@wandelbots/nova-api 26.2.0-dev.5 → 26.2.0-dev.56

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -1,4 +1,4 @@
1
- import * as axios0 from "axios";
1
+ import * as axios142 from "axios";
2
2
  import { AxiosInstance, AxiosPromise, RawAxiosRequestConfig } from "axios";
3
3
 
4
4
  //#region v1/configuration.d.ts
@@ -7,7 +7,7 @@ import { AxiosInstance, AxiosPromise, RawAxiosRequestConfig } from "axios";
7
7
  * Wandelbots NOVA API
8
8
  * Interact with robots in an easy and intuitive way.
9
9
  *
10
- * The version of the OpenAPI document: 1.2.0
10
+ * The version of the OpenAPI document: 1.3.0 dev
11
11
  *
12
12
  *
13
13
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -227,7 +227,7 @@ interface ArrayOutput {
227
227
  'array': Array<ResponseGetValuesProgramsValuesGetValue>;
228
228
  }
229
229
  /**
230
- * ## BEHAVIOR_AUTOMATIC This is the default behavior. The motion group instantly takes any commanded joint configuration as actual joint state. Configures the compliance of the virtual robot with the normal ControllerState cycle time. If set, the virtual robot will act like a physical one, e.g. with a cycle time of 8ms to respond to a new joint state command. ## BEHAVIOR_AUTOMATIC_NOT_COMPLY_WITH_CYCLETIME Configures the compliance of the virtual robot with the normal ControllerState cycle time. If set, the robot will respond as fast as possible, limited only by software execution speed. Because of that the execution of a movement requires less time than with BEHAVIOR_AUTOMATIC. ## BEHAVIOR_EXTERNAL_SOURCE The external client is the only source of actual joint state changes. This mode is used to enable third party software indicating the current joint state via [externalJointsStream](externalJointsStream).
230
+ * ## BEHAVIOR_AUTOMATIC This is the default behavior. The motion group instantly takes any commanded joint configuration as actual joint state. Configures the compliance of the virtual robot with the normal ControllerState cycle time. If set, the virtual robot will act like a physical one, e.g. with a cycle time of 8ms to respond to a new joint state command. ## BEHAVIOR_AUTOMATIC_NOT_COMPLY_WITH_CYCLETIME Configures the compliance of the virtual robot with the normal ControllerState cycle time. If set, the robot will respond as fast as possible, limited only by software execution speed. Because of that, the execution of a movement requires less time than with BEHAVIOR_AUTOMATIC. ## BEHAVIOR_EXTERNAL_SOURCE The external client is the only source of actual joint state changes. This mode is used to enable third party software indicating the current joint state via [externalJointsStream](#/operations/externalJointsStream).
231
231
  */
232
232
  declare const Behavior: {
233
233
  readonly BehaviorAutomatic: "BEHAVIOR_AUTOMATIC";
@@ -710,7 +710,7 @@ interface ContainerResources {
710
710
  'intel-gpu'?: number;
711
711
  }
712
712
  /**
713
- * The path and capacity of a volume that retains data across application restarts. The maximal requestable capacity is 300Mi. If you need more capacity consider using [storeObject](storeObject).
713
+ * The path and capacity of a volume that retains data across application restarts. The maximal requestable capacity is 300Mi. If you need more capacity consider using [storeObject](#/operations/storeObject).
714
714
  */
715
715
  interface ContainerStorage {
716
716
  'mountPath': string;
@@ -1321,15 +1321,15 @@ interface InfoServiceCapabilities {
1321
1321
  */
1322
1322
  interface InitializeMovementRequest {
1323
1323
  /**
1324
- * Type specifier for server, set automatically.
1324
+ * Type specifier for the server, set automatically.
1325
1325
  */
1326
1326
  'message_type'?: string;
1327
1327
  /**
1328
- * The UUID of the trajectory which should be executed and locked to the connection. Get information about the trajectory via [getMotionTrajectorySample](getMotionTrajectorySample) or [getMotionTrajectory](getMotionTrajectory).
1328
+ * The UUID of the trajectory which should be executed and locked to the connection. Get information about the trajectory via [getMotionTrajectorySample](#/operations/getMotionTrajectorySample) or [getMotionTrajectory](#/operations/getMotionTrajectory).
1329
1329
  */
1330
1330
  'trajectory': string;
1331
1331
  /**
1332
- * Location on trajectory where the execution will start. The default value is the start (forward movement) or end (backward movement) of the trajectory. If you want to start your movement from an arbitrary location, e.g. in combination with [streamMoveToTrajectoryViaJointPTP](streamMoveToTrajectoryViaJointPTP), set the location by respecting the following format: - The location is a scalar value that defines a position along a path, typically ranging from 0 to `n`, where `n` denotes the number of motion commands - Each integer value of the location corresponds to a specific motion command, while non-integer values interpolate positions within the segments. - The location is calculated from the joint path
1332
+ * Location on trajectory where the execution will start. The default value is the start (forward movement) or end (backward movement) of the trajectory. If you want to start your movement from an arbitrary location, e.g. in combination with [streamMoveToTrajectoryViaJointPTP](#/operations/streamMoveToTrajectoryViaJointPTP), set the location by respecting the following format: - The location is a scalar value that defines a position along a path, typically ranging from 0 to `n`, where `n` denotes the number of motion commands - Each integer value of the location corresponds to a specific motion command, while non-integer values interpolate positions within the segments. - The location is calculated from the joint path
1333
1333
  */
1334
1334
  'initial_location'?: number;
1335
1335
  /**
@@ -1739,7 +1739,7 @@ declare const Manufacturer: {
1739
1739
  };
1740
1740
  type Manufacturer = typeof Manufacturer[keyof typeof Manufacturer];
1741
1741
  /**
1742
- * Mode change example: * Client sends [jointJogging](jointJogging)](cell=\"..\",...) * Server responds with *current_robot_mode: ROBOT_SYSTEM_MODE_UNDEFINED, by_client_request: true* at the beginning of the transition. * Server responds with *current_robot_mode: ROBOT_SYSTEM_MODE_CONTROL, by_client_request: true* when transition is done. In case an error happens during execution, e.g. a path would lead to a joint limit violation: * Server responds with *current_robot_mode: ROBOT_SYSTEM_MODE_UNDEFINED, by_client_request: false* * Server responds with *current_robot_mode: ROBOT_SYSTEM_MODE_MONITOR, by_client_request: false* In case an error happens during connection, e.g. the robot is not reachable: * Client sends [setDefaultMode](setDefaultMode)(mode: MODE_CONTROL) * Server responds with *current_robot_mode:ROBOT_SYSTEM_MODE_UNDEFINED, by_client_request: true* * Server responds with *current_robot_mode:ROBOT_SYSTEM_MODE_DISCONNECT, by_client_request: false*
1742
+ * Mode change example: * Client sends [jointJogging](#/operations/jointJogging)](cell=\"..\",...) * Server responds with *current_robot_mode: ROBOT_SYSTEM_MODE_UNDEFINED, by_client_request: true* at the beginning of the transition. * Server responds with *current_robot_mode: ROBOT_SYSTEM_MODE_CONTROL, by_client_request: true* when the transition is done. In case an error happens during execution, e.g. a path would lead to a joint limit violation: * Server responds with *current_robot_mode: ROBOT_SYSTEM_MODE_UNDEFINED, by_client_request: false* * Server responds with *current_robot_mode: ROBOT_SYSTEM_MODE_MONITOR, by_client_request: false* In case an error happens during connection, e.g. the robot is not reachable: * Client sends [setDefaultMode](#/operations/setDefaultMode)(mode: MODE_CONTROL) * Server responds with *current_robot_mode:ROBOT_SYSTEM_MODE_UNDEFINED, by_client_request: true* * Server responds with *current_robot_mode:ROBOT_SYSTEM_MODE_DISCONNECT, by_client_request: false*
1743
1743
  */
1744
1744
  interface ModeChangeResponse {
1745
1745
  'current_robot_mode': RobotSystemMode;
@@ -1826,7 +1826,7 @@ interface MotionGroupInstanceList {
1826
1826
  'instances': Array<MotionGroupInstance>;
1827
1827
  }
1828
1828
  /**
1829
- * Ensure to provide one value for each joint. See [getMotionGroups](getMotionGroups) for the number of joints. Everything but positions is optional.
1829
+ * Ensure to provide one value for each joint. See [getMotionGroups](#/operations/getMotionGroups) for the number of joints. Everything but positions is optional.
1830
1830
  */
1831
1831
  interface MotionGroupJoints {
1832
1832
  /**
@@ -1859,7 +1859,7 @@ interface MotionGroupPhysical {
1859
1859
  */
1860
1860
  'name_from_controller': string;
1861
1861
  /**
1862
- * True if this motion group is active. When a request for a motion group is made, the motion group will be activated and remain activated. The robot controller provides the current state and data for all active motion groups. See [getCurrentMotionGroupState](getCurrentMotionGroupState). To deactivate a motion group, use [deactivateMotionGroup](deactivateMotionGroup).
1862
+ * True if this motion group is active. When a request for a motion group is made, the motion group will be activated and remain activated. The robot controller provides the current state and data for all active motion groups. See [getCurrentMotionGroupState](#/operations/getCurrentMotionGroupState). To deactivate a motion group, use [deactivateMotionGroup](#/operations/deactivateMotionGroup).
1863
1863
  */
1864
1864
  'active': boolean;
1865
1865
  /**
@@ -1964,7 +1964,7 @@ interface MotionId {
1964
1964
  }
1965
1965
  interface MotionIdsListResponse {
1966
1966
  /**
1967
- * -| Identifiers of all motions which are currently cached. Use [planMotion](planMotion) to add a new motion. Motions are deleted if corresponding motion group or controller is disconnected.
1967
+ * -| Identifiers of all motions which are currently cached. Use [planMotion](#/operations/planMotion) to add a new motion. Motions are deleted if corresponding motion group or controller is disconnected.
1968
1968
  */
1969
1969
  'motions'?: Array<string>;
1970
1970
  }
@@ -1990,7 +1990,7 @@ interface Mounting {
1990
1990
  'pose': Pose;
1991
1991
  }
1992
1992
  /**
1993
- * Moves the motion group forward or backward along a previously planned motion. Once started, you can stop a motion using the [stop](StreamStop) endpoint. Prerequisite, before starting the motion execution: - The motion group is currently at the endpoint of the planned motion.
1993
+ * Moves the motion group forward or backward along a previously planned motion. Once started, you can stop a motion using the [stop](#/operations/stopExecution) endpoint. Prerequisite, before starting the motion execution: - The motion group is currently at the endpoint of the planned motion.
1994
1994
  */
1995
1995
  interface MoveRequest {
1996
1996
  /**
@@ -2037,7 +2037,7 @@ interface MoveResponse {
2037
2037
  'current_location_on_trajectory': number;
2038
2038
  }
2039
2039
  /**
2040
- * Request to move the motion group via joint point-to-point to a given location on a planned motion. You must use this endpoint in order to start moving from an arbritrary location of the trajectory. Afterwards, you are able to call [streamMoveForward](streamMoveForward) or [streamMoveBackward](streamMoveBackward) to move along planned motion. Use the [stopExecution](stopExecution) endpoint to stop the motion gracefully.
2040
+ * Request to move the motion group via joint point-to-point to a given location on a planned motion. You must use this endpoint in order to start moving from an arbritrary location of the trajectory. Afterwards, you are able to call [streamMoveForward](#/operations/streamMoveForward) or [streamMoveBackward](#/operations/streamMoveBackward) to move along the planned motion. Use the [stopExecution](#/operations/stopExecution) endpoint to stop the motion gracefully.
2041
2041
  */
2042
2042
  interface MoveToTrajectoryViaJointPTPRequest {
2043
2043
  /**
@@ -2227,7 +2227,7 @@ interface PauseMovementRequest {
2227
2227
  'send_response'?: boolean;
2228
2228
  }
2229
2229
  /**
2230
- * Response for PauseMovementRequest message. ATTENTION: No confirmation that the movement was paused. Confirmation that the PauseMovementRequest was received and is processed. End of movement execution is signalled by [StillstandResponse](StillstandResponse).
2230
+ * Response for PauseMovementRequest message. ATTENTION: No confirmation that the movement was paused. Confirmation that the PauseMovementRequest was received and is processed. End of movement execution is signalled by Standstill response.
2231
2231
  */
2232
2232
  interface PauseMovementResponse {
2233
2233
  'pause_response': PauseMovementResponsePauseResponse;
@@ -2266,7 +2266,7 @@ interface Payload {
2266
2266
  }
2267
2267
  interface PlanCollisionFreePTPRequest {
2268
2268
  /**
2269
- * The robot setup as returned from [getOptimizerConfiguration](getOptimizerConfiguration) endpoint.
2269
+ * The robot setup as returned from the [getOptimizerConfiguration](#/operations/getOptimizerConfiguration) endpoint.
2270
2270
  */
2271
2271
  'robot_setup': OptimizerSetup;
2272
2272
  'start_joint_position': Array<number>;
@@ -2331,7 +2331,7 @@ interface PlanRequest {
2331
2331
  */
2332
2332
  'motion_group': string;
2333
2333
  /**
2334
- * -| To define a motion the start joints have to be indicated. Cartesian movements will be in the same kinematic configuration as the start joint position until the first joint point to point motion. Motions can only be executed, if the start joint position is the current joint position of the motion group. To retrieve the current joint position use the endpoint [getCurrentMotionGroupState](getCurrentMotionGroupState). To move the robot to the start joint position, use the endpoint [streamMoveToTrajectoryViaJointP2P](streamMoveToTrajectoryViaJointP2P).
2334
+ * -| To define a motion the start joints have to be indicated. Cartesian movements will be in the same kinematic configuration as the start joint position until the first joint point-to-point motion. Motions can only be executed if the start joint position is the current joint position of the motion group. To retrieve the current joint position, use the endpoint [getCurrentMotionGroupState](#/operations/getCurrentMotionGroupState). To move the robot to the start joint position, use the endpoint [streamMoveToTrajectoryViaJointP2P](#/operations/streamMoveToTrajectoryViaJointP2P).
2335
2335
  */
2336
2336
  'start_joint_position': Joints;
2337
2337
  /**
@@ -2339,16 +2339,16 @@ interface PlanRequest {
2339
2339
  */
2340
2340
  'commands': Array<Command>;
2341
2341
  /**
2342
- * Tool identifier. If not set the current tool is used.
2342
+ * Tool identifier. If not set, the current tool is used.
2343
2343
  */
2344
2344
  'tcp'?: string;
2345
2345
  /**
2346
- * Payload identifier. If unset the currently set payload is used.
2346
+ * Payload identifier. If unset, the currently set payload is used.
2347
2347
  */
2348
2348
  'payload'?: string;
2349
2349
  }
2350
2350
  /**
2351
- * -| The plan response signals if the planned motion is executable, partially executable or not executable. If the motion is executable or partially executable, the response contains an unique identifier for the motion and the end joint position. To execute the motion use the unique identifier for calling move endpoints [streamMoveForward](streamMoveForward) or [streamMoveBackward](streamMoveBackward). Use the unique identifier within the endpoints [getMotionTrajectory](getMotionTrajectory) and [getMotionTrajectorySample](getMotionTrajectorySample) to retrieve information about the motion. Use the end joint position to plan and concatenate the next motion. If an error occurred, the response contains feedback including the reason for failure and the location where the failure occurred.
2351
+ * -| The plan response signals if the planned motion is executable, partially executable, or not executable. If the motion is executable or partially executable, the response contains an unique identifier for the motion and the end joint position. To execute the motion, use this unique identifier in the move endpoints [streamMoveForward](#/operations/streamMoveForward) or [streamMoveBackward](#/operations/streamMoveBackward). To retrieve information about this motion use the identifier [getMotionTrajectory](#/operations/getMotionTrajectory) and [getMotionTrajectorySample](#/operations/getMotionTrajectorySample). Use the end joint position to plan and concatenate the next motion. If an error occurred, the response contains feedback including the reason for failure and the location where the failure occurred.
2352
2352
  */
2353
2353
  interface PlanResponse {
2354
2354
  'plan_successful_response'?: PlanSuccessfulResponse;
@@ -2382,7 +2382,7 @@ interface PlanTrajectoryFailedResponse {
2382
2382
  type PlanTrajectoryFailedResponseErrorFeedback = FeedbackCollision | FeedbackJointLimitExceeded | FeedbackOutOfWorkspace | FeedbackSingularity;
2383
2383
  interface PlanTrajectoryRequest {
2384
2384
  /**
2385
- * The robot setup as returned from [getOptimizerConfiguration](getOptimizerConfiguration) endpoint.
2385
+ * The robot setup as returned from the [getOptimizerConfiguration](#/operations/getOptimizerConfiguration) endpoint.
2386
2386
  */
2387
2387
  'robot_setup': OptimizerSetup;
2388
2388
  'start_joint_position': Array<number>;
@@ -3058,7 +3058,7 @@ interface RobotState {
3058
3058
  'joints'?: Array<number> | null;
3059
3059
  }
3060
3060
  /**
3061
- * The system mode of the robot system. ### ROBOT_SYSTEM_MODE_UNDEFINED Indicates that the robot controller is currently performing a mode transition. ### ROBOT_SYSTEM_MODE_DISCONNECT There is no communication with the robot controller at all. All connections are closed. No command is sent to the robot controller while in this mode. No IO interaction is possible in this mode! All move requests will be rejected in this mode! ### ROBOT_SYSTEM_MODE_MONITOR A connection to the robot controller is established to only read the robot controller state. No command is sent to the robot controller while in this mode. It is possible to receive IO information. All move requests will be rejected in this mode! ### ROBOT_SYSTEM_MODE_CONTROL An active connection is established with the robot controller and the robot system is cyclic commanded to stay in its actual position. The robot controller state is received in the cycle time of the robot controller. Requests via the MotionService and JoggingService will be processed and executed in this mode. IO interaction is possible in this mode! **In this mode the robot system can be commanded to move.** ### ROBOT_SYSTEM_MODE_FREE_DRIVE Like ROBOT_SYSTEM_MODE_MONITOR a connection to the robot controller is established to only read the robot controller state. The difference is that the motion groups can be moved by the user (Free Drive). Thus, the servo motors are turned on. All move requests will be rejected in this mode! **This mode is not supported by every robot!** Use [getSupportedModes](getSupportedModes) to evaluate if the device support free drive.
3061
+ * The system mode of the robot system. ### ROBOT_SYSTEM_MODE_UNDEFINED Indicates that the robot controller is currently performing a mode transition. ### ROBOT_SYSTEM_MODE_DISCONNECT There is no communication with the robot controller at all. All connections are closed. No command is sent to the robot controller while in this mode. No IO interaction is possible in this mode! All move requests will be rejected in this mode! ### ROBOT_SYSTEM_MODE_MONITOR A connection to the robot controller is established to only read the robot controller state. No command is sent to the robot controller while in this mode. It is possible to receive IO information. All move requests will be rejected in this mode! ### ROBOT_SYSTEM_MODE_CONTROL An active connection is established with the robot controller and the robot system is cyclic commanded to stay in its actual position. The robot controller state is received in the cycle time of the robot controller. Requests via the MotionService and JoggingService will be processed and executed in this mode. IO interaction is possible in this mode! **In this mode the robot system can be commanded to move.** ### ROBOT_SYSTEM_MODE_FREE_DRIVE Like ROBOT_SYSTEM_MODE_MONITOR, a connection to the robot controller is established to only read the robot controller state. The difference is that the motion groups can be moved by the user (Free Drive). Thus, the servo motors are turned on. All move requests will be rejected in this mode! **This mode is not supported by every robot!** Use [getSupportedModes](#/operations/getSupportedModes) to evaluate if the device supports free drive.
3062
3062
  */
3063
3063
  declare const RobotSystemMode: {
3064
3064
  readonly RobotSystemModeUndefined: "ROBOT_SYSTEM_MODE_UNDEFINED";
@@ -3377,7 +3377,7 @@ interface StandstillStandstill {
3377
3377
  'state': RobotControllerState;
3378
3378
  }
3379
3379
  /**
3380
- * Moves the motion group along a trajectory, added via [planTrajectory](planTrajectory) or [planMotion](planMotion). Trajectories can be executed forwards or backwards(\"in reverse\"). Pause the execution with PauseMovementRequest. Resume execution with StartMovementRequest. Precondition: To start execution, the motion group must be located at the trajectory\'s start location specified in InitializeMovementRequest.
3380
+ * Moves the motion group along a trajectory, added via [planTrajectory](#/operations/planTrajectory) or [planMotion](#/operations/planMotion). Trajectories can be executed forwards or backwards(\"in reverse\"). Pause the execution with PauseMovementRequest. Resume execution with StartMovementRequest. Precondition: To start execution, the motion group must be located at the trajectory\'s start location specified in InitializeMovementRequest.
3381
3381
  */
3382
3382
  interface StartMovementRequest {
3383
3383
  /**
@@ -3713,7 +3713,7 @@ interface VirtualController {
3713
3713
  'manufacturer': Manufacturer;
3714
3714
  'type'?: VirtualControllerTypes;
3715
3715
  /**
3716
- * Complete JSON configuration of the virtual robot controller. Can be obtained from the physical controller\'s configuration via [getVirtualRobotConfiguration](getVirtualRobotConfiguration). If this field is provided, the `type` field should not be used.
3716
+ * Complete JSON configuration of the virtual robot controller. Can be obtained from the physical controller\'s configuration via [getVirtualRobotConfiguration](#/operations/getVirtualRobotConfiguration). If this field is provided, the `type` field should not be used.
3717
3717
  */
3718
3718
  'json'?: string;
3719
3719
  /**
@@ -3855,7 +3855,7 @@ interface VirtualRobotConfiguration {
3855
3855
  */
3856
3856
  'name': string;
3857
3857
  /**
3858
- * Content of the configuration file. Copy & paste to the [addRobotController](addRobotController) configuration.json parameter.
3858
+ * Content of the configuration file. Copy & paste to the [addRobotController](#/operations/addRobotController) configuration.json parameter.
3859
3859
  */
3860
3860
  'content': string;
3861
3861
  }
@@ -4069,7 +4069,7 @@ declare class ApplicationApi extends BaseAPI {
4069
4069
  * @param {*} [options] Override http request option.
4070
4070
  * @throws {RequiredError}
4071
4071
  */
4072
- addApp(cell: string, app: App, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
4072
+ addApp(cell: string, app: App, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<axios142.AxiosResponse<void, any>>;
4073
4073
  /**
4074
4074
  * Delete all GUI applications from the cell.
4075
4075
  * @summary Clear Applications
@@ -4078,7 +4078,7 @@ declare class ApplicationApi extends BaseAPI {
4078
4078
  * @param {*} [options] Override http request option.
4079
4079
  * @throws {RequiredError}
4080
4080
  */
4081
- clearApps(cell: string, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
4081
+ clearApps(cell: string, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<axios142.AxiosResponse<void, any>>;
4082
4082
  /**
4083
4083
  * Delete a GUI application from the cell.
4084
4084
  * @summary Delete Application
@@ -4088,7 +4088,7 @@ declare class ApplicationApi extends BaseAPI {
4088
4088
  * @param {*} [options] Override http request option.
4089
4089
  * @throws {RequiredError}
4090
4090
  */
4091
- deleteApp(cell: string, app: string, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
4091
+ deleteApp(cell: string, app: string, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<axios142.AxiosResponse<void, any>>;
4092
4092
  /**
4093
4093
  * Get the configuration for an active GUI application in the cell. To update the configuration of a GUI application in the cell, use this configuration with the \'Update Configuration\' endpoint.
4094
4094
  * @summary Configuration
@@ -4097,7 +4097,7 @@ declare class ApplicationApi extends BaseAPI {
4097
4097
  * @param {*} [options] Override http request option.
4098
4098
  * @throws {RequiredError}
4099
4099
  */
4100
- getApp(cell: string, app: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<App, any>>;
4100
+ getApp(cell: string, app: string, options?: RawAxiosRequestConfig): Promise<axios142.AxiosResponse<App, any>>;
4101
4101
  /**
4102
4102
  * List all GUI applications that have been added to a cell. with the \'Add Application\' endpoint. If the cell does not contain GUI applications, the list is returned empty.
4103
4103
  * @summary List Applications
@@ -4105,7 +4105,7 @@ declare class ApplicationApi extends BaseAPI {
4105
4105
  * @param {*} [options] Override http request option.
4106
4106
  * @throws {RequiredError}
4107
4107
  */
4108
- listApps(cell: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<string[], any>>;
4108
+ listApps(cell: string, options?: RawAxiosRequestConfig): Promise<axios142.AxiosResponse<string[], any>>;
4109
4109
  /**
4110
4110
  * Update the configuration of a GUI application in the cell.
4111
4111
  * @summary Update Configuration
@@ -4116,7 +4116,7 @@ declare class ApplicationApi extends BaseAPI {
4116
4116
  * @param {*} [options] Override http request option.
4117
4117
  * @throws {RequiredError}
4118
4118
  */
4119
- updateApp(cell: string, app: string, app2: App, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
4119
+ updateApp(cell: string, app: string, app2: App, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<axios142.AxiosResponse<void, any>>;
4120
4120
  }
4121
4121
  /**
4122
4122
  * CellApi - axios parameter creator
@@ -4298,7 +4298,7 @@ declare class CellApi extends BaseAPI {
4298
4298
  * @param {*} [options] Override http request option.
4299
4299
  * @throws {RequiredError}
4300
4300
  */
4301
- deleteCell(cell: string, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
4301
+ deleteCell(cell: string, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<axios142.AxiosResponse<void, any>>;
4302
4302
  /**
4303
4303
  * Deploy an entire cell with all its resources. A cell can be used to deploy a robot controller, one or more robots, as well as custom applications. Refer to the [Wandelbots NOVA documentation](docs/wandelbots-nova-api/#create-a-cell) for more information.
4304
4304
  * @summary Add Cell
@@ -4307,7 +4307,7 @@ declare class CellApi extends BaseAPI {
4307
4307
  * @param {*} [options] Override http request option.
4308
4308
  * @throws {RequiredError}
4309
4309
  */
4310
- deployCell(cell: Cell, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
4310
+ deployCell(cell: Cell, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<axios142.AxiosResponse<void, any>>;
4311
4311
  /**
4312
4312
  * List all cell resources. > **NOTE** > > The output generated by this endpoint can be too large for the site to handle, and may produce an error or incorrect output. > Use `curl` in combination with `> output.json` to capture the output, or use an API client like Postman.
4313
4313
  * @summary Configuration
@@ -4315,7 +4315,7 @@ declare class CellApi extends BaseAPI {
4315
4315
  * @param {*} [options] Override http request option.
4316
4316
  * @throws {RequiredError}
4317
4317
  */
4318
- getCell(cell: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<Cell, any>>;
4318
+ getCell(cell: string, options?: RawAxiosRequestConfig): Promise<axios142.AxiosResponse<Cell, any>>;
4319
4319
  /**
4320
4320
  * List the status of all cell resources.
4321
4321
  * @summary Service Status
@@ -4323,14 +4323,14 @@ declare class CellApi extends BaseAPI {
4323
4323
  * @param {*} [options] Override http request option.
4324
4324
  * @throws {RequiredError}
4325
4325
  */
4326
- getCellStatus(cell: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<ServiceStatus[], any>>;
4326
+ getCellStatus(cell: string, options?: RawAxiosRequestConfig): Promise<axios142.AxiosResponse<ServiceStatus[], any>>;
4327
4327
  /**
4328
4328
  * List all deployed cell names. If no cells are deployed, an empty list is returned.
4329
4329
  * @summary List Cells
4330
4330
  * @param {*} [options] Override http request option.
4331
4331
  * @throws {RequiredError}
4332
4332
  */
4333
- listCells(options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<string[], any>>;
4333
+ listCells(options?: RawAxiosRequestConfig): Promise<axios142.AxiosResponse<string[], any>>;
4334
4334
  /**
4335
4335
  * Update the definition of the entire Cell.
4336
4336
  * @summary Update Configuration
@@ -4340,7 +4340,7 @@ declare class CellApi extends BaseAPI {
4340
4340
  * @param {*} [options] Override http request option.
4341
4341
  * @throws {RequiredError}
4342
4342
  */
4343
- updateCell(cell: string, cell2: Cell, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
4343
+ updateCell(cell: string, cell2: Cell, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<axios142.AxiosResponse<void, any>>;
4344
4344
  }
4345
4345
  /**
4346
4346
  * ControllerApi - axios parameter creator
@@ -4385,7 +4385,7 @@ declare const ControllerApiAxiosParamCreator: (configuration?: Configuration) =>
4385
4385
  */
4386
4386
  getCurrentRobotControllerState: (cell: string, controller: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
4387
4387
  /**
4388
- * Get the current robot system mode of a registered robot controller. The robot system mode indicates if a robot controller can be used. See [setDefaultMode](setDefaultMode) for more information about the different modes. The mode is influenced by the operating mode of the robot controller. The operating mode can be changed via [setDefaultMode](setDefaultMode). Request the current operating mode of the robot controller via [getCurrentRobotControllerState](getCurrentRobotControllerState).
4388
+ * Get the current robot system mode of a registered robot controller. The robot system mode indicates if a robot controller can be used. See [setDefaultMode](#/operations/setDefaultMode) for more information about the different modes. The mode is influenced by the operating mode of the robot controller. The operating mode can be changed via [setDefaultMode](#/operations/setDefaultMode). Request the current operating mode of the robot controller via [getCurrentRobotControllerState](#/operations/getCurrentRobotControllerState).
4389
4389
  * @summary Current Mode
4390
4390
  * @param {string} cell Unique identifier addressing a cell in all API calls.
4391
4391
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -4412,7 +4412,7 @@ declare const ControllerApiAxiosParamCreator: (configuration?: Configuration) =>
4412
4412
  */
4413
4413
  getSupportedModes: (cell: string, controller: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
4414
4414
  /**
4415
- * Receive data to configure a virtual robot controller based on another controller. This can be used to create a virtual clone of a specific physical robot. When adding a virtual controller, use the Virtual configuration variant of [addRobotController](addRobotController) and pass the content string from this endpoint as the `json` field. Omit the `type` field that selects a preset configuration which is not required when providing a complete configuration. > **NOTE** > > The output generated by this endpoint can be too large for the site to handle, and may produce an error or incorrect output. > Use `curl` in combination with `> output.json` to capture the output, or use an API client like Postman.
4415
+ * Receive data to configure a virtual robot controller based on another controller. This can be used to create a virtual clone of a specific physical robot. When adding a virtual controller, use the virtual configuration variant of [addRobotController](#/operations/addRobotController) and pass the content string from this endpoint as the `json` field. Omit the `type` field that selects a preset configuration, which is not required when providing a complete configuration. > **NOTE** > > The output generated by this endpoint can be too large for the site to handle and may produce an error or incorrect output. > Use `curl` in combination with `> output.json` to capture the output, or use an API client like Postman.
4416
4416
  * @summary Virtual Robot Configuration
4417
4417
  * @param {string} cell Unique identifier addressing a cell in all API calls.
4418
4418
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -4429,7 +4429,7 @@ declare const ControllerApiAxiosParamCreator: (configuration?: Configuration) =>
4429
4429
  */
4430
4430
  listControllers: (cell: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
4431
4431
  /**
4432
- * Switch between monitor and control usage as default for a robot controller. Monitoring mode is used to read information from the robot controller and control mode is used to command the robot system. As long as the robot controller is connected via network monitoring mode is always possible. To switch to control mode the robot controller must be in `automatic` or `manual` operating mode and safety state \'normal\' or \'reduced\'. If the robot controller is in `manual` operating mode, you have manually confirm the control usage activation on the robot control panel. This manual confirmation can\'t be replaced with this API. Without manual confirmation the robot controller will stay in monitor mode. The robot system will try to activate the required operation mode for the requested usage unless no active call requires a different mode. > **NOTE** > > Some robot controllers prevent the external activation of automatic operating mode. In this case, changing the operating mode manually at the robot controller is mandatory. > **NOTE** > > The current operation mode and safety state can be requested via [getCurrentRobotControllerState](getCurrentRobotControllerState). If a mode change is not possible, the response lists reasons for the failed change.
4432
+ * Switch between monitor and control usage as default for a robot controller. Monitoring mode is used to read information from the robot controller and control mode is used to command the robot system. As long as the robot controller is connected via network, monitoring mode is always possible. To switch to control mode, the robot controller must be in `automatic` or `manual` operating mode and safety state \'normal\' or \'reduced\'. If the robot controller is in `manual` operating mode, you have to manually confirm the control usage activation on the robot control panel. This manual confirmation can\'t be replaced with this API. Without manual confirmation, the robot controller will stay in monitor mode. The robot system will try to activate the required operation mode for the requested usage unless no active call requires a different mode. > **NOTE** > > Some robot controllers prevent the external activation of automatic operating mode. In this case, changing the operating mode manually at the robot controller is mandatory. > **NOTE** > > The current operation mode and safety state can be requested via [getCurrentRobotControllerState](#/operations/getCurrentRobotControllerState). If a mode change is not possible, the response lists reasons for the failed change.
4433
4433
  * @summary Set Default Mode
4434
4434
  * @param {string} cell Unique identifier addressing a cell in all API calls.
4435
4435
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -4449,7 +4449,7 @@ declare const ControllerApiAxiosParamCreator: (configuration?: Configuration) =>
4449
4449
  */
4450
4450
  streamFreeDrive: (cell: string, controller: string, responseRate?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
4451
4451
  /**
4452
- * Receive updates of the current robot system mode of a robot controller via websocket upon robot system mode change. See [setDefaultMode](setDefaultMode) for more information about the different modes.
4452
+ * Receive updates of the current robot system mode of a robot controller via websocket upon robot system mode change. See [setDefaultMode](#/operations/setDefaultMode) for more information about the different modes.
4453
4453
  * @summary Stream Mode Change
4454
4454
  * @param {string} cell Unique identifier addressing a cell in all API calls.
4455
4455
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -4468,7 +4468,7 @@ declare const ControllerApiAxiosParamCreator: (configuration?: Configuration) =>
4468
4468
  */
4469
4469
  streamRobotControllerState: (cell: string, controller: string, responseRate?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
4470
4470
  /**
4471
- * Update the configuration of a robot controller. Reconfigure certain options of a robot controller, or deploy a specific container image of a robot controller. <!-- theme: warning --> > **WARNING** > > Using it in conjunction with the settings app may lead to unpredictable behavior. To update a virtual controller, the previous controller will be deleted and a new one created. Changes to the configuration, e.g., TCPs, coordinate systems, mounting, are **not** transferred to the new robot. <!-- theme: info --> > **NOTE** > > An update is not a reset. To do a reset: > 1. Get the current configuration via [getRobotController](getRobotController). > 2. Delete the existing virtual robot controller via [deleteRobotController](deleteRobotController). > 3. Add a virtual robot controller with [addRobotController](addRobotController).
4471
+ * Update the configuration of a robot controller. Reconfigure certain options of a robot controller, or deploy a specific container image of a robot controller. <!-- theme: warning --> > **WARNING** > > Using it in conjunction with the settings app may lead to unpredictable behavior. To update a virtual controller, the previous controller will be deleted and a new one created. Changes to the configuration, e.g., TCPs, coordinate systems, mounting, are **not** transferred to the new robot. <!-- theme: info --> > **NOTE** > > An update is not a reset. To do a reset: > 1. Get the current configuration via [getRobotController](#/operations/getRobotController). > 2. Delete the existing virtual robot controller via [deleteRobotController](#/operations/deleteRobotController). > 3. Add a virtual robot controller with [addRobotController](#/operations/addRobotController).
4472
4472
  * @summary Update Robot Controller Configuration
4473
4473
  * @param {string} cell Unique identifier addressing a cell in all API calls.
4474
4474
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -4522,7 +4522,7 @@ declare const ControllerApiFp: (configuration?: Configuration) => {
4522
4522
  */
4523
4523
  getCurrentRobotControllerState(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<RobotControllerState>>;
4524
4524
  /**
4525
- * Get the current robot system mode of a registered robot controller. The robot system mode indicates if a robot controller can be used. See [setDefaultMode](setDefaultMode) for more information about the different modes. The mode is influenced by the operating mode of the robot controller. The operating mode can be changed via [setDefaultMode](setDefaultMode). Request the current operating mode of the robot controller via [getCurrentRobotControllerState](getCurrentRobotControllerState).
4525
+ * Get the current robot system mode of a registered robot controller. The robot system mode indicates if a robot controller can be used. See [setDefaultMode](#/operations/setDefaultMode) for more information about the different modes. The mode is influenced by the operating mode of the robot controller. The operating mode can be changed via [setDefaultMode](#/operations/setDefaultMode). Request the current operating mode of the robot controller via [getCurrentRobotControllerState](#/operations/getCurrentRobotControllerState).
4526
4526
  * @summary Current Mode
4527
4527
  * @param {string} cell Unique identifier addressing a cell in all API calls.
4528
4528
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -4549,7 +4549,7 @@ declare const ControllerApiFp: (configuration?: Configuration) => {
4549
4549
  */
4550
4550
  getSupportedModes(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ControllerCapabilities>>;
4551
4551
  /**
4552
- * Receive data to configure a virtual robot controller based on another controller. This can be used to create a virtual clone of a specific physical robot. When adding a virtual controller, use the Virtual configuration variant of [addRobotController](addRobotController) and pass the content string from this endpoint as the `json` field. Omit the `type` field that selects a preset configuration which is not required when providing a complete configuration. > **NOTE** > > The output generated by this endpoint can be too large for the site to handle, and may produce an error or incorrect output. > Use `curl` in combination with `> output.json` to capture the output, or use an API client like Postman.
4552
+ * Receive data to configure a virtual robot controller based on another controller. This can be used to create a virtual clone of a specific physical robot. When adding a virtual controller, use the virtual configuration variant of [addRobotController](#/operations/addRobotController) and pass the content string from this endpoint as the `json` field. Omit the `type` field that selects a preset configuration, which is not required when providing a complete configuration. > **NOTE** > > The output generated by this endpoint can be too large for the site to handle and may produce an error or incorrect output. > Use `curl` in combination with `> output.json` to capture the output, or use an API client like Postman.
4553
4553
  * @summary Virtual Robot Configuration
4554
4554
  * @param {string} cell Unique identifier addressing a cell in all API calls.
4555
4555
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -4566,7 +4566,7 @@ declare const ControllerApiFp: (configuration?: Configuration) => {
4566
4566
  */
4567
4567
  listControllers(cell: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ControllerInstanceList>>;
4568
4568
  /**
4569
- * Switch between monitor and control usage as default for a robot controller. Monitoring mode is used to read information from the robot controller and control mode is used to command the robot system. As long as the robot controller is connected via network monitoring mode is always possible. To switch to control mode the robot controller must be in `automatic` or `manual` operating mode and safety state \'normal\' or \'reduced\'. If the robot controller is in `manual` operating mode, you have manually confirm the control usage activation on the robot control panel. This manual confirmation can\'t be replaced with this API. Without manual confirmation the robot controller will stay in monitor mode. The robot system will try to activate the required operation mode for the requested usage unless no active call requires a different mode. > **NOTE** > > Some robot controllers prevent the external activation of automatic operating mode. In this case, changing the operating mode manually at the robot controller is mandatory. > **NOTE** > > The current operation mode and safety state can be requested via [getCurrentRobotControllerState](getCurrentRobotControllerState). If a mode change is not possible, the response lists reasons for the failed change.
4569
+ * Switch between monitor and control usage as default for a robot controller. Monitoring mode is used to read information from the robot controller and control mode is used to command the robot system. As long as the robot controller is connected via network, monitoring mode is always possible. To switch to control mode, the robot controller must be in `automatic` or `manual` operating mode and safety state \'normal\' or \'reduced\'. If the robot controller is in `manual` operating mode, you have to manually confirm the control usage activation on the robot control panel. This manual confirmation can\'t be replaced with this API. Without manual confirmation, the robot controller will stay in monitor mode. The robot system will try to activate the required operation mode for the requested usage unless no active call requires a different mode. > **NOTE** > > Some robot controllers prevent the external activation of automatic operating mode. In this case, changing the operating mode manually at the robot controller is mandatory. > **NOTE** > > The current operation mode and safety state can be requested via [getCurrentRobotControllerState](#/operations/getCurrentRobotControllerState). If a mode change is not possible, the response lists reasons for the failed change.
4570
4570
  * @summary Set Default Mode
4571
4571
  * @param {string} cell Unique identifier addressing a cell in all API calls.
4572
4572
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -4586,7 +4586,7 @@ declare const ControllerApiFp: (configuration?: Configuration) => {
4586
4586
  */
4587
4587
  streamFreeDrive(cell: string, controller: string, responseRate?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<RobotControllerState>>;
4588
4588
  /**
4589
- * Receive updates of the current robot system mode of a robot controller via websocket upon robot system mode change. See [setDefaultMode](setDefaultMode) for more information about the different modes.
4589
+ * Receive updates of the current robot system mode of a robot controller via websocket upon robot system mode change. See [setDefaultMode](#/operations/setDefaultMode) for more information about the different modes.
4590
4590
  * @summary Stream Mode Change
4591
4591
  * @param {string} cell Unique identifier addressing a cell in all API calls.
4592
4592
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -4605,7 +4605,7 @@ declare const ControllerApiFp: (configuration?: Configuration) => {
4605
4605
  */
4606
4606
  streamRobotControllerState(cell: string, controller: string, responseRate?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<RobotControllerState>>;
4607
4607
  /**
4608
- * Update the configuration of a robot controller. Reconfigure certain options of a robot controller, or deploy a specific container image of a robot controller. <!-- theme: warning --> > **WARNING** > > Using it in conjunction with the settings app may lead to unpredictable behavior. To update a virtual controller, the previous controller will be deleted and a new one created. Changes to the configuration, e.g., TCPs, coordinate systems, mounting, are **not** transferred to the new robot. <!-- theme: info --> > **NOTE** > > An update is not a reset. To do a reset: > 1. Get the current configuration via [getRobotController](getRobotController). > 2. Delete the existing virtual robot controller via [deleteRobotController](deleteRobotController). > 3. Add a virtual robot controller with [addRobotController](addRobotController).
4608
+ * Update the configuration of a robot controller. Reconfigure certain options of a robot controller, or deploy a specific container image of a robot controller. <!-- theme: warning --> > **WARNING** > > Using it in conjunction with the settings app may lead to unpredictable behavior. To update a virtual controller, the previous controller will be deleted and a new one created. Changes to the configuration, e.g., TCPs, coordinate systems, mounting, are **not** transferred to the new robot. <!-- theme: info --> > **NOTE** > > An update is not a reset. To do a reset: > 1. Get the current configuration via [getRobotController](#/operations/getRobotController). > 2. Delete the existing virtual robot controller via [deleteRobotController](#/operations/deleteRobotController). > 3. Add a virtual robot controller with [addRobotController](#/operations/addRobotController).
4609
4609
  * @summary Update Robot Controller Configuration
4610
4610
  * @param {string} cell Unique identifier addressing a cell in all API calls.
4611
4611
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -4659,7 +4659,7 @@ declare const ControllerApiFactory: (configuration?: Configuration, basePath?: s
4659
4659
  */
4660
4660
  getCurrentRobotControllerState(cell: string, controller: string, options?: RawAxiosRequestConfig): AxiosPromise<RobotControllerState>;
4661
4661
  /**
4662
- * Get the current robot system mode of a registered robot controller. The robot system mode indicates if a robot controller can be used. See [setDefaultMode](setDefaultMode) for more information about the different modes. The mode is influenced by the operating mode of the robot controller. The operating mode can be changed via [setDefaultMode](setDefaultMode). Request the current operating mode of the robot controller via [getCurrentRobotControllerState](getCurrentRobotControllerState).
4662
+ * Get the current robot system mode of a registered robot controller. The robot system mode indicates if a robot controller can be used. See [setDefaultMode](#/operations/setDefaultMode) for more information about the different modes. The mode is influenced by the operating mode of the robot controller. The operating mode can be changed via [setDefaultMode](#/operations/setDefaultMode). Request the current operating mode of the robot controller via [getCurrentRobotControllerState](#/operations/getCurrentRobotControllerState).
4663
4663
  * @summary Current Mode
4664
4664
  * @param {string} cell Unique identifier addressing a cell in all API calls.
4665
4665
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -4686,7 +4686,7 @@ declare const ControllerApiFactory: (configuration?: Configuration, basePath?: s
4686
4686
  */
4687
4687
  getSupportedModes(cell: string, controller: string, options?: RawAxiosRequestConfig): AxiosPromise<ControllerCapabilities>;
4688
4688
  /**
4689
- * Receive data to configure a virtual robot controller based on another controller. This can be used to create a virtual clone of a specific physical robot. When adding a virtual controller, use the Virtual configuration variant of [addRobotController](addRobotController) and pass the content string from this endpoint as the `json` field. Omit the `type` field that selects a preset configuration which is not required when providing a complete configuration. > **NOTE** > > The output generated by this endpoint can be too large for the site to handle, and may produce an error or incorrect output. > Use `curl` in combination with `> output.json` to capture the output, or use an API client like Postman.
4689
+ * Receive data to configure a virtual robot controller based on another controller. This can be used to create a virtual clone of a specific physical robot. When adding a virtual controller, use the virtual configuration variant of [addRobotController](#/operations/addRobotController) and pass the content string from this endpoint as the `json` field. Omit the `type` field that selects a preset configuration, which is not required when providing a complete configuration. > **NOTE** > > The output generated by this endpoint can be too large for the site to handle and may produce an error or incorrect output. > Use `curl` in combination with `> output.json` to capture the output, or use an API client like Postman.
4690
4690
  * @summary Virtual Robot Configuration
4691
4691
  * @param {string} cell Unique identifier addressing a cell in all API calls.
4692
4692
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -4703,7 +4703,7 @@ declare const ControllerApiFactory: (configuration?: Configuration, basePath?: s
4703
4703
  */
4704
4704
  listControllers(cell: string, options?: RawAxiosRequestConfig): AxiosPromise<ControllerInstanceList>;
4705
4705
  /**
4706
- * Switch between monitor and control usage as default for a robot controller. Monitoring mode is used to read information from the robot controller and control mode is used to command the robot system. As long as the robot controller is connected via network monitoring mode is always possible. To switch to control mode the robot controller must be in `automatic` or `manual` operating mode and safety state \'normal\' or \'reduced\'. If the robot controller is in `manual` operating mode, you have manually confirm the control usage activation on the robot control panel. This manual confirmation can\'t be replaced with this API. Without manual confirmation the robot controller will stay in monitor mode. The robot system will try to activate the required operation mode for the requested usage unless no active call requires a different mode. > **NOTE** > > Some robot controllers prevent the external activation of automatic operating mode. In this case, changing the operating mode manually at the robot controller is mandatory. > **NOTE** > > The current operation mode and safety state can be requested via [getCurrentRobotControllerState](getCurrentRobotControllerState). If a mode change is not possible, the response lists reasons for the failed change.
4706
+ * Switch between monitor and control usage as default for a robot controller. Monitoring mode is used to read information from the robot controller and control mode is used to command the robot system. As long as the robot controller is connected via network, monitoring mode is always possible. To switch to control mode, the robot controller must be in `automatic` or `manual` operating mode and safety state \'normal\' or \'reduced\'. If the robot controller is in `manual` operating mode, you have to manually confirm the control usage activation on the robot control panel. This manual confirmation can\'t be replaced with this API. Without manual confirmation, the robot controller will stay in monitor mode. The robot system will try to activate the required operation mode for the requested usage unless no active call requires a different mode. > **NOTE** > > Some robot controllers prevent the external activation of automatic operating mode. In this case, changing the operating mode manually at the robot controller is mandatory. > **NOTE** > > The current operation mode and safety state can be requested via [getCurrentRobotControllerState](#/operations/getCurrentRobotControllerState). If a mode change is not possible, the response lists reasons for the failed change.
4707
4707
  * @summary Set Default Mode
4708
4708
  * @param {string} cell Unique identifier addressing a cell in all API calls.
4709
4709
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -4723,7 +4723,7 @@ declare const ControllerApiFactory: (configuration?: Configuration, basePath?: s
4723
4723
  */
4724
4724
  streamFreeDrive(cell: string, controller: string, responseRate?: number, options?: RawAxiosRequestConfig): AxiosPromise<RobotControllerState>;
4725
4725
  /**
4726
- * Receive updates of the current robot system mode of a robot controller via websocket upon robot system mode change. See [setDefaultMode](setDefaultMode) for more information about the different modes.
4726
+ * Receive updates of the current robot system mode of a robot controller via websocket upon robot system mode change. See [setDefaultMode](#/operations/setDefaultMode) for more information about the different modes.
4727
4727
  * @summary Stream Mode Change
4728
4728
  * @param {string} cell Unique identifier addressing a cell in all API calls.
4729
4729
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -4742,7 +4742,7 @@ declare const ControllerApiFactory: (configuration?: Configuration, basePath?: s
4742
4742
  */
4743
4743
  streamRobotControllerState(cell: string, controller: string, responseRate?: number, options?: RawAxiosRequestConfig): AxiosPromise<RobotControllerState>;
4744
4744
  /**
4745
- * Update the configuration of a robot controller. Reconfigure certain options of a robot controller, or deploy a specific container image of a robot controller. <!-- theme: warning --> > **WARNING** > > Using it in conjunction with the settings app may lead to unpredictable behavior. To update a virtual controller, the previous controller will be deleted and a new one created. Changes to the configuration, e.g., TCPs, coordinate systems, mounting, are **not** transferred to the new robot. <!-- theme: info --> > **NOTE** > > An update is not a reset. To do a reset: > 1. Get the current configuration via [getRobotController](getRobotController). > 2. Delete the existing virtual robot controller via [deleteRobotController](deleteRobotController). > 3. Add a virtual robot controller with [addRobotController](addRobotController).
4745
+ * Update the configuration of a robot controller. Reconfigure certain options of a robot controller, or deploy a specific container image of a robot controller. <!-- theme: warning --> > **WARNING** > > Using it in conjunction with the settings app may lead to unpredictable behavior. To update a virtual controller, the previous controller will be deleted and a new one created. Changes to the configuration, e.g., TCPs, coordinate systems, mounting, are **not** transferred to the new robot. <!-- theme: info --> > **NOTE** > > An update is not a reset. To do a reset: > 1. Get the current configuration via [getRobotController](#/operations/getRobotController). > 2. Delete the existing virtual robot controller via [deleteRobotController](#/operations/deleteRobotController). > 3. Add a virtual robot controller with [addRobotController](#/operations/addRobotController).
4746
4746
  * @summary Update Robot Controller Configuration
4747
4747
  * @param {string} cell Unique identifier addressing a cell in all API calls.
4748
4748
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -4766,7 +4766,7 @@ declare class ControllerApi extends BaseAPI {
4766
4766
  * @param {*} [options] Override http request option.
4767
4767
  * @throws {RequiredError}
4768
4768
  */
4769
- addRobotController(cell: string, robotController: RobotController, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
4769
+ addRobotController(cell: string, robotController: RobotController, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<axios142.AxiosResponse<void, any>>;
4770
4770
  /**
4771
4771
  * Delete all robot controllers from the cell. To replace all robot controllers in a cell, use this endpoint in combination with the \'Add Robot Controller\' endpoint. <!-- theme: warning --> > **WARNING** > > Using it in conjunction with the settings app may lead to unpredictable behavior.
4772
4772
  * @summary Clear Robot Controllers
@@ -4775,7 +4775,7 @@ declare class ControllerApi extends BaseAPI {
4775
4775
  * @param {*} [options] Override http request option.
4776
4776
  * @throws {RequiredError}
4777
4777
  */
4778
- clearRobotControllers(cell: string, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
4778
+ clearRobotControllers(cell: string, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<axios142.AxiosResponse<void, any>>;
4779
4779
  /**
4780
4780
  * Delete a robot controller from the cell. <!-- theme: warning --> > **WARNING** > > Using it in conjunction with the settings app may lead to unpredictable behavior.
4781
4781
  * @summary Delete Robot Controller
@@ -4785,7 +4785,7 @@ declare class ControllerApi extends BaseAPI {
4785
4785
  * @param {*} [options] Override http request option.
4786
4786
  * @throws {RequiredError}
4787
4787
  */
4788
- deleteRobotController(cell: string, controller: string, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
4788
+ deleteRobotController(cell: string, controller: string, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<axios142.AxiosResponse<void, any>>;
4789
4789
  /**
4790
4790
  * Get the current state of a robot controller.
4791
4791
  * @summary State of Device
@@ -4794,16 +4794,16 @@ declare class ControllerApi extends BaseAPI {
4794
4794
  * @param {*} [options] Override http request option.
4795
4795
  * @throws {RequiredError}
4796
4796
  */
4797
- getCurrentRobotControllerState(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<RobotControllerState, any>>;
4797
+ getCurrentRobotControllerState(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<axios142.AxiosResponse<RobotControllerState, any>>;
4798
4798
  /**
4799
- * Get the current robot system mode of a registered robot controller. The robot system mode indicates if a robot controller can be used. See [setDefaultMode](setDefaultMode) for more information about the different modes. The mode is influenced by the operating mode of the robot controller. The operating mode can be changed via [setDefaultMode](setDefaultMode). Request the current operating mode of the robot controller via [getCurrentRobotControllerState](getCurrentRobotControllerState).
4799
+ * Get the current robot system mode of a registered robot controller. The robot system mode indicates if a robot controller can be used. See [setDefaultMode](#/operations/setDefaultMode) for more information about the different modes. The mode is influenced by the operating mode of the robot controller. The operating mode can be changed via [setDefaultMode](#/operations/setDefaultMode). Request the current operating mode of the robot controller via [getCurrentRobotControllerState](#/operations/getCurrentRobotControllerState).
4800
4800
  * @summary Current Mode
4801
4801
  * @param {string} cell Unique identifier addressing a cell in all API calls.
4802
4802
  * @param {string} controller Unique identifier to address a controller in the cell.
4803
4803
  * @param {*} [options] Override http request option.
4804
4804
  * @throws {RequiredError}
4805
4805
  */
4806
- getMode(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<GetModeResponse, any>>;
4806
+ getMode(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<axios142.AxiosResponse<GetModeResponse, any>>;
4807
4807
  /**
4808
4808
  * Get the configuration for a robot controller.
4809
4809
  * @summary Robot Controller Configuration
@@ -4812,7 +4812,7 @@ declare class ControllerApi extends BaseAPI {
4812
4812
  * @param {*} [options] Override http request option.
4813
4813
  * @throws {RequiredError}
4814
4814
  */
4815
- getRobotController(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<RobotController, any>>;
4815
+ getRobotController(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<axios142.AxiosResponse<RobotController, any>>;
4816
4816
  /**
4817
4817
  * Lists supported operating modes. Usually cobots support free drive and control, industrial robots only support control.
4818
4818
  * @summary Supported Motion Modes
@@ -4821,16 +4821,16 @@ declare class ControllerApi extends BaseAPI {
4821
4821
  * @param {*} [options] Override http request option.
4822
4822
  * @throws {RequiredError}
4823
4823
  */
4824
- getSupportedModes(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<ControllerCapabilities, any>>;
4824
+ getSupportedModes(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<axios142.AxiosResponse<ControllerCapabilities, any>>;
4825
4825
  /**
4826
- * Receive data to configure a virtual robot controller based on another controller. This can be used to create a virtual clone of a specific physical robot. When adding a virtual controller, use the Virtual configuration variant of [addRobotController](addRobotController) and pass the content string from this endpoint as the `json` field. Omit the `type` field that selects a preset configuration which is not required when providing a complete configuration. > **NOTE** > > The output generated by this endpoint can be too large for the site to handle, and may produce an error or incorrect output. > Use `curl` in combination with `> output.json` to capture the output, or use an API client like Postman.
4826
+ * Receive data to configure a virtual robot controller based on another controller. This can be used to create a virtual clone of a specific physical robot. When adding a virtual controller, use the virtual configuration variant of [addRobotController](#/operations/addRobotController) and pass the content string from this endpoint as the `json` field. Omit the `type` field that selects a preset configuration, which is not required when providing a complete configuration. > **NOTE** > > The output generated by this endpoint can be too large for the site to handle and may produce an error or incorrect output. > Use `curl` in combination with `> output.json` to capture the output, or use an API client like Postman.
4827
4827
  * @summary Virtual Robot Configuration
4828
4828
  * @param {string} cell Unique identifier addressing a cell in all API calls.
4829
4829
  * @param {string} controller Unique identifier to address a controller in the cell.
4830
4830
  * @param {*} [options] Override http request option.
4831
4831
  * @throws {RequiredError}
4832
4832
  */
4833
- getVirtualRobotConfiguration(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<VirtualRobotConfiguration, any>>;
4833
+ getVirtualRobotConfiguration(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<axios142.AxiosResponse<VirtualRobotConfiguration, any>>;
4834
4834
  /**
4835
4835
  * List all configured robot controllers.
4836
4836
  * @summary List Robot Controllers
@@ -4838,9 +4838,9 @@ declare class ControllerApi extends BaseAPI {
4838
4838
  * @param {*} [options] Override http request option.
4839
4839
  * @throws {RequiredError}
4840
4840
  */
4841
- listControllers(cell: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<ControllerInstanceList, any>>;
4841
+ listControllers(cell: string, options?: RawAxiosRequestConfig): Promise<axios142.AxiosResponse<ControllerInstanceList, any>>;
4842
4842
  /**
4843
- * Switch between monitor and control usage as default for a robot controller. Monitoring mode is used to read information from the robot controller and control mode is used to command the robot system. As long as the robot controller is connected via network monitoring mode is always possible. To switch to control mode the robot controller must be in `automatic` or `manual` operating mode and safety state \'normal\' or \'reduced\'. If the robot controller is in `manual` operating mode, you have manually confirm the control usage activation on the robot control panel. This manual confirmation can\'t be replaced with this API. Without manual confirmation the robot controller will stay in monitor mode. The robot system will try to activate the required operation mode for the requested usage unless no active call requires a different mode. > **NOTE** > > Some robot controllers prevent the external activation of automatic operating mode. In this case, changing the operating mode manually at the robot controller is mandatory. > **NOTE** > > The current operation mode and safety state can be requested via [getCurrentRobotControllerState](getCurrentRobotControllerState). If a mode change is not possible, the response lists reasons for the failed change.
4843
+ * Switch between monitor and control usage as default for a robot controller. Monitoring mode is used to read information from the robot controller and control mode is used to command the robot system. As long as the robot controller is connected via network, monitoring mode is always possible. To switch to control mode, the robot controller must be in `automatic` or `manual` operating mode and safety state \'normal\' or \'reduced\'. If the robot controller is in `manual` operating mode, you have to manually confirm the control usage activation on the robot control panel. This manual confirmation can\'t be replaced with this API. Without manual confirmation, the robot controller will stay in monitor mode. The robot system will try to activate the required operation mode for the requested usage unless no active call requires a different mode. > **NOTE** > > Some robot controllers prevent the external activation of automatic operating mode. In this case, changing the operating mode manually at the robot controller is mandatory. > **NOTE** > > The current operation mode and safety state can be requested via [getCurrentRobotControllerState](#/operations/getCurrentRobotControllerState). If a mode change is not possible, the response lists reasons for the failed change.
4844
4844
  * @summary Set Default Mode
4845
4845
  * @param {string} cell Unique identifier addressing a cell in all API calls.
4846
4846
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -4848,7 +4848,7 @@ declare class ControllerApi extends BaseAPI {
4848
4848
  * @param {*} [options] Override http request option.
4849
4849
  * @throws {RequiredError}
4850
4850
  */
4851
- setDefaultMode(cell: string, controller: string, mode: SetDefaultModeModeEnum, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
4851
+ setDefaultMode(cell: string, controller: string, mode: SetDefaultModeModeEnum, options?: RawAxiosRequestConfig): Promise<axios142.AxiosResponse<void, any>>;
4852
4852
  /**
4853
4853
  * Sets the robot controller into freedrive mode and stays in freedrive until the websocket connection is closed by the client. In freedrive mode, it is possible to move the attached motion groups by hand. This is a blocking call. As long as the websocket connection is open, no other endpoint can control or move the robot. <!-- theme: danger --> > **DANGER** > Danger caused by robot. Improper assessment by the integrator of the application-specific hazards can result in people being crushed, > drawn in or caught due to the robot\'s complex movement sequences. Before opening the websocket, ensure that > - The robot is in a safe state, > - The right payload is set (e.g by using the (getActivePayload)[getActivePayload] endpoint), > - No humans or object are within the robot\'s reach or within the cell. As long as the websocket connection is open you will get the current state of the robot system in the response in the specified response_rate. If the activation failed, the returned status will return possible reasons for the failure. Free drive mode is only available for robot controllers that support it, in particular Collobarative Robots (\"Cobots\"). Use the (getSupportedModes)[getSupportedModes] endpoint to check if the robot controller supports free drive mode.
4854
4854
  * @summary Stream Free Drive Mode
@@ -4858,16 +4858,16 @@ declare class ControllerApi extends BaseAPI {
4858
4858
  * @param {*} [options] Override http request option.
4859
4859
  * @throws {RequiredError}
4860
4860
  */
4861
- streamFreeDrive(cell: string, controller: string, responseRate?: number, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<RobotControllerState, any>>;
4861
+ streamFreeDrive(cell: string, controller: string, responseRate?: number, options?: RawAxiosRequestConfig): Promise<axios142.AxiosResponse<RobotControllerState, any>>;
4862
4862
  /**
4863
- * Receive updates of the current robot system mode of a robot controller via websocket upon robot system mode change. See [setDefaultMode](setDefaultMode) for more information about the different modes.
4863
+ * Receive updates of the current robot system mode of a robot controller via websocket upon robot system mode change. See [setDefaultMode](#/operations/setDefaultMode) for more information about the different modes.
4864
4864
  * @summary Stream Mode Change
4865
4865
  * @param {string} cell Unique identifier addressing a cell in all API calls.
4866
4866
  * @param {string} controller Unique identifier to address a controller in the cell.
4867
4867
  * @param {*} [options] Override http request option.
4868
4868
  * @throws {RequiredError}
4869
4869
  */
4870
- streamModeChange(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<ModeChangeResponse, any>>;
4870
+ streamModeChange(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<axios142.AxiosResponse<ModeChangeResponse, any>>;
4871
4871
  /**
4872
4872
  * Receive updates of the state of a robot controller.
4873
4873
  * @summary Stream State of Device
@@ -4877,9 +4877,9 @@ declare class ControllerApi extends BaseAPI {
4877
4877
  * @param {*} [options] Override http request option.
4878
4878
  * @throws {RequiredError}
4879
4879
  */
4880
- streamRobotControllerState(cell: string, controller: string, responseRate?: number, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<RobotControllerState, any>>;
4880
+ streamRobotControllerState(cell: string, controller: string, responseRate?: number, options?: RawAxiosRequestConfig): Promise<axios142.AxiosResponse<RobotControllerState, any>>;
4881
4881
  /**
4882
- * Update the configuration of a robot controller. Reconfigure certain options of a robot controller, or deploy a specific container image of a robot controller. <!-- theme: warning --> > **WARNING** > > Using it in conjunction with the settings app may lead to unpredictable behavior. To update a virtual controller, the previous controller will be deleted and a new one created. Changes to the configuration, e.g., TCPs, coordinate systems, mounting, are **not** transferred to the new robot. <!-- theme: info --> > **NOTE** > > An update is not a reset. To do a reset: > 1. Get the current configuration via [getRobotController](getRobotController). > 2. Delete the existing virtual robot controller via [deleteRobotController](deleteRobotController). > 3. Add a virtual robot controller with [addRobotController](addRobotController).
4882
+ * Update the configuration of a robot controller. Reconfigure certain options of a robot controller, or deploy a specific container image of a robot controller. <!-- theme: warning --> > **WARNING** > > Using it in conjunction with the settings app may lead to unpredictable behavior. To update a virtual controller, the previous controller will be deleted and a new one created. Changes to the configuration, e.g., TCPs, coordinate systems, mounting, are **not** transferred to the new robot. <!-- theme: info --> > **NOTE** > > An update is not a reset. To do a reset: > 1. Get the current configuration via [getRobotController](#/operations/getRobotController). > 2. Delete the existing virtual robot controller via [deleteRobotController](#/operations/deleteRobotController). > 3. Add a virtual robot controller with [addRobotController](#/operations/addRobotController).
4883
4883
  * @summary Update Robot Controller Configuration
4884
4884
  * @param {string} cell Unique identifier addressing a cell in all API calls.
4885
4885
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -4888,7 +4888,7 @@ declare class ControllerApi extends BaseAPI {
4888
4888
  * @param {*} [options] Override http request option.
4889
4889
  * @throws {RequiredError}
4890
4890
  */
4891
- updateRobotController(cell: string, controller: string, robotController: RobotController, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
4891
+ updateRobotController(cell: string, controller: string, robotController: RobotController, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<axios142.AxiosResponse<void, any>>;
4892
4892
  }
4893
4893
  declare const SetDefaultModeModeEnum: {
4894
4894
  readonly ModeMonitor: "MODE_MONITOR";
@@ -4910,7 +4910,7 @@ declare const ControllerIOsApiAxiosParamCreator: (configuration?: Configuration)
4910
4910
  */
4911
4911
  listIODescriptions: (cell: string, controller: string, ios?: Array<string>, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
4912
4912
  /**
4913
- * Retrieves the current values of I/Os. The identifiers of the I/Os must be provided in the request. Request all available I/O identifiers via [listIODescriptions](listIODescriptions).
4913
+ * Retrieves the current values of I/Os. The identifiers of the I/Os must be provided in the request. Request all available I/O identifiers via [listIODescriptions](#/operations/listIODescriptions).
4914
4914
  * @summary Values
4915
4915
  * @param {string} cell Unique identifier addressing a cell in all API calls.
4916
4916
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -4920,7 +4920,7 @@ declare const ControllerIOsApiAxiosParamCreator: (configuration?: Configuration)
4920
4920
  */
4921
4921
  listIOValues: (cell: string, controller: string, ios?: Array<string>, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
4922
4922
  /**
4923
- * Set the values of outputs. All available I/O identifiers and possible value ranges can be requested via [listIODescriptions](listIODescriptions). The call will return once the values have been set on and accepted by the robot. This might take up to 200 milliseconds. > **NOTE** > > Do not call this endpoint while another request is still in progress. The second call will fail.
4923
+ * Set the values of outputs. All available I/O identifiers and possible value ranges can be requested via [listIODescriptions](#/operations/listIODescriptions). The call will return once the values have been set on and accepted by the robot. This might take up to 200 milliseconds. > **NOTE** > > Do not call this endpoint while another request is still in progress. The second call will fail.
4924
4924
  * @summary Set Values
4925
4925
  * @param {string} cell Unique identifier addressing a cell in all API calls.
4926
4926
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -4969,7 +4969,7 @@ declare const ControllerIOsApiFp: (configuration?: Configuration) => {
4969
4969
  */
4970
4970
  listIODescriptions(cell: string, controller: string, ios?: Array<string>, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListIODescriptionsResponse>>;
4971
4971
  /**
4972
- * Retrieves the current values of I/Os. The identifiers of the I/Os must be provided in the request. Request all available I/O identifiers via [listIODescriptions](listIODescriptions).
4972
+ * Retrieves the current values of I/Os. The identifiers of the I/Os must be provided in the request. Request all available I/O identifiers via [listIODescriptions](#/operations/listIODescriptions).
4973
4973
  * @summary Values
4974
4974
  * @param {string} cell Unique identifier addressing a cell in all API calls.
4975
4975
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -4979,7 +4979,7 @@ declare const ControllerIOsApiFp: (configuration?: Configuration) => {
4979
4979
  */
4980
4980
  listIOValues(cell: string, controller: string, ios?: Array<string>, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListIOValuesResponse>>;
4981
4981
  /**
4982
- * Set the values of outputs. All available I/O identifiers and possible value ranges can be requested via [listIODescriptions](listIODescriptions). The call will return once the values have been set on and accepted by the robot. This might take up to 200 milliseconds. > **NOTE** > > Do not call this endpoint while another request is still in progress. The second call will fail.
4982
+ * Set the values of outputs. All available I/O identifiers and possible value ranges can be requested via [listIODescriptions](#/operations/listIODescriptions). The call will return once the values have been set on and accepted by the robot. This might take up to 200 milliseconds. > **NOTE** > > Do not call this endpoint while another request is still in progress. The second call will fail.
4983
4983
  * @summary Set Values
4984
4984
  * @param {string} cell Unique identifier addressing a cell in all API calls.
4985
4985
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -5028,7 +5028,7 @@ declare const ControllerIOsApiFactory: (configuration?: Configuration, basePath?
5028
5028
  */
5029
5029
  listIODescriptions(cell: string, controller: string, ios?: Array<string>, options?: RawAxiosRequestConfig): AxiosPromise<ListIODescriptionsResponse>;
5030
5030
  /**
5031
- * Retrieves the current values of I/Os. The identifiers of the I/Os must be provided in the request. Request all available I/O identifiers via [listIODescriptions](listIODescriptions).
5031
+ * Retrieves the current values of I/Os. The identifiers of the I/Os must be provided in the request. Request all available I/O identifiers via [listIODescriptions](#/operations/listIODescriptions).
5032
5032
  * @summary Values
5033
5033
  * @param {string} cell Unique identifier addressing a cell in all API calls.
5034
5034
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -5038,7 +5038,7 @@ declare const ControllerIOsApiFactory: (configuration?: Configuration, basePath?
5038
5038
  */
5039
5039
  listIOValues(cell: string, controller: string, ios?: Array<string>, options?: RawAxiosRequestConfig): AxiosPromise<ListIOValuesResponse>;
5040
5040
  /**
5041
- * Set the values of outputs. All available I/O identifiers and possible value ranges can be requested via [listIODescriptions](listIODescriptions). The call will return once the values have been set on and accepted by the robot. This might take up to 200 milliseconds. > **NOTE** > > Do not call this endpoint while another request is still in progress. The second call will fail.
5041
+ * Set the values of outputs. All available I/O identifiers and possible value ranges can be requested via [listIODescriptions](#/operations/listIODescriptions). The call will return once the values have been set on and accepted by the robot. This might take up to 200 milliseconds. > **NOTE** > > Do not call this endpoint while another request is still in progress. The second call will fail.
5042
5042
  * @summary Set Values
5043
5043
  * @param {string} cell Unique identifier addressing a cell in all API calls.
5044
5044
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -5085,9 +5085,9 @@ declare class ControllerIOsApi extends BaseAPI {
5085
5085
  * @param {*} [options] Override http request option.
5086
5086
  * @throws {RequiredError}
5087
5087
  */
5088
- listIODescriptions(cell: string, controller: string, ios?: Array<string>, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<ListIODescriptionsResponse, any>>;
5088
+ listIODescriptions(cell: string, controller: string, ios?: Array<string>, options?: RawAxiosRequestConfig): Promise<axios142.AxiosResponse<ListIODescriptionsResponse, any>>;
5089
5089
  /**
5090
- * Retrieves the current values of I/Os. The identifiers of the I/Os must be provided in the request. Request all available I/O identifiers via [listIODescriptions](listIODescriptions).
5090
+ * Retrieves the current values of I/Os. The identifiers of the I/Os must be provided in the request. Request all available I/O identifiers via [listIODescriptions](#/operations/listIODescriptions).
5091
5091
  * @summary Values
5092
5092
  * @param {string} cell Unique identifier addressing a cell in all API calls.
5093
5093
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -5095,9 +5095,9 @@ declare class ControllerIOsApi extends BaseAPI {
5095
5095
  * @param {*} [options] Override http request option.
5096
5096
  * @throws {RequiredError}
5097
5097
  */
5098
- listIOValues(cell: string, controller: string, ios?: Array<string>, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<ListIOValuesResponse, any>>;
5098
+ listIOValues(cell: string, controller: string, ios?: Array<string>, options?: RawAxiosRequestConfig): Promise<axios142.AxiosResponse<ListIOValuesResponse, any>>;
5099
5099
  /**
5100
- * Set the values of outputs. All available I/O identifiers and possible value ranges can be requested via [listIODescriptions](listIODescriptions). The call will return once the values have been set on and accepted by the robot. This might take up to 200 milliseconds. > **NOTE** > > Do not call this endpoint while another request is still in progress. The second call will fail.
5100
+ * Set the values of outputs. All available I/O identifiers and possible value ranges can be requested via [listIODescriptions](#/operations/listIODescriptions). The call will return once the values have been set on and accepted by the robot. This might take up to 200 milliseconds. > **NOTE** > > Do not call this endpoint while another request is still in progress. The second call will fail.
5101
5101
  * @summary Set Values
5102
5102
  * @param {string} cell Unique identifier addressing a cell in all API calls.
5103
5103
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -5105,7 +5105,7 @@ declare class ControllerIOsApi extends BaseAPI {
5105
5105
  * @param {*} [options] Override http request option.
5106
5106
  * @throws {RequiredError}
5107
5107
  */
5108
- setOutputValues(cell: string, controller: string, iOValue: Array<IOValue>, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
5108
+ setOutputValues(cell: string, controller: string, iOValue: Array<IOValue>, options?: RawAxiosRequestConfig): Promise<axios142.AxiosResponse<void, any>>;
5109
5109
  /**
5110
5110
  * Continuously receive updates of I/O values via websocket. Updates are sent in the update rate of the controller. > **NOTE** > > Do not request too many values simultaneously as the request is then likely to fail. The amount of values that can be streamed simultaneously depends on the specific robot controller. > **NOTE** > > The inputs and outputs are sent in the update rate of the controller to prevent losing any values. Consider that this might lead to a high amount of data transmitted.
5111
5111
  * @summary Stream Values
@@ -5115,7 +5115,7 @@ declare class ControllerIOsApi extends BaseAPI {
5115
5115
  * @param {*} [options] Override http request option.
5116
5116
  * @throws {RequiredError}
5117
5117
  */
5118
- streamIOValues(cell: string, controller: string, ios?: Array<string>, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<ListIOValuesResponse, any>>;
5118
+ streamIOValues(cell: string, controller: string, ios?: Array<string>, options?: RawAxiosRequestConfig): Promise<axios142.AxiosResponse<ListIOValuesResponse, any>>;
5119
5119
  /**
5120
5120
  * Wait until an I/O reaches a certain value. This call returns as soon as the condition is met or the request fails. The comparison_type value is used to define how the current value of the I/O is compared with given value. Only set the value that corresponds to the value_type of the I/O, see (listIODescriptions)[listIODescriptions] for more information. Examples: If you want to wait until an analog input (\"AI_1\") is less than 10, you would set io to \"AI_1\" comparison_type to COMPARISON_LESS and only integer_value to 10. If you want to wait until an analog input (\"AI_2\") is greater than 5.0, you would set io to \"AI_2\" comparison_type to COMPARISON_GREATER and only floating_value to 5.0. If you want to wait until a digital input (\"DI_3\") is true, you would set io to \"DI_3\" comparison_type to COMPARISON_EQUAL and only boolean_value to true.
5121
5121
  * @summary Wait For
@@ -5129,7 +5129,7 @@ declare class ControllerIOsApi extends BaseAPI {
5129
5129
  * @param {*} [options] Override http request option.
5130
5130
  * @throws {RequiredError}
5131
5131
  */
5132
- waitForIOEvent(cell: string, controller: string, io: string, comparisonType: WaitForIOEventComparisonTypeEnum, booleanValue?: boolean, integerValue?: string, floatingValue?: number, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<boolean, any>>;
5132
+ waitForIOEvent(cell: string, controller: string, io: string, comparisonType: WaitForIOEventComparisonTypeEnum, booleanValue?: boolean, integerValue?: string, floatingValue?: number, options?: RawAxiosRequestConfig): Promise<axios142.AxiosResponse<boolean, any>>;
5133
5133
  }
5134
5134
  declare const WaitForIOEventComparisonTypeEnum: {
5135
5135
  readonly ComparisonTypeEqual: "COMPARISON_TYPE_EQUAL";
@@ -5142,7 +5142,7 @@ type WaitForIOEventComparisonTypeEnum = typeof WaitForIOEventComparisonTypeEnum[
5142
5142
  */
5143
5143
  declare const CoordinateSystemsApiAxiosParamCreator: (configuration?: Configuration) => {
5144
5144
  /**
5145
- * Add a user coordinate system to the list of coordinate systems but not on a robot controller. The coordinate system is defined by a name and an offset in another coordinate system referenced by the unique identifier of the reference coordinate system. Will return the specification of the added coordinate systems which includes the unique identifier of the added coordinate system. All available coordinate systems can be listed via the [listCoordinateSystems](listCoordinateSystems) endpoint.
5145
+ * Add a user coordinate system to the list of coordinate systems but not on a robot controller. The coordinate system is defined by a name and an offset in another coordinate system referenced by the unique identifier of the reference coordinate system. Will return the specification of the added coordinate systems which includes the unique identifier of the added coordinate system. All available coordinate systems can be listed via the [listCoordinateSystems](#/operations/listCoordinateSystems) endpoint.
5146
5146
  * @summary Add
5147
5147
  * @param {string} cell Unique identifier addressing a cell in all API calls.
5148
5148
  * @param {AddRequest} addRequest
@@ -5151,7 +5151,7 @@ declare const CoordinateSystemsApiAxiosParamCreator: (configuration?: Configurat
5151
5151
  */
5152
5152
  addCoordinateSystem: (cell: string, addRequest: AddRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
5153
5153
  /**
5154
- * Removes a user coordinate system specified by the given identifier. > **NOTE** > > If the coordinate system has originally been configured on the robot controller, it will remain on the controller even after this endpoint has been executed successfully.. This will remove the user coordinate system from the list of user coordinate systems but keep all dependent coordinate systems which use the deleted coordinate system as reference. Coordinate systems on the robot controller are not affected by this operation. They can be removed via the robot control panel only and will be removed in NOVA when the controller is removed. On virtual controllers, use the [deleteVirtualRobotCoordinateSystem](deleteVirtualRobotCoordinateSystem) endpoint to remove coordinate systems from NOVA and the virtual controller. All available coordinate systems can be listed via the [listCoordinateSystems](listCoordinateSystems) endpoint.
5154
+ * Removes a user coordinate system specified by the given identifier. > **NOTE** > > If the coordinate system has originally been configured on the robot controller, it will remain on the controller even after this endpoint has been executed successfully.. This will remove the user coordinate system from the list of user coordinate systems but keep all dependent coordinate systems which use the deleted coordinate system as reference. Coordinate systems on the robot controller are not affected by this operation. They can be removed via the robot control panel only and will be removed in NOVA when the controller is removed. On virtual controllers, use the [deleteVirtualRobotCoordinateSystem](#/operations/deleteVirtualRobotCoordinateSystem) endpoint to remove coordinate systems from NOVA and the virtual controller. All available coordinate systems can be listed via the [listCoordinateSystems](#/operations/listCoordinateSystems) endpoint.
5155
5155
  * @summary Delete
5156
5156
  * @param {string} cell Unique identifier addressing a cell in all API calls.
5157
5157
  * @param {string} coordinateSystem Unique identifier addressing a coordinate system.
@@ -5160,7 +5160,7 @@ declare const CoordinateSystemsApiAxiosParamCreator: (configuration?: Configurat
5160
5160
  */
5161
5161
  deleteCoordinateSystem: (cell: string, coordinateSystem: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
5162
5162
  /**
5163
- * Request a coordinate system specification for a given identifier. Use parameter rotation_type to get the orientation part of the transformation offset of the coordinate system returned in the requested rotation angle type. If parameter rotation_type is not set, the orientation part of the transformation offset of the coordinate system is returned in the rotation angle type used on the robot controller. This can be useful for visualization purposes in the client application due to equivalent numbers with robot control panel visualization. User coordinate systems can be configured on a robot controller during setup or added to the system via the [addCoordinateSystem](addCoordinateSystem) endpoint. Updating the robot controller\'s configuration either requires credentials or is not possible. With the endpoint [addCoordinateSystem](addCoordinateSystem) you can create a coordinate system without changing the robot controller\'s configuration.
5163
+ * Request a coordinate system specification for a given identifier. Use parameter rotation_type to get the orientation part of the transformation offset of the coordinate system returned in the requested rotation angle type. If parameter rotation_type is not set, the orientation part of the transformation offset of the coordinate system is returned in the rotation angle type used on the robot controller. This can be useful for visualization purposes in the client application due to equivalent numbers with robot control panel visualization. User coordinate systems can be configured on a robot controller during setup or added to the system via the [addCoordinateSystem](#/operations/addCoordinateSystem) endpoint. Updating the robot controller\'s configuration either requires credentials or is not possible. With the endpoint [addCoordinateSystem](#/operations/addCoordinateSystem) you can create a coordinate system without changing the robot controller\'s configuration.
5164
5164
  * @summary Description
5165
5165
  * @param {string} cell Unique identifier addressing a cell in all API calls.
5166
5166
  * @param {string} coordinateSystem Unique identifier addressing a coordinate system.
@@ -5170,7 +5170,7 @@ declare const CoordinateSystemsApiAxiosParamCreator: (configuration?: Configurat
5170
5170
  */
5171
5171
  getCoordinateSystem: (cell: string, coordinateSystem: string, rotationType?: RotationAngleTypes, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
5172
5172
  /**
5173
- * Lists all specifications of coordinate systems from robot controllers and user coordinate systems added to the system via the [addCoordinateSystem](addCoordinateSystem) endpoint. Use parameter rotation_type to get the orientation part of the transformation offset of the coordinate system returned in the requested rotation angle type. If parameter rotation_type is not set, the orientation part of the transformation offset of the coordinate system is returned in the rotation angle type used on the robot controller. This can be useful for visualization purposes in the client application due to equivalent numbers with robot control panel visualization. The coordinate systems from the robot controller are loaded when the motion group associated with the coordinate system is activated. With deactivation of the motion group, the associated coordinate systems are removed from NOVA. The unique identifier of the coordinate systems from the robot controllers are suffixed with \"On\" + the unique identifier of the robot controller. Updating the robot controller\'s configuration either requires credentials or is not possible. With the endpoint [addCoordinateSystem](addCoordinateSystem) you can create a coordinate system without changing the robot controller\'s configuration.
5173
+ * Lists all specifications of coordinate systems from robot controllers and user coordinate systems added to the system via the [addCoordinateSystem](#/operations/addCoordinateSystem) endpoint. Use parameter rotation_type to get the orientation part of the transformation offset of the coordinate system returned in the requested rotation angle type. If parameter rotation_type is not set, the orientation part of the transformation offset of the coordinate system is returned in the rotation angle type used on the robot controller. This can be useful for visualization purposes in the client application due to equivalent numbers with robot control panel visualization. The coordinate systems from the robot controller are loaded when the motion group associated with the coordinate system is activated. With deactivation of the motion group, the associated coordinate systems are removed from NOVA. The unique identifier of the coordinate systems from the robot controllers are suffixed with \"On\" + the unique identifier of the robot controller. Updating the robot controller\'s configuration either requires credentials or is not possible. With the endpoint [addCoordinateSystem](#/operations/addCoordinateSystem) you can create a coordinate system without changing the robot controller\'s configuration.
5174
5174
  * @summary List
5175
5175
  * @param {string} cell Unique identifier addressing a cell in all API calls.
5176
5176
  * @param {RotationAngleTypes} [rotationType]
@@ -5194,7 +5194,7 @@ declare const CoordinateSystemsApiAxiosParamCreator: (configuration?: Configurat
5194
5194
  */
5195
5195
  declare const CoordinateSystemsApiFp: (configuration?: Configuration) => {
5196
5196
  /**
5197
- * Add a user coordinate system to the list of coordinate systems but not on a robot controller. The coordinate system is defined by a name and an offset in another coordinate system referenced by the unique identifier of the reference coordinate system. Will return the specification of the added coordinate systems which includes the unique identifier of the added coordinate system. All available coordinate systems can be listed via the [listCoordinateSystems](listCoordinateSystems) endpoint.
5197
+ * Add a user coordinate system to the list of coordinate systems but not on a robot controller. The coordinate system is defined by a name and an offset in another coordinate system referenced by the unique identifier of the reference coordinate system. Will return the specification of the added coordinate systems which includes the unique identifier of the added coordinate system. All available coordinate systems can be listed via the [listCoordinateSystems](#/operations/listCoordinateSystems) endpoint.
5198
5198
  * @summary Add
5199
5199
  * @param {string} cell Unique identifier addressing a cell in all API calls.
5200
5200
  * @param {AddRequest} addRequest
@@ -5203,7 +5203,7 @@ declare const CoordinateSystemsApiFp: (configuration?: Configuration) => {
5203
5203
  */
5204
5204
  addCoordinateSystem(cell: string, addRequest: AddRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CoordinateSystem>>;
5205
5205
  /**
5206
- * Removes a user coordinate system specified by the given identifier. > **NOTE** > > If the coordinate system has originally been configured on the robot controller, it will remain on the controller even after this endpoint has been executed successfully.. This will remove the user coordinate system from the list of user coordinate systems but keep all dependent coordinate systems which use the deleted coordinate system as reference. Coordinate systems on the robot controller are not affected by this operation. They can be removed via the robot control panel only and will be removed in NOVA when the controller is removed. On virtual controllers, use the [deleteVirtualRobotCoordinateSystem](deleteVirtualRobotCoordinateSystem) endpoint to remove coordinate systems from NOVA and the virtual controller. All available coordinate systems can be listed via the [listCoordinateSystems](listCoordinateSystems) endpoint.
5206
+ * Removes a user coordinate system specified by the given identifier. > **NOTE** > > If the coordinate system has originally been configured on the robot controller, it will remain on the controller even after this endpoint has been executed successfully.. This will remove the user coordinate system from the list of user coordinate systems but keep all dependent coordinate systems which use the deleted coordinate system as reference. Coordinate systems on the robot controller are not affected by this operation. They can be removed via the robot control panel only and will be removed in NOVA when the controller is removed. On virtual controllers, use the [deleteVirtualRobotCoordinateSystem](#/operations/deleteVirtualRobotCoordinateSystem) endpoint to remove coordinate systems from NOVA and the virtual controller. All available coordinate systems can be listed via the [listCoordinateSystems](#/operations/listCoordinateSystems) endpoint.
5207
5207
  * @summary Delete
5208
5208
  * @param {string} cell Unique identifier addressing a cell in all API calls.
5209
5209
  * @param {string} coordinateSystem Unique identifier addressing a coordinate system.
@@ -5212,7 +5212,7 @@ declare const CoordinateSystemsApiFp: (configuration?: Configuration) => {
5212
5212
  */
5213
5213
  deleteCoordinateSystem(cell: string, coordinateSystem: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
5214
5214
  /**
5215
- * Request a coordinate system specification for a given identifier. Use parameter rotation_type to get the orientation part of the transformation offset of the coordinate system returned in the requested rotation angle type. If parameter rotation_type is not set, the orientation part of the transformation offset of the coordinate system is returned in the rotation angle type used on the robot controller. This can be useful for visualization purposes in the client application due to equivalent numbers with robot control panel visualization. User coordinate systems can be configured on a robot controller during setup or added to the system via the [addCoordinateSystem](addCoordinateSystem) endpoint. Updating the robot controller\'s configuration either requires credentials or is not possible. With the endpoint [addCoordinateSystem](addCoordinateSystem) you can create a coordinate system without changing the robot controller\'s configuration.
5215
+ * Request a coordinate system specification for a given identifier. Use parameter rotation_type to get the orientation part of the transformation offset of the coordinate system returned in the requested rotation angle type. If parameter rotation_type is not set, the orientation part of the transformation offset of the coordinate system is returned in the rotation angle type used on the robot controller. This can be useful for visualization purposes in the client application due to equivalent numbers with robot control panel visualization. User coordinate systems can be configured on a robot controller during setup or added to the system via the [addCoordinateSystem](#/operations/addCoordinateSystem) endpoint. Updating the robot controller\'s configuration either requires credentials or is not possible. With the endpoint [addCoordinateSystem](#/operations/addCoordinateSystem) you can create a coordinate system without changing the robot controller\'s configuration.
5216
5216
  * @summary Description
5217
5217
  * @param {string} cell Unique identifier addressing a cell in all API calls.
5218
5218
  * @param {string} coordinateSystem Unique identifier addressing a coordinate system.
@@ -5222,7 +5222,7 @@ declare const CoordinateSystemsApiFp: (configuration?: Configuration) => {
5222
5222
  */
5223
5223
  getCoordinateSystem(cell: string, coordinateSystem: string, rotationType?: RotationAngleTypes, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CoordinateSystem>>;
5224
5224
  /**
5225
- * Lists all specifications of coordinate systems from robot controllers and user coordinate systems added to the system via the [addCoordinateSystem](addCoordinateSystem) endpoint. Use parameter rotation_type to get the orientation part of the transformation offset of the coordinate system returned in the requested rotation angle type. If parameter rotation_type is not set, the orientation part of the transformation offset of the coordinate system is returned in the rotation angle type used on the robot controller. This can be useful for visualization purposes in the client application due to equivalent numbers with robot control panel visualization. The coordinate systems from the robot controller are loaded when the motion group associated with the coordinate system is activated. With deactivation of the motion group, the associated coordinate systems are removed from NOVA. The unique identifier of the coordinate systems from the robot controllers are suffixed with \"On\" + the unique identifier of the robot controller. Updating the robot controller\'s configuration either requires credentials or is not possible. With the endpoint [addCoordinateSystem](addCoordinateSystem) you can create a coordinate system without changing the robot controller\'s configuration.
5225
+ * Lists all specifications of coordinate systems from robot controllers and user coordinate systems added to the system via the [addCoordinateSystem](#/operations/addCoordinateSystem) endpoint. Use parameter rotation_type to get the orientation part of the transformation offset of the coordinate system returned in the requested rotation angle type. If parameter rotation_type is not set, the orientation part of the transformation offset of the coordinate system is returned in the rotation angle type used on the robot controller. This can be useful for visualization purposes in the client application due to equivalent numbers with robot control panel visualization. The coordinate systems from the robot controller are loaded when the motion group associated with the coordinate system is activated. With deactivation of the motion group, the associated coordinate systems are removed from NOVA. The unique identifier of the coordinate systems from the robot controllers are suffixed with \"On\" + the unique identifier of the robot controller. Updating the robot controller\'s configuration either requires credentials or is not possible. With the endpoint [addCoordinateSystem](#/operations/addCoordinateSystem) you can create a coordinate system without changing the robot controller\'s configuration.
5226
5226
  * @summary List
5227
5227
  * @param {string} cell Unique identifier addressing a cell in all API calls.
5228
5228
  * @param {RotationAngleTypes} [rotationType]
@@ -5246,7 +5246,7 @@ declare const CoordinateSystemsApiFp: (configuration?: Configuration) => {
5246
5246
  */
5247
5247
  declare const CoordinateSystemsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
5248
5248
  /**
5249
- * Add a user coordinate system to the list of coordinate systems but not on a robot controller. The coordinate system is defined by a name and an offset in another coordinate system referenced by the unique identifier of the reference coordinate system. Will return the specification of the added coordinate systems which includes the unique identifier of the added coordinate system. All available coordinate systems can be listed via the [listCoordinateSystems](listCoordinateSystems) endpoint.
5249
+ * Add a user coordinate system to the list of coordinate systems but not on a robot controller. The coordinate system is defined by a name and an offset in another coordinate system referenced by the unique identifier of the reference coordinate system. Will return the specification of the added coordinate systems which includes the unique identifier of the added coordinate system. All available coordinate systems can be listed via the [listCoordinateSystems](#/operations/listCoordinateSystems) endpoint.
5250
5250
  * @summary Add
5251
5251
  * @param {string} cell Unique identifier addressing a cell in all API calls.
5252
5252
  * @param {AddRequest} addRequest
@@ -5255,7 +5255,7 @@ declare const CoordinateSystemsApiFactory: (configuration?: Configuration, baseP
5255
5255
  */
5256
5256
  addCoordinateSystem(cell: string, addRequest: AddRequest, options?: RawAxiosRequestConfig): AxiosPromise<CoordinateSystem>;
5257
5257
  /**
5258
- * Removes a user coordinate system specified by the given identifier. > **NOTE** > > If the coordinate system has originally been configured on the robot controller, it will remain on the controller even after this endpoint has been executed successfully.. This will remove the user coordinate system from the list of user coordinate systems but keep all dependent coordinate systems which use the deleted coordinate system as reference. Coordinate systems on the robot controller are not affected by this operation. They can be removed via the robot control panel only and will be removed in NOVA when the controller is removed. On virtual controllers, use the [deleteVirtualRobotCoordinateSystem](deleteVirtualRobotCoordinateSystem) endpoint to remove coordinate systems from NOVA and the virtual controller. All available coordinate systems can be listed via the [listCoordinateSystems](listCoordinateSystems) endpoint.
5258
+ * Removes a user coordinate system specified by the given identifier. > **NOTE** > > If the coordinate system has originally been configured on the robot controller, it will remain on the controller even after this endpoint has been executed successfully.. This will remove the user coordinate system from the list of user coordinate systems but keep all dependent coordinate systems which use the deleted coordinate system as reference. Coordinate systems on the robot controller are not affected by this operation. They can be removed via the robot control panel only and will be removed in NOVA when the controller is removed. On virtual controllers, use the [deleteVirtualRobotCoordinateSystem](#/operations/deleteVirtualRobotCoordinateSystem) endpoint to remove coordinate systems from NOVA and the virtual controller. All available coordinate systems can be listed via the [listCoordinateSystems](#/operations/listCoordinateSystems) endpoint.
5259
5259
  * @summary Delete
5260
5260
  * @param {string} cell Unique identifier addressing a cell in all API calls.
5261
5261
  * @param {string} coordinateSystem Unique identifier addressing a coordinate system.
@@ -5264,7 +5264,7 @@ declare const CoordinateSystemsApiFactory: (configuration?: Configuration, baseP
5264
5264
  */
5265
5265
  deleteCoordinateSystem(cell: string, coordinateSystem: string, options?: RawAxiosRequestConfig): AxiosPromise<void>;
5266
5266
  /**
5267
- * Request a coordinate system specification for a given identifier. Use parameter rotation_type to get the orientation part of the transformation offset of the coordinate system returned in the requested rotation angle type. If parameter rotation_type is not set, the orientation part of the transformation offset of the coordinate system is returned in the rotation angle type used on the robot controller. This can be useful for visualization purposes in the client application due to equivalent numbers with robot control panel visualization. User coordinate systems can be configured on a robot controller during setup or added to the system via the [addCoordinateSystem](addCoordinateSystem) endpoint. Updating the robot controller\'s configuration either requires credentials or is not possible. With the endpoint [addCoordinateSystem](addCoordinateSystem) you can create a coordinate system without changing the robot controller\'s configuration.
5267
+ * Request a coordinate system specification for a given identifier. Use parameter rotation_type to get the orientation part of the transformation offset of the coordinate system returned in the requested rotation angle type. If parameter rotation_type is not set, the orientation part of the transformation offset of the coordinate system is returned in the rotation angle type used on the robot controller. This can be useful for visualization purposes in the client application due to equivalent numbers with robot control panel visualization. User coordinate systems can be configured on a robot controller during setup or added to the system via the [addCoordinateSystem](#/operations/addCoordinateSystem) endpoint. Updating the robot controller\'s configuration either requires credentials or is not possible. With the endpoint [addCoordinateSystem](#/operations/addCoordinateSystem) you can create a coordinate system without changing the robot controller\'s configuration.
5268
5268
  * @summary Description
5269
5269
  * @param {string} cell Unique identifier addressing a cell in all API calls.
5270
5270
  * @param {string} coordinateSystem Unique identifier addressing a coordinate system.
@@ -5274,7 +5274,7 @@ declare const CoordinateSystemsApiFactory: (configuration?: Configuration, baseP
5274
5274
  */
5275
5275
  getCoordinateSystem(cell: string, coordinateSystem: string, rotationType?: RotationAngleTypes, options?: RawAxiosRequestConfig): AxiosPromise<CoordinateSystem>;
5276
5276
  /**
5277
- * Lists all specifications of coordinate systems from robot controllers and user coordinate systems added to the system via the [addCoordinateSystem](addCoordinateSystem) endpoint. Use parameter rotation_type to get the orientation part of the transformation offset of the coordinate system returned in the requested rotation angle type. If parameter rotation_type is not set, the orientation part of the transformation offset of the coordinate system is returned in the rotation angle type used on the robot controller. This can be useful for visualization purposes in the client application due to equivalent numbers with robot control panel visualization. The coordinate systems from the robot controller are loaded when the motion group associated with the coordinate system is activated. With deactivation of the motion group, the associated coordinate systems are removed from NOVA. The unique identifier of the coordinate systems from the robot controllers are suffixed with \"On\" + the unique identifier of the robot controller. Updating the robot controller\'s configuration either requires credentials or is not possible. With the endpoint [addCoordinateSystem](addCoordinateSystem) you can create a coordinate system without changing the robot controller\'s configuration.
5277
+ * Lists all specifications of coordinate systems from robot controllers and user coordinate systems added to the system via the [addCoordinateSystem](#/operations/addCoordinateSystem) endpoint. Use parameter rotation_type to get the orientation part of the transformation offset of the coordinate system returned in the requested rotation angle type. If parameter rotation_type is not set, the orientation part of the transformation offset of the coordinate system is returned in the rotation angle type used on the robot controller. This can be useful for visualization purposes in the client application due to equivalent numbers with robot control panel visualization. The coordinate systems from the robot controller are loaded when the motion group associated with the coordinate system is activated. With deactivation of the motion group, the associated coordinate systems are removed from NOVA. The unique identifier of the coordinate systems from the robot controllers are suffixed with \"On\" + the unique identifier of the robot controller. Updating the robot controller\'s configuration either requires credentials or is not possible. With the endpoint [addCoordinateSystem](#/operations/addCoordinateSystem) you can create a coordinate system without changing the robot controller\'s configuration.
5278
5278
  * @summary List
5279
5279
  * @param {string} cell Unique identifier addressing a cell in all API calls.
5280
5280
  * @param {RotationAngleTypes} [rotationType]
@@ -5298,25 +5298,25 @@ declare const CoordinateSystemsApiFactory: (configuration?: Configuration, baseP
5298
5298
  */
5299
5299
  declare class CoordinateSystemsApi extends BaseAPI {
5300
5300
  /**
5301
- * Add a user coordinate system to the list of coordinate systems but not on a robot controller. The coordinate system is defined by a name and an offset in another coordinate system referenced by the unique identifier of the reference coordinate system. Will return the specification of the added coordinate systems which includes the unique identifier of the added coordinate system. All available coordinate systems can be listed via the [listCoordinateSystems](listCoordinateSystems) endpoint.
5301
+ * Add a user coordinate system to the list of coordinate systems but not on a robot controller. The coordinate system is defined by a name and an offset in another coordinate system referenced by the unique identifier of the reference coordinate system. Will return the specification of the added coordinate systems which includes the unique identifier of the added coordinate system. All available coordinate systems can be listed via the [listCoordinateSystems](#/operations/listCoordinateSystems) endpoint.
5302
5302
  * @summary Add
5303
5303
  * @param {string} cell Unique identifier addressing a cell in all API calls.
5304
5304
  * @param {AddRequest} addRequest
5305
5305
  * @param {*} [options] Override http request option.
5306
5306
  * @throws {RequiredError}
5307
5307
  */
5308
- addCoordinateSystem(cell: string, addRequest: AddRequest, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<CoordinateSystem, any>>;
5308
+ addCoordinateSystem(cell: string, addRequest: AddRequest, options?: RawAxiosRequestConfig): Promise<axios142.AxiosResponse<CoordinateSystem, any>>;
5309
5309
  /**
5310
- * Removes a user coordinate system specified by the given identifier. > **NOTE** > > If the coordinate system has originally been configured on the robot controller, it will remain on the controller even after this endpoint has been executed successfully.. This will remove the user coordinate system from the list of user coordinate systems but keep all dependent coordinate systems which use the deleted coordinate system as reference. Coordinate systems on the robot controller are not affected by this operation. They can be removed via the robot control panel only and will be removed in NOVA when the controller is removed. On virtual controllers, use the [deleteVirtualRobotCoordinateSystem](deleteVirtualRobotCoordinateSystem) endpoint to remove coordinate systems from NOVA and the virtual controller. All available coordinate systems can be listed via the [listCoordinateSystems](listCoordinateSystems) endpoint.
5310
+ * Removes a user coordinate system specified by the given identifier. > **NOTE** > > If the coordinate system has originally been configured on the robot controller, it will remain on the controller even after this endpoint has been executed successfully.. This will remove the user coordinate system from the list of user coordinate systems but keep all dependent coordinate systems which use the deleted coordinate system as reference. Coordinate systems on the robot controller are not affected by this operation. They can be removed via the robot control panel only and will be removed in NOVA when the controller is removed. On virtual controllers, use the [deleteVirtualRobotCoordinateSystem](#/operations/deleteVirtualRobotCoordinateSystem) endpoint to remove coordinate systems from NOVA and the virtual controller. All available coordinate systems can be listed via the [listCoordinateSystems](#/operations/listCoordinateSystems) endpoint.
5311
5311
  * @summary Delete
5312
5312
  * @param {string} cell Unique identifier addressing a cell in all API calls.
5313
5313
  * @param {string} coordinateSystem Unique identifier addressing a coordinate system.
5314
5314
  * @param {*} [options] Override http request option.
5315
5315
  * @throws {RequiredError}
5316
5316
  */
5317
- deleteCoordinateSystem(cell: string, coordinateSystem: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
5317
+ deleteCoordinateSystem(cell: string, coordinateSystem: string, options?: RawAxiosRequestConfig): Promise<axios142.AxiosResponse<void, any>>;
5318
5318
  /**
5319
- * Request a coordinate system specification for a given identifier. Use parameter rotation_type to get the orientation part of the transformation offset of the coordinate system returned in the requested rotation angle type. If parameter rotation_type is not set, the orientation part of the transformation offset of the coordinate system is returned in the rotation angle type used on the robot controller. This can be useful for visualization purposes in the client application due to equivalent numbers with robot control panel visualization. User coordinate systems can be configured on a robot controller during setup or added to the system via the [addCoordinateSystem](addCoordinateSystem) endpoint. Updating the robot controller\'s configuration either requires credentials or is not possible. With the endpoint [addCoordinateSystem](addCoordinateSystem) you can create a coordinate system without changing the robot controller\'s configuration.
5319
+ * Request a coordinate system specification for a given identifier. Use parameter rotation_type to get the orientation part of the transformation offset of the coordinate system returned in the requested rotation angle type. If parameter rotation_type is not set, the orientation part of the transformation offset of the coordinate system is returned in the rotation angle type used on the robot controller. This can be useful for visualization purposes in the client application due to equivalent numbers with robot control panel visualization. User coordinate systems can be configured on a robot controller during setup or added to the system via the [addCoordinateSystem](#/operations/addCoordinateSystem) endpoint. Updating the robot controller\'s configuration either requires credentials or is not possible. With the endpoint [addCoordinateSystem](#/operations/addCoordinateSystem) you can create a coordinate system without changing the robot controller\'s configuration.
5320
5320
  * @summary Description
5321
5321
  * @param {string} cell Unique identifier addressing a cell in all API calls.
5322
5322
  * @param {string} coordinateSystem Unique identifier addressing a coordinate system.
@@ -5324,16 +5324,16 @@ declare class CoordinateSystemsApi extends BaseAPI {
5324
5324
  * @param {*} [options] Override http request option.
5325
5325
  * @throws {RequiredError}
5326
5326
  */
5327
- getCoordinateSystem(cell: string, coordinateSystem: string, rotationType?: RotationAngleTypes, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<CoordinateSystem, any>>;
5327
+ getCoordinateSystem(cell: string, coordinateSystem: string, rotationType?: RotationAngleTypes, options?: RawAxiosRequestConfig): Promise<axios142.AxiosResponse<CoordinateSystem, any>>;
5328
5328
  /**
5329
- * Lists all specifications of coordinate systems from robot controllers and user coordinate systems added to the system via the [addCoordinateSystem](addCoordinateSystem) endpoint. Use parameter rotation_type to get the orientation part of the transformation offset of the coordinate system returned in the requested rotation angle type. If parameter rotation_type is not set, the orientation part of the transformation offset of the coordinate system is returned in the rotation angle type used on the robot controller. This can be useful for visualization purposes in the client application due to equivalent numbers with robot control panel visualization. The coordinate systems from the robot controller are loaded when the motion group associated with the coordinate system is activated. With deactivation of the motion group, the associated coordinate systems are removed from NOVA. The unique identifier of the coordinate systems from the robot controllers are suffixed with \"On\" + the unique identifier of the robot controller. Updating the robot controller\'s configuration either requires credentials or is not possible. With the endpoint [addCoordinateSystem](addCoordinateSystem) you can create a coordinate system without changing the robot controller\'s configuration.
5329
+ * Lists all specifications of coordinate systems from robot controllers and user coordinate systems added to the system via the [addCoordinateSystem](#/operations/addCoordinateSystem) endpoint. Use parameter rotation_type to get the orientation part of the transformation offset of the coordinate system returned in the requested rotation angle type. If parameter rotation_type is not set, the orientation part of the transformation offset of the coordinate system is returned in the rotation angle type used on the robot controller. This can be useful for visualization purposes in the client application due to equivalent numbers with robot control panel visualization. The coordinate systems from the robot controller are loaded when the motion group associated with the coordinate system is activated. With deactivation of the motion group, the associated coordinate systems are removed from NOVA. The unique identifier of the coordinate systems from the robot controllers are suffixed with \"On\" + the unique identifier of the robot controller. Updating the robot controller\'s configuration either requires credentials or is not possible. With the endpoint [addCoordinateSystem](#/operations/addCoordinateSystem) you can create a coordinate system without changing the robot controller\'s configuration.
5330
5330
  * @summary List
5331
5331
  * @param {string} cell Unique identifier addressing a cell in all API calls.
5332
5332
  * @param {RotationAngleTypes} [rotationType]
5333
5333
  * @param {*} [options] Override http request option.
5334
5334
  * @throws {RequiredError}
5335
5335
  */
5336
- listCoordinateSystems(cell: string, rotationType?: RotationAngleTypes, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<ListResponse, any>>;
5336
+ listCoordinateSystems(cell: string, rotationType?: RotationAngleTypes, options?: RawAxiosRequestConfig): Promise<axios142.AxiosResponse<ListResponse, any>>;
5337
5337
  /**
5338
5338
  * Transform a pose to another base.
5339
5339
  * @summary Transform
@@ -5343,7 +5343,7 @@ declare class CoordinateSystemsApi extends BaseAPI {
5343
5343
  * @param {*} [options] Override http request option.
5344
5344
  * @throws {RequiredError}
5345
5345
  */
5346
- transformInCoordinateSystem(cell: string, coordinateSystem: string, pose: Pose, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<Pose, any>>;
5346
+ transformInCoordinateSystem(cell: string, coordinateSystem: string, pose: Pose, options?: RawAxiosRequestConfig): Promise<axios142.AxiosResponse<Pose, any>>;
5347
5347
  }
5348
5348
  /**
5349
5349
  * DeviceConfigurationApi - axios parameter creator
@@ -5516,7 +5516,7 @@ declare class DeviceConfigurationApi extends BaseAPI {
5516
5516
  * @deprecated
5517
5517
  * @throws {RequiredError}
5518
5518
  */
5519
- clearDevices(cell: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
5519
+ clearDevices(cell: string, options?: RawAxiosRequestConfig): Promise<axios142.AxiosResponse<void, any>>;
5520
5520
  /**
5521
5521
  * Deprecated endpoint. Overwrite existing devices in an existing robot cell. The devices are added to the robot cell in the order they are specified in the request body. Each device needs to have a unique identifier which is used to reference the device in Wandelscript. Devices which can be configured in the cell: - Robots - OPC UA devices ## Parameters - For more information about the available device configurations have a look at the **Schema** tab or in the provided examples.
5522
5522
  * @summary Create Devices
@@ -5526,7 +5526,7 @@ declare class DeviceConfigurationApi extends BaseAPI {
5526
5526
  * @deprecated
5527
5527
  * @throws {RequiredError}
5528
5528
  */
5529
- createDevice(cell: string, createDeviceRequestInner: Array<CreateDeviceRequestInner>, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<any, any>>;
5529
+ createDevice(cell: string, createDeviceRequestInner: Array<CreateDeviceRequestInner>, options?: RawAxiosRequestConfig): Promise<axios142.AxiosResponse<any, any>>;
5530
5530
  /**
5531
5531
  * Deprecated endpoint. Deletes a specific device from the cell.
5532
5532
  * @summary Delete Device
@@ -5536,7 +5536,7 @@ declare class DeviceConfigurationApi extends BaseAPI {
5536
5536
  * @deprecated
5537
5537
  * @throws {RequiredError}
5538
5538
  */
5539
- deleteDevice(cell: string, identifier: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
5539
+ deleteDevice(cell: string, identifier: string, options?: RawAxiosRequestConfig): Promise<axios142.AxiosResponse<void, any>>;
5540
5540
  /**
5541
5541
  * Deprecated endpoint. Returns information about a device.
5542
5542
  * @summary Device Information
@@ -5546,7 +5546,7 @@ declare class DeviceConfigurationApi extends BaseAPI {
5546
5546
  * @deprecated
5547
5547
  * @throws {RequiredError}
5548
5548
  */
5549
- getDevice(cell: string, identifier: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<any, any>>;
5549
+ getDevice(cell: string, identifier: string, options?: RawAxiosRequestConfig): Promise<axios142.AxiosResponse<any, any>>;
5550
5550
  /**
5551
5551
  * Deprecated endpoint. Lists all devices which are configured in the cell: - Robots - Databases - OPC UA devices
5552
5552
  * @summary List All Devices
@@ -5555,7 +5555,7 @@ declare class DeviceConfigurationApi extends BaseAPI {
5555
5555
  * @deprecated
5556
5556
  * @throws {RequiredError}
5557
5557
  */
5558
- listDevices(cell: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<ListDevices200ResponseInner[], any>>;
5558
+ listDevices(cell: string, options?: RawAxiosRequestConfig): Promise<axios142.AxiosResponse<ListDevices200ResponseInner[], any>>;
5559
5559
  }
5560
5560
  /**
5561
5561
  * LibraryProgramApi - axios parameter creator
@@ -5575,7 +5575,7 @@ declare const LibraryProgramApiAxiosParamCreator: (configuration?: Configuration
5575
5575
  * <!-- theme: danger --> > **Experimental** Deletes the program with the corresponding metadata. This action is irreversible. Does not delete the associated recipes.
5576
5576
  * @summary Delete Program
5577
5577
  * @param {string} cell Unique identifier addressing a cell in all API calls.
5578
- * @param {string} program Recieved from [listProgramMetadata](listProgramMetadata) or from the response of [createProgram](createProgram).
5578
+ * @param {string} program Recieved from [listProgramMetadata](#/operations/listProgramMetadata) or from the response of [createProgram](#/operations/createProgram).
5579
5579
  * @param {*} [options] Override http request option.
5580
5580
  * @throws {RequiredError}
5581
5581
  */
@@ -5584,7 +5584,7 @@ declare const LibraryProgramApiAxiosParamCreator: (configuration?: Configuration
5584
5584
  * <!-- theme: danger --> > **Experimental** Deletes the provided list of programs with the corresponding metadata. This action is irreversible. Does not delete the associated recipes.
5585
5585
  * @summary Delete Program List
5586
5586
  * @param {string} cell Unique identifier addressing a cell in all API calls.
5587
- * @param {Array<string>} programIds Recieved from [listProgramMetadata](listProgramMetadata) or from the response of [createProgram](createProgram).
5587
+ * @param {Array<string>} programIds Received from [listProgramMetadata](#/operations/listProgramMetadata) or from the response of [createProgram](#/operations/createProgram).
5588
5588
  * @param {*} [options] Override http request option.
5589
5589
  * @throws {RequiredError}
5590
5590
  */
@@ -5593,7 +5593,7 @@ declare const LibraryProgramApiAxiosParamCreator: (configuration?: Configuration
5593
5593
  * <!-- theme: danger --> > **Experimental** Returns the content of the program. The identifier of the program is received upon creation or from the metadata list of all the programs.
5594
5594
  * @summary Get Program
5595
5595
  * @param {string} cell Unique identifier addressing a cell in all API calls.
5596
- * @param {string} program Recieved from [listProgramMetadata](listProgramMetadata) or from the response of [createProgram](createProgram).
5596
+ * @param {string} program Recieved from [listProgramMetadata](#/operations/listProgramMetadata) or from the response of [createProgram](#/operations/createProgram).
5597
5597
  * @param {*} [options] Override http request option.
5598
5598
  * @throws {RequiredError}
5599
5599
  */
@@ -5602,7 +5602,7 @@ declare const LibraryProgramApiAxiosParamCreator: (configuration?: Configuration
5602
5602
  * <!-- theme: danger --> > **Experimental** Updates the content of the program. The update overwrites the existing content. The metadata is updated in correspondence. ## Examples ``` move via p2p() to [0, 0, 0, 0, 0, 0] move frame(\"flange\") to [1, 2, 0] move via line() to [1, 1, 0] a := planned_pose() ``` ``` {% from \'schneider_conveyor_v1.j2\' import schneider_conveyor_library -%} {{ schneider_conveyor_library() }} def start_main(): conveyor_speed_percentage = {{ conveyor_speed_percentage | round(4) }} conveyer_speed = conveyor_speed_percentage*1500 schneider_conveyor_start(conveyer_speed) end ```
5603
5603
  * @summary Update Program
5604
5604
  * @param {string} cell Unique identifier addressing a cell in all API calls.
5605
- * @param {string} program Recieved from [listProgramMetadata](listProgramMetadata) or from the response of [createProgram](createProgram).
5605
+ * @param {string} program Recieved from [listProgramMetadata](#/operations/listProgramMetadata) or from the response of [createProgram](#/operations/createProgram).
5606
5606
  * @param {string} body
5607
5607
  * @param {*} [options] Override http request option.
5608
5608
  * @throws {RequiredError}
@@ -5627,7 +5627,7 @@ declare const LibraryProgramApiFp: (configuration?: Configuration) => {
5627
5627
  * <!-- theme: danger --> > **Experimental** Deletes the program with the corresponding metadata. This action is irreversible. Does not delete the associated recipes.
5628
5628
  * @summary Delete Program
5629
5629
  * @param {string} cell Unique identifier addressing a cell in all API calls.
5630
- * @param {string} program Recieved from [listProgramMetadata](listProgramMetadata) or from the response of [createProgram](createProgram).
5630
+ * @param {string} program Recieved from [listProgramMetadata](#/operations/listProgramMetadata) or from the response of [createProgram](#/operations/createProgram).
5631
5631
  * @param {*} [options] Override http request option.
5632
5632
  * @throws {RequiredError}
5633
5633
  */
@@ -5636,7 +5636,7 @@ declare const LibraryProgramApiFp: (configuration?: Configuration) => {
5636
5636
  * <!-- theme: danger --> > **Experimental** Deletes the provided list of programs with the corresponding metadata. This action is irreversible. Does not delete the associated recipes.
5637
5637
  * @summary Delete Program List
5638
5638
  * @param {string} cell Unique identifier addressing a cell in all API calls.
5639
- * @param {Array<string>} programIds Recieved from [listProgramMetadata](listProgramMetadata) or from the response of [createProgram](createProgram).
5639
+ * @param {Array<string>} programIds Received from [listProgramMetadata](#/operations/listProgramMetadata) or from the response of [createProgram](#/operations/createProgram).
5640
5640
  * @param {*} [options] Override http request option.
5641
5641
  * @throws {RequiredError}
5642
5642
  */
@@ -5645,7 +5645,7 @@ declare const LibraryProgramApiFp: (configuration?: Configuration) => {
5645
5645
  * <!-- theme: danger --> > **Experimental** Returns the content of the program. The identifier of the program is received upon creation or from the metadata list of all the programs.
5646
5646
  * @summary Get Program
5647
5647
  * @param {string} cell Unique identifier addressing a cell in all API calls.
5648
- * @param {string} program Recieved from [listProgramMetadata](listProgramMetadata) or from the response of [createProgram](createProgram).
5648
+ * @param {string} program Recieved from [listProgramMetadata](#/operations/listProgramMetadata) or from the response of [createProgram](#/operations/createProgram).
5649
5649
  * @param {*} [options] Override http request option.
5650
5650
  * @throws {RequiredError}
5651
5651
  */
@@ -5654,7 +5654,7 @@ declare const LibraryProgramApiFp: (configuration?: Configuration) => {
5654
5654
  * <!-- theme: danger --> > **Experimental** Updates the content of the program. The update overwrites the existing content. The metadata is updated in correspondence. ## Examples ``` move via p2p() to [0, 0, 0, 0, 0, 0] move frame(\"flange\") to [1, 2, 0] move via line() to [1, 1, 0] a := planned_pose() ``` ``` {% from \'schneider_conveyor_v1.j2\' import schneider_conveyor_library -%} {{ schneider_conveyor_library() }} def start_main(): conveyor_speed_percentage = {{ conveyor_speed_percentage | round(4) }} conveyer_speed = conveyor_speed_percentage*1500 schneider_conveyor_start(conveyer_speed) end ```
5655
5655
  * @summary Update Program
5656
5656
  * @param {string} cell Unique identifier addressing a cell in all API calls.
5657
- * @param {string} program Recieved from [listProgramMetadata](listProgramMetadata) or from the response of [createProgram](createProgram).
5657
+ * @param {string} program Recieved from [listProgramMetadata](#/operations/listProgramMetadata) or from the response of [createProgram](#/operations/createProgram).
5658
5658
  * @param {string} body
5659
5659
  * @param {*} [options] Override http request option.
5660
5660
  * @throws {RequiredError}
@@ -5679,7 +5679,7 @@ declare const LibraryProgramApiFactory: (configuration?: Configuration, basePath
5679
5679
  * <!-- theme: danger --> > **Experimental** Deletes the program with the corresponding metadata. This action is irreversible. Does not delete the associated recipes.
5680
5680
  * @summary Delete Program
5681
5681
  * @param {string} cell Unique identifier addressing a cell in all API calls.
5682
- * @param {string} program Recieved from [listProgramMetadata](listProgramMetadata) or from the response of [createProgram](createProgram).
5682
+ * @param {string} program Recieved from [listProgramMetadata](#/operations/listProgramMetadata) or from the response of [createProgram](#/operations/createProgram).
5683
5683
  * @param {*} [options] Override http request option.
5684
5684
  * @throws {RequiredError}
5685
5685
  */
@@ -5688,7 +5688,7 @@ declare const LibraryProgramApiFactory: (configuration?: Configuration, basePath
5688
5688
  * <!-- theme: danger --> > **Experimental** Deletes the provided list of programs with the corresponding metadata. This action is irreversible. Does not delete the associated recipes.
5689
5689
  * @summary Delete Program List
5690
5690
  * @param {string} cell Unique identifier addressing a cell in all API calls.
5691
- * @param {Array<string>} programIds Recieved from [listProgramMetadata](listProgramMetadata) or from the response of [createProgram](createProgram).
5691
+ * @param {Array<string>} programIds Received from [listProgramMetadata](#/operations/listProgramMetadata) or from the response of [createProgram](#/operations/createProgram).
5692
5692
  * @param {*} [options] Override http request option.
5693
5693
  * @throws {RequiredError}
5694
5694
  */
@@ -5697,7 +5697,7 @@ declare const LibraryProgramApiFactory: (configuration?: Configuration, basePath
5697
5697
  * <!-- theme: danger --> > **Experimental** Returns the content of the program. The identifier of the program is received upon creation or from the metadata list of all the programs.
5698
5698
  * @summary Get Program
5699
5699
  * @param {string} cell Unique identifier addressing a cell in all API calls.
5700
- * @param {string} program Recieved from [listProgramMetadata](listProgramMetadata) or from the response of [createProgram](createProgram).
5700
+ * @param {string} program Recieved from [listProgramMetadata](#/operations/listProgramMetadata) or from the response of [createProgram](#/operations/createProgram).
5701
5701
  * @param {*} [options] Override http request option.
5702
5702
  * @throws {RequiredError}
5703
5703
  */
@@ -5706,7 +5706,7 @@ declare const LibraryProgramApiFactory: (configuration?: Configuration, basePath
5706
5706
  * <!-- theme: danger --> > **Experimental** Updates the content of the program. The update overwrites the existing content. The metadata is updated in correspondence. ## Examples ``` move via p2p() to [0, 0, 0, 0, 0, 0] move frame(\"flange\") to [1, 2, 0] move via line() to [1, 1, 0] a := planned_pose() ``` ``` {% from \'schneider_conveyor_v1.j2\' import schneider_conveyor_library -%} {{ schneider_conveyor_library() }} def start_main(): conveyor_speed_percentage = {{ conveyor_speed_percentage | round(4) }} conveyer_speed = conveyor_speed_percentage*1500 schneider_conveyor_start(conveyer_speed) end ```
5707
5707
  * @summary Update Program
5708
5708
  * @param {string} cell Unique identifier addressing a cell in all API calls.
5709
- * @param {string} program Recieved from [listProgramMetadata](listProgramMetadata) or from the response of [createProgram](createProgram).
5709
+ * @param {string} program Recieved from [listProgramMetadata](#/operations/listProgramMetadata) or from the response of [createProgram](#/operations/createProgram).
5710
5710
  * @param {string} body
5711
5711
  * @param {*} [options] Override http request option.
5712
5712
  * @throws {RequiredError}
@@ -5726,44 +5726,44 @@ declare class LibraryProgramApi extends BaseAPI {
5726
5726
  * @param {*} [options] Override http request option.
5727
5727
  * @throws {RequiredError}
5728
5728
  */
5729
- createProgram(cell: string, body: string, name?: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<ProgramMetadata, any>>;
5729
+ createProgram(cell: string, body: string, name?: string, options?: RawAxiosRequestConfig): Promise<axios142.AxiosResponse<ProgramMetadata, any>>;
5730
5730
  /**
5731
5731
  * <!-- theme: danger --> > **Experimental** Deletes the program with the corresponding metadata. This action is irreversible. Does not delete the associated recipes.
5732
5732
  * @summary Delete Program
5733
5733
  * @param {string} cell Unique identifier addressing a cell in all API calls.
5734
- * @param {string} program Recieved from [listProgramMetadata](listProgramMetadata) or from the response of [createProgram](createProgram).
5734
+ * @param {string} program Recieved from [listProgramMetadata](#/operations/listProgramMetadata) or from the response of [createProgram](#/operations/createProgram).
5735
5735
  * @param {*} [options] Override http request option.
5736
5736
  * @throws {RequiredError}
5737
5737
  */
5738
- deleteProgram(cell: string, program: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<ProgramMetadata, any>>;
5738
+ deleteProgram(cell: string, program: string, options?: RawAxiosRequestConfig): Promise<axios142.AxiosResponse<ProgramMetadata, any>>;
5739
5739
  /**
5740
5740
  * <!-- theme: danger --> > **Experimental** Deletes the provided list of programs with the corresponding metadata. This action is irreversible. Does not delete the associated recipes.
5741
5741
  * @summary Delete Program List
5742
5742
  * @param {string} cell Unique identifier addressing a cell in all API calls.
5743
- * @param {Array<string>} programIds Recieved from [listProgramMetadata](listProgramMetadata) or from the response of [createProgram](createProgram).
5743
+ * @param {Array<string>} programIds Received from [listProgramMetadata](#/operations/listProgramMetadata) or from the response of [createProgram](#/operations/createProgram).
5744
5744
  * @param {*} [options] Override http request option.
5745
5745
  * @throws {RequiredError}
5746
5746
  */
5747
- deleteProgramList(cell: string, programIds: Array<string>, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<ListProgramMetadataResponse, any>>;
5747
+ deleteProgramList(cell: string, programIds: Array<string>, options?: RawAxiosRequestConfig): Promise<axios142.AxiosResponse<ListProgramMetadataResponse, any>>;
5748
5748
  /**
5749
5749
  * <!-- theme: danger --> > **Experimental** Returns the content of the program. The identifier of the program is received upon creation or from the metadata list of all the programs.
5750
5750
  * @summary Get Program
5751
5751
  * @param {string} cell Unique identifier addressing a cell in all API calls.
5752
- * @param {string} program Recieved from [listProgramMetadata](listProgramMetadata) or from the response of [createProgram](createProgram).
5752
+ * @param {string} program Recieved from [listProgramMetadata](#/operations/listProgramMetadata) or from the response of [createProgram](#/operations/createProgram).
5753
5753
  * @param {*} [options] Override http request option.
5754
5754
  * @throws {RequiredError}
5755
5755
  */
5756
- getProgram(cell: string, program: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<string, any>>;
5756
+ getProgram(cell: string, program: string, options?: RawAxiosRequestConfig): Promise<axios142.AxiosResponse<string, any>>;
5757
5757
  /**
5758
5758
  * <!-- theme: danger --> > **Experimental** Updates the content of the program. The update overwrites the existing content. The metadata is updated in correspondence. ## Examples ``` move via p2p() to [0, 0, 0, 0, 0, 0] move frame(\"flange\") to [1, 2, 0] move via line() to [1, 1, 0] a := planned_pose() ``` ``` {% from \'schneider_conveyor_v1.j2\' import schneider_conveyor_library -%} {{ schneider_conveyor_library() }} def start_main(): conveyor_speed_percentage = {{ conveyor_speed_percentage | round(4) }} conveyer_speed = conveyor_speed_percentage*1500 schneider_conveyor_start(conveyer_speed) end ```
5759
5759
  * @summary Update Program
5760
5760
  * @param {string} cell Unique identifier addressing a cell in all API calls.
5761
- * @param {string} program Recieved from [listProgramMetadata](listProgramMetadata) or from the response of [createProgram](createProgram).
5761
+ * @param {string} program Recieved from [listProgramMetadata](#/operations/listProgramMetadata) or from the response of [createProgram](#/operations/createProgram).
5762
5762
  * @param {string} body
5763
5763
  * @param {*} [options] Override http request option.
5764
5764
  * @throws {RequiredError}
5765
5765
  */
5766
- updateProgram(cell: string, program: string, body: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<ProgramMetadata, any>>;
5766
+ updateProgram(cell: string, program: string, body: string, options?: RawAxiosRequestConfig): Promise<axios142.AxiosResponse<ProgramMetadata, any>>;
5767
5767
  }
5768
5768
  /**
5769
5769
  * LibraryProgramMetadataApi - axios parameter creator
@@ -5773,7 +5773,7 @@ declare const LibraryProgramMetadataApiAxiosParamCreator: (configuration?: Confi
5773
5773
  * <!-- theme: danger --> > **Experimental** Returns metadata of the corresponding program.
5774
5774
  * @summary Get Program Metadata
5775
5775
  * @param {string} cell Unique identifier addressing a cell in all API calls.
5776
- * @param {string} program Recieved from [listProgramMetadata](listProgramMetadata) or from the response of [createProgram](createProgram).
5776
+ * @param {string} program Recieved from [listProgramMetadata](#/operations/listProgramMetadata) or from the response of [createProgram](#/operations/createProgram).
5777
5777
  * @param {*} [options] Override http request option.
5778
5778
  * @throws {RequiredError}
5779
5779
  */
@@ -5791,7 +5791,7 @@ declare const LibraryProgramMetadataApiAxiosParamCreator: (configuration?: Confi
5791
5791
  * <!-- theme: danger --> > **Experimental** Updates the metadata of the corresponding program. The update is partial, only the set fields get updated.
5792
5792
  * @summary Update Program Metadata
5793
5793
  * @param {string} cell Unique identifier addressing a cell in all API calls.
5794
- * @param {string} program Recieved from [listProgramMetadata](listProgramMetadata) or from the response of [createProgram](createProgram).
5794
+ * @param {string} program Recieved from [listProgramMetadata](#/operations/listProgramMetadata) or from the response of [createProgram](#/operations/createProgram).
5795
5795
  * @param {UpdateProgramMetadataRequest} updateProgramMetadataRequest
5796
5796
  * @param {*} [options] Override http request option.
5797
5797
  * @throws {RequiredError}
@@ -5801,7 +5801,7 @@ declare const LibraryProgramMetadataApiAxiosParamCreator: (configuration?: Confi
5801
5801
  * <!-- theme: danger --> > **Experimental** Uploads an image for the corresponding program. The image is served as a static file. The path to the image is stored in the metadata.
5802
5802
  * @summary Upload Program Metadata Image
5803
5803
  * @param {string} cell Unique identifier addressing a cell in all API calls.
5804
- * @param {string} program Recieved from [listProgramMetadata](listProgramMetadata) or from the response of [createProgram](createProgram).
5804
+ * @param {string} program Recieved from [listProgramMetadata](#/operations/listProgramMetadata) or from the response of [createProgram](#/operations/createProgram).
5805
5805
  * @param {File} file
5806
5806
  * @param {*} [options] Override http request option.
5807
5807
  * @throws {RequiredError}
@@ -5816,7 +5816,7 @@ declare const LibraryProgramMetadataApiFp: (configuration?: Configuration) => {
5816
5816
  * <!-- theme: danger --> > **Experimental** Returns metadata of the corresponding program.
5817
5817
  * @summary Get Program Metadata
5818
5818
  * @param {string} cell Unique identifier addressing a cell in all API calls.
5819
- * @param {string} program Recieved from [listProgramMetadata](listProgramMetadata) or from the response of [createProgram](createProgram).
5819
+ * @param {string} program Recieved from [listProgramMetadata](#/operations/listProgramMetadata) or from the response of [createProgram](#/operations/createProgram).
5820
5820
  * @param {*} [options] Override http request option.
5821
5821
  * @throws {RequiredError}
5822
5822
  */
@@ -5834,7 +5834,7 @@ declare const LibraryProgramMetadataApiFp: (configuration?: Configuration) => {
5834
5834
  * <!-- theme: danger --> > **Experimental** Updates the metadata of the corresponding program. The update is partial, only the set fields get updated.
5835
5835
  * @summary Update Program Metadata
5836
5836
  * @param {string} cell Unique identifier addressing a cell in all API calls.
5837
- * @param {string} program Recieved from [listProgramMetadata](listProgramMetadata) or from the response of [createProgram](createProgram).
5837
+ * @param {string} program Recieved from [listProgramMetadata](#/operations/listProgramMetadata) or from the response of [createProgram](#/operations/createProgram).
5838
5838
  * @param {UpdateProgramMetadataRequest} updateProgramMetadataRequest
5839
5839
  * @param {*} [options] Override http request option.
5840
5840
  * @throws {RequiredError}
@@ -5844,7 +5844,7 @@ declare const LibraryProgramMetadataApiFp: (configuration?: Configuration) => {
5844
5844
  * <!-- theme: danger --> > **Experimental** Uploads an image for the corresponding program. The image is served as a static file. The path to the image is stored in the metadata.
5845
5845
  * @summary Upload Program Metadata Image
5846
5846
  * @param {string} cell Unique identifier addressing a cell in all API calls.
5847
- * @param {string} program Recieved from [listProgramMetadata](listProgramMetadata) or from the response of [createProgram](createProgram).
5847
+ * @param {string} program Recieved from [listProgramMetadata](#/operations/listProgramMetadata) or from the response of [createProgram](#/operations/createProgram).
5848
5848
  * @param {File} file
5849
5849
  * @param {*} [options] Override http request option.
5850
5850
  * @throws {RequiredError}
@@ -5859,7 +5859,7 @@ declare const LibraryProgramMetadataApiFactory: (configuration?: Configuration,
5859
5859
  * <!-- theme: danger --> > **Experimental** Returns metadata of the corresponding program.
5860
5860
  * @summary Get Program Metadata
5861
5861
  * @param {string} cell Unique identifier addressing a cell in all API calls.
5862
- * @param {string} program Recieved from [listProgramMetadata](listProgramMetadata) or from the response of [createProgram](createProgram).
5862
+ * @param {string} program Recieved from [listProgramMetadata](#/operations/listProgramMetadata) or from the response of [createProgram](#/operations/createProgram).
5863
5863
  * @param {*} [options] Override http request option.
5864
5864
  * @throws {RequiredError}
5865
5865
  */
@@ -5877,7 +5877,7 @@ declare const LibraryProgramMetadataApiFactory: (configuration?: Configuration,
5877
5877
  * <!-- theme: danger --> > **Experimental** Updates the metadata of the corresponding program. The update is partial, only the set fields get updated.
5878
5878
  * @summary Update Program Metadata
5879
5879
  * @param {string} cell Unique identifier addressing a cell in all API calls.
5880
- * @param {string} program Recieved from [listProgramMetadata](listProgramMetadata) or from the response of [createProgram](createProgram).
5880
+ * @param {string} program Recieved from [listProgramMetadata](#/operations/listProgramMetadata) or from the response of [createProgram](#/operations/createProgram).
5881
5881
  * @param {UpdateProgramMetadataRequest} updateProgramMetadataRequest
5882
5882
  * @param {*} [options] Override http request option.
5883
5883
  * @throws {RequiredError}
@@ -5887,7 +5887,7 @@ declare const LibraryProgramMetadataApiFactory: (configuration?: Configuration,
5887
5887
  * <!-- theme: danger --> > **Experimental** Uploads an image for the corresponding program. The image is served as a static file. The path to the image is stored in the metadata.
5888
5888
  * @summary Upload Program Metadata Image
5889
5889
  * @param {string} cell Unique identifier addressing a cell in all API calls.
5890
- * @param {string} program Recieved from [listProgramMetadata](listProgramMetadata) or from the response of [createProgram](createProgram).
5890
+ * @param {string} program Recieved from [listProgramMetadata](#/operations/listProgramMetadata) or from the response of [createProgram](#/operations/createProgram).
5891
5891
  * @param {File} file
5892
5892
  * @param {*} [options] Override http request option.
5893
5893
  * @throws {RequiredError}
@@ -5902,11 +5902,11 @@ declare class LibraryProgramMetadataApi extends BaseAPI {
5902
5902
  * <!-- theme: danger --> > **Experimental** Returns metadata of the corresponding program.
5903
5903
  * @summary Get Program Metadata
5904
5904
  * @param {string} cell Unique identifier addressing a cell in all API calls.
5905
- * @param {string} program Recieved from [listProgramMetadata](listProgramMetadata) or from the response of [createProgram](createProgram).
5905
+ * @param {string} program Recieved from [listProgramMetadata](#/operations/listProgramMetadata) or from the response of [createProgram](#/operations/createProgram).
5906
5906
  * @param {*} [options] Override http request option.
5907
5907
  * @throws {RequiredError}
5908
5908
  */
5909
- getProgramMetadata(cell: string, program: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<ProgramMetadata, any>>;
5909
+ getProgramMetadata(cell: string, program: string, options?: RawAxiosRequestConfig): Promise<axios142.AxiosResponse<ProgramMetadata, any>>;
5910
5910
  /**
5911
5911
  * <!-- theme: danger --> > **Experimental** Returns a list of all the stored programs, represented by their metadata.
5912
5912
  * @summary List Program Metadata
@@ -5915,27 +5915,27 @@ declare class LibraryProgramMetadataApi extends BaseAPI {
5915
5915
  * @param {*} [options] Override http request option.
5916
5916
  * @throws {RequiredError}
5917
5917
  */
5918
- listProgramMetadata(cell: string, showHidden?: boolean, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<ListProgramMetadataResponse, any>>;
5918
+ listProgramMetadata(cell: string, showHidden?: boolean, options?: RawAxiosRequestConfig): Promise<axios142.AxiosResponse<ListProgramMetadataResponse, any>>;
5919
5919
  /**
5920
5920
  * <!-- theme: danger --> > **Experimental** Updates the metadata of the corresponding program. The update is partial, only the set fields get updated.
5921
5921
  * @summary Update Program Metadata
5922
5922
  * @param {string} cell Unique identifier addressing a cell in all API calls.
5923
- * @param {string} program Recieved from [listProgramMetadata](listProgramMetadata) or from the response of [createProgram](createProgram).
5923
+ * @param {string} program Recieved from [listProgramMetadata](#/operations/listProgramMetadata) or from the response of [createProgram](#/operations/createProgram).
5924
5924
  * @param {UpdateProgramMetadataRequest} updateProgramMetadataRequest
5925
5925
  * @param {*} [options] Override http request option.
5926
5926
  * @throws {RequiredError}
5927
5927
  */
5928
- updateProgramMetadata(cell: string, program: string, updateProgramMetadataRequest: UpdateProgramMetadataRequest, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<ProgramMetadata, any>>;
5928
+ updateProgramMetadata(cell: string, program: string, updateProgramMetadataRequest: UpdateProgramMetadataRequest, options?: RawAxiosRequestConfig): Promise<axios142.AxiosResponse<ProgramMetadata, any>>;
5929
5929
  /**
5930
5930
  * <!-- theme: danger --> > **Experimental** Uploads an image for the corresponding program. The image is served as a static file. The path to the image is stored in the metadata.
5931
5931
  * @summary Upload Program Metadata Image
5932
5932
  * @param {string} cell Unique identifier addressing a cell in all API calls.
5933
- * @param {string} program Recieved from [listProgramMetadata](listProgramMetadata) or from the response of [createProgram](createProgram).
5933
+ * @param {string} program Recieved from [listProgramMetadata](#/operations/listProgramMetadata) or from the response of [createProgram](#/operations/createProgram).
5934
5934
  * @param {File} file
5935
5935
  * @param {*} [options] Override http request option.
5936
5936
  * @throws {RequiredError}
5937
5937
  */
5938
- uploadProgramMetadataImage(cell: string, program: string, file: File, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<ProgramMetadata, any>>;
5938
+ uploadProgramMetadataImage(cell: string, program: string, file: File, options?: RawAxiosRequestConfig): Promise<axios142.AxiosResponse<ProgramMetadata, any>>;
5939
5939
  }
5940
5940
  /**
5941
5941
  * LibraryRecipeApi - axios parameter creator
@@ -5947,7 +5947,7 @@ declare const LibraryRecipeApiAxiosParamCreator: (configuration?: Configuration)
5947
5947
  * @param {string} cell Unique identifier addressing a cell in all API calls.
5948
5948
  * @param {string} programId The identifier of the program the recipe will be associated with.
5949
5949
  * @param {object} body
5950
- * @param {string} [name] If no inital name is set a default name based on the program and timestamp is created.
5950
+ * @param {string} [name] If no initial name is set, a default name based on the program and timestamp is created.
5951
5951
  * @param {*} [options] Override http request option.
5952
5952
  * @throws {RequiredError}
5953
5953
  */
@@ -5956,7 +5956,7 @@ declare const LibraryRecipeApiAxiosParamCreator: (configuration?: Configuration)
5956
5956
  * # EXPERIMENTAL > **Note:** This endpoint is experimental and might experience functional changes in the future. Deletes a recipe. This action is irreversible.
5957
5957
  * @summary Delete Recipe
5958
5958
  * @param {string} cell Unique identifier addressing a cell in all API calls.
5959
- * @param {string} recipe Recieved from [listRecipeMetadata](listRecipeMetadata) or from the response of [createRecipe](createRecipe).
5959
+ * @param {string} recipe Recieved from [listRecipeMetadata](#/operations/listRecipeMetadata) or from the response of [createRecipe](#/operations/createRecipe).
5960
5960
  * @param {*} [options] Override http request option.
5961
5961
  * @throws {RequiredError}
5962
5962
  */
@@ -5965,7 +5965,7 @@ declare const LibraryRecipeApiAxiosParamCreator: (configuration?: Configuration)
5965
5965
  * <!-- theme: danger --> > **Experimental** Deletes the provided list of recipes. This action is irreversible.
5966
5966
  * @summary Delete Recipe List
5967
5967
  * @param {string} cell Unique identifier addressing a cell in all API calls.
5968
- * @param {Array<string>} recipeIds Recieved from [listRecipeMetadata](listRecipeMetadata) or from the response of [createRecipe](createRecipe)
5968
+ * @param {Array<string>} recipeIds Received from [listRecipeMetadata](#/operations/listRecipeMetadata) or from the response of [createRecipe](#/operations/createRecipe)
5969
5969
  * @param {*} [options] Override http request option.
5970
5970
  * @throws {RequiredError}
5971
5971
  */
@@ -5974,7 +5974,7 @@ declare const LibraryRecipeApiAxiosParamCreator: (configuration?: Configuration)
5974
5974
  * <!-- theme: danger --> > **Experimental** Returns the content of a recipe. The identifier of the recipe is recieved on creation or from the metadata list of all the recipes.
5975
5975
  * @summary Get Recipe
5976
5976
  * @param {string} cell Unique identifier addressing a cell in all API calls.
5977
- * @param {string} recipe Recieved from [listRecipeMetadata](listRecipeMetadata) or from the response of [createRecipe](createRecipe).
5977
+ * @param {string} recipe Recieved from [listRecipeMetadata](#/operations/listRecipeMetadata) or from the response of [createRecipe](#/operations/createRecipe).
5978
5978
  * @param {*} [options] Override http request option.
5979
5979
  * @throws {RequiredError}
5980
5980
  */
@@ -5983,7 +5983,7 @@ declare const LibraryRecipeApiAxiosParamCreator: (configuration?: Configuration)
5983
5983
  * <!-- theme: danger --> > **Experimental** Updates an existing recipe. The update is partial, only the set fields get updated.
5984
5984
  * @summary Update Recipe
5985
5985
  * @param {string} cell Unique identifier addressing a cell in all API calls.
5986
- * @param {string} recipe Recieved from [listRecipeMetadata](listRecipeMetadata) or from the response of [createRecipe](createRecipe).
5986
+ * @param {string} recipe Recieved from [listRecipeMetadata](#/operations/listRecipeMetadata) or from the response of [createRecipe](#/operations/createRecipe).
5987
5987
  * @param {object} body
5988
5988
  * @param {*} [options] Override http request option.
5989
5989
  * @throws {RequiredError}
@@ -6000,7 +6000,7 @@ declare const LibraryRecipeApiFp: (configuration?: Configuration) => {
6000
6000
  * @param {string} cell Unique identifier addressing a cell in all API calls.
6001
6001
  * @param {string} programId The identifier of the program the recipe will be associated with.
6002
6002
  * @param {object} body
6003
- * @param {string} [name] If no inital name is set a default name based on the program and timestamp is created.
6003
+ * @param {string} [name] If no initial name is set, a default name based on the program and timestamp is created.
6004
6004
  * @param {*} [options] Override http request option.
6005
6005
  * @throws {RequiredError}
6006
6006
  */
@@ -6009,7 +6009,7 @@ declare const LibraryRecipeApiFp: (configuration?: Configuration) => {
6009
6009
  * # EXPERIMENTAL > **Note:** This endpoint is experimental and might experience functional changes in the future. Deletes a recipe. This action is irreversible.
6010
6010
  * @summary Delete Recipe
6011
6011
  * @param {string} cell Unique identifier addressing a cell in all API calls.
6012
- * @param {string} recipe Recieved from [listRecipeMetadata](listRecipeMetadata) or from the response of [createRecipe](createRecipe).
6012
+ * @param {string} recipe Recieved from [listRecipeMetadata](#/operations/listRecipeMetadata) or from the response of [createRecipe](#/operations/createRecipe).
6013
6013
  * @param {*} [options] Override http request option.
6014
6014
  * @throws {RequiredError}
6015
6015
  */
@@ -6018,7 +6018,7 @@ declare const LibraryRecipeApiFp: (configuration?: Configuration) => {
6018
6018
  * <!-- theme: danger --> > **Experimental** Deletes the provided list of recipes. This action is irreversible.
6019
6019
  * @summary Delete Recipe List
6020
6020
  * @param {string} cell Unique identifier addressing a cell in all API calls.
6021
- * @param {Array<string>} recipeIds Recieved from [listRecipeMetadata](listRecipeMetadata) or from the response of [createRecipe](createRecipe)
6021
+ * @param {Array<string>} recipeIds Received from [listRecipeMetadata](#/operations/listRecipeMetadata) or from the response of [createRecipe](#/operations/createRecipe)
6022
6022
  * @param {*} [options] Override http request option.
6023
6023
  * @throws {RequiredError}
6024
6024
  */
@@ -6027,7 +6027,7 @@ declare const LibraryRecipeApiFp: (configuration?: Configuration) => {
6027
6027
  * <!-- theme: danger --> > **Experimental** Returns the content of a recipe. The identifier of the recipe is recieved on creation or from the metadata list of all the recipes.
6028
6028
  * @summary Get Recipe
6029
6029
  * @param {string} cell Unique identifier addressing a cell in all API calls.
6030
- * @param {string} recipe Recieved from [listRecipeMetadata](listRecipeMetadata) or from the response of [createRecipe](createRecipe).
6030
+ * @param {string} recipe Recieved from [listRecipeMetadata](#/operations/listRecipeMetadata) or from the response of [createRecipe](#/operations/createRecipe).
6031
6031
  * @param {*} [options] Override http request option.
6032
6032
  * @throws {RequiredError}
6033
6033
  */
@@ -6036,7 +6036,7 @@ declare const LibraryRecipeApiFp: (configuration?: Configuration) => {
6036
6036
  * <!-- theme: danger --> > **Experimental** Updates an existing recipe. The update is partial, only the set fields get updated.
6037
6037
  * @summary Update Recipe
6038
6038
  * @param {string} cell Unique identifier addressing a cell in all API calls.
6039
- * @param {string} recipe Recieved from [listRecipeMetadata](listRecipeMetadata) or from the response of [createRecipe](createRecipe).
6039
+ * @param {string} recipe Recieved from [listRecipeMetadata](#/operations/listRecipeMetadata) or from the response of [createRecipe](#/operations/createRecipe).
6040
6040
  * @param {object} body
6041
6041
  * @param {*} [options] Override http request option.
6042
6042
  * @throws {RequiredError}
@@ -6053,7 +6053,7 @@ declare const LibraryRecipeApiFactory: (configuration?: Configuration, basePath?
6053
6053
  * @param {string} cell Unique identifier addressing a cell in all API calls.
6054
6054
  * @param {string} programId The identifier of the program the recipe will be associated with.
6055
6055
  * @param {object} body
6056
- * @param {string} [name] If no inital name is set a default name based on the program and timestamp is created.
6056
+ * @param {string} [name] If no initial name is set, a default name based on the program and timestamp is created.
6057
6057
  * @param {*} [options] Override http request option.
6058
6058
  * @throws {RequiredError}
6059
6059
  */
@@ -6062,7 +6062,7 @@ declare const LibraryRecipeApiFactory: (configuration?: Configuration, basePath?
6062
6062
  * # EXPERIMENTAL > **Note:** This endpoint is experimental and might experience functional changes in the future. Deletes a recipe. This action is irreversible.
6063
6063
  * @summary Delete Recipe
6064
6064
  * @param {string} cell Unique identifier addressing a cell in all API calls.
6065
- * @param {string} recipe Recieved from [listRecipeMetadata](listRecipeMetadata) or from the response of [createRecipe](createRecipe).
6065
+ * @param {string} recipe Recieved from [listRecipeMetadata](#/operations/listRecipeMetadata) or from the response of [createRecipe](#/operations/createRecipe).
6066
6066
  * @param {*} [options] Override http request option.
6067
6067
  * @throws {RequiredError}
6068
6068
  */
@@ -6071,7 +6071,7 @@ declare const LibraryRecipeApiFactory: (configuration?: Configuration, basePath?
6071
6071
  * <!-- theme: danger --> > **Experimental** Deletes the provided list of recipes. This action is irreversible.
6072
6072
  * @summary Delete Recipe List
6073
6073
  * @param {string} cell Unique identifier addressing a cell in all API calls.
6074
- * @param {Array<string>} recipeIds Recieved from [listRecipeMetadata](listRecipeMetadata) or from the response of [createRecipe](createRecipe)
6074
+ * @param {Array<string>} recipeIds Received from [listRecipeMetadata](#/operations/listRecipeMetadata) or from the response of [createRecipe](#/operations/createRecipe)
6075
6075
  * @param {*} [options] Override http request option.
6076
6076
  * @throws {RequiredError}
6077
6077
  */
@@ -6080,7 +6080,7 @@ declare const LibraryRecipeApiFactory: (configuration?: Configuration, basePath?
6080
6080
  * <!-- theme: danger --> > **Experimental** Returns the content of a recipe. The identifier of the recipe is recieved on creation or from the metadata list of all the recipes.
6081
6081
  * @summary Get Recipe
6082
6082
  * @param {string} cell Unique identifier addressing a cell in all API calls.
6083
- * @param {string} recipe Recieved from [listRecipeMetadata](listRecipeMetadata) or from the response of [createRecipe](createRecipe).
6083
+ * @param {string} recipe Recieved from [listRecipeMetadata](#/operations/listRecipeMetadata) or from the response of [createRecipe](#/operations/createRecipe).
6084
6084
  * @param {*} [options] Override http request option.
6085
6085
  * @throws {RequiredError}
6086
6086
  */
@@ -6089,7 +6089,7 @@ declare const LibraryRecipeApiFactory: (configuration?: Configuration, basePath?
6089
6089
  * <!-- theme: danger --> > **Experimental** Updates an existing recipe. The update is partial, only the set fields get updated.
6090
6090
  * @summary Update Recipe
6091
6091
  * @param {string} cell Unique identifier addressing a cell in all API calls.
6092
- * @param {string} recipe Recieved from [listRecipeMetadata](listRecipeMetadata) or from the response of [createRecipe](createRecipe).
6092
+ * @param {string} recipe Recieved from [listRecipeMetadata](#/operations/listRecipeMetadata) or from the response of [createRecipe](#/operations/createRecipe).
6093
6093
  * @param {object} body
6094
6094
  * @param {*} [options] Override http request option.
6095
6095
  * @throws {RequiredError}
@@ -6106,48 +6106,48 @@ declare class LibraryRecipeApi extends BaseAPI {
6106
6106
  * @param {string} cell Unique identifier addressing a cell in all API calls.
6107
6107
  * @param {string} programId The identifier of the program the recipe will be associated with.
6108
6108
  * @param {object} body
6109
- * @param {string} [name] If no inital name is set a default name based on the program and timestamp is created.
6109
+ * @param {string} [name] If no initial name is set, a default name based on the program and timestamp is created.
6110
6110
  * @param {*} [options] Override http request option.
6111
6111
  * @throws {RequiredError}
6112
6112
  */
6113
- createRecipe(cell: string, programId: string, body: object, name?: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<RecipeMetadata, any>>;
6113
+ createRecipe(cell: string, programId: string, body: object, name?: string, options?: RawAxiosRequestConfig): Promise<axios142.AxiosResponse<RecipeMetadata, any>>;
6114
6114
  /**
6115
6115
  * # EXPERIMENTAL > **Note:** This endpoint is experimental and might experience functional changes in the future. Deletes a recipe. This action is irreversible.
6116
6116
  * @summary Delete Recipe
6117
6117
  * @param {string} cell Unique identifier addressing a cell in all API calls.
6118
- * @param {string} recipe Recieved from [listRecipeMetadata](listRecipeMetadata) or from the response of [createRecipe](createRecipe).
6118
+ * @param {string} recipe Recieved from [listRecipeMetadata](#/operations/listRecipeMetadata) or from the response of [createRecipe](#/operations/createRecipe).
6119
6119
  * @param {*} [options] Override http request option.
6120
6120
  * @throws {RequiredError}
6121
6121
  */
6122
- deleteRecipe(cell: string, recipe: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<RecipeMetadata, any>>;
6122
+ deleteRecipe(cell: string, recipe: string, options?: RawAxiosRequestConfig): Promise<axios142.AxiosResponse<RecipeMetadata, any>>;
6123
6123
  /**
6124
6124
  * <!-- theme: danger --> > **Experimental** Deletes the provided list of recipes. This action is irreversible.
6125
6125
  * @summary Delete Recipe List
6126
6126
  * @param {string} cell Unique identifier addressing a cell in all API calls.
6127
- * @param {Array<string>} recipeIds Recieved from [listRecipeMetadata](listRecipeMetadata) or from the response of [createRecipe](createRecipe)
6127
+ * @param {Array<string>} recipeIds Received from [listRecipeMetadata](#/operations/listRecipeMetadata) or from the response of [createRecipe](#/operations/createRecipe)
6128
6128
  * @param {*} [options] Override http request option.
6129
6129
  * @throws {RequiredError}
6130
6130
  */
6131
- deleteRecipeList(cell: string, recipeIds: Array<string>, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<ListRecipeMetadataResponse, any>>;
6131
+ deleteRecipeList(cell: string, recipeIds: Array<string>, options?: RawAxiosRequestConfig): Promise<axios142.AxiosResponse<ListRecipeMetadataResponse, any>>;
6132
6132
  /**
6133
6133
  * <!-- theme: danger --> > **Experimental** Returns the content of a recipe. The identifier of the recipe is recieved on creation or from the metadata list of all the recipes.
6134
6134
  * @summary Get Recipe
6135
6135
  * @param {string} cell Unique identifier addressing a cell in all API calls.
6136
- * @param {string} recipe Recieved from [listRecipeMetadata](listRecipeMetadata) or from the response of [createRecipe](createRecipe).
6136
+ * @param {string} recipe Recieved from [listRecipeMetadata](#/operations/listRecipeMetadata) or from the response of [createRecipe](#/operations/createRecipe).
6137
6137
  * @param {*} [options] Override http request option.
6138
6138
  * @throws {RequiredError}
6139
6139
  */
6140
- getRecipe(cell: string, recipe: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<object, any>>;
6140
+ getRecipe(cell: string, recipe: string, options?: RawAxiosRequestConfig): Promise<axios142.AxiosResponse<object, any>>;
6141
6141
  /**
6142
6142
  * <!-- theme: danger --> > **Experimental** Updates an existing recipe. The update is partial, only the set fields get updated.
6143
6143
  * @summary Update Recipe
6144
6144
  * @param {string} cell Unique identifier addressing a cell in all API calls.
6145
- * @param {string} recipe Recieved from [listRecipeMetadata](listRecipeMetadata) or from the response of [createRecipe](createRecipe).
6145
+ * @param {string} recipe Recieved from [listRecipeMetadata](#/operations/listRecipeMetadata) or from the response of [createRecipe](#/operations/createRecipe).
6146
6146
  * @param {object} body
6147
6147
  * @param {*} [options] Override http request option.
6148
6148
  * @throws {RequiredError}
6149
6149
  */
6150
- updateRecipe(cell: string, recipe: string, body: object, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<RecipeMetadata, any>>;
6150
+ updateRecipe(cell: string, recipe: string, body: object, options?: RawAxiosRequestConfig): Promise<axios142.AxiosResponse<RecipeMetadata, any>>;
6151
6151
  }
6152
6152
  /**
6153
6153
  * LibraryRecipeMetadataApi - axios parameter creator
@@ -6157,7 +6157,7 @@ declare const LibraryRecipeMetadataApiAxiosParamCreator: (configuration?: Config
6157
6157
  * <!-- theme: danger --> > **Experimental** Returns the metadata of the recipe.
6158
6158
  * @summary Get Recipe Metadata
6159
6159
  * @param {string} cell Unique identifier addressing a cell in all API calls.
6160
- * @param {string} recipe Recieved from [listRecipeMetadata](listRecipeMetadata) or from the response of [createRecipe](createRecipe).
6160
+ * @param {string} recipe Recieved from [listRecipeMetadata](#/operations/listRecipeMetadata) or from the response of [createRecipe](#/operations/createRecipe).
6161
6161
  * @param {*} [options] Override http request option.
6162
6162
  * @throws {RequiredError}
6163
6163
  */
@@ -6174,7 +6174,7 @@ declare const LibraryRecipeMetadataApiAxiosParamCreator: (configuration?: Config
6174
6174
  * <!-- theme: danger --> > **Experimental** Updates the metadata of a recipe. The update is partial, only the set fields get updated.
6175
6175
  * @summary Update Recipe Metadata
6176
6176
  * @param {string} cell Unique identifier addressing a cell in all API calls.
6177
- * @param {string} recipe Recieved from [listRecipeMetadata](listRecipeMetadata) or from the response of [createRecipe](createRecipe).
6177
+ * @param {string} recipe Recieved from [listRecipeMetadata](#/operations/listRecipeMetadata) or from the response of [createRecipe](#/operations/createRecipe).
6178
6178
  * @param {UpdateRecipeMetadataRequest} updateRecipeMetadataRequest
6179
6179
  * @param {*} [options] Override http request option.
6180
6180
  * @throws {RequiredError}
@@ -6184,7 +6184,7 @@ declare const LibraryRecipeMetadataApiAxiosParamCreator: (configuration?: Config
6184
6184
  * <!-- theme: danger --> > **Experimental** Uploads an image for a recipe. The image is served as a static file and the path is stored in the metadata.
6185
6185
  * @summary Upload Recipe Metadata Image
6186
6186
  * @param {string} cell Unique identifier addressing a cell in all API calls.
6187
- * @param {string} recipe Recieved from [listRecipeMetadata](listRecipeMetadata) or from the response of [createRecipe](createRecipe).
6187
+ * @param {string} recipe Recieved from [listRecipeMetadata](#/operations/listRecipeMetadata) or from the response of [createRecipe](#/operations/createRecipe).
6188
6188
  * @param {File} file
6189
6189
  * @param {*} [options] Override http request option.
6190
6190
  * @throws {RequiredError}
@@ -6199,7 +6199,7 @@ declare const LibraryRecipeMetadataApiFp: (configuration?: Configuration) => {
6199
6199
  * <!-- theme: danger --> > **Experimental** Returns the metadata of the recipe.
6200
6200
  * @summary Get Recipe Metadata
6201
6201
  * @param {string} cell Unique identifier addressing a cell in all API calls.
6202
- * @param {string} recipe Recieved from [listRecipeMetadata](listRecipeMetadata) or from the response of [createRecipe](createRecipe).
6202
+ * @param {string} recipe Recieved from [listRecipeMetadata](#/operations/listRecipeMetadata) or from the response of [createRecipe](#/operations/createRecipe).
6203
6203
  * @param {*} [options] Override http request option.
6204
6204
  * @throws {RequiredError}
6205
6205
  */
@@ -6216,7 +6216,7 @@ declare const LibraryRecipeMetadataApiFp: (configuration?: Configuration) => {
6216
6216
  * <!-- theme: danger --> > **Experimental** Updates the metadata of a recipe. The update is partial, only the set fields get updated.
6217
6217
  * @summary Update Recipe Metadata
6218
6218
  * @param {string} cell Unique identifier addressing a cell in all API calls.
6219
- * @param {string} recipe Recieved from [listRecipeMetadata](listRecipeMetadata) or from the response of [createRecipe](createRecipe).
6219
+ * @param {string} recipe Recieved from [listRecipeMetadata](#/operations/listRecipeMetadata) or from the response of [createRecipe](#/operations/createRecipe).
6220
6220
  * @param {UpdateRecipeMetadataRequest} updateRecipeMetadataRequest
6221
6221
  * @param {*} [options] Override http request option.
6222
6222
  * @throws {RequiredError}
@@ -6226,7 +6226,7 @@ declare const LibraryRecipeMetadataApiFp: (configuration?: Configuration) => {
6226
6226
  * <!-- theme: danger --> > **Experimental** Uploads an image for a recipe. The image is served as a static file and the path is stored in the metadata.
6227
6227
  * @summary Upload Recipe Metadata Image
6228
6228
  * @param {string} cell Unique identifier addressing a cell in all API calls.
6229
- * @param {string} recipe Recieved from [listRecipeMetadata](listRecipeMetadata) or from the response of [createRecipe](createRecipe).
6229
+ * @param {string} recipe Recieved from [listRecipeMetadata](#/operations/listRecipeMetadata) or from the response of [createRecipe](#/operations/createRecipe).
6230
6230
  * @param {File} file
6231
6231
  * @param {*} [options] Override http request option.
6232
6232
  * @throws {RequiredError}
@@ -6241,7 +6241,7 @@ declare const LibraryRecipeMetadataApiFactory: (configuration?: Configuration, b
6241
6241
  * <!-- theme: danger --> > **Experimental** Returns the metadata of the recipe.
6242
6242
  * @summary Get Recipe Metadata
6243
6243
  * @param {string} cell Unique identifier addressing a cell in all API calls.
6244
- * @param {string} recipe Recieved from [listRecipeMetadata](listRecipeMetadata) or from the response of [createRecipe](createRecipe).
6244
+ * @param {string} recipe Recieved from [listRecipeMetadata](#/operations/listRecipeMetadata) or from the response of [createRecipe](#/operations/createRecipe).
6245
6245
  * @param {*} [options] Override http request option.
6246
6246
  * @throws {RequiredError}
6247
6247
  */
@@ -6258,7 +6258,7 @@ declare const LibraryRecipeMetadataApiFactory: (configuration?: Configuration, b
6258
6258
  * <!-- theme: danger --> > **Experimental** Updates the metadata of a recipe. The update is partial, only the set fields get updated.
6259
6259
  * @summary Update Recipe Metadata
6260
6260
  * @param {string} cell Unique identifier addressing a cell in all API calls.
6261
- * @param {string} recipe Recieved from [listRecipeMetadata](listRecipeMetadata) or from the response of [createRecipe](createRecipe).
6261
+ * @param {string} recipe Recieved from [listRecipeMetadata](#/operations/listRecipeMetadata) or from the response of [createRecipe](#/operations/createRecipe).
6262
6262
  * @param {UpdateRecipeMetadataRequest} updateRecipeMetadataRequest
6263
6263
  * @param {*} [options] Override http request option.
6264
6264
  * @throws {RequiredError}
@@ -6268,7 +6268,7 @@ declare const LibraryRecipeMetadataApiFactory: (configuration?: Configuration, b
6268
6268
  * <!-- theme: danger --> > **Experimental** Uploads an image for a recipe. The image is served as a static file and the path is stored in the metadata.
6269
6269
  * @summary Upload Recipe Metadata Image
6270
6270
  * @param {string} cell Unique identifier addressing a cell in all API calls.
6271
- * @param {string} recipe Recieved from [listRecipeMetadata](listRecipeMetadata) or from the response of [createRecipe](createRecipe).
6271
+ * @param {string} recipe Recieved from [listRecipeMetadata](#/operations/listRecipeMetadata) or from the response of [createRecipe](#/operations/createRecipe).
6272
6272
  * @param {File} file
6273
6273
  * @param {*} [options] Override http request option.
6274
6274
  * @throws {RequiredError}
@@ -6283,11 +6283,11 @@ declare class LibraryRecipeMetadataApi extends BaseAPI {
6283
6283
  * <!-- theme: danger --> > **Experimental** Returns the metadata of the recipe.
6284
6284
  * @summary Get Recipe Metadata
6285
6285
  * @param {string} cell Unique identifier addressing a cell in all API calls.
6286
- * @param {string} recipe Recieved from [listRecipeMetadata](listRecipeMetadata) or from the response of [createRecipe](createRecipe).
6286
+ * @param {string} recipe Recieved from [listRecipeMetadata](#/operations/listRecipeMetadata) or from the response of [createRecipe](#/operations/createRecipe).
6287
6287
  * @param {*} [options] Override http request option.
6288
6288
  * @throws {RequiredError}
6289
6289
  */
6290
- getRecipeMetadata(cell: string, recipe: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<RecipeMetadata, any>>;
6290
+ getRecipeMetadata(cell: string, recipe: string, options?: RawAxiosRequestConfig): Promise<axios142.AxiosResponse<RecipeMetadata, any>>;
6291
6291
  /**
6292
6292
  * <!-- theme: danger --> > **Experimental** List of all the stored recipes, represented by their metadata.
6293
6293
  * @summary List Recipe Metadata
@@ -6295,27 +6295,27 @@ declare class LibraryRecipeMetadataApi extends BaseAPI {
6295
6295
  * @param {*} [options] Override http request option.
6296
6296
  * @throws {RequiredError}
6297
6297
  */
6298
- listRecipeMetadata(cell: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<ListRecipeMetadataResponse, any>>;
6298
+ listRecipeMetadata(cell: string, options?: RawAxiosRequestConfig): Promise<axios142.AxiosResponse<ListRecipeMetadataResponse, any>>;
6299
6299
  /**
6300
6300
  * <!-- theme: danger --> > **Experimental** Updates the metadata of a recipe. The update is partial, only the set fields get updated.
6301
6301
  * @summary Update Recipe Metadata
6302
6302
  * @param {string} cell Unique identifier addressing a cell in all API calls.
6303
- * @param {string} recipe Recieved from [listRecipeMetadata](listRecipeMetadata) or from the response of [createRecipe](createRecipe).
6303
+ * @param {string} recipe Recieved from [listRecipeMetadata](#/operations/listRecipeMetadata) or from the response of [createRecipe](#/operations/createRecipe).
6304
6304
  * @param {UpdateRecipeMetadataRequest} updateRecipeMetadataRequest
6305
6305
  * @param {*} [options] Override http request option.
6306
6306
  * @throws {RequiredError}
6307
6307
  */
6308
- updateRecipeMetadata(cell: string, recipe: string, updateRecipeMetadataRequest: UpdateRecipeMetadataRequest, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<RecipeMetadata, any>>;
6308
+ updateRecipeMetadata(cell: string, recipe: string, updateRecipeMetadataRequest: UpdateRecipeMetadataRequest, options?: RawAxiosRequestConfig): Promise<axios142.AxiosResponse<RecipeMetadata, any>>;
6309
6309
  /**
6310
6310
  * <!-- theme: danger --> > **Experimental** Uploads an image for a recipe. The image is served as a static file and the path is stored in the metadata.
6311
6311
  * @summary Upload Recipe Metadata Image
6312
6312
  * @param {string} cell Unique identifier addressing a cell in all API calls.
6313
- * @param {string} recipe Recieved from [listRecipeMetadata](listRecipeMetadata) or from the response of [createRecipe](createRecipe).
6313
+ * @param {string} recipe Recieved from [listRecipeMetadata](#/operations/listRecipeMetadata) or from the response of [createRecipe](#/operations/createRecipe).
6314
6314
  * @param {File} file
6315
6315
  * @param {*} [options] Override http request option.
6316
6316
  * @throws {RequiredError}
6317
6317
  */
6318
- uploadRecipeMetadataImage(cell: string, recipe: string, file: File, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<RecipeMetadata, any>>;
6318
+ uploadRecipeMetadataImage(cell: string, recipe: string, file: File, options?: RawAxiosRequestConfig): Promise<axios142.AxiosResponse<RecipeMetadata, any>>;
6319
6319
  }
6320
6320
  /**
6321
6321
  * LicenseApi - axios parameter creator
@@ -6430,28 +6430,28 @@ declare class LicenseApi extends BaseAPI {
6430
6430
  * @param {*} [options] Override http request option.
6431
6431
  * @throws {RequiredError}
6432
6432
  */
6433
- activateLicense(activateLicenseRequest: ActivateLicenseRequest, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<License, any>>;
6433
+ activateLicense(activateLicenseRequest: ActivateLicenseRequest, options?: RawAxiosRequestConfig): Promise<axios142.AxiosResponse<License, any>>;
6434
6434
  /**
6435
6435
  * Deactivates active license.
6436
6436
  * @summary Deactivate license
6437
6437
  * @param {*} [options] Override http request option.
6438
6438
  * @throws {RequiredError}
6439
6439
  */
6440
- deactivateLicense(options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
6440
+ deactivateLicense(options?: RawAxiosRequestConfig): Promise<axios142.AxiosResponse<void, any>>;
6441
6441
  /**
6442
6442
  * Get information on the license used with the Wandelbots NOVA instance, e.g. licensed product, expiration date, license status.
6443
6443
  * @summary Get license
6444
6444
  * @param {*} [options] Override http request option.
6445
6445
  * @throws {RequiredError}
6446
6446
  */
6447
- getLicense(options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<License, any>>;
6447
+ getLicense(options?: RawAxiosRequestConfig): Promise<axios142.AxiosResponse<License, any>>;
6448
6448
  /**
6449
6449
  * Get the license status. If `valid`, Wandelbots NOVA can be used. If `expired`, the license has to be renewed in order to use Wandelbots NOVA.
6450
6450
  * @summary Get license status
6451
6451
  * @param {*} [options] Override http request option.
6452
6452
  * @throws {RequiredError}
6453
6453
  */
6454
- getLicenseStatus(options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<LicenseStatus, any>>;
6454
+ getLicenseStatus(options?: RawAxiosRequestConfig): Promise<axios142.AxiosResponse<LicenseStatus, any>>;
6455
6455
  }
6456
6456
  /**
6457
6457
  * MotionApi - axios parameter creator
@@ -6466,7 +6466,7 @@ declare const MotionApiAxiosParamCreator: (configuration?: Configuration) => {
6466
6466
  */
6467
6467
  deleteAllMotions: (cell: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
6468
6468
  /**
6469
- * Remove a previously created motion from cache. Use [listMotions](listMotions) to list all available motions. Motions are removed automatically if the motion group or the corresponding controller is disconnected.
6469
+ * Remove a previously created motion from cache. Use [listMotions](#/operations/listMotions) to list all available motions. Motions are removed automatically if the motion group or the corresponding controller is disconnected.
6470
6470
  * @summary Remove
6471
6471
  * @param {string} cell Unique identifier addressing a cell in all API calls.
6472
6472
  * @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.
@@ -6475,7 +6475,7 @@ declare const MotionApiAxiosParamCreator: (configuration?: Configuration) => {
6475
6475
  */
6476
6476
  deleteMotion: (cell: string, motion: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
6477
6477
  /**
6478
- * <!-- theme: danger --> > Websocket endpoint Provides execution control over a previously planned trajectory. Enables the caller to attach I/O actions to the trajectory. Understanding the 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 [planMotion](planMotion). 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. ### 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 reponse 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 reponse . - 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.
6478
+ * <!-- theme: danger --> > Websocket endpoint Provide execution control over a previously planned trajectory. Enable the caller to attach I/O actions to the trajectory. Understanding the 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 [planMotion](#/operations/planMotion). 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 is at the start location specified with InitializeMovementRequest. ### 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.
6479
6479
  * @summary Execute Trajectory
6480
6480
  * @param {string} cell Unique identifier addressing a cell in all API calls.
6481
6481
  * @param {ExecuteTrajectoryRequest} executeTrajectoryRequest
@@ -6484,7 +6484,7 @@ declare const MotionApiAxiosParamCreator: (configuration?: Configuration) => {
6484
6484
  */
6485
6485
  executeTrajectory: (cell: string, executeTrajectoryRequest: ExecuteTrajectoryRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
6486
6486
  /**
6487
- * Get the trajectory of a planned motion with defined `sample_time` in milliseconds (ms). The trajectory is a list of points containing cartesian and joint data. The cartesian data is in the requested coordinate system. To get a single point of the trajectory, please use the [getMotionTrajectorySample](getMotionTrajectorySample) endpoint.
6487
+ * Get the trajectory of a planned motion with defined `sample_time` in milliseconds (ms). The trajectory is a list of points containing cartesian and joint data. The cartesian data is in the requested coordinate system. To get a single point of the trajectory, please use the [getMotionTrajectorySample](#/operations/getMotionTrajectorySample) endpoint.
6488
6488
  * @summary Get Trajectory
6489
6489
  * @param {string} cell Unique identifier addressing a cell in all API calls.
6490
6490
  * @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.
@@ -6495,18 +6495,18 @@ declare const MotionApiAxiosParamCreator: (configuration?: Configuration) => {
6495
6495
  */
6496
6496
  getMotionTrajectory: (cell: string, motion: string, sampleTime: number, responsesCoordinateSystem?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
6497
6497
  /**
6498
- * Get a single point at a certain location of a planned motion. To get the whole trajectory, use the [getMotionTrajectory](getMotionTrajectory) endpoint.
6498
+ * Get a single point at a certain location of a planned motion. To get the whole trajectory, use the [getMotionTrajectory](#/operations/getMotionTrajectory) endpoint.
6499
6499
  * @summary Get Trajectory Sample
6500
6500
  * @param {string} cell Unique identifier addressing a cell in all API calls.
6501
6501
  * @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.
6502
6502
  * @param {number} [locationOnTrajectory]
6503
- * @param {string} [responseCoordinateSystem] Unique identifier addressing a coordinate system in which the cartesian data of the response should be converted to. Default is the world coordinate system.
6503
+ * @param {string} [responseCoordinateSystem] Unique identifier addressing a coordinate system for which the cartesian data of the response should be converted to. Default is the world coordinate system.
6504
6504
  * @param {*} [options] Override http request option.
6505
6505
  * @throws {RequiredError}
6506
6506
  */
6507
6507
  getMotionTrajectorySample: (cell: string, motion: string, locationOnTrajectory?: number, responseCoordinateSystem?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
6508
6508
  /**
6509
- * Get the joint data of a planned motion. The planned motion contains only the joint information, to persistently store and reload it later. The data will be sampled equidistantly with defined `sample_time` in milliseconds (ms). If not provided, the data is returned as it is stored on Wandelbots NOVA system. To request cartesian data for visualization purposes, use the [getMotionTrajectory](getMotionTrajectory) endpoint. To get a single point of the planned motion, use the [getMotionTrajectorySample](getMotionTrajectorySample) endpoint.
6509
+ * Get the joint data of a planned motion. The planned motion contains only the joint information, to persistently store and reload it later. The data will be sampled equidistantly with defined `sample_time` in milliseconds (ms). If not provided, the data is returned as it is stored on Wandelbots NOVA system. To request cartesian data for visualization purposes, use the [getMotionTrajectory](#/operations/getMotionTrajectory) endpoint. To get a single point of the planned motion, use the [getMotionTrajectorySample](#/operations/getMotionTrajectorySample) endpoint.
6510
6510
  * @summary Get Planned Motion
6511
6511
  * @param {string} cell Unique identifier addressing a cell in all API calls.
6512
6512
  * @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.
@@ -6524,7 +6524,7 @@ declare const MotionApiAxiosParamCreator: (configuration?: Configuration) => {
6524
6524
  */
6525
6525
  getPlanningMotionGroupModels: (cell: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
6526
6526
  /**
6527
- * List all currently planned and available motions. Use [planMotion](planMotion) to plan a new motion. Motions are removed if the corresponding motion group or controller disconnects.
6527
+ * List all currently planned and available motions. Use [planMotion](#/operations/planMotion) to plan a new motion. Motions are removed if the corresponding motion group or controller disconnects.
6528
6528
  * @summary List All Motions
6529
6529
  * @param {string} cell Unique identifier addressing a cell in all API calls.
6530
6530
  * @param {*} [options] Override http request option.
@@ -6532,7 +6532,7 @@ declare const MotionApiAxiosParamCreator: (configuration?: Configuration) => {
6532
6532
  */
6533
6533
  listMotions: (cell: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
6534
6534
  /**
6535
- * Loads and validates the data of a planned motion into a motion session. The response contains information about the validated motion. Validation can lead to three different results: - Fully valid: The whole planned motion can be executed from start to end. The response will contain the session to move the robot. - Partially valid: Only parts of the planned motion can be executed. The response will contain the session to move the robot and information about the failure for the part that is not executable. - Invalid: The planned motion can not be executed. The response will tell you, which information about the reason of failure. If the motion is at least partially valid, the parts of the motion that are valid can be executed using the [streamMoveForward](streamMoveForward) endpoint. You can use the following workflows: - Plan motions using the [planMotion](planMotion) endpoint, - Store the planned motion persistently, - Use this endpoint to reload the stored motion and get a motion session for it. - Execute the loaded motion using the [streamMoveForward](streamMoveForward) endpoint. OR: - Generate a planned motion with [planTrajectory](planTrajectory) or your own motion planner, - Send the planned motion to this endpoint to validate it and get a motion session for it, - Execute your motion using the [streamMoveForward](streamMoveForward) endpoint. Once a planned motion is validated, it is treated like a motion session and will appear in the list of available motions, see [listMotions](listMotions) endpoint. You can then execute a motion session with the [streamMoveForward](streamMoveForward) endpoint.
6535
+ * Loads and validates the data of a planned motion into a motion session. The response contains information about the validated motion. Validation can lead to three different results: - Fully valid: The whole planned motion can be executed from start to end. The response will contain the session to move the robot. - Partially valid: Only parts of the planned motion can be executed. The response will contain the session to move the robot and information about the failure for the part that is not executable. - Invalid: The planned motion can not be executed. The response will tell you, which information about the reason of failure. If the motion is at least partially valid, the parts of the motion that are valid can be executed using the [streamMoveForward](#/operations/streamMoveForward) endpoint. You can use the following workflows: - Plan motions using the [planMotion](#/operations/planMotion) endpoint, - Store the planned motion persistently, - Use this endpoint to reload the stored motion and get a motion session for it. - Execute the loaded motion using the [streamMoveForward](#/operations/streamMoveForward) endpoint. OR: - Generate a planned motion with [planTrajectory](#/operations/planTrajectory) or your own motion planner, - Send the planned motion to this endpoint to validate it and get a motion session for it, - Execute your motion using the [streamMoveForward](#/operations/streamMoveForward) endpoint. Once a planned motion is validated, it is treated like a motion session and will appear in the list of available motions, see [listMotions](#/operations/listMotions) endpoint. You can then execute a motion session with the [streamMoveForward](#/operations/streamMoveForward) endpoint.
6536
6536
  * @summary Load Planned Motion
6537
6537
  * @param {string} cell Unique identifier addressing a cell in all API calls.
6538
6538
  * @param {PlannedMotion} plannedMotion
@@ -6541,7 +6541,7 @@ declare const MotionApiAxiosParamCreator: (configuration?: Configuration) => {
6541
6541
  */
6542
6542
  loadPlannedMotion: (cell: string, plannedMotion: PlannedMotion, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
6543
6543
  /**
6544
- * <!-- theme: danger --> > **Experimental** Plans a collision-free PTP motion for a single motion group. Use the following workflow to execute a planned trajectory: 1. Plan collision-free movement/motion. 2. Validate and load the planned trajectory using the [loadPlannedMotion](loadPlannedMotion) endpoint. 3. Execute the loaded trajectory using the [streamMove](streamMove) endpoint.
6544
+ * <!-- theme: danger --> > **Experimental** Plans a collision-free PTP motion for a single motion group. Use the following workflow to execute a planned trajectory: 1. Plan a collision-free movement/motion. 2. Validate and load the planned trajectory using the [loadPlannedMotion](#/operations/loadPlannedMotion) endpoint. 3. Execute the loaded trajectory using the [streamMove](#/operations/streamMove) endpoint.
6545
6545
  * @summary Plan Collision Free PTP
6546
6546
  * @param {string} cell Unique identifier addressing a cell in all API calls.
6547
6547
  * @param {PlanCollisionFreePTPRequest} [planCollisionFreePTPRequest]
@@ -6550,7 +6550,7 @@ declare const MotionApiAxiosParamCreator: (configuration?: Configuration) => {
6550
6550
  */
6551
6551
  planCollisionFreePTP: (cell: string, planCollisionFreePTPRequest?: PlanCollisionFreePTPRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
6552
6552
  /**
6553
- * Deprecated endpoint. Use [planTrajectory](planTrajectory) and [loadPlannedMotion](loadPlannedMotion) instead. Plans a new motion for a single previously configured [motion group](listMotionGroups). Motions are described by a sequence of motion commands starting with start joints. A motion is planned from standstill to standstill. A single motion has constant TCP and payload. Currently, I/O actions can\'t be attached to a motion to execute the action in realtime while a motion is executed. If an I/O is needed at a specific point, multiple motions need to be planned. If an I/O is needed to be set while a motion is executed, the endpoint [setOutputValues](setOutputValues) could be used.
6553
+ * Deprecated endpoint. Use [planTrajectory](#/operations/planTrajectory) and [loadPlannedMotion](#/operations/loadPlannedMotion) instead. Plans a new motion for a single previously configured [motion group](#/operations/listMotionGroups). Motions are described by a sequence of motion commands starting with start joints. A motion is planned from standstill to standstill. A single motion has constant TCP and payload. Currently, I/O actions can\'t be attached to a motion to execute the action in realtime while a motion is executed. If an I/O is needed at a specific point, multiple motions need to be planned. If an I/O is needed to be set while a motion is executed, the endpoint [setOutputValues](#/operations/setOutputValues) could be used.
6554
6554
  * @summary Plan Motion
6555
6555
  * @param {string} cell Unique identifier addressing a cell in all API calls.
6556
6556
  * @param {PlanRequest} planRequest
@@ -6560,7 +6560,7 @@ declare const MotionApiAxiosParamCreator: (configuration?: Configuration) => {
6560
6560
  */
6561
6561
  planMotion: (cell: string, planRequest: PlanRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
6562
6562
  /**
6563
- * Plans a new trajectory for a single motion group. Describe the trajectory as a sequence of motion commands that the robots TCP should follow. Use the following workflow to execute a planned trajectory: 1. Plan a trajectory. 2. Validate and load the planned trajectory using the [loadPlannedMotion](loadPlannedMotion) endpoint. 3. Execute the loaded trajectory using the [streamMove](streamMove) endpoint. If the trajectory is not executable, the [PlanTrajectoryResponse](PlanTrajectoryResponse) will contain the joint trajectory up until the error, e.g. all samples until a collision occurs. EXCEPTION: If a CartesianPTP or JointPTP motion command has an invalid target, the response will contain the trajectory up until the start of the invalid PTP motion.
6563
+ * Plans a new trajectory for a single motion group. Describe the trajectory as a sequence of motion commands that the robots TCP should follow. Use the following workflow to execute a planned trajectory: 1. Plan a trajectory. 2. Validate and load the planned trajectory using the [loadPlannedMotion](#/operations/loadPlannedMotion) endpoint. 3. Execute the loaded trajectory using the [streamMove](#/operations/streamMove) endpoint. If the trajectory is not executable, the PlanTrajectoryFailedResponse will contain the joint trajectory up until the error (e.g. a collision) occurred. EXCEPTION: If a CartesianPTP or JointPTP motion command has an invalid target, the response will contain the trajectory up until the start of the invalid PTP motion.
6564
6564
  * @summary Plan Trajectory
6565
6565
  * @param {string} cell Unique identifier addressing a cell in all API calls.
6566
6566
  * @param {PlanTrajectoryRequest} [planTrajectoryRequest]
@@ -6588,7 +6588,7 @@ declare const MotionApiAxiosParamCreator: (configuration?: Configuration) => {
6588
6588
  */
6589
6589
  streamMove: (cell: string, streamMoveRequest: StreamMoveRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
6590
6590
  /**
6591
- * Deprecated endpoint. Use the [executeTrajectory](executeTrajectory) endpoint instead. Request to move the motion group backward along a previously planned motion. Once started, you can stop a motion using the [stopExecution](stopExecution) endpoint. Prerequisites, before starting the motion execution: - The motion group is currently at the endpoint of the planned motion. OR - The motion was stopped using [stopExecution](stopExecution) endpoint. Then it is possible to resume the motion execution from where it stopped. OR - The motion group was moved onto the motion using the [streamMoveToTrajectoryViaJointP2P](streamMoveToTrajectoryViaJointP2P) endpoint.
6591
+ * Deprecated endpoint. Use the [executeTrajectory](#/operations/executeTrajectory) endpoint instead. Request to move the motion group backward along a previously planned motion. Once started, you can stop a motion using the [stopExecution](#/operations/stopExecution) endpoint. Prerequisites, before starting the motion execution: - The motion group is currently at the endpoint of the planned motion OR - The motion was stopped using [stopExecution](#/operations/stopExecution) endpoint. Then it is possible to resume the motion execution from where it stopped OR - The motion group was moved onto the motion using the [streamMoveToTrajectoryViaJointP2P](#/operations/streamMoveToTrajectoryViaJointP2P) endpoint.
6592
6592
  * @summary Stream Backward
6593
6593
  * @param {string} cell Unique identifier addressing a cell in all API calls.
6594
6594
  * @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.
@@ -6602,21 +6602,21 @@ declare const MotionApiAxiosParamCreator: (configuration?: Configuration) => {
6602
6602
  */
6603
6603
  streamMoveBackward: (cell: string, motion: string, playbackSpeedInPercent: number, responseRate?: number, responseCoordinateSystem?: string, startLocationOnTrajectory?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
6604
6604
  /**
6605
- * Deprecated endpoint. Use the [executeTrajectory](executeTrajectory) endpoint instead. Moves the motion group forward along a previously planned motion. Once started, you can stop a motion using the [stopExecution](stopExecution) endpoint. Prerequisites, before starting the motion execution: - The motion group is currently at the start point of the planned motion. OR - The motion was stopped using [stopExecution](stopExecution) endpoint. Then it is possible to resume the motion execution from where it stopped. OR - The motion group was moved onto the motion using the [streamMoveToTrajectoryViaJointP2P](streamMoveToTrajectoryViaJointP2P) endpoint.
6605
+ * Deprecated endpoint. Use the [executeTrajectory](#/operations/executeTrajectory) endpoint instead. Move the motion group forward along a previously planned motion. Once started, you can stop a motion using the [stopExecution](#/operations/stopExecution) endpoint. Prerequisites, before starting the motion execution: - The motion group is currently at the start point of the planned motion OR - The motion was stopped using [stopExecution](#/operations/stopExecution) endpoint. Then it is possible to resume the motion execution from where it stopped OR - The motion group was moved onto the motion using the [streamMoveToTrajectoryViaJointP2P](#/operations/streamMoveToTrajectoryViaJointP2P) endpoint.
6606
6606
  * @summary Stream Forward
6607
6607
  * @param {string} cell Unique identifier addressing a cell in all API calls.
6608
6608
  * @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.
6609
6609
  * @param {number} playbackSpeedInPercent Set the velocity for executed movements of the motion in percent. A percentage of 100% means that the robot moves as fast as possible without violating the limits. Setting this value does not affect the overall shape of the velocity profile. Everything is slowed down by the same factor. Therefore, this should only be used for teaching and trajectory evaluation purposes. If the process requires a certain velocity, the respective limits should be set when planning the motion. This will not change the velocity override of the controller. The controller velocity override value shall be 100% to ensure controllability of the motion group.
6610
6610
  * @param {number} [responseRate] Update rate for the response message in milliseconds (ms). Default is 200 ms. We recommend to use the step rate of the controller or a multiple of the step rate as NOVA updates the state in the controller\&#39;s step rate as well. Minimal response rate is the step rate of controller.
6611
6611
  * @param {string} [responseCoordinateSystem] Unique identifier addressing a coordinate system to which the cartesian data of the responses should be converted. Default is the world coordinate system.
6612
- * @param {number} [startLocationOnTrajectory] Location the motion is requested to start at. The default value is the begin of the trajectory. The location is a scalar value that defines a position along a path, typically ranging from 0 to &#x60;n&#x60;, where &#x60;n&#x60; denotes the number of motion commands. Each integer value of the location corresponds to a specific motion command, while non-integer values interpolate positions within the segments. The location is calculated from the joint path.
6612
+ * @param {number} [startLocationOnTrajectory] Location the motion is requested to start at. The default value is the beginning of the trajectory. The location is a scalar value that defines a position along a path, typically ranging from 0 to &#x60;n&#x60;, where &#x60;n&#x60; denotes the number of motion commands. Each integer value of the location corresponds to a specific motion command, while non-integer values interpolate positions within the segments. The location is calculated from the joint path.
6613
6613
  * @param {*} [options] Override http request option.
6614
6614
  * @deprecated
6615
6615
  * @throws {RequiredError}
6616
6616
  */
6617
6617
  streamMoveForward: (cell: string, motion: string, playbackSpeedInPercent: number, responseRate?: number, responseCoordinateSystem?: string, startLocationOnTrajectory?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
6618
6618
  /**
6619
- * Request to move the motion group via joint point-to-point to a given location on a planned motion. You must use this endpoint in order to start moving from an arbritrary location of the trajectory. Afterwards, you are able to call [streamMoveForward](streamMoveForward) or [streamMoveBackward](streamMoveBackward) to move along planned motion. Use the [stopExecution](stopExecution) endpoint to stop the motion gracefully.
6619
+ * Request to move the motion group via joint point-to-point to a given location on a planned motion. You must use this endpoint in order to start moving from an arbritrary location of the trajectory. Afterwards, you are able to call [streamMoveForward](#/operations/streamMoveForward) or [streamMoveBackward](#/operations/streamMoveBackward) to move along planned motion. Use the [stopExecution](#/operations/stopExecution) endpoint to stop the motion gracefully.
6620
6620
  * @summary Stream to Trajectory
6621
6621
  * @param {string} cell Unique identifier addressing a cell in all API calls.
6622
6622
  * @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.
@@ -6646,7 +6646,7 @@ declare const MotionApiFp: (configuration?: Configuration) => {
6646
6646
  */
6647
6647
  deleteAllMotions(cell: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
6648
6648
  /**
6649
- * Remove a previously created motion from cache. Use [listMotions](listMotions) to list all available motions. Motions are removed automatically if the motion group or the corresponding controller is disconnected.
6649
+ * Remove a previously created motion from cache. Use [listMotions](#/operations/listMotions) to list all available motions. Motions are removed automatically if the motion group or the corresponding controller is disconnected.
6650
6650
  * @summary Remove
6651
6651
  * @param {string} cell Unique identifier addressing a cell in all API calls.
6652
6652
  * @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.
@@ -6655,7 +6655,7 @@ declare const MotionApiFp: (configuration?: Configuration) => {
6655
6655
  */
6656
6656
  deleteMotion(cell: string, motion: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
6657
6657
  /**
6658
- * <!-- theme: danger --> > Websocket endpoint Provides execution control over a previously planned trajectory. Enables the caller to attach I/O actions to the trajectory. Understanding the 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 [planMotion](planMotion). 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. ### 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 reponse 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 reponse . - 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.
6658
+ * <!-- theme: danger --> > Websocket endpoint Provide execution control over a previously planned trajectory. Enable the caller to attach I/O actions to the trajectory. Understanding the 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 [planMotion](#/operations/planMotion). 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 is at the start location specified with InitializeMovementRequest. ### 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.
6659
6659
  * @summary Execute Trajectory
6660
6660
  * @param {string} cell Unique identifier addressing a cell in all API calls.
6661
6661
  * @param {ExecuteTrajectoryRequest} executeTrajectoryRequest
@@ -6664,7 +6664,7 @@ declare const MotionApiFp: (configuration?: Configuration) => {
6664
6664
  */
6665
6665
  executeTrajectory(cell: string, executeTrajectoryRequest: ExecuteTrajectoryRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ExecuteTrajectoryResponse>>;
6666
6666
  /**
6667
- * Get the trajectory of a planned motion with defined `sample_time` in milliseconds (ms). The trajectory is a list of points containing cartesian and joint data. The cartesian data is in the requested coordinate system. To get a single point of the trajectory, please use the [getMotionTrajectorySample](getMotionTrajectorySample) endpoint.
6667
+ * Get the trajectory of a planned motion with defined `sample_time` in milliseconds (ms). The trajectory is a list of points containing cartesian and joint data. The cartesian data is in the requested coordinate system. To get a single point of the trajectory, please use the [getMotionTrajectorySample](#/operations/getMotionTrajectorySample) endpoint.
6668
6668
  * @summary Get Trajectory
6669
6669
  * @param {string} cell Unique identifier addressing a cell in all API calls.
6670
6670
  * @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.
@@ -6675,18 +6675,18 @@ declare const MotionApiFp: (configuration?: Configuration) => {
6675
6675
  */
6676
6676
  getMotionTrajectory(cell: string, motion: string, sampleTime: number, responsesCoordinateSystem?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetTrajectoryResponse>>;
6677
6677
  /**
6678
- * Get a single point at a certain location of a planned motion. To get the whole trajectory, use the [getMotionTrajectory](getMotionTrajectory) endpoint.
6678
+ * Get a single point at a certain location of a planned motion. To get the whole trajectory, use the [getMotionTrajectory](#/operations/getMotionTrajectory) endpoint.
6679
6679
  * @summary Get Trajectory Sample
6680
6680
  * @param {string} cell Unique identifier addressing a cell in all API calls.
6681
6681
  * @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.
6682
6682
  * @param {number} [locationOnTrajectory]
6683
- * @param {string} [responseCoordinateSystem] Unique identifier addressing a coordinate system in which the cartesian data of the response should be converted to. Default is the world coordinate system.
6683
+ * @param {string} [responseCoordinateSystem] Unique identifier addressing a coordinate system for which the cartesian data of the response should be converted to. Default is the world coordinate system.
6684
6684
  * @param {*} [options] Override http request option.
6685
6685
  * @throws {RequiredError}
6686
6686
  */
6687
6687
  getMotionTrajectorySample(cell: string, motion: string, locationOnTrajectory?: number, responseCoordinateSystem?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetTrajectorySampleResponse>>;
6688
6688
  /**
6689
- * Get the joint data of a planned motion. The planned motion contains only the joint information, to persistently store and reload it later. The data will be sampled equidistantly with defined `sample_time` in milliseconds (ms). If not provided, the data is returned as it is stored on Wandelbots NOVA system. To request cartesian data for visualization purposes, use the [getMotionTrajectory](getMotionTrajectory) endpoint. To get a single point of the planned motion, use the [getMotionTrajectorySample](getMotionTrajectorySample) endpoint.
6689
+ * Get the joint data of a planned motion. The planned motion contains only the joint information, to persistently store and reload it later. The data will be sampled equidistantly with defined `sample_time` in milliseconds (ms). If not provided, the data is returned as it is stored on Wandelbots NOVA system. To request cartesian data for visualization purposes, use the [getMotionTrajectory](#/operations/getMotionTrajectory) endpoint. To get a single point of the planned motion, use the [getMotionTrajectorySample](#/operations/getMotionTrajectorySample) endpoint.
6690
6690
  * @summary Get Planned Motion
6691
6691
  * @param {string} cell Unique identifier addressing a cell in all API calls.
6692
6692
  * @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.
@@ -6704,7 +6704,7 @@ declare const MotionApiFp: (configuration?: Configuration) => {
6704
6704
  */
6705
6705
  getPlanningMotionGroupModels(cell: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<string>>>;
6706
6706
  /**
6707
- * List all currently planned and available motions. Use [planMotion](planMotion) to plan a new motion. Motions are removed if the corresponding motion group or controller disconnects.
6707
+ * List all currently planned and available motions. Use [planMotion](#/operations/planMotion) to plan a new motion. Motions are removed if the corresponding motion group or controller disconnects.
6708
6708
  * @summary List All Motions
6709
6709
  * @param {string} cell Unique identifier addressing a cell in all API calls.
6710
6710
  * @param {*} [options] Override http request option.
@@ -6712,7 +6712,7 @@ declare const MotionApiFp: (configuration?: Configuration) => {
6712
6712
  */
6713
6713
  listMotions(cell: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<MotionIdsListResponse>>;
6714
6714
  /**
6715
- * Loads and validates the data of a planned motion into a motion session. The response contains information about the validated motion. Validation can lead to three different results: - Fully valid: The whole planned motion can be executed from start to end. The response will contain the session to move the robot. - Partially valid: Only parts of the planned motion can be executed. The response will contain the session to move the robot and information about the failure for the part that is not executable. - Invalid: The planned motion can not be executed. The response will tell you, which information about the reason of failure. If the motion is at least partially valid, the parts of the motion that are valid can be executed using the [streamMoveForward](streamMoveForward) endpoint. You can use the following workflows: - Plan motions using the [planMotion](planMotion) endpoint, - Store the planned motion persistently, - Use this endpoint to reload the stored motion and get a motion session for it. - Execute the loaded motion using the [streamMoveForward](streamMoveForward) endpoint. OR: - Generate a planned motion with [planTrajectory](planTrajectory) or your own motion planner, - Send the planned motion to this endpoint to validate it and get a motion session for it, - Execute your motion using the [streamMoveForward](streamMoveForward) endpoint. Once a planned motion is validated, it is treated like a motion session and will appear in the list of available motions, see [listMotions](listMotions) endpoint. You can then execute a motion session with the [streamMoveForward](streamMoveForward) endpoint.
6715
+ * Loads and validates the data of a planned motion into a motion session. The response contains information about the validated motion. Validation can lead to three different results: - Fully valid: The whole planned motion can be executed from start to end. The response will contain the session to move the robot. - Partially valid: Only parts of the planned motion can be executed. The response will contain the session to move the robot and information about the failure for the part that is not executable. - Invalid: The planned motion can not be executed. The response will tell you, which information about the reason of failure. If the motion is at least partially valid, the parts of the motion that are valid can be executed using the [streamMoveForward](#/operations/streamMoveForward) endpoint. You can use the following workflows: - Plan motions using the [planMotion](#/operations/planMotion) endpoint, - Store the planned motion persistently, - Use this endpoint to reload the stored motion and get a motion session for it. - Execute the loaded motion using the [streamMoveForward](#/operations/streamMoveForward) endpoint. OR: - Generate a planned motion with [planTrajectory](#/operations/planTrajectory) or your own motion planner, - Send the planned motion to this endpoint to validate it and get a motion session for it, - Execute your motion using the [streamMoveForward](#/operations/streamMoveForward) endpoint. Once a planned motion is validated, it is treated like a motion session and will appear in the list of available motions, see [listMotions](#/operations/listMotions) endpoint. You can then execute a motion session with the [streamMoveForward](#/operations/streamMoveForward) endpoint.
6716
6716
  * @summary Load Planned Motion
6717
6717
  * @param {string} cell Unique identifier addressing a cell in all API calls.
6718
6718
  * @param {PlannedMotion} plannedMotion
@@ -6721,7 +6721,7 @@ declare const MotionApiFp: (configuration?: Configuration) => {
6721
6721
  */
6722
6722
  loadPlannedMotion(cell: string, plannedMotion: PlannedMotion, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PlanResponse>>;
6723
6723
  /**
6724
- * <!-- theme: danger --> > **Experimental** Plans a collision-free PTP motion for a single motion group. Use the following workflow to execute a planned trajectory: 1. Plan collision-free movement/motion. 2. Validate and load the planned trajectory using the [loadPlannedMotion](loadPlannedMotion) endpoint. 3. Execute the loaded trajectory using the [streamMove](streamMove) endpoint.
6724
+ * <!-- theme: danger --> > **Experimental** Plans a collision-free PTP motion for a single motion group. Use the following workflow to execute a planned trajectory: 1. Plan a collision-free movement/motion. 2. Validate and load the planned trajectory using the [loadPlannedMotion](#/operations/loadPlannedMotion) endpoint. 3. Execute the loaded trajectory using the [streamMove](#/operations/streamMove) endpoint.
6725
6725
  * @summary Plan Collision Free PTP
6726
6726
  * @param {string} cell Unique identifier addressing a cell in all API calls.
6727
6727
  * @param {PlanCollisionFreePTPRequest} [planCollisionFreePTPRequest]
@@ -6730,7 +6730,7 @@ declare const MotionApiFp: (configuration?: Configuration) => {
6730
6730
  */
6731
6731
  planCollisionFreePTP(cell: string, planCollisionFreePTPRequest?: PlanCollisionFreePTPRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PlanTrajectoryResponse>>;
6732
6732
  /**
6733
- * Deprecated endpoint. Use [planTrajectory](planTrajectory) and [loadPlannedMotion](loadPlannedMotion) instead. Plans a new motion for a single previously configured [motion group](listMotionGroups). Motions are described by a sequence of motion commands starting with start joints. A motion is planned from standstill to standstill. A single motion has constant TCP and payload. Currently, I/O actions can\'t be attached to a motion to execute the action in realtime while a motion is executed. If an I/O is needed at a specific point, multiple motions need to be planned. If an I/O is needed to be set while a motion is executed, the endpoint [setOutputValues](setOutputValues) could be used.
6733
+ * Deprecated endpoint. Use [planTrajectory](#/operations/planTrajectory) and [loadPlannedMotion](#/operations/loadPlannedMotion) instead. Plans a new motion for a single previously configured [motion group](#/operations/listMotionGroups). Motions are described by a sequence of motion commands starting with start joints. A motion is planned from standstill to standstill. A single motion has constant TCP and payload. Currently, I/O actions can\'t be attached to a motion to execute the action in realtime while a motion is executed. If an I/O is needed at a specific point, multiple motions need to be planned. If an I/O is needed to be set while a motion is executed, the endpoint [setOutputValues](#/operations/setOutputValues) could be used.
6734
6734
  * @summary Plan Motion
6735
6735
  * @param {string} cell Unique identifier addressing a cell in all API calls.
6736
6736
  * @param {PlanRequest} planRequest
@@ -6740,7 +6740,7 @@ declare const MotionApiFp: (configuration?: Configuration) => {
6740
6740
  */
6741
6741
  planMotion(cell: string, planRequest: PlanRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PlanResponse>>;
6742
6742
  /**
6743
- * Plans a new trajectory for a single motion group. Describe the trajectory as a sequence of motion commands that the robots TCP should follow. Use the following workflow to execute a planned trajectory: 1. Plan a trajectory. 2. Validate and load the planned trajectory using the [loadPlannedMotion](loadPlannedMotion) endpoint. 3. Execute the loaded trajectory using the [streamMove](streamMove) endpoint. If the trajectory is not executable, the [PlanTrajectoryResponse](PlanTrajectoryResponse) will contain the joint trajectory up until the error, e.g. all samples until a collision occurs. EXCEPTION: If a CartesianPTP or JointPTP motion command has an invalid target, the response will contain the trajectory up until the start of the invalid PTP motion.
6743
+ * Plans a new trajectory for a single motion group. Describe the trajectory as a sequence of motion commands that the robots TCP should follow. Use the following workflow to execute a planned trajectory: 1. Plan a trajectory. 2. Validate and load the planned trajectory using the [loadPlannedMotion](#/operations/loadPlannedMotion) endpoint. 3. Execute the loaded trajectory using the [streamMove](#/operations/streamMove) endpoint. If the trajectory is not executable, the PlanTrajectoryFailedResponse will contain the joint trajectory up until the error (e.g. a collision) occurred. EXCEPTION: If a CartesianPTP or JointPTP motion command has an invalid target, the response will contain the trajectory up until the start of the invalid PTP motion.
6744
6744
  * @summary Plan Trajectory
6745
6745
  * @param {string} cell Unique identifier addressing a cell in all API calls.
6746
6746
  * @param {PlanTrajectoryRequest} [planTrajectoryRequest]
@@ -6768,7 +6768,7 @@ declare const MotionApiFp: (configuration?: Configuration) => {
6768
6768
  */
6769
6769
  streamMove(cell: string, streamMoveRequest: StreamMoveRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<StreamMoveResponse>>;
6770
6770
  /**
6771
- * Deprecated endpoint. Use the [executeTrajectory](executeTrajectory) endpoint instead. Request to move the motion group backward along a previously planned motion. Once started, you can stop a motion using the [stopExecution](stopExecution) endpoint. Prerequisites, before starting the motion execution: - The motion group is currently at the endpoint of the planned motion. OR - The motion was stopped using [stopExecution](stopExecution) endpoint. Then it is possible to resume the motion execution from where it stopped. OR - The motion group was moved onto the motion using the [streamMoveToTrajectoryViaJointP2P](streamMoveToTrajectoryViaJointP2P) endpoint.
6771
+ * Deprecated endpoint. Use the [executeTrajectory](#/operations/executeTrajectory) endpoint instead. Request to move the motion group backward along a previously planned motion. Once started, you can stop a motion using the [stopExecution](#/operations/stopExecution) endpoint. Prerequisites, before starting the motion execution: - The motion group is currently at the endpoint of the planned motion OR - The motion was stopped using [stopExecution](#/operations/stopExecution) endpoint. Then it is possible to resume the motion execution from where it stopped OR - The motion group was moved onto the motion using the [streamMoveToTrajectoryViaJointP2P](#/operations/streamMoveToTrajectoryViaJointP2P) endpoint.
6772
6772
  * @summary Stream Backward
6773
6773
  * @param {string} cell Unique identifier addressing a cell in all API calls.
6774
6774
  * @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.
@@ -6782,21 +6782,21 @@ declare const MotionApiFp: (configuration?: Configuration) => {
6782
6782
  */
6783
6783
  streamMoveBackward(cell: string, motion: string, playbackSpeedInPercent: number, responseRate?: number, responseCoordinateSystem?: string, startLocationOnTrajectory?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<StreamMoveResponse>>;
6784
6784
  /**
6785
- * Deprecated endpoint. Use the [executeTrajectory](executeTrajectory) endpoint instead. Moves the motion group forward along a previously planned motion. Once started, you can stop a motion using the [stopExecution](stopExecution) endpoint. Prerequisites, before starting the motion execution: - The motion group is currently at the start point of the planned motion. OR - The motion was stopped using [stopExecution](stopExecution) endpoint. Then it is possible to resume the motion execution from where it stopped. OR - The motion group was moved onto the motion using the [streamMoveToTrajectoryViaJointP2P](streamMoveToTrajectoryViaJointP2P) endpoint.
6785
+ * Deprecated endpoint. Use the [executeTrajectory](#/operations/executeTrajectory) endpoint instead. Move the motion group forward along a previously planned motion. Once started, you can stop a motion using the [stopExecution](#/operations/stopExecution) endpoint. Prerequisites, before starting the motion execution: - The motion group is currently at the start point of the planned motion OR - The motion was stopped using [stopExecution](#/operations/stopExecution) endpoint. Then it is possible to resume the motion execution from where it stopped OR - The motion group was moved onto the motion using the [streamMoveToTrajectoryViaJointP2P](#/operations/streamMoveToTrajectoryViaJointP2P) endpoint.
6786
6786
  * @summary Stream Forward
6787
6787
  * @param {string} cell Unique identifier addressing a cell in all API calls.
6788
6788
  * @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.
6789
6789
  * @param {number} playbackSpeedInPercent Set the velocity for executed movements of the motion in percent. A percentage of 100% means that the robot moves as fast as possible without violating the limits. Setting this value does not affect the overall shape of the velocity profile. Everything is slowed down by the same factor. Therefore, this should only be used for teaching and trajectory evaluation purposes. If the process requires a certain velocity, the respective limits should be set when planning the motion. This will not change the velocity override of the controller. The controller velocity override value shall be 100% to ensure controllability of the motion group.
6790
6790
  * @param {number} [responseRate] Update rate for the response message in milliseconds (ms). Default is 200 ms. We recommend to use the step rate of the controller or a multiple of the step rate as NOVA updates the state in the controller\&#39;s step rate as well. Minimal response rate is the step rate of controller.
6791
6791
  * @param {string} [responseCoordinateSystem] Unique identifier addressing a coordinate system to which the cartesian data of the responses should be converted. Default is the world coordinate system.
6792
- * @param {number} [startLocationOnTrajectory] Location the motion is requested to start at. The default value is the begin of the trajectory. The location is a scalar value that defines a position along a path, typically ranging from 0 to &#x60;n&#x60;, where &#x60;n&#x60; denotes the number of motion commands. Each integer value of the location corresponds to a specific motion command, while non-integer values interpolate positions within the segments. The location is calculated from the joint path.
6792
+ * @param {number} [startLocationOnTrajectory] Location the motion is requested to start at. The default value is the beginning of the trajectory. The location is a scalar value that defines a position along a path, typically ranging from 0 to &#x60;n&#x60;, where &#x60;n&#x60; denotes the number of motion commands. Each integer value of the location corresponds to a specific motion command, while non-integer values interpolate positions within the segments. The location is calculated from the joint path.
6793
6793
  * @param {*} [options] Override http request option.
6794
6794
  * @deprecated
6795
6795
  * @throws {RequiredError}
6796
6796
  */
6797
6797
  streamMoveForward(cell: string, motion: string, playbackSpeedInPercent: number, responseRate?: number, responseCoordinateSystem?: string, startLocationOnTrajectory?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<StreamMoveResponse>>;
6798
6798
  /**
6799
- * Request to move the motion group via joint point-to-point to a given location on a planned motion. You must use this endpoint in order to start moving from an arbritrary location of the trajectory. Afterwards, you are able to call [streamMoveForward](streamMoveForward) or [streamMoveBackward](streamMoveBackward) to move along planned motion. Use the [stopExecution](stopExecution) endpoint to stop the motion gracefully.
6799
+ * Request to move the motion group via joint point-to-point to a given location on a planned motion. You must use this endpoint in order to start moving from an arbritrary location of the trajectory. Afterwards, you are able to call [streamMoveForward](#/operations/streamMoveForward) or [streamMoveBackward](#/operations/streamMoveBackward) to move along planned motion. Use the [stopExecution](#/operations/stopExecution) endpoint to stop the motion gracefully.
6800
6800
  * @summary Stream to Trajectory
6801
6801
  * @param {string} cell Unique identifier addressing a cell in all API calls.
6802
6802
  * @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.
@@ -6826,7 +6826,7 @@ declare const MotionApiFactory: (configuration?: Configuration, basePath?: strin
6826
6826
  */
6827
6827
  deleteAllMotions(cell: string, options?: RawAxiosRequestConfig): AxiosPromise<void>;
6828
6828
  /**
6829
- * Remove a previously created motion from cache. Use [listMotions](listMotions) to list all available motions. Motions are removed automatically if the motion group or the corresponding controller is disconnected.
6829
+ * Remove a previously created motion from cache. Use [listMotions](#/operations/listMotions) to list all available motions. Motions are removed automatically if the motion group or the corresponding controller is disconnected.
6830
6830
  * @summary Remove
6831
6831
  * @param {string} cell Unique identifier addressing a cell in all API calls.
6832
6832
  * @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.
@@ -6835,7 +6835,7 @@ declare const MotionApiFactory: (configuration?: Configuration, basePath?: strin
6835
6835
  */
6836
6836
  deleteMotion(cell: string, motion: string, options?: RawAxiosRequestConfig): AxiosPromise<void>;
6837
6837
  /**
6838
- * <!-- theme: danger --> > Websocket endpoint Provides execution control over a previously planned trajectory. Enables the caller to attach I/O actions to the trajectory. Understanding the 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 [planMotion](planMotion). 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. ### 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 reponse 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 reponse . - 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.
6838
+ * <!-- theme: danger --> > Websocket endpoint Provide execution control over a previously planned trajectory. Enable the caller to attach I/O actions to the trajectory. Understanding the 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 [planMotion](#/operations/planMotion). 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 is at the start location specified with InitializeMovementRequest. ### 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.
6839
6839
  * @summary Execute Trajectory
6840
6840
  * @param {string} cell Unique identifier addressing a cell in all API calls.
6841
6841
  * @param {ExecuteTrajectoryRequest} executeTrajectoryRequest
@@ -6844,7 +6844,7 @@ declare const MotionApiFactory: (configuration?: Configuration, basePath?: strin
6844
6844
  */
6845
6845
  executeTrajectory(cell: string, executeTrajectoryRequest: ExecuteTrajectoryRequest, options?: RawAxiosRequestConfig): AxiosPromise<ExecuteTrajectoryResponse>;
6846
6846
  /**
6847
- * Get the trajectory of a planned motion with defined `sample_time` in milliseconds (ms). The trajectory is a list of points containing cartesian and joint data. The cartesian data is in the requested coordinate system. To get a single point of the trajectory, please use the [getMotionTrajectorySample](getMotionTrajectorySample) endpoint.
6847
+ * Get the trajectory of a planned motion with defined `sample_time` in milliseconds (ms). The trajectory is a list of points containing cartesian and joint data. The cartesian data is in the requested coordinate system. To get a single point of the trajectory, please use the [getMotionTrajectorySample](#/operations/getMotionTrajectorySample) endpoint.
6848
6848
  * @summary Get Trajectory
6849
6849
  * @param {string} cell Unique identifier addressing a cell in all API calls.
6850
6850
  * @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.
@@ -6855,18 +6855,18 @@ declare const MotionApiFactory: (configuration?: Configuration, basePath?: strin
6855
6855
  */
6856
6856
  getMotionTrajectory(cell: string, motion: string, sampleTime: number, responsesCoordinateSystem?: string, options?: RawAxiosRequestConfig): AxiosPromise<GetTrajectoryResponse>;
6857
6857
  /**
6858
- * Get a single point at a certain location of a planned motion. To get the whole trajectory, use the [getMotionTrajectory](getMotionTrajectory) endpoint.
6858
+ * Get a single point at a certain location of a planned motion. To get the whole trajectory, use the [getMotionTrajectory](#/operations/getMotionTrajectory) endpoint.
6859
6859
  * @summary Get Trajectory Sample
6860
6860
  * @param {string} cell Unique identifier addressing a cell in all API calls.
6861
6861
  * @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.
6862
6862
  * @param {number} [locationOnTrajectory]
6863
- * @param {string} [responseCoordinateSystem] Unique identifier addressing a coordinate system in which the cartesian data of the response should be converted to. Default is the world coordinate system.
6863
+ * @param {string} [responseCoordinateSystem] Unique identifier addressing a coordinate system for which the cartesian data of the response should be converted to. Default is the world coordinate system.
6864
6864
  * @param {*} [options] Override http request option.
6865
6865
  * @throws {RequiredError}
6866
6866
  */
6867
6867
  getMotionTrajectorySample(cell: string, motion: string, locationOnTrajectory?: number, responseCoordinateSystem?: string, options?: RawAxiosRequestConfig): AxiosPromise<GetTrajectorySampleResponse>;
6868
6868
  /**
6869
- * Get the joint data of a planned motion. The planned motion contains only the joint information, to persistently store and reload it later. The data will be sampled equidistantly with defined `sample_time` in milliseconds (ms). If not provided, the data is returned as it is stored on Wandelbots NOVA system. To request cartesian data for visualization purposes, use the [getMotionTrajectory](getMotionTrajectory) endpoint. To get a single point of the planned motion, use the [getMotionTrajectorySample](getMotionTrajectorySample) endpoint.
6869
+ * Get the joint data of a planned motion. The planned motion contains only the joint information, to persistently store and reload it later. The data will be sampled equidistantly with defined `sample_time` in milliseconds (ms). If not provided, the data is returned as it is stored on Wandelbots NOVA system. To request cartesian data for visualization purposes, use the [getMotionTrajectory](#/operations/getMotionTrajectory) endpoint. To get a single point of the planned motion, use the [getMotionTrajectorySample](#/operations/getMotionTrajectorySample) endpoint.
6870
6870
  * @summary Get Planned Motion
6871
6871
  * @param {string} cell Unique identifier addressing a cell in all API calls.
6872
6872
  * @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.
@@ -6884,7 +6884,7 @@ declare const MotionApiFactory: (configuration?: Configuration, basePath?: strin
6884
6884
  */
6885
6885
  getPlanningMotionGroupModels(cell: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<string>>;
6886
6886
  /**
6887
- * List all currently planned and available motions. Use [planMotion](planMotion) to plan a new motion. Motions are removed if the corresponding motion group or controller disconnects.
6887
+ * List all currently planned and available motions. Use [planMotion](#/operations/planMotion) to plan a new motion. Motions are removed if the corresponding motion group or controller disconnects.
6888
6888
  * @summary List All Motions
6889
6889
  * @param {string} cell Unique identifier addressing a cell in all API calls.
6890
6890
  * @param {*} [options] Override http request option.
@@ -6892,7 +6892,7 @@ declare const MotionApiFactory: (configuration?: Configuration, basePath?: strin
6892
6892
  */
6893
6893
  listMotions(cell: string, options?: RawAxiosRequestConfig): AxiosPromise<MotionIdsListResponse>;
6894
6894
  /**
6895
- * Loads and validates the data of a planned motion into a motion session. The response contains information about the validated motion. Validation can lead to three different results: - Fully valid: The whole planned motion can be executed from start to end. The response will contain the session to move the robot. - Partially valid: Only parts of the planned motion can be executed. The response will contain the session to move the robot and information about the failure for the part that is not executable. - Invalid: The planned motion can not be executed. The response will tell you, which information about the reason of failure. If the motion is at least partially valid, the parts of the motion that are valid can be executed using the [streamMoveForward](streamMoveForward) endpoint. You can use the following workflows: - Plan motions using the [planMotion](planMotion) endpoint, - Store the planned motion persistently, - Use this endpoint to reload the stored motion and get a motion session for it. - Execute the loaded motion using the [streamMoveForward](streamMoveForward) endpoint. OR: - Generate a planned motion with [planTrajectory](planTrajectory) or your own motion planner, - Send the planned motion to this endpoint to validate it and get a motion session for it, - Execute your motion using the [streamMoveForward](streamMoveForward) endpoint. Once a planned motion is validated, it is treated like a motion session and will appear in the list of available motions, see [listMotions](listMotions) endpoint. You can then execute a motion session with the [streamMoveForward](streamMoveForward) endpoint.
6895
+ * Loads and validates the data of a planned motion into a motion session. The response contains information about the validated motion. Validation can lead to three different results: - Fully valid: The whole planned motion can be executed from start to end. The response will contain the session to move the robot. - Partially valid: Only parts of the planned motion can be executed. The response will contain the session to move the robot and information about the failure for the part that is not executable. - Invalid: The planned motion can not be executed. The response will tell you, which information about the reason of failure. If the motion is at least partially valid, the parts of the motion that are valid can be executed using the [streamMoveForward](#/operations/streamMoveForward) endpoint. You can use the following workflows: - Plan motions using the [planMotion](#/operations/planMotion) endpoint, - Store the planned motion persistently, - Use this endpoint to reload the stored motion and get a motion session for it. - Execute the loaded motion using the [streamMoveForward](#/operations/streamMoveForward) endpoint. OR: - Generate a planned motion with [planTrajectory](#/operations/planTrajectory) or your own motion planner, - Send the planned motion to this endpoint to validate it and get a motion session for it, - Execute your motion using the [streamMoveForward](#/operations/streamMoveForward) endpoint. Once a planned motion is validated, it is treated like a motion session and will appear in the list of available motions, see [listMotions](#/operations/listMotions) endpoint. You can then execute a motion session with the [streamMoveForward](#/operations/streamMoveForward) endpoint.
6896
6896
  * @summary Load Planned Motion
6897
6897
  * @param {string} cell Unique identifier addressing a cell in all API calls.
6898
6898
  * @param {PlannedMotion} plannedMotion
@@ -6901,7 +6901,7 @@ declare const MotionApiFactory: (configuration?: Configuration, basePath?: strin
6901
6901
  */
6902
6902
  loadPlannedMotion(cell: string, plannedMotion: PlannedMotion, options?: RawAxiosRequestConfig): AxiosPromise<PlanResponse>;
6903
6903
  /**
6904
- * <!-- theme: danger --> > **Experimental** Plans a collision-free PTP motion for a single motion group. Use the following workflow to execute a planned trajectory: 1. Plan collision-free movement/motion. 2. Validate and load the planned trajectory using the [loadPlannedMotion](loadPlannedMotion) endpoint. 3. Execute the loaded trajectory using the [streamMove](streamMove) endpoint.
6904
+ * <!-- theme: danger --> > **Experimental** Plans a collision-free PTP motion for a single motion group. Use the following workflow to execute a planned trajectory: 1. Plan a collision-free movement/motion. 2. Validate and load the planned trajectory using the [loadPlannedMotion](#/operations/loadPlannedMotion) endpoint. 3. Execute the loaded trajectory using the [streamMove](#/operations/streamMove) endpoint.
6905
6905
  * @summary Plan Collision Free PTP
6906
6906
  * @param {string} cell Unique identifier addressing a cell in all API calls.
6907
6907
  * @param {PlanCollisionFreePTPRequest} [planCollisionFreePTPRequest]
@@ -6910,7 +6910,7 @@ declare const MotionApiFactory: (configuration?: Configuration, basePath?: strin
6910
6910
  */
6911
6911
  planCollisionFreePTP(cell: string, planCollisionFreePTPRequest?: PlanCollisionFreePTPRequest, options?: RawAxiosRequestConfig): AxiosPromise<PlanTrajectoryResponse>;
6912
6912
  /**
6913
- * Deprecated endpoint. Use [planTrajectory](planTrajectory) and [loadPlannedMotion](loadPlannedMotion) instead. Plans a new motion for a single previously configured [motion group](listMotionGroups). Motions are described by a sequence of motion commands starting with start joints. A motion is planned from standstill to standstill. A single motion has constant TCP and payload. Currently, I/O actions can\'t be attached to a motion to execute the action in realtime while a motion is executed. If an I/O is needed at a specific point, multiple motions need to be planned. If an I/O is needed to be set while a motion is executed, the endpoint [setOutputValues](setOutputValues) could be used.
6913
+ * Deprecated endpoint. Use [planTrajectory](#/operations/planTrajectory) and [loadPlannedMotion](#/operations/loadPlannedMotion) instead. Plans a new motion for a single previously configured [motion group](#/operations/listMotionGroups). Motions are described by a sequence of motion commands starting with start joints. A motion is planned from standstill to standstill. A single motion has constant TCP and payload. Currently, I/O actions can\'t be attached to a motion to execute the action in realtime while a motion is executed. If an I/O is needed at a specific point, multiple motions need to be planned. If an I/O is needed to be set while a motion is executed, the endpoint [setOutputValues](#/operations/setOutputValues) could be used.
6914
6914
  * @summary Plan Motion
6915
6915
  * @param {string} cell Unique identifier addressing a cell in all API calls.
6916
6916
  * @param {PlanRequest} planRequest
@@ -6920,7 +6920,7 @@ declare const MotionApiFactory: (configuration?: Configuration, basePath?: strin
6920
6920
  */
6921
6921
  planMotion(cell: string, planRequest: PlanRequest, options?: RawAxiosRequestConfig): AxiosPromise<PlanResponse>;
6922
6922
  /**
6923
- * Plans a new trajectory for a single motion group. Describe the trajectory as a sequence of motion commands that the robots TCP should follow. Use the following workflow to execute a planned trajectory: 1. Plan a trajectory. 2. Validate and load the planned trajectory using the [loadPlannedMotion](loadPlannedMotion) endpoint. 3. Execute the loaded trajectory using the [streamMove](streamMove) endpoint. If the trajectory is not executable, the [PlanTrajectoryResponse](PlanTrajectoryResponse) will contain the joint trajectory up until the error, e.g. all samples until a collision occurs. EXCEPTION: If a CartesianPTP or JointPTP motion command has an invalid target, the response will contain the trajectory up until the start of the invalid PTP motion.
6923
+ * Plans a new trajectory for a single motion group. Describe the trajectory as a sequence of motion commands that the robots TCP should follow. Use the following workflow to execute a planned trajectory: 1. Plan a trajectory. 2. Validate and load the planned trajectory using the [loadPlannedMotion](#/operations/loadPlannedMotion) endpoint. 3. Execute the loaded trajectory using the [streamMove](#/operations/streamMove) endpoint. If the trajectory is not executable, the PlanTrajectoryFailedResponse will contain the joint trajectory up until the error (e.g. a collision) occurred. EXCEPTION: If a CartesianPTP or JointPTP motion command has an invalid target, the response will contain the trajectory up until the start of the invalid PTP motion.
6924
6924
  * @summary Plan Trajectory
6925
6925
  * @param {string} cell Unique identifier addressing a cell in all API calls.
6926
6926
  * @param {PlanTrajectoryRequest} [planTrajectoryRequest]
@@ -6948,7 +6948,7 @@ declare const MotionApiFactory: (configuration?: Configuration, basePath?: strin
6948
6948
  */
6949
6949
  streamMove(cell: string, streamMoveRequest: StreamMoveRequest, options?: RawAxiosRequestConfig): AxiosPromise<StreamMoveResponse>;
6950
6950
  /**
6951
- * Deprecated endpoint. Use the [executeTrajectory](executeTrajectory) endpoint instead. Request to move the motion group backward along a previously planned motion. Once started, you can stop a motion using the [stopExecution](stopExecution) endpoint. Prerequisites, before starting the motion execution: - The motion group is currently at the endpoint of the planned motion. OR - The motion was stopped using [stopExecution](stopExecution) endpoint. Then it is possible to resume the motion execution from where it stopped. OR - The motion group was moved onto the motion using the [streamMoveToTrajectoryViaJointP2P](streamMoveToTrajectoryViaJointP2P) endpoint.
6951
+ * Deprecated endpoint. Use the [executeTrajectory](#/operations/executeTrajectory) endpoint instead. Request to move the motion group backward along a previously planned motion. Once started, you can stop a motion using the [stopExecution](#/operations/stopExecution) endpoint. Prerequisites, before starting the motion execution: - The motion group is currently at the endpoint of the planned motion OR - The motion was stopped using [stopExecution](#/operations/stopExecution) endpoint. Then it is possible to resume the motion execution from where it stopped OR - The motion group was moved onto the motion using the [streamMoveToTrajectoryViaJointP2P](#/operations/streamMoveToTrajectoryViaJointP2P) endpoint.
6952
6952
  * @summary Stream Backward
6953
6953
  * @param {string} cell Unique identifier addressing a cell in all API calls.
6954
6954
  * @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.
@@ -6962,21 +6962,21 @@ declare const MotionApiFactory: (configuration?: Configuration, basePath?: strin
6962
6962
  */
6963
6963
  streamMoveBackward(cell: string, motion: string, playbackSpeedInPercent: number, responseRate?: number, responseCoordinateSystem?: string, startLocationOnTrajectory?: number, options?: RawAxiosRequestConfig): AxiosPromise<StreamMoveResponse>;
6964
6964
  /**
6965
- * Deprecated endpoint. Use the [executeTrajectory](executeTrajectory) endpoint instead. Moves the motion group forward along a previously planned motion. Once started, you can stop a motion using the [stopExecution](stopExecution) endpoint. Prerequisites, before starting the motion execution: - The motion group is currently at the start point of the planned motion. OR - The motion was stopped using [stopExecution](stopExecution) endpoint. Then it is possible to resume the motion execution from where it stopped. OR - The motion group was moved onto the motion using the [streamMoveToTrajectoryViaJointP2P](streamMoveToTrajectoryViaJointP2P) endpoint.
6965
+ * Deprecated endpoint. Use the [executeTrajectory](#/operations/executeTrajectory) endpoint instead. Move the motion group forward along a previously planned motion. Once started, you can stop a motion using the [stopExecution](#/operations/stopExecution) endpoint. Prerequisites, before starting the motion execution: - The motion group is currently at the start point of the planned motion OR - The motion was stopped using [stopExecution](#/operations/stopExecution) endpoint. Then it is possible to resume the motion execution from where it stopped OR - The motion group was moved onto the motion using the [streamMoveToTrajectoryViaJointP2P](#/operations/streamMoveToTrajectoryViaJointP2P) endpoint.
6966
6966
  * @summary Stream Forward
6967
6967
  * @param {string} cell Unique identifier addressing a cell in all API calls.
6968
6968
  * @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.
6969
6969
  * @param {number} playbackSpeedInPercent Set the velocity for executed movements of the motion in percent. A percentage of 100% means that the robot moves as fast as possible without violating the limits. Setting this value does not affect the overall shape of the velocity profile. Everything is slowed down by the same factor. Therefore, this should only be used for teaching and trajectory evaluation purposes. If the process requires a certain velocity, the respective limits should be set when planning the motion. This will not change the velocity override of the controller. The controller velocity override value shall be 100% to ensure controllability of the motion group.
6970
6970
  * @param {number} [responseRate] Update rate for the response message in milliseconds (ms). Default is 200 ms. We recommend to use the step rate of the controller or a multiple of the step rate as NOVA updates the state in the controller\&#39;s step rate as well. Minimal response rate is the step rate of controller.
6971
6971
  * @param {string} [responseCoordinateSystem] Unique identifier addressing a coordinate system to which the cartesian data of the responses should be converted. Default is the world coordinate system.
6972
- * @param {number} [startLocationOnTrajectory] Location the motion is requested to start at. The default value is the begin of the trajectory. The location is a scalar value that defines a position along a path, typically ranging from 0 to &#x60;n&#x60;, where &#x60;n&#x60; denotes the number of motion commands. Each integer value of the location corresponds to a specific motion command, while non-integer values interpolate positions within the segments. The location is calculated from the joint path.
6972
+ * @param {number} [startLocationOnTrajectory] Location the motion is requested to start at. The default value is the beginning of the trajectory. The location is a scalar value that defines a position along a path, typically ranging from 0 to &#x60;n&#x60;, where &#x60;n&#x60; denotes the number of motion commands. Each integer value of the location corresponds to a specific motion command, while non-integer values interpolate positions within the segments. The location is calculated from the joint path.
6973
6973
  * @param {*} [options] Override http request option.
6974
6974
  * @deprecated
6975
6975
  * @throws {RequiredError}
6976
6976
  */
6977
6977
  streamMoveForward(cell: string, motion: string, playbackSpeedInPercent: number, responseRate?: number, responseCoordinateSystem?: string, startLocationOnTrajectory?: number, options?: RawAxiosRequestConfig): AxiosPromise<StreamMoveResponse>;
6978
6978
  /**
6979
- * Request to move the motion group via joint point-to-point to a given location on a planned motion. You must use this endpoint in order to start moving from an arbritrary location of the trajectory. Afterwards, you are able to call [streamMoveForward](streamMoveForward) or [streamMoveBackward](streamMoveBackward) to move along planned motion. Use the [stopExecution](stopExecution) endpoint to stop the motion gracefully.
6979
+ * Request to move the motion group via joint point-to-point to a given location on a planned motion. You must use this endpoint in order to start moving from an arbritrary location of the trajectory. Afterwards, you are able to call [streamMoveForward](#/operations/streamMoveForward) or [streamMoveBackward](#/operations/streamMoveBackward) to move along planned motion. Use the [stopExecution](#/operations/stopExecution) endpoint to stop the motion gracefully.
6980
6980
  * @summary Stream to Trajectory
6981
6981
  * @param {string} cell Unique identifier addressing a cell in all API calls.
6982
6982
  * @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.
@@ -7004,27 +7004,27 @@ declare class MotionApi extends BaseAPI {
7004
7004
  * @param {*} [options] Override http request option.
7005
7005
  * @throws {RequiredError}
7006
7006
  */
7007
- deleteAllMotions(cell: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
7007
+ deleteAllMotions(cell: string, options?: RawAxiosRequestConfig): Promise<axios142.AxiosResponse<void, any>>;
7008
7008
  /**
7009
- * Remove a previously created motion from cache. Use [listMotions](listMotions) to list all available motions. Motions are removed automatically if the motion group or the corresponding controller is disconnected.
7009
+ * Remove a previously created motion from cache. Use [listMotions](#/operations/listMotions) to list all available motions. Motions are removed automatically if the motion group or the corresponding controller is disconnected.
7010
7010
  * @summary Remove
7011
7011
  * @param {string} cell Unique identifier addressing a cell in all API calls.
7012
7012
  * @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.
7013
7013
  * @param {*} [options] Override http request option.
7014
7014
  * @throws {RequiredError}
7015
7015
  */
7016
- deleteMotion(cell: string, motion: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
7016
+ deleteMotion(cell: string, motion: string, options?: RawAxiosRequestConfig): Promise<axios142.AxiosResponse<void, any>>;
7017
7017
  /**
7018
- * <!-- theme: danger --> > Websocket endpoint Provides execution control over a previously planned trajectory. Enables the caller to attach I/O actions to the trajectory. Understanding the 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 [planMotion](planMotion). 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. ### 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 reponse 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 reponse . - 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.
7018
+ * <!-- theme: danger --> > Websocket endpoint Provide execution control over a previously planned trajectory. Enable the caller to attach I/O actions to the trajectory. Understanding the 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 [planMotion](#/operations/planMotion). 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 is at the start location specified with InitializeMovementRequest. ### 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.
7019
7019
  * @summary Execute Trajectory
7020
7020
  * @param {string} cell Unique identifier addressing a cell in all API calls.
7021
7021
  * @param {ExecuteTrajectoryRequest} executeTrajectoryRequest
7022
7022
  * @param {*} [options] Override http request option.
7023
7023
  * @throws {RequiredError}
7024
7024
  */
7025
- executeTrajectory(cell: string, executeTrajectoryRequest: ExecuteTrajectoryRequest, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<ExecuteTrajectoryResponse, any>>;
7025
+ executeTrajectory(cell: string, executeTrajectoryRequest: ExecuteTrajectoryRequest, options?: RawAxiosRequestConfig): Promise<axios142.AxiosResponse<ExecuteTrajectoryResponse, any>>;
7026
7026
  /**
7027
- * Get the trajectory of a planned motion with defined `sample_time` in milliseconds (ms). The trajectory is a list of points containing cartesian and joint data. The cartesian data is in the requested coordinate system. To get a single point of the trajectory, please use the [getMotionTrajectorySample](getMotionTrajectorySample) endpoint.
7027
+ * Get the trajectory of a planned motion with defined `sample_time` in milliseconds (ms). The trajectory is a list of points containing cartesian and joint data. The cartesian data is in the requested coordinate system. To get a single point of the trajectory, please use the [getMotionTrajectorySample](#/operations/getMotionTrajectorySample) endpoint.
7028
7028
  * @summary Get Trajectory
7029
7029
  * @param {string} cell Unique identifier addressing a cell in all API calls.
7030
7030
  * @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.
@@ -7033,20 +7033,20 @@ declare class MotionApi extends BaseAPI {
7033
7033
  * @param {*} [options] Override http request option.
7034
7034
  * @throws {RequiredError}
7035
7035
  */
7036
- getMotionTrajectory(cell: string, motion: string, sampleTime: number, responsesCoordinateSystem?: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<GetTrajectoryResponse, any>>;
7036
+ getMotionTrajectory(cell: string, motion: string, sampleTime: number, responsesCoordinateSystem?: string, options?: RawAxiosRequestConfig): Promise<axios142.AxiosResponse<GetTrajectoryResponse, any>>;
7037
7037
  /**
7038
- * Get a single point at a certain location of a planned motion. To get the whole trajectory, use the [getMotionTrajectory](getMotionTrajectory) endpoint.
7038
+ * Get a single point at a certain location of a planned motion. To get the whole trajectory, use the [getMotionTrajectory](#/operations/getMotionTrajectory) endpoint.
7039
7039
  * @summary Get Trajectory Sample
7040
7040
  * @param {string} cell Unique identifier addressing a cell in all API calls.
7041
7041
  * @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.
7042
7042
  * @param {number} [locationOnTrajectory]
7043
- * @param {string} [responseCoordinateSystem] Unique identifier addressing a coordinate system in which the cartesian data of the response should be converted to. Default is the world coordinate system.
7043
+ * @param {string} [responseCoordinateSystem] Unique identifier addressing a coordinate system for which the cartesian data of the response should be converted to. Default is the world coordinate system.
7044
7044
  * @param {*} [options] Override http request option.
7045
7045
  * @throws {RequiredError}
7046
7046
  */
7047
- getMotionTrajectorySample(cell: string, motion: string, locationOnTrajectory?: number, responseCoordinateSystem?: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<GetTrajectorySampleResponse, any>>;
7047
+ getMotionTrajectorySample(cell: string, motion: string, locationOnTrajectory?: number, responseCoordinateSystem?: string, options?: RawAxiosRequestConfig): Promise<axios142.AxiosResponse<GetTrajectorySampleResponse, any>>;
7048
7048
  /**
7049
- * Get the joint data of a planned motion. The planned motion contains only the joint information, to persistently store and reload it later. The data will be sampled equidistantly with defined `sample_time` in milliseconds (ms). If not provided, the data is returned as it is stored on Wandelbots NOVA system. To request cartesian data for visualization purposes, use the [getMotionTrajectory](getMotionTrajectory) endpoint. To get a single point of the planned motion, use the [getMotionTrajectorySample](getMotionTrajectorySample) endpoint.
7049
+ * Get the joint data of a planned motion. The planned motion contains only the joint information, to persistently store and reload it later. The data will be sampled equidistantly with defined `sample_time` in milliseconds (ms). If not provided, the data is returned as it is stored on Wandelbots NOVA system. To request cartesian data for visualization purposes, use the [getMotionTrajectory](#/operations/getMotionTrajectory) endpoint. To get a single point of the planned motion, use the [getMotionTrajectorySample](#/operations/getMotionTrajectorySample) endpoint.
7050
7050
  * @summary Get Planned Motion
7051
7051
  * @param {string} cell Unique identifier addressing a cell in all API calls.
7052
7052
  * @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.
@@ -7054,7 +7054,7 @@ declare class MotionApi extends BaseAPI {
7054
7054
  * @param {*} [options] Override http request option.
7055
7055
  * @throws {RequiredError}
7056
7056
  */
7057
- getPlannedMotion(cell: string, motion: string, sampleTime?: number, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<PlannedMotion, any>>;
7057
+ getPlannedMotion(cell: string, motion: string, sampleTime?: number, options?: RawAxiosRequestConfig): Promise<axios142.AxiosResponse<PlannedMotion, any>>;
7058
7058
  /**
7059
7059
  * Returns motion group models that are supported for planning.
7060
7060
  * @summary Motion Group Models for Planning
@@ -7062,35 +7062,35 @@ declare class MotionApi extends BaseAPI {
7062
7062
  * @param {*} [options] Override http request option.
7063
7063
  * @throws {RequiredError}
7064
7064
  */
7065
- getPlanningMotionGroupModels(cell: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<string[], any>>;
7065
+ getPlanningMotionGroupModels(cell: string, options?: RawAxiosRequestConfig): Promise<axios142.AxiosResponse<string[], any>>;
7066
7066
  /**
7067
- * List all currently planned and available motions. Use [planMotion](planMotion) to plan a new motion. Motions are removed if the corresponding motion group or controller disconnects.
7067
+ * List all currently planned and available motions. Use [planMotion](#/operations/planMotion) to plan a new motion. Motions are removed if the corresponding motion group or controller disconnects.
7068
7068
  * @summary List All Motions
7069
7069
  * @param {string} cell Unique identifier addressing a cell in all API calls.
7070
7070
  * @param {*} [options] Override http request option.
7071
7071
  * @throws {RequiredError}
7072
7072
  */
7073
- listMotions(cell: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<MotionIdsListResponse, any>>;
7073
+ listMotions(cell: string, options?: RawAxiosRequestConfig): Promise<axios142.AxiosResponse<MotionIdsListResponse, any>>;
7074
7074
  /**
7075
- * Loads and validates the data of a planned motion into a motion session. The response contains information about the validated motion. Validation can lead to three different results: - Fully valid: The whole planned motion can be executed from start to end. The response will contain the session to move the robot. - Partially valid: Only parts of the planned motion can be executed. The response will contain the session to move the robot and information about the failure for the part that is not executable. - Invalid: The planned motion can not be executed. The response will tell you, which information about the reason of failure. If the motion is at least partially valid, the parts of the motion that are valid can be executed using the [streamMoveForward](streamMoveForward) endpoint. You can use the following workflows: - Plan motions using the [planMotion](planMotion) endpoint, - Store the planned motion persistently, - Use this endpoint to reload the stored motion and get a motion session for it. - Execute the loaded motion using the [streamMoveForward](streamMoveForward) endpoint. OR: - Generate a planned motion with [planTrajectory](planTrajectory) or your own motion planner, - Send the planned motion to this endpoint to validate it and get a motion session for it, - Execute your motion using the [streamMoveForward](streamMoveForward) endpoint. Once a planned motion is validated, it is treated like a motion session and will appear in the list of available motions, see [listMotions](listMotions) endpoint. You can then execute a motion session with the [streamMoveForward](streamMoveForward) endpoint.
7075
+ * Loads and validates the data of a planned motion into a motion session. The response contains information about the validated motion. Validation can lead to three different results: - Fully valid: The whole planned motion can be executed from start to end. The response will contain the session to move the robot. - Partially valid: Only parts of the planned motion can be executed. The response will contain the session to move the robot and information about the failure for the part that is not executable. - Invalid: The planned motion can not be executed. The response will tell you, which information about the reason of failure. If the motion is at least partially valid, the parts of the motion that are valid can be executed using the [streamMoveForward](#/operations/streamMoveForward) endpoint. You can use the following workflows: - Plan motions using the [planMotion](#/operations/planMotion) endpoint, - Store the planned motion persistently, - Use this endpoint to reload the stored motion and get a motion session for it. - Execute the loaded motion using the [streamMoveForward](#/operations/streamMoveForward) endpoint. OR: - Generate a planned motion with [planTrajectory](#/operations/planTrajectory) or your own motion planner, - Send the planned motion to this endpoint to validate it and get a motion session for it, - Execute your motion using the [streamMoveForward](#/operations/streamMoveForward) endpoint. Once a planned motion is validated, it is treated like a motion session and will appear in the list of available motions, see [listMotions](#/operations/listMotions) endpoint. You can then execute a motion session with the [streamMoveForward](#/operations/streamMoveForward) endpoint.
7076
7076
  * @summary Load Planned Motion
7077
7077
  * @param {string} cell Unique identifier addressing a cell in all API calls.
7078
7078
  * @param {PlannedMotion} plannedMotion
7079
7079
  * @param {*} [options] Override http request option.
7080
7080
  * @throws {RequiredError}
7081
7081
  */
7082
- loadPlannedMotion(cell: string, plannedMotion: PlannedMotion, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<PlanResponse, any>>;
7082
+ loadPlannedMotion(cell: string, plannedMotion: PlannedMotion, options?: RawAxiosRequestConfig): Promise<axios142.AxiosResponse<PlanResponse, any>>;
7083
7083
  /**
7084
- * <!-- theme: danger --> > **Experimental** Plans a collision-free PTP motion for a single motion group. Use the following workflow to execute a planned trajectory: 1. Plan collision-free movement/motion. 2. Validate and load the planned trajectory using the [loadPlannedMotion](loadPlannedMotion) endpoint. 3. Execute the loaded trajectory using the [streamMove](streamMove) endpoint.
7084
+ * <!-- theme: danger --> > **Experimental** Plans a collision-free PTP motion for a single motion group. Use the following workflow to execute a planned trajectory: 1. Plan a collision-free movement/motion. 2. Validate and load the planned trajectory using the [loadPlannedMotion](#/operations/loadPlannedMotion) endpoint. 3. Execute the loaded trajectory using the [streamMove](#/operations/streamMove) endpoint.
7085
7085
  * @summary Plan Collision Free PTP
7086
7086
  * @param {string} cell Unique identifier addressing a cell in all API calls.
7087
7087
  * @param {PlanCollisionFreePTPRequest} [planCollisionFreePTPRequest]
7088
7088
  * @param {*} [options] Override http request option.
7089
7089
  * @throws {RequiredError}
7090
7090
  */
7091
- planCollisionFreePTP(cell: string, planCollisionFreePTPRequest?: PlanCollisionFreePTPRequest, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<PlanTrajectoryResponse, any>>;
7091
+ planCollisionFreePTP(cell: string, planCollisionFreePTPRequest?: PlanCollisionFreePTPRequest, options?: RawAxiosRequestConfig): Promise<axios142.AxiosResponse<PlanTrajectoryResponse, any>>;
7092
7092
  /**
7093
- * Deprecated endpoint. Use [planTrajectory](planTrajectory) and [loadPlannedMotion](loadPlannedMotion) instead. Plans a new motion for a single previously configured [motion group](listMotionGroups). Motions are described by a sequence of motion commands starting with start joints. A motion is planned from standstill to standstill. A single motion has constant TCP and payload. Currently, I/O actions can\'t be attached to a motion to execute the action in realtime while a motion is executed. If an I/O is needed at a specific point, multiple motions need to be planned. If an I/O is needed to be set while a motion is executed, the endpoint [setOutputValues](setOutputValues) could be used.
7093
+ * Deprecated endpoint. Use [planTrajectory](#/operations/planTrajectory) and [loadPlannedMotion](#/operations/loadPlannedMotion) instead. Plans a new motion for a single previously configured [motion group](#/operations/listMotionGroups). Motions are described by a sequence of motion commands starting with start joints. A motion is planned from standstill to standstill. A single motion has constant TCP and payload. Currently, I/O actions can\'t be attached to a motion to execute the action in realtime while a motion is executed. If an I/O is needed at a specific point, multiple motions need to be planned. If an I/O is needed to be set while a motion is executed, the endpoint [setOutputValues](#/operations/setOutputValues) could be used.
7094
7094
  * @summary Plan Motion
7095
7095
  * @param {string} cell Unique identifier addressing a cell in all API calls.
7096
7096
  * @param {PlanRequest} planRequest
@@ -7098,16 +7098,16 @@ declare class MotionApi extends BaseAPI {
7098
7098
  * @deprecated
7099
7099
  * @throws {RequiredError}
7100
7100
  */
7101
- planMotion(cell: string, planRequest: PlanRequest, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<PlanResponse, any>>;
7101
+ planMotion(cell: string, planRequest: PlanRequest, options?: RawAxiosRequestConfig): Promise<axios142.AxiosResponse<PlanResponse, any>>;
7102
7102
  /**
7103
- * Plans a new trajectory for a single motion group. Describe the trajectory as a sequence of motion commands that the robots TCP should follow. Use the following workflow to execute a planned trajectory: 1. Plan a trajectory. 2. Validate and load the planned trajectory using the [loadPlannedMotion](loadPlannedMotion) endpoint. 3. Execute the loaded trajectory using the [streamMove](streamMove) endpoint. If the trajectory is not executable, the [PlanTrajectoryResponse](PlanTrajectoryResponse) will contain the joint trajectory up until the error, e.g. all samples until a collision occurs. EXCEPTION: If a CartesianPTP or JointPTP motion command has an invalid target, the response will contain the trajectory up until the start of the invalid PTP motion.
7103
+ * Plans a new trajectory for a single motion group. Describe the trajectory as a sequence of motion commands that the robots TCP should follow. Use the following workflow to execute a planned trajectory: 1. Plan a trajectory. 2. Validate and load the planned trajectory using the [loadPlannedMotion](#/operations/loadPlannedMotion) endpoint. 3. Execute the loaded trajectory using the [streamMove](#/operations/streamMove) endpoint. If the trajectory is not executable, the PlanTrajectoryFailedResponse will contain the joint trajectory up until the error (e.g. a collision) occurred. EXCEPTION: If a CartesianPTP or JointPTP motion command has an invalid target, the response will contain the trajectory up until the start of the invalid PTP motion.
7104
7104
  * @summary Plan Trajectory
7105
7105
  * @param {string} cell Unique identifier addressing a cell in all API calls.
7106
7106
  * @param {PlanTrajectoryRequest} [planTrajectoryRequest]
7107
7107
  * @param {*} [options] Override http request option.
7108
7108
  * @throws {RequiredError}
7109
7109
  */
7110
- planTrajectory(cell: string, planTrajectoryRequest?: PlanTrajectoryRequest, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<PlanTrajectoryResponse, any>>;
7110
+ planTrajectory(cell: string, planTrajectoryRequest?: PlanTrajectoryRequest, options?: RawAxiosRequestConfig): Promise<axios142.AxiosResponse<PlanTrajectoryResponse, any>>;
7111
7111
  /**
7112
7112
  * 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.
7113
7113
  * @summary Stop
@@ -7116,7 +7116,7 @@ declare class MotionApi extends BaseAPI {
7116
7116
  * @param {*} [options] Override http request option.
7117
7117
  * @throws {RequiredError}
7118
7118
  */
7119
- stopExecution(cell: string, motion: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
7119
+ stopExecution(cell: string, motion: string, options?: RawAxiosRequestConfig): Promise<axios142.AxiosResponse<void, any>>;
7120
7120
  /**
7121
7121
  * Deprecated endpoint. Use `executeTrajectory` instead. Moves the motion group forward or backward along a previously planned motion. Or request to move the motion group via joint point-to-point to a given location on a planned motion. Or set the playback speed of the motion. Or stop the motion execution.
7122
7122
  * @summary Stream Move
@@ -7126,9 +7126,9 @@ declare class MotionApi extends BaseAPI {
7126
7126
  * @deprecated
7127
7127
  * @throws {RequiredError}
7128
7128
  */
7129
- streamMove(cell: string, streamMoveRequest: StreamMoveRequest, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<StreamMoveResponse, any>>;
7129
+ streamMove(cell: string, streamMoveRequest: StreamMoveRequest, options?: RawAxiosRequestConfig): Promise<axios142.AxiosResponse<StreamMoveResponse, any>>;
7130
7130
  /**
7131
- * Deprecated endpoint. Use the [executeTrajectory](executeTrajectory) endpoint instead. Request to move the motion group backward along a previously planned motion. Once started, you can stop a motion using the [stopExecution](stopExecution) endpoint. Prerequisites, before starting the motion execution: - The motion group is currently at the endpoint of the planned motion. OR - The motion was stopped using [stopExecution](stopExecution) endpoint. Then it is possible to resume the motion execution from where it stopped. OR - The motion group was moved onto the motion using the [streamMoveToTrajectoryViaJointP2P](streamMoveToTrajectoryViaJointP2P) endpoint.
7131
+ * Deprecated endpoint. Use the [executeTrajectory](#/operations/executeTrajectory) endpoint instead. Request to move the motion group backward along a previously planned motion. Once started, you can stop a motion using the [stopExecution](#/operations/stopExecution) endpoint. Prerequisites, before starting the motion execution: - The motion group is currently at the endpoint of the planned motion OR - The motion was stopped using [stopExecution](#/operations/stopExecution) endpoint. Then it is possible to resume the motion execution from where it stopped OR - The motion group was moved onto the motion using the [streamMoveToTrajectoryViaJointP2P](#/operations/streamMoveToTrajectoryViaJointP2P) endpoint.
7132
7132
  * @summary Stream Backward
7133
7133
  * @param {string} cell Unique identifier addressing a cell in all API calls.
7134
7134
  * @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.
@@ -7140,23 +7140,23 @@ declare class MotionApi extends BaseAPI {
7140
7140
  * @deprecated
7141
7141
  * @throws {RequiredError}
7142
7142
  */
7143
- streamMoveBackward(cell: string, motion: string, playbackSpeedInPercent: number, responseRate?: number, responseCoordinateSystem?: string, startLocationOnTrajectory?: number, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<StreamMoveResponse, any>>;
7143
+ streamMoveBackward(cell: string, motion: string, playbackSpeedInPercent: number, responseRate?: number, responseCoordinateSystem?: string, startLocationOnTrajectory?: number, options?: RawAxiosRequestConfig): Promise<axios142.AxiosResponse<StreamMoveResponse, any>>;
7144
7144
  /**
7145
- * Deprecated endpoint. Use the [executeTrajectory](executeTrajectory) endpoint instead. Moves the motion group forward along a previously planned motion. Once started, you can stop a motion using the [stopExecution](stopExecution) endpoint. Prerequisites, before starting the motion execution: - The motion group is currently at the start point of the planned motion. OR - The motion was stopped using [stopExecution](stopExecution) endpoint. Then it is possible to resume the motion execution from where it stopped. OR - The motion group was moved onto the motion using the [streamMoveToTrajectoryViaJointP2P](streamMoveToTrajectoryViaJointP2P) endpoint.
7145
+ * Deprecated endpoint. Use the [executeTrajectory](#/operations/executeTrajectory) endpoint instead. Move the motion group forward along a previously planned motion. Once started, you can stop a motion using the [stopExecution](#/operations/stopExecution) endpoint. Prerequisites, before starting the motion execution: - The motion group is currently at the start point of the planned motion OR - The motion was stopped using [stopExecution](#/operations/stopExecution) endpoint. Then it is possible to resume the motion execution from where it stopped OR - The motion group was moved onto the motion using the [streamMoveToTrajectoryViaJointP2P](#/operations/streamMoveToTrajectoryViaJointP2P) endpoint.
7146
7146
  * @summary Stream Forward
7147
7147
  * @param {string} cell Unique identifier addressing a cell in all API calls.
7148
7148
  * @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.
7149
7149
  * @param {number} playbackSpeedInPercent Set the velocity for executed movements of the motion in percent. A percentage of 100% means that the robot moves as fast as possible without violating the limits. Setting this value does not affect the overall shape of the velocity profile. Everything is slowed down by the same factor. Therefore, this should only be used for teaching and trajectory evaluation purposes. If the process requires a certain velocity, the respective limits should be set when planning the motion. This will not change the velocity override of the controller. The controller velocity override value shall be 100% to ensure controllability of the motion group.
7150
7150
  * @param {number} [responseRate] Update rate for the response message in milliseconds (ms). Default is 200 ms. We recommend to use the step rate of the controller or a multiple of the step rate as NOVA updates the state in the controller\&#39;s step rate as well. Minimal response rate is the step rate of controller.
7151
7151
  * @param {string} [responseCoordinateSystem] Unique identifier addressing a coordinate system to which the cartesian data of the responses should be converted. Default is the world coordinate system.
7152
- * @param {number} [startLocationOnTrajectory] Location the motion is requested to start at. The default value is the begin of the trajectory. The location is a scalar value that defines a position along a path, typically ranging from 0 to &#x60;n&#x60;, where &#x60;n&#x60; denotes the number of motion commands. Each integer value of the location corresponds to a specific motion command, while non-integer values interpolate positions within the segments. The location is calculated from the joint path.
7152
+ * @param {number} [startLocationOnTrajectory] Location the motion is requested to start at. The default value is the beginning of the trajectory. The location is a scalar value that defines a position along a path, typically ranging from 0 to &#x60;n&#x60;, where &#x60;n&#x60; denotes the number of motion commands. Each integer value of the location corresponds to a specific motion command, while non-integer values interpolate positions within the segments. The location is calculated from the joint path.
7153
7153
  * @param {*} [options] Override http request option.
7154
7154
  * @deprecated
7155
7155
  * @throws {RequiredError}
7156
7156
  */
7157
- streamMoveForward(cell: string, motion: string, playbackSpeedInPercent: number, responseRate?: number, responseCoordinateSystem?: string, startLocationOnTrajectory?: number, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<StreamMoveResponse, any>>;
7157
+ streamMoveForward(cell: string, motion: string, playbackSpeedInPercent: number, responseRate?: number, responseCoordinateSystem?: string, startLocationOnTrajectory?: number, options?: RawAxiosRequestConfig): Promise<axios142.AxiosResponse<StreamMoveResponse, any>>;
7158
7158
  /**
7159
- * Request to move the motion group via joint point-to-point to a given location on a planned motion. You must use this endpoint in order to start moving from an arbritrary location of the trajectory. Afterwards, you are able to call [streamMoveForward](streamMoveForward) or [streamMoveBackward](streamMoveBackward) to move along planned motion. Use the [stopExecution](stopExecution) endpoint to stop the motion gracefully.
7159
+ * Request to move the motion group via joint point-to-point to a given location on a planned motion. You must use this endpoint in order to start moving from an arbritrary location of the trajectory. Afterwards, you are able to call [streamMoveForward](#/operations/streamMoveForward) or [streamMoveBackward](#/operations/streamMoveBackward) to move along planned motion. Use the [stopExecution](#/operations/stopExecution) endpoint to stop the motion gracefully.
7160
7160
  * @summary Stream to Trajectory
7161
7161
  * @param {string} cell Unique identifier addressing a cell in all API calls.
7162
7162
  * @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.
@@ -7171,14 +7171,14 @@ declare class MotionApi extends BaseAPI {
7171
7171
  * @param {*} [options] Override http request option.
7172
7172
  * @throws {RequiredError}
7173
7173
  */
7174
- streamMoveToTrajectoryViaJointPTP(cell: string, motion: string, locationOnTrajectory: number, limitOverrideJointVelocityLimitsJoints?: Array<number>, limitOverrideJointAccelerationLimitsJoints?: Array<number>, limitOverrideTcpVelocityLimit?: number, limitOverrideTcpAccelerationLimit?: number, limitOverrideTcpOrientationVelocityLimit?: number, limitOverrideTcpOrientationAccelerationLimit?: number, responsesCoordinateSystem?: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<StreamMoveResponse, any>>;
7174
+ streamMoveToTrajectoryViaJointPTP(cell: string, motion: string, locationOnTrajectory: number, limitOverrideJointVelocityLimitsJoints?: Array<number>, limitOverrideJointAccelerationLimitsJoints?: Array<number>, limitOverrideTcpVelocityLimit?: number, limitOverrideTcpAccelerationLimit?: number, limitOverrideTcpOrientationVelocityLimit?: number, limitOverrideTcpOrientationAccelerationLimit?: number, responsesCoordinateSystem?: string, options?: RawAxiosRequestConfig): Promise<axios142.AxiosResponse<StreamMoveResponse, any>>;
7175
7175
  }
7176
7176
  /**
7177
7177
  * MotionGroupApi - axios parameter creator
7178
7178
  */
7179
7179
  declare const MotionGroupApiAxiosParamCreator: (configuration?: Configuration) => {
7180
7180
  /**
7181
- * Activate the motion group and keeps the motion group in an active status. To activate all motion groups of a robot controller, use this endpoint. It will return all activated motion groups of that controller. When activating motion groups, it is not possible to interact with the controller in any other way. To deactivate a motion group, use [deactivateMotionGroup](deactivateMotionGroup).
7181
+ * Activate the motion group and keep the motion group in an active status. To activate all motion groups of a robot controller, use this endpoint. It will return all activated motion groups of that controller. When activating motion groups, it is not possible to interact with the controller in any other way. To deactivate a motion group, use [deactivateMotionGroup](#/operations/deactivateMotionGroup).
7182
7182
  * @summary Activate All
7183
7183
  * @param {string} cell Unique identifier addressing a cell in all API calls.
7184
7184
  * @param {string} controller
@@ -7187,7 +7187,7 @@ declare const MotionGroupApiAxiosParamCreator: (configuration?: Configuration) =
7187
7187
  */
7188
7188
  activateAllMotionGroups: (cell: string, controller: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
7189
7189
  /**
7190
- * Activate the motion group and keeps the motion group in an active status. To manually activate a motion group, use this endpoint. When activating a motion group, interacting with the controller in other ways is not possible. To deactivate a motion group, use [deactivateMotionGroup](deactivateMotionGroup).
7190
+ * Activate the motion group and keep the motion group in an active status. To manually activate a motion group, use this endpoint. When activating a motion group, interacting with the controller in other ways is not possible. To deactivate a motion group, use [deactivateMotionGroup](#/operations/deactivateMotionGroup).
7191
7191
  * @summary Activate
7192
7192
  * @param {string} cell Unique identifier addressing a cell in all API calls.
7193
7193
  * @param {string} motionGroup
@@ -7218,7 +7218,7 @@ declare const MotionGroupApiAxiosParamCreator: (configuration?: Configuration) =
7218
7218
  */
7219
7219
  declare const MotionGroupApiFp: (configuration?: Configuration) => {
7220
7220
  /**
7221
- * Activate the motion group and keeps the motion group in an active status. To activate all motion groups of a robot controller, use this endpoint. It will return all activated motion groups of that controller. When activating motion groups, it is not possible to interact with the controller in any other way. To deactivate a motion group, use [deactivateMotionGroup](deactivateMotionGroup).
7221
+ * Activate the motion group and keep the motion group in an active status. To activate all motion groups of a robot controller, use this endpoint. It will return all activated motion groups of that controller. When activating motion groups, it is not possible to interact with the controller in any other way. To deactivate a motion group, use [deactivateMotionGroup](#/operations/deactivateMotionGroup).
7222
7222
  * @summary Activate All
7223
7223
  * @param {string} cell Unique identifier addressing a cell in all API calls.
7224
7224
  * @param {string} controller
@@ -7227,7 +7227,7 @@ declare const MotionGroupApiFp: (configuration?: Configuration) => {
7227
7227
  */
7228
7228
  activateAllMotionGroups(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<MotionGroupInstanceList>>;
7229
7229
  /**
7230
- * Activate the motion group and keeps the motion group in an active status. To manually activate a motion group, use this endpoint. When activating a motion group, interacting with the controller in other ways is not possible. To deactivate a motion group, use [deactivateMotionGroup](deactivateMotionGroup).
7230
+ * Activate the motion group and keep the motion group in an active status. To manually activate a motion group, use this endpoint. When activating a motion group, interacting with the controller in other ways is not possible. To deactivate a motion group, use [deactivateMotionGroup](#/operations/deactivateMotionGroup).
7231
7231
  * @summary Activate
7232
7232
  * @param {string} cell Unique identifier addressing a cell in all API calls.
7233
7233
  * @param {string} motionGroup
@@ -7258,7 +7258,7 @@ declare const MotionGroupApiFp: (configuration?: Configuration) => {
7258
7258
  */
7259
7259
  declare const MotionGroupApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
7260
7260
  /**
7261
- * Activate the motion group and keeps the motion group in an active status. To activate all motion groups of a robot controller, use this endpoint. It will return all activated motion groups of that controller. When activating motion groups, it is not possible to interact with the controller in any other way. To deactivate a motion group, use [deactivateMotionGroup](deactivateMotionGroup).
7261
+ * Activate the motion group and keep the motion group in an active status. To activate all motion groups of a robot controller, use this endpoint. It will return all activated motion groups of that controller. When activating motion groups, it is not possible to interact with the controller in any other way. To deactivate a motion group, use [deactivateMotionGroup](#/operations/deactivateMotionGroup).
7262
7262
  * @summary Activate All
7263
7263
  * @param {string} cell Unique identifier addressing a cell in all API calls.
7264
7264
  * @param {string} controller
@@ -7267,7 +7267,7 @@ declare const MotionGroupApiFactory: (configuration?: Configuration, basePath?:
7267
7267
  */
7268
7268
  activateAllMotionGroups(cell: string, controller: string, options?: RawAxiosRequestConfig): AxiosPromise<MotionGroupInstanceList>;
7269
7269
  /**
7270
- * Activate the motion group and keeps the motion group in an active status. To manually activate a motion group, use this endpoint. When activating a motion group, interacting with the controller in other ways is not possible. To deactivate a motion group, use [deactivateMotionGroup](deactivateMotionGroup).
7270
+ * Activate the motion group and keep the motion group in an active status. To manually activate a motion group, use this endpoint. When activating a motion group, interacting with the controller in other ways is not possible. To deactivate a motion group, use [deactivateMotionGroup](#/operations/deactivateMotionGroup).
7271
7271
  * @summary Activate
7272
7272
  * @param {string} cell Unique identifier addressing a cell in all API calls.
7273
7273
  * @param {string} motionGroup
@@ -7298,23 +7298,23 @@ declare const MotionGroupApiFactory: (configuration?: Configuration, basePath?:
7298
7298
  */
7299
7299
  declare class MotionGroupApi extends BaseAPI {
7300
7300
  /**
7301
- * Activate the motion group and keeps the motion group in an active status. To activate all motion groups of a robot controller, use this endpoint. It will return all activated motion groups of that controller. When activating motion groups, it is not possible to interact with the controller in any other way. To deactivate a motion group, use [deactivateMotionGroup](deactivateMotionGroup).
7301
+ * Activate the motion group and keep the motion group in an active status. To activate all motion groups of a robot controller, use this endpoint. It will return all activated motion groups of that controller. When activating motion groups, it is not possible to interact with the controller in any other way. To deactivate a motion group, use [deactivateMotionGroup](#/operations/deactivateMotionGroup).
7302
7302
  * @summary Activate All
7303
7303
  * @param {string} cell Unique identifier addressing a cell in all API calls.
7304
7304
  * @param {string} controller
7305
7305
  * @param {*} [options] Override http request option.
7306
7306
  * @throws {RequiredError}
7307
7307
  */
7308
- activateAllMotionGroups(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<MotionGroupInstanceList, any>>;
7308
+ activateAllMotionGroups(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<axios142.AxiosResponse<MotionGroupInstanceList, any>>;
7309
7309
  /**
7310
- * Activate the motion group and keeps the motion group in an active status. To manually activate a motion group, use this endpoint. When activating a motion group, interacting with the controller in other ways is not possible. To deactivate a motion group, use [deactivateMotionGroup](deactivateMotionGroup).
7310
+ * Activate the motion group and keep the motion group in an active status. To manually activate a motion group, use this endpoint. When activating a motion group, interacting with the controller in other ways is not possible. To deactivate a motion group, use [deactivateMotionGroup](#/operations/deactivateMotionGroup).
7311
7311
  * @summary Activate
7312
7312
  * @param {string} cell Unique identifier addressing a cell in all API calls.
7313
7313
  * @param {string} motionGroup
7314
7314
  * @param {*} [options] Override http request option.
7315
7315
  * @throws {RequiredError}
7316
7316
  */
7317
- activateMotionGroup(cell: string, motionGroup: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<MotionGroupInstance, any>>;
7317
+ activateMotionGroup(cell: string, motionGroup: string, options?: RawAxiosRequestConfig): Promise<axios142.AxiosResponse<MotionGroupInstance, any>>;
7318
7318
  /**
7319
7319
  * Deactivate a motion group. Activate the motion group and keeps the motion group in an active status. The robot controller streams information about all active motion groups. Deactivate motion groups that you no longer use. When deactivating motion groups, it is not possible to interact with the controller in any other way.
7320
7320
  * @summary Deactivate
@@ -7323,7 +7323,7 @@ declare class MotionGroupApi extends BaseAPI {
7323
7323
  * @param {*} [options] Override http request option.
7324
7324
  * @throws {RequiredError}
7325
7325
  */
7326
- deactivateMotionGroup(cell: string, motionGroup: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
7326
+ deactivateMotionGroup(cell: string, motionGroup: string, options?: RawAxiosRequestConfig): Promise<axios142.AxiosResponse<void, any>>;
7327
7327
  /**
7328
7328
  * List all active motion groups. A motion group is active if it is currently used by a controller.
7329
7329
  * @summary List Active
@@ -7331,7 +7331,7 @@ declare class MotionGroupApi extends BaseAPI {
7331
7331
  * @param {*} [options] Override http request option.
7332
7332
  * @throws {RequiredError}
7333
7333
  */
7334
- listMotionGroups(cell: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<MotionGroupInstanceList, any>>;
7334
+ listMotionGroups(cell: string, options?: RawAxiosRequestConfig): Promise<axios142.AxiosResponse<MotionGroupInstanceList, any>>;
7335
7335
  }
7336
7336
  /**
7337
7337
  * MotionGroupInfosApi - axios parameter creator
@@ -7681,7 +7681,7 @@ declare class MotionGroupInfosApi extends BaseAPI {
7681
7681
  * @param {*} [options] Override http request option.
7682
7682
  * @throws {RequiredError}
7683
7683
  */
7684
- getActivePayload(cell: string, motionGroup: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<Payload, any>>;
7684
+ getActivePayload(cell: string, motionGroup: string, options?: RawAxiosRequestConfig): Promise<axios142.AxiosResponse<Payload, any>>;
7685
7685
  /**
7686
7686
  * Get the internal selected TCP of a connected device.
7687
7687
  * @summary Selected TCP
@@ -7691,7 +7691,7 @@ declare class MotionGroupInfosApi extends BaseAPI {
7691
7691
  * @param {*} [options] Override http request option.
7692
7692
  * @throws {RequiredError}
7693
7693
  */
7694
- getActiveTcp(cell: string, motionGroup: string, rotationType?: RotationAngleTypes, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<RobotTcp, any>>;
7694
+ getActiveTcp(cell: string, motionGroup: string, rotationType?: RotationAngleTypes, options?: RawAxiosRequestConfig): Promise<axios142.AxiosResponse<RobotTcp, any>>;
7695
7695
  /**
7696
7696
  * Returns the current state of the selected motion group including the current joint position, velocity, pose, and more.
7697
7697
  * @summary State of Device
@@ -7702,7 +7702,7 @@ declare class MotionGroupInfosApi extends BaseAPI {
7702
7702
  * @param {*} [options] Override http request option.
7703
7703
  * @throws {RequiredError}
7704
7704
  */
7705
- getCurrentMotionGroupState(cell: string, motionGroup: string, tcp?: string, responseCoordinateSystem?: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<MotionGroupStateResponse, any>>;
7705
+ getCurrentMotionGroupState(cell: string, motionGroup: string, tcp?: string, responseCoordinateSystem?: string, options?: RawAxiosRequestConfig): Promise<axios142.AxiosResponse<MotionGroupStateResponse, any>>;
7706
7706
  /**
7707
7707
  * Shows the options the motion group offers in regard to the information service. Some motion groups may not provide all information services, e.g. some manufacturers don\'t have a blending zone concept.
7708
7708
  * @summary Capabilities
@@ -7711,7 +7711,7 @@ declare class MotionGroupInfosApi extends BaseAPI {
7711
7711
  * @param {*} [options] Override http request option.
7712
7712
  * @throws {RequiredError}
7713
7713
  */
7714
- getInfoCapabilities(cell: string, motionGroup: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<InfoServiceCapabilities, any>>;
7714
+ getInfoCapabilities(cell: string, motionGroup: string, options?: RawAxiosRequestConfig): Promise<axios142.AxiosResponse<InfoServiceCapabilities, any>>;
7715
7715
  /**
7716
7716
  * Get static properties of the motion group. Those properties are used internally for motion group plannning. Only supported motion groups will return a valid response.
7717
7717
  * @summary Get Static Properties
@@ -7720,7 +7720,7 @@ declare class MotionGroupInfosApi extends BaseAPI {
7720
7720
  * @param {*} [options] Override http request option.
7721
7721
  * @throws {RequiredError}
7722
7722
  */
7723
- getMotionGroupSpecification(cell: string, motionGroup: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<MotionGroupSpecification, any>>;
7723
+ getMotionGroupSpecification(cell: string, motionGroup: string, options?: RawAxiosRequestConfig): Promise<axios142.AxiosResponse<MotionGroupSpecification, any>>;
7724
7724
  /**
7725
7725
  * Returns the configured mounting pose offset in relation to world coordinate system and the motion groups coordinate system.
7726
7726
  * @summary Device Mounting
@@ -7729,7 +7729,7 @@ declare class MotionGroupInfosApi extends BaseAPI {
7729
7729
  * @param {*} [options] Override http request option.
7730
7730
  * @throws {RequiredError}
7731
7731
  */
7732
- getMounting(cell: string, motionGroup: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<Mounting, any>>;
7732
+ getMounting(cell: string, motionGroup: string, options?: RawAxiosRequestConfig): Promise<axios142.AxiosResponse<Mounting, any>>;
7733
7733
  /**
7734
7734
  * <!-- theme: danger --> > **Experimental** Get the complete configuration which can be passed to the planner-optimizer (incl. motion group description, limits etc.)
7735
7735
  * @summary Optimizer Configuration
@@ -7739,7 +7739,7 @@ declare class MotionGroupInfosApi extends BaseAPI {
7739
7739
  * @param {*} [options] Override http request option.
7740
7740
  * @throws {RequiredError}
7741
7741
  */
7742
- getOptimizerConfiguration(cell: string, motionGroup: string, tcp?: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<OptimizerSetup, any>>;
7742
+ getOptimizerConfiguration(cell: string, motionGroup: string, tcp?: string, options?: RawAxiosRequestConfig): Promise<axios142.AxiosResponse<OptimizerSetup, any>>;
7743
7743
  /**
7744
7744
  * Get the safety setup and limitations of a connected device, which restricts the device. Safety settings are configured globally on the robot controller and are valid for all the connected devices (like robots).
7745
7745
  * @summary Safety Setup and Limitations
@@ -7748,7 +7748,7 @@ declare class MotionGroupInfosApi extends BaseAPI {
7748
7748
  * @param {*} [options] Override http request option.
7749
7749
  * @throws {RequiredError}
7750
7750
  */
7751
- getSafetySetup(cell: string, motionGroup: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<SafetySetup, any>>;
7751
+ getSafetySetup(cell: string, motionGroup: string, options?: RawAxiosRequestConfig): Promise<axios142.AxiosResponse<SafetySetup, any>>;
7752
7752
  /**
7753
7753
  * Lists all defined payloads of the motion group. The payload is defined as the sum of all weights attached to the flange/endpoint of the motion group, e.g. sum of the tools and workpiece weight that are currently attached.
7754
7754
  * @summary List Payloads
@@ -7757,7 +7757,7 @@ declare class MotionGroupInfosApi extends BaseAPI {
7757
7757
  * @param {*} [options] Override http request option.
7758
7758
  * @throws {RequiredError}
7759
7759
  */
7760
- listPayloads(cell: string, motionGroup: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<ListPayloadsResponse, any>>;
7760
+ listPayloads(cell: string, motionGroup: string, options?: RawAxiosRequestConfig): Promise<axios142.AxiosResponse<ListPayloadsResponse, any>>;
7761
7761
  /**
7762
7762
  * Get all internal configured TCPs of a connected device.
7763
7763
  * @summary List TCPs
@@ -7767,7 +7767,7 @@ declare class MotionGroupInfosApi extends BaseAPI {
7767
7767
  * @param {*} [options] Override http request option.
7768
7768
  * @throws {RequiredError}
7769
7769
  */
7770
- listTcps(cell: string, motionGroup: string, rotationType?: RotationAngleTypes, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<ListTcpsResponse, any>>;
7770
+ listTcps(cell: string, motionGroup: string, rotationType?: RotationAngleTypes, options?: RawAxiosRequestConfig): Promise<axios142.AxiosResponse<ListTcpsResponse, any>>;
7771
7771
  /**
7772
7772
  * Receive updates of the motion group state. The stream will be closed from the server if the controller is disconnected.
7773
7773
  * @summary Stream State of Device
@@ -7779,14 +7779,14 @@ declare class MotionGroupInfosApi extends BaseAPI {
7779
7779
  * @param {*} [options] Override http request option.
7780
7780
  * @throws {RequiredError}
7781
7781
  */
7782
- streamMotionGroupState(cell: string, motionGroup: string, responseRate?: number, responseCoordinateSystem?: string, tcp?: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<MotionGroupStateResponse, any>>;
7782
+ streamMotionGroupState(cell: string, motionGroup: string, responseRate?: number, responseCoordinateSystem?: string, tcp?: string, options?: RawAxiosRequestConfig): Promise<axios142.AxiosResponse<MotionGroupStateResponse, any>>;
7783
7783
  }
7784
7784
  /**
7785
7785
  * MotionGroupJoggingApi - axios parameter creator
7786
7786
  */
7787
7787
  declare const MotionGroupJoggingApiAxiosParamCreator: (configuration?: Configuration) => {
7788
7788
  /**
7789
- * Move TCP along/around a specified direction vector with a specified velocity via a websocket. The purpose of a direction jogging motion is to move a device in exactly one direction with a specified maximum velocity. The sign of the velocity determines the direction of the movement: Positive [+] or Negative [-]. The velocity is given in [mm/s]. In contrast to a planned motion, a jogging motion can be changed dynamically while the motion group is in motion. Only one single client at a time can jog a particular motion group. If another client tries to jog the same motion group at the same time, the second call will fail. The movement of the motion group will start as soon as: * the motion group is not in motion * the websocket connection is established * the first request has been sent As long as the jogging motion is ongoing, responses will be sent continuously and contain the current state of the motion group. The responses will be sent with the specified rate according to the *response_rate* parameter of the initial websocket request. While in motion, the desired direction and velocity can be changed by sending a new request to the same websocket. The motion and sending of the replies will stop when: * a [stopJogging](stopJogging) request was received, processed, and the movement stopped The motion group state will be published in the original command stream until the motion group has stopped. * the client cancels the stream (not recommended, because final stopping position will not be returned from the stream) When a physical limit (e.g. workspace boundary) is reached, the motion group will stop moving in the desired direction. The stream, howewer, will continue to send the state until the client cancels the stream or sends the [stopJogging](stopJogging) request. Singularities are avoided during a jogging motion. This avoidance can result in deviations from the specified direction. The amount of deviation depends on the robot type and current velocity. These mechanisms can lead to a small deviation from the specified direction. The size of deviation is depending on robot type and current velocity. **Usage example:** 1. Open a websocket via python and start the jogging motion: ```bash > python -m websockets \"ws://<IP of Wandelbots NOVA API>/api/v1/cells/<your cell id>/motion-groups/move-tcp\" ``` 2. Send the following message to the server to move current TCP 2 parts up in z direction and one part in negative y direction with 0.2 mm/s along the specified direction vector: ```json { \"motion_group\": \"<your motion group id>\", \"position_direction\": { \"y\": -0.5, \"z\": 1 }, \"rotation_direction\": {}, \"position_velocity\": 0.2, \"response_rate\": 500 } ``` The NOVA API clients support jogging motions without the need to manually open a websocket. > **NOTE** > > If the jogging movement is stopped immediately, ensure that > > - A websocket connection is established. Websockets can be kept open until the robot\'s movement is done as opposed to a simple HTTP GET request. > > - The motion group is not in motion by another jogging movement or a planned movement. > **NOTE** > > If the robot does not move, ensure that > > - The joint velocity values are not zero, > > - The motion group is not in a state where it cannot move further (e.g. joint limit reached). > **NOTE** > > If the specified velocities are higher than the maximum allowed by the robot controller, the motion group will move with the maximum allowed velocities.
7789
+ * Move TCP along/around a specified direction vector with a specified velocity via a websocket. The purpose of a direction jogging motion is to move a device in exactly one direction with a specified maximum velocity. The sign of the velocity determines the direction of the movement: Positive [+] or Negative [-]. The velocity is given in [mm/s]. In contrast to a planned motion, a jogging motion can be changed dynamically while the motion group is in motion. Only one single client at a time can jog a particular motion group. If another client tries to jog the same motion group at the same time, the second call will fail. The movement of the motion group will start as soon as: * the motion group is not in motion * the websocket connection is established * the first request has been sent As long as the jogging motion is ongoing, responses will be sent continuously and contain the current state of the motion group. The responses will be sent with the specified rate according to the *response_rate* parameter of the initial websocket request. While in motion, the desired direction and velocity can be changed by sending a new request to the same websocket. The motion and sending of the replies will stop when: * a [stopJogging](#/operations/stopJogging) request was received, processed, and the movement stopped The motion group state will be published in the original command stream until the motion group has stopped * the client cancels the stream (not recommended, because final stopping position will not be returned from the stream) When a physical limit (e.g. workspace boundary) is reached, the motion group will stop moving in the desired direction. The stream, howewer, will continue to send the state until the client cancels the stream or sends the [stopJogging](#/operations/stopJogging) request. Singularities are avoided during a jogging motion. This avoidance can result in deviations from the specified direction. The amount of deviation depends on the robot type and current velocity. These mechanisms can lead to a small deviation from the specified direction. The size of deviation is depending on robot type and current velocity. **Usage example:** 1. Open a websocket via Python and start the jogging motion: ```bash > python -m websockets \"ws://<IP of Wandelbots NOVA API>/api/v1/cells/<your cell id>/motion-groups/move-tcp\" ``` 2. Send the following message to the server to move current TCP two parts up in the z direction and one part in the negative y direction with 0.2 mm/s along the specified direction vector: ```json { \"motion_group\": \"<your motion group id>\", \"position_direction\": { \"y\": -0.5, \"z\": 1 }, \"rotation_direction\": {}, \"position_velocity\": 0.2, \"response_rate\": 500 } ``` The NOVA API clients support jogging motions without the need to manually open a websocket. > **NOTE** > > If the jogging movement is stopped immediately, ensure that > > - A websocket connection is established. Websockets can be kept open until the robot\'s movement is done as opposed to a simple HTTP GET request. > > - The motion group is not in motion by another jogging movement or a planned movement. > **NOTE** > > If the robot does not move, ensure that > > - The joint velocity values are not zero, > > - The motion group is not in a state where it cannot move further (e.g. joint limit reached). > **NOTE** > > If the specified velocities are higher than the maximum allowed by the robot controller, the motion group will move with the maximum allowed velocities.
7790
7790
  * @summary Stream Cartesian
7791
7791
  * @param {string} cell Unique identifier addressing a cell in all API calls.
7792
7792
  * @param {DirectionJoggingRequest} directionJoggingRequest
@@ -7804,7 +7804,7 @@ declare const MotionGroupJoggingApiAxiosParamCreator: (configuration?: Configura
7804
7804
  */
7805
7805
  getJoggingCapabilities: (cell: string, motionGroup: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
7806
7806
  /**
7807
- * Move one or more joints of a motion group with specified velocities via a websocket. The purpose of a joint jogging motion is to maneuver a motion group in one or more joints with a specified velocity for each joint. The sign of the velocity determines the direction of the joint movement. The velocity is given in [rad/s]. In contrast to a planned motion, a jogging motion can be changed dynamically while the motion group is in motion. Only one single client at a time can jog a particular motion group. If another client tries to jog the same motion group at the same time, the second call will fail. The movement of the motion group will start as soon as: * the motion group is not in motion * the websocket connection is established * the first request has been sent As long as the jogging motion is ongoing, responses will be sent continuously and contain the current state of the motion group. The responses will be sent with the specified rate according to the *response_rate* parameter of the initial websocket request. While in motion, the desired joint velocity can be changed by sending a new request to the same websocket. The motion and sending of the replies will stop when: * a [stopJogging](stopJogging) request was received, processed, and the movement stopped Motion group state will be published in the original command stream until the motion group has fully stopped. * the client cancels the stream (not recommended, because final stopping position will not be returned from the stream) When a physical limit (e.g. joint limit) is reached, the motion group will stop moving in the desired direction. The stream, howewer, will continue to send the state until the client cancels the stream or sends the [stopJogging](stopJogging) request. **Usage example:** 1. Open a websocket via python and start the jogging motion: ```bash > python -m websockets \"ws://<IP of Wandelbots NOVA API>/api/v1/cells/<your cell id>/motion-groups/move-joint\" ``` 2. Send the following message to move with a velocity of 0.1 rad/s (negative) for joint 5 and 0.2 rad/s for joint 6: ```json { \"motion_group\": \"<your motion group id>\", \"joint_velocities\": [0, 0, 0, 0, -0.1, 0.2], \"response_rate\": 500 } ``` The provided NOVA API clients also natively support jogging motions, without the need to manually open a websocket. > **NOTE** > > If the jogging movement is stopped immediately, ensure that > > - A websocket connection is established. Websockets can be kept open until the robot\'s movement is done as opposed to a simple HTTP GET request. > > - The motion group is not in motion by another jogging movement or a planned movement. > **NOTE** > > If the robot does not move, ensure that > > - The joint velocity values are not zero, > > - The motion group is not in a state where it cannot move further (e.g. joint limit reached). > **NOTE** > > If the specified velocities are higher than the maximum allowed by the robot controller, the motion group will move with the maximum allowed velocities.
7807
+ * Move one or more joints of a motion group with specified velocities via a websocket. The purpose of a joint jogging motion is to maneuver a motion group in one or more joints with a specified velocity for each joint. The sign of the velocity determines the direction of the joint movement. The velocity is given in [rad/s]. In contrast to a planned motion, a jogging motion can be changed dynamically while the motion group is in motion. Only one single client at a time can jog a particular motion group. If another client tries to jog the same motion group at the same time, the second call will fail. The movement of the motion group will start as soon as: * the motion group is not in motion * the websocket connection is established * the first request has been sent As long as the jogging motion is ongoing, responses will be sent continuously and contain the current state of the motion group. The responses will be sent with the specified rate according to the *response_rate* parameter of the initial websocket request. While in motion, the desired joint velocity can be changed by sending a new request to the same websocket. The motion and sending of the replies will stop when: * a [stopJogging](#/operations/stopJogging) request was received, processed, and the movement stopped Motion group state will be published in the original command stream until the motion group has fully stopped * the client cancels the stream (not recommended, because final stopping position will not be returned from the stream) When a physical limit (e.g. joint limit) is reached, the motion group will stop moving in the desired direction. The stream, howewer, will continue to send the state until the client cancels the stream or sends the [stopJogging](#/operations/stopJogging) request. **Usage example:** 1. Open a websocket via Python and start the jogging motion: ```bash > python -m websockets \"ws://<IP of Wandelbots NOVA API>/api/v1/cells/<your cell id>/motion-groups/move-joint\" ``` 2. Send the following message to move with a velocity of 0.1 rad/s (negative) for joint 5 and 0.2 rad/s for joint 6: ```json { \"motion_group\": \"<your motion group id>\", \"joint_velocities\": [0, 0, 0, 0, -0.1, 0.2], \"response_rate\": 500 } ``` The provided NOVA API clients also natively support jogging motions, without the need to manually open a websocket. > **NOTE** > > If the jogging movement is stopped immediately, ensure that > > - A websocket connection is established. Websockets can be kept open until the robot\'s movement is done as opposed to a simple HTTP GET request. > > - The motion group is not in motion by another jogging movement or a planned movement. > **NOTE** > > If the robot does not move, ensure that > > - The joint velocity values are not zero, > > - The motion group is not in a state where it cannot move further (e.g. joint limit reached). > **NOTE** > > If the specified velocities are higher than the maximum allowed by the robot controller, the motion group will move with the maximum allowed velocities.
7808
7808
  * @summary Stream Joints
7809
7809
  * @param {string} cell Unique identifier addressing a cell in all API calls.
7810
7810
  * @param {JointJoggingRequest} jointJoggingRequest
@@ -7827,7 +7827,7 @@ declare const MotionGroupJoggingApiAxiosParamCreator: (configuration?: Configura
7827
7827
  */
7828
7828
  declare const MotionGroupJoggingApiFp: (configuration?: Configuration) => {
7829
7829
  /**
7830
- * Move TCP along/around a specified direction vector with a specified velocity via a websocket. The purpose of a direction jogging motion is to move a device in exactly one direction with a specified maximum velocity. The sign of the velocity determines the direction of the movement: Positive [+] or Negative [-]. The velocity is given in [mm/s]. In contrast to a planned motion, a jogging motion can be changed dynamically while the motion group is in motion. Only one single client at a time can jog a particular motion group. If another client tries to jog the same motion group at the same time, the second call will fail. The movement of the motion group will start as soon as: * the motion group is not in motion * the websocket connection is established * the first request has been sent As long as the jogging motion is ongoing, responses will be sent continuously and contain the current state of the motion group. The responses will be sent with the specified rate according to the *response_rate* parameter of the initial websocket request. While in motion, the desired direction and velocity can be changed by sending a new request to the same websocket. The motion and sending of the replies will stop when: * a [stopJogging](stopJogging) request was received, processed, and the movement stopped The motion group state will be published in the original command stream until the motion group has stopped. * the client cancels the stream (not recommended, because final stopping position will not be returned from the stream) When a physical limit (e.g. workspace boundary) is reached, the motion group will stop moving in the desired direction. The stream, howewer, will continue to send the state until the client cancels the stream or sends the [stopJogging](stopJogging) request. Singularities are avoided during a jogging motion. This avoidance can result in deviations from the specified direction. The amount of deviation depends on the robot type and current velocity. These mechanisms can lead to a small deviation from the specified direction. The size of deviation is depending on robot type and current velocity. **Usage example:** 1. Open a websocket via python and start the jogging motion: ```bash > python -m websockets \"ws://<IP of Wandelbots NOVA API>/api/v1/cells/<your cell id>/motion-groups/move-tcp\" ``` 2. Send the following message to the server to move current TCP 2 parts up in z direction and one part in negative y direction with 0.2 mm/s along the specified direction vector: ```json { \"motion_group\": \"<your motion group id>\", \"position_direction\": { \"y\": -0.5, \"z\": 1 }, \"rotation_direction\": {}, \"position_velocity\": 0.2, \"response_rate\": 500 } ``` The NOVA API clients support jogging motions without the need to manually open a websocket. > **NOTE** > > If the jogging movement is stopped immediately, ensure that > > - A websocket connection is established. Websockets can be kept open until the robot\'s movement is done as opposed to a simple HTTP GET request. > > - The motion group is not in motion by another jogging movement or a planned movement. > **NOTE** > > If the robot does not move, ensure that > > - The joint velocity values are not zero, > > - The motion group is not in a state where it cannot move further (e.g. joint limit reached). > **NOTE** > > If the specified velocities are higher than the maximum allowed by the robot controller, the motion group will move with the maximum allowed velocities.
7830
+ * Move TCP along/around a specified direction vector with a specified velocity via a websocket. The purpose of a direction jogging motion is to move a device in exactly one direction with a specified maximum velocity. The sign of the velocity determines the direction of the movement: Positive [+] or Negative [-]. The velocity is given in [mm/s]. In contrast to a planned motion, a jogging motion can be changed dynamically while the motion group is in motion. Only one single client at a time can jog a particular motion group. If another client tries to jog the same motion group at the same time, the second call will fail. The movement of the motion group will start as soon as: * the motion group is not in motion * the websocket connection is established * the first request has been sent As long as the jogging motion is ongoing, responses will be sent continuously and contain the current state of the motion group. The responses will be sent with the specified rate according to the *response_rate* parameter of the initial websocket request. While in motion, the desired direction and velocity can be changed by sending a new request to the same websocket. The motion and sending of the replies will stop when: * a [stopJogging](#/operations/stopJogging) request was received, processed, and the movement stopped The motion group state will be published in the original command stream until the motion group has stopped * the client cancels the stream (not recommended, because final stopping position will not be returned from the stream) When a physical limit (e.g. workspace boundary) is reached, the motion group will stop moving in the desired direction. The stream, howewer, will continue to send the state until the client cancels the stream or sends the [stopJogging](#/operations/stopJogging) request. Singularities are avoided during a jogging motion. This avoidance can result in deviations from the specified direction. The amount of deviation depends on the robot type and current velocity. These mechanisms can lead to a small deviation from the specified direction. The size of deviation is depending on robot type and current velocity. **Usage example:** 1. Open a websocket via Python and start the jogging motion: ```bash > python -m websockets \"ws://<IP of Wandelbots NOVA API>/api/v1/cells/<your cell id>/motion-groups/move-tcp\" ``` 2. Send the following message to the server to move current TCP two parts up in the z direction and one part in the negative y direction with 0.2 mm/s along the specified direction vector: ```json { \"motion_group\": \"<your motion group id>\", \"position_direction\": { \"y\": -0.5, \"z\": 1 }, \"rotation_direction\": {}, \"position_velocity\": 0.2, \"response_rate\": 500 } ``` The NOVA API clients support jogging motions without the need to manually open a websocket. > **NOTE** > > If the jogging movement is stopped immediately, ensure that > > - A websocket connection is established. Websockets can be kept open until the robot\'s movement is done as opposed to a simple HTTP GET request. > > - The motion group is not in motion by another jogging movement or a planned movement. > **NOTE** > > If the robot does not move, ensure that > > - The joint velocity values are not zero, > > - The motion group is not in a state where it cannot move further (e.g. joint limit reached). > **NOTE** > > If the specified velocities are higher than the maximum allowed by the robot controller, the motion group will move with the maximum allowed velocities.
7831
7831
  * @summary Stream Cartesian
7832
7832
  * @param {string} cell Unique identifier addressing a cell in all API calls.
7833
7833
  * @param {DirectionJoggingRequest} directionJoggingRequest
@@ -7845,7 +7845,7 @@ declare const MotionGroupJoggingApiFp: (configuration?: Configuration) => {
7845
7845
  */
7846
7846
  getJoggingCapabilities(cell: string, motionGroup: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<JoggingServiceCapabilities>>;
7847
7847
  /**
7848
- * Move one or more joints of a motion group with specified velocities via a websocket. The purpose of a joint jogging motion is to maneuver a motion group in one or more joints with a specified velocity for each joint. The sign of the velocity determines the direction of the joint movement. The velocity is given in [rad/s]. In contrast to a planned motion, a jogging motion can be changed dynamically while the motion group is in motion. Only one single client at a time can jog a particular motion group. If another client tries to jog the same motion group at the same time, the second call will fail. The movement of the motion group will start as soon as: * the motion group is not in motion * the websocket connection is established * the first request has been sent As long as the jogging motion is ongoing, responses will be sent continuously and contain the current state of the motion group. The responses will be sent with the specified rate according to the *response_rate* parameter of the initial websocket request. While in motion, the desired joint velocity can be changed by sending a new request to the same websocket. The motion and sending of the replies will stop when: * a [stopJogging](stopJogging) request was received, processed, and the movement stopped Motion group state will be published in the original command stream until the motion group has fully stopped. * the client cancels the stream (not recommended, because final stopping position will not be returned from the stream) When a physical limit (e.g. joint limit) is reached, the motion group will stop moving in the desired direction. The stream, howewer, will continue to send the state until the client cancels the stream or sends the [stopJogging](stopJogging) request. **Usage example:** 1. Open a websocket via python and start the jogging motion: ```bash > python -m websockets \"ws://<IP of Wandelbots NOVA API>/api/v1/cells/<your cell id>/motion-groups/move-joint\" ``` 2. Send the following message to move with a velocity of 0.1 rad/s (negative) for joint 5 and 0.2 rad/s for joint 6: ```json { \"motion_group\": \"<your motion group id>\", \"joint_velocities\": [0, 0, 0, 0, -0.1, 0.2], \"response_rate\": 500 } ``` The provided NOVA API clients also natively support jogging motions, without the need to manually open a websocket. > **NOTE** > > If the jogging movement is stopped immediately, ensure that > > - A websocket connection is established. Websockets can be kept open until the robot\'s movement is done as opposed to a simple HTTP GET request. > > - The motion group is not in motion by another jogging movement or a planned movement. > **NOTE** > > If the robot does not move, ensure that > > - The joint velocity values are not zero, > > - The motion group is not in a state where it cannot move further (e.g. joint limit reached). > **NOTE** > > If the specified velocities are higher than the maximum allowed by the robot controller, the motion group will move with the maximum allowed velocities.
7848
+ * Move one or more joints of a motion group with specified velocities via a websocket. The purpose of a joint jogging motion is to maneuver a motion group in one or more joints with a specified velocity for each joint. The sign of the velocity determines the direction of the joint movement. The velocity is given in [rad/s]. In contrast to a planned motion, a jogging motion can be changed dynamically while the motion group is in motion. Only one single client at a time can jog a particular motion group. If another client tries to jog the same motion group at the same time, the second call will fail. The movement of the motion group will start as soon as: * the motion group is not in motion * the websocket connection is established * the first request has been sent As long as the jogging motion is ongoing, responses will be sent continuously and contain the current state of the motion group. The responses will be sent with the specified rate according to the *response_rate* parameter of the initial websocket request. While in motion, the desired joint velocity can be changed by sending a new request to the same websocket. The motion and sending of the replies will stop when: * a [stopJogging](#/operations/stopJogging) request was received, processed, and the movement stopped Motion group state will be published in the original command stream until the motion group has fully stopped * the client cancels the stream (not recommended, because final stopping position will not be returned from the stream) When a physical limit (e.g. joint limit) is reached, the motion group will stop moving in the desired direction. The stream, howewer, will continue to send the state until the client cancels the stream or sends the [stopJogging](#/operations/stopJogging) request. **Usage example:** 1. Open a websocket via Python and start the jogging motion: ```bash > python -m websockets \"ws://<IP of Wandelbots NOVA API>/api/v1/cells/<your cell id>/motion-groups/move-joint\" ``` 2. Send the following message to move with a velocity of 0.1 rad/s (negative) for joint 5 and 0.2 rad/s for joint 6: ```json { \"motion_group\": \"<your motion group id>\", \"joint_velocities\": [0, 0, 0, 0, -0.1, 0.2], \"response_rate\": 500 } ``` The provided NOVA API clients also natively support jogging motions, without the need to manually open a websocket. > **NOTE** > > If the jogging movement is stopped immediately, ensure that > > - A websocket connection is established. Websockets can be kept open until the robot\'s movement is done as opposed to a simple HTTP GET request. > > - The motion group is not in motion by another jogging movement or a planned movement. > **NOTE** > > If the robot does not move, ensure that > > - The joint velocity values are not zero, > > - The motion group is not in a state where it cannot move further (e.g. joint limit reached). > **NOTE** > > If the specified velocities are higher than the maximum allowed by the robot controller, the motion group will move with the maximum allowed velocities.
7849
7849
  * @summary Stream Joints
7850
7850
  * @param {string} cell Unique identifier addressing a cell in all API calls.
7851
7851
  * @param {JointJoggingRequest} jointJoggingRequest
@@ -7868,7 +7868,7 @@ declare const MotionGroupJoggingApiFp: (configuration?: Configuration) => {
7868
7868
  */
7869
7869
  declare const MotionGroupJoggingApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
7870
7870
  /**
7871
- * Move TCP along/around a specified direction vector with a specified velocity via a websocket. The purpose of a direction jogging motion is to move a device in exactly one direction with a specified maximum velocity. The sign of the velocity determines the direction of the movement: Positive [+] or Negative [-]. The velocity is given in [mm/s]. In contrast to a planned motion, a jogging motion can be changed dynamically while the motion group is in motion. Only one single client at a time can jog a particular motion group. If another client tries to jog the same motion group at the same time, the second call will fail. The movement of the motion group will start as soon as: * the motion group is not in motion * the websocket connection is established * the first request has been sent As long as the jogging motion is ongoing, responses will be sent continuously and contain the current state of the motion group. The responses will be sent with the specified rate according to the *response_rate* parameter of the initial websocket request. While in motion, the desired direction and velocity can be changed by sending a new request to the same websocket. The motion and sending of the replies will stop when: * a [stopJogging](stopJogging) request was received, processed, and the movement stopped The motion group state will be published in the original command stream until the motion group has stopped. * the client cancels the stream (not recommended, because final stopping position will not be returned from the stream) When a physical limit (e.g. workspace boundary) is reached, the motion group will stop moving in the desired direction. The stream, howewer, will continue to send the state until the client cancels the stream or sends the [stopJogging](stopJogging) request. Singularities are avoided during a jogging motion. This avoidance can result in deviations from the specified direction. The amount of deviation depends on the robot type and current velocity. These mechanisms can lead to a small deviation from the specified direction. The size of deviation is depending on robot type and current velocity. **Usage example:** 1. Open a websocket via python and start the jogging motion: ```bash > python -m websockets \"ws://<IP of Wandelbots NOVA API>/api/v1/cells/<your cell id>/motion-groups/move-tcp\" ``` 2. Send the following message to the server to move current TCP 2 parts up in z direction and one part in negative y direction with 0.2 mm/s along the specified direction vector: ```json { \"motion_group\": \"<your motion group id>\", \"position_direction\": { \"y\": -0.5, \"z\": 1 }, \"rotation_direction\": {}, \"position_velocity\": 0.2, \"response_rate\": 500 } ``` The NOVA API clients support jogging motions without the need to manually open a websocket. > **NOTE** > > If the jogging movement is stopped immediately, ensure that > > - A websocket connection is established. Websockets can be kept open until the robot\'s movement is done as opposed to a simple HTTP GET request. > > - The motion group is not in motion by another jogging movement or a planned movement. > **NOTE** > > If the robot does not move, ensure that > > - The joint velocity values are not zero, > > - The motion group is not in a state where it cannot move further (e.g. joint limit reached). > **NOTE** > > If the specified velocities are higher than the maximum allowed by the robot controller, the motion group will move with the maximum allowed velocities.
7871
+ * Move TCP along/around a specified direction vector with a specified velocity via a websocket. The purpose of a direction jogging motion is to move a device in exactly one direction with a specified maximum velocity. The sign of the velocity determines the direction of the movement: Positive [+] or Negative [-]. The velocity is given in [mm/s]. In contrast to a planned motion, a jogging motion can be changed dynamically while the motion group is in motion. Only one single client at a time can jog a particular motion group. If another client tries to jog the same motion group at the same time, the second call will fail. The movement of the motion group will start as soon as: * the motion group is not in motion * the websocket connection is established * the first request has been sent As long as the jogging motion is ongoing, responses will be sent continuously and contain the current state of the motion group. The responses will be sent with the specified rate according to the *response_rate* parameter of the initial websocket request. While in motion, the desired direction and velocity can be changed by sending a new request to the same websocket. The motion and sending of the replies will stop when: * a [stopJogging](#/operations/stopJogging) request was received, processed, and the movement stopped The motion group state will be published in the original command stream until the motion group has stopped * the client cancels the stream (not recommended, because final stopping position will not be returned from the stream) When a physical limit (e.g. workspace boundary) is reached, the motion group will stop moving in the desired direction. The stream, howewer, will continue to send the state until the client cancels the stream or sends the [stopJogging](#/operations/stopJogging) request. Singularities are avoided during a jogging motion. This avoidance can result in deviations from the specified direction. The amount of deviation depends on the robot type and current velocity. These mechanisms can lead to a small deviation from the specified direction. The size of deviation is depending on robot type and current velocity. **Usage example:** 1. Open a websocket via Python and start the jogging motion: ```bash > python -m websockets \"ws://<IP of Wandelbots NOVA API>/api/v1/cells/<your cell id>/motion-groups/move-tcp\" ``` 2. Send the following message to the server to move current TCP two parts up in the z direction and one part in the negative y direction with 0.2 mm/s along the specified direction vector: ```json { \"motion_group\": \"<your motion group id>\", \"position_direction\": { \"y\": -0.5, \"z\": 1 }, \"rotation_direction\": {}, \"position_velocity\": 0.2, \"response_rate\": 500 } ``` The NOVA API clients support jogging motions without the need to manually open a websocket. > **NOTE** > > If the jogging movement is stopped immediately, ensure that > > - A websocket connection is established. Websockets can be kept open until the robot\'s movement is done as opposed to a simple HTTP GET request. > > - The motion group is not in motion by another jogging movement or a planned movement. > **NOTE** > > If the robot does not move, ensure that > > - The joint velocity values are not zero, > > - The motion group is not in a state where it cannot move further (e.g. joint limit reached). > **NOTE** > > If the specified velocities are higher than the maximum allowed by the robot controller, the motion group will move with the maximum allowed velocities.
7872
7872
  * @summary Stream Cartesian
7873
7873
  * @param {string} cell Unique identifier addressing a cell in all API calls.
7874
7874
  * @param {DirectionJoggingRequest} directionJoggingRequest
@@ -7886,7 +7886,7 @@ declare const MotionGroupJoggingApiFactory: (configuration?: Configuration, base
7886
7886
  */
7887
7887
  getJoggingCapabilities(cell: string, motionGroup: string, options?: RawAxiosRequestConfig): AxiosPromise<JoggingServiceCapabilities>;
7888
7888
  /**
7889
- * Move one or more joints of a motion group with specified velocities via a websocket. The purpose of a joint jogging motion is to maneuver a motion group in one or more joints with a specified velocity for each joint. The sign of the velocity determines the direction of the joint movement. The velocity is given in [rad/s]. In contrast to a planned motion, a jogging motion can be changed dynamically while the motion group is in motion. Only one single client at a time can jog a particular motion group. If another client tries to jog the same motion group at the same time, the second call will fail. The movement of the motion group will start as soon as: * the motion group is not in motion * the websocket connection is established * the first request has been sent As long as the jogging motion is ongoing, responses will be sent continuously and contain the current state of the motion group. The responses will be sent with the specified rate according to the *response_rate* parameter of the initial websocket request. While in motion, the desired joint velocity can be changed by sending a new request to the same websocket. The motion and sending of the replies will stop when: * a [stopJogging](stopJogging) request was received, processed, and the movement stopped Motion group state will be published in the original command stream until the motion group has fully stopped. * the client cancels the stream (not recommended, because final stopping position will not be returned from the stream) When a physical limit (e.g. joint limit) is reached, the motion group will stop moving in the desired direction. The stream, howewer, will continue to send the state until the client cancels the stream or sends the [stopJogging](stopJogging) request. **Usage example:** 1. Open a websocket via python and start the jogging motion: ```bash > python -m websockets \"ws://<IP of Wandelbots NOVA API>/api/v1/cells/<your cell id>/motion-groups/move-joint\" ``` 2. Send the following message to move with a velocity of 0.1 rad/s (negative) for joint 5 and 0.2 rad/s for joint 6: ```json { \"motion_group\": \"<your motion group id>\", \"joint_velocities\": [0, 0, 0, 0, -0.1, 0.2], \"response_rate\": 500 } ``` The provided NOVA API clients also natively support jogging motions, without the need to manually open a websocket. > **NOTE** > > If the jogging movement is stopped immediately, ensure that > > - A websocket connection is established. Websockets can be kept open until the robot\'s movement is done as opposed to a simple HTTP GET request. > > - The motion group is not in motion by another jogging movement or a planned movement. > **NOTE** > > If the robot does not move, ensure that > > - The joint velocity values are not zero, > > - The motion group is not in a state where it cannot move further (e.g. joint limit reached). > **NOTE** > > If the specified velocities are higher than the maximum allowed by the robot controller, the motion group will move with the maximum allowed velocities.
7889
+ * Move one or more joints of a motion group with specified velocities via a websocket. The purpose of a joint jogging motion is to maneuver a motion group in one or more joints with a specified velocity for each joint. The sign of the velocity determines the direction of the joint movement. The velocity is given in [rad/s]. In contrast to a planned motion, a jogging motion can be changed dynamically while the motion group is in motion. Only one single client at a time can jog a particular motion group. If another client tries to jog the same motion group at the same time, the second call will fail. The movement of the motion group will start as soon as: * the motion group is not in motion * the websocket connection is established * the first request has been sent As long as the jogging motion is ongoing, responses will be sent continuously and contain the current state of the motion group. The responses will be sent with the specified rate according to the *response_rate* parameter of the initial websocket request. While in motion, the desired joint velocity can be changed by sending a new request to the same websocket. The motion and sending of the replies will stop when: * a [stopJogging](#/operations/stopJogging) request was received, processed, and the movement stopped Motion group state will be published in the original command stream until the motion group has fully stopped * the client cancels the stream (not recommended, because final stopping position will not be returned from the stream) When a physical limit (e.g. joint limit) is reached, the motion group will stop moving in the desired direction. The stream, howewer, will continue to send the state until the client cancels the stream or sends the [stopJogging](#/operations/stopJogging) request. **Usage example:** 1. Open a websocket via Python and start the jogging motion: ```bash > python -m websockets \"ws://<IP of Wandelbots NOVA API>/api/v1/cells/<your cell id>/motion-groups/move-joint\" ``` 2. Send the following message to move with a velocity of 0.1 rad/s (negative) for joint 5 and 0.2 rad/s for joint 6: ```json { \"motion_group\": \"<your motion group id>\", \"joint_velocities\": [0, 0, 0, 0, -0.1, 0.2], \"response_rate\": 500 } ``` The provided NOVA API clients also natively support jogging motions, without the need to manually open a websocket. > **NOTE** > > If the jogging movement is stopped immediately, ensure that > > - A websocket connection is established. Websockets can be kept open until the robot\'s movement is done as opposed to a simple HTTP GET request. > > - The motion group is not in motion by another jogging movement or a planned movement. > **NOTE** > > If the robot does not move, ensure that > > - The joint velocity values are not zero, > > - The motion group is not in a state where it cannot move further (e.g. joint limit reached). > **NOTE** > > If the specified velocities are higher than the maximum allowed by the robot controller, the motion group will move with the maximum allowed velocities.
7890
7890
  * @summary Stream Joints
7891
7891
  * @param {string} cell Unique identifier addressing a cell in all API calls.
7892
7892
  * @param {JointJoggingRequest} jointJoggingRequest
@@ -7909,14 +7909,14 @@ declare const MotionGroupJoggingApiFactory: (configuration?: Configuration, base
7909
7909
  */
7910
7910
  declare class MotionGroupJoggingApi extends BaseAPI {
7911
7911
  /**
7912
- * Move TCP along/around a specified direction vector with a specified velocity via a websocket. The purpose of a direction jogging motion is to move a device in exactly one direction with a specified maximum velocity. The sign of the velocity determines the direction of the movement: Positive [+] or Negative [-]. The velocity is given in [mm/s]. In contrast to a planned motion, a jogging motion can be changed dynamically while the motion group is in motion. Only one single client at a time can jog a particular motion group. If another client tries to jog the same motion group at the same time, the second call will fail. The movement of the motion group will start as soon as: * the motion group is not in motion * the websocket connection is established * the first request has been sent As long as the jogging motion is ongoing, responses will be sent continuously and contain the current state of the motion group. The responses will be sent with the specified rate according to the *response_rate* parameter of the initial websocket request. While in motion, the desired direction and velocity can be changed by sending a new request to the same websocket. The motion and sending of the replies will stop when: * a [stopJogging](stopJogging) request was received, processed, and the movement stopped The motion group state will be published in the original command stream until the motion group has stopped. * the client cancels the stream (not recommended, because final stopping position will not be returned from the stream) When a physical limit (e.g. workspace boundary) is reached, the motion group will stop moving in the desired direction. The stream, howewer, will continue to send the state until the client cancels the stream or sends the [stopJogging](stopJogging) request. Singularities are avoided during a jogging motion. This avoidance can result in deviations from the specified direction. The amount of deviation depends on the robot type and current velocity. These mechanisms can lead to a small deviation from the specified direction. The size of deviation is depending on robot type and current velocity. **Usage example:** 1. Open a websocket via python and start the jogging motion: ```bash > python -m websockets \"ws://<IP of Wandelbots NOVA API>/api/v1/cells/<your cell id>/motion-groups/move-tcp\" ``` 2. Send the following message to the server to move current TCP 2 parts up in z direction and one part in negative y direction with 0.2 mm/s along the specified direction vector: ```json { \"motion_group\": \"<your motion group id>\", \"position_direction\": { \"y\": -0.5, \"z\": 1 }, \"rotation_direction\": {}, \"position_velocity\": 0.2, \"response_rate\": 500 } ``` The NOVA API clients support jogging motions without the need to manually open a websocket. > **NOTE** > > If the jogging movement is stopped immediately, ensure that > > - A websocket connection is established. Websockets can be kept open until the robot\'s movement is done as opposed to a simple HTTP GET request. > > - The motion group is not in motion by another jogging movement or a planned movement. > **NOTE** > > If the robot does not move, ensure that > > - The joint velocity values are not zero, > > - The motion group is not in a state where it cannot move further (e.g. joint limit reached). > **NOTE** > > If the specified velocities are higher than the maximum allowed by the robot controller, the motion group will move with the maximum allowed velocities.
7912
+ * Move TCP along/around a specified direction vector with a specified velocity via a websocket. The purpose of a direction jogging motion is to move a device in exactly one direction with a specified maximum velocity. The sign of the velocity determines the direction of the movement: Positive [+] or Negative [-]. The velocity is given in [mm/s]. In contrast to a planned motion, a jogging motion can be changed dynamically while the motion group is in motion. Only one single client at a time can jog a particular motion group. If another client tries to jog the same motion group at the same time, the second call will fail. The movement of the motion group will start as soon as: * the motion group is not in motion * the websocket connection is established * the first request has been sent As long as the jogging motion is ongoing, responses will be sent continuously and contain the current state of the motion group. The responses will be sent with the specified rate according to the *response_rate* parameter of the initial websocket request. While in motion, the desired direction and velocity can be changed by sending a new request to the same websocket. The motion and sending of the replies will stop when: * a [stopJogging](#/operations/stopJogging) request was received, processed, and the movement stopped The motion group state will be published in the original command stream until the motion group has stopped * the client cancels the stream (not recommended, because final stopping position will not be returned from the stream) When a physical limit (e.g. workspace boundary) is reached, the motion group will stop moving in the desired direction. The stream, howewer, will continue to send the state until the client cancels the stream or sends the [stopJogging](#/operations/stopJogging) request. Singularities are avoided during a jogging motion. This avoidance can result in deviations from the specified direction. The amount of deviation depends on the robot type and current velocity. These mechanisms can lead to a small deviation from the specified direction. The size of deviation is depending on robot type and current velocity. **Usage example:** 1. Open a websocket via Python and start the jogging motion: ```bash > python -m websockets \"ws://<IP of Wandelbots NOVA API>/api/v1/cells/<your cell id>/motion-groups/move-tcp\" ``` 2. Send the following message to the server to move current TCP two parts up in the z direction and one part in the negative y direction with 0.2 mm/s along the specified direction vector: ```json { \"motion_group\": \"<your motion group id>\", \"position_direction\": { \"y\": -0.5, \"z\": 1 }, \"rotation_direction\": {}, \"position_velocity\": 0.2, \"response_rate\": 500 } ``` The NOVA API clients support jogging motions without the need to manually open a websocket. > **NOTE** > > If the jogging movement is stopped immediately, ensure that > > - A websocket connection is established. Websockets can be kept open until the robot\'s movement is done as opposed to a simple HTTP GET request. > > - The motion group is not in motion by another jogging movement or a planned movement. > **NOTE** > > If the robot does not move, ensure that > > - The joint velocity values are not zero, > > - The motion group is not in a state where it cannot move further (e.g. joint limit reached). > **NOTE** > > If the specified velocities are higher than the maximum allowed by the robot controller, the motion group will move with the maximum allowed velocities.
7913
7913
  * @summary Stream Cartesian
7914
7914
  * @param {string} cell Unique identifier addressing a cell in all API calls.
7915
7915
  * @param {DirectionJoggingRequest} directionJoggingRequest
7916
7916
  * @param {*} [options] Override http request option.
7917
7917
  * @throws {RequiredError}
7918
7918
  */
7919
- directionJogging(cell: string, directionJoggingRequest: DirectionJoggingRequest, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<JoggingResponse, any>>;
7919
+ directionJogging(cell: string, directionJoggingRequest: DirectionJoggingRequest, options?: RawAxiosRequestConfig): Promise<axios142.AxiosResponse<JoggingResponse, any>>;
7920
7920
  /**
7921
7921
  * Shows the options the motion group offers in regard to jogging. Some motion groups may not provide all information services, e.g. it is physically not possible to move a one-axis-turntable in a linear way.
7922
7922
  * @summary Capabilities
@@ -7925,16 +7925,16 @@ declare class MotionGroupJoggingApi extends BaseAPI {
7925
7925
  * @param {*} [options] Override http request option.
7926
7926
  * @throws {RequiredError}
7927
7927
  */
7928
- getJoggingCapabilities(cell: string, motionGroup: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<JoggingServiceCapabilities, any>>;
7928
+ getJoggingCapabilities(cell: string, motionGroup: string, options?: RawAxiosRequestConfig): Promise<axios142.AxiosResponse<JoggingServiceCapabilities, any>>;
7929
7929
  /**
7930
- * Move one or more joints of a motion group with specified velocities via a websocket. The purpose of a joint jogging motion is to maneuver a motion group in one or more joints with a specified velocity for each joint. The sign of the velocity determines the direction of the joint movement. The velocity is given in [rad/s]. In contrast to a planned motion, a jogging motion can be changed dynamically while the motion group is in motion. Only one single client at a time can jog a particular motion group. If another client tries to jog the same motion group at the same time, the second call will fail. The movement of the motion group will start as soon as: * the motion group is not in motion * the websocket connection is established * the first request has been sent As long as the jogging motion is ongoing, responses will be sent continuously and contain the current state of the motion group. The responses will be sent with the specified rate according to the *response_rate* parameter of the initial websocket request. While in motion, the desired joint velocity can be changed by sending a new request to the same websocket. The motion and sending of the replies will stop when: * a [stopJogging](stopJogging) request was received, processed, and the movement stopped Motion group state will be published in the original command stream until the motion group has fully stopped. * the client cancels the stream (not recommended, because final stopping position will not be returned from the stream) When a physical limit (e.g. joint limit) is reached, the motion group will stop moving in the desired direction. The stream, howewer, will continue to send the state until the client cancels the stream or sends the [stopJogging](stopJogging) request. **Usage example:** 1. Open a websocket via python and start the jogging motion: ```bash > python -m websockets \"ws://<IP of Wandelbots NOVA API>/api/v1/cells/<your cell id>/motion-groups/move-joint\" ``` 2. Send the following message to move with a velocity of 0.1 rad/s (negative) for joint 5 and 0.2 rad/s for joint 6: ```json { \"motion_group\": \"<your motion group id>\", \"joint_velocities\": [0, 0, 0, 0, -0.1, 0.2], \"response_rate\": 500 } ``` The provided NOVA API clients also natively support jogging motions, without the need to manually open a websocket. > **NOTE** > > If the jogging movement is stopped immediately, ensure that > > - A websocket connection is established. Websockets can be kept open until the robot\'s movement is done as opposed to a simple HTTP GET request. > > - The motion group is not in motion by another jogging movement or a planned movement. > **NOTE** > > If the robot does not move, ensure that > > - The joint velocity values are not zero, > > - The motion group is not in a state where it cannot move further (e.g. joint limit reached). > **NOTE** > > If the specified velocities are higher than the maximum allowed by the robot controller, the motion group will move with the maximum allowed velocities.
7930
+ * Move one or more joints of a motion group with specified velocities via a websocket. The purpose of a joint jogging motion is to maneuver a motion group in one or more joints with a specified velocity for each joint. The sign of the velocity determines the direction of the joint movement. The velocity is given in [rad/s]. In contrast to a planned motion, a jogging motion can be changed dynamically while the motion group is in motion. Only one single client at a time can jog a particular motion group. If another client tries to jog the same motion group at the same time, the second call will fail. The movement of the motion group will start as soon as: * the motion group is not in motion * the websocket connection is established * the first request has been sent As long as the jogging motion is ongoing, responses will be sent continuously and contain the current state of the motion group. The responses will be sent with the specified rate according to the *response_rate* parameter of the initial websocket request. While in motion, the desired joint velocity can be changed by sending a new request to the same websocket. The motion and sending of the replies will stop when: * a [stopJogging](#/operations/stopJogging) request was received, processed, and the movement stopped Motion group state will be published in the original command stream until the motion group has fully stopped * the client cancels the stream (not recommended, because final stopping position will not be returned from the stream) When a physical limit (e.g. joint limit) is reached, the motion group will stop moving in the desired direction. The stream, howewer, will continue to send the state until the client cancels the stream or sends the [stopJogging](#/operations/stopJogging) request. **Usage example:** 1. Open a websocket via Python and start the jogging motion: ```bash > python -m websockets \"ws://<IP of Wandelbots NOVA API>/api/v1/cells/<your cell id>/motion-groups/move-joint\" ``` 2. Send the following message to move with a velocity of 0.1 rad/s (negative) for joint 5 and 0.2 rad/s for joint 6: ```json { \"motion_group\": \"<your motion group id>\", \"joint_velocities\": [0, 0, 0, 0, -0.1, 0.2], \"response_rate\": 500 } ``` The provided NOVA API clients also natively support jogging motions, without the need to manually open a websocket. > **NOTE** > > If the jogging movement is stopped immediately, ensure that > > - A websocket connection is established. Websockets can be kept open until the robot\'s movement is done as opposed to a simple HTTP GET request. > > - The motion group is not in motion by another jogging movement or a planned movement. > **NOTE** > > If the robot does not move, ensure that > > - The joint velocity values are not zero, > > - The motion group is not in a state where it cannot move further (e.g. joint limit reached). > **NOTE** > > If the specified velocities are higher than the maximum allowed by the robot controller, the motion group will move with the maximum allowed velocities.
7931
7931
  * @summary Stream Joints
7932
7932
  * @param {string} cell Unique identifier addressing a cell in all API calls.
7933
7933
  * @param {JointJoggingRequest} jointJoggingRequest
7934
7934
  * @param {*} [options] Override http request option.
7935
7935
  * @throws {RequiredError}
7936
7936
  */
7937
- jointJogging(cell: string, jointJoggingRequest: JointJoggingRequest, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<JoggingResponse, any>>;
7937
+ jointJogging(cell: string, jointJoggingRequest: JointJoggingRequest, options?: RawAxiosRequestConfig): Promise<axios142.AxiosResponse<JoggingResponse, any>>;
7938
7938
  /**
7939
7939
  * Stops an ongoing jogging movement as fast as possible. Until the motion group reaches standstill, it decelerates and keeps the last specified direction. This call will immediately return even if the deceleration is still in progress. After a stop request has been received, no further updates to the ongoing jogging movement are possible. State responses will be sent via the jogging stream until the motion group reaches standstill.
7940
7940
  * @summary Stop
@@ -7943,7 +7943,7 @@ declare class MotionGroupJoggingApi extends BaseAPI {
7943
7943
  * @param {*} [options] Override http request option.
7944
7944
  * @throws {RequiredError}
7945
7945
  */
7946
- stopJogging(cell: string, motionGroup: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
7946
+ stopJogging(cell: string, motionGroup: string, options?: RawAxiosRequestConfig): Promise<axios142.AxiosResponse<void, any>>;
7947
7947
  }
7948
7948
  /**
7949
7949
  * MotionGroupKinematicApi - axios parameter creator
@@ -8090,7 +8090,7 @@ declare class MotionGroupKinematicApi extends BaseAPI {
8090
8090
  * @param {*} [options] Override http request option.
8091
8091
  * @throws {RequiredError}
8092
8092
  */
8093
- calculateAllInverseKinematic(cell: string, motionGroup: string, allJointPositionsRequest: AllJointPositionsRequest, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<AllJointPositionsResponse, any>>;
8093
+ calculateAllInverseKinematic(cell: string, motionGroup: string, allJointPositionsRequest: AllJointPositionsRequest, options?: RawAxiosRequestConfig): Promise<axios142.AxiosResponse<AllJointPositionsResponse, any>>;
8094
8094
  /**
8095
8095
  * Calculates the TCP pose from a joint position sample using the forward kinematics of the motion-group.
8096
8096
  * @summary TcpPose from JointPosition
@@ -8100,7 +8100,7 @@ declare class MotionGroupKinematicApi extends BaseAPI {
8100
8100
  * @param {*} [options] Override http request option.
8101
8101
  * @throws {RequiredError}
8102
8102
  */
8103
- calculateForwardKinematic(cell: string, motionGroup: string, tcpPoseRequest: TcpPoseRequest, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<Pose, any>>;
8103
+ calculateForwardKinematic(cell: string, motionGroup: string, tcpPoseRequest: TcpPoseRequest, options?: RawAxiosRequestConfig): Promise<axios142.AxiosResponse<Pose, any>>;
8104
8104
  /**
8105
8105
  * Calculate the joint positions the motion-group needs to apply for its TCP to be in a specified pose (Inverse Kinematic Solution). If multiple solutions are found, the one nearest to the given specified joint position is picked. * For all supported robot models, except the Fanuc CRX line, the returned joint position is guaranteed to have the same configuration (often referred to as ELBOW_UP, WRIST_DOWN, SHOULDER_RIGHT, f.e.) as the specified reference joint position. If the position limit of any single joint allows it to be in a range larger than 2 PI, the respective joint value in the result will be as close as possible to its reference value. * For the Fanuc CRX line the solution is selected to have the smallest distance measured by the norm of its difference to the reference joint position. The returned joint position is guaranteed to be within the joint limits and not in a singular position of the robot.
8106
8106
  * @summary Nearest JointPosition from TcpPose
@@ -8110,7 +8110,7 @@ declare class MotionGroupKinematicApi extends BaseAPI {
8110
8110
  * @param {*} [options] Override http request option.
8111
8111
  * @throws {RequiredError}
8112
8112
  */
8113
- calculateInverseKinematic(cell: string, motionGroup: string, jointPositionRequest: JointPositionRequest, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<Joints, any>>;
8113
+ calculateInverseKinematic(cell: string, motionGroup: string, jointPositionRequest: JointPositionRequest, options?: RawAxiosRequestConfig): Promise<axios142.AxiosResponse<Joints, any>>;
8114
8114
  /**
8115
8115
  * Get the kinematic endpoints provided for the specified motion-group.
8116
8116
  * @summary Capabilities
@@ -8119,7 +8119,7 @@ declare class MotionGroupKinematicApi extends BaseAPI {
8119
8119
  * @param {*} [options] Override http request option.
8120
8120
  * @throws {RequiredError}
8121
8121
  */
8122
- getKinematicCapabilities(cell: string, motionGroup: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<KinematicServiceCapabilities, any>>;
8122
+ getKinematicCapabilities(cell: string, motionGroup: string, options?: RawAxiosRequestConfig): Promise<axios142.AxiosResponse<KinematicServiceCapabilities, any>>;
8123
8123
  }
8124
8124
  /**
8125
8125
  * ProgramApi - axios parameter creator
@@ -8361,7 +8361,7 @@ declare class ProgramApi extends BaseAPI {
8361
8361
  * @param {*} [options] Override http request option.
8362
8362
  * @throws {RequiredError}
8363
8363
  */
8364
- createProgramRunner(cell: string, request: Request, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<ProgramRunnerReference, any>>;
8364
+ createProgramRunner(cell: string, request: Request, options?: RawAxiosRequestConfig): Promise<axios142.AxiosResponse<ProgramRunnerReference, any>>;
8365
8365
  /**
8366
8366
  * Execute a program in Wandelscript. The Wandelscript can also move multiple robots by using the \'do with\' syntax. The execute operation will be started from the current joint configuration of any addressed robot(s). Addressed robots have to be in control mode for the execute operation to succeed. A request to this endpoint will block this endpoint until the program has been executed, or until an error occurs. The executed movement is returned in case of a succesful execution. Otherwise an error (e.g. out of reach, singularity), is returned. The Wandelscript can either be submitted as is, using Content-type text/plain, or as content-type application/json with the Wandelscript under \"code\" alongside a set of values provided under \"initial_state\". * [WandelEngine & Wandelscript Documentation](/docs/docs/wandelscript)
8367
8367
  * @summary Execute Program
@@ -8370,7 +8370,7 @@ declare class ProgramApi extends BaseAPI {
8370
8370
  * @param {*} [options] Override http request option.
8371
8371
  * @throws {RequiredError}
8372
8372
  */
8373
- executeProgram(cell: string, codeWithArguments: CodeWithArguments, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<ProgramRun, any>>;
8373
+ executeProgram(cell: string, codeWithArguments: CodeWithArguments, options?: RawAxiosRequestConfig): Promise<axios142.AxiosResponse<ProgramRun, any>>;
8374
8374
  /**
8375
8375
  * Returns information about a program currently executed. When a program is finished: Program response, result, collected Wandelscript logs, etc. When a program is running: Running status, current executed line, etc. ## Parameters - **runner_id**: The id of the program runner
8376
8376
  * @summary Get Program Runner
@@ -8379,7 +8379,7 @@ declare class ProgramApi extends BaseAPI {
8379
8379
  * @param {*} [options] Override http request option.
8380
8380
  * @throws {RequiredError}
8381
8381
  */
8382
- getProgramRunner(cell: string, runner: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<ProgramRun, any>>;
8382
+ getProgramRunner(cell: string, runner: string, options?: RawAxiosRequestConfig): Promise<axios142.AxiosResponse<ProgramRun, any>>;
8383
8383
  /**
8384
8384
  * Get details about all existing program runners.
8385
8385
  * @summary List Program Runners
@@ -8387,7 +8387,7 @@ declare class ProgramApi extends BaseAPI {
8387
8387
  * @param {*} [options] Override http request option.
8388
8388
  * @throws {RequiredError}
8389
8389
  */
8390
- listProgramRunners(cell: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<ProgramRunnerReference[], any>>;
8390
+ listProgramRunners(cell: string, options?: RawAxiosRequestConfig): Promise<axios142.AxiosResponse<ProgramRunnerReference[], any>>;
8391
8391
  /**
8392
8392
  * Migrate a program ## Parameters See the **Schema** tab for information about the request body
8393
8393
  * @summary Migrate Program
@@ -8396,7 +8396,7 @@ declare class ProgramApi extends BaseAPI {
8396
8396
  * @param {*} [options] Override http request option.
8397
8397
  * @throws {RequiredError}
8398
8398
  */
8399
- migrateProgram(cell: string, request1: Request1, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<string, any>>;
8399
+ migrateProgram(cell: string, request1: Request1, options?: RawAxiosRequestConfig): Promise<axios142.AxiosResponse<string, any>>;
8400
8400
  /**
8401
8401
  * Plan a program based on the specified robot type. The plan operation can be used to check if a Wandelscript is executable, given the current joint configuration of the robot. If the Wandelscript is executable, the result contains the motion path. If the Wandelscript is not executable, e.g. points that are out of reach, or the joints encounter a singularity, the reason is returned. The plan operation can be used in other operating modes besides control mode. The Wandelscript can either be submitted as is, using Content-type text/plain, or as content-type application/json with the Wandelscript under \"code\" alongside a set of values provided under \"initial_state\". The plan operation can be used in other operating modes besides control mode. The Wandelscript can either be submitted as is, using Content-type text/plain, or as Content-type application/json with the Wandelscript under \"code\" alongside a set of values provided under \"initial_state\". * [WandelEngine & Wandelscript Documentation](/docs/docs/wandelscript)
8402
8402
  * @summary Plan Program
@@ -8406,7 +8406,7 @@ declare class ProgramApi extends BaseAPI {
8406
8406
  * @param {*} [options] Override http request option.
8407
8407
  * @throws {RequiredError}
8408
8408
  */
8409
- planProgram(cell: string, request: Request, identifier?: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<ProgramRun, any>>;
8409
+ planProgram(cell: string, request: Request, identifier?: string, options?: RawAxiosRequestConfig): Promise<axios142.AxiosResponse<ProgramRun, any>>;
8410
8410
  /**
8411
8411
  * Stop all runners.
8412
8412
  * @summary Stop All Program Runners
@@ -8414,7 +8414,7 @@ declare class ProgramApi extends BaseAPI {
8414
8414
  * @param {*} [options] Override http request option.
8415
8415
  * @throws {RequiredError}
8416
8416
  */
8417
- stopAllProgramRunner(cell: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<any, any>>;
8417
+ stopAllProgramRunner(cell: string, options?: RawAxiosRequestConfig): Promise<axios142.AxiosResponse<any, any>>;
8418
8418
  /**
8419
8419
  * Stop a specific program runner. If the indicated runner was not running, an error will be returned. ## Parameters - **runner_id**: The id of the program runner
8420
8420
  * @summary Stop Program Runner
@@ -8423,7 +8423,7 @@ declare class ProgramApi extends BaseAPI {
8423
8423
  * @param {*} [options] Override http request option.
8424
8424
  * @throws {RequiredError}
8425
8425
  */
8426
- stopProgramRunner(cell: string, runner: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
8426
+ stopProgramRunner(cell: string, runner: string, options?: RawAxiosRequestConfig): Promise<axios142.AxiosResponse<void, any>>;
8427
8427
  }
8428
8428
  /**
8429
8429
  * ProgramOperatorApi - axios parameter creator
@@ -8668,7 +8668,7 @@ declare class ProgramOperatorApi extends BaseAPI {
8668
8668
  * @param {*} [options] Override http request option.
8669
8669
  * @throws {RequiredError}
8670
8670
  */
8671
- createProgramRun(cell: string, createProgramRunRequest: CreateProgramRunRequest, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<CreateProgramRun200Response, any>>;
8671
+ createProgramRun(cell: string, createProgramRunRequest: CreateProgramRunRequest, options?: RawAxiosRequestConfig): Promise<axios142.AxiosResponse<CreateProgramRun200Response, any>>;
8672
8672
  /**
8673
8673
  * <!-- theme: danger --> > **Experimental** Creates a new trigger that automatically runs a program when certain conditions are met. Each trigger has a different configuration, and the configuration must be valid for the provided trigger type.
8674
8674
  * @summary Create Trigger
@@ -8677,7 +8677,7 @@ declare class ProgramOperatorApi extends BaseAPI {
8677
8677
  * @param {*} [options] Override http request option.
8678
8678
  * @throws {RequiredError}
8679
8679
  */
8680
- createTrigger(cell: string, createTriggerRequest: CreateTriggerRequest, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<CreateTrigger200Response, any>>;
8680
+ createTrigger(cell: string, createTriggerRequest: CreateTriggerRequest, options?: RawAxiosRequestConfig): Promise<axios142.AxiosResponse<CreateTrigger200Response, any>>;
8681
8681
  /**
8682
8682
  * <!-- theme: danger --> > **Experimental** Delete an existing trigger.
8683
8683
  * @summary Delete Trigger
@@ -8686,7 +8686,7 @@ declare class ProgramOperatorApi extends BaseAPI {
8686
8686
  * @param {*} [options] Override http request option.
8687
8687
  * @throws {RequiredError}
8688
8688
  */
8689
- deleteTrigger(trigger: string, cell: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
8689
+ deleteTrigger(trigger: string, cell: string, options?: RawAxiosRequestConfig): Promise<axios142.AxiosResponse<void, any>>;
8690
8690
  /**
8691
8691
  * <!-- theme: danger --> > **Experimental** Retrieves all program runs, including past and current executions. Use the optional `state` parameter to filter the results by their status.
8692
8692
  * @summary Get All Program Runs
@@ -8695,7 +8695,7 @@ declare class ProgramOperatorApi extends BaseAPI {
8695
8695
  * @param {*} [options] Override http request option.
8696
8696
  * @throws {RequiredError}
8697
8697
  */
8698
- getAllProgramRuns(cell: string, state?: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<GetAllProgramRuns200Response, any>>;
8698
+ getAllProgramRuns(cell: string, state?: string, options?: RawAxiosRequestConfig): Promise<axios142.AxiosResponse<GetAllProgramRuns200Response, any>>;
8699
8699
  /**
8700
8700
  * <!-- theme: danger --> > **Experimental** Returns all triggers in the system with the program runs caused by each trigger. You can use the program run id to get more details about a specific program run.
8701
8701
  * @summary Get All Triggers
@@ -8703,7 +8703,7 @@ declare class ProgramOperatorApi extends BaseAPI {
8703
8703
  * @param {*} [options] Override http request option.
8704
8704
  * @throws {RequiredError}
8705
8705
  */
8706
- getAllTriggers(cell: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<GetAllTriggers200Response, any>>;
8706
+ getAllTriggers(cell: string, options?: RawAxiosRequestConfig): Promise<axios142.AxiosResponse<GetAllTriggers200Response, any>>;
8707
8707
  /**
8708
8708
  * <!-- theme: danger --> > **Experimental** Retrieves detailed information about a specific program run.
8709
8709
  * @summary Get Program Run
@@ -8712,7 +8712,7 @@ declare class ProgramOperatorApi extends BaseAPI {
8712
8712
  * @param {*} [options] Override http request option.
8713
8713
  * @throws {RequiredError}
8714
8714
  */
8715
- getProgramRun(run: string, cell: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<ProgramRunObject, any>>;
8715
+ getProgramRun(run: string, cell: string, options?: RawAxiosRequestConfig): Promise<axios142.AxiosResponse<ProgramRunObject, any>>;
8716
8716
  /**
8717
8717
  * <!-- theme: danger --> > **Experimental** Retrieves detailed information about a specific trigger.
8718
8718
  * @summary Get Trigger
@@ -8721,7 +8721,7 @@ declare class ProgramOperatorApi extends BaseAPI {
8721
8721
  * @param {*} [options] Override http request option.
8722
8722
  * @throws {RequiredError}
8723
8723
  */
8724
- getTrigger(trigger: string, cell: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<TriggerObject, any>>;
8724
+ getTrigger(trigger: string, cell: string, options?: RawAxiosRequestConfig): Promise<axios142.AxiosResponse<TriggerObject, any>>;
8725
8725
  /**
8726
8726
  * <!-- theme: danger --> > **Experimental** Updates the details of an existing trigger The exact behavior of switching a trigger from active to inactive or vice versa is not defined yet.
8727
8727
  * @summary Update Trigger
@@ -8731,7 +8731,7 @@ declare class ProgramOperatorApi extends BaseAPI {
8731
8731
  * @param {*} [options] Override http request option.
8732
8732
  * @throws {RequiredError}
8733
8733
  */
8734
- updateTrigger(trigger: string, cell: string, updateTriggerRequest: UpdateTriggerRequest, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<TriggerObject, any>>;
8734
+ updateTrigger(trigger: string, cell: string, updateTriggerRequest: UpdateTriggerRequest, options?: RawAxiosRequestConfig): Promise<axios142.AxiosResponse<TriggerObject, any>>;
8735
8735
  }
8736
8736
  /**
8737
8737
  * ProgramValuesApi - axios parameter creator
@@ -8747,7 +8747,7 @@ declare const ProgramValuesApiAxiosParamCreator: (configuration?: Configuration)
8747
8747
  */
8748
8748
  clearProgramsValues: (cell: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
8749
8749
  /**
8750
- * Deprecated endpoint. Add or overwrite one or more values in the database. PREREQUISITE: The database has been added as a device. Add the database with [createDevice](createDevice). The database itself is a key-value store. For reference of possible data types see: * [Documentation for elementary data types](/docs/docs/wandelscript/data-types/#elementary-types)
8750
+ * Deprecated endpoint. Add or overwrite one or more values in the database. PREREQUISITE: The database has been added as a device. Add the database with [createDevice](#/operations/createDevice). The database itself is a key-value store. For reference of possible data types see: * [Documentation for elementary data types](/docs/docs/wandelscript/data-types/#elementary-types)
8751
8751
  * @summary Add Value(s)
8752
8752
  * @param {string} cell Unique identifier addressing a cell in all API calls.
8753
8753
  * @param {{ [key: string]: CollectionValue; }} requestBody
@@ -8769,7 +8769,7 @@ declare const ProgramValuesApiAxiosParamCreator: (configuration?: Configuration)
8769
8769
  */
8770
8770
  deleteProgramValue: (cell: string, key: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
8771
8771
  /**
8772
- * Deprecated endpoint. Return a value stored in the database. PREREQUISITE: The database has been added as a device. Add the database with [createDevice](createDevice). The database itself is a key-value store. For reference of possible data types see: * [Documentation for elementary data types](/docs/docs/wandelscript/data-types/#elementary-types)
8772
+ * Deprecated endpoint. Return a value stored in the database. PREREQUISITE: The database has been added as a device. Add the database with [createDevice](#/operations/createDevice). The database itself is a key-value store. For reference of possible data types see: * [Documentation for elementary data types](/docs/docs/wandelscript/data-types/#elementary-types)
8773
8773
  * @summary Get Value
8774
8774
  * @param {string} cell Unique identifier addressing a cell in all API calls.
8775
8775
  * @param {string} key
@@ -8779,7 +8779,7 @@ declare const ProgramValuesApiAxiosParamCreator: (configuration?: Configuration)
8779
8779
  */
8780
8780
  getProgramValue: (cell: string, key: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
8781
8781
  /**
8782
- * Deprecated endpoint. Gets all values that are stored in the database. PREREQUISITE: The database has been added as a device. Add the database with [createDevice](createDevice). The database itself is a key-value storage. For reference of possible data types see: * [Documentation for elementary data types](/docs/docs/wandelscript/data-types/#elementary-types)
8782
+ * Deprecated endpoint. Gets all values that are stored in the database. PREREQUISITE: The database has been added as a device. Add the database with [createDevice](#/operations/createDevice). The database itself is a key-value storage. For reference of possible data types see: * [Documentation for elementary data types](/docs/docs/wandelscript/data-types/#elementary-types)
8783
8783
  * @summary Get Values
8784
8784
  * @param {string} cell Unique identifier addressing a cell in all API calls.
8785
8785
  * @param {*} [options] Override http request option.
@@ -8788,7 +8788,7 @@ declare const ProgramValuesApiAxiosParamCreator: (configuration?: Configuration)
8788
8788
  */
8789
8789
  listProgramsValues: (cell: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
8790
8790
  /**
8791
- * Deprecated endpoint. Creates or updates a value in the database. PREREQUISITE: The database has been added as a device. Add the database with [createDevice](createDevice). The database itself is a key-value store. For reference of possible data types see: * [Documentation for elementary data types](/docs/docs/wandelscript/data-types/#elementary-types)
8791
+ * Deprecated endpoint. Creates or updates a value in the database. PREREQUISITE: The database has been added as a device. Add the database with [createDevice](#/operations/createDevice). The database itself is a key-value store. For reference of possible data types see: * [Documentation for elementary data types](/docs/docs/wandelscript/data-types/#elementary-types)
8792
8792
  * @summary Create or Update Value
8793
8793
  * @param {string} cell Unique identifier addressing a cell in all API calls.
8794
8794
  * @param {string} key
@@ -8813,7 +8813,7 @@ declare const ProgramValuesApiFp: (configuration?: Configuration) => {
8813
8813
  */
8814
8814
  clearProgramsValues(cell: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
8815
8815
  /**
8816
- * Deprecated endpoint. Add or overwrite one or more values in the database. PREREQUISITE: The database has been added as a device. Add the database with [createDevice](createDevice). The database itself is a key-value store. For reference of possible data types see: * [Documentation for elementary data types](/docs/docs/wandelscript/data-types/#elementary-types)
8816
+ * Deprecated endpoint. Add or overwrite one or more values in the database. PREREQUISITE: The database has been added as a device. Add the database with [createDevice](#/operations/createDevice). The database itself is a key-value store. For reference of possible data types see: * [Documentation for elementary data types](/docs/docs/wandelscript/data-types/#elementary-types)
8817
8817
  * @summary Add Value(s)
8818
8818
  * @param {string} cell Unique identifier addressing a cell in all API calls.
8819
8819
  * @param {{ [key: string]: CollectionValue; }} requestBody
@@ -8835,7 +8835,7 @@ declare const ProgramValuesApiFp: (configuration?: Configuration) => {
8835
8835
  */
8836
8836
  deleteProgramValue(cell: string, key: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
8837
8837
  /**
8838
- * Deprecated endpoint. Return a value stored in the database. PREREQUISITE: The database has been added as a device. Add the database with [createDevice](createDevice). The database itself is a key-value store. For reference of possible data types see: * [Documentation for elementary data types](/docs/docs/wandelscript/data-types/#elementary-types)
8838
+ * Deprecated endpoint. Return a value stored in the database. PREREQUISITE: The database has been added as a device. Add the database with [createDevice](#/operations/createDevice). The database itself is a key-value store. For reference of possible data types see: * [Documentation for elementary data types](/docs/docs/wandelscript/data-types/#elementary-types)
8839
8839
  * @summary Get Value
8840
8840
  * @param {string} cell Unique identifier addressing a cell in all API calls.
8841
8841
  * @param {string} key
@@ -8845,7 +8845,7 @@ declare const ProgramValuesApiFp: (configuration?: Configuration) => {
8845
8845
  */
8846
8846
  getProgramValue(cell: string, key: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ResponseGetValueProgramsValuesKeyGet>>;
8847
8847
  /**
8848
- * Deprecated endpoint. Gets all values that are stored in the database. PREREQUISITE: The database has been added as a device. Add the database with [createDevice](createDevice). The database itself is a key-value storage. For reference of possible data types see: * [Documentation for elementary data types](/docs/docs/wandelscript/data-types/#elementary-types)
8848
+ * Deprecated endpoint. Gets all values that are stored in the database. PREREQUISITE: The database has been added as a device. Add the database with [createDevice](#/operations/createDevice). The database itself is a key-value storage. For reference of possible data types see: * [Documentation for elementary data types](/docs/docs/wandelscript/data-types/#elementary-types)
8849
8849
  * @summary Get Values
8850
8850
  * @param {string} cell Unique identifier addressing a cell in all API calls.
8851
8851
  * @param {*} [options] Override http request option.
@@ -8856,7 +8856,7 @@ declare const ProgramValuesApiFp: (configuration?: Configuration) => {
8856
8856
  [key: string]: ResponseGetValuesProgramsValuesGetValue;
8857
8857
  }>>;
8858
8858
  /**
8859
- * Deprecated endpoint. Creates or updates a value in the database. PREREQUISITE: The database has been added as a device. Add the database with [createDevice](createDevice). The database itself is a key-value store. For reference of possible data types see: * [Documentation for elementary data types](/docs/docs/wandelscript/data-types/#elementary-types)
8859
+ * Deprecated endpoint. Creates or updates a value in the database. PREREQUISITE: The database has been added as a device. Add the database with [createDevice](#/operations/createDevice). The database itself is a key-value store. For reference of possible data types see: * [Documentation for elementary data types](/docs/docs/wandelscript/data-types/#elementary-types)
8860
8860
  * @summary Create or Update Value
8861
8861
  * @param {string} cell Unique identifier addressing a cell in all API calls.
8862
8862
  * @param {string} key
@@ -8881,7 +8881,7 @@ declare const ProgramValuesApiFactory: (configuration?: Configuration, basePath?
8881
8881
  */
8882
8882
  clearProgramsValues(cell: string, options?: RawAxiosRequestConfig): AxiosPromise<void>;
8883
8883
  /**
8884
- * Deprecated endpoint. Add or overwrite one or more values in the database. PREREQUISITE: The database has been added as a device. Add the database with [createDevice](createDevice). The database itself is a key-value store. For reference of possible data types see: * [Documentation for elementary data types](/docs/docs/wandelscript/data-types/#elementary-types)
8884
+ * Deprecated endpoint. Add or overwrite one or more values in the database. PREREQUISITE: The database has been added as a device. Add the database with [createDevice](#/operations/createDevice). The database itself is a key-value store. For reference of possible data types see: * [Documentation for elementary data types](/docs/docs/wandelscript/data-types/#elementary-types)
8885
8885
  * @summary Add Value(s)
8886
8886
  * @param {string} cell Unique identifier addressing a cell in all API calls.
8887
8887
  * @param {{ [key: string]: CollectionValue; }} requestBody
@@ -8903,7 +8903,7 @@ declare const ProgramValuesApiFactory: (configuration?: Configuration, basePath?
8903
8903
  */
8904
8904
  deleteProgramValue(cell: string, key: string, options?: RawAxiosRequestConfig): AxiosPromise<void>;
8905
8905
  /**
8906
- * Deprecated endpoint. Return a value stored in the database. PREREQUISITE: The database has been added as a device. Add the database with [createDevice](createDevice). The database itself is a key-value store. For reference of possible data types see: * [Documentation for elementary data types](/docs/docs/wandelscript/data-types/#elementary-types)
8906
+ * Deprecated endpoint. Return a value stored in the database. PREREQUISITE: The database has been added as a device. Add the database with [createDevice](#/operations/createDevice). The database itself is a key-value store. For reference of possible data types see: * [Documentation for elementary data types](/docs/docs/wandelscript/data-types/#elementary-types)
8907
8907
  * @summary Get Value
8908
8908
  * @param {string} cell Unique identifier addressing a cell in all API calls.
8909
8909
  * @param {string} key
@@ -8913,7 +8913,7 @@ declare const ProgramValuesApiFactory: (configuration?: Configuration, basePath?
8913
8913
  */
8914
8914
  getProgramValue(cell: string, key: string, options?: RawAxiosRequestConfig): AxiosPromise<ResponseGetValueProgramsValuesKeyGet>;
8915
8915
  /**
8916
- * Deprecated endpoint. Gets all values that are stored in the database. PREREQUISITE: The database has been added as a device. Add the database with [createDevice](createDevice). The database itself is a key-value storage. For reference of possible data types see: * [Documentation for elementary data types](/docs/docs/wandelscript/data-types/#elementary-types)
8916
+ * Deprecated endpoint. Gets all values that are stored in the database. PREREQUISITE: The database has been added as a device. Add the database with [createDevice](#/operations/createDevice). The database itself is a key-value storage. For reference of possible data types see: * [Documentation for elementary data types](/docs/docs/wandelscript/data-types/#elementary-types)
8917
8917
  * @summary Get Values
8918
8918
  * @param {string} cell Unique identifier addressing a cell in all API calls.
8919
8919
  * @param {*} [options] Override http request option.
@@ -8924,7 +8924,7 @@ declare const ProgramValuesApiFactory: (configuration?: Configuration, basePath?
8924
8924
  [key: string]: ResponseGetValuesProgramsValuesGetValue;
8925
8925
  }>;
8926
8926
  /**
8927
- * Deprecated endpoint. Creates or updates a value in the database. PREREQUISITE: The database has been added as a device. Add the database with [createDevice](createDevice). The database itself is a key-value store. For reference of possible data types see: * [Documentation for elementary data types](/docs/docs/wandelscript/data-types/#elementary-types)
8927
+ * Deprecated endpoint. Creates or updates a value in the database. PREREQUISITE: The database has been added as a device. Add the database with [createDevice](#/operations/createDevice). The database itself is a key-value store. For reference of possible data types see: * [Documentation for elementary data types](/docs/docs/wandelscript/data-types/#elementary-types)
8928
8928
  * @summary Create or Update Value
8929
8929
  * @param {string} cell Unique identifier addressing a cell in all API calls.
8930
8930
  * @param {string} key
@@ -8947,9 +8947,9 @@ declare class ProgramValuesApi extends BaseAPI {
8947
8947
  * @deprecated
8948
8948
  * @throws {RequiredError}
8949
8949
  */
8950
- clearProgramsValues(cell: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
8950
+ clearProgramsValues(cell: string, options?: RawAxiosRequestConfig): Promise<axios142.AxiosResponse<void, any>>;
8951
8951
  /**
8952
- * Deprecated endpoint. Add or overwrite one or more values in the database. PREREQUISITE: The database has been added as a device. Add the database with [createDevice](createDevice). The database itself is a key-value store. For reference of possible data types see: * [Documentation for elementary data types](/docs/docs/wandelscript/data-types/#elementary-types)
8952
+ * Deprecated endpoint. Add or overwrite one or more values in the database. PREREQUISITE: The database has been added as a device. Add the database with [createDevice](#/operations/createDevice). The database itself is a key-value store. For reference of possible data types see: * [Documentation for elementary data types](/docs/docs/wandelscript/data-types/#elementary-types)
8953
8953
  * @summary Add Value(s)
8954
8954
  * @param {string} cell Unique identifier addressing a cell in all API calls.
8955
8955
  * @param {{ [key: string]: CollectionValue; }} requestBody
@@ -8959,7 +8959,7 @@ declare class ProgramValuesApi extends BaseAPI {
8959
8959
  */
8960
8960
  createProgramsValue(cell: string, requestBody: {
8961
8961
  [key: string]: CollectionValue;
8962
- }, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
8962
+ }, options?: RawAxiosRequestConfig): Promise<axios142.AxiosResponse<void, any>>;
8963
8963
  /**
8964
8964
  * Delete a value from the database.
8965
8965
  * @summary Delete Value
@@ -8969,9 +8969,9 @@ declare class ProgramValuesApi extends BaseAPI {
8969
8969
  * @deprecated
8970
8970
  * @throws {RequiredError}
8971
8971
  */
8972
- deleteProgramValue(cell: string, key: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
8972
+ deleteProgramValue(cell: string, key: string, options?: RawAxiosRequestConfig): Promise<axios142.AxiosResponse<void, any>>;
8973
8973
  /**
8974
- * Deprecated endpoint. Return a value stored in the database. PREREQUISITE: The database has been added as a device. Add the database with [createDevice](createDevice). The database itself is a key-value store. For reference of possible data types see: * [Documentation for elementary data types](/docs/docs/wandelscript/data-types/#elementary-types)
8974
+ * Deprecated endpoint. Return a value stored in the database. PREREQUISITE: The database has been added as a device. Add the database with [createDevice](#/operations/createDevice). The database itself is a key-value store. For reference of possible data types see: * [Documentation for elementary data types](/docs/docs/wandelscript/data-types/#elementary-types)
8975
8975
  * @summary Get Value
8976
8976
  * @param {string} cell Unique identifier addressing a cell in all API calls.
8977
8977
  * @param {string} key
@@ -8979,20 +8979,20 @@ declare class ProgramValuesApi extends BaseAPI {
8979
8979
  * @deprecated
8980
8980
  * @throws {RequiredError}
8981
8981
  */
8982
- getProgramValue(cell: string, key: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<ResponseGetValueProgramsValuesKeyGet, any>>;
8982
+ getProgramValue(cell: string, key: string, options?: RawAxiosRequestConfig): Promise<axios142.AxiosResponse<ResponseGetValueProgramsValuesKeyGet, any>>;
8983
8983
  /**
8984
- * Deprecated endpoint. Gets all values that are stored in the database. PREREQUISITE: The database has been added as a device. Add the database with [createDevice](createDevice). The database itself is a key-value storage. For reference of possible data types see: * [Documentation for elementary data types](/docs/docs/wandelscript/data-types/#elementary-types)
8984
+ * Deprecated endpoint. Gets all values that are stored in the database. PREREQUISITE: The database has been added as a device. Add the database with [createDevice](#/operations/createDevice). The database itself is a key-value storage. For reference of possible data types see: * [Documentation for elementary data types](/docs/docs/wandelscript/data-types/#elementary-types)
8985
8985
  * @summary Get Values
8986
8986
  * @param {string} cell Unique identifier addressing a cell in all API calls.
8987
8987
  * @param {*} [options] Override http request option.
8988
8988
  * @deprecated
8989
8989
  * @throws {RequiredError}
8990
8990
  */
8991
- listProgramsValues(cell: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<{
8991
+ listProgramsValues(cell: string, options?: RawAxiosRequestConfig): Promise<axios142.AxiosResponse<{
8992
8992
  [key: string]: ResponseGetValuesProgramsValuesGetValue;
8993
8993
  }, any>>;
8994
8994
  /**
8995
- * Deprecated endpoint. Creates or updates a value in the database. PREREQUISITE: The database has been added as a device. Add the database with [createDevice](createDevice). The database itself is a key-value store. For reference of possible data types see: * [Documentation for elementary data types](/docs/docs/wandelscript/data-types/#elementary-types)
8995
+ * Deprecated endpoint. Creates or updates a value in the database. PREREQUISITE: The database has been added as a device. Add the database with [createDevice](#/operations/createDevice). The database itself is a key-value store. For reference of possible data types see: * [Documentation for elementary data types](/docs/docs/wandelscript/data-types/#elementary-types)
8996
8996
  * @summary Create or Update Value
8997
8997
  * @param {string} cell Unique identifier addressing a cell in all API calls.
8998
8998
  * @param {string} key
@@ -9001,7 +9001,7 @@ declare class ProgramValuesApi extends BaseAPI {
9001
9001
  * @deprecated
9002
9002
  * @throws {RequiredError}
9003
9003
  */
9004
- updateProgramValue(cell: string, key: string, value: Value, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
9004
+ updateProgramValue(cell: string, key: string, value: Value, options?: RawAxiosRequestConfig): Promise<axios142.AxiosResponse<void, any>>;
9005
9005
  }
9006
9006
  /**
9007
9007
  * StoreCollisionComponentsApi - axios parameter creator
@@ -9035,10 +9035,10 @@ declare const StoreCollisionComponentsApiAxiosParamCreator: (configuration?: Con
9035
9035
  */
9036
9036
  deleteStoredCollisionTool: (cell: string, tool: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
9037
9037
  /**
9038
- * Deprecated endpoint. Use [getCollisionModel](https://portal.wandelbots.io/docs/api/v2/ui/#/operations/getMotionGroupCollisionModel) instead. Returns the default collision link chain for a given motion group model. See [getPlanningMotionGroupModels](getPlanningMotionGroupModels) for supported motion group models. The default link chain is derived from 3D models and optimized for collision detection within NOVA. The default link chain includes link shapes only. It does not include any attached components like wire feeders or sensors. Use the `stored_link_chain` or `link_chain` field in [storeCollisionScene](storeCollisionScene) to attach additional shapes to the link reference frames. Additional shapes may overlap each other per link and may also overlap the respective link\'s default shape.
9038
+ * Deprecated endpoint. Use [getCollisionModel](https://portal.wandelbots.io/docs/api/v2/ui/#/operations/getMotionGroupCollisionModel) instead. Returns the default collision link chain for a given motion group model. See [getPlanningMotionGroupModels](#/operations/getPlanningMotionGroupModels) for supported motion group models. The default link chain is derived from 3D models and optimized for collision detection within NOVA. The default link chain includes link shapes only. It does not include any attached components like wire feeders or sensors. Use the `stored_link_chain` or `link_chain` field in [storeCollisionScene](#/operations/storeCollisionScene) to attach additional shapes to the link reference frames. Additional shapes may overlap each other per link and may also overlap the respective link\'s default shape.
9039
9039
  * @summary Get Default Link Chain
9040
9040
  * @param {string} cell Unique identifier addressing a cell in all API calls.
9041
- * @param {GetDefaultLinkChainMotionGroupModelEnum} motionGroupModel Unique identifier for the type of a motion group (robot model). Get the model name for a configured motion group from [getOptimizerConfiguration](getOptimizerConfiguration).
9041
+ * @param {GetDefaultLinkChainMotionGroupModelEnum} motionGroupModel Unique identifier for the type of a motion group (robot model). Get the model name for a configured motion group from [getOptimizerConfiguration](#/operations/getOptimizerConfiguration).
9042
9042
  * @param {*} [options] Override http request option.
9043
9043
  * @deprecated
9044
9044
  * @throws {RequiredError}
@@ -9162,10 +9162,10 @@ declare const StoreCollisionComponentsApiFp: (configuration?: Configuration) =>
9162
9162
  */
9163
9163
  deleteStoredCollisionTool(cell: string, tool: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
9164
9164
  /**
9165
- * Deprecated endpoint. Use [getCollisionModel](https://portal.wandelbots.io/docs/api/v2/ui/#/operations/getMotionGroupCollisionModel) instead. Returns the default collision link chain for a given motion group model. See [getPlanningMotionGroupModels](getPlanningMotionGroupModels) for supported motion group models. The default link chain is derived from 3D models and optimized for collision detection within NOVA. The default link chain includes link shapes only. It does not include any attached components like wire feeders or sensors. Use the `stored_link_chain` or `link_chain` field in [storeCollisionScene](storeCollisionScene) to attach additional shapes to the link reference frames. Additional shapes may overlap each other per link and may also overlap the respective link\'s default shape.
9165
+ * Deprecated endpoint. Use [getCollisionModel](https://portal.wandelbots.io/docs/api/v2/ui/#/operations/getMotionGroupCollisionModel) instead. Returns the default collision link chain for a given motion group model. See [getPlanningMotionGroupModels](#/operations/getPlanningMotionGroupModels) for supported motion group models. The default link chain is derived from 3D models and optimized for collision detection within NOVA. The default link chain includes link shapes only. It does not include any attached components like wire feeders or sensors. Use the `stored_link_chain` or `link_chain` field in [storeCollisionScene](#/operations/storeCollisionScene) to attach additional shapes to the link reference frames. Additional shapes may overlap each other per link and may also overlap the respective link\'s default shape.
9166
9166
  * @summary Get Default Link Chain
9167
9167
  * @param {string} cell Unique identifier addressing a cell in all API calls.
9168
- * @param {GetDefaultLinkChainMotionGroupModelEnum} motionGroupModel Unique identifier for the type of a motion group (robot model). Get the model name for a configured motion group from [getOptimizerConfiguration](getOptimizerConfiguration).
9168
+ * @param {GetDefaultLinkChainMotionGroupModelEnum} motionGroupModel Unique identifier for the type of a motion group (robot model). Get the model name for a configured motion group from [getOptimizerConfiguration](#/operations/getOptimizerConfiguration).
9169
9169
  * @param {*} [options] Override http request option.
9170
9170
  * @deprecated
9171
9171
  * @throws {RequiredError}
@@ -9309,10 +9309,10 @@ declare const StoreCollisionComponentsApiFactory: (configuration?: Configuration
9309
9309
  */
9310
9310
  deleteStoredCollisionTool(cell: string, tool: string, options?: RawAxiosRequestConfig): AxiosPromise<void>;
9311
9311
  /**
9312
- * Deprecated endpoint. Use [getCollisionModel](https://portal.wandelbots.io/docs/api/v2/ui/#/operations/getMotionGroupCollisionModel) instead. Returns the default collision link chain for a given motion group model. See [getPlanningMotionGroupModels](getPlanningMotionGroupModels) for supported motion group models. The default link chain is derived from 3D models and optimized for collision detection within NOVA. The default link chain includes link shapes only. It does not include any attached components like wire feeders or sensors. Use the `stored_link_chain` or `link_chain` field in [storeCollisionScene](storeCollisionScene) to attach additional shapes to the link reference frames. Additional shapes may overlap each other per link and may also overlap the respective link\'s default shape.
9312
+ * Deprecated endpoint. Use [getCollisionModel](https://portal.wandelbots.io/docs/api/v2/ui/#/operations/getMotionGroupCollisionModel) instead. Returns the default collision link chain for a given motion group model. See [getPlanningMotionGroupModels](#/operations/getPlanningMotionGroupModels) for supported motion group models. The default link chain is derived from 3D models and optimized for collision detection within NOVA. The default link chain includes link shapes only. It does not include any attached components like wire feeders or sensors. Use the `stored_link_chain` or `link_chain` field in [storeCollisionScene](#/operations/storeCollisionScene) to attach additional shapes to the link reference frames. Additional shapes may overlap each other per link and may also overlap the respective link\'s default shape.
9313
9313
  * @summary Get Default Link Chain
9314
9314
  * @param {string} cell Unique identifier addressing a cell in all API calls.
9315
- * @param {GetDefaultLinkChainMotionGroupModelEnum} motionGroupModel Unique identifier for the type of a motion group (robot model). Get the model name for a configured motion group from [getOptimizerConfiguration](getOptimizerConfiguration).
9315
+ * @param {GetDefaultLinkChainMotionGroupModelEnum} motionGroupModel Unique identifier for the type of a motion group (robot model). Get the model name for a configured motion group from [getOptimizerConfiguration](#/operations/getOptimizerConfiguration).
9316
9316
  * @param {*} [options] Override http request option.
9317
9317
  * @deprecated
9318
9318
  * @throws {RequiredError}
@@ -9436,7 +9436,7 @@ declare class StoreCollisionComponentsApi extends BaseAPI {
9436
9436
  * @param {*} [options] Override http request option.
9437
9437
  * @throws {RequiredError}
9438
9438
  */
9439
- deleteStoredCollider(cell: string, collider: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
9439
+ deleteStoredCollider(cell: string, collider: string, options?: RawAxiosRequestConfig): Promise<axios142.AxiosResponse<void, any>>;
9440
9440
  /**
9441
9441
  * Deletes the stored link chain. <!-- theme: danger --> > This will delete persistently stored data.
9442
9442
  * @summary Delete Link Chain
@@ -9445,7 +9445,7 @@ declare class StoreCollisionComponentsApi extends BaseAPI {
9445
9445
  * @param {*} [options] Override http request option.
9446
9446
  * @throws {RequiredError}
9447
9447
  */
9448
- deleteStoredCollisionLinkChain(cell: string, linkChain: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
9448
+ deleteStoredCollisionLinkChain(cell: string, linkChain: string, options?: RawAxiosRequestConfig): Promise<axios142.AxiosResponse<void, any>>;
9449
9449
  /**
9450
9450
  * Deletes the stored tool. <!-- theme: danger --> > This will delete persistently stored data.
9451
9451
  * @summary Delete Tool
@@ -9454,17 +9454,17 @@ declare class StoreCollisionComponentsApi extends BaseAPI {
9454
9454
  * @param {*} [options] Override http request option.
9455
9455
  * @throws {RequiredError}
9456
9456
  */
9457
- deleteStoredCollisionTool(cell: string, tool: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
9457
+ deleteStoredCollisionTool(cell: string, tool: string, options?: RawAxiosRequestConfig): Promise<axios142.AxiosResponse<void, any>>;
9458
9458
  /**
9459
- * Deprecated endpoint. Use [getCollisionModel](https://portal.wandelbots.io/docs/api/v2/ui/#/operations/getMotionGroupCollisionModel) instead. Returns the default collision link chain for a given motion group model. See [getPlanningMotionGroupModels](getPlanningMotionGroupModels) for supported motion group models. The default link chain is derived from 3D models and optimized for collision detection within NOVA. The default link chain includes link shapes only. It does not include any attached components like wire feeders or sensors. Use the `stored_link_chain` or `link_chain` field in [storeCollisionScene](storeCollisionScene) to attach additional shapes to the link reference frames. Additional shapes may overlap each other per link and may also overlap the respective link\'s default shape.
9459
+ * Deprecated endpoint. Use [getCollisionModel](https://portal.wandelbots.io/docs/api/v2/ui/#/operations/getMotionGroupCollisionModel) instead. Returns the default collision link chain for a given motion group model. See [getPlanningMotionGroupModels](#/operations/getPlanningMotionGroupModels) for supported motion group models. The default link chain is derived from 3D models and optimized for collision detection within NOVA. The default link chain includes link shapes only. It does not include any attached components like wire feeders or sensors. Use the `stored_link_chain` or `link_chain` field in [storeCollisionScene](#/operations/storeCollisionScene) to attach additional shapes to the link reference frames. Additional shapes may overlap each other per link and may also overlap the respective link\'s default shape.
9460
9460
  * @summary Get Default Link Chain
9461
9461
  * @param {string} cell Unique identifier addressing a cell in all API calls.
9462
- * @param {GetDefaultLinkChainMotionGroupModelEnum} motionGroupModel Unique identifier for the type of a motion group (robot model). Get the model name for a configured motion group from [getOptimizerConfiguration](getOptimizerConfiguration).
9462
+ * @param {GetDefaultLinkChainMotionGroupModelEnum} motionGroupModel Unique identifier for the type of a motion group (robot model). Get the model name for a configured motion group from [getOptimizerConfiguration](#/operations/getOptimizerConfiguration).
9463
9463
  * @param {*} [options] Override http request option.
9464
9464
  * @deprecated
9465
9465
  * @throws {RequiredError}
9466
9466
  */
9467
- getDefaultLinkChain(cell: string, motionGroupModel: GetDefaultLinkChainMotionGroupModelEnum, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<{
9467
+ getDefaultLinkChain(cell: string, motionGroupModel: GetDefaultLinkChainMotionGroupModelEnum, options?: RawAxiosRequestConfig): Promise<axios142.AxiosResponse<{
9468
9468
  [key: string]: Collider;
9469
9469
  }[], any>>;
9470
9470
  /**
@@ -9475,7 +9475,7 @@ declare class StoreCollisionComponentsApi extends BaseAPI {
9475
9475
  * @param {*} [options] Override http request option.
9476
9476
  * @throws {RequiredError}
9477
9477
  */
9478
- getStoredCollider(cell: string, collider: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<Collider, any>>;
9478
+ getStoredCollider(cell: string, collider: string, options?: RawAxiosRequestConfig): Promise<axios142.AxiosResponse<Collider, any>>;
9479
9479
  /**
9480
9480
  * Returns the collision link chain.
9481
9481
  * @summary Get Link Chain
@@ -9484,7 +9484,7 @@ declare class StoreCollisionComponentsApi extends BaseAPI {
9484
9484
  * @param {*} [options] Override http request option.
9485
9485
  * @throws {RequiredError}
9486
9486
  */
9487
- getStoredCollisionLinkChain(cell: string, linkChain: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<{
9487
+ getStoredCollisionLinkChain(cell: string, linkChain: string, options?: RawAxiosRequestConfig): Promise<axios142.AxiosResponse<{
9488
9488
  [key: string]: Collider;
9489
9489
  }[], any>>;
9490
9490
  /**
@@ -9495,7 +9495,7 @@ declare class StoreCollisionComponentsApi extends BaseAPI {
9495
9495
  * @param {*} [options] Override http request option.
9496
9496
  * @throws {RequiredError}
9497
9497
  */
9498
- getStoredCollisionTool(cell: string, tool: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<{
9498
+ getStoredCollisionTool(cell: string, tool: string, options?: RawAxiosRequestConfig): Promise<axios142.AxiosResponse<{
9499
9499
  [key: string]: Collider;
9500
9500
  }, any>>;
9501
9501
  /**
@@ -9505,7 +9505,7 @@ declare class StoreCollisionComponentsApi extends BaseAPI {
9505
9505
  * @param {*} [options] Override http request option.
9506
9506
  * @throws {RequiredError}
9507
9507
  */
9508
- listCollisionLinkChains(cell: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<{
9508
+ listCollisionLinkChains(cell: string, options?: RawAxiosRequestConfig): Promise<axios142.AxiosResponse<{
9509
9509
  [key: string]: {
9510
9510
  [key: string]: Collider;
9511
9511
  }[];
@@ -9517,7 +9517,7 @@ declare class StoreCollisionComponentsApi extends BaseAPI {
9517
9517
  * @param {*} [options] Override http request option.
9518
9518
  * @throws {RequiredError}
9519
9519
  */
9520
- listStoredColliders(cell: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<{
9520
+ listStoredColliders(cell: string, options?: RawAxiosRequestConfig): Promise<axios142.AxiosResponse<{
9521
9521
  [key: string]: Collider;
9522
9522
  }, any>>;
9523
9523
  /**
@@ -9527,7 +9527,7 @@ declare class StoreCollisionComponentsApi extends BaseAPI {
9527
9527
  * @param {*} [options] Override http request option.
9528
9528
  * @throws {RequiredError}
9529
9529
  */
9530
- listStoredCollisionTools(cell: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<{
9530
+ listStoredCollisionTools(cell: string, options?: RawAxiosRequestConfig): Promise<axios142.AxiosResponse<{
9531
9531
  [key: string]: {
9532
9532
  [key: string]: Collider;
9533
9533
  };
@@ -9541,7 +9541,7 @@ declare class StoreCollisionComponentsApi extends BaseAPI {
9541
9541
  * @param {*} [options] Override http request option.
9542
9542
  * @throws {RequiredError}
9543
9543
  */
9544
- storeCollider(cell: string, collider: string, collider2: Collider, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<Collider, any>>;
9544
+ storeCollider(cell: string, collider: string, collider2: Collider, options?: RawAxiosRequestConfig): Promise<axios142.AxiosResponse<Collider, any>>;
9545
9545
  /**
9546
9546
  * Stores link chain. If the link chain does not exist, it will be created. If the link chain exists, it will be updated.
9547
9547
  * @summary Store Link Chain
@@ -9553,7 +9553,7 @@ declare class StoreCollisionComponentsApi extends BaseAPI {
9553
9553
  */
9554
9554
  storeCollisionLinkChain(cell: string, linkChain: string, collider: Array<{
9555
9555
  [key: string]: Collider;
9556
- }>, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<{
9556
+ }>, options?: RawAxiosRequestConfig): Promise<axios142.AxiosResponse<{
9557
9557
  [key: string]: Collider;
9558
9558
  }[], any>>;
9559
9559
  /**
@@ -9567,7 +9567,7 @@ declare class StoreCollisionComponentsApi extends BaseAPI {
9567
9567
  */
9568
9568
  storeCollisionTool(cell: string, tool: string, requestBody: {
9569
9569
  [key: string]: Collider;
9570
- }, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<{
9570
+ }, options?: RawAxiosRequestConfig): Promise<axios142.AxiosResponse<{
9571
9571
  [key: string]: Collider;
9572
9572
  }, any>>;
9573
9573
  }
@@ -9882,7 +9882,7 @@ declare class StoreCollisionScenesApi extends BaseAPI {
9882
9882
  * @param {*} [options] Override http request option.
9883
9883
  * @throws {RequiredError}
9884
9884
  */
9885
- deleteStoredCollisionScene(cell: string, scene: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
9885
+ deleteStoredCollisionScene(cell: string, scene: string, options?: RawAxiosRequestConfig): Promise<axios142.AxiosResponse<void, any>>;
9886
9886
  /**
9887
9887
  * Returns the stored scene.
9888
9888
  * @summary Get Scene
@@ -9891,7 +9891,7 @@ declare class StoreCollisionScenesApi extends BaseAPI {
9891
9891
  * @param {*} [options] Override http request option.
9892
9892
  * @throws {RequiredError}
9893
9893
  */
9894
- getStoredCollisionScene(cell: string, scene: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<CollisionScene, any>>;
9894
+ getStoredCollisionScene(cell: string, scene: string, options?: RawAxiosRequestConfig): Promise<axios142.AxiosResponse<CollisionScene, any>>;
9895
9895
  /**
9896
9896
  * Returns a list of stored scenes.
9897
9897
  * @summary List Scenes
@@ -9899,7 +9899,7 @@ declare class StoreCollisionScenesApi extends BaseAPI {
9899
9899
  * @param {*} [options] Override http request option.
9900
9900
  * @throws {RequiredError}
9901
9901
  */
9902
- listStoredCollisionScenes(cell: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<{
9902
+ listStoredCollisionScenes(cell: string, options?: RawAxiosRequestConfig): Promise<axios142.AxiosResponse<{
9903
9903
  [key: string]: CollisionScene;
9904
9904
  }, any>>;
9905
9905
  /**
@@ -9911,7 +9911,7 @@ declare class StoreCollisionScenesApi extends BaseAPI {
9911
9911
  * @param {*} [options] Override http request option.
9912
9912
  * @throws {RequiredError}
9913
9913
  */
9914
- storeCollisionScene(cell: string, scene: string, collisionSceneAssembly: CollisionSceneAssembly, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<CollisionScene, any>>;
9914
+ storeCollisionScene(cell: string, scene: string, collisionSceneAssembly: CollisionSceneAssembly, options?: RawAxiosRequestConfig): Promise<axios142.AxiosResponse<CollisionScene, any>>;
9915
9915
  }
9916
9916
  /**
9917
9917
  * StoreObjectApi - axios parameter creator
@@ -9961,7 +9961,7 @@ declare const StoreObjectApiAxiosParamCreator: (configuration?: Configuration) =
9961
9961
  */
9962
9962
  listAllObjectKeys: (cell: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
9963
9963
  /**
9964
- * Store any data as an object. Using a key which already contains an object will override the previously stored object. Use [getObjectMetadata](getObjectMetadata) to verify that the key does not contain objects. Optional: Specify metadata as a dictionary with names and values.
9964
+ * Store any data as an object. Using a key which already contains an object will override the previously stored object. Use [getObjectMetadata](#/operations/getObjectMetadata) to verify that the key does not contain objects. Optional: Specify metadata as a dictionary with names and values.
9965
9965
  * @summary Store Object
9966
9966
  * @param {string} cell Unique identifier addressing a cell in all API calls.
9967
9967
  * @param {string} key
@@ -10022,7 +10022,7 @@ declare const StoreObjectApiFp: (configuration?: Configuration) => {
10022
10022
  */
10023
10023
  listAllObjectKeys(cell: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<string>>>;
10024
10024
  /**
10025
- * Store any data as an object. Using a key which already contains an object will override the previously stored object. Use [getObjectMetadata](getObjectMetadata) to verify that the key does not contain objects. Optional: Specify metadata as a dictionary with names and values.
10025
+ * Store any data as an object. Using a key which already contains an object will override the previously stored object. Use [getObjectMetadata](#/operations/getObjectMetadata) to verify that the key does not contain objects. Optional: Specify metadata as a dictionary with names and values.
10026
10026
  * @summary Store Object
10027
10027
  * @param {string} cell Unique identifier addressing a cell in all API calls.
10028
10028
  * @param {string} key
@@ -10083,7 +10083,7 @@ declare const StoreObjectApiFactory: (configuration?: Configuration, basePath?:
10083
10083
  */
10084
10084
  listAllObjectKeys(cell: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<string>>;
10085
10085
  /**
10086
- * Store any data as an object. Using a key which already contains an object will override the previously stored object. Use [getObjectMetadata](getObjectMetadata) to verify that the key does not contain objects. Optional: Specify metadata as a dictionary with names and values.
10086
+ * Store any data as an object. Using a key which already contains an object will override the previously stored object. Use [getObjectMetadata](#/operations/getObjectMetadata) to verify that the key does not contain objects. Optional: Specify metadata as a dictionary with names and values.
10087
10087
  * @summary Store Object
10088
10088
  * @param {string} cell Unique identifier addressing a cell in all API calls.
10089
10089
  * @param {string} key
@@ -10107,7 +10107,7 @@ declare class StoreObjectApi extends BaseAPI {
10107
10107
  * @param {*} [options] Override http request option.
10108
10108
  * @throws {RequiredError}
10109
10109
  */
10110
- clearAllObjects(cell: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
10110
+ clearAllObjects(cell: string, options?: RawAxiosRequestConfig): Promise<axios142.AxiosResponse<void, any>>;
10111
10111
  /**
10112
10112
  * Delete an object <!-- theme: danger --> > This will delete persistently stored data.
10113
10113
  * @summary Delete Object
@@ -10116,7 +10116,7 @@ declare class StoreObjectApi extends BaseAPI {
10116
10116
  * @param {*} [options] Override http request option.
10117
10117
  * @throws {RequiredError}
10118
10118
  */
10119
- deleteObject(cell: string, key: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
10119
+ deleteObject(cell: string, key: string, options?: RawAxiosRequestConfig): Promise<axios142.AxiosResponse<void, any>>;
10120
10120
  /**
10121
10121
  * Get the object. This request returns the object and any metadata attached to it.
10122
10122
  * @summary Get Object
@@ -10125,7 +10125,7 @@ declare class StoreObjectApi extends BaseAPI {
10125
10125
  * @param {*} [options] Override http request option.
10126
10126
  * @throws {RequiredError}
10127
10127
  */
10128
- getObject(cell: string, key: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<File, any>>;
10128
+ getObject(cell: string, key: string, options?: RawAxiosRequestConfig): Promise<axios142.AxiosResponse<File, any>>;
10129
10129
  /**
10130
10130
  * Get object metadata. Objects can be large. Therefore this request only returns metadata without fetching the object\'s content.
10131
10131
  * @summary Get Object Metadata
@@ -10134,7 +10134,7 @@ declare class StoreObjectApi extends BaseAPI {
10134
10134
  * @param {*} [options] Override http request option.
10135
10135
  * @throws {RequiredError}
10136
10136
  */
10137
- getObjectMetadata(cell: string, key: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
10137
+ getObjectMetadata(cell: string, key: string, options?: RawAxiosRequestConfig): Promise<axios142.AxiosResponse<void, any>>;
10138
10138
  /**
10139
10139
  * List the keys for all objects.
10140
10140
  * @summary List all Object Keys
@@ -10142,9 +10142,9 @@ declare class StoreObjectApi extends BaseAPI {
10142
10142
  * @param {*} [options] Override http request option.
10143
10143
  * @throws {RequiredError}
10144
10144
  */
10145
- listAllObjectKeys(cell: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<string[], any>>;
10145
+ listAllObjectKeys(cell: string, options?: RawAxiosRequestConfig): Promise<axios142.AxiosResponse<string[], any>>;
10146
10146
  /**
10147
- * Store any data as an object. Using a key which already contains an object will override the previously stored object. Use [getObjectMetadata](getObjectMetadata) to verify that the key does not contain objects. Optional: Specify metadata as a dictionary with names and values.
10147
+ * Store any data as an object. Using a key which already contains an object will override the previously stored object. Use [getObjectMetadata](#/operations/getObjectMetadata) to verify that the key does not contain objects. Optional: Specify metadata as a dictionary with names and values.
10148
10148
  * @summary Store Object
10149
10149
  * @param {string} cell Unique identifier addressing a cell in all API calls.
10150
10150
  * @param {string} key
@@ -10155,7 +10155,7 @@ declare class StoreObjectApi extends BaseAPI {
10155
10155
  */
10156
10156
  storeObject(cell: string, key: string, xMetadata?: {
10157
10157
  [key: string]: string;
10158
- }, anyValue?: any, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
10158
+ }, anyValue?: any, options?: RawAxiosRequestConfig): Promise<axios142.AxiosResponse<void, any>>;
10159
10159
  }
10160
10160
  /**
10161
10161
  * SystemApi - axios parameter creator
@@ -10294,28 +10294,28 @@ declare class SystemApi extends BaseAPI {
10294
10294
  * @param {*} [options] Override http request option.
10295
10295
  * @throws {RequiredError}
10296
10296
  */
10297
- checkNovaVersionUpdate(channel: ReleaseChannel, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<string, any>>;
10297
+ checkNovaVersionUpdate(channel: ReleaseChannel, options?: RawAxiosRequestConfig): Promise<axios142.AxiosResponse<string, any>>;
10298
10298
  /**
10299
10299
  * Collects information on the current status of all NOVA services and exports them as a .zip file. Includes information on all cells on the instance such as the service logs and virtual robot controllers. From each cell the logs of all services are included, as well as the configuration of each connected controller to start virtual robots.
10300
10300
  * @summary Download Diagnosis Package
10301
10301
  * @param {*} [options] Override http request option.
10302
10302
  * @throws {RequiredError}
10303
10303
  */
10304
- getDiagnosePackage(options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<File, any>>;
10304
+ getDiagnosePackage(options?: RawAxiosRequestConfig): Promise<axios142.AxiosResponse<File, any>>;
10305
10305
  /**
10306
10306
  * Get the status of all system services.
10307
10307
  * @summary Wandelbots NOVA status
10308
10308
  * @param {*} [options] Override http request option.
10309
10309
  * @throws {RequiredError}
10310
10310
  */
10311
- getSystemStatus(options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<ServiceStatus[], any>>;
10311
+ getSystemStatus(options?: RawAxiosRequestConfig): Promise<axios142.AxiosResponse<ServiceStatus[], any>>;
10312
10312
  /**
10313
10313
  * Get the current Wandelbots NOVA version.
10314
10314
  * @summary Wandelbots NOVA Version
10315
10315
  * @param {*} [options] Override http request option.
10316
10316
  * @throws {RequiredError}
10317
10317
  */
10318
- getSystemVersion(options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<string, any>>;
10318
+ getSystemVersion(options?: RawAxiosRequestConfig): Promise<axios142.AxiosResponse<string, any>>;
10319
10319
  /**
10320
10320
  * Update the Wandelbots NOVA version and all attached services. Sending this API Request will trigger an update of all NOVA services that are part of a cell. Previous cells and cell configurations will remain on the instance. If an error occurs, the API Request is sent 3 times. If the error persists, the old Wandelbots NOVA version is restored.
10321
10321
  * @summary Update Wandelbots NOVA version
@@ -10323,7 +10323,7 @@ declare class SystemApi extends BaseAPI {
10323
10323
  * @param {*} [options] Override http request option.
10324
10324
  * @throws {RequiredError}
10325
10325
  */
10326
- updateNovaVersion(updateNovaVersionRequest: UpdateNovaVersionRequest, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
10326
+ updateNovaVersion(updateNovaVersionRequest: UpdateNovaVersionRequest, options?: RawAxiosRequestConfig): Promise<axios142.AxiosResponse<void, any>>;
10327
10327
  }
10328
10328
  /**
10329
10329
  * VersionApi - axios parameter creator
@@ -10371,7 +10371,7 @@ declare class VersionApi extends BaseAPI {
10371
10371
  * @param {*} [options] Override http request option.
10372
10372
  * @throws {RequiredError}
10373
10373
  */
10374
- getApiVersion(options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<ApiVersion, any>>;
10374
+ getApiVersion(options?: RawAxiosRequestConfig): Promise<axios142.AxiosResponse<ApiVersion, any>>;
10375
10375
  }
10376
10376
  /**
10377
10377
  * VirtualRobotApi - axios parameter creator
@@ -10587,7 +10587,7 @@ declare class VirtualRobotApi extends BaseAPI {
10587
10587
  * @param {*} [options] Override http request option.
10588
10588
  * @throws {RequiredError}
10589
10589
  */
10590
- getMotionGroupState(cell: string, controller: string, id: number, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<MotionGroupJoints, any>>;
10590
+ getMotionGroupState(cell: string, controller: string, id: number, options?: RawAxiosRequestConfig): Promise<axios142.AxiosResponse<MotionGroupJoints, any>>;
10591
10591
  /**
10592
10592
  * Gets information on the motion group.
10593
10593
  * @summary Motion Group Description
@@ -10596,7 +10596,7 @@ declare class VirtualRobotApi extends BaseAPI {
10596
10596
  * @param {*} [options] Override http request option.
10597
10597
  * @throws {RequiredError}
10598
10598
  */
10599
- getMotionGroups(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<MotionGroupInfos, any>>;
10599
+ getMotionGroups(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<axios142.AxiosResponse<MotionGroupInfos, any>>;
10600
10600
  /**
10601
10601
  * Gets the description and value of a virtual controller I/O.
10602
10602
  * @summary Get I/O
@@ -10606,7 +10606,7 @@ declare class VirtualRobotApi extends BaseAPI {
10606
10606
  * @param {*} [options] Override http request option.
10607
10607
  * @throws {RequiredError}
10608
10608
  */
10609
- getVirtualRobotIOValue(cell: string, controller: string, io: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<IO, any>>;
10609
+ getVirtualRobotIOValue(cell: string, controller: string, io: string, options?: RawAxiosRequestConfig): Promise<axios142.AxiosResponse<IO, any>>;
10610
10610
  /**
10611
10611
  * Lists all inputs/outputs of the virtual controller. Every input/output contains the description and the value. As a virtual robot can have up to thousand inputs/outputs, be ready to handle a large response. Use [List Descriptions](List Descriptions) to get a detailed description of an input/output.
10612
10612
  * @summary List Inputs/Outputs
@@ -10615,7 +10615,7 @@ declare class VirtualRobotApi extends BaseAPI {
10615
10615
  * @param {*} [options] Override http request option.
10616
10616
  * @throws {RequiredError}
10617
10617
  */
10618
- listIOs(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<IOs, any>>;
10618
+ listIOs(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<axios142.AxiosResponse<IOs, any>>;
10619
10619
  /**
10620
10620
  * Sets the values for joint position, joint velocity or joint acceleration of a motion group state. The values are immediately applied to the joints of the motion group. We recommend to only use the endpoint when the motion group is in monitor mode. In case the motion group is controlled, currently jogging or planning motions, the values are overridden by the controller or an error may occur.
10621
10621
  * @summary Set Motion Group State
@@ -10626,7 +10626,7 @@ declare class VirtualRobotApi extends BaseAPI {
10626
10626
  * @param {*} [options] Override http request option.
10627
10627
  * @throws {RequiredError}
10628
10628
  */
10629
- setMotionGroupState(cell: string, controller: string, id: number, motionGroupJoints: MotionGroupJoints, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<object, any>>;
10629
+ setMotionGroupState(cell: string, controller: string, id: number, motionGroupJoints: MotionGroupJoints, options?: RawAxiosRequestConfig): Promise<axios142.AxiosResponse<object, any>>;
10630
10630
  /**
10631
10631
  * Sets the value of a virtual controller I/O.
10632
10632
  * @summary Set I/O
@@ -10639,7 +10639,7 @@ declare class VirtualRobotApi extends BaseAPI {
10639
10639
  * @param {*} [options] Override http request option.
10640
10640
  * @throws {RequiredError}
10641
10641
  */
10642
- setVirtualRobotIOValue(cell: string, controller: string, io: string, bool?: boolean, integer?: string, _double?: number, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<object, any>>;
10642
+ setVirtualRobotIOValue(cell: string, controller: string, io: string, bool?: boolean, integer?: string, _double?: number, options?: RawAxiosRequestConfig): Promise<axios142.AxiosResponse<object, any>>;
10643
10643
  }
10644
10644
  /**
10645
10645
  * VirtualRobotBehaviorApi - axios parameter creator
@@ -10656,7 +10656,7 @@ declare const VirtualRobotBehaviorApiAxiosParamCreator: (configuration?: Configu
10656
10656
  */
10657
10657
  externalJointsStream: (cell: string, controller: string, externalJointStreamDatapoint: ExternalJointStreamDatapoint, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
10658
10658
  /**
10659
- * Get the current robot motion group behavior - please see the setter [setMotionGroupBehavior](setMotionGroupBehavior) and the enum for details.
10659
+ * Get the current robot motion group behavior - please see the setter [setMotionGroupBehavior](#/operations/setMotionGroupBehavior) and the enum for details.
10660
10660
  * @summary Behavior
10661
10661
  * @param {string} cell Unique identifier addressing a cell in all API calls.
10662
10662
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -10692,7 +10692,7 @@ declare const VirtualRobotBehaviorApiFp: (configuration?: Configuration) => {
10692
10692
  */
10693
10693
  externalJointsStream(cell: string, controller: string, externalJointStreamDatapoint: ExternalJointStreamDatapoint, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<MotionGroupJoints>>;
10694
10694
  /**
10695
- * Get the current robot motion group behavior - please see the setter [setMotionGroupBehavior](setMotionGroupBehavior) and the enum for details.
10695
+ * Get the current robot motion group behavior - please see the setter [setMotionGroupBehavior](#/operations/setMotionGroupBehavior) and the enum for details.
10696
10696
  * @summary Behavior
10697
10697
  * @param {string} cell Unique identifier addressing a cell in all API calls.
10698
10698
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -10728,7 +10728,7 @@ declare const VirtualRobotBehaviorApiFactory: (configuration?: Configuration, ba
10728
10728
  */
10729
10729
  externalJointsStream(cell: string, controller: string, externalJointStreamDatapoint: ExternalJointStreamDatapoint, options?: RawAxiosRequestConfig): AxiosPromise<MotionGroupJoints>;
10730
10730
  /**
10731
- * Get the current robot motion group behavior - please see the setter [setMotionGroupBehavior](setMotionGroupBehavior) and the enum for details.
10731
+ * Get the current robot motion group behavior - please see the setter [setMotionGroupBehavior](#/operations/setMotionGroupBehavior) and the enum for details.
10732
10732
  * @summary Behavior
10733
10733
  * @param {string} cell Unique identifier addressing a cell in all API calls.
10734
10734
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -10762,9 +10762,9 @@ declare class VirtualRobotBehaviorApi extends BaseAPI {
10762
10762
  * @param {*} [options] Override http request option.
10763
10763
  * @throws {RequiredError}
10764
10764
  */
10765
- externalJointsStream(cell: string, controller: string, externalJointStreamDatapoint: ExternalJointStreamDatapoint, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<MotionGroupJoints, any>>;
10765
+ externalJointsStream(cell: string, controller: string, externalJointStreamDatapoint: ExternalJointStreamDatapoint, options?: RawAxiosRequestConfig): Promise<axios142.AxiosResponse<MotionGroupJoints, any>>;
10766
10766
  /**
10767
- * Get the current robot motion group behavior - please see the setter [setMotionGroupBehavior](setMotionGroupBehavior) and the enum for details.
10767
+ * Get the current robot motion group behavior - please see the setter [setMotionGroupBehavior](#/operations/setMotionGroupBehavior) and the enum for details.
10768
10768
  * @summary Behavior
10769
10769
  * @param {string} cell Unique identifier addressing a cell in all API calls.
10770
10770
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -10772,7 +10772,7 @@ declare class VirtualRobotBehaviorApi extends BaseAPI {
10772
10772
  * @param {*} [options] Override http request option.
10773
10773
  * @throws {RequiredError}
10774
10774
  */
10775
- getMotionGroupBehavior(cell: string, controller: string, id: number, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<MotionGroupBehaviorGetter, any>>;
10775
+ getMotionGroupBehavior(cell: string, controller: string, id: number, options?: RawAxiosRequestConfig): Promise<axios142.AxiosResponse<MotionGroupBehaviorGetter, any>>;
10776
10776
  /**
10777
10777
  * Switch robot motion group behavior.
10778
10778
  * @summary Switch Behavior
@@ -10783,7 +10783,7 @@ declare class VirtualRobotBehaviorApi extends BaseAPI {
10783
10783
  * @param {*} [options] Override http request option.
10784
10784
  * @throws {RequiredError}
10785
10785
  */
10786
- setMotionGroupBehavior(cell: string, controller: string, id: number, behavior?: Behavior, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<object, any>>;
10786
+ setMotionGroupBehavior(cell: string, controller: string, id: number, behavior?: Behavior, options?: RawAxiosRequestConfig): Promise<axios142.AxiosResponse<object, any>>;
10787
10787
  }
10788
10788
  /**
10789
10789
  * VirtualRobotModeApi - axios parameter creator
@@ -10799,7 +10799,7 @@ declare const VirtualRobotModeApiAxiosParamCreator: (configuration?: Configurati
10799
10799
  */
10800
10800
  getCycleTime: (cell: string, controller: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
10801
10801
  /**
10802
- * Requests the Emergency Stop state of the virtual robot controller. Use [getCurrentMotionGroupState](getCurrentMotionGroupState) to get the Emergency Stop state regardless of the controller type. There the Emergency Stop state is visible as the `safety_state`. > **NOTE** > > The Emergency Stop state can only be changed when using virtual robot controllers.
10802
+ * Requests the Emergency Stop state of the virtual robot controller. Use [getCurrentMotionGroupState](#/operations/getCurrentMotionGroupState) to get the Emergency Stop state regardless of the controller type. There, the Emergency Stop state is visible as the `safety_state`. > **NOTE** > > The Emergency Stop state can only be changed when using virtual robot controllers.
10803
10803
  * @summary Get E-Stop State
10804
10804
  * @param {string} cell Unique identifier addressing a cell in all API calls.
10805
10805
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -10808,7 +10808,7 @@ declare const VirtualRobotModeApiAxiosParamCreator: (configuration?: Configurati
10808
10808
  */
10809
10809
  getEStop: (cell: string, controller: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
10810
10810
  /**
10811
- * Requests the Operation Mode of the virtual robot controller. To get the Operation Mode regardless of the controller type use [getCurrentMotionGroupState](getCurrentMotionGroupState). > **NOTE** > > The Operating Mode can only change be changed via API when using virtual robot controllers.
10811
+ * Requests the Operation Mode of the virtual robot controller. To get the Operation Mode regardless of the controller type use [getCurrentMotionGroupState](#/operations/getCurrentMotionGroupState). > **NOTE** > > The Operating Mode can only be changed via API when using virtual robot controllers.
10812
10812
  * @summary Get Operation Mode
10813
10813
  * @param {string} cell Unique identifier addressing a cell in all API calls.
10814
10814
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -10817,7 +10817,7 @@ declare const VirtualRobotModeApiAxiosParamCreator: (configuration?: Configurati
10817
10817
  */
10818
10818
  getOperationMode: (cell: string, controller: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
10819
10819
  /**
10820
- * Activates the Emergency Stop on the virtual robot controller. Activating the Emergency Stop stops the execution of all motions on virtual and physical robot controllers. To return to normal operation the Emergency Stop needs to be released. Use [getCurrentMotionGroupState](getCurrentMotionGroupState) to get the Emergency Stop state regardless of the controller type. There the Emergency Stop state is visible as the `safety_state`. > **NOTE** > > The Emergency Stop state can only be changed via API when using virtual robot controllers.
10820
+ * Activates the Emergency Stop on the virtual robot controller. Activating the Emergency Stop stops the execution of all motions on virtual and physical robot controllers. To return to normal operation, the Emergency Stop needs to be released. Use [getCurrentMotionGroupState](#/operations/getCurrentMotionGroupState) to get the Emergency Stop state regardless of the controller type. There, the Emergency Stop state is visible as the `safety_state`. > **NOTE** > > The Emergency Stop state can only be changed via API when using virtual robot controllers.
10821
10821
  * @summary Push E-Stop
10822
10822
  * @param {string} cell Unique identifier addressing a cell in all API calls.
10823
10823
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -10826,7 +10826,7 @@ declare const VirtualRobotModeApiAxiosParamCreator: (configuration?: Configurati
10826
10826
  */
10827
10827
  pushEStop: (cell: string, controller: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
10828
10828
  /**
10829
- * Releases the Emergency Stop on the virtual robot controller. Activating the Emergency Stop stops the execution of all motions on virtual and physical robot controllers. To return to normal operation the Emergency Stop needs to be released. Use [getCurrentMotionGroupState](getCurrentMotionGroupState) to get the Emergency Stop state regardless of the controller type. There the Emergency Stop state is visible as the `safety_state`. > **NOTE** > > The Emergency Stop state can only be changed via API when using virtual robot controllers.
10829
+ * Releases the Emergency Stop on the virtual robot controller. Activating the Emergency Stop stops the execution of all motions on virtual and physical robot controllers. To return to normal operation, the Emergency Stop needs to be released. Use [getCurrentMotionGroupState](#/operations/getCurrentMotionGroupState) to get the Emergency Stop state regardless of the controller type. There, the Emergency Stop state is visible as the `safety_state`. > **NOTE** > > The Emergency Stop state can only be changed via API when using virtual robot controllers.
10830
10830
  * @summary Release E-Stop
10831
10831
  * @param {string} cell Unique identifier addressing a cell in all API calls.
10832
10832
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -10835,7 +10835,7 @@ declare const VirtualRobotModeApiAxiosParamCreator: (configuration?: Configurati
10835
10835
  */
10836
10836
  releaseEStop: (cell: string, controller: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
10837
10837
  /**
10838
- * Changes the Operation Mode of the virtual robot controller to the specified value. To get the Operation Mode regardless of the controller type use [getCurrentMotionGroupState](getCurrentMotionGroupState). > **NOTE** > > The Operating Mode can only change be changed via API when using virtual robot controllers.
10838
+ * Changes the Operation Mode of the virtual robot controller to the specified value. To get the Operation Mode, regardless of the controller type, use [getCurrentMotionGroupState](#/operations/getCurrentMotionGroupState). > **NOTE** > > The Operating Mode can only be changed via API when using virtual robot controllers.
10839
10839
  * @summary Set Operation Mode
10840
10840
  * @param {string} cell Unique identifier addressing a cell in all API calls.
10841
10841
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -10859,7 +10859,7 @@ declare const VirtualRobotModeApiFp: (configuration?: Configuration) => {
10859
10859
  */
10860
10860
  getCycleTime(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CycleTime>>;
10861
10861
  /**
10862
- * Requests the Emergency Stop state of the virtual robot controller. Use [getCurrentMotionGroupState](getCurrentMotionGroupState) to get the Emergency Stop state regardless of the controller type. There the Emergency Stop state is visible as the `safety_state`. > **NOTE** > > The Emergency Stop state can only be changed when using virtual robot controllers.
10862
+ * Requests the Emergency Stop state of the virtual robot controller. Use [getCurrentMotionGroupState](#/operations/getCurrentMotionGroupState) to get the Emergency Stop state regardless of the controller type. There, the Emergency Stop state is visible as the `safety_state`. > **NOTE** > > The Emergency Stop state can only be changed when using virtual robot controllers.
10863
10863
  * @summary Get E-Stop State
10864
10864
  * @param {string} cell Unique identifier addressing a cell in all API calls.
10865
10865
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -10868,7 +10868,7 @@ declare const VirtualRobotModeApiFp: (configuration?: Configuration) => {
10868
10868
  */
10869
10869
  getEStop(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Flag>>;
10870
10870
  /**
10871
- * Requests the Operation Mode of the virtual robot controller. To get the Operation Mode regardless of the controller type use [getCurrentMotionGroupState](getCurrentMotionGroupState). > **NOTE** > > The Operating Mode can only change be changed via API when using virtual robot controllers.
10871
+ * Requests the Operation Mode of the virtual robot controller. To get the Operation Mode regardless of the controller type use [getCurrentMotionGroupState](#/operations/getCurrentMotionGroupState). > **NOTE** > > The Operating Mode can only be changed via API when using virtual robot controllers.
10872
10872
  * @summary Get Operation Mode
10873
10873
  * @param {string} cell Unique identifier addressing a cell in all API calls.
10874
10874
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -10877,7 +10877,7 @@ declare const VirtualRobotModeApiFp: (configuration?: Configuration) => {
10877
10877
  */
10878
10878
  getOperationMode(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<OpMode>>;
10879
10879
  /**
10880
- * Activates the Emergency Stop on the virtual robot controller. Activating the Emergency Stop stops the execution of all motions on virtual and physical robot controllers. To return to normal operation the Emergency Stop needs to be released. Use [getCurrentMotionGroupState](getCurrentMotionGroupState) to get the Emergency Stop state regardless of the controller type. There the Emergency Stop state is visible as the `safety_state`. > **NOTE** > > The Emergency Stop state can only be changed via API when using virtual robot controllers.
10880
+ * Activates the Emergency Stop on the virtual robot controller. Activating the Emergency Stop stops the execution of all motions on virtual and physical robot controllers. To return to normal operation, the Emergency Stop needs to be released. Use [getCurrentMotionGroupState](#/operations/getCurrentMotionGroupState) to get the Emergency Stop state regardless of the controller type. There, the Emergency Stop state is visible as the `safety_state`. > **NOTE** > > The Emergency Stop state can only be changed via API when using virtual robot controllers.
10881
10881
  * @summary Push E-Stop
10882
10882
  * @param {string} cell Unique identifier addressing a cell in all API calls.
10883
10883
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -10886,7 +10886,7 @@ declare const VirtualRobotModeApiFp: (configuration?: Configuration) => {
10886
10886
  */
10887
10887
  pushEStop(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<object>>;
10888
10888
  /**
10889
- * Releases the Emergency Stop on the virtual robot controller. Activating the Emergency Stop stops the execution of all motions on virtual and physical robot controllers. To return to normal operation the Emergency Stop needs to be released. Use [getCurrentMotionGroupState](getCurrentMotionGroupState) to get the Emergency Stop state regardless of the controller type. There the Emergency Stop state is visible as the `safety_state`. > **NOTE** > > The Emergency Stop state can only be changed via API when using virtual robot controllers.
10889
+ * Releases the Emergency Stop on the virtual robot controller. Activating the Emergency Stop stops the execution of all motions on virtual and physical robot controllers. To return to normal operation, the Emergency Stop needs to be released. Use [getCurrentMotionGroupState](#/operations/getCurrentMotionGroupState) to get the Emergency Stop state regardless of the controller type. There, the Emergency Stop state is visible as the `safety_state`. > **NOTE** > > The Emergency Stop state can only be changed via API when using virtual robot controllers.
10890
10890
  * @summary Release E-Stop
10891
10891
  * @param {string} cell Unique identifier addressing a cell in all API calls.
10892
10892
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -10895,7 +10895,7 @@ declare const VirtualRobotModeApiFp: (configuration?: Configuration) => {
10895
10895
  */
10896
10896
  releaseEStop(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<object>>;
10897
10897
  /**
10898
- * Changes the Operation Mode of the virtual robot controller to the specified value. To get the Operation Mode regardless of the controller type use [getCurrentMotionGroupState](getCurrentMotionGroupState). > **NOTE** > > The Operating Mode can only change be changed via API when using virtual robot controllers.
10898
+ * Changes the Operation Mode of the virtual robot controller to the specified value. To get the Operation Mode, regardless of the controller type, use [getCurrentMotionGroupState](#/operations/getCurrentMotionGroupState). > **NOTE** > > The Operating Mode can only be changed via API when using virtual robot controllers.
10899
10899
  * @summary Set Operation Mode
10900
10900
  * @param {string} cell Unique identifier addressing a cell in all API calls.
10901
10901
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -10919,7 +10919,7 @@ declare const VirtualRobotModeApiFactory: (configuration?: Configuration, basePa
10919
10919
  */
10920
10920
  getCycleTime(cell: string, controller: string, options?: RawAxiosRequestConfig): AxiosPromise<CycleTime>;
10921
10921
  /**
10922
- * Requests the Emergency Stop state of the virtual robot controller. Use [getCurrentMotionGroupState](getCurrentMotionGroupState) to get the Emergency Stop state regardless of the controller type. There the Emergency Stop state is visible as the `safety_state`. > **NOTE** > > The Emergency Stop state can only be changed when using virtual robot controllers.
10922
+ * Requests the Emergency Stop state of the virtual robot controller. Use [getCurrentMotionGroupState](#/operations/getCurrentMotionGroupState) to get the Emergency Stop state regardless of the controller type. There, the Emergency Stop state is visible as the `safety_state`. > **NOTE** > > The Emergency Stop state can only be changed when using virtual robot controllers.
10923
10923
  * @summary Get E-Stop State
10924
10924
  * @param {string} cell Unique identifier addressing a cell in all API calls.
10925
10925
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -10928,7 +10928,7 @@ declare const VirtualRobotModeApiFactory: (configuration?: Configuration, basePa
10928
10928
  */
10929
10929
  getEStop(cell: string, controller: string, options?: RawAxiosRequestConfig): AxiosPromise<Flag>;
10930
10930
  /**
10931
- * Requests the Operation Mode of the virtual robot controller. To get the Operation Mode regardless of the controller type use [getCurrentMotionGroupState](getCurrentMotionGroupState). > **NOTE** > > The Operating Mode can only change be changed via API when using virtual robot controllers.
10931
+ * Requests the Operation Mode of the virtual robot controller. To get the Operation Mode regardless of the controller type use [getCurrentMotionGroupState](#/operations/getCurrentMotionGroupState). > **NOTE** > > The Operating Mode can only be changed via API when using virtual robot controllers.
10932
10932
  * @summary Get Operation Mode
10933
10933
  * @param {string} cell Unique identifier addressing a cell in all API calls.
10934
10934
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -10937,7 +10937,7 @@ declare const VirtualRobotModeApiFactory: (configuration?: Configuration, basePa
10937
10937
  */
10938
10938
  getOperationMode(cell: string, controller: string, options?: RawAxiosRequestConfig): AxiosPromise<OpMode>;
10939
10939
  /**
10940
- * Activates the Emergency Stop on the virtual robot controller. Activating the Emergency Stop stops the execution of all motions on virtual and physical robot controllers. To return to normal operation the Emergency Stop needs to be released. Use [getCurrentMotionGroupState](getCurrentMotionGroupState) to get the Emergency Stop state regardless of the controller type. There the Emergency Stop state is visible as the `safety_state`. > **NOTE** > > The Emergency Stop state can only be changed via API when using virtual robot controllers.
10940
+ * Activates the Emergency Stop on the virtual robot controller. Activating the Emergency Stop stops the execution of all motions on virtual and physical robot controllers. To return to normal operation, the Emergency Stop needs to be released. Use [getCurrentMotionGroupState](#/operations/getCurrentMotionGroupState) to get the Emergency Stop state regardless of the controller type. There, the Emergency Stop state is visible as the `safety_state`. > **NOTE** > > The Emergency Stop state can only be changed via API when using virtual robot controllers.
10941
10941
  * @summary Push E-Stop
10942
10942
  * @param {string} cell Unique identifier addressing a cell in all API calls.
10943
10943
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -10946,7 +10946,7 @@ declare const VirtualRobotModeApiFactory: (configuration?: Configuration, basePa
10946
10946
  */
10947
10947
  pushEStop(cell: string, controller: string, options?: RawAxiosRequestConfig): AxiosPromise<object>;
10948
10948
  /**
10949
- * Releases the Emergency Stop on the virtual robot controller. Activating the Emergency Stop stops the execution of all motions on virtual and physical robot controllers. To return to normal operation the Emergency Stop needs to be released. Use [getCurrentMotionGroupState](getCurrentMotionGroupState) to get the Emergency Stop state regardless of the controller type. There the Emergency Stop state is visible as the `safety_state`. > **NOTE** > > The Emergency Stop state can only be changed via API when using virtual robot controllers.
10949
+ * Releases the Emergency Stop on the virtual robot controller. Activating the Emergency Stop stops the execution of all motions on virtual and physical robot controllers. To return to normal operation, the Emergency Stop needs to be released. Use [getCurrentMotionGroupState](#/operations/getCurrentMotionGroupState) to get the Emergency Stop state regardless of the controller type. There, the Emergency Stop state is visible as the `safety_state`. > **NOTE** > > The Emergency Stop state can only be changed via API when using virtual robot controllers.
10950
10950
  * @summary Release E-Stop
10951
10951
  * @param {string} cell Unique identifier addressing a cell in all API calls.
10952
10952
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -10955,7 +10955,7 @@ declare const VirtualRobotModeApiFactory: (configuration?: Configuration, basePa
10955
10955
  */
10956
10956
  releaseEStop(cell: string, controller: string, options?: RawAxiosRequestConfig): AxiosPromise<object>;
10957
10957
  /**
10958
- * Changes the Operation Mode of the virtual robot controller to the specified value. To get the Operation Mode regardless of the controller type use [getCurrentMotionGroupState](getCurrentMotionGroupState). > **NOTE** > > The Operating Mode can only change be changed via API when using virtual robot controllers.
10958
+ * Changes the Operation Mode of the virtual robot controller to the specified value. To get the Operation Mode, regardless of the controller type, use [getCurrentMotionGroupState](#/operations/getCurrentMotionGroupState). > **NOTE** > > The Operating Mode can only be changed via API when using virtual robot controllers.
10959
10959
  * @summary Set Operation Mode
10960
10960
  * @param {string} cell Unique identifier addressing a cell in all API calls.
10961
10961
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -10977,45 +10977,45 @@ declare class VirtualRobotModeApi extends BaseAPI {
10977
10977
  * @param {*} [options] Override http request option.
10978
10978
  * @throws {RequiredError}
10979
10979
  */
10980
- getCycleTime(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<CycleTime, any>>;
10980
+ getCycleTime(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<axios142.AxiosResponse<CycleTime, any>>;
10981
10981
  /**
10982
- * Requests the Emergency Stop state of the virtual robot controller. Use [getCurrentMotionGroupState](getCurrentMotionGroupState) to get the Emergency Stop state regardless of the controller type. There the Emergency Stop state is visible as the `safety_state`. > **NOTE** > > The Emergency Stop state can only be changed when using virtual robot controllers.
10982
+ * Requests the Emergency Stop state of the virtual robot controller. Use [getCurrentMotionGroupState](#/operations/getCurrentMotionGroupState) to get the Emergency Stop state regardless of the controller type. There, the Emergency Stop state is visible as the `safety_state`. > **NOTE** > > The Emergency Stop state can only be changed when using virtual robot controllers.
10983
10983
  * @summary Get E-Stop State
10984
10984
  * @param {string} cell Unique identifier addressing a cell in all API calls.
10985
10985
  * @param {string} controller Unique identifier to address a controller in the cell.
10986
10986
  * @param {*} [options] Override http request option.
10987
10987
  * @throws {RequiredError}
10988
10988
  */
10989
- getEStop(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<Flag, any>>;
10989
+ getEStop(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<axios142.AxiosResponse<Flag, any>>;
10990
10990
  /**
10991
- * Requests the Operation Mode of the virtual robot controller. To get the Operation Mode regardless of the controller type use [getCurrentMotionGroupState](getCurrentMotionGroupState). > **NOTE** > > The Operating Mode can only change be changed via API when using virtual robot controllers.
10991
+ * Requests the Operation Mode of the virtual robot controller. To get the Operation Mode regardless of the controller type use [getCurrentMotionGroupState](#/operations/getCurrentMotionGroupState). > **NOTE** > > The Operating Mode can only be changed via API when using virtual robot controllers.
10992
10992
  * @summary Get Operation Mode
10993
10993
  * @param {string} cell Unique identifier addressing a cell in all API calls.
10994
10994
  * @param {string} controller Unique identifier to address a controller in the cell.
10995
10995
  * @param {*} [options] Override http request option.
10996
10996
  * @throws {RequiredError}
10997
10997
  */
10998
- getOperationMode(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<OpMode, any>>;
10998
+ getOperationMode(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<axios142.AxiosResponse<OpMode, any>>;
10999
10999
  /**
11000
- * Activates the Emergency Stop on the virtual robot controller. Activating the Emergency Stop stops the execution of all motions on virtual and physical robot controllers. To return to normal operation the Emergency Stop needs to be released. Use [getCurrentMotionGroupState](getCurrentMotionGroupState) to get the Emergency Stop state regardless of the controller type. There the Emergency Stop state is visible as the `safety_state`. > **NOTE** > > The Emergency Stop state can only be changed via API when using virtual robot controllers.
11000
+ * Activates the Emergency Stop on the virtual robot controller. Activating the Emergency Stop stops the execution of all motions on virtual and physical robot controllers. To return to normal operation, the Emergency Stop needs to be released. Use [getCurrentMotionGroupState](#/operations/getCurrentMotionGroupState) to get the Emergency Stop state regardless of the controller type. There, the Emergency Stop state is visible as the `safety_state`. > **NOTE** > > The Emergency Stop state can only be changed via API when using virtual robot controllers.
11001
11001
  * @summary Push E-Stop
11002
11002
  * @param {string} cell Unique identifier addressing a cell in all API calls.
11003
11003
  * @param {string} controller Unique identifier to address a controller in the cell.
11004
11004
  * @param {*} [options] Override http request option.
11005
11005
  * @throws {RequiredError}
11006
11006
  */
11007
- pushEStop(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<object, any>>;
11007
+ pushEStop(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<axios142.AxiosResponse<object, any>>;
11008
11008
  /**
11009
- * Releases the Emergency Stop on the virtual robot controller. Activating the Emergency Stop stops the execution of all motions on virtual and physical robot controllers. To return to normal operation the Emergency Stop needs to be released. Use [getCurrentMotionGroupState](getCurrentMotionGroupState) to get the Emergency Stop state regardless of the controller type. There the Emergency Stop state is visible as the `safety_state`. > **NOTE** > > The Emergency Stop state can only be changed via API when using virtual robot controllers.
11009
+ * Releases the Emergency Stop on the virtual robot controller. Activating the Emergency Stop stops the execution of all motions on virtual and physical robot controllers. To return to normal operation, the Emergency Stop needs to be released. Use [getCurrentMotionGroupState](#/operations/getCurrentMotionGroupState) to get the Emergency Stop state regardless of the controller type. There, the Emergency Stop state is visible as the `safety_state`. > **NOTE** > > The Emergency Stop state can only be changed via API when using virtual robot controllers.
11010
11010
  * @summary Release E-Stop
11011
11011
  * @param {string} cell Unique identifier addressing a cell in all API calls.
11012
11012
  * @param {string} controller Unique identifier to address a controller in the cell.
11013
11013
  * @param {*} [options] Override http request option.
11014
11014
  * @throws {RequiredError}
11015
11015
  */
11016
- releaseEStop(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<object, any>>;
11016
+ releaseEStop(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<axios142.AxiosResponse<object, any>>;
11017
11017
  /**
11018
- * Changes the Operation Mode of the virtual robot controller to the specified value. To get the Operation Mode regardless of the controller type use [getCurrentMotionGroupState](getCurrentMotionGroupState). > **NOTE** > > The Operating Mode can only change be changed via API when using virtual robot controllers.
11018
+ * Changes the Operation Mode of the virtual robot controller to the specified value. To get the Operation Mode, regardless of the controller type, use [getCurrentMotionGroupState](#/operations/getCurrentMotionGroupState). > **NOTE** > > The Operating Mode can only be changed via API when using virtual robot controllers.
11019
11019
  * @summary Set Operation Mode
11020
11020
  * @param {string} cell Unique identifier addressing a cell in all API calls.
11021
11021
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -11023,7 +11023,7 @@ declare class VirtualRobotModeApi extends BaseAPI {
11023
11023
  * @param {*} [options] Override http request option.
11024
11024
  * @throws {RequiredError}
11025
11025
  */
11026
- setOperationMode(cell: string, controller: string, mode: SetOperationModeModeEnum, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<object, any>>;
11026
+ setOperationMode(cell: string, controller: string, mode: SetOperationModeModeEnum, options?: RawAxiosRequestConfig): Promise<axios142.AxiosResponse<object, any>>;
11027
11027
  }
11028
11028
  declare const SetOperationModeModeEnum: {
11029
11029
  readonly OperationModeManual: "OPERATION_MODE_MANUAL";
@@ -11307,7 +11307,7 @@ declare class VirtualRobotSetupApi extends BaseAPI {
11307
11307
  * @param {*} [options] Override http request option.
11308
11308
  * @throws {RequiredError}
11309
11309
  */
11310
- addVirtualRobotCoordinateSystem(cell: string, controller: string, coordinateSystem: CoordinateSystem, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<object, any>>;
11310
+ addVirtualRobotCoordinateSystem(cell: string, controller: string, coordinateSystem: CoordinateSystem, options?: RawAxiosRequestConfig): Promise<axios142.AxiosResponse<object, any>>;
11311
11311
  /**
11312
11312
  * Adds a new [TCP](https://docs.wandelbots.io/latest/vocabulary#tcp) or updates an existing TCP in the motion group. The position and rotation values in the request body are defined within the flange\'s coordinate system. > **NOTE** > Ensure the TCP\'s position is within the robot\'s reach. Refer to the robot\'s documentation or data sheet for details like joint limits or reach. > **NOTE** > Upon adding or updating a TCP, virtual robots are restarted to apply the new configuration. > What happens during restart: > - Robot visualization may temporarily disappear. > - TCP visualization may be delayed or outdated during the first run. > - Existing connections to the virtual robot are closed and re-established, which introduces a short delay before the TCP is available for use. > > The API call itself **does not wait until the restart and synchronization are complete**. This means that > immediately after a successful response, the TCP may not be available for visualization or program execution.
11313
11313
  * @summary Add TCP
@@ -11318,7 +11318,7 @@ declare class VirtualRobotSetupApi extends BaseAPI {
11318
11318
  * @param {*} [options] Override http request option.
11319
11319
  * @throws {RequiredError}
11320
11320
  */
11321
- addVirtualRobotTcp(cell: string, controller: string, id: number, robotTcp: RobotTcp, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<object, any>>;
11321
+ addVirtualRobotTcp(cell: string, controller: string, id: number, robotTcp: RobotTcp, options?: RawAxiosRequestConfig): Promise<axios142.AxiosResponse<object, any>>;
11322
11322
  /**
11323
11323
  * Deletes a coordinate system from the virtual controller. This will remove the coordinate system from the list of coordinate systems and also remove all dependent coordinate systems which use the deleted coordinate system as a reference. **Important notes:** - When a new coordinate system is added/removed, the **virtual robot is restarted** in the background in order to apply the new configuration. - During this restart: - Robot visualization may temporarily disappear or appear outdated in the UI. - coordinate system changes are not immediately visible in visualizations. - All existing connections to the virtual robot are closed and re-established, which introduces a short delay before the system is fully operational again. - The API call itself does **not wait until the restart and re-synchronization are complete**. This means that immediately after a successful response, the new coordinate system may not yet be > **NOTE** > > Upon adding or removing a coordinate system, virtual robots are restarted to apply the new configuration. > What happens during restart: > - Robot visualization may temporarily disappear or appear outdated in the UI. > - Coordinate system changes are not immediately visible in visualizations. > - Existing connections to the virtual robot are closed and re-established, which introduces a short delay before NOVA is fully operational again. > > The API call itself **does not wait until the restart and synchronization are complete**. This means that > immediately after a successful response, the new coordinate system may not be available for visualization or program execution.
11324
11324
  * @summary Remove Coordinate System
@@ -11329,7 +11329,7 @@ declare class VirtualRobotSetupApi extends BaseAPI {
11329
11329
  * @param {*} [options] Override http request option.
11330
11330
  * @throws {RequiredError}
11331
11331
  */
11332
- deleteVirtualRobotCoordinateSystem(cell: string, controller: string, coordinateSystem: string, deleteDependent?: boolean, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<object, any>>;
11332
+ deleteVirtualRobotCoordinateSystem(cell: string, controller: string, coordinateSystem: string, deleteDependent?: boolean, options?: RawAxiosRequestConfig): Promise<axios142.AxiosResponse<object, any>>;
11333
11333
  /**
11334
11334
  * Removes the TCP (Tool Center Point) from the motion group. An unknown TCP is a valid input and will simply be ignored. > **NOTE** > Upon removing a TCP, virtual robots are restarted to apply the new configuration. > What happens during restart: > - Robot visualization may temporarily disappear. > - TCP visualization may be delayed or outdated during the first run. > - Existing connections to the virtual robot are closed and re-established, which introduces a short delay before the TCP is removed. > > The API call itself **does not wait until the restart and synchronization are complete**. This means that immediately after a successful response, the TCP may not be removed.
11335
11335
  * @summary Remove TCP
@@ -11340,7 +11340,7 @@ declare class VirtualRobotSetupApi extends BaseAPI {
11340
11340
  * @param {*} [options] Override http request option.
11341
11341
  * @throws {RequiredError}
11342
11342
  */
11343
- deleteVirtualRobotTcp(cell: string, controller: string, id: number, tcp: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<object, any>>;
11343
+ deleteVirtualRobotTcp(cell: string, controller: string, id: number, tcp: string, options?: RawAxiosRequestConfig): Promise<axios142.AxiosResponse<object, any>>;
11344
11344
  /**
11345
11345
  * Gets motion group mounting. The motion group is based on the origin of the returned coordinate system.
11346
11346
  * @summary Get Mounting
@@ -11350,7 +11350,7 @@ declare class VirtualRobotSetupApi extends BaseAPI {
11350
11350
  * @param {*} [options] Override http request option.
11351
11351
  * @throws {RequiredError}
11352
11352
  */
11353
- getVirtualRobotMounting(cell: string, controller: string, id: number, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<CoordinateSystem, any>>;
11353
+ getVirtualRobotMounting(cell: string, controller: string, id: number, options?: RawAxiosRequestConfig): Promise<axios142.AxiosResponse<CoordinateSystem, any>>;
11354
11354
  /**
11355
11355
  * Lists all coordinate systems on the robot controller.
11356
11356
  * @summary List Coordinate Systems
@@ -11359,7 +11359,7 @@ declare class VirtualRobotSetupApi extends BaseAPI {
11359
11359
  * @param {*} [options] Override http request option.
11360
11360
  * @throws {RequiredError}
11361
11361
  */
11362
- listVirtualRobotCoordinateSystems(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<CoordinateSystems, any>>;
11362
+ listVirtualRobotCoordinateSystems(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<axios142.AxiosResponse<CoordinateSystems, any>>;
11363
11363
  /**
11364
11364
  * Lists TCPs of the motion group. An empty TCP list is valid, for example for external axes.
11365
11365
  * @summary List TCPs
@@ -11369,7 +11369,7 @@ declare class VirtualRobotSetupApi extends BaseAPI {
11369
11369
  * @param {*} [options] Override http request option.
11370
11370
  * @throws {RequiredError}
11371
11371
  */
11372
- listVirtualRobotTcps(cell: string, controller: string, id: number, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<RobotTcps, any>>;
11372
+ listVirtualRobotTcps(cell: string, controller: string, id: number, options?: RawAxiosRequestConfig): Promise<axios142.AxiosResponse<RobotTcps, any>>;
11373
11373
  /**
11374
11374
  * Sets the motion group mounting by specifying a coordinate system. The motion group will be based on the coordinate system\'s origin. The coordinate system defines a transformation offset, which consists of: - A unique identifier - A name - An offset in another coordinate system, referenced by the unique identifier of the reference coordinate system. > **NOTE** > Changing the mounting configuration is considered a configuration change. > > Upon updating the mounting to another coordinate system, virtual robots are restarted to apply the new configuration. > What happens during restart: > - Robot visualization may temporarily disappear or not reflect the updated mounting. > - Motion group state and coordinate system alignment may not be instantly updated. > - Existing connections to the virtual robot are closed and re-established, which introduces a short delay before NOVA is fully operational again. > > The API call itself **does not wait until the restart and synchronization are complete**. This means that > immediately after a successful response, the new mounting may not be available for visualization or program execution.
11375
11375
  * @summary Set Mounting
@@ -11380,7 +11380,7 @@ declare class VirtualRobotSetupApi extends BaseAPI {
11380
11380
  * @param {*} [options] Override http request option.
11381
11381
  * @throws {RequiredError}
11382
11382
  */
11383
- setVirtualRobotMounting(cell: string, controller: string, id: number, coordinateSystem: CoordinateSystem, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<CoordinateSystem, any>>;
11383
+ setVirtualRobotMounting(cell: string, controller: string, id: number, coordinateSystem: CoordinateSystem, options?: RawAxiosRequestConfig): Promise<axios142.AxiosResponse<CoordinateSystem, any>>;
11384
11384
  }
11385
11385
  //#endregion
11386
11386
  export { AbbController, AbbControllerEgmServer, AbbControllerKindEnum, ActivateLicenseRequest, AddRequest, AllJointPositionsRequest, AllJointPositionsResponse, ApiVersion, App, ApplicationApi, ApplicationApiAxiosParamCreator, ApplicationApiFactory, ApplicationApiFp, ArrayInput, ArrayOutput, BASE_PATH, BaseAPI, Behavior, BlendingAuto, BlendingAutoBlendingNameEnum, BlendingPosition, BlendingPositionBlendingNameEnum, Box, Box2, Box2BoxTypeEnum, Box2ShapeTypeEnum, Box3, Box3ShapeTypeEnum, Box3TypeEnum, BoxTypeEnum, COLLECTION_FORMATS, Capsule, Capsule2, Capsule2ShapeTypeEnum, Capsule3, Capsule3ShapeTypeEnum, Capture, Cell, CellApi, CellApiAxiosParamCreator, CellApiFactory, CellApiFp, Circle, CodeWithArguments, CollectionValue, Collider, ColliderInput, ColliderOutput, ColliderOutputShape, ColliderShape, Collision, CollisionContact, CollisionMotionGroup, CollisionMotionGroupAssembly, CollisionRobotConfigurationInput, CollisionRobotConfigurationOutput, CollisionScene, CollisionSceneAssembly, Command, CommandSettings, Comparator, Compound, Configuration, ConfigurationParameters, ContainerEnvironmentInner, ContainerImage, ContainerImageSecretsInner, ContainerResources, ContainerStorage, ControllerApi, ControllerApiAxiosParamCreator, ControllerApiFactory, ControllerApiFp, ControllerCapabilities, ControllerIOsApi, ControllerIOsApiAxiosParamCreator, ControllerIOsApiFactory, ControllerIOsApiFp, ControllerInstance, ControllerInstanceList, ConvexHull, ConvexHull2, ConvexHull2ShapeTypeEnum, ConvexHull3, ConvexHull3ShapeTypeEnum, CoordinateSystem, CoordinateSystems, CoordinateSystemsApi, CoordinateSystemsApiAxiosParamCreator, CoordinateSystemsApiFactory, CoordinateSystemsApiFp, CreateDeviceRequestInner, CreateProgramRun200Response, CreateProgramRunRequest, CreateTrigger200Response, CreateTriggerRequest, CubicSpline, CubicSplineCubicSplineParameter, CubicSplineParameter, CycleTime, Cylinder, Cylinder2, Cylinder2ShapeTypeEnum, Cylinder3, Cylinder3ShapeTypeEnum, DHParameter, DeviceConfigurationApi, DeviceConfigurationApiAxiosParamCreator, DeviceConfigurationApiFactory, DeviceConfigurationApiFp, Direction, DirectionJoggingRequest, ExecuteTrajectoryRequest, ExecuteTrajectoryResponse, ExecutionResult, ExternalJointStreamDatapoint, ExternalJointStreamDatapointValue, FanucController, FanucControllerKindEnum, FeedbackCollision, FeedbackCollisionErrorFeedbackNameEnum, FeedbackJointLimitExceeded, FeedbackJointLimitExceededErrorFeedbackNameEnum, FeedbackOutOfWorkspace, FeedbackOutOfWorkspaceErrorFeedbackNameEnum, FeedbackSingularity, FeedbackSingularityErrorFeedbackNameEnum, Flag, ForceVector, Geometry, GetAllProgramRuns200Response, GetAllTriggers200Response, GetDefaultLinkChainMotionGroupModelEnum, GetModeResponse, GetTrajectoryResponse, GetTrajectorySampleResponse, GoogleProtobufAny, HTTPExceptionResponse, HTTPValidationError, HTTPValidationError2, IO, IODescription, IODescriptionTypeEnum, IODescriptionUnitEnum, IODescriptionValueTypeEnum, IODirectionEnum, IOValue, IOs, ImageCredentials, InfoServiceCapabilities, InitializeMovementRequest, InitializeMovementResponse, InitializeMovementResponseInitResponse, JoggingResponse, JoggingResponseMovementStateEnum, JoggingServiceCapabilities, JointJoggingRequest, JointLimit, JointLimitExceeded, JointLimitJointEnum, JointPositionRequest, JointTrajectory, Joints, KinematicServiceCapabilities, KukaController, KukaControllerKindEnum, KukaControllerRsiServer, LibraryProgramApi, LibraryProgramApiAxiosParamCreator, LibraryProgramApiFactory, LibraryProgramApiFp, LibraryProgramMetadataApi, LibraryProgramMetadataApiAxiosParamCreator, LibraryProgramMetadataApiFactory, LibraryProgramMetadataApiFp, LibraryRecipeApi, LibraryRecipeApiAxiosParamCreator, LibraryRecipeApiFactory, LibraryRecipeApiFp, LibraryRecipeMetadataApi, LibraryRecipeMetadataApiAxiosParamCreator, LibraryRecipeMetadataApiFactory, LibraryRecipeMetadataApiFp, License, LicenseApi, LicenseApiAxiosParamCreator, LicenseApiFactory, LicenseApiFp, LicenseStatus, LicenseStatusEnum, LimitSettings, LimitsOverride, ListDevices200ResponseInner, ListIODescriptionsResponse, ListIOValuesResponse, ListPayloadsResponse, ListProgramMetadataResponse, ListRecipeMetadataResponse, ListResponse, ListTcpsResponse, Manufacturer, ModeChangeResponse, ModelError, MotionApi, MotionApiAxiosParamCreator, MotionApiFactory, MotionApiFp, MotionCommand, MotionCommandBlending, MotionCommandPath, MotionGroupApi, MotionGroupApiAxiosParamCreator, MotionGroupApiFactory, MotionGroupApiFp, MotionGroupBehaviorGetter, MotionGroupInfo, MotionGroupInfos, MotionGroupInfosApi, MotionGroupInfosApiAxiosParamCreator, MotionGroupInfosApiFactory, MotionGroupInfosApiFp, MotionGroupInstance, MotionGroupInstanceList, MotionGroupJoggingApi, MotionGroupJoggingApiAxiosParamCreator, MotionGroupJoggingApiFactory, MotionGroupJoggingApiFp, MotionGroupJoints, MotionGroupKinematicApi, MotionGroupKinematicApiAxiosParamCreator, MotionGroupKinematicApiFactory, MotionGroupKinematicApiFp, MotionGroupPhysical, MotionGroupSpecification, MotionGroupState, MotionGroupStateJointLimitReached, MotionGroupStateResponse, MotionId, MotionIdsListResponse, MotionVector, Mounting, MoveRequest, MoveResponse, MoveToTrajectoryViaJointPTPRequest, Movement, MovementError, MovementErrorError, MovementMovement, OpMode, OpModeModeEnum, OpcuaNodeValueTriggerConfig, OpcuaNodeValueTriggerConfigNodeValue, OptimizerSetup, OutOfWorkspace, Path, PathCartesianPTP, PathCartesianPTPPathDefinitionNameEnum, PathCircle, PathCirclePathDefinitionNameEnum, PathCubicSpline, PathCubicSplinePathDefinitionNameEnum, PathJointPTP, PathJointPTPPathDefinitionNameEnum, PathLine, PathLinePathDefinitionNameEnum, PauseMovementRequest, PauseMovementResponse, PauseMovementResponsePauseResponse, PauseOnIO, Payload, PlanCollisionFreePTPRequest, PlanCollisionFreePTPRequestTarget, PlanFailedOnTrajectoryResponse, PlanFailedResponse, PlanRequest, PlanResponse, PlanSuccessfulResponse, PlanTrajectoryFailedResponse, PlanTrajectoryFailedResponseErrorFeedback, PlanTrajectoryRequest, PlanTrajectoryResponse, PlanTrajectoryResponseResponse, Plane2, Plane2ShapeTypeEnum, Plane3, Plane3ShapeTypeEnum, PlannedMotion, PlannerPose, PlanningLimits, PlanningLimitsLimitRange, PlaybackSpeedRequest, PlaybackSpeedResponse, PlaybackSpeedResponsePlaybackSpeedResponse, PointCloud, Pose, Pose2, ProgramApi, ProgramApiAxiosParamCreator, ProgramApiFactory, ProgramApiFp, ProgramMetadata, ProgramOperatorApi, ProgramOperatorApiAxiosParamCreator, ProgramOperatorApiFactory, ProgramOperatorApiFp, ProgramRun, ProgramRunObject, ProgramRunState, ProgramRunnerReference, ProgramValuesApi, ProgramValuesApiAxiosParamCreator, ProgramValuesApiFactory, ProgramValuesApiFp, PyjectoryDatatypesCorePose, PyjectoryDatatypesSerializerOrientation, PyjectoryDatatypesSerializerPose, PyjectoryDatatypesSerializerPosition, PyripheryEtcdETCDConfiguration, PyripheryHardwareIsaacIsaacConfiguration, PyripheryOpcuaOPCUAConfiguration, PyripheryPyraeControllerControllerConfiguration, PyripheryPyraeRobotRobotConfiguration, PyripheryPyraeRobotRobotConfigurationTypeEnum, PyripheryRoboticsConfigurableCollisionSceneConfigurableCollisionSceneConfigurationInput, PyripheryRoboticsConfigurableCollisionSceneConfigurableCollisionSceneConfigurationOutput, PyripheryRoboticsRobotcellTimerConfiguration, PyripheryRoboticsRobotcellTimerConfigurationTypeEnum, PyripheryRoboticsSimulationRobotWithViewOpen3dConfiguration, PyripheryRoboticsSimulationSimulatedIOConfiguration, PyripheryRoboticsSimulationSimulatedOPCUAConfiguration, Quaternion, RecipeMetadata, Rectangle, Rectangle2, Rectangle2ShapeTypeEnum, Rectangle3, Rectangle3ShapeTypeEnum, RectangularCapsule, RectangularCapsule2, RectangularCapsule2ShapeTypeEnum, RectangularCapsule3, RectangularCapsule3ShapeTypeEnum, ReleaseChannel, Request, Request1, RequestArgs, RequiredError, ResponseGetValueProgramsValuesKeyGet, ResponseGetValuesProgramsValuesGetValue, RobotController, RobotControllerConfiguration, RobotControllerState, RobotControllerStateOperationModeEnum, RobotControllerStateSafetyStateEnum, RobotLinkGeometry, RobotState, RobotSystemMode, RobotTcp, RobotTcps, RotationAngleTypes, RotationAngles, SafetyConfiguration, SafetySetup, SafetySetupSafetySettings, SafetySetupSafetySettingsSafetyStateEnum, SafetySetupSafetyZone, SafetyZone, SafetyZoneLimits, SafetyZoneViolation, ServiceStatus, ServiceStatusPhase, ServiceStatusSeverity, ServiceStatusStatus, SetDefaultModeModeEnum, SetIO, SetOperationModeModeEnum, SetPlaybackSpeed, SingleJointLimit, SingleJointLimitJointEnum, Singularity, SingularitySingularityTypeEnum, SingularityTypeEnum, Sphere, Sphere2, Sphere2ShapeTypeEnum, Sphere3, Sphere3ShapeTypeEnum, Standstill, StandstillReason, StandstillStandstill, StartMovementRequest, StartOnIO, Status, StopResponse, StopResponseStopCodeEnum, StoreCollisionComponentsApi, StoreCollisionComponentsApiAxiosParamCreator, StoreCollisionComponentsApiFactory, StoreCollisionComponentsApiFp, StoreCollisionScenesApi, StoreCollisionScenesApiAxiosParamCreator, StoreCollisionScenesApiFactory, StoreCollisionScenesApiFp, StoreObjectApi, StoreObjectApiAxiosParamCreator, StoreObjectApiFactory, StoreObjectApiFp, StoreValue, StreamMoveBackward, StreamMoveForward, StreamMovePlaybackSpeed, StreamMoveRequest, StreamMoveResponse, StreamMoveToTrajectory, StreamStop, SystemApi, SystemApiAxiosParamCreator, SystemApiFactory, SystemApiFp, TcpPose, TcpPoseRequest, ToolGeometry, TrajectorySample, TriggerObject, TriggerType, UniversalrobotsController, UniversalrobotsControllerKindEnum, UpdateNovaVersionRequest, UpdateProgramMetadataRequest, UpdateRecipeMetadataRequest, UpdateTriggerRequest, ValidationError, ValidationError2, ValidationError2LocInner, ValidationErrorLocInner, Value, Vector3d, VersionApi, VersionApiAxiosParamCreator, VersionApiFactory, VersionApiFp, VersionNumber, VirtualController, VirtualControllerKindEnum, VirtualControllerTypes, VirtualRobotApi, VirtualRobotApiAxiosParamCreator, VirtualRobotApiFactory, VirtualRobotApiFp, VirtualRobotBehaviorApi, VirtualRobotBehaviorApiAxiosParamCreator, VirtualRobotBehaviorApiFactory, VirtualRobotBehaviorApiFp, VirtualRobotConfiguration, VirtualRobotModeApi, VirtualRobotModeApiAxiosParamCreator, VirtualRobotModeApiFactory, VirtualRobotModeApiFp, VirtualRobotSetupApi, VirtualRobotSetupApiAxiosParamCreator, VirtualRobotSetupApiFactory, VirtualRobotSetupApiFp, WaitForIOEventComparisonTypeEnum, YaskawaController, YaskawaControllerKindEnum, operationServerMap };