@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.ts CHANGED
@@ -224,7 +224,7 @@ export interface App {
224
224
  'diagnosis_path'?: string;
225
225
  }
226
226
  /**
227
- * ## 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).
227
+ * ## 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).
228
228
  * @export
229
229
  * @enum {string}
230
230
  */
@@ -870,6 +870,37 @@ export interface ContainerStorage {
870
870
  */
871
871
  'capacity': string;
872
872
  }
873
+ /**
874
+ * The data type to describe a robot controller.
875
+ * @export
876
+ * @interface ControllerDescription
877
+ */
878
+ export interface ControllerDescription {
879
+ /**
880
+ *
881
+ * @type {Array<string>}
882
+ * @memberof ControllerDescription
883
+ */
884
+ 'connected_motion_groups': Array<string>;
885
+ /**
886
+ * Can this controller be moved through freedrive (true), or not (false).
887
+ * @type {boolean}
888
+ * @memberof ControllerDescription
889
+ */
890
+ 'supports_freedrive': boolean;
891
+ /**
892
+ * Can this controller be controlled with NOVA (true) or is it only possible to read data (false).
893
+ * @type {boolean}
894
+ * @memberof ControllerDescription
895
+ */
896
+ 'supports_control': boolean;
897
+ /**
898
+ * 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.
899
+ * @type {boolean}
900
+ * @memberof ControllerDescription
901
+ */
902
+ 'supports_safety_zones': boolean;
903
+ }
873
904
  /**
874
905
  * Defines a convex hull encapsulating a set of vertices.
875
906
  * @export
@@ -902,12 +933,6 @@ export type ConvexHullShapeTypeEnum = typeof ConvexHullShapeTypeEnum[keyof typeo
902
933
  * @interface CoordinateSystem
903
934
  */
904
935
  export interface CoordinateSystem {
905
- /**
906
- * Unique identifier of the coordinate system.
907
- * @type {string}
908
- * @memberof CoordinateSystem
909
- */
910
- 'coordinate_system': string;
911
936
  /**
912
937
  * Human readable name of this coordinate system.
913
938
  * @type {string}
@@ -938,22 +963,54 @@ export interface CoordinateSystem {
938
963
  * @memberof CoordinateSystem
939
964
  */
940
965
  'orientation_type'?: OrientationType;
966
+ /**
967
+ * Unique identifier of the coordinate system.
968
+ * @type {string}
969
+ * @memberof CoordinateSystem
970
+ */
971
+ 'coordinate_system': string;
941
972
  }
942
973
 
943
974
 
944
975
  /**
945
976
  *
946
977
  * @export
947
- * @interface CoordinateSystems
978
+ * @interface CoordinateSystemData
948
979
  */
949
- export interface CoordinateSystems {
980
+ export interface CoordinateSystemData {
981
+ /**
982
+ * Human readable name of this coordinate system.
983
+ * @type {string}
984
+ * @memberof CoordinateSystemData
985
+ */
986
+ 'name'?: string;
987
+ /**
988
+ * The identifier of the reference coordinate system. Empty if world is used.
989
+ * @type {string}
990
+ * @memberof CoordinateSystemData
991
+ */
992
+ 'reference_coordinate_system'?: string;
993
+ /**
994
+ * A three-dimensional vector [x, y, z] with double precision.
995
+ * @type {Array<number>}
996
+ * @memberof CoordinateSystemData
997
+ */
998
+ 'position'?: Array<number>;
999
+ /**
1000
+ * Describes an orientation in 3D space. A tree-to-four-dimensional vector [x, y, z, w] with double precision.
1001
+ * @type {Array<number>}
1002
+ * @memberof CoordinateSystemData
1003
+ */
1004
+ 'orientation'?: Array<number>;
950
1005
  /**
951
1006
  *
952
- * @type {Array<CoordinateSystem>}
953
- * @memberof CoordinateSystems
1007
+ * @type {OrientationType}
1008
+ * @memberof CoordinateSystemData
954
1009
  */
955
- 'coordinate_systems': Array<CoordinateSystem>;
1010
+ 'orientation_type'?: OrientationType;
956
1011
  }
1012
+
1013
+
957
1014
  /**
958
1015
  *
959
1016
  * @export
@@ -1165,41 +1222,23 @@ export interface ExternalJointStreamDatapoint {
1165
1222
  'motion_group': string;
1166
1223
  /**
1167
1224
  *
1168
- * @type {ExternalJointStreamDatapointValue}
1225
+ * @type {MotionGroupJoints}
1169
1226
  * @memberof ExternalJointStreamDatapoint
1170
1227
  */
1171
- 'value': ExternalJointStreamDatapointValue;
1228
+ 'value': MotionGroupJoints;
1172
1229
  }
1173
1230
  /**
1174
- * The joint-values of the external joint stream datapoint.
1231
+ *
1175
1232
  * @export
1176
- * @interface ExternalJointStreamDatapointValue
1233
+ * @interface ExternalJointStreamRequest
1177
1234
  */
1178
- export interface ExternalJointStreamDatapointValue {
1179
- /**
1180
- * The joint positions of the robot.
1181
- * @type {Array<number>}
1182
- * @memberof ExternalJointStreamDatapointValue
1183
- */
1184
- 'positions': Array<number>;
1185
- /**
1186
- * The joint velocities of the robot.
1187
- * @type {Array<number>}
1188
- * @memberof ExternalJointStreamDatapointValue
1189
- */
1190
- 'velocities': Array<number>;
1191
- /**
1192
- * The joint accelerations of the robot.
1193
- * @type {Array<number>}
1194
- * @memberof ExternalJointStreamDatapointValue
1195
- */
1196
- 'accelerations': Array<number>;
1235
+ export interface ExternalJointStreamRequest {
1197
1236
  /**
1198
- * The joint torques of the robot.
1199
- * @type {Array<number>}
1200
- * @memberof ExternalJointStreamDatapointValue
1237
+ *
1238
+ * @type {Array<ExternalJointStreamDatapoint>}
1239
+ * @memberof ExternalJointStreamRequest
1201
1240
  */
1202
- 'torques': Array<number>;
1241
+ 'states': Array<ExternalJointStreamDatapoint>;
1203
1242
  }
1204
1243
  /**
1205
1244
  * The configuration of a physical FANUC robot controller has to contain IP address of the controller.
@@ -2417,19 +2456,6 @@ export interface LimitsOverride {
2417
2456
  */
2418
2457
  'tcp_orientation_acceleration_limit'?: number;
2419
2458
  }
2420
- /**
2421
- *
2422
- * @export
2423
- * @interface ListCoordinateSystemsResponse
2424
- */
2425
- export interface ListCoordinateSystemsResponse {
2426
- /**
2427
- *
2428
- * @type {Array<CoordinateSystem>}
2429
- * @memberof ListCoordinateSystemsResponse
2430
- */
2431
- 'coordinatesystems'?: Array<CoordinateSystem>;
2432
- }
2433
2459
  /**
2434
2460
  *
2435
2461
  * @export
@@ -2517,21 +2543,6 @@ export type MotionCommandBlending = BlendingAuto | BlendingPosition;
2517
2543
  */
2518
2544
  export type MotionCommandPath = PathCartesianPTP | PathCircle | PathCubicSpline | PathJointPTP | PathLine;
2519
2545
 
2520
- /**
2521
- *
2522
- * @export
2523
- * @interface MotionGroupBehaviorGetter
2524
- */
2525
- export interface MotionGroupBehaviorGetter {
2526
- /**
2527
- *
2528
- * @type {Behavior}
2529
- * @memberof MotionGroupBehaviorGetter
2530
- */
2531
- 'behavior': Behavior;
2532
- }
2533
-
2534
-
2535
2546
  /**
2536
2547
  * The configuration of a motion-group used for motion planning.
2537
2548
  * @export
@@ -2543,7 +2554,7 @@ export interface MotionGroupDescription {
2543
2554
  * @type {string}
2544
2555
  * @memberof MotionGroupDescription
2545
2556
  */
2546
- 'motion_group_type': string;
2557
+ 'motion_group_model': string;
2547
2558
  /**
2548
2559
  * The offset from the world frame to the motion group base.
2549
2560
  * @type {Pose}
@@ -2624,19 +2635,6 @@ export interface MotionGroupInfo {
2624
2635
  */
2625
2636
  'dof': number;
2626
2637
  }
2627
- /**
2628
- *
2629
- * @export
2630
- * @interface MotionGroupInfos
2631
- */
2632
- export interface MotionGroupInfos {
2633
- /**
2634
- *
2635
- * @type {Array<MotionGroupInfo>}
2636
- * @memberof MotionGroupInfos
2637
- */
2638
- 'motion_groups': Array<MotionGroupInfo>;
2639
- }
2640
2638
  /**
2641
2639
  * Ensure to provide one value for each joint. See [getMotionGroups](getMotionGroups) for the number of joints. Everything but positions is optional.
2642
2640
  * @export
@@ -2799,7 +2797,7 @@ export interface MovementErrorResponse {
2799
2797
  }
2800
2798
 
2801
2799
  export const MovementErrorResponseKindEnum = {
2802
- Error: 'ERROR'
2800
+ MotionError: 'MOTION_ERROR'
2803
2801
  } as const;
2804
2802
 
2805
2803
  export type MovementErrorResponseKindEnum = typeof MovementErrorResponseKindEnum[keyof typeof MovementErrorResponseKindEnum];
@@ -3740,12 +3738,6 @@ export type RobotSystemMode = typeof RobotSystemMode[keyof typeof RobotSystemMod
3740
3738
  * @interface RobotTcp
3741
3739
  */
3742
3740
  export interface RobotTcp {
3743
- /**
3744
- * Identifier of this tcp.
3745
- * @type {string}
3746
- * @memberof RobotTcp
3747
- */
3748
- 'id': string;
3749
3741
  /**
3750
3742
  * A readable and changeable name for frontend visualization.
3751
3743
  * @type {string}
@@ -3770,22 +3762,48 @@ export interface RobotTcp {
3770
3762
  * @memberof RobotTcp
3771
3763
  */
3772
3764
  'orientation_type'?: OrientationType;
3765
+ /**
3766
+ * Identifier of this tcp.
3767
+ * @type {string}
3768
+ * @memberof RobotTcp
3769
+ */
3770
+ 'id': string;
3773
3771
  }
3774
3772
 
3775
3773
 
3776
3774
  /**
3777
3775
  *
3778
3776
  * @export
3779
- * @interface RobotTcps
3777
+ * @interface RobotTcpData
3780
3778
  */
3781
- export interface RobotTcps {
3779
+ export interface RobotTcpData {
3780
+ /**
3781
+ * A readable and changeable name for frontend visualization.
3782
+ * @type {string}
3783
+ * @memberof RobotTcpData
3784
+ */
3785
+ 'name'?: string;
3786
+ /**
3787
+ * A three-dimensional vector [x, y, z] with double precision.
3788
+ * @type {Array<number>}
3789
+ * @memberof RobotTcpData
3790
+ */
3791
+ 'position': Array<number>;
3792
+ /**
3793
+ * Describes an orientation in 3D space. A tree-to-four-dimensional vector [x, y, z, w] with double precision.
3794
+ * @type {Array<number>}
3795
+ * @memberof RobotTcpData
3796
+ */
3797
+ 'orientation'?: Array<number>;
3782
3798
  /**
3783
3799
  *
3784
- * @type {Array<RobotTcp>}
3785
- * @memberof RobotTcps
3800
+ * @type {OrientationType}
3801
+ * @memberof RobotTcpData
3786
3802
  */
3787
- 'tcps': Array<RobotTcp>;
3803
+ 'orientation_type'?: OrientationType;
3788
3804
  }
3805
+
3806
+
3789
3807
  /**
3790
3808
  *
3791
3809
  * @export
@@ -6110,6 +6128,52 @@ export const ControllerApiAxiosParamCreator = function (configuration?: Configur
6110
6128
 
6111
6129
 
6112
6130
 
6131
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
6132
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
6133
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
6134
+
6135
+ return {
6136
+ url: toPathString(localVarUrlObj),
6137
+ options: localVarRequestOptions,
6138
+ };
6139
+ },
6140
+ /**
6141
+ * 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.
6142
+ * @summary Description
6143
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
6144
+ * @param {string} controller Unique identifier to address a controller in the cell.
6145
+ * @param {*} [options] Override http request option.
6146
+ * @throws {RequiredError}
6147
+ */
6148
+ getControllerDescription: async (cell: string, controller: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
6149
+ // verify required parameter 'cell' is not null or undefined
6150
+ assertParamExists('getControllerDescription', 'cell', cell)
6151
+ // verify required parameter 'controller' is not null or undefined
6152
+ assertParamExists('getControllerDescription', 'controller', controller)
6153
+ const localVarPath = `/cells/{cell}/controllers/{controller}/description`
6154
+ .replace(`{${"cell"}}`, encodeURIComponent(String(cell)))
6155
+ .replace(`{${"controller"}}`, encodeURIComponent(String(controller)));
6156
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
6157
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
6158
+ let baseOptions;
6159
+ if (configuration) {
6160
+ baseOptions = configuration.baseOptions;
6161
+ }
6162
+
6163
+ const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
6164
+ const localVarHeaderParameter = {} as any;
6165
+ const localVarQueryParameter = {} as any;
6166
+
6167
+ // authentication BasicAuth required
6168
+ // http basic authentication required
6169
+ setBasicAuthToObject(localVarRequestOptions, configuration)
6170
+
6171
+ // authentication BearerAuth required
6172
+ // http bearer authentication required
6173
+ await setBearerAuthToObject(localVarHeaderParameter, configuration)
6174
+
6175
+
6176
+
6113
6177
  setSearchParams(localVarUrlObj, localVarQueryParameter);
6114
6178
  let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
6115
6179
  localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
@@ -6717,6 +6781,20 @@ export const ControllerApiFp = function(configuration?: Configuration) {
6717
6781
  const localVarOperationServerBasePath = operationServerMap['ControllerApi.deleteRobotController']?.[localVarOperationServerIndex]?.url;
6718
6782
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
6719
6783
  },
6784
+ /**
6785
+ * 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.
6786
+ * @summary Description
6787
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
6788
+ * @param {string} controller Unique identifier to address a controller in the cell.
6789
+ * @param {*} [options] Override http request option.
6790
+ * @throws {RequiredError}
6791
+ */
6792
+ async getControllerDescription(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ControllerDescription>> {
6793
+ const localVarAxiosArgs = await localVarAxiosParamCreator.getControllerDescription(cell, controller, options);
6794
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
6795
+ const localVarOperationServerBasePath = operationServerMap['ControllerApi.getControllerDescription']?.[localVarOperationServerIndex]?.url;
6796
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
6797
+ },
6720
6798
  /**
6721
6799
  * 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.
6722
6800
  * @summary Coordinate System
@@ -6798,7 +6876,7 @@ export const ControllerApiFp = function(configuration?: Configuration) {
6798
6876
  * @param {*} [options] Override http request option.
6799
6877
  * @throws {RequiredError}
6800
6878
  */
6801
- async listCoordinateSystems(cell: string, controller: string, orientationType?: OrientationType, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListCoordinateSystemsResponse>> {
6879
+ async listCoordinateSystems(cell: string, controller: string, orientationType?: OrientationType, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<CoordinateSystem>>> {
6802
6880
  const localVarAxiosArgs = await localVarAxiosParamCreator.listCoordinateSystems(cell, controller, orientationType, options);
6803
6881
  const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
6804
6882
  const localVarOperationServerBasePath = operationServerMap['ControllerApi.listCoordinateSystems']?.[localVarOperationServerIndex]?.url;
@@ -6923,6 +7001,17 @@ export const ControllerApiFactory = function (configuration?: Configuration, bas
6923
7001
  deleteRobotController(cell: string, controller: string, completionTimeout?: number, options?: RawAxiosRequestConfig): AxiosPromise<void> {
6924
7002
  return localVarFp.deleteRobotController(cell, controller, completionTimeout, options).then((request) => request(axios, basePath));
6925
7003
  },
7004
+ /**
7005
+ * 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.
7006
+ * @summary Description
7007
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
7008
+ * @param {string} controller Unique identifier to address a controller in the cell.
7009
+ * @param {*} [options] Override http request option.
7010
+ * @throws {RequiredError}
7011
+ */
7012
+ getControllerDescription(cell: string, controller: string, options?: RawAxiosRequestConfig): AxiosPromise<ControllerDescription> {
7013
+ return localVarFp.getControllerDescription(cell, controller, options).then((request) => request(axios, basePath));
7014
+ },
6926
7015
  /**
6927
7016
  * 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.
6928
7017
  * @summary Coordinate System
@@ -6989,7 +7078,7 @@ export const ControllerApiFactory = function (configuration?: Configuration, bas
6989
7078
  * @param {*} [options] Override http request option.
6990
7079
  * @throws {RequiredError}
6991
7080
  */
6992
- listCoordinateSystems(cell: string, controller: string, orientationType?: OrientationType, options?: RawAxiosRequestConfig): AxiosPromise<ListCoordinateSystemsResponse> {
7081
+ listCoordinateSystems(cell: string, controller: string, orientationType?: OrientationType, options?: RawAxiosRequestConfig): AxiosPromise<Array<CoordinateSystem>> {
6993
7082
  return localVarFp.listCoordinateSystems(cell, controller, orientationType, options).then((request) => request(axios, basePath));
6994
7083
  },
6995
7084
  /**
@@ -7102,6 +7191,19 @@ export class ControllerApi extends BaseAPI {
7102
7191
  return ControllerApiFp(this.configuration).deleteRobotController(cell, controller, completionTimeout, options).then((request) => request(this.axios, this.basePath));
7103
7192
  }
7104
7193
 
7194
+ /**
7195
+ * 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.
7196
+ * @summary Description
7197
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
7198
+ * @param {string} controller Unique identifier to address a controller in the cell.
7199
+ * @param {*} [options] Override http request option.
7200
+ * @throws {RequiredError}
7201
+ * @memberof ControllerApi
7202
+ */
7203
+ public getControllerDescription(cell: string, controller: string, options?: RawAxiosRequestConfig) {
7204
+ return ControllerApiFp(this.configuration).getControllerDescription(cell, controller, options).then((request) => request(this.axios, this.basePath));
7205
+ }
7206
+
7105
7207
  /**
7106
7208
  * 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.
7107
7209
  * @summary Coordinate System
@@ -7790,17 +7892,21 @@ export const JoggingApiAxiosParamCreator = function (configuration?: Configurati
7790
7892
  * <!-- 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.
7791
7893
  * @summary Execute Jogging
7792
7894
  * @param {string} cell Unique identifier addressing a cell in all API calls.
7895
+ * @param {string} controller Unique identifier to address a controller in the cell.
7793
7896
  * @param {ExecuteJoggingRequest} executeJoggingRequest
7794
7897
  * @param {*} [options] Override http request option.
7795
7898
  * @throws {RequiredError}
7796
7899
  */
7797
- executeJogging: async (cell: string, executeJoggingRequest: ExecuteJoggingRequest, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
7900
+ executeJogging: async (cell: string, controller: string, executeJoggingRequest: ExecuteJoggingRequest, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
7798
7901
  // verify required parameter 'cell' is not null or undefined
7799
7902
  assertParamExists('executeJogging', 'cell', cell)
7903
+ // verify required parameter 'controller' is not null or undefined
7904
+ assertParamExists('executeJogging', 'controller', controller)
7800
7905
  // verify required parameter 'executeJoggingRequest' is not null or undefined
7801
7906
  assertParamExists('executeJogging', 'executeJoggingRequest', executeJoggingRequest)
7802
- const localVarPath = `/cells/{cell}/execution/jogging`
7803
- .replace(`{${"cell"}}`, encodeURIComponent(String(cell)));
7907
+ const localVarPath = `/cells/{cell}/controllers/{controller}/execution/jogging`
7908
+ .replace(`{${"cell"}}`, encodeURIComponent(String(cell)))
7909
+ .replace(`{${"controller"}}`, encodeURIComponent(String(controller)));
7804
7910
  // use dummy base URL string because the URL constructor only accepts absolute URLs.
7805
7911
  const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
7806
7912
  let baseOptions;
@@ -7848,12 +7954,13 @@ export const JoggingApiFp = function(configuration?: Configuration) {
7848
7954
  * <!-- 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.
7849
7955
  * @summary Execute Jogging
7850
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.
7851
7958
  * @param {ExecuteJoggingRequest} executeJoggingRequest
7852
7959
  * @param {*} [options] Override http request option.
7853
7960
  * @throws {RequiredError}
7854
7961
  */
7855
- async executeJogging(cell: string, executeJoggingRequest: ExecuteJoggingRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ExecuteJoggingResponse>> {
7856
- const localVarAxiosArgs = await localVarAxiosParamCreator.executeJogging(cell, executeJoggingRequest, options);
7962
+ async executeJogging(cell: string, controller: string, executeJoggingRequest: ExecuteJoggingRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ExecuteJoggingResponse>> {
7963
+ const localVarAxiosArgs = await localVarAxiosParamCreator.executeJogging(cell, controller, executeJoggingRequest, options);
7857
7964
  const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
7858
7965
  const localVarOperationServerBasePath = operationServerMap['JoggingApi.executeJogging']?.[localVarOperationServerIndex]?.url;
7859
7966
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
@@ -7872,12 +7979,13 @@ export const JoggingApiFactory = function (configuration?: Configuration, basePa
7872
7979
  * <!-- 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.
7873
7980
  * @summary Execute Jogging
7874
7981
  * @param {string} cell Unique identifier addressing a cell in all API calls.
7982
+ * @param {string} controller Unique identifier to address a controller in the cell.
7875
7983
  * @param {ExecuteJoggingRequest} executeJoggingRequest
7876
7984
  * @param {*} [options] Override http request option.
7877
7985
  * @throws {RequiredError}
7878
7986
  */
7879
- executeJogging(cell: string, executeJoggingRequest: ExecuteJoggingRequest, options?: RawAxiosRequestConfig): AxiosPromise<ExecuteJoggingResponse> {
7880
- return localVarFp.executeJogging(cell, executeJoggingRequest, options).then((request) => request(axios, basePath));
7987
+ executeJogging(cell: string, controller: string, executeJoggingRequest: ExecuteJoggingRequest, options?: RawAxiosRequestConfig): AxiosPromise<ExecuteJoggingResponse> {
7988
+ return localVarFp.executeJogging(cell, controller, executeJoggingRequest, options).then((request) => request(axios, basePath));
7881
7989
  },
7882
7990
  };
7883
7991
  };
@@ -7893,13 +8001,14 @@ export class JoggingApi extends BaseAPI {
7893
8001
  * <!-- 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.
7894
8002
  * @summary Execute Jogging
7895
8003
  * @param {string} cell Unique identifier addressing a cell in all API calls.
8004
+ * @param {string} controller Unique identifier to address a controller in the cell.
7896
8005
  * @param {ExecuteJoggingRequest} executeJoggingRequest
7897
8006
  * @param {*} [options] Override http request option.
7898
8007
  * @throws {RequiredError}
7899
8008
  * @memberof JoggingApi
7900
8009
  */
7901
- public executeJogging(cell: string, executeJoggingRequest: ExecuteJoggingRequest, options?: RawAxiosRequestConfig) {
7902
- return JoggingApiFp(this.configuration).executeJogging(cell, executeJoggingRequest, options).then((request) => request(this.axios, this.basePath));
8010
+ public executeJogging(cell: string, controller: string, executeJoggingRequest: ExecuteJoggingRequest, options?: RawAxiosRequestConfig) {
8011
+ return JoggingApiFp(this.configuration).executeJogging(cell, controller, executeJoggingRequest, options).then((request) => request(this.axios, this.basePath));
7903
8012
  }
7904
8013
  }
7905
8014
 
@@ -8366,18 +8475,22 @@ export const MotionGroupApiAxiosParamCreator = function (configuration?: Configu
8366
8475
  * Returns the current state of the selected motion group including the current joint position, velocity, pose, and more.
8367
8476
  * @summary State
8368
8477
  * @param {string} cell Unique identifier addressing a cell in all API calls.
8478
+ * @param {string} controller Unique identifier to address a controller in the cell.
8369
8479
  * @param {string} motionGroup The motion-group identifier.
8370
8480
  * @param {string} [responseCoordinateSystem] Unique identifier addressing a coordinate system to which the responses should be converted. If not set, world coordinate system is used.
8371
8481
  * @param {*} [options] Override http request option.
8372
8482
  * @throws {RequiredError}
8373
8483
  */
8374
- getCurrentMotionGroupState: async (cell: string, motionGroup: string, responseCoordinateSystem?: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
8484
+ getCurrentMotionGroupState: async (cell: string, controller: string, motionGroup: string, responseCoordinateSystem?: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
8375
8485
  // verify required parameter 'cell' is not null or undefined
8376
8486
  assertParamExists('getCurrentMotionGroupState', 'cell', cell)
8487
+ // verify required parameter 'controller' is not null or undefined
8488
+ assertParamExists('getCurrentMotionGroupState', 'controller', controller)
8377
8489
  // verify required parameter 'motionGroup' is not null or undefined
8378
8490
  assertParamExists('getCurrentMotionGroupState', 'motionGroup', motionGroup)
8379
- const localVarPath = `/cells/{cell}/motion-groups/{motion-group}/state`
8491
+ const localVarPath = `/cells/{cell}/controllers/{controller}/motion-groups/{motion-group}/state`
8380
8492
  .replace(`{${"cell"}}`, encodeURIComponent(String(cell)))
8493
+ .replace(`{${"controller"}}`, encodeURIComponent(String(controller)))
8381
8494
  .replace(`{${"motion-group"}}`, encodeURIComponent(String(motionGroup)));
8382
8495
  // use dummy base URL string because the URL constructor only accepts absolute URLs.
8383
8496
  const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
@@ -8417,17 +8530,21 @@ export const MotionGroupApiAxiosParamCreator = function (configuration?: Configu
8417
8530
  * 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.
8418
8531
  * @summary Description
8419
8532
  * @param {string} cell Unique identifier addressing a cell in all API calls.
8533
+ * @param {string} controller Unique identifier to address a controller in the cell.
8420
8534
  * @param {string} motionGroup The motion-group identifier.
8421
8535
  * @param {*} [options] Override http request option.
8422
8536
  * @throws {RequiredError}
8423
8537
  */
8424
- getMotionGroupDescription: async (cell: string, motionGroup: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
8538
+ getMotionGroupDescription: async (cell: string, controller: string, motionGroup: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
8425
8539
  // verify required parameter 'cell' is not null or undefined
8426
8540
  assertParamExists('getMotionGroupDescription', 'cell', cell)
8541
+ // verify required parameter 'controller' is not null or undefined
8542
+ assertParamExists('getMotionGroupDescription', 'controller', controller)
8427
8543
  // verify required parameter 'motionGroup' is not null or undefined
8428
8544
  assertParamExists('getMotionGroupDescription', 'motionGroup', motionGroup)
8429
- const localVarPath = `/cells/{cell}/motion-groups/{motion-group}/description`
8545
+ const localVarPath = `/cells/{cell}/controllers/{controller}/motion-groups/{motion-group}/description`
8430
8546
  .replace(`{${"cell"}}`, encodeURIComponent(String(cell)))
8547
+ .replace(`{${"controller"}}`, encodeURIComponent(String(controller)))
8431
8548
  .replace(`{${"motion-group"}}`, encodeURIComponent(String(motionGroup)));
8432
8549
  // use dummy base URL string because the URL constructor only accepts absolute URLs.
8433
8550
  const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
@@ -8463,19 +8580,23 @@ export const MotionGroupApiAxiosParamCreator = function (configuration?: Configu
8463
8580
  * <!-- theme: danger --> > Websocket endpoint Receive updates of the motion group state. The stream will be closed from the server if the controller is disconnected.
8464
8581
  * @summary Stream State
8465
8582
  * @param {string} cell Unique identifier addressing a cell in all API calls.
8583
+ * @param {string} controller Unique identifier to address a controller in the cell.
8466
8584
  * @param {string} motionGroup The motion-group identifier.
8467
8585
  * @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.
8468
8586
  * @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.
8469
8587
  * @param {*} [options] Override http request option.
8470
8588
  * @throws {RequiredError}
8471
8589
  */
8472
- streamMotionGroupState: async (cell: string, motionGroup: string, responseRate?: number, responseCoordinateSystem?: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
8590
+ streamMotionGroupState: async (cell: string, controller: string, motionGroup: string, responseRate?: number, responseCoordinateSystem?: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
8473
8591
  // verify required parameter 'cell' is not null or undefined
8474
8592
  assertParamExists('streamMotionGroupState', 'cell', cell)
8593
+ // verify required parameter 'controller' is not null or undefined
8594
+ assertParamExists('streamMotionGroupState', 'controller', controller)
8475
8595
  // verify required parameter 'motionGroup' is not null or undefined
8476
8596
  assertParamExists('streamMotionGroupState', 'motionGroup', motionGroup)
8477
- const localVarPath = `/cells/{cell}/motion-groups/{motion-group}/state-stream`
8597
+ const localVarPath = `/cells/{cell}/controllers/{controller}/motion-groups/{motion-group}/state-stream`
8478
8598
  .replace(`{${"cell"}}`, encodeURIComponent(String(cell)))
8599
+ .replace(`{${"controller"}}`, encodeURIComponent(String(controller)))
8479
8600
  .replace(`{${"motion-group"}}`, encodeURIComponent(String(motionGroup)));
8480
8601
  // use dummy base URL string because the URL constructor only accepts absolute URLs.
8481
8602
  const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
@@ -8529,13 +8650,14 @@ export const MotionGroupApiFp = function(configuration?: Configuration) {
8529
8650
  * Returns the current state of the selected motion group including the current joint position, velocity, pose, and more.
8530
8651
  * @summary State
8531
8652
  * @param {string} cell Unique identifier addressing a cell in all API calls.
8653
+ * @param {string} controller Unique identifier to address a controller in the cell.
8532
8654
  * @param {string} motionGroup The motion-group identifier.
8533
8655
  * @param {string} [responseCoordinateSystem] Unique identifier addressing a coordinate system to which the responses should be converted. If not set, world coordinate system is used.
8534
8656
  * @param {*} [options] Override http request option.
8535
8657
  * @throws {RequiredError}
8536
8658
  */
8537
- async getCurrentMotionGroupState(cell: string, motionGroup: string, responseCoordinateSystem?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<MotionGroupState>> {
8538
- const localVarAxiosArgs = await localVarAxiosParamCreator.getCurrentMotionGroupState(cell, motionGroup, responseCoordinateSystem, options);
8659
+ async getCurrentMotionGroupState(cell: string, controller: string, motionGroup: string, responseCoordinateSystem?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<MotionGroupState>> {
8660
+ const localVarAxiosArgs = await localVarAxiosParamCreator.getCurrentMotionGroupState(cell, controller, motionGroup, responseCoordinateSystem, options);
8539
8661
  const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
8540
8662
  const localVarOperationServerBasePath = operationServerMap['MotionGroupApi.getCurrentMotionGroupState']?.[localVarOperationServerIndex]?.url;
8541
8663
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
@@ -8544,12 +8666,13 @@ export const MotionGroupApiFp = function(configuration?: Configuration) {
8544
8666
  * 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.
8545
8667
  * @summary Description
8546
8668
  * @param {string} cell Unique identifier addressing a cell in all API calls.
8669
+ * @param {string} controller Unique identifier to address a controller in the cell.
8547
8670
  * @param {string} motionGroup The motion-group identifier.
8548
8671
  * @param {*} [options] Override http request option.
8549
8672
  * @throws {RequiredError}
8550
8673
  */
8551
- async getMotionGroupDescription(cell: string, motionGroup: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<MotionGroupDescription>> {
8552
- const localVarAxiosArgs = await localVarAxiosParamCreator.getMotionGroupDescription(cell, motionGroup, options);
8674
+ async getMotionGroupDescription(cell: string, controller: string, motionGroup: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<MotionGroupDescription>> {
8675
+ const localVarAxiosArgs = await localVarAxiosParamCreator.getMotionGroupDescription(cell, controller, motionGroup, options);
8553
8676
  const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
8554
8677
  const localVarOperationServerBasePath = operationServerMap['MotionGroupApi.getMotionGroupDescription']?.[localVarOperationServerIndex]?.url;
8555
8678
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
@@ -8558,14 +8681,15 @@ export const MotionGroupApiFp = function(configuration?: Configuration) {
8558
8681
  * <!-- theme: danger --> > Websocket endpoint Receive updates of the motion group state. The stream will be closed from the server if the controller is disconnected.
8559
8682
  * @summary Stream State
8560
8683
  * @param {string} cell Unique identifier addressing a cell in all API calls.
8684
+ * @param {string} controller Unique identifier to address a controller in the cell.
8561
8685
  * @param {string} motionGroup The motion-group identifier.
8562
8686
  * @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.
8563
8687
  * @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.
8564
8688
  * @param {*} [options] Override http request option.
8565
8689
  * @throws {RequiredError}
8566
8690
  */
8567
- async streamMotionGroupState(cell: string, motionGroup: string, responseRate?: number, responseCoordinateSystem?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<MotionGroupState>> {
8568
- const localVarAxiosArgs = await localVarAxiosParamCreator.streamMotionGroupState(cell, motionGroup, responseRate, responseCoordinateSystem, options);
8691
+ async streamMotionGroupState(cell: string, controller: string, motionGroup: string, responseRate?: number, responseCoordinateSystem?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<MotionGroupState>> {
8692
+ const localVarAxiosArgs = await localVarAxiosParamCreator.streamMotionGroupState(cell, controller, motionGroup, responseRate, responseCoordinateSystem, options);
8569
8693
  const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
8570
8694
  const localVarOperationServerBasePath = operationServerMap['MotionGroupApi.streamMotionGroupState']?.[localVarOperationServerIndex]?.url;
8571
8695
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
@@ -8584,37 +8708,40 @@ export const MotionGroupApiFactory = function (configuration?: Configuration, ba
8584
8708
  * Returns the current state of the selected motion group including the current joint position, velocity, pose, and more.
8585
8709
  * @summary State
8586
8710
  * @param {string} cell Unique identifier addressing a cell in all API calls.
8711
+ * @param {string} controller Unique identifier to address a controller in the cell.
8587
8712
  * @param {string} motionGroup The motion-group identifier.
8588
8713
  * @param {string} [responseCoordinateSystem] Unique identifier addressing a coordinate system to which the responses should be converted. If not set, world coordinate system is used.
8589
8714
  * @param {*} [options] Override http request option.
8590
8715
  * @throws {RequiredError}
8591
8716
  */
8592
- getCurrentMotionGroupState(cell: string, motionGroup: string, responseCoordinateSystem?: string, options?: RawAxiosRequestConfig): AxiosPromise<MotionGroupState> {
8593
- return localVarFp.getCurrentMotionGroupState(cell, motionGroup, responseCoordinateSystem, options).then((request) => request(axios, basePath));
8717
+ getCurrentMotionGroupState(cell: string, controller: string, motionGroup: string, responseCoordinateSystem?: string, options?: RawAxiosRequestConfig): AxiosPromise<MotionGroupState> {
8718
+ return localVarFp.getCurrentMotionGroupState(cell, controller, motionGroup, responseCoordinateSystem, options).then((request) => request(axios, basePath));
8594
8719
  },
8595
8720
  /**
8596
8721
  * 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.
8597
8722
  * @summary Description
8598
8723
  * @param {string} cell Unique identifier addressing a cell in all API calls.
8724
+ * @param {string} controller Unique identifier to address a controller in the cell.
8599
8725
  * @param {string} motionGroup The motion-group identifier.
8600
8726
  * @param {*} [options] Override http request option.
8601
8727
  * @throws {RequiredError}
8602
8728
  */
8603
- getMotionGroupDescription(cell: string, motionGroup: string, options?: RawAxiosRequestConfig): AxiosPromise<MotionGroupDescription> {
8604
- return localVarFp.getMotionGroupDescription(cell, motionGroup, options).then((request) => request(axios, basePath));
8729
+ getMotionGroupDescription(cell: string, controller: string, motionGroup: string, options?: RawAxiosRequestConfig): AxiosPromise<MotionGroupDescription> {
8730
+ return localVarFp.getMotionGroupDescription(cell, controller, motionGroup, options).then((request) => request(axios, basePath));
8605
8731
  },
8606
8732
  /**
8607
8733
  * <!-- theme: danger --> > Websocket endpoint Receive updates of the motion group state. The stream will be closed from the server if the controller is disconnected.
8608
8734
  * @summary Stream State
8609
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.
8610
8737
  * @param {string} motionGroup The motion-group identifier.
8611
8738
  * @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.
8612
8739
  * @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.
8613
8740
  * @param {*} [options] Override http request option.
8614
8741
  * @throws {RequiredError}
8615
8742
  */
8616
- streamMotionGroupState(cell: string, motionGroup: string, responseRate?: number, responseCoordinateSystem?: string, options?: RawAxiosRequestConfig): AxiosPromise<MotionGroupState> {
8617
- return localVarFp.streamMotionGroupState(cell, motionGroup, responseRate, responseCoordinateSystem, options).then((request) => request(axios, basePath));
8743
+ streamMotionGroupState(cell: string, controller: string, motionGroup: string, responseRate?: number, responseCoordinateSystem?: string, options?: RawAxiosRequestConfig): AxiosPromise<MotionGroupState> {
8744
+ return localVarFp.streamMotionGroupState(cell, controller, motionGroup, responseRate, responseCoordinateSystem, options).then((request) => request(axios, basePath));
8618
8745
  },
8619
8746
  };
8620
8747
  };
@@ -8630,33 +8757,36 @@ export class MotionGroupApi extends BaseAPI {
8630
8757
  * Returns the current state of the selected motion group including the current joint position, velocity, pose, and more.
8631
8758
  * @summary State
8632
8759
  * @param {string} cell Unique identifier addressing a cell in all API calls.
8760
+ * @param {string} controller Unique identifier to address a controller in the cell.
8633
8761
  * @param {string} motionGroup The motion-group identifier.
8634
8762
  * @param {string} [responseCoordinateSystem] Unique identifier addressing a coordinate system to which the responses should be converted. If not set, world coordinate system is used.
8635
8763
  * @param {*} [options] Override http request option.
8636
8764
  * @throws {RequiredError}
8637
8765
  * @memberof MotionGroupApi
8638
8766
  */
8639
- public getCurrentMotionGroupState(cell: string, motionGroup: string, responseCoordinateSystem?: string, options?: RawAxiosRequestConfig) {
8640
- return MotionGroupApiFp(this.configuration).getCurrentMotionGroupState(cell, motionGroup, responseCoordinateSystem, options).then((request) => request(this.axios, this.basePath));
8767
+ public getCurrentMotionGroupState(cell: string, controller: string, motionGroup: string, responseCoordinateSystem?: string, options?: RawAxiosRequestConfig) {
8768
+ return MotionGroupApiFp(this.configuration).getCurrentMotionGroupState(cell, controller, motionGroup, responseCoordinateSystem, options).then((request) => request(this.axios, this.basePath));
8641
8769
  }
8642
8770
 
8643
8771
  /**
8644
8772
  * 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.
8645
8773
  * @summary Description
8646
8774
  * @param {string} cell Unique identifier addressing a cell in all API calls.
8775
+ * @param {string} controller Unique identifier to address a controller in the cell.
8647
8776
  * @param {string} motionGroup The motion-group identifier.
8648
8777
  * @param {*} [options] Override http request option.
8649
8778
  * @throws {RequiredError}
8650
8779
  * @memberof MotionGroupApi
8651
8780
  */
8652
- public getMotionGroupDescription(cell: string, motionGroup: string, options?: RawAxiosRequestConfig) {
8653
- return MotionGroupApiFp(this.configuration).getMotionGroupDescription(cell, motionGroup, options).then((request) => request(this.axios, this.basePath));
8781
+ public getMotionGroupDescription(cell: string, controller: string, motionGroup: string, options?: RawAxiosRequestConfig) {
8782
+ return MotionGroupApiFp(this.configuration).getMotionGroupDescription(cell, controller, motionGroup, options).then((request) => request(this.axios, this.basePath));
8654
8783
  }
8655
8784
 
8656
8785
  /**
8657
8786
  * <!-- theme: danger --> > Websocket endpoint Receive updates of the motion group state. The stream will be closed from the server if the controller is disconnected.
8658
8787
  * @summary Stream State
8659
8788
  * @param {string} cell Unique identifier addressing a cell in all API calls.
8789
+ * @param {string} controller Unique identifier to address a controller in the cell.
8660
8790
  * @param {string} motionGroup The motion-group identifier.
8661
8791
  * @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.
8662
8792
  * @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.
@@ -8664,8 +8794,8 @@ export class MotionGroupApi extends BaseAPI {
8664
8794
  * @throws {RequiredError}
8665
8795
  * @memberof MotionGroupApi
8666
8796
  */
8667
- public streamMotionGroupState(cell: string, motionGroup: string, responseRate?: number, responseCoordinateSystem?: string, options?: RawAxiosRequestConfig) {
8668
- return MotionGroupApiFp(this.configuration).streamMotionGroupState(cell, motionGroup, responseRate, responseCoordinateSystem, options).then((request) => request(this.axios, this.basePath));
8797
+ public streamMotionGroupState(cell: string, controller: string, motionGroup: string, responseRate?: number, responseCoordinateSystem?: string, options?: RawAxiosRequestConfig) {
8798
+ return MotionGroupApiFp(this.configuration).streamMotionGroupState(cell, controller, motionGroup, responseRate, responseCoordinateSystem, options).then((request) => request(this.axios, this.basePath));
8669
8799
  }
8670
8800
  }
8671
8801
 
@@ -11596,17 +11726,21 @@ export const TrajectoryCachingApiAxiosParamCreator = function (configuration?: C
11596
11726
  * <!-- 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.
11597
11727
  * @summary Add Trajectory
11598
11728
  * @param {string} cell Unique identifier addressing a cell in all API calls.
11729
+ * @param {string} controller Unique identifier to address a controller in the cell.
11599
11730
  * @param {AddTrajectoryRequest} addTrajectoryRequest
11600
11731
  * @param {*} [options] Override http request option.
11601
11732
  * @throws {RequiredError}
11602
11733
  */
11603
- addTrajectory: async (cell: string, addTrajectoryRequest: AddTrajectoryRequest, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
11734
+ addTrajectory: async (cell: string, controller: string, addTrajectoryRequest: AddTrajectoryRequest, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
11604
11735
  // verify required parameter 'cell' is not null or undefined
11605
11736
  assertParamExists('addTrajectory', 'cell', cell)
11737
+ // verify required parameter 'controller' is not null or undefined
11738
+ assertParamExists('addTrajectory', 'controller', controller)
11606
11739
  // verify required parameter 'addTrajectoryRequest' is not null or undefined
11607
11740
  assertParamExists('addTrajectory', 'addTrajectoryRequest', addTrajectoryRequest)
11608
- const localVarPath = `/cells/{cell}/trajectories`
11609
- .replace(`{${"cell"}}`, encodeURIComponent(String(cell)));
11741
+ const localVarPath = `/cells/{cell}/controllers/{controller}/trajectories`
11742
+ .replace(`{${"cell"}}`, encodeURIComponent(String(cell)))
11743
+ .replace(`{${"controller"}}`, encodeURIComponent(String(controller)));
11610
11744
  // use dummy base URL string because the URL constructor only accepts absolute URLs.
11611
11745
  const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
11612
11746
  let baseOptions;
@@ -11644,14 +11778,18 @@ export const TrajectoryCachingApiAxiosParamCreator = function (configuration?: C
11644
11778
  * Clear the trajectory cache.
11645
11779
  * @summary Clear Trajectories
11646
11780
  * @param {string} cell Unique identifier addressing a cell in all API calls.
11781
+ * @param {string} controller Unique identifier to address a controller in the cell.
11647
11782
  * @param {*} [options] Override http request option.
11648
11783
  * @throws {RequiredError}
11649
11784
  */
11650
- clearTrajectories: async (cell: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
11785
+ clearTrajectories: async (cell: string, controller: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
11651
11786
  // verify required parameter 'cell' is not null or undefined
11652
11787
  assertParamExists('clearTrajectories', 'cell', cell)
11653
- const localVarPath = `/cells/{cell}/trajectories`
11654
- .replace(`{${"cell"}}`, encodeURIComponent(String(cell)));
11788
+ // verify required parameter 'controller' is not null or undefined
11789
+ assertParamExists('clearTrajectories', 'controller', controller)
11790
+ const localVarPath = `/cells/{cell}/controllers/{controller}/trajectories`
11791
+ .replace(`{${"cell"}}`, encodeURIComponent(String(cell)))
11792
+ .replace(`{${"controller"}}`, encodeURIComponent(String(controller)));
11655
11793
  // use dummy base URL string because the URL constructor only accepts absolute URLs.
11656
11794
  const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
11657
11795
  let baseOptions;
@@ -11686,17 +11824,21 @@ export const TrajectoryCachingApiAxiosParamCreator = function (configuration?: C
11686
11824
  * 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.
11687
11825
  * @summary Delete Trajectory
11688
11826
  * @param {string} cell Unique identifier addressing a cell in all API calls.
11827
+ * @param {string} controller Unique identifier to address a controller in the cell.
11689
11828
  * @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.
11690
11829
  * @param {*} [options] Override http request option.
11691
11830
  * @throws {RequiredError}
11692
11831
  */
11693
- deleteTrajectory: async (cell: string, trajectory: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
11832
+ deleteTrajectory: async (cell: string, controller: string, trajectory: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
11694
11833
  // verify required parameter 'cell' is not null or undefined
11695
11834
  assertParamExists('deleteTrajectory', 'cell', cell)
11835
+ // verify required parameter 'controller' is not null or undefined
11836
+ assertParamExists('deleteTrajectory', 'controller', controller)
11696
11837
  // verify required parameter 'trajectory' is not null or undefined
11697
11838
  assertParamExists('deleteTrajectory', 'trajectory', trajectory)
11698
- const localVarPath = `/cells/{cell}/trajectories/{trajectory}`
11839
+ const localVarPath = `/cells/{cell}/controllers/{controller}/trajectories/{trajectory}`
11699
11840
  .replace(`{${"cell"}}`, encodeURIComponent(String(cell)))
11841
+ .replace(`{${"controller"}}`, encodeURIComponent(String(controller)))
11700
11842
  .replace(`{${"trajectory"}}`, encodeURIComponent(String(trajectory)));
11701
11843
  // use dummy base URL string because the URL constructor only accepts absolute URLs.
11702
11844
  const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
@@ -11732,17 +11874,21 @@ export const TrajectoryCachingApiAxiosParamCreator = function (configuration?: C
11732
11874
  * Get a previously created trajectory from cache. Use [listTrajectories](listTrajectories) to list all cached trajectories.
11733
11875
  * @summary Get Trajectory
11734
11876
  * @param {string} cell Unique identifier addressing a cell in all API calls.
11877
+ * @param {string} controller Unique identifier to address a controller in the cell.
11735
11878
  * @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.
11736
11879
  * @param {*} [options] Override http request option.
11737
11880
  * @throws {RequiredError}
11738
11881
  */
11739
- getTrajectory: async (cell: string, trajectory: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
11882
+ getTrajectory: async (cell: string, controller: string, trajectory: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
11740
11883
  // verify required parameter 'cell' is not null or undefined
11741
11884
  assertParamExists('getTrajectory', 'cell', cell)
11885
+ // verify required parameter 'controller' is not null or undefined
11886
+ assertParamExists('getTrajectory', 'controller', controller)
11742
11887
  // verify required parameter 'trajectory' is not null or undefined
11743
11888
  assertParamExists('getTrajectory', 'trajectory', trajectory)
11744
- const localVarPath = `/cells/{cell}/trajectories/{trajectory}`
11889
+ const localVarPath = `/cells/{cell}/controllers/{controller}/trajectories/{trajectory}`
11745
11890
  .replace(`{${"cell"}}`, encodeURIComponent(String(cell)))
11891
+ .replace(`{${"controller"}}`, encodeURIComponent(String(controller)))
11746
11892
  .replace(`{${"trajectory"}}`, encodeURIComponent(String(trajectory)));
11747
11893
  // use dummy base URL string because the URL constructor only accepts absolute URLs.
11748
11894
  const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
@@ -11778,14 +11924,18 @@ export const TrajectoryCachingApiAxiosParamCreator = function (configuration?: C
11778
11924
  * 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.
11779
11925
  * @summary List Trajectories
11780
11926
  * @param {string} cell Unique identifier addressing a cell in all API calls.
11927
+ * @param {string} controller Unique identifier to address a controller in the cell.
11781
11928
  * @param {*} [options] Override http request option.
11782
11929
  * @throws {RequiredError}
11783
11930
  */
11784
- listTrajectories: async (cell: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
11931
+ listTrajectories: async (cell: string, controller: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
11785
11932
  // verify required parameter 'cell' is not null or undefined
11786
11933
  assertParamExists('listTrajectories', 'cell', cell)
11787
- const localVarPath = `/cells/{cell}/trajectories`
11788
- .replace(`{${"cell"}}`, encodeURIComponent(String(cell)));
11934
+ // verify required parameter 'controller' is not null or undefined
11935
+ assertParamExists('listTrajectories', 'controller', controller)
11936
+ const localVarPath = `/cells/{cell}/controllers/{controller}/trajectories`
11937
+ .replace(`{${"cell"}}`, encodeURIComponent(String(cell)))
11938
+ .replace(`{${"controller"}}`, encodeURIComponent(String(controller)));
11789
11939
  // use dummy base URL string because the URL constructor only accepts absolute URLs.
11790
11940
  const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
11791
11941
  let baseOptions;
@@ -11830,12 +11980,13 @@ export const TrajectoryCachingApiFp = function(configuration?: Configuration) {
11830
11980
  * <!-- 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.
11831
11981
  * @summary Add Trajectory
11832
11982
  * @param {string} cell Unique identifier addressing a cell in all API calls.
11983
+ * @param {string} controller Unique identifier to address a controller in the cell.
11833
11984
  * @param {AddTrajectoryRequest} addTrajectoryRequest
11834
11985
  * @param {*} [options] Override http request option.
11835
11986
  * @throws {RequiredError}
11836
11987
  */
11837
- async addTrajectory(cell: string, addTrajectoryRequest: AddTrajectoryRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AddTrajectoryResponse>> {
11838
- const localVarAxiosArgs = await localVarAxiosParamCreator.addTrajectory(cell, addTrajectoryRequest, options);
11988
+ async addTrajectory(cell: string, controller: string, addTrajectoryRequest: AddTrajectoryRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AddTrajectoryResponse>> {
11989
+ const localVarAxiosArgs = await localVarAxiosParamCreator.addTrajectory(cell, controller, addTrajectoryRequest, options);
11839
11990
  const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
11840
11991
  const localVarOperationServerBasePath = operationServerMap['TrajectoryCachingApi.addTrajectory']?.[localVarOperationServerIndex]?.url;
11841
11992
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
@@ -11844,11 +11995,12 @@ export const TrajectoryCachingApiFp = function(configuration?: Configuration) {
11844
11995
  * Clear the trajectory cache.
11845
11996
  * @summary Clear Trajectories
11846
11997
  * @param {string} cell Unique identifier addressing a cell in all API calls.
11998
+ * @param {string} controller Unique identifier to address a controller in the cell.
11847
11999
  * @param {*} [options] Override http request option.
11848
12000
  * @throws {RequiredError}
11849
12001
  */
11850
- async clearTrajectories(cell: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> {
11851
- const localVarAxiosArgs = await localVarAxiosParamCreator.clearTrajectories(cell, options);
12002
+ async clearTrajectories(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> {
12003
+ const localVarAxiosArgs = await localVarAxiosParamCreator.clearTrajectories(cell, controller, options);
11852
12004
  const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
11853
12005
  const localVarOperationServerBasePath = operationServerMap['TrajectoryCachingApi.clearTrajectories']?.[localVarOperationServerIndex]?.url;
11854
12006
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
@@ -11857,12 +12009,13 @@ export const TrajectoryCachingApiFp = function(configuration?: Configuration) {
11857
12009
  * 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.
11858
12010
  * @summary Delete Trajectory
11859
12011
  * @param {string} cell Unique identifier addressing a cell in all API calls.
12012
+ * @param {string} controller Unique identifier to address a controller in the cell.
11860
12013
  * @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.
11861
12014
  * @param {*} [options] Override http request option.
11862
12015
  * @throws {RequiredError}
11863
12016
  */
11864
- async deleteTrajectory(cell: string, trajectory: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> {
11865
- const localVarAxiosArgs = await localVarAxiosParamCreator.deleteTrajectory(cell, trajectory, options);
12017
+ async deleteTrajectory(cell: string, controller: string, trajectory: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> {
12018
+ const localVarAxiosArgs = await localVarAxiosParamCreator.deleteTrajectory(cell, controller, trajectory, options);
11866
12019
  const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
11867
12020
  const localVarOperationServerBasePath = operationServerMap['TrajectoryCachingApi.deleteTrajectory']?.[localVarOperationServerIndex]?.url;
11868
12021
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
@@ -11871,12 +12024,13 @@ export const TrajectoryCachingApiFp = function(configuration?: Configuration) {
11871
12024
  * Get a previously created trajectory from cache. Use [listTrajectories](listTrajectories) to list all cached trajectories.
11872
12025
  * @summary Get Trajectory
11873
12026
  * @param {string} cell Unique identifier addressing a cell in all API calls.
12027
+ * @param {string} controller Unique identifier to address a controller in the cell.
11874
12028
  * @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.
11875
12029
  * @param {*} [options] Override http request option.
11876
12030
  * @throws {RequiredError}
11877
12031
  */
11878
- async getTrajectory(cell: string, trajectory: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetTrajectoryResponse>> {
11879
- const localVarAxiosArgs = await localVarAxiosParamCreator.getTrajectory(cell, trajectory, options);
12032
+ async getTrajectory(cell: string, controller: string, trajectory: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetTrajectoryResponse>> {
12033
+ const localVarAxiosArgs = await localVarAxiosParamCreator.getTrajectory(cell, controller, trajectory, options);
11880
12034
  const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
11881
12035
  const localVarOperationServerBasePath = operationServerMap['TrajectoryCachingApi.getTrajectory']?.[localVarOperationServerIndex]?.url;
11882
12036
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
@@ -11885,11 +12039,12 @@ export const TrajectoryCachingApiFp = function(configuration?: Configuration) {
11885
12039
  * 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.
11886
12040
  * @summary List Trajectories
11887
12041
  * @param {string} cell Unique identifier addressing a cell in all API calls.
12042
+ * @param {string} controller Unique identifier to address a controller in the cell.
11888
12043
  * @param {*} [options] Override http request option.
11889
12044
  * @throws {RequiredError}
11890
12045
  */
11891
- async listTrajectories(cell: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListTrajectoriesResponse>> {
11892
- const localVarAxiosArgs = await localVarAxiosParamCreator.listTrajectories(cell, options);
12046
+ async listTrajectories(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListTrajectoriesResponse>> {
12047
+ const localVarAxiosArgs = await localVarAxiosParamCreator.listTrajectories(cell, controller, options);
11893
12048
  const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
11894
12049
  const localVarOperationServerBasePath = operationServerMap['TrajectoryCachingApi.listTrajectories']?.[localVarOperationServerIndex]?.url;
11895
12050
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
@@ -11908,54 +12063,59 @@ export const TrajectoryCachingApiFactory = function (configuration?: Configurati
11908
12063
  * <!-- 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.
11909
12064
  * @summary Add Trajectory
11910
12065
  * @param {string} cell Unique identifier addressing a cell in all API calls.
12066
+ * @param {string} controller Unique identifier to address a controller in the cell.
11911
12067
  * @param {AddTrajectoryRequest} addTrajectoryRequest
11912
12068
  * @param {*} [options] Override http request option.
11913
12069
  * @throws {RequiredError}
11914
12070
  */
11915
- addTrajectory(cell: string, addTrajectoryRequest: AddTrajectoryRequest, options?: RawAxiosRequestConfig): AxiosPromise<AddTrajectoryResponse> {
11916
- return localVarFp.addTrajectory(cell, addTrajectoryRequest, options).then((request) => request(axios, basePath));
12071
+ addTrajectory(cell: string, controller: string, addTrajectoryRequest: AddTrajectoryRequest, options?: RawAxiosRequestConfig): AxiosPromise<AddTrajectoryResponse> {
12072
+ return localVarFp.addTrajectory(cell, controller, addTrajectoryRequest, options).then((request) => request(axios, basePath));
11917
12073
  },
11918
12074
  /**
11919
12075
  * Clear the trajectory cache.
11920
12076
  * @summary Clear Trajectories
11921
12077
  * @param {string} cell Unique identifier addressing a cell in all API calls.
12078
+ * @param {string} controller Unique identifier to address a controller in the cell.
11922
12079
  * @param {*} [options] Override http request option.
11923
12080
  * @throws {RequiredError}
11924
12081
  */
11925
- clearTrajectories(cell: string, options?: RawAxiosRequestConfig): AxiosPromise<void> {
11926
- return localVarFp.clearTrajectories(cell, options).then((request) => request(axios, basePath));
12082
+ clearTrajectories(cell: string, controller: string, options?: RawAxiosRequestConfig): AxiosPromise<void> {
12083
+ return localVarFp.clearTrajectories(cell, controller, options).then((request) => request(axios, basePath));
11927
12084
  },
11928
12085
  /**
11929
12086
  * 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.
11930
12087
  * @summary Delete Trajectory
11931
12088
  * @param {string} cell Unique identifier addressing a cell in all API calls.
12089
+ * @param {string} controller Unique identifier to address a controller in the cell.
11932
12090
  * @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.
11933
12091
  * @param {*} [options] Override http request option.
11934
12092
  * @throws {RequiredError}
11935
12093
  */
11936
- deleteTrajectory(cell: string, trajectory: string, options?: RawAxiosRequestConfig): AxiosPromise<void> {
11937
- return localVarFp.deleteTrajectory(cell, trajectory, options).then((request) => request(axios, basePath));
12094
+ deleteTrajectory(cell: string, controller: string, trajectory: string, options?: RawAxiosRequestConfig): AxiosPromise<void> {
12095
+ return localVarFp.deleteTrajectory(cell, controller, trajectory, options).then((request) => request(axios, basePath));
11938
12096
  },
11939
12097
  /**
11940
12098
  * Get a previously created trajectory from cache. Use [listTrajectories](listTrajectories) to list all cached trajectories.
11941
12099
  * @summary Get Trajectory
11942
12100
  * @param {string} cell Unique identifier addressing a cell in all API calls.
12101
+ * @param {string} controller Unique identifier to address a controller in the cell.
11943
12102
  * @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.
11944
12103
  * @param {*} [options] Override http request option.
11945
12104
  * @throws {RequiredError}
11946
12105
  */
11947
- getTrajectory(cell: string, trajectory: string, options?: RawAxiosRequestConfig): AxiosPromise<GetTrajectoryResponse> {
11948
- return localVarFp.getTrajectory(cell, trajectory, options).then((request) => request(axios, basePath));
12106
+ getTrajectory(cell: string, controller: string, trajectory: string, options?: RawAxiosRequestConfig): AxiosPromise<GetTrajectoryResponse> {
12107
+ return localVarFp.getTrajectory(cell, controller, trajectory, options).then((request) => request(axios, basePath));
11949
12108
  },
11950
12109
  /**
11951
12110
  * 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.
11952
12111
  * @summary List Trajectories
11953
12112
  * @param {string} cell Unique identifier addressing a cell in all API calls.
12113
+ * @param {string} controller Unique identifier to address a controller in the cell.
11954
12114
  * @param {*} [options] Override http request option.
11955
12115
  * @throws {RequiredError}
11956
12116
  */
11957
- listTrajectories(cell: string, options?: RawAxiosRequestConfig): AxiosPromise<ListTrajectoriesResponse> {
11958
- return localVarFp.listTrajectories(cell, options).then((request) => request(axios, basePath));
12117
+ listTrajectories(cell: string, controller: string, options?: RawAxiosRequestConfig): AxiosPromise<ListTrajectoriesResponse> {
12118
+ return localVarFp.listTrajectories(cell, controller, options).then((request) => request(axios, basePath));
11959
12119
  },
11960
12120
  };
11961
12121
  };
@@ -11971,63 +12131,68 @@ export class TrajectoryCachingApi extends BaseAPI {
11971
12131
  * <!-- 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.
11972
12132
  * @summary Add Trajectory
11973
12133
  * @param {string} cell Unique identifier addressing a cell in all API calls.
12134
+ * @param {string} controller Unique identifier to address a controller in the cell.
11974
12135
  * @param {AddTrajectoryRequest} addTrajectoryRequest
11975
12136
  * @param {*} [options] Override http request option.
11976
12137
  * @throws {RequiredError}
11977
12138
  * @memberof TrajectoryCachingApi
11978
12139
  */
11979
- public addTrajectory(cell: string, addTrajectoryRequest: AddTrajectoryRequest, options?: RawAxiosRequestConfig) {
11980
- return TrajectoryCachingApiFp(this.configuration).addTrajectory(cell, addTrajectoryRequest, options).then((request) => request(this.axios, this.basePath));
12140
+ public addTrajectory(cell: string, controller: string, addTrajectoryRequest: AddTrajectoryRequest, options?: RawAxiosRequestConfig) {
12141
+ return TrajectoryCachingApiFp(this.configuration).addTrajectory(cell, controller, addTrajectoryRequest, options).then((request) => request(this.axios, this.basePath));
11981
12142
  }
11982
12143
 
11983
12144
  /**
11984
12145
  * Clear the trajectory cache.
11985
12146
  * @summary Clear Trajectories
11986
12147
  * @param {string} cell Unique identifier addressing a cell in all API calls.
12148
+ * @param {string} controller Unique identifier to address a controller in the cell.
11987
12149
  * @param {*} [options] Override http request option.
11988
12150
  * @throws {RequiredError}
11989
12151
  * @memberof TrajectoryCachingApi
11990
12152
  */
11991
- public clearTrajectories(cell: string, options?: RawAxiosRequestConfig) {
11992
- return TrajectoryCachingApiFp(this.configuration).clearTrajectories(cell, options).then((request) => request(this.axios, this.basePath));
12153
+ public clearTrajectories(cell: string, controller: string, options?: RawAxiosRequestConfig) {
12154
+ return TrajectoryCachingApiFp(this.configuration).clearTrajectories(cell, controller, options).then((request) => request(this.axios, this.basePath));
11993
12155
  }
11994
12156
 
11995
12157
  /**
11996
12158
  * 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.
11997
12159
  * @summary Delete Trajectory
11998
12160
  * @param {string} cell Unique identifier addressing a cell in all API calls.
12161
+ * @param {string} controller Unique identifier to address a controller in the cell.
11999
12162
  * @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.
12000
12163
  * @param {*} [options] Override http request option.
12001
12164
  * @throws {RequiredError}
12002
12165
  * @memberof TrajectoryCachingApi
12003
12166
  */
12004
- public deleteTrajectory(cell: string, trajectory: string, options?: RawAxiosRequestConfig) {
12005
- return TrajectoryCachingApiFp(this.configuration).deleteTrajectory(cell, trajectory, options).then((request) => request(this.axios, this.basePath));
12167
+ public deleteTrajectory(cell: string, controller: string, trajectory: string, options?: RawAxiosRequestConfig) {
12168
+ return TrajectoryCachingApiFp(this.configuration).deleteTrajectory(cell, controller, trajectory, options).then((request) => request(this.axios, this.basePath));
12006
12169
  }
12007
12170
 
12008
12171
  /**
12009
12172
  * Get a previously created trajectory from cache. Use [listTrajectories](listTrajectories) to list all cached trajectories.
12010
12173
  * @summary Get Trajectory
12011
12174
  * @param {string} cell Unique identifier addressing a cell in all API calls.
12175
+ * @param {string} controller Unique identifier to address a controller in the cell.
12012
12176
  * @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.
12013
12177
  * @param {*} [options] Override http request option.
12014
12178
  * @throws {RequiredError}
12015
12179
  * @memberof TrajectoryCachingApi
12016
12180
  */
12017
- public getTrajectory(cell: string, trajectory: string, options?: RawAxiosRequestConfig) {
12018
- return TrajectoryCachingApiFp(this.configuration).getTrajectory(cell, trajectory, options).then((request) => request(this.axios, this.basePath));
12181
+ public getTrajectory(cell: string, controller: string, trajectory: string, options?: RawAxiosRequestConfig) {
12182
+ return TrajectoryCachingApiFp(this.configuration).getTrajectory(cell, controller, trajectory, options).then((request) => request(this.axios, this.basePath));
12019
12183
  }
12020
12184
 
12021
12185
  /**
12022
12186
  * 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.
12023
12187
  * @summary List Trajectories
12024
12188
  * @param {string} cell Unique identifier addressing a cell in all API calls.
12189
+ * @param {string} controller Unique identifier to address a controller in the cell.
12025
12190
  * @param {*} [options] Override http request option.
12026
12191
  * @throws {RequiredError}
12027
12192
  * @memberof TrajectoryCachingApi
12028
12193
  */
12029
- public listTrajectories(cell: string, options?: RawAxiosRequestConfig) {
12030
- return TrajectoryCachingApiFp(this.configuration).listTrajectories(cell, options).then((request) => request(this.axios, this.basePath));
12194
+ public listTrajectories(cell: string, controller: string, options?: RawAxiosRequestConfig) {
12195
+ return TrajectoryCachingApiFp(this.configuration).listTrajectories(cell, controller, options).then((request) => request(this.axios, this.basePath));
12031
12196
  }
12032
12197
  }
12033
12198
 
@@ -12043,17 +12208,21 @@ export const TrajectoryExecutionApiAxiosParamCreator = function (configuration?:
12043
12208
  * <!-- 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.
12044
12209
  * @summary Execute Trajectory
12045
12210
  * @param {string} cell Unique identifier addressing a cell in all API calls.
12211
+ * @param {string} controller Unique identifier to address a controller in the cell.
12046
12212
  * @param {ExecuteTrajectoryRequest} executeTrajectoryRequest
12047
12213
  * @param {*} [options] Override http request option.
12048
12214
  * @throws {RequiredError}
12049
12215
  */
12050
- executeTrajectory: async (cell: string, executeTrajectoryRequest: ExecuteTrajectoryRequest, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
12216
+ executeTrajectory: async (cell: string, controller: string, executeTrajectoryRequest: ExecuteTrajectoryRequest, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
12051
12217
  // verify required parameter 'cell' is not null or undefined
12052
12218
  assertParamExists('executeTrajectory', 'cell', cell)
12219
+ // verify required parameter 'controller' is not null or undefined
12220
+ assertParamExists('executeTrajectory', 'controller', controller)
12053
12221
  // verify required parameter 'executeTrajectoryRequest' is not null or undefined
12054
12222
  assertParamExists('executeTrajectory', 'executeTrajectoryRequest', executeTrajectoryRequest)
12055
- const localVarPath = `/cells/{cell}/execution/trajectory`
12056
- .replace(`{${"cell"}}`, encodeURIComponent(String(cell)));
12223
+ const localVarPath = `/cells/{cell}/controllers/{controller}/execution/trajectory`
12224
+ .replace(`{${"cell"}}`, encodeURIComponent(String(cell)))
12225
+ .replace(`{${"controller"}}`, encodeURIComponent(String(controller)));
12057
12226
  // use dummy base URL string because the URL constructor only accepts absolute URLs.
12058
12227
  const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
12059
12228
  let baseOptions;
@@ -12101,12 +12270,13 @@ export const TrajectoryExecutionApiFp = function(configuration?: Configuration)
12101
12270
  * <!-- 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.
12102
12271
  * @summary Execute Trajectory
12103
12272
  * @param {string} cell Unique identifier addressing a cell in all API calls.
12273
+ * @param {string} controller Unique identifier to address a controller in the cell.
12104
12274
  * @param {ExecuteTrajectoryRequest} executeTrajectoryRequest
12105
12275
  * @param {*} [options] Override http request option.
12106
12276
  * @throws {RequiredError}
12107
12277
  */
12108
- async executeTrajectory(cell: string, executeTrajectoryRequest: ExecuteTrajectoryRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ExecuteTrajectoryResponse>> {
12109
- const localVarAxiosArgs = await localVarAxiosParamCreator.executeTrajectory(cell, executeTrajectoryRequest, options);
12278
+ async executeTrajectory(cell: string, controller: string, executeTrajectoryRequest: ExecuteTrajectoryRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ExecuteTrajectoryResponse>> {
12279
+ const localVarAxiosArgs = await localVarAxiosParamCreator.executeTrajectory(cell, controller, executeTrajectoryRequest, options);
12110
12280
  const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
12111
12281
  const localVarOperationServerBasePath = operationServerMap['TrajectoryExecutionApi.executeTrajectory']?.[localVarOperationServerIndex]?.url;
12112
12282
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
@@ -12125,12 +12295,13 @@ export const TrajectoryExecutionApiFactory = function (configuration?: Configura
12125
12295
  * <!-- 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.
12126
12296
  * @summary Execute Trajectory
12127
12297
  * @param {string} cell Unique identifier addressing a cell in all API calls.
12298
+ * @param {string} controller Unique identifier to address a controller in the cell.
12128
12299
  * @param {ExecuteTrajectoryRequest} executeTrajectoryRequest
12129
12300
  * @param {*} [options] Override http request option.
12130
12301
  * @throws {RequiredError}
12131
12302
  */
12132
- executeTrajectory(cell: string, executeTrajectoryRequest: ExecuteTrajectoryRequest, options?: RawAxiosRequestConfig): AxiosPromise<ExecuteTrajectoryResponse> {
12133
- return localVarFp.executeTrajectory(cell, executeTrajectoryRequest, options).then((request) => request(axios, basePath));
12303
+ executeTrajectory(cell: string, controller: string, executeTrajectoryRequest: ExecuteTrajectoryRequest, options?: RawAxiosRequestConfig): AxiosPromise<ExecuteTrajectoryResponse> {
12304
+ return localVarFp.executeTrajectory(cell, controller, executeTrajectoryRequest, options).then((request) => request(axios, basePath));
12134
12305
  },
12135
12306
  };
12136
12307
  };
@@ -12146,13 +12317,14 @@ export class TrajectoryExecutionApi extends BaseAPI {
12146
12317
  * <!-- 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.
12147
12318
  * @summary Execute Trajectory
12148
12319
  * @param {string} cell Unique identifier addressing a cell in all API calls.
12320
+ * @param {string} controller Unique identifier to address a controller in the cell.
12149
12321
  * @param {ExecuteTrajectoryRequest} executeTrajectoryRequest
12150
12322
  * @param {*} [options] Override http request option.
12151
12323
  * @throws {RequiredError}
12152
12324
  * @memberof TrajectoryExecutionApi
12153
12325
  */
12154
- public executeTrajectory(cell: string, executeTrajectoryRequest: ExecuteTrajectoryRequest, options?: RawAxiosRequestConfig) {
12155
- return TrajectoryExecutionApiFp(this.configuration).executeTrajectory(cell, executeTrajectoryRequest, options).then((request) => request(this.axios, this.basePath));
12326
+ public executeTrajectory(cell: string, controller: string, executeTrajectoryRequest: ExecuteTrajectoryRequest, options?: RawAxiosRequestConfig) {
12327
+ return TrajectoryExecutionApiFp(this.configuration).executeTrajectory(cell, controller, executeTrajectoryRequest, options).then((request) => request(this.axios, this.basePath));
12156
12328
  }
12157
12329
  }
12158
12330
 
@@ -12282,31 +12454,34 @@ export class TrajectoryPlanningApi extends BaseAPI {
12282
12454
 
12283
12455
 
12284
12456
  /**
12285
- * VirtualRobotApi - axios parameter creator
12457
+ * VirtualControllerApi - axios parameter creator
12286
12458
  * @export
12287
12459
  */
12288
- export const VirtualRobotApiAxiosParamCreator = function (configuration?: Configuration) {
12460
+ export const VirtualControllerApiAxiosParamCreator = function (configuration?: Configuration) {
12289
12461
  return {
12290
12462
  /**
12291
- * Get the current motion group state which provides values for the joints\' position, velocity and acceleration.
12292
- * @summary Get Motion Group State
12463
+ * Adds a coordinate system to the robot controller.
12464
+ * @summary Add Coordinate Systems
12293
12465
  * @param {string} cell Unique identifier addressing a cell in all API calls.
12294
12466
  * @param {string} controller Unique identifier to address a controller in the cell.
12295
- * @param {string} motionGroup The motion-group identifier.
12467
+ * @param {string} coordinateSystem Unique identifier addressing a coordinate system.
12468
+ * @param {CoordinateSystemData} coordinateSystemData
12296
12469
  * @param {*} [options] Override http request option.
12297
12470
  * @throws {RequiredError}
12298
12471
  */
12299
- getMotionGroupState: async (cell: string, controller: string, motionGroup: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
12472
+ addVirtualRobotCoordinateSystem: async (cell: string, controller: string, coordinateSystem: string, coordinateSystemData: CoordinateSystemData, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
12300
12473
  // verify required parameter 'cell' is not null or undefined
12301
- assertParamExists('getMotionGroupState', 'cell', cell)
12474
+ assertParamExists('addVirtualRobotCoordinateSystem', 'cell', cell)
12302
12475
  // verify required parameter 'controller' is not null or undefined
12303
- assertParamExists('getMotionGroupState', 'controller', controller)
12304
- // verify required parameter 'motionGroup' is not null or undefined
12305
- assertParamExists('getMotionGroupState', 'motionGroup', motionGroup)
12306
- const localVarPath = `/cells/{cell}/controllers/{controller}/teach-pendant/motion-groups/{motion-group}`
12476
+ assertParamExists('addVirtualRobotCoordinateSystem', 'controller', controller)
12477
+ // verify required parameter 'coordinateSystem' is not null or undefined
12478
+ assertParamExists('addVirtualRobotCoordinateSystem', 'coordinateSystem', coordinateSystem)
12479
+ // verify required parameter 'coordinateSystemData' is not null or undefined
12480
+ assertParamExists('addVirtualRobotCoordinateSystem', 'coordinateSystemData', coordinateSystemData)
12481
+ const localVarPath = `/cells/{cell}/virtual-controllers/{controller}/coordinate-systems/{coordinate-system}`
12307
12482
  .replace(`{${"cell"}}`, encodeURIComponent(String(cell)))
12308
12483
  .replace(`{${"controller"}}`, encodeURIComponent(String(controller)))
12309
- .replace(`{${"motion-group"}}`, encodeURIComponent(String(motionGroup)));
12484
+ .replace(`{${"coordinate-system"}}`, encodeURIComponent(String(coordinateSystem)));
12310
12485
  // use dummy base URL string because the URL constructor only accepts absolute URLs.
12311
12486
  const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
12312
12487
  let baseOptions;
@@ -12314,7 +12489,7 @@ export const VirtualRobotApiAxiosParamCreator = function (configuration?: Config
12314
12489
  baseOptions = configuration.baseOptions;
12315
12490
  }
12316
12491
 
12317
- const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
12492
+ const localVarRequestOptions = { method: 'PUT', ...baseOptions, ...options};
12318
12493
  const localVarHeaderParameter = {} as any;
12319
12494
  const localVarQueryParameter = {} as any;
12320
12495
 
@@ -12328,9 +12503,12 @@ export const VirtualRobotApiAxiosParamCreator = function (configuration?: Config
12328
12503
 
12329
12504
 
12330
12505
 
12506
+ localVarHeaderParameter['Content-Type'] = 'application/json';
12507
+
12331
12508
  setSearchParams(localVarUrlObj, localVarQueryParameter);
12332
12509
  let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
12333
12510
  localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
12511
+ localVarRequestOptions.data = serializeDataIfNeeded(coordinateSystemData, localVarRequestOptions, configuration)
12334
12512
 
12335
12513
  return {
12336
12514
  url: toPathString(localVarUrlObj),
@@ -12338,21 +12516,32 @@ export const VirtualRobotApiAxiosParamCreator = function (configuration?: Config
12338
12516
  };
12339
12517
  },
12340
12518
  /**
12341
- * Gets information on the motion group.
12342
- * @summary Motion Group Description
12519
+ * 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.
12520
+ * @summary Add TCP
12343
12521
  * @param {string} cell Unique identifier addressing a cell in all API calls.
12344
12522
  * @param {string} controller Unique identifier to address a controller in the cell.
12523
+ * @param {string} motionGroup The motion-group identifier.
12524
+ * @param {string} tcp The unique identifier of a TCP.
12525
+ * @param {RobotTcpData} robotTcpData
12345
12526
  * @param {*} [options] Override http request option.
12346
12527
  * @throws {RequiredError}
12347
12528
  */
12348
- getMotionGroups: async (cell: string, controller: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
12529
+ addVirtualRobotTcp: async (cell: string, controller: string, motionGroup: string, tcp: string, robotTcpData: RobotTcpData, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
12349
12530
  // verify required parameter 'cell' is not null or undefined
12350
- assertParamExists('getMotionGroups', 'cell', cell)
12531
+ assertParamExists('addVirtualRobotTcp', 'cell', cell)
12351
12532
  // verify required parameter 'controller' is not null or undefined
12352
- assertParamExists('getMotionGroups', 'controller', controller)
12353
- const localVarPath = `/cells/{cell}/controllers/{controller}/teach-pendant/motion-groups`
12533
+ assertParamExists('addVirtualRobotTcp', 'controller', controller)
12534
+ // verify required parameter 'motionGroup' is not null or undefined
12535
+ assertParamExists('addVirtualRobotTcp', 'motionGroup', motionGroup)
12536
+ // verify required parameter 'tcp' is not null or undefined
12537
+ assertParamExists('addVirtualRobotTcp', 'tcp', tcp)
12538
+ // verify required parameter 'robotTcpData' is not null or undefined
12539
+ assertParamExists('addVirtualRobotTcp', 'robotTcpData', robotTcpData)
12540
+ const localVarPath = `/cells/{cell}/virtual-controllers/{controller}/motion-groups/{motion-group}/tcps/{tcp}`
12354
12541
  .replace(`{${"cell"}}`, encodeURIComponent(String(cell)))
12355
- .replace(`{${"controller"}}`, encodeURIComponent(String(controller)));
12542
+ .replace(`{${"controller"}}`, encodeURIComponent(String(controller)))
12543
+ .replace(`{${"motion-group"}}`, encodeURIComponent(String(motionGroup)))
12544
+ .replace(`{${"tcp"}}`, encodeURIComponent(String(tcp)));
12356
12545
  // use dummy base URL string because the URL constructor only accepts absolute URLs.
12357
12546
  const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
12358
12547
  let baseOptions;
@@ -12360,7 +12549,7 @@ export const VirtualRobotApiAxiosParamCreator = function (configuration?: Config
12360
12549
  baseOptions = configuration.baseOptions;
12361
12550
  }
12362
12551
 
12363
- const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
12552
+ const localVarRequestOptions = { method: 'PUT', ...baseOptions, ...options};
12364
12553
  const localVarHeaderParameter = {} as any;
12365
12554
  const localVarQueryParameter = {} as any;
12366
12555
 
@@ -12374,9 +12563,12 @@ export const VirtualRobotApiAxiosParamCreator = function (configuration?: Config
12374
12563
 
12375
12564
 
12376
12565
 
12566
+ localVarHeaderParameter['Content-Type'] = 'application/json';
12567
+
12377
12568
  setSearchParams(localVarUrlObj, localVarQueryParameter);
12378
12569
  let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
12379
12570
  localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
12571
+ localVarRequestOptions.data = serializeDataIfNeeded(robotTcpData, localVarRequestOptions, configuration)
12380
12572
 
12381
12573
  return {
12382
12574
  url: toPathString(localVarUrlObj),
@@ -12384,24 +12576,26 @@ export const VirtualRobotApiAxiosParamCreator = function (configuration?: Config
12384
12576
  };
12385
12577
  },
12386
12578
  /**
12387
- * 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).
12388
- * @summary Get Inputs/Outputs
12579
+ * 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.
12580
+ * @summary Remove Coordinate System
12389
12581
  * @param {string} cell Unique identifier addressing a cell in all API calls.
12390
12582
  * @param {string} controller Unique identifier to address a controller in the cell.
12391
- * @param {Array<string>} ios
12583
+ * @param {string} coordinateSystem Unique identifier addressing a coordinate system.
12584
+ * @param {boolean} [deleteDependent] If true, all dependent coordinate systems will be deleted as well.
12392
12585
  * @param {*} [options] Override http request option.
12393
12586
  * @throws {RequiredError}
12394
12587
  */
12395
- listIOs: async (cell: string, controller: string, ios: Array<string>, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
12588
+ deleteVirtualRobotCoordinateSystem: async (cell: string, controller: string, coordinateSystem: string, deleteDependent?: boolean, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
12396
12589
  // verify required parameter 'cell' is not null or undefined
12397
- assertParamExists('listIOs', 'cell', cell)
12590
+ assertParamExists('deleteVirtualRobotCoordinateSystem', 'cell', cell)
12398
12591
  // verify required parameter 'controller' is not null or undefined
12399
- assertParamExists('listIOs', 'controller', controller)
12400
- // verify required parameter 'ios' is not null or undefined
12401
- assertParamExists('listIOs', 'ios', ios)
12402
- const localVarPath = `/cells/{cell}/controllers/{controller}/teach-pendant/ios`
12592
+ assertParamExists('deleteVirtualRobotCoordinateSystem', 'controller', controller)
12593
+ // verify required parameter 'coordinateSystem' is not null or undefined
12594
+ assertParamExists('deleteVirtualRobotCoordinateSystem', 'coordinateSystem', coordinateSystem)
12595
+ const localVarPath = `/cells/{cell}/virtual-controllers/{controller}/coordinate-systems/{coordinate-system}`
12403
12596
  .replace(`{${"cell"}}`, encodeURIComponent(String(cell)))
12404
- .replace(`{${"controller"}}`, encodeURIComponent(String(controller)));
12597
+ .replace(`{${"controller"}}`, encodeURIComponent(String(controller)))
12598
+ .replace(`{${"coordinate-system"}}`, encodeURIComponent(String(coordinateSystem)));
12405
12599
  // use dummy base URL string because the URL constructor only accepts absolute URLs.
12406
12600
  const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
12407
12601
  let baseOptions;
@@ -12409,7 +12603,7 @@ export const VirtualRobotApiAxiosParamCreator = function (configuration?: Config
12409
12603
  baseOptions = configuration.baseOptions;
12410
12604
  }
12411
12605
 
12412
- const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
12606
+ const localVarRequestOptions = { method: 'DELETE', ...baseOptions, ...options};
12413
12607
  const localVarHeaderParameter = {} as any;
12414
12608
  const localVarQueryParameter = {} as any;
12415
12609
 
@@ -12421,8 +12615,8 @@ export const VirtualRobotApiAxiosParamCreator = function (configuration?: Config
12421
12615
  // http bearer authentication required
12422
12616
  await setBearerAuthToObject(localVarHeaderParameter, configuration)
12423
12617
 
12424
- if (ios) {
12425
- localVarQueryParameter['ios'] = ios;
12618
+ if (deleteDependent !== undefined) {
12619
+ localVarQueryParameter['delete_dependent'] = deleteDependent;
12426
12620
  }
12427
12621
 
12428
12622
 
@@ -12437,25 +12631,29 @@ export const VirtualRobotApiAxiosParamCreator = function (configuration?: Config
12437
12631
  };
12438
12632
  },
12439
12633
  /**
12440
- * 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.
12441
- * @summary List Input/Output Descriptions
12634
+ * Removes the TCP from the motion group. An unknown TCP is a valid input.
12635
+ * @summary Remove TCP
12442
12636
  * @param {string} cell Unique identifier addressing a cell in all API calls.
12443
12637
  * @param {string} controller Unique identifier to address a controller in the cell.
12444
- * @param {Array<string>} [ios]
12445
- * @param {IODirection} [direction] Return only inputs/outputs with the specified direction.
12446
- * @param {IOValueType} [valueType] Return only inputs/outputs with the specified value type.
12447
- * @param {string} [group] Return only inputs/outputs from the specified group.
12638
+ * @param {string} motionGroup The motion-group identifier.
12639
+ * @param {string} tcp The unique identifier of a TCP.
12448
12640
  * @param {*} [options] Override http request option.
12449
12641
  * @throws {RequiredError}
12450
12642
  */
12451
- listVirtualRobotIODescriptions: async (cell: string, controller: string, ios?: Array<string>, direction?: IODirection, valueType?: IOValueType, group?: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
12643
+ deleteVirtualRobotTcp: async (cell: string, controller: string, motionGroup: string, tcp: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
12452
12644
  // verify required parameter 'cell' is not null or undefined
12453
- assertParamExists('listVirtualRobotIODescriptions', 'cell', cell)
12645
+ assertParamExists('deleteVirtualRobotTcp', 'cell', cell)
12454
12646
  // verify required parameter 'controller' is not null or undefined
12455
- assertParamExists('listVirtualRobotIODescriptions', 'controller', controller)
12456
- const localVarPath = `/cells/{cell}/controllers/{controller}/teach-pendant/ios/description`
12647
+ assertParamExists('deleteVirtualRobotTcp', 'controller', controller)
12648
+ // verify required parameter 'motionGroup' is not null or undefined
12649
+ assertParamExists('deleteVirtualRobotTcp', 'motionGroup', motionGroup)
12650
+ // verify required parameter 'tcp' is not null or undefined
12651
+ assertParamExists('deleteVirtualRobotTcp', 'tcp', tcp)
12652
+ const localVarPath = `/cells/{cell}/virtual-controllers/{controller}/motion-groups/{motion-group}/tcps/{tcp}`
12457
12653
  .replace(`{${"cell"}}`, encodeURIComponent(String(cell)))
12458
- .replace(`{${"controller"}}`, encodeURIComponent(String(controller)));
12654
+ .replace(`{${"controller"}}`, encodeURIComponent(String(controller)))
12655
+ .replace(`{${"motion-group"}}`, encodeURIComponent(String(motionGroup)))
12656
+ .replace(`{${"tcp"}}`, encodeURIComponent(String(tcp)));
12459
12657
  // use dummy base URL string because the URL constructor only accepts absolute URLs.
12460
12658
  const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
12461
12659
  let baseOptions;
@@ -12463,7 +12661,7 @@ export const VirtualRobotApiAxiosParamCreator = function (configuration?: Config
12463
12661
  baseOptions = configuration.baseOptions;
12464
12662
  }
12465
12663
 
12466
- const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
12664
+ const localVarRequestOptions = { method: 'DELETE', ...baseOptions, ...options};
12467
12665
  const localVarHeaderParameter = {} as any;
12468
12666
  const localVarQueryParameter = {} as any;
12469
12667
 
@@ -12475,22 +12673,6 @@ export const VirtualRobotApiAxiosParamCreator = function (configuration?: Config
12475
12673
  // http bearer authentication required
12476
12674
  await setBearerAuthToObject(localVarHeaderParameter, configuration)
12477
12675
 
12478
- if (ios) {
12479
- localVarQueryParameter['ios'] = ios;
12480
- }
12481
-
12482
- if (direction !== undefined) {
12483
- localVarQueryParameter['direction'] = direction;
12484
- }
12485
-
12486
- if (valueType !== undefined) {
12487
- localVarQueryParameter['value_type'] = valueType;
12488
- }
12489
-
12490
- if (group !== undefined) {
12491
- localVarQueryParameter['group'] = group;
12492
- }
12493
-
12494
12676
 
12495
12677
 
12496
12678
  setSearchParams(localVarUrlObj, localVarQueryParameter);
@@ -12503,22 +12685,19 @@ export const VirtualRobotApiAxiosParamCreator = function (configuration?: Config
12503
12685
  };
12504
12686
  },
12505
12687
  /**
12506
- * Sets a list of values of a virtual controller inputs/outputs.
12507
- * @summary Set Input/Ouput Values
12688
+ * 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.
12689
+ * @summary Get Emergency Stop State
12508
12690
  * @param {string} cell Unique identifier addressing a cell in all API calls.
12509
12691
  * @param {string} controller Unique identifier to address a controller in the cell.
12510
- * @param {Array<IOValue>} iOValue
12511
12692
  * @param {*} [options] Override http request option.
12512
12693
  * @throws {RequiredError}
12513
12694
  */
12514
- setIOValues: async (cell: string, controller: string, iOValue: Array<IOValue>, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
12695
+ getEmergencyStop: async (cell: string, controller: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
12515
12696
  // verify required parameter 'cell' is not null or undefined
12516
- assertParamExists('setIOValues', 'cell', cell)
12697
+ assertParamExists('getEmergencyStop', 'cell', cell)
12517
12698
  // verify required parameter 'controller' is not null or undefined
12518
- assertParamExists('setIOValues', 'controller', controller)
12519
- // verify required parameter 'iOValue' is not null or undefined
12520
- assertParamExists('setIOValues', 'iOValue', iOValue)
12521
- const localVarPath = `/cells/{cell}/controllers/{controller}/teach-pendant/ios`
12699
+ assertParamExists('getEmergencyStop', 'controller', controller)
12700
+ const localVarPath = `/cells/{cell}/virtual-controllers/{controller}/emergency-stop`
12522
12701
  .replace(`{${"cell"}}`, encodeURIComponent(String(cell)))
12523
12702
  .replace(`{${"controller"}}`, encodeURIComponent(String(controller)));
12524
12703
  // use dummy base URL string because the URL constructor only accepts absolute URLs.
@@ -12528,7 +12707,7 @@ export const VirtualRobotApiAxiosParamCreator = function (configuration?: Config
12528
12707
  baseOptions = configuration.baseOptions;
12529
12708
  }
12530
12709
 
12531
- const localVarRequestOptions = { method: 'PUT', ...baseOptions, ...options};
12710
+ const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
12532
12711
  const localVarHeaderParameter = {} as any;
12533
12712
  const localVarQueryParameter = {} as any;
12534
12713
 
@@ -12542,12 +12721,9 @@ export const VirtualRobotApiAxiosParamCreator = function (configuration?: Config
12542
12721
 
12543
12722
 
12544
12723
 
12545
- localVarHeaderParameter['Content-Type'] = 'application/json';
12546
-
12547
12724
  setSearchParams(localVarUrlObj, localVarQueryParameter);
12548
12725
  let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
12549
12726
  localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
12550
- localVarRequestOptions.data = serializeDataIfNeeded(iOValue, localVarRequestOptions, configuration)
12551
12727
 
12552
12728
  return {
12553
12729
  url: toPathString(localVarUrlObj),
@@ -12555,25 +12731,22 @@ export const VirtualRobotApiAxiosParamCreator = function (configuration?: Config
12555
12731
  };
12556
12732
  },
12557
12733
  /**
12558
- * 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.
12559
- * @summary Set Motion Group State
12734
+ * Get the current motion group state which provides values for the joints\' position, velocity and acceleration.
12735
+ * @summary Get Motion Group State
12560
12736
  * @param {string} cell Unique identifier addressing a cell in all API calls.
12561
12737
  * @param {string} controller Unique identifier to address a controller in the cell.
12562
12738
  * @param {string} motionGroup The motion-group identifier.
12563
- * @param {MotionGroupJoints} motionGroupJoints
12564
12739
  * @param {*} [options] Override http request option.
12565
12740
  * @throws {RequiredError}
12566
12741
  */
12567
- setMotionGroupState: async (cell: string, controller: string, motionGroup: string, motionGroupJoints: MotionGroupJoints, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
12742
+ getMotionGroupState: async (cell: string, controller: string, motionGroup: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
12568
12743
  // verify required parameter 'cell' is not null or undefined
12569
- assertParamExists('setMotionGroupState', 'cell', cell)
12744
+ assertParamExists('getMotionGroupState', 'cell', cell)
12570
12745
  // verify required parameter 'controller' is not null or undefined
12571
- assertParamExists('setMotionGroupState', 'controller', controller)
12746
+ assertParamExists('getMotionGroupState', 'controller', controller)
12572
12747
  // verify required parameter 'motionGroup' is not null or undefined
12573
- assertParamExists('setMotionGroupState', 'motionGroup', motionGroup)
12574
- // verify required parameter 'motionGroupJoints' is not null or undefined
12575
- assertParamExists('setMotionGroupState', 'motionGroupJoints', motionGroupJoints)
12576
- const localVarPath = `/cells/{cell}/controllers/{controller}/teach-pendant/motion-groups/{motion-group}`
12748
+ assertParamExists('getMotionGroupState', 'motionGroup', motionGroup)
12749
+ const localVarPath = `/cells/{cell}/virtual-controllers/{controller}/motion-groups/{motion-group}/state`
12577
12750
  .replace(`{${"cell"}}`, encodeURIComponent(String(cell)))
12578
12751
  .replace(`{${"controller"}}`, encodeURIComponent(String(controller)))
12579
12752
  .replace(`{${"motion-group"}}`, encodeURIComponent(String(motionGroup)));
@@ -12584,7 +12757,7 @@ export const VirtualRobotApiAxiosParamCreator = function (configuration?: Config
12584
12757
  baseOptions = configuration.baseOptions;
12585
12758
  }
12586
12759
 
12587
- const localVarRequestOptions = { method: 'PUT', ...baseOptions, ...options};
12760
+ const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
12588
12761
  const localVarHeaderParameter = {} as any;
12589
12762
  const localVarQueryParameter = {} as any;
12590
12763
 
@@ -12598,331 +12771,127 @@ export const VirtualRobotApiAxiosParamCreator = function (configuration?: Config
12598
12771
 
12599
12772
 
12600
12773
 
12601
- localVarHeaderParameter['Content-Type'] = 'application/json';
12602
-
12603
12774
  setSearchParams(localVarUrlObj, localVarQueryParameter);
12604
12775
  let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
12605
12776
  localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
12606
- localVarRequestOptions.data = serializeDataIfNeeded(motionGroupJoints, localVarRequestOptions, configuration)
12607
12777
 
12608
12778
  return {
12609
12779
  url: toPathString(localVarUrlObj),
12610
12780
  options: localVarRequestOptions,
12611
12781
  };
12612
12782
  },
12613
- }
12614
- };
12615
-
12616
- /**
12617
- * VirtualRobotApi - functional programming interface
12618
- * @export
12619
- */
12620
- export const VirtualRobotApiFp = function(configuration?: Configuration) {
12621
- const localVarAxiosParamCreator = VirtualRobotApiAxiosParamCreator(configuration)
12622
- return {
12623
12783
  /**
12624
- * Get the current motion group state which provides values for the joints\' position, velocity and acceleration.
12625
- * @summary Get Motion Group State
12784
+ * Gets information on the motion group.
12785
+ * @summary Motion Group Description
12626
12786
  * @param {string} cell Unique identifier addressing a cell in all API calls.
12627
12787
  * @param {string} controller Unique identifier to address a controller in the cell.
12628
- * @param {string} motionGroup The motion-group identifier.
12629
12788
  * @param {*} [options] Override http request option.
12630
12789
  * @throws {RequiredError}
12631
12790
  */
12632
- async getMotionGroupState(cell: string, controller: string, motionGroup: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<MotionGroupJoints>> {
12633
- const localVarAxiosArgs = await localVarAxiosParamCreator.getMotionGroupState(cell, controller, motionGroup, options);
12634
- const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
12635
- const localVarOperationServerBasePath = operationServerMap['VirtualRobotApi.getMotionGroupState']?.[localVarOperationServerIndex]?.url;
12636
- return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
12791
+ getMotionGroups: async (cell: string, controller: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
12792
+ // verify required parameter 'cell' is not null or undefined
12793
+ assertParamExists('getMotionGroups', 'cell', cell)
12794
+ // verify required parameter 'controller' is not null or undefined
12795
+ assertParamExists('getMotionGroups', 'controller', controller)
12796
+ const localVarPath = `/cells/{cell}/virtual-controllers/{controller}/motion-groups`
12797
+ .replace(`{${"cell"}}`, encodeURIComponent(String(cell)))
12798
+ .replace(`{${"controller"}}`, encodeURIComponent(String(controller)));
12799
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
12800
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
12801
+ let baseOptions;
12802
+ if (configuration) {
12803
+ baseOptions = configuration.baseOptions;
12804
+ }
12805
+
12806
+ const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
12807
+ const localVarHeaderParameter = {} as any;
12808
+ const localVarQueryParameter = {} as any;
12809
+
12810
+ // authentication BasicAuth required
12811
+ // http basic authentication required
12812
+ setBasicAuthToObject(localVarRequestOptions, configuration)
12813
+
12814
+ // authentication BearerAuth required
12815
+ // http bearer authentication required
12816
+ await setBearerAuthToObject(localVarHeaderParameter, configuration)
12817
+
12818
+
12819
+
12820
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
12821
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
12822
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
12823
+
12824
+ return {
12825
+ url: toPathString(localVarUrlObj),
12826
+ options: localVarRequestOptions,
12827
+ };
12637
12828
  },
12638
12829
  /**
12639
- * Gets information on the motion group.
12640
- * @summary Motion Group Description
12830
+ * 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.
12831
+ * @summary Get Operation Mode
12641
12832
  * @param {string} cell Unique identifier addressing a cell in all API calls.
12642
12833
  * @param {string} controller Unique identifier to address a controller in the cell.
12643
12834
  * @param {*} [options] Override http request option.
12644
12835
  * @throws {RequiredError}
12645
12836
  */
12646
- async getMotionGroups(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<MotionGroupInfos>> {
12647
- const localVarAxiosArgs = await localVarAxiosParamCreator.getMotionGroups(cell, controller, options);
12648
- const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
12649
- const localVarOperationServerBasePath = operationServerMap['VirtualRobotApi.getMotionGroups']?.[localVarOperationServerIndex]?.url;
12650
- return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
12837
+ getOperationMode: async (cell: string, controller: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
12838
+ // verify required parameter 'cell' is not null or undefined
12839
+ assertParamExists('getOperationMode', 'cell', cell)
12840
+ // verify required parameter 'controller' is not null or undefined
12841
+ assertParamExists('getOperationMode', 'controller', controller)
12842
+ const localVarPath = `/cells/{cell}/virtual-controllers/{controller}/operationmode`
12843
+ .replace(`{${"cell"}}`, encodeURIComponent(String(cell)))
12844
+ .replace(`{${"controller"}}`, encodeURIComponent(String(controller)));
12845
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
12846
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
12847
+ let baseOptions;
12848
+ if (configuration) {
12849
+ baseOptions = configuration.baseOptions;
12850
+ }
12851
+
12852
+ const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
12853
+ const localVarHeaderParameter = {} as any;
12854
+ const localVarQueryParameter = {} as any;
12855
+
12856
+ // authentication BasicAuth required
12857
+ // http basic authentication required
12858
+ setBasicAuthToObject(localVarRequestOptions, configuration)
12859
+
12860
+ // authentication BearerAuth required
12861
+ // http bearer authentication required
12862
+ await setBearerAuthToObject(localVarHeaderParameter, configuration)
12863
+
12864
+
12865
+
12866
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
12867
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
12868
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
12869
+
12870
+ return {
12871
+ url: toPathString(localVarUrlObj),
12872
+ options: localVarRequestOptions,
12873
+ };
12651
12874
  },
12652
12875
  /**
12653
- * 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).
12654
- * @summary Get Inputs/Outputs
12876
+ * Gets motion group mounting. The motion group is based on the origin of the returned coordinate system.
12877
+ * @summary Get Mounting
12655
12878
  * @param {string} cell Unique identifier addressing a cell in all API calls.
12656
12879
  * @param {string} controller Unique identifier to address a controller in the cell.
12657
- * @param {Array<string>} ios
12880
+ * @param {string} motionGroup The motion-group identifier.
12658
12881
  * @param {*} [options] Override http request option.
12659
12882
  * @throws {RequiredError}
12660
12883
  */
12661
- async listIOs(cell: string, controller: string, ios: Array<string>, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<IOValue>>> {
12662
- const localVarAxiosArgs = await localVarAxiosParamCreator.listIOs(cell, controller, ios, options);
12663
- const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
12664
- const localVarOperationServerBasePath = operationServerMap['VirtualRobotApi.listIOs']?.[localVarOperationServerIndex]?.url;
12665
- return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
12666
- },
12667
- /**
12668
- * 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.
12669
- * @summary List Input/Output Descriptions
12670
- * @param {string} cell Unique identifier addressing a cell in all API calls.
12671
- * @param {string} controller Unique identifier to address a controller in the cell.
12672
- * @param {Array<string>} [ios]
12673
- * @param {IODirection} [direction] Return only inputs/outputs with the specified direction.
12674
- * @param {IOValueType} [valueType] Return only inputs/outputs with the specified value type.
12675
- * @param {string} [group] Return only inputs/outputs from the specified group.
12676
- * @param {*} [options] Override http request option.
12677
- * @throws {RequiredError}
12678
- */
12679
- async listVirtualRobotIODescriptions(cell: string, controller: string, ios?: Array<string>, direction?: IODirection, valueType?: IOValueType, group?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<IODescription>>> {
12680
- const localVarAxiosArgs = await localVarAxiosParamCreator.listVirtualRobotIODescriptions(cell, controller, ios, direction, valueType, group, options);
12681
- const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
12682
- const localVarOperationServerBasePath = operationServerMap['VirtualRobotApi.listVirtualRobotIODescriptions']?.[localVarOperationServerIndex]?.url;
12683
- return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
12684
- },
12685
- /**
12686
- * Sets a list of values of a virtual controller inputs/outputs.
12687
- * @summary Set Input/Ouput Values
12688
- * @param {string} cell Unique identifier addressing a cell in all API calls.
12689
- * @param {string} controller Unique identifier to address a controller in the cell.
12690
- * @param {Array<IOValue>} iOValue
12691
- * @param {*} [options] Override http request option.
12692
- * @throws {RequiredError}
12693
- */
12694
- async setIOValues(cell: string, controller: string, iOValue: Array<IOValue>, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> {
12695
- const localVarAxiosArgs = await localVarAxiosParamCreator.setIOValues(cell, controller, iOValue, options);
12696
- const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
12697
- const localVarOperationServerBasePath = operationServerMap['VirtualRobotApi.setIOValues']?.[localVarOperationServerIndex]?.url;
12698
- return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
12699
- },
12700
- /**
12701
- * 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.
12702
- * @summary Set Motion Group State
12703
- * @param {string} cell Unique identifier addressing a cell in all API calls.
12704
- * @param {string} controller Unique identifier to address a controller in the cell.
12705
- * @param {string} motionGroup The motion-group identifier.
12706
- * @param {MotionGroupJoints} motionGroupJoints
12707
- * @param {*} [options] Override http request option.
12708
- * @throws {RequiredError}
12709
- */
12710
- async setMotionGroupState(cell: string, controller: string, motionGroup: string, motionGroupJoints: MotionGroupJoints, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> {
12711
- const localVarAxiosArgs = await localVarAxiosParamCreator.setMotionGroupState(cell, controller, motionGroup, motionGroupJoints, options);
12712
- const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
12713
- const localVarOperationServerBasePath = operationServerMap['VirtualRobotApi.setMotionGroupState']?.[localVarOperationServerIndex]?.url;
12714
- return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
12715
- },
12716
- }
12717
- };
12718
-
12719
- /**
12720
- * VirtualRobotApi - factory interface
12721
- * @export
12722
- */
12723
- export const VirtualRobotApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
12724
- const localVarFp = VirtualRobotApiFp(configuration)
12725
- return {
12726
- /**
12727
- * Get the current motion group state which provides values for the joints\' position, velocity and acceleration.
12728
- * @summary Get Motion Group State
12729
- * @param {string} cell Unique identifier addressing a cell in all API calls.
12730
- * @param {string} controller Unique identifier to address a controller in the cell.
12731
- * @param {string} motionGroup The motion-group identifier.
12732
- * @param {*} [options] Override http request option.
12733
- * @throws {RequiredError}
12734
- */
12735
- getMotionGroupState(cell: string, controller: string, motionGroup: string, options?: RawAxiosRequestConfig): AxiosPromise<MotionGroupJoints> {
12736
- return localVarFp.getMotionGroupState(cell, controller, motionGroup, options).then((request) => request(axios, basePath));
12737
- },
12738
- /**
12739
- * Gets information on the motion group.
12740
- * @summary Motion Group Description
12741
- * @param {string} cell Unique identifier addressing a cell in all API calls.
12742
- * @param {string} controller Unique identifier to address a controller in the cell.
12743
- * @param {*} [options] Override http request option.
12744
- * @throws {RequiredError}
12745
- */
12746
- getMotionGroups(cell: string, controller: string, options?: RawAxiosRequestConfig): AxiosPromise<MotionGroupInfos> {
12747
- return localVarFp.getMotionGroups(cell, controller, options).then((request) => request(axios, basePath));
12748
- },
12749
- /**
12750
- * 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).
12751
- * @summary Get Inputs/Outputs
12752
- * @param {string} cell Unique identifier addressing a cell in all API calls.
12753
- * @param {string} controller Unique identifier to address a controller in the cell.
12754
- * @param {Array<string>} ios
12755
- * @param {*} [options] Override http request option.
12756
- * @throws {RequiredError}
12757
- */
12758
- listIOs(cell: string, controller: string, ios: Array<string>, options?: RawAxiosRequestConfig): AxiosPromise<Array<IOValue>> {
12759
- return localVarFp.listIOs(cell, controller, ios, options).then((request) => request(axios, basePath));
12760
- },
12761
- /**
12762
- * 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.
12763
- * @summary List Input/Output Descriptions
12764
- * @param {string} cell Unique identifier addressing a cell in all API calls.
12765
- * @param {string} controller Unique identifier to address a controller in the cell.
12766
- * @param {Array<string>} [ios]
12767
- * @param {IODirection} [direction] Return only inputs/outputs with the specified direction.
12768
- * @param {IOValueType} [valueType] Return only inputs/outputs with the specified value type.
12769
- * @param {string} [group] Return only inputs/outputs from the specified group.
12770
- * @param {*} [options] Override http request option.
12771
- * @throws {RequiredError}
12772
- */
12773
- listVirtualRobotIODescriptions(cell: string, controller: string, ios?: Array<string>, direction?: IODirection, valueType?: IOValueType, group?: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<IODescription>> {
12774
- return localVarFp.listVirtualRobotIODescriptions(cell, controller, ios, direction, valueType, group, options).then((request) => request(axios, basePath));
12775
- },
12776
- /**
12777
- * Sets a list of values of a virtual controller inputs/outputs.
12778
- * @summary Set Input/Ouput Values
12779
- * @param {string} cell Unique identifier addressing a cell in all API calls.
12780
- * @param {string} controller Unique identifier to address a controller in the cell.
12781
- * @param {Array<IOValue>} iOValue
12782
- * @param {*} [options] Override http request option.
12783
- * @throws {RequiredError}
12784
- */
12785
- setIOValues(cell: string, controller: string, iOValue: Array<IOValue>, options?: RawAxiosRequestConfig): AxiosPromise<void> {
12786
- return localVarFp.setIOValues(cell, controller, iOValue, options).then((request) => request(axios, basePath));
12787
- },
12788
- /**
12789
- * 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.
12790
- * @summary Set Motion Group State
12791
- * @param {string} cell Unique identifier addressing a cell in all API calls.
12792
- * @param {string} controller Unique identifier to address a controller in the cell.
12793
- * @param {string} motionGroup The motion-group identifier.
12794
- * @param {MotionGroupJoints} motionGroupJoints
12795
- * @param {*} [options] Override http request option.
12796
- * @throws {RequiredError}
12797
- */
12798
- setMotionGroupState(cell: string, controller: string, motionGroup: string, motionGroupJoints: MotionGroupJoints, options?: RawAxiosRequestConfig): AxiosPromise<void> {
12799
- return localVarFp.setMotionGroupState(cell, controller, motionGroup, motionGroupJoints, options).then((request) => request(axios, basePath));
12800
- },
12801
- };
12802
- };
12803
-
12804
- /**
12805
- * VirtualRobotApi - object-oriented interface
12806
- * @export
12807
- * @class VirtualRobotApi
12808
- * @extends {BaseAPI}
12809
- */
12810
- export class VirtualRobotApi extends BaseAPI {
12811
- /**
12812
- * Get the current motion group state which provides values for the joints\' position, velocity and acceleration.
12813
- * @summary Get Motion Group State
12814
- * @param {string} cell Unique identifier addressing a cell in all API calls.
12815
- * @param {string} controller Unique identifier to address a controller in the cell.
12816
- * @param {string} motionGroup The motion-group identifier.
12817
- * @param {*} [options] Override http request option.
12818
- * @throws {RequiredError}
12819
- * @memberof VirtualRobotApi
12820
- */
12821
- public getMotionGroupState(cell: string, controller: string, motionGroup: string, options?: RawAxiosRequestConfig) {
12822
- return VirtualRobotApiFp(this.configuration).getMotionGroupState(cell, controller, motionGroup, options).then((request) => request(this.axios, this.basePath));
12823
- }
12824
-
12825
- /**
12826
- * Gets information on the motion group.
12827
- * @summary Motion Group Description
12828
- * @param {string} cell Unique identifier addressing a cell in all API calls.
12829
- * @param {string} controller Unique identifier to address a controller in the cell.
12830
- * @param {*} [options] Override http request option.
12831
- * @throws {RequiredError}
12832
- * @memberof VirtualRobotApi
12833
- */
12834
- public getMotionGroups(cell: string, controller: string, options?: RawAxiosRequestConfig) {
12835
- return VirtualRobotApiFp(this.configuration).getMotionGroups(cell, controller, options).then((request) => request(this.axios, this.basePath));
12836
- }
12837
-
12838
- /**
12839
- * 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).
12840
- * @summary Get Inputs/Outputs
12841
- * @param {string} cell Unique identifier addressing a cell in all API calls.
12842
- * @param {string} controller Unique identifier to address a controller in the cell.
12843
- * @param {Array<string>} ios
12844
- * @param {*} [options] Override http request option.
12845
- * @throws {RequiredError}
12846
- * @memberof VirtualRobotApi
12847
- */
12848
- public listIOs(cell: string, controller: string, ios: Array<string>, options?: RawAxiosRequestConfig) {
12849
- return VirtualRobotApiFp(this.configuration).listIOs(cell, controller, ios, options).then((request) => request(this.axios, this.basePath));
12850
- }
12851
-
12852
- /**
12853
- * 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.
12854
- * @summary List Input/Output Descriptions
12855
- * @param {string} cell Unique identifier addressing a cell in all API calls.
12856
- * @param {string} controller Unique identifier to address a controller in the cell.
12857
- * @param {Array<string>} [ios]
12858
- * @param {IODirection} [direction] Return only inputs/outputs with the specified direction.
12859
- * @param {IOValueType} [valueType] Return only inputs/outputs with the specified value type.
12860
- * @param {string} [group] Return only inputs/outputs from the specified group.
12861
- * @param {*} [options] Override http request option.
12862
- * @throws {RequiredError}
12863
- * @memberof VirtualRobotApi
12864
- */
12865
- public listVirtualRobotIODescriptions(cell: string, controller: string, ios?: Array<string>, direction?: IODirection, valueType?: IOValueType, group?: string, options?: RawAxiosRequestConfig) {
12866
- return VirtualRobotApiFp(this.configuration).listVirtualRobotIODescriptions(cell, controller, ios, direction, valueType, group, options).then((request) => request(this.axios, this.basePath));
12867
- }
12868
-
12869
- /**
12870
- * Sets a list of values of a virtual controller inputs/outputs.
12871
- * @summary Set Input/Ouput Values
12872
- * @param {string} cell Unique identifier addressing a cell in all API calls.
12873
- * @param {string} controller Unique identifier to address a controller in the cell.
12874
- * @param {Array<IOValue>} iOValue
12875
- * @param {*} [options] Override http request option.
12876
- * @throws {RequiredError}
12877
- * @memberof VirtualRobotApi
12878
- */
12879
- public setIOValues(cell: string, controller: string, iOValue: Array<IOValue>, options?: RawAxiosRequestConfig) {
12880
- return VirtualRobotApiFp(this.configuration).setIOValues(cell, controller, iOValue, options).then((request) => request(this.axios, this.basePath));
12881
- }
12882
-
12883
- /**
12884
- * 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.
12885
- * @summary Set Motion Group State
12886
- * @param {string} cell Unique identifier addressing a cell in all API calls.
12887
- * @param {string} controller Unique identifier to address a controller in the cell.
12888
- * @param {string} motionGroup The motion-group identifier.
12889
- * @param {MotionGroupJoints} motionGroupJoints
12890
- * @param {*} [options] Override http request option.
12891
- * @throws {RequiredError}
12892
- * @memberof VirtualRobotApi
12893
- */
12894
- public setMotionGroupState(cell: string, controller: string, motionGroup: string, motionGroupJoints: MotionGroupJoints, options?: RawAxiosRequestConfig) {
12895
- return VirtualRobotApiFp(this.configuration).setMotionGroupState(cell, controller, motionGroup, motionGroupJoints, options).then((request) => request(this.axios, this.basePath));
12896
- }
12897
- }
12898
-
12899
-
12900
-
12901
- /**
12902
- * VirtualRobotBehaviorApi - axios parameter creator
12903
- * @export
12904
- */
12905
- export const VirtualRobotBehaviorApiAxiosParamCreator = function (configuration?: Configuration) {
12906
- return {
12907
- /**
12908
- * <!-- 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.
12909
- * @summary Stream Joint Configuration
12910
- * @param {string} cell Unique identifier addressing a cell in all API calls.
12911
- * @param {string} controller Unique identifier to address a controller in the cell.
12912
- * @param {ExternalJointStreamDatapoint} externalJointStreamDatapoint
12913
- * @param {*} [options] Override http request option.
12914
- * @throws {RequiredError}
12915
- */
12916
- externalJointsStream: async (cell: string, controller: string, externalJointStreamDatapoint: ExternalJointStreamDatapoint, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
12884
+ getVirtualRobotMounting: async (cell: string, controller: string, motionGroup: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
12917
12885
  // verify required parameter 'cell' is not null or undefined
12918
- assertParamExists('externalJointsStream', 'cell', cell)
12886
+ assertParamExists('getVirtualRobotMounting', 'cell', cell)
12919
12887
  // verify required parameter 'controller' is not null or undefined
12920
- assertParamExists('externalJointsStream', 'controller', controller)
12921
- // verify required parameter 'externalJointStreamDatapoint' is not null or undefined
12922
- assertParamExists('externalJointsStream', 'externalJointStreamDatapoint', externalJointStreamDatapoint)
12923
- const localVarPath = `/cells/{cell}/controllers/{controller}/teach-pendant/motion-groups/external-joints-stream`
12888
+ assertParamExists('getVirtualRobotMounting', 'controller', controller)
12889
+ // verify required parameter 'motionGroup' is not null or undefined
12890
+ assertParamExists('getVirtualRobotMounting', 'motionGroup', motionGroup)
12891
+ const localVarPath = `/cells/{cell}/virtual-controllers/{controller}/motion-groups/{motion-group}/mounting`
12924
12892
  .replace(`{${"cell"}}`, encodeURIComponent(String(cell)))
12925
- .replace(`{${"controller"}}`, encodeURIComponent(String(controller)));
12893
+ .replace(`{${"controller"}}`, encodeURIComponent(String(controller)))
12894
+ .replace(`{${"motion-group"}}`, encodeURIComponent(String(motionGroup)));
12926
12895
  // use dummy base URL string because the URL constructor only accepts absolute URLs.
12927
12896
  const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
12928
12897
  let baseOptions;
@@ -12944,12 +12913,9 @@ export const VirtualRobotBehaviorApiAxiosParamCreator = function (configuration?
12944
12913
 
12945
12914
 
12946
12915
 
12947
- localVarHeaderParameter['Content-Type'] = 'application/json';
12948
-
12949
12916
  setSearchParams(localVarUrlObj, localVarQueryParameter);
12950
12917
  let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
12951
12918
  localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
12952
- localVarRequestOptions.data = serializeDataIfNeeded(externalJointStreamDatapoint, localVarRequestOptions, configuration)
12953
12919
 
12954
12920
  return {
12955
12921
  url: toPathString(localVarUrlObj),
@@ -12957,25 +12923,21 @@ export const VirtualRobotBehaviorApiAxiosParamCreator = function (configuration?
12957
12923
  };
12958
12924
  },
12959
12925
  /**
12960
- * Get the current robot motion group behavior - please see the setter [setMotionGroupBehavior](setMotionGroupBehavior) and the enum for details.
12961
- * @summary Behavior
12926
+ * Lists all coordinate systems on the robot controller.
12927
+ * @summary List Coordinate Systems
12962
12928
  * @param {string} cell Unique identifier addressing a cell in all API calls.
12963
12929
  * @param {string} controller Unique identifier to address a controller in the cell.
12964
- * @param {string} motionGroup The motion-group identifier.
12965
12930
  * @param {*} [options] Override http request option.
12966
12931
  * @throws {RequiredError}
12967
12932
  */
12968
- getMotionGroupBehavior: async (cell: string, controller: string, motionGroup: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
12933
+ listVirtualRobotCoordinateSystems: async (cell: string, controller: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
12969
12934
  // verify required parameter 'cell' is not null or undefined
12970
- assertParamExists('getMotionGroupBehavior', 'cell', cell)
12935
+ assertParamExists('listVirtualRobotCoordinateSystems', 'cell', cell)
12971
12936
  // verify required parameter 'controller' is not null or undefined
12972
- assertParamExists('getMotionGroupBehavior', 'controller', controller)
12973
- // verify required parameter 'motionGroup' is not null or undefined
12974
- assertParamExists('getMotionGroupBehavior', 'motionGroup', motionGroup)
12975
- const localVarPath = `/cells/{cell}/controllers/{controller}/teach-pendant/motion-groups/{motion-group}/behavior`
12937
+ assertParamExists('listVirtualRobotCoordinateSystems', 'controller', controller)
12938
+ const localVarPath = `/cells/{cell}/virtual-controllers/{controller}/coordinate-systems`
12976
12939
  .replace(`{${"cell"}}`, encodeURIComponent(String(cell)))
12977
- .replace(`{${"controller"}}`, encodeURIComponent(String(controller)))
12978
- .replace(`{${"motion-group"}}`, encodeURIComponent(String(motionGroup)));
12940
+ .replace(`{${"controller"}}`, encodeURIComponent(String(controller)));
12979
12941
  // use dummy base URL string because the URL constructor only accepts absolute URLs.
12980
12942
  const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
12981
12943
  let baseOptions;
@@ -13007,23 +12969,22 @@ export const VirtualRobotBehaviorApiAxiosParamCreator = function (configuration?
13007
12969
  };
13008
12970
  },
13009
12971
  /**
13010
- * Switch robot motion group behavior.
13011
- * @summary Switch Behavior
12972
+ * Lists TCPs of the motion group. An empty TCP list is valid, for example for external axes.
12973
+ * @summary List TCPs
13012
12974
  * @param {string} cell Unique identifier addressing a cell in all API calls.
13013
12975
  * @param {string} controller Unique identifier to address a controller in the cell.
13014
12976
  * @param {string} motionGroup The motion-group identifier.
13015
- * @param {Behavior} [behavior]
13016
12977
  * @param {*} [options] Override http request option.
13017
12978
  * @throws {RequiredError}
13018
12979
  */
13019
- setMotionGroupBehavior: async (cell: string, controller: string, motionGroup: string, behavior?: Behavior, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
12980
+ listVirtualRobotTcps: async (cell: string, controller: string, motionGroup: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
13020
12981
  // verify required parameter 'cell' is not null or undefined
13021
- assertParamExists('setMotionGroupBehavior', 'cell', cell)
12982
+ assertParamExists('listVirtualRobotTcps', 'cell', cell)
13022
12983
  // verify required parameter 'controller' is not null or undefined
13023
- assertParamExists('setMotionGroupBehavior', 'controller', controller)
12984
+ assertParamExists('listVirtualRobotTcps', 'controller', controller)
13024
12985
  // verify required parameter 'motionGroup' is not null or undefined
13025
- assertParamExists('setMotionGroupBehavior', 'motionGroup', motionGroup)
13026
- const localVarPath = `/cells/{cell}/controllers/{controller}/teach-pendant/motion-groups/{motion-group}/behavior`
12986
+ assertParamExists('listVirtualRobotTcps', 'motionGroup', motionGroup)
12987
+ const localVarPath = `/cells/{cell}/virtual-controllers/{controller}/motion-groups/{motion-group}/tcps`
13027
12988
  .replace(`{${"cell"}}`, encodeURIComponent(String(cell)))
13028
12989
  .replace(`{${"controller"}}`, encodeURIComponent(String(controller)))
13029
12990
  .replace(`{${"motion-group"}}`, encodeURIComponent(String(motionGroup)));
@@ -13034,7 +12995,7 @@ export const VirtualRobotBehaviorApiAxiosParamCreator = function (configuration?
13034
12995
  baseOptions = configuration.baseOptions;
13035
12996
  }
13036
12997
 
13037
- const localVarRequestOptions = { method: 'PUT', ...baseOptions, ...options};
12998
+ const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
13038
12999
  const localVarHeaderParameter = {} as any;
13039
13000
  const localVarQueryParameter = {} as any;
13040
13001
 
@@ -13046,10 +13007,6 @@ export const VirtualRobotBehaviorApiAxiosParamCreator = function (configuration?
13046
13007
  // http bearer authentication required
13047
13008
  await setBearerAuthToObject(localVarHeaderParameter, configuration)
13048
13009
 
13049
- if (behavior !== undefined) {
13050
- localVarQueryParameter['behavior'] = behavior;
13051
- }
13052
-
13053
13010
 
13054
13011
 
13055
13012
  setSearchParams(localVarUrlObj, localVarQueryParameter);
@@ -13061,185 +13018,21 @@ export const VirtualRobotBehaviorApiAxiosParamCreator = function (configuration?
13061
13018
  options: localVarRequestOptions,
13062
13019
  };
13063
13020
  },
13064
- }
13065
- };
13066
-
13067
- /**
13068
- * VirtualRobotBehaviorApi - functional programming interface
13069
- * @export
13070
- */
13071
- export const VirtualRobotBehaviorApiFp = function(configuration?: Configuration) {
13072
- const localVarAxiosParamCreator = VirtualRobotBehaviorApiAxiosParamCreator(configuration)
13073
- return {
13074
- /**
13075
- * <!-- 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.
13076
- * @summary Stream Joint Configuration
13077
- * @param {string} cell Unique identifier addressing a cell in all API calls.
13078
- * @param {string} controller Unique identifier to address a controller in the cell.
13079
- * @param {ExternalJointStreamDatapoint} externalJointStreamDatapoint
13080
- * @param {*} [options] Override http request option.
13081
- * @throws {RequiredError}
13082
- */
13083
- async externalJointsStream(cell: string, controller: string, externalJointStreamDatapoint: ExternalJointStreamDatapoint, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<MotionGroupJoints>> {
13084
- const localVarAxiosArgs = await localVarAxiosParamCreator.externalJointsStream(cell, controller, externalJointStreamDatapoint, options);
13085
- const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
13086
- const localVarOperationServerBasePath = operationServerMap['VirtualRobotBehaviorApi.externalJointsStream']?.[localVarOperationServerIndex]?.url;
13087
- return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
13088
- },
13089
- /**
13090
- * Get the current robot motion group behavior - please see the setter [setMotionGroupBehavior](setMotionGroupBehavior) and the enum for details.
13091
- * @summary Behavior
13092
- * @param {string} cell Unique identifier addressing a cell in all API calls.
13093
- * @param {string} controller Unique identifier to address a controller in the cell.
13094
- * @param {string} motionGroup The motion-group identifier.
13095
- * @param {*} [options] Override http request option.
13096
- * @throws {RequiredError}
13097
- */
13098
- async getMotionGroupBehavior(cell: string, controller: string, motionGroup: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<MotionGroupBehaviorGetter>> {
13099
- const localVarAxiosArgs = await localVarAxiosParamCreator.getMotionGroupBehavior(cell, controller, motionGroup, options);
13100
- const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
13101
- const localVarOperationServerBasePath = operationServerMap['VirtualRobotBehaviorApi.getMotionGroupBehavior']?.[localVarOperationServerIndex]?.url;
13102
- return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
13103
- },
13104
- /**
13105
- * Switch robot motion group behavior.
13106
- * @summary Switch Behavior
13107
- * @param {string} cell Unique identifier addressing a cell in all API calls.
13108
- * @param {string} controller Unique identifier to address a controller in the cell.
13109
- * @param {string} motionGroup The motion-group identifier.
13110
- * @param {Behavior} [behavior]
13111
- * @param {*} [options] Override http request option.
13112
- * @throws {RequiredError}
13113
- */
13114
- async setMotionGroupBehavior(cell: string, controller: string, motionGroup: string, behavior?: Behavior, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> {
13115
- const localVarAxiosArgs = await localVarAxiosParamCreator.setMotionGroupBehavior(cell, controller, motionGroup, behavior, options);
13116
- const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
13117
- const localVarOperationServerBasePath = operationServerMap['VirtualRobotBehaviorApi.setMotionGroupBehavior']?.[localVarOperationServerIndex]?.url;
13118
- return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
13119
- },
13120
- }
13121
- };
13122
-
13123
- /**
13124
- * VirtualRobotBehaviorApi - factory interface
13125
- * @export
13126
- */
13127
- export const VirtualRobotBehaviorApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
13128
- const localVarFp = VirtualRobotBehaviorApiFp(configuration)
13129
- return {
13130
- /**
13131
- * <!-- 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.
13132
- * @summary Stream Joint Configuration
13133
- * @param {string} cell Unique identifier addressing a cell in all API calls.
13134
- * @param {string} controller Unique identifier to address a controller in the cell.
13135
- * @param {ExternalJointStreamDatapoint} externalJointStreamDatapoint
13136
- * @param {*} [options] Override http request option.
13137
- * @throws {RequiredError}
13138
- */
13139
- externalJointsStream(cell: string, controller: string, externalJointStreamDatapoint: ExternalJointStreamDatapoint, options?: RawAxiosRequestConfig): AxiosPromise<MotionGroupJoints> {
13140
- return localVarFp.externalJointsStream(cell, controller, externalJointStreamDatapoint, options).then((request) => request(axios, basePath));
13141
- },
13142
- /**
13143
- * Get the current robot motion group behavior - please see the setter [setMotionGroupBehavior](setMotionGroupBehavior) and the enum for details.
13144
- * @summary Behavior
13145
- * @param {string} cell Unique identifier addressing a cell in all API calls.
13146
- * @param {string} controller Unique identifier to address a controller in the cell.
13147
- * @param {string} motionGroup The motion-group identifier.
13148
- * @param {*} [options] Override http request option.
13149
- * @throws {RequiredError}
13150
- */
13151
- getMotionGroupBehavior(cell: string, controller: string, motionGroup: string, options?: RawAxiosRequestConfig): AxiosPromise<MotionGroupBehaviorGetter> {
13152
- return localVarFp.getMotionGroupBehavior(cell, controller, motionGroup, options).then((request) => request(axios, basePath));
13153
- },
13154
- /**
13155
- * Switch robot motion group behavior.
13156
- * @summary Switch Behavior
13157
- * @param {string} cell Unique identifier addressing a cell in all API calls.
13158
- * @param {string} controller Unique identifier to address a controller in the cell.
13159
- * @param {string} motionGroup The motion-group identifier.
13160
- * @param {Behavior} [behavior]
13161
- * @param {*} [options] Override http request option.
13162
- * @throws {RequiredError}
13163
- */
13164
- setMotionGroupBehavior(cell: string, controller: string, motionGroup: string, behavior?: Behavior, options?: RawAxiosRequestConfig): AxiosPromise<void> {
13165
- return localVarFp.setMotionGroupBehavior(cell, controller, motionGroup, behavior, options).then((request) => request(axios, basePath));
13166
- },
13167
- };
13168
- };
13169
-
13170
- /**
13171
- * VirtualRobotBehaviorApi - object-oriented interface
13172
- * @export
13173
- * @class VirtualRobotBehaviorApi
13174
- * @extends {BaseAPI}
13175
- */
13176
- export class VirtualRobotBehaviorApi extends BaseAPI {
13177
- /**
13178
- * <!-- 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.
13179
- * @summary Stream Joint Configuration
13180
- * @param {string} cell Unique identifier addressing a cell in all API calls.
13181
- * @param {string} controller Unique identifier to address a controller in the cell.
13182
- * @param {ExternalJointStreamDatapoint} externalJointStreamDatapoint
13183
- * @param {*} [options] Override http request option.
13184
- * @throws {RequiredError}
13185
- * @memberof VirtualRobotBehaviorApi
13186
- */
13187
- public externalJointsStream(cell: string, controller: string, externalJointStreamDatapoint: ExternalJointStreamDatapoint, options?: RawAxiosRequestConfig) {
13188
- return VirtualRobotBehaviorApiFp(this.configuration).externalJointsStream(cell, controller, externalJointStreamDatapoint, options).then((request) => request(this.axios, this.basePath));
13189
- }
13190
-
13191
- /**
13192
- * Get the current robot motion group behavior - please see the setter [setMotionGroupBehavior](setMotionGroupBehavior) and the enum for details.
13193
- * @summary Behavior
13194
- * @param {string} cell Unique identifier addressing a cell in all API calls.
13195
- * @param {string} controller Unique identifier to address a controller in the cell.
13196
- * @param {string} motionGroup The motion-group identifier.
13197
- * @param {*} [options] Override http request option.
13198
- * @throws {RequiredError}
13199
- * @memberof VirtualRobotBehaviorApi
13200
- */
13201
- public getMotionGroupBehavior(cell: string, controller: string, motionGroup: string, options?: RawAxiosRequestConfig) {
13202
- return VirtualRobotBehaviorApiFp(this.configuration).getMotionGroupBehavior(cell, controller, motionGroup, options).then((request) => request(this.axios, this.basePath));
13203
- }
13204
-
13205
- /**
13206
- * Switch robot motion group behavior.
13207
- * @summary Switch Behavior
13208
- * @param {string} cell Unique identifier addressing a cell in all API calls.
13209
- * @param {string} controller Unique identifier to address a controller in the cell.
13210
- * @param {string} motionGroup The motion-group identifier.
13211
- * @param {Behavior} [behavior]
13212
- * @param {*} [options] Override http request option.
13213
- * @throws {RequiredError}
13214
- * @memberof VirtualRobotBehaviorApi
13215
- */
13216
- public setMotionGroupBehavior(cell: string, controller: string, motionGroup: string, behavior?: Behavior, options?: RawAxiosRequestConfig) {
13217
- return VirtualRobotBehaviorApiFp(this.configuration).setMotionGroupBehavior(cell, controller, motionGroup, behavior, options).then((request) => request(this.axios, this.basePath));
13218
- }
13219
- }
13220
-
13221
-
13222
-
13223
- /**
13224
- * VirtualRobotModeApi - axios parameter creator
13225
- * @export
13226
- */
13227
- export const VirtualRobotModeApiAxiosParamCreator = function (configuration?: Configuration) {
13228
- return {
13229
13021
  /**
13230
- * Get the cycle time of controller communication in [ms].
13231
- * @summary Cycle Time
13022
+ * 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.
13023
+ * @summary Push or Release Emergency Stop
13232
13024
  * @param {string} cell Unique identifier addressing a cell in all API calls.
13233
13025
  * @param {string} controller Unique identifier to address a controller in the cell.
13026
+ * @param {boolean} [active]
13234
13027
  * @param {*} [options] Override http request option.
13235
13028
  * @throws {RequiredError}
13236
13029
  */
13237
- getCycleTime: async (cell: string, controller: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
13030
+ setEmergencyStop: async (cell: string, controller: string, active?: boolean, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
13238
13031
  // verify required parameter 'cell' is not null or undefined
13239
- assertParamExists('getCycleTime', 'cell', cell)
13032
+ assertParamExists('setEmergencyStop', 'cell', cell)
13240
13033
  // verify required parameter 'controller' is not null or undefined
13241
- assertParamExists('getCycleTime', 'controller', controller)
13242
- const localVarPath = `/cells/{cell}/controllers/{controller}/teach-pendant/cycle-time`
13034
+ assertParamExists('setEmergencyStop', 'controller', controller)
13035
+ const localVarPath = `/cells/{cell}/virtual-controllers/{controller}/emergency-stop`
13243
13036
  .replace(`{${"cell"}}`, encodeURIComponent(String(cell)))
13244
13037
  .replace(`{${"controller"}}`, encodeURIComponent(String(controller)));
13245
13038
  // use dummy base URL string because the URL constructor only accepts absolute URLs.
@@ -13249,7 +13042,7 @@ export const VirtualRobotModeApiAxiosParamCreator = function (configuration?: Co
13249
13042
  baseOptions = configuration.baseOptions;
13250
13043
  }
13251
13044
 
13252
- const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
13045
+ const localVarRequestOptions = { method: 'PUT', ...baseOptions, ...options};
13253
13046
  const localVarHeaderParameter = {} as any;
13254
13047
  const localVarQueryParameter = {} as any;
13255
13048
 
@@ -13261,52 +13054,10 @@ export const VirtualRobotModeApiAxiosParamCreator = function (configuration?: Co
13261
13054
  // http bearer authentication required
13262
13055
  await setBearerAuthToObject(localVarHeaderParameter, configuration)
13263
13056
 
13264
-
13265
-
13266
- setSearchParams(localVarUrlObj, localVarQueryParameter);
13267
- let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
13268
- localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
13269
-
13270
- return {
13271
- url: toPathString(localVarUrlObj),
13272
- options: localVarRequestOptions,
13273
- };
13274
- },
13275
- /**
13276
- * 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.
13277
- * @summary Get Emergency Stop State
13278
- * @param {string} cell Unique identifier addressing a cell in all API calls.
13279
- * @param {string} controller Unique identifier to address a controller in the cell.
13280
- * @param {*} [options] Override http request option.
13281
- * @throws {RequiredError}
13282
- */
13283
- getEmergencyStop: async (cell: string, controller: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
13284
- // verify required parameter 'cell' is not null or undefined
13285
- assertParamExists('getEmergencyStop', 'cell', cell)
13286
- // verify required parameter 'controller' is not null or undefined
13287
- assertParamExists('getEmergencyStop', 'controller', controller)
13288
- const localVarPath = `/cells/{cell}/controllers/{controller}/teach-pendant/emergency-stop`
13289
- .replace(`{${"cell"}}`, encodeURIComponent(String(cell)))
13290
- .replace(`{${"controller"}}`, encodeURIComponent(String(controller)));
13291
- // use dummy base URL string because the URL constructor only accepts absolute URLs.
13292
- const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
13293
- let baseOptions;
13294
- if (configuration) {
13295
- baseOptions = configuration.baseOptions;
13057
+ if (active !== undefined) {
13058
+ localVarQueryParameter['active'] = active;
13296
13059
  }
13297
13060
 
13298
- const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
13299
- const localVarHeaderParameter = {} as any;
13300
- const localVarQueryParameter = {} as any;
13301
-
13302
- // authentication BasicAuth required
13303
- // http basic authentication required
13304
- setBasicAuthToObject(localVarRequestOptions, configuration)
13305
-
13306
- // authentication BearerAuth required
13307
- // http bearer authentication required
13308
- await setBearerAuthToObject(localVarHeaderParameter, configuration)
13309
-
13310
13061
 
13311
13062
 
13312
13063
  setSearchParams(localVarUrlObj, localVarQueryParameter);
@@ -13319,21 +13070,28 @@ export const VirtualRobotModeApiAxiosParamCreator = function (configuration?: Co
13319
13070
  };
13320
13071
  },
13321
13072
  /**
13322
- * 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.
13323
- * @summary Get Operation Mode
13073
+ * 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.
13074
+ * @summary Set Motion Group State
13324
13075
  * @param {string} cell Unique identifier addressing a cell in all API calls.
13325
13076
  * @param {string} controller Unique identifier to address a controller in the cell.
13077
+ * @param {string} motionGroup The motion-group identifier.
13078
+ * @param {MotionGroupJoints} motionGroupJoints
13326
13079
  * @param {*} [options] Override http request option.
13327
13080
  * @throws {RequiredError}
13328
13081
  */
13329
- getOperationMode: async (cell: string, controller: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
13082
+ setMotionGroupState: async (cell: string, controller: string, motionGroup: string, motionGroupJoints: MotionGroupJoints, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
13330
13083
  // verify required parameter 'cell' is not null or undefined
13331
- assertParamExists('getOperationMode', 'cell', cell)
13084
+ assertParamExists('setMotionGroupState', 'cell', cell)
13332
13085
  // verify required parameter 'controller' is not null or undefined
13333
- assertParamExists('getOperationMode', 'controller', controller)
13334
- const localVarPath = `/cells/{cell}/controllers/{controller}/teach-pendant/operationmode`
13086
+ assertParamExists('setMotionGroupState', 'controller', controller)
13087
+ // verify required parameter 'motionGroup' is not null or undefined
13088
+ assertParamExists('setMotionGroupState', 'motionGroup', motionGroup)
13089
+ // verify required parameter 'motionGroupJoints' is not null or undefined
13090
+ assertParamExists('setMotionGroupState', 'motionGroupJoints', motionGroupJoints)
13091
+ const localVarPath = `/cells/{cell}/virtual-controllers/{controller}/motion-groups/{motion-group}/state`
13335
13092
  .replace(`{${"cell"}}`, encodeURIComponent(String(cell)))
13336
- .replace(`{${"controller"}}`, encodeURIComponent(String(controller)));
13093
+ .replace(`{${"controller"}}`, encodeURIComponent(String(controller)))
13094
+ .replace(`{${"motion-group"}}`, encodeURIComponent(String(motionGroup)));
13337
13095
  // use dummy base URL string because the URL constructor only accepts absolute URLs.
13338
13096
  const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
13339
13097
  let baseOptions;
@@ -13341,7 +13099,7 @@ export const VirtualRobotModeApiAxiosParamCreator = function (configuration?: Co
13341
13099
  baseOptions = configuration.baseOptions;
13342
13100
  }
13343
13101
 
13344
- const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
13102
+ const localVarRequestOptions = { method: 'PUT', ...baseOptions, ...options};
13345
13103
  const localVarHeaderParameter = {} as any;
13346
13104
  const localVarQueryParameter = {} as any;
13347
13105
 
@@ -13355,9 +13113,12 @@ export const VirtualRobotModeApiAxiosParamCreator = function (configuration?: Co
13355
13113
 
13356
13114
 
13357
13115
 
13116
+ localVarHeaderParameter['Content-Type'] = 'application/json';
13117
+
13358
13118
  setSearchParams(localVarUrlObj, localVarQueryParameter);
13359
13119
  let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
13360
13120
  localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
13121
+ localVarRequestOptions.data = serializeDataIfNeeded(motionGroupJoints, localVarRequestOptions, configuration)
13361
13122
 
13362
13123
  return {
13363
13124
  url: toPathString(localVarUrlObj),
@@ -13365,20 +13126,22 @@ export const VirtualRobotModeApiAxiosParamCreator = function (configuration?: Co
13365
13126
  };
13366
13127
  },
13367
13128
  /**
13368
- * 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.
13369
- * @summary Push or Release Emergency Stop
13129
+ * 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.
13130
+ * @summary Set Operation Mode
13370
13131
  * @param {string} cell Unique identifier addressing a cell in all API calls.
13371
13132
  * @param {string} controller Unique identifier to address a controller in the cell.
13372
- * @param {boolean} [active]
13133
+ * @param {OperationMode} mode
13373
13134
  * @param {*} [options] Override http request option.
13374
13135
  * @throws {RequiredError}
13375
13136
  */
13376
- setEmergencyStop: async (cell: string, controller: string, active?: boolean, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
13137
+ setOperationMode: async (cell: string, controller: string, mode: OperationMode, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
13377
13138
  // verify required parameter 'cell' is not null or undefined
13378
- assertParamExists('setEmergencyStop', 'cell', cell)
13139
+ assertParamExists('setOperationMode', 'cell', cell)
13379
13140
  // verify required parameter 'controller' is not null or undefined
13380
- assertParamExists('setEmergencyStop', 'controller', controller)
13381
- const localVarPath = `/cells/{cell}/controllers/{controller}/teach-pendant/emergency-stop`
13141
+ assertParamExists('setOperationMode', 'controller', controller)
13142
+ // verify required parameter 'mode' is not null or undefined
13143
+ assertParamExists('setOperationMode', 'mode', mode)
13144
+ const localVarPath = `/cells/{cell}/virtual-controllers/{controller}/operationmode`
13382
13145
  .replace(`{${"cell"}}`, encodeURIComponent(String(cell)))
13383
13146
  .replace(`{${"controller"}}`, encodeURIComponent(String(controller)));
13384
13147
  // use dummy base URL string because the URL constructor only accepts absolute URLs.
@@ -13400,8 +13163,8 @@ export const VirtualRobotModeApiAxiosParamCreator = function (configuration?: Co
13400
13163
  // http bearer authentication required
13401
13164
  await setBearerAuthToObject(localVarHeaderParameter, configuration)
13402
13165
 
13403
- if (active !== undefined) {
13404
- localVarQueryParameter['active'] = active;
13166
+ if (mode !== undefined) {
13167
+ localVarQueryParameter['mode'] = mode;
13405
13168
  }
13406
13169
 
13407
13170
 
@@ -13416,24 +13179,28 @@ export const VirtualRobotModeApiAxiosParamCreator = function (configuration?: Co
13416
13179
  };
13417
13180
  },
13418
13181
  /**
13419
- * 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.
13420
- * @summary Set Operation Mode
13182
+ * 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.
13183
+ * @summary Set Mounting
13421
13184
  * @param {string} cell Unique identifier addressing a cell in all API calls.
13422
13185
  * @param {string} controller Unique identifier to address a controller in the cell.
13423
- * @param {OperationMode} mode
13186
+ * @param {string} motionGroup The motion-group identifier.
13187
+ * @param {CoordinateSystem} coordinateSystem
13424
13188
  * @param {*} [options] Override http request option.
13425
13189
  * @throws {RequiredError}
13426
13190
  */
13427
- setOperationMode: async (cell: string, controller: string, mode: OperationMode, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
13191
+ setVirtualRobotMounting: async (cell: string, controller: string, motionGroup: string, coordinateSystem: CoordinateSystem, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
13428
13192
  // verify required parameter 'cell' is not null or undefined
13429
- assertParamExists('setOperationMode', 'cell', cell)
13193
+ assertParamExists('setVirtualRobotMounting', 'cell', cell)
13430
13194
  // verify required parameter 'controller' is not null or undefined
13431
- assertParamExists('setOperationMode', 'controller', controller)
13432
- // verify required parameter 'mode' is not null or undefined
13433
- assertParamExists('setOperationMode', 'mode', mode)
13434
- const localVarPath = `/cells/{cell}/controllers/{controller}/teach-pendant/operationmode`
13195
+ assertParamExists('setVirtualRobotMounting', 'controller', controller)
13196
+ // verify required parameter 'motionGroup' is not null or undefined
13197
+ assertParamExists('setVirtualRobotMounting', 'motionGroup', motionGroup)
13198
+ // verify required parameter 'coordinateSystem' is not null or undefined
13199
+ assertParamExists('setVirtualRobotMounting', 'coordinateSystem', coordinateSystem)
13200
+ const localVarPath = `/cells/{cell}/virtual-controllers/{controller}/motion-groups/{motion-group}/mounting`
13435
13201
  .replace(`{${"cell"}}`, encodeURIComponent(String(cell)))
13436
- .replace(`{${"controller"}}`, encodeURIComponent(String(controller)));
13202
+ .replace(`{${"controller"}}`, encodeURIComponent(String(controller)))
13203
+ .replace(`{${"motion-group"}}`, encodeURIComponent(String(motionGroup)));
13437
13204
  // use dummy base URL string because the URL constructor only accepts absolute URLs.
13438
13205
  const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
13439
13206
  let baseOptions;
@@ -13453,15 +13220,14 @@ export const VirtualRobotModeApiAxiosParamCreator = function (configuration?: Co
13453
13220
  // http bearer authentication required
13454
13221
  await setBearerAuthToObject(localVarHeaderParameter, configuration)
13455
13222
 
13456
- if (mode !== undefined) {
13457
- localVarQueryParameter['mode'] = mode;
13458
- }
13459
-
13460
13223
 
13461
13224
 
13225
+ localVarHeaderParameter['Content-Type'] = 'application/json';
13226
+
13462
13227
  setSearchParams(localVarUrlObj, localVarQueryParameter);
13463
13228
  let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
13464
13229
  localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
13230
+ localVarRequestOptions.data = serializeDataIfNeeded(coordinateSystem, localVarRequestOptions, configuration)
13465
13231
 
13466
13232
  return {
13467
13233
  url: toPathString(localVarUrlObj),
@@ -13472,42 +13238,122 @@ export const VirtualRobotModeApiAxiosParamCreator = function (configuration?: Co
13472
13238
  };
13473
13239
 
13474
13240
  /**
13475
- * VirtualRobotModeApi - functional programming interface
13241
+ * VirtualControllerApi - functional programming interface
13476
13242
  * @export
13477
13243
  */
13478
- export const VirtualRobotModeApiFp = function(configuration?: Configuration) {
13479
- const localVarAxiosParamCreator = VirtualRobotModeApiAxiosParamCreator(configuration)
13244
+ export const VirtualControllerApiFp = function(configuration?: Configuration) {
13245
+ const localVarAxiosParamCreator = VirtualControllerApiAxiosParamCreator(configuration)
13480
13246
  return {
13481
13247
  /**
13482
- * Get the cycle time of controller communication in [ms].
13483
- * @summary Cycle Time
13248
+ * Adds a coordinate system to the robot controller.
13249
+ * @summary Add Coordinate Systems
13484
13250
  * @param {string} cell Unique identifier addressing a cell in all API calls.
13485
13251
  * @param {string} controller Unique identifier to address a controller in the cell.
13252
+ * @param {string} coordinateSystem Unique identifier addressing a coordinate system.
13253
+ * @param {CoordinateSystemData} coordinateSystemData
13486
13254
  * @param {*} [options] Override http request option.
13487
13255
  * @throws {RequiredError}
13488
13256
  */
13489
- async getCycleTime(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CycleTime>> {
13490
- const localVarAxiosArgs = await localVarAxiosParamCreator.getCycleTime(cell, controller, options);
13257
+ async addVirtualRobotCoordinateSystem(cell: string, controller: string, coordinateSystem: string, coordinateSystemData: CoordinateSystemData, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> {
13258
+ const localVarAxiosArgs = await localVarAxiosParamCreator.addVirtualRobotCoordinateSystem(cell, controller, coordinateSystem, coordinateSystemData, options);
13491
13259
  const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
13492
- const localVarOperationServerBasePath = operationServerMap['VirtualRobotModeApi.getCycleTime']?.[localVarOperationServerIndex]?.url;
13260
+ const localVarOperationServerBasePath = operationServerMap['VirtualControllerApi.addVirtualRobotCoordinateSystem']?.[localVarOperationServerIndex]?.url;
13493
13261
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
13494
13262
  },
13495
13263
  /**
13496
- * 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.
13497
- * @summary Get Emergency Stop State
13264
+ * 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.
13265
+ * @summary Add TCP
13498
13266
  * @param {string} cell Unique identifier addressing a cell in all API calls.
13499
13267
  * @param {string} controller Unique identifier to address a controller in the cell.
13268
+ * @param {string} motionGroup The motion-group identifier.
13269
+ * @param {string} tcp The unique identifier of a TCP.
13270
+ * @param {RobotTcpData} robotTcpData
13500
13271
  * @param {*} [options] Override http request option.
13501
13272
  * @throws {RequiredError}
13502
13273
  */
13503
- async getEmergencyStop(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Flag>> {
13504
- const localVarAxiosArgs = await localVarAxiosParamCreator.getEmergencyStop(cell, controller, options);
13274
+ async addVirtualRobotTcp(cell: string, controller: string, motionGroup: string, tcp: string, robotTcpData: RobotTcpData, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> {
13275
+ const localVarAxiosArgs = await localVarAxiosParamCreator.addVirtualRobotTcp(cell, controller, motionGroup, tcp, robotTcpData, options);
13505
13276
  const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
13506
- const localVarOperationServerBasePath = operationServerMap['VirtualRobotModeApi.getEmergencyStop']?.[localVarOperationServerIndex]?.url;
13277
+ const localVarOperationServerBasePath = operationServerMap['VirtualControllerApi.addVirtualRobotTcp']?.[localVarOperationServerIndex]?.url;
13507
13278
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
13508
13279
  },
13509
13280
  /**
13510
- * 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.
13281
+ * 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.
13282
+ * @summary Remove Coordinate System
13283
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
13284
+ * @param {string} controller Unique identifier to address a controller in the cell.
13285
+ * @param {string} coordinateSystem Unique identifier addressing a coordinate system.
13286
+ * @param {boolean} [deleteDependent] If true, all dependent coordinate systems will be deleted as well.
13287
+ * @param {*} [options] Override http request option.
13288
+ * @throws {RequiredError}
13289
+ */
13290
+ async deleteVirtualRobotCoordinateSystem(cell: string, controller: string, coordinateSystem: string, deleteDependent?: boolean, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> {
13291
+ const localVarAxiosArgs = await localVarAxiosParamCreator.deleteVirtualRobotCoordinateSystem(cell, controller, coordinateSystem, deleteDependent, options);
13292
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
13293
+ const localVarOperationServerBasePath = operationServerMap['VirtualControllerApi.deleteVirtualRobotCoordinateSystem']?.[localVarOperationServerIndex]?.url;
13294
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
13295
+ },
13296
+ /**
13297
+ * Removes the TCP from the motion group. An unknown TCP is a valid input.
13298
+ * @summary Remove TCP
13299
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
13300
+ * @param {string} controller Unique identifier to address a controller in the cell.
13301
+ * @param {string} motionGroup The motion-group identifier.
13302
+ * @param {string} tcp The unique identifier of a TCP.
13303
+ * @param {*} [options] Override http request option.
13304
+ * @throws {RequiredError}
13305
+ */
13306
+ async deleteVirtualRobotTcp(cell: string, controller: string, motionGroup: string, tcp: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> {
13307
+ const localVarAxiosArgs = await localVarAxiosParamCreator.deleteVirtualRobotTcp(cell, controller, motionGroup, tcp, options);
13308
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
13309
+ const localVarOperationServerBasePath = operationServerMap['VirtualControllerApi.deleteVirtualRobotTcp']?.[localVarOperationServerIndex]?.url;
13310
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
13311
+ },
13312
+ /**
13313
+ * 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.
13314
+ * @summary Get Emergency Stop State
13315
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
13316
+ * @param {string} controller Unique identifier to address a controller in the cell.
13317
+ * @param {*} [options] Override http request option.
13318
+ * @throws {RequiredError}
13319
+ */
13320
+ async getEmergencyStop(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Flag>> {
13321
+ const localVarAxiosArgs = await localVarAxiosParamCreator.getEmergencyStop(cell, controller, options);
13322
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
13323
+ const localVarOperationServerBasePath = operationServerMap['VirtualControllerApi.getEmergencyStop']?.[localVarOperationServerIndex]?.url;
13324
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
13325
+ },
13326
+ /**
13327
+ * Get the current motion group state which provides values for the joints\' position, velocity and acceleration.
13328
+ * @summary Get Motion Group State
13329
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
13330
+ * @param {string} controller Unique identifier to address a controller in the cell.
13331
+ * @param {string} motionGroup The motion-group identifier.
13332
+ * @param {*} [options] Override http request option.
13333
+ * @throws {RequiredError}
13334
+ */
13335
+ async getMotionGroupState(cell: string, controller: string, motionGroup: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<MotionGroupJoints>> {
13336
+ const localVarAxiosArgs = await localVarAxiosParamCreator.getMotionGroupState(cell, controller, motionGroup, options);
13337
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
13338
+ const localVarOperationServerBasePath = operationServerMap['VirtualControllerApi.getMotionGroupState']?.[localVarOperationServerIndex]?.url;
13339
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
13340
+ },
13341
+ /**
13342
+ * Gets information on the motion group.
13343
+ * @summary Motion Group Description
13344
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
13345
+ * @param {string} controller Unique identifier to address a controller in the cell.
13346
+ * @param {*} [options] Override http request option.
13347
+ * @throws {RequiredError}
13348
+ */
13349
+ async getMotionGroups(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<MotionGroupInfo>>> {
13350
+ const localVarAxiosArgs = await localVarAxiosParamCreator.getMotionGroups(cell, controller, options);
13351
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
13352
+ const localVarOperationServerBasePath = operationServerMap['VirtualControllerApi.getMotionGroups']?.[localVarOperationServerIndex]?.url;
13353
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
13354
+ },
13355
+ /**
13356
+ * 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.
13511
13357
  * @summary Get Operation Mode
13512
13358
  * @param {string} cell Unique identifier addressing a cell in all API calls.
13513
13359
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -13517,7 +13363,51 @@ export const VirtualRobotModeApiFp = function(configuration?: Configuration) {
13517
13363
  async getOperationMode(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<OpMode>> {
13518
13364
  const localVarAxiosArgs = await localVarAxiosParamCreator.getOperationMode(cell, controller, options);
13519
13365
  const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
13520
- const localVarOperationServerBasePath = operationServerMap['VirtualRobotModeApi.getOperationMode']?.[localVarOperationServerIndex]?.url;
13366
+ const localVarOperationServerBasePath = operationServerMap['VirtualControllerApi.getOperationMode']?.[localVarOperationServerIndex]?.url;
13367
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
13368
+ },
13369
+ /**
13370
+ * Gets motion group mounting. The motion group is based on the origin of the returned coordinate system.
13371
+ * @summary Get Mounting
13372
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
13373
+ * @param {string} controller Unique identifier to address a controller in the cell.
13374
+ * @param {string} motionGroup The motion-group identifier.
13375
+ * @param {*} [options] Override http request option.
13376
+ * @throws {RequiredError}
13377
+ */
13378
+ async getVirtualRobotMounting(cell: string, controller: string, motionGroup: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CoordinateSystem>> {
13379
+ const localVarAxiosArgs = await localVarAxiosParamCreator.getVirtualRobotMounting(cell, controller, motionGroup, options);
13380
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
13381
+ const localVarOperationServerBasePath = operationServerMap['VirtualControllerApi.getVirtualRobotMounting']?.[localVarOperationServerIndex]?.url;
13382
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
13383
+ },
13384
+ /**
13385
+ * Lists all coordinate systems on the robot controller.
13386
+ * @summary List Coordinate Systems
13387
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
13388
+ * @param {string} controller Unique identifier to address a controller in the cell.
13389
+ * @param {*} [options] Override http request option.
13390
+ * @throws {RequiredError}
13391
+ */
13392
+ async listVirtualRobotCoordinateSystems(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<CoordinateSystem>>> {
13393
+ const localVarAxiosArgs = await localVarAxiosParamCreator.listVirtualRobotCoordinateSystems(cell, controller, options);
13394
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
13395
+ const localVarOperationServerBasePath = operationServerMap['VirtualControllerApi.listVirtualRobotCoordinateSystems']?.[localVarOperationServerIndex]?.url;
13396
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
13397
+ },
13398
+ /**
13399
+ * Lists TCPs of the motion group. An empty TCP list is valid, for example for external axes.
13400
+ * @summary List TCPs
13401
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
13402
+ * @param {string} controller Unique identifier to address a controller in the cell.
13403
+ * @param {string} motionGroup The motion-group identifier.
13404
+ * @param {*} [options] Override http request option.
13405
+ * @throws {RequiredError}
13406
+ */
13407
+ async listVirtualRobotTcps(cell: string, controller: string, motionGroup: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<RobotTcp>>> {
13408
+ const localVarAxiosArgs = await localVarAxiosParamCreator.listVirtualRobotTcps(cell, controller, motionGroup, options);
13409
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
13410
+ const localVarOperationServerBasePath = operationServerMap['VirtualControllerApi.listVirtualRobotTcps']?.[localVarOperationServerIndex]?.url;
13521
13411
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
13522
13412
  },
13523
13413
  /**
@@ -13532,7 +13422,23 @@ export const VirtualRobotModeApiFp = function(configuration?: Configuration) {
13532
13422
  async setEmergencyStop(cell: string, controller: string, active?: boolean, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> {
13533
13423
  const localVarAxiosArgs = await localVarAxiosParamCreator.setEmergencyStop(cell, controller, active, options);
13534
13424
  const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
13535
- const localVarOperationServerBasePath = operationServerMap['VirtualRobotModeApi.setEmergencyStop']?.[localVarOperationServerIndex]?.url;
13425
+ const localVarOperationServerBasePath = operationServerMap['VirtualControllerApi.setEmergencyStop']?.[localVarOperationServerIndex]?.url;
13426
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
13427
+ },
13428
+ /**
13429
+ * 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.
13430
+ * @summary Set Motion Group State
13431
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
13432
+ * @param {string} controller Unique identifier to address a controller in the cell.
13433
+ * @param {string} motionGroup The motion-group identifier.
13434
+ * @param {MotionGroupJoints} motionGroupJoints
13435
+ * @param {*} [options] Override http request option.
13436
+ * @throws {RequiredError}
13437
+ */
13438
+ async setMotionGroupState(cell: string, controller: string, motionGroup: string, motionGroupJoints: MotionGroupJoints, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> {
13439
+ const localVarAxiosArgs = await localVarAxiosParamCreator.setMotionGroupState(cell, controller, motionGroup, motionGroupJoints, options);
13440
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
13441
+ const localVarOperationServerBasePath = operationServerMap['VirtualControllerApi.setMotionGroupState']?.[localVarOperationServerIndex]?.url;
13536
13442
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
13537
13443
  },
13538
13444
  /**
@@ -13547,29 +13453,87 @@ export const VirtualRobotModeApiFp = function(configuration?: Configuration) {
13547
13453
  async setOperationMode(cell: string, controller: string, mode: OperationMode, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> {
13548
13454
  const localVarAxiosArgs = await localVarAxiosParamCreator.setOperationMode(cell, controller, mode, options);
13549
13455
  const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
13550
- const localVarOperationServerBasePath = operationServerMap['VirtualRobotModeApi.setOperationMode']?.[localVarOperationServerIndex]?.url;
13456
+ const localVarOperationServerBasePath = operationServerMap['VirtualControllerApi.setOperationMode']?.[localVarOperationServerIndex]?.url;
13457
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
13458
+ },
13459
+ /**
13460
+ * 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.
13461
+ * @summary Set Mounting
13462
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
13463
+ * @param {string} controller Unique identifier to address a controller in the cell.
13464
+ * @param {string} motionGroup The motion-group identifier.
13465
+ * @param {CoordinateSystem} coordinateSystem
13466
+ * @param {*} [options] Override http request option.
13467
+ * @throws {RequiredError}
13468
+ */
13469
+ async setVirtualRobotMounting(cell: string, controller: string, motionGroup: string, coordinateSystem: CoordinateSystem, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CoordinateSystem>> {
13470
+ const localVarAxiosArgs = await localVarAxiosParamCreator.setVirtualRobotMounting(cell, controller, motionGroup, coordinateSystem, options);
13471
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
13472
+ const localVarOperationServerBasePath = operationServerMap['VirtualControllerApi.setVirtualRobotMounting']?.[localVarOperationServerIndex]?.url;
13551
13473
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
13552
13474
  },
13553
13475
  }
13554
13476
  };
13555
13477
 
13556
13478
  /**
13557
- * VirtualRobotModeApi - factory interface
13479
+ * VirtualControllerApi - factory interface
13558
13480
  * @export
13559
13481
  */
13560
- export const VirtualRobotModeApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
13561
- const localVarFp = VirtualRobotModeApiFp(configuration)
13482
+ export const VirtualControllerApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
13483
+ const localVarFp = VirtualControllerApiFp(configuration)
13562
13484
  return {
13563
13485
  /**
13564
- * Get the cycle time of controller communication in [ms].
13565
- * @summary Cycle Time
13486
+ * Adds a coordinate system to the robot controller.
13487
+ * @summary Add Coordinate Systems
13566
13488
  * @param {string} cell Unique identifier addressing a cell in all API calls.
13567
13489
  * @param {string} controller Unique identifier to address a controller in the cell.
13490
+ * @param {string} coordinateSystem Unique identifier addressing a coordinate system.
13491
+ * @param {CoordinateSystemData} coordinateSystemData
13568
13492
  * @param {*} [options] Override http request option.
13569
13493
  * @throws {RequiredError}
13570
13494
  */
13571
- getCycleTime(cell: string, controller: string, options?: RawAxiosRequestConfig): AxiosPromise<CycleTime> {
13572
- return localVarFp.getCycleTime(cell, controller, options).then((request) => request(axios, basePath));
13495
+ addVirtualRobotCoordinateSystem(cell: string, controller: string, coordinateSystem: string, coordinateSystemData: CoordinateSystemData, options?: RawAxiosRequestConfig): AxiosPromise<void> {
13496
+ return localVarFp.addVirtualRobotCoordinateSystem(cell, controller, coordinateSystem, coordinateSystemData, options).then((request) => request(axios, basePath));
13497
+ },
13498
+ /**
13499
+ * 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.
13500
+ * @summary Add TCP
13501
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
13502
+ * @param {string} controller Unique identifier to address a controller in the cell.
13503
+ * @param {string} motionGroup The motion-group identifier.
13504
+ * @param {string} tcp The unique identifier of a TCP.
13505
+ * @param {RobotTcpData} robotTcpData
13506
+ * @param {*} [options] Override http request option.
13507
+ * @throws {RequiredError}
13508
+ */
13509
+ addVirtualRobotTcp(cell: string, controller: string, motionGroup: string, tcp: string, robotTcpData: RobotTcpData, options?: RawAxiosRequestConfig): AxiosPromise<void> {
13510
+ return localVarFp.addVirtualRobotTcp(cell, controller, motionGroup, tcp, robotTcpData, options).then((request) => request(axios, basePath));
13511
+ },
13512
+ /**
13513
+ * 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.
13514
+ * @summary Remove Coordinate System
13515
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
13516
+ * @param {string} controller Unique identifier to address a controller in the cell.
13517
+ * @param {string} coordinateSystem Unique identifier addressing a coordinate system.
13518
+ * @param {boolean} [deleteDependent] If true, all dependent coordinate systems will be deleted as well.
13519
+ * @param {*} [options] Override http request option.
13520
+ * @throws {RequiredError}
13521
+ */
13522
+ deleteVirtualRobotCoordinateSystem(cell: string, controller: string, coordinateSystem: string, deleteDependent?: boolean, options?: RawAxiosRequestConfig): AxiosPromise<void> {
13523
+ return localVarFp.deleteVirtualRobotCoordinateSystem(cell, controller, coordinateSystem, deleteDependent, options).then((request) => request(axios, basePath));
13524
+ },
13525
+ /**
13526
+ * Removes the TCP from the motion group. An unknown TCP is a valid input.
13527
+ * @summary Remove TCP
13528
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
13529
+ * @param {string} controller Unique identifier to address a controller in the cell.
13530
+ * @param {string} motionGroup The motion-group identifier.
13531
+ * @param {string} tcp The unique identifier of a TCP.
13532
+ * @param {*} [options] Override http request option.
13533
+ * @throws {RequiredError}
13534
+ */
13535
+ deleteVirtualRobotTcp(cell: string, controller: string, motionGroup: string, tcp: string, options?: RawAxiosRequestConfig): AxiosPromise<void> {
13536
+ return localVarFp.deleteVirtualRobotTcp(cell, controller, motionGroup, tcp, options).then((request) => request(axios, basePath));
13573
13537
  },
13574
13538
  /**
13575
13539
  * 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.
@@ -13582,6 +13546,29 @@ export const VirtualRobotModeApiFactory = function (configuration?: Configuratio
13582
13546
  getEmergencyStop(cell: string, controller: string, options?: RawAxiosRequestConfig): AxiosPromise<Flag> {
13583
13547
  return localVarFp.getEmergencyStop(cell, controller, options).then((request) => request(axios, basePath));
13584
13548
  },
13549
+ /**
13550
+ * Get the current motion group state which provides values for the joints\' position, velocity and acceleration.
13551
+ * @summary Get Motion Group State
13552
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
13553
+ * @param {string} controller Unique identifier to address a controller in the cell.
13554
+ * @param {string} motionGroup The motion-group identifier.
13555
+ * @param {*} [options] Override http request option.
13556
+ * @throws {RequiredError}
13557
+ */
13558
+ getMotionGroupState(cell: string, controller: string, motionGroup: string, options?: RawAxiosRequestConfig): AxiosPromise<MotionGroupJoints> {
13559
+ return localVarFp.getMotionGroupState(cell, controller, motionGroup, options).then((request) => request(axios, basePath));
13560
+ },
13561
+ /**
13562
+ * Gets information on the motion group.
13563
+ * @summary Motion Group Description
13564
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
13565
+ * @param {string} controller Unique identifier to address a controller in the cell.
13566
+ * @param {*} [options] Override http request option.
13567
+ * @throws {RequiredError}
13568
+ */
13569
+ getMotionGroups(cell: string, controller: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<MotionGroupInfo>> {
13570
+ return localVarFp.getMotionGroups(cell, controller, options).then((request) => request(axios, basePath));
13571
+ },
13585
13572
  /**
13586
13573
  * 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.
13587
13574
  * @summary Get Operation Mode
@@ -13593,6 +13580,41 @@ export const VirtualRobotModeApiFactory = function (configuration?: Configuratio
13593
13580
  getOperationMode(cell: string, controller: string, options?: RawAxiosRequestConfig): AxiosPromise<OpMode> {
13594
13581
  return localVarFp.getOperationMode(cell, controller, options).then((request) => request(axios, basePath));
13595
13582
  },
13583
+ /**
13584
+ * Gets motion group mounting. The motion group is based on the origin of the returned coordinate system.
13585
+ * @summary Get Mounting
13586
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
13587
+ * @param {string} controller Unique identifier to address a controller in the cell.
13588
+ * @param {string} motionGroup The motion-group identifier.
13589
+ * @param {*} [options] Override http request option.
13590
+ * @throws {RequiredError}
13591
+ */
13592
+ getVirtualRobotMounting(cell: string, controller: string, motionGroup: string, options?: RawAxiosRequestConfig): AxiosPromise<CoordinateSystem> {
13593
+ return localVarFp.getVirtualRobotMounting(cell, controller, motionGroup, options).then((request) => request(axios, basePath));
13594
+ },
13595
+ /**
13596
+ * Lists all coordinate systems on the robot controller.
13597
+ * @summary List Coordinate Systems
13598
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
13599
+ * @param {string} controller Unique identifier to address a controller in the cell.
13600
+ * @param {*} [options] Override http request option.
13601
+ * @throws {RequiredError}
13602
+ */
13603
+ listVirtualRobotCoordinateSystems(cell: string, controller: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<CoordinateSystem>> {
13604
+ return localVarFp.listVirtualRobotCoordinateSystems(cell, controller, options).then((request) => request(axios, basePath));
13605
+ },
13606
+ /**
13607
+ * Lists TCPs of the motion group. An empty TCP list is valid, for example for external axes.
13608
+ * @summary List TCPs
13609
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
13610
+ * @param {string} controller Unique identifier to address a controller in the cell.
13611
+ * @param {string} motionGroup The motion-group identifier.
13612
+ * @param {*} [options] Override http request option.
13613
+ * @throws {RequiredError}
13614
+ */
13615
+ listVirtualRobotTcps(cell: string, controller: string, motionGroup: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<RobotTcp>> {
13616
+ return localVarFp.listVirtualRobotTcps(cell, controller, motionGroup, options).then((request) => request(axios, basePath));
13617
+ },
13596
13618
  /**
13597
13619
  * 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.
13598
13620
  * @summary Push or Release Emergency Stop
@@ -13605,6 +13627,19 @@ export const VirtualRobotModeApiFactory = function (configuration?: Configuratio
13605
13627
  setEmergencyStop(cell: string, controller: string, active?: boolean, options?: RawAxiosRequestConfig): AxiosPromise<void> {
13606
13628
  return localVarFp.setEmergencyStop(cell, controller, active, options).then((request) => request(axios, basePath));
13607
13629
  },
13630
+ /**
13631
+ * 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.
13632
+ * @summary Set Motion Group State
13633
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
13634
+ * @param {string} controller Unique identifier to address a controller in the cell.
13635
+ * @param {string} motionGroup The motion-group identifier.
13636
+ * @param {MotionGroupJoints} motionGroupJoints
13637
+ * @param {*} [options] Override http request option.
13638
+ * @throws {RequiredError}
13639
+ */
13640
+ setMotionGroupState(cell: string, controller: string, motionGroup: string, motionGroupJoints: MotionGroupJoints, options?: RawAxiosRequestConfig): AxiosPromise<void> {
13641
+ return localVarFp.setMotionGroupState(cell, controller, motionGroup, motionGroupJoints, options).then((request) => request(axios, basePath));
13642
+ },
13608
13643
  /**
13609
13644
  * 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.
13610
13645
  * @summary Set Operation Mode
@@ -13617,27 +13652,88 @@ export const VirtualRobotModeApiFactory = function (configuration?: Configuratio
13617
13652
  setOperationMode(cell: string, controller: string, mode: OperationMode, options?: RawAxiosRequestConfig): AxiosPromise<void> {
13618
13653
  return localVarFp.setOperationMode(cell, controller, mode, options).then((request) => request(axios, basePath));
13619
13654
  },
13620
- };
13621
- };
13622
-
13623
- /**
13624
- * VirtualRobotModeApi - object-oriented interface
13625
- * @export
13626
- * @class VirtualRobotModeApi
13627
- * @extends {BaseAPI}
13655
+ /**
13656
+ * 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.
13657
+ * @summary Set Mounting
13658
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
13659
+ * @param {string} controller Unique identifier to address a controller in the cell.
13660
+ * @param {string} motionGroup The motion-group identifier.
13661
+ * @param {CoordinateSystem} coordinateSystem
13662
+ * @param {*} [options] Override http request option.
13663
+ * @throws {RequiredError}
13664
+ */
13665
+ setVirtualRobotMounting(cell: string, controller: string, motionGroup: string, coordinateSystem: CoordinateSystem, options?: RawAxiosRequestConfig): AxiosPromise<CoordinateSystem> {
13666
+ return localVarFp.setVirtualRobotMounting(cell, controller, motionGroup, coordinateSystem, options).then((request) => request(axios, basePath));
13667
+ },
13668
+ };
13669
+ };
13670
+
13671
+ /**
13672
+ * VirtualControllerApi - object-oriented interface
13673
+ * @export
13674
+ * @class VirtualControllerApi
13675
+ * @extends {BaseAPI}
13628
13676
  */
13629
- export class VirtualRobotModeApi extends BaseAPI {
13677
+ export class VirtualControllerApi extends BaseAPI {
13630
13678
  /**
13631
- * Get the cycle time of controller communication in [ms].
13632
- * @summary Cycle Time
13679
+ * Adds a coordinate system to the robot controller.
13680
+ * @summary Add Coordinate Systems
13633
13681
  * @param {string} cell Unique identifier addressing a cell in all API calls.
13634
13682
  * @param {string} controller Unique identifier to address a controller in the cell.
13683
+ * @param {string} coordinateSystem Unique identifier addressing a coordinate system.
13684
+ * @param {CoordinateSystemData} coordinateSystemData
13635
13685
  * @param {*} [options] Override http request option.
13636
13686
  * @throws {RequiredError}
13637
- * @memberof VirtualRobotModeApi
13687
+ * @memberof VirtualControllerApi
13638
13688
  */
13639
- public getCycleTime(cell: string, controller: string, options?: RawAxiosRequestConfig) {
13640
- return VirtualRobotModeApiFp(this.configuration).getCycleTime(cell, controller, options).then((request) => request(this.axios, this.basePath));
13689
+ public addVirtualRobotCoordinateSystem(cell: string, controller: string, coordinateSystem: string, coordinateSystemData: CoordinateSystemData, options?: RawAxiosRequestConfig) {
13690
+ return VirtualControllerApiFp(this.configuration).addVirtualRobotCoordinateSystem(cell, controller, coordinateSystem, coordinateSystemData, options).then((request) => request(this.axios, this.basePath));
13691
+ }
13692
+
13693
+ /**
13694
+ * 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.
13695
+ * @summary Add TCP
13696
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
13697
+ * @param {string} controller Unique identifier to address a controller in the cell.
13698
+ * @param {string} motionGroup The motion-group identifier.
13699
+ * @param {string} tcp The unique identifier of a TCP.
13700
+ * @param {RobotTcpData} robotTcpData
13701
+ * @param {*} [options] Override http request option.
13702
+ * @throws {RequiredError}
13703
+ * @memberof VirtualControllerApi
13704
+ */
13705
+ public addVirtualRobotTcp(cell: string, controller: string, motionGroup: string, tcp: string, robotTcpData: RobotTcpData, options?: RawAxiosRequestConfig) {
13706
+ return VirtualControllerApiFp(this.configuration).addVirtualRobotTcp(cell, controller, motionGroup, tcp, robotTcpData, options).then((request) => request(this.axios, this.basePath));
13707
+ }
13708
+
13709
+ /**
13710
+ * 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.
13711
+ * @summary Remove Coordinate System
13712
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
13713
+ * @param {string} controller Unique identifier to address a controller in the cell.
13714
+ * @param {string} coordinateSystem Unique identifier addressing a coordinate system.
13715
+ * @param {boolean} [deleteDependent] If true, all dependent coordinate systems will be deleted as well.
13716
+ * @param {*} [options] Override http request option.
13717
+ * @throws {RequiredError}
13718
+ * @memberof VirtualControllerApi
13719
+ */
13720
+ public deleteVirtualRobotCoordinateSystem(cell: string, controller: string, coordinateSystem: string, deleteDependent?: boolean, options?: RawAxiosRequestConfig) {
13721
+ return VirtualControllerApiFp(this.configuration).deleteVirtualRobotCoordinateSystem(cell, controller, coordinateSystem, deleteDependent, options).then((request) => request(this.axios, this.basePath));
13722
+ }
13723
+
13724
+ /**
13725
+ * Removes the TCP from the motion group. An unknown TCP is a valid input.
13726
+ * @summary Remove TCP
13727
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
13728
+ * @param {string} controller Unique identifier to address a controller in the cell.
13729
+ * @param {string} motionGroup The motion-group identifier.
13730
+ * @param {string} tcp The unique identifier of a TCP.
13731
+ * @param {*} [options] Override http request option.
13732
+ * @throws {RequiredError}
13733
+ * @memberof VirtualControllerApi
13734
+ */
13735
+ public deleteVirtualRobotTcp(cell: string, controller: string, motionGroup: string, tcp: string, options?: RawAxiosRequestConfig) {
13736
+ return VirtualControllerApiFp(this.configuration).deleteVirtualRobotTcp(cell, controller, motionGroup, tcp, options).then((request) => request(this.axios, this.basePath));
13641
13737
  }
13642
13738
 
13643
13739
  /**
@@ -13647,10 +13743,37 @@ export class VirtualRobotModeApi extends BaseAPI {
13647
13743
  * @param {string} controller Unique identifier to address a controller in the cell.
13648
13744
  * @param {*} [options] Override http request option.
13649
13745
  * @throws {RequiredError}
13650
- * @memberof VirtualRobotModeApi
13746
+ * @memberof VirtualControllerApi
13651
13747
  */
13652
13748
  public getEmergencyStop(cell: string, controller: string, options?: RawAxiosRequestConfig) {
13653
- return VirtualRobotModeApiFp(this.configuration).getEmergencyStop(cell, controller, options).then((request) => request(this.axios, this.basePath));
13749
+ return VirtualControllerApiFp(this.configuration).getEmergencyStop(cell, controller, options).then((request) => request(this.axios, this.basePath));
13750
+ }
13751
+
13752
+ /**
13753
+ * Get the current motion group state which provides values for the joints\' position, velocity and acceleration.
13754
+ * @summary Get Motion Group State
13755
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
13756
+ * @param {string} controller Unique identifier to address a controller in the cell.
13757
+ * @param {string} motionGroup The motion-group identifier.
13758
+ * @param {*} [options] Override http request option.
13759
+ * @throws {RequiredError}
13760
+ * @memberof VirtualControllerApi
13761
+ */
13762
+ public getMotionGroupState(cell: string, controller: string, motionGroup: string, options?: RawAxiosRequestConfig) {
13763
+ return VirtualControllerApiFp(this.configuration).getMotionGroupState(cell, controller, motionGroup, options).then((request) => request(this.axios, this.basePath));
13764
+ }
13765
+
13766
+ /**
13767
+ * Gets information on the motion group.
13768
+ * @summary Motion Group Description
13769
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
13770
+ * @param {string} controller Unique identifier to address a controller in the cell.
13771
+ * @param {*} [options] Override http request option.
13772
+ * @throws {RequiredError}
13773
+ * @memberof VirtualControllerApi
13774
+ */
13775
+ public getMotionGroups(cell: string, controller: string, options?: RawAxiosRequestConfig) {
13776
+ return VirtualControllerApiFp(this.configuration).getMotionGroups(cell, controller, options).then((request) => request(this.axios, this.basePath));
13654
13777
  }
13655
13778
 
13656
13779
  /**
@@ -13660,10 +13783,51 @@ export class VirtualRobotModeApi extends BaseAPI {
13660
13783
  * @param {string} controller Unique identifier to address a controller in the cell.
13661
13784
  * @param {*} [options] Override http request option.
13662
13785
  * @throws {RequiredError}
13663
- * @memberof VirtualRobotModeApi
13786
+ * @memberof VirtualControllerApi
13664
13787
  */
13665
13788
  public getOperationMode(cell: string, controller: string, options?: RawAxiosRequestConfig) {
13666
- return VirtualRobotModeApiFp(this.configuration).getOperationMode(cell, controller, options).then((request) => request(this.axios, this.basePath));
13789
+ return VirtualControllerApiFp(this.configuration).getOperationMode(cell, controller, options).then((request) => request(this.axios, this.basePath));
13790
+ }
13791
+
13792
+ /**
13793
+ * Gets motion group mounting. The motion group is based on the origin of the returned coordinate system.
13794
+ * @summary Get Mounting
13795
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
13796
+ * @param {string} controller Unique identifier to address a controller in the cell.
13797
+ * @param {string} motionGroup The motion-group identifier.
13798
+ * @param {*} [options] Override http request option.
13799
+ * @throws {RequiredError}
13800
+ * @memberof VirtualControllerApi
13801
+ */
13802
+ public getVirtualRobotMounting(cell: string, controller: string, motionGroup: string, options?: RawAxiosRequestConfig) {
13803
+ return VirtualControllerApiFp(this.configuration).getVirtualRobotMounting(cell, controller, motionGroup, options).then((request) => request(this.axios, this.basePath));
13804
+ }
13805
+
13806
+ /**
13807
+ * Lists all coordinate systems on the robot controller.
13808
+ * @summary List Coordinate Systems
13809
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
13810
+ * @param {string} controller Unique identifier to address a controller in the cell.
13811
+ * @param {*} [options] Override http request option.
13812
+ * @throws {RequiredError}
13813
+ * @memberof VirtualControllerApi
13814
+ */
13815
+ public listVirtualRobotCoordinateSystems(cell: string, controller: string, options?: RawAxiosRequestConfig) {
13816
+ return VirtualControllerApiFp(this.configuration).listVirtualRobotCoordinateSystems(cell, controller, options).then((request) => request(this.axios, this.basePath));
13817
+ }
13818
+
13819
+ /**
13820
+ * Lists TCPs of the motion group. An empty TCP list is valid, for example for external axes.
13821
+ * @summary List TCPs
13822
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
13823
+ * @param {string} controller Unique identifier to address a controller in the cell.
13824
+ * @param {string} motionGroup The motion-group identifier.
13825
+ * @param {*} [options] Override http request option.
13826
+ * @throws {RequiredError}
13827
+ * @memberof VirtualControllerApi
13828
+ */
13829
+ public listVirtualRobotTcps(cell: string, controller: string, motionGroup: string, options?: RawAxiosRequestConfig) {
13830
+ return VirtualControllerApiFp(this.configuration).listVirtualRobotTcps(cell, controller, motionGroup, options).then((request) => request(this.axios, this.basePath));
13667
13831
  }
13668
13832
 
13669
13833
  /**
@@ -13674,10 +13838,25 @@ export class VirtualRobotModeApi extends BaseAPI {
13674
13838
  * @param {boolean} [active]
13675
13839
  * @param {*} [options] Override http request option.
13676
13840
  * @throws {RequiredError}
13677
- * @memberof VirtualRobotModeApi
13841
+ * @memberof VirtualControllerApi
13678
13842
  */
13679
13843
  public setEmergencyStop(cell: string, controller: string, active?: boolean, options?: RawAxiosRequestConfig) {
13680
- return VirtualRobotModeApiFp(this.configuration).setEmergencyStop(cell, controller, active, options).then((request) => request(this.axios, this.basePath));
13844
+ return VirtualControllerApiFp(this.configuration).setEmergencyStop(cell, controller, active, options).then((request) => request(this.axios, this.basePath));
13845
+ }
13846
+
13847
+ /**
13848
+ * 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.
13849
+ * @summary Set Motion Group State
13850
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
13851
+ * @param {string} controller Unique identifier to address a controller in the cell.
13852
+ * @param {string} motionGroup The motion-group identifier.
13853
+ * @param {MotionGroupJoints} motionGroupJoints
13854
+ * @param {*} [options] Override http request option.
13855
+ * @throws {RequiredError}
13856
+ * @memberof VirtualControllerApi
13857
+ */
13858
+ public setMotionGroupState(cell: string, controller: string, motionGroup: string, motionGroupJoints: MotionGroupJoints, options?: RawAxiosRequestConfig) {
13859
+ return VirtualControllerApiFp(this.configuration).setMotionGroupState(cell, controller, motionGroup, motionGroupJoints, options).then((request) => request(this.axios, this.basePath));
13681
13860
  }
13682
13861
 
13683
13862
  /**
@@ -13688,38 +13867,53 @@ export class VirtualRobotModeApi extends BaseAPI {
13688
13867
  * @param {OperationMode} mode
13689
13868
  * @param {*} [options] Override http request option.
13690
13869
  * @throws {RequiredError}
13691
- * @memberof VirtualRobotModeApi
13870
+ * @memberof VirtualControllerApi
13692
13871
  */
13693
13872
  public setOperationMode(cell: string, controller: string, mode: OperationMode, options?: RawAxiosRequestConfig) {
13694
- return VirtualRobotModeApiFp(this.configuration).setOperationMode(cell, controller, mode, options).then((request) => request(this.axios, this.basePath));
13873
+ return VirtualControllerApiFp(this.configuration).setOperationMode(cell, controller, mode, options).then((request) => request(this.axios, this.basePath));
13874
+ }
13875
+
13876
+ /**
13877
+ * 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.
13878
+ * @summary Set Mounting
13879
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
13880
+ * @param {string} controller Unique identifier to address a controller in the cell.
13881
+ * @param {string} motionGroup The motion-group identifier.
13882
+ * @param {CoordinateSystem} coordinateSystem
13883
+ * @param {*} [options] Override http request option.
13884
+ * @throws {RequiredError}
13885
+ * @memberof VirtualControllerApi
13886
+ */
13887
+ public setVirtualRobotMounting(cell: string, controller: string, motionGroup: string, coordinateSystem: CoordinateSystem, options?: RawAxiosRequestConfig) {
13888
+ return VirtualControllerApiFp(this.configuration).setVirtualRobotMounting(cell, controller, motionGroup, coordinateSystem, options).then((request) => request(this.axios, this.basePath));
13695
13889
  }
13696
13890
  }
13697
13891
 
13698
13892
 
13699
13893
 
13700
13894
  /**
13701
- * VirtualRobotSetupApi - axios parameter creator
13895
+ * VirtualControllerBehaviorApi - axios parameter creator
13702
13896
  * @export
13703
13897
  */
13704
- export const VirtualRobotSetupApiAxiosParamCreator = function (configuration?: Configuration) {
13898
+ export const VirtualControllerBehaviorApiAxiosParamCreator = function (configuration?: Configuration) {
13705
13899
  return {
13706
13900
  /**
13707
- * Adds a coordinate system to the robot controller.
13708
- * @summary Add Coordinate Systems
13901
+ * <!-- 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.
13902
+ * @summary Stream Joint Configuration
13709
13903
  * @param {string} cell Unique identifier addressing a cell in all API calls.
13710
13904
  * @param {string} controller Unique identifier to address a controller in the cell.
13711
- * @param {CoordinateSystem} coordinateSystem
13905
+ * @param {ExternalJointStreamRequest} externalJointStreamRequest
13712
13906
  * @param {*} [options] Override http request option.
13713
13907
  * @throws {RequiredError}
13714
13908
  */
13715
- addVirtualRobotCoordinateSystem: async (cell: string, controller: string, coordinateSystem: CoordinateSystem, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
13909
+ externalJointsStream: async (cell: string, controller: string, externalJointStreamRequest: ExternalJointStreamRequest, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
13716
13910
  // verify required parameter 'cell' is not null or undefined
13717
- assertParamExists('addVirtualRobotCoordinateSystem', 'cell', cell)
13911
+ assertParamExists('externalJointsStream', 'cell', cell)
13718
13912
  // verify required parameter 'controller' is not null or undefined
13719
- assertParamExists('addVirtualRobotCoordinateSystem', 'controller', controller)
13720
- // verify required parameter 'coordinateSystem' is not null or undefined
13721
- assertParamExists('addVirtualRobotCoordinateSystem', 'coordinateSystem', coordinateSystem)
13722
- const localVarPath = `/cells/{cell}/controllers/{controller}/teach-pendant/coordinate-systems`
13913
+ assertParamExists('externalJointsStream', 'controller', controller)
13914
+ // verify required parameter 'externalJointStreamRequest' is not null or undefined
13915
+ assertParamExists('externalJointsStream', 'externalJointStreamRequest', externalJointStreamRequest)
13916
+ const localVarPath = `/cells/{cell}/virtual-controllers/{controller}/external-joints-stream`
13723
13917
  .replace(`{${"cell"}}`, encodeURIComponent(String(cell)))
13724
13918
  .replace(`{${"controller"}}`, encodeURIComponent(String(controller)));
13725
13919
  // use dummy base URL string because the URL constructor only accepts absolute URLs.
@@ -13729,7 +13923,7 @@ export const VirtualRobotSetupApiAxiosParamCreator = function (configuration?: C
13729
13923
  baseOptions = configuration.baseOptions;
13730
13924
  }
13731
13925
 
13732
- const localVarRequestOptions = { method: 'PUT', ...baseOptions, ...options};
13926
+ const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
13733
13927
  const localVarHeaderParameter = {} as any;
13734
13928
  const localVarQueryParameter = {} as any;
13735
13929
 
@@ -13748,7 +13942,7 @@ export const VirtualRobotSetupApiAxiosParamCreator = function (configuration?: C
13748
13942
  setSearchParams(localVarUrlObj, localVarQueryParameter);
13749
13943
  let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
13750
13944
  localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
13751
- localVarRequestOptions.data = serializeDataIfNeeded(coordinateSystem, localVarRequestOptions, configuration)
13945
+ localVarRequestOptions.data = serializeDataIfNeeded(externalJointStreamRequest, localVarRequestOptions, configuration)
13752
13946
 
13753
13947
  return {
13754
13948
  url: toPathString(localVarUrlObj),
@@ -13756,28 +13950,21 @@ export const VirtualRobotSetupApiAxiosParamCreator = function (configuration?: C
13756
13950
  };
13757
13951
  },
13758
13952
  /**
13759
- * 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.
13760
- * @summary Add TCP
13953
+ * Get the cycle time of controller communication in [ms].
13954
+ * @summary Get Cycle Time
13761
13955
  * @param {string} cell Unique identifier addressing a cell in all API calls.
13762
13956
  * @param {string} controller Unique identifier to address a controller in the cell.
13763
- * @param {string} motionGroup The motion-group identifier.
13764
- * @param {RobotTcp} robotTcp
13765
13957
  * @param {*} [options] Override http request option.
13766
13958
  * @throws {RequiredError}
13767
13959
  */
13768
- addVirtualRobotTcp: async (cell: string, controller: string, motionGroup: string, robotTcp: RobotTcp, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
13960
+ getCycleTime: async (cell: string, controller: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
13769
13961
  // verify required parameter 'cell' is not null or undefined
13770
- assertParamExists('addVirtualRobotTcp', 'cell', cell)
13962
+ assertParamExists('getCycleTime', 'cell', cell)
13771
13963
  // verify required parameter 'controller' is not null or undefined
13772
- assertParamExists('addVirtualRobotTcp', 'controller', controller)
13773
- // verify required parameter 'motionGroup' is not null or undefined
13774
- assertParamExists('addVirtualRobotTcp', 'motionGroup', motionGroup)
13775
- // verify required parameter 'robotTcp' is not null or undefined
13776
- assertParamExists('addVirtualRobotTcp', 'robotTcp', robotTcp)
13777
- const localVarPath = `/cells/{cell}/controllers/{controller}/teach-pendant/motion-groups/{motion-group}/tcps`
13964
+ assertParamExists('getCycleTime', 'controller', controller)
13965
+ const localVarPath = `/cells/{cell}/virtual-controllers/{controller}/cycle-time`
13778
13966
  .replace(`{${"cell"}}`, encodeURIComponent(String(cell)))
13779
- .replace(`{${"controller"}}`, encodeURIComponent(String(controller)))
13780
- .replace(`{${"motion-group"}}`, encodeURIComponent(String(motionGroup)));
13967
+ .replace(`{${"controller"}}`, encodeURIComponent(String(controller)));
13781
13968
  // use dummy base URL string because the URL constructor only accepts absolute URLs.
13782
13969
  const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
13783
13970
  let baseOptions;
@@ -13785,7 +13972,7 @@ export const VirtualRobotSetupApiAxiosParamCreator = function (configuration?: C
13785
13972
  baseOptions = configuration.baseOptions;
13786
13973
  }
13787
13974
 
13788
- const localVarRequestOptions = { method: 'PUT', ...baseOptions, ...options};
13975
+ const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
13789
13976
  const localVarHeaderParameter = {} as any;
13790
13977
  const localVarQueryParameter = {} as any;
13791
13978
 
@@ -13799,12 +13986,9 @@ export const VirtualRobotSetupApiAxiosParamCreator = function (configuration?: C
13799
13986
 
13800
13987
 
13801
13988
 
13802
- localVarHeaderParameter['Content-Type'] = 'application/json';
13803
-
13804
13989
  setSearchParams(localVarUrlObj, localVarQueryParameter);
13805
13990
  let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
13806
13991
  localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
13807
- localVarRequestOptions.data = serializeDataIfNeeded(robotTcp, localVarRequestOptions, configuration)
13808
13992
 
13809
13993
  return {
13810
13994
  url: toPathString(localVarUrlObj),
@@ -13812,26 +13996,21 @@ export const VirtualRobotSetupApiAxiosParamCreator = function (configuration?: C
13812
13996
  };
13813
13997
  },
13814
13998
  /**
13815
- * 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.
13816
- * @summary Remove Coordinate System
13999
+ * Get the current virtual controller behavior - please see the setter [setVirtualRobotBehavior](setVirtualRobotBehavior) and the enum for details.
14000
+ * @summary Get Behavior
13817
14001
  * @param {string} cell Unique identifier addressing a cell in all API calls.
13818
14002
  * @param {string} controller Unique identifier to address a controller in the cell.
13819
- * @param {string} coordinateSystem Unique identifier addressing a coordinate system.
13820
- * @param {boolean} [deleteDependent] If true, all dependent coordinate systems will be deleted as well.
13821
14003
  * @param {*} [options] Override http request option.
13822
14004
  * @throws {RequiredError}
13823
14005
  */
13824
- deleteVirtualRobotCoordinateSystem: async (cell: string, controller: string, coordinateSystem: string, deleteDependent?: boolean, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
14006
+ getVirtualRobotBehavior: async (cell: string, controller: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
13825
14007
  // verify required parameter 'cell' is not null or undefined
13826
- assertParamExists('deleteVirtualRobotCoordinateSystem', 'cell', cell)
14008
+ assertParamExists('getVirtualRobotBehavior', 'cell', cell)
13827
14009
  // verify required parameter 'controller' is not null or undefined
13828
- assertParamExists('deleteVirtualRobotCoordinateSystem', 'controller', controller)
13829
- // verify required parameter 'coordinateSystem' is not null or undefined
13830
- assertParamExists('deleteVirtualRobotCoordinateSystem', 'coordinateSystem', coordinateSystem)
13831
- const localVarPath = `/cells/{cell}/controllers/{controller}/teach-pendant/coordinate-systems/{coordinate-system}`
14010
+ assertParamExists('getVirtualRobotBehavior', 'controller', controller)
14011
+ const localVarPath = `/cells/{cell}/virtual-controllers/{controller}/behavior`
13832
14012
  .replace(`{${"cell"}}`, encodeURIComponent(String(cell)))
13833
- .replace(`{${"controller"}}`, encodeURIComponent(String(controller)))
13834
- .replace(`{${"coordinate-system"}}`, encodeURIComponent(String(coordinateSystem)));
14013
+ .replace(`{${"controller"}}`, encodeURIComponent(String(controller)));
13835
14014
  // use dummy base URL string because the URL constructor only accepts absolute URLs.
13836
14015
  const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
13837
14016
  let baseOptions;
@@ -13839,7 +14018,7 @@ export const VirtualRobotSetupApiAxiosParamCreator = function (configuration?: C
13839
14018
  baseOptions = configuration.baseOptions;
13840
14019
  }
13841
14020
 
13842
- const localVarRequestOptions = { method: 'DELETE', ...baseOptions, ...options};
14021
+ const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
13843
14022
  const localVarHeaderParameter = {} as any;
13844
14023
  const localVarQueryParameter = {} as any;
13845
14024
 
@@ -13851,10 +14030,6 @@ export const VirtualRobotSetupApiAxiosParamCreator = function (configuration?: C
13851
14030
  // http bearer authentication required
13852
14031
  await setBearerAuthToObject(localVarHeaderParameter, configuration)
13853
14032
 
13854
- if (deleteDependent !== undefined) {
13855
- localVarQueryParameter['delete_dependent'] = deleteDependent;
13856
- }
13857
-
13858
14033
 
13859
14034
 
13860
14035
  setSearchParams(localVarUrlObj, localVarQueryParameter);
@@ -13867,29 +14042,22 @@ export const VirtualRobotSetupApiAxiosParamCreator = function (configuration?: C
13867
14042
  };
13868
14043
  },
13869
14044
  /**
13870
- * Removes the TCP from the motion group. An unknown TCP is a valid input.
13871
- * @summary Remove TCP
14045
+ * Set virtual controller behavior.
14046
+ * @summary Set Behavior
13872
14047
  * @param {string} cell Unique identifier addressing a cell in all API calls.
13873
14048
  * @param {string} controller Unique identifier to address a controller in the cell.
13874
- * @param {string} motionGroup The motion-group identifier.
13875
- * @param {string} tcp The unique identifier of a TCP.
14049
+ * @param {Behavior} [behavior]
13876
14050
  * @param {*} [options] Override http request option.
13877
14051
  * @throws {RequiredError}
13878
14052
  */
13879
- deleteVirtualRobotTcp: async (cell: string, controller: string, motionGroup: string, tcp: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
14053
+ setVirtualRobotBehavior: async (cell: string, controller: string, behavior?: Behavior, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
13880
14054
  // verify required parameter 'cell' is not null or undefined
13881
- assertParamExists('deleteVirtualRobotTcp', 'cell', cell)
14055
+ assertParamExists('setVirtualRobotBehavior', 'cell', cell)
13882
14056
  // verify required parameter 'controller' is not null or undefined
13883
- assertParamExists('deleteVirtualRobotTcp', 'controller', controller)
13884
- // verify required parameter 'motionGroup' is not null or undefined
13885
- assertParamExists('deleteVirtualRobotTcp', 'motionGroup', motionGroup)
13886
- // verify required parameter 'tcp' is not null or undefined
13887
- assertParamExists('deleteVirtualRobotTcp', 'tcp', tcp)
13888
- const localVarPath = `/cells/{cell}/controllers/{controller}/teach-pendant/motion-groups/{motion-group}/tcps/{tcp}`
14057
+ assertParamExists('setVirtualRobotBehavior', 'controller', controller)
14058
+ const localVarPath = `/cells/{cell}/virtual-controllers/{controller}/behavior`
13889
14059
  .replace(`{${"cell"}}`, encodeURIComponent(String(cell)))
13890
- .replace(`{${"controller"}}`, encodeURIComponent(String(controller)))
13891
- .replace(`{${"motion-group"}}`, encodeURIComponent(String(motionGroup)))
13892
- .replace(`{${"tcp"}}`, encodeURIComponent(String(tcp)));
14060
+ .replace(`{${"controller"}}`, encodeURIComponent(String(controller)));
13893
14061
  // use dummy base URL string because the URL constructor only accepts absolute URLs.
13894
14062
  const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
13895
14063
  let baseOptions;
@@ -13897,7 +14065,7 @@ export const VirtualRobotSetupApiAxiosParamCreator = function (configuration?: C
13897
14065
  baseOptions = configuration.baseOptions;
13898
14066
  }
13899
14067
 
13900
- const localVarRequestOptions = { method: 'DELETE', ...baseOptions, ...options};
14068
+ const localVarRequestOptions = { method: 'PUT', ...baseOptions, ...options};
13901
14069
  const localVarHeaderParameter = {} as any;
13902
14070
  const localVarQueryParameter = {} as any;
13903
14071
 
@@ -13909,6 +14077,10 @@ export const VirtualRobotSetupApiAxiosParamCreator = function (configuration?: C
13909
14077
  // http bearer authentication required
13910
14078
  await setBearerAuthToObject(localVarHeaderParameter, configuration)
13911
14079
 
14080
+ if (behavior !== undefined) {
14081
+ localVarQueryParameter['behavior'] = behavior;
14082
+ }
14083
+
13912
14084
 
13913
14085
 
13914
14086
  setSearchParams(localVarUrlObj, localVarQueryParameter);
@@ -13920,70 +14092,220 @@ export const VirtualRobotSetupApiAxiosParamCreator = function (configuration?: C
13920
14092
  options: localVarRequestOptions,
13921
14093
  };
13922
14094
  },
14095
+ }
14096
+ };
14097
+
14098
+ /**
14099
+ * VirtualControllerBehaviorApi - functional programming interface
14100
+ * @export
14101
+ */
14102
+ export const VirtualControllerBehaviorApiFp = function(configuration?: Configuration) {
14103
+ const localVarAxiosParamCreator = VirtualControllerBehaviorApiAxiosParamCreator(configuration)
14104
+ return {
13923
14105
  /**
13924
- * Gets motion group mounting. The motion group is based on the origin of the returned coordinate system.
13925
- * @summary Get Mounting
14106
+ * <!-- 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.
14107
+ * @summary Stream Joint Configuration
13926
14108
  * @param {string} cell Unique identifier addressing a cell in all API calls.
13927
14109
  * @param {string} controller Unique identifier to address a controller in the cell.
13928
- * @param {string} motionGroup The motion-group identifier.
14110
+ * @param {ExternalJointStreamRequest} externalJointStreamRequest
13929
14111
  * @param {*} [options] Override http request option.
13930
14112
  * @throws {RequiredError}
13931
14113
  */
13932
- getVirtualRobotMounting: async (cell: string, controller: string, motionGroup: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
13933
- // verify required parameter 'cell' is not null or undefined
13934
- assertParamExists('getVirtualRobotMounting', 'cell', cell)
13935
- // verify required parameter 'controller' is not null or undefined
13936
- assertParamExists('getVirtualRobotMounting', 'controller', controller)
13937
- // verify required parameter 'motionGroup' is not null or undefined
13938
- assertParamExists('getVirtualRobotMounting', 'motionGroup', motionGroup)
13939
- const localVarPath = `/cells/{cell}/controllers/{controller}/teach-pendant/motion-groups/{motion-group}/mounting`
13940
- .replace(`{${"cell"}}`, encodeURIComponent(String(cell)))
13941
- .replace(`{${"controller"}}`, encodeURIComponent(String(controller)))
13942
- .replace(`{${"motion-group"}}`, encodeURIComponent(String(motionGroup)));
13943
- // use dummy base URL string because the URL constructor only accepts absolute URLs.
13944
- const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
13945
- let baseOptions;
13946
- if (configuration) {
13947
- baseOptions = configuration.baseOptions;
13948
- }
13949
-
13950
- const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
13951
- const localVarHeaderParameter = {} as any;
13952
- const localVarQueryParameter = {} as any;
13953
-
13954
- // authentication BasicAuth required
13955
- // http basic authentication required
13956
- setBasicAuthToObject(localVarRequestOptions, configuration)
13957
-
13958
- // authentication BearerAuth required
13959
- // http bearer authentication required
13960
- await setBearerAuthToObject(localVarHeaderParameter, configuration)
14114
+ async externalJointsStream(cell: string, controller: string, externalJointStreamRequest: ExternalJointStreamRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<ExternalJointStreamDatapoint>>> {
14115
+ const localVarAxiosArgs = await localVarAxiosParamCreator.externalJointsStream(cell, controller, externalJointStreamRequest, options);
14116
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
14117
+ const localVarOperationServerBasePath = operationServerMap['VirtualControllerBehaviorApi.externalJointsStream']?.[localVarOperationServerIndex]?.url;
14118
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
14119
+ },
14120
+ /**
14121
+ * Get the cycle time of controller communication in [ms].
14122
+ * @summary Get Cycle Time
14123
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
14124
+ * @param {string} controller Unique identifier to address a controller in the cell.
14125
+ * @param {*} [options] Override http request option.
14126
+ * @throws {RequiredError}
14127
+ */
14128
+ async getCycleTime(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CycleTime>> {
14129
+ const localVarAxiosArgs = await localVarAxiosParamCreator.getCycleTime(cell, controller, options);
14130
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
14131
+ const localVarOperationServerBasePath = operationServerMap['VirtualControllerBehaviorApi.getCycleTime']?.[localVarOperationServerIndex]?.url;
14132
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
14133
+ },
14134
+ /**
14135
+ * Get the current virtual controller behavior - please see the setter [setVirtualRobotBehavior](setVirtualRobotBehavior) and the enum for details.
14136
+ * @summary Get Behavior
14137
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
14138
+ * @param {string} controller Unique identifier to address a controller in the cell.
14139
+ * @param {*} [options] Override http request option.
14140
+ * @throws {RequiredError}
14141
+ */
14142
+ async getVirtualRobotBehavior(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Behavior>> {
14143
+ const localVarAxiosArgs = await localVarAxiosParamCreator.getVirtualRobotBehavior(cell, controller, options);
14144
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
14145
+ const localVarOperationServerBasePath = operationServerMap['VirtualControllerBehaviorApi.getVirtualRobotBehavior']?.[localVarOperationServerIndex]?.url;
14146
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
14147
+ },
14148
+ /**
14149
+ * Set virtual controller behavior.
14150
+ * @summary Set Behavior
14151
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
14152
+ * @param {string} controller Unique identifier to address a controller in the cell.
14153
+ * @param {Behavior} [behavior]
14154
+ * @param {*} [options] Override http request option.
14155
+ * @throws {RequiredError}
14156
+ */
14157
+ async setVirtualRobotBehavior(cell: string, controller: string, behavior?: Behavior, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> {
14158
+ const localVarAxiosArgs = await localVarAxiosParamCreator.setVirtualRobotBehavior(cell, controller, behavior, options);
14159
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
14160
+ const localVarOperationServerBasePath = operationServerMap['VirtualControllerBehaviorApi.setVirtualRobotBehavior']?.[localVarOperationServerIndex]?.url;
14161
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
14162
+ },
14163
+ }
14164
+ };
13961
14165
 
14166
+ /**
14167
+ * VirtualControllerBehaviorApi - factory interface
14168
+ * @export
14169
+ */
14170
+ export const VirtualControllerBehaviorApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
14171
+ const localVarFp = VirtualControllerBehaviorApiFp(configuration)
14172
+ return {
14173
+ /**
14174
+ * <!-- 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.
14175
+ * @summary Stream Joint Configuration
14176
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
14177
+ * @param {string} controller Unique identifier to address a controller in the cell.
14178
+ * @param {ExternalJointStreamRequest} externalJointStreamRequest
14179
+ * @param {*} [options] Override http request option.
14180
+ * @throws {RequiredError}
14181
+ */
14182
+ externalJointsStream(cell: string, controller: string, externalJointStreamRequest: ExternalJointStreamRequest, options?: RawAxiosRequestConfig): AxiosPromise<Array<ExternalJointStreamDatapoint>> {
14183
+ return localVarFp.externalJointsStream(cell, controller, externalJointStreamRequest, options).then((request) => request(axios, basePath));
14184
+ },
14185
+ /**
14186
+ * Get the cycle time of controller communication in [ms].
14187
+ * @summary Get Cycle Time
14188
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
14189
+ * @param {string} controller Unique identifier to address a controller in the cell.
14190
+ * @param {*} [options] Override http request option.
14191
+ * @throws {RequiredError}
14192
+ */
14193
+ getCycleTime(cell: string, controller: string, options?: RawAxiosRequestConfig): AxiosPromise<CycleTime> {
14194
+ return localVarFp.getCycleTime(cell, controller, options).then((request) => request(axios, basePath));
14195
+ },
14196
+ /**
14197
+ * Get the current virtual controller behavior - please see the setter [setVirtualRobotBehavior](setVirtualRobotBehavior) and the enum for details.
14198
+ * @summary Get Behavior
14199
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
14200
+ * @param {string} controller Unique identifier to address a controller in the cell.
14201
+ * @param {*} [options] Override http request option.
14202
+ * @throws {RequiredError}
14203
+ */
14204
+ getVirtualRobotBehavior(cell: string, controller: string, options?: RawAxiosRequestConfig): AxiosPromise<Behavior> {
14205
+ return localVarFp.getVirtualRobotBehavior(cell, controller, options).then((request) => request(axios, basePath));
14206
+ },
14207
+ /**
14208
+ * Set virtual controller behavior.
14209
+ * @summary Set Behavior
14210
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
14211
+ * @param {string} controller Unique identifier to address a controller in the cell.
14212
+ * @param {Behavior} [behavior]
14213
+ * @param {*} [options] Override http request option.
14214
+ * @throws {RequiredError}
14215
+ */
14216
+ setVirtualRobotBehavior(cell: string, controller: string, behavior?: Behavior, options?: RawAxiosRequestConfig): AxiosPromise<void> {
14217
+ return localVarFp.setVirtualRobotBehavior(cell, controller, behavior, options).then((request) => request(axios, basePath));
14218
+ },
14219
+ };
14220
+ };
13962
14221
 
13963
-
13964
- setSearchParams(localVarUrlObj, localVarQueryParameter);
13965
- let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
13966
- localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
14222
+ /**
14223
+ * VirtualControllerBehaviorApi - object-oriented interface
14224
+ * @export
14225
+ * @class VirtualControllerBehaviorApi
14226
+ * @extends {BaseAPI}
14227
+ */
14228
+ export class VirtualControllerBehaviorApi extends BaseAPI {
14229
+ /**
14230
+ * <!-- 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.
14231
+ * @summary Stream Joint Configuration
14232
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
14233
+ * @param {string} controller Unique identifier to address a controller in the cell.
14234
+ * @param {ExternalJointStreamRequest} externalJointStreamRequest
14235
+ * @param {*} [options] Override http request option.
14236
+ * @throws {RequiredError}
14237
+ * @memberof VirtualControllerBehaviorApi
14238
+ */
14239
+ public externalJointsStream(cell: string, controller: string, externalJointStreamRequest: ExternalJointStreamRequest, options?: RawAxiosRequestConfig) {
14240
+ return VirtualControllerBehaviorApiFp(this.configuration).externalJointsStream(cell, controller, externalJointStreamRequest, options).then((request) => request(this.axios, this.basePath));
14241
+ }
13967
14242
 
13968
- return {
13969
- url: toPathString(localVarUrlObj),
13970
- options: localVarRequestOptions,
13971
- };
13972
- },
14243
+ /**
14244
+ * Get the cycle time of controller communication in [ms].
14245
+ * @summary Get Cycle Time
14246
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
14247
+ * @param {string} controller Unique identifier to address a controller in the cell.
14248
+ * @param {*} [options] Override http request option.
14249
+ * @throws {RequiredError}
14250
+ * @memberof VirtualControllerBehaviorApi
14251
+ */
14252
+ public getCycleTime(cell: string, controller: string, options?: RawAxiosRequestConfig) {
14253
+ return VirtualControllerBehaviorApiFp(this.configuration).getCycleTime(cell, controller, options).then((request) => request(this.axios, this.basePath));
14254
+ }
14255
+
14256
+ /**
14257
+ * Get the current virtual controller behavior - please see the setter [setVirtualRobotBehavior](setVirtualRobotBehavior) and the enum for details.
14258
+ * @summary Get Behavior
14259
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
14260
+ * @param {string} controller Unique identifier to address a controller in the cell.
14261
+ * @param {*} [options] Override http request option.
14262
+ * @throws {RequiredError}
14263
+ * @memberof VirtualControllerBehaviorApi
14264
+ */
14265
+ public getVirtualRobotBehavior(cell: string, controller: string, options?: RawAxiosRequestConfig) {
14266
+ return VirtualControllerBehaviorApiFp(this.configuration).getVirtualRobotBehavior(cell, controller, options).then((request) => request(this.axios, this.basePath));
14267
+ }
14268
+
14269
+ /**
14270
+ * Set virtual controller behavior.
14271
+ * @summary Set Behavior
14272
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
14273
+ * @param {string} controller Unique identifier to address a controller in the cell.
14274
+ * @param {Behavior} [behavior]
14275
+ * @param {*} [options] Override http request option.
14276
+ * @throws {RequiredError}
14277
+ * @memberof VirtualControllerBehaviorApi
14278
+ */
14279
+ public setVirtualRobotBehavior(cell: string, controller: string, behavior?: Behavior, options?: RawAxiosRequestConfig) {
14280
+ return VirtualControllerBehaviorApiFp(this.configuration).setVirtualRobotBehavior(cell, controller, behavior, options).then((request) => request(this.axios, this.basePath));
14281
+ }
14282
+ }
14283
+
14284
+
14285
+
14286
+ /**
14287
+ * VirtualControllerInputsOutputsApi - axios parameter creator
14288
+ * @export
14289
+ */
14290
+ export const VirtualControllerInputsOutputsApiAxiosParamCreator = function (configuration?: Configuration) {
14291
+ return {
13973
14292
  /**
13974
- * Lists all coordinate systems on the robot controller.
13975
- * @summary List Coordinate Systems
14293
+ * 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).
14294
+ * @summary Get Input/Output Values
13976
14295
  * @param {string} cell Unique identifier addressing a cell in all API calls.
13977
14296
  * @param {string} controller Unique identifier to address a controller in the cell.
14297
+ * @param {Array<string>} ios
13978
14298
  * @param {*} [options] Override http request option.
13979
14299
  * @throws {RequiredError}
13980
14300
  */
13981
- listVirtualRobotCoordinateSystems: async (cell: string, controller: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
14301
+ listIOs: async (cell: string, controller: string, ios: Array<string>, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
13982
14302
  // verify required parameter 'cell' is not null or undefined
13983
- assertParamExists('listVirtualRobotCoordinateSystems', 'cell', cell)
14303
+ assertParamExists('listIOs', 'cell', cell)
13984
14304
  // verify required parameter 'controller' is not null or undefined
13985
- assertParamExists('listVirtualRobotCoordinateSystems', 'controller', controller)
13986
- const localVarPath = `/cells/{cell}/controllers/{controller}/teach-pendant/coordinate-systems`
14305
+ assertParamExists('listIOs', 'controller', controller)
14306
+ // verify required parameter 'ios' is not null or undefined
14307
+ assertParamExists('listIOs', 'ios', ios)
14308
+ const localVarPath = `/cells/{cell}/virtual-controllers/{controller}/ios/values`
13987
14309
  .replace(`{${"cell"}}`, encodeURIComponent(String(cell)))
13988
14310
  .replace(`{${"controller"}}`, encodeURIComponent(String(controller)));
13989
14311
  // use dummy base URL string because the URL constructor only accepts absolute URLs.
@@ -14005,6 +14327,10 @@ export const VirtualRobotSetupApiAxiosParamCreator = function (configuration?: C
14005
14327
  // http bearer authentication required
14006
14328
  await setBearerAuthToObject(localVarHeaderParameter, configuration)
14007
14329
 
14330
+ if (ios) {
14331
+ localVarQueryParameter['ios'] = ios;
14332
+ }
14333
+
14008
14334
 
14009
14335
 
14010
14336
  setSearchParams(localVarUrlObj, localVarQueryParameter);
@@ -14017,25 +14343,25 @@ export const VirtualRobotSetupApiAxiosParamCreator = function (configuration?: C
14017
14343
  };
14018
14344
  },
14019
14345
  /**
14020
- * Lists TCPs of the motion group. An empty TCP list is valid, for example for external axes.
14021
- * @summary List TCPs
14346
+ * 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.
14347
+ * @summary List Descriptions
14022
14348
  * @param {string} cell Unique identifier addressing a cell in all API calls.
14023
14349
  * @param {string} controller Unique identifier to address a controller in the cell.
14024
- * @param {string} motionGroup The motion-group identifier.
14350
+ * @param {Array<string>} [ios]
14351
+ * @param {IODirection} [direction] Return only inputs/outputs with the specified direction.
14352
+ * @param {IOValueType} [valueType] Return only inputs/outputs with the specified value type.
14353
+ * @param {string} [group] Return only inputs/outputs from the specified group.
14025
14354
  * @param {*} [options] Override http request option.
14026
14355
  * @throws {RequiredError}
14027
14356
  */
14028
- listVirtualRobotTcps: async (cell: string, controller: string, motionGroup: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
14357
+ listVirtualRobotIODescriptions: async (cell: string, controller: string, ios?: Array<string>, direction?: IODirection, valueType?: IOValueType, group?: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
14029
14358
  // verify required parameter 'cell' is not null or undefined
14030
- assertParamExists('listVirtualRobotTcps', 'cell', cell)
14359
+ assertParamExists('listVirtualRobotIODescriptions', 'cell', cell)
14031
14360
  // verify required parameter 'controller' is not null or undefined
14032
- assertParamExists('listVirtualRobotTcps', 'controller', controller)
14033
- // verify required parameter 'motionGroup' is not null or undefined
14034
- assertParamExists('listVirtualRobotTcps', 'motionGroup', motionGroup)
14035
- const localVarPath = `/cells/{cell}/controllers/{controller}/teach-pendant/motion-groups/{motion-group}/tcps`
14361
+ assertParamExists('listVirtualRobotIODescriptions', 'controller', controller)
14362
+ const localVarPath = `/cells/{cell}/virtual-controllers/{controller}/ios/description`
14036
14363
  .replace(`{${"cell"}}`, encodeURIComponent(String(cell)))
14037
- .replace(`{${"controller"}}`, encodeURIComponent(String(controller)))
14038
- .replace(`{${"motion-group"}}`, encodeURIComponent(String(motionGroup)));
14364
+ .replace(`{${"controller"}}`, encodeURIComponent(String(controller)));
14039
14365
  // use dummy base URL string because the URL constructor only accepts absolute URLs.
14040
14366
  const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
14041
14367
  let baseOptions;
@@ -14055,6 +14381,22 @@ export const VirtualRobotSetupApiAxiosParamCreator = function (configuration?: C
14055
14381
  // http bearer authentication required
14056
14382
  await setBearerAuthToObject(localVarHeaderParameter, configuration)
14057
14383
 
14384
+ if (ios) {
14385
+ localVarQueryParameter['ios'] = ios;
14386
+ }
14387
+
14388
+ if (direction !== undefined) {
14389
+ localVarQueryParameter['direction'] = direction;
14390
+ }
14391
+
14392
+ if (valueType !== undefined) {
14393
+ localVarQueryParameter['value_type'] = valueType;
14394
+ }
14395
+
14396
+ if (group !== undefined) {
14397
+ localVarQueryParameter['group'] = group;
14398
+ }
14399
+
14058
14400
 
14059
14401
 
14060
14402
  setSearchParams(localVarUrlObj, localVarQueryParameter);
@@ -14067,28 +14409,24 @@ export const VirtualRobotSetupApiAxiosParamCreator = function (configuration?: C
14067
14409
  };
14068
14410
  },
14069
14411
  /**
14070
- * 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.
14071
- * @summary Set Mounting
14412
+ * Sets a list of values of a virtual controller inputs/outputs.
14413
+ * @summary Set Input/Ouput Values
14072
14414
  * @param {string} cell Unique identifier addressing a cell in all API calls.
14073
14415
  * @param {string} controller Unique identifier to address a controller in the cell.
14074
- * @param {string} motionGroup The motion-group identifier.
14075
- * @param {CoordinateSystem} coordinateSystem
14416
+ * @param {Array<IOValue>} iOValue
14076
14417
  * @param {*} [options] Override http request option.
14077
14418
  * @throws {RequiredError}
14078
14419
  */
14079
- setVirtualRobotMounting: async (cell: string, controller: string, motionGroup: string, coordinateSystem: CoordinateSystem, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
14420
+ setIOValues: async (cell: string, controller: string, iOValue: Array<IOValue>, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
14080
14421
  // verify required parameter 'cell' is not null or undefined
14081
- assertParamExists('setVirtualRobotMounting', 'cell', cell)
14422
+ assertParamExists('setIOValues', 'cell', cell)
14082
14423
  // verify required parameter 'controller' is not null or undefined
14083
- assertParamExists('setVirtualRobotMounting', 'controller', controller)
14084
- // verify required parameter 'motionGroup' is not null or undefined
14085
- assertParamExists('setVirtualRobotMounting', 'motionGroup', motionGroup)
14086
- // verify required parameter 'coordinateSystem' is not null or undefined
14087
- assertParamExists('setVirtualRobotMounting', 'coordinateSystem', coordinateSystem)
14088
- const localVarPath = `/cells/{cell}/controllers/{controller}/teach-pendant/motion-groups/{motion-group}/mounting`
14424
+ assertParamExists('setIOValues', 'controller', controller)
14425
+ // verify required parameter 'iOValue' is not null or undefined
14426
+ assertParamExists('setIOValues', 'iOValue', iOValue)
14427
+ const localVarPath = `/cells/{cell}/virtual-controllers/{controller}/ios/values`
14089
14428
  .replace(`{${"cell"}}`, encodeURIComponent(String(cell)))
14090
- .replace(`{${"controller"}}`, encodeURIComponent(String(controller)))
14091
- .replace(`{${"motion-group"}}`, encodeURIComponent(String(motionGroup)));
14429
+ .replace(`{${"controller"}}`, encodeURIComponent(String(controller)));
14092
14430
  // use dummy base URL string because the URL constructor only accepts absolute URLs.
14093
14431
  const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
14094
14432
  let baseOptions;
@@ -14115,7 +14453,7 @@ export const VirtualRobotSetupApiAxiosParamCreator = function (configuration?: C
14115
14453
  setSearchParams(localVarUrlObj, localVarQueryParameter);
14116
14454
  let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
14117
14455
  localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
14118
- localVarRequestOptions.data = serializeDataIfNeeded(coordinateSystem, localVarRequestOptions, configuration)
14456
+ localVarRequestOptions.data = serializeDataIfNeeded(iOValue, localVarRequestOptions, configuration)
14119
14457
 
14120
14458
  return {
14121
14459
  url: toPathString(localVarUrlObj),
@@ -14126,367 +14464,162 @@ export const VirtualRobotSetupApiAxiosParamCreator = function (configuration?: C
14126
14464
  };
14127
14465
 
14128
14466
  /**
14129
- * VirtualRobotSetupApi - functional programming interface
14467
+ * VirtualControllerInputsOutputsApi - functional programming interface
14130
14468
  * @export
14131
14469
  */
14132
- export const VirtualRobotSetupApiFp = function(configuration?: Configuration) {
14133
- const localVarAxiosParamCreator = VirtualRobotSetupApiAxiosParamCreator(configuration)
14470
+ export const VirtualControllerInputsOutputsApiFp = function(configuration?: Configuration) {
14471
+ const localVarAxiosParamCreator = VirtualControllerInputsOutputsApiAxiosParamCreator(configuration)
14134
14472
  return {
14135
14473
  /**
14136
- * Adds a coordinate system to the robot controller.
14137
- * @summary Add Coordinate Systems
14138
- * @param {string} cell Unique identifier addressing a cell in all API calls.
14139
- * @param {string} controller Unique identifier to address a controller in the cell.
14140
- * @param {CoordinateSystem} coordinateSystem
14141
- * @param {*} [options] Override http request option.
14142
- * @throws {RequiredError}
14143
- */
14144
- async addVirtualRobotCoordinateSystem(cell: string, controller: string, coordinateSystem: CoordinateSystem, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> {
14145
- const localVarAxiosArgs = await localVarAxiosParamCreator.addVirtualRobotCoordinateSystem(cell, controller, coordinateSystem, options);
14146
- const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
14147
- const localVarOperationServerBasePath = operationServerMap['VirtualRobotSetupApi.addVirtualRobotCoordinateSystem']?.[localVarOperationServerIndex]?.url;
14148
- return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
14149
- },
14150
- /**
14151
- * 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.
14152
- * @summary Add TCP
14153
- * @param {string} cell Unique identifier addressing a cell in all API calls.
14154
- * @param {string} controller Unique identifier to address a controller in the cell.
14155
- * @param {string} motionGroup The motion-group identifier.
14156
- * @param {RobotTcp} robotTcp
14157
- * @param {*} [options] Override http request option.
14158
- * @throws {RequiredError}
14159
- */
14160
- async addVirtualRobotTcp(cell: string, controller: string, motionGroup: string, robotTcp: RobotTcp, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> {
14161
- const localVarAxiosArgs = await localVarAxiosParamCreator.addVirtualRobotTcp(cell, controller, motionGroup, robotTcp, options);
14162
- const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
14163
- const localVarOperationServerBasePath = operationServerMap['VirtualRobotSetupApi.addVirtualRobotTcp']?.[localVarOperationServerIndex]?.url;
14164
- return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
14165
- },
14166
- /**
14167
- * 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.
14168
- * @summary Remove Coordinate System
14169
- * @param {string} cell Unique identifier addressing a cell in all API calls.
14170
- * @param {string} controller Unique identifier to address a controller in the cell.
14171
- * @param {string} coordinateSystem Unique identifier addressing a coordinate system.
14172
- * @param {boolean} [deleteDependent] If true, all dependent coordinate systems will be deleted as well.
14173
- * @param {*} [options] Override http request option.
14174
- * @throws {RequiredError}
14175
- */
14176
- async deleteVirtualRobotCoordinateSystem(cell: string, controller: string, coordinateSystem: string, deleteDependent?: boolean, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> {
14177
- const localVarAxiosArgs = await localVarAxiosParamCreator.deleteVirtualRobotCoordinateSystem(cell, controller, coordinateSystem, deleteDependent, options);
14178
- const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
14179
- const localVarOperationServerBasePath = operationServerMap['VirtualRobotSetupApi.deleteVirtualRobotCoordinateSystem']?.[localVarOperationServerIndex]?.url;
14180
- return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
14181
- },
14182
- /**
14183
- * Removes the TCP from the motion group. An unknown TCP is a valid input.
14184
- * @summary Remove TCP
14185
- * @param {string} cell Unique identifier addressing a cell in all API calls.
14186
- * @param {string} controller Unique identifier to address a controller in the cell.
14187
- * @param {string} motionGroup The motion-group identifier.
14188
- * @param {string} tcp The unique identifier of a TCP.
14189
- * @param {*} [options] Override http request option.
14190
- * @throws {RequiredError}
14191
- */
14192
- async deleteVirtualRobotTcp(cell: string, controller: string, motionGroup: string, tcp: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> {
14193
- const localVarAxiosArgs = await localVarAxiosParamCreator.deleteVirtualRobotTcp(cell, controller, motionGroup, tcp, options);
14194
- const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
14195
- const localVarOperationServerBasePath = operationServerMap['VirtualRobotSetupApi.deleteVirtualRobotTcp']?.[localVarOperationServerIndex]?.url;
14196
- return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
14197
- },
14198
- /**
14199
- * Gets motion group mounting. The motion group is based on the origin of the returned coordinate system.
14200
- * @summary Get Mounting
14201
- * @param {string} cell Unique identifier addressing a cell in all API calls.
14202
- * @param {string} controller Unique identifier to address a controller in the cell.
14203
- * @param {string} motionGroup The motion-group identifier.
14204
- * @param {*} [options] Override http request option.
14205
- * @throws {RequiredError}
14206
- */
14207
- async getVirtualRobotMounting(cell: string, controller: string, motionGroup: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CoordinateSystem>> {
14208
- const localVarAxiosArgs = await localVarAxiosParamCreator.getVirtualRobotMounting(cell, controller, motionGroup, options);
14209
- const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
14210
- const localVarOperationServerBasePath = operationServerMap['VirtualRobotSetupApi.getVirtualRobotMounting']?.[localVarOperationServerIndex]?.url;
14211
- return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
14212
- },
14213
- /**
14214
- * Lists all coordinate systems on the robot controller.
14215
- * @summary List Coordinate Systems
14474
+ * 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).
14475
+ * @summary Get Input/Output Values
14216
14476
  * @param {string} cell Unique identifier addressing a cell in all API calls.
14217
14477
  * @param {string} controller Unique identifier to address a controller in the cell.
14478
+ * @param {Array<string>} ios
14218
14479
  * @param {*} [options] Override http request option.
14219
14480
  * @throws {RequiredError}
14220
14481
  */
14221
- async listVirtualRobotCoordinateSystems(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CoordinateSystems>> {
14222
- const localVarAxiosArgs = await localVarAxiosParamCreator.listVirtualRobotCoordinateSystems(cell, controller, options);
14482
+ async listIOs(cell: string, controller: string, ios: Array<string>, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<IOValue>>> {
14483
+ const localVarAxiosArgs = await localVarAxiosParamCreator.listIOs(cell, controller, ios, options);
14223
14484
  const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
14224
- const localVarOperationServerBasePath = operationServerMap['VirtualRobotSetupApi.listVirtualRobotCoordinateSystems']?.[localVarOperationServerIndex]?.url;
14485
+ const localVarOperationServerBasePath = operationServerMap['VirtualControllerInputsOutputsApi.listIOs']?.[localVarOperationServerIndex]?.url;
14225
14486
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
14226
14487
  },
14227
14488
  /**
14228
- * Lists TCPs of the motion group. An empty TCP list is valid, for example for external axes.
14229
- * @summary List TCPs
14489
+ * 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.
14490
+ * @summary List Descriptions
14230
14491
  * @param {string} cell Unique identifier addressing a cell in all API calls.
14231
14492
  * @param {string} controller Unique identifier to address a controller in the cell.
14232
- * @param {string} motionGroup The motion-group identifier.
14493
+ * @param {Array<string>} [ios]
14494
+ * @param {IODirection} [direction] Return only inputs/outputs with the specified direction.
14495
+ * @param {IOValueType} [valueType] Return only inputs/outputs with the specified value type.
14496
+ * @param {string} [group] Return only inputs/outputs from the specified group.
14233
14497
  * @param {*} [options] Override http request option.
14234
14498
  * @throws {RequiredError}
14235
14499
  */
14236
- async listVirtualRobotTcps(cell: string, controller: string, motionGroup: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<RobotTcps>> {
14237
- const localVarAxiosArgs = await localVarAxiosParamCreator.listVirtualRobotTcps(cell, controller, motionGroup, options);
14500
+ async listVirtualRobotIODescriptions(cell: string, controller: string, ios?: Array<string>, direction?: IODirection, valueType?: IOValueType, group?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<IODescription>>> {
14501
+ const localVarAxiosArgs = await localVarAxiosParamCreator.listVirtualRobotIODescriptions(cell, controller, ios, direction, valueType, group, options);
14238
14502
  const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
14239
- const localVarOperationServerBasePath = operationServerMap['VirtualRobotSetupApi.listVirtualRobotTcps']?.[localVarOperationServerIndex]?.url;
14503
+ const localVarOperationServerBasePath = operationServerMap['VirtualControllerInputsOutputsApi.listVirtualRobotIODescriptions']?.[localVarOperationServerIndex]?.url;
14240
14504
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
14241
14505
  },
14242
14506
  /**
14243
- * 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.
14244
- * @summary Set Mounting
14507
+ * Sets a list of values of a virtual controller inputs/outputs.
14508
+ * @summary Set Input/Ouput Values
14245
14509
  * @param {string} cell Unique identifier addressing a cell in all API calls.
14246
14510
  * @param {string} controller Unique identifier to address a controller in the cell.
14247
- * @param {string} motionGroup The motion-group identifier.
14248
- * @param {CoordinateSystem} coordinateSystem
14511
+ * @param {Array<IOValue>} iOValue
14249
14512
  * @param {*} [options] Override http request option.
14250
14513
  * @throws {RequiredError}
14251
14514
  */
14252
- async setVirtualRobotMounting(cell: string, controller: string, motionGroup: string, coordinateSystem: CoordinateSystem, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CoordinateSystem>> {
14253
- const localVarAxiosArgs = await localVarAxiosParamCreator.setVirtualRobotMounting(cell, controller, motionGroup, coordinateSystem, options);
14515
+ async setIOValues(cell: string, controller: string, iOValue: Array<IOValue>, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> {
14516
+ const localVarAxiosArgs = await localVarAxiosParamCreator.setIOValues(cell, controller, iOValue, options);
14254
14517
  const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
14255
- const localVarOperationServerBasePath = operationServerMap['VirtualRobotSetupApi.setVirtualRobotMounting']?.[localVarOperationServerIndex]?.url;
14518
+ const localVarOperationServerBasePath = operationServerMap['VirtualControllerInputsOutputsApi.setIOValues']?.[localVarOperationServerIndex]?.url;
14256
14519
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
14257
14520
  },
14258
14521
  }
14259
14522
  };
14260
14523
 
14261
14524
  /**
14262
- * VirtualRobotSetupApi - factory interface
14525
+ * VirtualControllerInputsOutputsApi - factory interface
14263
14526
  * @export
14264
14527
  */
14265
- export const VirtualRobotSetupApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
14266
- const localVarFp = VirtualRobotSetupApiFp(configuration)
14528
+ export const VirtualControllerInputsOutputsApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
14529
+ const localVarFp = VirtualControllerInputsOutputsApiFp(configuration)
14267
14530
  return {
14268
14531
  /**
14269
- * Adds a coordinate system to the robot controller.
14270
- * @summary Add Coordinate Systems
14271
- * @param {string} cell Unique identifier addressing a cell in all API calls.
14272
- * @param {string} controller Unique identifier to address a controller in the cell.
14273
- * @param {CoordinateSystem} coordinateSystem
14274
- * @param {*} [options] Override http request option.
14275
- * @throws {RequiredError}
14276
- */
14277
- addVirtualRobotCoordinateSystem(cell: string, controller: string, coordinateSystem: CoordinateSystem, options?: RawAxiosRequestConfig): AxiosPromise<void> {
14278
- return localVarFp.addVirtualRobotCoordinateSystem(cell, controller, coordinateSystem, options).then((request) => request(axios, basePath));
14279
- },
14280
- /**
14281
- * 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.
14282
- * @summary Add TCP
14283
- * @param {string} cell Unique identifier addressing a cell in all API calls.
14284
- * @param {string} controller Unique identifier to address a controller in the cell.
14285
- * @param {string} motionGroup The motion-group identifier.
14286
- * @param {RobotTcp} robotTcp
14287
- * @param {*} [options] Override http request option.
14288
- * @throws {RequiredError}
14289
- */
14290
- addVirtualRobotTcp(cell: string, controller: string, motionGroup: string, robotTcp: RobotTcp, options?: RawAxiosRequestConfig): AxiosPromise<void> {
14291
- return localVarFp.addVirtualRobotTcp(cell, controller, motionGroup, robotTcp, options).then((request) => request(axios, basePath));
14292
- },
14293
- /**
14294
- * 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.
14295
- * @summary Remove Coordinate System
14296
- * @param {string} cell Unique identifier addressing a cell in all API calls.
14297
- * @param {string} controller Unique identifier to address a controller in the cell.
14298
- * @param {string} coordinateSystem Unique identifier addressing a coordinate system.
14299
- * @param {boolean} [deleteDependent] If true, all dependent coordinate systems will be deleted as well.
14300
- * @param {*} [options] Override http request option.
14301
- * @throws {RequiredError}
14302
- */
14303
- deleteVirtualRobotCoordinateSystem(cell: string, controller: string, coordinateSystem: string, deleteDependent?: boolean, options?: RawAxiosRequestConfig): AxiosPromise<void> {
14304
- return localVarFp.deleteVirtualRobotCoordinateSystem(cell, controller, coordinateSystem, deleteDependent, options).then((request) => request(axios, basePath));
14305
- },
14306
- /**
14307
- * Removes the TCP from the motion group. An unknown TCP is a valid input.
14308
- * @summary Remove TCP
14309
- * @param {string} cell Unique identifier addressing a cell in all API calls.
14310
- * @param {string} controller Unique identifier to address a controller in the cell.
14311
- * @param {string} motionGroup The motion-group identifier.
14312
- * @param {string} tcp The unique identifier of a TCP.
14313
- * @param {*} [options] Override http request option.
14314
- * @throws {RequiredError}
14315
- */
14316
- deleteVirtualRobotTcp(cell: string, controller: string, motionGroup: string, tcp: string, options?: RawAxiosRequestConfig): AxiosPromise<void> {
14317
- return localVarFp.deleteVirtualRobotTcp(cell, controller, motionGroup, tcp, options).then((request) => request(axios, basePath));
14318
- },
14319
- /**
14320
- * Gets motion group mounting. The motion group is based on the origin of the returned coordinate system.
14321
- * @summary Get Mounting
14322
- * @param {string} cell Unique identifier addressing a cell in all API calls.
14323
- * @param {string} controller Unique identifier to address a controller in the cell.
14324
- * @param {string} motionGroup The motion-group identifier.
14325
- * @param {*} [options] Override http request option.
14326
- * @throws {RequiredError}
14327
- */
14328
- getVirtualRobotMounting(cell: string, controller: string, motionGroup: string, options?: RawAxiosRequestConfig): AxiosPromise<CoordinateSystem> {
14329
- return localVarFp.getVirtualRobotMounting(cell, controller, motionGroup, options).then((request) => request(axios, basePath));
14330
- },
14331
- /**
14332
- * Lists all coordinate systems on the robot controller.
14333
- * @summary List Coordinate Systems
14532
+ * 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).
14533
+ * @summary Get Input/Output Values
14334
14534
  * @param {string} cell Unique identifier addressing a cell in all API calls.
14335
14535
  * @param {string} controller Unique identifier to address a controller in the cell.
14536
+ * @param {Array<string>} ios
14336
14537
  * @param {*} [options] Override http request option.
14337
14538
  * @throws {RequiredError}
14338
14539
  */
14339
- listVirtualRobotCoordinateSystems(cell: string, controller: string, options?: RawAxiosRequestConfig): AxiosPromise<CoordinateSystems> {
14340
- return localVarFp.listVirtualRobotCoordinateSystems(cell, controller, options).then((request) => request(axios, basePath));
14540
+ listIOs(cell: string, controller: string, ios: Array<string>, options?: RawAxiosRequestConfig): AxiosPromise<Array<IOValue>> {
14541
+ return localVarFp.listIOs(cell, controller, ios, options).then((request) => request(axios, basePath));
14341
14542
  },
14342
14543
  /**
14343
- * Lists TCPs of the motion group. An empty TCP list is valid, for example for external axes.
14344
- * @summary List TCPs
14544
+ * 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.
14545
+ * @summary List Descriptions
14345
14546
  * @param {string} cell Unique identifier addressing a cell in all API calls.
14346
14547
  * @param {string} controller Unique identifier to address a controller in the cell.
14347
- * @param {string} motionGroup The motion-group identifier.
14548
+ * @param {Array<string>} [ios]
14549
+ * @param {IODirection} [direction] Return only inputs/outputs with the specified direction.
14550
+ * @param {IOValueType} [valueType] Return only inputs/outputs with the specified value type.
14551
+ * @param {string} [group] Return only inputs/outputs from the specified group.
14348
14552
  * @param {*} [options] Override http request option.
14349
14553
  * @throws {RequiredError}
14350
14554
  */
14351
- listVirtualRobotTcps(cell: string, controller: string, motionGroup: string, options?: RawAxiosRequestConfig): AxiosPromise<RobotTcps> {
14352
- return localVarFp.listVirtualRobotTcps(cell, controller, motionGroup, options).then((request) => request(axios, basePath));
14555
+ listVirtualRobotIODescriptions(cell: string, controller: string, ios?: Array<string>, direction?: IODirection, valueType?: IOValueType, group?: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<IODescription>> {
14556
+ return localVarFp.listVirtualRobotIODescriptions(cell, controller, ios, direction, valueType, group, options).then((request) => request(axios, basePath));
14353
14557
  },
14354
14558
  /**
14355
- * 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.
14356
- * @summary Set Mounting
14559
+ * Sets a list of values of a virtual controller inputs/outputs.
14560
+ * @summary Set Input/Ouput Values
14357
14561
  * @param {string} cell Unique identifier addressing a cell in all API calls.
14358
14562
  * @param {string} controller Unique identifier to address a controller in the cell.
14359
- * @param {string} motionGroup The motion-group identifier.
14360
- * @param {CoordinateSystem} coordinateSystem
14563
+ * @param {Array<IOValue>} iOValue
14361
14564
  * @param {*} [options] Override http request option.
14362
14565
  * @throws {RequiredError}
14363
14566
  */
14364
- setVirtualRobotMounting(cell: string, controller: string, motionGroup: string, coordinateSystem: CoordinateSystem, options?: RawAxiosRequestConfig): AxiosPromise<CoordinateSystem> {
14365
- return localVarFp.setVirtualRobotMounting(cell, controller, motionGroup, coordinateSystem, options).then((request) => request(axios, basePath));
14567
+ setIOValues(cell: string, controller: string, iOValue: Array<IOValue>, options?: RawAxiosRequestConfig): AxiosPromise<void> {
14568
+ return localVarFp.setIOValues(cell, controller, iOValue, options).then((request) => request(axios, basePath));
14366
14569
  },
14367
14570
  };
14368
14571
  };
14369
14572
 
14370
14573
  /**
14371
- * VirtualRobotSetupApi - object-oriented interface
14574
+ * VirtualControllerInputsOutputsApi - object-oriented interface
14372
14575
  * @export
14373
- * @class VirtualRobotSetupApi
14576
+ * @class VirtualControllerInputsOutputsApi
14374
14577
  * @extends {BaseAPI}
14375
14578
  */
14376
- export class VirtualRobotSetupApi extends BaseAPI {
14377
- /**
14378
- * Adds a coordinate system to the robot controller.
14379
- * @summary Add Coordinate Systems
14380
- * @param {string} cell Unique identifier addressing a cell in all API calls.
14381
- * @param {string} controller Unique identifier to address a controller in the cell.
14382
- * @param {CoordinateSystem} coordinateSystem
14383
- * @param {*} [options] Override http request option.
14384
- * @throws {RequiredError}
14385
- * @memberof VirtualRobotSetupApi
14386
- */
14387
- public addVirtualRobotCoordinateSystem(cell: string, controller: string, coordinateSystem: CoordinateSystem, options?: RawAxiosRequestConfig) {
14388
- return VirtualRobotSetupApiFp(this.configuration).addVirtualRobotCoordinateSystem(cell, controller, coordinateSystem, options).then((request) => request(this.axios, this.basePath));
14389
- }
14390
-
14391
- /**
14392
- * 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.
14393
- * @summary Add TCP
14394
- * @param {string} cell Unique identifier addressing a cell in all API calls.
14395
- * @param {string} controller Unique identifier to address a controller in the cell.
14396
- * @param {string} motionGroup The motion-group identifier.
14397
- * @param {RobotTcp} robotTcp
14398
- * @param {*} [options] Override http request option.
14399
- * @throws {RequiredError}
14400
- * @memberof VirtualRobotSetupApi
14401
- */
14402
- public addVirtualRobotTcp(cell: string, controller: string, motionGroup: string, robotTcp: RobotTcp, options?: RawAxiosRequestConfig) {
14403
- return VirtualRobotSetupApiFp(this.configuration).addVirtualRobotTcp(cell, controller, motionGroup, robotTcp, options).then((request) => request(this.axios, this.basePath));
14404
- }
14405
-
14406
- /**
14407
- * 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.
14408
- * @summary Remove Coordinate System
14409
- * @param {string} cell Unique identifier addressing a cell in all API calls.
14410
- * @param {string} controller Unique identifier to address a controller in the cell.
14411
- * @param {string} coordinateSystem Unique identifier addressing a coordinate system.
14412
- * @param {boolean} [deleteDependent] If true, all dependent coordinate systems will be deleted as well.
14413
- * @param {*} [options] Override http request option.
14414
- * @throws {RequiredError}
14415
- * @memberof VirtualRobotSetupApi
14416
- */
14417
- public deleteVirtualRobotCoordinateSystem(cell: string, controller: string, coordinateSystem: string, deleteDependent?: boolean, options?: RawAxiosRequestConfig) {
14418
- return VirtualRobotSetupApiFp(this.configuration).deleteVirtualRobotCoordinateSystem(cell, controller, coordinateSystem, deleteDependent, options).then((request) => request(this.axios, this.basePath));
14419
- }
14420
-
14421
- /**
14422
- * Removes the TCP from the motion group. An unknown TCP is a valid input.
14423
- * @summary Remove TCP
14424
- * @param {string} cell Unique identifier addressing a cell in all API calls.
14425
- * @param {string} controller Unique identifier to address a controller in the cell.
14426
- * @param {string} motionGroup The motion-group identifier.
14427
- * @param {string} tcp The unique identifier of a TCP.
14428
- * @param {*} [options] Override http request option.
14429
- * @throws {RequiredError}
14430
- * @memberof VirtualRobotSetupApi
14431
- */
14432
- public deleteVirtualRobotTcp(cell: string, controller: string, motionGroup: string, tcp: string, options?: RawAxiosRequestConfig) {
14433
- return VirtualRobotSetupApiFp(this.configuration).deleteVirtualRobotTcp(cell, controller, motionGroup, tcp, options).then((request) => request(this.axios, this.basePath));
14434
- }
14435
-
14436
- /**
14437
- * Gets motion group mounting. The motion group is based on the origin of the returned coordinate system.
14438
- * @summary Get Mounting
14439
- * @param {string} cell Unique identifier addressing a cell in all API calls.
14440
- * @param {string} controller Unique identifier to address a controller in the cell.
14441
- * @param {string} motionGroup The motion-group identifier.
14442
- * @param {*} [options] Override http request option.
14443
- * @throws {RequiredError}
14444
- * @memberof VirtualRobotSetupApi
14445
- */
14446
- public getVirtualRobotMounting(cell: string, controller: string, motionGroup: string, options?: RawAxiosRequestConfig) {
14447
- return VirtualRobotSetupApiFp(this.configuration).getVirtualRobotMounting(cell, controller, motionGroup, options).then((request) => request(this.axios, this.basePath));
14448
- }
14449
-
14579
+ export class VirtualControllerInputsOutputsApi extends BaseAPI {
14450
14580
  /**
14451
- * Lists all coordinate systems on the robot controller.
14452
- * @summary List Coordinate Systems
14581
+ * 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).
14582
+ * @summary Get Input/Output Values
14453
14583
  * @param {string} cell Unique identifier addressing a cell in all API calls.
14454
14584
  * @param {string} controller Unique identifier to address a controller in the cell.
14585
+ * @param {Array<string>} ios
14455
14586
  * @param {*} [options] Override http request option.
14456
14587
  * @throws {RequiredError}
14457
- * @memberof VirtualRobotSetupApi
14588
+ * @memberof VirtualControllerInputsOutputsApi
14458
14589
  */
14459
- public listVirtualRobotCoordinateSystems(cell: string, controller: string, options?: RawAxiosRequestConfig) {
14460
- return VirtualRobotSetupApiFp(this.configuration).listVirtualRobotCoordinateSystems(cell, controller, options).then((request) => request(this.axios, this.basePath));
14590
+ public listIOs(cell: string, controller: string, ios: Array<string>, options?: RawAxiosRequestConfig) {
14591
+ return VirtualControllerInputsOutputsApiFp(this.configuration).listIOs(cell, controller, ios, options).then((request) => request(this.axios, this.basePath));
14461
14592
  }
14462
14593
 
14463
14594
  /**
14464
- * Lists TCPs of the motion group. An empty TCP list is valid, for example for external axes.
14465
- * @summary List TCPs
14595
+ * 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.
14596
+ * @summary List Descriptions
14466
14597
  * @param {string} cell Unique identifier addressing a cell in all API calls.
14467
14598
  * @param {string} controller Unique identifier to address a controller in the cell.
14468
- * @param {string} motionGroup The motion-group identifier.
14599
+ * @param {Array<string>} [ios]
14600
+ * @param {IODirection} [direction] Return only inputs/outputs with the specified direction.
14601
+ * @param {IOValueType} [valueType] Return only inputs/outputs with the specified value type.
14602
+ * @param {string} [group] Return only inputs/outputs from the specified group.
14469
14603
  * @param {*} [options] Override http request option.
14470
14604
  * @throws {RequiredError}
14471
- * @memberof VirtualRobotSetupApi
14605
+ * @memberof VirtualControllerInputsOutputsApi
14472
14606
  */
14473
- public listVirtualRobotTcps(cell: string, controller: string, motionGroup: string, options?: RawAxiosRequestConfig) {
14474
- return VirtualRobotSetupApiFp(this.configuration).listVirtualRobotTcps(cell, controller, motionGroup, options).then((request) => request(this.axios, this.basePath));
14607
+ public listVirtualRobotIODescriptions(cell: string, controller: string, ios?: Array<string>, direction?: IODirection, valueType?: IOValueType, group?: string, options?: RawAxiosRequestConfig) {
14608
+ return VirtualControllerInputsOutputsApiFp(this.configuration).listVirtualRobotIODescriptions(cell, controller, ios, direction, valueType, group, options).then((request) => request(this.axios, this.basePath));
14475
14609
  }
14476
14610
 
14477
14611
  /**
14478
- * 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.
14479
- * @summary Set Mounting
14612
+ * Sets a list of values of a virtual controller inputs/outputs.
14613
+ * @summary Set Input/Ouput Values
14480
14614
  * @param {string} cell Unique identifier addressing a cell in all API calls.
14481
14615
  * @param {string} controller Unique identifier to address a controller in the cell.
14482
- * @param {string} motionGroup The motion-group identifier.
14483
- * @param {CoordinateSystem} coordinateSystem
14616
+ * @param {Array<IOValue>} iOValue
14484
14617
  * @param {*} [options] Override http request option.
14485
14618
  * @throws {RequiredError}
14486
- * @memberof VirtualRobotSetupApi
14619
+ * @memberof VirtualControllerInputsOutputsApi
14487
14620
  */
14488
- public setVirtualRobotMounting(cell: string, controller: string, motionGroup: string, coordinateSystem: CoordinateSystem, options?: RawAxiosRequestConfig) {
14489
- return VirtualRobotSetupApiFp(this.configuration).setVirtualRobotMounting(cell, controller, motionGroup, coordinateSystem, options).then((request) => request(this.axios, this.basePath));
14621
+ public setIOValues(cell: string, controller: string, iOValue: Array<IOValue>, options?: RawAxiosRequestConfig) {
14622
+ return VirtualControllerInputsOutputsApiFp(this.configuration).setIOValues(cell, controller, iOValue, options).then((request) => request(this.axios, this.basePath));
14490
14623
  }
14491
14624
  }
14492
14625