@wandelbots/nova-api 25.9.0-dev.14 → 25.9.0-dev.16

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.
@@ -230,7 +230,7 @@ interface AddTrajectoryError {
230
230
  */
231
231
  'message'?: string;
232
232
  /**
233
- * 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
233
+ * 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
234
234
  * @type {number}
235
235
  * @memberof AddTrajectoryError
236
236
  */
@@ -298,7 +298,7 @@ interface AddTrajectoryResponse {
298
298
  */
299
299
  interface App {
300
300
  /**
301
- * The name of the provided application. The name must be unique within the cell and is used as a identifier for addressing the application in all API calls , e.g. when updating the application. It also defines where the application is reachable (/$cell/$name). It must be a valid k8s label name as defined by [RFC 1035](https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#rfc-1035-label-names).
301
+ * The name of the provided application. The name must be unique within the cell and is used as a identifier for addressing the application in all API calls , e.g., when updating the application. It also defines where the application is reachable (/$cell/$name). It must be a valid k8s label name as defined by [RFC 1035](https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#rfc-1035-label-names).
302
302
  * @type {string}
303
303
  * @memberof App
304
304
  */
@@ -353,7 +353,7 @@ interface App {
353
353
  'diagnosis_path'?: string;
354
354
  }
355
355
  /**
356
- * ## BEHAVIOR_AUTOMATIC This is the default behavior. The motion groups of the controller take 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).
356
+ * ## BEHAVIOR_AUTOMATIC This is the default behavior. The motion groups of the controller take 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).
357
357
  * @export
358
358
  * @enum {string}
359
359
  */
@@ -627,7 +627,7 @@ interface BusIOsState {
627
627
  */
628
628
  'state': BusIOsStateEnum;
629
629
  /**
630
- * A message providing additional information on the input/output service, e.g. BUS service status, encountered errors. May be empty if no additional information is available.
630
+ * A message providing additional information on the input/output service, e.g., BUS service status, encountered errors. May be empty if no additional information is available.
631
631
  * @type {string}
632
632
  * @memberof BusIOsState
633
633
  */
@@ -706,7 +706,7 @@ interface CartesianLimits {
706
706
  'orientation_acceleration'?: number;
707
707
  }
708
708
  /**
709
- * To create a robot cell, only a valid name is required. Once created, a robot cell provides access to the Wandelbots NOVA foundation services. The configuration can be customized, e.g. robot controllers, also within apps.
709
+ * To create a robot cell, only a valid name is required. Once created, a robot cell provides access to the Wandelbots NOVA foundation services. The configuration can be customized, e.g., robot controllers, also within apps.
710
710
  * @export
711
711
  * @interface Cell
712
712
  */
@@ -1410,7 +1410,7 @@ declare const ErrorJointLimitExceededErrorFeedbackNameEnum: {
1410
1410
  };
1411
1411
  type ErrorJointLimitExceededErrorFeedbackNameEnum = typeof ErrorJointLimitExceededErrorFeedbackNameEnum[keyof typeof ErrorJointLimitExceededErrorFeedbackNameEnum];
1412
1412
  /**
1413
- * A reference joint position (e.g. start or target joint position) results in collisions that prevent processing.
1413
+ * A reference joint position, e.g., start or target joint position, results in collisions that prevent processing.
1414
1414
  * @export
1415
1415
  * @interface ErrorJointPositionCollision
1416
1416
  */
@@ -1960,7 +1960,7 @@ interface IODescription2 {
1960
1960
  */
1961
1961
  'io': string;
1962
1962
  /**
1963
- * Name of the input/output. Customize it using the respective BUS service, e.g. [addProfinetIO](addProfinetIO) for PROFINET service.
1963
+ * Name of the input/output. Customize it using the respective BUS service, e.g., [addProfinetIO](addProfinetIO) for PROFINET service.
1964
1964
  * @type {string}
1965
1965
  * @memberof IODescription2
1966
1966
  */
@@ -2247,7 +2247,7 @@ interface InitializeMovementRequest {
2247
2247
  */
2248
2248
  'trajectory': InitializeMovementRequestTrajectory;
2249
2249
  /**
2250
- * 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
2250
+ * 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
2251
2251
  * @type {number}
2252
2252
  * @memberof InitializeMovementRequest
2253
2253
  */
@@ -2407,7 +2407,7 @@ interface InverseKinematicsRequest {
2407
2407
  */
2408
2408
  'joint_position_limits'?: Array<LimitRange>;
2409
2409
  /**
2410
- * Collision layers to be respected by the motion planner when planning for a single motion group. Each setup represents one layer, e.g. the safety zones and shapes or a fine grained tool and workpiece model. Layers are checked individually along the trajectory and independently of other layers. To respect the safety zones of the controller and check for collision: 1. Fetch the safety zones, link and tool shapes from the controller. 2. Add the fetched zones, links and tools to a layer. 3. Create other layers from your own 3D data as needed. 4. Plan trajectory. 5. The response highlights the layer in which a collision was detected by key.
2410
+ * Collision layers to be respected by the motion planner when planning for a single motion group. Each setup represents one layer, e.g., the safety zones and shapes or a fine grained tool and workpiece model. Layers are checked individually along the trajectory and independently of other layers. To respect the safety zones of the controller and check for collision: 1. Fetch the safety zones, link and tool shapes from the controller. 2. Add the fetched zones, links and tools to a layer. 3. Create other layers from your own 3D data as needed. 4. Plan trajectory. 5. The response highlights the layer in which a collision was detected by key.
2411
2411
  * @type {{ [key: string]: CollisionSetup; }}
2412
2412
  * @memberof InverseKinematicsRequest
2413
2413
  */
@@ -2694,7 +2694,7 @@ interface JointVelocityRequest {
2694
2694
  */
2695
2695
  'message_type'?: JointVelocityRequestMessageTypeEnum;
2696
2696
  /**
2697
- * This structure describes a set of joint values (e.g. positions, currents, torques) of a motion group. Float precision is the default.
2697
+ * This structure describes a set of joint values, e.g., positions, currents, torques, of a motion group. Float precision is the default.
2698
2698
  * @type {Array<number>}
2699
2699
  * @memberof JointVelocityRequest
2700
2700
  */
@@ -3269,7 +3269,7 @@ interface MotionGroupSetup {
3269
3269
  */
3270
3270
  'payload'?: Payload;
3271
3271
  /**
3272
- * Collision layers to be respected by the motion planner when planning for a single motion group. Each setup represents one layer, e.g. the safety zones and shapes or a fine grained tool and workpiece model. Layers are checked individually along the trajectory and independently of other layers. To respect the safety zones of the controller and check for collision: 1. Fetch the safety zones, link and tool shapes from the controller. 2. Add the fetched zones, links and tools to a layer. 3. Create other layers from your own 3D data as needed. 4. Plan trajectory. 5. The response highlights the layer in which a collision was detected by key.
3272
+ * Collision layers to be respected by the motion planner when planning for a single motion group. Each setup represents one layer, e.g., the safety zones and shapes or a fine grained tool and workpiece model. Layers are checked individually along the trajectory and independently of other layers. To respect the safety zones of the controller and check for collision: 1. Fetch the safety zones, link and tool shapes from the controller. 2. Add the fetched zones, links and tools to a layer. 3. Create other layers from your own 3D data as needed. 4. Plan trajectory. 5. The response highlights the layer in which a collision was detected by key.
3273
3273
  * @type {{ [key: string]: CollisionSetup; }}
3274
3274
  * @memberof MotionGroupSetup
3275
3275
  */
@@ -3308,7 +3308,7 @@ interface MotionGroupState {
3308
3308
  */
3309
3309
  'controller': string;
3310
3310
  /**
3311
- * This structure describes a set of joint values (e.g. positions, currents, torques) of a motion group. Float precision is the default.
3311
+ * This structure describes a set of joint values, e.g., positions, currents, torques, of a motion group. Float precision is the default.
3312
3312
  * @type {Array<number>}
3313
3313
  * @memberof MotionGroupState
3314
3314
  */
@@ -3320,13 +3320,13 @@ interface MotionGroupState {
3320
3320
  */
3321
3321
  'joint_limit_reached': MotionGroupStateJointLimitReached;
3322
3322
  /**
3323
- * This structure describes a set of joint values (e.g. positions, currents, torques) of a motion group. Float precision is the default.
3323
+ * This structure describes a set of joint values, e.g., positions, currents, torques, of a motion group. Float precision is the default.
3324
3324
  * @type {Array<number>}
3325
3325
  * @memberof MotionGroupState
3326
3326
  */
3327
3327
  'joint_torque'?: Array<number>;
3328
3328
  /**
3329
- * This structure describes a set of joint values (e.g. positions, currents, torques) of a motion group. Float precision is the default.
3329
+ * This structure describes a set of joint values, e.g., positions, currents, torques, of a motion group. Float precision is the default.
3330
3330
  * @type {Array<number>}
3331
3331
  * @memberof MotionGroupState
3332
3332
  */
@@ -3368,7 +3368,7 @@ interface MotionGroupState {
3368
3368
  */
3369
3369
  'standstill': boolean;
3370
3370
  /**
3371
- * Data that was commanded to the motion group. Includes additional data on NOVA\'s execution components for executing trajectories and jogging. This is a convenience field to indicate the last command sent to the motion group. It is not available in all cases, e.g. if the motion group is not moved by NOVA.
3371
+ * Data that was commanded to the motion group. Includes additional data on NOVA\'s execution components for executing trajectories and jogging. This is a convenience field to indicate the last command sent to the motion group. It is not available in all cases, e.g., if the motion group is not moved by NOVA.
3372
3372
  * @type {Execute}
3373
3373
  * @memberof MotionGroupState
3374
3374
  */
@@ -3887,7 +3887,7 @@ interface PlanTrajectoryFailedResponse {
3887
3887
  */
3888
3888
  'error_feedback': PlanTrajectoryFailedResponseErrorFeedback;
3889
3889
  /**
3890
- * 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
3890
+ * 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
3891
3891
  * @type {number}
3892
3892
  * @memberof PlanTrajectoryFailedResponse
3893
3893
  */
@@ -4136,13 +4136,13 @@ interface ProfinetIO {
4136
4136
  */
4137
4137
  'type': ProfinetIOTypeEnum;
4138
4138
  /**
4139
- * The direction of the input/output variable, indicating whether it is an input or output for the PROFINET device, e.g. NOVA\'s PROFINET service.
4139
+ * The direction of the input/output variable, indicating whether it is an input or output for the PROFINET device, e.g., NOVA\'s PROFINET service.
4140
4140
  * @type {ProfinetIODirection}
4141
4141
  * @memberof ProfinetIO
4142
4142
  */
4143
4143
  'direction': ProfinetIODirection;
4144
4144
  /**
4145
- * The byte address of the input/output variable in the PROFINET device, e.g. NOVA\'s PROFINET service. The byte address is used to locate the specific input/output variable within the device\'s memory or data structure.
4145
+ * The byte address of the input/output variable in the PROFINET device, e.g., NOVA\'s PROFINET service. The byte address is used to locate the specific input/output variable within the device\'s memory or data structure.
4146
4146
  * @type {number}
4147
4147
  * @memberof ProfinetIO
4148
4148
  */
@@ -4154,7 +4154,7 @@ interface ProfinetIO {
4154
4154
  */
4155
4155
  'bit_address'?: number;
4156
4156
  /**
4157
- * The unique identifier for the input/output value. This identifier is used to reference the specific input/output variable in the PROFINET device, e.g. NOVA\'s PROFINET service.
4157
+ * The unique identifier for the input/output value. This identifier is used to reference the specific input/output variable in the PROFINET device, e.g., NOVA\'s PROFINET service.
4158
4158
  * @type {string}
4159
4159
  * @memberof ProfinetIO
4160
4160
  */
@@ -4179,13 +4179,13 @@ interface ProfinetIOData {
4179
4179
  */
4180
4180
  'type': ProfinetIOTypeEnum;
4181
4181
  /**
4182
- * The direction of the input/output variable, indicating whether it is an input or output for the PROFINET device, e.g. NOVA\'s PROFINET service.
4182
+ * The direction of the input/output variable, indicating whether it is an input or output for the PROFINET device, e.g., NOVA\'s PROFINET service.
4183
4183
  * @type {ProfinetIODirection}
4184
4184
  * @memberof ProfinetIOData
4185
4185
  */
4186
4186
  'direction': ProfinetIODirection;
4187
4187
  /**
4188
- * The byte address of the input/output variable in the PROFINET device, e.g. NOVA\'s PROFINET service. The byte address is used to locate the specific input/output variable within the device\'s memory or data structure.
4188
+ * The byte address of the input/output variable in the PROFINET device, e.g., NOVA\'s PROFINET service. The byte address is used to locate the specific input/output variable within the device\'s memory or data structure.
4189
4189
  * @type {number}
4190
4190
  * @memberof ProfinetIOData
4191
4191
  */
@@ -4198,7 +4198,7 @@ interface ProfinetIOData {
4198
4198
  'bit_address'?: number;
4199
4199
  }
4200
4200
  /**
4201
- * The direction of the input/output variable, indicating whether it is an input or output for the PROFINET device, e.g. NOVA\'s PROFINET service.
4201
+ * The direction of the input/output variable, indicating whether it is an input or output for the PROFINET device, e.g., NOVA\'s PROFINET service.
4202
4202
  * @export
4203
4203
  * @enum {string}
4204
4204
  */
@@ -4252,7 +4252,7 @@ interface ProfinetInputOutputConfig {
4252
4252
  'output_offset': number;
4253
4253
  }
4254
4254
  /**
4255
- * An array of PROFINET slots. PROFINET models each device’s input/output hardware as a hierarchy of slots (modules) and subslots (submodules). A slot can represent a physical or virtual input/output card and each subslot one of its individual channels or functions. Every slot and subslot has unique identifiers that the controller uses to map cyclic input/output data and parameter records to its process image. This slot/subslot separation enables e.g. addressing each input/output stream when establishing input/output application relations (I/O-AR).
4255
+ * An array of PROFINET slots. PROFINET models each device’s input/output hardware as a hierarchy of slots (modules) and subslots (submodules). A slot can represent a physical or virtual input/output card and each subslot one of its individual channels or functions. Every slot and subslot has unique identifiers that the controller uses to map cyclic input/output data and parameter records to its process image. This slot/subslot separation enables e.g., addressing each input/output stream when establishing input/output application relations (I/O-AR).
4256
4256
  * @export
4257
4257
  * @interface ProfinetSlotDescription
4258
4258
  */
@@ -4956,7 +4956,7 @@ interface StartMovementRequest {
4956
4956
  */
4957
4957
  'direction'?: Direction;
4958
4958
  /**
4959
- * 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
4959
+ * 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
4960
4960
  * @type {number}
4961
4961
  * @memberof StartMovementRequest
4962
4962
  */
@@ -5227,7 +5227,7 @@ interface TrajectoryDetails {
5227
5227
  */
5228
5228
  'trajectory': string;
5229
5229
  /**
5230
- * 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
5230
+ * 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
5231
5231
  * @type {number}
5232
5232
  * @memberof TrajectoryDetails
5233
5233
  */
@@ -5526,7 +5526,7 @@ interface VirtualController {
5526
5526
  */
5527
5527
  'json'?: string;
5528
5528
  /**
5529
- * Initial joint position of the first motion group from the virtual robot controller. Provide the joint position as a JSON array containing 7 float values, each representing a joint position in radians, e.g. \"[0, 0, 0, 0, 0, 0, 0]\". If the robot has fewer than 7 joints, use \"0\" for each remaining position to ensure the array has exactly 7 values.
5529
+ * Initial joint position of the first motion group from the virtual robot controller. Provide the joint position as a JSON array containing 7 float values, each representing a joint position in radians, e.g., \"[0, 0, 0, 0, 0, 0, 0]\". If the robot has fewer than 7 joints, use \"0\" for each remaining position to ensure the array has exactly 7 values.
5530
5530
  * @type {string}
5531
5531
  * @memberof VirtualController
5532
5532
  */
@@ -5722,7 +5722,7 @@ type YaskawaControllerKindEnum = typeof YaskawaControllerKindEnum[keyof typeof Y
5722
5722
  */
5723
5723
  declare const ApplicationApiAxiosParamCreator: (configuration?: Configuration) => {
5724
5724
  /**
5725
- * Install a basic, containerized web application to the cell to control robots with a customized frontend. Prerequisites: A Docker hub account or similar container registry account, with valid credentials. After adding the application to the cell, open the application on the Wandelbots NOVA home screen. Read [build your application](/docs/docs/development/) for more information. <!-- theme: none --> > #### Predefined Environment Variables > - `NOVA_API`: The API endpoint accessible from within the application container. > - `NATS_BROKER`: The NATS broker endpoint accessible from within the application container. > - `BASE_PATH`: The application\'s root path, accessible at http://$host/$BASE_PATH > - `CELL_NAME`: The name of the cell hosting the deployed application.
5725
+ * Install a basic, containerized web application to the cell to control robots with a customized frontend. #### Prerequisites - A Docker hub account or similar container registry account, with valid credentials. #### Workflow After adding the application to the cell, open the application on the Wandelbots NOVA home screen. Read [build your application](https://docs.wandelbots.io/latest/developing-introduction) for more information. #### Predefined environment variables <!-- theme: NOTE --> > **NOTE** > - `NOVA_API`: The API endpoint accessible from within the application container. > - `NATS_BROKER`: The NATS broker endpoint accessible from within the application container. > - `BASE_PATH`: The application\'s root path, accessible at http://$host/$BASE_PATH > - `CELL_NAME`: The name of the cell hosting the deployed application.
5726
5726
  * @summary Add Application
5727
5727
  * @param {string} cell Unique identifier addressing a cell in all API calls.
5728
5728
  * @param {App} app
@@ -5751,7 +5751,7 @@ declare const ApplicationApiAxiosParamCreator: (configuration?: Configuration) =
5751
5751
  */
5752
5752
  deleteApp: (cell: string, app: string, completionTimeout?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
5753
5753
  /**
5754
- * 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.
5754
+ * 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 [updateApp](updateApp).
5755
5755
  * @summary Configuration
5756
5756
  * @param {string} cell Unique identifier addressing a cell in all API calls.
5757
5757
  * @param {string} app
@@ -5760,7 +5760,7 @@ declare const ApplicationApiAxiosParamCreator: (configuration?: Configuration) =
5760
5760
  */
5761
5761
  getApp: (cell: string, app: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
5762
5762
  /**
5763
- * 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.
5763
+ * List all GUI applications that have been added to a cell with [addApp](addApp). If the cell does not contain GUI applications, the list is returned empty.
5764
5764
  * @summary List Applications
5765
5765
  * @param {string} cell Unique identifier addressing a cell in all API calls.
5766
5766
  * @param {*} [options] Override http request option.
@@ -5785,7 +5785,7 @@ declare const ApplicationApiAxiosParamCreator: (configuration?: Configuration) =
5785
5785
  */
5786
5786
  declare const ApplicationApiFp: (configuration?: Configuration) => {
5787
5787
  /**
5788
- * Install a basic, containerized web application to the cell to control robots with a customized frontend. Prerequisites: A Docker hub account or similar container registry account, with valid credentials. After adding the application to the cell, open the application on the Wandelbots NOVA home screen. Read [build your application](/docs/docs/development/) for more information. <!-- theme: none --> > #### Predefined Environment Variables > - `NOVA_API`: The API endpoint accessible from within the application container. > - `NATS_BROKER`: The NATS broker endpoint accessible from within the application container. > - `BASE_PATH`: The application\'s root path, accessible at http://$host/$BASE_PATH > - `CELL_NAME`: The name of the cell hosting the deployed application.
5788
+ * Install a basic, containerized web application to the cell to control robots with a customized frontend. #### Prerequisites - A Docker hub account or similar container registry account, with valid credentials. #### Workflow After adding the application to the cell, open the application on the Wandelbots NOVA home screen. Read [build your application](https://docs.wandelbots.io/latest/developing-introduction) for more information. #### Predefined environment variables <!-- theme: NOTE --> > **NOTE** > - `NOVA_API`: The API endpoint accessible from within the application container. > - `NATS_BROKER`: The NATS broker endpoint accessible from within the application container. > - `BASE_PATH`: The application\'s root path, accessible at http://$host/$BASE_PATH > - `CELL_NAME`: The name of the cell hosting the deployed application.
5789
5789
  * @summary Add Application
5790
5790
  * @param {string} cell Unique identifier addressing a cell in all API calls.
5791
5791
  * @param {App} app
@@ -5814,7 +5814,7 @@ declare const ApplicationApiFp: (configuration?: Configuration) => {
5814
5814
  */
5815
5815
  deleteApp(cell: string, app: string, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
5816
5816
  /**
5817
- * 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.
5817
+ * 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 [updateApp](updateApp).
5818
5818
  * @summary Configuration
5819
5819
  * @param {string} cell Unique identifier addressing a cell in all API calls.
5820
5820
  * @param {string} app
@@ -5823,7 +5823,7 @@ declare const ApplicationApiFp: (configuration?: Configuration) => {
5823
5823
  */
5824
5824
  getApp(cell: string, app: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<App>>;
5825
5825
  /**
5826
- * 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.
5826
+ * List all GUI applications that have been added to a cell with [addApp](addApp). If the cell does not contain GUI applications, the list is returned empty.
5827
5827
  * @summary List Applications
5828
5828
  * @param {string} cell Unique identifier addressing a cell in all API calls.
5829
5829
  * @param {*} [options] Override http request option.
@@ -5848,7 +5848,7 @@ declare const ApplicationApiFp: (configuration?: Configuration) => {
5848
5848
  */
5849
5849
  declare const ApplicationApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
5850
5850
  /**
5851
- * Install a basic, containerized web application to the cell to control robots with a customized frontend. Prerequisites: A Docker hub account or similar container registry account, with valid credentials. After adding the application to the cell, open the application on the Wandelbots NOVA home screen. Read [build your application](/docs/docs/development/) for more information. <!-- theme: none --> > #### Predefined Environment Variables > - `NOVA_API`: The API endpoint accessible from within the application container. > - `NATS_BROKER`: The NATS broker endpoint accessible from within the application container. > - `BASE_PATH`: The application\'s root path, accessible at http://$host/$BASE_PATH > - `CELL_NAME`: The name of the cell hosting the deployed application.
5851
+ * Install a basic, containerized web application to the cell to control robots with a customized frontend. #### Prerequisites - A Docker hub account or similar container registry account, with valid credentials. #### Workflow After adding the application to the cell, open the application on the Wandelbots NOVA home screen. Read [build your application](https://docs.wandelbots.io/latest/developing-introduction) for more information. #### Predefined environment variables <!-- theme: NOTE --> > **NOTE** > - `NOVA_API`: The API endpoint accessible from within the application container. > - `NATS_BROKER`: The NATS broker endpoint accessible from within the application container. > - `BASE_PATH`: The application\'s root path, accessible at http://$host/$BASE_PATH > - `CELL_NAME`: The name of the cell hosting the deployed application.
5852
5852
  * @summary Add Application
5853
5853
  * @param {string} cell Unique identifier addressing a cell in all API calls.
5854
5854
  * @param {App} app
@@ -5877,7 +5877,7 @@ declare const ApplicationApiFactory: (configuration?: Configuration, basePath?:
5877
5877
  */
5878
5878
  deleteApp(cell: string, app: string, completionTimeout?: number, options?: RawAxiosRequestConfig): AxiosPromise<void>;
5879
5879
  /**
5880
- * 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.
5880
+ * 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 [updateApp](updateApp).
5881
5881
  * @summary Configuration
5882
5882
  * @param {string} cell Unique identifier addressing a cell in all API calls.
5883
5883
  * @param {string} app
@@ -5886,7 +5886,7 @@ declare const ApplicationApiFactory: (configuration?: Configuration, basePath?:
5886
5886
  */
5887
5887
  getApp(cell: string, app: string, options?: RawAxiosRequestConfig): AxiosPromise<App>;
5888
5888
  /**
5889
- * 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.
5889
+ * List all GUI applications that have been added to a cell with [addApp](addApp). If the cell does not contain GUI applications, the list is returned empty.
5890
5890
  * @summary List Applications
5891
5891
  * @param {string} cell Unique identifier addressing a cell in all API calls.
5892
5892
  * @param {*} [options] Override http request option.
@@ -5913,7 +5913,7 @@ declare const ApplicationApiFactory: (configuration?: Configuration, basePath?:
5913
5913
  */
5914
5914
  declare class ApplicationApi extends BaseAPI {
5915
5915
  /**
5916
- * Install a basic, containerized web application to the cell to control robots with a customized frontend. Prerequisites: A Docker hub account or similar container registry account, with valid credentials. After adding the application to the cell, open the application on the Wandelbots NOVA home screen. Read [build your application](/docs/docs/development/) for more information. <!-- theme: none --> > #### Predefined Environment Variables > - `NOVA_API`: The API endpoint accessible from within the application container. > - `NATS_BROKER`: The NATS broker endpoint accessible from within the application container. > - `BASE_PATH`: The application\'s root path, accessible at http://$host/$BASE_PATH > - `CELL_NAME`: The name of the cell hosting the deployed application.
5916
+ * Install a basic, containerized web application to the cell to control robots with a customized frontend. #### Prerequisites - A Docker hub account or similar container registry account, with valid credentials. #### Workflow After adding the application to the cell, open the application on the Wandelbots NOVA home screen. Read [build your application](https://docs.wandelbots.io/latest/developing-introduction) for more information. #### Predefined environment variables <!-- theme: NOTE --> > **NOTE** > - `NOVA_API`: The API endpoint accessible from within the application container. > - `NATS_BROKER`: The NATS broker endpoint accessible from within the application container. > - `BASE_PATH`: The application\'s root path, accessible at http://$host/$BASE_PATH > - `CELL_NAME`: The name of the cell hosting the deployed application.
5917
5917
  * @summary Add Application
5918
5918
  * @param {string} cell Unique identifier addressing a cell in all API calls.
5919
5919
  * @param {App} app
@@ -5945,7 +5945,7 @@ declare class ApplicationApi extends BaseAPI {
5945
5945
  */
5946
5946
  deleteApp(cell: string, app: string, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
5947
5947
  /**
5948
- * 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.
5948
+ * 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 [updateApp](updateApp).
5949
5949
  * @summary Configuration
5950
5950
  * @param {string} cell Unique identifier addressing a cell in all API calls.
5951
5951
  * @param {string} app
@@ -5955,7 +5955,7 @@ declare class ApplicationApi extends BaseAPI {
5955
5955
  */
5956
5956
  getApp(cell: string, app: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<App, any>>;
5957
5957
  /**
5958
- * 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.
5958
+ * List all GUI applications that have been added to a cell with [addApp](addApp). If the cell does not contain GUI applications, the list is returned empty.
5959
5959
  * @summary List Applications
5960
5960
  * @param {string} cell Unique identifier addressing a cell in all API calls.
5961
5961
  * @param {*} [options] Override http request option.
@@ -5992,7 +5992,7 @@ declare const BUSInputsOutputsApiAxiosParamCreator: (configuration?: Configurati
5992
5992
  */
5993
5993
  addBusIOService: (cell: string, busIOType: BusIOType, completionTimeout?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
5994
5994
  /**
5995
- * Adds an input/output variable to or updates an input/output variable on the PROFINET device, e.g. NOVA\'s PROFINET service. The inputs/outputs map variables to specific memory addresses in the process image. The default process image has buffer lengths of 64 bytes for input and output. The size of the buffer is determined by the `config_file_content` that is passed in [addBusIOService](addBusIOService) and has to be in accordance with the GSDML file describing the PROFINET device. The PROFINET controller as well as NOVA\'s PROFINET service use an input/output variable configuration to interpret the bits of the input/output process image. The NOVA\'s PROFINET service\'s configuration can be viewed via [listProfinetIOs](listProfinetIOs). For the PROFINET controller, e.g. a connected PLC, refer to the corresponding third party software, e.g. TIA portal).
5995
+ * Adds an input/output variable to or updates an input/output variable on the PROFINET device, e.g., NOVA\'s PROFINET service. The inputs/outputs map variables to specific memory addresses in the process image. The default process image has buffer lengths of 64 bytes for input and output. - The size of the buffer is determined by the `config_file_content` that is passed in [addBusIOService](addBusIOService) and has to be in accordance with the GSDML file describing the PROFINET device. The PROFINET controller as well as NOVA\'s PROFINET service use an input/output variable configuration to interpret the bits of the input/output process image. - The NOVA\'s PROFINET service\'s configuration can be viewed via [listProfinetIOs](listProfinetIOs). For the PROFINET controller, e.g., a connected PLC, refer to the corresponding third party software, e.g., TIA portal).
5996
5996
  * @summary Add PROFINET Input/Output
5997
5997
  * @param {string} cell Unique identifier addressing a cell in all API calls.
5998
5998
  * @param {string} io Unique identifier to address an Input/Output in the cell.
@@ -6011,7 +6011,7 @@ declare const BUSInputsOutputsApiAxiosParamCreator: (configuration?: Configurati
6011
6011
  */
6012
6012
  clearBusIOService: (cell: string, completionTimeout?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
6013
6013
  /**
6014
- * Removes an input/output variable configuration from the PROFINET device, e.g. NOVA\'s PROFINET service.
6014
+ * Removes an input/output variable configuration from the PROFINET device, e.g., NOVA\'s PROFINET service.
6015
6015
  * @summary Remove PROFINET Input/Ouptut
6016
6016
  * @param {string} cell Unique identifier addressing a cell in all API calls.
6017
6017
  * @param {string} io Unique identifier to address an Input/Output in the cell.
@@ -6053,7 +6053,7 @@ declare const BUSInputsOutputsApiAxiosParamCreator: (configuration?: Configurati
6053
6053
  */
6054
6054
  getProfinetDescription: (cell: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
6055
6055
  /**
6056
- * Get input/output variable configuration of the PROFINET device, e.g. NOVA\'s PROFINET service as file. You can specify byte offsets for the input and output variable addresses to get an XML tagmap that is ready to paste to the third party software, e.g. TIA portal.
6056
+ * Get input/output variable configuration of the PROFINET device, e.g., NOVA\'s PROFINET service as file. You can specify byte offsets for the input and output variable addresses to get an XML tagmap that is ready to paste to the third party software, e.g., TIA portal.
6057
6057
  * @summary PROFINET Inputs/Outputs to File
6058
6058
  * @param {string} cell Unique identifier addressing a cell in all API calls.
6059
6059
  * @param {number} [inputOffset]
@@ -6063,7 +6063,7 @@ declare const BUSInputsOutputsApiAxiosParamCreator: (configuration?: Configurati
6063
6063
  */
6064
6064
  getProfinetIOsFromFile: (cell: string, inputOffset?: number, outputOffset?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
6065
6065
  /**
6066
- * List all input/output descriptions for configured BUS services. The input/output descriptions contain information such as the name, the type and the unit. The input/output direction is given in perspective of the BUS service.
6066
+ * List all input/output descriptions for configured BUS services. The input/output descriptions contain information like name, type and unit. The input/output direction is given in perspective of the BUS service.
6067
6067
  * @summary List Descriptions
6068
6068
  * @param {string} cell Unique identifier addressing a cell in all API calls.
6069
6069
  * @param {*} [options] Override http request option.
@@ -6071,7 +6071,7 @@ declare const BUSInputsOutputsApiAxiosParamCreator: (configuration?: Configurati
6071
6071
  */
6072
6072
  listBusIODescriptions: (cell: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
6073
6073
  /**
6074
- * List descriptions for all configured input/output variables of the PROFINET service. The input/output descriptions contain information such as the name, the type and the unit. The input/output direction is given in perspective of the PROFINET Device, e.g. the configured PROFINET service. The byte and bit addresses are the locations in the PROFINET input/output process image the variable points to. The PROFINET controller as well as NOVA\'s PROFINET service use an input/output variable configuration to interpret the bits of the input and output process image. The NOVA PROFINET service\'s configuration is modified via [addProfinetIO](addProfinetIO) and [setProfinetIOsFromFile](setProfinetIOsFromFile). For the PROFINET controller, e.g. a connected PLC, refer to the corresponding third party software, e.g. TIA portal.
6074
+ * List descriptions for all configured input/output variables of the PROFINET service. The input/output descriptions contain information like name, type and unit. The input/output direction is given in perspective of the PROFINET Device, e.g., the configured PROFINET service. - The byte and bit addresses are the locations in the PROFINET input/output process image the variable points to. - The PROFINET controller as well as NOVA\'s PROFINET service use an input/output variable configuration to interpret the bits of the input and output process image. - The NOVA PROFINET service\'s configuration is modified via [addProfinetIO](addProfinetIO) and [setProfinetIOsFromFile](setProfinetIOsFromFile). For the PROFINET controller, e.g., a connected PLC, refer to the corresponding third party software, e.g., TIA portal.
6075
6075
  * @summary List PROFINET Input/Output Configuration
6076
6076
  * @param {string} cell Unique identifier addressing a cell in all API calls.
6077
6077
  * @param {*} [options] Override http request option.
@@ -6088,7 +6088,7 @@ declare const BUSInputsOutputsApiAxiosParamCreator: (configuration?: Configurati
6088
6088
  */
6089
6089
  setBusIOValues: (cell: string, iOValue: Array<IOValue>, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
6090
6090
  /**
6091
- * Sets input/output variable configuration on the PROFINET device (i.e. NOVA\'s PROFINET service) from XML file. The inputs/outputs map variables to specific memory addresses in the process image. The default process image has buffer lengths of 64 bytes for input and output. The size of the buffer is determined by the `config_file_content` that is passed in [addBusIOService](addBusIOService) and has to be in accordance with the GSDML file describing the PROFINET device. The PROFINET controller as well as NOVA\'s PROFINET service use an input/output variable configuration to interpret the bits of the input/output process image. The NOVA\'s PROFINET service\'s configuration can be viewed via [listProfinetIOs](listProfinetIOs). For the PROFINET controller, e.g. a connected PLC, refer to the corresponding engineering system, e.g. TIA portal. You can export the variable configuration of the PROFINET controller as XML file from your engineering system, e.g. TIA portal. The endpoint is built so that the perspective of input and output (PROFINET Device\'s input is PROFINET Controller\'s output) is internally handled (PROFINET device input is PROFINET controller output), meaning that you can paste the exported XML file here without modifying.
6091
+ * Sets input/output variable configuration on the PROFINET device (i.e. NOVA\'s PROFINET service) from XML file. The inputs/outputs map variables to specific memory addresses in the process image. The default process image has buffer lengths of 64 bytes for input and output. - The size of the buffer is determined by the `config_file_content` that is passed in [addBusIOService](addBusIOService) and has to be in accordance with the GSDML file describing the PROFINET device. The PROFINET controller as well as NOVA\'s PROFINET service use an input/output variable configuration to interpret the bits of the input/output process image. - The NOVA\'s PROFINET service\'s configuration can be viewed via [listProfinetIOs](listProfinetIOs). For the PROFINET controller, e.g., a connected PLC, refer to the corresponding engineering system, e.g., TIA portal. #### Export variables You can export the variable configuration of the PROFINET controller as XML file from your engineering system, e.g., TIA portal. - The endpoint is built so that the perspective of input and output (PROFINET Device\'s input is PROFINET Controller\'s output) is internally handled (PROFINET device input is PROFINET controller output), meaning that you can paste the exported XML file here without modifying.
6092
6092
  * @summary Set PROFINET Inputs/Outputs from File
6093
6093
  * @param {string} cell Unique identifier addressing a cell in all API calls.
6094
6094
  * @param {ProfinetInputOutputConfig} profinetInputOutputConfig
@@ -6113,7 +6113,7 @@ declare const BUSInputsOutputsApiFp: (configuration?: Configuration) => {
6113
6113
  */
6114
6114
  addBusIOService(cell: string, busIOType: BusIOType, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
6115
6115
  /**
6116
- * Adds an input/output variable to or updates an input/output variable on the PROFINET device, e.g. NOVA\'s PROFINET service. The inputs/outputs map variables to specific memory addresses in the process image. The default process image has buffer lengths of 64 bytes for input and output. The size of the buffer is determined by the `config_file_content` that is passed in [addBusIOService](addBusIOService) and has to be in accordance with the GSDML file describing the PROFINET device. The PROFINET controller as well as NOVA\'s PROFINET service use an input/output variable configuration to interpret the bits of the input/output process image. The NOVA\'s PROFINET service\'s configuration can be viewed via [listProfinetIOs](listProfinetIOs). For the PROFINET controller, e.g. a connected PLC, refer to the corresponding third party software, e.g. TIA portal).
6116
+ * Adds an input/output variable to or updates an input/output variable on the PROFINET device, e.g., NOVA\'s PROFINET service. The inputs/outputs map variables to specific memory addresses in the process image. The default process image has buffer lengths of 64 bytes for input and output. - The size of the buffer is determined by the `config_file_content` that is passed in [addBusIOService](addBusIOService) and has to be in accordance with the GSDML file describing the PROFINET device. The PROFINET controller as well as NOVA\'s PROFINET service use an input/output variable configuration to interpret the bits of the input/output process image. - The NOVA\'s PROFINET service\'s configuration can be viewed via [listProfinetIOs](listProfinetIOs). For the PROFINET controller, e.g., a connected PLC, refer to the corresponding third party software, e.g., TIA portal).
6117
6117
  * @summary Add PROFINET Input/Output
6118
6118
  * @param {string} cell Unique identifier addressing a cell in all API calls.
6119
6119
  * @param {string} io Unique identifier to address an Input/Output in the cell.
@@ -6132,7 +6132,7 @@ declare const BUSInputsOutputsApiFp: (configuration?: Configuration) => {
6132
6132
  */
6133
6133
  clearBusIOService(cell: string, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
6134
6134
  /**
6135
- * Removes an input/output variable configuration from the PROFINET device, e.g. NOVA\'s PROFINET service.
6135
+ * Removes an input/output variable configuration from the PROFINET device, e.g., NOVA\'s PROFINET service.
6136
6136
  * @summary Remove PROFINET Input/Ouptut
6137
6137
  * @param {string} cell Unique identifier addressing a cell in all API calls.
6138
6138
  * @param {string} io Unique identifier to address an Input/Output in the cell.
@@ -6174,7 +6174,7 @@ declare const BUSInputsOutputsApiFp: (configuration?: Configuration) => {
6174
6174
  */
6175
6175
  getProfinetDescription(cell: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ProfinetDescription>>;
6176
6176
  /**
6177
- * Get input/output variable configuration of the PROFINET device, e.g. NOVA\'s PROFINET service as file. You can specify byte offsets for the input and output variable addresses to get an XML tagmap that is ready to paste to the third party software, e.g. TIA portal.
6177
+ * Get input/output variable configuration of the PROFINET device, e.g., NOVA\'s PROFINET service as file. You can specify byte offsets for the input and output variable addresses to get an XML tagmap that is ready to paste to the third party software, e.g., TIA portal.
6178
6178
  * @summary PROFINET Inputs/Outputs to File
6179
6179
  * @param {string} cell Unique identifier addressing a cell in all API calls.
6180
6180
  * @param {number} [inputOffset]
@@ -6184,7 +6184,7 @@ declare const BUSInputsOutputsApiFp: (configuration?: Configuration) => {
6184
6184
  */
6185
6185
  getProfinetIOsFromFile(cell: string, inputOffset?: number, outputOffset?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<string>>;
6186
6186
  /**
6187
- * List all input/output descriptions for configured BUS services. The input/output descriptions contain information such as the name, the type and the unit. The input/output direction is given in perspective of the BUS service.
6187
+ * List all input/output descriptions for configured BUS services. The input/output descriptions contain information like name, type and unit. The input/output direction is given in perspective of the BUS service.
6188
6188
  * @summary List Descriptions
6189
6189
  * @param {string} cell Unique identifier addressing a cell in all API calls.
6190
6190
  * @param {*} [options] Override http request option.
@@ -6192,7 +6192,7 @@ declare const BUSInputsOutputsApiFp: (configuration?: Configuration) => {
6192
6192
  */
6193
6193
  listBusIODescriptions(cell: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<IODescription2>>>;
6194
6194
  /**
6195
- * List descriptions for all configured input/output variables of the PROFINET service. The input/output descriptions contain information such as the name, the type and the unit. The input/output direction is given in perspective of the PROFINET Device, e.g. the configured PROFINET service. The byte and bit addresses are the locations in the PROFINET input/output process image the variable points to. The PROFINET controller as well as NOVA\'s PROFINET service use an input/output variable configuration to interpret the bits of the input and output process image. The NOVA PROFINET service\'s configuration is modified via [addProfinetIO](addProfinetIO) and [setProfinetIOsFromFile](setProfinetIOsFromFile). For the PROFINET controller, e.g. a connected PLC, refer to the corresponding third party software, e.g. TIA portal.
6195
+ * List descriptions for all configured input/output variables of the PROFINET service. The input/output descriptions contain information like name, type and unit. The input/output direction is given in perspective of the PROFINET Device, e.g., the configured PROFINET service. - The byte and bit addresses are the locations in the PROFINET input/output process image the variable points to. - The PROFINET controller as well as NOVA\'s PROFINET service use an input/output variable configuration to interpret the bits of the input and output process image. - The NOVA PROFINET service\'s configuration is modified via [addProfinetIO](addProfinetIO) and [setProfinetIOsFromFile](setProfinetIOsFromFile). For the PROFINET controller, e.g., a connected PLC, refer to the corresponding third party software, e.g., TIA portal.
6196
6196
  * @summary List PROFINET Input/Output Configuration
6197
6197
  * @param {string} cell Unique identifier addressing a cell in all API calls.
6198
6198
  * @param {*} [options] Override http request option.
@@ -6209,7 +6209,7 @@ declare const BUSInputsOutputsApiFp: (configuration?: Configuration) => {
6209
6209
  */
6210
6210
  setBusIOValues(cell: string, iOValue: Array<IOValue>, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
6211
6211
  /**
6212
- * Sets input/output variable configuration on the PROFINET device (i.e. NOVA\'s PROFINET service) from XML file. The inputs/outputs map variables to specific memory addresses in the process image. The default process image has buffer lengths of 64 bytes for input and output. The size of the buffer is determined by the `config_file_content` that is passed in [addBusIOService](addBusIOService) and has to be in accordance with the GSDML file describing the PROFINET device. The PROFINET controller as well as NOVA\'s PROFINET service use an input/output variable configuration to interpret the bits of the input/output process image. The NOVA\'s PROFINET service\'s configuration can be viewed via [listProfinetIOs](listProfinetIOs). For the PROFINET controller, e.g. a connected PLC, refer to the corresponding engineering system, e.g. TIA portal. You can export the variable configuration of the PROFINET controller as XML file from your engineering system, e.g. TIA portal. The endpoint is built so that the perspective of input and output (PROFINET Device\'s input is PROFINET Controller\'s output) is internally handled (PROFINET device input is PROFINET controller output), meaning that you can paste the exported XML file here without modifying.
6212
+ * Sets input/output variable configuration on the PROFINET device (i.e. NOVA\'s PROFINET service) from XML file. The inputs/outputs map variables to specific memory addresses in the process image. The default process image has buffer lengths of 64 bytes for input and output. - The size of the buffer is determined by the `config_file_content` that is passed in [addBusIOService](addBusIOService) and has to be in accordance with the GSDML file describing the PROFINET device. The PROFINET controller as well as NOVA\'s PROFINET service use an input/output variable configuration to interpret the bits of the input/output process image. - The NOVA\'s PROFINET service\'s configuration can be viewed via [listProfinetIOs](listProfinetIOs). For the PROFINET controller, e.g., a connected PLC, refer to the corresponding engineering system, e.g., TIA portal. #### Export variables You can export the variable configuration of the PROFINET controller as XML file from your engineering system, e.g., TIA portal. - The endpoint is built so that the perspective of input and output (PROFINET Device\'s input is PROFINET Controller\'s output) is internally handled (PROFINET device input is PROFINET controller output), meaning that you can paste the exported XML file here without modifying.
6213
6213
  * @summary Set PROFINET Inputs/Outputs from File
6214
6214
  * @param {string} cell Unique identifier addressing a cell in all API calls.
6215
6215
  * @param {ProfinetInputOutputConfig} profinetInputOutputConfig
@@ -6234,7 +6234,7 @@ declare const BUSInputsOutputsApiFactory: (configuration?: Configuration, basePa
6234
6234
  */
6235
6235
  addBusIOService(cell: string, busIOType: BusIOType, completionTimeout?: number, options?: RawAxiosRequestConfig): AxiosPromise<void>;
6236
6236
  /**
6237
- * Adds an input/output variable to or updates an input/output variable on the PROFINET device, e.g. NOVA\'s PROFINET service. The inputs/outputs map variables to specific memory addresses in the process image. The default process image has buffer lengths of 64 bytes for input and output. The size of the buffer is determined by the `config_file_content` that is passed in [addBusIOService](addBusIOService) and has to be in accordance with the GSDML file describing the PROFINET device. The PROFINET controller as well as NOVA\'s PROFINET service use an input/output variable configuration to interpret the bits of the input/output process image. The NOVA\'s PROFINET service\'s configuration can be viewed via [listProfinetIOs](listProfinetIOs). For the PROFINET controller, e.g. a connected PLC, refer to the corresponding third party software, e.g. TIA portal).
6237
+ * Adds an input/output variable to or updates an input/output variable on the PROFINET device, e.g., NOVA\'s PROFINET service. The inputs/outputs map variables to specific memory addresses in the process image. The default process image has buffer lengths of 64 bytes for input and output. - The size of the buffer is determined by the `config_file_content` that is passed in [addBusIOService](addBusIOService) and has to be in accordance with the GSDML file describing the PROFINET device. The PROFINET controller as well as NOVA\'s PROFINET service use an input/output variable configuration to interpret the bits of the input/output process image. - The NOVA\'s PROFINET service\'s configuration can be viewed via [listProfinetIOs](listProfinetIOs). For the PROFINET controller, e.g., a connected PLC, refer to the corresponding third party software, e.g., TIA portal).
6238
6238
  * @summary Add PROFINET Input/Output
6239
6239
  * @param {string} cell Unique identifier addressing a cell in all API calls.
6240
6240
  * @param {string} io Unique identifier to address an Input/Output in the cell.
@@ -6253,7 +6253,7 @@ declare const BUSInputsOutputsApiFactory: (configuration?: Configuration, basePa
6253
6253
  */
6254
6254
  clearBusIOService(cell: string, completionTimeout?: number, options?: RawAxiosRequestConfig): AxiosPromise<void>;
6255
6255
  /**
6256
- * Removes an input/output variable configuration from the PROFINET device, e.g. NOVA\'s PROFINET service.
6256
+ * Removes an input/output variable configuration from the PROFINET device, e.g., NOVA\'s PROFINET service.
6257
6257
  * @summary Remove PROFINET Input/Ouptut
6258
6258
  * @param {string} cell Unique identifier addressing a cell in all API calls.
6259
6259
  * @param {string} io Unique identifier to address an Input/Output in the cell.
@@ -6295,7 +6295,7 @@ declare const BUSInputsOutputsApiFactory: (configuration?: Configuration, basePa
6295
6295
  */
6296
6296
  getProfinetDescription(cell: string, options?: RawAxiosRequestConfig): AxiosPromise<ProfinetDescription>;
6297
6297
  /**
6298
- * Get input/output variable configuration of the PROFINET device, e.g. NOVA\'s PROFINET service as file. You can specify byte offsets for the input and output variable addresses to get an XML tagmap that is ready to paste to the third party software, e.g. TIA portal.
6298
+ * Get input/output variable configuration of the PROFINET device, e.g., NOVA\'s PROFINET service as file. You can specify byte offsets for the input and output variable addresses to get an XML tagmap that is ready to paste to the third party software, e.g., TIA portal.
6299
6299
  * @summary PROFINET Inputs/Outputs to File
6300
6300
  * @param {string} cell Unique identifier addressing a cell in all API calls.
6301
6301
  * @param {number} [inputOffset]
@@ -6305,7 +6305,7 @@ declare const BUSInputsOutputsApiFactory: (configuration?: Configuration, basePa
6305
6305
  */
6306
6306
  getProfinetIOsFromFile(cell: string, inputOffset?: number, outputOffset?: number, options?: RawAxiosRequestConfig): AxiosPromise<string>;
6307
6307
  /**
6308
- * List all input/output descriptions for configured BUS services. The input/output descriptions contain information such as the name, the type and the unit. The input/output direction is given in perspective of the BUS service.
6308
+ * List all input/output descriptions for configured BUS services. The input/output descriptions contain information like name, type and unit. The input/output direction is given in perspective of the BUS service.
6309
6309
  * @summary List Descriptions
6310
6310
  * @param {string} cell Unique identifier addressing a cell in all API calls.
6311
6311
  * @param {*} [options] Override http request option.
@@ -6313,7 +6313,7 @@ declare const BUSInputsOutputsApiFactory: (configuration?: Configuration, basePa
6313
6313
  */
6314
6314
  listBusIODescriptions(cell: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<IODescription2>>;
6315
6315
  /**
6316
- * List descriptions for all configured input/output variables of the PROFINET service. The input/output descriptions contain information such as the name, the type and the unit. The input/output direction is given in perspective of the PROFINET Device, e.g. the configured PROFINET service. The byte and bit addresses are the locations in the PROFINET input/output process image the variable points to. The PROFINET controller as well as NOVA\'s PROFINET service use an input/output variable configuration to interpret the bits of the input and output process image. The NOVA PROFINET service\'s configuration is modified via [addProfinetIO](addProfinetIO) and [setProfinetIOsFromFile](setProfinetIOsFromFile). For the PROFINET controller, e.g. a connected PLC, refer to the corresponding third party software, e.g. TIA portal.
6316
+ * List descriptions for all configured input/output variables of the PROFINET service. The input/output descriptions contain information like name, type and unit. The input/output direction is given in perspective of the PROFINET Device, e.g., the configured PROFINET service. - The byte and bit addresses are the locations in the PROFINET input/output process image the variable points to. - The PROFINET controller as well as NOVA\'s PROFINET service use an input/output variable configuration to interpret the bits of the input and output process image. - The NOVA PROFINET service\'s configuration is modified via [addProfinetIO](addProfinetIO) and [setProfinetIOsFromFile](setProfinetIOsFromFile). For the PROFINET controller, e.g., a connected PLC, refer to the corresponding third party software, e.g., TIA portal.
6317
6317
  * @summary List PROFINET Input/Output Configuration
6318
6318
  * @param {string} cell Unique identifier addressing a cell in all API calls.
6319
6319
  * @param {*} [options] Override http request option.
@@ -6330,7 +6330,7 @@ declare const BUSInputsOutputsApiFactory: (configuration?: Configuration, basePa
6330
6330
  */
6331
6331
  setBusIOValues(cell: string, iOValue: Array<IOValue>, options?: RawAxiosRequestConfig): AxiosPromise<void>;
6332
6332
  /**
6333
- * Sets input/output variable configuration on the PROFINET device (i.e. NOVA\'s PROFINET service) from XML file. The inputs/outputs map variables to specific memory addresses in the process image. The default process image has buffer lengths of 64 bytes for input and output. The size of the buffer is determined by the `config_file_content` that is passed in [addBusIOService](addBusIOService) and has to be in accordance with the GSDML file describing the PROFINET device. The PROFINET controller as well as NOVA\'s PROFINET service use an input/output variable configuration to interpret the bits of the input/output process image. The NOVA\'s PROFINET service\'s configuration can be viewed via [listProfinetIOs](listProfinetIOs). For the PROFINET controller, e.g. a connected PLC, refer to the corresponding engineering system, e.g. TIA portal. You can export the variable configuration of the PROFINET controller as XML file from your engineering system, e.g. TIA portal. The endpoint is built so that the perspective of input and output (PROFINET Device\'s input is PROFINET Controller\'s output) is internally handled (PROFINET device input is PROFINET controller output), meaning that you can paste the exported XML file here without modifying.
6333
+ * Sets input/output variable configuration on the PROFINET device (i.e. NOVA\'s PROFINET service) from XML file. The inputs/outputs map variables to specific memory addresses in the process image. The default process image has buffer lengths of 64 bytes for input and output. - The size of the buffer is determined by the `config_file_content` that is passed in [addBusIOService](addBusIOService) and has to be in accordance with the GSDML file describing the PROFINET device. The PROFINET controller as well as NOVA\'s PROFINET service use an input/output variable configuration to interpret the bits of the input/output process image. - The NOVA\'s PROFINET service\'s configuration can be viewed via [listProfinetIOs](listProfinetIOs). For the PROFINET controller, e.g., a connected PLC, refer to the corresponding engineering system, e.g., TIA portal. #### Export variables You can export the variable configuration of the PROFINET controller as XML file from your engineering system, e.g., TIA portal. - The endpoint is built so that the perspective of input and output (PROFINET Device\'s input is PROFINET Controller\'s output) is internally handled (PROFINET device input is PROFINET controller output), meaning that you can paste the exported XML file here without modifying.
6334
6334
  * @summary Set PROFINET Inputs/Outputs from File
6335
6335
  * @param {string} cell Unique identifier addressing a cell in all API calls.
6336
6336
  * @param {ProfinetInputOutputConfig} profinetInputOutputConfig
@@ -6358,7 +6358,7 @@ declare class BUSInputsOutputsApi extends BaseAPI {
6358
6358
  */
6359
6359
  addBusIOService(cell: string, busIOType: BusIOType, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
6360
6360
  /**
6361
- * Adds an input/output variable to or updates an input/output variable on the PROFINET device, e.g. NOVA\'s PROFINET service. The inputs/outputs map variables to specific memory addresses in the process image. The default process image has buffer lengths of 64 bytes for input and output. The size of the buffer is determined by the `config_file_content` that is passed in [addBusIOService](addBusIOService) and has to be in accordance with the GSDML file describing the PROFINET device. The PROFINET controller as well as NOVA\'s PROFINET service use an input/output variable configuration to interpret the bits of the input/output process image. The NOVA\'s PROFINET service\'s configuration can be viewed via [listProfinetIOs](listProfinetIOs). For the PROFINET controller, e.g. a connected PLC, refer to the corresponding third party software, e.g. TIA portal).
6361
+ * Adds an input/output variable to or updates an input/output variable on the PROFINET device, e.g., NOVA\'s PROFINET service. The inputs/outputs map variables to specific memory addresses in the process image. The default process image has buffer lengths of 64 bytes for input and output. - The size of the buffer is determined by the `config_file_content` that is passed in [addBusIOService](addBusIOService) and has to be in accordance with the GSDML file describing the PROFINET device. The PROFINET controller as well as NOVA\'s PROFINET service use an input/output variable configuration to interpret the bits of the input/output process image. - The NOVA\'s PROFINET service\'s configuration can be viewed via [listProfinetIOs](listProfinetIOs). For the PROFINET controller, e.g., a connected PLC, refer to the corresponding third party software, e.g., TIA portal).
6362
6362
  * @summary Add PROFINET Input/Output
6363
6363
  * @param {string} cell Unique identifier addressing a cell in all API calls.
6364
6364
  * @param {string} io Unique identifier to address an Input/Output in the cell.
@@ -6379,7 +6379,7 @@ declare class BUSInputsOutputsApi extends BaseAPI {
6379
6379
  */
6380
6380
  clearBusIOService(cell: string, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
6381
6381
  /**
6382
- * Removes an input/output variable configuration from the PROFINET device, e.g. NOVA\'s PROFINET service.
6382
+ * Removes an input/output variable configuration from the PROFINET device, e.g., NOVA\'s PROFINET service.
6383
6383
  * @summary Remove PROFINET Input/Ouptut
6384
6384
  * @param {string} cell Unique identifier addressing a cell in all API calls.
6385
6385
  * @param {string} io Unique identifier to address an Input/Output in the cell.
@@ -6426,7 +6426,7 @@ declare class BUSInputsOutputsApi extends BaseAPI {
6426
6426
  */
6427
6427
  getProfinetDescription(cell: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<ProfinetDescription, any>>;
6428
6428
  /**
6429
- * Get input/output variable configuration of the PROFINET device, e.g. NOVA\'s PROFINET service as file. You can specify byte offsets for the input and output variable addresses to get an XML tagmap that is ready to paste to the third party software, e.g. TIA portal.
6429
+ * Get input/output variable configuration of the PROFINET device, e.g., NOVA\'s PROFINET service as file. You can specify byte offsets for the input and output variable addresses to get an XML tagmap that is ready to paste to the third party software, e.g., TIA portal.
6430
6430
  * @summary PROFINET Inputs/Outputs to File
6431
6431
  * @param {string} cell Unique identifier addressing a cell in all API calls.
6432
6432
  * @param {number} [inputOffset]
@@ -6437,7 +6437,7 @@ declare class BUSInputsOutputsApi extends BaseAPI {
6437
6437
  */
6438
6438
  getProfinetIOsFromFile(cell: string, inputOffset?: number, outputOffset?: number, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<string, any>>;
6439
6439
  /**
6440
- * List all input/output descriptions for configured BUS services. The input/output descriptions contain information such as the name, the type and the unit. The input/output direction is given in perspective of the BUS service.
6440
+ * List all input/output descriptions for configured BUS services. The input/output descriptions contain information like name, type and unit. The input/output direction is given in perspective of the BUS service.
6441
6441
  * @summary List Descriptions
6442
6442
  * @param {string} cell Unique identifier addressing a cell in all API calls.
6443
6443
  * @param {*} [options] Override http request option.
@@ -6446,7 +6446,7 @@ declare class BUSInputsOutputsApi extends BaseAPI {
6446
6446
  */
6447
6447
  listBusIODescriptions(cell: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<IODescription2[], any>>;
6448
6448
  /**
6449
- * List descriptions for all configured input/output variables of the PROFINET service. The input/output descriptions contain information such as the name, the type and the unit. The input/output direction is given in perspective of the PROFINET Device, e.g. the configured PROFINET service. The byte and bit addresses are the locations in the PROFINET input/output process image the variable points to. The PROFINET controller as well as NOVA\'s PROFINET service use an input/output variable configuration to interpret the bits of the input and output process image. The NOVA PROFINET service\'s configuration is modified via [addProfinetIO](addProfinetIO) and [setProfinetIOsFromFile](setProfinetIOsFromFile). For the PROFINET controller, e.g. a connected PLC, refer to the corresponding third party software, e.g. TIA portal.
6449
+ * List descriptions for all configured input/output variables of the PROFINET service. The input/output descriptions contain information like name, type and unit. The input/output direction is given in perspective of the PROFINET Device, e.g., the configured PROFINET service. - The byte and bit addresses are the locations in the PROFINET input/output process image the variable points to. - The PROFINET controller as well as NOVA\'s PROFINET service use an input/output variable configuration to interpret the bits of the input and output process image. - The NOVA PROFINET service\'s configuration is modified via [addProfinetIO](addProfinetIO) and [setProfinetIOsFromFile](setProfinetIOsFromFile). For the PROFINET controller, e.g., a connected PLC, refer to the corresponding third party software, e.g., TIA portal.
6450
6450
  * @summary List PROFINET Input/Output Configuration
6451
6451
  * @param {string} cell Unique identifier addressing a cell in all API calls.
6452
6452
  * @param {*} [options] Override http request option.
@@ -6465,7 +6465,7 @@ declare class BUSInputsOutputsApi extends BaseAPI {
6465
6465
  */
6466
6466
  setBusIOValues(cell: string, iOValue: Array<IOValue>, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
6467
6467
  /**
6468
- * Sets input/output variable configuration on the PROFINET device (i.e. NOVA\'s PROFINET service) from XML file. The inputs/outputs map variables to specific memory addresses in the process image. The default process image has buffer lengths of 64 bytes for input and output. The size of the buffer is determined by the `config_file_content` that is passed in [addBusIOService](addBusIOService) and has to be in accordance with the GSDML file describing the PROFINET device. The PROFINET controller as well as NOVA\'s PROFINET service use an input/output variable configuration to interpret the bits of the input/output process image. The NOVA\'s PROFINET service\'s configuration can be viewed via [listProfinetIOs](listProfinetIOs). For the PROFINET controller, e.g. a connected PLC, refer to the corresponding engineering system, e.g. TIA portal. You can export the variable configuration of the PROFINET controller as XML file from your engineering system, e.g. TIA portal. The endpoint is built so that the perspective of input and output (PROFINET Device\'s input is PROFINET Controller\'s output) is internally handled (PROFINET device input is PROFINET controller output), meaning that you can paste the exported XML file here without modifying.
6468
+ * Sets input/output variable configuration on the PROFINET device (i.e. NOVA\'s PROFINET service) from XML file. The inputs/outputs map variables to specific memory addresses in the process image. The default process image has buffer lengths of 64 bytes for input and output. - The size of the buffer is determined by the `config_file_content` that is passed in [addBusIOService](addBusIOService) and has to be in accordance with the GSDML file describing the PROFINET device. The PROFINET controller as well as NOVA\'s PROFINET service use an input/output variable configuration to interpret the bits of the input/output process image. - The NOVA\'s PROFINET service\'s configuration can be viewed via [listProfinetIOs](listProfinetIOs). For the PROFINET controller, e.g., a connected PLC, refer to the corresponding engineering system, e.g., TIA portal. #### Export variables You can export the variable configuration of the PROFINET controller as XML file from your engineering system, e.g., TIA portal. - The endpoint is built so that the perspective of input and output (PROFINET Device\'s input is PROFINET Controller\'s output) is internally handled (PROFINET device input is PROFINET controller output), meaning that you can paste the exported XML file here without modifying.
6469
6469
  * @summary Set PROFINET Inputs/Outputs from File
6470
6470
  * @param {string} cell Unique identifier addressing a cell in all API calls.
6471
6471
  * @param {ProfinetInputOutputConfig} profinetInputOutputConfig
@@ -6490,7 +6490,7 @@ declare const CellApiAxiosParamCreator: (configuration?: Configuration) => {
6490
6490
  */
6491
6491
  deleteCell: (cell: string, completionTimeout?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
6492
6492
  /**
6493
- * 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.
6493
+ * 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](https://docs.wandelbots.io/latest/setup-cell) for more information.
6494
6494
  * @summary Add Cell
6495
6495
  * @param {Cell} cell
6496
6496
  * @param {number} [completionTimeout]
@@ -6499,7 +6499,7 @@ declare const CellApiAxiosParamCreator: (configuration?: Configuration) => {
6499
6499
  */
6500
6500
  deployCell: (cell: Cell, completionTimeout?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
6501
6501
  /**
6502
- * 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.
6502
+ * List all cell resources.
6503
6503
  * @summary Configuration
6504
6504
  * @param {string} cell Unique identifier addressing a cell in all API calls.
6505
6505
  * @param {*} [options] Override http request option.
@@ -6556,7 +6556,7 @@ declare const CellApiFp: (configuration?: Configuration) => {
6556
6556
  */
6557
6557
  deleteCell(cell: string, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
6558
6558
  /**
6559
- * 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.
6559
+ * 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](https://docs.wandelbots.io/latest/setup-cell) for more information.
6560
6560
  * @summary Add Cell
6561
6561
  * @param {Cell} cell
6562
6562
  * @param {number} [completionTimeout]
@@ -6565,7 +6565,7 @@ declare const CellApiFp: (configuration?: Configuration) => {
6565
6565
  */
6566
6566
  deployCell(cell: Cell, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
6567
6567
  /**
6568
- * 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.
6568
+ * List all cell resources.
6569
6569
  * @summary Configuration
6570
6570
  * @param {string} cell Unique identifier addressing a cell in all API calls.
6571
6571
  * @param {*} [options] Override http request option.
@@ -6622,7 +6622,7 @@ declare const CellApiFactory: (configuration?: Configuration, basePath?: string,
6622
6622
  */
6623
6623
  deleteCell(cell: string, completionTimeout?: number, options?: RawAxiosRequestConfig): AxiosPromise<void>;
6624
6624
  /**
6625
- * 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.
6625
+ * 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](https://docs.wandelbots.io/latest/setup-cell) for more information.
6626
6626
  * @summary Add Cell
6627
6627
  * @param {Cell} cell
6628
6628
  * @param {number} [completionTimeout]
@@ -6631,7 +6631,7 @@ declare const CellApiFactory: (configuration?: Configuration, basePath?: string,
6631
6631
  */
6632
6632
  deployCell(cell: Cell, completionTimeout?: number, options?: RawAxiosRequestConfig): AxiosPromise<void>;
6633
6633
  /**
6634
- * 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.
6634
+ * List all cell resources.
6635
6635
  * @summary Configuration
6636
6636
  * @param {string} cell Unique identifier addressing a cell in all API calls.
6637
6637
  * @param {*} [options] Override http request option.
@@ -6691,7 +6691,7 @@ declare class CellApi extends BaseAPI {
6691
6691
  */
6692
6692
  deleteCell(cell: string, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
6693
6693
  /**
6694
- * 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.
6694
+ * 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](https://docs.wandelbots.io/latest/setup-cell) for more information.
6695
6695
  * @summary Add Cell
6696
6696
  * @param {Cell} cell
6697
6697
  * @param {number} [completionTimeout]
@@ -6701,7 +6701,7 @@ declare class CellApi extends BaseAPI {
6701
6701
  */
6702
6702
  deployCell(cell: Cell, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
6703
6703
  /**
6704
- * 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.
6704
+ * List all cell resources.
6705
6705
  * @summary Configuration
6706
6706
  * @param {string} cell Unique identifier addressing a cell in all API calls.
6707
6707
  * @param {*} [options] Override http request option.
@@ -6754,7 +6754,7 @@ declare class CellApi extends BaseAPI {
6754
6754
  */
6755
6755
  declare const ControllerApiAxiosParamCreator: (configuration?: Configuration) => {
6756
6756
  /**
6757
- * Add a robot controller to the cell. <!-- theme: warning --> > **WARNING** > > Using it in conjunction with the settings app may lead to unpredictable behavior.
6757
+ * Add a robot controller to the cell.
6758
6758
  * @summary Add Robot Controller
6759
6759
  * @param {string} cell Unique identifier addressing a cell in all API calls.
6760
6760
  * @param {RobotController} robotController
@@ -6764,7 +6764,7 @@ declare const ControllerApiAxiosParamCreator: (configuration?: Configuration) =>
6764
6764
  */
6765
6765
  addRobotController: (cell: string, robotController: RobotController, completionTimeout?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
6766
6766
  /**
6767
- * 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.
6767
+ * Delete all robot controllers from the cell. To replace all robot controllers in a cell, use this endpoint in combination with [addRobotController](addRobotController).
6768
6768
  * @summary Clear Robot Controllers
6769
6769
  * @param {string} cell Unique identifier addressing a cell in all API calls.
6770
6770
  * @param {number} [completionTimeout]
@@ -6773,7 +6773,7 @@ declare const ControllerApiAxiosParamCreator: (configuration?: Configuration) =>
6773
6773
  */
6774
6774
  clearRobotControllers: (cell: string, completionTimeout?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
6775
6775
  /**
6776
- * Delete a robot controller from the cell. <!-- theme: warning --> > **WARNING** > > Using it in conjunction with the settings app may lead to unpredictable behavior.
6776
+ * Delete a robot controller from the cell.
6777
6777
  * @summary Delete Robot Controller
6778
6778
  * @param {string} cell Unique identifier addressing a cell in all API calls.
6779
6779
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -6792,7 +6792,7 @@ declare const ControllerApiAxiosParamCreator: (configuration?: Configuration) =>
6792
6792
  */
6793
6793
  getControllerDescription: (cell: string, controller: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
6794
6794
  /**
6795
- * Request a coordinate system specification for a given identifier. Use parameter orientation_type to get the orientation part of the transformation offset of the coordinate system returned in the requested orientation notation. If parameter orientation_type is not set, the orientation part of the transformation offset of the coordinate system is returned in rotation vector notation. 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.
6795
+ * Request a coordinate system specification for a given identifier. Use parameter `orientation_type` to get the orientation part of the transformation offset of the coordinate system returned in the requested orientation notation. If parameter `orientation_type` is not set, the orientation part of the transformation offset of the coordinate system is returned in rotation vector notation. 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.
6796
6796
  * @summary Coordinate System
6797
6797
  * @param {string} cell Unique identifier addressing a cell in all API calls.
6798
6798
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -6821,7 +6821,7 @@ declare const ControllerApiAxiosParamCreator: (configuration?: Configuration) =>
6821
6821
  */
6822
6822
  getRobotController: (cell: string, controller: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
6823
6823
  /**
6824
- * 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.
6824
+ * 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.
6825
6825
  * @summary Virtual Controller Configuration
6826
6826
  * @param {string} cell Unique identifier addressing a cell in all API calls.
6827
6827
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -6830,7 +6830,7 @@ declare const ControllerApiAxiosParamCreator: (configuration?: Configuration) =>
6830
6830
  */
6831
6831
  getVirtualControllerConfiguration: (cell: string, controller: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
6832
6832
  /**
6833
- * Lists all specifications of coordinate systems from robot controllers. Use parameter orientation_type to get the orientation part of the transformation offset of the coordinate system returned in the requested orientation notation. If parameter orientation_type is not set, the orientation part of the transformation offset of the coordinate system is returned in rotation vector notation. 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.
6833
+ * Lists all specifications of coordinate systems from robot controllers. Use parameter `orientation_type` to get the orientation part of the transformation offset of the coordinate system returned in the requested orientation notation. If parameter `orientation_type` is not set, the orientation part of the transformation offset of the coordinate system is returned in rotation vector notation. 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.
6834
6834
  * @summary List Coordinate Systems
6835
6835
  * @param {string} cell Unique identifier addressing a cell in all API calls.
6836
6836
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -6848,7 +6848,7 @@ declare const ControllerApiAxiosParamCreator: (configuration?: Configuration) =>
6848
6848
  */
6849
6849
  listRobotControllers: (cell: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
6850
6850
  /**
6851
- * 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** > > `setDefaultMode` enables the robot controller to stay in control mode to keep the motors activated. > This allows for faster execution of sequential movements as no mode switches are required. > **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.
6851
+ * 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** > > `setDefaultMode` enables the robot controller to stay in control mode to keep the motors activated. > This allows for faster execution of sequential movements as no mode switches are required. > **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.
6852
6852
  * @summary Set Default Mode
6853
6853
  * @param {string} cell Unique identifier addressing a cell in all API calls.
6854
6854
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -6858,7 +6858,7 @@ declare const ControllerApiAxiosParamCreator: (configuration?: Configuration) =>
6858
6858
  */
6859
6859
  setDefaultMode: (cell: string, controller: string, mode: SettableRobotSystemMode, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
6860
6860
  /**
6861
- * <!-- theme: danger --> > Websocket endpoint 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 (listController)[listController] endpoint to check if the robot controller supports free drive mode.
6861
+ * <!-- theme: success --> > Websocket endpoint 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, > - 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 cobots. Use [listRobotControllers](listRobotControllers) to check if the robot controller supports free drive mode.
6862
6862
  * @summary Stream Free Drive
6863
6863
  * @param {string} cell Unique identifier addressing a cell in all API calls.
6864
6864
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -6868,7 +6868,7 @@ declare const ControllerApiAxiosParamCreator: (configuration?: Configuration) =>
6868
6868
  */
6869
6869
  streamFreeDrive: (cell: string, controller: string, responseRate?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
6870
6870
  /**
6871
- * <!-- theme: danger --> > Websocket endpoint Receive updates of the state of a robot controller. The stream can be opened before the controller is registered. To register a controller, call [addRobotController](addRobotController). While connecting, the stream sends initialization updates. Once the controller reaches `MODE_MONITOR`, it sends controller state updates.
6871
+ * <!-- theme: success --> > Websocket endpoint Receive updates of the state of a robot controller. The stream can be opened before the controller is registered. To register a controller, call [addRobotController](addRobotController). While connecting, the stream sends initialization updates. Once the controller reaches `MODE_MONITOR`, it sends controller state updates.
6872
6872
  * @summary Stream State
6873
6873
  * @param {string} cell Unique identifier addressing a cell in all API calls.
6874
6874
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -6879,7 +6879,7 @@ declare const ControllerApiAxiosParamCreator: (configuration?: Configuration) =>
6879
6879
  */
6880
6880
  streamRobotControllerState: (cell: string, controller: string, responseRate?: number, addControllerTimeout?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
6881
6881
  /**
6882
- * 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.
6882
+ * Update the configuration of a robot controller. Reconfigure certain options of a robot controller, or deploy a specific container image of a robot controller.
6883
6883
  * @summary Update Robot Controller
6884
6884
  * @param {string} cell Unique identifier addressing a cell in all API calls.
6885
6885
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -6896,7 +6896,7 @@ declare const ControllerApiAxiosParamCreator: (configuration?: Configuration) =>
6896
6896
  */
6897
6897
  declare const ControllerApiFp: (configuration?: Configuration) => {
6898
6898
  /**
6899
- * Add a robot controller to the cell. <!-- theme: warning --> > **WARNING** > > Using it in conjunction with the settings app may lead to unpredictable behavior.
6899
+ * Add a robot controller to the cell.
6900
6900
  * @summary Add Robot Controller
6901
6901
  * @param {string} cell Unique identifier addressing a cell in all API calls.
6902
6902
  * @param {RobotController} robotController
@@ -6906,7 +6906,7 @@ declare const ControllerApiFp: (configuration?: Configuration) => {
6906
6906
  */
6907
6907
  addRobotController(cell: string, robotController: RobotController, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
6908
6908
  /**
6909
- * 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.
6909
+ * Delete all robot controllers from the cell. To replace all robot controllers in a cell, use this endpoint in combination with [addRobotController](addRobotController).
6910
6910
  * @summary Clear Robot Controllers
6911
6911
  * @param {string} cell Unique identifier addressing a cell in all API calls.
6912
6912
  * @param {number} [completionTimeout]
@@ -6915,7 +6915,7 @@ declare const ControllerApiFp: (configuration?: Configuration) => {
6915
6915
  */
6916
6916
  clearRobotControllers(cell: string, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
6917
6917
  /**
6918
- * Delete a robot controller from the cell. <!-- theme: warning --> > **WARNING** > > Using it in conjunction with the settings app may lead to unpredictable behavior.
6918
+ * Delete a robot controller from the cell.
6919
6919
  * @summary Delete Robot Controller
6920
6920
  * @param {string} cell Unique identifier addressing a cell in all API calls.
6921
6921
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -6934,7 +6934,7 @@ declare const ControllerApiFp: (configuration?: Configuration) => {
6934
6934
  */
6935
6935
  getControllerDescription(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ControllerDescription>>;
6936
6936
  /**
6937
- * Request a coordinate system specification for a given identifier. Use parameter orientation_type to get the orientation part of the transformation offset of the coordinate system returned in the requested orientation notation. If parameter orientation_type is not set, the orientation part of the transformation offset of the coordinate system is returned in rotation vector notation. 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.
6937
+ * Request a coordinate system specification for a given identifier. Use parameter `orientation_type` to get the orientation part of the transformation offset of the coordinate system returned in the requested orientation notation. If parameter `orientation_type` is not set, the orientation part of the transformation offset of the coordinate system is returned in rotation vector notation. 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.
6938
6938
  * @summary Coordinate System
6939
6939
  * @param {string} cell Unique identifier addressing a cell in all API calls.
6940
6940
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -6963,7 +6963,7 @@ declare const ControllerApiFp: (configuration?: Configuration) => {
6963
6963
  */
6964
6964
  getRobotController(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<RobotController>>;
6965
6965
  /**
6966
- * 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.
6966
+ * 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.
6967
6967
  * @summary Virtual Controller Configuration
6968
6968
  * @param {string} cell Unique identifier addressing a cell in all API calls.
6969
6969
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -6972,7 +6972,7 @@ declare const ControllerApiFp: (configuration?: Configuration) => {
6972
6972
  */
6973
6973
  getVirtualControllerConfiguration(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<VirtualRobotConfiguration>>;
6974
6974
  /**
6975
- * Lists all specifications of coordinate systems from robot controllers. Use parameter orientation_type to get the orientation part of the transformation offset of the coordinate system returned in the requested orientation notation. If parameter orientation_type is not set, the orientation part of the transformation offset of the coordinate system is returned in rotation vector notation. 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.
6975
+ * Lists all specifications of coordinate systems from robot controllers. Use parameter `orientation_type` to get the orientation part of the transformation offset of the coordinate system returned in the requested orientation notation. If parameter `orientation_type` is not set, the orientation part of the transformation offset of the coordinate system is returned in rotation vector notation. 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.
6976
6976
  * @summary List Coordinate Systems
6977
6977
  * @param {string} cell Unique identifier addressing a cell in all API calls.
6978
6978
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -6990,7 +6990,7 @@ declare const ControllerApiFp: (configuration?: Configuration) => {
6990
6990
  */
6991
6991
  listRobotControllers(cell: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<string>>>;
6992
6992
  /**
6993
- * 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** > > `setDefaultMode` enables the robot controller to stay in control mode to keep the motors activated. > This allows for faster execution of sequential movements as no mode switches are required. > **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.
6993
+ * 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** > > `setDefaultMode` enables the robot controller to stay in control mode to keep the motors activated. > This allows for faster execution of sequential movements as no mode switches are required. > **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.
6994
6994
  * @summary Set Default Mode
6995
6995
  * @param {string} cell Unique identifier addressing a cell in all API calls.
6996
6996
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -7000,7 +7000,7 @@ declare const ControllerApiFp: (configuration?: Configuration) => {
7000
7000
  */
7001
7001
  setDefaultMode(cell: string, controller: string, mode: SettableRobotSystemMode, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
7002
7002
  /**
7003
- * <!-- theme: danger --> > Websocket endpoint 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 (listController)[listController] endpoint to check if the robot controller supports free drive mode.
7003
+ * <!-- theme: success --> > Websocket endpoint 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, > - 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 cobots. Use [listRobotControllers](listRobotControllers) to check if the robot controller supports free drive mode.
7004
7004
  * @summary Stream Free Drive
7005
7005
  * @param {string} cell Unique identifier addressing a cell in all API calls.
7006
7006
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -7010,7 +7010,7 @@ declare const ControllerApiFp: (configuration?: Configuration) => {
7010
7010
  */
7011
7011
  streamFreeDrive(cell: string, controller: string, responseRate?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<RobotControllerState>>;
7012
7012
  /**
7013
- * <!-- theme: danger --> > Websocket endpoint Receive updates of the state of a robot controller. The stream can be opened before the controller is registered. To register a controller, call [addRobotController](addRobotController). While connecting, the stream sends initialization updates. Once the controller reaches `MODE_MONITOR`, it sends controller state updates.
7013
+ * <!-- theme: success --> > Websocket endpoint Receive updates of the state of a robot controller. The stream can be opened before the controller is registered. To register a controller, call [addRobotController](addRobotController). While connecting, the stream sends initialization updates. Once the controller reaches `MODE_MONITOR`, it sends controller state updates.
7014
7014
  * @summary Stream State
7015
7015
  * @param {string} cell Unique identifier addressing a cell in all API calls.
7016
7016
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -7021,7 +7021,7 @@ declare const ControllerApiFp: (configuration?: Configuration) => {
7021
7021
  */
7022
7022
  streamRobotControllerState(cell: string, controller: string, responseRate?: number, addControllerTimeout?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<RobotControllerState>>;
7023
7023
  /**
7024
- * 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.
7024
+ * Update the configuration of a robot controller. Reconfigure certain options of a robot controller, or deploy a specific container image of a robot controller.
7025
7025
  * @summary Update Robot Controller
7026
7026
  * @param {string} cell Unique identifier addressing a cell in all API calls.
7027
7027
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -7038,7 +7038,7 @@ declare const ControllerApiFp: (configuration?: Configuration) => {
7038
7038
  */
7039
7039
  declare const ControllerApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
7040
7040
  /**
7041
- * Add a robot controller to the cell. <!-- theme: warning --> > **WARNING** > > Using it in conjunction with the settings app may lead to unpredictable behavior.
7041
+ * Add a robot controller to the cell.
7042
7042
  * @summary Add Robot Controller
7043
7043
  * @param {string} cell Unique identifier addressing a cell in all API calls.
7044
7044
  * @param {RobotController} robotController
@@ -7048,7 +7048,7 @@ declare const ControllerApiFactory: (configuration?: Configuration, basePath?: s
7048
7048
  */
7049
7049
  addRobotController(cell: string, robotController: RobotController, completionTimeout?: number, options?: RawAxiosRequestConfig): AxiosPromise<void>;
7050
7050
  /**
7051
- * 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.
7051
+ * Delete all robot controllers from the cell. To replace all robot controllers in a cell, use this endpoint in combination with [addRobotController](addRobotController).
7052
7052
  * @summary Clear Robot Controllers
7053
7053
  * @param {string} cell Unique identifier addressing a cell in all API calls.
7054
7054
  * @param {number} [completionTimeout]
@@ -7057,7 +7057,7 @@ declare const ControllerApiFactory: (configuration?: Configuration, basePath?: s
7057
7057
  */
7058
7058
  clearRobotControllers(cell: string, completionTimeout?: number, options?: RawAxiosRequestConfig): AxiosPromise<void>;
7059
7059
  /**
7060
- * Delete a robot controller from the cell. <!-- theme: warning --> > **WARNING** > > Using it in conjunction with the settings app may lead to unpredictable behavior.
7060
+ * Delete a robot controller from the cell.
7061
7061
  * @summary Delete Robot Controller
7062
7062
  * @param {string} cell Unique identifier addressing a cell in all API calls.
7063
7063
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -7076,7 +7076,7 @@ declare const ControllerApiFactory: (configuration?: Configuration, basePath?: s
7076
7076
  */
7077
7077
  getControllerDescription(cell: string, controller: string, options?: RawAxiosRequestConfig): AxiosPromise<ControllerDescription>;
7078
7078
  /**
7079
- * Request a coordinate system specification for a given identifier. Use parameter orientation_type to get the orientation part of the transformation offset of the coordinate system returned in the requested orientation notation. If parameter orientation_type is not set, the orientation part of the transformation offset of the coordinate system is returned in rotation vector notation. 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.
7079
+ * Request a coordinate system specification for a given identifier. Use parameter `orientation_type` to get the orientation part of the transformation offset of the coordinate system returned in the requested orientation notation. If parameter `orientation_type` is not set, the orientation part of the transformation offset of the coordinate system is returned in rotation vector notation. 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.
7080
7080
  * @summary Coordinate System
7081
7081
  * @param {string} cell Unique identifier addressing a cell in all API calls.
7082
7082
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -7105,7 +7105,7 @@ declare const ControllerApiFactory: (configuration?: Configuration, basePath?: s
7105
7105
  */
7106
7106
  getRobotController(cell: string, controller: string, options?: RawAxiosRequestConfig): AxiosPromise<RobotController>;
7107
7107
  /**
7108
- * 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.
7108
+ * 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.
7109
7109
  * @summary Virtual Controller Configuration
7110
7110
  * @param {string} cell Unique identifier addressing a cell in all API calls.
7111
7111
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -7114,7 +7114,7 @@ declare const ControllerApiFactory: (configuration?: Configuration, basePath?: s
7114
7114
  */
7115
7115
  getVirtualControllerConfiguration(cell: string, controller: string, options?: RawAxiosRequestConfig): AxiosPromise<VirtualRobotConfiguration>;
7116
7116
  /**
7117
- * Lists all specifications of coordinate systems from robot controllers. Use parameter orientation_type to get the orientation part of the transformation offset of the coordinate system returned in the requested orientation notation. If parameter orientation_type is not set, the orientation part of the transformation offset of the coordinate system is returned in rotation vector notation. 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.
7117
+ * Lists all specifications of coordinate systems from robot controllers. Use parameter `orientation_type` to get the orientation part of the transformation offset of the coordinate system returned in the requested orientation notation. If parameter `orientation_type` is not set, the orientation part of the transformation offset of the coordinate system is returned in rotation vector notation. 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.
7118
7118
  * @summary List Coordinate Systems
7119
7119
  * @param {string} cell Unique identifier addressing a cell in all API calls.
7120
7120
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -7132,7 +7132,7 @@ declare const ControllerApiFactory: (configuration?: Configuration, basePath?: s
7132
7132
  */
7133
7133
  listRobotControllers(cell: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<string>>;
7134
7134
  /**
7135
- * 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** > > `setDefaultMode` enables the robot controller to stay in control mode to keep the motors activated. > This allows for faster execution of sequential movements as no mode switches are required. > **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.
7135
+ * 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** > > `setDefaultMode` enables the robot controller to stay in control mode to keep the motors activated. > This allows for faster execution of sequential movements as no mode switches are required. > **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.
7136
7136
  * @summary Set Default Mode
7137
7137
  * @param {string} cell Unique identifier addressing a cell in all API calls.
7138
7138
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -7142,7 +7142,7 @@ declare const ControllerApiFactory: (configuration?: Configuration, basePath?: s
7142
7142
  */
7143
7143
  setDefaultMode(cell: string, controller: string, mode: SettableRobotSystemMode, options?: RawAxiosRequestConfig): AxiosPromise<void>;
7144
7144
  /**
7145
- * <!-- theme: danger --> > Websocket endpoint 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 (listController)[listController] endpoint to check if the robot controller supports free drive mode.
7145
+ * <!-- theme: success --> > Websocket endpoint 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, > - 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 cobots. Use [listRobotControllers](listRobotControllers) to check if the robot controller supports free drive mode.
7146
7146
  * @summary Stream Free Drive
7147
7147
  * @param {string} cell Unique identifier addressing a cell in all API calls.
7148
7148
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -7152,7 +7152,7 @@ declare const ControllerApiFactory: (configuration?: Configuration, basePath?: s
7152
7152
  */
7153
7153
  streamFreeDrive(cell: string, controller: string, responseRate?: number, options?: RawAxiosRequestConfig): AxiosPromise<RobotControllerState>;
7154
7154
  /**
7155
- * <!-- theme: danger --> > Websocket endpoint Receive updates of the state of a robot controller. The stream can be opened before the controller is registered. To register a controller, call [addRobotController](addRobotController). While connecting, the stream sends initialization updates. Once the controller reaches `MODE_MONITOR`, it sends controller state updates.
7155
+ * <!-- theme: success --> > Websocket endpoint Receive updates of the state of a robot controller. The stream can be opened before the controller is registered. To register a controller, call [addRobotController](addRobotController). While connecting, the stream sends initialization updates. Once the controller reaches `MODE_MONITOR`, it sends controller state updates.
7156
7156
  * @summary Stream State
7157
7157
  * @param {string} cell Unique identifier addressing a cell in all API calls.
7158
7158
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -7163,7 +7163,7 @@ declare const ControllerApiFactory: (configuration?: Configuration, basePath?: s
7163
7163
  */
7164
7164
  streamRobotControllerState(cell: string, controller: string, responseRate?: number, addControllerTimeout?: number, options?: RawAxiosRequestConfig): AxiosPromise<RobotControllerState>;
7165
7165
  /**
7166
- * 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.
7166
+ * Update the configuration of a robot controller. Reconfigure certain options of a robot controller, or deploy a specific container image of a robot controller.
7167
7167
  * @summary Update Robot Controller
7168
7168
  * @param {string} cell Unique identifier addressing a cell in all API calls.
7169
7169
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -7182,7 +7182,7 @@ declare const ControllerApiFactory: (configuration?: Configuration, basePath?: s
7182
7182
  */
7183
7183
  declare class ControllerApi extends BaseAPI {
7184
7184
  /**
7185
- * Add a robot controller to the cell. <!-- theme: warning --> > **WARNING** > > Using it in conjunction with the settings app may lead to unpredictable behavior.
7185
+ * Add a robot controller to the cell.
7186
7186
  * @summary Add Robot Controller
7187
7187
  * @param {string} cell Unique identifier addressing a cell in all API calls.
7188
7188
  * @param {RobotController} robotController
@@ -7193,7 +7193,7 @@ declare class ControllerApi extends BaseAPI {
7193
7193
  */
7194
7194
  addRobotController(cell: string, robotController: RobotController, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
7195
7195
  /**
7196
- * 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.
7196
+ * Delete all robot controllers from the cell. To replace all robot controllers in a cell, use this endpoint in combination with [addRobotController](addRobotController).
7197
7197
  * @summary Clear Robot Controllers
7198
7198
  * @param {string} cell Unique identifier addressing a cell in all API calls.
7199
7199
  * @param {number} [completionTimeout]
@@ -7203,7 +7203,7 @@ declare class ControllerApi extends BaseAPI {
7203
7203
  */
7204
7204
  clearRobotControllers(cell: string, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
7205
7205
  /**
7206
- * Delete a robot controller from the cell. <!-- theme: warning --> > **WARNING** > > Using it in conjunction with the settings app may lead to unpredictable behavior.
7206
+ * Delete a robot controller from the cell.
7207
7207
  * @summary Delete Robot Controller
7208
7208
  * @param {string} cell Unique identifier addressing a cell in all API calls.
7209
7209
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -7224,7 +7224,7 @@ declare class ControllerApi extends BaseAPI {
7224
7224
  */
7225
7225
  getControllerDescription(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<ControllerDescription, any>>;
7226
7226
  /**
7227
- * Request a coordinate system specification for a given identifier. Use parameter orientation_type to get the orientation part of the transformation offset of the coordinate system returned in the requested orientation notation. If parameter orientation_type is not set, the orientation part of the transformation offset of the coordinate system is returned in rotation vector notation. 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.
7227
+ * Request a coordinate system specification for a given identifier. Use parameter `orientation_type` to get the orientation part of the transformation offset of the coordinate system returned in the requested orientation notation. If parameter `orientation_type` is not set, the orientation part of the transformation offset of the coordinate system is returned in rotation vector notation. 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.
7228
7228
  * @summary Coordinate System
7229
7229
  * @param {string} cell Unique identifier addressing a cell in all API calls.
7230
7230
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -7256,7 +7256,7 @@ declare class ControllerApi extends BaseAPI {
7256
7256
  */
7257
7257
  getRobotController(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<RobotController, any>>;
7258
7258
  /**
7259
- * 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.
7259
+ * 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.
7260
7260
  * @summary Virtual Controller Configuration
7261
7261
  * @param {string} cell Unique identifier addressing a cell in all API calls.
7262
7262
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -7266,7 +7266,7 @@ declare class ControllerApi extends BaseAPI {
7266
7266
  */
7267
7267
  getVirtualControllerConfiguration(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<VirtualRobotConfiguration, any>>;
7268
7268
  /**
7269
- * Lists all specifications of coordinate systems from robot controllers. Use parameter orientation_type to get the orientation part of the transformation offset of the coordinate system returned in the requested orientation notation. If parameter orientation_type is not set, the orientation part of the transformation offset of the coordinate system is returned in rotation vector notation. 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.
7269
+ * Lists all specifications of coordinate systems from robot controllers. Use parameter `orientation_type` to get the orientation part of the transformation offset of the coordinate system returned in the requested orientation notation. If parameter `orientation_type` is not set, the orientation part of the transformation offset of the coordinate system is returned in rotation vector notation. 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.
7270
7270
  * @summary List Coordinate Systems
7271
7271
  * @param {string} cell Unique identifier addressing a cell in all API calls.
7272
7272
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -7286,7 +7286,7 @@ declare class ControllerApi extends BaseAPI {
7286
7286
  */
7287
7287
  listRobotControllers(cell: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<string[], any>>;
7288
7288
  /**
7289
- * 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** > > `setDefaultMode` enables the robot controller to stay in control mode to keep the motors activated. > This allows for faster execution of sequential movements as no mode switches are required. > **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.
7289
+ * 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** > > `setDefaultMode` enables the robot controller to stay in control mode to keep the motors activated. > This allows for faster execution of sequential movements as no mode switches are required. > **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.
7290
7290
  * @summary Set Default Mode
7291
7291
  * @param {string} cell Unique identifier addressing a cell in all API calls.
7292
7292
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -7297,7 +7297,7 @@ declare class ControllerApi extends BaseAPI {
7297
7297
  */
7298
7298
  setDefaultMode(cell: string, controller: string, mode: SettableRobotSystemMode, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
7299
7299
  /**
7300
- * <!-- theme: danger --> > Websocket endpoint 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 (listController)[listController] endpoint to check if the robot controller supports free drive mode.
7300
+ * <!-- theme: success --> > Websocket endpoint 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, > - 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 cobots. Use [listRobotControllers](listRobotControllers) to check if the robot controller supports free drive mode.
7301
7301
  * @summary Stream Free Drive
7302
7302
  * @param {string} cell Unique identifier addressing a cell in all API calls.
7303
7303
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -7308,7 +7308,7 @@ declare class ControllerApi extends BaseAPI {
7308
7308
  */
7309
7309
  streamFreeDrive(cell: string, controller: string, responseRate?: number, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<RobotControllerState, any>>;
7310
7310
  /**
7311
- * <!-- theme: danger --> > Websocket endpoint Receive updates of the state of a robot controller. The stream can be opened before the controller is registered. To register a controller, call [addRobotController](addRobotController). While connecting, the stream sends initialization updates. Once the controller reaches `MODE_MONITOR`, it sends controller state updates.
7311
+ * <!-- theme: success --> > Websocket endpoint Receive updates of the state of a robot controller. The stream can be opened before the controller is registered. To register a controller, call [addRobotController](addRobotController). While connecting, the stream sends initialization updates. Once the controller reaches `MODE_MONITOR`, it sends controller state updates.
7312
7312
  * @summary Stream State
7313
7313
  * @param {string} cell Unique identifier addressing a cell in all API calls.
7314
7314
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -7320,7 +7320,7 @@ declare class ControllerApi extends BaseAPI {
7320
7320
  */
7321
7321
  streamRobotControllerState(cell: string, controller: string, responseRate?: number, addControllerTimeout?: number, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<RobotControllerState, any>>;
7322
7322
  /**
7323
- * 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.
7323
+ * Update the configuration of a robot controller. Reconfigure certain options of a robot controller, or deploy a specific container image of a robot controller.
7324
7324
  * @summary Update Robot Controller
7325
7325
  * @param {string} cell Unique identifier addressing a cell in all API calls.
7326
7326
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -7338,7 +7338,7 @@ declare class ControllerApi extends BaseAPI {
7338
7338
  */
7339
7339
  declare const ControllerInputsOutputsApiAxiosParamCreator: (configuration?: Configuration) => {
7340
7340
  /**
7341
- * Lists the input/output descriptions of the robot controller. The input/output descriptions contain information such as the name of the input/output, the input/output type and the input/output unit. The set of available inputs/outputs is defined by the robot controller. Each input/output has a unique identifier. If no identifiers are specified in the request, the full list of available inputs/outputs is retrieved by this endpoint. Except when a filter (direction, value_type, group) is applied. Then only the inputs/outputs matching the filter are returned.
7341
+ * Lists the input/output descriptions of the robot controller. The input/output descriptions contain information like name, type and unit.\\ Available inputs/outputs are defined by the robot controller\\ Each input/output has a unique identifier. - If no identifiers and no filters are specified in the request, all available inputs/outputs are retrieved by this endpoint. - If a filter, e.g., `direction`, `value_type`, `group` is applied, only matching inputs/outputs are returned.
7342
7342
  * @summary List Descriptions
7343
7343
  * @param {string} cell Unique identifier addressing a cell in all API calls.
7344
7344
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -7361,7 +7361,7 @@ declare const ControllerInputsOutputsApiAxiosParamCreator: (configuration?: Conf
7361
7361
  */
7362
7362
  listIOValues: (cell: string, controller: string, ios?: Array<string>, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
7363
7363
  /**
7364
- * Set the values of outputs. All available output 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.
7364
+ * Set the values of outputs. All available output 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 can take up to 200 milliseconds. > **NOTE** > > Do not call this endpoint while another request is still in progress. The second call will fail.
7365
7365
  * @summary Set Output Values
7366
7366
  * @param {string} cell Unique identifier addressing a cell in all API calls.
7367
7367
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -7371,7 +7371,7 @@ declare const ControllerInputsOutputsApiAxiosParamCreator: (configuration?: Conf
7371
7371
  */
7372
7372
  setOutputValues: (cell: string, controller: string, iOValue: Array<IOValue>, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
7373
7373
  /**
7374
- * <!-- theme: danger --> > Websocket endpoint Continuously receive updates of input/output 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.
7374
+ * <!-- theme: success --> > Websocket endpoint Continuously receive updates of input/output values via websocket. Updates are sent in the update rate of the controller. > **NOTE** > > If you request many values simultaneously, the request is 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. This can lead to a high amount of data transmitted.
7375
7375
  * @summary Stream Input/Output Values
7376
7376
  * @param {string} cell Unique identifier addressing a cell in all API calls.
7377
7377
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -7381,7 +7381,7 @@ declare const ControllerInputsOutputsApiAxiosParamCreator: (configuration?: Conf
7381
7381
  */
7382
7382
  streamIOValues: (cell: string, controller: string, ios?: Array<string>, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
7383
7383
  /**
7384
- * Wait until an input/output 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 input/output is compared with given value. Only set the value that corresponds to the value_type of the input/output, 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 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 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 value to true.
7384
+ * Wait until an input/output 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 input/output is compared with given value. Only set the value that corresponds to the `value_type` of the input/output. See [listIODescriptions](listIODescriptions) for more information. **Examples** 1. Wait until analog input `AI_1` < 10: ``` io: \"AI_1\" comparison_type: \"COMPARISON_LESS\" value: 10 ``` 2. Wait until analog input `AI_2` > 5.0: ``` io: \"AI_2\" comparison_type: \"COMPARISON_GREATER\" value: 5.0 ``` 3. Wait until digital input `DI_3` is true: ``` io: \"DI_3\" comparison_type: \"COMPARISON_EQUAL\" value: true ```
7385
7385
  * @summary Wait For
7386
7386
  * @param {string} cell Unique identifier addressing a cell in all API calls.
7387
7387
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -7397,7 +7397,7 @@ declare const ControllerInputsOutputsApiAxiosParamCreator: (configuration?: Conf
7397
7397
  */
7398
7398
  declare const ControllerInputsOutputsApiFp: (configuration?: Configuration) => {
7399
7399
  /**
7400
- * Lists the input/output descriptions of the robot controller. The input/output descriptions contain information such as the name of the input/output, the input/output type and the input/output unit. The set of available inputs/outputs is defined by the robot controller. Each input/output has a unique identifier. If no identifiers are specified in the request, the full list of available inputs/outputs is retrieved by this endpoint. Except when a filter (direction, value_type, group) is applied. Then only the inputs/outputs matching the filter are returned.
7400
+ * Lists the input/output descriptions of the robot controller. The input/output descriptions contain information like name, type and unit.\\ Available inputs/outputs are defined by the robot controller\\ Each input/output has a unique identifier. - If no identifiers and no filters are specified in the request, all available inputs/outputs are retrieved by this endpoint. - If a filter, e.g., `direction`, `value_type`, `group` is applied, only matching inputs/outputs are returned.
7401
7401
  * @summary List Descriptions
7402
7402
  * @param {string} cell Unique identifier addressing a cell in all API calls.
7403
7403
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -7420,7 +7420,7 @@ declare const ControllerInputsOutputsApiFp: (configuration?: Configuration) => {
7420
7420
  */
7421
7421
  listIOValues(cell: string, controller: string, ios?: Array<string>, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<IOValue>>>;
7422
7422
  /**
7423
- * Set the values of outputs. All available output 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.
7423
+ * Set the values of outputs. All available output 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 can take up to 200 milliseconds. > **NOTE** > > Do not call this endpoint while another request is still in progress. The second call will fail.
7424
7424
  * @summary Set Output Values
7425
7425
  * @param {string} cell Unique identifier addressing a cell in all API calls.
7426
7426
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -7430,7 +7430,7 @@ declare const ControllerInputsOutputsApiFp: (configuration?: Configuration) => {
7430
7430
  */
7431
7431
  setOutputValues(cell: string, controller: string, iOValue: Array<IOValue>, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
7432
7432
  /**
7433
- * <!-- theme: danger --> > Websocket endpoint Continuously receive updates of input/output 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.
7433
+ * <!-- theme: success --> > Websocket endpoint Continuously receive updates of input/output values via websocket. Updates are sent in the update rate of the controller. > **NOTE** > > If you request many values simultaneously, the request is 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. This can lead to a high amount of data transmitted.
7434
7434
  * @summary Stream Input/Output Values
7435
7435
  * @param {string} cell Unique identifier addressing a cell in all API calls.
7436
7436
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -7440,7 +7440,7 @@ declare const ControllerInputsOutputsApiFp: (configuration?: Configuration) => {
7440
7440
  */
7441
7441
  streamIOValues(cell: string, controller: string, ios?: Array<string>, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<StreamIOValuesResponse>>;
7442
7442
  /**
7443
- * Wait until an input/output 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 input/output is compared with given value. Only set the value that corresponds to the value_type of the input/output, 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 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 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 value to true.
7443
+ * Wait until an input/output 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 input/output is compared with given value. Only set the value that corresponds to the `value_type` of the input/output. See [listIODescriptions](listIODescriptions) for more information. **Examples** 1. Wait until analog input `AI_1` < 10: ``` io: \"AI_1\" comparison_type: \"COMPARISON_LESS\" value: 10 ``` 2. Wait until analog input `AI_2` > 5.0: ``` io: \"AI_2\" comparison_type: \"COMPARISON_GREATER\" value: 5.0 ``` 3. Wait until digital input `DI_3` is true: ``` io: \"DI_3\" comparison_type: \"COMPARISON_EQUAL\" value: true ```
7444
7444
  * @summary Wait For
7445
7445
  * @param {string} cell Unique identifier addressing a cell in all API calls.
7446
7446
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -7456,7 +7456,7 @@ declare const ControllerInputsOutputsApiFp: (configuration?: Configuration) => {
7456
7456
  */
7457
7457
  declare const ControllerInputsOutputsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
7458
7458
  /**
7459
- * Lists the input/output descriptions of the robot controller. The input/output descriptions contain information such as the name of the input/output, the input/output type and the input/output unit. The set of available inputs/outputs is defined by the robot controller. Each input/output has a unique identifier. If no identifiers are specified in the request, the full list of available inputs/outputs is retrieved by this endpoint. Except when a filter (direction, value_type, group) is applied. Then only the inputs/outputs matching the filter are returned.
7459
+ * Lists the input/output descriptions of the robot controller. The input/output descriptions contain information like name, type and unit.\\ Available inputs/outputs are defined by the robot controller\\ Each input/output has a unique identifier. - If no identifiers and no filters are specified in the request, all available inputs/outputs are retrieved by this endpoint. - If a filter, e.g., `direction`, `value_type`, `group` is applied, only matching inputs/outputs are returned.
7460
7460
  * @summary List Descriptions
7461
7461
  * @param {string} cell Unique identifier addressing a cell in all API calls.
7462
7462
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -7479,7 +7479,7 @@ declare const ControllerInputsOutputsApiFactory: (configuration?: Configuration,
7479
7479
  */
7480
7480
  listIOValues(cell: string, controller: string, ios?: Array<string>, options?: RawAxiosRequestConfig): AxiosPromise<Array<IOValue>>;
7481
7481
  /**
7482
- * Set the values of outputs. All available output 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.
7482
+ * Set the values of outputs. All available output 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 can take up to 200 milliseconds. > **NOTE** > > Do not call this endpoint while another request is still in progress. The second call will fail.
7483
7483
  * @summary Set Output Values
7484
7484
  * @param {string} cell Unique identifier addressing a cell in all API calls.
7485
7485
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -7489,7 +7489,7 @@ declare const ControllerInputsOutputsApiFactory: (configuration?: Configuration,
7489
7489
  */
7490
7490
  setOutputValues(cell: string, controller: string, iOValue: Array<IOValue>, options?: RawAxiosRequestConfig): AxiosPromise<void>;
7491
7491
  /**
7492
- * <!-- theme: danger --> > Websocket endpoint Continuously receive updates of input/output 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.
7492
+ * <!-- theme: success --> > Websocket endpoint Continuously receive updates of input/output values via websocket. Updates are sent in the update rate of the controller. > **NOTE** > > If you request many values simultaneously, the request is 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. This can lead to a high amount of data transmitted.
7493
7493
  * @summary Stream Input/Output Values
7494
7494
  * @param {string} cell Unique identifier addressing a cell in all API calls.
7495
7495
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -7499,7 +7499,7 @@ declare const ControllerInputsOutputsApiFactory: (configuration?: Configuration,
7499
7499
  */
7500
7500
  streamIOValues(cell: string, controller: string, ios?: Array<string>, options?: RawAxiosRequestConfig): AxiosPromise<StreamIOValuesResponse>;
7501
7501
  /**
7502
- * Wait until an input/output 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 input/output is compared with given value. Only set the value that corresponds to the value_type of the input/output, 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 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 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 value to true.
7502
+ * Wait until an input/output 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 input/output is compared with given value. Only set the value that corresponds to the `value_type` of the input/output. See [listIODescriptions](listIODescriptions) for more information. **Examples** 1. Wait until analog input `AI_1` < 10: ``` io: \"AI_1\" comparison_type: \"COMPARISON_LESS\" value: 10 ``` 2. Wait until analog input `AI_2` > 5.0: ``` io: \"AI_2\" comparison_type: \"COMPARISON_GREATER\" value: 5.0 ``` 3. Wait until digital input `DI_3` is true: ``` io: \"DI_3\" comparison_type: \"COMPARISON_EQUAL\" value: true ```
7503
7503
  * @summary Wait For
7504
7504
  * @param {string} cell Unique identifier addressing a cell in all API calls.
7505
7505
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -7517,7 +7517,7 @@ declare const ControllerInputsOutputsApiFactory: (configuration?: Configuration,
7517
7517
  */
7518
7518
  declare class ControllerInputsOutputsApi extends BaseAPI {
7519
7519
  /**
7520
- * Lists the input/output descriptions of the robot controller. The input/output descriptions contain information such as the name of the input/output, the input/output type and the input/output unit. The set of available inputs/outputs is defined by the robot controller. Each input/output has a unique identifier. If no identifiers are specified in the request, the full list of available inputs/outputs is retrieved by this endpoint. Except when a filter (direction, value_type, group) is applied. Then only the inputs/outputs matching the filter are returned.
7520
+ * Lists the input/output descriptions of the robot controller. The input/output descriptions contain information like name, type and unit.\\ Available inputs/outputs are defined by the robot controller\\ Each input/output has a unique identifier. - If no identifiers and no filters are specified in the request, all available inputs/outputs are retrieved by this endpoint. - If a filter, e.g., `direction`, `value_type`, `group` is applied, only matching inputs/outputs are returned.
7521
7521
  * @summary List Descriptions
7522
7522
  * @param {string} cell Unique identifier addressing a cell in all API calls.
7523
7523
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -7542,7 +7542,7 @@ declare class ControllerInputsOutputsApi extends BaseAPI {
7542
7542
  */
7543
7543
  listIOValues(cell: string, controller: string, ios?: Array<string>, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<IOValue[], any>>;
7544
7544
  /**
7545
- * Set the values of outputs. All available output 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.
7545
+ * Set the values of outputs. All available output 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 can take up to 200 milliseconds. > **NOTE** > > Do not call this endpoint while another request is still in progress. The second call will fail.
7546
7546
  * @summary Set Output Values
7547
7547
  * @param {string} cell Unique identifier addressing a cell in all API calls.
7548
7548
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -7553,7 +7553,7 @@ declare class ControllerInputsOutputsApi extends BaseAPI {
7553
7553
  */
7554
7554
  setOutputValues(cell: string, controller: string, iOValue: Array<IOValue>, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
7555
7555
  /**
7556
- * <!-- theme: danger --> > Websocket endpoint Continuously receive updates of input/output 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.
7556
+ * <!-- theme: success --> > Websocket endpoint Continuously receive updates of input/output values via websocket. Updates are sent in the update rate of the controller. > **NOTE** > > If you request many values simultaneously, the request is 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. This can lead to a high amount of data transmitted.
7557
7557
  * @summary Stream Input/Output Values
7558
7558
  * @param {string} cell Unique identifier addressing a cell in all API calls.
7559
7559
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -7564,7 +7564,7 @@ declare class ControllerInputsOutputsApi extends BaseAPI {
7564
7564
  */
7565
7565
  streamIOValues(cell: string, controller: string, ios?: Array<string>, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<StreamIOValuesResponse, any>>;
7566
7566
  /**
7567
- * Wait until an input/output 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 input/output is compared with given value. Only set the value that corresponds to the value_type of the input/output, 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 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 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 value to true.
7567
+ * Wait until an input/output 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 input/output is compared with given value. Only set the value that corresponds to the `value_type` of the input/output. See [listIODescriptions](listIODescriptions) for more information. **Examples** 1. Wait until analog input `AI_1` < 10: ``` io: \"AI_1\" comparison_type: \"COMPARISON_LESS\" value: 10 ``` 2. Wait until analog input `AI_2` > 5.0: ``` io: \"AI_2\" comparison_type: \"COMPARISON_GREATER\" value: 5.0 ``` 3. Wait until digital input `DI_3` is true: ``` io: \"DI_3\" comparison_type: \"COMPARISON_EQUAL\" value: true ```
7568
7568
  * @summary Wait For
7569
7569
  * @param {string} cell Unique identifier addressing a cell in all API calls.
7570
7570
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -7581,7 +7581,7 @@ declare class ControllerInputsOutputsApi extends BaseAPI {
7581
7581
  */
7582
7582
  declare const JoggingApiAxiosParamCreator: (configuration?: Configuration) => {
7583
7583
  /**
7584
- * <!-- theme: danger --> > Websocket endpoint Provides execution control over a dynamically adaptable jogging motion for a motion group. Jogging describes controlling a motion group by sending real-time commands to move either its joints or the TCP (Tool Center Point). The commands contain target velocities that may change at any time during execution, so the resulting motion cannot be computed upfront. ### Preconditions The motion group is not moved by any other endpoint. ### Requests #### 1. Send InitializeJoggingRequest to configure the jogging. Sets robot controller mode to control mode. Sets rate and coordinate system for the jogging response. #### 2. Send JointVelocityRequest or TcpVelocityRequest to start the jogging motion. #### 3. Change or stop the jogging motion - Change the jogging direction and/or velocity during the jogging motion with JointVelocityRequest or TcpVelocityRequest. - To stop the jogging motion, send zero velocities via either request. ### Responses - InitializeJoggingResponse is sent to signal the success or failure of the InitializeJoggingRequest. - Jogging responses are streamed continuously after an InitializeJoggingRequest is processed. Jogging responses contain the robot controller state and the state of the jogging control. - JoggingErrorResponse with error details is sent in case of an unexpected error, e.g., controller disconnects during jogging. ### Tips and Tricks - In the JoggingResponse, verify that the robot control is in the desired state, e.g. standstill, with JoggingState. - Ensure that the websocket connection remains open until the jogging motion is stopped to avoid unexpected stops.
7584
+ * <!-- theme: success --> > Websocket endpoint Provides execution control over a dynamically adaptable jogging motion for a motion group. Jogging describes controlling a motion group by sending real-time commands to move either its joints or the TCP. The commands contain target velocities that may change at any time during execution, so the resulting motion cannot be computed upfront. ### Preconditions The motion group is not moved by any other endpoint. ### Requests #### 1. Send `InitializeJoggingRequest` to configure the jogging. - Sets the robot controller mode to control mode. - Sets rate and coordinate system for the jogging response. #### 2. Send `JointVelocityRequest` or `TcpVelocityRequest` to start the jogging motion. #### 3. Change or stop the jogging motion - Change the jogging direction and/or velocity during the jogging motion with `JointVelocityRequest` or `TcpVelocityRequest`. - To stop the jogging motion, send zero velocities via either request. ### Responses - `InitializeJoggingResponse` is sent to signal the success or failure of the `InitializeJoggingRequest`. - Jogging responses are streamed continuously after an `InitializeJoggingRequest` is processed. Jogging responses contain the robot controller state and the state of the jogging control. - `JoggingErrorResponse` with error details is sent in case of an unexpected error, e.g., controller disconnects during jogging. ### Tips and Tricks - In the `JoggingResponse`, verify that the robot control is in the desired state, e.g., standstill, with JoggingState. - Ensure that the websocket connection remains open until the jogging motion is stopped to avoid unexpected stops.
7585
7585
  * @summary Execute Jogging
7586
7586
  * @param {string} cell Unique identifier addressing a cell in all API calls.
7587
7587
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -7597,7 +7597,7 @@ declare const JoggingApiAxiosParamCreator: (configuration?: Configuration) => {
7597
7597
  */
7598
7598
  declare const JoggingApiFp: (configuration?: Configuration) => {
7599
7599
  /**
7600
- * <!-- theme: danger --> > Websocket endpoint Provides execution control over a dynamically adaptable jogging motion for a motion group. Jogging describes controlling a motion group by sending real-time commands to move either its joints or the TCP (Tool Center Point). The commands contain target velocities that may change at any time during execution, so the resulting motion cannot be computed upfront. ### Preconditions The motion group is not moved by any other endpoint. ### Requests #### 1. Send InitializeJoggingRequest to configure the jogging. Sets robot controller mode to control mode. Sets rate and coordinate system for the jogging response. #### 2. Send JointVelocityRequest or TcpVelocityRequest to start the jogging motion. #### 3. Change or stop the jogging motion - Change the jogging direction and/or velocity during the jogging motion with JointVelocityRequest or TcpVelocityRequest. - To stop the jogging motion, send zero velocities via either request. ### Responses - InitializeJoggingResponse is sent to signal the success or failure of the InitializeJoggingRequest. - Jogging responses are streamed continuously after an InitializeJoggingRequest is processed. Jogging responses contain the robot controller state and the state of the jogging control. - JoggingErrorResponse with error details is sent in case of an unexpected error, e.g., controller disconnects during jogging. ### Tips and Tricks - In the JoggingResponse, verify that the robot control is in the desired state, e.g. standstill, with JoggingState. - Ensure that the websocket connection remains open until the jogging motion is stopped to avoid unexpected stops.
7600
+ * <!-- theme: success --> > Websocket endpoint Provides execution control over a dynamically adaptable jogging motion for a motion group. Jogging describes controlling a motion group by sending real-time commands to move either its joints or the TCP. The commands contain target velocities that may change at any time during execution, so the resulting motion cannot be computed upfront. ### Preconditions The motion group is not moved by any other endpoint. ### Requests #### 1. Send `InitializeJoggingRequest` to configure the jogging. - Sets the robot controller mode to control mode. - Sets rate and coordinate system for the jogging response. #### 2. Send `JointVelocityRequest` or `TcpVelocityRequest` to start the jogging motion. #### 3. Change or stop the jogging motion - Change the jogging direction and/or velocity during the jogging motion with `JointVelocityRequest` or `TcpVelocityRequest`. - To stop the jogging motion, send zero velocities via either request. ### Responses - `InitializeJoggingResponse` is sent to signal the success or failure of the `InitializeJoggingRequest`. - Jogging responses are streamed continuously after an `InitializeJoggingRequest` is processed. Jogging responses contain the robot controller state and the state of the jogging control. - `JoggingErrorResponse` with error details is sent in case of an unexpected error, e.g., controller disconnects during jogging. ### Tips and Tricks - In the `JoggingResponse`, verify that the robot control is in the desired state, e.g., standstill, with JoggingState. - Ensure that the websocket connection remains open until the jogging motion is stopped to avoid unexpected stops.
7601
7601
  * @summary Execute Jogging
7602
7602
  * @param {string} cell Unique identifier addressing a cell in all API calls.
7603
7603
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -7613,7 +7613,7 @@ declare const JoggingApiFp: (configuration?: Configuration) => {
7613
7613
  */
7614
7614
  declare const JoggingApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
7615
7615
  /**
7616
- * <!-- theme: danger --> > Websocket endpoint Provides execution control over a dynamically adaptable jogging motion for a motion group. Jogging describes controlling a motion group by sending real-time commands to move either its joints or the TCP (Tool Center Point). The commands contain target velocities that may change at any time during execution, so the resulting motion cannot be computed upfront. ### Preconditions The motion group is not moved by any other endpoint. ### Requests #### 1. Send InitializeJoggingRequest to configure the jogging. Sets robot controller mode to control mode. Sets rate and coordinate system for the jogging response. #### 2. Send JointVelocityRequest or TcpVelocityRequest to start the jogging motion. #### 3. Change or stop the jogging motion - Change the jogging direction and/or velocity during the jogging motion with JointVelocityRequest or TcpVelocityRequest. - To stop the jogging motion, send zero velocities via either request. ### Responses - InitializeJoggingResponse is sent to signal the success or failure of the InitializeJoggingRequest. - Jogging responses are streamed continuously after an InitializeJoggingRequest is processed. Jogging responses contain the robot controller state and the state of the jogging control. - JoggingErrorResponse with error details is sent in case of an unexpected error, e.g., controller disconnects during jogging. ### Tips and Tricks - In the JoggingResponse, verify that the robot control is in the desired state, e.g. standstill, with JoggingState. - Ensure that the websocket connection remains open until the jogging motion is stopped to avoid unexpected stops.
7616
+ * <!-- theme: success --> > Websocket endpoint Provides execution control over a dynamically adaptable jogging motion for a motion group. Jogging describes controlling a motion group by sending real-time commands to move either its joints or the TCP. The commands contain target velocities that may change at any time during execution, so the resulting motion cannot be computed upfront. ### Preconditions The motion group is not moved by any other endpoint. ### Requests #### 1. Send `InitializeJoggingRequest` to configure the jogging. - Sets the robot controller mode to control mode. - Sets rate and coordinate system for the jogging response. #### 2. Send `JointVelocityRequest` or `TcpVelocityRequest` to start the jogging motion. #### 3. Change or stop the jogging motion - Change the jogging direction and/or velocity during the jogging motion with `JointVelocityRequest` or `TcpVelocityRequest`. - To stop the jogging motion, send zero velocities via either request. ### Responses - `InitializeJoggingResponse` is sent to signal the success or failure of the `InitializeJoggingRequest`. - Jogging responses are streamed continuously after an `InitializeJoggingRequest` is processed. Jogging responses contain the robot controller state and the state of the jogging control. - `JoggingErrorResponse` with error details is sent in case of an unexpected error, e.g., controller disconnects during jogging. ### Tips and Tricks - In the `JoggingResponse`, verify that the robot control is in the desired state, e.g., standstill, with JoggingState. - Ensure that the websocket connection remains open until the jogging motion is stopped to avoid unexpected stops.
7617
7617
  * @summary Execute Jogging
7618
7618
  * @param {string} cell Unique identifier addressing a cell in all API calls.
7619
7619
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -7631,7 +7631,7 @@ declare const JoggingApiFactory: (configuration?: Configuration, basePath?: stri
7631
7631
  */
7632
7632
  declare class JoggingApi extends BaseAPI {
7633
7633
  /**
7634
- * <!-- theme: danger --> > Websocket endpoint Provides execution control over a dynamically adaptable jogging motion for a motion group. Jogging describes controlling a motion group by sending real-time commands to move either its joints or the TCP (Tool Center Point). The commands contain target velocities that may change at any time during execution, so the resulting motion cannot be computed upfront. ### Preconditions The motion group is not moved by any other endpoint. ### Requests #### 1. Send InitializeJoggingRequest to configure the jogging. Sets robot controller mode to control mode. Sets rate and coordinate system for the jogging response. #### 2. Send JointVelocityRequest or TcpVelocityRequest to start the jogging motion. #### 3. Change or stop the jogging motion - Change the jogging direction and/or velocity during the jogging motion with JointVelocityRequest or TcpVelocityRequest. - To stop the jogging motion, send zero velocities via either request. ### Responses - InitializeJoggingResponse is sent to signal the success or failure of the InitializeJoggingRequest. - Jogging responses are streamed continuously after an InitializeJoggingRequest is processed. Jogging responses contain the robot controller state and the state of the jogging control. - JoggingErrorResponse with error details is sent in case of an unexpected error, e.g., controller disconnects during jogging. ### Tips and Tricks - In the JoggingResponse, verify that the robot control is in the desired state, e.g. standstill, with JoggingState. - Ensure that the websocket connection remains open until the jogging motion is stopped to avoid unexpected stops.
7634
+ * <!-- theme: success --> > Websocket endpoint Provides execution control over a dynamically adaptable jogging motion for a motion group. Jogging describes controlling a motion group by sending real-time commands to move either its joints or the TCP. The commands contain target velocities that may change at any time during execution, so the resulting motion cannot be computed upfront. ### Preconditions The motion group is not moved by any other endpoint. ### Requests #### 1. Send `InitializeJoggingRequest` to configure the jogging. - Sets the robot controller mode to control mode. - Sets rate and coordinate system for the jogging response. #### 2. Send `JointVelocityRequest` or `TcpVelocityRequest` to start the jogging motion. #### 3. Change or stop the jogging motion - Change the jogging direction and/or velocity during the jogging motion with `JointVelocityRequest` or `TcpVelocityRequest`. - To stop the jogging motion, send zero velocities via either request. ### Responses - `InitializeJoggingResponse` is sent to signal the success or failure of the `InitializeJoggingRequest`. - Jogging responses are streamed continuously after an `InitializeJoggingRequest` is processed. Jogging responses contain the robot controller state and the state of the jogging control. - `JoggingErrorResponse` with error details is sent in case of an unexpected error, e.g., controller disconnects during jogging. ### Tips and Tricks - In the `JoggingResponse`, verify that the robot control is in the desired state, e.g., standstill, with JoggingState. - Ensure that the websocket connection remains open until the jogging motion is stopped to avoid unexpected stops.
7635
7635
  * @summary Execute Jogging
7636
7636
  * @param {string} cell Unique identifier addressing a cell in all API calls.
7637
7637
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -7763,14 +7763,14 @@ declare const LicenseApiAxiosParamCreator: (configuration?: Configuration) => {
7763
7763
  */
7764
7764
  deactivateLicense: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
7765
7765
  /**
7766
- * Get information on the license used with the Wandelbots NOVA instance, e.g. licensed product, expiration date, license status.
7766
+ * Get information on the license used with the Wandelbots NOVA instance, e.g., licensed product, expiration date, license status.
7767
7767
  * @summary Get license
7768
7768
  * @param {*} [options] Override http request option.
7769
7769
  * @throws {RequiredError}
7770
7770
  */
7771
7771
  getLicense: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
7772
7772
  /**
7773
- * 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.
7773
+ * 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.
7774
7774
  * @summary Get license status
7775
7775
  * @param {*} [options] Override http request option.
7776
7776
  * @throws {RequiredError}
@@ -7798,14 +7798,14 @@ declare const LicenseApiFp: (configuration?: Configuration) => {
7798
7798
  */
7799
7799
  deactivateLicense(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
7800
7800
  /**
7801
- * Get information on the license used with the Wandelbots NOVA instance, e.g. licensed product, expiration date, license status.
7801
+ * Get information on the license used with the Wandelbots NOVA instance, e.g., licensed product, expiration date, license status.
7802
7802
  * @summary Get license
7803
7803
  * @param {*} [options] Override http request option.
7804
7804
  * @throws {RequiredError}
7805
7805
  */
7806
7806
  getLicense(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<License>>;
7807
7807
  /**
7808
- * 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.
7808
+ * 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.
7809
7809
  * @summary Get license status
7810
7810
  * @param {*} [options] Override http request option.
7811
7811
  * @throws {RequiredError}
@@ -7833,14 +7833,14 @@ declare const LicenseApiFactory: (configuration?: Configuration, basePath?: stri
7833
7833
  */
7834
7834
  deactivateLicense(options?: RawAxiosRequestConfig): AxiosPromise<void>;
7835
7835
  /**
7836
- * Get information on the license used with the Wandelbots NOVA instance, e.g. licensed product, expiration date, license status.
7836
+ * Get information on the license used with the Wandelbots NOVA instance, e.g., licensed product, expiration date, license status.
7837
7837
  * @summary Get license
7838
7838
  * @param {*} [options] Override http request option.
7839
7839
  * @throws {RequiredError}
7840
7840
  */
7841
7841
  getLicense(options?: RawAxiosRequestConfig): AxiosPromise<License>;
7842
7842
  /**
7843
- * 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.
7843
+ * 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.
7844
7844
  * @summary Get license status
7845
7845
  * @param {*} [options] Override http request option.
7846
7846
  * @throws {RequiredError}
@@ -7872,7 +7872,7 @@ declare class LicenseApi extends BaseAPI {
7872
7872
  */
7873
7873
  deactivateLicense(options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
7874
7874
  /**
7875
- * Get information on the license used with the Wandelbots NOVA instance, e.g. licensed product, expiration date, license status.
7875
+ * Get information on the license used with the Wandelbots NOVA instance, e.g., licensed product, expiration date, license status.
7876
7876
  * @summary Get license
7877
7877
  * @param {*} [options] Override http request option.
7878
7878
  * @throws {RequiredError}
@@ -7880,7 +7880,7 @@ declare class LicenseApi extends BaseAPI {
7880
7880
  */
7881
7881
  getLicense(options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<License, any>>;
7882
7882
  /**
7883
- * 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.
7883
+ * 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.
7884
7884
  * @summary Get license status
7885
7885
  * @param {*} [options] Override http request option.
7886
7886
  * @throws {RequiredError}
@@ -7905,7 +7905,7 @@ declare const MotionGroupApiAxiosParamCreator: (configuration?: Configuration) =
7905
7905
  */
7906
7906
  getCurrentMotionGroupState: (cell: string, controller: string, motionGroup: string, responseCoordinateSystem?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
7907
7907
  /**
7908
- * Get the set of parameters that describe the motion group and its configuration including safety zones, limits, etc. This data might change upon connection to the robot.
7908
+ * Get the set of parameters that describe the motion group and its configuration including safety zones, limits, etc. This data can change upon connection to the robot.
7909
7909
  * @summary Description
7910
7910
  * @param {string} cell Unique identifier addressing a cell in all API calls.
7911
7911
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -7915,7 +7915,7 @@ declare const MotionGroupApiAxiosParamCreator: (configuration?: Configuration) =
7915
7915
  */
7916
7916
  getMotionGroupDescription: (cell: string, controller: string, motionGroup: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
7917
7917
  /**
7918
- * <!-- theme: danger --> > Websocket endpoint Receive updates of the motion group state. The stream will be closed from the server if the controller is disconnected.
7918
+ * <!-- theme: success --> > Websocket endpoint Receive updates of the motion group state. The stream will be closed from the server if the controller is disconnected.
7919
7919
  * @summary Stream State
7920
7920
  * @param {string} cell Unique identifier addressing a cell in all API calls.
7921
7921
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -7944,7 +7944,7 @@ declare const MotionGroupApiFp: (configuration?: Configuration) => {
7944
7944
  */
7945
7945
  getCurrentMotionGroupState(cell: string, controller: string, motionGroup: string, responseCoordinateSystem?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<MotionGroupState>>;
7946
7946
  /**
7947
- * Get the set of parameters that describe the motion group and its configuration including safety zones, limits, etc. This data might change upon connection to the robot.
7947
+ * Get the set of parameters that describe the motion group and its configuration including safety zones, limits, etc. This data can change upon connection to the robot.
7948
7948
  * @summary Description
7949
7949
  * @param {string} cell Unique identifier addressing a cell in all API calls.
7950
7950
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -7954,7 +7954,7 @@ declare const MotionGroupApiFp: (configuration?: Configuration) => {
7954
7954
  */
7955
7955
  getMotionGroupDescription(cell: string, controller: string, motionGroup: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<MotionGroupDescription>>;
7956
7956
  /**
7957
- * <!-- theme: danger --> > Websocket endpoint Receive updates of the motion group state. The stream will be closed from the server if the controller is disconnected.
7957
+ * <!-- theme: success --> > Websocket endpoint Receive updates of the motion group state. The stream will be closed from the server if the controller is disconnected.
7958
7958
  * @summary Stream State
7959
7959
  * @param {string} cell Unique identifier addressing a cell in all API calls.
7960
7960
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -7983,7 +7983,7 @@ declare const MotionGroupApiFactory: (configuration?: Configuration, basePath?:
7983
7983
  */
7984
7984
  getCurrentMotionGroupState(cell: string, controller: string, motionGroup: string, responseCoordinateSystem?: string, options?: RawAxiosRequestConfig): AxiosPromise<MotionGroupState>;
7985
7985
  /**
7986
- * Get the set of parameters that describe the motion group and its configuration including safety zones, limits, etc. This data might change upon connection to the robot.
7986
+ * Get the set of parameters that describe the motion group and its configuration including safety zones, limits, etc. This data can change upon connection to the robot.
7987
7987
  * @summary Description
7988
7988
  * @param {string} cell Unique identifier addressing a cell in all API calls.
7989
7989
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -7993,7 +7993,7 @@ declare const MotionGroupApiFactory: (configuration?: Configuration, basePath?:
7993
7993
  */
7994
7994
  getMotionGroupDescription(cell: string, controller: string, motionGroup: string, options?: RawAxiosRequestConfig): AxiosPromise<MotionGroupDescription>;
7995
7995
  /**
7996
- * <!-- theme: danger --> > Websocket endpoint Receive updates of the motion group state. The stream will be closed from the server if the controller is disconnected.
7996
+ * <!-- theme: success --> > Websocket endpoint Receive updates of the motion group state. The stream will be closed from the server if the controller is disconnected.
7997
7997
  * @summary Stream State
7998
7998
  * @param {string} cell Unique identifier addressing a cell in all API calls.
7999
7999
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -8025,7 +8025,7 @@ declare class MotionGroupApi extends BaseAPI {
8025
8025
  */
8026
8026
  getCurrentMotionGroupState(cell: string, controller: string, motionGroup: string, responseCoordinateSystem?: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<MotionGroupState, any>>;
8027
8027
  /**
8028
- * Get the set of parameters that describe the motion group and its configuration including safety zones, limits, etc. This data might change upon connection to the robot.
8028
+ * Get the set of parameters that describe the motion group and its configuration including safety zones, limits, etc. This data can change upon connection to the robot.
8029
8029
  * @summary Description
8030
8030
  * @param {string} cell Unique identifier addressing a cell in all API calls.
8031
8031
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -8036,7 +8036,7 @@ declare class MotionGroupApi extends BaseAPI {
8036
8036
  */
8037
8037
  getMotionGroupDescription(cell: string, controller: string, motionGroup: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<MotionGroupDescription, any>>;
8038
8038
  /**
8039
- * <!-- theme: danger --> > Websocket endpoint Receive updates of the motion group state. The stream will be closed from the server if the controller is disconnected.
8039
+ * <!-- theme: success --> > Websocket endpoint Receive updates of the motion group state. The stream will be closed from the server if the controller is disconnected.
8040
8040
  * @summary Stream State
8041
8041
  * @param {string} cell Unique identifier addressing a cell in all API calls.
8042
8042
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -8058,7 +8058,7 @@ declare const MotionGroupModelsApiAxiosParamCreator: (configuration?: Configurat
8058
8058
  * Returns the default collision link chain for a given motion group model. See [getMotionGroupModels](getMotionGroupModels) 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. Attach additional shapes to the link reference frames by extending the link dictionaries before further use. Additional shapes may overlap each other per link and may also overlap the respective link\'s default shape.
8059
8059
  * @summary Get Collision Model
8060
8060
  * @param {string} cell Unique identifier addressing a cell in all API calls.
8061
- * @param {string} motionGroupModel Unique identifier for the model of a motion group, e.g. &#x60;UniversalRobots_UR10e&#x60;. Get the &#x60;model&#x60; of a configured motion group with [getOptimizerConfiguration](getOptimizerConfiguration).
8061
+ * @param {string} motionGroupModel Unique identifier for the model of a motion group, e.g., &#x60;UniversalRobots_UR10e&#x60;. Get the &#x60;model&#x60; of a configured motion group with [getOptimizerConfiguration](getOptimizerConfiguration).
8062
8062
  * @param {*} [options] Override http request option.
8063
8063
  * @throws {RequiredError}
8064
8064
  */
@@ -8081,7 +8081,7 @@ declare const MotionGroupModelsApiFp: (configuration?: Configuration) => {
8081
8081
  * Returns the default collision link chain for a given motion group model. See [getMotionGroupModels](getMotionGroupModels) 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. Attach additional shapes to the link reference frames by extending the link dictionaries before further use. Additional shapes may overlap each other per link and may also overlap the respective link\'s default shape.
8082
8082
  * @summary Get Collision Model
8083
8083
  * @param {string} cell Unique identifier addressing a cell in all API calls.
8084
- * @param {string} motionGroupModel Unique identifier for the model of a motion group, e.g. &#x60;UniversalRobots_UR10e&#x60;. Get the &#x60;model&#x60; of a configured motion group with [getOptimizerConfiguration](getOptimizerConfiguration).
8084
+ * @param {string} motionGroupModel Unique identifier for the model of a motion group, e.g., &#x60;UniversalRobots_UR10e&#x60;. Get the &#x60;model&#x60; of a configured motion group with [getOptimizerConfiguration](getOptimizerConfiguration).
8085
8085
  * @param {*} [options] Override http request option.
8086
8086
  * @throws {RequiredError}
8087
8087
  */
@@ -8106,7 +8106,7 @@ declare const MotionGroupModelsApiFactory: (configuration?: Configuration, baseP
8106
8106
  * Returns the default collision link chain for a given motion group model. See [getMotionGroupModels](getMotionGroupModels) 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. Attach additional shapes to the link reference frames by extending the link dictionaries before further use. Additional shapes may overlap each other per link and may also overlap the respective link\'s default shape.
8107
8107
  * @summary Get Collision Model
8108
8108
  * @param {string} cell Unique identifier addressing a cell in all API calls.
8109
- * @param {string} motionGroupModel Unique identifier for the model of a motion group, e.g. &#x60;UniversalRobots_UR10e&#x60;. Get the &#x60;model&#x60; of a configured motion group with [getOptimizerConfiguration](getOptimizerConfiguration).
8109
+ * @param {string} motionGroupModel Unique identifier for the model of a motion group, e.g., &#x60;UniversalRobots_UR10e&#x60;. Get the &#x60;model&#x60; of a configured motion group with [getOptimizerConfiguration](getOptimizerConfiguration).
8110
8110
  * @param {*} [options] Override http request option.
8111
8111
  * @throws {RequiredError}
8112
8112
  */
@@ -8133,7 +8133,7 @@ declare class MotionGroupModelsApi extends BaseAPI {
8133
8133
  * Returns the default collision link chain for a given motion group model. See [getMotionGroupModels](getMotionGroupModels) 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. Attach additional shapes to the link reference frames by extending the link dictionaries before further use. Additional shapes may overlap each other per link and may also overlap the respective link\'s default shape.
8134
8134
  * @summary Get Collision Model
8135
8135
  * @param {string} cell Unique identifier addressing a cell in all API calls.
8136
- * @param {string} motionGroupModel Unique identifier for the model of a motion group, e.g. &#x60;UniversalRobots_UR10e&#x60;. Get the &#x60;model&#x60; of a configured motion group with [getOptimizerConfiguration](getOptimizerConfiguration).
8136
+ * @param {string} motionGroupModel Unique identifier for the model of a motion group, e.g., &#x60;UniversalRobots_UR10e&#x60;. Get the &#x60;model&#x60; of a configured motion group with [getOptimizerConfiguration](getOptimizerConfiguration).
8137
8137
  * @param {*} [options] Override http request option.
8138
8138
  * @throws {RequiredError}
8139
8139
  * @memberof MotionGroupModelsApi
@@ -8409,7 +8409,7 @@ declare const StoreCollisionComponentsApiAxiosParamCreator: (configuration?: Con
8409
8409
  */
8410
8410
  listStoredCollisionTools: (cell: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
8411
8411
  /**
8412
- * Stores collider. If the collider does not exist, it will be created. If the collider exists, it will be updated.
8412
+ * Stores collider. - If the collider does not exist, it will be created. - If the collider exists, it will be updated.
8413
8413
  * @summary Store Collider
8414
8414
  * @param {string} cell Unique identifier addressing a cell in all API calls.
8415
8415
  * @param {string} collider Unique identifier addressing a collider.
@@ -8419,7 +8419,7 @@ declare const StoreCollisionComponentsApiAxiosParamCreator: (configuration?: Con
8419
8419
  */
8420
8420
  storeCollider: (cell: string, collider: string, collider2: Collider, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
8421
8421
  /**
8422
- * Stores link chain. If the link chain does not exist, it will be created. If the link chain exists, it will be updated.
8422
+ * Stores link chain. - If the link chain does not exist, it will be created. - If the link chain exists, it will be updated.
8423
8423
  * @summary Store Link Chain
8424
8424
  * @param {string} cell Unique identifier addressing a cell in all API calls.
8425
8425
  * @param {string} linkChain Unique identifier addressing a collision link chain.
@@ -8431,7 +8431,7 @@ declare const StoreCollisionComponentsApiAxiosParamCreator: (configuration?: Con
8431
8431
  [key: string]: Collider;
8432
8432
  }>, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
8433
8433
  /**
8434
- * Stores the tool. If the tool does not exist, it will be created. If the tool exists, it will be updated.
8434
+ * Stores the tool. - If the tool does not exist, it will be created. - If the tool exists, it will be updated.
8435
8435
  * @summary Store Tool
8436
8436
  * @param {string} cell Unique identifier addressing a cell in all API calls.
8437
8437
  * @param {string} tool Unique identifier addressing a collision tool.
@@ -8541,7 +8541,7 @@ declare const StoreCollisionComponentsApiFp: (configuration?: Configuration) =>
8541
8541
  };
8542
8542
  }>>;
8543
8543
  /**
8544
- * Stores collider. If the collider does not exist, it will be created. If the collider exists, it will be updated.
8544
+ * Stores collider. - If the collider does not exist, it will be created. - If the collider exists, it will be updated.
8545
8545
  * @summary Store Collider
8546
8546
  * @param {string} cell Unique identifier addressing a cell in all API calls.
8547
8547
  * @param {string} collider Unique identifier addressing a collider.
@@ -8551,7 +8551,7 @@ declare const StoreCollisionComponentsApiFp: (configuration?: Configuration) =>
8551
8551
  */
8552
8552
  storeCollider(cell: string, collider: string, collider2: Collider, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Collider>>;
8553
8553
  /**
8554
- * Stores link chain. If the link chain does not exist, it will be created. If the link chain exists, it will be updated.
8554
+ * Stores link chain. - If the link chain does not exist, it will be created. - If the link chain exists, it will be updated.
8555
8555
  * @summary Store Link Chain
8556
8556
  * @param {string} cell Unique identifier addressing a cell in all API calls.
8557
8557
  * @param {string} linkChain Unique identifier addressing a collision link chain.
@@ -8565,7 +8565,7 @@ declare const StoreCollisionComponentsApiFp: (configuration?: Configuration) =>
8565
8565
  [key: string]: Collider;
8566
8566
  }>>>;
8567
8567
  /**
8568
- * Stores the tool. If the tool does not exist, it will be created. If the tool exists, it will be updated.
8568
+ * Stores the tool. - If the tool does not exist, it will be created. - If the tool exists, it will be updated.
8569
8569
  * @summary Store Tool
8570
8570
  * @param {string} cell Unique identifier addressing a cell in all API calls.
8571
8571
  * @param {string} tool Unique identifier addressing a collision tool.
@@ -8677,7 +8677,7 @@ declare const StoreCollisionComponentsApiFactory: (configuration?: Configuration
8677
8677
  };
8678
8678
  }>;
8679
8679
  /**
8680
- * Stores collider. If the collider does not exist, it will be created. If the collider exists, it will be updated.
8680
+ * Stores collider. - If the collider does not exist, it will be created. - If the collider exists, it will be updated.
8681
8681
  * @summary Store Collider
8682
8682
  * @param {string} cell Unique identifier addressing a cell in all API calls.
8683
8683
  * @param {string} collider Unique identifier addressing a collider.
@@ -8687,7 +8687,7 @@ declare const StoreCollisionComponentsApiFactory: (configuration?: Configuration
8687
8687
  */
8688
8688
  storeCollider(cell: string, collider: string, collider2: Collider, options?: RawAxiosRequestConfig): AxiosPromise<Collider>;
8689
8689
  /**
8690
- * Stores link chain. If the link chain does not exist, it will be created. If the link chain exists, it will be updated.
8690
+ * Stores link chain. - If the link chain does not exist, it will be created. - If the link chain exists, it will be updated.
8691
8691
  * @summary Store Link Chain
8692
8692
  * @param {string} cell Unique identifier addressing a cell in all API calls.
8693
8693
  * @param {string} linkChain Unique identifier addressing a collision link chain.
@@ -8701,7 +8701,7 @@ declare const StoreCollisionComponentsApiFactory: (configuration?: Configuration
8701
8701
  [key: string]: Collider;
8702
8702
  }>>;
8703
8703
  /**
8704
- * Stores the tool. If the tool does not exist, it will be created. If the tool exists, it will be updated.
8704
+ * Stores the tool. - If the tool does not exist, it will be created. - If the tool exists, it will be updated.
8705
8705
  * @summary Store Tool
8706
8706
  * @param {string} cell Unique identifier addressing a cell in all API calls.
8707
8707
  * @param {string} tool Unique identifier addressing a collision tool.
@@ -8824,7 +8824,7 @@ declare class StoreCollisionComponentsApi extends BaseAPI {
8824
8824
  };
8825
8825
  }, any>>;
8826
8826
  /**
8827
- * Stores collider. If the collider does not exist, it will be created. If the collider exists, it will be updated.
8827
+ * Stores collider. - If the collider does not exist, it will be created. - If the collider exists, it will be updated.
8828
8828
  * @summary Store Collider
8829
8829
  * @param {string} cell Unique identifier addressing a cell in all API calls.
8830
8830
  * @param {string} collider Unique identifier addressing a collider.
@@ -8835,7 +8835,7 @@ declare class StoreCollisionComponentsApi extends BaseAPI {
8835
8835
  */
8836
8836
  storeCollider(cell: string, collider: string, collider2: Collider, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<Collider, any>>;
8837
8837
  /**
8838
- * Stores link chain. If the link chain does not exist, it will be created. If the link chain exists, it will be updated.
8838
+ * Stores link chain. - If the link chain does not exist, it will be created. - If the link chain exists, it will be updated.
8839
8839
  * @summary Store Link Chain
8840
8840
  * @param {string} cell Unique identifier addressing a cell in all API calls.
8841
8841
  * @param {string} linkChain Unique identifier addressing a collision link chain.
@@ -8850,7 +8850,7 @@ declare class StoreCollisionComponentsApi extends BaseAPI {
8850
8850
  [key: string]: Collider;
8851
8851
  }[], any>>;
8852
8852
  /**
8853
- * Stores the tool. If the tool does not exist, it will be created. If the tool exists, it will be updated.
8853
+ * Stores the tool. - If the tool does not exist, it will be created. - If the tool exists, it will be updated.
8854
8854
  * @summary Store Tool
8855
8855
  * @param {string} cell Unique identifier addressing a cell in all API calls.
8856
8856
  * @param {string} tool Unique identifier addressing a collision tool.
@@ -8897,7 +8897,7 @@ declare const StoreCollisionSetupsApiAxiosParamCreator: (configuration?: Configu
8897
8897
  */
8898
8898
  listStoredCollisionSetups: (cell: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
8899
8899
  /**
8900
- * Stores collision setup. If the collision setup does not exist, it will be created. If the collision setup exists, it will be updated.
8900
+ * Stores collision setup. - If the collision setup does not exist, it will be created. - If the collision setup exists, it will be updated.
8901
8901
  * @summary Store Collision Setup
8902
8902
  * @param {string} cell Unique identifier addressing a cell in all API calls.
8903
8903
  * @param {string} setup Identifier of the collision setup
@@ -8941,7 +8941,7 @@ declare const StoreCollisionSetupsApiFp: (configuration?: Configuration) => {
8941
8941
  [key: string]: CollisionSetup;
8942
8942
  }>>;
8943
8943
  /**
8944
- * Stores collision setup. If the collision setup does not exist, it will be created. If the collision setup exists, it will be updated.
8944
+ * Stores collision setup. - If the collision setup does not exist, it will be created. - If the collision setup exists, it will be updated.
8945
8945
  * @summary Store Collision Setup
8946
8946
  * @param {string} cell Unique identifier addressing a cell in all API calls.
8947
8947
  * @param {string} setup Identifier of the collision setup
@@ -8985,7 +8985,7 @@ declare const StoreCollisionSetupsApiFactory: (configuration?: Configuration, ba
8985
8985
  [key: string]: CollisionSetup;
8986
8986
  }>;
8987
8987
  /**
8988
- * Stores collision setup. If the collision setup does not exist, it will be created. If the collision setup exists, it will be updated.
8988
+ * Stores collision setup. - If the collision setup does not exist, it will be created. - If the collision setup exists, it will be updated.
8989
8989
  * @summary Store Collision Setup
8990
8990
  * @param {string} cell Unique identifier addressing a cell in all API calls.
8991
8991
  * @param {string} setup Identifier of the collision setup
@@ -9034,7 +9034,7 @@ declare class StoreCollisionSetupsApi extends BaseAPI {
9034
9034
  [key: string]: CollisionSetup;
9035
9035
  }, any>>;
9036
9036
  /**
9037
- * Stores collision setup. If the collision setup does not exist, it will be created. If the collision setup exists, it will be updated.
9037
+ * Stores collision setup. - If the collision setup does not exist, it will be created. - If the collision setup exists, it will be updated.
9038
9038
  * @summary Store Collision Setup
9039
9039
  * @param {string} cell Unique identifier addressing a cell in all API calls.
9040
9040
  * @param {string} setup Identifier of the collision setup
@@ -9068,7 +9068,7 @@ declare const StoreObjectApiAxiosParamCreator: (configuration?: Configuration) =
9068
9068
  */
9069
9069
  deleteObject: (cell: string, key: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
9070
9070
  /**
9071
- * Get the object. This request returns the object and any metadata attached to it.
9071
+ * Returns content and metadata of a stored object.
9072
9072
  * @summary Get Object
9073
9073
  * @param {string} cell Unique identifier addressing a cell in all API calls.
9074
9074
  * @param {string} key
@@ -9077,7 +9077,7 @@ declare const StoreObjectApiAxiosParamCreator: (configuration?: Configuration) =
9077
9077
  */
9078
9078
  getObject: (cell: string, key: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
9079
9079
  /**
9080
- * Get object metadata. Objects can be large. Therefore this request only returns metadata without fetching the object\'s content.
9080
+ * Returns metadata. Object content is not returned.
9081
9081
  * @summary Get Object Metadata
9082
9082
  * @param {string} cell Unique identifier addressing a cell in all API calls.
9083
9083
  * @param {string} key
@@ -9094,7 +9094,7 @@ declare const StoreObjectApiAxiosParamCreator: (configuration?: Configuration) =
9094
9094
  */
9095
9095
  listAllObjectKeys: (cell: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
9096
9096
  /**
9097
- * 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.
9097
+ * 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.
9098
9098
  * @summary Store Object
9099
9099
  * @param {string} cell Unique identifier addressing a cell in all API calls.
9100
9100
  * @param {string} key
@@ -9130,7 +9130,7 @@ declare const StoreObjectApiFp: (configuration?: Configuration) => {
9130
9130
  */
9131
9131
  deleteObject(cell: string, key: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
9132
9132
  /**
9133
- * Get the object. This request returns the object and any metadata attached to it.
9133
+ * Returns content and metadata of a stored object.
9134
9134
  * @summary Get Object
9135
9135
  * @param {string} cell Unique identifier addressing a cell in all API calls.
9136
9136
  * @param {string} key
@@ -9139,7 +9139,7 @@ declare const StoreObjectApiFp: (configuration?: Configuration) => {
9139
9139
  */
9140
9140
  getObject(cell: string, key: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<File>>;
9141
9141
  /**
9142
- * Get object metadata. Objects can be large. Therefore this request only returns metadata without fetching the object\'s content.
9142
+ * Returns metadata. Object content is not returned.
9143
9143
  * @summary Get Object Metadata
9144
9144
  * @param {string} cell Unique identifier addressing a cell in all API calls.
9145
9145
  * @param {string} key
@@ -9156,7 +9156,7 @@ declare const StoreObjectApiFp: (configuration?: Configuration) => {
9156
9156
  */
9157
9157
  listAllObjectKeys(cell: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<string>>>;
9158
9158
  /**
9159
- * 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.
9159
+ * 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.
9160
9160
  * @summary Store Object
9161
9161
  * @param {string} cell Unique identifier addressing a cell in all API calls.
9162
9162
  * @param {string} key
@@ -9192,7 +9192,7 @@ declare const StoreObjectApiFactory: (configuration?: Configuration, basePath?:
9192
9192
  */
9193
9193
  deleteObject(cell: string, key: string, options?: RawAxiosRequestConfig): AxiosPromise<void>;
9194
9194
  /**
9195
- * Get the object. This request returns the object and any metadata attached to it.
9195
+ * Returns content and metadata of a stored object.
9196
9196
  * @summary Get Object
9197
9197
  * @param {string} cell Unique identifier addressing a cell in all API calls.
9198
9198
  * @param {string} key
@@ -9201,7 +9201,7 @@ declare const StoreObjectApiFactory: (configuration?: Configuration, basePath?:
9201
9201
  */
9202
9202
  getObject(cell: string, key: string, options?: RawAxiosRequestConfig): AxiosPromise<File>;
9203
9203
  /**
9204
- * Get object metadata. Objects can be large. Therefore this request only returns metadata without fetching the object\'s content.
9204
+ * Returns metadata. Object content is not returned.
9205
9205
  * @summary Get Object Metadata
9206
9206
  * @param {string} cell Unique identifier addressing a cell in all API calls.
9207
9207
  * @param {string} key
@@ -9218,7 +9218,7 @@ declare const StoreObjectApiFactory: (configuration?: Configuration, basePath?:
9218
9218
  */
9219
9219
  listAllObjectKeys(cell: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<string>>;
9220
9220
  /**
9221
- * 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.
9221
+ * 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.
9222
9222
  * @summary Store Object
9223
9223
  * @param {string} cell Unique identifier addressing a cell in all API calls.
9224
9224
  * @param {string} key
@@ -9258,7 +9258,7 @@ declare class StoreObjectApi extends BaseAPI {
9258
9258
  */
9259
9259
  deleteObject(cell: string, key: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
9260
9260
  /**
9261
- * Get the object. This request returns the object and any metadata attached to it.
9261
+ * Returns content and metadata of a stored object.
9262
9262
  * @summary Get Object
9263
9263
  * @param {string} cell Unique identifier addressing a cell in all API calls.
9264
9264
  * @param {string} key
@@ -9268,7 +9268,7 @@ declare class StoreObjectApi extends BaseAPI {
9268
9268
  */
9269
9269
  getObject(cell: string, key: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<File, any>>;
9270
9270
  /**
9271
- * Get object metadata. Objects can be large. Therefore this request only returns metadata without fetching the object\'s content.
9271
+ * Returns metadata. Object content is not returned.
9272
9272
  * @summary Get Object Metadata
9273
9273
  * @param {string} cell Unique identifier addressing a cell in all API calls.
9274
9274
  * @param {string} key
@@ -9287,7 +9287,7 @@ declare class StoreObjectApi extends BaseAPI {
9287
9287
  */
9288
9288
  listAllObjectKeys(cell: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<string[], any>>;
9289
9289
  /**
9290
- * 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.
9290
+ * 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.
9291
9291
  * @summary Store Object
9292
9292
  * @param {string} cell Unique identifier addressing a cell in all API calls.
9293
9293
  * @param {string} key
@@ -9630,7 +9630,7 @@ declare class SystemApi extends BaseAPI {
9630
9630
  */
9631
9631
  declare const TrajectoryCachingApiAxiosParamCreator: (configuration?: Configuration) => {
9632
9632
  /**
9633
- * <!-- theme: info --> > Using the trajectory cache is an optional performance optimization. It is not necessary to use the cache to execute trajectories. Loads and validates the data of a trajectory into the execution cache, rendering the trajectory executable. The response contains the result of the validation of the trajectory. Validation can lead to three different results: - Fully valid: The whole trajectory can be executed from start to end. The response will contain an unique identifier which is used to move the robot. - Partially valid: Only parts of the trajectory can be executed. The response will contain an unique identifier to move the robot and information about the failure for the part that is not executable. - Invalid: The trajectory can not be executed. The response will tell you the reason of failure. If the trajectory is at least partially valid, the parts of the trajectory that are valid can be executed using the [executeTrajectory](executeTrajectory) endpoint. The workflow is as follows: - Generate a trajectory with [planTrajectory](planTrajectory) or your own motion planner, - Send the trajectory to this endpoint to validate it and get a unique identifier for it, - The unique identifier will appear in the list of available trajectories, see [listTrajectories](listTrajectories) endpoint, if it is at least partially executable. - Execute your trajectory using the [executeTrajectory](executeTrajectory) endpoint.
9633
+ * Loads and validates the data of a trajectory into the execution cache, rendering the trajectory executable. <!-- theme: info --> > #### NOTE > > Using the trajectory cache is an optional performance optimization. It is not necessary to use the cache to execute trajectories. The response contains the result of the validation of the trajectory. Validation can lead to three different results: - Fully valid: The whole trajectory can be executed from start to end. The response will contain an unique identifier which is used to move the robot. - Partially valid: Only parts of the trajectory can be executed. The response will contain an unique identifier to move the robot and information about the failure for the part that is not executable. - Invalid: The trajectory can not be executed. The response will tell you the reason of failure. If the trajectory is at least partially valid, the parts of the trajectory that are valid can be executed using the [executeTrajectory](executeTrajectory) endpoint. The workflow is as follows: - Generate a trajectory with [planTrajectory](planTrajectory) or your own motion planner, - Send the trajectory to this endpoint to validate it and get a unique identifier for it, - The unique identifier will appear in the list of available trajectories, see [listTrajectories](listTrajectories) endpoint, if it is at least partially executable. - Execute your trajectory using the [executeTrajectory](executeTrajectory) endpoint.
9634
9634
  * @summary Add Trajectory
9635
9635
  * @param {string} cell Unique identifier addressing a cell in all API calls.
9636
9636
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -9649,7 +9649,7 @@ declare const TrajectoryCachingApiAxiosParamCreator: (configuration?: Configurat
9649
9649
  */
9650
9650
  clearTrajectories: (cell: string, controller: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
9651
9651
  /**
9652
- * Delete a previously created trajectory from cache. Use [listTrajectories](listTrajectories) to list all cached trajectories. Trajectories are removed automatically if the motion group or the corresponding controller is disconnected.
9652
+ * Delete a previously created trajectory from cache. Use [listTrajectories](listTrajectories) to list all cached trajectories. Trajectories are removed automatically if the motion group or the corresponding controller is disconnected.
9653
9653
  * @summary Delete Trajectory
9654
9654
  * @param {string} cell Unique identifier addressing a cell in all API calls.
9655
9655
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -9659,7 +9659,7 @@ declare const TrajectoryCachingApiAxiosParamCreator: (configuration?: Configurat
9659
9659
  */
9660
9660
  deleteTrajectory: (cell: string, controller: string, trajectory: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
9661
9661
  /**
9662
- * Get a previously created trajectory from cache. Use [listTrajectories](listTrajectories) to list all cached trajectories.
9662
+ * Get a previously created trajectory from cache. Use [listTrajectories](listTrajectories) to list all cached trajectories.
9663
9663
  * @summary Get Trajectory
9664
9664
  * @param {string} cell Unique identifier addressing a cell in all API calls.
9665
9665
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -9669,7 +9669,7 @@ declare const TrajectoryCachingApiAxiosParamCreator: (configuration?: Configurat
9669
9669
  */
9670
9670
  getTrajectory: (cell: string, controller: string, trajectory: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
9671
9671
  /**
9672
- * List currently cached trajectories. Use [addTrajectory](addTrajectory) to add a new trajectory. Adding trajectories is necessary to execute them. Trajectories are removed if the corresponding motion group or controller disconnects.
9672
+ * List currently cached trajectories. Use [addTrajectory](addTrajectory) to add a new trajectory. Adding trajectories is necessary to execute them. Trajectories are removed if the corresponding motion group or controller disconnects.
9673
9673
  * @summary List Trajectories
9674
9674
  * @param {string} cell Unique identifier addressing a cell in all API calls.
9675
9675
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -9684,7 +9684,7 @@ declare const TrajectoryCachingApiAxiosParamCreator: (configuration?: Configurat
9684
9684
  */
9685
9685
  declare const TrajectoryCachingApiFp: (configuration?: Configuration) => {
9686
9686
  /**
9687
- * <!-- theme: info --> > Using the trajectory cache is an optional performance optimization. It is not necessary to use the cache to execute trajectories. Loads and validates the data of a trajectory into the execution cache, rendering the trajectory executable. The response contains the result of the validation of the trajectory. Validation can lead to three different results: - Fully valid: The whole trajectory can be executed from start to end. The response will contain an unique identifier which is used to move the robot. - Partially valid: Only parts of the trajectory can be executed. The response will contain an unique identifier to move the robot and information about the failure for the part that is not executable. - Invalid: The trajectory can not be executed. The response will tell you the reason of failure. If the trajectory is at least partially valid, the parts of the trajectory that are valid can be executed using the [executeTrajectory](executeTrajectory) endpoint. The workflow is as follows: - Generate a trajectory with [planTrajectory](planTrajectory) or your own motion planner, - Send the trajectory to this endpoint to validate it and get a unique identifier for it, - The unique identifier will appear in the list of available trajectories, see [listTrajectories](listTrajectories) endpoint, if it is at least partially executable. - Execute your trajectory using the [executeTrajectory](executeTrajectory) endpoint.
9687
+ * Loads and validates the data of a trajectory into the execution cache, rendering the trajectory executable. <!-- theme: info --> > #### NOTE > > Using the trajectory cache is an optional performance optimization. It is not necessary to use the cache to execute trajectories. The response contains the result of the validation of the trajectory. Validation can lead to three different results: - Fully valid: The whole trajectory can be executed from start to end. The response will contain an unique identifier which is used to move the robot. - Partially valid: Only parts of the trajectory can be executed. The response will contain an unique identifier to move the robot and information about the failure for the part that is not executable. - Invalid: The trajectory can not be executed. The response will tell you the reason of failure. If the trajectory is at least partially valid, the parts of the trajectory that are valid can be executed using the [executeTrajectory](executeTrajectory) endpoint. The workflow is as follows: - Generate a trajectory with [planTrajectory](planTrajectory) or your own motion planner, - Send the trajectory to this endpoint to validate it and get a unique identifier for it, - The unique identifier will appear in the list of available trajectories, see [listTrajectories](listTrajectories) endpoint, if it is at least partially executable. - Execute your trajectory using the [executeTrajectory](executeTrajectory) endpoint.
9688
9688
  * @summary Add Trajectory
9689
9689
  * @param {string} cell Unique identifier addressing a cell in all API calls.
9690
9690
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -9703,7 +9703,7 @@ declare const TrajectoryCachingApiFp: (configuration?: Configuration) => {
9703
9703
  */
9704
9704
  clearTrajectories(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
9705
9705
  /**
9706
- * Delete a previously created trajectory from cache. Use [listTrajectories](listTrajectories) to list all cached trajectories. Trajectories are removed automatically if the motion group or the corresponding controller is disconnected.
9706
+ * Delete a previously created trajectory from cache. Use [listTrajectories](listTrajectories) to list all cached trajectories. Trajectories are removed automatically if the motion group or the corresponding controller is disconnected.
9707
9707
  * @summary Delete Trajectory
9708
9708
  * @param {string} cell Unique identifier addressing a cell in all API calls.
9709
9709
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -9713,7 +9713,7 @@ declare const TrajectoryCachingApiFp: (configuration?: Configuration) => {
9713
9713
  */
9714
9714
  deleteTrajectory(cell: string, controller: string, trajectory: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
9715
9715
  /**
9716
- * Get a previously created trajectory from cache. Use [listTrajectories](listTrajectories) to list all cached trajectories.
9716
+ * Get a previously created trajectory from cache. Use [listTrajectories](listTrajectories) to list all cached trajectories.
9717
9717
  * @summary Get Trajectory
9718
9718
  * @param {string} cell Unique identifier addressing a cell in all API calls.
9719
9719
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -9723,7 +9723,7 @@ declare const TrajectoryCachingApiFp: (configuration?: Configuration) => {
9723
9723
  */
9724
9724
  getTrajectory(cell: string, controller: string, trajectory: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetTrajectoryResponse>>;
9725
9725
  /**
9726
- * List currently cached trajectories. Use [addTrajectory](addTrajectory) to add a new trajectory. Adding trajectories is necessary to execute them. Trajectories are removed if the corresponding motion group or controller disconnects.
9726
+ * List currently cached trajectories. Use [addTrajectory](addTrajectory) to add a new trajectory. Adding trajectories is necessary to execute them. Trajectories are removed if the corresponding motion group or controller disconnects.
9727
9727
  * @summary List Trajectories
9728
9728
  * @param {string} cell Unique identifier addressing a cell in all API calls.
9729
9729
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -9738,7 +9738,7 @@ declare const TrajectoryCachingApiFp: (configuration?: Configuration) => {
9738
9738
  */
9739
9739
  declare const TrajectoryCachingApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
9740
9740
  /**
9741
- * <!-- theme: info --> > Using the trajectory cache is an optional performance optimization. It is not necessary to use the cache to execute trajectories. Loads and validates the data of a trajectory into the execution cache, rendering the trajectory executable. The response contains the result of the validation of the trajectory. Validation can lead to three different results: - Fully valid: The whole trajectory can be executed from start to end. The response will contain an unique identifier which is used to move the robot. - Partially valid: Only parts of the trajectory can be executed. The response will contain an unique identifier to move the robot and information about the failure for the part that is not executable. - Invalid: The trajectory can not be executed. The response will tell you the reason of failure. If the trajectory is at least partially valid, the parts of the trajectory that are valid can be executed using the [executeTrajectory](executeTrajectory) endpoint. The workflow is as follows: - Generate a trajectory with [planTrajectory](planTrajectory) or your own motion planner, - Send the trajectory to this endpoint to validate it and get a unique identifier for it, - The unique identifier will appear in the list of available trajectories, see [listTrajectories](listTrajectories) endpoint, if it is at least partially executable. - Execute your trajectory using the [executeTrajectory](executeTrajectory) endpoint.
9741
+ * Loads and validates the data of a trajectory into the execution cache, rendering the trajectory executable. <!-- theme: info --> > #### NOTE > > Using the trajectory cache is an optional performance optimization. It is not necessary to use the cache to execute trajectories. The response contains the result of the validation of the trajectory. Validation can lead to three different results: - Fully valid: The whole trajectory can be executed from start to end. The response will contain an unique identifier which is used to move the robot. - Partially valid: Only parts of the trajectory can be executed. The response will contain an unique identifier to move the robot and information about the failure for the part that is not executable. - Invalid: The trajectory can not be executed. The response will tell you the reason of failure. If the trajectory is at least partially valid, the parts of the trajectory that are valid can be executed using the [executeTrajectory](executeTrajectory) endpoint. The workflow is as follows: - Generate a trajectory with [planTrajectory](planTrajectory) or your own motion planner, - Send the trajectory to this endpoint to validate it and get a unique identifier for it, - The unique identifier will appear in the list of available trajectories, see [listTrajectories](listTrajectories) endpoint, if it is at least partially executable. - Execute your trajectory using the [executeTrajectory](executeTrajectory) endpoint.
9742
9742
  * @summary Add Trajectory
9743
9743
  * @param {string} cell Unique identifier addressing a cell in all API calls.
9744
9744
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -9757,7 +9757,7 @@ declare const TrajectoryCachingApiFactory: (configuration?: Configuration, baseP
9757
9757
  */
9758
9758
  clearTrajectories(cell: string, controller: string, options?: RawAxiosRequestConfig): AxiosPromise<void>;
9759
9759
  /**
9760
- * Delete a previously created trajectory from cache. Use [listTrajectories](listTrajectories) to list all cached trajectories. Trajectories are removed automatically if the motion group or the corresponding controller is disconnected.
9760
+ * Delete a previously created trajectory from cache. Use [listTrajectories](listTrajectories) to list all cached trajectories. Trajectories are removed automatically if the motion group or the corresponding controller is disconnected.
9761
9761
  * @summary Delete Trajectory
9762
9762
  * @param {string} cell Unique identifier addressing a cell in all API calls.
9763
9763
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -9767,7 +9767,7 @@ declare const TrajectoryCachingApiFactory: (configuration?: Configuration, baseP
9767
9767
  */
9768
9768
  deleteTrajectory(cell: string, controller: string, trajectory: string, options?: RawAxiosRequestConfig): AxiosPromise<void>;
9769
9769
  /**
9770
- * Get a previously created trajectory from cache. Use [listTrajectories](listTrajectories) to list all cached trajectories.
9770
+ * Get a previously created trajectory from cache. Use [listTrajectories](listTrajectories) to list all cached trajectories.
9771
9771
  * @summary Get Trajectory
9772
9772
  * @param {string} cell Unique identifier addressing a cell in all API calls.
9773
9773
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -9777,7 +9777,7 @@ declare const TrajectoryCachingApiFactory: (configuration?: Configuration, baseP
9777
9777
  */
9778
9778
  getTrajectory(cell: string, controller: string, trajectory: string, options?: RawAxiosRequestConfig): AxiosPromise<GetTrajectoryResponse>;
9779
9779
  /**
9780
- * List currently cached trajectories. Use [addTrajectory](addTrajectory) to add a new trajectory. Adding trajectories is necessary to execute them. Trajectories are removed if the corresponding motion group or controller disconnects.
9780
+ * List currently cached trajectories. Use [addTrajectory](addTrajectory) to add a new trajectory. Adding trajectories is necessary to execute them. Trajectories are removed if the corresponding motion group or controller disconnects.
9781
9781
  * @summary List Trajectories
9782
9782
  * @param {string} cell Unique identifier addressing a cell in all API calls.
9783
9783
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -9794,7 +9794,7 @@ declare const TrajectoryCachingApiFactory: (configuration?: Configuration, baseP
9794
9794
  */
9795
9795
  declare class TrajectoryCachingApi extends BaseAPI {
9796
9796
  /**
9797
- * <!-- theme: info --> > Using the trajectory cache is an optional performance optimization. It is not necessary to use the cache to execute trajectories. Loads and validates the data of a trajectory into the execution cache, rendering the trajectory executable. The response contains the result of the validation of the trajectory. Validation can lead to three different results: - Fully valid: The whole trajectory can be executed from start to end. The response will contain an unique identifier which is used to move the robot. - Partially valid: Only parts of the trajectory can be executed. The response will contain an unique identifier to move the robot and information about the failure for the part that is not executable. - Invalid: The trajectory can not be executed. The response will tell you the reason of failure. If the trajectory is at least partially valid, the parts of the trajectory that are valid can be executed using the [executeTrajectory](executeTrajectory) endpoint. The workflow is as follows: - Generate a trajectory with [planTrajectory](planTrajectory) or your own motion planner, - Send the trajectory to this endpoint to validate it and get a unique identifier for it, - The unique identifier will appear in the list of available trajectories, see [listTrajectories](listTrajectories) endpoint, if it is at least partially executable. - Execute your trajectory using the [executeTrajectory](executeTrajectory) endpoint.
9797
+ * Loads and validates the data of a trajectory into the execution cache, rendering the trajectory executable. <!-- theme: info --> > #### NOTE > > Using the trajectory cache is an optional performance optimization. It is not necessary to use the cache to execute trajectories. The response contains the result of the validation of the trajectory. Validation can lead to three different results: - Fully valid: The whole trajectory can be executed from start to end. The response will contain an unique identifier which is used to move the robot. - Partially valid: Only parts of the trajectory can be executed. The response will contain an unique identifier to move the robot and information about the failure for the part that is not executable. - Invalid: The trajectory can not be executed. The response will tell you the reason of failure. If the trajectory is at least partially valid, the parts of the trajectory that are valid can be executed using the [executeTrajectory](executeTrajectory) endpoint. The workflow is as follows: - Generate a trajectory with [planTrajectory](planTrajectory) or your own motion planner, - Send the trajectory to this endpoint to validate it and get a unique identifier for it, - The unique identifier will appear in the list of available trajectories, see [listTrajectories](listTrajectories) endpoint, if it is at least partially executable. - Execute your trajectory using the [executeTrajectory](executeTrajectory) endpoint.
9798
9798
  * @summary Add Trajectory
9799
9799
  * @param {string} cell Unique identifier addressing a cell in all API calls.
9800
9800
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -9815,7 +9815,7 @@ declare class TrajectoryCachingApi extends BaseAPI {
9815
9815
  */
9816
9816
  clearTrajectories(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
9817
9817
  /**
9818
- * Delete a previously created trajectory from cache. Use [listTrajectories](listTrajectories) to list all cached trajectories. Trajectories are removed automatically if the motion group or the corresponding controller is disconnected.
9818
+ * Delete a previously created trajectory from cache. Use [listTrajectories](listTrajectories) to list all cached trajectories. Trajectories are removed automatically if the motion group or the corresponding controller is disconnected.
9819
9819
  * @summary Delete Trajectory
9820
9820
  * @param {string} cell Unique identifier addressing a cell in all API calls.
9821
9821
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -9826,7 +9826,7 @@ declare class TrajectoryCachingApi extends BaseAPI {
9826
9826
  */
9827
9827
  deleteTrajectory(cell: string, controller: string, trajectory: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
9828
9828
  /**
9829
- * Get a previously created trajectory from cache. Use [listTrajectories](listTrajectories) to list all cached trajectories.
9829
+ * Get a previously created trajectory from cache. Use [listTrajectories](listTrajectories) to list all cached trajectories.
9830
9830
  * @summary Get Trajectory
9831
9831
  * @param {string} cell Unique identifier addressing a cell in all API calls.
9832
9832
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -9837,7 +9837,7 @@ declare class TrajectoryCachingApi extends BaseAPI {
9837
9837
  */
9838
9838
  getTrajectory(cell: string, controller: string, trajectory: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<GetTrajectoryResponse, any>>;
9839
9839
  /**
9840
- * List currently cached trajectories. Use [addTrajectory](addTrajectory) to add a new trajectory. Adding trajectories is necessary to execute them. Trajectories are removed if the corresponding motion group or controller disconnects.
9840
+ * List currently cached trajectories. Use [addTrajectory](addTrajectory) to add a new trajectory. Adding trajectories is necessary to execute them. Trajectories are removed if the corresponding motion group or controller disconnects.
9841
9841
  * @summary List Trajectories
9842
9842
  * @param {string} cell Unique identifier addressing a cell in all API calls.
9843
9843
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -9853,7 +9853,7 @@ declare class TrajectoryCachingApi extends BaseAPI {
9853
9853
  */
9854
9854
  declare const TrajectoryExecutionApiAxiosParamCreator: (configuration?: Configuration) => {
9855
9855
  /**
9856
- * <!-- theme: danger --> > Websocket endpoint Provides execution control over a previously planned trajectory. Enables the caller to attach input/output 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. - Use [executeToTrajectory](executeToTrajectory) to move the robot to the start location. ### Requests #### 1. Send InitializeMovementRequest to lock the trajectory to this connection The following actions are executed: - Sets robot controller mode to control mode, - Sets start location of the execution Keep in mind that only a single trajectory can be locked to a websocket connection at a time and not unlocked anymore. To execute another trajectory, a new connection must be established. #### 2. Send StartMovementRequest to start the movement Sets direction of movement, default is forward. #### **Optional** - To pause, send PauseMovementRequest before the movement has reached its end location. - Change the movement\'s velocity with PlaybackSpeedRequest after initializing the movement with InitializeMovementRequest. ### Responses - InitializeMovementResponse is sent to signal the success or failure of the InitializeMovementRequest. - Movement responses are streamed after a StartMovementRequest successfully started the movement. Movement responses are streamed in a rate that is defined as the multiple of the controller step-rate closest to but not exceeding the rate configured by InitializeMovementRequest. - Standstill 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.
9856
+ * <!-- theme: success --> > Websocket endpoint Provides execution control over a previously [planned trajectory](planTrajectory). Enables the caller to attach input/output actions to the trajectory. ### Movement behavior | Virtual controller | Physical controller | |------------------|-------------------| | Desired joint configurations are commanded to each motion group and **applied immediately** | Move to desired **actual joint configuration**, **if possible** | ### Concept of location - The location or path parameter specifies the exact position along a trajectory. - The location is a scalar value that ranges from 0 to `n`, where `n` denotes the number of motion commands, or trajectory segments, e.g., line, p2p, etc. See [planTrajectory](planTrajectory). - Each integer value of the location corresponds to one motion command, e.g., 3.0 to 3.999 could be a line. ### Preconditions - The motion group\'s control mode is not claimed by any other endpoint. - The motion group\'s joint position are at start location specified with `InitializeMovementRequest`. - Use [executeToTrajectory](executeToTrajectory) to move the robot to the start location. ### Requests #### 1. Send `InitializeMovementRequest` to lock the trajectory to this connection The following actions are executed: - Sets robot controller mode to control mode, - Sets start location of the execution Keep in mind that only a single trajectory can be locked to a websocket connection at a time and not unlocked anymore. To execute another trajectory, a new connection must be established. #### 2. Send `StartMovementRequest` to start the movement Sets direction of movement, default is forward. #### **Optional** - To pause, send `PauseMovementRequest` before the movement has reached its end location. - Change the movement\'s velocity with `PlaybackSpeedRequest` after initializing the movement with `InitializeMovementRequest`. ### Responses - `InitializeMovementResponse` is sent to signal the success or failure of the `InitializeMovementRequest`. - Movement responses are streamed after a `StartMovementRequest` successfully started the movement. Movement responses are streamed in a rate that is defined as the multiple of the controller step-rate closest to but not exceeding the rate configured by `InitializeMovementRequest`. - Standstill response is sent once the movement has finished or has come to a standstill due to a pause. - `PauseMovementResponse` is sent to signal the success of the `PauseMovementRequest`. It does not signal the end of the movement. End of movement is signaled by Standstill response. - `PlaybackSpeedResponse` is sent to signal the success of the `PlaybackSpeedRequest`. - `MovementError` with error details is sent in case of an unexpected error, e.g., controller disconnects during movement. ### Tips and Tricks - A movement can be paused and resumed by sending `PauseMovementRequest` and `StartMovementRequest`. - Send `PlaybackSpeedRequest` before `StartMovementRequest` to reduce the velocity of the movement before it starts. - Send `PlaybackSpeedRequest` repeatedly to implement a slider. The velocity of the motion group can be adjusted with each controller step. Therefore, if your app needs a slider-like UI to alter the velocity of a currently running movement, you can send `PlaybackSpeedRequest` with different speed values repeatedly during the movement. - A closed trajectory (end and start joint position are equal) can be repeated by sending `StartMovementRequest` after the movement has finished.
9857
9857
  * @summary Execute Trajectory
9858
9858
  * @param {string} cell Unique identifier addressing a cell in all API calls.
9859
9859
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -9869,7 +9869,7 @@ declare const TrajectoryExecutionApiAxiosParamCreator: (configuration?: Configur
9869
9869
  */
9870
9870
  declare const TrajectoryExecutionApiFp: (configuration?: Configuration) => {
9871
9871
  /**
9872
- * <!-- theme: danger --> > Websocket endpoint Provides execution control over a previously planned trajectory. Enables the caller to attach input/output 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. - Use [executeToTrajectory](executeToTrajectory) to move the robot to the start location. ### Requests #### 1. Send InitializeMovementRequest to lock the trajectory to this connection The following actions are executed: - Sets robot controller mode to control mode, - Sets start location of the execution Keep in mind that only a single trajectory can be locked to a websocket connection at a time and not unlocked anymore. To execute another trajectory, a new connection must be established. #### 2. Send StartMovementRequest to start the movement Sets direction of movement, default is forward. #### **Optional** - To pause, send PauseMovementRequest before the movement has reached its end location. - Change the movement\'s velocity with PlaybackSpeedRequest after initializing the movement with InitializeMovementRequest. ### Responses - InitializeMovementResponse is sent to signal the success or failure of the InitializeMovementRequest. - Movement responses are streamed after a StartMovementRequest successfully started the movement. Movement responses are streamed in a rate that is defined as the multiple of the controller step-rate closest to but not exceeding the rate configured by InitializeMovementRequest. - Standstill 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.
9872
+ * <!-- theme: success --> > Websocket endpoint Provides execution control over a previously [planned trajectory](planTrajectory). Enables the caller to attach input/output actions to the trajectory. ### Movement behavior | Virtual controller | Physical controller | |------------------|-------------------| | Desired joint configurations are commanded to each motion group and **applied immediately** | Move to desired **actual joint configuration**, **if possible** | ### Concept of location - The location or path parameter specifies the exact position along a trajectory. - The location is a scalar value that ranges from 0 to `n`, where `n` denotes the number of motion commands, or trajectory segments, e.g., line, p2p, etc. See [planTrajectory](planTrajectory). - Each integer value of the location corresponds to one motion command, e.g., 3.0 to 3.999 could be a line. ### Preconditions - The motion group\'s control mode is not claimed by any other endpoint. - The motion group\'s joint position are at start location specified with `InitializeMovementRequest`. - Use [executeToTrajectory](executeToTrajectory) to move the robot to the start location. ### Requests #### 1. Send `InitializeMovementRequest` to lock the trajectory to this connection The following actions are executed: - Sets robot controller mode to control mode, - Sets start location of the execution Keep in mind that only a single trajectory can be locked to a websocket connection at a time and not unlocked anymore. To execute another trajectory, a new connection must be established. #### 2. Send `StartMovementRequest` to start the movement Sets direction of movement, default is forward. #### **Optional** - To pause, send `PauseMovementRequest` before the movement has reached its end location. - Change the movement\'s velocity with `PlaybackSpeedRequest` after initializing the movement with `InitializeMovementRequest`. ### Responses - `InitializeMovementResponse` is sent to signal the success or failure of the `InitializeMovementRequest`. - Movement responses are streamed after a `StartMovementRequest` successfully started the movement. Movement responses are streamed in a rate that is defined as the multiple of the controller step-rate closest to but not exceeding the rate configured by `InitializeMovementRequest`. - Standstill response is sent once the movement has finished or has come to a standstill due to a pause. - `PauseMovementResponse` is sent to signal the success of the `PauseMovementRequest`. It does not signal the end of the movement. End of movement is signaled by Standstill response. - `PlaybackSpeedResponse` is sent to signal the success of the `PlaybackSpeedRequest`. - `MovementError` with error details is sent in case of an unexpected error, e.g., controller disconnects during movement. ### Tips and Tricks - A movement can be paused and resumed by sending `PauseMovementRequest` and `StartMovementRequest`. - Send `PlaybackSpeedRequest` before `StartMovementRequest` to reduce the velocity of the movement before it starts. - Send `PlaybackSpeedRequest` repeatedly to implement a slider. The velocity of the motion group can be adjusted with each controller step. Therefore, if your app needs a slider-like UI to alter the velocity of a currently running movement, you can send `PlaybackSpeedRequest` with different speed values repeatedly during the movement. - A closed trajectory (end and start joint position are equal) can be repeated by sending `StartMovementRequest` after the movement has finished.
9873
9873
  * @summary Execute Trajectory
9874
9874
  * @param {string} cell Unique identifier addressing a cell in all API calls.
9875
9875
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -9885,7 +9885,7 @@ declare const TrajectoryExecutionApiFp: (configuration?: Configuration) => {
9885
9885
  */
9886
9886
  declare const TrajectoryExecutionApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
9887
9887
  /**
9888
- * <!-- theme: danger --> > Websocket endpoint Provides execution control over a previously planned trajectory. Enables the caller to attach input/output 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. - Use [executeToTrajectory](executeToTrajectory) to move the robot to the start location. ### Requests #### 1. Send InitializeMovementRequest to lock the trajectory to this connection The following actions are executed: - Sets robot controller mode to control mode, - Sets start location of the execution Keep in mind that only a single trajectory can be locked to a websocket connection at a time and not unlocked anymore. To execute another trajectory, a new connection must be established. #### 2. Send StartMovementRequest to start the movement Sets direction of movement, default is forward. #### **Optional** - To pause, send PauseMovementRequest before the movement has reached its end location. - Change the movement\'s velocity with PlaybackSpeedRequest after initializing the movement with InitializeMovementRequest. ### Responses - InitializeMovementResponse is sent to signal the success or failure of the InitializeMovementRequest. - Movement responses are streamed after a StartMovementRequest successfully started the movement. Movement responses are streamed in a rate that is defined as the multiple of the controller step-rate closest to but not exceeding the rate configured by InitializeMovementRequest. - Standstill 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.
9888
+ * <!-- theme: success --> > Websocket endpoint Provides execution control over a previously [planned trajectory](planTrajectory). Enables the caller to attach input/output actions to the trajectory. ### Movement behavior | Virtual controller | Physical controller | |------------------|-------------------| | Desired joint configurations are commanded to each motion group and **applied immediately** | Move to desired **actual joint configuration**, **if possible** | ### Concept of location - The location or path parameter specifies the exact position along a trajectory. - The location is a scalar value that ranges from 0 to `n`, where `n` denotes the number of motion commands, or trajectory segments, e.g., line, p2p, etc. See [planTrajectory](planTrajectory). - Each integer value of the location corresponds to one motion command, e.g., 3.0 to 3.999 could be a line. ### Preconditions - The motion group\'s control mode is not claimed by any other endpoint. - The motion group\'s joint position are at start location specified with `InitializeMovementRequest`. - Use [executeToTrajectory](executeToTrajectory) to move the robot to the start location. ### Requests #### 1. Send `InitializeMovementRequest` to lock the trajectory to this connection The following actions are executed: - Sets robot controller mode to control mode, - Sets start location of the execution Keep in mind that only a single trajectory can be locked to a websocket connection at a time and not unlocked anymore. To execute another trajectory, a new connection must be established. #### 2. Send `StartMovementRequest` to start the movement Sets direction of movement, default is forward. #### **Optional** - To pause, send `PauseMovementRequest` before the movement has reached its end location. - Change the movement\'s velocity with `PlaybackSpeedRequest` after initializing the movement with `InitializeMovementRequest`. ### Responses - `InitializeMovementResponse` is sent to signal the success or failure of the `InitializeMovementRequest`. - Movement responses are streamed after a `StartMovementRequest` successfully started the movement. Movement responses are streamed in a rate that is defined as the multiple of the controller step-rate closest to but not exceeding the rate configured by `InitializeMovementRequest`. - Standstill response is sent once the movement has finished or has come to a standstill due to a pause. - `PauseMovementResponse` is sent to signal the success of the `PauseMovementRequest`. It does not signal the end of the movement. End of movement is signaled by Standstill response. - `PlaybackSpeedResponse` is sent to signal the success of the `PlaybackSpeedRequest`. - `MovementError` with error details is sent in case of an unexpected error, e.g., controller disconnects during movement. ### Tips and Tricks - A movement can be paused and resumed by sending `PauseMovementRequest` and `StartMovementRequest`. - Send `PlaybackSpeedRequest` before `StartMovementRequest` to reduce the velocity of the movement before it starts. - Send `PlaybackSpeedRequest` repeatedly to implement a slider. The velocity of the motion group can be adjusted with each controller step. Therefore, if your app needs a slider-like UI to alter the velocity of a currently running movement, you can send `PlaybackSpeedRequest` with different speed values repeatedly during the movement. - A closed trajectory (end and start joint position are equal) can be repeated by sending `StartMovementRequest` after the movement has finished.
9889
9889
  * @summary Execute Trajectory
9890
9890
  * @param {string} cell Unique identifier addressing a cell in all API calls.
9891
9891
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -9903,7 +9903,7 @@ declare const TrajectoryExecutionApiFactory: (configuration?: Configuration, bas
9903
9903
  */
9904
9904
  declare class TrajectoryExecutionApi extends BaseAPI {
9905
9905
  /**
9906
- * <!-- theme: danger --> > Websocket endpoint Provides execution control over a previously planned trajectory. Enables the caller to attach input/output 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. - Use [executeToTrajectory](executeToTrajectory) to move the robot to the start location. ### Requests #### 1. Send InitializeMovementRequest to lock the trajectory to this connection The following actions are executed: - Sets robot controller mode to control mode, - Sets start location of the execution Keep in mind that only a single trajectory can be locked to a websocket connection at a time and not unlocked anymore. To execute another trajectory, a new connection must be established. #### 2. Send StartMovementRequest to start the movement Sets direction of movement, default is forward. #### **Optional** - To pause, send PauseMovementRequest before the movement has reached its end location. - Change the movement\'s velocity with PlaybackSpeedRequest after initializing the movement with InitializeMovementRequest. ### Responses - InitializeMovementResponse is sent to signal the success or failure of the InitializeMovementRequest. - Movement responses are streamed after a StartMovementRequest successfully started the movement. Movement responses are streamed in a rate that is defined as the multiple of the controller step-rate closest to but not exceeding the rate configured by InitializeMovementRequest. - Standstill 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.
9906
+ * <!-- theme: success --> > Websocket endpoint Provides execution control over a previously [planned trajectory](planTrajectory). Enables the caller to attach input/output actions to the trajectory. ### Movement behavior | Virtual controller | Physical controller | |------------------|-------------------| | Desired joint configurations are commanded to each motion group and **applied immediately** | Move to desired **actual joint configuration**, **if possible** | ### Concept of location - The location or path parameter specifies the exact position along a trajectory. - The location is a scalar value that ranges from 0 to `n`, where `n` denotes the number of motion commands, or trajectory segments, e.g., line, p2p, etc. See [planTrajectory](planTrajectory). - Each integer value of the location corresponds to one motion command, e.g., 3.0 to 3.999 could be a line. ### Preconditions - The motion group\'s control mode is not claimed by any other endpoint. - The motion group\'s joint position are at start location specified with `InitializeMovementRequest`. - Use [executeToTrajectory](executeToTrajectory) to move the robot to the start location. ### Requests #### 1. Send `InitializeMovementRequest` to lock the trajectory to this connection The following actions are executed: - Sets robot controller mode to control mode, - Sets start location of the execution Keep in mind that only a single trajectory can be locked to a websocket connection at a time and not unlocked anymore. To execute another trajectory, a new connection must be established. #### 2. Send `StartMovementRequest` to start the movement Sets direction of movement, default is forward. #### **Optional** - To pause, send `PauseMovementRequest` before the movement has reached its end location. - Change the movement\'s velocity with `PlaybackSpeedRequest` after initializing the movement with `InitializeMovementRequest`. ### Responses - `InitializeMovementResponse` is sent to signal the success or failure of the `InitializeMovementRequest`. - Movement responses are streamed after a `StartMovementRequest` successfully started the movement. Movement responses are streamed in a rate that is defined as the multiple of the controller step-rate closest to but not exceeding the rate configured by `InitializeMovementRequest`. - Standstill response is sent once the movement has finished or has come to a standstill due to a pause. - `PauseMovementResponse` is sent to signal the success of the `PauseMovementRequest`. It does not signal the end of the movement. End of movement is signaled by Standstill response. - `PlaybackSpeedResponse` is sent to signal the success of the `PlaybackSpeedRequest`. - `MovementError` with error details is sent in case of an unexpected error, e.g., controller disconnects during movement. ### Tips and Tricks - A movement can be paused and resumed by sending `PauseMovementRequest` and `StartMovementRequest`. - Send `PlaybackSpeedRequest` before `StartMovementRequest` to reduce the velocity of the movement before it starts. - Send `PlaybackSpeedRequest` repeatedly to implement a slider. The velocity of the motion group can be adjusted with each controller step. Therefore, if your app needs a slider-like UI to alter the velocity of a currently running movement, you can send `PlaybackSpeedRequest` with different speed values repeatedly during the movement. - A closed trajectory (end and start joint position are equal) can be repeated by sending `StartMovementRequest` after the movement has finished.
9907
9907
  * @summary Execute Trajectory
9908
9908
  * @param {string} cell Unique identifier addressing a cell in all API calls.
9909
9909
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -9929,7 +9929,7 @@ declare const TrajectoryPlanningApiAxiosParamCreator: (configuration?: Configura
9929
9929
  */
9930
9930
  planCollisionFree: (cell: string, planCollisionFreeRequest?: PlanCollisionFreeRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
9931
9931
  /**
9932
- * 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. Optional: Load the planned trajectory into the cache using the [addTrajectory](addTrajectory) endpoint. 3. Execute the (cached) trajectory using the [executeTrajectory](executeTrajectory) 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.
9932
+ * 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. Optional: Load the planned trajectory into the cache using the [addTrajectory](addTrajectory) endpoint. 3. Execute the (cached) trajectory using the [executeTrajectory](executeTrajectory) endpoint. If the trajectory is not executable, the response will contain the joint trajectory up until the error, e.g., all samples until a collision occurs. <!-- theme: info --> > #### 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.
9933
9933
  * @summary Plan Trajectory
9934
9934
  * @param {string} cell Unique identifier addressing a cell in all API calls.
9935
9935
  * @param {PlanTrajectoryRequest} [planTrajectoryRequest]
@@ -9953,7 +9953,7 @@ declare const TrajectoryPlanningApiFp: (configuration?: Configuration) => {
9953
9953
  */
9954
9954
  planCollisionFree(cell: string, planCollisionFreeRequest?: PlanCollisionFreeRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PlanCollisionFreeResponse>>;
9955
9955
  /**
9956
- * 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. Optional: Load the planned trajectory into the cache using the [addTrajectory](addTrajectory) endpoint. 3. Execute the (cached) trajectory using the [executeTrajectory](executeTrajectory) 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.
9956
+ * 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. Optional: Load the planned trajectory into the cache using the [addTrajectory](addTrajectory) endpoint. 3. Execute the (cached) trajectory using the [executeTrajectory](executeTrajectory) endpoint. If the trajectory is not executable, the response will contain the joint trajectory up until the error, e.g., all samples until a collision occurs. <!-- theme: info --> > #### 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.
9957
9957
  * @summary Plan Trajectory
9958
9958
  * @param {string} cell Unique identifier addressing a cell in all API calls.
9959
9959
  * @param {PlanTrajectoryRequest} [planTrajectoryRequest]
@@ -9977,7 +9977,7 @@ declare const TrajectoryPlanningApiFactory: (configuration?: Configuration, base
9977
9977
  */
9978
9978
  planCollisionFree(cell: string, planCollisionFreeRequest?: PlanCollisionFreeRequest, options?: RawAxiosRequestConfig): AxiosPromise<PlanCollisionFreeResponse>;
9979
9979
  /**
9980
- * 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. Optional: Load the planned trajectory into the cache using the [addTrajectory](addTrajectory) endpoint. 3. Execute the (cached) trajectory using the [executeTrajectory](executeTrajectory) 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.
9980
+ * 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. Optional: Load the planned trajectory into the cache using the [addTrajectory](addTrajectory) endpoint. 3. Execute the (cached) trajectory using the [executeTrajectory](executeTrajectory) endpoint. If the trajectory is not executable, the response will contain the joint trajectory up until the error, e.g., all samples until a collision occurs. <!-- theme: info --> > #### 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.
9981
9981
  * @summary Plan Trajectory
9982
9982
  * @param {string} cell Unique identifier addressing a cell in all API calls.
9983
9983
  * @param {PlanTrajectoryRequest} [planTrajectoryRequest]
@@ -10004,7 +10004,7 @@ declare class TrajectoryPlanningApi extends BaseAPI {
10004
10004
  */
10005
10005
  planCollisionFree(cell: string, planCollisionFreeRequest?: PlanCollisionFreeRequest, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<PlanCollisionFreeResponse, any>>;
10006
10006
  /**
10007
- * 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. Optional: Load the planned trajectory into the cache using the [addTrajectory](addTrajectory) endpoint. 3. Execute the (cached) trajectory using the [executeTrajectory](executeTrajectory) 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.
10007
+ * 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. Optional: Load the planned trajectory into the cache using the [addTrajectory](addTrajectory) endpoint. 3. Execute the (cached) trajectory using the [executeTrajectory](executeTrajectory) endpoint. If the trajectory is not executable, the response will contain the joint trajectory up until the error, e.g., all samples until a collision occurs. <!-- theme: info --> > #### 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.
10008
10008
  * @summary Plan Trajectory
10009
10009
  * @param {string} cell Unique identifier addressing a cell in all API calls.
10010
10010
  * @param {PlanTrajectoryRequest} [planTrajectoryRequest]
@@ -10020,7 +10020,7 @@ declare class TrajectoryPlanningApi extends BaseAPI {
10020
10020
  */
10021
10021
  declare const VirtualControllerApiAxiosParamCreator: (configuration?: Configuration) => {
10022
10022
  /**
10023
- * Adds a coordinate system to the robot controller. **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 available for visualization or program execution.
10023
+ * Adds a coordinate system to the robot controller. <!-- theme: info --> > #### NOTE > > When a new coordinate system is added, the **virtual robot is restarted** to apply the new configuration. > > During this restart: > - Robot visualization can temporarily disappear or appear outdated in the UI. > - Coordinate system changes are not immediately visible in visualizations. > - All connections to 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 available for visualization or program execution.
10024
10024
  * @summary Add Coordinate Systems
10025
10025
  * @param {string} cell Unique identifier addressing a cell in all API calls.
10026
10026
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -10031,7 +10031,7 @@ declare const VirtualControllerApiAxiosParamCreator: (configuration?: Configurat
10031
10031
  */
10032
10032
  addVirtualControllerCoordinateSystem: (cell: string, controller: string, coordinateSystem: string, coordinateSystemData: CoordinateSystemData, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
10033
10033
  /**
10034
- * Adds a new TCP (Tool Center Point) 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. **Important notes:** - Adding or updating a TCP triggers a **virtual robot restart** to apply the new configuration. - During this restart: - The robot visualization in the UI may temporarily disappear. - The TCP visualization may not immediately appear, or may look outdated during the first test/rerun. - All active connections to the virtual robot are closed and then re-established. This creates a delay before the TCP is available in both the UI and robot programs. - The API call itself does **not wait until the restart and synchronization are complete**. Even if the request succeeds, the new or updated TCP may not yet be visible in the GUI or available for use.
10034
+ * Adds a new 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. <!-- theme: info --> > #### NOTE > > When adding or updating a TCP, the **virtual robot is restarted** to apply the new configuration. > > During this restart: > - Robot visualization can temporarily disappear. > - The TCP may not be immediately visible or appear outdated in visualizations. > - All connections to virtual robot are closed and re-established, which introduces a short delay before the TCP is available for operation. > > The API call itself does **not wait until the restart and re-synchronization are complete**. > A successful response indicates that the request was accepted, but the TCP may not yet be visible nor usable.
10035
10035
  * @summary Add TCP
10036
10036
  * @param {string} cell Unique identifier addressing a cell in all API calls.
10037
10037
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -10043,7 +10043,7 @@ declare const VirtualControllerApiAxiosParamCreator: (configuration?: Configurat
10043
10043
  */
10044
10044
  addVirtualControllerTcp: (cell: string, controller: string, motionGroup: string, tcp: string, robotTcpData: RobotTcpData, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
10045
10045
  /**
10046
- * 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 that use the deleted coordinate system as 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 available for visualization or program execution.
10046
+ * 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 that use the deleted coordinate system as reference. <!-- theme: info --> > #### NOTE > > When a new coordinate system is removed, the **virtual robot is restarted** to apply the new configuration. > > During this restart: > - Robot visualization can temporarily disappear or appear outdated in the UI. > - Coordinate system changes are not immediately visible in visualizations. > - All connections to 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 available for visualization or program execution.
10047
10047
  * @summary Delete Coordinate System
10048
10048
  * @param {string} cell Unique identifier addressing a cell in all API calls.
10049
10049
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -10054,7 +10054,7 @@ declare const VirtualControllerApiAxiosParamCreator: (configuration?: Configurat
10054
10054
  */
10055
10055
  deleteVirtualControllerCoordinateSystem: (cell: string, controller: string, coordinateSystem: string, deleteDependent?: boolean, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
10056
10056
  /**
10057
- * Removes the TCP (Tool Center Point) from the motion group. An unknown TCP is a valid input and will simply be ignored. **Important notes:** - Removing or updating a TCP triggers a **virtual robot restart** to apply the new configuration. - During this restart: - The robot visualization in the UI may temporarily disappear. - The TCP visualization may not immediately appear, or may look outdated during the first test/rerun. - All active connections to the virtual robot are closed and then re-established. This creates a delay before the TCP is available in both the UI and robot programs. - The API call itself does **not wait until the restart and synchronization are complete**. Even if the request succeeds, the new or updated TCP may not yet be visible in the GUI or available for use.
10057
+ * Removes the TCP (Tool Center Point) from the motion group. An unknown TCP is a valid input and will simply be ignored. <!-- theme: info --> > #### NOTE > > When removing a TCP, the **virtual robot is restarted** to apply the new configuration. > > During this restart: > - Robot visualization can temporarily disappear. > - The removal of the TCP may not be immediately visible or appear outdated in visualizations. > - All connections to 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**. > A successful response indicates that the request was accepted, but the then used TCP may not yet be visible nor usable.
10058
10058
  * @summary Remove TCP
10059
10059
  * @param {string} cell Unique identifier addressing a cell in all API calls.
10060
10060
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -10065,7 +10065,7 @@ declare const VirtualControllerApiAxiosParamCreator: (configuration?: Configurat
10065
10065
  */
10066
10066
  deleteVirtualControllerTcp: (cell: string, controller: string, motionGroup: string, tcp: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
10067
10067
  /**
10068
- * 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.
10068
+ * Requests the Emergency Stop state of the virtual robot controller. Use [getCurrentMotionGroupState](getCurrentMotionGroupState) to get the Emergency Stop state with `safety_state` regardless of the controller type. > **NOTE** > > The Emergency Stop state can only be changed when using virtual robot controllers.
10069
10069
  * @summary Get Emergency Stop State
10070
10070
  * @param {string} cell Unique identifier addressing a cell in all API calls.
10071
10071
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -10093,7 +10093,7 @@ declare const VirtualControllerApiAxiosParamCreator: (configuration?: Configurat
10093
10093
  */
10094
10094
  getMotionGroups: (cell: string, controller: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
10095
10095
  /**
10096
- * 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.
10096
+ * Requests the operation mode of the virtual robot controller. To get the operation mode regardless of the controller type, use [getCurrentMotionGroupState](getCurrentMotionGroupState). > **NOTE** > > The operation mode can only be changed via API when using virtual robot controllers.
10097
10097
  * @summary Get Operation Mode
10098
10098
  * @param {string} cell Unique identifier addressing a cell in all API calls.
10099
10099
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -10102,7 +10102,7 @@ declare const VirtualControllerApiAxiosParamCreator: (configuration?: Configurat
10102
10102
  */
10103
10103
  getOperationMode: (cell: string, controller: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
10104
10104
  /**
10105
- * Gets motion group mounting. The motion group is based on the origin of the returned coordinate system.
10105
+ * Gets motion group mounting. The motion group is based on the origin of the returned coordinate system.
10106
10106
  * @summary Get Mounting
10107
10107
  * @param {string} cell Unique identifier addressing a cell in all API calls.
10108
10108
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -10121,7 +10121,7 @@ declare const VirtualControllerApiAxiosParamCreator: (configuration?: Configurat
10121
10121
  */
10122
10122
  listVirtualControllerCoordinateSystems: (cell: string, controller: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
10123
10123
  /**
10124
- * Lists TCPs of the motion group. An empty TCP list is valid, for example for external axes.
10124
+ * Lists TCPs of the motion group. An empty TCP list is valid, e.g., for external axes.
10125
10125
  * @summary List TCPs
10126
10126
  * @param {string} cell Unique identifier addressing a cell in all API calls.
10127
10127
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -10131,7 +10131,7 @@ declare const VirtualControllerApiAxiosParamCreator: (configuration?: Configurat
10131
10131
  */
10132
10132
  listVirtualControllerTcps: (cell: string, controller: string, motionGroup: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
10133
10133
  /**
10134
- * Activates or releases the Emergency Stop on the virtual robot controller. Activating the Emergency Stop stops the execution of all motions. The stop is executed on physical controllers immediately not gracefully and not on paths. Due to restricted physical behavior of the virtual robot controller, the Emergency Stop is executed on paths. 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.
10134
+ * Activates or releases the Emergency Stop on the virtual robot controller. Activating the Emergency Stop stops the execution of all motions. The stop is executed on physical controllers immediately not gracefully and not on paths. Due to restricted physical behavior of the virtual robot controller, the Emergency Stop is executed on paths. To return to normal operation the Emergency Stop needs to be released. Use [getCurrentMotionGroupState](getCurrentMotionGroupState) to get the Emergency Stop state with `safety_state` regardless of the controller type. > **NOTE** > > The Emergency Stop state can only be changed via API when using virtual robot controllers.
10135
10135
  * @summary Push or Release Emergency Stop
10136
10136
  * @param {string} cell Unique identifier addressing a cell in all API calls.
10137
10137
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -10141,7 +10141,7 @@ declare const VirtualControllerApiAxiosParamCreator: (configuration?: Configurat
10141
10141
  */
10142
10142
  setEmergencyStop: (cell: string, controller: string, active?: boolean, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
10143
10143
  /**
10144
- * 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.
10144
+ * 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. <!-- theme: info --> > #### NOTE > > Only use the endpoint when the motion group is in monitor mode. If the motion group is controlled, currently jogging or planning motions, > the values are overridden by the controller or an error may occur.
10145
10145
  * @summary Set Motion Group State
10146
10146
  * @param {string} cell Unique identifier addressing a cell in all API calls.
10147
10147
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -10152,7 +10152,7 @@ declare const VirtualControllerApiAxiosParamCreator: (configuration?: Configurat
10152
10152
  */
10153
10153
  setMotionGroupState: (cell: string, controller: string, motionGroup: string, motionGroupJoints: MotionGroupJoints, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
10154
10154
  /**
10155
- * 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.
10155
+ * 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 operation mode can only be changed via API when using virtual robot controllers.
10156
10156
  * @summary Set Operation Mode
10157
10157
  * @param {string} cell Unique identifier addressing a cell in all API calls.
10158
10158
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -10162,7 +10162,7 @@ declare const VirtualControllerApiAxiosParamCreator: (configuration?: Configurat
10162
10162
  */
10163
10163
  setOperationMode: (cell: string, controller: string, mode: OperationMode, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
10164
10164
  /**
10165
- * 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 user-facing name - An offset in another coordinate system, referenced by the unique identifier of the reference coordinate system. **Important notes:** - Changing the mounting configuration is treated as a setup change. - When the mounting is set to a new coordinate system, the **virtual robot restarts** in the background to apply the new configuration. - During this process: - Robot visualization may temporarily disappear or not reflect the new mounting immediately. - Motion group state and coordinate system alignment may not be instantly updated in the UI. - All connections to the virtual robot are closed and then re-established, which can cause a short delay before the system is ready again. - The API call itself does **not wait until the restart and synchronization are complete**. A successful response indicates that the request was accepted, but the updated mounting may not yet be visible.
10165
+ * 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 user-facing name - An offset in another coordinate system, referenced by the unique identifier of the reference coordinate system. <!-- theme: info --> > #### Changing the mounting configuration is considered a setup change > > When the mounting is set to a new coordinate system, the **virtual robot is restarted** to apply the new configuration. > > During this restart: > - Robot visualization can temporarily disappear or not reflect the new mounting immediately. > - Motion group state and coordinate system alignment may not be immediately visible in visualizations. > - All connections to 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**. > A successful response indicates that the request was accepted, but the updated mounting may not yet be visible.
10166
10166
  * @summary Set Mounting
10167
10167
  * @param {string} cell Unique identifier addressing a cell in all API calls.
10168
10168
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -10179,7 +10179,7 @@ declare const VirtualControllerApiAxiosParamCreator: (configuration?: Configurat
10179
10179
  */
10180
10180
  declare const VirtualControllerApiFp: (configuration?: Configuration) => {
10181
10181
  /**
10182
- * Adds a coordinate system to the robot controller. **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 available for visualization or program execution.
10182
+ * Adds a coordinate system to the robot controller. <!-- theme: info --> > #### NOTE > > When a new coordinate system is added, the **virtual robot is restarted** to apply the new configuration. > > During this restart: > - Robot visualization can temporarily disappear or appear outdated in the UI. > - Coordinate system changes are not immediately visible in visualizations. > - All connections to 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 available for visualization or program execution.
10183
10183
  * @summary Add Coordinate Systems
10184
10184
  * @param {string} cell Unique identifier addressing a cell in all API calls.
10185
10185
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -10190,7 +10190,7 @@ declare const VirtualControllerApiFp: (configuration?: Configuration) => {
10190
10190
  */
10191
10191
  addVirtualControllerCoordinateSystem(cell: string, controller: string, coordinateSystem: string, coordinateSystemData: CoordinateSystemData, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
10192
10192
  /**
10193
- * Adds a new TCP (Tool Center Point) 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. **Important notes:** - Adding or updating a TCP triggers a **virtual robot restart** to apply the new configuration. - During this restart: - The robot visualization in the UI may temporarily disappear. - The TCP visualization may not immediately appear, or may look outdated during the first test/rerun. - All active connections to the virtual robot are closed and then re-established. This creates a delay before the TCP is available in both the UI and robot programs. - The API call itself does **not wait until the restart and synchronization are complete**. Even if the request succeeds, the new or updated TCP may not yet be visible in the GUI or available for use.
10193
+ * Adds a new 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. <!-- theme: info --> > #### NOTE > > When adding or updating a TCP, the **virtual robot is restarted** to apply the new configuration. > > During this restart: > - Robot visualization can temporarily disappear. > - The TCP may not be immediately visible or appear outdated in visualizations. > - All connections to virtual robot are closed and re-established, which introduces a short delay before the TCP is available for operation. > > The API call itself does **not wait until the restart and re-synchronization are complete**. > A successful response indicates that the request was accepted, but the TCP may not yet be visible nor usable.
10194
10194
  * @summary Add TCP
10195
10195
  * @param {string} cell Unique identifier addressing a cell in all API calls.
10196
10196
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -10202,7 +10202,7 @@ declare const VirtualControllerApiFp: (configuration?: Configuration) => {
10202
10202
  */
10203
10203
  addVirtualControllerTcp(cell: string, controller: string, motionGroup: string, tcp: string, robotTcpData: RobotTcpData, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
10204
10204
  /**
10205
- * 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 that use the deleted coordinate system as 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 available for visualization or program execution.
10205
+ * 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 that use the deleted coordinate system as reference. <!-- theme: info --> > #### NOTE > > When a new coordinate system is removed, the **virtual robot is restarted** to apply the new configuration. > > During this restart: > - Robot visualization can temporarily disappear or appear outdated in the UI. > - Coordinate system changes are not immediately visible in visualizations. > - All connections to 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 available for visualization or program execution.
10206
10206
  * @summary Delete Coordinate System
10207
10207
  * @param {string} cell Unique identifier addressing a cell in all API calls.
10208
10208
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -10213,7 +10213,7 @@ declare const VirtualControllerApiFp: (configuration?: Configuration) => {
10213
10213
  */
10214
10214
  deleteVirtualControllerCoordinateSystem(cell: string, controller: string, coordinateSystem: string, deleteDependent?: boolean, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
10215
10215
  /**
10216
- * Removes the TCP (Tool Center Point) from the motion group. An unknown TCP is a valid input and will simply be ignored. **Important notes:** - Removing or updating a TCP triggers a **virtual robot restart** to apply the new configuration. - During this restart: - The robot visualization in the UI may temporarily disappear. - The TCP visualization may not immediately appear, or may look outdated during the first test/rerun. - All active connections to the virtual robot are closed and then re-established. This creates a delay before the TCP is available in both the UI and robot programs. - The API call itself does **not wait until the restart and synchronization are complete**. Even if the request succeeds, the new or updated TCP may not yet be visible in the GUI or available for use.
10216
+ * Removes the TCP (Tool Center Point) from the motion group. An unknown TCP is a valid input and will simply be ignored. <!-- theme: info --> > #### NOTE > > When removing a TCP, the **virtual robot is restarted** to apply the new configuration. > > During this restart: > - Robot visualization can temporarily disappear. > - The removal of the TCP may not be immediately visible or appear outdated in visualizations. > - All connections to 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**. > A successful response indicates that the request was accepted, but the then used TCP may not yet be visible nor usable.
10217
10217
  * @summary Remove TCP
10218
10218
  * @param {string} cell Unique identifier addressing a cell in all API calls.
10219
10219
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -10224,7 +10224,7 @@ declare const VirtualControllerApiFp: (configuration?: Configuration) => {
10224
10224
  */
10225
10225
  deleteVirtualControllerTcp(cell: string, controller: string, motionGroup: string, tcp: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
10226
10226
  /**
10227
- * 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.
10227
+ * Requests the Emergency Stop state of the virtual robot controller. Use [getCurrentMotionGroupState](getCurrentMotionGroupState) to get the Emergency Stop state with `safety_state` regardless of the controller type. > **NOTE** > > The Emergency Stop state can only be changed when using virtual robot controllers.
10228
10228
  * @summary Get Emergency Stop State
10229
10229
  * @param {string} cell Unique identifier addressing a cell in all API calls.
10230
10230
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -10252,7 +10252,7 @@ declare const VirtualControllerApiFp: (configuration?: Configuration) => {
10252
10252
  */
10253
10253
  getMotionGroups(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<MotionGroupInfo>>>;
10254
10254
  /**
10255
- * 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.
10255
+ * Requests the operation mode of the virtual robot controller. To get the operation mode regardless of the controller type, use [getCurrentMotionGroupState](getCurrentMotionGroupState). > **NOTE** > > The operation mode can only be changed via API when using virtual robot controllers.
10256
10256
  * @summary Get Operation Mode
10257
10257
  * @param {string} cell Unique identifier addressing a cell in all API calls.
10258
10258
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -10261,7 +10261,7 @@ declare const VirtualControllerApiFp: (configuration?: Configuration) => {
10261
10261
  */
10262
10262
  getOperationMode(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<OpMode>>;
10263
10263
  /**
10264
- * Gets motion group mounting. The motion group is based on the origin of the returned coordinate system.
10264
+ * Gets motion group mounting. The motion group is based on the origin of the returned coordinate system.
10265
10265
  * @summary Get Mounting
10266
10266
  * @param {string} cell Unique identifier addressing a cell in all API calls.
10267
10267
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -10280,7 +10280,7 @@ declare const VirtualControllerApiFp: (configuration?: Configuration) => {
10280
10280
  */
10281
10281
  listVirtualControllerCoordinateSystems(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<CoordinateSystem>>>;
10282
10282
  /**
10283
- * Lists TCPs of the motion group. An empty TCP list is valid, for example for external axes.
10283
+ * Lists TCPs of the motion group. An empty TCP list is valid, e.g., for external axes.
10284
10284
  * @summary List TCPs
10285
10285
  * @param {string} cell Unique identifier addressing a cell in all API calls.
10286
10286
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -10290,7 +10290,7 @@ declare const VirtualControllerApiFp: (configuration?: Configuration) => {
10290
10290
  */
10291
10291
  listVirtualControllerTcps(cell: string, controller: string, motionGroup: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<RobotTcp>>>;
10292
10292
  /**
10293
- * Activates or releases the Emergency Stop on the virtual robot controller. Activating the Emergency Stop stops the execution of all motions. The stop is executed on physical controllers immediately not gracefully and not on paths. Due to restricted physical behavior of the virtual robot controller, the Emergency Stop is executed on paths. 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.
10293
+ * Activates or releases the Emergency Stop on the virtual robot controller. Activating the Emergency Stop stops the execution of all motions. The stop is executed on physical controllers immediately not gracefully and not on paths. Due to restricted physical behavior of the virtual robot controller, the Emergency Stop is executed on paths. To return to normal operation the Emergency Stop needs to be released. Use [getCurrentMotionGroupState](getCurrentMotionGroupState) to get the Emergency Stop state with `safety_state` regardless of the controller type. > **NOTE** > > The Emergency Stop state can only be changed via API when using virtual robot controllers.
10294
10294
  * @summary Push or Release Emergency Stop
10295
10295
  * @param {string} cell Unique identifier addressing a cell in all API calls.
10296
10296
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -10300,7 +10300,7 @@ declare const VirtualControllerApiFp: (configuration?: Configuration) => {
10300
10300
  */
10301
10301
  setEmergencyStop(cell: string, controller: string, active?: boolean, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
10302
10302
  /**
10303
- * 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.
10303
+ * 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. <!-- theme: info --> > #### NOTE > > Only use the endpoint when the motion group is in monitor mode. If the motion group is controlled, currently jogging or planning motions, > the values are overridden by the controller or an error may occur.
10304
10304
  * @summary Set Motion Group State
10305
10305
  * @param {string} cell Unique identifier addressing a cell in all API calls.
10306
10306
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -10311,7 +10311,7 @@ declare const VirtualControllerApiFp: (configuration?: Configuration) => {
10311
10311
  */
10312
10312
  setMotionGroupState(cell: string, controller: string, motionGroup: string, motionGroupJoints: MotionGroupJoints, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
10313
10313
  /**
10314
- * 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.
10314
+ * 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 operation mode can only be changed via API when using virtual robot controllers.
10315
10315
  * @summary Set Operation Mode
10316
10316
  * @param {string} cell Unique identifier addressing a cell in all API calls.
10317
10317
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -10321,7 +10321,7 @@ declare const VirtualControllerApiFp: (configuration?: Configuration) => {
10321
10321
  */
10322
10322
  setOperationMode(cell: string, controller: string, mode: OperationMode, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
10323
10323
  /**
10324
- * 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 user-facing name - An offset in another coordinate system, referenced by the unique identifier of the reference coordinate system. **Important notes:** - Changing the mounting configuration is treated as a setup change. - When the mounting is set to a new coordinate system, the **virtual robot restarts** in the background to apply the new configuration. - During this process: - Robot visualization may temporarily disappear or not reflect the new mounting immediately. - Motion group state and coordinate system alignment may not be instantly updated in the UI. - All connections to the virtual robot are closed and then re-established, which can cause a short delay before the system is ready again. - The API call itself does **not wait until the restart and synchronization are complete**. A successful response indicates that the request was accepted, but the updated mounting may not yet be visible.
10324
+ * 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 user-facing name - An offset in another coordinate system, referenced by the unique identifier of the reference coordinate system. <!-- theme: info --> > #### Changing the mounting configuration is considered a setup change > > When the mounting is set to a new coordinate system, the **virtual robot is restarted** to apply the new configuration. > > During this restart: > - Robot visualization can temporarily disappear or not reflect the new mounting immediately. > - Motion group state and coordinate system alignment may not be immediately visible in visualizations. > - All connections to 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**. > A successful response indicates that the request was accepted, but the updated mounting may not yet be visible.
10325
10325
  * @summary Set Mounting
10326
10326
  * @param {string} cell Unique identifier addressing a cell in all API calls.
10327
10327
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -10338,7 +10338,7 @@ declare const VirtualControllerApiFp: (configuration?: Configuration) => {
10338
10338
  */
10339
10339
  declare const VirtualControllerApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
10340
10340
  /**
10341
- * Adds a coordinate system to the robot controller. **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 available for visualization or program execution.
10341
+ * Adds a coordinate system to the robot controller. <!-- theme: info --> > #### NOTE > > When a new coordinate system is added, the **virtual robot is restarted** to apply the new configuration. > > During this restart: > - Robot visualization can temporarily disappear or appear outdated in the UI. > - Coordinate system changes are not immediately visible in visualizations. > - All connections to 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 available for visualization or program execution.
10342
10342
  * @summary Add Coordinate Systems
10343
10343
  * @param {string} cell Unique identifier addressing a cell in all API calls.
10344
10344
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -10349,7 +10349,7 @@ declare const VirtualControllerApiFactory: (configuration?: Configuration, baseP
10349
10349
  */
10350
10350
  addVirtualControllerCoordinateSystem(cell: string, controller: string, coordinateSystem: string, coordinateSystemData: CoordinateSystemData, options?: RawAxiosRequestConfig): AxiosPromise<void>;
10351
10351
  /**
10352
- * Adds a new TCP (Tool Center Point) 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. **Important notes:** - Adding or updating a TCP triggers a **virtual robot restart** to apply the new configuration. - During this restart: - The robot visualization in the UI may temporarily disappear. - The TCP visualization may not immediately appear, or may look outdated during the first test/rerun. - All active connections to the virtual robot are closed and then re-established. This creates a delay before the TCP is available in both the UI and robot programs. - The API call itself does **not wait until the restart and synchronization are complete**. Even if the request succeeds, the new or updated TCP may not yet be visible in the GUI or available for use.
10352
+ * Adds a new 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. <!-- theme: info --> > #### NOTE > > When adding or updating a TCP, the **virtual robot is restarted** to apply the new configuration. > > During this restart: > - Robot visualization can temporarily disappear. > - The TCP may not be immediately visible or appear outdated in visualizations. > - All connections to virtual robot are closed and re-established, which introduces a short delay before the TCP is available for operation. > > The API call itself does **not wait until the restart and re-synchronization are complete**. > A successful response indicates that the request was accepted, but the TCP may not yet be visible nor usable.
10353
10353
  * @summary Add TCP
10354
10354
  * @param {string} cell Unique identifier addressing a cell in all API calls.
10355
10355
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -10361,7 +10361,7 @@ declare const VirtualControllerApiFactory: (configuration?: Configuration, baseP
10361
10361
  */
10362
10362
  addVirtualControllerTcp(cell: string, controller: string, motionGroup: string, tcp: string, robotTcpData: RobotTcpData, options?: RawAxiosRequestConfig): AxiosPromise<void>;
10363
10363
  /**
10364
- * 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 that use the deleted coordinate system as 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 available for visualization or program execution.
10364
+ * 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 that use the deleted coordinate system as reference. <!-- theme: info --> > #### NOTE > > When a new coordinate system is removed, the **virtual robot is restarted** to apply the new configuration. > > During this restart: > - Robot visualization can temporarily disappear or appear outdated in the UI. > - Coordinate system changes are not immediately visible in visualizations. > - All connections to 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 available for visualization or program execution.
10365
10365
  * @summary Delete Coordinate System
10366
10366
  * @param {string} cell Unique identifier addressing a cell in all API calls.
10367
10367
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -10372,7 +10372,7 @@ declare const VirtualControllerApiFactory: (configuration?: Configuration, baseP
10372
10372
  */
10373
10373
  deleteVirtualControllerCoordinateSystem(cell: string, controller: string, coordinateSystem: string, deleteDependent?: boolean, options?: RawAxiosRequestConfig): AxiosPromise<void>;
10374
10374
  /**
10375
- * Removes the TCP (Tool Center Point) from the motion group. An unknown TCP is a valid input and will simply be ignored. **Important notes:** - Removing or updating a TCP triggers a **virtual robot restart** to apply the new configuration. - During this restart: - The robot visualization in the UI may temporarily disappear. - The TCP visualization may not immediately appear, or may look outdated during the first test/rerun. - All active connections to the virtual robot are closed and then re-established. This creates a delay before the TCP is available in both the UI and robot programs. - The API call itself does **not wait until the restart and synchronization are complete**. Even if the request succeeds, the new or updated TCP may not yet be visible in the GUI or available for use.
10375
+ * Removes the TCP (Tool Center Point) from the motion group. An unknown TCP is a valid input and will simply be ignored. <!-- theme: info --> > #### NOTE > > When removing a TCP, the **virtual robot is restarted** to apply the new configuration. > > During this restart: > - Robot visualization can temporarily disappear. > - The removal of the TCP may not be immediately visible or appear outdated in visualizations. > - All connections to 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**. > A successful response indicates that the request was accepted, but the then used TCP may not yet be visible nor usable.
10376
10376
  * @summary Remove TCP
10377
10377
  * @param {string} cell Unique identifier addressing a cell in all API calls.
10378
10378
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -10383,7 +10383,7 @@ declare const VirtualControllerApiFactory: (configuration?: Configuration, baseP
10383
10383
  */
10384
10384
  deleteVirtualControllerTcp(cell: string, controller: string, motionGroup: string, tcp: string, options?: RawAxiosRequestConfig): AxiosPromise<void>;
10385
10385
  /**
10386
- * 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.
10386
+ * Requests the Emergency Stop state of the virtual robot controller. Use [getCurrentMotionGroupState](getCurrentMotionGroupState) to get the Emergency Stop state with `safety_state` regardless of the controller type. > **NOTE** > > The Emergency Stop state can only be changed when using virtual robot controllers.
10387
10387
  * @summary Get Emergency Stop State
10388
10388
  * @param {string} cell Unique identifier addressing a cell in all API calls.
10389
10389
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -10411,7 +10411,7 @@ declare const VirtualControllerApiFactory: (configuration?: Configuration, baseP
10411
10411
  */
10412
10412
  getMotionGroups(cell: string, controller: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<MotionGroupInfo>>;
10413
10413
  /**
10414
- * 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.
10414
+ * Requests the operation mode of the virtual robot controller. To get the operation mode regardless of the controller type, use [getCurrentMotionGroupState](getCurrentMotionGroupState). > **NOTE** > > The operation mode can only be changed via API when using virtual robot controllers.
10415
10415
  * @summary Get Operation Mode
10416
10416
  * @param {string} cell Unique identifier addressing a cell in all API calls.
10417
10417
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -10420,7 +10420,7 @@ declare const VirtualControllerApiFactory: (configuration?: Configuration, baseP
10420
10420
  */
10421
10421
  getOperationMode(cell: string, controller: string, options?: RawAxiosRequestConfig): AxiosPromise<OpMode>;
10422
10422
  /**
10423
- * Gets motion group mounting. The motion group is based on the origin of the returned coordinate system.
10423
+ * Gets motion group mounting. The motion group is based on the origin of the returned coordinate system.
10424
10424
  * @summary Get Mounting
10425
10425
  * @param {string} cell Unique identifier addressing a cell in all API calls.
10426
10426
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -10439,7 +10439,7 @@ declare const VirtualControllerApiFactory: (configuration?: Configuration, baseP
10439
10439
  */
10440
10440
  listVirtualControllerCoordinateSystems(cell: string, controller: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<CoordinateSystem>>;
10441
10441
  /**
10442
- * Lists TCPs of the motion group. An empty TCP list is valid, for example for external axes.
10442
+ * Lists TCPs of the motion group. An empty TCP list is valid, e.g., for external axes.
10443
10443
  * @summary List TCPs
10444
10444
  * @param {string} cell Unique identifier addressing a cell in all API calls.
10445
10445
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -10449,7 +10449,7 @@ declare const VirtualControllerApiFactory: (configuration?: Configuration, baseP
10449
10449
  */
10450
10450
  listVirtualControllerTcps(cell: string, controller: string, motionGroup: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<RobotTcp>>;
10451
10451
  /**
10452
- * Activates or releases the Emergency Stop on the virtual robot controller. Activating the Emergency Stop stops the execution of all motions. The stop is executed on physical controllers immediately not gracefully and not on paths. Due to restricted physical behavior of the virtual robot controller, the Emergency Stop is executed on paths. 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.
10452
+ * Activates or releases the Emergency Stop on the virtual robot controller. Activating the Emergency Stop stops the execution of all motions. The stop is executed on physical controllers immediately not gracefully and not on paths. Due to restricted physical behavior of the virtual robot controller, the Emergency Stop is executed on paths. To return to normal operation the Emergency Stop needs to be released. Use [getCurrentMotionGroupState](getCurrentMotionGroupState) to get the Emergency Stop state with `safety_state` regardless of the controller type. > **NOTE** > > The Emergency Stop state can only be changed via API when using virtual robot controllers.
10453
10453
  * @summary Push or Release Emergency Stop
10454
10454
  * @param {string} cell Unique identifier addressing a cell in all API calls.
10455
10455
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -10459,7 +10459,7 @@ declare const VirtualControllerApiFactory: (configuration?: Configuration, baseP
10459
10459
  */
10460
10460
  setEmergencyStop(cell: string, controller: string, active?: boolean, options?: RawAxiosRequestConfig): AxiosPromise<void>;
10461
10461
  /**
10462
- * 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.
10462
+ * 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. <!-- theme: info --> > #### NOTE > > Only use the endpoint when the motion group is in monitor mode. If the motion group is controlled, currently jogging or planning motions, > the values are overridden by the controller or an error may occur.
10463
10463
  * @summary Set Motion Group State
10464
10464
  * @param {string} cell Unique identifier addressing a cell in all API calls.
10465
10465
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -10470,7 +10470,7 @@ declare const VirtualControllerApiFactory: (configuration?: Configuration, baseP
10470
10470
  */
10471
10471
  setMotionGroupState(cell: string, controller: string, motionGroup: string, motionGroupJoints: MotionGroupJoints, options?: RawAxiosRequestConfig): AxiosPromise<void>;
10472
10472
  /**
10473
- * 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.
10473
+ * 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 operation mode can only be changed via API when using virtual robot controllers.
10474
10474
  * @summary Set Operation Mode
10475
10475
  * @param {string} cell Unique identifier addressing a cell in all API calls.
10476
10476
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -10480,7 +10480,7 @@ declare const VirtualControllerApiFactory: (configuration?: Configuration, baseP
10480
10480
  */
10481
10481
  setOperationMode(cell: string, controller: string, mode: OperationMode, options?: RawAxiosRequestConfig): AxiosPromise<void>;
10482
10482
  /**
10483
- * 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 user-facing name - An offset in another coordinate system, referenced by the unique identifier of the reference coordinate system. **Important notes:** - Changing the mounting configuration is treated as a setup change. - When the mounting is set to a new coordinate system, the **virtual robot restarts** in the background to apply the new configuration. - During this process: - Robot visualization may temporarily disappear or not reflect the new mounting immediately. - Motion group state and coordinate system alignment may not be instantly updated in the UI. - All connections to the virtual robot are closed and then re-established, which can cause a short delay before the system is ready again. - The API call itself does **not wait until the restart and synchronization are complete**. A successful response indicates that the request was accepted, but the updated mounting may not yet be visible.
10483
+ * 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 user-facing name - An offset in another coordinate system, referenced by the unique identifier of the reference coordinate system. <!-- theme: info --> > #### Changing the mounting configuration is considered a setup change > > When the mounting is set to a new coordinate system, the **virtual robot is restarted** to apply the new configuration. > > During this restart: > - Robot visualization can temporarily disappear or not reflect the new mounting immediately. > - Motion group state and coordinate system alignment may not be immediately visible in visualizations. > - All connections to 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**. > A successful response indicates that the request was accepted, but the updated mounting may not yet be visible.
10484
10484
  * @summary Set Mounting
10485
10485
  * @param {string} cell Unique identifier addressing a cell in all API calls.
10486
10486
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -10499,7 +10499,7 @@ declare const VirtualControllerApiFactory: (configuration?: Configuration, baseP
10499
10499
  */
10500
10500
  declare class VirtualControllerApi extends BaseAPI {
10501
10501
  /**
10502
- * Adds a coordinate system to the robot controller. **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 available for visualization or program execution.
10502
+ * Adds a coordinate system to the robot controller. <!-- theme: info --> > #### NOTE > > When a new coordinate system is added, the **virtual robot is restarted** to apply the new configuration. > > During this restart: > - Robot visualization can temporarily disappear or appear outdated in the UI. > - Coordinate system changes are not immediately visible in visualizations. > - All connections to 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 available for visualization or program execution.
10503
10503
  * @summary Add Coordinate Systems
10504
10504
  * @param {string} cell Unique identifier addressing a cell in all API calls.
10505
10505
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -10511,7 +10511,7 @@ declare class VirtualControllerApi extends BaseAPI {
10511
10511
  */
10512
10512
  addVirtualControllerCoordinateSystem(cell: string, controller: string, coordinateSystem: string, coordinateSystemData: CoordinateSystemData, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
10513
10513
  /**
10514
- * Adds a new TCP (Tool Center Point) 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. **Important notes:** - Adding or updating a TCP triggers a **virtual robot restart** to apply the new configuration. - During this restart: - The robot visualization in the UI may temporarily disappear. - The TCP visualization may not immediately appear, or may look outdated during the first test/rerun. - All active connections to the virtual robot are closed and then re-established. This creates a delay before the TCP is available in both the UI and robot programs. - The API call itself does **not wait until the restart and synchronization are complete**. Even if the request succeeds, the new or updated TCP may not yet be visible in the GUI or available for use.
10514
+ * Adds a new 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. <!-- theme: info --> > #### NOTE > > When adding or updating a TCP, the **virtual robot is restarted** to apply the new configuration. > > During this restart: > - Robot visualization can temporarily disappear. > - The TCP may not be immediately visible or appear outdated in visualizations. > - All connections to virtual robot are closed and re-established, which introduces a short delay before the TCP is available for operation. > > The API call itself does **not wait until the restart and re-synchronization are complete**. > A successful response indicates that the request was accepted, but the TCP may not yet be visible nor usable.
10515
10515
  * @summary Add TCP
10516
10516
  * @param {string} cell Unique identifier addressing a cell in all API calls.
10517
10517
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -10524,7 +10524,7 @@ declare class VirtualControllerApi extends BaseAPI {
10524
10524
  */
10525
10525
  addVirtualControllerTcp(cell: string, controller: string, motionGroup: string, tcp: string, robotTcpData: RobotTcpData, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
10526
10526
  /**
10527
- * 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 that use the deleted coordinate system as 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 available for visualization or program execution.
10527
+ * 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 that use the deleted coordinate system as reference. <!-- theme: info --> > #### NOTE > > When a new coordinate system is removed, the **virtual robot is restarted** to apply the new configuration. > > During this restart: > - Robot visualization can temporarily disappear or appear outdated in the UI. > - Coordinate system changes are not immediately visible in visualizations. > - All connections to 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 available for visualization or program execution.
10528
10528
  * @summary Delete Coordinate System
10529
10529
  * @param {string} cell Unique identifier addressing a cell in all API calls.
10530
10530
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -10536,7 +10536,7 @@ declare class VirtualControllerApi extends BaseAPI {
10536
10536
  */
10537
10537
  deleteVirtualControllerCoordinateSystem(cell: string, controller: string, coordinateSystem: string, deleteDependent?: boolean, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
10538
10538
  /**
10539
- * Removes the TCP (Tool Center Point) from the motion group. An unknown TCP is a valid input and will simply be ignored. **Important notes:** - Removing or updating a TCP triggers a **virtual robot restart** to apply the new configuration. - During this restart: - The robot visualization in the UI may temporarily disappear. - The TCP visualization may not immediately appear, or may look outdated during the first test/rerun. - All active connections to the virtual robot are closed and then re-established. This creates a delay before the TCP is available in both the UI and robot programs. - The API call itself does **not wait until the restart and synchronization are complete**. Even if the request succeeds, the new or updated TCP may not yet be visible in the GUI or available for use.
10539
+ * Removes the TCP (Tool Center Point) from the motion group. An unknown TCP is a valid input and will simply be ignored. <!-- theme: info --> > #### NOTE > > When removing a TCP, the **virtual robot is restarted** to apply the new configuration. > > During this restart: > - Robot visualization can temporarily disappear. > - The removal of the TCP may not be immediately visible or appear outdated in visualizations. > - All connections to 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**. > A successful response indicates that the request was accepted, but the then used TCP may not yet be visible nor usable.
10540
10540
  * @summary Remove TCP
10541
10541
  * @param {string} cell Unique identifier addressing a cell in all API calls.
10542
10542
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -10548,7 +10548,7 @@ declare class VirtualControllerApi extends BaseAPI {
10548
10548
  */
10549
10549
  deleteVirtualControllerTcp(cell: string, controller: string, motionGroup: string, tcp: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
10550
10550
  /**
10551
- * 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.
10551
+ * Requests the Emergency Stop state of the virtual robot controller. Use [getCurrentMotionGroupState](getCurrentMotionGroupState) to get the Emergency Stop state with `safety_state` regardless of the controller type. > **NOTE** > > The Emergency Stop state can only be changed when using virtual robot controllers.
10552
10552
  * @summary Get Emergency Stop State
10553
10553
  * @param {string} cell Unique identifier addressing a cell in all API calls.
10554
10554
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -10579,7 +10579,7 @@ declare class VirtualControllerApi extends BaseAPI {
10579
10579
  */
10580
10580
  getMotionGroups(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<MotionGroupInfo[], any>>;
10581
10581
  /**
10582
- * 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.
10582
+ * Requests the operation mode of the virtual robot controller. To get the operation mode regardless of the controller type, use [getCurrentMotionGroupState](getCurrentMotionGroupState). > **NOTE** > > The operation mode can only be changed via API when using virtual robot controllers.
10583
10583
  * @summary Get Operation Mode
10584
10584
  * @param {string} cell Unique identifier addressing a cell in all API calls.
10585
10585
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -10589,7 +10589,7 @@ declare class VirtualControllerApi extends BaseAPI {
10589
10589
  */
10590
10590
  getOperationMode(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<OpMode, any>>;
10591
10591
  /**
10592
- * Gets motion group mounting. The motion group is based on the origin of the returned coordinate system.
10592
+ * Gets motion group mounting. The motion group is based on the origin of the returned coordinate system.
10593
10593
  * @summary Get Mounting
10594
10594
  * @param {string} cell Unique identifier addressing a cell in all API calls.
10595
10595
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -10610,7 +10610,7 @@ declare class VirtualControllerApi extends BaseAPI {
10610
10610
  */
10611
10611
  listVirtualControllerCoordinateSystems(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<CoordinateSystem[], any>>;
10612
10612
  /**
10613
- * Lists TCPs of the motion group. An empty TCP list is valid, for example for external axes.
10613
+ * Lists TCPs of the motion group. An empty TCP list is valid, e.g., for external axes.
10614
10614
  * @summary List TCPs
10615
10615
  * @param {string} cell Unique identifier addressing a cell in all API calls.
10616
10616
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -10621,7 +10621,7 @@ declare class VirtualControllerApi extends BaseAPI {
10621
10621
  */
10622
10622
  listVirtualControllerTcps(cell: string, controller: string, motionGroup: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<RobotTcp[], any>>;
10623
10623
  /**
10624
- * Activates or releases the Emergency Stop on the virtual robot controller. Activating the Emergency Stop stops the execution of all motions. The stop is executed on physical controllers immediately not gracefully and not on paths. Due to restricted physical behavior of the virtual robot controller, the Emergency Stop is executed on paths. 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.
10624
+ * Activates or releases the Emergency Stop on the virtual robot controller. Activating the Emergency Stop stops the execution of all motions. The stop is executed on physical controllers immediately not gracefully and not on paths. Due to restricted physical behavior of the virtual robot controller, the Emergency Stop is executed on paths. To return to normal operation the Emergency Stop needs to be released. Use [getCurrentMotionGroupState](getCurrentMotionGroupState) to get the Emergency Stop state with `safety_state` regardless of the controller type. > **NOTE** > > The Emergency Stop state can only be changed via API when using virtual robot controllers.
10625
10625
  * @summary Push or Release Emergency Stop
10626
10626
  * @param {string} cell Unique identifier addressing a cell in all API calls.
10627
10627
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -10632,7 +10632,7 @@ declare class VirtualControllerApi extends BaseAPI {
10632
10632
  */
10633
10633
  setEmergencyStop(cell: string, controller: string, active?: boolean, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
10634
10634
  /**
10635
- * 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.
10635
+ * 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. <!-- theme: info --> > #### NOTE > > Only use the endpoint when the motion group is in monitor mode. If the motion group is controlled, currently jogging or planning motions, > the values are overridden by the controller or an error may occur.
10636
10636
  * @summary Set Motion Group State
10637
10637
  * @param {string} cell Unique identifier addressing a cell in all API calls.
10638
10638
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -10644,7 +10644,7 @@ declare class VirtualControllerApi extends BaseAPI {
10644
10644
  */
10645
10645
  setMotionGroupState(cell: string, controller: string, motionGroup: string, motionGroupJoints: MotionGroupJoints, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
10646
10646
  /**
10647
- * 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.
10647
+ * 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 operation mode can only be changed via API when using virtual robot controllers.
10648
10648
  * @summary Set Operation Mode
10649
10649
  * @param {string} cell Unique identifier addressing a cell in all API calls.
10650
10650
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -10655,7 +10655,7 @@ declare class VirtualControllerApi extends BaseAPI {
10655
10655
  */
10656
10656
  setOperationMode(cell: string, controller: string, mode: OperationMode, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
10657
10657
  /**
10658
- * 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 user-facing name - An offset in another coordinate system, referenced by the unique identifier of the reference coordinate system. **Important notes:** - Changing the mounting configuration is treated as a setup change. - When the mounting is set to a new coordinate system, the **virtual robot restarts** in the background to apply the new configuration. - During this process: - Robot visualization may temporarily disappear or not reflect the new mounting immediately. - Motion group state and coordinate system alignment may not be instantly updated in the UI. - All connections to the virtual robot are closed and then re-established, which can cause a short delay before the system is ready again. - The API call itself does **not wait until the restart and synchronization are complete**. A successful response indicates that the request was accepted, but the updated mounting may not yet be visible.
10658
+ * 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 user-facing name - An offset in another coordinate system, referenced by the unique identifier of the reference coordinate system. <!-- theme: info --> > #### Changing the mounting configuration is considered a setup change > > When the mounting is set to a new coordinate system, the **virtual robot is restarted** to apply the new configuration. > > During this restart: > - Robot visualization can temporarily disappear or not reflect the new mounting immediately. > - Motion group state and coordinate system alignment may not be immediately visible in visualizations. > - All connections to 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**. > A successful response indicates that the request was accepted, but the updated mounting may not yet be visible.
10659
10659
  * @summary Set Mounting
10660
10660
  * @param {string} cell Unique identifier addressing a cell in all API calls.
10661
10661
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -10673,7 +10673,7 @@ declare class VirtualControllerApi extends BaseAPI {
10673
10673
  */
10674
10674
  declare const VirtualControllerBehaviorApiAxiosParamCreator: (configuration?: Configuration) => {
10675
10675
  /**
10676
- * <!-- theme: danger --> > Websocket endpoint This stream sends the commanded state (joint positions, velocities, accelerations, torques) for each motion group of the virtual controller and sets the joint configuration. Moving motion groups on virtual controllers can be executed by using Trajectory Planning and Trajectory Execution. Trajectory Execution commands the desired joint configuration to each motion group. Physical motion groups move to this joint configuration. With physical motion groups, this takes some time and only works if possible. And you have the *actual* joint state - the current real motion group configuration. Again, this stream is providing *commanded* joint state! > **NOTE** > > This stream provides *commanded* joint states, it **doesn\'t provide actual joint states**. When the virtual controller receives joint commands the joint configuration is immediately adapted to match the incoming joint configuration. > **CAUTION** > > Incoming joint configurations are not visualized and their velocity limits are not checked. Possible use cases are: 1. Creating a robotic application that dynamically adapts to the configured joints on the robot controller, using this stream to feed new joint configurations back to the motion groups. The stream only sends data to the robot controller if a motion is executed. If the robot controller\'s joint configuration differs too much from the incoming joint configuration, a following error occurs. Joint configurations that result in following errors are executed only for motions with a low velocity. 2. Mimic Freedrive motions. <!-- theme: danger --> > **DANGER** > > If the incoming joint configuration is set to maximum velocity, the movement to reach this incoming joint configuration > will be executed with maximum speed regardless of safety zones and mechanical limits.
10676
+ * <!-- theme: success --> > Websocket endpoint Sends the **commanded** state, e.g., joint positions, velocities, accelerations, torques, for each motion group of the virtual controller and sets the joint configuration. Use [planTrajectory](planTrajectory) and [executeTrajectory](executeTrajectory) to move motion groups on virtual controllers. Learn more about the [movement behavior of virtual controllers in comparison to physical controllers](executeTrajectory#movement-behavior). > **NOTE** > > Incoming joint configurations are not visualized and their velocity limits are not checked. #### Use cases 1. Creating a robotic application that dynamically adapts to the configured joints on the robot controller, using this stream to feed new joint configurations back to the motion groups.\\ The stream only sends data to the robot controller if a motion is executed.\\ If the robot controller\'s joint configuration differs too much from the incoming joint configuration, a following error occurs. Joint configurations that result in following errors are executed only for motions with a low velocity. 2. Mimic freedrive motions. <!-- theme: danger --> > **DANGER** > > If the incoming joint configuration is set to maximum velocity, the movement to reach this incoming joint configuration > will be executed with maximum speed regardless of safety zones and mechanical limits.
10677
10677
  * @summary Stream Joint Configuration
10678
10678
  * @param {string} cell Unique identifier addressing a cell in all API calls.
10679
10679
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -10692,7 +10692,7 @@ declare const VirtualControllerBehaviorApiAxiosParamCreator: (configuration?: Co
10692
10692
  */
10693
10693
  getCycleTime: (cell: string, controller: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
10694
10694
  /**
10695
- * Get the current virtual controller behavior - please see the setter [setVirtualControllerBehavior](setVirtualControllerBehavior) and the enum for details.
10695
+ * Get the current virtual controller behavior. See [setVirtualControllerBehavior](setVirtualControllerBehavior) and the body for details.
10696
10696
  * @summary Get 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.
@@ -10701,7 +10701,7 @@ declare const VirtualControllerBehaviorApiAxiosParamCreator: (configuration?: Co
10701
10701
  */
10702
10702
  getVirtualControllerBehavior: (cell: string, controller: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
10703
10703
  /**
10704
- * Set virtual controller behavior.
10704
+ * Set virtual controller behavior. See query parameters for details.
10705
10705
  * @summary Set Behavior
10706
10706
  * @param {string} cell Unique identifier addressing a cell in all API calls.
10707
10707
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -10717,7 +10717,7 @@ declare const VirtualControllerBehaviorApiAxiosParamCreator: (configuration?: Co
10717
10717
  */
10718
10718
  declare const VirtualControllerBehaviorApiFp: (configuration?: Configuration) => {
10719
10719
  /**
10720
- * <!-- theme: danger --> > Websocket endpoint This stream sends the commanded state (joint positions, velocities, accelerations, torques) for each motion group of the virtual controller and sets the joint configuration. Moving motion groups on virtual controllers can be executed by using Trajectory Planning and Trajectory Execution. Trajectory Execution commands the desired joint configuration to each motion group. Physical motion groups move to this joint configuration. With physical motion groups, this takes some time and only works if possible. And you have the *actual* joint state - the current real motion group configuration. Again, this stream is providing *commanded* joint state! > **NOTE** > > This stream provides *commanded* joint states, it **doesn\'t provide actual joint states**. When the virtual controller receives joint commands the joint configuration is immediately adapted to match the incoming joint configuration. > **CAUTION** > > Incoming joint configurations are not visualized and their velocity limits are not checked. Possible use cases are: 1. Creating a robotic application that dynamically adapts to the configured joints on the robot controller, using this stream to feed new joint configurations back to the motion groups. The stream only sends data to the robot controller if a motion is executed. If the robot controller\'s joint configuration differs too much from the incoming joint configuration, a following error occurs. Joint configurations that result in following errors are executed only for motions with a low velocity. 2. Mimic Freedrive motions. <!-- theme: danger --> > **DANGER** > > If the incoming joint configuration is set to maximum velocity, the movement to reach this incoming joint configuration > will be executed with maximum speed regardless of safety zones and mechanical limits.
10720
+ * <!-- theme: success --> > Websocket endpoint Sends the **commanded** state, e.g., joint positions, velocities, accelerations, torques, for each motion group of the virtual controller and sets the joint configuration. Use [planTrajectory](planTrajectory) and [executeTrajectory](executeTrajectory) to move motion groups on virtual controllers. Learn more about the [movement behavior of virtual controllers in comparison to physical controllers](executeTrajectory#movement-behavior). > **NOTE** > > Incoming joint configurations are not visualized and their velocity limits are not checked. #### Use cases 1. Creating a robotic application that dynamically adapts to the configured joints on the robot controller, using this stream to feed new joint configurations back to the motion groups.\\ The stream only sends data to the robot controller if a motion is executed.\\ If the robot controller\'s joint configuration differs too much from the incoming joint configuration, a following error occurs. Joint configurations that result in following errors are executed only for motions with a low velocity. 2. Mimic freedrive motions. <!-- theme: danger --> > **DANGER** > > If the incoming joint configuration is set to maximum velocity, the movement to reach this incoming joint configuration > will be executed with maximum speed regardless of safety zones and mechanical limits.
10721
10721
  * @summary Stream Joint Configuration
10722
10722
  * @param {string} cell Unique identifier addressing a cell in all API calls.
10723
10723
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -10736,7 +10736,7 @@ declare const VirtualControllerBehaviorApiFp: (configuration?: Configuration) =>
10736
10736
  */
10737
10737
  getCycleTime(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CycleTime>>;
10738
10738
  /**
10739
- * Get the current virtual controller behavior - please see the setter [setVirtualControllerBehavior](setVirtualControllerBehavior) and the enum for details.
10739
+ * Get the current virtual controller behavior. See [setVirtualControllerBehavior](setVirtualControllerBehavior) and the body for details.
10740
10740
  * @summary Get Behavior
10741
10741
  * @param {string} cell Unique identifier addressing a cell in all API calls.
10742
10742
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -10745,7 +10745,7 @@ declare const VirtualControllerBehaviorApiFp: (configuration?: Configuration) =>
10745
10745
  */
10746
10746
  getVirtualControllerBehavior(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Behavior>>;
10747
10747
  /**
10748
- * Set virtual controller behavior.
10748
+ * Set virtual controller behavior. See query parameters for details.
10749
10749
  * @summary Set Behavior
10750
10750
  * @param {string} cell Unique identifier addressing a cell in all API calls.
10751
10751
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -10761,7 +10761,7 @@ declare const VirtualControllerBehaviorApiFp: (configuration?: Configuration) =>
10761
10761
  */
10762
10762
  declare const VirtualControllerBehaviorApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
10763
10763
  /**
10764
- * <!-- theme: danger --> > Websocket endpoint This stream sends the commanded state (joint positions, velocities, accelerations, torques) for each motion group of the virtual controller and sets the joint configuration. Moving motion groups on virtual controllers can be executed by using Trajectory Planning and Trajectory Execution. Trajectory Execution commands the desired joint configuration to each motion group. Physical motion groups move to this joint configuration. With physical motion groups, this takes some time and only works if possible. And you have the *actual* joint state - the current real motion group configuration. Again, this stream is providing *commanded* joint state! > **NOTE** > > This stream provides *commanded* joint states, it **doesn\'t provide actual joint states**. When the virtual controller receives joint commands the joint configuration is immediately adapted to match the incoming joint configuration. > **CAUTION** > > Incoming joint configurations are not visualized and their velocity limits are not checked. Possible use cases are: 1. Creating a robotic application that dynamically adapts to the configured joints on the robot controller, using this stream to feed new joint configurations back to the motion groups. The stream only sends data to the robot controller if a motion is executed. If the robot controller\'s joint configuration differs too much from the incoming joint configuration, a following error occurs. Joint configurations that result in following errors are executed only for motions with a low velocity. 2. Mimic Freedrive motions. <!-- theme: danger --> > **DANGER** > > If the incoming joint configuration is set to maximum velocity, the movement to reach this incoming joint configuration > will be executed with maximum speed regardless of safety zones and mechanical limits.
10764
+ * <!-- theme: success --> > Websocket endpoint Sends the **commanded** state, e.g., joint positions, velocities, accelerations, torques, for each motion group of the virtual controller and sets the joint configuration. Use [planTrajectory](planTrajectory) and [executeTrajectory](executeTrajectory) to move motion groups on virtual controllers. Learn more about the [movement behavior of virtual controllers in comparison to physical controllers](executeTrajectory#movement-behavior). > **NOTE** > > Incoming joint configurations are not visualized and their velocity limits are not checked. #### Use cases 1. Creating a robotic application that dynamically adapts to the configured joints on the robot controller, using this stream to feed new joint configurations back to the motion groups.\\ The stream only sends data to the robot controller if a motion is executed.\\ If the robot controller\'s joint configuration differs too much from the incoming joint configuration, a following error occurs. Joint configurations that result in following errors are executed only for motions with a low velocity. 2. Mimic freedrive motions. <!-- theme: danger --> > **DANGER** > > If the incoming joint configuration is set to maximum velocity, the movement to reach this incoming joint configuration > will be executed with maximum speed regardless of safety zones and mechanical limits.
10765
10765
  * @summary Stream Joint Configuration
10766
10766
  * @param {string} cell Unique identifier addressing a cell in all API calls.
10767
10767
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -10780,7 +10780,7 @@ declare const VirtualControllerBehaviorApiFactory: (configuration?: Configuratio
10780
10780
  */
10781
10781
  getCycleTime(cell: string, controller: string, options?: RawAxiosRequestConfig): AxiosPromise<CycleTime>;
10782
10782
  /**
10783
- * Get the current virtual controller behavior - please see the setter [setVirtualControllerBehavior](setVirtualControllerBehavior) and the enum for details.
10783
+ * Get the current virtual controller behavior. See [setVirtualControllerBehavior](setVirtualControllerBehavior) and the body for details.
10784
10784
  * @summary Get Behavior
10785
10785
  * @param {string} cell Unique identifier addressing a cell in all API calls.
10786
10786
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -10789,7 +10789,7 @@ declare const VirtualControllerBehaviorApiFactory: (configuration?: Configuratio
10789
10789
  */
10790
10790
  getVirtualControllerBehavior(cell: string, controller: string, options?: RawAxiosRequestConfig): AxiosPromise<Behavior>;
10791
10791
  /**
10792
- * Set virtual controller behavior.
10792
+ * Set virtual controller behavior. See query parameters for details.
10793
10793
  * @summary Set Behavior
10794
10794
  * @param {string} cell Unique identifier addressing a cell in all API calls.
10795
10795
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -10807,7 +10807,7 @@ declare const VirtualControllerBehaviorApiFactory: (configuration?: Configuratio
10807
10807
  */
10808
10808
  declare class VirtualControllerBehaviorApi extends BaseAPI {
10809
10809
  /**
10810
- * <!-- theme: danger --> > Websocket endpoint This stream sends the commanded state (joint positions, velocities, accelerations, torques) for each motion group of the virtual controller and sets the joint configuration. Moving motion groups on virtual controllers can be executed by using Trajectory Planning and Trajectory Execution. Trajectory Execution commands the desired joint configuration to each motion group. Physical motion groups move to this joint configuration. With physical motion groups, this takes some time and only works if possible. And you have the *actual* joint state - the current real motion group configuration. Again, this stream is providing *commanded* joint state! > **NOTE** > > This stream provides *commanded* joint states, it **doesn\'t provide actual joint states**. When the virtual controller receives joint commands the joint configuration is immediately adapted to match the incoming joint configuration. > **CAUTION** > > Incoming joint configurations are not visualized and their velocity limits are not checked. Possible use cases are: 1. Creating a robotic application that dynamically adapts to the configured joints on the robot controller, using this stream to feed new joint configurations back to the motion groups. The stream only sends data to the robot controller if a motion is executed. If the robot controller\'s joint configuration differs too much from the incoming joint configuration, a following error occurs. Joint configurations that result in following errors are executed only for motions with a low velocity. 2. Mimic Freedrive motions. <!-- theme: danger --> > **DANGER** > > If the incoming joint configuration is set to maximum velocity, the movement to reach this incoming joint configuration > will be executed with maximum speed regardless of safety zones and mechanical limits.
10810
+ * <!-- theme: success --> > Websocket endpoint Sends the **commanded** state, e.g., joint positions, velocities, accelerations, torques, for each motion group of the virtual controller and sets the joint configuration. Use [planTrajectory](planTrajectory) and [executeTrajectory](executeTrajectory) to move motion groups on virtual controllers. Learn more about the [movement behavior of virtual controllers in comparison to physical controllers](executeTrajectory#movement-behavior). > **NOTE** > > Incoming joint configurations are not visualized and their velocity limits are not checked. #### Use cases 1. Creating a robotic application that dynamically adapts to the configured joints on the robot controller, using this stream to feed new joint configurations back to the motion groups.\\ The stream only sends data to the robot controller if a motion is executed.\\ If the robot controller\'s joint configuration differs too much from the incoming joint configuration, a following error occurs. Joint configurations that result in following errors are executed only for motions with a low velocity. 2. Mimic freedrive motions. <!-- theme: danger --> > **DANGER** > > If the incoming joint configuration is set to maximum velocity, the movement to reach this incoming joint configuration > will be executed with maximum speed regardless of safety zones and mechanical limits.
10811
10811
  * @summary Stream Joint Configuration
10812
10812
  * @param {string} cell Unique identifier addressing a cell in all API calls.
10813
10813
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -10828,7 +10828,7 @@ declare class VirtualControllerBehaviorApi extends BaseAPI {
10828
10828
  */
10829
10829
  getCycleTime(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<CycleTime, any>>;
10830
10830
  /**
10831
- * Get the current virtual controller behavior - please see the setter [setVirtualControllerBehavior](setVirtualControllerBehavior) and the enum for details.
10831
+ * Get the current virtual controller behavior. See [setVirtualControllerBehavior](setVirtualControllerBehavior) and the body for details.
10832
10832
  * @summary Get Behavior
10833
10833
  * @param {string} cell Unique identifier addressing a cell in all API calls.
10834
10834
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -10838,7 +10838,7 @@ declare class VirtualControllerBehaviorApi extends BaseAPI {
10838
10838
  */
10839
10839
  getVirtualControllerBehavior(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<Behavior, any>>;
10840
10840
  /**
10841
- * Set virtual controller behavior.
10841
+ * Set virtual controller behavior. See query parameters for details.
10842
10842
  * @summary Set Behavior
10843
10843
  * @param {string} cell Unique identifier addressing a cell in all API calls.
10844
10844
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -10865,7 +10865,7 @@ declare const VirtualControllerInputsOutputsApiAxiosParamCreator: (configuration
10865
10865
  */
10866
10866
  listIOs: (cell: string, controller: string, ios: Array<string>, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
10867
10867
  /**
10868
- * Lists the input/output descriptions of the virtual robot controller. The input/output descriptions contain information like name, type and unit. Available inputs/outputs are defined by the virtual robot controller. Each input/output has a unique identifier. If no identifiers are specified in the request, all available inputs/outputs are retrieved by this endpoint. Exception: When a filter (e.g., direction, value_type, group) is applied, only matching inputs/outputs are returned.
10868
+ * Lists the input/output descriptions of the virtual robot controller. The input/output descriptions contain information like name, type and unit.\\ Available inputs/outputs are defined by the virtual robot controller.\\ Each input/output has a unique identifier. - If no identifiers and no filters are specified in the request, all available inputs/outputs are retrieved by this endpoint. - If a filter, e.g., `direction`, `value_type`, `group` is applied, only matching inputs/outputs are returned.
10869
10869
  * @summary List Descriptions
10870
10870
  * @param {string} cell Unique identifier addressing a cell in all API calls.
10871
10871
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -10904,7 +10904,7 @@ declare const VirtualControllerInputsOutputsApiFp: (configuration?: Configuratio
10904
10904
  */
10905
10905
  listIOs(cell: string, controller: string, ios: Array<string>, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<IOValue>>>;
10906
10906
  /**
10907
- * Lists the input/output descriptions of the virtual robot controller. The input/output descriptions contain information like name, type and unit. Available inputs/outputs are defined by the virtual robot controller. Each input/output has a unique identifier. If no identifiers are specified in the request, all available inputs/outputs are retrieved by this endpoint. Exception: When a filter (e.g., direction, value_type, group) is applied, only matching inputs/outputs are returned.
10907
+ * Lists the input/output descriptions of the virtual robot controller. The input/output descriptions contain information like name, type and unit.\\ Available inputs/outputs are defined by the virtual robot controller.\\ Each input/output has a unique identifier. - If no identifiers and no filters are specified in the request, all available inputs/outputs are retrieved by this endpoint. - If a filter, e.g., `direction`, `value_type`, `group` is applied, only matching inputs/outputs are returned.
10908
10908
  * @summary List Descriptions
10909
10909
  * @param {string} cell Unique identifier addressing a cell in all API calls.
10910
10910
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -10943,7 +10943,7 @@ declare const VirtualControllerInputsOutputsApiFactory: (configuration?: Configu
10943
10943
  */
10944
10944
  listIOs(cell: string, controller: string, ios: Array<string>, options?: RawAxiosRequestConfig): AxiosPromise<Array<IOValue>>;
10945
10945
  /**
10946
- * Lists the input/output descriptions of the virtual robot controller. The input/output descriptions contain information like name, type and unit. Available inputs/outputs are defined by the virtual robot controller. Each input/output has a unique identifier. If no identifiers are specified in the request, all available inputs/outputs are retrieved by this endpoint. Exception: When a filter (e.g., direction, value_type, group) is applied, only matching inputs/outputs are returned.
10946
+ * Lists the input/output descriptions of the virtual robot controller. The input/output descriptions contain information like name, type and unit.\\ Available inputs/outputs are defined by the virtual robot controller.\\ Each input/output has a unique identifier. - If no identifiers and no filters are specified in the request, all available inputs/outputs are retrieved by this endpoint. - If a filter, e.g., `direction`, `value_type`, `group` is applied, only matching inputs/outputs are returned.
10947
10947
  * @summary List Descriptions
10948
10948
  * @param {string} cell Unique identifier addressing a cell in all API calls.
10949
10949
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -10985,7 +10985,7 @@ declare class VirtualControllerInputsOutputsApi extends BaseAPI {
10985
10985
  */
10986
10986
  listIOs(cell: string, controller: string, ios: Array<string>, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<IOValue[], any>>;
10987
10987
  /**
10988
- * Lists the input/output descriptions of the virtual robot controller. The input/output descriptions contain information like name, type and unit. Available inputs/outputs are defined by the virtual robot controller. Each input/output has a unique identifier. If no identifiers are specified in the request, all available inputs/outputs are retrieved by this endpoint. Exception: When a filter (e.g., direction, value_type, group) is applied, only matching inputs/outputs are returned.
10988
+ * Lists the input/output descriptions of the virtual robot controller. The input/output descriptions contain information like name, type and unit.\\ Available inputs/outputs are defined by the virtual robot controller.\\ Each input/output has a unique identifier. - If no identifiers and no filters are specified in the request, all available inputs/outputs are retrieved by this endpoint. - If a filter, e.g., `direction`, `value_type`, `group` is applied, only matching inputs/outputs are returned.
10989
10989
  * @summary List Descriptions
10990
10990
  * @param {string} cell Unique identifier addressing a cell in all API calls.
10991
10991
  * @param {string} controller Unique identifier to address a controller in the cell.