@wandelbots/nova-api 25.7.0-dev.25 → 25.7.0-dev.27

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.
Files changed (5) hide show
  1. package/package.json +1 -1
  2. package/v2/api.d.ts +1777 -482
  3. package/v2/api.js +1436 -212
  4. package/v2/api.js.map +1 -1
  5. package/v2/api.ts +2452 -393
package/v2/api.js CHANGED
@@ -46,6 +46,23 @@ export const BoxBoxTypeEnum = {
46
46
  Hollow: 'HOLLOW',
47
47
  Full: 'FULL'
48
48
  };
49
+ export const BusIOProfinetBusTypeEnum = {
50
+ Profinet: 'profinet'
51
+ };
52
+ export const BusIOProfinetVirtualBusTypeEnum = {
53
+ VirtualProfinet: 'virtual_profinet'
54
+ };
55
+ /**
56
+ * Current state of the BUS input/output service.
57
+ * @export
58
+ * @enum {string}
59
+ */
60
+ export const BusIOsStateEnum = {
61
+ BusIosStateUnknown: 'BUS_IOS_STATE_UNKNOWN',
62
+ BusIosStateInitializing: 'BUS_IOS_STATE_INITIALIZING',
63
+ BusIosStateConnected: 'BUS_IOS_STATE_CONNECTED',
64
+ BusIosStateDisconnected: 'BUS_IOS_STATE_DISCONNECTED'
65
+ };
49
66
  export const CapsuleShapeTypeEnum = {
50
67
  Capsule: 'capsule'
51
68
  };
@@ -86,6 +103,18 @@ export const Direction = {
86
103
  DirectionForward: 'DIRECTION_FORWARD',
87
104
  DirectionBackward: 'DIRECTION_BACKWARD'
88
105
  };
106
+ export const ErrorInvalidJointCountErrorFeedbackNameEnum = {
107
+ ErrorInvalidJointCount: 'ErrorInvalidJointCount'
108
+ };
109
+ export const ErrorJointLimitExceededErrorFeedbackNameEnum = {
110
+ ErrorJointLimitExceeded: 'ErrorJointLimitExceeded'
111
+ };
112
+ export const ErrorJointPositionCollisionErrorFeedbackNameEnum = {
113
+ ErrorJointPositionCollision: 'ErrorJointPositionCollision'
114
+ };
115
+ export const ErrorMaxIterationsExceededErrorFeedbackNameEnum = {
116
+ ErrorMaxIterationsExceeded: 'ErrorMaxIterationsExceeded'
117
+ };
89
118
  export const FanucControllerKindEnum = {
90
119
  FanucController: 'FanucController'
91
120
  };
@@ -198,6 +227,9 @@ export const Manufacturer = {
198
227
  Universalrobots: 'universalrobots',
199
228
  Yaskawa: 'yaskawa'
200
229
  };
230
+ export const MidpointInsertionAlgorithmAlgorithmNameEnum = {
231
+ MidpointInsertionAlgorithm: 'MidpointInsertionAlgorithm'
232
+ };
201
233
  export const MovementErrorResponseKindEnum = {
202
234
  MotionError: 'MOTION_ERROR'
203
235
  };
@@ -296,6 +328,36 @@ export const PlaybackSpeedRequestMessageTypeEnum = {
296
328
  export const PlaybackSpeedResponseKindEnum = {
297
329
  PlaybackSpeedReceived: 'PLAYBACK_SPEED_RECEIVED'
298
330
  };
331
+ /**
332
+ * Identifies the input/output type.
333
+ * @export
334
+ * @enum {string}
335
+ */
336
+ export const ProfinetIODirection = {
337
+ ProfinetIoDirectionInput: 'PROFINET_IO_DIRECTION_INPUT',
338
+ ProfinetIoDirectionOutput: 'PROFINET_IO_DIRECTION_OUTPUT',
339
+ ProfinetIoDirectionInout: 'PROFINET_IO_DIRECTION_INOUT'
340
+ };
341
+ /**
342
+ * Value type of the PROFINET input/output.
343
+ * @export
344
+ * @enum {string}
345
+ */
346
+ export const ProfinetIOTypeEnum = {
347
+ ProfinetIoTypeUnknown: 'PROFINET_IO_TYPE_UNKNOWN',
348
+ ProfinetIoTypeBool: 'PROFINET_IO_TYPE_BOOL',
349
+ ProfinetIoTypeUsint: 'PROFINET_IO_TYPE_USINT',
350
+ ProfinetIoTypeSint: 'PROFINET_IO_TYPE_SINT',
351
+ ProfinetIoTypeUint: 'PROFINET_IO_TYPE_UINT',
352
+ ProfinetIoTypeInt: 'PROFINET_IO_TYPE_INT',
353
+ ProfinetIoTypeUdint: 'PROFINET_IO_TYPE_UDINT',
354
+ ProfinetIoTypeDint: 'PROFINET_IO_TYPE_DINT',
355
+ ProfinetIoTypeReal: 'PROFINET_IO_TYPE_REAL',
356
+ ProfinetIoTypeLreal: 'PROFINET_IO_TYPE_LREAL'
357
+ };
358
+ export const RRTConnectAlgorithmAlgorithmNameEnum = {
359
+ RrtConnectAlgorithm: 'RRTConnectAlgorithm'
360
+ };
299
361
  export const RectangleShapeTypeEnum = {
300
362
  Rectangle: 'rectangle'
301
363
  };
@@ -914,189 +976,1201 @@ export const ApplicationApiFp = function (configuration) {
914
976
  * @param {*} [options] Override http request option.
915
977
  * @throws {RequiredError}
916
978
  */
917
- async listApps(cell, options) {
918
- const localVarAxiosArgs = await localVarAxiosParamCreator.listApps(cell, options);
919
- const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
920
- const localVarOperationServerBasePath = operationServerMap['ApplicationApi.listApps']?.[localVarOperationServerIndex]?.url;
921
- return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
979
+ async listApps(cell, options) {
980
+ const localVarAxiosArgs = await localVarAxiosParamCreator.listApps(cell, options);
981
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
982
+ const localVarOperationServerBasePath = operationServerMap['ApplicationApi.listApps']?.[localVarOperationServerIndex]?.url;
983
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
984
+ },
985
+ /**
986
+ * Update the configuration of a GUI application in the cell.
987
+ * @summary Update Configuration
988
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
989
+ * @param {string} app
990
+ * @param {App} app2
991
+ * @param {number} [completionTimeout]
992
+ * @param {*} [options] Override http request option.
993
+ * @throws {RequiredError}
994
+ */
995
+ async updateApp(cell, app, app2, completionTimeout, options) {
996
+ const localVarAxiosArgs = await localVarAxiosParamCreator.updateApp(cell, app, app2, completionTimeout, options);
997
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
998
+ const localVarOperationServerBasePath = operationServerMap['ApplicationApi.updateApp']?.[localVarOperationServerIndex]?.url;
999
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
1000
+ },
1001
+ };
1002
+ };
1003
+ /**
1004
+ * ApplicationApi - factory interface
1005
+ * @export
1006
+ */
1007
+ export const ApplicationApiFactory = function (configuration, basePath, axios) {
1008
+ const localVarFp = ApplicationApiFp(configuration);
1009
+ return {
1010
+ /**
1011
+ * Install a basic, containerized web application to the cell to control robots with a customized frontend. Prerequisites: A Docker hub account or similar container registry account, with valid credentials. After adding the application to the cell, open the application on the Wandelbots NOVA home screen. Read [build your application](/docs/docs/development/) for more information. <!-- theme: none --> > #### Predefined Environment Variables > - `NOVA_API`: The API endpoint accessible from within the application container. > - `NATS_BROKER`: The NATS broker endpoint accessible from within the application container. > - `BASE_PATH`: The application\'s root path, accessible at http://$host/$BASE_PATH > - `CELL_NAME`: The name of the cell hosting the deployed application.
1012
+ * @summary Add Application
1013
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
1014
+ * @param {App} app
1015
+ * @param {number} [completionTimeout]
1016
+ * @param {*} [options] Override http request option.
1017
+ * @throws {RequiredError}
1018
+ */
1019
+ addApp(cell, app, completionTimeout, options) {
1020
+ return localVarFp.addApp(cell, app, completionTimeout, options).then((request) => request(axios, basePath));
1021
+ },
1022
+ /**
1023
+ * Delete all GUI applications from the cell.
1024
+ * @summary Clear Applications
1025
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
1026
+ * @param {number} [completionTimeout]
1027
+ * @param {*} [options] Override http request option.
1028
+ * @throws {RequiredError}
1029
+ */
1030
+ clearApps(cell, completionTimeout, options) {
1031
+ return localVarFp.clearApps(cell, completionTimeout, options).then((request) => request(axios, basePath));
1032
+ },
1033
+ /**
1034
+ * Delete a GUI application from the cell.
1035
+ * @summary Delete Application
1036
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
1037
+ * @param {string} app
1038
+ * @param {number} [completionTimeout]
1039
+ * @param {*} [options] Override http request option.
1040
+ * @throws {RequiredError}
1041
+ */
1042
+ deleteApp(cell, app, completionTimeout, options) {
1043
+ return localVarFp.deleteApp(cell, app, completionTimeout, options).then((request) => request(axios, basePath));
1044
+ },
1045
+ /**
1046
+ * Get the configuration for an active GUI application in the cell. To update the configuration of a GUI application in the cell, use this configuration with the \'Update Configuration\' endpoint.
1047
+ * @summary Configuration
1048
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
1049
+ * @param {string} app
1050
+ * @param {*} [options] Override http request option.
1051
+ * @throws {RequiredError}
1052
+ */
1053
+ getApp(cell, app, options) {
1054
+ return localVarFp.getApp(cell, app, options).then((request) => request(axios, basePath));
1055
+ },
1056
+ /**
1057
+ * List all GUI applications that have been added to a cell. with the \'Add Application\' endpoint. If the cell does not contain GUI applications, the list is returned empty.
1058
+ * @summary List Applications
1059
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
1060
+ * @param {*} [options] Override http request option.
1061
+ * @throws {RequiredError}
1062
+ */
1063
+ listApps(cell, options) {
1064
+ return localVarFp.listApps(cell, options).then((request) => request(axios, basePath));
1065
+ },
1066
+ /**
1067
+ * Update the configuration of a GUI application in the cell.
1068
+ * @summary Update Configuration
1069
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
1070
+ * @param {string} app
1071
+ * @param {App} app2
1072
+ * @param {number} [completionTimeout]
1073
+ * @param {*} [options] Override http request option.
1074
+ * @throws {RequiredError}
1075
+ */
1076
+ updateApp(cell, app, app2, completionTimeout, options) {
1077
+ return localVarFp.updateApp(cell, app, app2, completionTimeout, options).then((request) => request(axios, basePath));
1078
+ },
1079
+ };
1080
+ };
1081
+ /**
1082
+ * ApplicationApi - object-oriented interface
1083
+ * @export
1084
+ * @class ApplicationApi
1085
+ * @extends {BaseAPI}
1086
+ */
1087
+ export class ApplicationApi extends BaseAPI {
1088
+ /**
1089
+ * Install a basic, containerized web application to the cell to control robots with a customized frontend. Prerequisites: A Docker hub account or similar container registry account, with valid credentials. After adding the application to the cell, open the application on the Wandelbots NOVA home screen. Read [build your application](/docs/docs/development/) for more information. <!-- theme: none --> > #### Predefined Environment Variables > - `NOVA_API`: The API endpoint accessible from within the application container. > - `NATS_BROKER`: The NATS broker endpoint accessible from within the application container. > - `BASE_PATH`: The application\'s root path, accessible at http://$host/$BASE_PATH > - `CELL_NAME`: The name of the cell hosting the deployed application.
1090
+ * @summary Add Application
1091
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
1092
+ * @param {App} app
1093
+ * @param {number} [completionTimeout]
1094
+ * @param {*} [options] Override http request option.
1095
+ * @throws {RequiredError}
1096
+ * @memberof ApplicationApi
1097
+ */
1098
+ addApp(cell, app, completionTimeout, options) {
1099
+ return ApplicationApiFp(this.configuration).addApp(cell, app, completionTimeout, options).then((request) => request(this.axios, this.basePath));
1100
+ }
1101
+ /**
1102
+ * Delete all GUI applications from the cell.
1103
+ * @summary Clear Applications
1104
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
1105
+ * @param {number} [completionTimeout]
1106
+ * @param {*} [options] Override http request option.
1107
+ * @throws {RequiredError}
1108
+ * @memberof ApplicationApi
1109
+ */
1110
+ clearApps(cell, completionTimeout, options) {
1111
+ return ApplicationApiFp(this.configuration).clearApps(cell, completionTimeout, options).then((request) => request(this.axios, this.basePath));
1112
+ }
1113
+ /**
1114
+ * Delete a GUI application from the cell.
1115
+ * @summary Delete Application
1116
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
1117
+ * @param {string} app
1118
+ * @param {number} [completionTimeout]
1119
+ * @param {*} [options] Override http request option.
1120
+ * @throws {RequiredError}
1121
+ * @memberof ApplicationApi
1122
+ */
1123
+ deleteApp(cell, app, completionTimeout, options) {
1124
+ return ApplicationApiFp(this.configuration).deleteApp(cell, app, completionTimeout, options).then((request) => request(this.axios, this.basePath));
1125
+ }
1126
+ /**
1127
+ * Get the configuration for an active GUI application in the cell. To update the configuration of a GUI application in the cell, use this configuration with the \'Update Configuration\' endpoint.
1128
+ * @summary Configuration
1129
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
1130
+ * @param {string} app
1131
+ * @param {*} [options] Override http request option.
1132
+ * @throws {RequiredError}
1133
+ * @memberof ApplicationApi
1134
+ */
1135
+ getApp(cell, app, options) {
1136
+ return ApplicationApiFp(this.configuration).getApp(cell, app, options).then((request) => request(this.axios, this.basePath));
1137
+ }
1138
+ /**
1139
+ * List all GUI applications that have been added to a cell. with the \'Add Application\' endpoint. If the cell does not contain GUI applications, the list is returned empty.
1140
+ * @summary List Applications
1141
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
1142
+ * @param {*} [options] Override http request option.
1143
+ * @throws {RequiredError}
1144
+ * @memberof ApplicationApi
1145
+ */
1146
+ listApps(cell, options) {
1147
+ return ApplicationApiFp(this.configuration).listApps(cell, options).then((request) => request(this.axios, this.basePath));
1148
+ }
1149
+ /**
1150
+ * Update the configuration of a GUI application in the cell.
1151
+ * @summary Update Configuration
1152
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
1153
+ * @param {string} app
1154
+ * @param {App} app2
1155
+ * @param {number} [completionTimeout]
1156
+ * @param {*} [options] Override http request option.
1157
+ * @throws {RequiredError}
1158
+ * @memberof ApplicationApi
1159
+ */
1160
+ updateApp(cell, app, app2, completionTimeout, options) {
1161
+ return ApplicationApiFp(this.configuration).updateApp(cell, app, app2, completionTimeout, options).then((request) => request(this.axios, this.basePath));
1162
+ }
1163
+ }
1164
+ /**
1165
+ * BUSInputsOutputsApi - axios parameter creator
1166
+ * @export
1167
+ */
1168
+ export const BUSInputsOutputsApiAxiosParamCreator = function (configuration) {
1169
+ return {
1170
+ /**
1171
+ * Add a BUS Inputs/Outputs Service to the cell.
1172
+ * @summary Add Service
1173
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
1174
+ * @param {BusIOType} busIOType
1175
+ * @param {number} [completionTimeout]
1176
+ * @param {*} [options] Override http request option.
1177
+ * @throws {RequiredError}
1178
+ */
1179
+ addBusIOService: async (cell, busIOType, completionTimeout, options = {}) => {
1180
+ // verify required parameter 'cell' is not null or undefined
1181
+ assertParamExists('addBusIOService', 'cell', cell);
1182
+ // verify required parameter 'busIOType' is not null or undefined
1183
+ assertParamExists('addBusIOService', 'busIOType', busIOType);
1184
+ const localVarPath = `/cells/{cell}/bus-ios`
1185
+ .replace(`{${"cell"}}`, encodeURIComponent(String(cell)));
1186
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
1187
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
1188
+ let baseOptions;
1189
+ if (configuration) {
1190
+ baseOptions = configuration.baseOptions;
1191
+ }
1192
+ const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options };
1193
+ const localVarHeaderParameter = {};
1194
+ const localVarQueryParameter = {};
1195
+ // authentication BasicAuth required
1196
+ // http basic authentication required
1197
+ setBasicAuthToObject(localVarRequestOptions, configuration);
1198
+ // authentication BearerAuth required
1199
+ // http bearer authentication required
1200
+ await setBearerAuthToObject(localVarHeaderParameter, configuration);
1201
+ if (completionTimeout !== undefined) {
1202
+ localVarQueryParameter['completion_timeout'] = completionTimeout;
1203
+ }
1204
+ localVarHeaderParameter['Content-Type'] = 'application/json';
1205
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
1206
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
1207
+ localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
1208
+ localVarRequestOptions.data = serializeDataIfNeeded(busIOType, localVarRequestOptions, configuration);
1209
+ return {
1210
+ url: toPathString(localVarUrlObj),
1211
+ options: localVarRequestOptions,
1212
+ };
1213
+ },
1214
+ /**
1215
+ * Adds an input/output to or updates an input/output on the PROFINET device.
1216
+ * @summary Add PROFINET Input/Output
1217
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
1218
+ * @param {string} io Unique identifier to address an Input/Output in the cell.
1219
+ * @param {ProfinetIOData} profinetIOData
1220
+ * @param {*} [options] Override http request option.
1221
+ * @throws {RequiredError}
1222
+ */
1223
+ addProfinetIO: async (cell, io, profinetIOData, options = {}) => {
1224
+ // verify required parameter 'cell' is not null or undefined
1225
+ assertParamExists('addProfinetIO', 'cell', cell);
1226
+ // verify required parameter 'io' is not null or undefined
1227
+ assertParamExists('addProfinetIO', 'io', io);
1228
+ // verify required parameter 'profinetIOData' is not null or undefined
1229
+ assertParamExists('addProfinetIO', 'profinetIOData', profinetIOData);
1230
+ const localVarPath = `/cells/{cell}/bus-ios/profinet/ios/{io}`
1231
+ .replace(`{${"cell"}}`, encodeURIComponent(String(cell)))
1232
+ .replace(`{${"io"}}`, encodeURIComponent(String(io)));
1233
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
1234
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
1235
+ let baseOptions;
1236
+ if (configuration) {
1237
+ baseOptions = configuration.baseOptions;
1238
+ }
1239
+ const localVarRequestOptions = { method: 'PUT', ...baseOptions, ...options };
1240
+ const localVarHeaderParameter = {};
1241
+ const localVarQueryParameter = {};
1242
+ // authentication BasicAuth required
1243
+ // http basic authentication required
1244
+ setBasicAuthToObject(localVarRequestOptions, configuration);
1245
+ // authentication BearerAuth required
1246
+ // http bearer authentication required
1247
+ await setBearerAuthToObject(localVarHeaderParameter, configuration);
1248
+ localVarHeaderParameter['Content-Type'] = 'application/json';
1249
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
1250
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
1251
+ localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
1252
+ localVarRequestOptions.data = serializeDataIfNeeded(profinetIOData, localVarRequestOptions, configuration);
1253
+ return {
1254
+ url: toPathString(localVarUrlObj),
1255
+ options: localVarRequestOptions,
1256
+ };
1257
+ },
1258
+ /**
1259
+ * Delete BUS Inputs/Outputs Service from the cell.
1260
+ * @summary Clear Service
1261
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
1262
+ * @param {number} [completionTimeout]
1263
+ * @param {*} [options] Override http request option.
1264
+ * @throws {RequiredError}
1265
+ */
1266
+ clearBusIOService: async (cell, completionTimeout, options = {}) => {
1267
+ // verify required parameter 'cell' is not null or undefined
1268
+ assertParamExists('clearBusIOService', 'cell', cell);
1269
+ const localVarPath = `/cells/{cell}/bus-ios`
1270
+ .replace(`{${"cell"}}`, encodeURIComponent(String(cell)));
1271
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
1272
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
1273
+ let baseOptions;
1274
+ if (configuration) {
1275
+ baseOptions = configuration.baseOptions;
1276
+ }
1277
+ const localVarRequestOptions = { method: 'DELETE', ...baseOptions, ...options };
1278
+ const localVarHeaderParameter = {};
1279
+ const localVarQueryParameter = {};
1280
+ // authentication BasicAuth required
1281
+ // http basic authentication required
1282
+ setBasicAuthToObject(localVarRequestOptions, configuration);
1283
+ // authentication BearerAuth required
1284
+ // http bearer authentication required
1285
+ await setBearerAuthToObject(localVarHeaderParameter, configuration);
1286
+ if (completionTimeout !== undefined) {
1287
+ localVarQueryParameter['completion_timeout'] = completionTimeout;
1288
+ }
1289
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
1290
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
1291
+ localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
1292
+ return {
1293
+ url: toPathString(localVarUrlObj),
1294
+ options: localVarRequestOptions,
1295
+ };
1296
+ },
1297
+ /**
1298
+ * Removes the input/output from the PROFINET device.
1299
+ * @summary Remove PROFINET Input/Ouptut
1300
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
1301
+ * @param {string} io Unique identifier to address an Input/Output in the cell.
1302
+ * @param {*} [options] Override http request option.
1303
+ * @throws {RequiredError}
1304
+ */
1305
+ deleteProfinetIO: async (cell, io, options = {}) => {
1306
+ // verify required parameter 'cell' is not null or undefined
1307
+ assertParamExists('deleteProfinetIO', 'cell', cell);
1308
+ // verify required parameter 'io' is not null or undefined
1309
+ assertParamExists('deleteProfinetIO', 'io', io);
1310
+ const localVarPath = `/cells/{cell}/bus-ios/profinet/ios/{io}`
1311
+ .replace(`{${"cell"}}`, encodeURIComponent(String(cell)))
1312
+ .replace(`{${"io"}}`, encodeURIComponent(String(io)));
1313
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
1314
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
1315
+ let baseOptions;
1316
+ if (configuration) {
1317
+ baseOptions = configuration.baseOptions;
1318
+ }
1319
+ const localVarRequestOptions = { method: 'DELETE', ...baseOptions, ...options };
1320
+ const localVarHeaderParameter = {};
1321
+ const localVarQueryParameter = {};
1322
+ // authentication BasicAuth required
1323
+ // http basic authentication required
1324
+ setBasicAuthToObject(localVarRequestOptions, configuration);
1325
+ // authentication BearerAuth required
1326
+ // http bearer authentication required
1327
+ await setBearerAuthToObject(localVarHeaderParameter, configuration);
1328
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
1329
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
1330
+ localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
1331
+ return {
1332
+ url: toPathString(localVarUrlObj),
1333
+ options: localVarRequestOptions,
1334
+ };
1335
+ },
1336
+ /**
1337
+ * Get deployed BUS Inputs/Outputs Service.
1338
+ * @summary Get Service
1339
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
1340
+ * @param {*} [options] Override http request option.
1341
+ * @throws {RequiredError}
1342
+ */
1343
+ getBusIOService: async (cell, options = {}) => {
1344
+ // verify required parameter 'cell' is not null or undefined
1345
+ assertParamExists('getBusIOService', 'cell', cell);
1346
+ const localVarPath = `/cells/{cell}/bus-ios`
1347
+ .replace(`{${"cell"}}`, encodeURIComponent(String(cell)));
1348
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
1349
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
1350
+ let baseOptions;
1351
+ if (configuration) {
1352
+ baseOptions = configuration.baseOptions;
1353
+ }
1354
+ const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options };
1355
+ const localVarHeaderParameter = {};
1356
+ const localVarQueryParameter = {};
1357
+ // authentication BasicAuth required
1358
+ // http basic authentication required
1359
+ setBasicAuthToObject(localVarRequestOptions, configuration);
1360
+ // authentication BearerAuth required
1361
+ // http bearer authentication required
1362
+ await setBearerAuthToObject(localVarHeaderParameter, configuration);
1363
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
1364
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
1365
+ localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
1366
+ return {
1367
+ url: toPathString(localVarUrlObj),
1368
+ options: localVarRequestOptions,
1369
+ };
1370
+ },
1371
+ /**
1372
+ * Get the current state of the BUS Inputs/Outputs service.
1373
+ * @summary State
1374
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
1375
+ * @param {*} [options] Override http request option.
1376
+ * @throws {RequiredError}
1377
+ */
1378
+ getBusIOState: async (cell, options = {}) => {
1379
+ // verify required parameter 'cell' is not null or undefined
1380
+ assertParamExists('getBusIOState', 'cell', cell);
1381
+ const localVarPath = `/cells/{cell}/bus-ios/state`
1382
+ .replace(`{${"cell"}}`, encodeURIComponent(String(cell)));
1383
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
1384
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
1385
+ let baseOptions;
1386
+ if (configuration) {
1387
+ baseOptions = configuration.baseOptions;
1388
+ }
1389
+ const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options };
1390
+ const localVarHeaderParameter = {};
1391
+ const localVarQueryParameter = {};
1392
+ // authentication BasicAuth required
1393
+ // http basic authentication required
1394
+ setBasicAuthToObject(localVarRequestOptions, configuration);
1395
+ // authentication BearerAuth required
1396
+ // http bearer authentication required
1397
+ await setBearerAuthToObject(localVarHeaderParameter, configuration);
1398
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
1399
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
1400
+ localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
1401
+ return {
1402
+ url: toPathString(localVarUrlObj),
1403
+ options: localVarRequestOptions,
1404
+ };
1405
+ },
1406
+ /**
1407
+ * Retrieves the current values of inputs/outputs. The identifiers of the inputs/outputs must be provided in the request. Request all available input/output identifiers via [listBusIODescriptions](listBusIODescriptions).
1408
+ * @summary Get Input/Output Values
1409
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
1410
+ * @param {Array<string>} [ios]
1411
+ * @param {*} [options] Override http request option.
1412
+ * @throws {RequiredError}
1413
+ */
1414
+ getBusIOValues: async (cell, ios, options = {}) => {
1415
+ // verify required parameter 'cell' is not null or undefined
1416
+ assertParamExists('getBusIOValues', 'cell', cell);
1417
+ const localVarPath = `/cells/{cell}/bus-ios/ios/values`
1418
+ .replace(`{${"cell"}}`, encodeURIComponent(String(cell)));
1419
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
1420
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
1421
+ let baseOptions;
1422
+ if (configuration) {
1423
+ baseOptions = configuration.baseOptions;
1424
+ }
1425
+ const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options };
1426
+ const localVarHeaderParameter = {};
1427
+ const localVarQueryParameter = {};
1428
+ // authentication BasicAuth required
1429
+ // http basic authentication required
1430
+ setBasicAuthToObject(localVarRequestOptions, configuration);
1431
+ // authentication BearerAuth required
1432
+ // http bearer authentication required
1433
+ await setBearerAuthToObject(localVarHeaderParameter, configuration);
1434
+ if (ios) {
1435
+ localVarQueryParameter['ios'] = ios;
1436
+ }
1437
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
1438
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
1439
+ localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
1440
+ return {
1441
+ url: toPathString(localVarUrlObj),
1442
+ options: localVarRequestOptions,
1443
+ };
1444
+ },
1445
+ /**
1446
+ * Get description of PROFINET
1447
+ * @summary Get PROFINET Description
1448
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
1449
+ * @param {*} [options] Override http request option.
1450
+ * @throws {RequiredError}
1451
+ */
1452
+ getProfinetDescription: async (cell, options = {}) => {
1453
+ // verify required parameter 'cell' is not null or undefined
1454
+ assertParamExists('getProfinetDescription', 'cell', cell);
1455
+ const localVarPath = `/cells/{cell}/bus-ios/profinet/description`
1456
+ .replace(`{${"cell"}}`, encodeURIComponent(String(cell)));
1457
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
1458
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
1459
+ let baseOptions;
1460
+ if (configuration) {
1461
+ baseOptions = configuration.baseOptions;
1462
+ }
1463
+ const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options };
1464
+ const localVarHeaderParameter = {};
1465
+ const localVarQueryParameter = {};
1466
+ // authentication BasicAuth required
1467
+ // http basic authentication required
1468
+ setBasicAuthToObject(localVarRequestOptions, configuration);
1469
+ // authentication BearerAuth required
1470
+ // http bearer authentication required
1471
+ await setBearerAuthToObject(localVarHeaderParameter, configuration);
1472
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
1473
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
1474
+ localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
1475
+ return {
1476
+ url: toPathString(localVarUrlObj),
1477
+ options: localVarRequestOptions,
1478
+ };
1479
+ },
1480
+ /**
1481
+ * Get input/output configuration of the PROFINET device as file.
1482
+ * @summary PROFINET Inputs/Outputs to File
1483
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
1484
+ * @param {number} [inputOffset]
1485
+ * @param {number} [outputOffset]
1486
+ * @param {*} [options] Override http request option.
1487
+ * @throws {RequiredError}
1488
+ */
1489
+ getProfinetIOsFromFile: async (cell, inputOffset, outputOffset, options = {}) => {
1490
+ // verify required parameter 'cell' is not null or undefined
1491
+ assertParamExists('getProfinetIOsFromFile', 'cell', cell);
1492
+ const localVarPath = `/cells/{cell}/bus-ios/profinet/iofile`
1493
+ .replace(`{${"cell"}}`, encodeURIComponent(String(cell)));
1494
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
1495
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
1496
+ let baseOptions;
1497
+ if (configuration) {
1498
+ baseOptions = configuration.baseOptions;
1499
+ }
1500
+ const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options };
1501
+ const localVarHeaderParameter = {};
1502
+ const localVarQueryParameter = {};
1503
+ // authentication BasicAuth required
1504
+ // http basic authentication required
1505
+ setBasicAuthToObject(localVarRequestOptions, configuration);
1506
+ // authentication BearerAuth required
1507
+ // http bearer authentication required
1508
+ await setBearerAuthToObject(localVarHeaderParameter, configuration);
1509
+ if (inputOffset !== undefined) {
1510
+ localVarQueryParameter['input_offset'] = inputOffset;
1511
+ }
1512
+ if (outputOffset !== undefined) {
1513
+ localVarQueryParameter['output_offset'] = outputOffset;
1514
+ }
1515
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
1516
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
1517
+ localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
1518
+ return {
1519
+ url: toPathString(localVarUrlObj),
1520
+ options: localVarRequestOptions,
1521
+ };
1522
+ },
1523
+ /**
1524
+ * List all BUS Input/Output descriptions.
1525
+ * @summary List Descriptions
1526
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
1527
+ * @param {*} [options] Override http request option.
1528
+ * @throws {RequiredError}
1529
+ */
1530
+ listBusIODescriptions: async (cell, options = {}) => {
1531
+ // verify required parameter 'cell' is not null or undefined
1532
+ assertParamExists('listBusIODescriptions', 'cell', cell);
1533
+ const localVarPath = `/cells/{cell}/bus-ios/ios/description`
1534
+ .replace(`{${"cell"}}`, encodeURIComponent(String(cell)));
1535
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
1536
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
1537
+ let baseOptions;
1538
+ if (configuration) {
1539
+ baseOptions = configuration.baseOptions;
1540
+ }
1541
+ const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options };
1542
+ const localVarHeaderParameter = {};
1543
+ const localVarQueryParameter = {};
1544
+ // authentication BasicAuth required
1545
+ // http basic authentication required
1546
+ setBasicAuthToObject(localVarRequestOptions, configuration);
1547
+ // authentication BearerAuth required
1548
+ // http bearer authentication required
1549
+ await setBearerAuthToObject(localVarHeaderParameter, configuration);
1550
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
1551
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
1552
+ localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
1553
+ return {
1554
+ url: toPathString(localVarUrlObj),
1555
+ options: localVarRequestOptions,
1556
+ };
1557
+ },
1558
+ /**
1559
+ * List all PROFINET input and outputs.
1560
+ * @summary List PROFINET Input/Output Configuration
1561
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
1562
+ * @param {*} [options] Override http request option.
1563
+ * @throws {RequiredError}
1564
+ */
1565
+ listProfinetIOs: async (cell, options = {}) => {
1566
+ // verify required parameter 'cell' is not null or undefined
1567
+ assertParamExists('listProfinetIOs', 'cell', cell);
1568
+ const localVarPath = `/cells/{cell}/bus-ios/profinet/ios`
1569
+ .replace(`{${"cell"}}`, encodeURIComponent(String(cell)));
1570
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
1571
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
1572
+ let baseOptions;
1573
+ if (configuration) {
1574
+ baseOptions = configuration.baseOptions;
1575
+ }
1576
+ const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options };
1577
+ const localVarHeaderParameter = {};
1578
+ const localVarQueryParameter = {};
1579
+ // authentication BasicAuth required
1580
+ // http basic authentication required
1581
+ setBasicAuthToObject(localVarRequestOptions, configuration);
1582
+ // authentication BearerAuth required
1583
+ // http bearer authentication required
1584
+ await setBearerAuthToObject(localVarHeaderParameter, configuration);
1585
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
1586
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
1587
+ localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
1588
+ return {
1589
+ url: toPathString(localVarUrlObj),
1590
+ options: localVarRequestOptions,
1591
+ };
1592
+ },
1593
+ /**
1594
+ * Set values of outputs. In case of virtual Bus Input/Outputs, also inputs can be set. All available output identifiers can be requested via [listBusIODescriptions](listBusIODescriptions). The call will return once the values have been set and accepted by the service.
1595
+ * @summary Set Output Values
1596
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
1597
+ * @param {Array<IOValue>} iOValue
1598
+ * @param {*} [options] Override http request option.
1599
+ * @throws {RequiredError}
1600
+ */
1601
+ setBusIOValues: async (cell, iOValue, options = {}) => {
1602
+ // verify required parameter 'cell' is not null or undefined
1603
+ assertParamExists('setBusIOValues', 'cell', cell);
1604
+ // verify required parameter 'iOValue' is not null or undefined
1605
+ assertParamExists('setBusIOValues', 'iOValue', iOValue);
1606
+ const localVarPath = `/cells/{cell}/bus-ios/ios/values`
1607
+ .replace(`{${"cell"}}`, encodeURIComponent(String(cell)));
1608
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
1609
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
1610
+ let baseOptions;
1611
+ if (configuration) {
1612
+ baseOptions = configuration.baseOptions;
1613
+ }
1614
+ const localVarRequestOptions = { method: 'PUT', ...baseOptions, ...options };
1615
+ const localVarHeaderParameter = {};
1616
+ const localVarQueryParameter = {};
1617
+ // authentication BasicAuth required
1618
+ // http basic authentication required
1619
+ setBasicAuthToObject(localVarRequestOptions, configuration);
1620
+ // authentication BearerAuth required
1621
+ // http bearer authentication required
1622
+ await setBearerAuthToObject(localVarHeaderParameter, configuration);
1623
+ localVarHeaderParameter['Content-Type'] = 'application/json';
1624
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
1625
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
1626
+ localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
1627
+ localVarRequestOptions.data = serializeDataIfNeeded(iOValue, localVarRequestOptions, configuration);
1628
+ return {
1629
+ url: toPathString(localVarUrlObj),
1630
+ options: localVarRequestOptions,
1631
+ };
1632
+ },
1633
+ /**
1634
+ * Sets inputs/outputs on the PROFINET device from file.
1635
+ * @summary Set PROFINET Inputs/Outputs from File
1636
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
1637
+ * @param {ProfinetInputOutputConfig} profinetInputOutputConfig
1638
+ * @param {*} [options] Override http request option.
1639
+ * @throws {RequiredError}
1640
+ */
1641
+ setProfinetIOsFromFile: async (cell, profinetInputOutputConfig, options = {}) => {
1642
+ // verify required parameter 'cell' is not null or undefined
1643
+ assertParamExists('setProfinetIOsFromFile', 'cell', cell);
1644
+ // verify required parameter 'profinetInputOutputConfig' is not null or undefined
1645
+ assertParamExists('setProfinetIOsFromFile', 'profinetInputOutputConfig', profinetInputOutputConfig);
1646
+ const localVarPath = `/cells/{cell}/bus-ios/profinet/iofile`
1647
+ .replace(`{${"cell"}}`, encodeURIComponent(String(cell)));
1648
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
1649
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
1650
+ let baseOptions;
1651
+ if (configuration) {
1652
+ baseOptions = configuration.baseOptions;
1653
+ }
1654
+ const localVarRequestOptions = { method: 'PUT', ...baseOptions, ...options };
1655
+ const localVarHeaderParameter = {};
1656
+ const localVarQueryParameter = {};
1657
+ // authentication BasicAuth required
1658
+ // http basic authentication required
1659
+ setBasicAuthToObject(localVarRequestOptions, configuration);
1660
+ // authentication BearerAuth required
1661
+ // http bearer authentication required
1662
+ await setBearerAuthToObject(localVarHeaderParameter, configuration);
1663
+ localVarHeaderParameter['Content-Type'] = 'application/json';
1664
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
1665
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
1666
+ localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
1667
+ localVarRequestOptions.data = serializeDataIfNeeded(profinetInputOutputConfig, localVarRequestOptions, configuration);
1668
+ return {
1669
+ url: toPathString(localVarUrlObj),
1670
+ options: localVarRequestOptions,
1671
+ };
1672
+ },
1673
+ };
1674
+ };
1675
+ /**
1676
+ * BUSInputsOutputsApi - functional programming interface
1677
+ * @export
1678
+ */
1679
+ export const BUSInputsOutputsApiFp = function (configuration) {
1680
+ const localVarAxiosParamCreator = BUSInputsOutputsApiAxiosParamCreator(configuration);
1681
+ return {
1682
+ /**
1683
+ * Add a BUS Inputs/Outputs Service to the cell.
1684
+ * @summary Add Service
1685
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
1686
+ * @param {BusIOType} busIOType
1687
+ * @param {number} [completionTimeout]
1688
+ * @param {*} [options] Override http request option.
1689
+ * @throws {RequiredError}
1690
+ */
1691
+ async addBusIOService(cell, busIOType, completionTimeout, options) {
1692
+ const localVarAxiosArgs = await localVarAxiosParamCreator.addBusIOService(cell, busIOType, completionTimeout, options);
1693
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
1694
+ const localVarOperationServerBasePath = operationServerMap['BUSInputsOutputsApi.addBusIOService']?.[localVarOperationServerIndex]?.url;
1695
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
1696
+ },
1697
+ /**
1698
+ * Adds an input/output to or updates an input/output on the PROFINET device.
1699
+ * @summary Add PROFINET Input/Output
1700
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
1701
+ * @param {string} io Unique identifier to address an Input/Output in the cell.
1702
+ * @param {ProfinetIOData} profinetIOData
1703
+ * @param {*} [options] Override http request option.
1704
+ * @throws {RequiredError}
1705
+ */
1706
+ async addProfinetIO(cell, io, profinetIOData, options) {
1707
+ const localVarAxiosArgs = await localVarAxiosParamCreator.addProfinetIO(cell, io, profinetIOData, options);
1708
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
1709
+ const localVarOperationServerBasePath = operationServerMap['BUSInputsOutputsApi.addProfinetIO']?.[localVarOperationServerIndex]?.url;
1710
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
1711
+ },
1712
+ /**
1713
+ * Delete BUS Inputs/Outputs Service from the cell.
1714
+ * @summary Clear Service
1715
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
1716
+ * @param {number} [completionTimeout]
1717
+ * @param {*} [options] Override http request option.
1718
+ * @throws {RequiredError}
1719
+ */
1720
+ async clearBusIOService(cell, completionTimeout, options) {
1721
+ const localVarAxiosArgs = await localVarAxiosParamCreator.clearBusIOService(cell, completionTimeout, options);
1722
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
1723
+ const localVarOperationServerBasePath = operationServerMap['BUSInputsOutputsApi.clearBusIOService']?.[localVarOperationServerIndex]?.url;
1724
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
1725
+ },
1726
+ /**
1727
+ * Removes the input/output from the PROFINET device.
1728
+ * @summary Remove PROFINET Input/Ouptut
1729
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
1730
+ * @param {string} io Unique identifier to address an Input/Output in the cell.
1731
+ * @param {*} [options] Override http request option.
1732
+ * @throws {RequiredError}
1733
+ */
1734
+ async deleteProfinetIO(cell, io, options) {
1735
+ const localVarAxiosArgs = await localVarAxiosParamCreator.deleteProfinetIO(cell, io, options);
1736
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
1737
+ const localVarOperationServerBasePath = operationServerMap['BUSInputsOutputsApi.deleteProfinetIO']?.[localVarOperationServerIndex]?.url;
1738
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
1739
+ },
1740
+ /**
1741
+ * Get deployed BUS Inputs/Outputs Service.
1742
+ * @summary Get Service
1743
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
1744
+ * @param {*} [options] Override http request option.
1745
+ * @throws {RequiredError}
1746
+ */
1747
+ async getBusIOService(cell, options) {
1748
+ const localVarAxiosArgs = await localVarAxiosParamCreator.getBusIOService(cell, options);
1749
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
1750
+ const localVarOperationServerBasePath = operationServerMap['BUSInputsOutputsApi.getBusIOService']?.[localVarOperationServerIndex]?.url;
1751
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
1752
+ },
1753
+ /**
1754
+ * Get the current state of the BUS Inputs/Outputs service.
1755
+ * @summary State
1756
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
1757
+ * @param {*} [options] Override http request option.
1758
+ * @throws {RequiredError}
1759
+ */
1760
+ async getBusIOState(cell, options) {
1761
+ const localVarAxiosArgs = await localVarAxiosParamCreator.getBusIOState(cell, options);
1762
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
1763
+ const localVarOperationServerBasePath = operationServerMap['BUSInputsOutputsApi.getBusIOState']?.[localVarOperationServerIndex]?.url;
1764
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
1765
+ },
1766
+ /**
1767
+ * Retrieves the current values of inputs/outputs. The identifiers of the inputs/outputs must be provided in the request. Request all available input/output identifiers via [listBusIODescriptions](listBusIODescriptions).
1768
+ * @summary Get Input/Output Values
1769
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
1770
+ * @param {Array<string>} [ios]
1771
+ * @param {*} [options] Override http request option.
1772
+ * @throws {RequiredError}
1773
+ */
1774
+ async getBusIOValues(cell, ios, options) {
1775
+ const localVarAxiosArgs = await localVarAxiosParamCreator.getBusIOValues(cell, ios, options);
1776
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
1777
+ const localVarOperationServerBasePath = operationServerMap['BUSInputsOutputsApi.getBusIOValues']?.[localVarOperationServerIndex]?.url;
1778
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
1779
+ },
1780
+ /**
1781
+ * Get description of PROFINET
1782
+ * @summary Get PROFINET Description
1783
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
1784
+ * @param {*} [options] Override http request option.
1785
+ * @throws {RequiredError}
1786
+ */
1787
+ async getProfinetDescription(cell, options) {
1788
+ const localVarAxiosArgs = await localVarAxiosParamCreator.getProfinetDescription(cell, options);
1789
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
1790
+ const localVarOperationServerBasePath = operationServerMap['BUSInputsOutputsApi.getProfinetDescription']?.[localVarOperationServerIndex]?.url;
1791
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
1792
+ },
1793
+ /**
1794
+ * Get input/output configuration of the PROFINET device as file.
1795
+ * @summary PROFINET Inputs/Outputs to File
1796
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
1797
+ * @param {number} [inputOffset]
1798
+ * @param {number} [outputOffset]
1799
+ * @param {*} [options] Override http request option.
1800
+ * @throws {RequiredError}
1801
+ */
1802
+ async getProfinetIOsFromFile(cell, inputOffset, outputOffset, options) {
1803
+ const localVarAxiosArgs = await localVarAxiosParamCreator.getProfinetIOsFromFile(cell, inputOffset, outputOffset, options);
1804
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
1805
+ const localVarOperationServerBasePath = operationServerMap['BUSInputsOutputsApi.getProfinetIOsFromFile']?.[localVarOperationServerIndex]?.url;
1806
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
1807
+ },
1808
+ /**
1809
+ * List all BUS Input/Output descriptions.
1810
+ * @summary List Descriptions
1811
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
1812
+ * @param {*} [options] Override http request option.
1813
+ * @throws {RequiredError}
1814
+ */
1815
+ async listBusIODescriptions(cell, options) {
1816
+ const localVarAxiosArgs = await localVarAxiosParamCreator.listBusIODescriptions(cell, options);
1817
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
1818
+ const localVarOperationServerBasePath = operationServerMap['BUSInputsOutputsApi.listBusIODescriptions']?.[localVarOperationServerIndex]?.url;
1819
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
1820
+ },
1821
+ /**
1822
+ * List all PROFINET input and outputs.
1823
+ * @summary List PROFINET Input/Output Configuration
1824
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
1825
+ * @param {*} [options] Override http request option.
1826
+ * @throws {RequiredError}
1827
+ */
1828
+ async listProfinetIOs(cell, options) {
1829
+ const localVarAxiosArgs = await localVarAxiosParamCreator.listProfinetIOs(cell, options);
1830
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
1831
+ const localVarOperationServerBasePath = operationServerMap['BUSInputsOutputsApi.listProfinetIOs']?.[localVarOperationServerIndex]?.url;
1832
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
1833
+ },
1834
+ /**
1835
+ * Set values of outputs. In case of virtual Bus Input/Outputs, also inputs can be set. All available output identifiers can be requested via [listBusIODescriptions](listBusIODescriptions). The call will return once the values have been set and accepted by the service.
1836
+ * @summary Set Output Values
1837
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
1838
+ * @param {Array<IOValue>} iOValue
1839
+ * @param {*} [options] Override http request option.
1840
+ * @throws {RequiredError}
1841
+ */
1842
+ async setBusIOValues(cell, iOValue, options) {
1843
+ const localVarAxiosArgs = await localVarAxiosParamCreator.setBusIOValues(cell, iOValue, options);
1844
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
1845
+ const localVarOperationServerBasePath = operationServerMap['BUSInputsOutputsApi.setBusIOValues']?.[localVarOperationServerIndex]?.url;
1846
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
1847
+ },
1848
+ /**
1849
+ * Sets inputs/outputs on the PROFINET device from file.
1850
+ * @summary Set PROFINET Inputs/Outputs from File
1851
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
1852
+ * @param {ProfinetInputOutputConfig} profinetInputOutputConfig
1853
+ * @param {*} [options] Override http request option.
1854
+ * @throws {RequiredError}
1855
+ */
1856
+ async setProfinetIOsFromFile(cell, profinetInputOutputConfig, options) {
1857
+ const localVarAxiosArgs = await localVarAxiosParamCreator.setProfinetIOsFromFile(cell, profinetInputOutputConfig, options);
1858
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
1859
+ const localVarOperationServerBasePath = operationServerMap['BUSInputsOutputsApi.setProfinetIOsFromFile']?.[localVarOperationServerIndex]?.url;
1860
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
1861
+ },
1862
+ };
1863
+ };
1864
+ /**
1865
+ * BUSInputsOutputsApi - factory interface
1866
+ * @export
1867
+ */
1868
+ export const BUSInputsOutputsApiFactory = function (configuration, basePath, axios) {
1869
+ const localVarFp = BUSInputsOutputsApiFp(configuration);
1870
+ return {
1871
+ /**
1872
+ * Add a BUS Inputs/Outputs Service to the cell.
1873
+ * @summary Add Service
1874
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
1875
+ * @param {BusIOType} busIOType
1876
+ * @param {number} [completionTimeout]
1877
+ * @param {*} [options] Override http request option.
1878
+ * @throws {RequiredError}
1879
+ */
1880
+ addBusIOService(cell, busIOType, completionTimeout, options) {
1881
+ return localVarFp.addBusIOService(cell, busIOType, completionTimeout, options).then((request) => request(axios, basePath));
1882
+ },
1883
+ /**
1884
+ * Adds an input/output to or updates an input/output on the PROFINET device.
1885
+ * @summary Add PROFINET Input/Output
1886
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
1887
+ * @param {string} io Unique identifier to address an Input/Output in the cell.
1888
+ * @param {ProfinetIOData} profinetIOData
1889
+ * @param {*} [options] Override http request option.
1890
+ * @throws {RequiredError}
1891
+ */
1892
+ addProfinetIO(cell, io, profinetIOData, options) {
1893
+ return localVarFp.addProfinetIO(cell, io, profinetIOData, options).then((request) => request(axios, basePath));
1894
+ },
1895
+ /**
1896
+ * Delete BUS Inputs/Outputs Service from the cell.
1897
+ * @summary Clear Service
1898
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
1899
+ * @param {number} [completionTimeout]
1900
+ * @param {*} [options] Override http request option.
1901
+ * @throws {RequiredError}
1902
+ */
1903
+ clearBusIOService(cell, completionTimeout, options) {
1904
+ return localVarFp.clearBusIOService(cell, completionTimeout, options).then((request) => request(axios, basePath));
1905
+ },
1906
+ /**
1907
+ * Removes the input/output from the PROFINET device.
1908
+ * @summary Remove PROFINET Input/Ouptut
1909
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
1910
+ * @param {string} io Unique identifier to address an Input/Output in the cell.
1911
+ * @param {*} [options] Override http request option.
1912
+ * @throws {RequiredError}
1913
+ */
1914
+ deleteProfinetIO(cell, io, options) {
1915
+ return localVarFp.deleteProfinetIO(cell, io, options).then((request) => request(axios, basePath));
1916
+ },
1917
+ /**
1918
+ * Get deployed BUS Inputs/Outputs Service.
1919
+ * @summary Get Service
1920
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
1921
+ * @param {*} [options] Override http request option.
1922
+ * @throws {RequiredError}
1923
+ */
1924
+ getBusIOService(cell, options) {
1925
+ return localVarFp.getBusIOService(cell, options).then((request) => request(axios, basePath));
1926
+ },
1927
+ /**
1928
+ * Get the current state of the BUS Inputs/Outputs service.
1929
+ * @summary State
1930
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
1931
+ * @param {*} [options] Override http request option.
1932
+ * @throws {RequiredError}
1933
+ */
1934
+ getBusIOState(cell, options) {
1935
+ return localVarFp.getBusIOState(cell, options).then((request) => request(axios, basePath));
922
1936
  },
923
1937
  /**
924
- * Update the configuration of a GUI application in the cell.
925
- * @summary Update Configuration
1938
+ * Retrieves the current values of inputs/outputs. The identifiers of the inputs/outputs must be provided in the request. Request all available input/output identifiers via [listBusIODescriptions](listBusIODescriptions).
1939
+ * @summary Get Input/Output Values
926
1940
  * @param {string} cell Unique identifier addressing a cell in all API calls.
927
- * @param {string} app
928
- * @param {App} app2
929
- * @param {number} [completionTimeout]
1941
+ * @param {Array<string>} [ios]
930
1942
  * @param {*} [options] Override http request option.
931
1943
  * @throws {RequiredError}
932
1944
  */
933
- async updateApp(cell, app, app2, completionTimeout, options) {
934
- const localVarAxiosArgs = await localVarAxiosParamCreator.updateApp(cell, app, app2, completionTimeout, options);
935
- const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
936
- const localVarOperationServerBasePath = operationServerMap['ApplicationApi.updateApp']?.[localVarOperationServerIndex]?.url;
937
- return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
1945
+ getBusIOValues(cell, ios, options) {
1946
+ return localVarFp.getBusIOValues(cell, ios, options).then((request) => request(axios, basePath));
938
1947
  },
939
- };
940
- };
941
- /**
942
- * ApplicationApi - factory interface
943
- * @export
944
- */
945
- export const ApplicationApiFactory = function (configuration, basePath, axios) {
946
- const localVarFp = ApplicationApiFp(configuration);
947
- return {
948
1948
  /**
949
- * Install a basic, containerized web application to the cell to control robots with a customized frontend. Prerequisites: A Docker hub account or similar container registry account, with valid credentials. After adding the application to the cell, open the application on the Wandelbots NOVA home screen. Read [build your application](/docs/docs/development/) for more information. <!-- theme: none --> > #### Predefined Environment Variables > - `NOVA_API`: The API endpoint accessible from within the application container. > - `NATS_BROKER`: The NATS broker endpoint accessible from within the application container. > - `BASE_PATH`: The application\'s root path, accessible at http://$host/$BASE_PATH > - `CELL_NAME`: The name of the cell hosting the deployed application.
950
- * @summary Add Application
1949
+ * Get description of PROFINET
1950
+ * @summary Get PROFINET Description
951
1951
  * @param {string} cell Unique identifier addressing a cell in all API calls.
952
- * @param {App} app
953
- * @param {number} [completionTimeout]
954
1952
  * @param {*} [options] Override http request option.
955
1953
  * @throws {RequiredError}
956
1954
  */
957
- addApp(cell, app, completionTimeout, options) {
958
- return localVarFp.addApp(cell, app, completionTimeout, options).then((request) => request(axios, basePath));
1955
+ getProfinetDescription(cell, options) {
1956
+ return localVarFp.getProfinetDescription(cell, options).then((request) => request(axios, basePath));
959
1957
  },
960
1958
  /**
961
- * Delete all GUI applications from the cell.
962
- * @summary Clear Applications
1959
+ * Get input/output configuration of the PROFINET device as file.
1960
+ * @summary PROFINET Inputs/Outputs to File
963
1961
  * @param {string} cell Unique identifier addressing a cell in all API calls.
964
- * @param {number} [completionTimeout]
1962
+ * @param {number} [inputOffset]
1963
+ * @param {number} [outputOffset]
965
1964
  * @param {*} [options] Override http request option.
966
1965
  * @throws {RequiredError}
967
1966
  */
968
- clearApps(cell, completionTimeout, options) {
969
- return localVarFp.clearApps(cell, completionTimeout, options).then((request) => request(axios, basePath));
1967
+ getProfinetIOsFromFile(cell, inputOffset, outputOffset, options) {
1968
+ return localVarFp.getProfinetIOsFromFile(cell, inputOffset, outputOffset, options).then((request) => request(axios, basePath));
970
1969
  },
971
1970
  /**
972
- * Delete a GUI application from the cell.
973
- * @summary Delete Application
1971
+ * List all BUS Input/Output descriptions.
1972
+ * @summary List Descriptions
974
1973
  * @param {string} cell Unique identifier addressing a cell in all API calls.
975
- * @param {string} app
976
- * @param {number} [completionTimeout]
977
1974
  * @param {*} [options] Override http request option.
978
1975
  * @throws {RequiredError}
979
1976
  */
980
- deleteApp(cell, app, completionTimeout, options) {
981
- return localVarFp.deleteApp(cell, app, completionTimeout, options).then((request) => request(axios, basePath));
1977
+ listBusIODescriptions(cell, options) {
1978
+ return localVarFp.listBusIODescriptions(cell, options).then((request) => request(axios, basePath));
982
1979
  },
983
1980
  /**
984
- * Get the configuration for an active GUI application in the cell. To update the configuration of a GUI application in the cell, use this configuration with the \'Update Configuration\' endpoint.
985
- * @summary Configuration
1981
+ * List all PROFINET input and outputs.
1982
+ * @summary List PROFINET Input/Output Configuration
986
1983
  * @param {string} cell Unique identifier addressing a cell in all API calls.
987
- * @param {string} app
988
1984
  * @param {*} [options] Override http request option.
989
1985
  * @throws {RequiredError}
990
1986
  */
991
- getApp(cell, app, options) {
992
- return localVarFp.getApp(cell, app, options).then((request) => request(axios, basePath));
1987
+ listProfinetIOs(cell, options) {
1988
+ return localVarFp.listProfinetIOs(cell, options).then((request) => request(axios, basePath));
993
1989
  },
994
1990
  /**
995
- * List all GUI applications that have been added to a cell. with the \'Add Application\' endpoint. If the cell does not contain GUI applications, the list is returned empty.
996
- * @summary List Applications
1991
+ * Set values of outputs. In case of virtual Bus Input/Outputs, also inputs can be set. All available output identifiers can be requested via [listBusIODescriptions](listBusIODescriptions). The call will return once the values have been set and accepted by the service.
1992
+ * @summary Set Output Values
997
1993
  * @param {string} cell Unique identifier addressing a cell in all API calls.
1994
+ * @param {Array<IOValue>} iOValue
998
1995
  * @param {*} [options] Override http request option.
999
1996
  * @throws {RequiredError}
1000
1997
  */
1001
- listApps(cell, options) {
1002
- return localVarFp.listApps(cell, options).then((request) => request(axios, basePath));
1998
+ setBusIOValues(cell, iOValue, options) {
1999
+ return localVarFp.setBusIOValues(cell, iOValue, options).then((request) => request(axios, basePath));
1003
2000
  },
1004
2001
  /**
1005
- * Update the configuration of a GUI application in the cell.
1006
- * @summary Update Configuration
2002
+ * Sets inputs/outputs on the PROFINET device from file.
2003
+ * @summary Set PROFINET Inputs/Outputs from File
1007
2004
  * @param {string} cell Unique identifier addressing a cell in all API calls.
1008
- * @param {string} app
1009
- * @param {App} app2
1010
- * @param {number} [completionTimeout]
2005
+ * @param {ProfinetInputOutputConfig} profinetInputOutputConfig
1011
2006
  * @param {*} [options] Override http request option.
1012
2007
  * @throws {RequiredError}
1013
2008
  */
1014
- updateApp(cell, app, app2, completionTimeout, options) {
1015
- return localVarFp.updateApp(cell, app, app2, completionTimeout, options).then((request) => request(axios, basePath));
2009
+ setProfinetIOsFromFile(cell, profinetInputOutputConfig, options) {
2010
+ return localVarFp.setProfinetIOsFromFile(cell, profinetInputOutputConfig, options).then((request) => request(axios, basePath));
1016
2011
  },
1017
2012
  };
1018
2013
  };
1019
2014
  /**
1020
- * ApplicationApi - object-oriented interface
2015
+ * BUSInputsOutputsApi - object-oriented interface
1021
2016
  * @export
1022
- * @class ApplicationApi
2017
+ * @class BUSInputsOutputsApi
1023
2018
  * @extends {BaseAPI}
1024
2019
  */
1025
- export class ApplicationApi extends BaseAPI {
2020
+ export class BUSInputsOutputsApi extends BaseAPI {
1026
2021
  /**
1027
- * Install a basic, containerized web application to the cell to control robots with a customized frontend. Prerequisites: A Docker hub account or similar container registry account, with valid credentials. After adding the application to the cell, open the application on the Wandelbots NOVA home screen. Read [build your application](/docs/docs/development/) for more information. <!-- theme: none --> > #### Predefined Environment Variables > - `NOVA_API`: The API endpoint accessible from within the application container. > - `NATS_BROKER`: The NATS broker endpoint accessible from within the application container. > - `BASE_PATH`: The application\'s root path, accessible at http://$host/$BASE_PATH > - `CELL_NAME`: The name of the cell hosting the deployed application.
1028
- * @summary Add Application
2022
+ * Add a BUS Inputs/Outputs Service to the cell.
2023
+ * @summary Add Service
1029
2024
  * @param {string} cell Unique identifier addressing a cell in all API calls.
1030
- * @param {App} app
2025
+ * @param {BusIOType} busIOType
1031
2026
  * @param {number} [completionTimeout]
1032
2027
  * @param {*} [options] Override http request option.
1033
2028
  * @throws {RequiredError}
1034
- * @memberof ApplicationApi
2029
+ * @memberof BUSInputsOutputsApi
1035
2030
  */
1036
- addApp(cell, app, completionTimeout, options) {
1037
- return ApplicationApiFp(this.configuration).addApp(cell, app, completionTimeout, options).then((request) => request(this.axios, this.basePath));
2031
+ addBusIOService(cell, busIOType, completionTimeout, options) {
2032
+ return BUSInputsOutputsApiFp(this.configuration).addBusIOService(cell, busIOType, completionTimeout, options).then((request) => request(this.axios, this.basePath));
1038
2033
  }
1039
2034
  /**
1040
- * Delete all GUI applications from the cell.
1041
- * @summary Clear Applications
2035
+ * Adds an input/output to or updates an input/output on the PROFINET device.
2036
+ * @summary Add PROFINET Input/Output
1042
2037
  * @param {string} cell Unique identifier addressing a cell in all API calls.
1043
- * @param {number} [completionTimeout]
2038
+ * @param {string} io Unique identifier to address an Input/Output in the cell.
2039
+ * @param {ProfinetIOData} profinetIOData
1044
2040
  * @param {*} [options] Override http request option.
1045
2041
  * @throws {RequiredError}
1046
- * @memberof ApplicationApi
2042
+ * @memberof BUSInputsOutputsApi
1047
2043
  */
1048
- clearApps(cell, completionTimeout, options) {
1049
- return ApplicationApiFp(this.configuration).clearApps(cell, completionTimeout, options).then((request) => request(this.axios, this.basePath));
2044
+ addProfinetIO(cell, io, profinetIOData, options) {
2045
+ return BUSInputsOutputsApiFp(this.configuration).addProfinetIO(cell, io, profinetIOData, options).then((request) => request(this.axios, this.basePath));
1050
2046
  }
1051
2047
  /**
1052
- * Delete a GUI application from the cell.
1053
- * @summary Delete Application
2048
+ * Delete BUS Inputs/Outputs Service from the cell.
2049
+ * @summary Clear Service
1054
2050
  * @param {string} cell Unique identifier addressing a cell in all API calls.
1055
- * @param {string} app
1056
2051
  * @param {number} [completionTimeout]
1057
2052
  * @param {*} [options] Override http request option.
1058
2053
  * @throws {RequiredError}
1059
- * @memberof ApplicationApi
2054
+ * @memberof BUSInputsOutputsApi
1060
2055
  */
1061
- deleteApp(cell, app, completionTimeout, options) {
1062
- return ApplicationApiFp(this.configuration).deleteApp(cell, app, completionTimeout, options).then((request) => request(this.axios, this.basePath));
2056
+ clearBusIOService(cell, completionTimeout, options) {
2057
+ return BUSInputsOutputsApiFp(this.configuration).clearBusIOService(cell, completionTimeout, options).then((request) => request(this.axios, this.basePath));
1063
2058
  }
1064
2059
  /**
1065
- * Get the configuration for an active GUI application in the cell. To update the configuration of a GUI application in the cell, use this configuration with the \'Update Configuration\' endpoint.
1066
- * @summary Configuration
2060
+ * Removes the input/output from the PROFINET device.
2061
+ * @summary Remove PROFINET Input/Ouptut
1067
2062
  * @param {string} cell Unique identifier addressing a cell in all API calls.
1068
- * @param {string} app
2063
+ * @param {string} io Unique identifier to address an Input/Output in the cell.
1069
2064
  * @param {*} [options] Override http request option.
1070
2065
  * @throws {RequiredError}
1071
- * @memberof ApplicationApi
2066
+ * @memberof BUSInputsOutputsApi
1072
2067
  */
1073
- getApp(cell, app, options) {
1074
- return ApplicationApiFp(this.configuration).getApp(cell, app, options).then((request) => request(this.axios, this.basePath));
2068
+ deleteProfinetIO(cell, io, options) {
2069
+ return BUSInputsOutputsApiFp(this.configuration).deleteProfinetIO(cell, io, options).then((request) => request(this.axios, this.basePath));
1075
2070
  }
1076
2071
  /**
1077
- * List all GUI applications that have been added to a cell. with the \'Add Application\' endpoint. If the cell does not contain GUI applications, the list is returned empty.
1078
- * @summary List Applications
2072
+ * Get deployed BUS Inputs/Outputs Service.
2073
+ * @summary Get Service
1079
2074
  * @param {string} cell Unique identifier addressing a cell in all API calls.
1080
2075
  * @param {*} [options] Override http request option.
1081
2076
  * @throws {RequiredError}
1082
- * @memberof ApplicationApi
2077
+ * @memberof BUSInputsOutputsApi
1083
2078
  */
1084
- listApps(cell, options) {
1085
- return ApplicationApiFp(this.configuration).listApps(cell, options).then((request) => request(this.axios, this.basePath));
2079
+ getBusIOService(cell, options) {
2080
+ return BUSInputsOutputsApiFp(this.configuration).getBusIOService(cell, options).then((request) => request(this.axios, this.basePath));
1086
2081
  }
1087
2082
  /**
1088
- * Update the configuration of a GUI application in the cell.
1089
- * @summary Update Configuration
2083
+ * Get the current state of the BUS Inputs/Outputs service.
2084
+ * @summary State
1090
2085
  * @param {string} cell Unique identifier addressing a cell in all API calls.
1091
- * @param {string} app
1092
- * @param {App} app2
1093
- * @param {number} [completionTimeout]
1094
2086
  * @param {*} [options] Override http request option.
1095
2087
  * @throws {RequiredError}
1096
- * @memberof ApplicationApi
2088
+ * @memberof BUSInputsOutputsApi
1097
2089
  */
1098
- updateApp(cell, app, app2, completionTimeout, options) {
1099
- return ApplicationApiFp(this.configuration).updateApp(cell, app, app2, completionTimeout, options).then((request) => request(this.axios, this.basePath));
2090
+ getBusIOState(cell, options) {
2091
+ return BUSInputsOutputsApiFp(this.configuration).getBusIOState(cell, options).then((request) => request(this.axios, this.basePath));
2092
+ }
2093
+ /**
2094
+ * Retrieves the current values of inputs/outputs. The identifiers of the inputs/outputs must be provided in the request. Request all available input/output identifiers via [listBusIODescriptions](listBusIODescriptions).
2095
+ * @summary Get Input/Output Values
2096
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
2097
+ * @param {Array<string>} [ios]
2098
+ * @param {*} [options] Override http request option.
2099
+ * @throws {RequiredError}
2100
+ * @memberof BUSInputsOutputsApi
2101
+ */
2102
+ getBusIOValues(cell, ios, options) {
2103
+ return BUSInputsOutputsApiFp(this.configuration).getBusIOValues(cell, ios, options).then((request) => request(this.axios, this.basePath));
2104
+ }
2105
+ /**
2106
+ * Get description of PROFINET
2107
+ * @summary Get PROFINET Description
2108
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
2109
+ * @param {*} [options] Override http request option.
2110
+ * @throws {RequiredError}
2111
+ * @memberof BUSInputsOutputsApi
2112
+ */
2113
+ getProfinetDescription(cell, options) {
2114
+ return BUSInputsOutputsApiFp(this.configuration).getProfinetDescription(cell, options).then((request) => request(this.axios, this.basePath));
2115
+ }
2116
+ /**
2117
+ * Get input/output configuration of the PROFINET device as file.
2118
+ * @summary PROFINET Inputs/Outputs to File
2119
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
2120
+ * @param {number} [inputOffset]
2121
+ * @param {number} [outputOffset]
2122
+ * @param {*} [options] Override http request option.
2123
+ * @throws {RequiredError}
2124
+ * @memberof BUSInputsOutputsApi
2125
+ */
2126
+ getProfinetIOsFromFile(cell, inputOffset, outputOffset, options) {
2127
+ return BUSInputsOutputsApiFp(this.configuration).getProfinetIOsFromFile(cell, inputOffset, outputOffset, options).then((request) => request(this.axios, this.basePath));
2128
+ }
2129
+ /**
2130
+ * List all BUS Input/Output descriptions.
2131
+ * @summary List Descriptions
2132
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
2133
+ * @param {*} [options] Override http request option.
2134
+ * @throws {RequiredError}
2135
+ * @memberof BUSInputsOutputsApi
2136
+ */
2137
+ listBusIODescriptions(cell, options) {
2138
+ return BUSInputsOutputsApiFp(this.configuration).listBusIODescriptions(cell, options).then((request) => request(this.axios, this.basePath));
2139
+ }
2140
+ /**
2141
+ * List all PROFINET input and outputs.
2142
+ * @summary List PROFINET Input/Output Configuration
2143
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
2144
+ * @param {*} [options] Override http request option.
2145
+ * @throws {RequiredError}
2146
+ * @memberof BUSInputsOutputsApi
2147
+ */
2148
+ listProfinetIOs(cell, options) {
2149
+ return BUSInputsOutputsApiFp(this.configuration).listProfinetIOs(cell, options).then((request) => request(this.axios, this.basePath));
2150
+ }
2151
+ /**
2152
+ * Set values of outputs. In case of virtual Bus Input/Outputs, also inputs can be set. All available output identifiers can be requested via [listBusIODescriptions](listBusIODescriptions). The call will return once the values have been set and accepted by the service.
2153
+ * @summary Set Output Values
2154
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
2155
+ * @param {Array<IOValue>} iOValue
2156
+ * @param {*} [options] Override http request option.
2157
+ * @throws {RequiredError}
2158
+ * @memberof BUSInputsOutputsApi
2159
+ */
2160
+ setBusIOValues(cell, iOValue, options) {
2161
+ return BUSInputsOutputsApiFp(this.configuration).setBusIOValues(cell, iOValue, options).then((request) => request(this.axios, this.basePath));
2162
+ }
2163
+ /**
2164
+ * Sets inputs/outputs on the PROFINET device from file.
2165
+ * @summary Set PROFINET Inputs/Outputs from File
2166
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
2167
+ * @param {ProfinetInputOutputConfig} profinetInputOutputConfig
2168
+ * @param {*} [options] Override http request option.
2169
+ * @throws {RequiredError}
2170
+ * @memberof BUSInputsOutputsApi
2171
+ */
2172
+ setProfinetIOsFromFile(cell, profinetInputOutputConfig, options) {
2173
+ return BUSInputsOutputsApiFp(this.configuration).setProfinetIOsFromFile(cell, profinetInputOutputConfig, options).then((request) => request(this.axios, this.basePath));
1100
2174
  }
1101
2175
  }
1102
2176
  /**
@@ -3485,6 +4559,44 @@ export class JoggingApi extends BaseAPI {
3485
4559
  */
3486
4560
  export const KinematicsApiAxiosParamCreator = function (configuration) {
3487
4561
  return {
4562
+ /**
4563
+ * Returns the TCP poses for a list of given joint positions.
4564
+ * @summary Forward kinematics
4565
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
4566
+ * @param {ForwardKinematicsRequest} [forwardKinematicsRequest]
4567
+ * @param {*} [options] Override http request option.
4568
+ * @throws {RequiredError}
4569
+ */
4570
+ forwardKinematics: async (cell, forwardKinematicsRequest, options = {}) => {
4571
+ // verify required parameter 'cell' is not null or undefined
4572
+ assertParamExists('forwardKinematics', 'cell', cell);
4573
+ const localVarPath = `/cells/{cell}/kinematic/forward`
4574
+ .replace(`{${"cell"}}`, encodeURIComponent(String(cell)));
4575
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
4576
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
4577
+ let baseOptions;
4578
+ if (configuration) {
4579
+ baseOptions = configuration.baseOptions;
4580
+ }
4581
+ const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options };
4582
+ const localVarHeaderParameter = {};
4583
+ const localVarQueryParameter = {};
4584
+ // authentication BasicAuth required
4585
+ // http basic authentication required
4586
+ setBasicAuthToObject(localVarRequestOptions, configuration);
4587
+ // authentication BearerAuth required
4588
+ // http bearer authentication required
4589
+ await setBearerAuthToObject(localVarHeaderParameter, configuration);
4590
+ localVarHeaderParameter['Content-Type'] = 'application/json';
4591
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
4592
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
4593
+ localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
4594
+ localVarRequestOptions.data = serializeDataIfNeeded(forwardKinematicsRequest, localVarRequestOptions, configuration);
4595
+ return {
4596
+ url: toPathString(localVarUrlObj),
4597
+ options: localVarRequestOptions,
4598
+ };
4599
+ },
3488
4600
  /**
3489
4601
  * Returns the reachable joint positions for a list of given poses.
3490
4602
  * @summary Inverse kinematics
@@ -3532,6 +4644,20 @@ export const KinematicsApiAxiosParamCreator = function (configuration) {
3532
4644
  export const KinematicsApiFp = function (configuration) {
3533
4645
  const localVarAxiosParamCreator = KinematicsApiAxiosParamCreator(configuration);
3534
4646
  return {
4647
+ /**
4648
+ * Returns the TCP poses for a list of given joint positions.
4649
+ * @summary Forward kinematics
4650
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
4651
+ * @param {ForwardKinematicsRequest} [forwardKinematicsRequest]
4652
+ * @param {*} [options] Override http request option.
4653
+ * @throws {RequiredError}
4654
+ */
4655
+ async forwardKinematics(cell, forwardKinematicsRequest, options) {
4656
+ const localVarAxiosArgs = await localVarAxiosParamCreator.forwardKinematics(cell, forwardKinematicsRequest, options);
4657
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
4658
+ const localVarOperationServerBasePath = operationServerMap['KinematicsApi.forwardKinematics']?.[localVarOperationServerIndex]?.url;
4659
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
4660
+ },
3535
4661
  /**
3536
4662
  * Returns the reachable joint positions for a list of given poses.
3537
4663
  * @summary Inverse kinematics
@@ -3555,6 +4681,17 @@ export const KinematicsApiFp = function (configuration) {
3555
4681
  export const KinematicsApiFactory = function (configuration, basePath, axios) {
3556
4682
  const localVarFp = KinematicsApiFp(configuration);
3557
4683
  return {
4684
+ /**
4685
+ * Returns the TCP poses for a list of given joint positions.
4686
+ * @summary Forward kinematics
4687
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
4688
+ * @param {ForwardKinematicsRequest} [forwardKinematicsRequest]
4689
+ * @param {*} [options] Override http request option.
4690
+ * @throws {RequiredError}
4691
+ */
4692
+ forwardKinematics(cell, forwardKinematicsRequest, options) {
4693
+ return localVarFp.forwardKinematics(cell, forwardKinematicsRequest, options).then((request) => request(axios, basePath));
4694
+ },
3558
4695
  /**
3559
4696
  * Returns the reachable joint positions for a list of given poses.
3560
4697
  * @summary Inverse kinematics
@@ -3575,6 +4712,18 @@ export const KinematicsApiFactory = function (configuration, basePath, axios) {
3575
4712
  * @extends {BaseAPI}
3576
4713
  */
3577
4714
  export class KinematicsApi extends BaseAPI {
4715
+ /**
4716
+ * Returns the TCP poses for a list of given joint positions.
4717
+ * @summary Forward kinematics
4718
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
4719
+ * @param {ForwardKinematicsRequest} [forwardKinematicsRequest]
4720
+ * @param {*} [options] Override http request option.
4721
+ * @throws {RequiredError}
4722
+ * @memberof KinematicsApi
4723
+ */
4724
+ forwardKinematics(cell, forwardKinematicsRequest, options) {
4725
+ return KinematicsApiFp(this.configuration).forwardKinematics(cell, forwardKinematicsRequest, options).then((request) => request(this.axios, this.basePath));
4726
+ }
3578
4727
  /**
3579
4728
  * Returns the reachable joint positions for a list of given poses.
3580
4729
  * @summary Inverse kinematics
@@ -5311,27 +6460,27 @@ export class StoreCollisionComponentsApi extends BaseAPI {
5311
6460
  }
5312
6461
  }
5313
6462
  /**
5314
- * StoreCollisionScenesApi - axios parameter creator
6463
+ * StoreCollisionSetupsApi - axios parameter creator
5315
6464
  * @export
5316
6465
  */
5317
- export const StoreCollisionScenesApiAxiosParamCreator = function (configuration) {
6466
+ export const StoreCollisionSetupsApiAxiosParamCreator = function (configuration) {
5318
6467
  return {
5319
6468
  /**
5320
- * Deletes the stored scene. <!-- theme: danger --> > This will delete persistently stored data.
5321
- * @summary Delete Scene
6469
+ * Deletes the stored collision setup. <!-- theme: danger --> > This will delete persistently stored data.
6470
+ * @summary Delete Collision Setup
5322
6471
  * @param {string} cell Unique identifier addressing a cell in all API calls.
5323
- * @param {string} scene Unique identifier addressing a collision scene.
6472
+ * @param {string} setup Identifier of the collision setup
5324
6473
  * @param {*} [options] Override http request option.
5325
6474
  * @throws {RequiredError}
5326
6475
  */
5327
- deleteStoredCollisionScene: async (cell, scene, options = {}) => {
6476
+ deleteStoredCollisionSetup: async (cell, setup, options = {}) => {
5328
6477
  // verify required parameter 'cell' is not null or undefined
5329
- assertParamExists('deleteStoredCollisionScene', 'cell', cell);
5330
- // verify required parameter 'scene' is not null or undefined
5331
- assertParamExists('deleteStoredCollisionScene', 'scene', scene);
5332
- const localVarPath = `/cells/{cell}/store/collision/scenes/{scene}`
6478
+ assertParamExists('deleteStoredCollisionSetup', 'cell', cell);
6479
+ // verify required parameter 'setup' is not null or undefined
6480
+ assertParamExists('deleteStoredCollisionSetup', 'setup', setup);
6481
+ const localVarPath = `/cells/{cell}/store/collision/setups/{setup}`
5333
6482
  .replace(`{${"cell"}}`, encodeURIComponent(String(cell)))
5334
- .replace(`{${"scene"}}`, encodeURIComponent(String(scene)));
6483
+ .replace(`{${"setup"}}`, encodeURIComponent(String(setup)));
5335
6484
  // use dummy base URL string because the URL constructor only accepts absolute URLs.
5336
6485
  const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
5337
6486
  let baseOptions;
@@ -5356,21 +6505,21 @@ export const StoreCollisionScenesApiAxiosParamCreator = function (configuration)
5356
6505
  };
5357
6506
  },
5358
6507
  /**
5359
- * Returns the stored scene.
5360
- * @summary Get Scene
6508
+ * Returns the stored collision setup.
6509
+ * @summary Get Collision Setup
5361
6510
  * @param {string} cell Unique identifier addressing a cell in all API calls.
5362
- * @param {string} scene Unique identifier addressing a collision scene.
6511
+ * @param {string} setup Identifier of the collision setup
5363
6512
  * @param {*} [options] Override http request option.
5364
6513
  * @throws {RequiredError}
5365
6514
  */
5366
- getStoredCollisionScene: async (cell, scene, options = {}) => {
6515
+ getStoredCollisionSetup: async (cell, setup, options = {}) => {
5367
6516
  // verify required parameter 'cell' is not null or undefined
5368
- assertParamExists('getStoredCollisionScene', 'cell', cell);
5369
- // verify required parameter 'scene' is not null or undefined
5370
- assertParamExists('getStoredCollisionScene', 'scene', scene);
5371
- const localVarPath = `/cells/{cell}/store/collision/scenes/{scene}`
6517
+ assertParamExists('getStoredCollisionSetup', 'cell', cell);
6518
+ // verify required parameter 'setup' is not null or undefined
6519
+ assertParamExists('getStoredCollisionSetup', 'setup', setup);
6520
+ const localVarPath = `/cells/{cell}/store/collision/setups/{setup}`
5372
6521
  .replace(`{${"cell"}}`, encodeURIComponent(String(cell)))
5373
- .replace(`{${"scene"}}`, encodeURIComponent(String(scene)));
6522
+ .replace(`{${"setup"}}`, encodeURIComponent(String(setup)));
5374
6523
  // use dummy base URL string because the URL constructor only accepts absolute URLs.
5375
6524
  const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
5376
6525
  let baseOptions;
@@ -5395,16 +6544,16 @@ export const StoreCollisionScenesApiAxiosParamCreator = function (configuration)
5395
6544
  };
5396
6545
  },
5397
6546
  /**
5398
- * Returns a list of stored scenes.
5399
- * @summary List Scenes
6547
+ * Returns a list of stored collision setups.
6548
+ * @summary List Collision Setups
5400
6549
  * @param {string} cell Unique identifier addressing a cell in all API calls.
5401
6550
  * @param {*} [options] Override http request option.
5402
6551
  * @throws {RequiredError}
5403
6552
  */
5404
- listStoredCollisionScenes: async (cell, options = {}) => {
6553
+ listStoredCollisionSetups: async (cell, options = {}) => {
5405
6554
  // verify required parameter 'cell' is not null or undefined
5406
- assertParamExists('listStoredCollisionScenes', 'cell', cell);
5407
- const localVarPath = `/cells/{cell}/store/collision/scenes`
6555
+ assertParamExists('listStoredCollisionSetups', 'cell', cell);
6556
+ const localVarPath = `/cells/{cell}/store/collision/setups`
5408
6557
  .replace(`{${"cell"}}`, encodeURIComponent(String(cell)));
5409
6558
  // use dummy base URL string because the URL constructor only accepts absolute URLs.
5410
6559
  const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
@@ -5430,24 +6579,24 @@ export const StoreCollisionScenesApiAxiosParamCreator = function (configuration)
5430
6579
  };
5431
6580
  },
5432
6581
  /**
5433
- * Creates or replaces the stored collision scene. The scene is assembled from components as defined in the request body. <!-- theme: info --> > This endpoint allows indicating previously stored components. > Components used within the request will be copied into the new or updated scene. An error is returned if an indicated component does not exist.
5434
- * @summary Store Scene
6582
+ * Stores collision setup. If the collision setup does not exist, it will be created. If the collision setup exists, it will be updated.
6583
+ * @summary Store Collision Setup
5435
6584
  * @param {string} cell Unique identifier addressing a cell in all API calls.
5436
- * @param {string} scene Unique identifier addressing a collision scene.
5437
- * @param {CollisionSceneAssembly} collisionSceneAssembly
6585
+ * @param {string} setup Identifier of the collision setup
6586
+ * @param {CollisionSetup} collisionSetup
5438
6587
  * @param {*} [options] Override http request option.
5439
6588
  * @throws {RequiredError}
5440
6589
  */
5441
- storeCollisionScene: async (cell, scene, collisionSceneAssembly, options = {}) => {
6590
+ storeCollisionSetup: async (cell, setup, collisionSetup, options = {}) => {
5442
6591
  // verify required parameter 'cell' is not null or undefined
5443
- assertParamExists('storeCollisionScene', 'cell', cell);
5444
- // verify required parameter 'scene' is not null or undefined
5445
- assertParamExists('storeCollisionScene', 'scene', scene);
5446
- // verify required parameter 'collisionSceneAssembly' is not null or undefined
5447
- assertParamExists('storeCollisionScene', 'collisionSceneAssembly', collisionSceneAssembly);
5448
- const localVarPath = `/cells/{cell}/store/collision/scenes/{scene}`
6592
+ assertParamExists('storeCollisionSetup', 'cell', cell);
6593
+ // verify required parameter 'setup' is not null or undefined
6594
+ assertParamExists('storeCollisionSetup', 'setup', setup);
6595
+ // verify required parameter 'collisionSetup' is not null or undefined
6596
+ assertParamExists('storeCollisionSetup', 'collisionSetup', collisionSetup);
6597
+ const localVarPath = `/cells/{cell}/store/collision/setups/{setup}`
5449
6598
  .replace(`{${"cell"}}`, encodeURIComponent(String(cell)))
5450
- .replace(`{${"scene"}}`, encodeURIComponent(String(scene)));
6599
+ .replace(`{${"setup"}}`, encodeURIComponent(String(setup)));
5451
6600
  // use dummy base URL string because the URL constructor only accepts absolute URLs.
5452
6601
  const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
5453
6602
  let baseOptions;
@@ -5467,7 +6616,7 @@ export const StoreCollisionScenesApiAxiosParamCreator = function (configuration)
5467
6616
  setSearchParams(localVarUrlObj, localVarQueryParameter);
5468
6617
  let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
5469
6618
  localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
5470
- localVarRequestOptions.data = serializeDataIfNeeded(collisionSceneAssembly, localVarRequestOptions, configuration);
6619
+ localVarRequestOptions.data = serializeDataIfNeeded(collisionSetup, localVarRequestOptions, configuration);
5471
6620
  return {
5472
6621
  url: toPathString(localVarUrlObj),
5473
6622
  options: localVarRequestOptions,
@@ -5476,177 +6625,177 @@ export const StoreCollisionScenesApiAxiosParamCreator = function (configuration)
5476
6625
  };
5477
6626
  };
5478
6627
  /**
5479
- * StoreCollisionScenesApi - functional programming interface
6628
+ * StoreCollisionSetupsApi - functional programming interface
5480
6629
  * @export
5481
6630
  */
5482
- export const StoreCollisionScenesApiFp = function (configuration) {
5483
- const localVarAxiosParamCreator = StoreCollisionScenesApiAxiosParamCreator(configuration);
6631
+ export const StoreCollisionSetupsApiFp = function (configuration) {
6632
+ const localVarAxiosParamCreator = StoreCollisionSetupsApiAxiosParamCreator(configuration);
5484
6633
  return {
5485
6634
  /**
5486
- * Deletes the stored scene. <!-- theme: danger --> > This will delete persistently stored data.
5487
- * @summary Delete Scene
6635
+ * Deletes the stored collision setup. <!-- theme: danger --> > This will delete persistently stored data.
6636
+ * @summary Delete Collision Setup
5488
6637
  * @param {string} cell Unique identifier addressing a cell in all API calls.
5489
- * @param {string} scene Unique identifier addressing a collision scene.
6638
+ * @param {string} setup Identifier of the collision setup
5490
6639
  * @param {*} [options] Override http request option.
5491
6640
  * @throws {RequiredError}
5492
6641
  */
5493
- async deleteStoredCollisionScene(cell, scene, options) {
5494
- const localVarAxiosArgs = await localVarAxiosParamCreator.deleteStoredCollisionScene(cell, scene, options);
6642
+ async deleteStoredCollisionSetup(cell, setup, options) {
6643
+ const localVarAxiosArgs = await localVarAxiosParamCreator.deleteStoredCollisionSetup(cell, setup, options);
5495
6644
  const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
5496
- const localVarOperationServerBasePath = operationServerMap['StoreCollisionScenesApi.deleteStoredCollisionScene']?.[localVarOperationServerIndex]?.url;
6645
+ const localVarOperationServerBasePath = operationServerMap['StoreCollisionSetupsApi.deleteStoredCollisionSetup']?.[localVarOperationServerIndex]?.url;
5497
6646
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
5498
6647
  },
5499
6648
  /**
5500
- * Returns the stored scene.
5501
- * @summary Get Scene
6649
+ * Returns the stored collision setup.
6650
+ * @summary Get Collision Setup
5502
6651
  * @param {string} cell Unique identifier addressing a cell in all API calls.
5503
- * @param {string} scene Unique identifier addressing a collision scene.
6652
+ * @param {string} setup Identifier of the collision setup
5504
6653
  * @param {*} [options] Override http request option.
5505
6654
  * @throws {RequiredError}
5506
6655
  */
5507
- async getStoredCollisionScene(cell, scene, options) {
5508
- const localVarAxiosArgs = await localVarAxiosParamCreator.getStoredCollisionScene(cell, scene, options);
6656
+ async getStoredCollisionSetup(cell, setup, options) {
6657
+ const localVarAxiosArgs = await localVarAxiosParamCreator.getStoredCollisionSetup(cell, setup, options);
5509
6658
  const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
5510
- const localVarOperationServerBasePath = operationServerMap['StoreCollisionScenesApi.getStoredCollisionScene']?.[localVarOperationServerIndex]?.url;
6659
+ const localVarOperationServerBasePath = operationServerMap['StoreCollisionSetupsApi.getStoredCollisionSetup']?.[localVarOperationServerIndex]?.url;
5511
6660
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
5512
6661
  },
5513
6662
  /**
5514
- * Returns a list of stored scenes.
5515
- * @summary List Scenes
6663
+ * Returns a list of stored collision setups.
6664
+ * @summary List Collision Setups
5516
6665
  * @param {string} cell Unique identifier addressing a cell in all API calls.
5517
6666
  * @param {*} [options] Override http request option.
5518
6667
  * @throws {RequiredError}
5519
6668
  */
5520
- async listStoredCollisionScenes(cell, options) {
5521
- const localVarAxiosArgs = await localVarAxiosParamCreator.listStoredCollisionScenes(cell, options);
6669
+ async listStoredCollisionSetups(cell, options) {
6670
+ const localVarAxiosArgs = await localVarAxiosParamCreator.listStoredCollisionSetups(cell, options);
5522
6671
  const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
5523
- const localVarOperationServerBasePath = operationServerMap['StoreCollisionScenesApi.listStoredCollisionScenes']?.[localVarOperationServerIndex]?.url;
6672
+ const localVarOperationServerBasePath = operationServerMap['StoreCollisionSetupsApi.listStoredCollisionSetups']?.[localVarOperationServerIndex]?.url;
5524
6673
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
5525
6674
  },
5526
6675
  /**
5527
- * Creates or replaces the stored collision scene. The scene is assembled from components as defined in the request body. <!-- theme: info --> > This endpoint allows indicating previously stored components. > Components used within the request will be copied into the new or updated scene. An error is returned if an indicated component does not exist.
5528
- * @summary Store Scene
6676
+ * Stores collision setup. If the collision setup does not exist, it will be created. If the collision setup exists, it will be updated.
6677
+ * @summary Store Collision Setup
5529
6678
  * @param {string} cell Unique identifier addressing a cell in all API calls.
5530
- * @param {string} scene Unique identifier addressing a collision scene.
5531
- * @param {CollisionSceneAssembly} collisionSceneAssembly
6679
+ * @param {string} setup Identifier of the collision setup
6680
+ * @param {CollisionSetup} collisionSetup
5532
6681
  * @param {*} [options] Override http request option.
5533
6682
  * @throws {RequiredError}
5534
6683
  */
5535
- async storeCollisionScene(cell, scene, collisionSceneAssembly, options) {
5536
- const localVarAxiosArgs = await localVarAxiosParamCreator.storeCollisionScene(cell, scene, collisionSceneAssembly, options);
6684
+ async storeCollisionSetup(cell, setup, collisionSetup, options) {
6685
+ const localVarAxiosArgs = await localVarAxiosParamCreator.storeCollisionSetup(cell, setup, collisionSetup, options);
5537
6686
  const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
5538
- const localVarOperationServerBasePath = operationServerMap['StoreCollisionScenesApi.storeCollisionScene']?.[localVarOperationServerIndex]?.url;
6687
+ const localVarOperationServerBasePath = operationServerMap['StoreCollisionSetupsApi.storeCollisionSetup']?.[localVarOperationServerIndex]?.url;
5539
6688
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
5540
6689
  },
5541
6690
  };
5542
6691
  };
5543
6692
  /**
5544
- * StoreCollisionScenesApi - factory interface
6693
+ * StoreCollisionSetupsApi - factory interface
5545
6694
  * @export
5546
6695
  */
5547
- export const StoreCollisionScenesApiFactory = function (configuration, basePath, axios) {
5548
- const localVarFp = StoreCollisionScenesApiFp(configuration);
6696
+ export const StoreCollisionSetupsApiFactory = function (configuration, basePath, axios) {
6697
+ const localVarFp = StoreCollisionSetupsApiFp(configuration);
5549
6698
  return {
5550
6699
  /**
5551
- * Deletes the stored scene. <!-- theme: danger --> > This will delete persistently stored data.
5552
- * @summary Delete Scene
6700
+ * Deletes the stored collision setup. <!-- theme: danger --> > This will delete persistently stored data.
6701
+ * @summary Delete Collision Setup
5553
6702
  * @param {string} cell Unique identifier addressing a cell in all API calls.
5554
- * @param {string} scene Unique identifier addressing a collision scene.
6703
+ * @param {string} setup Identifier of the collision setup
5555
6704
  * @param {*} [options] Override http request option.
5556
6705
  * @throws {RequiredError}
5557
6706
  */
5558
- deleteStoredCollisionScene(cell, scene, options) {
5559
- return localVarFp.deleteStoredCollisionScene(cell, scene, options).then((request) => request(axios, basePath));
6707
+ deleteStoredCollisionSetup(cell, setup, options) {
6708
+ return localVarFp.deleteStoredCollisionSetup(cell, setup, options).then((request) => request(axios, basePath));
5560
6709
  },
5561
6710
  /**
5562
- * Returns the stored scene.
5563
- * @summary Get Scene
6711
+ * Returns the stored collision setup.
6712
+ * @summary Get Collision Setup
5564
6713
  * @param {string} cell Unique identifier addressing a cell in all API calls.
5565
- * @param {string} scene Unique identifier addressing a collision scene.
6714
+ * @param {string} setup Identifier of the collision setup
5566
6715
  * @param {*} [options] Override http request option.
5567
6716
  * @throws {RequiredError}
5568
6717
  */
5569
- getStoredCollisionScene(cell, scene, options) {
5570
- return localVarFp.getStoredCollisionScene(cell, scene, options).then((request) => request(axios, basePath));
6718
+ getStoredCollisionSetup(cell, setup, options) {
6719
+ return localVarFp.getStoredCollisionSetup(cell, setup, options).then((request) => request(axios, basePath));
5571
6720
  },
5572
6721
  /**
5573
- * Returns a list of stored scenes.
5574
- * @summary List Scenes
6722
+ * Returns a list of stored collision setups.
6723
+ * @summary List Collision Setups
5575
6724
  * @param {string} cell Unique identifier addressing a cell in all API calls.
5576
6725
  * @param {*} [options] Override http request option.
5577
6726
  * @throws {RequiredError}
5578
6727
  */
5579
- listStoredCollisionScenes(cell, options) {
5580
- return localVarFp.listStoredCollisionScenes(cell, options).then((request) => request(axios, basePath));
6728
+ listStoredCollisionSetups(cell, options) {
6729
+ return localVarFp.listStoredCollisionSetups(cell, options).then((request) => request(axios, basePath));
5581
6730
  },
5582
6731
  /**
5583
- * Creates or replaces the stored collision scene. The scene is assembled from components as defined in the request body. <!-- theme: info --> > This endpoint allows indicating previously stored components. > Components used within the request will be copied into the new or updated scene. An error is returned if an indicated component does not exist.
5584
- * @summary Store Scene
6732
+ * Stores collision setup. If the collision setup does not exist, it will be created. If the collision setup exists, it will be updated.
6733
+ * @summary Store Collision Setup
5585
6734
  * @param {string} cell Unique identifier addressing a cell in all API calls.
5586
- * @param {string} scene Unique identifier addressing a collision scene.
5587
- * @param {CollisionSceneAssembly} collisionSceneAssembly
6735
+ * @param {string} setup Identifier of the collision setup
6736
+ * @param {CollisionSetup} collisionSetup
5588
6737
  * @param {*} [options] Override http request option.
5589
6738
  * @throws {RequiredError}
5590
6739
  */
5591
- storeCollisionScene(cell, scene, collisionSceneAssembly, options) {
5592
- return localVarFp.storeCollisionScene(cell, scene, collisionSceneAssembly, options).then((request) => request(axios, basePath));
6740
+ storeCollisionSetup(cell, setup, collisionSetup, options) {
6741
+ return localVarFp.storeCollisionSetup(cell, setup, collisionSetup, options).then((request) => request(axios, basePath));
5593
6742
  },
5594
6743
  };
5595
6744
  };
5596
6745
  /**
5597
- * StoreCollisionScenesApi - object-oriented interface
6746
+ * StoreCollisionSetupsApi - object-oriented interface
5598
6747
  * @export
5599
- * @class StoreCollisionScenesApi
6748
+ * @class StoreCollisionSetupsApi
5600
6749
  * @extends {BaseAPI}
5601
6750
  */
5602
- export class StoreCollisionScenesApi extends BaseAPI {
6751
+ export class StoreCollisionSetupsApi extends BaseAPI {
5603
6752
  /**
5604
- * Deletes the stored scene. <!-- theme: danger --> > This will delete persistently stored data.
5605
- * @summary Delete Scene
6753
+ * Deletes the stored collision setup. <!-- theme: danger --> > This will delete persistently stored data.
6754
+ * @summary Delete Collision Setup
5606
6755
  * @param {string} cell Unique identifier addressing a cell in all API calls.
5607
- * @param {string} scene Unique identifier addressing a collision scene.
6756
+ * @param {string} setup Identifier of the collision setup
5608
6757
  * @param {*} [options] Override http request option.
5609
6758
  * @throws {RequiredError}
5610
- * @memberof StoreCollisionScenesApi
6759
+ * @memberof StoreCollisionSetupsApi
5611
6760
  */
5612
- deleteStoredCollisionScene(cell, scene, options) {
5613
- return StoreCollisionScenesApiFp(this.configuration).deleteStoredCollisionScene(cell, scene, options).then((request) => request(this.axios, this.basePath));
6761
+ deleteStoredCollisionSetup(cell, setup, options) {
6762
+ return StoreCollisionSetupsApiFp(this.configuration).deleteStoredCollisionSetup(cell, setup, options).then((request) => request(this.axios, this.basePath));
5614
6763
  }
5615
6764
  /**
5616
- * Returns the stored scene.
5617
- * @summary Get Scene
6765
+ * Returns the stored collision setup.
6766
+ * @summary Get Collision Setup
5618
6767
  * @param {string} cell Unique identifier addressing a cell in all API calls.
5619
- * @param {string} scene Unique identifier addressing a collision scene.
6768
+ * @param {string} setup Identifier of the collision setup
5620
6769
  * @param {*} [options] Override http request option.
5621
6770
  * @throws {RequiredError}
5622
- * @memberof StoreCollisionScenesApi
6771
+ * @memberof StoreCollisionSetupsApi
5623
6772
  */
5624
- getStoredCollisionScene(cell, scene, options) {
5625
- return StoreCollisionScenesApiFp(this.configuration).getStoredCollisionScene(cell, scene, options).then((request) => request(this.axios, this.basePath));
6773
+ getStoredCollisionSetup(cell, setup, options) {
6774
+ return StoreCollisionSetupsApiFp(this.configuration).getStoredCollisionSetup(cell, setup, options).then((request) => request(this.axios, this.basePath));
5626
6775
  }
5627
6776
  /**
5628
- * Returns a list of stored scenes.
5629
- * @summary List Scenes
6777
+ * Returns a list of stored collision setups.
6778
+ * @summary List Collision Setups
5630
6779
  * @param {string} cell Unique identifier addressing a cell in all API calls.
5631
6780
  * @param {*} [options] Override http request option.
5632
6781
  * @throws {RequiredError}
5633
- * @memberof StoreCollisionScenesApi
6782
+ * @memberof StoreCollisionSetupsApi
5634
6783
  */
5635
- listStoredCollisionScenes(cell, options) {
5636
- return StoreCollisionScenesApiFp(this.configuration).listStoredCollisionScenes(cell, options).then((request) => request(this.axios, this.basePath));
6784
+ listStoredCollisionSetups(cell, options) {
6785
+ return StoreCollisionSetupsApiFp(this.configuration).listStoredCollisionSetups(cell, options).then((request) => request(this.axios, this.basePath));
5637
6786
  }
5638
6787
  /**
5639
- * Creates or replaces the stored collision scene. The scene is assembled from components as defined in the request body. <!-- theme: info --> > This endpoint allows indicating previously stored components. > Components used within the request will be copied into the new or updated scene. An error is returned if an indicated component does not exist.
5640
- * @summary Store Scene
6788
+ * Stores collision setup. If the collision setup does not exist, it will be created. If the collision setup exists, it will be updated.
6789
+ * @summary Store Collision Setup
5641
6790
  * @param {string} cell Unique identifier addressing a cell in all API calls.
5642
- * @param {string} scene Unique identifier addressing a collision scene.
5643
- * @param {CollisionSceneAssembly} collisionSceneAssembly
6791
+ * @param {string} setup Identifier of the collision setup
6792
+ * @param {CollisionSetup} collisionSetup
5644
6793
  * @param {*} [options] Override http request option.
5645
6794
  * @throws {RequiredError}
5646
- * @memberof StoreCollisionScenesApi
6795
+ * @memberof StoreCollisionSetupsApi
5647
6796
  */
5648
- storeCollisionScene(cell, scene, collisionSceneAssembly, options) {
5649
- return StoreCollisionScenesApiFp(this.configuration).storeCollisionScene(cell, scene, collisionSceneAssembly, options).then((request) => request(this.axios, this.basePath));
6797
+ storeCollisionSetup(cell, setup, collisionSetup, options) {
6798
+ return StoreCollisionSetupsApiFp(this.configuration).storeCollisionSetup(cell, setup, collisionSetup, options).then((request) => request(this.axios, this.basePath));
5650
6799
  }
5651
6800
  }
5652
6801
  /**
@@ -7355,6 +8504,44 @@ export class TrajectoryExecutionApi extends BaseAPI {
7355
8504
  */
7356
8505
  export const TrajectoryPlanningApiAxiosParamCreator = function (configuration) {
7357
8506
  return {
8507
+ /**
8508
+ * Plans a collision-free trajectory for a single motion group using point-to-point (PTP) motions. This endpoint is specifically designed for collision-free path planning algorithms that find a trajectory from a start joint position to a target position while avoiding obstacles. Use the following workflow to execute a planned collision-free trajectory: 1. Plan a collision-free trajectory. 2. Optional: Load the planned trajectory into the cache using the [addTrajectory](addTrajectory) endpoint. 3. Execute the (cached) trajectory using the [executeTrajectory](executeTrajectory) endpoint. If the trajectory planning fails due to collision or algorithm constraints, the response will contain error information about the failure.
8509
+ * @summary Plan Collision-Free Trajectory
8510
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
8511
+ * @param {PlanCollisionFreeRequest} [planCollisionFreeRequest]
8512
+ * @param {*} [options] Override http request option.
8513
+ * @throws {RequiredError}
8514
+ */
8515
+ planCollisionFree: async (cell, planCollisionFreeRequest, options = {}) => {
8516
+ // verify required parameter 'cell' is not null or undefined
8517
+ assertParamExists('planCollisionFree', 'cell', cell);
8518
+ const localVarPath = `/cells/{cell}/trajectory-planning/plan-collision-free`
8519
+ .replace(`{${"cell"}}`, encodeURIComponent(String(cell)));
8520
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
8521
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
8522
+ let baseOptions;
8523
+ if (configuration) {
8524
+ baseOptions = configuration.baseOptions;
8525
+ }
8526
+ const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options };
8527
+ const localVarHeaderParameter = {};
8528
+ const localVarQueryParameter = {};
8529
+ // authentication BasicAuth required
8530
+ // http basic authentication required
8531
+ setBasicAuthToObject(localVarRequestOptions, configuration);
8532
+ // authentication BearerAuth required
8533
+ // http bearer authentication required
8534
+ await setBearerAuthToObject(localVarHeaderParameter, configuration);
8535
+ localVarHeaderParameter['Content-Type'] = 'application/json';
8536
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
8537
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
8538
+ localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
8539
+ localVarRequestOptions.data = serializeDataIfNeeded(planCollisionFreeRequest, localVarRequestOptions, configuration);
8540
+ return {
8541
+ url: toPathString(localVarUrlObj),
8542
+ options: localVarRequestOptions,
8543
+ };
8544
+ },
7358
8545
  /**
7359
8546
  * Plans a new trajectory for a single motion group. Describe the trajectory as a sequence of motion commands that the robots TCP should follow. Use the following workflow to execute a planned trajectory: 1. Plan a trajectory. 2. Optional: Load the planned trajectory into the cache using the [addTrajectory](addTrajectory) endpoint. 3. Execute the (cached) trajectory using the [executeTrajectory](executeTrajectory) endpoint. If the trajectory is not executable, the [PlanTrajectoryResponse](PlanTrajectoryResponse) will contain the joint trajectory up until the error, e.g. all samples until a collision occurs. EXCEPTION: If a CartesianPTP or JointPTP motion command has an invalid target, the response will contain the trajectory up until the start of the invalid PTP motion.
7360
8547
  * @summary Plan Trajectory
@@ -7402,6 +8589,20 @@ export const TrajectoryPlanningApiAxiosParamCreator = function (configuration) {
7402
8589
  export const TrajectoryPlanningApiFp = function (configuration) {
7403
8590
  const localVarAxiosParamCreator = TrajectoryPlanningApiAxiosParamCreator(configuration);
7404
8591
  return {
8592
+ /**
8593
+ * Plans a collision-free trajectory for a single motion group using point-to-point (PTP) motions. This endpoint is specifically designed for collision-free path planning algorithms that find a trajectory from a start joint position to a target position while avoiding obstacles. Use the following workflow to execute a planned collision-free trajectory: 1. Plan a collision-free trajectory. 2. Optional: Load the planned trajectory into the cache using the [addTrajectory](addTrajectory) endpoint. 3. Execute the (cached) trajectory using the [executeTrajectory](executeTrajectory) endpoint. If the trajectory planning fails due to collision or algorithm constraints, the response will contain error information about the failure.
8594
+ * @summary Plan Collision-Free Trajectory
8595
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
8596
+ * @param {PlanCollisionFreeRequest} [planCollisionFreeRequest]
8597
+ * @param {*} [options] Override http request option.
8598
+ * @throws {RequiredError}
8599
+ */
8600
+ async planCollisionFree(cell, planCollisionFreeRequest, options) {
8601
+ const localVarAxiosArgs = await localVarAxiosParamCreator.planCollisionFree(cell, planCollisionFreeRequest, options);
8602
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
8603
+ const localVarOperationServerBasePath = operationServerMap['TrajectoryPlanningApi.planCollisionFree']?.[localVarOperationServerIndex]?.url;
8604
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
8605
+ },
7405
8606
  /**
7406
8607
  * Plans a new trajectory for a single motion group. Describe the trajectory as a sequence of motion commands that the robots TCP should follow. Use the following workflow to execute a planned trajectory: 1. Plan a trajectory. 2. Optional: Load the planned trajectory into the cache using the [addTrajectory](addTrajectory) endpoint. 3. Execute the (cached) trajectory using the [executeTrajectory](executeTrajectory) endpoint. If the trajectory is not executable, the [PlanTrajectoryResponse](PlanTrajectoryResponse) will contain the joint trajectory up until the error, e.g. all samples until a collision occurs. EXCEPTION: If a CartesianPTP or JointPTP motion command has an invalid target, the response will contain the trajectory up until the start of the invalid PTP motion.
7407
8608
  * @summary Plan Trajectory
@@ -7425,6 +8626,17 @@ export const TrajectoryPlanningApiFp = function (configuration) {
7425
8626
  export const TrajectoryPlanningApiFactory = function (configuration, basePath, axios) {
7426
8627
  const localVarFp = TrajectoryPlanningApiFp(configuration);
7427
8628
  return {
8629
+ /**
8630
+ * Plans a collision-free trajectory for a single motion group using point-to-point (PTP) motions. This endpoint is specifically designed for collision-free path planning algorithms that find a trajectory from a start joint position to a target position while avoiding obstacles. Use the following workflow to execute a planned collision-free trajectory: 1. Plan a collision-free trajectory. 2. Optional: Load the planned trajectory into the cache using the [addTrajectory](addTrajectory) endpoint. 3. Execute the (cached) trajectory using the [executeTrajectory](executeTrajectory) endpoint. If the trajectory planning fails due to collision or algorithm constraints, the response will contain error information about the failure.
8631
+ * @summary Plan Collision-Free Trajectory
8632
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
8633
+ * @param {PlanCollisionFreeRequest} [planCollisionFreeRequest]
8634
+ * @param {*} [options] Override http request option.
8635
+ * @throws {RequiredError}
8636
+ */
8637
+ planCollisionFree(cell, planCollisionFreeRequest, options) {
8638
+ return localVarFp.planCollisionFree(cell, planCollisionFreeRequest, options).then((request) => request(axios, basePath));
8639
+ },
7428
8640
  /**
7429
8641
  * Plans a new trajectory for a single motion group. Describe the trajectory as a sequence of motion commands that the robots TCP should follow. Use the following workflow to execute a planned trajectory: 1. Plan a trajectory. 2. Optional: Load the planned trajectory into the cache using the [addTrajectory](addTrajectory) endpoint. 3. Execute the (cached) trajectory using the [executeTrajectory](executeTrajectory) endpoint. If the trajectory is not executable, the [PlanTrajectoryResponse](PlanTrajectoryResponse) will contain the joint trajectory up until the error, e.g. all samples until a collision occurs. EXCEPTION: If a CartesianPTP or JointPTP motion command has an invalid target, the response will contain the trajectory up until the start of the invalid PTP motion.
7430
8642
  * @summary Plan Trajectory
@@ -7445,6 +8657,18 @@ export const TrajectoryPlanningApiFactory = function (configuration, basePath, a
7445
8657
  * @extends {BaseAPI}
7446
8658
  */
7447
8659
  export class TrajectoryPlanningApi extends BaseAPI {
8660
+ /**
8661
+ * Plans a collision-free trajectory for a single motion group using point-to-point (PTP) motions. This endpoint is specifically designed for collision-free path planning algorithms that find a trajectory from a start joint position to a target position while avoiding obstacles. Use the following workflow to execute a planned collision-free trajectory: 1. Plan a collision-free trajectory. 2. Optional: Load the planned trajectory into the cache using the [addTrajectory](addTrajectory) endpoint. 3. Execute the (cached) trajectory using the [executeTrajectory](executeTrajectory) endpoint. If the trajectory planning fails due to collision or algorithm constraints, the response will contain error information about the failure.
8662
+ * @summary Plan Collision-Free Trajectory
8663
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
8664
+ * @param {PlanCollisionFreeRequest} [planCollisionFreeRequest]
8665
+ * @param {*} [options] Override http request option.
8666
+ * @throws {RequiredError}
8667
+ * @memberof TrajectoryPlanningApi
8668
+ */
8669
+ planCollisionFree(cell, planCollisionFreeRequest, options) {
8670
+ return TrajectoryPlanningApiFp(this.configuration).planCollisionFree(cell, planCollisionFreeRequest, options).then((request) => request(this.axios, this.basePath));
8671
+ }
7448
8672
  /**
7449
8673
  * Plans a new trajectory for a single motion group. Describe the trajectory as a sequence of motion commands that the robots TCP should follow. Use the following workflow to execute a planned trajectory: 1. Plan a trajectory. 2. Optional: Load the planned trajectory into the cache using the [addTrajectory](addTrajectory) endpoint. 3. Execute the (cached) trajectory using the [executeTrajectory](executeTrajectory) endpoint. If the trajectory is not executable, the [PlanTrajectoryResponse](PlanTrajectoryResponse) will contain the joint trajectory up until the error, e.g. all samples until a collision occurs. EXCEPTION: If a CartesianPTP or JointPTP motion command has an invalid target, the response will contain the trajectory up until the start of the invalid PTP motion.
7450
8674
  * @summary Plan Trajectory