@wandelbots/nova-api 25.7.0-dev.2 → 25.7.0-dev.3
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 +596 -597
- package/v2/api.js +1254 -1218
- package/v2/api.js.map +1 -1
- package/v2/api.ts +1351 -1333
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 groups of the controller take commanded joint configuration as actual joint state. Configures the compliance of the virtual robot with the normal ControllerState cycle time. If set, the virtual robot will act like a physical one, e.g. with a cycle time of 8ms to respond to a new joint state command. ## BEHAVIOR_AUTOMATIC_NOT_COMPLY_WITH_CYCLETIME Configures the compliance of the virtual robot with the normal ControllerState cycle time. If set, the robot will respond as fast as possible, limited only by software execution speed. Because of that the execution of a movement requires less time than with BEHAVIOR_AUTOMATIC. ## BEHAVIOR_EXTERNAL_SOURCE The external client is the only source of actual joint state changes. This mode is used to enable third party software indicating the current joint state via [externalJointsStream](externalJointsStream).
|
|
25
25
|
* @export
|
|
26
26
|
* @enum {string}
|
|
27
27
|
*/
|
|
@@ -187,7 +187,7 @@ export const Manufacturer = {
|
|
|
187
187
|
Yaskawa: 'yaskawa'
|
|
188
188
|
};
|
|
189
189
|
export const MovementErrorResponseKindEnum = {
|
|
190
|
-
|
|
190
|
+
MotionError: 'MOTION_ERROR'
|
|
191
191
|
};
|
|
192
192
|
/**
|
|
193
193
|
* The operating state.
|
|
@@ -3292,17 +3292,21 @@ export const JoggingApiAxiosParamCreator = function (configuration) {
|
|
|
3292
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.
|
|
3293
3293
|
* @summary Execute Jogging
|
|
3294
3294
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
3295
|
+
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
3295
3296
|
* @param {ExecuteJoggingRequest} executeJoggingRequest
|
|
3296
3297
|
* @param {*} [options] Override http request option.
|
|
3297
3298
|
* @throws {RequiredError}
|
|
3298
3299
|
*/
|
|
3299
|
-
executeJogging: async (cell, executeJoggingRequest, options = {}) => {
|
|
3300
|
+
executeJogging: async (cell, controller, executeJoggingRequest, options = {}) => {
|
|
3300
3301
|
// verify required parameter 'cell' is not null or undefined
|
|
3301
3302
|
assertParamExists('executeJogging', 'cell', cell);
|
|
3303
|
+
// verify required parameter 'controller' is not null or undefined
|
|
3304
|
+
assertParamExists('executeJogging', 'controller', controller);
|
|
3302
3305
|
// verify required parameter 'executeJoggingRequest' is not null or undefined
|
|
3303
3306
|
assertParamExists('executeJogging', 'executeJoggingRequest', executeJoggingRequest);
|
|
3304
|
-
const localVarPath = `/cells/{cell}/execution/jogging`
|
|
3305
|
-
.replace(`{${"cell"}}`, encodeURIComponent(String(cell)))
|
|
3307
|
+
const localVarPath = `/cells/{cell}/controllers/{controller}/execution/jogging`
|
|
3308
|
+
.replace(`{${"cell"}}`, encodeURIComponent(String(cell)))
|
|
3309
|
+
.replace(`{${"controller"}}`, encodeURIComponent(String(controller)));
|
|
3306
3310
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
3307
3311
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
3308
3312
|
let baseOptions;
|
|
@@ -3341,12 +3345,13 @@ export const JoggingApiFp = function (configuration) {
|
|
|
3341
3345
|
* <!-- theme: danger --> > Websocket endpoint Provides execution control over a dynamically adaptable jogging motion for a motion group. Jogging describes controlling a motion group by sending real-time commands to move either its joints or the TCP (Tool Center Point). The commands contain target velocities that may change at any time during execution, so the resulting motion cannot be computed upfront. ### Preconditions The motion group is not moved by any other endpoint. ### Requests #### 1. Send InitializeJoggingRequest to configure the jogging. Sets robot controller mode to control mode. Sets rate and coordinate system for the jogging response. #### 2. Send JointVelocityRequest or TcpVelocityRequest to start the jogging motion. #### 3. Change or stop the jogging motion - Change the jogging direction and/or velocity during the jogging motion with JointVelocityRequest or TcpVelocityRequest. - To stop the jogging motion, send zero velocities via either request. ### Responses - InitializeJoggingResponse is sent to signal the success or failure of the InitializeJoggingRequest. - Jogging responses are streamed continuously after an InitializeJoggingRequest is processed. Jogging responses contain the robot controller state and the state of the jogging control. - JoggingErrorResponse with error details is sent in case of an unexpected error, e.g., controller disconnects during jogging. ### Tips and Tricks - In the JoggingResponse, verify that the robot control is in the desired state, e.g. standstill, with JoggingState. - Ensure that the websocket connection remains open until the jogging motion is stopped to avoid unexpected stops.
|
|
3342
3346
|
* @summary Execute Jogging
|
|
3343
3347
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
3348
|
+
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
3344
3349
|
* @param {ExecuteJoggingRequest} executeJoggingRequest
|
|
3345
3350
|
* @param {*} [options] Override http request option.
|
|
3346
3351
|
* @throws {RequiredError}
|
|
3347
3352
|
*/
|
|
3348
|
-
async executeJogging(cell, executeJoggingRequest, options) {
|
|
3349
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.executeJogging(cell, executeJoggingRequest, options);
|
|
3353
|
+
async executeJogging(cell, controller, executeJoggingRequest, options) {
|
|
3354
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.executeJogging(cell, controller, executeJoggingRequest, options);
|
|
3350
3355
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
3351
3356
|
const localVarOperationServerBasePath = operationServerMap['JoggingApi.executeJogging']?.[localVarOperationServerIndex]?.url;
|
|
3352
3357
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
@@ -3364,12 +3369,13 @@ export const JoggingApiFactory = function (configuration, basePath, axios) {
|
|
|
3364
3369
|
* <!-- theme: danger --> > Websocket endpoint Provides execution control over a dynamically adaptable jogging motion for a motion group. Jogging describes controlling a motion group by sending real-time commands to move either its joints or the TCP (Tool Center Point). The commands contain target velocities that may change at any time during execution, so the resulting motion cannot be computed upfront. ### Preconditions The motion group is not moved by any other endpoint. ### Requests #### 1. Send InitializeJoggingRequest to configure the jogging. Sets robot controller mode to control mode. Sets rate and coordinate system for the jogging response. #### 2. Send JointVelocityRequest or TcpVelocityRequest to start the jogging motion. #### 3. Change or stop the jogging motion - Change the jogging direction and/or velocity during the jogging motion with JointVelocityRequest or TcpVelocityRequest. - To stop the jogging motion, send zero velocities via either request. ### Responses - InitializeJoggingResponse is sent to signal the success or failure of the InitializeJoggingRequest. - Jogging responses are streamed continuously after an InitializeJoggingRequest is processed. Jogging responses contain the robot controller state and the state of the jogging control. - JoggingErrorResponse with error details is sent in case of an unexpected error, e.g., controller disconnects during jogging. ### Tips and Tricks - In the JoggingResponse, verify that the robot control is in the desired state, e.g. standstill, with JoggingState. - Ensure that the websocket connection remains open until the jogging motion is stopped to avoid unexpected stops.
|
|
3365
3370
|
* @summary Execute Jogging
|
|
3366
3371
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
3372
|
+
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
3367
3373
|
* @param {ExecuteJoggingRequest} executeJoggingRequest
|
|
3368
3374
|
* @param {*} [options] Override http request option.
|
|
3369
3375
|
* @throws {RequiredError}
|
|
3370
3376
|
*/
|
|
3371
|
-
executeJogging(cell, executeJoggingRequest, options) {
|
|
3372
|
-
return localVarFp.executeJogging(cell, executeJoggingRequest, options).then((request) => request(axios, basePath));
|
|
3377
|
+
executeJogging(cell, controller, executeJoggingRequest, options) {
|
|
3378
|
+
return localVarFp.executeJogging(cell, controller, executeJoggingRequest, options).then((request) => request(axios, basePath));
|
|
3373
3379
|
},
|
|
3374
3380
|
};
|
|
3375
3381
|
};
|
|
@@ -3384,13 +3390,14 @@ export class JoggingApi extends BaseAPI {
|
|
|
3384
3390
|
* <!-- theme: danger --> > Websocket endpoint Provides execution control over a dynamically adaptable jogging motion for a motion group. Jogging describes controlling a motion group by sending real-time commands to move either its joints or the TCP (Tool Center Point). The commands contain target velocities that may change at any time during execution, so the resulting motion cannot be computed upfront. ### Preconditions The motion group is not moved by any other endpoint. ### Requests #### 1. Send InitializeJoggingRequest to configure the jogging. Sets robot controller mode to control mode. Sets rate and coordinate system for the jogging response. #### 2. Send JointVelocityRequest or TcpVelocityRequest to start the jogging motion. #### 3. Change or stop the jogging motion - Change the jogging direction and/or velocity during the jogging motion with JointVelocityRequest or TcpVelocityRequest. - To stop the jogging motion, send zero velocities via either request. ### Responses - InitializeJoggingResponse is sent to signal the success or failure of the InitializeJoggingRequest. - Jogging responses are streamed continuously after an InitializeJoggingRequest is processed. Jogging responses contain the robot controller state and the state of the jogging control. - JoggingErrorResponse with error details is sent in case of an unexpected error, e.g., controller disconnects during jogging. ### Tips and Tricks - In the JoggingResponse, verify that the robot control is in the desired state, e.g. standstill, with JoggingState. - Ensure that the websocket connection remains open until the jogging motion is stopped to avoid unexpected stops.
|
|
3385
3391
|
* @summary Execute Jogging
|
|
3386
3392
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
3393
|
+
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
3387
3394
|
* @param {ExecuteJoggingRequest} executeJoggingRequest
|
|
3388
3395
|
* @param {*} [options] Override http request option.
|
|
3389
3396
|
* @throws {RequiredError}
|
|
3390
3397
|
* @memberof JoggingApi
|
|
3391
3398
|
*/
|
|
3392
|
-
executeJogging(cell, executeJoggingRequest, options) {
|
|
3393
|
-
return JoggingApiFp(this.configuration).executeJogging(cell, executeJoggingRequest, options).then((request) => request(this.axios, this.basePath));
|
|
3399
|
+
executeJogging(cell, controller, executeJoggingRequest, options) {
|
|
3400
|
+
return JoggingApiFp(this.configuration).executeJogging(cell, controller, executeJoggingRequest, options).then((request) => request(this.axios, this.basePath));
|
|
3394
3401
|
}
|
|
3395
3402
|
}
|
|
3396
3403
|
/**
|
|
@@ -3802,18 +3809,22 @@ export const MotionGroupApiAxiosParamCreator = function (configuration) {
|
|
|
3802
3809
|
* Returns the current state of the selected motion group including the current joint position, velocity, pose, and more.
|
|
3803
3810
|
* @summary State
|
|
3804
3811
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
3812
|
+
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
3805
3813
|
* @param {string} motionGroup The motion-group identifier.
|
|
3806
3814
|
* @param {string} [responseCoordinateSystem] Unique identifier addressing a coordinate system to which the responses should be converted. If not set, world coordinate system is used.
|
|
3807
3815
|
* @param {*} [options] Override http request option.
|
|
3808
3816
|
* @throws {RequiredError}
|
|
3809
3817
|
*/
|
|
3810
|
-
getCurrentMotionGroupState: async (cell, motionGroup, responseCoordinateSystem, options = {}) => {
|
|
3818
|
+
getCurrentMotionGroupState: async (cell, controller, motionGroup, responseCoordinateSystem, options = {}) => {
|
|
3811
3819
|
// verify required parameter 'cell' is not null or undefined
|
|
3812
3820
|
assertParamExists('getCurrentMotionGroupState', 'cell', cell);
|
|
3821
|
+
// verify required parameter 'controller' is not null or undefined
|
|
3822
|
+
assertParamExists('getCurrentMotionGroupState', 'controller', controller);
|
|
3813
3823
|
// verify required parameter 'motionGroup' is not null or undefined
|
|
3814
3824
|
assertParamExists('getCurrentMotionGroupState', 'motionGroup', motionGroup);
|
|
3815
|
-
const localVarPath = `/cells/{cell}/motion-groups/{motion-group}/state`
|
|
3825
|
+
const localVarPath = `/cells/{cell}/controllers/{controller}/motion-groups/{motion-group}/state`
|
|
3816
3826
|
.replace(`{${"cell"}}`, encodeURIComponent(String(cell)))
|
|
3827
|
+
.replace(`{${"controller"}}`, encodeURIComponent(String(controller)))
|
|
3817
3828
|
.replace(`{${"motion-group"}}`, encodeURIComponent(String(motionGroup)));
|
|
3818
3829
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
3819
3830
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
@@ -3845,17 +3856,21 @@ export const MotionGroupApiAxiosParamCreator = function (configuration) {
|
|
|
3845
3856
|
* Get the set of parameters that describe the motion group and its configuration including safety zones, limits, etc. This data might change upon connection to the robot.
|
|
3846
3857
|
* @summary Description
|
|
3847
3858
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
3859
|
+
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
3848
3860
|
* @param {string} motionGroup The motion-group identifier.
|
|
3849
3861
|
* @param {*} [options] Override http request option.
|
|
3850
3862
|
* @throws {RequiredError}
|
|
3851
3863
|
*/
|
|
3852
|
-
getMotionGroupDescription: async (cell, motionGroup, options = {}) => {
|
|
3864
|
+
getMotionGroupDescription: async (cell, controller, motionGroup, options = {}) => {
|
|
3853
3865
|
// verify required parameter 'cell' is not null or undefined
|
|
3854
3866
|
assertParamExists('getMotionGroupDescription', 'cell', cell);
|
|
3867
|
+
// verify required parameter 'controller' is not null or undefined
|
|
3868
|
+
assertParamExists('getMotionGroupDescription', 'controller', controller);
|
|
3855
3869
|
// verify required parameter 'motionGroup' is not null or undefined
|
|
3856
3870
|
assertParamExists('getMotionGroupDescription', 'motionGroup', motionGroup);
|
|
3857
|
-
const localVarPath = `/cells/{cell}/motion-groups/{motion-group}/description`
|
|
3871
|
+
const localVarPath = `/cells/{cell}/controllers/{controller}/motion-groups/{motion-group}/description`
|
|
3858
3872
|
.replace(`{${"cell"}}`, encodeURIComponent(String(cell)))
|
|
3873
|
+
.replace(`{${"controller"}}`, encodeURIComponent(String(controller)))
|
|
3859
3874
|
.replace(`{${"motion-group"}}`, encodeURIComponent(String(motionGroup)));
|
|
3860
3875
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
3861
3876
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
@@ -3884,19 +3899,23 @@ export const MotionGroupApiAxiosParamCreator = function (configuration) {
|
|
|
3884
3899
|
* <!-- theme: danger --> > Websocket endpoint Receive updates of the motion group state. The stream will be closed from the server if the controller is disconnected.
|
|
3885
3900
|
* @summary Stream State
|
|
3886
3901
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
3902
|
+
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
3887
3903
|
* @param {string} motionGroup The motion-group identifier.
|
|
3888
3904
|
* @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.
|
|
3889
3905
|
* @param {string} [responseCoordinateSystem] Unique identifier addressing a coordinate system to which the cartesian data of the responses should be converted. Default is the world coordinate system.
|
|
3890
3906
|
* @param {*} [options] Override http request option.
|
|
3891
3907
|
* @throws {RequiredError}
|
|
3892
3908
|
*/
|
|
3893
|
-
streamMotionGroupState: async (cell, motionGroup, responseRate, responseCoordinateSystem, options = {}) => {
|
|
3909
|
+
streamMotionGroupState: async (cell, controller, motionGroup, responseRate, responseCoordinateSystem, options = {}) => {
|
|
3894
3910
|
// verify required parameter 'cell' is not null or undefined
|
|
3895
3911
|
assertParamExists('streamMotionGroupState', 'cell', cell);
|
|
3912
|
+
// verify required parameter 'controller' is not null or undefined
|
|
3913
|
+
assertParamExists('streamMotionGroupState', 'controller', controller);
|
|
3896
3914
|
// verify required parameter 'motionGroup' is not null or undefined
|
|
3897
3915
|
assertParamExists('streamMotionGroupState', 'motionGroup', motionGroup);
|
|
3898
|
-
const localVarPath = `/cells/{cell}/motion-groups/{motion-group}/state-stream`
|
|
3916
|
+
const localVarPath = `/cells/{cell}/controllers/{controller}/motion-groups/{motion-group}/state-stream`
|
|
3899
3917
|
.replace(`{${"cell"}}`, encodeURIComponent(String(cell)))
|
|
3918
|
+
.replace(`{${"controller"}}`, encodeURIComponent(String(controller)))
|
|
3900
3919
|
.replace(`{${"motion-group"}}`, encodeURIComponent(String(motionGroup)));
|
|
3901
3920
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
3902
3921
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
@@ -3940,13 +3959,14 @@ export const MotionGroupApiFp = function (configuration) {
|
|
|
3940
3959
|
* Returns the current state of the selected motion group including the current joint position, velocity, pose, and more.
|
|
3941
3960
|
* @summary State
|
|
3942
3961
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
3962
|
+
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
3943
3963
|
* @param {string} motionGroup The motion-group identifier.
|
|
3944
3964
|
* @param {string} [responseCoordinateSystem] Unique identifier addressing a coordinate system to which the responses should be converted. If not set, world coordinate system is used.
|
|
3945
3965
|
* @param {*} [options] Override http request option.
|
|
3946
3966
|
* @throws {RequiredError}
|
|
3947
3967
|
*/
|
|
3948
|
-
async getCurrentMotionGroupState(cell, motionGroup, responseCoordinateSystem, options) {
|
|
3949
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.getCurrentMotionGroupState(cell, motionGroup, responseCoordinateSystem, options);
|
|
3968
|
+
async getCurrentMotionGroupState(cell, controller, motionGroup, responseCoordinateSystem, options) {
|
|
3969
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.getCurrentMotionGroupState(cell, controller, motionGroup, responseCoordinateSystem, options);
|
|
3950
3970
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
3951
3971
|
const localVarOperationServerBasePath = operationServerMap['MotionGroupApi.getCurrentMotionGroupState']?.[localVarOperationServerIndex]?.url;
|
|
3952
3972
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
@@ -3955,12 +3975,13 @@ export const MotionGroupApiFp = function (configuration) {
|
|
|
3955
3975
|
* Get the set of parameters that describe the motion group and its configuration including safety zones, limits, etc. This data might change upon connection to the robot.
|
|
3956
3976
|
* @summary Description
|
|
3957
3977
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
3978
|
+
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
3958
3979
|
* @param {string} motionGroup The motion-group identifier.
|
|
3959
3980
|
* @param {*} [options] Override http request option.
|
|
3960
3981
|
* @throws {RequiredError}
|
|
3961
3982
|
*/
|
|
3962
|
-
async getMotionGroupDescription(cell, motionGroup, options) {
|
|
3963
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.getMotionGroupDescription(cell, motionGroup, options);
|
|
3983
|
+
async getMotionGroupDescription(cell, controller, motionGroup, options) {
|
|
3984
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.getMotionGroupDescription(cell, controller, motionGroup, options);
|
|
3964
3985
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
3965
3986
|
const localVarOperationServerBasePath = operationServerMap['MotionGroupApi.getMotionGroupDescription']?.[localVarOperationServerIndex]?.url;
|
|
3966
3987
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
@@ -3969,14 +3990,15 @@ export const MotionGroupApiFp = function (configuration) {
|
|
|
3969
3990
|
* <!-- theme: danger --> > Websocket endpoint Receive updates of the motion group state. The stream will be closed from the server if the controller is disconnected.
|
|
3970
3991
|
* @summary Stream State
|
|
3971
3992
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
3993
|
+
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
3972
3994
|
* @param {string} motionGroup The motion-group identifier.
|
|
3973
3995
|
* @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.
|
|
3974
3996
|
* @param {string} [responseCoordinateSystem] Unique identifier addressing a coordinate system to which the cartesian data of the responses should be converted. Default is the world coordinate system.
|
|
3975
3997
|
* @param {*} [options] Override http request option.
|
|
3976
3998
|
* @throws {RequiredError}
|
|
3977
3999
|
*/
|
|
3978
|
-
async streamMotionGroupState(cell, motionGroup, responseRate, responseCoordinateSystem, options) {
|
|
3979
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.streamMotionGroupState(cell, motionGroup, responseRate, responseCoordinateSystem, options);
|
|
4000
|
+
async streamMotionGroupState(cell, controller, motionGroup, responseRate, responseCoordinateSystem, options) {
|
|
4001
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.streamMotionGroupState(cell, controller, motionGroup, responseRate, responseCoordinateSystem, options);
|
|
3980
4002
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
3981
4003
|
const localVarOperationServerBasePath = operationServerMap['MotionGroupApi.streamMotionGroupState']?.[localVarOperationServerIndex]?.url;
|
|
3982
4004
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
@@ -3994,37 +4016,40 @@ export const MotionGroupApiFactory = function (configuration, basePath, axios) {
|
|
|
3994
4016
|
* Returns the current state of the selected motion group including the current joint position, velocity, pose, and more.
|
|
3995
4017
|
* @summary State
|
|
3996
4018
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
4019
|
+
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
3997
4020
|
* @param {string} motionGroup The motion-group identifier.
|
|
3998
4021
|
* @param {string} [responseCoordinateSystem] Unique identifier addressing a coordinate system to which the responses should be converted. If not set, world coordinate system is used.
|
|
3999
4022
|
* @param {*} [options] Override http request option.
|
|
4000
4023
|
* @throws {RequiredError}
|
|
4001
4024
|
*/
|
|
4002
|
-
getCurrentMotionGroupState(cell, motionGroup, responseCoordinateSystem, options) {
|
|
4003
|
-
return localVarFp.getCurrentMotionGroupState(cell, motionGroup, responseCoordinateSystem, options).then((request) => request(axios, basePath));
|
|
4025
|
+
getCurrentMotionGroupState(cell, controller, motionGroup, responseCoordinateSystem, options) {
|
|
4026
|
+
return localVarFp.getCurrentMotionGroupState(cell, controller, motionGroup, responseCoordinateSystem, options).then((request) => request(axios, basePath));
|
|
4004
4027
|
},
|
|
4005
4028
|
/**
|
|
4006
4029
|
* Get the set of parameters that describe the motion group and its configuration including safety zones, limits, etc. This data might change upon connection to the robot.
|
|
4007
4030
|
* @summary Description
|
|
4008
4031
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
4032
|
+
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
4009
4033
|
* @param {string} motionGroup The motion-group identifier.
|
|
4010
4034
|
* @param {*} [options] Override http request option.
|
|
4011
4035
|
* @throws {RequiredError}
|
|
4012
4036
|
*/
|
|
4013
|
-
getMotionGroupDescription(cell, motionGroup, options) {
|
|
4014
|
-
return localVarFp.getMotionGroupDescription(cell, motionGroup, options).then((request) => request(axios, basePath));
|
|
4037
|
+
getMotionGroupDescription(cell, controller, motionGroup, options) {
|
|
4038
|
+
return localVarFp.getMotionGroupDescription(cell, controller, motionGroup, options).then((request) => request(axios, basePath));
|
|
4015
4039
|
},
|
|
4016
4040
|
/**
|
|
4017
4041
|
* <!-- theme: danger --> > Websocket endpoint Receive updates of the motion group state. The stream will be closed from the server if the controller is disconnected.
|
|
4018
4042
|
* @summary Stream State
|
|
4019
4043
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
4044
|
+
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
4020
4045
|
* @param {string} motionGroup The motion-group identifier.
|
|
4021
4046
|
* @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.
|
|
4022
4047
|
* @param {string} [responseCoordinateSystem] Unique identifier addressing a coordinate system to which the cartesian data of the responses should be converted. Default is the world coordinate system.
|
|
4023
4048
|
* @param {*} [options] Override http request option.
|
|
4024
4049
|
* @throws {RequiredError}
|
|
4025
4050
|
*/
|
|
4026
|
-
streamMotionGroupState(cell, motionGroup, responseRate, responseCoordinateSystem, options) {
|
|
4027
|
-
return localVarFp.streamMotionGroupState(cell, motionGroup, responseRate, responseCoordinateSystem, options).then((request) => request(axios, basePath));
|
|
4051
|
+
streamMotionGroupState(cell, controller, motionGroup, responseRate, responseCoordinateSystem, options) {
|
|
4052
|
+
return localVarFp.streamMotionGroupState(cell, controller, motionGroup, responseRate, responseCoordinateSystem, options).then((request) => request(axios, basePath));
|
|
4028
4053
|
},
|
|
4029
4054
|
};
|
|
4030
4055
|
};
|
|
@@ -4039,31 +4064,34 @@ export class MotionGroupApi extends BaseAPI {
|
|
|
4039
4064
|
* Returns the current state of the selected motion group including the current joint position, velocity, pose, and more.
|
|
4040
4065
|
* @summary State
|
|
4041
4066
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
4067
|
+
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
4042
4068
|
* @param {string} motionGroup The motion-group identifier.
|
|
4043
4069
|
* @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
4070
|
* @param {*} [options] Override http request option.
|
|
4045
4071
|
* @throws {RequiredError}
|
|
4046
4072
|
* @memberof MotionGroupApi
|
|
4047
4073
|
*/
|
|
4048
|
-
getCurrentMotionGroupState(cell, motionGroup, responseCoordinateSystem, options) {
|
|
4049
|
-
return MotionGroupApiFp(this.configuration).getCurrentMotionGroupState(cell, motionGroup, responseCoordinateSystem, options).then((request) => request(this.axios, this.basePath));
|
|
4074
|
+
getCurrentMotionGroupState(cell, controller, motionGroup, responseCoordinateSystem, options) {
|
|
4075
|
+
return MotionGroupApiFp(this.configuration).getCurrentMotionGroupState(cell, controller, motionGroup, responseCoordinateSystem, options).then((request) => request(this.axios, this.basePath));
|
|
4050
4076
|
}
|
|
4051
4077
|
/**
|
|
4052
4078
|
* Get the set of parameters that describe the motion group and its configuration including safety zones, limits, etc. This data might change upon connection to the robot.
|
|
4053
4079
|
* @summary Description
|
|
4054
4080
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
4081
|
+
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
4055
4082
|
* @param {string} motionGroup The motion-group identifier.
|
|
4056
4083
|
* @param {*} [options] Override http request option.
|
|
4057
4084
|
* @throws {RequiredError}
|
|
4058
4085
|
* @memberof MotionGroupApi
|
|
4059
4086
|
*/
|
|
4060
|
-
getMotionGroupDescription(cell, motionGroup, options) {
|
|
4061
|
-
return MotionGroupApiFp(this.configuration).getMotionGroupDescription(cell, motionGroup, options).then((request) => request(this.axios, this.basePath));
|
|
4087
|
+
getMotionGroupDescription(cell, controller, motionGroup, options) {
|
|
4088
|
+
return MotionGroupApiFp(this.configuration).getMotionGroupDescription(cell, controller, motionGroup, options).then((request) => request(this.axios, this.basePath));
|
|
4062
4089
|
}
|
|
4063
4090
|
/**
|
|
4064
4091
|
* <!-- theme: danger --> > Websocket endpoint Receive updates of the motion group state. The stream will be closed from the server if the controller is disconnected.
|
|
4065
4092
|
* @summary Stream State
|
|
4066
4093
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
4094
|
+
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
4067
4095
|
* @param {string} motionGroup The motion-group identifier.
|
|
4068
4096
|
* @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.
|
|
4069
4097
|
* @param {string} [responseCoordinateSystem] Unique identifier addressing a coordinate system to which the cartesian data of the responses should be converted. Default is the world coordinate system.
|
|
@@ -4071,8 +4099,8 @@ export class MotionGroupApi extends BaseAPI {
|
|
|
4071
4099
|
* @throws {RequiredError}
|
|
4072
4100
|
* @memberof MotionGroupApi
|
|
4073
4101
|
*/
|
|
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));
|
|
4102
|
+
streamMotionGroupState(cell, controller, motionGroup, responseRate, responseCoordinateSystem, options) {
|
|
4103
|
+
return MotionGroupApiFp(this.configuration).streamMotionGroupState(cell, controller, motionGroup, responseRate, responseCoordinateSystem, options).then((request) => request(this.axios, this.basePath));
|
|
4076
4104
|
}
|
|
4077
4105
|
}
|
|
4078
4106
|
/**
|
|
@@ -6698,17 +6726,21 @@ export const TrajectoryCachingApiAxiosParamCreator = function (configuration) {
|
|
|
6698
6726
|
* <!-- theme: info --> > Using the trajectory cache is an optional performance optimization. It is not necessary to use the cache to execute trajectories. Loads and validates the data of a trajectory into the execution cache, rendering the trajectory executable. The response contains the result of the validation of the trajectory. Validation can lead to three different results: - Fully valid: The whole trajectory can be executed from start to end. The response will contain an unique identifier which is used to move the robot. - Partially valid: Only parts of the trajectory can be executed. The response will contain an unique identifier to move the robot and information about the failure for the part that is not executable. - Invalid: The trajectory can not be executed. The response will tell you the reason of failure. If the trajectory is at least partially valid, the parts of the trajectory that are valid can be executed using the [executeTrajectory](executeTrajectory) endpoint. The workflow is as follows: - Generate a trajectory with [planTrajectory](planTrajectory) or your own motion planner, - Send the trajectory to this endpoint to validate it and get a unique identifier for it, - The unique identifier will appear in the list of available trajectories, see [listTrajectories](listTrajectories) endpoint, if it is at least partially executable. - Execute your trajectory using the [executeTrajectory](executeTrajectory) endpoint.
|
|
6699
6727
|
* @summary Add Trajectory
|
|
6700
6728
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
6729
|
+
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
6701
6730
|
* @param {AddTrajectoryRequest} addTrajectoryRequest
|
|
6702
6731
|
* @param {*} [options] Override http request option.
|
|
6703
6732
|
* @throws {RequiredError}
|
|
6704
6733
|
*/
|
|
6705
|
-
addTrajectory: async (cell, addTrajectoryRequest, options = {}) => {
|
|
6734
|
+
addTrajectory: async (cell, controller, addTrajectoryRequest, options = {}) => {
|
|
6706
6735
|
// verify required parameter 'cell' is not null or undefined
|
|
6707
6736
|
assertParamExists('addTrajectory', 'cell', cell);
|
|
6737
|
+
// verify required parameter 'controller' is not null or undefined
|
|
6738
|
+
assertParamExists('addTrajectory', 'controller', controller);
|
|
6708
6739
|
// verify required parameter 'addTrajectoryRequest' is not null or undefined
|
|
6709
6740
|
assertParamExists('addTrajectory', 'addTrajectoryRequest', addTrajectoryRequest);
|
|
6710
|
-
const localVarPath = `/cells/{cell}/trajectories`
|
|
6711
|
-
.replace(`{${"cell"}}`, encodeURIComponent(String(cell)))
|
|
6741
|
+
const localVarPath = `/cells/{cell}/controllers/{controller}/trajectories`
|
|
6742
|
+
.replace(`{${"cell"}}`, encodeURIComponent(String(cell)))
|
|
6743
|
+
.replace(`{${"controller"}}`, encodeURIComponent(String(controller)));
|
|
6712
6744
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
6713
6745
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
6714
6746
|
let baseOptions;
|
|
@@ -6738,14 +6770,18 @@ export const TrajectoryCachingApiAxiosParamCreator = function (configuration) {
|
|
|
6738
6770
|
* Clear the trajectory cache.
|
|
6739
6771
|
* @summary Clear Trajectories
|
|
6740
6772
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
6773
|
+
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
6741
6774
|
* @param {*} [options] Override http request option.
|
|
6742
6775
|
* @throws {RequiredError}
|
|
6743
6776
|
*/
|
|
6744
|
-
clearTrajectories: async (cell, options = {}) => {
|
|
6777
|
+
clearTrajectories: async (cell, controller, options = {}) => {
|
|
6745
6778
|
// verify required parameter 'cell' is not null or undefined
|
|
6746
6779
|
assertParamExists('clearTrajectories', 'cell', cell);
|
|
6747
|
-
|
|
6748
|
-
|
|
6780
|
+
// verify required parameter 'controller' is not null or undefined
|
|
6781
|
+
assertParamExists('clearTrajectories', 'controller', controller);
|
|
6782
|
+
const localVarPath = `/cells/{cell}/controllers/{controller}/trajectories`
|
|
6783
|
+
.replace(`{${"cell"}}`, encodeURIComponent(String(cell)))
|
|
6784
|
+
.replace(`{${"controller"}}`, encodeURIComponent(String(controller)));
|
|
6749
6785
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
6750
6786
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
6751
6787
|
let baseOptions;
|
|
@@ -6773,17 +6809,21 @@ export const TrajectoryCachingApiAxiosParamCreator = function (configuration) {
|
|
|
6773
6809
|
* Delete a previously created trajectory from cache. Use [listTrajectories](listTrajectories) to list all cached trajectories. Trajectories are removed automatically if the motion group or the corresponding controller is disconnected.
|
|
6774
6810
|
* @summary Delete Trajectory
|
|
6775
6811
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
6812
|
+
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
6776
6813
|
* @param {string} trajectory This represents the unique identifier of a trajectory. Every executable or partially executable trajectory is cached and an unique identifier is returned. Indicate the unique identifier to execute the trajectory or retrieve information on the trajectory.
|
|
6777
6814
|
* @param {*} [options] Override http request option.
|
|
6778
6815
|
* @throws {RequiredError}
|
|
6779
6816
|
*/
|
|
6780
|
-
deleteTrajectory: async (cell, trajectory, options = {}) => {
|
|
6817
|
+
deleteTrajectory: async (cell, controller, trajectory, options = {}) => {
|
|
6781
6818
|
// verify required parameter 'cell' is not null or undefined
|
|
6782
6819
|
assertParamExists('deleteTrajectory', 'cell', cell);
|
|
6820
|
+
// verify required parameter 'controller' is not null or undefined
|
|
6821
|
+
assertParamExists('deleteTrajectory', 'controller', controller);
|
|
6783
6822
|
// verify required parameter 'trajectory' is not null or undefined
|
|
6784
6823
|
assertParamExists('deleteTrajectory', 'trajectory', trajectory);
|
|
6785
|
-
const localVarPath = `/cells/{cell}/trajectories/{trajectory}`
|
|
6824
|
+
const localVarPath = `/cells/{cell}/controllers/{controller}/trajectories/{trajectory}`
|
|
6786
6825
|
.replace(`{${"cell"}}`, encodeURIComponent(String(cell)))
|
|
6826
|
+
.replace(`{${"controller"}}`, encodeURIComponent(String(controller)))
|
|
6787
6827
|
.replace(`{${"trajectory"}}`, encodeURIComponent(String(trajectory)));
|
|
6788
6828
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
6789
6829
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
@@ -6812,17 +6852,21 @@ export const TrajectoryCachingApiAxiosParamCreator = function (configuration) {
|
|
|
6812
6852
|
* Get a previously created trajectory from cache. Use [listTrajectories](listTrajectories) to list all cached trajectories.
|
|
6813
6853
|
* @summary Get Trajectory
|
|
6814
6854
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
6855
|
+
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
6815
6856
|
* @param {string} trajectory This represents the unique identifier of a trajectory. Every executable or partially executable trajectory is cached and an unique identifier is returned. Indicate the unique identifier to execute the trajectory or retrieve information on the trajectory.
|
|
6816
6857
|
* @param {*} [options] Override http request option.
|
|
6817
6858
|
* @throws {RequiredError}
|
|
6818
6859
|
*/
|
|
6819
|
-
getTrajectory: async (cell, trajectory, options = {}) => {
|
|
6860
|
+
getTrajectory: async (cell, controller, trajectory, options = {}) => {
|
|
6820
6861
|
// verify required parameter 'cell' is not null or undefined
|
|
6821
6862
|
assertParamExists('getTrajectory', 'cell', cell);
|
|
6863
|
+
// verify required parameter 'controller' is not null or undefined
|
|
6864
|
+
assertParamExists('getTrajectory', 'controller', controller);
|
|
6822
6865
|
// verify required parameter 'trajectory' is not null or undefined
|
|
6823
6866
|
assertParamExists('getTrajectory', 'trajectory', trajectory);
|
|
6824
|
-
const localVarPath = `/cells/{cell}/trajectories/{trajectory}`
|
|
6867
|
+
const localVarPath = `/cells/{cell}/controllers/{controller}/trajectories/{trajectory}`
|
|
6825
6868
|
.replace(`{${"cell"}}`, encodeURIComponent(String(cell)))
|
|
6869
|
+
.replace(`{${"controller"}}`, encodeURIComponent(String(controller)))
|
|
6826
6870
|
.replace(`{${"trajectory"}}`, encodeURIComponent(String(trajectory)));
|
|
6827
6871
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
6828
6872
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
@@ -6851,14 +6895,18 @@ export const TrajectoryCachingApiAxiosParamCreator = function (configuration) {
|
|
|
6851
6895
|
* List currently cached trajectories. Use [addTrajectory](addTrajectory) to add a new trajectory. Adding trajectories is necessary to execute them. Trajectories are removed if the corresponding motion group or controller disconnects.
|
|
6852
6896
|
* @summary List Trajectories
|
|
6853
6897
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
6898
|
+
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
6854
6899
|
* @param {*} [options] Override http request option.
|
|
6855
6900
|
* @throws {RequiredError}
|
|
6856
6901
|
*/
|
|
6857
|
-
listTrajectories: async (cell, options = {}) => {
|
|
6902
|
+
listTrajectories: async (cell, controller, options = {}) => {
|
|
6858
6903
|
// verify required parameter 'cell' is not null or undefined
|
|
6859
6904
|
assertParamExists('listTrajectories', 'cell', cell);
|
|
6860
|
-
|
|
6861
|
-
|
|
6905
|
+
// verify required parameter 'controller' is not null or undefined
|
|
6906
|
+
assertParamExists('listTrajectories', 'controller', controller);
|
|
6907
|
+
const localVarPath = `/cells/{cell}/controllers/{controller}/trajectories`
|
|
6908
|
+
.replace(`{${"cell"}}`, encodeURIComponent(String(cell)))
|
|
6909
|
+
.replace(`{${"controller"}}`, encodeURIComponent(String(controller)));
|
|
6862
6910
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
6863
6911
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
6864
6912
|
let baseOptions;
|
|
@@ -6895,12 +6943,13 @@ export const TrajectoryCachingApiFp = function (configuration) {
|
|
|
6895
6943
|
* <!-- theme: info --> > Using the trajectory cache is an optional performance optimization. It is not necessary to use the cache to execute trajectories. Loads and validates the data of a trajectory into the execution cache, rendering the trajectory executable. The response contains the result of the validation of the trajectory. Validation can lead to three different results: - Fully valid: The whole trajectory can be executed from start to end. The response will contain an unique identifier which is used to move the robot. - Partially valid: Only parts of the trajectory can be executed. The response will contain an unique identifier to move the robot and information about the failure for the part that is not executable. - Invalid: The trajectory can not be executed. The response will tell you the reason of failure. If the trajectory is at least partially valid, the parts of the trajectory that are valid can be executed using the [executeTrajectory](executeTrajectory) endpoint. The workflow is as follows: - Generate a trajectory with [planTrajectory](planTrajectory) or your own motion planner, - Send the trajectory to this endpoint to validate it and get a unique identifier for it, - The unique identifier will appear in the list of available trajectories, see [listTrajectories](listTrajectories) endpoint, if it is at least partially executable. - Execute your trajectory using the [executeTrajectory](executeTrajectory) endpoint.
|
|
6896
6944
|
* @summary Add Trajectory
|
|
6897
6945
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
6946
|
+
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
6898
6947
|
* @param {AddTrajectoryRequest} addTrajectoryRequest
|
|
6899
6948
|
* @param {*} [options] Override http request option.
|
|
6900
6949
|
* @throws {RequiredError}
|
|
6901
6950
|
*/
|
|
6902
|
-
async addTrajectory(cell, addTrajectoryRequest, options) {
|
|
6903
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.addTrajectory(cell, addTrajectoryRequest, options);
|
|
6951
|
+
async addTrajectory(cell, controller, addTrajectoryRequest, options) {
|
|
6952
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.addTrajectory(cell, controller, addTrajectoryRequest, options);
|
|
6904
6953
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
6905
6954
|
const localVarOperationServerBasePath = operationServerMap['TrajectoryCachingApi.addTrajectory']?.[localVarOperationServerIndex]?.url;
|
|
6906
6955
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
@@ -6909,11 +6958,12 @@ export const TrajectoryCachingApiFp = function (configuration) {
|
|
|
6909
6958
|
* Clear the trajectory cache.
|
|
6910
6959
|
* @summary Clear Trajectories
|
|
6911
6960
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
6961
|
+
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
6912
6962
|
* @param {*} [options] Override http request option.
|
|
6913
6963
|
* @throws {RequiredError}
|
|
6914
6964
|
*/
|
|
6915
|
-
async clearTrajectories(cell, options) {
|
|
6916
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.clearTrajectories(cell, options);
|
|
6965
|
+
async clearTrajectories(cell, controller, options) {
|
|
6966
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.clearTrajectories(cell, controller, options);
|
|
6917
6967
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
6918
6968
|
const localVarOperationServerBasePath = operationServerMap['TrajectoryCachingApi.clearTrajectories']?.[localVarOperationServerIndex]?.url;
|
|
6919
6969
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
@@ -6922,12 +6972,13 @@ export const TrajectoryCachingApiFp = function (configuration) {
|
|
|
6922
6972
|
* Delete a previously created trajectory from cache. Use [listTrajectories](listTrajectories) to list all cached trajectories. Trajectories are removed automatically if the motion group or the corresponding controller is disconnected.
|
|
6923
6973
|
* @summary Delete Trajectory
|
|
6924
6974
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
6975
|
+
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
6925
6976
|
* @param {string} trajectory This represents the unique identifier of a trajectory. Every executable or partially executable trajectory is cached and an unique identifier is returned. Indicate the unique identifier to execute the trajectory or retrieve information on the trajectory.
|
|
6926
6977
|
* @param {*} [options] Override http request option.
|
|
6927
6978
|
* @throws {RequiredError}
|
|
6928
6979
|
*/
|
|
6929
|
-
async deleteTrajectory(cell, trajectory, options) {
|
|
6930
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.deleteTrajectory(cell, trajectory, options);
|
|
6980
|
+
async deleteTrajectory(cell, controller, trajectory, options) {
|
|
6981
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.deleteTrajectory(cell, controller, trajectory, options);
|
|
6931
6982
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
6932
6983
|
const localVarOperationServerBasePath = operationServerMap['TrajectoryCachingApi.deleteTrajectory']?.[localVarOperationServerIndex]?.url;
|
|
6933
6984
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
@@ -6936,12 +6987,13 @@ export const TrajectoryCachingApiFp = function (configuration) {
|
|
|
6936
6987
|
* Get a previously created trajectory from cache. Use [listTrajectories](listTrajectories) to list all cached trajectories.
|
|
6937
6988
|
* @summary Get Trajectory
|
|
6938
6989
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
6990
|
+
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
6939
6991
|
* @param {string} trajectory This represents the unique identifier of a trajectory. Every executable or partially executable trajectory is cached and an unique identifier is returned. Indicate the unique identifier to execute the trajectory or retrieve information on the trajectory.
|
|
6940
6992
|
* @param {*} [options] Override http request option.
|
|
6941
6993
|
* @throws {RequiredError}
|
|
6942
6994
|
*/
|
|
6943
|
-
async getTrajectory(cell, trajectory, options) {
|
|
6944
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.getTrajectory(cell, trajectory, options);
|
|
6995
|
+
async getTrajectory(cell, controller, trajectory, options) {
|
|
6996
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.getTrajectory(cell, controller, trajectory, options);
|
|
6945
6997
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
6946
6998
|
const localVarOperationServerBasePath = operationServerMap['TrajectoryCachingApi.getTrajectory']?.[localVarOperationServerIndex]?.url;
|
|
6947
6999
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
@@ -6950,11 +7002,12 @@ export const TrajectoryCachingApiFp = function (configuration) {
|
|
|
6950
7002
|
* List currently cached trajectories. Use [addTrajectory](addTrajectory) to add a new trajectory. Adding trajectories is necessary to execute them. Trajectories are removed if the corresponding motion group or controller disconnects.
|
|
6951
7003
|
* @summary List Trajectories
|
|
6952
7004
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
7005
|
+
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
6953
7006
|
* @param {*} [options] Override http request option.
|
|
6954
7007
|
* @throws {RequiredError}
|
|
6955
7008
|
*/
|
|
6956
|
-
async listTrajectories(cell, options) {
|
|
6957
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.listTrajectories(cell, options);
|
|
7009
|
+
async listTrajectories(cell, controller, options) {
|
|
7010
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.listTrajectories(cell, controller, options);
|
|
6958
7011
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
6959
7012
|
const localVarOperationServerBasePath = operationServerMap['TrajectoryCachingApi.listTrajectories']?.[localVarOperationServerIndex]?.url;
|
|
6960
7013
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
@@ -6972,54 +7025,59 @@ export const TrajectoryCachingApiFactory = function (configuration, basePath, ax
|
|
|
6972
7025
|
* <!-- theme: info --> > Using the trajectory cache is an optional performance optimization. It is not necessary to use the cache to execute trajectories. Loads and validates the data of a trajectory into the execution cache, rendering the trajectory executable. The response contains the result of the validation of the trajectory. Validation can lead to three different results: - Fully valid: The whole trajectory can be executed from start to end. The response will contain an unique identifier which is used to move the robot. - Partially valid: Only parts of the trajectory can be executed. The response will contain an unique identifier to move the robot and information about the failure for the part that is not executable. - Invalid: The trajectory can not be executed. The response will tell you the reason of failure. If the trajectory is at least partially valid, the parts of the trajectory that are valid can be executed using the [executeTrajectory](executeTrajectory) endpoint. The workflow is as follows: - Generate a trajectory with [planTrajectory](planTrajectory) or your own motion planner, - Send the trajectory to this endpoint to validate it and get a unique identifier for it, - The unique identifier will appear in the list of available trajectories, see [listTrajectories](listTrajectories) endpoint, if it is at least partially executable. - Execute your trajectory using the [executeTrajectory](executeTrajectory) endpoint.
|
|
6973
7026
|
* @summary Add Trajectory
|
|
6974
7027
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
7028
|
+
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
6975
7029
|
* @param {AddTrajectoryRequest} addTrajectoryRequest
|
|
6976
7030
|
* @param {*} [options] Override http request option.
|
|
6977
7031
|
* @throws {RequiredError}
|
|
6978
7032
|
*/
|
|
6979
|
-
addTrajectory(cell, addTrajectoryRequest, options) {
|
|
6980
|
-
return localVarFp.addTrajectory(cell, addTrajectoryRequest, options).then((request) => request(axios, basePath));
|
|
7033
|
+
addTrajectory(cell, controller, addTrajectoryRequest, options) {
|
|
7034
|
+
return localVarFp.addTrajectory(cell, controller, addTrajectoryRequest, options).then((request) => request(axios, basePath));
|
|
6981
7035
|
},
|
|
6982
7036
|
/**
|
|
6983
7037
|
* Clear the trajectory cache.
|
|
6984
7038
|
* @summary Clear Trajectories
|
|
6985
7039
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
7040
|
+
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
6986
7041
|
* @param {*} [options] Override http request option.
|
|
6987
7042
|
* @throws {RequiredError}
|
|
6988
7043
|
*/
|
|
6989
|
-
clearTrajectories(cell, options) {
|
|
6990
|
-
return localVarFp.clearTrajectories(cell, options).then((request) => request(axios, basePath));
|
|
7044
|
+
clearTrajectories(cell, controller, options) {
|
|
7045
|
+
return localVarFp.clearTrajectories(cell, controller, options).then((request) => request(axios, basePath));
|
|
6991
7046
|
},
|
|
6992
7047
|
/**
|
|
6993
7048
|
* Delete a previously created trajectory from cache. Use [listTrajectories](listTrajectories) to list all cached trajectories. Trajectories are removed automatically if the motion group or the corresponding controller is disconnected.
|
|
6994
7049
|
* @summary Delete Trajectory
|
|
6995
7050
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
7051
|
+
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
6996
7052
|
* @param {string} trajectory This represents the unique identifier of a trajectory. Every executable or partially executable trajectory is cached and an unique identifier is returned. Indicate the unique identifier to execute the trajectory or retrieve information on the trajectory.
|
|
6997
7053
|
* @param {*} [options] Override http request option.
|
|
6998
7054
|
* @throws {RequiredError}
|
|
6999
7055
|
*/
|
|
7000
|
-
deleteTrajectory(cell, trajectory, options) {
|
|
7001
|
-
return localVarFp.deleteTrajectory(cell, trajectory, options).then((request) => request(axios, basePath));
|
|
7056
|
+
deleteTrajectory(cell, controller, trajectory, options) {
|
|
7057
|
+
return localVarFp.deleteTrajectory(cell, controller, trajectory, options).then((request) => request(axios, basePath));
|
|
7002
7058
|
},
|
|
7003
7059
|
/**
|
|
7004
7060
|
* Get a previously created trajectory from cache. Use [listTrajectories](listTrajectories) to list all cached trajectories.
|
|
7005
7061
|
* @summary Get Trajectory
|
|
7006
7062
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
7063
|
+
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
7007
7064
|
* @param {string} trajectory This represents the unique identifier of a trajectory. Every executable or partially executable trajectory is cached and an unique identifier is returned. Indicate the unique identifier to execute the trajectory or retrieve information on the trajectory.
|
|
7008
7065
|
* @param {*} [options] Override http request option.
|
|
7009
7066
|
* @throws {RequiredError}
|
|
7010
7067
|
*/
|
|
7011
|
-
getTrajectory(cell, trajectory, options) {
|
|
7012
|
-
return localVarFp.getTrajectory(cell, trajectory, options).then((request) => request(axios, basePath));
|
|
7068
|
+
getTrajectory(cell, controller, trajectory, options) {
|
|
7069
|
+
return localVarFp.getTrajectory(cell, controller, trajectory, options).then((request) => request(axios, basePath));
|
|
7013
7070
|
},
|
|
7014
7071
|
/**
|
|
7015
7072
|
* List currently cached trajectories. Use [addTrajectory](addTrajectory) to add a new trajectory. Adding trajectories is necessary to execute them. Trajectories are removed if the corresponding motion group or controller disconnects.
|
|
7016
7073
|
* @summary List Trajectories
|
|
7017
7074
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
7075
|
+
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
7018
7076
|
* @param {*} [options] Override http request option.
|
|
7019
7077
|
* @throws {RequiredError}
|
|
7020
7078
|
*/
|
|
7021
|
-
listTrajectories(cell, options) {
|
|
7022
|
-
return localVarFp.listTrajectories(cell, options).then((request) => request(axios, basePath));
|
|
7079
|
+
listTrajectories(cell, controller, options) {
|
|
7080
|
+
return localVarFp.listTrajectories(cell, controller, options).then((request) => request(axios, basePath));
|
|
7023
7081
|
},
|
|
7024
7082
|
};
|
|
7025
7083
|
};
|
|
@@ -7034,59 +7092,64 @@ export class TrajectoryCachingApi extends BaseAPI {
|
|
|
7034
7092
|
* <!-- theme: info --> > Using the trajectory cache is an optional performance optimization. It is not necessary to use the cache to execute trajectories. Loads and validates the data of a trajectory into the execution cache, rendering the trajectory executable. The response contains the result of the validation of the trajectory. Validation can lead to three different results: - Fully valid: The whole trajectory can be executed from start to end. The response will contain an unique identifier which is used to move the robot. - Partially valid: Only parts of the trajectory can be executed. The response will contain an unique identifier to move the robot and information about the failure for the part that is not executable. - Invalid: The trajectory can not be executed. The response will tell you the reason of failure. If the trajectory is at least partially valid, the parts of the trajectory that are valid can be executed using the [executeTrajectory](executeTrajectory) endpoint. The workflow is as follows: - Generate a trajectory with [planTrajectory](planTrajectory) or your own motion planner, - Send the trajectory to this endpoint to validate it and get a unique identifier for it, - The unique identifier will appear in the list of available trajectories, see [listTrajectories](listTrajectories) endpoint, if it is at least partially executable. - Execute your trajectory using the [executeTrajectory](executeTrajectory) endpoint.
|
|
7035
7093
|
* @summary Add Trajectory
|
|
7036
7094
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
7095
|
+
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
7037
7096
|
* @param {AddTrajectoryRequest} addTrajectoryRequest
|
|
7038
7097
|
* @param {*} [options] Override http request option.
|
|
7039
7098
|
* @throws {RequiredError}
|
|
7040
7099
|
* @memberof TrajectoryCachingApi
|
|
7041
7100
|
*/
|
|
7042
|
-
addTrajectory(cell, addTrajectoryRequest, options) {
|
|
7043
|
-
return TrajectoryCachingApiFp(this.configuration).addTrajectory(cell, addTrajectoryRequest, options).then((request) => request(this.axios, this.basePath));
|
|
7101
|
+
addTrajectory(cell, controller, addTrajectoryRequest, options) {
|
|
7102
|
+
return TrajectoryCachingApiFp(this.configuration).addTrajectory(cell, controller, addTrajectoryRequest, options).then((request) => request(this.axios, this.basePath));
|
|
7044
7103
|
}
|
|
7045
7104
|
/**
|
|
7046
7105
|
* Clear the trajectory cache.
|
|
7047
7106
|
* @summary Clear Trajectories
|
|
7048
7107
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
7108
|
+
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
7049
7109
|
* @param {*} [options] Override http request option.
|
|
7050
7110
|
* @throws {RequiredError}
|
|
7051
7111
|
* @memberof TrajectoryCachingApi
|
|
7052
7112
|
*/
|
|
7053
|
-
clearTrajectories(cell, options) {
|
|
7054
|
-
return TrajectoryCachingApiFp(this.configuration).clearTrajectories(cell, options).then((request) => request(this.axios, this.basePath));
|
|
7113
|
+
clearTrajectories(cell, controller, options) {
|
|
7114
|
+
return TrajectoryCachingApiFp(this.configuration).clearTrajectories(cell, controller, options).then((request) => request(this.axios, this.basePath));
|
|
7055
7115
|
}
|
|
7056
7116
|
/**
|
|
7057
7117
|
* Delete a previously created trajectory from cache. Use [listTrajectories](listTrajectories) to list all cached trajectories. Trajectories are removed automatically if the motion group or the corresponding controller is disconnected.
|
|
7058
7118
|
* @summary Delete Trajectory
|
|
7059
7119
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
7120
|
+
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
7060
7121
|
* @param {string} trajectory This represents the unique identifier of a trajectory. Every executable or partially executable trajectory is cached and an unique identifier is returned. Indicate the unique identifier to execute the trajectory or retrieve information on the trajectory.
|
|
7061
7122
|
* @param {*} [options] Override http request option.
|
|
7062
7123
|
* @throws {RequiredError}
|
|
7063
7124
|
* @memberof TrajectoryCachingApi
|
|
7064
7125
|
*/
|
|
7065
|
-
deleteTrajectory(cell, trajectory, options) {
|
|
7066
|
-
return TrajectoryCachingApiFp(this.configuration).deleteTrajectory(cell, trajectory, options).then((request) => request(this.axios, this.basePath));
|
|
7126
|
+
deleteTrajectory(cell, controller, trajectory, options) {
|
|
7127
|
+
return TrajectoryCachingApiFp(this.configuration).deleteTrajectory(cell, controller, trajectory, options).then((request) => request(this.axios, this.basePath));
|
|
7067
7128
|
}
|
|
7068
7129
|
/**
|
|
7069
7130
|
* Get a previously created trajectory from cache. Use [listTrajectories](listTrajectories) to list all cached trajectories.
|
|
7070
7131
|
* @summary Get Trajectory
|
|
7071
7132
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
7133
|
+
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
7072
7134
|
* @param {string} trajectory This represents the unique identifier of a trajectory. Every executable or partially executable trajectory is cached and an unique identifier is returned. Indicate the unique identifier to execute the trajectory or retrieve information on the trajectory.
|
|
7073
7135
|
* @param {*} [options] Override http request option.
|
|
7074
7136
|
* @throws {RequiredError}
|
|
7075
7137
|
* @memberof TrajectoryCachingApi
|
|
7076
7138
|
*/
|
|
7077
|
-
getTrajectory(cell, trajectory, options) {
|
|
7078
|
-
return TrajectoryCachingApiFp(this.configuration).getTrajectory(cell, trajectory, options).then((request) => request(this.axios, this.basePath));
|
|
7139
|
+
getTrajectory(cell, controller, trajectory, options) {
|
|
7140
|
+
return TrajectoryCachingApiFp(this.configuration).getTrajectory(cell, controller, trajectory, options).then((request) => request(this.axios, this.basePath));
|
|
7079
7141
|
}
|
|
7080
7142
|
/**
|
|
7081
7143
|
* 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
7144
|
* @summary List Trajectories
|
|
7083
7145
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
7146
|
+
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
7084
7147
|
* @param {*} [options] Override http request option.
|
|
7085
7148
|
* @throws {RequiredError}
|
|
7086
7149
|
* @memberof TrajectoryCachingApi
|
|
7087
7150
|
*/
|
|
7088
|
-
listTrajectories(cell, options) {
|
|
7089
|
-
return TrajectoryCachingApiFp(this.configuration).listTrajectories(cell, options).then((request) => request(this.axios, this.basePath));
|
|
7151
|
+
listTrajectories(cell, controller, options) {
|
|
7152
|
+
return TrajectoryCachingApiFp(this.configuration).listTrajectories(cell, controller, options).then((request) => request(this.axios, this.basePath));
|
|
7090
7153
|
}
|
|
7091
7154
|
}
|
|
7092
7155
|
/**
|
|
@@ -7099,17 +7162,21 @@ export const TrajectoryExecutionApiAxiosParamCreator = function (configuration)
|
|
|
7099
7162
|
* <!-- theme: danger --> > Websocket endpoint Provides execution control over a previously planned trajectory. Enables the caller to attach input/output actions to the trajectory. Understanding the concept of location: The location or path parameter specifies the exact position along a trajectory. The location is a scalar value that ranges from 0 to `n`, where `n` denotes the number of motion commands, or trajectory segments, e.g. line, p2p, etc. See [planMotion](planMotion). Each integer value of the location corresponds to one motion command, e.g. 3.0 to 3.999 could be a line. ### Preconditions - The motion group\'s control mode is not claimed by any other endpoint. - The motion group\'s joint position are at start location specified with InitializeMovementRequest. - Use [executeToTrajectory](executeToTrajectory) to move the robot to the start location. ### Requests #### 1. Send InitializeMovementRequest to lock the trajectory to this connection The following actions are executed: - Sets robot controller mode to control mode, - Sets start location of the execution Keep in mind that only a single trajectory can be locked to a websocket connection at a time and not unlocked anymore. To execute another trajectory, a new connection must be established. #### 2. Send StartMovementRequest to start the movement Sets direction of movement, default is forward. #### **Optional** - To pause, send PauseMovementRequest before the movement has reached its end location. - Change the movement\'s velocity with PlaybackSpeedRequest after initializing the movement with InitializeMovementRequest. ### Responses - InitializeMovementResponse is sent to signal the success or failure of the InitializeMovementRequest. - Movement responses are streamed after a StartMovementRequest successfully started the movement. Movement responses are streamed in a rate that is defined as the multiple of the controller step-rate closest to but not exceeding the rate configured by InitializeMovementRequest. - Standstill reponse is sent once the movement has finished or has come to a standstill due to a pause. - PauseMovementResponse is sent to signal the success of the PauseMovementRequest. It does not signal the end of the movement. End of movement is signaled by Standstill reponse . - PlaybackSpeedResponse is sent to signal the success of the PlaybackSpeedRequest. - MovementError with error details is sent in case of an unexpected error, e.g. controller disconnects during movement. ### Tips and Tricks - A movement can be paused and resumed by sending PauseMovementRequest and StartMovementRequest. - Send PlaybackSpeedRequest before StartMovementRequest to reduce the velocity of the movement before it starts. - Send PlaybackSpeedRequest repeatedly to implement a slider. The velocity of the motion group can be adjusted with each controller step. Therefore, if your app needs a slider-like UI to alter the velocity of a currently running movement, you can send PlaybackSpeedRequest with different speed values repeatedly during the movement. - A closed trajectory (end and start joint position are equal) can be repeated by sending StartMovementRequest after the movement has finished.
|
|
7100
7163
|
* @summary Execute Trajectory
|
|
7101
7164
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
7165
|
+
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
7102
7166
|
* @param {ExecuteTrajectoryRequest} executeTrajectoryRequest
|
|
7103
7167
|
* @param {*} [options] Override http request option.
|
|
7104
7168
|
* @throws {RequiredError}
|
|
7105
7169
|
*/
|
|
7106
|
-
executeTrajectory: async (cell, executeTrajectoryRequest, options = {}) => {
|
|
7170
|
+
executeTrajectory: async (cell, controller, executeTrajectoryRequest, options = {}) => {
|
|
7107
7171
|
// verify required parameter 'cell' is not null or undefined
|
|
7108
7172
|
assertParamExists('executeTrajectory', 'cell', cell);
|
|
7173
|
+
// verify required parameter 'controller' is not null or undefined
|
|
7174
|
+
assertParamExists('executeTrajectory', 'controller', controller);
|
|
7109
7175
|
// verify required parameter 'executeTrajectoryRequest' is not null or undefined
|
|
7110
7176
|
assertParamExists('executeTrajectory', 'executeTrajectoryRequest', executeTrajectoryRequest);
|
|
7111
|
-
const localVarPath = `/cells/{cell}/execution/trajectory`
|
|
7112
|
-
.replace(`{${"cell"}}`, encodeURIComponent(String(cell)))
|
|
7177
|
+
const localVarPath = `/cells/{cell}/controllers/{controller}/execution/trajectory`
|
|
7178
|
+
.replace(`{${"cell"}}`, encodeURIComponent(String(cell)))
|
|
7179
|
+
.replace(`{${"controller"}}`, encodeURIComponent(String(controller)));
|
|
7113
7180
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
7114
7181
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
7115
7182
|
let baseOptions;
|
|
@@ -7148,12 +7215,13 @@ export const TrajectoryExecutionApiFp = function (configuration) {
|
|
|
7148
7215
|
* <!-- theme: danger --> > Websocket endpoint Provides execution control over a previously planned trajectory. Enables the caller to attach input/output actions to the trajectory. Understanding the concept of location: The location or path parameter specifies the exact position along a trajectory. The location is a scalar value that ranges from 0 to `n`, where `n` denotes the number of motion commands, or trajectory segments, e.g. line, p2p, etc. See [planMotion](planMotion). Each integer value of the location corresponds to one motion command, e.g. 3.0 to 3.999 could be a line. ### Preconditions - The motion group\'s control mode is not claimed by any other endpoint. - The motion group\'s joint position are at start location specified with InitializeMovementRequest. - Use [executeToTrajectory](executeToTrajectory) to move the robot to the start location. ### Requests #### 1. Send InitializeMovementRequest to lock the trajectory to this connection The following actions are executed: - Sets robot controller mode to control mode, - Sets start location of the execution Keep in mind that only a single trajectory can be locked to a websocket connection at a time and not unlocked anymore. To execute another trajectory, a new connection must be established. #### 2. Send StartMovementRequest to start the movement Sets direction of movement, default is forward. #### **Optional** - To pause, send PauseMovementRequest before the movement has reached its end location. - Change the movement\'s velocity with PlaybackSpeedRequest after initializing the movement with InitializeMovementRequest. ### Responses - InitializeMovementResponse is sent to signal the success or failure of the InitializeMovementRequest. - Movement responses are streamed after a StartMovementRequest successfully started the movement. Movement responses are streamed in a rate that is defined as the multiple of the controller step-rate closest to but not exceeding the rate configured by InitializeMovementRequest. - Standstill reponse is sent once the movement has finished or has come to a standstill due to a pause. - PauseMovementResponse is sent to signal the success of the PauseMovementRequest. It does not signal the end of the movement. End of movement is signaled by Standstill reponse . - PlaybackSpeedResponse is sent to signal the success of the PlaybackSpeedRequest. - MovementError with error details is sent in case of an unexpected error, e.g. controller disconnects during movement. ### Tips and Tricks - A movement can be paused and resumed by sending PauseMovementRequest and StartMovementRequest. - Send PlaybackSpeedRequest before StartMovementRequest to reduce the velocity of the movement before it starts. - Send PlaybackSpeedRequest repeatedly to implement a slider. The velocity of the motion group can be adjusted with each controller step. Therefore, if your app needs a slider-like UI to alter the velocity of a currently running movement, you can send PlaybackSpeedRequest with different speed values repeatedly during the movement. - A closed trajectory (end and start joint position are equal) can be repeated by sending StartMovementRequest after the movement has finished.
|
|
7149
7216
|
* @summary Execute Trajectory
|
|
7150
7217
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
7218
|
+
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
7151
7219
|
* @param {ExecuteTrajectoryRequest} executeTrajectoryRequest
|
|
7152
7220
|
* @param {*} [options] Override http request option.
|
|
7153
7221
|
* @throws {RequiredError}
|
|
7154
7222
|
*/
|
|
7155
|
-
async executeTrajectory(cell, executeTrajectoryRequest, options) {
|
|
7156
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.executeTrajectory(cell, executeTrajectoryRequest, options);
|
|
7223
|
+
async executeTrajectory(cell, controller, executeTrajectoryRequest, options) {
|
|
7224
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.executeTrajectory(cell, controller, executeTrajectoryRequest, options);
|
|
7157
7225
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
7158
7226
|
const localVarOperationServerBasePath = operationServerMap['TrajectoryExecutionApi.executeTrajectory']?.[localVarOperationServerIndex]?.url;
|
|
7159
7227
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
@@ -7171,12 +7239,13 @@ export const TrajectoryExecutionApiFactory = function (configuration, basePath,
|
|
|
7171
7239
|
* <!-- theme: danger --> > Websocket endpoint Provides execution control over a previously planned trajectory. Enables the caller to attach input/output actions to the trajectory. Understanding the concept of location: The location or path parameter specifies the exact position along a trajectory. The location is a scalar value that ranges from 0 to `n`, where `n` denotes the number of motion commands, or trajectory segments, e.g. line, p2p, etc. See [planMotion](planMotion). Each integer value of the location corresponds to one motion command, e.g. 3.0 to 3.999 could be a line. ### Preconditions - The motion group\'s control mode is not claimed by any other endpoint. - The motion group\'s joint position are at start location specified with InitializeMovementRequest. - Use [executeToTrajectory](executeToTrajectory) to move the robot to the start location. ### Requests #### 1. Send InitializeMovementRequest to lock the trajectory to this connection The following actions are executed: - Sets robot controller mode to control mode, - Sets start location of the execution Keep in mind that only a single trajectory can be locked to a websocket connection at a time and not unlocked anymore. To execute another trajectory, a new connection must be established. #### 2. Send StartMovementRequest to start the movement Sets direction of movement, default is forward. #### **Optional** - To pause, send PauseMovementRequest before the movement has reached its end location. - Change the movement\'s velocity with PlaybackSpeedRequest after initializing the movement with InitializeMovementRequest. ### Responses - InitializeMovementResponse is sent to signal the success or failure of the InitializeMovementRequest. - Movement responses are streamed after a StartMovementRequest successfully started the movement. Movement responses are streamed in a rate that is defined as the multiple of the controller step-rate closest to but not exceeding the rate configured by InitializeMovementRequest. - Standstill reponse is sent once the movement has finished or has come to a standstill due to a pause. - PauseMovementResponse is sent to signal the success of the PauseMovementRequest. It does not signal the end of the movement. End of movement is signaled by Standstill reponse . - PlaybackSpeedResponse is sent to signal the success of the PlaybackSpeedRequest. - MovementError with error details is sent in case of an unexpected error, e.g. controller disconnects during movement. ### Tips and Tricks - A movement can be paused and resumed by sending PauseMovementRequest and StartMovementRequest. - Send PlaybackSpeedRequest before StartMovementRequest to reduce the velocity of the movement before it starts. - Send PlaybackSpeedRequest repeatedly to implement a slider. The velocity of the motion group can be adjusted with each controller step. Therefore, if your app needs a slider-like UI to alter the velocity of a currently running movement, you can send PlaybackSpeedRequest with different speed values repeatedly during the movement. - A closed trajectory (end and start joint position are equal) can be repeated by sending StartMovementRequest after the movement has finished.
|
|
7172
7240
|
* @summary Execute Trajectory
|
|
7173
7241
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
7242
|
+
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
7174
7243
|
* @param {ExecuteTrajectoryRequest} executeTrajectoryRequest
|
|
7175
7244
|
* @param {*} [options] Override http request option.
|
|
7176
7245
|
* @throws {RequiredError}
|
|
7177
7246
|
*/
|
|
7178
|
-
executeTrajectory(cell, executeTrajectoryRequest, options) {
|
|
7179
|
-
return localVarFp.executeTrajectory(cell, executeTrajectoryRequest, options).then((request) => request(axios, basePath));
|
|
7247
|
+
executeTrajectory(cell, controller, executeTrajectoryRequest, options) {
|
|
7248
|
+
return localVarFp.executeTrajectory(cell, controller, executeTrajectoryRequest, options).then((request) => request(axios, basePath));
|
|
7180
7249
|
},
|
|
7181
7250
|
};
|
|
7182
7251
|
};
|
|
@@ -7191,13 +7260,14 @@ export class TrajectoryExecutionApi extends BaseAPI {
|
|
|
7191
7260
|
* <!-- theme: danger --> > Websocket endpoint Provides execution control over a previously planned trajectory. Enables the caller to attach input/output actions to the trajectory. Understanding the concept of location: The location or path parameter specifies the exact position along a trajectory. The location is a scalar value that ranges from 0 to `n`, where `n` denotes the number of motion commands, or trajectory segments, e.g. line, p2p, etc. See [planMotion](planMotion). Each integer value of the location corresponds to one motion command, e.g. 3.0 to 3.999 could be a line. ### Preconditions - The motion group\'s control mode is not claimed by any other endpoint. - The motion group\'s joint position are at start location specified with InitializeMovementRequest. - Use [executeToTrajectory](executeToTrajectory) to move the robot to the start location. ### Requests #### 1. Send InitializeMovementRequest to lock the trajectory to this connection The following actions are executed: - Sets robot controller mode to control mode, - Sets start location of the execution Keep in mind that only a single trajectory can be locked to a websocket connection at a time and not unlocked anymore. To execute another trajectory, a new connection must be established. #### 2. Send StartMovementRequest to start the movement Sets direction of movement, default is forward. #### **Optional** - To pause, send PauseMovementRequest before the movement has reached its end location. - Change the movement\'s velocity with PlaybackSpeedRequest after initializing the movement with InitializeMovementRequest. ### Responses - InitializeMovementResponse is sent to signal the success or failure of the InitializeMovementRequest. - Movement responses are streamed after a StartMovementRequest successfully started the movement. Movement responses are streamed in a rate that is defined as the multiple of the controller step-rate closest to but not exceeding the rate configured by InitializeMovementRequest. - Standstill reponse is sent once the movement has finished or has come to a standstill due to a pause. - PauseMovementResponse is sent to signal the success of the PauseMovementRequest. It does not signal the end of the movement. End of movement is signaled by Standstill reponse . - PlaybackSpeedResponse is sent to signal the success of the PlaybackSpeedRequest. - MovementError with error details is sent in case of an unexpected error, e.g. controller disconnects during movement. ### Tips and Tricks - A movement can be paused and resumed by sending PauseMovementRequest and StartMovementRequest. - Send PlaybackSpeedRequest before StartMovementRequest to reduce the velocity of the movement before it starts. - Send PlaybackSpeedRequest repeatedly to implement a slider. The velocity of the motion group can be adjusted with each controller step. Therefore, if your app needs a slider-like UI to alter the velocity of a currently running movement, you can send PlaybackSpeedRequest with different speed values repeatedly during the movement. - A closed trajectory (end and start joint position are equal) can be repeated by sending StartMovementRequest after the movement has finished.
|
|
7192
7261
|
* @summary Execute Trajectory
|
|
7193
7262
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
7263
|
+
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
7194
7264
|
* @param {ExecuteTrajectoryRequest} executeTrajectoryRequest
|
|
7195
7265
|
* @param {*} [options] Override http request option.
|
|
7196
7266
|
* @throws {RequiredError}
|
|
7197
7267
|
* @memberof TrajectoryExecutionApi
|
|
7198
7268
|
*/
|
|
7199
|
-
executeTrajectory(cell, executeTrajectoryRequest, options) {
|
|
7200
|
-
return TrajectoryExecutionApiFp(this.configuration).executeTrajectory(cell, executeTrajectoryRequest, options).then((request) => request(this.axios, this.basePath));
|
|
7269
|
+
executeTrajectory(cell, controller, executeTrajectoryRequest, options) {
|
|
7270
|
+
return TrajectoryExecutionApiFp(this.configuration).executeTrajectory(cell, controller, executeTrajectoryRequest, options).then((request) => request(this.axios, this.basePath));
|
|
7201
7271
|
}
|
|
7202
7272
|
}
|
|
7203
7273
|
/**
|
|
@@ -7310,38 +7380,41 @@ export class TrajectoryPlanningApi extends BaseAPI {
|
|
|
7310
7380
|
}
|
|
7311
7381
|
}
|
|
7312
7382
|
/**
|
|
7313
|
-
*
|
|
7383
|
+
* VirtualControllerApi - axios parameter creator
|
|
7314
7384
|
* @export
|
|
7315
7385
|
*/
|
|
7316
|
-
export const
|
|
7386
|
+
export const VirtualControllerApiAxiosParamCreator = function (configuration) {
|
|
7317
7387
|
return {
|
|
7318
7388
|
/**
|
|
7319
|
-
*
|
|
7320
|
-
* @summary
|
|
7389
|
+
* Adds a coordinate system to the robot controller.
|
|
7390
|
+
* @summary Add Coordinate Systems
|
|
7321
7391
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
7322
7392
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
7323
|
-
* @param {string}
|
|
7393
|
+
* @param {string} coordinateSystem Unique identifier addressing a coordinate system.
|
|
7394
|
+
* @param {CoordinateSystemData} coordinateSystemData
|
|
7324
7395
|
* @param {*} [options] Override http request option.
|
|
7325
7396
|
* @throws {RequiredError}
|
|
7326
7397
|
*/
|
|
7327
|
-
|
|
7398
|
+
addVirtualRobotCoordinateSystem: async (cell, controller, coordinateSystem, coordinateSystemData, options = {}) => {
|
|
7328
7399
|
// verify required parameter 'cell' is not null or undefined
|
|
7329
|
-
assertParamExists('
|
|
7400
|
+
assertParamExists('addVirtualRobotCoordinateSystem', 'cell', cell);
|
|
7330
7401
|
// verify required parameter 'controller' is not null or undefined
|
|
7331
|
-
assertParamExists('
|
|
7332
|
-
// verify required parameter '
|
|
7333
|
-
assertParamExists('
|
|
7334
|
-
|
|
7402
|
+
assertParamExists('addVirtualRobotCoordinateSystem', 'controller', controller);
|
|
7403
|
+
// verify required parameter 'coordinateSystem' is not null or undefined
|
|
7404
|
+
assertParamExists('addVirtualRobotCoordinateSystem', 'coordinateSystem', coordinateSystem);
|
|
7405
|
+
// verify required parameter 'coordinateSystemData' is not null or undefined
|
|
7406
|
+
assertParamExists('addVirtualRobotCoordinateSystem', 'coordinateSystemData', coordinateSystemData);
|
|
7407
|
+
const localVarPath = `/cells/{cell}/virtual-controllers/{controller}/coordinate-systems/{coordinate-system}`
|
|
7335
7408
|
.replace(`{${"cell"}}`, encodeURIComponent(String(cell)))
|
|
7336
7409
|
.replace(`{${"controller"}}`, encodeURIComponent(String(controller)))
|
|
7337
|
-
.replace(`{${"
|
|
7410
|
+
.replace(`{${"coordinate-system"}}`, encodeURIComponent(String(coordinateSystem)));
|
|
7338
7411
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
7339
7412
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
7340
7413
|
let baseOptions;
|
|
7341
7414
|
if (configuration) {
|
|
7342
7415
|
baseOptions = configuration.baseOptions;
|
|
7343
7416
|
}
|
|
7344
|
-
const localVarRequestOptions = { method: '
|
|
7417
|
+
const localVarRequestOptions = { method: 'PUT', ...baseOptions, ...options };
|
|
7345
7418
|
const localVarHeaderParameter = {};
|
|
7346
7419
|
const localVarQueryParameter = {};
|
|
7347
7420
|
// authentication BasicAuth required
|
|
@@ -7350,37 +7423,50 @@ export const VirtualRobotApiAxiosParamCreator = function (configuration) {
|
|
|
7350
7423
|
// authentication BearerAuth required
|
|
7351
7424
|
// http bearer authentication required
|
|
7352
7425
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
7426
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
7353
7427
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
7354
7428
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
7355
7429
|
localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
|
|
7430
|
+
localVarRequestOptions.data = serializeDataIfNeeded(coordinateSystemData, localVarRequestOptions, configuration);
|
|
7356
7431
|
return {
|
|
7357
7432
|
url: toPathString(localVarUrlObj),
|
|
7358
7433
|
options: localVarRequestOptions,
|
|
7359
7434
|
};
|
|
7360
7435
|
},
|
|
7361
7436
|
/**
|
|
7362
|
-
*
|
|
7363
|
-
* @summary
|
|
7437
|
+
* 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.
|
|
7438
|
+
* @summary Add TCP
|
|
7364
7439
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
7365
7440
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
7441
|
+
* @param {string} motionGroup The motion-group identifier.
|
|
7442
|
+
* @param {string} tcp The unique identifier of a TCP.
|
|
7443
|
+
* @param {RobotTcpData} robotTcpData
|
|
7366
7444
|
* @param {*} [options] Override http request option.
|
|
7367
7445
|
* @throws {RequiredError}
|
|
7368
7446
|
*/
|
|
7369
|
-
|
|
7447
|
+
addVirtualRobotTcp: async (cell, controller, motionGroup, tcp, robotTcpData, options = {}) => {
|
|
7370
7448
|
// verify required parameter 'cell' is not null or undefined
|
|
7371
|
-
assertParamExists('
|
|
7449
|
+
assertParamExists('addVirtualRobotTcp', 'cell', cell);
|
|
7372
7450
|
// verify required parameter 'controller' is not null or undefined
|
|
7373
|
-
assertParamExists('
|
|
7374
|
-
|
|
7451
|
+
assertParamExists('addVirtualRobotTcp', 'controller', controller);
|
|
7452
|
+
// verify required parameter 'motionGroup' is not null or undefined
|
|
7453
|
+
assertParamExists('addVirtualRobotTcp', 'motionGroup', motionGroup);
|
|
7454
|
+
// verify required parameter 'tcp' is not null or undefined
|
|
7455
|
+
assertParamExists('addVirtualRobotTcp', 'tcp', tcp);
|
|
7456
|
+
// verify required parameter 'robotTcpData' is not null or undefined
|
|
7457
|
+
assertParamExists('addVirtualRobotTcp', 'robotTcpData', robotTcpData);
|
|
7458
|
+
const localVarPath = `/cells/{cell}/virtual-controllers/{controller}/motion-groups/{motion-group}/tcps/{tcp}`
|
|
7375
7459
|
.replace(`{${"cell"}}`, encodeURIComponent(String(cell)))
|
|
7376
|
-
.replace(`{${"controller"}}`, encodeURIComponent(String(controller)))
|
|
7460
|
+
.replace(`{${"controller"}}`, encodeURIComponent(String(controller)))
|
|
7461
|
+
.replace(`{${"motion-group"}}`, encodeURIComponent(String(motionGroup)))
|
|
7462
|
+
.replace(`{${"tcp"}}`, encodeURIComponent(String(tcp)));
|
|
7377
7463
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
7378
7464
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
7379
7465
|
let baseOptions;
|
|
7380
7466
|
if (configuration) {
|
|
7381
7467
|
baseOptions = configuration.baseOptions;
|
|
7382
7468
|
}
|
|
7383
|
-
const localVarRequestOptions = { method: '
|
|
7469
|
+
const localVarRequestOptions = { method: 'PUT', ...baseOptions, ...options };
|
|
7384
7470
|
const localVarHeaderParameter = {};
|
|
7385
7471
|
const localVarQueryParameter = {};
|
|
7386
7472
|
// authentication BasicAuth required
|
|
@@ -7389,40 +7475,44 @@ export const VirtualRobotApiAxiosParamCreator = function (configuration) {
|
|
|
7389
7475
|
// authentication BearerAuth required
|
|
7390
7476
|
// http bearer authentication required
|
|
7391
7477
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
7478
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
7392
7479
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
7393
7480
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
7394
7481
|
localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
|
|
7482
|
+
localVarRequestOptions.data = serializeDataIfNeeded(robotTcpData, localVarRequestOptions, configuration);
|
|
7395
7483
|
return {
|
|
7396
7484
|
url: toPathString(localVarUrlObj),
|
|
7397
7485
|
options: localVarRequestOptions,
|
|
7398
7486
|
};
|
|
7399
7487
|
},
|
|
7400
7488
|
/**
|
|
7401
|
-
*
|
|
7402
|
-
* @summary
|
|
7489
|
+
* 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.
|
|
7490
|
+
* @summary Remove Coordinate System
|
|
7403
7491
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
7404
7492
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
7405
|
-
* @param {
|
|
7493
|
+
* @param {string} coordinateSystem Unique identifier addressing a coordinate system.
|
|
7494
|
+
* @param {boolean} [deleteDependent] If true, all dependent coordinate systems will be deleted as well.
|
|
7406
7495
|
* @param {*} [options] Override http request option.
|
|
7407
7496
|
* @throws {RequiredError}
|
|
7408
7497
|
*/
|
|
7409
|
-
|
|
7498
|
+
deleteVirtualRobotCoordinateSystem: async (cell, controller, coordinateSystem, deleteDependent, options = {}) => {
|
|
7410
7499
|
// verify required parameter 'cell' is not null or undefined
|
|
7411
|
-
assertParamExists('
|
|
7500
|
+
assertParamExists('deleteVirtualRobotCoordinateSystem', 'cell', cell);
|
|
7412
7501
|
// verify required parameter 'controller' is not null or undefined
|
|
7413
|
-
assertParamExists('
|
|
7414
|
-
// verify required parameter '
|
|
7415
|
-
assertParamExists('
|
|
7416
|
-
const localVarPath = `/cells/{cell}/controllers/{controller}/
|
|
7502
|
+
assertParamExists('deleteVirtualRobotCoordinateSystem', 'controller', controller);
|
|
7503
|
+
// verify required parameter 'coordinateSystem' is not null or undefined
|
|
7504
|
+
assertParamExists('deleteVirtualRobotCoordinateSystem', 'coordinateSystem', coordinateSystem);
|
|
7505
|
+
const localVarPath = `/cells/{cell}/virtual-controllers/{controller}/coordinate-systems/{coordinate-system}`
|
|
7417
7506
|
.replace(`{${"cell"}}`, encodeURIComponent(String(cell)))
|
|
7418
|
-
.replace(`{${"controller"}}`, encodeURIComponent(String(controller)))
|
|
7507
|
+
.replace(`{${"controller"}}`, encodeURIComponent(String(controller)))
|
|
7508
|
+
.replace(`{${"coordinate-system"}}`, encodeURIComponent(String(coordinateSystem)));
|
|
7419
7509
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
7420
7510
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
7421
7511
|
let baseOptions;
|
|
7422
7512
|
if (configuration) {
|
|
7423
7513
|
baseOptions = configuration.baseOptions;
|
|
7424
7514
|
}
|
|
7425
|
-
const localVarRequestOptions = { method: '
|
|
7515
|
+
const localVarRequestOptions = { method: 'DELETE', ...baseOptions, ...options };
|
|
7426
7516
|
const localVarHeaderParameter = {};
|
|
7427
7517
|
const localVarQueryParameter = {};
|
|
7428
7518
|
// authentication BasicAuth required
|
|
@@ -7431,8 +7521,8 @@ export const VirtualRobotApiAxiosParamCreator = function (configuration) {
|
|
|
7431
7521
|
// authentication BearerAuth required
|
|
7432
7522
|
// http bearer authentication required
|
|
7433
7523
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
7434
|
-
if (
|
|
7435
|
-
localVarQueryParameter['
|
|
7524
|
+
if (deleteDependent !== undefined) {
|
|
7525
|
+
localVarQueryParameter['delete_dependent'] = deleteDependent;
|
|
7436
7526
|
}
|
|
7437
7527
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
7438
7528
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
@@ -7443,32 +7533,36 @@ export const VirtualRobotApiAxiosParamCreator = function (configuration) {
|
|
|
7443
7533
|
};
|
|
7444
7534
|
},
|
|
7445
7535
|
/**
|
|
7446
|
-
*
|
|
7447
|
-
* @summary
|
|
7536
|
+
* Removes the TCP from the motion group. An unknown TCP is a valid input.
|
|
7537
|
+
* @summary Remove TCP
|
|
7448
7538
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
7449
7539
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
7450
|
-
* @param {
|
|
7451
|
-
* @param {
|
|
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.
|
|
7540
|
+
* @param {string} motionGroup The motion-group identifier.
|
|
7541
|
+
* @param {string} tcp The unique identifier of a TCP.
|
|
7454
7542
|
* @param {*} [options] Override http request option.
|
|
7455
7543
|
* @throws {RequiredError}
|
|
7456
7544
|
*/
|
|
7457
|
-
|
|
7545
|
+
deleteVirtualRobotTcp: async (cell, controller, motionGroup, tcp, options = {}) => {
|
|
7458
7546
|
// verify required parameter 'cell' is not null or undefined
|
|
7459
|
-
assertParamExists('
|
|
7547
|
+
assertParamExists('deleteVirtualRobotTcp', 'cell', cell);
|
|
7460
7548
|
// verify required parameter 'controller' is not null or undefined
|
|
7461
|
-
assertParamExists('
|
|
7462
|
-
|
|
7549
|
+
assertParamExists('deleteVirtualRobotTcp', 'controller', controller);
|
|
7550
|
+
// verify required parameter 'motionGroup' is not null or undefined
|
|
7551
|
+
assertParamExists('deleteVirtualRobotTcp', 'motionGroup', motionGroup);
|
|
7552
|
+
// verify required parameter 'tcp' is not null or undefined
|
|
7553
|
+
assertParamExists('deleteVirtualRobotTcp', 'tcp', tcp);
|
|
7554
|
+
const localVarPath = `/cells/{cell}/virtual-controllers/{controller}/motion-groups/{motion-group}/tcps/{tcp}`
|
|
7463
7555
|
.replace(`{${"cell"}}`, encodeURIComponent(String(cell)))
|
|
7464
|
-
.replace(`{${"controller"}}`, encodeURIComponent(String(controller)))
|
|
7556
|
+
.replace(`{${"controller"}}`, encodeURIComponent(String(controller)))
|
|
7557
|
+
.replace(`{${"motion-group"}}`, encodeURIComponent(String(motionGroup)))
|
|
7558
|
+
.replace(`{${"tcp"}}`, encodeURIComponent(String(tcp)));
|
|
7465
7559
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
7466
7560
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
7467
7561
|
let baseOptions;
|
|
7468
7562
|
if (configuration) {
|
|
7469
7563
|
baseOptions = configuration.baseOptions;
|
|
7470
7564
|
}
|
|
7471
|
-
const localVarRequestOptions = { method: '
|
|
7565
|
+
const localVarRequestOptions = { method: 'DELETE', ...baseOptions, ...options };
|
|
7472
7566
|
const localVarHeaderParameter = {};
|
|
7473
7567
|
const localVarQueryParameter = {};
|
|
7474
7568
|
// authentication BasicAuth required
|
|
@@ -7477,18 +7571,6 @@ export const VirtualRobotApiAxiosParamCreator = function (configuration) {
|
|
|
7477
7571
|
// authentication BearerAuth required
|
|
7478
7572
|
// http bearer authentication required
|
|
7479
7573
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
7480
|
-
if (ios) {
|
|
7481
|
-
localVarQueryParameter['ios'] = ios;
|
|
7482
|
-
}
|
|
7483
|
-
if (direction !== undefined) {
|
|
7484
|
-
localVarQueryParameter['direction'] = direction;
|
|
7485
|
-
}
|
|
7486
|
-
if (valueType !== undefined) {
|
|
7487
|
-
localVarQueryParameter['value_type'] = valueType;
|
|
7488
|
-
}
|
|
7489
|
-
if (group !== undefined) {
|
|
7490
|
-
localVarQueryParameter['group'] = group;
|
|
7491
|
-
}
|
|
7492
7574
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
7493
7575
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
7494
7576
|
localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
|
|
@@ -7498,22 +7580,19 @@ export const VirtualRobotApiAxiosParamCreator = function (configuration) {
|
|
|
7498
7580
|
};
|
|
7499
7581
|
},
|
|
7500
7582
|
/**
|
|
7501
|
-
*
|
|
7502
|
-
* @summary
|
|
7583
|
+
* 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.
|
|
7584
|
+
* @summary Get Emergency Stop State
|
|
7503
7585
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
7504
7586
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
7505
|
-
* @param {Array<IOValue>} iOValue
|
|
7506
7587
|
* @param {*} [options] Override http request option.
|
|
7507
7588
|
* @throws {RequiredError}
|
|
7508
7589
|
*/
|
|
7509
|
-
|
|
7590
|
+
getEmergencyStop: async (cell, controller, options = {}) => {
|
|
7510
7591
|
// verify required parameter 'cell' is not null or undefined
|
|
7511
|
-
assertParamExists('
|
|
7592
|
+
assertParamExists('getEmergencyStop', 'cell', cell);
|
|
7512
7593
|
// verify required parameter 'controller' is not null or undefined
|
|
7513
|
-
assertParamExists('
|
|
7514
|
-
|
|
7515
|
-
assertParamExists('setIOValues', 'iOValue', iOValue);
|
|
7516
|
-
const localVarPath = `/cells/{cell}/controllers/{controller}/teach-pendant/ios`
|
|
7594
|
+
assertParamExists('getEmergencyStop', 'controller', controller);
|
|
7595
|
+
const localVarPath = `/cells/{cell}/virtual-controllers/{controller}/emergency-stop`
|
|
7517
7596
|
.replace(`{${"cell"}}`, encodeURIComponent(String(cell)))
|
|
7518
7597
|
.replace(`{${"controller"}}`, encodeURIComponent(String(controller)));
|
|
7519
7598
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
@@ -7522,7 +7601,7 @@ export const VirtualRobotApiAxiosParamCreator = function (configuration) {
|
|
|
7522
7601
|
if (configuration) {
|
|
7523
7602
|
baseOptions = configuration.baseOptions;
|
|
7524
7603
|
}
|
|
7525
|
-
const localVarRequestOptions = { method: '
|
|
7604
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options };
|
|
7526
7605
|
const localVarHeaderParameter = {};
|
|
7527
7606
|
const localVarQueryParameter = {};
|
|
7528
7607
|
// authentication BasicAuth required
|
|
@@ -7531,36 +7610,31 @@ export const VirtualRobotApiAxiosParamCreator = function (configuration) {
|
|
|
7531
7610
|
// authentication BearerAuth required
|
|
7532
7611
|
// http bearer authentication required
|
|
7533
7612
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
7534
|
-
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
7535
7613
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
7536
7614
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
7537
7615
|
localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
|
|
7538
|
-
localVarRequestOptions.data = serializeDataIfNeeded(iOValue, localVarRequestOptions, configuration);
|
|
7539
7616
|
return {
|
|
7540
7617
|
url: toPathString(localVarUrlObj),
|
|
7541
7618
|
options: localVarRequestOptions,
|
|
7542
7619
|
};
|
|
7543
7620
|
},
|
|
7544
7621
|
/**
|
|
7545
|
-
*
|
|
7546
|
-
* @summary
|
|
7622
|
+
* Get the current motion group state which provides values for the joints\' position, velocity and acceleration.
|
|
7623
|
+
* @summary Get Motion Group State
|
|
7547
7624
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
7548
7625
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
7549
7626
|
* @param {string} motionGroup The motion-group identifier.
|
|
7550
|
-
* @param {MotionGroupJoints} motionGroupJoints
|
|
7551
7627
|
* @param {*} [options] Override http request option.
|
|
7552
7628
|
* @throws {RequiredError}
|
|
7553
7629
|
*/
|
|
7554
|
-
|
|
7630
|
+
getMotionGroupState: async (cell, controller, motionGroup, options = {}) => {
|
|
7555
7631
|
// verify required parameter 'cell' is not null or undefined
|
|
7556
|
-
assertParamExists('
|
|
7632
|
+
assertParamExists('getMotionGroupState', 'cell', cell);
|
|
7557
7633
|
// verify required parameter 'controller' is not null or undefined
|
|
7558
|
-
assertParamExists('
|
|
7634
|
+
assertParamExists('getMotionGroupState', 'controller', controller);
|
|
7559
7635
|
// verify required parameter 'motionGroup' is not null or undefined
|
|
7560
|
-
assertParamExists('
|
|
7561
|
-
|
|
7562
|
-
assertParamExists('setMotionGroupState', 'motionGroupJoints', motionGroupJoints);
|
|
7563
|
-
const localVarPath = `/cells/{cell}/controllers/{controller}/teach-pendant/motion-groups/{motion-group}`
|
|
7636
|
+
assertParamExists('getMotionGroupState', 'motionGroup', motionGroup);
|
|
7637
|
+
const localVarPath = `/cells/{cell}/virtual-controllers/{controller}/motion-groups/{motion-group}/state`
|
|
7564
7638
|
.replace(`{${"cell"}}`, encodeURIComponent(String(cell)))
|
|
7565
7639
|
.replace(`{${"controller"}}`, encodeURIComponent(String(controller)))
|
|
7566
7640
|
.replace(`{${"motion-group"}}`, encodeURIComponent(String(motionGroup)));
|
|
@@ -7570,7 +7644,7 @@ export const VirtualRobotApiAxiosParamCreator = function (configuration) {
|
|
|
7570
7644
|
if (configuration) {
|
|
7571
7645
|
baseOptions = configuration.baseOptions;
|
|
7572
7646
|
}
|
|
7573
|
-
const localVarRequestOptions = { method: '
|
|
7647
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options };
|
|
7574
7648
|
const localVarHeaderParameter = {};
|
|
7575
7649
|
const localVarQueryParameter = {};
|
|
7576
7650
|
// authentication BasicAuth required
|
|
@@ -7579,40 +7653,14 @@ export const VirtualRobotApiAxiosParamCreator = function (configuration) {
|
|
|
7579
7653
|
// authentication BearerAuth required
|
|
7580
7654
|
// http bearer authentication required
|
|
7581
7655
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
7582
|
-
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
7583
7656
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
7584
7657
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
7585
7658
|
localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
|
|
7586
|
-
localVarRequestOptions.data = serializeDataIfNeeded(motionGroupJoints, localVarRequestOptions, configuration);
|
|
7587
7659
|
return {
|
|
7588
7660
|
url: toPathString(localVarUrlObj),
|
|
7589
7661
|
options: localVarRequestOptions,
|
|
7590
7662
|
};
|
|
7591
7663
|
},
|
|
7592
|
-
};
|
|
7593
|
-
};
|
|
7594
|
-
/**
|
|
7595
|
-
* VirtualRobotApi - functional programming interface
|
|
7596
|
-
* @export
|
|
7597
|
-
*/
|
|
7598
|
-
export const VirtualRobotApiFp = function (configuration) {
|
|
7599
|
-
const localVarAxiosParamCreator = VirtualRobotApiAxiosParamCreator(configuration);
|
|
7600
|
-
return {
|
|
7601
|
-
/**
|
|
7602
|
-
* Get the current motion group state which provides values for the joints\' position, velocity and acceleration.
|
|
7603
|
-
* @summary Get Motion Group State
|
|
7604
|
-
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
7605
|
-
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
7606
|
-
* @param {string} motionGroup The motion-group identifier.
|
|
7607
|
-
* @param {*} [options] Override http request option.
|
|
7608
|
-
* @throws {RequiredError}
|
|
7609
|
-
*/
|
|
7610
|
-
async getMotionGroupState(cell, controller, motionGroup, options) {
|
|
7611
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.getMotionGroupState(cell, controller, motionGroup, options);
|
|
7612
|
-
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
7613
|
-
const localVarOperationServerBasePath = operationServerMap['VirtualRobotApi.getMotionGroupState']?.[localVarOperationServerIndex]?.url;
|
|
7614
|
-
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
7615
|
-
},
|
|
7616
7664
|
/**
|
|
7617
7665
|
* Gets information on the motion group.
|
|
7618
7666
|
* @summary Motion Group Description
|
|
@@ -7621,274 +7669,51 @@ export const VirtualRobotApiFp = function (configuration) {
|
|
|
7621
7669
|
* @param {*} [options] Override http request option.
|
|
7622
7670
|
* @throws {RequiredError}
|
|
7623
7671
|
*/
|
|
7624
|
-
async
|
|
7625
|
-
|
|
7626
|
-
|
|
7627
|
-
|
|
7628
|
-
|
|
7629
|
-
|
|
7630
|
-
|
|
7631
|
-
|
|
7632
|
-
|
|
7633
|
-
|
|
7634
|
-
|
|
7635
|
-
|
|
7636
|
-
|
|
7637
|
-
|
|
7638
|
-
|
|
7639
|
-
|
|
7640
|
-
const
|
|
7641
|
-
|
|
7642
|
-
|
|
7643
|
-
|
|
7644
|
-
|
|
7645
|
-
|
|
7646
|
-
|
|
7647
|
-
|
|
7648
|
-
|
|
7649
|
-
|
|
7650
|
-
|
|
7651
|
-
|
|
7652
|
-
|
|
7653
|
-
|
|
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));
|
|
7672
|
+
getMotionGroups: async (cell, controller, options = {}) => {
|
|
7673
|
+
// verify required parameter 'cell' is not null or undefined
|
|
7674
|
+
assertParamExists('getMotionGroups', 'cell', cell);
|
|
7675
|
+
// verify required parameter 'controller' is not null or undefined
|
|
7676
|
+
assertParamExists('getMotionGroups', 'controller', controller);
|
|
7677
|
+
const localVarPath = `/cells/{cell}/virtual-controllers/{controller}/motion-groups`
|
|
7678
|
+
.replace(`{${"cell"}}`, encodeURIComponent(String(cell)))
|
|
7679
|
+
.replace(`{${"controller"}}`, encodeURIComponent(String(controller)));
|
|
7680
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
7681
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
7682
|
+
let baseOptions;
|
|
7683
|
+
if (configuration) {
|
|
7684
|
+
baseOptions = configuration.baseOptions;
|
|
7685
|
+
}
|
|
7686
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options };
|
|
7687
|
+
const localVarHeaderParameter = {};
|
|
7688
|
+
const localVarQueryParameter = {};
|
|
7689
|
+
// authentication BasicAuth required
|
|
7690
|
+
// http basic authentication required
|
|
7691
|
+
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
7692
|
+
// authentication BearerAuth required
|
|
7693
|
+
// http bearer authentication required
|
|
7694
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
7695
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
7696
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
7697
|
+
localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
|
|
7698
|
+
return {
|
|
7699
|
+
url: toPathString(localVarUrlObj),
|
|
7700
|
+
options: localVarRequestOptions,
|
|
7701
|
+
};
|
|
7777
7702
|
},
|
|
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
7703
|
/**
|
|
7876
|
-
*
|
|
7877
|
-
* @summary
|
|
7704
|
+
* 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.
|
|
7705
|
+
* @summary Get Operation Mode
|
|
7878
7706
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
7879
7707
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
7880
|
-
* @param {ExternalJointStreamDatapoint} externalJointStreamDatapoint
|
|
7881
7708
|
* @param {*} [options] Override http request option.
|
|
7882
7709
|
* @throws {RequiredError}
|
|
7883
7710
|
*/
|
|
7884
|
-
|
|
7711
|
+
getOperationMode: async (cell, controller, options = {}) => {
|
|
7885
7712
|
// verify required parameter 'cell' is not null or undefined
|
|
7886
|
-
assertParamExists('
|
|
7713
|
+
assertParamExists('getOperationMode', 'cell', cell);
|
|
7887
7714
|
// verify required parameter 'controller' is not null or undefined
|
|
7888
|
-
assertParamExists('
|
|
7889
|
-
|
|
7890
|
-
assertParamExists('externalJointsStream', 'externalJointStreamDatapoint', externalJointStreamDatapoint);
|
|
7891
|
-
const localVarPath = `/cells/{cell}/controllers/{controller}/teach-pendant/motion-groups/external-joints-stream`
|
|
7715
|
+
assertParamExists('getOperationMode', 'controller', controller);
|
|
7716
|
+
const localVarPath = `/cells/{cell}/virtual-controllers/{controller}/operationmode`
|
|
7892
7717
|
.replace(`{${"cell"}}`, encodeURIComponent(String(cell)))
|
|
7893
7718
|
.replace(`{${"controller"}}`, encodeURIComponent(String(controller)));
|
|
7894
7719
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
@@ -7906,33 +7731,31 @@ export const VirtualRobotBehaviorApiAxiosParamCreator = function (configuration)
|
|
|
7906
7731
|
// authentication BearerAuth required
|
|
7907
7732
|
// http bearer authentication required
|
|
7908
7733
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
7909
|
-
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
7910
7734
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
7911
7735
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
7912
7736
|
localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
|
|
7913
|
-
localVarRequestOptions.data = serializeDataIfNeeded(externalJointStreamDatapoint, localVarRequestOptions, configuration);
|
|
7914
7737
|
return {
|
|
7915
7738
|
url: toPathString(localVarUrlObj),
|
|
7916
7739
|
options: localVarRequestOptions,
|
|
7917
7740
|
};
|
|
7918
7741
|
},
|
|
7919
7742
|
/**
|
|
7920
|
-
*
|
|
7921
|
-
* @summary
|
|
7743
|
+
* Gets motion group mounting. The motion group is based on the origin of the returned coordinate system.
|
|
7744
|
+
* @summary Get Mounting
|
|
7922
7745
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
7923
7746
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
7924
7747
|
* @param {string} motionGroup The motion-group identifier.
|
|
7925
7748
|
* @param {*} [options] Override http request option.
|
|
7926
7749
|
* @throws {RequiredError}
|
|
7927
7750
|
*/
|
|
7928
|
-
|
|
7751
|
+
getVirtualRobotMounting: async (cell, controller, motionGroup, options = {}) => {
|
|
7929
7752
|
// verify required parameter 'cell' is not null or undefined
|
|
7930
|
-
assertParamExists('
|
|
7753
|
+
assertParamExists('getVirtualRobotMounting', 'cell', cell);
|
|
7931
7754
|
// verify required parameter 'controller' is not null or undefined
|
|
7932
|
-
assertParamExists('
|
|
7755
|
+
assertParamExists('getVirtualRobotMounting', 'controller', controller);
|
|
7933
7756
|
// verify required parameter 'motionGroup' is not null or undefined
|
|
7934
|
-
assertParamExists('
|
|
7935
|
-
const localVarPath = `/cells/{cell}/controllers/{controller}/
|
|
7757
|
+
assertParamExists('getVirtualRobotMounting', 'motionGroup', motionGroup);
|
|
7758
|
+
const localVarPath = `/cells/{cell}/virtual-controllers/{controller}/motion-groups/{motion-group}/mounting`
|
|
7936
7759
|
.replace(`{${"cell"}}`, encodeURIComponent(String(cell)))
|
|
7937
7760
|
.replace(`{${"controller"}}`, encodeURIComponent(String(controller)))
|
|
7938
7761
|
.replace(`{${"motion-group"}}`, encodeURIComponent(String(motionGroup)));
|
|
@@ -7960,33 +7783,28 @@ export const VirtualRobotBehaviorApiAxiosParamCreator = function (configuration)
|
|
|
7960
7783
|
};
|
|
7961
7784
|
},
|
|
7962
7785
|
/**
|
|
7963
|
-
*
|
|
7964
|
-
* @summary
|
|
7786
|
+
* Lists all coordinate systems on the robot controller.
|
|
7787
|
+
* @summary List Coordinate Systems
|
|
7965
7788
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
7966
7789
|
* @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
7790
|
* @param {*} [options] Override http request option.
|
|
7970
7791
|
* @throws {RequiredError}
|
|
7971
7792
|
*/
|
|
7972
|
-
|
|
7793
|
+
listVirtualRobotCoordinateSystems: async (cell, controller, options = {}) => {
|
|
7973
7794
|
// verify required parameter 'cell' is not null or undefined
|
|
7974
|
-
assertParamExists('
|
|
7795
|
+
assertParamExists('listVirtualRobotCoordinateSystems', 'cell', cell);
|
|
7975
7796
|
// verify required parameter 'controller' is not null or undefined
|
|
7976
|
-
assertParamExists('
|
|
7977
|
-
|
|
7978
|
-
assertParamExists('setMotionGroupBehavior', 'motionGroup', motionGroup);
|
|
7979
|
-
const localVarPath = `/cells/{cell}/controllers/{controller}/teach-pendant/motion-groups/{motion-group}/behavior`
|
|
7797
|
+
assertParamExists('listVirtualRobotCoordinateSystems', 'controller', controller);
|
|
7798
|
+
const localVarPath = `/cells/{cell}/virtual-controllers/{controller}/coordinate-systems`
|
|
7980
7799
|
.replace(`{${"cell"}}`, encodeURIComponent(String(cell)))
|
|
7981
|
-
.replace(`{${"controller"}}`, encodeURIComponent(String(controller)))
|
|
7982
|
-
.replace(`{${"motion-group"}}`, encodeURIComponent(String(motionGroup)));
|
|
7800
|
+
.replace(`{${"controller"}}`, encodeURIComponent(String(controller)));
|
|
7983
7801
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
7984
7802
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
7985
7803
|
let baseOptions;
|
|
7986
7804
|
if (configuration) {
|
|
7987
7805
|
baseOptions = configuration.baseOptions;
|
|
7988
7806
|
}
|
|
7989
|
-
const localVarRequestOptions = { method: '
|
|
7807
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options };
|
|
7990
7808
|
const localVarHeaderParameter = {};
|
|
7991
7809
|
const localVarQueryParameter = {};
|
|
7992
7810
|
// authentication BasicAuth required
|
|
@@ -7995,9 +7813,6 @@ export const VirtualRobotBehaviorApiAxiosParamCreator = function (configuration)
|
|
|
7995
7813
|
// authentication BearerAuth required
|
|
7996
7814
|
// http bearer authentication required
|
|
7997
7815
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
7998
|
-
if (behavior !== undefined) {
|
|
7999
|
-
localVarQueryParameter['behavior'] = behavior;
|
|
8000
|
-
}
|
|
8001
7816
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
8002
7817
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
8003
7818
|
localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
|
|
@@ -8006,179 +7821,26 @@ export const VirtualRobotBehaviorApiAxiosParamCreator = function (configuration)
|
|
|
8006
7821
|
options: localVarRequestOptions,
|
|
8007
7822
|
};
|
|
8008
7823
|
},
|
|
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
7824
|
/**
|
|
8086
|
-
*
|
|
8087
|
-
* @summary
|
|
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
|
|
7825
|
+
* Lists TCPs of the motion group. An empty TCP list is valid, for example for external axes.
|
|
7826
|
+
* @summary List TCPs
|
|
8100
7827
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8101
7828
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
8102
7829
|
* @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
|
|
8169
|
-
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8170
|
-
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
8171
7830
|
* @param {*} [options] Override http request option.
|
|
8172
7831
|
* @throws {RequiredError}
|
|
8173
7832
|
*/
|
|
8174
|
-
|
|
7833
|
+
listVirtualRobotTcps: async (cell, controller, motionGroup, options = {}) => {
|
|
8175
7834
|
// verify required parameter 'cell' is not null or undefined
|
|
8176
|
-
assertParamExists('
|
|
7835
|
+
assertParamExists('listVirtualRobotTcps', 'cell', cell);
|
|
8177
7836
|
// verify required parameter 'controller' is not null or undefined
|
|
8178
|
-
assertParamExists('
|
|
8179
|
-
|
|
7837
|
+
assertParamExists('listVirtualRobotTcps', 'controller', controller);
|
|
7838
|
+
// verify required parameter 'motionGroup' is not null or undefined
|
|
7839
|
+
assertParamExists('listVirtualRobotTcps', 'motionGroup', motionGroup);
|
|
7840
|
+
const localVarPath = `/cells/{cell}/virtual-controllers/{controller}/motion-groups/{motion-group}/tcps`
|
|
8180
7841
|
.replace(`{${"cell"}}`, encodeURIComponent(String(cell)))
|
|
8181
|
-
.replace(`{${"controller"}}`, encodeURIComponent(String(controller)))
|
|
7842
|
+
.replace(`{${"controller"}}`, encodeURIComponent(String(controller)))
|
|
7843
|
+
.replace(`{${"motion-group"}}`, encodeURIComponent(String(motionGroup)));
|
|
8182
7844
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
8183
7845
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
8184
7846
|
let baseOptions;
|
|
@@ -8203,19 +7865,20 @@ export const VirtualRobotModeApiAxiosParamCreator = function (configuration) {
|
|
|
8203
7865
|
};
|
|
8204
7866
|
},
|
|
8205
7867
|
/**
|
|
8206
|
-
*
|
|
8207
|
-
* @summary
|
|
7868
|
+
* 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.
|
|
7869
|
+
* @summary Push or Release Emergency Stop
|
|
8208
7870
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8209
7871
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
7872
|
+
* @param {boolean} [active]
|
|
8210
7873
|
* @param {*} [options] Override http request option.
|
|
8211
7874
|
* @throws {RequiredError}
|
|
8212
7875
|
*/
|
|
8213
|
-
|
|
7876
|
+
setEmergencyStop: async (cell, controller, active, options = {}) => {
|
|
8214
7877
|
// verify required parameter 'cell' is not null or undefined
|
|
8215
|
-
assertParamExists('
|
|
7878
|
+
assertParamExists('setEmergencyStop', 'cell', cell);
|
|
8216
7879
|
// verify required parameter 'controller' is not null or undefined
|
|
8217
|
-
assertParamExists('
|
|
8218
|
-
const localVarPath = `/cells/{cell}/controllers/{controller}/
|
|
7880
|
+
assertParamExists('setEmergencyStop', 'controller', controller);
|
|
7881
|
+
const localVarPath = `/cells/{cell}/virtual-controllers/{controller}/emergency-stop`
|
|
8219
7882
|
.replace(`{${"cell"}}`, encodeURIComponent(String(cell)))
|
|
8220
7883
|
.replace(`{${"controller"}}`, encodeURIComponent(String(controller)));
|
|
8221
7884
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
@@ -8224,7 +7887,7 @@ export const VirtualRobotModeApiAxiosParamCreator = function (configuration) {
|
|
|
8224
7887
|
if (configuration) {
|
|
8225
7888
|
baseOptions = configuration.baseOptions;
|
|
8226
7889
|
}
|
|
8227
|
-
const localVarRequestOptions = { method: '
|
|
7890
|
+
const localVarRequestOptions = { method: 'PUT', ...baseOptions, ...options };
|
|
8228
7891
|
const localVarHeaderParameter = {};
|
|
8229
7892
|
const localVarQueryParameter = {};
|
|
8230
7893
|
// authentication BasicAuth required
|
|
@@ -8233,6 +7896,9 @@ export const VirtualRobotModeApiAxiosParamCreator = function (configuration) {
|
|
|
8233
7896
|
// authentication BearerAuth required
|
|
8234
7897
|
// http bearer authentication required
|
|
8235
7898
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
7899
|
+
if (active !== undefined) {
|
|
7900
|
+
localVarQueryParameter['active'] = active;
|
|
7901
|
+
}
|
|
8236
7902
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
8237
7903
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
8238
7904
|
localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
|
|
@@ -8242,28 +7908,35 @@ export const VirtualRobotModeApiAxiosParamCreator = function (configuration) {
|
|
|
8242
7908
|
};
|
|
8243
7909
|
},
|
|
8244
7910
|
/**
|
|
8245
|
-
*
|
|
8246
|
-
* @summary
|
|
7911
|
+
* 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.
|
|
7912
|
+
* @summary Set Motion Group State
|
|
8247
7913
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8248
7914
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
7915
|
+
* @param {string} motionGroup The motion-group identifier.
|
|
7916
|
+
* @param {MotionGroupJoints} motionGroupJoints
|
|
8249
7917
|
* @param {*} [options] Override http request option.
|
|
8250
7918
|
* @throws {RequiredError}
|
|
8251
7919
|
*/
|
|
8252
|
-
|
|
7920
|
+
setMotionGroupState: async (cell, controller, motionGroup, motionGroupJoints, options = {}) => {
|
|
8253
7921
|
// verify required parameter 'cell' is not null or undefined
|
|
8254
|
-
assertParamExists('
|
|
7922
|
+
assertParamExists('setMotionGroupState', 'cell', cell);
|
|
8255
7923
|
// verify required parameter 'controller' is not null or undefined
|
|
8256
|
-
assertParamExists('
|
|
8257
|
-
|
|
7924
|
+
assertParamExists('setMotionGroupState', 'controller', controller);
|
|
7925
|
+
// verify required parameter 'motionGroup' is not null or undefined
|
|
7926
|
+
assertParamExists('setMotionGroupState', 'motionGroup', motionGroup);
|
|
7927
|
+
// verify required parameter 'motionGroupJoints' is not null or undefined
|
|
7928
|
+
assertParamExists('setMotionGroupState', 'motionGroupJoints', motionGroupJoints);
|
|
7929
|
+
const localVarPath = `/cells/{cell}/virtual-controllers/{controller}/motion-groups/{motion-group}/state`
|
|
8258
7930
|
.replace(`{${"cell"}}`, encodeURIComponent(String(cell)))
|
|
8259
|
-
.replace(`{${"controller"}}`, encodeURIComponent(String(controller)))
|
|
7931
|
+
.replace(`{${"controller"}}`, encodeURIComponent(String(controller)))
|
|
7932
|
+
.replace(`{${"motion-group"}}`, encodeURIComponent(String(motionGroup)));
|
|
8260
7933
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
8261
7934
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
8262
7935
|
let baseOptions;
|
|
8263
7936
|
if (configuration) {
|
|
8264
7937
|
baseOptions = configuration.baseOptions;
|
|
8265
7938
|
}
|
|
8266
|
-
const localVarRequestOptions = { method: '
|
|
7939
|
+
const localVarRequestOptions = { method: 'PUT', ...baseOptions, ...options };
|
|
8267
7940
|
const localVarHeaderParameter = {};
|
|
8268
7941
|
const localVarQueryParameter = {};
|
|
8269
7942
|
// authentication BasicAuth required
|
|
@@ -8272,29 +7945,33 @@ export const VirtualRobotModeApiAxiosParamCreator = function (configuration) {
|
|
|
8272
7945
|
// authentication BearerAuth required
|
|
8273
7946
|
// http bearer authentication required
|
|
8274
7947
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
7948
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
8275
7949
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
8276
7950
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
8277
7951
|
localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
|
|
7952
|
+
localVarRequestOptions.data = serializeDataIfNeeded(motionGroupJoints, localVarRequestOptions, configuration);
|
|
8278
7953
|
return {
|
|
8279
7954
|
url: toPathString(localVarUrlObj),
|
|
8280
7955
|
options: localVarRequestOptions,
|
|
8281
7956
|
};
|
|
8282
7957
|
},
|
|
8283
7958
|
/**
|
|
8284
|
-
*
|
|
8285
|
-
* @summary
|
|
7959
|
+
* 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.
|
|
7960
|
+
* @summary Set Operation Mode
|
|
8286
7961
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8287
7962
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
8288
|
-
* @param {
|
|
7963
|
+
* @param {OperationMode} mode
|
|
8289
7964
|
* @param {*} [options] Override http request option.
|
|
8290
7965
|
* @throws {RequiredError}
|
|
8291
7966
|
*/
|
|
8292
|
-
|
|
7967
|
+
setOperationMode: async (cell, controller, mode, options = {}) => {
|
|
8293
7968
|
// verify required parameter 'cell' is not null or undefined
|
|
8294
|
-
assertParamExists('
|
|
7969
|
+
assertParamExists('setOperationMode', 'cell', cell);
|
|
8295
7970
|
// verify required parameter 'controller' is not null or undefined
|
|
8296
|
-
assertParamExists('
|
|
8297
|
-
|
|
7971
|
+
assertParamExists('setOperationMode', 'controller', controller);
|
|
7972
|
+
// verify required parameter 'mode' is not null or undefined
|
|
7973
|
+
assertParamExists('setOperationMode', 'mode', mode);
|
|
7974
|
+
const localVarPath = `/cells/{cell}/virtual-controllers/{controller}/operationmode`
|
|
8298
7975
|
.replace(`{${"cell"}}`, encodeURIComponent(String(cell)))
|
|
8299
7976
|
.replace(`{${"controller"}}`, encodeURIComponent(String(controller)));
|
|
8300
7977
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
@@ -8312,8 +7989,8 @@ export const VirtualRobotModeApiAxiosParamCreator = function (configuration) {
|
|
|
8312
7989
|
// authentication BearerAuth required
|
|
8313
7990
|
// http bearer authentication required
|
|
8314
7991
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
8315
|
-
if (
|
|
8316
|
-
localVarQueryParameter['
|
|
7992
|
+
if (mode !== undefined) {
|
|
7993
|
+
localVarQueryParameter['mode'] = mode;
|
|
8317
7994
|
}
|
|
8318
7995
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
8319
7996
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
@@ -8324,24 +8001,28 @@ export const VirtualRobotModeApiAxiosParamCreator = function (configuration) {
|
|
|
8324
8001
|
};
|
|
8325
8002
|
},
|
|
8326
8003
|
/**
|
|
8327
|
-
*
|
|
8328
|
-
* @summary Set
|
|
8004
|
+
* 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.
|
|
8005
|
+
* @summary Set Mounting
|
|
8329
8006
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8330
8007
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
8331
|
-
* @param {
|
|
8008
|
+
* @param {string} motionGroup The motion-group identifier.
|
|
8009
|
+
* @param {CoordinateSystem} coordinateSystem
|
|
8332
8010
|
* @param {*} [options] Override http request option.
|
|
8333
8011
|
* @throws {RequiredError}
|
|
8334
8012
|
*/
|
|
8335
|
-
|
|
8013
|
+
setVirtualRobotMounting: async (cell, controller, motionGroup, coordinateSystem, options = {}) => {
|
|
8336
8014
|
// verify required parameter 'cell' is not null or undefined
|
|
8337
|
-
assertParamExists('
|
|
8015
|
+
assertParamExists('setVirtualRobotMounting', 'cell', cell);
|
|
8338
8016
|
// verify required parameter 'controller' is not null or undefined
|
|
8339
|
-
assertParamExists('
|
|
8340
|
-
// verify required parameter '
|
|
8341
|
-
assertParamExists('
|
|
8342
|
-
|
|
8017
|
+
assertParamExists('setVirtualRobotMounting', 'controller', controller);
|
|
8018
|
+
// verify required parameter 'motionGroup' is not null or undefined
|
|
8019
|
+
assertParamExists('setVirtualRobotMounting', 'motionGroup', motionGroup);
|
|
8020
|
+
// verify required parameter 'coordinateSystem' is not null or undefined
|
|
8021
|
+
assertParamExists('setVirtualRobotMounting', 'coordinateSystem', coordinateSystem);
|
|
8022
|
+
const localVarPath = `/cells/{cell}/virtual-controllers/{controller}/motion-groups/{motion-group}/mounting`
|
|
8343
8023
|
.replace(`{${"cell"}}`, encodeURIComponent(String(cell)))
|
|
8344
|
-
.replace(`{${"controller"}}`, encodeURIComponent(String(controller)))
|
|
8024
|
+
.replace(`{${"controller"}}`, encodeURIComponent(String(controller)))
|
|
8025
|
+
.replace(`{${"motion-group"}}`, encodeURIComponent(String(motionGroup)));
|
|
8345
8026
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
8346
8027
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
8347
8028
|
let baseOptions;
|
|
@@ -8357,12 +8038,11 @@ export const VirtualRobotModeApiAxiosParamCreator = function (configuration) {
|
|
|
8357
8038
|
// authentication BearerAuth required
|
|
8358
8039
|
// http bearer authentication required
|
|
8359
8040
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
8360
|
-
|
|
8361
|
-
localVarQueryParameter['mode'] = mode;
|
|
8362
|
-
}
|
|
8041
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
8363
8042
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
8364
8043
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
8365
8044
|
localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
|
|
8045
|
+
localVarRequestOptions.data = serializeDataIfNeeded(coordinateSystem, localVarRequestOptions, configuration);
|
|
8366
8046
|
return {
|
|
8367
8047
|
url: toPathString(localVarUrlObj),
|
|
8368
8048
|
options: localVarRequestOptions,
|
|
@@ -8371,114 +8051,119 @@ export const VirtualRobotModeApiAxiosParamCreator = function (configuration) {
|
|
|
8371
8051
|
};
|
|
8372
8052
|
};
|
|
8373
8053
|
/**
|
|
8374
|
-
*
|
|
8054
|
+
* VirtualControllerApi - functional programming interface
|
|
8375
8055
|
* @export
|
|
8376
8056
|
*/
|
|
8377
|
-
export const
|
|
8378
|
-
const localVarAxiosParamCreator =
|
|
8057
|
+
export const VirtualControllerApiFp = function (configuration) {
|
|
8058
|
+
const localVarAxiosParamCreator = VirtualControllerApiAxiosParamCreator(configuration);
|
|
8379
8059
|
return {
|
|
8380
8060
|
/**
|
|
8381
|
-
*
|
|
8382
|
-
* @summary
|
|
8061
|
+
* Adds a coordinate system to the robot controller.
|
|
8062
|
+
* @summary Add Coordinate Systems
|
|
8383
8063
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8384
8064
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
8065
|
+
* @param {string} coordinateSystem Unique identifier addressing a coordinate system.
|
|
8066
|
+
* @param {CoordinateSystemData} coordinateSystemData
|
|
8385
8067
|
* @param {*} [options] Override http request option.
|
|
8386
8068
|
* @throws {RequiredError}
|
|
8387
8069
|
*/
|
|
8388
|
-
async
|
|
8389
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.
|
|
8070
|
+
async addVirtualRobotCoordinateSystem(cell, controller, coordinateSystem, coordinateSystemData, options) {
|
|
8071
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.addVirtualRobotCoordinateSystem(cell, controller, coordinateSystem, coordinateSystemData, options);
|
|
8390
8072
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
8391
|
-
const localVarOperationServerBasePath = operationServerMap['
|
|
8073
|
+
const localVarOperationServerBasePath = operationServerMap['VirtualControllerApi.addVirtualRobotCoordinateSystem']?.[localVarOperationServerIndex]?.url;
|
|
8392
8074
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
8393
8075
|
},
|
|
8394
8076
|
/**
|
|
8395
|
-
*
|
|
8396
|
-
* @summary
|
|
8077
|
+
* 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.
|
|
8078
|
+
* @summary Add TCP
|
|
8397
8079
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8398
8080
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
8081
|
+
* @param {string} motionGroup The motion-group identifier.
|
|
8082
|
+
* @param {string} tcp The unique identifier of a TCP.
|
|
8083
|
+
* @param {RobotTcpData} robotTcpData
|
|
8399
8084
|
* @param {*} [options] Override http request option.
|
|
8400
8085
|
* @throws {RequiredError}
|
|
8401
8086
|
*/
|
|
8402
|
-
async
|
|
8403
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.
|
|
8087
|
+
async addVirtualRobotTcp(cell, controller, motionGroup, tcp, robotTcpData, options) {
|
|
8088
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.addVirtualRobotTcp(cell, controller, motionGroup, tcp, robotTcpData, options);
|
|
8404
8089
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
8405
|
-
const localVarOperationServerBasePath = operationServerMap['
|
|
8090
|
+
const localVarOperationServerBasePath = operationServerMap['VirtualControllerApi.addVirtualRobotTcp']?.[localVarOperationServerIndex]?.url;
|
|
8406
8091
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
8407
8092
|
},
|
|
8408
8093
|
/**
|
|
8409
|
-
*
|
|
8410
|
-
* @summary
|
|
8094
|
+
* 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.
|
|
8095
|
+
* @summary Remove Coordinate System
|
|
8411
8096
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8412
8097
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
8098
|
+
* @param {string} coordinateSystem Unique identifier addressing a coordinate system.
|
|
8099
|
+
* @param {boolean} [deleteDependent] If true, all dependent coordinate systems will be deleted as well.
|
|
8413
8100
|
* @param {*} [options] Override http request option.
|
|
8414
8101
|
* @throws {RequiredError}
|
|
8415
8102
|
*/
|
|
8416
|
-
async
|
|
8417
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.
|
|
8103
|
+
async deleteVirtualRobotCoordinateSystem(cell, controller, coordinateSystem, deleteDependent, options) {
|
|
8104
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.deleteVirtualRobotCoordinateSystem(cell, controller, coordinateSystem, deleteDependent, options);
|
|
8418
8105
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
8419
|
-
const localVarOperationServerBasePath = operationServerMap['
|
|
8106
|
+
const localVarOperationServerBasePath = operationServerMap['VirtualControllerApi.deleteVirtualRobotCoordinateSystem']?.[localVarOperationServerIndex]?.url;
|
|
8420
8107
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
8421
8108
|
},
|
|
8422
8109
|
/**
|
|
8423
|
-
*
|
|
8424
|
-
* @summary
|
|
8110
|
+
* Removes the TCP from the motion group. An unknown TCP is a valid input.
|
|
8111
|
+
* @summary Remove TCP
|
|
8425
8112
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8426
8113
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
8427
|
-
* @param {
|
|
8114
|
+
* @param {string} motionGroup The motion-group identifier.
|
|
8115
|
+
* @param {string} tcp The unique identifier of a TCP.
|
|
8428
8116
|
* @param {*} [options] Override http request option.
|
|
8429
8117
|
* @throws {RequiredError}
|
|
8430
8118
|
*/
|
|
8431
|
-
async
|
|
8432
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.
|
|
8119
|
+
async deleteVirtualRobotTcp(cell, controller, motionGroup, tcp, options) {
|
|
8120
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.deleteVirtualRobotTcp(cell, controller, motionGroup, tcp, options);
|
|
8433
8121
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
8434
|
-
const localVarOperationServerBasePath = operationServerMap['
|
|
8122
|
+
const localVarOperationServerBasePath = operationServerMap['VirtualControllerApi.deleteVirtualRobotTcp']?.[localVarOperationServerIndex]?.url;
|
|
8435
8123
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
8436
8124
|
},
|
|
8437
8125
|
/**
|
|
8438
|
-
*
|
|
8439
|
-
* @summary
|
|
8126
|
+
* 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.
|
|
8127
|
+
* @summary Get Emergency Stop State
|
|
8440
8128
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8441
8129
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
8442
|
-
* @param {OperationMode} mode
|
|
8443
8130
|
* @param {*} [options] Override http request option.
|
|
8444
8131
|
* @throws {RequiredError}
|
|
8445
8132
|
*/
|
|
8446
|
-
async
|
|
8447
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.
|
|
8133
|
+
async getEmergencyStop(cell, controller, options) {
|
|
8134
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.getEmergencyStop(cell, controller, options);
|
|
8448
8135
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
8449
|
-
const localVarOperationServerBasePath = operationServerMap['
|
|
8136
|
+
const localVarOperationServerBasePath = operationServerMap['VirtualControllerApi.getEmergencyStop']?.[localVarOperationServerIndex]?.url;
|
|
8450
8137
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
8451
8138
|
},
|
|
8452
|
-
};
|
|
8453
|
-
};
|
|
8454
|
-
/**
|
|
8455
|
-
* VirtualRobotModeApi - factory interface
|
|
8456
|
-
* @export
|
|
8457
|
-
*/
|
|
8458
|
-
export const VirtualRobotModeApiFactory = function (configuration, basePath, axios) {
|
|
8459
|
-
const localVarFp = VirtualRobotModeApiFp(configuration);
|
|
8460
|
-
return {
|
|
8461
8139
|
/**
|
|
8462
|
-
* Get the
|
|
8463
|
-
* @summary
|
|
8140
|
+
* Get the current motion group state which provides values for the joints\' position, velocity and acceleration.
|
|
8141
|
+
* @summary Get Motion Group State
|
|
8464
8142
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8465
8143
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
8144
|
+
* @param {string} motionGroup The motion-group identifier.
|
|
8466
8145
|
* @param {*} [options] Override http request option.
|
|
8467
8146
|
* @throws {RequiredError}
|
|
8468
8147
|
*/
|
|
8469
|
-
|
|
8470
|
-
|
|
8471
|
-
|
|
8472
|
-
|
|
8473
|
-
|
|
8474
|
-
|
|
8148
|
+
async getMotionGroupState(cell, controller, motionGroup, options) {
|
|
8149
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.getMotionGroupState(cell, controller, motionGroup, options);
|
|
8150
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
8151
|
+
const localVarOperationServerBasePath = operationServerMap['VirtualControllerApi.getMotionGroupState']?.[localVarOperationServerIndex]?.url;
|
|
8152
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
8153
|
+
},
|
|
8154
|
+
/**
|
|
8155
|
+
* Gets information on the motion group.
|
|
8156
|
+
* @summary Motion Group Description
|
|
8475
8157
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8476
8158
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
8477
8159
|
* @param {*} [options] Override http request option.
|
|
8478
8160
|
* @throws {RequiredError}
|
|
8479
8161
|
*/
|
|
8480
|
-
|
|
8481
|
-
|
|
8162
|
+
async getMotionGroups(cell, controller, options) {
|
|
8163
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.getMotionGroups(cell, controller, options);
|
|
8164
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
8165
|
+
const localVarOperationServerBasePath = operationServerMap['VirtualControllerApi.getMotionGroups']?.[localVarOperationServerIndex]?.url;
|
|
8166
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
8482
8167
|
},
|
|
8483
8168
|
/**
|
|
8484
8169
|
* 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.
|
|
@@ -8488,8 +8173,55 @@ export const VirtualRobotModeApiFactory = function (configuration, basePath, axi
|
|
|
8488
8173
|
* @param {*} [options] Override http request option.
|
|
8489
8174
|
* @throws {RequiredError}
|
|
8490
8175
|
*/
|
|
8491
|
-
getOperationMode(cell, controller, options) {
|
|
8492
|
-
|
|
8176
|
+
async getOperationMode(cell, controller, options) {
|
|
8177
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.getOperationMode(cell, controller, options);
|
|
8178
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
8179
|
+
const localVarOperationServerBasePath = operationServerMap['VirtualControllerApi.getOperationMode']?.[localVarOperationServerIndex]?.url;
|
|
8180
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
8181
|
+
},
|
|
8182
|
+
/**
|
|
8183
|
+
* Gets motion group mounting. The motion group is based on the origin of the returned coordinate system.
|
|
8184
|
+
* @summary Get Mounting
|
|
8185
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8186
|
+
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
8187
|
+
* @param {string} motionGroup The motion-group identifier.
|
|
8188
|
+
* @param {*} [options] Override http request option.
|
|
8189
|
+
* @throws {RequiredError}
|
|
8190
|
+
*/
|
|
8191
|
+
async getVirtualRobotMounting(cell, controller, motionGroup, options) {
|
|
8192
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.getVirtualRobotMounting(cell, controller, motionGroup, options);
|
|
8193
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
8194
|
+
const localVarOperationServerBasePath = operationServerMap['VirtualControllerApi.getVirtualRobotMounting']?.[localVarOperationServerIndex]?.url;
|
|
8195
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
8196
|
+
},
|
|
8197
|
+
/**
|
|
8198
|
+
* Lists all coordinate systems on the robot controller.
|
|
8199
|
+
* @summary List Coordinate Systems
|
|
8200
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8201
|
+
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
8202
|
+
* @param {*} [options] Override http request option.
|
|
8203
|
+
* @throws {RequiredError}
|
|
8204
|
+
*/
|
|
8205
|
+
async listVirtualRobotCoordinateSystems(cell, controller, options) {
|
|
8206
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.listVirtualRobotCoordinateSystems(cell, controller, options);
|
|
8207
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
8208
|
+
const localVarOperationServerBasePath = operationServerMap['VirtualControllerApi.listVirtualRobotCoordinateSystems']?.[localVarOperationServerIndex]?.url;
|
|
8209
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
8210
|
+
},
|
|
8211
|
+
/**
|
|
8212
|
+
* Lists TCPs of the motion group. An empty TCP list is valid, for example for external axes.
|
|
8213
|
+
* @summary List TCPs
|
|
8214
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8215
|
+
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
8216
|
+
* @param {string} motionGroup The motion-group identifier.
|
|
8217
|
+
* @param {*} [options] Override http request option.
|
|
8218
|
+
* @throws {RequiredError}
|
|
8219
|
+
*/
|
|
8220
|
+
async listVirtualRobotTcps(cell, controller, motionGroup, options) {
|
|
8221
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.listVirtualRobotTcps(cell, controller, motionGroup, options);
|
|
8222
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
8223
|
+
const localVarOperationServerBasePath = operationServerMap['VirtualControllerApi.listVirtualRobotTcps']?.[localVarOperationServerIndex]?.url;
|
|
8224
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
8493
8225
|
},
|
|
8494
8226
|
/**
|
|
8495
8227
|
* 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.
|
|
@@ -8500,8 +8232,27 @@ export const VirtualRobotModeApiFactory = function (configuration, basePath, axi
|
|
|
8500
8232
|
* @param {*} [options] Override http request option.
|
|
8501
8233
|
* @throws {RequiredError}
|
|
8502
8234
|
*/
|
|
8503
|
-
setEmergencyStop(cell, controller, active, options) {
|
|
8504
|
-
|
|
8235
|
+
async setEmergencyStop(cell, controller, active, options) {
|
|
8236
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.setEmergencyStop(cell, controller, active, options);
|
|
8237
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
8238
|
+
const localVarOperationServerBasePath = operationServerMap['VirtualControllerApi.setEmergencyStop']?.[localVarOperationServerIndex]?.url;
|
|
8239
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
8240
|
+
},
|
|
8241
|
+
/**
|
|
8242
|
+
* 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.
|
|
8243
|
+
* @summary Set Motion Group State
|
|
8244
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8245
|
+
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
8246
|
+
* @param {string} motionGroup The motion-group identifier.
|
|
8247
|
+
* @param {MotionGroupJoints} motionGroupJoints
|
|
8248
|
+
* @param {*} [options] Override http request option.
|
|
8249
|
+
* @throws {RequiredError}
|
|
8250
|
+
*/
|
|
8251
|
+
async setMotionGroupState(cell, controller, motionGroup, motionGroupJoints, options) {
|
|
8252
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.setMotionGroupState(cell, controller, motionGroup, motionGroupJoints, options);
|
|
8253
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
8254
|
+
const localVarOperationServerBasePath = operationServerMap['VirtualControllerApi.setMotionGroupState']?.[localVarOperationServerIndex]?.url;
|
|
8255
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
8505
8256
|
},
|
|
8506
8257
|
/**
|
|
8507
8258
|
* 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.
|
|
@@ -8512,130 +8263,49 @@ export const VirtualRobotModeApiFactory = function (configuration, basePath, axi
|
|
|
8512
8263
|
* @param {*} [options] Override http request option.
|
|
8513
8264
|
* @throws {RequiredError}
|
|
8514
8265
|
*/
|
|
8515
|
-
setOperationMode(cell, controller, mode, options) {
|
|
8516
|
-
|
|
8266
|
+
async setOperationMode(cell, controller, mode, options) {
|
|
8267
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.setOperationMode(cell, controller, mode, options);
|
|
8268
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
8269
|
+
const localVarOperationServerBasePath = operationServerMap['VirtualControllerApi.setOperationMode']?.[localVarOperationServerIndex]?.url;
|
|
8270
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
8271
|
+
},
|
|
8272
|
+
/**
|
|
8273
|
+
* 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.
|
|
8274
|
+
* @summary Set Mounting
|
|
8275
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8276
|
+
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
8277
|
+
* @param {string} motionGroup The motion-group identifier.
|
|
8278
|
+
* @param {CoordinateSystem} coordinateSystem
|
|
8279
|
+
* @param {*} [options] Override http request option.
|
|
8280
|
+
* @throws {RequiredError}
|
|
8281
|
+
*/
|
|
8282
|
+
async setVirtualRobotMounting(cell, controller, motionGroup, coordinateSystem, options) {
|
|
8283
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.setVirtualRobotMounting(cell, controller, motionGroup, coordinateSystem, options);
|
|
8284
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
8285
|
+
const localVarOperationServerBasePath = operationServerMap['VirtualControllerApi.setVirtualRobotMounting']?.[localVarOperationServerIndex]?.url;
|
|
8286
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
8517
8287
|
},
|
|
8518
8288
|
};
|
|
8519
8289
|
};
|
|
8520
8290
|
/**
|
|
8521
|
-
*
|
|
8522
|
-
* @export
|
|
8523
|
-
* @class VirtualRobotModeApi
|
|
8524
|
-
* @extends {BaseAPI}
|
|
8525
|
-
*/
|
|
8526
|
-
export class VirtualRobotModeApi extends BaseAPI {
|
|
8527
|
-
/**
|
|
8528
|
-
* Get the cycle time of controller communication in [ms].
|
|
8529
|
-
* @summary Cycle Time
|
|
8530
|
-
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8531
|
-
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
8532
|
-
* @param {*} [options] Override http request option.
|
|
8533
|
-
* @throws {RequiredError}
|
|
8534
|
-
* @memberof VirtualRobotModeApi
|
|
8535
|
-
*/
|
|
8536
|
-
getCycleTime(cell, controller, options) {
|
|
8537
|
-
return VirtualRobotModeApiFp(this.configuration).getCycleTime(cell, controller, options).then((request) => request(this.axios, this.basePath));
|
|
8538
|
-
}
|
|
8539
|
-
/**
|
|
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.
|
|
8541
|
-
* @summary Get Emergency Stop State
|
|
8542
|
-
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8543
|
-
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
8544
|
-
* @param {*} [options] Override http request option.
|
|
8545
|
-
* @throws {RequiredError}
|
|
8546
|
-
* @memberof VirtualRobotModeApi
|
|
8547
|
-
*/
|
|
8548
|
-
getEmergencyStop(cell, controller, options) {
|
|
8549
|
-
return VirtualRobotModeApiFp(this.configuration).getEmergencyStop(cell, controller, options).then((request) => request(this.axios, this.basePath));
|
|
8550
|
-
}
|
|
8551
|
-
/**
|
|
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.
|
|
8553
|
-
* @summary Get Operation Mode
|
|
8554
|
-
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8555
|
-
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
8556
|
-
* @param {*} [options] Override http request option.
|
|
8557
|
-
* @throws {RequiredError}
|
|
8558
|
-
* @memberof VirtualRobotModeApi
|
|
8559
|
-
*/
|
|
8560
|
-
getOperationMode(cell, controller, options) {
|
|
8561
|
-
return VirtualRobotModeApiFp(this.configuration).getOperationMode(cell, controller, options).then((request) => request(this.axios, this.basePath));
|
|
8562
|
-
}
|
|
8563
|
-
/**
|
|
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.
|
|
8565
|
-
* @summary Push or Release Emergency Stop
|
|
8566
|
-
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8567
|
-
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
8568
|
-
* @param {boolean} [active]
|
|
8569
|
-
* @param {*} [options] Override http request option.
|
|
8570
|
-
* @throws {RequiredError}
|
|
8571
|
-
* @memberof VirtualRobotModeApi
|
|
8572
|
-
*/
|
|
8573
|
-
setEmergencyStop(cell, controller, active, options) {
|
|
8574
|
-
return VirtualRobotModeApiFp(this.configuration).setEmergencyStop(cell, controller, active, options).then((request) => request(this.axios, this.basePath));
|
|
8575
|
-
}
|
|
8576
|
-
/**
|
|
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
|
|
8579
|
-
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8580
|
-
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
8581
|
-
* @param {OperationMode} mode
|
|
8582
|
-
* @param {*} [options] Override http request option.
|
|
8583
|
-
* @throws {RequiredError}
|
|
8584
|
-
* @memberof VirtualRobotModeApi
|
|
8585
|
-
*/
|
|
8586
|
-
setOperationMode(cell, controller, mode, options) {
|
|
8587
|
-
return VirtualRobotModeApiFp(this.configuration).setOperationMode(cell, controller, mode, options).then((request) => request(this.axios, this.basePath));
|
|
8588
|
-
}
|
|
8589
|
-
}
|
|
8590
|
-
/**
|
|
8591
|
-
* VirtualRobotSetupApi - axios parameter creator
|
|
8291
|
+
* VirtualControllerApi - factory interface
|
|
8592
8292
|
* @export
|
|
8593
8293
|
*/
|
|
8594
|
-
export const
|
|
8294
|
+
export const VirtualControllerApiFactory = function (configuration, basePath, axios) {
|
|
8295
|
+
const localVarFp = VirtualControllerApiFp(configuration);
|
|
8595
8296
|
return {
|
|
8596
8297
|
/**
|
|
8597
8298
|
* Adds a coordinate system to the robot controller.
|
|
8598
8299
|
* @summary Add Coordinate Systems
|
|
8599
8300
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8600
8301
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
8601
|
-
* @param {
|
|
8302
|
+
* @param {string} coordinateSystem Unique identifier addressing a coordinate system.
|
|
8303
|
+
* @param {CoordinateSystemData} coordinateSystemData
|
|
8602
8304
|
* @param {*} [options] Override http request option.
|
|
8603
8305
|
* @throws {RequiredError}
|
|
8604
8306
|
*/
|
|
8605
|
-
addVirtualRobotCoordinateSystem
|
|
8606
|
-
|
|
8607
|
-
assertParamExists('addVirtualRobotCoordinateSystem', 'cell', cell);
|
|
8608
|
-
// verify required parameter 'controller' is not null or undefined
|
|
8609
|
-
assertParamExists('addVirtualRobotCoordinateSystem', 'controller', controller);
|
|
8610
|
-
// verify required parameter 'coordinateSystem' is not null or undefined
|
|
8611
|
-
assertParamExists('addVirtualRobotCoordinateSystem', 'coordinateSystem', coordinateSystem);
|
|
8612
|
-
const localVarPath = `/cells/{cell}/controllers/{controller}/teach-pendant/coordinate-systems`
|
|
8613
|
-
.replace(`{${"cell"}}`, encodeURIComponent(String(cell)))
|
|
8614
|
-
.replace(`{${"controller"}}`, encodeURIComponent(String(controller)));
|
|
8615
|
-
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
8616
|
-
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
8617
|
-
let baseOptions;
|
|
8618
|
-
if (configuration) {
|
|
8619
|
-
baseOptions = configuration.baseOptions;
|
|
8620
|
-
}
|
|
8621
|
-
const localVarRequestOptions = { method: 'PUT', ...baseOptions, ...options };
|
|
8622
|
-
const localVarHeaderParameter = {};
|
|
8623
|
-
const localVarQueryParameter = {};
|
|
8624
|
-
// authentication BasicAuth required
|
|
8625
|
-
// http basic authentication required
|
|
8626
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
8627
|
-
// authentication BearerAuth required
|
|
8628
|
-
// http bearer authentication required
|
|
8629
|
-
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
8630
|
-
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
8631
|
-
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
8632
|
-
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
8633
|
-
localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
|
|
8634
|
-
localVarRequestOptions.data = serializeDataIfNeeded(coordinateSystem, localVarRequestOptions, configuration);
|
|
8635
|
-
return {
|
|
8636
|
-
url: toPathString(localVarUrlObj),
|
|
8637
|
-
options: localVarRequestOptions,
|
|
8638
|
-
};
|
|
8307
|
+
addVirtualRobotCoordinateSystem(cell, controller, coordinateSystem, coordinateSystemData, options) {
|
|
8308
|
+
return localVarFp.addVirtualRobotCoordinateSystem(cell, controller, coordinateSystem, coordinateSystemData, options).then((request) => request(axios, basePath));
|
|
8639
8309
|
},
|
|
8640
8310
|
/**
|
|
8641
8311
|
* 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.
|
|
@@ -8643,47 +8313,13 @@ export const VirtualRobotSetupApiAxiosParamCreator = function (configuration) {
|
|
|
8643
8313
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8644
8314
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
8645
8315
|
* @param {string} motionGroup The motion-group identifier.
|
|
8646
|
-
* @param {
|
|
8316
|
+
* @param {string} tcp The unique identifier of a TCP.
|
|
8317
|
+
* @param {RobotTcpData} robotTcpData
|
|
8647
8318
|
* @param {*} [options] Override http request option.
|
|
8648
8319
|
* @throws {RequiredError}
|
|
8649
8320
|
*/
|
|
8650
|
-
addVirtualRobotTcp
|
|
8651
|
-
|
|
8652
|
-
assertParamExists('addVirtualRobotTcp', 'cell', cell);
|
|
8653
|
-
// verify required parameter 'controller' is not null or undefined
|
|
8654
|
-
assertParamExists('addVirtualRobotTcp', 'controller', controller);
|
|
8655
|
-
// verify required parameter 'motionGroup' is not null or undefined
|
|
8656
|
-
assertParamExists('addVirtualRobotTcp', 'motionGroup', motionGroup);
|
|
8657
|
-
// verify required parameter 'robotTcp' is not null or undefined
|
|
8658
|
-
assertParamExists('addVirtualRobotTcp', 'robotTcp', robotTcp);
|
|
8659
|
-
const localVarPath = `/cells/{cell}/controllers/{controller}/teach-pendant/motion-groups/{motion-group}/tcps`
|
|
8660
|
-
.replace(`{${"cell"}}`, encodeURIComponent(String(cell)))
|
|
8661
|
-
.replace(`{${"controller"}}`, encodeURIComponent(String(controller)))
|
|
8662
|
-
.replace(`{${"motion-group"}}`, encodeURIComponent(String(motionGroup)));
|
|
8663
|
-
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
8664
|
-
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
8665
|
-
let baseOptions;
|
|
8666
|
-
if (configuration) {
|
|
8667
|
-
baseOptions = configuration.baseOptions;
|
|
8668
|
-
}
|
|
8669
|
-
const localVarRequestOptions = { method: 'PUT', ...baseOptions, ...options };
|
|
8670
|
-
const localVarHeaderParameter = {};
|
|
8671
|
-
const localVarQueryParameter = {};
|
|
8672
|
-
// authentication BasicAuth required
|
|
8673
|
-
// http basic authentication required
|
|
8674
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
8675
|
-
// authentication BearerAuth required
|
|
8676
|
-
// http bearer authentication required
|
|
8677
|
-
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
8678
|
-
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
8679
|
-
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
8680
|
-
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
8681
|
-
localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
|
|
8682
|
-
localVarRequestOptions.data = serializeDataIfNeeded(robotTcp, localVarRequestOptions, configuration);
|
|
8683
|
-
return {
|
|
8684
|
-
url: toPathString(localVarUrlObj),
|
|
8685
|
-
options: localVarRequestOptions,
|
|
8686
|
-
};
|
|
8321
|
+
addVirtualRobotTcp(cell, controller, motionGroup, tcp, robotTcpData, options) {
|
|
8322
|
+
return localVarFp.addVirtualRobotTcp(cell, controller, motionGroup, tcp, robotTcpData, options).then((request) => request(axios, basePath));
|
|
8687
8323
|
},
|
|
8688
8324
|
/**
|
|
8689
8325
|
* 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.
|
|
@@ -8695,42 +8331,8 @@ export const VirtualRobotSetupApiAxiosParamCreator = function (configuration) {
|
|
|
8695
8331
|
* @param {*} [options] Override http request option.
|
|
8696
8332
|
* @throws {RequiredError}
|
|
8697
8333
|
*/
|
|
8698
|
-
deleteVirtualRobotCoordinateSystem
|
|
8699
|
-
|
|
8700
|
-
assertParamExists('deleteVirtualRobotCoordinateSystem', 'cell', cell);
|
|
8701
|
-
// verify required parameter 'controller' is not null or undefined
|
|
8702
|
-
assertParamExists('deleteVirtualRobotCoordinateSystem', 'controller', controller);
|
|
8703
|
-
// verify required parameter 'coordinateSystem' is not null or undefined
|
|
8704
|
-
assertParamExists('deleteVirtualRobotCoordinateSystem', 'coordinateSystem', coordinateSystem);
|
|
8705
|
-
const localVarPath = `/cells/{cell}/controllers/{controller}/teach-pendant/coordinate-systems/{coordinate-system}`
|
|
8706
|
-
.replace(`{${"cell"}}`, encodeURIComponent(String(cell)))
|
|
8707
|
-
.replace(`{${"controller"}}`, encodeURIComponent(String(controller)))
|
|
8708
|
-
.replace(`{${"coordinate-system"}}`, encodeURIComponent(String(coordinateSystem)));
|
|
8709
|
-
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
8710
|
-
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
8711
|
-
let baseOptions;
|
|
8712
|
-
if (configuration) {
|
|
8713
|
-
baseOptions = configuration.baseOptions;
|
|
8714
|
-
}
|
|
8715
|
-
const localVarRequestOptions = { method: 'DELETE', ...baseOptions, ...options };
|
|
8716
|
-
const localVarHeaderParameter = {};
|
|
8717
|
-
const localVarQueryParameter = {};
|
|
8718
|
-
// authentication BasicAuth required
|
|
8719
|
-
// http basic authentication required
|
|
8720
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
8721
|
-
// authentication BearerAuth required
|
|
8722
|
-
// http bearer authentication required
|
|
8723
|
-
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
8724
|
-
if (deleteDependent !== undefined) {
|
|
8725
|
-
localVarQueryParameter['delete_dependent'] = deleteDependent;
|
|
8726
|
-
}
|
|
8727
|
-
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
8728
|
-
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
8729
|
-
localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
|
|
8730
|
-
return {
|
|
8731
|
-
url: toPathString(localVarUrlObj),
|
|
8732
|
-
options: localVarRequestOptions,
|
|
8733
|
-
};
|
|
8334
|
+
deleteVirtualRobotCoordinateSystem(cell, controller, coordinateSystem, deleteDependent, options) {
|
|
8335
|
+
return localVarFp.deleteVirtualRobotCoordinateSystem(cell, controller, coordinateSystem, deleteDependent, options).then((request) => request(axios, basePath));
|
|
8734
8336
|
},
|
|
8735
8337
|
/**
|
|
8736
8338
|
* Removes the TCP from the motion group. An unknown TCP is a valid input.
|
|
@@ -8742,63 +8344,372 @@ export const VirtualRobotSetupApiAxiosParamCreator = function (configuration) {
|
|
|
8742
8344
|
* @param {*} [options] Override http request option.
|
|
8743
8345
|
* @throws {RequiredError}
|
|
8744
8346
|
*/
|
|
8745
|
-
deleteVirtualRobotTcp
|
|
8746
|
-
|
|
8747
|
-
|
|
8748
|
-
|
|
8749
|
-
|
|
8750
|
-
|
|
8751
|
-
|
|
8752
|
-
|
|
8753
|
-
|
|
8754
|
-
|
|
8755
|
-
|
|
8756
|
-
|
|
8757
|
-
|
|
8758
|
-
|
|
8759
|
-
|
|
8760
|
-
|
|
8761
|
-
|
|
8762
|
-
|
|
8763
|
-
|
|
8764
|
-
|
|
8765
|
-
|
|
8766
|
-
|
|
8767
|
-
|
|
8768
|
-
|
|
8769
|
-
|
|
8770
|
-
|
|
8771
|
-
|
|
8772
|
-
|
|
8773
|
-
|
|
8774
|
-
|
|
8775
|
-
|
|
8776
|
-
|
|
8777
|
-
|
|
8778
|
-
|
|
8779
|
-
|
|
8780
|
-
|
|
8347
|
+
deleteVirtualRobotTcp(cell, controller, motionGroup, tcp, options) {
|
|
8348
|
+
return localVarFp.deleteVirtualRobotTcp(cell, controller, motionGroup, tcp, options).then((request) => request(axios, basePath));
|
|
8349
|
+
},
|
|
8350
|
+
/**
|
|
8351
|
+
* 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.
|
|
8352
|
+
* @summary Get Emergency Stop State
|
|
8353
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8354
|
+
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
8355
|
+
* @param {*} [options] Override http request option.
|
|
8356
|
+
* @throws {RequiredError}
|
|
8357
|
+
*/
|
|
8358
|
+
getEmergencyStop(cell, controller, options) {
|
|
8359
|
+
return localVarFp.getEmergencyStop(cell, controller, options).then((request) => request(axios, basePath));
|
|
8360
|
+
},
|
|
8361
|
+
/**
|
|
8362
|
+
* Get the current motion group state which provides values for the joints\' position, velocity and acceleration.
|
|
8363
|
+
* @summary Get Motion Group State
|
|
8364
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8365
|
+
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
8366
|
+
* @param {string} motionGroup The motion-group identifier.
|
|
8367
|
+
* @param {*} [options] Override http request option.
|
|
8368
|
+
* @throws {RequiredError}
|
|
8369
|
+
*/
|
|
8370
|
+
getMotionGroupState(cell, controller, motionGroup, options) {
|
|
8371
|
+
return localVarFp.getMotionGroupState(cell, controller, motionGroup, options).then((request) => request(axios, basePath));
|
|
8372
|
+
},
|
|
8373
|
+
/**
|
|
8374
|
+
* Gets information on the motion group.
|
|
8375
|
+
* @summary Motion Group Description
|
|
8376
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8377
|
+
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
8378
|
+
* @param {*} [options] Override http request option.
|
|
8379
|
+
* @throws {RequiredError}
|
|
8380
|
+
*/
|
|
8381
|
+
getMotionGroups(cell, controller, options) {
|
|
8382
|
+
return localVarFp.getMotionGroups(cell, controller, options).then((request) => request(axios, basePath));
|
|
8383
|
+
},
|
|
8384
|
+
/**
|
|
8385
|
+
* 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.
|
|
8386
|
+
* @summary Get Operation Mode
|
|
8387
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8388
|
+
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
8389
|
+
* @param {*} [options] Override http request option.
|
|
8390
|
+
* @throws {RequiredError}
|
|
8391
|
+
*/
|
|
8392
|
+
getOperationMode(cell, controller, options) {
|
|
8393
|
+
return localVarFp.getOperationMode(cell, controller, options).then((request) => request(axios, basePath));
|
|
8781
8394
|
},
|
|
8782
8395
|
/**
|
|
8783
8396
|
* Gets motion group mounting. The motion group is based on the origin of the returned coordinate system.
|
|
8784
8397
|
* @summary Get Mounting
|
|
8785
8398
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8786
8399
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
8787
|
-
* @param {string} motionGroup The motion-group identifier.
|
|
8400
|
+
* @param {string} motionGroup The motion-group identifier.
|
|
8401
|
+
* @param {*} [options] Override http request option.
|
|
8402
|
+
* @throws {RequiredError}
|
|
8403
|
+
*/
|
|
8404
|
+
getVirtualRobotMounting(cell, controller, motionGroup, options) {
|
|
8405
|
+
return localVarFp.getVirtualRobotMounting(cell, controller, motionGroup, options).then((request) => request(axios, basePath));
|
|
8406
|
+
},
|
|
8407
|
+
/**
|
|
8408
|
+
* Lists all coordinate systems on the robot controller.
|
|
8409
|
+
* @summary List Coordinate Systems
|
|
8410
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8411
|
+
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
8412
|
+
* @param {*} [options] Override http request option.
|
|
8413
|
+
* @throws {RequiredError}
|
|
8414
|
+
*/
|
|
8415
|
+
listVirtualRobotCoordinateSystems(cell, controller, options) {
|
|
8416
|
+
return localVarFp.listVirtualRobotCoordinateSystems(cell, controller, options).then((request) => request(axios, basePath));
|
|
8417
|
+
},
|
|
8418
|
+
/**
|
|
8419
|
+
* Lists TCPs of the motion group. An empty TCP list is valid, for example for external axes.
|
|
8420
|
+
* @summary List TCPs
|
|
8421
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8422
|
+
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
8423
|
+
* @param {string} motionGroup The motion-group identifier.
|
|
8424
|
+
* @param {*} [options] Override http request option.
|
|
8425
|
+
* @throws {RequiredError}
|
|
8426
|
+
*/
|
|
8427
|
+
listVirtualRobotTcps(cell, controller, motionGroup, options) {
|
|
8428
|
+
return localVarFp.listVirtualRobotTcps(cell, controller, motionGroup, options).then((request) => request(axios, basePath));
|
|
8429
|
+
},
|
|
8430
|
+
/**
|
|
8431
|
+
* 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.
|
|
8432
|
+
* @summary Push or Release Emergency Stop
|
|
8433
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8434
|
+
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
8435
|
+
* @param {boolean} [active]
|
|
8436
|
+
* @param {*} [options] Override http request option.
|
|
8437
|
+
* @throws {RequiredError}
|
|
8438
|
+
*/
|
|
8439
|
+
setEmergencyStop(cell, controller, active, options) {
|
|
8440
|
+
return localVarFp.setEmergencyStop(cell, controller, active, options).then((request) => request(axios, basePath));
|
|
8441
|
+
},
|
|
8442
|
+
/**
|
|
8443
|
+
* 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.
|
|
8444
|
+
* @summary Set Motion Group State
|
|
8445
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8446
|
+
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
8447
|
+
* @param {string} motionGroup The motion-group identifier.
|
|
8448
|
+
* @param {MotionGroupJoints} motionGroupJoints
|
|
8449
|
+
* @param {*} [options] Override http request option.
|
|
8450
|
+
* @throws {RequiredError}
|
|
8451
|
+
*/
|
|
8452
|
+
setMotionGroupState(cell, controller, motionGroup, motionGroupJoints, options) {
|
|
8453
|
+
return localVarFp.setMotionGroupState(cell, controller, motionGroup, motionGroupJoints, options).then((request) => request(axios, basePath));
|
|
8454
|
+
},
|
|
8455
|
+
/**
|
|
8456
|
+
* 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.
|
|
8457
|
+
* @summary Set Operation Mode
|
|
8458
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8459
|
+
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
8460
|
+
* @param {OperationMode} mode
|
|
8461
|
+
* @param {*} [options] Override http request option.
|
|
8462
|
+
* @throws {RequiredError}
|
|
8463
|
+
*/
|
|
8464
|
+
setOperationMode(cell, controller, mode, options) {
|
|
8465
|
+
return localVarFp.setOperationMode(cell, controller, mode, options).then((request) => request(axios, basePath));
|
|
8466
|
+
},
|
|
8467
|
+
/**
|
|
8468
|
+
* 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.
|
|
8469
|
+
* @summary Set Mounting
|
|
8470
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8471
|
+
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
8472
|
+
* @param {string} motionGroup The motion-group identifier.
|
|
8473
|
+
* @param {CoordinateSystem} coordinateSystem
|
|
8474
|
+
* @param {*} [options] Override http request option.
|
|
8475
|
+
* @throws {RequiredError}
|
|
8476
|
+
*/
|
|
8477
|
+
setVirtualRobotMounting(cell, controller, motionGroup, coordinateSystem, options) {
|
|
8478
|
+
return localVarFp.setVirtualRobotMounting(cell, controller, motionGroup, coordinateSystem, options).then((request) => request(axios, basePath));
|
|
8479
|
+
},
|
|
8480
|
+
};
|
|
8481
|
+
};
|
|
8482
|
+
/**
|
|
8483
|
+
* VirtualControllerApi - object-oriented interface
|
|
8484
|
+
* @export
|
|
8485
|
+
* @class VirtualControllerApi
|
|
8486
|
+
* @extends {BaseAPI}
|
|
8487
|
+
*/
|
|
8488
|
+
export class VirtualControllerApi extends BaseAPI {
|
|
8489
|
+
/**
|
|
8490
|
+
* Adds a coordinate system to the robot controller.
|
|
8491
|
+
* @summary Add Coordinate Systems
|
|
8492
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8493
|
+
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
8494
|
+
* @param {string} coordinateSystem Unique identifier addressing a coordinate system.
|
|
8495
|
+
* @param {CoordinateSystemData} coordinateSystemData
|
|
8496
|
+
* @param {*} [options] Override http request option.
|
|
8497
|
+
* @throws {RequiredError}
|
|
8498
|
+
* @memberof VirtualControllerApi
|
|
8499
|
+
*/
|
|
8500
|
+
addVirtualRobotCoordinateSystem(cell, controller, coordinateSystem, coordinateSystemData, options) {
|
|
8501
|
+
return VirtualControllerApiFp(this.configuration).addVirtualRobotCoordinateSystem(cell, controller, coordinateSystem, coordinateSystemData, options).then((request) => request(this.axios, this.basePath));
|
|
8502
|
+
}
|
|
8503
|
+
/**
|
|
8504
|
+
* 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.
|
|
8505
|
+
* @summary Add TCP
|
|
8506
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8507
|
+
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
8508
|
+
* @param {string} motionGroup The motion-group identifier.
|
|
8509
|
+
* @param {string} tcp The unique identifier of a TCP.
|
|
8510
|
+
* @param {RobotTcpData} robotTcpData
|
|
8511
|
+
* @param {*} [options] Override http request option.
|
|
8512
|
+
* @throws {RequiredError}
|
|
8513
|
+
* @memberof VirtualControllerApi
|
|
8514
|
+
*/
|
|
8515
|
+
addVirtualRobotTcp(cell, controller, motionGroup, tcp, robotTcpData, options) {
|
|
8516
|
+
return VirtualControllerApiFp(this.configuration).addVirtualRobotTcp(cell, controller, motionGroup, tcp, robotTcpData, options).then((request) => request(this.axios, this.basePath));
|
|
8517
|
+
}
|
|
8518
|
+
/**
|
|
8519
|
+
* 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.
|
|
8520
|
+
* @summary Remove Coordinate System
|
|
8521
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8522
|
+
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
8523
|
+
* @param {string} coordinateSystem Unique identifier addressing a coordinate system.
|
|
8524
|
+
* @param {boolean} [deleteDependent] If true, all dependent coordinate systems will be deleted as well.
|
|
8525
|
+
* @param {*} [options] Override http request option.
|
|
8526
|
+
* @throws {RequiredError}
|
|
8527
|
+
* @memberof VirtualControllerApi
|
|
8528
|
+
*/
|
|
8529
|
+
deleteVirtualRobotCoordinateSystem(cell, controller, coordinateSystem, deleteDependent, options) {
|
|
8530
|
+
return VirtualControllerApiFp(this.configuration).deleteVirtualRobotCoordinateSystem(cell, controller, coordinateSystem, deleteDependent, options).then((request) => request(this.axios, this.basePath));
|
|
8531
|
+
}
|
|
8532
|
+
/**
|
|
8533
|
+
* Removes the TCP from the motion group. An unknown TCP is a valid input.
|
|
8534
|
+
* @summary Remove TCP
|
|
8535
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8536
|
+
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
8537
|
+
* @param {string} motionGroup The motion-group identifier.
|
|
8538
|
+
* @param {string} tcp The unique identifier of a TCP.
|
|
8539
|
+
* @param {*} [options] Override http request option.
|
|
8540
|
+
* @throws {RequiredError}
|
|
8541
|
+
* @memberof VirtualControllerApi
|
|
8542
|
+
*/
|
|
8543
|
+
deleteVirtualRobotTcp(cell, controller, motionGroup, tcp, options) {
|
|
8544
|
+
return VirtualControllerApiFp(this.configuration).deleteVirtualRobotTcp(cell, controller, motionGroup, tcp, options).then((request) => request(this.axios, this.basePath));
|
|
8545
|
+
}
|
|
8546
|
+
/**
|
|
8547
|
+
* 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.
|
|
8548
|
+
* @summary Get Emergency Stop State
|
|
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 {*} [options] Override http request option.
|
|
8552
|
+
* @throws {RequiredError}
|
|
8553
|
+
* @memberof VirtualControllerApi
|
|
8554
|
+
*/
|
|
8555
|
+
getEmergencyStop(cell, controller, options) {
|
|
8556
|
+
return VirtualControllerApiFp(this.configuration).getEmergencyStop(cell, controller, options).then((request) => request(this.axios, this.basePath));
|
|
8557
|
+
}
|
|
8558
|
+
/**
|
|
8559
|
+
* Get the current motion group state which provides values for the joints\' position, velocity and acceleration.
|
|
8560
|
+
* @summary Get Motion Group State
|
|
8561
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8562
|
+
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
8563
|
+
* @param {string} motionGroup The motion-group identifier.
|
|
8564
|
+
* @param {*} [options] Override http request option.
|
|
8565
|
+
* @throws {RequiredError}
|
|
8566
|
+
* @memberof VirtualControllerApi
|
|
8567
|
+
*/
|
|
8568
|
+
getMotionGroupState(cell, controller, motionGroup, options) {
|
|
8569
|
+
return VirtualControllerApiFp(this.configuration).getMotionGroupState(cell, controller, motionGroup, options).then((request) => request(this.axios, this.basePath));
|
|
8570
|
+
}
|
|
8571
|
+
/**
|
|
8572
|
+
* Gets information on the motion group.
|
|
8573
|
+
* @summary Motion Group Description
|
|
8574
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8575
|
+
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
8576
|
+
* @param {*} [options] Override http request option.
|
|
8577
|
+
* @throws {RequiredError}
|
|
8578
|
+
* @memberof VirtualControllerApi
|
|
8579
|
+
*/
|
|
8580
|
+
getMotionGroups(cell, controller, options) {
|
|
8581
|
+
return VirtualControllerApiFp(this.configuration).getMotionGroups(cell, controller, options).then((request) => request(this.axios, this.basePath));
|
|
8582
|
+
}
|
|
8583
|
+
/**
|
|
8584
|
+
* 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.
|
|
8585
|
+
* @summary Get Operation Mode
|
|
8586
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8587
|
+
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
8588
|
+
* @param {*} [options] Override http request option.
|
|
8589
|
+
* @throws {RequiredError}
|
|
8590
|
+
* @memberof VirtualControllerApi
|
|
8591
|
+
*/
|
|
8592
|
+
getOperationMode(cell, controller, options) {
|
|
8593
|
+
return VirtualControllerApiFp(this.configuration).getOperationMode(cell, controller, options).then((request) => request(this.axios, this.basePath));
|
|
8594
|
+
}
|
|
8595
|
+
/**
|
|
8596
|
+
* Gets motion group mounting. The motion group is based on the origin of the returned coordinate system.
|
|
8597
|
+
* @summary Get Mounting
|
|
8598
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8599
|
+
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
8600
|
+
* @param {string} motionGroup The motion-group identifier.
|
|
8601
|
+
* @param {*} [options] Override http request option.
|
|
8602
|
+
* @throws {RequiredError}
|
|
8603
|
+
* @memberof VirtualControllerApi
|
|
8604
|
+
*/
|
|
8605
|
+
getVirtualRobotMounting(cell, controller, motionGroup, options) {
|
|
8606
|
+
return VirtualControllerApiFp(this.configuration).getVirtualRobotMounting(cell, controller, motionGroup, options).then((request) => request(this.axios, this.basePath));
|
|
8607
|
+
}
|
|
8608
|
+
/**
|
|
8609
|
+
* Lists all coordinate systems on the robot controller.
|
|
8610
|
+
* @summary List Coordinate Systems
|
|
8611
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8612
|
+
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
8613
|
+
* @param {*} [options] Override http request option.
|
|
8614
|
+
* @throws {RequiredError}
|
|
8615
|
+
* @memberof VirtualControllerApi
|
|
8616
|
+
*/
|
|
8617
|
+
listVirtualRobotCoordinateSystems(cell, controller, options) {
|
|
8618
|
+
return VirtualControllerApiFp(this.configuration).listVirtualRobotCoordinateSystems(cell, controller, options).then((request) => request(this.axios, this.basePath));
|
|
8619
|
+
}
|
|
8620
|
+
/**
|
|
8621
|
+
* Lists TCPs of the motion group. An empty TCP list is valid, for example for external axes.
|
|
8622
|
+
* @summary List TCPs
|
|
8623
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8624
|
+
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
8625
|
+
* @param {string} motionGroup The motion-group identifier.
|
|
8626
|
+
* @param {*} [options] Override http request option.
|
|
8627
|
+
* @throws {RequiredError}
|
|
8628
|
+
* @memberof VirtualControllerApi
|
|
8629
|
+
*/
|
|
8630
|
+
listVirtualRobotTcps(cell, controller, motionGroup, options) {
|
|
8631
|
+
return VirtualControllerApiFp(this.configuration).listVirtualRobotTcps(cell, controller, motionGroup, options).then((request) => request(this.axios, this.basePath));
|
|
8632
|
+
}
|
|
8633
|
+
/**
|
|
8634
|
+
* 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.
|
|
8635
|
+
* @summary Push or Release Emergency Stop
|
|
8636
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8637
|
+
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
8638
|
+
* @param {boolean} [active]
|
|
8639
|
+
* @param {*} [options] Override http request option.
|
|
8640
|
+
* @throws {RequiredError}
|
|
8641
|
+
* @memberof VirtualControllerApi
|
|
8642
|
+
*/
|
|
8643
|
+
setEmergencyStop(cell, controller, active, options) {
|
|
8644
|
+
return VirtualControllerApiFp(this.configuration).setEmergencyStop(cell, controller, active, options).then((request) => request(this.axios, this.basePath));
|
|
8645
|
+
}
|
|
8646
|
+
/**
|
|
8647
|
+
* 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.
|
|
8648
|
+
* @summary Set Motion Group State
|
|
8649
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8650
|
+
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
8651
|
+
* @param {string} motionGroup The motion-group identifier.
|
|
8652
|
+
* @param {MotionGroupJoints} motionGroupJoints
|
|
8653
|
+
* @param {*} [options] Override http request option.
|
|
8654
|
+
* @throws {RequiredError}
|
|
8655
|
+
* @memberof VirtualControllerApi
|
|
8656
|
+
*/
|
|
8657
|
+
setMotionGroupState(cell, controller, motionGroup, motionGroupJoints, options) {
|
|
8658
|
+
return VirtualControllerApiFp(this.configuration).setMotionGroupState(cell, controller, motionGroup, motionGroupJoints, options).then((request) => request(this.axios, this.basePath));
|
|
8659
|
+
}
|
|
8660
|
+
/**
|
|
8661
|
+
* 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.
|
|
8662
|
+
* @summary Set Operation Mode
|
|
8663
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8664
|
+
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
8665
|
+
* @param {OperationMode} mode
|
|
8666
|
+
* @param {*} [options] Override http request option.
|
|
8667
|
+
* @throws {RequiredError}
|
|
8668
|
+
* @memberof VirtualControllerApi
|
|
8669
|
+
*/
|
|
8670
|
+
setOperationMode(cell, controller, mode, options) {
|
|
8671
|
+
return VirtualControllerApiFp(this.configuration).setOperationMode(cell, controller, mode, options).then((request) => request(this.axios, this.basePath));
|
|
8672
|
+
}
|
|
8673
|
+
/**
|
|
8674
|
+
* 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.
|
|
8675
|
+
* @summary Set Mounting
|
|
8676
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8677
|
+
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
8678
|
+
* @param {string} motionGroup The motion-group identifier.
|
|
8679
|
+
* @param {CoordinateSystem} coordinateSystem
|
|
8680
|
+
* @param {*} [options] Override http request option.
|
|
8681
|
+
* @throws {RequiredError}
|
|
8682
|
+
* @memberof VirtualControllerApi
|
|
8683
|
+
*/
|
|
8684
|
+
setVirtualRobotMounting(cell, controller, motionGroup, coordinateSystem, options) {
|
|
8685
|
+
return VirtualControllerApiFp(this.configuration).setVirtualRobotMounting(cell, controller, motionGroup, coordinateSystem, options).then((request) => request(this.axios, this.basePath));
|
|
8686
|
+
}
|
|
8687
|
+
}
|
|
8688
|
+
/**
|
|
8689
|
+
* VirtualControllerBehaviorApi - axios parameter creator
|
|
8690
|
+
* @export
|
|
8691
|
+
*/
|
|
8692
|
+
export const VirtualControllerBehaviorApiAxiosParamCreator = function (configuration) {
|
|
8693
|
+
return {
|
|
8694
|
+
/**
|
|
8695
|
+
* <!-- 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.
|
|
8696
|
+
* @summary Stream Joint Configuration
|
|
8697
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8698
|
+
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
8699
|
+
* @param {ExternalJointStreamRequest} externalJointStreamRequest
|
|
8788
8700
|
* @param {*} [options] Override http request option.
|
|
8789
8701
|
* @throws {RequiredError}
|
|
8790
8702
|
*/
|
|
8791
|
-
|
|
8703
|
+
externalJointsStream: async (cell, controller, externalJointStreamRequest, options = {}) => {
|
|
8792
8704
|
// verify required parameter 'cell' is not null or undefined
|
|
8793
|
-
assertParamExists('
|
|
8705
|
+
assertParamExists('externalJointsStream', 'cell', cell);
|
|
8794
8706
|
// verify required parameter 'controller' is not null or undefined
|
|
8795
|
-
assertParamExists('
|
|
8796
|
-
// verify required parameter '
|
|
8797
|
-
assertParamExists('
|
|
8798
|
-
const localVarPath = `/cells/{cell}/controllers/{controller}/
|
|
8707
|
+
assertParamExists('externalJointsStream', 'controller', controller);
|
|
8708
|
+
// verify required parameter 'externalJointStreamRequest' is not null or undefined
|
|
8709
|
+
assertParamExists('externalJointsStream', 'externalJointStreamRequest', externalJointStreamRequest);
|
|
8710
|
+
const localVarPath = `/cells/{cell}/virtual-controllers/{controller}/external-joints-stream`
|
|
8799
8711
|
.replace(`{${"cell"}}`, encodeURIComponent(String(cell)))
|
|
8800
|
-
.replace(`{${"controller"}}`, encodeURIComponent(String(controller)))
|
|
8801
|
-
.replace(`{${"motion-group"}}`, encodeURIComponent(String(motionGroup)));
|
|
8712
|
+
.replace(`{${"controller"}}`, encodeURIComponent(String(controller)));
|
|
8802
8713
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
8803
8714
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
8804
8715
|
let baseOptions;
|
|
@@ -8814,28 +8725,30 @@ export const VirtualRobotSetupApiAxiosParamCreator = function (configuration) {
|
|
|
8814
8725
|
// authentication BearerAuth required
|
|
8815
8726
|
// http bearer authentication required
|
|
8816
8727
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
8728
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
8817
8729
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
8818
8730
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
8819
8731
|
localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
|
|
8732
|
+
localVarRequestOptions.data = serializeDataIfNeeded(externalJointStreamRequest, localVarRequestOptions, configuration);
|
|
8820
8733
|
return {
|
|
8821
8734
|
url: toPathString(localVarUrlObj),
|
|
8822
8735
|
options: localVarRequestOptions,
|
|
8823
8736
|
};
|
|
8824
8737
|
},
|
|
8825
8738
|
/**
|
|
8826
|
-
*
|
|
8827
|
-
* @summary
|
|
8739
|
+
* Get the cycle time of controller communication in [ms].
|
|
8740
|
+
* @summary Get Cycle Time
|
|
8828
8741
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8829
8742
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
8830
8743
|
* @param {*} [options] Override http request option.
|
|
8831
8744
|
* @throws {RequiredError}
|
|
8832
8745
|
*/
|
|
8833
|
-
|
|
8746
|
+
getCycleTime: async (cell, controller, options = {}) => {
|
|
8834
8747
|
// verify required parameter 'cell' is not null or undefined
|
|
8835
|
-
assertParamExists('
|
|
8748
|
+
assertParamExists('getCycleTime', 'cell', cell);
|
|
8836
8749
|
// verify required parameter 'controller' is not null or undefined
|
|
8837
|
-
assertParamExists('
|
|
8838
|
-
const localVarPath = `/cells/{cell}/controllers/{controller}/
|
|
8750
|
+
assertParamExists('getCycleTime', 'controller', controller);
|
|
8751
|
+
const localVarPath = `/cells/{cell}/virtual-controllers/{controller}/cycle-time`
|
|
8839
8752
|
.replace(`{${"cell"}}`, encodeURIComponent(String(cell)))
|
|
8840
8753
|
.replace(`{${"controller"}}`, encodeURIComponent(String(controller)));
|
|
8841
8754
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
@@ -8862,25 +8775,21 @@ export const VirtualRobotSetupApiAxiosParamCreator = function (configuration) {
|
|
|
8862
8775
|
};
|
|
8863
8776
|
},
|
|
8864
8777
|
/**
|
|
8865
|
-
*
|
|
8866
|
-
* @summary
|
|
8778
|
+
* Get the current virtual controller behavior - please see the setter [setVirtualRobotBehavior](setVirtualRobotBehavior) and the enum for details.
|
|
8779
|
+
* @summary Get Behavior
|
|
8867
8780
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8868
8781
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
8869
|
-
* @param {string} motionGroup The motion-group identifier.
|
|
8870
8782
|
* @param {*} [options] Override http request option.
|
|
8871
8783
|
* @throws {RequiredError}
|
|
8872
8784
|
*/
|
|
8873
|
-
|
|
8785
|
+
getVirtualRobotBehavior: async (cell, controller, options = {}) => {
|
|
8874
8786
|
// verify required parameter 'cell' is not null or undefined
|
|
8875
|
-
assertParamExists('
|
|
8787
|
+
assertParamExists('getVirtualRobotBehavior', 'cell', cell);
|
|
8876
8788
|
// verify required parameter 'controller' is not null or undefined
|
|
8877
|
-
assertParamExists('
|
|
8878
|
-
|
|
8879
|
-
assertParamExists('listVirtualRobotTcps', 'motionGroup', motionGroup);
|
|
8880
|
-
const localVarPath = `/cells/{cell}/controllers/{controller}/teach-pendant/motion-groups/{motion-group}/tcps`
|
|
8789
|
+
assertParamExists('getVirtualRobotBehavior', 'controller', controller);
|
|
8790
|
+
const localVarPath = `/cells/{cell}/virtual-controllers/{controller}/behavior`
|
|
8881
8791
|
.replace(`{${"cell"}}`, encodeURIComponent(String(cell)))
|
|
8882
|
-
.replace(`{${"controller"}}`, encodeURIComponent(String(controller)))
|
|
8883
|
-
.replace(`{${"motion-group"}}`, encodeURIComponent(String(motionGroup)));
|
|
8792
|
+
.replace(`{${"controller"}}`, encodeURIComponent(String(controller)));
|
|
8884
8793
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
8885
8794
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
8886
8795
|
let baseOptions;
|
|
@@ -8905,28 +8814,22 @@ export const VirtualRobotSetupApiAxiosParamCreator = function (configuration) {
|
|
|
8905
8814
|
};
|
|
8906
8815
|
},
|
|
8907
8816
|
/**
|
|
8908
|
-
*
|
|
8909
|
-
* @summary Set
|
|
8817
|
+
* Set virtual controller behavior.
|
|
8818
|
+
* @summary Set Behavior
|
|
8910
8819
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8911
8820
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
8912
|
-
* @param {
|
|
8913
|
-
* @param {CoordinateSystem} coordinateSystem
|
|
8821
|
+
* @param {Behavior} [behavior]
|
|
8914
8822
|
* @param {*} [options] Override http request option.
|
|
8915
8823
|
* @throws {RequiredError}
|
|
8916
8824
|
*/
|
|
8917
|
-
|
|
8825
|
+
setVirtualRobotBehavior: async (cell, controller, behavior, options = {}) => {
|
|
8918
8826
|
// verify required parameter 'cell' is not null or undefined
|
|
8919
|
-
assertParamExists('
|
|
8827
|
+
assertParamExists('setVirtualRobotBehavior', 'cell', cell);
|
|
8920
8828
|
// verify required parameter 'controller' is not null or undefined
|
|
8921
|
-
assertParamExists('
|
|
8922
|
-
|
|
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`
|
|
8829
|
+
assertParamExists('setVirtualRobotBehavior', 'controller', controller);
|
|
8830
|
+
const localVarPath = `/cells/{cell}/virtual-controllers/{controller}/behavior`
|
|
8927
8831
|
.replace(`{${"cell"}}`, encodeURIComponent(String(cell)))
|
|
8928
|
-
.replace(`{${"controller"}}`, encodeURIComponent(String(controller)))
|
|
8929
|
-
.replace(`{${"motion-group"}}`, encodeURIComponent(String(motionGroup)));
|
|
8832
|
+
.replace(`{${"controller"}}`, encodeURIComponent(String(controller)));
|
|
8930
8833
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
8931
8834
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
8932
8835
|
let baseOptions;
|
|
@@ -8942,11 +8845,12 @@ export const VirtualRobotSetupApiAxiosParamCreator = function (configuration) {
|
|
|
8942
8845
|
// authentication BearerAuth required
|
|
8943
8846
|
// http bearer authentication required
|
|
8944
8847
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
8945
|
-
|
|
8848
|
+
if (behavior !== undefined) {
|
|
8849
|
+
localVarQueryParameter['behavior'] = behavior;
|
|
8850
|
+
}
|
|
8946
8851
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
8947
8852
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
8948
8853
|
localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
|
|
8949
|
-
localVarRequestOptions.data = serializeDataIfNeeded(coordinateSystem, localVarRequestOptions, configuration);
|
|
8950
8854
|
return {
|
|
8951
8855
|
url: toPathString(localVarUrlObj),
|
|
8952
8856
|
options: localVarRequestOptions,
|
|
@@ -8955,358 +8859,490 @@ export const VirtualRobotSetupApiAxiosParamCreator = function (configuration) {
|
|
|
8955
8859
|
};
|
|
8956
8860
|
};
|
|
8957
8861
|
/**
|
|
8958
|
-
*
|
|
8862
|
+
* VirtualControllerBehaviorApi - functional programming interface
|
|
8959
8863
|
* @export
|
|
8960
8864
|
*/
|
|
8961
|
-
export const
|
|
8962
|
-
const localVarAxiosParamCreator =
|
|
8865
|
+
export const VirtualControllerBehaviorApiFp = function (configuration) {
|
|
8866
|
+
const localVarAxiosParamCreator = VirtualControllerBehaviorApiAxiosParamCreator(configuration);
|
|
8963
8867
|
return {
|
|
8964
8868
|
/**
|
|
8965
|
-
*
|
|
8966
|
-
* @summary
|
|
8869
|
+
* <!-- 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.
|
|
8870
|
+
* @summary Stream Joint Configuration
|
|
8967
8871
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8968
8872
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
8969
|
-
* @param {
|
|
8873
|
+
* @param {ExternalJointStreamRequest} externalJointStreamRequest
|
|
8970
8874
|
* @param {*} [options] Override http request option.
|
|
8971
8875
|
* @throws {RequiredError}
|
|
8972
8876
|
*/
|
|
8973
|
-
async
|
|
8974
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.
|
|
8877
|
+
async externalJointsStream(cell, controller, externalJointStreamRequest, options) {
|
|
8878
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.externalJointsStream(cell, controller, externalJointStreamRequest, options);
|
|
8975
8879
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
8976
|
-
const localVarOperationServerBasePath = operationServerMap['
|
|
8880
|
+
const localVarOperationServerBasePath = operationServerMap['VirtualControllerBehaviorApi.externalJointsStream']?.[localVarOperationServerIndex]?.url;
|
|
8977
8881
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
8978
8882
|
},
|
|
8979
8883
|
/**
|
|
8980
|
-
*
|
|
8981
|
-
* @summary
|
|
8884
|
+
* Get the cycle time of controller communication in [ms].
|
|
8885
|
+
* @summary Get Cycle Time
|
|
8982
8886
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8983
8887
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
8984
|
-
* @param {string} motionGroup The motion-group identifier.
|
|
8985
|
-
* @param {RobotTcp} robotTcp
|
|
8986
8888
|
* @param {*} [options] Override http request option.
|
|
8987
8889
|
* @throws {RequiredError}
|
|
8988
8890
|
*/
|
|
8989
|
-
async
|
|
8990
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.
|
|
8891
|
+
async getCycleTime(cell, controller, options) {
|
|
8892
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.getCycleTime(cell, controller, options);
|
|
8991
8893
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
8992
|
-
const localVarOperationServerBasePath = operationServerMap['
|
|
8894
|
+
const localVarOperationServerBasePath = operationServerMap['VirtualControllerBehaviorApi.getCycleTime']?.[localVarOperationServerIndex]?.url;
|
|
8993
8895
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
8994
8896
|
},
|
|
8995
8897
|
/**
|
|
8996
|
-
*
|
|
8997
|
-
* @summary
|
|
8898
|
+
* Get the current virtual controller behavior - please see the setter [setVirtualRobotBehavior](setVirtualRobotBehavior) and the enum for details.
|
|
8899
|
+
* @summary Get Behavior
|
|
8998
8900
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8999
8901
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
9000
|
-
* @param {string} coordinateSystem Unique identifier addressing a coordinate system.
|
|
9001
|
-
* @param {boolean} [deleteDependent] If true, all dependent coordinate systems will be deleted as well.
|
|
9002
8902
|
* @param {*} [options] Override http request option.
|
|
9003
8903
|
* @throws {RequiredError}
|
|
9004
8904
|
*/
|
|
9005
|
-
async
|
|
9006
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.
|
|
8905
|
+
async getVirtualRobotBehavior(cell, controller, options) {
|
|
8906
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.getVirtualRobotBehavior(cell, controller, options);
|
|
9007
8907
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
9008
|
-
const localVarOperationServerBasePath = operationServerMap['
|
|
8908
|
+
const localVarOperationServerBasePath = operationServerMap['VirtualControllerBehaviorApi.getVirtualRobotBehavior']?.[localVarOperationServerIndex]?.url;
|
|
9009
8909
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
9010
8910
|
},
|
|
9011
8911
|
/**
|
|
9012
|
-
*
|
|
9013
|
-
* @summary
|
|
8912
|
+
* Set virtual controller behavior.
|
|
8913
|
+
* @summary Set Behavior
|
|
9014
8914
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
9015
8915
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
9016
|
-
* @param {
|
|
9017
|
-
* @param {string} tcp The unique identifier of a TCP.
|
|
8916
|
+
* @param {Behavior} [behavior]
|
|
9018
8917
|
* @param {*} [options] Override http request option.
|
|
9019
8918
|
* @throws {RequiredError}
|
|
9020
8919
|
*/
|
|
9021
|
-
async
|
|
9022
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.
|
|
8920
|
+
async setVirtualRobotBehavior(cell, controller, behavior, options) {
|
|
8921
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.setVirtualRobotBehavior(cell, controller, behavior, options);
|
|
9023
8922
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
9024
|
-
const localVarOperationServerBasePath = operationServerMap['
|
|
8923
|
+
const localVarOperationServerBasePath = operationServerMap['VirtualControllerBehaviorApi.setVirtualRobotBehavior']?.[localVarOperationServerIndex]?.url;
|
|
9025
8924
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
9026
8925
|
},
|
|
8926
|
+
};
|
|
8927
|
+
};
|
|
8928
|
+
/**
|
|
8929
|
+
* VirtualControllerBehaviorApi - factory interface
|
|
8930
|
+
* @export
|
|
8931
|
+
*/
|
|
8932
|
+
export const VirtualControllerBehaviorApiFactory = function (configuration, basePath, axios) {
|
|
8933
|
+
const localVarFp = VirtualControllerBehaviorApiFp(configuration);
|
|
8934
|
+
return {
|
|
8935
|
+
/**
|
|
8936
|
+
* <!-- 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.
|
|
8937
|
+
* @summary Stream Joint Configuration
|
|
8938
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8939
|
+
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
8940
|
+
* @param {ExternalJointStreamRequest} externalJointStreamRequest
|
|
8941
|
+
* @param {*} [options] Override http request option.
|
|
8942
|
+
* @throws {RequiredError}
|
|
8943
|
+
*/
|
|
8944
|
+
externalJointsStream(cell, controller, externalJointStreamRequest, options) {
|
|
8945
|
+
return localVarFp.externalJointsStream(cell, controller, externalJointStreamRequest, options).then((request) => request(axios, basePath));
|
|
8946
|
+
},
|
|
8947
|
+
/**
|
|
8948
|
+
* Get the cycle time of controller communication in [ms].
|
|
8949
|
+
* @summary Get Cycle Time
|
|
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 {*} [options] Override http request option.
|
|
8953
|
+
* @throws {RequiredError}
|
|
8954
|
+
*/
|
|
8955
|
+
getCycleTime(cell, controller, options) {
|
|
8956
|
+
return localVarFp.getCycleTime(cell, controller, options).then((request) => request(axios, basePath));
|
|
8957
|
+
},
|
|
8958
|
+
/**
|
|
8959
|
+
* Get the current virtual controller behavior - please see the setter [setVirtualRobotBehavior](setVirtualRobotBehavior) and the enum for details.
|
|
8960
|
+
* @summary Get Behavior
|
|
8961
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8962
|
+
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
8963
|
+
* @param {*} [options] Override http request option.
|
|
8964
|
+
* @throws {RequiredError}
|
|
8965
|
+
*/
|
|
8966
|
+
getVirtualRobotBehavior(cell, controller, options) {
|
|
8967
|
+
return localVarFp.getVirtualRobotBehavior(cell, controller, options).then((request) => request(axios, basePath));
|
|
8968
|
+
},
|
|
8969
|
+
/**
|
|
8970
|
+
* Set virtual controller behavior.
|
|
8971
|
+
* @summary Set Behavior
|
|
8972
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8973
|
+
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
8974
|
+
* @param {Behavior} [behavior]
|
|
8975
|
+
* @param {*} [options] Override http request option.
|
|
8976
|
+
* @throws {RequiredError}
|
|
8977
|
+
*/
|
|
8978
|
+
setVirtualRobotBehavior(cell, controller, behavior, options) {
|
|
8979
|
+
return localVarFp.setVirtualRobotBehavior(cell, controller, behavior, options).then((request) => request(axios, basePath));
|
|
8980
|
+
},
|
|
8981
|
+
};
|
|
8982
|
+
};
|
|
8983
|
+
/**
|
|
8984
|
+
* VirtualControllerBehaviorApi - object-oriented interface
|
|
8985
|
+
* @export
|
|
8986
|
+
* @class VirtualControllerBehaviorApi
|
|
8987
|
+
* @extends {BaseAPI}
|
|
8988
|
+
*/
|
|
8989
|
+
export class VirtualControllerBehaviorApi extends BaseAPI {
|
|
8990
|
+
/**
|
|
8991
|
+
* <!-- 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.
|
|
8992
|
+
* @summary Stream Joint Configuration
|
|
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 {ExternalJointStreamRequest} externalJointStreamRequest
|
|
8996
|
+
* @param {*} [options] Override http request option.
|
|
8997
|
+
* @throws {RequiredError}
|
|
8998
|
+
* @memberof VirtualControllerBehaviorApi
|
|
8999
|
+
*/
|
|
9000
|
+
externalJointsStream(cell, controller, externalJointStreamRequest, options) {
|
|
9001
|
+
return VirtualControllerBehaviorApiFp(this.configuration).externalJointsStream(cell, controller, externalJointStreamRequest, options).then((request) => request(this.axios, this.basePath));
|
|
9002
|
+
}
|
|
9003
|
+
/**
|
|
9004
|
+
* Get the cycle time of controller communication in [ms].
|
|
9005
|
+
* @summary Get Cycle Time
|
|
9006
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
9007
|
+
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
9008
|
+
* @param {*} [options] Override http request option.
|
|
9009
|
+
* @throws {RequiredError}
|
|
9010
|
+
* @memberof VirtualControllerBehaviorApi
|
|
9011
|
+
*/
|
|
9012
|
+
getCycleTime(cell, controller, options) {
|
|
9013
|
+
return VirtualControllerBehaviorApiFp(this.configuration).getCycleTime(cell, controller, options).then((request) => request(this.axios, this.basePath));
|
|
9014
|
+
}
|
|
9015
|
+
/**
|
|
9016
|
+
* Get the current virtual controller behavior - please see the setter [setVirtualRobotBehavior](setVirtualRobotBehavior) and the enum for details.
|
|
9017
|
+
* @summary Get Behavior
|
|
9018
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
9019
|
+
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
9020
|
+
* @param {*} [options] Override http request option.
|
|
9021
|
+
* @throws {RequiredError}
|
|
9022
|
+
* @memberof VirtualControllerBehaviorApi
|
|
9023
|
+
*/
|
|
9024
|
+
getVirtualRobotBehavior(cell, controller, options) {
|
|
9025
|
+
return VirtualControllerBehaviorApiFp(this.configuration).getVirtualRobotBehavior(cell, controller, options).then((request) => request(this.axios, this.basePath));
|
|
9026
|
+
}
|
|
9027
|
+
/**
|
|
9028
|
+
* Set virtual controller behavior.
|
|
9029
|
+
* @summary Set Behavior
|
|
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 {Behavior} [behavior]
|
|
9033
|
+
* @param {*} [options] Override http request option.
|
|
9034
|
+
* @throws {RequiredError}
|
|
9035
|
+
* @memberof VirtualControllerBehaviorApi
|
|
9036
|
+
*/
|
|
9037
|
+
setVirtualRobotBehavior(cell, controller, behavior, options) {
|
|
9038
|
+
return VirtualControllerBehaviorApiFp(this.configuration).setVirtualRobotBehavior(cell, controller, behavior, options).then((request) => request(this.axios, this.basePath));
|
|
9039
|
+
}
|
|
9040
|
+
}
|
|
9041
|
+
/**
|
|
9042
|
+
* VirtualControllerInputsOutputsApi - axios parameter creator
|
|
9043
|
+
* @export
|
|
9044
|
+
*/
|
|
9045
|
+
export const VirtualControllerInputsOutputsApiAxiosParamCreator = function (configuration) {
|
|
9046
|
+
return {
|
|
9047
|
+
/**
|
|
9048
|
+
* 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).
|
|
9049
|
+
* @summary Get Input/Output Values
|
|
9050
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
9051
|
+
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
9052
|
+
* @param {Array<string>} ios
|
|
9053
|
+
* @param {*} [options] Override http request option.
|
|
9054
|
+
* @throws {RequiredError}
|
|
9055
|
+
*/
|
|
9056
|
+
listIOs: async (cell, controller, ios, options = {}) => {
|
|
9057
|
+
// verify required parameter 'cell' is not null or undefined
|
|
9058
|
+
assertParamExists('listIOs', 'cell', cell);
|
|
9059
|
+
// verify required parameter 'controller' is not null or undefined
|
|
9060
|
+
assertParamExists('listIOs', 'controller', controller);
|
|
9061
|
+
// verify required parameter 'ios' is not null or undefined
|
|
9062
|
+
assertParamExists('listIOs', 'ios', ios);
|
|
9063
|
+
const localVarPath = `/cells/{cell}/virtual-controllers/{controller}/ios/values`
|
|
9064
|
+
.replace(`{${"cell"}}`, encodeURIComponent(String(cell)))
|
|
9065
|
+
.replace(`{${"controller"}}`, encodeURIComponent(String(controller)));
|
|
9066
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
9067
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
9068
|
+
let baseOptions;
|
|
9069
|
+
if (configuration) {
|
|
9070
|
+
baseOptions = configuration.baseOptions;
|
|
9071
|
+
}
|
|
9072
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options };
|
|
9073
|
+
const localVarHeaderParameter = {};
|
|
9074
|
+
const localVarQueryParameter = {};
|
|
9075
|
+
// authentication BasicAuth required
|
|
9076
|
+
// http basic authentication required
|
|
9077
|
+
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
9078
|
+
// authentication BearerAuth required
|
|
9079
|
+
// http bearer authentication required
|
|
9080
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
9081
|
+
if (ios) {
|
|
9082
|
+
localVarQueryParameter['ios'] = ios;
|
|
9083
|
+
}
|
|
9084
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
9085
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
9086
|
+
localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
|
|
9087
|
+
return {
|
|
9088
|
+
url: toPathString(localVarUrlObj),
|
|
9089
|
+
options: localVarRequestOptions,
|
|
9090
|
+
};
|
|
9091
|
+
},
|
|
9092
|
+
/**
|
|
9093
|
+
* 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.
|
|
9094
|
+
* @summary List Descriptions
|
|
9095
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
9096
|
+
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
9097
|
+
* @param {Array<string>} [ios]
|
|
9098
|
+
* @param {IODirection} [direction] Return only inputs/outputs with the specified direction.
|
|
9099
|
+
* @param {IOValueType} [valueType] Return only inputs/outputs with the specified value type.
|
|
9100
|
+
* @param {string} [group] Return only inputs/outputs from the specified group.
|
|
9101
|
+
* @param {*} [options] Override http request option.
|
|
9102
|
+
* @throws {RequiredError}
|
|
9103
|
+
*/
|
|
9104
|
+
listVirtualRobotIODescriptions: async (cell, controller, ios, direction, valueType, group, options = {}) => {
|
|
9105
|
+
// verify required parameter 'cell' is not null or undefined
|
|
9106
|
+
assertParamExists('listVirtualRobotIODescriptions', 'cell', cell);
|
|
9107
|
+
// verify required parameter 'controller' is not null or undefined
|
|
9108
|
+
assertParamExists('listVirtualRobotIODescriptions', 'controller', controller);
|
|
9109
|
+
const localVarPath = `/cells/{cell}/virtual-controllers/{controller}/ios/description`
|
|
9110
|
+
.replace(`{${"cell"}}`, encodeURIComponent(String(cell)))
|
|
9111
|
+
.replace(`{${"controller"}}`, encodeURIComponent(String(controller)));
|
|
9112
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
9113
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
9114
|
+
let baseOptions;
|
|
9115
|
+
if (configuration) {
|
|
9116
|
+
baseOptions = configuration.baseOptions;
|
|
9117
|
+
}
|
|
9118
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options };
|
|
9119
|
+
const localVarHeaderParameter = {};
|
|
9120
|
+
const localVarQueryParameter = {};
|
|
9121
|
+
// authentication BasicAuth required
|
|
9122
|
+
// http basic authentication required
|
|
9123
|
+
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
9124
|
+
// authentication BearerAuth required
|
|
9125
|
+
// http bearer authentication required
|
|
9126
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
9127
|
+
if (ios) {
|
|
9128
|
+
localVarQueryParameter['ios'] = ios;
|
|
9129
|
+
}
|
|
9130
|
+
if (direction !== undefined) {
|
|
9131
|
+
localVarQueryParameter['direction'] = direction;
|
|
9132
|
+
}
|
|
9133
|
+
if (valueType !== undefined) {
|
|
9134
|
+
localVarQueryParameter['value_type'] = valueType;
|
|
9135
|
+
}
|
|
9136
|
+
if (group !== undefined) {
|
|
9137
|
+
localVarQueryParameter['group'] = group;
|
|
9138
|
+
}
|
|
9139
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
9140
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
9141
|
+
localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
|
|
9142
|
+
return {
|
|
9143
|
+
url: toPathString(localVarUrlObj),
|
|
9144
|
+
options: localVarRequestOptions,
|
|
9145
|
+
};
|
|
9146
|
+
},
|
|
9027
9147
|
/**
|
|
9028
|
-
*
|
|
9029
|
-
* @summary
|
|
9148
|
+
* Sets a list of values of a virtual controller inputs/outputs.
|
|
9149
|
+
* @summary Set Input/Ouput Values
|
|
9030
9150
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
9031
9151
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
9032
|
-
* @param {
|
|
9152
|
+
* @param {Array<IOValue>} iOValue
|
|
9033
9153
|
* @param {*} [options] Override http request option.
|
|
9034
9154
|
* @throws {RequiredError}
|
|
9035
9155
|
*/
|
|
9036
|
-
async
|
|
9037
|
-
|
|
9038
|
-
|
|
9039
|
-
|
|
9040
|
-
|
|
9156
|
+
setIOValues: async (cell, controller, iOValue, options = {}) => {
|
|
9157
|
+
// verify required parameter 'cell' is not null or undefined
|
|
9158
|
+
assertParamExists('setIOValues', 'cell', cell);
|
|
9159
|
+
// verify required parameter 'controller' is not null or undefined
|
|
9160
|
+
assertParamExists('setIOValues', 'controller', controller);
|
|
9161
|
+
// verify required parameter 'iOValue' is not null or undefined
|
|
9162
|
+
assertParamExists('setIOValues', 'iOValue', iOValue);
|
|
9163
|
+
const localVarPath = `/cells/{cell}/virtual-controllers/{controller}/ios/values`
|
|
9164
|
+
.replace(`{${"cell"}}`, encodeURIComponent(String(cell)))
|
|
9165
|
+
.replace(`{${"controller"}}`, encodeURIComponent(String(controller)));
|
|
9166
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
9167
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
9168
|
+
let baseOptions;
|
|
9169
|
+
if (configuration) {
|
|
9170
|
+
baseOptions = configuration.baseOptions;
|
|
9171
|
+
}
|
|
9172
|
+
const localVarRequestOptions = { method: 'PUT', ...baseOptions, ...options };
|
|
9173
|
+
const localVarHeaderParameter = {};
|
|
9174
|
+
const localVarQueryParameter = {};
|
|
9175
|
+
// authentication BasicAuth required
|
|
9176
|
+
// http basic authentication required
|
|
9177
|
+
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
9178
|
+
// authentication BearerAuth required
|
|
9179
|
+
// http bearer authentication required
|
|
9180
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
9181
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
9182
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
9183
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
9184
|
+
localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
|
|
9185
|
+
localVarRequestOptions.data = serializeDataIfNeeded(iOValue, localVarRequestOptions, configuration);
|
|
9186
|
+
return {
|
|
9187
|
+
url: toPathString(localVarUrlObj),
|
|
9188
|
+
options: localVarRequestOptions,
|
|
9189
|
+
};
|
|
9041
9190
|
},
|
|
9191
|
+
};
|
|
9192
|
+
};
|
|
9193
|
+
/**
|
|
9194
|
+
* VirtualControllerInputsOutputsApi - functional programming interface
|
|
9195
|
+
* @export
|
|
9196
|
+
*/
|
|
9197
|
+
export const VirtualControllerInputsOutputsApiFp = function (configuration) {
|
|
9198
|
+
const localVarAxiosParamCreator = VirtualControllerInputsOutputsApiAxiosParamCreator(configuration);
|
|
9199
|
+
return {
|
|
9042
9200
|
/**
|
|
9043
|
-
*
|
|
9044
|
-
* @summary
|
|
9201
|
+
* 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).
|
|
9202
|
+
* @summary Get Input/Output Values
|
|
9045
9203
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
9046
9204
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
9205
|
+
* @param {Array<string>} ios
|
|
9047
9206
|
* @param {*} [options] Override http request option.
|
|
9048
9207
|
* @throws {RequiredError}
|
|
9049
9208
|
*/
|
|
9050
|
-
async
|
|
9051
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.
|
|
9209
|
+
async listIOs(cell, controller, ios, options) {
|
|
9210
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.listIOs(cell, controller, ios, options);
|
|
9052
9211
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
9053
|
-
const localVarOperationServerBasePath = operationServerMap['
|
|
9212
|
+
const localVarOperationServerBasePath = operationServerMap['VirtualControllerInputsOutputsApi.listIOs']?.[localVarOperationServerIndex]?.url;
|
|
9054
9213
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
9055
9214
|
},
|
|
9056
9215
|
/**
|
|
9057
|
-
* Lists
|
|
9058
|
-
* @summary List
|
|
9216
|
+
* 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.
|
|
9217
|
+
* @summary List Descriptions
|
|
9059
9218
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
9060
9219
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
9061
|
-
* @param {string}
|
|
9220
|
+
* @param {Array<string>} [ios]
|
|
9221
|
+
* @param {IODirection} [direction] Return only inputs/outputs with the specified direction.
|
|
9222
|
+
* @param {IOValueType} [valueType] Return only inputs/outputs with the specified value type.
|
|
9223
|
+
* @param {string} [group] Return only inputs/outputs from the specified group.
|
|
9062
9224
|
* @param {*} [options] Override http request option.
|
|
9063
9225
|
* @throws {RequiredError}
|
|
9064
9226
|
*/
|
|
9065
|
-
async
|
|
9066
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.
|
|
9227
|
+
async listVirtualRobotIODescriptions(cell, controller, ios, direction, valueType, group, options) {
|
|
9228
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.listVirtualRobotIODescriptions(cell, controller, ios, direction, valueType, group, options);
|
|
9067
9229
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
9068
|
-
const localVarOperationServerBasePath = operationServerMap['
|
|
9230
|
+
const localVarOperationServerBasePath = operationServerMap['VirtualControllerInputsOutputsApi.listVirtualRobotIODescriptions']?.[localVarOperationServerIndex]?.url;
|
|
9069
9231
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
9070
9232
|
},
|
|
9071
9233
|
/**
|
|
9072
|
-
* Sets
|
|
9073
|
-
* @summary Set
|
|
9234
|
+
* Sets a list of values of a virtual controller inputs/outputs.
|
|
9235
|
+
* @summary Set Input/Ouput Values
|
|
9074
9236
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
9075
9237
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
9076
|
-
* @param {
|
|
9077
|
-
* @param {CoordinateSystem} coordinateSystem
|
|
9238
|
+
* @param {Array<IOValue>} iOValue
|
|
9078
9239
|
* @param {*} [options] Override http request option.
|
|
9079
9240
|
* @throws {RequiredError}
|
|
9080
9241
|
*/
|
|
9081
|
-
async
|
|
9082
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.
|
|
9242
|
+
async setIOValues(cell, controller, iOValue, options) {
|
|
9243
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.setIOValues(cell, controller, iOValue, options);
|
|
9083
9244
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
9084
|
-
const localVarOperationServerBasePath = operationServerMap['
|
|
9245
|
+
const localVarOperationServerBasePath = operationServerMap['VirtualControllerInputsOutputsApi.setIOValues']?.[localVarOperationServerIndex]?.url;
|
|
9085
9246
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
9086
9247
|
},
|
|
9087
9248
|
};
|
|
9088
9249
|
};
|
|
9089
9250
|
/**
|
|
9090
|
-
*
|
|
9251
|
+
* VirtualControllerInputsOutputsApi - factory interface
|
|
9091
9252
|
* @export
|
|
9092
9253
|
*/
|
|
9093
|
-
export const
|
|
9094
|
-
const localVarFp =
|
|
9254
|
+
export const VirtualControllerInputsOutputsApiFactory = function (configuration, basePath, axios) {
|
|
9255
|
+
const localVarFp = VirtualControllerInputsOutputsApiFp(configuration);
|
|
9095
9256
|
return {
|
|
9096
9257
|
/**
|
|
9097
|
-
*
|
|
9098
|
-
* @summary
|
|
9099
|
-
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
9100
|
-
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
9101
|
-
* @param {CoordinateSystem} coordinateSystem
|
|
9102
|
-
* @param {*} [options] Override http request option.
|
|
9103
|
-
* @throws {RequiredError}
|
|
9104
|
-
*/
|
|
9105
|
-
addVirtualRobotCoordinateSystem(cell, controller, coordinateSystem, options) {
|
|
9106
|
-
return localVarFp.addVirtualRobotCoordinateSystem(cell, controller, coordinateSystem, options).then((request) => request(axios, basePath));
|
|
9107
|
-
},
|
|
9108
|
-
/**
|
|
9109
|
-
* Adds a new TCP or updates an existing TCP in the motion group. The position and rotation values in the request body are defined within the flange’s coordinate system. > **NOTE** > > Ensure the TCP\'s position is within the robot\'s reach. Refer to the robot’s documentation or data sheet for details like joint limits or reach.
|
|
9110
|
-
* @summary Add TCP
|
|
9111
|
-
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
9112
|
-
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
9113
|
-
* @param {string} motionGroup The motion-group identifier.
|
|
9114
|
-
* @param {RobotTcp} robotTcp
|
|
9115
|
-
* @param {*} [options] Override http request option.
|
|
9116
|
-
* @throws {RequiredError}
|
|
9117
|
-
*/
|
|
9118
|
-
addVirtualRobotTcp(cell, controller, motionGroup, robotTcp, options) {
|
|
9119
|
-
return localVarFp.addVirtualRobotTcp(cell, controller, motionGroup, robotTcp, options).then((request) => request(axios, basePath));
|
|
9120
|
-
},
|
|
9121
|
-
/**
|
|
9122
|
-
* Deletes a coordinate system from the virtual controller. This will remove the coordinate system from the list of coordinate systems and remove all dependent coordinate systems which use the deleted coordinate system as reference.
|
|
9123
|
-
* @summary Remove Coordinate System
|
|
9124
|
-
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
9125
|
-
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
9126
|
-
* @param {string} coordinateSystem Unique identifier addressing a coordinate system.
|
|
9127
|
-
* @param {boolean} [deleteDependent] If true, all dependent coordinate systems will be deleted as well.
|
|
9128
|
-
* @param {*} [options] Override http request option.
|
|
9129
|
-
* @throws {RequiredError}
|
|
9130
|
-
*/
|
|
9131
|
-
deleteVirtualRobotCoordinateSystem(cell, controller, coordinateSystem, deleteDependent, options) {
|
|
9132
|
-
return localVarFp.deleteVirtualRobotCoordinateSystem(cell, controller, coordinateSystem, deleteDependent, options).then((request) => request(axios, basePath));
|
|
9133
|
-
},
|
|
9134
|
-
/**
|
|
9135
|
-
* Removes the TCP from the motion group. An unknown TCP is a valid input.
|
|
9136
|
-
* @summary Remove TCP
|
|
9137
|
-
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
9138
|
-
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
9139
|
-
* @param {string} motionGroup The motion-group identifier.
|
|
9140
|
-
* @param {string} tcp The unique identifier of a TCP.
|
|
9141
|
-
* @param {*} [options] Override http request option.
|
|
9142
|
-
* @throws {RequiredError}
|
|
9143
|
-
*/
|
|
9144
|
-
deleteVirtualRobotTcp(cell, controller, motionGroup, tcp, options) {
|
|
9145
|
-
return localVarFp.deleteVirtualRobotTcp(cell, controller, motionGroup, tcp, options).then((request) => request(axios, basePath));
|
|
9146
|
-
},
|
|
9147
|
-
/**
|
|
9148
|
-
* Gets motion group mounting. The motion group is based on the origin of the returned coordinate system.
|
|
9149
|
-
* @summary Get Mounting
|
|
9150
|
-
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
9151
|
-
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
9152
|
-
* @param {string} motionGroup The motion-group identifier.
|
|
9153
|
-
* @param {*} [options] Override http request option.
|
|
9154
|
-
* @throws {RequiredError}
|
|
9155
|
-
*/
|
|
9156
|
-
getVirtualRobotMounting(cell, controller, motionGroup, options) {
|
|
9157
|
-
return localVarFp.getVirtualRobotMounting(cell, controller, motionGroup, options).then((request) => request(axios, basePath));
|
|
9158
|
-
},
|
|
9159
|
-
/**
|
|
9160
|
-
* Lists all coordinate systems on the robot controller.
|
|
9161
|
-
* @summary List Coordinate Systems
|
|
9258
|
+
* 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).
|
|
9259
|
+
* @summary Get Input/Output Values
|
|
9162
9260
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
9163
9261
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
9262
|
+
* @param {Array<string>} ios
|
|
9164
9263
|
* @param {*} [options] Override http request option.
|
|
9165
9264
|
* @throws {RequiredError}
|
|
9166
9265
|
*/
|
|
9167
|
-
|
|
9168
|
-
return localVarFp.
|
|
9266
|
+
listIOs(cell, controller, ios, options) {
|
|
9267
|
+
return localVarFp.listIOs(cell, controller, ios, options).then((request) => request(axios, basePath));
|
|
9169
9268
|
},
|
|
9170
9269
|
/**
|
|
9171
|
-
* Lists
|
|
9172
|
-
* @summary List
|
|
9270
|
+
* 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.
|
|
9271
|
+
* @summary List Descriptions
|
|
9173
9272
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
9174
9273
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
9175
|
-
* @param {string}
|
|
9274
|
+
* @param {Array<string>} [ios]
|
|
9275
|
+
* @param {IODirection} [direction] Return only inputs/outputs with the specified direction.
|
|
9276
|
+
* @param {IOValueType} [valueType] Return only inputs/outputs with the specified value type.
|
|
9277
|
+
* @param {string} [group] Return only inputs/outputs from the specified group.
|
|
9176
9278
|
* @param {*} [options] Override http request option.
|
|
9177
9279
|
* @throws {RequiredError}
|
|
9178
9280
|
*/
|
|
9179
|
-
|
|
9180
|
-
return localVarFp.
|
|
9281
|
+
listVirtualRobotIODescriptions(cell, controller, ios, direction, valueType, group, options) {
|
|
9282
|
+
return localVarFp.listVirtualRobotIODescriptions(cell, controller, ios, direction, valueType, group, options).then((request) => request(axios, basePath));
|
|
9181
9283
|
},
|
|
9182
9284
|
/**
|
|
9183
|
-
* Sets
|
|
9184
|
-
* @summary Set
|
|
9285
|
+
* Sets a list of values of a virtual controller inputs/outputs.
|
|
9286
|
+
* @summary Set Input/Ouput Values
|
|
9185
9287
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
9186
9288
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
9187
|
-
* @param {
|
|
9188
|
-
* @param {CoordinateSystem} coordinateSystem
|
|
9289
|
+
* @param {Array<IOValue>} iOValue
|
|
9189
9290
|
* @param {*} [options] Override http request option.
|
|
9190
9291
|
* @throws {RequiredError}
|
|
9191
9292
|
*/
|
|
9192
|
-
|
|
9193
|
-
return localVarFp.
|
|
9293
|
+
setIOValues(cell, controller, iOValue, options) {
|
|
9294
|
+
return localVarFp.setIOValues(cell, controller, iOValue, options).then((request) => request(axios, basePath));
|
|
9194
9295
|
},
|
|
9195
9296
|
};
|
|
9196
9297
|
};
|
|
9197
9298
|
/**
|
|
9198
|
-
*
|
|
9299
|
+
* VirtualControllerInputsOutputsApi - object-oriented interface
|
|
9199
9300
|
* @export
|
|
9200
|
-
* @class
|
|
9301
|
+
* @class VirtualControllerInputsOutputsApi
|
|
9201
9302
|
* @extends {BaseAPI}
|
|
9202
9303
|
*/
|
|
9203
|
-
export class
|
|
9204
|
-
/**
|
|
9205
|
-
* Adds a coordinate system to the robot controller.
|
|
9206
|
-
* @summary Add Coordinate Systems
|
|
9207
|
-
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
9208
|
-
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
9209
|
-
* @param {CoordinateSystem} coordinateSystem
|
|
9210
|
-
* @param {*} [options] Override http request option.
|
|
9211
|
-
* @throws {RequiredError}
|
|
9212
|
-
* @memberof VirtualRobotSetupApi
|
|
9213
|
-
*/
|
|
9214
|
-
addVirtualRobotCoordinateSystem(cell, controller, coordinateSystem, options) {
|
|
9215
|
-
return VirtualRobotSetupApiFp(this.configuration).addVirtualRobotCoordinateSystem(cell, controller, coordinateSystem, options).then((request) => request(this.axios, this.basePath));
|
|
9216
|
-
}
|
|
9217
|
-
/**
|
|
9218
|
-
* Adds a new TCP or updates an existing TCP in the motion group. The position and rotation values in the request body are defined within the flange’s coordinate system. > **NOTE** > > Ensure the TCP\'s position is within the robot\'s reach. Refer to the robot’s documentation or data sheet for details like joint limits or reach.
|
|
9219
|
-
* @summary Add TCP
|
|
9220
|
-
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
9221
|
-
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
9222
|
-
* @param {string} motionGroup The motion-group identifier.
|
|
9223
|
-
* @param {RobotTcp} robotTcp
|
|
9224
|
-
* @param {*} [options] Override http request option.
|
|
9225
|
-
* @throws {RequiredError}
|
|
9226
|
-
* @memberof VirtualRobotSetupApi
|
|
9227
|
-
*/
|
|
9228
|
-
addVirtualRobotTcp(cell, controller, motionGroup, robotTcp, options) {
|
|
9229
|
-
return VirtualRobotSetupApiFp(this.configuration).addVirtualRobotTcp(cell, controller, motionGroup, robotTcp, options).then((request) => request(this.axios, this.basePath));
|
|
9230
|
-
}
|
|
9231
|
-
/**
|
|
9232
|
-
* Deletes a coordinate system from the virtual controller. This will remove the coordinate system from the list of coordinate systems and remove all dependent coordinate systems which use the deleted coordinate system as reference.
|
|
9233
|
-
* @summary Remove Coordinate System
|
|
9234
|
-
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
9235
|
-
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
9236
|
-
* @param {string} coordinateSystem Unique identifier addressing a coordinate system.
|
|
9237
|
-
* @param {boolean} [deleteDependent] If true, all dependent coordinate systems will be deleted as well.
|
|
9238
|
-
* @param {*} [options] Override http request option.
|
|
9239
|
-
* @throws {RequiredError}
|
|
9240
|
-
* @memberof VirtualRobotSetupApi
|
|
9241
|
-
*/
|
|
9242
|
-
deleteVirtualRobotCoordinateSystem(cell, controller, coordinateSystem, deleteDependent, options) {
|
|
9243
|
-
return VirtualRobotSetupApiFp(this.configuration).deleteVirtualRobotCoordinateSystem(cell, controller, coordinateSystem, deleteDependent, options).then((request) => request(this.axios, this.basePath));
|
|
9244
|
-
}
|
|
9245
|
-
/**
|
|
9246
|
-
* Removes the TCP from the motion group. An unknown TCP is a valid input.
|
|
9247
|
-
* @summary Remove TCP
|
|
9248
|
-
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
9249
|
-
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
9250
|
-
* @param {string} motionGroup The motion-group identifier.
|
|
9251
|
-
* @param {string} tcp The unique identifier of a TCP.
|
|
9252
|
-
* @param {*} [options] Override http request option.
|
|
9253
|
-
* @throws {RequiredError}
|
|
9254
|
-
* @memberof VirtualRobotSetupApi
|
|
9255
|
-
*/
|
|
9256
|
-
deleteVirtualRobotTcp(cell, controller, motionGroup, tcp, options) {
|
|
9257
|
-
return VirtualRobotSetupApiFp(this.configuration).deleteVirtualRobotTcp(cell, controller, motionGroup, tcp, options).then((request) => request(this.axios, this.basePath));
|
|
9258
|
-
}
|
|
9259
|
-
/**
|
|
9260
|
-
* Gets motion group mounting. The motion group is based on the origin of the returned coordinate system.
|
|
9261
|
-
* @summary Get Mounting
|
|
9262
|
-
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
9263
|
-
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
9264
|
-
* @param {string} motionGroup The motion-group identifier.
|
|
9265
|
-
* @param {*} [options] Override http request option.
|
|
9266
|
-
* @throws {RequiredError}
|
|
9267
|
-
* @memberof VirtualRobotSetupApi
|
|
9268
|
-
*/
|
|
9269
|
-
getVirtualRobotMounting(cell, controller, motionGroup, options) {
|
|
9270
|
-
return VirtualRobotSetupApiFp(this.configuration).getVirtualRobotMounting(cell, controller, motionGroup, options).then((request) => request(this.axios, this.basePath));
|
|
9271
|
-
}
|
|
9304
|
+
export class VirtualControllerInputsOutputsApi extends BaseAPI {
|
|
9272
9305
|
/**
|
|
9273
|
-
*
|
|
9274
|
-
* @summary
|
|
9306
|
+
* 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).
|
|
9307
|
+
* @summary Get Input/Output Values
|
|
9275
9308
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
9276
9309
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
9310
|
+
* @param {Array<string>} ios
|
|
9277
9311
|
* @param {*} [options] Override http request option.
|
|
9278
9312
|
* @throws {RequiredError}
|
|
9279
|
-
* @memberof
|
|
9313
|
+
* @memberof VirtualControllerInputsOutputsApi
|
|
9280
9314
|
*/
|
|
9281
|
-
|
|
9282
|
-
return
|
|
9315
|
+
listIOs(cell, controller, ios, options) {
|
|
9316
|
+
return VirtualControllerInputsOutputsApiFp(this.configuration).listIOs(cell, controller, ios, options).then((request) => request(this.axios, this.basePath));
|
|
9283
9317
|
}
|
|
9284
9318
|
/**
|
|
9285
|
-
* Lists
|
|
9286
|
-
* @summary List
|
|
9319
|
+
* 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.
|
|
9320
|
+
* @summary List Descriptions
|
|
9287
9321
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
9288
9322
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
9289
|
-
* @param {string}
|
|
9323
|
+
* @param {Array<string>} [ios]
|
|
9324
|
+
* @param {IODirection} [direction] Return only inputs/outputs with the specified direction.
|
|
9325
|
+
* @param {IOValueType} [valueType] Return only inputs/outputs with the specified value type.
|
|
9326
|
+
* @param {string} [group] Return only inputs/outputs from the specified group.
|
|
9290
9327
|
* @param {*} [options] Override http request option.
|
|
9291
9328
|
* @throws {RequiredError}
|
|
9292
|
-
* @memberof
|
|
9329
|
+
* @memberof VirtualControllerInputsOutputsApi
|
|
9293
9330
|
*/
|
|
9294
|
-
|
|
9295
|
-
return
|
|
9331
|
+
listVirtualRobotIODescriptions(cell, controller, ios, direction, valueType, group, options) {
|
|
9332
|
+
return VirtualControllerInputsOutputsApiFp(this.configuration).listVirtualRobotIODescriptions(cell, controller, ios, direction, valueType, group, options).then((request) => request(this.axios, this.basePath));
|
|
9296
9333
|
}
|
|
9297
9334
|
/**
|
|
9298
|
-
* Sets
|
|
9299
|
-
* @summary Set
|
|
9335
|
+
* Sets a list of values of a virtual controller inputs/outputs.
|
|
9336
|
+
* @summary Set Input/Ouput Values
|
|
9300
9337
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
9301
9338
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
9302
|
-
* @param {
|
|
9303
|
-
* @param {CoordinateSystem} coordinateSystem
|
|
9339
|
+
* @param {Array<IOValue>} iOValue
|
|
9304
9340
|
* @param {*} [options] Override http request option.
|
|
9305
9341
|
* @throws {RequiredError}
|
|
9306
|
-
* @memberof
|
|
9342
|
+
* @memberof VirtualControllerInputsOutputsApi
|
|
9307
9343
|
*/
|
|
9308
|
-
|
|
9309
|
-
return
|
|
9344
|
+
setIOValues(cell, controller, iOValue, options) {
|
|
9345
|
+
return VirtualControllerInputsOutputsApiFp(this.configuration).setIOValues(cell, controller, iOValue, options).then((request) => request(this.axios, this.basePath));
|
|
9310
9346
|
}
|
|
9311
9347
|
}
|
|
9312
9348
|
//# sourceMappingURL=api.js.map
|