@wandelbots/nova-api 25.6.0-dev.30 → 25.6.0-dev.32
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/v2/api.d.ts +121 -285
- package/v2/api.js +126 -126
- package/v2/api.js.map +1 -1
- package/v2/api.ts +160 -326
package/v2/api.js
CHANGED
|
@@ -2192,17 +2192,22 @@ export const ControllerApiAxiosParamCreator = function (configuration) {
|
|
|
2192
2192
|
};
|
|
2193
2193
|
},
|
|
2194
2194
|
/**
|
|
2195
|
-
*
|
|
2196
|
-
* @summary List
|
|
2195
|
+
* 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.
|
|
2196
|
+
* @summary List Coordinate Systems
|
|
2197
2197
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
2198
|
+
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
2199
|
+
* @param {OrientationType} [orientationType]
|
|
2198
2200
|
* @param {*} [options] Override http request option.
|
|
2199
2201
|
* @throws {RequiredError}
|
|
2200
2202
|
*/
|
|
2201
|
-
|
|
2203
|
+
listCoordinateSystems: async (cell, controller, orientationType, options = {}) => {
|
|
2202
2204
|
// verify required parameter 'cell' is not null or undefined
|
|
2203
|
-
assertParamExists('
|
|
2204
|
-
|
|
2205
|
-
|
|
2205
|
+
assertParamExists('listCoordinateSystems', 'cell', cell);
|
|
2206
|
+
// verify required parameter 'controller' is not null or undefined
|
|
2207
|
+
assertParamExists('listCoordinateSystems', 'controller', controller);
|
|
2208
|
+
const localVarPath = `/cells/{cell}/controllers/{controller}/coordinate-systems`
|
|
2209
|
+
.replace(`{${"cell"}}`, encodeURIComponent(String(cell)))
|
|
2210
|
+
.replace(`{${"controller"}}`, encodeURIComponent(String(controller)));
|
|
2206
2211
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
2207
2212
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
2208
2213
|
let baseOptions;
|
|
@@ -2218,6 +2223,9 @@ export const ControllerApiAxiosParamCreator = function (configuration) {
|
|
|
2218
2223
|
// authentication BearerAuth required
|
|
2219
2224
|
// http bearer authentication required
|
|
2220
2225
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
2226
|
+
if (orientationType !== undefined) {
|
|
2227
|
+
localVarQueryParameter['orientation_type'] = orientationType;
|
|
2228
|
+
}
|
|
2221
2229
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
2222
2230
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
2223
2231
|
localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
|
|
@@ -2227,22 +2235,17 @@ export const ControllerApiAxiosParamCreator = function (configuration) {
|
|
|
2227
2235
|
};
|
|
2228
2236
|
},
|
|
2229
2237
|
/**
|
|
2230
|
-
*
|
|
2231
|
-
* @summary List
|
|
2238
|
+
* List the names of all deployed robot controllers.
|
|
2239
|
+
* @summary List Robot Controllers
|
|
2232
2240
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
2233
|
-
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
2234
|
-
* @param {OrientationType} [orientationType]
|
|
2235
2241
|
* @param {*} [options] Override http request option.
|
|
2236
2242
|
* @throws {RequiredError}
|
|
2237
2243
|
*/
|
|
2238
|
-
|
|
2244
|
+
listRobotControllers: async (cell, options = {}) => {
|
|
2239
2245
|
// verify required parameter 'cell' is not null or undefined
|
|
2240
|
-
assertParamExists('
|
|
2241
|
-
|
|
2242
|
-
|
|
2243
|
-
const localVarPath = `/cells/{cell}/controllers/{controller}/coordinate-systems`
|
|
2244
|
-
.replace(`{${"cell"}}`, encodeURIComponent(String(cell)))
|
|
2245
|
-
.replace(`{${"controller"}}`, encodeURIComponent(String(controller)));
|
|
2246
|
+
assertParamExists('listRobotControllers', 'cell', cell);
|
|
2247
|
+
const localVarPath = `/cells/{cell}/controllers`
|
|
2248
|
+
.replace(`{${"cell"}}`, encodeURIComponent(String(cell)));
|
|
2246
2249
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
2247
2250
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
2248
2251
|
let baseOptions;
|
|
@@ -2258,9 +2261,6 @@ export const ControllerApiAxiosParamCreator = function (configuration) {
|
|
|
2258
2261
|
// authentication BearerAuth required
|
|
2259
2262
|
// http bearer authentication required
|
|
2260
2263
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
2261
|
-
if (orientationType !== undefined) {
|
|
2262
|
-
localVarQueryParameter['orientation_type'] = orientationType;
|
|
2263
|
-
}
|
|
2264
2264
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
2265
2265
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
2266
2266
|
localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
|
|
@@ -2574,31 +2574,31 @@ export const ControllerApiFp = function (configuration) {
|
|
|
2574
2574
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
2575
2575
|
},
|
|
2576
2576
|
/**
|
|
2577
|
-
*
|
|
2578
|
-
* @summary List
|
|
2577
|
+
* 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.
|
|
2578
|
+
* @summary List Coordinate Systems
|
|
2579
2579
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
2580
|
+
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
2581
|
+
* @param {OrientationType} [orientationType]
|
|
2580
2582
|
* @param {*} [options] Override http request option.
|
|
2581
2583
|
* @throws {RequiredError}
|
|
2582
2584
|
*/
|
|
2583
|
-
async
|
|
2584
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.
|
|
2585
|
+
async listCoordinateSystems(cell, controller, orientationType, options) {
|
|
2586
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.listCoordinateSystems(cell, controller, orientationType, options);
|
|
2585
2587
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
2586
|
-
const localVarOperationServerBasePath = operationServerMap['ControllerApi.
|
|
2588
|
+
const localVarOperationServerBasePath = operationServerMap['ControllerApi.listCoordinateSystems']?.[localVarOperationServerIndex]?.url;
|
|
2587
2589
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
2588
2590
|
},
|
|
2589
2591
|
/**
|
|
2590
|
-
*
|
|
2591
|
-
* @summary List
|
|
2592
|
+
* List the names of all deployed robot controllers.
|
|
2593
|
+
* @summary List Robot Controllers
|
|
2592
2594
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
2593
|
-
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
2594
|
-
* @param {OrientationType} [orientationType]
|
|
2595
2595
|
* @param {*} [options] Override http request option.
|
|
2596
2596
|
* @throws {RequiredError}
|
|
2597
2597
|
*/
|
|
2598
|
-
async
|
|
2599
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.
|
|
2598
|
+
async listRobotControllers(cell, options) {
|
|
2599
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.listRobotControllers(cell, options);
|
|
2600
2600
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
2601
|
-
const localVarOperationServerBasePath = operationServerMap['ControllerApi.
|
|
2601
|
+
const localVarOperationServerBasePath = operationServerMap['ControllerApi.listRobotControllers']?.[localVarOperationServerIndex]?.url;
|
|
2602
2602
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
2603
2603
|
},
|
|
2604
2604
|
/**
|
|
@@ -2763,16 +2763,6 @@ export const ControllerApiFactory = function (configuration, basePath, axios) {
|
|
|
2763
2763
|
getVirtualRobotConfiguration(cell, controller, options) {
|
|
2764
2764
|
return localVarFp.getVirtualRobotConfiguration(cell, controller, options).then((request) => request(axios, basePath));
|
|
2765
2765
|
},
|
|
2766
|
-
/**
|
|
2767
|
-
* List all configured robot controllers.
|
|
2768
|
-
* @summary List Descriptions
|
|
2769
|
-
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
2770
|
-
* @param {*} [options] Override http request option.
|
|
2771
|
-
* @throws {RequiredError}
|
|
2772
|
-
*/
|
|
2773
|
-
listControllers(cell, options) {
|
|
2774
|
-
return localVarFp.listControllers(cell, options).then((request) => request(axios, basePath));
|
|
2775
|
-
},
|
|
2776
2766
|
/**
|
|
2777
2767
|
* 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.
|
|
2778
2768
|
* @summary List Coordinate Systems
|
|
@@ -2785,6 +2775,16 @@ export const ControllerApiFactory = function (configuration, basePath, axios) {
|
|
|
2785
2775
|
listCoordinateSystems(cell, controller, orientationType, options) {
|
|
2786
2776
|
return localVarFp.listCoordinateSystems(cell, controller, orientationType, options).then((request) => request(axios, basePath));
|
|
2787
2777
|
},
|
|
2778
|
+
/**
|
|
2779
|
+
* List the names of all deployed robot controllers.
|
|
2780
|
+
* @summary List Robot Controllers
|
|
2781
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
2782
|
+
* @param {*} [options] Override http request option.
|
|
2783
|
+
* @throws {RequiredError}
|
|
2784
|
+
*/
|
|
2785
|
+
listRobotControllers(cell, options) {
|
|
2786
|
+
return localVarFp.listRobotControllers(cell, options).then((request) => request(axios, basePath));
|
|
2787
|
+
},
|
|
2788
2788
|
/**
|
|
2789
2789
|
* Switch between monitor and control usage as default for a robot controller. Monitoring mode is used to read information from the robot controller and control mode is used to command the robot system. As long as the robot controller is connected via network monitoring mode is always possible. To switch to control mode the robot controller must be in `automatic` or `manual` operating mode and safety state \'normal\' or \'reduced\'. If the robot controller is in `manual` operating mode, you have manually confirm the control usage activation on the robot control panel. This manual confirmation can\'t be replaced with this API. Without manual confirmation the robot controller will stay in monitor mode. The robot system will try to activate the required operation mode for the requested usage unless no active call requires a different mode. > **NOTE** > > Some robot controllers prevent the external activation of automatic operating mode. In this case, changing the operating mode manually at the robot controller is mandatory. > **NOTE** > > The current operation mode and safety state can be requested via [getCurrentRobotControllerState](getCurrentRobotControllerState). If a mode change is not possible, the response lists reasons for the failed change.
|
|
2790
2790
|
* @summary Set Default Mode
|
|
@@ -2944,28 +2944,28 @@ export class ControllerApi extends BaseAPI {
|
|
|
2944
2944
|
return ControllerApiFp(this.configuration).getVirtualRobotConfiguration(cell, controller, options).then((request) => request(this.axios, this.basePath));
|
|
2945
2945
|
}
|
|
2946
2946
|
/**
|
|
2947
|
-
*
|
|
2948
|
-
* @summary List
|
|
2947
|
+
* 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.
|
|
2948
|
+
* @summary List Coordinate Systems
|
|
2949
2949
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
2950
|
+
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
2951
|
+
* @param {OrientationType} [orientationType]
|
|
2950
2952
|
* @param {*} [options] Override http request option.
|
|
2951
2953
|
* @throws {RequiredError}
|
|
2952
2954
|
* @memberof ControllerApi
|
|
2953
2955
|
*/
|
|
2954
|
-
|
|
2955
|
-
return ControllerApiFp(this.configuration).
|
|
2956
|
+
listCoordinateSystems(cell, controller, orientationType, options) {
|
|
2957
|
+
return ControllerApiFp(this.configuration).listCoordinateSystems(cell, controller, orientationType, options).then((request) => request(this.axios, this.basePath));
|
|
2956
2958
|
}
|
|
2957
2959
|
/**
|
|
2958
|
-
*
|
|
2959
|
-
* @summary List
|
|
2960
|
+
* List the names of all deployed robot controllers.
|
|
2961
|
+
* @summary List Robot Controllers
|
|
2960
2962
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
2961
|
-
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
2962
|
-
* @param {OrientationType} [orientationType]
|
|
2963
2963
|
* @param {*} [options] Override http request option.
|
|
2964
2964
|
* @throws {RequiredError}
|
|
2965
2965
|
* @memberof ControllerApi
|
|
2966
2966
|
*/
|
|
2967
|
-
|
|
2968
|
-
return ControllerApiFp(this.configuration).
|
|
2967
|
+
listRobotControllers(cell, options) {
|
|
2968
|
+
return ControllerApiFp(this.configuration).listRobotControllers(cell, options).then((request) => request(this.axios, this.basePath));
|
|
2969
2969
|
}
|
|
2970
2970
|
/**
|
|
2971
2971
|
* Switch between monitor and control usage as default for a robot controller. Monitoring mode is used to read information from the robot controller and control mode is used to command the robot system. As long as the robot controller is connected via network monitoring mode is always possible. To switch to control mode the robot controller must be in `automatic` or `manual` operating mode and safety state \'normal\' or \'reduced\'. If the robot controller is in `manual` operating mode, you have manually confirm the control usage activation on the robot control panel. This manual confirmation can\'t be replaced with this API. Without manual confirmation the robot controller will stay in monitor mode. The robot system will try to activate the required operation mode for the requested usage unless no active call requires a different mode. > **NOTE** > > Some robot controllers prevent the external activation of automatic operating mode. In this case, changing the operating mode manually at the robot controller is mandatory. > **NOTE** > > The current operation mode and safety state can be requested via [getCurrentRobotControllerState](getCurrentRobotControllerState). If a mode change is not possible, the response lists reasons for the failed change.
|
|
@@ -3494,23 +3494,25 @@ export class ControllerInputsOutputsApi extends BaseAPI {
|
|
|
3494
3494
|
}
|
|
3495
3495
|
}
|
|
3496
3496
|
/**
|
|
3497
|
-
*
|
|
3497
|
+
* JoggingApi - axios parameter creator
|
|
3498
3498
|
* @export
|
|
3499
3499
|
*/
|
|
3500
|
-
export const
|
|
3500
|
+
export const JoggingApiAxiosParamCreator = function (configuration) {
|
|
3501
3501
|
return {
|
|
3502
3502
|
/**
|
|
3503
|
-
*
|
|
3504
|
-
* @summary
|
|
3503
|
+
* <!-- 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.
|
|
3504
|
+
* @summary Execute Jogging
|
|
3505
3505
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
3506
|
-
* @param {
|
|
3506
|
+
* @param {ExecuteJoggingRequest} executeJoggingRequest
|
|
3507
3507
|
* @param {*} [options] Override http request option.
|
|
3508
3508
|
* @throws {RequiredError}
|
|
3509
3509
|
*/
|
|
3510
|
-
|
|
3510
|
+
executeJogging: async (cell, executeJoggingRequest, options = {}) => {
|
|
3511
3511
|
// verify required parameter 'cell' is not null or undefined
|
|
3512
|
-
assertParamExists('
|
|
3513
|
-
|
|
3512
|
+
assertParamExists('executeJogging', 'cell', cell);
|
|
3513
|
+
// verify required parameter 'executeJoggingRequest' is not null or undefined
|
|
3514
|
+
assertParamExists('executeJogging', 'executeJoggingRequest', executeJoggingRequest);
|
|
3515
|
+
const localVarPath = `/cells/{cell}/execution/jogging`
|
|
3514
3516
|
.replace(`{${"cell"}}`, encodeURIComponent(String(cell)));
|
|
3515
3517
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
3516
3518
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
@@ -3518,7 +3520,7 @@ export const InverseKinematicsApiAxiosParamCreator = function (configuration) {
|
|
|
3518
3520
|
if (configuration) {
|
|
3519
3521
|
baseOptions = configuration.baseOptions;
|
|
3520
3522
|
}
|
|
3521
|
-
const localVarRequestOptions = { method: '
|
|
3523
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options };
|
|
3522
3524
|
const localVarHeaderParameter = {};
|
|
3523
3525
|
const localVarQueryParameter = {};
|
|
3524
3526
|
// authentication BasicAuth required
|
|
@@ -3531,7 +3533,7 @@ export const InverseKinematicsApiAxiosParamCreator = function (configuration) {
|
|
|
3531
3533
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
3532
3534
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
3533
3535
|
localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
|
|
3534
|
-
localVarRequestOptions.data = serializeDataIfNeeded(
|
|
3536
|
+
localVarRequestOptions.data = serializeDataIfNeeded(executeJoggingRequest, localVarRequestOptions, configuration);
|
|
3535
3537
|
return {
|
|
3536
3538
|
url: toPathString(localVarUrlObj),
|
|
3537
3539
|
options: localVarRequestOptions,
|
|
@@ -3540,88 +3542,86 @@ export const InverseKinematicsApiAxiosParamCreator = function (configuration) {
|
|
|
3540
3542
|
};
|
|
3541
3543
|
};
|
|
3542
3544
|
/**
|
|
3543
|
-
*
|
|
3545
|
+
* JoggingApi - functional programming interface
|
|
3544
3546
|
* @export
|
|
3545
3547
|
*/
|
|
3546
|
-
export const
|
|
3547
|
-
const localVarAxiosParamCreator =
|
|
3548
|
+
export const JoggingApiFp = function (configuration) {
|
|
3549
|
+
const localVarAxiosParamCreator = JoggingApiAxiosParamCreator(configuration);
|
|
3548
3550
|
return {
|
|
3549
3551
|
/**
|
|
3550
|
-
*
|
|
3551
|
-
* @summary
|
|
3552
|
+
* <!-- 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.
|
|
3553
|
+
* @summary Execute Jogging
|
|
3552
3554
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
3553
|
-
* @param {
|
|
3555
|
+
* @param {ExecuteJoggingRequest} executeJoggingRequest
|
|
3554
3556
|
* @param {*} [options] Override http request option.
|
|
3555
3557
|
* @throws {RequiredError}
|
|
3556
3558
|
*/
|
|
3557
|
-
async
|
|
3558
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.
|
|
3559
|
+
async executeJogging(cell, executeJoggingRequest, options) {
|
|
3560
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.executeJogging(cell, executeJoggingRequest, options);
|
|
3559
3561
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
3560
|
-
const localVarOperationServerBasePath = operationServerMap['
|
|
3562
|
+
const localVarOperationServerBasePath = operationServerMap['JoggingApi.executeJogging']?.[localVarOperationServerIndex]?.url;
|
|
3561
3563
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
3562
3564
|
},
|
|
3563
3565
|
};
|
|
3564
3566
|
};
|
|
3565
3567
|
/**
|
|
3566
|
-
*
|
|
3568
|
+
* JoggingApi - factory interface
|
|
3567
3569
|
* @export
|
|
3568
3570
|
*/
|
|
3569
|
-
export const
|
|
3570
|
-
const localVarFp =
|
|
3571
|
+
export const JoggingApiFactory = function (configuration, basePath, axios) {
|
|
3572
|
+
const localVarFp = JoggingApiFp(configuration);
|
|
3571
3573
|
return {
|
|
3572
3574
|
/**
|
|
3573
|
-
*
|
|
3574
|
-
* @summary
|
|
3575
|
+
* <!-- 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.
|
|
3576
|
+
* @summary Execute Jogging
|
|
3575
3577
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
3576
|
-
* @param {
|
|
3578
|
+
* @param {ExecuteJoggingRequest} executeJoggingRequest
|
|
3577
3579
|
* @param {*} [options] Override http request option.
|
|
3578
3580
|
* @throws {RequiredError}
|
|
3579
3581
|
*/
|
|
3580
|
-
|
|
3581
|
-
return localVarFp.
|
|
3582
|
+
executeJogging(cell, executeJoggingRequest, options) {
|
|
3583
|
+
return localVarFp.executeJogging(cell, executeJoggingRequest, options).then((request) => request(axios, basePath));
|
|
3582
3584
|
},
|
|
3583
3585
|
};
|
|
3584
3586
|
};
|
|
3585
3587
|
/**
|
|
3586
|
-
*
|
|
3588
|
+
* JoggingApi - object-oriented interface
|
|
3587
3589
|
* @export
|
|
3588
|
-
* @class
|
|
3590
|
+
* @class JoggingApi
|
|
3589
3591
|
* @extends {BaseAPI}
|
|
3590
3592
|
*/
|
|
3591
|
-
export class
|
|
3593
|
+
export class JoggingApi extends BaseAPI {
|
|
3592
3594
|
/**
|
|
3593
|
-
*
|
|
3594
|
-
* @summary
|
|
3595
|
+
* <!-- 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.
|
|
3596
|
+
* @summary Execute Jogging
|
|
3595
3597
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
3596
|
-
* @param {
|
|
3598
|
+
* @param {ExecuteJoggingRequest} executeJoggingRequest
|
|
3597
3599
|
* @param {*} [options] Override http request option.
|
|
3598
3600
|
* @throws {RequiredError}
|
|
3599
|
-
* @memberof
|
|
3601
|
+
* @memberof JoggingApi
|
|
3600
3602
|
*/
|
|
3601
|
-
|
|
3602
|
-
return
|
|
3603
|
+
executeJogging(cell, executeJoggingRequest, options) {
|
|
3604
|
+
return JoggingApiFp(this.configuration).executeJogging(cell, executeJoggingRequest, options).then((request) => request(this.axios, this.basePath));
|
|
3603
3605
|
}
|
|
3604
3606
|
}
|
|
3605
3607
|
/**
|
|
3606
|
-
*
|
|
3608
|
+
* KinematicsApi - axios parameter creator
|
|
3607
3609
|
* @export
|
|
3608
3610
|
*/
|
|
3609
|
-
export const
|
|
3611
|
+
export const KinematicsApiAxiosParamCreator = function (configuration) {
|
|
3610
3612
|
return {
|
|
3611
3613
|
/**
|
|
3612
|
-
*
|
|
3613
|
-
* @summary
|
|
3614
|
+
* Returns the reachable joint positions for a list of given poses.
|
|
3615
|
+
* @summary Inverse kinematics
|
|
3614
3616
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
3615
|
-
* @param {
|
|
3617
|
+
* @param {InverseKinematicsRequest} [inverseKinematicsRequest]
|
|
3616
3618
|
* @param {*} [options] Override http request option.
|
|
3617
3619
|
* @throws {RequiredError}
|
|
3618
3620
|
*/
|
|
3619
|
-
|
|
3621
|
+
inverseKinematics: async (cell, inverseKinematicsRequest, options = {}) => {
|
|
3620
3622
|
// verify required parameter 'cell' is not null or undefined
|
|
3621
|
-
assertParamExists('
|
|
3622
|
-
|
|
3623
|
-
assertParamExists('executeJogging', 'executeJoggingRequest', executeJoggingRequest);
|
|
3624
|
-
const localVarPath = `/cells/{cell}/execution/jogging`
|
|
3623
|
+
assertParamExists('inverseKinematics', 'cell', cell);
|
|
3624
|
+
const localVarPath = `/cells/{cell}/kinematic/inverse`
|
|
3625
3625
|
.replace(`{${"cell"}}`, encodeURIComponent(String(cell)));
|
|
3626
3626
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
3627
3627
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
@@ -3629,7 +3629,7 @@ export const JoggingApiAxiosParamCreator = function (configuration) {
|
|
|
3629
3629
|
if (configuration) {
|
|
3630
3630
|
baseOptions = configuration.baseOptions;
|
|
3631
3631
|
}
|
|
3632
|
-
const localVarRequestOptions = { method: '
|
|
3632
|
+
const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options };
|
|
3633
3633
|
const localVarHeaderParameter = {};
|
|
3634
3634
|
const localVarQueryParameter = {};
|
|
3635
3635
|
// authentication BasicAuth required
|
|
@@ -3642,7 +3642,7 @@ export const JoggingApiAxiosParamCreator = function (configuration) {
|
|
|
3642
3642
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
3643
3643
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
3644
3644
|
localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
|
|
3645
|
-
localVarRequestOptions.data = serializeDataIfNeeded(
|
|
3645
|
+
localVarRequestOptions.data = serializeDataIfNeeded(inverseKinematicsRequest, localVarRequestOptions, configuration);
|
|
3646
3646
|
return {
|
|
3647
3647
|
url: toPathString(localVarUrlObj),
|
|
3648
3648
|
options: localVarRequestOptions,
|
|
@@ -3651,66 +3651,66 @@ export const JoggingApiAxiosParamCreator = function (configuration) {
|
|
|
3651
3651
|
};
|
|
3652
3652
|
};
|
|
3653
3653
|
/**
|
|
3654
|
-
*
|
|
3654
|
+
* KinematicsApi - functional programming interface
|
|
3655
3655
|
* @export
|
|
3656
3656
|
*/
|
|
3657
|
-
export const
|
|
3658
|
-
const localVarAxiosParamCreator =
|
|
3657
|
+
export const KinematicsApiFp = function (configuration) {
|
|
3658
|
+
const localVarAxiosParamCreator = KinematicsApiAxiosParamCreator(configuration);
|
|
3659
3659
|
return {
|
|
3660
3660
|
/**
|
|
3661
|
-
*
|
|
3662
|
-
* @summary
|
|
3661
|
+
* Returns the reachable joint positions for a list of given poses.
|
|
3662
|
+
* @summary Inverse kinematics
|
|
3663
3663
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
3664
|
-
* @param {
|
|
3664
|
+
* @param {InverseKinematicsRequest} [inverseKinematicsRequest]
|
|
3665
3665
|
* @param {*} [options] Override http request option.
|
|
3666
3666
|
* @throws {RequiredError}
|
|
3667
3667
|
*/
|
|
3668
|
-
async
|
|
3669
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.
|
|
3668
|
+
async inverseKinematics(cell, inverseKinematicsRequest, options) {
|
|
3669
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.inverseKinematics(cell, inverseKinematicsRequest, options);
|
|
3670
3670
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
3671
|
-
const localVarOperationServerBasePath = operationServerMap['
|
|
3671
|
+
const localVarOperationServerBasePath = operationServerMap['KinematicsApi.inverseKinematics']?.[localVarOperationServerIndex]?.url;
|
|
3672
3672
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
3673
3673
|
},
|
|
3674
3674
|
};
|
|
3675
3675
|
};
|
|
3676
3676
|
/**
|
|
3677
|
-
*
|
|
3677
|
+
* KinematicsApi - factory interface
|
|
3678
3678
|
* @export
|
|
3679
3679
|
*/
|
|
3680
|
-
export const
|
|
3681
|
-
const localVarFp =
|
|
3680
|
+
export const KinematicsApiFactory = function (configuration, basePath, axios) {
|
|
3681
|
+
const localVarFp = KinematicsApiFp(configuration);
|
|
3682
3682
|
return {
|
|
3683
3683
|
/**
|
|
3684
|
-
*
|
|
3685
|
-
* @summary
|
|
3684
|
+
* Returns the reachable joint positions for a list of given poses.
|
|
3685
|
+
* @summary Inverse kinematics
|
|
3686
3686
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
3687
|
-
* @param {
|
|
3687
|
+
* @param {InverseKinematicsRequest} [inverseKinematicsRequest]
|
|
3688
3688
|
* @param {*} [options] Override http request option.
|
|
3689
3689
|
* @throws {RequiredError}
|
|
3690
3690
|
*/
|
|
3691
|
-
|
|
3692
|
-
return localVarFp.
|
|
3691
|
+
inverseKinematics(cell, inverseKinematicsRequest, options) {
|
|
3692
|
+
return localVarFp.inverseKinematics(cell, inverseKinematicsRequest, options).then((request) => request(axios, basePath));
|
|
3693
3693
|
},
|
|
3694
3694
|
};
|
|
3695
3695
|
};
|
|
3696
3696
|
/**
|
|
3697
|
-
*
|
|
3697
|
+
* KinematicsApi - object-oriented interface
|
|
3698
3698
|
* @export
|
|
3699
|
-
* @class
|
|
3699
|
+
* @class KinematicsApi
|
|
3700
3700
|
* @extends {BaseAPI}
|
|
3701
3701
|
*/
|
|
3702
|
-
export class
|
|
3702
|
+
export class KinematicsApi extends BaseAPI {
|
|
3703
3703
|
/**
|
|
3704
|
-
*
|
|
3705
|
-
* @summary
|
|
3704
|
+
* Returns the reachable joint positions for a list of given poses.
|
|
3705
|
+
* @summary Inverse kinematics
|
|
3706
3706
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
3707
|
-
* @param {
|
|
3707
|
+
* @param {InverseKinematicsRequest} [inverseKinematicsRequest]
|
|
3708
3708
|
* @param {*} [options] Override http request option.
|
|
3709
3709
|
* @throws {RequiredError}
|
|
3710
|
-
* @memberof
|
|
3710
|
+
* @memberof KinematicsApi
|
|
3711
3711
|
*/
|
|
3712
|
-
|
|
3713
|
-
return
|
|
3712
|
+
inverseKinematics(cell, inverseKinematicsRequest, options) {
|
|
3713
|
+
return KinematicsApiFp(this.configuration).inverseKinematics(cell, inverseKinematicsRequest, options).then((request) => request(this.axios, this.basePath));
|
|
3714
3714
|
}
|
|
3715
3715
|
}
|
|
3716
3716
|
/**
|