@wandelbots/nova-api 25.7.0-rc.2 → 25.8.0-dev.3
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/package.json +1 -1
- package/v2/api.d.ts +903 -27
- package/v2/api.js +1056 -0
- package/v2/api.js.map +1 -1
- package/v2/api.ts +1553 -27
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
|
};
|
|
@@ -311,6 +328,33 @@ export const PlaybackSpeedRequestMessageTypeEnum = {
|
|
|
311
328
|
export const PlaybackSpeedResponseKindEnum = {
|
|
312
329
|
PlaybackSpeedReceived: 'PLAYBACK_SPEED_RECEIVED'
|
|
313
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
|
+
};
|
|
314
358
|
export const RRTConnectAlgorithmAlgorithmNameEnum = {
|
|
315
359
|
RrtConnectAlgorithm: 'RRTConnectAlgorithm'
|
|
316
360
|
};
|
|
@@ -1119,6 +1163,1018 @@ export class ApplicationApi extends BaseAPI {
|
|
|
1119
1163
|
return ApplicationApiFp(this.configuration).updateApp(cell, app, app2, completionTimeout, options).then((request) => request(this.axios, this.basePath));
|
|
1120
1164
|
}
|
|
1121
1165
|
}
|
|
1166
|
+
/**
|
|
1167
|
+
* BUSInputsOutputsApi - axios parameter creator
|
|
1168
|
+
* @export
|
|
1169
|
+
*/
|
|
1170
|
+
export const BUSInputsOutputsApiAxiosParamCreator = function (configuration) {
|
|
1171
|
+
return {
|
|
1172
|
+
/**
|
|
1173
|
+
* Add a BUS Inputs/Outputs Service to the cell.
|
|
1174
|
+
* @summary Add Service
|
|
1175
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
1176
|
+
* @param {BusIOType} busIOType
|
|
1177
|
+
* @param {number} [completionTimeout]
|
|
1178
|
+
* @param {*} [options] Override http request option.
|
|
1179
|
+
* @throws {RequiredError}
|
|
1180
|
+
*/
|
|
1181
|
+
addBusIOService: async (cell, busIOType, completionTimeout, options = {}) => {
|
|
1182
|
+
// verify required parameter 'cell' is not null or undefined
|
|
1183
|
+
assertParamExists('addBusIOService', 'cell', cell);
|
|
1184
|
+
// verify required parameter 'busIOType' is not null or undefined
|
|
1185
|
+
assertParamExists('addBusIOService', 'busIOType', busIOType);
|
|
1186
|
+
const localVarPath = `/cells/{cell}/bus-ios`
|
|
1187
|
+
.replace(`{${"cell"}}`, encodeURIComponent(String(cell)));
|
|
1188
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
1189
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
1190
|
+
let baseOptions;
|
|
1191
|
+
if (configuration) {
|
|
1192
|
+
baseOptions = configuration.baseOptions;
|
|
1193
|
+
}
|
|
1194
|
+
const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options };
|
|
1195
|
+
const localVarHeaderParameter = {};
|
|
1196
|
+
const localVarQueryParameter = {};
|
|
1197
|
+
// authentication BasicAuth required
|
|
1198
|
+
// http basic authentication required
|
|
1199
|
+
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
1200
|
+
// authentication BearerAuth required
|
|
1201
|
+
// http bearer authentication required
|
|
1202
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
1203
|
+
if (completionTimeout !== undefined) {
|
|
1204
|
+
localVarQueryParameter['completion_timeout'] = completionTimeout;
|
|
1205
|
+
}
|
|
1206
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
1207
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
1208
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
1209
|
+
localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
|
|
1210
|
+
localVarRequestOptions.data = serializeDataIfNeeded(busIOType, localVarRequestOptions, configuration);
|
|
1211
|
+
return {
|
|
1212
|
+
url: toPathString(localVarUrlObj),
|
|
1213
|
+
options: localVarRequestOptions,
|
|
1214
|
+
};
|
|
1215
|
+
},
|
|
1216
|
+
/**
|
|
1217
|
+
* Adds an input/output to or updates an input/output on the PROFINET device.
|
|
1218
|
+
* @summary Add PROFINET Input/Output
|
|
1219
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
1220
|
+
* @param {string} io Unique identifier to address an Input/Output in the cell.
|
|
1221
|
+
* @param {ProfinetIOData} profinetIOData
|
|
1222
|
+
* @param {*} [options] Override http request option.
|
|
1223
|
+
* @throws {RequiredError}
|
|
1224
|
+
*/
|
|
1225
|
+
addProfinetIO: async (cell, io, profinetIOData, options = {}) => {
|
|
1226
|
+
// verify required parameter 'cell' is not null or undefined
|
|
1227
|
+
assertParamExists('addProfinetIO', 'cell', cell);
|
|
1228
|
+
// verify required parameter 'io' is not null or undefined
|
|
1229
|
+
assertParamExists('addProfinetIO', 'io', io);
|
|
1230
|
+
// verify required parameter 'profinetIOData' is not null or undefined
|
|
1231
|
+
assertParamExists('addProfinetIO', 'profinetIOData', profinetIOData);
|
|
1232
|
+
const localVarPath = `/cells/{cell}/bus-ios/profinet/ios/{io}`
|
|
1233
|
+
.replace(`{${"cell"}}`, encodeURIComponent(String(cell)))
|
|
1234
|
+
.replace(`{${"io"}}`, encodeURIComponent(String(io)));
|
|
1235
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
1236
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
1237
|
+
let baseOptions;
|
|
1238
|
+
if (configuration) {
|
|
1239
|
+
baseOptions = configuration.baseOptions;
|
|
1240
|
+
}
|
|
1241
|
+
const localVarRequestOptions = { method: 'PUT', ...baseOptions, ...options };
|
|
1242
|
+
const localVarHeaderParameter = {};
|
|
1243
|
+
const localVarQueryParameter = {};
|
|
1244
|
+
// authentication BasicAuth required
|
|
1245
|
+
// http basic authentication required
|
|
1246
|
+
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
1247
|
+
// authentication BearerAuth required
|
|
1248
|
+
// http bearer authentication required
|
|
1249
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
1250
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
1251
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
1252
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
1253
|
+
localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
|
|
1254
|
+
localVarRequestOptions.data = serializeDataIfNeeded(profinetIOData, localVarRequestOptions, configuration);
|
|
1255
|
+
return {
|
|
1256
|
+
url: toPathString(localVarUrlObj),
|
|
1257
|
+
options: localVarRequestOptions,
|
|
1258
|
+
};
|
|
1259
|
+
},
|
|
1260
|
+
/**
|
|
1261
|
+
* Delete BUS Inputs/Outputs Service from the cell.
|
|
1262
|
+
* @summary Clear Service
|
|
1263
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
1264
|
+
* @param {number} [completionTimeout]
|
|
1265
|
+
* @param {*} [options] Override http request option.
|
|
1266
|
+
* @throws {RequiredError}
|
|
1267
|
+
*/
|
|
1268
|
+
clearBusIOService: async (cell, completionTimeout, options = {}) => {
|
|
1269
|
+
// verify required parameter 'cell' is not null or undefined
|
|
1270
|
+
assertParamExists('clearBusIOService', 'cell', cell);
|
|
1271
|
+
const localVarPath = `/cells/{cell}/bus-ios`
|
|
1272
|
+
.replace(`{${"cell"}}`, encodeURIComponent(String(cell)));
|
|
1273
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
1274
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
1275
|
+
let baseOptions;
|
|
1276
|
+
if (configuration) {
|
|
1277
|
+
baseOptions = configuration.baseOptions;
|
|
1278
|
+
}
|
|
1279
|
+
const localVarRequestOptions = { method: 'DELETE', ...baseOptions, ...options };
|
|
1280
|
+
const localVarHeaderParameter = {};
|
|
1281
|
+
const localVarQueryParameter = {};
|
|
1282
|
+
// authentication BasicAuth required
|
|
1283
|
+
// http basic authentication required
|
|
1284
|
+
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
1285
|
+
// authentication BearerAuth required
|
|
1286
|
+
// http bearer authentication required
|
|
1287
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
1288
|
+
if (completionTimeout !== undefined) {
|
|
1289
|
+
localVarQueryParameter['completion_timeout'] = completionTimeout;
|
|
1290
|
+
}
|
|
1291
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
1292
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
1293
|
+
localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
|
|
1294
|
+
return {
|
|
1295
|
+
url: toPathString(localVarUrlObj),
|
|
1296
|
+
options: localVarRequestOptions,
|
|
1297
|
+
};
|
|
1298
|
+
},
|
|
1299
|
+
/**
|
|
1300
|
+
* Removes the input/output from the PROFINET device.
|
|
1301
|
+
* @summary Remove PROFINET Input/Ouptut
|
|
1302
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
1303
|
+
* @param {string} io Unique identifier to address an Input/Output in the cell.
|
|
1304
|
+
* @param {*} [options] Override http request option.
|
|
1305
|
+
* @throws {RequiredError}
|
|
1306
|
+
*/
|
|
1307
|
+
deleteProfinetIO: async (cell, io, options = {}) => {
|
|
1308
|
+
// verify required parameter 'cell' is not null or undefined
|
|
1309
|
+
assertParamExists('deleteProfinetIO', 'cell', cell);
|
|
1310
|
+
// verify required parameter 'io' is not null or undefined
|
|
1311
|
+
assertParamExists('deleteProfinetIO', 'io', io);
|
|
1312
|
+
const localVarPath = `/cells/{cell}/bus-ios/profinet/ios/{io}`
|
|
1313
|
+
.replace(`{${"cell"}}`, encodeURIComponent(String(cell)))
|
|
1314
|
+
.replace(`{${"io"}}`, encodeURIComponent(String(io)));
|
|
1315
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
1316
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
1317
|
+
let baseOptions;
|
|
1318
|
+
if (configuration) {
|
|
1319
|
+
baseOptions = configuration.baseOptions;
|
|
1320
|
+
}
|
|
1321
|
+
const localVarRequestOptions = { method: 'DELETE', ...baseOptions, ...options };
|
|
1322
|
+
const localVarHeaderParameter = {};
|
|
1323
|
+
const localVarQueryParameter = {};
|
|
1324
|
+
// authentication BasicAuth required
|
|
1325
|
+
// http basic authentication required
|
|
1326
|
+
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
1327
|
+
// authentication BearerAuth required
|
|
1328
|
+
// http bearer authentication required
|
|
1329
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
1330
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
1331
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
1332
|
+
localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
|
|
1333
|
+
return {
|
|
1334
|
+
url: toPathString(localVarUrlObj),
|
|
1335
|
+
options: localVarRequestOptions,
|
|
1336
|
+
};
|
|
1337
|
+
},
|
|
1338
|
+
/**
|
|
1339
|
+
* Get deployed BUS Inputs/Outputs Service.
|
|
1340
|
+
* @summary Get Service
|
|
1341
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
1342
|
+
* @param {*} [options] Override http request option.
|
|
1343
|
+
* @throws {RequiredError}
|
|
1344
|
+
*/
|
|
1345
|
+
getBusIOService: async (cell, options = {}) => {
|
|
1346
|
+
// verify required parameter 'cell' is not null or undefined
|
|
1347
|
+
assertParamExists('getBusIOService', 'cell', cell);
|
|
1348
|
+
const localVarPath = `/cells/{cell}/bus-ios`
|
|
1349
|
+
.replace(`{${"cell"}}`, encodeURIComponent(String(cell)));
|
|
1350
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
1351
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
1352
|
+
let baseOptions;
|
|
1353
|
+
if (configuration) {
|
|
1354
|
+
baseOptions = configuration.baseOptions;
|
|
1355
|
+
}
|
|
1356
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options };
|
|
1357
|
+
const localVarHeaderParameter = {};
|
|
1358
|
+
const localVarQueryParameter = {};
|
|
1359
|
+
// authentication BasicAuth required
|
|
1360
|
+
// http basic authentication required
|
|
1361
|
+
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
1362
|
+
// authentication BearerAuth required
|
|
1363
|
+
// http bearer authentication required
|
|
1364
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
1365
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
1366
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
1367
|
+
localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
|
|
1368
|
+
return {
|
|
1369
|
+
url: toPathString(localVarUrlObj),
|
|
1370
|
+
options: localVarRequestOptions,
|
|
1371
|
+
};
|
|
1372
|
+
},
|
|
1373
|
+
/**
|
|
1374
|
+
* Get the current state of the BUS Inputs/Outputs service.
|
|
1375
|
+
* @summary State
|
|
1376
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
1377
|
+
* @param {*} [options] Override http request option.
|
|
1378
|
+
* @throws {RequiredError}
|
|
1379
|
+
*/
|
|
1380
|
+
getBusIOState: async (cell, options = {}) => {
|
|
1381
|
+
// verify required parameter 'cell' is not null or undefined
|
|
1382
|
+
assertParamExists('getBusIOState', 'cell', cell);
|
|
1383
|
+
const localVarPath = `/cells/{cell}/bus-ios/state`
|
|
1384
|
+
.replace(`{${"cell"}}`, encodeURIComponent(String(cell)));
|
|
1385
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
1386
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
1387
|
+
let baseOptions;
|
|
1388
|
+
if (configuration) {
|
|
1389
|
+
baseOptions = configuration.baseOptions;
|
|
1390
|
+
}
|
|
1391
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options };
|
|
1392
|
+
const localVarHeaderParameter = {};
|
|
1393
|
+
const localVarQueryParameter = {};
|
|
1394
|
+
// authentication BasicAuth required
|
|
1395
|
+
// http basic authentication required
|
|
1396
|
+
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
1397
|
+
// authentication BearerAuth required
|
|
1398
|
+
// http bearer authentication required
|
|
1399
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
1400
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
1401
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
1402
|
+
localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
|
|
1403
|
+
return {
|
|
1404
|
+
url: toPathString(localVarUrlObj),
|
|
1405
|
+
options: localVarRequestOptions,
|
|
1406
|
+
};
|
|
1407
|
+
},
|
|
1408
|
+
/**
|
|
1409
|
+
* 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).
|
|
1410
|
+
* @summary Get Input/Output Values
|
|
1411
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
1412
|
+
* @param {Array<string>} [ios]
|
|
1413
|
+
* @param {*} [options] Override http request option.
|
|
1414
|
+
* @throws {RequiredError}
|
|
1415
|
+
*/
|
|
1416
|
+
getBusIOValues: async (cell, ios, options = {}) => {
|
|
1417
|
+
// verify required parameter 'cell' is not null or undefined
|
|
1418
|
+
assertParamExists('getBusIOValues', 'cell', cell);
|
|
1419
|
+
const localVarPath = `/cells/{cell}/bus-ios/ios/values`
|
|
1420
|
+
.replace(`{${"cell"}}`, encodeURIComponent(String(cell)));
|
|
1421
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
1422
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
1423
|
+
let baseOptions;
|
|
1424
|
+
if (configuration) {
|
|
1425
|
+
baseOptions = configuration.baseOptions;
|
|
1426
|
+
}
|
|
1427
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options };
|
|
1428
|
+
const localVarHeaderParameter = {};
|
|
1429
|
+
const localVarQueryParameter = {};
|
|
1430
|
+
// authentication BasicAuth required
|
|
1431
|
+
// http basic authentication required
|
|
1432
|
+
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
1433
|
+
// authentication BearerAuth required
|
|
1434
|
+
// http bearer authentication required
|
|
1435
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
1436
|
+
if (ios) {
|
|
1437
|
+
localVarQueryParameter['ios'] = ios;
|
|
1438
|
+
}
|
|
1439
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
1440
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
1441
|
+
localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
|
|
1442
|
+
return {
|
|
1443
|
+
url: toPathString(localVarUrlObj),
|
|
1444
|
+
options: localVarRequestOptions,
|
|
1445
|
+
};
|
|
1446
|
+
},
|
|
1447
|
+
/**
|
|
1448
|
+
* Get description of PROFINET
|
|
1449
|
+
* @summary Get PROFINET Description
|
|
1450
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
1451
|
+
* @param {*} [options] Override http request option.
|
|
1452
|
+
* @throws {RequiredError}
|
|
1453
|
+
*/
|
|
1454
|
+
getProfinetDescription: async (cell, options = {}) => {
|
|
1455
|
+
// verify required parameter 'cell' is not null or undefined
|
|
1456
|
+
assertParamExists('getProfinetDescription', 'cell', cell);
|
|
1457
|
+
const localVarPath = `/cells/{cell}/bus-ios/profinet/description`
|
|
1458
|
+
.replace(`{${"cell"}}`, encodeURIComponent(String(cell)));
|
|
1459
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
1460
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
1461
|
+
let baseOptions;
|
|
1462
|
+
if (configuration) {
|
|
1463
|
+
baseOptions = configuration.baseOptions;
|
|
1464
|
+
}
|
|
1465
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options };
|
|
1466
|
+
const localVarHeaderParameter = {};
|
|
1467
|
+
const localVarQueryParameter = {};
|
|
1468
|
+
// authentication BasicAuth required
|
|
1469
|
+
// http basic authentication required
|
|
1470
|
+
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
1471
|
+
// authentication BearerAuth required
|
|
1472
|
+
// http bearer authentication required
|
|
1473
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
1474
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
1475
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
1476
|
+
localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
|
|
1477
|
+
return {
|
|
1478
|
+
url: toPathString(localVarUrlObj),
|
|
1479
|
+
options: localVarRequestOptions,
|
|
1480
|
+
};
|
|
1481
|
+
},
|
|
1482
|
+
/**
|
|
1483
|
+
* Get input/output configuration of the PROFINET device as file.
|
|
1484
|
+
* @summary PROFINET Inputs/Outputs to File
|
|
1485
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
1486
|
+
* @param {number} [inputOffset]
|
|
1487
|
+
* @param {number} [outputOffset]
|
|
1488
|
+
* @param {*} [options] Override http request option.
|
|
1489
|
+
* @throws {RequiredError}
|
|
1490
|
+
*/
|
|
1491
|
+
getProfinetIOsFromFile: async (cell, inputOffset, outputOffset, options = {}) => {
|
|
1492
|
+
// verify required parameter 'cell' is not null or undefined
|
|
1493
|
+
assertParamExists('getProfinetIOsFromFile', 'cell', cell);
|
|
1494
|
+
const localVarPath = `/cells/{cell}/bus-ios/profinet/iofile`
|
|
1495
|
+
.replace(`{${"cell"}}`, encodeURIComponent(String(cell)));
|
|
1496
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
1497
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
1498
|
+
let baseOptions;
|
|
1499
|
+
if (configuration) {
|
|
1500
|
+
baseOptions = configuration.baseOptions;
|
|
1501
|
+
}
|
|
1502
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options };
|
|
1503
|
+
const localVarHeaderParameter = {};
|
|
1504
|
+
const localVarQueryParameter = {};
|
|
1505
|
+
// authentication BasicAuth required
|
|
1506
|
+
// http basic authentication required
|
|
1507
|
+
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
1508
|
+
// authentication BearerAuth required
|
|
1509
|
+
// http bearer authentication required
|
|
1510
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
1511
|
+
if (inputOffset !== undefined) {
|
|
1512
|
+
localVarQueryParameter['input_offset'] = inputOffset;
|
|
1513
|
+
}
|
|
1514
|
+
if (outputOffset !== undefined) {
|
|
1515
|
+
localVarQueryParameter['output_offset'] = outputOffset;
|
|
1516
|
+
}
|
|
1517
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
1518
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
1519
|
+
localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
|
|
1520
|
+
return {
|
|
1521
|
+
url: toPathString(localVarUrlObj),
|
|
1522
|
+
options: localVarRequestOptions,
|
|
1523
|
+
};
|
|
1524
|
+
},
|
|
1525
|
+
/**
|
|
1526
|
+
* List all BUS Input/Output descriptions.
|
|
1527
|
+
* @summary List Descriptions
|
|
1528
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
1529
|
+
* @param {*} [options] Override http request option.
|
|
1530
|
+
* @throws {RequiredError}
|
|
1531
|
+
*/
|
|
1532
|
+
listBusIODescriptions: async (cell, options = {}) => {
|
|
1533
|
+
// verify required parameter 'cell' is not null or undefined
|
|
1534
|
+
assertParamExists('listBusIODescriptions', 'cell', cell);
|
|
1535
|
+
const localVarPath = `/cells/{cell}/bus-ios/ios/description`
|
|
1536
|
+
.replace(`{${"cell"}}`, encodeURIComponent(String(cell)));
|
|
1537
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
1538
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
1539
|
+
let baseOptions;
|
|
1540
|
+
if (configuration) {
|
|
1541
|
+
baseOptions = configuration.baseOptions;
|
|
1542
|
+
}
|
|
1543
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options };
|
|
1544
|
+
const localVarHeaderParameter = {};
|
|
1545
|
+
const localVarQueryParameter = {};
|
|
1546
|
+
// authentication BasicAuth required
|
|
1547
|
+
// http basic authentication required
|
|
1548
|
+
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
1549
|
+
// authentication BearerAuth required
|
|
1550
|
+
// http bearer authentication required
|
|
1551
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
1552
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
1553
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
1554
|
+
localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
|
|
1555
|
+
return {
|
|
1556
|
+
url: toPathString(localVarUrlObj),
|
|
1557
|
+
options: localVarRequestOptions,
|
|
1558
|
+
};
|
|
1559
|
+
},
|
|
1560
|
+
/**
|
|
1561
|
+
* List all PROFINET input and outputs.
|
|
1562
|
+
* @summary List PROFINET Input/Output Configuration
|
|
1563
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
1564
|
+
* @param {*} [options] Override http request option.
|
|
1565
|
+
* @throws {RequiredError}
|
|
1566
|
+
*/
|
|
1567
|
+
listProfinetIOs: async (cell, options = {}) => {
|
|
1568
|
+
// verify required parameter 'cell' is not null or undefined
|
|
1569
|
+
assertParamExists('listProfinetIOs', 'cell', cell);
|
|
1570
|
+
const localVarPath = `/cells/{cell}/bus-ios/profinet/ios`
|
|
1571
|
+
.replace(`{${"cell"}}`, encodeURIComponent(String(cell)));
|
|
1572
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
1573
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
1574
|
+
let baseOptions;
|
|
1575
|
+
if (configuration) {
|
|
1576
|
+
baseOptions = configuration.baseOptions;
|
|
1577
|
+
}
|
|
1578
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options };
|
|
1579
|
+
const localVarHeaderParameter = {};
|
|
1580
|
+
const localVarQueryParameter = {};
|
|
1581
|
+
// authentication BasicAuth required
|
|
1582
|
+
// http basic authentication required
|
|
1583
|
+
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
1584
|
+
// authentication BearerAuth required
|
|
1585
|
+
// http bearer authentication required
|
|
1586
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
1587
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
1588
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
1589
|
+
localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
|
|
1590
|
+
return {
|
|
1591
|
+
url: toPathString(localVarUrlObj),
|
|
1592
|
+
options: localVarRequestOptions,
|
|
1593
|
+
};
|
|
1594
|
+
},
|
|
1595
|
+
/**
|
|
1596
|
+
* 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.
|
|
1597
|
+
* @summary Set Output Values
|
|
1598
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
1599
|
+
* @param {Array<IOValue>} iOValue
|
|
1600
|
+
* @param {*} [options] Override http request option.
|
|
1601
|
+
* @throws {RequiredError}
|
|
1602
|
+
*/
|
|
1603
|
+
setBusIOValues: async (cell, iOValue, options = {}) => {
|
|
1604
|
+
// verify required parameter 'cell' is not null or undefined
|
|
1605
|
+
assertParamExists('setBusIOValues', 'cell', cell);
|
|
1606
|
+
// verify required parameter 'iOValue' is not null or undefined
|
|
1607
|
+
assertParamExists('setBusIOValues', 'iOValue', iOValue);
|
|
1608
|
+
const localVarPath = `/cells/{cell}/bus-ios/ios/values`
|
|
1609
|
+
.replace(`{${"cell"}}`, encodeURIComponent(String(cell)));
|
|
1610
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
1611
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
1612
|
+
let baseOptions;
|
|
1613
|
+
if (configuration) {
|
|
1614
|
+
baseOptions = configuration.baseOptions;
|
|
1615
|
+
}
|
|
1616
|
+
const localVarRequestOptions = { method: 'PUT', ...baseOptions, ...options };
|
|
1617
|
+
const localVarHeaderParameter = {};
|
|
1618
|
+
const localVarQueryParameter = {};
|
|
1619
|
+
// authentication BasicAuth required
|
|
1620
|
+
// http basic authentication required
|
|
1621
|
+
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
1622
|
+
// authentication BearerAuth required
|
|
1623
|
+
// http bearer authentication required
|
|
1624
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
1625
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
1626
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
1627
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
1628
|
+
localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
|
|
1629
|
+
localVarRequestOptions.data = serializeDataIfNeeded(iOValue, localVarRequestOptions, configuration);
|
|
1630
|
+
return {
|
|
1631
|
+
url: toPathString(localVarUrlObj),
|
|
1632
|
+
options: localVarRequestOptions,
|
|
1633
|
+
};
|
|
1634
|
+
},
|
|
1635
|
+
/**
|
|
1636
|
+
* Sets inputs/outputs on the PROFINET device from file.
|
|
1637
|
+
* @summary Set PROFINET Inputs/Outputs from File
|
|
1638
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
1639
|
+
* @param {ProfinetInputOutputConfig} profinetInputOutputConfig
|
|
1640
|
+
* @param {*} [options] Override http request option.
|
|
1641
|
+
* @throws {RequiredError}
|
|
1642
|
+
*/
|
|
1643
|
+
setProfinetIOsFromFile: async (cell, profinetInputOutputConfig, options = {}) => {
|
|
1644
|
+
// verify required parameter 'cell' is not null or undefined
|
|
1645
|
+
assertParamExists('setProfinetIOsFromFile', 'cell', cell);
|
|
1646
|
+
// verify required parameter 'profinetInputOutputConfig' is not null or undefined
|
|
1647
|
+
assertParamExists('setProfinetIOsFromFile', 'profinetInputOutputConfig', profinetInputOutputConfig);
|
|
1648
|
+
const localVarPath = `/cells/{cell}/bus-ios/profinet/iofile`
|
|
1649
|
+
.replace(`{${"cell"}}`, encodeURIComponent(String(cell)));
|
|
1650
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
1651
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
1652
|
+
let baseOptions;
|
|
1653
|
+
if (configuration) {
|
|
1654
|
+
baseOptions = configuration.baseOptions;
|
|
1655
|
+
}
|
|
1656
|
+
const localVarRequestOptions = { method: 'PUT', ...baseOptions, ...options };
|
|
1657
|
+
const localVarHeaderParameter = {};
|
|
1658
|
+
const localVarQueryParameter = {};
|
|
1659
|
+
// authentication BasicAuth required
|
|
1660
|
+
// http basic authentication required
|
|
1661
|
+
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
1662
|
+
// authentication BearerAuth required
|
|
1663
|
+
// http bearer authentication required
|
|
1664
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
1665
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
1666
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
1667
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
1668
|
+
localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
|
|
1669
|
+
localVarRequestOptions.data = serializeDataIfNeeded(profinetInputOutputConfig, localVarRequestOptions, configuration);
|
|
1670
|
+
return {
|
|
1671
|
+
url: toPathString(localVarUrlObj),
|
|
1672
|
+
options: localVarRequestOptions,
|
|
1673
|
+
};
|
|
1674
|
+
},
|
|
1675
|
+
};
|
|
1676
|
+
};
|
|
1677
|
+
/**
|
|
1678
|
+
* BUSInputsOutputsApi - functional programming interface
|
|
1679
|
+
* @export
|
|
1680
|
+
*/
|
|
1681
|
+
export const BUSInputsOutputsApiFp = function (configuration) {
|
|
1682
|
+
const localVarAxiosParamCreator = BUSInputsOutputsApiAxiosParamCreator(configuration);
|
|
1683
|
+
return {
|
|
1684
|
+
/**
|
|
1685
|
+
* Add a BUS Inputs/Outputs Service to the cell.
|
|
1686
|
+
* @summary Add Service
|
|
1687
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
1688
|
+
* @param {BusIOType} busIOType
|
|
1689
|
+
* @param {number} [completionTimeout]
|
|
1690
|
+
* @param {*} [options] Override http request option.
|
|
1691
|
+
* @throws {RequiredError}
|
|
1692
|
+
*/
|
|
1693
|
+
async addBusIOService(cell, busIOType, completionTimeout, options) {
|
|
1694
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.addBusIOService(cell, busIOType, completionTimeout, options);
|
|
1695
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
1696
|
+
const localVarOperationServerBasePath = operationServerMap['BUSInputsOutputsApi.addBusIOService']?.[localVarOperationServerIndex]?.url;
|
|
1697
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
1698
|
+
},
|
|
1699
|
+
/**
|
|
1700
|
+
* Adds an input/output to or updates an input/output on the PROFINET device.
|
|
1701
|
+
* @summary Add PROFINET Input/Output
|
|
1702
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
1703
|
+
* @param {string} io Unique identifier to address an Input/Output in the cell.
|
|
1704
|
+
* @param {ProfinetIOData} profinetIOData
|
|
1705
|
+
* @param {*} [options] Override http request option.
|
|
1706
|
+
* @throws {RequiredError}
|
|
1707
|
+
*/
|
|
1708
|
+
async addProfinetIO(cell, io, profinetIOData, options) {
|
|
1709
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.addProfinetIO(cell, io, profinetIOData, options);
|
|
1710
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
1711
|
+
const localVarOperationServerBasePath = operationServerMap['BUSInputsOutputsApi.addProfinetIO']?.[localVarOperationServerIndex]?.url;
|
|
1712
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
1713
|
+
},
|
|
1714
|
+
/**
|
|
1715
|
+
* Delete BUS Inputs/Outputs Service from the cell.
|
|
1716
|
+
* @summary Clear Service
|
|
1717
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
1718
|
+
* @param {number} [completionTimeout]
|
|
1719
|
+
* @param {*} [options] Override http request option.
|
|
1720
|
+
* @throws {RequiredError}
|
|
1721
|
+
*/
|
|
1722
|
+
async clearBusIOService(cell, completionTimeout, options) {
|
|
1723
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.clearBusIOService(cell, completionTimeout, options);
|
|
1724
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
1725
|
+
const localVarOperationServerBasePath = operationServerMap['BUSInputsOutputsApi.clearBusIOService']?.[localVarOperationServerIndex]?.url;
|
|
1726
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
1727
|
+
},
|
|
1728
|
+
/**
|
|
1729
|
+
* Removes the input/output from the PROFINET device.
|
|
1730
|
+
* @summary Remove PROFINET Input/Ouptut
|
|
1731
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
1732
|
+
* @param {string} io Unique identifier to address an Input/Output in the cell.
|
|
1733
|
+
* @param {*} [options] Override http request option.
|
|
1734
|
+
* @throws {RequiredError}
|
|
1735
|
+
*/
|
|
1736
|
+
async deleteProfinetIO(cell, io, options) {
|
|
1737
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.deleteProfinetIO(cell, io, options);
|
|
1738
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
1739
|
+
const localVarOperationServerBasePath = operationServerMap['BUSInputsOutputsApi.deleteProfinetIO']?.[localVarOperationServerIndex]?.url;
|
|
1740
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
1741
|
+
},
|
|
1742
|
+
/**
|
|
1743
|
+
* Get deployed BUS Inputs/Outputs Service.
|
|
1744
|
+
* @summary Get Service
|
|
1745
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
1746
|
+
* @param {*} [options] Override http request option.
|
|
1747
|
+
* @throws {RequiredError}
|
|
1748
|
+
*/
|
|
1749
|
+
async getBusIOService(cell, options) {
|
|
1750
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.getBusIOService(cell, options);
|
|
1751
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
1752
|
+
const localVarOperationServerBasePath = operationServerMap['BUSInputsOutputsApi.getBusIOService']?.[localVarOperationServerIndex]?.url;
|
|
1753
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
1754
|
+
},
|
|
1755
|
+
/**
|
|
1756
|
+
* Get the current state of the BUS Inputs/Outputs service.
|
|
1757
|
+
* @summary State
|
|
1758
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
1759
|
+
* @param {*} [options] Override http request option.
|
|
1760
|
+
* @throws {RequiredError}
|
|
1761
|
+
*/
|
|
1762
|
+
async getBusIOState(cell, options) {
|
|
1763
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.getBusIOState(cell, options);
|
|
1764
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
1765
|
+
const localVarOperationServerBasePath = operationServerMap['BUSInputsOutputsApi.getBusIOState']?.[localVarOperationServerIndex]?.url;
|
|
1766
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
1767
|
+
},
|
|
1768
|
+
/**
|
|
1769
|
+
* 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).
|
|
1770
|
+
* @summary Get Input/Output Values
|
|
1771
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
1772
|
+
* @param {Array<string>} [ios]
|
|
1773
|
+
* @param {*} [options] Override http request option.
|
|
1774
|
+
* @throws {RequiredError}
|
|
1775
|
+
*/
|
|
1776
|
+
async getBusIOValues(cell, ios, options) {
|
|
1777
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.getBusIOValues(cell, ios, options);
|
|
1778
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
1779
|
+
const localVarOperationServerBasePath = operationServerMap['BUSInputsOutputsApi.getBusIOValues']?.[localVarOperationServerIndex]?.url;
|
|
1780
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
1781
|
+
},
|
|
1782
|
+
/**
|
|
1783
|
+
* Get description of PROFINET
|
|
1784
|
+
* @summary Get PROFINET Description
|
|
1785
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
1786
|
+
* @param {*} [options] Override http request option.
|
|
1787
|
+
* @throws {RequiredError}
|
|
1788
|
+
*/
|
|
1789
|
+
async getProfinetDescription(cell, options) {
|
|
1790
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.getProfinetDescription(cell, options);
|
|
1791
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
1792
|
+
const localVarOperationServerBasePath = operationServerMap['BUSInputsOutputsApi.getProfinetDescription']?.[localVarOperationServerIndex]?.url;
|
|
1793
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
1794
|
+
},
|
|
1795
|
+
/**
|
|
1796
|
+
* Get input/output configuration of the PROFINET device as file.
|
|
1797
|
+
* @summary PROFINET Inputs/Outputs to File
|
|
1798
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
1799
|
+
* @param {number} [inputOffset]
|
|
1800
|
+
* @param {number} [outputOffset]
|
|
1801
|
+
* @param {*} [options] Override http request option.
|
|
1802
|
+
* @throws {RequiredError}
|
|
1803
|
+
*/
|
|
1804
|
+
async getProfinetIOsFromFile(cell, inputOffset, outputOffset, options) {
|
|
1805
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.getProfinetIOsFromFile(cell, inputOffset, outputOffset, options);
|
|
1806
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
1807
|
+
const localVarOperationServerBasePath = operationServerMap['BUSInputsOutputsApi.getProfinetIOsFromFile']?.[localVarOperationServerIndex]?.url;
|
|
1808
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
1809
|
+
},
|
|
1810
|
+
/**
|
|
1811
|
+
* List all BUS Input/Output descriptions.
|
|
1812
|
+
* @summary List Descriptions
|
|
1813
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
1814
|
+
* @param {*} [options] Override http request option.
|
|
1815
|
+
* @throws {RequiredError}
|
|
1816
|
+
*/
|
|
1817
|
+
async listBusIODescriptions(cell, options) {
|
|
1818
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.listBusIODescriptions(cell, options);
|
|
1819
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
1820
|
+
const localVarOperationServerBasePath = operationServerMap['BUSInputsOutputsApi.listBusIODescriptions']?.[localVarOperationServerIndex]?.url;
|
|
1821
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
1822
|
+
},
|
|
1823
|
+
/**
|
|
1824
|
+
* List all PROFINET input and outputs.
|
|
1825
|
+
* @summary List PROFINET Input/Output Configuration
|
|
1826
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
1827
|
+
* @param {*} [options] Override http request option.
|
|
1828
|
+
* @throws {RequiredError}
|
|
1829
|
+
*/
|
|
1830
|
+
async listProfinetIOs(cell, options) {
|
|
1831
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.listProfinetIOs(cell, options);
|
|
1832
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
1833
|
+
const localVarOperationServerBasePath = operationServerMap['BUSInputsOutputsApi.listProfinetIOs']?.[localVarOperationServerIndex]?.url;
|
|
1834
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
1835
|
+
},
|
|
1836
|
+
/**
|
|
1837
|
+
* 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.
|
|
1838
|
+
* @summary Set Output Values
|
|
1839
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
1840
|
+
* @param {Array<IOValue>} iOValue
|
|
1841
|
+
* @param {*} [options] Override http request option.
|
|
1842
|
+
* @throws {RequiredError}
|
|
1843
|
+
*/
|
|
1844
|
+
async setBusIOValues(cell, iOValue, options) {
|
|
1845
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.setBusIOValues(cell, iOValue, options);
|
|
1846
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
1847
|
+
const localVarOperationServerBasePath = operationServerMap['BUSInputsOutputsApi.setBusIOValues']?.[localVarOperationServerIndex]?.url;
|
|
1848
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
1849
|
+
},
|
|
1850
|
+
/**
|
|
1851
|
+
* Sets inputs/outputs on the PROFINET device from file.
|
|
1852
|
+
* @summary Set PROFINET Inputs/Outputs from File
|
|
1853
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
1854
|
+
* @param {ProfinetInputOutputConfig} profinetInputOutputConfig
|
|
1855
|
+
* @param {*} [options] Override http request option.
|
|
1856
|
+
* @throws {RequiredError}
|
|
1857
|
+
*/
|
|
1858
|
+
async setProfinetIOsFromFile(cell, profinetInputOutputConfig, options) {
|
|
1859
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.setProfinetIOsFromFile(cell, profinetInputOutputConfig, options);
|
|
1860
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
1861
|
+
const localVarOperationServerBasePath = operationServerMap['BUSInputsOutputsApi.setProfinetIOsFromFile']?.[localVarOperationServerIndex]?.url;
|
|
1862
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
1863
|
+
},
|
|
1864
|
+
};
|
|
1865
|
+
};
|
|
1866
|
+
/**
|
|
1867
|
+
* BUSInputsOutputsApi - factory interface
|
|
1868
|
+
* @export
|
|
1869
|
+
*/
|
|
1870
|
+
export const BUSInputsOutputsApiFactory = function (configuration, basePath, axios) {
|
|
1871
|
+
const localVarFp = BUSInputsOutputsApiFp(configuration);
|
|
1872
|
+
return {
|
|
1873
|
+
/**
|
|
1874
|
+
* Add a BUS Inputs/Outputs Service to the cell.
|
|
1875
|
+
* @summary Add Service
|
|
1876
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
1877
|
+
* @param {BusIOType} busIOType
|
|
1878
|
+
* @param {number} [completionTimeout]
|
|
1879
|
+
* @param {*} [options] Override http request option.
|
|
1880
|
+
* @throws {RequiredError}
|
|
1881
|
+
*/
|
|
1882
|
+
addBusIOService(cell, busIOType, completionTimeout, options) {
|
|
1883
|
+
return localVarFp.addBusIOService(cell, busIOType, completionTimeout, options).then((request) => request(axios, basePath));
|
|
1884
|
+
},
|
|
1885
|
+
/**
|
|
1886
|
+
* Adds an input/output to or updates an input/output on the PROFINET device.
|
|
1887
|
+
* @summary Add PROFINET Input/Output
|
|
1888
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
1889
|
+
* @param {string} io Unique identifier to address an Input/Output in the cell.
|
|
1890
|
+
* @param {ProfinetIOData} profinetIOData
|
|
1891
|
+
* @param {*} [options] Override http request option.
|
|
1892
|
+
* @throws {RequiredError}
|
|
1893
|
+
*/
|
|
1894
|
+
addProfinetIO(cell, io, profinetIOData, options) {
|
|
1895
|
+
return localVarFp.addProfinetIO(cell, io, profinetIOData, options).then((request) => request(axios, basePath));
|
|
1896
|
+
},
|
|
1897
|
+
/**
|
|
1898
|
+
* Delete BUS Inputs/Outputs Service from the cell.
|
|
1899
|
+
* @summary Clear Service
|
|
1900
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
1901
|
+
* @param {number} [completionTimeout]
|
|
1902
|
+
* @param {*} [options] Override http request option.
|
|
1903
|
+
* @throws {RequiredError}
|
|
1904
|
+
*/
|
|
1905
|
+
clearBusIOService(cell, completionTimeout, options) {
|
|
1906
|
+
return localVarFp.clearBusIOService(cell, completionTimeout, options).then((request) => request(axios, basePath));
|
|
1907
|
+
},
|
|
1908
|
+
/**
|
|
1909
|
+
* Removes the input/output from the PROFINET device.
|
|
1910
|
+
* @summary Remove PROFINET Input/Ouptut
|
|
1911
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
1912
|
+
* @param {string} io Unique identifier to address an Input/Output in the cell.
|
|
1913
|
+
* @param {*} [options] Override http request option.
|
|
1914
|
+
* @throws {RequiredError}
|
|
1915
|
+
*/
|
|
1916
|
+
deleteProfinetIO(cell, io, options) {
|
|
1917
|
+
return localVarFp.deleteProfinetIO(cell, io, options).then((request) => request(axios, basePath));
|
|
1918
|
+
},
|
|
1919
|
+
/**
|
|
1920
|
+
* Get deployed BUS Inputs/Outputs Service.
|
|
1921
|
+
* @summary Get Service
|
|
1922
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
1923
|
+
* @param {*} [options] Override http request option.
|
|
1924
|
+
* @throws {RequiredError}
|
|
1925
|
+
*/
|
|
1926
|
+
getBusIOService(cell, options) {
|
|
1927
|
+
return localVarFp.getBusIOService(cell, options).then((request) => request(axios, basePath));
|
|
1928
|
+
},
|
|
1929
|
+
/**
|
|
1930
|
+
* Get the current state of the BUS Inputs/Outputs service.
|
|
1931
|
+
* @summary State
|
|
1932
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
1933
|
+
* @param {*} [options] Override http request option.
|
|
1934
|
+
* @throws {RequiredError}
|
|
1935
|
+
*/
|
|
1936
|
+
getBusIOState(cell, options) {
|
|
1937
|
+
return localVarFp.getBusIOState(cell, options).then((request) => request(axios, basePath));
|
|
1938
|
+
},
|
|
1939
|
+
/**
|
|
1940
|
+
* 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).
|
|
1941
|
+
* @summary Get Input/Output Values
|
|
1942
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
1943
|
+
* @param {Array<string>} [ios]
|
|
1944
|
+
* @param {*} [options] Override http request option.
|
|
1945
|
+
* @throws {RequiredError}
|
|
1946
|
+
*/
|
|
1947
|
+
getBusIOValues(cell, ios, options) {
|
|
1948
|
+
return localVarFp.getBusIOValues(cell, ios, options).then((request) => request(axios, basePath));
|
|
1949
|
+
},
|
|
1950
|
+
/**
|
|
1951
|
+
* Get description of PROFINET
|
|
1952
|
+
* @summary Get PROFINET Description
|
|
1953
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
1954
|
+
* @param {*} [options] Override http request option.
|
|
1955
|
+
* @throws {RequiredError}
|
|
1956
|
+
*/
|
|
1957
|
+
getProfinetDescription(cell, options) {
|
|
1958
|
+
return localVarFp.getProfinetDescription(cell, options).then((request) => request(axios, basePath));
|
|
1959
|
+
},
|
|
1960
|
+
/**
|
|
1961
|
+
* Get input/output configuration of the PROFINET device as file.
|
|
1962
|
+
* @summary PROFINET Inputs/Outputs to File
|
|
1963
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
1964
|
+
* @param {number} [inputOffset]
|
|
1965
|
+
* @param {number} [outputOffset]
|
|
1966
|
+
* @param {*} [options] Override http request option.
|
|
1967
|
+
* @throws {RequiredError}
|
|
1968
|
+
*/
|
|
1969
|
+
getProfinetIOsFromFile(cell, inputOffset, outputOffset, options) {
|
|
1970
|
+
return localVarFp.getProfinetIOsFromFile(cell, inputOffset, outputOffset, options).then((request) => request(axios, basePath));
|
|
1971
|
+
},
|
|
1972
|
+
/**
|
|
1973
|
+
* List all BUS Input/Output descriptions.
|
|
1974
|
+
* @summary List Descriptions
|
|
1975
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
1976
|
+
* @param {*} [options] Override http request option.
|
|
1977
|
+
* @throws {RequiredError}
|
|
1978
|
+
*/
|
|
1979
|
+
listBusIODescriptions(cell, options) {
|
|
1980
|
+
return localVarFp.listBusIODescriptions(cell, options).then((request) => request(axios, basePath));
|
|
1981
|
+
},
|
|
1982
|
+
/**
|
|
1983
|
+
* List all PROFINET input and outputs.
|
|
1984
|
+
* @summary List PROFINET Input/Output Configuration
|
|
1985
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
1986
|
+
* @param {*} [options] Override http request option.
|
|
1987
|
+
* @throws {RequiredError}
|
|
1988
|
+
*/
|
|
1989
|
+
listProfinetIOs(cell, options) {
|
|
1990
|
+
return localVarFp.listProfinetIOs(cell, options).then((request) => request(axios, basePath));
|
|
1991
|
+
},
|
|
1992
|
+
/**
|
|
1993
|
+
* 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.
|
|
1994
|
+
* @summary Set Output Values
|
|
1995
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
1996
|
+
* @param {Array<IOValue>} iOValue
|
|
1997
|
+
* @param {*} [options] Override http request option.
|
|
1998
|
+
* @throws {RequiredError}
|
|
1999
|
+
*/
|
|
2000
|
+
setBusIOValues(cell, iOValue, options) {
|
|
2001
|
+
return localVarFp.setBusIOValues(cell, iOValue, options).then((request) => request(axios, basePath));
|
|
2002
|
+
},
|
|
2003
|
+
/**
|
|
2004
|
+
* Sets inputs/outputs on the PROFINET device from file.
|
|
2005
|
+
* @summary Set PROFINET Inputs/Outputs from File
|
|
2006
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
2007
|
+
* @param {ProfinetInputOutputConfig} profinetInputOutputConfig
|
|
2008
|
+
* @param {*} [options] Override http request option.
|
|
2009
|
+
* @throws {RequiredError}
|
|
2010
|
+
*/
|
|
2011
|
+
setProfinetIOsFromFile(cell, profinetInputOutputConfig, options) {
|
|
2012
|
+
return localVarFp.setProfinetIOsFromFile(cell, profinetInputOutputConfig, options).then((request) => request(axios, basePath));
|
|
2013
|
+
},
|
|
2014
|
+
};
|
|
2015
|
+
};
|
|
2016
|
+
/**
|
|
2017
|
+
* BUSInputsOutputsApi - object-oriented interface
|
|
2018
|
+
* @export
|
|
2019
|
+
* @class BUSInputsOutputsApi
|
|
2020
|
+
* @extends {BaseAPI}
|
|
2021
|
+
*/
|
|
2022
|
+
export class BUSInputsOutputsApi extends BaseAPI {
|
|
2023
|
+
/**
|
|
2024
|
+
* Add a BUS Inputs/Outputs Service to the cell.
|
|
2025
|
+
* @summary Add Service
|
|
2026
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
2027
|
+
* @param {BusIOType} busIOType
|
|
2028
|
+
* @param {number} [completionTimeout]
|
|
2029
|
+
* @param {*} [options] Override http request option.
|
|
2030
|
+
* @throws {RequiredError}
|
|
2031
|
+
* @memberof BUSInputsOutputsApi
|
|
2032
|
+
*/
|
|
2033
|
+
addBusIOService(cell, busIOType, completionTimeout, options) {
|
|
2034
|
+
return BUSInputsOutputsApiFp(this.configuration).addBusIOService(cell, busIOType, completionTimeout, options).then((request) => request(this.axios, this.basePath));
|
|
2035
|
+
}
|
|
2036
|
+
/**
|
|
2037
|
+
* Adds an input/output to or updates an input/output on the PROFINET device.
|
|
2038
|
+
* @summary Add PROFINET Input/Output
|
|
2039
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
2040
|
+
* @param {string} io Unique identifier to address an Input/Output in the cell.
|
|
2041
|
+
* @param {ProfinetIOData} profinetIOData
|
|
2042
|
+
* @param {*} [options] Override http request option.
|
|
2043
|
+
* @throws {RequiredError}
|
|
2044
|
+
* @memberof BUSInputsOutputsApi
|
|
2045
|
+
*/
|
|
2046
|
+
addProfinetIO(cell, io, profinetIOData, options) {
|
|
2047
|
+
return BUSInputsOutputsApiFp(this.configuration).addProfinetIO(cell, io, profinetIOData, options).then((request) => request(this.axios, this.basePath));
|
|
2048
|
+
}
|
|
2049
|
+
/**
|
|
2050
|
+
* Delete BUS Inputs/Outputs Service from the cell.
|
|
2051
|
+
* @summary Clear Service
|
|
2052
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
2053
|
+
* @param {number} [completionTimeout]
|
|
2054
|
+
* @param {*} [options] Override http request option.
|
|
2055
|
+
* @throws {RequiredError}
|
|
2056
|
+
* @memberof BUSInputsOutputsApi
|
|
2057
|
+
*/
|
|
2058
|
+
clearBusIOService(cell, completionTimeout, options) {
|
|
2059
|
+
return BUSInputsOutputsApiFp(this.configuration).clearBusIOService(cell, completionTimeout, options).then((request) => request(this.axios, this.basePath));
|
|
2060
|
+
}
|
|
2061
|
+
/**
|
|
2062
|
+
* Removes the input/output from the PROFINET device.
|
|
2063
|
+
* @summary Remove PROFINET Input/Ouptut
|
|
2064
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
2065
|
+
* @param {string} io Unique identifier to address an Input/Output in the cell.
|
|
2066
|
+
* @param {*} [options] Override http request option.
|
|
2067
|
+
* @throws {RequiredError}
|
|
2068
|
+
* @memberof BUSInputsOutputsApi
|
|
2069
|
+
*/
|
|
2070
|
+
deleteProfinetIO(cell, io, options) {
|
|
2071
|
+
return BUSInputsOutputsApiFp(this.configuration).deleteProfinetIO(cell, io, options).then((request) => request(this.axios, this.basePath));
|
|
2072
|
+
}
|
|
2073
|
+
/**
|
|
2074
|
+
* Get deployed BUS Inputs/Outputs Service.
|
|
2075
|
+
* @summary Get Service
|
|
2076
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
2077
|
+
* @param {*} [options] Override http request option.
|
|
2078
|
+
* @throws {RequiredError}
|
|
2079
|
+
* @memberof BUSInputsOutputsApi
|
|
2080
|
+
*/
|
|
2081
|
+
getBusIOService(cell, options) {
|
|
2082
|
+
return BUSInputsOutputsApiFp(this.configuration).getBusIOService(cell, options).then((request) => request(this.axios, this.basePath));
|
|
2083
|
+
}
|
|
2084
|
+
/**
|
|
2085
|
+
* Get the current state of the BUS Inputs/Outputs service.
|
|
2086
|
+
* @summary State
|
|
2087
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
2088
|
+
* @param {*} [options] Override http request option.
|
|
2089
|
+
* @throws {RequiredError}
|
|
2090
|
+
* @memberof BUSInputsOutputsApi
|
|
2091
|
+
*/
|
|
2092
|
+
getBusIOState(cell, options) {
|
|
2093
|
+
return BUSInputsOutputsApiFp(this.configuration).getBusIOState(cell, options).then((request) => request(this.axios, this.basePath));
|
|
2094
|
+
}
|
|
2095
|
+
/**
|
|
2096
|
+
* 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).
|
|
2097
|
+
* @summary Get Input/Output Values
|
|
2098
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
2099
|
+
* @param {Array<string>} [ios]
|
|
2100
|
+
* @param {*} [options] Override http request option.
|
|
2101
|
+
* @throws {RequiredError}
|
|
2102
|
+
* @memberof BUSInputsOutputsApi
|
|
2103
|
+
*/
|
|
2104
|
+
getBusIOValues(cell, ios, options) {
|
|
2105
|
+
return BUSInputsOutputsApiFp(this.configuration).getBusIOValues(cell, ios, options).then((request) => request(this.axios, this.basePath));
|
|
2106
|
+
}
|
|
2107
|
+
/**
|
|
2108
|
+
* Get description of PROFINET
|
|
2109
|
+
* @summary Get PROFINET Description
|
|
2110
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
2111
|
+
* @param {*} [options] Override http request option.
|
|
2112
|
+
* @throws {RequiredError}
|
|
2113
|
+
* @memberof BUSInputsOutputsApi
|
|
2114
|
+
*/
|
|
2115
|
+
getProfinetDescription(cell, options) {
|
|
2116
|
+
return BUSInputsOutputsApiFp(this.configuration).getProfinetDescription(cell, options).then((request) => request(this.axios, this.basePath));
|
|
2117
|
+
}
|
|
2118
|
+
/**
|
|
2119
|
+
* Get input/output configuration of the PROFINET device as file.
|
|
2120
|
+
* @summary PROFINET Inputs/Outputs to File
|
|
2121
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
2122
|
+
* @param {number} [inputOffset]
|
|
2123
|
+
* @param {number} [outputOffset]
|
|
2124
|
+
* @param {*} [options] Override http request option.
|
|
2125
|
+
* @throws {RequiredError}
|
|
2126
|
+
* @memberof BUSInputsOutputsApi
|
|
2127
|
+
*/
|
|
2128
|
+
getProfinetIOsFromFile(cell, inputOffset, outputOffset, options) {
|
|
2129
|
+
return BUSInputsOutputsApiFp(this.configuration).getProfinetIOsFromFile(cell, inputOffset, outputOffset, options).then((request) => request(this.axios, this.basePath));
|
|
2130
|
+
}
|
|
2131
|
+
/**
|
|
2132
|
+
* List all BUS Input/Output descriptions.
|
|
2133
|
+
* @summary List Descriptions
|
|
2134
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
2135
|
+
* @param {*} [options] Override http request option.
|
|
2136
|
+
* @throws {RequiredError}
|
|
2137
|
+
* @memberof BUSInputsOutputsApi
|
|
2138
|
+
*/
|
|
2139
|
+
listBusIODescriptions(cell, options) {
|
|
2140
|
+
return BUSInputsOutputsApiFp(this.configuration).listBusIODescriptions(cell, options).then((request) => request(this.axios, this.basePath));
|
|
2141
|
+
}
|
|
2142
|
+
/**
|
|
2143
|
+
* List all PROFINET input and outputs.
|
|
2144
|
+
* @summary List PROFINET Input/Output Configuration
|
|
2145
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
2146
|
+
* @param {*} [options] Override http request option.
|
|
2147
|
+
* @throws {RequiredError}
|
|
2148
|
+
* @memberof BUSInputsOutputsApi
|
|
2149
|
+
*/
|
|
2150
|
+
listProfinetIOs(cell, options) {
|
|
2151
|
+
return BUSInputsOutputsApiFp(this.configuration).listProfinetIOs(cell, options).then((request) => request(this.axios, this.basePath));
|
|
2152
|
+
}
|
|
2153
|
+
/**
|
|
2154
|
+
* 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.
|
|
2155
|
+
* @summary Set Output Values
|
|
2156
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
2157
|
+
* @param {Array<IOValue>} iOValue
|
|
2158
|
+
* @param {*} [options] Override http request option.
|
|
2159
|
+
* @throws {RequiredError}
|
|
2160
|
+
* @memberof BUSInputsOutputsApi
|
|
2161
|
+
*/
|
|
2162
|
+
setBusIOValues(cell, iOValue, options) {
|
|
2163
|
+
return BUSInputsOutputsApiFp(this.configuration).setBusIOValues(cell, iOValue, options).then((request) => request(this.axios, this.basePath));
|
|
2164
|
+
}
|
|
2165
|
+
/**
|
|
2166
|
+
* Sets inputs/outputs on the PROFINET device from file.
|
|
2167
|
+
* @summary Set PROFINET Inputs/Outputs from File
|
|
2168
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
2169
|
+
* @param {ProfinetInputOutputConfig} profinetInputOutputConfig
|
|
2170
|
+
* @param {*} [options] Override http request option.
|
|
2171
|
+
* @throws {RequiredError}
|
|
2172
|
+
* @memberof BUSInputsOutputsApi
|
|
2173
|
+
*/
|
|
2174
|
+
setProfinetIOsFromFile(cell, profinetInputOutputConfig, options) {
|
|
2175
|
+
return BUSInputsOutputsApiFp(this.configuration).setProfinetIOsFromFile(cell, profinetInputOutputConfig, options).then((request) => request(this.axios, this.basePath));
|
|
2176
|
+
}
|
|
2177
|
+
}
|
|
1122
2178
|
/**
|
|
1123
2179
|
* CellApi - axios parameter creator
|
|
1124
2180
|
* @export
|