@wandelbots/nova-api 25.11.0-dev.9 → 26.1.0-dev.40
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/dist/v1/index.cjs +1 -1
- package/dist/v1/index.d.cts +183 -183
- package/dist/v1/index.d.ts +183 -183
- package/dist/v1/index.js +1 -1
- package/dist/v2/index.cjs +198 -6
- package/dist/v2/index.d.cts +191 -27
- package/dist/v2/index.d.ts +191 -27
- package/dist/v2/index.js +198 -7
- package/package.json +1 -1
package/dist/v1/index.js
CHANGED
|
@@ -4752,7 +4752,7 @@ var MotionApi = class extends BaseAPI {
|
|
|
4752
4752
|
return MotionApiFp(this.configuration).planTrajectory(cell, planTrajectoryRequest, options).then((request) => request(this.axios, this.basePath));
|
|
4753
4753
|
}
|
|
4754
4754
|
/**
|
|
4755
|
-
* Stops an active motion gracefully with deceleration until standstill while staying on the planned trajectory. When an active movement is stopped any further update request will be rejected. The active movement
|
|
4755
|
+
* Stops an active motion gracefully with deceleration until standstill while staying on the planned trajectory. When an active movement is stopped any further update request will be rejected. This call will immediately return even if the deceleration is still in progress. The active movement stream returns responses until the robot has reached standstill. Currently it is not possible to restart the motion. Please send in a feature request if you need to restart/continue the motion.
|
|
4756
4756
|
* @summary Stop
|
|
4757
4757
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
4758
4758
|
* @param {string} motion This represents the UUID of a motion. Every executable or partially executable motion is cached and an UUID is returned. Indicate the UUID to execute the motion or retrieve information on the motion.
|
package/dist/v2/index.cjs
CHANGED
|
@@ -92,6 +92,13 @@ const Behavior = {
|
|
|
92
92
|
};
|
|
93
93
|
const BlendingAutoBlendingNameEnum = { BlendingAuto: "BlendingAuto" };
|
|
94
94
|
const BlendingPositionBlendingNameEnum = { BlendingPosition: "BlendingPosition" };
|
|
95
|
+
/**
|
|
96
|
+
* Defines the space in which blending is performed. - `JOINT`: Zone blending is performed in joint space - `CARTESIAN`: Auto-blending is performed in cartesian space
|
|
97
|
+
*/
|
|
98
|
+
const BlendingSpace = {
|
|
99
|
+
Joint: "JOINT",
|
|
100
|
+
Cartesian: "CARTESIAN"
|
|
101
|
+
};
|
|
95
102
|
const BooleanValueValueTypeEnum = { Boolean: "boolean" };
|
|
96
103
|
const BoxShapeTypeEnum = { Box: "box" };
|
|
97
104
|
const BoxBoxTypeEnum = {
|
|
@@ -1013,6 +1020,60 @@ const BUSInputsOutputsApiAxiosParamCreator = function(configuration) {
|
|
|
1013
1020
|
options: localVarRequestOptions
|
|
1014
1021
|
};
|
|
1015
1022
|
},
|
|
1023
|
+
deleteAllModbusIOs: async (cell, options = {}) => {
|
|
1024
|
+
assertParamExists("deleteAllModbusIOs", "cell", cell);
|
|
1025
|
+
const localVarPath = `/cells/{cell}/bus-ios/modbus/ios`.replace(`{cell}`, encodeURIComponent(String(cell)));
|
|
1026
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
1027
|
+
let baseOptions;
|
|
1028
|
+
if (configuration) baseOptions = configuration.baseOptions;
|
|
1029
|
+
const localVarRequestOptions = {
|
|
1030
|
+
method: "DELETE",
|
|
1031
|
+
...baseOptions,
|
|
1032
|
+
...options
|
|
1033
|
+
};
|
|
1034
|
+
const localVarHeaderParameter = {};
|
|
1035
|
+
const localVarQueryParameter = {};
|
|
1036
|
+
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
1037
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
1038
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
1039
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
1040
|
+
localVarRequestOptions.headers = {
|
|
1041
|
+
...localVarHeaderParameter,
|
|
1042
|
+
...headersFromBaseOptions,
|
|
1043
|
+
...options.headers
|
|
1044
|
+
};
|
|
1045
|
+
return {
|
|
1046
|
+
url: toPathString(localVarUrlObj),
|
|
1047
|
+
options: localVarRequestOptions
|
|
1048
|
+
};
|
|
1049
|
+
},
|
|
1050
|
+
deleteAllProfinetIOs: async (cell, options = {}) => {
|
|
1051
|
+
assertParamExists("deleteAllProfinetIOs", "cell", cell);
|
|
1052
|
+
const localVarPath = `/cells/{cell}/bus-ios/profinet/ios`.replace(`{cell}`, encodeURIComponent(String(cell)));
|
|
1053
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
1054
|
+
let baseOptions;
|
|
1055
|
+
if (configuration) baseOptions = configuration.baseOptions;
|
|
1056
|
+
const localVarRequestOptions = {
|
|
1057
|
+
method: "DELETE",
|
|
1058
|
+
...baseOptions,
|
|
1059
|
+
...options
|
|
1060
|
+
};
|
|
1061
|
+
const localVarHeaderParameter = {};
|
|
1062
|
+
const localVarQueryParameter = {};
|
|
1063
|
+
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
1064
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
1065
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
1066
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
1067
|
+
localVarRequestOptions.headers = {
|
|
1068
|
+
...localVarHeaderParameter,
|
|
1069
|
+
...headersFromBaseOptions,
|
|
1070
|
+
...options.headers
|
|
1071
|
+
};
|
|
1072
|
+
return {
|
|
1073
|
+
url: toPathString(localVarUrlObj),
|
|
1074
|
+
options: localVarRequestOptions
|
|
1075
|
+
};
|
|
1076
|
+
},
|
|
1016
1077
|
deleteModbusIO: async (cell, io, options = {}) => {
|
|
1017
1078
|
assertParamExists("deleteModbusIO", "cell", cell);
|
|
1018
1079
|
assertParamExists("deleteModbusIO", "io", io);
|
|
@@ -1380,6 +1441,18 @@ const BUSInputsOutputsApiFp = function(configuration) {
|
|
|
1380
1441
|
const localVarOperationServerBasePath = operationServerMap["BUSInputsOutputsApi.clearBusIOService"]?.[localVarOperationServerIndex]?.url;
|
|
1381
1442
|
return (axios$1, basePath) => createRequestFunction(localVarAxiosArgs, axios.default, BASE_PATH, configuration)(axios$1, localVarOperationServerBasePath || basePath);
|
|
1382
1443
|
},
|
|
1444
|
+
async deleteAllModbusIOs(cell, options) {
|
|
1445
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.deleteAllModbusIOs(cell, options);
|
|
1446
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
1447
|
+
const localVarOperationServerBasePath = operationServerMap["BUSInputsOutputsApi.deleteAllModbusIOs"]?.[localVarOperationServerIndex]?.url;
|
|
1448
|
+
return (axios$1, basePath) => createRequestFunction(localVarAxiosArgs, axios.default, BASE_PATH, configuration)(axios$1, localVarOperationServerBasePath || basePath);
|
|
1449
|
+
},
|
|
1450
|
+
async deleteAllProfinetIOs(cell, options) {
|
|
1451
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.deleteAllProfinetIOs(cell, options);
|
|
1452
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
1453
|
+
const localVarOperationServerBasePath = operationServerMap["BUSInputsOutputsApi.deleteAllProfinetIOs"]?.[localVarOperationServerIndex]?.url;
|
|
1454
|
+
return (axios$1, basePath) => createRequestFunction(localVarAxiosArgs, axios.default, BASE_PATH, configuration)(axios$1, localVarOperationServerBasePath || basePath);
|
|
1455
|
+
},
|
|
1383
1456
|
async deleteModbusIO(cell, io, options) {
|
|
1384
1457
|
const localVarAxiosArgs = await localVarAxiosParamCreator.deleteModbusIO(cell, io, options);
|
|
1385
1458
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
@@ -1472,6 +1545,12 @@ const BUSInputsOutputsApiFactory = function(configuration, basePath, axios$1) {
|
|
|
1472
1545
|
clearBusIOService(cell, completionTimeout, options) {
|
|
1473
1546
|
return localVarFp.clearBusIOService(cell, completionTimeout, options).then((request) => request(axios$1, basePath));
|
|
1474
1547
|
},
|
|
1548
|
+
deleteAllModbusIOs(cell, options) {
|
|
1549
|
+
return localVarFp.deleteAllModbusIOs(cell, options).then((request) => request(axios$1, basePath));
|
|
1550
|
+
},
|
|
1551
|
+
deleteAllProfinetIOs(cell, options) {
|
|
1552
|
+
return localVarFp.deleteAllProfinetIOs(cell, options).then((request) => request(axios$1, basePath));
|
|
1553
|
+
},
|
|
1475
1554
|
deleteModbusIO(cell, io, options) {
|
|
1476
1555
|
return localVarFp.deleteModbusIO(cell, io, options).then((request) => request(axios$1, basePath));
|
|
1477
1556
|
},
|
|
@@ -1562,6 +1641,26 @@ var BUSInputsOutputsApi = class extends BaseAPI {
|
|
|
1562
1641
|
return BUSInputsOutputsApiFp(this.configuration).clearBusIOService(cell, completionTimeout, options).then((request) => request(this.axios, this.basePath));
|
|
1563
1642
|
}
|
|
1564
1643
|
/**
|
|
1644
|
+
* Removes all input/output variable configurations from the MODBUS device, e.g., NOVA\'s MODBUS service.
|
|
1645
|
+
* @summary Remove all MODBUS Input/Outputs
|
|
1646
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
1647
|
+
* @param {*} [options] Override http request option.
|
|
1648
|
+
* @throws {RequiredError}
|
|
1649
|
+
*/
|
|
1650
|
+
deleteAllModbusIOs(cell, options) {
|
|
1651
|
+
return BUSInputsOutputsApiFp(this.configuration).deleteAllModbusIOs(cell, options).then((request) => request(this.axios, this.basePath));
|
|
1652
|
+
}
|
|
1653
|
+
/**
|
|
1654
|
+
* Removes all input/output variable configurations from the PROFINET device, e.g., NOVA\'s PROFINET service.
|
|
1655
|
+
* @summary Remove all PROFINET Input/Outputs
|
|
1656
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
1657
|
+
* @param {*} [options] Override http request option.
|
|
1658
|
+
* @throws {RequiredError}
|
|
1659
|
+
*/
|
|
1660
|
+
deleteAllProfinetIOs(cell, options) {
|
|
1661
|
+
return BUSInputsOutputsApiFp(this.configuration).deleteAllProfinetIOs(cell, options).then((request) => request(this.axios, this.basePath));
|
|
1662
|
+
}
|
|
1663
|
+
/**
|
|
1565
1664
|
* Removes an input/output variable configuration from the MODBUS device, e.g., NOVA\'s MODBUS service.
|
|
1566
1665
|
* @summary Remove MODBUS Input/Ouptut
|
|
1567
1666
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
@@ -3125,7 +3224,7 @@ const JoggingApiFactory = function(configuration, basePath, axios$1) {
|
|
|
3125
3224
|
*/
|
|
3126
3225
|
var JoggingApi = class extends BaseAPI {
|
|
3127
3226
|
/**
|
|
3128
|
-
* <!-- theme: success --> > 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. 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 the 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.
|
|
3227
|
+
* <!-- theme: success --> > 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. 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 the 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. - Commands can only be processed in the cycle rate of the controller - Sending commands faster will not increase the responsiveness of the jogging motion, it will lead to dropped commands - It is recommended to couple sending commands with the (state stream)[streamMotionGroupState], which can be subscribed to via nats as well. #### 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.
|
|
3129
3228
|
* @summary Execute Jogging
|
|
3130
3229
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
3131
3230
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -3685,6 +3784,33 @@ const MotionGroupModelsApiAxiosParamCreator = function(configuration) {
|
|
|
3685
3784
|
options: localVarRequestOptions
|
|
3686
3785
|
};
|
|
3687
3786
|
},
|
|
3787
|
+
getMotionGroupGlbModel: async (motionGroupModel, options = {}) => {
|
|
3788
|
+
assertParamExists("getMotionGroupGlbModel", "motionGroupModel", motionGroupModel);
|
|
3789
|
+
const localVarPath = `/motion-group-models/{motion-group-model}/glb`.replace(`{motion-group-model}`, encodeURIComponent(String(motionGroupModel)));
|
|
3790
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
3791
|
+
let baseOptions;
|
|
3792
|
+
if (configuration) baseOptions = configuration.baseOptions;
|
|
3793
|
+
const localVarRequestOptions = {
|
|
3794
|
+
method: "GET",
|
|
3795
|
+
...baseOptions,
|
|
3796
|
+
...options
|
|
3797
|
+
};
|
|
3798
|
+
const localVarHeaderParameter = {};
|
|
3799
|
+
const localVarQueryParameter = {};
|
|
3800
|
+
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
3801
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
3802
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
3803
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
3804
|
+
localVarRequestOptions.headers = {
|
|
3805
|
+
...localVarHeaderParameter,
|
|
3806
|
+
...headersFromBaseOptions,
|
|
3807
|
+
...options.headers
|
|
3808
|
+
};
|
|
3809
|
+
return {
|
|
3810
|
+
url: toPathString(localVarUrlObj),
|
|
3811
|
+
options: localVarRequestOptions
|
|
3812
|
+
};
|
|
3813
|
+
},
|
|
3688
3814
|
getMotionGroupModels: async (options = {}) => {
|
|
3689
3815
|
const localVarUrlObj = new URL(`/motion-group-models`, DUMMY_BASE_URL);
|
|
3690
3816
|
let baseOptions;
|
|
@@ -3709,6 +3835,33 @@ const MotionGroupModelsApiAxiosParamCreator = function(configuration) {
|
|
|
3709
3835
|
url: toPathString(localVarUrlObj),
|
|
3710
3836
|
options: localVarRequestOptions
|
|
3711
3837
|
};
|
|
3838
|
+
},
|
|
3839
|
+
getMotionGroupUsdModel: async (motionGroupModel, options = {}) => {
|
|
3840
|
+
assertParamExists("getMotionGroupUsdModel", "motionGroupModel", motionGroupModel);
|
|
3841
|
+
const localVarPath = `/motion-group-models/{motion-group-model}/usd`.replace(`{motion-group-model}`, encodeURIComponent(String(motionGroupModel)));
|
|
3842
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
3843
|
+
let baseOptions;
|
|
3844
|
+
if (configuration) baseOptions = configuration.baseOptions;
|
|
3845
|
+
const localVarRequestOptions = {
|
|
3846
|
+
method: "GET",
|
|
3847
|
+
...baseOptions,
|
|
3848
|
+
...options
|
|
3849
|
+
};
|
|
3850
|
+
const localVarHeaderParameter = {};
|
|
3851
|
+
const localVarQueryParameter = {};
|
|
3852
|
+
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
3853
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
3854
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
3855
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
3856
|
+
localVarRequestOptions.headers = {
|
|
3857
|
+
...localVarHeaderParameter,
|
|
3858
|
+
...headersFromBaseOptions,
|
|
3859
|
+
...options.headers
|
|
3860
|
+
};
|
|
3861
|
+
return {
|
|
3862
|
+
url: toPathString(localVarUrlObj),
|
|
3863
|
+
options: localVarRequestOptions
|
|
3864
|
+
};
|
|
3712
3865
|
}
|
|
3713
3866
|
};
|
|
3714
3867
|
};
|
|
@@ -3724,11 +3877,23 @@ const MotionGroupModelsApiFp = function(configuration) {
|
|
|
3724
3877
|
const localVarOperationServerBasePath = operationServerMap["MotionGroupModelsApi.getMotionGroupCollisionModel"]?.[localVarOperationServerIndex]?.url;
|
|
3725
3878
|
return (axios$1, basePath) => createRequestFunction(localVarAxiosArgs, axios.default, BASE_PATH, configuration)(axios$1, localVarOperationServerBasePath || basePath);
|
|
3726
3879
|
},
|
|
3880
|
+
async getMotionGroupGlbModel(motionGroupModel, options) {
|
|
3881
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.getMotionGroupGlbModel(motionGroupModel, options);
|
|
3882
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
3883
|
+
const localVarOperationServerBasePath = operationServerMap["MotionGroupModelsApi.getMotionGroupGlbModel"]?.[localVarOperationServerIndex]?.url;
|
|
3884
|
+
return (axios$1, basePath) => createRequestFunction(localVarAxiosArgs, axios.default, BASE_PATH, configuration)(axios$1, localVarOperationServerBasePath || basePath);
|
|
3885
|
+
},
|
|
3727
3886
|
async getMotionGroupModels(options) {
|
|
3728
3887
|
const localVarAxiosArgs = await localVarAxiosParamCreator.getMotionGroupModels(options);
|
|
3729
3888
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
3730
3889
|
const localVarOperationServerBasePath = operationServerMap["MotionGroupModelsApi.getMotionGroupModels"]?.[localVarOperationServerIndex]?.url;
|
|
3731
3890
|
return (axios$1, basePath) => createRequestFunction(localVarAxiosArgs, axios.default, BASE_PATH, configuration)(axios$1, localVarOperationServerBasePath || basePath);
|
|
3891
|
+
},
|
|
3892
|
+
async getMotionGroupUsdModel(motionGroupModel, options) {
|
|
3893
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.getMotionGroupUsdModel(motionGroupModel, options);
|
|
3894
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
3895
|
+
const localVarOperationServerBasePath = operationServerMap["MotionGroupModelsApi.getMotionGroupUsdModel"]?.[localVarOperationServerIndex]?.url;
|
|
3896
|
+
return (axios$1, basePath) => createRequestFunction(localVarAxiosArgs, axios.default, BASE_PATH, configuration)(axios$1, localVarOperationServerBasePath || basePath);
|
|
3732
3897
|
}
|
|
3733
3898
|
};
|
|
3734
3899
|
};
|
|
@@ -3741,8 +3906,14 @@ const MotionGroupModelsApiFactory = function(configuration, basePath, axios$1) {
|
|
|
3741
3906
|
getMotionGroupCollisionModel(motionGroupModel, options) {
|
|
3742
3907
|
return localVarFp.getMotionGroupCollisionModel(motionGroupModel, options).then((request) => request(axios$1, basePath));
|
|
3743
3908
|
},
|
|
3909
|
+
getMotionGroupGlbModel(motionGroupModel, options) {
|
|
3910
|
+
return localVarFp.getMotionGroupGlbModel(motionGroupModel, options).then((request) => request(axios$1, basePath));
|
|
3911
|
+
},
|
|
3744
3912
|
getMotionGroupModels(options) {
|
|
3745
3913
|
return localVarFp.getMotionGroupModels(options).then((request) => request(axios$1, basePath));
|
|
3914
|
+
},
|
|
3915
|
+
getMotionGroupUsdModel(motionGroupModel, options) {
|
|
3916
|
+
return localVarFp.getMotionGroupUsdModel(motionGroupModel, options).then((request) => request(axios$1, basePath));
|
|
3746
3917
|
}
|
|
3747
3918
|
};
|
|
3748
3919
|
};
|
|
@@ -3761,6 +3932,16 @@ var MotionGroupModelsApi = class extends BaseAPI {
|
|
|
3761
3932
|
return MotionGroupModelsApiFp(this.configuration).getMotionGroupCollisionModel(motionGroupModel, options).then((request) => request(this.axios, this.basePath));
|
|
3762
3933
|
}
|
|
3763
3934
|
/**
|
|
3935
|
+
* Returns the GLB asset for the specified motion group model. See [getMotionGroupModels](getMotionGroupModels) for supported identifiers.
|
|
3936
|
+
* @summary Download GLB Model
|
|
3937
|
+
* @param {string} motionGroupModel Unique identifier for the model of a motion group, e.g., `UniversalRobots_UR10e`. Get the `model` of a configured motion group with [getOptimizerConfiguration](getOptimizerConfiguration).
|
|
3938
|
+
* @param {*} [options] Override http request option.
|
|
3939
|
+
* @throws {RequiredError}
|
|
3940
|
+
*/
|
|
3941
|
+
getMotionGroupGlbModel(motionGroupModel, options) {
|
|
3942
|
+
return MotionGroupModelsApiFp(this.configuration).getMotionGroupGlbModel(motionGroupModel, options).then((request) => request(this.axios, this.basePath));
|
|
3943
|
+
}
|
|
3944
|
+
/**
|
|
3764
3945
|
* Returns the list of supported motion group models.
|
|
3765
3946
|
* @summary Motion Group Models
|
|
3766
3947
|
* @param {*} [options] Override http request option.
|
|
@@ -3769,6 +3950,16 @@ var MotionGroupModelsApi = class extends BaseAPI {
|
|
|
3769
3950
|
getMotionGroupModels(options) {
|
|
3770
3951
|
return MotionGroupModelsApiFp(this.configuration).getMotionGroupModels(options).then((request) => request(this.axios, this.basePath));
|
|
3771
3952
|
}
|
|
3953
|
+
/**
|
|
3954
|
+
* Returns the USD scene model for the specified motion group model. See [getMotionGroupModels](getMotionGroupModels) for supported identifiers.
|
|
3955
|
+
* @summary Download USD Model
|
|
3956
|
+
* @param {string} motionGroupModel Unique identifier for the model of a motion group, e.g., `UniversalRobots_UR10e`. Get the `model` of a configured motion group with [getOptimizerConfiguration](getOptimizerConfiguration).
|
|
3957
|
+
* @param {*} [options] Override http request option.
|
|
3958
|
+
* @throws {RequiredError}
|
|
3959
|
+
*/
|
|
3960
|
+
getMotionGroupUsdModel(motionGroupModel, options) {
|
|
3961
|
+
return MotionGroupModelsApiFp(this.configuration).getMotionGroupUsdModel(motionGroupModel, options).then((request) => request(this.axios, this.basePath));
|
|
3962
|
+
}
|
|
3772
3963
|
};
|
|
3773
3964
|
/**
|
|
3774
3965
|
* ProgramApi - axios parameter creator
|
|
@@ -3948,7 +4139,7 @@ const ProgramApiFactory = function(configuration, basePath, axios$1) {
|
|
|
3948
4139
|
*/
|
|
3949
4140
|
var ProgramApi = class extends BaseAPI {
|
|
3950
4141
|
/**
|
|
3951
|
-
* Get details of a program.
|
|
4142
|
+
* <!-- theme: danger --> > **Experimental** Get details of a program.
|
|
3952
4143
|
* @summary Get program
|
|
3953
4144
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
3954
4145
|
* @param {string} program
|
|
@@ -3959,7 +4150,7 @@ var ProgramApi = class extends BaseAPI {
|
|
|
3959
4150
|
return ProgramApiFp(this.configuration).getProgram(cell, program, options).then((request) => request(this.axios, this.basePath));
|
|
3960
4151
|
}
|
|
3961
4152
|
/**
|
|
3962
|
-
* List details of all existing programs.
|
|
4153
|
+
* <!-- theme: danger --> > **Experimental** List details of all existing programs.
|
|
3963
4154
|
* @summary List programs
|
|
3964
4155
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
3965
4156
|
* @param {*} [options] Override http request option.
|
|
@@ -3969,7 +4160,7 @@ var ProgramApi = class extends BaseAPI {
|
|
|
3969
4160
|
return ProgramApiFp(this.configuration).listPrograms(cell, options).then((request) => request(this.axios, this.basePath));
|
|
3970
4161
|
}
|
|
3971
4162
|
/**
|
|
3972
|
-
* This endpoint starts a new program execution. The program will be executed asynchronously.
|
|
4163
|
+
* <!-- theme: danger --> > **Experimental** This endpoint starts a new program execution. The program will be executed asynchronously.
|
|
3973
4164
|
* @summary Start the program
|
|
3974
4165
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
3975
4166
|
* @param {string} program
|
|
@@ -3981,7 +4172,7 @@ var ProgramApi = class extends BaseAPI {
|
|
|
3981
4172
|
return ProgramApiFp(this.configuration).startProgram(cell, program, programStartRequest, options).then((request) => request(this.axios, this.basePath));
|
|
3982
4173
|
}
|
|
3983
4174
|
/**
|
|
3984
|
-
* Stop a specific program run.
|
|
4175
|
+
* <!-- theme: danger --> > **Experimental** Stop a specific program run.
|
|
3985
4176
|
* @summary Stop program run
|
|
3986
4177
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
3987
4178
|
* @param {string} program
|
|
@@ -6101,7 +6292,7 @@ const TrajectoryExecutionApiFactory = function(configuration, basePath, axios$1)
|
|
|
6101
6292
|
*/
|
|
6102
6293
|
var TrajectoryExecutionApi = class extends BaseAPI {
|
|
6103
6294
|
/**
|
|
6104
|
-
* <!-- theme: success --> > Websocket endpoint Provides execution control over a previously [planned trajectory](planTrajectory). Enables the caller to attach input/output actions to the trajectory. ### Movement behavior | Virtual controller | Physical controller | |------------------|-------------------| | Desired joint configurations are commanded to each motion group and **applied immediately** | Move to desired **actual joint configuration**, **if possible** | ### 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 [planTrajectory](planTrajectory). - 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
|
|
6295
|
+
* <!-- theme: success --> > Websocket endpoint Provides execution control over a previously [planned trajectory](planTrajectory). Enables the caller to attach input/output actions to the trajectory. ### Movement behavior | Virtual controller | Physical controller | |------------------|-------------------| | Desired joint configurations are commanded to each motion group and **applied immediately** | Move to desired **actual joint configuration**, **if possible** | ### 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 [planTrajectory](planTrajectory). - 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. Pausing the current movement enables you to send another `InitializeMovementRequest` to execute another trajectory on the same connection. #### 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 To monitor the state of the movement, listen to the [state stream](streamMotionGroupState). The state is published via nats as well. Field `execute` in the `MotionGroupState` indicates whether a movement is ongoing and carries execution details. Each request has a corresponding acknowledgment response. They signal success or failure of the request. Especially for `PauseMovementResponse`, it does not signal the end of the movement. Additionally, `MovementError` messages can be sent in case of unexpected errors during the execution, 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.
|
|
6105
6296
|
* @summary Execute Trajectory
|
|
6106
6297
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
6107
6298
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -7647,6 +7838,7 @@ exports.BaseAPI = BaseAPI;
|
|
|
7647
7838
|
exports.Behavior = Behavior;
|
|
7648
7839
|
exports.BlendingAutoBlendingNameEnum = BlendingAutoBlendingNameEnum;
|
|
7649
7840
|
exports.BlendingPositionBlendingNameEnum = BlendingPositionBlendingNameEnum;
|
|
7841
|
+
exports.BlendingSpace = BlendingSpace;
|
|
7650
7842
|
exports.BooleanValueValueTypeEnum = BooleanValueValueTypeEnum;
|
|
7651
7843
|
exports.BoxBoxTypeEnum = BoxBoxTypeEnum;
|
|
7652
7844
|
exports.BoxShapeTypeEnum = BoxShapeTypeEnum;
|