@wandelbots/nova-api 25.7.0-dev.4 → 25.7.0-dev.40

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/v2/api.d.ts CHANGED
@@ -196,6 +196,12 @@ export interface App {
196
196
  * @memberof App
197
197
  */
198
198
  'storage'?: ContainerStorage;
199
+ /**
200
+ *
201
+ * @type {ContainerResources}
202
+ * @memberof App
203
+ */
204
+ 'resources'?: ContainerResources;
199
205
  /**
200
206
  * Defines the URL path suffix used to check the application\'s health status. The complete health check URL is constructed as `/$cell/$name/$health_path`. When the application is working as expected, the endpoint returns an HTTP 200 status code. If not specified, the system will default to using the application icon path suffix (the value of `app_icon`) as the health check endpoint, resulting in `/$cell/$name/$app_icon`. If the health check fails (no response or non-200 status code), the system will automatically restart the application container to restore service.
201
207
  * @type {string}
@@ -335,6 +341,173 @@ export declare const BoxBoxTypeEnum: {
335
341
  readonly Full: "FULL";
336
342
  };
337
343
  export type BoxBoxTypeEnum = typeof BoxBoxTypeEnum[keyof typeof BoxBoxTypeEnum];
344
+ /**
345
+ * PROFINET BUS Inputs/Outputs Service configuration.
346
+ * @export
347
+ * @interface BusIOProfinet
348
+ */
349
+ export interface BusIOProfinet {
350
+ /**
351
+ *
352
+ * @type {string}
353
+ * @memberof BusIOProfinet
354
+ */
355
+ 'bus_type'?: BusIOProfinetBusTypeEnum;
356
+ /**
357
+ * Path to the configuration file.
358
+ * @type {string}
359
+ * @memberof BusIOProfinet
360
+ */
361
+ 'config_file_content'?: string;
362
+ /**
363
+ *
364
+ * @type {BusIOProfinetNetwork}
365
+ * @memberof BusIOProfinet
366
+ */
367
+ 'network_config'?: BusIOProfinetNetwork;
368
+ /**
369
+ * MAC address for the PROFINET port, should be get from another NOVA API endpoind?
370
+ * @type {string}
371
+ * @memberof BusIOProfinet
372
+ */
373
+ 'mac': string;
374
+ /**
375
+ *
376
+ * @type {BusIOProfinetDefaultRoute}
377
+ * @memberof BusIOProfinet
378
+ */
379
+ 'default_route': BusIOProfinetDefaultRoute;
380
+ }
381
+ export declare const BusIOProfinetBusTypeEnum: {
382
+ readonly Profinet: "profinet";
383
+ };
384
+ export type BusIOProfinetBusTypeEnum = typeof BusIOProfinetBusTypeEnum[keyof typeof BusIOProfinetBusTypeEnum];
385
+ /**
386
+ * Default route configuration for the PROFINET service. Will be removed before release by automatic default route configuration, if possible.
387
+ * @export
388
+ * @interface BusIOProfinetDefaultRoute
389
+ */
390
+ export interface BusIOProfinetDefaultRoute {
391
+ /**
392
+ * Gateway for the default route.
393
+ * @type {string}
394
+ * @memberof BusIOProfinetDefaultRoute
395
+ */
396
+ 'gateway': string;
397
+ /**
398
+ * Interface for the default route.
399
+ * @type {string}
400
+ * @memberof BusIOProfinetDefaultRoute
401
+ */
402
+ 'interface': string;
403
+ }
404
+ /**
405
+ * Network configuration for the PROFINET device
406
+ * @export
407
+ * @interface BusIOProfinetIpConfig
408
+ */
409
+ export interface BusIOProfinetIpConfig {
410
+ /**
411
+ * IP address for the PROFINET device
412
+ * @type {string}
413
+ * @memberof BusIOProfinetIpConfig
414
+ */
415
+ 'ip': string;
416
+ /**
417
+ * Network mask for the PROFINET device.
418
+ * @type {string}
419
+ * @memberof BusIOProfinetIpConfig
420
+ */
421
+ 'netmask': string;
422
+ /**
423
+ * Gateway for the PROFINET device
424
+ * @type {string}
425
+ * @memberof BusIOProfinetIpConfig
426
+ */
427
+ 'gateway': string;
428
+ }
429
+ /**
430
+ *
431
+ * @export
432
+ * @interface BusIOProfinetNetwork
433
+ */
434
+ export interface BusIOProfinetNetwork {
435
+ /**
436
+ * Name of the PROFINET device.
437
+ * @type {string}
438
+ * @memberof BusIOProfinetNetwork
439
+ */
440
+ 'device_name'?: string;
441
+ /**
442
+ *
443
+ * @type {BusIOProfinetIpConfig}
444
+ * @memberof BusIOProfinetNetwork
445
+ */
446
+ 'ip_config'?: BusIOProfinetIpConfig;
447
+ /**
448
+ * Content of the PROFINET REMA XML file.
449
+ * @type {string}
450
+ * @memberof BusIOProfinetNetwork
451
+ */
452
+ 'rema_xml_content'?: string;
453
+ }
454
+ /**
455
+ * Virtual PROFINET BUS Inputs/Outputs Service configuration.
456
+ * @export
457
+ * @interface BusIOProfinetVirtual
458
+ */
459
+ export interface BusIOProfinetVirtual {
460
+ /**
461
+ *
462
+ * @type {string}
463
+ * @memberof BusIOProfinetVirtual
464
+ */
465
+ 'bus_type'?: BusIOProfinetVirtualBusTypeEnum;
466
+ }
467
+ export declare const BusIOProfinetVirtualBusTypeEnum: {
468
+ readonly VirtualProfinet: "virtual_profinet";
469
+ };
470
+ export type BusIOProfinetVirtualBusTypeEnum = typeof BusIOProfinetVirtualBusTypeEnum[keyof typeof BusIOProfinetVirtualBusTypeEnum];
471
+ /**
472
+ * @type BusIOType
473
+ * @export
474
+ */
475
+ export type BusIOType = {
476
+ bus_type: 'profinet';
477
+ } & BusIOProfinet | {
478
+ bus_type: 'profinet_virtual';
479
+ } & BusIOProfinetVirtual;
480
+ /**
481
+ *
482
+ * @export
483
+ * @interface BusIOsState
484
+ */
485
+ export interface BusIOsState {
486
+ /**
487
+ *
488
+ * @type {BusIOsStateEnum}
489
+ * @memberof BusIOsState
490
+ */
491
+ 'state': BusIOsStateEnum;
492
+ /**
493
+ * 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.
494
+ * @type {string}
495
+ * @memberof BusIOsState
496
+ */
497
+ 'message'?: string;
498
+ }
499
+ /**
500
+ * Current state of the BUS input/output service.
501
+ * @export
502
+ * @enum {string}
503
+ */
504
+ export declare const BusIOsStateEnum: {
505
+ readonly BusIosStateUnknown: "BUS_IOS_STATE_UNKNOWN";
506
+ readonly BusIosStateInitializing: "BUS_IOS_STATE_INITIALIZING";
507
+ readonly BusIosStateConnected: "BUS_IOS_STATE_CONNECTED";
508
+ readonly BusIosStateDisconnected: "BUS_IOS_STATE_DISCONNECTED";
509
+ };
510
+ export type BusIOsStateEnum = typeof BusIOsStateEnum[keyof typeof BusIOsStateEnum];
338
511
  /**
339
512
  * Defines a cylindrical shape with 2 semi-spheres on the top and bottom. Centred around origin, symmetric around z-axis.
340
513
  * @export
@@ -495,13 +668,13 @@ export interface Collision {
495
668
  * @type {string}
496
669
  * @memberof Collision
497
670
  */
498
- 'id_of_world'?: string;
671
+ 'id_of_layer'?: string;
499
672
  /**
500
673
  * A three-dimensional vector [x, y, z] with double precision.
501
674
  * @type {Array<number>}
502
675
  * @memberof Collision
503
676
  */
504
- 'normal_world_on_b'?: Array<number>;
677
+ 'normal_root_on_b'?: Array<number>;
505
678
  /**
506
679
  *
507
680
  * @type {CollisionContact}
@@ -532,7 +705,7 @@ export interface CollisionContact {
532
705
  * @type {Array<number>}
533
706
  * @memberof CollisionContact
534
707
  */
535
- 'world'?: Array<number>;
708
+ 'root'?: Array<number>;
536
709
  }
537
710
  /**
538
711
  *
@@ -548,50 +721,29 @@ export interface CollisionError {
548
721
  'collision'?: FeedbackCollision;
549
722
  }
550
723
  /**
551
- *
724
+ * @type CollisionFreeAlgorithm
725
+ * Configuration for collision-free path planning algorithms. Different algorithms may have different parameters and behavior.
552
726
  * @export
553
- * @interface CollisionMotionGroup
554
727
  */
555
- export interface CollisionMotionGroup {
556
- /**
557
- * 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.
558
- * @type {Array<{ [key: string]: Collider; }>}
559
- * @memberof CollisionMotionGroup
560
- */
561
- 'link_chain'?: Array<{
562
- [key: string]: Collider;
563
- }>;
564
- /**
565
- * 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.
566
- * @type {{ [key: string]: Collider; }}
567
- * @memberof CollisionMotionGroup
568
- */
569
- 'tool'?: {
570
- [key: string]: Collider;
571
- };
572
- }
728
+ export type CollisionFreeAlgorithm = MidpointInsertionAlgorithm | RRTConnectAlgorithm;
573
729
  /**
574
730
  *
575
731
  * @export
576
- * @interface CollisionMotionGroupAssembly
732
+ * @interface CollisionSetup
577
733
  */
578
- export interface CollisionMotionGroupAssembly {
734
+ export interface CollisionSetup {
579
735
  /**
580
- * References a stored link chain.
581
- * @type {string}
582
- * @memberof CollisionMotionGroupAssembly
583
- */
584
- 'stored_link_chain'?: string;
585
- /**
586
- * References a stored tool.
587
- * @type {string}
588
- * @memberof CollisionMotionGroupAssembly
736
+ * A collection of identifiable colliders.
737
+ * @type {{ [key: string]: Collider; }}
738
+ * @memberof CollisionSetup
589
739
  */
590
- 'stored_tool'?: string;
740
+ 'colliders'?: {
741
+ [key: string]: Collider;
742
+ };
591
743
  /**
592
744
  * 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.
593
745
  * @type {Array<{ [key: string]: Collider; }>}
594
- * @memberof CollisionMotionGroupAssembly
746
+ * @memberof CollisionSetup
595
747
  */
596
748
  'link_chain'?: Array<{
597
749
  [key: string]: Collider;
@@ -599,75 +751,17 @@ export interface CollisionMotionGroupAssembly {
599
751
  /**
600
752
  * 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.
601
753
  * @type {{ [key: string]: Collider; }}
602
- * @memberof CollisionMotionGroupAssembly
754
+ * @memberof CollisionSetup
603
755
  */
604
756
  'tool'?: {
605
757
  [key: string]: Collider;
606
758
  };
607
- }
608
- /**
609
- * 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 >> […]
610
- * @export
611
- * @interface CollisionScene
612
- */
613
- export interface CollisionScene {
614
- /**
615
- * A collection of identifiable colliders.
616
- * @type {{ [key: string]: Collider; }}
617
- * @memberof CollisionScene
618
- */
619
- 'colliders'?: {
620
- [key: string]: Collider;
621
- };
622
759
  /**
623
- * 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.
624
- * @type {{ [key: string]: CollisionMotionGroup; }}
625
- * @memberof CollisionScene
626
- */
627
- 'motion_groups'?: {
628
- [key: string]: CollisionMotionGroup;
629
- };
630
- }
631
- /**
632
- * 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)
633
- * @export
634
- * @interface CollisionSceneAssembly
635
- */
636
- export interface CollisionSceneAssembly {
637
- /**
638
- * 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).
639
- * @type {Array<string>}
640
- * @memberof CollisionSceneAssembly
641
- */
642
- 'stored_scenes'?: Array<string>;
643
- /**
644
- *
645
- * @type {CollisionScene}
646
- * @memberof CollisionSceneAssembly
647
- */
648
- 'scene'?: CollisionScene;
649
- /**
650
- * Add stored colliders to the scene via their identifiers. The colliders are added to the the origin of the scene.
651
- * @type {Array<string>}
652
- * @memberof CollisionSceneAssembly
653
- */
654
- 'stored_colliders'?: Array<string>;
655
- /**
656
- * A collection of identifiable colliders.
657
- * @type {{ [key: string]: Collider; }}
658
- * @memberof CollisionSceneAssembly
659
- */
660
- 'colliders'?: {
661
- [key: string]: Collider;
662
- };
663
- /**
664
- * 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.
665
- * @type {{ [key: string]: CollisionMotionGroupAssembly; }}
666
- * @memberof CollisionSceneAssembly
760
+ * 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.
761
+ * @type {boolean}
762
+ * @memberof CollisionSetup
667
763
  */
668
- 'motion_groups'?: {
669
- [key: string]: CollisionMotionGroupAssembly;
670
- };
764
+ 'self_collision_detection'?: boolean;
671
765
  }
672
766
  /**
673
767
  * 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.
@@ -840,6 +934,25 @@ export interface ContainerImageSecretsInner {
840
934
  */
841
935
  'name': string;
842
936
  }
937
+ /**
938
+ * Additional resources that the application requires.
939
+ * @export
940
+ * @interface ContainerResources
941
+ */
942
+ export interface ContainerResources {
943
+ /**
944
+ * Number of GPUs the application requires.
945
+ * @type {number}
946
+ * @memberof ContainerResources
947
+ */
948
+ 'intel_gpu'?: number;
949
+ /**
950
+ * The maximum memory allocated to this application.
951
+ * @type {string}
952
+ * @memberof ContainerResources
953
+ */
954
+ 'memory_limit'?: string;
955
+ }
843
956
  /**
844
957
  * The path and capacity of a volume that retains data across application restarts. The maximal requestable capacity is 300Mi. If you need more capacity consider using [storeObject](storeObject).
845
958
  * @export
@@ -1102,35 +1215,115 @@ export declare const Direction: {
1102
1215
  };
1103
1216
  export type Direction = typeof Direction[keyof typeof Direction];
1104
1217
  /**
1105
- *
1218
+ * The provided joint data does not match the expected number of joints for this motion group.
1106
1219
  * @export
1107
- * @interface EndOfTrajectory
1220
+ * @interface ErrorInvalidJointCount
1108
1221
  */
1109
- export interface EndOfTrajectory {
1222
+ export interface ErrorInvalidJointCount {
1223
+ /**
1224
+ * The expected number of joints for this motion group.
1225
+ * @type {number}
1226
+ * @memberof ErrorInvalidJointCount
1227
+ */
1228
+ 'expected_joint_count': number;
1229
+ /**
1230
+ * The number of provided joints.
1231
+ * @type {number}
1232
+ * @memberof ErrorInvalidJointCount
1233
+ */
1234
+ 'provided_joint_count': number;
1110
1235
  /**
1111
1236
  *
1112
1237
  * @type {string}
1113
- * @memberof EndOfTrajectory
1238
+ * @memberof ErrorInvalidJointCount
1114
1239
  */
1115
- 'kind': EndOfTrajectoryKindEnum;
1240
+ 'error_feedback_name': ErrorInvalidJointCountErrorFeedbackNameEnum;
1116
1241
  }
1117
- export declare const EndOfTrajectoryKindEnum: {
1118
- readonly EndOfTrajectory: "END_OF_TRAJECTORY";
1242
+ export declare const ErrorInvalidJointCountErrorFeedbackNameEnum: {
1243
+ readonly ErrorInvalidJointCount: "ErrorInvalidJointCount";
1119
1244
  };
1120
- export type EndOfTrajectoryKindEnum = typeof EndOfTrajectoryKindEnum[keyof typeof EndOfTrajectoryKindEnum];
1245
+ export type ErrorInvalidJointCountErrorFeedbackNameEnum = typeof ErrorInvalidJointCountErrorFeedbackNameEnum[keyof typeof ErrorInvalidJointCountErrorFeedbackNameEnum];
1121
1246
  /**
1122
- *
1247
+ * A reference joint position (start or target) exceeds the configured joint limits.
1123
1248
  * @export
1124
- * @interface Error2
1249
+ * @interface ErrorJointLimitExceeded
1125
1250
  */
1126
- export interface Error2 {
1251
+ export interface ErrorJointLimitExceeded {
1252
+ /**
1253
+ * Index of the joint exceeding its limits (0-based).
1254
+ * @type {number}
1255
+ * @memberof ErrorJointLimitExceeded
1256
+ */
1257
+ 'joint_index'?: number;
1258
+ /**
1259
+ *
1260
+ * @type {Array<number>}
1261
+ * @memberof ErrorJointLimitExceeded
1262
+ */
1263
+ 'joint_position'?: Array<number>;
1127
1264
  /**
1128
1265
  *
1129
1266
  * @type {string}
1130
- * @memberof Error2
1267
+ * @memberof ErrorJointLimitExceeded
1131
1268
  */
1132
- 'message': string;
1269
+ 'error_feedback_name': ErrorJointLimitExceededErrorFeedbackNameEnum;
1270
+ }
1271
+ export declare const ErrorJointLimitExceededErrorFeedbackNameEnum: {
1272
+ readonly ErrorJointLimitExceeded: "ErrorJointLimitExceeded";
1273
+ };
1274
+ export type ErrorJointLimitExceededErrorFeedbackNameEnum = typeof ErrorJointLimitExceededErrorFeedbackNameEnum[keyof typeof ErrorJointLimitExceededErrorFeedbackNameEnum];
1275
+ /**
1276
+ * A reference joint position (e.g. start or target joint position) results in collisions that prevent processing.
1277
+ * @export
1278
+ * @interface ErrorJointPositionCollision
1279
+ */
1280
+ export interface ErrorJointPositionCollision {
1281
+ /**
1282
+ *
1283
+ * @type {Array<Collision>}
1284
+ * @memberof ErrorJointPositionCollision
1285
+ */
1286
+ 'collisions'?: Array<Collision>;
1287
+ /**
1288
+ *
1289
+ * @type {Array<number>}
1290
+ * @memberof ErrorJointPositionCollision
1291
+ */
1292
+ 'joint_position'?: Array<number>;
1293
+ /**
1294
+ *
1295
+ * @type {string}
1296
+ * @memberof ErrorJointPositionCollision
1297
+ */
1298
+ 'error_feedback_name': ErrorJointPositionCollisionErrorFeedbackNameEnum;
1299
+ }
1300
+ export declare const ErrorJointPositionCollisionErrorFeedbackNameEnum: {
1301
+ readonly ErrorJointPositionCollision: "ErrorJointPositionCollision";
1302
+ };
1303
+ export type ErrorJointPositionCollisionErrorFeedbackNameEnum = typeof ErrorJointPositionCollisionErrorFeedbackNameEnum[keyof typeof ErrorJointPositionCollisionErrorFeedbackNameEnum];
1304
+ /**
1305
+ * The collision-free planning algorithm reached its maximum iteration limit without finding a valid path. Increase max_iterations or modify the start/target positions.
1306
+ * @export
1307
+ * @interface ErrorMaxIterationsExceeded
1308
+ */
1309
+ export interface ErrorMaxIterationsExceeded {
1310
+ /**
1311
+ * The maximum number of iterations that was reached.
1312
+ * @type {number}
1313
+ * @memberof ErrorMaxIterationsExceeded
1314
+ */
1315
+ 'max_iterations'?: number;
1316
+ /**
1317
+ *
1318
+ * @type {string}
1319
+ * @memberof ErrorMaxIterationsExceeded
1320
+ */
1321
+ 'error_feedback_name': ErrorMaxIterationsExceededErrorFeedbackNameEnum;
1133
1322
  }
1323
+ export declare const ErrorMaxIterationsExceededErrorFeedbackNameEnum: {
1324
+ readonly ErrorMaxIterationsExceeded: "ErrorMaxIterationsExceeded";
1325
+ };
1326
+ export type ErrorMaxIterationsExceededErrorFeedbackNameEnum = typeof ErrorMaxIterationsExceededErrorFeedbackNameEnum[keyof typeof ErrorMaxIterationsExceededErrorFeedbackNameEnum];
1134
1327
  /**
1135
1328
  * 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.
1136
1329
  * @export
@@ -1389,64 +1582,147 @@ export type FloatValueValueTypeEnum = typeof FloatValueValueTypeEnum[keyof typeo
1389
1582
  /**
1390
1583
  *
1391
1584
  * @export
1392
- * @interface GetModeResponse
1585
+ * @interface ForwardKinematics422Response
1393
1586
  */
1394
- export interface GetModeResponse {
1587
+ export interface ForwardKinematics422Response {
1395
1588
  /**
1396
1589
  *
1397
- * @type {RobotSystemMode}
1398
- * @memberof GetModeResponse
1590
+ * @type {Array<ForwardKinematicsValidationError>}
1591
+ * @memberof ForwardKinematics422Response
1399
1592
  */
1400
- 'robot_system_mode': RobotSystemMode;
1593
+ 'detail'?: Array<ForwardKinematicsValidationError>;
1401
1594
  }
1402
1595
  /**
1403
1596
  *
1404
1597
  * @export
1405
- * @interface GetTrajectoryResponse
1598
+ * @interface ForwardKinematicsRequest
1406
1599
  */
1407
- export interface GetTrajectoryResponse {
1600
+ export interface ForwardKinematicsRequest {
1408
1601
  /**
1409
- * Unique identifier of the motion group the trajectory is planned for.
1602
+ * String identifiying the model of a motion group.
1410
1603
  * @type {string}
1411
- * @memberof GetTrajectoryResponse
1604
+ * @memberof ForwardKinematicsRequest
1412
1605
  */
1413
- 'motion_group': string;
1606
+ 'motion_group_model': string;
1414
1607
  /**
1415
- * The trajectory consisting of a list of joint positions and an equal number of corresponding timestamps.
1416
- * @type {JointTrajectory}
1417
- * @memberof GetTrajectoryResponse
1608
+ * List of joint positions [rad] for which TCP poses are computed.
1609
+ * @type {Array<Array<number>>}
1610
+ * @memberof ForwardKinematicsRequest
1418
1611
  */
1419
- 'trajectory': JointTrajectory;
1612
+ 'joint_positions': Array<Array<number>>;
1420
1613
  /**
1421
- * Unique identifier of the tool the trajectory is planned for.
1422
- * @type {string}
1423
- * @memberof GetTrajectoryResponse
1614
+ *
1615
+ * @type {Pose}
1616
+ * @memberof ForwardKinematicsRequest
1424
1617
  */
1425
- 'tcp': string;
1618
+ 'tcp_offset'?: Pose;
1619
+ /**
1620
+ * Offset from the world frame to the motion group base.
1621
+ * @type {Pose}
1622
+ * @memberof ForwardKinematicsRequest
1623
+ */
1624
+ 'mounting'?: Pose;
1426
1625
  }
1427
1626
  /**
1428
1627
  *
1429
1628
  * @export
1430
- * @interface HTTPValidationError
1629
+ * @interface ForwardKinematicsResponse
1431
1630
  */
1432
- export interface HTTPValidationError {
1631
+ export interface ForwardKinematicsResponse {
1433
1632
  /**
1434
- *
1435
- * @type {Array<ValidationError>}
1436
- * @memberof HTTPValidationError
1633
+ * List of computed TCP poses corresponding to the input joint positions.
1634
+ * @type {Array<Pose>}
1635
+ * @memberof ForwardKinematicsResponse
1437
1636
  */
1438
- 'detail'?: Array<ValidationError>;
1637
+ 'tcp_poses': Array<Pose>;
1439
1638
  }
1440
1639
  /**
1441
- * Input/Output boolean value representation.
1640
+ *
1442
1641
  * @export
1443
- * @interface IOBooleanValue
1642
+ * @interface ForwardKinematicsValidationError
1444
1643
  */
1445
- export interface IOBooleanValue {
1644
+ export interface ForwardKinematicsValidationError {
1446
1645
  /**
1447
- * Unique identifier of the input/output.
1448
- * @type {string}
1449
- * @memberof IOBooleanValue
1646
+ *
1647
+ * @type {Array<ValidationErrorLocInner>}
1648
+ * @memberof ForwardKinematicsValidationError
1649
+ */
1650
+ 'loc': Array<ValidationErrorLocInner>;
1651
+ /**
1652
+ *
1653
+ * @type {string}
1654
+ * @memberof ForwardKinematicsValidationError
1655
+ */
1656
+ 'msg': string;
1657
+ /**
1658
+ *
1659
+ * @type {string}
1660
+ * @memberof ForwardKinematicsValidationError
1661
+ */
1662
+ 'type': string;
1663
+ /**
1664
+ *
1665
+ * @type {{ [key: string]: any; }}
1666
+ * @memberof ForwardKinematicsValidationError
1667
+ */
1668
+ 'input': {
1669
+ [key: string]: any;
1670
+ };
1671
+ /**
1672
+ *
1673
+ * @type {ErrorInvalidJointCount}
1674
+ * @memberof ForwardKinematicsValidationError
1675
+ */
1676
+ 'data'?: ErrorInvalidJointCount;
1677
+ }
1678
+ /**
1679
+ *
1680
+ * @export
1681
+ * @interface GetTrajectoryResponse
1682
+ */
1683
+ export interface GetTrajectoryResponse {
1684
+ /**
1685
+ * Unique identifier of the motion group the trajectory is planned for.
1686
+ * @type {string}
1687
+ * @memberof GetTrajectoryResponse
1688
+ */
1689
+ 'motion_group': string;
1690
+ /**
1691
+ * The trajectory consisting of a list of joint positions and an equal number of corresponding timestamps.
1692
+ * @type {JointTrajectory}
1693
+ * @memberof GetTrajectoryResponse
1694
+ */
1695
+ 'trajectory': JointTrajectory;
1696
+ /**
1697
+ * Unique identifier of the tool the trajectory is planned for.
1698
+ * @type {string}
1699
+ * @memberof GetTrajectoryResponse
1700
+ */
1701
+ 'tcp': string;
1702
+ }
1703
+ /**
1704
+ *
1705
+ * @export
1706
+ * @interface HTTPValidationError
1707
+ */
1708
+ export interface HTTPValidationError {
1709
+ /**
1710
+ *
1711
+ * @type {Array<ValidationError>}
1712
+ * @memberof HTTPValidationError
1713
+ */
1714
+ 'detail'?: Array<ValidationError>;
1715
+ }
1716
+ /**
1717
+ * Input/Output boolean value representation.
1718
+ * @export
1719
+ * @interface IOBooleanValue
1720
+ */
1721
+ export interface IOBooleanValue {
1722
+ /**
1723
+ * Unique identifier of the input/output.
1724
+ * @type {string}
1725
+ * @memberof IOBooleanValue
1450
1726
  */
1451
1727
  'io': string;
1452
1728
  /**
@@ -1890,6 +2166,19 @@ export interface InvalidDofInvalidDof {
1890
2166
  */
1891
2167
  'joint_position'?: Array<number>;
1892
2168
  }
2169
+ /**
2170
+ *
2171
+ * @export
2172
+ * @interface InverseKinematics422Response
2173
+ */
2174
+ export interface InverseKinematics422Response {
2175
+ /**
2176
+ *
2177
+ * @type {Array<InverseKinematicsValidationError>}
2178
+ * @memberof InverseKinematics422Response
2179
+ */
2180
+ 'detail'?: Array<InverseKinematicsValidationError>;
2181
+ }
1893
2182
  /**
1894
2183
  *
1895
2184
  * @export
@@ -1927,12 +2216,12 @@ export interface InverseKinematicsRequest {
1927
2216
  */
1928
2217
  'joint_position_limits'?: Array<LimitRange>;
1929
2218
  /**
1930
- * 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.
1931
- * @type {{ [key: string]: SingleMotionGroupCollisionScene; }}
2219
+ * 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.
2220
+ * @type {{ [key: string]: CollisionSetup; }}
1932
2221
  * @memberof InverseKinematicsRequest
1933
2222
  */
1934
- 'collision_scenes'?: {
1935
- [key: string]: SingleMotionGroupCollisionScene;
2223
+ 'collision_setups'?: {
2224
+ [key: string]: CollisionSetup;
1936
2225
  };
1937
2226
  }
1938
2227
  /**
@@ -1948,6 +2237,55 @@ export interface InverseKinematicsResponse {
1948
2237
  */
1949
2238
  'joints': Array<Array<Array<number>>>;
1950
2239
  }
2240
+ /**
2241
+ *
2242
+ * @export
2243
+ * @interface InverseKinematicsValidationError
2244
+ */
2245
+ export interface InverseKinematicsValidationError {
2246
+ /**
2247
+ *
2248
+ * @type {Array<ValidationErrorLocInner>}
2249
+ * @memberof InverseKinematicsValidationError
2250
+ */
2251
+ 'loc': Array<ValidationErrorLocInner>;
2252
+ /**
2253
+ *
2254
+ * @type {string}
2255
+ * @memberof InverseKinematicsValidationError
2256
+ */
2257
+ 'msg': string;
2258
+ /**
2259
+ *
2260
+ * @type {string}
2261
+ * @memberof InverseKinematicsValidationError
2262
+ */
2263
+ 'type': string;
2264
+ /**
2265
+ *
2266
+ * @type {{ [key: string]: any; }}
2267
+ * @memberof InverseKinematicsValidationError
2268
+ */
2269
+ 'input': {
2270
+ [key: string]: any;
2271
+ };
2272
+ /**
2273
+ *
2274
+ * @type {InverseKinematicsValidationErrorAllOfData}
2275
+ * @memberof InverseKinematicsValidationError
2276
+ */
2277
+ 'data'?: InverseKinematicsValidationErrorAllOfData;
2278
+ }
2279
+ /**
2280
+ * @type InverseKinematicsValidationErrorAllOfData
2281
+ * Optional data further specifying the validation error.
2282
+ * @export
2283
+ */
2284
+ export type InverseKinematicsValidationErrorAllOfData = {
2285
+ error_feedback_name: 'ErrorInvalidJointCount';
2286
+ } & ErrorInvalidJointCount | {
2287
+ error_feedback_name: 'ErrorJointLimitExceeded';
2288
+ } & ErrorJointLimitExceeded;
1951
2289
  /**
1952
2290
  * 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.
1953
2291
  * @export
@@ -1975,7 +2313,104 @@ export type JoggingDetailsKindEnum = typeof JoggingDetailsKindEnum[keyof typeof
1975
2313
  * @type JoggingDetailsState
1976
2314
  * @export
1977
2315
  */
1978
- export type JoggingDetailsState = PausedByUser | PausedNearCollision | PausedNearJointLimit | PausedOnIO | Running;
2316
+ export type JoggingDetailsState = JoggingPausedByUser | JoggingPausedNearCollision | JoggingPausedNearJointLimit | JoggingPausedOnIO | JoggingRunning;
2317
+ /**
2318
+ *
2319
+ * @export
2320
+ * @interface JoggingPausedByUser
2321
+ */
2322
+ export interface JoggingPausedByUser {
2323
+ /**
2324
+ *
2325
+ * @type {string}
2326
+ * @memberof JoggingPausedByUser
2327
+ */
2328
+ 'kind': JoggingPausedByUserKindEnum;
2329
+ }
2330
+ export declare const JoggingPausedByUserKindEnum: {
2331
+ readonly PausedByUser: "PAUSED_BY_USER";
2332
+ };
2333
+ export type JoggingPausedByUserKindEnum = typeof JoggingPausedByUserKindEnum[keyof typeof JoggingPausedByUserKindEnum];
2334
+ /**
2335
+ *
2336
+ * @export
2337
+ * @interface JoggingPausedNearCollision
2338
+ */
2339
+ export interface JoggingPausedNearCollision {
2340
+ /**
2341
+ *
2342
+ * @type {string}
2343
+ * @memberof JoggingPausedNearCollision
2344
+ */
2345
+ 'kind': JoggingPausedNearCollisionKindEnum;
2346
+ /**
2347
+ *
2348
+ * @type {string}
2349
+ * @memberof JoggingPausedNearCollision
2350
+ */
2351
+ 'description': string;
2352
+ }
2353
+ export declare const JoggingPausedNearCollisionKindEnum: {
2354
+ readonly PausedNearCollision: "PAUSED_NEAR_COLLISION";
2355
+ };
2356
+ export type JoggingPausedNearCollisionKindEnum = typeof JoggingPausedNearCollisionKindEnum[keyof typeof JoggingPausedNearCollisionKindEnum];
2357
+ /**
2358
+ *
2359
+ * @export
2360
+ * @interface JoggingPausedNearJointLimit
2361
+ */
2362
+ export interface JoggingPausedNearJointLimit {
2363
+ /**
2364
+ *
2365
+ * @type {string}
2366
+ * @memberof JoggingPausedNearJointLimit
2367
+ */
2368
+ 'kind': JoggingPausedNearJointLimitKindEnum;
2369
+ /**
2370
+ *
2371
+ * @type {Array<number>}
2372
+ * @memberof JoggingPausedNearJointLimit
2373
+ */
2374
+ 'joint_indices': Array<number>;
2375
+ }
2376
+ export declare const JoggingPausedNearJointLimitKindEnum: {
2377
+ readonly PausedNearJointLimit: "PAUSED_NEAR_JOINT_LIMIT";
2378
+ };
2379
+ export type JoggingPausedNearJointLimitKindEnum = typeof JoggingPausedNearJointLimitKindEnum[keyof typeof JoggingPausedNearJointLimitKindEnum];
2380
+ /**
2381
+ *
2382
+ * @export
2383
+ * @interface JoggingPausedOnIO
2384
+ */
2385
+ export interface JoggingPausedOnIO {
2386
+ /**
2387
+ *
2388
+ * @type {string}
2389
+ * @memberof JoggingPausedOnIO
2390
+ */
2391
+ 'kind': JoggingPausedOnIOKindEnum;
2392
+ }
2393
+ export declare const JoggingPausedOnIOKindEnum: {
2394
+ readonly PausedOnIo: "PAUSED_ON_IO";
2395
+ };
2396
+ export type JoggingPausedOnIOKindEnum = typeof JoggingPausedOnIOKindEnum[keyof typeof JoggingPausedOnIOKindEnum];
2397
+ /**
2398
+ *
2399
+ * @export
2400
+ * @interface JoggingRunning
2401
+ */
2402
+ export interface JoggingRunning {
2403
+ /**
2404
+ *
2405
+ * @type {string}
2406
+ * @memberof JoggingRunning
2407
+ */
2408
+ 'kind': JoggingRunningKindEnum;
2409
+ }
2410
+ export declare const JoggingRunningKindEnum: {
2411
+ readonly Running: "RUNNING";
2412
+ };
2413
+ export type JoggingRunningKindEnum = typeof JoggingRunningKindEnum[keyof typeof JoggingRunningKindEnum];
1979
2414
  /**
1980
2415
  *
1981
2416
  * @export
@@ -2397,6 +2832,29 @@ export declare const Manufacturer: {
2397
2832
  readonly Yaskawa: "yaskawa";
2398
2833
  };
2399
2834
  export type Manufacturer = typeof Manufacturer[keyof typeof Manufacturer];
2835
+ /**
2836
+ * 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.
2837
+ * @export
2838
+ * @interface MidpointInsertionAlgorithm
2839
+ */
2840
+ export interface MidpointInsertionAlgorithm {
2841
+ /**
2842
+ * Algorithm discriminator.
2843
+ * @type {string}
2844
+ * @memberof MidpointInsertionAlgorithm
2845
+ */
2846
+ 'algorithm_name': MidpointInsertionAlgorithmAlgorithmNameEnum;
2847
+ /**
2848
+ * Maximum number of iterations for the midpoint insertion algorithm. Higher values increase likelyhood of success, but also computation time (linear).
2849
+ * @type {number}
2850
+ * @memberof MidpointInsertionAlgorithm
2851
+ */
2852
+ 'max_iterations'?: number;
2853
+ }
2854
+ export declare const MidpointInsertionAlgorithmAlgorithmNameEnum: {
2855
+ readonly MidpointInsertionAlgorithm: "MidpointInsertionAlgorithm";
2856
+ };
2857
+ export type MidpointInsertionAlgorithmAlgorithmNameEnum = typeof MidpointInsertionAlgorithmAlgorithmNameEnum[keyof typeof MidpointInsertionAlgorithmAlgorithmNameEnum];
2400
2858
  /**
2401
2859
  *
2402
2860
  * @export
@@ -2587,6 +3045,57 @@ export interface MotionGroupJoints {
2587
3045
  */
2588
3046
  'torques'?: Array<number>;
2589
3047
  }
3048
+ /**
3049
+ *
3050
+ * @export
3051
+ * @interface MotionGroupSetup
3052
+ */
3053
+ export interface MotionGroupSetup {
3054
+ /**
3055
+ * String identifiying the model of a motion group.
3056
+ * @type {string}
3057
+ * @memberof MotionGroupSetup
3058
+ */
3059
+ 'motion_group_model': string;
3060
+ /**
3061
+ * [ms] cycle time of the motion group controller. A trajectory for this motion group should be computed to this resolution.
3062
+ * @type {number}
3063
+ * @memberof MotionGroupSetup
3064
+ */
3065
+ 'cycle_time': number;
3066
+ /**
3067
+ * The offset from the world frame to the motion group base.
3068
+ * @type {Pose}
3069
+ * @memberof MotionGroupSetup
3070
+ */
3071
+ 'mounting'?: Pose;
3072
+ /**
3073
+ *
3074
+ * @type {Pose}
3075
+ * @memberof MotionGroupSetup
3076
+ */
3077
+ 'tcp_offset'?: Pose;
3078
+ /**
3079
+ *
3080
+ * @type {LimitSet}
3081
+ * @memberof MotionGroupSetup
3082
+ */
3083
+ 'global_limits'?: LimitSet;
3084
+ /**
3085
+ *
3086
+ * @type {Payload}
3087
+ * @memberof MotionGroupSetup
3088
+ */
3089
+ 'payload'?: Payload;
3090
+ /**
3091
+ * 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.
3092
+ * @type {{ [key: string]: CollisionSetup; }}
3093
+ * @memberof MotionGroupSetup
3094
+ */
3095
+ 'collision_setups'?: {
3096
+ [key: string]: CollisionSetup;
3097
+ };
3098
+ }
2590
3099
  /**
2591
3100
  * Presents the current state of the motion group.
2592
3101
  * @export
@@ -3075,131 +3584,109 @@ export interface PauseOnIO {
3075
3584
  /**
3076
3585
  *
3077
3586
  * @export
3078
- * @interface PausedByRequest
3587
+ * @interface Payload
3079
3588
  */
3080
- export interface PausedByRequest {
3589
+ export interface Payload {
3081
3590
  /**
3082
3591
  *
3083
3592
  * @type {string}
3084
- * @memberof PausedByRequest
3593
+ * @memberof Payload
3594
+ */
3595
+ 'name': string;
3596
+ /**
3597
+ * Mass of payload in [kg].
3598
+ * @type {number}
3599
+ * @memberof Payload
3600
+ */
3601
+ 'payload': number;
3602
+ /**
3603
+ * A three-dimensional vector [x, y, z] with double precision.
3604
+ * @type {Array<number>}
3605
+ * @memberof Payload
3606
+ */
3607
+ 'center_of_mass'?: Array<number>;
3608
+ /**
3609
+ * A three-dimensional vector [x, y, z] with double precision.
3610
+ * @type {Array<number>}
3611
+ * @memberof Payload
3085
3612
  */
3086
- 'kind': PausedByRequestKindEnum;
3613
+ 'moment_of_inertia'?: Array<number>;
3087
3614
  }
3088
- export declare const PausedByRequestKindEnum: {
3089
- readonly PausedByUser: "PAUSED_BY_USER";
3090
- };
3091
- export type PausedByRequestKindEnum = typeof PausedByRequestKindEnum[keyof typeof PausedByRequestKindEnum];
3092
3615
  /**
3093
3616
  *
3094
3617
  * @export
3095
- * @interface PausedByUser
3618
+ * @interface Plan422Response
3096
3619
  */
3097
- export interface PausedByUser {
3620
+ export interface Plan422Response {
3098
3621
  /**
3099
3622
  *
3100
- * @type {string}
3101
- * @memberof PausedByUser
3623
+ * @type {Array<PlanValidationError>}
3624
+ * @memberof Plan422Response
3102
3625
  */
3103
- 'kind': PausedByUserKindEnum;
3626
+ 'detail'?: Array<PlanValidationError>;
3104
3627
  }
3105
- export declare const PausedByUserKindEnum: {
3106
- readonly PausedByUser: "PAUSED_BY_USER";
3107
- };
3108
- export type PausedByUserKindEnum = typeof PausedByUserKindEnum[keyof typeof PausedByUserKindEnum];
3109
3628
  /**
3110
- *
3629
+ * Response when collision-free trajectory planning fails. Contains specific feedback about why the planning failed.
3111
3630
  * @export
3112
- * @interface PausedNearCollision
3631
+ * @interface PlanCollisionFreeFailedResponse
3113
3632
  */
3114
- export interface PausedNearCollision {
3633
+ export interface PlanCollisionFreeFailedResponse {
3115
3634
  /**
3116
3635
  *
3117
- * @type {string}
3118
- * @memberof PausedNearCollision
3119
- */
3120
- 'kind': PausedNearCollisionKindEnum;
3121
- /**
3122
- *
3123
- * @type {string}
3124
- * @memberof PausedNearCollision
3636
+ * @type {ErrorMaxIterationsExceeded}
3637
+ * @memberof PlanCollisionFreeFailedResponse
3125
3638
  */
3126
- 'description': string;
3639
+ 'error_feedback': ErrorMaxIterationsExceeded;
3127
3640
  }
3128
- export declare const PausedNearCollisionKindEnum: {
3129
- readonly PausedNearCollision: "PAUSED_NEAR_COLLISION";
3130
- };
3131
- export type PausedNearCollisionKindEnum = typeof PausedNearCollisionKindEnum[keyof typeof PausedNearCollisionKindEnum];
3132
3641
  /**
3133
3642
  *
3134
3643
  * @export
3135
- * @interface PausedNearJointLimit
3644
+ * @interface PlanCollisionFreeRequest
3136
3645
  */
3137
- export interface PausedNearJointLimit {
3646
+ export interface PlanCollisionFreeRequest {
3647
+ /**
3648
+ * The data to assemble the robot setup can be retrieved from [getMotionGroupDescription](getMotionGroupDescription) endpoint.
3649
+ * @type {MotionGroupSetup}
3650
+ * @memberof PlanCollisionFreeRequest
3651
+ */
3652
+ 'motion_group_setup': MotionGroupSetup;
3138
3653
  /**
3139
3654
  *
3140
- * @type {string}
3141
- * @memberof PausedNearJointLimit
3655
+ * @type {Array<number>}
3656
+ * @memberof PlanCollisionFreeRequest
3142
3657
  */
3143
- 'kind': PausedNearJointLimitKindEnum;
3658
+ 'start_joint_position': Array<number>;
3144
3659
  /**
3145
3660
  *
3146
3661
  * @type {Array<number>}
3147
- * @memberof PausedNearJointLimit
3662
+ * @memberof PlanCollisionFreeRequest
3148
3663
  */
3149
- 'joint_indices': Array<number>;
3150
- }
3151
- export declare const PausedNearJointLimitKindEnum: {
3152
- readonly PausedNearJointLimit: "PAUSED_NEAR_JOINT_LIMIT";
3153
- };
3154
- export type PausedNearJointLimitKindEnum = typeof PausedNearJointLimitKindEnum[keyof typeof PausedNearJointLimitKindEnum];
3155
- /**
3156
- *
3157
- * @export
3158
- * @interface PausedOnIO
3159
- */
3160
- export interface PausedOnIO {
3664
+ 'target': Array<number>;
3161
3665
  /**
3162
3666
  *
3163
- * @type {string}
3164
- * @memberof PausedOnIO
3667
+ * @type {CollisionFreeAlgorithm}
3668
+ * @memberof PlanCollisionFreeRequest
3165
3669
  */
3166
- 'kind': PausedOnIOKindEnum;
3670
+ 'algorithm': CollisionFreeAlgorithm;
3167
3671
  }
3168
- export declare const PausedOnIOKindEnum: {
3169
- readonly PausedOnIo: "PAUSED_ON_IO";
3170
- };
3171
- export type PausedOnIOKindEnum = typeof PausedOnIOKindEnum[keyof typeof PausedOnIOKindEnum];
3172
3672
  /**
3173
- *
3673
+ * Response from collision-free trajectory planning. Contains either a successful joint trajectory or failure information.
3174
3674
  * @export
3175
- * @interface Payload
3675
+ * @interface PlanCollisionFreeResponse
3176
3676
  */
3177
- export interface Payload {
3677
+ export interface PlanCollisionFreeResponse {
3178
3678
  /**
3179
3679
  *
3180
- * @type {string}
3181
- * @memberof Payload
3182
- */
3183
- 'name': string;
3184
- /**
3185
- * Mass of payload in [kg].
3186
- * @type {number}
3187
- * @memberof Payload
3188
- */
3189
- 'payload': number;
3190
- /**
3191
- * A three-dimensional vector [x, y, z] with double precision.
3192
- * @type {Array<number>}
3193
- * @memberof Payload
3194
- */
3195
- 'center_of_mass'?: Array<number>;
3196
- /**
3197
- * A three-dimensional vector [x, y, z] with double precision.
3198
- * @type {Array<number>}
3199
- * @memberof Payload
3680
+ * @type {PlanCollisionFreeResponseResponse}
3681
+ * @memberof PlanCollisionFreeResponse
3200
3682
  */
3201
- 'moment_of_inertia'?: Array<number>;
3683
+ 'response': PlanCollisionFreeResponseResponse;
3202
3684
  }
3685
+ /**
3686
+ * @type PlanCollisionFreeResponseResponse
3687
+ * @export
3688
+ */
3689
+ export type PlanCollisionFreeResponseResponse = JointTrajectory | PlanCollisionFreeFailedResponse;
3203
3690
  /**
3204
3691
  *
3205
3692
  * @export
@@ -3238,10 +3725,10 @@ export type PlanTrajectoryFailedResponseErrorFeedback = FeedbackCollision | Feed
3238
3725
  export interface PlanTrajectoryRequest {
3239
3726
  /**
3240
3727
  * The data to assemble the robot setup can be retrieved from [getMotionGroupDescription](getMotionGroupDescription) endpoint.
3241
- * @type {RobotSetup}
3728
+ * @type {MotionGroupSetup}
3242
3729
  * @memberof PlanTrajectoryRequest
3243
3730
  */
3244
- 'robot_setup': RobotSetup;
3731
+ 'motion_group_setup': MotionGroupSetup;
3245
3732
  /**
3246
3733
  *
3247
3734
  * @type {Array<number>}
@@ -3273,6 +3760,57 @@ export interface PlanTrajectoryResponse {
3273
3760
  * @export
3274
3761
  */
3275
3762
  export type PlanTrajectoryResponseResponse = JointTrajectory | PlanTrajectoryFailedResponse;
3763
+ /**
3764
+ *
3765
+ * @export
3766
+ * @interface PlanValidationError
3767
+ */
3768
+ export interface PlanValidationError {
3769
+ /**
3770
+ *
3771
+ * @type {Array<ValidationErrorLocInner>}
3772
+ * @memberof PlanValidationError
3773
+ */
3774
+ 'loc': Array<ValidationErrorLocInner>;
3775
+ /**
3776
+ *
3777
+ * @type {string}
3778
+ * @memberof PlanValidationError
3779
+ */
3780
+ 'msg': string;
3781
+ /**
3782
+ *
3783
+ * @type {string}
3784
+ * @memberof PlanValidationError
3785
+ */
3786
+ 'type': string;
3787
+ /**
3788
+ *
3789
+ * @type {{ [key: string]: any; }}
3790
+ * @memberof PlanValidationError
3791
+ */
3792
+ 'input': {
3793
+ [key: string]: any;
3794
+ };
3795
+ /**
3796
+ *
3797
+ * @type {PlanValidationErrorAllOfData}
3798
+ * @memberof PlanValidationError
3799
+ */
3800
+ 'data'?: PlanValidationErrorAllOfData;
3801
+ }
3802
+ /**
3803
+ * @type PlanValidationErrorAllOfData
3804
+ * Optional data further specifying the validation error.
3805
+ * @export
3806
+ */
3807
+ export type PlanValidationErrorAllOfData = {
3808
+ error_feedback_name: 'ErrorInvalidJointCount';
3809
+ } & ErrorInvalidJointCount | {
3810
+ error_feedback_name: 'ErrorJointLimitExceeded';
3811
+ } & ErrorJointLimitExceeded | {
3812
+ error_feedback_name: 'ErrorJointPositionCollision';
3813
+ } & ErrorJointPositionCollision;
3276
3814
  /**
3277
3815
  * Defines an x/y-plane with infinite size.
3278
3816
  * @export
@@ -3355,6 +3893,250 @@ export interface Pose {
3355
3893
  */
3356
3894
  'orientation'?: Array<number>;
3357
3895
  }
3896
+ /**
3897
+ *
3898
+ * @export
3899
+ * @interface ProfinetDescription
3900
+ */
3901
+ export interface ProfinetDescription {
3902
+ /**
3903
+ * The vendor identifier of the PROFINET device, identifying the manufacturer.
3904
+ * @type {string}
3905
+ * @memberof ProfinetDescription
3906
+ */
3907
+ 'vendor_id': string;
3908
+ /**
3909
+ * The device identifier of the PROFINET device, identifying the specific device within the vendor\'s range.
3910
+ * @type {string}
3911
+ * @memberof ProfinetDescription
3912
+ */
3913
+ 'device_id': string;
3914
+ /**
3915
+ *
3916
+ * @type {Array<ProfinetSlotDescription>}
3917
+ * @memberof ProfinetDescription
3918
+ */
3919
+ 'slots'?: Array<ProfinetSlotDescription>;
3920
+ /**
3921
+ * Name of the PROFINET device
3922
+ * @type {string}
3923
+ * @memberof ProfinetDescription
3924
+ */
3925
+ 'device_name'?: string;
3926
+ /**
3927
+ * IP address for the PROFINET device
3928
+ * @type {string}
3929
+ * @memberof ProfinetDescription
3930
+ */
3931
+ 'ip'?: string;
3932
+ }
3933
+ /**
3934
+ *
3935
+ * @export
3936
+ * @interface ProfinetIO
3937
+ */
3938
+ export interface ProfinetIO {
3939
+ /**
3940
+ * 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.
3941
+ * @type {string}
3942
+ * @memberof ProfinetIO
3943
+ */
3944
+ 'name': string;
3945
+ /**
3946
+ *
3947
+ * @type {ProfinetIOTypeEnum}
3948
+ * @memberof ProfinetIO
3949
+ */
3950
+ 'type': ProfinetIOTypeEnum;
3951
+ /**
3952
+ * The direction of the input/output value, indicating whether it is an input or output for the device.
3953
+ * @type {ProfinetIODirection}
3954
+ * @memberof ProfinetIO
3955
+ */
3956
+ 'direction': ProfinetIODirection;
3957
+ /**
3958
+ * 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.
3959
+ * @type {number}
3960
+ * @memberof ProfinetIO
3961
+ */
3962
+ 'byte_address': number;
3963
+ /**
3964
+ * 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.
3965
+ * @type {number}
3966
+ * @memberof ProfinetIO
3967
+ */
3968
+ 'bit_address'?: number;
3969
+ /**
3970
+ * The unique identifier for the input/output value. This identifier is used to reference the specific input/output in the NOVA system.
3971
+ * @type {string}
3972
+ * @memberof ProfinetIO
3973
+ */
3974
+ 'io': string;
3975
+ }
3976
+ /**
3977
+ *
3978
+ * @export
3979
+ * @interface ProfinetIOData
3980
+ */
3981
+ export interface ProfinetIOData {
3982
+ /**
3983
+ * 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.
3984
+ * @type {string}
3985
+ * @memberof ProfinetIOData
3986
+ */
3987
+ 'name': string;
3988
+ /**
3989
+ *
3990
+ * @type {ProfinetIOTypeEnum}
3991
+ * @memberof ProfinetIOData
3992
+ */
3993
+ 'type': ProfinetIOTypeEnum;
3994
+ /**
3995
+ * The direction of the input/output value, indicating whether it is an input or output for the device.
3996
+ * @type {ProfinetIODirection}
3997
+ * @memberof ProfinetIOData
3998
+ */
3999
+ 'direction': ProfinetIODirection;
4000
+ /**
4001
+ * 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.
4002
+ * @type {number}
4003
+ * @memberof ProfinetIOData
4004
+ */
4005
+ 'byte_address': number;
4006
+ /**
4007
+ * 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.
4008
+ * @type {number}
4009
+ * @memberof ProfinetIOData
4010
+ */
4011
+ 'bit_address'?: number;
4012
+ }
4013
+ /**
4014
+ * Identifies the input/output type.
4015
+ * @export
4016
+ * @enum {string}
4017
+ */
4018
+ export declare const ProfinetIODirection: {
4019
+ readonly ProfinetIoDirectionInput: "PROFINET_IO_DIRECTION_INPUT";
4020
+ readonly ProfinetIoDirectionOutput: "PROFINET_IO_DIRECTION_OUTPUT";
4021
+ readonly ProfinetIoDirectionInout: "PROFINET_IO_DIRECTION_INOUT";
4022
+ };
4023
+ export type ProfinetIODirection = typeof ProfinetIODirection[keyof typeof ProfinetIODirection];
4024
+ /**
4025
+ * Value type of the PROFINET input/output.
4026
+ * @export
4027
+ * @enum {string}
4028
+ */
4029
+ export declare const ProfinetIOTypeEnum: {
4030
+ readonly ProfinetIoTypeUnknown: "PROFINET_IO_TYPE_UNKNOWN";
4031
+ readonly ProfinetIoTypeBool: "PROFINET_IO_TYPE_BOOL";
4032
+ readonly ProfinetIoTypeUsint: "PROFINET_IO_TYPE_USINT";
4033
+ readonly ProfinetIoTypeSint: "PROFINET_IO_TYPE_SINT";
4034
+ readonly ProfinetIoTypeUint: "PROFINET_IO_TYPE_UINT";
4035
+ readonly ProfinetIoTypeInt: "PROFINET_IO_TYPE_INT";
4036
+ readonly ProfinetIoTypeUdint: "PROFINET_IO_TYPE_UDINT";
4037
+ readonly ProfinetIoTypeDint: "PROFINET_IO_TYPE_DINT";
4038
+ readonly ProfinetIoTypeReal: "PROFINET_IO_TYPE_REAL";
4039
+ readonly ProfinetIoTypeLreal: "PROFINET_IO_TYPE_LREAL";
4040
+ };
4041
+ export type ProfinetIOTypeEnum = typeof ProfinetIOTypeEnum[keyof typeof ProfinetIOTypeEnum];
4042
+ /**
4043
+ *
4044
+ * @export
4045
+ * @interface ProfinetInputOutputConfig
4046
+ */
4047
+ export interface ProfinetInputOutputConfig {
4048
+ /**
4049
+ * Content of the input output configuration file.
4050
+ * @type {string}
4051
+ * @memberof ProfinetInputOutputConfig
4052
+ */
4053
+ 'config': string;
4054
+ /**
4055
+ * Offset in bytes for the input data.
4056
+ * @type {number}
4057
+ * @memberof ProfinetInputOutputConfig
4058
+ */
4059
+ 'input_offset': number;
4060
+ /**
4061
+ * Offset in bytes for the output data.
4062
+ * @type {number}
4063
+ * @memberof ProfinetInputOutputConfig
4064
+ */
4065
+ 'output_offset': number;
4066
+ }
4067
+ /**
4068
+ *
4069
+ * @export
4070
+ * @interface ProfinetSlotDescription
4071
+ */
4072
+ export interface ProfinetSlotDescription {
4073
+ /**
4074
+ * The number of the PROFINET slot.
4075
+ * @type {number}
4076
+ * @memberof ProfinetSlotDescription
4077
+ */
4078
+ 'number': number;
4079
+ /**
4080
+ * The API number of the PROFINET input, used to identify the specific API for the input.
4081
+ * @type {number}
4082
+ * @memberof ProfinetSlotDescription
4083
+ */
4084
+ 'api': number;
4085
+ /**
4086
+ * An array of PROFINET subslots.
4087
+ * @type {Array<ProfinetSubSlotDescription>}
4088
+ * @memberof ProfinetSlotDescription
4089
+ */
4090
+ 'subslots': Array<ProfinetSubSlotDescription>;
4091
+ }
4092
+ /**
4093
+ *
4094
+ * @export
4095
+ * @interface ProfinetSubSlotDescription
4096
+ */
4097
+ export interface ProfinetSubSlotDescription {
4098
+ /**
4099
+ * The identifier of the PROFINET subslot.
4100
+ * @type {number}
4101
+ * @memberof ProfinetSubSlotDescription
4102
+ */
4103
+ 'number': number;
4104
+ /**
4105
+ * The length in bytes of the PROFINET input.
4106
+ * @type {number}
4107
+ * @memberof ProfinetSubSlotDescription
4108
+ */
4109
+ 'input_length': number;
4110
+ /**
4111
+ * The length in bytes of the PROFINET output.
4112
+ * @type {number}
4113
+ * @memberof ProfinetSubSlotDescription
4114
+ */
4115
+ 'output_length': number;
4116
+ }
4117
+ /**
4118
+ * <!-- 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.
4119
+ * @export
4120
+ * @interface RRTConnectAlgorithm
4121
+ */
4122
+ export interface RRTConnectAlgorithm {
4123
+ /**
4124
+ * Algorithm discriminator.
4125
+ * @type {string}
4126
+ * @memberof RRTConnectAlgorithm
4127
+ */
4128
+ 'algorithm_name': RRTConnectAlgorithmAlgorithmNameEnum;
4129
+ /**
4130
+ * Maximum number of iterations for the RRT Connect algorithm. Higher values increase likelihood of success, but also computation time.
4131
+ * @type {number}
4132
+ * @memberof RRTConnectAlgorithm
4133
+ */
4134
+ 'max_iterations'?: number;
4135
+ }
4136
+ export declare const RRTConnectAlgorithmAlgorithmNameEnum: {
4137
+ readonly RrtConnectAlgorithm: "RRTConnectAlgorithm";
4138
+ };
4139
+ export type RRTConnectAlgorithmAlgorithmNameEnum = typeof RRTConnectAlgorithmAlgorithmNameEnum[keyof typeof RRTConnectAlgorithmAlgorithmNameEnum];
3358
4140
  /**
3359
4141
  * Defines an x/y-plane with finite size. Centred around the z-axis.
3360
4142
  * @export
@@ -3436,7 +4218,7 @@ export type ReleaseChannel = typeof ReleaseChannel[keyof typeof ReleaseChannel];
3436
4218
  */
3437
4219
  export interface RobotController {
3438
4220
  /**
3439
- * A unique name of the Controller inside the Cell. It must be a valid k8s label name as defined by [RFC 1035](https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#rfc-1035-label-names).
4221
+ * Unique name of controller within the cell. It must be a valid k8s label name as defined by [RFC 1035](https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#rfc-1035-label-names).
3440
4222
  * @type {string}
3441
4223
  * @memberof RobotController
3442
4224
  */
@@ -3459,6 +4241,18 @@ export type RobotControllerConfiguration = AbbController | FanucController | Kuk
3459
4241
  * @interface RobotControllerState
3460
4242
  */
3461
4243
  export interface RobotControllerState {
4244
+ /**
4245
+ * Mode of communication and control between NOVA and the robot controller.
4246
+ * @type {RobotSystemMode}
4247
+ * @memberof RobotControllerState
4248
+ */
4249
+ 'mode': RobotSystemMode;
4250
+ /**
4251
+ * Last error stack encountered during initialization process or after a controller disconnect. At this stage, it\'s unclear whether the error is fatal. Evaluate `last_error` to decide whether to remove the controller using `deleteController`. Examples: - Delete required: Host resolution fails repeatedly due to an incorrect IP. - Delete not required: Temporary network delay caused a disconnect; the system will auto-reconnect.
4252
+ * @type {Array<string>}
4253
+ * @memberof RobotControllerState
4254
+ */
4255
+ 'last_error'?: Array<string>;
3462
4256
  /**
3463
4257
  * Timestamp indicating when the represented information was received from the robot controller.
3464
4258
  * @type {string}
@@ -3503,67 +4297,16 @@ export interface RobotControllerState {
3503
4297
  'motion_groups': Array<MotionGroupState>;
3504
4298
  }
3505
4299
  /**
3506
- *
3507
- * @export
3508
- * @interface RobotSetup
3509
- */
3510
- export interface RobotSetup {
3511
- /**
3512
- * String identifiying the model of a motion group.
3513
- * @type {string}
3514
- * @memberof RobotSetup
3515
- */
3516
- 'motion_group_model': string;
3517
- /**
3518
- * [ms] cycle time of the motion group controller. A trajectory for this motion group should be computed to this resolution.
3519
- * @type {number}
3520
- * @memberof RobotSetup
3521
- */
3522
- 'cycle_time': number;
3523
- /**
3524
- * The offset from the world frame to the motion group base.
3525
- * @type {Pose}
3526
- * @memberof RobotSetup
3527
- */
3528
- 'mounting'?: Pose;
3529
- /**
3530
- *
3531
- * @type {Pose}
3532
- * @memberof RobotSetup
3533
- */
3534
- 'tcp_offset'?: Pose;
3535
- /**
3536
- *
3537
- * @type {LimitSet}
3538
- * @memberof RobotSetup
3539
- */
3540
- 'global_limits'?: LimitSet;
3541
- /**
3542
- *
3543
- * @type {Payload}
3544
- * @memberof RobotSetup
3545
- */
3546
- 'payload'?: Payload;
3547
- /**
3548
- * 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.
3549
- * @type {{ [key: string]: SingleMotionGroupCollisionScene; }}
3550
- * @memberof RobotSetup
3551
- */
3552
- 'collision_scenes'?: {
3553
- [key: string]: SingleMotionGroupCollisionScene;
3554
- };
3555
- }
3556
- /**
3557
- * 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.
4300
+ * Defines the current system mode of the robot system, including NOVA communicating with the robot controller. ### MODE_CONTROLLER_NOT_CONFIGURED No controller with the specified identifier is configured. Call [addRobotController](addRobotController) to register a controller. ### MODE_INITIALIZING Indicates that a connection to the robot controller is established or reestablished in case of a disconnect. On success, the controller is set to MODE_MONITOR. On failure, the initialization process is retried until successful or cancelled by the user. ### MODE_MONITOR Read-only mode with an active controller connection. - Receives robot state and I/O signals - Move requests are rejected - No commands are sent to the controller ### MODE_CONTROL Active control mode. **Movement is possible in this mode** The robot is cyclically commanded to hold its current position. The robot state is received in sync with the controller cycle. Motion and jogging requests are accepted and executed. Input/Output interaction is enabled. ### MODE_FREE_DRIVE Read-only mode with servo motors enabled for manual movement (Free Drive). Move requests are rejected. Not supported by all robots: Use [getSupportedModes](getSupportedModes) to check Free Drive availability.
3558
4301
  * @export
3559
4302
  * @enum {string}
3560
4303
  */
3561
4304
  export declare const RobotSystemMode: {
3562
- readonly RobotSystemModeUndefined: "ROBOT_SYSTEM_MODE_UNDEFINED";
3563
- readonly RobotSystemModeDisconnect: "ROBOT_SYSTEM_MODE_DISCONNECT";
3564
- readonly RobotSystemModeMonitor: "ROBOT_SYSTEM_MODE_MONITOR";
3565
- readonly RobotSystemModeControl: "ROBOT_SYSTEM_MODE_CONTROL";
3566
- readonly RobotSystemModeFreeDrive: "ROBOT_SYSTEM_MODE_FREE_DRIVE";
4305
+ readonly ModeControllerNotConfigured: "MODE_CONTROLLER_NOT_CONFIGURED";
4306
+ readonly ModeInitializing: "MODE_INITIALIZING";
4307
+ readonly ModeMonitor: "MODE_MONITOR";
4308
+ readonly ModeControl: "MODE_CONTROL";
4309
+ readonly ModeFreeDrive: "MODE_FREE_DRIVE";
3567
4310
  };
3568
4311
  export type RobotSystemMode = typeof RobotSystemMode[keyof typeof RobotSystemMode];
3569
4312
  /**
@@ -3635,49 +4378,9 @@ export interface RobotTcpData {
3635
4378
  'orientation_type'?: OrientationType;
3636
4379
  }
3637
4380
  /**
3638
- *
4381
+ * Current safety state of the configured robot controller. Operation modes in which the attached motion groups can be moved are: - SAFETY_STATE_NORMAL - SAFETY_STATE_REDUCED All other modes are considered as non-operational.
3639
4382
  * @export
3640
- * @interface Running
3641
- */
3642
- export interface Running {
3643
- /**
3644
- *
3645
- * @type {string}
3646
- * @memberof Running
3647
- */
3648
- 'kind': RunningKindEnum;
3649
- }
3650
- export declare const RunningKindEnum: {
3651
- readonly Running: "RUNNING";
3652
- };
3653
- export type RunningKindEnum = typeof RunningKindEnum[keyof typeof RunningKindEnum];
3654
- /**
3655
- *
3656
- * @export
3657
- * @interface Running1
3658
- */
3659
- export interface Running1 {
3660
- /**
3661
- *
3662
- * @type {string}
3663
- * @memberof Running1
3664
- */
3665
- 'kind': Running1KindEnum;
3666
- /**
3667
- * Remaining time in milliseconds (ms) to reach the end of the motion.
3668
- * @type {number}
3669
- * @memberof Running1
3670
- */
3671
- 'time_to_end': number;
3672
- }
3673
- export declare const Running1KindEnum: {
3674
- readonly Running: "RUNNING";
3675
- };
3676
- export type Running1KindEnum = typeof Running1KindEnum[keyof typeof Running1KindEnum];
3677
- /**
3678
- * Current safety state of the configured robot controller. Operation modes in which the attached motion groups can be moved are: - SAFETY_STATE_NORMAL - SAFETY_STATE_REDUCED All other modes are considered as non-operational.
3679
- * @export
3680
- * @enum {string}
4383
+ * @enum {string}
3681
4384
  */
3682
4385
  export declare const SafetyStateType: {
3683
4386
  readonly SafetyStateUnknown: "SAFETY_STATE_UNKNOWN";
@@ -3822,43 +4525,6 @@ export declare const SettableRobotSystemMode: {
3822
4525
  readonly RobotSystemModeControl: "ROBOT_SYSTEM_MODE_CONTROL";
3823
4526
  };
3824
4527
  export type SettableRobotSystemMode = typeof SettableRobotSystemMode[keyof typeof SettableRobotSystemMode];
3825
- /**
3826
- *
3827
- * @export
3828
- * @interface SingleMotionGroupCollisionScene
3829
- */
3830
- export interface SingleMotionGroupCollisionScene {
3831
- /**
3832
- * A collection of identifiable colliders.
3833
- * @type {{ [key: string]: Collider; }}
3834
- * @memberof SingleMotionGroupCollisionScene
3835
- */
3836
- 'static_colliders'?: {
3837
- [key: string]: Collider;
3838
- };
3839
- /**
3840
- * 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.
3841
- * @type {Array<{ [key: string]: Collider; }>}
3842
- * @memberof SingleMotionGroupCollisionScene
3843
- */
3844
- 'link_chain'?: Array<{
3845
- [key: string]: Collider;
3846
- }>;
3847
- /**
3848
- * 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.
3849
- * @type {{ [key: string]: Collider; }}
3850
- * @memberof SingleMotionGroupCollisionScene
3851
- */
3852
- 'tool'?: {
3853
- [key: string]: Collider;
3854
- };
3855
- /**
3856
- * If true, self-collision detection is enabled for the motion group. See LinkChain documentation for details. Default is true.
3857
- * @type {boolean}
3858
- * @memberof SingleMotionGroupCollisionScene
3859
- */
3860
- 'motion_group_self_collision_detection'?: boolean;
3861
- }
3862
4528
  /**
3863
4529
  *
3864
4530
  * @export
@@ -3910,7 +4576,7 @@ export interface StartMovementRequest {
3910
4576
  * @type {Direction}
3911
4577
  * @memberof StartMovementRequest
3912
4578
  */
3913
- 'direction': Direction;
4579
+ 'direction'?: Direction;
3914
4580
  /**
3915
4581
  * Attaches a list of output commands to the trajectory. The outputs are set to the specified values right after the specified location was reached. If the specified location is located before the start location (forward direction: value is smaller, backward direction: value is bigger), the output is not set.
3916
4582
  * @type {Array<IOValue>}
@@ -4197,7 +4863,24 @@ export type TrajectoryDetailsKindEnum = typeof TrajectoryDetailsKindEnum[keyof t
4197
4863
  * @type TrajectoryDetailsState
4198
4864
  * @export
4199
4865
  */
4200
- export type TrajectoryDetailsState = EndOfTrajectory | PausedByRequest | PausedOnIO | Running1 | WaitForIO;
4866
+ export type TrajectoryDetailsState = TrajectoryEnded | TrajectoryPausedByUser | TrajectoryPausedOnIO | TrajectoryRunning | TrajectoryWaitForIO;
4867
+ /**
4868
+ *
4869
+ * @export
4870
+ * @interface TrajectoryEnded
4871
+ */
4872
+ export interface TrajectoryEnded {
4873
+ /**
4874
+ *
4875
+ * @type {string}
4876
+ * @memberof TrajectoryEnded
4877
+ */
4878
+ 'kind': TrajectoryEndedKindEnum;
4879
+ }
4880
+ export declare const TrajectoryEndedKindEnum: {
4881
+ readonly EndOfTrajectory: "END_OF_TRAJECTORY";
4882
+ };
4883
+ export type TrajectoryEndedKindEnum = typeof TrajectoryEndedKindEnum[keyof typeof TrajectoryEndedKindEnum];
4201
4884
  /**
4202
4885
  *
4203
4886
  * @export
@@ -4221,6 +4904,80 @@ export declare const TrajectoryIdMessageTypeEnum: {
4221
4904
  readonly TrajectoryId: "TrajectoryId";
4222
4905
  };
4223
4906
  export type TrajectoryIdMessageTypeEnum = typeof TrajectoryIdMessageTypeEnum[keyof typeof TrajectoryIdMessageTypeEnum];
4907
+ /**
4908
+ *
4909
+ * @export
4910
+ * @interface TrajectoryPausedByUser
4911
+ */
4912
+ export interface TrajectoryPausedByUser {
4913
+ /**
4914
+ *
4915
+ * @type {string}
4916
+ * @memberof TrajectoryPausedByUser
4917
+ */
4918
+ 'kind': TrajectoryPausedByUserKindEnum;
4919
+ }
4920
+ export declare const TrajectoryPausedByUserKindEnum: {
4921
+ readonly PausedByUser: "PAUSED_BY_USER";
4922
+ };
4923
+ export type TrajectoryPausedByUserKindEnum = typeof TrajectoryPausedByUserKindEnum[keyof typeof TrajectoryPausedByUserKindEnum];
4924
+ /**
4925
+ *
4926
+ * @export
4927
+ * @interface TrajectoryPausedOnIO
4928
+ */
4929
+ export interface TrajectoryPausedOnIO {
4930
+ /**
4931
+ *
4932
+ * @type {string}
4933
+ * @memberof TrajectoryPausedOnIO
4934
+ */
4935
+ 'kind': TrajectoryPausedOnIOKindEnum;
4936
+ }
4937
+ export declare const TrajectoryPausedOnIOKindEnum: {
4938
+ readonly PausedOnIo: "PAUSED_ON_IO";
4939
+ };
4940
+ export type TrajectoryPausedOnIOKindEnum = typeof TrajectoryPausedOnIOKindEnum[keyof typeof TrajectoryPausedOnIOKindEnum];
4941
+ /**
4942
+ *
4943
+ * @export
4944
+ * @interface TrajectoryRunning
4945
+ */
4946
+ export interface TrajectoryRunning {
4947
+ /**
4948
+ *
4949
+ * @type {string}
4950
+ * @memberof TrajectoryRunning
4951
+ */
4952
+ 'kind': TrajectoryRunningKindEnum;
4953
+ /**
4954
+ * Remaining time in milliseconds (ms) to reach the end of the motion.
4955
+ * @type {number}
4956
+ * @memberof TrajectoryRunning
4957
+ */
4958
+ 'time_to_end': number;
4959
+ }
4960
+ export declare const TrajectoryRunningKindEnum: {
4961
+ readonly Running: "RUNNING";
4962
+ };
4963
+ export type TrajectoryRunningKindEnum = typeof TrajectoryRunningKindEnum[keyof typeof TrajectoryRunningKindEnum];
4964
+ /**
4965
+ *
4966
+ * @export
4967
+ * @interface TrajectoryWaitForIO
4968
+ */
4969
+ export interface TrajectoryWaitForIO {
4970
+ /**
4971
+ *
4972
+ * @type {string}
4973
+ * @memberof TrajectoryWaitForIO
4974
+ */
4975
+ 'kind': TrajectoryWaitForIOKindEnum;
4976
+ }
4977
+ export declare const TrajectoryWaitForIOKindEnum: {
4978
+ readonly WaitForIo: "WAIT_FOR_IO";
4979
+ };
4980
+ export type TrajectoryWaitForIOKindEnum = typeof TrajectoryWaitForIOKindEnum[keyof typeof TrajectoryWaitForIOKindEnum];
4224
4981
  /**
4225
4982
  * The unit of input/output value.
4226
4983
  * @export
@@ -4299,6 +5056,14 @@ export interface ValidationError {
4299
5056
  * @memberof ValidationError
4300
5057
  */
4301
5058
  'type': string;
5059
+ /**
5060
+ *
5061
+ * @type {{ [key: string]: any; }}
5062
+ * @memberof ValidationError
5063
+ */
5064
+ 'input': {
5065
+ [key: string]: any;
5066
+ };
4302
5067
  }
4303
5068
  /**
4304
5069
  * @type ValidationErrorLocInner
@@ -4306,7 +5071,7 @@ export interface ValidationError {
4306
5071
  */
4307
5072
  export type ValidationErrorLocInner = number | string;
4308
5073
  /**
4309
- * The configuration of a virtual robot controller has to contain the manufacturer string, an optional joint position string array and either a type or the full JSON configuration. The JSON config of a physical controller can be obtained via `/cells/{cell}/controllers/{controller}/virtual-robot-configuration`
5074
+ * The configuration of a virtual robot controller has to contain the manufacturer string, an optional joint position string array and either a preset `type` **or** the complete JSON configuration.
4310
5075
  * @export
4311
5076
  * @interface VirtualController
4312
5077
  */
@@ -4330,7 +5095,7 @@ export interface VirtualController {
4330
5095
  */
4331
5096
  'type'?: VirtualControllerTypes;
4332
5097
  /**
4333
- *
5098
+ * Complete JSON configuration of the virtual robot controller. Can be obtained from the physical controller\'s configuration via [getVirtualControllerConfiguration](getVirtualControllerConfiguration). If provided, the `type` field should not be used.
4334
5099
  * @type {string}
4335
5100
  * @memberof VirtualController
4336
5101
  */
@@ -4340,7 +5105,7 @@ export interface VirtualController {
4340
5105
  * @type {string}
4341
5106
  * @memberof VirtualController
4342
5107
  */
4343
- 'position'?: string;
5108
+ 'initial_joint_position'?: string;
4344
5109
  }
4345
5110
  export declare const VirtualControllerKindEnum: {
4346
5111
  readonly VirtualController: "VirtualController";
@@ -4386,6 +5151,7 @@ export declare const VirtualControllerTypes: {
4386
5151
  readonly FanucCrx20ial: "fanuc-crx20ial";
4387
5152
  readonly FanucCrx25ia: "fanuc-crx25ia";
4388
5153
  readonly FanucCrx30ia: "fanuc-crx30ia";
5154
+ readonly FanucCrx5ia: "fanuc-crx5ia";
4389
5155
  readonly FanucLrMate200iD: "fanuc-lr_mate_200iD";
4390
5156
  readonly FanucLrMate200iD4S: "fanuc-lr_mate_200iD4S";
4391
5157
  readonly FanucLrMate200iD7L: "fanuc-lr_mate_200iD7L";
@@ -4393,6 +5159,7 @@ export declare const VirtualControllerTypes: {
4393
5159
  readonly FanucM10iD16S: "fanuc-m10iD16S";
4394
5160
  readonly FanucM20iD25: "fanuc-m20iD25";
4395
5161
  readonly FanucM20iD35: "fanuc-m20iD35";
5162
+ readonly FanucM710iC20L: "fanuc-m710iC20L";
4396
5163
  readonly FanucM900iB280L: "fanuc-m900iB280L";
4397
5164
  readonly FanucM900iB360E: "fanuc-m900iB360E";
4398
5165
  readonly FanucR2000ic125l: "fanuc-r2000ic125l";
@@ -4481,323 +5248,807 @@ export interface VirtualRobotConfiguration {
4481
5248
  'content': string;
4482
5249
  }
4483
5250
  /**
4484
- *
5251
+ * The value to compare with the current value of the input/output.
5252
+ * @export
5253
+ * @interface WaitForIOEventRequest
5254
+ */
5255
+ export interface WaitForIOEventRequest {
5256
+ /**
5257
+ *
5258
+ * @type {IOValue}
5259
+ * @memberof WaitForIOEventRequest
5260
+ */
5261
+ 'io': IOValue;
5262
+ /**
5263
+ * Comparator for the comparison of two values. Use the measured I/O as the base value (a) and the expected input/output value as the comparator (b): e.g., a > b.
5264
+ * @type {Comparator}
5265
+ * @memberof WaitForIOEventRequest
5266
+ */
5267
+ 'comparator': Comparator;
5268
+ }
5269
+ /**
5270
+ * The configuration of a physical Yaskawa robot controller has to contain IP address of the controller.
4485
5271
  * @export
4486
- * @interface WaitForIO
5272
+ * @interface YaskawaController
4487
5273
  */
4488
- export interface WaitForIO {
5274
+ export interface YaskawaController {
5275
+ /**
5276
+ *
5277
+ * @type {string}
5278
+ * @memberof YaskawaController
5279
+ */
5280
+ 'kind'?: YaskawaControllerKindEnum;
4489
5281
  /**
4490
5282
  *
4491
5283
  * @type {string}
4492
- * @memberof WaitForIO
5284
+ * @memberof YaskawaController
4493
5285
  */
4494
- 'kind': WaitForIOKindEnum;
5286
+ 'controller_ip': string;
4495
5287
  }
4496
- export declare const WaitForIOKindEnum: {
4497
- readonly WaitForIo: "WAIT_FOR_IO";
5288
+ export declare const YaskawaControllerKindEnum: {
5289
+ readonly YaskawaController: "YaskawaController";
4498
5290
  };
4499
- export type WaitForIOKindEnum = typeof WaitForIOKindEnum[keyof typeof WaitForIOKindEnum];
5291
+ export type YaskawaControllerKindEnum = typeof YaskawaControllerKindEnum[keyof typeof YaskawaControllerKindEnum];
4500
5292
  /**
4501
- * The value to compare with the current value of the input/output.
5293
+ * ApplicationApi - axios parameter creator
4502
5294
  * @export
4503
- * @interface WaitForIOEventRequest
4504
5295
  */
4505
- export interface WaitForIOEventRequest {
5296
+ export declare const ApplicationApiAxiosParamCreator: (configuration?: Configuration) => {
4506
5297
  /**
4507
- *
4508
- * @type {IOValue}
4509
- * @memberof WaitForIOEventRequest
5298
+ * 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.
5299
+ * @summary Add Application
5300
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
5301
+ * @param {App} app
5302
+ * @param {number} [completionTimeout]
5303
+ * @param {*} [options] Override http request option.
5304
+ * @throws {RequiredError}
5305
+ */
5306
+ addApp: (cell: string, app: App, completionTimeout?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
5307
+ /**
5308
+ * Delete all GUI applications from the cell.
5309
+ * @summary Clear Applications
5310
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
5311
+ * @param {number} [completionTimeout]
5312
+ * @param {*} [options] Override http request option.
5313
+ * @throws {RequiredError}
5314
+ */
5315
+ clearApps: (cell: string, completionTimeout?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
5316
+ /**
5317
+ * Delete a GUI application from the cell.
5318
+ * @summary Delete Application
5319
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
5320
+ * @param {string} app
5321
+ * @param {number} [completionTimeout]
5322
+ * @param {*} [options] Override http request option.
5323
+ * @throws {RequiredError}
5324
+ */
5325
+ deleteApp: (cell: string, app: string, completionTimeout?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
5326
+ /**
5327
+ * 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.
5328
+ * @summary Configuration
5329
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
5330
+ * @param {string} app
5331
+ * @param {*} [options] Override http request option.
5332
+ * @throws {RequiredError}
5333
+ */
5334
+ getApp: (cell: string, app: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
5335
+ /**
5336
+ * 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.
5337
+ * @summary List Applications
5338
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
5339
+ * @param {*} [options] Override http request option.
5340
+ * @throws {RequiredError}
5341
+ */
5342
+ listApps: (cell: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
5343
+ /**
5344
+ * Update the configuration of a GUI application in the cell.
5345
+ * @summary Update Configuration
5346
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
5347
+ * @param {string} app
5348
+ * @param {App} app2
5349
+ * @param {number} [completionTimeout]
5350
+ * @param {*} [options] Override http request option.
5351
+ * @throws {RequiredError}
5352
+ */
5353
+ updateApp: (cell: string, app: string, app2: App, completionTimeout?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
5354
+ };
5355
+ /**
5356
+ * ApplicationApi - functional programming interface
5357
+ * @export
5358
+ */
5359
+ export declare const ApplicationApiFp: (configuration?: Configuration) => {
5360
+ /**
5361
+ * 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.
5362
+ * @summary Add Application
5363
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
5364
+ * @param {App} app
5365
+ * @param {number} [completionTimeout]
5366
+ * @param {*} [options] Override http request option.
5367
+ * @throws {RequiredError}
5368
+ */
5369
+ addApp(cell: string, app: App, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
5370
+ /**
5371
+ * Delete all GUI applications from the cell.
5372
+ * @summary Clear Applications
5373
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
5374
+ * @param {number} [completionTimeout]
5375
+ * @param {*} [options] Override http request option.
5376
+ * @throws {RequiredError}
5377
+ */
5378
+ clearApps(cell: string, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
5379
+ /**
5380
+ * Delete a GUI application from the cell.
5381
+ * @summary Delete Application
5382
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
5383
+ * @param {string} app
5384
+ * @param {number} [completionTimeout]
5385
+ * @param {*} [options] Override http request option.
5386
+ * @throws {RequiredError}
5387
+ */
5388
+ deleteApp(cell: string, app: string, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
5389
+ /**
5390
+ * 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.
5391
+ * @summary Configuration
5392
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
5393
+ * @param {string} app
5394
+ * @param {*} [options] Override http request option.
5395
+ * @throws {RequiredError}
5396
+ */
5397
+ getApp(cell: string, app: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<App>>;
5398
+ /**
5399
+ * 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.
5400
+ * @summary List Applications
5401
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
5402
+ * @param {*} [options] Override http request option.
5403
+ * @throws {RequiredError}
5404
+ */
5405
+ listApps(cell: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<string>>>;
5406
+ /**
5407
+ * Update the configuration of a GUI application in the cell.
5408
+ * @summary Update Configuration
5409
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
5410
+ * @param {string} app
5411
+ * @param {App} app2
5412
+ * @param {number} [completionTimeout]
5413
+ * @param {*} [options] Override http request option.
5414
+ * @throws {RequiredError}
5415
+ */
5416
+ updateApp(cell: string, app: string, app2: App, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
5417
+ };
5418
+ /**
5419
+ * ApplicationApi - factory interface
5420
+ * @export
5421
+ */
5422
+ export declare const ApplicationApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
5423
+ /**
5424
+ * 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.
5425
+ * @summary Add Application
5426
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
5427
+ * @param {App} app
5428
+ * @param {number} [completionTimeout]
5429
+ * @param {*} [options] Override http request option.
5430
+ * @throws {RequiredError}
5431
+ */
5432
+ addApp(cell: string, app: App, completionTimeout?: number, options?: RawAxiosRequestConfig): AxiosPromise<void>;
5433
+ /**
5434
+ * Delete all GUI applications from the cell.
5435
+ * @summary Clear Applications
5436
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
5437
+ * @param {number} [completionTimeout]
5438
+ * @param {*} [options] Override http request option.
5439
+ * @throws {RequiredError}
5440
+ */
5441
+ clearApps(cell: string, completionTimeout?: number, options?: RawAxiosRequestConfig): AxiosPromise<void>;
5442
+ /**
5443
+ * Delete a GUI application from the cell.
5444
+ * @summary Delete Application
5445
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
5446
+ * @param {string} app
5447
+ * @param {number} [completionTimeout]
5448
+ * @param {*} [options] Override http request option.
5449
+ * @throws {RequiredError}
5450
+ */
5451
+ deleteApp(cell: string, app: string, completionTimeout?: number, options?: RawAxiosRequestConfig): AxiosPromise<void>;
5452
+ /**
5453
+ * 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.
5454
+ * @summary Configuration
5455
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
5456
+ * @param {string} app
5457
+ * @param {*} [options] Override http request option.
5458
+ * @throws {RequiredError}
5459
+ */
5460
+ getApp(cell: string, app: string, options?: RawAxiosRequestConfig): AxiosPromise<App>;
5461
+ /**
5462
+ * 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.
5463
+ * @summary List Applications
5464
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
5465
+ * @param {*} [options] Override http request option.
5466
+ * @throws {RequiredError}
5467
+ */
5468
+ listApps(cell: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<string>>;
5469
+ /**
5470
+ * Update the configuration of a GUI application in the cell.
5471
+ * @summary Update Configuration
5472
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
5473
+ * @param {string} app
5474
+ * @param {App} app2
5475
+ * @param {number} [completionTimeout]
5476
+ * @param {*} [options] Override http request option.
5477
+ * @throws {RequiredError}
5478
+ */
5479
+ updateApp(cell: string, app: string, app2: App, completionTimeout?: number, options?: RawAxiosRequestConfig): AxiosPromise<void>;
5480
+ };
5481
+ /**
5482
+ * ApplicationApi - object-oriented interface
5483
+ * @export
5484
+ * @class ApplicationApi
5485
+ * @extends {BaseAPI}
5486
+ */
5487
+ export declare class ApplicationApi extends BaseAPI {
5488
+ /**
5489
+ * 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.
5490
+ * @summary Add Application
5491
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
5492
+ * @param {App} app
5493
+ * @param {number} [completionTimeout]
5494
+ * @param {*} [options] Override http request option.
5495
+ * @throws {RequiredError}
5496
+ * @memberof ApplicationApi
5497
+ */
5498
+ addApp(cell: string, app: App, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
5499
+ /**
5500
+ * Delete all GUI applications from the cell.
5501
+ * @summary Clear Applications
5502
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
5503
+ * @param {number} [completionTimeout]
5504
+ * @param {*} [options] Override http request option.
5505
+ * @throws {RequiredError}
5506
+ * @memberof ApplicationApi
5507
+ */
5508
+ clearApps(cell: string, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
5509
+ /**
5510
+ * Delete a GUI application from the cell.
5511
+ * @summary Delete Application
5512
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
5513
+ * @param {string} app
5514
+ * @param {number} [completionTimeout]
5515
+ * @param {*} [options] Override http request option.
5516
+ * @throws {RequiredError}
5517
+ * @memberof ApplicationApi
5518
+ */
5519
+ deleteApp(cell: string, app: string, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
5520
+ /**
5521
+ * 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.
5522
+ * @summary Configuration
5523
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
5524
+ * @param {string} app
5525
+ * @param {*} [options] Override http request option.
5526
+ * @throws {RequiredError}
5527
+ * @memberof ApplicationApi
5528
+ */
5529
+ getApp(cell: string, app: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<App, any>>;
5530
+ /**
5531
+ * 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.
5532
+ * @summary List Applications
5533
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
5534
+ * @param {*} [options] Override http request option.
5535
+ * @throws {RequiredError}
5536
+ * @memberof ApplicationApi
5537
+ */
5538
+ listApps(cell: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<string[], any>>;
5539
+ /**
5540
+ * Update the configuration of a GUI application in the cell.
5541
+ * @summary Update Configuration
5542
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
5543
+ * @param {string} app
5544
+ * @param {App} app2
5545
+ * @param {number} [completionTimeout]
5546
+ * @param {*} [options] Override http request option.
5547
+ * @throws {RequiredError}
5548
+ * @memberof ApplicationApi
5549
+ */
5550
+ updateApp(cell: string, app: string, app2: App, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
5551
+ }
5552
+ /**
5553
+ * BUSInputsOutputsApi - axios parameter creator
5554
+ * @export
5555
+ */
5556
+ export declare const BUSInputsOutputsApiAxiosParamCreator: (configuration?: Configuration) => {
5557
+ /**
5558
+ * Add a BUS Inputs/Outputs Service to the cell.
5559
+ * @summary Add Service
5560
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
5561
+ * @param {BusIOType} busIOType
5562
+ * @param {number} [completionTimeout]
5563
+ * @param {*} [options] Override http request option.
5564
+ * @throws {RequiredError}
5565
+ */
5566
+ addBusIOService: (cell: string, busIOType: BusIOType, completionTimeout?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
5567
+ /**
5568
+ * Adds an input/output to or updates an input/output on the PROFINET device.
5569
+ * @summary Add PROFINET Input/Output
5570
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
5571
+ * @param {string} io Unique identifier to address an Input/Output in the cell.
5572
+ * @param {ProfinetIOData} profinetIOData
5573
+ * @param {*} [options] Override http request option.
5574
+ * @throws {RequiredError}
5575
+ */
5576
+ addProfinetIO: (cell: string, io: string, profinetIOData: ProfinetIOData, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
5577
+ /**
5578
+ * Delete BUS Inputs/Outputs Service from the cell.
5579
+ * @summary Clear Service
5580
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
5581
+ * @param {number} [completionTimeout]
5582
+ * @param {*} [options] Override http request option.
5583
+ * @throws {RequiredError}
5584
+ */
5585
+ clearBusIOService: (cell: string, completionTimeout?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
5586
+ /**
5587
+ * Removes the input/output from the PROFINET device.
5588
+ * @summary Remove PROFINET Input/Ouptut
5589
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
5590
+ * @param {string} io Unique identifier to address an Input/Output in the cell.
5591
+ * @param {*} [options] Override http request option.
5592
+ * @throws {RequiredError}
5593
+ */
5594
+ deleteProfinetIO: (cell: string, io: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
5595
+ /**
5596
+ * Get deployed BUS Inputs/Outputs Service.
5597
+ * @summary Get Service
5598
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
5599
+ * @param {*} [options] Override http request option.
5600
+ * @throws {RequiredError}
5601
+ */
5602
+ getBusIOService: (cell: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
5603
+ /**
5604
+ * Get the current state of the BUS Inputs/Outputs service.
5605
+ * @summary State
5606
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
5607
+ * @param {*} [options] Override http request option.
5608
+ * @throws {RequiredError}
5609
+ */
5610
+ getBusIOState: (cell: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
5611
+ /**
5612
+ * 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).
5613
+ * @summary Get Input/Output Values
5614
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
5615
+ * @param {Array<string>} [ios]
5616
+ * @param {*} [options] Override http request option.
5617
+ * @throws {RequiredError}
5618
+ */
5619
+ getBusIOValues: (cell: string, ios?: Array<string>, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
5620
+ /**
5621
+ * Get description of PROFINET
5622
+ * @summary Get PROFINET Description
5623
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
5624
+ * @param {*} [options] Override http request option.
5625
+ * @throws {RequiredError}
5626
+ */
5627
+ getProfinetDescription: (cell: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
5628
+ /**
5629
+ * Get input/output configuration of the PROFINET device as file.
5630
+ * @summary PROFINET Inputs/Outputs to File
5631
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
5632
+ * @param {number} [inputOffset]
5633
+ * @param {number} [outputOffset]
5634
+ * @param {*} [options] Override http request option.
5635
+ * @throws {RequiredError}
5636
+ */
5637
+ getProfinetIOsFromFile: (cell: string, inputOffset?: number, outputOffset?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
5638
+ /**
5639
+ * List all BUS Input/Output descriptions.
5640
+ * @summary List Descriptions
5641
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
5642
+ * @param {*} [options] Override http request option.
5643
+ * @throws {RequiredError}
5644
+ */
5645
+ listBusIODescriptions: (cell: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
5646
+ /**
5647
+ * List all PROFINET input and outputs.
5648
+ * @summary List PROFINET Input/Output Configuration
5649
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
5650
+ * @param {*} [options] Override http request option.
5651
+ * @throws {RequiredError}
5652
+ */
5653
+ listProfinetIOs: (cell: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
5654
+ /**
5655
+ * 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.
5656
+ * @summary Set Output Values
5657
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
5658
+ * @param {Array<IOValue>} iOValue
5659
+ * @param {*} [options] Override http request option.
5660
+ * @throws {RequiredError}
5661
+ */
5662
+ setBusIOValues: (cell: string, iOValue: Array<IOValue>, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
5663
+ /**
5664
+ * Sets inputs/outputs on the PROFINET device from file.
5665
+ * @summary Set PROFINET Inputs/Outputs from File
5666
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
5667
+ * @param {ProfinetInputOutputConfig} profinetInputOutputConfig
5668
+ * @param {*} [options] Override http request option.
5669
+ * @throws {RequiredError}
5670
+ */
5671
+ setProfinetIOsFromFile: (cell: string, profinetInputOutputConfig: ProfinetInputOutputConfig, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
5672
+ };
5673
+ /**
5674
+ * BUSInputsOutputsApi - functional programming interface
5675
+ * @export
5676
+ */
5677
+ export declare const BUSInputsOutputsApiFp: (configuration?: Configuration) => {
5678
+ /**
5679
+ * Add a BUS Inputs/Outputs Service to the cell.
5680
+ * @summary Add Service
5681
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
5682
+ * @param {BusIOType} busIOType
5683
+ * @param {number} [completionTimeout]
5684
+ * @param {*} [options] Override http request option.
5685
+ * @throws {RequiredError}
5686
+ */
5687
+ addBusIOService(cell: string, busIOType: BusIOType, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
5688
+ /**
5689
+ * Adds an input/output to or updates an input/output on the PROFINET device.
5690
+ * @summary Add PROFINET Input/Output
5691
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
5692
+ * @param {string} io Unique identifier to address an Input/Output in the cell.
5693
+ * @param {ProfinetIOData} profinetIOData
5694
+ * @param {*} [options] Override http request option.
5695
+ * @throws {RequiredError}
5696
+ */
5697
+ addProfinetIO(cell: string, io: string, profinetIOData: ProfinetIOData, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
5698
+ /**
5699
+ * Delete BUS Inputs/Outputs Service from the cell.
5700
+ * @summary Clear Service
5701
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
5702
+ * @param {number} [completionTimeout]
5703
+ * @param {*} [options] Override http request option.
5704
+ * @throws {RequiredError}
5705
+ */
5706
+ clearBusIOService(cell: string, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
5707
+ /**
5708
+ * Removes the input/output from the PROFINET device.
5709
+ * @summary Remove PROFINET Input/Ouptut
5710
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
5711
+ * @param {string} io Unique identifier to address an Input/Output in the cell.
5712
+ * @param {*} [options] Override http request option.
5713
+ * @throws {RequiredError}
5714
+ */
5715
+ deleteProfinetIO(cell: string, io: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
5716
+ /**
5717
+ * Get deployed BUS Inputs/Outputs Service.
5718
+ * @summary Get Service
5719
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
5720
+ * @param {*} [options] Override http request option.
5721
+ * @throws {RequiredError}
5722
+ */
5723
+ getBusIOService(cell: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BusIOType>>;
5724
+ /**
5725
+ * Get the current state of the BUS Inputs/Outputs service.
5726
+ * @summary State
5727
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
5728
+ * @param {*} [options] Override http request option.
5729
+ * @throws {RequiredError}
5730
+ */
5731
+ getBusIOState(cell: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BusIOsState>>;
5732
+ /**
5733
+ * 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).
5734
+ * @summary Get Input/Output Values
5735
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
5736
+ * @param {Array<string>} [ios]
5737
+ * @param {*} [options] Override http request option.
5738
+ * @throws {RequiredError}
5739
+ */
5740
+ getBusIOValues(cell: string, ios?: Array<string>, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<IOValue>>>;
5741
+ /**
5742
+ * Get description of PROFINET
5743
+ * @summary Get PROFINET Description
5744
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
5745
+ * @param {*} [options] Override http request option.
5746
+ * @throws {RequiredError}
5747
+ */
5748
+ getProfinetDescription(cell: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ProfinetDescription>>;
5749
+ /**
5750
+ * Get input/output configuration of the PROFINET device as file.
5751
+ * @summary PROFINET Inputs/Outputs to File
5752
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
5753
+ * @param {number} [inputOffset]
5754
+ * @param {number} [outputOffset]
5755
+ * @param {*} [options] Override http request option.
5756
+ * @throws {RequiredError}
5757
+ */
5758
+ getProfinetIOsFromFile(cell: string, inputOffset?: number, outputOffset?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<string>>;
5759
+ /**
5760
+ * List all BUS Input/Output descriptions.
5761
+ * @summary List Descriptions
5762
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
5763
+ * @param {*} [options] Override http request option.
5764
+ * @throws {RequiredError}
4510
5765
  */
4511
- 'io': IOValue;
5766
+ listBusIODescriptions(cell: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<IODescription>>>;
4512
5767
  /**
4513
- * Comparator for the comparison of two values. Use the measured I/O as the base value (a) and the expected input/output value as the comparator (b): e.g., a > b.
4514
- * @type {Comparator}
4515
- * @memberof WaitForIOEventRequest
5768
+ * List all PROFINET input and outputs.
5769
+ * @summary List PROFINET Input/Output Configuration
5770
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
5771
+ * @param {*} [options] Override http request option.
5772
+ * @throws {RequiredError}
4516
5773
  */
4517
- 'comparator': Comparator;
4518
- }
4519
- /**
4520
- * The configuration of a physical Yaskawa robot controller has to contain IP address of the controller.
4521
- * @export
4522
- * @interface YaskawaController
4523
- */
4524
- export interface YaskawaController {
5774
+ listProfinetIOs(cell: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<ProfinetIO>>>;
4525
5775
  /**
4526
- *
4527
- * @type {string}
4528
- * @memberof YaskawaController
5776
+ * 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.
5777
+ * @summary Set Output Values
5778
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
5779
+ * @param {Array<IOValue>} iOValue
5780
+ * @param {*} [options] Override http request option.
5781
+ * @throws {RequiredError}
4529
5782
  */
4530
- 'kind'?: YaskawaControllerKindEnum;
5783
+ setBusIOValues(cell: string, iOValue: Array<IOValue>, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
4531
5784
  /**
4532
- *
4533
- * @type {string}
4534
- * @memberof YaskawaController
5785
+ * Sets inputs/outputs on the PROFINET device from file.
5786
+ * @summary Set PROFINET Inputs/Outputs from File
5787
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
5788
+ * @param {ProfinetInputOutputConfig} profinetInputOutputConfig
5789
+ * @param {*} [options] Override http request option.
5790
+ * @throws {RequiredError}
4535
5791
  */
4536
- 'controller_ip': string;
4537
- }
4538
- export declare const YaskawaControllerKindEnum: {
4539
- readonly YaskawaController: "YaskawaController";
5792
+ setProfinetIOsFromFile(cell: string, profinetInputOutputConfig: ProfinetInputOutputConfig, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
4540
5793
  };
4541
- export type YaskawaControllerKindEnum = typeof YaskawaControllerKindEnum[keyof typeof YaskawaControllerKindEnum];
4542
5794
  /**
4543
- * ApplicationApi - axios parameter creator
5795
+ * BUSInputsOutputsApi - factory interface
4544
5796
  * @export
4545
5797
  */
4546
- export declare const ApplicationApiAxiosParamCreator: (configuration?: Configuration) => {
5798
+ export declare const BUSInputsOutputsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
4547
5799
  /**
4548
- * 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 endpoint where the API is reachable from the container serving the Application. > - `BASE_PATH`: The root path of the deployed Application. It will be reachable via: http://$host/$BASE_PATH > - `CELL_NAME`: The name of the cell where the application is deployed.
4549
- * @summary Add Application
5800
+ * Add a BUS Inputs/Outputs Service to the cell.
5801
+ * @summary Add Service
4550
5802
  * @param {string} cell Unique identifier addressing a cell in all API calls.
4551
- * @param {App} app
5803
+ * @param {BusIOType} busIOType
4552
5804
  * @param {number} [completionTimeout]
4553
5805
  * @param {*} [options] Override http request option.
4554
5806
  * @throws {RequiredError}
4555
5807
  */
4556
- addApp: (cell: string, app: App, completionTimeout?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
5808
+ addBusIOService(cell: string, busIOType: BusIOType, completionTimeout?: number, options?: RawAxiosRequestConfig): AxiosPromise<void>;
4557
5809
  /**
4558
- * Delete all GUI applications from the cell.
4559
- * @summary Clear Applications
5810
+ * Adds an input/output to or updates an input/output on the PROFINET device.
5811
+ * @summary Add PROFINET Input/Output
4560
5812
  * @param {string} cell Unique identifier addressing a cell in all API calls.
4561
- * @param {number} [completionTimeout]
5813
+ * @param {string} io Unique identifier to address an Input/Output in the cell.
5814
+ * @param {ProfinetIOData} profinetIOData
4562
5815
  * @param {*} [options] Override http request option.
4563
5816
  * @throws {RequiredError}
4564
5817
  */
4565
- clearApps: (cell: string, completionTimeout?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
5818
+ addProfinetIO(cell: string, io: string, profinetIOData: ProfinetIOData, options?: RawAxiosRequestConfig): AxiosPromise<void>;
4566
5819
  /**
4567
- * Delete a GUI application from the cell.
4568
- * @summary Delete Application
5820
+ * Delete BUS Inputs/Outputs Service from the cell.
5821
+ * @summary Clear Service
4569
5822
  * @param {string} cell Unique identifier addressing a cell in all API calls.
4570
- * @param {string} app
4571
5823
  * @param {number} [completionTimeout]
4572
5824
  * @param {*} [options] Override http request option.
4573
5825
  * @throws {RequiredError}
4574
5826
  */
4575
- deleteApp: (cell: string, app: string, completionTimeout?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
5827
+ clearBusIOService(cell: string, completionTimeout?: number, options?: RawAxiosRequestConfig): AxiosPromise<void>;
4576
5828
  /**
4577
- * 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.
4578
- * @summary Configuration
5829
+ * Removes the input/output from the PROFINET device.
5830
+ * @summary Remove PROFINET Input/Ouptut
4579
5831
  * @param {string} cell Unique identifier addressing a cell in all API calls.
4580
- * @param {string} app
5832
+ * @param {string} io Unique identifier to address an Input/Output in the cell.
4581
5833
  * @param {*} [options] Override http request option.
4582
5834
  * @throws {RequiredError}
4583
5835
  */
4584
- getApp: (cell: string, app: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
5836
+ deleteProfinetIO(cell: string, io: string, options?: RawAxiosRequestConfig): AxiosPromise<void>;
4585
5837
  /**
4586
- * 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.
4587
- * @summary List Applications
5838
+ * Get deployed BUS Inputs/Outputs Service.
5839
+ * @summary Get Service
4588
5840
  * @param {string} cell Unique identifier addressing a cell in all API calls.
4589
5841
  * @param {*} [options] Override http request option.
4590
5842
  * @throws {RequiredError}
4591
5843
  */
4592
- listApps: (cell: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
5844
+ getBusIOService(cell: string, options?: RawAxiosRequestConfig): AxiosPromise<BusIOType>;
4593
5845
  /**
4594
- * Update the configuration of a GUI application in the cell.
4595
- * @summary Update Configuration
5846
+ * Get the current state of the BUS Inputs/Outputs service.
5847
+ * @summary State
4596
5848
  * @param {string} cell Unique identifier addressing a cell in all API calls.
4597
- * @param {string} app
4598
- * @param {App} app2
4599
- * @param {number} [completionTimeout]
4600
5849
  * @param {*} [options] Override http request option.
4601
5850
  * @throws {RequiredError}
4602
5851
  */
4603
- updateApp: (cell: string, app: string, app2: App, completionTimeout?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
4604
- };
4605
- /**
4606
- * ApplicationApi - functional programming interface
4607
- * @export
4608
- */
4609
- export declare const ApplicationApiFp: (configuration?: Configuration) => {
5852
+ getBusIOState(cell: string, options?: RawAxiosRequestConfig): AxiosPromise<BusIOsState>;
4610
5853
  /**
4611
- * 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 endpoint where the API is reachable from the container serving the Application. > - `BASE_PATH`: The root path of the deployed Application. It will be reachable via: http://$host/$BASE_PATH > - `CELL_NAME`: The name of the cell where the application is deployed.
4612
- * @summary Add Application
5854
+ * 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).
5855
+ * @summary Get Input/Output Values
4613
5856
  * @param {string} cell Unique identifier addressing a cell in all API calls.
4614
- * @param {App} app
4615
- * @param {number} [completionTimeout]
5857
+ * @param {Array<string>} [ios]
4616
5858
  * @param {*} [options] Override http request option.
4617
5859
  * @throws {RequiredError}
4618
5860
  */
4619
- addApp(cell: string, app: App, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
5861
+ getBusIOValues(cell: string, ios?: Array<string>, options?: RawAxiosRequestConfig): AxiosPromise<Array<IOValue>>;
4620
5862
  /**
4621
- * Delete all GUI applications from the cell.
4622
- * @summary Clear Applications
5863
+ * Get description of PROFINET
5864
+ * @summary Get PROFINET Description
4623
5865
  * @param {string} cell Unique identifier addressing a cell in all API calls.
4624
- * @param {number} [completionTimeout]
4625
5866
  * @param {*} [options] Override http request option.
4626
5867
  * @throws {RequiredError}
4627
5868
  */
4628
- clearApps(cell: string, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
5869
+ getProfinetDescription(cell: string, options?: RawAxiosRequestConfig): AxiosPromise<ProfinetDescription>;
4629
5870
  /**
4630
- * Delete a GUI application from the cell.
4631
- * @summary Delete Application
5871
+ * Get input/output configuration of the PROFINET device as file.
5872
+ * @summary PROFINET Inputs/Outputs to File
4632
5873
  * @param {string} cell Unique identifier addressing a cell in all API calls.
4633
- * @param {string} app
4634
- * @param {number} [completionTimeout]
5874
+ * @param {number} [inputOffset]
5875
+ * @param {number} [outputOffset]
4635
5876
  * @param {*} [options] Override http request option.
4636
5877
  * @throws {RequiredError}
4637
5878
  */
4638
- deleteApp(cell: string, app: string, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
5879
+ getProfinetIOsFromFile(cell: string, inputOffset?: number, outputOffset?: number, options?: RawAxiosRequestConfig): AxiosPromise<string>;
4639
5880
  /**
4640
- * 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.
4641
- * @summary Configuration
5881
+ * List all BUS Input/Output descriptions.
5882
+ * @summary List Descriptions
4642
5883
  * @param {string} cell Unique identifier addressing a cell in all API calls.
4643
- * @param {string} app
4644
5884
  * @param {*} [options] Override http request option.
4645
5885
  * @throws {RequiredError}
4646
5886
  */
4647
- getApp(cell: string, app: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<App>>;
5887
+ listBusIODescriptions(cell: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<IODescription>>;
4648
5888
  /**
4649
- * 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.
4650
- * @summary List Applications
5889
+ * List all PROFINET input and outputs.
5890
+ * @summary List PROFINET Input/Output Configuration
4651
5891
  * @param {string} cell Unique identifier addressing a cell in all API calls.
4652
5892
  * @param {*} [options] Override http request option.
4653
5893
  * @throws {RequiredError}
4654
5894
  */
4655
- listApps(cell: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<string>>>;
5895
+ listProfinetIOs(cell: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<ProfinetIO>>;
4656
5896
  /**
4657
- * Update the configuration of a GUI application in the cell.
4658
- * @summary Update Configuration
5897
+ * 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.
5898
+ * @summary Set Output Values
4659
5899
  * @param {string} cell Unique identifier addressing a cell in all API calls.
4660
- * @param {string} app
4661
- * @param {App} app2
4662
- * @param {number} [completionTimeout]
5900
+ * @param {Array<IOValue>} iOValue
4663
5901
  * @param {*} [options] Override http request option.
4664
5902
  * @throws {RequiredError}
4665
5903
  */
4666
- updateApp(cell: string, app: string, app2: App, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
5904
+ setBusIOValues(cell: string, iOValue: Array<IOValue>, options?: RawAxiosRequestConfig): AxiosPromise<void>;
5905
+ /**
5906
+ * Sets inputs/outputs on the PROFINET device from file.
5907
+ * @summary Set PROFINET Inputs/Outputs from File
5908
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
5909
+ * @param {ProfinetInputOutputConfig} profinetInputOutputConfig
5910
+ * @param {*} [options] Override http request option.
5911
+ * @throws {RequiredError}
5912
+ */
5913
+ setProfinetIOsFromFile(cell: string, profinetInputOutputConfig: ProfinetInputOutputConfig, options?: RawAxiosRequestConfig): AxiosPromise<void>;
4667
5914
  };
4668
5915
  /**
4669
- * ApplicationApi - factory interface
5916
+ * BUSInputsOutputsApi - object-oriented interface
4670
5917
  * @export
5918
+ * @class BUSInputsOutputsApi
5919
+ * @extends {BaseAPI}
4671
5920
  */
4672
- export declare const ApplicationApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
5921
+ export declare class BUSInputsOutputsApi extends BaseAPI {
4673
5922
  /**
4674
- * 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 endpoint where the API is reachable from the container serving the Application. > - `BASE_PATH`: The root path of the deployed Application. It will be reachable via: http://$host/$BASE_PATH > - `CELL_NAME`: The name of the cell where the application is deployed.
4675
- * @summary Add Application
5923
+ * Add a BUS Inputs/Outputs Service to the cell.
5924
+ * @summary Add Service
4676
5925
  * @param {string} cell Unique identifier addressing a cell in all API calls.
4677
- * @param {App} app
5926
+ * @param {BusIOType} busIOType
4678
5927
  * @param {number} [completionTimeout]
4679
5928
  * @param {*} [options] Override http request option.
4680
5929
  * @throws {RequiredError}
5930
+ * @memberof BUSInputsOutputsApi
4681
5931
  */
4682
- addApp(cell: string, app: App, completionTimeout?: number, options?: RawAxiosRequestConfig): AxiosPromise<void>;
5932
+ addBusIOService(cell: string, busIOType: BusIOType, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
4683
5933
  /**
4684
- * Delete all GUI applications from the cell.
4685
- * @summary Clear Applications
5934
+ * Adds an input/output to or updates an input/output on the PROFINET device.
5935
+ * @summary Add PROFINET Input/Output
4686
5936
  * @param {string} cell Unique identifier addressing a cell in all API calls.
4687
- * @param {number} [completionTimeout]
5937
+ * @param {string} io Unique identifier to address an Input/Output in the cell.
5938
+ * @param {ProfinetIOData} profinetIOData
4688
5939
  * @param {*} [options] Override http request option.
4689
5940
  * @throws {RequiredError}
5941
+ * @memberof BUSInputsOutputsApi
4690
5942
  */
4691
- clearApps(cell: string, completionTimeout?: number, options?: RawAxiosRequestConfig): AxiosPromise<void>;
5943
+ addProfinetIO(cell: string, io: string, profinetIOData: ProfinetIOData, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
4692
5944
  /**
4693
- * Delete a GUI application from the cell.
4694
- * @summary Delete Application
5945
+ * Delete BUS Inputs/Outputs Service from the cell.
5946
+ * @summary Clear Service
4695
5947
  * @param {string} cell Unique identifier addressing a cell in all API calls.
4696
- * @param {string} app
4697
5948
  * @param {number} [completionTimeout]
4698
5949
  * @param {*} [options] Override http request option.
4699
5950
  * @throws {RequiredError}
5951
+ * @memberof BUSInputsOutputsApi
4700
5952
  */
4701
- deleteApp(cell: string, app: string, completionTimeout?: number, options?: RawAxiosRequestConfig): AxiosPromise<void>;
5953
+ clearBusIOService(cell: string, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
4702
5954
  /**
4703
- * 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.
4704
- * @summary Configuration
5955
+ * Removes the input/output from the PROFINET device.
5956
+ * @summary Remove PROFINET Input/Ouptut
4705
5957
  * @param {string} cell Unique identifier addressing a cell in all API calls.
4706
- * @param {string} app
5958
+ * @param {string} io Unique identifier to address an Input/Output in the cell.
4707
5959
  * @param {*} [options] Override http request option.
4708
5960
  * @throws {RequiredError}
5961
+ * @memberof BUSInputsOutputsApi
4709
5962
  */
4710
- getApp(cell: string, app: string, options?: RawAxiosRequestConfig): AxiosPromise<App>;
5963
+ deleteProfinetIO(cell: string, io: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
4711
5964
  /**
4712
- * 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.
4713
- * @summary List Applications
5965
+ * Get deployed BUS Inputs/Outputs Service.
5966
+ * @summary Get Service
4714
5967
  * @param {string} cell Unique identifier addressing a cell in all API calls.
4715
5968
  * @param {*} [options] Override http request option.
4716
5969
  * @throws {RequiredError}
5970
+ * @memberof BUSInputsOutputsApi
4717
5971
  */
4718
- listApps(cell: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<string>>;
5972
+ getBusIOService(cell: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<{
5973
+ bus_type: "profinet";
5974
+ } & BusIOProfinet, any>>;
4719
5975
  /**
4720
- * Update the configuration of a GUI application in the cell.
4721
- * @summary Update Configuration
5976
+ * Get the current state of the BUS Inputs/Outputs service.
5977
+ * @summary State
4722
5978
  * @param {string} cell Unique identifier addressing a cell in all API calls.
4723
- * @param {string} app
4724
- * @param {App} app2
4725
- * @param {number} [completionTimeout]
4726
5979
  * @param {*} [options] Override http request option.
4727
5980
  * @throws {RequiredError}
5981
+ * @memberof BUSInputsOutputsApi
4728
5982
  */
4729
- updateApp(cell: string, app: string, app2: App, completionTimeout?: number, options?: RawAxiosRequestConfig): AxiosPromise<void>;
4730
- };
4731
- /**
4732
- * ApplicationApi - object-oriented interface
4733
- * @export
4734
- * @class ApplicationApi
4735
- * @extends {BaseAPI}
4736
- */
4737
- export declare class ApplicationApi extends BaseAPI {
5983
+ getBusIOState(cell: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<BusIOsState, any>>;
4738
5984
  /**
4739
- * 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 endpoint where the API is reachable from the container serving the Application. > - `BASE_PATH`: The root path of the deployed Application. It will be reachable via: http://$host/$BASE_PATH > - `CELL_NAME`: The name of the cell where the application is deployed.
4740
- * @summary Add Application
5985
+ * 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).
5986
+ * @summary Get Input/Output Values
4741
5987
  * @param {string} cell Unique identifier addressing a cell in all API calls.
4742
- * @param {App} app
4743
- * @param {number} [completionTimeout]
5988
+ * @param {Array<string>} [ios]
4744
5989
  * @param {*} [options] Override http request option.
4745
5990
  * @throws {RequiredError}
4746
- * @memberof ApplicationApi
5991
+ * @memberof BUSInputsOutputsApi
4747
5992
  */
4748
- addApp(cell: string, app: App, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
5993
+ getBusIOValues(cell: string, ios?: Array<string>, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<IOValue[], any>>;
4749
5994
  /**
4750
- * Delete all GUI applications from the cell.
4751
- * @summary Clear Applications
5995
+ * Get description of PROFINET
5996
+ * @summary Get PROFINET Description
4752
5997
  * @param {string} cell Unique identifier addressing a cell in all API calls.
4753
- * @param {number} [completionTimeout]
4754
5998
  * @param {*} [options] Override http request option.
4755
5999
  * @throws {RequiredError}
4756
- * @memberof ApplicationApi
6000
+ * @memberof BUSInputsOutputsApi
4757
6001
  */
4758
- clearApps(cell: string, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
6002
+ getProfinetDescription(cell: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ProfinetDescription, any>>;
4759
6003
  /**
4760
- * Delete a GUI application from the cell.
4761
- * @summary Delete Application
6004
+ * Get input/output configuration of the PROFINET device as file.
6005
+ * @summary PROFINET Inputs/Outputs to File
4762
6006
  * @param {string} cell Unique identifier addressing a cell in all API calls.
4763
- * @param {string} app
4764
- * @param {number} [completionTimeout]
6007
+ * @param {number} [inputOffset]
6008
+ * @param {number} [outputOffset]
4765
6009
  * @param {*} [options] Override http request option.
4766
6010
  * @throws {RequiredError}
4767
- * @memberof ApplicationApi
6011
+ * @memberof BUSInputsOutputsApi
4768
6012
  */
4769
- deleteApp(cell: string, app: string, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
6013
+ getProfinetIOsFromFile(cell: string, inputOffset?: number, outputOffset?: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<string, any>>;
4770
6014
  /**
4771
- * 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.
4772
- * @summary Configuration
6015
+ * List all BUS Input/Output descriptions.
6016
+ * @summary List Descriptions
4773
6017
  * @param {string} cell Unique identifier addressing a cell in all API calls.
4774
- * @param {string} app
4775
6018
  * @param {*} [options] Override http request option.
4776
6019
  * @throws {RequiredError}
4777
- * @memberof ApplicationApi
6020
+ * @memberof BUSInputsOutputsApi
4778
6021
  */
4779
- getApp(cell: string, app: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<App, any>>;
6022
+ listBusIODescriptions(cell: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<IODescription[], any>>;
4780
6023
  /**
4781
- * 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.
4782
- * @summary List Applications
6024
+ * List all PROFINET input and outputs.
6025
+ * @summary List PROFINET Input/Output Configuration
4783
6026
  * @param {string} cell Unique identifier addressing a cell in all API calls.
4784
6027
  * @param {*} [options] Override http request option.
4785
6028
  * @throws {RequiredError}
4786
- * @memberof ApplicationApi
6029
+ * @memberof BUSInputsOutputsApi
4787
6030
  */
4788
- listApps(cell: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<string[], any>>;
6031
+ listProfinetIOs(cell: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ProfinetIO[], any>>;
4789
6032
  /**
4790
- * Update the configuration of a GUI application in the cell.
4791
- * @summary Update Configuration
6033
+ * 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.
6034
+ * @summary Set Output Values
4792
6035
  * @param {string} cell Unique identifier addressing a cell in all API calls.
4793
- * @param {string} app
4794
- * @param {App} app2
4795
- * @param {number} [completionTimeout]
6036
+ * @param {Array<IOValue>} iOValue
4796
6037
  * @param {*} [options] Override http request option.
4797
6038
  * @throws {RequiredError}
4798
- * @memberof ApplicationApi
6039
+ * @memberof BUSInputsOutputsApi
4799
6040
  */
4800
- updateApp(cell: string, app: string, app2: App, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
6041
+ setBusIOValues(cell: string, iOValue: Array<IOValue>, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
6042
+ /**
6043
+ * Sets inputs/outputs on the PROFINET device from file.
6044
+ * @summary Set PROFINET Inputs/Outputs from File
6045
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
6046
+ * @param {ProfinetInputOutputConfig} profinetInputOutputConfig
6047
+ * @param {*} [options] Override http request option.
6048
+ * @throws {RequiredError}
6049
+ * @memberof BUSInputsOutputsApi
6050
+ */
6051
+ setProfinetIOsFromFile(cell: string, profinetInputOutputConfig: ProfinetInputOutputConfig, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
4801
6052
  }
4802
6053
  /**
4803
6054
  * CellApi - axios parameter creator
@@ -5135,15 +6386,6 @@ export declare const ControllerApiAxiosParamCreator: (configuration?: Configurat
5135
6386
  * @throws {RequiredError}
5136
6387
  */
5137
6388
  getCurrentRobotControllerState: (cell: string, controller: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
5138
- /**
5139
- * Get the current robot system mode of a registered robot controller. The robot system mode indicates if a robot controller can be used. See [setDefaultMode](setDefaultMode) for more information about the different modes. The mode is influenced by the operating mode of the robot controller. The operating mode can be changed via [setDefaultMode](setDefaultMode). Request the current operating mode of the robot controller via [getCurrentRobotControllerState](getCurrentRobotControllerState).
5140
- * @summary Current Mode
5141
- * @param {string} cell Unique identifier addressing a cell in all API calls.
5142
- * @param {string} controller Unique identifier to address a controller in the cell.
5143
- * @param {*} [options] Override http request option.
5144
- * @throws {RequiredError}
5145
- */
5146
- getMode: (cell: string, controller: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
5147
6389
  /**
5148
6390
  * Get the configuration for a robot controller.
5149
6391
  * @summary Robot Controller
@@ -5154,14 +6396,14 @@ export declare const ControllerApiAxiosParamCreator: (configuration?: Configurat
5154
6396
  */
5155
6397
  getRobotController: (cell: string, controller: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
5156
6398
  /**
5157
- * Receive the configuration for a virtual robot controller. Used to configure a virtual robot controller via [addRobotController](addRobotController). > **NOTE** > > The output generated by this endpoint can be too large for the site to handle, and may produce an error or incorrect output. > Use `curl` in combination with `> output.json` to capture the output, or use an API client like Postman.
5158
- * @summary Virtual Robot Configuration
6399
+ * Receive data to configure a virtual robot controller based on another controller. This can be used to create a virtual clone of a specific physical robot. When adding a virtual controller, use the Virtual configuration variant of [addRobotController](addRobotController) and pass the content string from this endpoint as the `json` field. Omit the `type` field that selects a preset configuration which is not required when providing a complete configuration. > **NOTE** > > The output generated by this endpoint can be too large for the site to handle, and may produce an error or incorrect output. > Use `curl` in combination with `> output.json` to capture the output, or use an API client like Postman.
6400
+ * @summary Virtual Controller Configuration
5159
6401
  * @param {string} cell Unique identifier addressing a cell in all API calls.
5160
6402
  * @param {string} controller Unique identifier to address a controller in the cell.
5161
6403
  * @param {*} [options] Override http request option.
5162
6404
  * @throws {RequiredError}
5163
6405
  */
5164
- getVirtualRobotConfiguration: (cell: string, controller: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
6406
+ getVirtualControllerConfiguration: (cell: string, controller: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
5165
6407
  /**
5166
6408
  * Lists all specifications of coordinate systems from robot controllers. Use parameter orientation_type to get the orientation part of the transformation offset of the coordinate system returned in the requested orientation notation. If parameter orientation_type is not set, the orientation part of the transformation offset of the coordinate system is returned in rotation vector notation. The coordinate systems from the robot controller are loaded when the motion group associated with the coordinate system is activated. With deactivation of the motion group, the associated coordinate systems are removed from NOVA. The unique identifier of the coordinate systems from the robot controllers are suffixed with \"On\" + the unique identifier of the robot controller.
5167
6409
  * @summary List Coordinate Systems
@@ -5181,7 +6423,7 @@ export declare const ControllerApiAxiosParamCreator: (configuration?: Configurat
5181
6423
  */
5182
6424
  listRobotControllers: (cell: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
5183
6425
  /**
5184
- * Switch between monitor and control usage as default for a robot controller. Monitoring mode is used to read information from the robot controller and control mode is used to command the robot system. As long as the robot controller is connected via network monitoring mode is always possible. To switch to control mode the robot controller must be in `automatic` or `manual` operating mode and safety state \'normal\' or \'reduced\'. If the robot controller is in `manual` operating mode, you have manually confirm the control usage activation on the robot control panel. This manual confirmation can\'t be replaced with this API. Without manual confirmation the robot controller will stay in monitor mode. The robot system will try to activate the required operation mode for the requested usage unless no active call requires a different mode. > **NOTE** > > Some robot controllers prevent the external activation of automatic operating mode. In this case, changing the operating mode manually at the robot controller is mandatory. > **NOTE** > > The current operation mode and safety state can be requested via [getCurrentRobotControllerState](getCurrentRobotControllerState). If a mode change is not possible, the response lists reasons for the failed change.
6426
+ * Switch between monitor and control usage as default for a robot controller. Monitoring mode is used to read information from the robot controller and control mode is used to command the robot system. As long as the robot controller is connected via network monitoring mode is always possible. To switch to control mode the robot controller must be in `automatic` or `manual` operating mode and safety state \'normal\' or \'reduced\'. If the robot controller is in `manual` operating mode, you have manually confirm the control usage activation on the robot control panel. This manual confirmation can\'t be replaced with this API. Without manual confirmation the robot controller will stay in monitor mode. The robot system will try to activate the required operation mode for the requested usage unless no active call requires a different mode. > **NOTE** > > `setDefaultMode` enables the robot controller to stay in control mode to keep the motors activated. > This allows for faster execution of sequential movements as no mode switches are required. > **NOTE** > > Some robot controllers prevent the external activation of automatic operating mode. In this case, changing the operating mode manually at the robot controller is mandatory. > **NOTE** > > The current operation mode and safety state can be requested via [getCurrentRobotControllerState](getCurrentRobotControllerState). If a mode change is not possible, the response lists reasons for the failed change.
5185
6427
  * @summary Set Default Mode
5186
6428
  * @param {string} cell Unique identifier addressing a cell in all API calls.
5187
6429
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -5201,15 +6443,16 @@ export declare const ControllerApiAxiosParamCreator: (configuration?: Configurat
5201
6443
  */
5202
6444
  streamFreeDrive: (cell: string, controller: string, responseRate?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
5203
6445
  /**
5204
- * <!-- theme: danger --> > Websocket endpoint Receive updates of the state of a robot controller.
6446
+ * <!-- theme: danger --> > Websocket endpoint Receive updates of the state of a robot controller. The stream can be opened before the controller is registered. To register a controller, call [addRobotController](addRobotController). While connecting, the stream sends initialization updates. Once the controller reaches `MODE_MONITOR`, it sends controller state updates.
5205
6447
  * @summary Stream State
5206
6448
  * @param {string} cell Unique identifier addressing a cell in all API calls.
5207
6449
  * @param {string} controller Unique identifier to address a controller in the cell.
5208
6450
  * @param {number} [responseRate]
6451
+ * @param {number} [addControllerTimeout]
5209
6452
  * @param {*} [options] Override http request option.
5210
6453
  * @throws {RequiredError}
5211
6454
  */
5212
- streamRobotControllerState: (cell: string, controller: string, responseRate?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
6455
+ streamRobotControllerState: (cell: string, controller: string, responseRate?: number, addControllerTimeout?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
5213
6456
  /**
5214
6457
  * Update the configuration of a robot controller. Reconfigure certain options of a robot controller, or deploy a specific container image of a robot controller. <!-- theme: warning --> > **WARNING** > > Using it in conjunction with the settings app may lead to unpredictable behavior.
5215
6458
  * @summary Update Robot Controller
@@ -5285,15 +6528,6 @@ export declare const ControllerApiFp: (configuration?: Configuration) => {
5285
6528
  * @throws {RequiredError}
5286
6529
  */
5287
6530
  getCurrentRobotControllerState(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<RobotControllerState>>;
5288
- /**
5289
- * Get the current robot system mode of a registered robot controller. The robot system mode indicates if a robot controller can be used. See [setDefaultMode](setDefaultMode) for more information about the different modes. The mode is influenced by the operating mode of the robot controller. The operating mode can be changed via [setDefaultMode](setDefaultMode). Request the current operating mode of the robot controller via [getCurrentRobotControllerState](getCurrentRobotControllerState).
5290
- * @summary Current Mode
5291
- * @param {string} cell Unique identifier addressing a cell in all API calls.
5292
- * @param {string} controller Unique identifier to address a controller in the cell.
5293
- * @param {*} [options] Override http request option.
5294
- * @throws {RequiredError}
5295
- */
5296
- getMode(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetModeResponse>>;
5297
6531
  /**
5298
6532
  * Get the configuration for a robot controller.
5299
6533
  * @summary Robot Controller
@@ -5304,14 +6538,14 @@ export declare const ControllerApiFp: (configuration?: Configuration) => {
5304
6538
  */
5305
6539
  getRobotController(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<RobotController>>;
5306
6540
  /**
5307
- * Receive the configuration for a virtual robot controller. Used to configure a virtual robot controller via [addRobotController](addRobotController). > **NOTE** > > The output generated by this endpoint can be too large for the site to handle, and may produce an error or incorrect output. > Use `curl` in combination with `> output.json` to capture the output, or use an API client like Postman.
5308
- * @summary Virtual Robot Configuration
6541
+ * Receive data to configure a virtual robot controller based on another controller. This can be used to create a virtual clone of a specific physical robot. When adding a virtual controller, use the Virtual configuration variant of [addRobotController](addRobotController) and pass the content string from this endpoint as the `json` field. Omit the `type` field that selects a preset configuration which is not required when providing a complete configuration. > **NOTE** > > The output generated by this endpoint can be too large for the site to handle, and may produce an error or incorrect output. > Use `curl` in combination with `> output.json` to capture the output, or use an API client like Postman.
6542
+ * @summary Virtual Controller Configuration
5309
6543
  * @param {string} cell Unique identifier addressing a cell in all API calls.
5310
6544
  * @param {string} controller Unique identifier to address a controller in the cell.
5311
6545
  * @param {*} [options] Override http request option.
5312
6546
  * @throws {RequiredError}
5313
6547
  */
5314
- getVirtualRobotConfiguration(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<VirtualRobotConfiguration>>;
6548
+ getVirtualControllerConfiguration(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<VirtualRobotConfiguration>>;
5315
6549
  /**
5316
6550
  * Lists all specifications of coordinate systems from robot controllers. Use parameter orientation_type to get the orientation part of the transformation offset of the coordinate system returned in the requested orientation notation. If parameter orientation_type is not set, the orientation part of the transformation offset of the coordinate system is returned in rotation vector notation. The coordinate systems from the robot controller are loaded when the motion group associated with the coordinate system is activated. With deactivation of the motion group, the associated coordinate systems are removed from NOVA. The unique identifier of the coordinate systems from the robot controllers are suffixed with \"On\" + the unique identifier of the robot controller.
5317
6551
  * @summary List Coordinate Systems
@@ -5331,7 +6565,7 @@ export declare const ControllerApiFp: (configuration?: Configuration) => {
5331
6565
  */
5332
6566
  listRobotControllers(cell: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<string>>>;
5333
6567
  /**
5334
- * Switch between monitor and control usage as default for a robot controller. Monitoring mode is used to read information from the robot controller and control mode is used to command the robot system. As long as the robot controller is connected via network monitoring mode is always possible. To switch to control mode the robot controller must be in `automatic` or `manual` operating mode and safety state \'normal\' or \'reduced\'. If the robot controller is in `manual` operating mode, you have manually confirm the control usage activation on the robot control panel. This manual confirmation can\'t be replaced with this API. Without manual confirmation the robot controller will stay in monitor mode. The robot system will try to activate the required operation mode for the requested usage unless no active call requires a different mode. > **NOTE** > > Some robot controllers prevent the external activation of automatic operating mode. In this case, changing the operating mode manually at the robot controller is mandatory. > **NOTE** > > The current operation mode and safety state can be requested via [getCurrentRobotControllerState](getCurrentRobotControllerState). If a mode change is not possible, the response lists reasons for the failed change.
6568
+ * Switch between monitor and control usage as default for a robot controller. Monitoring mode is used to read information from the robot controller and control mode is used to command the robot system. As long as the robot controller is connected via network monitoring mode is always possible. To switch to control mode the robot controller must be in `automatic` or `manual` operating mode and safety state \'normal\' or \'reduced\'. If the robot controller is in `manual` operating mode, you have manually confirm the control usage activation on the robot control panel. This manual confirmation can\'t be replaced with this API. Without manual confirmation the robot controller will stay in monitor mode. The robot system will try to activate the required operation mode for the requested usage unless no active call requires a different mode. > **NOTE** > > `setDefaultMode` enables the robot controller to stay in control mode to keep the motors activated. > This allows for faster execution of sequential movements as no mode switches are required. > **NOTE** > > Some robot controllers prevent the external activation of automatic operating mode. In this case, changing the operating mode manually at the robot controller is mandatory. > **NOTE** > > The current operation mode and safety state can be requested via [getCurrentRobotControllerState](getCurrentRobotControllerState). If a mode change is not possible, the response lists reasons for the failed change.
5335
6569
  * @summary Set Default Mode
5336
6570
  * @param {string} cell Unique identifier addressing a cell in all API calls.
5337
6571
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -5351,15 +6585,16 @@ export declare const ControllerApiFp: (configuration?: Configuration) => {
5351
6585
  */
5352
6586
  streamFreeDrive(cell: string, controller: string, responseRate?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<RobotControllerState>>;
5353
6587
  /**
5354
- * <!-- theme: danger --> > Websocket endpoint Receive updates of the state of a robot controller.
6588
+ * <!-- theme: danger --> > Websocket endpoint Receive updates of the state of a robot controller. The stream can be opened before the controller is registered. To register a controller, call [addRobotController](addRobotController). While connecting, the stream sends initialization updates. Once the controller reaches `MODE_MONITOR`, it sends controller state updates.
5355
6589
  * @summary Stream State
5356
6590
  * @param {string} cell Unique identifier addressing a cell in all API calls.
5357
6591
  * @param {string} controller Unique identifier to address a controller in the cell.
5358
6592
  * @param {number} [responseRate]
6593
+ * @param {number} [addControllerTimeout]
5359
6594
  * @param {*} [options] Override http request option.
5360
6595
  * @throws {RequiredError}
5361
6596
  */
5362
- streamRobotControllerState(cell: string, controller: string, responseRate?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<RobotControllerState>>;
6597
+ streamRobotControllerState(cell: string, controller: string, responseRate?: number, addControllerTimeout?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<RobotControllerState>>;
5363
6598
  /**
5364
6599
  * Update the configuration of a robot controller. Reconfigure certain options of a robot controller, or deploy a specific container image of a robot controller. <!-- theme: warning --> > **WARNING** > > Using it in conjunction with the settings app may lead to unpredictable behavior.
5365
6600
  * @summary Update Robot Controller
@@ -5435,15 +6670,6 @@ export declare const ControllerApiFactory: (configuration?: Configuration, baseP
5435
6670
  * @throws {RequiredError}
5436
6671
  */
5437
6672
  getCurrentRobotControllerState(cell: string, controller: string, options?: RawAxiosRequestConfig): AxiosPromise<RobotControllerState>;
5438
- /**
5439
- * Get the current robot system mode of a registered robot controller. The robot system mode indicates if a robot controller can be used. See [setDefaultMode](setDefaultMode) for more information about the different modes. The mode is influenced by the operating mode of the robot controller. The operating mode can be changed via [setDefaultMode](setDefaultMode). Request the current operating mode of the robot controller via [getCurrentRobotControllerState](getCurrentRobotControllerState).
5440
- * @summary Current Mode
5441
- * @param {string} cell Unique identifier addressing a cell in all API calls.
5442
- * @param {string} controller Unique identifier to address a controller in the cell.
5443
- * @param {*} [options] Override http request option.
5444
- * @throws {RequiredError}
5445
- */
5446
- getMode(cell: string, controller: string, options?: RawAxiosRequestConfig): AxiosPromise<GetModeResponse>;
5447
6673
  /**
5448
6674
  * Get the configuration for a robot controller.
5449
6675
  * @summary Robot Controller
@@ -5454,14 +6680,14 @@ export declare const ControllerApiFactory: (configuration?: Configuration, baseP
5454
6680
  */
5455
6681
  getRobotController(cell: string, controller: string, options?: RawAxiosRequestConfig): AxiosPromise<RobotController>;
5456
6682
  /**
5457
- * Receive the configuration for a virtual robot controller. Used to configure a virtual robot controller via [addRobotController](addRobotController). > **NOTE** > > The output generated by this endpoint can be too large for the site to handle, and may produce an error or incorrect output. > Use `curl` in combination with `> output.json` to capture the output, or use an API client like Postman.
5458
- * @summary Virtual Robot Configuration
6683
+ * Receive data to configure a virtual robot controller based on another controller. This can be used to create a virtual clone of a specific physical robot. When adding a virtual controller, use the Virtual configuration variant of [addRobotController](addRobotController) and pass the content string from this endpoint as the `json` field. Omit the `type` field that selects a preset configuration which is not required when providing a complete configuration. > **NOTE** > > The output generated by this endpoint can be too large for the site to handle, and may produce an error or incorrect output. > Use `curl` in combination with `> output.json` to capture the output, or use an API client like Postman.
6684
+ * @summary Virtual Controller Configuration
5459
6685
  * @param {string} cell Unique identifier addressing a cell in all API calls.
5460
6686
  * @param {string} controller Unique identifier to address a controller in the cell.
5461
6687
  * @param {*} [options] Override http request option.
5462
6688
  * @throws {RequiredError}
5463
6689
  */
5464
- getVirtualRobotConfiguration(cell: string, controller: string, options?: RawAxiosRequestConfig): AxiosPromise<VirtualRobotConfiguration>;
6690
+ getVirtualControllerConfiguration(cell: string, controller: string, options?: RawAxiosRequestConfig): AxiosPromise<VirtualRobotConfiguration>;
5465
6691
  /**
5466
6692
  * Lists all specifications of coordinate systems from robot controllers. Use parameter orientation_type to get the orientation part of the transformation offset of the coordinate system returned in the requested orientation notation. If parameter orientation_type is not set, the orientation part of the transformation offset of the coordinate system is returned in rotation vector notation. The coordinate systems from the robot controller are loaded when the motion group associated with the coordinate system is activated. With deactivation of the motion group, the associated coordinate systems are removed from NOVA. The unique identifier of the coordinate systems from the robot controllers are suffixed with \"On\" + the unique identifier of the robot controller.
5467
6693
  * @summary List Coordinate Systems
@@ -5481,7 +6707,7 @@ export declare const ControllerApiFactory: (configuration?: Configuration, baseP
5481
6707
  */
5482
6708
  listRobotControllers(cell: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<string>>;
5483
6709
  /**
5484
- * Switch between monitor and control usage as default for a robot controller. Monitoring mode is used to read information from the robot controller and control mode is used to command the robot system. As long as the robot controller is connected via network monitoring mode is always possible. To switch to control mode the robot controller must be in `automatic` or `manual` operating mode and safety state \'normal\' or \'reduced\'. If the robot controller is in `manual` operating mode, you have manually confirm the control usage activation on the robot control panel. This manual confirmation can\'t be replaced with this API. Without manual confirmation the robot controller will stay in monitor mode. The robot system will try to activate the required operation mode for the requested usage unless no active call requires a different mode. > **NOTE** > > Some robot controllers prevent the external activation of automatic operating mode. In this case, changing the operating mode manually at the robot controller is mandatory. > **NOTE** > > The current operation mode and safety state can be requested via [getCurrentRobotControllerState](getCurrentRobotControllerState). If a mode change is not possible, the response lists reasons for the failed change.
6710
+ * Switch between monitor and control usage as default for a robot controller. Monitoring mode is used to read information from the robot controller and control mode is used to command the robot system. As long as the robot controller is connected via network monitoring mode is always possible. To switch to control mode the robot controller must be in `automatic` or `manual` operating mode and safety state \'normal\' or \'reduced\'. If the robot controller is in `manual` operating mode, you have manually confirm the control usage activation on the robot control panel. This manual confirmation can\'t be replaced with this API. Without manual confirmation the robot controller will stay in monitor mode. The robot system will try to activate the required operation mode for the requested usage unless no active call requires a different mode. > **NOTE** > > `setDefaultMode` enables the robot controller to stay in control mode to keep the motors activated. > This allows for faster execution of sequential movements as no mode switches are required. > **NOTE** > > Some robot controllers prevent the external activation of automatic operating mode. In this case, changing the operating mode manually at the robot controller is mandatory. > **NOTE** > > The current operation mode and safety state can be requested via [getCurrentRobotControllerState](getCurrentRobotControllerState). If a mode change is not possible, the response lists reasons for the failed change.
5485
6711
  * @summary Set Default Mode
5486
6712
  * @param {string} cell Unique identifier addressing a cell in all API calls.
5487
6713
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -5501,15 +6727,16 @@ export declare const ControllerApiFactory: (configuration?: Configuration, baseP
5501
6727
  */
5502
6728
  streamFreeDrive(cell: string, controller: string, responseRate?: number, options?: RawAxiosRequestConfig): AxiosPromise<RobotControllerState>;
5503
6729
  /**
5504
- * <!-- theme: danger --> > Websocket endpoint Receive updates of the state of a robot controller.
6730
+ * <!-- theme: danger --> > Websocket endpoint Receive updates of the state of a robot controller. The stream can be opened before the controller is registered. To register a controller, call [addRobotController](addRobotController). While connecting, the stream sends initialization updates. Once the controller reaches `MODE_MONITOR`, it sends controller state updates.
5505
6731
  * @summary Stream State
5506
6732
  * @param {string} cell Unique identifier addressing a cell in all API calls.
5507
6733
  * @param {string} controller Unique identifier to address a controller in the cell.
5508
6734
  * @param {number} [responseRate]
6735
+ * @param {number} [addControllerTimeout]
5509
6736
  * @param {*} [options] Override http request option.
5510
6737
  * @throws {RequiredError}
5511
6738
  */
5512
- streamRobotControllerState(cell: string, controller: string, responseRate?: number, options?: RawAxiosRequestConfig): AxiosPromise<RobotControllerState>;
6739
+ streamRobotControllerState(cell: string, controller: string, responseRate?: number, addControllerTimeout?: number, options?: RawAxiosRequestConfig): AxiosPromise<RobotControllerState>;
5513
6740
  /**
5514
6741
  * Update the configuration of a robot controller. Reconfigure certain options of a robot controller, or deploy a specific container image of a robot controller. <!-- theme: warning --> > **WARNING** > > Using it in conjunction with the settings app may lead to unpredictable behavior.
5515
6742
  * @summary Update Robot Controller
@@ -5593,16 +6820,6 @@ export declare class ControllerApi extends BaseAPI {
5593
6820
  * @memberof ControllerApi
5594
6821
  */
5595
6822
  getCurrentRobotControllerState(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<RobotControllerState, any>>;
5596
- /**
5597
- * Get the current robot system mode of a registered robot controller. The robot system mode indicates if a robot controller can be used. See [setDefaultMode](setDefaultMode) for more information about the different modes. The mode is influenced by the operating mode of the robot controller. The operating mode can be changed via [setDefaultMode](setDefaultMode). Request the current operating mode of the robot controller via [getCurrentRobotControllerState](getCurrentRobotControllerState).
5598
- * @summary Current Mode
5599
- * @param {string} cell Unique identifier addressing a cell in all API calls.
5600
- * @param {string} controller Unique identifier to address a controller in the cell.
5601
- * @param {*} [options] Override http request option.
5602
- * @throws {RequiredError}
5603
- * @memberof ControllerApi
5604
- */
5605
- getMode(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetModeResponse, any>>;
5606
6823
  /**
5607
6824
  * Get the configuration for a robot controller.
5608
6825
  * @summary Robot Controller
@@ -5614,15 +6831,15 @@ export declare class ControllerApi extends BaseAPI {
5614
6831
  */
5615
6832
  getRobotController(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<RobotController, any>>;
5616
6833
  /**
5617
- * Receive the configuration for a virtual robot controller. Used to configure a virtual robot controller via [addRobotController](addRobotController). > **NOTE** > > The output generated by this endpoint can be too large for the site to handle, and may produce an error or incorrect output. > Use `curl` in combination with `> output.json` to capture the output, or use an API client like Postman.
5618
- * @summary Virtual Robot Configuration
6834
+ * Receive data to configure a virtual robot controller based on another controller. This can be used to create a virtual clone of a specific physical robot. When adding a virtual controller, use the Virtual configuration variant of [addRobotController](addRobotController) and pass the content string from this endpoint as the `json` field. Omit the `type` field that selects a preset configuration which is not required when providing a complete configuration. > **NOTE** > > The output generated by this endpoint can be too large for the site to handle, and may produce an error or incorrect output. > Use `curl` in combination with `> output.json` to capture the output, or use an API client like Postman.
6835
+ * @summary Virtual Controller Configuration
5619
6836
  * @param {string} cell Unique identifier addressing a cell in all API calls.
5620
6837
  * @param {string} controller Unique identifier to address a controller in the cell.
5621
6838
  * @param {*} [options] Override http request option.
5622
6839
  * @throws {RequiredError}
5623
6840
  * @memberof ControllerApi
5624
6841
  */
5625
- getVirtualRobotConfiguration(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<VirtualRobotConfiguration, any>>;
6842
+ getVirtualControllerConfiguration(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<VirtualRobotConfiguration, any>>;
5626
6843
  /**
5627
6844
  * Lists all specifications of coordinate systems from robot controllers. Use parameter orientation_type to get the orientation part of the transformation offset of the coordinate system returned in the requested orientation notation. If parameter orientation_type is not set, the orientation part of the transformation offset of the coordinate system is returned in rotation vector notation. The coordinate systems from the robot controller are loaded when the motion group associated with the coordinate system is activated. With deactivation of the motion group, the associated coordinate systems are removed from NOVA. The unique identifier of the coordinate systems from the robot controllers are suffixed with \"On\" + the unique identifier of the robot controller.
5628
6845
  * @summary List Coordinate Systems
@@ -5644,7 +6861,7 @@ export declare class ControllerApi extends BaseAPI {
5644
6861
  */
5645
6862
  listRobotControllers(cell: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<string[], any>>;
5646
6863
  /**
5647
- * Switch between monitor and control usage as default for a robot controller. Monitoring mode is used to read information from the robot controller and control mode is used to command the robot system. As long as the robot controller is connected via network monitoring mode is always possible. To switch to control mode the robot controller must be in `automatic` or `manual` operating mode and safety state \'normal\' or \'reduced\'. If the robot controller is in `manual` operating mode, you have manually confirm the control usage activation on the robot control panel. This manual confirmation can\'t be replaced with this API. Without manual confirmation the robot controller will stay in monitor mode. The robot system will try to activate the required operation mode for the requested usage unless no active call requires a different mode. > **NOTE** > > Some robot controllers prevent the external activation of automatic operating mode. In this case, changing the operating mode manually at the robot controller is mandatory. > **NOTE** > > The current operation mode and safety state can be requested via [getCurrentRobotControllerState](getCurrentRobotControllerState). If a mode change is not possible, the response lists reasons for the failed change.
6864
+ * Switch between monitor and control usage as default for a robot controller. Monitoring mode is used to read information from the robot controller and control mode is used to command the robot system. As long as the robot controller is connected via network monitoring mode is always possible. To switch to control mode the robot controller must be in `automatic` or `manual` operating mode and safety state \'normal\' or \'reduced\'. If the robot controller is in `manual` operating mode, you have manually confirm the control usage activation on the robot control panel. This manual confirmation can\'t be replaced with this API. Without manual confirmation the robot controller will stay in monitor mode. The robot system will try to activate the required operation mode for the requested usage unless no active call requires a different mode. > **NOTE** > > `setDefaultMode` enables the robot controller to stay in control mode to keep the motors activated. > This allows for faster execution of sequential movements as no mode switches are required. > **NOTE** > > Some robot controllers prevent the external activation of automatic operating mode. In this case, changing the operating mode manually at the robot controller is mandatory. > **NOTE** > > The current operation mode and safety state can be requested via [getCurrentRobotControllerState](getCurrentRobotControllerState). If a mode change is not possible, the response lists reasons for the failed change.
5648
6865
  * @summary Set Default Mode
5649
6866
  * @param {string} cell Unique identifier addressing a cell in all API calls.
5650
6867
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -5666,16 +6883,17 @@ export declare class ControllerApi extends BaseAPI {
5666
6883
  */
5667
6884
  streamFreeDrive(cell: string, controller: string, responseRate?: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<RobotControllerState, any>>;
5668
6885
  /**
5669
- * <!-- theme: danger --> > Websocket endpoint Receive updates of the state of a robot controller.
6886
+ * <!-- theme: danger --> > Websocket endpoint Receive updates of the state of a robot controller. The stream can be opened before the controller is registered. To register a controller, call [addRobotController](addRobotController). While connecting, the stream sends initialization updates. Once the controller reaches `MODE_MONITOR`, it sends controller state updates.
5670
6887
  * @summary Stream State
5671
6888
  * @param {string} cell Unique identifier addressing a cell in all API calls.
5672
6889
  * @param {string} controller Unique identifier to address a controller in the cell.
5673
6890
  * @param {number} [responseRate]
6891
+ * @param {number} [addControllerTimeout]
5674
6892
  * @param {*} [options] Override http request option.
5675
6893
  * @throws {RequiredError}
5676
6894
  * @memberof ControllerApi
5677
6895
  */
5678
- streamRobotControllerState(cell: string, controller: string, responseRate?: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<RobotControllerState, any>>;
6896
+ streamRobotControllerState(cell: string, controller: string, responseRate?: number, addControllerTimeout?: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<RobotControllerState, any>>;
5679
6897
  /**
5680
6898
  * Update the configuration of a robot controller. Reconfigure certain options of a robot controller, or deploy a specific container image of a robot controller. <!-- theme: warning --> > **WARNING** > > Using it in conjunction with the settings app may lead to unpredictable behavior.
5681
6899
  * @summary Update Robot Controller
@@ -6004,6 +7222,15 @@ export declare class JoggingApi extends BaseAPI {
6004
7222
  * @export
6005
7223
  */
6006
7224
  export declare const KinematicsApiAxiosParamCreator: (configuration?: Configuration) => {
7225
+ /**
7226
+ * Returns the TCP poses for a list of given joint positions.
7227
+ * @summary Forward kinematics
7228
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
7229
+ * @param {ForwardKinematicsRequest} [forwardKinematicsRequest]
7230
+ * @param {*} [options] Override http request option.
7231
+ * @throws {RequiredError}
7232
+ */
7233
+ forwardKinematics: (cell: string, forwardKinematicsRequest?: ForwardKinematicsRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
6007
7234
  /**
6008
7235
  * Returns the reachable joint positions for a list of given poses.
6009
7236
  * @summary Inverse kinematics
@@ -6019,6 +7246,15 @@ export declare const KinematicsApiAxiosParamCreator: (configuration?: Configurat
6019
7246
  * @export
6020
7247
  */
6021
7248
  export declare const KinematicsApiFp: (configuration?: Configuration) => {
7249
+ /**
7250
+ * Returns the TCP poses for a list of given joint positions.
7251
+ * @summary Forward kinematics
7252
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
7253
+ * @param {ForwardKinematicsRequest} [forwardKinematicsRequest]
7254
+ * @param {*} [options] Override http request option.
7255
+ * @throws {RequiredError}
7256
+ */
7257
+ forwardKinematics(cell: string, forwardKinematicsRequest?: ForwardKinematicsRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ForwardKinematicsResponse>>;
6022
7258
  /**
6023
7259
  * Returns the reachable joint positions for a list of given poses.
6024
7260
  * @summary Inverse kinematics
@@ -6034,6 +7270,15 @@ export declare const KinematicsApiFp: (configuration?: Configuration) => {
6034
7270
  * @export
6035
7271
  */
6036
7272
  export declare const KinematicsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
7273
+ /**
7274
+ * Returns the TCP poses for a list of given joint positions.
7275
+ * @summary Forward kinematics
7276
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
7277
+ * @param {ForwardKinematicsRequest} [forwardKinematicsRequest]
7278
+ * @param {*} [options] Override http request option.
7279
+ * @throws {RequiredError}
7280
+ */
7281
+ forwardKinematics(cell: string, forwardKinematicsRequest?: ForwardKinematicsRequest, options?: RawAxiosRequestConfig): AxiosPromise<ForwardKinematicsResponse>;
6037
7282
  /**
6038
7283
  * Returns the reachable joint positions for a list of given poses.
6039
7284
  * @summary Inverse kinematics
@@ -6051,6 +7296,16 @@ export declare const KinematicsApiFactory: (configuration?: Configuration, baseP
6051
7296
  * @extends {BaseAPI}
6052
7297
  */
6053
7298
  export declare class KinematicsApi extends BaseAPI {
7299
+ /**
7300
+ * Returns the TCP poses for a list of given joint positions.
7301
+ * @summary Forward kinematics
7302
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
7303
+ * @param {ForwardKinematicsRequest} [forwardKinematicsRequest]
7304
+ * @param {*} [options] Override http request option.
7305
+ * @throws {RequiredError}
7306
+ * @memberof KinematicsApi
7307
+ */
7308
+ forwardKinematics(cell: string, forwardKinematicsRequest?: ForwardKinematicsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ForwardKinematicsResponse, any>>;
6054
7309
  /**
6055
7310
  * Returns the reachable joint positions for a list of given poses.
6056
7311
  * @summary Inverse kinematics
@@ -7012,184 +8267,184 @@ export declare class StoreCollisionComponentsApi extends BaseAPI {
7012
8267
  }, any>>;
7013
8268
  }
7014
8269
  /**
7015
- * StoreCollisionScenesApi - axios parameter creator
8270
+ * StoreCollisionSetupsApi - axios parameter creator
7016
8271
  * @export
7017
8272
  */
7018
- export declare const StoreCollisionScenesApiAxiosParamCreator: (configuration?: Configuration) => {
8273
+ export declare const StoreCollisionSetupsApiAxiosParamCreator: (configuration?: Configuration) => {
7019
8274
  /**
7020
- * Deletes the stored scene. <!-- theme: danger --> > This will delete persistently stored data.
7021
- * @summary Delete Scene
8275
+ * Deletes the stored collision setup. <!-- theme: danger --> > This will delete persistently stored data.
8276
+ * @summary Delete Collision Setup
7022
8277
  * @param {string} cell Unique identifier addressing a cell in all API calls.
7023
- * @param {string} scene Unique identifier addressing a collision scene.
8278
+ * @param {string} setup Identifier of the collision setup
7024
8279
  * @param {*} [options] Override http request option.
7025
8280
  * @throws {RequiredError}
7026
8281
  */
7027
- deleteStoredCollisionScene: (cell: string, scene: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
8282
+ deleteStoredCollisionSetup: (cell: string, setup: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
7028
8283
  /**
7029
- * Returns the stored scene.
7030
- * @summary Get Scene
8284
+ * Returns the stored collision setup.
8285
+ * @summary Get Collision Setup
7031
8286
  * @param {string} cell Unique identifier addressing a cell in all API calls.
7032
- * @param {string} scene Unique identifier addressing a collision scene.
8287
+ * @param {string} setup Identifier of the collision setup
7033
8288
  * @param {*} [options] Override http request option.
7034
8289
  * @throws {RequiredError}
7035
8290
  */
7036
- getStoredCollisionScene: (cell: string, scene: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
8291
+ getStoredCollisionSetup: (cell: string, setup: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
7037
8292
  /**
7038
- * Returns a list of stored scenes.
7039
- * @summary List Scenes
8293
+ * Returns a list of stored collision setups.
8294
+ * @summary List Collision Setups
7040
8295
  * @param {string} cell Unique identifier addressing a cell in all API calls.
7041
8296
  * @param {*} [options] Override http request option.
7042
8297
  * @throws {RequiredError}
7043
8298
  */
7044
- listStoredCollisionScenes: (cell: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
8299
+ listStoredCollisionSetups: (cell: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
7045
8300
  /**
7046
- * 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.
7047
- * @summary Store Scene
8301
+ * Stores collision setup. If the collision setup does not exist, it will be created. If the collision setup exists, it will be updated.
8302
+ * @summary Store Collision Setup
7048
8303
  * @param {string} cell Unique identifier addressing a cell in all API calls.
7049
- * @param {string} scene Unique identifier addressing a collision scene.
7050
- * @param {CollisionSceneAssembly} collisionSceneAssembly
8304
+ * @param {string} setup Identifier of the collision setup
8305
+ * @param {CollisionSetup} collisionSetup
7051
8306
  * @param {*} [options] Override http request option.
7052
8307
  * @throws {RequiredError}
7053
8308
  */
7054
- storeCollisionScene: (cell: string, scene: string, collisionSceneAssembly: CollisionSceneAssembly, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
8309
+ storeCollisionSetup: (cell: string, setup: string, collisionSetup: CollisionSetup, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
7055
8310
  };
7056
8311
  /**
7057
- * StoreCollisionScenesApi - functional programming interface
8312
+ * StoreCollisionSetupsApi - functional programming interface
7058
8313
  * @export
7059
8314
  */
7060
- export declare const StoreCollisionScenesApiFp: (configuration?: Configuration) => {
8315
+ export declare const StoreCollisionSetupsApiFp: (configuration?: Configuration) => {
7061
8316
  /**
7062
- * Deletes the stored scene. <!-- theme: danger --> > This will delete persistently stored data.
7063
- * @summary Delete Scene
8317
+ * Deletes the stored collision setup. <!-- theme: danger --> > This will delete persistently stored data.
8318
+ * @summary Delete Collision Setup
7064
8319
  * @param {string} cell Unique identifier addressing a cell in all API calls.
7065
- * @param {string} scene Unique identifier addressing a collision scene.
8320
+ * @param {string} setup Identifier of the collision setup
7066
8321
  * @param {*} [options] Override http request option.
7067
8322
  * @throws {RequiredError}
7068
8323
  */
7069
- deleteStoredCollisionScene(cell: string, scene: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
8324
+ deleteStoredCollisionSetup(cell: string, setup: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
7070
8325
  /**
7071
- * Returns the stored scene.
7072
- * @summary Get Scene
8326
+ * Returns the stored collision setup.
8327
+ * @summary Get Collision Setup
7073
8328
  * @param {string} cell Unique identifier addressing a cell in all API calls.
7074
- * @param {string} scene Unique identifier addressing a collision scene.
8329
+ * @param {string} setup Identifier of the collision setup
7075
8330
  * @param {*} [options] Override http request option.
7076
8331
  * @throws {RequiredError}
7077
8332
  */
7078
- getStoredCollisionScene(cell: string, scene: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CollisionScene>>;
8333
+ getStoredCollisionSetup(cell: string, setup: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CollisionSetup>>;
7079
8334
  /**
7080
- * Returns a list of stored scenes.
7081
- * @summary List Scenes
8335
+ * Returns a list of stored collision setups.
8336
+ * @summary List Collision Setups
7082
8337
  * @param {string} cell Unique identifier addressing a cell in all API calls.
7083
8338
  * @param {*} [options] Override http request option.
7084
8339
  * @throws {RequiredError}
7085
8340
  */
7086
- listStoredCollisionScenes(cell: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<{
7087
- [key: string]: CollisionScene;
8341
+ listStoredCollisionSetups(cell: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<{
8342
+ [key: string]: CollisionSetup;
7088
8343
  }>>;
7089
8344
  /**
7090
- * 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.
7091
- * @summary Store Scene
8345
+ * Stores collision setup. If the collision setup does not exist, it will be created. If the collision setup exists, it will be updated.
8346
+ * @summary Store Collision Setup
7092
8347
  * @param {string} cell Unique identifier addressing a cell in all API calls.
7093
- * @param {string} scene Unique identifier addressing a collision scene.
7094
- * @param {CollisionSceneAssembly} collisionSceneAssembly
8348
+ * @param {string} setup Identifier of the collision setup
8349
+ * @param {CollisionSetup} collisionSetup
7095
8350
  * @param {*} [options] Override http request option.
7096
8351
  * @throws {RequiredError}
7097
8352
  */
7098
- storeCollisionScene(cell: string, scene: string, collisionSceneAssembly: CollisionSceneAssembly, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CollisionScene>>;
8353
+ storeCollisionSetup(cell: string, setup: string, collisionSetup: CollisionSetup, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CollisionSetup>>;
7099
8354
  };
7100
8355
  /**
7101
- * StoreCollisionScenesApi - factory interface
8356
+ * StoreCollisionSetupsApi - factory interface
7102
8357
  * @export
7103
8358
  */
7104
- export declare const StoreCollisionScenesApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
8359
+ export declare const StoreCollisionSetupsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
7105
8360
  /**
7106
- * Deletes the stored scene. <!-- theme: danger --> > This will delete persistently stored data.
7107
- * @summary Delete Scene
8361
+ * Deletes the stored collision setup. <!-- theme: danger --> > This will delete persistently stored data.
8362
+ * @summary Delete Collision Setup
7108
8363
  * @param {string} cell Unique identifier addressing a cell in all API calls.
7109
- * @param {string} scene Unique identifier addressing a collision scene.
8364
+ * @param {string} setup Identifier of the collision setup
7110
8365
  * @param {*} [options] Override http request option.
7111
8366
  * @throws {RequiredError}
7112
8367
  */
7113
- deleteStoredCollisionScene(cell: string, scene: string, options?: RawAxiosRequestConfig): AxiosPromise<void>;
8368
+ deleteStoredCollisionSetup(cell: string, setup: string, options?: RawAxiosRequestConfig): AxiosPromise<void>;
7114
8369
  /**
7115
- * Returns the stored scene.
7116
- * @summary Get Scene
8370
+ * Returns the stored collision setup.
8371
+ * @summary Get Collision Setup
7117
8372
  * @param {string} cell Unique identifier addressing a cell in all API calls.
7118
- * @param {string} scene Unique identifier addressing a collision scene.
8373
+ * @param {string} setup Identifier of the collision setup
7119
8374
  * @param {*} [options] Override http request option.
7120
8375
  * @throws {RequiredError}
7121
8376
  */
7122
- getStoredCollisionScene(cell: string, scene: string, options?: RawAxiosRequestConfig): AxiosPromise<CollisionScene>;
8377
+ getStoredCollisionSetup(cell: string, setup: string, options?: RawAxiosRequestConfig): AxiosPromise<CollisionSetup>;
7123
8378
  /**
7124
- * Returns a list of stored scenes.
7125
- * @summary List Scenes
8379
+ * Returns a list of stored collision setups.
8380
+ * @summary List Collision Setups
7126
8381
  * @param {string} cell Unique identifier addressing a cell in all API calls.
7127
8382
  * @param {*} [options] Override http request option.
7128
8383
  * @throws {RequiredError}
7129
8384
  */
7130
- listStoredCollisionScenes(cell: string, options?: RawAxiosRequestConfig): AxiosPromise<{
7131
- [key: string]: CollisionScene;
8385
+ listStoredCollisionSetups(cell: string, options?: RawAxiosRequestConfig): AxiosPromise<{
8386
+ [key: string]: CollisionSetup;
7132
8387
  }>;
7133
8388
  /**
7134
- * 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.
7135
- * @summary Store Scene
8389
+ * Stores collision setup. If the collision setup does not exist, it will be created. If the collision setup exists, it will be updated.
8390
+ * @summary Store Collision Setup
7136
8391
  * @param {string} cell Unique identifier addressing a cell in all API calls.
7137
- * @param {string} scene Unique identifier addressing a collision scene.
7138
- * @param {CollisionSceneAssembly} collisionSceneAssembly
8392
+ * @param {string} setup Identifier of the collision setup
8393
+ * @param {CollisionSetup} collisionSetup
7139
8394
  * @param {*} [options] Override http request option.
7140
8395
  * @throws {RequiredError}
7141
8396
  */
7142
- storeCollisionScene(cell: string, scene: string, collisionSceneAssembly: CollisionSceneAssembly, options?: RawAxiosRequestConfig): AxiosPromise<CollisionScene>;
8397
+ storeCollisionSetup(cell: string, setup: string, collisionSetup: CollisionSetup, options?: RawAxiosRequestConfig): AxiosPromise<CollisionSetup>;
7143
8398
  };
7144
8399
  /**
7145
- * StoreCollisionScenesApi - object-oriented interface
8400
+ * StoreCollisionSetupsApi - object-oriented interface
7146
8401
  * @export
7147
- * @class StoreCollisionScenesApi
8402
+ * @class StoreCollisionSetupsApi
7148
8403
  * @extends {BaseAPI}
7149
8404
  */
7150
- export declare class StoreCollisionScenesApi extends BaseAPI {
8405
+ export declare class StoreCollisionSetupsApi extends BaseAPI {
7151
8406
  /**
7152
- * Deletes the stored scene. <!-- theme: danger --> > This will delete persistently stored data.
7153
- * @summary Delete Scene
8407
+ * Deletes the stored collision setup. <!-- theme: danger --> > This will delete persistently stored data.
8408
+ * @summary Delete Collision Setup
7154
8409
  * @param {string} cell Unique identifier addressing a cell in all API calls.
7155
- * @param {string} scene Unique identifier addressing a collision scene.
8410
+ * @param {string} setup Identifier of the collision setup
7156
8411
  * @param {*} [options] Override http request option.
7157
8412
  * @throws {RequiredError}
7158
- * @memberof StoreCollisionScenesApi
8413
+ * @memberof StoreCollisionSetupsApi
7159
8414
  */
7160
- deleteStoredCollisionScene(cell: string, scene: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
8415
+ deleteStoredCollisionSetup(cell: string, setup: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
7161
8416
  /**
7162
- * Returns the stored scene.
7163
- * @summary Get Scene
8417
+ * Returns the stored collision setup.
8418
+ * @summary Get Collision Setup
7164
8419
  * @param {string} cell Unique identifier addressing a cell in all API calls.
7165
- * @param {string} scene Unique identifier addressing a collision scene.
8420
+ * @param {string} setup Identifier of the collision setup
7166
8421
  * @param {*} [options] Override http request option.
7167
8422
  * @throws {RequiredError}
7168
- * @memberof StoreCollisionScenesApi
8423
+ * @memberof StoreCollisionSetupsApi
7169
8424
  */
7170
- getStoredCollisionScene(cell: string, scene: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CollisionScene, any>>;
8425
+ getStoredCollisionSetup(cell: string, setup: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CollisionSetup, any>>;
7171
8426
  /**
7172
- * Returns a list of stored scenes.
7173
- * @summary List Scenes
8427
+ * Returns a list of stored collision setups.
8428
+ * @summary List Collision Setups
7174
8429
  * @param {string} cell Unique identifier addressing a cell in all API calls.
7175
8430
  * @param {*} [options] Override http request option.
7176
8431
  * @throws {RequiredError}
7177
- * @memberof StoreCollisionScenesApi
8432
+ * @memberof StoreCollisionSetupsApi
7178
8433
  */
7179
- listStoredCollisionScenes(cell: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<{
7180
- [key: string]: CollisionScene;
8434
+ listStoredCollisionSetups(cell: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<{
8435
+ [key: string]: CollisionSetup;
7181
8436
  }, any>>;
7182
8437
  /**
7183
- * 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.
7184
- * @summary Store Scene
8438
+ * Stores collision setup. If the collision setup does not exist, it will be created. If the collision setup exists, it will be updated.
8439
+ * @summary Store Collision Setup
7185
8440
  * @param {string} cell Unique identifier addressing a cell in all API calls.
7186
- * @param {string} scene Unique identifier addressing a collision scene.
7187
- * @param {CollisionSceneAssembly} collisionSceneAssembly
8441
+ * @param {string} setup Identifier of the collision setup
8442
+ * @param {CollisionSetup} collisionSetup
7188
8443
  * @param {*} [options] Override http request option.
7189
8444
  * @throws {RequiredError}
7190
- * @memberof StoreCollisionScenesApi
8445
+ * @memberof StoreCollisionSetupsApi
7191
8446
  */
7192
- storeCollisionScene(cell: string, scene: string, collisionSceneAssembly: CollisionSceneAssembly, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CollisionScene, any>>;
8447
+ storeCollisionSetup(cell: string, setup: string, collisionSetup: CollisionSetup, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CollisionSetup, any>>;
7193
8448
  }
7194
8449
  /**
7195
8450
  * StoreObjectApi - axios parameter creator
@@ -7453,14 +8708,14 @@ export declare class StoreObjectApi extends BaseAPI {
7453
8708
  */
7454
8709
  export declare const SystemApiAxiosParamCreator: (configuration?: Configuration) => {
7455
8710
  /**
7456
- * Retrieves a configuration backup based on provided resource identifiers.
8711
+ * Retrieves a configuration backup based on provided resource identifiers. If an empty array of resources is provided, a backup for all resources will be retrieved.
7457
8712
  * @summary Retrieve Configuration Backup
7458
- * @param {Array<string>} resources List of resource identifiers to included in the backup and restore operations.
8713
+ * @param {Array<string>} [resources] List of resource identifiers to include in the retrieval.
7459
8714
  * @param {{ [key: string]: string; }} [metadata] Additional metadata to add to the backup
7460
8715
  * @param {*} [options] Override http request option.
7461
8716
  * @throws {RequiredError}
7462
8717
  */
7463
- backupConfiguration: (resources: Array<string>, metadata?: {
8718
+ backupConfiguration: (resources?: Array<string>, metadata?: {
7464
8719
  [key: string]: string;
7465
8720
  }, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
7466
8721
  /**
@@ -7531,14 +8786,14 @@ export declare const SystemApiAxiosParamCreator: (configuration?: Configuration)
7531
8786
  */
7532
8787
  export declare const SystemApiFp: (configuration?: Configuration) => {
7533
8788
  /**
7534
- * Retrieves a configuration backup based on provided resource identifiers.
8789
+ * Retrieves a configuration backup based on provided resource identifiers. If an empty array of resources is provided, a backup for all resources will be retrieved.
7535
8790
  * @summary Retrieve Configuration Backup
7536
- * @param {Array<string>} resources List of resource identifiers to included in the backup and restore operations.
8791
+ * @param {Array<string>} [resources] List of resource identifiers to include in the retrieval.
7537
8792
  * @param {{ [key: string]: string; }} [metadata] Additional metadata to add to the backup
7538
8793
  * @param {*} [options] Override http request option.
7539
8794
  * @throws {RequiredError}
7540
8795
  */
7541
- backupConfiguration(resources: Array<string>, metadata?: {
8796
+ backupConfiguration(resources?: Array<string>, metadata?: {
7542
8797
  [key: string]: string;
7543
8798
  }, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<File>>;
7544
8799
  /**
@@ -7609,14 +8864,14 @@ export declare const SystemApiFp: (configuration?: Configuration) => {
7609
8864
  */
7610
8865
  export declare const SystemApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
7611
8866
  /**
7612
- * Retrieves a configuration backup based on provided resource identifiers.
8867
+ * Retrieves a configuration backup based on provided resource identifiers. If an empty array of resources is provided, a backup for all resources will be retrieved.
7613
8868
  * @summary Retrieve Configuration Backup
7614
- * @param {Array<string>} resources List of resource identifiers to included in the backup and restore operations.
8869
+ * @param {Array<string>} [resources] List of resource identifiers to include in the retrieval.
7615
8870
  * @param {{ [key: string]: string; }} [metadata] Additional metadata to add to the backup
7616
8871
  * @param {*} [options] Override http request option.
7617
8872
  * @throws {RequiredError}
7618
8873
  */
7619
- backupConfiguration(resources: Array<string>, metadata?: {
8874
+ backupConfiguration(resources?: Array<string>, metadata?: {
7620
8875
  [key: string]: string;
7621
8876
  }, options?: RawAxiosRequestConfig): AxiosPromise<File>;
7622
8877
  /**
@@ -7689,15 +8944,15 @@ export declare const SystemApiFactory: (configuration?: Configuration, basePath?
7689
8944
  */
7690
8945
  export declare class SystemApi extends BaseAPI {
7691
8946
  /**
7692
- * Retrieves a configuration backup based on provided resource identifiers.
8947
+ * Retrieves a configuration backup based on provided resource identifiers. If an empty array of resources is provided, a backup for all resources will be retrieved.
7693
8948
  * @summary Retrieve Configuration Backup
7694
- * @param {Array<string>} resources List of resource identifiers to included in the backup and restore operations.
8949
+ * @param {Array<string>} [resources] List of resource identifiers to include in the retrieval.
7695
8950
  * @param {{ [key: string]: string; }} [metadata] Additional metadata to add to the backup
7696
8951
  * @param {*} [options] Override http request option.
7697
8952
  * @throws {RequiredError}
7698
8953
  * @memberof SystemApi
7699
8954
  */
7700
- backupConfiguration(resources: Array<string>, metadata?: {
8955
+ backupConfiguration(resources?: Array<string>, metadata?: {
7701
8956
  [key: string]: string;
7702
8957
  }, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<File, any>>;
7703
8958
  /**
@@ -8065,6 +9320,15 @@ export declare class TrajectoryExecutionApi extends BaseAPI {
8065
9320
  * @export
8066
9321
  */
8067
9322
  export declare const TrajectoryPlanningApiAxiosParamCreator: (configuration?: Configuration) => {
9323
+ /**
9324
+ * 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.
9325
+ * @summary Plan Collision-Free Trajectory
9326
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
9327
+ * @param {PlanCollisionFreeRequest} [planCollisionFreeRequest]
9328
+ * @param {*} [options] Override http request option.
9329
+ * @throws {RequiredError}
9330
+ */
9331
+ planCollisionFree: (cell: string, planCollisionFreeRequest?: PlanCollisionFreeRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
8068
9332
  /**
8069
9333
  * 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.
8070
9334
  * @summary Plan Trajectory
@@ -8080,6 +9344,15 @@ export declare const TrajectoryPlanningApiAxiosParamCreator: (configuration?: Co
8080
9344
  * @export
8081
9345
  */
8082
9346
  export declare const TrajectoryPlanningApiFp: (configuration?: Configuration) => {
9347
+ /**
9348
+ * 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.
9349
+ * @summary Plan Collision-Free Trajectory
9350
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
9351
+ * @param {PlanCollisionFreeRequest} [planCollisionFreeRequest]
9352
+ * @param {*} [options] Override http request option.
9353
+ * @throws {RequiredError}
9354
+ */
9355
+ planCollisionFree(cell: string, planCollisionFreeRequest?: PlanCollisionFreeRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PlanCollisionFreeResponse>>;
8083
9356
  /**
8084
9357
  * 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.
8085
9358
  * @summary Plan Trajectory
@@ -8095,6 +9368,15 @@ export declare const TrajectoryPlanningApiFp: (configuration?: Configuration) =>
8095
9368
  * @export
8096
9369
  */
8097
9370
  export declare const TrajectoryPlanningApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
9371
+ /**
9372
+ * 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.
9373
+ * @summary Plan Collision-Free Trajectory
9374
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
9375
+ * @param {PlanCollisionFreeRequest} [planCollisionFreeRequest]
9376
+ * @param {*} [options] Override http request option.
9377
+ * @throws {RequiredError}
9378
+ */
9379
+ planCollisionFree(cell: string, planCollisionFreeRequest?: PlanCollisionFreeRequest, options?: RawAxiosRequestConfig): AxiosPromise<PlanCollisionFreeResponse>;
8098
9380
  /**
8099
9381
  * 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.
8100
9382
  * @summary Plan Trajectory
@@ -8112,6 +9394,16 @@ export declare const TrajectoryPlanningApiFactory: (configuration?: Configuratio
8112
9394
  * @extends {BaseAPI}
8113
9395
  */
8114
9396
  export declare class TrajectoryPlanningApi extends BaseAPI {
9397
+ /**
9398
+ * 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.
9399
+ * @summary Plan Collision-Free Trajectory
9400
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
9401
+ * @param {PlanCollisionFreeRequest} [planCollisionFreeRequest]
9402
+ * @param {*} [options] Override http request option.
9403
+ * @throws {RequiredError}
9404
+ * @memberof TrajectoryPlanningApi
9405
+ */
9406
+ planCollisionFree(cell: string, planCollisionFreeRequest?: PlanCollisionFreeRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<PlanCollisionFreeResponse, any>>;
8115
9407
  /**
8116
9408
  * 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.
8117
9409
  * @summary Plan Trajectory
@@ -8138,7 +9430,7 @@ export declare const VirtualControllerApiAxiosParamCreator: (configuration?: Con
8138
9430
  * @param {*} [options] Override http request option.
8139
9431
  * @throws {RequiredError}
8140
9432
  */
8141
- addVirtualRobotCoordinateSystem: (cell: string, controller: string, coordinateSystem: string, coordinateSystemData: CoordinateSystemData, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
9433
+ addVirtualControllerCoordinateSystem: (cell: string, controller: string, coordinateSystem: string, coordinateSystemData: CoordinateSystemData, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
8142
9434
  /**
8143
9435
  * Adds a new TCP or updates an existing TCP in the motion group. The position and rotation values in the request body are defined within the flange’s coordinate system. > **NOTE** > > Ensure the TCP\'s position is within the robot\'s reach. Refer to the robot’s documentation or data sheet for details like joint limits or reach.
8144
9436
  * @summary Add TCP
@@ -8150,7 +9442,7 @@ export declare const VirtualControllerApiAxiosParamCreator: (configuration?: Con
8150
9442
  * @param {*} [options] Override http request option.
8151
9443
  * @throws {RequiredError}
8152
9444
  */
8153
- addVirtualRobotTcp: (cell: string, controller: string, motionGroup: string, tcp: string, robotTcpData: RobotTcpData, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
9445
+ addVirtualControllerTcp: (cell: string, controller: string, motionGroup: string, tcp: string, robotTcpData: RobotTcpData, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
8154
9446
  /**
8155
9447
  * Deletes a coordinate system from the virtual controller. This will remove the coordinate system from the list of coordinate systems and remove all dependent coordinate systems which use the deleted coordinate system as reference.
8156
9448
  * @summary Remove Coordinate System
@@ -8161,7 +9453,7 @@ export declare const VirtualControllerApiAxiosParamCreator: (configuration?: Con
8161
9453
  * @param {*} [options] Override http request option.
8162
9454
  * @throws {RequiredError}
8163
9455
  */
8164
- deleteVirtualRobotCoordinateSystem: (cell: string, controller: string, coordinateSystem: string, deleteDependent?: boolean, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
9456
+ deleteVirtualControllerCoordinateSystem: (cell: string, controller: string, coordinateSystem: string, deleteDependent?: boolean, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
8165
9457
  /**
8166
9458
  * Removes the TCP from the motion group. An unknown TCP is a valid input.
8167
9459
  * @summary Remove TCP
@@ -8172,7 +9464,7 @@ export declare const VirtualControllerApiAxiosParamCreator: (configuration?: Con
8172
9464
  * @param {*} [options] Override http request option.
8173
9465
  * @throws {RequiredError}
8174
9466
  */
8175
- deleteVirtualRobotTcp: (cell: string, controller: string, motionGroup: string, tcp: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
9467
+ deleteVirtualControllerTcp: (cell: string, controller: string, motionGroup: string, tcp: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
8176
9468
  /**
8177
9469
  * Requests the Emergency Stop state of the virtual robot controller. Use [getCurrentMotionGroupState](getCurrentMotionGroupState) to get the Emergency Stop state regardless of the controller type. There the Emergency Stop state is visible as the `safety_state`. > **NOTE** > > The Emergency Stop state can only be changed when using virtual robot controllers.
8178
9470
  * @summary Get Emergency Stop State
@@ -8219,7 +9511,7 @@ export declare const VirtualControllerApiAxiosParamCreator: (configuration?: Con
8219
9511
  * @param {*} [options] Override http request option.
8220
9512
  * @throws {RequiredError}
8221
9513
  */
8222
- getVirtualRobotMounting: (cell: string, controller: string, motionGroup: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
9514
+ getVirtualControllerMounting: (cell: string, controller: string, motionGroup: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
8223
9515
  /**
8224
9516
  * Lists all coordinate systems on the robot controller.
8225
9517
  * @summary List Coordinate Systems
@@ -8228,7 +9520,7 @@ export declare const VirtualControllerApiAxiosParamCreator: (configuration?: Con
8228
9520
  * @param {*} [options] Override http request option.
8229
9521
  * @throws {RequiredError}
8230
9522
  */
8231
- listVirtualRobotCoordinateSystems: (cell: string, controller: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
9523
+ listVirtualControllerCoordinateSystems: (cell: string, controller: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
8232
9524
  /**
8233
9525
  * Lists TCPs of the motion group. An empty TCP list is valid, for example for external axes.
8234
9526
  * @summary List TCPs
@@ -8238,7 +9530,7 @@ export declare const VirtualControllerApiAxiosParamCreator: (configuration?: Con
8238
9530
  * @param {*} [options] Override http request option.
8239
9531
  * @throws {RequiredError}
8240
9532
  */
8241
- listVirtualRobotTcps: (cell: string, controller: string, motionGroup: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
9533
+ listVirtualControllerTcps: (cell: string, controller: string, motionGroup: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
8242
9534
  /**
8243
9535
  * Activates or releases the Emergency Stop on the virtual robot controller. Activating the Emergency Stop stops the execution of all motions. The stop is executed on physical controllers immediately not gracefully and not on paths. Due to restricted physical behavior of the virtual robot controller, the Emergency Stop is executed on paths. To return to normal operation the Emergency Stop needs to be released. Use [getCurrentMotionGroupState](getCurrentMotionGroupState) to get the Emergency Stop state regardless of the controller type. There the Emergency Stop state is visible as the `safety_state`. > **NOTE** > > The Emergency Stop state can only be changed via API when using virtual robot controllers.
8244
9536
  * @summary Push or Release Emergency Stop
@@ -8280,7 +9572,7 @@ export declare const VirtualControllerApiAxiosParamCreator: (configuration?: Con
8280
9572
  * @param {*} [options] Override http request option.
8281
9573
  * @throws {RequiredError}
8282
9574
  */
8283
- setVirtualRobotMounting: (cell: string, controller: string, motionGroup: string, coordinateSystem: CoordinateSystem, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
9575
+ setVirtualControllerMounting: (cell: string, controller: string, motionGroup: string, coordinateSystem: CoordinateSystem, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
8284
9576
  };
8285
9577
  /**
8286
9578
  * VirtualControllerApi - functional programming interface
@@ -8297,7 +9589,7 @@ export declare const VirtualControllerApiFp: (configuration?: Configuration) =>
8297
9589
  * @param {*} [options] Override http request option.
8298
9590
  * @throws {RequiredError}
8299
9591
  */
8300
- addVirtualRobotCoordinateSystem(cell: string, controller: string, coordinateSystem: string, coordinateSystemData: CoordinateSystemData, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
9592
+ addVirtualControllerCoordinateSystem(cell: string, controller: string, coordinateSystem: string, coordinateSystemData: CoordinateSystemData, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
8301
9593
  /**
8302
9594
  * Adds a new TCP or updates an existing TCP in the motion group. The position and rotation values in the request body are defined within the flange’s coordinate system. > **NOTE** > > Ensure the TCP\'s position is within the robot\'s reach. Refer to the robot’s documentation or data sheet for details like joint limits or reach.
8303
9595
  * @summary Add TCP
@@ -8309,7 +9601,7 @@ export declare const VirtualControllerApiFp: (configuration?: Configuration) =>
8309
9601
  * @param {*} [options] Override http request option.
8310
9602
  * @throws {RequiredError}
8311
9603
  */
8312
- addVirtualRobotTcp(cell: string, controller: string, motionGroup: string, tcp: string, robotTcpData: RobotTcpData, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
9604
+ addVirtualControllerTcp(cell: string, controller: string, motionGroup: string, tcp: string, robotTcpData: RobotTcpData, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
8313
9605
  /**
8314
9606
  * Deletes a coordinate system from the virtual controller. This will remove the coordinate system from the list of coordinate systems and remove all dependent coordinate systems which use the deleted coordinate system as reference.
8315
9607
  * @summary Remove Coordinate System
@@ -8320,7 +9612,7 @@ export declare const VirtualControllerApiFp: (configuration?: Configuration) =>
8320
9612
  * @param {*} [options] Override http request option.
8321
9613
  * @throws {RequiredError}
8322
9614
  */
8323
- deleteVirtualRobotCoordinateSystem(cell: string, controller: string, coordinateSystem: string, deleteDependent?: boolean, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
9615
+ deleteVirtualControllerCoordinateSystem(cell: string, controller: string, coordinateSystem: string, deleteDependent?: boolean, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
8324
9616
  /**
8325
9617
  * Removes the TCP from the motion group. An unknown TCP is a valid input.
8326
9618
  * @summary Remove TCP
@@ -8331,7 +9623,7 @@ export declare const VirtualControllerApiFp: (configuration?: Configuration) =>
8331
9623
  * @param {*} [options] Override http request option.
8332
9624
  * @throws {RequiredError}
8333
9625
  */
8334
- deleteVirtualRobotTcp(cell: string, controller: string, motionGroup: string, tcp: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
9626
+ deleteVirtualControllerTcp(cell: string, controller: string, motionGroup: string, tcp: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
8335
9627
  /**
8336
9628
  * Requests the Emergency Stop state of the virtual robot controller. Use [getCurrentMotionGroupState](getCurrentMotionGroupState) to get the Emergency Stop state regardless of the controller type. There the Emergency Stop state is visible as the `safety_state`. > **NOTE** > > The Emergency Stop state can only be changed when using virtual robot controllers.
8337
9629
  * @summary Get Emergency Stop State
@@ -8378,7 +9670,7 @@ export declare const VirtualControllerApiFp: (configuration?: Configuration) =>
8378
9670
  * @param {*} [options] Override http request option.
8379
9671
  * @throws {RequiredError}
8380
9672
  */
8381
- getVirtualRobotMounting(cell: string, controller: string, motionGroup: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CoordinateSystem>>;
9673
+ getVirtualControllerMounting(cell: string, controller: string, motionGroup: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CoordinateSystem>>;
8382
9674
  /**
8383
9675
  * Lists all coordinate systems on the robot controller.
8384
9676
  * @summary List Coordinate Systems
@@ -8387,7 +9679,7 @@ export declare const VirtualControllerApiFp: (configuration?: Configuration) =>
8387
9679
  * @param {*} [options] Override http request option.
8388
9680
  * @throws {RequiredError}
8389
9681
  */
8390
- listVirtualRobotCoordinateSystems(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<CoordinateSystem>>>;
9682
+ listVirtualControllerCoordinateSystems(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<CoordinateSystem>>>;
8391
9683
  /**
8392
9684
  * Lists TCPs of the motion group. An empty TCP list is valid, for example for external axes.
8393
9685
  * @summary List TCPs
@@ -8397,7 +9689,7 @@ export declare const VirtualControllerApiFp: (configuration?: Configuration) =>
8397
9689
  * @param {*} [options] Override http request option.
8398
9690
  * @throws {RequiredError}
8399
9691
  */
8400
- listVirtualRobotTcps(cell: string, controller: string, motionGroup: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<RobotTcp>>>;
9692
+ listVirtualControllerTcps(cell: string, controller: string, motionGroup: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<RobotTcp>>>;
8401
9693
  /**
8402
9694
  * Activates or releases the Emergency Stop on the virtual robot controller. Activating the Emergency Stop stops the execution of all motions. The stop is executed on physical controllers immediately not gracefully and not on paths. Due to restricted physical behavior of the virtual robot controller, the Emergency Stop is executed on paths. To return to normal operation the Emergency Stop needs to be released. Use [getCurrentMotionGroupState](getCurrentMotionGroupState) to get the Emergency Stop state regardless of the controller type. There the Emergency Stop state is visible as the `safety_state`. > **NOTE** > > The Emergency Stop state can only be changed via API when using virtual robot controllers.
8403
9695
  * @summary Push or Release Emergency Stop
@@ -8439,7 +9731,7 @@ export declare const VirtualControllerApiFp: (configuration?: Configuration) =>
8439
9731
  * @param {*} [options] Override http request option.
8440
9732
  * @throws {RequiredError}
8441
9733
  */
8442
- setVirtualRobotMounting(cell: string, controller: string, motionGroup: string, coordinateSystem: CoordinateSystem, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CoordinateSystem>>;
9734
+ setVirtualControllerMounting(cell: string, controller: string, motionGroup: string, coordinateSystem: CoordinateSystem, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CoordinateSystem>>;
8443
9735
  };
8444
9736
  /**
8445
9737
  * VirtualControllerApi - factory interface
@@ -8456,7 +9748,7 @@ export declare const VirtualControllerApiFactory: (configuration?: Configuration
8456
9748
  * @param {*} [options] Override http request option.
8457
9749
  * @throws {RequiredError}
8458
9750
  */
8459
- addVirtualRobotCoordinateSystem(cell: string, controller: string, coordinateSystem: string, coordinateSystemData: CoordinateSystemData, options?: RawAxiosRequestConfig): AxiosPromise<void>;
9751
+ addVirtualControllerCoordinateSystem(cell: string, controller: string, coordinateSystem: string, coordinateSystemData: CoordinateSystemData, options?: RawAxiosRequestConfig): AxiosPromise<void>;
8460
9752
  /**
8461
9753
  * Adds a new TCP or updates an existing TCP in the motion group. The position and rotation values in the request body are defined within the flange’s coordinate system. > **NOTE** > > Ensure the TCP\'s position is within the robot\'s reach. Refer to the robot’s documentation or data sheet for details like joint limits or reach.
8462
9754
  * @summary Add TCP
@@ -8468,7 +9760,7 @@ export declare const VirtualControllerApiFactory: (configuration?: Configuration
8468
9760
  * @param {*} [options] Override http request option.
8469
9761
  * @throws {RequiredError}
8470
9762
  */
8471
- addVirtualRobotTcp(cell: string, controller: string, motionGroup: string, tcp: string, robotTcpData: RobotTcpData, options?: RawAxiosRequestConfig): AxiosPromise<void>;
9763
+ addVirtualControllerTcp(cell: string, controller: string, motionGroup: string, tcp: string, robotTcpData: RobotTcpData, options?: RawAxiosRequestConfig): AxiosPromise<void>;
8472
9764
  /**
8473
9765
  * Deletes a coordinate system from the virtual controller. This will remove the coordinate system from the list of coordinate systems and remove all dependent coordinate systems which use the deleted coordinate system as reference.
8474
9766
  * @summary Remove Coordinate System
@@ -8479,7 +9771,7 @@ export declare const VirtualControllerApiFactory: (configuration?: Configuration
8479
9771
  * @param {*} [options] Override http request option.
8480
9772
  * @throws {RequiredError}
8481
9773
  */
8482
- deleteVirtualRobotCoordinateSystem(cell: string, controller: string, coordinateSystem: string, deleteDependent?: boolean, options?: RawAxiosRequestConfig): AxiosPromise<void>;
9774
+ deleteVirtualControllerCoordinateSystem(cell: string, controller: string, coordinateSystem: string, deleteDependent?: boolean, options?: RawAxiosRequestConfig): AxiosPromise<void>;
8483
9775
  /**
8484
9776
  * Removes the TCP from the motion group. An unknown TCP is a valid input.
8485
9777
  * @summary Remove TCP
@@ -8490,7 +9782,7 @@ export declare const VirtualControllerApiFactory: (configuration?: Configuration
8490
9782
  * @param {*} [options] Override http request option.
8491
9783
  * @throws {RequiredError}
8492
9784
  */
8493
- deleteVirtualRobotTcp(cell: string, controller: string, motionGroup: string, tcp: string, options?: RawAxiosRequestConfig): AxiosPromise<void>;
9785
+ deleteVirtualControllerTcp(cell: string, controller: string, motionGroup: string, tcp: string, options?: RawAxiosRequestConfig): AxiosPromise<void>;
8494
9786
  /**
8495
9787
  * Requests the Emergency Stop state of the virtual robot controller. Use [getCurrentMotionGroupState](getCurrentMotionGroupState) to get the Emergency Stop state regardless of the controller type. There the Emergency Stop state is visible as the `safety_state`. > **NOTE** > > The Emergency Stop state can only be changed when using virtual robot controllers.
8496
9788
  * @summary Get Emergency Stop State
@@ -8537,7 +9829,7 @@ export declare const VirtualControllerApiFactory: (configuration?: Configuration
8537
9829
  * @param {*} [options] Override http request option.
8538
9830
  * @throws {RequiredError}
8539
9831
  */
8540
- getVirtualRobotMounting(cell: string, controller: string, motionGroup: string, options?: RawAxiosRequestConfig): AxiosPromise<CoordinateSystem>;
9832
+ getVirtualControllerMounting(cell: string, controller: string, motionGroup: string, options?: RawAxiosRequestConfig): AxiosPromise<CoordinateSystem>;
8541
9833
  /**
8542
9834
  * Lists all coordinate systems on the robot controller.
8543
9835
  * @summary List Coordinate Systems
@@ -8546,7 +9838,7 @@ export declare const VirtualControllerApiFactory: (configuration?: Configuration
8546
9838
  * @param {*} [options] Override http request option.
8547
9839
  * @throws {RequiredError}
8548
9840
  */
8549
- listVirtualRobotCoordinateSystems(cell: string, controller: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<CoordinateSystem>>;
9841
+ listVirtualControllerCoordinateSystems(cell: string, controller: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<CoordinateSystem>>;
8550
9842
  /**
8551
9843
  * Lists TCPs of the motion group. An empty TCP list is valid, for example for external axes.
8552
9844
  * @summary List TCPs
@@ -8556,7 +9848,7 @@ export declare const VirtualControllerApiFactory: (configuration?: Configuration
8556
9848
  * @param {*} [options] Override http request option.
8557
9849
  * @throws {RequiredError}
8558
9850
  */
8559
- listVirtualRobotTcps(cell: string, controller: string, motionGroup: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<RobotTcp>>;
9851
+ listVirtualControllerTcps(cell: string, controller: string, motionGroup: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<RobotTcp>>;
8560
9852
  /**
8561
9853
  * Activates or releases the Emergency Stop on the virtual robot controller. Activating the Emergency Stop stops the execution of all motions. The stop is executed on physical controllers immediately not gracefully and not on paths. Due to restricted physical behavior of the virtual robot controller, the Emergency Stop is executed on paths. To return to normal operation the Emergency Stop needs to be released. Use [getCurrentMotionGroupState](getCurrentMotionGroupState) to get the Emergency Stop state regardless of the controller type. There the Emergency Stop state is visible as the `safety_state`. > **NOTE** > > The Emergency Stop state can only be changed via API when using virtual robot controllers.
8562
9854
  * @summary Push or Release Emergency Stop
@@ -8598,7 +9890,7 @@ export declare const VirtualControllerApiFactory: (configuration?: Configuration
8598
9890
  * @param {*} [options] Override http request option.
8599
9891
  * @throws {RequiredError}
8600
9892
  */
8601
- setVirtualRobotMounting(cell: string, controller: string, motionGroup: string, coordinateSystem: CoordinateSystem, options?: RawAxiosRequestConfig): AxiosPromise<CoordinateSystem>;
9893
+ setVirtualControllerMounting(cell: string, controller: string, motionGroup: string, coordinateSystem: CoordinateSystem, options?: RawAxiosRequestConfig): AxiosPromise<CoordinateSystem>;
8602
9894
  };
8603
9895
  /**
8604
9896
  * VirtualControllerApi - object-oriented interface
@@ -8618,7 +9910,7 @@ export declare class VirtualControllerApi extends BaseAPI {
8618
9910
  * @throws {RequiredError}
8619
9911
  * @memberof VirtualControllerApi
8620
9912
  */
8621
- addVirtualRobotCoordinateSystem(cell: string, controller: string, coordinateSystem: string, coordinateSystemData: CoordinateSystemData, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
9913
+ addVirtualControllerCoordinateSystem(cell: string, controller: string, coordinateSystem: string, coordinateSystemData: CoordinateSystemData, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
8622
9914
  /**
8623
9915
  * Adds a new TCP or updates an existing TCP in the motion group. The position and rotation values in the request body are defined within the flange’s coordinate system. > **NOTE** > > Ensure the TCP\'s position is within the robot\'s reach. Refer to the robot’s documentation or data sheet for details like joint limits or reach.
8624
9916
  * @summary Add TCP
@@ -8631,7 +9923,7 @@ export declare class VirtualControllerApi extends BaseAPI {
8631
9923
  * @throws {RequiredError}
8632
9924
  * @memberof VirtualControllerApi
8633
9925
  */
8634
- addVirtualRobotTcp(cell: string, controller: string, motionGroup: string, tcp: string, robotTcpData: RobotTcpData, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
9926
+ addVirtualControllerTcp(cell: string, controller: string, motionGroup: string, tcp: string, robotTcpData: RobotTcpData, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
8635
9927
  /**
8636
9928
  * Deletes a coordinate system from the virtual controller. This will remove the coordinate system from the list of coordinate systems and remove all dependent coordinate systems which use the deleted coordinate system as reference.
8637
9929
  * @summary Remove Coordinate System
@@ -8643,7 +9935,7 @@ export declare class VirtualControllerApi extends BaseAPI {
8643
9935
  * @throws {RequiredError}
8644
9936
  * @memberof VirtualControllerApi
8645
9937
  */
8646
- deleteVirtualRobotCoordinateSystem(cell: string, controller: string, coordinateSystem: string, deleteDependent?: boolean, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
9938
+ deleteVirtualControllerCoordinateSystem(cell: string, controller: string, coordinateSystem: string, deleteDependent?: boolean, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
8647
9939
  /**
8648
9940
  * Removes the TCP from the motion group. An unknown TCP is a valid input.
8649
9941
  * @summary Remove TCP
@@ -8655,7 +9947,7 @@ export declare class VirtualControllerApi extends BaseAPI {
8655
9947
  * @throws {RequiredError}
8656
9948
  * @memberof VirtualControllerApi
8657
9949
  */
8658
- deleteVirtualRobotTcp(cell: string, controller: string, motionGroup: string, tcp: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
9950
+ deleteVirtualControllerTcp(cell: string, controller: string, motionGroup: string, tcp: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
8659
9951
  /**
8660
9952
  * Requests the Emergency Stop state of the virtual robot controller. Use [getCurrentMotionGroupState](getCurrentMotionGroupState) to get the Emergency Stop state regardless of the controller type. There the Emergency Stop state is visible as the `safety_state`. > **NOTE** > > The Emergency Stop state can only be changed when using virtual robot controllers.
8661
9953
  * @summary Get Emergency Stop State
@@ -8707,7 +9999,7 @@ export declare class VirtualControllerApi extends BaseAPI {
8707
9999
  * @throws {RequiredError}
8708
10000
  * @memberof VirtualControllerApi
8709
10001
  */
8710
- getVirtualRobotMounting(cell: string, controller: string, motionGroup: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CoordinateSystem, any>>;
10002
+ getVirtualControllerMounting(cell: string, controller: string, motionGroup: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CoordinateSystem, any>>;
8711
10003
  /**
8712
10004
  * Lists all coordinate systems on the robot controller.
8713
10005
  * @summary List Coordinate Systems
@@ -8717,7 +10009,7 @@ export declare class VirtualControllerApi extends BaseAPI {
8717
10009
  * @throws {RequiredError}
8718
10010
  * @memberof VirtualControllerApi
8719
10011
  */
8720
- listVirtualRobotCoordinateSystems(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CoordinateSystem[], any>>;
10012
+ listVirtualControllerCoordinateSystems(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CoordinateSystem[], any>>;
8721
10013
  /**
8722
10014
  * Lists TCPs of the motion group. An empty TCP list is valid, for example for external axes.
8723
10015
  * @summary List TCPs
@@ -8728,7 +10020,7 @@ export declare class VirtualControllerApi extends BaseAPI {
8728
10020
  * @throws {RequiredError}
8729
10021
  * @memberof VirtualControllerApi
8730
10022
  */
8731
- listVirtualRobotTcps(cell: string, controller: string, motionGroup: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<RobotTcp[], any>>;
10023
+ listVirtualControllerTcps(cell: string, controller: string, motionGroup: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<RobotTcp[], any>>;
8732
10024
  /**
8733
10025
  * Activates or releases the Emergency Stop on the virtual robot controller. Activating the Emergency Stop stops the execution of all motions. The stop is executed on physical controllers immediately not gracefully and not on paths. Due to restricted physical behavior of the virtual robot controller, the Emergency Stop is executed on paths. To return to normal operation the Emergency Stop needs to be released. Use [getCurrentMotionGroupState](getCurrentMotionGroupState) to get the Emergency Stop state regardless of the controller type. There the Emergency Stop state is visible as the `safety_state`. > **NOTE** > > The Emergency Stop state can only be changed via API when using virtual robot controllers.
8734
10026
  * @summary Push or Release Emergency Stop
@@ -8774,7 +10066,7 @@ export declare class VirtualControllerApi extends BaseAPI {
8774
10066
  * @throws {RequiredError}
8775
10067
  * @memberof VirtualControllerApi
8776
10068
  */
8777
- setVirtualRobotMounting(cell: string, controller: string, motionGroup: string, coordinateSystem: CoordinateSystem, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CoordinateSystem, any>>;
10069
+ setVirtualControllerMounting(cell: string, controller: string, motionGroup: string, coordinateSystem: CoordinateSystem, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CoordinateSystem, any>>;
8778
10070
  }
8779
10071
  /**
8780
10072
  * VirtualControllerBehaviorApi - axios parameter creator
@@ -8801,14 +10093,14 @@ export declare const VirtualControllerBehaviorApiAxiosParamCreator: (configurati
8801
10093
  */
8802
10094
  getCycleTime: (cell: string, controller: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
8803
10095
  /**
8804
- * Get the current virtual controller behavior - please see the setter [setVirtualRobotBehavior](setVirtualRobotBehavior) and the enum for details.
10096
+ * Get the current virtual controller behavior - please see the setter [setVirtualControllerBehavior](setVirtualControllerBehavior) and the enum for details.
8805
10097
  * @summary Get Behavior
8806
10098
  * @param {string} cell Unique identifier addressing a cell in all API calls.
8807
10099
  * @param {string} controller Unique identifier to address a controller in the cell.
8808
10100
  * @param {*} [options] Override http request option.
8809
10101
  * @throws {RequiredError}
8810
10102
  */
8811
- getVirtualRobotBehavior: (cell: string, controller: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
10103
+ getVirtualControllerBehavior: (cell: string, controller: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
8812
10104
  /**
8813
10105
  * Set virtual controller behavior.
8814
10106
  * @summary Set Behavior
@@ -8818,7 +10110,7 @@ export declare const VirtualControllerBehaviorApiAxiosParamCreator: (configurati
8818
10110
  * @param {*} [options] Override http request option.
8819
10111
  * @throws {RequiredError}
8820
10112
  */
8821
- setVirtualRobotBehavior: (cell: string, controller: string, behavior?: Behavior, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
10113
+ setVirtualControllerBehavior: (cell: string, controller: string, behavior?: Behavior, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
8822
10114
  };
8823
10115
  /**
8824
10116
  * VirtualControllerBehaviorApi - functional programming interface
@@ -8845,14 +10137,14 @@ export declare const VirtualControllerBehaviorApiFp: (configuration?: Configurat
8845
10137
  */
8846
10138
  getCycleTime(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CycleTime>>;
8847
10139
  /**
8848
- * Get the current virtual controller behavior - please see the setter [setVirtualRobotBehavior](setVirtualRobotBehavior) and the enum for details.
10140
+ * Get the current virtual controller behavior - please see the setter [setVirtualControllerBehavior](setVirtualControllerBehavior) and the enum for details.
8849
10141
  * @summary Get Behavior
8850
10142
  * @param {string} cell Unique identifier addressing a cell in all API calls.
8851
10143
  * @param {string} controller Unique identifier to address a controller in the cell.
8852
10144
  * @param {*} [options] Override http request option.
8853
10145
  * @throws {RequiredError}
8854
10146
  */
8855
- getVirtualRobotBehavior(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Behavior>>;
10147
+ getVirtualControllerBehavior(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Behavior>>;
8856
10148
  /**
8857
10149
  * Set virtual controller behavior.
8858
10150
  * @summary Set Behavior
@@ -8862,7 +10154,7 @@ export declare const VirtualControllerBehaviorApiFp: (configuration?: Configurat
8862
10154
  * @param {*} [options] Override http request option.
8863
10155
  * @throws {RequiredError}
8864
10156
  */
8865
- setVirtualRobotBehavior(cell: string, controller: string, behavior?: Behavior, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
10157
+ setVirtualControllerBehavior(cell: string, controller: string, behavior?: Behavior, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
8866
10158
  };
8867
10159
  /**
8868
10160
  * VirtualControllerBehaviorApi - factory interface
@@ -8889,14 +10181,14 @@ export declare const VirtualControllerBehaviorApiFactory: (configuration?: Confi
8889
10181
  */
8890
10182
  getCycleTime(cell: string, controller: string, options?: RawAxiosRequestConfig): AxiosPromise<CycleTime>;
8891
10183
  /**
8892
- * Get the current virtual controller behavior - please see the setter [setVirtualRobotBehavior](setVirtualRobotBehavior) and the enum for details.
10184
+ * Get the current virtual controller behavior - please see the setter [setVirtualControllerBehavior](setVirtualControllerBehavior) and the enum for details.
8893
10185
  * @summary Get Behavior
8894
10186
  * @param {string} cell Unique identifier addressing a cell in all API calls.
8895
10187
  * @param {string} controller Unique identifier to address a controller in the cell.
8896
10188
  * @param {*} [options] Override http request option.
8897
10189
  * @throws {RequiredError}
8898
10190
  */
8899
- getVirtualRobotBehavior(cell: string, controller: string, options?: RawAxiosRequestConfig): AxiosPromise<Behavior>;
10191
+ getVirtualControllerBehavior(cell: string, controller: string, options?: RawAxiosRequestConfig): AxiosPromise<Behavior>;
8900
10192
  /**
8901
10193
  * Set virtual controller behavior.
8902
10194
  * @summary Set Behavior
@@ -8906,7 +10198,7 @@ export declare const VirtualControllerBehaviorApiFactory: (configuration?: Confi
8906
10198
  * @param {*} [options] Override http request option.
8907
10199
  * @throws {RequiredError}
8908
10200
  */
8909
- setVirtualRobotBehavior(cell: string, controller: string, behavior?: Behavior, options?: RawAxiosRequestConfig): AxiosPromise<void>;
10201
+ setVirtualControllerBehavior(cell: string, controller: string, behavior?: Behavior, options?: RawAxiosRequestConfig): AxiosPromise<void>;
8910
10202
  };
8911
10203
  /**
8912
10204
  * VirtualControllerBehaviorApi - object-oriented interface
@@ -8937,7 +10229,7 @@ export declare class VirtualControllerBehaviorApi extends BaseAPI {
8937
10229
  */
8938
10230
  getCycleTime(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CycleTime, any>>;
8939
10231
  /**
8940
- * Get the current virtual controller behavior - please see the setter [setVirtualRobotBehavior](setVirtualRobotBehavior) and the enum for details.
10232
+ * Get the current virtual controller behavior - please see the setter [setVirtualControllerBehavior](setVirtualControllerBehavior) and the enum for details.
8941
10233
  * @summary Get Behavior
8942
10234
  * @param {string} cell Unique identifier addressing a cell in all API calls.
8943
10235
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -8945,7 +10237,7 @@ export declare class VirtualControllerBehaviorApi extends BaseAPI {
8945
10237
  * @throws {RequiredError}
8946
10238
  * @memberof VirtualControllerBehaviorApi
8947
10239
  */
8948
- getVirtualRobotBehavior(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Behavior, any>>;
10240
+ getVirtualControllerBehavior(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Behavior, any>>;
8949
10241
  /**
8950
10242
  * Set virtual controller behavior.
8951
10243
  * @summary Set Behavior
@@ -8956,7 +10248,7 @@ export declare class VirtualControllerBehaviorApi extends BaseAPI {
8956
10248
  * @throws {RequiredError}
8957
10249
  * @memberof VirtualControllerBehaviorApi
8958
10250
  */
8959
- setVirtualRobotBehavior(cell: string, controller: string, behavior?: Behavior, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
10251
+ setVirtualControllerBehavior(cell: string, controller: string, behavior?: Behavior, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
8960
10252
  }
8961
10253
  /**
8962
10254
  * VirtualControllerInputsOutputsApi - axios parameter creator
@@ -8964,7 +10256,7 @@ export declare class VirtualControllerBehaviorApi extends BaseAPI {
8964
10256
  */
8965
10257
  export declare const VirtualControllerInputsOutputsApiAxiosParamCreator: (configuration?: Configuration) => {
8966
10258
  /**
8967
- * Retrieves the current values of inputs/outputs of the virtual controller. The identifiers of inputs/outputs must be provided in the request. Request all available input/output identifiers via [listVirtualRobotIODescriptions](listVirtualRobotIODescriptions).
10259
+ * Retrieves the current values of inputs/outputs of the virtual controller. The identifiers of inputs/outputs must be provided in the request. Request all available input/output identifiers via [listVirtualControllerIODescriptions](listVirtualControllerIODescriptions).
8968
10260
  * @summary Get Input/Output Values
8969
10261
  * @param {string} cell Unique identifier addressing a cell in all API calls.
8970
10262
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -8985,7 +10277,7 @@ export declare const VirtualControllerInputsOutputsApiAxiosParamCreator: (config
8985
10277
  * @param {*} [options] Override http request option.
8986
10278
  * @throws {RequiredError}
8987
10279
  */
8988
- listVirtualRobotIODescriptions: (cell: string, controller: string, ios?: Array<string>, direction?: IODirection, valueType?: IOValueType, group?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
10280
+ listVirtualControllerIODescriptions: (cell: string, controller: string, ios?: Array<string>, direction?: IODirection, valueType?: IOValueType, group?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
8989
10281
  /**
8990
10282
  * Sets a list of values of a virtual controller inputs/outputs.
8991
10283
  * @summary Set Input/Ouput Values
@@ -9003,7 +10295,7 @@ export declare const VirtualControllerInputsOutputsApiAxiosParamCreator: (config
9003
10295
  */
9004
10296
  export declare const VirtualControllerInputsOutputsApiFp: (configuration?: Configuration) => {
9005
10297
  /**
9006
- * Retrieves the current values of inputs/outputs of the virtual controller. The identifiers of inputs/outputs must be provided in the request. Request all available input/output identifiers via [listVirtualRobotIODescriptions](listVirtualRobotIODescriptions).
10298
+ * Retrieves the current values of inputs/outputs of the virtual controller. The identifiers of inputs/outputs must be provided in the request. Request all available input/output identifiers via [listVirtualControllerIODescriptions](listVirtualControllerIODescriptions).
9007
10299
  * @summary Get Input/Output Values
9008
10300
  * @param {string} cell Unique identifier addressing a cell in all API calls.
9009
10301
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -9024,7 +10316,7 @@ export declare const VirtualControllerInputsOutputsApiFp: (configuration?: Confi
9024
10316
  * @param {*} [options] Override http request option.
9025
10317
  * @throws {RequiredError}
9026
10318
  */
9027
- listVirtualRobotIODescriptions(cell: string, controller: string, ios?: Array<string>, direction?: IODirection, valueType?: IOValueType, group?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<IODescription>>>;
10319
+ listVirtualControllerIODescriptions(cell: string, controller: string, ios?: Array<string>, direction?: IODirection, valueType?: IOValueType, group?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<IODescription>>>;
9028
10320
  /**
9029
10321
  * Sets a list of values of a virtual controller inputs/outputs.
9030
10322
  * @summary Set Input/Ouput Values
@@ -9042,7 +10334,7 @@ export declare const VirtualControllerInputsOutputsApiFp: (configuration?: Confi
9042
10334
  */
9043
10335
  export declare const VirtualControllerInputsOutputsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
9044
10336
  /**
9045
- * Retrieves the current values of inputs/outputs of the virtual controller. The identifiers of inputs/outputs must be provided in the request. Request all available input/output identifiers via [listVirtualRobotIODescriptions](listVirtualRobotIODescriptions).
10337
+ * Retrieves the current values of inputs/outputs of the virtual controller. The identifiers of inputs/outputs must be provided in the request. Request all available input/output identifiers via [listVirtualControllerIODescriptions](listVirtualControllerIODescriptions).
9046
10338
  * @summary Get Input/Output Values
9047
10339
  * @param {string} cell Unique identifier addressing a cell in all API calls.
9048
10340
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -9063,7 +10355,7 @@ export declare const VirtualControllerInputsOutputsApiFactory: (configuration?:
9063
10355
  * @param {*} [options] Override http request option.
9064
10356
  * @throws {RequiredError}
9065
10357
  */
9066
- listVirtualRobotIODescriptions(cell: string, controller: string, ios?: Array<string>, direction?: IODirection, valueType?: IOValueType, group?: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<IODescription>>;
10358
+ listVirtualControllerIODescriptions(cell: string, controller: string, ios?: Array<string>, direction?: IODirection, valueType?: IOValueType, group?: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<IODescription>>;
9067
10359
  /**
9068
10360
  * Sets a list of values of a virtual controller inputs/outputs.
9069
10361
  * @summary Set Input/Ouput Values
@@ -9083,7 +10375,7 @@ export declare const VirtualControllerInputsOutputsApiFactory: (configuration?:
9083
10375
  */
9084
10376
  export declare class VirtualControllerInputsOutputsApi extends BaseAPI {
9085
10377
  /**
9086
- * Retrieves the current values of inputs/outputs of the virtual controller. The identifiers of inputs/outputs must be provided in the request. Request all available input/output identifiers via [listVirtualRobotIODescriptions](listVirtualRobotIODescriptions).
10378
+ * Retrieves the current values of inputs/outputs of the virtual controller. The identifiers of inputs/outputs must be provided in the request. Request all available input/output identifiers via [listVirtualControllerIODescriptions](listVirtualControllerIODescriptions).
9087
10379
  * @summary Get Input/Output Values
9088
10380
  * @param {string} cell Unique identifier addressing a cell in all API calls.
9089
10381
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -9106,7 +10398,7 @@ export declare class VirtualControllerInputsOutputsApi extends BaseAPI {
9106
10398
  * @throws {RequiredError}
9107
10399
  * @memberof VirtualControllerInputsOutputsApi
9108
10400
  */
9109
- listVirtualRobotIODescriptions(cell: string, controller: string, ios?: Array<string>, direction?: IODirection, valueType?: IOValueType, group?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<IODescription[], any>>;
10401
+ listVirtualControllerIODescriptions(cell: string, controller: string, ios?: Array<string>, direction?: IODirection, valueType?: IOValueType, group?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<IODescription[], any>>;
9110
10402
  /**
9111
10403
  * Sets a list of values of a virtual controller inputs/outputs.
9112
10404
  * @summary Set Input/Ouput Values