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

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.
package/v2/api.js CHANGED
@@ -21,7 +21,7 @@ export const AbbControllerKindEnum = {
21
21
  AbbController: 'AbbController'
22
22
  };
23
23
  /**
24
- * ## 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).
24
+ * ## 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).
25
25
  * @export
26
26
  * @enum {string}
27
27
  */
@@ -86,9 +86,6 @@ export const Direction = {
86
86
  DirectionForward: 'DIRECTION_FORWARD',
87
87
  DirectionBackward: 'DIRECTION_BACKWARD'
88
88
  };
89
- export const EndOfTrajectoryKindEnum = {
90
- EndOfTrajectory: 'END_OF_TRAJECTORY'
91
- };
92
89
  export const FanucControllerKindEnum = {
93
90
  FanucController: 'FanucController'
94
91
  };
@@ -153,6 +150,21 @@ export const IntegerValueValueTypeEnum = {
153
150
  export const JoggingDetailsKindEnum = {
154
151
  Jogging: 'JOGGING'
155
152
  };
153
+ export const JoggingPausedByUserKindEnum = {
154
+ PausedByUser: 'PAUSED_BY_USER'
155
+ };
156
+ export const JoggingPausedNearCollisionKindEnum = {
157
+ PausedNearCollision: 'PAUSED_NEAR_COLLISION'
158
+ };
159
+ export const JoggingPausedNearJointLimitKindEnum = {
160
+ PausedNearJointLimit: 'PAUSED_NEAR_JOINT_LIMIT'
161
+ };
162
+ export const JoggingPausedOnIOKindEnum = {
163
+ PausedOnIo: 'PAUSED_ON_IO'
164
+ };
165
+ export const JoggingRunningKindEnum = {
166
+ Running: 'RUNNING'
167
+ };
156
168
  export const JointVelocityRequestMessageTypeEnum = {
157
169
  JointVelocityRequest: 'JointVelocityRequest'
158
170
  };
@@ -187,7 +199,7 @@ export const Manufacturer = {
187
199
  Yaskawa: 'yaskawa'
188
200
  };
189
201
  export const MovementErrorResponseKindEnum = {
190
- Error: 'ERROR'
202
+ MotionError: 'MOTION_ERROR'
191
203
  };
192
204
  /**
193
205
  * The operating state.
@@ -275,21 +287,6 @@ export const PauseMovementRequestMessageTypeEnum = {
275
287
  export const PauseMovementResponseKindEnum = {
276
288
  PauseReceived: 'PAUSE_RECEIVED'
277
289
  };
278
- export const PausedByRequestKindEnum = {
279
- PausedByUser: 'PAUSED_BY_USER'
280
- };
281
- export const PausedByUserKindEnum = {
282
- PausedByUser: 'PAUSED_BY_USER'
283
- };
284
- export const PausedNearCollisionKindEnum = {
285
- PausedNearCollision: 'PAUSED_NEAR_COLLISION'
286
- };
287
- export const PausedNearJointLimitKindEnum = {
288
- PausedNearJointLimit: 'PAUSED_NEAR_JOINT_LIMIT'
289
- };
290
- export const PausedOnIOKindEnum = {
291
- PausedOnIo: 'PAUSED_ON_IO'
292
- };
293
290
  export const PlaneShapeTypeEnum = {
294
291
  Plane: 'plane'
295
292
  };
@@ -326,12 +323,6 @@ export const RobotSystemMode = {
326
323
  RobotSystemModeControl: 'ROBOT_SYSTEM_MODE_CONTROL',
327
324
  RobotSystemModeFreeDrive: 'ROBOT_SYSTEM_MODE_FREE_DRIVE'
328
325
  };
329
- export const RunningKindEnum = {
330
- Running: 'RUNNING'
331
- };
332
- export const Running1KindEnum = {
333
- Running: 'RUNNING'
334
- };
335
326
  /**
336
327
  * Current safety state of the configured robot controller. Operation modes in which the attached motion groups can be moved are: - SAFETY_STATE_NORMAL - SAFETY_STATE_REDUCED All other modes are considered as non-operational.
337
328
  * @export
@@ -437,9 +428,24 @@ export const TrajectoryDataMessageTypeEnum = {
437
428
  export const TrajectoryDetailsKindEnum = {
438
429
  Trajectory: 'TRAJECTORY'
439
430
  };
431
+ export const TrajectoryEndedKindEnum = {
432
+ EndOfTrajectory: 'END_OF_TRAJECTORY'
433
+ };
440
434
  export const TrajectoryIdMessageTypeEnum = {
441
435
  TrajectoryId: 'TrajectoryId'
442
436
  };
437
+ export const TrajectoryPausedByUserKindEnum = {
438
+ PausedByUser: 'PAUSED_BY_USER'
439
+ };
440
+ export const TrajectoryPausedOnIOKindEnum = {
441
+ PausedOnIo: 'PAUSED_ON_IO'
442
+ };
443
+ export const TrajectoryRunningKindEnum = {
444
+ Running: 'RUNNING'
445
+ };
446
+ export const TrajectoryWaitForIOKindEnum = {
447
+ WaitForIo: 'WAIT_FOR_IO'
448
+ };
443
449
  /**
444
450
  * The unit of input/output value.
445
451
  * @export
@@ -577,9 +583,6 @@ export const VirtualControllerTypes = {
577
583
  YaskawaHc10dtp: 'yaskawa-hc10dtp',
578
584
  YaskawaHc20dtp: 'yaskawa-hc20dtp'
579
585
  };
580
- export const WaitForIOKindEnum = {
581
- WaitForIo: 'WAIT_FOR_IO'
582
- };
583
586
  export const YaskawaControllerKindEnum = {
584
587
  YaskawaController: 'YaskawaController'
585
588
  };
@@ -1777,6 +1780,45 @@ export const ControllerApiAxiosParamCreator = function (configuration) {
1777
1780
  options: localVarRequestOptions,
1778
1781
  };
1779
1782
  },
1783
+ /**
1784
+ * 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.
1785
+ * @summary Description
1786
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
1787
+ * @param {string} controller Unique identifier to address a controller in the cell.
1788
+ * @param {*} [options] Override http request option.
1789
+ * @throws {RequiredError}
1790
+ */
1791
+ getControllerDescription: async (cell, controller, options = {}) => {
1792
+ // verify required parameter 'cell' is not null or undefined
1793
+ assertParamExists('getControllerDescription', 'cell', cell);
1794
+ // verify required parameter 'controller' is not null or undefined
1795
+ assertParamExists('getControllerDescription', 'controller', controller);
1796
+ const localVarPath = `/cells/{cell}/controllers/{controller}/description`
1797
+ .replace(`{${"cell"}}`, encodeURIComponent(String(cell)))
1798
+ .replace(`{${"controller"}}`, encodeURIComponent(String(controller)));
1799
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
1800
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
1801
+ let baseOptions;
1802
+ if (configuration) {
1803
+ baseOptions = configuration.baseOptions;
1804
+ }
1805
+ const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options };
1806
+ const localVarHeaderParameter = {};
1807
+ const localVarQueryParameter = {};
1808
+ // authentication BasicAuth required
1809
+ // http basic authentication required
1810
+ setBasicAuthToObject(localVarRequestOptions, configuration);
1811
+ // authentication BearerAuth required
1812
+ // http bearer authentication required
1813
+ await setBearerAuthToObject(localVarHeaderParameter, configuration);
1814
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
1815
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
1816
+ localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
1817
+ return {
1818
+ url: toPathString(localVarUrlObj),
1819
+ options: localVarRequestOptions,
1820
+ };
1821
+ },
1780
1822
  /**
1781
1823
  * 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.
1782
1824
  * @summary Coordinate System
@@ -1942,18 +1984,18 @@ export const ControllerApiAxiosParamCreator = function (configuration) {
1942
1984
  };
1943
1985
  },
1944
1986
  /**
1945
- * Receive the configuration for a virtual robot controller. Used to configure a virtual robot controller via [addRobotController](addRobotController). > **NOTE** > > The output generated by this endpoint can be too large for the site to handle, and may produce an error or incorrect output. > Use `curl` in combination with `> output.json` to capture the output, or use an API client like Postman.
1946
- * @summary Virtual Robot Configuration
1987
+ * Receive data to configure a virtual robot controller based on another controller. This can be used to create a virtual clone of a specific physical robot. When adding a virtual controller, use the Virtual configuration variant of [addRobotController](addRobotController) and pass the content string from this endpoint as the `json` field. Omit the `type` field that selects a preset configuration which is not required when providing a complete configuration. > **NOTE** > > The output generated by this endpoint can be too large for the site to handle, and may produce an error or incorrect output. > Use `curl` in combination with `> output.json` to capture the output, or use an API client like Postman.
1988
+ * @summary Virtual Controller Configuration
1947
1989
  * @param {string} cell Unique identifier addressing a cell in all API calls.
1948
1990
  * @param {string} controller Unique identifier to address a controller in the cell.
1949
1991
  * @param {*} [options] Override http request option.
1950
1992
  * @throws {RequiredError}
1951
1993
  */
1952
- getVirtualRobotConfiguration: async (cell, controller, options = {}) => {
1994
+ getVirtualControllerConfiguration: async (cell, controller, options = {}) => {
1953
1995
  // verify required parameter 'cell' is not null or undefined
1954
- assertParamExists('getVirtualRobotConfiguration', 'cell', cell);
1996
+ assertParamExists('getVirtualControllerConfiguration', 'cell', cell);
1955
1997
  // verify required parameter 'controller' is not null or undefined
1956
- assertParamExists('getVirtualRobotConfiguration', 'controller', controller);
1998
+ assertParamExists('getVirtualControllerConfiguration', 'controller', controller);
1957
1999
  const localVarPath = `/cells/{cell}/controllers/{controller}/virtual-robot-configuration`
1958
2000
  .replace(`{${"cell"}}`, encodeURIComponent(String(cell)))
1959
2001
  .replace(`{${"controller"}}`, encodeURIComponent(String(controller)));
@@ -2290,6 +2332,20 @@ export const ControllerApiFp = function (configuration) {
2290
2332
  const localVarOperationServerBasePath = operationServerMap['ControllerApi.deleteRobotController']?.[localVarOperationServerIndex]?.url;
2291
2333
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
2292
2334
  },
2335
+ /**
2336
+ * 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.
2337
+ * @summary Description
2338
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
2339
+ * @param {string} controller Unique identifier to address a controller in the cell.
2340
+ * @param {*} [options] Override http request option.
2341
+ * @throws {RequiredError}
2342
+ */
2343
+ async getControllerDescription(cell, controller, options) {
2344
+ const localVarAxiosArgs = await localVarAxiosParamCreator.getControllerDescription(cell, controller, options);
2345
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
2346
+ const localVarOperationServerBasePath = operationServerMap['ControllerApi.getControllerDescription']?.[localVarOperationServerIndex]?.url;
2347
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
2348
+ },
2293
2349
  /**
2294
2350
  * 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.
2295
2351
  * @summary Coordinate System
@@ -2349,17 +2405,17 @@ export const ControllerApiFp = function (configuration) {
2349
2405
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
2350
2406
  },
2351
2407
  /**
2352
- * Receive the configuration for a virtual robot controller. Used to configure a virtual robot controller via [addRobotController](addRobotController). > **NOTE** > > The output generated by this endpoint can be too large for the site to handle, and may produce an error or incorrect output. > Use `curl` in combination with `> output.json` to capture the output, or use an API client like Postman.
2353
- * @summary Virtual Robot Configuration
2408
+ * Receive data to configure a virtual robot controller based on another controller. This can be used to create a virtual clone of a specific physical robot. When adding a virtual controller, use the Virtual configuration variant of [addRobotController](addRobotController) and pass the content string from this endpoint as the `json` field. Omit the `type` field that selects a preset configuration which is not required when providing a complete configuration. > **NOTE** > > The output generated by this endpoint can be too large for the site to handle, and may produce an error or incorrect output. > Use `curl` in combination with `> output.json` to capture the output, or use an API client like Postman.
2409
+ * @summary Virtual Controller Configuration
2354
2410
  * @param {string} cell Unique identifier addressing a cell in all API calls.
2355
2411
  * @param {string} controller Unique identifier to address a controller in the cell.
2356
2412
  * @param {*} [options] Override http request option.
2357
2413
  * @throws {RequiredError}
2358
2414
  */
2359
- async getVirtualRobotConfiguration(cell, controller, options) {
2360
- const localVarAxiosArgs = await localVarAxiosParamCreator.getVirtualRobotConfiguration(cell, controller, options);
2415
+ async getVirtualControllerConfiguration(cell, controller, options) {
2416
+ const localVarAxiosArgs = await localVarAxiosParamCreator.getVirtualControllerConfiguration(cell, controller, options);
2361
2417
  const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
2362
- const localVarOperationServerBasePath = operationServerMap['ControllerApi.getVirtualRobotConfiguration']?.[localVarOperationServerIndex]?.url;
2418
+ const localVarOperationServerBasePath = operationServerMap['ControllerApi.getVirtualControllerConfiguration']?.[localVarOperationServerIndex]?.url;
2363
2419
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
2364
2420
  },
2365
2421
  /**
@@ -2495,6 +2551,17 @@ export const ControllerApiFactory = function (configuration, basePath, axios) {
2495
2551
  deleteRobotController(cell, controller, completionTimeout, options) {
2496
2552
  return localVarFp.deleteRobotController(cell, controller, completionTimeout, options).then((request) => request(axios, basePath));
2497
2553
  },
2554
+ /**
2555
+ * 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.
2556
+ * @summary Description
2557
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
2558
+ * @param {string} controller Unique identifier to address a controller in the cell.
2559
+ * @param {*} [options] Override http request option.
2560
+ * @throws {RequiredError}
2561
+ */
2562
+ getControllerDescription(cell, controller, options) {
2563
+ return localVarFp.getControllerDescription(cell, controller, options).then((request) => request(axios, basePath));
2564
+ },
2498
2565
  /**
2499
2566
  * 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.
2500
2567
  * @summary Coordinate System
@@ -2542,15 +2609,15 @@ export const ControllerApiFactory = function (configuration, basePath, axios) {
2542
2609
  return localVarFp.getRobotController(cell, controller, options).then((request) => request(axios, basePath));
2543
2610
  },
2544
2611
  /**
2545
- * Receive the configuration for a virtual robot controller. Used to configure a virtual robot controller via [addRobotController](addRobotController). > **NOTE** > > The output generated by this endpoint can be too large for the site to handle, and may produce an error or incorrect output. > Use `curl` in combination with `> output.json` to capture the output, or use an API client like Postman.
2546
- * @summary Virtual Robot Configuration
2612
+ * Receive data to configure a virtual robot controller based on another controller. This can be used to create a virtual clone of a specific physical robot. When adding a virtual controller, use the Virtual configuration variant of [addRobotController](addRobotController) and pass the content string from this endpoint as the `json` field. Omit the `type` field that selects a preset configuration which is not required when providing a complete configuration. > **NOTE** > > The output generated by this endpoint can be too large for the site to handle, and may produce an error or incorrect output. > Use `curl` in combination with `> output.json` to capture the output, or use an API client like Postman.
2613
+ * @summary Virtual Controller Configuration
2547
2614
  * @param {string} cell Unique identifier addressing a cell in all API calls.
2548
2615
  * @param {string} controller Unique identifier to address a controller in the cell.
2549
2616
  * @param {*} [options] Override http request option.
2550
2617
  * @throws {RequiredError}
2551
2618
  */
2552
- getVirtualRobotConfiguration(cell, controller, options) {
2553
- return localVarFp.getVirtualRobotConfiguration(cell, controller, options).then((request) => request(axios, basePath));
2619
+ getVirtualControllerConfiguration(cell, controller, options) {
2620
+ return localVarFp.getVirtualControllerConfiguration(cell, controller, options).then((request) => request(axios, basePath));
2554
2621
  },
2555
2622
  /**
2556
2623
  * Lists all specifications of coordinate systems from robot controllers. Use parameter orientation_type to get the orientation part of the transformation offset of the coordinate system returned in the requested orientation notation. If parameter orientation_type is not set, the orientation part of the transformation offset of the coordinate system is returned in rotation vector notation. The coordinate systems from the robot controller are loaded when the motion group associated with the coordinate system is activated. With deactivation of the motion group, the associated coordinate systems are removed from NOVA. The unique identifier of the coordinate systems from the robot controllers are suffixed with \"On\" + the unique identifier of the robot controller.
@@ -2670,6 +2737,18 @@ export class ControllerApi extends BaseAPI {
2670
2737
  deleteRobotController(cell, controller, completionTimeout, options) {
2671
2738
  return ControllerApiFp(this.configuration).deleteRobotController(cell, controller, completionTimeout, options).then((request) => request(this.axios, this.basePath));
2672
2739
  }
2740
+ /**
2741
+ * 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.
2742
+ * @summary Description
2743
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
2744
+ * @param {string} controller Unique identifier to address a controller in the cell.
2745
+ * @param {*} [options] Override http request option.
2746
+ * @throws {RequiredError}
2747
+ * @memberof ControllerApi
2748
+ */
2749
+ getControllerDescription(cell, controller, options) {
2750
+ return ControllerApiFp(this.configuration).getControllerDescription(cell, controller, options).then((request) => request(this.axios, this.basePath));
2751
+ }
2673
2752
  /**
2674
2753
  * 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.
2675
2754
  * @summary Coordinate System
@@ -2721,16 +2800,16 @@ export class ControllerApi extends BaseAPI {
2721
2800
  return ControllerApiFp(this.configuration).getRobotController(cell, controller, options).then((request) => request(this.axios, this.basePath));
2722
2801
  }
2723
2802
  /**
2724
- * Receive the configuration for a virtual robot controller. Used to configure a virtual robot controller via [addRobotController](addRobotController). > **NOTE** > > The output generated by this endpoint can be too large for the site to handle, and may produce an error or incorrect output. > Use `curl` in combination with `> output.json` to capture the output, or use an API client like Postman.
2725
- * @summary Virtual Robot Configuration
2803
+ * Receive data to configure a virtual robot controller based on another controller. This can be used to create a virtual clone of a specific physical robot. When adding a virtual controller, use the Virtual configuration variant of [addRobotController](addRobotController) and pass the content string from this endpoint as the `json` field. Omit the `type` field that selects a preset configuration which is not required when providing a complete configuration. > **NOTE** > > The output generated by this endpoint can be too large for the site to handle, and may produce an error or incorrect output. > Use `curl` in combination with `> output.json` to capture the output, or use an API client like Postman.
2804
+ * @summary Virtual Controller Configuration
2726
2805
  * @param {string} cell Unique identifier addressing a cell in all API calls.
2727
2806
  * @param {string} controller Unique identifier to address a controller in the cell.
2728
2807
  * @param {*} [options] Override http request option.
2729
2808
  * @throws {RequiredError}
2730
2809
  * @memberof ControllerApi
2731
2810
  */
2732
- getVirtualRobotConfiguration(cell, controller, options) {
2733
- return ControllerApiFp(this.configuration).getVirtualRobotConfiguration(cell, controller, options).then((request) => request(this.axios, this.basePath));
2811
+ getVirtualControllerConfiguration(cell, controller, options) {
2812
+ return ControllerApiFp(this.configuration).getVirtualControllerConfiguration(cell, controller, options).then((request) => request(this.axios, this.basePath));
2734
2813
  }
2735
2814
  /**
2736
2815
  * Lists all specifications of coordinate systems from robot controllers. Use parameter orientation_type to get the orientation part of the transformation offset of the coordinate system returned in the requested orientation notation. If parameter orientation_type is not set, the orientation part of the transformation offset of the coordinate system is returned in rotation vector notation. The coordinate systems from the robot controller are loaded when the motion group associated with the coordinate system is activated. With deactivation of the motion group, the associated coordinate systems are removed from NOVA. The unique identifier of the coordinate systems from the robot controllers are suffixed with \"On\" + the unique identifier of the robot controller.
@@ -3292,17 +3371,21 @@ export const JoggingApiAxiosParamCreator = function (configuration) {
3292
3371
  * <!-- 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.
3293
3372
  * @summary Execute Jogging
3294
3373
  * @param {string} cell Unique identifier addressing a cell in all API calls.
3374
+ * @param {string} controller Unique identifier to address a controller in the cell.
3295
3375
  * @param {ExecuteJoggingRequest} executeJoggingRequest
3296
3376
  * @param {*} [options] Override http request option.
3297
3377
  * @throws {RequiredError}
3298
3378
  */
3299
- executeJogging: async (cell, executeJoggingRequest, options = {}) => {
3379
+ executeJogging: async (cell, controller, executeJoggingRequest, options = {}) => {
3300
3380
  // verify required parameter 'cell' is not null or undefined
3301
3381
  assertParamExists('executeJogging', 'cell', cell);
3382
+ // verify required parameter 'controller' is not null or undefined
3383
+ assertParamExists('executeJogging', 'controller', controller);
3302
3384
  // verify required parameter 'executeJoggingRequest' is not null or undefined
3303
3385
  assertParamExists('executeJogging', 'executeJoggingRequest', executeJoggingRequest);
3304
- const localVarPath = `/cells/{cell}/execution/jogging`
3305
- .replace(`{${"cell"}}`, encodeURIComponent(String(cell)));
3386
+ const localVarPath = `/cells/{cell}/controllers/{controller}/execution/jogging`
3387
+ .replace(`{${"cell"}}`, encodeURIComponent(String(cell)))
3388
+ .replace(`{${"controller"}}`, encodeURIComponent(String(controller)));
3306
3389
  // use dummy base URL string because the URL constructor only accepts absolute URLs.
3307
3390
  const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
3308
3391
  let baseOptions;
@@ -3341,12 +3424,13 @@ export const JoggingApiFp = function (configuration) {
3341
3424
  * <!-- 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.
3342
3425
  * @summary Execute Jogging
3343
3426
  * @param {string} cell Unique identifier addressing a cell in all API calls.
3427
+ * @param {string} controller Unique identifier to address a controller in the cell.
3344
3428
  * @param {ExecuteJoggingRequest} executeJoggingRequest
3345
3429
  * @param {*} [options] Override http request option.
3346
3430
  * @throws {RequiredError}
3347
3431
  */
3348
- async executeJogging(cell, executeJoggingRequest, options) {
3349
- const localVarAxiosArgs = await localVarAxiosParamCreator.executeJogging(cell, executeJoggingRequest, options);
3432
+ async executeJogging(cell, controller, executeJoggingRequest, options) {
3433
+ const localVarAxiosArgs = await localVarAxiosParamCreator.executeJogging(cell, controller, executeJoggingRequest, options);
3350
3434
  const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
3351
3435
  const localVarOperationServerBasePath = operationServerMap['JoggingApi.executeJogging']?.[localVarOperationServerIndex]?.url;
3352
3436
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
@@ -3364,12 +3448,13 @@ export const JoggingApiFactory = function (configuration, basePath, axios) {
3364
3448
  * <!-- 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.
3365
3449
  * @summary Execute Jogging
3366
3450
  * @param {string} cell Unique identifier addressing a cell in all API calls.
3451
+ * @param {string} controller Unique identifier to address a controller in the cell.
3367
3452
  * @param {ExecuteJoggingRequest} executeJoggingRequest
3368
3453
  * @param {*} [options] Override http request option.
3369
3454
  * @throws {RequiredError}
3370
3455
  */
3371
- executeJogging(cell, executeJoggingRequest, options) {
3372
- return localVarFp.executeJogging(cell, executeJoggingRequest, options).then((request) => request(axios, basePath));
3456
+ executeJogging(cell, controller, executeJoggingRequest, options) {
3457
+ return localVarFp.executeJogging(cell, controller, executeJoggingRequest, options).then((request) => request(axios, basePath));
3373
3458
  },
3374
3459
  };
3375
3460
  };
@@ -3384,13 +3469,14 @@ export class JoggingApi extends BaseAPI {
3384
3469
  * <!-- 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.
3385
3470
  * @summary Execute Jogging
3386
3471
  * @param {string} cell Unique identifier addressing a cell in all API calls.
3472
+ * @param {string} controller Unique identifier to address a controller in the cell.
3387
3473
  * @param {ExecuteJoggingRequest} executeJoggingRequest
3388
3474
  * @param {*} [options] Override http request option.
3389
3475
  * @throws {RequiredError}
3390
3476
  * @memberof JoggingApi
3391
3477
  */
3392
- executeJogging(cell, executeJoggingRequest, options) {
3393
- return JoggingApiFp(this.configuration).executeJogging(cell, executeJoggingRequest, options).then((request) => request(this.axios, this.basePath));
3478
+ executeJogging(cell, controller, executeJoggingRequest, options) {
3479
+ return JoggingApiFp(this.configuration).executeJogging(cell, controller, executeJoggingRequest, options).then((request) => request(this.axios, this.basePath));
3394
3480
  }
3395
3481
  }
3396
3482
  /**
@@ -3802,18 +3888,22 @@ export const MotionGroupApiAxiosParamCreator = function (configuration) {
3802
3888
  * Returns the current state of the selected motion group including the current joint position, velocity, pose, and more.
3803
3889
  * @summary State
3804
3890
  * @param {string} cell Unique identifier addressing a cell in all API calls.
3891
+ * @param {string} controller Unique identifier to address a controller in the cell.
3805
3892
  * @param {string} motionGroup The motion-group identifier.
3806
3893
  * @param {string} [responseCoordinateSystem] Unique identifier addressing a coordinate system to which the responses should be converted. If not set, world coordinate system is used.
3807
3894
  * @param {*} [options] Override http request option.
3808
3895
  * @throws {RequiredError}
3809
3896
  */
3810
- getCurrentMotionGroupState: async (cell, motionGroup, responseCoordinateSystem, options = {}) => {
3897
+ getCurrentMotionGroupState: async (cell, controller, motionGroup, responseCoordinateSystem, options = {}) => {
3811
3898
  // verify required parameter 'cell' is not null or undefined
3812
3899
  assertParamExists('getCurrentMotionGroupState', 'cell', cell);
3900
+ // verify required parameter 'controller' is not null or undefined
3901
+ assertParamExists('getCurrentMotionGroupState', 'controller', controller);
3813
3902
  // verify required parameter 'motionGroup' is not null or undefined
3814
3903
  assertParamExists('getCurrentMotionGroupState', 'motionGroup', motionGroup);
3815
- const localVarPath = `/cells/{cell}/motion-groups/{motion-group}/state`
3904
+ const localVarPath = `/cells/{cell}/controllers/{controller}/motion-groups/{motion-group}/state`
3816
3905
  .replace(`{${"cell"}}`, encodeURIComponent(String(cell)))
3906
+ .replace(`{${"controller"}}`, encodeURIComponent(String(controller)))
3817
3907
  .replace(`{${"motion-group"}}`, encodeURIComponent(String(motionGroup)));
3818
3908
  // use dummy base URL string because the URL constructor only accepts absolute URLs.
3819
3909
  const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
@@ -3845,17 +3935,21 @@ export const MotionGroupApiAxiosParamCreator = function (configuration) {
3845
3935
  * 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.
3846
3936
  * @summary Description
3847
3937
  * @param {string} cell Unique identifier addressing a cell in all API calls.
3938
+ * @param {string} controller Unique identifier to address a controller in the cell.
3848
3939
  * @param {string} motionGroup The motion-group identifier.
3849
3940
  * @param {*} [options] Override http request option.
3850
3941
  * @throws {RequiredError}
3851
3942
  */
3852
- getMotionGroupDescription: async (cell, motionGroup, options = {}) => {
3943
+ getMotionGroupDescription: async (cell, controller, motionGroup, options = {}) => {
3853
3944
  // verify required parameter 'cell' is not null or undefined
3854
3945
  assertParamExists('getMotionGroupDescription', 'cell', cell);
3946
+ // verify required parameter 'controller' is not null or undefined
3947
+ assertParamExists('getMotionGroupDescription', 'controller', controller);
3855
3948
  // verify required parameter 'motionGroup' is not null or undefined
3856
3949
  assertParamExists('getMotionGroupDescription', 'motionGroup', motionGroup);
3857
- const localVarPath = `/cells/{cell}/motion-groups/{motion-group}/description`
3950
+ const localVarPath = `/cells/{cell}/controllers/{controller}/motion-groups/{motion-group}/description`
3858
3951
  .replace(`{${"cell"}}`, encodeURIComponent(String(cell)))
3952
+ .replace(`{${"controller"}}`, encodeURIComponent(String(controller)))
3859
3953
  .replace(`{${"motion-group"}}`, encodeURIComponent(String(motionGroup)));
3860
3954
  // use dummy base URL string because the URL constructor only accepts absolute URLs.
3861
3955
  const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
@@ -3884,19 +3978,23 @@ export const MotionGroupApiAxiosParamCreator = function (configuration) {
3884
3978
  * <!-- theme: danger --> > Websocket endpoint Receive updates of the motion group state. The stream will be closed from the server if the controller is disconnected.
3885
3979
  * @summary Stream State
3886
3980
  * @param {string} cell Unique identifier addressing a cell in all API calls.
3981
+ * @param {string} controller Unique identifier to address a controller in the cell.
3887
3982
  * @param {string} motionGroup The motion-group identifier.
3888
3983
  * @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.
3889
3984
  * @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.
3890
3985
  * @param {*} [options] Override http request option.
3891
3986
  * @throws {RequiredError}
3892
3987
  */
3893
- streamMotionGroupState: async (cell, motionGroup, responseRate, responseCoordinateSystem, options = {}) => {
3988
+ streamMotionGroupState: async (cell, controller, motionGroup, responseRate, responseCoordinateSystem, options = {}) => {
3894
3989
  // verify required parameter 'cell' is not null or undefined
3895
3990
  assertParamExists('streamMotionGroupState', 'cell', cell);
3991
+ // verify required parameter 'controller' is not null or undefined
3992
+ assertParamExists('streamMotionGroupState', 'controller', controller);
3896
3993
  // verify required parameter 'motionGroup' is not null or undefined
3897
3994
  assertParamExists('streamMotionGroupState', 'motionGroup', motionGroup);
3898
- const localVarPath = `/cells/{cell}/motion-groups/{motion-group}/state-stream`
3995
+ const localVarPath = `/cells/{cell}/controllers/{controller}/motion-groups/{motion-group}/state-stream`
3899
3996
  .replace(`{${"cell"}}`, encodeURIComponent(String(cell)))
3997
+ .replace(`{${"controller"}}`, encodeURIComponent(String(controller)))
3900
3998
  .replace(`{${"motion-group"}}`, encodeURIComponent(String(motionGroup)));
3901
3999
  // use dummy base URL string because the URL constructor only accepts absolute URLs.
3902
4000
  const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
@@ -3940,13 +4038,14 @@ export const MotionGroupApiFp = function (configuration) {
3940
4038
  * Returns the current state of the selected motion group including the current joint position, velocity, pose, and more.
3941
4039
  * @summary State
3942
4040
  * @param {string} cell Unique identifier addressing a cell in all API calls.
4041
+ * @param {string} controller Unique identifier to address a controller in the cell.
3943
4042
  * @param {string} motionGroup The motion-group identifier.
3944
4043
  * @param {string} [responseCoordinateSystem] Unique identifier addressing a coordinate system to which the responses should be converted. If not set, world coordinate system is used.
3945
4044
  * @param {*} [options] Override http request option.
3946
4045
  * @throws {RequiredError}
3947
4046
  */
3948
- async getCurrentMotionGroupState(cell, motionGroup, responseCoordinateSystem, options) {
3949
- const localVarAxiosArgs = await localVarAxiosParamCreator.getCurrentMotionGroupState(cell, motionGroup, responseCoordinateSystem, options);
4047
+ async getCurrentMotionGroupState(cell, controller, motionGroup, responseCoordinateSystem, options) {
4048
+ const localVarAxiosArgs = await localVarAxiosParamCreator.getCurrentMotionGroupState(cell, controller, motionGroup, responseCoordinateSystem, options);
3950
4049
  const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
3951
4050
  const localVarOperationServerBasePath = operationServerMap['MotionGroupApi.getCurrentMotionGroupState']?.[localVarOperationServerIndex]?.url;
3952
4051
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
@@ -3955,12 +4054,13 @@ export const MotionGroupApiFp = function (configuration) {
3955
4054
  * 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.
3956
4055
  * @summary Description
3957
4056
  * @param {string} cell Unique identifier addressing a cell in all API calls.
4057
+ * @param {string} controller Unique identifier to address a controller in the cell.
3958
4058
  * @param {string} motionGroup The motion-group identifier.
3959
4059
  * @param {*} [options] Override http request option.
3960
4060
  * @throws {RequiredError}
3961
4061
  */
3962
- async getMotionGroupDescription(cell, motionGroup, options) {
3963
- const localVarAxiosArgs = await localVarAxiosParamCreator.getMotionGroupDescription(cell, motionGroup, options);
4062
+ async getMotionGroupDescription(cell, controller, motionGroup, options) {
4063
+ const localVarAxiosArgs = await localVarAxiosParamCreator.getMotionGroupDescription(cell, controller, motionGroup, options);
3964
4064
  const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
3965
4065
  const localVarOperationServerBasePath = operationServerMap['MotionGroupApi.getMotionGroupDescription']?.[localVarOperationServerIndex]?.url;
3966
4066
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
@@ -3969,14 +4069,15 @@ export const MotionGroupApiFp = function (configuration) {
3969
4069
  * <!-- theme: danger --> > Websocket endpoint Receive updates of the motion group state. The stream will be closed from the server if the controller is disconnected.
3970
4070
  * @summary Stream State
3971
4071
  * @param {string} cell Unique identifier addressing a cell in all API calls.
4072
+ * @param {string} controller Unique identifier to address a controller in the cell.
3972
4073
  * @param {string} motionGroup The motion-group identifier.
3973
4074
  * @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.
3974
4075
  * @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.
3975
4076
  * @param {*} [options] Override http request option.
3976
4077
  * @throws {RequiredError}
3977
4078
  */
3978
- async streamMotionGroupState(cell, motionGroup, responseRate, responseCoordinateSystem, options) {
3979
- const localVarAxiosArgs = await localVarAxiosParamCreator.streamMotionGroupState(cell, motionGroup, responseRate, responseCoordinateSystem, options);
4079
+ async streamMotionGroupState(cell, controller, motionGroup, responseRate, responseCoordinateSystem, options) {
4080
+ const localVarAxiosArgs = await localVarAxiosParamCreator.streamMotionGroupState(cell, controller, motionGroup, responseRate, responseCoordinateSystem, options);
3980
4081
  const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
3981
4082
  const localVarOperationServerBasePath = operationServerMap['MotionGroupApi.streamMotionGroupState']?.[localVarOperationServerIndex]?.url;
3982
4083
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
@@ -3994,37 +4095,40 @@ export const MotionGroupApiFactory = function (configuration, basePath, axios) {
3994
4095
  * Returns the current state of the selected motion group including the current joint position, velocity, pose, and more.
3995
4096
  * @summary State
3996
4097
  * @param {string} cell Unique identifier addressing a cell in all API calls.
4098
+ * @param {string} controller Unique identifier to address a controller in the cell.
3997
4099
  * @param {string} motionGroup The motion-group identifier.
3998
4100
  * @param {string} [responseCoordinateSystem] Unique identifier addressing a coordinate system to which the responses should be converted. If not set, world coordinate system is used.
3999
4101
  * @param {*} [options] Override http request option.
4000
4102
  * @throws {RequiredError}
4001
4103
  */
4002
- getCurrentMotionGroupState(cell, motionGroup, responseCoordinateSystem, options) {
4003
- return localVarFp.getCurrentMotionGroupState(cell, motionGroup, responseCoordinateSystem, options).then((request) => request(axios, basePath));
4104
+ getCurrentMotionGroupState(cell, controller, motionGroup, responseCoordinateSystem, options) {
4105
+ return localVarFp.getCurrentMotionGroupState(cell, controller, motionGroup, responseCoordinateSystem, options).then((request) => request(axios, basePath));
4004
4106
  },
4005
4107
  /**
4006
4108
  * 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.
4007
4109
  * @summary Description
4008
4110
  * @param {string} cell Unique identifier addressing a cell in all API calls.
4111
+ * @param {string} controller Unique identifier to address a controller in the cell.
4009
4112
  * @param {string} motionGroup The motion-group identifier.
4010
4113
  * @param {*} [options] Override http request option.
4011
4114
  * @throws {RequiredError}
4012
4115
  */
4013
- getMotionGroupDescription(cell, motionGroup, options) {
4014
- return localVarFp.getMotionGroupDescription(cell, motionGroup, options).then((request) => request(axios, basePath));
4116
+ getMotionGroupDescription(cell, controller, motionGroup, options) {
4117
+ return localVarFp.getMotionGroupDescription(cell, controller, motionGroup, options).then((request) => request(axios, basePath));
4015
4118
  },
4016
4119
  /**
4017
4120
  * <!-- theme: danger --> > Websocket endpoint Receive updates of the motion group state. The stream will be closed from the server if the controller is disconnected.
4018
4121
  * @summary Stream State
4019
4122
  * @param {string} cell Unique identifier addressing a cell in all API calls.
4123
+ * @param {string} controller Unique identifier to address a controller in the cell.
4020
4124
  * @param {string} motionGroup The motion-group identifier.
4021
4125
  * @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.
4022
4126
  * @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.
4023
4127
  * @param {*} [options] Override http request option.
4024
4128
  * @throws {RequiredError}
4025
4129
  */
4026
- streamMotionGroupState(cell, motionGroup, responseRate, responseCoordinateSystem, options) {
4027
- return localVarFp.streamMotionGroupState(cell, motionGroup, responseRate, responseCoordinateSystem, options).then((request) => request(axios, basePath));
4130
+ streamMotionGroupState(cell, controller, motionGroup, responseRate, responseCoordinateSystem, options) {
4131
+ return localVarFp.streamMotionGroupState(cell, controller, motionGroup, responseRate, responseCoordinateSystem, options).then((request) => request(axios, basePath));
4028
4132
  },
4029
4133
  };
4030
4134
  };
@@ -4039,31 +4143,34 @@ export class MotionGroupApi extends BaseAPI {
4039
4143
  * Returns the current state of the selected motion group including the current joint position, velocity, pose, and more.
4040
4144
  * @summary State
4041
4145
  * @param {string} cell Unique identifier addressing a cell in all API calls.
4146
+ * @param {string} controller Unique identifier to address a controller in the cell.
4042
4147
  * @param {string} motionGroup The motion-group identifier.
4043
4148
  * @param {string} [responseCoordinateSystem] Unique identifier addressing a coordinate system to which the responses should be converted. If not set, world coordinate system is used.
4044
4149
  * @param {*} [options] Override http request option.
4045
4150
  * @throws {RequiredError}
4046
4151
  * @memberof MotionGroupApi
4047
4152
  */
4048
- getCurrentMotionGroupState(cell, motionGroup, responseCoordinateSystem, options) {
4049
- return MotionGroupApiFp(this.configuration).getCurrentMotionGroupState(cell, motionGroup, responseCoordinateSystem, options).then((request) => request(this.axios, this.basePath));
4153
+ getCurrentMotionGroupState(cell, controller, motionGroup, responseCoordinateSystem, options) {
4154
+ return MotionGroupApiFp(this.configuration).getCurrentMotionGroupState(cell, controller, motionGroup, responseCoordinateSystem, options).then((request) => request(this.axios, this.basePath));
4050
4155
  }
4051
4156
  /**
4052
4157
  * 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.
4053
4158
  * @summary Description
4054
4159
  * @param {string} cell Unique identifier addressing a cell in all API calls.
4160
+ * @param {string} controller Unique identifier to address a controller in the cell.
4055
4161
  * @param {string} motionGroup The motion-group identifier.
4056
4162
  * @param {*} [options] Override http request option.
4057
4163
  * @throws {RequiredError}
4058
4164
  * @memberof MotionGroupApi
4059
4165
  */
4060
- getMotionGroupDescription(cell, motionGroup, options) {
4061
- return MotionGroupApiFp(this.configuration).getMotionGroupDescription(cell, motionGroup, options).then((request) => request(this.axios, this.basePath));
4166
+ getMotionGroupDescription(cell, controller, motionGroup, options) {
4167
+ return MotionGroupApiFp(this.configuration).getMotionGroupDescription(cell, controller, motionGroup, options).then((request) => request(this.axios, this.basePath));
4062
4168
  }
4063
4169
  /**
4064
4170
  * <!-- theme: danger --> > Websocket endpoint Receive updates of the motion group state. The stream will be closed from the server if the controller is disconnected.
4065
4171
  * @summary Stream State
4066
4172
  * @param {string} cell Unique identifier addressing a cell in all API calls.
4173
+ * @param {string} controller Unique identifier to address a controller in the cell.
4067
4174
  * @param {string} motionGroup The motion-group identifier.
4068
4175
  * @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.
4069
4176
  * @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.
@@ -4071,8 +4178,8 @@ export class MotionGroupApi extends BaseAPI {
4071
4178
  * @throws {RequiredError}
4072
4179
  * @memberof MotionGroupApi
4073
4180
  */
4074
- streamMotionGroupState(cell, motionGroup, responseRate, responseCoordinateSystem, options) {
4075
- return MotionGroupApiFp(this.configuration).streamMotionGroupState(cell, motionGroup, responseRate, responseCoordinateSystem, options).then((request) => request(this.axios, this.basePath));
4181
+ streamMotionGroupState(cell, controller, motionGroup, responseRate, responseCoordinateSystem, options) {
4182
+ return MotionGroupApiFp(this.configuration).streamMotionGroupState(cell, controller, motionGroup, responseRate, responseCoordinateSystem, options).then((request) => request(this.axios, this.basePath));
4076
4183
  }
4077
4184
  }
4078
4185
  /**
@@ -6698,17 +6805,21 @@ export const TrajectoryCachingApiAxiosParamCreator = function (configuration) {
6698
6805
  * <!-- 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.
6699
6806
  * @summary Add Trajectory
6700
6807
  * @param {string} cell Unique identifier addressing a cell in all API calls.
6808
+ * @param {string} controller Unique identifier to address a controller in the cell.
6701
6809
  * @param {AddTrajectoryRequest} addTrajectoryRequest
6702
6810
  * @param {*} [options] Override http request option.
6703
6811
  * @throws {RequiredError}
6704
6812
  */
6705
- addTrajectory: async (cell, addTrajectoryRequest, options = {}) => {
6813
+ addTrajectory: async (cell, controller, addTrajectoryRequest, options = {}) => {
6706
6814
  // verify required parameter 'cell' is not null or undefined
6707
6815
  assertParamExists('addTrajectory', 'cell', cell);
6816
+ // verify required parameter 'controller' is not null or undefined
6817
+ assertParamExists('addTrajectory', 'controller', controller);
6708
6818
  // verify required parameter 'addTrajectoryRequest' is not null or undefined
6709
6819
  assertParamExists('addTrajectory', 'addTrajectoryRequest', addTrajectoryRequest);
6710
- const localVarPath = `/cells/{cell}/trajectories`
6711
- .replace(`{${"cell"}}`, encodeURIComponent(String(cell)));
6820
+ const localVarPath = `/cells/{cell}/controllers/{controller}/trajectories`
6821
+ .replace(`{${"cell"}}`, encodeURIComponent(String(cell)))
6822
+ .replace(`{${"controller"}}`, encodeURIComponent(String(controller)));
6712
6823
  // use dummy base URL string because the URL constructor only accepts absolute URLs.
6713
6824
  const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
6714
6825
  let baseOptions;
@@ -6738,14 +6849,18 @@ export const TrajectoryCachingApiAxiosParamCreator = function (configuration) {
6738
6849
  * Clear the trajectory cache.
6739
6850
  * @summary Clear Trajectories
6740
6851
  * @param {string} cell Unique identifier addressing a cell in all API calls.
6852
+ * @param {string} controller Unique identifier to address a controller in the cell.
6741
6853
  * @param {*} [options] Override http request option.
6742
6854
  * @throws {RequiredError}
6743
6855
  */
6744
- clearTrajectories: async (cell, options = {}) => {
6856
+ clearTrajectories: async (cell, controller, options = {}) => {
6745
6857
  // verify required parameter 'cell' is not null or undefined
6746
6858
  assertParamExists('clearTrajectories', 'cell', cell);
6747
- const localVarPath = `/cells/{cell}/trajectories`
6748
- .replace(`{${"cell"}}`, encodeURIComponent(String(cell)));
6859
+ // verify required parameter 'controller' is not null or undefined
6860
+ assertParamExists('clearTrajectories', 'controller', controller);
6861
+ const localVarPath = `/cells/{cell}/controllers/{controller}/trajectories`
6862
+ .replace(`{${"cell"}}`, encodeURIComponent(String(cell)))
6863
+ .replace(`{${"controller"}}`, encodeURIComponent(String(controller)));
6749
6864
  // use dummy base URL string because the URL constructor only accepts absolute URLs.
6750
6865
  const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
6751
6866
  let baseOptions;
@@ -6773,17 +6888,21 @@ export const TrajectoryCachingApiAxiosParamCreator = function (configuration) {
6773
6888
  * 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.
6774
6889
  * @summary Delete Trajectory
6775
6890
  * @param {string} cell Unique identifier addressing a cell in all API calls.
6891
+ * @param {string} controller Unique identifier to address a controller in the cell.
6776
6892
  * @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.
6777
6893
  * @param {*} [options] Override http request option.
6778
6894
  * @throws {RequiredError}
6779
6895
  */
6780
- deleteTrajectory: async (cell, trajectory, options = {}) => {
6896
+ deleteTrajectory: async (cell, controller, trajectory, options = {}) => {
6781
6897
  // verify required parameter 'cell' is not null or undefined
6782
6898
  assertParamExists('deleteTrajectory', 'cell', cell);
6899
+ // verify required parameter 'controller' is not null or undefined
6900
+ assertParamExists('deleteTrajectory', 'controller', controller);
6783
6901
  // verify required parameter 'trajectory' is not null or undefined
6784
6902
  assertParamExists('deleteTrajectory', 'trajectory', trajectory);
6785
- const localVarPath = `/cells/{cell}/trajectories/{trajectory}`
6903
+ const localVarPath = `/cells/{cell}/controllers/{controller}/trajectories/{trajectory}`
6786
6904
  .replace(`{${"cell"}}`, encodeURIComponent(String(cell)))
6905
+ .replace(`{${"controller"}}`, encodeURIComponent(String(controller)))
6787
6906
  .replace(`{${"trajectory"}}`, encodeURIComponent(String(trajectory)));
6788
6907
  // use dummy base URL string because the URL constructor only accepts absolute URLs.
6789
6908
  const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
@@ -6812,17 +6931,21 @@ export const TrajectoryCachingApiAxiosParamCreator = function (configuration) {
6812
6931
  * Get a previously created trajectory from cache. Use [listTrajectories](listTrajectories) to list all cached trajectories.
6813
6932
  * @summary Get Trajectory
6814
6933
  * @param {string} cell Unique identifier addressing a cell in all API calls.
6934
+ * @param {string} controller Unique identifier to address a controller in the cell.
6815
6935
  * @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.
6816
6936
  * @param {*} [options] Override http request option.
6817
6937
  * @throws {RequiredError}
6818
6938
  */
6819
- getTrajectory: async (cell, trajectory, options = {}) => {
6939
+ getTrajectory: async (cell, controller, trajectory, options = {}) => {
6820
6940
  // verify required parameter 'cell' is not null or undefined
6821
6941
  assertParamExists('getTrajectory', 'cell', cell);
6942
+ // verify required parameter 'controller' is not null or undefined
6943
+ assertParamExists('getTrajectory', 'controller', controller);
6822
6944
  // verify required parameter 'trajectory' is not null or undefined
6823
6945
  assertParamExists('getTrajectory', 'trajectory', trajectory);
6824
- const localVarPath = `/cells/{cell}/trajectories/{trajectory}`
6946
+ const localVarPath = `/cells/{cell}/controllers/{controller}/trajectories/{trajectory}`
6825
6947
  .replace(`{${"cell"}}`, encodeURIComponent(String(cell)))
6948
+ .replace(`{${"controller"}}`, encodeURIComponent(String(controller)))
6826
6949
  .replace(`{${"trajectory"}}`, encodeURIComponent(String(trajectory)));
6827
6950
  // use dummy base URL string because the URL constructor only accepts absolute URLs.
6828
6951
  const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
@@ -6851,14 +6974,18 @@ export const TrajectoryCachingApiAxiosParamCreator = function (configuration) {
6851
6974
  * 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.
6852
6975
  * @summary List Trajectories
6853
6976
  * @param {string} cell Unique identifier addressing a cell in all API calls.
6977
+ * @param {string} controller Unique identifier to address a controller in the cell.
6854
6978
  * @param {*} [options] Override http request option.
6855
6979
  * @throws {RequiredError}
6856
6980
  */
6857
- listTrajectories: async (cell, options = {}) => {
6981
+ listTrajectories: async (cell, controller, options = {}) => {
6858
6982
  // verify required parameter 'cell' is not null or undefined
6859
6983
  assertParamExists('listTrajectories', 'cell', cell);
6860
- const localVarPath = `/cells/{cell}/trajectories`
6861
- .replace(`{${"cell"}}`, encodeURIComponent(String(cell)));
6984
+ // verify required parameter 'controller' is not null or undefined
6985
+ assertParamExists('listTrajectories', 'controller', controller);
6986
+ const localVarPath = `/cells/{cell}/controllers/{controller}/trajectories`
6987
+ .replace(`{${"cell"}}`, encodeURIComponent(String(cell)))
6988
+ .replace(`{${"controller"}}`, encodeURIComponent(String(controller)));
6862
6989
  // use dummy base URL string because the URL constructor only accepts absolute URLs.
6863
6990
  const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
6864
6991
  let baseOptions;
@@ -6895,12 +7022,13 @@ export const TrajectoryCachingApiFp = function (configuration) {
6895
7022
  * <!-- 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.
6896
7023
  * @summary Add Trajectory
6897
7024
  * @param {string} cell Unique identifier addressing a cell in all API calls.
7025
+ * @param {string} controller Unique identifier to address a controller in the cell.
6898
7026
  * @param {AddTrajectoryRequest} addTrajectoryRequest
6899
7027
  * @param {*} [options] Override http request option.
6900
7028
  * @throws {RequiredError}
6901
7029
  */
6902
- async addTrajectory(cell, addTrajectoryRequest, options) {
6903
- const localVarAxiosArgs = await localVarAxiosParamCreator.addTrajectory(cell, addTrajectoryRequest, options);
7030
+ async addTrajectory(cell, controller, addTrajectoryRequest, options) {
7031
+ const localVarAxiosArgs = await localVarAxiosParamCreator.addTrajectory(cell, controller, addTrajectoryRequest, options);
6904
7032
  const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
6905
7033
  const localVarOperationServerBasePath = operationServerMap['TrajectoryCachingApi.addTrajectory']?.[localVarOperationServerIndex]?.url;
6906
7034
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
@@ -6909,11 +7037,12 @@ export const TrajectoryCachingApiFp = function (configuration) {
6909
7037
  * Clear the trajectory cache.
6910
7038
  * @summary Clear Trajectories
6911
7039
  * @param {string} cell Unique identifier addressing a cell in all API calls.
7040
+ * @param {string} controller Unique identifier to address a controller in the cell.
6912
7041
  * @param {*} [options] Override http request option.
6913
7042
  * @throws {RequiredError}
6914
7043
  */
6915
- async clearTrajectories(cell, options) {
6916
- const localVarAxiosArgs = await localVarAxiosParamCreator.clearTrajectories(cell, options);
7044
+ async clearTrajectories(cell, controller, options) {
7045
+ const localVarAxiosArgs = await localVarAxiosParamCreator.clearTrajectories(cell, controller, options);
6917
7046
  const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
6918
7047
  const localVarOperationServerBasePath = operationServerMap['TrajectoryCachingApi.clearTrajectories']?.[localVarOperationServerIndex]?.url;
6919
7048
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
@@ -6922,12 +7051,13 @@ export const TrajectoryCachingApiFp = function (configuration) {
6922
7051
  * 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.
6923
7052
  * @summary Delete Trajectory
6924
7053
  * @param {string} cell Unique identifier addressing a cell in all API calls.
7054
+ * @param {string} controller Unique identifier to address a controller in the cell.
6925
7055
  * @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.
6926
7056
  * @param {*} [options] Override http request option.
6927
7057
  * @throws {RequiredError}
6928
7058
  */
6929
- async deleteTrajectory(cell, trajectory, options) {
6930
- const localVarAxiosArgs = await localVarAxiosParamCreator.deleteTrajectory(cell, trajectory, options);
7059
+ async deleteTrajectory(cell, controller, trajectory, options) {
7060
+ const localVarAxiosArgs = await localVarAxiosParamCreator.deleteTrajectory(cell, controller, trajectory, options);
6931
7061
  const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
6932
7062
  const localVarOperationServerBasePath = operationServerMap['TrajectoryCachingApi.deleteTrajectory']?.[localVarOperationServerIndex]?.url;
6933
7063
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
@@ -6936,12 +7066,13 @@ export const TrajectoryCachingApiFp = function (configuration) {
6936
7066
  * Get a previously created trajectory from cache. Use [listTrajectories](listTrajectories) to list all cached trajectories.
6937
7067
  * @summary Get Trajectory
6938
7068
  * @param {string} cell Unique identifier addressing a cell in all API calls.
7069
+ * @param {string} controller Unique identifier to address a controller in the cell.
6939
7070
  * @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.
6940
7071
  * @param {*} [options] Override http request option.
6941
7072
  * @throws {RequiredError}
6942
7073
  */
6943
- async getTrajectory(cell, trajectory, options) {
6944
- const localVarAxiosArgs = await localVarAxiosParamCreator.getTrajectory(cell, trajectory, options);
7074
+ async getTrajectory(cell, controller, trajectory, options) {
7075
+ const localVarAxiosArgs = await localVarAxiosParamCreator.getTrajectory(cell, controller, trajectory, options);
6945
7076
  const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
6946
7077
  const localVarOperationServerBasePath = operationServerMap['TrajectoryCachingApi.getTrajectory']?.[localVarOperationServerIndex]?.url;
6947
7078
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
@@ -6950,11 +7081,12 @@ export const TrajectoryCachingApiFp = function (configuration) {
6950
7081
  * 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.
6951
7082
  * @summary List Trajectories
6952
7083
  * @param {string} cell Unique identifier addressing a cell in all API calls.
7084
+ * @param {string} controller Unique identifier to address a controller in the cell.
6953
7085
  * @param {*} [options] Override http request option.
6954
7086
  * @throws {RequiredError}
6955
7087
  */
6956
- async listTrajectories(cell, options) {
6957
- const localVarAxiosArgs = await localVarAxiosParamCreator.listTrajectories(cell, options);
7088
+ async listTrajectories(cell, controller, options) {
7089
+ const localVarAxiosArgs = await localVarAxiosParamCreator.listTrajectories(cell, controller, options);
6958
7090
  const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
6959
7091
  const localVarOperationServerBasePath = operationServerMap['TrajectoryCachingApi.listTrajectories']?.[localVarOperationServerIndex]?.url;
6960
7092
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
@@ -6972,54 +7104,59 @@ export const TrajectoryCachingApiFactory = function (configuration, basePath, ax
6972
7104
  * <!-- 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.
6973
7105
  * @summary Add Trajectory
6974
7106
  * @param {string} cell Unique identifier addressing a cell in all API calls.
7107
+ * @param {string} controller Unique identifier to address a controller in the cell.
6975
7108
  * @param {AddTrajectoryRequest} addTrajectoryRequest
6976
7109
  * @param {*} [options] Override http request option.
6977
7110
  * @throws {RequiredError}
6978
7111
  */
6979
- addTrajectory(cell, addTrajectoryRequest, options) {
6980
- return localVarFp.addTrajectory(cell, addTrajectoryRequest, options).then((request) => request(axios, basePath));
7112
+ addTrajectory(cell, controller, addTrajectoryRequest, options) {
7113
+ return localVarFp.addTrajectory(cell, controller, addTrajectoryRequest, options).then((request) => request(axios, basePath));
6981
7114
  },
6982
7115
  /**
6983
7116
  * Clear the trajectory cache.
6984
7117
  * @summary Clear Trajectories
6985
7118
  * @param {string} cell Unique identifier addressing a cell in all API calls.
7119
+ * @param {string} controller Unique identifier to address a controller in the cell.
6986
7120
  * @param {*} [options] Override http request option.
6987
7121
  * @throws {RequiredError}
6988
7122
  */
6989
- clearTrajectories(cell, options) {
6990
- return localVarFp.clearTrajectories(cell, options).then((request) => request(axios, basePath));
7123
+ clearTrajectories(cell, controller, options) {
7124
+ return localVarFp.clearTrajectories(cell, controller, options).then((request) => request(axios, basePath));
6991
7125
  },
6992
7126
  /**
6993
7127
  * 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.
6994
7128
  * @summary Delete Trajectory
6995
7129
  * @param {string} cell Unique identifier addressing a cell in all API calls.
7130
+ * @param {string} controller Unique identifier to address a controller in the cell.
6996
7131
  * @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.
6997
7132
  * @param {*} [options] Override http request option.
6998
7133
  * @throws {RequiredError}
6999
7134
  */
7000
- deleteTrajectory(cell, trajectory, options) {
7001
- return localVarFp.deleteTrajectory(cell, trajectory, options).then((request) => request(axios, basePath));
7135
+ deleteTrajectory(cell, controller, trajectory, options) {
7136
+ return localVarFp.deleteTrajectory(cell, controller, trajectory, options).then((request) => request(axios, basePath));
7002
7137
  },
7003
7138
  /**
7004
7139
  * Get a previously created trajectory from cache. Use [listTrajectories](listTrajectories) to list all cached trajectories.
7005
7140
  * @summary Get Trajectory
7006
7141
  * @param {string} cell Unique identifier addressing a cell in all API calls.
7142
+ * @param {string} controller Unique identifier to address a controller in the cell.
7007
7143
  * @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.
7008
7144
  * @param {*} [options] Override http request option.
7009
7145
  * @throws {RequiredError}
7010
7146
  */
7011
- getTrajectory(cell, trajectory, options) {
7012
- return localVarFp.getTrajectory(cell, trajectory, options).then((request) => request(axios, basePath));
7147
+ getTrajectory(cell, controller, trajectory, options) {
7148
+ return localVarFp.getTrajectory(cell, controller, trajectory, options).then((request) => request(axios, basePath));
7013
7149
  },
7014
7150
  /**
7015
7151
  * 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.
7016
7152
  * @summary List Trajectories
7017
7153
  * @param {string} cell Unique identifier addressing a cell in all API calls.
7154
+ * @param {string} controller Unique identifier to address a controller in the cell.
7018
7155
  * @param {*} [options] Override http request option.
7019
7156
  * @throws {RequiredError}
7020
7157
  */
7021
- listTrajectories(cell, options) {
7022
- return localVarFp.listTrajectories(cell, options).then((request) => request(axios, basePath));
7158
+ listTrajectories(cell, controller, options) {
7159
+ return localVarFp.listTrajectories(cell, controller, options).then((request) => request(axios, basePath));
7023
7160
  },
7024
7161
  };
7025
7162
  };
@@ -7034,59 +7171,64 @@ export class TrajectoryCachingApi extends BaseAPI {
7034
7171
  * <!-- 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.
7035
7172
  * @summary Add Trajectory
7036
7173
  * @param {string} cell Unique identifier addressing a cell in all API calls.
7174
+ * @param {string} controller Unique identifier to address a controller in the cell.
7037
7175
  * @param {AddTrajectoryRequest} addTrajectoryRequest
7038
7176
  * @param {*} [options] Override http request option.
7039
7177
  * @throws {RequiredError}
7040
7178
  * @memberof TrajectoryCachingApi
7041
7179
  */
7042
- addTrajectory(cell, addTrajectoryRequest, options) {
7043
- return TrajectoryCachingApiFp(this.configuration).addTrajectory(cell, addTrajectoryRequest, options).then((request) => request(this.axios, this.basePath));
7180
+ addTrajectory(cell, controller, addTrajectoryRequest, options) {
7181
+ return TrajectoryCachingApiFp(this.configuration).addTrajectory(cell, controller, addTrajectoryRequest, options).then((request) => request(this.axios, this.basePath));
7044
7182
  }
7045
7183
  /**
7046
7184
  * Clear the trajectory cache.
7047
7185
  * @summary Clear Trajectories
7048
7186
  * @param {string} cell Unique identifier addressing a cell in all API calls.
7187
+ * @param {string} controller Unique identifier to address a controller in the cell.
7049
7188
  * @param {*} [options] Override http request option.
7050
7189
  * @throws {RequiredError}
7051
7190
  * @memberof TrajectoryCachingApi
7052
7191
  */
7053
- clearTrajectories(cell, options) {
7054
- return TrajectoryCachingApiFp(this.configuration).clearTrajectories(cell, options).then((request) => request(this.axios, this.basePath));
7192
+ clearTrajectories(cell, controller, options) {
7193
+ return TrajectoryCachingApiFp(this.configuration).clearTrajectories(cell, controller, options).then((request) => request(this.axios, this.basePath));
7055
7194
  }
7056
7195
  /**
7057
7196
  * 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.
7058
7197
  * @summary Delete Trajectory
7059
7198
  * @param {string} cell Unique identifier addressing a cell in all API calls.
7199
+ * @param {string} controller Unique identifier to address a controller in the cell.
7060
7200
  * @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.
7061
7201
  * @param {*} [options] Override http request option.
7062
7202
  * @throws {RequiredError}
7063
7203
  * @memberof TrajectoryCachingApi
7064
7204
  */
7065
- deleteTrajectory(cell, trajectory, options) {
7066
- return TrajectoryCachingApiFp(this.configuration).deleteTrajectory(cell, trajectory, options).then((request) => request(this.axios, this.basePath));
7205
+ deleteTrajectory(cell, controller, trajectory, options) {
7206
+ return TrajectoryCachingApiFp(this.configuration).deleteTrajectory(cell, controller, trajectory, options).then((request) => request(this.axios, this.basePath));
7067
7207
  }
7068
7208
  /**
7069
7209
  * Get a previously created trajectory from cache. Use [listTrajectories](listTrajectories) to list all cached trajectories.
7070
7210
  * @summary Get Trajectory
7071
7211
  * @param {string} cell Unique identifier addressing a cell in all API calls.
7212
+ * @param {string} controller Unique identifier to address a controller in the cell.
7072
7213
  * @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.
7073
7214
  * @param {*} [options] Override http request option.
7074
7215
  * @throws {RequiredError}
7075
7216
  * @memberof TrajectoryCachingApi
7076
7217
  */
7077
- getTrajectory(cell, trajectory, options) {
7078
- return TrajectoryCachingApiFp(this.configuration).getTrajectory(cell, trajectory, options).then((request) => request(this.axios, this.basePath));
7218
+ getTrajectory(cell, controller, trajectory, options) {
7219
+ return TrajectoryCachingApiFp(this.configuration).getTrajectory(cell, controller, trajectory, options).then((request) => request(this.axios, this.basePath));
7079
7220
  }
7080
7221
  /**
7081
7222
  * 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.
7082
7223
  * @summary List Trajectories
7083
7224
  * @param {string} cell Unique identifier addressing a cell in all API calls.
7225
+ * @param {string} controller Unique identifier to address a controller in the cell.
7084
7226
  * @param {*} [options] Override http request option.
7085
7227
  * @throws {RequiredError}
7086
7228
  * @memberof TrajectoryCachingApi
7087
7229
  */
7088
- listTrajectories(cell, options) {
7089
- return TrajectoryCachingApiFp(this.configuration).listTrajectories(cell, options).then((request) => request(this.axios, this.basePath));
7230
+ listTrajectories(cell, controller, options) {
7231
+ return TrajectoryCachingApiFp(this.configuration).listTrajectories(cell, controller, options).then((request) => request(this.axios, this.basePath));
7090
7232
  }
7091
7233
  }
7092
7234
  /**
@@ -7099,17 +7241,21 @@ export const TrajectoryExecutionApiAxiosParamCreator = function (configuration)
7099
7241
  * <!-- 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.
7100
7242
  * @summary Execute Trajectory
7101
7243
  * @param {string} cell Unique identifier addressing a cell in all API calls.
7244
+ * @param {string} controller Unique identifier to address a controller in the cell.
7102
7245
  * @param {ExecuteTrajectoryRequest} executeTrajectoryRequest
7103
7246
  * @param {*} [options] Override http request option.
7104
7247
  * @throws {RequiredError}
7105
7248
  */
7106
- executeTrajectory: async (cell, executeTrajectoryRequest, options = {}) => {
7249
+ executeTrajectory: async (cell, controller, executeTrajectoryRequest, options = {}) => {
7107
7250
  // verify required parameter 'cell' is not null or undefined
7108
7251
  assertParamExists('executeTrajectory', 'cell', cell);
7252
+ // verify required parameter 'controller' is not null or undefined
7253
+ assertParamExists('executeTrajectory', 'controller', controller);
7109
7254
  // verify required parameter 'executeTrajectoryRequest' is not null or undefined
7110
7255
  assertParamExists('executeTrajectory', 'executeTrajectoryRequest', executeTrajectoryRequest);
7111
- const localVarPath = `/cells/{cell}/execution/trajectory`
7112
- .replace(`{${"cell"}}`, encodeURIComponent(String(cell)));
7256
+ const localVarPath = `/cells/{cell}/controllers/{controller}/execution/trajectory`
7257
+ .replace(`{${"cell"}}`, encodeURIComponent(String(cell)))
7258
+ .replace(`{${"controller"}}`, encodeURIComponent(String(controller)));
7113
7259
  // use dummy base URL string because the URL constructor only accepts absolute URLs.
7114
7260
  const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
7115
7261
  let baseOptions;
@@ -7148,12 +7294,13 @@ export const TrajectoryExecutionApiFp = function (configuration) {
7148
7294
  * <!-- 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.
7149
7295
  * @summary Execute Trajectory
7150
7296
  * @param {string} cell Unique identifier addressing a cell in all API calls.
7297
+ * @param {string} controller Unique identifier to address a controller in the cell.
7151
7298
  * @param {ExecuteTrajectoryRequest} executeTrajectoryRequest
7152
7299
  * @param {*} [options] Override http request option.
7153
7300
  * @throws {RequiredError}
7154
7301
  */
7155
- async executeTrajectory(cell, executeTrajectoryRequest, options) {
7156
- const localVarAxiosArgs = await localVarAxiosParamCreator.executeTrajectory(cell, executeTrajectoryRequest, options);
7302
+ async executeTrajectory(cell, controller, executeTrajectoryRequest, options) {
7303
+ const localVarAxiosArgs = await localVarAxiosParamCreator.executeTrajectory(cell, controller, executeTrajectoryRequest, options);
7157
7304
  const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
7158
7305
  const localVarOperationServerBasePath = operationServerMap['TrajectoryExecutionApi.executeTrajectory']?.[localVarOperationServerIndex]?.url;
7159
7306
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
@@ -7171,12 +7318,13 @@ export const TrajectoryExecutionApiFactory = function (configuration, basePath,
7171
7318
  * <!-- 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.
7172
7319
  * @summary Execute Trajectory
7173
7320
  * @param {string} cell Unique identifier addressing a cell in all API calls.
7321
+ * @param {string} controller Unique identifier to address a controller in the cell.
7174
7322
  * @param {ExecuteTrajectoryRequest} executeTrajectoryRequest
7175
7323
  * @param {*} [options] Override http request option.
7176
7324
  * @throws {RequiredError}
7177
7325
  */
7178
- executeTrajectory(cell, executeTrajectoryRequest, options) {
7179
- return localVarFp.executeTrajectory(cell, executeTrajectoryRequest, options).then((request) => request(axios, basePath));
7326
+ executeTrajectory(cell, controller, executeTrajectoryRequest, options) {
7327
+ return localVarFp.executeTrajectory(cell, controller, executeTrajectoryRequest, options).then((request) => request(axios, basePath));
7180
7328
  },
7181
7329
  };
7182
7330
  };
@@ -7191,13 +7339,14 @@ export class TrajectoryExecutionApi extends BaseAPI {
7191
7339
  * <!-- 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.
7192
7340
  * @summary Execute Trajectory
7193
7341
  * @param {string} cell Unique identifier addressing a cell in all API calls.
7342
+ * @param {string} controller Unique identifier to address a controller in the cell.
7194
7343
  * @param {ExecuteTrajectoryRequest} executeTrajectoryRequest
7195
7344
  * @param {*} [options] Override http request option.
7196
7345
  * @throws {RequiredError}
7197
7346
  * @memberof TrajectoryExecutionApi
7198
7347
  */
7199
- executeTrajectory(cell, executeTrajectoryRequest, options) {
7200
- return TrajectoryExecutionApiFp(this.configuration).executeTrajectory(cell, executeTrajectoryRequest, options).then((request) => request(this.axios, this.basePath));
7348
+ executeTrajectory(cell, controller, executeTrajectoryRequest, options) {
7349
+ return TrajectoryExecutionApiFp(this.configuration).executeTrajectory(cell, controller, executeTrajectoryRequest, options).then((request) => request(this.axios, this.basePath));
7201
7350
  }
7202
7351
  }
7203
7352
  /**
@@ -7310,38 +7459,41 @@ export class TrajectoryPlanningApi extends BaseAPI {
7310
7459
  }
7311
7460
  }
7312
7461
  /**
7313
- * VirtualRobotApi - axios parameter creator
7462
+ * VirtualControllerApi - axios parameter creator
7314
7463
  * @export
7315
7464
  */
7316
- export const VirtualRobotApiAxiosParamCreator = function (configuration) {
7465
+ export const VirtualControllerApiAxiosParamCreator = function (configuration) {
7317
7466
  return {
7318
7467
  /**
7319
- * Get the current motion group state which provides values for the joints\' position, velocity and acceleration.
7320
- * @summary Get Motion Group State
7468
+ * Adds a coordinate system to the robot controller.
7469
+ * @summary Add Coordinate Systems
7321
7470
  * @param {string} cell Unique identifier addressing a cell in all API calls.
7322
7471
  * @param {string} controller Unique identifier to address a controller in the cell.
7323
- * @param {string} motionGroup The motion-group identifier.
7472
+ * @param {string} coordinateSystem Unique identifier addressing a coordinate system.
7473
+ * @param {CoordinateSystemData} coordinateSystemData
7324
7474
  * @param {*} [options] Override http request option.
7325
7475
  * @throws {RequiredError}
7326
7476
  */
7327
- getMotionGroupState: async (cell, controller, motionGroup, options = {}) => {
7477
+ addVirtualControllerCoordinateSystem: async (cell, controller, coordinateSystem, coordinateSystemData, options = {}) => {
7328
7478
  // verify required parameter 'cell' is not null or undefined
7329
- assertParamExists('getMotionGroupState', 'cell', cell);
7479
+ assertParamExists('addVirtualControllerCoordinateSystem', 'cell', cell);
7330
7480
  // verify required parameter 'controller' is not null or undefined
7331
- assertParamExists('getMotionGroupState', 'controller', controller);
7332
- // verify required parameter 'motionGroup' is not null or undefined
7333
- assertParamExists('getMotionGroupState', 'motionGroup', motionGroup);
7334
- const localVarPath = `/cells/{cell}/controllers/{controller}/teach-pendant/motion-groups/{motion-group}`
7481
+ assertParamExists('addVirtualControllerCoordinateSystem', 'controller', controller);
7482
+ // verify required parameter 'coordinateSystem' is not null or undefined
7483
+ assertParamExists('addVirtualControllerCoordinateSystem', 'coordinateSystem', coordinateSystem);
7484
+ // verify required parameter 'coordinateSystemData' is not null or undefined
7485
+ assertParamExists('addVirtualControllerCoordinateSystem', 'coordinateSystemData', coordinateSystemData);
7486
+ const localVarPath = `/cells/{cell}/virtual-controllers/{controller}/coordinate-systems/{coordinate-system}`
7335
7487
  .replace(`{${"cell"}}`, encodeURIComponent(String(cell)))
7336
7488
  .replace(`{${"controller"}}`, encodeURIComponent(String(controller)))
7337
- .replace(`{${"motion-group"}}`, encodeURIComponent(String(motionGroup)));
7489
+ .replace(`{${"coordinate-system"}}`, encodeURIComponent(String(coordinateSystem)));
7338
7490
  // use dummy base URL string because the URL constructor only accepts absolute URLs.
7339
7491
  const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
7340
7492
  let baseOptions;
7341
7493
  if (configuration) {
7342
7494
  baseOptions = configuration.baseOptions;
7343
7495
  }
7344
- const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options };
7496
+ const localVarRequestOptions = { method: 'PUT', ...baseOptions, ...options };
7345
7497
  const localVarHeaderParameter = {};
7346
7498
  const localVarQueryParameter = {};
7347
7499
  // authentication BasicAuth required
@@ -7350,37 +7502,50 @@ export const VirtualRobotApiAxiosParamCreator = function (configuration) {
7350
7502
  // authentication BearerAuth required
7351
7503
  // http bearer authentication required
7352
7504
  await setBearerAuthToObject(localVarHeaderParameter, configuration);
7505
+ localVarHeaderParameter['Content-Type'] = 'application/json';
7353
7506
  setSearchParams(localVarUrlObj, localVarQueryParameter);
7354
7507
  let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
7355
7508
  localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
7509
+ localVarRequestOptions.data = serializeDataIfNeeded(coordinateSystemData, localVarRequestOptions, configuration);
7356
7510
  return {
7357
7511
  url: toPathString(localVarUrlObj),
7358
7512
  options: localVarRequestOptions,
7359
7513
  };
7360
7514
  },
7361
7515
  /**
7362
- * Gets information on the motion group.
7363
- * @summary Motion Group Description
7516
+ * 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.
7517
+ * @summary Add TCP
7364
7518
  * @param {string} cell Unique identifier addressing a cell in all API calls.
7365
7519
  * @param {string} controller Unique identifier to address a controller in the cell.
7520
+ * @param {string} motionGroup The motion-group identifier.
7521
+ * @param {string} tcp The unique identifier of a TCP.
7522
+ * @param {RobotTcpData} robotTcpData
7366
7523
  * @param {*} [options] Override http request option.
7367
7524
  * @throws {RequiredError}
7368
7525
  */
7369
- getMotionGroups: async (cell, controller, options = {}) => {
7526
+ addVirtualControllerTcp: async (cell, controller, motionGroup, tcp, robotTcpData, options = {}) => {
7370
7527
  // verify required parameter 'cell' is not null or undefined
7371
- assertParamExists('getMotionGroups', 'cell', cell);
7528
+ assertParamExists('addVirtualControllerTcp', 'cell', cell);
7372
7529
  // verify required parameter 'controller' is not null or undefined
7373
- assertParamExists('getMotionGroups', 'controller', controller);
7374
- const localVarPath = `/cells/{cell}/controllers/{controller}/teach-pendant/motion-groups`
7530
+ assertParamExists('addVirtualControllerTcp', 'controller', controller);
7531
+ // verify required parameter 'motionGroup' is not null or undefined
7532
+ assertParamExists('addVirtualControllerTcp', 'motionGroup', motionGroup);
7533
+ // verify required parameter 'tcp' is not null or undefined
7534
+ assertParamExists('addVirtualControllerTcp', 'tcp', tcp);
7535
+ // verify required parameter 'robotTcpData' is not null or undefined
7536
+ assertParamExists('addVirtualControllerTcp', 'robotTcpData', robotTcpData);
7537
+ const localVarPath = `/cells/{cell}/virtual-controllers/{controller}/motion-groups/{motion-group}/tcps/{tcp}`
7375
7538
  .replace(`{${"cell"}}`, encodeURIComponent(String(cell)))
7376
- .replace(`{${"controller"}}`, encodeURIComponent(String(controller)));
7539
+ .replace(`{${"controller"}}`, encodeURIComponent(String(controller)))
7540
+ .replace(`{${"motion-group"}}`, encodeURIComponent(String(motionGroup)))
7541
+ .replace(`{${"tcp"}}`, encodeURIComponent(String(tcp)));
7377
7542
  // use dummy base URL string because the URL constructor only accepts absolute URLs.
7378
7543
  const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
7379
7544
  let baseOptions;
7380
7545
  if (configuration) {
7381
7546
  baseOptions = configuration.baseOptions;
7382
7547
  }
7383
- const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options };
7548
+ const localVarRequestOptions = { method: 'PUT', ...baseOptions, ...options };
7384
7549
  const localVarHeaderParameter = {};
7385
7550
  const localVarQueryParameter = {};
7386
7551
  // authentication BasicAuth required
@@ -7389,40 +7554,44 @@ export const VirtualRobotApiAxiosParamCreator = function (configuration) {
7389
7554
  // authentication BearerAuth required
7390
7555
  // http bearer authentication required
7391
7556
  await setBearerAuthToObject(localVarHeaderParameter, configuration);
7557
+ localVarHeaderParameter['Content-Type'] = 'application/json';
7392
7558
  setSearchParams(localVarUrlObj, localVarQueryParameter);
7393
7559
  let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
7394
7560
  localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
7561
+ localVarRequestOptions.data = serializeDataIfNeeded(robotTcpData, localVarRequestOptions, configuration);
7395
7562
  return {
7396
7563
  url: toPathString(localVarUrlObj),
7397
7564
  options: localVarRequestOptions,
7398
7565
  };
7399
7566
  },
7400
7567
  /**
7401
- * 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).
7402
- * @summary Get Inputs/Outputs
7568
+ * 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.
7569
+ * @summary Remove Coordinate System
7403
7570
  * @param {string} cell Unique identifier addressing a cell in all API calls.
7404
7571
  * @param {string} controller Unique identifier to address a controller in the cell.
7405
- * @param {Array<string>} ios
7572
+ * @param {string} coordinateSystem Unique identifier addressing a coordinate system.
7573
+ * @param {boolean} [deleteDependent] If true, all dependent coordinate systems will be deleted as well.
7406
7574
  * @param {*} [options] Override http request option.
7407
7575
  * @throws {RequiredError}
7408
7576
  */
7409
- listIOs: async (cell, controller, ios, options = {}) => {
7577
+ deleteVirtualControllerCoordinateSystem: async (cell, controller, coordinateSystem, deleteDependent, options = {}) => {
7410
7578
  // verify required parameter 'cell' is not null or undefined
7411
- assertParamExists('listIOs', 'cell', cell);
7579
+ assertParamExists('deleteVirtualControllerCoordinateSystem', 'cell', cell);
7412
7580
  // verify required parameter 'controller' is not null or undefined
7413
- assertParamExists('listIOs', 'controller', controller);
7414
- // verify required parameter 'ios' is not null or undefined
7415
- assertParamExists('listIOs', 'ios', ios);
7416
- const localVarPath = `/cells/{cell}/controllers/{controller}/teach-pendant/ios`
7581
+ assertParamExists('deleteVirtualControllerCoordinateSystem', 'controller', controller);
7582
+ // verify required parameter 'coordinateSystem' is not null or undefined
7583
+ assertParamExists('deleteVirtualControllerCoordinateSystem', 'coordinateSystem', coordinateSystem);
7584
+ const localVarPath = `/cells/{cell}/virtual-controllers/{controller}/coordinate-systems/{coordinate-system}`
7417
7585
  .replace(`{${"cell"}}`, encodeURIComponent(String(cell)))
7418
- .replace(`{${"controller"}}`, encodeURIComponent(String(controller)));
7586
+ .replace(`{${"controller"}}`, encodeURIComponent(String(controller)))
7587
+ .replace(`{${"coordinate-system"}}`, encodeURIComponent(String(coordinateSystem)));
7419
7588
  // use dummy base URL string because the URL constructor only accepts absolute URLs.
7420
7589
  const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
7421
7590
  let baseOptions;
7422
7591
  if (configuration) {
7423
7592
  baseOptions = configuration.baseOptions;
7424
7593
  }
7425
- const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options };
7594
+ const localVarRequestOptions = { method: 'DELETE', ...baseOptions, ...options };
7426
7595
  const localVarHeaderParameter = {};
7427
7596
  const localVarQueryParameter = {};
7428
7597
  // authentication BasicAuth required
@@ -7431,8 +7600,8 @@ export const VirtualRobotApiAxiosParamCreator = function (configuration) {
7431
7600
  // authentication BearerAuth required
7432
7601
  // http bearer authentication required
7433
7602
  await setBearerAuthToObject(localVarHeaderParameter, configuration);
7434
- if (ios) {
7435
- localVarQueryParameter['ios'] = ios;
7603
+ if (deleteDependent !== undefined) {
7604
+ localVarQueryParameter['delete_dependent'] = deleteDependent;
7436
7605
  }
7437
7606
  setSearchParams(localVarUrlObj, localVarQueryParameter);
7438
7607
  let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
@@ -7443,32 +7612,36 @@ export const VirtualRobotApiAxiosParamCreator = function (configuration) {
7443
7612
  };
7444
7613
  },
7445
7614
  /**
7446
- * 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.
7447
- * @summary List Input/Output Descriptions
7615
+ * Removes the TCP from the motion group. An unknown TCP is a valid input.
7616
+ * @summary Remove TCP
7448
7617
  * @param {string} cell Unique identifier addressing a cell in all API calls.
7449
7618
  * @param {string} controller Unique identifier to address a controller in the cell.
7450
- * @param {Array<string>} [ios]
7451
- * @param {IODirection} [direction] Return only inputs/outputs with the specified direction.
7452
- * @param {IOValueType} [valueType] Return only inputs/outputs with the specified value type.
7453
- * @param {string} [group] Return only inputs/outputs from the specified group.
7619
+ * @param {string} motionGroup The motion-group identifier.
7620
+ * @param {string} tcp The unique identifier of a TCP.
7454
7621
  * @param {*} [options] Override http request option.
7455
7622
  * @throws {RequiredError}
7456
7623
  */
7457
- listVirtualRobotIODescriptions: async (cell, controller, ios, direction, valueType, group, options = {}) => {
7624
+ deleteVirtualControllerTcp: async (cell, controller, motionGroup, tcp, options = {}) => {
7458
7625
  // verify required parameter 'cell' is not null or undefined
7459
- assertParamExists('listVirtualRobotIODescriptions', 'cell', cell);
7626
+ assertParamExists('deleteVirtualControllerTcp', 'cell', cell);
7460
7627
  // verify required parameter 'controller' is not null or undefined
7461
- assertParamExists('listVirtualRobotIODescriptions', 'controller', controller);
7462
- const localVarPath = `/cells/{cell}/controllers/{controller}/teach-pendant/ios/description`
7628
+ assertParamExists('deleteVirtualControllerTcp', 'controller', controller);
7629
+ // verify required parameter 'motionGroup' is not null or undefined
7630
+ assertParamExists('deleteVirtualControllerTcp', 'motionGroup', motionGroup);
7631
+ // verify required parameter 'tcp' is not null or undefined
7632
+ assertParamExists('deleteVirtualControllerTcp', 'tcp', tcp);
7633
+ const localVarPath = `/cells/{cell}/virtual-controllers/{controller}/motion-groups/{motion-group}/tcps/{tcp}`
7463
7634
  .replace(`{${"cell"}}`, encodeURIComponent(String(cell)))
7464
- .replace(`{${"controller"}}`, encodeURIComponent(String(controller)));
7635
+ .replace(`{${"controller"}}`, encodeURIComponent(String(controller)))
7636
+ .replace(`{${"motion-group"}}`, encodeURIComponent(String(motionGroup)))
7637
+ .replace(`{${"tcp"}}`, encodeURIComponent(String(tcp)));
7465
7638
  // use dummy base URL string because the URL constructor only accepts absolute URLs.
7466
7639
  const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
7467
7640
  let baseOptions;
7468
7641
  if (configuration) {
7469
7642
  baseOptions = configuration.baseOptions;
7470
7643
  }
7471
- const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options };
7644
+ const localVarRequestOptions = { method: 'DELETE', ...baseOptions, ...options };
7472
7645
  const localVarHeaderParameter = {};
7473
7646
  const localVarQueryParameter = {};
7474
7647
  // authentication BasicAuth required
@@ -7477,18 +7650,6 @@ export const VirtualRobotApiAxiosParamCreator = function (configuration) {
7477
7650
  // authentication BearerAuth required
7478
7651
  // http bearer authentication required
7479
7652
  await setBearerAuthToObject(localVarHeaderParameter, configuration);
7480
- if (ios) {
7481
- localVarQueryParameter['ios'] = ios;
7482
- }
7483
- if (direction !== undefined) {
7484
- localVarQueryParameter['direction'] = direction;
7485
- }
7486
- if (valueType !== undefined) {
7487
- localVarQueryParameter['value_type'] = valueType;
7488
- }
7489
- if (group !== undefined) {
7490
- localVarQueryParameter['group'] = group;
7491
- }
7492
7653
  setSearchParams(localVarUrlObj, localVarQueryParameter);
7493
7654
  let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
7494
7655
  localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
@@ -7498,22 +7659,19 @@ export const VirtualRobotApiAxiosParamCreator = function (configuration) {
7498
7659
  };
7499
7660
  },
7500
7661
  /**
7501
- * Sets a list of values of a virtual controller inputs/outputs.
7502
- * @summary Set Input/Ouput Values
7662
+ * 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.
7663
+ * @summary Get Emergency Stop State
7503
7664
  * @param {string} cell Unique identifier addressing a cell in all API calls.
7504
7665
  * @param {string} controller Unique identifier to address a controller in the cell.
7505
- * @param {Array<IOValue>} iOValue
7506
7666
  * @param {*} [options] Override http request option.
7507
7667
  * @throws {RequiredError}
7508
7668
  */
7509
- setIOValues: async (cell, controller, iOValue, options = {}) => {
7669
+ getEmergencyStop: async (cell, controller, options = {}) => {
7510
7670
  // verify required parameter 'cell' is not null or undefined
7511
- assertParamExists('setIOValues', 'cell', cell);
7671
+ assertParamExists('getEmergencyStop', 'cell', cell);
7512
7672
  // verify required parameter 'controller' is not null or undefined
7513
- assertParamExists('setIOValues', 'controller', controller);
7514
- // verify required parameter 'iOValue' is not null or undefined
7515
- assertParamExists('setIOValues', 'iOValue', iOValue);
7516
- const localVarPath = `/cells/{cell}/controllers/{controller}/teach-pendant/ios`
7673
+ assertParamExists('getEmergencyStop', 'controller', controller);
7674
+ const localVarPath = `/cells/{cell}/virtual-controllers/{controller}/emergency-stop`
7517
7675
  .replace(`{${"cell"}}`, encodeURIComponent(String(cell)))
7518
7676
  .replace(`{${"controller"}}`, encodeURIComponent(String(controller)));
7519
7677
  // use dummy base URL string because the URL constructor only accepts absolute URLs.
@@ -7522,7 +7680,7 @@ export const VirtualRobotApiAxiosParamCreator = function (configuration) {
7522
7680
  if (configuration) {
7523
7681
  baseOptions = configuration.baseOptions;
7524
7682
  }
7525
- const localVarRequestOptions = { method: 'PUT', ...baseOptions, ...options };
7683
+ const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options };
7526
7684
  const localVarHeaderParameter = {};
7527
7685
  const localVarQueryParameter = {};
7528
7686
  // authentication BasicAuth required
@@ -7531,36 +7689,31 @@ export const VirtualRobotApiAxiosParamCreator = function (configuration) {
7531
7689
  // authentication BearerAuth required
7532
7690
  // http bearer authentication required
7533
7691
  await setBearerAuthToObject(localVarHeaderParameter, configuration);
7534
- localVarHeaderParameter['Content-Type'] = 'application/json';
7535
7692
  setSearchParams(localVarUrlObj, localVarQueryParameter);
7536
7693
  let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
7537
7694
  localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
7538
- localVarRequestOptions.data = serializeDataIfNeeded(iOValue, localVarRequestOptions, configuration);
7539
7695
  return {
7540
7696
  url: toPathString(localVarUrlObj),
7541
7697
  options: localVarRequestOptions,
7542
7698
  };
7543
7699
  },
7544
7700
  /**
7545
- * 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.
7546
- * @summary Set Motion Group State
7701
+ * Get the current motion group state which provides values for the joints\' position, velocity and acceleration.
7702
+ * @summary Get Motion Group State
7547
7703
  * @param {string} cell Unique identifier addressing a cell in all API calls.
7548
7704
  * @param {string} controller Unique identifier to address a controller in the cell.
7549
7705
  * @param {string} motionGroup The motion-group identifier.
7550
- * @param {MotionGroupJoints} motionGroupJoints
7551
7706
  * @param {*} [options] Override http request option.
7552
7707
  * @throws {RequiredError}
7553
7708
  */
7554
- setMotionGroupState: async (cell, controller, motionGroup, motionGroupJoints, options = {}) => {
7709
+ getMotionGroupState: async (cell, controller, motionGroup, options = {}) => {
7555
7710
  // verify required parameter 'cell' is not null or undefined
7556
- assertParamExists('setMotionGroupState', 'cell', cell);
7711
+ assertParamExists('getMotionGroupState', 'cell', cell);
7557
7712
  // verify required parameter 'controller' is not null or undefined
7558
- assertParamExists('setMotionGroupState', 'controller', controller);
7713
+ assertParamExists('getMotionGroupState', 'controller', controller);
7559
7714
  // verify required parameter 'motionGroup' is not null or undefined
7560
- assertParamExists('setMotionGroupState', 'motionGroup', motionGroup);
7561
- // verify required parameter 'motionGroupJoints' is not null or undefined
7562
- assertParamExists('setMotionGroupState', 'motionGroupJoints', motionGroupJoints);
7563
- const localVarPath = `/cells/{cell}/controllers/{controller}/teach-pendant/motion-groups/{motion-group}`
7715
+ assertParamExists('getMotionGroupState', 'motionGroup', motionGroup);
7716
+ const localVarPath = `/cells/{cell}/virtual-controllers/{controller}/motion-groups/{motion-group}/state`
7564
7717
  .replace(`{${"cell"}}`, encodeURIComponent(String(cell)))
7565
7718
  .replace(`{${"controller"}}`, encodeURIComponent(String(controller)))
7566
7719
  .replace(`{${"motion-group"}}`, encodeURIComponent(String(motionGroup)));
@@ -7570,7 +7723,7 @@ export const VirtualRobotApiAxiosParamCreator = function (configuration) {
7570
7723
  if (configuration) {
7571
7724
  baseOptions = configuration.baseOptions;
7572
7725
  }
7573
- const localVarRequestOptions = { method: 'PUT', ...baseOptions, ...options };
7726
+ const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options };
7574
7727
  const localVarHeaderParameter = {};
7575
7728
  const localVarQueryParameter = {};
7576
7729
  // authentication BasicAuth required
@@ -7579,139 +7732,14 @@ export const VirtualRobotApiAxiosParamCreator = function (configuration) {
7579
7732
  // authentication BearerAuth required
7580
7733
  // http bearer authentication required
7581
7734
  await setBearerAuthToObject(localVarHeaderParameter, configuration);
7582
- localVarHeaderParameter['Content-Type'] = 'application/json';
7583
7735
  setSearchParams(localVarUrlObj, localVarQueryParameter);
7584
7736
  let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
7585
7737
  localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
7586
- localVarRequestOptions.data = serializeDataIfNeeded(motionGroupJoints, localVarRequestOptions, configuration);
7587
7738
  return {
7588
7739
  url: toPathString(localVarUrlObj),
7589
7740
  options: localVarRequestOptions,
7590
7741
  };
7591
7742
  },
7592
- };
7593
- };
7594
- /**
7595
- * VirtualRobotApi - functional programming interface
7596
- * @export
7597
- */
7598
- export const VirtualRobotApiFp = function (configuration) {
7599
- const localVarAxiosParamCreator = VirtualRobotApiAxiosParamCreator(configuration);
7600
- return {
7601
- /**
7602
- * Get the current motion group state which provides values for the joints\' position, velocity and acceleration.
7603
- * @summary Get Motion Group State
7604
- * @param {string} cell Unique identifier addressing a cell in all API calls.
7605
- * @param {string} controller Unique identifier to address a controller in the cell.
7606
- * @param {string} motionGroup The motion-group identifier.
7607
- * @param {*} [options] Override http request option.
7608
- * @throws {RequiredError}
7609
- */
7610
- async getMotionGroupState(cell, controller, motionGroup, options) {
7611
- const localVarAxiosArgs = await localVarAxiosParamCreator.getMotionGroupState(cell, controller, motionGroup, options);
7612
- const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
7613
- const localVarOperationServerBasePath = operationServerMap['VirtualRobotApi.getMotionGroupState']?.[localVarOperationServerIndex]?.url;
7614
- return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
7615
- },
7616
- /**
7617
- * Gets information on the motion group.
7618
- * @summary Motion Group Description
7619
- * @param {string} cell Unique identifier addressing a cell in all API calls.
7620
- * @param {string} controller Unique identifier to address a controller in the cell.
7621
- * @param {*} [options] Override http request option.
7622
- * @throws {RequiredError}
7623
- */
7624
- async getMotionGroups(cell, controller, options) {
7625
- const localVarAxiosArgs = await localVarAxiosParamCreator.getMotionGroups(cell, controller, options);
7626
- const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
7627
- const localVarOperationServerBasePath = operationServerMap['VirtualRobotApi.getMotionGroups']?.[localVarOperationServerIndex]?.url;
7628
- return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
7629
- },
7630
- /**
7631
- * 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).
7632
- * @summary Get Inputs/Outputs
7633
- * @param {string} cell Unique identifier addressing a cell in all API calls.
7634
- * @param {string} controller Unique identifier to address a controller in the cell.
7635
- * @param {Array<string>} ios
7636
- * @param {*} [options] Override http request option.
7637
- * @throws {RequiredError}
7638
- */
7639
- async listIOs(cell, controller, ios, options) {
7640
- const localVarAxiosArgs = await localVarAxiosParamCreator.listIOs(cell, controller, ios, options);
7641
- const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
7642
- const localVarOperationServerBasePath = operationServerMap['VirtualRobotApi.listIOs']?.[localVarOperationServerIndex]?.url;
7643
- return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
7644
- },
7645
- /**
7646
- * 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.
7647
- * @summary List Input/Output Descriptions
7648
- * @param {string} cell Unique identifier addressing a cell in all API calls.
7649
- * @param {string} controller Unique identifier to address a controller in the cell.
7650
- * @param {Array<string>} [ios]
7651
- * @param {IODirection} [direction] Return only inputs/outputs with the specified direction.
7652
- * @param {IOValueType} [valueType] Return only inputs/outputs with the specified value type.
7653
- * @param {string} [group] Return only inputs/outputs from the specified group.
7654
- * @param {*} [options] Override http request option.
7655
- * @throws {RequiredError}
7656
- */
7657
- async listVirtualRobotIODescriptions(cell, controller, ios, direction, valueType, group, options) {
7658
- const localVarAxiosArgs = await localVarAxiosParamCreator.listVirtualRobotIODescriptions(cell, controller, ios, direction, valueType, group, options);
7659
- const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
7660
- const localVarOperationServerBasePath = operationServerMap['VirtualRobotApi.listVirtualRobotIODescriptions']?.[localVarOperationServerIndex]?.url;
7661
- return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
7662
- },
7663
- /**
7664
- * Sets a list of values of a virtual controller inputs/outputs.
7665
- * @summary Set Input/Ouput Values
7666
- * @param {string} cell Unique identifier addressing a cell in all API calls.
7667
- * @param {string} controller Unique identifier to address a controller in the cell.
7668
- * @param {Array<IOValue>} iOValue
7669
- * @param {*} [options] Override http request option.
7670
- * @throws {RequiredError}
7671
- */
7672
- async setIOValues(cell, controller, iOValue, options) {
7673
- const localVarAxiosArgs = await localVarAxiosParamCreator.setIOValues(cell, controller, iOValue, options);
7674
- const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
7675
- const localVarOperationServerBasePath = operationServerMap['VirtualRobotApi.setIOValues']?.[localVarOperationServerIndex]?.url;
7676
- return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
7677
- },
7678
- /**
7679
- * 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.
7680
- * @summary Set Motion Group State
7681
- * @param {string} cell Unique identifier addressing a cell in all API calls.
7682
- * @param {string} controller Unique identifier to address a controller in the cell.
7683
- * @param {string} motionGroup The motion-group identifier.
7684
- * @param {MotionGroupJoints} motionGroupJoints
7685
- * @param {*} [options] Override http request option.
7686
- * @throws {RequiredError}
7687
- */
7688
- async setMotionGroupState(cell, controller, motionGroup, motionGroupJoints, options) {
7689
- const localVarAxiosArgs = await localVarAxiosParamCreator.setMotionGroupState(cell, controller, motionGroup, motionGroupJoints, options);
7690
- const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
7691
- const localVarOperationServerBasePath = operationServerMap['VirtualRobotApi.setMotionGroupState']?.[localVarOperationServerIndex]?.url;
7692
- return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
7693
- },
7694
- };
7695
- };
7696
- /**
7697
- * VirtualRobotApi - factory interface
7698
- * @export
7699
- */
7700
- export const VirtualRobotApiFactory = function (configuration, basePath, axios) {
7701
- const localVarFp = VirtualRobotApiFp(configuration);
7702
- return {
7703
- /**
7704
- * Get the current motion group state which provides values for the joints\' position, velocity and acceleration.
7705
- * @summary Get Motion Group State
7706
- * @param {string} cell Unique identifier addressing a cell in all API calls.
7707
- * @param {string} controller Unique identifier to address a controller in the cell.
7708
- * @param {string} motionGroup The motion-group identifier.
7709
- * @param {*} [options] Override http request option.
7710
- * @throws {RequiredError}
7711
- */
7712
- getMotionGroupState(cell, controller, motionGroup, options) {
7713
- return localVarFp.getMotionGroupState(cell, controller, motionGroup, options).then((request) => request(axios, basePath));
7714
- },
7715
7743
  /**
7716
7744
  * Gets information on the motion group.
7717
7745
  * @summary Motion Group Description
@@ -7720,175 +7748,12 @@ export const VirtualRobotApiFactory = function (configuration, basePath, axios)
7720
7748
  * @param {*} [options] Override http request option.
7721
7749
  * @throws {RequiredError}
7722
7750
  */
7723
- getMotionGroups(cell, controller, options) {
7724
- return localVarFp.getMotionGroups(cell, controller, options).then((request) => request(axios, basePath));
7725
- },
7726
- /**
7727
- * 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).
7728
- * @summary Get Inputs/Outputs
7729
- * @param {string} cell Unique identifier addressing a cell in all API calls.
7730
- * @param {string} controller Unique identifier to address a controller in the cell.
7731
- * @param {Array<string>} ios
7732
- * @param {*} [options] Override http request option.
7733
- * @throws {RequiredError}
7734
- */
7735
- listIOs(cell, controller, ios, options) {
7736
- return localVarFp.listIOs(cell, controller, ios, options).then((request) => request(axios, basePath));
7737
- },
7738
- /**
7739
- * 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.
7740
- * @summary List Input/Output Descriptions
7741
- * @param {string} cell Unique identifier addressing a cell in all API calls.
7742
- * @param {string} controller Unique identifier to address a controller in the cell.
7743
- * @param {Array<string>} [ios]
7744
- * @param {IODirection} [direction] Return only inputs/outputs with the specified direction.
7745
- * @param {IOValueType} [valueType] Return only inputs/outputs with the specified value type.
7746
- * @param {string} [group] Return only inputs/outputs from the specified group.
7747
- * @param {*} [options] Override http request option.
7748
- * @throws {RequiredError}
7749
- */
7750
- listVirtualRobotIODescriptions(cell, controller, ios, direction, valueType, group, options) {
7751
- return localVarFp.listVirtualRobotIODescriptions(cell, controller, ios, direction, valueType, group, options).then((request) => request(axios, basePath));
7752
- },
7753
- /**
7754
- * Sets a list of values of a virtual controller inputs/outputs.
7755
- * @summary Set Input/Ouput Values
7756
- * @param {string} cell Unique identifier addressing a cell in all API calls.
7757
- * @param {string} controller Unique identifier to address a controller in the cell.
7758
- * @param {Array<IOValue>} iOValue
7759
- * @param {*} [options] Override http request option.
7760
- * @throws {RequiredError}
7761
- */
7762
- setIOValues(cell, controller, iOValue, options) {
7763
- return localVarFp.setIOValues(cell, controller, iOValue, options).then((request) => request(axios, basePath));
7764
- },
7765
- /**
7766
- * 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.
7767
- * @summary Set Motion Group State
7768
- * @param {string} cell Unique identifier addressing a cell in all API calls.
7769
- * @param {string} controller Unique identifier to address a controller in the cell.
7770
- * @param {string} motionGroup The motion-group identifier.
7771
- * @param {MotionGroupJoints} motionGroupJoints
7772
- * @param {*} [options] Override http request option.
7773
- * @throws {RequiredError}
7774
- */
7775
- setMotionGroupState(cell, controller, motionGroup, motionGroupJoints, options) {
7776
- return localVarFp.setMotionGroupState(cell, controller, motionGroup, motionGroupJoints, options).then((request) => request(axios, basePath));
7777
- },
7778
- };
7779
- };
7780
- /**
7781
- * VirtualRobotApi - object-oriented interface
7782
- * @export
7783
- * @class VirtualRobotApi
7784
- * @extends {BaseAPI}
7785
- */
7786
- export class VirtualRobotApi extends BaseAPI {
7787
- /**
7788
- * Get the current motion group state which provides values for the joints\' position, velocity and acceleration.
7789
- * @summary Get Motion Group State
7790
- * @param {string} cell Unique identifier addressing a cell in all API calls.
7791
- * @param {string} controller Unique identifier to address a controller in the cell.
7792
- * @param {string} motionGroup The motion-group identifier.
7793
- * @param {*} [options] Override http request option.
7794
- * @throws {RequiredError}
7795
- * @memberof VirtualRobotApi
7796
- */
7797
- getMotionGroupState(cell, controller, motionGroup, options) {
7798
- return VirtualRobotApiFp(this.configuration).getMotionGroupState(cell, controller, motionGroup, options).then((request) => request(this.axios, this.basePath));
7799
- }
7800
- /**
7801
- * Gets information on the motion group.
7802
- * @summary Motion Group Description
7803
- * @param {string} cell Unique identifier addressing a cell in all API calls.
7804
- * @param {string} controller Unique identifier to address a controller in the cell.
7805
- * @param {*} [options] Override http request option.
7806
- * @throws {RequiredError}
7807
- * @memberof VirtualRobotApi
7808
- */
7809
- getMotionGroups(cell, controller, options) {
7810
- return VirtualRobotApiFp(this.configuration).getMotionGroups(cell, controller, options).then((request) => request(this.axios, this.basePath));
7811
- }
7812
- /**
7813
- * 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).
7814
- * @summary Get Inputs/Outputs
7815
- * @param {string} cell Unique identifier addressing a cell in all API calls.
7816
- * @param {string} controller Unique identifier to address a controller in the cell.
7817
- * @param {Array<string>} ios
7818
- * @param {*} [options] Override http request option.
7819
- * @throws {RequiredError}
7820
- * @memberof VirtualRobotApi
7821
- */
7822
- listIOs(cell, controller, ios, options) {
7823
- return VirtualRobotApiFp(this.configuration).listIOs(cell, controller, ios, options).then((request) => request(this.axios, this.basePath));
7824
- }
7825
- /**
7826
- * 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.
7827
- * @summary List Input/Output Descriptions
7828
- * @param {string} cell Unique identifier addressing a cell in all API calls.
7829
- * @param {string} controller Unique identifier to address a controller in the cell.
7830
- * @param {Array<string>} [ios]
7831
- * @param {IODirection} [direction] Return only inputs/outputs with the specified direction.
7832
- * @param {IOValueType} [valueType] Return only inputs/outputs with the specified value type.
7833
- * @param {string} [group] Return only inputs/outputs from the specified group.
7834
- * @param {*} [options] Override http request option.
7835
- * @throws {RequiredError}
7836
- * @memberof VirtualRobotApi
7837
- */
7838
- listVirtualRobotIODescriptions(cell, controller, ios, direction, valueType, group, options) {
7839
- return VirtualRobotApiFp(this.configuration).listVirtualRobotIODescriptions(cell, controller, ios, direction, valueType, group, options).then((request) => request(this.axios, this.basePath));
7840
- }
7841
- /**
7842
- * Sets a list of values of a virtual controller inputs/outputs.
7843
- * @summary Set Input/Ouput Values
7844
- * @param {string} cell Unique identifier addressing a cell in all API calls.
7845
- * @param {string} controller Unique identifier to address a controller in the cell.
7846
- * @param {Array<IOValue>} iOValue
7847
- * @param {*} [options] Override http request option.
7848
- * @throws {RequiredError}
7849
- * @memberof VirtualRobotApi
7850
- */
7851
- setIOValues(cell, controller, iOValue, options) {
7852
- return VirtualRobotApiFp(this.configuration).setIOValues(cell, controller, iOValue, options).then((request) => request(this.axios, this.basePath));
7853
- }
7854
- /**
7855
- * 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.
7856
- * @summary Set Motion Group State
7857
- * @param {string} cell Unique identifier addressing a cell in all API calls.
7858
- * @param {string} controller Unique identifier to address a controller in the cell.
7859
- * @param {string} motionGroup The motion-group identifier.
7860
- * @param {MotionGroupJoints} motionGroupJoints
7861
- * @param {*} [options] Override http request option.
7862
- * @throws {RequiredError}
7863
- * @memberof VirtualRobotApi
7864
- */
7865
- setMotionGroupState(cell, controller, motionGroup, motionGroupJoints, options) {
7866
- return VirtualRobotApiFp(this.configuration).setMotionGroupState(cell, controller, motionGroup, motionGroupJoints, options).then((request) => request(this.axios, this.basePath));
7867
- }
7868
- }
7869
- /**
7870
- * VirtualRobotBehaviorApi - axios parameter creator
7871
- * @export
7872
- */
7873
- export const VirtualRobotBehaviorApiAxiosParamCreator = function (configuration) {
7874
- return {
7875
- /**
7876
- * <!-- 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.
7877
- * @summary Stream Joint Configuration
7878
- * @param {string} cell Unique identifier addressing a cell in all API calls.
7879
- * @param {string} controller Unique identifier to address a controller in the cell.
7880
- * @param {ExternalJointStreamDatapoint} externalJointStreamDatapoint
7881
- * @param {*} [options] Override http request option.
7882
- * @throws {RequiredError}
7883
- */
7884
- externalJointsStream: async (cell, controller, externalJointStreamDatapoint, options = {}) => {
7751
+ getMotionGroups: async (cell, controller, options = {}) => {
7885
7752
  // verify required parameter 'cell' is not null or undefined
7886
- assertParamExists('externalJointsStream', 'cell', cell);
7753
+ assertParamExists('getMotionGroups', 'cell', cell);
7887
7754
  // verify required parameter 'controller' is not null or undefined
7888
- assertParamExists('externalJointsStream', 'controller', controller);
7889
- // verify required parameter 'externalJointStreamDatapoint' is not null or undefined
7890
- assertParamExists('externalJointsStream', 'externalJointStreamDatapoint', externalJointStreamDatapoint);
7891
- const localVarPath = `/cells/{cell}/controllers/{controller}/teach-pendant/motion-groups/external-joints-stream`
7755
+ assertParamExists('getMotionGroups', 'controller', controller);
7756
+ const localVarPath = `/cells/{cell}/virtual-controllers/{controller}/motion-groups`
7892
7757
  .replace(`{${"cell"}}`, encodeURIComponent(String(cell)))
7893
7758
  .replace(`{${"controller"}}`, encodeURIComponent(String(controller)));
7894
7759
  // use dummy base URL string because the URL constructor only accepts absolute URLs.
@@ -7906,51 +7771,6 @@ export const VirtualRobotBehaviorApiAxiosParamCreator = function (configuration)
7906
7771
  // authentication BearerAuth required
7907
7772
  // http bearer authentication required
7908
7773
  await setBearerAuthToObject(localVarHeaderParameter, configuration);
7909
- localVarHeaderParameter['Content-Type'] = 'application/json';
7910
- setSearchParams(localVarUrlObj, localVarQueryParameter);
7911
- let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
7912
- localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
7913
- localVarRequestOptions.data = serializeDataIfNeeded(externalJointStreamDatapoint, localVarRequestOptions, configuration);
7914
- return {
7915
- url: toPathString(localVarUrlObj),
7916
- options: localVarRequestOptions,
7917
- };
7918
- },
7919
- /**
7920
- * Get the current robot motion group behavior - please see the setter [setMotionGroupBehavior](setMotionGroupBehavior) and the enum for details.
7921
- * @summary Behavior
7922
- * @param {string} cell Unique identifier addressing a cell in all API calls.
7923
- * @param {string} controller Unique identifier to address a controller in the cell.
7924
- * @param {string} motionGroup The motion-group identifier.
7925
- * @param {*} [options] Override http request option.
7926
- * @throws {RequiredError}
7927
- */
7928
- getMotionGroupBehavior: async (cell, controller, motionGroup, options = {}) => {
7929
- // verify required parameter 'cell' is not null or undefined
7930
- assertParamExists('getMotionGroupBehavior', 'cell', cell);
7931
- // verify required parameter 'controller' is not null or undefined
7932
- assertParamExists('getMotionGroupBehavior', 'controller', controller);
7933
- // verify required parameter 'motionGroup' is not null or undefined
7934
- assertParamExists('getMotionGroupBehavior', 'motionGroup', motionGroup);
7935
- const localVarPath = `/cells/{cell}/controllers/{controller}/teach-pendant/motion-groups/{motion-group}/behavior`
7936
- .replace(`{${"cell"}}`, encodeURIComponent(String(cell)))
7937
- .replace(`{${"controller"}}`, encodeURIComponent(String(controller)))
7938
- .replace(`{${"motion-group"}}`, encodeURIComponent(String(motionGroup)));
7939
- // use dummy base URL string because the URL constructor only accepts absolute URLs.
7940
- const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
7941
- let baseOptions;
7942
- if (configuration) {
7943
- baseOptions = configuration.baseOptions;
7944
- }
7945
- const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options };
7946
- const localVarHeaderParameter = {};
7947
- const localVarQueryParameter = {};
7948
- // authentication BasicAuth required
7949
- // http basic authentication required
7950
- setBasicAuthToObject(localVarRequestOptions, configuration);
7951
- // authentication BearerAuth required
7952
- // http bearer authentication required
7953
- await setBearerAuthToObject(localVarHeaderParameter, configuration);
7954
7774
  setSearchParams(localVarUrlObj, localVarQueryParameter);
7955
7775
  let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
7956
7776
  localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
@@ -7960,225 +7780,64 @@ export const VirtualRobotBehaviorApiAxiosParamCreator = function (configuration)
7960
7780
  };
7961
7781
  },
7962
7782
  /**
7963
- * Switch robot motion group behavior.
7964
- * @summary Switch Behavior
7783
+ * 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.
7784
+ * @summary Get Operation Mode
7965
7785
  * @param {string} cell Unique identifier addressing a cell in all API calls.
7966
7786
  * @param {string} controller Unique identifier to address a controller in the cell.
7967
- * @param {string} motionGroup The motion-group identifier.
7968
- * @param {Behavior} [behavior]
7969
7787
  * @param {*} [options] Override http request option.
7970
7788
  * @throws {RequiredError}
7971
7789
  */
7972
- setMotionGroupBehavior: async (cell, controller, motionGroup, behavior, options = {}) => {
7790
+ getOperationMode: async (cell, controller, options = {}) => {
7973
7791
  // verify required parameter 'cell' is not null or undefined
7974
- assertParamExists('setMotionGroupBehavior', 'cell', cell);
7975
- // verify required parameter 'controller' is not null or undefined
7976
- assertParamExists('setMotionGroupBehavior', 'controller', controller);
7977
- // verify required parameter 'motionGroup' is not null or undefined
7978
- assertParamExists('setMotionGroupBehavior', 'motionGroup', motionGroup);
7979
- const localVarPath = `/cells/{cell}/controllers/{controller}/teach-pendant/motion-groups/{motion-group}/behavior`
7980
- .replace(`{${"cell"}}`, encodeURIComponent(String(cell)))
7981
- .replace(`{${"controller"}}`, encodeURIComponent(String(controller)))
7982
- .replace(`{${"motion-group"}}`, encodeURIComponent(String(motionGroup)));
7983
- // use dummy base URL string because the URL constructor only accepts absolute URLs.
7984
- const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
7985
- let baseOptions;
7986
- if (configuration) {
7987
- baseOptions = configuration.baseOptions;
7988
- }
7989
- const localVarRequestOptions = { method: 'PUT', ...baseOptions, ...options };
7990
- const localVarHeaderParameter = {};
7991
- const localVarQueryParameter = {};
7992
- // authentication BasicAuth required
7993
- // http basic authentication required
7994
- setBasicAuthToObject(localVarRequestOptions, configuration);
7995
- // authentication BearerAuth required
7996
- // http bearer authentication required
7997
- await setBearerAuthToObject(localVarHeaderParameter, configuration);
7998
- if (behavior !== undefined) {
7999
- localVarQueryParameter['behavior'] = behavior;
8000
- }
8001
- setSearchParams(localVarUrlObj, localVarQueryParameter);
8002
- let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
8003
- localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
8004
- return {
8005
- url: toPathString(localVarUrlObj),
8006
- options: localVarRequestOptions,
8007
- };
8008
- },
8009
- };
8010
- };
8011
- /**
8012
- * VirtualRobotBehaviorApi - functional programming interface
8013
- * @export
8014
- */
8015
- export const VirtualRobotBehaviorApiFp = function (configuration) {
8016
- const localVarAxiosParamCreator = VirtualRobotBehaviorApiAxiosParamCreator(configuration);
8017
- return {
8018
- /**
8019
- * <!-- 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.
8020
- * @summary Stream Joint Configuration
8021
- * @param {string} cell Unique identifier addressing a cell in all API calls.
8022
- * @param {string} controller Unique identifier to address a controller in the cell.
8023
- * @param {ExternalJointStreamDatapoint} externalJointStreamDatapoint
8024
- * @param {*} [options] Override http request option.
8025
- * @throws {RequiredError}
8026
- */
8027
- async externalJointsStream(cell, controller, externalJointStreamDatapoint, options) {
8028
- const localVarAxiosArgs = await localVarAxiosParamCreator.externalJointsStream(cell, controller, externalJointStreamDatapoint, options);
8029
- const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
8030
- const localVarOperationServerBasePath = operationServerMap['VirtualRobotBehaviorApi.externalJointsStream']?.[localVarOperationServerIndex]?.url;
8031
- return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
8032
- },
8033
- /**
8034
- * Get the current robot motion group behavior - please see the setter [setMotionGroupBehavior](setMotionGroupBehavior) and the enum for details.
8035
- * @summary Behavior
8036
- * @param {string} cell Unique identifier addressing a cell in all API calls.
8037
- * @param {string} controller Unique identifier to address a controller in the cell.
8038
- * @param {string} motionGroup The motion-group identifier.
8039
- * @param {*} [options] Override http request option.
8040
- * @throws {RequiredError}
8041
- */
8042
- async getMotionGroupBehavior(cell, controller, motionGroup, options) {
8043
- const localVarAxiosArgs = await localVarAxiosParamCreator.getMotionGroupBehavior(cell, controller, motionGroup, options);
8044
- const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
8045
- const localVarOperationServerBasePath = operationServerMap['VirtualRobotBehaviorApi.getMotionGroupBehavior']?.[localVarOperationServerIndex]?.url;
8046
- return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
8047
- },
8048
- /**
8049
- * Switch robot motion group behavior.
8050
- * @summary Switch Behavior
8051
- * @param {string} cell Unique identifier addressing a cell in all API calls.
8052
- * @param {string} controller Unique identifier to address a controller in the cell.
8053
- * @param {string} motionGroup The motion-group identifier.
8054
- * @param {Behavior} [behavior]
8055
- * @param {*} [options] Override http request option.
8056
- * @throws {RequiredError}
8057
- */
8058
- async setMotionGroupBehavior(cell, controller, motionGroup, behavior, options) {
8059
- const localVarAxiosArgs = await localVarAxiosParamCreator.setMotionGroupBehavior(cell, controller, motionGroup, behavior, options);
8060
- const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
8061
- const localVarOperationServerBasePath = operationServerMap['VirtualRobotBehaviorApi.setMotionGroupBehavior']?.[localVarOperationServerIndex]?.url;
8062
- return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
8063
- },
8064
- };
8065
- };
8066
- /**
8067
- * VirtualRobotBehaviorApi - factory interface
8068
- * @export
8069
- */
8070
- export const VirtualRobotBehaviorApiFactory = function (configuration, basePath, axios) {
8071
- const localVarFp = VirtualRobotBehaviorApiFp(configuration);
8072
- return {
8073
- /**
8074
- * <!-- 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.
8075
- * @summary Stream Joint Configuration
8076
- * @param {string} cell Unique identifier addressing a cell in all API calls.
8077
- * @param {string} controller Unique identifier to address a controller in the cell.
8078
- * @param {ExternalJointStreamDatapoint} externalJointStreamDatapoint
8079
- * @param {*} [options] Override http request option.
8080
- * @throws {RequiredError}
8081
- */
8082
- externalJointsStream(cell, controller, externalJointStreamDatapoint, options) {
8083
- return localVarFp.externalJointsStream(cell, controller, externalJointStreamDatapoint, options).then((request) => request(axios, basePath));
8084
- },
8085
- /**
8086
- * Get the current robot motion group behavior - please see the setter [setMotionGroupBehavior](setMotionGroupBehavior) and the enum for details.
8087
- * @summary Behavior
8088
- * @param {string} cell Unique identifier addressing a cell in all API calls.
8089
- * @param {string} controller Unique identifier to address a controller in the cell.
8090
- * @param {string} motionGroup The motion-group identifier.
8091
- * @param {*} [options] Override http request option.
8092
- * @throws {RequiredError}
8093
- */
8094
- getMotionGroupBehavior(cell, controller, motionGroup, options) {
8095
- return localVarFp.getMotionGroupBehavior(cell, controller, motionGroup, options).then((request) => request(axios, basePath));
8096
- },
8097
- /**
8098
- * Switch robot motion group behavior.
8099
- * @summary Switch Behavior
8100
- * @param {string} cell Unique identifier addressing a cell in all API calls.
8101
- * @param {string} controller Unique identifier to address a controller in the cell.
8102
- * @param {string} motionGroup The motion-group identifier.
8103
- * @param {Behavior} [behavior]
8104
- * @param {*} [options] Override http request option.
8105
- * @throws {RequiredError}
8106
- */
8107
- setMotionGroupBehavior(cell, controller, motionGroup, behavior, options) {
8108
- return localVarFp.setMotionGroupBehavior(cell, controller, motionGroup, behavior, options).then((request) => request(axios, basePath));
8109
- },
8110
- };
8111
- };
8112
- /**
8113
- * VirtualRobotBehaviorApi - object-oriented interface
8114
- * @export
8115
- * @class VirtualRobotBehaviorApi
8116
- * @extends {BaseAPI}
8117
- */
8118
- export class VirtualRobotBehaviorApi extends BaseAPI {
8119
- /**
8120
- * <!-- 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.
8121
- * @summary Stream Joint Configuration
8122
- * @param {string} cell Unique identifier addressing a cell in all API calls.
8123
- * @param {string} controller Unique identifier to address a controller in the cell.
8124
- * @param {ExternalJointStreamDatapoint} externalJointStreamDatapoint
8125
- * @param {*} [options] Override http request option.
8126
- * @throws {RequiredError}
8127
- * @memberof VirtualRobotBehaviorApi
8128
- */
8129
- externalJointsStream(cell, controller, externalJointStreamDatapoint, options) {
8130
- return VirtualRobotBehaviorApiFp(this.configuration).externalJointsStream(cell, controller, externalJointStreamDatapoint, options).then((request) => request(this.axios, this.basePath));
8131
- }
8132
- /**
8133
- * Get the current robot motion group behavior - please see the setter [setMotionGroupBehavior](setMotionGroupBehavior) and the enum for details.
8134
- * @summary Behavior
8135
- * @param {string} cell Unique identifier addressing a cell in all API calls.
8136
- * @param {string} controller Unique identifier to address a controller in the cell.
8137
- * @param {string} motionGroup The motion-group identifier.
8138
- * @param {*} [options] Override http request option.
8139
- * @throws {RequiredError}
8140
- * @memberof VirtualRobotBehaviorApi
8141
- */
8142
- getMotionGroupBehavior(cell, controller, motionGroup, options) {
8143
- return VirtualRobotBehaviorApiFp(this.configuration).getMotionGroupBehavior(cell, controller, motionGroup, options).then((request) => request(this.axios, this.basePath));
8144
- }
8145
- /**
8146
- * Switch robot motion group behavior.
8147
- * @summary Switch Behavior
8148
- * @param {string} cell Unique identifier addressing a cell in all API calls.
8149
- * @param {string} controller Unique identifier to address a controller in the cell.
8150
- * @param {string} motionGroup The motion-group identifier.
8151
- * @param {Behavior} [behavior]
8152
- * @param {*} [options] Override http request option.
8153
- * @throws {RequiredError}
8154
- * @memberof VirtualRobotBehaviorApi
8155
- */
8156
- setMotionGroupBehavior(cell, controller, motionGroup, behavior, options) {
8157
- return VirtualRobotBehaviorApiFp(this.configuration).setMotionGroupBehavior(cell, controller, motionGroup, behavior, options).then((request) => request(this.axios, this.basePath));
8158
- }
8159
- }
8160
- /**
8161
- * VirtualRobotModeApi - axios parameter creator
8162
- * @export
8163
- */
8164
- export const VirtualRobotModeApiAxiosParamCreator = function (configuration) {
8165
- return {
7792
+ assertParamExists('getOperationMode', 'cell', cell);
7793
+ // verify required parameter 'controller' is not null or undefined
7794
+ assertParamExists('getOperationMode', 'controller', controller);
7795
+ const localVarPath = `/cells/{cell}/virtual-controllers/{controller}/operationmode`
7796
+ .replace(`{${"cell"}}`, encodeURIComponent(String(cell)))
7797
+ .replace(`{${"controller"}}`, encodeURIComponent(String(controller)));
7798
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
7799
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
7800
+ let baseOptions;
7801
+ if (configuration) {
7802
+ baseOptions = configuration.baseOptions;
7803
+ }
7804
+ const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options };
7805
+ const localVarHeaderParameter = {};
7806
+ const localVarQueryParameter = {};
7807
+ // authentication BasicAuth required
7808
+ // http basic authentication required
7809
+ setBasicAuthToObject(localVarRequestOptions, configuration);
7810
+ // authentication BearerAuth required
7811
+ // http bearer authentication required
7812
+ await setBearerAuthToObject(localVarHeaderParameter, configuration);
7813
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
7814
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
7815
+ localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
7816
+ return {
7817
+ url: toPathString(localVarUrlObj),
7818
+ options: localVarRequestOptions,
7819
+ };
7820
+ },
8166
7821
  /**
8167
- * Get the cycle time of controller communication in [ms].
8168
- * @summary Cycle Time
7822
+ * Gets motion group mounting. The motion group is based on the origin of the returned coordinate system.
7823
+ * @summary Get Mounting
8169
7824
  * @param {string} cell Unique identifier addressing a cell in all API calls.
8170
7825
  * @param {string} controller Unique identifier to address a controller in the cell.
7826
+ * @param {string} motionGroup The motion-group identifier.
8171
7827
  * @param {*} [options] Override http request option.
8172
7828
  * @throws {RequiredError}
8173
7829
  */
8174
- getCycleTime: async (cell, controller, options = {}) => {
7830
+ getVirtualControllerMounting: async (cell, controller, motionGroup, options = {}) => {
8175
7831
  // verify required parameter 'cell' is not null or undefined
8176
- assertParamExists('getCycleTime', 'cell', cell);
7832
+ assertParamExists('getVirtualControllerMounting', 'cell', cell);
8177
7833
  // verify required parameter 'controller' is not null or undefined
8178
- assertParamExists('getCycleTime', 'controller', controller);
8179
- const localVarPath = `/cells/{cell}/controllers/{controller}/teach-pendant/cycle-time`
7834
+ assertParamExists('getVirtualControllerMounting', 'controller', controller);
7835
+ // verify required parameter 'motionGroup' is not null or undefined
7836
+ assertParamExists('getVirtualControllerMounting', 'motionGroup', motionGroup);
7837
+ const localVarPath = `/cells/{cell}/virtual-controllers/{controller}/motion-groups/{motion-group}/mounting`
8180
7838
  .replace(`{${"cell"}}`, encodeURIComponent(String(cell)))
8181
- .replace(`{${"controller"}}`, encodeURIComponent(String(controller)));
7839
+ .replace(`{${"controller"}}`, encodeURIComponent(String(controller)))
7840
+ .replace(`{${"motion-group"}}`, encodeURIComponent(String(motionGroup)));
8182
7841
  // use dummy base URL string because the URL constructor only accepts absolute URLs.
8183
7842
  const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
8184
7843
  let baseOptions;
@@ -8203,19 +7862,19 @@ export const VirtualRobotModeApiAxiosParamCreator = function (configuration) {
8203
7862
  };
8204
7863
  },
8205
7864
  /**
8206
- * 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.
8207
- * @summary Get Emergency Stop State
7865
+ * Lists all coordinate systems on the robot controller.
7866
+ * @summary List Coordinate Systems
8208
7867
  * @param {string} cell Unique identifier addressing a cell in all API calls.
8209
7868
  * @param {string} controller Unique identifier to address a controller in the cell.
8210
7869
  * @param {*} [options] Override http request option.
8211
7870
  * @throws {RequiredError}
8212
7871
  */
8213
- getEmergencyStop: async (cell, controller, options = {}) => {
7872
+ listVirtualControllerCoordinateSystems: async (cell, controller, options = {}) => {
8214
7873
  // verify required parameter 'cell' is not null or undefined
8215
- assertParamExists('getEmergencyStop', 'cell', cell);
7874
+ assertParamExists('listVirtualControllerCoordinateSystems', 'cell', cell);
8216
7875
  // verify required parameter 'controller' is not null or undefined
8217
- assertParamExists('getEmergencyStop', 'controller', controller);
8218
- const localVarPath = `/cells/{cell}/controllers/{controller}/teach-pendant/emergency-stop`
7876
+ assertParamExists('listVirtualControllerCoordinateSystems', 'controller', controller);
7877
+ const localVarPath = `/cells/{cell}/virtual-controllers/{controller}/coordinate-systems`
8219
7878
  .replace(`{${"cell"}}`, encodeURIComponent(String(cell)))
8220
7879
  .replace(`{${"controller"}}`, encodeURIComponent(String(controller)));
8221
7880
  // use dummy base URL string because the URL constructor only accepts absolute URLs.
@@ -8242,21 +7901,25 @@ export const VirtualRobotModeApiAxiosParamCreator = function (configuration) {
8242
7901
  };
8243
7902
  },
8244
7903
  /**
8245
- * 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.
8246
- * @summary Get Operation Mode
7904
+ * Lists TCPs of the motion group. An empty TCP list is valid, for example for external axes.
7905
+ * @summary List TCPs
8247
7906
  * @param {string} cell Unique identifier addressing a cell in all API calls.
8248
7907
  * @param {string} controller Unique identifier to address a controller in the cell.
7908
+ * @param {string} motionGroup The motion-group identifier.
8249
7909
  * @param {*} [options] Override http request option.
8250
7910
  * @throws {RequiredError}
8251
7911
  */
8252
- getOperationMode: async (cell, controller, options = {}) => {
7912
+ listVirtualControllerTcps: async (cell, controller, motionGroup, options = {}) => {
8253
7913
  // verify required parameter 'cell' is not null or undefined
8254
- assertParamExists('getOperationMode', 'cell', cell);
7914
+ assertParamExists('listVirtualControllerTcps', 'cell', cell);
8255
7915
  // verify required parameter 'controller' is not null or undefined
8256
- assertParamExists('getOperationMode', 'controller', controller);
8257
- const localVarPath = `/cells/{cell}/controllers/{controller}/teach-pendant/operationmode`
7916
+ assertParamExists('listVirtualControllerTcps', 'controller', controller);
7917
+ // verify required parameter 'motionGroup' is not null or undefined
7918
+ assertParamExists('listVirtualControllerTcps', 'motionGroup', motionGroup);
7919
+ const localVarPath = `/cells/{cell}/virtual-controllers/{controller}/motion-groups/{motion-group}/tcps`
8258
7920
  .replace(`{${"cell"}}`, encodeURIComponent(String(cell)))
8259
- .replace(`{${"controller"}}`, encodeURIComponent(String(controller)));
7921
+ .replace(`{${"controller"}}`, encodeURIComponent(String(controller)))
7922
+ .replace(`{${"motion-group"}}`, encodeURIComponent(String(motionGroup)));
8260
7923
  // use dummy base URL string because the URL constructor only accepts absolute URLs.
8261
7924
  const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
8262
7925
  let baseOptions;
@@ -8294,7 +7957,7 @@ export const VirtualRobotModeApiAxiosParamCreator = function (configuration) {
8294
7957
  assertParamExists('setEmergencyStop', 'cell', cell);
8295
7958
  // verify required parameter 'controller' is not null or undefined
8296
7959
  assertParamExists('setEmergencyStop', 'controller', controller);
8297
- const localVarPath = `/cells/{cell}/controllers/{controller}/teach-pendant/emergency-stop`
7960
+ const localVarPath = `/cells/{cell}/virtual-controllers/{controller}/emergency-stop`
8298
7961
  .replace(`{${"cell"}}`, encodeURIComponent(String(cell)))
8299
7962
  .replace(`{${"controller"}}`, encodeURIComponent(String(controller)));
8300
7963
  // use dummy base URL string because the URL constructor only accepts absolute URLs.
@@ -8323,6 +7986,54 @@ export const VirtualRobotModeApiAxiosParamCreator = function (configuration) {
8323
7986
  options: localVarRequestOptions,
8324
7987
  };
8325
7988
  },
7989
+ /**
7990
+ * 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.
7991
+ * @summary Set Motion Group State
7992
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
7993
+ * @param {string} controller Unique identifier to address a controller in the cell.
7994
+ * @param {string} motionGroup The motion-group identifier.
7995
+ * @param {MotionGroupJoints} motionGroupJoints
7996
+ * @param {*} [options] Override http request option.
7997
+ * @throws {RequiredError}
7998
+ */
7999
+ setMotionGroupState: async (cell, controller, motionGroup, motionGroupJoints, options = {}) => {
8000
+ // verify required parameter 'cell' is not null or undefined
8001
+ assertParamExists('setMotionGroupState', 'cell', cell);
8002
+ // verify required parameter 'controller' is not null or undefined
8003
+ assertParamExists('setMotionGroupState', 'controller', controller);
8004
+ // verify required parameter 'motionGroup' is not null or undefined
8005
+ assertParamExists('setMotionGroupState', 'motionGroup', motionGroup);
8006
+ // verify required parameter 'motionGroupJoints' is not null or undefined
8007
+ assertParamExists('setMotionGroupState', 'motionGroupJoints', motionGroupJoints);
8008
+ const localVarPath = `/cells/{cell}/virtual-controllers/{controller}/motion-groups/{motion-group}/state`
8009
+ .replace(`{${"cell"}}`, encodeURIComponent(String(cell)))
8010
+ .replace(`{${"controller"}}`, encodeURIComponent(String(controller)))
8011
+ .replace(`{${"motion-group"}}`, encodeURIComponent(String(motionGroup)));
8012
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
8013
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
8014
+ let baseOptions;
8015
+ if (configuration) {
8016
+ baseOptions = configuration.baseOptions;
8017
+ }
8018
+ const localVarRequestOptions = { method: 'PUT', ...baseOptions, ...options };
8019
+ const localVarHeaderParameter = {};
8020
+ const localVarQueryParameter = {};
8021
+ // authentication BasicAuth required
8022
+ // http basic authentication required
8023
+ setBasicAuthToObject(localVarRequestOptions, configuration);
8024
+ // authentication BearerAuth required
8025
+ // http bearer authentication required
8026
+ await setBearerAuthToObject(localVarHeaderParameter, configuration);
8027
+ localVarHeaderParameter['Content-Type'] = 'application/json';
8028
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
8029
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
8030
+ localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
8031
+ localVarRequestOptions.data = serializeDataIfNeeded(motionGroupJoints, localVarRequestOptions, configuration);
8032
+ return {
8033
+ url: toPathString(localVarUrlObj),
8034
+ options: localVarRequestOptions,
8035
+ };
8036
+ },
8326
8037
  /**
8327
8038
  * 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.
8328
8039
  * @summary Set Operation Mode
@@ -8339,7 +8050,7 @@ export const VirtualRobotModeApiAxiosParamCreator = function (configuration) {
8339
8050
  assertParamExists('setOperationMode', 'controller', controller);
8340
8051
  // verify required parameter 'mode' is not null or undefined
8341
8052
  assertParamExists('setOperationMode', 'mode', mode);
8342
- const localVarPath = `/cells/{cell}/controllers/{controller}/teach-pendant/operationmode`
8053
+ const localVarPath = `/cells/{cell}/virtual-controllers/{controller}/operationmode`
8343
8054
  .replace(`{${"cell"}}`, encodeURIComponent(String(cell)))
8344
8055
  .replace(`{${"controller"}}`, encodeURIComponent(String(controller)));
8345
8056
  // use dummy base URL string because the URL constructor only accepts absolute URLs.
@@ -8368,55 +8079,227 @@ export const VirtualRobotModeApiAxiosParamCreator = function (configuration) {
8368
8079
  options: localVarRequestOptions,
8369
8080
  };
8370
8081
  },
8082
+ /**
8083
+ * 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.
8084
+ * @summary Set Mounting
8085
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
8086
+ * @param {string} controller Unique identifier to address a controller in the cell.
8087
+ * @param {string} motionGroup The motion-group identifier.
8088
+ * @param {CoordinateSystem} coordinateSystem
8089
+ * @param {*} [options] Override http request option.
8090
+ * @throws {RequiredError}
8091
+ */
8092
+ setVirtualControllerMounting: async (cell, controller, motionGroup, coordinateSystem, options = {}) => {
8093
+ // verify required parameter 'cell' is not null or undefined
8094
+ assertParamExists('setVirtualControllerMounting', 'cell', cell);
8095
+ // verify required parameter 'controller' is not null or undefined
8096
+ assertParamExists('setVirtualControllerMounting', 'controller', controller);
8097
+ // verify required parameter 'motionGroup' is not null or undefined
8098
+ assertParamExists('setVirtualControllerMounting', 'motionGroup', motionGroup);
8099
+ // verify required parameter 'coordinateSystem' is not null or undefined
8100
+ assertParamExists('setVirtualControllerMounting', 'coordinateSystem', coordinateSystem);
8101
+ const localVarPath = `/cells/{cell}/virtual-controllers/{controller}/motion-groups/{motion-group}/mounting`
8102
+ .replace(`{${"cell"}}`, encodeURIComponent(String(cell)))
8103
+ .replace(`{${"controller"}}`, encodeURIComponent(String(controller)))
8104
+ .replace(`{${"motion-group"}}`, encodeURIComponent(String(motionGroup)));
8105
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
8106
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
8107
+ let baseOptions;
8108
+ if (configuration) {
8109
+ baseOptions = configuration.baseOptions;
8110
+ }
8111
+ const localVarRequestOptions = { method: 'PUT', ...baseOptions, ...options };
8112
+ const localVarHeaderParameter = {};
8113
+ const localVarQueryParameter = {};
8114
+ // authentication BasicAuth required
8115
+ // http basic authentication required
8116
+ setBasicAuthToObject(localVarRequestOptions, configuration);
8117
+ // authentication BearerAuth required
8118
+ // http bearer authentication required
8119
+ await setBearerAuthToObject(localVarHeaderParameter, configuration);
8120
+ localVarHeaderParameter['Content-Type'] = 'application/json';
8121
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
8122
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
8123
+ localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
8124
+ localVarRequestOptions.data = serializeDataIfNeeded(coordinateSystem, localVarRequestOptions, configuration);
8125
+ return {
8126
+ url: toPathString(localVarUrlObj),
8127
+ options: localVarRequestOptions,
8128
+ };
8129
+ },
8371
8130
  };
8372
8131
  };
8373
8132
  /**
8374
- * VirtualRobotModeApi - functional programming interface
8133
+ * VirtualControllerApi - functional programming interface
8375
8134
  * @export
8376
8135
  */
8377
- export const VirtualRobotModeApiFp = function (configuration) {
8378
- const localVarAxiosParamCreator = VirtualRobotModeApiAxiosParamCreator(configuration);
8136
+ export const VirtualControllerApiFp = function (configuration) {
8137
+ const localVarAxiosParamCreator = VirtualControllerApiAxiosParamCreator(configuration);
8379
8138
  return {
8380
8139
  /**
8381
- * Get the cycle time of controller communication in [ms].
8382
- * @summary Cycle Time
8140
+ * Adds a coordinate system to the robot controller.
8141
+ * @summary Add Coordinate Systems
8383
8142
  * @param {string} cell Unique identifier addressing a cell in all API calls.
8384
8143
  * @param {string} controller Unique identifier to address a controller in the cell.
8144
+ * @param {string} coordinateSystem Unique identifier addressing a coordinate system.
8145
+ * @param {CoordinateSystemData} coordinateSystemData
8385
8146
  * @param {*} [options] Override http request option.
8386
8147
  * @throws {RequiredError}
8387
8148
  */
8388
- async getCycleTime(cell, controller, options) {
8389
- const localVarAxiosArgs = await localVarAxiosParamCreator.getCycleTime(cell, controller, options);
8149
+ async addVirtualControllerCoordinateSystem(cell, controller, coordinateSystem, coordinateSystemData, options) {
8150
+ const localVarAxiosArgs = await localVarAxiosParamCreator.addVirtualControllerCoordinateSystem(cell, controller, coordinateSystem, coordinateSystemData, options);
8151
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
8152
+ const localVarOperationServerBasePath = operationServerMap['VirtualControllerApi.addVirtualControllerCoordinateSystem']?.[localVarOperationServerIndex]?.url;
8153
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
8154
+ },
8155
+ /**
8156
+ * 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.
8157
+ * @summary Add TCP
8158
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
8159
+ * @param {string} controller Unique identifier to address a controller in the cell.
8160
+ * @param {string} motionGroup The motion-group identifier.
8161
+ * @param {string} tcp The unique identifier of a TCP.
8162
+ * @param {RobotTcpData} robotTcpData
8163
+ * @param {*} [options] Override http request option.
8164
+ * @throws {RequiredError}
8165
+ */
8166
+ async addVirtualControllerTcp(cell, controller, motionGroup, tcp, robotTcpData, options) {
8167
+ const localVarAxiosArgs = await localVarAxiosParamCreator.addVirtualControllerTcp(cell, controller, motionGroup, tcp, robotTcpData, options);
8168
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
8169
+ const localVarOperationServerBasePath = operationServerMap['VirtualControllerApi.addVirtualControllerTcp']?.[localVarOperationServerIndex]?.url;
8170
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
8171
+ },
8172
+ /**
8173
+ * 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.
8174
+ * @summary Remove Coordinate System
8175
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
8176
+ * @param {string} controller Unique identifier to address a controller in the cell.
8177
+ * @param {string} coordinateSystem Unique identifier addressing a coordinate system.
8178
+ * @param {boolean} [deleteDependent] If true, all dependent coordinate systems will be deleted as well.
8179
+ * @param {*} [options] Override http request option.
8180
+ * @throws {RequiredError}
8181
+ */
8182
+ async deleteVirtualControllerCoordinateSystem(cell, controller, coordinateSystem, deleteDependent, options) {
8183
+ const localVarAxiosArgs = await localVarAxiosParamCreator.deleteVirtualControllerCoordinateSystem(cell, controller, coordinateSystem, deleteDependent, options);
8184
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
8185
+ const localVarOperationServerBasePath = operationServerMap['VirtualControllerApi.deleteVirtualControllerCoordinateSystem']?.[localVarOperationServerIndex]?.url;
8186
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
8187
+ },
8188
+ /**
8189
+ * Removes the TCP from the motion group. An unknown TCP is a valid input.
8190
+ * @summary Remove TCP
8191
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
8192
+ * @param {string} controller Unique identifier to address a controller in the cell.
8193
+ * @param {string} motionGroup The motion-group identifier.
8194
+ * @param {string} tcp The unique identifier of a TCP.
8195
+ * @param {*} [options] Override http request option.
8196
+ * @throws {RequiredError}
8197
+ */
8198
+ async deleteVirtualControllerTcp(cell, controller, motionGroup, tcp, options) {
8199
+ const localVarAxiosArgs = await localVarAxiosParamCreator.deleteVirtualControllerTcp(cell, controller, motionGroup, tcp, options);
8200
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
8201
+ const localVarOperationServerBasePath = operationServerMap['VirtualControllerApi.deleteVirtualControllerTcp']?.[localVarOperationServerIndex]?.url;
8202
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
8203
+ },
8204
+ /**
8205
+ * 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.
8206
+ * @summary Get Emergency Stop State
8207
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
8208
+ * @param {string} controller Unique identifier to address a controller in the cell.
8209
+ * @param {*} [options] Override http request option.
8210
+ * @throws {RequiredError}
8211
+ */
8212
+ async getEmergencyStop(cell, controller, options) {
8213
+ const localVarAxiosArgs = await localVarAxiosParamCreator.getEmergencyStop(cell, controller, options);
8214
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
8215
+ const localVarOperationServerBasePath = operationServerMap['VirtualControllerApi.getEmergencyStop']?.[localVarOperationServerIndex]?.url;
8216
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
8217
+ },
8218
+ /**
8219
+ * Get the current motion group state which provides values for the joints\' position, velocity and acceleration.
8220
+ * @summary Get Motion Group State
8221
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
8222
+ * @param {string} controller Unique identifier to address a controller in the cell.
8223
+ * @param {string} motionGroup The motion-group identifier.
8224
+ * @param {*} [options] Override http request option.
8225
+ * @throws {RequiredError}
8226
+ */
8227
+ async getMotionGroupState(cell, controller, motionGroup, options) {
8228
+ const localVarAxiosArgs = await localVarAxiosParamCreator.getMotionGroupState(cell, controller, motionGroup, options);
8229
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
8230
+ const localVarOperationServerBasePath = operationServerMap['VirtualControllerApi.getMotionGroupState']?.[localVarOperationServerIndex]?.url;
8231
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
8232
+ },
8233
+ /**
8234
+ * Gets information on the motion group.
8235
+ * @summary Motion Group Description
8236
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
8237
+ * @param {string} controller Unique identifier to address a controller in the cell.
8238
+ * @param {*} [options] Override http request option.
8239
+ * @throws {RequiredError}
8240
+ */
8241
+ async getMotionGroups(cell, controller, options) {
8242
+ const localVarAxiosArgs = await localVarAxiosParamCreator.getMotionGroups(cell, controller, options);
8243
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
8244
+ const localVarOperationServerBasePath = operationServerMap['VirtualControllerApi.getMotionGroups']?.[localVarOperationServerIndex]?.url;
8245
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
8246
+ },
8247
+ /**
8248
+ * 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.
8249
+ * @summary Get Operation Mode
8250
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
8251
+ * @param {string} controller Unique identifier to address a controller in the cell.
8252
+ * @param {*} [options] Override http request option.
8253
+ * @throws {RequiredError}
8254
+ */
8255
+ async getOperationMode(cell, controller, options) {
8256
+ const localVarAxiosArgs = await localVarAxiosParamCreator.getOperationMode(cell, controller, options);
8257
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
8258
+ const localVarOperationServerBasePath = operationServerMap['VirtualControllerApi.getOperationMode']?.[localVarOperationServerIndex]?.url;
8259
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
8260
+ },
8261
+ /**
8262
+ * Gets motion group mounting. The motion group is based on the origin of the returned coordinate system.
8263
+ * @summary Get Mounting
8264
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
8265
+ * @param {string} controller Unique identifier to address a controller in the cell.
8266
+ * @param {string} motionGroup The motion-group identifier.
8267
+ * @param {*} [options] Override http request option.
8268
+ * @throws {RequiredError}
8269
+ */
8270
+ async getVirtualControllerMounting(cell, controller, motionGroup, options) {
8271
+ const localVarAxiosArgs = await localVarAxiosParamCreator.getVirtualControllerMounting(cell, controller, motionGroup, options);
8390
8272
  const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
8391
- const localVarOperationServerBasePath = operationServerMap['VirtualRobotModeApi.getCycleTime']?.[localVarOperationServerIndex]?.url;
8273
+ const localVarOperationServerBasePath = operationServerMap['VirtualControllerApi.getVirtualControllerMounting']?.[localVarOperationServerIndex]?.url;
8392
8274
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
8393
8275
  },
8394
8276
  /**
8395
- * 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.
8396
- * @summary Get Emergency Stop State
8277
+ * Lists all coordinate systems on the robot controller.
8278
+ * @summary List Coordinate Systems
8397
8279
  * @param {string} cell Unique identifier addressing a cell in all API calls.
8398
8280
  * @param {string} controller Unique identifier to address a controller in the cell.
8399
8281
  * @param {*} [options] Override http request option.
8400
8282
  * @throws {RequiredError}
8401
8283
  */
8402
- async getEmergencyStop(cell, controller, options) {
8403
- const localVarAxiosArgs = await localVarAxiosParamCreator.getEmergencyStop(cell, controller, options);
8284
+ async listVirtualControllerCoordinateSystems(cell, controller, options) {
8285
+ const localVarAxiosArgs = await localVarAxiosParamCreator.listVirtualControllerCoordinateSystems(cell, controller, options);
8404
8286
  const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
8405
- const localVarOperationServerBasePath = operationServerMap['VirtualRobotModeApi.getEmergencyStop']?.[localVarOperationServerIndex]?.url;
8287
+ const localVarOperationServerBasePath = operationServerMap['VirtualControllerApi.listVirtualControllerCoordinateSystems']?.[localVarOperationServerIndex]?.url;
8406
8288
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
8407
8289
  },
8408
8290
  /**
8409
- * 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.
8410
- * @summary Get Operation Mode
8291
+ * Lists TCPs of the motion group. An empty TCP list is valid, for example for external axes.
8292
+ * @summary List TCPs
8411
8293
  * @param {string} cell Unique identifier addressing a cell in all API calls.
8412
8294
  * @param {string} controller Unique identifier to address a controller in the cell.
8295
+ * @param {string} motionGroup The motion-group identifier.
8413
8296
  * @param {*} [options] Override http request option.
8414
8297
  * @throws {RequiredError}
8415
8298
  */
8416
- async getOperationMode(cell, controller, options) {
8417
- const localVarAxiosArgs = await localVarAxiosParamCreator.getOperationMode(cell, controller, options);
8299
+ async listVirtualControllerTcps(cell, controller, motionGroup, options) {
8300
+ const localVarAxiosArgs = await localVarAxiosParamCreator.listVirtualControllerTcps(cell, controller, motionGroup, options);
8418
8301
  const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
8419
- const localVarOperationServerBasePath = operationServerMap['VirtualRobotModeApi.getOperationMode']?.[localVarOperationServerIndex]?.url;
8302
+ const localVarOperationServerBasePath = operationServerMap['VirtualControllerApi.listVirtualControllerTcps']?.[localVarOperationServerIndex]?.url;
8420
8303
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
8421
8304
  },
8422
8305
  /**
@@ -8431,7 +8314,23 @@ export const VirtualRobotModeApiFp = function (configuration) {
8431
8314
  async setEmergencyStop(cell, controller, active, options) {
8432
8315
  const localVarAxiosArgs = await localVarAxiosParamCreator.setEmergencyStop(cell, controller, active, options);
8433
8316
  const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
8434
- const localVarOperationServerBasePath = operationServerMap['VirtualRobotModeApi.setEmergencyStop']?.[localVarOperationServerIndex]?.url;
8317
+ const localVarOperationServerBasePath = operationServerMap['VirtualControllerApi.setEmergencyStop']?.[localVarOperationServerIndex]?.url;
8318
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
8319
+ },
8320
+ /**
8321
+ * 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.
8322
+ * @summary Set Motion Group State
8323
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
8324
+ * @param {string} controller Unique identifier to address a controller in the cell.
8325
+ * @param {string} motionGroup The motion-group identifier.
8326
+ * @param {MotionGroupJoints} motionGroupJoints
8327
+ * @param {*} [options] Override http request option.
8328
+ * @throws {RequiredError}
8329
+ */
8330
+ async setMotionGroupState(cell, controller, motionGroup, motionGroupJoints, options) {
8331
+ const localVarAxiosArgs = await localVarAxiosParamCreator.setMotionGroupState(cell, controller, motionGroup, motionGroupJoints, options);
8332
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
8333
+ const localVarOperationServerBasePath = operationServerMap['VirtualControllerApi.setMotionGroupState']?.[localVarOperationServerIndex]?.url;
8435
8334
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
8436
8335
  },
8437
8336
  /**
@@ -8446,28 +8345,86 @@ export const VirtualRobotModeApiFp = function (configuration) {
8446
8345
  async setOperationMode(cell, controller, mode, options) {
8447
8346
  const localVarAxiosArgs = await localVarAxiosParamCreator.setOperationMode(cell, controller, mode, options);
8448
8347
  const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
8449
- const localVarOperationServerBasePath = operationServerMap['VirtualRobotModeApi.setOperationMode']?.[localVarOperationServerIndex]?.url;
8348
+ const localVarOperationServerBasePath = operationServerMap['VirtualControllerApi.setOperationMode']?.[localVarOperationServerIndex]?.url;
8349
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
8350
+ },
8351
+ /**
8352
+ * 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.
8353
+ * @summary Set Mounting
8354
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
8355
+ * @param {string} controller Unique identifier to address a controller in the cell.
8356
+ * @param {string} motionGroup The motion-group identifier.
8357
+ * @param {CoordinateSystem} coordinateSystem
8358
+ * @param {*} [options] Override http request option.
8359
+ * @throws {RequiredError}
8360
+ */
8361
+ async setVirtualControllerMounting(cell, controller, motionGroup, coordinateSystem, options) {
8362
+ const localVarAxiosArgs = await localVarAxiosParamCreator.setVirtualControllerMounting(cell, controller, motionGroup, coordinateSystem, options);
8363
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
8364
+ const localVarOperationServerBasePath = operationServerMap['VirtualControllerApi.setVirtualControllerMounting']?.[localVarOperationServerIndex]?.url;
8450
8365
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
8451
8366
  },
8452
8367
  };
8453
8368
  };
8454
8369
  /**
8455
- * VirtualRobotModeApi - factory interface
8370
+ * VirtualControllerApi - factory interface
8456
8371
  * @export
8457
8372
  */
8458
- export const VirtualRobotModeApiFactory = function (configuration, basePath, axios) {
8459
- const localVarFp = VirtualRobotModeApiFp(configuration);
8373
+ export const VirtualControllerApiFactory = function (configuration, basePath, axios) {
8374
+ const localVarFp = VirtualControllerApiFp(configuration);
8460
8375
  return {
8461
8376
  /**
8462
- * Get the cycle time of controller communication in [ms].
8463
- * @summary Cycle Time
8377
+ * Adds a coordinate system to the robot controller.
8378
+ * @summary Add Coordinate Systems
8464
8379
  * @param {string} cell Unique identifier addressing a cell in all API calls.
8465
8380
  * @param {string} controller Unique identifier to address a controller in the cell.
8381
+ * @param {string} coordinateSystem Unique identifier addressing a coordinate system.
8382
+ * @param {CoordinateSystemData} coordinateSystemData
8466
8383
  * @param {*} [options] Override http request option.
8467
8384
  * @throws {RequiredError}
8468
8385
  */
8469
- getCycleTime(cell, controller, options) {
8470
- return localVarFp.getCycleTime(cell, controller, options).then((request) => request(axios, basePath));
8386
+ addVirtualControllerCoordinateSystem(cell, controller, coordinateSystem, coordinateSystemData, options) {
8387
+ return localVarFp.addVirtualControllerCoordinateSystem(cell, controller, coordinateSystem, coordinateSystemData, options).then((request) => request(axios, basePath));
8388
+ },
8389
+ /**
8390
+ * 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.
8391
+ * @summary Add TCP
8392
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
8393
+ * @param {string} controller Unique identifier to address a controller in the cell.
8394
+ * @param {string} motionGroup The motion-group identifier.
8395
+ * @param {string} tcp The unique identifier of a TCP.
8396
+ * @param {RobotTcpData} robotTcpData
8397
+ * @param {*} [options] Override http request option.
8398
+ * @throws {RequiredError}
8399
+ */
8400
+ addVirtualControllerTcp(cell, controller, motionGroup, tcp, robotTcpData, options) {
8401
+ return localVarFp.addVirtualControllerTcp(cell, controller, motionGroup, tcp, robotTcpData, options).then((request) => request(axios, basePath));
8402
+ },
8403
+ /**
8404
+ * 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.
8405
+ * @summary Remove Coordinate System
8406
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
8407
+ * @param {string} controller Unique identifier to address a controller in the cell.
8408
+ * @param {string} coordinateSystem Unique identifier addressing a coordinate system.
8409
+ * @param {boolean} [deleteDependent] If true, all dependent coordinate systems will be deleted as well.
8410
+ * @param {*} [options] Override http request option.
8411
+ * @throws {RequiredError}
8412
+ */
8413
+ deleteVirtualControllerCoordinateSystem(cell, controller, coordinateSystem, deleteDependent, options) {
8414
+ return localVarFp.deleteVirtualControllerCoordinateSystem(cell, controller, coordinateSystem, deleteDependent, options).then((request) => request(axios, basePath));
8415
+ },
8416
+ /**
8417
+ * Removes the TCP from the motion group. An unknown TCP is a valid input.
8418
+ * @summary Remove TCP
8419
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
8420
+ * @param {string} controller Unique identifier to address a controller in the cell.
8421
+ * @param {string} motionGroup The motion-group identifier.
8422
+ * @param {string} tcp The unique identifier of a TCP.
8423
+ * @param {*} [options] Override http request option.
8424
+ * @throws {RequiredError}
8425
+ */
8426
+ deleteVirtualControllerTcp(cell, controller, motionGroup, tcp, options) {
8427
+ return localVarFp.deleteVirtualControllerTcp(cell, controller, motionGroup, tcp, options).then((request) => request(axios, basePath));
8471
8428
  },
8472
8429
  /**
8473
8430
  * 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.
@@ -8480,6 +8437,29 @@ export const VirtualRobotModeApiFactory = function (configuration, basePath, axi
8480
8437
  getEmergencyStop(cell, controller, options) {
8481
8438
  return localVarFp.getEmergencyStop(cell, controller, options).then((request) => request(axios, basePath));
8482
8439
  },
8440
+ /**
8441
+ * Get the current motion group state which provides values for the joints\' position, velocity and acceleration.
8442
+ * @summary Get Motion Group State
8443
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
8444
+ * @param {string} controller Unique identifier to address a controller in the cell.
8445
+ * @param {string} motionGroup The motion-group identifier.
8446
+ * @param {*} [options] Override http request option.
8447
+ * @throws {RequiredError}
8448
+ */
8449
+ getMotionGroupState(cell, controller, motionGroup, options) {
8450
+ return localVarFp.getMotionGroupState(cell, controller, motionGroup, options).then((request) => request(axios, basePath));
8451
+ },
8452
+ /**
8453
+ * Gets information on the motion group.
8454
+ * @summary Motion Group Description
8455
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
8456
+ * @param {string} controller Unique identifier to address a controller in the cell.
8457
+ * @param {*} [options] Override http request option.
8458
+ * @throws {RequiredError}
8459
+ */
8460
+ getMotionGroups(cell, controller, options) {
8461
+ return localVarFp.getMotionGroups(cell, controller, options).then((request) => request(axios, basePath));
8462
+ },
8483
8463
  /**
8484
8464
  * 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.
8485
8465
  * @summary Get Operation Mode
@@ -8491,6 +8471,41 @@ export const VirtualRobotModeApiFactory = function (configuration, basePath, axi
8491
8471
  getOperationMode(cell, controller, options) {
8492
8472
  return localVarFp.getOperationMode(cell, controller, options).then((request) => request(axios, basePath));
8493
8473
  },
8474
+ /**
8475
+ * Gets motion group mounting. The motion group is based on the origin of the returned coordinate system.
8476
+ * @summary Get Mounting
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.
8479
+ * @param {string} motionGroup The motion-group identifier.
8480
+ * @param {*} [options] Override http request option.
8481
+ * @throws {RequiredError}
8482
+ */
8483
+ getVirtualControllerMounting(cell, controller, motionGroup, options) {
8484
+ return localVarFp.getVirtualControllerMounting(cell, controller, motionGroup, options).then((request) => request(axios, basePath));
8485
+ },
8486
+ /**
8487
+ * Lists all coordinate systems on the robot controller.
8488
+ * @summary List Coordinate Systems
8489
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
8490
+ * @param {string} controller Unique identifier to address a controller in the cell.
8491
+ * @param {*} [options] Override http request option.
8492
+ * @throws {RequiredError}
8493
+ */
8494
+ listVirtualControllerCoordinateSystems(cell, controller, options) {
8495
+ return localVarFp.listVirtualControllerCoordinateSystems(cell, controller, options).then((request) => request(axios, basePath));
8496
+ },
8497
+ /**
8498
+ * Lists TCPs of the motion group. An empty TCP list is valid, for example for external axes.
8499
+ * @summary List TCPs
8500
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
8501
+ * @param {string} controller Unique identifier to address a controller in the cell.
8502
+ * @param {string} motionGroup The motion-group identifier.
8503
+ * @param {*} [options] Override http request option.
8504
+ * @throws {RequiredError}
8505
+ */
8506
+ listVirtualControllerTcps(cell, controller, motionGroup, options) {
8507
+ return localVarFp.listVirtualControllerTcps(cell, controller, motionGroup, options).then((request) => request(axios, basePath));
8508
+ },
8494
8509
  /**
8495
8510
  * 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.
8496
8511
  * @summary Push or Release Emergency Stop
@@ -8503,6 +8518,19 @@ export const VirtualRobotModeApiFactory = function (configuration, basePath, axi
8503
8518
  setEmergencyStop(cell, controller, active, options) {
8504
8519
  return localVarFp.setEmergencyStop(cell, controller, active, options).then((request) => request(axios, basePath));
8505
8520
  },
8521
+ /**
8522
+ * 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.
8523
+ * @summary Set Motion Group State
8524
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
8525
+ * @param {string} controller Unique identifier to address a controller in the cell.
8526
+ * @param {string} motionGroup The motion-group identifier.
8527
+ * @param {MotionGroupJoints} motionGroupJoints
8528
+ * @param {*} [options] Override http request option.
8529
+ * @throws {RequiredError}
8530
+ */
8531
+ setMotionGroupState(cell, controller, motionGroup, motionGroupJoints, options) {
8532
+ return localVarFp.setMotionGroupState(cell, controller, motionGroup, motionGroupJoints, options).then((request) => request(axios, basePath));
8533
+ },
8506
8534
  /**
8507
8535
  * 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.
8508
8536
  * @summary Set Operation Mode
@@ -8515,26 +8543,84 @@ export const VirtualRobotModeApiFactory = function (configuration, basePath, axi
8515
8543
  setOperationMode(cell, controller, mode, options) {
8516
8544
  return localVarFp.setOperationMode(cell, controller, mode, options).then((request) => request(axios, basePath));
8517
8545
  },
8546
+ /**
8547
+ * 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.
8548
+ * @summary Set Mounting
8549
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
8550
+ * @param {string} controller Unique identifier to address a controller in the cell.
8551
+ * @param {string} motionGroup The motion-group identifier.
8552
+ * @param {CoordinateSystem} coordinateSystem
8553
+ * @param {*} [options] Override http request option.
8554
+ * @throws {RequiredError}
8555
+ */
8556
+ setVirtualControllerMounting(cell, controller, motionGroup, coordinateSystem, options) {
8557
+ return localVarFp.setVirtualControllerMounting(cell, controller, motionGroup, coordinateSystem, options).then((request) => request(axios, basePath));
8558
+ },
8518
8559
  };
8519
8560
  };
8520
8561
  /**
8521
- * VirtualRobotModeApi - object-oriented interface
8562
+ * VirtualControllerApi - object-oriented interface
8522
8563
  * @export
8523
- * @class VirtualRobotModeApi
8564
+ * @class VirtualControllerApi
8524
8565
  * @extends {BaseAPI}
8525
8566
  */
8526
- export class VirtualRobotModeApi extends BaseAPI {
8567
+ export class VirtualControllerApi extends BaseAPI {
8527
8568
  /**
8528
- * Get the cycle time of controller communication in [ms].
8529
- * @summary Cycle Time
8569
+ * Adds a coordinate system to the robot controller.
8570
+ * @summary Add Coordinate Systems
8530
8571
  * @param {string} cell Unique identifier addressing a cell in all API calls.
8531
8572
  * @param {string} controller Unique identifier to address a controller in the cell.
8573
+ * @param {string} coordinateSystem Unique identifier addressing a coordinate system.
8574
+ * @param {CoordinateSystemData} coordinateSystemData
8532
8575
  * @param {*} [options] Override http request option.
8533
8576
  * @throws {RequiredError}
8534
- * @memberof VirtualRobotModeApi
8577
+ * @memberof VirtualControllerApi
8535
8578
  */
8536
- getCycleTime(cell, controller, options) {
8537
- return VirtualRobotModeApiFp(this.configuration).getCycleTime(cell, controller, options).then((request) => request(this.axios, this.basePath));
8579
+ addVirtualControllerCoordinateSystem(cell, controller, coordinateSystem, coordinateSystemData, options) {
8580
+ return VirtualControllerApiFp(this.configuration).addVirtualControllerCoordinateSystem(cell, controller, coordinateSystem, coordinateSystemData, options).then((request) => request(this.axios, this.basePath));
8581
+ }
8582
+ /**
8583
+ * 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.
8584
+ * @summary Add TCP
8585
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
8586
+ * @param {string} controller Unique identifier to address a controller in the cell.
8587
+ * @param {string} motionGroup The motion-group identifier.
8588
+ * @param {string} tcp The unique identifier of a TCP.
8589
+ * @param {RobotTcpData} robotTcpData
8590
+ * @param {*} [options] Override http request option.
8591
+ * @throws {RequiredError}
8592
+ * @memberof VirtualControllerApi
8593
+ */
8594
+ addVirtualControllerTcp(cell, controller, motionGroup, tcp, robotTcpData, options) {
8595
+ return VirtualControllerApiFp(this.configuration).addVirtualControllerTcp(cell, controller, motionGroup, tcp, robotTcpData, options).then((request) => request(this.axios, this.basePath));
8596
+ }
8597
+ /**
8598
+ * 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.
8599
+ * @summary Remove Coordinate System
8600
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
8601
+ * @param {string} controller Unique identifier to address a controller in the cell.
8602
+ * @param {string} coordinateSystem Unique identifier addressing a coordinate system.
8603
+ * @param {boolean} [deleteDependent] If true, all dependent coordinate systems will be deleted as well.
8604
+ * @param {*} [options] Override http request option.
8605
+ * @throws {RequiredError}
8606
+ * @memberof VirtualControllerApi
8607
+ */
8608
+ deleteVirtualControllerCoordinateSystem(cell, controller, coordinateSystem, deleteDependent, options) {
8609
+ return VirtualControllerApiFp(this.configuration).deleteVirtualControllerCoordinateSystem(cell, controller, coordinateSystem, deleteDependent, options).then((request) => request(this.axios, this.basePath));
8610
+ }
8611
+ /**
8612
+ * Removes the TCP from the motion group. An unknown TCP is a valid input.
8613
+ * @summary Remove TCP
8614
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
8615
+ * @param {string} controller Unique identifier to address a controller in the cell.
8616
+ * @param {string} motionGroup The motion-group identifier.
8617
+ * @param {string} tcp The unique identifier of a TCP.
8618
+ * @param {*} [options] Override http request option.
8619
+ * @throws {RequiredError}
8620
+ * @memberof VirtualControllerApi
8621
+ */
8622
+ deleteVirtualControllerTcp(cell, controller, motionGroup, tcp, options) {
8623
+ return VirtualControllerApiFp(this.configuration).deleteVirtualControllerTcp(cell, controller, motionGroup, tcp, options).then((request) => request(this.axios, this.basePath));
8538
8624
  }
8539
8625
  /**
8540
8626
  * 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.
@@ -8543,10 +8629,35 @@ export class VirtualRobotModeApi extends BaseAPI {
8543
8629
  * @param {string} controller Unique identifier to address a controller in the cell.
8544
8630
  * @param {*} [options] Override http request option.
8545
8631
  * @throws {RequiredError}
8546
- * @memberof VirtualRobotModeApi
8632
+ * @memberof VirtualControllerApi
8547
8633
  */
8548
8634
  getEmergencyStop(cell, controller, options) {
8549
- return VirtualRobotModeApiFp(this.configuration).getEmergencyStop(cell, controller, options).then((request) => request(this.axios, this.basePath));
8635
+ return VirtualControllerApiFp(this.configuration).getEmergencyStop(cell, controller, options).then((request) => request(this.axios, this.basePath));
8636
+ }
8637
+ /**
8638
+ * Get the current motion group state which provides values for the joints\' position, velocity and acceleration.
8639
+ * @summary Get Motion Group State
8640
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
8641
+ * @param {string} controller Unique identifier to address a controller in the cell.
8642
+ * @param {string} motionGroup The motion-group identifier.
8643
+ * @param {*} [options] Override http request option.
8644
+ * @throws {RequiredError}
8645
+ * @memberof VirtualControllerApi
8646
+ */
8647
+ getMotionGroupState(cell, controller, motionGroup, options) {
8648
+ return VirtualControllerApiFp(this.configuration).getMotionGroupState(cell, controller, motionGroup, options).then((request) => request(this.axios, this.basePath));
8649
+ }
8650
+ /**
8651
+ * Gets information on the motion group.
8652
+ * @summary Motion Group Description
8653
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
8654
+ * @param {string} controller Unique identifier to address a controller in the cell.
8655
+ * @param {*} [options] Override http request option.
8656
+ * @throws {RequiredError}
8657
+ * @memberof VirtualControllerApi
8658
+ */
8659
+ getMotionGroups(cell, controller, options) {
8660
+ return VirtualControllerApiFp(this.configuration).getMotionGroups(cell, controller, options).then((request) => request(this.axios, this.basePath));
8550
8661
  }
8551
8662
  /**
8552
8663
  * 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.
@@ -8555,10 +8666,48 @@ export class VirtualRobotModeApi extends BaseAPI {
8555
8666
  * @param {string} controller Unique identifier to address a controller in the cell.
8556
8667
  * @param {*} [options] Override http request option.
8557
8668
  * @throws {RequiredError}
8558
- * @memberof VirtualRobotModeApi
8669
+ * @memberof VirtualControllerApi
8559
8670
  */
8560
8671
  getOperationMode(cell, controller, options) {
8561
- return VirtualRobotModeApiFp(this.configuration).getOperationMode(cell, controller, options).then((request) => request(this.axios, this.basePath));
8672
+ return VirtualControllerApiFp(this.configuration).getOperationMode(cell, controller, options).then((request) => request(this.axios, this.basePath));
8673
+ }
8674
+ /**
8675
+ * Gets motion group mounting. The motion group is based on the origin of the returned coordinate system.
8676
+ * @summary Get Mounting
8677
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
8678
+ * @param {string} controller Unique identifier to address a controller in the cell.
8679
+ * @param {string} motionGroup The motion-group identifier.
8680
+ * @param {*} [options] Override http request option.
8681
+ * @throws {RequiredError}
8682
+ * @memberof VirtualControllerApi
8683
+ */
8684
+ getVirtualControllerMounting(cell, controller, motionGroup, options) {
8685
+ return VirtualControllerApiFp(this.configuration).getVirtualControllerMounting(cell, controller, motionGroup, options).then((request) => request(this.axios, this.basePath));
8686
+ }
8687
+ /**
8688
+ * Lists all coordinate systems on the robot controller.
8689
+ * @summary List Coordinate Systems
8690
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
8691
+ * @param {string} controller Unique identifier to address a controller in the cell.
8692
+ * @param {*} [options] Override http request option.
8693
+ * @throws {RequiredError}
8694
+ * @memberof VirtualControllerApi
8695
+ */
8696
+ listVirtualControllerCoordinateSystems(cell, controller, options) {
8697
+ return VirtualControllerApiFp(this.configuration).listVirtualControllerCoordinateSystems(cell, controller, options).then((request) => request(this.axios, this.basePath));
8698
+ }
8699
+ /**
8700
+ * Lists TCPs of the motion group. An empty TCP list is valid, for example for external axes.
8701
+ * @summary List TCPs
8702
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
8703
+ * @param {string} controller Unique identifier to address a controller in the cell.
8704
+ * @param {string} motionGroup The motion-group identifier.
8705
+ * @param {*} [options] Override http request option.
8706
+ * @throws {RequiredError}
8707
+ * @memberof VirtualControllerApi
8708
+ */
8709
+ listVirtualControllerTcps(cell, controller, motionGroup, options) {
8710
+ return VirtualControllerApiFp(this.configuration).listVirtualControllerTcps(cell, controller, motionGroup, options).then((request) => request(this.axios, this.basePath));
8562
8711
  }
8563
8712
  /**
8564
8713
  * 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.
@@ -8568,10 +8717,24 @@ export class VirtualRobotModeApi extends BaseAPI {
8568
8717
  * @param {boolean} [active]
8569
8718
  * @param {*} [options] Override http request option.
8570
8719
  * @throws {RequiredError}
8571
- * @memberof VirtualRobotModeApi
8720
+ * @memberof VirtualControllerApi
8721
+ */
8722
+ setEmergencyStop(cell, controller, active, options) {
8723
+ return VirtualControllerApiFp(this.configuration).setEmergencyStop(cell, controller, active, options).then((request) => request(this.axios, this.basePath));
8724
+ }
8725
+ /**
8726
+ * 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.
8727
+ * @summary Set Motion Group State
8728
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
8729
+ * @param {string} controller Unique identifier to address a controller in the cell.
8730
+ * @param {string} motionGroup The motion-group identifier.
8731
+ * @param {MotionGroupJoints} motionGroupJoints
8732
+ * @param {*} [options] Override http request option.
8733
+ * @throws {RequiredError}
8734
+ * @memberof VirtualControllerApi
8572
8735
  */
8573
- setEmergencyStop(cell, controller, active, options) {
8574
- return VirtualRobotModeApiFp(this.configuration).setEmergencyStop(cell, controller, active, options).then((request) => request(this.axios, this.basePath));
8736
+ setMotionGroupState(cell, controller, motionGroup, motionGroupJoints, options) {
8737
+ return VirtualControllerApiFp(this.configuration).setMotionGroupState(cell, controller, motionGroup, motionGroupJoints, options).then((request) => request(this.axios, this.basePath));
8575
8738
  }
8576
8739
  /**
8577
8740
  * 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.
@@ -8581,35 +8744,49 @@ export class VirtualRobotModeApi extends BaseAPI {
8581
8744
  * @param {OperationMode} mode
8582
8745
  * @param {*} [options] Override http request option.
8583
8746
  * @throws {RequiredError}
8584
- * @memberof VirtualRobotModeApi
8747
+ * @memberof VirtualControllerApi
8585
8748
  */
8586
8749
  setOperationMode(cell, controller, mode, options) {
8587
- return VirtualRobotModeApiFp(this.configuration).setOperationMode(cell, controller, mode, options).then((request) => request(this.axios, this.basePath));
8750
+ return VirtualControllerApiFp(this.configuration).setOperationMode(cell, controller, mode, options).then((request) => request(this.axios, this.basePath));
8751
+ }
8752
+ /**
8753
+ * 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.
8754
+ * @summary Set Mounting
8755
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
8756
+ * @param {string} controller Unique identifier to address a controller in the cell.
8757
+ * @param {string} motionGroup The motion-group identifier.
8758
+ * @param {CoordinateSystem} coordinateSystem
8759
+ * @param {*} [options] Override http request option.
8760
+ * @throws {RequiredError}
8761
+ * @memberof VirtualControllerApi
8762
+ */
8763
+ setVirtualControllerMounting(cell, controller, motionGroup, coordinateSystem, options) {
8764
+ return VirtualControllerApiFp(this.configuration).setVirtualControllerMounting(cell, controller, motionGroup, coordinateSystem, options).then((request) => request(this.axios, this.basePath));
8588
8765
  }
8589
8766
  }
8590
8767
  /**
8591
- * VirtualRobotSetupApi - axios parameter creator
8768
+ * VirtualControllerBehaviorApi - axios parameter creator
8592
8769
  * @export
8593
8770
  */
8594
- export const VirtualRobotSetupApiAxiosParamCreator = function (configuration) {
8771
+ export const VirtualControllerBehaviorApiAxiosParamCreator = function (configuration) {
8595
8772
  return {
8596
8773
  /**
8597
- * Adds a coordinate system to the robot controller.
8598
- * @summary Add Coordinate Systems
8774
+ * <!-- 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.
8775
+ * @summary Stream Joint Configuration
8599
8776
  * @param {string} cell Unique identifier addressing a cell in all API calls.
8600
8777
  * @param {string} controller Unique identifier to address a controller in the cell.
8601
- * @param {CoordinateSystem} coordinateSystem
8778
+ * @param {ExternalJointStreamRequest} externalJointStreamRequest
8602
8779
  * @param {*} [options] Override http request option.
8603
8780
  * @throws {RequiredError}
8604
8781
  */
8605
- addVirtualRobotCoordinateSystem: async (cell, controller, coordinateSystem, options = {}) => {
8782
+ externalJointsStream: async (cell, controller, externalJointStreamRequest, options = {}) => {
8606
8783
  // verify required parameter 'cell' is not null or undefined
8607
- assertParamExists('addVirtualRobotCoordinateSystem', 'cell', cell);
8784
+ assertParamExists('externalJointsStream', 'cell', cell);
8608
8785
  // verify required parameter 'controller' is not null or undefined
8609
- assertParamExists('addVirtualRobotCoordinateSystem', 'controller', controller);
8610
- // verify required parameter 'coordinateSystem' is not null or undefined
8611
- assertParamExists('addVirtualRobotCoordinateSystem', 'coordinateSystem', coordinateSystem);
8612
- const localVarPath = `/cells/{cell}/controllers/{controller}/teach-pendant/coordinate-systems`
8786
+ assertParamExists('externalJointsStream', 'controller', controller);
8787
+ // verify required parameter 'externalJointStreamRequest' is not null or undefined
8788
+ assertParamExists('externalJointsStream', 'externalJointStreamRequest', externalJointStreamRequest);
8789
+ const localVarPath = `/cells/{cell}/virtual-controllers/{controller}/external-joints-stream`
8613
8790
  .replace(`{${"cell"}}`, encodeURIComponent(String(cell)))
8614
8791
  .replace(`{${"controller"}}`, encodeURIComponent(String(controller)));
8615
8792
  // use dummy base URL string because the URL constructor only accepts absolute URLs.
@@ -8618,7 +8795,7 @@ export const VirtualRobotSetupApiAxiosParamCreator = function (configuration) {
8618
8795
  if (configuration) {
8619
8796
  baseOptions = configuration.baseOptions;
8620
8797
  }
8621
- const localVarRequestOptions = { method: 'PUT', ...baseOptions, ...options };
8798
+ const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options };
8622
8799
  const localVarHeaderParameter = {};
8623
8800
  const localVarQueryParameter = {};
8624
8801
  // authentication BasicAuth required
@@ -8631,42 +8808,35 @@ export const VirtualRobotSetupApiAxiosParamCreator = function (configuration) {
8631
8808
  setSearchParams(localVarUrlObj, localVarQueryParameter);
8632
8809
  let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
8633
8810
  localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
8634
- localVarRequestOptions.data = serializeDataIfNeeded(coordinateSystem, localVarRequestOptions, configuration);
8811
+ localVarRequestOptions.data = serializeDataIfNeeded(externalJointStreamRequest, localVarRequestOptions, configuration);
8635
8812
  return {
8636
8813
  url: toPathString(localVarUrlObj),
8637
8814
  options: localVarRequestOptions,
8638
8815
  };
8639
8816
  },
8640
8817
  /**
8641
- * 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.
8642
- * @summary Add TCP
8818
+ * Get the cycle time of controller communication in [ms].
8819
+ * @summary Get Cycle Time
8643
8820
  * @param {string} cell Unique identifier addressing a cell in all API calls.
8644
8821
  * @param {string} controller Unique identifier to address a controller in the cell.
8645
- * @param {string} motionGroup The motion-group identifier.
8646
- * @param {RobotTcp} robotTcp
8647
8822
  * @param {*} [options] Override http request option.
8648
8823
  * @throws {RequiredError}
8649
8824
  */
8650
- addVirtualRobotTcp: async (cell, controller, motionGroup, robotTcp, options = {}) => {
8825
+ getCycleTime: async (cell, controller, options = {}) => {
8651
8826
  // verify required parameter 'cell' is not null or undefined
8652
- assertParamExists('addVirtualRobotTcp', 'cell', cell);
8827
+ assertParamExists('getCycleTime', 'cell', cell);
8653
8828
  // verify required parameter 'controller' is not null or undefined
8654
- assertParamExists('addVirtualRobotTcp', 'controller', controller);
8655
- // verify required parameter 'motionGroup' is not null or undefined
8656
- assertParamExists('addVirtualRobotTcp', 'motionGroup', motionGroup);
8657
- // verify required parameter 'robotTcp' is not null or undefined
8658
- assertParamExists('addVirtualRobotTcp', 'robotTcp', robotTcp);
8659
- const localVarPath = `/cells/{cell}/controllers/{controller}/teach-pendant/motion-groups/{motion-group}/tcps`
8829
+ assertParamExists('getCycleTime', 'controller', controller);
8830
+ const localVarPath = `/cells/{cell}/virtual-controllers/{controller}/cycle-time`
8660
8831
  .replace(`{${"cell"}}`, encodeURIComponent(String(cell)))
8661
- .replace(`{${"controller"}}`, encodeURIComponent(String(controller)))
8662
- .replace(`{${"motion-group"}}`, encodeURIComponent(String(motionGroup)));
8832
+ .replace(`{${"controller"}}`, encodeURIComponent(String(controller)));
8663
8833
  // use dummy base URL string because the URL constructor only accepts absolute URLs.
8664
8834
  const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
8665
8835
  let baseOptions;
8666
8836
  if (configuration) {
8667
8837
  baseOptions = configuration.baseOptions;
8668
8838
  }
8669
- const localVarRequestOptions = { method: 'PUT', ...baseOptions, ...options };
8839
+ const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options };
8670
8840
  const localVarHeaderParameter = {};
8671
8841
  const localVarQueryParameter = {};
8672
8842
  // authentication BasicAuth required
@@ -8675,44 +8845,37 @@ export const VirtualRobotSetupApiAxiosParamCreator = function (configuration) {
8675
8845
  // authentication BearerAuth required
8676
8846
  // http bearer authentication required
8677
8847
  await setBearerAuthToObject(localVarHeaderParameter, configuration);
8678
- localVarHeaderParameter['Content-Type'] = 'application/json';
8679
8848
  setSearchParams(localVarUrlObj, localVarQueryParameter);
8680
8849
  let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
8681
8850
  localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
8682
- localVarRequestOptions.data = serializeDataIfNeeded(robotTcp, localVarRequestOptions, configuration);
8683
8851
  return {
8684
8852
  url: toPathString(localVarUrlObj),
8685
8853
  options: localVarRequestOptions,
8686
8854
  };
8687
8855
  },
8688
8856
  /**
8689
- * 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.
8690
- * @summary Remove Coordinate System
8857
+ * Get the current virtual controller behavior - please see the setter [setVirtualControllerBehavior](setVirtualControllerBehavior) and the enum for details.
8858
+ * @summary Get Behavior
8691
8859
  * @param {string} cell Unique identifier addressing a cell in all API calls.
8692
8860
  * @param {string} controller Unique identifier to address a controller in the cell.
8693
- * @param {string} coordinateSystem Unique identifier addressing a coordinate system.
8694
- * @param {boolean} [deleteDependent] If true, all dependent coordinate systems will be deleted as well.
8695
8861
  * @param {*} [options] Override http request option.
8696
8862
  * @throws {RequiredError}
8697
8863
  */
8698
- deleteVirtualRobotCoordinateSystem: async (cell, controller, coordinateSystem, deleteDependent, options = {}) => {
8864
+ getVirtualControllerBehavior: async (cell, controller, options = {}) => {
8699
8865
  // verify required parameter 'cell' is not null or undefined
8700
- assertParamExists('deleteVirtualRobotCoordinateSystem', 'cell', cell);
8866
+ assertParamExists('getVirtualControllerBehavior', 'cell', cell);
8701
8867
  // verify required parameter 'controller' is not null or undefined
8702
- assertParamExists('deleteVirtualRobotCoordinateSystem', 'controller', controller);
8703
- // verify required parameter 'coordinateSystem' is not null or undefined
8704
- assertParamExists('deleteVirtualRobotCoordinateSystem', 'coordinateSystem', coordinateSystem);
8705
- const localVarPath = `/cells/{cell}/controllers/{controller}/teach-pendant/coordinate-systems/{coordinate-system}`
8868
+ assertParamExists('getVirtualControllerBehavior', 'controller', controller);
8869
+ const localVarPath = `/cells/{cell}/virtual-controllers/{controller}/behavior`
8706
8870
  .replace(`{${"cell"}}`, encodeURIComponent(String(cell)))
8707
- .replace(`{${"controller"}}`, encodeURIComponent(String(controller)))
8708
- .replace(`{${"coordinate-system"}}`, encodeURIComponent(String(coordinateSystem)));
8871
+ .replace(`{${"controller"}}`, encodeURIComponent(String(controller)));
8709
8872
  // use dummy base URL string because the URL constructor only accepts absolute URLs.
8710
8873
  const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
8711
8874
  let baseOptions;
8712
8875
  if (configuration) {
8713
8876
  baseOptions = configuration.baseOptions;
8714
8877
  }
8715
- const localVarRequestOptions = { method: 'DELETE', ...baseOptions, ...options };
8878
+ const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options };
8716
8879
  const localVarHeaderParameter = {};
8717
8880
  const localVarQueryParameter = {};
8718
8881
  // authentication BasicAuth required
@@ -8721,9 +8884,6 @@ export const VirtualRobotSetupApiAxiosParamCreator = function (configuration) {
8721
8884
  // authentication BearerAuth required
8722
8885
  // http bearer authentication required
8723
8886
  await setBearerAuthToObject(localVarHeaderParameter, configuration);
8724
- if (deleteDependent !== undefined) {
8725
- localVarQueryParameter['delete_dependent'] = deleteDependent;
8726
- }
8727
8887
  setSearchParams(localVarUrlObj, localVarQueryParameter);
8728
8888
  let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
8729
8889
  localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
@@ -8733,36 +8893,29 @@ export const VirtualRobotSetupApiAxiosParamCreator = function (configuration) {
8733
8893
  };
8734
8894
  },
8735
8895
  /**
8736
- * Removes the TCP from the motion group. An unknown TCP is a valid input.
8737
- * @summary Remove TCP
8896
+ * Set virtual controller behavior.
8897
+ * @summary Set Behavior
8738
8898
  * @param {string} cell Unique identifier addressing a cell in all API calls.
8739
8899
  * @param {string} controller Unique identifier to address a controller in the cell.
8740
- * @param {string} motionGroup The motion-group identifier.
8741
- * @param {string} tcp The unique identifier of a TCP.
8900
+ * @param {Behavior} [behavior]
8742
8901
  * @param {*} [options] Override http request option.
8743
8902
  * @throws {RequiredError}
8744
8903
  */
8745
- deleteVirtualRobotTcp: async (cell, controller, motionGroup, tcp, options = {}) => {
8904
+ setVirtualControllerBehavior: async (cell, controller, behavior, options = {}) => {
8746
8905
  // verify required parameter 'cell' is not null or undefined
8747
- assertParamExists('deleteVirtualRobotTcp', 'cell', cell);
8906
+ assertParamExists('setVirtualControllerBehavior', 'cell', cell);
8748
8907
  // verify required parameter 'controller' is not null or undefined
8749
- assertParamExists('deleteVirtualRobotTcp', 'controller', controller);
8750
- // verify required parameter 'motionGroup' is not null or undefined
8751
- assertParamExists('deleteVirtualRobotTcp', 'motionGroup', motionGroup);
8752
- // verify required parameter 'tcp' is not null or undefined
8753
- assertParamExists('deleteVirtualRobotTcp', 'tcp', tcp);
8754
- const localVarPath = `/cells/{cell}/controllers/{controller}/teach-pendant/motion-groups/{motion-group}/tcps/{tcp}`
8908
+ assertParamExists('setVirtualControllerBehavior', 'controller', controller);
8909
+ const localVarPath = `/cells/{cell}/virtual-controllers/{controller}/behavior`
8755
8910
  .replace(`{${"cell"}}`, encodeURIComponent(String(cell)))
8756
- .replace(`{${"controller"}}`, encodeURIComponent(String(controller)))
8757
- .replace(`{${"motion-group"}}`, encodeURIComponent(String(motionGroup)))
8758
- .replace(`{${"tcp"}}`, encodeURIComponent(String(tcp)));
8911
+ .replace(`{${"controller"}}`, encodeURIComponent(String(controller)));
8759
8912
  // use dummy base URL string because the URL constructor only accepts absolute URLs.
8760
8913
  const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
8761
8914
  let baseOptions;
8762
8915
  if (configuration) {
8763
8916
  baseOptions = configuration.baseOptions;
8764
8917
  }
8765
- const localVarRequestOptions = { method: 'DELETE', ...baseOptions, ...options };
8918
+ const localVarRequestOptions = { method: 'PUT', ...baseOptions, ...options };
8766
8919
  const localVarHeaderParameter = {};
8767
8920
  const localVarQueryParameter = {};
8768
8921
  // authentication BasicAuth required
@@ -8771,6 +8924,9 @@ export const VirtualRobotSetupApiAxiosParamCreator = function (configuration) {
8771
8924
  // authentication BearerAuth required
8772
8925
  // http bearer authentication required
8773
8926
  await setBearerAuthToObject(localVarHeaderParameter, configuration);
8927
+ if (behavior !== undefined) {
8928
+ localVarQueryParameter['behavior'] = behavior;
8929
+ }
8774
8930
  setSearchParams(localVarUrlObj, localVarQueryParameter);
8775
8931
  let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
8776
8932
  localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
@@ -8779,63 +8935,211 @@ export const VirtualRobotSetupApiAxiosParamCreator = function (configuration) {
8779
8935
  options: localVarRequestOptions,
8780
8936
  };
8781
8937
  },
8938
+ };
8939
+ };
8940
+ /**
8941
+ * VirtualControllerBehaviorApi - functional programming interface
8942
+ * @export
8943
+ */
8944
+ export const VirtualControllerBehaviorApiFp = function (configuration) {
8945
+ const localVarAxiosParamCreator = VirtualControllerBehaviorApiAxiosParamCreator(configuration);
8946
+ return {
8782
8947
  /**
8783
- * Gets motion group mounting. The motion group is based on the origin of the returned coordinate system.
8784
- * @summary Get Mounting
8948
+ * <!-- 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.
8949
+ * @summary Stream Joint Configuration
8785
8950
  * @param {string} cell Unique identifier addressing a cell in all API calls.
8786
8951
  * @param {string} controller Unique identifier to address a controller in the cell.
8787
- * @param {string} motionGroup The motion-group identifier.
8952
+ * @param {ExternalJointStreamRequest} externalJointStreamRequest
8788
8953
  * @param {*} [options] Override http request option.
8789
8954
  * @throws {RequiredError}
8790
8955
  */
8791
- getVirtualRobotMounting: async (cell, controller, motionGroup, options = {}) => {
8792
- // verify required parameter 'cell' is not null or undefined
8793
- assertParamExists('getVirtualRobotMounting', 'cell', cell);
8794
- // verify required parameter 'controller' is not null or undefined
8795
- assertParamExists('getVirtualRobotMounting', 'controller', controller);
8796
- // verify required parameter 'motionGroup' is not null or undefined
8797
- assertParamExists('getVirtualRobotMounting', 'motionGroup', motionGroup);
8798
- const localVarPath = `/cells/{cell}/controllers/{controller}/teach-pendant/motion-groups/{motion-group}/mounting`
8799
- .replace(`{${"cell"}}`, encodeURIComponent(String(cell)))
8800
- .replace(`{${"controller"}}`, encodeURIComponent(String(controller)))
8801
- .replace(`{${"motion-group"}}`, encodeURIComponent(String(motionGroup)));
8802
- // use dummy base URL string because the URL constructor only accepts absolute URLs.
8803
- const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
8804
- let baseOptions;
8805
- if (configuration) {
8806
- baseOptions = configuration.baseOptions;
8807
- }
8808
- const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options };
8809
- const localVarHeaderParameter = {};
8810
- const localVarQueryParameter = {};
8811
- // authentication BasicAuth required
8812
- // http basic authentication required
8813
- setBasicAuthToObject(localVarRequestOptions, configuration);
8814
- // authentication BearerAuth required
8815
- // http bearer authentication required
8816
- await setBearerAuthToObject(localVarHeaderParameter, configuration);
8817
- setSearchParams(localVarUrlObj, localVarQueryParameter);
8818
- let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
8819
- localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
8820
- return {
8821
- url: toPathString(localVarUrlObj),
8822
- options: localVarRequestOptions,
8823
- };
8956
+ async externalJointsStream(cell, controller, externalJointStreamRequest, options) {
8957
+ const localVarAxiosArgs = await localVarAxiosParamCreator.externalJointsStream(cell, controller, externalJointStreamRequest, options);
8958
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
8959
+ const localVarOperationServerBasePath = operationServerMap['VirtualControllerBehaviorApi.externalJointsStream']?.[localVarOperationServerIndex]?.url;
8960
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
8824
8961
  },
8825
8962
  /**
8826
- * Lists all coordinate systems on the robot controller.
8827
- * @summary List Coordinate Systems
8963
+ * Get the cycle time of controller communication in [ms].
8964
+ * @summary Get Cycle Time
8965
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
8966
+ * @param {string} controller Unique identifier to address a controller in the cell.
8967
+ * @param {*} [options] Override http request option.
8968
+ * @throws {RequiredError}
8969
+ */
8970
+ async getCycleTime(cell, controller, options) {
8971
+ const localVarAxiosArgs = await localVarAxiosParamCreator.getCycleTime(cell, controller, options);
8972
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
8973
+ const localVarOperationServerBasePath = operationServerMap['VirtualControllerBehaviorApi.getCycleTime']?.[localVarOperationServerIndex]?.url;
8974
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
8975
+ },
8976
+ /**
8977
+ * Get the current virtual controller behavior - please see the setter [setVirtualControllerBehavior](setVirtualControllerBehavior) and the enum for details.
8978
+ * @summary Get Behavior
8979
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
8980
+ * @param {string} controller Unique identifier to address a controller in the cell.
8981
+ * @param {*} [options] Override http request option.
8982
+ * @throws {RequiredError}
8983
+ */
8984
+ async getVirtualControllerBehavior(cell, controller, options) {
8985
+ const localVarAxiosArgs = await localVarAxiosParamCreator.getVirtualControllerBehavior(cell, controller, options);
8986
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
8987
+ const localVarOperationServerBasePath = operationServerMap['VirtualControllerBehaviorApi.getVirtualControllerBehavior']?.[localVarOperationServerIndex]?.url;
8988
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
8989
+ },
8990
+ /**
8991
+ * Set virtual controller behavior.
8992
+ * @summary Set Behavior
8993
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
8994
+ * @param {string} controller Unique identifier to address a controller in the cell.
8995
+ * @param {Behavior} [behavior]
8996
+ * @param {*} [options] Override http request option.
8997
+ * @throws {RequiredError}
8998
+ */
8999
+ async setVirtualControllerBehavior(cell, controller, behavior, options) {
9000
+ const localVarAxiosArgs = await localVarAxiosParamCreator.setVirtualControllerBehavior(cell, controller, behavior, options);
9001
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
9002
+ const localVarOperationServerBasePath = operationServerMap['VirtualControllerBehaviorApi.setVirtualControllerBehavior']?.[localVarOperationServerIndex]?.url;
9003
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
9004
+ },
9005
+ };
9006
+ };
9007
+ /**
9008
+ * VirtualControllerBehaviorApi - factory interface
9009
+ * @export
9010
+ */
9011
+ export const VirtualControllerBehaviorApiFactory = function (configuration, basePath, axios) {
9012
+ const localVarFp = VirtualControllerBehaviorApiFp(configuration);
9013
+ return {
9014
+ /**
9015
+ * <!-- 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.
9016
+ * @summary Stream Joint Configuration
9017
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
9018
+ * @param {string} controller Unique identifier to address a controller in the cell.
9019
+ * @param {ExternalJointStreamRequest} externalJointStreamRequest
9020
+ * @param {*} [options] Override http request option.
9021
+ * @throws {RequiredError}
9022
+ */
9023
+ externalJointsStream(cell, controller, externalJointStreamRequest, options) {
9024
+ return localVarFp.externalJointsStream(cell, controller, externalJointStreamRequest, options).then((request) => request(axios, basePath));
9025
+ },
9026
+ /**
9027
+ * Get the cycle time of controller communication in [ms].
9028
+ * @summary Get Cycle Time
9029
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
9030
+ * @param {string} controller Unique identifier to address a controller in the cell.
9031
+ * @param {*} [options] Override http request option.
9032
+ * @throws {RequiredError}
9033
+ */
9034
+ getCycleTime(cell, controller, options) {
9035
+ return localVarFp.getCycleTime(cell, controller, options).then((request) => request(axios, basePath));
9036
+ },
9037
+ /**
9038
+ * Get the current virtual controller behavior - please see the setter [setVirtualControllerBehavior](setVirtualControllerBehavior) and the enum for details.
9039
+ * @summary Get Behavior
9040
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
9041
+ * @param {string} controller Unique identifier to address a controller in the cell.
9042
+ * @param {*} [options] Override http request option.
9043
+ * @throws {RequiredError}
9044
+ */
9045
+ getVirtualControllerBehavior(cell, controller, options) {
9046
+ return localVarFp.getVirtualControllerBehavior(cell, controller, options).then((request) => request(axios, basePath));
9047
+ },
9048
+ /**
9049
+ * Set virtual controller behavior.
9050
+ * @summary Set Behavior
9051
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
9052
+ * @param {string} controller Unique identifier to address a controller in the cell.
9053
+ * @param {Behavior} [behavior]
9054
+ * @param {*} [options] Override http request option.
9055
+ * @throws {RequiredError}
9056
+ */
9057
+ setVirtualControllerBehavior(cell, controller, behavior, options) {
9058
+ return localVarFp.setVirtualControllerBehavior(cell, controller, behavior, options).then((request) => request(axios, basePath));
9059
+ },
9060
+ };
9061
+ };
9062
+ /**
9063
+ * VirtualControllerBehaviorApi - object-oriented interface
9064
+ * @export
9065
+ * @class VirtualControllerBehaviorApi
9066
+ * @extends {BaseAPI}
9067
+ */
9068
+ export class VirtualControllerBehaviorApi extends BaseAPI {
9069
+ /**
9070
+ * <!-- 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.
9071
+ * @summary Stream Joint Configuration
9072
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
9073
+ * @param {string} controller Unique identifier to address a controller in the cell.
9074
+ * @param {ExternalJointStreamRequest} externalJointStreamRequest
9075
+ * @param {*} [options] Override http request option.
9076
+ * @throws {RequiredError}
9077
+ * @memberof VirtualControllerBehaviorApi
9078
+ */
9079
+ externalJointsStream(cell, controller, externalJointStreamRequest, options) {
9080
+ return VirtualControllerBehaviorApiFp(this.configuration).externalJointsStream(cell, controller, externalJointStreamRequest, options).then((request) => request(this.axios, this.basePath));
9081
+ }
9082
+ /**
9083
+ * Get the cycle time of controller communication in [ms].
9084
+ * @summary Get Cycle Time
9085
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
9086
+ * @param {string} controller Unique identifier to address a controller in the cell.
9087
+ * @param {*} [options] Override http request option.
9088
+ * @throws {RequiredError}
9089
+ * @memberof VirtualControllerBehaviorApi
9090
+ */
9091
+ getCycleTime(cell, controller, options) {
9092
+ return VirtualControllerBehaviorApiFp(this.configuration).getCycleTime(cell, controller, options).then((request) => request(this.axios, this.basePath));
9093
+ }
9094
+ /**
9095
+ * Get the current virtual controller behavior - please see the setter [setVirtualControllerBehavior](setVirtualControllerBehavior) and the enum for details.
9096
+ * @summary Get Behavior
9097
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
9098
+ * @param {string} controller Unique identifier to address a controller in the cell.
9099
+ * @param {*} [options] Override http request option.
9100
+ * @throws {RequiredError}
9101
+ * @memberof VirtualControllerBehaviorApi
9102
+ */
9103
+ getVirtualControllerBehavior(cell, controller, options) {
9104
+ return VirtualControllerBehaviorApiFp(this.configuration).getVirtualControllerBehavior(cell, controller, options).then((request) => request(this.axios, this.basePath));
9105
+ }
9106
+ /**
9107
+ * Set virtual controller behavior.
9108
+ * @summary Set Behavior
9109
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
9110
+ * @param {string} controller Unique identifier to address a controller in the cell.
9111
+ * @param {Behavior} [behavior]
9112
+ * @param {*} [options] Override http request option.
9113
+ * @throws {RequiredError}
9114
+ * @memberof VirtualControllerBehaviorApi
9115
+ */
9116
+ setVirtualControllerBehavior(cell, controller, behavior, options) {
9117
+ return VirtualControllerBehaviorApiFp(this.configuration).setVirtualControllerBehavior(cell, controller, behavior, options).then((request) => request(this.axios, this.basePath));
9118
+ }
9119
+ }
9120
+ /**
9121
+ * VirtualControllerInputsOutputsApi - axios parameter creator
9122
+ * @export
9123
+ */
9124
+ export const VirtualControllerInputsOutputsApiAxiosParamCreator = function (configuration) {
9125
+ return {
9126
+ /**
9127
+ * 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 [listVirtualControllerIODescriptions](listVirtualControllerIODescriptions).
9128
+ * @summary Get Input/Output Values
8828
9129
  * @param {string} cell Unique identifier addressing a cell in all API calls.
8829
9130
  * @param {string} controller Unique identifier to address a controller in the cell.
9131
+ * @param {Array<string>} ios
8830
9132
  * @param {*} [options] Override http request option.
8831
9133
  * @throws {RequiredError}
8832
9134
  */
8833
- listVirtualRobotCoordinateSystems: async (cell, controller, options = {}) => {
9135
+ listIOs: async (cell, controller, ios, options = {}) => {
8834
9136
  // verify required parameter 'cell' is not null or undefined
8835
- assertParamExists('listVirtualRobotCoordinateSystems', 'cell', cell);
9137
+ assertParamExists('listIOs', 'cell', cell);
8836
9138
  // verify required parameter 'controller' is not null or undefined
8837
- assertParamExists('listVirtualRobotCoordinateSystems', 'controller', controller);
8838
- const localVarPath = `/cells/{cell}/controllers/{controller}/teach-pendant/coordinate-systems`
9139
+ assertParamExists('listIOs', 'controller', controller);
9140
+ // verify required parameter 'ios' is not null or undefined
9141
+ assertParamExists('listIOs', 'ios', ios);
9142
+ const localVarPath = `/cells/{cell}/virtual-controllers/{controller}/ios/values`
8839
9143
  .replace(`{${"cell"}}`, encodeURIComponent(String(cell)))
8840
9144
  .replace(`{${"controller"}}`, encodeURIComponent(String(controller)));
8841
9145
  // use dummy base URL string because the URL constructor only accepts absolute URLs.
@@ -8853,6 +9157,9 @@ export const VirtualRobotSetupApiAxiosParamCreator = function (configuration) {
8853
9157
  // authentication BearerAuth required
8854
9158
  // http bearer authentication required
8855
9159
  await setBearerAuthToObject(localVarHeaderParameter, configuration);
9160
+ if (ios) {
9161
+ localVarQueryParameter['ios'] = ios;
9162
+ }
8856
9163
  setSearchParams(localVarUrlObj, localVarQueryParameter);
8857
9164
  let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
8858
9165
  localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
@@ -8862,25 +9169,25 @@ export const VirtualRobotSetupApiAxiosParamCreator = function (configuration) {
8862
9169
  };
8863
9170
  },
8864
9171
  /**
8865
- * Lists TCPs of the motion group. An empty TCP list is valid, for example for external axes.
8866
- * @summary List TCPs
9172
+ * 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.
9173
+ * @summary List Descriptions
8867
9174
  * @param {string} cell Unique identifier addressing a cell in all API calls.
8868
9175
  * @param {string} controller Unique identifier to address a controller in the cell.
8869
- * @param {string} motionGroup The motion-group identifier.
9176
+ * @param {Array<string>} [ios]
9177
+ * @param {IODirection} [direction] Return only inputs/outputs with the specified direction.
9178
+ * @param {IOValueType} [valueType] Return only inputs/outputs with the specified value type.
9179
+ * @param {string} [group] Return only inputs/outputs from the specified group.
8870
9180
  * @param {*} [options] Override http request option.
8871
9181
  * @throws {RequiredError}
8872
9182
  */
8873
- listVirtualRobotTcps: async (cell, controller, motionGroup, options = {}) => {
9183
+ listVirtualControllerIODescriptions: async (cell, controller, ios, direction, valueType, group, options = {}) => {
8874
9184
  // verify required parameter 'cell' is not null or undefined
8875
- assertParamExists('listVirtualRobotTcps', 'cell', cell);
9185
+ assertParamExists('listVirtualControllerIODescriptions', 'cell', cell);
8876
9186
  // verify required parameter 'controller' is not null or undefined
8877
- assertParamExists('listVirtualRobotTcps', 'controller', controller);
8878
- // verify required parameter 'motionGroup' is not null or undefined
8879
- assertParamExists('listVirtualRobotTcps', 'motionGroup', motionGroup);
8880
- const localVarPath = `/cells/{cell}/controllers/{controller}/teach-pendant/motion-groups/{motion-group}/tcps`
9187
+ assertParamExists('listVirtualControllerIODescriptions', 'controller', controller);
9188
+ const localVarPath = `/cells/{cell}/virtual-controllers/{controller}/ios/description`
8881
9189
  .replace(`{${"cell"}}`, encodeURIComponent(String(cell)))
8882
- .replace(`{${"controller"}}`, encodeURIComponent(String(controller)))
8883
- .replace(`{${"motion-group"}}`, encodeURIComponent(String(motionGroup)));
9190
+ .replace(`{${"controller"}}`, encodeURIComponent(String(controller)));
8884
9191
  // use dummy base URL string because the URL constructor only accepts absolute URLs.
8885
9192
  const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
8886
9193
  let baseOptions;
@@ -8896,6 +9203,18 @@ export const VirtualRobotSetupApiAxiosParamCreator = function (configuration) {
8896
9203
  // authentication BearerAuth required
8897
9204
  // http bearer authentication required
8898
9205
  await setBearerAuthToObject(localVarHeaderParameter, configuration);
9206
+ if (ios) {
9207
+ localVarQueryParameter['ios'] = ios;
9208
+ }
9209
+ if (direction !== undefined) {
9210
+ localVarQueryParameter['direction'] = direction;
9211
+ }
9212
+ if (valueType !== undefined) {
9213
+ localVarQueryParameter['value_type'] = valueType;
9214
+ }
9215
+ if (group !== undefined) {
9216
+ localVarQueryParameter['group'] = group;
9217
+ }
8899
9218
  setSearchParams(localVarUrlObj, localVarQueryParameter);
8900
9219
  let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
8901
9220
  localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
@@ -8905,28 +9224,24 @@ export const VirtualRobotSetupApiAxiosParamCreator = function (configuration) {
8905
9224
  };
8906
9225
  },
8907
9226
  /**
8908
- * 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.
8909
- * @summary Set Mounting
9227
+ * Sets a list of values of a virtual controller inputs/outputs.
9228
+ * @summary Set Input/Ouput Values
8910
9229
  * @param {string} cell Unique identifier addressing a cell in all API calls.
8911
9230
  * @param {string} controller Unique identifier to address a controller in the cell.
8912
- * @param {string} motionGroup The motion-group identifier.
8913
- * @param {CoordinateSystem} coordinateSystem
9231
+ * @param {Array<IOValue>} iOValue
8914
9232
  * @param {*} [options] Override http request option.
8915
9233
  * @throws {RequiredError}
8916
9234
  */
8917
- setVirtualRobotMounting: async (cell, controller, motionGroup, coordinateSystem, options = {}) => {
9235
+ setIOValues: async (cell, controller, iOValue, options = {}) => {
8918
9236
  // verify required parameter 'cell' is not null or undefined
8919
- assertParamExists('setVirtualRobotMounting', 'cell', cell);
9237
+ assertParamExists('setIOValues', 'cell', cell);
8920
9238
  // verify required parameter 'controller' is not null or undefined
8921
- assertParamExists('setVirtualRobotMounting', 'controller', controller);
8922
- // verify required parameter 'motionGroup' is not null or undefined
8923
- assertParamExists('setVirtualRobotMounting', 'motionGroup', motionGroup);
8924
- // verify required parameter 'coordinateSystem' is not null or undefined
8925
- assertParamExists('setVirtualRobotMounting', 'coordinateSystem', coordinateSystem);
8926
- const localVarPath = `/cells/{cell}/controllers/{controller}/teach-pendant/motion-groups/{motion-group}/mounting`
9239
+ assertParamExists('setIOValues', 'controller', controller);
9240
+ // verify required parameter 'iOValue' is not null or undefined
9241
+ assertParamExists('setIOValues', 'iOValue', iOValue);
9242
+ const localVarPath = `/cells/{cell}/virtual-controllers/{controller}/ios/values`
8927
9243
  .replace(`{${"cell"}}`, encodeURIComponent(String(cell)))
8928
- .replace(`{${"controller"}}`, encodeURIComponent(String(controller)))
8929
- .replace(`{${"motion-group"}}`, encodeURIComponent(String(motionGroup)));
9244
+ .replace(`{${"controller"}}`, encodeURIComponent(String(controller)));
8930
9245
  // use dummy base URL string because the URL constructor only accepts absolute URLs.
8931
9246
  const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
8932
9247
  let baseOptions;
@@ -8946,7 +9261,7 @@ export const VirtualRobotSetupApiAxiosParamCreator = function (configuration) {
8946
9261
  setSearchParams(localVarUrlObj, localVarQueryParameter);
8947
9262
  let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
8948
9263
  localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
8949
- localVarRequestOptions.data = serializeDataIfNeeded(coordinateSystem, localVarRequestOptions, configuration);
9264
+ localVarRequestOptions.data = serializeDataIfNeeded(iOValue, localVarRequestOptions, configuration);
8950
9265
  return {
8951
9266
  url: toPathString(localVarUrlObj),
8952
9267
  options: localVarRequestOptions,
@@ -8955,358 +9270,158 @@ export const VirtualRobotSetupApiAxiosParamCreator = function (configuration) {
8955
9270
  };
8956
9271
  };
8957
9272
  /**
8958
- * VirtualRobotSetupApi - functional programming interface
9273
+ * VirtualControllerInputsOutputsApi - functional programming interface
8959
9274
  * @export
8960
9275
  */
8961
- export const VirtualRobotSetupApiFp = function (configuration) {
8962
- const localVarAxiosParamCreator = VirtualRobotSetupApiAxiosParamCreator(configuration);
9276
+ export const VirtualControllerInputsOutputsApiFp = function (configuration) {
9277
+ const localVarAxiosParamCreator = VirtualControllerInputsOutputsApiAxiosParamCreator(configuration);
8963
9278
  return {
8964
9279
  /**
8965
- * Adds a coordinate system to the robot controller.
8966
- * @summary Add Coordinate Systems
8967
- * @param {string} cell Unique identifier addressing a cell in all API calls.
8968
- * @param {string} controller Unique identifier to address a controller in the cell.
8969
- * @param {CoordinateSystem} coordinateSystem
8970
- * @param {*} [options] Override http request option.
8971
- * @throws {RequiredError}
8972
- */
8973
- async addVirtualRobotCoordinateSystem(cell, controller, coordinateSystem, options) {
8974
- const localVarAxiosArgs = await localVarAxiosParamCreator.addVirtualRobotCoordinateSystem(cell, controller, coordinateSystem, options);
8975
- const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
8976
- const localVarOperationServerBasePath = operationServerMap['VirtualRobotSetupApi.addVirtualRobotCoordinateSystem']?.[localVarOperationServerIndex]?.url;
8977
- return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
8978
- },
8979
- /**
8980
- * 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.
8981
- * @summary Add TCP
8982
- * @param {string} cell Unique identifier addressing a cell in all API calls.
8983
- * @param {string} controller Unique identifier to address a controller in the cell.
8984
- * @param {string} motionGroup The motion-group identifier.
8985
- * @param {RobotTcp} robotTcp
8986
- * @param {*} [options] Override http request option.
8987
- * @throws {RequiredError}
8988
- */
8989
- async addVirtualRobotTcp(cell, controller, motionGroup, robotTcp, options) {
8990
- const localVarAxiosArgs = await localVarAxiosParamCreator.addVirtualRobotTcp(cell, controller, motionGroup, robotTcp, options);
8991
- const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
8992
- const localVarOperationServerBasePath = operationServerMap['VirtualRobotSetupApi.addVirtualRobotTcp']?.[localVarOperationServerIndex]?.url;
8993
- return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
8994
- },
8995
- /**
8996
- * 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.
8997
- * @summary Remove Coordinate System
8998
- * @param {string} cell Unique identifier addressing a cell in all API calls.
8999
- * @param {string} controller Unique identifier to address a controller in the cell.
9000
- * @param {string} coordinateSystem Unique identifier addressing a coordinate system.
9001
- * @param {boolean} [deleteDependent] If true, all dependent coordinate systems will be deleted as well.
9002
- * @param {*} [options] Override http request option.
9003
- * @throws {RequiredError}
9004
- */
9005
- async deleteVirtualRobotCoordinateSystem(cell, controller, coordinateSystem, deleteDependent, options) {
9006
- const localVarAxiosArgs = await localVarAxiosParamCreator.deleteVirtualRobotCoordinateSystem(cell, controller, coordinateSystem, deleteDependent, options);
9007
- const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
9008
- const localVarOperationServerBasePath = operationServerMap['VirtualRobotSetupApi.deleteVirtualRobotCoordinateSystem']?.[localVarOperationServerIndex]?.url;
9009
- return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
9010
- },
9011
- /**
9012
- * Removes the TCP from the motion group. An unknown TCP is a valid input.
9013
- * @summary Remove TCP
9014
- * @param {string} cell Unique identifier addressing a cell in all API calls.
9015
- * @param {string} controller Unique identifier to address a controller in the cell.
9016
- * @param {string} motionGroup The motion-group identifier.
9017
- * @param {string} tcp The unique identifier of a TCP.
9018
- * @param {*} [options] Override http request option.
9019
- * @throws {RequiredError}
9020
- */
9021
- async deleteVirtualRobotTcp(cell, controller, motionGroup, tcp, options) {
9022
- const localVarAxiosArgs = await localVarAxiosParamCreator.deleteVirtualRobotTcp(cell, controller, motionGroup, tcp, options);
9023
- const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
9024
- const localVarOperationServerBasePath = operationServerMap['VirtualRobotSetupApi.deleteVirtualRobotTcp']?.[localVarOperationServerIndex]?.url;
9025
- return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
9026
- },
9027
- /**
9028
- * Gets motion group mounting. The motion group is based on the origin of the returned coordinate system.
9029
- * @summary Get Mounting
9030
- * @param {string} cell Unique identifier addressing a cell in all API calls.
9031
- * @param {string} controller Unique identifier to address a controller in the cell.
9032
- * @param {string} motionGroup The motion-group identifier.
9033
- * @param {*} [options] Override http request option.
9034
- * @throws {RequiredError}
9035
- */
9036
- async getVirtualRobotMounting(cell, controller, motionGroup, options) {
9037
- const localVarAxiosArgs = await localVarAxiosParamCreator.getVirtualRobotMounting(cell, controller, motionGroup, options);
9038
- const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
9039
- const localVarOperationServerBasePath = operationServerMap['VirtualRobotSetupApi.getVirtualRobotMounting']?.[localVarOperationServerIndex]?.url;
9040
- return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
9041
- },
9042
- /**
9043
- * Lists all coordinate systems on the robot controller.
9044
- * @summary List Coordinate Systems
9280
+ * 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 [listVirtualControllerIODescriptions](listVirtualControllerIODescriptions).
9281
+ * @summary Get Input/Output Values
9045
9282
  * @param {string} cell Unique identifier addressing a cell in all API calls.
9046
9283
  * @param {string} controller Unique identifier to address a controller in the cell.
9284
+ * @param {Array<string>} ios
9047
9285
  * @param {*} [options] Override http request option.
9048
9286
  * @throws {RequiredError}
9049
9287
  */
9050
- async listVirtualRobotCoordinateSystems(cell, controller, options) {
9051
- const localVarAxiosArgs = await localVarAxiosParamCreator.listVirtualRobotCoordinateSystems(cell, controller, options);
9288
+ async listIOs(cell, controller, ios, options) {
9289
+ const localVarAxiosArgs = await localVarAxiosParamCreator.listIOs(cell, controller, ios, options);
9052
9290
  const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
9053
- const localVarOperationServerBasePath = operationServerMap['VirtualRobotSetupApi.listVirtualRobotCoordinateSystems']?.[localVarOperationServerIndex]?.url;
9291
+ const localVarOperationServerBasePath = operationServerMap['VirtualControllerInputsOutputsApi.listIOs']?.[localVarOperationServerIndex]?.url;
9054
9292
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
9055
9293
  },
9056
9294
  /**
9057
- * Lists TCPs of the motion group. An empty TCP list is valid, for example for external axes.
9058
- * @summary List TCPs
9295
+ * 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.
9296
+ * @summary List Descriptions
9059
9297
  * @param {string} cell Unique identifier addressing a cell in all API calls.
9060
9298
  * @param {string} controller Unique identifier to address a controller in the cell.
9061
- * @param {string} motionGroup The motion-group identifier.
9299
+ * @param {Array<string>} [ios]
9300
+ * @param {IODirection} [direction] Return only inputs/outputs with the specified direction.
9301
+ * @param {IOValueType} [valueType] Return only inputs/outputs with the specified value type.
9302
+ * @param {string} [group] Return only inputs/outputs from the specified group.
9062
9303
  * @param {*} [options] Override http request option.
9063
9304
  * @throws {RequiredError}
9064
9305
  */
9065
- async listVirtualRobotTcps(cell, controller, motionGroup, options) {
9066
- const localVarAxiosArgs = await localVarAxiosParamCreator.listVirtualRobotTcps(cell, controller, motionGroup, options);
9306
+ async listVirtualControllerIODescriptions(cell, controller, ios, direction, valueType, group, options) {
9307
+ const localVarAxiosArgs = await localVarAxiosParamCreator.listVirtualControllerIODescriptions(cell, controller, ios, direction, valueType, group, options);
9067
9308
  const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
9068
- const localVarOperationServerBasePath = operationServerMap['VirtualRobotSetupApi.listVirtualRobotTcps']?.[localVarOperationServerIndex]?.url;
9309
+ const localVarOperationServerBasePath = operationServerMap['VirtualControllerInputsOutputsApi.listVirtualControllerIODescriptions']?.[localVarOperationServerIndex]?.url;
9069
9310
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
9070
9311
  },
9071
9312
  /**
9072
- * 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.
9073
- * @summary Set Mounting
9313
+ * Sets a list of values of a virtual controller inputs/outputs.
9314
+ * @summary Set Input/Ouput Values
9074
9315
  * @param {string} cell Unique identifier addressing a cell in all API calls.
9075
9316
  * @param {string} controller Unique identifier to address a controller in the cell.
9076
- * @param {string} motionGroup The motion-group identifier.
9077
- * @param {CoordinateSystem} coordinateSystem
9317
+ * @param {Array<IOValue>} iOValue
9078
9318
  * @param {*} [options] Override http request option.
9079
9319
  * @throws {RequiredError}
9080
9320
  */
9081
- async setVirtualRobotMounting(cell, controller, motionGroup, coordinateSystem, options) {
9082
- const localVarAxiosArgs = await localVarAxiosParamCreator.setVirtualRobotMounting(cell, controller, motionGroup, coordinateSystem, options);
9321
+ async setIOValues(cell, controller, iOValue, options) {
9322
+ const localVarAxiosArgs = await localVarAxiosParamCreator.setIOValues(cell, controller, iOValue, options);
9083
9323
  const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
9084
- const localVarOperationServerBasePath = operationServerMap['VirtualRobotSetupApi.setVirtualRobotMounting']?.[localVarOperationServerIndex]?.url;
9324
+ const localVarOperationServerBasePath = operationServerMap['VirtualControllerInputsOutputsApi.setIOValues']?.[localVarOperationServerIndex]?.url;
9085
9325
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
9086
9326
  },
9087
9327
  };
9088
9328
  };
9089
9329
  /**
9090
- * VirtualRobotSetupApi - factory interface
9330
+ * VirtualControllerInputsOutputsApi - factory interface
9091
9331
  * @export
9092
9332
  */
9093
- export const VirtualRobotSetupApiFactory = function (configuration, basePath, axios) {
9094
- const localVarFp = VirtualRobotSetupApiFp(configuration);
9333
+ export const VirtualControllerInputsOutputsApiFactory = function (configuration, basePath, axios) {
9334
+ const localVarFp = VirtualControllerInputsOutputsApiFp(configuration);
9095
9335
  return {
9096
9336
  /**
9097
- * Adds a coordinate system to the robot controller.
9098
- * @summary Add Coordinate Systems
9099
- * @param {string} cell Unique identifier addressing a cell in all API calls.
9100
- * @param {string} controller Unique identifier to address a controller in the cell.
9101
- * @param {CoordinateSystem} coordinateSystem
9102
- * @param {*} [options] Override http request option.
9103
- * @throws {RequiredError}
9104
- */
9105
- addVirtualRobotCoordinateSystem(cell, controller, coordinateSystem, options) {
9106
- return localVarFp.addVirtualRobotCoordinateSystem(cell, controller, coordinateSystem, options).then((request) => request(axios, basePath));
9107
- },
9108
- /**
9109
- * 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.
9110
- * @summary Add TCP
9111
- * @param {string} cell Unique identifier addressing a cell in all API calls.
9112
- * @param {string} controller Unique identifier to address a controller in the cell.
9113
- * @param {string} motionGroup The motion-group identifier.
9114
- * @param {RobotTcp} robotTcp
9115
- * @param {*} [options] Override http request option.
9116
- * @throws {RequiredError}
9117
- */
9118
- addVirtualRobotTcp(cell, controller, motionGroup, robotTcp, options) {
9119
- return localVarFp.addVirtualRobotTcp(cell, controller, motionGroup, robotTcp, options).then((request) => request(axios, basePath));
9120
- },
9121
- /**
9122
- * 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.
9123
- * @summary Remove Coordinate System
9124
- * @param {string} cell Unique identifier addressing a cell in all API calls.
9125
- * @param {string} controller Unique identifier to address a controller in the cell.
9126
- * @param {string} coordinateSystem Unique identifier addressing a coordinate system.
9127
- * @param {boolean} [deleteDependent] If true, all dependent coordinate systems will be deleted as well.
9128
- * @param {*} [options] Override http request option.
9129
- * @throws {RequiredError}
9130
- */
9131
- deleteVirtualRobotCoordinateSystem(cell, controller, coordinateSystem, deleteDependent, options) {
9132
- return localVarFp.deleteVirtualRobotCoordinateSystem(cell, controller, coordinateSystem, deleteDependent, options).then((request) => request(axios, basePath));
9133
- },
9134
- /**
9135
- * Removes the TCP from the motion group. An unknown TCP is a valid input.
9136
- * @summary Remove TCP
9137
- * @param {string} cell Unique identifier addressing a cell in all API calls.
9138
- * @param {string} controller Unique identifier to address a controller in the cell.
9139
- * @param {string} motionGroup The motion-group identifier.
9140
- * @param {string} tcp The unique identifier of a TCP.
9141
- * @param {*} [options] Override http request option.
9142
- * @throws {RequiredError}
9143
- */
9144
- deleteVirtualRobotTcp(cell, controller, motionGroup, tcp, options) {
9145
- return localVarFp.deleteVirtualRobotTcp(cell, controller, motionGroup, tcp, options).then((request) => request(axios, basePath));
9146
- },
9147
- /**
9148
- * Gets motion group mounting. The motion group is based on the origin of the returned coordinate system.
9149
- * @summary Get Mounting
9150
- * @param {string} cell Unique identifier addressing a cell in all API calls.
9151
- * @param {string} controller Unique identifier to address a controller in the cell.
9152
- * @param {string} motionGroup The motion-group identifier.
9153
- * @param {*} [options] Override http request option.
9154
- * @throws {RequiredError}
9155
- */
9156
- getVirtualRobotMounting(cell, controller, motionGroup, options) {
9157
- return localVarFp.getVirtualRobotMounting(cell, controller, motionGroup, options).then((request) => request(axios, basePath));
9158
- },
9159
- /**
9160
- * Lists all coordinate systems on the robot controller.
9161
- * @summary List Coordinate Systems
9337
+ * 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 [listVirtualControllerIODescriptions](listVirtualControllerIODescriptions).
9338
+ * @summary Get Input/Output Values
9162
9339
  * @param {string} cell Unique identifier addressing a cell in all API calls.
9163
9340
  * @param {string} controller Unique identifier to address a controller in the cell.
9341
+ * @param {Array<string>} ios
9164
9342
  * @param {*} [options] Override http request option.
9165
9343
  * @throws {RequiredError}
9166
9344
  */
9167
- listVirtualRobotCoordinateSystems(cell, controller, options) {
9168
- return localVarFp.listVirtualRobotCoordinateSystems(cell, controller, options).then((request) => request(axios, basePath));
9345
+ listIOs(cell, controller, ios, options) {
9346
+ return localVarFp.listIOs(cell, controller, ios, options).then((request) => request(axios, basePath));
9169
9347
  },
9170
9348
  /**
9171
- * Lists TCPs of the motion group. An empty TCP list is valid, for example for external axes.
9172
- * @summary List TCPs
9349
+ * 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.
9350
+ * @summary List Descriptions
9173
9351
  * @param {string} cell Unique identifier addressing a cell in all API calls.
9174
9352
  * @param {string} controller Unique identifier to address a controller in the cell.
9175
- * @param {string} motionGroup The motion-group identifier.
9353
+ * @param {Array<string>} [ios]
9354
+ * @param {IODirection} [direction] Return only inputs/outputs with the specified direction.
9355
+ * @param {IOValueType} [valueType] Return only inputs/outputs with the specified value type.
9356
+ * @param {string} [group] Return only inputs/outputs from the specified group.
9176
9357
  * @param {*} [options] Override http request option.
9177
9358
  * @throws {RequiredError}
9178
9359
  */
9179
- listVirtualRobotTcps(cell, controller, motionGroup, options) {
9180
- return localVarFp.listVirtualRobotTcps(cell, controller, motionGroup, options).then((request) => request(axios, basePath));
9360
+ listVirtualControllerIODescriptions(cell, controller, ios, direction, valueType, group, options) {
9361
+ return localVarFp.listVirtualControllerIODescriptions(cell, controller, ios, direction, valueType, group, options).then((request) => request(axios, basePath));
9181
9362
  },
9182
9363
  /**
9183
- * 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.
9184
- * @summary Set Mounting
9364
+ * Sets a list of values of a virtual controller inputs/outputs.
9365
+ * @summary Set Input/Ouput Values
9185
9366
  * @param {string} cell Unique identifier addressing a cell in all API calls.
9186
9367
  * @param {string} controller Unique identifier to address a controller in the cell.
9187
- * @param {string} motionGroup The motion-group identifier.
9188
- * @param {CoordinateSystem} coordinateSystem
9368
+ * @param {Array<IOValue>} iOValue
9189
9369
  * @param {*} [options] Override http request option.
9190
9370
  * @throws {RequiredError}
9191
9371
  */
9192
- setVirtualRobotMounting(cell, controller, motionGroup, coordinateSystem, options) {
9193
- return localVarFp.setVirtualRobotMounting(cell, controller, motionGroup, coordinateSystem, options).then((request) => request(axios, basePath));
9372
+ setIOValues(cell, controller, iOValue, options) {
9373
+ return localVarFp.setIOValues(cell, controller, iOValue, options).then((request) => request(axios, basePath));
9194
9374
  },
9195
9375
  };
9196
9376
  };
9197
9377
  /**
9198
- * VirtualRobotSetupApi - object-oriented interface
9378
+ * VirtualControllerInputsOutputsApi - object-oriented interface
9199
9379
  * @export
9200
- * @class VirtualRobotSetupApi
9380
+ * @class VirtualControllerInputsOutputsApi
9201
9381
  * @extends {BaseAPI}
9202
9382
  */
9203
- export class VirtualRobotSetupApi extends BaseAPI {
9204
- /**
9205
- * Adds a coordinate system to the robot controller.
9206
- * @summary Add Coordinate Systems
9207
- * @param {string} cell Unique identifier addressing a cell in all API calls.
9208
- * @param {string} controller Unique identifier to address a controller in the cell.
9209
- * @param {CoordinateSystem} coordinateSystem
9210
- * @param {*} [options] Override http request option.
9211
- * @throws {RequiredError}
9212
- * @memberof VirtualRobotSetupApi
9213
- */
9214
- addVirtualRobotCoordinateSystem(cell, controller, coordinateSystem, options) {
9215
- return VirtualRobotSetupApiFp(this.configuration).addVirtualRobotCoordinateSystem(cell, controller, coordinateSystem, options).then((request) => request(this.axios, this.basePath));
9216
- }
9383
+ export class VirtualControllerInputsOutputsApi extends BaseAPI {
9217
9384
  /**
9218
- * 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.
9219
- * @summary Add TCP
9220
- * @param {string} cell Unique identifier addressing a cell in all API calls.
9221
- * @param {string} controller Unique identifier to address a controller in the cell.
9222
- * @param {string} motionGroup The motion-group identifier.
9223
- * @param {RobotTcp} robotTcp
9224
- * @param {*} [options] Override http request option.
9225
- * @throws {RequiredError}
9226
- * @memberof VirtualRobotSetupApi
9227
- */
9228
- addVirtualRobotTcp(cell, controller, motionGroup, robotTcp, options) {
9229
- return VirtualRobotSetupApiFp(this.configuration).addVirtualRobotTcp(cell, controller, motionGroup, robotTcp, options).then((request) => request(this.axios, this.basePath));
9230
- }
9231
- /**
9232
- * 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.
9233
- * @summary Remove Coordinate System
9234
- * @param {string} cell Unique identifier addressing a cell in all API calls.
9235
- * @param {string} controller Unique identifier to address a controller in the cell.
9236
- * @param {string} coordinateSystem Unique identifier addressing a coordinate system.
9237
- * @param {boolean} [deleteDependent] If true, all dependent coordinate systems will be deleted as well.
9238
- * @param {*} [options] Override http request option.
9239
- * @throws {RequiredError}
9240
- * @memberof VirtualRobotSetupApi
9241
- */
9242
- deleteVirtualRobotCoordinateSystem(cell, controller, coordinateSystem, deleteDependent, options) {
9243
- return VirtualRobotSetupApiFp(this.configuration).deleteVirtualRobotCoordinateSystem(cell, controller, coordinateSystem, deleteDependent, options).then((request) => request(this.axios, this.basePath));
9244
- }
9245
- /**
9246
- * Removes the TCP from the motion group. An unknown TCP is a valid input.
9247
- * @summary Remove TCP
9248
- * @param {string} cell Unique identifier addressing a cell in all API calls.
9249
- * @param {string} controller Unique identifier to address a controller in the cell.
9250
- * @param {string} motionGroup The motion-group identifier.
9251
- * @param {string} tcp The unique identifier of a TCP.
9252
- * @param {*} [options] Override http request option.
9253
- * @throws {RequiredError}
9254
- * @memberof VirtualRobotSetupApi
9255
- */
9256
- deleteVirtualRobotTcp(cell, controller, motionGroup, tcp, options) {
9257
- return VirtualRobotSetupApiFp(this.configuration).deleteVirtualRobotTcp(cell, controller, motionGroup, tcp, options).then((request) => request(this.axios, this.basePath));
9258
- }
9259
- /**
9260
- * Gets motion group mounting. The motion group is based on the origin of the returned coordinate system.
9261
- * @summary Get Mounting
9262
- * @param {string} cell Unique identifier addressing a cell in all API calls.
9263
- * @param {string} controller Unique identifier to address a controller in the cell.
9264
- * @param {string} motionGroup The motion-group identifier.
9265
- * @param {*} [options] Override http request option.
9266
- * @throws {RequiredError}
9267
- * @memberof VirtualRobotSetupApi
9268
- */
9269
- getVirtualRobotMounting(cell, controller, motionGroup, options) {
9270
- return VirtualRobotSetupApiFp(this.configuration).getVirtualRobotMounting(cell, controller, motionGroup, options).then((request) => request(this.axios, this.basePath));
9271
- }
9272
- /**
9273
- * Lists all coordinate systems on the robot controller.
9274
- * @summary List Coordinate Systems
9385
+ * 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 [listVirtualControllerIODescriptions](listVirtualControllerIODescriptions).
9386
+ * @summary Get Input/Output Values
9275
9387
  * @param {string} cell Unique identifier addressing a cell in all API calls.
9276
9388
  * @param {string} controller Unique identifier to address a controller in the cell.
9389
+ * @param {Array<string>} ios
9277
9390
  * @param {*} [options] Override http request option.
9278
9391
  * @throws {RequiredError}
9279
- * @memberof VirtualRobotSetupApi
9392
+ * @memberof VirtualControllerInputsOutputsApi
9280
9393
  */
9281
- listVirtualRobotCoordinateSystems(cell, controller, options) {
9282
- return VirtualRobotSetupApiFp(this.configuration).listVirtualRobotCoordinateSystems(cell, controller, options).then((request) => request(this.axios, this.basePath));
9394
+ listIOs(cell, controller, ios, options) {
9395
+ return VirtualControllerInputsOutputsApiFp(this.configuration).listIOs(cell, controller, ios, options).then((request) => request(this.axios, this.basePath));
9283
9396
  }
9284
9397
  /**
9285
- * Lists TCPs of the motion group. An empty TCP list is valid, for example for external axes.
9286
- * @summary List TCPs
9398
+ * 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.
9399
+ * @summary List Descriptions
9287
9400
  * @param {string} cell Unique identifier addressing a cell in all API calls.
9288
9401
  * @param {string} controller Unique identifier to address a controller in the cell.
9289
- * @param {string} motionGroup The motion-group identifier.
9402
+ * @param {Array<string>} [ios]
9403
+ * @param {IODirection} [direction] Return only inputs/outputs with the specified direction.
9404
+ * @param {IOValueType} [valueType] Return only inputs/outputs with the specified value type.
9405
+ * @param {string} [group] Return only inputs/outputs from the specified group.
9290
9406
  * @param {*} [options] Override http request option.
9291
9407
  * @throws {RequiredError}
9292
- * @memberof VirtualRobotSetupApi
9408
+ * @memberof VirtualControllerInputsOutputsApi
9293
9409
  */
9294
- listVirtualRobotTcps(cell, controller, motionGroup, options) {
9295
- return VirtualRobotSetupApiFp(this.configuration).listVirtualRobotTcps(cell, controller, motionGroup, options).then((request) => request(this.axios, this.basePath));
9410
+ listVirtualControllerIODescriptions(cell, controller, ios, direction, valueType, group, options) {
9411
+ return VirtualControllerInputsOutputsApiFp(this.configuration).listVirtualControllerIODescriptions(cell, controller, ios, direction, valueType, group, options).then((request) => request(this.axios, this.basePath));
9296
9412
  }
9297
9413
  /**
9298
- * 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.
9299
- * @summary Set Mounting
9414
+ * Sets a list of values of a virtual controller inputs/outputs.
9415
+ * @summary Set Input/Ouput Values
9300
9416
  * @param {string} cell Unique identifier addressing a cell in all API calls.
9301
9417
  * @param {string} controller Unique identifier to address a controller in the cell.
9302
- * @param {string} motionGroup The motion-group identifier.
9303
- * @param {CoordinateSystem} coordinateSystem
9418
+ * @param {Array<IOValue>} iOValue
9304
9419
  * @param {*} [options] Override http request option.
9305
9420
  * @throws {RequiredError}
9306
- * @memberof VirtualRobotSetupApi
9421
+ * @memberof VirtualControllerInputsOutputsApi
9307
9422
  */
9308
- setVirtualRobotMounting(cell, controller, motionGroup, coordinateSystem, options) {
9309
- return VirtualRobotSetupApiFp(this.configuration).setVirtualRobotMounting(cell, controller, motionGroup, coordinateSystem, options).then((request) => request(this.axios, this.basePath));
9423
+ setIOValues(cell, controller, iOValue, options) {
9424
+ return VirtualControllerInputsOutputsApiFp(this.configuration).setIOValues(cell, controller, iOValue, options).then((request) => request(this.axios, this.basePath));
9310
9425
  }
9311
9426
  }
9312
9427
  //# sourceMappingURL=api.js.map