@wandelbots/nova-api 25.7.0-dev.9 → 25.8.0-dev.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/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,22 +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";
1244
+ };
1245
+ export type ErrorInvalidJointCountErrorFeedbackNameEnum = typeof ErrorInvalidJointCountErrorFeedbackNameEnum[keyof typeof ErrorInvalidJointCountErrorFeedbackNameEnum];
1246
+ /**
1247
+ * A reference joint position (start or target) exceeds the configured joint limits.
1248
+ * @export
1249
+ * @interface ErrorJointLimitExceeded
1250
+ */
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>;
1264
+ /**
1265
+ *
1266
+ * @type {string}
1267
+ * @memberof ErrorJointLimitExceeded
1268
+ */
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";
1119
1302
  };
1120
- export type EndOfTrajectoryKindEnum = typeof EndOfTrajectoryKindEnum[keyof typeof EndOfTrajectoryKindEnum];
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;
1322
+ }
1323
+ export declare const ErrorMaxIterationsExceededErrorFeedbackNameEnum: {
1324
+ readonly ErrorMaxIterationsExceeded: "ErrorMaxIterationsExceeded";
1325
+ };
1326
+ export type ErrorMaxIterationsExceededErrorFeedbackNameEnum = typeof ErrorMaxIterationsExceededErrorFeedbackNameEnum[keyof typeof ErrorMaxIterationsExceededErrorFeedbackNameEnum];
1121
1327
  /**
1122
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.
1123
1329
  * @export
@@ -1376,58 +1582,141 @@ export type FloatValueValueTypeEnum = typeof FloatValueValueTypeEnum[keyof typeo
1376
1582
  /**
1377
1583
  *
1378
1584
  * @export
1379
- * @interface GetModeResponse
1585
+ * @interface ForwardKinematics422Response
1380
1586
  */
1381
- export interface GetModeResponse {
1587
+ export interface ForwardKinematics422Response {
1382
1588
  /**
1383
1589
  *
1384
- * @type {RobotSystemMode}
1385
- * @memberof GetModeResponse
1590
+ * @type {Array<ForwardKinematicsValidationError>}
1591
+ * @memberof ForwardKinematics422Response
1386
1592
  */
1387
- 'robot_system_mode': RobotSystemMode;
1593
+ 'detail'?: Array<ForwardKinematicsValidationError>;
1388
1594
  }
1389
1595
  /**
1390
1596
  *
1391
1597
  * @export
1392
- * @interface GetTrajectoryResponse
1598
+ * @interface ForwardKinematicsRequest
1393
1599
  */
1394
- export interface GetTrajectoryResponse {
1600
+ export interface ForwardKinematicsRequest {
1395
1601
  /**
1396
- * Unique identifier of the motion group the trajectory is planned for.
1602
+ * String identifiying the model of a motion group.
1397
1603
  * @type {string}
1398
- * @memberof GetTrajectoryResponse
1604
+ * @memberof ForwardKinematicsRequest
1399
1605
  */
1400
- 'motion_group': string;
1606
+ 'motion_group_model': string;
1401
1607
  /**
1402
- * The trajectory consisting of a list of joint positions and an equal number of corresponding timestamps.
1403
- * @type {JointTrajectory}
1404
- * @memberof GetTrajectoryResponse
1608
+ * List of joint positions [rad] for which TCP poses are computed.
1609
+ * @type {Array<Array<number>>}
1610
+ * @memberof ForwardKinematicsRequest
1405
1611
  */
1406
- 'trajectory': JointTrajectory;
1612
+ 'joint_positions': Array<Array<number>>;
1407
1613
  /**
1408
- * Unique identifier of the tool the trajectory is planned for.
1409
- * @type {string}
1410
- * @memberof GetTrajectoryResponse
1614
+ *
1615
+ * @type {Pose}
1616
+ * @memberof ForwardKinematicsRequest
1411
1617
  */
1412
- '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;
1413
1625
  }
1414
1626
  /**
1415
1627
  *
1416
1628
  * @export
1417
- * @interface HTTPValidationError
1629
+ * @interface ForwardKinematicsResponse
1418
1630
  */
1419
- export interface HTTPValidationError {
1631
+ export interface ForwardKinematicsResponse {
1420
1632
  /**
1421
- *
1422
- * @type {Array<ValidationError>}
1423
- * @memberof HTTPValidationError
1633
+ * List of computed TCP poses corresponding to the input joint positions.
1634
+ * @type {Array<Pose>}
1635
+ * @memberof ForwardKinematicsResponse
1424
1636
  */
1425
- 'detail'?: Array<ValidationError>;
1637
+ 'tcp_poses': Array<Pose>;
1426
1638
  }
1427
1639
  /**
1428
- * Input/Output boolean value representation.
1640
+ *
1429
1641
  * @export
1430
- * @interface IOBooleanValue
1642
+ * @interface ForwardKinematicsValidationError
1643
+ */
1644
+ export interface ForwardKinematicsValidationError {
1645
+ /**
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
1431
1720
  */
1432
1721
  export interface IOBooleanValue {
1433
1722
  /**
@@ -1877,6 +2166,19 @@ export interface InvalidDofInvalidDof {
1877
2166
  */
1878
2167
  'joint_position'?: Array<number>;
1879
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
+ }
1880
2182
  /**
1881
2183
  *
1882
2184
  * @export
@@ -1914,12 +2216,12 @@ export interface InverseKinematicsRequest {
1914
2216
  */
1915
2217
  'joint_position_limits'?: Array<LimitRange>;
1916
2218
  /**
1917
- * 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.
1918
- * @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; }}
1919
2221
  * @memberof InverseKinematicsRequest
1920
2222
  */
1921
- 'collision_scenes'?: {
1922
- [key: string]: SingleMotionGroupCollisionScene;
2223
+ 'collision_setups'?: {
2224
+ [key: string]: CollisionSetup;
1923
2225
  };
1924
2226
  }
1925
2227
  /**
@@ -1935,6 +2237,55 @@ export interface InverseKinematicsResponse {
1935
2237
  */
1936
2238
  'joints': Array<Array<Array<number>>>;
1937
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;
1938
2289
  /**
1939
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.
1940
2291
  * @export
@@ -1962,7 +2313,104 @@ export type JoggingDetailsKindEnum = typeof JoggingDetailsKindEnum[keyof typeof
1962
2313
  * @type JoggingDetailsState
1963
2314
  * @export
1964
2315
  */
1965
- 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];
1966
2414
  /**
1967
2415
  *
1968
2416
  * @export
@@ -2015,10 +2463,10 @@ export interface JointLimits {
2015
2463
  export interface JointTrajectory {
2016
2464
  /**
2017
2465
  * List of joint positions [rad] for each sample. The number of samples must match the number of timestamps provided in the times field.
2018
- * @type {Array<Joints>}
2466
+ * @type {Array<Array<number>>}
2019
2467
  * @memberof JointTrajectory
2020
2468
  */
2021
- 'joint_positions': Array<Joints>;
2469
+ 'joint_positions': Array<Array<number>>;
2022
2470
  /**
2023
2471
  * Timestamp for each sample [s].
2024
2472
  * @type {Array<number>}
@@ -2045,11 +2493,11 @@ export interface JointVelocityRequest {
2045
2493
  */
2046
2494
  'message_type'?: JointVelocityRequestMessageTypeEnum;
2047
2495
  /**
2048
- * in [rad/s]
2049
- * @type {Joints}
2496
+ * This structure describes a set of joint values (e.g. positions, currents, torques) of a motion group. Float precision is the default.
2497
+ * @type {Array<number>}
2050
2498
  * @memberof JointVelocityRequest
2051
2499
  */
2052
- 'velocity': Joints;
2500
+ 'velocity': Array<number>;
2053
2501
  }
2054
2502
  export declare const JointVelocityRequestMessageTypeEnum: {
2055
2503
  readonly JointVelocityRequest: "JointVelocityRequest";
@@ -2078,19 +2526,6 @@ export declare const JointVelocityResponseKindEnum: {
2078
2526
  readonly JointVelocityReceived: "JOINT_VELOCITY_RECEIVED";
2079
2527
  };
2080
2528
  export type JointVelocityResponseKindEnum = typeof JointVelocityResponseKindEnum[keyof typeof JointVelocityResponseKindEnum];
2081
- /**
2082
- * This structure describes a set of joint values of a motion group. We call a set of joint values describing the current position in joint space of a motion group a \"joint position\". Joint position was chosen as the term to be consistent with the terms \"joint velocity\" and \"joint acceleration\". `joints` must have as many entries as the motion group\'s degrees of freedom to be valid. Float precision is the default.
2083
- * @export
2084
- * @interface Joints
2085
- */
2086
- export interface Joints {
2087
- /**
2088
- *
2089
- * @type {Array<number>}
2090
- * @memberof Joints
2091
- */
2092
- 'joints': Array<number>;
2093
- }
2094
2529
  /**
2095
2530
  * The configuration of a physical KUKA robot controller has to contain an IP address. Additionally an RSI server configuration has to be specified in order to control the robot. Deploying the server is a functionality of this API.
2096
2531
  * @export
@@ -2384,6 +2819,29 @@ export declare const Manufacturer: {
2384
2819
  readonly Yaskawa: "yaskawa";
2385
2820
  };
2386
2821
  export type Manufacturer = typeof Manufacturer[keyof typeof Manufacturer];
2822
+ /**
2823
+ * 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.
2824
+ * @export
2825
+ * @interface MidpointInsertionAlgorithm
2826
+ */
2827
+ export interface MidpointInsertionAlgorithm {
2828
+ /**
2829
+ * Algorithm discriminator.
2830
+ * @type {string}
2831
+ * @memberof MidpointInsertionAlgorithm
2832
+ */
2833
+ 'algorithm_name': MidpointInsertionAlgorithmAlgorithmNameEnum;
2834
+ /**
2835
+ * Maximum number of iterations for the midpoint insertion algorithm. Higher values increase likelyhood of success, but also computation time (linear).
2836
+ * @type {number}
2837
+ * @memberof MidpointInsertionAlgorithm
2838
+ */
2839
+ 'max_iterations'?: number;
2840
+ }
2841
+ export declare const MidpointInsertionAlgorithmAlgorithmNameEnum: {
2842
+ readonly MidpointInsertionAlgorithm: "MidpointInsertionAlgorithm";
2843
+ };
2844
+ export type MidpointInsertionAlgorithmAlgorithmNameEnum = typeof MidpointInsertionAlgorithmAlgorithmNameEnum[keyof typeof MidpointInsertionAlgorithmAlgorithmNameEnum];
2387
2845
  /**
2388
2846
  *
2389
2847
  * @export
@@ -2574,6 +3032,57 @@ export interface MotionGroupJoints {
2574
3032
  */
2575
3033
  'torques'?: Array<number>;
2576
3034
  }
3035
+ /**
3036
+ *
3037
+ * @export
3038
+ * @interface MotionGroupSetup
3039
+ */
3040
+ export interface MotionGroupSetup {
3041
+ /**
3042
+ * String identifiying the model of a motion group.
3043
+ * @type {string}
3044
+ * @memberof MotionGroupSetup
3045
+ */
3046
+ 'motion_group_model': string;
3047
+ /**
3048
+ * [ms] cycle time of the motion group controller. A trajectory for this motion group should be computed to this resolution.
3049
+ * @type {number}
3050
+ * @memberof MotionGroupSetup
3051
+ */
3052
+ 'cycle_time': number;
3053
+ /**
3054
+ * The offset from the world frame to the motion group base.
3055
+ * @type {Pose}
3056
+ * @memberof MotionGroupSetup
3057
+ */
3058
+ 'mounting'?: Pose;
3059
+ /**
3060
+ *
3061
+ * @type {Pose}
3062
+ * @memberof MotionGroupSetup
3063
+ */
3064
+ 'tcp_offset'?: Pose;
3065
+ /**
3066
+ *
3067
+ * @type {LimitSet}
3068
+ * @memberof MotionGroupSetup
3069
+ */
3070
+ 'global_limits'?: LimitSet;
3071
+ /**
3072
+ *
3073
+ * @type {Payload}
3074
+ * @memberof MotionGroupSetup
3075
+ */
3076
+ 'payload'?: Payload;
3077
+ /**
3078
+ * 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.
3079
+ * @type {{ [key: string]: CollisionSetup; }}
3080
+ * @memberof MotionGroupSetup
3081
+ */
3082
+ 'collision_setups'?: {
3083
+ [key: string]: CollisionSetup;
3084
+ };
3085
+ }
2577
3086
  /**
2578
3087
  * Presents the current state of the motion group.
2579
3088
  * @export
@@ -2605,11 +3114,11 @@ export interface MotionGroupState {
2605
3114
  */
2606
3115
  'controller': string;
2607
3116
  /**
2608
- * Current joint position of each joint in [rad]
2609
- * @type {Joints}
3117
+ * This structure describes a set of joint values (e.g. positions, currents, torques) of a motion group. Float precision is the default.
3118
+ * @type {Array<number>}
2610
3119
  * @memberof MotionGroupState
2611
3120
  */
2612
- 'joint_position': Joints;
3121
+ 'joint_position': Array<number>;
2613
3122
  /**
2614
3123
  * Indicates whether the joint is in a limit for all joints of the motion group.
2615
3124
  * @type {MotionGroupStateJointLimitReached}
@@ -2617,17 +3126,17 @@ export interface MotionGroupState {
2617
3126
  */
2618
3127
  'joint_limit_reached': MotionGroupStateJointLimitReached;
2619
3128
  /**
2620
- * Current joint torque of each joint in [Nm]. Is only available if the robot controller supports it, e.g. available for UR controllers.
2621
- * @type {Joints}
3129
+ * This structure describes a set of joint values (e.g. positions, currents, torques) of a motion group. Float precision is the default.
3130
+ * @type {Array<number>}
2622
3131
  * @memberof MotionGroupState
2623
3132
  */
2624
- 'joint_torque'?: Joints;
3133
+ 'joint_torque'?: Array<number>;
2625
3134
  /**
2626
- * Current at TCP in [A]. Is only available if the robot controller supports it, e.g. available for UR controllers.
2627
- * @type {Joints}
3135
+ * This structure describes a set of joint values (e.g. positions, currents, torques) of a motion group. Float precision is the default.
3136
+ * @type {Array<number>}
2628
3137
  * @memberof MotionGroupState
2629
3138
  */
2630
- 'joint_current'?: Joints;
3139
+ 'joint_current'?: Array<number>;
2631
3140
  /**
2632
3141
  * Pose of the flange. Positions are in [mm]. Oriantations are in [rad]. The pose is relative to the response_coordinate_system specified in the request. For robot arms a flange pose is always returned, for positioners the flange might not be available, depending on the model.
2633
3142
  * @type {Pose}
@@ -3062,131 +3571,109 @@ export interface PauseOnIO {
3062
3571
  /**
3063
3572
  *
3064
3573
  * @export
3065
- * @interface PausedByRequest
3574
+ * @interface Payload
3066
3575
  */
3067
- export interface PausedByRequest {
3576
+ export interface Payload {
3068
3577
  /**
3069
3578
  *
3070
3579
  * @type {string}
3071
- * @memberof PausedByRequest
3580
+ * @memberof Payload
3581
+ */
3582
+ 'name': string;
3583
+ /**
3584
+ * Mass of payload in [kg].
3585
+ * @type {number}
3586
+ * @memberof Payload
3587
+ */
3588
+ 'payload': number;
3589
+ /**
3590
+ * A three-dimensional vector [x, y, z] with double precision.
3591
+ * @type {Array<number>}
3592
+ * @memberof Payload
3593
+ */
3594
+ 'center_of_mass'?: Array<number>;
3595
+ /**
3596
+ * A three-dimensional vector [x, y, z] with double precision.
3597
+ * @type {Array<number>}
3598
+ * @memberof Payload
3072
3599
  */
3073
- 'kind': PausedByRequestKindEnum;
3600
+ 'moment_of_inertia'?: Array<number>;
3074
3601
  }
3075
- export declare const PausedByRequestKindEnum: {
3076
- readonly PausedByUser: "PAUSED_BY_USER";
3077
- };
3078
- export type PausedByRequestKindEnum = typeof PausedByRequestKindEnum[keyof typeof PausedByRequestKindEnum];
3079
3602
  /**
3080
3603
  *
3081
3604
  * @export
3082
- * @interface PausedByUser
3605
+ * @interface Plan422Response
3083
3606
  */
3084
- export interface PausedByUser {
3607
+ export interface Plan422Response {
3085
3608
  /**
3086
3609
  *
3087
- * @type {string}
3088
- * @memberof PausedByUser
3610
+ * @type {Array<PlanValidationError>}
3611
+ * @memberof Plan422Response
3089
3612
  */
3090
- 'kind': PausedByUserKindEnum;
3613
+ 'detail'?: Array<PlanValidationError>;
3091
3614
  }
3092
- export declare const PausedByUserKindEnum: {
3093
- readonly PausedByUser: "PAUSED_BY_USER";
3094
- };
3095
- export type PausedByUserKindEnum = typeof PausedByUserKindEnum[keyof typeof PausedByUserKindEnum];
3096
3615
  /**
3097
- *
3616
+ * Response when collision-free trajectory planning fails. Contains specific feedback about why the planning failed.
3098
3617
  * @export
3099
- * @interface PausedNearCollision
3618
+ * @interface PlanCollisionFreeFailedResponse
3100
3619
  */
3101
- export interface PausedNearCollision {
3102
- /**
3103
- *
3104
- * @type {string}
3105
- * @memberof PausedNearCollision
3106
- */
3107
- 'kind': PausedNearCollisionKindEnum;
3620
+ export interface PlanCollisionFreeFailedResponse {
3108
3621
  /**
3109
3622
  *
3110
- * @type {string}
3111
- * @memberof PausedNearCollision
3623
+ * @type {ErrorMaxIterationsExceeded}
3624
+ * @memberof PlanCollisionFreeFailedResponse
3112
3625
  */
3113
- 'description': string;
3626
+ 'error_feedback': ErrorMaxIterationsExceeded;
3114
3627
  }
3115
- export declare const PausedNearCollisionKindEnum: {
3116
- readonly PausedNearCollision: "PAUSED_NEAR_COLLISION";
3117
- };
3118
- export type PausedNearCollisionKindEnum = typeof PausedNearCollisionKindEnum[keyof typeof PausedNearCollisionKindEnum];
3119
3628
  /**
3120
3629
  *
3121
3630
  * @export
3122
- * @interface PausedNearJointLimit
3631
+ * @interface PlanCollisionFreeRequest
3123
3632
  */
3124
- export interface PausedNearJointLimit {
3633
+ export interface PlanCollisionFreeRequest {
3634
+ /**
3635
+ * The data to assemble the robot setup can be retrieved from [getMotionGroupDescription](getMotionGroupDescription) endpoint.
3636
+ * @type {MotionGroupSetup}
3637
+ * @memberof PlanCollisionFreeRequest
3638
+ */
3639
+ 'motion_group_setup': MotionGroupSetup;
3125
3640
  /**
3126
3641
  *
3127
- * @type {string}
3128
- * @memberof PausedNearJointLimit
3642
+ * @type {Array<number>}
3643
+ * @memberof PlanCollisionFreeRequest
3129
3644
  */
3130
- 'kind': PausedNearJointLimitKindEnum;
3645
+ 'start_joint_position': Array<number>;
3131
3646
  /**
3132
3647
  *
3133
3648
  * @type {Array<number>}
3134
- * @memberof PausedNearJointLimit
3649
+ * @memberof PlanCollisionFreeRequest
3135
3650
  */
3136
- 'joint_indices': Array<number>;
3137
- }
3138
- export declare const PausedNearJointLimitKindEnum: {
3139
- readonly PausedNearJointLimit: "PAUSED_NEAR_JOINT_LIMIT";
3140
- };
3141
- export type PausedNearJointLimitKindEnum = typeof PausedNearJointLimitKindEnum[keyof typeof PausedNearJointLimitKindEnum];
3142
- /**
3143
- *
3144
- * @export
3145
- * @interface PausedOnIO
3146
- */
3147
- export interface PausedOnIO {
3651
+ 'target': Array<number>;
3148
3652
  /**
3149
3653
  *
3150
- * @type {string}
3151
- * @memberof PausedOnIO
3654
+ * @type {CollisionFreeAlgorithm}
3655
+ * @memberof PlanCollisionFreeRequest
3152
3656
  */
3153
- 'kind': PausedOnIOKindEnum;
3657
+ 'algorithm': CollisionFreeAlgorithm;
3154
3658
  }
3155
- export declare const PausedOnIOKindEnum: {
3156
- readonly PausedOnIo: "PAUSED_ON_IO";
3157
- };
3158
- export type PausedOnIOKindEnum = typeof PausedOnIOKindEnum[keyof typeof PausedOnIOKindEnum];
3159
3659
  /**
3160
- *
3660
+ * Response from collision-free trajectory planning. Contains either a successful joint trajectory or failure information.
3161
3661
  * @export
3162
- * @interface Payload
3662
+ * @interface PlanCollisionFreeResponse
3163
3663
  */
3164
- export interface Payload {
3664
+ export interface PlanCollisionFreeResponse {
3165
3665
  /**
3166
3666
  *
3167
- * @type {string}
3168
- * @memberof Payload
3169
- */
3170
- 'name': string;
3171
- /**
3172
- * Mass of payload in [kg].
3173
- * @type {number}
3174
- * @memberof Payload
3175
- */
3176
- 'payload': number;
3177
- /**
3178
- * A three-dimensional vector [x, y, z] with double precision.
3179
- * @type {Array<number>}
3180
- * @memberof Payload
3181
- */
3182
- 'center_of_mass'?: Array<number>;
3183
- /**
3184
- * A three-dimensional vector [x, y, z] with double precision.
3185
- * @type {Array<number>}
3186
- * @memberof Payload
3667
+ * @type {PlanCollisionFreeResponseResponse}
3668
+ * @memberof PlanCollisionFreeResponse
3187
3669
  */
3188
- 'moment_of_inertia'?: Array<number>;
3670
+ 'response': PlanCollisionFreeResponseResponse;
3189
3671
  }
3672
+ /**
3673
+ * @type PlanCollisionFreeResponseResponse
3674
+ * @export
3675
+ */
3676
+ export type PlanCollisionFreeResponseResponse = JointTrajectory | PlanCollisionFreeFailedResponse;
3190
3677
  /**
3191
3678
  *
3192
3679
  * @export
@@ -3225,10 +3712,10 @@ export type PlanTrajectoryFailedResponseErrorFeedback = FeedbackCollision | Feed
3225
3712
  export interface PlanTrajectoryRequest {
3226
3713
  /**
3227
3714
  * The data to assemble the robot setup can be retrieved from [getMotionGroupDescription](getMotionGroupDescription) endpoint.
3228
- * @type {RobotSetup}
3715
+ * @type {MotionGroupSetup}
3229
3716
  * @memberof PlanTrajectoryRequest
3230
3717
  */
3231
- 'robot_setup': RobotSetup;
3718
+ 'motion_group_setup': MotionGroupSetup;
3232
3719
  /**
3233
3720
  *
3234
3721
  * @type {Array<number>}
@@ -3260,6 +3747,57 @@ export interface PlanTrajectoryResponse {
3260
3747
  * @export
3261
3748
  */
3262
3749
  export type PlanTrajectoryResponseResponse = JointTrajectory | PlanTrajectoryFailedResponse;
3750
+ /**
3751
+ *
3752
+ * @export
3753
+ * @interface PlanValidationError
3754
+ */
3755
+ export interface PlanValidationError {
3756
+ /**
3757
+ *
3758
+ * @type {Array<ValidationErrorLocInner>}
3759
+ * @memberof PlanValidationError
3760
+ */
3761
+ 'loc': Array<ValidationErrorLocInner>;
3762
+ /**
3763
+ *
3764
+ * @type {string}
3765
+ * @memberof PlanValidationError
3766
+ */
3767
+ 'msg': string;
3768
+ /**
3769
+ *
3770
+ * @type {string}
3771
+ * @memberof PlanValidationError
3772
+ */
3773
+ 'type': string;
3774
+ /**
3775
+ *
3776
+ * @type {{ [key: string]: any; }}
3777
+ * @memberof PlanValidationError
3778
+ */
3779
+ 'input': {
3780
+ [key: string]: any;
3781
+ };
3782
+ /**
3783
+ *
3784
+ * @type {PlanValidationErrorAllOfData}
3785
+ * @memberof PlanValidationError
3786
+ */
3787
+ 'data'?: PlanValidationErrorAllOfData;
3788
+ }
3789
+ /**
3790
+ * @type PlanValidationErrorAllOfData
3791
+ * Optional data further specifying the validation error.
3792
+ * @export
3793
+ */
3794
+ export type PlanValidationErrorAllOfData = {
3795
+ error_feedback_name: 'ErrorInvalidJointCount';
3796
+ } & ErrorInvalidJointCount | {
3797
+ error_feedback_name: 'ErrorJointLimitExceeded';
3798
+ } & ErrorJointLimitExceeded | {
3799
+ error_feedback_name: 'ErrorJointPositionCollision';
3800
+ } & ErrorJointPositionCollision;
3263
3801
  /**
3264
3802
  * Defines an x/y-plane with infinite size.
3265
3803
  * @export
@@ -3342,6 +3880,250 @@ export interface Pose {
3342
3880
  */
3343
3881
  'orientation'?: Array<number>;
3344
3882
  }
3883
+ /**
3884
+ *
3885
+ * @export
3886
+ * @interface ProfinetDescription
3887
+ */
3888
+ export interface ProfinetDescription {
3889
+ /**
3890
+ * The vendor identifier of the PROFINET device, identifying the manufacturer.
3891
+ * @type {string}
3892
+ * @memberof ProfinetDescription
3893
+ */
3894
+ 'vendor_id': string;
3895
+ /**
3896
+ * The device identifier of the PROFINET device, identifying the specific device within the vendor\'s range.
3897
+ * @type {string}
3898
+ * @memberof ProfinetDescription
3899
+ */
3900
+ 'device_id': string;
3901
+ /**
3902
+ *
3903
+ * @type {Array<ProfinetSlotDescription>}
3904
+ * @memberof ProfinetDescription
3905
+ */
3906
+ 'slots'?: Array<ProfinetSlotDescription>;
3907
+ /**
3908
+ * Name of the PROFINET device
3909
+ * @type {string}
3910
+ * @memberof ProfinetDescription
3911
+ */
3912
+ 'device_name'?: string;
3913
+ /**
3914
+ * IP address for the PROFINET device
3915
+ * @type {string}
3916
+ * @memberof ProfinetDescription
3917
+ */
3918
+ 'ip'?: string;
3919
+ }
3920
+ /**
3921
+ *
3922
+ * @export
3923
+ * @interface ProfinetIO
3924
+ */
3925
+ export interface ProfinetIO {
3926
+ /**
3927
+ * 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.
3928
+ * @type {string}
3929
+ * @memberof ProfinetIO
3930
+ */
3931
+ 'name': string;
3932
+ /**
3933
+ *
3934
+ * @type {ProfinetIOTypeEnum}
3935
+ * @memberof ProfinetIO
3936
+ */
3937
+ 'type': ProfinetIOTypeEnum;
3938
+ /**
3939
+ * The direction of the input/output value, indicating whether it is an input or output for the device.
3940
+ * @type {ProfinetIODirection}
3941
+ * @memberof ProfinetIO
3942
+ */
3943
+ 'direction': ProfinetIODirection;
3944
+ /**
3945
+ * 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.
3946
+ * @type {number}
3947
+ * @memberof ProfinetIO
3948
+ */
3949
+ 'byte_address': number;
3950
+ /**
3951
+ * 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.
3952
+ * @type {number}
3953
+ * @memberof ProfinetIO
3954
+ */
3955
+ 'bit_address'?: number;
3956
+ /**
3957
+ * The unique identifier for the input/output value. This identifier is used to reference the specific input/output in the NOVA system.
3958
+ * @type {string}
3959
+ * @memberof ProfinetIO
3960
+ */
3961
+ 'io': string;
3962
+ }
3963
+ /**
3964
+ *
3965
+ * @export
3966
+ * @interface ProfinetIOData
3967
+ */
3968
+ export interface ProfinetIOData {
3969
+ /**
3970
+ * 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.
3971
+ * @type {string}
3972
+ * @memberof ProfinetIOData
3973
+ */
3974
+ 'name': string;
3975
+ /**
3976
+ *
3977
+ * @type {ProfinetIOTypeEnum}
3978
+ * @memberof ProfinetIOData
3979
+ */
3980
+ 'type': ProfinetIOTypeEnum;
3981
+ /**
3982
+ * The direction of the input/output value, indicating whether it is an input or output for the device.
3983
+ * @type {ProfinetIODirection}
3984
+ * @memberof ProfinetIOData
3985
+ */
3986
+ 'direction': ProfinetIODirection;
3987
+ /**
3988
+ * 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.
3989
+ * @type {number}
3990
+ * @memberof ProfinetIOData
3991
+ */
3992
+ 'byte_address': number;
3993
+ /**
3994
+ * 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.
3995
+ * @type {number}
3996
+ * @memberof ProfinetIOData
3997
+ */
3998
+ 'bit_address'?: number;
3999
+ }
4000
+ /**
4001
+ * Identifies the input/output type.
4002
+ * @export
4003
+ * @enum {string}
4004
+ */
4005
+ export declare const ProfinetIODirection: {
4006
+ readonly ProfinetIoDirectionInput: "PROFINET_IO_DIRECTION_INPUT";
4007
+ readonly ProfinetIoDirectionOutput: "PROFINET_IO_DIRECTION_OUTPUT";
4008
+ readonly ProfinetIoDirectionInout: "PROFINET_IO_DIRECTION_INOUT";
4009
+ };
4010
+ export type ProfinetIODirection = typeof ProfinetIODirection[keyof typeof ProfinetIODirection];
4011
+ /**
4012
+ * Value type of the PROFINET input/output.
4013
+ * @export
4014
+ * @enum {string}
4015
+ */
4016
+ export declare const ProfinetIOTypeEnum: {
4017
+ readonly ProfinetIoTypeUnknown: "PROFINET_IO_TYPE_UNKNOWN";
4018
+ readonly ProfinetIoTypeBool: "PROFINET_IO_TYPE_BOOL";
4019
+ readonly ProfinetIoTypeUsint: "PROFINET_IO_TYPE_USINT";
4020
+ readonly ProfinetIoTypeSint: "PROFINET_IO_TYPE_SINT";
4021
+ readonly ProfinetIoTypeUint: "PROFINET_IO_TYPE_UINT";
4022
+ readonly ProfinetIoTypeInt: "PROFINET_IO_TYPE_INT";
4023
+ readonly ProfinetIoTypeUdint: "PROFINET_IO_TYPE_UDINT";
4024
+ readonly ProfinetIoTypeDint: "PROFINET_IO_TYPE_DINT";
4025
+ readonly ProfinetIoTypeReal: "PROFINET_IO_TYPE_REAL";
4026
+ readonly ProfinetIoTypeLreal: "PROFINET_IO_TYPE_LREAL";
4027
+ };
4028
+ export type ProfinetIOTypeEnum = typeof ProfinetIOTypeEnum[keyof typeof ProfinetIOTypeEnum];
4029
+ /**
4030
+ *
4031
+ * @export
4032
+ * @interface ProfinetInputOutputConfig
4033
+ */
4034
+ export interface ProfinetInputOutputConfig {
4035
+ /**
4036
+ * Content of the input output configuration file.
4037
+ * @type {string}
4038
+ * @memberof ProfinetInputOutputConfig
4039
+ */
4040
+ 'config': string;
4041
+ /**
4042
+ * Offset in bytes for the input data.
4043
+ * @type {number}
4044
+ * @memberof ProfinetInputOutputConfig
4045
+ */
4046
+ 'input_offset': number;
4047
+ /**
4048
+ * Offset in bytes for the output data.
4049
+ * @type {number}
4050
+ * @memberof ProfinetInputOutputConfig
4051
+ */
4052
+ 'output_offset': number;
4053
+ }
4054
+ /**
4055
+ *
4056
+ * @export
4057
+ * @interface ProfinetSlotDescription
4058
+ */
4059
+ export interface ProfinetSlotDescription {
4060
+ /**
4061
+ * The number of the PROFINET slot.
4062
+ * @type {number}
4063
+ * @memberof ProfinetSlotDescription
4064
+ */
4065
+ 'number': number;
4066
+ /**
4067
+ * The API number of the PROFINET input, used to identify the specific API for the input.
4068
+ * @type {number}
4069
+ * @memberof ProfinetSlotDescription
4070
+ */
4071
+ 'api': number;
4072
+ /**
4073
+ * An array of PROFINET subslots.
4074
+ * @type {Array<ProfinetSubSlotDescription>}
4075
+ * @memberof ProfinetSlotDescription
4076
+ */
4077
+ 'subslots': Array<ProfinetSubSlotDescription>;
4078
+ }
4079
+ /**
4080
+ *
4081
+ * @export
4082
+ * @interface ProfinetSubSlotDescription
4083
+ */
4084
+ export interface ProfinetSubSlotDescription {
4085
+ /**
4086
+ * The identifier of the PROFINET subslot.
4087
+ * @type {number}
4088
+ * @memberof ProfinetSubSlotDescription
4089
+ */
4090
+ 'number': number;
4091
+ /**
4092
+ * The length in bytes of the PROFINET input.
4093
+ * @type {number}
4094
+ * @memberof ProfinetSubSlotDescription
4095
+ */
4096
+ 'input_length': number;
4097
+ /**
4098
+ * The length in bytes of the PROFINET output.
4099
+ * @type {number}
4100
+ * @memberof ProfinetSubSlotDescription
4101
+ */
4102
+ 'output_length': number;
4103
+ }
4104
+ /**
4105
+ * <!-- 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.
4106
+ * @export
4107
+ * @interface RRTConnectAlgorithm
4108
+ */
4109
+ export interface RRTConnectAlgorithm {
4110
+ /**
4111
+ * Algorithm discriminator.
4112
+ * @type {string}
4113
+ * @memberof RRTConnectAlgorithm
4114
+ */
4115
+ 'algorithm_name': RRTConnectAlgorithmAlgorithmNameEnum;
4116
+ /**
4117
+ * Maximum number of iterations for the RRT Connect algorithm. Higher values increase likelihood of success, but also computation time.
4118
+ * @type {number}
4119
+ * @memberof RRTConnectAlgorithm
4120
+ */
4121
+ 'max_iterations'?: number;
4122
+ }
4123
+ export declare const RRTConnectAlgorithmAlgorithmNameEnum: {
4124
+ readonly RrtConnectAlgorithm: "RRTConnectAlgorithm";
4125
+ };
4126
+ export type RRTConnectAlgorithmAlgorithmNameEnum = typeof RRTConnectAlgorithmAlgorithmNameEnum[keyof typeof RRTConnectAlgorithmAlgorithmNameEnum];
3345
4127
  /**
3346
4128
  * Defines an x/y-plane with finite size. Centred around the z-axis.
3347
4129
  * @export
@@ -3423,7 +4205,7 @@ export type ReleaseChannel = typeof ReleaseChannel[keyof typeof ReleaseChannel];
3423
4205
  */
3424
4206
  export interface RobotController {
3425
4207
  /**
3426
- * 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).
4208
+ * 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).
3427
4209
  * @type {string}
3428
4210
  * @memberof RobotController
3429
4211
  */
@@ -3446,6 +4228,18 @@ export type RobotControllerConfiguration = AbbController | FanucController | Kuk
3446
4228
  * @interface RobotControllerState
3447
4229
  */
3448
4230
  export interface RobotControllerState {
4231
+ /**
4232
+ * Mode of communication and control between NOVA and the robot controller.
4233
+ * @type {RobotSystemMode}
4234
+ * @memberof RobotControllerState
4235
+ */
4236
+ 'mode': RobotSystemMode;
4237
+ /**
4238
+ * 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.
4239
+ * @type {Array<string>}
4240
+ * @memberof RobotControllerState
4241
+ */
4242
+ 'last_error'?: Array<string>;
3449
4243
  /**
3450
4244
  * Timestamp indicating when the represented information was received from the robot controller.
3451
4245
  * @type {string}
@@ -3489,100 +4283,49 @@ export interface RobotControllerState {
3489
4283
  */
3490
4284
  'motion_groups': Array<MotionGroupState>;
3491
4285
  }
4286
+ /**
4287
+ * 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.
4288
+ * @export
4289
+ * @enum {string}
4290
+ */
4291
+ export declare const RobotSystemMode: {
4292
+ readonly ModeControllerNotConfigured: "MODE_CONTROLLER_NOT_CONFIGURED";
4293
+ readonly ModeInitializing: "MODE_INITIALIZING";
4294
+ readonly ModeMonitor: "MODE_MONITOR";
4295
+ readonly ModeControl: "MODE_CONTROL";
4296
+ readonly ModeFreeDrive: "MODE_FREE_DRIVE";
4297
+ };
4298
+ export type RobotSystemMode = typeof RobotSystemMode[keyof typeof RobotSystemMode];
3492
4299
  /**
3493
4300
  *
3494
4301
  * @export
3495
- * @interface RobotSetup
4302
+ * @interface RobotTcp
3496
4303
  */
3497
- export interface RobotSetup {
4304
+ export interface RobotTcp {
3498
4305
  /**
3499
- * String identifiying the model of a motion group.
4306
+ * A readable and changeable name for frontend visualization.
3500
4307
  * @type {string}
3501
- * @memberof RobotSetup
4308
+ * @memberof RobotTcp
3502
4309
  */
3503
- 'motion_group_model': string;
4310
+ 'name'?: string;
3504
4311
  /**
3505
- * [ms] cycle time of the motion group controller. A trajectory for this motion group should be computed to this resolution.
3506
- * @type {number}
3507
- * @memberof RobotSetup
4312
+ * A three-dimensional vector [x, y, z] with double precision.
4313
+ * @type {Array<number>}
4314
+ * @memberof RobotTcp
3508
4315
  */
3509
- 'cycle_time': number;
4316
+ 'position': Array<number>;
3510
4317
  /**
3511
- * The offset from the world frame to the motion group base.
3512
- * @type {Pose}
3513
- * @memberof RobotSetup
4318
+ * Describes an orientation in 3D space. A tree-to-four-dimensional vector [x, y, z, w] with double precision.
4319
+ * @type {Array<number>}
4320
+ * @memberof RobotTcp
3514
4321
  */
3515
- 'mounting'?: Pose;
4322
+ 'orientation'?: Array<number>;
3516
4323
  /**
3517
4324
  *
3518
- * @type {Pose}
3519
- * @memberof RobotSetup
4325
+ * @type {OrientationType}
4326
+ * @memberof RobotTcp
3520
4327
  */
3521
- 'tcp_offset'?: Pose;
3522
- /**
3523
- *
3524
- * @type {LimitSet}
3525
- * @memberof RobotSetup
3526
- */
3527
- 'global_limits'?: LimitSet;
3528
- /**
3529
- *
3530
- * @type {Payload}
3531
- * @memberof RobotSetup
3532
- */
3533
- 'payload'?: Payload;
3534
- /**
3535
- * 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.
3536
- * @type {{ [key: string]: SingleMotionGroupCollisionScene; }}
3537
- * @memberof RobotSetup
3538
- */
3539
- 'collision_scenes'?: {
3540
- [key: string]: SingleMotionGroupCollisionScene;
3541
- };
3542
- }
3543
- /**
3544
- * 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.
3545
- * @export
3546
- * @enum {string}
3547
- */
3548
- export declare const RobotSystemMode: {
3549
- readonly RobotSystemModeUndefined: "ROBOT_SYSTEM_MODE_UNDEFINED";
3550
- readonly RobotSystemModeDisconnect: "ROBOT_SYSTEM_MODE_DISCONNECT";
3551
- readonly RobotSystemModeMonitor: "ROBOT_SYSTEM_MODE_MONITOR";
3552
- readonly RobotSystemModeControl: "ROBOT_SYSTEM_MODE_CONTROL";
3553
- readonly RobotSystemModeFreeDrive: "ROBOT_SYSTEM_MODE_FREE_DRIVE";
3554
- };
3555
- export type RobotSystemMode = typeof RobotSystemMode[keyof typeof RobotSystemMode];
3556
- /**
3557
- *
3558
- * @export
3559
- * @interface RobotTcp
3560
- */
3561
- export interface RobotTcp {
3562
- /**
3563
- * A readable and changeable name for frontend visualization.
3564
- * @type {string}
3565
- * @memberof RobotTcp
3566
- */
3567
- 'name'?: string;
3568
- /**
3569
- * A three-dimensional vector [x, y, z] with double precision.
3570
- * @type {Array<number>}
3571
- * @memberof RobotTcp
3572
- */
3573
- 'position': Array<number>;
3574
- /**
3575
- * Describes an orientation in 3D space. A tree-to-four-dimensional vector [x, y, z, w] with double precision.
3576
- * @type {Array<number>}
3577
- * @memberof RobotTcp
3578
- */
3579
- 'orientation'?: Array<number>;
3580
- /**
3581
- *
3582
- * @type {OrientationType}
3583
- * @memberof RobotTcp
3584
- */
3585
- 'orientation_type'?: OrientationType;
4328
+ 'orientation_type'?: OrientationType;
3586
4329
  /**
3587
4330
  * Identifier of this tcp.
3588
4331
  * @type {string}
@@ -3621,46 +4364,6 @@ export interface RobotTcpData {
3621
4364
  */
3622
4365
  'orientation_type'?: OrientationType;
3623
4366
  }
3624
- /**
3625
- *
3626
- * @export
3627
- * @interface Running
3628
- */
3629
- export interface Running {
3630
- /**
3631
- *
3632
- * @type {string}
3633
- * @memberof Running
3634
- */
3635
- 'kind': RunningKindEnum;
3636
- }
3637
- export declare const RunningKindEnum: {
3638
- readonly Running: "RUNNING";
3639
- };
3640
- export type RunningKindEnum = typeof RunningKindEnum[keyof typeof RunningKindEnum];
3641
- /**
3642
- *
3643
- * @export
3644
- * @interface Running1
3645
- */
3646
- export interface Running1 {
3647
- /**
3648
- *
3649
- * @type {string}
3650
- * @memberof Running1
3651
- */
3652
- 'kind': Running1KindEnum;
3653
- /**
3654
- * Remaining time in milliseconds (ms) to reach the end of the motion.
3655
- * @type {number}
3656
- * @memberof Running1
3657
- */
3658
- 'time_to_end': number;
3659
- }
3660
- export declare const Running1KindEnum: {
3661
- readonly Running: "RUNNING";
3662
- };
3663
- export type Running1KindEnum = typeof Running1KindEnum[keyof typeof Running1KindEnum];
3664
4367
  /**
3665
4368
  * 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.
3666
4369
  * @export
@@ -3809,43 +4512,6 @@ export declare const SettableRobotSystemMode: {
3809
4512
  readonly RobotSystemModeControl: "ROBOT_SYSTEM_MODE_CONTROL";
3810
4513
  };
3811
4514
  export type SettableRobotSystemMode = typeof SettableRobotSystemMode[keyof typeof SettableRobotSystemMode];
3812
- /**
3813
- *
3814
- * @export
3815
- * @interface SingleMotionGroupCollisionScene
3816
- */
3817
- export interface SingleMotionGroupCollisionScene {
3818
- /**
3819
- * A collection of identifiable colliders.
3820
- * @type {{ [key: string]: Collider; }}
3821
- * @memberof SingleMotionGroupCollisionScene
3822
- */
3823
- 'static_colliders'?: {
3824
- [key: string]: Collider;
3825
- };
3826
- /**
3827
- * 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.
3828
- * @type {Array<{ [key: string]: Collider; }>}
3829
- * @memberof SingleMotionGroupCollisionScene
3830
- */
3831
- 'link_chain'?: Array<{
3832
- [key: string]: Collider;
3833
- }>;
3834
- /**
3835
- * 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.
3836
- * @type {{ [key: string]: Collider; }}
3837
- * @memberof SingleMotionGroupCollisionScene
3838
- */
3839
- 'tool'?: {
3840
- [key: string]: Collider;
3841
- };
3842
- /**
3843
- * If true, self-collision detection is enabled for the motion group. See LinkChain documentation for details. Default is true.
3844
- * @type {boolean}
3845
- * @memberof SingleMotionGroupCollisionScene
3846
- */
3847
- 'motion_group_self_collision_detection'?: boolean;
3848
- }
3849
4515
  /**
3850
4516
  *
3851
4517
  * @export
@@ -3897,7 +4563,7 @@ export interface StartMovementRequest {
3897
4563
  * @type {Direction}
3898
4564
  * @memberof StartMovementRequest
3899
4565
  */
3900
- 'direction': Direction;
4566
+ 'direction'?: Direction;
3901
4567
  /**
3902
4568
  * 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.
3903
4569
  * @type {Array<IOValue>}
@@ -4184,7 +4850,24 @@ export type TrajectoryDetailsKindEnum = typeof TrajectoryDetailsKindEnum[keyof t
4184
4850
  * @type TrajectoryDetailsState
4185
4851
  * @export
4186
4852
  */
4187
- export type TrajectoryDetailsState = EndOfTrajectory | PausedByRequest | PausedOnIO | Running1 | WaitForIO;
4853
+ export type TrajectoryDetailsState = TrajectoryEnded | TrajectoryPausedByUser | TrajectoryPausedOnIO | TrajectoryRunning | TrajectoryWaitForIO;
4854
+ /**
4855
+ *
4856
+ * @export
4857
+ * @interface TrajectoryEnded
4858
+ */
4859
+ export interface TrajectoryEnded {
4860
+ /**
4861
+ *
4862
+ * @type {string}
4863
+ * @memberof TrajectoryEnded
4864
+ */
4865
+ 'kind': TrajectoryEndedKindEnum;
4866
+ }
4867
+ export declare const TrajectoryEndedKindEnum: {
4868
+ readonly EndOfTrajectory: "END_OF_TRAJECTORY";
4869
+ };
4870
+ export type TrajectoryEndedKindEnum = typeof TrajectoryEndedKindEnum[keyof typeof TrajectoryEndedKindEnum];
4188
4871
  /**
4189
4872
  *
4190
4873
  * @export
@@ -4208,6 +4891,80 @@ export declare const TrajectoryIdMessageTypeEnum: {
4208
4891
  readonly TrajectoryId: "TrajectoryId";
4209
4892
  };
4210
4893
  export type TrajectoryIdMessageTypeEnum = typeof TrajectoryIdMessageTypeEnum[keyof typeof TrajectoryIdMessageTypeEnum];
4894
+ /**
4895
+ *
4896
+ * @export
4897
+ * @interface TrajectoryPausedByUser
4898
+ */
4899
+ export interface TrajectoryPausedByUser {
4900
+ /**
4901
+ *
4902
+ * @type {string}
4903
+ * @memberof TrajectoryPausedByUser
4904
+ */
4905
+ 'kind': TrajectoryPausedByUserKindEnum;
4906
+ }
4907
+ export declare const TrajectoryPausedByUserKindEnum: {
4908
+ readonly PausedByUser: "PAUSED_BY_USER";
4909
+ };
4910
+ export type TrajectoryPausedByUserKindEnum = typeof TrajectoryPausedByUserKindEnum[keyof typeof TrajectoryPausedByUserKindEnum];
4911
+ /**
4912
+ *
4913
+ * @export
4914
+ * @interface TrajectoryPausedOnIO
4915
+ */
4916
+ export interface TrajectoryPausedOnIO {
4917
+ /**
4918
+ *
4919
+ * @type {string}
4920
+ * @memberof TrajectoryPausedOnIO
4921
+ */
4922
+ 'kind': TrajectoryPausedOnIOKindEnum;
4923
+ }
4924
+ export declare const TrajectoryPausedOnIOKindEnum: {
4925
+ readonly PausedOnIo: "PAUSED_ON_IO";
4926
+ };
4927
+ export type TrajectoryPausedOnIOKindEnum = typeof TrajectoryPausedOnIOKindEnum[keyof typeof TrajectoryPausedOnIOKindEnum];
4928
+ /**
4929
+ *
4930
+ * @export
4931
+ * @interface TrajectoryRunning
4932
+ */
4933
+ export interface TrajectoryRunning {
4934
+ /**
4935
+ *
4936
+ * @type {string}
4937
+ * @memberof TrajectoryRunning
4938
+ */
4939
+ 'kind': TrajectoryRunningKindEnum;
4940
+ /**
4941
+ * Remaining time in milliseconds (ms) to reach the end of the motion.
4942
+ * @type {number}
4943
+ * @memberof TrajectoryRunning
4944
+ */
4945
+ 'time_to_end': number;
4946
+ }
4947
+ export declare const TrajectoryRunningKindEnum: {
4948
+ readonly Running: "RUNNING";
4949
+ };
4950
+ export type TrajectoryRunningKindEnum = typeof TrajectoryRunningKindEnum[keyof typeof TrajectoryRunningKindEnum];
4951
+ /**
4952
+ *
4953
+ * @export
4954
+ * @interface TrajectoryWaitForIO
4955
+ */
4956
+ export interface TrajectoryWaitForIO {
4957
+ /**
4958
+ *
4959
+ * @type {string}
4960
+ * @memberof TrajectoryWaitForIO
4961
+ */
4962
+ 'kind': TrajectoryWaitForIOKindEnum;
4963
+ }
4964
+ export declare const TrajectoryWaitForIOKindEnum: {
4965
+ readonly WaitForIo: "WAIT_FOR_IO";
4966
+ };
4967
+ export type TrajectoryWaitForIOKindEnum = typeof TrajectoryWaitForIOKindEnum[keyof typeof TrajectoryWaitForIOKindEnum];
4211
4968
  /**
4212
4969
  * The unit of input/output value.
4213
4970
  * @export
@@ -4286,6 +5043,14 @@ export interface ValidationError {
4286
5043
  * @memberof ValidationError
4287
5044
  */
4288
5045
  'type': string;
5046
+ /**
5047
+ *
5048
+ * @type {{ [key: string]: any; }}
5049
+ * @memberof ValidationError
5050
+ */
5051
+ 'input': {
5052
+ [key: string]: any;
5053
+ };
4289
5054
  }
4290
5055
  /**
4291
5056
  * @type ValidationErrorLocInner
@@ -4327,7 +5092,7 @@ export interface VirtualController {
4327
5092
  * @type {string}
4328
5093
  * @memberof VirtualController
4329
5094
  */
4330
- 'position'?: string;
5095
+ 'initial_joint_position'?: string;
4331
5096
  }
4332
5097
  export declare const VirtualControllerKindEnum: {
4333
5098
  readonly VirtualController: "VirtualController";
@@ -4373,6 +5138,7 @@ export declare const VirtualControllerTypes: {
4373
5138
  readonly FanucCrx20ial: "fanuc-crx20ial";
4374
5139
  readonly FanucCrx25ia: "fanuc-crx25ia";
4375
5140
  readonly FanucCrx30ia: "fanuc-crx30ia";
5141
+ readonly FanucCrx5ia: "fanuc-crx5ia";
4376
5142
  readonly FanucLrMate200iD: "fanuc-lr_mate_200iD";
4377
5143
  readonly FanucLrMate200iD4S: "fanuc-lr_mate_200iD4S";
4378
5144
  readonly FanucLrMate200iD7L: "fanuc-lr_mate_200iD7L";
@@ -4380,6 +5146,7 @@ export declare const VirtualControllerTypes: {
4380
5146
  readonly FanucM10iD16S: "fanuc-m10iD16S";
4381
5147
  readonly FanucM20iD25: "fanuc-m20iD25";
4382
5148
  readonly FanucM20iD35: "fanuc-m20iD35";
5149
+ readonly FanucM710iC20L: "fanuc-m710iC20L";
4383
5150
  readonly FanucM900iB280L: "fanuc-m900iB280L";
4384
5151
  readonly FanucM900iB360E: "fanuc-m900iB360E";
4385
5152
  readonly FanucR2000ic125l: "fanuc-r2000ic125l";
@@ -4468,323 +5235,807 @@ export interface VirtualRobotConfiguration {
4468
5235
  'content': string;
4469
5236
  }
4470
5237
  /**
4471
- *
5238
+ * The value to compare with the current value of the input/output.
5239
+ * @export
5240
+ * @interface WaitForIOEventRequest
5241
+ */
5242
+ export interface WaitForIOEventRequest {
5243
+ /**
5244
+ *
5245
+ * @type {IOValue}
5246
+ * @memberof WaitForIOEventRequest
5247
+ */
5248
+ 'io': IOValue;
5249
+ /**
5250
+ * 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.
5251
+ * @type {Comparator}
5252
+ * @memberof WaitForIOEventRequest
5253
+ */
5254
+ 'comparator': Comparator;
5255
+ }
5256
+ /**
5257
+ * The configuration of a physical Yaskawa robot controller has to contain IP address of the controller.
4472
5258
  * @export
4473
- * @interface WaitForIO
5259
+ * @interface YaskawaController
4474
5260
  */
4475
- export interface WaitForIO {
5261
+ export interface YaskawaController {
5262
+ /**
5263
+ *
5264
+ * @type {string}
5265
+ * @memberof YaskawaController
5266
+ */
5267
+ 'kind'?: YaskawaControllerKindEnum;
4476
5268
  /**
4477
5269
  *
4478
5270
  * @type {string}
4479
- * @memberof WaitForIO
5271
+ * @memberof YaskawaController
4480
5272
  */
4481
- 'kind': WaitForIOKindEnum;
5273
+ 'controller_ip': string;
4482
5274
  }
4483
- export declare const WaitForIOKindEnum: {
4484
- readonly WaitForIo: "WAIT_FOR_IO";
5275
+ export declare const YaskawaControllerKindEnum: {
5276
+ readonly YaskawaController: "YaskawaController";
4485
5277
  };
4486
- export type WaitForIOKindEnum = typeof WaitForIOKindEnum[keyof typeof WaitForIOKindEnum];
5278
+ export type YaskawaControllerKindEnum = typeof YaskawaControllerKindEnum[keyof typeof YaskawaControllerKindEnum];
4487
5279
  /**
4488
- * The value to compare with the current value of the input/output.
5280
+ * ApplicationApi - axios parameter creator
4489
5281
  * @export
4490
- * @interface WaitForIOEventRequest
4491
5282
  */
4492
- export interface WaitForIOEventRequest {
5283
+ export declare const ApplicationApiAxiosParamCreator: (configuration?: Configuration) => {
4493
5284
  /**
4494
- *
4495
- * @type {IOValue}
4496
- * @memberof WaitForIOEventRequest
5285
+ * 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.
5286
+ * @summary Add Application
5287
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
5288
+ * @param {App} app
5289
+ * @param {number} [completionTimeout]
5290
+ * @param {*} [options] Override http request option.
5291
+ * @throws {RequiredError}
5292
+ */
5293
+ addApp: (cell: string, app: App, completionTimeout?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
5294
+ /**
5295
+ * Delete all GUI applications from the cell.
5296
+ * @summary Clear Applications
5297
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
5298
+ * @param {number} [completionTimeout]
5299
+ * @param {*} [options] Override http request option.
5300
+ * @throws {RequiredError}
5301
+ */
5302
+ clearApps: (cell: string, completionTimeout?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
5303
+ /**
5304
+ * Delete a GUI application from the cell.
5305
+ * @summary Delete Application
5306
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
5307
+ * @param {string} app
5308
+ * @param {number} [completionTimeout]
5309
+ * @param {*} [options] Override http request option.
5310
+ * @throws {RequiredError}
5311
+ */
5312
+ deleteApp: (cell: string, app: string, completionTimeout?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
5313
+ /**
5314
+ * 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.
5315
+ * @summary Configuration
5316
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
5317
+ * @param {string} app
5318
+ * @param {*} [options] Override http request option.
5319
+ * @throws {RequiredError}
5320
+ */
5321
+ getApp: (cell: string, app: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
5322
+ /**
5323
+ * 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.
5324
+ * @summary List Applications
5325
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
5326
+ * @param {*} [options] Override http request option.
5327
+ * @throws {RequiredError}
5328
+ */
5329
+ listApps: (cell: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
5330
+ /**
5331
+ * Update the configuration of a GUI application in the cell.
5332
+ * @summary Update Configuration
5333
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
5334
+ * @param {string} app
5335
+ * @param {App} app2
5336
+ * @param {number} [completionTimeout]
5337
+ * @param {*} [options] Override http request option.
5338
+ * @throws {RequiredError}
5339
+ */
5340
+ updateApp: (cell: string, app: string, app2: App, completionTimeout?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
5341
+ };
5342
+ /**
5343
+ * ApplicationApi - functional programming interface
5344
+ * @export
5345
+ */
5346
+ export declare const ApplicationApiFp: (configuration?: Configuration) => {
5347
+ /**
5348
+ * 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.
5349
+ * @summary Add Application
5350
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
5351
+ * @param {App} app
5352
+ * @param {number} [completionTimeout]
5353
+ * @param {*} [options] Override http request option.
5354
+ * @throws {RequiredError}
5355
+ */
5356
+ addApp(cell: string, app: App, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
5357
+ /**
5358
+ * Delete all GUI applications from the cell.
5359
+ * @summary Clear Applications
5360
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
5361
+ * @param {number} [completionTimeout]
5362
+ * @param {*} [options] Override http request option.
5363
+ * @throws {RequiredError}
5364
+ */
5365
+ clearApps(cell: string, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
5366
+ /**
5367
+ * Delete a GUI application from the cell.
5368
+ * @summary Delete Application
5369
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
5370
+ * @param {string} app
5371
+ * @param {number} [completionTimeout]
5372
+ * @param {*} [options] Override http request option.
5373
+ * @throws {RequiredError}
5374
+ */
5375
+ deleteApp(cell: string, app: string, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
5376
+ /**
5377
+ * 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.
5378
+ * @summary Configuration
5379
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
5380
+ * @param {string} app
5381
+ * @param {*} [options] Override http request option.
5382
+ * @throws {RequiredError}
5383
+ */
5384
+ getApp(cell: string, app: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<App>>;
5385
+ /**
5386
+ * 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.
5387
+ * @summary List Applications
5388
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
5389
+ * @param {*} [options] Override http request option.
5390
+ * @throws {RequiredError}
5391
+ */
5392
+ listApps(cell: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<string>>>;
5393
+ /**
5394
+ * Update the configuration of a GUI application in the cell.
5395
+ * @summary Update Configuration
5396
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
5397
+ * @param {string} app
5398
+ * @param {App} app2
5399
+ * @param {number} [completionTimeout]
5400
+ * @param {*} [options] Override http request option.
5401
+ * @throws {RequiredError}
5402
+ */
5403
+ updateApp(cell: string, app: string, app2: App, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
5404
+ };
5405
+ /**
5406
+ * ApplicationApi - factory interface
5407
+ * @export
5408
+ */
5409
+ export declare const ApplicationApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
5410
+ /**
5411
+ * 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.
5412
+ * @summary Add Application
5413
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
5414
+ * @param {App} app
5415
+ * @param {number} [completionTimeout]
5416
+ * @param {*} [options] Override http request option.
5417
+ * @throws {RequiredError}
5418
+ */
5419
+ addApp(cell: string, app: App, completionTimeout?: number, options?: RawAxiosRequestConfig): AxiosPromise<void>;
5420
+ /**
5421
+ * Delete all GUI applications from the cell.
5422
+ * @summary Clear Applications
5423
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
5424
+ * @param {number} [completionTimeout]
5425
+ * @param {*} [options] Override http request option.
5426
+ * @throws {RequiredError}
5427
+ */
5428
+ clearApps(cell: string, completionTimeout?: number, options?: RawAxiosRequestConfig): AxiosPromise<void>;
5429
+ /**
5430
+ * Delete a GUI application from the cell.
5431
+ * @summary Delete Application
5432
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
5433
+ * @param {string} app
5434
+ * @param {number} [completionTimeout]
5435
+ * @param {*} [options] Override http request option.
5436
+ * @throws {RequiredError}
5437
+ */
5438
+ deleteApp(cell: string, app: string, completionTimeout?: number, options?: RawAxiosRequestConfig): AxiosPromise<void>;
5439
+ /**
5440
+ * 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.
5441
+ * @summary Configuration
5442
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
5443
+ * @param {string} app
5444
+ * @param {*} [options] Override http request option.
5445
+ * @throws {RequiredError}
5446
+ */
5447
+ getApp(cell: string, app: string, options?: RawAxiosRequestConfig): AxiosPromise<App>;
5448
+ /**
5449
+ * 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.
5450
+ * @summary List Applications
5451
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
5452
+ * @param {*} [options] Override http request option.
5453
+ * @throws {RequiredError}
5454
+ */
5455
+ listApps(cell: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<string>>;
5456
+ /**
5457
+ * Update the configuration of a GUI application in the cell.
5458
+ * @summary Update Configuration
5459
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
5460
+ * @param {string} app
5461
+ * @param {App} app2
5462
+ * @param {number} [completionTimeout]
5463
+ * @param {*} [options] Override http request option.
5464
+ * @throws {RequiredError}
5465
+ */
5466
+ updateApp(cell: string, app: string, app2: App, completionTimeout?: number, options?: RawAxiosRequestConfig): AxiosPromise<void>;
5467
+ };
5468
+ /**
5469
+ * ApplicationApi - object-oriented interface
5470
+ * @export
5471
+ * @class ApplicationApi
5472
+ * @extends {BaseAPI}
5473
+ */
5474
+ export declare class ApplicationApi extends BaseAPI {
5475
+ /**
5476
+ * 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.
5477
+ * @summary Add Application
5478
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
5479
+ * @param {App} app
5480
+ * @param {number} [completionTimeout]
5481
+ * @param {*} [options] Override http request option.
5482
+ * @throws {RequiredError}
5483
+ * @memberof ApplicationApi
5484
+ */
5485
+ addApp(cell: string, app: App, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
5486
+ /**
5487
+ * Delete all GUI applications from the cell.
5488
+ * @summary Clear Applications
5489
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
5490
+ * @param {number} [completionTimeout]
5491
+ * @param {*} [options] Override http request option.
5492
+ * @throws {RequiredError}
5493
+ * @memberof ApplicationApi
5494
+ */
5495
+ clearApps(cell: string, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
5496
+ /**
5497
+ * Delete a GUI application from the cell.
5498
+ * @summary Delete Application
5499
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
5500
+ * @param {string} app
5501
+ * @param {number} [completionTimeout]
5502
+ * @param {*} [options] Override http request option.
5503
+ * @throws {RequiredError}
5504
+ * @memberof ApplicationApi
5505
+ */
5506
+ deleteApp(cell: string, app: string, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
5507
+ /**
5508
+ * 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.
5509
+ * @summary Configuration
5510
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
5511
+ * @param {string} app
5512
+ * @param {*} [options] Override http request option.
5513
+ * @throws {RequiredError}
5514
+ * @memberof ApplicationApi
5515
+ */
5516
+ getApp(cell: string, app: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<App, any>>;
5517
+ /**
5518
+ * 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.
5519
+ * @summary List Applications
5520
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
5521
+ * @param {*} [options] Override http request option.
5522
+ * @throws {RequiredError}
5523
+ * @memberof ApplicationApi
5524
+ */
5525
+ listApps(cell: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<string[], any>>;
5526
+ /**
5527
+ * Update the configuration of a GUI application in the cell.
5528
+ * @summary Update Configuration
5529
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
5530
+ * @param {string} app
5531
+ * @param {App} app2
5532
+ * @param {number} [completionTimeout]
5533
+ * @param {*} [options] Override http request option.
5534
+ * @throws {RequiredError}
5535
+ * @memberof ApplicationApi
5536
+ */
5537
+ updateApp(cell: string, app: string, app2: App, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
5538
+ }
5539
+ /**
5540
+ * BUSInputsOutputsApi - axios parameter creator
5541
+ * @export
5542
+ */
5543
+ export declare const BUSInputsOutputsApiAxiosParamCreator: (configuration?: Configuration) => {
5544
+ /**
5545
+ * Add a BUS Inputs/Outputs Service to the cell.
5546
+ * @summary Add Service
5547
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
5548
+ * @param {BusIOType} busIOType
5549
+ * @param {number} [completionTimeout]
5550
+ * @param {*} [options] Override http request option.
5551
+ * @throws {RequiredError}
5552
+ */
5553
+ addBusIOService: (cell: string, busIOType: BusIOType, completionTimeout?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
5554
+ /**
5555
+ * Adds an input/output to or updates an input/output on the PROFINET device.
5556
+ * @summary Add PROFINET Input/Output
5557
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
5558
+ * @param {string} io Unique identifier to address an Input/Output in the cell.
5559
+ * @param {ProfinetIOData} profinetIOData
5560
+ * @param {*} [options] Override http request option.
5561
+ * @throws {RequiredError}
5562
+ */
5563
+ addProfinetIO: (cell: string, io: string, profinetIOData: ProfinetIOData, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
5564
+ /**
5565
+ * Delete BUS Inputs/Outputs Service from the cell.
5566
+ * @summary Clear Service
5567
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
5568
+ * @param {number} [completionTimeout]
5569
+ * @param {*} [options] Override http request option.
5570
+ * @throws {RequiredError}
5571
+ */
5572
+ clearBusIOService: (cell: string, completionTimeout?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
5573
+ /**
5574
+ * Removes the input/output from the PROFINET device.
5575
+ * @summary Remove PROFINET Input/Ouptut
5576
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
5577
+ * @param {string} io Unique identifier to address an Input/Output in the cell.
5578
+ * @param {*} [options] Override http request option.
5579
+ * @throws {RequiredError}
5580
+ */
5581
+ deleteProfinetIO: (cell: string, io: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
5582
+ /**
5583
+ * Get deployed BUS Inputs/Outputs Service.
5584
+ * @summary Get Service
5585
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
5586
+ * @param {*} [options] Override http request option.
5587
+ * @throws {RequiredError}
5588
+ */
5589
+ getBusIOService: (cell: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
5590
+ /**
5591
+ * Get the current state of the BUS Inputs/Outputs service.
5592
+ * @summary State
5593
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
5594
+ * @param {*} [options] Override http request option.
5595
+ * @throws {RequiredError}
5596
+ */
5597
+ getBusIOState: (cell: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
5598
+ /**
5599
+ * 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).
5600
+ * @summary Get Input/Output Values
5601
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
5602
+ * @param {Array<string>} [ios]
5603
+ * @param {*} [options] Override http request option.
5604
+ * @throws {RequiredError}
5605
+ */
5606
+ getBusIOValues: (cell: string, ios?: Array<string>, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
5607
+ /**
5608
+ * Get description of PROFINET
5609
+ * @summary Get PROFINET Description
5610
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
5611
+ * @param {*} [options] Override http request option.
5612
+ * @throws {RequiredError}
5613
+ */
5614
+ getProfinetDescription: (cell: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
5615
+ /**
5616
+ * Get input/output configuration of the PROFINET device as file.
5617
+ * @summary PROFINET Inputs/Outputs to File
5618
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
5619
+ * @param {number} [inputOffset]
5620
+ * @param {number} [outputOffset]
5621
+ * @param {*} [options] Override http request option.
5622
+ * @throws {RequiredError}
5623
+ */
5624
+ getProfinetIOsFromFile: (cell: string, inputOffset?: number, outputOffset?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
5625
+ /**
5626
+ * List all BUS Input/Output descriptions.
5627
+ * @summary List Descriptions
5628
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
5629
+ * @param {*} [options] Override http request option.
5630
+ * @throws {RequiredError}
5631
+ */
5632
+ listBusIODescriptions: (cell: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
5633
+ /**
5634
+ * List all PROFINET input and outputs.
5635
+ * @summary List PROFINET Input/Output Configuration
5636
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
5637
+ * @param {*} [options] Override http request option.
5638
+ * @throws {RequiredError}
5639
+ */
5640
+ listProfinetIOs: (cell: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
5641
+ /**
5642
+ * 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.
5643
+ * @summary Set Output Values
5644
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
5645
+ * @param {Array<IOValue>} iOValue
5646
+ * @param {*} [options] Override http request option.
5647
+ * @throws {RequiredError}
5648
+ */
5649
+ setBusIOValues: (cell: string, iOValue: Array<IOValue>, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
5650
+ /**
5651
+ * Sets inputs/outputs on the PROFINET device from file.
5652
+ * @summary Set PROFINET Inputs/Outputs from File
5653
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
5654
+ * @param {ProfinetInputOutputConfig} profinetInputOutputConfig
5655
+ * @param {*} [options] Override http request option.
5656
+ * @throws {RequiredError}
5657
+ */
5658
+ setProfinetIOsFromFile: (cell: string, profinetInputOutputConfig: ProfinetInputOutputConfig, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
5659
+ };
5660
+ /**
5661
+ * BUSInputsOutputsApi - functional programming interface
5662
+ * @export
5663
+ */
5664
+ export declare const BUSInputsOutputsApiFp: (configuration?: Configuration) => {
5665
+ /**
5666
+ * Add a BUS Inputs/Outputs Service to the cell.
5667
+ * @summary Add Service
5668
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
5669
+ * @param {BusIOType} busIOType
5670
+ * @param {number} [completionTimeout]
5671
+ * @param {*} [options] Override http request option.
5672
+ * @throws {RequiredError}
5673
+ */
5674
+ addBusIOService(cell: string, busIOType: BusIOType, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
5675
+ /**
5676
+ * Adds an input/output to or updates an input/output on the PROFINET device.
5677
+ * @summary Add PROFINET Input/Output
5678
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
5679
+ * @param {string} io Unique identifier to address an Input/Output in the cell.
5680
+ * @param {ProfinetIOData} profinetIOData
5681
+ * @param {*} [options] Override http request option.
5682
+ * @throws {RequiredError}
5683
+ */
5684
+ addProfinetIO(cell: string, io: string, profinetIOData: ProfinetIOData, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
5685
+ /**
5686
+ * Delete BUS Inputs/Outputs Service from the cell.
5687
+ * @summary Clear Service
5688
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
5689
+ * @param {number} [completionTimeout]
5690
+ * @param {*} [options] Override http request option.
5691
+ * @throws {RequiredError}
5692
+ */
5693
+ clearBusIOService(cell: string, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
5694
+ /**
5695
+ * Removes the input/output from the PROFINET device.
5696
+ * @summary Remove PROFINET Input/Ouptut
5697
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
5698
+ * @param {string} io Unique identifier to address an Input/Output in the cell.
5699
+ * @param {*} [options] Override http request option.
5700
+ * @throws {RequiredError}
5701
+ */
5702
+ deleteProfinetIO(cell: string, io: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
5703
+ /**
5704
+ * Get deployed BUS Inputs/Outputs Service.
5705
+ * @summary Get Service
5706
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
5707
+ * @param {*} [options] Override http request option.
5708
+ * @throws {RequiredError}
5709
+ */
5710
+ getBusIOService(cell: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BusIOType>>;
5711
+ /**
5712
+ * Get the current state of the BUS Inputs/Outputs service.
5713
+ * @summary State
5714
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
5715
+ * @param {*} [options] Override http request option.
5716
+ * @throws {RequiredError}
5717
+ */
5718
+ getBusIOState(cell: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BusIOsState>>;
5719
+ /**
5720
+ * 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).
5721
+ * @summary Get Input/Output Values
5722
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
5723
+ * @param {Array<string>} [ios]
5724
+ * @param {*} [options] Override http request option.
5725
+ * @throws {RequiredError}
5726
+ */
5727
+ getBusIOValues(cell: string, ios?: Array<string>, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<IOValue>>>;
5728
+ /**
5729
+ * Get description of PROFINET
5730
+ * @summary Get PROFINET Description
5731
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
5732
+ * @param {*} [options] Override http request option.
5733
+ * @throws {RequiredError}
5734
+ */
5735
+ getProfinetDescription(cell: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ProfinetDescription>>;
5736
+ /**
5737
+ * Get input/output configuration of the PROFINET device as file.
5738
+ * @summary PROFINET Inputs/Outputs to File
5739
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
5740
+ * @param {number} [inputOffset]
5741
+ * @param {number} [outputOffset]
5742
+ * @param {*} [options] Override http request option.
5743
+ * @throws {RequiredError}
5744
+ */
5745
+ getProfinetIOsFromFile(cell: string, inputOffset?: number, outputOffset?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<string>>;
5746
+ /**
5747
+ * List all BUS Input/Output descriptions.
5748
+ * @summary List Descriptions
5749
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
5750
+ * @param {*} [options] Override http request option.
5751
+ * @throws {RequiredError}
4497
5752
  */
4498
- 'io': IOValue;
5753
+ listBusIODescriptions(cell: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<IODescription>>>;
4499
5754
  /**
4500
- * 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.
4501
- * @type {Comparator}
4502
- * @memberof WaitForIOEventRequest
5755
+ * List all PROFINET input and outputs.
5756
+ * @summary List PROFINET Input/Output Configuration
5757
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
5758
+ * @param {*} [options] Override http request option.
5759
+ * @throws {RequiredError}
4503
5760
  */
4504
- 'comparator': Comparator;
4505
- }
4506
- /**
4507
- * The configuration of a physical Yaskawa robot controller has to contain IP address of the controller.
4508
- * @export
4509
- * @interface YaskawaController
4510
- */
4511
- export interface YaskawaController {
5761
+ listProfinetIOs(cell: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<ProfinetIO>>>;
4512
5762
  /**
4513
- *
4514
- * @type {string}
4515
- * @memberof YaskawaController
5763
+ * 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.
5764
+ * @summary Set Output Values
5765
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
5766
+ * @param {Array<IOValue>} iOValue
5767
+ * @param {*} [options] Override http request option.
5768
+ * @throws {RequiredError}
4516
5769
  */
4517
- 'kind'?: YaskawaControllerKindEnum;
5770
+ setBusIOValues(cell: string, iOValue: Array<IOValue>, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
4518
5771
  /**
4519
- *
4520
- * @type {string}
4521
- * @memberof YaskawaController
5772
+ * Sets inputs/outputs on the PROFINET device from file.
5773
+ * @summary Set PROFINET Inputs/Outputs from File
5774
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
5775
+ * @param {ProfinetInputOutputConfig} profinetInputOutputConfig
5776
+ * @param {*} [options] Override http request option.
5777
+ * @throws {RequiredError}
4522
5778
  */
4523
- 'controller_ip': string;
4524
- }
4525
- export declare const YaskawaControllerKindEnum: {
4526
- readonly YaskawaController: "YaskawaController";
5779
+ setProfinetIOsFromFile(cell: string, profinetInputOutputConfig: ProfinetInputOutputConfig, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
4527
5780
  };
4528
- export type YaskawaControllerKindEnum = typeof YaskawaControllerKindEnum[keyof typeof YaskawaControllerKindEnum];
4529
5781
  /**
4530
- * ApplicationApi - axios parameter creator
5782
+ * BUSInputsOutputsApi - factory interface
4531
5783
  * @export
4532
5784
  */
4533
- export declare const ApplicationApiAxiosParamCreator: (configuration?: Configuration) => {
5785
+ export declare const BUSInputsOutputsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
4534
5786
  /**
4535
- * 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.
4536
- * @summary Add Application
5787
+ * Add a BUS Inputs/Outputs Service to the cell.
5788
+ * @summary Add Service
4537
5789
  * @param {string} cell Unique identifier addressing a cell in all API calls.
4538
- * @param {App} app
5790
+ * @param {BusIOType} busIOType
4539
5791
  * @param {number} [completionTimeout]
4540
5792
  * @param {*} [options] Override http request option.
4541
5793
  * @throws {RequiredError}
4542
5794
  */
4543
- addApp: (cell: string, app: App, completionTimeout?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
5795
+ addBusIOService(cell: string, busIOType: BusIOType, completionTimeout?: number, options?: RawAxiosRequestConfig): AxiosPromise<void>;
4544
5796
  /**
4545
- * Delete all GUI applications from the cell.
4546
- * @summary Clear Applications
5797
+ * Adds an input/output to or updates an input/output on the PROFINET device.
5798
+ * @summary Add PROFINET Input/Output
4547
5799
  * @param {string} cell Unique identifier addressing a cell in all API calls.
4548
- * @param {number} [completionTimeout]
5800
+ * @param {string} io Unique identifier to address an Input/Output in the cell.
5801
+ * @param {ProfinetIOData} profinetIOData
4549
5802
  * @param {*} [options] Override http request option.
4550
5803
  * @throws {RequiredError}
4551
5804
  */
4552
- clearApps: (cell: string, completionTimeout?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
5805
+ addProfinetIO(cell: string, io: string, profinetIOData: ProfinetIOData, options?: RawAxiosRequestConfig): AxiosPromise<void>;
4553
5806
  /**
4554
- * Delete a GUI application from the cell.
4555
- * @summary Delete Application
5807
+ * Delete BUS Inputs/Outputs Service from the cell.
5808
+ * @summary Clear Service
4556
5809
  * @param {string} cell Unique identifier addressing a cell in all API calls.
4557
- * @param {string} app
4558
5810
  * @param {number} [completionTimeout]
4559
5811
  * @param {*} [options] Override http request option.
4560
5812
  * @throws {RequiredError}
4561
5813
  */
4562
- deleteApp: (cell: string, app: string, completionTimeout?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
5814
+ clearBusIOService(cell: string, completionTimeout?: number, options?: RawAxiosRequestConfig): AxiosPromise<void>;
4563
5815
  /**
4564
- * 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.
4565
- * @summary Configuration
5816
+ * Removes the input/output from the PROFINET device.
5817
+ * @summary Remove PROFINET Input/Ouptut
4566
5818
  * @param {string} cell Unique identifier addressing a cell in all API calls.
4567
- * @param {string} app
5819
+ * @param {string} io Unique identifier to address an Input/Output in the cell.
4568
5820
  * @param {*} [options] Override http request option.
4569
5821
  * @throws {RequiredError}
4570
5822
  */
4571
- getApp: (cell: string, app: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
5823
+ deleteProfinetIO(cell: string, io: string, options?: RawAxiosRequestConfig): AxiosPromise<void>;
4572
5824
  /**
4573
- * 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.
4574
- * @summary List Applications
5825
+ * Get deployed BUS Inputs/Outputs Service.
5826
+ * @summary Get Service
4575
5827
  * @param {string} cell Unique identifier addressing a cell in all API calls.
4576
5828
  * @param {*} [options] Override http request option.
4577
5829
  * @throws {RequiredError}
4578
5830
  */
4579
- listApps: (cell: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
5831
+ getBusIOService(cell: string, options?: RawAxiosRequestConfig): AxiosPromise<BusIOType>;
4580
5832
  /**
4581
- * Update the configuration of a GUI application in the cell.
4582
- * @summary Update Configuration
5833
+ * Get the current state of the BUS Inputs/Outputs service.
5834
+ * @summary State
4583
5835
  * @param {string} cell Unique identifier addressing a cell in all API calls.
4584
- * @param {string} app
4585
- * @param {App} app2
4586
- * @param {number} [completionTimeout]
4587
5836
  * @param {*} [options] Override http request option.
4588
5837
  * @throws {RequiredError}
4589
5838
  */
4590
- updateApp: (cell: string, app: string, app2: App, completionTimeout?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
4591
- };
4592
- /**
4593
- * ApplicationApi - functional programming interface
4594
- * @export
4595
- */
4596
- export declare const ApplicationApiFp: (configuration?: Configuration) => {
5839
+ getBusIOState(cell: string, options?: RawAxiosRequestConfig): AxiosPromise<BusIOsState>;
4597
5840
  /**
4598
- * 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.
4599
- * @summary Add Application
5841
+ * 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).
5842
+ * @summary Get Input/Output Values
4600
5843
  * @param {string} cell Unique identifier addressing a cell in all API calls.
4601
- * @param {App} app
4602
- * @param {number} [completionTimeout]
5844
+ * @param {Array<string>} [ios]
4603
5845
  * @param {*} [options] Override http request option.
4604
5846
  * @throws {RequiredError}
4605
5847
  */
4606
- addApp(cell: string, app: App, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
5848
+ getBusIOValues(cell: string, ios?: Array<string>, options?: RawAxiosRequestConfig): AxiosPromise<Array<IOValue>>;
4607
5849
  /**
4608
- * Delete all GUI applications from the cell.
4609
- * @summary Clear Applications
5850
+ * Get description of PROFINET
5851
+ * @summary Get PROFINET Description
4610
5852
  * @param {string} cell Unique identifier addressing a cell in all API calls.
4611
- * @param {number} [completionTimeout]
4612
5853
  * @param {*} [options] Override http request option.
4613
5854
  * @throws {RequiredError}
4614
5855
  */
4615
- clearApps(cell: string, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
5856
+ getProfinetDescription(cell: string, options?: RawAxiosRequestConfig): AxiosPromise<ProfinetDescription>;
4616
5857
  /**
4617
- * Delete a GUI application from the cell.
4618
- * @summary Delete Application
5858
+ * Get input/output configuration of the PROFINET device as file.
5859
+ * @summary PROFINET Inputs/Outputs to File
4619
5860
  * @param {string} cell Unique identifier addressing a cell in all API calls.
4620
- * @param {string} app
4621
- * @param {number} [completionTimeout]
5861
+ * @param {number} [inputOffset]
5862
+ * @param {number} [outputOffset]
4622
5863
  * @param {*} [options] Override http request option.
4623
5864
  * @throws {RequiredError}
4624
5865
  */
4625
- deleteApp(cell: string, app: string, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
5866
+ getProfinetIOsFromFile(cell: string, inputOffset?: number, outputOffset?: number, options?: RawAxiosRequestConfig): AxiosPromise<string>;
4626
5867
  /**
4627
- * 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.
4628
- * @summary Configuration
5868
+ * List all BUS Input/Output descriptions.
5869
+ * @summary List Descriptions
4629
5870
  * @param {string} cell Unique identifier addressing a cell in all API calls.
4630
- * @param {string} app
4631
5871
  * @param {*} [options] Override http request option.
4632
5872
  * @throws {RequiredError}
4633
5873
  */
4634
- getApp(cell: string, app: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<App>>;
5874
+ listBusIODescriptions(cell: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<IODescription>>;
4635
5875
  /**
4636
- * 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.
4637
- * @summary List Applications
5876
+ * List all PROFINET input and outputs.
5877
+ * @summary List PROFINET Input/Output Configuration
4638
5878
  * @param {string} cell Unique identifier addressing a cell in all API calls.
4639
5879
  * @param {*} [options] Override http request option.
4640
5880
  * @throws {RequiredError}
4641
5881
  */
4642
- listApps(cell: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<string>>>;
5882
+ listProfinetIOs(cell: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<ProfinetIO>>;
4643
5883
  /**
4644
- * Update the configuration of a GUI application in the cell.
4645
- * @summary Update Configuration
5884
+ * 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.
5885
+ * @summary Set Output Values
4646
5886
  * @param {string} cell Unique identifier addressing a cell in all API calls.
4647
- * @param {string} app
4648
- * @param {App} app2
4649
- * @param {number} [completionTimeout]
5887
+ * @param {Array<IOValue>} iOValue
4650
5888
  * @param {*} [options] Override http request option.
4651
5889
  * @throws {RequiredError}
4652
5890
  */
4653
- updateApp(cell: string, app: string, app2: App, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
5891
+ setBusIOValues(cell: string, iOValue: Array<IOValue>, options?: RawAxiosRequestConfig): AxiosPromise<void>;
5892
+ /**
5893
+ * Sets inputs/outputs on the PROFINET device from file.
5894
+ * @summary Set PROFINET Inputs/Outputs from File
5895
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
5896
+ * @param {ProfinetInputOutputConfig} profinetInputOutputConfig
5897
+ * @param {*} [options] Override http request option.
5898
+ * @throws {RequiredError}
5899
+ */
5900
+ setProfinetIOsFromFile(cell: string, profinetInputOutputConfig: ProfinetInputOutputConfig, options?: RawAxiosRequestConfig): AxiosPromise<void>;
4654
5901
  };
4655
5902
  /**
4656
- * ApplicationApi - factory interface
5903
+ * BUSInputsOutputsApi - object-oriented interface
4657
5904
  * @export
5905
+ * @class BUSInputsOutputsApi
5906
+ * @extends {BaseAPI}
4658
5907
  */
4659
- export declare const ApplicationApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
5908
+ export declare class BUSInputsOutputsApi extends BaseAPI {
4660
5909
  /**
4661
- * 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.
4662
- * @summary Add Application
5910
+ * Add a BUS Inputs/Outputs Service to the cell.
5911
+ * @summary Add Service
4663
5912
  * @param {string} cell Unique identifier addressing a cell in all API calls.
4664
- * @param {App} app
5913
+ * @param {BusIOType} busIOType
4665
5914
  * @param {number} [completionTimeout]
4666
5915
  * @param {*} [options] Override http request option.
4667
5916
  * @throws {RequiredError}
5917
+ * @memberof BUSInputsOutputsApi
4668
5918
  */
4669
- addApp(cell: string, app: App, completionTimeout?: number, options?: RawAxiosRequestConfig): AxiosPromise<void>;
5919
+ addBusIOService(cell: string, busIOType: BusIOType, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
4670
5920
  /**
4671
- * Delete all GUI applications from the cell.
4672
- * @summary Clear Applications
5921
+ * Adds an input/output to or updates an input/output on the PROFINET device.
5922
+ * @summary Add PROFINET Input/Output
4673
5923
  * @param {string} cell Unique identifier addressing a cell in all API calls.
4674
- * @param {number} [completionTimeout]
5924
+ * @param {string} io Unique identifier to address an Input/Output in the cell.
5925
+ * @param {ProfinetIOData} profinetIOData
4675
5926
  * @param {*} [options] Override http request option.
4676
5927
  * @throws {RequiredError}
5928
+ * @memberof BUSInputsOutputsApi
4677
5929
  */
4678
- clearApps(cell: string, completionTimeout?: number, options?: RawAxiosRequestConfig): AxiosPromise<void>;
5930
+ addProfinetIO(cell: string, io: string, profinetIOData: ProfinetIOData, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
4679
5931
  /**
4680
- * Delete a GUI application from the cell.
4681
- * @summary Delete Application
5932
+ * Delete BUS Inputs/Outputs Service from the cell.
5933
+ * @summary Clear Service
4682
5934
  * @param {string} cell Unique identifier addressing a cell in all API calls.
4683
- * @param {string} app
4684
5935
  * @param {number} [completionTimeout]
4685
5936
  * @param {*} [options] Override http request option.
4686
5937
  * @throws {RequiredError}
5938
+ * @memberof BUSInputsOutputsApi
4687
5939
  */
4688
- deleteApp(cell: string, app: string, completionTimeout?: number, options?: RawAxiosRequestConfig): AxiosPromise<void>;
5940
+ clearBusIOService(cell: string, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
4689
5941
  /**
4690
- * 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.
4691
- * @summary Configuration
5942
+ * Removes the input/output from the PROFINET device.
5943
+ * @summary Remove PROFINET Input/Ouptut
4692
5944
  * @param {string} cell Unique identifier addressing a cell in all API calls.
4693
- * @param {string} app
5945
+ * @param {string} io Unique identifier to address an Input/Output in the cell.
4694
5946
  * @param {*} [options] Override http request option.
4695
5947
  * @throws {RequiredError}
5948
+ * @memberof BUSInputsOutputsApi
4696
5949
  */
4697
- getApp(cell: string, app: string, options?: RawAxiosRequestConfig): AxiosPromise<App>;
5950
+ deleteProfinetIO(cell: string, io: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
4698
5951
  /**
4699
- * 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.
4700
- * @summary List Applications
5952
+ * Get deployed BUS Inputs/Outputs Service.
5953
+ * @summary Get Service
4701
5954
  * @param {string} cell Unique identifier addressing a cell in all API calls.
4702
5955
  * @param {*} [options] Override http request option.
4703
5956
  * @throws {RequiredError}
5957
+ * @memberof BUSInputsOutputsApi
4704
5958
  */
4705
- listApps(cell: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<string>>;
5959
+ getBusIOService(cell: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<{
5960
+ bus_type: "profinet";
5961
+ } & BusIOProfinet, any>>;
4706
5962
  /**
4707
- * Update the configuration of a GUI application in the cell.
4708
- * @summary Update Configuration
5963
+ * Get the current state of the BUS Inputs/Outputs service.
5964
+ * @summary State
4709
5965
  * @param {string} cell Unique identifier addressing a cell in all API calls.
4710
- * @param {string} app
4711
- * @param {App} app2
4712
- * @param {number} [completionTimeout]
4713
5966
  * @param {*} [options] Override http request option.
4714
5967
  * @throws {RequiredError}
5968
+ * @memberof BUSInputsOutputsApi
4715
5969
  */
4716
- updateApp(cell: string, app: string, app2: App, completionTimeout?: number, options?: RawAxiosRequestConfig): AxiosPromise<void>;
4717
- };
4718
- /**
4719
- * ApplicationApi - object-oriented interface
4720
- * @export
4721
- * @class ApplicationApi
4722
- * @extends {BaseAPI}
4723
- */
4724
- export declare class ApplicationApi extends BaseAPI {
5970
+ getBusIOState(cell: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<BusIOsState, any>>;
4725
5971
  /**
4726
- * 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.
4727
- * @summary Add Application
5972
+ * 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).
5973
+ * @summary Get Input/Output Values
4728
5974
  * @param {string} cell Unique identifier addressing a cell in all API calls.
4729
- * @param {App} app
4730
- * @param {number} [completionTimeout]
5975
+ * @param {Array<string>} [ios]
4731
5976
  * @param {*} [options] Override http request option.
4732
5977
  * @throws {RequiredError}
4733
- * @memberof ApplicationApi
5978
+ * @memberof BUSInputsOutputsApi
4734
5979
  */
4735
- addApp(cell: string, app: App, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
5980
+ getBusIOValues(cell: string, ios?: Array<string>, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<IOValue[], any>>;
4736
5981
  /**
4737
- * Delete all GUI applications from the cell.
4738
- * @summary Clear Applications
5982
+ * Get description of PROFINET
5983
+ * @summary Get PROFINET Description
4739
5984
  * @param {string} cell Unique identifier addressing a cell in all API calls.
4740
- * @param {number} [completionTimeout]
4741
5985
  * @param {*} [options] Override http request option.
4742
5986
  * @throws {RequiredError}
4743
- * @memberof ApplicationApi
5987
+ * @memberof BUSInputsOutputsApi
4744
5988
  */
4745
- clearApps(cell: string, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
5989
+ getProfinetDescription(cell: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ProfinetDescription, any>>;
4746
5990
  /**
4747
- * Delete a GUI application from the cell.
4748
- * @summary Delete Application
5991
+ * Get input/output configuration of the PROFINET device as file.
5992
+ * @summary PROFINET Inputs/Outputs to File
4749
5993
  * @param {string} cell Unique identifier addressing a cell in all API calls.
4750
- * @param {string} app
4751
- * @param {number} [completionTimeout]
5994
+ * @param {number} [inputOffset]
5995
+ * @param {number} [outputOffset]
4752
5996
  * @param {*} [options] Override http request option.
4753
5997
  * @throws {RequiredError}
4754
- * @memberof ApplicationApi
5998
+ * @memberof BUSInputsOutputsApi
4755
5999
  */
4756
- deleteApp(cell: string, app: string, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
6000
+ getProfinetIOsFromFile(cell: string, inputOffset?: number, outputOffset?: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<string, any>>;
4757
6001
  /**
4758
- * 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.
4759
- * @summary Configuration
6002
+ * List all BUS Input/Output descriptions.
6003
+ * @summary List Descriptions
4760
6004
  * @param {string} cell Unique identifier addressing a cell in all API calls.
4761
- * @param {string} app
4762
6005
  * @param {*} [options] Override http request option.
4763
6006
  * @throws {RequiredError}
4764
- * @memberof ApplicationApi
6007
+ * @memberof BUSInputsOutputsApi
4765
6008
  */
4766
- getApp(cell: string, app: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<App, any>>;
6009
+ listBusIODescriptions(cell: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<IODescription[], any>>;
4767
6010
  /**
4768
- * 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.
4769
- * @summary List Applications
6011
+ * List all PROFINET input and outputs.
6012
+ * @summary List PROFINET Input/Output Configuration
4770
6013
  * @param {string} cell Unique identifier addressing a cell in all API calls.
4771
6014
  * @param {*} [options] Override http request option.
4772
6015
  * @throws {RequiredError}
4773
- * @memberof ApplicationApi
6016
+ * @memberof BUSInputsOutputsApi
4774
6017
  */
4775
- listApps(cell: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<string[], any>>;
6018
+ listProfinetIOs(cell: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ProfinetIO[], any>>;
4776
6019
  /**
4777
- * Update the configuration of a GUI application in the cell.
4778
- * @summary Update Configuration
6020
+ * 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.
6021
+ * @summary Set Output Values
4779
6022
  * @param {string} cell Unique identifier addressing a cell in all API calls.
4780
- * @param {string} app
4781
- * @param {App} app2
4782
- * @param {number} [completionTimeout]
6023
+ * @param {Array<IOValue>} iOValue
4783
6024
  * @param {*} [options] Override http request option.
4784
6025
  * @throws {RequiredError}
4785
- * @memberof ApplicationApi
6026
+ * @memberof BUSInputsOutputsApi
4786
6027
  */
4787
- updateApp(cell: string, app: string, app2: App, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
6028
+ setBusIOValues(cell: string, iOValue: Array<IOValue>, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
6029
+ /**
6030
+ * Sets inputs/outputs on the PROFINET device from file.
6031
+ * @summary Set PROFINET Inputs/Outputs from File
6032
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
6033
+ * @param {ProfinetInputOutputConfig} profinetInputOutputConfig
6034
+ * @param {*} [options] Override http request option.
6035
+ * @throws {RequiredError}
6036
+ * @memberof BUSInputsOutputsApi
6037
+ */
6038
+ setProfinetIOsFromFile(cell: string, profinetInputOutputConfig: ProfinetInputOutputConfig, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
4788
6039
  }
4789
6040
  /**
4790
6041
  * CellApi - axios parameter creator
@@ -5122,15 +6373,6 @@ export declare const ControllerApiAxiosParamCreator: (configuration?: Configurat
5122
6373
  * @throws {RequiredError}
5123
6374
  */
5124
6375
  getCurrentRobotControllerState: (cell: string, controller: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
5125
- /**
5126
- * 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).
5127
- * @summary Current Mode
5128
- * @param {string} cell Unique identifier addressing a cell in all API calls.
5129
- * @param {string} controller Unique identifier to address a controller in the cell.
5130
- * @param {*} [options] Override http request option.
5131
- * @throws {RequiredError}
5132
- */
5133
- getMode: (cell: string, controller: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
5134
6376
  /**
5135
6377
  * Get the configuration for a robot controller.
5136
6378
  * @summary Robot Controller
@@ -5168,7 +6410,7 @@ export declare const ControllerApiAxiosParamCreator: (configuration?: Configurat
5168
6410
  */
5169
6411
  listRobotControllers: (cell: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
5170
6412
  /**
5171
- * 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.
6413
+ * 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.
5172
6414
  * @summary Set Default Mode
5173
6415
  * @param {string} cell Unique identifier addressing a cell in all API calls.
5174
6416
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -5188,15 +6430,16 @@ export declare const ControllerApiAxiosParamCreator: (configuration?: Configurat
5188
6430
  */
5189
6431
  streamFreeDrive: (cell: string, controller: string, responseRate?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
5190
6432
  /**
5191
- * <!-- theme: danger --> > Websocket endpoint Receive updates of the state of a robot controller.
6433
+ * <!-- 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.
5192
6434
  * @summary Stream State
5193
6435
  * @param {string} cell Unique identifier addressing a cell in all API calls.
5194
6436
  * @param {string} controller Unique identifier to address a controller in the cell.
5195
6437
  * @param {number} [responseRate]
6438
+ * @param {number} [addControllerTimeout]
5196
6439
  * @param {*} [options] Override http request option.
5197
6440
  * @throws {RequiredError}
5198
6441
  */
5199
- streamRobotControllerState: (cell: string, controller: string, responseRate?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
6442
+ streamRobotControllerState: (cell: string, controller: string, responseRate?: number, addControllerTimeout?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
5200
6443
  /**
5201
6444
  * 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.
5202
6445
  * @summary Update Robot Controller
@@ -5272,15 +6515,6 @@ export declare const ControllerApiFp: (configuration?: Configuration) => {
5272
6515
  * @throws {RequiredError}
5273
6516
  */
5274
6517
  getCurrentRobotControllerState(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<RobotControllerState>>;
5275
- /**
5276
- * 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).
5277
- * @summary Current Mode
5278
- * @param {string} cell Unique identifier addressing a cell in all API calls.
5279
- * @param {string} controller Unique identifier to address a controller in the cell.
5280
- * @param {*} [options] Override http request option.
5281
- * @throws {RequiredError}
5282
- */
5283
- getMode(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetModeResponse>>;
5284
6518
  /**
5285
6519
  * Get the configuration for a robot controller.
5286
6520
  * @summary Robot Controller
@@ -5318,7 +6552,7 @@ export declare const ControllerApiFp: (configuration?: Configuration) => {
5318
6552
  */
5319
6553
  listRobotControllers(cell: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<string>>>;
5320
6554
  /**
5321
- * 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.
6555
+ * 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.
5322
6556
  * @summary Set Default Mode
5323
6557
  * @param {string} cell Unique identifier addressing a cell in all API calls.
5324
6558
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -5338,15 +6572,16 @@ export declare const ControllerApiFp: (configuration?: Configuration) => {
5338
6572
  */
5339
6573
  streamFreeDrive(cell: string, controller: string, responseRate?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<RobotControllerState>>;
5340
6574
  /**
5341
- * <!-- theme: danger --> > Websocket endpoint Receive updates of the state of a robot controller.
6575
+ * <!-- 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.
5342
6576
  * @summary Stream State
5343
6577
  * @param {string} cell Unique identifier addressing a cell in all API calls.
5344
6578
  * @param {string} controller Unique identifier to address a controller in the cell.
5345
6579
  * @param {number} [responseRate]
6580
+ * @param {number} [addControllerTimeout]
5346
6581
  * @param {*} [options] Override http request option.
5347
6582
  * @throws {RequiredError}
5348
6583
  */
5349
- streamRobotControllerState(cell: string, controller: string, responseRate?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<RobotControllerState>>;
6584
+ streamRobotControllerState(cell: string, controller: string, responseRate?: number, addControllerTimeout?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<RobotControllerState>>;
5350
6585
  /**
5351
6586
  * 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.
5352
6587
  * @summary Update Robot Controller
@@ -5422,15 +6657,6 @@ export declare const ControllerApiFactory: (configuration?: Configuration, baseP
5422
6657
  * @throws {RequiredError}
5423
6658
  */
5424
6659
  getCurrentRobotControllerState(cell: string, controller: string, options?: RawAxiosRequestConfig): AxiosPromise<RobotControllerState>;
5425
- /**
5426
- * 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).
5427
- * @summary Current Mode
5428
- * @param {string} cell Unique identifier addressing a cell in all API calls.
5429
- * @param {string} controller Unique identifier to address a controller in the cell.
5430
- * @param {*} [options] Override http request option.
5431
- * @throws {RequiredError}
5432
- */
5433
- getMode(cell: string, controller: string, options?: RawAxiosRequestConfig): AxiosPromise<GetModeResponse>;
5434
6660
  /**
5435
6661
  * Get the configuration for a robot controller.
5436
6662
  * @summary Robot Controller
@@ -5468,7 +6694,7 @@ export declare const ControllerApiFactory: (configuration?: Configuration, baseP
5468
6694
  */
5469
6695
  listRobotControllers(cell: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<string>>;
5470
6696
  /**
5471
- * 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.
6697
+ * 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.
5472
6698
  * @summary Set Default Mode
5473
6699
  * @param {string} cell Unique identifier addressing a cell in all API calls.
5474
6700
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -5488,15 +6714,16 @@ export declare const ControllerApiFactory: (configuration?: Configuration, baseP
5488
6714
  */
5489
6715
  streamFreeDrive(cell: string, controller: string, responseRate?: number, options?: RawAxiosRequestConfig): AxiosPromise<RobotControllerState>;
5490
6716
  /**
5491
- * <!-- theme: danger --> > Websocket endpoint Receive updates of the state of a robot controller.
6717
+ * <!-- 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.
5492
6718
  * @summary Stream State
5493
6719
  * @param {string} cell Unique identifier addressing a cell in all API calls.
5494
6720
  * @param {string} controller Unique identifier to address a controller in the cell.
5495
6721
  * @param {number} [responseRate]
6722
+ * @param {number} [addControllerTimeout]
5496
6723
  * @param {*} [options] Override http request option.
5497
6724
  * @throws {RequiredError}
5498
6725
  */
5499
- streamRobotControllerState(cell: string, controller: string, responseRate?: number, options?: RawAxiosRequestConfig): AxiosPromise<RobotControllerState>;
6726
+ streamRobotControllerState(cell: string, controller: string, responseRate?: number, addControllerTimeout?: number, options?: RawAxiosRequestConfig): AxiosPromise<RobotControllerState>;
5500
6727
  /**
5501
6728
  * 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.
5502
6729
  * @summary Update Robot Controller
@@ -5580,16 +6807,6 @@ export declare class ControllerApi extends BaseAPI {
5580
6807
  * @memberof ControllerApi
5581
6808
  */
5582
6809
  getCurrentRobotControllerState(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<RobotControllerState, any>>;
5583
- /**
5584
- * 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).
5585
- * @summary Current Mode
5586
- * @param {string} cell Unique identifier addressing a cell in all API calls.
5587
- * @param {string} controller Unique identifier to address a controller in the cell.
5588
- * @param {*} [options] Override http request option.
5589
- * @throws {RequiredError}
5590
- * @memberof ControllerApi
5591
- */
5592
- getMode(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetModeResponse, any>>;
5593
6810
  /**
5594
6811
  * Get the configuration for a robot controller.
5595
6812
  * @summary Robot Controller
@@ -5631,7 +6848,7 @@ export declare class ControllerApi extends BaseAPI {
5631
6848
  */
5632
6849
  listRobotControllers(cell: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<string[], any>>;
5633
6850
  /**
5634
- * 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.
6851
+ * 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.
5635
6852
  * @summary Set Default Mode
5636
6853
  * @param {string} cell Unique identifier addressing a cell in all API calls.
5637
6854
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -5653,16 +6870,17 @@ export declare class ControllerApi extends BaseAPI {
5653
6870
  */
5654
6871
  streamFreeDrive(cell: string, controller: string, responseRate?: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<RobotControllerState, any>>;
5655
6872
  /**
5656
- * <!-- theme: danger --> > Websocket endpoint Receive updates of the state of a robot controller.
6873
+ * <!-- 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.
5657
6874
  * @summary Stream State
5658
6875
  * @param {string} cell Unique identifier addressing a cell in all API calls.
5659
6876
  * @param {string} controller Unique identifier to address a controller in the cell.
5660
6877
  * @param {number} [responseRate]
6878
+ * @param {number} [addControllerTimeout]
5661
6879
  * @param {*} [options] Override http request option.
5662
6880
  * @throws {RequiredError}
5663
6881
  * @memberof ControllerApi
5664
6882
  */
5665
- streamRobotControllerState(cell: string, controller: string, responseRate?: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<RobotControllerState, any>>;
6883
+ streamRobotControllerState(cell: string, controller: string, responseRate?: number, addControllerTimeout?: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<RobotControllerState, any>>;
5666
6884
  /**
5667
6885
  * 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.
5668
6886
  * @summary Update Robot Controller
@@ -5991,6 +7209,15 @@ export declare class JoggingApi extends BaseAPI {
5991
7209
  * @export
5992
7210
  */
5993
7211
  export declare const KinematicsApiAxiosParamCreator: (configuration?: Configuration) => {
7212
+ /**
7213
+ * Returns the TCP poses for a list of given joint positions.
7214
+ * @summary Forward kinematics
7215
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
7216
+ * @param {ForwardKinematicsRequest} [forwardKinematicsRequest]
7217
+ * @param {*} [options] Override http request option.
7218
+ * @throws {RequiredError}
7219
+ */
7220
+ forwardKinematics: (cell: string, forwardKinematicsRequest?: ForwardKinematicsRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
5994
7221
  /**
5995
7222
  * Returns the reachable joint positions for a list of given poses.
5996
7223
  * @summary Inverse kinematics
@@ -6006,6 +7233,15 @@ export declare const KinematicsApiAxiosParamCreator: (configuration?: Configurat
6006
7233
  * @export
6007
7234
  */
6008
7235
  export declare const KinematicsApiFp: (configuration?: Configuration) => {
7236
+ /**
7237
+ * Returns the TCP poses for a list of given joint positions.
7238
+ * @summary Forward kinematics
7239
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
7240
+ * @param {ForwardKinematicsRequest} [forwardKinematicsRequest]
7241
+ * @param {*} [options] Override http request option.
7242
+ * @throws {RequiredError}
7243
+ */
7244
+ forwardKinematics(cell: string, forwardKinematicsRequest?: ForwardKinematicsRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ForwardKinematicsResponse>>;
6009
7245
  /**
6010
7246
  * Returns the reachable joint positions for a list of given poses.
6011
7247
  * @summary Inverse kinematics
@@ -6021,6 +7257,15 @@ export declare const KinematicsApiFp: (configuration?: Configuration) => {
6021
7257
  * @export
6022
7258
  */
6023
7259
  export declare const KinematicsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
7260
+ /**
7261
+ * Returns the TCP poses for a list of given joint positions.
7262
+ * @summary Forward kinematics
7263
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
7264
+ * @param {ForwardKinematicsRequest} [forwardKinematicsRequest]
7265
+ * @param {*} [options] Override http request option.
7266
+ * @throws {RequiredError}
7267
+ */
7268
+ forwardKinematics(cell: string, forwardKinematicsRequest?: ForwardKinematicsRequest, options?: RawAxiosRequestConfig): AxiosPromise<ForwardKinematicsResponse>;
6024
7269
  /**
6025
7270
  * Returns the reachable joint positions for a list of given poses.
6026
7271
  * @summary Inverse kinematics
@@ -6038,6 +7283,16 @@ export declare const KinematicsApiFactory: (configuration?: Configuration, baseP
6038
7283
  * @extends {BaseAPI}
6039
7284
  */
6040
7285
  export declare class KinematicsApi extends BaseAPI {
7286
+ /**
7287
+ * Returns the TCP poses for a list of given joint positions.
7288
+ * @summary Forward kinematics
7289
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
7290
+ * @param {ForwardKinematicsRequest} [forwardKinematicsRequest]
7291
+ * @param {*} [options] Override http request option.
7292
+ * @throws {RequiredError}
7293
+ * @memberof KinematicsApi
7294
+ */
7295
+ forwardKinematics(cell: string, forwardKinematicsRequest?: ForwardKinematicsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ForwardKinematicsResponse, any>>;
6041
7296
  /**
6042
7297
  * Returns the reachable joint positions for a list of given poses.
6043
7298
  * @summary Inverse kinematics
@@ -6999,184 +8254,184 @@ export declare class StoreCollisionComponentsApi extends BaseAPI {
6999
8254
  }, any>>;
7000
8255
  }
7001
8256
  /**
7002
- * StoreCollisionScenesApi - axios parameter creator
8257
+ * StoreCollisionSetupsApi - axios parameter creator
7003
8258
  * @export
7004
8259
  */
7005
- export declare const StoreCollisionScenesApiAxiosParamCreator: (configuration?: Configuration) => {
8260
+ export declare const StoreCollisionSetupsApiAxiosParamCreator: (configuration?: Configuration) => {
7006
8261
  /**
7007
- * Deletes the stored scene. <!-- theme: danger --> > This will delete persistently stored data.
7008
- * @summary Delete Scene
8262
+ * Deletes the stored collision setup. <!-- theme: danger --> > This will delete persistently stored data.
8263
+ * @summary Delete Collision Setup
7009
8264
  * @param {string} cell Unique identifier addressing a cell in all API calls.
7010
- * @param {string} scene Unique identifier addressing a collision scene.
8265
+ * @param {string} setup Identifier of the collision setup
7011
8266
  * @param {*} [options] Override http request option.
7012
8267
  * @throws {RequiredError}
7013
8268
  */
7014
- deleteStoredCollisionScene: (cell: string, scene: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
8269
+ deleteStoredCollisionSetup: (cell: string, setup: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
7015
8270
  /**
7016
- * Returns the stored scene.
7017
- * @summary Get Scene
8271
+ * Returns the stored collision setup.
8272
+ * @summary Get Collision Setup
7018
8273
  * @param {string} cell Unique identifier addressing a cell in all API calls.
7019
- * @param {string} scene Unique identifier addressing a collision scene.
8274
+ * @param {string} setup Identifier of the collision setup
7020
8275
  * @param {*} [options] Override http request option.
7021
8276
  * @throws {RequiredError}
7022
8277
  */
7023
- getStoredCollisionScene: (cell: string, scene: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
8278
+ getStoredCollisionSetup: (cell: string, setup: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
7024
8279
  /**
7025
- * Returns a list of stored scenes.
7026
- * @summary List Scenes
8280
+ * Returns a list of stored collision setups.
8281
+ * @summary List Collision Setups
7027
8282
  * @param {string} cell Unique identifier addressing a cell in all API calls.
7028
8283
  * @param {*} [options] Override http request option.
7029
8284
  * @throws {RequiredError}
7030
8285
  */
7031
- listStoredCollisionScenes: (cell: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
8286
+ listStoredCollisionSetups: (cell: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
7032
8287
  /**
7033
- * 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.
7034
- * @summary Store Scene
8288
+ * Stores collision setup. If the collision setup does not exist, it will be created. If the collision setup exists, it will be updated.
8289
+ * @summary Store Collision Setup
7035
8290
  * @param {string} cell Unique identifier addressing a cell in all API calls.
7036
- * @param {string} scene Unique identifier addressing a collision scene.
7037
- * @param {CollisionSceneAssembly} collisionSceneAssembly
8291
+ * @param {string} setup Identifier of the collision setup
8292
+ * @param {CollisionSetup} collisionSetup
7038
8293
  * @param {*} [options] Override http request option.
7039
8294
  * @throws {RequiredError}
7040
8295
  */
7041
- storeCollisionScene: (cell: string, scene: string, collisionSceneAssembly: CollisionSceneAssembly, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
8296
+ storeCollisionSetup: (cell: string, setup: string, collisionSetup: CollisionSetup, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
7042
8297
  };
7043
8298
  /**
7044
- * StoreCollisionScenesApi - functional programming interface
8299
+ * StoreCollisionSetupsApi - functional programming interface
7045
8300
  * @export
7046
8301
  */
7047
- export declare const StoreCollisionScenesApiFp: (configuration?: Configuration) => {
8302
+ export declare const StoreCollisionSetupsApiFp: (configuration?: Configuration) => {
7048
8303
  /**
7049
- * Deletes the stored scene. <!-- theme: danger --> > This will delete persistently stored data.
7050
- * @summary Delete Scene
8304
+ * Deletes the stored collision setup. <!-- theme: danger --> > This will delete persistently stored data.
8305
+ * @summary Delete Collision Setup
7051
8306
  * @param {string} cell Unique identifier addressing a cell in all API calls.
7052
- * @param {string} scene Unique identifier addressing a collision scene.
8307
+ * @param {string} setup Identifier of the collision setup
7053
8308
  * @param {*} [options] Override http request option.
7054
8309
  * @throws {RequiredError}
7055
8310
  */
7056
- deleteStoredCollisionScene(cell: string, scene: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
8311
+ deleteStoredCollisionSetup(cell: string, setup: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
7057
8312
  /**
7058
- * Returns the stored scene.
7059
- * @summary Get Scene
8313
+ * Returns the stored collision setup.
8314
+ * @summary Get Collision Setup
7060
8315
  * @param {string} cell Unique identifier addressing a cell in all API calls.
7061
- * @param {string} scene Unique identifier addressing a collision scene.
8316
+ * @param {string} setup Identifier of the collision setup
7062
8317
  * @param {*} [options] Override http request option.
7063
8318
  * @throws {RequiredError}
7064
8319
  */
7065
- getStoredCollisionScene(cell: string, scene: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CollisionScene>>;
8320
+ getStoredCollisionSetup(cell: string, setup: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CollisionSetup>>;
7066
8321
  /**
7067
- * Returns a list of stored scenes.
7068
- * @summary List Scenes
8322
+ * Returns a list of stored collision setups.
8323
+ * @summary List Collision Setups
7069
8324
  * @param {string} cell Unique identifier addressing a cell in all API calls.
7070
8325
  * @param {*} [options] Override http request option.
7071
8326
  * @throws {RequiredError}
7072
8327
  */
7073
- listStoredCollisionScenes(cell: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<{
7074
- [key: string]: CollisionScene;
8328
+ listStoredCollisionSetups(cell: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<{
8329
+ [key: string]: CollisionSetup;
7075
8330
  }>>;
7076
8331
  /**
7077
- * 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.
7078
- * @summary Store Scene
8332
+ * Stores collision setup. If the collision setup does not exist, it will be created. If the collision setup exists, it will be updated.
8333
+ * @summary Store Collision Setup
7079
8334
  * @param {string} cell Unique identifier addressing a cell in all API calls.
7080
- * @param {string} scene Unique identifier addressing a collision scene.
7081
- * @param {CollisionSceneAssembly} collisionSceneAssembly
8335
+ * @param {string} setup Identifier of the collision setup
8336
+ * @param {CollisionSetup} collisionSetup
7082
8337
  * @param {*} [options] Override http request option.
7083
8338
  * @throws {RequiredError}
7084
8339
  */
7085
- storeCollisionScene(cell: string, scene: string, collisionSceneAssembly: CollisionSceneAssembly, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CollisionScene>>;
8340
+ storeCollisionSetup(cell: string, setup: string, collisionSetup: CollisionSetup, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CollisionSetup>>;
7086
8341
  };
7087
8342
  /**
7088
- * StoreCollisionScenesApi - factory interface
8343
+ * StoreCollisionSetupsApi - factory interface
7089
8344
  * @export
7090
8345
  */
7091
- export declare const StoreCollisionScenesApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
8346
+ export declare const StoreCollisionSetupsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
7092
8347
  /**
7093
- * Deletes the stored scene. <!-- theme: danger --> > This will delete persistently stored data.
7094
- * @summary Delete Scene
8348
+ * Deletes the stored collision setup. <!-- theme: danger --> > This will delete persistently stored data.
8349
+ * @summary Delete Collision Setup
7095
8350
  * @param {string} cell Unique identifier addressing a cell in all API calls.
7096
- * @param {string} scene Unique identifier addressing a collision scene.
8351
+ * @param {string} setup Identifier of the collision setup
7097
8352
  * @param {*} [options] Override http request option.
7098
8353
  * @throws {RequiredError}
7099
8354
  */
7100
- deleteStoredCollisionScene(cell: string, scene: string, options?: RawAxiosRequestConfig): AxiosPromise<void>;
8355
+ deleteStoredCollisionSetup(cell: string, setup: string, options?: RawAxiosRequestConfig): AxiosPromise<void>;
7101
8356
  /**
7102
- * Returns the stored scene.
7103
- * @summary Get Scene
8357
+ * Returns the stored collision setup.
8358
+ * @summary Get Collision Setup
7104
8359
  * @param {string} cell Unique identifier addressing a cell in all API calls.
7105
- * @param {string} scene Unique identifier addressing a collision scene.
8360
+ * @param {string} setup Identifier of the collision setup
7106
8361
  * @param {*} [options] Override http request option.
7107
8362
  * @throws {RequiredError}
7108
8363
  */
7109
- getStoredCollisionScene(cell: string, scene: string, options?: RawAxiosRequestConfig): AxiosPromise<CollisionScene>;
8364
+ getStoredCollisionSetup(cell: string, setup: string, options?: RawAxiosRequestConfig): AxiosPromise<CollisionSetup>;
7110
8365
  /**
7111
- * Returns a list of stored scenes.
7112
- * @summary List Scenes
8366
+ * Returns a list of stored collision setups.
8367
+ * @summary List Collision Setups
7113
8368
  * @param {string} cell Unique identifier addressing a cell in all API calls.
7114
8369
  * @param {*} [options] Override http request option.
7115
8370
  * @throws {RequiredError}
7116
8371
  */
7117
- listStoredCollisionScenes(cell: string, options?: RawAxiosRequestConfig): AxiosPromise<{
7118
- [key: string]: CollisionScene;
8372
+ listStoredCollisionSetups(cell: string, options?: RawAxiosRequestConfig): AxiosPromise<{
8373
+ [key: string]: CollisionSetup;
7119
8374
  }>;
7120
8375
  /**
7121
- * 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.
7122
- * @summary Store Scene
8376
+ * Stores collision setup. If the collision setup does not exist, it will be created. If the collision setup exists, it will be updated.
8377
+ * @summary Store Collision Setup
7123
8378
  * @param {string} cell Unique identifier addressing a cell in all API calls.
7124
- * @param {string} scene Unique identifier addressing a collision scene.
7125
- * @param {CollisionSceneAssembly} collisionSceneAssembly
8379
+ * @param {string} setup Identifier of the collision setup
8380
+ * @param {CollisionSetup} collisionSetup
7126
8381
  * @param {*} [options] Override http request option.
7127
8382
  * @throws {RequiredError}
7128
8383
  */
7129
- storeCollisionScene(cell: string, scene: string, collisionSceneAssembly: CollisionSceneAssembly, options?: RawAxiosRequestConfig): AxiosPromise<CollisionScene>;
8384
+ storeCollisionSetup(cell: string, setup: string, collisionSetup: CollisionSetup, options?: RawAxiosRequestConfig): AxiosPromise<CollisionSetup>;
7130
8385
  };
7131
8386
  /**
7132
- * StoreCollisionScenesApi - object-oriented interface
8387
+ * StoreCollisionSetupsApi - object-oriented interface
7133
8388
  * @export
7134
- * @class StoreCollisionScenesApi
8389
+ * @class StoreCollisionSetupsApi
7135
8390
  * @extends {BaseAPI}
7136
8391
  */
7137
- export declare class StoreCollisionScenesApi extends BaseAPI {
8392
+ export declare class StoreCollisionSetupsApi extends BaseAPI {
7138
8393
  /**
7139
- * Deletes the stored scene. <!-- theme: danger --> > This will delete persistently stored data.
7140
- * @summary Delete Scene
8394
+ * Deletes the stored collision setup. <!-- theme: danger --> > This will delete persistently stored data.
8395
+ * @summary Delete Collision Setup
7141
8396
  * @param {string} cell Unique identifier addressing a cell in all API calls.
7142
- * @param {string} scene Unique identifier addressing a collision scene.
8397
+ * @param {string} setup Identifier of the collision setup
7143
8398
  * @param {*} [options] Override http request option.
7144
8399
  * @throws {RequiredError}
7145
- * @memberof StoreCollisionScenesApi
8400
+ * @memberof StoreCollisionSetupsApi
7146
8401
  */
7147
- deleteStoredCollisionScene(cell: string, scene: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
8402
+ deleteStoredCollisionSetup(cell: string, setup: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
7148
8403
  /**
7149
- * Returns the stored scene.
7150
- * @summary Get Scene
8404
+ * Returns the stored collision setup.
8405
+ * @summary Get Collision Setup
7151
8406
  * @param {string} cell Unique identifier addressing a cell in all API calls.
7152
- * @param {string} scene Unique identifier addressing a collision scene.
8407
+ * @param {string} setup Identifier of the collision setup
7153
8408
  * @param {*} [options] Override http request option.
7154
8409
  * @throws {RequiredError}
7155
- * @memberof StoreCollisionScenesApi
8410
+ * @memberof StoreCollisionSetupsApi
7156
8411
  */
7157
- getStoredCollisionScene(cell: string, scene: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CollisionScene, any>>;
8412
+ getStoredCollisionSetup(cell: string, setup: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CollisionSetup, any>>;
7158
8413
  /**
7159
- * Returns a list of stored scenes.
7160
- * @summary List Scenes
8414
+ * Returns a list of stored collision setups.
8415
+ * @summary List Collision Setups
7161
8416
  * @param {string} cell Unique identifier addressing a cell in all API calls.
7162
8417
  * @param {*} [options] Override http request option.
7163
8418
  * @throws {RequiredError}
7164
- * @memberof StoreCollisionScenesApi
8419
+ * @memberof StoreCollisionSetupsApi
7165
8420
  */
7166
- listStoredCollisionScenes(cell: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<{
7167
- [key: string]: CollisionScene;
8421
+ listStoredCollisionSetups(cell: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<{
8422
+ [key: string]: CollisionSetup;
7168
8423
  }, any>>;
7169
8424
  /**
7170
- * 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.
7171
- * @summary Store Scene
8425
+ * Stores collision setup. If the collision setup does not exist, it will be created. If the collision setup exists, it will be updated.
8426
+ * @summary Store Collision Setup
7172
8427
  * @param {string} cell Unique identifier addressing a cell in all API calls.
7173
- * @param {string} scene Unique identifier addressing a collision scene.
7174
- * @param {CollisionSceneAssembly} collisionSceneAssembly
8428
+ * @param {string} setup Identifier of the collision setup
8429
+ * @param {CollisionSetup} collisionSetup
7175
8430
  * @param {*} [options] Override http request option.
7176
8431
  * @throws {RequiredError}
7177
- * @memberof StoreCollisionScenesApi
8432
+ * @memberof StoreCollisionSetupsApi
7178
8433
  */
7179
- storeCollisionScene(cell: string, scene: string, collisionSceneAssembly: CollisionSceneAssembly, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CollisionScene, any>>;
8434
+ storeCollisionSetup(cell: string, setup: string, collisionSetup: CollisionSetup, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CollisionSetup, any>>;
7180
8435
  }
7181
8436
  /**
7182
8437
  * StoreObjectApi - axios parameter creator
@@ -7440,14 +8695,14 @@ export declare class StoreObjectApi extends BaseAPI {
7440
8695
  */
7441
8696
  export declare const SystemApiAxiosParamCreator: (configuration?: Configuration) => {
7442
8697
  /**
7443
- * Retrieves a configuration backup based on provided resource identifiers.
8698
+ * 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.
7444
8699
  * @summary Retrieve Configuration Backup
7445
- * @param {Array<string>} resources List of resource identifiers to included in the backup and restore operations.
8700
+ * @param {Array<string>} [resources] List of resource identifiers to include in the retrieval.
7446
8701
  * @param {{ [key: string]: string; }} [metadata] Additional metadata to add to the backup
7447
8702
  * @param {*} [options] Override http request option.
7448
8703
  * @throws {RequiredError}
7449
8704
  */
7450
- backupConfiguration: (resources: Array<string>, metadata?: {
8705
+ backupConfiguration: (resources?: Array<string>, metadata?: {
7451
8706
  [key: string]: string;
7452
8707
  }, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
7453
8708
  /**
@@ -7518,14 +8773,14 @@ export declare const SystemApiAxiosParamCreator: (configuration?: Configuration)
7518
8773
  */
7519
8774
  export declare const SystemApiFp: (configuration?: Configuration) => {
7520
8775
  /**
7521
- * Retrieves a configuration backup based on provided resource identifiers.
8776
+ * 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.
7522
8777
  * @summary Retrieve Configuration Backup
7523
- * @param {Array<string>} resources List of resource identifiers to included in the backup and restore operations.
8778
+ * @param {Array<string>} [resources] List of resource identifiers to include in the retrieval.
7524
8779
  * @param {{ [key: string]: string; }} [metadata] Additional metadata to add to the backup
7525
8780
  * @param {*} [options] Override http request option.
7526
8781
  * @throws {RequiredError}
7527
8782
  */
7528
- backupConfiguration(resources: Array<string>, metadata?: {
8783
+ backupConfiguration(resources?: Array<string>, metadata?: {
7529
8784
  [key: string]: string;
7530
8785
  }, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<File>>;
7531
8786
  /**
@@ -7596,14 +8851,14 @@ export declare const SystemApiFp: (configuration?: Configuration) => {
7596
8851
  */
7597
8852
  export declare const SystemApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
7598
8853
  /**
7599
- * Retrieves a configuration backup based on provided resource identifiers.
8854
+ * 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.
7600
8855
  * @summary Retrieve Configuration Backup
7601
- * @param {Array<string>} resources List of resource identifiers to included in the backup and restore operations.
8856
+ * @param {Array<string>} [resources] List of resource identifiers to include in the retrieval.
7602
8857
  * @param {{ [key: string]: string; }} [metadata] Additional metadata to add to the backup
7603
8858
  * @param {*} [options] Override http request option.
7604
8859
  * @throws {RequiredError}
7605
8860
  */
7606
- backupConfiguration(resources: Array<string>, metadata?: {
8861
+ backupConfiguration(resources?: Array<string>, metadata?: {
7607
8862
  [key: string]: string;
7608
8863
  }, options?: RawAxiosRequestConfig): AxiosPromise<File>;
7609
8864
  /**
@@ -7676,15 +8931,15 @@ export declare const SystemApiFactory: (configuration?: Configuration, basePath?
7676
8931
  */
7677
8932
  export declare class SystemApi extends BaseAPI {
7678
8933
  /**
7679
- * Retrieves a configuration backup based on provided resource identifiers.
8934
+ * 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.
7680
8935
  * @summary Retrieve Configuration Backup
7681
- * @param {Array<string>} resources List of resource identifiers to included in the backup and restore operations.
8936
+ * @param {Array<string>} [resources] List of resource identifiers to include in the retrieval.
7682
8937
  * @param {{ [key: string]: string; }} [metadata] Additional metadata to add to the backup
7683
8938
  * @param {*} [options] Override http request option.
7684
8939
  * @throws {RequiredError}
7685
8940
  * @memberof SystemApi
7686
8941
  */
7687
- backupConfiguration(resources: Array<string>, metadata?: {
8942
+ backupConfiguration(resources?: Array<string>, metadata?: {
7688
8943
  [key: string]: string;
7689
8944
  }, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<File, any>>;
7690
8945
  /**
@@ -8052,6 +9307,15 @@ export declare class TrajectoryExecutionApi extends BaseAPI {
8052
9307
  * @export
8053
9308
  */
8054
9309
  export declare const TrajectoryPlanningApiAxiosParamCreator: (configuration?: Configuration) => {
9310
+ /**
9311
+ * 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.
9312
+ * @summary Plan Collision-Free Trajectory
9313
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
9314
+ * @param {PlanCollisionFreeRequest} [planCollisionFreeRequest]
9315
+ * @param {*} [options] Override http request option.
9316
+ * @throws {RequiredError}
9317
+ */
9318
+ planCollisionFree: (cell: string, planCollisionFreeRequest?: PlanCollisionFreeRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
8055
9319
  /**
8056
9320
  * 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.
8057
9321
  * @summary Plan Trajectory
@@ -8067,6 +9331,15 @@ export declare const TrajectoryPlanningApiAxiosParamCreator: (configuration?: Co
8067
9331
  * @export
8068
9332
  */
8069
9333
  export declare const TrajectoryPlanningApiFp: (configuration?: Configuration) => {
9334
+ /**
9335
+ * 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.
9336
+ * @summary Plan Collision-Free Trajectory
9337
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
9338
+ * @param {PlanCollisionFreeRequest} [planCollisionFreeRequest]
9339
+ * @param {*} [options] Override http request option.
9340
+ * @throws {RequiredError}
9341
+ */
9342
+ planCollisionFree(cell: string, planCollisionFreeRequest?: PlanCollisionFreeRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PlanCollisionFreeResponse>>;
8070
9343
  /**
8071
9344
  * 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.
8072
9345
  * @summary Plan Trajectory
@@ -8082,6 +9355,15 @@ export declare const TrajectoryPlanningApiFp: (configuration?: Configuration) =>
8082
9355
  * @export
8083
9356
  */
8084
9357
  export declare const TrajectoryPlanningApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
9358
+ /**
9359
+ * 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.
9360
+ * @summary Plan Collision-Free Trajectory
9361
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
9362
+ * @param {PlanCollisionFreeRequest} [planCollisionFreeRequest]
9363
+ * @param {*} [options] Override http request option.
9364
+ * @throws {RequiredError}
9365
+ */
9366
+ planCollisionFree(cell: string, planCollisionFreeRequest?: PlanCollisionFreeRequest, options?: RawAxiosRequestConfig): AxiosPromise<PlanCollisionFreeResponse>;
8085
9367
  /**
8086
9368
  * 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.
8087
9369
  * @summary Plan Trajectory
@@ -8099,6 +9381,16 @@ export declare const TrajectoryPlanningApiFactory: (configuration?: Configuratio
8099
9381
  * @extends {BaseAPI}
8100
9382
  */
8101
9383
  export declare class TrajectoryPlanningApi extends BaseAPI {
9384
+ /**
9385
+ * 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.
9386
+ * @summary Plan Collision-Free Trajectory
9387
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
9388
+ * @param {PlanCollisionFreeRequest} [planCollisionFreeRequest]
9389
+ * @param {*} [options] Override http request option.
9390
+ * @throws {RequiredError}
9391
+ * @memberof TrajectoryPlanningApi
9392
+ */
9393
+ planCollisionFree(cell: string, planCollisionFreeRequest?: PlanCollisionFreeRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<PlanCollisionFreeResponse, any>>;
8102
9394
  /**
8103
9395
  * 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.
8104
9396
  * @summary Plan Trajectory