@wandelbots/nova-api 25.11.0-dev.9 → 26.1.0-dev.38

package/dist/v1/index.js

@@ -4752,7 +4752,7 @@ var MotionApi = class extends BaseAPI {
 		return MotionApiFp(this.configuration).planTrajectory(cell, planTrajectoryRequest, options).then((request) => request(this.axios, this.basePath));
 	}
 	/**
-	* Stops an active motion gracefully with deceleration until standstill while staying on the planned trajectory. When an active movement is stopped any further update request will be rejected. The active movement request returns until the robot has reached standstill. Currently it is not possible to restart the motion. Please send in a feature request if you need to restart/continue the motion.
+	* Stops an active motion gracefully with deceleration until standstill while staying on the planned trajectory. When an active movement is stopped any further update request will be rejected. This call will immediately return even if the deceleration is still in progress. The active movement stream returns responses until the robot has reached standstill. Currently it is not possible to restart the motion. Please send in a feature request if you need to restart/continue the motion.
 	* @summary Stop
 	* @param {string} cell Unique identifier addressing a cell in all API calls. 
 	* @param {string} motion This represents the UUID of a motion. Every executable or partially executable motion is cached and an UUID is returned. Indicate the UUID to execute the motion or retrieve information on the motion.

package/dist/v2/index.cjs

@@ -92,6 +92,13 @@ const Behavior = {
 };
 const BlendingAutoBlendingNameEnum = { BlendingAuto: "BlendingAuto" };
 const BlendingPositionBlendingNameEnum = { BlendingPosition: "BlendingPosition" };
+/**
+* Defines the space in which blending is performed. - `JOINT`: Zone blending is performed in joint space - `CARTESIAN`: Auto-blending is performed in cartesian space 
+*/
+const BlendingSpace = {
+	Joint: "JOINT",
+	Cartesian: "CARTESIAN"
+};
 const BooleanValueValueTypeEnum = { Boolean: "boolean" };
 const BoxShapeTypeEnum = { Box: "box" };
 const BoxBoxTypeEnum = {
@@ -1013,6 +1020,60 @@ const BUSInputsOutputsApiAxiosParamCreator = function(configuration) {
 				options: localVarRequestOptions
 			};
 		},
+		deleteAllModbusIOs: async (cell, options = {}) => {
+			assertParamExists("deleteAllModbusIOs", "cell", cell);
+			const localVarPath = `/cells/{cell}/bus-ios/modbus/ios`.replace(`{cell}`, encodeURIComponent(String(cell)));
+			const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
+			let baseOptions;
+			if (configuration) baseOptions = configuration.baseOptions;
+			const localVarRequestOptions = {
+				method: "DELETE",
+				...baseOptions,
+				...options
+			};
+			const localVarHeaderParameter = {};
+			const localVarQueryParameter = {};
+			setBasicAuthToObject(localVarRequestOptions, configuration);
+			await setBearerAuthToObject(localVarHeaderParameter, configuration);
+			setSearchParams(localVarUrlObj, localVarQueryParameter);
+			let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+			localVarRequestOptions.headers = {
+				...localVarHeaderParameter,
+				...headersFromBaseOptions,
+				...options.headers
+			};
+			return {
+				url: toPathString(localVarUrlObj),
+				options: localVarRequestOptions
+			};
+		},
+		deleteAllProfinetIOs: async (cell, options = {}) => {
+			assertParamExists("deleteAllProfinetIOs", "cell", cell);
+			const localVarPath = `/cells/{cell}/bus-ios/profinet/ios`.replace(`{cell}`, encodeURIComponent(String(cell)));
+			const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
+			let baseOptions;
+			if (configuration) baseOptions = configuration.baseOptions;
+			const localVarRequestOptions = {
+				method: "DELETE",
+				...baseOptions,
+				...options
+			};
+			const localVarHeaderParameter = {};
+			const localVarQueryParameter = {};
+			setBasicAuthToObject(localVarRequestOptions, configuration);
+			await setBearerAuthToObject(localVarHeaderParameter, configuration);
+			setSearchParams(localVarUrlObj, localVarQueryParameter);
+			let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+			localVarRequestOptions.headers = {
+				...localVarHeaderParameter,
+				...headersFromBaseOptions,
+				...options.headers
+			};
+			return {
+				url: toPathString(localVarUrlObj),
+				options: localVarRequestOptions
+			};
+		},
 		deleteModbusIO: async (cell, io, options = {}) => {
 			assertParamExists("deleteModbusIO", "cell", cell);
 			assertParamExists("deleteModbusIO", "io", io);
@@ -1380,6 +1441,18 @@ const BUSInputsOutputsApiFp = function(configuration) {
 			const localVarOperationServerBasePath = operationServerMap["BUSInputsOutputsApi.clearBusIOService"]?.[localVarOperationServerIndex]?.url;
 			return (axios$1, basePath) => createRequestFunction(localVarAxiosArgs, axios.default, BASE_PATH, configuration)(axios$1, localVarOperationServerBasePath || basePath);
 		},
+		async deleteAllModbusIOs(cell, options) {
+			const localVarAxiosArgs = await localVarAxiosParamCreator.deleteAllModbusIOs(cell, options);
+			const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
+			const localVarOperationServerBasePath = operationServerMap["BUSInputsOutputsApi.deleteAllModbusIOs"]?.[localVarOperationServerIndex]?.url;
+			return (axios$1, basePath) => createRequestFunction(localVarAxiosArgs, axios.default, BASE_PATH, configuration)(axios$1, localVarOperationServerBasePath || basePath);
+		},
+		async deleteAllProfinetIOs(cell, options) {
+			const localVarAxiosArgs = await localVarAxiosParamCreator.deleteAllProfinetIOs(cell, options);
+			const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
+			const localVarOperationServerBasePath = operationServerMap["BUSInputsOutputsApi.deleteAllProfinetIOs"]?.[localVarOperationServerIndex]?.url;
+			return (axios$1, basePath) => createRequestFunction(localVarAxiosArgs, axios.default, BASE_PATH, configuration)(axios$1, localVarOperationServerBasePath || basePath);
+		},
 		async deleteModbusIO(cell, io, options) {
 			const localVarAxiosArgs = await localVarAxiosParamCreator.deleteModbusIO(cell, io, options);
 			const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
@@ -1472,6 +1545,12 @@ const BUSInputsOutputsApiFactory = function(configuration, basePath, axios$1) {
 		clearBusIOService(cell, completionTimeout, options) {
 			return localVarFp.clearBusIOService(cell, completionTimeout, options).then((request) => request(axios$1, basePath));
 		},
+		deleteAllModbusIOs(cell, options) {
+			return localVarFp.deleteAllModbusIOs(cell, options).then((request) => request(axios$1, basePath));
+		},
+		deleteAllProfinetIOs(cell, options) {
+			return localVarFp.deleteAllProfinetIOs(cell, options).then((request) => request(axios$1, basePath));
+		},
 		deleteModbusIO(cell, io, options) {
 			return localVarFp.deleteModbusIO(cell, io, options).then((request) => request(axios$1, basePath));
 		},
@@ -1562,6 +1641,26 @@ var BUSInputsOutputsApi = class extends BaseAPI {
 		return BUSInputsOutputsApiFp(this.configuration).clearBusIOService(cell, completionTimeout, options).then((request) => request(this.axios, this.basePath));
 	}
 	/**
+	* Removes all input/output variable configurations from the MODBUS device, e.g., NOVA\'s MODBUS service. 
+	* @summary Remove all MODBUS Input/Outputs
+	* @param {string} cell Unique identifier addressing a cell in all API calls. 
+	* @param {*} [options] Override http request option.
+	* @throws {RequiredError}
+	*/
+	deleteAllModbusIOs(cell, options) {
+		return BUSInputsOutputsApiFp(this.configuration).deleteAllModbusIOs(cell, options).then((request) => request(this.axios, this.basePath));
+	}
+	/**
+	* Removes all input/output variable configurations from the PROFINET device, e.g., NOVA\'s PROFINET service. 
+	* @summary Remove all PROFINET Input/Outputs
+	* @param {string} cell Unique identifier addressing a cell in all API calls. 
+	* @param {*} [options] Override http request option.
+	* @throws {RequiredError}
+	*/
+	deleteAllProfinetIOs(cell, options) {
+		return BUSInputsOutputsApiFp(this.configuration).deleteAllProfinetIOs(cell, options).then((request) => request(this.axios, this.basePath));
+	}
+	/**
 	* Removes an input/output variable configuration from the MODBUS device, e.g., NOVA\'s MODBUS service. 
 	* @summary Remove MODBUS Input/Ouptut
 	* @param {string} cell Unique identifier addressing a cell in all API calls. 
@@ -3125,7 +3224,7 @@ const JoggingApiFactory = function(configuration, basePath, axios$1) {
 */
 var JoggingApi = class extends BaseAPI {
 	/**
-	* <!-- theme: success -->  > Websocket endpoint  Provides execution control over a dynamically adaptable jogging motion for a motion group.  Jogging describes controlling a motion group by sending real-time commands to move either its joints or the TCP. The commands contain target velocities that may change at any time during execution, so the resulting motion cannot be computed upfront.  ### Preconditions  The motion group is not moved by any other endpoint.  ### Requests  #### 1. Send `InitializeJoggingRequest` to configure the jogging.  - Sets the robot controller mode to control mode. - Sets rate and coordinate system for the jogging response.  #### 2. Send `JointVelocityRequest` or `TcpVelocityRequest` to start the jogging motion.  #### 3. Change or stop the jogging motion  - Change the jogging direction and/or velocity during the jogging motion with `JointVelocityRequest` or `TcpVelocityRequest`. - To stop the jogging motion, send zero velocities via either request.  ### Responses  - `InitializeJoggingResponse` is sent to signal the success or failure of the `InitializeJoggingRequest`. - Jogging responses are streamed continuously after an `InitializeJoggingRequest` is processed.   Jogging responses contain the robot controller state and the state of the jogging control. - `JoggingErrorResponse` with error details is sent in case of an unexpected error, e.g., controller disconnects during jogging.  ### Tips and Tricks  - In the `JoggingResponse`, verify that the robot control is in the desired state, e.g., standstill, with JoggingState. - Ensure that the websocket connection remains open until the jogging motion is stopped to avoid unexpected stops. 
+	* <!-- theme: success -->  > Websocket endpoint  Provides execution control over a dynamically adaptable jogging motion for a motion group.  Jogging describes controlling a motion group by sending real-time commands to move either its joints or the TCP. The commands contain target velocities that may change at any time during execution, so the resulting motion cannot be computed upfront.  ### Preconditions  The motion group is not moved by any other endpoint.  ### Requests  #### 1. Send `InitializeJoggingRequest` to configure the jogging.  - Sets the robot controller mode to control mode. - Sets rate and coordinate system for the jogging response.  #### 2. Send `JointVelocityRequest` or `TcpVelocityRequest` to start the jogging motion.  - Commands can only be processed in the cycle rate of the controller - Sending commands faster will not increase the responsiveness of the jogging motion, it will lead to dropped commands - It is recommended to couple sending commands with the (state stream)[streamMotionGroupState], which can be subscribed to via nats as well.  #### 3. Change or stop the jogging motion  - Change the jogging direction and/or velocity during the jogging motion with `JointVelocityRequest` or `TcpVelocityRequest`. - To stop the jogging motion, send zero velocities via either request.  ### Responses  - `InitializeJoggingResponse` is sent to signal the success or failure of the `InitializeJoggingRequest`. - Jogging responses are streamed continuously after an `InitializeJoggingRequest` is processed.   Jogging responses contain the robot controller state and the state of the jogging control. - `JoggingErrorResponse` with error details is sent in case of an unexpected error, e.g., controller disconnects during jogging.  ### Tips and Tricks  - In the `JoggingResponse`, verify that the robot control is in the desired state, e.g., standstill, with JoggingState. - Ensure that the websocket connection remains open until the jogging motion is stopped to avoid unexpected stops. 
 	* @summary Execute Jogging
 	* @param {string} cell Unique identifier addressing a cell in all API calls. 
 	* @param {string} controller Unique identifier to address a controller in the cell.
@@ -3948,7 +4047,7 @@ const ProgramApiFactory = function(configuration, basePath, axios$1) {
 */
 var ProgramApi = class extends BaseAPI {
 	/**
-	* Get details of a program.
+	* <!-- theme: danger -->  > **Experimental**  Get details of a program. 
 	* @summary Get program
 	* @param {string} cell Unique identifier addressing a cell in all API calls. 
 	* @param {string} program 
@@ -3959,7 +4058,7 @@ var ProgramApi = class extends BaseAPI {
 		return ProgramApiFp(this.configuration).getProgram(cell, program, options).then((request) => request(this.axios, this.basePath));
 	}
 	/**
-	* List details of all existing programs.
+	* <!-- theme: danger -->  > **Experimental**  List details of all existing programs. 
 	* @summary List programs
 	* @param {string} cell Unique identifier addressing a cell in all API calls. 
 	* @param {*} [options] Override http request option.
@@ -3969,7 +4068,7 @@ var ProgramApi = class extends BaseAPI {
 		return ProgramApiFp(this.configuration).listPrograms(cell, options).then((request) => request(this.axios, this.basePath));
 	}
 	/**
-	* This endpoint starts a new program execution.  The program will be executed asynchronously. 
+	* <!-- theme: danger -->  > **Experimental**  This endpoint starts a new program execution.  The program will be executed asynchronously. 
 	* @summary Start the program
 	* @param {string} cell Unique identifier addressing a cell in all API calls. 
 	* @param {string} program 
@@ -3981,7 +4080,7 @@ var ProgramApi = class extends BaseAPI {
 		return ProgramApiFp(this.configuration).startProgram(cell, program, programStartRequest, options).then((request) => request(this.axios, this.basePath));
 	}
 	/**
-	* Stop a specific program run.
+	* <!-- theme: danger -->  > **Experimental**  Stop a specific program run. 
 	* @summary Stop program run
 	* @param {string} cell Unique identifier addressing a cell in all API calls. 
 	* @param {string} program 
@@ -6101,7 +6200,7 @@ const TrajectoryExecutionApiFactory = function(configuration, basePath, axios$1)
 */
 var TrajectoryExecutionApi = class extends BaseAPI {
 	/**
-	* <!-- theme: success -->  > Websocket endpoint  Provides execution control over a previously [planned trajectory](planTrajectory). Enables the caller to attach input/output actions to the trajectory.  ### Movement behavior  | Virtual controller | Physical controller | |------------------|-------------------| | Desired joint configurations are commanded to each motion group and **applied immediately** | Move to desired **actual joint configuration**, **if possible** |  ### Concept of location    - The location or path parameter specifies the exact position along a trajectory.   - The location is a scalar value that ranges from 0 to `n`, where `n` denotes the number of motion commands, or trajectory segments, e.g., line, p2p, etc. See [planTrajectory](planTrajectory).   - Each integer value of the location corresponds to one motion command, e.g., 3.0 to 3.999 could be a line.  ### Preconditions  - The motion group\'s control mode is not claimed by any other endpoint. - The motion group\'s joint position are at start location specified with `InitializeMovementRequest`. - Use [executeToTrajectory](executeToTrajectory) to move the robot to the start location.  ### Requests  #### 1. Send `InitializeMovementRequest` to lock the trajectory to this connection   The following actions are executed:   - Sets robot controller mode to control mode,   - Sets start location of the execution    Keep in mind that only a single trajectory can be locked to a websocket connection at a time and not unlocked anymore.   To execute another trajectory, a new connection must be established.  #### 2. Send `StartMovementRequest` to start the movement  Sets direction of movement, default is forward.  #### **Optional**  - To pause, send `PauseMovementRequest` before the movement has reached its end location. - Change the movement\'s velocity with `PlaybackSpeedRequest` after initializing the movement with `InitializeMovementRequest`.  ### Responses  - `InitializeMovementResponse` is sent to signal the success or failure of the `InitializeMovementRequest`. - Movement responses are streamed after a `StartMovementRequest` successfully started the movement.   Movement responses are streamed in a rate that is defined as the multiple of the controller step-rate closest to   but not exceeding the rate configured by `InitializeMovementRequest`. - Standstill response is sent once the movement has finished or has come to a standstill due to a pause. - `PauseMovementResponse` is sent to signal the success of the `PauseMovementRequest`. It does not signal the end of the movement.   End of movement is signaled by Standstill response. - `PlaybackSpeedResponse` is sent to signal the success of the `PlaybackSpeedRequest`. - `MovementError` with error details is sent in case of an unexpected error, e.g., controller disconnects during movement.  ### Tips and Tricks  - A movement can be paused and resumed by sending `PauseMovementRequest` and `StartMovementRequest`. - Send `PlaybackSpeedRequest` before `StartMovementRequest` to reduce the velocity of the movement before it starts. - Send `PlaybackSpeedRequest` repeatedly to implement a slider. The velocity of the motion group can be adjusted with each controller step. Therefore, if your app needs a slider-like UI to alter the velocity of a currently running movement, you can send `PlaybackSpeedRequest` with different speed values repeatedly during the movement. - A closed trajectory (end and start joint position are equal) can be repeated by sending `StartMovementRequest` after the movement has finished. 
+	* <!-- theme: success -->  > Websocket endpoint  Provides execution control over a previously [planned trajectory](planTrajectory). Enables the caller to attach input/output actions to the trajectory.  ### Movement behavior  | Virtual controller | Physical controller | |------------------|-------------------| | Desired joint configurations are commanded to each motion group and **applied immediately** | Move to desired **actual joint configuration**, **if possible** |  ### Concept of location    - The location or path parameter specifies the exact position along a trajectory.   - The location is a scalar value that ranges from 0 to `n`, where `n` denotes the number of motion commands, or trajectory segments, e.g., line, p2p, etc. See [planTrajectory](planTrajectory).   - Each integer value of the location corresponds to one motion command, e.g., 3.0 to 3.999 could be a line.  ### Preconditions  - The motion group\'s control mode is not claimed by any other endpoint. - The motion group\'s joint position are at start location specified with `InitializeMovementRequest`. - Use [executeToTrajectory](executeToTrajectory) to move the robot to the start location.  ### Requests  #### 1. Send `InitializeMovementRequest` to lock the trajectory to this connection   The following actions are executed:   - Sets robot controller mode to control mode,   - Sets start location of the execution    Keep in mind that only a single trajectory can be locked to a websocket connection at a time.   Pausing the current movement enables you to send another `InitializeMovementRequest` to execute another trajectory on the same connection.  #### 2. Send `StartMovementRequest` to start the movement  Sets direction of movement, default is forward.  #### **Optional**  - To pause, send `PauseMovementRequest` before the movement has reached its end location. - Change the movement\'s velocity with `PlaybackSpeedRequest` after initializing the movement with `InitializeMovementRequest`.  ### Responses  To monitor the state of the movement, listen to the [state stream](streamMotionGroupState). The state is published via nats as well. Field `execute` in the `MotionGroupState` indicates whether a movement is ongoing and carries execution details.  Each request has a corresponding acknowledgment response. They signal success or failure of the request. Especially for `PauseMovementResponse`, it does not signal the end of the movement.  Additionally, `MovementError` messages can be sent in case of unexpected errors during the execution, e.g., controller disconnects during movement.  ### Tips and Tricks  - A movement can be paused and resumed by sending `PauseMovementRequest` and `StartMovementRequest`. - Send `PlaybackSpeedRequest` before `StartMovementRequest` to reduce the velocity of the movement before it starts. - Send `PlaybackSpeedRequest` repeatedly to implement a slider. The velocity of the motion group can be adjusted with each controller step. Therefore, if your app needs a slider-like UI to alter the velocity of a currently running movement, you can send `PlaybackSpeedRequest` with different speed values repeatedly during the movement. - A closed trajectory (end and start joint position are equal) can be repeated by sending `StartMovementRequest` after the movement has finished. 
 	* @summary Execute Trajectory
 	* @param {string} cell Unique identifier addressing a cell in all API calls. 
 	* @param {string} controller Unique identifier to address a controller in the cell.
@@ -7647,6 +7746,7 @@ exports.BaseAPI = BaseAPI;
 exports.Behavior = Behavior;
 exports.BlendingAutoBlendingNameEnum = BlendingAutoBlendingNameEnum;
 exports.BlendingPositionBlendingNameEnum = BlendingPositionBlendingNameEnum;
+exports.BlendingSpace = BlendingSpace;
 exports.BooleanValueValueTypeEnum = BooleanValueValueTypeEnum;
 exports.BoxBoxTypeEnum = BoxBoxTypeEnum;
 exports.BoxShapeTypeEnum = BoxShapeTypeEnum;