@wandelbots/nova-api 25.7.0-dev.9 → 25.7.0-rc.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}
@@ -495,13 +501,13 @@ export interface Collision {
495
501
  * @type {string}
496
502
  * @memberof Collision
497
503
  */
498
- 'id_of_world'?: string;
504
+ 'id_of_layer'?: string;
499
505
  /**
500
506
  * A three-dimensional vector [x, y, z] with double precision.
501
507
  * @type {Array<number>}
502
508
  * @memberof Collision
503
509
  */
504
- 'normal_world_on_b'?: Array<number>;
510
+ 'normal_root_on_b'?: Array<number>;
505
511
  /**
506
512
  *
507
513
  * @type {CollisionContact}
@@ -532,7 +538,7 @@ export interface CollisionContact {
532
538
  * @type {Array<number>}
533
539
  * @memberof CollisionContact
534
540
  */
535
- 'world'?: Array<number>;
541
+ 'root'?: Array<number>;
536
542
  }
537
543
  /**
538
544
  *
@@ -548,50 +554,29 @@ export interface CollisionError {
548
554
  'collision'?: FeedbackCollision;
549
555
  }
550
556
  /**
551
- *
557
+ * @type CollisionFreeAlgorithm
558
+ * Configuration for collision-free path planning algorithms. Different algorithms may have different parameters and behavior.
552
559
  * @export
553
- * @interface CollisionMotionGroup
554
560
  */
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
- }
561
+ export type CollisionFreeAlgorithm = MidpointInsertionAlgorithm | RRTConnectAlgorithm;
573
562
  /**
574
563
  *
575
564
  * @export
576
- * @interface CollisionMotionGroupAssembly
565
+ * @interface CollisionSetup
577
566
  */
578
- export interface CollisionMotionGroupAssembly {
579
- /**
580
- * References a stored link chain.
581
- * @type {string}
582
- * @memberof CollisionMotionGroupAssembly
583
- */
584
- 'stored_link_chain'?: string;
567
+ export interface CollisionSetup {
585
568
  /**
586
- * References a stored tool.
587
- * @type {string}
588
- * @memberof CollisionMotionGroupAssembly
569
+ * A collection of identifiable colliders.
570
+ * @type {{ [key: string]: Collider; }}
571
+ * @memberof CollisionSetup
589
572
  */
590
- 'stored_tool'?: string;
573
+ 'colliders'?: {
574
+ [key: string]: Collider;
575
+ };
591
576
  /**
592
577
  * 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
578
  * @type {Array<{ [key: string]: Collider; }>}
594
- * @memberof CollisionMotionGroupAssembly
579
+ * @memberof CollisionSetup
595
580
  */
596
581
  'link_chain'?: Array<{
597
582
  [key: string]: Collider;
@@ -599,75 +584,17 @@ export interface CollisionMotionGroupAssembly {
599
584
  /**
600
585
  * 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
586
  * @type {{ [key: string]: Collider; }}
602
- * @memberof CollisionMotionGroupAssembly
587
+ * @memberof CollisionSetup
603
588
  */
604
589
  'tool'?: {
605
590
  [key: string]: Collider;
606
591
  };
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
592
  /**
615
- * A collection of identifiable colliders.
616
- * @type {{ [key: string]: Collider; }}
617
- * @memberof CollisionScene
618
- */
619
- 'colliders'?: {
620
- [key: string]: Collider;
621
- };
622
- /**
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
593
+ * 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.
594
+ * @type {boolean}
595
+ * @memberof CollisionSetup
667
596
  */
668
- 'motion_groups'?: {
669
- [key: string]: CollisionMotionGroupAssembly;
670
- };
597
+ 'self_collision_detection'?: boolean;
671
598
  }
672
599
  /**
673
600
  * 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 +767,25 @@ export interface ContainerImageSecretsInner {
840
767
  */
841
768
  'name': string;
842
769
  }
770
+ /**
771
+ * Additional resources that the application requires.
772
+ * @export
773
+ * @interface ContainerResources
774
+ */
775
+ export interface ContainerResources {
776
+ /**
777
+ * Number of GPUs the application requires.
778
+ * @type {number}
779
+ * @memberof ContainerResources
780
+ */
781
+ 'intel_gpu'?: number;
782
+ /**
783
+ * The maximum memory allocated to this application.
784
+ * @type {string}
785
+ * @memberof ContainerResources
786
+ */
787
+ 'memory_limit'?: string;
788
+ }
843
789
  /**
844
790
  * 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
791
  * @export
@@ -1102,22 +1048,115 @@ export declare const Direction: {
1102
1048
  };
1103
1049
  export type Direction = typeof Direction[keyof typeof Direction];
1104
1050
  /**
1105
- *
1051
+ * The provided joint data does not match the expected number of joints for this motion group.
1106
1052
  * @export
1107
- * @interface EndOfTrajectory
1053
+ * @interface ErrorInvalidJointCount
1108
1054
  */
1109
- export interface EndOfTrajectory {
1055
+ export interface ErrorInvalidJointCount {
1056
+ /**
1057
+ * The expected number of joints for this motion group.
1058
+ * @type {number}
1059
+ * @memberof ErrorInvalidJointCount
1060
+ */
1061
+ 'expected_joint_count': number;
1062
+ /**
1063
+ * The number of provided joints.
1064
+ * @type {number}
1065
+ * @memberof ErrorInvalidJointCount
1066
+ */
1067
+ 'provided_joint_count': number;
1110
1068
  /**
1111
1069
  *
1112
1070
  * @type {string}
1113
- * @memberof EndOfTrajectory
1071
+ * @memberof ErrorInvalidJointCount
1114
1072
  */
1115
- 'kind': EndOfTrajectoryKindEnum;
1073
+ 'error_feedback_name': ErrorInvalidJointCountErrorFeedbackNameEnum;
1116
1074
  }
1117
- export declare const EndOfTrajectoryKindEnum: {
1118
- readonly EndOfTrajectory: "END_OF_TRAJECTORY";
1075
+ export declare const ErrorInvalidJointCountErrorFeedbackNameEnum: {
1076
+ readonly ErrorInvalidJointCount: "ErrorInvalidJointCount";
1077
+ };
1078
+ export type ErrorInvalidJointCountErrorFeedbackNameEnum = typeof ErrorInvalidJointCountErrorFeedbackNameEnum[keyof typeof ErrorInvalidJointCountErrorFeedbackNameEnum];
1079
+ /**
1080
+ * A reference joint position (start or target) exceeds the configured joint limits.
1081
+ * @export
1082
+ * @interface ErrorJointLimitExceeded
1083
+ */
1084
+ export interface ErrorJointLimitExceeded {
1085
+ /**
1086
+ * Index of the joint exceeding its limits (0-based).
1087
+ * @type {number}
1088
+ * @memberof ErrorJointLimitExceeded
1089
+ */
1090
+ 'joint_index'?: number;
1091
+ /**
1092
+ *
1093
+ * @type {Array<number>}
1094
+ * @memberof ErrorJointLimitExceeded
1095
+ */
1096
+ 'joint_position'?: Array<number>;
1097
+ /**
1098
+ *
1099
+ * @type {string}
1100
+ * @memberof ErrorJointLimitExceeded
1101
+ */
1102
+ 'error_feedback_name': ErrorJointLimitExceededErrorFeedbackNameEnum;
1103
+ }
1104
+ export declare const ErrorJointLimitExceededErrorFeedbackNameEnum: {
1105
+ readonly ErrorJointLimitExceeded: "ErrorJointLimitExceeded";
1106
+ };
1107
+ export type ErrorJointLimitExceededErrorFeedbackNameEnum = typeof ErrorJointLimitExceededErrorFeedbackNameEnum[keyof typeof ErrorJointLimitExceededErrorFeedbackNameEnum];
1108
+ /**
1109
+ * A reference joint position (e.g. start or target joint position) results in collisions that prevent processing.
1110
+ * @export
1111
+ * @interface ErrorJointPositionCollision
1112
+ */
1113
+ export interface ErrorJointPositionCollision {
1114
+ /**
1115
+ *
1116
+ * @type {Array<Collision>}
1117
+ * @memberof ErrorJointPositionCollision
1118
+ */
1119
+ 'collisions'?: Array<Collision>;
1120
+ /**
1121
+ *
1122
+ * @type {Array<number>}
1123
+ * @memberof ErrorJointPositionCollision
1124
+ */
1125
+ 'joint_position'?: Array<number>;
1126
+ /**
1127
+ *
1128
+ * @type {string}
1129
+ * @memberof ErrorJointPositionCollision
1130
+ */
1131
+ 'error_feedback_name': ErrorJointPositionCollisionErrorFeedbackNameEnum;
1132
+ }
1133
+ export declare const ErrorJointPositionCollisionErrorFeedbackNameEnum: {
1134
+ readonly ErrorJointPositionCollision: "ErrorJointPositionCollision";
1135
+ };
1136
+ export type ErrorJointPositionCollisionErrorFeedbackNameEnum = typeof ErrorJointPositionCollisionErrorFeedbackNameEnum[keyof typeof ErrorJointPositionCollisionErrorFeedbackNameEnum];
1137
+ /**
1138
+ * The collision-free planning algorithm reached its maximum iteration limit without finding a valid path. Increase max_iterations or modify the start/target positions.
1139
+ * @export
1140
+ * @interface ErrorMaxIterationsExceeded
1141
+ */
1142
+ export interface ErrorMaxIterationsExceeded {
1143
+ /**
1144
+ * The maximum number of iterations that was reached.
1145
+ * @type {number}
1146
+ * @memberof ErrorMaxIterationsExceeded
1147
+ */
1148
+ 'max_iterations'?: number;
1149
+ /**
1150
+ *
1151
+ * @type {string}
1152
+ * @memberof ErrorMaxIterationsExceeded
1153
+ */
1154
+ 'error_feedback_name': ErrorMaxIterationsExceededErrorFeedbackNameEnum;
1155
+ }
1156
+ export declare const ErrorMaxIterationsExceededErrorFeedbackNameEnum: {
1157
+ readonly ErrorMaxIterationsExceeded: "ErrorMaxIterationsExceeded";
1119
1158
  };
1120
- export type EndOfTrajectoryKindEnum = typeof EndOfTrajectoryKindEnum[keyof typeof EndOfTrajectoryKindEnum];
1159
+ export type ErrorMaxIterationsExceededErrorFeedbackNameEnum = typeof ErrorMaxIterationsExceededErrorFeedbackNameEnum[keyof typeof ErrorMaxIterationsExceededErrorFeedbackNameEnum];
1121
1160
  /**
1122
1161
  * 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
1162
  * @export
@@ -1376,15 +1415,98 @@ export type FloatValueValueTypeEnum = typeof FloatValueValueTypeEnum[keyof typeo
1376
1415
  /**
1377
1416
  *
1378
1417
  * @export
1379
- * @interface GetModeResponse
1418
+ * @interface ForwardKinematics422Response
1380
1419
  */
1381
- export interface GetModeResponse {
1420
+ export interface ForwardKinematics422Response {
1382
1421
  /**
1383
1422
  *
1384
- * @type {RobotSystemMode}
1385
- * @memberof GetModeResponse
1423
+ * @type {Array<ForwardKinematicsValidationError>}
1424
+ * @memberof ForwardKinematics422Response
1386
1425
  */
1387
- 'robot_system_mode': RobotSystemMode;
1426
+ 'detail'?: Array<ForwardKinematicsValidationError>;
1427
+ }
1428
+ /**
1429
+ *
1430
+ * @export
1431
+ * @interface ForwardKinematicsRequest
1432
+ */
1433
+ export interface ForwardKinematicsRequest {
1434
+ /**
1435
+ * String identifiying the model of a motion group.
1436
+ * @type {string}
1437
+ * @memberof ForwardKinematicsRequest
1438
+ */
1439
+ 'motion_group_model': string;
1440
+ /**
1441
+ * List of joint positions [rad] for which TCP poses are computed.
1442
+ * @type {Array<Array<number>>}
1443
+ * @memberof ForwardKinematicsRequest
1444
+ */
1445
+ 'joint_positions': Array<Array<number>>;
1446
+ /**
1447
+ *
1448
+ * @type {Pose}
1449
+ * @memberof ForwardKinematicsRequest
1450
+ */
1451
+ 'tcp_offset'?: Pose;
1452
+ /**
1453
+ * Offset from the world frame to the motion group base.
1454
+ * @type {Pose}
1455
+ * @memberof ForwardKinematicsRequest
1456
+ */
1457
+ 'mounting'?: Pose;
1458
+ }
1459
+ /**
1460
+ *
1461
+ * @export
1462
+ * @interface ForwardKinematicsResponse
1463
+ */
1464
+ export interface ForwardKinematicsResponse {
1465
+ /**
1466
+ * List of computed TCP poses corresponding to the input joint positions.
1467
+ * @type {Array<Pose>}
1468
+ * @memberof ForwardKinematicsResponse
1469
+ */
1470
+ 'tcp_poses': Array<Pose>;
1471
+ }
1472
+ /**
1473
+ *
1474
+ * @export
1475
+ * @interface ForwardKinematicsValidationError
1476
+ */
1477
+ export interface ForwardKinematicsValidationError {
1478
+ /**
1479
+ *
1480
+ * @type {Array<ValidationErrorLocInner>}
1481
+ * @memberof ForwardKinematicsValidationError
1482
+ */
1483
+ 'loc': Array<ValidationErrorLocInner>;
1484
+ /**
1485
+ *
1486
+ * @type {string}
1487
+ * @memberof ForwardKinematicsValidationError
1488
+ */
1489
+ 'msg': string;
1490
+ /**
1491
+ *
1492
+ * @type {string}
1493
+ * @memberof ForwardKinematicsValidationError
1494
+ */
1495
+ 'type': string;
1496
+ /**
1497
+ *
1498
+ * @type {{ [key: string]: any; }}
1499
+ * @memberof ForwardKinematicsValidationError
1500
+ */
1501
+ 'input': {
1502
+ [key: string]: any;
1503
+ };
1504
+ /**
1505
+ *
1506
+ * @type {ErrorInvalidJointCount}
1507
+ * @memberof ForwardKinematicsValidationError
1508
+ */
1509
+ 'data'?: ErrorInvalidJointCount;
1388
1510
  }
1389
1511
  /**
1390
1512
  *
@@ -1877,6 +1999,19 @@ export interface InvalidDofInvalidDof {
1877
1999
  */
1878
2000
  'joint_position'?: Array<number>;
1879
2001
  }
2002
+ /**
2003
+ *
2004
+ * @export
2005
+ * @interface InverseKinematics422Response
2006
+ */
2007
+ export interface InverseKinematics422Response {
2008
+ /**
2009
+ *
2010
+ * @type {Array<InverseKinematicsValidationError>}
2011
+ * @memberof InverseKinematics422Response
2012
+ */
2013
+ 'detail'?: Array<InverseKinematicsValidationError>;
2014
+ }
1880
2015
  /**
1881
2016
  *
1882
2017
  * @export
@@ -1914,12 +2049,12 @@ export interface InverseKinematicsRequest {
1914
2049
  */
1915
2050
  'joint_position_limits'?: Array<LimitRange>;
1916
2051
  /**
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; }}
2052
+ * 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.
2053
+ * @type {{ [key: string]: CollisionSetup; }}
1919
2054
  * @memberof InverseKinematicsRequest
1920
2055
  */
1921
- 'collision_scenes'?: {
1922
- [key: string]: SingleMotionGroupCollisionScene;
2056
+ 'collision_setups'?: {
2057
+ [key: string]: CollisionSetup;
1923
2058
  };
1924
2059
  }
1925
2060
  /**
@@ -1935,6 +2070,55 @@ export interface InverseKinematicsResponse {
1935
2070
  */
1936
2071
  'joints': Array<Array<Array<number>>>;
1937
2072
  }
2073
+ /**
2074
+ *
2075
+ * @export
2076
+ * @interface InverseKinematicsValidationError
2077
+ */
2078
+ export interface InverseKinematicsValidationError {
2079
+ /**
2080
+ *
2081
+ * @type {Array<ValidationErrorLocInner>}
2082
+ * @memberof InverseKinematicsValidationError
2083
+ */
2084
+ 'loc': Array<ValidationErrorLocInner>;
2085
+ /**
2086
+ *
2087
+ * @type {string}
2088
+ * @memberof InverseKinematicsValidationError
2089
+ */
2090
+ 'msg': string;
2091
+ /**
2092
+ *
2093
+ * @type {string}
2094
+ * @memberof InverseKinematicsValidationError
2095
+ */
2096
+ 'type': string;
2097
+ /**
2098
+ *
2099
+ * @type {{ [key: string]: any; }}
2100
+ * @memberof InverseKinematicsValidationError
2101
+ */
2102
+ 'input': {
2103
+ [key: string]: any;
2104
+ };
2105
+ /**
2106
+ *
2107
+ * @type {InverseKinematicsValidationErrorAllOfData}
2108
+ * @memberof InverseKinematicsValidationError
2109
+ */
2110
+ 'data'?: InverseKinematicsValidationErrorAllOfData;
2111
+ }
2112
+ /**
2113
+ * @type InverseKinematicsValidationErrorAllOfData
2114
+ * Optional data further specifying the validation error.
2115
+ * @export
2116
+ */
2117
+ export type InverseKinematicsValidationErrorAllOfData = {
2118
+ error_feedback_name: 'ErrorInvalidJointCount';
2119
+ } & ErrorInvalidJointCount | {
2120
+ error_feedback_name: 'ErrorJointLimitExceeded';
2121
+ } & ErrorJointLimitExceeded;
1938
2122
  /**
1939
2123
  * 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
2124
  * @export
@@ -1962,7 +2146,104 @@ export type JoggingDetailsKindEnum = typeof JoggingDetailsKindEnum[keyof typeof
1962
2146
  * @type JoggingDetailsState
1963
2147
  * @export
1964
2148
  */
1965
- export type JoggingDetailsState = PausedByUser | PausedNearCollision | PausedNearJointLimit | PausedOnIO | Running;
2149
+ export type JoggingDetailsState = JoggingPausedByUser | JoggingPausedNearCollision | JoggingPausedNearJointLimit | JoggingPausedOnIO | JoggingRunning;
2150
+ /**
2151
+ *
2152
+ * @export
2153
+ * @interface JoggingPausedByUser
2154
+ */
2155
+ export interface JoggingPausedByUser {
2156
+ /**
2157
+ *
2158
+ * @type {string}
2159
+ * @memberof JoggingPausedByUser
2160
+ */
2161
+ 'kind': JoggingPausedByUserKindEnum;
2162
+ }
2163
+ export declare const JoggingPausedByUserKindEnum: {
2164
+ readonly PausedByUser: "PAUSED_BY_USER";
2165
+ };
2166
+ export type JoggingPausedByUserKindEnum = typeof JoggingPausedByUserKindEnum[keyof typeof JoggingPausedByUserKindEnum];
2167
+ /**
2168
+ *
2169
+ * @export
2170
+ * @interface JoggingPausedNearCollision
2171
+ */
2172
+ export interface JoggingPausedNearCollision {
2173
+ /**
2174
+ *
2175
+ * @type {string}
2176
+ * @memberof JoggingPausedNearCollision
2177
+ */
2178
+ 'kind': JoggingPausedNearCollisionKindEnum;
2179
+ /**
2180
+ *
2181
+ * @type {string}
2182
+ * @memberof JoggingPausedNearCollision
2183
+ */
2184
+ 'description': string;
2185
+ }
2186
+ export declare const JoggingPausedNearCollisionKindEnum: {
2187
+ readonly PausedNearCollision: "PAUSED_NEAR_COLLISION";
2188
+ };
2189
+ export type JoggingPausedNearCollisionKindEnum = typeof JoggingPausedNearCollisionKindEnum[keyof typeof JoggingPausedNearCollisionKindEnum];
2190
+ /**
2191
+ *
2192
+ * @export
2193
+ * @interface JoggingPausedNearJointLimit
2194
+ */
2195
+ export interface JoggingPausedNearJointLimit {
2196
+ /**
2197
+ *
2198
+ * @type {string}
2199
+ * @memberof JoggingPausedNearJointLimit
2200
+ */
2201
+ 'kind': JoggingPausedNearJointLimitKindEnum;
2202
+ /**
2203
+ *
2204
+ * @type {Array<number>}
2205
+ * @memberof JoggingPausedNearJointLimit
2206
+ */
2207
+ 'joint_indices': Array<number>;
2208
+ }
2209
+ export declare const JoggingPausedNearJointLimitKindEnum: {
2210
+ readonly PausedNearJointLimit: "PAUSED_NEAR_JOINT_LIMIT";
2211
+ };
2212
+ export type JoggingPausedNearJointLimitKindEnum = typeof JoggingPausedNearJointLimitKindEnum[keyof typeof JoggingPausedNearJointLimitKindEnum];
2213
+ /**
2214
+ *
2215
+ * @export
2216
+ * @interface JoggingPausedOnIO
2217
+ */
2218
+ export interface JoggingPausedOnIO {
2219
+ /**
2220
+ *
2221
+ * @type {string}
2222
+ * @memberof JoggingPausedOnIO
2223
+ */
2224
+ 'kind': JoggingPausedOnIOKindEnum;
2225
+ }
2226
+ export declare const JoggingPausedOnIOKindEnum: {
2227
+ readonly PausedOnIo: "PAUSED_ON_IO";
2228
+ };
2229
+ export type JoggingPausedOnIOKindEnum = typeof JoggingPausedOnIOKindEnum[keyof typeof JoggingPausedOnIOKindEnum];
2230
+ /**
2231
+ *
2232
+ * @export
2233
+ * @interface JoggingRunning
2234
+ */
2235
+ export interface JoggingRunning {
2236
+ /**
2237
+ *
2238
+ * @type {string}
2239
+ * @memberof JoggingRunning
2240
+ */
2241
+ 'kind': JoggingRunningKindEnum;
2242
+ }
2243
+ export declare const JoggingRunningKindEnum: {
2244
+ readonly Running: "RUNNING";
2245
+ };
2246
+ export type JoggingRunningKindEnum = typeof JoggingRunningKindEnum[keyof typeof JoggingRunningKindEnum];
1966
2247
  /**
1967
2248
  *
1968
2249
  * @export
@@ -2384,6 +2665,29 @@ export declare const Manufacturer: {
2384
2665
  readonly Yaskawa: "yaskawa";
2385
2666
  };
2386
2667
  export type Manufacturer = typeof Manufacturer[keyof typeof Manufacturer];
2668
+ /**
2669
+ * 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.
2670
+ * @export
2671
+ * @interface MidpointInsertionAlgorithm
2672
+ */
2673
+ export interface MidpointInsertionAlgorithm {
2674
+ /**
2675
+ * Algorithm discriminator.
2676
+ * @type {string}
2677
+ * @memberof MidpointInsertionAlgorithm
2678
+ */
2679
+ 'algorithm_name': MidpointInsertionAlgorithmAlgorithmNameEnum;
2680
+ /**
2681
+ * Maximum number of iterations for the midpoint insertion algorithm. Higher values increase likelyhood of success, but also computation time (linear).
2682
+ * @type {number}
2683
+ * @memberof MidpointInsertionAlgorithm
2684
+ */
2685
+ 'max_iterations'?: number;
2686
+ }
2687
+ export declare const MidpointInsertionAlgorithmAlgorithmNameEnum: {
2688
+ readonly MidpointInsertionAlgorithm: "MidpointInsertionAlgorithm";
2689
+ };
2690
+ export type MidpointInsertionAlgorithmAlgorithmNameEnum = typeof MidpointInsertionAlgorithmAlgorithmNameEnum[keyof typeof MidpointInsertionAlgorithmAlgorithmNameEnum];
2387
2691
  /**
2388
2692
  *
2389
2693
  * @export
@@ -2574,6 +2878,57 @@ export interface MotionGroupJoints {
2574
2878
  */
2575
2879
  'torques'?: Array<number>;
2576
2880
  }
2881
+ /**
2882
+ *
2883
+ * @export
2884
+ * @interface MotionGroupSetup
2885
+ */
2886
+ export interface MotionGroupSetup {
2887
+ /**
2888
+ * String identifiying the model of a motion group.
2889
+ * @type {string}
2890
+ * @memberof MotionGroupSetup
2891
+ */
2892
+ 'motion_group_model': string;
2893
+ /**
2894
+ * [ms] cycle time of the motion group controller. A trajectory for this motion group should be computed to this resolution.
2895
+ * @type {number}
2896
+ * @memberof MotionGroupSetup
2897
+ */
2898
+ 'cycle_time': number;
2899
+ /**
2900
+ * The offset from the world frame to the motion group base.
2901
+ * @type {Pose}
2902
+ * @memberof MotionGroupSetup
2903
+ */
2904
+ 'mounting'?: Pose;
2905
+ /**
2906
+ *
2907
+ * @type {Pose}
2908
+ * @memberof MotionGroupSetup
2909
+ */
2910
+ 'tcp_offset'?: Pose;
2911
+ /**
2912
+ *
2913
+ * @type {LimitSet}
2914
+ * @memberof MotionGroupSetup
2915
+ */
2916
+ 'global_limits'?: LimitSet;
2917
+ /**
2918
+ *
2919
+ * @type {Payload}
2920
+ * @memberof MotionGroupSetup
2921
+ */
2922
+ 'payload'?: Payload;
2923
+ /**
2924
+ * 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.
2925
+ * @type {{ [key: string]: CollisionSetup; }}
2926
+ * @memberof MotionGroupSetup
2927
+ */
2928
+ 'collision_setups'?: {
2929
+ [key: string]: CollisionSetup;
2930
+ };
2931
+ }
2577
2932
  /**
2578
2933
  * Presents the current state of the motion group.
2579
2934
  * @export
@@ -3062,131 +3417,109 @@ export interface PauseOnIO {
3062
3417
  /**
3063
3418
  *
3064
3419
  * @export
3065
- * @interface PausedByRequest
3420
+ * @interface Payload
3066
3421
  */
3067
- export interface PausedByRequest {
3422
+ export interface Payload {
3068
3423
  /**
3069
3424
  *
3070
3425
  * @type {string}
3071
- * @memberof PausedByRequest
3426
+ * @memberof Payload
3072
3427
  */
3073
- 'kind': PausedByRequestKindEnum;
3428
+ 'name': string;
3429
+ /**
3430
+ * Mass of payload in [kg].
3431
+ * @type {number}
3432
+ * @memberof Payload
3433
+ */
3434
+ 'payload': number;
3435
+ /**
3436
+ * A three-dimensional vector [x, y, z] with double precision.
3437
+ * @type {Array<number>}
3438
+ * @memberof Payload
3439
+ */
3440
+ 'center_of_mass'?: Array<number>;
3441
+ /**
3442
+ * A three-dimensional vector [x, y, z] with double precision.
3443
+ * @type {Array<number>}
3444
+ * @memberof Payload
3445
+ */
3446
+ 'moment_of_inertia'?: Array<number>;
3074
3447
  }
3075
- export declare const PausedByRequestKindEnum: {
3076
- readonly PausedByUser: "PAUSED_BY_USER";
3077
- };
3078
- export type PausedByRequestKindEnum = typeof PausedByRequestKindEnum[keyof typeof PausedByRequestKindEnum];
3079
3448
  /**
3080
3449
  *
3081
3450
  * @export
3082
- * @interface PausedByUser
3451
+ * @interface Plan422Response
3083
3452
  */
3084
- export interface PausedByUser {
3453
+ export interface Plan422Response {
3085
3454
  /**
3086
3455
  *
3087
- * @type {string}
3088
- * @memberof PausedByUser
3456
+ * @type {Array<PlanValidationError>}
3457
+ * @memberof Plan422Response
3089
3458
  */
3090
- 'kind': PausedByUserKindEnum;
3459
+ 'detail'?: Array<PlanValidationError>;
3091
3460
  }
3092
- export declare const PausedByUserKindEnum: {
3093
- readonly PausedByUser: "PAUSED_BY_USER";
3094
- };
3095
- export type PausedByUserKindEnum = typeof PausedByUserKindEnum[keyof typeof PausedByUserKindEnum];
3096
3461
  /**
3097
- *
3462
+ * Response when collision-free trajectory planning fails. Contains specific feedback about why the planning failed.
3098
3463
  * @export
3099
- * @interface PausedNearCollision
3464
+ * @interface PlanCollisionFreeFailedResponse
3100
3465
  */
3101
- export interface PausedNearCollision {
3102
- /**
3103
- *
3104
- * @type {string}
3105
- * @memberof PausedNearCollision
3106
- */
3107
- 'kind': PausedNearCollisionKindEnum;
3466
+ export interface PlanCollisionFreeFailedResponse {
3108
3467
  /**
3109
3468
  *
3110
- * @type {string}
3111
- * @memberof PausedNearCollision
3469
+ * @type {ErrorMaxIterationsExceeded}
3470
+ * @memberof PlanCollisionFreeFailedResponse
3112
3471
  */
3113
- 'description': string;
3472
+ 'error_feedback': ErrorMaxIterationsExceeded;
3114
3473
  }
3115
- export declare const PausedNearCollisionKindEnum: {
3116
- readonly PausedNearCollision: "PAUSED_NEAR_COLLISION";
3117
- };
3118
- export type PausedNearCollisionKindEnum = typeof PausedNearCollisionKindEnum[keyof typeof PausedNearCollisionKindEnum];
3119
3474
  /**
3120
3475
  *
3121
3476
  * @export
3122
- * @interface PausedNearJointLimit
3477
+ * @interface PlanCollisionFreeRequest
3123
3478
  */
3124
- export interface PausedNearJointLimit {
3479
+ export interface PlanCollisionFreeRequest {
3480
+ /**
3481
+ * The data to assemble the robot setup can be retrieved from [getMotionGroupDescription](getMotionGroupDescription) endpoint.
3482
+ * @type {MotionGroupSetup}
3483
+ * @memberof PlanCollisionFreeRequest
3484
+ */
3485
+ 'motion_group_setup': MotionGroupSetup;
3125
3486
  /**
3126
3487
  *
3127
- * @type {string}
3128
- * @memberof PausedNearJointLimit
3488
+ * @type {Array<number>}
3489
+ * @memberof PlanCollisionFreeRequest
3129
3490
  */
3130
- 'kind': PausedNearJointLimitKindEnum;
3491
+ 'start_joint_position': Array<number>;
3131
3492
  /**
3132
3493
  *
3133
3494
  * @type {Array<number>}
3134
- * @memberof PausedNearJointLimit
3495
+ * @memberof PlanCollisionFreeRequest
3135
3496
  */
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 {
3497
+ 'target': Array<number>;
3148
3498
  /**
3149
3499
  *
3150
- * @type {string}
3151
- * @memberof PausedOnIO
3500
+ * @type {CollisionFreeAlgorithm}
3501
+ * @memberof PlanCollisionFreeRequest
3152
3502
  */
3153
- 'kind': PausedOnIOKindEnum;
3503
+ 'algorithm': CollisionFreeAlgorithm;
3154
3504
  }
3155
- export declare const PausedOnIOKindEnum: {
3156
- readonly PausedOnIo: "PAUSED_ON_IO";
3157
- };
3158
- export type PausedOnIOKindEnum = typeof PausedOnIOKindEnum[keyof typeof PausedOnIOKindEnum];
3159
3505
  /**
3160
- *
3506
+ * Response from collision-free trajectory planning. Contains either a successful joint trajectory or failure information.
3161
3507
  * @export
3162
- * @interface Payload
3508
+ * @interface PlanCollisionFreeResponse
3163
3509
  */
3164
- export interface Payload {
3510
+ export interface PlanCollisionFreeResponse {
3165
3511
  /**
3166
3512
  *
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
3513
+ * @type {PlanCollisionFreeResponseResponse}
3514
+ * @memberof PlanCollisionFreeResponse
3181
3515
  */
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
3187
- */
3188
- 'moment_of_inertia'?: Array<number>;
3516
+ 'response': PlanCollisionFreeResponseResponse;
3189
3517
  }
3518
+ /**
3519
+ * @type PlanCollisionFreeResponseResponse
3520
+ * @export
3521
+ */
3522
+ export type PlanCollisionFreeResponseResponse = JointTrajectory | PlanCollisionFreeFailedResponse;
3190
3523
  /**
3191
3524
  *
3192
3525
  * @export
@@ -3225,10 +3558,10 @@ export type PlanTrajectoryFailedResponseErrorFeedback = FeedbackCollision | Feed
3225
3558
  export interface PlanTrajectoryRequest {
3226
3559
  /**
3227
3560
  * The data to assemble the robot setup can be retrieved from [getMotionGroupDescription](getMotionGroupDescription) endpoint.
3228
- * @type {RobotSetup}
3561
+ * @type {MotionGroupSetup}
3229
3562
  * @memberof PlanTrajectoryRequest
3230
3563
  */
3231
- 'robot_setup': RobotSetup;
3564
+ 'motion_group_setup': MotionGroupSetup;
3232
3565
  /**
3233
3566
  *
3234
3567
  * @type {Array<number>}
@@ -3260,6 +3593,57 @@ export interface PlanTrajectoryResponse {
3260
3593
  * @export
3261
3594
  */
3262
3595
  export type PlanTrajectoryResponseResponse = JointTrajectory | PlanTrajectoryFailedResponse;
3596
+ /**
3597
+ *
3598
+ * @export
3599
+ * @interface PlanValidationError
3600
+ */
3601
+ export interface PlanValidationError {
3602
+ /**
3603
+ *
3604
+ * @type {Array<ValidationErrorLocInner>}
3605
+ * @memberof PlanValidationError
3606
+ */
3607
+ 'loc': Array<ValidationErrorLocInner>;
3608
+ /**
3609
+ *
3610
+ * @type {string}
3611
+ * @memberof PlanValidationError
3612
+ */
3613
+ 'msg': string;
3614
+ /**
3615
+ *
3616
+ * @type {string}
3617
+ * @memberof PlanValidationError
3618
+ */
3619
+ 'type': string;
3620
+ /**
3621
+ *
3622
+ * @type {{ [key: string]: any; }}
3623
+ * @memberof PlanValidationError
3624
+ */
3625
+ 'input': {
3626
+ [key: string]: any;
3627
+ };
3628
+ /**
3629
+ *
3630
+ * @type {PlanValidationErrorAllOfData}
3631
+ * @memberof PlanValidationError
3632
+ */
3633
+ 'data'?: PlanValidationErrorAllOfData;
3634
+ }
3635
+ /**
3636
+ * @type PlanValidationErrorAllOfData
3637
+ * Optional data further specifying the validation error.
3638
+ * @export
3639
+ */
3640
+ export type PlanValidationErrorAllOfData = {
3641
+ error_feedback_name: 'ErrorInvalidJointCount';
3642
+ } & ErrorInvalidJointCount | {
3643
+ error_feedback_name: 'ErrorJointLimitExceeded';
3644
+ } & ErrorJointLimitExceeded | {
3645
+ error_feedback_name: 'ErrorJointPositionCollision';
3646
+ } & ErrorJointPositionCollision;
3263
3647
  /**
3264
3648
  * Defines an x/y-plane with infinite size.
3265
3649
  * @export
@@ -3336,12 +3720,35 @@ export interface Pose {
3336
3720
  */
3337
3721
  'position'?: Array<number>;
3338
3722
  /**
3339
- * Defines a rotation in 3D space. A three-dimensional Vector [rx, ry, rz] with double precision. Rotation is applied around the vector. The angle of rotation equals the length of the vector.
3340
- * @type {Array<number>}
3341
- * @memberof Pose
3723
+ * Defines a rotation in 3D space. A three-dimensional Vector [rx, ry, rz] with double precision. Rotation is applied around the vector. The angle of rotation equals the length of the vector.
3724
+ * @type {Array<number>}
3725
+ * @memberof Pose
3726
+ */
3727
+ 'orientation'?: Array<number>;
3728
+ }
3729
+ /**
3730
+ * <!-- 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.
3731
+ * @export
3732
+ * @interface RRTConnectAlgorithm
3733
+ */
3734
+ export interface RRTConnectAlgorithm {
3735
+ /**
3736
+ * Algorithm discriminator.
3737
+ * @type {string}
3738
+ * @memberof RRTConnectAlgorithm
3739
+ */
3740
+ 'algorithm_name': RRTConnectAlgorithmAlgorithmNameEnum;
3741
+ /**
3742
+ * Maximum number of iterations for the RRT Connect algorithm. Higher values increase likelihood of success, but also computation time.
3743
+ * @type {number}
3744
+ * @memberof RRTConnectAlgorithm
3342
3745
  */
3343
- 'orientation'?: Array<number>;
3746
+ 'max_iterations'?: number;
3344
3747
  }
3748
+ export declare const RRTConnectAlgorithmAlgorithmNameEnum: {
3749
+ readonly RrtConnectAlgorithm: "RRTConnectAlgorithm";
3750
+ };
3751
+ export type RRTConnectAlgorithmAlgorithmNameEnum = typeof RRTConnectAlgorithmAlgorithmNameEnum[keyof typeof RRTConnectAlgorithmAlgorithmNameEnum];
3345
3752
  /**
3346
3753
  * Defines an x/y-plane with finite size. Centred around the z-axis.
3347
3754
  * @export
@@ -3423,7 +3830,7 @@ export type ReleaseChannel = typeof ReleaseChannel[keyof typeof ReleaseChannel];
3423
3830
  */
3424
3831
  export interface RobotController {
3425
3832
  /**
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).
3833
+ * 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
3834
  * @type {string}
3428
3835
  * @memberof RobotController
3429
3836
  */
@@ -3446,6 +3853,18 @@ export type RobotControllerConfiguration = AbbController | FanucController | Kuk
3446
3853
  * @interface RobotControllerState
3447
3854
  */
3448
3855
  export interface RobotControllerState {
3856
+ /**
3857
+ * Mode of communication and control between NOVA and the robot controller.
3858
+ * @type {RobotSystemMode}
3859
+ * @memberof RobotControllerState
3860
+ */
3861
+ 'mode': RobotSystemMode;
3862
+ /**
3863
+ * 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.
3864
+ * @type {Array<string>}
3865
+ * @memberof RobotControllerState
3866
+ */
3867
+ 'last_error'?: Array<string>;
3449
3868
  /**
3450
3869
  * Timestamp indicating when the represented information was received from the robot controller.
3451
3870
  * @type {string}
@@ -3490,67 +3909,16 @@ export interface RobotControllerState {
3490
3909
  'motion_groups': Array<MotionGroupState>;
3491
3910
  }
3492
3911
  /**
3493
- *
3494
- * @export
3495
- * @interface RobotSetup
3496
- */
3497
- export interface RobotSetup {
3498
- /**
3499
- * String identifiying the model of a motion group.
3500
- * @type {string}
3501
- * @memberof RobotSetup
3502
- */
3503
- 'motion_group_model': string;
3504
- /**
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
3508
- */
3509
- 'cycle_time': number;
3510
- /**
3511
- * The offset from the world frame to the motion group base.
3512
- * @type {Pose}
3513
- * @memberof RobotSetup
3514
- */
3515
- 'mounting'?: Pose;
3516
- /**
3517
- *
3518
- * @type {Pose}
3519
- * @memberof RobotSetup
3520
- */
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.
3912
+ * 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.
3545
3913
  * @export
3546
3914
  * @enum {string}
3547
3915
  */
3548
3916
  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";
3917
+ readonly ModeControllerNotConfigured: "MODE_CONTROLLER_NOT_CONFIGURED";
3918
+ readonly ModeInitializing: "MODE_INITIALIZING";
3919
+ readonly ModeMonitor: "MODE_MONITOR";
3920
+ readonly ModeControl: "MODE_CONTROL";
3921
+ readonly ModeFreeDrive: "MODE_FREE_DRIVE";
3554
3922
  };
3555
3923
  export type RobotSystemMode = typeof RobotSystemMode[keyof typeof RobotSystemMode];
3556
3924
  /**
@@ -3621,46 +3989,6 @@ export interface RobotTcpData {
3621
3989
  */
3622
3990
  'orientation_type'?: OrientationType;
3623
3991
  }
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
3992
  /**
3665
3993
  * 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
3994
  * @export
@@ -3809,43 +4137,6 @@ export declare const SettableRobotSystemMode: {
3809
4137
  readonly RobotSystemModeControl: "ROBOT_SYSTEM_MODE_CONTROL";
3810
4138
  };
3811
4139
  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
4140
  /**
3850
4141
  *
3851
4142
  * @export
@@ -3897,7 +4188,7 @@ export interface StartMovementRequest {
3897
4188
  * @type {Direction}
3898
4189
  * @memberof StartMovementRequest
3899
4190
  */
3900
- 'direction': Direction;
4191
+ 'direction'?: Direction;
3901
4192
  /**
3902
4193
  * 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
4194
  * @type {Array<IOValue>}
@@ -4184,7 +4475,24 @@ export type TrajectoryDetailsKindEnum = typeof TrajectoryDetailsKindEnum[keyof t
4184
4475
  * @type TrajectoryDetailsState
4185
4476
  * @export
4186
4477
  */
4187
- export type TrajectoryDetailsState = EndOfTrajectory | PausedByRequest | PausedOnIO | Running1 | WaitForIO;
4478
+ export type TrajectoryDetailsState = TrajectoryEnded | TrajectoryPausedByUser | TrajectoryPausedOnIO | TrajectoryRunning | TrajectoryWaitForIO;
4479
+ /**
4480
+ *
4481
+ * @export
4482
+ * @interface TrajectoryEnded
4483
+ */
4484
+ export interface TrajectoryEnded {
4485
+ /**
4486
+ *
4487
+ * @type {string}
4488
+ * @memberof TrajectoryEnded
4489
+ */
4490
+ 'kind': TrajectoryEndedKindEnum;
4491
+ }
4492
+ export declare const TrajectoryEndedKindEnum: {
4493
+ readonly EndOfTrajectory: "END_OF_TRAJECTORY";
4494
+ };
4495
+ export type TrajectoryEndedKindEnum = typeof TrajectoryEndedKindEnum[keyof typeof TrajectoryEndedKindEnum];
4188
4496
  /**
4189
4497
  *
4190
4498
  * @export
@@ -4208,6 +4516,80 @@ export declare const TrajectoryIdMessageTypeEnum: {
4208
4516
  readonly TrajectoryId: "TrajectoryId";
4209
4517
  };
4210
4518
  export type TrajectoryIdMessageTypeEnum = typeof TrajectoryIdMessageTypeEnum[keyof typeof TrajectoryIdMessageTypeEnum];
4519
+ /**
4520
+ *
4521
+ * @export
4522
+ * @interface TrajectoryPausedByUser
4523
+ */
4524
+ export interface TrajectoryPausedByUser {
4525
+ /**
4526
+ *
4527
+ * @type {string}
4528
+ * @memberof TrajectoryPausedByUser
4529
+ */
4530
+ 'kind': TrajectoryPausedByUserKindEnum;
4531
+ }
4532
+ export declare const TrajectoryPausedByUserKindEnum: {
4533
+ readonly PausedByUser: "PAUSED_BY_USER";
4534
+ };
4535
+ export type TrajectoryPausedByUserKindEnum = typeof TrajectoryPausedByUserKindEnum[keyof typeof TrajectoryPausedByUserKindEnum];
4536
+ /**
4537
+ *
4538
+ * @export
4539
+ * @interface TrajectoryPausedOnIO
4540
+ */
4541
+ export interface TrajectoryPausedOnIO {
4542
+ /**
4543
+ *
4544
+ * @type {string}
4545
+ * @memberof TrajectoryPausedOnIO
4546
+ */
4547
+ 'kind': TrajectoryPausedOnIOKindEnum;
4548
+ }
4549
+ export declare const TrajectoryPausedOnIOKindEnum: {
4550
+ readonly PausedOnIo: "PAUSED_ON_IO";
4551
+ };
4552
+ export type TrajectoryPausedOnIOKindEnum = typeof TrajectoryPausedOnIOKindEnum[keyof typeof TrajectoryPausedOnIOKindEnum];
4553
+ /**
4554
+ *
4555
+ * @export
4556
+ * @interface TrajectoryRunning
4557
+ */
4558
+ export interface TrajectoryRunning {
4559
+ /**
4560
+ *
4561
+ * @type {string}
4562
+ * @memberof TrajectoryRunning
4563
+ */
4564
+ 'kind': TrajectoryRunningKindEnum;
4565
+ /**
4566
+ * Remaining time in milliseconds (ms) to reach the end of the motion.
4567
+ * @type {number}
4568
+ * @memberof TrajectoryRunning
4569
+ */
4570
+ 'time_to_end': number;
4571
+ }
4572
+ export declare const TrajectoryRunningKindEnum: {
4573
+ readonly Running: "RUNNING";
4574
+ };
4575
+ export type TrajectoryRunningKindEnum = typeof TrajectoryRunningKindEnum[keyof typeof TrajectoryRunningKindEnum];
4576
+ /**
4577
+ *
4578
+ * @export
4579
+ * @interface TrajectoryWaitForIO
4580
+ */
4581
+ export interface TrajectoryWaitForIO {
4582
+ /**
4583
+ *
4584
+ * @type {string}
4585
+ * @memberof TrajectoryWaitForIO
4586
+ */
4587
+ 'kind': TrajectoryWaitForIOKindEnum;
4588
+ }
4589
+ export declare const TrajectoryWaitForIOKindEnum: {
4590
+ readonly WaitForIo: "WAIT_FOR_IO";
4591
+ };
4592
+ export type TrajectoryWaitForIOKindEnum = typeof TrajectoryWaitForIOKindEnum[keyof typeof TrajectoryWaitForIOKindEnum];
4211
4593
  /**
4212
4594
  * The unit of input/output value.
4213
4595
  * @export
@@ -4286,6 +4668,14 @@ export interface ValidationError {
4286
4668
  * @memberof ValidationError
4287
4669
  */
4288
4670
  'type': string;
4671
+ /**
4672
+ *
4673
+ * @type {{ [key: string]: any; }}
4674
+ * @memberof ValidationError
4675
+ */
4676
+ 'input': {
4677
+ [key: string]: any;
4678
+ };
4289
4679
  }
4290
4680
  /**
4291
4681
  * @type ValidationErrorLocInner
@@ -4327,7 +4717,7 @@ export interface VirtualController {
4327
4717
  * @type {string}
4328
4718
  * @memberof VirtualController
4329
4719
  */
4330
- 'position'?: string;
4720
+ 'initial_joint_position'?: string;
4331
4721
  }
4332
4722
  export declare const VirtualControllerKindEnum: {
4333
4723
  readonly VirtualController: "VirtualController";
@@ -4373,6 +4763,7 @@ export declare const VirtualControllerTypes: {
4373
4763
  readonly FanucCrx20ial: "fanuc-crx20ial";
4374
4764
  readonly FanucCrx25ia: "fanuc-crx25ia";
4375
4765
  readonly FanucCrx30ia: "fanuc-crx30ia";
4766
+ readonly FanucCrx5ia: "fanuc-crx5ia";
4376
4767
  readonly FanucLrMate200iD: "fanuc-lr_mate_200iD";
4377
4768
  readonly FanucLrMate200iD4S: "fanuc-lr_mate_200iD4S";
4378
4769
  readonly FanucLrMate200iD7L: "fanuc-lr_mate_200iD7L";
@@ -4380,6 +4771,7 @@ export declare const VirtualControllerTypes: {
4380
4771
  readonly FanucM10iD16S: "fanuc-m10iD16S";
4381
4772
  readonly FanucM20iD25: "fanuc-m20iD25";
4382
4773
  readonly FanucM20iD35: "fanuc-m20iD35";
4774
+ readonly FanucM710iC20L: "fanuc-m710iC20L";
4383
4775
  readonly FanucM900iB280L: "fanuc-m900iB280L";
4384
4776
  readonly FanucM900iB360E: "fanuc-m900iB360E";
4385
4777
  readonly FanucR2000ic125l: "fanuc-r2000ic125l";
@@ -4467,23 +4859,6 @@ export interface VirtualRobotConfiguration {
4467
4859
  */
4468
4860
  'content': string;
4469
4861
  }
4470
- /**
4471
- *
4472
- * @export
4473
- * @interface WaitForIO
4474
- */
4475
- export interface WaitForIO {
4476
- /**
4477
- *
4478
- * @type {string}
4479
- * @memberof WaitForIO
4480
- */
4481
- 'kind': WaitForIOKindEnum;
4482
- }
4483
- export declare const WaitForIOKindEnum: {
4484
- readonly WaitForIo: "WAIT_FOR_IO";
4485
- };
4486
- export type WaitForIOKindEnum = typeof WaitForIOKindEnum[keyof typeof WaitForIOKindEnum];
4487
4862
  /**
4488
4863
  * The value to compare with the current value of the input/output.
4489
4864
  * @export
@@ -4532,7 +4907,7 @@ export type YaskawaControllerKindEnum = typeof YaskawaControllerKindEnum[keyof t
4532
4907
  */
4533
4908
  export declare const ApplicationApiAxiosParamCreator: (configuration?: Configuration) => {
4534
4909
  /**
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.
4910
+ * 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.
4536
4911
  * @summary Add Application
4537
4912
  * @param {string} cell Unique identifier addressing a cell in all API calls.
4538
4913
  * @param {App} app
@@ -4595,7 +4970,7 @@ export declare const ApplicationApiAxiosParamCreator: (configuration?: Configura
4595
4970
  */
4596
4971
  export declare const ApplicationApiFp: (configuration?: Configuration) => {
4597
4972
  /**
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.
4973
+ * 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.
4599
4974
  * @summary Add Application
4600
4975
  * @param {string} cell Unique identifier addressing a cell in all API calls.
4601
4976
  * @param {App} app
@@ -4658,7 +5033,7 @@ export declare const ApplicationApiFp: (configuration?: Configuration) => {
4658
5033
  */
4659
5034
  export declare const ApplicationApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
4660
5035
  /**
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.
5036
+ * 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.
4662
5037
  * @summary Add Application
4663
5038
  * @param {string} cell Unique identifier addressing a cell in all API calls.
4664
5039
  * @param {App} app
@@ -4723,7 +5098,7 @@ export declare const ApplicationApiFactory: (configuration?: Configuration, base
4723
5098
  */
4724
5099
  export declare class ApplicationApi extends BaseAPI {
4725
5100
  /**
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.
5101
+ * 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.
4727
5102
  * @summary Add Application
4728
5103
  * @param {string} cell Unique identifier addressing a cell in all API calls.
4729
5104
  * @param {App} app
@@ -5122,15 +5497,6 @@ export declare const ControllerApiAxiosParamCreator: (configuration?: Configurat
5122
5497
  * @throws {RequiredError}
5123
5498
  */
5124
5499
  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
5500
  /**
5135
5501
  * Get the configuration for a robot controller.
5136
5502
  * @summary Robot Controller
@@ -5168,7 +5534,7 @@ export declare const ControllerApiAxiosParamCreator: (configuration?: Configurat
5168
5534
  */
5169
5535
  listRobotControllers: (cell: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
5170
5536
  /**
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.
5537
+ * 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
5538
  * @summary Set Default Mode
5173
5539
  * @param {string} cell Unique identifier addressing a cell in all API calls.
5174
5540
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -5188,15 +5554,16 @@ export declare const ControllerApiAxiosParamCreator: (configuration?: Configurat
5188
5554
  */
5189
5555
  streamFreeDrive: (cell: string, controller: string, responseRate?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
5190
5556
  /**
5191
- * <!-- theme: danger --> > Websocket endpoint Receive updates of the state of a robot controller.
5557
+ * <!-- 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
5558
  * @summary Stream State
5193
5559
  * @param {string} cell Unique identifier addressing a cell in all API calls.
5194
5560
  * @param {string} controller Unique identifier to address a controller in the cell.
5195
5561
  * @param {number} [responseRate]
5562
+ * @param {number} [addControllerTimeout]
5196
5563
  * @param {*} [options] Override http request option.
5197
5564
  * @throws {RequiredError}
5198
5565
  */
5199
- streamRobotControllerState: (cell: string, controller: string, responseRate?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
5566
+ streamRobotControllerState: (cell: string, controller: string, responseRate?: number, addControllerTimeout?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
5200
5567
  /**
5201
5568
  * 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
5569
  * @summary Update Robot Controller
@@ -5272,15 +5639,6 @@ export declare const ControllerApiFp: (configuration?: Configuration) => {
5272
5639
  * @throws {RequiredError}
5273
5640
  */
5274
5641
  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
5642
  /**
5285
5643
  * Get the configuration for a robot controller.
5286
5644
  * @summary Robot Controller
@@ -5318,7 +5676,7 @@ export declare const ControllerApiFp: (configuration?: Configuration) => {
5318
5676
  */
5319
5677
  listRobotControllers(cell: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<string>>>;
5320
5678
  /**
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.
5679
+ * 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
5680
  * @summary Set Default Mode
5323
5681
  * @param {string} cell Unique identifier addressing a cell in all API calls.
5324
5682
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -5338,15 +5696,16 @@ export declare const ControllerApiFp: (configuration?: Configuration) => {
5338
5696
  */
5339
5697
  streamFreeDrive(cell: string, controller: string, responseRate?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<RobotControllerState>>;
5340
5698
  /**
5341
- * <!-- theme: danger --> > Websocket endpoint Receive updates of the state of a robot controller.
5699
+ * <!-- 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
5700
  * @summary Stream State
5343
5701
  * @param {string} cell Unique identifier addressing a cell in all API calls.
5344
5702
  * @param {string} controller Unique identifier to address a controller in the cell.
5345
5703
  * @param {number} [responseRate]
5704
+ * @param {number} [addControllerTimeout]
5346
5705
  * @param {*} [options] Override http request option.
5347
5706
  * @throws {RequiredError}
5348
5707
  */
5349
- streamRobotControllerState(cell: string, controller: string, responseRate?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<RobotControllerState>>;
5708
+ streamRobotControllerState(cell: string, controller: string, responseRate?: number, addControllerTimeout?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<RobotControllerState>>;
5350
5709
  /**
5351
5710
  * 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
5711
  * @summary Update Robot Controller
@@ -5422,15 +5781,6 @@ export declare const ControllerApiFactory: (configuration?: Configuration, baseP
5422
5781
  * @throws {RequiredError}
5423
5782
  */
5424
5783
  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
5784
  /**
5435
5785
  * Get the configuration for a robot controller.
5436
5786
  * @summary Robot Controller
@@ -5468,7 +5818,7 @@ export declare const ControllerApiFactory: (configuration?: Configuration, baseP
5468
5818
  */
5469
5819
  listRobotControllers(cell: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<string>>;
5470
5820
  /**
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.
5821
+ * 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
5822
  * @summary Set Default Mode
5473
5823
  * @param {string} cell Unique identifier addressing a cell in all API calls.
5474
5824
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -5488,15 +5838,16 @@ export declare const ControllerApiFactory: (configuration?: Configuration, baseP
5488
5838
  */
5489
5839
  streamFreeDrive(cell: string, controller: string, responseRate?: number, options?: RawAxiosRequestConfig): AxiosPromise<RobotControllerState>;
5490
5840
  /**
5491
- * <!-- theme: danger --> > Websocket endpoint Receive updates of the state of a robot controller.
5841
+ * <!-- 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
5842
  * @summary Stream State
5493
5843
  * @param {string} cell Unique identifier addressing a cell in all API calls.
5494
5844
  * @param {string} controller Unique identifier to address a controller in the cell.
5495
5845
  * @param {number} [responseRate]
5846
+ * @param {number} [addControllerTimeout]
5496
5847
  * @param {*} [options] Override http request option.
5497
5848
  * @throws {RequiredError}
5498
5849
  */
5499
- streamRobotControllerState(cell: string, controller: string, responseRate?: number, options?: RawAxiosRequestConfig): AxiosPromise<RobotControllerState>;
5850
+ streamRobotControllerState(cell: string, controller: string, responseRate?: number, addControllerTimeout?: number, options?: RawAxiosRequestConfig): AxiosPromise<RobotControllerState>;
5500
5851
  /**
5501
5852
  * 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
5853
  * @summary Update Robot Controller
@@ -5580,16 +5931,6 @@ export declare class ControllerApi extends BaseAPI {
5580
5931
  * @memberof ControllerApi
5581
5932
  */
5582
5933
  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
5934
  /**
5594
5935
  * Get the configuration for a robot controller.
5595
5936
  * @summary Robot Controller
@@ -5631,7 +5972,7 @@ export declare class ControllerApi extends BaseAPI {
5631
5972
  */
5632
5973
  listRobotControllers(cell: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<string[], any>>;
5633
5974
  /**
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.
5975
+ * 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
5976
  * @summary Set Default Mode
5636
5977
  * @param {string} cell Unique identifier addressing a cell in all API calls.
5637
5978
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -5653,16 +5994,17 @@ export declare class ControllerApi extends BaseAPI {
5653
5994
  */
5654
5995
  streamFreeDrive(cell: string, controller: string, responseRate?: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<RobotControllerState, any>>;
5655
5996
  /**
5656
- * <!-- theme: danger --> > Websocket endpoint Receive updates of the state of a robot controller.
5997
+ * <!-- 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
5998
  * @summary Stream State
5658
5999
  * @param {string} cell Unique identifier addressing a cell in all API calls.
5659
6000
  * @param {string} controller Unique identifier to address a controller in the cell.
5660
6001
  * @param {number} [responseRate]
6002
+ * @param {number} [addControllerTimeout]
5661
6003
  * @param {*} [options] Override http request option.
5662
6004
  * @throws {RequiredError}
5663
6005
  * @memberof ControllerApi
5664
6006
  */
5665
- streamRobotControllerState(cell: string, controller: string, responseRate?: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<RobotControllerState, any>>;
6007
+ streamRobotControllerState(cell: string, controller: string, responseRate?: number, addControllerTimeout?: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<RobotControllerState, any>>;
5666
6008
  /**
5667
6009
  * 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
6010
  * @summary Update Robot Controller
@@ -5991,6 +6333,15 @@ export declare class JoggingApi extends BaseAPI {
5991
6333
  * @export
5992
6334
  */
5993
6335
  export declare const KinematicsApiAxiosParamCreator: (configuration?: Configuration) => {
6336
+ /**
6337
+ * Returns the TCP poses for a list of given joint positions.
6338
+ * @summary Forward kinematics
6339
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
6340
+ * @param {ForwardKinematicsRequest} [forwardKinematicsRequest]
6341
+ * @param {*} [options] Override http request option.
6342
+ * @throws {RequiredError}
6343
+ */
6344
+ forwardKinematics: (cell: string, forwardKinematicsRequest?: ForwardKinematicsRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
5994
6345
  /**
5995
6346
  * Returns the reachable joint positions for a list of given poses.
5996
6347
  * @summary Inverse kinematics
@@ -6006,6 +6357,15 @@ export declare const KinematicsApiAxiosParamCreator: (configuration?: Configurat
6006
6357
  * @export
6007
6358
  */
6008
6359
  export declare const KinematicsApiFp: (configuration?: Configuration) => {
6360
+ /**
6361
+ * Returns the TCP poses for a list of given joint positions.
6362
+ * @summary Forward kinematics
6363
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
6364
+ * @param {ForwardKinematicsRequest} [forwardKinematicsRequest]
6365
+ * @param {*} [options] Override http request option.
6366
+ * @throws {RequiredError}
6367
+ */
6368
+ forwardKinematics(cell: string, forwardKinematicsRequest?: ForwardKinematicsRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ForwardKinematicsResponse>>;
6009
6369
  /**
6010
6370
  * Returns the reachable joint positions for a list of given poses.
6011
6371
  * @summary Inverse kinematics
@@ -6021,6 +6381,15 @@ export declare const KinematicsApiFp: (configuration?: Configuration) => {
6021
6381
  * @export
6022
6382
  */
6023
6383
  export declare const KinematicsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
6384
+ /**
6385
+ * Returns the TCP poses for a list of given joint positions.
6386
+ * @summary Forward kinematics
6387
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
6388
+ * @param {ForwardKinematicsRequest} [forwardKinematicsRequest]
6389
+ * @param {*} [options] Override http request option.
6390
+ * @throws {RequiredError}
6391
+ */
6392
+ forwardKinematics(cell: string, forwardKinematicsRequest?: ForwardKinematicsRequest, options?: RawAxiosRequestConfig): AxiosPromise<ForwardKinematicsResponse>;
6024
6393
  /**
6025
6394
  * Returns the reachable joint positions for a list of given poses.
6026
6395
  * @summary Inverse kinematics
@@ -6038,6 +6407,16 @@ export declare const KinematicsApiFactory: (configuration?: Configuration, baseP
6038
6407
  * @extends {BaseAPI}
6039
6408
  */
6040
6409
  export declare class KinematicsApi extends BaseAPI {
6410
+ /**
6411
+ * Returns the TCP poses for a list of given joint positions.
6412
+ * @summary Forward kinematics
6413
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
6414
+ * @param {ForwardKinematicsRequest} [forwardKinematicsRequest]
6415
+ * @param {*} [options] Override http request option.
6416
+ * @throws {RequiredError}
6417
+ * @memberof KinematicsApi
6418
+ */
6419
+ forwardKinematics(cell: string, forwardKinematicsRequest?: ForwardKinematicsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ForwardKinematicsResponse, any>>;
6041
6420
  /**
6042
6421
  * Returns the reachable joint positions for a list of given poses.
6043
6422
  * @summary Inverse kinematics
@@ -6999,184 +7378,184 @@ export declare class StoreCollisionComponentsApi extends BaseAPI {
6999
7378
  }, any>>;
7000
7379
  }
7001
7380
  /**
7002
- * StoreCollisionScenesApi - axios parameter creator
7381
+ * StoreCollisionSetupsApi - axios parameter creator
7003
7382
  * @export
7004
7383
  */
7005
- export declare const StoreCollisionScenesApiAxiosParamCreator: (configuration?: Configuration) => {
7384
+ export declare const StoreCollisionSetupsApiAxiosParamCreator: (configuration?: Configuration) => {
7006
7385
  /**
7007
- * Deletes the stored scene. <!-- theme: danger --> > This will delete persistently stored data.
7008
- * @summary Delete Scene
7386
+ * Deletes the stored collision setup. <!-- theme: danger --> > This will delete persistently stored data.
7387
+ * @summary Delete Collision Setup
7009
7388
  * @param {string} cell Unique identifier addressing a cell in all API calls.
7010
- * @param {string} scene Unique identifier addressing a collision scene.
7389
+ * @param {string} setup Identifier of the collision setup
7011
7390
  * @param {*} [options] Override http request option.
7012
7391
  * @throws {RequiredError}
7013
7392
  */
7014
- deleteStoredCollisionScene: (cell: string, scene: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
7393
+ deleteStoredCollisionSetup: (cell: string, setup: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
7015
7394
  /**
7016
- * Returns the stored scene.
7017
- * @summary Get Scene
7395
+ * Returns the stored collision setup.
7396
+ * @summary Get Collision Setup
7018
7397
  * @param {string} cell Unique identifier addressing a cell in all API calls.
7019
- * @param {string} scene Unique identifier addressing a collision scene.
7398
+ * @param {string} setup Identifier of the collision setup
7020
7399
  * @param {*} [options] Override http request option.
7021
7400
  * @throws {RequiredError}
7022
7401
  */
7023
- getStoredCollisionScene: (cell: string, scene: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
7402
+ getStoredCollisionSetup: (cell: string, setup: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
7024
7403
  /**
7025
- * Returns a list of stored scenes.
7026
- * @summary List Scenes
7404
+ * Returns a list of stored collision setups.
7405
+ * @summary List Collision Setups
7027
7406
  * @param {string} cell Unique identifier addressing a cell in all API calls.
7028
7407
  * @param {*} [options] Override http request option.
7029
7408
  * @throws {RequiredError}
7030
7409
  */
7031
- listStoredCollisionScenes: (cell: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
7410
+ listStoredCollisionSetups: (cell: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
7032
7411
  /**
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
7412
+ * Stores collision setup. If the collision setup does not exist, it will be created. If the collision setup exists, it will be updated.
7413
+ * @summary Store Collision Setup
7035
7414
  * @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
7415
+ * @param {string} setup Identifier of the collision setup
7416
+ * @param {CollisionSetup} collisionSetup
7038
7417
  * @param {*} [options] Override http request option.
7039
7418
  * @throws {RequiredError}
7040
7419
  */
7041
- storeCollisionScene: (cell: string, scene: string, collisionSceneAssembly: CollisionSceneAssembly, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
7420
+ storeCollisionSetup: (cell: string, setup: string, collisionSetup: CollisionSetup, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
7042
7421
  };
7043
7422
  /**
7044
- * StoreCollisionScenesApi - functional programming interface
7423
+ * StoreCollisionSetupsApi - functional programming interface
7045
7424
  * @export
7046
7425
  */
7047
- export declare const StoreCollisionScenesApiFp: (configuration?: Configuration) => {
7426
+ export declare const StoreCollisionSetupsApiFp: (configuration?: Configuration) => {
7048
7427
  /**
7049
- * Deletes the stored scene. <!-- theme: danger --> > This will delete persistently stored data.
7050
- * @summary Delete Scene
7428
+ * Deletes the stored collision setup. <!-- theme: danger --> > This will delete persistently stored data.
7429
+ * @summary Delete Collision Setup
7051
7430
  * @param {string} cell Unique identifier addressing a cell in all API calls.
7052
- * @param {string} scene Unique identifier addressing a collision scene.
7431
+ * @param {string} setup Identifier of the collision setup
7053
7432
  * @param {*} [options] Override http request option.
7054
7433
  * @throws {RequiredError}
7055
7434
  */
7056
- deleteStoredCollisionScene(cell: string, scene: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
7435
+ deleteStoredCollisionSetup(cell: string, setup: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
7057
7436
  /**
7058
- * Returns the stored scene.
7059
- * @summary Get Scene
7437
+ * Returns the stored collision setup.
7438
+ * @summary Get Collision Setup
7060
7439
  * @param {string} cell Unique identifier addressing a cell in all API calls.
7061
- * @param {string} scene Unique identifier addressing a collision scene.
7440
+ * @param {string} setup Identifier of the collision setup
7062
7441
  * @param {*} [options] Override http request option.
7063
7442
  * @throws {RequiredError}
7064
7443
  */
7065
- getStoredCollisionScene(cell: string, scene: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CollisionScene>>;
7444
+ getStoredCollisionSetup(cell: string, setup: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CollisionSetup>>;
7066
7445
  /**
7067
- * Returns a list of stored scenes.
7068
- * @summary List Scenes
7446
+ * Returns a list of stored collision setups.
7447
+ * @summary List Collision Setups
7069
7448
  * @param {string} cell Unique identifier addressing a cell in all API calls.
7070
7449
  * @param {*} [options] Override http request option.
7071
7450
  * @throws {RequiredError}
7072
7451
  */
7073
- listStoredCollisionScenes(cell: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<{
7074
- [key: string]: CollisionScene;
7452
+ listStoredCollisionSetups(cell: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<{
7453
+ [key: string]: CollisionSetup;
7075
7454
  }>>;
7076
7455
  /**
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
7456
+ * Stores collision setup. If the collision setup does not exist, it will be created. If the collision setup exists, it will be updated.
7457
+ * @summary Store Collision Setup
7079
7458
  * @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
7459
+ * @param {string} setup Identifier of the collision setup
7460
+ * @param {CollisionSetup} collisionSetup
7082
7461
  * @param {*} [options] Override http request option.
7083
7462
  * @throws {RequiredError}
7084
7463
  */
7085
- storeCollisionScene(cell: string, scene: string, collisionSceneAssembly: CollisionSceneAssembly, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CollisionScene>>;
7464
+ storeCollisionSetup(cell: string, setup: string, collisionSetup: CollisionSetup, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CollisionSetup>>;
7086
7465
  };
7087
7466
  /**
7088
- * StoreCollisionScenesApi - factory interface
7467
+ * StoreCollisionSetupsApi - factory interface
7089
7468
  * @export
7090
7469
  */
7091
- export declare const StoreCollisionScenesApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
7470
+ export declare const StoreCollisionSetupsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
7092
7471
  /**
7093
- * Deletes the stored scene. <!-- theme: danger --> > This will delete persistently stored data.
7094
- * @summary Delete Scene
7472
+ * Deletes the stored collision setup. <!-- theme: danger --> > This will delete persistently stored data.
7473
+ * @summary Delete Collision Setup
7095
7474
  * @param {string} cell Unique identifier addressing a cell in all API calls.
7096
- * @param {string} scene Unique identifier addressing a collision scene.
7475
+ * @param {string} setup Identifier of the collision setup
7097
7476
  * @param {*} [options] Override http request option.
7098
7477
  * @throws {RequiredError}
7099
7478
  */
7100
- deleteStoredCollisionScene(cell: string, scene: string, options?: RawAxiosRequestConfig): AxiosPromise<void>;
7479
+ deleteStoredCollisionSetup(cell: string, setup: string, options?: RawAxiosRequestConfig): AxiosPromise<void>;
7101
7480
  /**
7102
- * Returns the stored scene.
7103
- * @summary Get Scene
7481
+ * Returns the stored collision setup.
7482
+ * @summary Get Collision Setup
7104
7483
  * @param {string} cell Unique identifier addressing a cell in all API calls.
7105
- * @param {string} scene Unique identifier addressing a collision scene.
7484
+ * @param {string} setup Identifier of the collision setup
7106
7485
  * @param {*} [options] Override http request option.
7107
7486
  * @throws {RequiredError}
7108
7487
  */
7109
- getStoredCollisionScene(cell: string, scene: string, options?: RawAxiosRequestConfig): AxiosPromise<CollisionScene>;
7488
+ getStoredCollisionSetup(cell: string, setup: string, options?: RawAxiosRequestConfig): AxiosPromise<CollisionSetup>;
7110
7489
  /**
7111
- * Returns a list of stored scenes.
7112
- * @summary List Scenes
7490
+ * Returns a list of stored collision setups.
7491
+ * @summary List Collision Setups
7113
7492
  * @param {string} cell Unique identifier addressing a cell in all API calls.
7114
7493
  * @param {*} [options] Override http request option.
7115
7494
  * @throws {RequiredError}
7116
7495
  */
7117
- listStoredCollisionScenes(cell: string, options?: RawAxiosRequestConfig): AxiosPromise<{
7118
- [key: string]: CollisionScene;
7496
+ listStoredCollisionSetups(cell: string, options?: RawAxiosRequestConfig): AxiosPromise<{
7497
+ [key: string]: CollisionSetup;
7119
7498
  }>;
7120
7499
  /**
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
7500
+ * Stores collision setup. If the collision setup does not exist, it will be created. If the collision setup exists, it will be updated.
7501
+ * @summary Store Collision Setup
7123
7502
  * @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
7503
+ * @param {string} setup Identifier of the collision setup
7504
+ * @param {CollisionSetup} collisionSetup
7126
7505
  * @param {*} [options] Override http request option.
7127
7506
  * @throws {RequiredError}
7128
7507
  */
7129
- storeCollisionScene(cell: string, scene: string, collisionSceneAssembly: CollisionSceneAssembly, options?: RawAxiosRequestConfig): AxiosPromise<CollisionScene>;
7508
+ storeCollisionSetup(cell: string, setup: string, collisionSetup: CollisionSetup, options?: RawAxiosRequestConfig): AxiosPromise<CollisionSetup>;
7130
7509
  };
7131
7510
  /**
7132
- * StoreCollisionScenesApi - object-oriented interface
7511
+ * StoreCollisionSetupsApi - object-oriented interface
7133
7512
  * @export
7134
- * @class StoreCollisionScenesApi
7513
+ * @class StoreCollisionSetupsApi
7135
7514
  * @extends {BaseAPI}
7136
7515
  */
7137
- export declare class StoreCollisionScenesApi extends BaseAPI {
7516
+ export declare class StoreCollisionSetupsApi extends BaseAPI {
7138
7517
  /**
7139
- * Deletes the stored scene. <!-- theme: danger --> > This will delete persistently stored data.
7140
- * @summary Delete Scene
7518
+ * Deletes the stored collision setup. <!-- theme: danger --> > This will delete persistently stored data.
7519
+ * @summary Delete Collision Setup
7141
7520
  * @param {string} cell Unique identifier addressing a cell in all API calls.
7142
- * @param {string} scene Unique identifier addressing a collision scene.
7521
+ * @param {string} setup Identifier of the collision setup
7143
7522
  * @param {*} [options] Override http request option.
7144
7523
  * @throws {RequiredError}
7145
- * @memberof StoreCollisionScenesApi
7524
+ * @memberof StoreCollisionSetupsApi
7146
7525
  */
7147
- deleteStoredCollisionScene(cell: string, scene: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
7526
+ deleteStoredCollisionSetup(cell: string, setup: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
7148
7527
  /**
7149
- * Returns the stored scene.
7150
- * @summary Get Scene
7528
+ * Returns the stored collision setup.
7529
+ * @summary Get Collision Setup
7151
7530
  * @param {string} cell Unique identifier addressing a cell in all API calls.
7152
- * @param {string} scene Unique identifier addressing a collision scene.
7531
+ * @param {string} setup Identifier of the collision setup
7153
7532
  * @param {*} [options] Override http request option.
7154
7533
  * @throws {RequiredError}
7155
- * @memberof StoreCollisionScenesApi
7534
+ * @memberof StoreCollisionSetupsApi
7156
7535
  */
7157
- getStoredCollisionScene(cell: string, scene: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CollisionScene, any>>;
7536
+ getStoredCollisionSetup(cell: string, setup: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CollisionSetup, any>>;
7158
7537
  /**
7159
- * Returns a list of stored scenes.
7160
- * @summary List Scenes
7538
+ * Returns a list of stored collision setups.
7539
+ * @summary List Collision Setups
7161
7540
  * @param {string} cell Unique identifier addressing a cell in all API calls.
7162
7541
  * @param {*} [options] Override http request option.
7163
7542
  * @throws {RequiredError}
7164
- * @memberof StoreCollisionScenesApi
7543
+ * @memberof StoreCollisionSetupsApi
7165
7544
  */
7166
- listStoredCollisionScenes(cell: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<{
7167
- [key: string]: CollisionScene;
7545
+ listStoredCollisionSetups(cell: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<{
7546
+ [key: string]: CollisionSetup;
7168
7547
  }, any>>;
7169
7548
  /**
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
7549
+ * Stores collision setup. If the collision setup does not exist, it will be created. If the collision setup exists, it will be updated.
7550
+ * @summary Store Collision Setup
7172
7551
  * @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
7552
+ * @param {string} setup Identifier of the collision setup
7553
+ * @param {CollisionSetup} collisionSetup
7175
7554
  * @param {*} [options] Override http request option.
7176
7555
  * @throws {RequiredError}
7177
- * @memberof StoreCollisionScenesApi
7556
+ * @memberof StoreCollisionSetupsApi
7178
7557
  */
7179
- storeCollisionScene(cell: string, scene: string, collisionSceneAssembly: CollisionSceneAssembly, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CollisionScene, any>>;
7558
+ storeCollisionSetup(cell: string, setup: string, collisionSetup: CollisionSetup, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CollisionSetup, any>>;
7180
7559
  }
7181
7560
  /**
7182
7561
  * StoreObjectApi - axios parameter creator
@@ -7440,14 +7819,14 @@ export declare class StoreObjectApi extends BaseAPI {
7440
7819
  */
7441
7820
  export declare const SystemApiAxiosParamCreator: (configuration?: Configuration) => {
7442
7821
  /**
7443
- * Retrieves a configuration backup based on provided resource identifiers.
7822
+ * 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
7823
  * @summary Retrieve Configuration Backup
7445
- * @param {Array<string>} resources List of resource identifiers to included in the backup and restore operations.
7824
+ * @param {Array<string>} [resources] List of resource identifiers to include in the retrieval.
7446
7825
  * @param {{ [key: string]: string; }} [metadata] Additional metadata to add to the backup
7447
7826
  * @param {*} [options] Override http request option.
7448
7827
  * @throws {RequiredError}
7449
7828
  */
7450
- backupConfiguration: (resources: Array<string>, metadata?: {
7829
+ backupConfiguration: (resources?: Array<string>, metadata?: {
7451
7830
  [key: string]: string;
7452
7831
  }, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
7453
7832
  /**
@@ -7518,14 +7897,14 @@ export declare const SystemApiAxiosParamCreator: (configuration?: Configuration)
7518
7897
  */
7519
7898
  export declare const SystemApiFp: (configuration?: Configuration) => {
7520
7899
  /**
7521
- * Retrieves a configuration backup based on provided resource identifiers.
7900
+ * 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
7901
  * @summary Retrieve Configuration Backup
7523
- * @param {Array<string>} resources List of resource identifiers to included in the backup and restore operations.
7902
+ * @param {Array<string>} [resources] List of resource identifiers to include in the retrieval.
7524
7903
  * @param {{ [key: string]: string; }} [metadata] Additional metadata to add to the backup
7525
7904
  * @param {*} [options] Override http request option.
7526
7905
  * @throws {RequiredError}
7527
7906
  */
7528
- backupConfiguration(resources: Array<string>, metadata?: {
7907
+ backupConfiguration(resources?: Array<string>, metadata?: {
7529
7908
  [key: string]: string;
7530
7909
  }, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<File>>;
7531
7910
  /**
@@ -7596,14 +7975,14 @@ export declare const SystemApiFp: (configuration?: Configuration) => {
7596
7975
  */
7597
7976
  export declare const SystemApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
7598
7977
  /**
7599
- * Retrieves a configuration backup based on provided resource identifiers.
7978
+ * 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
7979
  * @summary Retrieve Configuration Backup
7601
- * @param {Array<string>} resources List of resource identifiers to included in the backup and restore operations.
7980
+ * @param {Array<string>} [resources] List of resource identifiers to include in the retrieval.
7602
7981
  * @param {{ [key: string]: string; }} [metadata] Additional metadata to add to the backup
7603
7982
  * @param {*} [options] Override http request option.
7604
7983
  * @throws {RequiredError}
7605
7984
  */
7606
- backupConfiguration(resources: Array<string>, metadata?: {
7985
+ backupConfiguration(resources?: Array<string>, metadata?: {
7607
7986
  [key: string]: string;
7608
7987
  }, options?: RawAxiosRequestConfig): AxiosPromise<File>;
7609
7988
  /**
@@ -7676,15 +8055,15 @@ export declare const SystemApiFactory: (configuration?: Configuration, basePath?
7676
8055
  */
7677
8056
  export declare class SystemApi extends BaseAPI {
7678
8057
  /**
7679
- * Retrieves a configuration backup based on provided resource identifiers.
8058
+ * 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
8059
  * @summary Retrieve Configuration Backup
7681
- * @param {Array<string>} resources List of resource identifiers to included in the backup and restore operations.
8060
+ * @param {Array<string>} [resources] List of resource identifiers to include in the retrieval.
7682
8061
  * @param {{ [key: string]: string; }} [metadata] Additional metadata to add to the backup
7683
8062
  * @param {*} [options] Override http request option.
7684
8063
  * @throws {RequiredError}
7685
8064
  * @memberof SystemApi
7686
8065
  */
7687
- backupConfiguration(resources: Array<string>, metadata?: {
8066
+ backupConfiguration(resources?: Array<string>, metadata?: {
7688
8067
  [key: string]: string;
7689
8068
  }, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<File, any>>;
7690
8069
  /**
@@ -8052,6 +8431,15 @@ export declare class TrajectoryExecutionApi extends BaseAPI {
8052
8431
  * @export
8053
8432
  */
8054
8433
  export declare const TrajectoryPlanningApiAxiosParamCreator: (configuration?: Configuration) => {
8434
+ /**
8435
+ * 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.
8436
+ * @summary Plan Collision-Free Trajectory
8437
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
8438
+ * @param {PlanCollisionFreeRequest} [planCollisionFreeRequest]
8439
+ * @param {*} [options] Override http request option.
8440
+ * @throws {RequiredError}
8441
+ */
8442
+ planCollisionFree: (cell: string, planCollisionFreeRequest?: PlanCollisionFreeRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
8055
8443
  /**
8056
8444
  * 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
8445
  * @summary Plan Trajectory
@@ -8067,6 +8455,15 @@ export declare const TrajectoryPlanningApiAxiosParamCreator: (configuration?: Co
8067
8455
  * @export
8068
8456
  */
8069
8457
  export declare const TrajectoryPlanningApiFp: (configuration?: Configuration) => {
8458
+ /**
8459
+ * 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.
8460
+ * @summary Plan Collision-Free Trajectory
8461
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
8462
+ * @param {PlanCollisionFreeRequest} [planCollisionFreeRequest]
8463
+ * @param {*} [options] Override http request option.
8464
+ * @throws {RequiredError}
8465
+ */
8466
+ planCollisionFree(cell: string, planCollisionFreeRequest?: PlanCollisionFreeRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PlanCollisionFreeResponse>>;
8070
8467
  /**
8071
8468
  * 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
8469
  * @summary Plan Trajectory
@@ -8082,6 +8479,15 @@ export declare const TrajectoryPlanningApiFp: (configuration?: Configuration) =>
8082
8479
  * @export
8083
8480
  */
8084
8481
  export declare const TrajectoryPlanningApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
8482
+ /**
8483
+ * 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.
8484
+ * @summary Plan Collision-Free Trajectory
8485
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
8486
+ * @param {PlanCollisionFreeRequest} [planCollisionFreeRequest]
8487
+ * @param {*} [options] Override http request option.
8488
+ * @throws {RequiredError}
8489
+ */
8490
+ planCollisionFree(cell: string, planCollisionFreeRequest?: PlanCollisionFreeRequest, options?: RawAxiosRequestConfig): AxiosPromise<PlanCollisionFreeResponse>;
8085
8491
  /**
8086
8492
  * 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
8493
  * @summary Plan Trajectory
@@ -8099,6 +8505,16 @@ export declare const TrajectoryPlanningApiFactory: (configuration?: Configuratio
8099
8505
  * @extends {BaseAPI}
8100
8506
  */
8101
8507
  export declare class TrajectoryPlanningApi extends BaseAPI {
8508
+ /**
8509
+ * 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.
8510
+ * @summary Plan Collision-Free Trajectory
8511
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
8512
+ * @param {PlanCollisionFreeRequest} [planCollisionFreeRequest]
8513
+ * @param {*} [options] Override http request option.
8514
+ * @throws {RequiredError}
8515
+ * @memberof TrajectoryPlanningApi
8516
+ */
8517
+ planCollisionFree(cell: string, planCollisionFreeRequest?: PlanCollisionFreeRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<PlanCollisionFreeResponse, any>>;
8102
8518
  /**
8103
8519
  * 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
8520
  * @summary Plan Trajectory