@wandelbots/nova-api 25.7.0-dev.9 → 25.8.0-dev.2
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/v1/api.d.ts +5 -1
- package/v1/api.js +5 -1
- package/v1/api.js.map +1 -1
- package/v1/api.ts +5 -1
- package/v1/base.d.ts +1 -1
- package/v1/base.js +1 -1
- package/v1/base.ts +1 -1
- package/v1/common.d.ts +1 -1
- package/v1/common.js +1 -1
- package/v1/common.ts +1 -1
- package/v1/configuration.d.ts +1 -1
- package/v1/configuration.js +1 -1
- package/v1/configuration.ts +1 -1
- package/v1/index.d.ts +1 -1
- package/v1/index.js +1 -1
- package/v1/index.ts +1 -1
- package/v2/api.d.ts +2009 -717
- package/v2/api.js +1449 -291
- package/v2/api.js.map +1 -1
- package/v2/api.ts +2767 -755
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,8 +103,17 @@ export const Direction = {
|
|
|
86
103
|
DirectionForward: 'DIRECTION_FORWARD',
|
|
87
104
|
DirectionBackward: 'DIRECTION_BACKWARD'
|
|
88
105
|
};
|
|
89
|
-
export const
|
|
90
|
-
|
|
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'
|
|
91
117
|
};
|
|
92
118
|
export const FanucControllerKindEnum = {
|
|
93
119
|
FanucController: 'FanucController'
|
|
@@ -153,6 +179,21 @@ export const IntegerValueValueTypeEnum = {
|
|
|
153
179
|
export const JoggingDetailsKindEnum = {
|
|
154
180
|
Jogging: 'JOGGING'
|
|
155
181
|
};
|
|
182
|
+
export const JoggingPausedByUserKindEnum = {
|
|
183
|
+
PausedByUser: 'PAUSED_BY_USER'
|
|
184
|
+
};
|
|
185
|
+
export const JoggingPausedNearCollisionKindEnum = {
|
|
186
|
+
PausedNearCollision: 'PAUSED_NEAR_COLLISION'
|
|
187
|
+
};
|
|
188
|
+
export const JoggingPausedNearJointLimitKindEnum = {
|
|
189
|
+
PausedNearJointLimit: 'PAUSED_NEAR_JOINT_LIMIT'
|
|
190
|
+
};
|
|
191
|
+
export const JoggingPausedOnIOKindEnum = {
|
|
192
|
+
PausedOnIo: 'PAUSED_ON_IO'
|
|
193
|
+
};
|
|
194
|
+
export const JoggingRunningKindEnum = {
|
|
195
|
+
Running: 'RUNNING'
|
|
196
|
+
};
|
|
156
197
|
export const JointVelocityRequestMessageTypeEnum = {
|
|
157
198
|
JointVelocityRequest: 'JointVelocityRequest'
|
|
158
199
|
};
|
|
@@ -186,6 +227,9 @@ export const Manufacturer = {
|
|
|
186
227
|
Universalrobots: 'universalrobots',
|
|
187
228
|
Yaskawa: 'yaskawa'
|
|
188
229
|
};
|
|
230
|
+
export const MidpointInsertionAlgorithmAlgorithmNameEnum = {
|
|
231
|
+
MidpointInsertionAlgorithm: 'MidpointInsertionAlgorithm'
|
|
232
|
+
};
|
|
189
233
|
export const MovementErrorResponseKindEnum = {
|
|
190
234
|
MotionError: 'MOTION_ERROR'
|
|
191
235
|
};
|
|
@@ -275,21 +319,6 @@ export const PauseMovementRequestMessageTypeEnum = {
|
|
|
275
319
|
export const PauseMovementResponseKindEnum = {
|
|
276
320
|
PauseReceived: 'PAUSE_RECEIVED'
|
|
277
321
|
};
|
|
278
|
-
export const PausedByRequestKindEnum = {
|
|
279
|
-
PausedByUser: 'PAUSED_BY_USER'
|
|
280
|
-
};
|
|
281
|
-
export const PausedByUserKindEnum = {
|
|
282
|
-
PausedByUser: 'PAUSED_BY_USER'
|
|
283
|
-
};
|
|
284
|
-
export const PausedNearCollisionKindEnum = {
|
|
285
|
-
PausedNearCollision: 'PAUSED_NEAR_COLLISION'
|
|
286
|
-
};
|
|
287
|
-
export const PausedNearJointLimitKindEnum = {
|
|
288
|
-
PausedNearJointLimit: 'PAUSED_NEAR_JOINT_LIMIT'
|
|
289
|
-
};
|
|
290
|
-
export const PausedOnIOKindEnum = {
|
|
291
|
-
PausedOnIo: 'PAUSED_ON_IO'
|
|
292
|
-
};
|
|
293
322
|
export const PlaneShapeTypeEnum = {
|
|
294
323
|
Plane: 'plane'
|
|
295
324
|
};
|
|
@@ -299,6 +328,36 @@ export const PlaybackSpeedRequestMessageTypeEnum = {
|
|
|
299
328
|
export const PlaybackSpeedResponseKindEnum = {
|
|
300
329
|
PlaybackSpeedReceived: 'PLAYBACK_SPEED_RECEIVED'
|
|
301
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
|
+
};
|
|
302
361
|
export const RectangleShapeTypeEnum = {
|
|
303
362
|
Rectangle: 'rectangle'
|
|
304
363
|
};
|
|
@@ -315,22 +374,16 @@ export const ReleaseChannel = {
|
|
|
315
374
|
Next: 'next'
|
|
316
375
|
};
|
|
317
376
|
/**
|
|
318
|
-
*
|
|
377
|
+
* Defines the current system mode of the robot system, including NOVA communicating with the robot controller. ### MODE_CONTROLLER_NOT_CONFIGURED No controller with the specified identifier is configured. Call [addRobotController](addRobotController) to register a controller. ### MODE_INITIALIZING Indicates that a connection to the robot controller is established or reestablished in case of a disconnect. On success, the controller is set to MODE_MONITOR. On failure, the initialization process is retried until successful or cancelled by the user. ### MODE_MONITOR Read-only mode with an active controller connection. - Receives robot state and I/O signals - Move requests are rejected - No commands are sent to the controller ### MODE_CONTROL Active control mode. **Movement is possible in this mode** The robot is cyclically commanded to hold its current position. The robot state is received in sync with the controller cycle. Motion and jogging requests are accepted and executed. Input/Output interaction is enabled. ### MODE_FREE_DRIVE Read-only mode with servo motors enabled for manual movement (Free Drive). Move requests are rejected. Not supported by all robots: Use [getSupportedModes](getSupportedModes) to check Free Drive availability.
|
|
319
378
|
* @export
|
|
320
379
|
* @enum {string}
|
|
321
380
|
*/
|
|
322
381
|
export const RobotSystemMode = {
|
|
323
|
-
|
|
324
|
-
|
|
325
|
-
|
|
326
|
-
|
|
327
|
-
|
|
328
|
-
};
|
|
329
|
-
export const RunningKindEnum = {
|
|
330
|
-
Running: 'RUNNING'
|
|
331
|
-
};
|
|
332
|
-
export const Running1KindEnum = {
|
|
333
|
-
Running: 'RUNNING'
|
|
382
|
+
ModeControllerNotConfigured: 'MODE_CONTROLLER_NOT_CONFIGURED',
|
|
383
|
+
ModeInitializing: 'MODE_INITIALIZING',
|
|
384
|
+
ModeMonitor: 'MODE_MONITOR',
|
|
385
|
+
ModeControl: 'MODE_CONTROL',
|
|
386
|
+
ModeFreeDrive: 'MODE_FREE_DRIVE'
|
|
334
387
|
};
|
|
335
388
|
/**
|
|
336
389
|
* Current safety state of the configured robot controller. Operation modes in which the attached motion groups can be moved are: - SAFETY_STATE_NORMAL - SAFETY_STATE_REDUCED All other modes are considered as non-operational.
|
|
@@ -437,9 +490,24 @@ export const TrajectoryDataMessageTypeEnum = {
|
|
|
437
490
|
export const TrajectoryDetailsKindEnum = {
|
|
438
491
|
Trajectory: 'TRAJECTORY'
|
|
439
492
|
};
|
|
493
|
+
export const TrajectoryEndedKindEnum = {
|
|
494
|
+
EndOfTrajectory: 'END_OF_TRAJECTORY'
|
|
495
|
+
};
|
|
440
496
|
export const TrajectoryIdMessageTypeEnum = {
|
|
441
497
|
TrajectoryId: 'TrajectoryId'
|
|
442
498
|
};
|
|
499
|
+
export const TrajectoryPausedByUserKindEnum = {
|
|
500
|
+
PausedByUser: 'PAUSED_BY_USER'
|
|
501
|
+
};
|
|
502
|
+
export const TrajectoryPausedOnIOKindEnum = {
|
|
503
|
+
PausedOnIo: 'PAUSED_ON_IO'
|
|
504
|
+
};
|
|
505
|
+
export const TrajectoryRunningKindEnum = {
|
|
506
|
+
Running: 'RUNNING'
|
|
507
|
+
};
|
|
508
|
+
export const TrajectoryWaitForIOKindEnum = {
|
|
509
|
+
WaitForIo: 'WAIT_FOR_IO'
|
|
510
|
+
};
|
|
443
511
|
/**
|
|
444
512
|
* The unit of input/output value.
|
|
445
513
|
* @export
|
|
@@ -503,6 +571,7 @@ export const VirtualControllerTypes = {
|
|
|
503
571
|
FanucCrx20ial: 'fanuc-crx20ial',
|
|
504
572
|
FanucCrx25ia: 'fanuc-crx25ia',
|
|
505
573
|
FanucCrx30ia: 'fanuc-crx30ia',
|
|
574
|
+
FanucCrx5ia: 'fanuc-crx5ia',
|
|
506
575
|
FanucLrMate200iD: 'fanuc-lr_mate_200iD',
|
|
507
576
|
FanucLrMate200iD4S: 'fanuc-lr_mate_200iD4S',
|
|
508
577
|
FanucLrMate200iD7L: 'fanuc-lr_mate_200iD7L',
|
|
@@ -510,6 +579,7 @@ export const VirtualControllerTypes = {
|
|
|
510
579
|
FanucM10iD16S: 'fanuc-m10iD16S',
|
|
511
580
|
FanucM20iD25: 'fanuc-m20iD25',
|
|
512
581
|
FanucM20iD35: 'fanuc-m20iD35',
|
|
582
|
+
FanucM710iC20L: 'fanuc-m710iC20L',
|
|
513
583
|
FanucM900iB280L: 'fanuc-m900iB280L',
|
|
514
584
|
FanucM900iB360E: 'fanuc-m900iB360E',
|
|
515
585
|
FanucR2000ic125l: 'fanuc-r2000ic125l',
|
|
@@ -577,9 +647,6 @@ export const VirtualControllerTypes = {
|
|
|
577
647
|
YaskawaHc10dtp: 'yaskawa-hc10dtp',
|
|
578
648
|
YaskawaHc20dtp: 'yaskawa-hc20dtp'
|
|
579
649
|
};
|
|
580
|
-
export const WaitForIOKindEnum = {
|
|
581
|
-
WaitForIo: 'WAIT_FOR_IO'
|
|
582
|
-
};
|
|
583
650
|
export const YaskawaControllerKindEnum = {
|
|
584
651
|
YaskawaController: 'YaskawaController'
|
|
585
652
|
};
|
|
@@ -590,7 +657,7 @@ export const YaskawaControllerKindEnum = {
|
|
|
590
657
|
export const ApplicationApiAxiosParamCreator = function (configuration) {
|
|
591
658
|
return {
|
|
592
659
|
/**
|
|
593
|
-
* 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
|
|
660
|
+
* 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.
|
|
594
661
|
* @summary Add Application
|
|
595
662
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
596
663
|
* @param {App} app
|
|
@@ -847,7 +914,7 @@ export const ApplicationApiFp = function (configuration) {
|
|
|
847
914
|
const localVarAxiosParamCreator = ApplicationApiAxiosParamCreator(configuration);
|
|
848
915
|
return {
|
|
849
916
|
/**
|
|
850
|
-
* 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
|
|
917
|
+
* 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.
|
|
851
918
|
* @summary Add Application
|
|
852
919
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
853
920
|
* @param {App} app
|
|
@@ -943,7 +1010,7 @@ export const ApplicationApiFactory = function (configuration, basePath, axios) {
|
|
|
943
1010
|
const localVarFp = ApplicationApiFp(configuration);
|
|
944
1011
|
return {
|
|
945
1012
|
/**
|
|
946
|
-
* 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
|
|
1013
|
+
* 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.
|
|
947
1014
|
* @summary Add Application
|
|
948
1015
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
949
1016
|
* @param {App} app
|
|
@@ -1014,86 +1081,1098 @@ export const ApplicationApiFactory = function (configuration, basePath, axios) {
|
|
|
1014
1081
|
};
|
|
1015
1082
|
};
|
|
1016
1083
|
/**
|
|
1017
|
-
* ApplicationApi - object-oriented interface
|
|
1084
|
+
* ApplicationApi - object-oriented interface
|
|
1085
|
+
* @export
|
|
1086
|
+
* @class ApplicationApi
|
|
1087
|
+
* @extends {BaseAPI}
|
|
1088
|
+
*/
|
|
1089
|
+
export class ApplicationApi extends BaseAPI {
|
|
1090
|
+
/**
|
|
1091
|
+
* 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.
|
|
1092
|
+
* @summary Add Application
|
|
1093
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
1094
|
+
* @param {App} app
|
|
1095
|
+
* @param {number} [completionTimeout]
|
|
1096
|
+
* @param {*} [options] Override http request option.
|
|
1097
|
+
* @throws {RequiredError}
|
|
1098
|
+
* @memberof ApplicationApi
|
|
1099
|
+
*/
|
|
1100
|
+
addApp(cell, app, completionTimeout, options) {
|
|
1101
|
+
return ApplicationApiFp(this.configuration).addApp(cell, app, completionTimeout, options).then((request) => request(this.axios, this.basePath));
|
|
1102
|
+
}
|
|
1103
|
+
/**
|
|
1104
|
+
* Delete all GUI applications from the cell.
|
|
1105
|
+
* @summary Clear Applications
|
|
1106
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
1107
|
+
* @param {number} [completionTimeout]
|
|
1108
|
+
* @param {*} [options] Override http request option.
|
|
1109
|
+
* @throws {RequiredError}
|
|
1110
|
+
* @memberof ApplicationApi
|
|
1111
|
+
*/
|
|
1112
|
+
clearApps(cell, completionTimeout, options) {
|
|
1113
|
+
return ApplicationApiFp(this.configuration).clearApps(cell, completionTimeout, options).then((request) => request(this.axios, this.basePath));
|
|
1114
|
+
}
|
|
1115
|
+
/**
|
|
1116
|
+
* Delete a GUI application from the cell.
|
|
1117
|
+
* @summary Delete Application
|
|
1118
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
1119
|
+
* @param {string} app
|
|
1120
|
+
* @param {number} [completionTimeout]
|
|
1121
|
+
* @param {*} [options] Override http request option.
|
|
1122
|
+
* @throws {RequiredError}
|
|
1123
|
+
* @memberof ApplicationApi
|
|
1124
|
+
*/
|
|
1125
|
+
deleteApp(cell, app, completionTimeout, options) {
|
|
1126
|
+
return ApplicationApiFp(this.configuration).deleteApp(cell, app, completionTimeout, options).then((request) => request(this.axios, this.basePath));
|
|
1127
|
+
}
|
|
1128
|
+
/**
|
|
1129
|
+
* 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.
|
|
1130
|
+
* @summary Configuration
|
|
1131
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
1132
|
+
* @param {string} app
|
|
1133
|
+
* @param {*} [options] Override http request option.
|
|
1134
|
+
* @throws {RequiredError}
|
|
1135
|
+
* @memberof ApplicationApi
|
|
1136
|
+
*/
|
|
1137
|
+
getApp(cell, app, options) {
|
|
1138
|
+
return ApplicationApiFp(this.configuration).getApp(cell, app, options).then((request) => request(this.axios, this.basePath));
|
|
1139
|
+
}
|
|
1140
|
+
/**
|
|
1141
|
+
* 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.
|
|
1142
|
+
* @summary List Applications
|
|
1143
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
1144
|
+
* @param {*} [options] Override http request option.
|
|
1145
|
+
* @throws {RequiredError}
|
|
1146
|
+
* @memberof ApplicationApi
|
|
1147
|
+
*/
|
|
1148
|
+
listApps(cell, options) {
|
|
1149
|
+
return ApplicationApiFp(this.configuration).listApps(cell, options).then((request) => request(this.axios, this.basePath));
|
|
1150
|
+
}
|
|
1151
|
+
/**
|
|
1152
|
+
* Update the configuration of a GUI application in the cell.
|
|
1153
|
+
* @summary Update Configuration
|
|
1154
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
1155
|
+
* @param {string} app
|
|
1156
|
+
* @param {App} app2
|
|
1157
|
+
* @param {number} [completionTimeout]
|
|
1158
|
+
* @param {*} [options] Override http request option.
|
|
1159
|
+
* @throws {RequiredError}
|
|
1160
|
+
* @memberof ApplicationApi
|
|
1161
|
+
*/
|
|
1162
|
+
updateApp(cell, app, app2, completionTimeout, options) {
|
|
1163
|
+
return ApplicationApiFp(this.configuration).updateApp(cell, app, app2, completionTimeout, options).then((request) => request(this.axios, this.basePath));
|
|
1164
|
+
}
|
|
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
|
|
1018
2018
|
* @export
|
|
1019
|
-
* @class
|
|
2019
|
+
* @class BUSInputsOutputsApi
|
|
1020
2020
|
* @extends {BaseAPI}
|
|
1021
2021
|
*/
|
|
1022
|
-
export class
|
|
2022
|
+
export class BUSInputsOutputsApi extends BaseAPI {
|
|
1023
2023
|
/**
|
|
1024
|
-
*
|
|
1025
|
-
* @summary Add
|
|
2024
|
+
* Add a BUS Inputs/Outputs Service to the cell.
|
|
2025
|
+
* @summary Add Service
|
|
1026
2026
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
1027
|
-
* @param {
|
|
2027
|
+
* @param {BusIOType} busIOType
|
|
1028
2028
|
* @param {number} [completionTimeout]
|
|
1029
2029
|
* @param {*} [options] Override http request option.
|
|
1030
2030
|
* @throws {RequiredError}
|
|
1031
|
-
* @memberof
|
|
2031
|
+
* @memberof BUSInputsOutputsApi
|
|
1032
2032
|
*/
|
|
1033
|
-
|
|
1034
|
-
return
|
|
2033
|
+
addBusIOService(cell, busIOType, completionTimeout, options) {
|
|
2034
|
+
return BUSInputsOutputsApiFp(this.configuration).addBusIOService(cell, busIOType, completionTimeout, options).then((request) => request(this.axios, this.basePath));
|
|
1035
2035
|
}
|
|
1036
2036
|
/**
|
|
1037
|
-
*
|
|
1038
|
-
* @summary
|
|
2037
|
+
* Adds an input/output to or updates an input/output on the PROFINET device.
|
|
2038
|
+
* @summary Add PROFINET Input/Output
|
|
1039
2039
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
1040
|
-
* @param {
|
|
2040
|
+
* @param {string} io Unique identifier to address an Input/Output in the cell.
|
|
2041
|
+
* @param {ProfinetIOData} profinetIOData
|
|
1041
2042
|
* @param {*} [options] Override http request option.
|
|
1042
2043
|
* @throws {RequiredError}
|
|
1043
|
-
* @memberof
|
|
2044
|
+
* @memberof BUSInputsOutputsApi
|
|
1044
2045
|
*/
|
|
1045
|
-
|
|
1046
|
-
return
|
|
2046
|
+
addProfinetIO(cell, io, profinetIOData, options) {
|
|
2047
|
+
return BUSInputsOutputsApiFp(this.configuration).addProfinetIO(cell, io, profinetIOData, options).then((request) => request(this.axios, this.basePath));
|
|
1047
2048
|
}
|
|
1048
2049
|
/**
|
|
1049
|
-
* Delete
|
|
1050
|
-
* @summary
|
|
2050
|
+
* Delete BUS Inputs/Outputs Service from the cell.
|
|
2051
|
+
* @summary Clear Service
|
|
1051
2052
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
1052
|
-
* @param {string} app
|
|
1053
2053
|
* @param {number} [completionTimeout]
|
|
1054
2054
|
* @param {*} [options] Override http request option.
|
|
1055
2055
|
* @throws {RequiredError}
|
|
1056
|
-
* @memberof
|
|
2056
|
+
* @memberof BUSInputsOutputsApi
|
|
1057
2057
|
*/
|
|
1058
|
-
|
|
1059
|
-
return
|
|
2058
|
+
clearBusIOService(cell, completionTimeout, options) {
|
|
2059
|
+
return BUSInputsOutputsApiFp(this.configuration).clearBusIOService(cell, completionTimeout, options).then((request) => request(this.axios, this.basePath));
|
|
1060
2060
|
}
|
|
1061
2061
|
/**
|
|
1062
|
-
*
|
|
1063
|
-
* @summary
|
|
2062
|
+
* Removes the input/output from the PROFINET device.
|
|
2063
|
+
* @summary Remove PROFINET Input/Ouptut
|
|
1064
2064
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
1065
|
-
* @param {string}
|
|
2065
|
+
* @param {string} io Unique identifier to address an Input/Output in the cell.
|
|
1066
2066
|
* @param {*} [options] Override http request option.
|
|
1067
2067
|
* @throws {RequiredError}
|
|
1068
|
-
* @memberof
|
|
2068
|
+
* @memberof BUSInputsOutputsApi
|
|
1069
2069
|
*/
|
|
1070
|
-
|
|
1071
|
-
return
|
|
2070
|
+
deleteProfinetIO(cell, io, options) {
|
|
2071
|
+
return BUSInputsOutputsApiFp(this.configuration).deleteProfinetIO(cell, io, options).then((request) => request(this.axios, this.basePath));
|
|
1072
2072
|
}
|
|
1073
2073
|
/**
|
|
1074
|
-
*
|
|
1075
|
-
* @summary
|
|
2074
|
+
* Get deployed BUS Inputs/Outputs Service.
|
|
2075
|
+
* @summary Get Service
|
|
1076
2076
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
1077
2077
|
* @param {*} [options] Override http request option.
|
|
1078
2078
|
* @throws {RequiredError}
|
|
1079
|
-
* @memberof
|
|
2079
|
+
* @memberof BUSInputsOutputsApi
|
|
1080
2080
|
*/
|
|
1081
|
-
|
|
1082
|
-
return
|
|
2081
|
+
getBusIOService(cell, options) {
|
|
2082
|
+
return BUSInputsOutputsApiFp(this.configuration).getBusIOService(cell, options).then((request) => request(this.axios, this.basePath));
|
|
1083
2083
|
}
|
|
1084
2084
|
/**
|
|
1085
|
-
*
|
|
1086
|
-
* @summary
|
|
2085
|
+
* Get the current state of the BUS Inputs/Outputs service.
|
|
2086
|
+
* @summary State
|
|
1087
2087
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
1088
|
-
* @param {string} app
|
|
1089
|
-
* @param {App} app2
|
|
1090
|
-
* @param {number} [completionTimeout]
|
|
1091
2088
|
* @param {*} [options] Override http request option.
|
|
1092
2089
|
* @throws {RequiredError}
|
|
1093
|
-
* @memberof
|
|
2090
|
+
* @memberof BUSInputsOutputsApi
|
|
1094
2091
|
*/
|
|
1095
|
-
|
|
1096
|
-
return
|
|
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));
|
|
1097
2176
|
}
|
|
1098
2177
|
}
|
|
1099
2178
|
/**
|
|
@@ -1902,45 +2981,6 @@ export const ControllerApiAxiosParamCreator = function (configuration) {
|
|
|
1902
2981
|
options: localVarRequestOptions,
|
|
1903
2982
|
};
|
|
1904
2983
|
},
|
|
1905
|
-
/**
|
|
1906
|
-
* Get the current robot system mode of a registered robot controller. The robot system mode indicates if a robot controller can be used. See [setDefaultMode](setDefaultMode) for more information about the different modes. The mode is influenced by the operating mode of the robot controller. The operating mode can be changed via [setDefaultMode](setDefaultMode). Request the current operating mode of the robot controller via [getCurrentRobotControllerState](getCurrentRobotControllerState).
|
|
1907
|
-
* @summary Current Mode
|
|
1908
|
-
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
1909
|
-
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
1910
|
-
* @param {*} [options] Override http request option.
|
|
1911
|
-
* @throws {RequiredError}
|
|
1912
|
-
*/
|
|
1913
|
-
getMode: async (cell, controller, options = {}) => {
|
|
1914
|
-
// verify required parameter 'cell' is not null or undefined
|
|
1915
|
-
assertParamExists('getMode', 'cell', cell);
|
|
1916
|
-
// verify required parameter 'controller' is not null or undefined
|
|
1917
|
-
assertParamExists('getMode', 'controller', controller);
|
|
1918
|
-
const localVarPath = `/cells/{cell}/controllers/{controller}/mode`
|
|
1919
|
-
.replace(`{${"cell"}}`, encodeURIComponent(String(cell)))
|
|
1920
|
-
.replace(`{${"controller"}}`, encodeURIComponent(String(controller)));
|
|
1921
|
-
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
1922
|
-
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
1923
|
-
let baseOptions;
|
|
1924
|
-
if (configuration) {
|
|
1925
|
-
baseOptions = configuration.baseOptions;
|
|
1926
|
-
}
|
|
1927
|
-
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options };
|
|
1928
|
-
const localVarHeaderParameter = {};
|
|
1929
|
-
const localVarQueryParameter = {};
|
|
1930
|
-
// authentication BasicAuth required
|
|
1931
|
-
// http basic authentication required
|
|
1932
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
1933
|
-
// authentication BearerAuth required
|
|
1934
|
-
// http bearer authentication required
|
|
1935
|
-
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
1936
|
-
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
1937
|
-
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
1938
|
-
localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
|
|
1939
|
-
return {
|
|
1940
|
-
url: toPathString(localVarUrlObj),
|
|
1941
|
-
options: localVarRequestOptions,
|
|
1942
|
-
};
|
|
1943
|
-
},
|
|
1944
2984
|
/**
|
|
1945
2985
|
* Get the configuration for a robot controller.
|
|
1946
2986
|
* @summary Robot Controller
|
|
@@ -2098,7 +3138,7 @@ export const ControllerApiAxiosParamCreator = function (configuration) {
|
|
|
2098
3138
|
};
|
|
2099
3139
|
},
|
|
2100
3140
|
/**
|
|
2101
|
-
* Switch between monitor and control usage as default for a robot controller. Monitoring mode is used to read information from the robot controller and control mode is used to command the robot system. As long as the robot controller is connected via network monitoring mode is always possible. To switch to control mode the robot controller must be in `automatic` or `manual` operating mode and safety state \'normal\' or \'reduced\'. If the robot controller is in `manual` operating mode, you have manually confirm the control usage activation on the robot control panel. This manual confirmation can\'t be replaced with this API. Without manual confirmation the robot controller will stay in monitor mode. The robot system will try to activate the required operation mode for the requested usage unless no active call requires a different mode. > **NOTE** > > Some robot controllers prevent the external activation of automatic operating mode. In this case, changing the operating mode manually at the robot controller is mandatory. > **NOTE** > > The current operation mode and safety state can be requested via [getCurrentRobotControllerState](getCurrentRobotControllerState). If a mode change is not possible, the response lists reasons for the failed change.
|
|
3141
|
+
* Switch between monitor and control usage as default for a robot controller. Monitoring mode is used to read information from the robot controller and control mode is used to command the robot system. As long as the robot controller is connected via network monitoring mode is always possible. To switch to control mode the robot controller must be in `automatic` or `manual` operating mode and safety state \'normal\' or \'reduced\'. If the robot controller is in `manual` operating mode, you have manually confirm the control usage activation on the robot control panel. This manual confirmation can\'t be replaced with this API. Without manual confirmation the robot controller will stay in monitor mode. The robot system will try to activate the required operation mode for the requested usage unless no active call requires a different mode. > **NOTE** > > `setDefaultMode` enables the robot controller to stay in control mode to keep the motors activated. > This allows for faster execution of sequential movements as no mode switches are required. > **NOTE** > > Some robot controllers prevent the external activation of automatic operating mode. In this case, changing the operating mode manually at the robot controller is mandatory. > **NOTE** > > The current operation mode and safety state can be requested via [getCurrentRobotControllerState](getCurrentRobotControllerState). If a mode change is not possible, the response lists reasons for the failed change.
|
|
2102
3142
|
* @summary Set Default Mode
|
|
2103
3143
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
2104
3144
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -2186,15 +3226,16 @@ export const ControllerApiAxiosParamCreator = function (configuration) {
|
|
|
2186
3226
|
};
|
|
2187
3227
|
},
|
|
2188
3228
|
/**
|
|
2189
|
-
* <!-- theme: danger --> > Websocket endpoint Receive updates of the state of a robot controller.
|
|
3229
|
+
* <!-- theme: danger --> > Websocket endpoint Receive updates of the state of a robot controller. The stream can be opened before the controller is registered. To register a controller, call [addRobotController](addRobotController). While connecting, the stream sends initialization updates. Once the controller reaches `MODE_MONITOR`, it sends controller state updates.
|
|
2190
3230
|
* @summary Stream State
|
|
2191
3231
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
2192
3232
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
2193
3233
|
* @param {number} [responseRate]
|
|
3234
|
+
* @param {number} [addControllerTimeout]
|
|
2194
3235
|
* @param {*} [options] Override http request option.
|
|
2195
3236
|
* @throws {RequiredError}
|
|
2196
3237
|
*/
|
|
2197
|
-
streamRobotControllerState: async (cell, controller, responseRate, options = {}) => {
|
|
3238
|
+
streamRobotControllerState: async (cell, controller, responseRate, addControllerTimeout, options = {}) => {
|
|
2198
3239
|
// verify required parameter 'cell' is not null or undefined
|
|
2199
3240
|
assertParamExists('streamRobotControllerState', 'cell', cell);
|
|
2200
3241
|
// verify required parameter 'controller' is not null or undefined
|
|
@@ -2220,6 +3261,9 @@ export const ControllerApiAxiosParamCreator = function (configuration) {
|
|
|
2220
3261
|
if (responseRate !== undefined) {
|
|
2221
3262
|
localVarQueryParameter['response_rate'] = responseRate;
|
|
2222
3263
|
}
|
|
3264
|
+
if (addControllerTimeout !== undefined) {
|
|
3265
|
+
localVarQueryParameter['add_controller_timeout'] = addControllerTimeout;
|
|
3266
|
+
}
|
|
2223
3267
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
2224
3268
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
2225
3269
|
localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
|
|
@@ -2373,20 +3417,6 @@ export const ControllerApiFp = function (configuration) {
|
|
|
2373
3417
|
const localVarOperationServerBasePath = operationServerMap['ControllerApi.getCurrentRobotControllerState']?.[localVarOperationServerIndex]?.url;
|
|
2374
3418
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
2375
3419
|
},
|
|
2376
|
-
/**
|
|
2377
|
-
* Get the current robot system mode of a registered robot controller. The robot system mode indicates if a robot controller can be used. See [setDefaultMode](setDefaultMode) for more information about the different modes. The mode is influenced by the operating mode of the robot controller. The operating mode can be changed via [setDefaultMode](setDefaultMode). Request the current operating mode of the robot controller via [getCurrentRobotControllerState](getCurrentRobotControllerState).
|
|
2378
|
-
* @summary Current Mode
|
|
2379
|
-
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
2380
|
-
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
2381
|
-
* @param {*} [options] Override http request option.
|
|
2382
|
-
* @throws {RequiredError}
|
|
2383
|
-
*/
|
|
2384
|
-
async getMode(cell, controller, options) {
|
|
2385
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.getMode(cell, controller, options);
|
|
2386
|
-
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
2387
|
-
const localVarOperationServerBasePath = operationServerMap['ControllerApi.getMode']?.[localVarOperationServerIndex]?.url;
|
|
2388
|
-
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
2389
|
-
},
|
|
2390
3420
|
/**
|
|
2391
3421
|
* Get the configuration for a robot controller.
|
|
2392
3422
|
* @summary Robot Controller
|
|
@@ -2444,7 +3474,7 @@ export const ControllerApiFp = function (configuration) {
|
|
|
2444
3474
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
2445
3475
|
},
|
|
2446
3476
|
/**
|
|
2447
|
-
* Switch between monitor and control usage as default for a robot controller. Monitoring mode is used to read information from the robot controller and control mode is used to command the robot system. As long as the robot controller is connected via network monitoring mode is always possible. To switch to control mode the robot controller must be in `automatic` or `manual` operating mode and safety state \'normal\' or \'reduced\'. If the robot controller is in `manual` operating mode, you have manually confirm the control usage activation on the robot control panel. This manual confirmation can\'t be replaced with this API. Without manual confirmation the robot controller will stay in monitor mode. The robot system will try to activate the required operation mode for the requested usage unless no active call requires a different mode. > **NOTE** > > Some robot controllers prevent the external activation of automatic operating mode. In this case, changing the operating mode manually at the robot controller is mandatory. > **NOTE** > > The current operation mode and safety state can be requested via [getCurrentRobotControllerState](getCurrentRobotControllerState). If a mode change is not possible, the response lists reasons for the failed change.
|
|
3477
|
+
* Switch between monitor and control usage as default for a robot controller. Monitoring mode is used to read information from the robot controller and control mode is used to command the robot system. As long as the robot controller is connected via network monitoring mode is always possible. To switch to control mode the robot controller must be in `automatic` or `manual` operating mode and safety state \'normal\' or \'reduced\'. If the robot controller is in `manual` operating mode, you have manually confirm the control usage activation on the robot control panel. This manual confirmation can\'t be replaced with this API. Without manual confirmation the robot controller will stay in monitor mode. The robot system will try to activate the required operation mode for the requested usage unless no active call requires a different mode. > **NOTE** > > `setDefaultMode` enables the robot controller to stay in control mode to keep the motors activated. > This allows for faster execution of sequential movements as no mode switches are required. > **NOTE** > > Some robot controllers prevent the external activation of automatic operating mode. In this case, changing the operating mode manually at the robot controller is mandatory. > **NOTE** > > The current operation mode and safety state can be requested via [getCurrentRobotControllerState](getCurrentRobotControllerState). If a mode change is not possible, the response lists reasons for the failed change.
|
|
2448
3478
|
* @summary Set Default Mode
|
|
2449
3479
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
2450
3480
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -2474,16 +3504,17 @@ export const ControllerApiFp = function (configuration) {
|
|
|
2474
3504
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
2475
3505
|
},
|
|
2476
3506
|
/**
|
|
2477
|
-
* <!-- theme: danger --> > Websocket endpoint Receive updates of the state of a robot controller.
|
|
3507
|
+
* <!-- theme: danger --> > Websocket endpoint Receive updates of the state of a robot controller. The stream can be opened before the controller is registered. To register a controller, call [addRobotController](addRobotController). While connecting, the stream sends initialization updates. Once the controller reaches `MODE_MONITOR`, it sends controller state updates.
|
|
2478
3508
|
* @summary Stream State
|
|
2479
3509
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
2480
3510
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
2481
3511
|
* @param {number} [responseRate]
|
|
3512
|
+
* @param {number} [addControllerTimeout]
|
|
2482
3513
|
* @param {*} [options] Override http request option.
|
|
2483
3514
|
* @throws {RequiredError}
|
|
2484
3515
|
*/
|
|
2485
|
-
async streamRobotControllerState(cell, controller, responseRate, options) {
|
|
2486
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.streamRobotControllerState(cell, controller, responseRate, options);
|
|
3516
|
+
async streamRobotControllerState(cell, controller, responseRate, addControllerTimeout, options) {
|
|
3517
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.streamRobotControllerState(cell, controller, responseRate, addControllerTimeout, options);
|
|
2487
3518
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
2488
3519
|
const localVarOperationServerBasePath = operationServerMap['ControllerApi.streamRobotControllerState']?.[localVarOperationServerIndex]?.url;
|
|
2489
3520
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
@@ -2583,17 +3614,6 @@ export const ControllerApiFactory = function (configuration, basePath, axios) {
|
|
|
2583
3614
|
getCurrentRobotControllerState(cell, controller, options) {
|
|
2584
3615
|
return localVarFp.getCurrentRobotControllerState(cell, controller, options).then((request) => request(axios, basePath));
|
|
2585
3616
|
},
|
|
2586
|
-
/**
|
|
2587
|
-
* Get the current robot system mode of a registered robot controller. The robot system mode indicates if a robot controller can be used. See [setDefaultMode](setDefaultMode) for more information about the different modes. The mode is influenced by the operating mode of the robot controller. The operating mode can be changed via [setDefaultMode](setDefaultMode). Request the current operating mode of the robot controller via [getCurrentRobotControllerState](getCurrentRobotControllerState).
|
|
2588
|
-
* @summary Current Mode
|
|
2589
|
-
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
2590
|
-
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
2591
|
-
* @param {*} [options] Override http request option.
|
|
2592
|
-
* @throws {RequiredError}
|
|
2593
|
-
*/
|
|
2594
|
-
getMode(cell, controller, options) {
|
|
2595
|
-
return localVarFp.getMode(cell, controller, options).then((request) => request(axios, basePath));
|
|
2596
|
-
},
|
|
2597
3617
|
/**
|
|
2598
3618
|
* Get the configuration for a robot controller.
|
|
2599
3619
|
* @summary Robot Controller
|
|
@@ -2639,7 +3659,7 @@ export const ControllerApiFactory = function (configuration, basePath, axios) {
|
|
|
2639
3659
|
return localVarFp.listRobotControllers(cell, options).then((request) => request(axios, basePath));
|
|
2640
3660
|
},
|
|
2641
3661
|
/**
|
|
2642
|
-
* Switch between monitor and control usage as default for a robot controller. Monitoring mode is used to read information from the robot controller and control mode is used to command the robot system. As long as the robot controller is connected via network monitoring mode is always possible. To switch to control mode the robot controller must be in `automatic` or `manual` operating mode and safety state \'normal\' or \'reduced\'. If the robot controller is in `manual` operating mode, you have manually confirm the control usage activation on the robot control panel. This manual confirmation can\'t be replaced with this API. Without manual confirmation the robot controller will stay in monitor mode. The robot system will try to activate the required operation mode for the requested usage unless no active call requires a different mode. > **NOTE** > > Some robot controllers prevent the external activation of automatic operating mode. In this case, changing the operating mode manually at the robot controller is mandatory. > **NOTE** > > The current operation mode and safety state can be requested via [getCurrentRobotControllerState](getCurrentRobotControllerState). If a mode change is not possible, the response lists reasons for the failed change.
|
|
3662
|
+
* Switch between monitor and control usage as default for a robot controller. Monitoring mode is used to read information from the robot controller and control mode is used to command the robot system. As long as the robot controller is connected via network monitoring mode is always possible. To switch to control mode the robot controller must be in `automatic` or `manual` operating mode and safety state \'normal\' or \'reduced\'. If the robot controller is in `manual` operating mode, you have manually confirm the control usage activation on the robot control panel. This manual confirmation can\'t be replaced with this API. Without manual confirmation the robot controller will stay in monitor mode. The robot system will try to activate the required operation mode for the requested usage unless no active call requires a different mode. > **NOTE** > > `setDefaultMode` enables the robot controller to stay in control mode to keep the motors activated. > This allows for faster execution of sequential movements as no mode switches are required. > **NOTE** > > Some robot controllers prevent the external activation of automatic operating mode. In this case, changing the operating mode manually at the robot controller is mandatory. > **NOTE** > > The current operation mode and safety state can be requested via [getCurrentRobotControllerState](getCurrentRobotControllerState). If a mode change is not possible, the response lists reasons for the failed change.
|
|
2643
3663
|
* @summary Set Default Mode
|
|
2644
3664
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
2645
3665
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -2663,16 +3683,17 @@ export const ControllerApiFactory = function (configuration, basePath, axios) {
|
|
|
2663
3683
|
return localVarFp.streamFreeDrive(cell, controller, responseRate, options).then((request) => request(axios, basePath));
|
|
2664
3684
|
},
|
|
2665
3685
|
/**
|
|
2666
|
-
* <!-- theme: danger --> > Websocket endpoint Receive updates of the state of a robot controller.
|
|
3686
|
+
* <!-- theme: danger --> > Websocket endpoint Receive updates of the state of a robot controller. The stream can be opened before the controller is registered. To register a controller, call [addRobotController](addRobotController). While connecting, the stream sends initialization updates. Once the controller reaches `MODE_MONITOR`, it sends controller state updates.
|
|
2667
3687
|
* @summary Stream State
|
|
2668
3688
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
2669
3689
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
2670
3690
|
* @param {number} [responseRate]
|
|
3691
|
+
* @param {number} [addControllerTimeout]
|
|
2671
3692
|
* @param {*} [options] Override http request option.
|
|
2672
3693
|
* @throws {RequiredError}
|
|
2673
3694
|
*/
|
|
2674
|
-
streamRobotControllerState(cell, controller, responseRate, options) {
|
|
2675
|
-
return localVarFp.streamRobotControllerState(cell, controller, responseRate, options).then((request) => request(axios, basePath));
|
|
3695
|
+
streamRobotControllerState(cell, controller, responseRate, addControllerTimeout, options) {
|
|
3696
|
+
return localVarFp.streamRobotControllerState(cell, controller, responseRate, addControllerTimeout, options).then((request) => request(axios, basePath));
|
|
2676
3697
|
},
|
|
2677
3698
|
/**
|
|
2678
3699
|
* Update the configuration of a robot controller. Reconfigure certain options of a robot controller, or deploy a specific container image of a robot controller. <!-- theme: warning --> > **WARNING** > > Using it in conjunction with the settings app may lead to unpredictable behavior.
|
|
@@ -2772,18 +3793,6 @@ export class ControllerApi extends BaseAPI {
|
|
|
2772
3793
|
getCurrentRobotControllerState(cell, controller, options) {
|
|
2773
3794
|
return ControllerApiFp(this.configuration).getCurrentRobotControllerState(cell, controller, options).then((request) => request(this.axios, this.basePath));
|
|
2774
3795
|
}
|
|
2775
|
-
/**
|
|
2776
|
-
* Get the current robot system mode of a registered robot controller. The robot system mode indicates if a robot controller can be used. See [setDefaultMode](setDefaultMode) for more information about the different modes. The mode is influenced by the operating mode of the robot controller. The operating mode can be changed via [setDefaultMode](setDefaultMode). Request the current operating mode of the robot controller via [getCurrentRobotControllerState](getCurrentRobotControllerState).
|
|
2777
|
-
* @summary Current Mode
|
|
2778
|
-
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
2779
|
-
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
2780
|
-
* @param {*} [options] Override http request option.
|
|
2781
|
-
* @throws {RequiredError}
|
|
2782
|
-
* @memberof ControllerApi
|
|
2783
|
-
*/
|
|
2784
|
-
getMode(cell, controller, options) {
|
|
2785
|
-
return ControllerApiFp(this.configuration).getMode(cell, controller, options).then((request) => request(this.axios, this.basePath));
|
|
2786
|
-
}
|
|
2787
3796
|
/**
|
|
2788
3797
|
* Get the configuration for a robot controller.
|
|
2789
3798
|
* @summary Robot Controller
|
|
@@ -2833,7 +3842,7 @@ export class ControllerApi extends BaseAPI {
|
|
|
2833
3842
|
return ControllerApiFp(this.configuration).listRobotControllers(cell, options).then((request) => request(this.axios, this.basePath));
|
|
2834
3843
|
}
|
|
2835
3844
|
/**
|
|
2836
|
-
* Switch between monitor and control usage as default for a robot controller. Monitoring mode is used to read information from the robot controller and control mode is used to command the robot system. As long as the robot controller is connected via network monitoring mode is always possible. To switch to control mode the robot controller must be in `automatic` or `manual` operating mode and safety state \'normal\' or \'reduced\'. If the robot controller is in `manual` operating mode, you have manually confirm the control usage activation on the robot control panel. This manual confirmation can\'t be replaced with this API. Without manual confirmation the robot controller will stay in monitor mode. The robot system will try to activate the required operation mode for the requested usage unless no active call requires a different mode. > **NOTE** > > Some robot controllers prevent the external activation of automatic operating mode. In this case, changing the operating mode manually at the robot controller is mandatory. > **NOTE** > > The current operation mode and safety state can be requested via [getCurrentRobotControllerState](getCurrentRobotControllerState). If a mode change is not possible, the response lists reasons for the failed change.
|
|
3845
|
+
* Switch between monitor and control usage as default for a robot controller. Monitoring mode is used to read information from the robot controller and control mode is used to command the robot system. As long as the robot controller is connected via network monitoring mode is always possible. To switch to control mode the robot controller must be in `automatic` or `manual` operating mode and safety state \'normal\' or \'reduced\'. If the robot controller is in `manual` operating mode, you have manually confirm the control usage activation on the robot control panel. This manual confirmation can\'t be replaced with this API. Without manual confirmation the robot controller will stay in monitor mode. The robot system will try to activate the required operation mode for the requested usage unless no active call requires a different mode. > **NOTE** > > `setDefaultMode` enables the robot controller to stay in control mode to keep the motors activated. > This allows for faster execution of sequential movements as no mode switches are required. > **NOTE** > > Some robot controllers prevent the external activation of automatic operating mode. In this case, changing the operating mode manually at the robot controller is mandatory. > **NOTE** > > The current operation mode and safety state can be requested via [getCurrentRobotControllerState](getCurrentRobotControllerState). If a mode change is not possible, the response lists reasons for the failed change.
|
|
2837
3846
|
* @summary Set Default Mode
|
|
2838
3847
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
2839
3848
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -2859,17 +3868,18 @@ export class ControllerApi extends BaseAPI {
|
|
|
2859
3868
|
return ControllerApiFp(this.configuration).streamFreeDrive(cell, controller, responseRate, options).then((request) => request(this.axios, this.basePath));
|
|
2860
3869
|
}
|
|
2861
3870
|
/**
|
|
2862
|
-
* <!-- theme: danger --> > Websocket endpoint Receive updates of the state of a robot controller.
|
|
3871
|
+
* <!-- theme: danger --> > Websocket endpoint Receive updates of the state of a robot controller. The stream can be opened before the controller is registered. To register a controller, call [addRobotController](addRobotController). While connecting, the stream sends initialization updates. Once the controller reaches `MODE_MONITOR`, it sends controller state updates.
|
|
2863
3872
|
* @summary Stream State
|
|
2864
3873
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
2865
3874
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
2866
3875
|
* @param {number} [responseRate]
|
|
3876
|
+
* @param {number} [addControllerTimeout]
|
|
2867
3877
|
* @param {*} [options] Override http request option.
|
|
2868
3878
|
* @throws {RequiredError}
|
|
2869
3879
|
* @memberof ControllerApi
|
|
2870
3880
|
*/
|
|
2871
|
-
streamRobotControllerState(cell, controller, responseRate, options) {
|
|
2872
|
-
return ControllerApiFp(this.configuration).streamRobotControllerState(cell, controller, responseRate, options).then((request) => request(this.axios, this.basePath));
|
|
3881
|
+
streamRobotControllerState(cell, controller, responseRate, addControllerTimeout, options) {
|
|
3882
|
+
return ControllerApiFp(this.configuration).streamRobotControllerState(cell, controller, responseRate, addControllerTimeout, options).then((request) => request(this.axios, this.basePath));
|
|
2873
3883
|
}
|
|
2874
3884
|
/**
|
|
2875
3885
|
* Update the configuration of a robot controller. Reconfigure certain options of a robot controller, or deploy a specific container image of a robot controller. <!-- theme: warning --> > **WARNING** > > Using it in conjunction with the settings app may lead to unpredictable behavior.
|
|
@@ -3482,6 +4492,44 @@ export class JoggingApi extends BaseAPI {
|
|
|
3482
4492
|
*/
|
|
3483
4493
|
export const KinematicsApiAxiosParamCreator = function (configuration) {
|
|
3484
4494
|
return {
|
|
4495
|
+
/**
|
|
4496
|
+
* Returns the TCP poses for a list of given joint positions.
|
|
4497
|
+
* @summary Forward kinematics
|
|
4498
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
4499
|
+
* @param {ForwardKinematicsRequest} [forwardKinematicsRequest]
|
|
4500
|
+
* @param {*} [options] Override http request option.
|
|
4501
|
+
* @throws {RequiredError}
|
|
4502
|
+
*/
|
|
4503
|
+
forwardKinematics: async (cell, forwardKinematicsRequest, options = {}) => {
|
|
4504
|
+
// verify required parameter 'cell' is not null or undefined
|
|
4505
|
+
assertParamExists('forwardKinematics', 'cell', cell);
|
|
4506
|
+
const localVarPath = `/cells/{cell}/kinematic/forward`
|
|
4507
|
+
.replace(`{${"cell"}}`, encodeURIComponent(String(cell)));
|
|
4508
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
4509
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
4510
|
+
let baseOptions;
|
|
4511
|
+
if (configuration) {
|
|
4512
|
+
baseOptions = configuration.baseOptions;
|
|
4513
|
+
}
|
|
4514
|
+
const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options };
|
|
4515
|
+
const localVarHeaderParameter = {};
|
|
4516
|
+
const localVarQueryParameter = {};
|
|
4517
|
+
// authentication BasicAuth required
|
|
4518
|
+
// http basic authentication required
|
|
4519
|
+
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
4520
|
+
// authentication BearerAuth required
|
|
4521
|
+
// http bearer authentication required
|
|
4522
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
4523
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
4524
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
4525
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
4526
|
+
localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
|
|
4527
|
+
localVarRequestOptions.data = serializeDataIfNeeded(forwardKinematicsRequest, localVarRequestOptions, configuration);
|
|
4528
|
+
return {
|
|
4529
|
+
url: toPathString(localVarUrlObj),
|
|
4530
|
+
options: localVarRequestOptions,
|
|
4531
|
+
};
|
|
4532
|
+
},
|
|
3485
4533
|
/**
|
|
3486
4534
|
* Returns the reachable joint positions for a list of given poses.
|
|
3487
4535
|
* @summary Inverse kinematics
|
|
@@ -3529,6 +4577,20 @@ export const KinematicsApiAxiosParamCreator = function (configuration) {
|
|
|
3529
4577
|
export const KinematicsApiFp = function (configuration) {
|
|
3530
4578
|
const localVarAxiosParamCreator = KinematicsApiAxiosParamCreator(configuration);
|
|
3531
4579
|
return {
|
|
4580
|
+
/**
|
|
4581
|
+
* Returns the TCP poses for a list of given joint positions.
|
|
4582
|
+
* @summary Forward kinematics
|
|
4583
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
4584
|
+
* @param {ForwardKinematicsRequest} [forwardKinematicsRequest]
|
|
4585
|
+
* @param {*} [options] Override http request option.
|
|
4586
|
+
* @throws {RequiredError}
|
|
4587
|
+
*/
|
|
4588
|
+
async forwardKinematics(cell, forwardKinematicsRequest, options) {
|
|
4589
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.forwardKinematics(cell, forwardKinematicsRequest, options);
|
|
4590
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
4591
|
+
const localVarOperationServerBasePath = operationServerMap['KinematicsApi.forwardKinematics']?.[localVarOperationServerIndex]?.url;
|
|
4592
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
4593
|
+
},
|
|
3532
4594
|
/**
|
|
3533
4595
|
* Returns the reachable joint positions for a list of given poses.
|
|
3534
4596
|
* @summary Inverse kinematics
|
|
@@ -3552,6 +4614,17 @@ export const KinematicsApiFp = function (configuration) {
|
|
|
3552
4614
|
export const KinematicsApiFactory = function (configuration, basePath, axios) {
|
|
3553
4615
|
const localVarFp = KinematicsApiFp(configuration);
|
|
3554
4616
|
return {
|
|
4617
|
+
/**
|
|
4618
|
+
* Returns the TCP poses for a list of given joint positions.
|
|
4619
|
+
* @summary Forward kinematics
|
|
4620
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
4621
|
+
* @param {ForwardKinematicsRequest} [forwardKinematicsRequest]
|
|
4622
|
+
* @param {*} [options] Override http request option.
|
|
4623
|
+
* @throws {RequiredError}
|
|
4624
|
+
*/
|
|
4625
|
+
forwardKinematics(cell, forwardKinematicsRequest, options) {
|
|
4626
|
+
return localVarFp.forwardKinematics(cell, forwardKinematicsRequest, options).then((request) => request(axios, basePath));
|
|
4627
|
+
},
|
|
3555
4628
|
/**
|
|
3556
4629
|
* Returns the reachable joint positions for a list of given poses.
|
|
3557
4630
|
* @summary Inverse kinematics
|
|
@@ -3572,6 +4645,18 @@ export const KinematicsApiFactory = function (configuration, basePath, axios) {
|
|
|
3572
4645
|
* @extends {BaseAPI}
|
|
3573
4646
|
*/
|
|
3574
4647
|
export class KinematicsApi extends BaseAPI {
|
|
4648
|
+
/**
|
|
4649
|
+
* Returns the TCP poses for a list of given joint positions.
|
|
4650
|
+
* @summary Forward kinematics
|
|
4651
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
4652
|
+
* @param {ForwardKinematicsRequest} [forwardKinematicsRequest]
|
|
4653
|
+
* @param {*} [options] Override http request option.
|
|
4654
|
+
* @throws {RequiredError}
|
|
4655
|
+
* @memberof KinematicsApi
|
|
4656
|
+
*/
|
|
4657
|
+
forwardKinematics(cell, forwardKinematicsRequest, options) {
|
|
4658
|
+
return KinematicsApiFp(this.configuration).forwardKinematics(cell, forwardKinematicsRequest, options).then((request) => request(this.axios, this.basePath));
|
|
4659
|
+
}
|
|
3575
4660
|
/**
|
|
3576
4661
|
* Returns the reachable joint positions for a list of given poses.
|
|
3577
4662
|
* @summary Inverse kinematics
|
|
@@ -5308,27 +6393,27 @@ export class StoreCollisionComponentsApi extends BaseAPI {
|
|
|
5308
6393
|
}
|
|
5309
6394
|
}
|
|
5310
6395
|
/**
|
|
5311
|
-
*
|
|
6396
|
+
* StoreCollisionSetupsApi - axios parameter creator
|
|
5312
6397
|
* @export
|
|
5313
6398
|
*/
|
|
5314
|
-
export const
|
|
6399
|
+
export const StoreCollisionSetupsApiAxiosParamCreator = function (configuration) {
|
|
5315
6400
|
return {
|
|
5316
6401
|
/**
|
|
5317
|
-
* Deletes the stored
|
|
5318
|
-
* @summary Delete
|
|
6402
|
+
* Deletes the stored collision setup. <!-- theme: danger --> > This will delete persistently stored data.
|
|
6403
|
+
* @summary Delete Collision Setup
|
|
5319
6404
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5320
|
-
* @param {string}
|
|
6405
|
+
* @param {string} setup Identifier of the collision setup
|
|
5321
6406
|
* @param {*} [options] Override http request option.
|
|
5322
6407
|
* @throws {RequiredError}
|
|
5323
6408
|
*/
|
|
5324
|
-
|
|
6409
|
+
deleteStoredCollisionSetup: async (cell, setup, options = {}) => {
|
|
5325
6410
|
// verify required parameter 'cell' is not null or undefined
|
|
5326
|
-
assertParamExists('
|
|
5327
|
-
// verify required parameter '
|
|
5328
|
-
assertParamExists('
|
|
5329
|
-
const localVarPath = `/cells/{cell}/store/collision/
|
|
6411
|
+
assertParamExists('deleteStoredCollisionSetup', 'cell', cell);
|
|
6412
|
+
// verify required parameter 'setup' is not null or undefined
|
|
6413
|
+
assertParamExists('deleteStoredCollisionSetup', 'setup', setup);
|
|
6414
|
+
const localVarPath = `/cells/{cell}/store/collision/setups/{setup}`
|
|
5330
6415
|
.replace(`{${"cell"}}`, encodeURIComponent(String(cell)))
|
|
5331
|
-
.replace(`{${"
|
|
6416
|
+
.replace(`{${"setup"}}`, encodeURIComponent(String(setup)));
|
|
5332
6417
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
5333
6418
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
5334
6419
|
let baseOptions;
|
|
@@ -5353,21 +6438,21 @@ export const StoreCollisionScenesApiAxiosParamCreator = function (configuration)
|
|
|
5353
6438
|
};
|
|
5354
6439
|
},
|
|
5355
6440
|
/**
|
|
5356
|
-
* Returns the stored
|
|
5357
|
-
* @summary Get
|
|
6441
|
+
* Returns the stored collision setup.
|
|
6442
|
+
* @summary Get Collision Setup
|
|
5358
6443
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5359
|
-
* @param {string}
|
|
6444
|
+
* @param {string} setup Identifier of the collision setup
|
|
5360
6445
|
* @param {*} [options] Override http request option.
|
|
5361
6446
|
* @throws {RequiredError}
|
|
5362
6447
|
*/
|
|
5363
|
-
|
|
6448
|
+
getStoredCollisionSetup: async (cell, setup, options = {}) => {
|
|
5364
6449
|
// verify required parameter 'cell' is not null or undefined
|
|
5365
|
-
assertParamExists('
|
|
5366
|
-
// verify required parameter '
|
|
5367
|
-
assertParamExists('
|
|
5368
|
-
const localVarPath = `/cells/{cell}/store/collision/
|
|
6450
|
+
assertParamExists('getStoredCollisionSetup', 'cell', cell);
|
|
6451
|
+
// verify required parameter 'setup' is not null or undefined
|
|
6452
|
+
assertParamExists('getStoredCollisionSetup', 'setup', setup);
|
|
6453
|
+
const localVarPath = `/cells/{cell}/store/collision/setups/{setup}`
|
|
5369
6454
|
.replace(`{${"cell"}}`, encodeURIComponent(String(cell)))
|
|
5370
|
-
.replace(`{${"
|
|
6455
|
+
.replace(`{${"setup"}}`, encodeURIComponent(String(setup)));
|
|
5371
6456
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
5372
6457
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
5373
6458
|
let baseOptions;
|
|
@@ -5392,16 +6477,16 @@ export const StoreCollisionScenesApiAxiosParamCreator = function (configuration)
|
|
|
5392
6477
|
};
|
|
5393
6478
|
},
|
|
5394
6479
|
/**
|
|
5395
|
-
* Returns a list of stored
|
|
5396
|
-
* @summary List
|
|
6480
|
+
* Returns a list of stored collision setups.
|
|
6481
|
+
* @summary List Collision Setups
|
|
5397
6482
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5398
6483
|
* @param {*} [options] Override http request option.
|
|
5399
6484
|
* @throws {RequiredError}
|
|
5400
6485
|
*/
|
|
5401
|
-
|
|
6486
|
+
listStoredCollisionSetups: async (cell, options = {}) => {
|
|
5402
6487
|
// verify required parameter 'cell' is not null or undefined
|
|
5403
|
-
assertParamExists('
|
|
5404
|
-
const localVarPath = `/cells/{cell}/store/collision/
|
|
6488
|
+
assertParamExists('listStoredCollisionSetups', 'cell', cell);
|
|
6489
|
+
const localVarPath = `/cells/{cell}/store/collision/setups`
|
|
5405
6490
|
.replace(`{${"cell"}}`, encodeURIComponent(String(cell)));
|
|
5406
6491
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
5407
6492
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
@@ -5427,24 +6512,24 @@ export const StoreCollisionScenesApiAxiosParamCreator = function (configuration)
|
|
|
5427
6512
|
};
|
|
5428
6513
|
},
|
|
5429
6514
|
/**
|
|
5430
|
-
*
|
|
5431
|
-
* @summary Store
|
|
6515
|
+
* Stores collision setup. If the collision setup does not exist, it will be created. If the collision setup exists, it will be updated.
|
|
6516
|
+
* @summary Store Collision Setup
|
|
5432
6517
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5433
|
-
* @param {string}
|
|
5434
|
-
* @param {
|
|
6518
|
+
* @param {string} setup Identifier of the collision setup
|
|
6519
|
+
* @param {CollisionSetup} collisionSetup
|
|
5435
6520
|
* @param {*} [options] Override http request option.
|
|
5436
6521
|
* @throws {RequiredError}
|
|
5437
6522
|
*/
|
|
5438
|
-
|
|
6523
|
+
storeCollisionSetup: async (cell, setup, collisionSetup, options = {}) => {
|
|
5439
6524
|
// verify required parameter 'cell' is not null or undefined
|
|
5440
|
-
assertParamExists('
|
|
5441
|
-
// verify required parameter '
|
|
5442
|
-
assertParamExists('
|
|
5443
|
-
// verify required parameter '
|
|
5444
|
-
assertParamExists('
|
|
5445
|
-
const localVarPath = `/cells/{cell}/store/collision/
|
|
6525
|
+
assertParamExists('storeCollisionSetup', 'cell', cell);
|
|
6526
|
+
// verify required parameter 'setup' is not null or undefined
|
|
6527
|
+
assertParamExists('storeCollisionSetup', 'setup', setup);
|
|
6528
|
+
// verify required parameter 'collisionSetup' is not null or undefined
|
|
6529
|
+
assertParamExists('storeCollisionSetup', 'collisionSetup', collisionSetup);
|
|
6530
|
+
const localVarPath = `/cells/{cell}/store/collision/setups/{setup}`
|
|
5446
6531
|
.replace(`{${"cell"}}`, encodeURIComponent(String(cell)))
|
|
5447
|
-
.replace(`{${"
|
|
6532
|
+
.replace(`{${"setup"}}`, encodeURIComponent(String(setup)));
|
|
5448
6533
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
5449
6534
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
5450
6535
|
let baseOptions;
|
|
@@ -5464,7 +6549,7 @@ export const StoreCollisionScenesApiAxiosParamCreator = function (configuration)
|
|
|
5464
6549
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
5465
6550
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
5466
6551
|
localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
|
|
5467
|
-
localVarRequestOptions.data = serializeDataIfNeeded(
|
|
6552
|
+
localVarRequestOptions.data = serializeDataIfNeeded(collisionSetup, localVarRequestOptions, configuration);
|
|
5468
6553
|
return {
|
|
5469
6554
|
url: toPathString(localVarUrlObj),
|
|
5470
6555
|
options: localVarRequestOptions,
|
|
@@ -5473,177 +6558,177 @@ export const StoreCollisionScenesApiAxiosParamCreator = function (configuration)
|
|
|
5473
6558
|
};
|
|
5474
6559
|
};
|
|
5475
6560
|
/**
|
|
5476
|
-
*
|
|
6561
|
+
* StoreCollisionSetupsApi - functional programming interface
|
|
5477
6562
|
* @export
|
|
5478
6563
|
*/
|
|
5479
|
-
export const
|
|
5480
|
-
const localVarAxiosParamCreator =
|
|
6564
|
+
export const StoreCollisionSetupsApiFp = function (configuration) {
|
|
6565
|
+
const localVarAxiosParamCreator = StoreCollisionSetupsApiAxiosParamCreator(configuration);
|
|
5481
6566
|
return {
|
|
5482
6567
|
/**
|
|
5483
|
-
* Deletes the stored
|
|
5484
|
-
* @summary Delete
|
|
6568
|
+
* Deletes the stored collision setup. <!-- theme: danger --> > This will delete persistently stored data.
|
|
6569
|
+
* @summary Delete Collision Setup
|
|
5485
6570
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5486
|
-
* @param {string}
|
|
6571
|
+
* @param {string} setup Identifier of the collision setup
|
|
5487
6572
|
* @param {*} [options] Override http request option.
|
|
5488
6573
|
* @throws {RequiredError}
|
|
5489
6574
|
*/
|
|
5490
|
-
async
|
|
5491
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.
|
|
6575
|
+
async deleteStoredCollisionSetup(cell, setup, options) {
|
|
6576
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.deleteStoredCollisionSetup(cell, setup, options);
|
|
5492
6577
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
5493
|
-
const localVarOperationServerBasePath = operationServerMap['
|
|
6578
|
+
const localVarOperationServerBasePath = operationServerMap['StoreCollisionSetupsApi.deleteStoredCollisionSetup']?.[localVarOperationServerIndex]?.url;
|
|
5494
6579
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
5495
6580
|
},
|
|
5496
6581
|
/**
|
|
5497
|
-
* Returns the stored
|
|
5498
|
-
* @summary Get
|
|
6582
|
+
* Returns the stored collision setup.
|
|
6583
|
+
* @summary Get Collision Setup
|
|
5499
6584
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5500
|
-
* @param {string}
|
|
6585
|
+
* @param {string} setup Identifier of the collision setup
|
|
5501
6586
|
* @param {*} [options] Override http request option.
|
|
5502
6587
|
* @throws {RequiredError}
|
|
5503
6588
|
*/
|
|
5504
|
-
async
|
|
5505
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.
|
|
6589
|
+
async getStoredCollisionSetup(cell, setup, options) {
|
|
6590
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.getStoredCollisionSetup(cell, setup, options);
|
|
5506
6591
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
5507
|
-
const localVarOperationServerBasePath = operationServerMap['
|
|
6592
|
+
const localVarOperationServerBasePath = operationServerMap['StoreCollisionSetupsApi.getStoredCollisionSetup']?.[localVarOperationServerIndex]?.url;
|
|
5508
6593
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
5509
6594
|
},
|
|
5510
6595
|
/**
|
|
5511
|
-
* Returns a list of stored
|
|
5512
|
-
* @summary List
|
|
6596
|
+
* Returns a list of stored collision setups.
|
|
6597
|
+
* @summary List Collision Setups
|
|
5513
6598
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5514
6599
|
* @param {*} [options] Override http request option.
|
|
5515
6600
|
* @throws {RequiredError}
|
|
5516
6601
|
*/
|
|
5517
|
-
async
|
|
5518
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.
|
|
6602
|
+
async listStoredCollisionSetups(cell, options) {
|
|
6603
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.listStoredCollisionSetups(cell, options);
|
|
5519
6604
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
5520
|
-
const localVarOperationServerBasePath = operationServerMap['
|
|
6605
|
+
const localVarOperationServerBasePath = operationServerMap['StoreCollisionSetupsApi.listStoredCollisionSetups']?.[localVarOperationServerIndex]?.url;
|
|
5521
6606
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
5522
6607
|
},
|
|
5523
6608
|
/**
|
|
5524
|
-
*
|
|
5525
|
-
* @summary Store
|
|
6609
|
+
* Stores collision setup. If the collision setup does not exist, it will be created. If the collision setup exists, it will be updated.
|
|
6610
|
+
* @summary Store Collision Setup
|
|
5526
6611
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5527
|
-
* @param {string}
|
|
5528
|
-
* @param {
|
|
6612
|
+
* @param {string} setup Identifier of the collision setup
|
|
6613
|
+
* @param {CollisionSetup} collisionSetup
|
|
5529
6614
|
* @param {*} [options] Override http request option.
|
|
5530
6615
|
* @throws {RequiredError}
|
|
5531
6616
|
*/
|
|
5532
|
-
async
|
|
5533
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.
|
|
6617
|
+
async storeCollisionSetup(cell, setup, collisionSetup, options) {
|
|
6618
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.storeCollisionSetup(cell, setup, collisionSetup, options);
|
|
5534
6619
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
5535
|
-
const localVarOperationServerBasePath = operationServerMap['
|
|
6620
|
+
const localVarOperationServerBasePath = operationServerMap['StoreCollisionSetupsApi.storeCollisionSetup']?.[localVarOperationServerIndex]?.url;
|
|
5536
6621
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
5537
6622
|
},
|
|
5538
6623
|
};
|
|
5539
6624
|
};
|
|
5540
6625
|
/**
|
|
5541
|
-
*
|
|
6626
|
+
* StoreCollisionSetupsApi - factory interface
|
|
5542
6627
|
* @export
|
|
5543
6628
|
*/
|
|
5544
|
-
export const
|
|
5545
|
-
const localVarFp =
|
|
6629
|
+
export const StoreCollisionSetupsApiFactory = function (configuration, basePath, axios) {
|
|
6630
|
+
const localVarFp = StoreCollisionSetupsApiFp(configuration);
|
|
5546
6631
|
return {
|
|
5547
6632
|
/**
|
|
5548
|
-
* Deletes the stored
|
|
5549
|
-
* @summary Delete
|
|
6633
|
+
* Deletes the stored collision setup. <!-- theme: danger --> > This will delete persistently stored data.
|
|
6634
|
+
* @summary Delete Collision Setup
|
|
5550
6635
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5551
|
-
* @param {string}
|
|
6636
|
+
* @param {string} setup Identifier of the collision setup
|
|
5552
6637
|
* @param {*} [options] Override http request option.
|
|
5553
6638
|
* @throws {RequiredError}
|
|
5554
6639
|
*/
|
|
5555
|
-
|
|
5556
|
-
return localVarFp.
|
|
6640
|
+
deleteStoredCollisionSetup(cell, setup, options) {
|
|
6641
|
+
return localVarFp.deleteStoredCollisionSetup(cell, setup, options).then((request) => request(axios, basePath));
|
|
5557
6642
|
},
|
|
5558
6643
|
/**
|
|
5559
|
-
* Returns the stored
|
|
5560
|
-
* @summary Get
|
|
6644
|
+
* Returns the stored collision setup.
|
|
6645
|
+
* @summary Get Collision Setup
|
|
5561
6646
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5562
|
-
* @param {string}
|
|
6647
|
+
* @param {string} setup Identifier of the collision setup
|
|
5563
6648
|
* @param {*} [options] Override http request option.
|
|
5564
6649
|
* @throws {RequiredError}
|
|
5565
6650
|
*/
|
|
5566
|
-
|
|
5567
|
-
return localVarFp.
|
|
6651
|
+
getStoredCollisionSetup(cell, setup, options) {
|
|
6652
|
+
return localVarFp.getStoredCollisionSetup(cell, setup, options).then((request) => request(axios, basePath));
|
|
5568
6653
|
},
|
|
5569
6654
|
/**
|
|
5570
|
-
* Returns a list of stored
|
|
5571
|
-
* @summary List
|
|
6655
|
+
* Returns a list of stored collision setups.
|
|
6656
|
+
* @summary List Collision Setups
|
|
5572
6657
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5573
6658
|
* @param {*} [options] Override http request option.
|
|
5574
6659
|
* @throws {RequiredError}
|
|
5575
6660
|
*/
|
|
5576
|
-
|
|
5577
|
-
return localVarFp.
|
|
6661
|
+
listStoredCollisionSetups(cell, options) {
|
|
6662
|
+
return localVarFp.listStoredCollisionSetups(cell, options).then((request) => request(axios, basePath));
|
|
5578
6663
|
},
|
|
5579
6664
|
/**
|
|
5580
|
-
*
|
|
5581
|
-
* @summary Store
|
|
6665
|
+
* Stores collision setup. If the collision setup does not exist, it will be created. If the collision setup exists, it will be updated.
|
|
6666
|
+
* @summary Store Collision Setup
|
|
5582
6667
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5583
|
-
* @param {string}
|
|
5584
|
-
* @param {
|
|
6668
|
+
* @param {string} setup Identifier of the collision setup
|
|
6669
|
+
* @param {CollisionSetup} collisionSetup
|
|
5585
6670
|
* @param {*} [options] Override http request option.
|
|
5586
6671
|
* @throws {RequiredError}
|
|
5587
6672
|
*/
|
|
5588
|
-
|
|
5589
|
-
return localVarFp.
|
|
6673
|
+
storeCollisionSetup(cell, setup, collisionSetup, options) {
|
|
6674
|
+
return localVarFp.storeCollisionSetup(cell, setup, collisionSetup, options).then((request) => request(axios, basePath));
|
|
5590
6675
|
},
|
|
5591
6676
|
};
|
|
5592
6677
|
};
|
|
5593
6678
|
/**
|
|
5594
|
-
*
|
|
6679
|
+
* StoreCollisionSetupsApi - object-oriented interface
|
|
5595
6680
|
* @export
|
|
5596
|
-
* @class
|
|
6681
|
+
* @class StoreCollisionSetupsApi
|
|
5597
6682
|
* @extends {BaseAPI}
|
|
5598
6683
|
*/
|
|
5599
|
-
export class
|
|
6684
|
+
export class StoreCollisionSetupsApi extends BaseAPI {
|
|
5600
6685
|
/**
|
|
5601
|
-
* Deletes the stored
|
|
5602
|
-
* @summary Delete
|
|
6686
|
+
* Deletes the stored collision setup. <!-- theme: danger --> > This will delete persistently stored data.
|
|
6687
|
+
* @summary Delete Collision Setup
|
|
5603
6688
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5604
|
-
* @param {string}
|
|
6689
|
+
* @param {string} setup Identifier of the collision setup
|
|
5605
6690
|
* @param {*} [options] Override http request option.
|
|
5606
6691
|
* @throws {RequiredError}
|
|
5607
|
-
* @memberof
|
|
6692
|
+
* @memberof StoreCollisionSetupsApi
|
|
5608
6693
|
*/
|
|
5609
|
-
|
|
5610
|
-
return
|
|
6694
|
+
deleteStoredCollisionSetup(cell, setup, options) {
|
|
6695
|
+
return StoreCollisionSetupsApiFp(this.configuration).deleteStoredCollisionSetup(cell, setup, options).then((request) => request(this.axios, this.basePath));
|
|
5611
6696
|
}
|
|
5612
6697
|
/**
|
|
5613
|
-
* Returns the stored
|
|
5614
|
-
* @summary Get
|
|
6698
|
+
* Returns the stored collision setup.
|
|
6699
|
+
* @summary Get Collision Setup
|
|
5615
6700
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5616
|
-
* @param {string}
|
|
6701
|
+
* @param {string} setup Identifier of the collision setup
|
|
5617
6702
|
* @param {*} [options] Override http request option.
|
|
5618
6703
|
* @throws {RequiredError}
|
|
5619
|
-
* @memberof
|
|
6704
|
+
* @memberof StoreCollisionSetupsApi
|
|
5620
6705
|
*/
|
|
5621
|
-
|
|
5622
|
-
return
|
|
6706
|
+
getStoredCollisionSetup(cell, setup, options) {
|
|
6707
|
+
return StoreCollisionSetupsApiFp(this.configuration).getStoredCollisionSetup(cell, setup, options).then((request) => request(this.axios, this.basePath));
|
|
5623
6708
|
}
|
|
5624
6709
|
/**
|
|
5625
|
-
* Returns a list of stored
|
|
5626
|
-
* @summary List
|
|
6710
|
+
* Returns a list of stored collision setups.
|
|
6711
|
+
* @summary List Collision Setups
|
|
5627
6712
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5628
6713
|
* @param {*} [options] Override http request option.
|
|
5629
6714
|
* @throws {RequiredError}
|
|
5630
|
-
* @memberof
|
|
6715
|
+
* @memberof StoreCollisionSetupsApi
|
|
5631
6716
|
*/
|
|
5632
|
-
|
|
5633
|
-
return
|
|
6717
|
+
listStoredCollisionSetups(cell, options) {
|
|
6718
|
+
return StoreCollisionSetupsApiFp(this.configuration).listStoredCollisionSetups(cell, options).then((request) => request(this.axios, this.basePath));
|
|
5634
6719
|
}
|
|
5635
6720
|
/**
|
|
5636
|
-
*
|
|
5637
|
-
* @summary Store
|
|
6721
|
+
* Stores collision setup. If the collision setup does not exist, it will be created. If the collision setup exists, it will be updated.
|
|
6722
|
+
* @summary Store Collision Setup
|
|
5638
6723
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5639
|
-
* @param {string}
|
|
5640
|
-
* @param {
|
|
6724
|
+
* @param {string} setup Identifier of the collision setup
|
|
6725
|
+
* @param {CollisionSetup} collisionSetup
|
|
5641
6726
|
* @param {*} [options] Override http request option.
|
|
5642
6727
|
* @throws {RequiredError}
|
|
5643
|
-
* @memberof
|
|
6728
|
+
* @memberof StoreCollisionSetupsApi
|
|
5644
6729
|
*/
|
|
5645
|
-
|
|
5646
|
-
return
|
|
6730
|
+
storeCollisionSetup(cell, setup, collisionSetup, options) {
|
|
6731
|
+
return StoreCollisionSetupsApiFp(this.configuration).storeCollisionSetup(cell, setup, collisionSetup, options).then((request) => request(this.axios, this.basePath));
|
|
5647
6732
|
}
|
|
5648
6733
|
}
|
|
5649
6734
|
/**
|
|
@@ -6148,16 +7233,14 @@ export class StoreObjectApi extends BaseAPI {
|
|
|
6148
7233
|
export const SystemApiAxiosParamCreator = function (configuration) {
|
|
6149
7234
|
return {
|
|
6150
7235
|
/**
|
|
6151
|
-
* Retrieves a configuration backup based on provided resource identifiers.
|
|
7236
|
+
* Retrieves a configuration backup based on provided resource identifiers. If an empty array of resources is provided, a backup for all resources will be retrieved.
|
|
6152
7237
|
* @summary Retrieve Configuration Backup
|
|
6153
|
-
* @param {Array<string>} resources List of resource identifiers to
|
|
7238
|
+
* @param {Array<string>} [resources] List of resource identifiers to include in the retrieval.
|
|
6154
7239
|
* @param {{ [key: string]: string; }} [metadata] Additional metadata to add to the backup
|
|
6155
7240
|
* @param {*} [options] Override http request option.
|
|
6156
7241
|
* @throws {RequiredError}
|
|
6157
7242
|
*/
|
|
6158
7243
|
backupConfiguration: async (resources, metadata, options = {}) => {
|
|
6159
|
-
// verify required parameter 'resources' is not null or undefined
|
|
6160
|
-
assertParamExists('backupConfiguration', 'resources', resources);
|
|
6161
7244
|
const localVarPath = `/system/configuration`;
|
|
6162
7245
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
6163
7246
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
@@ -6474,9 +7557,9 @@ export const SystemApiFp = function (configuration) {
|
|
|
6474
7557
|
const localVarAxiosParamCreator = SystemApiAxiosParamCreator(configuration);
|
|
6475
7558
|
return {
|
|
6476
7559
|
/**
|
|
6477
|
-
* Retrieves a configuration backup based on provided resource identifiers.
|
|
7560
|
+
* Retrieves a configuration backup based on provided resource identifiers. If an empty array of resources is provided, a backup for all resources will be retrieved.
|
|
6478
7561
|
* @summary Retrieve Configuration Backup
|
|
6479
|
-
* @param {Array<string>} resources List of resource identifiers to
|
|
7562
|
+
* @param {Array<string>} [resources] List of resource identifiers to include in the retrieval.
|
|
6480
7563
|
* @param {{ [key: string]: string; }} [metadata] Additional metadata to add to the backup
|
|
6481
7564
|
* @param {*} [options] Override http request option.
|
|
6482
7565
|
* @throws {RequiredError}
|
|
@@ -6598,9 +7681,9 @@ export const SystemApiFactory = function (configuration, basePath, axios) {
|
|
|
6598
7681
|
const localVarFp = SystemApiFp(configuration);
|
|
6599
7682
|
return {
|
|
6600
7683
|
/**
|
|
6601
|
-
* Retrieves a configuration backup based on provided resource identifiers.
|
|
7684
|
+
* Retrieves a configuration backup based on provided resource identifiers. If an empty array of resources is provided, a backup for all resources will be retrieved.
|
|
6602
7685
|
* @summary Retrieve Configuration Backup
|
|
6603
|
-
* @param {Array<string>} resources List of resource identifiers to
|
|
7686
|
+
* @param {Array<string>} [resources] List of resource identifiers to include in the retrieval.
|
|
6604
7687
|
* @param {{ [key: string]: string; }} [metadata] Additional metadata to add to the backup
|
|
6605
7688
|
* @param {*} [options] Override http request option.
|
|
6606
7689
|
* @throws {RequiredError}
|
|
@@ -6695,9 +7778,9 @@ export const SystemApiFactory = function (configuration, basePath, axios) {
|
|
|
6695
7778
|
*/
|
|
6696
7779
|
export class SystemApi extends BaseAPI {
|
|
6697
7780
|
/**
|
|
6698
|
-
* Retrieves a configuration backup based on provided resource identifiers.
|
|
7781
|
+
* Retrieves a configuration backup based on provided resource identifiers. If an empty array of resources is provided, a backup for all resources will be retrieved.
|
|
6699
7782
|
* @summary Retrieve Configuration Backup
|
|
6700
|
-
* @param {Array<string>} resources List of resource identifiers to
|
|
7783
|
+
* @param {Array<string>} [resources] List of resource identifiers to include in the retrieval.
|
|
6701
7784
|
* @param {{ [key: string]: string; }} [metadata] Additional metadata to add to the backup
|
|
6702
7785
|
* @param {*} [options] Override http request option.
|
|
6703
7786
|
* @throws {RequiredError}
|
|
@@ -7352,6 +8435,44 @@ export class TrajectoryExecutionApi extends BaseAPI {
|
|
|
7352
8435
|
*/
|
|
7353
8436
|
export const TrajectoryPlanningApiAxiosParamCreator = function (configuration) {
|
|
7354
8437
|
return {
|
|
8438
|
+
/**
|
|
8439
|
+
* 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.
|
|
8440
|
+
* @summary Plan Collision-Free Trajectory
|
|
8441
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8442
|
+
* @param {PlanCollisionFreeRequest} [planCollisionFreeRequest]
|
|
8443
|
+
* @param {*} [options] Override http request option.
|
|
8444
|
+
* @throws {RequiredError}
|
|
8445
|
+
*/
|
|
8446
|
+
planCollisionFree: async (cell, planCollisionFreeRequest, options = {}) => {
|
|
8447
|
+
// verify required parameter 'cell' is not null or undefined
|
|
8448
|
+
assertParamExists('planCollisionFree', 'cell', cell);
|
|
8449
|
+
const localVarPath = `/cells/{cell}/trajectory-planning/plan-collision-free`
|
|
8450
|
+
.replace(`{${"cell"}}`, encodeURIComponent(String(cell)));
|
|
8451
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
8452
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
8453
|
+
let baseOptions;
|
|
8454
|
+
if (configuration) {
|
|
8455
|
+
baseOptions = configuration.baseOptions;
|
|
8456
|
+
}
|
|
8457
|
+
const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options };
|
|
8458
|
+
const localVarHeaderParameter = {};
|
|
8459
|
+
const localVarQueryParameter = {};
|
|
8460
|
+
// authentication BasicAuth required
|
|
8461
|
+
// http basic authentication required
|
|
8462
|
+
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
8463
|
+
// authentication BearerAuth required
|
|
8464
|
+
// http bearer authentication required
|
|
8465
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
8466
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
8467
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
8468
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
8469
|
+
localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
|
|
8470
|
+
localVarRequestOptions.data = serializeDataIfNeeded(planCollisionFreeRequest, localVarRequestOptions, configuration);
|
|
8471
|
+
return {
|
|
8472
|
+
url: toPathString(localVarUrlObj),
|
|
8473
|
+
options: localVarRequestOptions,
|
|
8474
|
+
};
|
|
8475
|
+
},
|
|
7355
8476
|
/**
|
|
7356
8477
|
* 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.
|
|
7357
8478
|
* @summary Plan Trajectory
|
|
@@ -7399,6 +8520,20 @@ export const TrajectoryPlanningApiAxiosParamCreator = function (configuration) {
|
|
|
7399
8520
|
export const TrajectoryPlanningApiFp = function (configuration) {
|
|
7400
8521
|
const localVarAxiosParamCreator = TrajectoryPlanningApiAxiosParamCreator(configuration);
|
|
7401
8522
|
return {
|
|
8523
|
+
/**
|
|
8524
|
+
* 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.
|
|
8525
|
+
* @summary Plan Collision-Free Trajectory
|
|
8526
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8527
|
+
* @param {PlanCollisionFreeRequest} [planCollisionFreeRequest]
|
|
8528
|
+
* @param {*} [options] Override http request option.
|
|
8529
|
+
* @throws {RequiredError}
|
|
8530
|
+
*/
|
|
8531
|
+
async planCollisionFree(cell, planCollisionFreeRequest, options) {
|
|
8532
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.planCollisionFree(cell, planCollisionFreeRequest, options);
|
|
8533
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
8534
|
+
const localVarOperationServerBasePath = operationServerMap['TrajectoryPlanningApi.planCollisionFree']?.[localVarOperationServerIndex]?.url;
|
|
8535
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
8536
|
+
},
|
|
7402
8537
|
/**
|
|
7403
8538
|
* 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.
|
|
7404
8539
|
* @summary Plan Trajectory
|
|
@@ -7422,6 +8557,17 @@ export const TrajectoryPlanningApiFp = function (configuration) {
|
|
|
7422
8557
|
export const TrajectoryPlanningApiFactory = function (configuration, basePath, axios) {
|
|
7423
8558
|
const localVarFp = TrajectoryPlanningApiFp(configuration);
|
|
7424
8559
|
return {
|
|
8560
|
+
/**
|
|
8561
|
+
* 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.
|
|
8562
|
+
* @summary Plan Collision-Free Trajectory
|
|
8563
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8564
|
+
* @param {PlanCollisionFreeRequest} [planCollisionFreeRequest]
|
|
8565
|
+
* @param {*} [options] Override http request option.
|
|
8566
|
+
* @throws {RequiredError}
|
|
8567
|
+
*/
|
|
8568
|
+
planCollisionFree(cell, planCollisionFreeRequest, options) {
|
|
8569
|
+
return localVarFp.planCollisionFree(cell, planCollisionFreeRequest, options).then((request) => request(axios, basePath));
|
|
8570
|
+
},
|
|
7425
8571
|
/**
|
|
7426
8572
|
* 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.
|
|
7427
8573
|
* @summary Plan Trajectory
|
|
@@ -7442,6 +8588,18 @@ export const TrajectoryPlanningApiFactory = function (configuration, basePath, a
|
|
|
7442
8588
|
* @extends {BaseAPI}
|
|
7443
8589
|
*/
|
|
7444
8590
|
export class TrajectoryPlanningApi extends BaseAPI {
|
|
8591
|
+
/**
|
|
8592
|
+
* 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.
|
|
8593
|
+
* @summary Plan Collision-Free Trajectory
|
|
8594
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8595
|
+
* @param {PlanCollisionFreeRequest} [planCollisionFreeRequest]
|
|
8596
|
+
* @param {*} [options] Override http request option.
|
|
8597
|
+
* @throws {RequiredError}
|
|
8598
|
+
* @memberof TrajectoryPlanningApi
|
|
8599
|
+
*/
|
|
8600
|
+
planCollisionFree(cell, planCollisionFreeRequest, options) {
|
|
8601
|
+
return TrajectoryPlanningApiFp(this.configuration).planCollisionFree(cell, planCollisionFreeRequest, options).then((request) => request(this.axios, this.basePath));
|
|
8602
|
+
}
|
|
7445
8603
|
/**
|
|
7446
8604
|
* 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.
|
|
7447
8605
|
* @summary Plan Trajectory
|