@wandelbots/nova-api 25.7.0-dev.17 → 25.7.0-dev.2
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/package.json +1 -1
- package/v1/api.d.ts +7 -7
- package/v1/api.js +5 -5
- package/v1/api.ts +7 -7
- package/v1/base.d.ts +1 -1
- package/v1/base.js +1 -1
- package/v1/base.ts +1 -1
- package/v1/common.d.ts +1 -1
- package/v1/common.js +1 -1
- package/v1/common.ts +1 -1
- package/v1/configuration.d.ts +1 -1
- package/v1/configuration.js +1 -1
- package/v1/configuration.ts +1 -1
- package/v1/index.d.ts +1 -1
- package/v1/index.js +1 -1
- package/v1/index.ts +1 -1
- package/v2/api.d.ts +793 -864
- package/v2/api.js +1187 -1302
- package/v2/api.js.map +1 -1
- package/v2/api.ts +1541 -1681
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
|
|
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).
|
|
25
25
|
* @export
|
|
26
26
|
* @enum {string}
|
|
27
27
|
*/
|
|
@@ -86,6 +86,9 @@ 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
|
+
};
|
|
89
92
|
export const FanucControllerKindEnum = {
|
|
90
93
|
FanucController: 'FanucController'
|
|
91
94
|
};
|
|
@@ -150,21 +153,6 @@ export const IntegerValueValueTypeEnum = {
|
|
|
150
153
|
export const JoggingDetailsKindEnum = {
|
|
151
154
|
Jogging: 'JOGGING'
|
|
152
155
|
};
|
|
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
|
-
};
|
|
168
156
|
export const JointVelocityRequestMessageTypeEnum = {
|
|
169
157
|
JointVelocityRequest: 'JointVelocityRequest'
|
|
170
158
|
};
|
|
@@ -199,7 +187,7 @@ export const Manufacturer = {
|
|
|
199
187
|
Yaskawa: 'yaskawa'
|
|
200
188
|
};
|
|
201
189
|
export const MovementErrorResponseKindEnum = {
|
|
202
|
-
|
|
190
|
+
Error: 'ERROR'
|
|
203
191
|
};
|
|
204
192
|
/**
|
|
205
193
|
* The operating state.
|
|
@@ -287,6 +275,21 @@ export const PauseMovementRequestMessageTypeEnum = {
|
|
|
287
275
|
export const PauseMovementResponseKindEnum = {
|
|
288
276
|
PauseReceived: 'PAUSE_RECEIVED'
|
|
289
277
|
};
|
|
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
|
+
};
|
|
290
293
|
export const PlaneShapeTypeEnum = {
|
|
291
294
|
Plane: 'plane'
|
|
292
295
|
};
|
|
@@ -323,6 +326,12 @@ export const RobotSystemMode = {
|
|
|
323
326
|
RobotSystemModeControl: 'ROBOT_SYSTEM_MODE_CONTROL',
|
|
324
327
|
RobotSystemModeFreeDrive: 'ROBOT_SYSTEM_MODE_FREE_DRIVE'
|
|
325
328
|
};
|
|
329
|
+
export const RunningKindEnum = {
|
|
330
|
+
Running: 'RUNNING'
|
|
331
|
+
};
|
|
332
|
+
export const Running1KindEnum = {
|
|
333
|
+
Running: 'RUNNING'
|
|
334
|
+
};
|
|
326
335
|
/**
|
|
327
336
|
* 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.
|
|
328
337
|
* @export
|
|
@@ -428,24 +437,9 @@ export const TrajectoryDataMessageTypeEnum = {
|
|
|
428
437
|
export const TrajectoryDetailsKindEnum = {
|
|
429
438
|
Trajectory: 'TRAJECTORY'
|
|
430
439
|
};
|
|
431
|
-
export const TrajectoryEndedKindEnum = {
|
|
432
|
-
EndOfTrajectory: 'END_OF_TRAJECTORY'
|
|
433
|
-
};
|
|
434
440
|
export const TrajectoryIdMessageTypeEnum = {
|
|
435
441
|
TrajectoryId: 'TrajectoryId'
|
|
436
442
|
};
|
|
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
|
-
};
|
|
449
443
|
/**
|
|
450
444
|
* The unit of input/output value.
|
|
451
445
|
* @export
|
|
@@ -583,6 +577,9 @@ export const VirtualControllerTypes = {
|
|
|
583
577
|
YaskawaHc10dtp: 'yaskawa-hc10dtp',
|
|
584
578
|
YaskawaHc20dtp: 'yaskawa-hc20dtp'
|
|
585
579
|
};
|
|
580
|
+
export const WaitForIOKindEnum = {
|
|
581
|
+
WaitForIo: 'WAIT_FOR_IO'
|
|
582
|
+
};
|
|
586
583
|
export const YaskawaControllerKindEnum = {
|
|
587
584
|
YaskawaController: 'YaskawaController'
|
|
588
585
|
};
|
|
@@ -1780,45 +1777,6 @@ export const ControllerApiAxiosParamCreator = function (configuration) {
|
|
|
1780
1777
|
options: localVarRequestOptions,
|
|
1781
1778
|
};
|
|
1782
1779
|
},
|
|
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
|
-
},
|
|
1822
1780
|
/**
|
|
1823
1781
|
* 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.
|
|
1824
1782
|
* @summary Coordinate System
|
|
@@ -1984,18 +1942,18 @@ export const ControllerApiAxiosParamCreator = function (configuration) {
|
|
|
1984
1942
|
};
|
|
1985
1943
|
},
|
|
1986
1944
|
/**
|
|
1987
|
-
* Receive
|
|
1988
|
-
* @summary Virtual
|
|
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
|
|
1989
1947
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
1990
1948
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
1991
1949
|
* @param {*} [options] Override http request option.
|
|
1992
1950
|
* @throws {RequiredError}
|
|
1993
1951
|
*/
|
|
1994
|
-
|
|
1952
|
+
getVirtualRobotConfiguration: async (cell, controller, options = {}) => {
|
|
1995
1953
|
// verify required parameter 'cell' is not null or undefined
|
|
1996
|
-
assertParamExists('
|
|
1954
|
+
assertParamExists('getVirtualRobotConfiguration', 'cell', cell);
|
|
1997
1955
|
// verify required parameter 'controller' is not null or undefined
|
|
1998
|
-
assertParamExists('
|
|
1956
|
+
assertParamExists('getVirtualRobotConfiguration', 'controller', controller);
|
|
1999
1957
|
const localVarPath = `/cells/{cell}/controllers/{controller}/virtual-robot-configuration`
|
|
2000
1958
|
.replace(`{${"cell"}}`, encodeURIComponent(String(cell)))
|
|
2001
1959
|
.replace(`{${"controller"}}`, encodeURIComponent(String(controller)));
|
|
@@ -2332,20 +2290,6 @@ export const ControllerApiFp = function (configuration) {
|
|
|
2332
2290
|
const localVarOperationServerBasePath = operationServerMap['ControllerApi.deleteRobotController']?.[localVarOperationServerIndex]?.url;
|
|
2333
2291
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
2334
2292
|
},
|
|
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
|
-
},
|
|
2349
2293
|
/**
|
|
2350
2294
|
* 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.
|
|
2351
2295
|
* @summary Coordinate System
|
|
@@ -2405,17 +2349,17 @@ export const ControllerApiFp = function (configuration) {
|
|
|
2405
2349
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
2406
2350
|
},
|
|
2407
2351
|
/**
|
|
2408
|
-
* Receive
|
|
2409
|
-
* @summary Virtual
|
|
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
|
|
2410
2354
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
2411
2355
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
2412
2356
|
* @param {*} [options] Override http request option.
|
|
2413
2357
|
* @throws {RequiredError}
|
|
2414
2358
|
*/
|
|
2415
|
-
async
|
|
2416
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.
|
|
2359
|
+
async getVirtualRobotConfiguration(cell, controller, options) {
|
|
2360
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.getVirtualRobotConfiguration(cell, controller, options);
|
|
2417
2361
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
2418
|
-
const localVarOperationServerBasePath = operationServerMap['ControllerApi.
|
|
2362
|
+
const localVarOperationServerBasePath = operationServerMap['ControllerApi.getVirtualRobotConfiguration']?.[localVarOperationServerIndex]?.url;
|
|
2419
2363
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
2420
2364
|
},
|
|
2421
2365
|
/**
|
|
@@ -2551,17 +2495,6 @@ export const ControllerApiFactory = function (configuration, basePath, axios) {
|
|
|
2551
2495
|
deleteRobotController(cell, controller, completionTimeout, options) {
|
|
2552
2496
|
return localVarFp.deleteRobotController(cell, controller, completionTimeout, options).then((request) => request(axios, basePath));
|
|
2553
2497
|
},
|
|
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
|
-
},
|
|
2565
2498
|
/**
|
|
2566
2499
|
* 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.
|
|
2567
2500
|
* @summary Coordinate System
|
|
@@ -2609,15 +2542,15 @@ export const ControllerApiFactory = function (configuration, basePath, axios) {
|
|
|
2609
2542
|
return localVarFp.getRobotController(cell, controller, options).then((request) => request(axios, basePath));
|
|
2610
2543
|
},
|
|
2611
2544
|
/**
|
|
2612
|
-
* Receive
|
|
2613
|
-
* @summary Virtual
|
|
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
|
|
2614
2547
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
2615
2548
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
2616
2549
|
* @param {*} [options] Override http request option.
|
|
2617
2550
|
* @throws {RequiredError}
|
|
2618
2551
|
*/
|
|
2619
|
-
|
|
2620
|
-
return localVarFp.
|
|
2552
|
+
getVirtualRobotConfiguration(cell, controller, options) {
|
|
2553
|
+
return localVarFp.getVirtualRobotConfiguration(cell, controller, options).then((request) => request(axios, basePath));
|
|
2621
2554
|
},
|
|
2622
2555
|
/**
|
|
2623
2556
|
* 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.
|
|
@@ -2737,18 +2670,6 @@ export class ControllerApi extends BaseAPI {
|
|
|
2737
2670
|
deleteRobotController(cell, controller, completionTimeout, options) {
|
|
2738
2671
|
return ControllerApiFp(this.configuration).deleteRobotController(cell, controller, completionTimeout, options).then((request) => request(this.axios, this.basePath));
|
|
2739
2672
|
}
|
|
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
|
-
}
|
|
2752
2673
|
/**
|
|
2753
2674
|
* 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.
|
|
2754
2675
|
* @summary Coordinate System
|
|
@@ -2800,16 +2721,16 @@ export class ControllerApi extends BaseAPI {
|
|
|
2800
2721
|
return ControllerApiFp(this.configuration).getRobotController(cell, controller, options).then((request) => request(this.axios, this.basePath));
|
|
2801
2722
|
}
|
|
2802
2723
|
/**
|
|
2803
|
-
* Receive
|
|
2804
|
-
* @summary Virtual
|
|
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
|
|
2805
2726
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
2806
2727
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
2807
2728
|
* @param {*} [options] Override http request option.
|
|
2808
2729
|
* @throws {RequiredError}
|
|
2809
2730
|
* @memberof ControllerApi
|
|
2810
2731
|
*/
|
|
2811
|
-
|
|
2812
|
-
return ControllerApiFp(this.configuration).
|
|
2732
|
+
getVirtualRobotConfiguration(cell, controller, options) {
|
|
2733
|
+
return ControllerApiFp(this.configuration).getVirtualRobotConfiguration(cell, controller, options).then((request) => request(this.axios, this.basePath));
|
|
2813
2734
|
}
|
|
2814
2735
|
/**
|
|
2815
2736
|
* 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.
|
|
@@ -3371,21 +3292,17 @@ export const JoggingApiAxiosParamCreator = function (configuration) {
|
|
|
3371
3292
|
* <!-- 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.
|
|
3372
3293
|
* @summary Execute Jogging
|
|
3373
3294
|
* @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.
|
|
3375
3295
|
* @param {ExecuteJoggingRequest} executeJoggingRequest
|
|
3376
3296
|
* @param {*} [options] Override http request option.
|
|
3377
3297
|
* @throws {RequiredError}
|
|
3378
3298
|
*/
|
|
3379
|
-
executeJogging: async (cell,
|
|
3299
|
+
executeJogging: async (cell, executeJoggingRequest, options = {}) => {
|
|
3380
3300
|
// verify required parameter 'cell' is not null or undefined
|
|
3381
3301
|
assertParamExists('executeJogging', 'cell', cell);
|
|
3382
|
-
// verify required parameter 'controller' is not null or undefined
|
|
3383
|
-
assertParamExists('executeJogging', 'controller', controller);
|
|
3384
3302
|
// verify required parameter 'executeJoggingRequest' is not null or undefined
|
|
3385
3303
|
assertParamExists('executeJogging', 'executeJoggingRequest', executeJoggingRequest);
|
|
3386
|
-
const localVarPath = `/cells/{cell}/
|
|
3387
|
-
.replace(`{${"cell"}}`, encodeURIComponent(String(cell)))
|
|
3388
|
-
.replace(`{${"controller"}}`, encodeURIComponent(String(controller)));
|
|
3304
|
+
const localVarPath = `/cells/{cell}/execution/jogging`
|
|
3305
|
+
.replace(`{${"cell"}}`, encodeURIComponent(String(cell)));
|
|
3389
3306
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
3390
3307
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
3391
3308
|
let baseOptions;
|
|
@@ -3424,13 +3341,12 @@ export const JoggingApiFp = function (configuration) {
|
|
|
3424
3341
|
* <!-- 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.
|
|
3425
3342
|
* @summary Execute Jogging
|
|
3426
3343
|
* @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.
|
|
3428
3344
|
* @param {ExecuteJoggingRequest} executeJoggingRequest
|
|
3429
3345
|
* @param {*} [options] Override http request option.
|
|
3430
3346
|
* @throws {RequiredError}
|
|
3431
3347
|
*/
|
|
3432
|
-
async executeJogging(cell,
|
|
3433
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.executeJogging(cell,
|
|
3348
|
+
async executeJogging(cell, executeJoggingRequest, options) {
|
|
3349
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.executeJogging(cell, executeJoggingRequest, options);
|
|
3434
3350
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
3435
3351
|
const localVarOperationServerBasePath = operationServerMap['JoggingApi.executeJogging']?.[localVarOperationServerIndex]?.url;
|
|
3436
3352
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
@@ -3448,13 +3364,12 @@ export const JoggingApiFactory = function (configuration, basePath, axios) {
|
|
|
3448
3364
|
* <!-- 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.
|
|
3449
3365
|
* @summary Execute Jogging
|
|
3450
3366
|
* @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.
|
|
3452
3367
|
* @param {ExecuteJoggingRequest} executeJoggingRequest
|
|
3453
3368
|
* @param {*} [options] Override http request option.
|
|
3454
3369
|
* @throws {RequiredError}
|
|
3455
3370
|
*/
|
|
3456
|
-
executeJogging(cell,
|
|
3457
|
-
return localVarFp.executeJogging(cell,
|
|
3371
|
+
executeJogging(cell, executeJoggingRequest, options) {
|
|
3372
|
+
return localVarFp.executeJogging(cell, executeJoggingRequest, options).then((request) => request(axios, basePath));
|
|
3458
3373
|
},
|
|
3459
3374
|
};
|
|
3460
3375
|
};
|
|
@@ -3469,14 +3384,13 @@ export class JoggingApi extends BaseAPI {
|
|
|
3469
3384
|
* <!-- 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.
|
|
3470
3385
|
* @summary Execute Jogging
|
|
3471
3386
|
* @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.
|
|
3473
3387
|
* @param {ExecuteJoggingRequest} executeJoggingRequest
|
|
3474
3388
|
* @param {*} [options] Override http request option.
|
|
3475
3389
|
* @throws {RequiredError}
|
|
3476
3390
|
* @memberof JoggingApi
|
|
3477
3391
|
*/
|
|
3478
|
-
executeJogging(cell,
|
|
3479
|
-
return JoggingApiFp(this.configuration).executeJogging(cell,
|
|
3392
|
+
executeJogging(cell, executeJoggingRequest, options) {
|
|
3393
|
+
return JoggingApiFp(this.configuration).executeJogging(cell, executeJoggingRequest, options).then((request) => request(this.axios, this.basePath));
|
|
3480
3394
|
}
|
|
3481
3395
|
}
|
|
3482
3396
|
/**
|
|
@@ -3888,22 +3802,18 @@ export const MotionGroupApiAxiosParamCreator = function (configuration) {
|
|
|
3888
3802
|
* Returns the current state of the selected motion group including the current joint position, velocity, pose, and more.
|
|
3889
3803
|
* @summary State
|
|
3890
3804
|
* @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.
|
|
3892
3805
|
* @param {string} motionGroup The motion-group identifier.
|
|
3893
3806
|
* @param {string} [responseCoordinateSystem] Unique identifier addressing a coordinate system to which the responses should be converted. If not set, world coordinate system is used.
|
|
3894
3807
|
* @param {*} [options] Override http request option.
|
|
3895
3808
|
* @throws {RequiredError}
|
|
3896
3809
|
*/
|
|
3897
|
-
getCurrentMotionGroupState: async (cell,
|
|
3810
|
+
getCurrentMotionGroupState: async (cell, motionGroup, responseCoordinateSystem, options = {}) => {
|
|
3898
3811
|
// verify required parameter 'cell' is not null or undefined
|
|
3899
3812
|
assertParamExists('getCurrentMotionGroupState', 'cell', cell);
|
|
3900
|
-
// verify required parameter 'controller' is not null or undefined
|
|
3901
|
-
assertParamExists('getCurrentMotionGroupState', 'controller', controller);
|
|
3902
3813
|
// verify required parameter 'motionGroup' is not null or undefined
|
|
3903
3814
|
assertParamExists('getCurrentMotionGroupState', 'motionGroup', motionGroup);
|
|
3904
|
-
const localVarPath = `/cells/{cell}/
|
|
3815
|
+
const localVarPath = `/cells/{cell}/motion-groups/{motion-group}/state`
|
|
3905
3816
|
.replace(`{${"cell"}}`, encodeURIComponent(String(cell)))
|
|
3906
|
-
.replace(`{${"controller"}}`, encodeURIComponent(String(controller)))
|
|
3907
3817
|
.replace(`{${"motion-group"}}`, encodeURIComponent(String(motionGroup)));
|
|
3908
3818
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
3909
3819
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
@@ -3935,21 +3845,17 @@ export const MotionGroupApiAxiosParamCreator = function (configuration) {
|
|
|
3935
3845
|
* 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.
|
|
3936
3846
|
* @summary Description
|
|
3937
3847
|
* @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.
|
|
3939
3848
|
* @param {string} motionGroup The motion-group identifier.
|
|
3940
3849
|
* @param {*} [options] Override http request option.
|
|
3941
3850
|
* @throws {RequiredError}
|
|
3942
3851
|
*/
|
|
3943
|
-
getMotionGroupDescription: async (cell,
|
|
3852
|
+
getMotionGroupDescription: async (cell, motionGroup, options = {}) => {
|
|
3944
3853
|
// verify required parameter 'cell' is not null or undefined
|
|
3945
3854
|
assertParamExists('getMotionGroupDescription', 'cell', cell);
|
|
3946
|
-
// verify required parameter 'controller' is not null or undefined
|
|
3947
|
-
assertParamExists('getMotionGroupDescription', 'controller', controller);
|
|
3948
3855
|
// verify required parameter 'motionGroup' is not null or undefined
|
|
3949
3856
|
assertParamExists('getMotionGroupDescription', 'motionGroup', motionGroup);
|
|
3950
|
-
const localVarPath = `/cells/{cell}/
|
|
3857
|
+
const localVarPath = `/cells/{cell}/motion-groups/{motion-group}/description`
|
|
3951
3858
|
.replace(`{${"cell"}}`, encodeURIComponent(String(cell)))
|
|
3952
|
-
.replace(`{${"controller"}}`, encodeURIComponent(String(controller)))
|
|
3953
3859
|
.replace(`{${"motion-group"}}`, encodeURIComponent(String(motionGroup)));
|
|
3954
3860
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
3955
3861
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
@@ -3978,23 +3884,19 @@ export const MotionGroupApiAxiosParamCreator = function (configuration) {
|
|
|
3978
3884
|
* <!-- theme: danger --> > Websocket endpoint Receive updates of the motion group state. The stream will be closed from the server if the controller is disconnected.
|
|
3979
3885
|
* @summary Stream State
|
|
3980
3886
|
* @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.
|
|
3982
3887
|
* @param {string} motionGroup The motion-group identifier.
|
|
3983
3888
|
* @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\'s step rate as well. Minimal response rate is the step rate of controller.
|
|
3984
3889
|
* @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.
|
|
3985
3890
|
* @param {*} [options] Override http request option.
|
|
3986
3891
|
* @throws {RequiredError}
|
|
3987
3892
|
*/
|
|
3988
|
-
streamMotionGroupState: async (cell,
|
|
3893
|
+
streamMotionGroupState: async (cell, motionGroup, responseRate, responseCoordinateSystem, options = {}) => {
|
|
3989
3894
|
// verify required parameter 'cell' is not null or undefined
|
|
3990
3895
|
assertParamExists('streamMotionGroupState', 'cell', cell);
|
|
3991
|
-
// verify required parameter 'controller' is not null or undefined
|
|
3992
|
-
assertParamExists('streamMotionGroupState', 'controller', controller);
|
|
3993
3896
|
// verify required parameter 'motionGroup' is not null or undefined
|
|
3994
3897
|
assertParamExists('streamMotionGroupState', 'motionGroup', motionGroup);
|
|
3995
|
-
const localVarPath = `/cells/{cell}/
|
|
3898
|
+
const localVarPath = `/cells/{cell}/motion-groups/{motion-group}/state-stream`
|
|
3996
3899
|
.replace(`{${"cell"}}`, encodeURIComponent(String(cell)))
|
|
3997
|
-
.replace(`{${"controller"}}`, encodeURIComponent(String(controller)))
|
|
3998
3900
|
.replace(`{${"motion-group"}}`, encodeURIComponent(String(motionGroup)));
|
|
3999
3901
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
4000
3902
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
@@ -4038,14 +3940,13 @@ export const MotionGroupApiFp = function (configuration) {
|
|
|
4038
3940
|
* Returns the current state of the selected motion group including the current joint position, velocity, pose, and more.
|
|
4039
3941
|
* @summary State
|
|
4040
3942
|
* @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.
|
|
4042
3943
|
* @param {string} motionGroup The motion-group identifier.
|
|
4043
3944
|
* @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
3945
|
* @param {*} [options] Override http request option.
|
|
4045
3946
|
* @throws {RequiredError}
|
|
4046
3947
|
*/
|
|
4047
|
-
async getCurrentMotionGroupState(cell,
|
|
4048
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.getCurrentMotionGroupState(cell,
|
|
3948
|
+
async getCurrentMotionGroupState(cell, motionGroup, responseCoordinateSystem, options) {
|
|
3949
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.getCurrentMotionGroupState(cell, motionGroup, responseCoordinateSystem, options);
|
|
4049
3950
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
4050
3951
|
const localVarOperationServerBasePath = operationServerMap['MotionGroupApi.getCurrentMotionGroupState']?.[localVarOperationServerIndex]?.url;
|
|
4051
3952
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
@@ -4054,13 +3955,12 @@ export const MotionGroupApiFp = function (configuration) {
|
|
|
4054
3955
|
* 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.
|
|
4055
3956
|
* @summary Description
|
|
4056
3957
|
* @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.
|
|
4058
3958
|
* @param {string} motionGroup The motion-group identifier.
|
|
4059
3959
|
* @param {*} [options] Override http request option.
|
|
4060
3960
|
* @throws {RequiredError}
|
|
4061
3961
|
*/
|
|
4062
|
-
async getMotionGroupDescription(cell,
|
|
4063
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.getMotionGroupDescription(cell,
|
|
3962
|
+
async getMotionGroupDescription(cell, motionGroup, options) {
|
|
3963
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.getMotionGroupDescription(cell, motionGroup, options);
|
|
4064
3964
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
4065
3965
|
const localVarOperationServerBasePath = operationServerMap['MotionGroupApi.getMotionGroupDescription']?.[localVarOperationServerIndex]?.url;
|
|
4066
3966
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
@@ -4069,15 +3969,14 @@ export const MotionGroupApiFp = function (configuration) {
|
|
|
4069
3969
|
* <!-- theme: danger --> > Websocket endpoint Receive updates of the motion group state. The stream will be closed from the server if the controller is disconnected.
|
|
4070
3970
|
* @summary Stream State
|
|
4071
3971
|
* @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.
|
|
4073
3972
|
* @param {string} motionGroup The motion-group identifier.
|
|
4074
3973
|
* @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\'s step rate as well. Minimal response rate is the step rate of controller.
|
|
4075
3974
|
* @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.
|
|
4076
3975
|
* @param {*} [options] Override http request option.
|
|
4077
3976
|
* @throws {RequiredError}
|
|
4078
3977
|
*/
|
|
4079
|
-
async streamMotionGroupState(cell,
|
|
4080
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.streamMotionGroupState(cell,
|
|
3978
|
+
async streamMotionGroupState(cell, motionGroup, responseRate, responseCoordinateSystem, options) {
|
|
3979
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.streamMotionGroupState(cell, motionGroup, responseRate, responseCoordinateSystem, options);
|
|
4081
3980
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
4082
3981
|
const localVarOperationServerBasePath = operationServerMap['MotionGroupApi.streamMotionGroupState']?.[localVarOperationServerIndex]?.url;
|
|
4083
3982
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
@@ -4095,40 +3994,37 @@ export const MotionGroupApiFactory = function (configuration, basePath, axios) {
|
|
|
4095
3994
|
* Returns the current state of the selected motion group including the current joint position, velocity, pose, and more.
|
|
4096
3995
|
* @summary State
|
|
4097
3996
|
* @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.
|
|
4099
3997
|
* @param {string} motionGroup The motion-group identifier.
|
|
4100
3998
|
* @param {string} [responseCoordinateSystem] Unique identifier addressing a coordinate system to which the responses should be converted. If not set, world coordinate system is used.
|
|
4101
3999
|
* @param {*} [options] Override http request option.
|
|
4102
4000
|
* @throws {RequiredError}
|
|
4103
4001
|
*/
|
|
4104
|
-
getCurrentMotionGroupState(cell,
|
|
4105
|
-
return localVarFp.getCurrentMotionGroupState(cell,
|
|
4002
|
+
getCurrentMotionGroupState(cell, motionGroup, responseCoordinateSystem, options) {
|
|
4003
|
+
return localVarFp.getCurrentMotionGroupState(cell, motionGroup, responseCoordinateSystem, options).then((request) => request(axios, basePath));
|
|
4106
4004
|
},
|
|
4107
4005
|
/**
|
|
4108
4006
|
* 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.
|
|
4109
4007
|
* @summary Description
|
|
4110
4008
|
* @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.
|
|
4112
4009
|
* @param {string} motionGroup The motion-group identifier.
|
|
4113
4010
|
* @param {*} [options] Override http request option.
|
|
4114
4011
|
* @throws {RequiredError}
|
|
4115
4012
|
*/
|
|
4116
|
-
getMotionGroupDescription(cell,
|
|
4117
|
-
return localVarFp.getMotionGroupDescription(cell,
|
|
4013
|
+
getMotionGroupDescription(cell, motionGroup, options) {
|
|
4014
|
+
return localVarFp.getMotionGroupDescription(cell, motionGroup, options).then((request) => request(axios, basePath));
|
|
4118
4015
|
},
|
|
4119
4016
|
/**
|
|
4120
4017
|
* <!-- theme: danger --> > Websocket endpoint Receive updates of the motion group state. The stream will be closed from the server if the controller is disconnected.
|
|
4121
4018
|
* @summary Stream State
|
|
4122
4019
|
* @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.
|
|
4124
4020
|
* @param {string} motionGroup The motion-group identifier.
|
|
4125
4021
|
* @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\'s step rate as well. Minimal response rate is the step rate of controller.
|
|
4126
4022
|
* @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.
|
|
4127
4023
|
* @param {*} [options] Override http request option.
|
|
4128
4024
|
* @throws {RequiredError}
|
|
4129
4025
|
*/
|
|
4130
|
-
streamMotionGroupState(cell,
|
|
4131
|
-
return localVarFp.streamMotionGroupState(cell,
|
|
4026
|
+
streamMotionGroupState(cell, motionGroup, responseRate, responseCoordinateSystem, options) {
|
|
4027
|
+
return localVarFp.streamMotionGroupState(cell, motionGroup, responseRate, responseCoordinateSystem, options).then((request) => request(axios, basePath));
|
|
4132
4028
|
},
|
|
4133
4029
|
};
|
|
4134
4030
|
};
|
|
@@ -4143,34 +4039,31 @@ export class MotionGroupApi extends BaseAPI {
|
|
|
4143
4039
|
* Returns the current state of the selected motion group including the current joint position, velocity, pose, and more.
|
|
4144
4040
|
* @summary State
|
|
4145
4041
|
* @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.
|
|
4147
4042
|
* @param {string} motionGroup The motion-group identifier.
|
|
4148
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.
|
|
4149
4044
|
* @param {*} [options] Override http request option.
|
|
4150
4045
|
* @throws {RequiredError}
|
|
4151
4046
|
* @memberof MotionGroupApi
|
|
4152
4047
|
*/
|
|
4153
|
-
getCurrentMotionGroupState(cell,
|
|
4154
|
-
return MotionGroupApiFp(this.configuration).getCurrentMotionGroupState(cell,
|
|
4048
|
+
getCurrentMotionGroupState(cell, motionGroup, responseCoordinateSystem, options) {
|
|
4049
|
+
return MotionGroupApiFp(this.configuration).getCurrentMotionGroupState(cell, motionGroup, responseCoordinateSystem, options).then((request) => request(this.axios, this.basePath));
|
|
4155
4050
|
}
|
|
4156
4051
|
/**
|
|
4157
4052
|
* 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.
|
|
4158
4053
|
* @summary Description
|
|
4159
4054
|
* @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.
|
|
4161
4055
|
* @param {string} motionGroup The motion-group identifier.
|
|
4162
4056
|
* @param {*} [options] Override http request option.
|
|
4163
4057
|
* @throws {RequiredError}
|
|
4164
4058
|
* @memberof MotionGroupApi
|
|
4165
4059
|
*/
|
|
4166
|
-
getMotionGroupDescription(cell,
|
|
4167
|
-
return MotionGroupApiFp(this.configuration).getMotionGroupDescription(cell,
|
|
4060
|
+
getMotionGroupDescription(cell, motionGroup, options) {
|
|
4061
|
+
return MotionGroupApiFp(this.configuration).getMotionGroupDescription(cell, motionGroup, options).then((request) => request(this.axios, this.basePath));
|
|
4168
4062
|
}
|
|
4169
4063
|
/**
|
|
4170
4064
|
* <!-- theme: danger --> > Websocket endpoint Receive updates of the motion group state. The stream will be closed from the server if the controller is disconnected.
|
|
4171
4065
|
* @summary Stream State
|
|
4172
4066
|
* @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.
|
|
4174
4067
|
* @param {string} motionGroup The motion-group identifier.
|
|
4175
4068
|
* @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\'s step rate as well. Minimal response rate is the step rate of controller.
|
|
4176
4069
|
* @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.
|
|
@@ -4178,8 +4071,8 @@ export class MotionGroupApi extends BaseAPI {
|
|
|
4178
4071
|
* @throws {RequiredError}
|
|
4179
4072
|
* @memberof MotionGroupApi
|
|
4180
4073
|
*/
|
|
4181
|
-
streamMotionGroupState(cell,
|
|
4182
|
-
return MotionGroupApiFp(this.configuration).streamMotionGroupState(cell,
|
|
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));
|
|
4183
4076
|
}
|
|
4184
4077
|
}
|
|
4185
4078
|
/**
|
|
@@ -6805,21 +6698,17 @@ export const TrajectoryCachingApiAxiosParamCreator = function (configuration) {
|
|
|
6805
6698
|
* <!-- 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.
|
|
6806
6699
|
* @summary Add Trajectory
|
|
6807
6700
|
* @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.
|
|
6809
6701
|
* @param {AddTrajectoryRequest} addTrajectoryRequest
|
|
6810
6702
|
* @param {*} [options] Override http request option.
|
|
6811
6703
|
* @throws {RequiredError}
|
|
6812
6704
|
*/
|
|
6813
|
-
addTrajectory: async (cell,
|
|
6705
|
+
addTrajectory: async (cell, addTrajectoryRequest, options = {}) => {
|
|
6814
6706
|
// verify required parameter 'cell' is not null or undefined
|
|
6815
6707
|
assertParamExists('addTrajectory', 'cell', cell);
|
|
6816
|
-
// verify required parameter 'controller' is not null or undefined
|
|
6817
|
-
assertParamExists('addTrajectory', 'controller', controller);
|
|
6818
6708
|
// verify required parameter 'addTrajectoryRequest' is not null or undefined
|
|
6819
6709
|
assertParamExists('addTrajectory', 'addTrajectoryRequest', addTrajectoryRequest);
|
|
6820
|
-
const localVarPath = `/cells/{cell}/
|
|
6821
|
-
.replace(`{${"cell"}}`, encodeURIComponent(String(cell)))
|
|
6822
|
-
.replace(`{${"controller"}}`, encodeURIComponent(String(controller)));
|
|
6710
|
+
const localVarPath = `/cells/{cell}/trajectories`
|
|
6711
|
+
.replace(`{${"cell"}}`, encodeURIComponent(String(cell)));
|
|
6823
6712
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
6824
6713
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
6825
6714
|
let baseOptions;
|
|
@@ -6849,18 +6738,14 @@ export const TrajectoryCachingApiAxiosParamCreator = function (configuration) {
|
|
|
6849
6738
|
* Clear the trajectory cache.
|
|
6850
6739
|
* @summary Clear Trajectories
|
|
6851
6740
|
* @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.
|
|
6853
6741
|
* @param {*} [options] Override http request option.
|
|
6854
6742
|
* @throws {RequiredError}
|
|
6855
6743
|
*/
|
|
6856
|
-
clearTrajectories: async (cell,
|
|
6744
|
+
clearTrajectories: async (cell, options = {}) => {
|
|
6857
6745
|
// verify required parameter 'cell' is not null or undefined
|
|
6858
6746
|
assertParamExists('clearTrajectories', 'cell', cell);
|
|
6859
|
-
|
|
6860
|
-
|
|
6861
|
-
const localVarPath = `/cells/{cell}/controllers/{controller}/trajectories`
|
|
6862
|
-
.replace(`{${"cell"}}`, encodeURIComponent(String(cell)))
|
|
6863
|
-
.replace(`{${"controller"}}`, encodeURIComponent(String(controller)));
|
|
6747
|
+
const localVarPath = `/cells/{cell}/trajectories`
|
|
6748
|
+
.replace(`{${"cell"}}`, encodeURIComponent(String(cell)));
|
|
6864
6749
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
6865
6750
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
6866
6751
|
let baseOptions;
|
|
@@ -6888,21 +6773,17 @@ export const TrajectoryCachingApiAxiosParamCreator = function (configuration) {
|
|
|
6888
6773
|
* 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.
|
|
6889
6774
|
* @summary Delete Trajectory
|
|
6890
6775
|
* @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.
|
|
6892
6776
|
* @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.
|
|
6893
6777
|
* @param {*} [options] Override http request option.
|
|
6894
6778
|
* @throws {RequiredError}
|
|
6895
6779
|
*/
|
|
6896
|
-
deleteTrajectory: async (cell,
|
|
6780
|
+
deleteTrajectory: async (cell, trajectory, options = {}) => {
|
|
6897
6781
|
// verify required parameter 'cell' is not null or undefined
|
|
6898
6782
|
assertParamExists('deleteTrajectory', 'cell', cell);
|
|
6899
|
-
// verify required parameter 'controller' is not null or undefined
|
|
6900
|
-
assertParamExists('deleteTrajectory', 'controller', controller);
|
|
6901
6783
|
// verify required parameter 'trajectory' is not null or undefined
|
|
6902
6784
|
assertParamExists('deleteTrajectory', 'trajectory', trajectory);
|
|
6903
|
-
const localVarPath = `/cells/{cell}/
|
|
6785
|
+
const localVarPath = `/cells/{cell}/trajectories/{trajectory}`
|
|
6904
6786
|
.replace(`{${"cell"}}`, encodeURIComponent(String(cell)))
|
|
6905
|
-
.replace(`{${"controller"}}`, encodeURIComponent(String(controller)))
|
|
6906
6787
|
.replace(`{${"trajectory"}}`, encodeURIComponent(String(trajectory)));
|
|
6907
6788
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
6908
6789
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
@@ -6931,21 +6812,17 @@ export const TrajectoryCachingApiAxiosParamCreator = function (configuration) {
|
|
|
6931
6812
|
* Get a previously created trajectory from cache. Use [listTrajectories](listTrajectories) to list all cached trajectories.
|
|
6932
6813
|
* @summary Get Trajectory
|
|
6933
6814
|
* @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.
|
|
6935
6815
|
* @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.
|
|
6936
6816
|
* @param {*} [options] Override http request option.
|
|
6937
6817
|
* @throws {RequiredError}
|
|
6938
6818
|
*/
|
|
6939
|
-
getTrajectory: async (cell,
|
|
6819
|
+
getTrajectory: async (cell, trajectory, options = {}) => {
|
|
6940
6820
|
// verify required parameter 'cell' is not null or undefined
|
|
6941
6821
|
assertParamExists('getTrajectory', 'cell', cell);
|
|
6942
|
-
// verify required parameter 'controller' is not null or undefined
|
|
6943
|
-
assertParamExists('getTrajectory', 'controller', controller);
|
|
6944
6822
|
// verify required parameter 'trajectory' is not null or undefined
|
|
6945
6823
|
assertParamExists('getTrajectory', 'trajectory', trajectory);
|
|
6946
|
-
const localVarPath = `/cells/{cell}/
|
|
6824
|
+
const localVarPath = `/cells/{cell}/trajectories/{trajectory}`
|
|
6947
6825
|
.replace(`{${"cell"}}`, encodeURIComponent(String(cell)))
|
|
6948
|
-
.replace(`{${"controller"}}`, encodeURIComponent(String(controller)))
|
|
6949
6826
|
.replace(`{${"trajectory"}}`, encodeURIComponent(String(trajectory)));
|
|
6950
6827
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
6951
6828
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
@@ -6974,18 +6851,14 @@ export const TrajectoryCachingApiAxiosParamCreator = function (configuration) {
|
|
|
6974
6851
|
* 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.
|
|
6975
6852
|
* @summary List Trajectories
|
|
6976
6853
|
* @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.
|
|
6978
6854
|
* @param {*} [options] Override http request option.
|
|
6979
6855
|
* @throws {RequiredError}
|
|
6980
6856
|
*/
|
|
6981
|
-
listTrajectories: async (cell,
|
|
6857
|
+
listTrajectories: async (cell, options = {}) => {
|
|
6982
6858
|
// verify required parameter 'cell' is not null or undefined
|
|
6983
6859
|
assertParamExists('listTrajectories', 'cell', cell);
|
|
6984
|
-
|
|
6985
|
-
|
|
6986
|
-
const localVarPath = `/cells/{cell}/controllers/{controller}/trajectories`
|
|
6987
|
-
.replace(`{${"cell"}}`, encodeURIComponent(String(cell)))
|
|
6988
|
-
.replace(`{${"controller"}}`, encodeURIComponent(String(controller)));
|
|
6860
|
+
const localVarPath = `/cells/{cell}/trajectories`
|
|
6861
|
+
.replace(`{${"cell"}}`, encodeURIComponent(String(cell)));
|
|
6989
6862
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
6990
6863
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
6991
6864
|
let baseOptions;
|
|
@@ -7022,13 +6895,12 @@ export const TrajectoryCachingApiFp = function (configuration) {
|
|
|
7022
6895
|
* <!-- 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.
|
|
7023
6896
|
* @summary Add Trajectory
|
|
7024
6897
|
* @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.
|
|
7026
6898
|
* @param {AddTrajectoryRequest} addTrajectoryRequest
|
|
7027
6899
|
* @param {*} [options] Override http request option.
|
|
7028
6900
|
* @throws {RequiredError}
|
|
7029
6901
|
*/
|
|
7030
|
-
async addTrajectory(cell,
|
|
7031
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.addTrajectory(cell,
|
|
6902
|
+
async addTrajectory(cell, addTrajectoryRequest, options) {
|
|
6903
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.addTrajectory(cell, addTrajectoryRequest, options);
|
|
7032
6904
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
7033
6905
|
const localVarOperationServerBasePath = operationServerMap['TrajectoryCachingApi.addTrajectory']?.[localVarOperationServerIndex]?.url;
|
|
7034
6906
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
@@ -7037,12 +6909,11 @@ export const TrajectoryCachingApiFp = function (configuration) {
|
|
|
7037
6909
|
* Clear the trajectory cache.
|
|
7038
6910
|
* @summary Clear Trajectories
|
|
7039
6911
|
* @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.
|
|
7041
6912
|
* @param {*} [options] Override http request option.
|
|
7042
6913
|
* @throws {RequiredError}
|
|
7043
6914
|
*/
|
|
7044
|
-
async clearTrajectories(cell,
|
|
7045
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.clearTrajectories(cell,
|
|
6915
|
+
async clearTrajectories(cell, options) {
|
|
6916
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.clearTrajectories(cell, options);
|
|
7046
6917
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
7047
6918
|
const localVarOperationServerBasePath = operationServerMap['TrajectoryCachingApi.clearTrajectories']?.[localVarOperationServerIndex]?.url;
|
|
7048
6919
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
@@ -7051,13 +6922,12 @@ export const TrajectoryCachingApiFp = function (configuration) {
|
|
|
7051
6922
|
* 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.
|
|
7052
6923
|
* @summary Delete Trajectory
|
|
7053
6924
|
* @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.
|
|
7055
6925
|
* @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.
|
|
7056
6926
|
* @param {*} [options] Override http request option.
|
|
7057
6927
|
* @throws {RequiredError}
|
|
7058
6928
|
*/
|
|
7059
|
-
async deleteTrajectory(cell,
|
|
7060
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.deleteTrajectory(cell,
|
|
6929
|
+
async deleteTrajectory(cell, trajectory, options) {
|
|
6930
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.deleteTrajectory(cell, trajectory, options);
|
|
7061
6931
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
7062
6932
|
const localVarOperationServerBasePath = operationServerMap['TrajectoryCachingApi.deleteTrajectory']?.[localVarOperationServerIndex]?.url;
|
|
7063
6933
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
@@ -7066,13 +6936,12 @@ export const TrajectoryCachingApiFp = function (configuration) {
|
|
|
7066
6936
|
* Get a previously created trajectory from cache. Use [listTrajectories](listTrajectories) to list all cached trajectories.
|
|
7067
6937
|
* @summary Get Trajectory
|
|
7068
6938
|
* @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.
|
|
7070
6939
|
* @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.
|
|
7071
6940
|
* @param {*} [options] Override http request option.
|
|
7072
6941
|
* @throws {RequiredError}
|
|
7073
6942
|
*/
|
|
7074
|
-
async getTrajectory(cell,
|
|
7075
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.getTrajectory(cell,
|
|
6943
|
+
async getTrajectory(cell, trajectory, options) {
|
|
6944
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.getTrajectory(cell, trajectory, options);
|
|
7076
6945
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
7077
6946
|
const localVarOperationServerBasePath = operationServerMap['TrajectoryCachingApi.getTrajectory']?.[localVarOperationServerIndex]?.url;
|
|
7078
6947
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
@@ -7081,12 +6950,11 @@ export const TrajectoryCachingApiFp = function (configuration) {
|
|
|
7081
6950
|
* 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
6951
|
* @summary List Trajectories
|
|
7083
6952
|
* @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.
|
|
7085
6953
|
* @param {*} [options] Override http request option.
|
|
7086
6954
|
* @throws {RequiredError}
|
|
7087
6955
|
*/
|
|
7088
|
-
async listTrajectories(cell,
|
|
7089
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.listTrajectories(cell,
|
|
6956
|
+
async listTrajectories(cell, options) {
|
|
6957
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.listTrajectories(cell, options);
|
|
7090
6958
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
7091
6959
|
const localVarOperationServerBasePath = operationServerMap['TrajectoryCachingApi.listTrajectories']?.[localVarOperationServerIndex]?.url;
|
|
7092
6960
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
@@ -7104,59 +6972,54 @@ export const TrajectoryCachingApiFactory = function (configuration, basePath, ax
|
|
|
7104
6972
|
* <!-- 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.
|
|
7105
6973
|
* @summary Add Trajectory
|
|
7106
6974
|
* @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.
|
|
7108
6975
|
* @param {AddTrajectoryRequest} addTrajectoryRequest
|
|
7109
6976
|
* @param {*} [options] Override http request option.
|
|
7110
6977
|
* @throws {RequiredError}
|
|
7111
6978
|
*/
|
|
7112
|
-
addTrajectory(cell,
|
|
7113
|
-
return localVarFp.addTrajectory(cell,
|
|
6979
|
+
addTrajectory(cell, addTrajectoryRequest, options) {
|
|
6980
|
+
return localVarFp.addTrajectory(cell, addTrajectoryRequest, options).then((request) => request(axios, basePath));
|
|
7114
6981
|
},
|
|
7115
6982
|
/**
|
|
7116
6983
|
* Clear the trajectory cache.
|
|
7117
6984
|
* @summary Clear Trajectories
|
|
7118
6985
|
* @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.
|
|
7120
6986
|
* @param {*} [options] Override http request option.
|
|
7121
6987
|
* @throws {RequiredError}
|
|
7122
6988
|
*/
|
|
7123
|
-
clearTrajectories(cell,
|
|
7124
|
-
return localVarFp.clearTrajectories(cell,
|
|
6989
|
+
clearTrajectories(cell, options) {
|
|
6990
|
+
return localVarFp.clearTrajectories(cell, options).then((request) => request(axios, basePath));
|
|
7125
6991
|
},
|
|
7126
6992
|
/**
|
|
7127
6993
|
* 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.
|
|
7128
6994
|
* @summary Delete Trajectory
|
|
7129
6995
|
* @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.
|
|
7131
6996
|
* @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.
|
|
7132
6997
|
* @param {*} [options] Override http request option.
|
|
7133
6998
|
* @throws {RequiredError}
|
|
7134
6999
|
*/
|
|
7135
|
-
deleteTrajectory(cell,
|
|
7136
|
-
return localVarFp.deleteTrajectory(cell,
|
|
7000
|
+
deleteTrajectory(cell, trajectory, options) {
|
|
7001
|
+
return localVarFp.deleteTrajectory(cell, trajectory, options).then((request) => request(axios, basePath));
|
|
7137
7002
|
},
|
|
7138
7003
|
/**
|
|
7139
7004
|
* Get a previously created trajectory from cache. Use [listTrajectories](listTrajectories) to list all cached trajectories.
|
|
7140
7005
|
* @summary Get Trajectory
|
|
7141
7006
|
* @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.
|
|
7143
7007
|
* @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.
|
|
7144
7008
|
* @param {*} [options] Override http request option.
|
|
7145
7009
|
* @throws {RequiredError}
|
|
7146
7010
|
*/
|
|
7147
|
-
getTrajectory(cell,
|
|
7148
|
-
return localVarFp.getTrajectory(cell,
|
|
7011
|
+
getTrajectory(cell, trajectory, options) {
|
|
7012
|
+
return localVarFp.getTrajectory(cell, trajectory, options).then((request) => request(axios, basePath));
|
|
7149
7013
|
},
|
|
7150
7014
|
/**
|
|
7151
7015
|
* 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.
|
|
7152
7016
|
* @summary List Trajectories
|
|
7153
7017
|
* @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.
|
|
7155
7018
|
* @param {*} [options] Override http request option.
|
|
7156
7019
|
* @throws {RequiredError}
|
|
7157
7020
|
*/
|
|
7158
|
-
listTrajectories(cell,
|
|
7159
|
-
return localVarFp.listTrajectories(cell,
|
|
7021
|
+
listTrajectories(cell, options) {
|
|
7022
|
+
return localVarFp.listTrajectories(cell, options).then((request) => request(axios, basePath));
|
|
7160
7023
|
},
|
|
7161
7024
|
};
|
|
7162
7025
|
};
|
|
@@ -7171,64 +7034,59 @@ export class TrajectoryCachingApi extends BaseAPI {
|
|
|
7171
7034
|
* <!-- 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.
|
|
7172
7035
|
* @summary Add Trajectory
|
|
7173
7036
|
* @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.
|
|
7175
7037
|
* @param {AddTrajectoryRequest} addTrajectoryRequest
|
|
7176
7038
|
* @param {*} [options] Override http request option.
|
|
7177
7039
|
* @throws {RequiredError}
|
|
7178
7040
|
* @memberof TrajectoryCachingApi
|
|
7179
7041
|
*/
|
|
7180
|
-
addTrajectory(cell,
|
|
7181
|
-
return TrajectoryCachingApiFp(this.configuration).addTrajectory(cell,
|
|
7042
|
+
addTrajectory(cell, addTrajectoryRequest, options) {
|
|
7043
|
+
return TrajectoryCachingApiFp(this.configuration).addTrajectory(cell, addTrajectoryRequest, options).then((request) => request(this.axios, this.basePath));
|
|
7182
7044
|
}
|
|
7183
7045
|
/**
|
|
7184
7046
|
* Clear the trajectory cache.
|
|
7185
7047
|
* @summary Clear Trajectories
|
|
7186
7048
|
* @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.
|
|
7188
7049
|
* @param {*} [options] Override http request option.
|
|
7189
7050
|
* @throws {RequiredError}
|
|
7190
7051
|
* @memberof TrajectoryCachingApi
|
|
7191
7052
|
*/
|
|
7192
|
-
clearTrajectories(cell,
|
|
7193
|
-
return TrajectoryCachingApiFp(this.configuration).clearTrajectories(cell,
|
|
7053
|
+
clearTrajectories(cell, options) {
|
|
7054
|
+
return TrajectoryCachingApiFp(this.configuration).clearTrajectories(cell, options).then((request) => request(this.axios, this.basePath));
|
|
7194
7055
|
}
|
|
7195
7056
|
/**
|
|
7196
7057
|
* 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.
|
|
7197
7058
|
* @summary Delete Trajectory
|
|
7198
7059
|
* @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.
|
|
7200
7060
|
* @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.
|
|
7201
7061
|
* @param {*} [options] Override http request option.
|
|
7202
7062
|
* @throws {RequiredError}
|
|
7203
7063
|
* @memberof TrajectoryCachingApi
|
|
7204
7064
|
*/
|
|
7205
|
-
deleteTrajectory(cell,
|
|
7206
|
-
return TrajectoryCachingApiFp(this.configuration).deleteTrajectory(cell,
|
|
7065
|
+
deleteTrajectory(cell, trajectory, options) {
|
|
7066
|
+
return TrajectoryCachingApiFp(this.configuration).deleteTrajectory(cell, trajectory, options).then((request) => request(this.axios, this.basePath));
|
|
7207
7067
|
}
|
|
7208
7068
|
/**
|
|
7209
7069
|
* Get a previously created trajectory from cache. Use [listTrajectories](listTrajectories) to list all cached trajectories.
|
|
7210
7070
|
* @summary Get Trajectory
|
|
7211
7071
|
* @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.
|
|
7213
7072
|
* @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.
|
|
7214
7073
|
* @param {*} [options] Override http request option.
|
|
7215
7074
|
* @throws {RequiredError}
|
|
7216
7075
|
* @memberof TrajectoryCachingApi
|
|
7217
7076
|
*/
|
|
7218
|
-
getTrajectory(cell,
|
|
7219
|
-
return TrajectoryCachingApiFp(this.configuration).getTrajectory(cell,
|
|
7077
|
+
getTrajectory(cell, trajectory, options) {
|
|
7078
|
+
return TrajectoryCachingApiFp(this.configuration).getTrajectory(cell, trajectory, options).then((request) => request(this.axios, this.basePath));
|
|
7220
7079
|
}
|
|
7221
7080
|
/**
|
|
7222
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.
|
|
7223
7082
|
* @summary List Trajectories
|
|
7224
7083
|
* @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.
|
|
7226
7084
|
* @param {*} [options] Override http request option.
|
|
7227
7085
|
* @throws {RequiredError}
|
|
7228
7086
|
* @memberof TrajectoryCachingApi
|
|
7229
7087
|
*/
|
|
7230
|
-
listTrajectories(cell,
|
|
7231
|
-
return TrajectoryCachingApiFp(this.configuration).listTrajectories(cell,
|
|
7088
|
+
listTrajectories(cell, options) {
|
|
7089
|
+
return TrajectoryCachingApiFp(this.configuration).listTrajectories(cell, options).then((request) => request(this.axios, this.basePath));
|
|
7232
7090
|
}
|
|
7233
7091
|
}
|
|
7234
7092
|
/**
|
|
@@ -7241,21 +7099,17 @@ export const TrajectoryExecutionApiAxiosParamCreator = function (configuration)
|
|
|
7241
7099
|
* <!-- 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.
|
|
7242
7100
|
* @summary Execute Trajectory
|
|
7243
7101
|
* @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.
|
|
7245
7102
|
* @param {ExecuteTrajectoryRequest} executeTrajectoryRequest
|
|
7246
7103
|
* @param {*} [options] Override http request option.
|
|
7247
7104
|
* @throws {RequiredError}
|
|
7248
7105
|
*/
|
|
7249
|
-
executeTrajectory: async (cell,
|
|
7106
|
+
executeTrajectory: async (cell, executeTrajectoryRequest, options = {}) => {
|
|
7250
7107
|
// verify required parameter 'cell' is not null or undefined
|
|
7251
7108
|
assertParamExists('executeTrajectory', 'cell', cell);
|
|
7252
|
-
// verify required parameter 'controller' is not null or undefined
|
|
7253
|
-
assertParamExists('executeTrajectory', 'controller', controller);
|
|
7254
7109
|
// verify required parameter 'executeTrajectoryRequest' is not null or undefined
|
|
7255
7110
|
assertParamExists('executeTrajectory', 'executeTrajectoryRequest', executeTrajectoryRequest);
|
|
7256
|
-
const localVarPath = `/cells/{cell}/
|
|
7257
|
-
.replace(`{${"cell"}}`, encodeURIComponent(String(cell)))
|
|
7258
|
-
.replace(`{${"controller"}}`, encodeURIComponent(String(controller)));
|
|
7111
|
+
const localVarPath = `/cells/{cell}/execution/trajectory`
|
|
7112
|
+
.replace(`{${"cell"}}`, encodeURIComponent(String(cell)));
|
|
7259
7113
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
7260
7114
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
7261
7115
|
let baseOptions;
|
|
@@ -7294,13 +7148,12 @@ export const TrajectoryExecutionApiFp = function (configuration) {
|
|
|
7294
7148
|
* <!-- 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.
|
|
7295
7149
|
* @summary Execute Trajectory
|
|
7296
7150
|
* @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.
|
|
7298
7151
|
* @param {ExecuteTrajectoryRequest} executeTrajectoryRequest
|
|
7299
7152
|
* @param {*} [options] Override http request option.
|
|
7300
7153
|
* @throws {RequiredError}
|
|
7301
7154
|
*/
|
|
7302
|
-
async executeTrajectory(cell,
|
|
7303
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.executeTrajectory(cell,
|
|
7155
|
+
async executeTrajectory(cell, executeTrajectoryRequest, options) {
|
|
7156
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.executeTrajectory(cell, executeTrajectoryRequest, options);
|
|
7304
7157
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
7305
7158
|
const localVarOperationServerBasePath = operationServerMap['TrajectoryExecutionApi.executeTrajectory']?.[localVarOperationServerIndex]?.url;
|
|
7306
7159
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
@@ -7318,13 +7171,12 @@ export const TrajectoryExecutionApiFactory = function (configuration, basePath,
|
|
|
7318
7171
|
* <!-- 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.
|
|
7319
7172
|
* @summary Execute Trajectory
|
|
7320
7173
|
* @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.
|
|
7322
7174
|
* @param {ExecuteTrajectoryRequest} executeTrajectoryRequest
|
|
7323
7175
|
* @param {*} [options] Override http request option.
|
|
7324
7176
|
* @throws {RequiredError}
|
|
7325
7177
|
*/
|
|
7326
|
-
executeTrajectory(cell,
|
|
7327
|
-
return localVarFp.executeTrajectory(cell,
|
|
7178
|
+
executeTrajectory(cell, executeTrajectoryRequest, options) {
|
|
7179
|
+
return localVarFp.executeTrajectory(cell, executeTrajectoryRequest, options).then((request) => request(axios, basePath));
|
|
7328
7180
|
},
|
|
7329
7181
|
};
|
|
7330
7182
|
};
|
|
@@ -7339,14 +7191,13 @@ export class TrajectoryExecutionApi extends BaseAPI {
|
|
|
7339
7191
|
* <!-- 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.
|
|
7340
7192
|
* @summary Execute Trajectory
|
|
7341
7193
|
* @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.
|
|
7343
7194
|
* @param {ExecuteTrajectoryRequest} executeTrajectoryRequest
|
|
7344
7195
|
* @param {*} [options] Override http request option.
|
|
7345
7196
|
* @throws {RequiredError}
|
|
7346
7197
|
* @memberof TrajectoryExecutionApi
|
|
7347
7198
|
*/
|
|
7348
|
-
executeTrajectory(cell,
|
|
7349
|
-
return TrajectoryExecutionApiFp(this.configuration).executeTrajectory(cell,
|
|
7199
|
+
executeTrajectory(cell, executeTrajectoryRequest, options) {
|
|
7200
|
+
return TrajectoryExecutionApiFp(this.configuration).executeTrajectory(cell, executeTrajectoryRequest, options).then((request) => request(this.axios, this.basePath));
|
|
7350
7201
|
}
|
|
7351
7202
|
}
|
|
7352
7203
|
/**
|
|
@@ -7459,41 +7310,38 @@ export class TrajectoryPlanningApi extends BaseAPI {
|
|
|
7459
7310
|
}
|
|
7460
7311
|
}
|
|
7461
7312
|
/**
|
|
7462
|
-
*
|
|
7313
|
+
* VirtualRobotApi - axios parameter creator
|
|
7463
7314
|
* @export
|
|
7464
7315
|
*/
|
|
7465
|
-
export const
|
|
7316
|
+
export const VirtualRobotApiAxiosParamCreator = function (configuration) {
|
|
7466
7317
|
return {
|
|
7467
7318
|
/**
|
|
7468
|
-
*
|
|
7469
|
-
* @summary
|
|
7319
|
+
* Get the current motion group state which provides values for the joints\' position, velocity and acceleration.
|
|
7320
|
+
* @summary Get Motion Group State
|
|
7470
7321
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
7471
7322
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
7472
|
-
* @param {string}
|
|
7473
|
-
* @param {CoordinateSystemData} coordinateSystemData
|
|
7323
|
+
* @param {string} motionGroup The motion-group identifier.
|
|
7474
7324
|
* @param {*} [options] Override http request option.
|
|
7475
7325
|
* @throws {RequiredError}
|
|
7476
7326
|
*/
|
|
7477
|
-
|
|
7327
|
+
getMotionGroupState: async (cell, controller, motionGroup, options = {}) => {
|
|
7478
7328
|
// verify required parameter 'cell' is not null or undefined
|
|
7479
|
-
assertParamExists('
|
|
7329
|
+
assertParamExists('getMotionGroupState', 'cell', cell);
|
|
7480
7330
|
// verify required parameter 'controller' is not null or undefined
|
|
7481
|
-
assertParamExists('
|
|
7482
|
-
// verify required parameter '
|
|
7483
|
-
assertParamExists('
|
|
7484
|
-
|
|
7485
|
-
assertParamExists('addVirtualControllerCoordinateSystem', 'coordinateSystemData', coordinateSystemData);
|
|
7486
|
-
const localVarPath = `/cells/{cell}/virtual-controllers/{controller}/coordinate-systems/{coordinate-system}`
|
|
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}`
|
|
7487
7335
|
.replace(`{${"cell"}}`, encodeURIComponent(String(cell)))
|
|
7488
7336
|
.replace(`{${"controller"}}`, encodeURIComponent(String(controller)))
|
|
7489
|
-
.replace(`{${"
|
|
7337
|
+
.replace(`{${"motion-group"}}`, encodeURIComponent(String(motionGroup)));
|
|
7490
7338
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
7491
7339
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
7492
7340
|
let baseOptions;
|
|
7493
7341
|
if (configuration) {
|
|
7494
7342
|
baseOptions = configuration.baseOptions;
|
|
7495
7343
|
}
|
|
7496
|
-
const localVarRequestOptions = { method: '
|
|
7344
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options };
|
|
7497
7345
|
const localVarHeaderParameter = {};
|
|
7498
7346
|
const localVarQueryParameter = {};
|
|
7499
7347
|
// authentication BasicAuth required
|
|
@@ -7502,50 +7350,37 @@ export const VirtualControllerApiAxiosParamCreator = function (configuration) {
|
|
|
7502
7350
|
// authentication BearerAuth required
|
|
7503
7351
|
// http bearer authentication required
|
|
7504
7352
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
7505
|
-
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
7506
7353
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
7507
7354
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
7508
7355
|
localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
|
|
7509
|
-
localVarRequestOptions.data = serializeDataIfNeeded(coordinateSystemData, localVarRequestOptions, configuration);
|
|
7510
7356
|
return {
|
|
7511
7357
|
url: toPathString(localVarUrlObj),
|
|
7512
7358
|
options: localVarRequestOptions,
|
|
7513
7359
|
};
|
|
7514
7360
|
},
|
|
7515
7361
|
/**
|
|
7516
|
-
*
|
|
7517
|
-
* @summary
|
|
7362
|
+
* Gets information on the motion group.
|
|
7363
|
+
* @summary Motion Group Description
|
|
7518
7364
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
7519
7365
|
* @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
|
|
7523
7366
|
* @param {*} [options] Override http request option.
|
|
7524
7367
|
* @throws {RequiredError}
|
|
7525
7368
|
*/
|
|
7526
|
-
|
|
7369
|
+
getMotionGroups: async (cell, controller, options = {}) => {
|
|
7527
7370
|
// verify required parameter 'cell' is not null or undefined
|
|
7528
|
-
assertParamExists('
|
|
7371
|
+
assertParamExists('getMotionGroups', 'cell', cell);
|
|
7529
7372
|
// verify required parameter 'controller' is not null or undefined
|
|
7530
|
-
assertParamExists('
|
|
7531
|
-
|
|
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}`
|
|
7373
|
+
assertParamExists('getMotionGroups', 'controller', controller);
|
|
7374
|
+
const localVarPath = `/cells/{cell}/controllers/{controller}/teach-pendant/motion-groups`
|
|
7538
7375
|
.replace(`{${"cell"}}`, encodeURIComponent(String(cell)))
|
|
7539
|
-
.replace(`{${"controller"}}`, encodeURIComponent(String(controller)))
|
|
7540
|
-
.replace(`{${"motion-group"}}`, encodeURIComponent(String(motionGroup)))
|
|
7541
|
-
.replace(`{${"tcp"}}`, encodeURIComponent(String(tcp)));
|
|
7376
|
+
.replace(`{${"controller"}}`, encodeURIComponent(String(controller)));
|
|
7542
7377
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
7543
7378
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
7544
7379
|
let baseOptions;
|
|
7545
7380
|
if (configuration) {
|
|
7546
7381
|
baseOptions = configuration.baseOptions;
|
|
7547
7382
|
}
|
|
7548
|
-
const localVarRequestOptions = { method: '
|
|
7383
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options };
|
|
7549
7384
|
const localVarHeaderParameter = {};
|
|
7550
7385
|
const localVarQueryParameter = {};
|
|
7551
7386
|
// authentication BasicAuth required
|
|
@@ -7554,44 +7389,40 @@ export const VirtualControllerApiAxiosParamCreator = function (configuration) {
|
|
|
7554
7389
|
// authentication BearerAuth required
|
|
7555
7390
|
// http bearer authentication required
|
|
7556
7391
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
7557
|
-
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
7558
7392
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
7559
7393
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
7560
7394
|
localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
|
|
7561
|
-
localVarRequestOptions.data = serializeDataIfNeeded(robotTcpData, localVarRequestOptions, configuration);
|
|
7562
7395
|
return {
|
|
7563
7396
|
url: toPathString(localVarUrlObj),
|
|
7564
7397
|
options: localVarRequestOptions,
|
|
7565
7398
|
};
|
|
7566
7399
|
},
|
|
7567
7400
|
/**
|
|
7568
|
-
*
|
|
7569
|
-
* @summary
|
|
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
|
|
7570
7403
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
7571
7404
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
7572
|
-
* @param {string}
|
|
7573
|
-
* @param {boolean} [deleteDependent] If true, all dependent coordinate systems will be deleted as well.
|
|
7405
|
+
* @param {Array<string>} ios
|
|
7574
7406
|
* @param {*} [options] Override http request option.
|
|
7575
7407
|
* @throws {RequiredError}
|
|
7576
7408
|
*/
|
|
7577
|
-
|
|
7409
|
+
listIOs: async (cell, controller, ios, options = {}) => {
|
|
7578
7410
|
// verify required parameter 'cell' is not null or undefined
|
|
7579
|
-
assertParamExists('
|
|
7411
|
+
assertParamExists('listIOs', 'cell', cell);
|
|
7580
7412
|
// verify required parameter 'controller' is not null or undefined
|
|
7581
|
-
assertParamExists('
|
|
7582
|
-
// verify required parameter '
|
|
7583
|
-
assertParamExists('
|
|
7584
|
-
const localVarPath = `/cells/{cell}/
|
|
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`
|
|
7585
7417
|
.replace(`{${"cell"}}`, encodeURIComponent(String(cell)))
|
|
7586
|
-
.replace(`{${"controller"}}`, encodeURIComponent(String(controller)))
|
|
7587
|
-
.replace(`{${"coordinate-system"}}`, encodeURIComponent(String(coordinateSystem)));
|
|
7418
|
+
.replace(`{${"controller"}}`, encodeURIComponent(String(controller)));
|
|
7588
7419
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
7589
7420
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
7590
7421
|
let baseOptions;
|
|
7591
7422
|
if (configuration) {
|
|
7592
7423
|
baseOptions = configuration.baseOptions;
|
|
7593
7424
|
}
|
|
7594
|
-
const localVarRequestOptions = { method: '
|
|
7425
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options };
|
|
7595
7426
|
const localVarHeaderParameter = {};
|
|
7596
7427
|
const localVarQueryParameter = {};
|
|
7597
7428
|
// authentication BasicAuth required
|
|
@@ -7600,8 +7431,8 @@ export const VirtualControllerApiAxiosParamCreator = function (configuration) {
|
|
|
7600
7431
|
// authentication BearerAuth required
|
|
7601
7432
|
// http bearer authentication required
|
|
7602
7433
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
7603
|
-
if (
|
|
7604
|
-
localVarQueryParameter['
|
|
7434
|
+
if (ios) {
|
|
7435
|
+
localVarQueryParameter['ios'] = ios;
|
|
7605
7436
|
}
|
|
7606
7437
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
7607
7438
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
@@ -7612,36 +7443,32 @@ export const VirtualControllerApiAxiosParamCreator = function (configuration) {
|
|
|
7612
7443
|
};
|
|
7613
7444
|
},
|
|
7614
7445
|
/**
|
|
7615
|
-
*
|
|
7616
|
-
* @summary
|
|
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
|
|
7617
7448
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
7618
7449
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
7619
|
-
* @param {string}
|
|
7620
|
-
* @param {
|
|
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.
|
|
7621
7454
|
* @param {*} [options] Override http request option.
|
|
7622
7455
|
* @throws {RequiredError}
|
|
7623
7456
|
*/
|
|
7624
|
-
|
|
7457
|
+
listVirtualRobotIODescriptions: async (cell, controller, ios, direction, valueType, group, options = {}) => {
|
|
7625
7458
|
// verify required parameter 'cell' is not null or undefined
|
|
7626
|
-
assertParamExists('
|
|
7459
|
+
assertParamExists('listVirtualRobotIODescriptions', 'cell', cell);
|
|
7627
7460
|
// verify required parameter 'controller' is not null or undefined
|
|
7628
|
-
assertParamExists('
|
|
7629
|
-
|
|
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}`
|
|
7461
|
+
assertParamExists('listVirtualRobotIODescriptions', 'controller', controller);
|
|
7462
|
+
const localVarPath = `/cells/{cell}/controllers/{controller}/teach-pendant/ios/description`
|
|
7634
7463
|
.replace(`{${"cell"}}`, encodeURIComponent(String(cell)))
|
|
7635
|
-
.replace(`{${"controller"}}`, encodeURIComponent(String(controller)))
|
|
7636
|
-
.replace(`{${"motion-group"}}`, encodeURIComponent(String(motionGroup)))
|
|
7637
|
-
.replace(`{${"tcp"}}`, encodeURIComponent(String(tcp)));
|
|
7464
|
+
.replace(`{${"controller"}}`, encodeURIComponent(String(controller)));
|
|
7638
7465
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
7639
7466
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
7640
7467
|
let baseOptions;
|
|
7641
7468
|
if (configuration) {
|
|
7642
7469
|
baseOptions = configuration.baseOptions;
|
|
7643
7470
|
}
|
|
7644
|
-
const localVarRequestOptions = { method: '
|
|
7471
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options };
|
|
7645
7472
|
const localVarHeaderParameter = {};
|
|
7646
7473
|
const localVarQueryParameter = {};
|
|
7647
7474
|
// authentication BasicAuth required
|
|
@@ -7650,6 +7477,18 @@ export const VirtualControllerApiAxiosParamCreator = function (configuration) {
|
|
|
7650
7477
|
// authentication BearerAuth required
|
|
7651
7478
|
// http bearer authentication required
|
|
7652
7479
|
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
|
+
}
|
|
7653
7492
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
7654
7493
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
7655
7494
|
localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
|
|
@@ -7659,19 +7498,22 @@ export const VirtualControllerApiAxiosParamCreator = function (configuration) {
|
|
|
7659
7498
|
};
|
|
7660
7499
|
},
|
|
7661
7500
|
/**
|
|
7662
|
-
*
|
|
7663
|
-
* @summary
|
|
7501
|
+
* Sets a list of values of a virtual controller inputs/outputs.
|
|
7502
|
+
* @summary Set Input/Ouput Values
|
|
7664
7503
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
7665
7504
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
7505
|
+
* @param {Array<IOValue>} iOValue
|
|
7666
7506
|
* @param {*} [options] Override http request option.
|
|
7667
7507
|
* @throws {RequiredError}
|
|
7668
7508
|
*/
|
|
7669
|
-
|
|
7509
|
+
setIOValues: async (cell, controller, iOValue, options = {}) => {
|
|
7670
7510
|
// verify required parameter 'cell' is not null or undefined
|
|
7671
|
-
assertParamExists('
|
|
7511
|
+
assertParamExists('setIOValues', 'cell', cell);
|
|
7672
7512
|
// verify required parameter 'controller' is not null or undefined
|
|
7673
|
-
assertParamExists('
|
|
7674
|
-
|
|
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`
|
|
7675
7517
|
.replace(`{${"cell"}}`, encodeURIComponent(String(cell)))
|
|
7676
7518
|
.replace(`{${"controller"}}`, encodeURIComponent(String(controller)));
|
|
7677
7519
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
@@ -7680,7 +7522,7 @@ export const VirtualControllerApiAxiosParamCreator = function (configuration) {
|
|
|
7680
7522
|
if (configuration) {
|
|
7681
7523
|
baseOptions = configuration.baseOptions;
|
|
7682
7524
|
}
|
|
7683
|
-
const localVarRequestOptions = { method: '
|
|
7525
|
+
const localVarRequestOptions = { method: 'PUT', ...baseOptions, ...options };
|
|
7684
7526
|
const localVarHeaderParameter = {};
|
|
7685
7527
|
const localVarQueryParameter = {};
|
|
7686
7528
|
// authentication BasicAuth required
|
|
@@ -7689,31 +7531,36 @@ export const VirtualControllerApiAxiosParamCreator = function (configuration) {
|
|
|
7689
7531
|
// authentication BearerAuth required
|
|
7690
7532
|
// http bearer authentication required
|
|
7691
7533
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
7534
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
7692
7535
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
7693
7536
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
7694
7537
|
localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
|
|
7538
|
+
localVarRequestOptions.data = serializeDataIfNeeded(iOValue, localVarRequestOptions, configuration);
|
|
7695
7539
|
return {
|
|
7696
7540
|
url: toPathString(localVarUrlObj),
|
|
7697
7541
|
options: localVarRequestOptions,
|
|
7698
7542
|
};
|
|
7699
7543
|
},
|
|
7700
7544
|
/**
|
|
7701
|
-
*
|
|
7702
|
-
* @summary
|
|
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
|
|
7703
7547
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
7704
7548
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
7705
7549
|
* @param {string} motionGroup The motion-group identifier.
|
|
7550
|
+
* @param {MotionGroupJoints} motionGroupJoints
|
|
7706
7551
|
* @param {*} [options] Override http request option.
|
|
7707
7552
|
* @throws {RequiredError}
|
|
7708
7553
|
*/
|
|
7709
|
-
|
|
7554
|
+
setMotionGroupState: async (cell, controller, motionGroup, motionGroupJoints, options = {}) => {
|
|
7710
7555
|
// verify required parameter 'cell' is not null or undefined
|
|
7711
|
-
assertParamExists('
|
|
7556
|
+
assertParamExists('setMotionGroupState', 'cell', cell);
|
|
7712
7557
|
// verify required parameter 'controller' is not null or undefined
|
|
7713
|
-
assertParamExists('
|
|
7558
|
+
assertParamExists('setMotionGroupState', 'controller', controller);
|
|
7714
7559
|
// verify required parameter 'motionGroup' is not null or undefined
|
|
7715
|
-
assertParamExists('
|
|
7716
|
-
|
|
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}`
|
|
7717
7564
|
.replace(`{${"cell"}}`, encodeURIComponent(String(cell)))
|
|
7718
7565
|
.replace(`{${"controller"}}`, encodeURIComponent(String(controller)))
|
|
7719
7566
|
.replace(`{${"motion-group"}}`, encodeURIComponent(String(motionGroup)));
|
|
@@ -7723,7 +7570,7 @@ export const VirtualControllerApiAxiosParamCreator = function (configuration) {
|
|
|
7723
7570
|
if (configuration) {
|
|
7724
7571
|
baseOptions = configuration.baseOptions;
|
|
7725
7572
|
}
|
|
7726
|
-
const localVarRequestOptions = { method: '
|
|
7573
|
+
const localVarRequestOptions = { method: 'PUT', ...baseOptions, ...options };
|
|
7727
7574
|
const localVarHeaderParameter = {};
|
|
7728
7575
|
const localVarQueryParameter = {};
|
|
7729
7576
|
// authentication BasicAuth required
|
|
@@ -7732,14 +7579,40 @@ export const VirtualControllerApiAxiosParamCreator = function (configuration) {
|
|
|
7732
7579
|
// authentication BearerAuth required
|
|
7733
7580
|
// http bearer authentication required
|
|
7734
7581
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
7582
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
7735
7583
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
7736
7584
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
7737
7585
|
localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
|
|
7586
|
+
localVarRequestOptions.data = serializeDataIfNeeded(motionGroupJoints, localVarRequestOptions, configuration);
|
|
7738
7587
|
return {
|
|
7739
7588
|
url: toPathString(localVarUrlObj),
|
|
7740
7589
|
options: localVarRequestOptions,
|
|
7741
7590
|
};
|
|
7742
7591
|
},
|
|
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
|
+
},
|
|
7743
7616
|
/**
|
|
7744
7617
|
* Gets information on the motion group.
|
|
7745
7618
|
* @summary Motion Group Description
|
|
@@ -7748,12 +7621,274 @@ export const VirtualControllerApiAxiosParamCreator = function (configuration) {
|
|
|
7748
7621
|
* @param {*} [options] Override http request option.
|
|
7749
7622
|
* @throws {RequiredError}
|
|
7750
7623
|
*/
|
|
7751
|
-
|
|
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
|
+
/**
|
|
7716
|
+
* Gets information on the motion group.
|
|
7717
|
+
* @summary Motion Group Description
|
|
7718
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
7719
|
+
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
7720
|
+
* @param {*} [options] Override http request option.
|
|
7721
|
+
* @throws {RequiredError}
|
|
7722
|
+
*/
|
|
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 = {}) => {
|
|
7752
7885
|
// verify required parameter 'cell' is not null or undefined
|
|
7753
|
-
assertParamExists('
|
|
7886
|
+
assertParamExists('externalJointsStream', 'cell', cell);
|
|
7754
7887
|
// verify required parameter 'controller' is not null or undefined
|
|
7755
|
-
assertParamExists('
|
|
7756
|
-
|
|
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`
|
|
7757
7892
|
.replace(`{${"cell"}}`, encodeURIComponent(String(cell)))
|
|
7758
7893
|
.replace(`{${"controller"}}`, encodeURIComponent(String(controller)));
|
|
7759
7894
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
@@ -7771,30 +7906,36 @@ export const VirtualControllerApiAxiosParamCreator = function (configuration) {
|
|
|
7771
7906
|
// authentication BearerAuth required
|
|
7772
7907
|
// http bearer authentication required
|
|
7773
7908
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
7909
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
7774
7910
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
7775
7911
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
7776
7912
|
localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
|
|
7913
|
+
localVarRequestOptions.data = serializeDataIfNeeded(externalJointStreamDatapoint, localVarRequestOptions, configuration);
|
|
7777
7914
|
return {
|
|
7778
7915
|
url: toPathString(localVarUrlObj),
|
|
7779
7916
|
options: localVarRequestOptions,
|
|
7780
7917
|
};
|
|
7781
7918
|
},
|
|
7782
7919
|
/**
|
|
7783
|
-
*
|
|
7784
|
-
* @summary
|
|
7920
|
+
* Get the current robot motion group behavior - please see the setter [setMotionGroupBehavior](setMotionGroupBehavior) and the enum for details.
|
|
7921
|
+
* @summary Behavior
|
|
7785
7922
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
7786
7923
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
7924
|
+
* @param {string} motionGroup The motion-group identifier.
|
|
7787
7925
|
* @param {*} [options] Override http request option.
|
|
7788
7926
|
* @throws {RequiredError}
|
|
7789
7927
|
*/
|
|
7790
|
-
|
|
7928
|
+
getMotionGroupBehavior: async (cell, controller, motionGroup, options = {}) => {
|
|
7791
7929
|
// verify required parameter 'cell' is not null or undefined
|
|
7792
|
-
assertParamExists('
|
|
7930
|
+
assertParamExists('getMotionGroupBehavior', 'cell', cell);
|
|
7793
7931
|
// verify required parameter 'controller' is not null or undefined
|
|
7794
|
-
assertParamExists('
|
|
7795
|
-
|
|
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`
|
|
7796
7936
|
.replace(`{${"cell"}}`, encodeURIComponent(String(cell)))
|
|
7797
|
-
.replace(`{${"controller"}}`, encodeURIComponent(String(controller)))
|
|
7937
|
+
.replace(`{${"controller"}}`, encodeURIComponent(String(controller)))
|
|
7938
|
+
.replace(`{${"motion-group"}}`, encodeURIComponent(String(motionGroup)));
|
|
7798
7939
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
7799
7940
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
7800
7941
|
let baseOptions;
|
|
@@ -7819,25 +7960,225 @@ export const VirtualControllerApiAxiosParamCreator = function (configuration) {
|
|
|
7819
7960
|
};
|
|
7820
7961
|
},
|
|
7821
7962
|
/**
|
|
7822
|
-
*
|
|
7823
|
-
* @summary
|
|
7963
|
+
* Switch robot motion group behavior.
|
|
7964
|
+
* @summary Switch Behavior
|
|
7965
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
7966
|
+
* @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
|
+
* @param {*} [options] Override http request option.
|
|
7970
|
+
* @throws {RequiredError}
|
|
7971
|
+
*/
|
|
7972
|
+
setMotionGroupBehavior: async (cell, controller, motionGroup, behavior, options = {}) => {
|
|
7973
|
+
// 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 {
|
|
8166
|
+
/**
|
|
8167
|
+
* Get the cycle time of controller communication in [ms].
|
|
8168
|
+
* @summary Cycle Time
|
|
7824
8169
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
7825
8170
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
7826
|
-
* @param {string} motionGroup The motion-group identifier.
|
|
7827
8171
|
* @param {*} [options] Override http request option.
|
|
7828
8172
|
* @throws {RequiredError}
|
|
7829
8173
|
*/
|
|
7830
|
-
|
|
8174
|
+
getCycleTime: async (cell, controller, options = {}) => {
|
|
7831
8175
|
// verify required parameter 'cell' is not null or undefined
|
|
7832
|
-
assertParamExists('
|
|
8176
|
+
assertParamExists('getCycleTime', 'cell', cell);
|
|
7833
8177
|
// verify required parameter 'controller' is not null or undefined
|
|
7834
|
-
assertParamExists('
|
|
7835
|
-
|
|
7836
|
-
assertParamExists('getVirtualControllerMounting', 'motionGroup', motionGroup);
|
|
7837
|
-
const localVarPath = `/cells/{cell}/virtual-controllers/{controller}/motion-groups/{motion-group}/mounting`
|
|
8178
|
+
assertParamExists('getCycleTime', 'controller', controller);
|
|
8179
|
+
const localVarPath = `/cells/{cell}/controllers/{controller}/teach-pendant/cycle-time`
|
|
7838
8180
|
.replace(`{${"cell"}}`, encodeURIComponent(String(cell)))
|
|
7839
|
-
.replace(`{${"controller"}}`, encodeURIComponent(String(controller)))
|
|
7840
|
-
.replace(`{${"motion-group"}}`, encodeURIComponent(String(motionGroup)));
|
|
8181
|
+
.replace(`{${"controller"}}`, encodeURIComponent(String(controller)));
|
|
7841
8182
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
7842
8183
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
7843
8184
|
let baseOptions;
|
|
@@ -7862,19 +8203,19 @@ export const VirtualControllerApiAxiosParamCreator = function (configuration) {
|
|
|
7862
8203
|
};
|
|
7863
8204
|
},
|
|
7864
8205
|
/**
|
|
7865
|
-
*
|
|
7866
|
-
* @summary
|
|
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
|
|
7867
8208
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
7868
8209
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
7869
8210
|
* @param {*} [options] Override http request option.
|
|
7870
8211
|
* @throws {RequiredError}
|
|
7871
8212
|
*/
|
|
7872
|
-
|
|
8213
|
+
getEmergencyStop: async (cell, controller, options = {}) => {
|
|
7873
8214
|
// verify required parameter 'cell' is not null or undefined
|
|
7874
|
-
assertParamExists('
|
|
8215
|
+
assertParamExists('getEmergencyStop', 'cell', cell);
|
|
7875
8216
|
// verify required parameter 'controller' is not null or undefined
|
|
7876
|
-
assertParamExists('
|
|
7877
|
-
const localVarPath = `/cells/{cell}/
|
|
8217
|
+
assertParamExists('getEmergencyStop', 'controller', controller);
|
|
8218
|
+
const localVarPath = `/cells/{cell}/controllers/{controller}/teach-pendant/emergency-stop`
|
|
7878
8219
|
.replace(`{${"cell"}}`, encodeURIComponent(String(cell)))
|
|
7879
8220
|
.replace(`{${"controller"}}`, encodeURIComponent(String(controller)));
|
|
7880
8221
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
@@ -7901,25 +8242,21 @@ export const VirtualControllerApiAxiosParamCreator = function (configuration) {
|
|
|
7901
8242
|
};
|
|
7902
8243
|
},
|
|
7903
8244
|
/**
|
|
7904
|
-
*
|
|
7905
|
-
* @summary
|
|
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
|
|
7906
8247
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
7907
8248
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
7908
|
-
* @param {string} motionGroup The motion-group identifier.
|
|
7909
8249
|
* @param {*} [options] Override http request option.
|
|
7910
8250
|
* @throws {RequiredError}
|
|
7911
8251
|
*/
|
|
7912
|
-
|
|
8252
|
+
getOperationMode: async (cell, controller, options = {}) => {
|
|
7913
8253
|
// verify required parameter 'cell' is not null or undefined
|
|
7914
|
-
assertParamExists('
|
|
8254
|
+
assertParamExists('getOperationMode', 'cell', cell);
|
|
7915
8255
|
// verify required parameter 'controller' is not null or undefined
|
|
7916
|
-
assertParamExists('
|
|
7917
|
-
|
|
7918
|
-
assertParamExists('listVirtualControllerTcps', 'motionGroup', motionGroup);
|
|
7919
|
-
const localVarPath = `/cells/{cell}/virtual-controllers/{controller}/motion-groups/{motion-group}/tcps`
|
|
8256
|
+
assertParamExists('getOperationMode', 'controller', controller);
|
|
8257
|
+
const localVarPath = `/cells/{cell}/controllers/{controller}/teach-pendant/operationmode`
|
|
7920
8258
|
.replace(`{${"cell"}}`, encodeURIComponent(String(cell)))
|
|
7921
|
-
.replace(`{${"controller"}}`, encodeURIComponent(String(controller)))
|
|
7922
|
-
.replace(`{${"motion-group"}}`, encodeURIComponent(String(motionGroup)));
|
|
8259
|
+
.replace(`{${"controller"}}`, encodeURIComponent(String(controller)));
|
|
7923
8260
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
7924
8261
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
7925
8262
|
let baseOptions;
|
|
@@ -7957,7 +8294,7 @@ export const VirtualControllerApiAxiosParamCreator = function (configuration) {
|
|
|
7957
8294
|
assertParamExists('setEmergencyStop', 'cell', cell);
|
|
7958
8295
|
// verify required parameter 'controller' is not null or undefined
|
|
7959
8296
|
assertParamExists('setEmergencyStop', 'controller', controller);
|
|
7960
|
-
const localVarPath = `/cells/{cell}/
|
|
8297
|
+
const localVarPath = `/cells/{cell}/controllers/{controller}/teach-pendant/emergency-stop`
|
|
7961
8298
|
.replace(`{${"cell"}}`, encodeURIComponent(String(cell)))
|
|
7962
8299
|
.replace(`{${"controller"}}`, encodeURIComponent(String(controller)));
|
|
7963
8300
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
@@ -7986,54 +8323,6 @@ export const VirtualControllerApiAxiosParamCreator = function (configuration) {
|
|
|
7986
8323
|
options: localVarRequestOptions,
|
|
7987
8324
|
};
|
|
7988
8325
|
},
|
|
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
|
-
},
|
|
8037
8326
|
/**
|
|
8038
8327
|
* 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.
|
|
8039
8328
|
* @summary Set Operation Mode
|
|
@@ -8050,7 +8339,7 @@ export const VirtualControllerApiAxiosParamCreator = function (configuration) {
|
|
|
8050
8339
|
assertParamExists('setOperationMode', 'controller', controller);
|
|
8051
8340
|
// verify required parameter 'mode' is not null or undefined
|
|
8052
8341
|
assertParamExists('setOperationMode', 'mode', mode);
|
|
8053
|
-
const localVarPath = `/cells/{cell}/
|
|
8342
|
+
const localVarPath = `/cells/{cell}/controllers/{controller}/teach-pendant/operationmode`
|
|
8054
8343
|
.replace(`{${"cell"}}`, encodeURIComponent(String(cell)))
|
|
8055
8344
|
.replace(`{${"controller"}}`, encodeURIComponent(String(controller)));
|
|
8056
8345
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
@@ -8079,126 +8368,27 @@ export const VirtualControllerApiAxiosParamCreator = function (configuration) {
|
|
|
8079
8368
|
options: localVarRequestOptions,
|
|
8080
8369
|
};
|
|
8081
8370
|
},
|
|
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
|
-
},
|
|
8130
8371
|
};
|
|
8131
8372
|
};
|
|
8132
8373
|
/**
|
|
8133
|
-
*
|
|
8374
|
+
* VirtualRobotModeApi - functional programming interface
|
|
8134
8375
|
* @export
|
|
8135
8376
|
*/
|
|
8136
|
-
export const
|
|
8137
|
-
const localVarAxiosParamCreator =
|
|
8377
|
+
export const VirtualRobotModeApiFp = function (configuration) {
|
|
8378
|
+
const localVarAxiosParamCreator = VirtualRobotModeApiAxiosParamCreator(configuration);
|
|
8138
8379
|
return {
|
|
8139
8380
|
/**
|
|
8140
|
-
*
|
|
8141
|
-
* @summary
|
|
8142
|
-
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
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
|
|
8146
|
-
* @param {*} [options] Override http request option.
|
|
8147
|
-
* @throws {RequiredError}
|
|
8148
|
-
*/
|
|
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
|
|
8381
|
+
* Get the cycle time of controller communication in [ms].
|
|
8382
|
+
* @summary Cycle Time
|
|
8191
8383
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8192
8384
|
* @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
8385
|
* @param {*} [options] Override http request option.
|
|
8196
8386
|
* @throws {RequiredError}
|
|
8197
8387
|
*/
|
|
8198
|
-
async
|
|
8199
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.
|
|
8388
|
+
async getCycleTime(cell, controller, options) {
|
|
8389
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.getCycleTime(cell, controller, options);
|
|
8200
8390
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
8201
|
-
const localVarOperationServerBasePath = operationServerMap['
|
|
8391
|
+
const localVarOperationServerBasePath = operationServerMap['VirtualRobotModeApi.getCycleTime']?.[localVarOperationServerIndex]?.url;
|
|
8202
8392
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
8203
8393
|
},
|
|
8204
8394
|
/**
|
|
@@ -8212,36 +8402,7 @@ export const VirtualControllerApiFp = function (configuration) {
|
|
|
8212
8402
|
async getEmergencyStop(cell, controller, options) {
|
|
8213
8403
|
const localVarAxiosArgs = await localVarAxiosParamCreator.getEmergencyStop(cell, controller, options);
|
|
8214
8404
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
8215
|
-
const localVarOperationServerBasePath = operationServerMap['
|
|
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;
|
|
8405
|
+
const localVarOperationServerBasePath = operationServerMap['VirtualRobotModeApi.getEmergencyStop']?.[localVarOperationServerIndex]?.url;
|
|
8245
8406
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
8246
8407
|
},
|
|
8247
8408
|
/**
|
|
@@ -8252,54 +8413,10 @@ export const VirtualControllerApiFp = function (configuration) {
|
|
|
8252
8413
|
* @param {*} [options] Override http request option.
|
|
8253
8414
|
* @throws {RequiredError}
|
|
8254
8415
|
*/
|
|
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);
|
|
8272
|
-
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
8273
|
-
const localVarOperationServerBasePath = operationServerMap['VirtualControllerApi.getVirtualControllerMounting']?.[localVarOperationServerIndex]?.url;
|
|
8274
|
-
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
8275
|
-
},
|
|
8276
|
-
/**
|
|
8277
|
-
* Lists all coordinate systems on the robot controller.
|
|
8278
|
-
* @summary List Coordinate Systems
|
|
8279
|
-
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8280
|
-
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
8281
|
-
* @param {*} [options] Override http request option.
|
|
8282
|
-
* @throws {RequiredError}
|
|
8283
|
-
*/
|
|
8284
|
-
async listVirtualControllerCoordinateSystems(cell, controller, options) {
|
|
8285
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.listVirtualControllerCoordinateSystems(cell, controller, options);
|
|
8286
|
-
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
8287
|
-
const localVarOperationServerBasePath = operationServerMap['VirtualControllerApi.listVirtualControllerCoordinateSystems']?.[localVarOperationServerIndex]?.url;
|
|
8288
|
-
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
8289
|
-
},
|
|
8290
|
-
/**
|
|
8291
|
-
* Lists TCPs of the motion group. An empty TCP list is valid, for example for external axes.
|
|
8292
|
-
* @summary List TCPs
|
|
8293
|
-
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8294
|
-
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
8295
|
-
* @param {string} motionGroup The motion-group identifier.
|
|
8296
|
-
* @param {*} [options] Override http request option.
|
|
8297
|
-
* @throws {RequiredError}
|
|
8298
|
-
*/
|
|
8299
|
-
async listVirtualControllerTcps(cell, controller, motionGroup, options) {
|
|
8300
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.listVirtualControllerTcps(cell, controller, motionGroup, options);
|
|
8416
|
+
async getOperationMode(cell, controller, options) {
|
|
8417
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.getOperationMode(cell, controller, options);
|
|
8301
8418
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
8302
|
-
const localVarOperationServerBasePath = operationServerMap['
|
|
8419
|
+
const localVarOperationServerBasePath = operationServerMap['VirtualRobotModeApi.getOperationMode']?.[localVarOperationServerIndex]?.url;
|
|
8303
8420
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
8304
8421
|
},
|
|
8305
8422
|
/**
|
|
@@ -8314,23 +8431,7 @@ export const VirtualControllerApiFp = function (configuration) {
|
|
|
8314
8431
|
async setEmergencyStop(cell, controller, active, options) {
|
|
8315
8432
|
const localVarAxiosArgs = await localVarAxiosParamCreator.setEmergencyStop(cell, controller, active, options);
|
|
8316
8433
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
8317
|
-
const localVarOperationServerBasePath = operationServerMap['
|
|
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;
|
|
8434
|
+
const localVarOperationServerBasePath = operationServerMap['VirtualRobotModeApi.setEmergencyStop']?.[localVarOperationServerIndex]?.url;
|
|
8334
8435
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
8335
8436
|
},
|
|
8336
8437
|
/**
|
|
@@ -8345,86 +8446,28 @@ export const VirtualControllerApiFp = function (configuration) {
|
|
|
8345
8446
|
async setOperationMode(cell, controller, mode, options) {
|
|
8346
8447
|
const localVarAxiosArgs = await localVarAxiosParamCreator.setOperationMode(cell, controller, mode, options);
|
|
8347
8448
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
8348
|
-
const localVarOperationServerBasePath = operationServerMap['
|
|
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;
|
|
8449
|
+
const localVarOperationServerBasePath = operationServerMap['VirtualRobotModeApi.setOperationMode']?.[localVarOperationServerIndex]?.url;
|
|
8365
8450
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
8366
8451
|
},
|
|
8367
8452
|
};
|
|
8368
8453
|
};
|
|
8369
8454
|
/**
|
|
8370
|
-
*
|
|
8455
|
+
* VirtualRobotModeApi - factory interface
|
|
8371
8456
|
* @export
|
|
8372
8457
|
*/
|
|
8373
|
-
export const
|
|
8374
|
-
const localVarFp =
|
|
8458
|
+
export const VirtualRobotModeApiFactory = function (configuration, basePath, axios) {
|
|
8459
|
+
const localVarFp = VirtualRobotModeApiFp(configuration);
|
|
8375
8460
|
return {
|
|
8376
8461
|
/**
|
|
8377
|
-
*
|
|
8378
|
-
* @summary
|
|
8379
|
-
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
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
|
|
8383
|
-
* @param {*} [options] Override http request option.
|
|
8384
|
-
* @throws {RequiredError}
|
|
8385
|
-
*/
|
|
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
|
|
8462
|
+
* Get the cycle time of controller communication in [ms].
|
|
8463
|
+
* @summary Cycle Time
|
|
8419
8464
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8420
8465
|
* @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
8466
|
* @param {*} [options] Override http request option.
|
|
8424
8467
|
* @throws {RequiredError}
|
|
8425
8468
|
*/
|
|
8426
|
-
|
|
8427
|
-
return localVarFp.
|
|
8469
|
+
getCycleTime(cell, controller, options) {
|
|
8470
|
+
return localVarFp.getCycleTime(cell, controller, options).then((request) => request(axios, basePath));
|
|
8428
8471
|
},
|
|
8429
8472
|
/**
|
|
8430
8473
|
* 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.
|
|
@@ -8437,29 +8480,6 @@ export const VirtualControllerApiFactory = function (configuration, basePath, ax
|
|
|
8437
8480
|
getEmergencyStop(cell, controller, options) {
|
|
8438
8481
|
return localVarFp.getEmergencyStop(cell, controller, options).then((request) => request(axios, basePath));
|
|
8439
8482
|
},
|
|
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
|
-
},
|
|
8463
8483
|
/**
|
|
8464
8484
|
* 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.
|
|
8465
8485
|
* @summary Get Operation Mode
|
|
@@ -8471,41 +8491,6 @@ export const VirtualControllerApiFactory = function (configuration, basePath, ax
|
|
|
8471
8491
|
getOperationMode(cell, controller, options) {
|
|
8472
8492
|
return localVarFp.getOperationMode(cell, controller, options).then((request) => request(axios, basePath));
|
|
8473
8493
|
},
|
|
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
|
-
},
|
|
8509
8494
|
/**
|
|
8510
8495
|
* 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.
|
|
8511
8496
|
* @summary Push or Release Emergency Stop
|
|
@@ -8518,19 +8503,6 @@ export const VirtualControllerApiFactory = function (configuration, basePath, ax
|
|
|
8518
8503
|
setEmergencyStop(cell, controller, active, options) {
|
|
8519
8504
|
return localVarFp.setEmergencyStop(cell, controller, active, options).then((request) => request(axios, basePath));
|
|
8520
8505
|
},
|
|
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
|
-
},
|
|
8534
8506
|
/**
|
|
8535
8507
|
* 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.
|
|
8536
8508
|
* @summary Set Operation Mode
|
|
@@ -8543,84 +8515,26 @@ export const VirtualControllerApiFactory = function (configuration, basePath, ax
|
|
|
8543
8515
|
setOperationMode(cell, controller, mode, options) {
|
|
8544
8516
|
return localVarFp.setOperationMode(cell, controller, mode, options).then((request) => request(axios, basePath));
|
|
8545
8517
|
},
|
|
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
|
-
},
|
|
8559
8518
|
};
|
|
8560
8519
|
};
|
|
8561
8520
|
/**
|
|
8562
|
-
*
|
|
8521
|
+
* VirtualRobotModeApi - object-oriented interface
|
|
8563
8522
|
* @export
|
|
8564
|
-
* @class
|
|
8523
|
+
* @class VirtualRobotModeApi
|
|
8565
8524
|
* @extends {BaseAPI}
|
|
8566
8525
|
*/
|
|
8567
|
-
export class
|
|
8568
|
-
/**
|
|
8569
|
-
* Adds a coordinate system to the robot controller.
|
|
8570
|
-
* @summary Add Coordinate Systems
|
|
8571
|
-
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
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
|
|
8575
|
-
* @param {*} [options] Override http request option.
|
|
8576
|
-
* @throws {RequiredError}
|
|
8577
|
-
* @memberof VirtualControllerApi
|
|
8578
|
-
*/
|
|
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
|
-
}
|
|
8526
|
+
export class VirtualRobotModeApi extends BaseAPI {
|
|
8611
8527
|
/**
|
|
8612
|
-
*
|
|
8613
|
-
* @summary
|
|
8528
|
+
* Get the cycle time of controller communication in [ms].
|
|
8529
|
+
* @summary Cycle Time
|
|
8614
8530
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8615
8531
|
* @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
8532
|
* @param {*} [options] Override http request option.
|
|
8619
8533
|
* @throws {RequiredError}
|
|
8620
|
-
* @memberof
|
|
8534
|
+
* @memberof VirtualRobotModeApi
|
|
8621
8535
|
*/
|
|
8622
|
-
|
|
8623
|
-
return
|
|
8536
|
+
getCycleTime(cell, controller, options) {
|
|
8537
|
+
return VirtualRobotModeApiFp(this.configuration).getCycleTime(cell, controller, options).then((request) => request(this.axios, this.basePath));
|
|
8624
8538
|
}
|
|
8625
8539
|
/**
|
|
8626
8540
|
* 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.
|
|
@@ -8629,35 +8543,10 @@ export class VirtualControllerApi extends BaseAPI {
|
|
|
8629
8543
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
8630
8544
|
* @param {*} [options] Override http request option.
|
|
8631
8545
|
* @throws {RequiredError}
|
|
8632
|
-
* @memberof
|
|
8546
|
+
* @memberof VirtualRobotModeApi
|
|
8633
8547
|
*/
|
|
8634
8548
|
getEmergencyStop(cell, controller, options) {
|
|
8635
|
-
return
|
|
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));
|
|
8549
|
+
return VirtualRobotModeApiFp(this.configuration).getEmergencyStop(cell, controller, options).then((request) => request(this.axios, this.basePath));
|
|
8661
8550
|
}
|
|
8662
8551
|
/**
|
|
8663
8552
|
* 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.
|
|
@@ -8666,127 +8555,61 @@ export class VirtualControllerApi extends BaseAPI {
|
|
|
8666
8555
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
8667
8556
|
* @param {*} [options] Override http request option.
|
|
8668
8557
|
* @throws {RequiredError}
|
|
8669
|
-
* @memberof
|
|
8558
|
+
* @memberof VirtualRobotModeApi
|
|
8670
8559
|
*/
|
|
8671
8560
|
getOperationMode(cell, controller, options) {
|
|
8672
|
-
return
|
|
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));
|
|
8561
|
+
return VirtualRobotModeApiFp(this.configuration).getOperationMode(cell, controller, options).then((request) => request(this.axios, this.basePath));
|
|
8711
8562
|
}
|
|
8712
8563
|
/**
|
|
8713
8564
|
* 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.
|
|
8714
8565
|
* @summary Push or Release Emergency Stop
|
|
8715
8566
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8716
8567
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
8717
|
-
* @param {boolean} [active]
|
|
8718
|
-
* @param {*} [options] Override http request option.
|
|
8719
|
-
* @throws {RequiredError}
|
|
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
|
|
8735
|
-
*/
|
|
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));
|
|
8738
|
-
}
|
|
8739
|
-
/**
|
|
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.
|
|
8741
|
-
* @summary Set Operation Mode
|
|
8742
|
-
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8743
|
-
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
8744
|
-
* @param {OperationMode} mode
|
|
8568
|
+
* @param {boolean} [active]
|
|
8745
8569
|
* @param {*} [options] Override http request option.
|
|
8746
8570
|
* @throws {RequiredError}
|
|
8747
|
-
* @memberof
|
|
8571
|
+
* @memberof VirtualRobotModeApi
|
|
8748
8572
|
*/
|
|
8749
|
-
|
|
8750
|
-
return
|
|
8573
|
+
setEmergencyStop(cell, controller, active, options) {
|
|
8574
|
+
return VirtualRobotModeApiFp(this.configuration).setEmergencyStop(cell, controller, active, options).then((request) => request(this.axios, this.basePath));
|
|
8751
8575
|
}
|
|
8752
8576
|
/**
|
|
8753
|
-
*
|
|
8754
|
-
* @summary Set
|
|
8577
|
+
* 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.
|
|
8578
|
+
* @summary Set Operation Mode
|
|
8755
8579
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8756
8580
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
8757
|
-
* @param {
|
|
8758
|
-
* @param {CoordinateSystem} coordinateSystem
|
|
8581
|
+
* @param {OperationMode} mode
|
|
8759
8582
|
* @param {*} [options] Override http request option.
|
|
8760
8583
|
* @throws {RequiredError}
|
|
8761
|
-
* @memberof
|
|
8584
|
+
* @memberof VirtualRobotModeApi
|
|
8762
8585
|
*/
|
|
8763
|
-
|
|
8764
|
-
return
|
|
8586
|
+
setOperationMode(cell, controller, mode, options) {
|
|
8587
|
+
return VirtualRobotModeApiFp(this.configuration).setOperationMode(cell, controller, mode, options).then((request) => request(this.axios, this.basePath));
|
|
8765
8588
|
}
|
|
8766
8589
|
}
|
|
8767
8590
|
/**
|
|
8768
|
-
*
|
|
8591
|
+
* VirtualRobotSetupApi - axios parameter creator
|
|
8769
8592
|
* @export
|
|
8770
8593
|
*/
|
|
8771
|
-
export const
|
|
8594
|
+
export const VirtualRobotSetupApiAxiosParamCreator = function (configuration) {
|
|
8772
8595
|
return {
|
|
8773
8596
|
/**
|
|
8774
|
-
*
|
|
8775
|
-
* @summary
|
|
8597
|
+
* Adds a coordinate system to the robot controller.
|
|
8598
|
+
* @summary Add Coordinate Systems
|
|
8776
8599
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8777
8600
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
8778
|
-
* @param {
|
|
8601
|
+
* @param {CoordinateSystem} coordinateSystem
|
|
8779
8602
|
* @param {*} [options] Override http request option.
|
|
8780
8603
|
* @throws {RequiredError}
|
|
8781
8604
|
*/
|
|
8782
|
-
|
|
8605
|
+
addVirtualRobotCoordinateSystem: async (cell, controller, coordinateSystem, options = {}) => {
|
|
8783
8606
|
// verify required parameter 'cell' is not null or undefined
|
|
8784
|
-
assertParamExists('
|
|
8607
|
+
assertParamExists('addVirtualRobotCoordinateSystem', 'cell', cell);
|
|
8785
8608
|
// verify required parameter 'controller' is not null or undefined
|
|
8786
|
-
assertParamExists('
|
|
8787
|
-
// verify required parameter '
|
|
8788
|
-
assertParamExists('
|
|
8789
|
-
const localVarPath = `/cells/{cell}/
|
|
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`
|
|
8790
8613
|
.replace(`{${"cell"}}`, encodeURIComponent(String(cell)))
|
|
8791
8614
|
.replace(`{${"controller"}}`, encodeURIComponent(String(controller)));
|
|
8792
8615
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
@@ -8795,7 +8618,7 @@ export const VirtualControllerBehaviorApiAxiosParamCreator = function (configura
|
|
|
8795
8618
|
if (configuration) {
|
|
8796
8619
|
baseOptions = configuration.baseOptions;
|
|
8797
8620
|
}
|
|
8798
|
-
const localVarRequestOptions = { method: '
|
|
8621
|
+
const localVarRequestOptions = { method: 'PUT', ...baseOptions, ...options };
|
|
8799
8622
|
const localVarHeaderParameter = {};
|
|
8800
8623
|
const localVarQueryParameter = {};
|
|
8801
8624
|
// authentication BasicAuth required
|
|
@@ -8808,35 +8631,42 @@ export const VirtualControllerBehaviorApiAxiosParamCreator = function (configura
|
|
|
8808
8631
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
8809
8632
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
8810
8633
|
localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
|
|
8811
|
-
localVarRequestOptions.data = serializeDataIfNeeded(
|
|
8634
|
+
localVarRequestOptions.data = serializeDataIfNeeded(coordinateSystem, localVarRequestOptions, configuration);
|
|
8812
8635
|
return {
|
|
8813
8636
|
url: toPathString(localVarUrlObj),
|
|
8814
8637
|
options: localVarRequestOptions,
|
|
8815
8638
|
};
|
|
8816
8639
|
},
|
|
8817
8640
|
/**
|
|
8818
|
-
*
|
|
8819
|
-
* @summary
|
|
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
|
|
8820
8643
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8821
8644
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
8645
|
+
* @param {string} motionGroup The motion-group identifier.
|
|
8646
|
+
* @param {RobotTcp} robotTcp
|
|
8822
8647
|
* @param {*} [options] Override http request option.
|
|
8823
8648
|
* @throws {RequiredError}
|
|
8824
8649
|
*/
|
|
8825
|
-
|
|
8650
|
+
addVirtualRobotTcp: async (cell, controller, motionGroup, robotTcp, options = {}) => {
|
|
8826
8651
|
// verify required parameter 'cell' is not null or undefined
|
|
8827
|
-
assertParamExists('
|
|
8652
|
+
assertParamExists('addVirtualRobotTcp', 'cell', cell);
|
|
8828
8653
|
// verify required parameter 'controller' is not null or undefined
|
|
8829
|
-
assertParamExists('
|
|
8830
|
-
|
|
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`
|
|
8831
8660
|
.replace(`{${"cell"}}`, encodeURIComponent(String(cell)))
|
|
8832
|
-
.replace(`{${"controller"}}`, encodeURIComponent(String(controller)))
|
|
8661
|
+
.replace(`{${"controller"}}`, encodeURIComponent(String(controller)))
|
|
8662
|
+
.replace(`{${"motion-group"}}`, encodeURIComponent(String(motionGroup)));
|
|
8833
8663
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
8834
8664
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
8835
8665
|
let baseOptions;
|
|
8836
8666
|
if (configuration) {
|
|
8837
8667
|
baseOptions = configuration.baseOptions;
|
|
8838
8668
|
}
|
|
8839
|
-
const localVarRequestOptions = { method: '
|
|
8669
|
+
const localVarRequestOptions = { method: 'PUT', ...baseOptions, ...options };
|
|
8840
8670
|
const localVarHeaderParameter = {};
|
|
8841
8671
|
const localVarQueryParameter = {};
|
|
8842
8672
|
// authentication BasicAuth required
|
|
@@ -8845,37 +8675,44 @@ export const VirtualControllerBehaviorApiAxiosParamCreator = function (configura
|
|
|
8845
8675
|
// authentication BearerAuth required
|
|
8846
8676
|
// http bearer authentication required
|
|
8847
8677
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
8678
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
8848
8679
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
8849
8680
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
8850
8681
|
localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
|
|
8682
|
+
localVarRequestOptions.data = serializeDataIfNeeded(robotTcp, localVarRequestOptions, configuration);
|
|
8851
8683
|
return {
|
|
8852
8684
|
url: toPathString(localVarUrlObj),
|
|
8853
8685
|
options: localVarRequestOptions,
|
|
8854
8686
|
};
|
|
8855
8687
|
},
|
|
8856
8688
|
/**
|
|
8857
|
-
*
|
|
8858
|
-
* @summary
|
|
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
|
|
8859
8691
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8860
8692
|
* @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.
|
|
8861
8695
|
* @param {*} [options] Override http request option.
|
|
8862
8696
|
* @throws {RequiredError}
|
|
8863
8697
|
*/
|
|
8864
|
-
|
|
8698
|
+
deleteVirtualRobotCoordinateSystem: async (cell, controller, coordinateSystem, deleteDependent, options = {}) => {
|
|
8865
8699
|
// verify required parameter 'cell' is not null or undefined
|
|
8866
|
-
assertParamExists('
|
|
8700
|
+
assertParamExists('deleteVirtualRobotCoordinateSystem', 'cell', cell);
|
|
8867
8701
|
// verify required parameter 'controller' is not null or undefined
|
|
8868
|
-
assertParamExists('
|
|
8869
|
-
|
|
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}`
|
|
8870
8706
|
.replace(`{${"cell"}}`, encodeURIComponent(String(cell)))
|
|
8871
|
-
.replace(`{${"controller"}}`, encodeURIComponent(String(controller)))
|
|
8707
|
+
.replace(`{${"controller"}}`, encodeURIComponent(String(controller)))
|
|
8708
|
+
.replace(`{${"coordinate-system"}}`, encodeURIComponent(String(coordinateSystem)));
|
|
8872
8709
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
8873
8710
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
8874
8711
|
let baseOptions;
|
|
8875
8712
|
if (configuration) {
|
|
8876
8713
|
baseOptions = configuration.baseOptions;
|
|
8877
8714
|
}
|
|
8878
|
-
const localVarRequestOptions = { method: '
|
|
8715
|
+
const localVarRequestOptions = { method: 'DELETE', ...baseOptions, ...options };
|
|
8879
8716
|
const localVarHeaderParameter = {};
|
|
8880
8717
|
const localVarQueryParameter = {};
|
|
8881
8718
|
// authentication BasicAuth required
|
|
@@ -8884,6 +8721,9 @@ export const VirtualControllerBehaviorApiAxiosParamCreator = function (configura
|
|
|
8884
8721
|
// authentication BearerAuth required
|
|
8885
8722
|
// http bearer authentication required
|
|
8886
8723
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
8724
|
+
if (deleteDependent !== undefined) {
|
|
8725
|
+
localVarQueryParameter['delete_dependent'] = deleteDependent;
|
|
8726
|
+
}
|
|
8887
8727
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
8888
8728
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
8889
8729
|
localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
|
|
@@ -8893,29 +8733,36 @@ export const VirtualControllerBehaviorApiAxiosParamCreator = function (configura
|
|
|
8893
8733
|
};
|
|
8894
8734
|
},
|
|
8895
8735
|
/**
|
|
8896
|
-
*
|
|
8897
|
-
* @summary
|
|
8736
|
+
* Removes the TCP from the motion group. An unknown TCP is a valid input.
|
|
8737
|
+
* @summary Remove TCP
|
|
8898
8738
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8899
8739
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
8900
|
-
* @param {
|
|
8740
|
+
* @param {string} motionGroup The motion-group identifier.
|
|
8741
|
+
* @param {string} tcp The unique identifier of a TCP.
|
|
8901
8742
|
* @param {*} [options] Override http request option.
|
|
8902
8743
|
* @throws {RequiredError}
|
|
8903
8744
|
*/
|
|
8904
|
-
|
|
8745
|
+
deleteVirtualRobotTcp: async (cell, controller, motionGroup, tcp, options = {}) => {
|
|
8905
8746
|
// verify required parameter 'cell' is not null or undefined
|
|
8906
|
-
assertParamExists('
|
|
8747
|
+
assertParamExists('deleteVirtualRobotTcp', 'cell', cell);
|
|
8907
8748
|
// verify required parameter 'controller' is not null or undefined
|
|
8908
|
-
assertParamExists('
|
|
8909
|
-
|
|
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}`
|
|
8910
8755
|
.replace(`{${"cell"}}`, encodeURIComponent(String(cell)))
|
|
8911
|
-
.replace(`{${"controller"}}`, encodeURIComponent(String(controller)))
|
|
8756
|
+
.replace(`{${"controller"}}`, encodeURIComponent(String(controller)))
|
|
8757
|
+
.replace(`{${"motion-group"}}`, encodeURIComponent(String(motionGroup)))
|
|
8758
|
+
.replace(`{${"tcp"}}`, encodeURIComponent(String(tcp)));
|
|
8912
8759
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
8913
8760
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
8914
8761
|
let baseOptions;
|
|
8915
8762
|
if (configuration) {
|
|
8916
8763
|
baseOptions = configuration.baseOptions;
|
|
8917
8764
|
}
|
|
8918
|
-
const localVarRequestOptions = { method: '
|
|
8765
|
+
const localVarRequestOptions = { method: 'DELETE', ...baseOptions, ...options };
|
|
8919
8766
|
const localVarHeaderParameter = {};
|
|
8920
8767
|
const localVarQueryParameter = {};
|
|
8921
8768
|
// authentication BasicAuth required
|
|
@@ -8924,9 +8771,6 @@ export const VirtualControllerBehaviorApiAxiosParamCreator = function (configura
|
|
|
8924
8771
|
// authentication BearerAuth required
|
|
8925
8772
|
// http bearer authentication required
|
|
8926
8773
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
8927
|
-
if (behavior !== undefined) {
|
|
8928
|
-
localVarQueryParameter['behavior'] = behavior;
|
|
8929
|
-
}
|
|
8930
8774
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
8931
8775
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
8932
8776
|
localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
|
|
@@ -8935,211 +8779,63 @@ export const VirtualControllerBehaviorApiAxiosParamCreator = function (configura
|
|
|
8935
8779
|
options: localVarRequestOptions,
|
|
8936
8780
|
};
|
|
8937
8781
|
},
|
|
8938
|
-
};
|
|
8939
|
-
};
|
|
8940
|
-
/**
|
|
8941
|
-
* VirtualControllerBehaviorApi - functional programming interface
|
|
8942
|
-
* @export
|
|
8943
|
-
*/
|
|
8944
|
-
export const VirtualControllerBehaviorApiFp = function (configuration) {
|
|
8945
|
-
const localVarAxiosParamCreator = VirtualControllerBehaviorApiAxiosParamCreator(configuration);
|
|
8946
|
-
return {
|
|
8947
|
-
/**
|
|
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
|
|
8950
|
-
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8951
|
-
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
8952
|
-
* @param {ExternalJointStreamRequest} externalJointStreamRequest
|
|
8953
|
-
* @param {*} [options] Override http request option.
|
|
8954
|
-
* @throws {RequiredError}
|
|
8955
|
-
*/
|
|
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);
|
|
8961
|
-
},
|
|
8962
|
-
/**
|
|
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
8782
|
/**
|
|
9038
|
-
*
|
|
9039
|
-
* @summary Get
|
|
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
|
|
8783
|
+
* Gets motion group mounting. The motion group is based on the origin of the returned coordinate system.
|
|
8784
|
+
* @summary Get Mounting
|
|
9051
8785
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
9052
8786
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
9053
|
-
* @param {
|
|
8787
|
+
* @param {string} motionGroup The motion-group identifier.
|
|
9054
8788
|
* @param {*} [options] Override http request option.
|
|
9055
8789
|
* @throws {RequiredError}
|
|
9056
8790
|
*/
|
|
9057
|
-
|
|
9058
|
-
|
|
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
|
+
};
|
|
9059
8824
|
},
|
|
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
8825
|
/**
|
|
9127
|
-
*
|
|
9128
|
-
* @summary
|
|
8826
|
+
* Lists all coordinate systems on the robot controller.
|
|
8827
|
+
* @summary List Coordinate Systems
|
|
9129
8828
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
9130
8829
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
9131
|
-
* @param {Array<string>} ios
|
|
9132
8830
|
* @param {*} [options] Override http request option.
|
|
9133
8831
|
* @throws {RequiredError}
|
|
9134
8832
|
*/
|
|
9135
|
-
|
|
8833
|
+
listVirtualRobotCoordinateSystems: async (cell, controller, options = {}) => {
|
|
9136
8834
|
// verify required parameter 'cell' is not null or undefined
|
|
9137
|
-
assertParamExists('
|
|
8835
|
+
assertParamExists('listVirtualRobotCoordinateSystems', 'cell', cell);
|
|
9138
8836
|
// verify required parameter 'controller' is not null or undefined
|
|
9139
|
-
assertParamExists('
|
|
9140
|
-
|
|
9141
|
-
assertParamExists('listIOs', 'ios', ios);
|
|
9142
|
-
const localVarPath = `/cells/{cell}/virtual-controllers/{controller}/ios/values`
|
|
8837
|
+
assertParamExists('listVirtualRobotCoordinateSystems', 'controller', controller);
|
|
8838
|
+
const localVarPath = `/cells/{cell}/controllers/{controller}/teach-pendant/coordinate-systems`
|
|
9143
8839
|
.replace(`{${"cell"}}`, encodeURIComponent(String(cell)))
|
|
9144
8840
|
.replace(`{${"controller"}}`, encodeURIComponent(String(controller)));
|
|
9145
8841
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
@@ -9157,9 +8853,6 @@ export const VirtualControllerInputsOutputsApiAxiosParamCreator = function (conf
|
|
|
9157
8853
|
// authentication BearerAuth required
|
|
9158
8854
|
// http bearer authentication required
|
|
9159
8855
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
9160
|
-
if (ios) {
|
|
9161
|
-
localVarQueryParameter['ios'] = ios;
|
|
9162
|
-
}
|
|
9163
8856
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
9164
8857
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
9165
8858
|
localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
|
|
@@ -9169,25 +8862,25 @@ export const VirtualControllerInputsOutputsApiAxiosParamCreator = function (conf
|
|
|
9169
8862
|
};
|
|
9170
8863
|
},
|
|
9171
8864
|
/**
|
|
9172
|
-
* Lists
|
|
9173
|
-
* @summary List
|
|
8865
|
+
* Lists TCPs of the motion group. An empty TCP list is valid, for example for external axes.
|
|
8866
|
+
* @summary List TCPs
|
|
9174
8867
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
9175
8868
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
9176
|
-
* @param {
|
|
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.
|
|
8869
|
+
* @param {string} motionGroup The motion-group identifier.
|
|
9180
8870
|
* @param {*} [options] Override http request option.
|
|
9181
8871
|
* @throws {RequiredError}
|
|
9182
8872
|
*/
|
|
9183
|
-
|
|
8873
|
+
listVirtualRobotTcps: async (cell, controller, motionGroup, options = {}) => {
|
|
9184
8874
|
// verify required parameter 'cell' is not null or undefined
|
|
9185
|
-
assertParamExists('
|
|
8875
|
+
assertParamExists('listVirtualRobotTcps', 'cell', cell);
|
|
9186
8876
|
// verify required parameter 'controller' is not null or undefined
|
|
9187
|
-
assertParamExists('
|
|
9188
|
-
|
|
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`
|
|
9189
8881
|
.replace(`{${"cell"}}`, encodeURIComponent(String(cell)))
|
|
9190
|
-
.replace(`{${"controller"}}`, encodeURIComponent(String(controller)))
|
|
8882
|
+
.replace(`{${"controller"}}`, encodeURIComponent(String(controller)))
|
|
8883
|
+
.replace(`{${"motion-group"}}`, encodeURIComponent(String(motionGroup)));
|
|
9191
8884
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
9192
8885
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
9193
8886
|
let baseOptions;
|
|
@@ -9202,19 +8895,7 @@ export const VirtualControllerInputsOutputsApiAxiosParamCreator = function (conf
|
|
|
9202
8895
|
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
9203
8896
|
// authentication BearerAuth required
|
|
9204
8897
|
// http bearer authentication required
|
|
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
|
-
}
|
|
8898
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
9218
8899
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
9219
8900
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
9220
8901
|
localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
|
|
@@ -9224,24 +8905,28 @@ export const VirtualControllerInputsOutputsApiAxiosParamCreator = function (conf
|
|
|
9224
8905
|
};
|
|
9225
8906
|
},
|
|
9226
8907
|
/**
|
|
9227
|
-
* Sets a
|
|
9228
|
-
* @summary Set
|
|
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
|
|
9229
8910
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
9230
8911
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
9231
|
-
* @param {
|
|
8912
|
+
* @param {string} motionGroup The motion-group identifier.
|
|
8913
|
+
* @param {CoordinateSystem} coordinateSystem
|
|
9232
8914
|
* @param {*} [options] Override http request option.
|
|
9233
8915
|
* @throws {RequiredError}
|
|
9234
8916
|
*/
|
|
9235
|
-
|
|
8917
|
+
setVirtualRobotMounting: async (cell, controller, motionGroup, coordinateSystem, options = {}) => {
|
|
9236
8918
|
// verify required parameter 'cell' is not null or undefined
|
|
9237
|
-
assertParamExists('
|
|
8919
|
+
assertParamExists('setVirtualRobotMounting', 'cell', cell);
|
|
9238
8920
|
// verify required parameter 'controller' is not null or undefined
|
|
9239
|
-
assertParamExists('
|
|
9240
|
-
// verify required parameter '
|
|
9241
|
-
assertParamExists('
|
|
9242
|
-
|
|
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`
|
|
9243
8927
|
.replace(`{${"cell"}}`, encodeURIComponent(String(cell)))
|
|
9244
|
-
.replace(`{${"controller"}}`, encodeURIComponent(String(controller)))
|
|
8928
|
+
.replace(`{${"controller"}}`, encodeURIComponent(String(controller)))
|
|
8929
|
+
.replace(`{${"motion-group"}}`, encodeURIComponent(String(motionGroup)));
|
|
9245
8930
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
9246
8931
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
9247
8932
|
let baseOptions;
|
|
@@ -9261,7 +8946,7 @@ export const VirtualControllerInputsOutputsApiAxiosParamCreator = function (conf
|
|
|
9261
8946
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
9262
8947
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
9263
8948
|
localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
|
|
9264
|
-
localVarRequestOptions.data = serializeDataIfNeeded(
|
|
8949
|
+
localVarRequestOptions.data = serializeDataIfNeeded(coordinateSystem, localVarRequestOptions, configuration);
|
|
9265
8950
|
return {
|
|
9266
8951
|
url: toPathString(localVarUrlObj),
|
|
9267
8952
|
options: localVarRequestOptions,
|
|
@@ -9270,158 +8955,358 @@ export const VirtualControllerInputsOutputsApiAxiosParamCreator = function (conf
|
|
|
9270
8955
|
};
|
|
9271
8956
|
};
|
|
9272
8957
|
/**
|
|
9273
|
-
*
|
|
8958
|
+
* VirtualRobotSetupApi - functional programming interface
|
|
9274
8959
|
* @export
|
|
9275
8960
|
*/
|
|
9276
|
-
export const
|
|
9277
|
-
const localVarAxiosParamCreator =
|
|
8961
|
+
export const VirtualRobotSetupApiFp = function (configuration) {
|
|
8962
|
+
const localVarAxiosParamCreator = VirtualRobotSetupApiAxiosParamCreator(configuration);
|
|
9278
8963
|
return {
|
|
9279
8964
|
/**
|
|
9280
|
-
*
|
|
9281
|
-
* @summary
|
|
8965
|
+
* Adds a coordinate system to the robot controller.
|
|
8966
|
+
* @summary Add Coordinate Systems
|
|
9282
8967
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
9283
8968
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
9284
|
-
* @param {
|
|
8969
|
+
* @param {CoordinateSystem} coordinateSystem
|
|
9285
8970
|
* @param {*} [options] Override http request option.
|
|
9286
8971
|
* @throws {RequiredError}
|
|
9287
8972
|
*/
|
|
9288
|
-
async
|
|
9289
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.
|
|
8973
|
+
async addVirtualRobotCoordinateSystem(cell, controller, coordinateSystem, options) {
|
|
8974
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.addVirtualRobotCoordinateSystem(cell, controller, coordinateSystem, options);
|
|
9290
8975
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
9291
|
-
const localVarOperationServerBasePath = operationServerMap['
|
|
8976
|
+
const localVarOperationServerBasePath = operationServerMap['VirtualRobotSetupApi.addVirtualRobotCoordinateSystem']?.[localVarOperationServerIndex]?.url;
|
|
9292
8977
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
9293
8978
|
},
|
|
9294
8979
|
/**
|
|
9295
|
-
*
|
|
9296
|
-
* @summary
|
|
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
|
|
9297
8982
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
9298
8983
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
9299
|
-
* @param {
|
|
9300
|
-
* @param {
|
|
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.
|
|
8984
|
+
* @param {string} motionGroup The motion-group identifier.
|
|
8985
|
+
* @param {RobotTcp} robotTcp
|
|
9303
8986
|
* @param {*} [options] Override http request option.
|
|
9304
8987
|
* @throws {RequiredError}
|
|
9305
8988
|
*/
|
|
9306
|
-
async
|
|
9307
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.
|
|
8989
|
+
async addVirtualRobotTcp(cell, controller, motionGroup, robotTcp, options) {
|
|
8990
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.addVirtualRobotTcp(cell, controller, motionGroup, robotTcp, options);
|
|
9308
8991
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
9309
|
-
const localVarOperationServerBasePath = operationServerMap['
|
|
8992
|
+
const localVarOperationServerBasePath = operationServerMap['VirtualRobotSetupApi.addVirtualRobotTcp']?.[localVarOperationServerIndex]?.url;
|
|
9310
8993
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
9311
8994
|
},
|
|
9312
8995
|
/**
|
|
9313
|
-
*
|
|
9314
|
-
* @summary
|
|
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
|
|
9315
8998
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
9316
8999
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
9317
|
-
* @param {
|
|
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.
|
|
9318
9002
|
* @param {*} [options] Override http request option.
|
|
9319
9003
|
* @throws {RequiredError}
|
|
9320
9004
|
*/
|
|
9321
|
-
async
|
|
9322
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.
|
|
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
|
|
9045
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
9046
|
+
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
9047
|
+
* @param {*} [options] Override http request option.
|
|
9048
|
+
* @throws {RequiredError}
|
|
9049
|
+
*/
|
|
9050
|
+
async listVirtualRobotCoordinateSystems(cell, controller, options) {
|
|
9051
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.listVirtualRobotCoordinateSystems(cell, controller, options);
|
|
9052
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
9053
|
+
const localVarOperationServerBasePath = operationServerMap['VirtualRobotSetupApi.listVirtualRobotCoordinateSystems']?.[localVarOperationServerIndex]?.url;
|
|
9054
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
9055
|
+
},
|
|
9056
|
+
/**
|
|
9057
|
+
* Lists TCPs of the motion group. An empty TCP list is valid, for example for external axes.
|
|
9058
|
+
* @summary List TCPs
|
|
9059
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
9060
|
+
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
9061
|
+
* @param {string} motionGroup The motion-group identifier.
|
|
9062
|
+
* @param {*} [options] Override http request option.
|
|
9063
|
+
* @throws {RequiredError}
|
|
9064
|
+
*/
|
|
9065
|
+
async listVirtualRobotTcps(cell, controller, motionGroup, options) {
|
|
9066
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.listVirtualRobotTcps(cell, controller, motionGroup, options);
|
|
9067
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
9068
|
+
const localVarOperationServerBasePath = operationServerMap['VirtualRobotSetupApi.listVirtualRobotTcps']?.[localVarOperationServerIndex]?.url;
|
|
9069
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
9070
|
+
},
|
|
9071
|
+
/**
|
|
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
|
|
9074
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
9075
|
+
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
9076
|
+
* @param {string} motionGroup The motion-group identifier.
|
|
9077
|
+
* @param {CoordinateSystem} coordinateSystem
|
|
9078
|
+
* @param {*} [options] Override http request option.
|
|
9079
|
+
* @throws {RequiredError}
|
|
9080
|
+
*/
|
|
9081
|
+
async setVirtualRobotMounting(cell, controller, motionGroup, coordinateSystem, options) {
|
|
9082
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.setVirtualRobotMounting(cell, controller, motionGroup, coordinateSystem, options);
|
|
9323
9083
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
9324
|
-
const localVarOperationServerBasePath = operationServerMap['
|
|
9084
|
+
const localVarOperationServerBasePath = operationServerMap['VirtualRobotSetupApi.setVirtualRobotMounting']?.[localVarOperationServerIndex]?.url;
|
|
9325
9085
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
9326
9086
|
},
|
|
9327
9087
|
};
|
|
9328
9088
|
};
|
|
9329
9089
|
/**
|
|
9330
|
-
*
|
|
9090
|
+
* VirtualRobotSetupApi - factory interface
|
|
9331
9091
|
* @export
|
|
9332
9092
|
*/
|
|
9333
|
-
export const
|
|
9334
|
-
const localVarFp =
|
|
9093
|
+
export const VirtualRobotSetupApiFactory = function (configuration, basePath, axios) {
|
|
9094
|
+
const localVarFp = VirtualRobotSetupApiFp(configuration);
|
|
9335
9095
|
return {
|
|
9336
9096
|
/**
|
|
9337
|
-
*
|
|
9338
|
-
* @summary
|
|
9097
|
+
* Adds a coordinate system to the robot controller.
|
|
9098
|
+
* @summary Add Coordinate Systems
|
|
9339
9099
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
9340
9100
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
9341
|
-
* @param {
|
|
9101
|
+
* @param {CoordinateSystem} coordinateSystem
|
|
9342
9102
|
* @param {*} [options] Override http request option.
|
|
9343
9103
|
* @throws {RequiredError}
|
|
9344
9104
|
*/
|
|
9345
|
-
|
|
9346
|
-
return localVarFp.
|
|
9105
|
+
addVirtualRobotCoordinateSystem(cell, controller, coordinateSystem, options) {
|
|
9106
|
+
return localVarFp.addVirtualRobotCoordinateSystem(cell, controller, coordinateSystem, options).then((request) => request(axios, basePath));
|
|
9347
9107
|
},
|
|
9348
9108
|
/**
|
|
9349
|
-
*
|
|
9350
|
-
* @summary
|
|
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
|
|
9351
9111
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
9352
9112
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
9353
|
-
* @param {
|
|
9354
|
-
* @param {
|
|
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.
|
|
9113
|
+
* @param {string} motionGroup The motion-group identifier.
|
|
9114
|
+
* @param {RobotTcp} robotTcp
|
|
9357
9115
|
* @param {*} [options] Override http request option.
|
|
9358
9116
|
* @throws {RequiredError}
|
|
9359
9117
|
*/
|
|
9360
|
-
|
|
9361
|
-
return localVarFp.
|
|
9118
|
+
addVirtualRobotTcp(cell, controller, motionGroup, robotTcp, options) {
|
|
9119
|
+
return localVarFp.addVirtualRobotTcp(cell, controller, motionGroup, robotTcp, options).then((request) => request(axios, basePath));
|
|
9362
9120
|
},
|
|
9363
9121
|
/**
|
|
9364
|
-
*
|
|
9365
|
-
* @summary
|
|
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
|
|
9366
9124
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
9367
9125
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
9368
|
-
* @param {
|
|
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.
|
|
9369
9128
|
* @param {*} [options] Override http request option.
|
|
9370
9129
|
* @throws {RequiredError}
|
|
9371
9130
|
*/
|
|
9372
|
-
|
|
9373
|
-
return localVarFp.
|
|
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
|
|
9162
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
9163
|
+
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
9164
|
+
* @param {*} [options] Override http request option.
|
|
9165
|
+
* @throws {RequiredError}
|
|
9166
|
+
*/
|
|
9167
|
+
listVirtualRobotCoordinateSystems(cell, controller, options) {
|
|
9168
|
+
return localVarFp.listVirtualRobotCoordinateSystems(cell, controller, options).then((request) => request(axios, basePath));
|
|
9169
|
+
},
|
|
9170
|
+
/**
|
|
9171
|
+
* Lists TCPs of the motion group. An empty TCP list is valid, for example for external axes.
|
|
9172
|
+
* @summary List TCPs
|
|
9173
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
9174
|
+
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
9175
|
+
* @param {string} motionGroup The motion-group identifier.
|
|
9176
|
+
* @param {*} [options] Override http request option.
|
|
9177
|
+
* @throws {RequiredError}
|
|
9178
|
+
*/
|
|
9179
|
+
listVirtualRobotTcps(cell, controller, motionGroup, options) {
|
|
9180
|
+
return localVarFp.listVirtualRobotTcps(cell, controller, motionGroup, options).then((request) => request(axios, basePath));
|
|
9181
|
+
},
|
|
9182
|
+
/**
|
|
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
|
|
9185
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
9186
|
+
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
9187
|
+
* @param {string} motionGroup The motion-group identifier.
|
|
9188
|
+
* @param {CoordinateSystem} coordinateSystem
|
|
9189
|
+
* @param {*} [options] Override http request option.
|
|
9190
|
+
* @throws {RequiredError}
|
|
9191
|
+
*/
|
|
9192
|
+
setVirtualRobotMounting(cell, controller, motionGroup, coordinateSystem, options) {
|
|
9193
|
+
return localVarFp.setVirtualRobotMounting(cell, controller, motionGroup, coordinateSystem, options).then((request) => request(axios, basePath));
|
|
9374
9194
|
},
|
|
9375
9195
|
};
|
|
9376
9196
|
};
|
|
9377
9197
|
/**
|
|
9378
|
-
*
|
|
9198
|
+
* VirtualRobotSetupApi - object-oriented interface
|
|
9379
9199
|
* @export
|
|
9380
|
-
* @class
|
|
9200
|
+
* @class VirtualRobotSetupApi
|
|
9381
9201
|
* @extends {BaseAPI}
|
|
9382
9202
|
*/
|
|
9383
|
-
export class
|
|
9203
|
+
export class VirtualRobotSetupApi extends BaseAPI {
|
|
9384
9204
|
/**
|
|
9385
|
-
*
|
|
9386
|
-
* @summary
|
|
9205
|
+
* Adds a coordinate system to the robot controller.
|
|
9206
|
+
* @summary Add Coordinate Systems
|
|
9387
9207
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
9388
9208
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
9389
|
-
* @param {
|
|
9209
|
+
* @param {CoordinateSystem} coordinateSystem
|
|
9390
9210
|
* @param {*} [options] Override http request option.
|
|
9391
9211
|
* @throws {RequiredError}
|
|
9392
|
-
* @memberof
|
|
9212
|
+
* @memberof VirtualRobotSetupApi
|
|
9393
9213
|
*/
|
|
9394
|
-
|
|
9395
|
-
return
|
|
9214
|
+
addVirtualRobotCoordinateSystem(cell, controller, coordinateSystem, options) {
|
|
9215
|
+
return VirtualRobotSetupApiFp(this.configuration).addVirtualRobotCoordinateSystem(cell, controller, coordinateSystem, options).then((request) => request(this.axios, this.basePath));
|
|
9396
9216
|
}
|
|
9397
9217
|
/**
|
|
9398
|
-
*
|
|
9399
|
-
* @summary
|
|
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
|
|
9400
9220
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
9401
9221
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
9402
|
-
* @param {
|
|
9403
|
-
* @param {
|
|
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.
|
|
9222
|
+
* @param {string} motionGroup The motion-group identifier.
|
|
9223
|
+
* @param {RobotTcp} robotTcp
|
|
9406
9224
|
* @param {*} [options] Override http request option.
|
|
9407
9225
|
* @throws {RequiredError}
|
|
9408
|
-
* @memberof
|
|
9226
|
+
* @memberof VirtualRobotSetupApi
|
|
9409
9227
|
*/
|
|
9410
|
-
|
|
9411
|
-
return
|
|
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));
|
|
9412
9230
|
}
|
|
9413
9231
|
/**
|
|
9414
|
-
*
|
|
9415
|
-
* @summary
|
|
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
|
|
9416
9234
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
9417
9235
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
9418
|
-
* @param {
|
|
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.
|
|
9419
9238
|
* @param {*} [options] Override http request option.
|
|
9420
9239
|
* @throws {RequiredError}
|
|
9421
|
-
* @memberof
|
|
9240
|
+
* @memberof VirtualRobotSetupApi
|
|
9422
9241
|
*/
|
|
9423
|
-
|
|
9424
|
-
return
|
|
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
|
|
9275
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
9276
|
+
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
9277
|
+
* @param {*} [options] Override http request option.
|
|
9278
|
+
* @throws {RequiredError}
|
|
9279
|
+
* @memberof VirtualRobotSetupApi
|
|
9280
|
+
*/
|
|
9281
|
+
listVirtualRobotCoordinateSystems(cell, controller, options) {
|
|
9282
|
+
return VirtualRobotSetupApiFp(this.configuration).listVirtualRobotCoordinateSystems(cell, controller, options).then((request) => request(this.axios, this.basePath));
|
|
9283
|
+
}
|
|
9284
|
+
/**
|
|
9285
|
+
* Lists TCPs of the motion group. An empty TCP list is valid, for example for external axes.
|
|
9286
|
+
* @summary List TCPs
|
|
9287
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
9288
|
+
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
9289
|
+
* @param {string} motionGroup The motion-group identifier.
|
|
9290
|
+
* @param {*} [options] Override http request option.
|
|
9291
|
+
* @throws {RequiredError}
|
|
9292
|
+
* @memberof VirtualRobotSetupApi
|
|
9293
|
+
*/
|
|
9294
|
+
listVirtualRobotTcps(cell, controller, motionGroup, options) {
|
|
9295
|
+
return VirtualRobotSetupApiFp(this.configuration).listVirtualRobotTcps(cell, controller, motionGroup, options).then((request) => request(this.axios, this.basePath));
|
|
9296
|
+
}
|
|
9297
|
+
/**
|
|
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
|
|
9300
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
9301
|
+
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
9302
|
+
* @param {string} motionGroup The motion-group identifier.
|
|
9303
|
+
* @param {CoordinateSystem} coordinateSystem
|
|
9304
|
+
* @param {*} [options] Override http request option.
|
|
9305
|
+
* @throws {RequiredError}
|
|
9306
|
+
* @memberof VirtualRobotSetupApi
|
|
9307
|
+
*/
|
|
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));
|
|
9425
9310
|
}
|
|
9426
9311
|
}
|
|
9427
9312
|
//# sourceMappingURL=api.js.map
|