@wandelbots/nova-api 25.7.0-dev.3 → 25.7.0-dev.31
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 +10 -7
- package/v1/api.js +8 -5
- package/v1/api.js.map +1 -1
- package/v1/api.ts +10 -7
- 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 +2050 -715
- package/v2/api.js +1649 -413
- package/v2/api.js.map +1 -1
- package/v2/api.ts +2866 -762
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
|
|
@@ -1021,79 +1088,1091 @@ export const ApplicationApiFactory = function (configuration, basePath, axios) {
|
|
|
1021
1088
|
*/
|
|
1022
1089
|
export class ApplicationApi extends BaseAPI {
|
|
1023
1090
|
/**
|
|
1024
|
-
* 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
|
|
1025
|
-
* @summary Add Application
|
|
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
|
|
2018
|
+
* @export
|
|
2019
|
+
* @class BUSInputsOutputsApi
|
|
2020
|
+
* @extends {BaseAPI}
|
|
2021
|
+
*/
|
|
2022
|
+
export class BUSInputsOutputsApi extends BaseAPI {
|
|
2023
|
+
/**
|
|
2024
|
+
* Add a BUS Inputs/Outputs Service to the cell.
|
|
2025
|
+
* @summary Add Service
|
|
2026
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
2027
|
+
* @param {BusIOType} busIOType
|
|
2028
|
+
* @param {number} [completionTimeout]
|
|
2029
|
+
* @param {*} [options] Override http request option.
|
|
2030
|
+
* @throws {RequiredError}
|
|
2031
|
+
* @memberof BUSInputsOutputsApi
|
|
2032
|
+
*/
|
|
2033
|
+
addBusIOService(cell, busIOType, completionTimeout, options) {
|
|
2034
|
+
return BUSInputsOutputsApiFp(this.configuration).addBusIOService(cell, busIOType, completionTimeout, options).then((request) => request(this.axios, this.basePath));
|
|
2035
|
+
}
|
|
2036
|
+
/**
|
|
2037
|
+
* Adds an input/output to or updates an input/output on the PROFINET device.
|
|
2038
|
+
* @summary Add PROFINET Input/Output
|
|
2039
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
2040
|
+
* @param {string} io Unique identifier to address an Input/Output in the cell.
|
|
2041
|
+
* @param {ProfinetIOData} profinetIOData
|
|
2042
|
+
* @param {*} [options] Override http request option.
|
|
2043
|
+
* @throws {RequiredError}
|
|
2044
|
+
* @memberof BUSInputsOutputsApi
|
|
2045
|
+
*/
|
|
2046
|
+
addProfinetIO(cell, io, profinetIOData, options) {
|
|
2047
|
+
return BUSInputsOutputsApiFp(this.configuration).addProfinetIO(cell, io, profinetIOData, options).then((request) => request(this.axios, this.basePath));
|
|
2048
|
+
}
|
|
2049
|
+
/**
|
|
2050
|
+
* Delete BUS Inputs/Outputs Service from the cell.
|
|
2051
|
+
* @summary Clear Service
|
|
2052
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
2053
|
+
* @param {number} [completionTimeout]
|
|
2054
|
+
* @param {*} [options] Override http request option.
|
|
2055
|
+
* @throws {RequiredError}
|
|
2056
|
+
* @memberof BUSInputsOutputsApi
|
|
2057
|
+
*/
|
|
2058
|
+
clearBusIOService(cell, completionTimeout, options) {
|
|
2059
|
+
return BUSInputsOutputsApiFp(this.configuration).clearBusIOService(cell, completionTimeout, options).then((request) => request(this.axios, this.basePath));
|
|
2060
|
+
}
|
|
2061
|
+
/**
|
|
2062
|
+
* Removes the input/output from the PROFINET device.
|
|
2063
|
+
* @summary Remove PROFINET Input/Ouptut
|
|
2064
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
2065
|
+
* @param {string} io Unique identifier to address an Input/Output in the cell.
|
|
2066
|
+
* @param {*} [options] Override http request option.
|
|
2067
|
+
* @throws {RequiredError}
|
|
2068
|
+
* @memberof BUSInputsOutputsApi
|
|
2069
|
+
*/
|
|
2070
|
+
deleteProfinetIO(cell, io, options) {
|
|
2071
|
+
return BUSInputsOutputsApiFp(this.configuration).deleteProfinetIO(cell, io, options).then((request) => request(this.axios, this.basePath));
|
|
2072
|
+
}
|
|
2073
|
+
/**
|
|
2074
|
+
* Get deployed BUS Inputs/Outputs Service.
|
|
2075
|
+
* @summary Get Service
|
|
2076
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
2077
|
+
* @param {*} [options] Override http request option.
|
|
2078
|
+
* @throws {RequiredError}
|
|
2079
|
+
* @memberof BUSInputsOutputsApi
|
|
2080
|
+
*/
|
|
2081
|
+
getBusIOService(cell, options) {
|
|
2082
|
+
return BUSInputsOutputsApiFp(this.configuration).getBusIOService(cell, options).then((request) => request(this.axios, this.basePath));
|
|
2083
|
+
}
|
|
2084
|
+
/**
|
|
2085
|
+
* Get the current state of the BUS Inputs/Outputs service.
|
|
2086
|
+
* @summary State
|
|
2087
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
2088
|
+
* @param {*} [options] Override http request option.
|
|
2089
|
+
* @throws {RequiredError}
|
|
2090
|
+
* @memberof BUSInputsOutputsApi
|
|
2091
|
+
*/
|
|
2092
|
+
getBusIOState(cell, options) {
|
|
2093
|
+
return BUSInputsOutputsApiFp(this.configuration).getBusIOState(cell, options).then((request) => request(this.axios, this.basePath));
|
|
2094
|
+
}
|
|
2095
|
+
/**
|
|
2096
|
+
* Retrieves the current values of inputs/outputs. The identifiers of the inputs/outputs must be provided in the request. Request all available input/output identifiers via [listBusIODescriptions](listBusIODescriptions).
|
|
2097
|
+
* @summary Get Input/Output Values
|
|
1026
2098
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
1027
|
-
* @param {
|
|
1028
|
-
* @param {number} [completionTimeout]
|
|
2099
|
+
* @param {Array<string>} [ios]
|
|
1029
2100
|
* @param {*} [options] Override http request option.
|
|
1030
2101
|
* @throws {RequiredError}
|
|
1031
|
-
* @memberof
|
|
2102
|
+
* @memberof BUSInputsOutputsApi
|
|
1032
2103
|
*/
|
|
1033
|
-
|
|
1034
|
-
return
|
|
2104
|
+
getBusIOValues(cell, ios, options) {
|
|
2105
|
+
return BUSInputsOutputsApiFp(this.configuration).getBusIOValues(cell, ios, options).then((request) => request(this.axios, this.basePath));
|
|
1035
2106
|
}
|
|
1036
2107
|
/**
|
|
1037
|
-
*
|
|
1038
|
-
* @summary
|
|
2108
|
+
* Get description of PROFINET
|
|
2109
|
+
* @summary Get PROFINET Description
|
|
1039
2110
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
1040
|
-
* @param {number} [completionTimeout]
|
|
1041
2111
|
* @param {*} [options] Override http request option.
|
|
1042
2112
|
* @throws {RequiredError}
|
|
1043
|
-
* @memberof
|
|
2113
|
+
* @memberof BUSInputsOutputsApi
|
|
1044
2114
|
*/
|
|
1045
|
-
|
|
1046
|
-
return
|
|
2115
|
+
getProfinetDescription(cell, options) {
|
|
2116
|
+
return BUSInputsOutputsApiFp(this.configuration).getProfinetDescription(cell, options).then((request) => request(this.axios, this.basePath));
|
|
1047
2117
|
}
|
|
1048
2118
|
/**
|
|
1049
|
-
*
|
|
1050
|
-
* @summary
|
|
2119
|
+
* Get input/output configuration of the PROFINET device as file.
|
|
2120
|
+
* @summary PROFINET Inputs/Outputs to File
|
|
1051
2121
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
1052
|
-
* @param {
|
|
1053
|
-
* @param {number} [
|
|
2122
|
+
* @param {number} [inputOffset]
|
|
2123
|
+
* @param {number} [outputOffset]
|
|
1054
2124
|
* @param {*} [options] Override http request option.
|
|
1055
2125
|
* @throws {RequiredError}
|
|
1056
|
-
* @memberof
|
|
2126
|
+
* @memberof BUSInputsOutputsApi
|
|
1057
2127
|
*/
|
|
1058
|
-
|
|
1059
|
-
return
|
|
2128
|
+
getProfinetIOsFromFile(cell, inputOffset, outputOffset, options) {
|
|
2129
|
+
return BUSInputsOutputsApiFp(this.configuration).getProfinetIOsFromFile(cell, inputOffset, outputOffset, options).then((request) => request(this.axios, this.basePath));
|
|
1060
2130
|
}
|
|
1061
2131
|
/**
|
|
1062
|
-
*
|
|
1063
|
-
* @summary
|
|
2132
|
+
* List all BUS Input/Output descriptions.
|
|
2133
|
+
* @summary List Descriptions
|
|
1064
2134
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
1065
|
-
* @param {string} app
|
|
1066
2135
|
* @param {*} [options] Override http request option.
|
|
1067
2136
|
* @throws {RequiredError}
|
|
1068
|
-
* @memberof
|
|
2137
|
+
* @memberof BUSInputsOutputsApi
|
|
1069
2138
|
*/
|
|
1070
|
-
|
|
1071
|
-
return
|
|
2139
|
+
listBusIODescriptions(cell, options) {
|
|
2140
|
+
return BUSInputsOutputsApiFp(this.configuration).listBusIODescriptions(cell, options).then((request) => request(this.axios, this.basePath));
|
|
1072
2141
|
}
|
|
1073
2142
|
/**
|
|
1074
|
-
* List all
|
|
1075
|
-
* @summary List
|
|
2143
|
+
* List all PROFINET input and outputs.
|
|
2144
|
+
* @summary List PROFINET Input/Output Configuration
|
|
1076
2145
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
1077
2146
|
* @param {*} [options] Override http request option.
|
|
1078
2147
|
* @throws {RequiredError}
|
|
1079
|
-
* @memberof
|
|
2148
|
+
* @memberof BUSInputsOutputsApi
|
|
1080
2149
|
*/
|
|
1081
|
-
|
|
1082
|
-
return
|
|
2150
|
+
listProfinetIOs(cell, options) {
|
|
2151
|
+
return BUSInputsOutputsApiFp(this.configuration).listProfinetIOs(cell, options).then((request) => request(this.axios, this.basePath));
|
|
1083
2152
|
}
|
|
1084
2153
|
/**
|
|
1085
|
-
*
|
|
1086
|
-
* @summary
|
|
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
|
|
1087
2156
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
1088
|
-
* @param {
|
|
1089
|
-
* @param {App} app2
|
|
1090
|
-
* @param {number} [completionTimeout]
|
|
2157
|
+
* @param {Array<IOValue>} iOValue
|
|
1091
2158
|
* @param {*} [options] Override http request option.
|
|
1092
2159
|
* @throws {RequiredError}
|
|
1093
|
-
* @memberof
|
|
2160
|
+
* @memberof BUSInputsOutputsApi
|
|
1094
2161
|
*/
|
|
1095
|
-
|
|
1096
|
-
return
|
|
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
|
/**
|
|
@@ -1778,26 +2857,21 @@ export const ControllerApiAxiosParamCreator = function (configuration) {
|
|
|
1778
2857
|
};
|
|
1779
2858
|
},
|
|
1780
2859
|
/**
|
|
1781
|
-
*
|
|
1782
|
-
* @summary
|
|
2860
|
+
* Get description of a configured robot controller including a list of connected motion group identifiers. Use [getMotionGroupDescription](getMotionGroupDescription) to get more information about the motion group.
|
|
2861
|
+
* @summary Description
|
|
1783
2862
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
1784
2863
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
1785
|
-
* @param {string} coordinateSystem Unique identifier addressing a coordinate system.
|
|
1786
|
-
* @param {OrientationType} [orientationType]
|
|
1787
2864
|
* @param {*} [options] Override http request option.
|
|
1788
2865
|
* @throws {RequiredError}
|
|
1789
2866
|
*/
|
|
1790
|
-
|
|
2867
|
+
getControllerDescription: async (cell, controller, options = {}) => {
|
|
1791
2868
|
// verify required parameter 'cell' is not null or undefined
|
|
1792
|
-
assertParamExists('
|
|
2869
|
+
assertParamExists('getControllerDescription', 'cell', cell);
|
|
1793
2870
|
// verify required parameter 'controller' is not null or undefined
|
|
1794
|
-
assertParamExists('
|
|
1795
|
-
|
|
1796
|
-
assertParamExists('getCoordinateSystem', 'coordinateSystem', coordinateSystem);
|
|
1797
|
-
const localVarPath = `/cells/{cell}/controllers/{controller}/coordinate-systems/{coordinate-system}`
|
|
2871
|
+
assertParamExists('getControllerDescription', 'controller', controller);
|
|
2872
|
+
const localVarPath = `/cells/{cell}/controllers/{controller}/description`
|
|
1798
2873
|
.replace(`{${"cell"}}`, encodeURIComponent(String(cell)))
|
|
1799
|
-
.replace(`{${"controller"}}`, encodeURIComponent(String(controller)))
|
|
1800
|
-
.replace(`{${"coordinate-system"}}`, encodeURIComponent(String(coordinateSystem)));
|
|
2874
|
+
.replace(`{${"controller"}}`, encodeURIComponent(String(controller)));
|
|
1801
2875
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
1802
2876
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
1803
2877
|
let baseOptions;
|
|
@@ -1813,9 +2887,6 @@ export const ControllerApiAxiosParamCreator = function (configuration) {
|
|
|
1813
2887
|
// authentication BearerAuth required
|
|
1814
2888
|
// http bearer authentication required
|
|
1815
2889
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
1816
|
-
if (orientationType !== undefined) {
|
|
1817
|
-
localVarQueryParameter['orientation_type'] = orientationType;
|
|
1818
|
-
}
|
|
1819
2890
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
1820
2891
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
1821
2892
|
localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
|
|
@@ -1825,21 +2896,26 @@ export const ControllerApiAxiosParamCreator = function (configuration) {
|
|
|
1825
2896
|
};
|
|
1826
2897
|
},
|
|
1827
2898
|
/**
|
|
1828
|
-
*
|
|
1829
|
-
* @summary
|
|
2899
|
+
* Request a coordinate system specification for a given identifier. Use parameter orientation_type to get the orientation part of the transformation offset of the coordinate system returned in the requested orientation notation. If parameter orientation_type is not set, the orientation part of the transformation offset of the coordinate system is returned in rotation vector notation. The coordinate systems from the robot controller are loaded when the motion group associated with the coordinate system is activated. With deactivation of the motion group, the associated coordinate systems are removed from NOVA. The unique identifier of the coordinate systems from the robot controllers are suffixed with \"On\" + the unique identifier of the robot controller.
|
|
2900
|
+
* @summary Coordinate System
|
|
1830
2901
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
1831
2902
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
2903
|
+
* @param {string} coordinateSystem Unique identifier addressing a coordinate system.
|
|
2904
|
+
* @param {OrientationType} [orientationType]
|
|
1832
2905
|
* @param {*} [options] Override http request option.
|
|
1833
2906
|
* @throws {RequiredError}
|
|
1834
2907
|
*/
|
|
1835
|
-
|
|
2908
|
+
getCoordinateSystem: async (cell, controller, coordinateSystem, orientationType, options = {}) => {
|
|
1836
2909
|
// verify required parameter 'cell' is not null or undefined
|
|
1837
|
-
assertParamExists('
|
|
2910
|
+
assertParamExists('getCoordinateSystem', 'cell', cell);
|
|
1838
2911
|
// verify required parameter 'controller' is not null or undefined
|
|
1839
|
-
assertParamExists('
|
|
1840
|
-
|
|
2912
|
+
assertParamExists('getCoordinateSystem', 'controller', controller);
|
|
2913
|
+
// verify required parameter 'coordinateSystem' is not null or undefined
|
|
2914
|
+
assertParamExists('getCoordinateSystem', 'coordinateSystem', coordinateSystem);
|
|
2915
|
+
const localVarPath = `/cells/{cell}/controllers/{controller}/coordinate-systems/{coordinate-system}`
|
|
1841
2916
|
.replace(`{${"cell"}}`, encodeURIComponent(String(cell)))
|
|
1842
|
-
.replace(`{${"controller"}}`, encodeURIComponent(String(controller)))
|
|
2917
|
+
.replace(`{${"controller"}}`, encodeURIComponent(String(controller)))
|
|
2918
|
+
.replace(`{${"coordinate-system"}}`, encodeURIComponent(String(coordinateSystem)));
|
|
1843
2919
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
1844
2920
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
1845
2921
|
let baseOptions;
|
|
@@ -1855,6 +2931,9 @@ export const ControllerApiAxiosParamCreator = function (configuration) {
|
|
|
1855
2931
|
// authentication BearerAuth required
|
|
1856
2932
|
// http bearer authentication required
|
|
1857
2933
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
2934
|
+
if (orientationType !== undefined) {
|
|
2935
|
+
localVarQueryParameter['orientation_type'] = orientationType;
|
|
2936
|
+
}
|
|
1858
2937
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
1859
2938
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
1860
2939
|
localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
|
|
@@ -1864,19 +2943,19 @@ export const ControllerApiAxiosParamCreator = function (configuration) {
|
|
|
1864
2943
|
};
|
|
1865
2944
|
},
|
|
1866
2945
|
/**
|
|
1867
|
-
* Get the current
|
|
1868
|
-
* @summary
|
|
2946
|
+
* Get the current state of a robot controller.
|
|
2947
|
+
* @summary State
|
|
1869
2948
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
1870
2949
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
1871
2950
|
* @param {*} [options] Override http request option.
|
|
1872
2951
|
* @throws {RequiredError}
|
|
1873
2952
|
*/
|
|
1874
|
-
|
|
2953
|
+
getCurrentRobotControllerState: async (cell, controller, options = {}) => {
|
|
1875
2954
|
// verify required parameter 'cell' is not null or undefined
|
|
1876
|
-
assertParamExists('
|
|
2955
|
+
assertParamExists('getCurrentRobotControllerState', 'cell', cell);
|
|
1877
2956
|
// verify required parameter 'controller' is not null or undefined
|
|
1878
|
-
assertParamExists('
|
|
1879
|
-
const localVarPath = `/cells/{cell}/controllers/{controller}/
|
|
2957
|
+
assertParamExists('getCurrentRobotControllerState', 'controller', controller);
|
|
2958
|
+
const localVarPath = `/cells/{cell}/controllers/{controller}/state`
|
|
1880
2959
|
.replace(`{${"cell"}}`, encodeURIComponent(String(cell)))
|
|
1881
2960
|
.replace(`{${"controller"}}`, encodeURIComponent(String(controller)));
|
|
1882
2961
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
@@ -1942,18 +3021,18 @@ export const ControllerApiAxiosParamCreator = function (configuration) {
|
|
|
1942
3021
|
};
|
|
1943
3022
|
},
|
|
1944
3023
|
/**
|
|
1945
|
-
* Receive
|
|
1946
|
-
* @summary Virtual
|
|
3024
|
+
* Receive data to configure a virtual robot controller based on another controller. This can be used to create a virtual clone of a specific physical robot. When adding a virtual controller, use the Virtual configuration variant of [addRobotController](addRobotController) and pass the content string from this endpoint as the `json` field. Omit the `type` field that selects a preset configuration which is not required when providing a complete configuration. > **NOTE** > > The output generated by this endpoint can be too large for the site to handle, and may produce an error or incorrect output. > Use `curl` in combination with `> output.json` to capture the output, or use an API client like Postman.
|
|
3025
|
+
* @summary Virtual Controller Configuration
|
|
1947
3026
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
1948
3027
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
1949
3028
|
* @param {*} [options] Override http request option.
|
|
1950
3029
|
* @throws {RequiredError}
|
|
1951
3030
|
*/
|
|
1952
|
-
|
|
3031
|
+
getVirtualControllerConfiguration: async (cell, controller, options = {}) => {
|
|
1953
3032
|
// verify required parameter 'cell' is not null or undefined
|
|
1954
|
-
assertParamExists('
|
|
3033
|
+
assertParamExists('getVirtualControllerConfiguration', 'cell', cell);
|
|
1955
3034
|
// verify required parameter 'controller' is not null or undefined
|
|
1956
|
-
assertParamExists('
|
|
3035
|
+
assertParamExists('getVirtualControllerConfiguration', 'controller', controller);
|
|
1957
3036
|
const localVarPath = `/cells/{cell}/controllers/{controller}/virtual-robot-configuration`
|
|
1958
3037
|
.replace(`{${"cell"}}`, encodeURIComponent(String(cell)))
|
|
1959
3038
|
.replace(`{${"controller"}}`, encodeURIComponent(String(controller)));
|
|
@@ -2147,15 +3226,16 @@ export const ControllerApiAxiosParamCreator = function (configuration) {
|
|
|
2147
3226
|
};
|
|
2148
3227
|
},
|
|
2149
3228
|
/**
|
|
2150
|
-
* <!-- 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.
|
|
2151
3230
|
* @summary Stream State
|
|
2152
3231
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
2153
3232
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
2154
3233
|
* @param {number} [responseRate]
|
|
3234
|
+
* @param {number} [addControllerTimeout]
|
|
2155
3235
|
* @param {*} [options] Override http request option.
|
|
2156
3236
|
* @throws {RequiredError}
|
|
2157
3237
|
*/
|
|
2158
|
-
streamRobotControllerState: async (cell, controller, responseRate, options = {}) => {
|
|
3238
|
+
streamRobotControllerState: async (cell, controller, responseRate, addControllerTimeout, options = {}) => {
|
|
2159
3239
|
// verify required parameter 'cell' is not null or undefined
|
|
2160
3240
|
assertParamExists('streamRobotControllerState', 'cell', cell);
|
|
2161
3241
|
// verify required parameter 'controller' is not null or undefined
|
|
@@ -2181,6 +3261,9 @@ export const ControllerApiAxiosParamCreator = function (configuration) {
|
|
|
2181
3261
|
if (responseRate !== undefined) {
|
|
2182
3262
|
localVarQueryParameter['response_rate'] = responseRate;
|
|
2183
3263
|
}
|
|
3264
|
+
if (addControllerTimeout !== undefined) {
|
|
3265
|
+
localVarQueryParameter['add_controller_timeout'] = addControllerTimeout;
|
|
3266
|
+
}
|
|
2184
3267
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
2185
3268
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
2186
3269
|
localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
|
|
@@ -2290,6 +3373,20 @@ export const ControllerApiFp = function (configuration) {
|
|
|
2290
3373
|
const localVarOperationServerBasePath = operationServerMap['ControllerApi.deleteRobotController']?.[localVarOperationServerIndex]?.url;
|
|
2291
3374
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
2292
3375
|
},
|
|
3376
|
+
/**
|
|
3377
|
+
* Get description of a configured robot controller including a list of connected motion group identifiers. Use [getMotionGroupDescription](getMotionGroupDescription) to get more information about the motion group.
|
|
3378
|
+
* @summary Description
|
|
3379
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
3380
|
+
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
3381
|
+
* @param {*} [options] Override http request option.
|
|
3382
|
+
* @throws {RequiredError}
|
|
3383
|
+
*/
|
|
3384
|
+
async getControllerDescription(cell, controller, options) {
|
|
3385
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.getControllerDescription(cell, controller, options);
|
|
3386
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
3387
|
+
const localVarOperationServerBasePath = operationServerMap['ControllerApi.getControllerDescription']?.[localVarOperationServerIndex]?.url;
|
|
3388
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
3389
|
+
},
|
|
2293
3390
|
/**
|
|
2294
3391
|
* Request a coordinate system specification for a given identifier. Use parameter orientation_type to get the orientation part of the transformation offset of the coordinate system returned in the requested orientation notation. If parameter orientation_type is not set, the orientation part of the transformation offset of the coordinate system is returned in rotation vector notation. The coordinate systems from the robot controller are loaded when the motion group associated with the coordinate system is activated. With deactivation of the motion group, the associated coordinate systems are removed from NOVA. The unique identifier of the coordinate systems from the robot controllers are suffixed with \"On\" + the unique identifier of the robot controller.
|
|
2295
3392
|
* @summary Coordinate System
|
|
@@ -2320,20 +3417,6 @@ export const ControllerApiFp = function (configuration) {
|
|
|
2320
3417
|
const localVarOperationServerBasePath = operationServerMap['ControllerApi.getCurrentRobotControllerState']?.[localVarOperationServerIndex]?.url;
|
|
2321
3418
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
2322
3419
|
},
|
|
2323
|
-
/**
|
|
2324
|
-
* 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).
|
|
2325
|
-
* @summary Current Mode
|
|
2326
|
-
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
2327
|
-
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
2328
|
-
* @param {*} [options] Override http request option.
|
|
2329
|
-
* @throws {RequiredError}
|
|
2330
|
-
*/
|
|
2331
|
-
async getMode(cell, controller, options) {
|
|
2332
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.getMode(cell, controller, options);
|
|
2333
|
-
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
2334
|
-
const localVarOperationServerBasePath = operationServerMap['ControllerApi.getMode']?.[localVarOperationServerIndex]?.url;
|
|
2335
|
-
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
2336
|
-
},
|
|
2337
3420
|
/**
|
|
2338
3421
|
* Get the configuration for a robot controller.
|
|
2339
3422
|
* @summary Robot Controller
|
|
@@ -2349,17 +3432,17 @@ export const ControllerApiFp = function (configuration) {
|
|
|
2349
3432
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
2350
3433
|
},
|
|
2351
3434
|
/**
|
|
2352
|
-
* Receive
|
|
2353
|
-
* @summary Virtual
|
|
3435
|
+
* Receive data to configure a virtual robot controller based on another controller. This can be used to create a virtual clone of a specific physical robot. When adding a virtual controller, use the Virtual configuration variant of [addRobotController](addRobotController) and pass the content string from this endpoint as the `json` field. Omit the `type` field that selects a preset configuration which is not required when providing a complete configuration. > **NOTE** > > The output generated by this endpoint can be too large for the site to handle, and may produce an error or incorrect output. > Use `curl` in combination with `> output.json` to capture the output, or use an API client like Postman.
|
|
3436
|
+
* @summary Virtual Controller Configuration
|
|
2354
3437
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
2355
3438
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
2356
3439
|
* @param {*} [options] Override http request option.
|
|
2357
3440
|
* @throws {RequiredError}
|
|
2358
3441
|
*/
|
|
2359
|
-
async
|
|
2360
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.
|
|
3442
|
+
async getVirtualControllerConfiguration(cell, controller, options) {
|
|
3443
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.getVirtualControllerConfiguration(cell, controller, options);
|
|
2361
3444
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
2362
|
-
const localVarOperationServerBasePath = operationServerMap['ControllerApi.
|
|
3445
|
+
const localVarOperationServerBasePath = operationServerMap['ControllerApi.getVirtualControllerConfiguration']?.[localVarOperationServerIndex]?.url;
|
|
2363
3446
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
2364
3447
|
},
|
|
2365
3448
|
/**
|
|
@@ -2421,16 +3504,17 @@ export const ControllerApiFp = function (configuration) {
|
|
|
2421
3504
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
2422
3505
|
},
|
|
2423
3506
|
/**
|
|
2424
|
-
* <!-- 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.
|
|
2425
3508
|
* @summary Stream State
|
|
2426
3509
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
2427
3510
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
2428
3511
|
* @param {number} [responseRate]
|
|
3512
|
+
* @param {number} [addControllerTimeout]
|
|
2429
3513
|
* @param {*} [options] Override http request option.
|
|
2430
3514
|
* @throws {RequiredError}
|
|
2431
3515
|
*/
|
|
2432
|
-
async streamRobotControllerState(cell, controller, responseRate, options) {
|
|
2433
|
-
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);
|
|
2434
3518
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
2435
3519
|
const localVarOperationServerBasePath = operationServerMap['ControllerApi.streamRobotControllerState']?.[localVarOperationServerIndex]?.url;
|
|
2436
3520
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
@@ -2495,6 +3579,17 @@ export const ControllerApiFactory = function (configuration, basePath, axios) {
|
|
|
2495
3579
|
deleteRobotController(cell, controller, completionTimeout, options) {
|
|
2496
3580
|
return localVarFp.deleteRobotController(cell, controller, completionTimeout, options).then((request) => request(axios, basePath));
|
|
2497
3581
|
},
|
|
3582
|
+
/**
|
|
3583
|
+
* Get description of a configured robot controller including a list of connected motion group identifiers. Use [getMotionGroupDescription](getMotionGroupDescription) to get more information about the motion group.
|
|
3584
|
+
* @summary Description
|
|
3585
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
3586
|
+
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
3587
|
+
* @param {*} [options] Override http request option.
|
|
3588
|
+
* @throws {RequiredError}
|
|
3589
|
+
*/
|
|
3590
|
+
getControllerDescription(cell, controller, options) {
|
|
3591
|
+
return localVarFp.getControllerDescription(cell, controller, options).then((request) => request(axios, basePath));
|
|
3592
|
+
},
|
|
2498
3593
|
/**
|
|
2499
3594
|
* Request a coordinate system specification for a given identifier. Use parameter orientation_type to get the orientation part of the transformation offset of the coordinate system returned in the requested orientation notation. If parameter orientation_type is not set, the orientation part of the transformation offset of the coordinate system is returned in rotation vector notation. The coordinate systems from the robot controller are loaded when the motion group associated with the coordinate system is activated. With deactivation of the motion group, the associated coordinate systems are removed from NOVA. The unique identifier of the coordinate systems from the robot controllers are suffixed with \"On\" + the unique identifier of the robot controller.
|
|
2500
3595
|
* @summary Coordinate System
|
|
@@ -2519,17 +3614,6 @@ export const ControllerApiFactory = function (configuration, basePath, axios) {
|
|
|
2519
3614
|
getCurrentRobotControllerState(cell, controller, options) {
|
|
2520
3615
|
return localVarFp.getCurrentRobotControllerState(cell, controller, options).then((request) => request(axios, basePath));
|
|
2521
3616
|
},
|
|
2522
|
-
/**
|
|
2523
|
-
* 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).
|
|
2524
|
-
* @summary Current Mode
|
|
2525
|
-
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
2526
|
-
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
2527
|
-
* @param {*} [options] Override http request option.
|
|
2528
|
-
* @throws {RequiredError}
|
|
2529
|
-
*/
|
|
2530
|
-
getMode(cell, controller, options) {
|
|
2531
|
-
return localVarFp.getMode(cell, controller, options).then((request) => request(axios, basePath));
|
|
2532
|
-
},
|
|
2533
3617
|
/**
|
|
2534
3618
|
* Get the configuration for a robot controller.
|
|
2535
3619
|
* @summary Robot Controller
|
|
@@ -2542,15 +3626,15 @@ export const ControllerApiFactory = function (configuration, basePath, axios) {
|
|
|
2542
3626
|
return localVarFp.getRobotController(cell, controller, options).then((request) => request(axios, basePath));
|
|
2543
3627
|
},
|
|
2544
3628
|
/**
|
|
2545
|
-
* Receive
|
|
2546
|
-
* @summary Virtual
|
|
3629
|
+
* Receive data to configure a virtual robot controller based on another controller. This can be used to create a virtual clone of a specific physical robot. When adding a virtual controller, use the Virtual configuration variant of [addRobotController](addRobotController) and pass the content string from this endpoint as the `json` field. Omit the `type` field that selects a preset configuration which is not required when providing a complete configuration. > **NOTE** > > The output generated by this endpoint can be too large for the site to handle, and may produce an error or incorrect output. > Use `curl` in combination with `> output.json` to capture the output, or use an API client like Postman.
|
|
3630
|
+
* @summary Virtual Controller Configuration
|
|
2547
3631
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
2548
3632
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
2549
3633
|
* @param {*} [options] Override http request option.
|
|
2550
3634
|
* @throws {RequiredError}
|
|
2551
3635
|
*/
|
|
2552
|
-
|
|
2553
|
-
return localVarFp.
|
|
3636
|
+
getVirtualControllerConfiguration(cell, controller, options) {
|
|
3637
|
+
return localVarFp.getVirtualControllerConfiguration(cell, controller, options).then((request) => request(axios, basePath));
|
|
2554
3638
|
},
|
|
2555
3639
|
/**
|
|
2556
3640
|
* Lists all specifications of coordinate systems from robot controllers. Use parameter orientation_type to get the orientation part of the transformation offset of the coordinate system returned in the requested orientation notation. If parameter orientation_type is not set, the orientation part of the transformation offset of the coordinate system is returned in rotation vector notation. The coordinate systems from the robot controller are loaded when the motion group associated with the coordinate system is activated. With deactivation of the motion group, the associated coordinate systems are removed from NOVA. The unique identifier of the coordinate systems from the robot controllers are suffixed with \"On\" + the unique identifier of the robot controller.
|
|
@@ -2599,16 +3683,17 @@ export const ControllerApiFactory = function (configuration, basePath, axios) {
|
|
|
2599
3683
|
return localVarFp.streamFreeDrive(cell, controller, responseRate, options).then((request) => request(axios, basePath));
|
|
2600
3684
|
},
|
|
2601
3685
|
/**
|
|
2602
|
-
* <!-- 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.
|
|
2603
3687
|
* @summary Stream State
|
|
2604
3688
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
2605
3689
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
2606
3690
|
* @param {number} [responseRate]
|
|
3691
|
+
* @param {number} [addControllerTimeout]
|
|
2607
3692
|
* @param {*} [options] Override http request option.
|
|
2608
3693
|
* @throws {RequiredError}
|
|
2609
3694
|
*/
|
|
2610
|
-
streamRobotControllerState(cell, controller, responseRate, options) {
|
|
2611
|
-
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));
|
|
2612
3697
|
},
|
|
2613
3698
|
/**
|
|
2614
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.
|
|
@@ -2670,6 +3755,18 @@ export class ControllerApi extends BaseAPI {
|
|
|
2670
3755
|
deleteRobotController(cell, controller, completionTimeout, options) {
|
|
2671
3756
|
return ControllerApiFp(this.configuration).deleteRobotController(cell, controller, completionTimeout, options).then((request) => request(this.axios, this.basePath));
|
|
2672
3757
|
}
|
|
3758
|
+
/**
|
|
3759
|
+
* Get description of a configured robot controller including a list of connected motion group identifiers. Use [getMotionGroupDescription](getMotionGroupDescription) to get more information about the motion group.
|
|
3760
|
+
* @summary Description
|
|
3761
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
3762
|
+
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
3763
|
+
* @param {*} [options] Override http request option.
|
|
3764
|
+
* @throws {RequiredError}
|
|
3765
|
+
* @memberof ControllerApi
|
|
3766
|
+
*/
|
|
3767
|
+
getControllerDescription(cell, controller, options) {
|
|
3768
|
+
return ControllerApiFp(this.configuration).getControllerDescription(cell, controller, options).then((request) => request(this.axios, this.basePath));
|
|
3769
|
+
}
|
|
2673
3770
|
/**
|
|
2674
3771
|
* Request a coordinate system specification for a given identifier. Use parameter orientation_type to get the orientation part of the transformation offset of the coordinate system returned in the requested orientation notation. If parameter orientation_type is not set, the orientation part of the transformation offset of the coordinate system is returned in rotation vector notation. The coordinate systems from the robot controller are loaded when the motion group associated with the coordinate system is activated. With deactivation of the motion group, the associated coordinate systems are removed from NOVA. The unique identifier of the coordinate systems from the robot controllers are suffixed with \"On\" + the unique identifier of the robot controller.
|
|
2675
3772
|
* @summary Coordinate System
|
|
@@ -2696,18 +3793,6 @@ export class ControllerApi extends BaseAPI {
|
|
|
2696
3793
|
getCurrentRobotControllerState(cell, controller, options) {
|
|
2697
3794
|
return ControllerApiFp(this.configuration).getCurrentRobotControllerState(cell, controller, options).then((request) => request(this.axios, this.basePath));
|
|
2698
3795
|
}
|
|
2699
|
-
/**
|
|
2700
|
-
* 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).
|
|
2701
|
-
* @summary Current Mode
|
|
2702
|
-
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
2703
|
-
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
2704
|
-
* @param {*} [options] Override http request option.
|
|
2705
|
-
* @throws {RequiredError}
|
|
2706
|
-
* @memberof ControllerApi
|
|
2707
|
-
*/
|
|
2708
|
-
getMode(cell, controller, options) {
|
|
2709
|
-
return ControllerApiFp(this.configuration).getMode(cell, controller, options).then((request) => request(this.axios, this.basePath));
|
|
2710
|
-
}
|
|
2711
3796
|
/**
|
|
2712
3797
|
* Get the configuration for a robot controller.
|
|
2713
3798
|
* @summary Robot Controller
|
|
@@ -2721,16 +3806,16 @@ export class ControllerApi extends BaseAPI {
|
|
|
2721
3806
|
return ControllerApiFp(this.configuration).getRobotController(cell, controller, options).then((request) => request(this.axios, this.basePath));
|
|
2722
3807
|
}
|
|
2723
3808
|
/**
|
|
2724
|
-
* Receive
|
|
2725
|
-
* @summary Virtual
|
|
3809
|
+
* Receive data to configure a virtual robot controller based on another controller. This can be used to create a virtual clone of a specific physical robot. When adding a virtual controller, use the Virtual configuration variant of [addRobotController](addRobotController) and pass the content string from this endpoint as the `json` field. Omit the `type` field that selects a preset configuration which is not required when providing a complete configuration. > **NOTE** > > The output generated by this endpoint can be too large for the site to handle, and may produce an error or incorrect output. > Use `curl` in combination with `> output.json` to capture the output, or use an API client like Postman.
|
|
3810
|
+
* @summary Virtual Controller Configuration
|
|
2726
3811
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
2727
3812
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
2728
3813
|
* @param {*} [options] Override http request option.
|
|
2729
3814
|
* @throws {RequiredError}
|
|
2730
3815
|
* @memberof ControllerApi
|
|
2731
3816
|
*/
|
|
2732
|
-
|
|
2733
|
-
return ControllerApiFp(this.configuration).
|
|
3817
|
+
getVirtualControllerConfiguration(cell, controller, options) {
|
|
3818
|
+
return ControllerApiFp(this.configuration).getVirtualControllerConfiguration(cell, controller, options).then((request) => request(this.axios, this.basePath));
|
|
2734
3819
|
}
|
|
2735
3820
|
/**
|
|
2736
3821
|
* Lists all specifications of coordinate systems from robot controllers. Use parameter orientation_type to get the orientation part of the transformation offset of the coordinate system returned in the requested orientation notation. If parameter orientation_type is not set, the orientation part of the transformation offset of the coordinate system is returned in rotation vector notation. The coordinate systems from the robot controller are loaded when the motion group associated with the coordinate system is activated. With deactivation of the motion group, the associated coordinate systems are removed from NOVA. The unique identifier of the coordinate systems from the robot controllers are suffixed with \"On\" + the unique identifier of the robot controller.
|
|
@@ -2783,17 +3868,18 @@ export class ControllerApi extends BaseAPI {
|
|
|
2783
3868
|
return ControllerApiFp(this.configuration).streamFreeDrive(cell, controller, responseRate, options).then((request) => request(this.axios, this.basePath));
|
|
2784
3869
|
}
|
|
2785
3870
|
/**
|
|
2786
|
-
* <!-- 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.
|
|
2787
3872
|
* @summary Stream State
|
|
2788
3873
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
2789
3874
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
2790
3875
|
* @param {number} [responseRate]
|
|
3876
|
+
* @param {number} [addControllerTimeout]
|
|
2791
3877
|
* @param {*} [options] Override http request option.
|
|
2792
3878
|
* @throws {RequiredError}
|
|
2793
3879
|
* @memberof ControllerApi
|
|
2794
3880
|
*/
|
|
2795
|
-
streamRobotControllerState(cell, controller, responseRate, options) {
|
|
2796
|
-
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));
|
|
2797
3883
|
}
|
|
2798
3884
|
/**
|
|
2799
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.
|
|
@@ -3406,6 +4492,44 @@ export class JoggingApi extends BaseAPI {
|
|
|
3406
4492
|
*/
|
|
3407
4493
|
export const KinematicsApiAxiosParamCreator = function (configuration) {
|
|
3408
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
|
+
},
|
|
3409
4533
|
/**
|
|
3410
4534
|
* Returns the reachable joint positions for a list of given poses.
|
|
3411
4535
|
* @summary Inverse kinematics
|
|
@@ -3453,6 +4577,20 @@ export const KinematicsApiAxiosParamCreator = function (configuration) {
|
|
|
3453
4577
|
export const KinematicsApiFp = function (configuration) {
|
|
3454
4578
|
const localVarAxiosParamCreator = KinematicsApiAxiosParamCreator(configuration);
|
|
3455
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
|
+
},
|
|
3456
4594
|
/**
|
|
3457
4595
|
* Returns the reachable joint positions for a list of given poses.
|
|
3458
4596
|
* @summary Inverse kinematics
|
|
@@ -3476,6 +4614,17 @@ export const KinematicsApiFp = function (configuration) {
|
|
|
3476
4614
|
export const KinematicsApiFactory = function (configuration, basePath, axios) {
|
|
3477
4615
|
const localVarFp = KinematicsApiFp(configuration);
|
|
3478
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
|
+
},
|
|
3479
4628
|
/**
|
|
3480
4629
|
* Returns the reachable joint positions for a list of given poses.
|
|
3481
4630
|
* @summary Inverse kinematics
|
|
@@ -3496,6 +4645,18 @@ export const KinematicsApiFactory = function (configuration, basePath, axios) {
|
|
|
3496
4645
|
* @extends {BaseAPI}
|
|
3497
4646
|
*/
|
|
3498
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
|
+
}
|
|
3499
4660
|
/**
|
|
3500
4661
|
* Returns the reachable joint positions for a list of given poses.
|
|
3501
4662
|
* @summary Inverse kinematics
|
|
@@ -5232,27 +6393,27 @@ export class StoreCollisionComponentsApi extends BaseAPI {
|
|
|
5232
6393
|
}
|
|
5233
6394
|
}
|
|
5234
6395
|
/**
|
|
5235
|
-
*
|
|
6396
|
+
* StoreCollisionSetupsApi - axios parameter creator
|
|
5236
6397
|
* @export
|
|
5237
6398
|
*/
|
|
5238
|
-
export const
|
|
6399
|
+
export const StoreCollisionSetupsApiAxiosParamCreator = function (configuration) {
|
|
5239
6400
|
return {
|
|
5240
6401
|
/**
|
|
5241
|
-
* Deletes the stored
|
|
5242
|
-
* @summary Delete
|
|
6402
|
+
* Deletes the stored collision setup. <!-- theme: danger --> > This will delete persistently stored data.
|
|
6403
|
+
* @summary Delete Collision Setup
|
|
5243
6404
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5244
|
-
* @param {string}
|
|
6405
|
+
* @param {string} setup Identifier of the collision setup
|
|
5245
6406
|
* @param {*} [options] Override http request option.
|
|
5246
6407
|
* @throws {RequiredError}
|
|
5247
6408
|
*/
|
|
5248
|
-
|
|
6409
|
+
deleteStoredCollisionSetup: async (cell, setup, options = {}) => {
|
|
5249
6410
|
// verify required parameter 'cell' is not null or undefined
|
|
5250
|
-
assertParamExists('
|
|
5251
|
-
// verify required parameter '
|
|
5252
|
-
assertParamExists('
|
|
5253
|
-
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}`
|
|
5254
6415
|
.replace(`{${"cell"}}`, encodeURIComponent(String(cell)))
|
|
5255
|
-
.replace(`{${"
|
|
6416
|
+
.replace(`{${"setup"}}`, encodeURIComponent(String(setup)));
|
|
5256
6417
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
5257
6418
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
5258
6419
|
let baseOptions;
|
|
@@ -5277,21 +6438,21 @@ export const StoreCollisionScenesApiAxiosParamCreator = function (configuration)
|
|
|
5277
6438
|
};
|
|
5278
6439
|
},
|
|
5279
6440
|
/**
|
|
5280
|
-
* Returns the stored
|
|
5281
|
-
* @summary Get
|
|
6441
|
+
* Returns the stored collision setup.
|
|
6442
|
+
* @summary Get Collision Setup
|
|
5282
6443
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5283
|
-
* @param {string}
|
|
6444
|
+
* @param {string} setup Identifier of the collision setup
|
|
5284
6445
|
* @param {*} [options] Override http request option.
|
|
5285
6446
|
* @throws {RequiredError}
|
|
5286
6447
|
*/
|
|
5287
|
-
|
|
6448
|
+
getStoredCollisionSetup: async (cell, setup, options = {}) => {
|
|
5288
6449
|
// verify required parameter 'cell' is not null or undefined
|
|
5289
|
-
assertParamExists('
|
|
5290
|
-
// verify required parameter '
|
|
5291
|
-
assertParamExists('
|
|
5292
|
-
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}`
|
|
5293
6454
|
.replace(`{${"cell"}}`, encodeURIComponent(String(cell)))
|
|
5294
|
-
.replace(`{${"
|
|
6455
|
+
.replace(`{${"setup"}}`, encodeURIComponent(String(setup)));
|
|
5295
6456
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
5296
6457
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
5297
6458
|
let baseOptions;
|
|
@@ -5316,16 +6477,16 @@ export const StoreCollisionScenesApiAxiosParamCreator = function (configuration)
|
|
|
5316
6477
|
};
|
|
5317
6478
|
},
|
|
5318
6479
|
/**
|
|
5319
|
-
* Returns a list of stored
|
|
5320
|
-
* @summary List
|
|
6480
|
+
* Returns a list of stored collision setups.
|
|
6481
|
+
* @summary List Collision Setups
|
|
5321
6482
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5322
6483
|
* @param {*} [options] Override http request option.
|
|
5323
6484
|
* @throws {RequiredError}
|
|
5324
6485
|
*/
|
|
5325
|
-
|
|
6486
|
+
listStoredCollisionSetups: async (cell, options = {}) => {
|
|
5326
6487
|
// verify required parameter 'cell' is not null or undefined
|
|
5327
|
-
assertParamExists('
|
|
5328
|
-
const localVarPath = `/cells/{cell}/store/collision/
|
|
6488
|
+
assertParamExists('listStoredCollisionSetups', 'cell', cell);
|
|
6489
|
+
const localVarPath = `/cells/{cell}/store/collision/setups`
|
|
5329
6490
|
.replace(`{${"cell"}}`, encodeURIComponent(String(cell)));
|
|
5330
6491
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
5331
6492
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
@@ -5351,24 +6512,24 @@ export const StoreCollisionScenesApiAxiosParamCreator = function (configuration)
|
|
|
5351
6512
|
};
|
|
5352
6513
|
},
|
|
5353
6514
|
/**
|
|
5354
|
-
*
|
|
5355
|
-
* @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
|
|
5356
6517
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5357
|
-
* @param {string}
|
|
5358
|
-
* @param {
|
|
6518
|
+
* @param {string} setup Identifier of the collision setup
|
|
6519
|
+
* @param {CollisionSetup} collisionSetup
|
|
5359
6520
|
* @param {*} [options] Override http request option.
|
|
5360
6521
|
* @throws {RequiredError}
|
|
5361
6522
|
*/
|
|
5362
|
-
|
|
6523
|
+
storeCollisionSetup: async (cell, setup, collisionSetup, options = {}) => {
|
|
5363
6524
|
// verify required parameter 'cell' is not null or undefined
|
|
5364
|
-
assertParamExists('
|
|
5365
|
-
// verify required parameter '
|
|
5366
|
-
assertParamExists('
|
|
5367
|
-
// verify required parameter '
|
|
5368
|
-
assertParamExists('
|
|
5369
|
-
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}`
|
|
5370
6531
|
.replace(`{${"cell"}}`, encodeURIComponent(String(cell)))
|
|
5371
|
-
.replace(`{${"
|
|
6532
|
+
.replace(`{${"setup"}}`, encodeURIComponent(String(setup)));
|
|
5372
6533
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
5373
6534
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
5374
6535
|
let baseOptions;
|
|
@@ -5388,7 +6549,7 @@ export const StoreCollisionScenesApiAxiosParamCreator = function (configuration)
|
|
|
5388
6549
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
5389
6550
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
5390
6551
|
localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
|
|
5391
|
-
localVarRequestOptions.data = serializeDataIfNeeded(
|
|
6552
|
+
localVarRequestOptions.data = serializeDataIfNeeded(collisionSetup, localVarRequestOptions, configuration);
|
|
5392
6553
|
return {
|
|
5393
6554
|
url: toPathString(localVarUrlObj),
|
|
5394
6555
|
options: localVarRequestOptions,
|
|
@@ -5397,177 +6558,177 @@ export const StoreCollisionScenesApiAxiosParamCreator = function (configuration)
|
|
|
5397
6558
|
};
|
|
5398
6559
|
};
|
|
5399
6560
|
/**
|
|
5400
|
-
*
|
|
6561
|
+
* StoreCollisionSetupsApi - functional programming interface
|
|
5401
6562
|
* @export
|
|
5402
6563
|
*/
|
|
5403
|
-
export const
|
|
5404
|
-
const localVarAxiosParamCreator =
|
|
6564
|
+
export const StoreCollisionSetupsApiFp = function (configuration) {
|
|
6565
|
+
const localVarAxiosParamCreator = StoreCollisionSetupsApiAxiosParamCreator(configuration);
|
|
5405
6566
|
return {
|
|
5406
6567
|
/**
|
|
5407
|
-
* Deletes the stored
|
|
5408
|
-
* @summary Delete
|
|
6568
|
+
* Deletes the stored collision setup. <!-- theme: danger --> > This will delete persistently stored data.
|
|
6569
|
+
* @summary Delete Collision Setup
|
|
5409
6570
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5410
|
-
* @param {string}
|
|
6571
|
+
* @param {string} setup Identifier of the collision setup
|
|
5411
6572
|
* @param {*} [options] Override http request option.
|
|
5412
6573
|
* @throws {RequiredError}
|
|
5413
6574
|
*/
|
|
5414
|
-
async
|
|
5415
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.
|
|
6575
|
+
async deleteStoredCollisionSetup(cell, setup, options) {
|
|
6576
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.deleteStoredCollisionSetup(cell, setup, options);
|
|
5416
6577
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
5417
|
-
const localVarOperationServerBasePath = operationServerMap['
|
|
6578
|
+
const localVarOperationServerBasePath = operationServerMap['StoreCollisionSetupsApi.deleteStoredCollisionSetup']?.[localVarOperationServerIndex]?.url;
|
|
5418
6579
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
5419
6580
|
},
|
|
5420
6581
|
/**
|
|
5421
|
-
* Returns the stored
|
|
5422
|
-
* @summary Get
|
|
6582
|
+
* Returns the stored collision setup.
|
|
6583
|
+
* @summary Get Collision Setup
|
|
5423
6584
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5424
|
-
* @param {string}
|
|
6585
|
+
* @param {string} setup Identifier of the collision setup
|
|
5425
6586
|
* @param {*} [options] Override http request option.
|
|
5426
6587
|
* @throws {RequiredError}
|
|
5427
6588
|
*/
|
|
5428
|
-
async
|
|
5429
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.
|
|
6589
|
+
async getStoredCollisionSetup(cell, setup, options) {
|
|
6590
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.getStoredCollisionSetup(cell, setup, options);
|
|
5430
6591
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
5431
|
-
const localVarOperationServerBasePath = operationServerMap['
|
|
6592
|
+
const localVarOperationServerBasePath = operationServerMap['StoreCollisionSetupsApi.getStoredCollisionSetup']?.[localVarOperationServerIndex]?.url;
|
|
5432
6593
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
5433
6594
|
},
|
|
5434
6595
|
/**
|
|
5435
|
-
* Returns a list of stored
|
|
5436
|
-
* @summary List
|
|
6596
|
+
* Returns a list of stored collision setups.
|
|
6597
|
+
* @summary List Collision Setups
|
|
5437
6598
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5438
6599
|
* @param {*} [options] Override http request option.
|
|
5439
6600
|
* @throws {RequiredError}
|
|
5440
6601
|
*/
|
|
5441
|
-
async
|
|
5442
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.
|
|
6602
|
+
async listStoredCollisionSetups(cell, options) {
|
|
6603
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.listStoredCollisionSetups(cell, options);
|
|
5443
6604
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
5444
|
-
const localVarOperationServerBasePath = operationServerMap['
|
|
6605
|
+
const localVarOperationServerBasePath = operationServerMap['StoreCollisionSetupsApi.listStoredCollisionSetups']?.[localVarOperationServerIndex]?.url;
|
|
5445
6606
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
5446
6607
|
},
|
|
5447
6608
|
/**
|
|
5448
|
-
*
|
|
5449
|
-
* @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
|
|
5450
6611
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5451
|
-
* @param {string}
|
|
5452
|
-
* @param {
|
|
6612
|
+
* @param {string} setup Identifier of the collision setup
|
|
6613
|
+
* @param {CollisionSetup} collisionSetup
|
|
5453
6614
|
* @param {*} [options] Override http request option.
|
|
5454
6615
|
* @throws {RequiredError}
|
|
5455
6616
|
*/
|
|
5456
|
-
async
|
|
5457
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.
|
|
6617
|
+
async storeCollisionSetup(cell, setup, collisionSetup, options) {
|
|
6618
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.storeCollisionSetup(cell, setup, collisionSetup, options);
|
|
5458
6619
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
5459
|
-
const localVarOperationServerBasePath = operationServerMap['
|
|
6620
|
+
const localVarOperationServerBasePath = operationServerMap['StoreCollisionSetupsApi.storeCollisionSetup']?.[localVarOperationServerIndex]?.url;
|
|
5460
6621
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
5461
6622
|
},
|
|
5462
6623
|
};
|
|
5463
6624
|
};
|
|
5464
6625
|
/**
|
|
5465
|
-
*
|
|
6626
|
+
* StoreCollisionSetupsApi - factory interface
|
|
5466
6627
|
* @export
|
|
5467
6628
|
*/
|
|
5468
|
-
export const
|
|
5469
|
-
const localVarFp =
|
|
6629
|
+
export const StoreCollisionSetupsApiFactory = function (configuration, basePath, axios) {
|
|
6630
|
+
const localVarFp = StoreCollisionSetupsApiFp(configuration);
|
|
5470
6631
|
return {
|
|
5471
6632
|
/**
|
|
5472
|
-
* Deletes the stored
|
|
5473
|
-
* @summary Delete
|
|
6633
|
+
* Deletes the stored collision setup. <!-- theme: danger --> > This will delete persistently stored data.
|
|
6634
|
+
* @summary Delete Collision Setup
|
|
5474
6635
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5475
|
-
* @param {string}
|
|
6636
|
+
* @param {string} setup Identifier of the collision setup
|
|
5476
6637
|
* @param {*} [options] Override http request option.
|
|
5477
6638
|
* @throws {RequiredError}
|
|
5478
6639
|
*/
|
|
5479
|
-
|
|
5480
|
-
return localVarFp.
|
|
6640
|
+
deleteStoredCollisionSetup(cell, setup, options) {
|
|
6641
|
+
return localVarFp.deleteStoredCollisionSetup(cell, setup, options).then((request) => request(axios, basePath));
|
|
5481
6642
|
},
|
|
5482
6643
|
/**
|
|
5483
|
-
* Returns the stored
|
|
5484
|
-
* @summary Get
|
|
6644
|
+
* Returns the stored collision setup.
|
|
6645
|
+
* @summary Get Collision Setup
|
|
5485
6646
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5486
|
-
* @param {string}
|
|
6647
|
+
* @param {string} setup Identifier of the collision setup
|
|
5487
6648
|
* @param {*} [options] Override http request option.
|
|
5488
6649
|
* @throws {RequiredError}
|
|
5489
6650
|
*/
|
|
5490
|
-
|
|
5491
|
-
return localVarFp.
|
|
6651
|
+
getStoredCollisionSetup(cell, setup, options) {
|
|
6652
|
+
return localVarFp.getStoredCollisionSetup(cell, setup, options).then((request) => request(axios, basePath));
|
|
5492
6653
|
},
|
|
5493
6654
|
/**
|
|
5494
|
-
* Returns a list of stored
|
|
5495
|
-
* @summary List
|
|
6655
|
+
* Returns a list of stored collision setups.
|
|
6656
|
+
* @summary List Collision Setups
|
|
5496
6657
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5497
6658
|
* @param {*} [options] Override http request option.
|
|
5498
6659
|
* @throws {RequiredError}
|
|
5499
6660
|
*/
|
|
5500
|
-
|
|
5501
|
-
return localVarFp.
|
|
6661
|
+
listStoredCollisionSetups(cell, options) {
|
|
6662
|
+
return localVarFp.listStoredCollisionSetups(cell, options).then((request) => request(axios, basePath));
|
|
5502
6663
|
},
|
|
5503
6664
|
/**
|
|
5504
|
-
*
|
|
5505
|
-
* @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
|
|
5506
6667
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5507
|
-
* @param {string}
|
|
5508
|
-
* @param {
|
|
6668
|
+
* @param {string} setup Identifier of the collision setup
|
|
6669
|
+
* @param {CollisionSetup} collisionSetup
|
|
5509
6670
|
* @param {*} [options] Override http request option.
|
|
5510
6671
|
* @throws {RequiredError}
|
|
5511
6672
|
*/
|
|
5512
|
-
|
|
5513
|
-
return localVarFp.
|
|
6673
|
+
storeCollisionSetup(cell, setup, collisionSetup, options) {
|
|
6674
|
+
return localVarFp.storeCollisionSetup(cell, setup, collisionSetup, options).then((request) => request(axios, basePath));
|
|
5514
6675
|
},
|
|
5515
6676
|
};
|
|
5516
6677
|
};
|
|
5517
6678
|
/**
|
|
5518
|
-
*
|
|
6679
|
+
* StoreCollisionSetupsApi - object-oriented interface
|
|
5519
6680
|
* @export
|
|
5520
|
-
* @class
|
|
6681
|
+
* @class StoreCollisionSetupsApi
|
|
5521
6682
|
* @extends {BaseAPI}
|
|
5522
6683
|
*/
|
|
5523
|
-
export class
|
|
6684
|
+
export class StoreCollisionSetupsApi extends BaseAPI {
|
|
5524
6685
|
/**
|
|
5525
|
-
* Deletes the stored
|
|
5526
|
-
* @summary Delete
|
|
6686
|
+
* Deletes the stored collision setup. <!-- theme: danger --> > This will delete persistently stored data.
|
|
6687
|
+
* @summary Delete Collision Setup
|
|
5527
6688
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5528
|
-
* @param {string}
|
|
6689
|
+
* @param {string} setup Identifier of the collision setup
|
|
5529
6690
|
* @param {*} [options] Override http request option.
|
|
5530
6691
|
* @throws {RequiredError}
|
|
5531
|
-
* @memberof
|
|
6692
|
+
* @memberof StoreCollisionSetupsApi
|
|
5532
6693
|
*/
|
|
5533
|
-
|
|
5534
|
-
return
|
|
6694
|
+
deleteStoredCollisionSetup(cell, setup, options) {
|
|
6695
|
+
return StoreCollisionSetupsApiFp(this.configuration).deleteStoredCollisionSetup(cell, setup, options).then((request) => request(this.axios, this.basePath));
|
|
5535
6696
|
}
|
|
5536
6697
|
/**
|
|
5537
|
-
* Returns the stored
|
|
5538
|
-
* @summary Get
|
|
6698
|
+
* Returns the stored collision setup.
|
|
6699
|
+
* @summary Get Collision Setup
|
|
5539
6700
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5540
|
-
* @param {string}
|
|
6701
|
+
* @param {string} setup Identifier of the collision setup
|
|
5541
6702
|
* @param {*} [options] Override http request option.
|
|
5542
6703
|
* @throws {RequiredError}
|
|
5543
|
-
* @memberof
|
|
6704
|
+
* @memberof StoreCollisionSetupsApi
|
|
5544
6705
|
*/
|
|
5545
|
-
|
|
5546
|
-
return
|
|
6706
|
+
getStoredCollisionSetup(cell, setup, options) {
|
|
6707
|
+
return StoreCollisionSetupsApiFp(this.configuration).getStoredCollisionSetup(cell, setup, options).then((request) => request(this.axios, this.basePath));
|
|
5547
6708
|
}
|
|
5548
6709
|
/**
|
|
5549
|
-
* Returns a list of stored
|
|
5550
|
-
* @summary List
|
|
6710
|
+
* Returns a list of stored collision setups.
|
|
6711
|
+
* @summary List Collision Setups
|
|
5551
6712
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5552
6713
|
* @param {*} [options] Override http request option.
|
|
5553
6714
|
* @throws {RequiredError}
|
|
5554
|
-
* @memberof
|
|
6715
|
+
* @memberof StoreCollisionSetupsApi
|
|
5555
6716
|
*/
|
|
5556
|
-
|
|
5557
|
-
return
|
|
6717
|
+
listStoredCollisionSetups(cell, options) {
|
|
6718
|
+
return StoreCollisionSetupsApiFp(this.configuration).listStoredCollisionSetups(cell, options).then((request) => request(this.axios, this.basePath));
|
|
5558
6719
|
}
|
|
5559
6720
|
/**
|
|
5560
|
-
*
|
|
5561
|
-
* @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
|
|
5562
6723
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5563
|
-
* @param {string}
|
|
5564
|
-
* @param {
|
|
6724
|
+
* @param {string} setup Identifier of the collision setup
|
|
6725
|
+
* @param {CollisionSetup} collisionSetup
|
|
5565
6726
|
* @param {*} [options] Override http request option.
|
|
5566
6727
|
* @throws {RequiredError}
|
|
5567
|
-
* @memberof
|
|
6728
|
+
* @memberof StoreCollisionSetupsApi
|
|
5568
6729
|
*/
|
|
5569
|
-
|
|
5570
|
-
return
|
|
6730
|
+
storeCollisionSetup(cell, setup, collisionSetup, options) {
|
|
6731
|
+
return StoreCollisionSetupsApiFp(this.configuration).storeCollisionSetup(cell, setup, collisionSetup, options).then((request) => request(this.axios, this.basePath));
|
|
5571
6732
|
}
|
|
5572
6733
|
}
|
|
5573
6734
|
/**
|
|
@@ -7276,6 +8437,44 @@ export class TrajectoryExecutionApi extends BaseAPI {
|
|
|
7276
8437
|
*/
|
|
7277
8438
|
export const TrajectoryPlanningApiAxiosParamCreator = function (configuration) {
|
|
7278
8439
|
return {
|
|
8440
|
+
/**
|
|
8441
|
+
* 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.
|
|
8442
|
+
* @summary Plan Collision-Free Trajectory
|
|
8443
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8444
|
+
* @param {PlanCollisionFreeRequest} [planCollisionFreeRequest]
|
|
8445
|
+
* @param {*} [options] Override http request option.
|
|
8446
|
+
* @throws {RequiredError}
|
|
8447
|
+
*/
|
|
8448
|
+
planCollisionFree: async (cell, planCollisionFreeRequest, options = {}) => {
|
|
8449
|
+
// verify required parameter 'cell' is not null or undefined
|
|
8450
|
+
assertParamExists('planCollisionFree', 'cell', cell);
|
|
8451
|
+
const localVarPath = `/cells/{cell}/trajectory-planning/plan-collision-free`
|
|
8452
|
+
.replace(`{${"cell"}}`, encodeURIComponent(String(cell)));
|
|
8453
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
8454
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
8455
|
+
let baseOptions;
|
|
8456
|
+
if (configuration) {
|
|
8457
|
+
baseOptions = configuration.baseOptions;
|
|
8458
|
+
}
|
|
8459
|
+
const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options };
|
|
8460
|
+
const localVarHeaderParameter = {};
|
|
8461
|
+
const localVarQueryParameter = {};
|
|
8462
|
+
// authentication BasicAuth required
|
|
8463
|
+
// http basic authentication required
|
|
8464
|
+
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
8465
|
+
// authentication BearerAuth required
|
|
8466
|
+
// http bearer authentication required
|
|
8467
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
8468
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
8469
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
8470
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
8471
|
+
localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
|
|
8472
|
+
localVarRequestOptions.data = serializeDataIfNeeded(planCollisionFreeRequest, localVarRequestOptions, configuration);
|
|
8473
|
+
return {
|
|
8474
|
+
url: toPathString(localVarUrlObj),
|
|
8475
|
+
options: localVarRequestOptions,
|
|
8476
|
+
};
|
|
8477
|
+
},
|
|
7279
8478
|
/**
|
|
7280
8479
|
* 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.
|
|
7281
8480
|
* @summary Plan Trajectory
|
|
@@ -7323,6 +8522,20 @@ export const TrajectoryPlanningApiAxiosParamCreator = function (configuration) {
|
|
|
7323
8522
|
export const TrajectoryPlanningApiFp = function (configuration) {
|
|
7324
8523
|
const localVarAxiosParamCreator = TrajectoryPlanningApiAxiosParamCreator(configuration);
|
|
7325
8524
|
return {
|
|
8525
|
+
/**
|
|
8526
|
+
* 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.
|
|
8527
|
+
* @summary Plan Collision-Free Trajectory
|
|
8528
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8529
|
+
* @param {PlanCollisionFreeRequest} [planCollisionFreeRequest]
|
|
8530
|
+
* @param {*} [options] Override http request option.
|
|
8531
|
+
* @throws {RequiredError}
|
|
8532
|
+
*/
|
|
8533
|
+
async planCollisionFree(cell, planCollisionFreeRequest, options) {
|
|
8534
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.planCollisionFree(cell, planCollisionFreeRequest, options);
|
|
8535
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
8536
|
+
const localVarOperationServerBasePath = operationServerMap['TrajectoryPlanningApi.planCollisionFree']?.[localVarOperationServerIndex]?.url;
|
|
8537
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
8538
|
+
},
|
|
7326
8539
|
/**
|
|
7327
8540
|
* 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.
|
|
7328
8541
|
* @summary Plan Trajectory
|
|
@@ -7346,6 +8559,17 @@ export const TrajectoryPlanningApiFp = function (configuration) {
|
|
|
7346
8559
|
export const TrajectoryPlanningApiFactory = function (configuration, basePath, axios) {
|
|
7347
8560
|
const localVarFp = TrajectoryPlanningApiFp(configuration);
|
|
7348
8561
|
return {
|
|
8562
|
+
/**
|
|
8563
|
+
* 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.
|
|
8564
|
+
* @summary Plan Collision-Free Trajectory
|
|
8565
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8566
|
+
* @param {PlanCollisionFreeRequest} [planCollisionFreeRequest]
|
|
8567
|
+
* @param {*} [options] Override http request option.
|
|
8568
|
+
* @throws {RequiredError}
|
|
8569
|
+
*/
|
|
8570
|
+
planCollisionFree(cell, planCollisionFreeRequest, options) {
|
|
8571
|
+
return localVarFp.planCollisionFree(cell, planCollisionFreeRequest, options).then((request) => request(axios, basePath));
|
|
8572
|
+
},
|
|
7349
8573
|
/**
|
|
7350
8574
|
* 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.
|
|
7351
8575
|
* @summary Plan Trajectory
|
|
@@ -7366,6 +8590,18 @@ export const TrajectoryPlanningApiFactory = function (configuration, basePath, a
|
|
|
7366
8590
|
* @extends {BaseAPI}
|
|
7367
8591
|
*/
|
|
7368
8592
|
export class TrajectoryPlanningApi extends BaseAPI {
|
|
8593
|
+
/**
|
|
8594
|
+
* 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.
|
|
8595
|
+
* @summary Plan Collision-Free Trajectory
|
|
8596
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8597
|
+
* @param {PlanCollisionFreeRequest} [planCollisionFreeRequest]
|
|
8598
|
+
* @param {*} [options] Override http request option.
|
|
8599
|
+
* @throws {RequiredError}
|
|
8600
|
+
* @memberof TrajectoryPlanningApi
|
|
8601
|
+
*/
|
|
8602
|
+
planCollisionFree(cell, planCollisionFreeRequest, options) {
|
|
8603
|
+
return TrajectoryPlanningApiFp(this.configuration).planCollisionFree(cell, planCollisionFreeRequest, options).then((request) => request(this.axios, this.basePath));
|
|
8604
|
+
}
|
|
7369
8605
|
/**
|
|
7370
8606
|
* 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.
|
|
7371
8607
|
* @summary Plan Trajectory
|
|
@@ -7395,15 +8631,15 @@ export const VirtualControllerApiAxiosParamCreator = function (configuration) {
|
|
|
7395
8631
|
* @param {*} [options] Override http request option.
|
|
7396
8632
|
* @throws {RequiredError}
|
|
7397
8633
|
*/
|
|
7398
|
-
|
|
8634
|
+
addVirtualControllerCoordinateSystem: async (cell, controller, coordinateSystem, coordinateSystemData, options = {}) => {
|
|
7399
8635
|
// verify required parameter 'cell' is not null or undefined
|
|
7400
|
-
assertParamExists('
|
|
8636
|
+
assertParamExists('addVirtualControllerCoordinateSystem', 'cell', cell);
|
|
7401
8637
|
// verify required parameter 'controller' is not null or undefined
|
|
7402
|
-
assertParamExists('
|
|
8638
|
+
assertParamExists('addVirtualControllerCoordinateSystem', 'controller', controller);
|
|
7403
8639
|
// verify required parameter 'coordinateSystem' is not null or undefined
|
|
7404
|
-
assertParamExists('
|
|
8640
|
+
assertParamExists('addVirtualControllerCoordinateSystem', 'coordinateSystem', coordinateSystem);
|
|
7405
8641
|
// verify required parameter 'coordinateSystemData' is not null or undefined
|
|
7406
|
-
assertParamExists('
|
|
8642
|
+
assertParamExists('addVirtualControllerCoordinateSystem', 'coordinateSystemData', coordinateSystemData);
|
|
7407
8643
|
const localVarPath = `/cells/{cell}/virtual-controllers/{controller}/coordinate-systems/{coordinate-system}`
|
|
7408
8644
|
.replace(`{${"cell"}}`, encodeURIComponent(String(cell)))
|
|
7409
8645
|
.replace(`{${"controller"}}`, encodeURIComponent(String(controller)))
|
|
@@ -7444,17 +8680,17 @@ export const VirtualControllerApiAxiosParamCreator = function (configuration) {
|
|
|
7444
8680
|
* @param {*} [options] Override http request option.
|
|
7445
8681
|
* @throws {RequiredError}
|
|
7446
8682
|
*/
|
|
7447
|
-
|
|
8683
|
+
addVirtualControllerTcp: async (cell, controller, motionGroup, tcp, robotTcpData, options = {}) => {
|
|
7448
8684
|
// verify required parameter 'cell' is not null or undefined
|
|
7449
|
-
assertParamExists('
|
|
8685
|
+
assertParamExists('addVirtualControllerTcp', 'cell', cell);
|
|
7450
8686
|
// verify required parameter 'controller' is not null or undefined
|
|
7451
|
-
assertParamExists('
|
|
8687
|
+
assertParamExists('addVirtualControllerTcp', 'controller', controller);
|
|
7452
8688
|
// verify required parameter 'motionGroup' is not null or undefined
|
|
7453
|
-
assertParamExists('
|
|
8689
|
+
assertParamExists('addVirtualControllerTcp', 'motionGroup', motionGroup);
|
|
7454
8690
|
// verify required parameter 'tcp' is not null or undefined
|
|
7455
|
-
assertParamExists('
|
|
8691
|
+
assertParamExists('addVirtualControllerTcp', 'tcp', tcp);
|
|
7456
8692
|
// verify required parameter 'robotTcpData' is not null or undefined
|
|
7457
|
-
assertParamExists('
|
|
8693
|
+
assertParamExists('addVirtualControllerTcp', 'robotTcpData', robotTcpData);
|
|
7458
8694
|
const localVarPath = `/cells/{cell}/virtual-controllers/{controller}/motion-groups/{motion-group}/tcps/{tcp}`
|
|
7459
8695
|
.replace(`{${"cell"}}`, encodeURIComponent(String(cell)))
|
|
7460
8696
|
.replace(`{${"controller"}}`, encodeURIComponent(String(controller)))
|
|
@@ -7495,13 +8731,13 @@ export const VirtualControllerApiAxiosParamCreator = function (configuration) {
|
|
|
7495
8731
|
* @param {*} [options] Override http request option.
|
|
7496
8732
|
* @throws {RequiredError}
|
|
7497
8733
|
*/
|
|
7498
|
-
|
|
8734
|
+
deleteVirtualControllerCoordinateSystem: async (cell, controller, coordinateSystem, deleteDependent, options = {}) => {
|
|
7499
8735
|
// verify required parameter 'cell' is not null or undefined
|
|
7500
|
-
assertParamExists('
|
|
8736
|
+
assertParamExists('deleteVirtualControllerCoordinateSystem', 'cell', cell);
|
|
7501
8737
|
// verify required parameter 'controller' is not null or undefined
|
|
7502
|
-
assertParamExists('
|
|
8738
|
+
assertParamExists('deleteVirtualControllerCoordinateSystem', 'controller', controller);
|
|
7503
8739
|
// verify required parameter 'coordinateSystem' is not null or undefined
|
|
7504
|
-
assertParamExists('
|
|
8740
|
+
assertParamExists('deleteVirtualControllerCoordinateSystem', 'coordinateSystem', coordinateSystem);
|
|
7505
8741
|
const localVarPath = `/cells/{cell}/virtual-controllers/{controller}/coordinate-systems/{coordinate-system}`
|
|
7506
8742
|
.replace(`{${"cell"}}`, encodeURIComponent(String(cell)))
|
|
7507
8743
|
.replace(`{${"controller"}}`, encodeURIComponent(String(controller)))
|
|
@@ -7542,15 +8778,15 @@ export const VirtualControllerApiAxiosParamCreator = function (configuration) {
|
|
|
7542
8778
|
* @param {*} [options] Override http request option.
|
|
7543
8779
|
* @throws {RequiredError}
|
|
7544
8780
|
*/
|
|
7545
|
-
|
|
8781
|
+
deleteVirtualControllerTcp: async (cell, controller, motionGroup, tcp, options = {}) => {
|
|
7546
8782
|
// verify required parameter 'cell' is not null or undefined
|
|
7547
|
-
assertParamExists('
|
|
8783
|
+
assertParamExists('deleteVirtualControllerTcp', 'cell', cell);
|
|
7548
8784
|
// verify required parameter 'controller' is not null or undefined
|
|
7549
|
-
assertParamExists('
|
|
8785
|
+
assertParamExists('deleteVirtualControllerTcp', 'controller', controller);
|
|
7550
8786
|
// verify required parameter 'motionGroup' is not null or undefined
|
|
7551
|
-
assertParamExists('
|
|
8787
|
+
assertParamExists('deleteVirtualControllerTcp', 'motionGroup', motionGroup);
|
|
7552
8788
|
// verify required parameter 'tcp' is not null or undefined
|
|
7553
|
-
assertParamExists('
|
|
8789
|
+
assertParamExists('deleteVirtualControllerTcp', 'tcp', tcp);
|
|
7554
8790
|
const localVarPath = `/cells/{cell}/virtual-controllers/{controller}/motion-groups/{motion-group}/tcps/{tcp}`
|
|
7555
8791
|
.replace(`{${"cell"}}`, encodeURIComponent(String(cell)))
|
|
7556
8792
|
.replace(`{${"controller"}}`, encodeURIComponent(String(controller)))
|
|
@@ -7748,13 +8984,13 @@ export const VirtualControllerApiAxiosParamCreator = function (configuration) {
|
|
|
7748
8984
|
* @param {*} [options] Override http request option.
|
|
7749
8985
|
* @throws {RequiredError}
|
|
7750
8986
|
*/
|
|
7751
|
-
|
|
8987
|
+
getVirtualControllerMounting: async (cell, controller, motionGroup, options = {}) => {
|
|
7752
8988
|
// verify required parameter 'cell' is not null or undefined
|
|
7753
|
-
assertParamExists('
|
|
8989
|
+
assertParamExists('getVirtualControllerMounting', 'cell', cell);
|
|
7754
8990
|
// verify required parameter 'controller' is not null or undefined
|
|
7755
|
-
assertParamExists('
|
|
8991
|
+
assertParamExists('getVirtualControllerMounting', 'controller', controller);
|
|
7756
8992
|
// verify required parameter 'motionGroup' is not null or undefined
|
|
7757
|
-
assertParamExists('
|
|
8993
|
+
assertParamExists('getVirtualControllerMounting', 'motionGroup', motionGroup);
|
|
7758
8994
|
const localVarPath = `/cells/{cell}/virtual-controllers/{controller}/motion-groups/{motion-group}/mounting`
|
|
7759
8995
|
.replace(`{${"cell"}}`, encodeURIComponent(String(cell)))
|
|
7760
8996
|
.replace(`{${"controller"}}`, encodeURIComponent(String(controller)))
|
|
@@ -7790,11 +9026,11 @@ export const VirtualControllerApiAxiosParamCreator = function (configuration) {
|
|
|
7790
9026
|
* @param {*} [options] Override http request option.
|
|
7791
9027
|
* @throws {RequiredError}
|
|
7792
9028
|
*/
|
|
7793
|
-
|
|
9029
|
+
listVirtualControllerCoordinateSystems: async (cell, controller, options = {}) => {
|
|
7794
9030
|
// verify required parameter 'cell' is not null or undefined
|
|
7795
|
-
assertParamExists('
|
|
9031
|
+
assertParamExists('listVirtualControllerCoordinateSystems', 'cell', cell);
|
|
7796
9032
|
// verify required parameter 'controller' is not null or undefined
|
|
7797
|
-
assertParamExists('
|
|
9033
|
+
assertParamExists('listVirtualControllerCoordinateSystems', 'controller', controller);
|
|
7798
9034
|
const localVarPath = `/cells/{cell}/virtual-controllers/{controller}/coordinate-systems`
|
|
7799
9035
|
.replace(`{${"cell"}}`, encodeURIComponent(String(cell)))
|
|
7800
9036
|
.replace(`{${"controller"}}`, encodeURIComponent(String(controller)));
|
|
@@ -7830,13 +9066,13 @@ export const VirtualControllerApiAxiosParamCreator = function (configuration) {
|
|
|
7830
9066
|
* @param {*} [options] Override http request option.
|
|
7831
9067
|
* @throws {RequiredError}
|
|
7832
9068
|
*/
|
|
7833
|
-
|
|
9069
|
+
listVirtualControllerTcps: async (cell, controller, motionGroup, options = {}) => {
|
|
7834
9070
|
// verify required parameter 'cell' is not null or undefined
|
|
7835
|
-
assertParamExists('
|
|
9071
|
+
assertParamExists('listVirtualControllerTcps', 'cell', cell);
|
|
7836
9072
|
// verify required parameter 'controller' is not null or undefined
|
|
7837
|
-
assertParamExists('
|
|
9073
|
+
assertParamExists('listVirtualControllerTcps', 'controller', controller);
|
|
7838
9074
|
// verify required parameter 'motionGroup' is not null or undefined
|
|
7839
|
-
assertParamExists('
|
|
9075
|
+
assertParamExists('listVirtualControllerTcps', 'motionGroup', motionGroup);
|
|
7840
9076
|
const localVarPath = `/cells/{cell}/virtual-controllers/{controller}/motion-groups/{motion-group}/tcps`
|
|
7841
9077
|
.replace(`{${"cell"}}`, encodeURIComponent(String(cell)))
|
|
7842
9078
|
.replace(`{${"controller"}}`, encodeURIComponent(String(controller)))
|
|
@@ -8010,15 +9246,15 @@ export const VirtualControllerApiAxiosParamCreator = function (configuration) {
|
|
|
8010
9246
|
* @param {*} [options] Override http request option.
|
|
8011
9247
|
* @throws {RequiredError}
|
|
8012
9248
|
*/
|
|
8013
|
-
|
|
9249
|
+
setVirtualControllerMounting: async (cell, controller, motionGroup, coordinateSystem, options = {}) => {
|
|
8014
9250
|
// verify required parameter 'cell' is not null or undefined
|
|
8015
|
-
assertParamExists('
|
|
9251
|
+
assertParamExists('setVirtualControllerMounting', 'cell', cell);
|
|
8016
9252
|
// verify required parameter 'controller' is not null or undefined
|
|
8017
|
-
assertParamExists('
|
|
9253
|
+
assertParamExists('setVirtualControllerMounting', 'controller', controller);
|
|
8018
9254
|
// verify required parameter 'motionGroup' is not null or undefined
|
|
8019
|
-
assertParamExists('
|
|
9255
|
+
assertParamExists('setVirtualControllerMounting', 'motionGroup', motionGroup);
|
|
8020
9256
|
// verify required parameter 'coordinateSystem' is not null or undefined
|
|
8021
|
-
assertParamExists('
|
|
9257
|
+
assertParamExists('setVirtualControllerMounting', 'coordinateSystem', coordinateSystem);
|
|
8022
9258
|
const localVarPath = `/cells/{cell}/virtual-controllers/{controller}/motion-groups/{motion-group}/mounting`
|
|
8023
9259
|
.replace(`{${"cell"}}`, encodeURIComponent(String(cell)))
|
|
8024
9260
|
.replace(`{${"controller"}}`, encodeURIComponent(String(controller)))
|
|
@@ -8067,10 +9303,10 @@ export const VirtualControllerApiFp = function (configuration) {
|
|
|
8067
9303
|
* @param {*} [options] Override http request option.
|
|
8068
9304
|
* @throws {RequiredError}
|
|
8069
9305
|
*/
|
|
8070
|
-
async
|
|
8071
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.
|
|
9306
|
+
async addVirtualControllerCoordinateSystem(cell, controller, coordinateSystem, coordinateSystemData, options) {
|
|
9307
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.addVirtualControllerCoordinateSystem(cell, controller, coordinateSystem, coordinateSystemData, options);
|
|
8072
9308
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
8073
|
-
const localVarOperationServerBasePath = operationServerMap['VirtualControllerApi.
|
|
9309
|
+
const localVarOperationServerBasePath = operationServerMap['VirtualControllerApi.addVirtualControllerCoordinateSystem']?.[localVarOperationServerIndex]?.url;
|
|
8074
9310
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
8075
9311
|
},
|
|
8076
9312
|
/**
|
|
@@ -8084,10 +9320,10 @@ export const VirtualControllerApiFp = function (configuration) {
|
|
|
8084
9320
|
* @param {*} [options] Override http request option.
|
|
8085
9321
|
* @throws {RequiredError}
|
|
8086
9322
|
*/
|
|
8087
|
-
async
|
|
8088
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.
|
|
9323
|
+
async addVirtualControllerTcp(cell, controller, motionGroup, tcp, robotTcpData, options) {
|
|
9324
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.addVirtualControllerTcp(cell, controller, motionGroup, tcp, robotTcpData, options);
|
|
8089
9325
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
8090
|
-
const localVarOperationServerBasePath = operationServerMap['VirtualControllerApi.
|
|
9326
|
+
const localVarOperationServerBasePath = operationServerMap['VirtualControllerApi.addVirtualControllerTcp']?.[localVarOperationServerIndex]?.url;
|
|
8091
9327
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
8092
9328
|
},
|
|
8093
9329
|
/**
|
|
@@ -8100,10 +9336,10 @@ export const VirtualControllerApiFp = function (configuration) {
|
|
|
8100
9336
|
* @param {*} [options] Override http request option.
|
|
8101
9337
|
* @throws {RequiredError}
|
|
8102
9338
|
*/
|
|
8103
|
-
async
|
|
8104
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.
|
|
9339
|
+
async deleteVirtualControllerCoordinateSystem(cell, controller, coordinateSystem, deleteDependent, options) {
|
|
9340
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.deleteVirtualControllerCoordinateSystem(cell, controller, coordinateSystem, deleteDependent, options);
|
|
8105
9341
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
8106
|
-
const localVarOperationServerBasePath = operationServerMap['VirtualControllerApi.
|
|
9342
|
+
const localVarOperationServerBasePath = operationServerMap['VirtualControllerApi.deleteVirtualControllerCoordinateSystem']?.[localVarOperationServerIndex]?.url;
|
|
8107
9343
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
8108
9344
|
},
|
|
8109
9345
|
/**
|
|
@@ -8116,10 +9352,10 @@ export const VirtualControllerApiFp = function (configuration) {
|
|
|
8116
9352
|
* @param {*} [options] Override http request option.
|
|
8117
9353
|
* @throws {RequiredError}
|
|
8118
9354
|
*/
|
|
8119
|
-
async
|
|
8120
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.
|
|
9355
|
+
async deleteVirtualControllerTcp(cell, controller, motionGroup, tcp, options) {
|
|
9356
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.deleteVirtualControllerTcp(cell, controller, motionGroup, tcp, options);
|
|
8121
9357
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
8122
|
-
const localVarOperationServerBasePath = operationServerMap['VirtualControllerApi.
|
|
9358
|
+
const localVarOperationServerBasePath = operationServerMap['VirtualControllerApi.deleteVirtualControllerTcp']?.[localVarOperationServerIndex]?.url;
|
|
8123
9359
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
8124
9360
|
},
|
|
8125
9361
|
/**
|
|
@@ -8188,10 +9424,10 @@ export const VirtualControllerApiFp = function (configuration) {
|
|
|
8188
9424
|
* @param {*} [options] Override http request option.
|
|
8189
9425
|
* @throws {RequiredError}
|
|
8190
9426
|
*/
|
|
8191
|
-
async
|
|
8192
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.
|
|
9427
|
+
async getVirtualControllerMounting(cell, controller, motionGroup, options) {
|
|
9428
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.getVirtualControllerMounting(cell, controller, motionGroup, options);
|
|
8193
9429
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
8194
|
-
const localVarOperationServerBasePath = operationServerMap['VirtualControllerApi.
|
|
9430
|
+
const localVarOperationServerBasePath = operationServerMap['VirtualControllerApi.getVirtualControllerMounting']?.[localVarOperationServerIndex]?.url;
|
|
8195
9431
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
8196
9432
|
},
|
|
8197
9433
|
/**
|
|
@@ -8202,10 +9438,10 @@ export const VirtualControllerApiFp = function (configuration) {
|
|
|
8202
9438
|
* @param {*} [options] Override http request option.
|
|
8203
9439
|
* @throws {RequiredError}
|
|
8204
9440
|
*/
|
|
8205
|
-
async
|
|
8206
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.
|
|
9441
|
+
async listVirtualControllerCoordinateSystems(cell, controller, options) {
|
|
9442
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.listVirtualControllerCoordinateSystems(cell, controller, options);
|
|
8207
9443
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
8208
|
-
const localVarOperationServerBasePath = operationServerMap['VirtualControllerApi.
|
|
9444
|
+
const localVarOperationServerBasePath = operationServerMap['VirtualControllerApi.listVirtualControllerCoordinateSystems']?.[localVarOperationServerIndex]?.url;
|
|
8209
9445
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
8210
9446
|
},
|
|
8211
9447
|
/**
|
|
@@ -8217,10 +9453,10 @@ export const VirtualControllerApiFp = function (configuration) {
|
|
|
8217
9453
|
* @param {*} [options] Override http request option.
|
|
8218
9454
|
* @throws {RequiredError}
|
|
8219
9455
|
*/
|
|
8220
|
-
async
|
|
8221
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.
|
|
9456
|
+
async listVirtualControllerTcps(cell, controller, motionGroup, options) {
|
|
9457
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.listVirtualControllerTcps(cell, controller, motionGroup, options);
|
|
8222
9458
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
8223
|
-
const localVarOperationServerBasePath = operationServerMap['VirtualControllerApi.
|
|
9459
|
+
const localVarOperationServerBasePath = operationServerMap['VirtualControllerApi.listVirtualControllerTcps']?.[localVarOperationServerIndex]?.url;
|
|
8224
9460
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
8225
9461
|
},
|
|
8226
9462
|
/**
|
|
@@ -8279,10 +9515,10 @@ export const VirtualControllerApiFp = function (configuration) {
|
|
|
8279
9515
|
* @param {*} [options] Override http request option.
|
|
8280
9516
|
* @throws {RequiredError}
|
|
8281
9517
|
*/
|
|
8282
|
-
async
|
|
8283
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.
|
|
9518
|
+
async setVirtualControllerMounting(cell, controller, motionGroup, coordinateSystem, options) {
|
|
9519
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.setVirtualControllerMounting(cell, controller, motionGroup, coordinateSystem, options);
|
|
8284
9520
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
8285
|
-
const localVarOperationServerBasePath = operationServerMap['VirtualControllerApi.
|
|
9521
|
+
const localVarOperationServerBasePath = operationServerMap['VirtualControllerApi.setVirtualControllerMounting']?.[localVarOperationServerIndex]?.url;
|
|
8286
9522
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
8287
9523
|
},
|
|
8288
9524
|
};
|
|
@@ -8304,8 +9540,8 @@ export const VirtualControllerApiFactory = function (configuration, basePath, ax
|
|
|
8304
9540
|
* @param {*} [options] Override http request option.
|
|
8305
9541
|
* @throws {RequiredError}
|
|
8306
9542
|
*/
|
|
8307
|
-
|
|
8308
|
-
return localVarFp.
|
|
9543
|
+
addVirtualControllerCoordinateSystem(cell, controller, coordinateSystem, coordinateSystemData, options) {
|
|
9544
|
+
return localVarFp.addVirtualControllerCoordinateSystem(cell, controller, coordinateSystem, coordinateSystemData, options).then((request) => request(axios, basePath));
|
|
8309
9545
|
},
|
|
8310
9546
|
/**
|
|
8311
9547
|
* Adds a new TCP or updates an existing TCP in the motion group. The position and rotation values in the request body are defined within the flange’s coordinate system. > **NOTE** > > Ensure the TCP\'s position is within the robot\'s reach. Refer to the robot’s documentation or data sheet for details like joint limits or reach.
|
|
@@ -8318,8 +9554,8 @@ export const VirtualControllerApiFactory = function (configuration, basePath, ax
|
|
|
8318
9554
|
* @param {*} [options] Override http request option.
|
|
8319
9555
|
* @throws {RequiredError}
|
|
8320
9556
|
*/
|
|
8321
|
-
|
|
8322
|
-
return localVarFp.
|
|
9557
|
+
addVirtualControllerTcp(cell, controller, motionGroup, tcp, robotTcpData, options) {
|
|
9558
|
+
return localVarFp.addVirtualControllerTcp(cell, controller, motionGroup, tcp, robotTcpData, options).then((request) => request(axios, basePath));
|
|
8323
9559
|
},
|
|
8324
9560
|
/**
|
|
8325
9561
|
* Deletes a coordinate system from the virtual controller. This will remove the coordinate system from the list of coordinate systems and remove all dependent coordinate systems which use the deleted coordinate system as reference.
|
|
@@ -8331,8 +9567,8 @@ export const VirtualControllerApiFactory = function (configuration, basePath, ax
|
|
|
8331
9567
|
* @param {*} [options] Override http request option.
|
|
8332
9568
|
* @throws {RequiredError}
|
|
8333
9569
|
*/
|
|
8334
|
-
|
|
8335
|
-
return localVarFp.
|
|
9570
|
+
deleteVirtualControllerCoordinateSystem(cell, controller, coordinateSystem, deleteDependent, options) {
|
|
9571
|
+
return localVarFp.deleteVirtualControllerCoordinateSystem(cell, controller, coordinateSystem, deleteDependent, options).then((request) => request(axios, basePath));
|
|
8336
9572
|
},
|
|
8337
9573
|
/**
|
|
8338
9574
|
* Removes the TCP from the motion group. An unknown TCP is a valid input.
|
|
@@ -8344,8 +9580,8 @@ export const VirtualControllerApiFactory = function (configuration, basePath, ax
|
|
|
8344
9580
|
* @param {*} [options] Override http request option.
|
|
8345
9581
|
* @throws {RequiredError}
|
|
8346
9582
|
*/
|
|
8347
|
-
|
|
8348
|
-
return localVarFp.
|
|
9583
|
+
deleteVirtualControllerTcp(cell, controller, motionGroup, tcp, options) {
|
|
9584
|
+
return localVarFp.deleteVirtualControllerTcp(cell, controller, motionGroup, tcp, options).then((request) => request(axios, basePath));
|
|
8349
9585
|
},
|
|
8350
9586
|
/**
|
|
8351
9587
|
* Requests the Emergency Stop state of the virtual robot controller. Use [getCurrentMotionGroupState](getCurrentMotionGroupState) to get the Emergency Stop state regardless of the controller type. There the Emergency Stop state is visible as the `safety_state`. > **NOTE** > > The Emergency Stop state can only be changed when using virtual robot controllers.
|
|
@@ -8401,8 +9637,8 @@ export const VirtualControllerApiFactory = function (configuration, basePath, ax
|
|
|
8401
9637
|
* @param {*} [options] Override http request option.
|
|
8402
9638
|
* @throws {RequiredError}
|
|
8403
9639
|
*/
|
|
8404
|
-
|
|
8405
|
-
return localVarFp.
|
|
9640
|
+
getVirtualControllerMounting(cell, controller, motionGroup, options) {
|
|
9641
|
+
return localVarFp.getVirtualControllerMounting(cell, controller, motionGroup, options).then((request) => request(axios, basePath));
|
|
8406
9642
|
},
|
|
8407
9643
|
/**
|
|
8408
9644
|
* Lists all coordinate systems on the robot controller.
|
|
@@ -8412,8 +9648,8 @@ export const VirtualControllerApiFactory = function (configuration, basePath, ax
|
|
|
8412
9648
|
* @param {*} [options] Override http request option.
|
|
8413
9649
|
* @throws {RequiredError}
|
|
8414
9650
|
*/
|
|
8415
|
-
|
|
8416
|
-
return localVarFp.
|
|
9651
|
+
listVirtualControllerCoordinateSystems(cell, controller, options) {
|
|
9652
|
+
return localVarFp.listVirtualControllerCoordinateSystems(cell, controller, options).then((request) => request(axios, basePath));
|
|
8417
9653
|
},
|
|
8418
9654
|
/**
|
|
8419
9655
|
* Lists TCPs of the motion group. An empty TCP list is valid, for example for external axes.
|
|
@@ -8424,8 +9660,8 @@ export const VirtualControllerApiFactory = function (configuration, basePath, ax
|
|
|
8424
9660
|
* @param {*} [options] Override http request option.
|
|
8425
9661
|
* @throws {RequiredError}
|
|
8426
9662
|
*/
|
|
8427
|
-
|
|
8428
|
-
return localVarFp.
|
|
9663
|
+
listVirtualControllerTcps(cell, controller, motionGroup, options) {
|
|
9664
|
+
return localVarFp.listVirtualControllerTcps(cell, controller, motionGroup, options).then((request) => request(axios, basePath));
|
|
8429
9665
|
},
|
|
8430
9666
|
/**
|
|
8431
9667
|
* Activates or releases the Emergency Stop on the virtual robot controller. Activating the Emergency Stop stops the execution of all motions. The stop is executed on physical controllers immediately not gracefully and not on paths. Due to restricted physical behavior of the virtual robot controller, the Emergency Stop is executed on paths. To return to normal operation the Emergency Stop needs to be released. Use [getCurrentMotionGroupState](getCurrentMotionGroupState) to get the Emergency Stop state regardless of the controller type. There the Emergency Stop state is visible as the `safety_state`. > **NOTE** > > The Emergency Stop state can only be changed via API when using virtual robot controllers.
|
|
@@ -8474,8 +9710,8 @@ export const VirtualControllerApiFactory = function (configuration, basePath, ax
|
|
|
8474
9710
|
* @param {*} [options] Override http request option.
|
|
8475
9711
|
* @throws {RequiredError}
|
|
8476
9712
|
*/
|
|
8477
|
-
|
|
8478
|
-
return localVarFp.
|
|
9713
|
+
setVirtualControllerMounting(cell, controller, motionGroup, coordinateSystem, options) {
|
|
9714
|
+
return localVarFp.setVirtualControllerMounting(cell, controller, motionGroup, coordinateSystem, options).then((request) => request(axios, basePath));
|
|
8479
9715
|
},
|
|
8480
9716
|
};
|
|
8481
9717
|
};
|
|
@@ -8497,8 +9733,8 @@ export class VirtualControllerApi extends BaseAPI {
|
|
|
8497
9733
|
* @throws {RequiredError}
|
|
8498
9734
|
* @memberof VirtualControllerApi
|
|
8499
9735
|
*/
|
|
8500
|
-
|
|
8501
|
-
return VirtualControllerApiFp(this.configuration).
|
|
9736
|
+
addVirtualControllerCoordinateSystem(cell, controller, coordinateSystem, coordinateSystemData, options) {
|
|
9737
|
+
return VirtualControllerApiFp(this.configuration).addVirtualControllerCoordinateSystem(cell, controller, coordinateSystem, coordinateSystemData, options).then((request) => request(this.axios, this.basePath));
|
|
8502
9738
|
}
|
|
8503
9739
|
/**
|
|
8504
9740
|
* Adds a new TCP or updates an existing TCP in the motion group. The position and rotation values in the request body are defined within the flange’s coordinate system. > **NOTE** > > Ensure the TCP\'s position is within the robot\'s reach. Refer to the robot’s documentation or data sheet for details like joint limits or reach.
|
|
@@ -8512,8 +9748,8 @@ export class VirtualControllerApi extends BaseAPI {
|
|
|
8512
9748
|
* @throws {RequiredError}
|
|
8513
9749
|
* @memberof VirtualControllerApi
|
|
8514
9750
|
*/
|
|
8515
|
-
|
|
8516
|
-
return VirtualControllerApiFp(this.configuration).
|
|
9751
|
+
addVirtualControllerTcp(cell, controller, motionGroup, tcp, robotTcpData, options) {
|
|
9752
|
+
return VirtualControllerApiFp(this.configuration).addVirtualControllerTcp(cell, controller, motionGroup, tcp, robotTcpData, options).then((request) => request(this.axios, this.basePath));
|
|
8517
9753
|
}
|
|
8518
9754
|
/**
|
|
8519
9755
|
* Deletes a coordinate system from the virtual controller. This will remove the coordinate system from the list of coordinate systems and remove all dependent coordinate systems which use the deleted coordinate system as reference.
|
|
@@ -8526,8 +9762,8 @@ export class VirtualControllerApi extends BaseAPI {
|
|
|
8526
9762
|
* @throws {RequiredError}
|
|
8527
9763
|
* @memberof VirtualControllerApi
|
|
8528
9764
|
*/
|
|
8529
|
-
|
|
8530
|
-
return VirtualControllerApiFp(this.configuration).
|
|
9765
|
+
deleteVirtualControllerCoordinateSystem(cell, controller, coordinateSystem, deleteDependent, options) {
|
|
9766
|
+
return VirtualControllerApiFp(this.configuration).deleteVirtualControllerCoordinateSystem(cell, controller, coordinateSystem, deleteDependent, options).then((request) => request(this.axios, this.basePath));
|
|
8531
9767
|
}
|
|
8532
9768
|
/**
|
|
8533
9769
|
* Removes the TCP from the motion group. An unknown TCP is a valid input.
|
|
@@ -8540,8 +9776,8 @@ export class VirtualControllerApi extends BaseAPI {
|
|
|
8540
9776
|
* @throws {RequiredError}
|
|
8541
9777
|
* @memberof VirtualControllerApi
|
|
8542
9778
|
*/
|
|
8543
|
-
|
|
8544
|
-
return VirtualControllerApiFp(this.configuration).
|
|
9779
|
+
deleteVirtualControllerTcp(cell, controller, motionGroup, tcp, options) {
|
|
9780
|
+
return VirtualControllerApiFp(this.configuration).deleteVirtualControllerTcp(cell, controller, motionGroup, tcp, options).then((request) => request(this.axios, this.basePath));
|
|
8545
9781
|
}
|
|
8546
9782
|
/**
|
|
8547
9783
|
* Requests the Emergency Stop state of the virtual robot controller. Use [getCurrentMotionGroupState](getCurrentMotionGroupState) to get the Emergency Stop state regardless of the controller type. There the Emergency Stop state is visible as the `safety_state`. > **NOTE** > > The Emergency Stop state can only be changed when using virtual robot controllers.
|
|
@@ -8602,8 +9838,8 @@ export class VirtualControllerApi extends BaseAPI {
|
|
|
8602
9838
|
* @throws {RequiredError}
|
|
8603
9839
|
* @memberof VirtualControllerApi
|
|
8604
9840
|
*/
|
|
8605
|
-
|
|
8606
|
-
return VirtualControllerApiFp(this.configuration).
|
|
9841
|
+
getVirtualControllerMounting(cell, controller, motionGroup, options) {
|
|
9842
|
+
return VirtualControllerApiFp(this.configuration).getVirtualControllerMounting(cell, controller, motionGroup, options).then((request) => request(this.axios, this.basePath));
|
|
8607
9843
|
}
|
|
8608
9844
|
/**
|
|
8609
9845
|
* Lists all coordinate systems on the robot controller.
|
|
@@ -8614,8 +9850,8 @@ export class VirtualControllerApi extends BaseAPI {
|
|
|
8614
9850
|
* @throws {RequiredError}
|
|
8615
9851
|
* @memberof VirtualControllerApi
|
|
8616
9852
|
*/
|
|
8617
|
-
|
|
8618
|
-
return VirtualControllerApiFp(this.configuration).
|
|
9853
|
+
listVirtualControllerCoordinateSystems(cell, controller, options) {
|
|
9854
|
+
return VirtualControllerApiFp(this.configuration).listVirtualControllerCoordinateSystems(cell, controller, options).then((request) => request(this.axios, this.basePath));
|
|
8619
9855
|
}
|
|
8620
9856
|
/**
|
|
8621
9857
|
* Lists TCPs of the motion group. An empty TCP list is valid, for example for external axes.
|
|
@@ -8627,8 +9863,8 @@ export class VirtualControllerApi extends BaseAPI {
|
|
|
8627
9863
|
* @throws {RequiredError}
|
|
8628
9864
|
* @memberof VirtualControllerApi
|
|
8629
9865
|
*/
|
|
8630
|
-
|
|
8631
|
-
return VirtualControllerApiFp(this.configuration).
|
|
9866
|
+
listVirtualControllerTcps(cell, controller, motionGroup, options) {
|
|
9867
|
+
return VirtualControllerApiFp(this.configuration).listVirtualControllerTcps(cell, controller, motionGroup, options).then((request) => request(this.axios, this.basePath));
|
|
8632
9868
|
}
|
|
8633
9869
|
/**
|
|
8634
9870
|
* Activates or releases the Emergency Stop on the virtual robot controller. Activating the Emergency Stop stops the execution of all motions. The stop is executed on physical controllers immediately not gracefully and not on paths. Due to restricted physical behavior of the virtual robot controller, the Emergency Stop is executed on paths. To return to normal operation the Emergency Stop needs to be released. Use [getCurrentMotionGroupState](getCurrentMotionGroupState) to get the Emergency Stop state regardless of the controller type. There the Emergency Stop state is visible as the `safety_state`. > **NOTE** > > The Emergency Stop state can only be changed via API when using virtual robot controllers.
|
|
@@ -8681,8 +9917,8 @@ export class VirtualControllerApi extends BaseAPI {
|
|
|
8681
9917
|
* @throws {RequiredError}
|
|
8682
9918
|
* @memberof VirtualControllerApi
|
|
8683
9919
|
*/
|
|
8684
|
-
|
|
8685
|
-
return VirtualControllerApiFp(this.configuration).
|
|
9920
|
+
setVirtualControllerMounting(cell, controller, motionGroup, coordinateSystem, options) {
|
|
9921
|
+
return VirtualControllerApiFp(this.configuration).setVirtualControllerMounting(cell, controller, motionGroup, coordinateSystem, options).then((request) => request(this.axios, this.basePath));
|
|
8686
9922
|
}
|
|
8687
9923
|
}
|
|
8688
9924
|
/**
|
|
@@ -8775,18 +10011,18 @@ export const VirtualControllerBehaviorApiAxiosParamCreator = function (configura
|
|
|
8775
10011
|
};
|
|
8776
10012
|
},
|
|
8777
10013
|
/**
|
|
8778
|
-
* Get the current virtual controller behavior - please see the setter [
|
|
10014
|
+
* Get the current virtual controller behavior - please see the setter [setVirtualControllerBehavior](setVirtualControllerBehavior) and the enum for details.
|
|
8779
10015
|
* @summary Get Behavior
|
|
8780
10016
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8781
10017
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
8782
10018
|
* @param {*} [options] Override http request option.
|
|
8783
10019
|
* @throws {RequiredError}
|
|
8784
10020
|
*/
|
|
8785
|
-
|
|
10021
|
+
getVirtualControllerBehavior: async (cell, controller, options = {}) => {
|
|
8786
10022
|
// verify required parameter 'cell' is not null or undefined
|
|
8787
|
-
assertParamExists('
|
|
10023
|
+
assertParamExists('getVirtualControllerBehavior', 'cell', cell);
|
|
8788
10024
|
// verify required parameter 'controller' is not null or undefined
|
|
8789
|
-
assertParamExists('
|
|
10025
|
+
assertParamExists('getVirtualControllerBehavior', 'controller', controller);
|
|
8790
10026
|
const localVarPath = `/cells/{cell}/virtual-controllers/{controller}/behavior`
|
|
8791
10027
|
.replace(`{${"cell"}}`, encodeURIComponent(String(cell)))
|
|
8792
10028
|
.replace(`{${"controller"}}`, encodeURIComponent(String(controller)));
|
|
@@ -8822,11 +10058,11 @@ export const VirtualControllerBehaviorApiAxiosParamCreator = function (configura
|
|
|
8822
10058
|
* @param {*} [options] Override http request option.
|
|
8823
10059
|
* @throws {RequiredError}
|
|
8824
10060
|
*/
|
|
8825
|
-
|
|
10061
|
+
setVirtualControllerBehavior: async (cell, controller, behavior, options = {}) => {
|
|
8826
10062
|
// verify required parameter 'cell' is not null or undefined
|
|
8827
|
-
assertParamExists('
|
|
10063
|
+
assertParamExists('setVirtualControllerBehavior', 'cell', cell);
|
|
8828
10064
|
// verify required parameter 'controller' is not null or undefined
|
|
8829
|
-
assertParamExists('
|
|
10065
|
+
assertParamExists('setVirtualControllerBehavior', 'controller', controller);
|
|
8830
10066
|
const localVarPath = `/cells/{cell}/virtual-controllers/{controller}/behavior`
|
|
8831
10067
|
.replace(`{${"cell"}}`, encodeURIComponent(String(cell)))
|
|
8832
10068
|
.replace(`{${"controller"}}`, encodeURIComponent(String(controller)));
|
|
@@ -8895,17 +10131,17 @@ export const VirtualControllerBehaviorApiFp = function (configuration) {
|
|
|
8895
10131
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
8896
10132
|
},
|
|
8897
10133
|
/**
|
|
8898
|
-
* Get the current virtual controller behavior - please see the setter [
|
|
10134
|
+
* Get the current virtual controller behavior - please see the setter [setVirtualControllerBehavior](setVirtualControllerBehavior) and the enum for details.
|
|
8899
10135
|
* @summary Get Behavior
|
|
8900
10136
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8901
10137
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
8902
10138
|
* @param {*} [options] Override http request option.
|
|
8903
10139
|
* @throws {RequiredError}
|
|
8904
10140
|
*/
|
|
8905
|
-
async
|
|
8906
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.
|
|
10141
|
+
async getVirtualControllerBehavior(cell, controller, options) {
|
|
10142
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.getVirtualControllerBehavior(cell, controller, options);
|
|
8907
10143
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
8908
|
-
const localVarOperationServerBasePath = operationServerMap['VirtualControllerBehaviorApi.
|
|
10144
|
+
const localVarOperationServerBasePath = operationServerMap['VirtualControllerBehaviorApi.getVirtualControllerBehavior']?.[localVarOperationServerIndex]?.url;
|
|
8909
10145
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
8910
10146
|
},
|
|
8911
10147
|
/**
|
|
@@ -8917,10 +10153,10 @@ export const VirtualControllerBehaviorApiFp = function (configuration) {
|
|
|
8917
10153
|
* @param {*} [options] Override http request option.
|
|
8918
10154
|
* @throws {RequiredError}
|
|
8919
10155
|
*/
|
|
8920
|
-
async
|
|
8921
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.
|
|
10156
|
+
async setVirtualControllerBehavior(cell, controller, behavior, options) {
|
|
10157
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.setVirtualControllerBehavior(cell, controller, behavior, options);
|
|
8922
10158
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
8923
|
-
const localVarOperationServerBasePath = operationServerMap['VirtualControllerBehaviorApi.
|
|
10159
|
+
const localVarOperationServerBasePath = operationServerMap['VirtualControllerBehaviorApi.setVirtualControllerBehavior']?.[localVarOperationServerIndex]?.url;
|
|
8924
10160
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
8925
10161
|
},
|
|
8926
10162
|
};
|
|
@@ -8956,15 +10192,15 @@ export const VirtualControllerBehaviorApiFactory = function (configuration, base
|
|
|
8956
10192
|
return localVarFp.getCycleTime(cell, controller, options).then((request) => request(axios, basePath));
|
|
8957
10193
|
},
|
|
8958
10194
|
/**
|
|
8959
|
-
* Get the current virtual controller behavior - please see the setter [
|
|
10195
|
+
* Get the current virtual controller behavior - please see the setter [setVirtualControllerBehavior](setVirtualControllerBehavior) and the enum for details.
|
|
8960
10196
|
* @summary Get Behavior
|
|
8961
10197
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8962
10198
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
8963
10199
|
* @param {*} [options] Override http request option.
|
|
8964
10200
|
* @throws {RequiredError}
|
|
8965
10201
|
*/
|
|
8966
|
-
|
|
8967
|
-
return localVarFp.
|
|
10202
|
+
getVirtualControllerBehavior(cell, controller, options) {
|
|
10203
|
+
return localVarFp.getVirtualControllerBehavior(cell, controller, options).then((request) => request(axios, basePath));
|
|
8968
10204
|
},
|
|
8969
10205
|
/**
|
|
8970
10206
|
* Set virtual controller behavior.
|
|
@@ -8975,8 +10211,8 @@ export const VirtualControllerBehaviorApiFactory = function (configuration, base
|
|
|
8975
10211
|
* @param {*} [options] Override http request option.
|
|
8976
10212
|
* @throws {RequiredError}
|
|
8977
10213
|
*/
|
|
8978
|
-
|
|
8979
|
-
return localVarFp.
|
|
10214
|
+
setVirtualControllerBehavior(cell, controller, behavior, options) {
|
|
10215
|
+
return localVarFp.setVirtualControllerBehavior(cell, controller, behavior, options).then((request) => request(axios, basePath));
|
|
8980
10216
|
},
|
|
8981
10217
|
};
|
|
8982
10218
|
};
|
|
@@ -9013,7 +10249,7 @@ export class VirtualControllerBehaviorApi extends BaseAPI {
|
|
|
9013
10249
|
return VirtualControllerBehaviorApiFp(this.configuration).getCycleTime(cell, controller, options).then((request) => request(this.axios, this.basePath));
|
|
9014
10250
|
}
|
|
9015
10251
|
/**
|
|
9016
|
-
* Get the current virtual controller behavior - please see the setter [
|
|
10252
|
+
* Get the current virtual controller behavior - please see the setter [setVirtualControllerBehavior](setVirtualControllerBehavior) and the enum for details.
|
|
9017
10253
|
* @summary Get Behavior
|
|
9018
10254
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
9019
10255
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -9021,8 +10257,8 @@ export class VirtualControllerBehaviorApi extends BaseAPI {
|
|
|
9021
10257
|
* @throws {RequiredError}
|
|
9022
10258
|
* @memberof VirtualControllerBehaviorApi
|
|
9023
10259
|
*/
|
|
9024
|
-
|
|
9025
|
-
return VirtualControllerBehaviorApiFp(this.configuration).
|
|
10260
|
+
getVirtualControllerBehavior(cell, controller, options) {
|
|
10261
|
+
return VirtualControllerBehaviorApiFp(this.configuration).getVirtualControllerBehavior(cell, controller, options).then((request) => request(this.axios, this.basePath));
|
|
9026
10262
|
}
|
|
9027
10263
|
/**
|
|
9028
10264
|
* Set virtual controller behavior.
|
|
@@ -9034,8 +10270,8 @@ export class VirtualControllerBehaviorApi extends BaseAPI {
|
|
|
9034
10270
|
* @throws {RequiredError}
|
|
9035
10271
|
* @memberof VirtualControllerBehaviorApi
|
|
9036
10272
|
*/
|
|
9037
|
-
|
|
9038
|
-
return VirtualControllerBehaviorApiFp(this.configuration).
|
|
10273
|
+
setVirtualControllerBehavior(cell, controller, behavior, options) {
|
|
10274
|
+
return VirtualControllerBehaviorApiFp(this.configuration).setVirtualControllerBehavior(cell, controller, behavior, options).then((request) => request(this.axios, this.basePath));
|
|
9039
10275
|
}
|
|
9040
10276
|
}
|
|
9041
10277
|
/**
|
|
@@ -9045,7 +10281,7 @@ export class VirtualControllerBehaviorApi extends BaseAPI {
|
|
|
9045
10281
|
export const VirtualControllerInputsOutputsApiAxiosParamCreator = function (configuration) {
|
|
9046
10282
|
return {
|
|
9047
10283
|
/**
|
|
9048
|
-
* Retrieves the current values of inputs/outputs of the virtual controller. The identifiers of inputs/outputs must be provided in the request. Request all available input/output identifiers via [
|
|
10284
|
+
* Retrieves the current values of inputs/outputs of the virtual controller. The identifiers of inputs/outputs must be provided in the request. Request all available input/output identifiers via [listVirtualControllerIODescriptions](listVirtualControllerIODescriptions).
|
|
9049
10285
|
* @summary Get Input/Output Values
|
|
9050
10286
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
9051
10287
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -9101,11 +10337,11 @@ export const VirtualControllerInputsOutputsApiAxiosParamCreator = function (conf
|
|
|
9101
10337
|
* @param {*} [options] Override http request option.
|
|
9102
10338
|
* @throws {RequiredError}
|
|
9103
10339
|
*/
|
|
9104
|
-
|
|
10340
|
+
listVirtualControllerIODescriptions: async (cell, controller, ios, direction, valueType, group, options = {}) => {
|
|
9105
10341
|
// verify required parameter 'cell' is not null or undefined
|
|
9106
|
-
assertParamExists('
|
|
10342
|
+
assertParamExists('listVirtualControllerIODescriptions', 'cell', cell);
|
|
9107
10343
|
// verify required parameter 'controller' is not null or undefined
|
|
9108
|
-
assertParamExists('
|
|
10344
|
+
assertParamExists('listVirtualControllerIODescriptions', 'controller', controller);
|
|
9109
10345
|
const localVarPath = `/cells/{cell}/virtual-controllers/{controller}/ios/description`
|
|
9110
10346
|
.replace(`{${"cell"}}`, encodeURIComponent(String(cell)))
|
|
9111
10347
|
.replace(`{${"controller"}}`, encodeURIComponent(String(controller)));
|
|
@@ -9198,7 +10434,7 @@ export const VirtualControllerInputsOutputsApiFp = function (configuration) {
|
|
|
9198
10434
|
const localVarAxiosParamCreator = VirtualControllerInputsOutputsApiAxiosParamCreator(configuration);
|
|
9199
10435
|
return {
|
|
9200
10436
|
/**
|
|
9201
|
-
* Retrieves the current values of inputs/outputs of the virtual controller. The identifiers of inputs/outputs must be provided in the request. Request all available input/output identifiers via [
|
|
10437
|
+
* Retrieves the current values of inputs/outputs of the virtual controller. The identifiers of inputs/outputs must be provided in the request. Request all available input/output identifiers via [listVirtualControllerIODescriptions](listVirtualControllerIODescriptions).
|
|
9202
10438
|
* @summary Get Input/Output Values
|
|
9203
10439
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
9204
10440
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -9224,10 +10460,10 @@ export const VirtualControllerInputsOutputsApiFp = function (configuration) {
|
|
|
9224
10460
|
* @param {*} [options] Override http request option.
|
|
9225
10461
|
* @throws {RequiredError}
|
|
9226
10462
|
*/
|
|
9227
|
-
async
|
|
9228
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.
|
|
10463
|
+
async listVirtualControllerIODescriptions(cell, controller, ios, direction, valueType, group, options) {
|
|
10464
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.listVirtualControllerIODescriptions(cell, controller, ios, direction, valueType, group, options);
|
|
9229
10465
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
9230
|
-
const localVarOperationServerBasePath = operationServerMap['VirtualControllerInputsOutputsApi.
|
|
10466
|
+
const localVarOperationServerBasePath = operationServerMap['VirtualControllerInputsOutputsApi.listVirtualControllerIODescriptions']?.[localVarOperationServerIndex]?.url;
|
|
9231
10467
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
9232
10468
|
},
|
|
9233
10469
|
/**
|
|
@@ -9255,7 +10491,7 @@ export const VirtualControllerInputsOutputsApiFactory = function (configuration,
|
|
|
9255
10491
|
const localVarFp = VirtualControllerInputsOutputsApiFp(configuration);
|
|
9256
10492
|
return {
|
|
9257
10493
|
/**
|
|
9258
|
-
* Retrieves the current values of inputs/outputs of the virtual controller. The identifiers of inputs/outputs must be provided in the request. Request all available input/output identifiers via [
|
|
10494
|
+
* Retrieves the current values of inputs/outputs of the virtual controller. The identifiers of inputs/outputs must be provided in the request. Request all available input/output identifiers via [listVirtualControllerIODescriptions](listVirtualControllerIODescriptions).
|
|
9259
10495
|
* @summary Get Input/Output Values
|
|
9260
10496
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
9261
10497
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -9278,8 +10514,8 @@ export const VirtualControllerInputsOutputsApiFactory = function (configuration,
|
|
|
9278
10514
|
* @param {*} [options] Override http request option.
|
|
9279
10515
|
* @throws {RequiredError}
|
|
9280
10516
|
*/
|
|
9281
|
-
|
|
9282
|
-
return localVarFp.
|
|
10517
|
+
listVirtualControllerIODescriptions(cell, controller, ios, direction, valueType, group, options) {
|
|
10518
|
+
return localVarFp.listVirtualControllerIODescriptions(cell, controller, ios, direction, valueType, group, options).then((request) => request(axios, basePath));
|
|
9283
10519
|
},
|
|
9284
10520
|
/**
|
|
9285
10521
|
* Sets a list of values of a virtual controller inputs/outputs.
|
|
@@ -9303,7 +10539,7 @@ export const VirtualControllerInputsOutputsApiFactory = function (configuration,
|
|
|
9303
10539
|
*/
|
|
9304
10540
|
export class VirtualControllerInputsOutputsApi extends BaseAPI {
|
|
9305
10541
|
/**
|
|
9306
|
-
* Retrieves the current values of inputs/outputs of the virtual controller. The identifiers of inputs/outputs must be provided in the request. Request all available input/output identifiers via [
|
|
10542
|
+
* Retrieves the current values of inputs/outputs of the virtual controller. The identifiers of inputs/outputs must be provided in the request. Request all available input/output identifiers via [listVirtualControllerIODescriptions](listVirtualControllerIODescriptions).
|
|
9307
10543
|
* @summary Get Input/Output Values
|
|
9308
10544
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
9309
10545
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -9328,8 +10564,8 @@ export class VirtualControllerInputsOutputsApi extends BaseAPI {
|
|
|
9328
10564
|
* @throws {RequiredError}
|
|
9329
10565
|
* @memberof VirtualControllerInputsOutputsApi
|
|
9330
10566
|
*/
|
|
9331
|
-
|
|
9332
|
-
return VirtualControllerInputsOutputsApiFp(this.configuration).
|
|
10567
|
+
listVirtualControllerIODescriptions(cell, controller, ios, direction, valueType, group, options) {
|
|
10568
|
+
return VirtualControllerInputsOutputsApiFp(this.configuration).listVirtualControllerIODescriptions(cell, controller, ios, direction, valueType, group, options).then((request) => request(this.axios, this.basePath));
|
|
9333
10569
|
}
|
|
9334
10570
|
/**
|
|
9335
10571
|
* Sets a list of values of a virtual controller inputs/outputs.
|