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

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (5) hide show
  1. package/package.json +1 -1
  2. package/v2/api.d.ts +1777 -482
  3. package/v2/api.js +1436 -212
  4. package/v2/api.js.map +1 -1
  5. package/v2/api.ts +2452 -393
package/v2/api.ts CHANGED
@@ -366,6 +366,182 @@ export const BoxBoxTypeEnum = {
366
366
 
367
367
  export type BoxBoxTypeEnum = typeof BoxBoxTypeEnum[keyof typeof BoxBoxTypeEnum];
368
368
 
369
+ /**
370
+ * PROFINET BUS Inputs/Outputs Service configuration.
371
+ * @export
372
+ * @interface BusIOProfinet
373
+ */
374
+ export interface BusIOProfinet {
375
+ /**
376
+ *
377
+ * @type {string}
378
+ * @memberof BusIOProfinet
379
+ */
380
+ 'bus_type'?: BusIOProfinetBusTypeEnum;
381
+ /**
382
+ * Path to the configuration file.
383
+ * @type {string}
384
+ * @memberof BusIOProfinet
385
+ */
386
+ 'config_file_content'?: string;
387
+ /**
388
+ *
389
+ * @type {BusIOProfinetNetwork}
390
+ * @memberof BusIOProfinet
391
+ */
392
+ 'network_config'?: BusIOProfinetNetwork;
393
+ /**
394
+ * MAC address for the PROFINET port, should be get from another NOVA API endpoind?
395
+ * @type {string}
396
+ * @memberof BusIOProfinet
397
+ */
398
+ 'mac': string;
399
+ /**
400
+ *
401
+ * @type {BusIOProfinetDefaultRoute}
402
+ * @memberof BusIOProfinet
403
+ */
404
+ 'default_route': BusIOProfinetDefaultRoute;
405
+ }
406
+
407
+ export const BusIOProfinetBusTypeEnum = {
408
+ Profinet: 'profinet'
409
+ } as const;
410
+
411
+ export type BusIOProfinetBusTypeEnum = typeof BusIOProfinetBusTypeEnum[keyof typeof BusIOProfinetBusTypeEnum];
412
+
413
+ /**
414
+ * Default route configuration for the PROFINET service. Will be removed before release by automatic default route configuration, if possible.
415
+ * @export
416
+ * @interface BusIOProfinetDefaultRoute
417
+ */
418
+ export interface BusIOProfinetDefaultRoute {
419
+ /**
420
+ * Gateway for the default route.
421
+ * @type {string}
422
+ * @memberof BusIOProfinetDefaultRoute
423
+ */
424
+ 'gateway': string;
425
+ /**
426
+ * Interface for the default route.
427
+ * @type {string}
428
+ * @memberof BusIOProfinetDefaultRoute
429
+ */
430
+ 'interface': string;
431
+ }
432
+ /**
433
+ * Network configuration for the PROFINET device
434
+ * @export
435
+ * @interface BusIOProfinetIpConfig
436
+ */
437
+ export interface BusIOProfinetIpConfig {
438
+ /**
439
+ * IP address for the PROFINET device
440
+ * @type {string}
441
+ * @memberof BusIOProfinetIpConfig
442
+ */
443
+ 'ip': string;
444
+ /**
445
+ * Network mask for the PROFINET device.
446
+ * @type {string}
447
+ * @memberof BusIOProfinetIpConfig
448
+ */
449
+ 'netmask': string;
450
+ /**
451
+ * Gateway for the PROFINET device
452
+ * @type {string}
453
+ * @memberof BusIOProfinetIpConfig
454
+ */
455
+ 'gateway': string;
456
+ }
457
+ /**
458
+ *
459
+ * @export
460
+ * @interface BusIOProfinetNetwork
461
+ */
462
+ export interface BusIOProfinetNetwork {
463
+ /**
464
+ * Name of the PROFINET device.
465
+ * @type {string}
466
+ * @memberof BusIOProfinetNetwork
467
+ */
468
+ 'device_name'?: string;
469
+ /**
470
+ *
471
+ * @type {BusIOProfinetIpConfig}
472
+ * @memberof BusIOProfinetNetwork
473
+ */
474
+ 'ip_config'?: BusIOProfinetIpConfig;
475
+ /**
476
+ * Content of the PROFINET REMA XML file.
477
+ * @type {string}
478
+ * @memberof BusIOProfinetNetwork
479
+ */
480
+ 'rema_xml_content'?: string;
481
+ }
482
+ /**
483
+ * Virtual PROFINET BUS Inputs/Outputs Service configuration.
484
+ * @export
485
+ * @interface BusIOProfinetVirtual
486
+ */
487
+ export interface BusIOProfinetVirtual {
488
+ /**
489
+ *
490
+ * @type {string}
491
+ * @memberof BusIOProfinetVirtual
492
+ */
493
+ 'bus_type'?: BusIOProfinetVirtualBusTypeEnum;
494
+ }
495
+
496
+ export const BusIOProfinetVirtualBusTypeEnum = {
497
+ VirtualProfinet: 'virtual_profinet'
498
+ } as const;
499
+
500
+ export type BusIOProfinetVirtualBusTypeEnum = typeof BusIOProfinetVirtualBusTypeEnum[keyof typeof BusIOProfinetVirtualBusTypeEnum];
501
+
502
+ /**
503
+ * @type BusIOType
504
+ * @export
505
+ */
506
+ export type BusIOType = { bus_type: 'profinet' } & BusIOProfinet | { bus_type: 'profinet_virtual' } & BusIOProfinetVirtual;
507
+
508
+ /**
509
+ *
510
+ * @export
511
+ * @interface BusIOsState
512
+ */
513
+ export interface BusIOsState {
514
+ /**
515
+ *
516
+ * @type {BusIOsStateEnum}
517
+ * @memberof BusIOsState
518
+ */
519
+ 'state': BusIOsStateEnum;
520
+ /**
521
+ * A message providing additional information on the input/output, e.g. BUS service status, encountered errors. May be empty if no additional information is available.
522
+ * @type {string}
523
+ * @memberof BusIOsState
524
+ */
525
+ 'message'?: string;
526
+ }
527
+
528
+
529
+ /**
530
+ * Current state of the BUS input/output service.
531
+ * @export
532
+ * @enum {string}
533
+ */
534
+
535
+ export const BusIOsStateEnum = {
536
+ BusIosStateUnknown: 'BUS_IOS_STATE_UNKNOWN',
537
+ BusIosStateInitializing: 'BUS_IOS_STATE_INITIALIZING',
538
+ BusIosStateConnected: 'BUS_IOS_STATE_CONNECTED',
539
+ BusIosStateDisconnected: 'BUS_IOS_STATE_DISCONNECTED'
540
+ } as const;
541
+
542
+ export type BusIOsStateEnum = typeof BusIOsStateEnum[keyof typeof BusIOsStateEnum];
543
+
544
+
369
545
  /**
370
546
  * Defines a cylindrical shape with 2 semi-spheres on the top and bottom. Centred around origin, symmetric around z-axis.
371
547
  * @export
@@ -514,13 +690,13 @@ export interface Collision {
514
690
  * @type {string}
515
691
  * @memberof Collision
516
692
  */
517
- 'id_of_world'?: string;
693
+ 'id_of_layer'?: string;
518
694
  /**
519
695
  * A three-dimensional vector [x, y, z] with double precision.
520
696
  * @type {Array<number>}
521
697
  * @memberof Collision
522
698
  */
523
- 'normal_world_on_b'?: Array<number>;
699
+ 'normal_root_on_b'?: Array<number>;
524
700
  /**
525
701
  *
526
702
  * @type {CollisionContact}
@@ -551,7 +727,7 @@ export interface CollisionContact {
551
727
  * @type {Array<number>}
552
728
  * @memberof CollisionContact
553
729
  */
554
- 'world'?: Array<number>;
730
+ 'root'?: Array<number>;
555
731
  }
556
732
  /**
557
733
  *
@@ -567,110 +743,42 @@ export interface CollisionError {
567
743
  'collision'?: FeedbackCollision;
568
744
  }
569
745
  /**
570
- *
746
+ * @type CollisionFreeAlgorithm
747
+ * Configuration for collision-free path planning algorithms. Different algorithms may have different parameters and behavior.
571
748
  * @export
572
- * @interface CollisionMotionGroup
573
749
  */
574
- export interface CollisionMotionGroup {
575
- /**
576
- * A link chain is a kinematic chain of links that is connected via joints. A motion group can be used to control the motion of the joints in a link chain. A link is a group of colliders that is attached to the link reference frame. The reference frame of a link is obtained after applying all sets of Denavit-Hartenberg-parameters from base to (including) the link index. This means that the reference frame of the link is on the rotation axis of the next joint in the kinematic chain. Example: For a motion group with 2 joints, the collider reference frame (CRF) for link 1 is on the rotation axis of joint 2. The chain looks like: - Origin >> Mounting >> Base >> (CRF Base) Joint 0 >> Link 0 >> (CRF Link 0) Joint 1 >> Link 1 >> (CRF Link 1) Flange (CRF Tool) >> TCP Adjacent links in the kinematic chain of the motion group are not checked for mutual collision.
577
- * @type {Array<{ [key: string]: Collider; }>}
578
- * @memberof CollisionMotionGroup
579
- */
580
- 'link_chain'?: Array<{ [key: string]: Collider; }>;
581
- /**
582
- * Defines the shape of a tool. A tool is a dictionary of colliders. All colliders that make up a tool are attached to the flange frame of the motion group.
583
- * @type {{ [key: string]: Collider; }}
584
- * @memberof CollisionMotionGroup
585
- */
586
- 'tool'?: { [key: string]: Collider; };
587
- }
750
+ export type CollisionFreeAlgorithm = MidpointInsertionAlgorithm | RRTConnectAlgorithm;
751
+
588
752
  /**
589
753
  *
590
754
  * @export
591
- * @interface CollisionMotionGroupAssembly
755
+ * @interface CollisionSetup
592
756
  */
593
- export interface CollisionMotionGroupAssembly {
594
- /**
595
- * References a stored link chain.
596
- * @type {string}
597
- * @memberof CollisionMotionGroupAssembly
598
- */
599
- 'stored_link_chain'?: string;
757
+ export interface CollisionSetup {
600
758
  /**
601
- * References a stored tool.
602
- * @type {string}
603
- * @memberof CollisionMotionGroupAssembly
759
+ * A collection of identifiable colliders.
760
+ * @type {{ [key: string]: Collider; }}
761
+ * @memberof CollisionSetup
604
762
  */
605
- 'stored_tool'?: string;
763
+ 'colliders'?: { [key: string]: Collider; };
606
764
  /**
607
765
  * A link chain is a kinematic chain of links that is connected via joints. A motion group can be used to control the motion of the joints in a link chain. A link is a group of colliders that is attached to the link reference frame. The reference frame of a link is obtained after applying all sets of Denavit-Hartenberg-parameters from base to (including) the link index. This means that the reference frame of the link is on the rotation axis of the next joint in the kinematic chain. Example: For a motion group with 2 joints, the collider reference frame (CRF) for link 1 is on the rotation axis of joint 2. The chain looks like: - Origin >> Mounting >> Base >> (CRF Base) Joint 0 >> Link 0 >> (CRF Link 0) Joint 1 >> Link 1 >> (CRF Link 1) Flange (CRF Tool) >> TCP Adjacent links in the kinematic chain of the motion group are not checked for mutual collision.
608
766
  * @type {Array<{ [key: string]: Collider; }>}
609
- * @memberof CollisionMotionGroupAssembly
767
+ * @memberof CollisionSetup
610
768
  */
611
769
  'link_chain'?: Array<{ [key: string]: Collider; }>;
612
770
  /**
613
771
  * Defines the shape of a tool. A tool is a dictionary of colliders. All colliders that make up a tool are attached to the flange frame of the motion group.
614
772
  * @type {{ [key: string]: Collider; }}
615
- * @memberof CollisionMotionGroupAssembly
773
+ * @memberof CollisionSetup
616
774
  */
617
775
  'tool'?: { [key: string]: Collider; };
618
- }
619
- /**
620
- * Defines the collision scene. There are two types of objects in the scene: - `colliders`: Each collider is attached directly to the origin of the scene: Origin >> Collider - `motion-groups`: Each motion group is assigned a kinematic chain of links with a special collider, called tool, attached to the last element. The motion group is attached to the origin of the scene via its mounting: Origin >> Mounting >> Motion Group Base >> […]
621
- * @export
622
- * @interface CollisionScene
623
- */
624
- export interface CollisionScene {
625
- /**
626
- * A collection of identifiable colliders.
627
- * @type {{ [key: string]: Collider; }}
628
- * @memberof CollisionScene
629
- */
630
- 'colliders'?: { [key: string]: Collider; };
631
- /**
632
- * Maps a Wandelbots NOVA motion group to its configuration in the collision scene. Key must be a motion group identifier. Values are collision motion group objects. A collision motion group defines a motion group in the collision scene. The motion group is attached to the origin of the scene. To relocate the motion group, configure its mounting offset on the physical controller. This ensures that the definition of motion commands and collision scenes use the same coordinate system. The kinematic chain looks like this: - Origin >> Mounting >> Base >> Joint 0 >> Link 0 >> Joint 1 >> […] >> TCP A `tool` is treated like another link attached to the end (flange) of the kinematic chain. All tool colliders are described in the flange frame.
633
- * @type {{ [key: string]: CollisionMotionGroup; }}
634
- * @memberof CollisionScene
635
- */
636
- 'motion_groups'?: { [key: string]: CollisionMotionGroup; };
637
- }
638
- /**
639
- * Defines the collision scene assembly. Merges all referenced and new scene components into a single scene. Previously added components with identical identifiers are overwritten within the same group. There is one group for each of the following components: - Colliders attached to the origin of the scene, - Tool per motion group, and - For each link per motion group. The scene is assembled by adding components in the following order. 1. stored_scenes 2. scene 3. stored_colliders 4. colliders 5. stored_link_chains and stored_tools (per motion group) 6. link_chains and tools (per motion group)
640
- * @export
641
- * @interface CollisionSceneAssembly
642
- */
643
- export interface CollisionSceneAssembly {
644
- /**
645
- * Add stored scenes to the scene via their identifiers. The scenes are merged based on their order in the array. The scene at index zero serves as base. Following scenes overwrite components with identical identifiers, see [Collision Scene Assembly](Collision Scene Assembly).
646
- * @type {Array<string>}
647
- * @memberof CollisionSceneAssembly
648
- */
649
- 'stored_scenes'?: Array<string>;
650
- /**
651
- *
652
- * @type {CollisionScene}
653
- * @memberof CollisionSceneAssembly
654
- */
655
- 'scene'?: CollisionScene;
656
- /**
657
- * Add stored colliders to the scene via their identifiers. The colliders are added to the the origin of the scene.
658
- * @type {Array<string>}
659
- * @memberof CollisionSceneAssembly
660
- */
661
- 'stored_colliders'?: Array<string>;
662
- /**
663
- * A collection of identifiable colliders.
664
- * @type {{ [key: string]: Collider; }}
665
- * @memberof CollisionSceneAssembly
666
- */
667
- 'colliders'?: { [key: string]: Collider; };
668
776
  /**
669
- * Maps a Wandelbots NOVA motion group to its assembly configuration in the collision scene. Key must be a motion group identifier. A collision motion group defines a motion group in the collision scene. The motion group is attached to the origin of the scene. To relocate the motion group, configure its mounting offset on the physical controller. This ensures that the definition of motion commands and collision scenes use the same coordinate system. The kinematic chain looks like this: - Origin >> Mounting >> Base >> Joint 0 >> Link 0 >> Joint 1 >> […] >> TCP A `tool` is treated like another link attached to the end (flange) of the kinematic chain. All tool colliders are described in the flange frame.
670
- * @type {{ [key: string]: CollisionMotionGroupAssembly; }}
671
- * @memberof CollisionSceneAssembly
777
+ * If true, self-collision detection is enabled for the motion group. Self-collision detection checks if links in the kinematic chain of the motion group collide with each other. Adjacent links in the kinematic chain of the motion group are not checked for mutual collision. The tool is treated like a link at the end of the kinematic chain. It is checked against all links except the last one. Default is true.
778
+ * @type {boolean}
779
+ * @memberof CollisionSetup
672
780
  */
673
- 'motion_groups'?: { [key: string]: CollisionMotionGroupAssembly; };
781
+ 'self_collision_detection'?: boolean;
674
782
  }
675
783
  /**
676
784
  * Comparator for the comparison of two values. The comparator is used to compare two values and return a boolean result. The default comparator is unknown.
@@ -1126,6 +1234,128 @@ export const Direction = {
1126
1234
  export type Direction = typeof Direction[keyof typeof Direction];
1127
1235
 
1128
1236
 
1237
+ /**
1238
+ * The provided joint data does not match the expected number of joints for this motion group.
1239
+ * @export
1240
+ * @interface ErrorInvalidJointCount
1241
+ */
1242
+ export interface ErrorInvalidJointCount {
1243
+ /**
1244
+ * The expected number of joints for this motion group.
1245
+ * @type {number}
1246
+ * @memberof ErrorInvalidJointCount
1247
+ */
1248
+ 'expected_joint_count': number;
1249
+ /**
1250
+ * The number of provided joints.
1251
+ * @type {number}
1252
+ * @memberof ErrorInvalidJointCount
1253
+ */
1254
+ 'provided_joint_count': number;
1255
+ /**
1256
+ *
1257
+ * @type {string}
1258
+ * @memberof ErrorInvalidJointCount
1259
+ */
1260
+ 'error_feedback_name': ErrorInvalidJointCountErrorFeedbackNameEnum;
1261
+ }
1262
+
1263
+ export const ErrorInvalidJointCountErrorFeedbackNameEnum = {
1264
+ ErrorInvalidJointCount: 'ErrorInvalidJointCount'
1265
+ } as const;
1266
+
1267
+ export type ErrorInvalidJointCountErrorFeedbackNameEnum = typeof ErrorInvalidJointCountErrorFeedbackNameEnum[keyof typeof ErrorInvalidJointCountErrorFeedbackNameEnum];
1268
+
1269
+ /**
1270
+ * A reference joint position (start or target) exceeds the configured joint limits.
1271
+ * @export
1272
+ * @interface ErrorJointLimitExceeded
1273
+ */
1274
+ export interface ErrorJointLimitExceeded {
1275
+ /**
1276
+ * Index of the joint exceeding its limits (0-based).
1277
+ * @type {number}
1278
+ * @memberof ErrorJointLimitExceeded
1279
+ */
1280
+ 'joint_index'?: number;
1281
+ /**
1282
+ *
1283
+ * @type {Array<number>}
1284
+ * @memberof ErrorJointLimitExceeded
1285
+ */
1286
+ 'joint_position'?: Array<number>;
1287
+ /**
1288
+ *
1289
+ * @type {string}
1290
+ * @memberof ErrorJointLimitExceeded
1291
+ */
1292
+ 'error_feedback_name': ErrorJointLimitExceededErrorFeedbackNameEnum;
1293
+ }
1294
+
1295
+ export const ErrorJointLimitExceededErrorFeedbackNameEnum = {
1296
+ ErrorJointLimitExceeded: 'ErrorJointLimitExceeded'
1297
+ } as const;
1298
+
1299
+ export type ErrorJointLimitExceededErrorFeedbackNameEnum = typeof ErrorJointLimitExceededErrorFeedbackNameEnum[keyof typeof ErrorJointLimitExceededErrorFeedbackNameEnum];
1300
+
1301
+ /**
1302
+ * A reference joint position (e.g. start or target joint position) results in collisions that prevent processing.
1303
+ * @export
1304
+ * @interface ErrorJointPositionCollision
1305
+ */
1306
+ export interface ErrorJointPositionCollision {
1307
+ /**
1308
+ *
1309
+ * @type {Array<Collision>}
1310
+ * @memberof ErrorJointPositionCollision
1311
+ */
1312
+ 'collisions'?: Array<Collision>;
1313
+ /**
1314
+ *
1315
+ * @type {Array<number>}
1316
+ * @memberof ErrorJointPositionCollision
1317
+ */
1318
+ 'joint_position'?: Array<number>;
1319
+ /**
1320
+ *
1321
+ * @type {string}
1322
+ * @memberof ErrorJointPositionCollision
1323
+ */
1324
+ 'error_feedback_name': ErrorJointPositionCollisionErrorFeedbackNameEnum;
1325
+ }
1326
+
1327
+ export const ErrorJointPositionCollisionErrorFeedbackNameEnum = {
1328
+ ErrorJointPositionCollision: 'ErrorJointPositionCollision'
1329
+ } as const;
1330
+
1331
+ export type ErrorJointPositionCollisionErrorFeedbackNameEnum = typeof ErrorJointPositionCollisionErrorFeedbackNameEnum[keyof typeof ErrorJointPositionCollisionErrorFeedbackNameEnum];
1332
+
1333
+ /**
1334
+ * The collision-free planning algorithm reached its maximum iteration limit without finding a valid path. Increase max_iterations or modify the start/target positions.
1335
+ * @export
1336
+ * @interface ErrorMaxIterationsExceeded
1337
+ */
1338
+ export interface ErrorMaxIterationsExceeded {
1339
+ /**
1340
+ * The maximum number of iterations that was reached.
1341
+ * @type {number}
1342
+ * @memberof ErrorMaxIterationsExceeded
1343
+ */
1344
+ 'max_iterations'?: number;
1345
+ /**
1346
+ *
1347
+ * @type {string}
1348
+ * @memberof ErrorMaxIterationsExceeded
1349
+ */
1350
+ 'error_feedback_name': ErrorMaxIterationsExceededErrorFeedbackNameEnum;
1351
+ }
1352
+
1353
+ export const ErrorMaxIterationsExceededErrorFeedbackNameEnum = {
1354
+ ErrorMaxIterationsExceeded: 'ErrorMaxIterationsExceeded'
1355
+ } as const;
1356
+
1357
+ export type ErrorMaxIterationsExceededErrorFeedbackNameEnum = typeof ErrorMaxIterationsExceededErrorFeedbackNameEnum[keyof typeof ErrorMaxIterationsExceededErrorFeedbackNameEnum];
1358
+
1129
1359
  /**
1130
1360
  * Details about the state of the motion execution. The details are either for a jogging or a trajectory. If NOVA is not controlling this motion group at the moment, this field is omitted.
1131
1361
  * @export
@@ -1403,46 +1633,140 @@ export type FloatValueValueTypeEnum = typeof FloatValueValueTypeEnum[keyof typeo
1403
1633
  /**
1404
1634
  *
1405
1635
  * @export
1406
- * @interface GetModeResponse
1636
+ * @interface ForwardKinematics422Response
1407
1637
  */
1408
- export interface GetModeResponse {
1638
+ export interface ForwardKinematics422Response {
1409
1639
  /**
1410
1640
  *
1411
- * @type {RobotSystemMode}
1412
- * @memberof GetModeResponse
1641
+ * @type {Array<ForwardKinematicsValidationError>}
1642
+ * @memberof ForwardKinematics422Response
1413
1643
  */
1414
- 'robot_system_mode': RobotSystemMode;
1644
+ 'detail'?: Array<ForwardKinematicsValidationError>;
1415
1645
  }
1416
-
1417
-
1418
1646
  /**
1419
1647
  *
1420
1648
  * @export
1421
- * @interface GetTrajectoryResponse
1649
+ * @interface ForwardKinematicsRequest
1422
1650
  */
1423
- export interface GetTrajectoryResponse {
1651
+ export interface ForwardKinematicsRequest {
1424
1652
  /**
1425
- * Unique identifier of the motion group the trajectory is planned for.
1653
+ * String identifiying the model of a motion group.
1426
1654
  * @type {string}
1427
- * @memberof GetTrajectoryResponse
1655
+ * @memberof ForwardKinematicsRequest
1428
1656
  */
1429
- 'motion_group': string;
1657
+ 'motion_group_model': string;
1430
1658
  /**
1431
- * The trajectory consisting of a list of joint positions and an equal number of corresponding timestamps.
1432
- * @type {JointTrajectory}
1433
- * @memberof GetTrajectoryResponse
1659
+ * List of joint positions [rad] for which TCP poses are computed.
1660
+ * @type {Array<Array<number>>}
1661
+ * @memberof ForwardKinematicsRequest
1434
1662
  */
1435
- 'trajectory': JointTrajectory;
1663
+ 'joint_positions': Array<Array<number>>;
1436
1664
  /**
1437
- * Unique identifier of the tool the trajectory is planned for.
1438
- * @type {string}
1439
- * @memberof GetTrajectoryResponse
1665
+ *
1666
+ * @type {Pose}
1667
+ * @memberof ForwardKinematicsRequest
1440
1668
  */
1441
- 'tcp': string;
1442
- }
1443
- /**
1444
- *
1445
- * @export
1669
+ 'tcp_offset'?: Pose;
1670
+ /**
1671
+ * Offset from the world frame to the motion group base.
1672
+ * @type {Pose}
1673
+ * @memberof ForwardKinematicsRequest
1674
+ */
1675
+ 'mounting'?: Pose;
1676
+ }
1677
+ /**
1678
+ *
1679
+ * @export
1680
+ * @interface ForwardKinematicsResponse
1681
+ */
1682
+ export interface ForwardKinematicsResponse {
1683
+ /**
1684
+ * List of computed TCP poses corresponding to the input joint positions.
1685
+ * @type {Array<Pose>}
1686
+ * @memberof ForwardKinematicsResponse
1687
+ */
1688
+ 'tcp_poses': Array<Pose>;
1689
+ }
1690
+ /**
1691
+ *
1692
+ * @export
1693
+ * @interface ForwardKinematicsValidationError
1694
+ */
1695
+ export interface ForwardKinematicsValidationError {
1696
+ /**
1697
+ *
1698
+ * @type {Array<ValidationErrorLocInner>}
1699
+ * @memberof ForwardKinematicsValidationError
1700
+ */
1701
+ 'loc': Array<ValidationErrorLocInner>;
1702
+ /**
1703
+ *
1704
+ * @type {string}
1705
+ * @memberof ForwardKinematicsValidationError
1706
+ */
1707
+ 'msg': string;
1708
+ /**
1709
+ *
1710
+ * @type {string}
1711
+ * @memberof ForwardKinematicsValidationError
1712
+ */
1713
+ 'type': string;
1714
+ /**
1715
+ *
1716
+ * @type {{ [key: string]: any; }}
1717
+ * @memberof ForwardKinematicsValidationError
1718
+ */
1719
+ 'input': { [key: string]: any; };
1720
+ /**
1721
+ *
1722
+ * @type {ErrorInvalidJointCount}
1723
+ * @memberof ForwardKinematicsValidationError
1724
+ */
1725
+ 'data'?: ErrorInvalidJointCount;
1726
+ }
1727
+ /**
1728
+ *
1729
+ * @export
1730
+ * @interface GetModeResponse
1731
+ */
1732
+ export interface GetModeResponse {
1733
+ /**
1734
+ *
1735
+ * @type {RobotSystemMode}
1736
+ * @memberof GetModeResponse
1737
+ */
1738
+ 'robot_system_mode': RobotSystemMode;
1739
+ }
1740
+
1741
+
1742
+ /**
1743
+ *
1744
+ * @export
1745
+ * @interface GetTrajectoryResponse
1746
+ */
1747
+ export interface GetTrajectoryResponse {
1748
+ /**
1749
+ * Unique identifier of the motion group the trajectory is planned for.
1750
+ * @type {string}
1751
+ * @memberof GetTrajectoryResponse
1752
+ */
1753
+ 'motion_group': string;
1754
+ /**
1755
+ * The trajectory consisting of a list of joint positions and an equal number of corresponding timestamps.
1756
+ * @type {JointTrajectory}
1757
+ * @memberof GetTrajectoryResponse
1758
+ */
1759
+ 'trajectory': JointTrajectory;
1760
+ /**
1761
+ * Unique identifier of the tool the trajectory is planned for.
1762
+ * @type {string}
1763
+ * @memberof GetTrajectoryResponse
1764
+ */
1765
+ 'tcp': string;
1766
+ }
1767
+ /**
1768
+ *
1769
+ * @export
1446
1770
  * @interface HTTPValidationError
1447
1771
  */
1448
1772
  export interface HTTPValidationError {
@@ -1927,6 +2251,19 @@ export interface InvalidDofInvalidDof {
1927
2251
  */
1928
2252
  'joint_position'?: Array<number>;
1929
2253
  }
2254
+ /**
2255
+ *
2256
+ * @export
2257
+ * @interface InverseKinematics422Response
2258
+ */
2259
+ export interface InverseKinematics422Response {
2260
+ /**
2261
+ *
2262
+ * @type {Array<InverseKinematicsValidationError>}
2263
+ * @memberof InverseKinematics422Response
2264
+ */
2265
+ 'detail'?: Array<InverseKinematicsValidationError>;
2266
+ }
1930
2267
  /**
1931
2268
  *
1932
2269
  * @export
@@ -1964,11 +2301,11 @@ export interface InverseKinematicsRequest {
1964
2301
  */
1965
2302
  'joint_position_limits'?: Array<LimitRange>;
1966
2303
  /**
1967
- * Collision scenes to be respected by the motion planner. Each contains the single motion group which is planned for. Scenes are checked individually along the trajectory and independently of other scenes. To respect the safety zones of the controller, fetch the safety zones, link and tool shapes from the controller and add one scene made up of those. To respect the safety zones of the controller and check for collision: 1. Fetch the safety zones, link and tool shapes from the controller. 2. Add the fetched zones, links and tools to a scene. 3. Create other scenes from your own 3D data as needed. 4. Execute this endpoint. 5. The response highlights the scenes in which a collision was detected by key.
1968
- * @type {{ [key: string]: SingleMotionGroupCollisionScene; }}
2304
+ * Collision layers to be respected by the motion planner when planning for a single motion group. Each setup represents one layer, e.g. the safety zones and shapes or a fine grained tool and workpiece model. Layers are checked individually along the trajectory and independently of other layers. To respect the safety zones of the controller and check for collision: 1. Fetch the safety zones, link and tool shapes from the controller. 2. Add the fetched zones, links and tools to a layer. 3. Create other layers from your own 3D data as needed. 4. Plan trajectory. 5. The response highlights the layer in which a collision was detected by key.
2305
+ * @type {{ [key: string]: CollisionSetup; }}
1969
2306
  * @memberof InverseKinematicsRequest
1970
2307
  */
1971
- 'collision_scenes'?: { [key: string]: SingleMotionGroupCollisionScene; };
2308
+ 'collision_setups'?: { [key: string]: CollisionSetup; };
1972
2309
  }
1973
2310
  /**
1974
2311
  *
@@ -1983,6 +2320,50 @@ export interface InverseKinematicsResponse {
1983
2320
  */
1984
2321
  'joints': Array<Array<Array<number>>>;
1985
2322
  }
2323
+ /**
2324
+ *
2325
+ * @export
2326
+ * @interface InverseKinematicsValidationError
2327
+ */
2328
+ export interface InverseKinematicsValidationError {
2329
+ /**
2330
+ *
2331
+ * @type {Array<ValidationErrorLocInner>}
2332
+ * @memberof InverseKinematicsValidationError
2333
+ */
2334
+ 'loc': Array<ValidationErrorLocInner>;
2335
+ /**
2336
+ *
2337
+ * @type {string}
2338
+ * @memberof InverseKinematicsValidationError
2339
+ */
2340
+ 'msg': string;
2341
+ /**
2342
+ *
2343
+ * @type {string}
2344
+ * @memberof InverseKinematicsValidationError
2345
+ */
2346
+ 'type': string;
2347
+ /**
2348
+ *
2349
+ * @type {{ [key: string]: any; }}
2350
+ * @memberof InverseKinematicsValidationError
2351
+ */
2352
+ 'input': { [key: string]: any; };
2353
+ /**
2354
+ *
2355
+ * @type {InverseKinematicsValidationErrorAllOfData}
2356
+ * @memberof InverseKinematicsValidationError
2357
+ */
2358
+ 'data'?: InverseKinematicsValidationErrorAllOfData;
2359
+ }
2360
+ /**
2361
+ * @type InverseKinematicsValidationErrorAllOfData
2362
+ * Optional data further specifying the validation error.
2363
+ * @export
2364
+ */
2365
+ export type InverseKinematicsValidationErrorAllOfData = { error_feedback_name: 'ErrorInvalidJointCount' } & ErrorInvalidJointCount | { error_feedback_name: 'ErrorJointLimitExceeded' } & ErrorJointLimitExceeded;
2366
+
1986
2367
  /**
1987
2368
  * State of jogging execution. This state is sent during jogging movement, response-rate closest to the nearest multiple of controller step-rate but not exceeding the configured rate. The jogging state can be one of the following: - RUNNING: Jogging is active. - PAUSED_BY_USER: User has paused jogging. - PAUSED_NEAR_JOINT_LIMIT: Jogging was paused because a joint is is near its limit. - PAUSED_NEAR_COLLISION: Jogging was paused because the motion group neared a collision. - PAUSED_ON_IO: Jogging was paused because of an I/O event.
1988
2369
  * @export
@@ -2565,6 +2946,32 @@ export const Manufacturer = {
2565
2946
  export type Manufacturer = typeof Manufacturer[keyof typeof Manufacturer];
2566
2947
 
2567
2948
 
2949
+ /**
2950
+ * Midpoint insertion algorithm configuration for collision-free path planning. This algorithm iteratively inserts midpoints between the start and target joint position to find collision-free paths.
2951
+ * @export
2952
+ * @interface MidpointInsertionAlgorithm
2953
+ */
2954
+ export interface MidpointInsertionAlgorithm {
2955
+ /**
2956
+ * Algorithm discriminator.
2957
+ * @type {string}
2958
+ * @memberof MidpointInsertionAlgorithm
2959
+ */
2960
+ 'algorithm_name': MidpointInsertionAlgorithmAlgorithmNameEnum;
2961
+ /**
2962
+ * Maximum number of iterations for the midpoint insertion algorithm. Higher values increase likelyhood of success, but also computation time (linear).
2963
+ * @type {number}
2964
+ * @memberof MidpointInsertionAlgorithm
2965
+ */
2966
+ 'max_iterations'?: number;
2967
+ }
2968
+
2969
+ export const MidpointInsertionAlgorithmAlgorithmNameEnum = {
2970
+ MidpointInsertionAlgorithm: 'MidpointInsertionAlgorithm'
2971
+ } as const;
2972
+
2973
+ export type MidpointInsertionAlgorithmAlgorithmNameEnum = typeof MidpointInsertionAlgorithmAlgorithmNameEnum[keyof typeof MidpointInsertionAlgorithmAlgorithmNameEnum];
2974
+
2568
2975
  /**
2569
2976
  *
2570
2977
  * @export
@@ -2745,6 +3152,55 @@ export interface MotionGroupJoints {
2745
3152
  */
2746
3153
  'torques'?: Array<number>;
2747
3154
  }
3155
+ /**
3156
+ *
3157
+ * @export
3158
+ * @interface MotionGroupSetup
3159
+ */
3160
+ export interface MotionGroupSetup {
3161
+ /**
3162
+ * String identifiying the model of a motion group.
3163
+ * @type {string}
3164
+ * @memberof MotionGroupSetup
3165
+ */
3166
+ 'motion_group_model': string;
3167
+ /**
3168
+ * [ms] cycle time of the motion group controller. A trajectory for this motion group should be computed to this resolution.
3169
+ * @type {number}
3170
+ * @memberof MotionGroupSetup
3171
+ */
3172
+ 'cycle_time': number;
3173
+ /**
3174
+ * The offset from the world frame to the motion group base.
3175
+ * @type {Pose}
3176
+ * @memberof MotionGroupSetup
3177
+ */
3178
+ 'mounting'?: Pose;
3179
+ /**
3180
+ *
3181
+ * @type {Pose}
3182
+ * @memberof MotionGroupSetup
3183
+ */
3184
+ 'tcp_offset'?: Pose;
3185
+ /**
3186
+ *
3187
+ * @type {LimitSet}
3188
+ * @memberof MotionGroupSetup
3189
+ */
3190
+ 'global_limits'?: LimitSet;
3191
+ /**
3192
+ *
3193
+ * @type {Payload}
3194
+ * @memberof MotionGroupSetup
3195
+ */
3196
+ 'payload'?: Payload;
3197
+ /**
3198
+ * Collision layers to be respected by the motion planner when planning for a single motion group. Each setup represents one layer, e.g. the safety zones and shapes or a fine grained tool and workpiece model. Layers are checked individually along the trajectory and independently of other layers. To respect the safety zones of the controller and check for collision: 1. Fetch the safety zones, link and tool shapes from the controller. 2. Add the fetched zones, links and tools to a layer. 3. Create other layers from your own 3D data as needed. 4. Plan trajectory. 5. The response highlights the layer in which a collision was detected by key.
3199
+ * @type {{ [key: string]: CollisionSetup; }}
3200
+ * @memberof MotionGroupSetup
3201
+ */
3202
+ 'collision_setups'?: { [key: string]: CollisionSetup; };
3203
+ }
2748
3204
  /**
2749
3205
  * Presents the current state of the motion group.
2750
3206
  * @export
@@ -3307,6 +3763,82 @@ export interface Payload {
3307
3763
  */
3308
3764
  'moment_of_inertia'?: Array<number>;
3309
3765
  }
3766
+ /**
3767
+ *
3768
+ * @export
3769
+ * @interface Plan422Response
3770
+ */
3771
+ export interface Plan422Response {
3772
+ /**
3773
+ *
3774
+ * @type {Array<PlanValidationError>}
3775
+ * @memberof Plan422Response
3776
+ */
3777
+ 'detail'?: Array<PlanValidationError>;
3778
+ }
3779
+ /**
3780
+ * Response when collision-free trajectory planning fails. Contains specific feedback about why the planning failed.
3781
+ * @export
3782
+ * @interface PlanCollisionFreeFailedResponse
3783
+ */
3784
+ export interface PlanCollisionFreeFailedResponse {
3785
+ /**
3786
+ *
3787
+ * @type {ErrorMaxIterationsExceeded}
3788
+ * @memberof PlanCollisionFreeFailedResponse
3789
+ */
3790
+ 'error_feedback': ErrorMaxIterationsExceeded;
3791
+ }
3792
+ /**
3793
+ *
3794
+ * @export
3795
+ * @interface PlanCollisionFreeRequest
3796
+ */
3797
+ export interface PlanCollisionFreeRequest {
3798
+ /**
3799
+ * The data to assemble the robot setup can be retrieved from [getMotionGroupDescription](getMotionGroupDescription) endpoint.
3800
+ * @type {MotionGroupSetup}
3801
+ * @memberof PlanCollisionFreeRequest
3802
+ */
3803
+ 'motion_group_setup': MotionGroupSetup;
3804
+ /**
3805
+ *
3806
+ * @type {Array<number>}
3807
+ * @memberof PlanCollisionFreeRequest
3808
+ */
3809
+ 'start_joint_position': Array<number>;
3810
+ /**
3811
+ *
3812
+ * @type {Array<number>}
3813
+ * @memberof PlanCollisionFreeRequest
3814
+ */
3815
+ 'target': Array<number>;
3816
+ /**
3817
+ *
3818
+ * @type {CollisionFreeAlgorithm}
3819
+ * @memberof PlanCollisionFreeRequest
3820
+ */
3821
+ 'algorithm': CollisionFreeAlgorithm;
3822
+ }
3823
+ /**
3824
+ * Response from collision-free trajectory planning. Contains either a successful joint trajectory or failure information.
3825
+ * @export
3826
+ * @interface PlanCollisionFreeResponse
3827
+ */
3828
+ export interface PlanCollisionFreeResponse {
3829
+ /**
3830
+ *
3831
+ * @type {PlanCollisionFreeResponseResponse}
3832
+ * @memberof PlanCollisionFreeResponse
3833
+ */
3834
+ 'response': PlanCollisionFreeResponseResponse;
3835
+ }
3836
+ /**
3837
+ * @type PlanCollisionFreeResponseResponse
3838
+ * @export
3839
+ */
3840
+ export type PlanCollisionFreeResponseResponse = JointTrajectory | PlanCollisionFreeFailedResponse;
3841
+
3310
3842
  /**
3311
3843
  *
3312
3844
  * @export
@@ -3346,10 +3878,10 @@ export type PlanTrajectoryFailedResponseErrorFeedback = FeedbackCollision | Feed
3346
3878
  export interface PlanTrajectoryRequest {
3347
3879
  /**
3348
3880
  * The data to assemble the robot setup can be retrieved from [getMotionGroupDescription](getMotionGroupDescription) endpoint.
3349
- * @type {RobotSetup}
3881
+ * @type {MotionGroupSetup}
3350
3882
  * @memberof PlanTrajectoryRequest
3351
3883
  */
3352
- 'robot_setup': RobotSetup;
3884
+ 'motion_group_setup': MotionGroupSetup;
3353
3885
  /**
3354
3886
  *
3355
3887
  * @type {Array<number>}
@@ -3382,6 +3914,50 @@ export interface PlanTrajectoryResponse {
3382
3914
  */
3383
3915
  export type PlanTrajectoryResponseResponse = JointTrajectory | PlanTrajectoryFailedResponse;
3384
3916
 
3917
+ /**
3918
+ *
3919
+ * @export
3920
+ * @interface PlanValidationError
3921
+ */
3922
+ export interface PlanValidationError {
3923
+ /**
3924
+ *
3925
+ * @type {Array<ValidationErrorLocInner>}
3926
+ * @memberof PlanValidationError
3927
+ */
3928
+ 'loc': Array<ValidationErrorLocInner>;
3929
+ /**
3930
+ *
3931
+ * @type {string}
3932
+ * @memberof PlanValidationError
3933
+ */
3934
+ 'msg': string;
3935
+ /**
3936
+ *
3937
+ * @type {string}
3938
+ * @memberof PlanValidationError
3939
+ */
3940
+ 'type': string;
3941
+ /**
3942
+ *
3943
+ * @type {{ [key: string]: any; }}
3944
+ * @memberof PlanValidationError
3945
+ */
3946
+ 'input': { [key: string]: any; };
3947
+ /**
3948
+ *
3949
+ * @type {PlanValidationErrorAllOfData}
3950
+ * @memberof PlanValidationError
3951
+ */
3952
+ 'data'?: PlanValidationErrorAllOfData;
3953
+ }
3954
+ /**
3955
+ * @type PlanValidationErrorAllOfData
3956
+ * Optional data further specifying the validation error.
3957
+ * @export
3958
+ */
3959
+ export type PlanValidationErrorAllOfData = { error_feedback_name: 'ErrorInvalidJointCount' } & ErrorInvalidJointCount | { error_feedback_name: 'ErrorJointLimitExceeded' } & ErrorJointLimitExceeded | { error_feedback_name: 'ErrorJointPositionCollision' } & ErrorJointPositionCollision;
3960
+
3385
3961
  /**
3386
3962
  * Defines an x/y-plane with infinite size.
3387
3963
  * @export
@@ -3474,15 +4050,274 @@ export interface Pose {
3474
4050
  'orientation'?: Array<number>;
3475
4051
  }
3476
4052
  /**
3477
- * Defines an x/y-plane with finite size. Centred around the z-axis.
4053
+ *
3478
4054
  * @export
3479
- * @interface Rectangle
4055
+ * @interface ProfinetDescription
3480
4056
  */
3481
- export interface Rectangle {
4057
+ export interface ProfinetDescription {
3482
4058
  /**
3483
- *
4059
+ * The vendor identifier of the PROFINET device, identifying the manufacturer.
3484
4060
  * @type {string}
3485
- * @memberof Rectangle
4061
+ * @memberof ProfinetDescription
4062
+ */
4063
+ 'vendor_id': string;
4064
+ /**
4065
+ * The device identifier of the PROFINET device, identifying the specific device within the vendor\'s range.
4066
+ * @type {string}
4067
+ * @memberof ProfinetDescription
4068
+ */
4069
+ 'device_id': string;
4070
+ /**
4071
+ *
4072
+ * @type {Array<ProfinetSlotDescription>}
4073
+ * @memberof ProfinetDescription
4074
+ */
4075
+ 'slots'?: Array<ProfinetSlotDescription>;
4076
+ /**
4077
+ * Name of the PROFINET device
4078
+ * @type {string}
4079
+ * @memberof ProfinetDescription
4080
+ */
4081
+ 'device_name'?: string;
4082
+ /**
4083
+ * IP address for the PROFINET device
4084
+ * @type {string}
4085
+ * @memberof ProfinetDescription
4086
+ */
4087
+ 'ip'?: string;
4088
+ }
4089
+ /**
4090
+ *
4091
+ * @export
4092
+ * @interface ProfinetIO
4093
+ */
4094
+ export interface ProfinetIO {
4095
+ /**
4096
+ * The name of the input/output value. This is a human-readable identifier for the value. It can be used to distinguish between different inputs/outputs in the system.
4097
+ * @type {string}
4098
+ * @memberof ProfinetIO
4099
+ */
4100
+ 'name': string;
4101
+ /**
4102
+ *
4103
+ * @type {ProfinetIOTypeEnum}
4104
+ * @memberof ProfinetIO
4105
+ */
4106
+ 'type': ProfinetIOTypeEnum;
4107
+ /**
4108
+ * The direction of the input/output value, indicating whether it is an input or output for the device.
4109
+ * @type {ProfinetIODirection}
4110
+ * @memberof ProfinetIO
4111
+ */
4112
+ 'direction': ProfinetIODirection;
4113
+ /**
4114
+ * The byte address of the input/output value in the PROFINET device. The byte address is used to locate the specific input/output within the device\'s memory or data structure.
4115
+ * @type {number}
4116
+ * @memberof ProfinetIO
4117
+ */
4118
+ 'byte_address': number;
4119
+ /**
4120
+ * The bit address of the input/output value within the byte or word address. The bit address is used to specify the exact bit within the byte or word that corresponds to the input/output value.
4121
+ * @type {number}
4122
+ * @memberof ProfinetIO
4123
+ */
4124
+ 'bit_address'?: number;
4125
+ /**
4126
+ * The unique identifier for the input/output value. This identifier is used to reference the specific input/output in the NOVA system.
4127
+ * @type {string}
4128
+ * @memberof ProfinetIO
4129
+ */
4130
+ 'io': string;
4131
+ }
4132
+
4133
+
4134
+ /**
4135
+ *
4136
+ * @export
4137
+ * @interface ProfinetIOData
4138
+ */
4139
+ export interface ProfinetIOData {
4140
+ /**
4141
+ * The name of the input/output value. This is a human-readable identifier for the value. It can be used to distinguish between different inputs/outputs in the system.
4142
+ * @type {string}
4143
+ * @memberof ProfinetIOData
4144
+ */
4145
+ 'name': string;
4146
+ /**
4147
+ *
4148
+ * @type {ProfinetIOTypeEnum}
4149
+ * @memberof ProfinetIOData
4150
+ */
4151
+ 'type': ProfinetIOTypeEnum;
4152
+ /**
4153
+ * The direction of the input/output value, indicating whether it is an input or output for the device.
4154
+ * @type {ProfinetIODirection}
4155
+ * @memberof ProfinetIOData
4156
+ */
4157
+ 'direction': ProfinetIODirection;
4158
+ /**
4159
+ * The byte address of the input/output value in the PROFINET device. The byte address is used to locate the specific input/output within the device\'s memory or data structure.
4160
+ * @type {number}
4161
+ * @memberof ProfinetIOData
4162
+ */
4163
+ 'byte_address': number;
4164
+ /**
4165
+ * The bit address of the input/output value within the byte or word address. The bit address is used to specify the exact bit within the byte or word that corresponds to the input/output value.
4166
+ * @type {number}
4167
+ * @memberof ProfinetIOData
4168
+ */
4169
+ 'bit_address'?: number;
4170
+ }
4171
+
4172
+
4173
+ /**
4174
+ * Identifies the input/output type.
4175
+ * @export
4176
+ * @enum {string}
4177
+ */
4178
+
4179
+ export const ProfinetIODirection = {
4180
+ ProfinetIoDirectionInput: 'PROFINET_IO_DIRECTION_INPUT',
4181
+ ProfinetIoDirectionOutput: 'PROFINET_IO_DIRECTION_OUTPUT',
4182
+ ProfinetIoDirectionInout: 'PROFINET_IO_DIRECTION_INOUT'
4183
+ } as const;
4184
+
4185
+ export type ProfinetIODirection = typeof ProfinetIODirection[keyof typeof ProfinetIODirection];
4186
+
4187
+
4188
+ /**
4189
+ * Value type of the PROFINET input/output.
4190
+ * @export
4191
+ * @enum {string}
4192
+ */
4193
+
4194
+ export const ProfinetIOTypeEnum = {
4195
+ ProfinetIoTypeUnknown: 'PROFINET_IO_TYPE_UNKNOWN',
4196
+ ProfinetIoTypeBool: 'PROFINET_IO_TYPE_BOOL',
4197
+ ProfinetIoTypeUsint: 'PROFINET_IO_TYPE_USINT',
4198
+ ProfinetIoTypeSint: 'PROFINET_IO_TYPE_SINT',
4199
+ ProfinetIoTypeUint: 'PROFINET_IO_TYPE_UINT',
4200
+ ProfinetIoTypeInt: 'PROFINET_IO_TYPE_INT',
4201
+ ProfinetIoTypeUdint: 'PROFINET_IO_TYPE_UDINT',
4202
+ ProfinetIoTypeDint: 'PROFINET_IO_TYPE_DINT',
4203
+ ProfinetIoTypeReal: 'PROFINET_IO_TYPE_REAL',
4204
+ ProfinetIoTypeLreal: 'PROFINET_IO_TYPE_LREAL'
4205
+ } as const;
4206
+
4207
+ export type ProfinetIOTypeEnum = typeof ProfinetIOTypeEnum[keyof typeof ProfinetIOTypeEnum];
4208
+
4209
+
4210
+ /**
4211
+ *
4212
+ * @export
4213
+ * @interface ProfinetInputOutputConfig
4214
+ */
4215
+ export interface ProfinetInputOutputConfig {
4216
+ /**
4217
+ * Content of the input output configuration file.
4218
+ * @type {string}
4219
+ * @memberof ProfinetInputOutputConfig
4220
+ */
4221
+ 'config': string;
4222
+ /**
4223
+ * Offset in bytes for the input data.
4224
+ * @type {number}
4225
+ * @memberof ProfinetInputOutputConfig
4226
+ */
4227
+ 'input_offset': number;
4228
+ /**
4229
+ * Offset in bytes for the output data.
4230
+ * @type {number}
4231
+ * @memberof ProfinetInputOutputConfig
4232
+ */
4233
+ 'output_offset': number;
4234
+ }
4235
+ /**
4236
+ *
4237
+ * @export
4238
+ * @interface ProfinetSlotDescription
4239
+ */
4240
+ export interface ProfinetSlotDescription {
4241
+ /**
4242
+ * The number of the PROFINET slot.
4243
+ * @type {number}
4244
+ * @memberof ProfinetSlotDescription
4245
+ */
4246
+ 'number': number;
4247
+ /**
4248
+ * The API number of the PROFINET input, used to identify the specific API for the input.
4249
+ * @type {number}
4250
+ * @memberof ProfinetSlotDescription
4251
+ */
4252
+ 'api': number;
4253
+ /**
4254
+ * An array of PROFINET subslots.
4255
+ * @type {Array<ProfinetSubSlotDescription>}
4256
+ * @memberof ProfinetSlotDescription
4257
+ */
4258
+ 'subslots': Array<ProfinetSubSlotDescription>;
4259
+ }
4260
+ /**
4261
+ *
4262
+ * @export
4263
+ * @interface ProfinetSubSlotDescription
4264
+ */
4265
+ export interface ProfinetSubSlotDescription {
4266
+ /**
4267
+ * The identifier of the PROFINET subslot.
4268
+ * @type {number}
4269
+ * @memberof ProfinetSubSlotDescription
4270
+ */
4271
+ 'number': number;
4272
+ /**
4273
+ * The length in bytes of the PROFINET input.
4274
+ * @type {number}
4275
+ * @memberof ProfinetSubSlotDescription
4276
+ */
4277
+ 'input_length': number;
4278
+ /**
4279
+ * The length in bytes of the PROFINET output.
4280
+ * @type {number}
4281
+ * @memberof ProfinetSubSlotDescription
4282
+ */
4283
+ 'output_length': number;
4284
+ }
4285
+ /**
4286
+ * <!-- theme: danger --> > **Experimental** RRT Connect algorithm configuration for collision-free path planning. Rapidly-exploring Random Trees (RRT) builds trees of valid configurations by randomly sampling the joint space and connecting feasible points. RRT Connect grows two trees simultaneously from start and target positions until they meet. This is a custom implementation optimized for manipulator kinematics and collision checking in industrial contexts.
4287
+ * @export
4288
+ * @interface RRTConnectAlgorithm
4289
+ */
4290
+ export interface RRTConnectAlgorithm {
4291
+ /**
4292
+ * Algorithm discriminator.
4293
+ * @type {string}
4294
+ * @memberof RRTConnectAlgorithm
4295
+ */
4296
+ 'algorithm_name': RRTConnectAlgorithmAlgorithmNameEnum;
4297
+ /**
4298
+ * Maximum number of iterations for the RRT Connect algorithm. Higher values increase likelihood of success, but also computation time.
4299
+ * @type {number}
4300
+ * @memberof RRTConnectAlgorithm
4301
+ */
4302
+ 'max_iterations'?: number;
4303
+ }
4304
+
4305
+ export const RRTConnectAlgorithmAlgorithmNameEnum = {
4306
+ RrtConnectAlgorithm: 'RRTConnectAlgorithm'
4307
+ } as const;
4308
+
4309
+ export type RRTConnectAlgorithmAlgorithmNameEnum = typeof RRTConnectAlgorithmAlgorithmNameEnum[keyof typeof RRTConnectAlgorithmAlgorithmNameEnum];
4310
+
4311
+ /**
4312
+ * Defines an x/y-plane with finite size. Centred around the z-axis.
4313
+ * @export
4314
+ * @interface Rectangle
4315
+ */
4316
+ export interface Rectangle {
4317
+ /**
4318
+ *
4319
+ * @type {string}
4320
+ * @memberof Rectangle
3486
4321
  */
3487
4322
  'shape_type': RectangleShapeTypeEnum;
3488
4323
  /**
@@ -3633,55 +4468,6 @@ export interface RobotControllerState {
3633
4468
  }
3634
4469
 
3635
4470
 
3636
- /**
3637
- *
3638
- * @export
3639
- * @interface RobotSetup
3640
- */
3641
- export interface RobotSetup {
3642
- /**
3643
- * String identifiying the model of a motion group.
3644
- * @type {string}
3645
- * @memberof RobotSetup
3646
- */
3647
- 'motion_group_model': string;
3648
- /**
3649
- * [ms] cycle time of the motion group controller. A trajectory for this motion group should be computed to this resolution.
3650
- * @type {number}
3651
- * @memberof RobotSetup
3652
- */
3653
- 'cycle_time': number;
3654
- /**
3655
- * The offset from the world frame to the motion group base.
3656
- * @type {Pose}
3657
- * @memberof RobotSetup
3658
- */
3659
- 'mounting'?: Pose;
3660
- /**
3661
- *
3662
- * @type {Pose}
3663
- * @memberof RobotSetup
3664
- */
3665
- 'tcp_offset'?: Pose;
3666
- /**
3667
- *
3668
- * @type {LimitSet}
3669
- * @memberof RobotSetup
3670
- */
3671
- 'global_limits'?: LimitSet;
3672
- /**
3673
- *
3674
- * @type {Payload}
3675
- * @memberof RobotSetup
3676
- */
3677
- 'payload'?: Payload;
3678
- /**
3679
- * Collision scenes to be respected by the motion planner. Each contains the single motion group which is planned for. Scenes are checked individually along the trajectory and independently of other scenes. To respect the safety zones of the controller, fetch the safety zones, link and tool shapes from the controller and add one scene made up of those. To respect the safety zones of the controller and check for collision: 1. Fetch the safety zones, link and tool shapes from the controller. 2. Add the fetched zones, links and tools to a scene. 3. Create other scenes from your own 3D data as needed. 4. Execute this endpoint. 5. The response highlights the scenes in which a collision was detected by key.
3680
- * @type {{ [key: string]: SingleMotionGroupCollisionScene; }}
3681
- * @memberof RobotSetup
3682
- */
3683
- 'collision_scenes'?: { [key: string]: SingleMotionGroupCollisionScene; };
3684
- }
3685
4471
  /**
3686
4472
  * The system mode of the robot system. ### ROBOT_SYSTEM_MODE_UNDEFINED Indicates that the robot controller is currently performing a mode transition. ### ROBOT_SYSTEM_MODE_DISCONNECT There is no communication with the robot controller at all. All connections are closed. No command is sent to the robot controller while in this mode. No input/output interaction is possible in this mode! All move requests will be rejected in this mode! ### ROBOT_SYSTEM_MODE_MONITOR A connection to the robot controller is established to only read the robot controller state. No command is sent to the robot controller while in this mode. It is possible to receive input/output information. All move requests will be rejected in this mode! ### ROBOT_SYSTEM_MODE_CONTROL An active connection is established with the robot controller and the robot system is cyclic commanded to stay in its actual position. The robot controller state is received in the cycle time of the robot controller. Requests via the MotionService and JoggingService will be processed and executed in this mode. Input/Output interaction is possible in this mode! **In this mode the robot system can be commanded to move.** ### ROBOT_SYSTEM_MODE_FREE_DRIVE Like ROBOT_SYSTEM_MODE_MONITOR a connection to the robot controller is established to only read the robot controller state. The difference is that the motion groups can be moved by the user (Free Drive). Thus, the servo motors are turned on. All move requests will be rejected in this mode! **This mode is not supported by every robot!** Use [getSupportedModes](getSupportedModes) to evaluate if the device support free drive.
3687
4473
  * @export
@@ -3945,37 +4731,6 @@ export const SettableRobotSystemMode = {
3945
4731
  export type SettableRobotSystemMode = typeof SettableRobotSystemMode[keyof typeof SettableRobotSystemMode];
3946
4732
 
3947
4733
 
3948
- /**
3949
- *
3950
- * @export
3951
- * @interface SingleMotionGroupCollisionScene
3952
- */
3953
- export interface SingleMotionGroupCollisionScene {
3954
- /**
3955
- * A collection of identifiable colliders.
3956
- * @type {{ [key: string]: Collider; }}
3957
- * @memberof SingleMotionGroupCollisionScene
3958
- */
3959
- 'static_colliders'?: { [key: string]: Collider; };
3960
- /**
3961
- * A link chain is a kinematic chain of links that is connected via joints. A motion group can be used to control the motion of the joints in a link chain. A link is a group of colliders that is attached to the link reference frame. The reference frame of a link is obtained after applying all sets of Denavit-Hartenberg-parameters from base to (including) the link index. This means that the reference frame of the link is on the rotation axis of the next joint in the kinematic chain. Example: For a motion group with 2 joints, the collider reference frame (CRF) for link 1 is on the rotation axis of joint 2. The chain looks like: - Origin >> Mounting >> Base >> (CRF Base) Joint 0 >> Link 0 >> (CRF Link 0) Joint 1 >> Link 1 >> (CRF Link 1) Flange (CRF Tool) >> TCP Adjacent links in the kinematic chain of the motion group are not checked for mutual collision.
3962
- * @type {Array<{ [key: string]: Collider; }>}
3963
- * @memberof SingleMotionGroupCollisionScene
3964
- */
3965
- 'link_chain'?: Array<{ [key: string]: Collider; }>;
3966
- /**
3967
- * Defines the shape of a tool. A tool is a dictionary of colliders. All colliders that make up a tool are attached to the flange frame of the motion group.
3968
- * @type {{ [key: string]: Collider; }}
3969
- * @memberof SingleMotionGroupCollisionScene
3970
- */
3971
- 'tool'?: { [key: string]: Collider; };
3972
- /**
3973
- * If true, self-collision detection is enabled for the motion group. See LinkChain documentation for details. Default is true.
3974
- * @type {boolean}
3975
- * @memberof SingleMotionGroupCollisionScene
3976
- */
3977
- 'motion_group_self_collision_detection'?: boolean;
3978
- }
3979
4734
  /**
3980
4735
  *
3981
4736
  * @export
@@ -4562,6 +5317,12 @@ export interface ValidationError {
4562
5317
  * @memberof ValidationError
4563
5318
  */
4564
5319
  'type': string;
5320
+ /**
5321
+ *
5322
+ * @type {{ [key: string]: any; }}
5323
+ * @memberof ValidationError
5324
+ */
5325
+ 'input': { [key: string]: any; };
4565
5326
  }
4566
5327
  /**
4567
5328
  * @type ValidationErrorLocInner
@@ -5209,163 +5970,1293 @@ export const ApplicationApiFactory = function (configuration?: Configuration, ba
5209
5970
  const localVarFp = ApplicationApiFp(configuration)
5210
5971
  return {
5211
5972
  /**
5212
- * 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.
5213
- * @summary Add Application
5973
+ * 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.
5974
+ * @summary Add Application
5975
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
5976
+ * @param {App} app
5977
+ * @param {number} [completionTimeout]
5978
+ * @param {*} [options] Override http request option.
5979
+ * @throws {RequiredError}
5980
+ */
5981
+ addApp(cell: string, app: App, completionTimeout?: number, options?: RawAxiosRequestConfig): AxiosPromise<void> {
5982
+ return localVarFp.addApp(cell, app, completionTimeout, options).then((request) => request(axios, basePath));
5983
+ },
5984
+ /**
5985
+ * Delete all GUI applications from the cell.
5986
+ * @summary Clear Applications
5987
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
5988
+ * @param {number} [completionTimeout]
5989
+ * @param {*} [options] Override http request option.
5990
+ * @throws {RequiredError}
5991
+ */
5992
+ clearApps(cell: string, completionTimeout?: number, options?: RawAxiosRequestConfig): AxiosPromise<void> {
5993
+ return localVarFp.clearApps(cell, completionTimeout, options).then((request) => request(axios, basePath));
5994
+ },
5995
+ /**
5996
+ * Delete a GUI application from the cell.
5997
+ * @summary Delete Application
5998
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
5999
+ * @param {string} app
6000
+ * @param {number} [completionTimeout]
6001
+ * @param {*} [options] Override http request option.
6002
+ * @throws {RequiredError}
6003
+ */
6004
+ deleteApp(cell: string, app: string, completionTimeout?: number, options?: RawAxiosRequestConfig): AxiosPromise<void> {
6005
+ return localVarFp.deleteApp(cell, app, completionTimeout, options).then((request) => request(axios, basePath));
6006
+ },
6007
+ /**
6008
+ * 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.
6009
+ * @summary Configuration
6010
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
6011
+ * @param {string} app
6012
+ * @param {*} [options] Override http request option.
6013
+ * @throws {RequiredError}
6014
+ */
6015
+ getApp(cell: string, app: string, options?: RawAxiosRequestConfig): AxiosPromise<App> {
6016
+ return localVarFp.getApp(cell, app, options).then((request) => request(axios, basePath));
6017
+ },
6018
+ /**
6019
+ * 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.
6020
+ * @summary List Applications
6021
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
6022
+ * @param {*} [options] Override http request option.
6023
+ * @throws {RequiredError}
6024
+ */
6025
+ listApps(cell: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<string>> {
6026
+ return localVarFp.listApps(cell, options).then((request) => request(axios, basePath));
6027
+ },
6028
+ /**
6029
+ * Update the configuration of a GUI application in the cell.
6030
+ * @summary Update Configuration
6031
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
6032
+ * @param {string} app
6033
+ * @param {App} app2
6034
+ * @param {number} [completionTimeout]
6035
+ * @param {*} [options] Override http request option.
6036
+ * @throws {RequiredError}
6037
+ */
6038
+ updateApp(cell: string, app: string, app2: App, completionTimeout?: number, options?: RawAxiosRequestConfig): AxiosPromise<void> {
6039
+ return localVarFp.updateApp(cell, app, app2, completionTimeout, options).then((request) => request(axios, basePath));
6040
+ },
6041
+ };
6042
+ };
6043
+
6044
+ /**
6045
+ * ApplicationApi - object-oriented interface
6046
+ * @export
6047
+ * @class ApplicationApi
6048
+ * @extends {BaseAPI}
6049
+ */
6050
+ export class ApplicationApi extends BaseAPI {
6051
+ /**
6052
+ * 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.
6053
+ * @summary Add Application
6054
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
6055
+ * @param {App} app
6056
+ * @param {number} [completionTimeout]
6057
+ * @param {*} [options] Override http request option.
6058
+ * @throws {RequiredError}
6059
+ * @memberof ApplicationApi
6060
+ */
6061
+ public addApp(cell: string, app: App, completionTimeout?: number, options?: RawAxiosRequestConfig) {
6062
+ return ApplicationApiFp(this.configuration).addApp(cell, app, completionTimeout, options).then((request) => request(this.axios, this.basePath));
6063
+ }
6064
+
6065
+ /**
6066
+ * Delete all GUI applications from the cell.
6067
+ * @summary Clear Applications
6068
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
6069
+ * @param {number} [completionTimeout]
6070
+ * @param {*} [options] Override http request option.
6071
+ * @throws {RequiredError}
6072
+ * @memberof ApplicationApi
6073
+ */
6074
+ public clearApps(cell: string, completionTimeout?: number, options?: RawAxiosRequestConfig) {
6075
+ return ApplicationApiFp(this.configuration).clearApps(cell, completionTimeout, options).then((request) => request(this.axios, this.basePath));
6076
+ }
6077
+
6078
+ /**
6079
+ * Delete a GUI application from the cell.
6080
+ * @summary Delete Application
6081
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
6082
+ * @param {string} app
6083
+ * @param {number} [completionTimeout]
6084
+ * @param {*} [options] Override http request option.
6085
+ * @throws {RequiredError}
6086
+ * @memberof ApplicationApi
6087
+ */
6088
+ public deleteApp(cell: string, app: string, completionTimeout?: number, options?: RawAxiosRequestConfig) {
6089
+ return ApplicationApiFp(this.configuration).deleteApp(cell, app, completionTimeout, options).then((request) => request(this.axios, this.basePath));
6090
+ }
6091
+
6092
+ /**
6093
+ * 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.
6094
+ * @summary Configuration
6095
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
6096
+ * @param {string} app
6097
+ * @param {*} [options] Override http request option.
6098
+ * @throws {RequiredError}
6099
+ * @memberof ApplicationApi
6100
+ */
6101
+ public getApp(cell: string, app: string, options?: RawAxiosRequestConfig) {
6102
+ return ApplicationApiFp(this.configuration).getApp(cell, app, options).then((request) => request(this.axios, this.basePath));
6103
+ }
6104
+
6105
+ /**
6106
+ * 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.
6107
+ * @summary List Applications
6108
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
6109
+ * @param {*} [options] Override http request option.
6110
+ * @throws {RequiredError}
6111
+ * @memberof ApplicationApi
6112
+ */
6113
+ public listApps(cell: string, options?: RawAxiosRequestConfig) {
6114
+ return ApplicationApiFp(this.configuration).listApps(cell, options).then((request) => request(this.axios, this.basePath));
6115
+ }
6116
+
6117
+ /**
6118
+ * Update the configuration of a GUI application in the cell.
6119
+ * @summary Update Configuration
6120
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
6121
+ * @param {string} app
6122
+ * @param {App} app2
6123
+ * @param {number} [completionTimeout]
6124
+ * @param {*} [options] Override http request option.
6125
+ * @throws {RequiredError}
6126
+ * @memberof ApplicationApi
6127
+ */
6128
+ public updateApp(cell: string, app: string, app2: App, completionTimeout?: number, options?: RawAxiosRequestConfig) {
6129
+ return ApplicationApiFp(this.configuration).updateApp(cell, app, app2, completionTimeout, options).then((request) => request(this.axios, this.basePath));
6130
+ }
6131
+ }
6132
+
6133
+
6134
+
6135
+ /**
6136
+ * BUSInputsOutputsApi - axios parameter creator
6137
+ * @export
6138
+ */
6139
+ export const BUSInputsOutputsApiAxiosParamCreator = function (configuration?: Configuration) {
6140
+ return {
6141
+ /**
6142
+ * Add a BUS Inputs/Outputs Service to the cell.
6143
+ * @summary Add Service
6144
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
6145
+ * @param {BusIOType} busIOType
6146
+ * @param {number} [completionTimeout]
6147
+ * @param {*} [options] Override http request option.
6148
+ * @throws {RequiredError}
6149
+ */
6150
+ addBusIOService: async (cell: string, busIOType: BusIOType, completionTimeout?: number, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
6151
+ // verify required parameter 'cell' is not null or undefined
6152
+ assertParamExists('addBusIOService', 'cell', cell)
6153
+ // verify required parameter 'busIOType' is not null or undefined
6154
+ assertParamExists('addBusIOService', 'busIOType', busIOType)
6155
+ const localVarPath = `/cells/{cell}/bus-ios`
6156
+ .replace(`{${"cell"}}`, encodeURIComponent(String(cell)));
6157
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
6158
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
6159
+ let baseOptions;
6160
+ if (configuration) {
6161
+ baseOptions = configuration.baseOptions;
6162
+ }
6163
+
6164
+ const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
6165
+ const localVarHeaderParameter = {} as any;
6166
+ const localVarQueryParameter = {} as any;
6167
+
6168
+ // authentication BasicAuth required
6169
+ // http basic authentication required
6170
+ setBasicAuthToObject(localVarRequestOptions, configuration)
6171
+
6172
+ // authentication BearerAuth required
6173
+ // http bearer authentication required
6174
+ await setBearerAuthToObject(localVarHeaderParameter, configuration)
6175
+
6176
+ if (completionTimeout !== undefined) {
6177
+ localVarQueryParameter['completion_timeout'] = completionTimeout;
6178
+ }
6179
+
6180
+
6181
+
6182
+ localVarHeaderParameter['Content-Type'] = 'application/json';
6183
+
6184
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
6185
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
6186
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
6187
+ localVarRequestOptions.data = serializeDataIfNeeded(busIOType, localVarRequestOptions, configuration)
6188
+
6189
+ return {
6190
+ url: toPathString(localVarUrlObj),
6191
+ options: localVarRequestOptions,
6192
+ };
6193
+ },
6194
+ /**
6195
+ * Adds an input/output to or updates an input/output on the PROFINET device.
6196
+ * @summary Add PROFINET Input/Output
6197
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
6198
+ * @param {string} io Unique identifier to address an Input/Output in the cell.
6199
+ * @param {ProfinetIOData} profinetIOData
6200
+ * @param {*} [options] Override http request option.
6201
+ * @throws {RequiredError}
6202
+ */
6203
+ addProfinetIO: async (cell: string, io: string, profinetIOData: ProfinetIOData, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
6204
+ // verify required parameter 'cell' is not null or undefined
6205
+ assertParamExists('addProfinetIO', 'cell', cell)
6206
+ // verify required parameter 'io' is not null or undefined
6207
+ assertParamExists('addProfinetIO', 'io', io)
6208
+ // verify required parameter 'profinetIOData' is not null or undefined
6209
+ assertParamExists('addProfinetIO', 'profinetIOData', profinetIOData)
6210
+ const localVarPath = `/cells/{cell}/bus-ios/profinet/ios/{io}`
6211
+ .replace(`{${"cell"}}`, encodeURIComponent(String(cell)))
6212
+ .replace(`{${"io"}}`, encodeURIComponent(String(io)));
6213
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
6214
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
6215
+ let baseOptions;
6216
+ if (configuration) {
6217
+ baseOptions = configuration.baseOptions;
6218
+ }
6219
+
6220
+ const localVarRequestOptions = { method: 'PUT', ...baseOptions, ...options};
6221
+ const localVarHeaderParameter = {} as any;
6222
+ const localVarQueryParameter = {} as any;
6223
+
6224
+ // authentication BasicAuth required
6225
+ // http basic authentication required
6226
+ setBasicAuthToObject(localVarRequestOptions, configuration)
6227
+
6228
+ // authentication BearerAuth required
6229
+ // http bearer authentication required
6230
+ await setBearerAuthToObject(localVarHeaderParameter, configuration)
6231
+
6232
+
6233
+
6234
+ localVarHeaderParameter['Content-Type'] = 'application/json';
6235
+
6236
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
6237
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
6238
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
6239
+ localVarRequestOptions.data = serializeDataIfNeeded(profinetIOData, localVarRequestOptions, configuration)
6240
+
6241
+ return {
6242
+ url: toPathString(localVarUrlObj),
6243
+ options: localVarRequestOptions,
6244
+ };
6245
+ },
6246
+ /**
6247
+ * Delete BUS Inputs/Outputs Service from the cell.
6248
+ * @summary Clear Service
6249
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
6250
+ * @param {number} [completionTimeout]
6251
+ * @param {*} [options] Override http request option.
6252
+ * @throws {RequiredError}
6253
+ */
6254
+ clearBusIOService: async (cell: string, completionTimeout?: number, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
6255
+ // verify required parameter 'cell' is not null or undefined
6256
+ assertParamExists('clearBusIOService', 'cell', cell)
6257
+ const localVarPath = `/cells/{cell}/bus-ios`
6258
+ .replace(`{${"cell"}}`, encodeURIComponent(String(cell)));
6259
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
6260
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
6261
+ let baseOptions;
6262
+ if (configuration) {
6263
+ baseOptions = configuration.baseOptions;
6264
+ }
6265
+
6266
+ const localVarRequestOptions = { method: 'DELETE', ...baseOptions, ...options};
6267
+ const localVarHeaderParameter = {} as any;
6268
+ const localVarQueryParameter = {} as any;
6269
+
6270
+ // authentication BasicAuth required
6271
+ // http basic authentication required
6272
+ setBasicAuthToObject(localVarRequestOptions, configuration)
6273
+
6274
+ // authentication BearerAuth required
6275
+ // http bearer authentication required
6276
+ await setBearerAuthToObject(localVarHeaderParameter, configuration)
6277
+
6278
+ if (completionTimeout !== undefined) {
6279
+ localVarQueryParameter['completion_timeout'] = completionTimeout;
6280
+ }
6281
+
6282
+
6283
+
6284
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
6285
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
6286
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
6287
+
6288
+ return {
6289
+ url: toPathString(localVarUrlObj),
6290
+ options: localVarRequestOptions,
6291
+ };
6292
+ },
6293
+ /**
6294
+ * Removes the input/output from the PROFINET device.
6295
+ * @summary Remove PROFINET Input/Ouptut
6296
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
6297
+ * @param {string} io Unique identifier to address an Input/Output in the cell.
6298
+ * @param {*} [options] Override http request option.
6299
+ * @throws {RequiredError}
6300
+ */
6301
+ deleteProfinetIO: async (cell: string, io: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
6302
+ // verify required parameter 'cell' is not null or undefined
6303
+ assertParamExists('deleteProfinetIO', 'cell', cell)
6304
+ // verify required parameter 'io' is not null or undefined
6305
+ assertParamExists('deleteProfinetIO', 'io', io)
6306
+ const localVarPath = `/cells/{cell}/bus-ios/profinet/ios/{io}`
6307
+ .replace(`{${"cell"}}`, encodeURIComponent(String(cell)))
6308
+ .replace(`{${"io"}}`, encodeURIComponent(String(io)));
6309
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
6310
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
6311
+ let baseOptions;
6312
+ if (configuration) {
6313
+ baseOptions = configuration.baseOptions;
6314
+ }
6315
+
6316
+ const localVarRequestOptions = { method: 'DELETE', ...baseOptions, ...options};
6317
+ const localVarHeaderParameter = {} as any;
6318
+ const localVarQueryParameter = {} as any;
6319
+
6320
+ // authentication BasicAuth required
6321
+ // http basic authentication required
6322
+ setBasicAuthToObject(localVarRequestOptions, configuration)
6323
+
6324
+ // authentication BearerAuth required
6325
+ // http bearer authentication required
6326
+ await setBearerAuthToObject(localVarHeaderParameter, configuration)
6327
+
6328
+
6329
+
6330
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
6331
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
6332
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
6333
+
6334
+ return {
6335
+ url: toPathString(localVarUrlObj),
6336
+ options: localVarRequestOptions,
6337
+ };
6338
+ },
6339
+ /**
6340
+ * Get deployed BUS Inputs/Outputs Service.
6341
+ * @summary Get Service
6342
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
6343
+ * @param {*} [options] Override http request option.
6344
+ * @throws {RequiredError}
6345
+ */
6346
+ getBusIOService: async (cell: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
6347
+ // verify required parameter 'cell' is not null or undefined
6348
+ assertParamExists('getBusIOService', 'cell', cell)
6349
+ const localVarPath = `/cells/{cell}/bus-ios`
6350
+ .replace(`{${"cell"}}`, encodeURIComponent(String(cell)));
6351
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
6352
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
6353
+ let baseOptions;
6354
+ if (configuration) {
6355
+ baseOptions = configuration.baseOptions;
6356
+ }
6357
+
6358
+ const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
6359
+ const localVarHeaderParameter = {} as any;
6360
+ const localVarQueryParameter = {} as any;
6361
+
6362
+ // authentication BasicAuth required
6363
+ // http basic authentication required
6364
+ setBasicAuthToObject(localVarRequestOptions, configuration)
6365
+
6366
+ // authentication BearerAuth required
6367
+ // http bearer authentication required
6368
+ await setBearerAuthToObject(localVarHeaderParameter, configuration)
6369
+
6370
+
6371
+
6372
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
6373
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
6374
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
6375
+
6376
+ return {
6377
+ url: toPathString(localVarUrlObj),
6378
+ options: localVarRequestOptions,
6379
+ };
6380
+ },
6381
+ /**
6382
+ * Get the current state of the BUS Inputs/Outputs service.
6383
+ * @summary State
6384
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
6385
+ * @param {*} [options] Override http request option.
6386
+ * @throws {RequiredError}
6387
+ */
6388
+ getBusIOState: async (cell: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
6389
+ // verify required parameter 'cell' is not null or undefined
6390
+ assertParamExists('getBusIOState', 'cell', cell)
6391
+ const localVarPath = `/cells/{cell}/bus-ios/state`
6392
+ .replace(`{${"cell"}}`, encodeURIComponent(String(cell)));
6393
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
6394
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
6395
+ let baseOptions;
6396
+ if (configuration) {
6397
+ baseOptions = configuration.baseOptions;
6398
+ }
6399
+
6400
+ const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
6401
+ const localVarHeaderParameter = {} as any;
6402
+ const localVarQueryParameter = {} as any;
6403
+
6404
+ // authentication BasicAuth required
6405
+ // http basic authentication required
6406
+ setBasicAuthToObject(localVarRequestOptions, configuration)
6407
+
6408
+ // authentication BearerAuth required
6409
+ // http bearer authentication required
6410
+ await setBearerAuthToObject(localVarHeaderParameter, configuration)
6411
+
6412
+
6413
+
6414
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
6415
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
6416
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
6417
+
6418
+ return {
6419
+ url: toPathString(localVarUrlObj),
6420
+ options: localVarRequestOptions,
6421
+ };
6422
+ },
6423
+ /**
6424
+ * 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).
6425
+ * @summary Get Input/Output Values
6426
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
6427
+ * @param {Array<string>} [ios]
6428
+ * @param {*} [options] Override http request option.
6429
+ * @throws {RequiredError}
6430
+ */
6431
+ getBusIOValues: async (cell: string, ios?: Array<string>, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
6432
+ // verify required parameter 'cell' is not null or undefined
6433
+ assertParamExists('getBusIOValues', 'cell', cell)
6434
+ const localVarPath = `/cells/{cell}/bus-ios/ios/values`
6435
+ .replace(`{${"cell"}}`, encodeURIComponent(String(cell)));
6436
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
6437
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
6438
+ let baseOptions;
6439
+ if (configuration) {
6440
+ baseOptions = configuration.baseOptions;
6441
+ }
6442
+
6443
+ const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
6444
+ const localVarHeaderParameter = {} as any;
6445
+ const localVarQueryParameter = {} as any;
6446
+
6447
+ // authentication BasicAuth required
6448
+ // http basic authentication required
6449
+ setBasicAuthToObject(localVarRequestOptions, configuration)
6450
+
6451
+ // authentication BearerAuth required
6452
+ // http bearer authentication required
6453
+ await setBearerAuthToObject(localVarHeaderParameter, configuration)
6454
+
6455
+ if (ios) {
6456
+ localVarQueryParameter['ios'] = ios;
6457
+ }
6458
+
6459
+
6460
+
6461
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
6462
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
6463
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
6464
+
6465
+ return {
6466
+ url: toPathString(localVarUrlObj),
6467
+ options: localVarRequestOptions,
6468
+ };
6469
+ },
6470
+ /**
6471
+ * Get description of PROFINET
6472
+ * @summary Get PROFINET Description
6473
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
6474
+ * @param {*} [options] Override http request option.
6475
+ * @throws {RequiredError}
6476
+ */
6477
+ getProfinetDescription: async (cell: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
6478
+ // verify required parameter 'cell' is not null or undefined
6479
+ assertParamExists('getProfinetDescription', 'cell', cell)
6480
+ const localVarPath = `/cells/{cell}/bus-ios/profinet/description`
6481
+ .replace(`{${"cell"}}`, encodeURIComponent(String(cell)));
6482
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
6483
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
6484
+ let baseOptions;
6485
+ if (configuration) {
6486
+ baseOptions = configuration.baseOptions;
6487
+ }
6488
+
6489
+ const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
6490
+ const localVarHeaderParameter = {} as any;
6491
+ const localVarQueryParameter = {} as any;
6492
+
6493
+ // authentication BasicAuth required
6494
+ // http basic authentication required
6495
+ setBasicAuthToObject(localVarRequestOptions, configuration)
6496
+
6497
+ // authentication BearerAuth required
6498
+ // http bearer authentication required
6499
+ await setBearerAuthToObject(localVarHeaderParameter, configuration)
6500
+
6501
+
6502
+
6503
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
6504
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
6505
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
6506
+
6507
+ return {
6508
+ url: toPathString(localVarUrlObj),
6509
+ options: localVarRequestOptions,
6510
+ };
6511
+ },
6512
+ /**
6513
+ * Get input/output configuration of the PROFINET device as file.
6514
+ * @summary PROFINET Inputs/Outputs to File
6515
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
6516
+ * @param {number} [inputOffset]
6517
+ * @param {number} [outputOffset]
6518
+ * @param {*} [options] Override http request option.
6519
+ * @throws {RequiredError}
6520
+ */
6521
+ getProfinetIOsFromFile: async (cell: string, inputOffset?: number, outputOffset?: number, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
6522
+ // verify required parameter 'cell' is not null or undefined
6523
+ assertParamExists('getProfinetIOsFromFile', 'cell', cell)
6524
+ const localVarPath = `/cells/{cell}/bus-ios/profinet/iofile`
6525
+ .replace(`{${"cell"}}`, encodeURIComponent(String(cell)));
6526
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
6527
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
6528
+ let baseOptions;
6529
+ if (configuration) {
6530
+ baseOptions = configuration.baseOptions;
6531
+ }
6532
+
6533
+ const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
6534
+ const localVarHeaderParameter = {} as any;
6535
+ const localVarQueryParameter = {} as any;
6536
+
6537
+ // authentication BasicAuth required
6538
+ // http basic authentication required
6539
+ setBasicAuthToObject(localVarRequestOptions, configuration)
6540
+
6541
+ // authentication BearerAuth required
6542
+ // http bearer authentication required
6543
+ await setBearerAuthToObject(localVarHeaderParameter, configuration)
6544
+
6545
+ if (inputOffset !== undefined) {
6546
+ localVarQueryParameter['input_offset'] = inputOffset;
6547
+ }
6548
+
6549
+ if (outputOffset !== undefined) {
6550
+ localVarQueryParameter['output_offset'] = outputOffset;
6551
+ }
6552
+
6553
+
6554
+
6555
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
6556
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
6557
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
6558
+
6559
+ return {
6560
+ url: toPathString(localVarUrlObj),
6561
+ options: localVarRequestOptions,
6562
+ };
6563
+ },
6564
+ /**
6565
+ * List all BUS Input/Output descriptions.
6566
+ * @summary List Descriptions
6567
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
6568
+ * @param {*} [options] Override http request option.
6569
+ * @throws {RequiredError}
6570
+ */
6571
+ listBusIODescriptions: async (cell: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
6572
+ // verify required parameter 'cell' is not null or undefined
6573
+ assertParamExists('listBusIODescriptions', 'cell', cell)
6574
+ const localVarPath = `/cells/{cell}/bus-ios/ios/description`
6575
+ .replace(`{${"cell"}}`, encodeURIComponent(String(cell)));
6576
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
6577
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
6578
+ let baseOptions;
6579
+ if (configuration) {
6580
+ baseOptions = configuration.baseOptions;
6581
+ }
6582
+
6583
+ const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
6584
+ const localVarHeaderParameter = {} as any;
6585
+ const localVarQueryParameter = {} as any;
6586
+
6587
+ // authentication BasicAuth required
6588
+ // http basic authentication required
6589
+ setBasicAuthToObject(localVarRequestOptions, configuration)
6590
+
6591
+ // authentication BearerAuth required
6592
+ // http bearer authentication required
6593
+ await setBearerAuthToObject(localVarHeaderParameter, configuration)
6594
+
6595
+
6596
+
6597
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
6598
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
6599
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
6600
+
6601
+ return {
6602
+ url: toPathString(localVarUrlObj),
6603
+ options: localVarRequestOptions,
6604
+ };
6605
+ },
6606
+ /**
6607
+ * List all PROFINET input and outputs.
6608
+ * @summary List PROFINET Input/Output Configuration
6609
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
6610
+ * @param {*} [options] Override http request option.
6611
+ * @throws {RequiredError}
6612
+ */
6613
+ listProfinetIOs: async (cell: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
6614
+ // verify required parameter 'cell' is not null or undefined
6615
+ assertParamExists('listProfinetIOs', 'cell', cell)
6616
+ const localVarPath = `/cells/{cell}/bus-ios/profinet/ios`
6617
+ .replace(`{${"cell"}}`, encodeURIComponent(String(cell)));
6618
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
6619
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
6620
+ let baseOptions;
6621
+ if (configuration) {
6622
+ baseOptions = configuration.baseOptions;
6623
+ }
6624
+
6625
+ const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
6626
+ const localVarHeaderParameter = {} as any;
6627
+ const localVarQueryParameter = {} as any;
6628
+
6629
+ // authentication BasicAuth required
6630
+ // http basic authentication required
6631
+ setBasicAuthToObject(localVarRequestOptions, configuration)
6632
+
6633
+ // authentication BearerAuth required
6634
+ // http bearer authentication required
6635
+ await setBearerAuthToObject(localVarHeaderParameter, configuration)
6636
+
6637
+
6638
+
6639
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
6640
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
6641
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
6642
+
6643
+ return {
6644
+ url: toPathString(localVarUrlObj),
6645
+ options: localVarRequestOptions,
6646
+ };
6647
+ },
6648
+ /**
6649
+ * 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.
6650
+ * @summary Set Output Values
6651
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
6652
+ * @param {Array<IOValue>} iOValue
6653
+ * @param {*} [options] Override http request option.
6654
+ * @throws {RequiredError}
6655
+ */
6656
+ setBusIOValues: async (cell: string, iOValue: Array<IOValue>, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
6657
+ // verify required parameter 'cell' is not null or undefined
6658
+ assertParamExists('setBusIOValues', 'cell', cell)
6659
+ // verify required parameter 'iOValue' is not null or undefined
6660
+ assertParamExists('setBusIOValues', 'iOValue', iOValue)
6661
+ const localVarPath = `/cells/{cell}/bus-ios/ios/values`
6662
+ .replace(`{${"cell"}}`, encodeURIComponent(String(cell)));
6663
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
6664
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
6665
+ let baseOptions;
6666
+ if (configuration) {
6667
+ baseOptions = configuration.baseOptions;
6668
+ }
6669
+
6670
+ const localVarRequestOptions = { method: 'PUT', ...baseOptions, ...options};
6671
+ const localVarHeaderParameter = {} as any;
6672
+ const localVarQueryParameter = {} as any;
6673
+
6674
+ // authentication BasicAuth required
6675
+ // http basic authentication required
6676
+ setBasicAuthToObject(localVarRequestOptions, configuration)
6677
+
6678
+ // authentication BearerAuth required
6679
+ // http bearer authentication required
6680
+ await setBearerAuthToObject(localVarHeaderParameter, configuration)
6681
+
6682
+
6683
+
6684
+ localVarHeaderParameter['Content-Type'] = 'application/json';
6685
+
6686
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
6687
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
6688
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
6689
+ localVarRequestOptions.data = serializeDataIfNeeded(iOValue, localVarRequestOptions, configuration)
6690
+
6691
+ return {
6692
+ url: toPathString(localVarUrlObj),
6693
+ options: localVarRequestOptions,
6694
+ };
6695
+ },
6696
+ /**
6697
+ * Sets inputs/outputs on the PROFINET device from file.
6698
+ * @summary Set PROFINET Inputs/Outputs from File
6699
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
6700
+ * @param {ProfinetInputOutputConfig} profinetInputOutputConfig
6701
+ * @param {*} [options] Override http request option.
6702
+ * @throws {RequiredError}
6703
+ */
6704
+ setProfinetIOsFromFile: async (cell: string, profinetInputOutputConfig: ProfinetInputOutputConfig, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
6705
+ // verify required parameter 'cell' is not null or undefined
6706
+ assertParamExists('setProfinetIOsFromFile', 'cell', cell)
6707
+ // verify required parameter 'profinetInputOutputConfig' is not null or undefined
6708
+ assertParamExists('setProfinetIOsFromFile', 'profinetInputOutputConfig', profinetInputOutputConfig)
6709
+ const localVarPath = `/cells/{cell}/bus-ios/profinet/iofile`
6710
+ .replace(`{${"cell"}}`, encodeURIComponent(String(cell)));
6711
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
6712
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
6713
+ let baseOptions;
6714
+ if (configuration) {
6715
+ baseOptions = configuration.baseOptions;
6716
+ }
6717
+
6718
+ const localVarRequestOptions = { method: 'PUT', ...baseOptions, ...options};
6719
+ const localVarHeaderParameter = {} as any;
6720
+ const localVarQueryParameter = {} as any;
6721
+
6722
+ // authentication BasicAuth required
6723
+ // http basic authentication required
6724
+ setBasicAuthToObject(localVarRequestOptions, configuration)
6725
+
6726
+ // authentication BearerAuth required
6727
+ // http bearer authentication required
6728
+ await setBearerAuthToObject(localVarHeaderParameter, configuration)
6729
+
6730
+
6731
+
6732
+ localVarHeaderParameter['Content-Type'] = 'application/json';
6733
+
6734
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
6735
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
6736
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
6737
+ localVarRequestOptions.data = serializeDataIfNeeded(profinetInputOutputConfig, localVarRequestOptions, configuration)
6738
+
6739
+ return {
6740
+ url: toPathString(localVarUrlObj),
6741
+ options: localVarRequestOptions,
6742
+ };
6743
+ },
6744
+ }
6745
+ };
6746
+
6747
+ /**
6748
+ * BUSInputsOutputsApi - functional programming interface
6749
+ * @export
6750
+ */
6751
+ export const BUSInputsOutputsApiFp = function(configuration?: Configuration) {
6752
+ const localVarAxiosParamCreator = BUSInputsOutputsApiAxiosParamCreator(configuration)
6753
+ return {
6754
+ /**
6755
+ * Add a BUS Inputs/Outputs Service to the cell.
6756
+ * @summary Add Service
6757
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
6758
+ * @param {BusIOType} busIOType
6759
+ * @param {number} [completionTimeout]
6760
+ * @param {*} [options] Override http request option.
6761
+ * @throws {RequiredError}
6762
+ */
6763
+ async addBusIOService(cell: string, busIOType: BusIOType, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> {
6764
+ const localVarAxiosArgs = await localVarAxiosParamCreator.addBusIOService(cell, busIOType, completionTimeout, options);
6765
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
6766
+ const localVarOperationServerBasePath = operationServerMap['BUSInputsOutputsApi.addBusIOService']?.[localVarOperationServerIndex]?.url;
6767
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
6768
+ },
6769
+ /**
6770
+ * Adds an input/output to or updates an input/output on the PROFINET device.
6771
+ * @summary Add PROFINET Input/Output
6772
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
6773
+ * @param {string} io Unique identifier to address an Input/Output in the cell.
6774
+ * @param {ProfinetIOData} profinetIOData
6775
+ * @param {*} [options] Override http request option.
6776
+ * @throws {RequiredError}
6777
+ */
6778
+ async addProfinetIO(cell: string, io: string, profinetIOData: ProfinetIOData, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> {
6779
+ const localVarAxiosArgs = await localVarAxiosParamCreator.addProfinetIO(cell, io, profinetIOData, options);
6780
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
6781
+ const localVarOperationServerBasePath = operationServerMap['BUSInputsOutputsApi.addProfinetIO']?.[localVarOperationServerIndex]?.url;
6782
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
6783
+ },
6784
+ /**
6785
+ * Delete BUS Inputs/Outputs Service from the cell.
6786
+ * @summary Clear Service
6787
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
6788
+ * @param {number} [completionTimeout]
6789
+ * @param {*} [options] Override http request option.
6790
+ * @throws {RequiredError}
6791
+ */
6792
+ async clearBusIOService(cell: string, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> {
6793
+ const localVarAxiosArgs = await localVarAxiosParamCreator.clearBusIOService(cell, completionTimeout, options);
6794
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
6795
+ const localVarOperationServerBasePath = operationServerMap['BUSInputsOutputsApi.clearBusIOService']?.[localVarOperationServerIndex]?.url;
6796
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
6797
+ },
6798
+ /**
6799
+ * Removes the input/output from the PROFINET device.
6800
+ * @summary Remove PROFINET Input/Ouptut
6801
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
6802
+ * @param {string} io Unique identifier to address an Input/Output in the cell.
6803
+ * @param {*} [options] Override http request option.
6804
+ * @throws {RequiredError}
6805
+ */
6806
+ async deleteProfinetIO(cell: string, io: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> {
6807
+ const localVarAxiosArgs = await localVarAxiosParamCreator.deleteProfinetIO(cell, io, options);
6808
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
6809
+ const localVarOperationServerBasePath = operationServerMap['BUSInputsOutputsApi.deleteProfinetIO']?.[localVarOperationServerIndex]?.url;
6810
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
6811
+ },
6812
+ /**
6813
+ * Get deployed BUS Inputs/Outputs Service.
6814
+ * @summary Get Service
6815
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
6816
+ * @param {*} [options] Override http request option.
6817
+ * @throws {RequiredError}
6818
+ */
6819
+ async getBusIOService(cell: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BusIOType>> {
6820
+ const localVarAxiosArgs = await localVarAxiosParamCreator.getBusIOService(cell, options);
6821
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
6822
+ const localVarOperationServerBasePath = operationServerMap['BUSInputsOutputsApi.getBusIOService']?.[localVarOperationServerIndex]?.url;
6823
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
6824
+ },
6825
+ /**
6826
+ * Get the current state of the BUS Inputs/Outputs service.
6827
+ * @summary State
6828
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
6829
+ * @param {*} [options] Override http request option.
6830
+ * @throws {RequiredError}
6831
+ */
6832
+ async getBusIOState(cell: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BusIOsState>> {
6833
+ const localVarAxiosArgs = await localVarAxiosParamCreator.getBusIOState(cell, options);
6834
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
6835
+ const localVarOperationServerBasePath = operationServerMap['BUSInputsOutputsApi.getBusIOState']?.[localVarOperationServerIndex]?.url;
6836
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
6837
+ },
6838
+ /**
6839
+ * 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).
6840
+ * @summary Get Input/Output Values
6841
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
6842
+ * @param {Array<string>} [ios]
6843
+ * @param {*} [options] Override http request option.
6844
+ * @throws {RequiredError}
6845
+ */
6846
+ async getBusIOValues(cell: string, ios?: Array<string>, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<IOValue>>> {
6847
+ const localVarAxiosArgs = await localVarAxiosParamCreator.getBusIOValues(cell, ios, options);
6848
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
6849
+ const localVarOperationServerBasePath = operationServerMap['BUSInputsOutputsApi.getBusIOValues']?.[localVarOperationServerIndex]?.url;
6850
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
6851
+ },
6852
+ /**
6853
+ * Get description of PROFINET
6854
+ * @summary Get PROFINET Description
6855
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
6856
+ * @param {*} [options] Override http request option.
6857
+ * @throws {RequiredError}
6858
+ */
6859
+ async getProfinetDescription(cell: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ProfinetDescription>> {
6860
+ const localVarAxiosArgs = await localVarAxiosParamCreator.getProfinetDescription(cell, options);
6861
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
6862
+ const localVarOperationServerBasePath = operationServerMap['BUSInputsOutputsApi.getProfinetDescription']?.[localVarOperationServerIndex]?.url;
6863
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
6864
+ },
6865
+ /**
6866
+ * Get input/output configuration of the PROFINET device as file.
6867
+ * @summary PROFINET Inputs/Outputs to File
6868
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
6869
+ * @param {number} [inputOffset]
6870
+ * @param {number} [outputOffset]
6871
+ * @param {*} [options] Override http request option.
6872
+ * @throws {RequiredError}
6873
+ */
6874
+ async getProfinetIOsFromFile(cell: string, inputOffset?: number, outputOffset?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<string>> {
6875
+ const localVarAxiosArgs = await localVarAxiosParamCreator.getProfinetIOsFromFile(cell, inputOffset, outputOffset, options);
6876
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
6877
+ const localVarOperationServerBasePath = operationServerMap['BUSInputsOutputsApi.getProfinetIOsFromFile']?.[localVarOperationServerIndex]?.url;
6878
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
6879
+ },
6880
+ /**
6881
+ * List all BUS Input/Output descriptions.
6882
+ * @summary List Descriptions
6883
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
6884
+ * @param {*} [options] Override http request option.
6885
+ * @throws {RequiredError}
6886
+ */
6887
+ async listBusIODescriptions(cell: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<IODescription>>> {
6888
+ const localVarAxiosArgs = await localVarAxiosParamCreator.listBusIODescriptions(cell, options);
6889
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
6890
+ const localVarOperationServerBasePath = operationServerMap['BUSInputsOutputsApi.listBusIODescriptions']?.[localVarOperationServerIndex]?.url;
6891
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
6892
+ },
6893
+ /**
6894
+ * List all PROFINET input and outputs.
6895
+ * @summary List PROFINET Input/Output Configuration
6896
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
6897
+ * @param {*} [options] Override http request option.
6898
+ * @throws {RequiredError}
6899
+ */
6900
+ async listProfinetIOs(cell: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<ProfinetIO>>> {
6901
+ const localVarAxiosArgs = await localVarAxiosParamCreator.listProfinetIOs(cell, options);
6902
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
6903
+ const localVarOperationServerBasePath = operationServerMap['BUSInputsOutputsApi.listProfinetIOs']?.[localVarOperationServerIndex]?.url;
6904
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
6905
+ },
6906
+ /**
6907
+ * 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.
6908
+ * @summary Set Output Values
6909
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
6910
+ * @param {Array<IOValue>} iOValue
6911
+ * @param {*} [options] Override http request option.
6912
+ * @throws {RequiredError}
6913
+ */
6914
+ async setBusIOValues(cell: string, iOValue: Array<IOValue>, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> {
6915
+ const localVarAxiosArgs = await localVarAxiosParamCreator.setBusIOValues(cell, iOValue, options);
6916
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
6917
+ const localVarOperationServerBasePath = operationServerMap['BUSInputsOutputsApi.setBusIOValues']?.[localVarOperationServerIndex]?.url;
6918
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
6919
+ },
6920
+ /**
6921
+ * Sets inputs/outputs on the PROFINET device from file.
6922
+ * @summary Set PROFINET Inputs/Outputs from File
6923
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
6924
+ * @param {ProfinetInputOutputConfig} profinetInputOutputConfig
6925
+ * @param {*} [options] Override http request option.
6926
+ * @throws {RequiredError}
6927
+ */
6928
+ async setProfinetIOsFromFile(cell: string, profinetInputOutputConfig: ProfinetInputOutputConfig, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> {
6929
+ const localVarAxiosArgs = await localVarAxiosParamCreator.setProfinetIOsFromFile(cell, profinetInputOutputConfig, options);
6930
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
6931
+ const localVarOperationServerBasePath = operationServerMap['BUSInputsOutputsApi.setProfinetIOsFromFile']?.[localVarOperationServerIndex]?.url;
6932
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
6933
+ },
6934
+ }
6935
+ };
6936
+
6937
+ /**
6938
+ * BUSInputsOutputsApi - factory interface
6939
+ * @export
6940
+ */
6941
+ export const BUSInputsOutputsApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
6942
+ const localVarFp = BUSInputsOutputsApiFp(configuration)
6943
+ return {
6944
+ /**
6945
+ * Add a BUS Inputs/Outputs Service to the cell.
6946
+ * @summary Add Service
6947
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
6948
+ * @param {BusIOType} busIOType
6949
+ * @param {number} [completionTimeout]
6950
+ * @param {*} [options] Override http request option.
6951
+ * @throws {RequiredError}
6952
+ */
6953
+ addBusIOService(cell: string, busIOType: BusIOType, completionTimeout?: number, options?: RawAxiosRequestConfig): AxiosPromise<void> {
6954
+ return localVarFp.addBusIOService(cell, busIOType, completionTimeout, options).then((request) => request(axios, basePath));
6955
+ },
6956
+ /**
6957
+ * Adds an input/output to or updates an input/output on the PROFINET device.
6958
+ * @summary Add PROFINET Input/Output
6959
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
6960
+ * @param {string} io Unique identifier to address an Input/Output in the cell.
6961
+ * @param {ProfinetIOData} profinetIOData
6962
+ * @param {*} [options] Override http request option.
6963
+ * @throws {RequiredError}
6964
+ */
6965
+ addProfinetIO(cell: string, io: string, profinetIOData: ProfinetIOData, options?: RawAxiosRequestConfig): AxiosPromise<void> {
6966
+ return localVarFp.addProfinetIO(cell, io, profinetIOData, options).then((request) => request(axios, basePath));
6967
+ },
6968
+ /**
6969
+ * Delete BUS Inputs/Outputs Service from the cell.
6970
+ * @summary Clear Service
6971
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
6972
+ * @param {number} [completionTimeout]
6973
+ * @param {*} [options] Override http request option.
6974
+ * @throws {RequiredError}
6975
+ */
6976
+ clearBusIOService(cell: string, completionTimeout?: number, options?: RawAxiosRequestConfig): AxiosPromise<void> {
6977
+ return localVarFp.clearBusIOService(cell, completionTimeout, options).then((request) => request(axios, basePath));
6978
+ },
6979
+ /**
6980
+ * Removes the input/output from the PROFINET device.
6981
+ * @summary Remove PROFINET Input/Ouptut
6982
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
6983
+ * @param {string} io Unique identifier to address an Input/Output in the cell.
6984
+ * @param {*} [options] Override http request option.
6985
+ * @throws {RequiredError}
6986
+ */
6987
+ deleteProfinetIO(cell: string, io: string, options?: RawAxiosRequestConfig): AxiosPromise<void> {
6988
+ return localVarFp.deleteProfinetIO(cell, io, options).then((request) => request(axios, basePath));
6989
+ },
6990
+ /**
6991
+ * Get deployed BUS Inputs/Outputs Service.
6992
+ * @summary Get Service
6993
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
6994
+ * @param {*} [options] Override http request option.
6995
+ * @throws {RequiredError}
6996
+ */
6997
+ getBusIOService(cell: string, options?: RawAxiosRequestConfig): AxiosPromise<BusIOType> {
6998
+ return localVarFp.getBusIOService(cell, options).then((request) => request(axios, basePath));
6999
+ },
7000
+ /**
7001
+ * Get the current state of the BUS Inputs/Outputs service.
7002
+ * @summary State
7003
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
7004
+ * @param {*} [options] Override http request option.
7005
+ * @throws {RequiredError}
7006
+ */
7007
+ getBusIOState(cell: string, options?: RawAxiosRequestConfig): AxiosPromise<BusIOsState> {
7008
+ return localVarFp.getBusIOState(cell, options).then((request) => request(axios, basePath));
7009
+ },
7010
+ /**
7011
+ * 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).
7012
+ * @summary Get Input/Output Values
7013
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
7014
+ * @param {Array<string>} [ios]
7015
+ * @param {*} [options] Override http request option.
7016
+ * @throws {RequiredError}
7017
+ */
7018
+ getBusIOValues(cell: string, ios?: Array<string>, options?: RawAxiosRequestConfig): AxiosPromise<Array<IOValue>> {
7019
+ return localVarFp.getBusIOValues(cell, ios, options).then((request) => request(axios, basePath));
7020
+ },
7021
+ /**
7022
+ * Get description of PROFINET
7023
+ * @summary Get PROFINET Description
5214
7024
  * @param {string} cell Unique identifier addressing a cell in all API calls.
5215
- * @param {App} app
5216
- * @param {number} [completionTimeout]
5217
7025
  * @param {*} [options] Override http request option.
5218
7026
  * @throws {RequiredError}
5219
7027
  */
5220
- addApp(cell: string, app: App, completionTimeout?: number, options?: RawAxiosRequestConfig): AxiosPromise<void> {
5221
- return localVarFp.addApp(cell, app, completionTimeout, options).then((request) => request(axios, basePath));
7028
+ getProfinetDescription(cell: string, options?: RawAxiosRequestConfig): AxiosPromise<ProfinetDescription> {
7029
+ return localVarFp.getProfinetDescription(cell, options).then((request) => request(axios, basePath));
5222
7030
  },
5223
7031
  /**
5224
- * Delete all GUI applications from the cell.
5225
- * @summary Clear Applications
7032
+ * Get input/output configuration of the PROFINET device as file.
7033
+ * @summary PROFINET Inputs/Outputs to File
5226
7034
  * @param {string} cell Unique identifier addressing a cell in all API calls.
5227
- * @param {number} [completionTimeout]
7035
+ * @param {number} [inputOffset]
7036
+ * @param {number} [outputOffset]
5228
7037
  * @param {*} [options] Override http request option.
5229
7038
  * @throws {RequiredError}
5230
7039
  */
5231
- clearApps(cell: string, completionTimeout?: number, options?: RawAxiosRequestConfig): AxiosPromise<void> {
5232
- return localVarFp.clearApps(cell, completionTimeout, options).then((request) => request(axios, basePath));
7040
+ getProfinetIOsFromFile(cell: string, inputOffset?: number, outputOffset?: number, options?: RawAxiosRequestConfig): AxiosPromise<string> {
7041
+ return localVarFp.getProfinetIOsFromFile(cell, inputOffset, outputOffset, options).then((request) => request(axios, basePath));
5233
7042
  },
5234
7043
  /**
5235
- * Delete a GUI application from the cell.
5236
- * @summary Delete Application
7044
+ * List all BUS Input/Output descriptions.
7045
+ * @summary List Descriptions
5237
7046
  * @param {string} cell Unique identifier addressing a cell in all API calls.
5238
- * @param {string} app
5239
- * @param {number} [completionTimeout]
5240
7047
  * @param {*} [options] Override http request option.
5241
7048
  * @throws {RequiredError}
5242
7049
  */
5243
- deleteApp(cell: string, app: string, completionTimeout?: number, options?: RawAxiosRequestConfig): AxiosPromise<void> {
5244
- return localVarFp.deleteApp(cell, app, completionTimeout, options).then((request) => request(axios, basePath));
7050
+ listBusIODescriptions(cell: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<IODescription>> {
7051
+ return localVarFp.listBusIODescriptions(cell, options).then((request) => request(axios, basePath));
5245
7052
  },
5246
7053
  /**
5247
- * 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.
5248
- * @summary Configuration
7054
+ * List all PROFINET input and outputs.
7055
+ * @summary List PROFINET Input/Output Configuration
5249
7056
  * @param {string} cell Unique identifier addressing a cell in all API calls.
5250
- * @param {string} app
5251
7057
  * @param {*} [options] Override http request option.
5252
7058
  * @throws {RequiredError}
5253
7059
  */
5254
- getApp(cell: string, app: string, options?: RawAxiosRequestConfig): AxiosPromise<App> {
5255
- return localVarFp.getApp(cell, app, options).then((request) => request(axios, basePath));
7060
+ listProfinetIOs(cell: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<ProfinetIO>> {
7061
+ return localVarFp.listProfinetIOs(cell, options).then((request) => request(axios, basePath));
5256
7062
  },
5257
7063
  /**
5258
- * 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.
5259
- * @summary List Applications
7064
+ * 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.
7065
+ * @summary Set Output Values
5260
7066
  * @param {string} cell Unique identifier addressing a cell in all API calls.
7067
+ * @param {Array<IOValue>} iOValue
5261
7068
  * @param {*} [options] Override http request option.
5262
7069
  * @throws {RequiredError}
5263
7070
  */
5264
- listApps(cell: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<string>> {
5265
- return localVarFp.listApps(cell, options).then((request) => request(axios, basePath));
7071
+ setBusIOValues(cell: string, iOValue: Array<IOValue>, options?: RawAxiosRequestConfig): AxiosPromise<void> {
7072
+ return localVarFp.setBusIOValues(cell, iOValue, options).then((request) => request(axios, basePath));
5266
7073
  },
5267
7074
  /**
5268
- * Update the configuration of a GUI application in the cell.
5269
- * @summary Update Configuration
7075
+ * Sets inputs/outputs on the PROFINET device from file.
7076
+ * @summary Set PROFINET Inputs/Outputs from File
5270
7077
  * @param {string} cell Unique identifier addressing a cell in all API calls.
5271
- * @param {string} app
5272
- * @param {App} app2
5273
- * @param {number} [completionTimeout]
7078
+ * @param {ProfinetInputOutputConfig} profinetInputOutputConfig
5274
7079
  * @param {*} [options] Override http request option.
5275
7080
  * @throws {RequiredError}
5276
7081
  */
5277
- updateApp(cell: string, app: string, app2: App, completionTimeout?: number, options?: RawAxiosRequestConfig): AxiosPromise<void> {
5278
- return localVarFp.updateApp(cell, app, app2, completionTimeout, options).then((request) => request(axios, basePath));
7082
+ setProfinetIOsFromFile(cell: string, profinetInputOutputConfig: ProfinetInputOutputConfig, options?: RawAxiosRequestConfig): AxiosPromise<void> {
7083
+ return localVarFp.setProfinetIOsFromFile(cell, profinetInputOutputConfig, options).then((request) => request(axios, basePath));
5279
7084
  },
5280
7085
  };
5281
7086
  };
5282
7087
 
5283
7088
  /**
5284
- * ApplicationApi - object-oriented interface
7089
+ * BUSInputsOutputsApi - object-oriented interface
5285
7090
  * @export
5286
- * @class ApplicationApi
7091
+ * @class BUSInputsOutputsApi
5287
7092
  * @extends {BaseAPI}
5288
7093
  */
5289
- export class ApplicationApi extends BaseAPI {
7094
+ export class BUSInputsOutputsApi extends BaseAPI {
5290
7095
  /**
5291
- * 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.
5292
- * @summary Add Application
7096
+ * Add a BUS Inputs/Outputs Service to the cell.
7097
+ * @summary Add Service
5293
7098
  * @param {string} cell Unique identifier addressing a cell in all API calls.
5294
- * @param {App} app
7099
+ * @param {BusIOType} busIOType
5295
7100
  * @param {number} [completionTimeout]
5296
7101
  * @param {*} [options] Override http request option.
5297
7102
  * @throws {RequiredError}
5298
- * @memberof ApplicationApi
7103
+ * @memberof BUSInputsOutputsApi
5299
7104
  */
5300
- public addApp(cell: string, app: App, completionTimeout?: number, options?: RawAxiosRequestConfig) {
5301
- return ApplicationApiFp(this.configuration).addApp(cell, app, completionTimeout, options).then((request) => request(this.axios, this.basePath));
7105
+ public addBusIOService(cell: string, busIOType: BusIOType, completionTimeout?: number, options?: RawAxiosRequestConfig) {
7106
+ return BUSInputsOutputsApiFp(this.configuration).addBusIOService(cell, busIOType, completionTimeout, options).then((request) => request(this.axios, this.basePath));
5302
7107
  }
5303
7108
 
5304
7109
  /**
5305
- * Delete all GUI applications from the cell.
5306
- * @summary Clear Applications
7110
+ * Adds an input/output to or updates an input/output on the PROFINET device.
7111
+ * @summary Add PROFINET Input/Output
5307
7112
  * @param {string} cell Unique identifier addressing a cell in all API calls.
5308
- * @param {number} [completionTimeout]
7113
+ * @param {string} io Unique identifier to address an Input/Output in the cell.
7114
+ * @param {ProfinetIOData} profinetIOData
5309
7115
  * @param {*} [options] Override http request option.
5310
7116
  * @throws {RequiredError}
5311
- * @memberof ApplicationApi
7117
+ * @memberof BUSInputsOutputsApi
5312
7118
  */
5313
- public clearApps(cell: string, completionTimeout?: number, options?: RawAxiosRequestConfig) {
5314
- return ApplicationApiFp(this.configuration).clearApps(cell, completionTimeout, options).then((request) => request(this.axios, this.basePath));
7119
+ public addProfinetIO(cell: string, io: string, profinetIOData: ProfinetIOData, options?: RawAxiosRequestConfig) {
7120
+ return BUSInputsOutputsApiFp(this.configuration).addProfinetIO(cell, io, profinetIOData, options).then((request) => request(this.axios, this.basePath));
5315
7121
  }
5316
7122
 
5317
7123
  /**
5318
- * Delete a GUI application from the cell.
5319
- * @summary Delete Application
7124
+ * Delete BUS Inputs/Outputs Service from the cell.
7125
+ * @summary Clear Service
5320
7126
  * @param {string} cell Unique identifier addressing a cell in all API calls.
5321
- * @param {string} app
5322
7127
  * @param {number} [completionTimeout]
5323
7128
  * @param {*} [options] Override http request option.
5324
7129
  * @throws {RequiredError}
5325
- * @memberof ApplicationApi
7130
+ * @memberof BUSInputsOutputsApi
5326
7131
  */
5327
- public deleteApp(cell: string, app: string, completionTimeout?: number, options?: RawAxiosRequestConfig) {
5328
- return ApplicationApiFp(this.configuration).deleteApp(cell, app, completionTimeout, options).then((request) => request(this.axios, this.basePath));
7132
+ public clearBusIOService(cell: string, completionTimeout?: number, options?: RawAxiosRequestConfig) {
7133
+ return BUSInputsOutputsApiFp(this.configuration).clearBusIOService(cell, completionTimeout, options).then((request) => request(this.axios, this.basePath));
5329
7134
  }
5330
7135
 
5331
7136
  /**
5332
- * 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.
5333
- * @summary Configuration
7137
+ * Removes the input/output from the PROFINET device.
7138
+ * @summary Remove PROFINET Input/Ouptut
5334
7139
  * @param {string} cell Unique identifier addressing a cell in all API calls.
5335
- * @param {string} app
7140
+ * @param {string} io Unique identifier to address an Input/Output in the cell.
5336
7141
  * @param {*} [options] Override http request option.
5337
7142
  * @throws {RequiredError}
5338
- * @memberof ApplicationApi
7143
+ * @memberof BUSInputsOutputsApi
5339
7144
  */
5340
- public getApp(cell: string, app: string, options?: RawAxiosRequestConfig) {
5341
- return ApplicationApiFp(this.configuration).getApp(cell, app, options).then((request) => request(this.axios, this.basePath));
7145
+ public deleteProfinetIO(cell: string, io: string, options?: RawAxiosRequestConfig) {
7146
+ return BUSInputsOutputsApiFp(this.configuration).deleteProfinetIO(cell, io, options).then((request) => request(this.axios, this.basePath));
5342
7147
  }
5343
7148
 
5344
7149
  /**
5345
- * 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.
5346
- * @summary List Applications
7150
+ * Get deployed BUS Inputs/Outputs Service.
7151
+ * @summary Get Service
5347
7152
  * @param {string} cell Unique identifier addressing a cell in all API calls.
5348
7153
  * @param {*} [options] Override http request option.
5349
7154
  * @throws {RequiredError}
5350
- * @memberof ApplicationApi
7155
+ * @memberof BUSInputsOutputsApi
5351
7156
  */
5352
- public listApps(cell: string, options?: RawAxiosRequestConfig) {
5353
- return ApplicationApiFp(this.configuration).listApps(cell, options).then((request) => request(this.axios, this.basePath));
7157
+ public getBusIOService(cell: string, options?: RawAxiosRequestConfig) {
7158
+ return BUSInputsOutputsApiFp(this.configuration).getBusIOService(cell, options).then((request) => request(this.axios, this.basePath));
5354
7159
  }
5355
7160
 
5356
7161
  /**
5357
- * Update the configuration of a GUI application in the cell.
5358
- * @summary Update Configuration
7162
+ * Get the current state of the BUS Inputs/Outputs service.
7163
+ * @summary State
5359
7164
  * @param {string} cell Unique identifier addressing a cell in all API calls.
5360
- * @param {string} app
5361
- * @param {App} app2
5362
- * @param {number} [completionTimeout]
5363
7165
  * @param {*} [options] Override http request option.
5364
7166
  * @throws {RequiredError}
5365
- * @memberof ApplicationApi
7167
+ * @memberof BUSInputsOutputsApi
5366
7168
  */
5367
- public updateApp(cell: string, app: string, app2: App, completionTimeout?: number, options?: RawAxiosRequestConfig) {
5368
- return ApplicationApiFp(this.configuration).updateApp(cell, app, app2, completionTimeout, options).then((request) => request(this.axios, this.basePath));
7169
+ public getBusIOState(cell: string, options?: RawAxiosRequestConfig) {
7170
+ return BUSInputsOutputsApiFp(this.configuration).getBusIOState(cell, options).then((request) => request(this.axios, this.basePath));
7171
+ }
7172
+
7173
+ /**
7174
+ * 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).
7175
+ * @summary Get Input/Output Values
7176
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
7177
+ * @param {Array<string>} [ios]
7178
+ * @param {*} [options] Override http request option.
7179
+ * @throws {RequiredError}
7180
+ * @memberof BUSInputsOutputsApi
7181
+ */
7182
+ public getBusIOValues(cell: string, ios?: Array<string>, options?: RawAxiosRequestConfig) {
7183
+ return BUSInputsOutputsApiFp(this.configuration).getBusIOValues(cell, ios, options).then((request) => request(this.axios, this.basePath));
7184
+ }
7185
+
7186
+ /**
7187
+ * Get description of PROFINET
7188
+ * @summary Get PROFINET Description
7189
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
7190
+ * @param {*} [options] Override http request option.
7191
+ * @throws {RequiredError}
7192
+ * @memberof BUSInputsOutputsApi
7193
+ */
7194
+ public getProfinetDescription(cell: string, options?: RawAxiosRequestConfig) {
7195
+ return BUSInputsOutputsApiFp(this.configuration).getProfinetDescription(cell, options).then((request) => request(this.axios, this.basePath));
7196
+ }
7197
+
7198
+ /**
7199
+ * Get input/output configuration of the PROFINET device as file.
7200
+ * @summary PROFINET Inputs/Outputs to File
7201
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
7202
+ * @param {number} [inputOffset]
7203
+ * @param {number} [outputOffset]
7204
+ * @param {*} [options] Override http request option.
7205
+ * @throws {RequiredError}
7206
+ * @memberof BUSInputsOutputsApi
7207
+ */
7208
+ public getProfinetIOsFromFile(cell: string, inputOffset?: number, outputOffset?: number, options?: RawAxiosRequestConfig) {
7209
+ return BUSInputsOutputsApiFp(this.configuration).getProfinetIOsFromFile(cell, inputOffset, outputOffset, options).then((request) => request(this.axios, this.basePath));
7210
+ }
7211
+
7212
+ /**
7213
+ * List all BUS Input/Output descriptions.
7214
+ * @summary List Descriptions
7215
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
7216
+ * @param {*} [options] Override http request option.
7217
+ * @throws {RequiredError}
7218
+ * @memberof BUSInputsOutputsApi
7219
+ */
7220
+ public listBusIODescriptions(cell: string, options?: RawAxiosRequestConfig) {
7221
+ return BUSInputsOutputsApiFp(this.configuration).listBusIODescriptions(cell, options).then((request) => request(this.axios, this.basePath));
7222
+ }
7223
+
7224
+ /**
7225
+ * List all PROFINET input and outputs.
7226
+ * @summary List PROFINET Input/Output Configuration
7227
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
7228
+ * @param {*} [options] Override http request option.
7229
+ * @throws {RequiredError}
7230
+ * @memberof BUSInputsOutputsApi
7231
+ */
7232
+ public listProfinetIOs(cell: string, options?: RawAxiosRequestConfig) {
7233
+ return BUSInputsOutputsApiFp(this.configuration).listProfinetIOs(cell, options).then((request) => request(this.axios, this.basePath));
7234
+ }
7235
+
7236
+ /**
7237
+ * 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.
7238
+ * @summary Set Output Values
7239
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
7240
+ * @param {Array<IOValue>} iOValue
7241
+ * @param {*} [options] Override http request option.
7242
+ * @throws {RequiredError}
7243
+ * @memberof BUSInputsOutputsApi
7244
+ */
7245
+ public setBusIOValues(cell: string, iOValue: Array<IOValue>, options?: RawAxiosRequestConfig) {
7246
+ return BUSInputsOutputsApiFp(this.configuration).setBusIOValues(cell, iOValue, options).then((request) => request(this.axios, this.basePath));
7247
+ }
7248
+
7249
+ /**
7250
+ * Sets inputs/outputs on the PROFINET device from file.
7251
+ * @summary Set PROFINET Inputs/Outputs from File
7252
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
7253
+ * @param {ProfinetInputOutputConfig} profinetInputOutputConfig
7254
+ * @param {*} [options] Override http request option.
7255
+ * @throws {RequiredError}
7256
+ * @memberof BUSInputsOutputsApi
7257
+ */
7258
+ public setProfinetIOsFromFile(cell: string, profinetInputOutputConfig: ProfinetInputOutputConfig, options?: RawAxiosRequestConfig) {
7259
+ return BUSInputsOutputsApiFp(this.configuration).setProfinetIOsFromFile(cell, profinetInputOutputConfig, options).then((request) => request(this.axios, this.basePath));
5369
7260
  }
5370
7261
  }
5371
7262
 
@@ -8027,6 +9918,52 @@ export class JoggingApi extends BaseAPI {
8027
9918
  */
8028
9919
  export const KinematicsApiAxiosParamCreator = function (configuration?: Configuration) {
8029
9920
  return {
9921
+ /**
9922
+ * Returns the TCP poses for a list of given joint positions.
9923
+ * @summary Forward kinematics
9924
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
9925
+ * @param {ForwardKinematicsRequest} [forwardKinematicsRequest]
9926
+ * @param {*} [options] Override http request option.
9927
+ * @throws {RequiredError}
9928
+ */
9929
+ forwardKinematics: async (cell: string, forwardKinematicsRequest?: ForwardKinematicsRequest, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
9930
+ // verify required parameter 'cell' is not null or undefined
9931
+ assertParamExists('forwardKinematics', 'cell', cell)
9932
+ const localVarPath = `/cells/{cell}/kinematic/forward`
9933
+ .replace(`{${"cell"}}`, encodeURIComponent(String(cell)));
9934
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
9935
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
9936
+ let baseOptions;
9937
+ if (configuration) {
9938
+ baseOptions = configuration.baseOptions;
9939
+ }
9940
+
9941
+ const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
9942
+ const localVarHeaderParameter = {} as any;
9943
+ const localVarQueryParameter = {} as any;
9944
+
9945
+ // authentication BasicAuth required
9946
+ // http basic authentication required
9947
+ setBasicAuthToObject(localVarRequestOptions, configuration)
9948
+
9949
+ // authentication BearerAuth required
9950
+ // http bearer authentication required
9951
+ await setBearerAuthToObject(localVarHeaderParameter, configuration)
9952
+
9953
+
9954
+
9955
+ localVarHeaderParameter['Content-Type'] = 'application/json';
9956
+
9957
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
9958
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
9959
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
9960
+ localVarRequestOptions.data = serializeDataIfNeeded(forwardKinematicsRequest, localVarRequestOptions, configuration)
9961
+
9962
+ return {
9963
+ url: toPathString(localVarUrlObj),
9964
+ options: localVarRequestOptions,
9965
+ };
9966
+ },
8030
9967
  /**
8031
9968
  * Returns the reachable joint positions for a list of given poses.
8032
9969
  * @summary Inverse kinematics
@@ -8083,6 +10020,20 @@ export const KinematicsApiAxiosParamCreator = function (configuration?: Configur
8083
10020
  export const KinematicsApiFp = function(configuration?: Configuration) {
8084
10021
  const localVarAxiosParamCreator = KinematicsApiAxiosParamCreator(configuration)
8085
10022
  return {
10023
+ /**
10024
+ * Returns the TCP poses for a list of given joint positions.
10025
+ * @summary Forward kinematics
10026
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
10027
+ * @param {ForwardKinematicsRequest} [forwardKinematicsRequest]
10028
+ * @param {*} [options] Override http request option.
10029
+ * @throws {RequiredError}
10030
+ */
10031
+ async forwardKinematics(cell: string, forwardKinematicsRequest?: ForwardKinematicsRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ForwardKinematicsResponse>> {
10032
+ const localVarAxiosArgs = await localVarAxiosParamCreator.forwardKinematics(cell, forwardKinematicsRequest, options);
10033
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
10034
+ const localVarOperationServerBasePath = operationServerMap['KinematicsApi.forwardKinematics']?.[localVarOperationServerIndex]?.url;
10035
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
10036
+ },
8086
10037
  /**
8087
10038
  * Returns the reachable joint positions for a list of given poses.
8088
10039
  * @summary Inverse kinematics
@@ -8107,6 +10058,17 @@ export const KinematicsApiFp = function(configuration?: Configuration) {
8107
10058
  export const KinematicsApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
8108
10059
  const localVarFp = KinematicsApiFp(configuration)
8109
10060
  return {
10061
+ /**
10062
+ * Returns the TCP poses for a list of given joint positions.
10063
+ * @summary Forward kinematics
10064
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
10065
+ * @param {ForwardKinematicsRequest} [forwardKinematicsRequest]
10066
+ * @param {*} [options] Override http request option.
10067
+ * @throws {RequiredError}
10068
+ */
10069
+ forwardKinematics(cell: string, forwardKinematicsRequest?: ForwardKinematicsRequest, options?: RawAxiosRequestConfig): AxiosPromise<ForwardKinematicsResponse> {
10070
+ return localVarFp.forwardKinematics(cell, forwardKinematicsRequest, options).then((request) => request(axios, basePath));
10071
+ },
8110
10072
  /**
8111
10073
  * Returns the reachable joint positions for a list of given poses.
8112
10074
  * @summary Inverse kinematics
@@ -8128,6 +10090,19 @@ export const KinematicsApiFactory = function (configuration?: Configuration, bas
8128
10090
  * @extends {BaseAPI}
8129
10091
  */
8130
10092
  export class KinematicsApi extends BaseAPI {
10093
+ /**
10094
+ * Returns the TCP poses for a list of given joint positions.
10095
+ * @summary Forward kinematics
10096
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
10097
+ * @param {ForwardKinematicsRequest} [forwardKinematicsRequest]
10098
+ * @param {*} [options] Override http request option.
10099
+ * @throws {RequiredError}
10100
+ * @memberof KinematicsApi
10101
+ */
10102
+ public forwardKinematics(cell: string, forwardKinematicsRequest?: ForwardKinematicsRequest, options?: RawAxiosRequestConfig) {
10103
+ return KinematicsApiFp(this.configuration).forwardKinematics(cell, forwardKinematicsRequest, options).then((request) => request(this.axios, this.basePath));
10104
+ }
10105
+
8131
10106
  /**
8132
10107
  * Returns the reachable joint positions for a list of given poses.
8133
10108
  * @summary Inverse kinematics
@@ -10062,27 +12037,27 @@ export class StoreCollisionComponentsApi extends BaseAPI {
10062
12037
 
10063
12038
 
10064
12039
  /**
10065
- * StoreCollisionScenesApi - axios parameter creator
12040
+ * StoreCollisionSetupsApi - axios parameter creator
10066
12041
  * @export
10067
12042
  */
10068
- export const StoreCollisionScenesApiAxiosParamCreator = function (configuration?: Configuration) {
12043
+ export const StoreCollisionSetupsApiAxiosParamCreator = function (configuration?: Configuration) {
10069
12044
  return {
10070
12045
  /**
10071
- * Deletes the stored scene. <!-- theme: danger --> > This will delete persistently stored data.
10072
- * @summary Delete Scene
12046
+ * Deletes the stored collision setup. <!-- theme: danger --> > This will delete persistently stored data.
12047
+ * @summary Delete Collision Setup
10073
12048
  * @param {string} cell Unique identifier addressing a cell in all API calls.
10074
- * @param {string} scene Unique identifier addressing a collision scene.
12049
+ * @param {string} setup Identifier of the collision setup
10075
12050
  * @param {*} [options] Override http request option.
10076
12051
  * @throws {RequiredError}
10077
12052
  */
10078
- deleteStoredCollisionScene: async (cell: string, scene: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
12053
+ deleteStoredCollisionSetup: async (cell: string, setup: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
10079
12054
  // verify required parameter 'cell' is not null or undefined
10080
- assertParamExists('deleteStoredCollisionScene', 'cell', cell)
10081
- // verify required parameter 'scene' is not null or undefined
10082
- assertParamExists('deleteStoredCollisionScene', 'scene', scene)
10083
- const localVarPath = `/cells/{cell}/store/collision/scenes/{scene}`
12055
+ assertParamExists('deleteStoredCollisionSetup', 'cell', cell)
12056
+ // verify required parameter 'setup' is not null or undefined
12057
+ assertParamExists('deleteStoredCollisionSetup', 'setup', setup)
12058
+ const localVarPath = `/cells/{cell}/store/collision/setups/{setup}`
10084
12059
  .replace(`{${"cell"}}`, encodeURIComponent(String(cell)))
10085
- .replace(`{${"scene"}}`, encodeURIComponent(String(scene)));
12060
+ .replace(`{${"setup"}}`, encodeURIComponent(String(setup)));
10086
12061
  // use dummy base URL string because the URL constructor only accepts absolute URLs.
10087
12062
  const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
10088
12063
  let baseOptions;
@@ -10114,21 +12089,21 @@ export const StoreCollisionScenesApiAxiosParamCreator = function (configuration?
10114
12089
  };
10115
12090
  },
10116
12091
  /**
10117
- * Returns the stored scene.
10118
- * @summary Get Scene
12092
+ * Returns the stored collision setup.
12093
+ * @summary Get Collision Setup
10119
12094
  * @param {string} cell Unique identifier addressing a cell in all API calls.
10120
- * @param {string} scene Unique identifier addressing a collision scene.
12095
+ * @param {string} setup Identifier of the collision setup
10121
12096
  * @param {*} [options] Override http request option.
10122
12097
  * @throws {RequiredError}
10123
12098
  */
10124
- getStoredCollisionScene: async (cell: string, scene: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
12099
+ getStoredCollisionSetup: async (cell: string, setup: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
10125
12100
  // verify required parameter 'cell' is not null or undefined
10126
- assertParamExists('getStoredCollisionScene', 'cell', cell)
10127
- // verify required parameter 'scene' is not null or undefined
10128
- assertParamExists('getStoredCollisionScene', 'scene', scene)
10129
- const localVarPath = `/cells/{cell}/store/collision/scenes/{scene}`
12101
+ assertParamExists('getStoredCollisionSetup', 'cell', cell)
12102
+ // verify required parameter 'setup' is not null or undefined
12103
+ assertParamExists('getStoredCollisionSetup', 'setup', setup)
12104
+ const localVarPath = `/cells/{cell}/store/collision/setups/{setup}`
10130
12105
  .replace(`{${"cell"}}`, encodeURIComponent(String(cell)))
10131
- .replace(`{${"scene"}}`, encodeURIComponent(String(scene)));
12106
+ .replace(`{${"setup"}}`, encodeURIComponent(String(setup)));
10132
12107
  // use dummy base URL string because the URL constructor only accepts absolute URLs.
10133
12108
  const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
10134
12109
  let baseOptions;
@@ -10160,16 +12135,16 @@ export const StoreCollisionScenesApiAxiosParamCreator = function (configuration?
10160
12135
  };
10161
12136
  },
10162
12137
  /**
10163
- * Returns a list of stored scenes.
10164
- * @summary List Scenes
12138
+ * Returns a list of stored collision setups.
12139
+ * @summary List Collision Setups
10165
12140
  * @param {string} cell Unique identifier addressing a cell in all API calls.
10166
12141
  * @param {*} [options] Override http request option.
10167
12142
  * @throws {RequiredError}
10168
12143
  */
10169
- listStoredCollisionScenes: async (cell: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
12144
+ listStoredCollisionSetups: async (cell: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
10170
12145
  // verify required parameter 'cell' is not null or undefined
10171
- assertParamExists('listStoredCollisionScenes', 'cell', cell)
10172
- const localVarPath = `/cells/{cell}/store/collision/scenes`
12146
+ assertParamExists('listStoredCollisionSetups', 'cell', cell)
12147
+ const localVarPath = `/cells/{cell}/store/collision/setups`
10173
12148
  .replace(`{${"cell"}}`, encodeURIComponent(String(cell)));
10174
12149
  // use dummy base URL string because the URL constructor only accepts absolute URLs.
10175
12150
  const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
@@ -10202,24 +12177,24 @@ export const StoreCollisionScenesApiAxiosParamCreator = function (configuration?
10202
12177
  };
10203
12178
  },
10204
12179
  /**
10205
- * Creates or replaces the stored collision scene. The scene is assembled from components as defined in the request body. <!-- theme: info --> > This endpoint allows indicating previously stored components. > Components used within the request will be copied into the new or updated scene. An error is returned if an indicated component does not exist.
10206
- * @summary Store Scene
12180
+ * Stores collision setup. If the collision setup does not exist, it will be created. If the collision setup exists, it will be updated.
12181
+ * @summary Store Collision Setup
10207
12182
  * @param {string} cell Unique identifier addressing a cell in all API calls.
10208
- * @param {string} scene Unique identifier addressing a collision scene.
10209
- * @param {CollisionSceneAssembly} collisionSceneAssembly
12183
+ * @param {string} setup Identifier of the collision setup
12184
+ * @param {CollisionSetup} collisionSetup
10210
12185
  * @param {*} [options] Override http request option.
10211
12186
  * @throws {RequiredError}
10212
12187
  */
10213
- storeCollisionScene: async (cell: string, scene: string, collisionSceneAssembly: CollisionSceneAssembly, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
12188
+ storeCollisionSetup: async (cell: string, setup: string, collisionSetup: CollisionSetup, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
10214
12189
  // verify required parameter 'cell' is not null or undefined
10215
- assertParamExists('storeCollisionScene', 'cell', cell)
10216
- // verify required parameter 'scene' is not null or undefined
10217
- assertParamExists('storeCollisionScene', 'scene', scene)
10218
- // verify required parameter 'collisionSceneAssembly' is not null or undefined
10219
- assertParamExists('storeCollisionScene', 'collisionSceneAssembly', collisionSceneAssembly)
10220
- const localVarPath = `/cells/{cell}/store/collision/scenes/{scene}`
12190
+ assertParamExists('storeCollisionSetup', 'cell', cell)
12191
+ // verify required parameter 'setup' is not null or undefined
12192
+ assertParamExists('storeCollisionSetup', 'setup', setup)
12193
+ // verify required parameter 'collisionSetup' is not null or undefined
12194
+ assertParamExists('storeCollisionSetup', 'collisionSetup', collisionSetup)
12195
+ const localVarPath = `/cells/{cell}/store/collision/setups/{setup}`
10221
12196
  .replace(`{${"cell"}}`, encodeURIComponent(String(cell)))
10222
- .replace(`{${"scene"}}`, encodeURIComponent(String(scene)));
12197
+ .replace(`{${"setup"}}`, encodeURIComponent(String(setup)));
10223
12198
  // use dummy base URL string because the URL constructor only accepts absolute URLs.
10224
12199
  const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
10225
12200
  let baseOptions;
@@ -10246,7 +12221,7 @@ export const StoreCollisionScenesApiAxiosParamCreator = function (configuration?
10246
12221
  setSearchParams(localVarUrlObj, localVarQueryParameter);
10247
12222
  let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
10248
12223
  localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
10249
- localVarRequestOptions.data = serializeDataIfNeeded(collisionSceneAssembly, localVarRequestOptions, configuration)
12224
+ localVarRequestOptions.data = serializeDataIfNeeded(collisionSetup, localVarRequestOptions, configuration)
10250
12225
 
10251
12226
  return {
10252
12227
  url: toPathString(localVarUrlObj),
@@ -10257,182 +12232,182 @@ export const StoreCollisionScenesApiAxiosParamCreator = function (configuration?
10257
12232
  };
10258
12233
 
10259
12234
  /**
10260
- * StoreCollisionScenesApi - functional programming interface
12235
+ * StoreCollisionSetupsApi - functional programming interface
10261
12236
  * @export
10262
12237
  */
10263
- export const StoreCollisionScenesApiFp = function(configuration?: Configuration) {
10264
- const localVarAxiosParamCreator = StoreCollisionScenesApiAxiosParamCreator(configuration)
12238
+ export const StoreCollisionSetupsApiFp = function(configuration?: Configuration) {
12239
+ const localVarAxiosParamCreator = StoreCollisionSetupsApiAxiosParamCreator(configuration)
10265
12240
  return {
10266
12241
  /**
10267
- * Deletes the stored scene. <!-- theme: danger --> > This will delete persistently stored data.
10268
- * @summary Delete Scene
12242
+ * Deletes the stored collision setup. <!-- theme: danger --> > This will delete persistently stored data.
12243
+ * @summary Delete Collision Setup
10269
12244
  * @param {string} cell Unique identifier addressing a cell in all API calls.
10270
- * @param {string} scene Unique identifier addressing a collision scene.
12245
+ * @param {string} setup Identifier of the collision setup
10271
12246
  * @param {*} [options] Override http request option.
10272
12247
  * @throws {RequiredError}
10273
12248
  */
10274
- async deleteStoredCollisionScene(cell: string, scene: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> {
10275
- const localVarAxiosArgs = await localVarAxiosParamCreator.deleteStoredCollisionScene(cell, scene, options);
12249
+ async deleteStoredCollisionSetup(cell: string, setup: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> {
12250
+ const localVarAxiosArgs = await localVarAxiosParamCreator.deleteStoredCollisionSetup(cell, setup, options);
10276
12251
  const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
10277
- const localVarOperationServerBasePath = operationServerMap['StoreCollisionScenesApi.deleteStoredCollisionScene']?.[localVarOperationServerIndex]?.url;
12252
+ const localVarOperationServerBasePath = operationServerMap['StoreCollisionSetupsApi.deleteStoredCollisionSetup']?.[localVarOperationServerIndex]?.url;
10278
12253
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
10279
12254
  },
10280
12255
  /**
10281
- * Returns the stored scene.
10282
- * @summary Get Scene
12256
+ * Returns the stored collision setup.
12257
+ * @summary Get Collision Setup
10283
12258
  * @param {string} cell Unique identifier addressing a cell in all API calls.
10284
- * @param {string} scene Unique identifier addressing a collision scene.
12259
+ * @param {string} setup Identifier of the collision setup
10285
12260
  * @param {*} [options] Override http request option.
10286
12261
  * @throws {RequiredError}
10287
12262
  */
10288
- async getStoredCollisionScene(cell: string, scene: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CollisionScene>> {
10289
- const localVarAxiosArgs = await localVarAxiosParamCreator.getStoredCollisionScene(cell, scene, options);
12263
+ async getStoredCollisionSetup(cell: string, setup: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CollisionSetup>> {
12264
+ const localVarAxiosArgs = await localVarAxiosParamCreator.getStoredCollisionSetup(cell, setup, options);
10290
12265
  const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
10291
- const localVarOperationServerBasePath = operationServerMap['StoreCollisionScenesApi.getStoredCollisionScene']?.[localVarOperationServerIndex]?.url;
12266
+ const localVarOperationServerBasePath = operationServerMap['StoreCollisionSetupsApi.getStoredCollisionSetup']?.[localVarOperationServerIndex]?.url;
10292
12267
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
10293
12268
  },
10294
12269
  /**
10295
- * Returns a list of stored scenes.
10296
- * @summary List Scenes
12270
+ * Returns a list of stored collision setups.
12271
+ * @summary List Collision Setups
10297
12272
  * @param {string} cell Unique identifier addressing a cell in all API calls.
10298
12273
  * @param {*} [options] Override http request option.
10299
12274
  * @throws {RequiredError}
10300
12275
  */
10301
- async listStoredCollisionScenes(cell: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<{ [key: string]: CollisionScene; }>> {
10302
- const localVarAxiosArgs = await localVarAxiosParamCreator.listStoredCollisionScenes(cell, options);
12276
+ async listStoredCollisionSetups(cell: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<{ [key: string]: CollisionSetup; }>> {
12277
+ const localVarAxiosArgs = await localVarAxiosParamCreator.listStoredCollisionSetups(cell, options);
10303
12278
  const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
10304
- const localVarOperationServerBasePath = operationServerMap['StoreCollisionScenesApi.listStoredCollisionScenes']?.[localVarOperationServerIndex]?.url;
12279
+ const localVarOperationServerBasePath = operationServerMap['StoreCollisionSetupsApi.listStoredCollisionSetups']?.[localVarOperationServerIndex]?.url;
10305
12280
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
10306
12281
  },
10307
12282
  /**
10308
- * Creates or replaces the stored collision scene. The scene is assembled from components as defined in the request body. <!-- theme: info --> > This endpoint allows indicating previously stored components. > Components used within the request will be copied into the new or updated scene. An error is returned if an indicated component does not exist.
10309
- * @summary Store Scene
12283
+ * Stores collision setup. If the collision setup does not exist, it will be created. If the collision setup exists, it will be updated.
12284
+ * @summary Store Collision Setup
10310
12285
  * @param {string} cell Unique identifier addressing a cell in all API calls.
10311
- * @param {string} scene Unique identifier addressing a collision scene.
10312
- * @param {CollisionSceneAssembly} collisionSceneAssembly
12286
+ * @param {string} setup Identifier of the collision setup
12287
+ * @param {CollisionSetup} collisionSetup
10313
12288
  * @param {*} [options] Override http request option.
10314
12289
  * @throws {RequiredError}
10315
12290
  */
10316
- async storeCollisionScene(cell: string, scene: string, collisionSceneAssembly: CollisionSceneAssembly, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CollisionScene>> {
10317
- const localVarAxiosArgs = await localVarAxiosParamCreator.storeCollisionScene(cell, scene, collisionSceneAssembly, options);
12291
+ async storeCollisionSetup(cell: string, setup: string, collisionSetup: CollisionSetup, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CollisionSetup>> {
12292
+ const localVarAxiosArgs = await localVarAxiosParamCreator.storeCollisionSetup(cell, setup, collisionSetup, options);
10318
12293
  const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
10319
- const localVarOperationServerBasePath = operationServerMap['StoreCollisionScenesApi.storeCollisionScene']?.[localVarOperationServerIndex]?.url;
12294
+ const localVarOperationServerBasePath = operationServerMap['StoreCollisionSetupsApi.storeCollisionSetup']?.[localVarOperationServerIndex]?.url;
10320
12295
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
10321
12296
  },
10322
12297
  }
10323
12298
  };
10324
12299
 
10325
12300
  /**
10326
- * StoreCollisionScenesApi - factory interface
12301
+ * StoreCollisionSetupsApi - factory interface
10327
12302
  * @export
10328
12303
  */
10329
- export const StoreCollisionScenesApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
10330
- const localVarFp = StoreCollisionScenesApiFp(configuration)
12304
+ export const StoreCollisionSetupsApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
12305
+ const localVarFp = StoreCollisionSetupsApiFp(configuration)
10331
12306
  return {
10332
12307
  /**
10333
- * Deletes the stored scene. <!-- theme: danger --> > This will delete persistently stored data.
10334
- * @summary Delete Scene
12308
+ * Deletes the stored collision setup. <!-- theme: danger --> > This will delete persistently stored data.
12309
+ * @summary Delete Collision Setup
10335
12310
  * @param {string} cell Unique identifier addressing a cell in all API calls.
10336
- * @param {string} scene Unique identifier addressing a collision scene.
12311
+ * @param {string} setup Identifier of the collision setup
10337
12312
  * @param {*} [options] Override http request option.
10338
12313
  * @throws {RequiredError}
10339
12314
  */
10340
- deleteStoredCollisionScene(cell: string, scene: string, options?: RawAxiosRequestConfig): AxiosPromise<void> {
10341
- return localVarFp.deleteStoredCollisionScene(cell, scene, options).then((request) => request(axios, basePath));
12315
+ deleteStoredCollisionSetup(cell: string, setup: string, options?: RawAxiosRequestConfig): AxiosPromise<void> {
12316
+ return localVarFp.deleteStoredCollisionSetup(cell, setup, options).then((request) => request(axios, basePath));
10342
12317
  },
10343
12318
  /**
10344
- * Returns the stored scene.
10345
- * @summary Get Scene
12319
+ * Returns the stored collision setup.
12320
+ * @summary Get Collision Setup
10346
12321
  * @param {string} cell Unique identifier addressing a cell in all API calls.
10347
- * @param {string} scene Unique identifier addressing a collision scene.
12322
+ * @param {string} setup Identifier of the collision setup
10348
12323
  * @param {*} [options] Override http request option.
10349
12324
  * @throws {RequiredError}
10350
12325
  */
10351
- getStoredCollisionScene(cell: string, scene: string, options?: RawAxiosRequestConfig): AxiosPromise<CollisionScene> {
10352
- return localVarFp.getStoredCollisionScene(cell, scene, options).then((request) => request(axios, basePath));
12326
+ getStoredCollisionSetup(cell: string, setup: string, options?: RawAxiosRequestConfig): AxiosPromise<CollisionSetup> {
12327
+ return localVarFp.getStoredCollisionSetup(cell, setup, options).then((request) => request(axios, basePath));
10353
12328
  },
10354
12329
  /**
10355
- * Returns a list of stored scenes.
10356
- * @summary List Scenes
12330
+ * Returns a list of stored collision setups.
12331
+ * @summary List Collision Setups
10357
12332
  * @param {string} cell Unique identifier addressing a cell in all API calls.
10358
12333
  * @param {*} [options] Override http request option.
10359
12334
  * @throws {RequiredError}
10360
12335
  */
10361
- listStoredCollisionScenes(cell: string, options?: RawAxiosRequestConfig): AxiosPromise<{ [key: string]: CollisionScene; }> {
10362
- return localVarFp.listStoredCollisionScenes(cell, options).then((request) => request(axios, basePath));
12336
+ listStoredCollisionSetups(cell: string, options?: RawAxiosRequestConfig): AxiosPromise<{ [key: string]: CollisionSetup; }> {
12337
+ return localVarFp.listStoredCollisionSetups(cell, options).then((request) => request(axios, basePath));
10363
12338
  },
10364
12339
  /**
10365
- * Creates or replaces the stored collision scene. The scene is assembled from components as defined in the request body. <!-- theme: info --> > This endpoint allows indicating previously stored components. > Components used within the request will be copied into the new or updated scene. An error is returned if an indicated component does not exist.
10366
- * @summary Store Scene
12340
+ * Stores collision setup. If the collision setup does not exist, it will be created. If the collision setup exists, it will be updated.
12341
+ * @summary Store Collision Setup
10367
12342
  * @param {string} cell Unique identifier addressing a cell in all API calls.
10368
- * @param {string} scene Unique identifier addressing a collision scene.
10369
- * @param {CollisionSceneAssembly} collisionSceneAssembly
12343
+ * @param {string} setup Identifier of the collision setup
12344
+ * @param {CollisionSetup} collisionSetup
10370
12345
  * @param {*} [options] Override http request option.
10371
12346
  * @throws {RequiredError}
10372
12347
  */
10373
- storeCollisionScene(cell: string, scene: string, collisionSceneAssembly: CollisionSceneAssembly, options?: RawAxiosRequestConfig): AxiosPromise<CollisionScene> {
10374
- return localVarFp.storeCollisionScene(cell, scene, collisionSceneAssembly, options).then((request) => request(axios, basePath));
12348
+ storeCollisionSetup(cell: string, setup: string, collisionSetup: CollisionSetup, options?: RawAxiosRequestConfig): AxiosPromise<CollisionSetup> {
12349
+ return localVarFp.storeCollisionSetup(cell, setup, collisionSetup, options).then((request) => request(axios, basePath));
10375
12350
  },
10376
12351
  };
10377
12352
  };
10378
12353
 
10379
12354
  /**
10380
- * StoreCollisionScenesApi - object-oriented interface
12355
+ * StoreCollisionSetupsApi - object-oriented interface
10381
12356
  * @export
10382
- * @class StoreCollisionScenesApi
12357
+ * @class StoreCollisionSetupsApi
10383
12358
  * @extends {BaseAPI}
10384
12359
  */
10385
- export class StoreCollisionScenesApi extends BaseAPI {
12360
+ export class StoreCollisionSetupsApi extends BaseAPI {
10386
12361
  /**
10387
- * Deletes the stored scene. <!-- theme: danger --> > This will delete persistently stored data.
10388
- * @summary Delete Scene
12362
+ * Deletes the stored collision setup. <!-- theme: danger --> > This will delete persistently stored data.
12363
+ * @summary Delete Collision Setup
10389
12364
  * @param {string} cell Unique identifier addressing a cell in all API calls.
10390
- * @param {string} scene Unique identifier addressing a collision scene.
12365
+ * @param {string} setup Identifier of the collision setup
10391
12366
  * @param {*} [options] Override http request option.
10392
12367
  * @throws {RequiredError}
10393
- * @memberof StoreCollisionScenesApi
12368
+ * @memberof StoreCollisionSetupsApi
10394
12369
  */
10395
- public deleteStoredCollisionScene(cell: string, scene: string, options?: RawAxiosRequestConfig) {
10396
- return StoreCollisionScenesApiFp(this.configuration).deleteStoredCollisionScene(cell, scene, options).then((request) => request(this.axios, this.basePath));
12370
+ public deleteStoredCollisionSetup(cell: string, setup: string, options?: RawAxiosRequestConfig) {
12371
+ return StoreCollisionSetupsApiFp(this.configuration).deleteStoredCollisionSetup(cell, setup, options).then((request) => request(this.axios, this.basePath));
10397
12372
  }
10398
12373
 
10399
12374
  /**
10400
- * Returns the stored scene.
10401
- * @summary Get Scene
12375
+ * Returns the stored collision setup.
12376
+ * @summary Get Collision Setup
10402
12377
  * @param {string} cell Unique identifier addressing a cell in all API calls.
10403
- * @param {string} scene Unique identifier addressing a collision scene.
12378
+ * @param {string} setup Identifier of the collision setup
10404
12379
  * @param {*} [options] Override http request option.
10405
12380
  * @throws {RequiredError}
10406
- * @memberof StoreCollisionScenesApi
12381
+ * @memberof StoreCollisionSetupsApi
10407
12382
  */
10408
- public getStoredCollisionScene(cell: string, scene: string, options?: RawAxiosRequestConfig) {
10409
- return StoreCollisionScenesApiFp(this.configuration).getStoredCollisionScene(cell, scene, options).then((request) => request(this.axios, this.basePath));
12383
+ public getStoredCollisionSetup(cell: string, setup: string, options?: RawAxiosRequestConfig) {
12384
+ return StoreCollisionSetupsApiFp(this.configuration).getStoredCollisionSetup(cell, setup, options).then((request) => request(this.axios, this.basePath));
10410
12385
  }
10411
12386
 
10412
12387
  /**
10413
- * Returns a list of stored scenes.
10414
- * @summary List Scenes
12388
+ * Returns a list of stored collision setups.
12389
+ * @summary List Collision Setups
10415
12390
  * @param {string} cell Unique identifier addressing a cell in all API calls.
10416
12391
  * @param {*} [options] Override http request option.
10417
12392
  * @throws {RequiredError}
10418
- * @memberof StoreCollisionScenesApi
12393
+ * @memberof StoreCollisionSetupsApi
10419
12394
  */
10420
- public listStoredCollisionScenes(cell: string, options?: RawAxiosRequestConfig) {
10421
- return StoreCollisionScenesApiFp(this.configuration).listStoredCollisionScenes(cell, options).then((request) => request(this.axios, this.basePath));
12395
+ public listStoredCollisionSetups(cell: string, options?: RawAxiosRequestConfig) {
12396
+ return StoreCollisionSetupsApiFp(this.configuration).listStoredCollisionSetups(cell, options).then((request) => request(this.axios, this.basePath));
10422
12397
  }
10423
12398
 
10424
12399
  /**
10425
- * Creates or replaces the stored collision scene. The scene is assembled from components as defined in the request body. <!-- theme: info --> > This endpoint allows indicating previously stored components. > Components used within the request will be copied into the new or updated scene. An error is returned if an indicated component does not exist.
10426
- * @summary Store Scene
12400
+ * Stores collision setup. If the collision setup does not exist, it will be created. If the collision setup exists, it will be updated.
12401
+ * @summary Store Collision Setup
10427
12402
  * @param {string} cell Unique identifier addressing a cell in all API calls.
10428
- * @param {string} scene Unique identifier addressing a collision scene.
10429
- * @param {CollisionSceneAssembly} collisionSceneAssembly
12403
+ * @param {string} setup Identifier of the collision setup
12404
+ * @param {CollisionSetup} collisionSetup
10430
12405
  * @param {*} [options] Override http request option.
10431
12406
  * @throws {RequiredError}
10432
- * @memberof StoreCollisionScenesApi
12407
+ * @memberof StoreCollisionSetupsApi
10433
12408
  */
10434
- public storeCollisionScene(cell: string, scene: string, collisionSceneAssembly: CollisionSceneAssembly, options?: RawAxiosRequestConfig) {
10435
- return StoreCollisionScenesApiFp(this.configuration).storeCollisionScene(cell, scene, collisionSceneAssembly, options).then((request) => request(this.axios, this.basePath));
12409
+ public storeCollisionSetup(cell: string, setup: string, collisionSetup: CollisionSetup, options?: RawAxiosRequestConfig) {
12410
+ return StoreCollisionSetupsApiFp(this.configuration).storeCollisionSetup(cell, setup, collisionSetup, options).then((request) => request(this.axios, this.basePath));
10436
12411
  }
10437
12412
  }
10438
12413
 
@@ -12344,7 +14319,53 @@ export class TrajectoryExecutionApi extends BaseAPI {
12344
14319
  export const TrajectoryPlanningApiAxiosParamCreator = function (configuration?: Configuration) {
12345
14320
  return {
12346
14321
  /**
12347
- * 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.
14322
+ * 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.
14323
+ * @summary Plan Collision-Free Trajectory
14324
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
14325
+ * @param {PlanCollisionFreeRequest} [planCollisionFreeRequest]
14326
+ * @param {*} [options] Override http request option.
14327
+ * @throws {RequiredError}
14328
+ */
14329
+ planCollisionFree: async (cell: string, planCollisionFreeRequest?: PlanCollisionFreeRequest, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
14330
+ // verify required parameter 'cell' is not null or undefined
14331
+ assertParamExists('planCollisionFree', 'cell', cell)
14332
+ const localVarPath = `/cells/{cell}/trajectory-planning/plan-collision-free`
14333
+ .replace(`{${"cell"}}`, encodeURIComponent(String(cell)));
14334
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
14335
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
14336
+ let baseOptions;
14337
+ if (configuration) {
14338
+ baseOptions = configuration.baseOptions;
14339
+ }
14340
+
14341
+ const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
14342
+ const localVarHeaderParameter = {} as any;
14343
+ const localVarQueryParameter = {} as any;
14344
+
14345
+ // authentication BasicAuth required
14346
+ // http basic authentication required
14347
+ setBasicAuthToObject(localVarRequestOptions, configuration)
14348
+
14349
+ // authentication BearerAuth required
14350
+ // http bearer authentication required
14351
+ await setBearerAuthToObject(localVarHeaderParameter, configuration)
14352
+
14353
+
14354
+
14355
+ localVarHeaderParameter['Content-Type'] = 'application/json';
14356
+
14357
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
14358
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
14359
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
14360
+ localVarRequestOptions.data = serializeDataIfNeeded(planCollisionFreeRequest, localVarRequestOptions, configuration)
14361
+
14362
+ return {
14363
+ url: toPathString(localVarUrlObj),
14364
+ options: localVarRequestOptions,
14365
+ };
14366
+ },
14367
+ /**
14368
+ * 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.
12348
14369
  * @summary Plan Trajectory
12349
14370
  * @param {string} cell Unique identifier addressing a cell in all API calls.
12350
14371
  * @param {PlanTrajectoryRequest} [planTrajectoryRequest]
@@ -12400,7 +14421,21 @@ export const TrajectoryPlanningApiFp = function(configuration?: Configuration) {
12400
14421
  const localVarAxiosParamCreator = TrajectoryPlanningApiAxiosParamCreator(configuration)
12401
14422
  return {
12402
14423
  /**
12403
- * 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.
14424
+ * 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.
14425
+ * @summary Plan Collision-Free Trajectory
14426
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
14427
+ * @param {PlanCollisionFreeRequest} [planCollisionFreeRequest]
14428
+ * @param {*} [options] Override http request option.
14429
+ * @throws {RequiredError}
14430
+ */
14431
+ async planCollisionFree(cell: string, planCollisionFreeRequest?: PlanCollisionFreeRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PlanCollisionFreeResponse>> {
14432
+ const localVarAxiosArgs = await localVarAxiosParamCreator.planCollisionFree(cell, planCollisionFreeRequest, options);
14433
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
14434
+ const localVarOperationServerBasePath = operationServerMap['TrajectoryPlanningApi.planCollisionFree']?.[localVarOperationServerIndex]?.url;
14435
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
14436
+ },
14437
+ /**
14438
+ * 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.
12404
14439
  * @summary Plan Trajectory
12405
14440
  * @param {string} cell Unique identifier addressing a cell in all API calls.
12406
14441
  * @param {PlanTrajectoryRequest} [planTrajectoryRequest]
@@ -12424,7 +14459,18 @@ export const TrajectoryPlanningApiFactory = function (configuration?: Configurat
12424
14459
  const localVarFp = TrajectoryPlanningApiFp(configuration)
12425
14460
  return {
12426
14461
  /**
12427
- * 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.
14462
+ * 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.
14463
+ * @summary Plan Collision-Free Trajectory
14464
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
14465
+ * @param {PlanCollisionFreeRequest} [planCollisionFreeRequest]
14466
+ * @param {*} [options] Override http request option.
14467
+ * @throws {RequiredError}
14468
+ */
14469
+ planCollisionFree(cell: string, planCollisionFreeRequest?: PlanCollisionFreeRequest, options?: RawAxiosRequestConfig): AxiosPromise<PlanCollisionFreeResponse> {
14470
+ return localVarFp.planCollisionFree(cell, planCollisionFreeRequest, options).then((request) => request(axios, basePath));
14471
+ },
14472
+ /**
14473
+ * 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.
12428
14474
  * @summary Plan Trajectory
12429
14475
  * @param {string} cell Unique identifier addressing a cell in all API calls.
12430
14476
  * @param {PlanTrajectoryRequest} [planTrajectoryRequest]
@@ -12445,7 +14491,20 @@ export const TrajectoryPlanningApiFactory = function (configuration?: Configurat
12445
14491
  */
12446
14492
  export class TrajectoryPlanningApi extends BaseAPI {
12447
14493
  /**
12448
- * 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.
14494
+ * 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.
14495
+ * @summary Plan Collision-Free Trajectory
14496
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
14497
+ * @param {PlanCollisionFreeRequest} [planCollisionFreeRequest]
14498
+ * @param {*} [options] Override http request option.
14499
+ * @throws {RequiredError}
14500
+ * @memberof TrajectoryPlanningApi
14501
+ */
14502
+ public planCollisionFree(cell: string, planCollisionFreeRequest?: PlanCollisionFreeRequest, options?: RawAxiosRequestConfig) {
14503
+ return TrajectoryPlanningApiFp(this.configuration).planCollisionFree(cell, planCollisionFreeRequest, options).then((request) => request(this.axios, this.basePath));
14504
+ }
14505
+
14506
+ /**
14507
+ * 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.
12449
14508
  * @summary Plan Trajectory
12450
14509
  * @param {string} cell Unique identifier addressing a cell in all API calls.
12451
14510
  * @param {PlanTrajectoryRequest} [planTrajectoryRequest]