@wandelbots/nova-api 25.7.0-dev.2 → 25.7.0-dev.3

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.
Files changed (5) hide show
  1. package/package.json +1 -1
  2. package/v2/api.d.ts +596 -597
  3. package/v2/api.js +1254 -1218
  4. package/v2/api.js.map +1 -1
  5. package/v2/api.ts +1351 -1333
package/v2/api.d.ts CHANGED
@@ -210,7 +210,7 @@ export interface App {
210
210
  'diagnosis_path'?: string;
211
211
  }
212
212
  /**
213
- * ## BEHAVIOR_AUTOMATIC This is the default behavior. The motion group instantly takes any commanded joint configuration as actual joint state. Configures the compliance of the virtual robot with the normal ControllerState cycle time. If set, the virtual robot will act like a physical one, e.g. with a cycle time of 8ms to respond to a new joint state command. ## BEHAVIOR_AUTOMATIC_NOT_COMPLY_WITH_CYCLETIME Configures the compliance of the virtual robot with the normal ControllerState cycle time. If set, the robot will respond as fast as possible, limited only by software execution speed. Because of that the execution of a movement requires less time than with BEHAVIOR_AUTOMATIC. ## BEHAVIOR_EXTERNAL_SOURCE The external client is the only source of actual joint state changes. This mode is used to enable third party software indicating the current joint state via [externalJointsStream](externalJointsStream).
213
+ * ## 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).
214
214
  * @export
215
215
  * @enum {string}
216
216
  */
@@ -888,12 +888,6 @@ export type ConvexHullShapeTypeEnum = typeof ConvexHullShapeTypeEnum[keyof typeo
888
888
  * @interface CoordinateSystem
889
889
  */
890
890
  export interface CoordinateSystem {
891
- /**
892
- * Unique identifier of the coordinate system.
893
- * @type {string}
894
- * @memberof CoordinateSystem
895
- */
896
- 'coordinate_system': string;
897
891
  /**
898
892
  * Human readable name of this coordinate system.
899
893
  * @type {string}
@@ -924,19 +918,49 @@ export interface CoordinateSystem {
924
918
  * @memberof CoordinateSystem
925
919
  */
926
920
  'orientation_type'?: OrientationType;
921
+ /**
922
+ * Unique identifier of the coordinate system.
923
+ * @type {string}
924
+ * @memberof CoordinateSystem
925
+ */
926
+ 'coordinate_system': string;
927
927
  }
928
928
  /**
929
929
  *
930
930
  * @export
931
- * @interface CoordinateSystems
931
+ * @interface CoordinateSystemData
932
932
  */
933
- export interface CoordinateSystems {
933
+ export interface CoordinateSystemData {
934
+ /**
935
+ * Human readable name of this coordinate system.
936
+ * @type {string}
937
+ * @memberof CoordinateSystemData
938
+ */
939
+ 'name'?: string;
940
+ /**
941
+ * The identifier of the reference coordinate system. Empty if world is used.
942
+ * @type {string}
943
+ * @memberof CoordinateSystemData
944
+ */
945
+ 'reference_coordinate_system'?: string;
946
+ /**
947
+ * A three-dimensional vector [x, y, z] with double precision.
948
+ * @type {Array<number>}
949
+ * @memberof CoordinateSystemData
950
+ */
951
+ 'position'?: Array<number>;
952
+ /**
953
+ * Describes an orientation in 3D space. A tree-to-four-dimensional vector [x, y, z, w] with double precision.
954
+ * @type {Array<number>}
955
+ * @memberof CoordinateSystemData
956
+ */
957
+ 'orientation'?: Array<number>;
934
958
  /**
935
959
  *
936
- * @type {Array<CoordinateSystem>}
937
- * @memberof CoordinateSystems
960
+ * @type {OrientationType}
961
+ * @memberof CoordinateSystemData
938
962
  */
939
- 'coordinate_systems': Array<CoordinateSystem>;
963
+ 'orientation_type'?: OrientationType;
940
964
  }
941
965
  /**
942
966
  *
@@ -1138,41 +1162,23 @@ export interface ExternalJointStreamDatapoint {
1138
1162
  'motion_group': string;
1139
1163
  /**
1140
1164
  *
1141
- * @type {ExternalJointStreamDatapointValue}
1165
+ * @type {MotionGroupJoints}
1142
1166
  * @memberof ExternalJointStreamDatapoint
1143
1167
  */
1144
- 'value': ExternalJointStreamDatapointValue;
1168
+ 'value': MotionGroupJoints;
1145
1169
  }
1146
1170
  /**
1147
- * The joint-values of the external joint stream datapoint.
1171
+ *
1148
1172
  * @export
1149
- * @interface ExternalJointStreamDatapointValue
1173
+ * @interface ExternalJointStreamRequest
1150
1174
  */
1151
- export interface ExternalJointStreamDatapointValue {
1152
- /**
1153
- * The joint positions of the robot.
1154
- * @type {Array<number>}
1155
- * @memberof ExternalJointStreamDatapointValue
1156
- */
1157
- 'positions': Array<number>;
1158
- /**
1159
- * The joint velocities of the robot.
1160
- * @type {Array<number>}
1161
- * @memberof ExternalJointStreamDatapointValue
1162
- */
1163
- 'velocities': Array<number>;
1164
- /**
1165
- * The joint accelerations of the robot.
1166
- * @type {Array<number>}
1167
- * @memberof ExternalJointStreamDatapointValue
1168
- */
1169
- 'accelerations': Array<number>;
1175
+ export interface ExternalJointStreamRequest {
1170
1176
  /**
1171
- * The joint torques of the robot.
1172
- * @type {Array<number>}
1173
- * @memberof ExternalJointStreamDatapointValue
1177
+ *
1178
+ * @type {Array<ExternalJointStreamDatapoint>}
1179
+ * @memberof ExternalJointStreamRequest
1174
1180
  */
1175
- 'torques': Array<number>;
1181
+ 'states': Array<ExternalJointStreamDatapoint>;
1176
1182
  }
1177
1183
  /**
1178
1184
  * The configuration of a physical FANUC robot controller has to contain IP address of the controller.
@@ -2334,19 +2340,6 @@ export interface LimitsOverride {
2334
2340
  */
2335
2341
  'tcp_orientation_acceleration_limit'?: number;
2336
2342
  }
2337
- /**
2338
- *
2339
- * @export
2340
- * @interface ListCoordinateSystemsResponse
2341
- */
2342
- export interface ListCoordinateSystemsResponse {
2343
- /**
2344
- *
2345
- * @type {Array<CoordinateSystem>}
2346
- * @memberof ListCoordinateSystemsResponse
2347
- */
2348
- 'coordinatesystems'?: Array<CoordinateSystem>;
2349
- }
2350
2343
  /**
2351
2344
  *
2352
2345
  * @export
@@ -2428,19 +2421,6 @@ export type MotionCommandBlending = BlendingAuto | BlendingPosition;
2428
2421
  * @export
2429
2422
  */
2430
2423
  export type MotionCommandPath = PathCartesianPTP | PathCircle | PathCubicSpline | PathJointPTP | PathLine;
2431
- /**
2432
- *
2433
- * @export
2434
- * @interface MotionGroupBehaviorGetter
2435
- */
2436
- export interface MotionGroupBehaviorGetter {
2437
- /**
2438
- *
2439
- * @type {Behavior}
2440
- * @memberof MotionGroupBehaviorGetter
2441
- */
2442
- 'behavior': Behavior;
2443
- }
2444
2424
  /**
2445
2425
  * The configuration of a motion-group used for motion planning.
2446
2426
  * @export
@@ -2452,7 +2432,7 @@ export interface MotionGroupDescription {
2452
2432
  * @type {string}
2453
2433
  * @memberof MotionGroupDescription
2454
2434
  */
2455
- 'motion_group_type': string;
2435
+ 'motion_group_model': string;
2456
2436
  /**
2457
2437
  * The offset from the world frame to the motion group base.
2458
2438
  * @type {Pose}
@@ -2545,19 +2525,6 @@ export interface MotionGroupInfo {
2545
2525
  */
2546
2526
  'dof': number;
2547
2527
  }
2548
- /**
2549
- *
2550
- * @export
2551
- * @interface MotionGroupInfos
2552
- */
2553
- export interface MotionGroupInfos {
2554
- /**
2555
- *
2556
- * @type {Array<MotionGroupInfo>}
2557
- * @memberof MotionGroupInfos
2558
- */
2559
- 'motion_groups': Array<MotionGroupInfo>;
2560
- }
2561
2528
  /**
2562
2529
  * Ensure to provide one value for each joint. See [getMotionGroups](getMotionGroups) for the number of joints. Everything but positions is optional.
2563
2530
  * @export
@@ -2719,7 +2686,7 @@ export interface MovementErrorResponse {
2719
2686
  'kind': MovementErrorResponseKindEnum;
2720
2687
  }
2721
2688
  export declare const MovementErrorResponseKindEnum: {
2722
- readonly Error: "ERROR";
2689
+ readonly MotionError: "MOTION_ERROR";
2723
2690
  };
2724
2691
  export type MovementErrorResponseKindEnum = typeof MovementErrorResponseKindEnum[keyof typeof MovementErrorResponseKindEnum];
2725
2692
  /**
@@ -3574,12 +3541,6 @@ export type RobotSystemMode = typeof RobotSystemMode[keyof typeof RobotSystemMod
3574
3541
  * @interface RobotTcp
3575
3542
  */
3576
3543
  export interface RobotTcp {
3577
- /**
3578
- * Identifier of this tcp.
3579
- * @type {string}
3580
- * @memberof RobotTcp
3581
- */
3582
- 'id': string;
3583
3544
  /**
3584
3545
  * A readable and changeable name for frontend visualization.
3585
3546
  * @type {string}
@@ -3604,19 +3565,43 @@ export interface RobotTcp {
3604
3565
  * @memberof RobotTcp
3605
3566
  */
3606
3567
  'orientation_type'?: OrientationType;
3568
+ /**
3569
+ * Identifier of this tcp.
3570
+ * @type {string}
3571
+ * @memberof RobotTcp
3572
+ */
3573
+ 'id': string;
3607
3574
  }
3608
3575
  /**
3609
3576
  *
3610
3577
  * @export
3611
- * @interface RobotTcps
3578
+ * @interface RobotTcpData
3612
3579
  */
3613
- export interface RobotTcps {
3580
+ export interface RobotTcpData {
3581
+ /**
3582
+ * A readable and changeable name for frontend visualization.
3583
+ * @type {string}
3584
+ * @memberof RobotTcpData
3585
+ */
3586
+ 'name'?: string;
3587
+ /**
3588
+ * A three-dimensional vector [x, y, z] with double precision.
3589
+ * @type {Array<number>}
3590
+ * @memberof RobotTcpData
3591
+ */
3592
+ 'position': Array<number>;
3593
+ /**
3594
+ * Describes an orientation in 3D space. A tree-to-four-dimensional vector [x, y, z, w] with double precision.
3595
+ * @type {Array<number>}
3596
+ * @memberof RobotTcpData
3597
+ */
3598
+ 'orientation'?: Array<number>;
3614
3599
  /**
3615
3600
  *
3616
- * @type {Array<RobotTcp>}
3617
- * @memberof RobotTcps
3601
+ * @type {OrientationType}
3602
+ * @memberof RobotTcpData
3618
3603
  */
3619
- 'tcps': Array<RobotTcp>;
3604
+ 'orientation_type'?: OrientationType;
3620
3605
  }
3621
3606
  /**
3622
3607
  *
@@ -5287,7 +5272,7 @@ export declare const ControllerApiFp: (configuration?: Configuration) => {
5287
5272
  * @param {*} [options] Override http request option.
5288
5273
  * @throws {RequiredError}
5289
5274
  */
5290
- listCoordinateSystems(cell: string, controller: string, orientationType?: OrientationType, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListCoordinateSystemsResponse>>;
5275
+ listCoordinateSystems(cell: string, controller: string, orientationType?: OrientationType, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<CoordinateSystem>>>;
5291
5276
  /**
5292
5277
  * List the names of all deployed robot controllers.
5293
5278
  * @summary List Robot Controllers
@@ -5428,7 +5413,7 @@ export declare const ControllerApiFactory: (configuration?: Configuration, baseP
5428
5413
  * @param {*} [options] Override http request option.
5429
5414
  * @throws {RequiredError}
5430
5415
  */
5431
- listCoordinateSystems(cell: string, controller: string, orientationType?: OrientationType, options?: RawAxiosRequestConfig): AxiosPromise<ListCoordinateSystemsResponse>;
5416
+ listCoordinateSystems(cell: string, controller: string, orientationType?: OrientationType, options?: RawAxiosRequestConfig): AxiosPromise<Array<CoordinateSystem>>;
5432
5417
  /**
5433
5418
  * List the names of all deployed robot controllers.
5434
5419
  * @summary List Robot Controllers
@@ -5580,7 +5565,7 @@ export declare class ControllerApi extends BaseAPI {
5580
5565
  * @throws {RequiredError}
5581
5566
  * @memberof ControllerApi
5582
5567
  */
5583
- listCoordinateSystems(cell: string, controller: string, orientationType?: OrientationType, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ListCoordinateSystemsResponse, any>>;
5568
+ listCoordinateSystems(cell: string, controller: string, orientationType?: OrientationType, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CoordinateSystem[], any>>;
5584
5569
  /**
5585
5570
  * List the names of all deployed robot controllers.
5586
5571
  * @summary List Robot Controllers
@@ -5888,11 +5873,12 @@ export declare const JoggingApiAxiosParamCreator: (configuration?: Configuration
5888
5873
  * <!-- 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.
5889
5874
  * @summary Execute Jogging
5890
5875
  * @param {string} cell Unique identifier addressing a cell in all API calls.
5876
+ * @param {string} controller Unique identifier to address a controller in the cell.
5891
5877
  * @param {ExecuteJoggingRequest} executeJoggingRequest
5892
5878
  * @param {*} [options] Override http request option.
5893
5879
  * @throws {RequiredError}
5894
5880
  */
5895
- executeJogging: (cell: string, executeJoggingRequest: ExecuteJoggingRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
5881
+ executeJogging: (cell: string, controller: string, executeJoggingRequest: ExecuteJoggingRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
5896
5882
  };
5897
5883
  /**
5898
5884
  * JoggingApi - functional programming interface
@@ -5903,11 +5889,12 @@ export declare const JoggingApiFp: (configuration?: Configuration) => {
5903
5889
  * <!-- 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.
5904
5890
  * @summary Execute Jogging
5905
5891
  * @param {string} cell Unique identifier addressing a cell in all API calls.
5892
+ * @param {string} controller Unique identifier to address a controller in the cell.
5906
5893
  * @param {ExecuteJoggingRequest} executeJoggingRequest
5907
5894
  * @param {*} [options] Override http request option.
5908
5895
  * @throws {RequiredError}
5909
5896
  */
5910
- executeJogging(cell: string, executeJoggingRequest: ExecuteJoggingRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ExecuteJoggingResponse>>;
5897
+ executeJogging(cell: string, controller: string, executeJoggingRequest: ExecuteJoggingRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ExecuteJoggingResponse>>;
5911
5898
  };
5912
5899
  /**
5913
5900
  * JoggingApi - factory interface
@@ -5918,11 +5905,12 @@ export declare const JoggingApiFactory: (configuration?: Configuration, basePath
5918
5905
  * <!-- 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.
5919
5906
  * @summary Execute Jogging
5920
5907
  * @param {string} cell Unique identifier addressing a cell in all API calls.
5908
+ * @param {string} controller Unique identifier to address a controller in the cell.
5921
5909
  * @param {ExecuteJoggingRequest} executeJoggingRequest
5922
5910
  * @param {*} [options] Override http request option.
5923
5911
  * @throws {RequiredError}
5924
5912
  */
5925
- executeJogging(cell: string, executeJoggingRequest: ExecuteJoggingRequest, options?: RawAxiosRequestConfig): AxiosPromise<ExecuteJoggingResponse>;
5913
+ executeJogging(cell: string, controller: string, executeJoggingRequest: ExecuteJoggingRequest, options?: RawAxiosRequestConfig): AxiosPromise<ExecuteJoggingResponse>;
5926
5914
  };
5927
5915
  /**
5928
5916
  * JoggingApi - object-oriented interface
@@ -5935,12 +5923,13 @@ export declare class JoggingApi extends BaseAPI {
5935
5923
  * <!-- 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.
5936
5924
  * @summary Execute Jogging
5937
5925
  * @param {string} cell Unique identifier addressing a cell in all API calls.
5926
+ * @param {string} controller Unique identifier to address a controller in the cell.
5938
5927
  * @param {ExecuteJoggingRequest} executeJoggingRequest
5939
5928
  * @param {*} [options] Override http request option.
5940
5929
  * @throws {RequiredError}
5941
5930
  * @memberof JoggingApi
5942
5931
  */
5943
- executeJogging(cell: string, executeJoggingRequest: ExecuteJoggingRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ExecuteJoggingResponse, any>>;
5932
+ executeJogging(cell: string, controller: string, executeJoggingRequest: ExecuteJoggingRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ExecuteJoggingResponse, any>>;
5944
5933
  }
5945
5934
  /**
5946
5935
  * KinematicsApi - axios parameter creator
@@ -6160,32 +6149,35 @@ export declare const MotionGroupApiAxiosParamCreator: (configuration?: Configura
6160
6149
  * Returns the current state of the selected motion group including the current joint position, velocity, pose, and more.
6161
6150
  * @summary State
6162
6151
  * @param {string} cell Unique identifier addressing a cell in all API calls.
6152
+ * @param {string} controller Unique identifier to address a controller in the cell.
6163
6153
  * @param {string} motionGroup The motion-group identifier.
6164
6154
  * @param {string} [responseCoordinateSystem] Unique identifier addressing a coordinate system to which the responses should be converted. If not set, world coordinate system is used.
6165
6155
  * @param {*} [options] Override http request option.
6166
6156
  * @throws {RequiredError}
6167
6157
  */
6168
- getCurrentMotionGroupState: (cell: string, motionGroup: string, responseCoordinateSystem?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
6158
+ getCurrentMotionGroupState: (cell: string, controller: string, motionGroup: string, responseCoordinateSystem?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
6169
6159
  /**
6170
6160
  * 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.
6171
6161
  * @summary Description
6172
6162
  * @param {string} cell Unique identifier addressing a cell in all API calls.
6163
+ * @param {string} controller Unique identifier to address a controller in the cell.
6173
6164
  * @param {string} motionGroup The motion-group identifier.
6174
6165
  * @param {*} [options] Override http request option.
6175
6166
  * @throws {RequiredError}
6176
6167
  */
6177
- getMotionGroupDescription: (cell: string, motionGroup: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
6168
+ getMotionGroupDescription: (cell: string, controller: string, motionGroup: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
6178
6169
  /**
6179
6170
  * <!-- theme: danger --> > Websocket endpoint Receive updates of the motion group state. The stream will be closed from the server if the controller is disconnected.
6180
6171
  * @summary Stream State
6181
6172
  * @param {string} cell Unique identifier addressing a cell in all API calls.
6173
+ * @param {string} controller Unique identifier to address a controller in the cell.
6182
6174
  * @param {string} motionGroup The motion-group identifier.
6183
6175
  * @param {number} [responseRate] Update rate for the response message in milliseconds (ms). Default is 200 ms. We recommend to use the step rate of the controller or a multiple of the step rate as NOVA updates the state in the controller\&#39;s step rate as well. Minimal response rate is the step rate of controller.
6184
6176
  * @param {string} [responseCoordinateSystem] Unique identifier addressing a coordinate system to which the cartesian data of the responses should be converted. Default is the world coordinate system.
6185
6177
  * @param {*} [options] Override http request option.
6186
6178
  * @throws {RequiredError}
6187
6179
  */
6188
- streamMotionGroupState: (cell: string, motionGroup: string, responseRate?: number, responseCoordinateSystem?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
6180
+ streamMotionGroupState: (cell: string, controller: string, motionGroup: string, responseRate?: number, responseCoordinateSystem?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
6189
6181
  };
6190
6182
  /**
6191
6183
  * MotionGroupApi - functional programming interface
@@ -6196,32 +6188,35 @@ export declare const MotionGroupApiFp: (configuration?: Configuration) => {
6196
6188
  * Returns the current state of the selected motion group including the current joint position, velocity, pose, and more.
6197
6189
  * @summary State
6198
6190
  * @param {string} cell Unique identifier addressing a cell in all API calls.
6191
+ * @param {string} controller Unique identifier to address a controller in the cell.
6199
6192
  * @param {string} motionGroup The motion-group identifier.
6200
6193
  * @param {string} [responseCoordinateSystem] Unique identifier addressing a coordinate system to which the responses should be converted. If not set, world coordinate system is used.
6201
6194
  * @param {*} [options] Override http request option.
6202
6195
  * @throws {RequiredError}
6203
6196
  */
6204
- getCurrentMotionGroupState(cell: string, motionGroup: string, responseCoordinateSystem?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<MotionGroupState>>;
6197
+ getCurrentMotionGroupState(cell: string, controller: string, motionGroup: string, responseCoordinateSystem?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<MotionGroupState>>;
6205
6198
  /**
6206
6199
  * 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.
6207
6200
  * @summary Description
6208
6201
  * @param {string} cell Unique identifier addressing a cell in all API calls.
6202
+ * @param {string} controller Unique identifier to address a controller in the cell.
6209
6203
  * @param {string} motionGroup The motion-group identifier.
6210
6204
  * @param {*} [options] Override http request option.
6211
6205
  * @throws {RequiredError}
6212
6206
  */
6213
- getMotionGroupDescription(cell: string, motionGroup: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<MotionGroupDescription>>;
6207
+ getMotionGroupDescription(cell: string, controller: string, motionGroup: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<MotionGroupDescription>>;
6214
6208
  /**
6215
6209
  * <!-- theme: danger --> > Websocket endpoint Receive updates of the motion group state. The stream will be closed from the server if the controller is disconnected.
6216
6210
  * @summary Stream State
6217
6211
  * @param {string} cell Unique identifier addressing a cell in all API calls.
6212
+ * @param {string} controller Unique identifier to address a controller in the cell.
6218
6213
  * @param {string} motionGroup The motion-group identifier.
6219
6214
  * @param {number} [responseRate] Update rate for the response message in milliseconds (ms). Default is 200 ms. We recommend to use the step rate of the controller or a multiple of the step rate as NOVA updates the state in the controller\&#39;s step rate as well. Minimal response rate is the step rate of controller.
6220
6215
  * @param {string} [responseCoordinateSystem] Unique identifier addressing a coordinate system to which the cartesian data of the responses should be converted. Default is the world coordinate system.
6221
6216
  * @param {*} [options] Override http request option.
6222
6217
  * @throws {RequiredError}
6223
6218
  */
6224
- streamMotionGroupState(cell: string, motionGroup: string, responseRate?: number, responseCoordinateSystem?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<MotionGroupState>>;
6219
+ streamMotionGroupState(cell: string, controller: string, motionGroup: string, responseRate?: number, responseCoordinateSystem?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<MotionGroupState>>;
6225
6220
  };
6226
6221
  /**
6227
6222
  * MotionGroupApi - factory interface
@@ -6232,32 +6227,35 @@ export declare const MotionGroupApiFactory: (configuration?: Configuration, base
6232
6227
  * Returns the current state of the selected motion group including the current joint position, velocity, pose, and more.
6233
6228
  * @summary State
6234
6229
  * @param {string} cell Unique identifier addressing a cell in all API calls.
6230
+ * @param {string} controller Unique identifier to address a controller in the cell.
6235
6231
  * @param {string} motionGroup The motion-group identifier.
6236
6232
  * @param {string} [responseCoordinateSystem] Unique identifier addressing a coordinate system to which the responses should be converted. If not set, world coordinate system is used.
6237
6233
  * @param {*} [options] Override http request option.
6238
6234
  * @throws {RequiredError}
6239
6235
  */
6240
- getCurrentMotionGroupState(cell: string, motionGroup: string, responseCoordinateSystem?: string, options?: RawAxiosRequestConfig): AxiosPromise<MotionGroupState>;
6236
+ getCurrentMotionGroupState(cell: string, controller: string, motionGroup: string, responseCoordinateSystem?: string, options?: RawAxiosRequestConfig): AxiosPromise<MotionGroupState>;
6241
6237
  /**
6242
6238
  * 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.
6243
6239
  * @summary Description
6244
6240
  * @param {string} cell Unique identifier addressing a cell in all API calls.
6241
+ * @param {string} controller Unique identifier to address a controller in the cell.
6245
6242
  * @param {string} motionGroup The motion-group identifier.
6246
6243
  * @param {*} [options] Override http request option.
6247
6244
  * @throws {RequiredError}
6248
6245
  */
6249
- getMotionGroupDescription(cell: string, motionGroup: string, options?: RawAxiosRequestConfig): AxiosPromise<MotionGroupDescription>;
6246
+ getMotionGroupDescription(cell: string, controller: string, motionGroup: string, options?: RawAxiosRequestConfig): AxiosPromise<MotionGroupDescription>;
6250
6247
  /**
6251
6248
  * <!-- theme: danger --> > Websocket endpoint Receive updates of the motion group state. The stream will be closed from the server if the controller is disconnected.
6252
6249
  * @summary Stream State
6253
6250
  * @param {string} cell Unique identifier addressing a cell in all API calls.
6251
+ * @param {string} controller Unique identifier to address a controller in the cell.
6254
6252
  * @param {string} motionGroup The motion-group identifier.
6255
6253
  * @param {number} [responseRate] Update rate for the response message in milliseconds (ms). Default is 200 ms. We recommend to use the step rate of the controller or a multiple of the step rate as NOVA updates the state in the controller\&#39;s step rate as well. Minimal response rate is the step rate of controller.
6256
6254
  * @param {string} [responseCoordinateSystem] Unique identifier addressing a coordinate system to which the cartesian data of the responses should be converted. Default is the world coordinate system.
6257
6255
  * @param {*} [options] Override http request option.
6258
6256
  * @throws {RequiredError}
6259
6257
  */
6260
- streamMotionGroupState(cell: string, motionGroup: string, responseRate?: number, responseCoordinateSystem?: string, options?: RawAxiosRequestConfig): AxiosPromise<MotionGroupState>;
6258
+ streamMotionGroupState(cell: string, controller: string, motionGroup: string, responseRate?: number, responseCoordinateSystem?: string, options?: RawAxiosRequestConfig): AxiosPromise<MotionGroupState>;
6261
6259
  };
6262
6260
  /**
6263
6261
  * MotionGroupApi - object-oriented interface
@@ -6270,27 +6268,30 @@ export declare class MotionGroupApi extends BaseAPI {
6270
6268
  * Returns the current state of the selected motion group including the current joint position, velocity, pose, and more.
6271
6269
  * @summary State
6272
6270
  * @param {string} cell Unique identifier addressing a cell in all API calls.
6271
+ * @param {string} controller Unique identifier to address a controller in the cell.
6273
6272
  * @param {string} motionGroup The motion-group identifier.
6274
6273
  * @param {string} [responseCoordinateSystem] Unique identifier addressing a coordinate system to which the responses should be converted. If not set, world coordinate system is used.
6275
6274
  * @param {*} [options] Override http request option.
6276
6275
  * @throws {RequiredError}
6277
6276
  * @memberof MotionGroupApi
6278
6277
  */
6279
- getCurrentMotionGroupState(cell: string, motionGroup: string, responseCoordinateSystem?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<MotionGroupState, any>>;
6278
+ getCurrentMotionGroupState(cell: string, controller: string, motionGroup: string, responseCoordinateSystem?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<MotionGroupState, any>>;
6280
6279
  /**
6281
6280
  * 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.
6282
6281
  * @summary Description
6283
6282
  * @param {string} cell Unique identifier addressing a cell in all API calls.
6283
+ * @param {string} controller Unique identifier to address a controller in the cell.
6284
6284
  * @param {string} motionGroup The motion-group identifier.
6285
6285
  * @param {*} [options] Override http request option.
6286
6286
  * @throws {RequiredError}
6287
6287
  * @memberof MotionGroupApi
6288
6288
  */
6289
- getMotionGroupDescription(cell: string, motionGroup: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<MotionGroupDescription, any>>;
6289
+ getMotionGroupDescription(cell: string, controller: string, motionGroup: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<MotionGroupDescription, any>>;
6290
6290
  /**
6291
6291
  * <!-- theme: danger --> > Websocket endpoint Receive updates of the motion group state. The stream will be closed from the server if the controller is disconnected.
6292
6292
  * @summary Stream State
6293
6293
  * @param {string} cell Unique identifier addressing a cell in all API calls.
6294
+ * @param {string} controller Unique identifier to address a controller in the cell.
6294
6295
  * @param {string} motionGroup The motion-group identifier.
6295
6296
  * @param {number} [responseRate] Update rate for the response message in milliseconds (ms). Default is 200 ms. We recommend to use the step rate of the controller or a multiple of the step rate as NOVA updates the state in the controller\&#39;s step rate as well. Minimal response rate is the step rate of controller.
6296
6297
  * @param {string} [responseCoordinateSystem] Unique identifier addressing a coordinate system to which the cartesian data of the responses should be converted. Default is the world coordinate system.
@@ -6298,7 +6299,7 @@ export declare class MotionGroupApi extends BaseAPI {
6298
6299
  * @throws {RequiredError}
6299
6300
  * @memberof MotionGroupApi
6300
6301
  */
6301
- streamMotionGroupState(cell: string, motionGroup: string, responseRate?: number, responseCoordinateSystem?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<MotionGroupState, any>>;
6302
+ streamMotionGroupState(cell: string, controller: string, motionGroup: string, responseRate?: number, responseCoordinateSystem?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<MotionGroupState, any>>;
6302
6303
  }
6303
6304
  /**
6304
6305
  * MotionGroupModelsApi - axios parameter creator
@@ -7710,45 +7711,50 @@ export declare const TrajectoryCachingApiAxiosParamCreator: (configuration?: Con
7710
7711
  * <!-- 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.
7711
7712
  * @summary Add Trajectory
7712
7713
  * @param {string} cell Unique identifier addressing a cell in all API calls.
7714
+ * @param {string} controller Unique identifier to address a controller in the cell.
7713
7715
  * @param {AddTrajectoryRequest} addTrajectoryRequest
7714
7716
  * @param {*} [options] Override http request option.
7715
7717
  * @throws {RequiredError}
7716
7718
  */
7717
- addTrajectory: (cell: string, addTrajectoryRequest: AddTrajectoryRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
7719
+ addTrajectory: (cell: string, controller: string, addTrajectoryRequest: AddTrajectoryRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
7718
7720
  /**
7719
7721
  * Clear the trajectory cache.
7720
7722
  * @summary Clear Trajectories
7721
7723
  * @param {string} cell Unique identifier addressing a cell in all API calls.
7724
+ * @param {string} controller Unique identifier to address a controller in the cell.
7722
7725
  * @param {*} [options] Override http request option.
7723
7726
  * @throws {RequiredError}
7724
7727
  */
7725
- clearTrajectories: (cell: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
7728
+ clearTrajectories: (cell: string, controller: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
7726
7729
  /**
7727
7730
  * 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.
7728
7731
  * @summary Delete Trajectory
7729
7732
  * @param {string} cell Unique identifier addressing a cell in all API calls.
7733
+ * @param {string} controller Unique identifier to address a controller in the cell.
7730
7734
  * @param {string} trajectory This represents the unique identifier of a trajectory. Every executable or partially executable trajectory is cached and an unique identifier is returned. Indicate the unique identifier to execute the trajectory or retrieve information on the trajectory.
7731
7735
  * @param {*} [options] Override http request option.
7732
7736
  * @throws {RequiredError}
7733
7737
  */
7734
- deleteTrajectory: (cell: string, trajectory: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
7738
+ deleteTrajectory: (cell: string, controller: string, trajectory: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
7735
7739
  /**
7736
7740
  * Get a previously created trajectory from cache. Use [listTrajectories](listTrajectories) to list all cached trajectories.
7737
7741
  * @summary Get Trajectory
7738
7742
  * @param {string} cell Unique identifier addressing a cell in all API calls.
7743
+ * @param {string} controller Unique identifier to address a controller in the cell.
7739
7744
  * @param {string} trajectory This represents the unique identifier of a trajectory. Every executable or partially executable trajectory is cached and an unique identifier is returned. Indicate the unique identifier to execute the trajectory or retrieve information on the trajectory.
7740
7745
  * @param {*} [options] Override http request option.
7741
7746
  * @throws {RequiredError}
7742
7747
  */
7743
- getTrajectory: (cell: string, trajectory: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
7748
+ getTrajectory: (cell: string, controller: string, trajectory: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
7744
7749
  /**
7745
7750
  * 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.
7746
7751
  * @summary List Trajectories
7747
7752
  * @param {string} cell Unique identifier addressing a cell in all API calls.
7753
+ * @param {string} controller Unique identifier to address a controller in the cell.
7748
7754
  * @param {*} [options] Override http request option.
7749
7755
  * @throws {RequiredError}
7750
7756
  */
7751
- listTrajectories: (cell: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
7757
+ listTrajectories: (cell: string, controller: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
7752
7758
  };
7753
7759
  /**
7754
7760
  * TrajectoryCachingApi - functional programming interface
@@ -7759,45 +7765,50 @@ export declare const TrajectoryCachingApiFp: (configuration?: Configuration) =>
7759
7765
  * <!-- 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.
7760
7766
  * @summary Add Trajectory
7761
7767
  * @param {string} cell Unique identifier addressing a cell in all API calls.
7768
+ * @param {string} controller Unique identifier to address a controller in the cell.
7762
7769
  * @param {AddTrajectoryRequest} addTrajectoryRequest
7763
7770
  * @param {*} [options] Override http request option.
7764
7771
  * @throws {RequiredError}
7765
7772
  */
7766
- addTrajectory(cell: string, addTrajectoryRequest: AddTrajectoryRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AddTrajectoryResponse>>;
7773
+ addTrajectory(cell: string, controller: string, addTrajectoryRequest: AddTrajectoryRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AddTrajectoryResponse>>;
7767
7774
  /**
7768
7775
  * Clear the trajectory cache.
7769
7776
  * @summary Clear Trajectories
7770
7777
  * @param {string} cell Unique identifier addressing a cell in all API calls.
7778
+ * @param {string} controller Unique identifier to address a controller in the cell.
7771
7779
  * @param {*} [options] Override http request option.
7772
7780
  * @throws {RequiredError}
7773
7781
  */
7774
- clearTrajectories(cell: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
7782
+ clearTrajectories(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
7775
7783
  /**
7776
7784
  * 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.
7777
7785
  * @summary Delete Trajectory
7778
7786
  * @param {string} cell Unique identifier addressing a cell in all API calls.
7787
+ * @param {string} controller Unique identifier to address a controller in the cell.
7779
7788
  * @param {string} trajectory This represents the unique identifier of a trajectory. Every executable or partially executable trajectory is cached and an unique identifier is returned. Indicate the unique identifier to execute the trajectory or retrieve information on the trajectory.
7780
7789
  * @param {*} [options] Override http request option.
7781
7790
  * @throws {RequiredError}
7782
7791
  */
7783
- deleteTrajectory(cell: string, trajectory: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
7792
+ deleteTrajectory(cell: string, controller: string, trajectory: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
7784
7793
  /**
7785
7794
  * Get a previously created trajectory from cache. Use [listTrajectories](listTrajectories) to list all cached trajectories.
7786
7795
  * @summary Get Trajectory
7787
7796
  * @param {string} cell Unique identifier addressing a cell in all API calls.
7797
+ * @param {string} controller Unique identifier to address a controller in the cell.
7788
7798
  * @param {string} trajectory This represents the unique identifier of a trajectory. Every executable or partially executable trajectory is cached and an unique identifier is returned. Indicate the unique identifier to execute the trajectory or retrieve information on the trajectory.
7789
7799
  * @param {*} [options] Override http request option.
7790
7800
  * @throws {RequiredError}
7791
7801
  */
7792
- getTrajectory(cell: string, trajectory: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetTrajectoryResponse>>;
7802
+ getTrajectory(cell: string, controller: string, trajectory: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetTrajectoryResponse>>;
7793
7803
  /**
7794
7804
  * 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.
7795
7805
  * @summary List Trajectories
7796
7806
  * @param {string} cell Unique identifier addressing a cell in all API calls.
7807
+ * @param {string} controller Unique identifier to address a controller in the cell.
7797
7808
  * @param {*} [options] Override http request option.
7798
7809
  * @throws {RequiredError}
7799
7810
  */
7800
- listTrajectories(cell: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListTrajectoriesResponse>>;
7811
+ listTrajectories(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListTrajectoriesResponse>>;
7801
7812
  };
7802
7813
  /**
7803
7814
  * TrajectoryCachingApi - factory interface
@@ -7808,45 +7819,50 @@ export declare const TrajectoryCachingApiFactory: (configuration?: Configuration
7808
7819
  * <!-- 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.
7809
7820
  * @summary Add Trajectory
7810
7821
  * @param {string} cell Unique identifier addressing a cell in all API calls.
7822
+ * @param {string} controller Unique identifier to address a controller in the cell.
7811
7823
  * @param {AddTrajectoryRequest} addTrajectoryRequest
7812
7824
  * @param {*} [options] Override http request option.
7813
7825
  * @throws {RequiredError}
7814
7826
  */
7815
- addTrajectory(cell: string, addTrajectoryRequest: AddTrajectoryRequest, options?: RawAxiosRequestConfig): AxiosPromise<AddTrajectoryResponse>;
7827
+ addTrajectory(cell: string, controller: string, addTrajectoryRequest: AddTrajectoryRequest, options?: RawAxiosRequestConfig): AxiosPromise<AddTrajectoryResponse>;
7816
7828
  /**
7817
7829
  * Clear the trajectory cache.
7818
7830
  * @summary Clear Trajectories
7819
7831
  * @param {string} cell Unique identifier addressing a cell in all API calls.
7832
+ * @param {string} controller Unique identifier to address a controller in the cell.
7820
7833
  * @param {*} [options] Override http request option.
7821
7834
  * @throws {RequiredError}
7822
7835
  */
7823
- clearTrajectories(cell: string, options?: RawAxiosRequestConfig): AxiosPromise<void>;
7836
+ clearTrajectories(cell: string, controller: string, options?: RawAxiosRequestConfig): AxiosPromise<void>;
7824
7837
  /**
7825
7838
  * 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.
7826
7839
  * @summary Delete Trajectory
7827
7840
  * @param {string} cell Unique identifier addressing a cell in all API calls.
7841
+ * @param {string} controller Unique identifier to address a controller in the cell.
7828
7842
  * @param {string} trajectory This represents the unique identifier of a trajectory. Every executable or partially executable trajectory is cached and an unique identifier is returned. Indicate the unique identifier to execute the trajectory or retrieve information on the trajectory.
7829
7843
  * @param {*} [options] Override http request option.
7830
7844
  * @throws {RequiredError}
7831
7845
  */
7832
- deleteTrajectory(cell: string, trajectory: string, options?: RawAxiosRequestConfig): AxiosPromise<void>;
7846
+ deleteTrajectory(cell: string, controller: string, trajectory: string, options?: RawAxiosRequestConfig): AxiosPromise<void>;
7833
7847
  /**
7834
7848
  * Get a previously created trajectory from cache. Use [listTrajectories](listTrajectories) to list all cached trajectories.
7835
7849
  * @summary Get Trajectory
7836
7850
  * @param {string} cell Unique identifier addressing a cell in all API calls.
7851
+ * @param {string} controller Unique identifier to address a controller in the cell.
7837
7852
  * @param {string} trajectory This represents the unique identifier of a trajectory. Every executable or partially executable trajectory is cached and an unique identifier is returned. Indicate the unique identifier to execute the trajectory or retrieve information on the trajectory.
7838
7853
  * @param {*} [options] Override http request option.
7839
7854
  * @throws {RequiredError}
7840
7855
  */
7841
- getTrajectory(cell: string, trajectory: string, options?: RawAxiosRequestConfig): AxiosPromise<GetTrajectoryResponse>;
7856
+ getTrajectory(cell: string, controller: string, trajectory: string, options?: RawAxiosRequestConfig): AxiosPromise<GetTrajectoryResponse>;
7842
7857
  /**
7843
7858
  * 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.
7844
7859
  * @summary List Trajectories
7845
7860
  * @param {string} cell Unique identifier addressing a cell in all API calls.
7861
+ * @param {string} controller Unique identifier to address a controller in the cell.
7846
7862
  * @param {*} [options] Override http request option.
7847
7863
  * @throws {RequiredError}
7848
7864
  */
7849
- listTrajectories(cell: string, options?: RawAxiosRequestConfig): AxiosPromise<ListTrajectoriesResponse>;
7865
+ listTrajectories(cell: string, controller: string, options?: RawAxiosRequestConfig): AxiosPromise<ListTrajectoriesResponse>;
7850
7866
  };
7851
7867
  /**
7852
7868
  * TrajectoryCachingApi - object-oriented interface
@@ -7859,50 +7875,55 @@ export declare class TrajectoryCachingApi extends BaseAPI {
7859
7875
  * <!-- 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.
7860
7876
  * @summary Add Trajectory
7861
7877
  * @param {string} cell Unique identifier addressing a cell in all API calls.
7878
+ * @param {string} controller Unique identifier to address a controller in the cell.
7862
7879
  * @param {AddTrajectoryRequest} addTrajectoryRequest
7863
7880
  * @param {*} [options] Override http request option.
7864
7881
  * @throws {RequiredError}
7865
7882
  * @memberof TrajectoryCachingApi
7866
7883
  */
7867
- addTrajectory(cell: string, addTrajectoryRequest: AddTrajectoryRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AddTrajectoryResponse, any>>;
7884
+ addTrajectory(cell: string, controller: string, addTrajectoryRequest: AddTrajectoryRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AddTrajectoryResponse, any>>;
7868
7885
  /**
7869
7886
  * Clear the trajectory cache.
7870
7887
  * @summary Clear Trajectories
7871
7888
  * @param {string} cell Unique identifier addressing a cell in all API calls.
7889
+ * @param {string} controller Unique identifier to address a controller in the cell.
7872
7890
  * @param {*} [options] Override http request option.
7873
7891
  * @throws {RequiredError}
7874
7892
  * @memberof TrajectoryCachingApi
7875
7893
  */
7876
- clearTrajectories(cell: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
7894
+ clearTrajectories(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
7877
7895
  /**
7878
7896
  * 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.
7879
7897
  * @summary Delete Trajectory
7880
7898
  * @param {string} cell Unique identifier addressing a cell in all API calls.
7899
+ * @param {string} controller Unique identifier to address a controller in the cell.
7881
7900
  * @param {string} trajectory This represents the unique identifier of a trajectory. Every executable or partially executable trajectory is cached and an unique identifier is returned. Indicate the unique identifier to execute the trajectory or retrieve information on the trajectory.
7882
7901
  * @param {*} [options] Override http request option.
7883
7902
  * @throws {RequiredError}
7884
7903
  * @memberof TrajectoryCachingApi
7885
7904
  */
7886
- deleteTrajectory(cell: string, trajectory: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
7905
+ deleteTrajectory(cell: string, controller: string, trajectory: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
7887
7906
  /**
7888
7907
  * Get a previously created trajectory from cache. Use [listTrajectories](listTrajectories) to list all cached trajectories.
7889
7908
  * @summary Get Trajectory
7890
7909
  * @param {string} cell Unique identifier addressing a cell in all API calls.
7910
+ * @param {string} controller Unique identifier to address a controller in the cell.
7891
7911
  * @param {string} trajectory This represents the unique identifier of a trajectory. Every executable or partially executable trajectory is cached and an unique identifier is returned. Indicate the unique identifier to execute the trajectory or retrieve information on the trajectory.
7892
7912
  * @param {*} [options] Override http request option.
7893
7913
  * @throws {RequiredError}
7894
7914
  * @memberof TrajectoryCachingApi
7895
7915
  */
7896
- getTrajectory(cell: string, trajectory: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetTrajectoryResponse, any>>;
7916
+ getTrajectory(cell: string, controller: string, trajectory: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetTrajectoryResponse, any>>;
7897
7917
  /**
7898
7918
  * 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.
7899
7919
  * @summary List Trajectories
7900
7920
  * @param {string} cell Unique identifier addressing a cell in all API calls.
7921
+ * @param {string} controller Unique identifier to address a controller in the cell.
7901
7922
  * @param {*} [options] Override http request option.
7902
7923
  * @throws {RequiredError}
7903
7924
  * @memberof TrajectoryCachingApi
7904
7925
  */
7905
- listTrajectories(cell: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ListTrajectoriesResponse, any>>;
7926
+ listTrajectories(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ListTrajectoriesResponse, any>>;
7906
7927
  }
7907
7928
  /**
7908
7929
  * TrajectoryExecutionApi - axios parameter creator
@@ -7913,11 +7934,12 @@ export declare const TrajectoryExecutionApiAxiosParamCreator: (configuration?: C
7913
7934
  * <!-- 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.
7914
7935
  * @summary Execute Trajectory
7915
7936
  * @param {string} cell Unique identifier addressing a cell in all API calls.
7937
+ * @param {string} controller Unique identifier to address a controller in the cell.
7916
7938
  * @param {ExecuteTrajectoryRequest} executeTrajectoryRequest
7917
7939
  * @param {*} [options] Override http request option.
7918
7940
  * @throws {RequiredError}
7919
7941
  */
7920
- executeTrajectory: (cell: string, executeTrajectoryRequest: ExecuteTrajectoryRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
7942
+ executeTrajectory: (cell: string, controller: string, executeTrajectoryRequest: ExecuteTrajectoryRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
7921
7943
  };
7922
7944
  /**
7923
7945
  * TrajectoryExecutionApi - functional programming interface
@@ -7928,11 +7950,12 @@ export declare const TrajectoryExecutionApiFp: (configuration?: Configuration) =
7928
7950
  * <!-- 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.
7929
7951
  * @summary Execute Trajectory
7930
7952
  * @param {string} cell Unique identifier addressing a cell in all API calls.
7953
+ * @param {string} controller Unique identifier to address a controller in the cell.
7931
7954
  * @param {ExecuteTrajectoryRequest} executeTrajectoryRequest
7932
7955
  * @param {*} [options] Override http request option.
7933
7956
  * @throws {RequiredError}
7934
7957
  */
7935
- executeTrajectory(cell: string, executeTrajectoryRequest: ExecuteTrajectoryRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ExecuteTrajectoryResponse>>;
7958
+ executeTrajectory(cell: string, controller: string, executeTrajectoryRequest: ExecuteTrajectoryRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ExecuteTrajectoryResponse>>;
7936
7959
  };
7937
7960
  /**
7938
7961
  * TrajectoryExecutionApi - factory interface
@@ -7943,11 +7966,12 @@ export declare const TrajectoryExecutionApiFactory: (configuration?: Configurati
7943
7966
  * <!-- 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.
7944
7967
  * @summary Execute Trajectory
7945
7968
  * @param {string} cell Unique identifier addressing a cell in all API calls.
7969
+ * @param {string} controller Unique identifier to address a controller in the cell.
7946
7970
  * @param {ExecuteTrajectoryRequest} executeTrajectoryRequest
7947
7971
  * @param {*} [options] Override http request option.
7948
7972
  * @throws {RequiredError}
7949
7973
  */
7950
- executeTrajectory(cell: string, executeTrajectoryRequest: ExecuteTrajectoryRequest, options?: RawAxiosRequestConfig): AxiosPromise<ExecuteTrajectoryResponse>;
7974
+ executeTrajectory(cell: string, controller: string, executeTrajectoryRequest: ExecuteTrajectoryRequest, options?: RawAxiosRequestConfig): AxiosPromise<ExecuteTrajectoryResponse>;
7951
7975
  };
7952
7976
  /**
7953
7977
  * TrajectoryExecutionApi - object-oriented interface
@@ -7960,12 +7984,13 @@ export declare class TrajectoryExecutionApi extends BaseAPI {
7960
7984
  * <!-- 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.
7961
7985
  * @summary Execute Trajectory
7962
7986
  * @param {string} cell Unique identifier addressing a cell in all API calls.
7987
+ * @param {string} controller Unique identifier to address a controller in the cell.
7963
7988
  * @param {ExecuteTrajectoryRequest} executeTrajectoryRequest
7964
7989
  * @param {*} [options] Override http request option.
7965
7990
  * @throws {RequiredError}
7966
7991
  * @memberof TrajectoryExecutionApi
7967
7992
  */
7968
- executeTrajectory(cell: string, executeTrajectoryRequest: ExecuteTrajectoryRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ExecuteTrajectoryResponse, any>>;
7993
+ executeTrajectory(cell: string, controller: string, executeTrajectoryRequest: ExecuteTrajectoryRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ExecuteTrajectoryResponse, any>>;
7969
7994
  }
7970
7995
  /**
7971
7996
  * TrajectoryPlanningApi - axios parameter creator
@@ -8031,79 +8056,64 @@ export declare class TrajectoryPlanningApi extends BaseAPI {
8031
8056
  planTrajectory(cell: string, planTrajectoryRequest?: PlanTrajectoryRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<PlanTrajectoryResponse, any>>;
8032
8057
  }
8033
8058
  /**
8034
- * VirtualRobotApi - axios parameter creator
8059
+ * VirtualControllerApi - axios parameter creator
8035
8060
  * @export
8036
8061
  */
8037
- export declare const VirtualRobotApiAxiosParamCreator: (configuration?: Configuration) => {
8038
- /**
8039
- * Get the current motion group state which provides values for the joints\' position, velocity and acceleration.
8040
- * @summary Get Motion Group State
8041
- * @param {string} cell Unique identifier addressing a cell in all API calls.
8042
- * @param {string} controller Unique identifier to address a controller in the cell.
8043
- * @param {string} motionGroup The motion-group identifier.
8044
- * @param {*} [options] Override http request option.
8045
- * @throws {RequiredError}
8046
- */
8047
- getMotionGroupState: (cell: string, controller: string, motionGroup: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
8062
+ export declare const VirtualControllerApiAxiosParamCreator: (configuration?: Configuration) => {
8048
8063
  /**
8049
- * Gets information on the motion group.
8050
- * @summary Motion Group Description
8064
+ * Adds a coordinate system to the robot controller.
8065
+ * @summary Add Coordinate Systems
8051
8066
  * @param {string} cell Unique identifier addressing a cell in all API calls.
8052
8067
  * @param {string} controller Unique identifier to address a controller in the cell.
8068
+ * @param {string} coordinateSystem Unique identifier addressing a coordinate system.
8069
+ * @param {CoordinateSystemData} coordinateSystemData
8053
8070
  * @param {*} [options] Override http request option.
8054
8071
  * @throws {RequiredError}
8055
8072
  */
8056
- getMotionGroups: (cell: string, controller: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
8073
+ addVirtualRobotCoordinateSystem: (cell: string, controller: string, coordinateSystem: string, coordinateSystemData: CoordinateSystemData, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
8057
8074
  /**
8058
- * Retrieves the current values of inputs/outputs of the virtual controller. The identifiers of inputs/outputs must be provided in the request. Request all available input/output identifiers via [listVirtualRobotIODescriptions](listVirtualRobotIODescriptions).
8059
- * @summary Get Inputs/Outputs
8075
+ * 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.
8076
+ * @summary Add TCP
8060
8077
  * @param {string} cell Unique identifier addressing a cell in all API calls.
8061
8078
  * @param {string} controller Unique identifier to address a controller in the cell.
8062
- * @param {Array<string>} ios
8079
+ * @param {string} motionGroup The motion-group identifier.
8080
+ * @param {string} tcp The unique identifier of a TCP.
8081
+ * @param {RobotTcpData} robotTcpData
8063
8082
  * @param {*} [options] Override http request option.
8064
8083
  * @throws {RequiredError}
8065
8084
  */
8066
- listIOs: (cell: string, controller: string, ios: Array<string>, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
8085
+ addVirtualRobotTcp: (cell: string, controller: string, motionGroup: string, tcp: string, robotTcpData: RobotTcpData, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
8067
8086
  /**
8068
- * 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.
8069
- * @summary List Input/Output Descriptions
8087
+ * Deletes a coordinate system from the virtual controller. This will remove the coordinate system from the list of coordinate systems and remove all dependent coordinate systems which use the deleted coordinate system as reference.
8088
+ * @summary Remove Coordinate System
8070
8089
  * @param {string} cell Unique identifier addressing a cell in all API calls.
8071
8090
  * @param {string} controller Unique identifier to address a controller in the cell.
8072
- * @param {Array<string>} [ios]
8073
- * @param {IODirection} [direction] Return only inputs/outputs with the specified direction.
8074
- * @param {IOValueType} [valueType] Return only inputs/outputs with the specified value type.
8075
- * @param {string} [group] Return only inputs/outputs from the specified group.
8091
+ * @param {string} coordinateSystem Unique identifier addressing a coordinate system.
8092
+ * @param {boolean} [deleteDependent] If true, all dependent coordinate systems will be deleted as well.
8076
8093
  * @param {*} [options] Override http request option.
8077
8094
  * @throws {RequiredError}
8078
8095
  */
8079
- listVirtualRobotIODescriptions: (cell: string, controller: string, ios?: Array<string>, direction?: IODirection, valueType?: IOValueType, group?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
8096
+ deleteVirtualRobotCoordinateSystem: (cell: string, controller: string, coordinateSystem: string, deleteDependent?: boolean, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
8080
8097
  /**
8081
- * Sets a list of values of a virtual controller inputs/outputs.
8082
- * @summary Set Input/Ouput Values
8098
+ * Removes the TCP from the motion group. An unknown TCP is a valid input.
8099
+ * @summary Remove TCP
8083
8100
  * @param {string} cell Unique identifier addressing a cell in all API calls.
8084
8101
  * @param {string} controller Unique identifier to address a controller in the cell.
8085
- * @param {Array<IOValue>} iOValue
8102
+ * @param {string} motionGroup The motion-group identifier.
8103
+ * @param {string} tcp The unique identifier of a TCP.
8086
8104
  * @param {*} [options] Override http request option.
8087
8105
  * @throws {RequiredError}
8088
8106
  */
8089
- setIOValues: (cell: string, controller: string, iOValue: Array<IOValue>, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
8107
+ deleteVirtualRobotTcp: (cell: string, controller: string, motionGroup: string, tcp: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
8090
8108
  /**
8091
- * 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.
8092
- * @summary Set Motion Group State
8109
+ * 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.
8110
+ * @summary Get Emergency Stop State
8093
8111
  * @param {string} cell Unique identifier addressing a cell in all API calls.
8094
8112
  * @param {string} controller Unique identifier to address a controller in the cell.
8095
- * @param {string} motionGroup The motion-group identifier.
8096
- * @param {MotionGroupJoints} motionGroupJoints
8097
8113
  * @param {*} [options] Override http request option.
8098
8114
  * @throws {RequiredError}
8099
8115
  */
8100
- setMotionGroupState: (cell: string, controller: string, motionGroup: string, motionGroupJoints: MotionGroupJoints, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
8101
- };
8102
- /**
8103
- * VirtualRobotApi - functional programming interface
8104
- * @export
8105
- */
8106
- export declare const VirtualRobotApiFp: (configuration?: Configuration) => {
8116
+ getEmergencyStop: (cell: string, controller: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
8107
8117
  /**
8108
8118
  * Get the current motion group state which provides values for the joints\' position, velocity and acceleration.
8109
8119
  * @summary Get Motion Group State
@@ -8113,7 +8123,7 @@ export declare const VirtualRobotApiFp: (configuration?: Configuration) => {
8113
8123
  * @param {*} [options] Override http request option.
8114
8124
  * @throws {RequiredError}
8115
8125
  */
8116
- getMotionGroupState(cell: string, controller: string, motionGroup: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<MotionGroupJoints>>;
8126
+ getMotionGroupState: (cell: string, controller: string, motionGroup: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
8117
8127
  /**
8118
8128
  * Gets information on the motion group.
8119
8129
  * @summary Motion Group Description
@@ -8122,365 +8132,297 @@ export declare const VirtualRobotApiFp: (configuration?: Configuration) => {
8122
8132
  * @param {*} [options] Override http request option.
8123
8133
  * @throws {RequiredError}
8124
8134
  */
8125
- getMotionGroups(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<MotionGroupInfos>>;
8135
+ getMotionGroups: (cell: string, controller: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
8126
8136
  /**
8127
- * Retrieves the current values of inputs/outputs of the virtual controller. The identifiers of inputs/outputs must be provided in the request. Request all available input/output identifiers via [listVirtualRobotIODescriptions](listVirtualRobotIODescriptions).
8128
- * @summary Get Inputs/Outputs
8137
+ * 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.
8138
+ * @summary Get Operation Mode
8129
8139
  * @param {string} cell Unique identifier addressing a cell in all API calls.
8130
8140
  * @param {string} controller Unique identifier to address a controller in the cell.
8131
- * @param {Array<string>} ios
8132
8141
  * @param {*} [options] Override http request option.
8133
8142
  * @throws {RequiredError}
8134
8143
  */
8135
- listIOs(cell: string, controller: string, ios: Array<string>, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<IOValue>>>;
8144
+ getOperationMode: (cell: string, controller: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
8136
8145
  /**
8137
- * 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.
8138
- * @summary List Input/Output Descriptions
8146
+ * Gets motion group mounting. The motion group is based on the origin of the returned coordinate system.
8147
+ * @summary Get Mounting
8139
8148
  * @param {string} cell Unique identifier addressing a cell in all API calls.
8140
8149
  * @param {string} controller Unique identifier to address a controller in the cell.
8141
- * @param {Array<string>} [ios]
8142
- * @param {IODirection} [direction] Return only inputs/outputs with the specified direction.
8143
- * @param {IOValueType} [valueType] Return only inputs/outputs with the specified value type.
8144
- * @param {string} [group] Return only inputs/outputs from the specified group.
8150
+ * @param {string} motionGroup The motion-group identifier.
8145
8151
  * @param {*} [options] Override http request option.
8146
8152
  * @throws {RequiredError}
8147
8153
  */
8148
- listVirtualRobotIODescriptions(cell: string, controller: string, ios?: Array<string>, direction?: IODirection, valueType?: IOValueType, group?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<IODescription>>>;
8154
+ getVirtualRobotMounting: (cell: string, controller: string, motionGroup: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
8149
8155
  /**
8150
- * Sets a list of values of a virtual controller inputs/outputs.
8151
- * @summary Set Input/Ouput Values
8156
+ * Lists all coordinate systems on the robot controller.
8157
+ * @summary List Coordinate Systems
8152
8158
  * @param {string} cell Unique identifier addressing a cell in all API calls.
8153
8159
  * @param {string} controller Unique identifier to address a controller in the cell.
8154
- * @param {Array<IOValue>} iOValue
8155
8160
  * @param {*} [options] Override http request option.
8156
8161
  * @throws {RequiredError}
8157
8162
  */
8158
- setIOValues(cell: string, controller: string, iOValue: Array<IOValue>, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
8163
+ listVirtualRobotCoordinateSystems: (cell: string, controller: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
8159
8164
  /**
8160
- * 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.
8161
- * @summary Set Motion Group State
8165
+ * Lists TCPs of the motion group. An empty TCP list is valid, for example for external axes.
8166
+ * @summary List TCPs
8162
8167
  * @param {string} cell Unique identifier addressing a cell in all API calls.
8163
8168
  * @param {string} controller Unique identifier to address a controller in the cell.
8164
8169
  * @param {string} motionGroup The motion-group identifier.
8165
- * @param {MotionGroupJoints} motionGroupJoints
8166
8170
  * @param {*} [options] Override http request option.
8167
8171
  * @throws {RequiredError}
8168
8172
  */
8169
- setMotionGroupState(cell: string, controller: string, motionGroup: string, motionGroupJoints: MotionGroupJoints, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
8170
- };
8171
- /**
8172
- * VirtualRobotApi - factory interface
8173
- * @export
8174
- */
8175
- export declare const VirtualRobotApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
8173
+ listVirtualRobotTcps: (cell: string, controller: string, motionGroup: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
8176
8174
  /**
8177
- * Get the current motion group state which provides values for the joints\' position, velocity and acceleration.
8178
- * @summary Get Motion Group State
8175
+ * 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.
8176
+ * @summary Push or Release Emergency Stop
8179
8177
  * @param {string} cell Unique identifier addressing a cell in all API calls.
8180
8178
  * @param {string} controller Unique identifier to address a controller in the cell.
8181
- * @param {string} motionGroup The motion-group identifier.
8179
+ * @param {boolean} [active]
8182
8180
  * @param {*} [options] Override http request option.
8183
8181
  * @throws {RequiredError}
8184
8182
  */
8185
- getMotionGroupState(cell: string, controller: string, motionGroup: string, options?: RawAxiosRequestConfig): AxiosPromise<MotionGroupJoints>;
8183
+ setEmergencyStop: (cell: string, controller: string, active?: boolean, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
8186
8184
  /**
8187
- * Gets information on the motion group.
8188
- * @summary Motion Group Description
8185
+ * 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.
8186
+ * @summary Set Motion Group State
8189
8187
  * @param {string} cell Unique identifier addressing a cell in all API calls.
8190
8188
  * @param {string} controller Unique identifier to address a controller in the cell.
8189
+ * @param {string} motionGroup The motion-group identifier.
8190
+ * @param {MotionGroupJoints} motionGroupJoints
8191
8191
  * @param {*} [options] Override http request option.
8192
8192
  * @throws {RequiredError}
8193
8193
  */
8194
- getMotionGroups(cell: string, controller: string, options?: RawAxiosRequestConfig): AxiosPromise<MotionGroupInfos>;
8194
+ setMotionGroupState: (cell: string, controller: string, motionGroup: string, motionGroupJoints: MotionGroupJoints, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
8195
8195
  /**
8196
- * Retrieves the current values of inputs/outputs of the virtual controller. The identifiers of inputs/outputs must be provided in the request. Request all available input/output identifiers via [listVirtualRobotIODescriptions](listVirtualRobotIODescriptions).
8197
- * @summary Get Inputs/Outputs
8196
+ * 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.
8197
+ * @summary Set Operation Mode
8198
8198
  * @param {string} cell Unique identifier addressing a cell in all API calls.
8199
8199
  * @param {string} controller Unique identifier to address a controller in the cell.
8200
- * @param {Array<string>} ios
8200
+ * @param {OperationMode} mode
8201
8201
  * @param {*} [options] Override http request option.
8202
8202
  * @throws {RequiredError}
8203
8203
  */
8204
- listIOs(cell: string, controller: string, ios: Array<string>, options?: RawAxiosRequestConfig): AxiosPromise<Array<IOValue>>;
8204
+ setOperationMode: (cell: string, controller: string, mode: OperationMode, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
8205
8205
  /**
8206
- * 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.
8207
- * @summary List Input/Output Descriptions
8208
- * @param {string} cell Unique identifier addressing a cell in all API calls.
8209
- * @param {string} controller Unique identifier to address a controller in the cell.
8210
- * @param {Array<string>} [ios]
8211
- * @param {IODirection} [direction] Return only inputs/outputs with the specified direction.
8212
- * @param {IOValueType} [valueType] Return only inputs/outputs with the specified value type.
8213
- * @param {string} [group] Return only inputs/outputs from the specified group.
8214
- * @param {*} [options] Override http request option.
8215
- * @throws {RequiredError}
8216
- */
8217
- listVirtualRobotIODescriptions(cell: string, controller: string, ios?: Array<string>, direction?: IODirection, valueType?: IOValueType, group?: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<IODescription>>;
8218
- /**
8219
- * Sets a list of values of a virtual controller inputs/outputs.
8220
- * @summary Set Input/Ouput Values
8221
- * @param {string} cell Unique identifier addressing a cell in all API calls.
8222
- * @param {string} controller Unique identifier to address a controller in the cell.
8223
- * @param {Array<IOValue>} iOValue
8224
- * @param {*} [options] Override http request option.
8225
- * @throws {RequiredError}
8226
- */
8227
- setIOValues(cell: string, controller: string, iOValue: Array<IOValue>, options?: RawAxiosRequestConfig): AxiosPromise<void>;
8228
- /**
8229
- * 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.
8230
- * @summary Set Motion Group State
8206
+ * Sets 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. The transformation offset is defined by a unique identifier, a name for front end usage and an offset in another coordinate system referenced by the unique identifier of the reference coordinate system.
8207
+ * @summary Set Mounting
8231
8208
  * @param {string} cell Unique identifier addressing a cell in all API calls.
8232
8209
  * @param {string} controller Unique identifier to address a controller in the cell.
8233
8210
  * @param {string} motionGroup The motion-group identifier.
8234
- * @param {MotionGroupJoints} motionGroupJoints
8211
+ * @param {CoordinateSystem} coordinateSystem
8235
8212
  * @param {*} [options] Override http request option.
8236
8213
  * @throws {RequiredError}
8237
8214
  */
8238
- setMotionGroupState(cell: string, controller: string, motionGroup: string, motionGroupJoints: MotionGroupJoints, options?: RawAxiosRequestConfig): AxiosPromise<void>;
8215
+ setVirtualRobotMounting: (cell: string, controller: string, motionGroup: string, coordinateSystem: CoordinateSystem, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
8239
8216
  };
8240
8217
  /**
8241
- * VirtualRobotApi - object-oriented interface
8218
+ * VirtualControllerApi - functional programming interface
8242
8219
  * @export
8243
- * @class VirtualRobotApi
8244
- * @extends {BaseAPI}
8245
8220
  */
8246
- export declare class VirtualRobotApi extends BaseAPI {
8221
+ export declare const VirtualControllerApiFp: (configuration?: Configuration) => {
8247
8222
  /**
8248
- * Get the current motion group state which provides values for the joints\' position, velocity and acceleration.
8249
- * @summary Get Motion Group State
8223
+ * Adds a coordinate system to the robot controller.
8224
+ * @summary Add Coordinate Systems
8250
8225
  * @param {string} cell Unique identifier addressing a cell in all API calls.
8251
8226
  * @param {string} controller Unique identifier to address a controller in the cell.
8252
- * @param {string} motionGroup The motion-group identifier.
8227
+ * @param {string} coordinateSystem Unique identifier addressing a coordinate system.
8228
+ * @param {CoordinateSystemData} coordinateSystemData
8253
8229
  * @param {*} [options] Override http request option.
8254
8230
  * @throws {RequiredError}
8255
- * @memberof VirtualRobotApi
8256
8231
  */
8257
- getMotionGroupState(cell: string, controller: string, motionGroup: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<MotionGroupJoints, any>>;
8232
+ addVirtualRobotCoordinateSystem(cell: string, controller: string, coordinateSystem: string, coordinateSystemData: CoordinateSystemData, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
8258
8233
  /**
8259
- * Gets information on the motion group.
8260
- * @summary Motion Group Description
8234
+ * 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.
8235
+ * @summary Add TCP
8261
8236
  * @param {string} cell Unique identifier addressing a cell in all API calls.
8262
8237
  * @param {string} controller Unique identifier to address a controller in the cell.
8238
+ * @param {string} motionGroup The motion-group identifier.
8239
+ * @param {string} tcp The unique identifier of a TCP.
8240
+ * @param {RobotTcpData} robotTcpData
8263
8241
  * @param {*} [options] Override http request option.
8264
8242
  * @throws {RequiredError}
8265
- * @memberof VirtualRobotApi
8266
8243
  */
8267
- getMotionGroups(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<MotionGroupInfos, any>>;
8244
+ addVirtualRobotTcp(cell: string, controller: string, motionGroup: string, tcp: string, robotTcpData: RobotTcpData, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
8268
8245
  /**
8269
- * Retrieves the current values of inputs/outputs of the virtual controller. The identifiers of inputs/outputs must be provided in the request. Request all available input/output identifiers via [listVirtualRobotIODescriptions](listVirtualRobotIODescriptions).
8270
- * @summary Get Inputs/Outputs
8246
+ * Deletes a coordinate system from the virtual controller. This will remove the coordinate system from the list of coordinate systems and remove all dependent coordinate systems which use the deleted coordinate system as reference.
8247
+ * @summary Remove Coordinate System
8271
8248
  * @param {string} cell Unique identifier addressing a cell in all API calls.
8272
8249
  * @param {string} controller Unique identifier to address a controller in the cell.
8273
- * @param {Array<string>} ios
8250
+ * @param {string} coordinateSystem Unique identifier addressing a coordinate system.
8251
+ * @param {boolean} [deleteDependent] If true, all dependent coordinate systems will be deleted as well.
8274
8252
  * @param {*} [options] Override http request option.
8275
8253
  * @throws {RequiredError}
8276
- * @memberof VirtualRobotApi
8277
8254
  */
8278
- listIOs(cell: string, controller: string, ios: Array<string>, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<IOValue[], any>>;
8255
+ deleteVirtualRobotCoordinateSystem(cell: string, controller: string, coordinateSystem: string, deleteDependent?: boolean, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
8279
8256
  /**
8280
- * 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.
8281
- * @summary List Input/Output Descriptions
8257
+ * Removes the TCP from the motion group. An unknown TCP is a valid input.
8258
+ * @summary Remove TCP
8282
8259
  * @param {string} cell Unique identifier addressing a cell in all API calls.
8283
8260
  * @param {string} controller Unique identifier to address a controller in the cell.
8284
- * @param {Array<string>} [ios]
8285
- * @param {IODirection} [direction] Return only inputs/outputs with the specified direction.
8286
- * @param {IOValueType} [valueType] Return only inputs/outputs with the specified value type.
8287
- * @param {string} [group] Return only inputs/outputs from the specified group.
8261
+ * @param {string} motionGroup The motion-group identifier.
8262
+ * @param {string} tcp The unique identifier of a TCP.
8288
8263
  * @param {*} [options] Override http request option.
8289
8264
  * @throws {RequiredError}
8290
- * @memberof VirtualRobotApi
8291
8265
  */
8292
- listVirtualRobotIODescriptions(cell: string, controller: string, ios?: Array<string>, direction?: IODirection, valueType?: IOValueType, group?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<IODescription[], any>>;
8266
+ deleteVirtualRobotTcp(cell: string, controller: string, motionGroup: string, tcp: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
8293
8267
  /**
8294
- * Sets a list of values of a virtual controller inputs/outputs.
8295
- * @summary Set Input/Ouput Values
8268
+ * 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.
8269
+ * @summary Get Emergency Stop State
8296
8270
  * @param {string} cell Unique identifier addressing a cell in all API calls.
8297
8271
  * @param {string} controller Unique identifier to address a controller in the cell.
8298
- * @param {Array<IOValue>} iOValue
8299
8272
  * @param {*} [options] Override http request option.
8300
8273
  * @throws {RequiredError}
8301
- * @memberof VirtualRobotApi
8302
8274
  */
8303
- setIOValues(cell: string, controller: string, iOValue: Array<IOValue>, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
8275
+ getEmergencyStop(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Flag>>;
8304
8276
  /**
8305
- * 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.
8306
- * @summary Set Motion Group State
8277
+ * Get the current motion group state which provides values for the joints\' position, velocity and acceleration.
8278
+ * @summary Get Motion Group State
8307
8279
  * @param {string} cell Unique identifier addressing a cell in all API calls.
8308
8280
  * @param {string} controller Unique identifier to address a controller in the cell.
8309
8281
  * @param {string} motionGroup The motion-group identifier.
8310
- * @param {MotionGroupJoints} motionGroupJoints
8311
8282
  * @param {*} [options] Override http request option.
8312
8283
  * @throws {RequiredError}
8313
- * @memberof VirtualRobotApi
8314
8284
  */
8315
- setMotionGroupState(cell: string, controller: string, motionGroup: string, motionGroupJoints: MotionGroupJoints, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
8316
- }
8317
- /**
8318
- * VirtualRobotBehaviorApi - axios parameter creator
8319
- * @export
8320
- */
8321
- export declare const VirtualRobotBehaviorApiAxiosParamCreator: (configuration?: Configuration) => {
8285
+ getMotionGroupState(cell: string, controller: string, motionGroup: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<MotionGroupJoints>>;
8322
8286
  /**
8323
- * <!-- theme: danger --> > Websocket endpoint This stream provides the commanded joint state and sets a motion groups joint configuration, e.g. to move a motion group. The concept is that an application is using the Motion Service to move a motion group. The Motion Service is commanding the desired joint configuration of a 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! It is __not__ providing the *actual* joint state! (Please file a request - if you need a stream of the *actual* joint state) When the virtual controller receives joint commands the joint configuration is immediately adapted to match the incoming joint configurations. CAUTION: Incoming joint configurations are not visualized and their velocity limits are not checked. we don\'t even check limits! 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 group. 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.
8324
- * @summary Stream Joint Configuration
8287
+ * Gets information on the motion group.
8288
+ * @summary Motion Group Description
8325
8289
  * @param {string} cell Unique identifier addressing a cell in all API calls.
8326
8290
  * @param {string} controller Unique identifier to address a controller in the cell.
8327
- * @param {ExternalJointStreamDatapoint} externalJointStreamDatapoint
8328
8291
  * @param {*} [options] Override http request option.
8329
8292
  * @throws {RequiredError}
8330
8293
  */
8331
- externalJointsStream: (cell: string, controller: string, externalJointStreamDatapoint: ExternalJointStreamDatapoint, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
8294
+ getMotionGroups(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<MotionGroupInfo>>>;
8332
8295
  /**
8333
- * Get the current robot motion group behavior - please see the setter [setMotionGroupBehavior](setMotionGroupBehavior) and the enum for details.
8334
- * @summary Behavior
8296
+ * 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.
8297
+ * @summary Get Operation Mode
8335
8298
  * @param {string} cell Unique identifier addressing a cell in all API calls.
8336
8299
  * @param {string} controller Unique identifier to address a controller in the cell.
8337
- * @param {string} motionGroup The motion-group identifier.
8338
8300
  * @param {*} [options] Override http request option.
8339
8301
  * @throws {RequiredError}
8340
8302
  */
8341
- getMotionGroupBehavior: (cell: string, controller: string, motionGroup: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
8303
+ getOperationMode(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<OpMode>>;
8342
8304
  /**
8343
- * Switch robot motion group behavior.
8344
- * @summary Switch Behavior
8305
+ * Gets motion group mounting. The motion group is based on the origin of the returned coordinate system.
8306
+ * @summary Get Mounting
8345
8307
  * @param {string} cell Unique identifier addressing a cell in all API calls.
8346
8308
  * @param {string} controller Unique identifier to address a controller in the cell.
8347
8309
  * @param {string} motionGroup The motion-group identifier.
8348
- * @param {Behavior} [behavior]
8349
8310
  * @param {*} [options] Override http request option.
8350
8311
  * @throws {RequiredError}
8351
8312
  */
8352
- setMotionGroupBehavior: (cell: string, controller: string, motionGroup: string, behavior?: Behavior, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
8353
- };
8354
- /**
8355
- * VirtualRobotBehaviorApi - functional programming interface
8356
- * @export
8357
- */
8358
- export declare const VirtualRobotBehaviorApiFp: (configuration?: Configuration) => {
8313
+ getVirtualRobotMounting(cell: string, controller: string, motionGroup: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CoordinateSystem>>;
8359
8314
  /**
8360
- * <!-- theme: danger --> > Websocket endpoint This stream provides the commanded joint state and sets a motion groups joint configuration, e.g. to move a motion group. The concept is that an application is using the Motion Service to move a motion group. The Motion Service is commanding the desired joint configuration of a 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! It is __not__ providing the *actual* joint state! (Please file a request - if you need a stream of the *actual* joint state) When the virtual controller receives joint commands the joint configuration is immediately adapted to match the incoming joint configurations. CAUTION: Incoming joint configurations are not visualized and their velocity limits are not checked. we don\'t even check limits! 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 group. 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.
8361
- * @summary Stream Joint Configuration
8315
+ * Lists all coordinate systems on the robot controller.
8316
+ * @summary List Coordinate Systems
8362
8317
  * @param {string} cell Unique identifier addressing a cell in all API calls.
8363
8318
  * @param {string} controller Unique identifier to address a controller in the cell.
8364
- * @param {ExternalJointStreamDatapoint} externalJointStreamDatapoint
8365
8319
  * @param {*} [options] Override http request option.
8366
8320
  * @throws {RequiredError}
8367
8321
  */
8368
- externalJointsStream(cell: string, controller: string, externalJointStreamDatapoint: ExternalJointStreamDatapoint, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<MotionGroupJoints>>;
8322
+ listVirtualRobotCoordinateSystems(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<CoordinateSystem>>>;
8369
8323
  /**
8370
- * Get the current robot motion group behavior - please see the setter [setMotionGroupBehavior](setMotionGroupBehavior) and the enum for details.
8371
- * @summary Behavior
8324
+ * Lists TCPs of the motion group. An empty TCP list is valid, for example for external axes.
8325
+ * @summary List TCPs
8372
8326
  * @param {string} cell Unique identifier addressing a cell in all API calls.
8373
8327
  * @param {string} controller Unique identifier to address a controller in the cell.
8374
8328
  * @param {string} motionGroup The motion-group identifier.
8375
8329
  * @param {*} [options] Override http request option.
8376
8330
  * @throws {RequiredError}
8377
8331
  */
8378
- getMotionGroupBehavior(cell: string, controller: string, motionGroup: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<MotionGroupBehaviorGetter>>;
8332
+ listVirtualRobotTcps(cell: string, controller: string, motionGroup: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<RobotTcp>>>;
8379
8333
  /**
8380
- * Switch robot motion group behavior.
8381
- * @summary Switch Behavior
8334
+ * 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.
8335
+ * @summary Push or Release Emergency Stop
8382
8336
  * @param {string} cell Unique identifier addressing a cell in all API calls.
8383
8337
  * @param {string} controller Unique identifier to address a controller in the cell.
8384
- * @param {string} motionGroup The motion-group identifier.
8385
- * @param {Behavior} [behavior]
8338
+ * @param {boolean} [active]
8386
8339
  * @param {*} [options] Override http request option.
8387
8340
  * @throws {RequiredError}
8388
8341
  */
8389
- setMotionGroupBehavior(cell: string, controller: string, motionGroup: string, behavior?: Behavior, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
8390
- };
8391
- /**
8392
- * VirtualRobotBehaviorApi - factory interface
8393
- * @export
8394
- */
8395
- export declare const VirtualRobotBehaviorApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
8342
+ setEmergencyStop(cell: string, controller: string, active?: boolean, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
8396
8343
  /**
8397
- * <!-- theme: danger --> > Websocket endpoint This stream provides the commanded joint state and sets a motion groups joint configuration, e.g. to move a motion group. The concept is that an application is using the Motion Service to move a motion group. The Motion Service is commanding the desired joint configuration of a 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! It is __not__ providing the *actual* joint state! (Please file a request - if you need a stream of the *actual* joint state) When the virtual controller receives joint commands the joint configuration is immediately adapted to match the incoming joint configurations. CAUTION: Incoming joint configurations are not visualized and their velocity limits are not checked. we don\'t even check limits! 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 group. 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.
8398
- * @summary Stream Joint Configuration
8344
+ * 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.
8345
+ * @summary Set Motion Group State
8399
8346
  * @param {string} cell Unique identifier addressing a cell in all API calls.
8400
8347
  * @param {string} controller Unique identifier to address a controller in the cell.
8401
- * @param {ExternalJointStreamDatapoint} externalJointStreamDatapoint
8348
+ * @param {string} motionGroup The motion-group identifier.
8349
+ * @param {MotionGroupJoints} motionGroupJoints
8402
8350
  * @param {*} [options] Override http request option.
8403
8351
  * @throws {RequiredError}
8404
8352
  */
8405
- externalJointsStream(cell: string, controller: string, externalJointStreamDatapoint: ExternalJointStreamDatapoint, options?: RawAxiosRequestConfig): AxiosPromise<MotionGroupJoints>;
8353
+ setMotionGroupState(cell: string, controller: string, motionGroup: string, motionGroupJoints: MotionGroupJoints, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
8406
8354
  /**
8407
- * Get the current robot motion group behavior - please see the setter [setMotionGroupBehavior](setMotionGroupBehavior) and the enum for details.
8408
- * @summary Behavior
8355
+ * 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.
8356
+ * @summary Set Operation Mode
8409
8357
  * @param {string} cell Unique identifier addressing a cell in all API calls.
8410
8358
  * @param {string} controller Unique identifier to address a controller in the cell.
8411
- * @param {string} motionGroup The motion-group identifier.
8359
+ * @param {OperationMode} mode
8412
8360
  * @param {*} [options] Override http request option.
8413
8361
  * @throws {RequiredError}
8414
8362
  */
8415
- getMotionGroupBehavior(cell: string, controller: string, motionGroup: string, options?: RawAxiosRequestConfig): AxiosPromise<MotionGroupBehaviorGetter>;
8363
+ setOperationMode(cell: string, controller: string, mode: OperationMode, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
8416
8364
  /**
8417
- * Switch robot motion group behavior.
8418
- * @summary Switch Behavior
8365
+ * Sets 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. The transformation offset is defined by a unique identifier, a name for front end usage and an offset in another coordinate system referenced by the unique identifier of the reference coordinate system.
8366
+ * @summary Set Mounting
8419
8367
  * @param {string} cell Unique identifier addressing a cell in all API calls.
8420
8368
  * @param {string} controller Unique identifier to address a controller in the cell.
8421
8369
  * @param {string} motionGroup The motion-group identifier.
8422
- * @param {Behavior} [behavior]
8370
+ * @param {CoordinateSystem} coordinateSystem
8423
8371
  * @param {*} [options] Override http request option.
8424
8372
  * @throws {RequiredError}
8425
8373
  */
8426
- setMotionGroupBehavior(cell: string, controller: string, motionGroup: string, behavior?: Behavior, options?: RawAxiosRequestConfig): AxiosPromise<void>;
8374
+ setVirtualRobotMounting(cell: string, controller: string, motionGroup: string, coordinateSystem: CoordinateSystem, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CoordinateSystem>>;
8427
8375
  };
8428
8376
  /**
8429
- * VirtualRobotBehaviorApi - object-oriented interface
8377
+ * VirtualControllerApi - factory interface
8430
8378
  * @export
8431
- * @class VirtualRobotBehaviorApi
8432
- * @extends {BaseAPI}
8433
8379
  */
8434
- export declare class VirtualRobotBehaviorApi extends BaseAPI {
8380
+ export declare const VirtualControllerApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
8435
8381
  /**
8436
- * <!-- theme: danger --> > Websocket endpoint This stream provides the commanded joint state and sets a motion groups joint configuration, e.g. to move a motion group. The concept is that an application is using the Motion Service to move a motion group. The Motion Service is commanding the desired joint configuration of a 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! It is __not__ providing the *actual* joint state! (Please file a request - if you need a stream of the *actual* joint state) When the virtual controller receives joint commands the joint configuration is immediately adapted to match the incoming joint configurations. CAUTION: Incoming joint configurations are not visualized and their velocity limits are not checked. we don\'t even check limits! 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 group. 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.
8437
- * @summary Stream Joint Configuration
8382
+ * Adds a coordinate system to the robot controller.
8383
+ * @summary Add Coordinate Systems
8438
8384
  * @param {string} cell Unique identifier addressing a cell in all API calls.
8439
8385
  * @param {string} controller Unique identifier to address a controller in the cell.
8440
- * @param {ExternalJointStreamDatapoint} externalJointStreamDatapoint
8386
+ * @param {string} coordinateSystem Unique identifier addressing a coordinate system.
8387
+ * @param {CoordinateSystemData} coordinateSystemData
8441
8388
  * @param {*} [options] Override http request option.
8442
8389
  * @throws {RequiredError}
8443
- * @memberof VirtualRobotBehaviorApi
8444
8390
  */
8445
- externalJointsStream(cell: string, controller: string, externalJointStreamDatapoint: ExternalJointStreamDatapoint, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<MotionGroupJoints, any>>;
8391
+ addVirtualRobotCoordinateSystem(cell: string, controller: string, coordinateSystem: string, coordinateSystemData: CoordinateSystemData, options?: RawAxiosRequestConfig): AxiosPromise<void>;
8446
8392
  /**
8447
- * Get the current robot motion group behavior - please see the setter [setMotionGroupBehavior](setMotionGroupBehavior) and the enum for details.
8448
- * @summary Behavior
8393
+ * 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.
8394
+ * @summary Add TCP
8449
8395
  * @param {string} cell Unique identifier addressing a cell in all API calls.
8450
8396
  * @param {string} controller Unique identifier to address a controller in the cell.
8451
8397
  * @param {string} motionGroup The motion-group identifier.
8398
+ * @param {string} tcp The unique identifier of a TCP.
8399
+ * @param {RobotTcpData} robotTcpData
8452
8400
  * @param {*} [options] Override http request option.
8453
8401
  * @throws {RequiredError}
8454
- * @memberof VirtualRobotBehaviorApi
8455
8402
  */
8456
- getMotionGroupBehavior(cell: string, controller: string, motionGroup: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<MotionGroupBehaviorGetter, any>>;
8403
+ addVirtualRobotTcp(cell: string, controller: string, motionGroup: string, tcp: string, robotTcpData: RobotTcpData, options?: RawAxiosRequestConfig): AxiosPromise<void>;
8457
8404
  /**
8458
- * Switch robot motion group behavior.
8459
- * @summary Switch Behavior
8405
+ * Deletes a coordinate system from the virtual controller. This will remove the coordinate system from the list of coordinate systems and remove all dependent coordinate systems which use the deleted coordinate system as reference.
8406
+ * @summary Remove Coordinate System
8460
8407
  * @param {string} cell Unique identifier addressing a cell in all API calls.
8461
8408
  * @param {string} controller Unique identifier to address a controller in the cell.
8462
- * @param {string} motionGroup The motion-group identifier.
8463
- * @param {Behavior} [behavior]
8409
+ * @param {string} coordinateSystem Unique identifier addressing a coordinate system.
8410
+ * @param {boolean} [deleteDependent] If true, all dependent coordinate systems will be deleted as well.
8464
8411
  * @param {*} [options] Override http request option.
8465
8412
  * @throws {RequiredError}
8466
- * @memberof VirtualRobotBehaviorApi
8467
8413
  */
8468
- setMotionGroupBehavior(cell: string, controller: string, motionGroup: string, behavior?: Behavior, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
8469
- }
8470
- /**
8471
- * VirtualRobotModeApi - axios parameter creator
8472
- * @export
8473
- */
8474
- export declare const VirtualRobotModeApiAxiosParamCreator: (configuration?: Configuration) => {
8414
+ deleteVirtualRobotCoordinateSystem(cell: string, controller: string, coordinateSystem: string, deleteDependent?: boolean, options?: RawAxiosRequestConfig): AxiosPromise<void>;
8475
8415
  /**
8476
- * Get the cycle time of controller communication in [ms].
8477
- * @summary Cycle Time
8416
+ * Removes the TCP from the motion group. An unknown TCP is a valid input.
8417
+ * @summary Remove TCP
8478
8418
  * @param {string} cell Unique identifier addressing a cell in all API calls.
8479
8419
  * @param {string} controller Unique identifier to address a controller in the cell.
8420
+ * @param {string} motionGroup The motion-group identifier.
8421
+ * @param {string} tcp The unique identifier of a TCP.
8480
8422
  * @param {*} [options] Override http request option.
8481
8423
  * @throws {RequiredError}
8482
8424
  */
8483
- getCycleTime: (cell: string, controller: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
8425
+ deleteVirtualRobotTcp(cell: string, controller: string, motionGroup: string, tcp: string, options?: RawAxiosRequestConfig): AxiosPromise<void>;
8484
8426
  /**
8485
8427
  * 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.
8486
8428
  * @summary Get Emergency Stop State
@@ -8489,69 +8431,64 @@ export declare const VirtualRobotModeApiAxiosParamCreator: (configuration?: Conf
8489
8431
  * @param {*} [options] Override http request option.
8490
8432
  * @throws {RequiredError}
8491
8433
  */
8492
- getEmergencyStop: (cell: string, controller: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
8434
+ getEmergencyStop(cell: string, controller: string, options?: RawAxiosRequestConfig): AxiosPromise<Flag>;
8493
8435
  /**
8494
- * 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.
8495
- * @summary Get Operation Mode
8436
+ * Get the current motion group state which provides values for the joints\' position, velocity and acceleration.
8437
+ * @summary Get Motion Group State
8496
8438
  * @param {string} cell Unique identifier addressing a cell in all API calls.
8497
8439
  * @param {string} controller Unique identifier to address a controller in the cell.
8440
+ * @param {string} motionGroup The motion-group identifier.
8498
8441
  * @param {*} [options] Override http request option.
8499
8442
  * @throws {RequiredError}
8500
8443
  */
8501
- getOperationMode: (cell: string, controller: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
8444
+ getMotionGroupState(cell: string, controller: string, motionGroup: string, options?: RawAxiosRequestConfig): AxiosPromise<MotionGroupJoints>;
8502
8445
  /**
8503
- * 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.
8504
- * @summary Push or Release Emergency Stop
8446
+ * Gets information on the motion group.
8447
+ * @summary Motion Group Description
8505
8448
  * @param {string} cell Unique identifier addressing a cell in all API calls.
8506
8449
  * @param {string} controller Unique identifier to address a controller in the cell.
8507
- * @param {boolean} [active]
8508
8450
  * @param {*} [options] Override http request option.
8509
8451
  * @throws {RequiredError}
8510
8452
  */
8511
- setEmergencyStop: (cell: string, controller: string, active?: boolean, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
8453
+ getMotionGroups(cell: string, controller: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<MotionGroupInfo>>;
8512
8454
  /**
8513
- * 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.
8514
- * @summary Set Operation Mode
8455
+ * 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.
8456
+ * @summary Get Operation Mode
8515
8457
  * @param {string} cell Unique identifier addressing a cell in all API calls.
8516
8458
  * @param {string} controller Unique identifier to address a controller in the cell.
8517
- * @param {OperationMode} mode
8518
8459
  * @param {*} [options] Override http request option.
8519
8460
  * @throws {RequiredError}
8520
8461
  */
8521
- setOperationMode: (cell: string, controller: string, mode: OperationMode, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
8522
- };
8523
- /**
8524
- * VirtualRobotModeApi - functional programming interface
8525
- * @export
8526
- */
8527
- export declare const VirtualRobotModeApiFp: (configuration?: Configuration) => {
8462
+ getOperationMode(cell: string, controller: string, options?: RawAxiosRequestConfig): AxiosPromise<OpMode>;
8528
8463
  /**
8529
- * Get the cycle time of controller communication in [ms].
8530
- * @summary Cycle Time
8464
+ * Gets motion group mounting. The motion group is based on the origin of the returned coordinate system.
8465
+ * @summary Get Mounting
8531
8466
  * @param {string} cell Unique identifier addressing a cell in all API calls.
8532
8467
  * @param {string} controller Unique identifier to address a controller in the cell.
8468
+ * @param {string} motionGroup The motion-group identifier.
8533
8469
  * @param {*} [options] Override http request option.
8534
8470
  * @throws {RequiredError}
8535
8471
  */
8536
- getCycleTime(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CycleTime>>;
8472
+ getVirtualRobotMounting(cell: string, controller: string, motionGroup: string, options?: RawAxiosRequestConfig): AxiosPromise<CoordinateSystem>;
8537
8473
  /**
8538
- * 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.
8539
- * @summary Get Emergency Stop State
8474
+ * Lists all coordinate systems on the robot controller.
8475
+ * @summary List Coordinate Systems
8540
8476
  * @param {string} cell Unique identifier addressing a cell in all API calls.
8541
8477
  * @param {string} controller Unique identifier to address a controller in the cell.
8542
8478
  * @param {*} [options] Override http request option.
8543
8479
  * @throws {RequiredError}
8544
8480
  */
8545
- getEmergencyStop(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Flag>>;
8481
+ listVirtualRobotCoordinateSystems(cell: string, controller: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<CoordinateSystem>>;
8546
8482
  /**
8547
- * 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.
8548
- * @summary Get Operation Mode
8483
+ * Lists TCPs of the motion group. An empty TCP list is valid, for example for external axes.
8484
+ * @summary List TCPs
8549
8485
  * @param {string} cell Unique identifier addressing a cell in all API calls.
8550
8486
  * @param {string} controller Unique identifier to address a controller in the cell.
8487
+ * @param {string} motionGroup The motion-group identifier.
8551
8488
  * @param {*} [options] Override http request option.
8552
8489
  * @throws {RequiredError}
8553
8490
  */
8554
- getOperationMode(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<OpMode>>;
8491
+ listVirtualRobotTcps(cell: string, controller: string, motionGroup: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<RobotTcp>>;
8555
8492
  /**
8556
8493
  * 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.
8557
8494
  * @summary Push or Release Emergency Stop
@@ -8561,7 +8498,18 @@ export declare const VirtualRobotModeApiFp: (configuration?: Configuration) => {
8561
8498
  * @param {*} [options] Override http request option.
8562
8499
  * @throws {RequiredError}
8563
8500
  */
8564
- setEmergencyStop(cell: string, controller: string, active?: boolean, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
8501
+ setEmergencyStop(cell: string, controller: string, active?: boolean, options?: RawAxiosRequestConfig): AxiosPromise<void>;
8502
+ /**
8503
+ * 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.
8504
+ * @summary Set Motion Group State
8505
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
8506
+ * @param {string} controller Unique identifier to address a controller in the cell.
8507
+ * @param {string} motionGroup The motion-group identifier.
8508
+ * @param {MotionGroupJoints} motionGroupJoints
8509
+ * @param {*} [options] Override http request option.
8510
+ * @throws {RequiredError}
8511
+ */
8512
+ setMotionGroupState(cell: string, controller: string, motionGroup: string, motionGroupJoints: MotionGroupJoints, options?: RawAxiosRequestConfig): AxiosPromise<void>;
8565
8513
  /**
8566
8514
  * 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.
8567
8515
  * @summary Set Operation Mode
@@ -8571,88 +8519,106 @@ export declare const VirtualRobotModeApiFp: (configuration?: Configuration) => {
8571
8519
  * @param {*} [options] Override http request option.
8572
8520
  * @throws {RequiredError}
8573
8521
  */
8574
- setOperationMode(cell: string, controller: string, mode: OperationMode, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
8522
+ setOperationMode(cell: string, controller: string, mode: OperationMode, options?: RawAxiosRequestConfig): AxiosPromise<void>;
8523
+ /**
8524
+ * Sets 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. The transformation offset is defined by a unique identifier, a name for front end usage and an offset in another coordinate system referenced by the unique identifier of the reference coordinate system.
8525
+ * @summary Set Mounting
8526
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
8527
+ * @param {string} controller Unique identifier to address a controller in the cell.
8528
+ * @param {string} motionGroup The motion-group identifier.
8529
+ * @param {CoordinateSystem} coordinateSystem
8530
+ * @param {*} [options] Override http request option.
8531
+ * @throws {RequiredError}
8532
+ */
8533
+ setVirtualRobotMounting(cell: string, controller: string, motionGroup: string, coordinateSystem: CoordinateSystem, options?: RawAxiosRequestConfig): AxiosPromise<CoordinateSystem>;
8575
8534
  };
8576
8535
  /**
8577
- * VirtualRobotModeApi - factory interface
8536
+ * VirtualControllerApi - object-oriented interface
8578
8537
  * @export
8538
+ * @class VirtualControllerApi
8539
+ * @extends {BaseAPI}
8579
8540
  */
8580
- export declare const VirtualRobotModeApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
8541
+ export declare class VirtualControllerApi extends BaseAPI {
8581
8542
  /**
8582
- * Get the cycle time of controller communication in [ms].
8583
- * @summary Cycle Time
8543
+ * Adds a coordinate system to the robot controller.
8544
+ * @summary Add Coordinate Systems
8584
8545
  * @param {string} cell Unique identifier addressing a cell in all API calls.
8585
8546
  * @param {string} controller Unique identifier to address a controller in the cell.
8547
+ * @param {string} coordinateSystem Unique identifier addressing a coordinate system.
8548
+ * @param {CoordinateSystemData} coordinateSystemData
8586
8549
  * @param {*} [options] Override http request option.
8587
8550
  * @throws {RequiredError}
8551
+ * @memberof VirtualControllerApi
8588
8552
  */
8589
- getCycleTime(cell: string, controller: string, options?: RawAxiosRequestConfig): AxiosPromise<CycleTime>;
8553
+ addVirtualRobotCoordinateSystem(cell: string, controller: string, coordinateSystem: string, coordinateSystemData: CoordinateSystemData, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
8590
8554
  /**
8591
- * 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.
8592
- * @summary Get Emergency Stop State
8555
+ * 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.
8556
+ * @summary Add TCP
8593
8557
  * @param {string} cell Unique identifier addressing a cell in all API calls.
8594
8558
  * @param {string} controller Unique identifier to address a controller in the cell.
8559
+ * @param {string} motionGroup The motion-group identifier.
8560
+ * @param {string} tcp The unique identifier of a TCP.
8561
+ * @param {RobotTcpData} robotTcpData
8595
8562
  * @param {*} [options] Override http request option.
8596
8563
  * @throws {RequiredError}
8564
+ * @memberof VirtualControllerApi
8597
8565
  */
8598
- getEmergencyStop(cell: string, controller: string, options?: RawAxiosRequestConfig): AxiosPromise<Flag>;
8566
+ addVirtualRobotTcp(cell: string, controller: string, motionGroup: string, tcp: string, robotTcpData: RobotTcpData, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
8599
8567
  /**
8600
- * 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.
8601
- * @summary Get Operation Mode
8568
+ * Deletes a coordinate system from the virtual controller. This will remove the coordinate system from the list of coordinate systems and remove all dependent coordinate systems which use the deleted coordinate system as reference.
8569
+ * @summary Remove Coordinate System
8602
8570
  * @param {string} cell Unique identifier addressing a cell in all API calls.
8603
8571
  * @param {string} controller Unique identifier to address a controller in the cell.
8572
+ * @param {string} coordinateSystem Unique identifier addressing a coordinate system.
8573
+ * @param {boolean} [deleteDependent] If true, all dependent coordinate systems will be deleted as well.
8604
8574
  * @param {*} [options] Override http request option.
8605
8575
  * @throws {RequiredError}
8576
+ * @memberof VirtualControllerApi
8606
8577
  */
8607
- getOperationMode(cell: string, controller: string, options?: RawAxiosRequestConfig): AxiosPromise<OpMode>;
8578
+ deleteVirtualRobotCoordinateSystem(cell: string, controller: string, coordinateSystem: string, deleteDependent?: boolean, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
8608
8579
  /**
8609
- * 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.
8610
- * @summary Push or Release Emergency Stop
8580
+ * Removes the TCP from the motion group. An unknown TCP is a valid input.
8581
+ * @summary Remove TCP
8611
8582
  * @param {string} cell Unique identifier addressing a cell in all API calls.
8612
8583
  * @param {string} controller Unique identifier to address a controller in the cell.
8613
- * @param {boolean} [active]
8584
+ * @param {string} motionGroup The motion-group identifier.
8585
+ * @param {string} tcp The unique identifier of a TCP.
8614
8586
  * @param {*} [options] Override http request option.
8615
8587
  * @throws {RequiredError}
8588
+ * @memberof VirtualControllerApi
8616
8589
  */
8617
- setEmergencyStop(cell: string, controller: string, active?: boolean, options?: RawAxiosRequestConfig): AxiosPromise<void>;
8590
+ deleteVirtualRobotTcp(cell: string, controller: string, motionGroup: string, tcp: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
8618
8591
  /**
8619
- * 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.
8620
- * @summary Set Operation Mode
8592
+ * 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.
8593
+ * @summary Get Emergency Stop State
8621
8594
  * @param {string} cell Unique identifier addressing a cell in all API calls.
8622
8595
  * @param {string} controller Unique identifier to address a controller in the cell.
8623
- * @param {OperationMode} mode
8624
8596
  * @param {*} [options] Override http request option.
8625
8597
  * @throws {RequiredError}
8598
+ * @memberof VirtualControllerApi
8626
8599
  */
8627
- setOperationMode(cell: string, controller: string, mode: OperationMode, options?: RawAxiosRequestConfig): AxiosPromise<void>;
8628
- };
8629
- /**
8630
- * VirtualRobotModeApi - object-oriented interface
8631
- * @export
8632
- * @class VirtualRobotModeApi
8633
- * @extends {BaseAPI}
8634
- */
8635
- export declare class VirtualRobotModeApi extends BaseAPI {
8600
+ getEmergencyStop(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Flag, any>>;
8636
8601
  /**
8637
- * Get the cycle time of controller communication in [ms].
8638
- * @summary Cycle Time
8602
+ * Get the current motion group state which provides values for the joints\' position, velocity and acceleration.
8603
+ * @summary Get Motion Group State
8639
8604
  * @param {string} cell Unique identifier addressing a cell in all API calls.
8640
8605
  * @param {string} controller Unique identifier to address a controller in the cell.
8606
+ * @param {string} motionGroup The motion-group identifier.
8641
8607
  * @param {*} [options] Override http request option.
8642
8608
  * @throws {RequiredError}
8643
- * @memberof VirtualRobotModeApi
8609
+ * @memberof VirtualControllerApi
8644
8610
  */
8645
- getCycleTime(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CycleTime, any>>;
8611
+ getMotionGroupState(cell: string, controller: string, motionGroup: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<MotionGroupJoints, any>>;
8646
8612
  /**
8647
- * 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.
8648
- * @summary Get Emergency Stop State
8613
+ * Gets information on the motion group.
8614
+ * @summary Motion Group Description
8649
8615
  * @param {string} cell Unique identifier addressing a cell in all API calls.
8650
8616
  * @param {string} controller Unique identifier to address a controller in the cell.
8651
8617
  * @param {*} [options] Override http request option.
8652
8618
  * @throws {RequiredError}
8653
- * @memberof VirtualRobotModeApi
8619
+ * @memberof VirtualControllerApi
8654
8620
  */
8655
- getEmergencyStop(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Flag, any>>;
8621
+ getMotionGroups(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<MotionGroupInfo[], any>>;
8656
8622
  /**
8657
8623
  * 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.
8658
8624
  * @summary Get Operation Mode
@@ -8660,395 +8626,428 @@ export declare class VirtualRobotModeApi extends BaseAPI {
8660
8626
  * @param {string} controller Unique identifier to address a controller in the cell.
8661
8627
  * @param {*} [options] Override http request option.
8662
8628
  * @throws {RequiredError}
8663
- * @memberof VirtualRobotModeApi
8629
+ * @memberof VirtualControllerApi
8664
8630
  */
8665
8631
  getOperationMode(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<OpMode, any>>;
8666
8632
  /**
8667
- * 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.
8668
- * @summary Push or Release Emergency Stop
8633
+ * Gets motion group mounting. The motion group is based on the origin of the returned coordinate system.
8634
+ * @summary Get Mounting
8669
8635
  * @param {string} cell Unique identifier addressing a cell in all API calls.
8670
8636
  * @param {string} controller Unique identifier to address a controller in the cell.
8671
- * @param {boolean} [active]
8637
+ * @param {string} motionGroup The motion-group identifier.
8672
8638
  * @param {*} [options] Override http request option.
8673
8639
  * @throws {RequiredError}
8674
- * @memberof VirtualRobotModeApi
8640
+ * @memberof VirtualControllerApi
8675
8641
  */
8676
- setEmergencyStop(cell: string, controller: string, active?: boolean, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
8642
+ getVirtualRobotMounting(cell: string, controller: string, motionGroup: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CoordinateSystem, any>>;
8677
8643
  /**
8678
- * 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.
8679
- * @summary Set Operation Mode
8644
+ * Lists all coordinate systems on the robot controller.
8645
+ * @summary List Coordinate Systems
8680
8646
  * @param {string} cell Unique identifier addressing a cell in all API calls.
8681
8647
  * @param {string} controller Unique identifier to address a controller in the cell.
8682
- * @param {OperationMode} mode
8683
8648
  * @param {*} [options] Override http request option.
8684
8649
  * @throws {RequiredError}
8685
- * @memberof VirtualRobotModeApi
8650
+ * @memberof VirtualControllerApi
8686
8651
  */
8687
- setOperationMode(cell: string, controller: string, mode: OperationMode, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
8688
- }
8689
- /**
8690
- * VirtualRobotSetupApi - axios parameter creator
8691
- * @export
8692
- */
8693
- export declare const VirtualRobotSetupApiAxiosParamCreator: (configuration?: Configuration) => {
8652
+ listVirtualRobotCoordinateSystems(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CoordinateSystem[], any>>;
8694
8653
  /**
8695
- * Adds a coordinate system to the robot controller.
8696
- * @summary Add Coordinate Systems
8654
+ * Lists TCPs of the motion group. An empty TCP list is valid, for example for external axes.
8655
+ * @summary List TCPs
8697
8656
  * @param {string} cell Unique identifier addressing a cell in all API calls.
8698
8657
  * @param {string} controller Unique identifier to address a controller in the cell.
8699
- * @param {CoordinateSystem} coordinateSystem
8658
+ * @param {string} motionGroup The motion-group identifier.
8700
8659
  * @param {*} [options] Override http request option.
8701
8660
  * @throws {RequiredError}
8661
+ * @memberof VirtualControllerApi
8702
8662
  */
8703
- addVirtualRobotCoordinateSystem: (cell: string, controller: string, coordinateSystem: CoordinateSystem, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
8663
+ listVirtualRobotTcps(cell: string, controller: string, motionGroup: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<RobotTcp[], any>>;
8704
8664
  /**
8705
- * 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.
8706
- * @summary Add TCP
8665
+ * 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.
8666
+ * @summary Push or Release Emergency Stop
8667
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
8668
+ * @param {string} controller Unique identifier to address a controller in the cell.
8669
+ * @param {boolean} [active]
8670
+ * @param {*} [options] Override http request option.
8671
+ * @throws {RequiredError}
8672
+ * @memberof VirtualControllerApi
8673
+ */
8674
+ setEmergencyStop(cell: string, controller: string, active?: boolean, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
8675
+ /**
8676
+ * 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.
8677
+ * @summary Set Motion Group State
8707
8678
  * @param {string} cell Unique identifier addressing a cell in all API calls.
8708
8679
  * @param {string} controller Unique identifier to address a controller in the cell.
8709
8680
  * @param {string} motionGroup The motion-group identifier.
8710
- * @param {RobotTcp} robotTcp
8681
+ * @param {MotionGroupJoints} motionGroupJoints
8711
8682
  * @param {*} [options] Override http request option.
8712
8683
  * @throws {RequiredError}
8684
+ * @memberof VirtualControllerApi
8713
8685
  */
8714
- addVirtualRobotTcp: (cell: string, controller: string, motionGroup: string, robotTcp: RobotTcp, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
8686
+ setMotionGroupState(cell: string, controller: string, motionGroup: string, motionGroupJoints: MotionGroupJoints, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
8715
8687
  /**
8716
- * Deletes a coordinate system from the virtual controller. This will remove the coordinate system from the list of coordinate systems and remove all dependent coordinate systems which use the deleted coordinate system as reference.
8717
- * @summary Remove Coordinate System
8688
+ * 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.
8689
+ * @summary Set Operation Mode
8718
8690
  * @param {string} cell Unique identifier addressing a cell in all API calls.
8719
8691
  * @param {string} controller Unique identifier to address a controller in the cell.
8720
- * @param {string} coordinateSystem Unique identifier addressing a coordinate system.
8721
- * @param {boolean} [deleteDependent] If true, all dependent coordinate systems will be deleted as well.
8692
+ * @param {OperationMode} mode
8722
8693
  * @param {*} [options] Override http request option.
8723
8694
  * @throws {RequiredError}
8695
+ * @memberof VirtualControllerApi
8724
8696
  */
8725
- deleteVirtualRobotCoordinateSystem: (cell: string, controller: string, coordinateSystem: string, deleteDependent?: boolean, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
8697
+ setOperationMode(cell: string, controller: string, mode: OperationMode, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
8726
8698
  /**
8727
- * Removes the TCP from the motion group. An unknown TCP is a valid input.
8728
- * @summary Remove TCP
8699
+ * Sets 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. The transformation offset is defined by a unique identifier, a name for front end usage and an offset in another coordinate system referenced by the unique identifier of the reference coordinate system.
8700
+ * @summary Set Mounting
8729
8701
  * @param {string} cell Unique identifier addressing a cell in all API calls.
8730
8702
  * @param {string} controller Unique identifier to address a controller in the cell.
8731
8703
  * @param {string} motionGroup The motion-group identifier.
8732
- * @param {string} tcp The unique identifier of a TCP.
8704
+ * @param {CoordinateSystem} coordinateSystem
8733
8705
  * @param {*} [options] Override http request option.
8734
8706
  * @throws {RequiredError}
8707
+ * @memberof VirtualControllerApi
8735
8708
  */
8736
- deleteVirtualRobotTcp: (cell: string, controller: string, motionGroup: string, tcp: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
8709
+ setVirtualRobotMounting(cell: string, controller: string, motionGroup: string, coordinateSystem: CoordinateSystem, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CoordinateSystem, any>>;
8710
+ }
8711
+ /**
8712
+ * VirtualControllerBehaviorApi - axios parameter creator
8713
+ * @export
8714
+ */
8715
+ export declare const VirtualControllerBehaviorApiAxiosParamCreator: (configuration?: Configuration) => {
8737
8716
  /**
8738
- * Gets motion group mounting. The motion group is based on the origin of the returned coordinate system.
8739
- * @summary Get Mounting
8717
+ * <!-- 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.
8718
+ * @summary Stream Joint Configuration
8740
8719
  * @param {string} cell Unique identifier addressing a cell in all API calls.
8741
8720
  * @param {string} controller Unique identifier to address a controller in the cell.
8742
- * @param {string} motionGroup The motion-group identifier.
8721
+ * @param {ExternalJointStreamRequest} externalJointStreamRequest
8743
8722
  * @param {*} [options] Override http request option.
8744
8723
  * @throws {RequiredError}
8745
8724
  */
8746
- getVirtualRobotMounting: (cell: string, controller: string, motionGroup: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
8725
+ externalJointsStream: (cell: string, controller: string, externalJointStreamRequest: ExternalJointStreamRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
8747
8726
  /**
8748
- * Lists all coordinate systems on the robot controller.
8749
- * @summary List Coordinate Systems
8727
+ * Get the cycle time of controller communication in [ms].
8728
+ * @summary Get Cycle Time
8750
8729
  * @param {string} cell Unique identifier addressing a cell in all API calls.
8751
8730
  * @param {string} controller Unique identifier to address a controller in the cell.
8752
8731
  * @param {*} [options] Override http request option.
8753
8732
  * @throws {RequiredError}
8754
8733
  */
8755
- listVirtualRobotCoordinateSystems: (cell: string, controller: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
8734
+ getCycleTime: (cell: string, controller: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
8756
8735
  /**
8757
- * Lists TCPs of the motion group. An empty TCP list is valid, for example for external axes.
8758
- * @summary List TCPs
8736
+ * Get the current virtual controller behavior - please see the setter [setVirtualRobotBehavior](setVirtualRobotBehavior) and the enum for details.
8737
+ * @summary Get Behavior
8759
8738
  * @param {string} cell Unique identifier addressing a cell in all API calls.
8760
8739
  * @param {string} controller Unique identifier to address a controller in the cell.
8761
- * @param {string} motionGroup The motion-group identifier.
8762
8740
  * @param {*} [options] Override http request option.
8763
8741
  * @throws {RequiredError}
8764
8742
  */
8765
- listVirtualRobotTcps: (cell: string, controller: string, motionGroup: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
8743
+ getVirtualRobotBehavior: (cell: string, controller: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
8766
8744
  /**
8767
- * Sets 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. The transformation offset is defined by a unique identifier, a name for front end usage and an offset in another coordinate system referenced by the unique identifier of the reference coordinate system.
8768
- * @summary Set Mounting
8745
+ * Set virtual controller behavior.
8746
+ * @summary Set Behavior
8769
8747
  * @param {string} cell Unique identifier addressing a cell in all API calls.
8770
8748
  * @param {string} controller Unique identifier to address a controller in the cell.
8771
- * @param {string} motionGroup The motion-group identifier.
8772
- * @param {CoordinateSystem} coordinateSystem
8749
+ * @param {Behavior} [behavior]
8773
8750
  * @param {*} [options] Override http request option.
8774
8751
  * @throws {RequiredError}
8775
8752
  */
8776
- setVirtualRobotMounting: (cell: string, controller: string, motionGroup: string, coordinateSystem: CoordinateSystem, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
8753
+ setVirtualRobotBehavior: (cell: string, controller: string, behavior?: Behavior, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
8777
8754
  };
8778
8755
  /**
8779
- * VirtualRobotSetupApi - functional programming interface
8756
+ * VirtualControllerBehaviorApi - functional programming interface
8780
8757
  * @export
8781
8758
  */
8782
- export declare const VirtualRobotSetupApiFp: (configuration?: Configuration) => {
8759
+ export declare const VirtualControllerBehaviorApiFp: (configuration?: Configuration) => {
8783
8760
  /**
8784
- * Adds a coordinate system to the robot controller.
8785
- * @summary Add Coordinate Systems
8761
+ * <!-- 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.
8762
+ * @summary Stream Joint Configuration
8786
8763
  * @param {string} cell Unique identifier addressing a cell in all API calls.
8787
8764
  * @param {string} controller Unique identifier to address a controller in the cell.
8788
- * @param {CoordinateSystem} coordinateSystem
8765
+ * @param {ExternalJointStreamRequest} externalJointStreamRequest
8789
8766
  * @param {*} [options] Override http request option.
8790
8767
  * @throws {RequiredError}
8791
8768
  */
8792
- addVirtualRobotCoordinateSystem(cell: string, controller: string, coordinateSystem: CoordinateSystem, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
8769
+ externalJointsStream(cell: string, controller: string, externalJointStreamRequest: ExternalJointStreamRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<ExternalJointStreamDatapoint>>>;
8793
8770
  /**
8794
- * 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.
8795
- * @summary Add TCP
8771
+ * Get the cycle time of controller communication in [ms].
8772
+ * @summary Get Cycle Time
8796
8773
  * @param {string} cell Unique identifier addressing a cell in all API calls.
8797
8774
  * @param {string} controller Unique identifier to address a controller in the cell.
8798
- * @param {string} motionGroup The motion-group identifier.
8799
- * @param {RobotTcp} robotTcp
8800
8775
  * @param {*} [options] Override http request option.
8801
8776
  * @throws {RequiredError}
8802
8777
  */
8803
- addVirtualRobotTcp(cell: string, controller: string, motionGroup: string, robotTcp: RobotTcp, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
8778
+ getCycleTime(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CycleTime>>;
8804
8779
  /**
8805
- * Deletes a coordinate system from the virtual controller. This will remove the coordinate system from the list of coordinate systems and remove all dependent coordinate systems which use the deleted coordinate system as reference.
8806
- * @summary Remove Coordinate System
8780
+ * Get the current virtual controller behavior - please see the setter [setVirtualRobotBehavior](setVirtualRobotBehavior) and the enum for details.
8781
+ * @summary Get Behavior
8807
8782
  * @param {string} cell Unique identifier addressing a cell in all API calls.
8808
8783
  * @param {string} controller Unique identifier to address a controller in the cell.
8809
- * @param {string} coordinateSystem Unique identifier addressing a coordinate system.
8810
- * @param {boolean} [deleteDependent] If true, all dependent coordinate systems will be deleted as well.
8811
8784
  * @param {*} [options] Override http request option.
8812
8785
  * @throws {RequiredError}
8813
8786
  */
8814
- deleteVirtualRobotCoordinateSystem(cell: string, controller: string, coordinateSystem: string, deleteDependent?: boolean, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
8787
+ getVirtualRobotBehavior(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Behavior>>;
8815
8788
  /**
8816
- * Removes the TCP from the motion group. An unknown TCP is a valid input.
8817
- * @summary Remove TCP
8789
+ * Set virtual controller behavior.
8790
+ * @summary Set Behavior
8818
8791
  * @param {string} cell Unique identifier addressing a cell in all API calls.
8819
8792
  * @param {string} controller Unique identifier to address a controller in the cell.
8820
- * @param {string} motionGroup The motion-group identifier.
8821
- * @param {string} tcp The unique identifier of a TCP.
8793
+ * @param {Behavior} [behavior]
8822
8794
  * @param {*} [options] Override http request option.
8823
8795
  * @throws {RequiredError}
8824
8796
  */
8825
- deleteVirtualRobotTcp(cell: string, controller: string, motionGroup: string, tcp: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
8797
+ setVirtualRobotBehavior(cell: string, controller: string, behavior?: Behavior, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
8798
+ };
8799
+ /**
8800
+ * VirtualControllerBehaviorApi - factory interface
8801
+ * @export
8802
+ */
8803
+ export declare const VirtualControllerBehaviorApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
8826
8804
  /**
8827
- * Gets motion group mounting. The motion group is based on the origin of the returned coordinate system.
8828
- * @summary Get Mounting
8805
+ * <!-- 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.
8806
+ * @summary Stream Joint Configuration
8829
8807
  * @param {string} cell Unique identifier addressing a cell in all API calls.
8830
8808
  * @param {string} controller Unique identifier to address a controller in the cell.
8831
- * @param {string} motionGroup The motion-group identifier.
8809
+ * @param {ExternalJointStreamRequest} externalJointStreamRequest
8832
8810
  * @param {*} [options] Override http request option.
8833
8811
  * @throws {RequiredError}
8834
8812
  */
8835
- getVirtualRobotMounting(cell: string, controller: string, motionGroup: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CoordinateSystem>>;
8813
+ externalJointsStream(cell: string, controller: string, externalJointStreamRequest: ExternalJointStreamRequest, options?: RawAxiosRequestConfig): AxiosPromise<Array<ExternalJointStreamDatapoint>>;
8836
8814
  /**
8837
- * Lists all coordinate systems on the robot controller.
8838
- * @summary List Coordinate Systems
8815
+ * Get the cycle time of controller communication in [ms].
8816
+ * @summary Get Cycle Time
8839
8817
  * @param {string} cell Unique identifier addressing a cell in all API calls.
8840
8818
  * @param {string} controller Unique identifier to address a controller in the cell.
8841
8819
  * @param {*} [options] Override http request option.
8842
8820
  * @throws {RequiredError}
8843
8821
  */
8844
- listVirtualRobotCoordinateSystems(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CoordinateSystems>>;
8822
+ getCycleTime(cell: string, controller: string, options?: RawAxiosRequestConfig): AxiosPromise<CycleTime>;
8845
8823
  /**
8846
- * Lists TCPs of the motion group. An empty TCP list is valid, for example for external axes.
8847
- * @summary List TCPs
8824
+ * Get the current virtual controller behavior - please see the setter [setVirtualRobotBehavior](setVirtualRobotBehavior) and the enum for details.
8825
+ * @summary Get Behavior
8848
8826
  * @param {string} cell Unique identifier addressing a cell in all API calls.
8849
8827
  * @param {string} controller Unique identifier to address a controller in the cell.
8850
- * @param {string} motionGroup The motion-group identifier.
8851
8828
  * @param {*} [options] Override http request option.
8852
8829
  * @throws {RequiredError}
8853
8830
  */
8854
- listVirtualRobotTcps(cell: string, controller: string, motionGroup: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<RobotTcps>>;
8831
+ getVirtualRobotBehavior(cell: string, controller: string, options?: RawAxiosRequestConfig): AxiosPromise<Behavior>;
8855
8832
  /**
8856
- * Sets 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. The transformation offset is defined by a unique identifier, a name for front end usage and an offset in another coordinate system referenced by the unique identifier of the reference coordinate system.
8857
- * @summary Set Mounting
8833
+ * Set virtual controller behavior.
8834
+ * @summary Set Behavior
8858
8835
  * @param {string} cell Unique identifier addressing a cell in all API calls.
8859
8836
  * @param {string} controller Unique identifier to address a controller in the cell.
8860
- * @param {string} motionGroup The motion-group identifier.
8861
- * @param {CoordinateSystem} coordinateSystem
8837
+ * @param {Behavior} [behavior]
8862
8838
  * @param {*} [options] Override http request option.
8863
8839
  * @throws {RequiredError}
8864
8840
  */
8865
- setVirtualRobotMounting(cell: string, controller: string, motionGroup: string, coordinateSystem: CoordinateSystem, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CoordinateSystem>>;
8841
+ setVirtualRobotBehavior(cell: string, controller: string, behavior?: Behavior, options?: RawAxiosRequestConfig): AxiosPromise<void>;
8866
8842
  };
8867
8843
  /**
8868
- * VirtualRobotSetupApi - factory interface
8844
+ * VirtualControllerBehaviorApi - object-oriented interface
8869
8845
  * @export
8846
+ * @class VirtualControllerBehaviorApi
8847
+ * @extends {BaseAPI}
8870
8848
  */
8871
- export declare const VirtualRobotSetupApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
8849
+ export declare class VirtualControllerBehaviorApi extends BaseAPI {
8872
8850
  /**
8873
- * Adds a coordinate system to the robot controller.
8874
- * @summary Add Coordinate Systems
8851
+ * <!-- 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.
8852
+ * @summary Stream Joint Configuration
8875
8853
  * @param {string} cell Unique identifier addressing a cell in all API calls.
8876
8854
  * @param {string} controller Unique identifier to address a controller in the cell.
8877
- * @param {CoordinateSystem} coordinateSystem
8855
+ * @param {ExternalJointStreamRequest} externalJointStreamRequest
8878
8856
  * @param {*} [options] Override http request option.
8879
8857
  * @throws {RequiredError}
8858
+ * @memberof VirtualControllerBehaviorApi
8880
8859
  */
8881
- addVirtualRobotCoordinateSystem(cell: string, controller: string, coordinateSystem: CoordinateSystem, options?: RawAxiosRequestConfig): AxiosPromise<void>;
8860
+ externalJointsStream(cell: string, controller: string, externalJointStreamRequest: ExternalJointStreamRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ExternalJointStreamDatapoint[], any>>;
8882
8861
  /**
8883
- * 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.
8884
- * @summary Add TCP
8862
+ * Get the cycle time of controller communication in [ms].
8863
+ * @summary Get Cycle Time
8885
8864
  * @param {string} cell Unique identifier addressing a cell in all API calls.
8886
8865
  * @param {string} controller Unique identifier to address a controller in the cell.
8887
- * @param {string} motionGroup The motion-group identifier.
8888
- * @param {RobotTcp} robotTcp
8889
8866
  * @param {*} [options] Override http request option.
8890
8867
  * @throws {RequiredError}
8868
+ * @memberof VirtualControllerBehaviorApi
8891
8869
  */
8892
- addVirtualRobotTcp(cell: string, controller: string, motionGroup: string, robotTcp: RobotTcp, options?: RawAxiosRequestConfig): AxiosPromise<void>;
8870
+ getCycleTime(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CycleTime, any>>;
8893
8871
  /**
8894
- * Deletes a coordinate system from the virtual controller. This will remove the coordinate system from the list of coordinate systems and remove all dependent coordinate systems which use the deleted coordinate system as reference.
8895
- * @summary Remove Coordinate System
8872
+ * Get the current virtual controller behavior - please see the setter [setVirtualRobotBehavior](setVirtualRobotBehavior) and the enum for details.
8873
+ * @summary Get Behavior
8896
8874
  * @param {string} cell Unique identifier addressing a cell in all API calls.
8897
8875
  * @param {string} controller Unique identifier to address a controller in the cell.
8898
- * @param {string} coordinateSystem Unique identifier addressing a coordinate system.
8899
- * @param {boolean} [deleteDependent] If true, all dependent coordinate systems will be deleted as well.
8900
8876
  * @param {*} [options] Override http request option.
8901
8877
  * @throws {RequiredError}
8878
+ * @memberof VirtualControllerBehaviorApi
8902
8879
  */
8903
- deleteVirtualRobotCoordinateSystem(cell: string, controller: string, coordinateSystem: string, deleteDependent?: boolean, options?: RawAxiosRequestConfig): AxiosPromise<void>;
8880
+ getVirtualRobotBehavior(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Behavior, any>>;
8904
8881
  /**
8905
- * Removes the TCP from the motion group. An unknown TCP is a valid input.
8906
- * @summary Remove TCP
8882
+ * Set virtual controller behavior.
8883
+ * @summary Set Behavior
8907
8884
  * @param {string} cell Unique identifier addressing a cell in all API calls.
8908
8885
  * @param {string} controller Unique identifier to address a controller in the cell.
8909
- * @param {string} motionGroup The motion-group identifier.
8910
- * @param {string} tcp The unique identifier of a TCP.
8886
+ * @param {Behavior} [behavior]
8911
8887
  * @param {*} [options] Override http request option.
8912
8888
  * @throws {RequiredError}
8889
+ * @memberof VirtualControllerBehaviorApi
8913
8890
  */
8914
- deleteVirtualRobotTcp(cell: string, controller: string, motionGroup: string, tcp: string, options?: RawAxiosRequestConfig): AxiosPromise<void>;
8891
+ setVirtualRobotBehavior(cell: string, controller: string, behavior?: Behavior, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
8892
+ }
8893
+ /**
8894
+ * VirtualControllerInputsOutputsApi - axios parameter creator
8895
+ * @export
8896
+ */
8897
+ export declare const VirtualControllerInputsOutputsApiAxiosParamCreator: (configuration?: Configuration) => {
8915
8898
  /**
8916
- * Gets motion group mounting. The motion group is based on the origin of the returned coordinate system.
8917
- * @summary Get Mounting
8899
+ * Retrieves the current values of inputs/outputs of the virtual controller. The identifiers of inputs/outputs must be provided in the request. Request all available input/output identifiers via [listVirtualRobotIODescriptions](listVirtualRobotIODescriptions).
8900
+ * @summary Get Input/Output Values
8918
8901
  * @param {string} cell Unique identifier addressing a cell in all API calls.
8919
8902
  * @param {string} controller Unique identifier to address a controller in the cell.
8920
- * @param {string} motionGroup The motion-group identifier.
8903
+ * @param {Array<string>} ios
8921
8904
  * @param {*} [options] Override http request option.
8922
8905
  * @throws {RequiredError}
8923
8906
  */
8924
- getVirtualRobotMounting(cell: string, controller: string, motionGroup: string, options?: RawAxiosRequestConfig): AxiosPromise<CoordinateSystem>;
8907
+ listIOs: (cell: string, controller: string, ios: Array<string>, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
8925
8908
  /**
8926
- * Lists all coordinate systems on the robot controller.
8927
- * @summary List Coordinate Systems
8909
+ * 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.
8910
+ * @summary List Descriptions
8928
8911
  * @param {string} cell Unique identifier addressing a cell in all API calls.
8929
8912
  * @param {string} controller Unique identifier to address a controller in the cell.
8913
+ * @param {Array<string>} [ios]
8914
+ * @param {IODirection} [direction] Return only inputs/outputs with the specified direction.
8915
+ * @param {IOValueType} [valueType] Return only inputs/outputs with the specified value type.
8916
+ * @param {string} [group] Return only inputs/outputs from the specified group.
8930
8917
  * @param {*} [options] Override http request option.
8931
8918
  * @throws {RequiredError}
8932
8919
  */
8933
- listVirtualRobotCoordinateSystems(cell: string, controller: string, options?: RawAxiosRequestConfig): AxiosPromise<CoordinateSystems>;
8920
+ listVirtualRobotIODescriptions: (cell: string, controller: string, ios?: Array<string>, direction?: IODirection, valueType?: IOValueType, group?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
8934
8921
  /**
8935
- * Lists TCPs of the motion group. An empty TCP list is valid, for example for external axes.
8936
- * @summary List TCPs
8922
+ * Sets a list of values of a virtual controller inputs/outputs.
8923
+ * @summary Set Input/Ouput Values
8937
8924
  * @param {string} cell Unique identifier addressing a cell in all API calls.
8938
8925
  * @param {string} controller Unique identifier to address a controller in the cell.
8939
- * @param {string} motionGroup The motion-group identifier.
8926
+ * @param {Array<IOValue>} iOValue
8940
8927
  * @param {*} [options] Override http request option.
8941
8928
  * @throws {RequiredError}
8942
8929
  */
8943
- listVirtualRobotTcps(cell: string, controller: string, motionGroup: string, options?: RawAxiosRequestConfig): AxiosPromise<RobotTcps>;
8930
+ setIOValues: (cell: string, controller: string, iOValue: Array<IOValue>, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
8931
+ };
8932
+ /**
8933
+ * VirtualControllerInputsOutputsApi - functional programming interface
8934
+ * @export
8935
+ */
8936
+ export declare const VirtualControllerInputsOutputsApiFp: (configuration?: Configuration) => {
8944
8937
  /**
8945
- * Sets 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. The transformation offset is defined by a unique identifier, a name for front end usage and an offset in another coordinate system referenced by the unique identifier of the reference coordinate system.
8946
- * @summary Set Mounting
8938
+ * Retrieves the current values of inputs/outputs of the virtual controller. The identifiers of inputs/outputs must be provided in the request. Request all available input/output identifiers via [listVirtualRobotIODescriptions](listVirtualRobotIODescriptions).
8939
+ * @summary Get Input/Output Values
8947
8940
  * @param {string} cell Unique identifier addressing a cell in all API calls.
8948
8941
  * @param {string} controller Unique identifier to address a controller in the cell.
8949
- * @param {string} motionGroup The motion-group identifier.
8950
- * @param {CoordinateSystem} coordinateSystem
8942
+ * @param {Array<string>} ios
8951
8943
  * @param {*} [options] Override http request option.
8952
8944
  * @throws {RequiredError}
8953
8945
  */
8954
- setVirtualRobotMounting(cell: string, controller: string, motionGroup: string, coordinateSystem: CoordinateSystem, options?: RawAxiosRequestConfig): AxiosPromise<CoordinateSystem>;
8955
- };
8956
- /**
8957
- * VirtualRobotSetupApi - object-oriented interface
8958
- * @export
8959
- * @class VirtualRobotSetupApi
8960
- * @extends {BaseAPI}
8961
- */
8962
- export declare class VirtualRobotSetupApi extends BaseAPI {
8946
+ listIOs(cell: string, controller: string, ios: Array<string>, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<IOValue>>>;
8963
8947
  /**
8964
- * Adds a coordinate system to the robot controller.
8965
- * @summary Add Coordinate Systems
8948
+ * 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.
8949
+ * @summary List Descriptions
8966
8950
  * @param {string} cell Unique identifier addressing a cell in all API calls.
8967
8951
  * @param {string} controller Unique identifier to address a controller in the cell.
8968
- * @param {CoordinateSystem} coordinateSystem
8952
+ * @param {Array<string>} [ios]
8953
+ * @param {IODirection} [direction] Return only inputs/outputs with the specified direction.
8954
+ * @param {IOValueType} [valueType] Return only inputs/outputs with the specified value type.
8955
+ * @param {string} [group] Return only inputs/outputs from the specified group.
8969
8956
  * @param {*} [options] Override http request option.
8970
8957
  * @throws {RequiredError}
8971
- * @memberof VirtualRobotSetupApi
8972
8958
  */
8973
- addVirtualRobotCoordinateSystem(cell: string, controller: string, coordinateSystem: CoordinateSystem, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
8959
+ listVirtualRobotIODescriptions(cell: string, controller: string, ios?: Array<string>, direction?: IODirection, valueType?: IOValueType, group?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<IODescription>>>;
8974
8960
  /**
8975
- * 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.
8976
- * @summary Add TCP
8961
+ * Sets a list of values of a virtual controller inputs/outputs.
8962
+ * @summary Set Input/Ouput Values
8977
8963
  * @param {string} cell Unique identifier addressing a cell in all API calls.
8978
8964
  * @param {string} controller Unique identifier to address a controller in the cell.
8979
- * @param {string} motionGroup The motion-group identifier.
8980
- * @param {RobotTcp} robotTcp
8965
+ * @param {Array<IOValue>} iOValue
8981
8966
  * @param {*} [options] Override http request option.
8982
8967
  * @throws {RequiredError}
8983
- * @memberof VirtualRobotSetupApi
8984
8968
  */
8985
- addVirtualRobotTcp(cell: string, controller: string, motionGroup: string, robotTcp: RobotTcp, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
8969
+ setIOValues(cell: string, controller: string, iOValue: Array<IOValue>, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
8970
+ };
8971
+ /**
8972
+ * VirtualControllerInputsOutputsApi - factory interface
8973
+ * @export
8974
+ */
8975
+ export declare const VirtualControllerInputsOutputsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
8986
8976
  /**
8987
- * Deletes a coordinate system from the virtual controller. This will remove the coordinate system from the list of coordinate systems and remove all dependent coordinate systems which use the deleted coordinate system as reference.
8988
- * @summary Remove Coordinate System
8977
+ * Retrieves the current values of inputs/outputs of the virtual controller. The identifiers of inputs/outputs must be provided in the request. Request all available input/output identifiers via [listVirtualRobotIODescriptions](listVirtualRobotIODescriptions).
8978
+ * @summary Get Input/Output Values
8989
8979
  * @param {string} cell Unique identifier addressing a cell in all API calls.
8990
8980
  * @param {string} controller Unique identifier to address a controller in the cell.
8991
- * @param {string} coordinateSystem Unique identifier addressing a coordinate system.
8992
- * @param {boolean} [deleteDependent] If true, all dependent coordinate systems will be deleted as well.
8981
+ * @param {Array<string>} ios
8993
8982
  * @param {*} [options] Override http request option.
8994
8983
  * @throws {RequiredError}
8995
- * @memberof VirtualRobotSetupApi
8996
8984
  */
8997
- deleteVirtualRobotCoordinateSystem(cell: string, controller: string, coordinateSystem: string, deleteDependent?: boolean, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
8985
+ listIOs(cell: string, controller: string, ios: Array<string>, options?: RawAxiosRequestConfig): AxiosPromise<Array<IOValue>>;
8998
8986
  /**
8999
- * Removes the TCP from the motion group. An unknown TCP is a valid input.
9000
- * @summary Remove TCP
8987
+ * 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.
8988
+ * @summary List Descriptions
9001
8989
  * @param {string} cell Unique identifier addressing a cell in all API calls.
9002
8990
  * @param {string} controller Unique identifier to address a controller in the cell.
9003
- * @param {string} motionGroup The motion-group identifier.
9004
- * @param {string} tcp The unique identifier of a TCP.
8991
+ * @param {Array<string>} [ios]
8992
+ * @param {IODirection} [direction] Return only inputs/outputs with the specified direction.
8993
+ * @param {IOValueType} [valueType] Return only inputs/outputs with the specified value type.
8994
+ * @param {string} [group] Return only inputs/outputs from the specified group.
9005
8995
  * @param {*} [options] Override http request option.
9006
8996
  * @throws {RequiredError}
9007
- * @memberof VirtualRobotSetupApi
9008
8997
  */
9009
- deleteVirtualRobotTcp(cell: string, controller: string, motionGroup: string, tcp: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
8998
+ listVirtualRobotIODescriptions(cell: string, controller: string, ios?: Array<string>, direction?: IODirection, valueType?: IOValueType, group?: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<IODescription>>;
9010
8999
  /**
9011
- * Gets motion group mounting. The motion group is based on the origin of the returned coordinate system.
9012
- * @summary Get Mounting
9000
+ * Sets a list of values of a virtual controller inputs/outputs.
9001
+ * @summary Set Input/Ouput Values
9013
9002
  * @param {string} cell Unique identifier addressing a cell in all API calls.
9014
9003
  * @param {string} controller Unique identifier to address a controller in the cell.
9015
- * @param {string} motionGroup The motion-group identifier.
9004
+ * @param {Array<IOValue>} iOValue
9016
9005
  * @param {*} [options] Override http request option.
9017
9006
  * @throws {RequiredError}
9018
- * @memberof VirtualRobotSetupApi
9019
9007
  */
9020
- getVirtualRobotMounting(cell: string, controller: string, motionGroup: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CoordinateSystem, any>>;
9008
+ setIOValues(cell: string, controller: string, iOValue: Array<IOValue>, options?: RawAxiosRequestConfig): AxiosPromise<void>;
9009
+ };
9010
+ /**
9011
+ * VirtualControllerInputsOutputsApi - object-oriented interface
9012
+ * @export
9013
+ * @class VirtualControllerInputsOutputsApi
9014
+ * @extends {BaseAPI}
9015
+ */
9016
+ export declare class VirtualControllerInputsOutputsApi extends BaseAPI {
9021
9017
  /**
9022
- * Lists all coordinate systems on the robot controller.
9023
- * @summary List Coordinate Systems
9018
+ * Retrieves the current values of inputs/outputs of the virtual controller. The identifiers of inputs/outputs must be provided in the request. Request all available input/output identifiers via [listVirtualRobotIODescriptions](listVirtualRobotIODescriptions).
9019
+ * @summary Get Input/Output Values
9024
9020
  * @param {string} cell Unique identifier addressing a cell in all API calls.
9025
9021
  * @param {string} controller Unique identifier to address a controller in the cell.
9022
+ * @param {Array<string>} ios
9026
9023
  * @param {*} [options] Override http request option.
9027
9024
  * @throws {RequiredError}
9028
- * @memberof VirtualRobotSetupApi
9025
+ * @memberof VirtualControllerInputsOutputsApi
9029
9026
  */
9030
- listVirtualRobotCoordinateSystems(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CoordinateSystems, any>>;
9027
+ listIOs(cell: string, controller: string, ios: Array<string>, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<IOValue[], any>>;
9031
9028
  /**
9032
- * Lists TCPs of the motion group. An empty TCP list is valid, for example for external axes.
9033
- * @summary List TCPs
9029
+ * 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.
9030
+ * @summary List Descriptions
9034
9031
  * @param {string} cell Unique identifier addressing a cell in all API calls.
9035
9032
  * @param {string} controller Unique identifier to address a controller in the cell.
9036
- * @param {string} motionGroup The motion-group identifier.
9033
+ * @param {Array<string>} [ios]
9034
+ * @param {IODirection} [direction] Return only inputs/outputs with the specified direction.
9035
+ * @param {IOValueType} [valueType] Return only inputs/outputs with the specified value type.
9036
+ * @param {string} [group] Return only inputs/outputs from the specified group.
9037
9037
  * @param {*} [options] Override http request option.
9038
9038
  * @throws {RequiredError}
9039
- * @memberof VirtualRobotSetupApi
9039
+ * @memberof VirtualControllerInputsOutputsApi
9040
9040
  */
9041
- listVirtualRobotTcps(cell: string, controller: string, motionGroup: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<RobotTcps, any>>;
9041
+ listVirtualRobotIODescriptions(cell: string, controller: string, ios?: Array<string>, direction?: IODirection, valueType?: IOValueType, group?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<IODescription[], any>>;
9042
9042
  /**
9043
- * Sets 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. The transformation offset is defined by a unique identifier, a name for front end usage and an offset in another coordinate system referenced by the unique identifier of the reference coordinate system.
9044
- * @summary Set Mounting
9043
+ * Sets a list of values of a virtual controller inputs/outputs.
9044
+ * @summary Set Input/Ouput Values
9045
9045
  * @param {string} cell Unique identifier addressing a cell in all API calls.
9046
9046
  * @param {string} controller Unique identifier to address a controller in the cell.
9047
- * @param {string} motionGroup The motion-group identifier.
9048
- * @param {CoordinateSystem} coordinateSystem
9047
+ * @param {Array<IOValue>} iOValue
9049
9048
  * @param {*} [options] Override http request option.
9050
9049
  * @throws {RequiredError}
9051
- * @memberof VirtualRobotSetupApi
9050
+ * @memberof VirtualControllerInputsOutputsApi
9052
9051
  */
9053
- setVirtualRobotMounting(cell: string, controller: string, motionGroup: string, coordinateSystem: CoordinateSystem, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CoordinateSystem, any>>;
9052
+ setIOValues(cell: string, controller: string, iOValue: Array<IOValue>, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
9054
9053
  }