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

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 +664 -597
  3. package/v2/api.js +1348 -1236
  4. package/v2/api.js.map +1 -1
  5. package/v2/api.ts +1423 -1290
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
  */
@@ -859,6 +859,37 @@ export interface ContainerStorage {
859
859
  */
860
860
  'capacity': string;
861
861
  }
862
+ /**
863
+ * The data type to describe a robot controller.
864
+ * @export
865
+ * @interface ControllerDescription
866
+ */
867
+ export interface ControllerDescription {
868
+ /**
869
+ *
870
+ * @type {Array<string>}
871
+ * @memberof ControllerDescription
872
+ */
873
+ 'connected_motion_groups': Array<string>;
874
+ /**
875
+ * Can this controller be moved through freedrive (true), or not (false).
876
+ * @type {boolean}
877
+ * @memberof ControllerDescription
878
+ */
879
+ 'supports_freedrive': boolean;
880
+ /**
881
+ * Can this controller be controlled with NOVA (true) or is it only possible to read data (false).
882
+ * @type {boolean}
883
+ * @memberof ControllerDescription
884
+ */
885
+ 'supports_control': boolean;
886
+ /**
887
+ * True if NOVA supports reading safety zone-, tool- and link-geometries for this motion group. Safety zones are used to define areas where the robot should slow down or stop. If false, NOVA can\'t guarantee that the executed motions respect safety zones defined on the controller.
888
+ * @type {boolean}
889
+ * @memberof ControllerDescription
890
+ */
891
+ 'supports_safety_zones': boolean;
892
+ }
862
893
  /**
863
894
  * Defines a convex hull encapsulating a set of vertices.
864
895
  * @export
@@ -888,12 +919,6 @@ export type ConvexHullShapeTypeEnum = typeof ConvexHullShapeTypeEnum[keyof typeo
888
919
  * @interface CoordinateSystem
889
920
  */
890
921
  export interface CoordinateSystem {
891
- /**
892
- * Unique identifier of the coordinate system.
893
- * @type {string}
894
- * @memberof CoordinateSystem
895
- */
896
- 'coordinate_system': string;
897
922
  /**
898
923
  * Human readable name of this coordinate system.
899
924
  * @type {string}
@@ -924,19 +949,49 @@ export interface CoordinateSystem {
924
949
  * @memberof CoordinateSystem
925
950
  */
926
951
  'orientation_type'?: OrientationType;
952
+ /**
953
+ * Unique identifier of the coordinate system.
954
+ * @type {string}
955
+ * @memberof CoordinateSystem
956
+ */
957
+ 'coordinate_system': string;
927
958
  }
928
959
  /**
929
960
  *
930
961
  * @export
931
- * @interface CoordinateSystems
962
+ * @interface CoordinateSystemData
932
963
  */
933
- export interface CoordinateSystems {
964
+ export interface CoordinateSystemData {
965
+ /**
966
+ * Human readable name of this coordinate system.
967
+ * @type {string}
968
+ * @memberof CoordinateSystemData
969
+ */
970
+ 'name'?: string;
971
+ /**
972
+ * The identifier of the reference coordinate system. Empty if world is used.
973
+ * @type {string}
974
+ * @memberof CoordinateSystemData
975
+ */
976
+ 'reference_coordinate_system'?: string;
977
+ /**
978
+ * A three-dimensional vector [x, y, z] with double precision.
979
+ * @type {Array<number>}
980
+ * @memberof CoordinateSystemData
981
+ */
982
+ 'position'?: Array<number>;
983
+ /**
984
+ * Describes an orientation in 3D space. A tree-to-four-dimensional vector [x, y, z, w] with double precision.
985
+ * @type {Array<number>}
986
+ * @memberof CoordinateSystemData
987
+ */
988
+ 'orientation'?: Array<number>;
934
989
  /**
935
990
  *
936
- * @type {Array<CoordinateSystem>}
937
- * @memberof CoordinateSystems
991
+ * @type {OrientationType}
992
+ * @memberof CoordinateSystemData
938
993
  */
939
- 'coordinate_systems': Array<CoordinateSystem>;
994
+ 'orientation_type'?: OrientationType;
940
995
  }
941
996
  /**
942
997
  *
@@ -1138,41 +1193,23 @@ export interface ExternalJointStreamDatapoint {
1138
1193
  'motion_group': string;
1139
1194
  /**
1140
1195
  *
1141
- * @type {ExternalJointStreamDatapointValue}
1196
+ * @type {MotionGroupJoints}
1142
1197
  * @memberof ExternalJointStreamDatapoint
1143
1198
  */
1144
- 'value': ExternalJointStreamDatapointValue;
1199
+ 'value': MotionGroupJoints;
1145
1200
  }
1146
1201
  /**
1147
- * The joint-values of the external joint stream datapoint.
1202
+ *
1148
1203
  * @export
1149
- * @interface ExternalJointStreamDatapointValue
1204
+ * @interface ExternalJointStreamRequest
1150
1205
  */
1151
- export interface ExternalJointStreamDatapointValue {
1152
- /**
1153
- * The joint positions of the robot.
1154
- * @type {Array<number>}
1155
- * @memberof ExternalJointStreamDatapointValue
1156
- */
1157
- 'positions': Array<number>;
1206
+ export interface ExternalJointStreamRequest {
1158
1207
  /**
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>;
1170
- /**
1171
- * The joint torques of the robot.
1172
- * @type {Array<number>}
1173
- * @memberof ExternalJointStreamDatapointValue
1208
+ *
1209
+ * @type {Array<ExternalJointStreamDatapoint>}
1210
+ * @memberof ExternalJointStreamRequest
1174
1211
  */
1175
- 'torques': Array<number>;
1212
+ 'states': Array<ExternalJointStreamDatapoint>;
1176
1213
  }
1177
1214
  /**
1178
1215
  * The configuration of a physical FANUC robot controller has to contain IP address of the controller.
@@ -2334,19 +2371,6 @@ export interface LimitsOverride {
2334
2371
  */
2335
2372
  'tcp_orientation_acceleration_limit'?: number;
2336
2373
  }
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
2374
  /**
2351
2375
  *
2352
2376
  * @export
@@ -2428,19 +2452,6 @@ export type MotionCommandBlending = BlendingAuto | BlendingPosition;
2428
2452
  * @export
2429
2453
  */
2430
2454
  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
2455
  /**
2445
2456
  * The configuration of a motion-group used for motion planning.
2446
2457
  * @export
@@ -2452,7 +2463,7 @@ export interface MotionGroupDescription {
2452
2463
  * @type {string}
2453
2464
  * @memberof MotionGroupDescription
2454
2465
  */
2455
- 'motion_group_type': string;
2466
+ 'motion_group_model': string;
2456
2467
  /**
2457
2468
  * The offset from the world frame to the motion group base.
2458
2469
  * @type {Pose}
@@ -2545,19 +2556,6 @@ export interface MotionGroupInfo {
2545
2556
  */
2546
2557
  'dof': number;
2547
2558
  }
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
2559
  /**
2562
2560
  * Ensure to provide one value for each joint. See [getMotionGroups](getMotionGroups) for the number of joints. Everything but positions is optional.
2563
2561
  * @export
@@ -2719,7 +2717,7 @@ export interface MovementErrorResponse {
2719
2717
  'kind': MovementErrorResponseKindEnum;
2720
2718
  }
2721
2719
  export declare const MovementErrorResponseKindEnum: {
2722
- readonly Error: "ERROR";
2720
+ readonly MotionError: "MOTION_ERROR";
2723
2721
  };
2724
2722
  export type MovementErrorResponseKindEnum = typeof MovementErrorResponseKindEnum[keyof typeof MovementErrorResponseKindEnum];
2725
2723
  /**
@@ -3574,12 +3572,6 @@ export type RobotSystemMode = typeof RobotSystemMode[keyof typeof RobotSystemMod
3574
3572
  * @interface RobotTcp
3575
3573
  */
3576
3574
  export interface RobotTcp {
3577
- /**
3578
- * Identifier of this tcp.
3579
- * @type {string}
3580
- * @memberof RobotTcp
3581
- */
3582
- 'id': string;
3583
3575
  /**
3584
3576
  * A readable and changeable name for frontend visualization.
3585
3577
  * @type {string}
@@ -3604,19 +3596,43 @@ export interface RobotTcp {
3604
3596
  * @memberof RobotTcp
3605
3597
  */
3606
3598
  'orientation_type'?: OrientationType;
3599
+ /**
3600
+ * Identifier of this tcp.
3601
+ * @type {string}
3602
+ * @memberof RobotTcp
3603
+ */
3604
+ 'id': string;
3607
3605
  }
3608
3606
  /**
3609
3607
  *
3610
3608
  * @export
3611
- * @interface RobotTcps
3609
+ * @interface RobotTcpData
3612
3610
  */
3613
- export interface RobotTcps {
3611
+ export interface RobotTcpData {
3612
+ /**
3613
+ * A readable and changeable name for frontend visualization.
3614
+ * @type {string}
3615
+ * @memberof RobotTcpData
3616
+ */
3617
+ 'name'?: string;
3618
+ /**
3619
+ * A three-dimensional vector [x, y, z] with double precision.
3620
+ * @type {Array<number>}
3621
+ * @memberof RobotTcpData
3622
+ */
3623
+ 'position': Array<number>;
3624
+ /**
3625
+ * Describes an orientation in 3D space. A tree-to-four-dimensional vector [x, y, z, w] with double precision.
3626
+ * @type {Array<number>}
3627
+ * @memberof RobotTcpData
3628
+ */
3629
+ 'orientation'?: Array<number>;
3614
3630
  /**
3615
3631
  *
3616
- * @type {Array<RobotTcp>}
3617
- * @memberof RobotTcps
3632
+ * @type {OrientationType}
3633
+ * @memberof RobotTcpData
3618
3634
  */
3619
- 'tcps': Array<RobotTcp>;
3635
+ 'orientation_type'?: OrientationType;
3620
3636
  }
3621
3637
  /**
3622
3638
  *
@@ -5090,6 +5106,15 @@ export declare const ControllerApiAxiosParamCreator: (configuration?: Configurat
5090
5106
  * @throws {RequiredError}
5091
5107
  */
5092
5108
  deleteRobotController: (cell: string, controller: string, completionTimeout?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
5109
+ /**
5110
+ * Get description of a configured robot controller including a list of connected motion group identifiers. Use [getMotionGroupDescription](getMotionGroupDescription) to get more information about the motion group.
5111
+ * @summary Description
5112
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
5113
+ * @param {string} controller Unique identifier to address a controller in the cell.
5114
+ * @param {*} [options] Override http request option.
5115
+ * @throws {RequiredError}
5116
+ */
5117
+ getControllerDescription: (cell: string, controller: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
5093
5118
  /**
5094
5119
  * Request a coordinate system specification for a given identifier. Use parameter orientation_type to get the orientation part of the transformation offset of the coordinate system returned in the requested orientation notation. If parameter orientation_type is not set, the orientation part of the transformation offset of the coordinate system is returned in rotation vector notation. The coordinate systems from the robot controller are loaded when the motion group associated with the coordinate system is activated. With deactivation of the motion group, the associated coordinate systems are removed from NOVA. The unique identifier of the coordinate systems from the robot controllers are suffixed with \"On\" + the unique identifier of the robot controller.
5095
5120
  * @summary Coordinate System
@@ -5231,6 +5256,15 @@ export declare const ControllerApiFp: (configuration?: Configuration) => {
5231
5256
  * @throws {RequiredError}
5232
5257
  */
5233
5258
  deleteRobotController(cell: string, controller: string, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
5259
+ /**
5260
+ * Get description of a configured robot controller including a list of connected motion group identifiers. Use [getMotionGroupDescription](getMotionGroupDescription) to get more information about the motion group.
5261
+ * @summary Description
5262
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
5263
+ * @param {string} controller Unique identifier to address a controller in the cell.
5264
+ * @param {*} [options] Override http request option.
5265
+ * @throws {RequiredError}
5266
+ */
5267
+ getControllerDescription(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ControllerDescription>>;
5234
5268
  /**
5235
5269
  * Request a coordinate system specification for a given identifier. Use parameter orientation_type to get the orientation part of the transformation offset of the coordinate system returned in the requested orientation notation. If parameter orientation_type is not set, the orientation part of the transformation offset of the coordinate system is returned in rotation vector notation. The coordinate systems from the robot controller are loaded when the motion group associated with the coordinate system is activated. With deactivation of the motion group, the associated coordinate systems are removed from NOVA. The unique identifier of the coordinate systems from the robot controllers are suffixed with \"On\" + the unique identifier of the robot controller.
5236
5270
  * @summary Coordinate System
@@ -5287,7 +5321,7 @@ export declare const ControllerApiFp: (configuration?: Configuration) => {
5287
5321
  * @param {*} [options] Override http request option.
5288
5322
  * @throws {RequiredError}
5289
5323
  */
5290
- listCoordinateSystems(cell: string, controller: string, orientationType?: OrientationType, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListCoordinateSystemsResponse>>;
5324
+ listCoordinateSystems(cell: string, controller: string, orientationType?: OrientationType, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<CoordinateSystem>>>;
5291
5325
  /**
5292
5326
  * List the names of all deployed robot controllers.
5293
5327
  * @summary List Robot Controllers
@@ -5372,6 +5406,15 @@ export declare const ControllerApiFactory: (configuration?: Configuration, baseP
5372
5406
  * @throws {RequiredError}
5373
5407
  */
5374
5408
  deleteRobotController(cell: string, controller: string, completionTimeout?: number, options?: RawAxiosRequestConfig): AxiosPromise<void>;
5409
+ /**
5410
+ * Get description of a configured robot controller including a list of connected motion group identifiers. Use [getMotionGroupDescription](getMotionGroupDescription) to get more information about the motion group.
5411
+ * @summary Description
5412
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
5413
+ * @param {string} controller Unique identifier to address a controller in the cell.
5414
+ * @param {*} [options] Override http request option.
5415
+ * @throws {RequiredError}
5416
+ */
5417
+ getControllerDescription(cell: string, controller: string, options?: RawAxiosRequestConfig): AxiosPromise<ControllerDescription>;
5375
5418
  /**
5376
5419
  * Request a coordinate system specification for a given identifier. Use parameter orientation_type to get the orientation part of the transformation offset of the coordinate system returned in the requested orientation notation. If parameter orientation_type is not set, the orientation part of the transformation offset of the coordinate system is returned in rotation vector notation. The coordinate systems from the robot controller are loaded when the motion group associated with the coordinate system is activated. With deactivation of the motion group, the associated coordinate systems are removed from NOVA. The unique identifier of the coordinate systems from the robot controllers are suffixed with \"On\" + the unique identifier of the robot controller.
5377
5420
  * @summary Coordinate System
@@ -5428,7 +5471,7 @@ export declare const ControllerApiFactory: (configuration?: Configuration, baseP
5428
5471
  * @param {*} [options] Override http request option.
5429
5472
  * @throws {RequiredError}
5430
5473
  */
5431
- listCoordinateSystems(cell: string, controller: string, orientationType?: OrientationType, options?: RawAxiosRequestConfig): AxiosPromise<ListCoordinateSystemsResponse>;
5474
+ listCoordinateSystems(cell: string, controller: string, orientationType?: OrientationType, options?: RawAxiosRequestConfig): AxiosPromise<Array<CoordinateSystem>>;
5432
5475
  /**
5433
5476
  * List the names of all deployed robot controllers.
5434
5477
  * @summary List Robot Controllers
@@ -5518,6 +5561,16 @@ export declare class ControllerApi extends BaseAPI {
5518
5561
  * @memberof ControllerApi
5519
5562
  */
5520
5563
  deleteRobotController(cell: string, controller: string, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
5564
+ /**
5565
+ * Get description of a configured robot controller including a list of connected motion group identifiers. Use [getMotionGroupDescription](getMotionGroupDescription) to get more information about the motion group.
5566
+ * @summary Description
5567
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
5568
+ * @param {string} controller Unique identifier to address a controller in the cell.
5569
+ * @param {*} [options] Override http request option.
5570
+ * @throws {RequiredError}
5571
+ * @memberof ControllerApi
5572
+ */
5573
+ getControllerDescription(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ControllerDescription, any>>;
5521
5574
  /**
5522
5575
  * Request a coordinate system specification for a given identifier. Use parameter orientation_type to get the orientation part of the transformation offset of the coordinate system returned in the requested orientation notation. If parameter orientation_type is not set, the orientation part of the transformation offset of the coordinate system is returned in rotation vector notation. The coordinate systems from the robot controller are loaded when the motion group associated with the coordinate system is activated. With deactivation of the motion group, the associated coordinate systems are removed from NOVA. The unique identifier of the coordinate systems from the robot controllers are suffixed with \"On\" + the unique identifier of the robot controller.
5523
5576
  * @summary Coordinate System
@@ -5580,7 +5633,7 @@ export declare class ControllerApi extends BaseAPI {
5580
5633
  * @throws {RequiredError}
5581
5634
  * @memberof ControllerApi
5582
5635
  */
5583
- listCoordinateSystems(cell: string, controller: string, orientationType?: OrientationType, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ListCoordinateSystemsResponse, any>>;
5636
+ listCoordinateSystems(cell: string, controller: string, orientationType?: OrientationType, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CoordinateSystem[], any>>;
5584
5637
  /**
5585
5638
  * List the names of all deployed robot controllers.
5586
5639
  * @summary List Robot Controllers
@@ -5888,11 +5941,12 @@ export declare const JoggingApiAxiosParamCreator: (configuration?: Configuration
5888
5941
  * <!-- 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
5942
  * @summary Execute Jogging
5890
5943
  * @param {string} cell Unique identifier addressing a cell in all API calls.
5944
+ * @param {string} controller Unique identifier to address a controller in the cell.
5891
5945
  * @param {ExecuteJoggingRequest} executeJoggingRequest
5892
5946
  * @param {*} [options] Override http request option.
5893
5947
  * @throws {RequiredError}
5894
5948
  */
5895
- executeJogging: (cell: string, executeJoggingRequest: ExecuteJoggingRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
5949
+ executeJogging: (cell: string, controller: string, executeJoggingRequest: ExecuteJoggingRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
5896
5950
  };
5897
5951
  /**
5898
5952
  * JoggingApi - functional programming interface
@@ -5903,11 +5957,12 @@ export declare const JoggingApiFp: (configuration?: Configuration) => {
5903
5957
  * <!-- 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
5958
  * @summary Execute Jogging
5905
5959
  * @param {string} cell Unique identifier addressing a cell in all API calls.
5960
+ * @param {string} controller Unique identifier to address a controller in the cell.
5906
5961
  * @param {ExecuteJoggingRequest} executeJoggingRequest
5907
5962
  * @param {*} [options] Override http request option.
5908
5963
  * @throws {RequiredError}
5909
5964
  */
5910
- executeJogging(cell: string, executeJoggingRequest: ExecuteJoggingRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ExecuteJoggingResponse>>;
5965
+ executeJogging(cell: string, controller: string, executeJoggingRequest: ExecuteJoggingRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ExecuteJoggingResponse>>;
5911
5966
  };
5912
5967
  /**
5913
5968
  * JoggingApi - factory interface
@@ -5918,11 +5973,12 @@ export declare const JoggingApiFactory: (configuration?: Configuration, basePath
5918
5973
  * <!-- 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
5974
  * @summary Execute Jogging
5920
5975
  * @param {string} cell Unique identifier addressing a cell in all API calls.
5976
+ * @param {string} controller Unique identifier to address a controller in the cell.
5921
5977
  * @param {ExecuteJoggingRequest} executeJoggingRequest
5922
5978
  * @param {*} [options] Override http request option.
5923
5979
  * @throws {RequiredError}
5924
5980
  */
5925
- executeJogging(cell: string, executeJoggingRequest: ExecuteJoggingRequest, options?: RawAxiosRequestConfig): AxiosPromise<ExecuteJoggingResponse>;
5981
+ executeJogging(cell: string, controller: string, executeJoggingRequest: ExecuteJoggingRequest, options?: RawAxiosRequestConfig): AxiosPromise<ExecuteJoggingResponse>;
5926
5982
  };
5927
5983
  /**
5928
5984
  * JoggingApi - object-oriented interface
@@ -5935,12 +5991,13 @@ export declare class JoggingApi extends BaseAPI {
5935
5991
  * <!-- 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
5992
  * @summary Execute Jogging
5937
5993
  * @param {string} cell Unique identifier addressing a cell in all API calls.
5994
+ * @param {string} controller Unique identifier to address a controller in the cell.
5938
5995
  * @param {ExecuteJoggingRequest} executeJoggingRequest
5939
5996
  * @param {*} [options] Override http request option.
5940
5997
  * @throws {RequiredError}
5941
5998
  * @memberof JoggingApi
5942
5999
  */
5943
- executeJogging(cell: string, executeJoggingRequest: ExecuteJoggingRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ExecuteJoggingResponse, any>>;
6000
+ executeJogging(cell: string, controller: string, executeJoggingRequest: ExecuteJoggingRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ExecuteJoggingResponse, any>>;
5944
6001
  }
5945
6002
  /**
5946
6003
  * KinematicsApi - axios parameter creator
@@ -6160,32 +6217,35 @@ export declare const MotionGroupApiAxiosParamCreator: (configuration?: Configura
6160
6217
  * Returns the current state of the selected motion group including the current joint position, velocity, pose, and more.
6161
6218
  * @summary State
6162
6219
  * @param {string} cell Unique identifier addressing a cell in all API calls.
6220
+ * @param {string} controller Unique identifier to address a controller in the cell.
6163
6221
  * @param {string} motionGroup The motion-group identifier.
6164
6222
  * @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
6223
  * @param {*} [options] Override http request option.
6166
6224
  * @throws {RequiredError}
6167
6225
  */
6168
- getCurrentMotionGroupState: (cell: string, motionGroup: string, responseCoordinateSystem?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
6226
+ getCurrentMotionGroupState: (cell: string, controller: string, motionGroup: string, responseCoordinateSystem?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
6169
6227
  /**
6170
6228
  * 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
6229
  * @summary Description
6172
6230
  * @param {string} cell Unique identifier addressing a cell in all API calls.
6231
+ * @param {string} controller Unique identifier to address a controller in the cell.
6173
6232
  * @param {string} motionGroup The motion-group identifier.
6174
6233
  * @param {*} [options] Override http request option.
6175
6234
  * @throws {RequiredError}
6176
6235
  */
6177
- getMotionGroupDescription: (cell: string, motionGroup: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
6236
+ getMotionGroupDescription: (cell: string, controller: string, motionGroup: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
6178
6237
  /**
6179
6238
  * <!-- 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
6239
  * @summary Stream State
6181
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.
6182
6242
  * @param {string} motionGroup The motion-group identifier.
6183
6243
  * @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
6244
  * @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
6245
  * @param {*} [options] Override http request option.
6186
6246
  * @throws {RequiredError}
6187
6247
  */
6188
- streamMotionGroupState: (cell: string, motionGroup: string, responseRate?: number, responseCoordinateSystem?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
6248
+ streamMotionGroupState: (cell: string, controller: string, motionGroup: string, responseRate?: number, responseCoordinateSystem?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
6189
6249
  };
6190
6250
  /**
6191
6251
  * MotionGroupApi - functional programming interface
@@ -6196,32 +6256,35 @@ export declare const MotionGroupApiFp: (configuration?: Configuration) => {
6196
6256
  * Returns the current state of the selected motion group including the current joint position, velocity, pose, and more.
6197
6257
  * @summary State
6198
6258
  * @param {string} cell Unique identifier addressing a cell in all API calls.
6259
+ * @param {string} controller Unique identifier to address a controller in the cell.
6199
6260
  * @param {string} motionGroup The motion-group identifier.
6200
6261
  * @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
6262
  * @param {*} [options] Override http request option.
6202
6263
  * @throws {RequiredError}
6203
6264
  */
6204
- getCurrentMotionGroupState(cell: string, motionGroup: string, responseCoordinateSystem?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<MotionGroupState>>;
6265
+ getCurrentMotionGroupState(cell: string, controller: string, motionGroup: string, responseCoordinateSystem?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<MotionGroupState>>;
6205
6266
  /**
6206
6267
  * 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
6268
  * @summary Description
6208
6269
  * @param {string} cell Unique identifier addressing a cell in all API calls.
6270
+ * @param {string} controller Unique identifier to address a controller in the cell.
6209
6271
  * @param {string} motionGroup The motion-group identifier.
6210
6272
  * @param {*} [options] Override http request option.
6211
6273
  * @throws {RequiredError}
6212
6274
  */
6213
- getMotionGroupDescription(cell: string, motionGroup: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<MotionGroupDescription>>;
6275
+ getMotionGroupDescription(cell: string, controller: string, motionGroup: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<MotionGroupDescription>>;
6214
6276
  /**
6215
6277
  * <!-- 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
6278
  * @summary Stream State
6217
6279
  * @param {string} cell Unique identifier addressing a cell in all API calls.
6280
+ * @param {string} controller Unique identifier to address a controller in the cell.
6218
6281
  * @param {string} motionGroup The motion-group identifier.
6219
6282
  * @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
6283
  * @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
6284
  * @param {*} [options] Override http request option.
6222
6285
  * @throws {RequiredError}
6223
6286
  */
6224
- streamMotionGroupState(cell: string, motionGroup: string, responseRate?: number, responseCoordinateSystem?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<MotionGroupState>>;
6287
+ streamMotionGroupState(cell: string, controller: string, motionGroup: string, responseRate?: number, responseCoordinateSystem?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<MotionGroupState>>;
6225
6288
  };
6226
6289
  /**
6227
6290
  * MotionGroupApi - factory interface
@@ -6232,32 +6295,35 @@ export declare const MotionGroupApiFactory: (configuration?: Configuration, base
6232
6295
  * Returns the current state of the selected motion group including the current joint position, velocity, pose, and more.
6233
6296
  * @summary State
6234
6297
  * @param {string} cell Unique identifier addressing a cell in all API calls.
6298
+ * @param {string} controller Unique identifier to address a controller in the cell.
6235
6299
  * @param {string} motionGroup The motion-group identifier.
6236
6300
  * @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
6301
  * @param {*} [options] Override http request option.
6238
6302
  * @throws {RequiredError}
6239
6303
  */
6240
- getCurrentMotionGroupState(cell: string, motionGroup: string, responseCoordinateSystem?: string, options?: RawAxiosRequestConfig): AxiosPromise<MotionGroupState>;
6304
+ getCurrentMotionGroupState(cell: string, controller: string, motionGroup: string, responseCoordinateSystem?: string, options?: RawAxiosRequestConfig): AxiosPromise<MotionGroupState>;
6241
6305
  /**
6242
6306
  * 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
6307
  * @summary Description
6244
6308
  * @param {string} cell Unique identifier addressing a cell in all API calls.
6309
+ * @param {string} controller Unique identifier to address a controller in the cell.
6245
6310
  * @param {string} motionGroup The motion-group identifier.
6246
6311
  * @param {*} [options] Override http request option.
6247
6312
  * @throws {RequiredError}
6248
6313
  */
6249
- getMotionGroupDescription(cell: string, motionGroup: string, options?: RawAxiosRequestConfig): AxiosPromise<MotionGroupDescription>;
6314
+ getMotionGroupDescription(cell: string, controller: string, motionGroup: string, options?: RawAxiosRequestConfig): AxiosPromise<MotionGroupDescription>;
6250
6315
  /**
6251
6316
  * <!-- 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
6317
  * @summary Stream State
6253
6318
  * @param {string} cell Unique identifier addressing a cell in all API calls.
6319
+ * @param {string} controller Unique identifier to address a controller in the cell.
6254
6320
  * @param {string} motionGroup The motion-group identifier.
6255
6321
  * @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
6322
  * @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
6323
  * @param {*} [options] Override http request option.
6258
6324
  * @throws {RequiredError}
6259
6325
  */
6260
- streamMotionGroupState(cell: string, motionGroup: string, responseRate?: number, responseCoordinateSystem?: string, options?: RawAxiosRequestConfig): AxiosPromise<MotionGroupState>;
6326
+ streamMotionGroupState(cell: string, controller: string, motionGroup: string, responseRate?: number, responseCoordinateSystem?: string, options?: RawAxiosRequestConfig): AxiosPromise<MotionGroupState>;
6261
6327
  };
6262
6328
  /**
6263
6329
  * MotionGroupApi - object-oriented interface
@@ -6270,27 +6336,30 @@ export declare class MotionGroupApi extends BaseAPI {
6270
6336
  * Returns the current state of the selected motion group including the current joint position, velocity, pose, and more.
6271
6337
  * @summary State
6272
6338
  * @param {string} cell Unique identifier addressing a cell in all API calls.
6339
+ * @param {string} controller Unique identifier to address a controller in the cell.
6273
6340
  * @param {string} motionGroup The motion-group identifier.
6274
6341
  * @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
6342
  * @param {*} [options] Override http request option.
6276
6343
  * @throws {RequiredError}
6277
6344
  * @memberof MotionGroupApi
6278
6345
  */
6279
- getCurrentMotionGroupState(cell: string, motionGroup: string, responseCoordinateSystem?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<MotionGroupState, any>>;
6346
+ getCurrentMotionGroupState(cell: string, controller: string, motionGroup: string, responseCoordinateSystem?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<MotionGroupState, any>>;
6280
6347
  /**
6281
6348
  * 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
6349
  * @summary Description
6283
6350
  * @param {string} cell Unique identifier addressing a cell in all API calls.
6351
+ * @param {string} controller Unique identifier to address a controller in the cell.
6284
6352
  * @param {string} motionGroup The motion-group identifier.
6285
6353
  * @param {*} [options] Override http request option.
6286
6354
  * @throws {RequiredError}
6287
6355
  * @memberof MotionGroupApi
6288
6356
  */
6289
- getMotionGroupDescription(cell: string, motionGroup: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<MotionGroupDescription, any>>;
6357
+ getMotionGroupDescription(cell: string, controller: string, motionGroup: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<MotionGroupDescription, any>>;
6290
6358
  /**
6291
6359
  * <!-- 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
6360
  * @summary Stream State
6293
6361
  * @param {string} cell Unique identifier addressing a cell in all API calls.
6362
+ * @param {string} controller Unique identifier to address a controller in the cell.
6294
6363
  * @param {string} motionGroup The motion-group identifier.
6295
6364
  * @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
6365
  * @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 +6367,7 @@ export declare class MotionGroupApi extends BaseAPI {
6298
6367
  * @throws {RequiredError}
6299
6368
  * @memberof MotionGroupApi
6300
6369
  */
6301
- streamMotionGroupState(cell: string, motionGroup: string, responseRate?: number, responseCoordinateSystem?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<MotionGroupState, any>>;
6370
+ streamMotionGroupState(cell: string, controller: string, motionGroup: string, responseRate?: number, responseCoordinateSystem?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<MotionGroupState, any>>;
6302
6371
  }
6303
6372
  /**
6304
6373
  * MotionGroupModelsApi - axios parameter creator
@@ -7710,45 +7779,50 @@ export declare const TrajectoryCachingApiAxiosParamCreator: (configuration?: Con
7710
7779
  * <!-- 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
7780
  * @summary Add Trajectory
7712
7781
  * @param {string} cell Unique identifier addressing a cell in all API calls.
7782
+ * @param {string} controller Unique identifier to address a controller in the cell.
7713
7783
  * @param {AddTrajectoryRequest} addTrajectoryRequest
7714
7784
  * @param {*} [options] Override http request option.
7715
7785
  * @throws {RequiredError}
7716
7786
  */
7717
- addTrajectory: (cell: string, addTrajectoryRequest: AddTrajectoryRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
7787
+ addTrajectory: (cell: string, controller: string, addTrajectoryRequest: AddTrajectoryRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
7718
7788
  /**
7719
7789
  * Clear the trajectory cache.
7720
7790
  * @summary Clear Trajectories
7721
7791
  * @param {string} cell Unique identifier addressing a cell in all API calls.
7792
+ * @param {string} controller Unique identifier to address a controller in the cell.
7722
7793
  * @param {*} [options] Override http request option.
7723
7794
  * @throws {RequiredError}
7724
7795
  */
7725
- clearTrajectories: (cell: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
7796
+ clearTrajectories: (cell: string, controller: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
7726
7797
  /**
7727
7798
  * 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
7799
  * @summary Delete Trajectory
7729
7800
  * @param {string} cell Unique identifier addressing a cell in all API calls.
7801
+ * @param {string} controller Unique identifier to address a controller in the cell.
7730
7802
  * @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
7803
  * @param {*} [options] Override http request option.
7732
7804
  * @throws {RequiredError}
7733
7805
  */
7734
- deleteTrajectory: (cell: string, trajectory: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
7806
+ deleteTrajectory: (cell: string, controller: string, trajectory: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
7735
7807
  /**
7736
7808
  * Get a previously created trajectory from cache. Use [listTrajectories](listTrajectories) to list all cached trajectories.
7737
7809
  * @summary Get Trajectory
7738
7810
  * @param {string} cell Unique identifier addressing a cell in all API calls.
7811
+ * @param {string} controller Unique identifier to address a controller in the cell.
7739
7812
  * @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
7813
  * @param {*} [options] Override http request option.
7741
7814
  * @throws {RequiredError}
7742
7815
  */
7743
- getTrajectory: (cell: string, trajectory: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
7816
+ getTrajectory: (cell: string, controller: string, trajectory: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
7744
7817
  /**
7745
7818
  * 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
7819
  * @summary List Trajectories
7747
7820
  * @param {string} cell Unique identifier addressing a cell in all API calls.
7821
+ * @param {string} controller Unique identifier to address a controller in the cell.
7748
7822
  * @param {*} [options] Override http request option.
7749
7823
  * @throws {RequiredError}
7750
7824
  */
7751
- listTrajectories: (cell: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
7825
+ listTrajectories: (cell: string, controller: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
7752
7826
  };
7753
7827
  /**
7754
7828
  * TrajectoryCachingApi - functional programming interface
@@ -7759,45 +7833,50 @@ export declare const TrajectoryCachingApiFp: (configuration?: Configuration) =>
7759
7833
  * <!-- 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
7834
  * @summary Add Trajectory
7761
7835
  * @param {string} cell Unique identifier addressing a cell in all API calls.
7836
+ * @param {string} controller Unique identifier to address a controller in the cell.
7762
7837
  * @param {AddTrajectoryRequest} addTrajectoryRequest
7763
7838
  * @param {*} [options] Override http request option.
7764
7839
  * @throws {RequiredError}
7765
7840
  */
7766
- addTrajectory(cell: string, addTrajectoryRequest: AddTrajectoryRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AddTrajectoryResponse>>;
7841
+ addTrajectory(cell: string, controller: string, addTrajectoryRequest: AddTrajectoryRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AddTrajectoryResponse>>;
7767
7842
  /**
7768
7843
  * Clear the trajectory cache.
7769
7844
  * @summary Clear Trajectories
7770
7845
  * @param {string} cell Unique identifier addressing a cell in all API calls.
7846
+ * @param {string} controller Unique identifier to address a controller in the cell.
7771
7847
  * @param {*} [options] Override http request option.
7772
7848
  * @throws {RequiredError}
7773
7849
  */
7774
- clearTrajectories(cell: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
7850
+ clearTrajectories(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
7775
7851
  /**
7776
7852
  * 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
7853
  * @summary Delete Trajectory
7778
7854
  * @param {string} cell Unique identifier addressing a cell in all API calls.
7855
+ * @param {string} controller Unique identifier to address a controller in the cell.
7779
7856
  * @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
7857
  * @param {*} [options] Override http request option.
7781
7858
  * @throws {RequiredError}
7782
7859
  */
7783
- deleteTrajectory(cell: string, trajectory: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
7860
+ deleteTrajectory(cell: string, controller: string, trajectory: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
7784
7861
  /**
7785
7862
  * Get a previously created trajectory from cache. Use [listTrajectories](listTrajectories) to list all cached trajectories.
7786
7863
  * @summary Get Trajectory
7787
7864
  * @param {string} cell Unique identifier addressing a cell in all API calls.
7865
+ * @param {string} controller Unique identifier to address a controller in the cell.
7788
7866
  * @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
7867
  * @param {*} [options] Override http request option.
7790
7868
  * @throws {RequiredError}
7791
7869
  */
7792
- getTrajectory(cell: string, trajectory: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetTrajectoryResponse>>;
7870
+ getTrajectory(cell: string, controller: string, trajectory: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetTrajectoryResponse>>;
7793
7871
  /**
7794
7872
  * 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
7873
  * @summary List Trajectories
7796
7874
  * @param {string} cell Unique identifier addressing a cell in all API calls.
7875
+ * @param {string} controller Unique identifier to address a controller in the cell.
7797
7876
  * @param {*} [options] Override http request option.
7798
7877
  * @throws {RequiredError}
7799
7878
  */
7800
- listTrajectories(cell: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListTrajectoriesResponse>>;
7879
+ listTrajectories(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListTrajectoriesResponse>>;
7801
7880
  };
7802
7881
  /**
7803
7882
  * TrajectoryCachingApi - factory interface
@@ -7808,45 +7887,50 @@ export declare const TrajectoryCachingApiFactory: (configuration?: Configuration
7808
7887
  * <!-- 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
7888
  * @summary Add Trajectory
7810
7889
  * @param {string} cell Unique identifier addressing a cell in all API calls.
7890
+ * @param {string} controller Unique identifier to address a controller in the cell.
7811
7891
  * @param {AddTrajectoryRequest} addTrajectoryRequest
7812
7892
  * @param {*} [options] Override http request option.
7813
7893
  * @throws {RequiredError}
7814
7894
  */
7815
- addTrajectory(cell: string, addTrajectoryRequest: AddTrajectoryRequest, options?: RawAxiosRequestConfig): AxiosPromise<AddTrajectoryResponse>;
7895
+ addTrajectory(cell: string, controller: string, addTrajectoryRequest: AddTrajectoryRequest, options?: RawAxiosRequestConfig): AxiosPromise<AddTrajectoryResponse>;
7816
7896
  /**
7817
7897
  * Clear the trajectory cache.
7818
7898
  * @summary Clear Trajectories
7819
7899
  * @param {string} cell Unique identifier addressing a cell in all API calls.
7900
+ * @param {string} controller Unique identifier to address a controller in the cell.
7820
7901
  * @param {*} [options] Override http request option.
7821
7902
  * @throws {RequiredError}
7822
7903
  */
7823
- clearTrajectories(cell: string, options?: RawAxiosRequestConfig): AxiosPromise<void>;
7904
+ clearTrajectories(cell: string, controller: string, options?: RawAxiosRequestConfig): AxiosPromise<void>;
7824
7905
  /**
7825
7906
  * 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
7907
  * @summary Delete Trajectory
7827
7908
  * @param {string} cell Unique identifier addressing a cell in all API calls.
7909
+ * @param {string} controller Unique identifier to address a controller in the cell.
7828
7910
  * @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
7911
  * @param {*} [options] Override http request option.
7830
7912
  * @throws {RequiredError}
7831
7913
  */
7832
- deleteTrajectory(cell: string, trajectory: string, options?: RawAxiosRequestConfig): AxiosPromise<void>;
7914
+ deleteTrajectory(cell: string, controller: string, trajectory: string, options?: RawAxiosRequestConfig): AxiosPromise<void>;
7833
7915
  /**
7834
7916
  * Get a previously created trajectory from cache. Use [listTrajectories](listTrajectories) to list all cached trajectories.
7835
7917
  * @summary Get Trajectory
7836
7918
  * @param {string} cell Unique identifier addressing a cell in all API calls.
7919
+ * @param {string} controller Unique identifier to address a controller in the cell.
7837
7920
  * @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
7921
  * @param {*} [options] Override http request option.
7839
7922
  * @throws {RequiredError}
7840
7923
  */
7841
- getTrajectory(cell: string, trajectory: string, options?: RawAxiosRequestConfig): AxiosPromise<GetTrajectoryResponse>;
7924
+ getTrajectory(cell: string, controller: string, trajectory: string, options?: RawAxiosRequestConfig): AxiosPromise<GetTrajectoryResponse>;
7842
7925
  /**
7843
7926
  * 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
7927
  * @summary List Trajectories
7845
7928
  * @param {string} cell Unique identifier addressing a cell in all API calls.
7929
+ * @param {string} controller Unique identifier to address a controller in the cell.
7846
7930
  * @param {*} [options] Override http request option.
7847
7931
  * @throws {RequiredError}
7848
7932
  */
7849
- listTrajectories(cell: string, options?: RawAxiosRequestConfig): AxiosPromise<ListTrajectoriesResponse>;
7933
+ listTrajectories(cell: string, controller: string, options?: RawAxiosRequestConfig): AxiosPromise<ListTrajectoriesResponse>;
7850
7934
  };
7851
7935
  /**
7852
7936
  * TrajectoryCachingApi - object-oriented interface
@@ -7859,50 +7943,55 @@ export declare class TrajectoryCachingApi extends BaseAPI {
7859
7943
  * <!-- 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
7944
  * @summary Add Trajectory
7861
7945
  * @param {string} cell Unique identifier addressing a cell in all API calls.
7946
+ * @param {string} controller Unique identifier to address a controller in the cell.
7862
7947
  * @param {AddTrajectoryRequest} addTrajectoryRequest
7863
7948
  * @param {*} [options] Override http request option.
7864
7949
  * @throws {RequiredError}
7865
7950
  * @memberof TrajectoryCachingApi
7866
7951
  */
7867
- addTrajectory(cell: string, addTrajectoryRequest: AddTrajectoryRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AddTrajectoryResponse, any>>;
7952
+ addTrajectory(cell: string, controller: string, addTrajectoryRequest: AddTrajectoryRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AddTrajectoryResponse, any>>;
7868
7953
  /**
7869
7954
  * Clear the trajectory cache.
7870
7955
  * @summary Clear Trajectories
7871
7956
  * @param {string} cell Unique identifier addressing a cell in all API calls.
7957
+ * @param {string} controller Unique identifier to address a controller in the cell.
7872
7958
  * @param {*} [options] Override http request option.
7873
7959
  * @throws {RequiredError}
7874
7960
  * @memberof TrajectoryCachingApi
7875
7961
  */
7876
- clearTrajectories(cell: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
7962
+ clearTrajectories(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
7877
7963
  /**
7878
7964
  * 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
7965
  * @summary Delete Trajectory
7880
7966
  * @param {string} cell Unique identifier addressing a cell in all API calls.
7967
+ * @param {string} controller Unique identifier to address a controller in the cell.
7881
7968
  * @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
7969
  * @param {*} [options] Override http request option.
7883
7970
  * @throws {RequiredError}
7884
7971
  * @memberof TrajectoryCachingApi
7885
7972
  */
7886
- deleteTrajectory(cell: string, trajectory: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
7973
+ deleteTrajectory(cell: string, controller: string, trajectory: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
7887
7974
  /**
7888
7975
  * Get a previously created trajectory from cache. Use [listTrajectories](listTrajectories) to list all cached trajectories.
7889
7976
  * @summary Get Trajectory
7890
7977
  * @param {string} cell Unique identifier addressing a cell in all API calls.
7978
+ * @param {string} controller Unique identifier to address a controller in the cell.
7891
7979
  * @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
7980
  * @param {*} [options] Override http request option.
7893
7981
  * @throws {RequiredError}
7894
7982
  * @memberof TrajectoryCachingApi
7895
7983
  */
7896
- getTrajectory(cell: string, trajectory: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetTrajectoryResponse, any>>;
7984
+ getTrajectory(cell: string, controller: string, trajectory: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetTrajectoryResponse, any>>;
7897
7985
  /**
7898
7986
  * 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
7987
  * @summary List Trajectories
7900
7988
  * @param {string} cell Unique identifier addressing a cell in all API calls.
7989
+ * @param {string} controller Unique identifier to address a controller in the cell.
7901
7990
  * @param {*} [options] Override http request option.
7902
7991
  * @throws {RequiredError}
7903
7992
  * @memberof TrajectoryCachingApi
7904
7993
  */
7905
- listTrajectories(cell: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ListTrajectoriesResponse, any>>;
7994
+ listTrajectories(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ListTrajectoriesResponse, any>>;
7906
7995
  }
7907
7996
  /**
7908
7997
  * TrajectoryExecutionApi - axios parameter creator
@@ -7913,11 +8002,12 @@ export declare const TrajectoryExecutionApiAxiosParamCreator: (configuration?: C
7913
8002
  * <!-- 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
8003
  * @summary Execute Trajectory
7915
8004
  * @param {string} cell Unique identifier addressing a cell in all API calls.
8005
+ * @param {string} controller Unique identifier to address a controller in the cell.
7916
8006
  * @param {ExecuteTrajectoryRequest} executeTrajectoryRequest
7917
8007
  * @param {*} [options] Override http request option.
7918
8008
  * @throws {RequiredError}
7919
8009
  */
7920
- executeTrajectory: (cell: string, executeTrajectoryRequest: ExecuteTrajectoryRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
8010
+ executeTrajectory: (cell: string, controller: string, executeTrajectoryRequest: ExecuteTrajectoryRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
7921
8011
  };
7922
8012
  /**
7923
8013
  * TrajectoryExecutionApi - functional programming interface
@@ -7928,11 +8018,12 @@ export declare const TrajectoryExecutionApiFp: (configuration?: Configuration) =
7928
8018
  * <!-- 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
8019
  * @summary Execute Trajectory
7930
8020
  * @param {string} cell Unique identifier addressing a cell in all API calls.
8021
+ * @param {string} controller Unique identifier to address a controller in the cell.
7931
8022
  * @param {ExecuteTrajectoryRequest} executeTrajectoryRequest
7932
8023
  * @param {*} [options] Override http request option.
7933
8024
  * @throws {RequiredError}
7934
8025
  */
7935
- executeTrajectory(cell: string, executeTrajectoryRequest: ExecuteTrajectoryRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ExecuteTrajectoryResponse>>;
8026
+ executeTrajectory(cell: string, controller: string, executeTrajectoryRequest: ExecuteTrajectoryRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ExecuteTrajectoryResponse>>;
7936
8027
  };
7937
8028
  /**
7938
8029
  * TrajectoryExecutionApi - factory interface
@@ -7943,11 +8034,12 @@ export declare const TrajectoryExecutionApiFactory: (configuration?: Configurati
7943
8034
  * <!-- 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
8035
  * @summary Execute Trajectory
7945
8036
  * @param {string} cell Unique identifier addressing a cell in all API calls.
8037
+ * @param {string} controller Unique identifier to address a controller in the cell.
7946
8038
  * @param {ExecuteTrajectoryRequest} executeTrajectoryRequest
7947
8039
  * @param {*} [options] Override http request option.
7948
8040
  * @throws {RequiredError}
7949
8041
  */
7950
- executeTrajectory(cell: string, executeTrajectoryRequest: ExecuteTrajectoryRequest, options?: RawAxiosRequestConfig): AxiosPromise<ExecuteTrajectoryResponse>;
8042
+ executeTrajectory(cell: string, controller: string, executeTrajectoryRequest: ExecuteTrajectoryRequest, options?: RawAxiosRequestConfig): AxiosPromise<ExecuteTrajectoryResponse>;
7951
8043
  };
7952
8044
  /**
7953
8045
  * TrajectoryExecutionApi - object-oriented interface
@@ -7960,12 +8052,13 @@ export declare class TrajectoryExecutionApi extends BaseAPI {
7960
8052
  * <!-- 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
8053
  * @summary Execute Trajectory
7962
8054
  * @param {string} cell Unique identifier addressing a cell in all API calls.
8055
+ * @param {string} controller Unique identifier to address a controller in the cell.
7963
8056
  * @param {ExecuteTrajectoryRequest} executeTrajectoryRequest
7964
8057
  * @param {*} [options] Override http request option.
7965
8058
  * @throws {RequiredError}
7966
8059
  * @memberof TrajectoryExecutionApi
7967
8060
  */
7968
- executeTrajectory(cell: string, executeTrajectoryRequest: ExecuteTrajectoryRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ExecuteTrajectoryResponse, any>>;
8061
+ executeTrajectory(cell: string, controller: string, executeTrajectoryRequest: ExecuteTrajectoryRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ExecuteTrajectoryResponse, any>>;
7969
8062
  }
7970
8063
  /**
7971
8064
  * TrajectoryPlanningApi - axios parameter creator
@@ -8031,79 +8124,64 @@ export declare class TrajectoryPlanningApi extends BaseAPI {
8031
8124
  planTrajectory(cell: string, planTrajectoryRequest?: PlanTrajectoryRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<PlanTrajectoryResponse, any>>;
8032
8125
  }
8033
8126
  /**
8034
- * VirtualRobotApi - axios parameter creator
8127
+ * VirtualControllerApi - axios parameter creator
8035
8128
  * @export
8036
8129
  */
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>;
8130
+ export declare const VirtualControllerApiAxiosParamCreator: (configuration?: Configuration) => {
8048
8131
  /**
8049
- * Gets information on the motion group.
8050
- * @summary Motion Group Description
8132
+ * Adds a coordinate system to the robot controller.
8133
+ * @summary Add Coordinate Systems
8051
8134
  * @param {string} cell Unique identifier addressing a cell in all API calls.
8052
8135
  * @param {string} controller Unique identifier to address a controller in the cell.
8136
+ * @param {string} coordinateSystem Unique identifier addressing a coordinate system.
8137
+ * @param {CoordinateSystemData} coordinateSystemData
8053
8138
  * @param {*} [options] Override http request option.
8054
8139
  * @throws {RequiredError}
8055
8140
  */
8056
- getMotionGroups: (cell: string, controller: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
8141
+ addVirtualRobotCoordinateSystem: (cell: string, controller: string, coordinateSystem: string, coordinateSystemData: CoordinateSystemData, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
8057
8142
  /**
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
8143
+ * 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.
8144
+ * @summary Add TCP
8060
8145
  * @param {string} cell Unique identifier addressing a cell in all API calls.
8061
8146
  * @param {string} controller Unique identifier to address a controller in the cell.
8062
- * @param {Array<string>} ios
8147
+ * @param {string} motionGroup The motion-group identifier.
8148
+ * @param {string} tcp The unique identifier of a TCP.
8149
+ * @param {RobotTcpData} robotTcpData
8063
8150
  * @param {*} [options] Override http request option.
8064
8151
  * @throws {RequiredError}
8065
8152
  */
8066
- listIOs: (cell: string, controller: string, ios: Array<string>, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
8153
+ addVirtualRobotTcp: (cell: string, controller: string, motionGroup: string, tcp: string, robotTcpData: RobotTcpData, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
8067
8154
  /**
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
8155
+ * 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.
8156
+ * @summary Remove Coordinate System
8070
8157
  * @param {string} cell Unique identifier addressing a cell in all API calls.
8071
8158
  * @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.
8159
+ * @param {string} coordinateSystem Unique identifier addressing a coordinate system.
8160
+ * @param {boolean} [deleteDependent] If true, all dependent coordinate systems will be deleted as well.
8076
8161
  * @param {*} [options] Override http request option.
8077
8162
  * @throws {RequiredError}
8078
8163
  */
8079
- listVirtualRobotIODescriptions: (cell: string, controller: string, ios?: Array<string>, direction?: IODirection, valueType?: IOValueType, group?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
8164
+ deleteVirtualRobotCoordinateSystem: (cell: string, controller: string, coordinateSystem: string, deleteDependent?: boolean, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
8080
8165
  /**
8081
- * Sets a list of values of a virtual controller inputs/outputs.
8082
- * @summary Set Input/Ouput Values
8166
+ * Removes the TCP from the motion group. An unknown TCP is a valid input.
8167
+ * @summary Remove TCP
8083
8168
  * @param {string} cell Unique identifier addressing a cell in all API calls.
8084
8169
  * @param {string} controller Unique identifier to address a controller in the cell.
8085
- * @param {Array<IOValue>} iOValue
8170
+ * @param {string} motionGroup The motion-group identifier.
8171
+ * @param {string} tcp The unique identifier of a TCP.
8086
8172
  * @param {*} [options] Override http request option.
8087
8173
  * @throws {RequiredError}
8088
8174
  */
8089
- setIOValues: (cell: string, controller: string, iOValue: Array<IOValue>, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
8175
+ deleteVirtualRobotTcp: (cell: string, controller: string, motionGroup: string, tcp: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
8090
8176
  /**
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
8177
+ * 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.
8178
+ * @summary Get Emergency Stop State
8093
8179
  * @param {string} cell Unique identifier addressing a cell in all API calls.
8094
8180
  * @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
8181
  * @param {*} [options] Override http request option.
8098
8182
  * @throws {RequiredError}
8099
8183
  */
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) => {
8184
+ getEmergencyStop: (cell: string, controller: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
8107
8185
  /**
8108
8186
  * Get the current motion group state which provides values for the joints\' position, velocity and acceleration.
8109
8187
  * @summary Get Motion Group State
@@ -8113,7 +8191,7 @@ export declare const VirtualRobotApiFp: (configuration?: Configuration) => {
8113
8191
  * @param {*} [options] Override http request option.
8114
8192
  * @throws {RequiredError}
8115
8193
  */
8116
- getMotionGroupState(cell: string, controller: string, motionGroup: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<MotionGroupJoints>>;
8194
+ getMotionGroupState: (cell: string, controller: string, motionGroup: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
8117
8195
  /**
8118
8196
  * Gets information on the motion group.
8119
8197
  * @summary Motion Group Description
@@ -8122,365 +8200,297 @@ export declare const VirtualRobotApiFp: (configuration?: Configuration) => {
8122
8200
  * @param {*} [options] Override http request option.
8123
8201
  * @throws {RequiredError}
8124
8202
  */
8125
- getMotionGroups(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<MotionGroupInfos>>;
8203
+ getMotionGroups: (cell: string, controller: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
8126
8204
  /**
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
8205
+ * 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.
8206
+ * @summary Get Operation Mode
8129
8207
  * @param {string} cell Unique identifier addressing a cell in all API calls.
8130
8208
  * @param {string} controller Unique identifier to address a controller in the cell.
8131
- * @param {Array<string>} ios
8132
8209
  * @param {*} [options] Override http request option.
8133
8210
  * @throws {RequiredError}
8134
8211
  */
8135
- listIOs(cell: string, controller: string, ios: Array<string>, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<IOValue>>>;
8212
+ getOperationMode: (cell: string, controller: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
8136
8213
  /**
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
8139
- * @param {string} cell Unique identifier addressing a cell in all API calls.
8140
- * @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.
8145
- * @param {*} [options] Override http request option.
8146
- * @throws {RequiredError}
8147
- */
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>>>;
8149
- /**
8150
- * Sets a list of values of a virtual controller inputs/outputs.
8151
- * @summary Set Input/Ouput Values
8152
- * @param {string} cell Unique identifier addressing a cell in all API calls.
8153
- * @param {string} controller Unique identifier to address a controller in the cell.
8154
- * @param {Array<IOValue>} iOValue
8155
- * @param {*} [options] Override http request option.
8156
- * @throws {RequiredError}
8157
- */
8158
- setIOValues(cell: string, controller: string, iOValue: Array<IOValue>, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
8159
- /**
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
8214
+ * Gets motion group mounting. The motion group is based on the origin of the returned coordinate system.
8215
+ * @summary Get Mounting
8162
8216
  * @param {string} cell Unique identifier addressing a cell in all API calls.
8163
8217
  * @param {string} controller Unique identifier to address a controller in the cell.
8164
8218
  * @param {string} motionGroup The motion-group identifier.
8165
- * @param {MotionGroupJoints} motionGroupJoints
8166
8219
  * @param {*} [options] Override http request option.
8167
8220
  * @throws {RequiredError}
8168
8221
  */
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) => {
8222
+ getVirtualRobotMounting: (cell: string, controller: string, motionGroup: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
8176
8223
  /**
8177
- * Get the current motion group state which provides values for the joints\' position, velocity and acceleration.
8178
- * @summary Get Motion Group State
8224
+ * Lists all coordinate systems on the robot controller.
8225
+ * @summary List Coordinate Systems
8179
8226
  * @param {string} cell Unique identifier addressing a cell in all API calls.
8180
8227
  * @param {string} controller Unique identifier to address a controller in the cell.
8181
- * @param {string} motionGroup The motion-group identifier.
8182
8228
  * @param {*} [options] Override http request option.
8183
8229
  * @throws {RequiredError}
8184
8230
  */
8185
- getMotionGroupState(cell: string, controller: string, motionGroup: string, options?: RawAxiosRequestConfig): AxiosPromise<MotionGroupJoints>;
8231
+ listVirtualRobotCoordinateSystems: (cell: string, controller: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
8186
8232
  /**
8187
- * Gets information on the motion group.
8188
- * @summary Motion Group Description
8233
+ * Lists TCPs of the motion group. An empty TCP list is valid, for example for external axes.
8234
+ * @summary List TCPs
8189
8235
  * @param {string} cell Unique identifier addressing a cell in all API calls.
8190
8236
  * @param {string} controller Unique identifier to address a controller in the cell.
8237
+ * @param {string} motionGroup The motion-group identifier.
8191
8238
  * @param {*} [options] Override http request option.
8192
8239
  * @throws {RequiredError}
8193
8240
  */
8194
- getMotionGroups(cell: string, controller: string, options?: RawAxiosRequestConfig): AxiosPromise<MotionGroupInfos>;
8241
+ listVirtualRobotTcps: (cell: string, controller: string, motionGroup: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
8195
8242
  /**
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
8243
+ * 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.
8244
+ * @summary Push or Release Emergency Stop
8198
8245
  * @param {string} cell Unique identifier addressing a cell in all API calls.
8199
8246
  * @param {string} controller Unique identifier to address a controller in the cell.
8200
- * @param {Array<string>} ios
8247
+ * @param {boolean} [active]
8201
8248
  * @param {*} [options] Override http request option.
8202
8249
  * @throws {RequiredError}
8203
8250
  */
8204
- listIOs(cell: string, controller: string, ios: Array<string>, options?: RawAxiosRequestConfig): AxiosPromise<Array<IOValue>>;
8251
+ setEmergencyStop: (cell: string, controller: string, active?: boolean, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
8205
8252
  /**
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
8253
+ * 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.
8254
+ * @summary Set Motion Group State
8208
8255
  * @param {string} cell Unique identifier addressing a cell in all API calls.
8209
8256
  * @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.
8257
+ * @param {string} motionGroup The motion-group identifier.
8258
+ * @param {MotionGroupJoints} motionGroupJoints
8214
8259
  * @param {*} [options] Override http request option.
8215
8260
  * @throws {RequiredError}
8216
8261
  */
8217
- listVirtualRobotIODescriptions(cell: string, controller: string, ios?: Array<string>, direction?: IODirection, valueType?: IOValueType, group?: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<IODescription>>;
8262
+ setMotionGroupState: (cell: string, controller: string, motionGroup: string, motionGroupJoints: MotionGroupJoints, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
8218
8263
  /**
8219
- * Sets a list of values of a virtual controller inputs/outputs.
8220
- * @summary Set Input/Ouput Values
8264
+ * 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.
8265
+ * @summary Set Operation Mode
8221
8266
  * @param {string} cell Unique identifier addressing a cell in all API calls.
8222
8267
  * @param {string} controller Unique identifier to address a controller in the cell.
8223
- * @param {Array<IOValue>} iOValue
8268
+ * @param {OperationMode} mode
8224
8269
  * @param {*} [options] Override http request option.
8225
8270
  * @throws {RequiredError}
8226
8271
  */
8227
- setIOValues(cell: string, controller: string, iOValue: Array<IOValue>, options?: RawAxiosRequestConfig): AxiosPromise<void>;
8272
+ setOperationMode: (cell: string, controller: string, mode: OperationMode, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
8228
8273
  /**
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
8274
+ * 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.
8275
+ * @summary Set Mounting
8231
8276
  * @param {string} cell Unique identifier addressing a cell in all API calls.
8232
8277
  * @param {string} controller Unique identifier to address a controller in the cell.
8233
8278
  * @param {string} motionGroup The motion-group identifier.
8234
- * @param {MotionGroupJoints} motionGroupJoints
8279
+ * @param {CoordinateSystem} coordinateSystem
8235
8280
  * @param {*} [options] Override http request option.
8236
8281
  * @throws {RequiredError}
8237
8282
  */
8238
- setMotionGroupState(cell: string, controller: string, motionGroup: string, motionGroupJoints: MotionGroupJoints, options?: RawAxiosRequestConfig): AxiosPromise<void>;
8283
+ setVirtualRobotMounting: (cell: string, controller: string, motionGroup: string, coordinateSystem: CoordinateSystem, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
8239
8284
  };
8240
8285
  /**
8241
- * VirtualRobotApi - object-oriented interface
8286
+ * VirtualControllerApi - functional programming interface
8242
8287
  * @export
8243
- * @class VirtualRobotApi
8244
- * @extends {BaseAPI}
8245
8288
  */
8246
- export declare class VirtualRobotApi extends BaseAPI {
8289
+ export declare const VirtualControllerApiFp: (configuration?: Configuration) => {
8247
8290
  /**
8248
- * Get the current motion group state which provides values for the joints\' position, velocity and acceleration.
8249
- * @summary Get Motion Group State
8291
+ * Adds a coordinate system to the robot controller.
8292
+ * @summary Add Coordinate Systems
8250
8293
  * @param {string} cell Unique identifier addressing a cell in all API calls.
8251
8294
  * @param {string} controller Unique identifier to address a controller in the cell.
8252
- * @param {string} motionGroup The motion-group identifier.
8295
+ * @param {string} coordinateSystem Unique identifier addressing a coordinate system.
8296
+ * @param {CoordinateSystemData} coordinateSystemData
8253
8297
  * @param {*} [options] Override http request option.
8254
8298
  * @throws {RequiredError}
8255
- * @memberof VirtualRobotApi
8256
8299
  */
8257
- getMotionGroupState(cell: string, controller: string, motionGroup: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<MotionGroupJoints, any>>;
8300
+ addVirtualRobotCoordinateSystem(cell: string, controller: string, coordinateSystem: string, coordinateSystemData: CoordinateSystemData, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
8258
8301
  /**
8259
- * Gets information on the motion group.
8260
- * @summary Motion Group Description
8302
+ * 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.
8303
+ * @summary Add TCP
8261
8304
  * @param {string} cell Unique identifier addressing a cell in all API calls.
8262
8305
  * @param {string} controller Unique identifier to address a controller in the cell.
8306
+ * @param {string} motionGroup The motion-group identifier.
8307
+ * @param {string} tcp The unique identifier of a TCP.
8308
+ * @param {RobotTcpData} robotTcpData
8263
8309
  * @param {*} [options] Override http request option.
8264
8310
  * @throws {RequiredError}
8265
- * @memberof VirtualRobotApi
8266
8311
  */
8267
- getMotionGroups(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<MotionGroupInfos, any>>;
8312
+ addVirtualRobotTcp(cell: string, controller: string, motionGroup: string, tcp: string, robotTcpData: RobotTcpData, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
8268
8313
  /**
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
8314
+ * 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.
8315
+ * @summary Remove Coordinate System
8271
8316
  * @param {string} cell Unique identifier addressing a cell in all API calls.
8272
8317
  * @param {string} controller Unique identifier to address a controller in the cell.
8273
- * @param {Array<string>} ios
8318
+ * @param {string} coordinateSystem Unique identifier addressing a coordinate system.
8319
+ * @param {boolean} [deleteDependent] If true, all dependent coordinate systems will be deleted as well.
8274
8320
  * @param {*} [options] Override http request option.
8275
8321
  * @throws {RequiredError}
8276
- * @memberof VirtualRobotApi
8277
8322
  */
8278
- listIOs(cell: string, controller: string, ios: Array<string>, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<IOValue[], any>>;
8323
+ deleteVirtualRobotCoordinateSystem(cell: string, controller: string, coordinateSystem: string, deleteDependent?: boolean, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
8279
8324
  /**
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
8325
+ * Removes the TCP from the motion group. An unknown TCP is a valid input.
8326
+ * @summary Remove TCP
8282
8327
  * @param {string} cell Unique identifier addressing a cell in all API calls.
8283
8328
  * @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.
8329
+ * @param {string} motionGroup The motion-group identifier.
8330
+ * @param {string} tcp The unique identifier of a TCP.
8288
8331
  * @param {*} [options] Override http request option.
8289
8332
  * @throws {RequiredError}
8290
- * @memberof VirtualRobotApi
8291
8333
  */
8292
- listVirtualRobotIODescriptions(cell: string, controller: string, ios?: Array<string>, direction?: IODirection, valueType?: IOValueType, group?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<IODescription[], any>>;
8334
+ deleteVirtualRobotTcp(cell: string, controller: string, motionGroup: string, tcp: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
8293
8335
  /**
8294
- * Sets a list of values of a virtual controller inputs/outputs.
8295
- * @summary Set Input/Ouput Values
8336
+ * 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.
8337
+ * @summary Get Emergency Stop State
8296
8338
  * @param {string} cell Unique identifier addressing a cell in all API calls.
8297
8339
  * @param {string} controller Unique identifier to address a controller in the cell.
8298
- * @param {Array<IOValue>} iOValue
8299
8340
  * @param {*} [options] Override http request option.
8300
8341
  * @throws {RequiredError}
8301
- * @memberof VirtualRobotApi
8302
8342
  */
8303
- setIOValues(cell: string, controller: string, iOValue: Array<IOValue>, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
8343
+ getEmergencyStop(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Flag>>;
8304
8344
  /**
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
8345
+ * Get the current motion group state which provides values for the joints\' position, velocity and acceleration.
8346
+ * @summary Get Motion Group State
8307
8347
  * @param {string} cell Unique identifier addressing a cell in all API calls.
8308
8348
  * @param {string} controller Unique identifier to address a controller in the cell.
8309
8349
  * @param {string} motionGroup The motion-group identifier.
8310
- * @param {MotionGroupJoints} motionGroupJoints
8311
8350
  * @param {*} [options] Override http request option.
8312
8351
  * @throws {RequiredError}
8313
- * @memberof VirtualRobotApi
8314
8352
  */
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) => {
8353
+ getMotionGroupState(cell: string, controller: string, motionGroup: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<MotionGroupJoints>>;
8322
8354
  /**
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
8355
+ * Gets information on the motion group.
8356
+ * @summary Motion Group Description
8325
8357
  * @param {string} cell Unique identifier addressing a cell in all API calls.
8326
8358
  * @param {string} controller Unique identifier to address a controller in the cell.
8327
- * @param {ExternalJointStreamDatapoint} externalJointStreamDatapoint
8328
8359
  * @param {*} [options] Override http request option.
8329
8360
  * @throws {RequiredError}
8330
8361
  */
8331
- externalJointsStream: (cell: string, controller: string, externalJointStreamDatapoint: ExternalJointStreamDatapoint, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
8362
+ getMotionGroups(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<MotionGroupInfo>>>;
8332
8363
  /**
8333
- * Get the current robot motion group behavior - please see the setter [setMotionGroupBehavior](setMotionGroupBehavior) and the enum for details.
8334
- * @summary Behavior
8364
+ * 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.
8365
+ * @summary Get Operation Mode
8335
8366
  * @param {string} cell Unique identifier addressing a cell in all API calls.
8336
8367
  * @param {string} controller Unique identifier to address a controller in the cell.
8337
- * @param {string} motionGroup The motion-group identifier.
8338
8368
  * @param {*} [options] Override http request option.
8339
8369
  * @throws {RequiredError}
8340
8370
  */
8341
- getMotionGroupBehavior: (cell: string, controller: string, motionGroup: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
8371
+ getOperationMode(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<OpMode>>;
8342
8372
  /**
8343
- * Switch robot motion group behavior.
8344
- * @summary Switch Behavior
8373
+ * Gets motion group mounting. The motion group is based on the origin of the returned coordinate system.
8374
+ * @summary Get Mounting
8345
8375
  * @param {string} cell Unique identifier addressing a cell in all API calls.
8346
8376
  * @param {string} controller Unique identifier to address a controller in the cell.
8347
8377
  * @param {string} motionGroup The motion-group identifier.
8348
- * @param {Behavior} [behavior]
8349
8378
  * @param {*} [options] Override http request option.
8350
8379
  * @throws {RequiredError}
8351
8380
  */
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) => {
8381
+ getVirtualRobotMounting(cell: string, controller: string, motionGroup: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CoordinateSystem>>;
8359
8382
  /**
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
8383
+ * Lists all coordinate systems on the robot controller.
8384
+ * @summary List Coordinate Systems
8362
8385
  * @param {string} cell Unique identifier addressing a cell in all API calls.
8363
8386
  * @param {string} controller Unique identifier to address a controller in the cell.
8364
- * @param {ExternalJointStreamDatapoint} externalJointStreamDatapoint
8365
8387
  * @param {*} [options] Override http request option.
8366
8388
  * @throws {RequiredError}
8367
8389
  */
8368
- externalJointsStream(cell: string, controller: string, externalJointStreamDatapoint: ExternalJointStreamDatapoint, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<MotionGroupJoints>>;
8390
+ listVirtualRobotCoordinateSystems(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<CoordinateSystem>>>;
8369
8391
  /**
8370
- * Get the current robot motion group behavior - please see the setter [setMotionGroupBehavior](setMotionGroupBehavior) and the enum for details.
8371
- * @summary Behavior
8392
+ * Lists TCPs of the motion group. An empty TCP list is valid, for example for external axes.
8393
+ * @summary List TCPs
8372
8394
  * @param {string} cell Unique identifier addressing a cell in all API calls.
8373
8395
  * @param {string} controller Unique identifier to address a controller in the cell.
8374
8396
  * @param {string} motionGroup The motion-group identifier.
8375
8397
  * @param {*} [options] Override http request option.
8376
8398
  * @throws {RequiredError}
8377
8399
  */
8378
- getMotionGroupBehavior(cell: string, controller: string, motionGroup: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<MotionGroupBehaviorGetter>>;
8400
+ listVirtualRobotTcps(cell: string, controller: string, motionGroup: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<RobotTcp>>>;
8379
8401
  /**
8380
- * Switch robot motion group behavior.
8381
- * @summary Switch Behavior
8402
+ * 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.
8403
+ * @summary Push or Release Emergency Stop
8382
8404
  * @param {string} cell Unique identifier addressing a cell in all API calls.
8383
8405
  * @param {string} controller Unique identifier to address a controller in the cell.
8384
- * @param {string} motionGroup The motion-group identifier.
8385
- * @param {Behavior} [behavior]
8406
+ * @param {boolean} [active]
8386
8407
  * @param {*} [options] Override http request option.
8387
8408
  * @throws {RequiredError}
8388
8409
  */
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) => {
8410
+ setEmergencyStop(cell: string, controller: string, active?: boolean, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
8396
8411
  /**
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
8412
+ * 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.
8413
+ * @summary Set Motion Group State
8399
8414
  * @param {string} cell Unique identifier addressing a cell in all API calls.
8400
8415
  * @param {string} controller Unique identifier to address a controller in the cell.
8401
- * @param {ExternalJointStreamDatapoint} externalJointStreamDatapoint
8416
+ * @param {string} motionGroup The motion-group identifier.
8417
+ * @param {MotionGroupJoints} motionGroupJoints
8402
8418
  * @param {*} [options] Override http request option.
8403
8419
  * @throws {RequiredError}
8404
8420
  */
8405
- externalJointsStream(cell: string, controller: string, externalJointStreamDatapoint: ExternalJointStreamDatapoint, options?: RawAxiosRequestConfig): AxiosPromise<MotionGroupJoints>;
8421
+ setMotionGroupState(cell: string, controller: string, motionGroup: string, motionGroupJoints: MotionGroupJoints, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
8406
8422
  /**
8407
- * Get the current robot motion group behavior - please see the setter [setMotionGroupBehavior](setMotionGroupBehavior) and the enum for details.
8408
- * @summary Behavior
8423
+ * 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.
8424
+ * @summary Set Operation Mode
8409
8425
  * @param {string} cell Unique identifier addressing a cell in all API calls.
8410
8426
  * @param {string} controller Unique identifier to address a controller in the cell.
8411
- * @param {string} motionGroup The motion-group identifier.
8427
+ * @param {OperationMode} mode
8412
8428
  * @param {*} [options] Override http request option.
8413
8429
  * @throws {RequiredError}
8414
8430
  */
8415
- getMotionGroupBehavior(cell: string, controller: string, motionGroup: string, options?: RawAxiosRequestConfig): AxiosPromise<MotionGroupBehaviorGetter>;
8431
+ setOperationMode(cell: string, controller: string, mode: OperationMode, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
8416
8432
  /**
8417
- * Switch robot motion group behavior.
8418
- * @summary Switch Behavior
8433
+ * 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.
8434
+ * @summary Set Mounting
8419
8435
  * @param {string} cell Unique identifier addressing a cell in all API calls.
8420
8436
  * @param {string} controller Unique identifier to address a controller in the cell.
8421
8437
  * @param {string} motionGroup The motion-group identifier.
8422
- * @param {Behavior} [behavior]
8438
+ * @param {CoordinateSystem} coordinateSystem
8423
8439
  * @param {*} [options] Override http request option.
8424
8440
  * @throws {RequiredError}
8425
8441
  */
8426
- setMotionGroupBehavior(cell: string, controller: string, motionGroup: string, behavior?: Behavior, options?: RawAxiosRequestConfig): AxiosPromise<void>;
8442
+ setVirtualRobotMounting(cell: string, controller: string, motionGroup: string, coordinateSystem: CoordinateSystem, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CoordinateSystem>>;
8427
8443
  };
8428
8444
  /**
8429
- * VirtualRobotBehaviorApi - object-oriented interface
8445
+ * VirtualControllerApi - factory interface
8430
8446
  * @export
8431
- * @class VirtualRobotBehaviorApi
8432
- * @extends {BaseAPI}
8433
8447
  */
8434
- export declare class VirtualRobotBehaviorApi extends BaseAPI {
8448
+ export declare const VirtualControllerApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
8435
8449
  /**
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
8450
+ * Adds a coordinate system to the robot controller.
8451
+ * @summary Add Coordinate Systems
8438
8452
  * @param {string} cell Unique identifier addressing a cell in all API calls.
8439
8453
  * @param {string} controller Unique identifier to address a controller in the cell.
8440
- * @param {ExternalJointStreamDatapoint} externalJointStreamDatapoint
8454
+ * @param {string} coordinateSystem Unique identifier addressing a coordinate system.
8455
+ * @param {CoordinateSystemData} coordinateSystemData
8441
8456
  * @param {*} [options] Override http request option.
8442
8457
  * @throws {RequiredError}
8443
- * @memberof VirtualRobotBehaviorApi
8444
8458
  */
8445
- externalJointsStream(cell: string, controller: string, externalJointStreamDatapoint: ExternalJointStreamDatapoint, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<MotionGroupJoints, any>>;
8459
+ addVirtualRobotCoordinateSystem(cell: string, controller: string, coordinateSystem: string, coordinateSystemData: CoordinateSystemData, options?: RawAxiosRequestConfig): AxiosPromise<void>;
8446
8460
  /**
8447
- * Get the current robot motion group behavior - please see the setter [setMotionGroupBehavior](setMotionGroupBehavior) and the enum for details.
8448
- * @summary Behavior
8461
+ * 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.
8462
+ * @summary Add TCP
8449
8463
  * @param {string} cell Unique identifier addressing a cell in all API calls.
8450
8464
  * @param {string} controller Unique identifier to address a controller in the cell.
8451
8465
  * @param {string} motionGroup The motion-group identifier.
8466
+ * @param {string} tcp The unique identifier of a TCP.
8467
+ * @param {RobotTcpData} robotTcpData
8452
8468
  * @param {*} [options] Override http request option.
8453
8469
  * @throws {RequiredError}
8454
- * @memberof VirtualRobotBehaviorApi
8455
8470
  */
8456
- getMotionGroupBehavior(cell: string, controller: string, motionGroup: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<MotionGroupBehaviorGetter, any>>;
8471
+ addVirtualRobotTcp(cell: string, controller: string, motionGroup: string, tcp: string, robotTcpData: RobotTcpData, options?: RawAxiosRequestConfig): AxiosPromise<void>;
8457
8472
  /**
8458
- * Switch robot motion group behavior.
8459
- * @summary Switch Behavior
8473
+ * 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.
8474
+ * @summary Remove Coordinate System
8460
8475
  * @param {string} cell Unique identifier addressing a cell in all API calls.
8461
8476
  * @param {string} controller Unique identifier to address a controller in the cell.
8462
- * @param {string} motionGroup The motion-group identifier.
8463
- * @param {Behavior} [behavior]
8477
+ * @param {string} coordinateSystem Unique identifier addressing a coordinate system.
8478
+ * @param {boolean} [deleteDependent] If true, all dependent coordinate systems will be deleted as well.
8464
8479
  * @param {*} [options] Override http request option.
8465
8480
  * @throws {RequiredError}
8466
- * @memberof VirtualRobotBehaviorApi
8467
8481
  */
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) => {
8482
+ deleteVirtualRobotCoordinateSystem(cell: string, controller: string, coordinateSystem: string, deleteDependent?: boolean, options?: RawAxiosRequestConfig): AxiosPromise<void>;
8475
8483
  /**
8476
- * Get the cycle time of controller communication in [ms].
8477
- * @summary Cycle Time
8484
+ * Removes the TCP from the motion group. An unknown TCP is a valid input.
8485
+ * @summary Remove TCP
8478
8486
  * @param {string} cell Unique identifier addressing a cell in all API calls.
8479
8487
  * @param {string} controller Unique identifier to address a controller in the cell.
8488
+ * @param {string} motionGroup The motion-group identifier.
8489
+ * @param {string} tcp The unique identifier of a TCP.
8480
8490
  * @param {*} [options] Override http request option.
8481
8491
  * @throws {RequiredError}
8482
8492
  */
8483
- getCycleTime: (cell: string, controller: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
8493
+ deleteVirtualRobotTcp(cell: string, controller: string, motionGroup: string, tcp: string, options?: RawAxiosRequestConfig): AxiosPromise<void>;
8484
8494
  /**
8485
8495
  * 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
8496
  * @summary Get Emergency Stop State
@@ -8489,69 +8499,64 @@ export declare const VirtualRobotModeApiAxiosParamCreator: (configuration?: Conf
8489
8499
  * @param {*} [options] Override http request option.
8490
8500
  * @throws {RequiredError}
8491
8501
  */
8492
- getEmergencyStop: (cell: string, controller: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
8502
+ getEmergencyStop(cell: string, controller: string, options?: RawAxiosRequestConfig): AxiosPromise<Flag>;
8493
8503
  /**
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
8504
+ * Get the current motion group state which provides values for the joints\' position, velocity and acceleration.
8505
+ * @summary Get Motion Group State
8496
8506
  * @param {string} cell Unique identifier addressing a cell in all API calls.
8497
8507
  * @param {string} controller Unique identifier to address a controller in the cell.
8508
+ * @param {string} motionGroup The motion-group identifier.
8498
8509
  * @param {*} [options] Override http request option.
8499
8510
  * @throws {RequiredError}
8500
8511
  */
8501
- getOperationMode: (cell: string, controller: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
8512
+ getMotionGroupState(cell: string, controller: string, motionGroup: string, options?: RawAxiosRequestConfig): AxiosPromise<MotionGroupJoints>;
8502
8513
  /**
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
8514
+ * Gets information on the motion group.
8515
+ * @summary Motion Group Description
8505
8516
  * @param {string} cell Unique identifier addressing a cell in all API calls.
8506
8517
  * @param {string} controller Unique identifier to address a controller in the cell.
8507
- * @param {boolean} [active]
8508
8518
  * @param {*} [options] Override http request option.
8509
8519
  * @throws {RequiredError}
8510
8520
  */
8511
- setEmergencyStop: (cell: string, controller: string, active?: boolean, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
8521
+ getMotionGroups(cell: string, controller: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<MotionGroupInfo>>;
8512
8522
  /**
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
8523
+ * 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.
8524
+ * @summary Get Operation Mode
8515
8525
  * @param {string} cell Unique identifier addressing a cell in all API calls.
8516
8526
  * @param {string} controller Unique identifier to address a controller in the cell.
8517
- * @param {OperationMode} mode
8518
8527
  * @param {*} [options] Override http request option.
8519
8528
  * @throws {RequiredError}
8520
8529
  */
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) => {
8530
+ getOperationMode(cell: string, controller: string, options?: RawAxiosRequestConfig): AxiosPromise<OpMode>;
8528
8531
  /**
8529
- * Get the cycle time of controller communication in [ms].
8530
- * @summary Cycle Time
8532
+ * Gets motion group mounting. The motion group is based on the origin of the returned coordinate system.
8533
+ * @summary Get Mounting
8531
8534
  * @param {string} cell Unique identifier addressing a cell in all API calls.
8532
8535
  * @param {string} controller Unique identifier to address a controller in the cell.
8536
+ * @param {string} motionGroup The motion-group identifier.
8533
8537
  * @param {*} [options] Override http request option.
8534
8538
  * @throws {RequiredError}
8535
8539
  */
8536
- getCycleTime(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CycleTime>>;
8540
+ getVirtualRobotMounting(cell: string, controller: string, motionGroup: string, options?: RawAxiosRequestConfig): AxiosPromise<CoordinateSystem>;
8537
8541
  /**
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
8542
+ * Lists all coordinate systems on the robot controller.
8543
+ * @summary List Coordinate Systems
8540
8544
  * @param {string} cell Unique identifier addressing a cell in all API calls.
8541
8545
  * @param {string} controller Unique identifier to address a controller in the cell.
8542
8546
  * @param {*} [options] Override http request option.
8543
8547
  * @throws {RequiredError}
8544
8548
  */
8545
- getEmergencyStop(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Flag>>;
8549
+ listVirtualRobotCoordinateSystems(cell: string, controller: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<CoordinateSystem>>;
8546
8550
  /**
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
8551
+ * Lists TCPs of the motion group. An empty TCP list is valid, for example for external axes.
8552
+ * @summary List TCPs
8549
8553
  * @param {string} cell Unique identifier addressing a cell in all API calls.
8550
8554
  * @param {string} controller Unique identifier to address a controller in the cell.
8555
+ * @param {string} motionGroup The motion-group identifier.
8551
8556
  * @param {*} [options] Override http request option.
8552
8557
  * @throws {RequiredError}
8553
8558
  */
8554
- getOperationMode(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<OpMode>>;
8559
+ listVirtualRobotTcps(cell: string, controller: string, motionGroup: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<RobotTcp>>;
8555
8560
  /**
8556
8561
  * 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
8562
  * @summary Push or Release Emergency Stop
@@ -8561,7 +8566,18 @@ export declare const VirtualRobotModeApiFp: (configuration?: Configuration) => {
8561
8566
  * @param {*} [options] Override http request option.
8562
8567
  * @throws {RequiredError}
8563
8568
  */
8564
- setEmergencyStop(cell: string, controller: string, active?: boolean, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
8569
+ setEmergencyStop(cell: string, controller: string, active?: boolean, options?: RawAxiosRequestConfig): AxiosPromise<void>;
8570
+ /**
8571
+ * 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.
8572
+ * @summary Set Motion Group State
8573
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
8574
+ * @param {string} controller Unique identifier to address a controller in the cell.
8575
+ * @param {string} motionGroup The motion-group identifier.
8576
+ * @param {MotionGroupJoints} motionGroupJoints
8577
+ * @param {*} [options] Override http request option.
8578
+ * @throws {RequiredError}
8579
+ */
8580
+ setMotionGroupState(cell: string, controller: string, motionGroup: string, motionGroupJoints: MotionGroupJoints, options?: RawAxiosRequestConfig): AxiosPromise<void>;
8565
8581
  /**
8566
8582
  * 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
8583
  * @summary Set Operation Mode
@@ -8571,88 +8587,106 @@ export declare const VirtualRobotModeApiFp: (configuration?: Configuration) => {
8571
8587
  * @param {*} [options] Override http request option.
8572
8588
  * @throws {RequiredError}
8573
8589
  */
8574
- setOperationMode(cell: string, controller: string, mode: OperationMode, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
8590
+ setOperationMode(cell: string, controller: string, mode: OperationMode, options?: RawAxiosRequestConfig): AxiosPromise<void>;
8591
+ /**
8592
+ * 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.
8593
+ * @summary Set Mounting
8594
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
8595
+ * @param {string} controller Unique identifier to address a controller in the cell.
8596
+ * @param {string} motionGroup The motion-group identifier.
8597
+ * @param {CoordinateSystem} coordinateSystem
8598
+ * @param {*} [options] Override http request option.
8599
+ * @throws {RequiredError}
8600
+ */
8601
+ setVirtualRobotMounting(cell: string, controller: string, motionGroup: string, coordinateSystem: CoordinateSystem, options?: RawAxiosRequestConfig): AxiosPromise<CoordinateSystem>;
8575
8602
  };
8576
8603
  /**
8577
- * VirtualRobotModeApi - factory interface
8604
+ * VirtualControllerApi - object-oriented interface
8578
8605
  * @export
8606
+ * @class VirtualControllerApi
8607
+ * @extends {BaseAPI}
8579
8608
  */
8580
- export declare const VirtualRobotModeApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
8609
+ export declare class VirtualControllerApi extends BaseAPI {
8581
8610
  /**
8582
- * Get the cycle time of controller communication in [ms].
8583
- * @summary Cycle Time
8611
+ * Adds a coordinate system to the robot controller.
8612
+ * @summary Add Coordinate Systems
8584
8613
  * @param {string} cell Unique identifier addressing a cell in all API calls.
8585
8614
  * @param {string} controller Unique identifier to address a controller in the cell.
8615
+ * @param {string} coordinateSystem Unique identifier addressing a coordinate system.
8616
+ * @param {CoordinateSystemData} coordinateSystemData
8586
8617
  * @param {*} [options] Override http request option.
8587
8618
  * @throws {RequiredError}
8619
+ * @memberof VirtualControllerApi
8588
8620
  */
8589
- getCycleTime(cell: string, controller: string, options?: RawAxiosRequestConfig): AxiosPromise<CycleTime>;
8621
+ addVirtualRobotCoordinateSystem(cell: string, controller: string, coordinateSystem: string, coordinateSystemData: CoordinateSystemData, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
8590
8622
  /**
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
8623
+ * 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.
8624
+ * @summary Add TCP
8593
8625
  * @param {string} cell Unique identifier addressing a cell in all API calls.
8594
8626
  * @param {string} controller Unique identifier to address a controller in the cell.
8627
+ * @param {string} motionGroup The motion-group identifier.
8628
+ * @param {string} tcp The unique identifier of a TCP.
8629
+ * @param {RobotTcpData} robotTcpData
8595
8630
  * @param {*} [options] Override http request option.
8596
8631
  * @throws {RequiredError}
8632
+ * @memberof VirtualControllerApi
8597
8633
  */
8598
- getEmergencyStop(cell: string, controller: string, options?: RawAxiosRequestConfig): AxiosPromise<Flag>;
8634
+ addVirtualRobotTcp(cell: string, controller: string, motionGroup: string, tcp: string, robotTcpData: RobotTcpData, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
8599
8635
  /**
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
8636
+ * 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.
8637
+ * @summary Remove Coordinate System
8602
8638
  * @param {string} cell Unique identifier addressing a cell in all API calls.
8603
8639
  * @param {string} controller Unique identifier to address a controller in the cell.
8640
+ * @param {string} coordinateSystem Unique identifier addressing a coordinate system.
8641
+ * @param {boolean} [deleteDependent] If true, all dependent coordinate systems will be deleted as well.
8604
8642
  * @param {*} [options] Override http request option.
8605
8643
  * @throws {RequiredError}
8644
+ * @memberof VirtualControllerApi
8606
8645
  */
8607
- getOperationMode(cell: string, controller: string, options?: RawAxiosRequestConfig): AxiosPromise<OpMode>;
8646
+ deleteVirtualRobotCoordinateSystem(cell: string, controller: string, coordinateSystem: string, deleteDependent?: boolean, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
8608
8647
  /**
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
8648
+ * Removes the TCP from the motion group. An unknown TCP is a valid input.
8649
+ * @summary Remove TCP
8611
8650
  * @param {string} cell Unique identifier addressing a cell in all API calls.
8612
8651
  * @param {string} controller Unique identifier to address a controller in the cell.
8613
- * @param {boolean} [active]
8652
+ * @param {string} motionGroup The motion-group identifier.
8653
+ * @param {string} tcp The unique identifier of a TCP.
8614
8654
  * @param {*} [options] Override http request option.
8615
8655
  * @throws {RequiredError}
8656
+ * @memberof VirtualControllerApi
8616
8657
  */
8617
- setEmergencyStop(cell: string, controller: string, active?: boolean, options?: RawAxiosRequestConfig): AxiosPromise<void>;
8658
+ deleteVirtualRobotTcp(cell: string, controller: string, motionGroup: string, tcp: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
8618
8659
  /**
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
8660
+ * 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.
8661
+ * @summary Get Emergency Stop State
8621
8662
  * @param {string} cell Unique identifier addressing a cell in all API calls.
8622
8663
  * @param {string} controller Unique identifier to address a controller in the cell.
8623
- * @param {OperationMode} mode
8624
8664
  * @param {*} [options] Override http request option.
8625
8665
  * @throws {RequiredError}
8666
+ * @memberof VirtualControllerApi
8626
8667
  */
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 {
8668
+ getEmergencyStop(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Flag, any>>;
8636
8669
  /**
8637
- * Get the cycle time of controller communication in [ms].
8638
- * @summary Cycle Time
8670
+ * Get the current motion group state which provides values for the joints\' position, velocity and acceleration.
8671
+ * @summary Get Motion Group State
8639
8672
  * @param {string} cell Unique identifier addressing a cell in all API calls.
8640
8673
  * @param {string} controller Unique identifier to address a controller in the cell.
8674
+ * @param {string} motionGroup The motion-group identifier.
8641
8675
  * @param {*} [options] Override http request option.
8642
8676
  * @throws {RequiredError}
8643
- * @memberof VirtualRobotModeApi
8677
+ * @memberof VirtualControllerApi
8644
8678
  */
8645
- getCycleTime(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CycleTime, any>>;
8679
+ getMotionGroupState(cell: string, controller: string, motionGroup: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<MotionGroupJoints, any>>;
8646
8680
  /**
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
8681
+ * Gets information on the motion group.
8682
+ * @summary Motion Group Description
8649
8683
  * @param {string} cell Unique identifier addressing a cell in all API calls.
8650
8684
  * @param {string} controller Unique identifier to address a controller in the cell.
8651
8685
  * @param {*} [options] Override http request option.
8652
8686
  * @throws {RequiredError}
8653
- * @memberof VirtualRobotModeApi
8687
+ * @memberof VirtualControllerApi
8654
8688
  */
8655
- getEmergencyStop(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Flag, any>>;
8689
+ getMotionGroups(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<MotionGroupInfo[], any>>;
8656
8690
  /**
8657
8691
  * 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
8692
  * @summary Get Operation Mode
@@ -8660,395 +8694,428 @@ export declare class VirtualRobotModeApi extends BaseAPI {
8660
8694
  * @param {string} controller Unique identifier to address a controller in the cell.
8661
8695
  * @param {*} [options] Override http request option.
8662
8696
  * @throws {RequiredError}
8663
- * @memberof VirtualRobotModeApi
8697
+ * @memberof VirtualControllerApi
8664
8698
  */
8665
8699
  getOperationMode(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<OpMode, any>>;
8666
8700
  /**
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
8701
+ * Gets motion group mounting. The motion group is based on the origin of the returned coordinate system.
8702
+ * @summary Get Mounting
8669
8703
  * @param {string} cell Unique identifier addressing a cell in all API calls.
8670
8704
  * @param {string} controller Unique identifier to address a controller in the cell.
8671
- * @param {boolean} [active]
8705
+ * @param {string} motionGroup The motion-group identifier.
8672
8706
  * @param {*} [options] Override http request option.
8673
8707
  * @throws {RequiredError}
8674
- * @memberof VirtualRobotModeApi
8708
+ * @memberof VirtualControllerApi
8675
8709
  */
8676
- setEmergencyStop(cell: string, controller: string, active?: boolean, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
8710
+ getVirtualRobotMounting(cell: string, controller: string, motionGroup: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CoordinateSystem, any>>;
8677
8711
  /**
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
8712
+ * Lists all coordinate systems on the robot controller.
8713
+ * @summary List Coordinate Systems
8680
8714
  * @param {string} cell Unique identifier addressing a cell in all API calls.
8681
8715
  * @param {string} controller Unique identifier to address a controller in the cell.
8682
- * @param {OperationMode} mode
8683
8716
  * @param {*} [options] Override http request option.
8684
8717
  * @throws {RequiredError}
8685
- * @memberof VirtualRobotModeApi
8718
+ * @memberof VirtualControllerApi
8686
8719
  */
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) => {
8720
+ listVirtualRobotCoordinateSystems(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CoordinateSystem[], any>>;
8694
8721
  /**
8695
- * Adds a coordinate system to the robot controller.
8696
- * @summary Add Coordinate Systems
8722
+ * Lists TCPs of the motion group. An empty TCP list is valid, for example for external axes.
8723
+ * @summary List TCPs
8697
8724
  * @param {string} cell Unique identifier addressing a cell in all API calls.
8698
8725
  * @param {string} controller Unique identifier to address a controller in the cell.
8699
- * @param {CoordinateSystem} coordinateSystem
8726
+ * @param {string} motionGroup The motion-group identifier.
8700
8727
  * @param {*} [options] Override http request option.
8701
8728
  * @throws {RequiredError}
8729
+ * @memberof VirtualControllerApi
8702
8730
  */
8703
- addVirtualRobotCoordinateSystem: (cell: string, controller: string, coordinateSystem: CoordinateSystem, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
8731
+ listVirtualRobotTcps(cell: string, controller: string, motionGroup: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<RobotTcp[], any>>;
8704
8732
  /**
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
8733
+ * 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.
8734
+ * @summary Push or Release Emergency Stop
8735
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
8736
+ * @param {string} controller Unique identifier to address a controller in the cell.
8737
+ * @param {boolean} [active]
8738
+ * @param {*} [options] Override http request option.
8739
+ * @throws {RequiredError}
8740
+ * @memberof VirtualControllerApi
8741
+ */
8742
+ setEmergencyStop(cell: string, controller: string, active?: boolean, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
8743
+ /**
8744
+ * 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.
8745
+ * @summary Set Motion Group State
8707
8746
  * @param {string} cell Unique identifier addressing a cell in all API calls.
8708
8747
  * @param {string} controller Unique identifier to address a controller in the cell.
8709
8748
  * @param {string} motionGroup The motion-group identifier.
8710
- * @param {RobotTcp} robotTcp
8749
+ * @param {MotionGroupJoints} motionGroupJoints
8711
8750
  * @param {*} [options] Override http request option.
8712
8751
  * @throws {RequiredError}
8752
+ * @memberof VirtualControllerApi
8713
8753
  */
8714
- addVirtualRobotTcp: (cell: string, controller: string, motionGroup: string, robotTcp: RobotTcp, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
8754
+ setMotionGroupState(cell: string, controller: string, motionGroup: string, motionGroupJoints: MotionGroupJoints, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
8715
8755
  /**
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
8756
+ * 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.
8757
+ * @summary Set Operation Mode
8718
8758
  * @param {string} cell Unique identifier addressing a cell in all API calls.
8719
8759
  * @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.
8760
+ * @param {OperationMode} mode
8722
8761
  * @param {*} [options] Override http request option.
8723
8762
  * @throws {RequiredError}
8763
+ * @memberof VirtualControllerApi
8724
8764
  */
8725
- deleteVirtualRobotCoordinateSystem: (cell: string, controller: string, coordinateSystem: string, deleteDependent?: boolean, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
8765
+ setOperationMode(cell: string, controller: string, mode: OperationMode, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
8726
8766
  /**
8727
- * Removes the TCP from the motion group. An unknown TCP is a valid input.
8728
- * @summary Remove TCP
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
8729
8769
  * @param {string} cell Unique identifier addressing a cell in all API calls.
8730
8770
  * @param {string} controller Unique identifier to address a controller in the cell.
8731
8771
  * @param {string} motionGroup The motion-group identifier.
8732
- * @param {string} tcp The unique identifier of a TCP.
8772
+ * @param {CoordinateSystem} coordinateSystem
8733
8773
  * @param {*} [options] Override http request option.
8734
8774
  * @throws {RequiredError}
8775
+ * @memberof VirtualControllerApi
8735
8776
  */
8736
- deleteVirtualRobotTcp: (cell: string, controller: string, motionGroup: string, tcp: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
8777
+ setVirtualRobotMounting(cell: string, controller: string, motionGroup: string, coordinateSystem: CoordinateSystem, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CoordinateSystem, any>>;
8778
+ }
8779
+ /**
8780
+ * VirtualControllerBehaviorApi - axios parameter creator
8781
+ * @export
8782
+ */
8783
+ export declare const VirtualControllerBehaviorApiAxiosParamCreator: (configuration?: Configuration) => {
8737
8784
  /**
8738
- * Gets motion group mounting. The motion group is based on the origin of the returned coordinate system.
8739
- * @summary Get Mounting
8785
+ * <!-- 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.
8786
+ * @summary Stream Joint Configuration
8740
8787
  * @param {string} cell Unique identifier addressing a cell in all API calls.
8741
8788
  * @param {string} controller Unique identifier to address a controller in the cell.
8742
- * @param {string} motionGroup The motion-group identifier.
8789
+ * @param {ExternalJointStreamRequest} externalJointStreamRequest
8743
8790
  * @param {*} [options] Override http request option.
8744
8791
  * @throws {RequiredError}
8745
8792
  */
8746
- getVirtualRobotMounting: (cell: string, controller: string, motionGroup: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
8793
+ externalJointsStream: (cell: string, controller: string, externalJointStreamRequest: ExternalJointStreamRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
8747
8794
  /**
8748
- * Lists all coordinate systems on the robot controller.
8749
- * @summary List Coordinate Systems
8795
+ * Get the cycle time of controller communication in [ms].
8796
+ * @summary Get Cycle Time
8750
8797
  * @param {string} cell Unique identifier addressing a cell in all API calls.
8751
8798
  * @param {string} controller Unique identifier to address a controller in the cell.
8752
8799
  * @param {*} [options] Override http request option.
8753
8800
  * @throws {RequiredError}
8754
8801
  */
8755
- listVirtualRobotCoordinateSystems: (cell: string, controller: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
8802
+ getCycleTime: (cell: string, controller: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
8756
8803
  /**
8757
- * Lists TCPs of the motion group. An empty TCP list is valid, for example for external axes.
8758
- * @summary List TCPs
8804
+ * Get the current virtual controller behavior - please see the setter [setVirtualRobotBehavior](setVirtualRobotBehavior) and the enum for details.
8805
+ * @summary Get Behavior
8759
8806
  * @param {string} cell Unique identifier addressing a cell in all API calls.
8760
8807
  * @param {string} controller Unique identifier to address a controller in the cell.
8761
- * @param {string} motionGroup The motion-group identifier.
8762
8808
  * @param {*} [options] Override http request option.
8763
8809
  * @throws {RequiredError}
8764
8810
  */
8765
- listVirtualRobotTcps: (cell: string, controller: string, motionGroup: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
8811
+ getVirtualRobotBehavior: (cell: string, controller: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
8766
8812
  /**
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
8813
+ * Set virtual controller behavior.
8814
+ * @summary Set Behavior
8769
8815
  * @param {string} cell Unique identifier addressing a cell in all API calls.
8770
8816
  * @param {string} controller Unique identifier to address a controller in the cell.
8771
- * @param {string} motionGroup The motion-group identifier.
8772
- * @param {CoordinateSystem} coordinateSystem
8817
+ * @param {Behavior} [behavior]
8773
8818
  * @param {*} [options] Override http request option.
8774
8819
  * @throws {RequiredError}
8775
8820
  */
8776
- setVirtualRobotMounting: (cell: string, controller: string, motionGroup: string, coordinateSystem: CoordinateSystem, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
8821
+ setVirtualRobotBehavior: (cell: string, controller: string, behavior?: Behavior, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
8777
8822
  };
8778
8823
  /**
8779
- * VirtualRobotSetupApi - functional programming interface
8824
+ * VirtualControllerBehaviorApi - functional programming interface
8780
8825
  * @export
8781
8826
  */
8782
- export declare const VirtualRobotSetupApiFp: (configuration?: Configuration) => {
8827
+ export declare const VirtualControllerBehaviorApiFp: (configuration?: Configuration) => {
8783
8828
  /**
8784
- * Adds a coordinate system to the robot controller.
8785
- * @summary Add Coordinate Systems
8829
+ * <!-- 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.
8830
+ * @summary Stream Joint Configuration
8786
8831
  * @param {string} cell Unique identifier addressing a cell in all API calls.
8787
8832
  * @param {string} controller Unique identifier to address a controller in the cell.
8788
- * @param {CoordinateSystem} coordinateSystem
8833
+ * @param {ExternalJointStreamRequest} externalJointStreamRequest
8789
8834
  * @param {*} [options] Override http request option.
8790
8835
  * @throws {RequiredError}
8791
8836
  */
8792
- addVirtualRobotCoordinateSystem(cell: string, controller: string, coordinateSystem: CoordinateSystem, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
8837
+ externalJointsStream(cell: string, controller: string, externalJointStreamRequest: ExternalJointStreamRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<ExternalJointStreamDatapoint>>>;
8793
8838
  /**
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
8839
+ * Get the cycle time of controller communication in [ms].
8840
+ * @summary Get Cycle Time
8796
8841
  * @param {string} cell Unique identifier addressing a cell in all API calls.
8797
8842
  * @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
8843
  * @param {*} [options] Override http request option.
8801
8844
  * @throws {RequiredError}
8802
8845
  */
8803
- addVirtualRobotTcp(cell: string, controller: string, motionGroup: string, robotTcp: RobotTcp, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
8846
+ getCycleTime(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CycleTime>>;
8804
8847
  /**
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
8848
+ * Get the current virtual controller behavior - please see the setter [setVirtualRobotBehavior](setVirtualRobotBehavior) and the enum for details.
8849
+ * @summary Get Behavior
8807
8850
  * @param {string} cell Unique identifier addressing a cell in all API calls.
8808
8851
  * @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
8852
  * @param {*} [options] Override http request option.
8812
8853
  * @throws {RequiredError}
8813
8854
  */
8814
- deleteVirtualRobotCoordinateSystem(cell: string, controller: string, coordinateSystem: string, deleteDependent?: boolean, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
8855
+ getVirtualRobotBehavior(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Behavior>>;
8815
8856
  /**
8816
- * Removes the TCP from the motion group. An unknown TCP is a valid input.
8817
- * @summary Remove TCP
8857
+ * Set virtual controller behavior.
8858
+ * @summary Set Behavior
8818
8859
  * @param {string} cell Unique identifier addressing a cell in all API calls.
8819
8860
  * @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.
8861
+ * @param {Behavior} [behavior]
8822
8862
  * @param {*} [options] Override http request option.
8823
8863
  * @throws {RequiredError}
8824
8864
  */
8825
- deleteVirtualRobotTcp(cell: string, controller: string, motionGroup: string, tcp: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
8865
+ setVirtualRobotBehavior(cell: string, controller: string, behavior?: Behavior, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
8866
+ };
8867
+ /**
8868
+ * VirtualControllerBehaviorApi - factory interface
8869
+ * @export
8870
+ */
8871
+ export declare const VirtualControllerBehaviorApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
8826
8872
  /**
8827
- * Gets motion group mounting. The motion group is based on the origin of the returned coordinate system.
8828
- * @summary Get Mounting
8873
+ * <!-- 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.
8874
+ * @summary Stream Joint Configuration
8829
8875
  * @param {string} cell Unique identifier addressing a cell in all API calls.
8830
8876
  * @param {string} controller Unique identifier to address a controller in the cell.
8831
- * @param {string} motionGroup The motion-group identifier.
8877
+ * @param {ExternalJointStreamRequest} externalJointStreamRequest
8832
8878
  * @param {*} [options] Override http request option.
8833
8879
  * @throws {RequiredError}
8834
8880
  */
8835
- getVirtualRobotMounting(cell: string, controller: string, motionGroup: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CoordinateSystem>>;
8881
+ externalJointsStream(cell: string, controller: string, externalJointStreamRequest: ExternalJointStreamRequest, options?: RawAxiosRequestConfig): AxiosPromise<Array<ExternalJointStreamDatapoint>>;
8836
8882
  /**
8837
- * Lists all coordinate systems on the robot controller.
8838
- * @summary List Coordinate Systems
8883
+ * Get the cycle time of controller communication in [ms].
8884
+ * @summary Get Cycle Time
8839
8885
  * @param {string} cell Unique identifier addressing a cell in all API calls.
8840
8886
  * @param {string} controller Unique identifier to address a controller in the cell.
8841
8887
  * @param {*} [options] Override http request option.
8842
8888
  * @throws {RequiredError}
8843
8889
  */
8844
- listVirtualRobotCoordinateSystems(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CoordinateSystems>>;
8890
+ getCycleTime(cell: string, controller: string, options?: RawAxiosRequestConfig): AxiosPromise<CycleTime>;
8845
8891
  /**
8846
- * Lists TCPs of the motion group. An empty TCP list is valid, for example for external axes.
8847
- * @summary List TCPs
8892
+ * Get the current virtual controller behavior - please see the setter [setVirtualRobotBehavior](setVirtualRobotBehavior) and the enum for details.
8893
+ * @summary Get Behavior
8848
8894
  * @param {string} cell Unique identifier addressing a cell in all API calls.
8849
8895
  * @param {string} controller Unique identifier to address a controller in the cell.
8850
- * @param {string} motionGroup The motion-group identifier.
8851
8896
  * @param {*} [options] Override http request option.
8852
8897
  * @throws {RequiredError}
8853
8898
  */
8854
- listVirtualRobotTcps(cell: string, controller: string, motionGroup: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<RobotTcps>>;
8899
+ getVirtualRobotBehavior(cell: string, controller: string, options?: RawAxiosRequestConfig): AxiosPromise<Behavior>;
8855
8900
  /**
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
8901
+ * Set virtual controller behavior.
8902
+ * @summary Set Behavior
8858
8903
  * @param {string} cell Unique identifier addressing a cell in all API calls.
8859
8904
  * @param {string} controller Unique identifier to address a controller in the cell.
8860
- * @param {string} motionGroup The motion-group identifier.
8861
- * @param {CoordinateSystem} coordinateSystem
8905
+ * @param {Behavior} [behavior]
8862
8906
  * @param {*} [options] Override http request option.
8863
8907
  * @throws {RequiredError}
8864
8908
  */
8865
- setVirtualRobotMounting(cell: string, controller: string, motionGroup: string, coordinateSystem: CoordinateSystem, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CoordinateSystem>>;
8909
+ setVirtualRobotBehavior(cell: string, controller: string, behavior?: Behavior, options?: RawAxiosRequestConfig): AxiosPromise<void>;
8866
8910
  };
8867
8911
  /**
8868
- * VirtualRobotSetupApi - factory interface
8912
+ * VirtualControllerBehaviorApi - object-oriented interface
8869
8913
  * @export
8914
+ * @class VirtualControllerBehaviorApi
8915
+ * @extends {BaseAPI}
8870
8916
  */
8871
- export declare const VirtualRobotSetupApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
8917
+ export declare class VirtualControllerBehaviorApi extends BaseAPI {
8872
8918
  /**
8873
- * Adds a coordinate system to the robot controller.
8874
- * @summary Add Coordinate Systems
8919
+ * <!-- 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.
8920
+ * @summary Stream Joint Configuration
8875
8921
  * @param {string} cell Unique identifier addressing a cell in all API calls.
8876
8922
  * @param {string} controller Unique identifier to address a controller in the cell.
8877
- * @param {CoordinateSystem} coordinateSystem
8923
+ * @param {ExternalJointStreamRequest} externalJointStreamRequest
8878
8924
  * @param {*} [options] Override http request option.
8879
8925
  * @throws {RequiredError}
8926
+ * @memberof VirtualControllerBehaviorApi
8880
8927
  */
8881
- addVirtualRobotCoordinateSystem(cell: string, controller: string, coordinateSystem: CoordinateSystem, options?: RawAxiosRequestConfig): AxiosPromise<void>;
8928
+ externalJointsStream(cell: string, controller: string, externalJointStreamRequest: ExternalJointStreamRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ExternalJointStreamDatapoint[], any>>;
8882
8929
  /**
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
8930
+ * Get the cycle time of controller communication in [ms].
8931
+ * @summary Get Cycle Time
8885
8932
  * @param {string} cell Unique identifier addressing a cell in all API calls.
8886
8933
  * @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
8934
  * @param {*} [options] Override http request option.
8890
8935
  * @throws {RequiredError}
8936
+ * @memberof VirtualControllerBehaviorApi
8891
8937
  */
8892
- addVirtualRobotTcp(cell: string, controller: string, motionGroup: string, robotTcp: RobotTcp, options?: RawAxiosRequestConfig): AxiosPromise<void>;
8938
+ getCycleTime(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CycleTime, any>>;
8893
8939
  /**
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
8940
+ * Get the current virtual controller behavior - please see the setter [setVirtualRobotBehavior](setVirtualRobotBehavior) and the enum for details.
8941
+ * @summary Get Behavior
8896
8942
  * @param {string} cell Unique identifier addressing a cell in all API calls.
8897
8943
  * @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
8944
  * @param {*} [options] Override http request option.
8901
8945
  * @throws {RequiredError}
8946
+ * @memberof VirtualControllerBehaviorApi
8902
8947
  */
8903
- deleteVirtualRobotCoordinateSystem(cell: string, controller: string, coordinateSystem: string, deleteDependent?: boolean, options?: RawAxiosRequestConfig): AxiosPromise<void>;
8948
+ getVirtualRobotBehavior(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Behavior, any>>;
8904
8949
  /**
8905
- * Removes the TCP from the motion group. An unknown TCP is a valid input.
8906
- * @summary Remove TCP
8950
+ * Set virtual controller behavior.
8951
+ * @summary Set Behavior
8907
8952
  * @param {string} cell Unique identifier addressing a cell in all API calls.
8908
8953
  * @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.
8954
+ * @param {Behavior} [behavior]
8911
8955
  * @param {*} [options] Override http request option.
8912
8956
  * @throws {RequiredError}
8957
+ * @memberof VirtualControllerBehaviorApi
8913
8958
  */
8914
- deleteVirtualRobotTcp(cell: string, controller: string, motionGroup: string, tcp: string, options?: RawAxiosRequestConfig): AxiosPromise<void>;
8959
+ setVirtualRobotBehavior(cell: string, controller: string, behavior?: Behavior, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
8960
+ }
8961
+ /**
8962
+ * VirtualControllerInputsOutputsApi - axios parameter creator
8963
+ * @export
8964
+ */
8965
+ export declare const VirtualControllerInputsOutputsApiAxiosParamCreator: (configuration?: Configuration) => {
8915
8966
  /**
8916
- * Gets motion group mounting. The motion group is based on the origin of the returned coordinate system.
8917
- * @summary Get Mounting
8967
+ * 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).
8968
+ * @summary Get Input/Output Values
8918
8969
  * @param {string} cell Unique identifier addressing a cell in all API calls.
8919
8970
  * @param {string} controller Unique identifier to address a controller in the cell.
8920
- * @param {string} motionGroup The motion-group identifier.
8971
+ * @param {Array<string>} ios
8921
8972
  * @param {*} [options] Override http request option.
8922
8973
  * @throws {RequiredError}
8923
8974
  */
8924
- getVirtualRobotMounting(cell: string, controller: string, motionGroup: string, options?: RawAxiosRequestConfig): AxiosPromise<CoordinateSystem>;
8975
+ listIOs: (cell: string, controller: string, ios: Array<string>, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
8925
8976
  /**
8926
- * Lists all coordinate systems on the robot controller.
8927
- * @summary List Coordinate Systems
8977
+ * 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.
8978
+ * @summary List Descriptions
8928
8979
  * @param {string} cell Unique identifier addressing a cell in all API calls.
8929
8980
  * @param {string} controller Unique identifier to address a controller in the cell.
8981
+ * @param {Array<string>} [ios]
8982
+ * @param {IODirection} [direction] Return only inputs/outputs with the specified direction.
8983
+ * @param {IOValueType} [valueType] Return only inputs/outputs with the specified value type.
8984
+ * @param {string} [group] Return only inputs/outputs from the specified group.
8930
8985
  * @param {*} [options] Override http request option.
8931
8986
  * @throws {RequiredError}
8932
8987
  */
8933
- listVirtualRobotCoordinateSystems(cell: string, controller: string, options?: RawAxiosRequestConfig): AxiosPromise<CoordinateSystems>;
8988
+ listVirtualRobotIODescriptions: (cell: string, controller: string, ios?: Array<string>, direction?: IODirection, valueType?: IOValueType, group?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
8934
8989
  /**
8935
- * Lists TCPs of the motion group. An empty TCP list is valid, for example for external axes.
8936
- * @summary List TCPs
8990
+ * Sets a list of values of a virtual controller inputs/outputs.
8991
+ * @summary Set Input/Ouput Values
8937
8992
  * @param {string} cell Unique identifier addressing a cell in all API calls.
8938
8993
  * @param {string} controller Unique identifier to address a controller in the cell.
8939
- * @param {string} motionGroup The motion-group identifier.
8994
+ * @param {Array<IOValue>} iOValue
8940
8995
  * @param {*} [options] Override http request option.
8941
8996
  * @throws {RequiredError}
8942
8997
  */
8943
- listVirtualRobotTcps(cell: string, controller: string, motionGroup: string, options?: RawAxiosRequestConfig): AxiosPromise<RobotTcps>;
8998
+ setIOValues: (cell: string, controller: string, iOValue: Array<IOValue>, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
8999
+ };
9000
+ /**
9001
+ * VirtualControllerInputsOutputsApi - functional programming interface
9002
+ * @export
9003
+ */
9004
+ export declare const VirtualControllerInputsOutputsApiFp: (configuration?: Configuration) => {
8944
9005
  /**
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
9006
+ * 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).
9007
+ * @summary Get Input/Output Values
8947
9008
  * @param {string} cell Unique identifier addressing a cell in all API calls.
8948
9009
  * @param {string} controller Unique identifier to address a controller in the cell.
8949
- * @param {string} motionGroup The motion-group identifier.
8950
- * @param {CoordinateSystem} coordinateSystem
9010
+ * @param {Array<string>} ios
8951
9011
  * @param {*} [options] Override http request option.
8952
9012
  * @throws {RequiredError}
8953
9013
  */
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 {
9014
+ listIOs(cell: string, controller: string, ios: Array<string>, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<IOValue>>>;
8963
9015
  /**
8964
- * Adds a coordinate system to the robot controller.
8965
- * @summary Add Coordinate Systems
9016
+ * 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.
9017
+ * @summary List Descriptions
8966
9018
  * @param {string} cell Unique identifier addressing a cell in all API calls.
8967
9019
  * @param {string} controller Unique identifier to address a controller in the cell.
8968
- * @param {CoordinateSystem} coordinateSystem
9020
+ * @param {Array<string>} [ios]
9021
+ * @param {IODirection} [direction] Return only inputs/outputs with the specified direction.
9022
+ * @param {IOValueType} [valueType] Return only inputs/outputs with the specified value type.
9023
+ * @param {string} [group] Return only inputs/outputs from the specified group.
8969
9024
  * @param {*} [options] Override http request option.
8970
9025
  * @throws {RequiredError}
8971
- * @memberof VirtualRobotSetupApi
8972
9026
  */
8973
- addVirtualRobotCoordinateSystem(cell: string, controller: string, coordinateSystem: CoordinateSystem, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
9027
+ 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
9028
  /**
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
9029
+ * Sets a list of values of a virtual controller inputs/outputs.
9030
+ * @summary Set Input/Ouput Values
8977
9031
  * @param {string} cell Unique identifier addressing a cell in all API calls.
8978
9032
  * @param {string} controller Unique identifier to address a controller in the cell.
8979
- * @param {string} motionGroup The motion-group identifier.
8980
- * @param {RobotTcp} robotTcp
9033
+ * @param {Array<IOValue>} iOValue
8981
9034
  * @param {*} [options] Override http request option.
8982
9035
  * @throws {RequiredError}
8983
- * @memberof VirtualRobotSetupApi
8984
9036
  */
8985
- addVirtualRobotTcp(cell: string, controller: string, motionGroup: string, robotTcp: RobotTcp, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
9037
+ setIOValues(cell: string, controller: string, iOValue: Array<IOValue>, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
9038
+ };
9039
+ /**
9040
+ * VirtualControllerInputsOutputsApi - factory interface
9041
+ * @export
9042
+ */
9043
+ export declare const VirtualControllerInputsOutputsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
8986
9044
  /**
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
9045
+ * 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).
9046
+ * @summary Get Input/Output Values
8989
9047
  * @param {string} cell Unique identifier addressing a cell in all API calls.
8990
9048
  * @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.
9049
+ * @param {Array<string>} ios
8993
9050
  * @param {*} [options] Override http request option.
8994
9051
  * @throws {RequiredError}
8995
- * @memberof VirtualRobotSetupApi
8996
9052
  */
8997
- deleteVirtualRobotCoordinateSystem(cell: string, controller: string, coordinateSystem: string, deleteDependent?: boolean, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
9053
+ listIOs(cell: string, controller: string, ios: Array<string>, options?: RawAxiosRequestConfig): AxiosPromise<Array<IOValue>>;
8998
9054
  /**
8999
- * Removes the TCP from the motion group. An unknown TCP is a valid input.
9000
- * @summary Remove TCP
9055
+ * 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.
9056
+ * @summary List Descriptions
9001
9057
  * @param {string} cell Unique identifier addressing a cell in all API calls.
9002
9058
  * @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.
9059
+ * @param {Array<string>} [ios]
9060
+ * @param {IODirection} [direction] Return only inputs/outputs with the specified direction.
9061
+ * @param {IOValueType} [valueType] Return only inputs/outputs with the specified value type.
9062
+ * @param {string} [group] Return only inputs/outputs from the specified group.
9005
9063
  * @param {*} [options] Override http request option.
9006
9064
  * @throws {RequiredError}
9007
- * @memberof VirtualRobotSetupApi
9008
9065
  */
9009
- deleteVirtualRobotTcp(cell: string, controller: string, motionGroup: string, tcp: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
9066
+ listVirtualRobotIODescriptions(cell: string, controller: string, ios?: Array<string>, direction?: IODirection, valueType?: IOValueType, group?: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<IODescription>>;
9010
9067
  /**
9011
- * Gets motion group mounting. The motion group is based on the origin of the returned coordinate system.
9012
- * @summary Get Mounting
9068
+ * Sets a list of values of a virtual controller inputs/outputs.
9069
+ * @summary Set Input/Ouput Values
9013
9070
  * @param {string} cell Unique identifier addressing a cell in all API calls.
9014
9071
  * @param {string} controller Unique identifier to address a controller in the cell.
9015
- * @param {string} motionGroup The motion-group identifier.
9072
+ * @param {Array<IOValue>} iOValue
9016
9073
  * @param {*} [options] Override http request option.
9017
9074
  * @throws {RequiredError}
9018
- * @memberof VirtualRobotSetupApi
9019
9075
  */
9020
- getVirtualRobotMounting(cell: string, controller: string, motionGroup: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CoordinateSystem, any>>;
9076
+ setIOValues(cell: string, controller: string, iOValue: Array<IOValue>, options?: RawAxiosRequestConfig): AxiosPromise<void>;
9077
+ };
9078
+ /**
9079
+ * VirtualControllerInputsOutputsApi - object-oriented interface
9080
+ * @export
9081
+ * @class VirtualControllerInputsOutputsApi
9082
+ * @extends {BaseAPI}
9083
+ */
9084
+ export declare class VirtualControllerInputsOutputsApi extends BaseAPI {
9021
9085
  /**
9022
- * Lists all coordinate systems on the robot controller.
9023
- * @summary List Coordinate Systems
9086
+ * 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).
9087
+ * @summary Get Input/Output Values
9024
9088
  * @param {string} cell Unique identifier addressing a cell in all API calls.
9025
9089
  * @param {string} controller Unique identifier to address a controller in the cell.
9090
+ * @param {Array<string>} ios
9026
9091
  * @param {*} [options] Override http request option.
9027
9092
  * @throws {RequiredError}
9028
- * @memberof VirtualRobotSetupApi
9093
+ * @memberof VirtualControllerInputsOutputsApi
9029
9094
  */
9030
- listVirtualRobotCoordinateSystems(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CoordinateSystems, any>>;
9095
+ listIOs(cell: string, controller: string, ios: Array<string>, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<IOValue[], any>>;
9031
9096
  /**
9032
- * Lists TCPs of the motion group. An empty TCP list is valid, for example for external axes.
9033
- * @summary List TCPs
9097
+ * 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.
9098
+ * @summary List Descriptions
9034
9099
  * @param {string} cell Unique identifier addressing a cell in all API calls.
9035
9100
  * @param {string} controller Unique identifier to address a controller in the cell.
9036
- * @param {string} motionGroup The motion-group identifier.
9101
+ * @param {Array<string>} [ios]
9102
+ * @param {IODirection} [direction] Return only inputs/outputs with the specified direction.
9103
+ * @param {IOValueType} [valueType] Return only inputs/outputs with the specified value type.
9104
+ * @param {string} [group] Return only inputs/outputs from the specified group.
9037
9105
  * @param {*} [options] Override http request option.
9038
9106
  * @throws {RequiredError}
9039
- * @memberof VirtualRobotSetupApi
9107
+ * @memberof VirtualControllerInputsOutputsApi
9040
9108
  */
9041
- listVirtualRobotTcps(cell: string, controller: string, motionGroup: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<RobotTcps, any>>;
9109
+ listVirtualRobotIODescriptions(cell: string, controller: string, ios?: Array<string>, direction?: IODirection, valueType?: IOValueType, group?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<IODescription[], any>>;
9042
9110
  /**
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
9111
+ * Sets a list of values of a virtual controller inputs/outputs.
9112
+ * @summary Set Input/Ouput Values
9045
9113
  * @param {string} cell Unique identifier addressing a cell in all API calls.
9046
9114
  * @param {string} controller Unique identifier to address a controller in the cell.
9047
- * @param {string} motionGroup The motion-group identifier.
9048
- * @param {CoordinateSystem} coordinateSystem
9115
+ * @param {Array<IOValue>} iOValue
9049
9116
  * @param {*} [options] Override http request option.
9050
9117
  * @throws {RequiredError}
9051
- * @memberof VirtualRobotSetupApi
9118
+ * @memberof VirtualControllerInputsOutputsApi
9052
9119
  */
9053
- setVirtualRobotMounting(cell: string, controller: string, motionGroup: string, coordinateSystem: CoordinateSystem, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CoordinateSystem, any>>;
9120
+ setIOValues(cell: string, controller: string, iOValue: Array<IOValue>, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
9054
9121
  }