@wandelbots/nova-api 26.2.0-dev.8 → 26.2.0-rc.1

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.
@@ -7,7 +7,7 @@ import { AxiosInstance, AxiosPromise, RawAxiosRequestConfig } from "axios";
7
7
  * Wandelbots NOVA API
8
8
  * Interact with robots in an easy and intuitive way.
9
9
  *
10
- * The version of the OpenAPI document: 2.1.0
10
+ * The version of the OpenAPI document: 2.2.0
11
11
  *
12
12
  *
13
13
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -164,7 +164,7 @@ interface ActivateLicenseRequest {
164
164
  interface AddTrajectoryError {
165
165
  'message'?: string;
166
166
  /**
167
- * Location on trajectory where the execution will start. The default value is the start (forward movement) or end (backward movement) of the trajectory. If you want to start your movement from an arbitrary location, e.g., in combination with [streamMoveToTrajectoryViaJointPTP](streamMoveToTrajectoryViaJointPTP), set the location by respecting the following format: - The location is a scalar value that defines a position along a path, typically ranging from 0 to `n`, where `n` denotes the number of motion commands - Each integer value of the location corresponds to a specific motion command, while non-integer values interpolate positions within the segments. - The location is calculated from the joint path
167
+ * - The location is a scalar value that defines a position along a path, typically ranging from 0 to `n`, where `n` denotes the number of motion commands - Each integer value of the location corresponds to a specific motion command, while non-integer values interpolate positions within the segments. - The location is calculated from the joint path
168
168
  */
169
169
  'location'?: number;
170
170
  'data'?: AddTrajectoryErrorData;
@@ -172,7 +172,21 @@ interface AddTrajectoryError {
172
172
  /**
173
173
  * @type AddTrajectoryErrorData
174
174
  */
175
- type AddTrajectoryErrorData = CollisionError | InconsistentTrajectorySizeError | InvalidDofError | JointLimitExceededError | NanValueError | TcpRequiredError | TorqueExceededError;
175
+ type AddTrajectoryErrorData = {
176
+ kind: 'CollisionError';
177
+ } & CollisionError | {
178
+ kind: 'InconsistentTrajectorySizeError';
179
+ } & InconsistentTrajectorySizeError | {
180
+ kind: 'InvalidDofError';
181
+ } & InvalidDofError | {
182
+ kind: 'JointLimitExceededError';
183
+ } & JointLimitExceededError | {
184
+ kind: 'NanValueError';
185
+ } & NanValueError | {
186
+ kind: 'TcpRequiredError';
187
+ } & TcpRequiredError | {
188
+ kind: 'TorqueExceededError';
189
+ } & TorqueExceededError;
176
190
  interface AddTrajectoryRequest {
177
191
  /**
178
192
  * Unique identifier of the motion group the trajectory is planned for.
@@ -188,11 +202,11 @@ interface AddTrajectoryRequest {
188
202
  'tcp'?: string;
189
203
  }
190
204
  /**
191
- * The response signals if the trajectory is valid or faulty resulting in an executable, partially executable or not executable state. - valid trajectory: response contains only the unique identifier for the trajectory - trajectory has error on path: response contains the unique identifier for the trajectory and information about the failure. It is executable up to the point of failure. - trajectory has error at start or invalid data: response contains only information about the failure. To execute the trajectory use the unique identifier for calling [executeTrajectory](executeTrajectory). If you want to validate your trajectory before execution, execute it with a virtual motion group and check the state in the response stream of [executeTrajectory](executeTrajectory).
205
+ * The response signals if the trajectory is valid or faulty, resulting in an executable, partially executable or non-executable state. - valid trajectory: response contains only the unique identifier for the trajectory - trajectory has error on path: response contains the unique identifier for the trajectory and information about the failure. It is executable up to the point of failure. - trajectory has error at start or invalid data: response contains only information about the failure. To execute the trajectory, use the unique identifier for calling [executeTrajectory](#/operations/executeTrajectory). If you want to validate your trajectory before execution, execute it with a virtual motion group and check the state in the response stream of [executeTrajectory](#/operations/executeTrajectory).
192
206
  */
193
207
  interface AddTrajectoryResponse {
194
208
  /**
195
- * The unique identifier of the trajectory. Use this identifier to execute the trajectory with the [executeTrajectory](executeTrajectory) endpoint.
209
+ * The unique identifier of the trajectory. Use this identifier to execute the trajectory with the [executeTrajectory](#/operations/executeTrajectory) endpoint.
196
210
  */
197
211
  'trajectory'?: string;
198
212
  /**
@@ -200,6 +214,11 @@ interface AddTrajectoryResponse {
200
214
  */
201
215
  'error'?: AddTrajectoryError;
202
216
  }
217
+ /**
218
+ * @type AddVirtualControllerMotionGroupRequest
219
+ * Request body wrapper for `addVirtualControllerMotionGroup`. Allow callers to either reference a predefined motion group model or upload a full JSON configuration that the backend extracts into a motion group description.
220
+ */
221
+ type AddVirtualControllerMotionGroupRequest = MotionGroupFromJson | MotionGroupFromType;
203
222
  interface ApiVersion {
204
223
  /**
205
224
  * The version of the API.
@@ -239,7 +258,7 @@ interface App {
239
258
  'diagnosis_path'?: string;
240
259
  }
241
260
  /**
242
- * ## BEHAVIOR_AUTOMATIC This is the default behavior. The motion groups of the controller take commanded joint configuration as actual joint state. Configures the compliance of the virtual robot with the normal ControllerState cycle time. If set, the virtual robot will act like a physical one, e.g., with a cycle time of 8ms to respond to a new joint state command. ## BEHAVIOR_AUTOMATIC_NOT_COMPLY_WITH_CYCLETIME Configures the compliance of the virtual robot with the normal ControllerState cycle time. If set, the robot will respond as fast as possible, limited only by software execution speed. Because of that the execution of a movement requires less time than with BEHAVIOR_AUTOMATIC. ## BEHAVIOR_EXTERNAL_SOURCE The external client is the only source of actual joint state changes. This mode is used to enable third party software indicating the current joint state via [externalJointsStream](externalJointsStream).
261
+ * ## BEHAVIOR_AUTOMATIC This is the default behavior. The motion groups of the controller take commanded joint configuration as actual joint state. Configures the compliance of the virtual robot with the normal ControllerState cycle time. If set, the virtual robot will act like a physical one, e.g., with a cycle time of 8ms to respond to a new joint state command. ## BEHAVIOR_AUTOMATIC_NOT_COMPLY_WITH_CYCLETIME Configures the compliance of the virtual robot with the normal ControllerState cycle time. If set, the robot will respond as fast as possible, limited only by software execution speed. Because of that, the execution of a movement requires less time than with BEHAVIOR_AUTOMATIC. ## BEHAVIOR_EXTERNAL_SOURCE The external client is the only source of actual joint state changes. This mode is used to enable third party software indicating the current joint state via [externalJointsStream](#/operations/externalJointsStream).
243
262
  */
244
263
  declare const Behavior: {
245
264
  readonly BehaviorAutomatic: "BEHAVIOR_AUTOMATIC";
@@ -349,7 +368,7 @@ interface BusIODescription {
349
368
  */
350
369
  'io': string;
351
370
  /**
352
- * Name of the input/output. Customize it using the respective BUS service, e.g., [addProfinetIO](addProfinetIO) for PROFINET service.
371
+ * Name of the input/output. Customize it using the respective BUS service, e.g., [addProfinetIO](#/operations/addProfinetIO) for PROFINET service.
353
372
  */
354
373
  'name': string;
355
374
  'direction': IODirection;
@@ -576,6 +595,10 @@ interface Cell {
576
595
  * A unique name for the cell used as an identifier for addressing the cell in all API calls. It must be a valid k8s label name as defined by [RFC 1123](https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#dns-label-names).
577
596
  */
578
597
  'name': string;
598
+ /**
599
+ * Wandelbots NOVA version of the cell. This version must not exceed the current system version.
600
+ */
601
+ 'version'?: string;
579
602
  /**
580
603
  * A description of the cell.
581
604
  */
@@ -636,8 +659,13 @@ interface CollisionContact {
636
659
  'root'?: Array<number>;
637
660
  }
638
661
  interface CollisionError {
662
+ 'kind': CollisionErrorKindEnum;
639
663
  'collision'?: FeedbackCollision;
640
664
  }
665
+ declare const CollisionErrorKindEnum: {
666
+ readonly CollisionError: "CollisionError";
667
+ };
668
+ type CollisionErrorKindEnum = typeof CollisionErrorKindEnum[keyof typeof CollisionErrorKindEnum];
641
669
  /**
642
670
  * @type CollisionFreeAlgorithm
643
671
  * Configuration for collision-free path planning algorithms. Different algorithms may have different parameters and behavior. Recommendation: - For **cells with many obstacles**, use the RRTConnect algorithm. Use it as a starting point. - For **simple cells with very few obstacles** and when a faster solution is needed, try the MidpointInsertion algorithm.
@@ -777,7 +805,7 @@ interface ContainerResources {
777
805
  'memory_limit'?: string;
778
806
  }
779
807
  /**
780
- * 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).
808
+ * 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](#/operations/storeObject).
781
809
  */
782
810
  interface ContainerStorage {
783
811
  'mount_path': string;
@@ -912,6 +940,7 @@ interface DHParameter {
912
940
  * True, if rotation direction of joint is reversed.
913
941
  */
914
942
  'reverse_rotation_direction'?: boolean;
943
+ 'type'?: JointTypeEnum;
915
944
  }
916
945
  /**
917
946
  * The direction in which the trajectory is executed. Default: Forward.
@@ -985,7 +1014,7 @@ type ErrorMaxIterationsExceededErrorFeedbackNameEnum = typeof ErrorMaxIterations
985
1014
  */
986
1015
  interface Execute {
987
1016
  /**
988
- * Commanded joint position of each joint in [rad]. This command was sent in the time step the corresponding state was received.
1017
+ * Commanded joint position of each joint. This command was sent in the time step the corresponding state was received. The unit depends on the type of joint: For revolute joints, the angle is given in [rad]; for prismatic joints, the displacement is given in [mm].
989
1018
  */
990
1019
  'joint_position': Array<number>;
991
1020
  'details'?: ExecuteDetails;
@@ -1122,11 +1151,11 @@ interface ForwardKinematics422Response {
1122
1151
  }
1123
1152
  interface ForwardKinematicsRequest {
1124
1153
  /**
1125
- * String identifiying the model of a motion group.
1154
+ * Identifies a single motion group model. See [getMotionGroupModels](#/operations/getMotionGroupModels) for supported types.
1126
1155
  */
1127
1156
  'motion_group_model': string;
1128
1157
  /**
1129
- * List of joint positions [rad] for which TCP poses are computed.
1158
+ * List of joint positions for which TCP poses are computed. The unit depends on the type of joint: For revolute joints, the angle is given in [rad]; for prismatic joints, the displacement is given in [mm].
1130
1159
  */
1131
1160
  'joint_positions': Array<Array<number>>;
1132
1161
  'tcp_offset'?: Pose;
@@ -1291,8 +1320,13 @@ interface ImageCredentials {
1291
1320
  * Indicates that the trajectory contains an inconsistent number of joint positions, times, or locations.
1292
1321
  */
1293
1322
  interface InconsistentTrajectorySizeError {
1323
+ 'kind': InconsistentTrajectorySizeErrorKindEnum;
1294
1324
  'inconsistent_trajectory_size'?: InconsistentTrajectorySizeErrorInconsistentTrajectorySize;
1295
1325
  }
1326
+ declare const InconsistentTrajectorySizeErrorKindEnum: {
1327
+ readonly InconsistentTrajectorySizeError: "InconsistentTrajectorySizeError";
1328
+ };
1329
+ type InconsistentTrajectorySizeErrorKindEnum = typeof InconsistentTrajectorySizeErrorKindEnum[keyof typeof InconsistentTrajectorySizeErrorKindEnum];
1296
1330
  interface InconsistentTrajectorySizeErrorInconsistentTrajectorySize {
1297
1331
  'joint_position_size'?: number;
1298
1332
  'times_size'?: number;
@@ -1343,7 +1377,7 @@ interface InitializeMovementRequest {
1343
1377
  'message_type': InitializeMovementRequestMessageTypeEnum;
1344
1378
  'trajectory': InitializeMovementRequestTrajectory;
1345
1379
  /**
1346
- * Location on trajectory where the execution will start. The default value is the start (forward movement) or end (backward movement) of the trajectory. If you want to start your movement from an arbitrary location, e.g., in combination with [streamMoveToTrajectoryViaJointPTP](streamMoveToTrajectoryViaJointPTP), set the location by respecting the following format: - The location is a scalar value that defines a position along a path, typically ranging from 0 to `n`, where `n` denotes the number of motion commands - Each integer value of the location corresponds to a specific motion command, while non-integer values interpolate positions within the segments. - The location is calculated from the joint path
1380
+ * - The location is a scalar value that defines a position along a path, typically ranging from 0 to `n`, where `n` denotes the number of motion commands - Each integer value of the location corresponds to a specific motion command, while non-integer values interpolate positions within the segments. - The location is calculated from the joint path
1347
1381
  */
1348
1382
  'initial_location'?: number;
1349
1383
  /**
@@ -1369,7 +1403,7 @@ interface InitializeMovementResponse {
1369
1403
  */
1370
1404
  'message'?: string;
1371
1405
  /**
1372
- * Error can occur if joint trajectory was added by [InitializeMovementRequest](InitializeMovementRequest) and the trajectory is invalid.
1406
+ * Error can occur if joint trajectory was added by InitializeMovementRequest and the trajectory is invalid.
1373
1407
  */
1374
1408
  'add_trajectory_error'?: AddTrajectoryError;
1375
1409
  'kind': InitializeMovementResponseKindEnum;
@@ -1390,8 +1424,13 @@ declare const IntegerValueValueTypeEnum: {
1390
1424
  };
1391
1425
  type IntegerValueValueTypeEnum = typeof IntegerValueValueTypeEnum[keyof typeof IntegerValueValueTypeEnum];
1392
1426
  interface InvalidDofError {
1427
+ 'kind': InvalidDofErrorKindEnum;
1393
1428
  'invalid_dof'?: InvalidDofErrorInvalidDof;
1394
1429
  }
1430
+ declare const InvalidDofErrorKindEnum: {
1431
+ readonly InvalidDofError: "InvalidDofError";
1432
+ };
1433
+ type InvalidDofErrorKindEnum = typeof InvalidDofErrorKindEnum[keyof typeof InvalidDofErrorKindEnum];
1395
1434
  interface InvalidDofErrorInvalidDof {
1396
1435
  /**
1397
1436
  * The valid degrees of freedom for the motion group.
@@ -1407,7 +1446,7 @@ interface InverseKinematics422Response {
1407
1446
  }
1408
1447
  interface InverseKinematicsRequest {
1409
1448
  /**
1410
- * String identifiying the model of a motion group.
1449
+ * Identifies a single motion group model. See [getMotionGroupModels](#/operations/getMotionGroupModels) for supported types.
1411
1450
  */
1412
1451
  'motion_group_model': string;
1413
1452
  /**
@@ -1420,7 +1459,7 @@ interface InverseKinematicsRequest {
1420
1459
  */
1421
1460
  'mounting'?: Pose;
1422
1461
  /**
1423
- * Joint position limits in [rad], indexed starting from base.
1462
+ * Joint position limits, indexed starting from base. The unit depends on the type of joint: For revolute joints, the limit is given in [rad]; for prismatic joints, it is given in [mm].
1424
1463
  */
1425
1464
  'joint_position_limits'?: Array<LimitRange>;
1426
1465
  /**
@@ -1526,8 +1565,13 @@ declare const JoggingRunningKindEnum: {
1526
1565
  };
1527
1566
  type JoggingRunningKindEnum = typeof JoggingRunningKindEnum[keyof typeof JoggingRunningKindEnum];
1528
1567
  interface JointLimitExceededError {
1568
+ 'kind': JointLimitExceededErrorKindEnum;
1529
1569
  'joint_limit_exceeded'?: FeedbackJointLimitExceeded;
1530
1570
  }
1571
+ declare const JointLimitExceededErrorKindEnum: {
1572
+ readonly JointLimitExceededError: "JointLimitExceededError";
1573
+ };
1574
+ type JointLimitExceededErrorKindEnum = typeof JointLimitExceededErrorKindEnum[keyof typeof JointLimitExceededErrorKindEnum];
1531
1575
  interface JointLimits {
1532
1576
  'position'?: LimitRange;
1533
1577
  'velocity'?: number;
@@ -1536,7 +1580,7 @@ interface JointLimits {
1536
1580
  }
1537
1581
  interface JointTrajectory {
1538
1582
  /**
1539
- * List of joint positions [rad] for each sample. The number of samples must match the number of timestamps provided in the times field.
1583
+ * List of joint positions for each sample. The number of samples must match the number of timestamps provided in the times field. The unit depends on the type of joint: For revolute joints, the angle is given in [rad]; for prismatic joints, the displacement is given in [mm].
1540
1584
  */
1541
1585
  'joint_positions': Array<Array<number>>;
1542
1586
  /**
@@ -1545,6 +1589,11 @@ interface JointTrajectory {
1545
1589
  'times': Array<number>;
1546
1590
  'locations': Array<number>;
1547
1591
  }
1592
+ declare const JointTypeEnum: {
1593
+ readonly RevoluteJoint: "REVOLUTE_JOINT";
1594
+ readonly PrismaticJoint: "PRISMATIC_JOINT";
1595
+ };
1596
+ type JointTypeEnum = typeof JointTypeEnum[keyof typeof JointTypeEnum];
1548
1597
  /**
1549
1598
  * Sets target joint velocities for jogging a motion group.
1550
1599
  */
@@ -1581,6 +1630,10 @@ type JointVelocityResponseKindEnum = typeof JointVelocityResponseKindEnum[keyof
1581
1630
  */
1582
1631
  interface KinematicModel {
1583
1632
  'dh_parameters'?: Array<DHParameter>;
1633
+ /**
1634
+ * Constant coordinate transformation between the motion group base frame and the start of the kinematic chain modeled by Denavit-Hartenberg parameters.
1635
+ */
1636
+ 'kinematic_chain_offset'?: Pose;
1584
1637
  /**
1585
1638
  * Optional name of the inverse kinematics solver.
1586
1639
  */
@@ -1711,7 +1764,7 @@ interface LimitsOverride {
1711
1764
  }
1712
1765
  interface ListTrajectoriesResponse {
1713
1766
  /**
1714
- * Identifiers of trajectories which are currently cached. Use [addTrajectory](addTrajectory) to add a new trajectory. Adding trajectories is necessary to execute them. Trajectories are removed if the corresponding motion group or controller disconnects.
1767
+ * Identifiers of trajectories which are currently cached. Use [addTrajectory](#/operations/addTrajectory) to add a new trajectory. Adding trajectories is necessary to execute them. Trajectories are removed if the corresponding motion group or controller disconnects.
1715
1768
  */
1716
1769
  'trajectories'?: Array<string>;
1717
1770
  }
@@ -1723,6 +1776,72 @@ declare const Manufacturer: {
1723
1776
  readonly Yaskawa: "yaskawa";
1724
1777
  };
1725
1778
  type Manufacturer = typeof Manufacturer[keyof typeof Manufacturer];
1779
+ interface MergeTrajectories422Response {
1780
+ 'detail'?: Array<MergeTrajectoriesValidationError>;
1781
+ }
1782
+ interface MergeTrajectoriesError {
1783
+ 'error_feedback': PlanTrajectoryFailedResponseErrorFeedback;
1784
+ /**
1785
+ * - The location is a scalar value that defines a position along a path, typically ranging from 0 to `n`, where `n` denotes the number of motion commands - Each integer value of the location corresponds to a specific motion command, while non-integer values interpolate positions within the segments. - The location is calculated from the joint path
1786
+ */
1787
+ 'error_location_on_trajectory': number;
1788
+ }
1789
+ interface MergeTrajectoriesRequest {
1790
+ /**
1791
+ * The motion group setup required for collision checking and timescaling.
1792
+ */
1793
+ 'motion_group_setup': MotionGroupSetup;
1794
+ /**
1795
+ * List of trajectory segments to merge together. Each segment contains a trajectory with its own limits override, blending configuration and collision setup.
1796
+ */
1797
+ 'trajectory_segments': Array<MergeTrajectoriesSegment>;
1798
+ }
1799
+ interface MergeTrajectoriesResponse {
1800
+ /**
1801
+ * The merged joint trajectory. If a blending was requested on a segment but could not be applied, the trajectory is merged without blending. The feedback will contain further information on why blending could not be applied.
1802
+ */
1803
+ 'joint_trajectory'?: JointTrajectory;
1804
+ /**
1805
+ * For each blending, feedback will either contain the section in which the trajectory deviates from the original path, or an error message stating why blending could not be applied. The response will include `trajectory_segments` - 1 elements. If no blending was requested at the corresponding segment, the feedback will be a null section where `start_location == end_location`.
1806
+ */
1807
+ 'feedback'?: Array<MergeTrajectoriesResponseFeedbackInner>;
1808
+ }
1809
+ /**
1810
+ * @type MergeTrajectoriesResponseFeedbackInner
1811
+ */
1812
+ type MergeTrajectoriesResponseFeedbackInner = MergeTrajectoriesError | TrajectorySection;
1813
+ interface MergeTrajectoriesSegment {
1814
+ /**
1815
+ * The trajectory segment to merge. Both the time and location arrays must start at 0 and be strictly increasing.
1816
+ */
1817
+ 'trajectory': JointTrajectory;
1818
+ /**
1819
+ * Limits override is used to override the global limits of the motion group for the blending at the end of this segment.
1820
+ */
1821
+ 'limits_override'?: LimitsOverride;
1822
+ /**
1823
+ * Blending configuration for merging this trajectory segment with the next one. Specifies how the end of this trajectory should be blended with the start of the next trajectory. Ignored for the last segment.
1824
+ */
1825
+ 'blending'?: BlendingPosition;
1826
+ /**
1827
+ * 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.
1828
+ */
1829
+ 'collision_setups'?: {
1830
+ [key: string]: CollisionSetup;
1831
+ };
1832
+ }
1833
+ interface MergeTrajectoriesValidationError {
1834
+ 'loc': Array<ValidationErrorLocInner>;
1835
+ 'msg': string;
1836
+ 'type': string;
1837
+ 'input': {
1838
+ [key: string]: any;
1839
+ };
1840
+ /**
1841
+ * Optional data further specifying the merge validation error.
1842
+ */
1843
+ 'data'?: ErrorInvalidJointCount;
1844
+ }
1726
1845
  interface MidpointInsertionAlgorithm {
1727
1846
  /**
1728
1847
  * Algorithm discriminator. Midpoint insertion algorithm configuration for collision-free path planning. This algorithm adds a single midpoint between the start and target joint position to find collision-free paths.
@@ -1833,11 +1952,11 @@ type MotionCommandBlending = BlendingAuto | BlendingPosition;
1833
1952
  */
1834
1953
  type MotionCommandPath = PathCartesianPTP | PathCircle | PathCubicSpline | PathJointPTP | PathLine;
1835
1954
  /**
1836
- * The configuration of a motion-group used for motion planning.
1955
+ * The configuration of a motion-group used for motion planning. The parameters `mounting`, `kinematic_chain_offset`, `dh_parameters` and `tcp_offset` are used to model the kinematic structure of the motion group. They can be used to compute the coordinate transformations from world to tcp frame: [world frame] -> mounting -> [base frame] -> kinematic chain offset + motion group kinematics (Denavit-Hartenberg parameters) -> [flange frame] -> tcp_offset -> [tcp frame].
1837
1956
  */
1838
1957
  interface MotionGroupDescription {
1839
1958
  /**
1840
- * String identifiying the model of a motion group.
1959
+ * Identifies a single motion group model. See [getMotionGroupModels](#/operations/getMotionGroupModels) for supported types.
1841
1960
  */
1842
1961
  'motion_group_model': string;
1843
1962
  /**
@@ -1882,14 +2001,50 @@ interface MotionGroupDescription {
1882
2001
  */
1883
2002
  'cycle_time'?: number;
1884
2003
  /**
1885
- * The DH parameters describing the motion group geometry, starting from base.
2004
+ * The Denavit-Hartenberg parameters describing the motion group kinematics.
1886
2005
  */
1887
2006
  'dh_parameters'?: Array<DHParameter>;
2007
+ /**
2008
+ * Constant coordinate transformation between the motion group base frame and the start of the kinematic chain modelled by Denavit-Hartenberg parameters. Unlike the mounting, which is used to set the actual position and orientation of the motion group within a cell, this offset is fixed. It is part of the description of the kinematical structure of the motion group.
2009
+ */
2010
+ 'kinematic_chain_offset'?: Pose;
1888
2011
  /**
1889
2012
  * The serial number of the motion group, if available. If not available, the serial number of the robot controller. If not available, empty.
1890
2013
  */
1891
2014
  'serial_number'?: string;
1892
2015
  }
2016
+ interface MotionGroupFromJson {
2017
+ /**
2018
+ * Unique identifier for the motion group to be added.
2019
+ */
2020
+ 'motion_group': string;
2021
+ /**
2022
+ * Full JSON configuration of the virtual robot controller. This can be obtained from the physical controller\'s configuration via [getVirtualControllerConfiguration](#/operations/getVirtualControllerConfiguration).
2023
+ */
2024
+ 'json_data': string;
2025
+ /**
2026
+ * The identifier of the motion group that needs to be extracted from the provided JSON configuration.
2027
+ */
2028
+ 'extracted_motion_group_id': string;
2029
+ /**
2030
+ * Initial joint position of the added motion group. Provides the joint position as a JSON array of float values in radians, where the array length must match the robot\'s degrees of freedom (DOF), e.g., `\"[0, 0, 0, 0, 0, 0]\"` for a 6-DOF robot. If the provided array length does not match the robot\'s DOF, the array will be adjusted: if it is longer, extra values will be truncated; if it is shorter, missing values will be filled with zeros.
2031
+ */
2032
+ 'initial_joint_position'?: string;
2033
+ }
2034
+ interface MotionGroupFromType {
2035
+ /**
2036
+ * Unique identifier for the motion group to be added.
2037
+ */
2038
+ 'motion_group': string;
2039
+ /**
2040
+ * Identifies a single motion group model. See [getMotionGroupModels](#/operations/getMotionGroupModels) for supported types.
2041
+ */
2042
+ 'motion_group_model': string;
2043
+ /**
2044
+ * Initial joint position of the added motion group. Provides the joint position as a JSON array of float values in radians, where the array length must match the robot\'s degrees of freedom (DOF), e.g., `\"[0, 0, 0, 0, 0, 0]\"` for a 6-DOF robot. If the provided array length does not match the robot\'s DOF, the array will be adjusted; if it is longer, extra values will be truncated; if it is shorter, missing values will be filled with zeros.
2045
+ */
2046
+ 'initial_joint_position'?: string;
2047
+ }
1893
2048
  interface MotionGroupInfo {
1894
2049
  /**
1895
2050
  * The unique identifier of the motion group. Use it to refer to the motion group in other calls.
@@ -1905,7 +2060,7 @@ interface MotionGroupInfo {
1905
2060
  'dof': number;
1906
2061
  }
1907
2062
  /**
1908
- * Ensure to provide one value for each joint. See [getMotionGroups](getMotionGroups) for the number of joints. Everything but positions is optional.
2063
+ * Ensure to provide one value for each joint. See [getMotionGroups](#/operations/getMotionGroups) for the number of joints. Everything but positions is optional.
1909
2064
  */
1910
2065
  interface MotionGroupJoints {
1911
2066
  /**
@@ -1927,7 +2082,7 @@ interface MotionGroupJoints {
1927
2082
  }
1928
2083
  interface MotionGroupSetup {
1929
2084
  /**
1930
- * String identifiying the model of a motion group.
2085
+ * Identifies a single motion group model. See [getMotionGroupModels](#/operations/getMotionGroupModels) for supported types.
1931
2086
  */
1932
2087
  'motion_group_model': string;
1933
2088
  /**
@@ -1985,7 +2140,7 @@ interface MotionGroupState {
1985
2140
  */
1986
2141
  'joint_current'?: Array<number>;
1987
2142
  /**
1988
- * Pose of the flange. Positions are in [mm]. Oriantations are in [rad]. The pose is relative to the response_coordinate_system specified in the request. For robot arms a flange pose is always returned, for positioners the flange might not be available, depending on the model.
2143
+ * Pose of the flange. Positions are in [mm]. Orientations are in [rad]. The pose is relative to the response_coordinate_system specified in the request. For robot arms, a flange pose is always returned. For positioners, the flange might not be available, depending on the model.
1989
2144
  */
1990
2145
  'flange_pose'?: Pose;
1991
2146
  /**
@@ -1993,7 +2148,7 @@ interface MotionGroupState {
1993
2148
  */
1994
2149
  'tcp'?: string;
1995
2150
  /**
1996
- * Pose of the TCP selected on the robot control panel. Positions are in [mm]. Oriantations are in [rad]. The pose is relative to the response_coordinate_system specified in the request. Might not be returned for positioners as some do not support TCPs, depending on the model.
2151
+ * Pose of the TCP selected on the robot control panel. Positions are in [mm]. Orientations are in [rad]. The pose is relative to the response_coordinate_system specified in the request. Might not be returned for positioners as some do not support TCPs, depending on the model.
1997
2152
  */
1998
2153
  'tcp_pose'?: Pose;
1999
2154
  /**
@@ -2037,8 +2192,13 @@ declare const MovementErrorResponseKindEnum: {
2037
2192
  };
2038
2193
  type MovementErrorResponseKindEnum = typeof MovementErrorResponseKindEnum[keyof typeof MovementErrorResponseKindEnum];
2039
2194
  interface NanValueError {
2195
+ 'kind': NanValueErrorKindEnum;
2040
2196
  'nan_value'?: NanValueErrorNanValue;
2041
2197
  }
2198
+ declare const NanValueErrorKindEnum: {
2199
+ readonly NanValueError: "NanValueError";
2200
+ };
2201
+ type NanValueErrorKindEnum = typeof NanValueErrorKindEnum[keyof typeof NanValueErrorKindEnum];
2042
2202
  /**
2043
2203
  * Requested joint position contains NaN values.
2044
2204
  */
@@ -2279,11 +2439,11 @@ declare const PauseMovementRequestMessageTypeEnum: {
2279
2439
  };
2280
2440
  type PauseMovementRequestMessageTypeEnum = typeof PauseMovementRequestMessageTypeEnum[keyof typeof PauseMovementRequestMessageTypeEnum];
2281
2441
  /**
2282
- * Acknowledgment for PauseMovementRequest message. ATTENTION: No confirmation that the movement was paused. Confirmation that the PauseMovementRequest was received and is processed. End of movement execution is signalled by [StillstandResponse](StillstandResponse).
2442
+ * Acknowledgment for PauseMovementRequest message. ATTENTION: No confirmation that the movement was paused. Confirmation that the PauseMovementRequest was received and is processed. End of movement execution is signalled by [state stream](#/operations/streamMotionGroupState) response. See TrajectoryDetails of details in execute.
2283
2443
  */
2284
2444
  interface PauseMovementResponse {
2285
2445
  /**
2286
- * Error message in case of invalid PauseMovementResquest.
2446
+ * Error message in case of invalid PauseMovementRequest.
2287
2447
  */
2288
2448
  'message'?: string;
2289
2449
  'kind': PauseMovementResponseKindEnum;
@@ -2329,7 +2489,7 @@ interface PlanCollisionFreeFailedResponse {
2329
2489
  }
2330
2490
  interface PlanCollisionFreeRequest {
2331
2491
  /**
2332
- * The data to assemble the robot setup can be retrieved from [getMotionGroupDescription](getMotionGroupDescription) endpoint.
2492
+ * The data to assemble the robot setup can be retrieved from the [getMotionGroupDescription](#/operations/getMotionGroupDescription) endpoint.
2333
2493
  */
2334
2494
  'motion_group_setup': MotionGroupSetup;
2335
2495
  'start_joint_position': Array<number>;
@@ -2349,7 +2509,7 @@ type PlanCollisionFreeResponseResponse = JointTrajectory | PlanCollisionFreeFail
2349
2509
  interface PlanTrajectoryFailedResponse {
2350
2510
  'error_feedback': PlanTrajectoryFailedResponseErrorFeedback;
2351
2511
  /**
2352
- * Location on trajectory where the execution will start. The default value is the start (forward movement) or end (backward movement) of the trajectory. If you want to start your movement from an arbitrary location, e.g., in combination with [streamMoveToTrajectoryViaJointPTP](streamMoveToTrajectoryViaJointPTP), set the location by respecting the following format: - The location is a scalar value that defines a position along a path, typically ranging from 0 to `n`, where `n` denotes the number of motion commands - Each integer value of the location corresponds to a specific motion command, while non-integer values interpolate positions within the segments. - The location is calculated from the joint path
2512
+ * - The location is a scalar value that defines a position along a path, typically ranging from 0 to `n`, where `n` denotes the number of motion commands - Each integer value of the location corresponds to a specific motion command, while non-integer values interpolate positions within the segments. - The location is calculated from the joint path
2353
2513
  */
2354
2514
  'error_location_on_trajectory': number;
2355
2515
  /**
@@ -2363,7 +2523,7 @@ interface PlanTrajectoryFailedResponse {
2363
2523
  type PlanTrajectoryFailedResponseErrorFeedback = FeedbackCollision | FeedbackJointLimitExceeded | FeedbackOutOfWorkspace | FeedbackSingularity;
2364
2524
  interface PlanTrajectoryRequest {
2365
2525
  /**
2366
- * The data to assemble the robot setup can be retrieved from [getMotionGroupDescription](getMotionGroupDescription) endpoint.
2526
+ * The data to assemble the robot setup can be retrieved from [getMotionGroupDescription](#/operations/getMotionGroupDescription) endpoint.
2367
2527
  */
2368
2528
  'motion_group_setup': MotionGroupSetup;
2369
2529
  'start_joint_position': Array<number>;
@@ -2730,7 +2890,7 @@ declare const RectangularCapsuleShapeTypeEnum: {
2730
2890
  };
2731
2891
  type RectangularCapsuleShapeTypeEnum = typeof RectangularCapsuleShapeTypeEnum[keyof typeof RectangularCapsuleShapeTypeEnum];
2732
2892
  /**
2733
- * The channel that defines what a new Wandelbots NOVA version is. * `next` the over all latest version * `stable` newes patch of the current version
2893
+ * The channel that defines what a new Wandelbots NOVA version is. * `next` the latest version * `stable` newest patch of the current version
2734
2894
  */
2735
2895
  declare const ReleaseChannel: {
2736
2896
  readonly Stable: "stable";
@@ -2751,6 +2911,19 @@ interface RobotController {
2751
2911
  * @type RobotControllerConfiguration
2752
2912
  */
2753
2913
  type RobotControllerConfiguration = AbbController | FanucController | KukaController | UniversalrobotsController | VirtualController | YaskawaController;
2914
+ /**
2915
+ * Information to generate all robot controller configurations that match a given ARP scan result.
2916
+ */
2917
+ interface RobotControllerConfigurationRequest {
2918
+ /**
2919
+ * The IPv4 address assigned to the network interface where the ARP scan was performed.
2920
+ */
2921
+ 'ip': string;
2922
+ /**
2923
+ * Array of network devices.
2924
+ */
2925
+ 'network_devices': Array<NetworkDevice>;
2926
+ }
2754
2927
  /**
2755
2928
  * Returns the whole current state of robot controller.
2756
2929
  */
@@ -2787,7 +2960,7 @@ interface RobotControllerState {
2787
2960
  'motion_groups': Array<MotionGroupState>;
2788
2961
  }
2789
2962
  /**
2790
- * 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.
2963
+ * 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](#/operations/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](#/operations/getSupportedModes) to check Free Drive availability.
2791
2964
  */
2792
2965
  declare const RobotSystemMode: {
2793
2966
  readonly ModeControllerNotConfigured: "MODE_CONTROLLER_NOT_CONFIGURED";
@@ -2911,9 +3084,14 @@ interface SetIO {
2911
3084
  'location': number;
2912
3085
  'io_origin': IOOrigin;
2913
3086
  }
3087
+ /**
3088
+ * Defines available system modes of the robot system. Short versions (no \"ROBOT_SYSTEM_\" prefix) are provided, reusing strings from [getMode](#/operations/getMode) responses.
3089
+ */
2914
3090
  declare const SettableRobotSystemMode: {
2915
3091
  readonly RobotSystemModeMonitor: "ROBOT_SYSTEM_MODE_MONITOR";
3092
+ readonly ModeMonitor: "MODE_MONITOR";
2916
3093
  readonly RobotSystemModeControl: "ROBOT_SYSTEM_MODE_CONTROL";
3094
+ readonly ModeControl: "MODE_CONTROL";
2917
3095
  };
2918
3096
  type SettableRobotSystemMode = typeof SettableRobotSystemMode[keyof typeof SettableRobotSystemMode];
2919
3097
  declare const SingularityTypeEnum: {
@@ -2937,7 +3115,7 @@ declare const SphereShapeTypeEnum: {
2937
3115
  };
2938
3116
  type SphereShapeTypeEnum = typeof SphereShapeTypeEnum[keyof typeof SphereShapeTypeEnum];
2939
3117
  /**
2940
- * Moves the motion group along a trajectory, added via [planTrajectory](planTrajectory) or [planMotion](planMotion). Trajectories can be executed forwards or backwards(\"in reverse\"). Pause the execution with PauseMovementRequest. Resume execution with StartMovementRequest. Precondition: To start execution, the motion group must be located at the trajectory\'s start location specified in InitializeMovementRequest.
3118
+ * Moves the motion group along a trajectory, added via [planTrajectory](#/operations/planTrajectory) or [planMotion](#/operations/planMotion). Trajectories can be executed forwards or backwards(\"in reverse\"). Pause the execution with PauseMovementRequest. Resume execution with StartMovementRequest. Precondition: To start execution, the motion group must be located at the trajectory\'s start location specified in InitializeMovementRequest.
2941
3119
  */
2942
3120
  interface StartMovementRequest {
2943
3121
  /**
@@ -2946,7 +3124,7 @@ interface StartMovementRequest {
2946
3124
  'message_type': StartMovementRequestMessageTypeEnum;
2947
3125
  'direction'?: Direction;
2948
3126
  /**
2949
- * Location on trajectory where the execution will start. The default value is the start (forward movement) or end (backward movement) of the trajectory. If you want to start your movement from an arbitrary location, e.g., in combination with [streamMoveToTrajectoryViaJointPTP](streamMoveToTrajectoryViaJointPTP), set the location by respecting the following format: - The location is a scalar value that defines a position along a path, typically ranging from 0 to `n`, where `n` denotes the number of motion commands - Each integer value of the location corresponds to a specific motion command, while non-integer values interpolate positions within the segments. - The location is calculated from the joint path
3127
+ * - The location is a scalar value that defines a position along a path, typically ranging from 0 to `n`, where `n` denotes the number of motion commands - Each integer value of the location corresponds to a specific motion command, while non-integer values interpolate positions within the segments. - The location is calculated from the joint path
2950
3128
  */
2951
3129
  'target_location'?: number;
2952
3130
  /**
@@ -2967,7 +3145,7 @@ declare const StartMovementRequestMessageTypeEnum: {
2967
3145
  };
2968
3146
  type StartMovementRequestMessageTypeEnum = typeof StartMovementRequestMessageTypeEnum[keyof typeof StartMovementRequestMessageTypeEnum];
2969
3147
  /**
2970
- * Acknowledgment for StartMovementRequest message. ATTENTION: No confirmation that the movement was started. Confirmation that the StartMovementRequest was received and is processed. Fields `execute` and `standstill` of response of [streamMotionGroupState](streamMotionGroupState) signal start of movement execution.
3148
+ * Acknowledgment for StartMovementRequest message. ATTENTION: No confirmation that the movement was started. Confirmation that the StartMovementRequest was received and is processed. Fields `execute` and `standstill` of response of [streamMotionGroupState](#/operations/streamMotionGroupState) signal start of movement execution.
2971
3149
  */
2972
3150
  interface StartMovementResponse {
2973
3151
  /**
@@ -3016,10 +3194,15 @@ interface TcpOffset {
3016
3194
  * Requested motion group requires TCP to be defined.
3017
3195
  */
3018
3196
  interface TcpRequiredError {
3197
+ 'kind': TcpRequiredErrorKindEnum;
3019
3198
  'tcp_missing'?: any;
3020
3199
  }
3200
+ declare const TcpRequiredErrorKindEnum: {
3201
+ readonly TcpRequiredError: "TcpRequiredError";
3202
+ };
3203
+ type TcpRequiredErrorKindEnum = typeof TcpRequiredErrorKindEnum[keyof typeof TcpRequiredErrorKindEnum];
3021
3204
  /**
3022
- * Sets target TCP velocities for jogging a motion group. The motion group needs to have an inverse kinematic solver to be jogged by TCP velocities. Check `supports_inverse_kinematics` field in response of [listController](listController) for the motion group.
3205
+ * Sets target TCP velocities for jogging a motion group. The motion group needs to have an inverse kinematic solver to be jogged by TCP velocities. Check `supports_inverse_kinematics` field in response of [listController](#/operations/listController) for the motion group.
3023
3206
  */
3024
3207
  interface TcpVelocityRequest {
3025
3208
  /**
@@ -3058,8 +3241,13 @@ declare const TcpVelocityResponseKindEnum: {
3058
3241
  };
3059
3242
  type TcpVelocityResponseKindEnum = typeof TcpVelocityResponseKindEnum[keyof typeof TcpVelocityResponseKindEnum];
3060
3243
  interface TorqueExceededError {
3244
+ 'kind': TorqueExceededErrorKindEnum;
3061
3245
  'torque_exceeded'?: TorqueExceededErrorTorqueExceeded;
3062
3246
  }
3247
+ declare const TorqueExceededErrorKindEnum: {
3248
+ readonly TorqueExceededError: "TorqueExceededError";
3249
+ };
3250
+ type TorqueExceededErrorKindEnum = typeof TorqueExceededErrorKindEnum[keyof typeof TorqueExceededErrorKindEnum];
3063
3251
  interface TorqueExceededErrorTorqueExceeded {
3064
3252
  /**
3065
3253
  * The torque value that was exceeded.
@@ -3101,7 +3289,7 @@ interface TrajectoryDetails {
3101
3289
  */
3102
3290
  'trajectory': string;
3103
3291
  /**
3104
- * Location on trajectory where the execution will start. The default value is the start (forward movement) or end (backward movement) of the trajectory. If you want to start your movement from an arbitrary location, e.g., in combination with [streamMoveToTrajectoryViaJointPTP](streamMoveToTrajectoryViaJointPTP), set the location by respecting the following format: - The location is a scalar value that defines a position along a path, typically ranging from 0 to `n`, where `n` denotes the number of motion commands - Each integer value of the location corresponds to a specific motion command, while non-integer values interpolate positions within the segments. - The location is calculated from the joint path
3292
+ * - The location is a scalar value that defines a position along a path, typically ranging from 0 to `n`, where `n` denotes the number of motion commands - Each integer value of the location corresponds to a specific motion command, while non-integer values interpolate positions within the segments. - The location is calculated from the joint path
3105
3293
  */
3106
3294
  'location': number;
3107
3295
  'state': TrajectoryDetailsState;
@@ -3144,7 +3332,7 @@ interface TrajectoryId {
3144
3332
  */
3145
3333
  'message_type': TrajectoryIdMessageTypeEnum;
3146
3334
  /**
3147
- * The identifier of the trajectory which was returned by the [addTrajectory](addTrajectory) endpoint.
3335
+ * The identifier of the trajectory which was returned by the [addTrajectory](#/operations/addTrajectory) endpoint.
3148
3336
  */
3149
3337
  'id': string;
3150
3338
  }
@@ -3186,6 +3374,10 @@ declare const TrajectoryRunningKindEnum: {
3186
3374
  readonly Running: "RUNNING";
3187
3375
  };
3188
3376
  type TrajectoryRunningKindEnum = typeof TrajectoryRunningKindEnum[keyof typeof TrajectoryRunningKindEnum];
3377
+ interface TrajectorySection {
3378
+ 'start_location': number;
3379
+ 'end_location': number;
3380
+ }
3189
3381
  /**
3190
3382
  * Waiting for an I/O event to start execution.
3191
3383
  */
@@ -3223,11 +3415,21 @@ declare const UniversalrobotsControllerKindEnum: {
3223
3415
  readonly UniversalrobotsController: "UniversalrobotsController";
3224
3416
  };
3225
3417
  type UniversalrobotsControllerKindEnum = typeof UniversalrobotsControllerKindEnum[keyof typeof UniversalrobotsControllerKindEnum];
3418
+ /**
3419
+ * Update a single cell\'s Foundation chart version based on the indicated release channel.
3420
+ */
3421
+ interface UpdateCellVersionRequest {
3422
+ 'channel': ReleaseChannel;
3423
+ }
3226
3424
  /**
3227
3425
  * An update is defined by the indicated Wandelbots NOVA release channel.
3228
3426
  */
3229
3427
  interface UpdateNovaVersionRequest {
3230
3428
  'channel': ReleaseChannel;
3429
+ /**
3430
+ * Update unpinned cells during system update. Cells with an explicit chart version are never updated by a system update, regardless of this setting.
3431
+ */
3432
+ 'update_cells'?: boolean;
3231
3433
  }
3232
3434
  interface ValidationError {
3233
3435
  'loc': Array<ValidationErrorLocInner>;
@@ -3250,17 +3452,17 @@ interface ValidationError2 {
3250
3452
  */
3251
3453
  type ValidationErrorLocInner = number | string;
3252
3454
  /**
3253
- * The configuration of a virtual robot controller has to contain the manufacturer string, an optional joint position string array and either a preset `type` **or** the complete JSON configuration.
3455
+ * The configuration of a virtual robot controller has to contain the manufacturer string, an optional joint position string array, and either a preset `type` **or** the complete JSON configuration.
3254
3456
  */
3255
3457
  interface VirtualController {
3256
3458
  'kind': VirtualControllerKindEnum;
3257
3459
  'manufacturer': Manufacturer;
3258
3460
  /**
3259
- * Preset type of the virtual robot controller. See [getRobotConfigurations](getRobotConfigurations) for supported types.
3461
+ * Preset type of the virtual robot controller. See [getRobotConfigurations](#/operations/getRobotConfigurations) for supported types.
3260
3462
  */
3261
3463
  'type'?: string;
3262
3464
  /**
3263
- * Complete JSON configuration of the virtual robot controller. Can be obtained from the physical controller\'s configuration via [getVirtualControllerConfiguration](getVirtualControllerConfiguration). If provided, the `type` field should not be used.
3465
+ * Complete JSON configuration of the virtual robot controller. Can be obtained from the physical controller\'s configuration via [getVirtualControllerConfiguration](#/operations/getVirtualControllerConfiguration). If provided, the `type` field should not be used.
3264
3466
  */
3265
3467
  'json'?: string;
3266
3468
  /**
@@ -3278,7 +3480,7 @@ interface VirtualRobotConfiguration {
3278
3480
  */
3279
3481
  'name': string;
3280
3482
  /**
3281
- * Content of the configuration file. Copy & paste to the [addRobotController](addRobotController) configuration.json parameter.
3483
+ * Content of the configuration file. Copy & paste to the [addRobotController](#/operations/addRobotController) configuration.json parameter.
3282
3484
  */
3283
3485
  'content': string;
3284
3486
  }
@@ -3337,7 +3539,7 @@ declare const ApplicationApiAxiosParamCreator: (configuration?: Configuration) =
3337
3539
  */
3338
3540
  deleteApp: (cell: string, app: string, completionTimeout?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
3339
3541
  /**
3340
- * Get the configuration for an active GUI application in the cell. To update the configuration of a GUI application in the cell, use this configuration with [updateApp](updateApp).
3542
+ * Get the configuration for an active GUI application in the cell. To update the configuration of a GUI application in the cell, use this configuration with [updateApp](#/operations/updateApp).
3341
3543
  * @summary Configuration
3342
3544
  * @param {string} cell Unique identifier addressing a cell in all API calls.
3343
3545
  * @param {string} app
@@ -3346,7 +3548,7 @@ declare const ApplicationApiAxiosParamCreator: (configuration?: Configuration) =
3346
3548
  */
3347
3549
  getApp: (cell: string, app: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
3348
3550
  /**
3349
- * List all GUI applications that have been added to a cell with [addApp](addApp). If the cell does not contain GUI applications, the list is returned empty.
3551
+ * List all GUI applications that have been added to a cell with [addApp](#/operations/addApp). If the cell does not contain GUI applications, the list is returned empty.
3350
3552
  * @summary List Applications
3351
3553
  * @param {string} cell Unique identifier addressing a cell in all API calls.
3352
3554
  * @param {*} [options] Override http request option.
@@ -3399,7 +3601,7 @@ declare const ApplicationApiFp: (configuration?: Configuration) => {
3399
3601
  */
3400
3602
  deleteApp(cell: string, app: string, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
3401
3603
  /**
3402
- * Get the configuration for an active GUI application in the cell. To update the configuration of a GUI application in the cell, use this configuration with [updateApp](updateApp).
3604
+ * Get the configuration for an active GUI application in the cell. To update the configuration of a GUI application in the cell, use this configuration with [updateApp](#/operations/updateApp).
3403
3605
  * @summary Configuration
3404
3606
  * @param {string} cell Unique identifier addressing a cell in all API calls.
3405
3607
  * @param {string} app
@@ -3408,7 +3610,7 @@ declare const ApplicationApiFp: (configuration?: Configuration) => {
3408
3610
  */
3409
3611
  getApp(cell: string, app: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<App>>;
3410
3612
  /**
3411
- * List all GUI applications that have been added to a cell with [addApp](addApp). If the cell does not contain GUI applications, the list is returned empty.
3613
+ * List all GUI applications that have been added to a cell with [addApp](#/operations/addApp). If the cell does not contain GUI applications, the list is returned empty.
3412
3614
  * @summary List Applications
3413
3615
  * @param {string} cell Unique identifier addressing a cell in all API calls.
3414
3616
  * @param {*} [options] Override http request option.
@@ -3461,7 +3663,7 @@ declare const ApplicationApiFactory: (configuration?: Configuration, basePath?:
3461
3663
  */
3462
3664
  deleteApp(cell: string, app: string, completionTimeout?: number, options?: RawAxiosRequestConfig): AxiosPromise<void>;
3463
3665
  /**
3464
- * Get the configuration for an active GUI application in the cell. To update the configuration of a GUI application in the cell, use this configuration with [updateApp](updateApp).
3666
+ * Get the configuration for an active GUI application in the cell. To update the configuration of a GUI application in the cell, use this configuration with [updateApp](#/operations/updateApp).
3465
3667
  * @summary Configuration
3466
3668
  * @param {string} cell Unique identifier addressing a cell in all API calls.
3467
3669
  * @param {string} app
@@ -3470,7 +3672,7 @@ declare const ApplicationApiFactory: (configuration?: Configuration, basePath?:
3470
3672
  */
3471
3673
  getApp(cell: string, app: string, options?: RawAxiosRequestConfig): AxiosPromise<App>;
3472
3674
  /**
3473
- * List all GUI applications that have been added to a cell with [addApp](addApp). If the cell does not contain GUI applications, the list is returned empty.
3675
+ * List all GUI applications that have been added to a cell with [addApp](#/operations/addApp). If the cell does not contain GUI applications, the list is returned empty.
3474
3676
  * @summary List Applications
3475
3677
  * @param {string} cell Unique identifier addressing a cell in all API calls.
3476
3678
  * @param {*} [options] Override http request option.
@@ -3523,7 +3725,7 @@ declare class ApplicationApi extends BaseAPI {
3523
3725
  */
3524
3726
  deleteApp(cell: string, app: string, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
3525
3727
  /**
3526
- * Get the configuration for an active GUI application in the cell. To update the configuration of a GUI application in the cell, use this configuration with [updateApp](updateApp).
3728
+ * Get the configuration for an active GUI application in the cell. To update the configuration of a GUI application in the cell, use this configuration with [updateApp](#/operations/updateApp).
3527
3729
  * @summary Configuration
3528
3730
  * @param {string} cell Unique identifier addressing a cell in all API calls.
3529
3731
  * @param {string} app
@@ -3532,7 +3734,7 @@ declare class ApplicationApi extends BaseAPI {
3532
3734
  */
3533
3735
  getApp(cell: string, app: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<App, any>>;
3534
3736
  /**
3535
- * List all GUI applications that have been added to a cell with [addApp](addApp). If the cell does not contain GUI applications, the list is returned empty.
3737
+ * List all GUI applications that have been added to a cell with [addApp](#/operations/addApp). If the cell does not contain GUI applications, the list is returned empty.
3536
3738
  * @summary List Applications
3537
3739
  * @param {string} cell Unique identifier addressing a cell in all API calls.
3538
3740
  * @param {*} [options] Override http request option.
@@ -3566,7 +3768,7 @@ declare const BUSInputsOutputsApiAxiosParamCreator: (configuration?: Configurati
3566
3768
  */
3567
3769
  addBusIOService: (cell: string, busIOType: BusIOType, completionTimeout?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
3568
3770
  /**
3569
- * Adds an input/output variable to or updates an input/output variable on the MODBUS device, e.g., NOVA\'s MODBUS service. The inputs/outputs map variables to specific memory addresses in the process image. The NOVA\'s MODBUS service\'s configuration can be viewed via [listModbusIOs](listModbusIOs).
3771
+ * Adds an input/output variable to or updates an input/output variable on the MODBUS device, e.g., NOVA\'s MODBUS service. The inputs/outputs map variables to specific memory addresses in the process image. The NOVA\'s MODBUS service\'s configuration can be viewed via [listModbusIOs](#/operations/listModbusIOs).
3570
3772
  * @summary Add MODBUS Input/Output
3571
3773
  * @param {string} cell Unique identifier addressing a cell in all API calls.
3572
3774
  * @param {string} io Unique identifier to address an Input/Output in the cell.
@@ -3576,7 +3778,7 @@ declare const BUSInputsOutputsApiAxiosParamCreator: (configuration?: Configurati
3576
3778
  */
3577
3779
  addModbusIO: (cell: string, io: string, modbusIOData: ModbusIOData, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
3578
3780
  /**
3579
- * Adds an input/output variable to or updates an input/output variable on the PROFINET device, e.g., NOVA\'s PROFINET service. The inputs/outputs map variables to specific memory addresses in the process image. The default process image has buffer lengths of 64 bytes for input and output. - The size of the buffer is determined by the `config_file_content` that is passed in [addBusIOService](addBusIOService) and has to be in accordance with the GSDML file describing the PROFINET device. The PROFINET controller as well as NOVA\'s PROFINET service use an input/output variable configuration to interpret the bits of the input/output process image. - The NOVA\'s PROFINET service\'s configuration can be viewed via [listProfinetIOs](listProfinetIOs). For the PROFINET controller, e.g., a connected PLC, refer to the corresponding third party software, e.g., TIA portal).
3781
+ * Adds an input/output variable to or updates an input/output variable on the PROFINET device, e.g., NOVA\'s PROFINET service. The inputs/outputs map variables to specific memory addresses in the process image. The default process image has buffer lengths of 64 bytes for input and output. - The size of the buffer is determined by the `config_file_content` that is passed in [addBusIOService](#/operations/addBusIOService) and has to be in accordance with the GSDML file describing the PROFINET device. The PROFINET controller as well as NOVA\'s PROFINET service use an input/output variable configuration to interpret the bits of the input/output process image. - The NOVA\'s PROFINET service\'s configuration can be viewed via [listProfinetIOs](#/operations/listProfinetIOs). For the PROFINET controller, e.g., a connected PLC, refer to the corresponding third party software, e.g., TIA portal).
3580
3782
  * @summary Add PROFINET Input/Output
3581
3783
  * @param {string} cell Unique identifier addressing a cell in all API calls.
3582
3784
  * @param {string} io Unique identifier to address an Input/Output in the cell.
@@ -3612,7 +3814,7 @@ declare const BUSInputsOutputsApiAxiosParamCreator: (configuration?: Configurati
3612
3814
  deleteAllProfinetIOs: (cell: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
3613
3815
  /**
3614
3816
  * Removes an input/output variable configuration from the MODBUS device, e.g., NOVA\'s MODBUS service.
3615
- * @summary Remove MODBUS Input/Ouptut
3817
+ * @summary Remove MODBUS Input/Output
3616
3818
  * @param {string} cell Unique identifier addressing a cell in all API calls.
3617
3819
  * @param {string} io Unique identifier to address an Input/Output in the cell.
3618
3820
  * @param {*} [options] Override http request option.
@@ -3645,7 +3847,7 @@ declare const BUSInputsOutputsApiAxiosParamCreator: (configuration?: Configurati
3645
3847
  */
3646
3848
  getBusIOState: (cell: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
3647
3849
  /**
3648
- * Retrieves the current values of inputs/outputs. The identifiers of the inputs/outputs must be provided in the request. Request all available input/output identifiers via [listBusIODescriptions](listBusIODescriptions).
3850
+ * Retrieves the current values of inputs/outputs. The identifiers of the inputs/outputs must be provided in the request. Request all available input/output identifiers via [listBusIODescriptions](#/operations/listBusIODescriptions).
3649
3851
  * @summary Get Input/Output Values
3650
3852
  * @param {string} cell Unique identifier addressing a cell in all API calls.
3651
3853
  * @param {Array<string>} [ios]
@@ -3680,7 +3882,7 @@ declare const BUSInputsOutputsApiAxiosParamCreator: (configuration?: Configurati
3680
3882
  */
3681
3883
  listBusIODescriptions: (cell: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
3682
3884
  /**
3683
- * List descriptions for all configured input/output variables of the MODBUS service. The input/output descriptions contain information like name, type and address. The input/output direction is given in perspective of the active MODBUS type (service or client). - The byte and bit addresses are the locations in the MODBUS input/output process image the variable points to. - The MODBUS controller as well as NOVA\'s MODBUS service use an input/output variable configuration to interpret the bits of the input and output process image. - The NOVA MODBUS service\'s configuration is modified via [addModbusIO](addModbusIO).
3885
+ * List descriptions for all configured input/output variables of the MODBUS service. The input/output descriptions contain information like name, type, and address. The input/output direction is given in perspective of the active MODBUS type (service or client). - The byte and bit addresses are the locations in the MODBUS input/output process image the variable points to. - The MODBUS controller, as well as NOVA\'s MODBUS service, use an input/output variable configuration to interpret the bits of the input and output process image. - The NOVA MODBUS service\'s configuration is modified via [addModbusIO](#/operations/addModbusIO).
3684
3886
  * @summary List MODBUS Input/Output Configuration
3685
3887
  * @param {string} cell Unique identifier addressing a cell in all API calls.
3686
3888
  * @param {*} [options] Override http request option.
@@ -3688,7 +3890,7 @@ declare const BUSInputsOutputsApiAxiosParamCreator: (configuration?: Configurati
3688
3890
  */
3689
3891
  listModbusIOs: (cell: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
3690
3892
  /**
3691
- * List descriptions for all configured input/output variables of the PROFINET service. The input/output descriptions contain information like name, type and unit. The input/output direction is given in perspective of the PROFINET device, e.g., the configured PROFINET service. - The byte and bit addresses are the locations in the PROFINET input/output process image the variable points to. - The PROFINET controller as well as NOVA\'s PROFINET service use an input/output variable configuration to interpret the bits of the input and output process image. - The NOVA PROFINET service\'s configuration is modified via [addProfinetIO](addProfinetIO) and [setProfinetIOsFromFile](setProfinetIOsFromFile). For the PROFINET controller, e.g., a connected PLC, refer to the corresponding third party software, e.g., TIA portal.
3893
+ * List descriptions for all configured input/output variables of the PROFINET service. The input/output descriptions contain information like name, type, and unit. The input/output direction is given in perspective of the PROFINET device, e.g., the configured PROFINET service. - The byte and bit addresses are the locations in the PROFINET input/output process image the variable points to. - The PROFINET controller, as well as NOVA\'s PROFINET service, use an input/output variable configuration to interpret the bits of the input and output process image. - The NOVA PROFINET service\'s configuration is modified via [addProfinetIO](#/operations/addProfinetIO) and [setProfinetIOsFromFile](#/operations/setProfinetIOsFromFile). For the PROFINET controller, e.g., a connected PLC, refer to the corresponding third party software, e.g., TIA portal.
3692
3894
  * @summary List PROFINET Input/Output Configuration
3693
3895
  * @param {string} cell Unique identifier addressing a cell in all API calls.
3694
3896
  * @param {*} [options] Override http request option.
@@ -3696,7 +3898,7 @@ declare const BUSInputsOutputsApiAxiosParamCreator: (configuration?: Configurati
3696
3898
  */
3697
3899
  listProfinetIOs: (cell: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
3698
3900
  /**
3699
- * Set values of outputs. In case of virtual Bus Input/Outputs, also inputs can be set. All available output identifiers can be requested via [listBusIODescriptions](listBusIODescriptions). The call will return once the values have been set and accepted by the service.
3901
+ * Set values of outputs. In case of virtual Bus Input/Outputs, also inputs can be set. All available output identifiers can be requested via [listBusIODescriptions](#/operations/listBusIODescriptions). The call will return once the values have been set and accepted by the service.
3700
3902
  * @summary Set Output Values
3701
3903
  * @param {string} cell Unique identifier addressing a cell in all API calls.
3702
3904
  * @param {Array<IOValue>} iOValue
@@ -3705,7 +3907,7 @@ declare const BUSInputsOutputsApiAxiosParamCreator: (configuration?: Configurati
3705
3907
  */
3706
3908
  setBusIOValues: (cell: string, iOValue: Array<IOValue>, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
3707
3909
  /**
3708
- * Sets input/output variable configuration on the PROFINET device (i.e. NOVA\'s PROFINET service) from XML file. The inputs/outputs map variables to specific memory addresses in the process image. The default process image has buffer lengths of 64 bytes for input and output. - The size of the buffer is determined by the `config_file_content` that is passed in [addBusIOService](addBusIOService) and has to be in accordance with the GSDML file describing the PROFINET device. The PROFINET controller as well as NOVA\'s PROFINET service use an input/output variable configuration to interpret the bits of the input/output process image. - The NOVA\'s PROFINET service\'s configuration can be viewed via [listProfinetIOs](listProfinetIOs). For the PROFINET controller, e.g., a connected PLC, refer to the corresponding engineering system, e.g., TIA portal. #### Export variables You can export the variable configuration of the PROFINET controller as XML file from your engineering system, e.g., TIA portal. - The endpoint is built so that the perspective of input and output (PROFINET Device\'s input is PROFINET Controller\'s output) is internally handled (PROFINET device input is PROFINET controller output), meaning that you can paste the exported XML file here without modifying.
3910
+ * Sets input/output variable configuration on the PROFINET device (i.e. NOVA\'s PROFINET service) from XML file. The inputs/outputs map variables to specific memory addresses in the process image. The default process image has buffer lengths of 64 bytes for input and output. - The size of the buffer is determined by the `config_file_content` that is passed in [addBusIOService](#/operations/addBusIOService) and has to be in accordance with the GSDML file describing the PROFINET device. The PROFINET controller, as well as NOVA\'s PROFINET service, use an input/output variable configuration to interpret the bits of the input/output process image. - The NOVA\'s PROFINET service\'s configuration can be viewed via [listProfinetIOs](#/operations/listProfinetIOs). For the PROFINET controller, e.g., a connected PLC, refer to the corresponding engineering system, e.g., TIA portal. #### Export variables You can export the variable configuration of the PROFINET controller as an XML file from your engineering system, e.g., TIA portal. - The endpoint is built so that the perspective of input and output (PROFINET Device\'s input is PROFINET Controller\'s output) is internally handled (PROFINET device input is PROFINET controller output), meaning that you can paste the exported XML file here without modifying.
3709
3911
  * @summary Set PROFINET Inputs/Outputs from File
3710
3912
  * @param {string} cell Unique identifier addressing a cell in all API calls.
3711
3913
  * @param {ProfinetInputOutputConfig} profinetInputOutputConfig
@@ -3729,7 +3931,7 @@ declare const BUSInputsOutputsApiFp: (configuration?: Configuration) => {
3729
3931
  */
3730
3932
  addBusIOService(cell: string, busIOType: BusIOType, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
3731
3933
  /**
3732
- * Adds an input/output variable to or updates an input/output variable on the MODBUS device, e.g., NOVA\'s MODBUS service. The inputs/outputs map variables to specific memory addresses in the process image. The NOVA\'s MODBUS service\'s configuration can be viewed via [listModbusIOs](listModbusIOs).
3934
+ * Adds an input/output variable to or updates an input/output variable on the MODBUS device, e.g., NOVA\'s MODBUS service. The inputs/outputs map variables to specific memory addresses in the process image. The NOVA\'s MODBUS service\'s configuration can be viewed via [listModbusIOs](#/operations/listModbusIOs).
3733
3935
  * @summary Add MODBUS Input/Output
3734
3936
  * @param {string} cell Unique identifier addressing a cell in all API calls.
3735
3937
  * @param {string} io Unique identifier to address an Input/Output in the cell.
@@ -3739,7 +3941,7 @@ declare const BUSInputsOutputsApiFp: (configuration?: Configuration) => {
3739
3941
  */
3740
3942
  addModbusIO(cell: string, io: string, modbusIOData: ModbusIOData, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
3741
3943
  /**
3742
- * Adds an input/output variable to or updates an input/output variable on the PROFINET device, e.g., NOVA\'s PROFINET service. The inputs/outputs map variables to specific memory addresses in the process image. The default process image has buffer lengths of 64 bytes for input and output. - The size of the buffer is determined by the `config_file_content` that is passed in [addBusIOService](addBusIOService) and has to be in accordance with the GSDML file describing the PROFINET device. The PROFINET controller as well as NOVA\'s PROFINET service use an input/output variable configuration to interpret the bits of the input/output process image. - The NOVA\'s PROFINET service\'s configuration can be viewed via [listProfinetIOs](listProfinetIOs). For the PROFINET controller, e.g., a connected PLC, refer to the corresponding third party software, e.g., TIA portal).
3944
+ * Adds an input/output variable to or updates an input/output variable on the PROFINET device, e.g., NOVA\'s PROFINET service. The inputs/outputs map variables to specific memory addresses in the process image. The default process image has buffer lengths of 64 bytes for input and output. - The size of the buffer is determined by the `config_file_content` that is passed in [addBusIOService](#/operations/addBusIOService) and has to be in accordance with the GSDML file describing the PROFINET device. The PROFINET controller as well as NOVA\'s PROFINET service use an input/output variable configuration to interpret the bits of the input/output process image. - The NOVA\'s PROFINET service\'s configuration can be viewed via [listProfinetIOs](#/operations/listProfinetIOs). For the PROFINET controller, e.g., a connected PLC, refer to the corresponding third party software, e.g., TIA portal).
3743
3945
  * @summary Add PROFINET Input/Output
3744
3946
  * @param {string} cell Unique identifier addressing a cell in all API calls.
3745
3947
  * @param {string} io Unique identifier to address an Input/Output in the cell.
@@ -3775,7 +3977,7 @@ declare const BUSInputsOutputsApiFp: (configuration?: Configuration) => {
3775
3977
  deleteAllProfinetIOs(cell: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
3776
3978
  /**
3777
3979
  * Removes an input/output variable configuration from the MODBUS device, e.g., NOVA\'s MODBUS service.
3778
- * @summary Remove MODBUS Input/Ouptut
3980
+ * @summary Remove MODBUS Input/Output
3779
3981
  * @param {string} cell Unique identifier addressing a cell in all API calls.
3780
3982
  * @param {string} io Unique identifier to address an Input/Output in the cell.
3781
3983
  * @param {*} [options] Override http request option.
@@ -3808,7 +4010,7 @@ declare const BUSInputsOutputsApiFp: (configuration?: Configuration) => {
3808
4010
  */
3809
4011
  getBusIOState(cell: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BusIOsState>>;
3810
4012
  /**
3811
- * Retrieves the current values of inputs/outputs. The identifiers of the inputs/outputs must be provided in the request. Request all available input/output identifiers via [listBusIODescriptions](listBusIODescriptions).
4013
+ * Retrieves the current values of inputs/outputs. The identifiers of the inputs/outputs must be provided in the request. Request all available input/output identifiers via [listBusIODescriptions](#/operations/listBusIODescriptions).
3812
4014
  * @summary Get Input/Output Values
3813
4015
  * @param {string} cell Unique identifier addressing a cell in all API calls.
3814
4016
  * @param {Array<string>} [ios]
@@ -3843,7 +4045,7 @@ declare const BUSInputsOutputsApiFp: (configuration?: Configuration) => {
3843
4045
  */
3844
4046
  listBusIODescriptions(cell: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<BusIODescription>>>;
3845
4047
  /**
3846
- * List descriptions for all configured input/output variables of the MODBUS service. The input/output descriptions contain information like name, type and address. The input/output direction is given in perspective of the active MODBUS type (service or client). - The byte and bit addresses are the locations in the MODBUS input/output process image the variable points to. - The MODBUS controller as well as NOVA\'s MODBUS service use an input/output variable configuration to interpret the bits of the input and output process image. - The NOVA MODBUS service\'s configuration is modified via [addModbusIO](addModbusIO).
4048
+ * List descriptions for all configured input/output variables of the MODBUS service. The input/output descriptions contain information like name, type, and address. The input/output direction is given in perspective of the active MODBUS type (service or client). - The byte and bit addresses are the locations in the MODBUS input/output process image the variable points to. - The MODBUS controller, as well as NOVA\'s MODBUS service, use an input/output variable configuration to interpret the bits of the input and output process image. - The NOVA MODBUS service\'s configuration is modified via [addModbusIO](#/operations/addModbusIO).
3847
4049
  * @summary List MODBUS Input/Output Configuration
3848
4050
  * @param {string} cell Unique identifier addressing a cell in all API calls.
3849
4051
  * @param {*} [options] Override http request option.
@@ -3851,7 +4053,7 @@ declare const BUSInputsOutputsApiFp: (configuration?: Configuration) => {
3851
4053
  */
3852
4054
  listModbusIOs(cell: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<ModbusIO>>>;
3853
4055
  /**
3854
- * List descriptions for all configured input/output variables of the PROFINET service. The input/output descriptions contain information like name, type and unit. The input/output direction is given in perspective of the PROFINET device, e.g., the configured PROFINET service. - The byte and bit addresses are the locations in the PROFINET input/output process image the variable points to. - The PROFINET controller as well as NOVA\'s PROFINET service use an input/output variable configuration to interpret the bits of the input and output process image. - The NOVA PROFINET service\'s configuration is modified via [addProfinetIO](addProfinetIO) and [setProfinetIOsFromFile](setProfinetIOsFromFile). For the PROFINET controller, e.g., a connected PLC, refer to the corresponding third party software, e.g., TIA portal.
4056
+ * List descriptions for all configured input/output variables of the PROFINET service. The input/output descriptions contain information like name, type, and unit. The input/output direction is given in perspective of the PROFINET device, e.g., the configured PROFINET service. - The byte and bit addresses are the locations in the PROFINET input/output process image the variable points to. - The PROFINET controller, as well as NOVA\'s PROFINET service, use an input/output variable configuration to interpret the bits of the input and output process image. - The NOVA PROFINET service\'s configuration is modified via [addProfinetIO](#/operations/addProfinetIO) and [setProfinetIOsFromFile](#/operations/setProfinetIOsFromFile). For the PROFINET controller, e.g., a connected PLC, refer to the corresponding third party software, e.g., TIA portal.
3855
4057
  * @summary List PROFINET Input/Output Configuration
3856
4058
  * @param {string} cell Unique identifier addressing a cell in all API calls.
3857
4059
  * @param {*} [options] Override http request option.
@@ -3859,7 +4061,7 @@ declare const BUSInputsOutputsApiFp: (configuration?: Configuration) => {
3859
4061
  */
3860
4062
  listProfinetIOs(cell: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<ProfinetIO>>>;
3861
4063
  /**
3862
- * Set values of outputs. In case of virtual Bus Input/Outputs, also inputs can be set. All available output identifiers can be requested via [listBusIODescriptions](listBusIODescriptions). The call will return once the values have been set and accepted by the service.
4064
+ * Set values of outputs. In case of virtual Bus Input/Outputs, also inputs can be set. All available output identifiers can be requested via [listBusIODescriptions](#/operations/listBusIODescriptions). The call will return once the values have been set and accepted by the service.
3863
4065
  * @summary Set Output Values
3864
4066
  * @param {string} cell Unique identifier addressing a cell in all API calls.
3865
4067
  * @param {Array<IOValue>} iOValue
@@ -3868,7 +4070,7 @@ declare const BUSInputsOutputsApiFp: (configuration?: Configuration) => {
3868
4070
  */
3869
4071
  setBusIOValues(cell: string, iOValue: Array<IOValue>, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
3870
4072
  /**
3871
- * Sets input/output variable configuration on the PROFINET device (i.e. NOVA\'s PROFINET service) from XML file. The inputs/outputs map variables to specific memory addresses in the process image. The default process image has buffer lengths of 64 bytes for input and output. - The size of the buffer is determined by the `config_file_content` that is passed in [addBusIOService](addBusIOService) and has to be in accordance with the GSDML file describing the PROFINET device. The PROFINET controller as well as NOVA\'s PROFINET service use an input/output variable configuration to interpret the bits of the input/output process image. - The NOVA\'s PROFINET service\'s configuration can be viewed via [listProfinetIOs](listProfinetIOs). For the PROFINET controller, e.g., a connected PLC, refer to the corresponding engineering system, e.g., TIA portal. #### Export variables You can export the variable configuration of the PROFINET controller as XML file from your engineering system, e.g., TIA portal. - The endpoint is built so that the perspective of input and output (PROFINET Device\'s input is PROFINET Controller\'s output) is internally handled (PROFINET device input is PROFINET controller output), meaning that you can paste the exported XML file here without modifying.
4073
+ * Sets input/output variable configuration on the PROFINET device (i.e. NOVA\'s PROFINET service) from XML file. The inputs/outputs map variables to specific memory addresses in the process image. The default process image has buffer lengths of 64 bytes for input and output. - The size of the buffer is determined by the `config_file_content` that is passed in [addBusIOService](#/operations/addBusIOService) and has to be in accordance with the GSDML file describing the PROFINET device. The PROFINET controller, as well as NOVA\'s PROFINET service, use an input/output variable configuration to interpret the bits of the input/output process image. - The NOVA\'s PROFINET service\'s configuration can be viewed via [listProfinetIOs](#/operations/listProfinetIOs). For the PROFINET controller, e.g., a connected PLC, refer to the corresponding engineering system, e.g., TIA portal. #### Export variables You can export the variable configuration of the PROFINET controller as an XML file from your engineering system, e.g., TIA portal. - The endpoint is built so that the perspective of input and output (PROFINET Device\'s input is PROFINET Controller\'s output) is internally handled (PROFINET device input is PROFINET controller output), meaning that you can paste the exported XML file here without modifying.
3872
4074
  * @summary Set PROFINET Inputs/Outputs from File
3873
4075
  * @param {string} cell Unique identifier addressing a cell in all API calls.
3874
4076
  * @param {ProfinetInputOutputConfig} profinetInputOutputConfig
@@ -3892,7 +4094,7 @@ declare const BUSInputsOutputsApiFactory: (configuration?: Configuration, basePa
3892
4094
  */
3893
4095
  addBusIOService(cell: string, busIOType: BusIOType, completionTimeout?: number, options?: RawAxiosRequestConfig): AxiosPromise<void>;
3894
4096
  /**
3895
- * Adds an input/output variable to or updates an input/output variable on the MODBUS device, e.g., NOVA\'s MODBUS service. The inputs/outputs map variables to specific memory addresses in the process image. The NOVA\'s MODBUS service\'s configuration can be viewed via [listModbusIOs](listModbusIOs).
4097
+ * Adds an input/output variable to or updates an input/output variable on the MODBUS device, e.g., NOVA\'s MODBUS service. The inputs/outputs map variables to specific memory addresses in the process image. The NOVA\'s MODBUS service\'s configuration can be viewed via [listModbusIOs](#/operations/listModbusIOs).
3896
4098
  * @summary Add MODBUS Input/Output
3897
4099
  * @param {string} cell Unique identifier addressing a cell in all API calls.
3898
4100
  * @param {string} io Unique identifier to address an Input/Output in the cell.
@@ -3902,7 +4104,7 @@ declare const BUSInputsOutputsApiFactory: (configuration?: Configuration, basePa
3902
4104
  */
3903
4105
  addModbusIO(cell: string, io: string, modbusIOData: ModbusIOData, options?: RawAxiosRequestConfig): AxiosPromise<void>;
3904
4106
  /**
3905
- * Adds an input/output variable to or updates an input/output variable on the PROFINET device, e.g., NOVA\'s PROFINET service. The inputs/outputs map variables to specific memory addresses in the process image. The default process image has buffer lengths of 64 bytes for input and output. - The size of the buffer is determined by the `config_file_content` that is passed in [addBusIOService](addBusIOService) and has to be in accordance with the GSDML file describing the PROFINET device. The PROFINET controller as well as NOVA\'s PROFINET service use an input/output variable configuration to interpret the bits of the input/output process image. - The NOVA\'s PROFINET service\'s configuration can be viewed via [listProfinetIOs](listProfinetIOs). For the PROFINET controller, e.g., a connected PLC, refer to the corresponding third party software, e.g., TIA portal).
4107
+ * Adds an input/output variable to or updates an input/output variable on the PROFINET device, e.g., NOVA\'s PROFINET service. The inputs/outputs map variables to specific memory addresses in the process image. The default process image has buffer lengths of 64 bytes for input and output. - The size of the buffer is determined by the `config_file_content` that is passed in [addBusIOService](#/operations/addBusIOService) and has to be in accordance with the GSDML file describing the PROFINET device. The PROFINET controller as well as NOVA\'s PROFINET service use an input/output variable configuration to interpret the bits of the input/output process image. - The NOVA\'s PROFINET service\'s configuration can be viewed via [listProfinetIOs](#/operations/listProfinetIOs). For the PROFINET controller, e.g., a connected PLC, refer to the corresponding third party software, e.g., TIA portal).
3906
4108
  * @summary Add PROFINET Input/Output
3907
4109
  * @param {string} cell Unique identifier addressing a cell in all API calls.
3908
4110
  * @param {string} io Unique identifier to address an Input/Output in the cell.
@@ -3938,7 +4140,7 @@ declare const BUSInputsOutputsApiFactory: (configuration?: Configuration, basePa
3938
4140
  deleteAllProfinetIOs(cell: string, options?: RawAxiosRequestConfig): AxiosPromise<void>;
3939
4141
  /**
3940
4142
  * Removes an input/output variable configuration from the MODBUS device, e.g., NOVA\'s MODBUS service.
3941
- * @summary Remove MODBUS Input/Ouptut
4143
+ * @summary Remove MODBUS Input/Output
3942
4144
  * @param {string} cell Unique identifier addressing a cell in all API calls.
3943
4145
  * @param {string} io Unique identifier to address an Input/Output in the cell.
3944
4146
  * @param {*} [options] Override http request option.
@@ -3971,7 +4173,7 @@ declare const BUSInputsOutputsApiFactory: (configuration?: Configuration, basePa
3971
4173
  */
3972
4174
  getBusIOState(cell: string, options?: RawAxiosRequestConfig): AxiosPromise<BusIOsState>;
3973
4175
  /**
3974
- * Retrieves the current values of inputs/outputs. The identifiers of the inputs/outputs must be provided in the request. Request all available input/output identifiers via [listBusIODescriptions](listBusIODescriptions).
4176
+ * Retrieves the current values of inputs/outputs. The identifiers of the inputs/outputs must be provided in the request. Request all available input/output identifiers via [listBusIODescriptions](#/operations/listBusIODescriptions).
3975
4177
  * @summary Get Input/Output Values
3976
4178
  * @param {string} cell Unique identifier addressing a cell in all API calls.
3977
4179
  * @param {Array<string>} [ios]
@@ -4006,7 +4208,7 @@ declare const BUSInputsOutputsApiFactory: (configuration?: Configuration, basePa
4006
4208
  */
4007
4209
  listBusIODescriptions(cell: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<BusIODescription>>;
4008
4210
  /**
4009
- * List descriptions for all configured input/output variables of the MODBUS service. The input/output descriptions contain information like name, type and address. The input/output direction is given in perspective of the active MODBUS type (service or client). - The byte and bit addresses are the locations in the MODBUS input/output process image the variable points to. - The MODBUS controller as well as NOVA\'s MODBUS service use an input/output variable configuration to interpret the bits of the input and output process image. - The NOVA MODBUS service\'s configuration is modified via [addModbusIO](addModbusIO).
4211
+ * List descriptions for all configured input/output variables of the MODBUS service. The input/output descriptions contain information like name, type, and address. The input/output direction is given in perspective of the active MODBUS type (service or client). - The byte and bit addresses are the locations in the MODBUS input/output process image the variable points to. - The MODBUS controller, as well as NOVA\'s MODBUS service, use an input/output variable configuration to interpret the bits of the input and output process image. - The NOVA MODBUS service\'s configuration is modified via [addModbusIO](#/operations/addModbusIO).
4010
4212
  * @summary List MODBUS Input/Output Configuration
4011
4213
  * @param {string} cell Unique identifier addressing a cell in all API calls.
4012
4214
  * @param {*} [options] Override http request option.
@@ -4014,7 +4216,7 @@ declare const BUSInputsOutputsApiFactory: (configuration?: Configuration, basePa
4014
4216
  */
4015
4217
  listModbusIOs(cell: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<ModbusIO>>;
4016
4218
  /**
4017
- * List descriptions for all configured input/output variables of the PROFINET service. The input/output descriptions contain information like name, type and unit. The input/output direction is given in perspective of the PROFINET device, e.g., the configured PROFINET service. - The byte and bit addresses are the locations in the PROFINET input/output process image the variable points to. - The PROFINET controller as well as NOVA\'s PROFINET service use an input/output variable configuration to interpret the bits of the input and output process image. - The NOVA PROFINET service\'s configuration is modified via [addProfinetIO](addProfinetIO) and [setProfinetIOsFromFile](setProfinetIOsFromFile). For the PROFINET controller, e.g., a connected PLC, refer to the corresponding third party software, e.g., TIA portal.
4219
+ * List descriptions for all configured input/output variables of the PROFINET service. The input/output descriptions contain information like name, type, and unit. The input/output direction is given in perspective of the PROFINET device, e.g., the configured PROFINET service. - The byte and bit addresses are the locations in the PROFINET input/output process image the variable points to. - The PROFINET controller, as well as NOVA\'s PROFINET service, use an input/output variable configuration to interpret the bits of the input and output process image. - The NOVA PROFINET service\'s configuration is modified via [addProfinetIO](#/operations/addProfinetIO) and [setProfinetIOsFromFile](#/operations/setProfinetIOsFromFile). For the PROFINET controller, e.g., a connected PLC, refer to the corresponding third party software, e.g., TIA portal.
4018
4220
  * @summary List PROFINET Input/Output Configuration
4019
4221
  * @param {string} cell Unique identifier addressing a cell in all API calls.
4020
4222
  * @param {*} [options] Override http request option.
@@ -4022,7 +4224,7 @@ declare const BUSInputsOutputsApiFactory: (configuration?: Configuration, basePa
4022
4224
  */
4023
4225
  listProfinetIOs(cell: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<ProfinetIO>>;
4024
4226
  /**
4025
- * Set values of outputs. In case of virtual Bus Input/Outputs, also inputs can be set. All available output identifiers can be requested via [listBusIODescriptions](listBusIODescriptions). The call will return once the values have been set and accepted by the service.
4227
+ * Set values of outputs. In case of virtual Bus Input/Outputs, also inputs can be set. All available output identifiers can be requested via [listBusIODescriptions](#/operations/listBusIODescriptions). The call will return once the values have been set and accepted by the service.
4026
4228
  * @summary Set Output Values
4027
4229
  * @param {string} cell Unique identifier addressing a cell in all API calls.
4028
4230
  * @param {Array<IOValue>} iOValue
@@ -4031,7 +4233,7 @@ declare const BUSInputsOutputsApiFactory: (configuration?: Configuration, basePa
4031
4233
  */
4032
4234
  setBusIOValues(cell: string, iOValue: Array<IOValue>, options?: RawAxiosRequestConfig): AxiosPromise<void>;
4033
4235
  /**
4034
- * Sets input/output variable configuration on the PROFINET device (i.e. NOVA\'s PROFINET service) from XML file. The inputs/outputs map variables to specific memory addresses in the process image. The default process image has buffer lengths of 64 bytes for input and output. - The size of the buffer is determined by the `config_file_content` that is passed in [addBusIOService](addBusIOService) and has to be in accordance with the GSDML file describing the PROFINET device. The PROFINET controller as well as NOVA\'s PROFINET service use an input/output variable configuration to interpret the bits of the input/output process image. - The NOVA\'s PROFINET service\'s configuration can be viewed via [listProfinetIOs](listProfinetIOs). For the PROFINET controller, e.g., a connected PLC, refer to the corresponding engineering system, e.g., TIA portal. #### Export variables You can export the variable configuration of the PROFINET controller as XML file from your engineering system, e.g., TIA portal. - The endpoint is built so that the perspective of input and output (PROFINET Device\'s input is PROFINET Controller\'s output) is internally handled (PROFINET device input is PROFINET controller output), meaning that you can paste the exported XML file here without modifying.
4236
+ * Sets input/output variable configuration on the PROFINET device (i.e. NOVA\'s PROFINET service) from XML file. The inputs/outputs map variables to specific memory addresses in the process image. The default process image has buffer lengths of 64 bytes for input and output. - The size of the buffer is determined by the `config_file_content` that is passed in [addBusIOService](#/operations/addBusIOService) and has to be in accordance with the GSDML file describing the PROFINET device. The PROFINET controller, as well as NOVA\'s PROFINET service, use an input/output variable configuration to interpret the bits of the input/output process image. - The NOVA\'s PROFINET service\'s configuration can be viewed via [listProfinetIOs](#/operations/listProfinetIOs). For the PROFINET controller, e.g., a connected PLC, refer to the corresponding engineering system, e.g., TIA portal. #### Export variables You can export the variable configuration of the PROFINET controller as an XML file from your engineering system, e.g., TIA portal. - The endpoint is built so that the perspective of input and output (PROFINET Device\'s input is PROFINET Controller\'s output) is internally handled (PROFINET device input is PROFINET controller output), meaning that you can paste the exported XML file here without modifying.
4035
4237
  * @summary Set PROFINET Inputs/Outputs from File
4036
4238
  * @param {string} cell Unique identifier addressing a cell in all API calls.
4037
4239
  * @param {ProfinetInputOutputConfig} profinetInputOutputConfig
@@ -4055,7 +4257,7 @@ declare class BUSInputsOutputsApi extends BaseAPI {
4055
4257
  */
4056
4258
  addBusIOService(cell: string, busIOType: BusIOType, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
4057
4259
  /**
4058
- * Adds an input/output variable to or updates an input/output variable on the MODBUS device, e.g., NOVA\'s MODBUS service. The inputs/outputs map variables to specific memory addresses in the process image. The NOVA\'s MODBUS service\'s configuration can be viewed via [listModbusIOs](listModbusIOs).
4260
+ * Adds an input/output variable to or updates an input/output variable on the MODBUS device, e.g., NOVA\'s MODBUS service. The inputs/outputs map variables to specific memory addresses in the process image. The NOVA\'s MODBUS service\'s configuration can be viewed via [listModbusIOs](#/operations/listModbusIOs).
4059
4261
  * @summary Add MODBUS Input/Output
4060
4262
  * @param {string} cell Unique identifier addressing a cell in all API calls.
4061
4263
  * @param {string} io Unique identifier to address an Input/Output in the cell.
@@ -4065,7 +4267,7 @@ declare class BUSInputsOutputsApi extends BaseAPI {
4065
4267
  */
4066
4268
  addModbusIO(cell: string, io: string, modbusIOData: ModbusIOData, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
4067
4269
  /**
4068
- * Adds an input/output variable to or updates an input/output variable on the PROFINET device, e.g., NOVA\'s PROFINET service. The inputs/outputs map variables to specific memory addresses in the process image. The default process image has buffer lengths of 64 bytes for input and output. - The size of the buffer is determined by the `config_file_content` that is passed in [addBusIOService](addBusIOService) and has to be in accordance with the GSDML file describing the PROFINET device. The PROFINET controller as well as NOVA\'s PROFINET service use an input/output variable configuration to interpret the bits of the input/output process image. - The NOVA\'s PROFINET service\'s configuration can be viewed via [listProfinetIOs](listProfinetIOs). For the PROFINET controller, e.g., a connected PLC, refer to the corresponding third party software, e.g., TIA portal).
4270
+ * Adds an input/output variable to or updates an input/output variable on the PROFINET device, e.g., NOVA\'s PROFINET service. The inputs/outputs map variables to specific memory addresses in the process image. The default process image has buffer lengths of 64 bytes for input and output. - The size of the buffer is determined by the `config_file_content` that is passed in [addBusIOService](#/operations/addBusIOService) and has to be in accordance with the GSDML file describing the PROFINET device. The PROFINET controller as well as NOVA\'s PROFINET service use an input/output variable configuration to interpret the bits of the input/output process image. - The NOVA\'s PROFINET service\'s configuration can be viewed via [listProfinetIOs](#/operations/listProfinetIOs). For the PROFINET controller, e.g., a connected PLC, refer to the corresponding third party software, e.g., TIA portal).
4069
4271
  * @summary Add PROFINET Input/Output
4070
4272
  * @param {string} cell Unique identifier addressing a cell in all API calls.
4071
4273
  * @param {string} io Unique identifier to address an Input/Output in the cell.
@@ -4101,7 +4303,7 @@ declare class BUSInputsOutputsApi extends BaseAPI {
4101
4303
  deleteAllProfinetIOs(cell: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
4102
4304
  /**
4103
4305
  * Removes an input/output variable configuration from the MODBUS device, e.g., NOVA\'s MODBUS service.
4104
- * @summary Remove MODBUS Input/Ouptut
4306
+ * @summary Remove MODBUS Input/Output
4105
4307
  * @param {string} cell Unique identifier addressing a cell in all API calls.
4106
4308
  * @param {string} io Unique identifier to address an Input/Output in the cell.
4107
4309
  * @param {*} [options] Override http request option.
@@ -4134,7 +4336,7 @@ declare class BUSInputsOutputsApi extends BaseAPI {
4134
4336
  */
4135
4337
  getBusIOState(cell: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<BusIOsState, any>>;
4136
4338
  /**
4137
- * Retrieves the current values of inputs/outputs. The identifiers of the inputs/outputs must be provided in the request. Request all available input/output identifiers via [listBusIODescriptions](listBusIODescriptions).
4339
+ * Retrieves the current values of inputs/outputs. The identifiers of the inputs/outputs must be provided in the request. Request all available input/output identifiers via [listBusIODescriptions](#/operations/listBusIODescriptions).
4138
4340
  * @summary Get Input/Output Values
4139
4341
  * @param {string} cell Unique identifier addressing a cell in all API calls.
4140
4342
  * @param {Array<string>} [ios]
@@ -4169,7 +4371,7 @@ declare class BUSInputsOutputsApi extends BaseAPI {
4169
4371
  */
4170
4372
  listBusIODescriptions(cell: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<BusIODescription[], any>>;
4171
4373
  /**
4172
- * List descriptions for all configured input/output variables of the MODBUS service. The input/output descriptions contain information like name, type and address. The input/output direction is given in perspective of the active MODBUS type (service or client). - The byte and bit addresses are the locations in the MODBUS input/output process image the variable points to. - The MODBUS controller as well as NOVA\'s MODBUS service use an input/output variable configuration to interpret the bits of the input and output process image. - The NOVA MODBUS service\'s configuration is modified via [addModbusIO](addModbusIO).
4374
+ * List descriptions for all configured input/output variables of the MODBUS service. The input/output descriptions contain information like name, type, and address. The input/output direction is given in perspective of the active MODBUS type (service or client). - The byte and bit addresses are the locations in the MODBUS input/output process image the variable points to. - The MODBUS controller, as well as NOVA\'s MODBUS service, use an input/output variable configuration to interpret the bits of the input and output process image. - The NOVA MODBUS service\'s configuration is modified via [addModbusIO](#/operations/addModbusIO).
4173
4375
  * @summary List MODBUS Input/Output Configuration
4174
4376
  * @param {string} cell Unique identifier addressing a cell in all API calls.
4175
4377
  * @param {*} [options] Override http request option.
@@ -4177,7 +4379,7 @@ declare class BUSInputsOutputsApi extends BaseAPI {
4177
4379
  */
4178
4380
  listModbusIOs(cell: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<ModbusIO[], any>>;
4179
4381
  /**
4180
- * List descriptions for all configured input/output variables of the PROFINET service. The input/output descriptions contain information like name, type and unit. The input/output direction is given in perspective of the PROFINET device, e.g., the configured PROFINET service. - The byte and bit addresses are the locations in the PROFINET input/output process image the variable points to. - The PROFINET controller as well as NOVA\'s PROFINET service use an input/output variable configuration to interpret the bits of the input and output process image. - The NOVA PROFINET service\'s configuration is modified via [addProfinetIO](addProfinetIO) and [setProfinetIOsFromFile](setProfinetIOsFromFile). For the PROFINET controller, e.g., a connected PLC, refer to the corresponding third party software, e.g., TIA portal.
4382
+ * List descriptions for all configured input/output variables of the PROFINET service. The input/output descriptions contain information like name, type, and unit. The input/output direction is given in perspective of the PROFINET device, e.g., the configured PROFINET service. - The byte and bit addresses are the locations in the PROFINET input/output process image the variable points to. - The PROFINET controller, as well as NOVA\'s PROFINET service, use an input/output variable configuration to interpret the bits of the input and output process image. - The NOVA PROFINET service\'s configuration is modified via [addProfinetIO](#/operations/addProfinetIO) and [setProfinetIOsFromFile](#/operations/setProfinetIOsFromFile). For the PROFINET controller, e.g., a connected PLC, refer to the corresponding third party software, e.g., TIA portal.
4181
4383
  * @summary List PROFINET Input/Output Configuration
4182
4384
  * @param {string} cell Unique identifier addressing a cell in all API calls.
4183
4385
  * @param {*} [options] Override http request option.
@@ -4185,7 +4387,7 @@ declare class BUSInputsOutputsApi extends BaseAPI {
4185
4387
  */
4186
4388
  listProfinetIOs(cell: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<ProfinetIO[], any>>;
4187
4389
  /**
4188
- * Set values of outputs. In case of virtual Bus Input/Outputs, also inputs can be set. All available output identifiers can be requested via [listBusIODescriptions](listBusIODescriptions). The call will return once the values have been set and accepted by the service.
4390
+ * Set values of outputs. In case of virtual Bus Input/Outputs, also inputs can be set. All available output identifiers can be requested via [listBusIODescriptions](#/operations/listBusIODescriptions). The call will return once the values have been set and accepted by the service.
4189
4391
  * @summary Set Output Values
4190
4392
  * @param {string} cell Unique identifier addressing a cell in all API calls.
4191
4393
  * @param {Array<IOValue>} iOValue
@@ -4194,7 +4396,7 @@ declare class BUSInputsOutputsApi extends BaseAPI {
4194
4396
  */
4195
4397
  setBusIOValues(cell: string, iOValue: Array<IOValue>, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
4196
4398
  /**
4197
- * Sets input/output variable configuration on the PROFINET device (i.e. NOVA\'s PROFINET service) from XML file. The inputs/outputs map variables to specific memory addresses in the process image. The default process image has buffer lengths of 64 bytes for input and output. - The size of the buffer is determined by the `config_file_content` that is passed in [addBusIOService](addBusIOService) and has to be in accordance with the GSDML file describing the PROFINET device. The PROFINET controller as well as NOVA\'s PROFINET service use an input/output variable configuration to interpret the bits of the input/output process image. - The NOVA\'s PROFINET service\'s configuration can be viewed via [listProfinetIOs](listProfinetIOs). For the PROFINET controller, e.g., a connected PLC, refer to the corresponding engineering system, e.g., TIA portal. #### Export variables You can export the variable configuration of the PROFINET controller as XML file from your engineering system, e.g., TIA portal. - The endpoint is built so that the perspective of input and output (PROFINET Device\'s input is PROFINET Controller\'s output) is internally handled (PROFINET device input is PROFINET controller output), meaning that you can paste the exported XML file here without modifying.
4399
+ * Sets input/output variable configuration on the PROFINET device (i.e. NOVA\'s PROFINET service) from XML file. The inputs/outputs map variables to specific memory addresses in the process image. The default process image has buffer lengths of 64 bytes for input and output. - The size of the buffer is determined by the `config_file_content` that is passed in [addBusIOService](#/operations/addBusIOService) and has to be in accordance with the GSDML file describing the PROFINET device. The PROFINET controller, as well as NOVA\'s PROFINET service, use an input/output variable configuration to interpret the bits of the input/output process image. - The NOVA\'s PROFINET service\'s configuration can be viewed via [listProfinetIOs](#/operations/listProfinetIOs). For the PROFINET controller, e.g., a connected PLC, refer to the corresponding engineering system, e.g., TIA portal. #### Export variables You can export the variable configuration of the PROFINET controller as an XML file from your engineering system, e.g., TIA portal. - The endpoint is built so that the perspective of input and output (PROFINET Device\'s input is PROFINET Controller\'s output) is internally handled (PROFINET device input is PROFINET controller output), meaning that you can paste the exported XML file here without modifying.
4198
4400
  * @summary Set PROFINET Inputs/Outputs from File
4199
4401
  * @param {string} cell Unique identifier addressing a cell in all API calls.
4200
4402
  * @param {ProfinetInputOutputConfig} profinetInputOutputConfig
@@ -4207,6 +4409,15 @@ declare class BUSInputsOutputsApi extends BaseAPI {
4207
4409
  * CellApi - axios parameter creator
4208
4410
  */
4209
4411
  declare const CellApiAxiosParamCreator: (configuration?: Configuration) => {
4412
+ /**
4413
+ * Check if a more recent Wandelbots NOVA version is available for the cell. Updates greater than the system version are ignored.
4414
+ * @summary Check Cell Update
4415
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
4416
+ * @param {ReleaseChannel} channel
4417
+ * @param {*} [options] Override http request option.
4418
+ * @throws {RequiredError}
4419
+ */
4420
+ checkCellVersionUpdate: (cell: string, channel: ReleaseChannel, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
4210
4421
  /**
4211
4422
  * Delete an entire cell.
4212
4423
  * @summary Delete Cell
@@ -4267,11 +4478,29 @@ declare const CellApiAxiosParamCreator: (configuration?: Configuration) => {
4267
4478
  * @throws {RequiredError}
4268
4479
  */
4269
4480
  updateCell: (cell: string, cell2: Cell, completionTimeout?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
4481
+ /**
4482
+ * Update the Foundation chart version for a single cell based on a release channel. The resulting version is capped at the current system version.
4483
+ * @summary Update Cell Version
4484
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
4485
+ * @param {UpdateCellVersionRequest} updateCellVersionRequest
4486
+ * @param {*} [options] Override http request option.
4487
+ * @throws {RequiredError}
4488
+ */
4489
+ updateCellVersion: (cell: string, updateCellVersionRequest: UpdateCellVersionRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
4270
4490
  };
4271
4491
  /**
4272
4492
  * CellApi - functional programming interface
4273
4493
  */
4274
4494
  declare const CellApiFp: (configuration?: Configuration) => {
4495
+ /**
4496
+ * Check if a more recent Wandelbots NOVA version is available for the cell. Updates greater than the system version are ignored.
4497
+ * @summary Check Cell Update
4498
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
4499
+ * @param {ReleaseChannel} channel
4500
+ * @param {*} [options] Override http request option.
4501
+ * @throws {RequiredError}
4502
+ */
4503
+ checkCellVersionUpdate(cell: string, channel: ReleaseChannel, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<string>>;
4275
4504
  /**
4276
4505
  * Delete an entire cell.
4277
4506
  * @summary Delete Cell
@@ -4332,11 +4561,29 @@ declare const CellApiFp: (configuration?: Configuration) => {
4332
4561
  * @throws {RequiredError}
4333
4562
  */
4334
4563
  updateCell(cell: string, cell2: Cell, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
4564
+ /**
4565
+ * Update the Foundation chart version for a single cell based on a release channel. The resulting version is capped at the current system version.
4566
+ * @summary Update Cell Version
4567
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
4568
+ * @param {UpdateCellVersionRequest} updateCellVersionRequest
4569
+ * @param {*} [options] Override http request option.
4570
+ * @throws {RequiredError}
4571
+ */
4572
+ updateCellVersion(cell: string, updateCellVersionRequest: UpdateCellVersionRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
4335
4573
  };
4336
4574
  /**
4337
4575
  * CellApi - factory interface
4338
4576
  */
4339
4577
  declare const CellApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
4578
+ /**
4579
+ * Check if a more recent Wandelbots NOVA version is available for the cell. Updates greater than the system version are ignored.
4580
+ * @summary Check Cell Update
4581
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
4582
+ * @param {ReleaseChannel} channel
4583
+ * @param {*} [options] Override http request option.
4584
+ * @throws {RequiredError}
4585
+ */
4586
+ checkCellVersionUpdate(cell: string, channel: ReleaseChannel, options?: RawAxiosRequestConfig): AxiosPromise<string>;
4340
4587
  /**
4341
4588
  * Delete an entire cell.
4342
4589
  * @summary Delete Cell
@@ -4397,11 +4644,29 @@ declare const CellApiFactory: (configuration?: Configuration, basePath?: string,
4397
4644
  * @throws {RequiredError}
4398
4645
  */
4399
4646
  updateCell(cell: string, cell2: Cell, completionTimeout?: number, options?: RawAxiosRequestConfig): AxiosPromise<void>;
4647
+ /**
4648
+ * Update the Foundation chart version for a single cell based on a release channel. The resulting version is capped at the current system version.
4649
+ * @summary Update Cell Version
4650
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
4651
+ * @param {UpdateCellVersionRequest} updateCellVersionRequest
4652
+ * @param {*} [options] Override http request option.
4653
+ * @throws {RequiredError}
4654
+ */
4655
+ updateCellVersion(cell: string, updateCellVersionRequest: UpdateCellVersionRequest, options?: RawAxiosRequestConfig): AxiosPromise<void>;
4400
4656
  };
4401
4657
  /**
4402
4658
  * CellApi - object-oriented interface
4403
4659
  */
4404
4660
  declare class CellApi extends BaseAPI {
4661
+ /**
4662
+ * Check if a more recent Wandelbots NOVA version is available for the cell. Updates greater than the system version are ignored.
4663
+ * @summary Check Cell Update
4664
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
4665
+ * @param {ReleaseChannel} channel
4666
+ * @param {*} [options] Override http request option.
4667
+ * @throws {RequiredError}
4668
+ */
4669
+ checkCellVersionUpdate(cell: string, channel: ReleaseChannel, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<string, any>>;
4405
4670
  /**
4406
4671
  * Delete an entire cell.
4407
4672
  * @summary Delete Cell
@@ -4462,6 +4727,15 @@ declare class CellApi extends BaseAPI {
4462
4727
  * @throws {RequiredError}
4463
4728
  */
4464
4729
  updateCell(cell: string, cell2: Cell, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
4730
+ /**
4731
+ * Update the Foundation chart version for a single cell based on a release channel. The resulting version is capped at the current system version.
4732
+ * @summary Update Cell Version
4733
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
4734
+ * @param {UpdateCellVersionRequest} updateCellVersionRequest
4735
+ * @param {*} [options] Override http request option.
4736
+ * @throws {RequiredError}
4737
+ */
4738
+ updateCellVersion(cell: string, updateCellVersionRequest: UpdateCellVersionRequest, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
4465
4739
  }
4466
4740
  /**
4467
4741
  * ControllerApi - axios parameter creator
@@ -4478,7 +4752,7 @@ declare const ControllerApiAxiosParamCreator: (configuration?: Configuration) =>
4478
4752
  */
4479
4753
  addRobotController: (cell: string, robotController: RobotController, completionTimeout?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
4480
4754
  /**
4481
- * Delete all robot controllers from the cell. To replace all robot controllers in a cell, use this endpoint in combination with [addRobotController](addRobotController).
4755
+ * Delete all robot controllers from the cell. To replace all robot controllers in a cell, use this endpoint in combination with [addRobotController](#/operations/addRobotController).
4482
4756
  * @summary Clear Robot Controllers
4483
4757
  * @param {string} cell Unique identifier addressing a cell in all API calls.
4484
4758
  * @param {number} [completionTimeout]
@@ -4497,7 +4771,7 @@ declare const ControllerApiAxiosParamCreator: (configuration?: Configuration) =>
4497
4771
  */
4498
4772
  deleteRobotController: (cell: string, controller: string, completionTimeout?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
4499
4773
  /**
4500
- * Get description of a configured robot controller including a list of connected motion group identifiers. Use [getMotionGroupDescription](getMotionGroupDescription) to get more information about the motion group.
4774
+ * Get description of a configured robot controller including a list of connected motion group identifiers. Use [getMotionGroupDescription](#/operations/getMotionGroupDescription) to get more information about the motion group.
4501
4775
  * @summary Description
4502
4776
  * @param {string} cell Unique identifier addressing a cell in all API calls.
4503
4777
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -4535,7 +4809,7 @@ declare const ControllerApiAxiosParamCreator: (configuration?: Configuration) =>
4535
4809
  */
4536
4810
  getRobotController: (cell: string, controller: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
4537
4811
  /**
4538
- * Receive data to configure a virtual robot controller based on another controller. This can be used to create a virtual clone of a specific physical robot. When adding a virtual controller, use the Virtual configuration variant of [addRobotController](addRobotController) and pass the content string from this endpoint as the `json` field. Omit the `type` field that selects a preset configuration which is not required when providing a complete configuration.
4812
+ * Receive data to configure a virtual robot controller based on another controller. This can be used to create a virtual clone of a specific physical robot. When adding a virtual controller, use the Virtual configuration variant of [addRobotController](#/operations/addRobotController) and pass the content string from this endpoint as the `json` field. Omit the `type` field that selects a preset configuration, which is not required when providing a complete configuration.
4539
4813
  * @summary Virtual Controller Configuration
4540
4814
  * @param {string} cell Unique identifier addressing a cell in all API calls.
4541
4815
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -4562,7 +4836,7 @@ declare const ControllerApiAxiosParamCreator: (configuration?: Configuration) =>
4562
4836
  */
4563
4837
  listRobotControllers: (cell: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
4564
4838
  /**
4565
- * 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 to 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.
4839
+ * 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 to 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](#/operations/getCurrentRobotControllerState). If a mode change is not possible, the response lists reasons for the failed change.
4566
4840
  * @summary Set Default Mode
4567
4841
  * @param {string} cell Unique identifier addressing a cell in all API calls.
4568
4842
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -4572,7 +4846,7 @@ declare const ControllerApiAxiosParamCreator: (configuration?: Configuration) =>
4572
4846
  */
4573
4847
  setDefaultMode: (cell: string, controller: string, mode: SettableRobotSystemMode, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
4574
4848
  /**
4575
- * <!-- theme: success --> > Websocket endpoint Sets the robot controller into freedrive mode and stays in freedrive until the websocket connection is closed by the client. In freedrive mode, it is possible to move the attached motion groups by hand. This is a blocking call. As long as the websocket connection is open, no other endpoint can control or move the robot. <!-- theme: danger --> > **DANGER** > > Danger caused by robot. Improper assessment by the integrator of the application-specific hazards can result in people being > crushed, drawn in or caught due to the robot\'s complex movement sequences. Before opening the websocket, ensure that > > - The robot is in a safe state, > - The right payload is set, > - No humans or object are within the robot\'s reach or within the cell. As long as the websocket connection is open you will get the current state of the robot system in the response in the specified `response_rate`. If the activation failed, the returned status will return possible reasons for the failure. Free drive mode is only available for robot controllers that support it, in particular cobots. Use [listRobotControllers](listRobotControllers) to check if the robot controller supports free drive mode.
4849
+ * <!-- theme: success --> > Websocket endpoint Sets the robot controller into freedrive mode and stays in freedrive until the websocket connection is closed by the client. In freedrive mode, it is possible to move the attached motion groups by hand. This is a blocking call. As long as the websocket connection is open, no other endpoint can control or move the robot. <!-- theme: danger --> > **DANGER** > > Danger caused by robot. Improper assessment by the integrator of the application-specific hazards can result in people being > crushed, drawn in or caught due to the robot\'s complex movement sequences. Before opening the websocket, ensure that > > - The robot is in a safe state, > - The right payload is set, > - No humans or object are within the robot\'s reach or within the cell. As long as the websocket connection is open you will get the current state of the robot system in the response in the specified `response_rate`. If the activation failed, the returned status will return possible reasons for the failure. Free drive mode is only available for robot controllers that support it, in particular cobots. Use [listRobotControllers](#/operations/listRobotControllers) to check if the robot controller supports free drive mode.
4576
4850
  * @summary Stream Free Drive
4577
4851
  * @param {string} cell Unique identifier addressing a cell in all API calls.
4578
4852
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -4582,7 +4856,7 @@ declare const ControllerApiAxiosParamCreator: (configuration?: Configuration) =>
4582
4856
  */
4583
4857
  streamFreeDrive: (cell: string, controller: string, responseRate?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
4584
4858
  /**
4585
- * <!-- theme: success --> > 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.
4859
+ * <!-- theme: success --> > 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](#/operations/addRobotController). While connecting, the stream sends initialization updates. Once the controller reaches `MODE_MONITOR`, it sends controller state updates.
4586
4860
  * @summary Stream State
4587
4861
  * @param {string} cell Unique identifier addressing a cell in all API calls.
4588
4862
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -4593,7 +4867,7 @@ declare const ControllerApiAxiosParamCreator: (configuration?: Configuration) =>
4593
4867
  */
4594
4868
  streamRobotControllerState: (cell: string, controller: string, responseRate?: number, addControllerTimeout?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
4595
4869
  /**
4596
- * Update the configuration of a robot controller. Reconfigure certain options of a robot controller, or deploy a specific container image of a robot controller. To update a virtual controller, the previous controller will be deleted and a new one created. Changes to the configuration, e.g., TCPs, coordinate systems, mounting, are **not** transferred to the new robot. <!-- theme: info --> > **NOTE** > > An update is not a reset. To do a reset: > 1. Get the current configuration via [getRobotController](getRobotController). > 2. Delete the existing virtual robot controller via [deleteRobotController](deleteRobotController). > 3. Add a virtual robot controller with [addRobotController](addRobotController).
4870
+ * Update the configuration of a robot controller. Reconfigure certain options of a robot controller, or deploy a specific container image of a robot controller. To update a virtual controller, the previous controller will be deleted and a new one created. Changes to the configuration, e.g., TCPs, coordinate systems, mounting, are **not** transferred to the new robot. <!-- theme: info --> > **NOTE** > > An update is not a reset. To do a reset: > 1. Get the current configuration via [getRobotController](#/operations/getRobotController). > 2. Delete the existing virtual robot controller via [deleteRobotController](#/operations/deleteRobotController). > 3. Add a virtual robot controller with [addRobotController](#/operations/addRobotController).
4597
4871
  * @summary Update Robot Controller
4598
4872
  * @param {string} cell Unique identifier addressing a cell in all API calls.
4599
4873
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -4619,7 +4893,7 @@ declare const ControllerApiFp: (configuration?: Configuration) => {
4619
4893
  */
4620
4894
  addRobotController(cell: string, robotController: RobotController, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
4621
4895
  /**
4622
- * Delete all robot controllers from the cell. To replace all robot controllers in a cell, use this endpoint in combination with [addRobotController](addRobotController).
4896
+ * Delete all robot controllers from the cell. To replace all robot controllers in a cell, use this endpoint in combination with [addRobotController](#/operations/addRobotController).
4623
4897
  * @summary Clear Robot Controllers
4624
4898
  * @param {string} cell Unique identifier addressing a cell in all API calls.
4625
4899
  * @param {number} [completionTimeout]
@@ -4638,7 +4912,7 @@ declare const ControllerApiFp: (configuration?: Configuration) => {
4638
4912
  */
4639
4913
  deleteRobotController(cell: string, controller: string, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
4640
4914
  /**
4641
- * Get description of a configured robot controller including a list of connected motion group identifiers. Use [getMotionGroupDescription](getMotionGroupDescription) to get more information about the motion group.
4915
+ * Get description of a configured robot controller including a list of connected motion group identifiers. Use [getMotionGroupDescription](#/operations/getMotionGroupDescription) to get more information about the motion group.
4642
4916
  * @summary Description
4643
4917
  * @param {string} cell Unique identifier addressing a cell in all API calls.
4644
4918
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -4676,7 +4950,7 @@ declare const ControllerApiFp: (configuration?: Configuration) => {
4676
4950
  */
4677
4951
  getRobotController(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<RobotController>>;
4678
4952
  /**
4679
- * Receive data to configure a virtual robot controller based on another controller. This can be used to create a virtual clone of a specific physical robot. When adding a virtual controller, use the Virtual configuration variant of [addRobotController](addRobotController) and pass the content string from this endpoint as the `json` field. Omit the `type` field that selects a preset configuration which is not required when providing a complete configuration.
4953
+ * Receive data to configure a virtual robot controller based on another controller. This can be used to create a virtual clone of a specific physical robot. When adding a virtual controller, use the Virtual configuration variant of [addRobotController](#/operations/addRobotController) and pass the content string from this endpoint as the `json` field. Omit the `type` field that selects a preset configuration, which is not required when providing a complete configuration.
4680
4954
  * @summary Virtual Controller Configuration
4681
4955
  * @param {string} cell Unique identifier addressing a cell in all API calls.
4682
4956
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -4703,7 +4977,7 @@ declare const ControllerApiFp: (configuration?: Configuration) => {
4703
4977
  */
4704
4978
  listRobotControllers(cell: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<string>>>;
4705
4979
  /**
4706
- * 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 to 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.
4980
+ * 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 to 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](#/operations/getCurrentRobotControllerState). If a mode change is not possible, the response lists reasons for the failed change.
4707
4981
  * @summary Set Default Mode
4708
4982
  * @param {string} cell Unique identifier addressing a cell in all API calls.
4709
4983
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -4713,7 +4987,7 @@ declare const ControllerApiFp: (configuration?: Configuration) => {
4713
4987
  */
4714
4988
  setDefaultMode(cell: string, controller: string, mode: SettableRobotSystemMode, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
4715
4989
  /**
4716
- * <!-- theme: success --> > Websocket endpoint Sets the robot controller into freedrive mode and stays in freedrive until the websocket connection is closed by the client. In freedrive mode, it is possible to move the attached motion groups by hand. This is a blocking call. As long as the websocket connection is open, no other endpoint can control or move the robot. <!-- theme: danger --> > **DANGER** > > Danger caused by robot. Improper assessment by the integrator of the application-specific hazards can result in people being > crushed, drawn in or caught due to the robot\'s complex movement sequences. Before opening the websocket, ensure that > > - The robot is in a safe state, > - The right payload is set, > - No humans or object are within the robot\'s reach or within the cell. As long as the websocket connection is open you will get the current state of the robot system in the response in the specified `response_rate`. If the activation failed, the returned status will return possible reasons for the failure. Free drive mode is only available for robot controllers that support it, in particular cobots. Use [listRobotControllers](listRobotControllers) to check if the robot controller supports free drive mode.
4990
+ * <!-- theme: success --> > Websocket endpoint Sets the robot controller into freedrive mode and stays in freedrive until the websocket connection is closed by the client. In freedrive mode, it is possible to move the attached motion groups by hand. This is a blocking call. As long as the websocket connection is open, no other endpoint can control or move the robot. <!-- theme: danger --> > **DANGER** > > Danger caused by robot. Improper assessment by the integrator of the application-specific hazards can result in people being > crushed, drawn in or caught due to the robot\'s complex movement sequences. Before opening the websocket, ensure that > > - The robot is in a safe state, > - The right payload is set, > - No humans or object are within the robot\'s reach or within the cell. As long as the websocket connection is open you will get the current state of the robot system in the response in the specified `response_rate`. If the activation failed, the returned status will return possible reasons for the failure. Free drive mode is only available for robot controllers that support it, in particular cobots. Use [listRobotControllers](#/operations/listRobotControllers) to check if the robot controller supports free drive mode.
4717
4991
  * @summary Stream Free Drive
4718
4992
  * @param {string} cell Unique identifier addressing a cell in all API calls.
4719
4993
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -4723,7 +4997,7 @@ declare const ControllerApiFp: (configuration?: Configuration) => {
4723
4997
  */
4724
4998
  streamFreeDrive(cell: string, controller: string, responseRate?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<RobotControllerState>>;
4725
4999
  /**
4726
- * <!-- theme: success --> > 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.
5000
+ * <!-- theme: success --> > 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](#/operations/addRobotController). While connecting, the stream sends initialization updates. Once the controller reaches `MODE_MONITOR`, it sends controller state updates.
4727
5001
  * @summary Stream State
4728
5002
  * @param {string} cell Unique identifier addressing a cell in all API calls.
4729
5003
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -4734,7 +5008,7 @@ declare const ControllerApiFp: (configuration?: Configuration) => {
4734
5008
  */
4735
5009
  streamRobotControllerState(cell: string, controller: string, responseRate?: number, addControllerTimeout?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<RobotControllerState>>;
4736
5010
  /**
4737
- * Update the configuration of a robot controller. Reconfigure certain options of a robot controller, or deploy a specific container image of a robot controller. To update a virtual controller, the previous controller will be deleted and a new one created. Changes to the configuration, e.g., TCPs, coordinate systems, mounting, are **not** transferred to the new robot. <!-- theme: info --> > **NOTE** > > An update is not a reset. To do a reset: > 1. Get the current configuration via [getRobotController](getRobotController). > 2. Delete the existing virtual robot controller via [deleteRobotController](deleteRobotController). > 3. Add a virtual robot controller with [addRobotController](addRobotController).
5011
+ * Update the configuration of a robot controller. Reconfigure certain options of a robot controller, or deploy a specific container image of a robot controller. To update a virtual controller, the previous controller will be deleted and a new one created. Changes to the configuration, e.g., TCPs, coordinate systems, mounting, are **not** transferred to the new robot. <!-- theme: info --> > **NOTE** > > An update is not a reset. To do a reset: > 1. Get the current configuration via [getRobotController](#/operations/getRobotController). > 2. Delete the existing virtual robot controller via [deleteRobotController](#/operations/deleteRobotController). > 3. Add a virtual robot controller with [addRobotController](#/operations/addRobotController).
4738
5012
  * @summary Update Robot Controller
4739
5013
  * @param {string} cell Unique identifier addressing a cell in all API calls.
4740
5014
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -4760,7 +5034,7 @@ declare const ControllerApiFactory: (configuration?: Configuration, basePath?: s
4760
5034
  */
4761
5035
  addRobotController(cell: string, robotController: RobotController, completionTimeout?: number, options?: RawAxiosRequestConfig): AxiosPromise<void>;
4762
5036
  /**
4763
- * Delete all robot controllers from the cell. To replace all robot controllers in a cell, use this endpoint in combination with [addRobotController](addRobotController).
5037
+ * Delete all robot controllers from the cell. To replace all robot controllers in a cell, use this endpoint in combination with [addRobotController](#/operations/addRobotController).
4764
5038
  * @summary Clear Robot Controllers
4765
5039
  * @param {string} cell Unique identifier addressing a cell in all API calls.
4766
5040
  * @param {number} [completionTimeout]
@@ -4779,7 +5053,7 @@ declare const ControllerApiFactory: (configuration?: Configuration, basePath?: s
4779
5053
  */
4780
5054
  deleteRobotController(cell: string, controller: string, completionTimeout?: number, options?: RawAxiosRequestConfig): AxiosPromise<void>;
4781
5055
  /**
4782
- * Get description of a configured robot controller including a list of connected motion group identifiers. Use [getMotionGroupDescription](getMotionGroupDescription) to get more information about the motion group.
5056
+ * Get description of a configured robot controller including a list of connected motion group identifiers. Use [getMotionGroupDescription](#/operations/getMotionGroupDescription) to get more information about the motion group.
4783
5057
  * @summary Description
4784
5058
  * @param {string} cell Unique identifier addressing a cell in all API calls.
4785
5059
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -4817,7 +5091,7 @@ declare const ControllerApiFactory: (configuration?: Configuration, basePath?: s
4817
5091
  */
4818
5092
  getRobotController(cell: string, controller: string, options?: RawAxiosRequestConfig): AxiosPromise<RobotController>;
4819
5093
  /**
4820
- * Receive data to configure a virtual robot controller based on another controller. This can be used to create a virtual clone of a specific physical robot. When adding a virtual controller, use the Virtual configuration variant of [addRobotController](addRobotController) and pass the content string from this endpoint as the `json` field. Omit the `type` field that selects a preset configuration which is not required when providing a complete configuration.
5094
+ * Receive data to configure a virtual robot controller based on another controller. This can be used to create a virtual clone of a specific physical robot. When adding a virtual controller, use the Virtual configuration variant of [addRobotController](#/operations/addRobotController) and pass the content string from this endpoint as the `json` field. Omit the `type` field that selects a preset configuration, which is not required when providing a complete configuration.
4821
5095
  * @summary Virtual Controller Configuration
4822
5096
  * @param {string} cell Unique identifier addressing a cell in all API calls.
4823
5097
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -4844,7 +5118,7 @@ declare const ControllerApiFactory: (configuration?: Configuration, basePath?: s
4844
5118
  */
4845
5119
  listRobotControllers(cell: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<string>>;
4846
5120
  /**
4847
- * 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 to 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.
5121
+ * 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 to 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](#/operations/getCurrentRobotControllerState). If a mode change is not possible, the response lists reasons for the failed change.
4848
5122
  * @summary Set Default Mode
4849
5123
  * @param {string} cell Unique identifier addressing a cell in all API calls.
4850
5124
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -4854,7 +5128,7 @@ declare const ControllerApiFactory: (configuration?: Configuration, basePath?: s
4854
5128
  */
4855
5129
  setDefaultMode(cell: string, controller: string, mode: SettableRobotSystemMode, options?: RawAxiosRequestConfig): AxiosPromise<void>;
4856
5130
  /**
4857
- * <!-- theme: success --> > Websocket endpoint Sets the robot controller into freedrive mode and stays in freedrive until the websocket connection is closed by the client. In freedrive mode, it is possible to move the attached motion groups by hand. This is a blocking call. As long as the websocket connection is open, no other endpoint can control or move the robot. <!-- theme: danger --> > **DANGER** > > Danger caused by robot. Improper assessment by the integrator of the application-specific hazards can result in people being > crushed, drawn in or caught due to the robot\'s complex movement sequences. Before opening the websocket, ensure that > > - The robot is in a safe state, > - The right payload is set, > - No humans or object are within the robot\'s reach or within the cell. As long as the websocket connection is open you will get the current state of the robot system in the response in the specified `response_rate`. If the activation failed, the returned status will return possible reasons for the failure. Free drive mode is only available for robot controllers that support it, in particular cobots. Use [listRobotControllers](listRobotControllers) to check if the robot controller supports free drive mode.
5131
+ * <!-- theme: success --> > Websocket endpoint Sets the robot controller into freedrive mode and stays in freedrive until the websocket connection is closed by the client. In freedrive mode, it is possible to move the attached motion groups by hand. This is a blocking call. As long as the websocket connection is open, no other endpoint can control or move the robot. <!-- theme: danger --> > **DANGER** > > Danger caused by robot. Improper assessment by the integrator of the application-specific hazards can result in people being > crushed, drawn in or caught due to the robot\'s complex movement sequences. Before opening the websocket, ensure that > > - The robot is in a safe state, > - The right payload is set, > - No humans or object are within the robot\'s reach or within the cell. As long as the websocket connection is open you will get the current state of the robot system in the response in the specified `response_rate`. If the activation failed, the returned status will return possible reasons for the failure. Free drive mode is only available for robot controllers that support it, in particular cobots. Use [listRobotControllers](#/operations/listRobotControllers) to check if the robot controller supports free drive mode.
4858
5132
  * @summary Stream Free Drive
4859
5133
  * @param {string} cell Unique identifier addressing a cell in all API calls.
4860
5134
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -4864,7 +5138,7 @@ declare const ControllerApiFactory: (configuration?: Configuration, basePath?: s
4864
5138
  */
4865
5139
  streamFreeDrive(cell: string, controller: string, responseRate?: number, options?: RawAxiosRequestConfig): AxiosPromise<RobotControllerState>;
4866
5140
  /**
4867
- * <!-- theme: success --> > 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.
5141
+ * <!-- theme: success --> > 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](#/operations/addRobotController). While connecting, the stream sends initialization updates. Once the controller reaches `MODE_MONITOR`, it sends controller state updates.
4868
5142
  * @summary Stream State
4869
5143
  * @param {string} cell Unique identifier addressing a cell in all API calls.
4870
5144
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -4875,7 +5149,7 @@ declare const ControllerApiFactory: (configuration?: Configuration, basePath?: s
4875
5149
  */
4876
5150
  streamRobotControllerState(cell: string, controller: string, responseRate?: number, addControllerTimeout?: number, options?: RawAxiosRequestConfig): AxiosPromise<RobotControllerState>;
4877
5151
  /**
4878
- * Update the configuration of a robot controller. Reconfigure certain options of a robot controller, or deploy a specific container image of a robot controller. To update a virtual controller, the previous controller will be deleted and a new one created. Changes to the configuration, e.g., TCPs, coordinate systems, mounting, are **not** transferred to the new robot. <!-- theme: info --> > **NOTE** > > An update is not a reset. To do a reset: > 1. Get the current configuration via [getRobotController](getRobotController). > 2. Delete the existing virtual robot controller via [deleteRobotController](deleteRobotController). > 3. Add a virtual robot controller with [addRobotController](addRobotController).
5152
+ * Update the configuration of a robot controller. Reconfigure certain options of a robot controller, or deploy a specific container image of a robot controller. To update a virtual controller, the previous controller will be deleted and a new one created. Changes to the configuration, e.g., TCPs, coordinate systems, mounting, are **not** transferred to the new robot. <!-- theme: info --> > **NOTE** > > An update is not a reset. To do a reset: > 1. Get the current configuration via [getRobotController](#/operations/getRobotController). > 2. Delete the existing virtual robot controller via [deleteRobotController](#/operations/deleteRobotController). > 3. Add a virtual robot controller with [addRobotController](#/operations/addRobotController).
4879
5153
  * @summary Update Robot Controller
4880
5154
  * @param {string} cell Unique identifier addressing a cell in all API calls.
4881
5155
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -4901,7 +5175,7 @@ declare class ControllerApi extends BaseAPI {
4901
5175
  */
4902
5176
  addRobotController(cell: string, robotController: RobotController, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
4903
5177
  /**
4904
- * Delete all robot controllers from the cell. To replace all robot controllers in a cell, use this endpoint in combination with [addRobotController](addRobotController).
5178
+ * Delete all robot controllers from the cell. To replace all robot controllers in a cell, use this endpoint in combination with [addRobotController](#/operations/addRobotController).
4905
5179
  * @summary Clear Robot Controllers
4906
5180
  * @param {string} cell Unique identifier addressing a cell in all API calls.
4907
5181
  * @param {number} [completionTimeout]
@@ -4920,7 +5194,7 @@ declare class ControllerApi extends BaseAPI {
4920
5194
  */
4921
5195
  deleteRobotController(cell: string, controller: string, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
4922
5196
  /**
4923
- * Get description of a configured robot controller including a list of connected motion group identifiers. Use [getMotionGroupDescription](getMotionGroupDescription) to get more information about the motion group.
5197
+ * Get description of a configured robot controller including a list of connected motion group identifiers. Use [getMotionGroupDescription](#/operations/getMotionGroupDescription) to get more information about the motion group.
4924
5198
  * @summary Description
4925
5199
  * @param {string} cell Unique identifier addressing a cell in all API calls.
4926
5200
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -4958,7 +5232,7 @@ declare class ControllerApi extends BaseAPI {
4958
5232
  */
4959
5233
  getRobotController(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<RobotController, any>>;
4960
5234
  /**
4961
- * Receive data to configure a virtual robot controller based on another controller. This can be used to create a virtual clone of a specific physical robot. When adding a virtual controller, use the Virtual configuration variant of [addRobotController](addRobotController) and pass the content string from this endpoint as the `json` field. Omit the `type` field that selects a preset configuration which is not required when providing a complete configuration.
5235
+ * Receive data to configure a virtual robot controller based on another controller. This can be used to create a virtual clone of a specific physical robot. When adding a virtual controller, use the Virtual configuration variant of [addRobotController](#/operations/addRobotController) and pass the content string from this endpoint as the `json` field. Omit the `type` field that selects a preset configuration, which is not required when providing a complete configuration.
4962
5236
  * @summary Virtual Controller Configuration
4963
5237
  * @param {string} cell Unique identifier addressing a cell in all API calls.
4964
5238
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -4985,7 +5259,7 @@ declare class ControllerApi extends BaseAPI {
4985
5259
  */
4986
5260
  listRobotControllers(cell: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<string[], any>>;
4987
5261
  /**
4988
- * 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 to 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.
5262
+ * 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 to 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](#/operations/getCurrentRobotControllerState). If a mode change is not possible, the response lists reasons for the failed change.
4989
5263
  * @summary Set Default Mode
4990
5264
  * @param {string} cell Unique identifier addressing a cell in all API calls.
4991
5265
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -4995,7 +5269,7 @@ declare class ControllerApi extends BaseAPI {
4995
5269
  */
4996
5270
  setDefaultMode(cell: string, controller: string, mode: SettableRobotSystemMode, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
4997
5271
  /**
4998
- * <!-- theme: success --> > Websocket endpoint Sets the robot controller into freedrive mode and stays in freedrive until the websocket connection is closed by the client. In freedrive mode, it is possible to move the attached motion groups by hand. This is a blocking call. As long as the websocket connection is open, no other endpoint can control or move the robot. <!-- theme: danger --> > **DANGER** > > Danger caused by robot. Improper assessment by the integrator of the application-specific hazards can result in people being > crushed, drawn in or caught due to the robot\'s complex movement sequences. Before opening the websocket, ensure that > > - The robot is in a safe state, > - The right payload is set, > - No humans or object are within the robot\'s reach or within the cell. As long as the websocket connection is open you will get the current state of the robot system in the response in the specified `response_rate`. If the activation failed, the returned status will return possible reasons for the failure. Free drive mode is only available for robot controllers that support it, in particular cobots. Use [listRobotControllers](listRobotControllers) to check if the robot controller supports free drive mode.
5272
+ * <!-- theme: success --> > Websocket endpoint Sets the robot controller into freedrive mode and stays in freedrive until the websocket connection is closed by the client. In freedrive mode, it is possible to move the attached motion groups by hand. This is a blocking call. As long as the websocket connection is open, no other endpoint can control or move the robot. <!-- theme: danger --> > **DANGER** > > Danger caused by robot. Improper assessment by the integrator of the application-specific hazards can result in people being > crushed, drawn in or caught due to the robot\'s complex movement sequences. Before opening the websocket, ensure that > > - The robot is in a safe state, > - The right payload is set, > - No humans or object are within the robot\'s reach or within the cell. As long as the websocket connection is open you will get the current state of the robot system in the response in the specified `response_rate`. If the activation failed, the returned status will return possible reasons for the failure. Free drive mode is only available for robot controllers that support it, in particular cobots. Use [listRobotControllers](#/operations/listRobotControllers) to check if the robot controller supports free drive mode.
4999
5273
  * @summary Stream Free Drive
5000
5274
  * @param {string} cell Unique identifier addressing a cell in all API calls.
5001
5275
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -5005,7 +5279,7 @@ declare class ControllerApi extends BaseAPI {
5005
5279
  */
5006
5280
  streamFreeDrive(cell: string, controller: string, responseRate?: number, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<RobotControllerState, any>>;
5007
5281
  /**
5008
- * <!-- theme: success --> > 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.
5282
+ * <!-- theme: success --> > 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](#/operations/addRobotController). While connecting, the stream sends initialization updates. Once the controller reaches `MODE_MONITOR`, it sends controller state updates.
5009
5283
  * @summary Stream State
5010
5284
  * @param {string} cell Unique identifier addressing a cell in all API calls.
5011
5285
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -5016,7 +5290,7 @@ declare class ControllerApi extends BaseAPI {
5016
5290
  */
5017
5291
  streamRobotControllerState(cell: string, controller: string, responseRate?: number, addControllerTimeout?: number, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<RobotControllerState, any>>;
5018
5292
  /**
5019
- * Update the configuration of a robot controller. Reconfigure certain options of a robot controller, or deploy a specific container image of a robot controller. To update a virtual controller, the previous controller will be deleted and a new one created. Changes to the configuration, e.g., TCPs, coordinate systems, mounting, are **not** transferred to the new robot. <!-- theme: info --> > **NOTE** > > An update is not a reset. To do a reset: > 1. Get the current configuration via [getRobotController](getRobotController). > 2. Delete the existing virtual robot controller via [deleteRobotController](deleteRobotController). > 3. Add a virtual robot controller with [addRobotController](addRobotController).
5293
+ * Update the configuration of a robot controller. Reconfigure certain options of a robot controller, or deploy a specific container image of a robot controller. To update a virtual controller, the previous controller will be deleted and a new one created. Changes to the configuration, e.g., TCPs, coordinate systems, mounting, are **not** transferred to the new robot. <!-- theme: info --> > **NOTE** > > An update is not a reset. To do a reset: > 1. Get the current configuration via [getRobotController](#/operations/getRobotController). > 2. Delete the existing virtual robot controller via [deleteRobotController](#/operations/deleteRobotController). > 3. Add a virtual robot controller with [addRobotController](#/operations/addRobotController).
5020
5294
  * @summary Update Robot Controller
5021
5295
  * @param {string} cell Unique identifier addressing a cell in all API calls.
5022
5296
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -5045,7 +5319,7 @@ declare const ControllerInputsOutputsApiAxiosParamCreator: (configuration?: Conf
5045
5319
  */
5046
5320
  listIODescriptions: (cell: string, controller: string, ios?: Array<string>, direction?: IODirection, valueType?: IOValueType, group?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
5047
5321
  /**
5048
- * Retrieves the current values of inputs/outputs. The identifiers of the inputs/outputs must be provided in the request. Request all available input/output identifiers via [listIODescriptions](listIODescriptions).
5322
+ * Retrieves the current values of inputs/outputs. The identifiers of the inputs/outputs must be provided in the request. Request all available input/output identifiers via [listIODescriptions](#/operations/listIODescriptions).
5049
5323
  * @summary Get Input/Output Values
5050
5324
  * @param {string} cell Unique identifier addressing a cell in all API calls.
5051
5325
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -5055,7 +5329,7 @@ declare const ControllerInputsOutputsApiAxiosParamCreator: (configuration?: Conf
5055
5329
  */
5056
5330
  listIOValues: (cell: string, controller: string, ios?: Array<string>, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
5057
5331
  /**
5058
- * Set the values of outputs. All available output identifiers and possible value ranges can be requested via [listIODescriptions](listIODescriptions). The call will return once the values have been set on and accepted by the robot. This can take up to 200 milliseconds. > **NOTE** > > Do not call this endpoint while another request is still in progress. The second call will fail.
5332
+ * Set the values of outputs. All available output identifiers and possible value ranges can be requested via [listIODescriptions](#/operations/listIODescriptions). The call will return once the values have been set on and accepted by the robot. This can take up to 200 milliseconds. > **NOTE** > > Do not call this endpoint while another request is still in progress. The second call will fail.
5059
5333
  * @summary Set Output Values
5060
5334
  * @param {string} cell Unique identifier addressing a cell in all API calls.
5061
5335
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -5075,7 +5349,7 @@ declare const ControllerInputsOutputsApiAxiosParamCreator: (configuration?: Conf
5075
5349
  */
5076
5350
  streamIOValues: (cell: string, controller: string, ios?: Array<string>, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
5077
5351
  /**
5078
- * Wait until an input/output reaches a certain value. This call returns as soon as the condition is met or the request fails. The `comparison_type` value is used to define how the current value of the input/output is compared with given value. Only set the value that corresponds to the `value_type` of the input/output. See [listIODescriptions](listIODescriptions) for more information. **Examples** 1. Wait until analog input `AI_1` < 10: ``` io: \"AI_1\" comparison_type: \"COMPARISON_LESS\" value: 10 ``` 2. Wait until analog input `AI_2` > 5.0: ``` io: \"AI_2\" comparison_type: \"COMPARISON_GREATER\" value: 5.0 ``` 3. Wait until digital input `DI_3` is true: ``` io: \"DI_3\" comparison_type: \"COMPARISON_EQUAL\" value: true ```
5352
+ * Wait until an input/output reaches a certain value. This call returns as soon as the condition is met or the request fails. The `comparison_type` value is used to define how the current value of the input/output is compared with given value. Only set the value that corresponds to the `value_type` of the input/output. See [listIODescriptions](#/operations/listIODescriptions) for more information. **Examples** 1. Wait until analog input `AI_1` < 10: ``` io: \"AI_1\" comparison_type: \"COMPARISON_LESS\" value: 10 ``` 2. Wait until analog input `AI_2` > 5.0: ``` io: \"AI_2\" comparison_type: \"COMPARISON_GREATER\" value: 5.0 ``` 3. Wait until digital input `DI_3` is true: ``` io: \"DI_3\" comparison_type: \"COMPARISON_EQUAL\" value: true ```
5079
5353
  * @summary Wait For
5080
5354
  * @param {string} cell Unique identifier addressing a cell in all API calls.
5081
5355
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -5103,7 +5377,7 @@ declare const ControllerInputsOutputsApiFp: (configuration?: Configuration) => {
5103
5377
  */
5104
5378
  listIODescriptions(cell: string, controller: string, ios?: Array<string>, direction?: IODirection, valueType?: IOValueType, group?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<IODescription>>>;
5105
5379
  /**
5106
- * Retrieves the current values of inputs/outputs. The identifiers of the inputs/outputs must be provided in the request. Request all available input/output identifiers via [listIODescriptions](listIODescriptions).
5380
+ * Retrieves the current values of inputs/outputs. The identifiers of the inputs/outputs must be provided in the request. Request all available input/output identifiers via [listIODescriptions](#/operations/listIODescriptions).
5107
5381
  * @summary Get Input/Output Values
5108
5382
  * @param {string} cell Unique identifier addressing a cell in all API calls.
5109
5383
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -5113,7 +5387,7 @@ declare const ControllerInputsOutputsApiFp: (configuration?: Configuration) => {
5113
5387
  */
5114
5388
  listIOValues(cell: string, controller: string, ios?: Array<string>, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<IOValue>>>;
5115
5389
  /**
5116
- * Set the values of outputs. All available output identifiers and possible value ranges can be requested via [listIODescriptions](listIODescriptions). The call will return once the values have been set on and accepted by the robot. This can take up to 200 milliseconds. > **NOTE** > > Do not call this endpoint while another request is still in progress. The second call will fail.
5390
+ * Set the values of outputs. All available output identifiers and possible value ranges can be requested via [listIODescriptions](#/operations/listIODescriptions). The call will return once the values have been set on and accepted by the robot. This can take up to 200 milliseconds. > **NOTE** > > Do not call this endpoint while another request is still in progress. The second call will fail.
5117
5391
  * @summary Set Output Values
5118
5392
  * @param {string} cell Unique identifier addressing a cell in all API calls.
5119
5393
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -5133,7 +5407,7 @@ declare const ControllerInputsOutputsApiFp: (configuration?: Configuration) => {
5133
5407
  */
5134
5408
  streamIOValues(cell: string, controller: string, ios?: Array<string>, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<StreamIOValuesResponse>>;
5135
5409
  /**
5136
- * Wait until an input/output reaches a certain value. This call returns as soon as the condition is met or the request fails. The `comparison_type` value is used to define how the current value of the input/output is compared with given value. Only set the value that corresponds to the `value_type` of the input/output. See [listIODescriptions](listIODescriptions) for more information. **Examples** 1. Wait until analog input `AI_1` < 10: ``` io: \"AI_1\" comparison_type: \"COMPARISON_LESS\" value: 10 ``` 2. Wait until analog input `AI_2` > 5.0: ``` io: \"AI_2\" comparison_type: \"COMPARISON_GREATER\" value: 5.0 ``` 3. Wait until digital input `DI_3` is true: ``` io: \"DI_3\" comparison_type: \"COMPARISON_EQUAL\" value: true ```
5410
+ * Wait until an input/output reaches a certain value. This call returns as soon as the condition is met or the request fails. The `comparison_type` value is used to define how the current value of the input/output is compared with given value. Only set the value that corresponds to the `value_type` of the input/output. See [listIODescriptions](#/operations/listIODescriptions) for more information. **Examples** 1. Wait until analog input `AI_1` < 10: ``` io: \"AI_1\" comparison_type: \"COMPARISON_LESS\" value: 10 ``` 2. Wait until analog input `AI_2` > 5.0: ``` io: \"AI_2\" comparison_type: \"COMPARISON_GREATER\" value: 5.0 ``` 3. Wait until digital input `DI_3` is true: ``` io: \"DI_3\" comparison_type: \"COMPARISON_EQUAL\" value: true ```
5137
5411
  * @summary Wait For
5138
5412
  * @param {string} cell Unique identifier addressing a cell in all API calls.
5139
5413
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -5161,7 +5435,7 @@ declare const ControllerInputsOutputsApiFactory: (configuration?: Configuration,
5161
5435
  */
5162
5436
  listIODescriptions(cell: string, controller: string, ios?: Array<string>, direction?: IODirection, valueType?: IOValueType, group?: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<IODescription>>;
5163
5437
  /**
5164
- * Retrieves the current values of inputs/outputs. The identifiers of the inputs/outputs must be provided in the request. Request all available input/output identifiers via [listIODescriptions](listIODescriptions).
5438
+ * Retrieves the current values of inputs/outputs. The identifiers of the inputs/outputs must be provided in the request. Request all available input/output identifiers via [listIODescriptions](#/operations/listIODescriptions).
5165
5439
  * @summary Get Input/Output Values
5166
5440
  * @param {string} cell Unique identifier addressing a cell in all API calls.
5167
5441
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -5171,7 +5445,7 @@ declare const ControllerInputsOutputsApiFactory: (configuration?: Configuration,
5171
5445
  */
5172
5446
  listIOValues(cell: string, controller: string, ios?: Array<string>, options?: RawAxiosRequestConfig): AxiosPromise<Array<IOValue>>;
5173
5447
  /**
5174
- * Set the values of outputs. All available output identifiers and possible value ranges can be requested via [listIODescriptions](listIODescriptions). The call will return once the values have been set on and accepted by the robot. This can take up to 200 milliseconds. > **NOTE** > > Do not call this endpoint while another request is still in progress. The second call will fail.
5448
+ * Set the values of outputs. All available output identifiers and possible value ranges can be requested via [listIODescriptions](#/operations/listIODescriptions). The call will return once the values have been set on and accepted by the robot. This can take up to 200 milliseconds. > **NOTE** > > Do not call this endpoint while another request is still in progress. The second call will fail.
5175
5449
  * @summary Set Output Values
5176
5450
  * @param {string} cell Unique identifier addressing a cell in all API calls.
5177
5451
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -5191,7 +5465,7 @@ declare const ControllerInputsOutputsApiFactory: (configuration?: Configuration,
5191
5465
  */
5192
5466
  streamIOValues(cell: string, controller: string, ios?: Array<string>, options?: RawAxiosRequestConfig): AxiosPromise<StreamIOValuesResponse>;
5193
5467
  /**
5194
- * Wait until an input/output reaches a certain value. This call returns as soon as the condition is met or the request fails. The `comparison_type` value is used to define how the current value of the input/output is compared with given value. Only set the value that corresponds to the `value_type` of the input/output. See [listIODescriptions](listIODescriptions) for more information. **Examples** 1. Wait until analog input `AI_1` < 10: ``` io: \"AI_1\" comparison_type: \"COMPARISON_LESS\" value: 10 ``` 2. Wait until analog input `AI_2` > 5.0: ``` io: \"AI_2\" comparison_type: \"COMPARISON_GREATER\" value: 5.0 ``` 3. Wait until digital input `DI_3` is true: ``` io: \"DI_3\" comparison_type: \"COMPARISON_EQUAL\" value: true ```
5468
+ * Wait until an input/output reaches a certain value. This call returns as soon as the condition is met or the request fails. The `comparison_type` value is used to define how the current value of the input/output is compared with given value. Only set the value that corresponds to the `value_type` of the input/output. See [listIODescriptions](#/operations/listIODescriptions) for more information. **Examples** 1. Wait until analog input `AI_1` < 10: ``` io: \"AI_1\" comparison_type: \"COMPARISON_LESS\" value: 10 ``` 2. Wait until analog input `AI_2` > 5.0: ``` io: \"AI_2\" comparison_type: \"COMPARISON_GREATER\" value: 5.0 ``` 3. Wait until digital input `DI_3` is true: ``` io: \"DI_3\" comparison_type: \"COMPARISON_EQUAL\" value: true ```
5195
5469
  * @summary Wait For
5196
5470
  * @param {string} cell Unique identifier addressing a cell in all API calls.
5197
5471
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -5219,7 +5493,7 @@ declare class ControllerInputsOutputsApi extends BaseAPI {
5219
5493
  */
5220
5494
  listIODescriptions(cell: string, controller: string, ios?: Array<string>, direction?: IODirection, valueType?: IOValueType, group?: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<IODescription[], any>>;
5221
5495
  /**
5222
- * Retrieves the current values of inputs/outputs. The identifiers of the inputs/outputs must be provided in the request. Request all available input/output identifiers via [listIODescriptions](listIODescriptions).
5496
+ * Retrieves the current values of inputs/outputs. The identifiers of the inputs/outputs must be provided in the request. Request all available input/output identifiers via [listIODescriptions](#/operations/listIODescriptions).
5223
5497
  * @summary Get Input/Output Values
5224
5498
  * @param {string} cell Unique identifier addressing a cell in all API calls.
5225
5499
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -5229,7 +5503,7 @@ declare class ControllerInputsOutputsApi extends BaseAPI {
5229
5503
  */
5230
5504
  listIOValues(cell: string, controller: string, ios?: Array<string>, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<IOValue[], any>>;
5231
5505
  /**
5232
- * Set the values of outputs. All available output identifiers and possible value ranges can be requested via [listIODescriptions](listIODescriptions). The call will return once the values have been set on and accepted by the robot. This can take up to 200 milliseconds. > **NOTE** > > Do not call this endpoint while another request is still in progress. The second call will fail.
5506
+ * Set the values of outputs. All available output identifiers and possible value ranges can be requested via [listIODescriptions](#/operations/listIODescriptions). The call will return once the values have been set on and accepted by the robot. This can take up to 200 milliseconds. > **NOTE** > > Do not call this endpoint while another request is still in progress. The second call will fail.
5233
5507
  * @summary Set Output Values
5234
5508
  * @param {string} cell Unique identifier addressing a cell in all API calls.
5235
5509
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -5249,7 +5523,7 @@ declare class ControllerInputsOutputsApi extends BaseAPI {
5249
5523
  */
5250
5524
  streamIOValues(cell: string, controller: string, ios?: Array<string>, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<StreamIOValuesResponse, any>>;
5251
5525
  /**
5252
- * Wait until an input/output reaches a certain value. This call returns as soon as the condition is met or the request fails. The `comparison_type` value is used to define how the current value of the input/output is compared with given value. Only set the value that corresponds to the `value_type` of the input/output. See [listIODescriptions](listIODescriptions) for more information. **Examples** 1. Wait until analog input `AI_1` < 10: ``` io: \"AI_1\" comparison_type: \"COMPARISON_LESS\" value: 10 ``` 2. Wait until analog input `AI_2` > 5.0: ``` io: \"AI_2\" comparison_type: \"COMPARISON_GREATER\" value: 5.0 ``` 3. Wait until digital input `DI_3` is true: ``` io: \"DI_3\" comparison_type: \"COMPARISON_EQUAL\" value: true ```
5526
+ * Wait until an input/output reaches a certain value. This call returns as soon as the condition is met or the request fails. The `comparison_type` value is used to define how the current value of the input/output is compared with given value. Only set the value that corresponds to the `value_type` of the input/output. See [listIODescriptions](#/operations/listIODescriptions) for more information. **Examples** 1. Wait until analog input `AI_1` < 10: ``` io: \"AI_1\" comparison_type: \"COMPARISON_LESS\" value: 10 ``` 2. Wait until analog input `AI_2` > 5.0: ``` io: \"AI_2\" comparison_type: \"COMPARISON_GREATER\" value: 5.0 ``` 3. Wait until digital input `DI_3` is true: ``` io: \"DI_3\" comparison_type: \"COMPARISON_EQUAL\" value: true ```
5253
5527
  * @summary Wait For
5254
5528
  * @param {string} cell Unique identifier addressing a cell in all API calls.
5255
5529
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -5264,7 +5538,7 @@ declare class ControllerInputsOutputsApi extends BaseAPI {
5264
5538
  */
5265
5539
  declare const JoggingApiAxiosParamCreator: (configuration?: Configuration) => {
5266
5540
  /**
5267
- * <!-- theme: success --> > Websocket endpoint Provides execution control over a dynamically adaptable jogging motion for a motion group. Jogging describes controlling a motion group by sending real-time commands to move either its joints or the TCP. The commands contain target velocities that may change at any time during execution, so the resulting motion cannot be computed upfront. ### Preconditions The motion group is not moved by any other endpoint. ### Requests #### 1. Send `InitializeJoggingRequest` to configure the jogging. - Sets the robot controller mode to control mode. - Claims the motion group for jogging. For robotic arms, TCP is required to ensure that limits, including TCP limits, are respected. #### 2. Send `JointVelocityRequest` or `TcpVelocityRequest` to start the jogging motion. - Commands can only be processed in the cycle rate of the controller - Sending commands faster will not increase the responsiveness of the jogging motion, it will lead to dropped commands - It is recommended to couple sending commands with the [state stream](streamMotionGroupState), which can be subscribed to via nats as well. #### 3. Change or stop the jogging motion - Change the jogging direction and/or velocity during the jogging motion with `JointVelocityRequest` or `TcpVelocityRequest`. - To stop the jogging motion, send zero velocities via either request or `PauseJoggingRequest`. ### Responses - Each request is acknowledged with a corresponding response: - `InitializeJoggingResponse` after `InitializeJoggingRequest` - `JointVelocityResponse` after `JointVelocityRequest` - `TcpVelocityResponse` after `TcpVelocityRequest` - `PauseJoggingResponse` after `PauseJoggingRequest` The responses confirm that the requests were received. They do not signal that the operation was successful; check the [motion group state](streamMotionGroupState) for that. - `MovementErrorResponse` with error details is sent in case of an unexpected error, e.g., controller disconnects during jogging. ### Tips and Tricks - Ensure that the websocket connection remains open until the jogging motion is stopped to avoid unexpected stops.
5541
+ * <!-- theme: success --> > Websocket endpoint Provides execution control over a dynamically adaptable jogging motion for a motion group. Jogging describes controlling a motion group by sending real-time commands to move either its joints or the TCP. The commands contain target velocities that may change at any time during execution, so the resulting motion cannot be computed upfront. ### Preconditions The motion group is not moved by any other endpoint. ### Requests #### 1. Send `InitializeJoggingRequest` to configure the jogging. - Sets the robot controller mode to control mode. - Claims the motion group for jogging. For robotic arms, TCP is required to ensure that limits, including TCP limits, are respected. #### 2. Send `JointVelocityRequest` or `TcpVelocityRequest` to start the jogging motion. - Commands can only be processed in the cycle rate of the controller - Sending commands faster will not increase the responsiveness of the jogging motion, it will lead to dropped commands - It is recommended to couple sending commands with the [state stream](#/operations/streamMotionGroupState), which can be subscribed to via nats as well. #### 3. Change or stop the jogging motion - Change the jogging direction and/or velocity during the jogging motion with `JointVelocityRequest` or `TcpVelocityRequest`. - To stop the jogging motion, send zero velocities via either request or `PauseJoggingRequest`. ### Responses - Each request is acknowledged with a corresponding response: - `InitializeJoggingResponse` after `InitializeJoggingRequest` - `JointVelocityResponse` after `JointVelocityRequest` - `TcpVelocityResponse` after `TcpVelocityRequest` - `PauseJoggingResponse` after `PauseJoggingRequest` The responses confirm that the requests were received. They do not signal that the operation was successful; check the [motion group state](#/operations/streamMotionGroupState) for that. - `MovementErrorResponse` with error details is sent in case of an unexpected error, e.g., controller disconnects during jogging. ### Tips and Tricks - Ensure that the websocket connection remains open until the jogging motion is stopped to avoid unexpected stops.
5268
5542
  * @summary Execute Jogging
5269
5543
  * @param {string} cell Unique identifier addressing a cell in all API calls.
5270
5544
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -5279,7 +5553,7 @@ declare const JoggingApiAxiosParamCreator: (configuration?: Configuration) => {
5279
5553
  */
5280
5554
  declare const JoggingApiFp: (configuration?: Configuration) => {
5281
5555
  /**
5282
- * <!-- theme: success --> > Websocket endpoint Provides execution control over a dynamically adaptable jogging motion for a motion group. Jogging describes controlling a motion group by sending real-time commands to move either its joints or the TCP. The commands contain target velocities that may change at any time during execution, so the resulting motion cannot be computed upfront. ### Preconditions The motion group is not moved by any other endpoint. ### Requests #### 1. Send `InitializeJoggingRequest` to configure the jogging. - Sets the robot controller mode to control mode. - Claims the motion group for jogging. For robotic arms, TCP is required to ensure that limits, including TCP limits, are respected. #### 2. Send `JointVelocityRequest` or `TcpVelocityRequest` to start the jogging motion. - Commands can only be processed in the cycle rate of the controller - Sending commands faster will not increase the responsiveness of the jogging motion, it will lead to dropped commands - It is recommended to couple sending commands with the [state stream](streamMotionGroupState), which can be subscribed to via nats as well. #### 3. Change or stop the jogging motion - Change the jogging direction and/or velocity during the jogging motion with `JointVelocityRequest` or `TcpVelocityRequest`. - To stop the jogging motion, send zero velocities via either request or `PauseJoggingRequest`. ### Responses - Each request is acknowledged with a corresponding response: - `InitializeJoggingResponse` after `InitializeJoggingRequest` - `JointVelocityResponse` after `JointVelocityRequest` - `TcpVelocityResponse` after `TcpVelocityRequest` - `PauseJoggingResponse` after `PauseJoggingRequest` The responses confirm that the requests were received. They do not signal that the operation was successful; check the [motion group state](streamMotionGroupState) for that. - `MovementErrorResponse` with error details is sent in case of an unexpected error, e.g., controller disconnects during jogging. ### Tips and Tricks - Ensure that the websocket connection remains open until the jogging motion is stopped to avoid unexpected stops.
5556
+ * <!-- theme: success --> > Websocket endpoint Provides execution control over a dynamically adaptable jogging motion for a motion group. Jogging describes controlling a motion group by sending real-time commands to move either its joints or the TCP. The commands contain target velocities that may change at any time during execution, so the resulting motion cannot be computed upfront. ### Preconditions The motion group is not moved by any other endpoint. ### Requests #### 1. Send `InitializeJoggingRequest` to configure the jogging. - Sets the robot controller mode to control mode. - Claims the motion group for jogging. For robotic arms, TCP is required to ensure that limits, including TCP limits, are respected. #### 2. Send `JointVelocityRequest` or `TcpVelocityRequest` to start the jogging motion. - Commands can only be processed in the cycle rate of the controller - Sending commands faster will not increase the responsiveness of the jogging motion, it will lead to dropped commands - It is recommended to couple sending commands with the [state stream](#/operations/streamMotionGroupState), which can be subscribed to via nats as well. #### 3. Change or stop the jogging motion - Change the jogging direction and/or velocity during the jogging motion with `JointVelocityRequest` or `TcpVelocityRequest`. - To stop the jogging motion, send zero velocities via either request or `PauseJoggingRequest`. ### Responses - Each request is acknowledged with a corresponding response: - `InitializeJoggingResponse` after `InitializeJoggingRequest` - `JointVelocityResponse` after `JointVelocityRequest` - `TcpVelocityResponse` after `TcpVelocityRequest` - `PauseJoggingResponse` after `PauseJoggingRequest` The responses confirm that the requests were received. They do not signal that the operation was successful; check the [motion group state](#/operations/streamMotionGroupState) for that. - `MovementErrorResponse` with error details is sent in case of an unexpected error, e.g., controller disconnects during jogging. ### Tips and Tricks - Ensure that the websocket connection remains open until the jogging motion is stopped to avoid unexpected stops.
5283
5557
  * @summary Execute Jogging
5284
5558
  * @param {string} cell Unique identifier addressing a cell in all API calls.
5285
5559
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -5294,7 +5568,7 @@ declare const JoggingApiFp: (configuration?: Configuration) => {
5294
5568
  */
5295
5569
  declare const JoggingApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
5296
5570
  /**
5297
- * <!-- theme: success --> > Websocket endpoint Provides execution control over a dynamically adaptable jogging motion for a motion group. Jogging describes controlling a motion group by sending real-time commands to move either its joints or the TCP. The commands contain target velocities that may change at any time during execution, so the resulting motion cannot be computed upfront. ### Preconditions The motion group is not moved by any other endpoint. ### Requests #### 1. Send `InitializeJoggingRequest` to configure the jogging. - Sets the robot controller mode to control mode. - Claims the motion group for jogging. For robotic arms, TCP is required to ensure that limits, including TCP limits, are respected. #### 2. Send `JointVelocityRequest` or `TcpVelocityRequest` to start the jogging motion. - Commands can only be processed in the cycle rate of the controller - Sending commands faster will not increase the responsiveness of the jogging motion, it will lead to dropped commands - It is recommended to couple sending commands with the [state stream](streamMotionGroupState), which can be subscribed to via nats as well. #### 3. Change or stop the jogging motion - Change the jogging direction and/or velocity during the jogging motion with `JointVelocityRequest` or `TcpVelocityRequest`. - To stop the jogging motion, send zero velocities via either request or `PauseJoggingRequest`. ### Responses - Each request is acknowledged with a corresponding response: - `InitializeJoggingResponse` after `InitializeJoggingRequest` - `JointVelocityResponse` after `JointVelocityRequest` - `TcpVelocityResponse` after `TcpVelocityRequest` - `PauseJoggingResponse` after `PauseJoggingRequest` The responses confirm that the requests were received. They do not signal that the operation was successful; check the [motion group state](streamMotionGroupState) for that. - `MovementErrorResponse` with error details is sent in case of an unexpected error, e.g., controller disconnects during jogging. ### Tips and Tricks - Ensure that the websocket connection remains open until the jogging motion is stopped to avoid unexpected stops.
5571
+ * <!-- theme: success --> > Websocket endpoint Provides execution control over a dynamically adaptable jogging motion for a motion group. Jogging describes controlling a motion group by sending real-time commands to move either its joints or the TCP. The commands contain target velocities that may change at any time during execution, so the resulting motion cannot be computed upfront. ### Preconditions The motion group is not moved by any other endpoint. ### Requests #### 1. Send `InitializeJoggingRequest` to configure the jogging. - Sets the robot controller mode to control mode. - Claims the motion group for jogging. For robotic arms, TCP is required to ensure that limits, including TCP limits, are respected. #### 2. Send `JointVelocityRequest` or `TcpVelocityRequest` to start the jogging motion. - Commands can only be processed in the cycle rate of the controller - Sending commands faster will not increase the responsiveness of the jogging motion, it will lead to dropped commands - It is recommended to couple sending commands with the [state stream](#/operations/streamMotionGroupState), which can be subscribed to via nats as well. #### 3. Change or stop the jogging motion - Change the jogging direction and/or velocity during the jogging motion with `JointVelocityRequest` or `TcpVelocityRequest`. - To stop the jogging motion, send zero velocities via either request or `PauseJoggingRequest`. ### Responses - Each request is acknowledged with a corresponding response: - `InitializeJoggingResponse` after `InitializeJoggingRequest` - `JointVelocityResponse` after `JointVelocityRequest` - `TcpVelocityResponse` after `TcpVelocityRequest` - `PauseJoggingResponse` after `PauseJoggingRequest` The responses confirm that the requests were received. They do not signal that the operation was successful; check the [motion group state](#/operations/streamMotionGroupState) for that. - `MovementErrorResponse` with error details is sent in case of an unexpected error, e.g., controller disconnects during jogging. ### Tips and Tricks - Ensure that the websocket connection remains open until the jogging motion is stopped to avoid unexpected stops.
5298
5572
  * @summary Execute Jogging
5299
5573
  * @param {string} cell Unique identifier addressing a cell in all API calls.
5300
5574
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -5309,7 +5583,7 @@ declare const JoggingApiFactory: (configuration?: Configuration, basePath?: stri
5309
5583
  */
5310
5584
  declare class JoggingApi extends BaseAPI {
5311
5585
  /**
5312
- * <!-- theme: success --> > Websocket endpoint Provides execution control over a dynamically adaptable jogging motion for a motion group. Jogging describes controlling a motion group by sending real-time commands to move either its joints or the TCP. The commands contain target velocities that may change at any time during execution, so the resulting motion cannot be computed upfront. ### Preconditions The motion group is not moved by any other endpoint. ### Requests #### 1. Send `InitializeJoggingRequest` to configure the jogging. - Sets the robot controller mode to control mode. - Claims the motion group for jogging. For robotic arms, TCP is required to ensure that limits, including TCP limits, are respected. #### 2. Send `JointVelocityRequest` or `TcpVelocityRequest` to start the jogging motion. - Commands can only be processed in the cycle rate of the controller - Sending commands faster will not increase the responsiveness of the jogging motion, it will lead to dropped commands - It is recommended to couple sending commands with the [state stream](streamMotionGroupState), which can be subscribed to via nats as well. #### 3. Change or stop the jogging motion - Change the jogging direction and/or velocity during the jogging motion with `JointVelocityRequest` or `TcpVelocityRequest`. - To stop the jogging motion, send zero velocities via either request or `PauseJoggingRequest`. ### Responses - Each request is acknowledged with a corresponding response: - `InitializeJoggingResponse` after `InitializeJoggingRequest` - `JointVelocityResponse` after `JointVelocityRequest` - `TcpVelocityResponse` after `TcpVelocityRequest` - `PauseJoggingResponse` after `PauseJoggingRequest` The responses confirm that the requests were received. They do not signal that the operation was successful; check the [motion group state](streamMotionGroupState) for that. - `MovementErrorResponse` with error details is sent in case of an unexpected error, e.g., controller disconnects during jogging. ### Tips and Tricks - Ensure that the websocket connection remains open until the jogging motion is stopped to avoid unexpected stops.
5586
+ * <!-- theme: success --> > Websocket endpoint Provides execution control over a dynamically adaptable jogging motion for a motion group. Jogging describes controlling a motion group by sending real-time commands to move either its joints or the TCP. The commands contain target velocities that may change at any time during execution, so the resulting motion cannot be computed upfront. ### Preconditions The motion group is not moved by any other endpoint. ### Requests #### 1. Send `InitializeJoggingRequest` to configure the jogging. - Sets the robot controller mode to control mode. - Claims the motion group for jogging. For robotic arms, TCP is required to ensure that limits, including TCP limits, are respected. #### 2. Send `JointVelocityRequest` or `TcpVelocityRequest` to start the jogging motion. - Commands can only be processed in the cycle rate of the controller - Sending commands faster will not increase the responsiveness of the jogging motion, it will lead to dropped commands - It is recommended to couple sending commands with the [state stream](#/operations/streamMotionGroupState), which can be subscribed to via nats as well. #### 3. Change or stop the jogging motion - Change the jogging direction and/or velocity during the jogging motion with `JointVelocityRequest` or `TcpVelocityRequest`. - To stop the jogging motion, send zero velocities via either request or `PauseJoggingRequest`. ### Responses - Each request is acknowledged with a corresponding response: - `InitializeJoggingResponse` after `InitializeJoggingRequest` - `JointVelocityResponse` after `JointVelocityRequest` - `TcpVelocityResponse` after `TcpVelocityRequest` - `PauseJoggingResponse` after `PauseJoggingRequest` The responses confirm that the requests were received. They do not signal that the operation was successful; check the [motion group state](#/operations/streamMotionGroupState) for that. - `MovementErrorResponse` with error details is sent in case of an unexpected error, e.g., controller disconnects during jogging. ### Tips and Tricks - Ensure that the websocket connection remains open until the jogging motion is stopped to avoid unexpected stops.
5313
5587
  * @summary Execute Jogging
5314
5588
  * @param {string} cell Unique identifier addressing a cell in all API calls.
5315
5589
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -5704,25 +5978,25 @@ declare class MotionGroupApi extends BaseAPI {
5704
5978
  */
5705
5979
  declare const MotionGroupModelsApiAxiosParamCreator: (configuration?: Configuration) => {
5706
5980
  /**
5707
- * Returns the default collision link chain for a given motion group model. See [getMotionGroupModels](getMotionGroupModels) for supported motion group models. The default link chain is derived from 3D models and optimized for collision detection within NOVA. The default link chain includes link shapes only. It does not include any attached components like wire feeders or sensors. Attach additional shapes to the link reference frames by extending the link dictionaries before further use. Additional shapes may overlap each other per link and may also overlap the respective link\'s default shape.
5981
+ * Returns the default collision link chain for a given motion group model. See [getMotionGroupModels](#/operations/getMotionGroupModels) for supported motion group models. The default link chain is derived from 3D models and optimized for collision detection within NOVA. The default link chain includes link shapes only. It does not include any attached components like wire feeders or sensors. Attach additional shapes to the link reference frames by extending the link dictionaries before further use. Additional shapes may overlap each other per link and may also overlap the respective link\'s default shape.
5708
5982
  * @summary Get Collision Model
5709
- * @param {string} motionGroupModel Unique identifier for the model of a motion group, e.g., &#x60;UniversalRobots_UR10e&#x60;. Get the &#x60;model&#x60; of a configured motion group with [getOptimizerConfiguration](getOptimizerConfiguration).
5983
+ * @param {string} motionGroupModel Unique identifier for the model of a motion group, e.g., &#x60;UniversalRobots_UR10e&#x60;. Get the &#x60;model&#x60; of a configured motion group with [getOptimizerConfiguration](#/operations/getOptimizerConfiguration).
5710
5984
  * @param {*} [options] Override http request option.
5711
5985
  * @throws {RequiredError}
5712
5986
  */
5713
5987
  getMotionGroupCollisionModel: (motionGroupModel: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
5714
5988
  /**
5715
- * Returns the GLB asset for the specified motion group model. See [getMotionGroupModels](getMotionGroupModels) for supported identifiers.
5989
+ * Returns the GLB asset for the specified motion group model. See [getMotionGroupModels](#/operations/getMotionGroupModels) for supported identifiers.
5716
5990
  * @summary Download GLB Model
5717
- * @param {string} motionGroupModel Unique identifier for the model of a motion group, e.g., &#x60;UniversalRobots_UR10e&#x60;. Get the &#x60;model&#x60; of a configured motion group with [getOptimizerConfiguration](getOptimizerConfiguration).
5991
+ * @param {string} motionGroupModel Unique identifier for the model of a motion group, e.g., &#x60;UniversalRobots_UR10e&#x60;. Get the &#x60;model&#x60; of a configured motion group with [getOptimizerConfiguration](#/operations/getOptimizerConfiguration).
5718
5992
  * @param {*} [options] Override http request option.
5719
5993
  * @throws {RequiredError}
5720
5994
  */
5721
5995
  getMotionGroupGlbModel: (motionGroupModel: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
5722
5996
  /**
5723
- * Returns the kinematics model (DH parameters) for the given motion group model. See [getMotionGroupModels](getMotionGroupModels) for supported motion group models.
5997
+ * Returns the kinematics model (DH parameters) for the given motion group model. See [getMotionGroupModels](#/operations/getMotionGroupModels) for supported motion group models.
5724
5998
  * @summary Get Kinematics
5725
- * @param {string} motionGroupModel Unique identifier for the model of a motion group, e.g., &#x60;UniversalRobots_UR10e&#x60;. Get the &#x60;model&#x60; of a configured motion group with [getOptimizerConfiguration](getOptimizerConfiguration).
5999
+ * @param {string} motionGroupModel Unique identifier for the model of a motion group, e.g., &#x60;UniversalRobots_UR10e&#x60;. Get the &#x60;model&#x60; of a configured motion group with [getOptimizerConfiguration](#/operations/getOptimizerConfiguration).
5726
6000
  * @param {*} [options] Override http request option.
5727
6001
  * @throws {RequiredError}
5728
6002
  */
@@ -5735,9 +6009,9 @@ declare const MotionGroupModelsApiAxiosParamCreator: (configuration?: Configurat
5735
6009
  */
5736
6010
  getMotionGroupModels: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
5737
6011
  /**
5738
- * Returns the USD scene model for the specified motion group model. See [getMotionGroupModels](getMotionGroupModels) for supported identifiers.
6012
+ * Returns the USD scene model for the specified motion group model. See [getMotionGroupModels](#/operations/getMotionGroupModels) for supported identifiers.
5739
6013
  * @summary Download USD Model
5740
- * @param {string} motionGroupModel Unique identifier for the model of a motion group, e.g., &#x60;UniversalRobots_UR10e&#x60;. Get the &#x60;model&#x60; of a configured motion group with [getOptimizerConfiguration](getOptimizerConfiguration).
6014
+ * @param {string} motionGroupModel Unique identifier for the model of a motion group, e.g., &#x60;UniversalRobots_UR10e&#x60;. Get the &#x60;model&#x60; of a configured motion group with [getOptimizerConfiguration](#/operations/getOptimizerConfiguration).
5741
6015
  * @param {*} [options] Override http request option.
5742
6016
  * @throws {RequiredError}
5743
6017
  */
@@ -5748,9 +6022,9 @@ declare const MotionGroupModelsApiAxiosParamCreator: (configuration?: Configurat
5748
6022
  */
5749
6023
  declare const MotionGroupModelsApiFp: (configuration?: Configuration) => {
5750
6024
  /**
5751
- * Returns the default collision link chain for a given motion group model. See [getMotionGroupModels](getMotionGroupModels) for supported motion group models. The default link chain is derived from 3D models and optimized for collision detection within NOVA. The default link chain includes link shapes only. It does not include any attached components like wire feeders or sensors. Attach additional shapes to the link reference frames by extending the link dictionaries before further use. Additional shapes may overlap each other per link and may also overlap the respective link\'s default shape.
6025
+ * Returns the default collision link chain for a given motion group model. See [getMotionGroupModels](#/operations/getMotionGroupModels) for supported motion group models. The default link chain is derived from 3D models and optimized for collision detection within NOVA. The default link chain includes link shapes only. It does not include any attached components like wire feeders or sensors. Attach additional shapes to the link reference frames by extending the link dictionaries before further use. Additional shapes may overlap each other per link and may also overlap the respective link\'s default shape.
5752
6026
  * @summary Get Collision Model
5753
- * @param {string} motionGroupModel Unique identifier for the model of a motion group, e.g., &#x60;UniversalRobots_UR10e&#x60;. Get the &#x60;model&#x60; of a configured motion group with [getOptimizerConfiguration](getOptimizerConfiguration).
6027
+ * @param {string} motionGroupModel Unique identifier for the model of a motion group, e.g., &#x60;UniversalRobots_UR10e&#x60;. Get the &#x60;model&#x60; of a configured motion group with [getOptimizerConfiguration](#/operations/getOptimizerConfiguration).
5754
6028
  * @param {*} [options] Override http request option.
5755
6029
  * @throws {RequiredError}
5756
6030
  */
@@ -5758,17 +6032,17 @@ declare const MotionGroupModelsApiFp: (configuration?: Configuration) => {
5758
6032
  [key: string]: Collider;
5759
6033
  }>>>;
5760
6034
  /**
5761
- * Returns the GLB asset for the specified motion group model. See [getMotionGroupModels](getMotionGroupModels) for supported identifiers.
6035
+ * Returns the GLB asset for the specified motion group model. See [getMotionGroupModels](#/operations/getMotionGroupModels) for supported identifiers.
5762
6036
  * @summary Download GLB Model
5763
- * @param {string} motionGroupModel Unique identifier for the model of a motion group, e.g., &#x60;UniversalRobots_UR10e&#x60;. Get the &#x60;model&#x60; of a configured motion group with [getOptimizerConfiguration](getOptimizerConfiguration).
6037
+ * @param {string} motionGroupModel Unique identifier for the model of a motion group, e.g., &#x60;UniversalRobots_UR10e&#x60;. Get the &#x60;model&#x60; of a configured motion group with [getOptimizerConfiguration](#/operations/getOptimizerConfiguration).
5764
6038
  * @param {*} [options] Override http request option.
5765
6039
  * @throws {RequiredError}
5766
6040
  */
5767
6041
  getMotionGroupGlbModel(motionGroupModel: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<File>>;
5768
6042
  /**
5769
- * Returns the kinematics model (DH parameters) for the given motion group model. See [getMotionGroupModels](getMotionGroupModels) for supported motion group models.
6043
+ * Returns the kinematics model (DH parameters) for the given motion group model. See [getMotionGroupModels](#/operations/getMotionGroupModels) for supported motion group models.
5770
6044
  * @summary Get Kinematics
5771
- * @param {string} motionGroupModel Unique identifier for the model of a motion group, e.g., &#x60;UniversalRobots_UR10e&#x60;. Get the &#x60;model&#x60; of a configured motion group with [getOptimizerConfiguration](getOptimizerConfiguration).
6045
+ * @param {string} motionGroupModel Unique identifier for the model of a motion group, e.g., &#x60;UniversalRobots_UR10e&#x60;. Get the &#x60;model&#x60; of a configured motion group with [getOptimizerConfiguration](#/operations/getOptimizerConfiguration).
5772
6046
  * @param {*} [options] Override http request option.
5773
6047
  * @throws {RequiredError}
5774
6048
  */
@@ -5781,9 +6055,9 @@ declare const MotionGroupModelsApiFp: (configuration?: Configuration) => {
5781
6055
  */
5782
6056
  getMotionGroupModels(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<string>>>;
5783
6057
  /**
5784
- * Returns the USD scene model for the specified motion group model. See [getMotionGroupModels](getMotionGroupModels) for supported identifiers.
6058
+ * Returns the USD scene model for the specified motion group model. See [getMotionGroupModels](#/operations/getMotionGroupModels) for supported identifiers.
5785
6059
  * @summary Download USD Model
5786
- * @param {string} motionGroupModel Unique identifier for the model of a motion group, e.g., &#x60;UniversalRobots_UR10e&#x60;. Get the &#x60;model&#x60; of a configured motion group with [getOptimizerConfiguration](getOptimizerConfiguration).
6060
+ * @param {string} motionGroupModel Unique identifier for the model of a motion group, e.g., &#x60;UniversalRobots_UR10e&#x60;. Get the &#x60;model&#x60; of a configured motion group with [getOptimizerConfiguration](#/operations/getOptimizerConfiguration).
5787
6061
  * @param {*} [options] Override http request option.
5788
6062
  * @throws {RequiredError}
5789
6063
  */
@@ -5794,9 +6068,9 @@ declare const MotionGroupModelsApiFp: (configuration?: Configuration) => {
5794
6068
  */
5795
6069
  declare const MotionGroupModelsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
5796
6070
  /**
5797
- * Returns the default collision link chain for a given motion group model. See [getMotionGroupModels](getMotionGroupModels) for supported motion group models. The default link chain is derived from 3D models and optimized for collision detection within NOVA. The default link chain includes link shapes only. It does not include any attached components like wire feeders or sensors. Attach additional shapes to the link reference frames by extending the link dictionaries before further use. Additional shapes may overlap each other per link and may also overlap the respective link\'s default shape.
6071
+ * Returns the default collision link chain for a given motion group model. See [getMotionGroupModels](#/operations/getMotionGroupModels) for supported motion group models. The default link chain is derived from 3D models and optimized for collision detection within NOVA. The default link chain includes link shapes only. It does not include any attached components like wire feeders or sensors. Attach additional shapes to the link reference frames by extending the link dictionaries before further use. Additional shapes may overlap each other per link and may also overlap the respective link\'s default shape.
5798
6072
  * @summary Get Collision Model
5799
- * @param {string} motionGroupModel Unique identifier for the model of a motion group, e.g., &#x60;UniversalRobots_UR10e&#x60;. Get the &#x60;model&#x60; of a configured motion group with [getOptimizerConfiguration](getOptimizerConfiguration).
6073
+ * @param {string} motionGroupModel Unique identifier for the model of a motion group, e.g., &#x60;UniversalRobots_UR10e&#x60;. Get the &#x60;model&#x60; of a configured motion group with [getOptimizerConfiguration](#/operations/getOptimizerConfiguration).
5800
6074
  * @param {*} [options] Override http request option.
5801
6075
  * @throws {RequiredError}
5802
6076
  */
@@ -5804,17 +6078,17 @@ declare const MotionGroupModelsApiFactory: (configuration?: Configuration, baseP
5804
6078
  [key: string]: Collider;
5805
6079
  }>>;
5806
6080
  /**
5807
- * Returns the GLB asset for the specified motion group model. See [getMotionGroupModels](getMotionGroupModels) for supported identifiers.
6081
+ * Returns the GLB asset for the specified motion group model. See [getMotionGroupModels](#/operations/getMotionGroupModels) for supported identifiers.
5808
6082
  * @summary Download GLB Model
5809
- * @param {string} motionGroupModel Unique identifier for the model of a motion group, e.g., &#x60;UniversalRobots_UR10e&#x60;. Get the &#x60;model&#x60; of a configured motion group with [getOptimizerConfiguration](getOptimizerConfiguration).
6083
+ * @param {string} motionGroupModel Unique identifier for the model of a motion group, e.g., &#x60;UniversalRobots_UR10e&#x60;. Get the &#x60;model&#x60; of a configured motion group with [getOptimizerConfiguration](#/operations/getOptimizerConfiguration).
5810
6084
  * @param {*} [options] Override http request option.
5811
6085
  * @throws {RequiredError}
5812
6086
  */
5813
6087
  getMotionGroupGlbModel(motionGroupModel: string, options?: RawAxiosRequestConfig): AxiosPromise<File>;
5814
6088
  /**
5815
- * Returns the kinematics model (DH parameters) for the given motion group model. See [getMotionGroupModels](getMotionGroupModels) for supported motion group models.
6089
+ * Returns the kinematics model (DH parameters) for the given motion group model. See [getMotionGroupModels](#/operations/getMotionGroupModels) for supported motion group models.
5816
6090
  * @summary Get Kinematics
5817
- * @param {string} motionGroupModel Unique identifier for the model of a motion group, e.g., &#x60;UniversalRobots_UR10e&#x60;. Get the &#x60;model&#x60; of a configured motion group with [getOptimizerConfiguration](getOptimizerConfiguration).
6091
+ * @param {string} motionGroupModel Unique identifier for the model of a motion group, e.g., &#x60;UniversalRobots_UR10e&#x60;. Get the &#x60;model&#x60; of a configured motion group with [getOptimizerConfiguration](#/operations/getOptimizerConfiguration).
5818
6092
  * @param {*} [options] Override http request option.
5819
6093
  * @throws {RequiredError}
5820
6094
  */
@@ -5827,9 +6101,9 @@ declare const MotionGroupModelsApiFactory: (configuration?: Configuration, baseP
5827
6101
  */
5828
6102
  getMotionGroupModels(options?: RawAxiosRequestConfig): AxiosPromise<Array<string>>;
5829
6103
  /**
5830
- * Returns the USD scene model for the specified motion group model. See [getMotionGroupModels](getMotionGroupModels) for supported identifiers.
6104
+ * Returns the USD scene model for the specified motion group model. See [getMotionGroupModels](#/operations/getMotionGroupModels) for supported identifiers.
5831
6105
  * @summary Download USD Model
5832
- * @param {string} motionGroupModel Unique identifier for the model of a motion group, e.g., &#x60;UniversalRobots_UR10e&#x60;. Get the &#x60;model&#x60; of a configured motion group with [getOptimizerConfiguration](getOptimizerConfiguration).
6106
+ * @param {string} motionGroupModel Unique identifier for the model of a motion group, e.g., &#x60;UniversalRobots_UR10e&#x60;. Get the &#x60;model&#x60; of a configured motion group with [getOptimizerConfiguration](#/operations/getOptimizerConfiguration).
5833
6107
  * @param {*} [options] Override http request option.
5834
6108
  * @throws {RequiredError}
5835
6109
  */
@@ -5840,9 +6114,9 @@ declare const MotionGroupModelsApiFactory: (configuration?: Configuration, baseP
5840
6114
  */
5841
6115
  declare class MotionGroupModelsApi extends BaseAPI {
5842
6116
  /**
5843
- * Returns the default collision link chain for a given motion group model. See [getMotionGroupModels](getMotionGroupModels) for supported motion group models. The default link chain is derived from 3D models and optimized for collision detection within NOVA. The default link chain includes link shapes only. It does not include any attached components like wire feeders or sensors. Attach additional shapes to the link reference frames by extending the link dictionaries before further use. Additional shapes may overlap each other per link and may also overlap the respective link\'s default shape.
6117
+ * Returns the default collision link chain for a given motion group model. See [getMotionGroupModels](#/operations/getMotionGroupModels) for supported motion group models. The default link chain is derived from 3D models and optimized for collision detection within NOVA. The default link chain includes link shapes only. It does not include any attached components like wire feeders or sensors. Attach additional shapes to the link reference frames by extending the link dictionaries before further use. Additional shapes may overlap each other per link and may also overlap the respective link\'s default shape.
5844
6118
  * @summary Get Collision Model
5845
- * @param {string} motionGroupModel Unique identifier for the model of a motion group, e.g., &#x60;UniversalRobots_UR10e&#x60;. Get the &#x60;model&#x60; of a configured motion group with [getOptimizerConfiguration](getOptimizerConfiguration).
6119
+ * @param {string} motionGroupModel Unique identifier for the model of a motion group, e.g., &#x60;UniversalRobots_UR10e&#x60;. Get the &#x60;model&#x60; of a configured motion group with [getOptimizerConfiguration](#/operations/getOptimizerConfiguration).
5846
6120
  * @param {*} [options] Override http request option.
5847
6121
  * @throws {RequiredError}
5848
6122
  */
@@ -5850,17 +6124,17 @@ declare class MotionGroupModelsApi extends BaseAPI {
5850
6124
  [key: string]: Collider;
5851
6125
  }[], any>>;
5852
6126
  /**
5853
- * Returns the GLB asset for the specified motion group model. See [getMotionGroupModels](getMotionGroupModels) for supported identifiers.
6127
+ * Returns the GLB asset for the specified motion group model. See [getMotionGroupModels](#/operations/getMotionGroupModels) for supported identifiers.
5854
6128
  * @summary Download GLB Model
5855
- * @param {string} motionGroupModel Unique identifier for the model of a motion group, e.g., &#x60;UniversalRobots_UR10e&#x60;. Get the &#x60;model&#x60; of a configured motion group with [getOptimizerConfiguration](getOptimizerConfiguration).
6129
+ * @param {string} motionGroupModel Unique identifier for the model of a motion group, e.g., &#x60;UniversalRobots_UR10e&#x60;. Get the &#x60;model&#x60; of a configured motion group with [getOptimizerConfiguration](#/operations/getOptimizerConfiguration).
5856
6130
  * @param {*} [options] Override http request option.
5857
6131
  * @throws {RequiredError}
5858
6132
  */
5859
6133
  getMotionGroupGlbModel(motionGroupModel: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<File, any>>;
5860
6134
  /**
5861
- * Returns the kinematics model (DH parameters) for the given motion group model. See [getMotionGroupModels](getMotionGroupModels) for supported motion group models.
6135
+ * Returns the kinematics model (DH parameters) for the given motion group model. See [getMotionGroupModels](#/operations/getMotionGroupModels) for supported motion group models.
5862
6136
  * @summary Get Kinematics
5863
- * @param {string} motionGroupModel Unique identifier for the model of a motion group, e.g., &#x60;UniversalRobots_UR10e&#x60;. Get the &#x60;model&#x60; of a configured motion group with [getOptimizerConfiguration](getOptimizerConfiguration).
6137
+ * @param {string} motionGroupModel Unique identifier for the model of a motion group, e.g., &#x60;UniversalRobots_UR10e&#x60;. Get the &#x60;model&#x60; of a configured motion group with [getOptimizerConfiguration](#/operations/getOptimizerConfiguration).
5864
6138
  * @param {*} [options] Override http request option.
5865
6139
  * @throws {RequiredError}
5866
6140
  */
@@ -5873,9 +6147,9 @@ declare class MotionGroupModelsApi extends BaseAPI {
5873
6147
  */
5874
6148
  getMotionGroupModels(options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<string[], any>>;
5875
6149
  /**
5876
- * Returns the USD scene model for the specified motion group model. See [getMotionGroupModels](getMotionGroupModels) for supported identifiers.
6150
+ * Returns the USD scene model for the specified motion group model. See [getMotionGroupModels](#/operations/getMotionGroupModels) for supported identifiers.
5877
6151
  * @summary Download USD Model
5878
- * @param {string} motionGroupModel Unique identifier for the model of a motion group, e.g., &#x60;UniversalRobots_UR10e&#x60;. Get the &#x60;model&#x60; of a configured motion group with [getOptimizerConfiguration](getOptimizerConfiguration).
6152
+ * @param {string} motionGroupModel Unique identifier for the model of a motion group, e.g., &#x60;UniversalRobots_UR10e&#x60;. Get the &#x60;model&#x60; of a configured motion group with [getOptimizerConfiguration](#/operations/getOptimizerConfiguration).
5879
6153
  * @param {*} [options] Override http request option.
5880
6154
  * @throws {RequiredError}
5881
6155
  */
@@ -6049,6 +6323,14 @@ declare class ProgramApi extends BaseAPI {
6049
6323
  * RobotConfigurationsApi - axios parameter creator
6050
6324
  */
6051
6325
  declare const RobotConfigurationsApiAxiosParamCreator: (configuration?: Configuration) => {
6326
+ /**
6327
+ * Returns all robot controller configurations that match the provided [ARP scan result](#/operations/getArpScan).
6328
+ * @summary Robot Controller Configurations
6329
+ * @param {RobotControllerConfigurationRequest} robotControllerConfigurationRequest
6330
+ * @param {*} [options] Override http request option.
6331
+ * @throws {RequiredError}
6332
+ */
6333
+ getControllerConfigFromArpScan: (robotControllerConfigurationRequest: RobotControllerConfigurationRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
6052
6334
  /**
6053
6335
  * Returns the identifiers of available robot configurations. A robot configuration represents a robot controller with one or more attached motion groups.
6054
6336
  * @summary List Robot Configurations
@@ -6061,6 +6343,14 @@ declare const RobotConfigurationsApiAxiosParamCreator: (configuration?: Configur
6061
6343
  * RobotConfigurationsApi - functional programming interface
6062
6344
  */
6063
6345
  declare const RobotConfigurationsApiFp: (configuration?: Configuration) => {
6346
+ /**
6347
+ * Returns all robot controller configurations that match the provided [ARP scan result](#/operations/getArpScan).
6348
+ * @summary Robot Controller Configurations
6349
+ * @param {RobotControllerConfigurationRequest} robotControllerConfigurationRequest
6350
+ * @param {*} [options] Override http request option.
6351
+ * @throws {RequiredError}
6352
+ */
6353
+ getControllerConfigFromArpScan(robotControllerConfigurationRequest: RobotControllerConfigurationRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<RobotController>>>;
6064
6354
  /**
6065
6355
  * Returns the identifiers of available robot configurations. A robot configuration represents a robot controller with one or more attached motion groups.
6066
6356
  * @summary List Robot Configurations
@@ -6073,6 +6363,14 @@ declare const RobotConfigurationsApiFp: (configuration?: Configuration) => {
6073
6363
  * RobotConfigurationsApi - factory interface
6074
6364
  */
6075
6365
  declare const RobotConfigurationsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
6366
+ /**
6367
+ * Returns all robot controller configurations that match the provided [ARP scan result](#/operations/getArpScan).
6368
+ * @summary Robot Controller Configurations
6369
+ * @param {RobotControllerConfigurationRequest} robotControllerConfigurationRequest
6370
+ * @param {*} [options] Override http request option.
6371
+ * @throws {RequiredError}
6372
+ */
6373
+ getControllerConfigFromArpScan(robotControllerConfigurationRequest: RobotControllerConfigurationRequest, options?: RawAxiosRequestConfig): AxiosPromise<Array<RobotController>>;
6076
6374
  /**
6077
6375
  * Returns the identifiers of available robot configurations. A robot configuration represents a robot controller with one or more attached motion groups.
6078
6376
  * @summary List Robot Configurations
@@ -6085,6 +6383,14 @@ declare const RobotConfigurationsApiFactory: (configuration?: Configuration, bas
6085
6383
  * RobotConfigurationsApi - object-oriented interface
6086
6384
  */
6087
6385
  declare class RobotConfigurationsApi extends BaseAPI {
6386
+ /**
6387
+ * Returns all robot controller configurations that match the provided [ARP scan result](#/operations/getArpScan).
6388
+ * @summary Robot Controller Configurations
6389
+ * @param {RobotControllerConfigurationRequest} robotControllerConfigurationRequest
6390
+ * @param {*} [options] Override http request option.
6391
+ * @throws {RequiredError}
6392
+ */
6393
+ getControllerConfigFromArpScan(robotControllerConfigurationRequest: RobotControllerConfigurationRequest, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<RobotController[], any>>;
6088
6394
  /**
6089
6395
  * Returns the identifiers of available robot configurations. A robot configuration represents a robot controller with one or more attached motion groups.
6090
6396
  * @summary List Robot Configurations
@@ -6961,7 +7267,7 @@ declare const StoreObjectApiAxiosParamCreator: (configuration?: Configuration) =
6961
7267
  */
6962
7268
  listAllObjectKeys: (cell: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
6963
7269
  /**
6964
- * Store any data as an object. Using a key which already contains an object will override the previously stored object. Use [getObjectMetadata](getObjectMetadata) to verify that the key does not contain objects. #### Optional Specify metadata as a dictionary with names and values.
7270
+ * Store any data as an object. Using a key which already contains an object will override the previously stored object. Use [getObjectMetadata](#/operations/getObjectMetadata) to verify that the key does not contain objects. #### Optional Specify metadata as a dictionary with names and values.
6965
7271
  * @summary Store Object
6966
7272
  * @param {string} cell Unique identifier addressing a cell in all API calls.
6967
7273
  * @param {string} key
@@ -7022,7 +7328,7 @@ declare const StoreObjectApiFp: (configuration?: Configuration) => {
7022
7328
  */
7023
7329
  listAllObjectKeys(cell: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<string>>>;
7024
7330
  /**
7025
- * Store any data as an object. Using a key which already contains an object will override the previously stored object. Use [getObjectMetadata](getObjectMetadata) to verify that the key does not contain objects. #### Optional Specify metadata as a dictionary with names and values.
7331
+ * Store any data as an object. Using a key which already contains an object will override the previously stored object. Use [getObjectMetadata](#/operations/getObjectMetadata) to verify that the key does not contain objects. #### Optional Specify metadata as a dictionary with names and values.
7026
7332
  * @summary Store Object
7027
7333
  * @param {string} cell Unique identifier addressing a cell in all API calls.
7028
7334
  * @param {string} key
@@ -7083,7 +7389,7 @@ declare const StoreObjectApiFactory: (configuration?: Configuration, basePath?:
7083
7389
  */
7084
7390
  listAllObjectKeys(cell: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<string>>;
7085
7391
  /**
7086
- * Store any data as an object. Using a key which already contains an object will override the previously stored object. Use [getObjectMetadata](getObjectMetadata) to verify that the key does not contain objects. #### Optional Specify metadata as a dictionary with names and values.
7392
+ * Store any data as an object. Using a key which already contains an object will override the previously stored object. Use [getObjectMetadata](#/operations/getObjectMetadata) to verify that the key does not contain objects. #### Optional Specify metadata as a dictionary with names and values.
7087
7393
  * @summary Store Object
7088
7394
  * @param {string} cell Unique identifier addressing a cell in all API calls.
7089
7395
  * @param {string} key
@@ -7144,7 +7450,7 @@ declare class StoreObjectApi extends BaseAPI {
7144
7450
  */
7145
7451
  listAllObjectKeys(cell: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<string[], any>>;
7146
7452
  /**
7147
- * Store any data as an object. Using a key which already contains an object will override the previously stored object. Use [getObjectMetadata](getObjectMetadata) to verify that the key does not contain objects. #### Optional Specify metadata as a dictionary with names and values.
7453
+ * Store any data as an object. Using a key which already contains an object will override the previously stored object. Use [getObjectMetadata](#/operations/getObjectMetadata) to verify that the key does not contain objects. #### Optional Specify metadata as a dictionary with names and values.
7148
7454
  * @summary Store Object
7149
7455
  * @param {string} cell Unique identifier addressing a cell in all API calls.
7150
7456
  * @param {string} key
@@ -7250,7 +7556,7 @@ declare const SystemApiAxiosParamCreator: (configuration?: Configuration) => {
7250
7556
  */
7251
7557
  restoreConfiguration: (body: File, resources?: Array<string>, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
7252
7558
  /**
7253
- * Update the Wandelbots NOVA version and all attached services. Sending this API Request will trigger an update of all NOVA services that are part of a cell. Previous cells and cell configurations will remain on the instance. If the update fails, the previous Wandelbots NOVA version is restored.
7559
+ * Update the Wandelbots NOVA version and all attached services. Sending this API Request will trigger an update of all NOVA services that are part of a cell. Previous cells and cell configurations will remain on the instance. If the update fails, the previous Wandelbots NOVA version is restored. System updates only apply to cells without an explicit chart version. Pinned versions are always preserved; setting `update_cells=false` pins unversioned cells to the current system version before updating.
7254
7560
  * @summary Update Wandelbots NOVA version
7255
7561
  * @param {UpdateNovaVersionRequest} updateNovaVersionRequest
7256
7562
  * @param {*} [options] Override http request option.
@@ -7351,7 +7657,7 @@ declare const SystemApiFp: (configuration?: Configuration) => {
7351
7657
  */
7352
7658
  restoreConfiguration(body: File, resources?: Array<string>, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
7353
7659
  /**
7354
- * Update the Wandelbots NOVA version and all attached services. Sending this API Request will trigger an update of all NOVA services that are part of a cell. Previous cells and cell configurations will remain on the instance. If the update fails, the previous Wandelbots NOVA version is restored.
7660
+ * Update the Wandelbots NOVA version and all attached services. Sending this API Request will trigger an update of all NOVA services that are part of a cell. Previous cells and cell configurations will remain on the instance. If the update fails, the previous Wandelbots NOVA version is restored. System updates only apply to cells without an explicit chart version. Pinned versions are always preserved; setting `update_cells=false` pins unversioned cells to the current system version before updating.
7355
7661
  * @summary Update Wandelbots NOVA version
7356
7662
  * @param {UpdateNovaVersionRequest} updateNovaVersionRequest
7357
7663
  * @param {*} [options] Override http request option.
@@ -7452,7 +7758,7 @@ declare const SystemApiFactory: (configuration?: Configuration, basePath?: strin
7452
7758
  */
7453
7759
  restoreConfiguration(body: File, resources?: Array<string>, options?: RawAxiosRequestConfig): AxiosPromise<void>;
7454
7760
  /**
7455
- * Update the Wandelbots NOVA version and all attached services. Sending this API Request will trigger an update of all NOVA services that are part of a cell. Previous cells and cell configurations will remain on the instance. If the update fails, the previous Wandelbots NOVA version is restored.
7761
+ * Update the Wandelbots NOVA version and all attached services. Sending this API Request will trigger an update of all NOVA services that are part of a cell. Previous cells and cell configurations will remain on the instance. If the update fails, the previous Wandelbots NOVA version is restored. System updates only apply to cells without an explicit chart version. Pinned versions are always preserved; setting `update_cells=false` pins unversioned cells to the current system version before updating.
7456
7762
  * @summary Update Wandelbots NOVA version
7457
7763
  * @param {UpdateNovaVersionRequest} updateNovaVersionRequest
7458
7764
  * @param {*} [options] Override http request option.
@@ -7553,7 +7859,7 @@ declare class SystemApi extends BaseAPI {
7553
7859
  */
7554
7860
  restoreConfiguration(body: File, resources?: Array<string>, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
7555
7861
  /**
7556
- * Update the Wandelbots NOVA version and all attached services. Sending this API Request will trigger an update of all NOVA services that are part of a cell. Previous cells and cell configurations will remain on the instance. If the update fails, the previous Wandelbots NOVA version is restored.
7862
+ * Update the Wandelbots NOVA version and all attached services. Sending this API Request will trigger an update of all NOVA services that are part of a cell. Previous cells and cell configurations will remain on the instance. If the update fails, the previous Wandelbots NOVA version is restored. System updates only apply to cells without an explicit chart version. Pinned versions are always preserved; setting `update_cells=false` pins unversioned cells to the current system version before updating.
7557
7863
  * @summary Update Wandelbots NOVA version
7558
7864
  * @param {UpdateNovaVersionRequest} updateNovaVersionRequest
7559
7865
  * @param {*} [options] Override http request option.
@@ -7566,7 +7872,7 @@ declare class SystemApi extends BaseAPI {
7566
7872
  */
7567
7873
  declare const TrajectoryCachingApiAxiosParamCreator: (configuration?: Configuration) => {
7568
7874
  /**
7569
- * Loads and validates the data of a trajectory into the execution cache, rendering the trajectory executable. <!-- theme: info --> > #### NOTE > > Using the trajectory cache is an optional performance optimization. It is not necessary to use the cache to execute trajectories. The response contains the result of the validation of the trajectory. Validation can lead to three different results: - Fully valid: The whole trajectory can be executed from start to end. The response will contain an unique identifier which is used to move the robot. - Partially valid: Only parts of the trajectory can be executed. The response will contain an unique identifier to move the robot and information about the failure for the part that is not executable. - Invalid: The trajectory can not be executed. The response will tell you the reason of failure. If the trajectory is at least partially valid, the parts of the trajectory that are valid can be executed using the [executeTrajectory](executeTrajectory) endpoint. The workflow is as follows: - Generate a trajectory with [planTrajectory](planTrajectory) or your own motion planner, - Send the trajectory to this endpoint to validate it and get a unique identifier for it, - The unique identifier will appear in the list of available trajectories, see [listTrajectories](listTrajectories) endpoint, if it is at least partially executable. - Execute your trajectory using the [executeTrajectory](executeTrajectory) endpoint.
7875
+ * Loads and validates the data of a trajectory into the execution cache, rendering the trajectory executable. <!-- theme: info --> > #### NOTE > > Using the trajectory cache is an optional performance optimization. It is not necessary to use the cache to execute trajectories. The response contains the result of the validation of the trajectory. Validation can lead to three different results: - Fully valid: The whole trajectory can be executed from start to end. The response will contain an unique identifier which is used to move the robot. - Partially valid: Only parts of the trajectory can be executed. The response will contain an unique identifier to move the robot and information about the failure for the part that is not executable. - Invalid: The trajectory can not be executed. The response will tell you the reason of failure. If the trajectory is at least partially valid, the parts of the trajectory that are valid can be executed using the [executeTrajectory](#/operations/executeTrajectory) endpoint. The workflow is as follows: - Generate a trajectory with [planTrajectory](#/operations/planTrajectory) or your own motion planner, - Send the trajectory to this endpoint to validate it and get a unique identifier for it, - The unique identifier will appear in the list of available trajectories, see [listTrajectories](#/operations/listTrajectories) endpoint, if it is at least partially executable. - Execute your trajectory using the [executeTrajectory](#/operations/executeTrajectory) endpoint.
7570
7876
  * @summary Add Trajectory
7571
7877
  * @param {string} cell Unique identifier addressing a cell in all API calls.
7572
7878
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -7585,7 +7891,7 @@ declare const TrajectoryCachingApiAxiosParamCreator: (configuration?: Configurat
7585
7891
  */
7586
7892
  clearTrajectories: (cell: string, controller: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
7587
7893
  /**
7588
- * Delete a previously created trajectory from cache. Use [listTrajectories](listTrajectories) to list all cached trajectories. Trajectories are removed automatically if the motion group or the corresponding controller is disconnected.
7894
+ * Delete a previously created trajectory from cache. Use [listTrajectories](#/operations/listTrajectories) to list all cached trajectories. Trajectories are removed automatically if the motion group or the corresponding controller is disconnected.
7589
7895
  * @summary Delete Trajectory
7590
7896
  * @param {string} cell Unique identifier addressing a cell in all API calls.
7591
7897
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -7595,7 +7901,7 @@ declare const TrajectoryCachingApiAxiosParamCreator: (configuration?: Configurat
7595
7901
  */
7596
7902
  deleteTrajectory: (cell: string, controller: string, trajectory: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
7597
7903
  /**
7598
- * Get a previously created trajectory from cache. Use [listTrajectories](listTrajectories) to list all cached trajectories.
7904
+ * Get a previously created trajectory from cache. Use [listTrajectories](#/operations/listTrajectories) to list all cached trajectories.
7599
7905
  * @summary Get Trajectory
7600
7906
  * @param {string} cell Unique identifier addressing a cell in all API calls.
7601
7907
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -7605,7 +7911,7 @@ declare const TrajectoryCachingApiAxiosParamCreator: (configuration?: Configurat
7605
7911
  */
7606
7912
  getTrajectory: (cell: string, controller: string, trajectory: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
7607
7913
  /**
7608
- * List currently cached trajectories. Use [addTrajectory](addTrajectory) to add a new trajectory. Adding trajectories is necessary to execute them. Trajectories are removed if the corresponding motion group or controller disconnects.
7914
+ * List currently cached trajectories. Use [addTrajectory](#/operations/addTrajectory) to add a new trajectory. Adding trajectories is necessary to execute them. Trajectories are removed if the corresponding motion group or controller disconnects.
7609
7915
  * @summary List Trajectories
7610
7916
  * @param {string} cell Unique identifier addressing a cell in all API calls.
7611
7917
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -7619,7 +7925,7 @@ declare const TrajectoryCachingApiAxiosParamCreator: (configuration?: Configurat
7619
7925
  */
7620
7926
  declare const TrajectoryCachingApiFp: (configuration?: Configuration) => {
7621
7927
  /**
7622
- * Loads and validates the data of a trajectory into the execution cache, rendering the trajectory executable. <!-- theme: info --> > #### NOTE > > Using the trajectory cache is an optional performance optimization. It is not necessary to use the cache to execute trajectories. The response contains the result of the validation of the trajectory. Validation can lead to three different results: - Fully valid: The whole trajectory can be executed from start to end. The response will contain an unique identifier which is used to move the robot. - Partially valid: Only parts of the trajectory can be executed. The response will contain an unique identifier to move the robot and information about the failure for the part that is not executable. - Invalid: The trajectory can not be executed. The response will tell you the reason of failure. If the trajectory is at least partially valid, the parts of the trajectory that are valid can be executed using the [executeTrajectory](executeTrajectory) endpoint. The workflow is as follows: - Generate a trajectory with [planTrajectory](planTrajectory) or your own motion planner, - Send the trajectory to this endpoint to validate it and get a unique identifier for it, - The unique identifier will appear in the list of available trajectories, see [listTrajectories](listTrajectories) endpoint, if it is at least partially executable. - Execute your trajectory using the [executeTrajectory](executeTrajectory) endpoint.
7928
+ * Loads and validates the data of a trajectory into the execution cache, rendering the trajectory executable. <!-- theme: info --> > #### NOTE > > Using the trajectory cache is an optional performance optimization. It is not necessary to use the cache to execute trajectories. The response contains the result of the validation of the trajectory. Validation can lead to three different results: - Fully valid: The whole trajectory can be executed from start to end. The response will contain an unique identifier which is used to move the robot. - Partially valid: Only parts of the trajectory can be executed. The response will contain an unique identifier to move the robot and information about the failure for the part that is not executable. - Invalid: The trajectory can not be executed. The response will tell you the reason of failure. If the trajectory is at least partially valid, the parts of the trajectory that are valid can be executed using the [executeTrajectory](#/operations/executeTrajectory) endpoint. The workflow is as follows: - Generate a trajectory with [planTrajectory](#/operations/planTrajectory) or your own motion planner, - Send the trajectory to this endpoint to validate it and get a unique identifier for it, - The unique identifier will appear in the list of available trajectories, see [listTrajectories](#/operations/listTrajectories) endpoint, if it is at least partially executable. - Execute your trajectory using the [executeTrajectory](#/operations/executeTrajectory) endpoint.
7623
7929
  * @summary Add Trajectory
7624
7930
  * @param {string} cell Unique identifier addressing a cell in all API calls.
7625
7931
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -7638,7 +7944,7 @@ declare const TrajectoryCachingApiFp: (configuration?: Configuration) => {
7638
7944
  */
7639
7945
  clearTrajectories(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
7640
7946
  /**
7641
- * Delete a previously created trajectory from cache. Use [listTrajectories](listTrajectories) to list all cached trajectories. Trajectories are removed automatically if the motion group or the corresponding controller is disconnected.
7947
+ * Delete a previously created trajectory from cache. Use [listTrajectories](#/operations/listTrajectories) to list all cached trajectories. Trajectories are removed automatically if the motion group or the corresponding controller is disconnected.
7642
7948
  * @summary Delete Trajectory
7643
7949
  * @param {string} cell Unique identifier addressing a cell in all API calls.
7644
7950
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -7648,7 +7954,7 @@ declare const TrajectoryCachingApiFp: (configuration?: Configuration) => {
7648
7954
  */
7649
7955
  deleteTrajectory(cell: string, controller: string, trajectory: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
7650
7956
  /**
7651
- * Get a previously created trajectory from cache. Use [listTrajectories](listTrajectories) to list all cached trajectories.
7957
+ * Get a previously created trajectory from cache. Use [listTrajectories](#/operations/listTrajectories) to list all cached trajectories.
7652
7958
  * @summary Get Trajectory
7653
7959
  * @param {string} cell Unique identifier addressing a cell in all API calls.
7654
7960
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -7658,7 +7964,7 @@ declare const TrajectoryCachingApiFp: (configuration?: Configuration) => {
7658
7964
  */
7659
7965
  getTrajectory(cell: string, controller: string, trajectory: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetTrajectoryResponse>>;
7660
7966
  /**
7661
- * List currently cached trajectories. Use [addTrajectory](addTrajectory) to add a new trajectory. Adding trajectories is necessary to execute them. Trajectories are removed if the corresponding motion group or controller disconnects.
7967
+ * List currently cached trajectories. Use [addTrajectory](#/operations/addTrajectory) to add a new trajectory. Adding trajectories is necessary to execute them. Trajectories are removed if the corresponding motion group or controller disconnects.
7662
7968
  * @summary List Trajectories
7663
7969
  * @param {string} cell Unique identifier addressing a cell in all API calls.
7664
7970
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -7672,7 +7978,7 @@ declare const TrajectoryCachingApiFp: (configuration?: Configuration) => {
7672
7978
  */
7673
7979
  declare const TrajectoryCachingApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
7674
7980
  /**
7675
- * Loads and validates the data of a trajectory into the execution cache, rendering the trajectory executable. <!-- theme: info --> > #### NOTE > > Using the trajectory cache is an optional performance optimization. It is not necessary to use the cache to execute trajectories. The response contains the result of the validation of the trajectory. Validation can lead to three different results: - Fully valid: The whole trajectory can be executed from start to end. The response will contain an unique identifier which is used to move the robot. - Partially valid: Only parts of the trajectory can be executed. The response will contain an unique identifier to move the robot and information about the failure for the part that is not executable. - Invalid: The trajectory can not be executed. The response will tell you the reason of failure. If the trajectory is at least partially valid, the parts of the trajectory that are valid can be executed using the [executeTrajectory](executeTrajectory) endpoint. The workflow is as follows: - Generate a trajectory with [planTrajectory](planTrajectory) or your own motion planner, - Send the trajectory to this endpoint to validate it and get a unique identifier for it, - The unique identifier will appear in the list of available trajectories, see [listTrajectories](listTrajectories) endpoint, if it is at least partially executable. - Execute your trajectory using the [executeTrajectory](executeTrajectory) endpoint.
7981
+ * Loads and validates the data of a trajectory into the execution cache, rendering the trajectory executable. <!-- theme: info --> > #### NOTE > > Using the trajectory cache is an optional performance optimization. It is not necessary to use the cache to execute trajectories. The response contains the result of the validation of the trajectory. Validation can lead to three different results: - Fully valid: The whole trajectory can be executed from start to end. The response will contain an unique identifier which is used to move the robot. - Partially valid: Only parts of the trajectory can be executed. The response will contain an unique identifier to move the robot and information about the failure for the part that is not executable. - Invalid: The trajectory can not be executed. The response will tell you the reason of failure. If the trajectory is at least partially valid, the parts of the trajectory that are valid can be executed using the [executeTrajectory](#/operations/executeTrajectory) endpoint. The workflow is as follows: - Generate a trajectory with [planTrajectory](#/operations/planTrajectory) or your own motion planner, - Send the trajectory to this endpoint to validate it and get a unique identifier for it, - The unique identifier will appear in the list of available trajectories, see [listTrajectories](#/operations/listTrajectories) endpoint, if it is at least partially executable. - Execute your trajectory using the [executeTrajectory](#/operations/executeTrajectory) endpoint.
7676
7982
  * @summary Add Trajectory
7677
7983
  * @param {string} cell Unique identifier addressing a cell in all API calls.
7678
7984
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -7691,7 +7997,7 @@ declare const TrajectoryCachingApiFactory: (configuration?: Configuration, baseP
7691
7997
  */
7692
7998
  clearTrajectories(cell: string, controller: string, options?: RawAxiosRequestConfig): AxiosPromise<void>;
7693
7999
  /**
7694
- * Delete a previously created trajectory from cache. Use [listTrajectories](listTrajectories) to list all cached trajectories. Trajectories are removed automatically if the motion group or the corresponding controller is disconnected.
8000
+ * Delete a previously created trajectory from cache. Use [listTrajectories](#/operations/listTrajectories) to list all cached trajectories. Trajectories are removed automatically if the motion group or the corresponding controller is disconnected.
7695
8001
  * @summary Delete Trajectory
7696
8002
  * @param {string} cell Unique identifier addressing a cell in all API calls.
7697
8003
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -7701,7 +8007,7 @@ declare const TrajectoryCachingApiFactory: (configuration?: Configuration, baseP
7701
8007
  */
7702
8008
  deleteTrajectory(cell: string, controller: string, trajectory: string, options?: RawAxiosRequestConfig): AxiosPromise<void>;
7703
8009
  /**
7704
- * Get a previously created trajectory from cache. Use [listTrajectories](listTrajectories) to list all cached trajectories.
8010
+ * Get a previously created trajectory from cache. Use [listTrajectories](#/operations/listTrajectories) to list all cached trajectories.
7705
8011
  * @summary Get Trajectory
7706
8012
  * @param {string} cell Unique identifier addressing a cell in all API calls.
7707
8013
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -7711,7 +8017,7 @@ declare const TrajectoryCachingApiFactory: (configuration?: Configuration, baseP
7711
8017
  */
7712
8018
  getTrajectory(cell: string, controller: string, trajectory: string, options?: RawAxiosRequestConfig): AxiosPromise<GetTrajectoryResponse>;
7713
8019
  /**
7714
- * List currently cached trajectories. Use [addTrajectory](addTrajectory) to add a new trajectory. Adding trajectories is necessary to execute them. Trajectories are removed if the corresponding motion group or controller disconnects.
8020
+ * List currently cached trajectories. Use [addTrajectory](#/operations/addTrajectory) to add a new trajectory. Adding trajectories is necessary to execute them. Trajectories are removed if the corresponding motion group or controller disconnects.
7715
8021
  * @summary List Trajectories
7716
8022
  * @param {string} cell Unique identifier addressing a cell in all API calls.
7717
8023
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -7725,7 +8031,7 @@ declare const TrajectoryCachingApiFactory: (configuration?: Configuration, baseP
7725
8031
  */
7726
8032
  declare class TrajectoryCachingApi extends BaseAPI {
7727
8033
  /**
7728
- * Loads and validates the data of a trajectory into the execution cache, rendering the trajectory executable. <!-- theme: info --> > #### NOTE > > Using the trajectory cache is an optional performance optimization. It is not necessary to use the cache to execute trajectories. The response contains the result of the validation of the trajectory. Validation can lead to three different results: - Fully valid: The whole trajectory can be executed from start to end. The response will contain an unique identifier which is used to move the robot. - Partially valid: Only parts of the trajectory can be executed. The response will contain an unique identifier to move the robot and information about the failure for the part that is not executable. - Invalid: The trajectory can not be executed. The response will tell you the reason of failure. If the trajectory is at least partially valid, the parts of the trajectory that are valid can be executed using the [executeTrajectory](executeTrajectory) endpoint. The workflow is as follows: - Generate a trajectory with [planTrajectory](planTrajectory) or your own motion planner, - Send the trajectory to this endpoint to validate it and get a unique identifier for it, - The unique identifier will appear in the list of available trajectories, see [listTrajectories](listTrajectories) endpoint, if it is at least partially executable. - Execute your trajectory using the [executeTrajectory](executeTrajectory) endpoint.
8034
+ * Loads and validates the data of a trajectory into the execution cache, rendering the trajectory executable. <!-- theme: info --> > #### NOTE > > Using the trajectory cache is an optional performance optimization. It is not necessary to use the cache to execute trajectories. The response contains the result of the validation of the trajectory. Validation can lead to three different results: - Fully valid: The whole trajectory can be executed from start to end. The response will contain an unique identifier which is used to move the robot. - Partially valid: Only parts of the trajectory can be executed. The response will contain an unique identifier to move the robot and information about the failure for the part that is not executable. - Invalid: The trajectory can not be executed. The response will tell you the reason of failure. If the trajectory is at least partially valid, the parts of the trajectory that are valid can be executed using the [executeTrajectory](#/operations/executeTrajectory) endpoint. The workflow is as follows: - Generate a trajectory with [planTrajectory](#/operations/planTrajectory) or your own motion planner, - Send the trajectory to this endpoint to validate it and get a unique identifier for it, - The unique identifier will appear in the list of available trajectories, see [listTrajectories](#/operations/listTrajectories) endpoint, if it is at least partially executable. - Execute your trajectory using the [executeTrajectory](#/operations/executeTrajectory) endpoint.
7729
8035
  * @summary Add Trajectory
7730
8036
  * @param {string} cell Unique identifier addressing a cell in all API calls.
7731
8037
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -7744,7 +8050,7 @@ declare class TrajectoryCachingApi extends BaseAPI {
7744
8050
  */
7745
8051
  clearTrajectories(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
7746
8052
  /**
7747
- * Delete a previously created trajectory from cache. Use [listTrajectories](listTrajectories) to list all cached trajectories. Trajectories are removed automatically if the motion group or the corresponding controller is disconnected.
8053
+ * Delete a previously created trajectory from cache. Use [listTrajectories](#/operations/listTrajectories) to list all cached trajectories. Trajectories are removed automatically if the motion group or the corresponding controller is disconnected.
7748
8054
  * @summary Delete Trajectory
7749
8055
  * @param {string} cell Unique identifier addressing a cell in all API calls.
7750
8056
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -7754,7 +8060,7 @@ declare class TrajectoryCachingApi extends BaseAPI {
7754
8060
  */
7755
8061
  deleteTrajectory(cell: string, controller: string, trajectory: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
7756
8062
  /**
7757
- * Get a previously created trajectory from cache. Use [listTrajectories](listTrajectories) to list all cached trajectories.
8063
+ * Get a previously created trajectory from cache. Use [listTrajectories](#/operations/listTrajectories) to list all cached trajectories.
7758
8064
  * @summary Get Trajectory
7759
8065
  * @param {string} cell Unique identifier addressing a cell in all API calls.
7760
8066
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -7764,7 +8070,7 @@ declare class TrajectoryCachingApi extends BaseAPI {
7764
8070
  */
7765
8071
  getTrajectory(cell: string, controller: string, trajectory: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<GetTrajectoryResponse, any>>;
7766
8072
  /**
7767
- * List currently cached trajectories. Use [addTrajectory](addTrajectory) to add a new trajectory. Adding trajectories is necessary to execute them. Trajectories are removed if the corresponding motion group or controller disconnects.
8073
+ * List currently cached trajectories. Use [addTrajectory](#/operations/addTrajectory) to add a new trajectory. Adding trajectories is necessary to execute them. Trajectories are removed if the corresponding motion group or controller disconnects.
7768
8074
  * @summary List Trajectories
7769
8075
  * @param {string} cell Unique identifier addressing a cell in all API calls.
7770
8076
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -7778,7 +8084,7 @@ declare class TrajectoryCachingApi extends BaseAPI {
7778
8084
  */
7779
8085
  declare const TrajectoryExecutionApiAxiosParamCreator: (configuration?: Configuration) => {
7780
8086
  /**
7781
- * <!-- theme: success --> > Websocket endpoint Provides execution control over a previously [planned trajectory](planTrajectory). Enables the caller to attach input/output actions to the trajectory. ### Movement behavior | Virtual controller | Physical controller | |------------------|-------------------| | Desired joint configurations are commanded to each motion group and **applied immediately** | Move to desired **actual joint configuration**, **if possible** | ### Concept of location - The location or path parameter specifies the exact position along a trajectory. - The location is a scalar value that ranges from 0 to `n`, where `n` denotes the number of motion commands, or trajectory segments, e.g., line, p2p, etc. See [planTrajectory](planTrajectory). - Each integer value of the location corresponds to one motion command, e.g., 3.0 to 3.999 could be a line. ### Preconditions - The motion group\'s control mode is not claimed by any other endpoint. - The motion group\'s joint position are at start location specified with `InitializeMovementRequest`. - Use [executeToTrajectory](executeToTrajectory) to move the robot to the start location. ### Requests #### 1. Send `InitializeMovementRequest` to lock the trajectory to this connection The following actions are executed: - Sets robot controller mode to control mode, - Sets start location of the execution Keep in mind that only a single trajectory can be locked to a websocket connection at a time. Pausing the current movement enables you to send another `InitializeMovementRequest` to execute another trajectory on the same connection. #### 2. Send `StartMovementRequest` to start the movement Sets direction of movement, default is forward. #### **Optional** - To pause, send `PauseMovementRequest` before the movement has reached its end location. - Change the movement\'s velocity with `PlaybackSpeedRequest` after initializing the movement with `InitializeMovementRequest`. ### Responses To monitor the state of the movement, listen to the [state stream](streamMotionGroupState). The state is published via nats as well. Field `execute` in the `MotionGroupState` indicates whether a movement is ongoing and carries execution details. Each request has a corresponding acknowledgment response. They signal success or failure of the request. Especially for `PauseMovementResponse`, it does not signal the end of the movement. Additionally, `MovementError` messages can be sent in case of unexpected errors during the execution, e.g., controller disconnects during movement. ### Tips and Tricks - A movement can be paused and resumed by sending `PauseMovementRequest` and `StartMovementRequest`. - Send `PlaybackSpeedRequest` before `StartMovementRequest` to reduce the velocity of the movement before it starts. - Send `PlaybackSpeedRequest` repeatedly to implement a slider. The velocity of the motion group can be adjusted with each controller step. Therefore, if your app needs a slider-like UI to alter the velocity of a currently running movement, you can send `PlaybackSpeedRequest` with different speed values repeatedly during the movement. - A closed trajectory (end and start joint position are equal) can be repeated by sending `StartMovementRequest` after the movement has finished.
8087
+ * <!-- theme: success --> > Websocket endpoint Provides execution control over a previously [planned trajectory](#/operations/planTrajectory). Enables the caller to attach input/output actions to the trajectory. ### Movement behavior | Virtual controller | Physical controller | |------------------|-------------------| | Desired joint configurations are commanded to each motion group and **applied immediately** | Move to desired **actual joint configuration**, **if possible** | ### Concept of location - The location or path parameter specifies the exact position along a trajectory. - The location is a scalar value that ranges from 0 to `n`, where `n` denotes the number of motion commands, or trajectory segments, e.g., line, p2p, etc. See [planTrajectory](#/operations/planTrajectory). - Each integer value of the location corresponds to one motion command, e.g., 3.0 to 3.999 could be a line. ### Preconditions - The motion group\'s control mode is not claimed by any other endpoint. - The motion group\'s joint position are at start location specified with `InitializeMovementRequest`. - Use [executeToTrajectory](#/operations/executeToTrajectory) to move the robot to the start location. ### Requests #### 1. Send `InitializeMovementRequest` to lock the trajectory to this connection The following actions are executed: - Sets robot controller mode to control mode, - Sets start location of the execution Keep in mind that only a single trajectory can be locked to a websocket connection at a time. Pausing the current movement enables you to send another `InitializeMovementRequest` to execute another trajectory on the same connection. #### 2. Send `StartMovementRequest` to start the movement Sets direction of movement, default is forward. #### **Optional** - To pause, send `PauseMovementRequest` before the movement has reached its end location. - Change the movement\'s velocity with `PlaybackSpeedRequest` after initializing the movement with `InitializeMovementRequest`. ### Responses To monitor the state of the movement, listen to the [state stream](#/operations/streamMotionGroupState). The state is published via nats as well. Field `execute` in the `MotionGroupState` indicates whether a movement is ongoing and carries execution details. Each request has a corresponding acknowledgment response. They signal success or failure of the request. Especially for `PauseMovementResponse`, it does not signal the end of the movement. Additionally, `MovementError` messages can be sent in case of unexpected errors during the execution, e.g., controller disconnects during movement. ### Tips and Tricks - A movement can be paused and resumed by sending `PauseMovementRequest` and `StartMovementRequest`. - Send `PlaybackSpeedRequest` before `StartMovementRequest` to reduce the velocity of the movement before it starts. - Send `PlaybackSpeedRequest` repeatedly to implement a slider. The velocity of the motion group can be adjusted with each controller step. Therefore, if your app needs a slider-like UI to alter the velocity of a currently running movement, you can send `PlaybackSpeedRequest` with different speed values repeatedly during the movement. - A closed trajectory (end and start joint position are equal) can be repeated by sending `StartMovementRequest` after the movement has finished.
7782
8088
  * @summary Execute Trajectory
7783
8089
  * @param {string} cell Unique identifier addressing a cell in all API calls.
7784
8090
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -7793,7 +8099,7 @@ declare const TrajectoryExecutionApiAxiosParamCreator: (configuration?: Configur
7793
8099
  */
7794
8100
  declare const TrajectoryExecutionApiFp: (configuration?: Configuration) => {
7795
8101
  /**
7796
- * <!-- theme: success --> > Websocket endpoint Provides execution control over a previously [planned trajectory](planTrajectory). Enables the caller to attach input/output actions to the trajectory. ### Movement behavior | Virtual controller | Physical controller | |------------------|-------------------| | Desired joint configurations are commanded to each motion group and **applied immediately** | Move to desired **actual joint configuration**, **if possible** | ### Concept of location - The location or path parameter specifies the exact position along a trajectory. - The location is a scalar value that ranges from 0 to `n`, where `n` denotes the number of motion commands, or trajectory segments, e.g., line, p2p, etc. See [planTrajectory](planTrajectory). - Each integer value of the location corresponds to one motion command, e.g., 3.0 to 3.999 could be a line. ### Preconditions - The motion group\'s control mode is not claimed by any other endpoint. - The motion group\'s joint position are at start location specified with `InitializeMovementRequest`. - Use [executeToTrajectory](executeToTrajectory) to move the robot to the start location. ### Requests #### 1. Send `InitializeMovementRequest` to lock the trajectory to this connection The following actions are executed: - Sets robot controller mode to control mode, - Sets start location of the execution Keep in mind that only a single trajectory can be locked to a websocket connection at a time. Pausing the current movement enables you to send another `InitializeMovementRequest` to execute another trajectory on the same connection. #### 2. Send `StartMovementRequest` to start the movement Sets direction of movement, default is forward. #### **Optional** - To pause, send `PauseMovementRequest` before the movement has reached its end location. - Change the movement\'s velocity with `PlaybackSpeedRequest` after initializing the movement with `InitializeMovementRequest`. ### Responses To monitor the state of the movement, listen to the [state stream](streamMotionGroupState). The state is published via nats as well. Field `execute` in the `MotionGroupState` indicates whether a movement is ongoing and carries execution details. Each request has a corresponding acknowledgment response. They signal success or failure of the request. Especially for `PauseMovementResponse`, it does not signal the end of the movement. Additionally, `MovementError` messages can be sent in case of unexpected errors during the execution, e.g., controller disconnects during movement. ### Tips and Tricks - A movement can be paused and resumed by sending `PauseMovementRequest` and `StartMovementRequest`. - Send `PlaybackSpeedRequest` before `StartMovementRequest` to reduce the velocity of the movement before it starts. - Send `PlaybackSpeedRequest` repeatedly to implement a slider. The velocity of the motion group can be adjusted with each controller step. Therefore, if your app needs a slider-like UI to alter the velocity of a currently running movement, you can send `PlaybackSpeedRequest` with different speed values repeatedly during the movement. - A closed trajectory (end and start joint position are equal) can be repeated by sending `StartMovementRequest` after the movement has finished.
8102
+ * <!-- theme: success --> > Websocket endpoint Provides execution control over a previously [planned trajectory](#/operations/planTrajectory). Enables the caller to attach input/output actions to the trajectory. ### Movement behavior | Virtual controller | Physical controller | |------------------|-------------------| | Desired joint configurations are commanded to each motion group and **applied immediately** | Move to desired **actual joint configuration**, **if possible** | ### Concept of location - The location or path parameter specifies the exact position along a trajectory. - The location is a scalar value that ranges from 0 to `n`, where `n` denotes the number of motion commands, or trajectory segments, e.g., line, p2p, etc. See [planTrajectory](#/operations/planTrajectory). - Each integer value of the location corresponds to one motion command, e.g., 3.0 to 3.999 could be a line. ### Preconditions - The motion group\'s control mode is not claimed by any other endpoint. - The motion group\'s joint position are at start location specified with `InitializeMovementRequest`. - Use [executeToTrajectory](#/operations/executeToTrajectory) to move the robot to the start location. ### Requests #### 1. Send `InitializeMovementRequest` to lock the trajectory to this connection The following actions are executed: - Sets robot controller mode to control mode, - Sets start location of the execution Keep in mind that only a single trajectory can be locked to a websocket connection at a time. Pausing the current movement enables you to send another `InitializeMovementRequest` to execute another trajectory on the same connection. #### 2. Send `StartMovementRequest` to start the movement Sets direction of movement, default is forward. #### **Optional** - To pause, send `PauseMovementRequest` before the movement has reached its end location. - Change the movement\'s velocity with `PlaybackSpeedRequest` after initializing the movement with `InitializeMovementRequest`. ### Responses To monitor the state of the movement, listen to the [state stream](#/operations/streamMotionGroupState). The state is published via nats as well. Field `execute` in the `MotionGroupState` indicates whether a movement is ongoing and carries execution details. Each request has a corresponding acknowledgment response. They signal success or failure of the request. Especially for `PauseMovementResponse`, it does not signal the end of the movement. Additionally, `MovementError` messages can be sent in case of unexpected errors during the execution, e.g., controller disconnects during movement. ### Tips and Tricks - A movement can be paused and resumed by sending `PauseMovementRequest` and `StartMovementRequest`. - Send `PlaybackSpeedRequest` before `StartMovementRequest` to reduce the velocity of the movement before it starts. - Send `PlaybackSpeedRequest` repeatedly to implement a slider. The velocity of the motion group can be adjusted with each controller step. Therefore, if your app needs a slider-like UI to alter the velocity of a currently running movement, you can send `PlaybackSpeedRequest` with different speed values repeatedly during the movement. - A closed trajectory (end and start joint position are equal) can be repeated by sending `StartMovementRequest` after the movement has finished.
7797
8103
  * @summary Execute Trajectory
7798
8104
  * @param {string} cell Unique identifier addressing a cell in all API calls.
7799
8105
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -7808,7 +8114,7 @@ declare const TrajectoryExecutionApiFp: (configuration?: Configuration) => {
7808
8114
  */
7809
8115
  declare const TrajectoryExecutionApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
7810
8116
  /**
7811
- * <!-- theme: success --> > Websocket endpoint Provides execution control over a previously [planned trajectory](planTrajectory). Enables the caller to attach input/output actions to the trajectory. ### Movement behavior | Virtual controller | Physical controller | |------------------|-------------------| | Desired joint configurations are commanded to each motion group and **applied immediately** | Move to desired **actual joint configuration**, **if possible** | ### Concept of location - The location or path parameter specifies the exact position along a trajectory. - The location is a scalar value that ranges from 0 to `n`, where `n` denotes the number of motion commands, or trajectory segments, e.g., line, p2p, etc. See [planTrajectory](planTrajectory). - Each integer value of the location corresponds to one motion command, e.g., 3.0 to 3.999 could be a line. ### Preconditions - The motion group\'s control mode is not claimed by any other endpoint. - The motion group\'s joint position are at start location specified with `InitializeMovementRequest`. - Use [executeToTrajectory](executeToTrajectory) to move the robot to the start location. ### Requests #### 1. Send `InitializeMovementRequest` to lock the trajectory to this connection The following actions are executed: - Sets robot controller mode to control mode, - Sets start location of the execution Keep in mind that only a single trajectory can be locked to a websocket connection at a time. Pausing the current movement enables you to send another `InitializeMovementRequest` to execute another trajectory on the same connection. #### 2. Send `StartMovementRequest` to start the movement Sets direction of movement, default is forward. #### **Optional** - To pause, send `PauseMovementRequest` before the movement has reached its end location. - Change the movement\'s velocity with `PlaybackSpeedRequest` after initializing the movement with `InitializeMovementRequest`. ### Responses To monitor the state of the movement, listen to the [state stream](streamMotionGroupState). The state is published via nats as well. Field `execute` in the `MotionGroupState` indicates whether a movement is ongoing and carries execution details. Each request has a corresponding acknowledgment response. They signal success or failure of the request. Especially for `PauseMovementResponse`, it does not signal the end of the movement. Additionally, `MovementError` messages can be sent in case of unexpected errors during the execution, e.g., controller disconnects during movement. ### Tips and Tricks - A movement can be paused and resumed by sending `PauseMovementRequest` and `StartMovementRequest`. - Send `PlaybackSpeedRequest` before `StartMovementRequest` to reduce the velocity of the movement before it starts. - Send `PlaybackSpeedRequest` repeatedly to implement a slider. The velocity of the motion group can be adjusted with each controller step. Therefore, if your app needs a slider-like UI to alter the velocity of a currently running movement, you can send `PlaybackSpeedRequest` with different speed values repeatedly during the movement. - A closed trajectory (end and start joint position are equal) can be repeated by sending `StartMovementRequest` after the movement has finished.
8117
+ * <!-- theme: success --> > Websocket endpoint Provides execution control over a previously [planned trajectory](#/operations/planTrajectory). Enables the caller to attach input/output actions to the trajectory. ### Movement behavior | Virtual controller | Physical controller | |------------------|-------------------| | Desired joint configurations are commanded to each motion group and **applied immediately** | Move to desired **actual joint configuration**, **if possible** | ### Concept of location - The location or path parameter specifies the exact position along a trajectory. - The location is a scalar value that ranges from 0 to `n`, where `n` denotes the number of motion commands, or trajectory segments, e.g., line, p2p, etc. See [planTrajectory](#/operations/planTrajectory). - Each integer value of the location corresponds to one motion command, e.g., 3.0 to 3.999 could be a line. ### Preconditions - The motion group\'s control mode is not claimed by any other endpoint. - The motion group\'s joint position are at start location specified with `InitializeMovementRequest`. - Use [executeToTrajectory](#/operations/executeToTrajectory) to move the robot to the start location. ### Requests #### 1. Send `InitializeMovementRequest` to lock the trajectory to this connection The following actions are executed: - Sets robot controller mode to control mode, - Sets start location of the execution Keep in mind that only a single trajectory can be locked to a websocket connection at a time. Pausing the current movement enables you to send another `InitializeMovementRequest` to execute another trajectory on the same connection. #### 2. Send `StartMovementRequest` to start the movement Sets direction of movement, default is forward. #### **Optional** - To pause, send `PauseMovementRequest` before the movement has reached its end location. - Change the movement\'s velocity with `PlaybackSpeedRequest` after initializing the movement with `InitializeMovementRequest`. ### Responses To monitor the state of the movement, listen to the [state stream](#/operations/streamMotionGroupState). The state is published via nats as well. Field `execute` in the `MotionGroupState` indicates whether a movement is ongoing and carries execution details. Each request has a corresponding acknowledgment response. They signal success or failure of the request. Especially for `PauseMovementResponse`, it does not signal the end of the movement. Additionally, `MovementError` messages can be sent in case of unexpected errors during the execution, e.g., controller disconnects during movement. ### Tips and Tricks - A movement can be paused and resumed by sending `PauseMovementRequest` and `StartMovementRequest`. - Send `PlaybackSpeedRequest` before `StartMovementRequest` to reduce the velocity of the movement before it starts. - Send `PlaybackSpeedRequest` repeatedly to implement a slider. The velocity of the motion group can be adjusted with each controller step. Therefore, if your app needs a slider-like UI to alter the velocity of a currently running movement, you can send `PlaybackSpeedRequest` with different speed values repeatedly during the movement. - A closed trajectory (end and start joint position are equal) can be repeated by sending `StartMovementRequest` after the movement has finished.
7812
8118
  * @summary Execute Trajectory
7813
8119
  * @param {string} cell Unique identifier addressing a cell in all API calls.
7814
8120
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -7823,7 +8129,7 @@ declare const TrajectoryExecutionApiFactory: (configuration?: Configuration, bas
7823
8129
  */
7824
8130
  declare class TrajectoryExecutionApi extends BaseAPI {
7825
8131
  /**
7826
- * <!-- theme: success --> > Websocket endpoint Provides execution control over a previously [planned trajectory](planTrajectory). Enables the caller to attach input/output actions to the trajectory. ### Movement behavior | Virtual controller | Physical controller | |------------------|-------------------| | Desired joint configurations are commanded to each motion group and **applied immediately** | Move to desired **actual joint configuration**, **if possible** | ### Concept of location - The location or path parameter specifies the exact position along a trajectory. - The location is a scalar value that ranges from 0 to `n`, where `n` denotes the number of motion commands, or trajectory segments, e.g., line, p2p, etc. See [planTrajectory](planTrajectory). - Each integer value of the location corresponds to one motion command, e.g., 3.0 to 3.999 could be a line. ### Preconditions - The motion group\'s control mode is not claimed by any other endpoint. - The motion group\'s joint position are at start location specified with `InitializeMovementRequest`. - Use [executeToTrajectory](executeToTrajectory) to move the robot to the start location. ### Requests #### 1. Send `InitializeMovementRequest` to lock the trajectory to this connection The following actions are executed: - Sets robot controller mode to control mode, - Sets start location of the execution Keep in mind that only a single trajectory can be locked to a websocket connection at a time. Pausing the current movement enables you to send another `InitializeMovementRequest` to execute another trajectory on the same connection. #### 2. Send `StartMovementRequest` to start the movement Sets direction of movement, default is forward. #### **Optional** - To pause, send `PauseMovementRequest` before the movement has reached its end location. - Change the movement\'s velocity with `PlaybackSpeedRequest` after initializing the movement with `InitializeMovementRequest`. ### Responses To monitor the state of the movement, listen to the [state stream](streamMotionGroupState). The state is published via nats as well. Field `execute` in the `MotionGroupState` indicates whether a movement is ongoing and carries execution details. Each request has a corresponding acknowledgment response. They signal success or failure of the request. Especially for `PauseMovementResponse`, it does not signal the end of the movement. Additionally, `MovementError` messages can be sent in case of unexpected errors during the execution, e.g., controller disconnects during movement. ### Tips and Tricks - A movement can be paused and resumed by sending `PauseMovementRequest` and `StartMovementRequest`. - Send `PlaybackSpeedRequest` before `StartMovementRequest` to reduce the velocity of the movement before it starts. - Send `PlaybackSpeedRequest` repeatedly to implement a slider. The velocity of the motion group can be adjusted with each controller step. Therefore, if your app needs a slider-like UI to alter the velocity of a currently running movement, you can send `PlaybackSpeedRequest` with different speed values repeatedly during the movement. - A closed trajectory (end and start joint position are equal) can be repeated by sending `StartMovementRequest` after the movement has finished.
8132
+ * <!-- theme: success --> > Websocket endpoint Provides execution control over a previously [planned trajectory](#/operations/planTrajectory). Enables the caller to attach input/output actions to the trajectory. ### Movement behavior | Virtual controller | Physical controller | |------------------|-------------------| | Desired joint configurations are commanded to each motion group and **applied immediately** | Move to desired **actual joint configuration**, **if possible** | ### Concept of location - The location or path parameter specifies the exact position along a trajectory. - The location is a scalar value that ranges from 0 to `n`, where `n` denotes the number of motion commands, or trajectory segments, e.g., line, p2p, etc. See [planTrajectory](#/operations/planTrajectory). - Each integer value of the location corresponds to one motion command, e.g., 3.0 to 3.999 could be a line. ### Preconditions - The motion group\'s control mode is not claimed by any other endpoint. - The motion group\'s joint position are at start location specified with `InitializeMovementRequest`. - Use [executeToTrajectory](#/operations/executeToTrajectory) to move the robot to the start location. ### Requests #### 1. Send `InitializeMovementRequest` to lock the trajectory to this connection The following actions are executed: - Sets robot controller mode to control mode, - Sets start location of the execution Keep in mind that only a single trajectory can be locked to a websocket connection at a time. Pausing the current movement enables you to send another `InitializeMovementRequest` to execute another trajectory on the same connection. #### 2. Send `StartMovementRequest` to start the movement Sets direction of movement, default is forward. #### **Optional** - To pause, send `PauseMovementRequest` before the movement has reached its end location. - Change the movement\'s velocity with `PlaybackSpeedRequest` after initializing the movement with `InitializeMovementRequest`. ### Responses To monitor the state of the movement, listen to the [state stream](#/operations/streamMotionGroupState). The state is published via nats as well. Field `execute` in the `MotionGroupState` indicates whether a movement is ongoing and carries execution details. Each request has a corresponding acknowledgment response. They signal success or failure of the request. Especially for `PauseMovementResponse`, it does not signal the end of the movement. Additionally, `MovementError` messages can be sent in case of unexpected errors during the execution, e.g., controller disconnects during movement. ### Tips and Tricks - A movement can be paused and resumed by sending `PauseMovementRequest` and `StartMovementRequest`. - Send `PlaybackSpeedRequest` before `StartMovementRequest` to reduce the velocity of the movement before it starts. - Send `PlaybackSpeedRequest` repeatedly to implement a slider. The velocity of the motion group can be adjusted with each controller step. Therefore, if your app needs a slider-like UI to alter the velocity of a currently running movement, you can send `PlaybackSpeedRequest` with different speed values repeatedly during the movement. - A closed trajectory (end and start joint position are equal) can be repeated by sending `StartMovementRequest` after the movement has finished.
7827
8133
  * @summary Execute Trajectory
7828
8134
  * @param {string} cell Unique identifier addressing a cell in all API calls.
7829
8135
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -7838,7 +8144,16 @@ declare class TrajectoryExecutionApi extends BaseAPI {
7838
8144
  */
7839
8145
  declare const TrajectoryPlanningApiAxiosParamCreator: (configuration?: Configuration) => {
7840
8146
  /**
7841
- * 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.
8147
+ * <!-- theme: danger --> > **Experimental** Merges a list of joint trajectories into a single trajectory with collision-aware blending. This endpoint merges a list of separate trajectories by connecting them via blending. The blending is performed with collision checking to ensure the merged trajectory is safe to execute. Timescaling will be applied to the blended area to ensure all limits are respected.
8148
+ * @summary Merge Trajectories
8149
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
8150
+ * @param {MergeTrajectoriesRequest} mergeTrajectoriesRequest
8151
+ * @param {*} [options] Override http request option.
8152
+ * @throws {RequiredError}
8153
+ */
8154
+ mergeTrajectories: (cell: string, mergeTrajectoriesRequest: MergeTrajectoriesRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
8155
+ /**
8156
+ * 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](#/operations/addTrajectory) endpoint. 3. Execute the (cached) trajectory using the [executeTrajectory](#/operations/executeTrajectory) endpoint. If the trajectory planning fails due to collision or algorithm constraints, the response will contain error information about the failure.
7842
8157
  * @summary Plan Collision-Free Trajectory
7843
8158
  * @param {string} cell Unique identifier addressing a cell in all API calls.
7844
8159
  * @param {PlanCollisionFreeRequest} planCollisionFreeRequest
@@ -7847,7 +8162,7 @@ declare const TrajectoryPlanningApiAxiosParamCreator: (configuration?: Configura
7847
8162
  */
7848
8163
  planCollisionFree: (cell: string, planCollisionFreeRequest: PlanCollisionFreeRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
7849
8164
  /**
7850
- * 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 response will contain the joint trajectory up until the error, e.g., all samples until a collision occurs. <!-- theme: info --> > #### 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.
8165
+ * 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](#/operations/addTrajectory) endpoint. 3. Execute the (cached) trajectory using the [executeTrajectory](#/operations/executeTrajectory) endpoint. If the trajectory is not executable, the response will contain the joint trajectory up until the error, e.g., all samples until a collision occurs. <!-- theme: info --> > #### 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.
7851
8166
  * @summary Plan Trajectory
7852
8167
  * @param {string} cell Unique identifier addressing a cell in all API calls.
7853
8168
  * @param {PlanTrajectoryRequest} planTrajectoryRequest
@@ -7861,7 +8176,16 @@ declare const TrajectoryPlanningApiAxiosParamCreator: (configuration?: Configura
7861
8176
  */
7862
8177
  declare const TrajectoryPlanningApiFp: (configuration?: Configuration) => {
7863
8178
  /**
7864
- * 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.
8179
+ * <!-- theme: danger --> > **Experimental** Merges a list of joint trajectories into a single trajectory with collision-aware blending. This endpoint merges a list of separate trajectories by connecting them via blending. The blending is performed with collision checking to ensure the merged trajectory is safe to execute. Timescaling will be applied to the blended area to ensure all limits are respected.
8180
+ * @summary Merge Trajectories
8181
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
8182
+ * @param {MergeTrajectoriesRequest} mergeTrajectoriesRequest
8183
+ * @param {*} [options] Override http request option.
8184
+ * @throws {RequiredError}
8185
+ */
8186
+ mergeTrajectories(cell: string, mergeTrajectoriesRequest: MergeTrajectoriesRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<MergeTrajectoriesResponse>>;
8187
+ /**
8188
+ * 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](#/operations/addTrajectory) endpoint. 3. Execute the (cached) trajectory using the [executeTrajectory](#/operations/executeTrajectory) endpoint. If the trajectory planning fails due to collision or algorithm constraints, the response will contain error information about the failure.
7865
8189
  * @summary Plan Collision-Free Trajectory
7866
8190
  * @param {string} cell Unique identifier addressing a cell in all API calls.
7867
8191
  * @param {PlanCollisionFreeRequest} planCollisionFreeRequest
@@ -7870,7 +8194,7 @@ declare const TrajectoryPlanningApiFp: (configuration?: Configuration) => {
7870
8194
  */
7871
8195
  planCollisionFree(cell: string, planCollisionFreeRequest: PlanCollisionFreeRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PlanCollisionFreeResponse>>;
7872
8196
  /**
7873
- * 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 response will contain the joint trajectory up until the error, e.g., all samples until a collision occurs. <!-- theme: info --> > #### 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.
8197
+ * 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](#/operations/addTrajectory) endpoint. 3. Execute the (cached) trajectory using the [executeTrajectory](#/operations/executeTrajectory) endpoint. If the trajectory is not executable, the response will contain the joint trajectory up until the error, e.g., all samples until a collision occurs. <!-- theme: info --> > #### 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.
7874
8198
  * @summary Plan Trajectory
7875
8199
  * @param {string} cell Unique identifier addressing a cell in all API calls.
7876
8200
  * @param {PlanTrajectoryRequest} planTrajectoryRequest
@@ -7884,7 +8208,16 @@ declare const TrajectoryPlanningApiFp: (configuration?: Configuration) => {
7884
8208
  */
7885
8209
  declare const TrajectoryPlanningApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
7886
8210
  /**
7887
- * 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.
8211
+ * <!-- theme: danger --> > **Experimental** Merges a list of joint trajectories into a single trajectory with collision-aware blending. This endpoint merges a list of separate trajectories by connecting them via blending. The blending is performed with collision checking to ensure the merged trajectory is safe to execute. Timescaling will be applied to the blended area to ensure all limits are respected.
8212
+ * @summary Merge Trajectories
8213
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
8214
+ * @param {MergeTrajectoriesRequest} mergeTrajectoriesRequest
8215
+ * @param {*} [options] Override http request option.
8216
+ * @throws {RequiredError}
8217
+ */
8218
+ mergeTrajectories(cell: string, mergeTrajectoriesRequest: MergeTrajectoriesRequest, options?: RawAxiosRequestConfig): AxiosPromise<MergeTrajectoriesResponse>;
8219
+ /**
8220
+ * 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](#/operations/addTrajectory) endpoint. 3. Execute the (cached) trajectory using the [executeTrajectory](#/operations/executeTrajectory) endpoint. If the trajectory planning fails due to collision or algorithm constraints, the response will contain error information about the failure.
7888
8221
  * @summary Plan Collision-Free Trajectory
7889
8222
  * @param {string} cell Unique identifier addressing a cell in all API calls.
7890
8223
  * @param {PlanCollisionFreeRequest} planCollisionFreeRequest
@@ -7893,7 +8226,7 @@ declare const TrajectoryPlanningApiFactory: (configuration?: Configuration, base
7893
8226
  */
7894
8227
  planCollisionFree(cell: string, planCollisionFreeRequest: PlanCollisionFreeRequest, options?: RawAxiosRequestConfig): AxiosPromise<PlanCollisionFreeResponse>;
7895
8228
  /**
7896
- * 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 response will contain the joint trajectory up until the error, e.g., all samples until a collision occurs. <!-- theme: info --> > #### 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.
8229
+ * 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](#/operations/addTrajectory) endpoint. 3. Execute the (cached) trajectory using the [executeTrajectory](#/operations/executeTrajectory) endpoint. If the trajectory is not executable, the response will contain the joint trajectory up until the error, e.g., all samples until a collision occurs. <!-- theme: info --> > #### 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.
7897
8230
  * @summary Plan Trajectory
7898
8231
  * @param {string} cell Unique identifier addressing a cell in all API calls.
7899
8232
  * @param {PlanTrajectoryRequest} planTrajectoryRequest
@@ -7907,7 +8240,16 @@ declare const TrajectoryPlanningApiFactory: (configuration?: Configuration, base
7907
8240
  */
7908
8241
  declare class TrajectoryPlanningApi extends BaseAPI {
7909
8242
  /**
7910
- * 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.
8243
+ * <!-- theme: danger --> > **Experimental** Merges a list of joint trajectories into a single trajectory with collision-aware blending. This endpoint merges a list of separate trajectories by connecting them via blending. The blending is performed with collision checking to ensure the merged trajectory is safe to execute. Timescaling will be applied to the blended area to ensure all limits are respected.
8244
+ * @summary Merge Trajectories
8245
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
8246
+ * @param {MergeTrajectoriesRequest} mergeTrajectoriesRequest
8247
+ * @param {*} [options] Override http request option.
8248
+ * @throws {RequiredError}
8249
+ */
8250
+ mergeTrajectories(cell: string, mergeTrajectoriesRequest: MergeTrajectoriesRequest, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<MergeTrajectoriesResponse, any>>;
8251
+ /**
8252
+ * 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](#/operations/addTrajectory) endpoint. 3. Execute the (cached) trajectory using the [executeTrajectory](#/operations/executeTrajectory) endpoint. If the trajectory planning fails due to collision or algorithm constraints, the response will contain error information about the failure.
7911
8253
  * @summary Plan Collision-Free Trajectory
7912
8254
  * @param {string} cell Unique identifier addressing a cell in all API calls.
7913
8255
  * @param {PlanCollisionFreeRequest} planCollisionFreeRequest
@@ -7916,7 +8258,7 @@ declare class TrajectoryPlanningApi extends BaseAPI {
7916
8258
  */
7917
8259
  planCollisionFree(cell: string, planCollisionFreeRequest: PlanCollisionFreeRequest, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<PlanCollisionFreeResponse, any>>;
7918
8260
  /**
7919
- * 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 response will contain the joint trajectory up until the error, e.g., all samples until a collision occurs. <!-- theme: info --> > #### 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.
8261
+ * 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](#/operations/addTrajectory) endpoint. 3. Execute the (cached) trajectory using the [executeTrajectory](#/operations/executeTrajectory) endpoint. If the trajectory is not executable, the response will contain the joint trajectory up until the error, e.g., all samples until a collision occurs. <!-- theme: info --> > #### 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.
7920
8262
  * @summary Plan Trajectory
7921
8263
  * @param {string} cell Unique identifier addressing a cell in all API calls.
7922
8264
  * @param {PlanTrajectoryRequest} planTrajectoryRequest
@@ -7988,6 +8330,16 @@ declare const VirtualControllerApiAxiosParamCreator: (configuration?: Configurat
7988
8330
  * @throws {RequiredError}
7989
8331
  */
7990
8332
  addVirtualControllerCoordinateSystem: (cell: string, controller: string, coordinateSystem: string, coordinateSystemData: CoordinateSystemData, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
8333
+ /**
8334
+ * Adds a motion group configuration for the virtual robot controller. Fields: - Only one of **motion_group_model** or **json_data** should be set. - **motion_group_model**: Identifies a single motion group. See [getMotionGroupModels](#/operations/getMotionGroupModels) for supported types. - **json_data**: Full JSON configuration of the virtual robot controller. This can be obtained from the physical controller\'s configuration via [getVirtualControllerConfiguration](#/operations/getVirtualControllerConfiguration). - **extracted_motion_group_id** (required when using json_data): The motion group identifier to extract from the provided JSON configuration. - **motion_group**: Unique identifier for the motion group to be added. - **initial_joint_position**: Specifies the initial joint position for the added motion group. <!-- theme: info --> > #### NOTE > > When a motion group is added, **the virtual robot is restarted** to apply the new configuration. > > During this restart: > - Robot visualization can temporarily disappear or appear outdated in the UI. > - Motion group changes are not immediately visible in visualizations. > - All connections to virtual robot are closed and re-established, which introduces a short delay before the system is fully operational again. > > The API call itself **does not wait until the restart and re-synchronization are complete**. > This means that immediately after a successful response, the new motion group may not yet be available for use.
8335
+ * @summary Add Motion Group
8336
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
8337
+ * @param {string} controller Unique identifier to address a controller in the cell.
8338
+ * @param {AddVirtualControllerMotionGroupRequest} addVirtualControllerMotionGroupRequest
8339
+ * @param {*} [options] Override http request option.
8340
+ * @throws {RequiredError}
8341
+ */
8342
+ addVirtualControllerMotionGroup: (cell: string, controller: string, addVirtualControllerMotionGroupRequest: AddVirtualControllerMotionGroupRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
7991
8343
  /**
7992
8344
  * Adds a new TCP or updates an existing TCP in the motion group. The position and rotation values in the request body are defined within the flange\'s coordinate system. > **NOTE** > > Ensure the TCP\'s position is within the robot\'s reach. Refer to the robot\'s documentation or data sheet for details like joint limits or reach. <!-- theme: info --> > #### NOTE > > When adding or updating a TCP, the **virtual robot is restarted** to apply the new configuration. > > During this restart: > - Robot visualization can temporarily disappear. > - The TCP may not be immediately visible or appear outdated in visualizations. > - All connections to virtual robot are closed and re-established, which introduces a short delay before the TCP is available for operation. > > The API call itself does **not wait until the restart and re-synchronization are complete**. > A successful response indicates that the request was accepted, but the TCP may not yet be visible nor usable.
7993
8345
  * @summary Add TCP
@@ -8011,6 +8363,16 @@ declare const VirtualControllerApiAxiosParamCreator: (configuration?: Configurat
8011
8363
  * @throws {RequiredError}
8012
8364
  */
8013
8365
  deleteVirtualControllerCoordinateSystem: (cell: string, controller: string, coordinateSystem: string, deleteDependent?: boolean, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
8366
+ /**
8367
+ * Removes a motion group configuration from the virtual controller. <!-- theme: info --> > #### NOTE > > When a motion group is removed, **the virtual robot is restarted** to apply the new configuration. > > During this restart: > - Robot visualization can temporarily disappear or appear outdated in the UI. > - Motion group changes are not immediately visible in visualizations. > - All connections to virtual robot are closed and re-established, which introduces a short delay before the system is fully operational again. > > The API call itself **does not wait until the restart and re-synchronization are complete**.
8368
+ * @summary Delete Motion Group
8369
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
8370
+ * @param {string} controller Unique identifier to address a controller in the cell.
8371
+ * @param {string} motionGroup The motion-group identifier.
8372
+ * @param {*} [options] Override http request option.
8373
+ * @throws {RequiredError}
8374
+ */
8375
+ deleteVirtualControllerMotionGroup: (cell: string, controller: string, motionGroup: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
8014
8376
  /**
8015
8377
  * Removes the TCP (Tool Center Point) from the motion group. An unknown TCP is a valid input and will simply be ignored. <!-- theme: info --> > #### NOTE > > When removing a TCP, the **virtual robot is restarted** to apply the new configuration. > > During this restart: > - Robot visualization can temporarily disappear. > - The removal of the TCP may not be immediately visible or appear outdated in visualizations. > - All connections to virtual robot are closed and re-established, which introduces a short delay before the system is fully operational again. > > The API call itself does **not wait until the restart and re-synchronization are complete**. > A successful response indicates that the request was accepted, but the then used TCP may not yet be visible nor usable.
8016
8378
  * @summary Remove TCP
@@ -8023,7 +8385,7 @@ declare const VirtualControllerApiAxiosParamCreator: (configuration?: Configurat
8023
8385
  */
8024
8386
  deleteVirtualControllerTcp: (cell: string, controller: string, motionGroup: string, tcp: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
8025
8387
  /**
8026
- * Requests the Emergency Stop state of the virtual robot controller. Use [getCurrentMotionGroupState](getCurrentMotionGroupState) to get the Emergency Stop state with `safety_state` regardless of the controller type. > **NOTE** > > The Emergency Stop state can only be changed when using virtual robot controllers.
8388
+ * Requests the Emergency Stop state of the virtual robot controller. Use [getCurrentMotionGroupState](#/operations/getCurrentMotionGroupState) to get the Emergency Stop state with `safety_state` regardless of the controller type. > **NOTE** > > The Emergency Stop state can only be changed when using virtual robot controllers.
8027
8389
  * @summary Get Emergency Stop State
8028
8390
  * @param {string} cell Unique identifier addressing a cell in all API calls.
8029
8391
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -8051,7 +8413,7 @@ declare const VirtualControllerApiAxiosParamCreator: (configuration?: Configurat
8051
8413
  */
8052
8414
  getMotionGroups: (cell: string, controller: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
8053
8415
  /**
8054
- * Requests the operation mode of the virtual robot controller. To get the operation mode regardless of the controller type, use [getCurrentMotionGroupState](getCurrentMotionGroupState). > **NOTE** > > The operation mode can only be changed via API when using virtual robot controllers.
8416
+ * Requests the operation mode of the virtual robot controller. To get the operation mode regardless of the controller type, use [getCurrentMotionGroupState](#/operations/getCurrentMotionGroupState). > **NOTE** > > The operation mode can only be changed via API when using virtual robot controllers.
8055
8417
  * @summary Get Operation Mode
8056
8418
  * @param {string} cell Unique identifier addressing a cell in all API calls.
8057
8419
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -8089,7 +8451,7 @@ declare const VirtualControllerApiAxiosParamCreator: (configuration?: Configurat
8089
8451
  */
8090
8452
  listVirtualControllerTcps: (cell: string, controller: string, motionGroup: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
8091
8453
  /**
8092
- * Activates or releases the Emergency Stop on the virtual robot controller. Activating the Emergency Stop stops the execution of all motions. The stop is executed on physical controllers immediately not gracefully and not on paths. Due to restricted physical behavior of the virtual robot controller, the Emergency Stop is executed on paths. To return to normal operation the Emergency Stop needs to be released. Use [getCurrentMotionGroupState](getCurrentMotionGroupState) to get the Emergency Stop state with `safety_state` regardless of the controller type. > **NOTE** > > The Emergency Stop state can only be changed via API when using virtual robot controllers.
8454
+ * Activates or releases the Emergency Stop on the virtual robot controller. Activating the Emergency Stop stops the execution of all motions. The stop is executed on physical controllers immediately not gracefully and not on paths. Due to restricted physical behavior of the virtual robot controller, the Emergency Stop is executed on paths. To return to normal operation the Emergency Stop needs to be released. Use [getCurrentMotionGroupState](#/operations/getCurrentMotionGroupState) to get the Emergency Stop state with `safety_state` regardless of the controller type. > **NOTE** > > The Emergency Stop state can only be changed via API when using virtual robot controllers.
8093
8455
  * @summary Push or Release Emergency Stop
8094
8456
  * @param {string} cell Unique identifier addressing a cell in all API calls.
8095
8457
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -8110,7 +8472,7 @@ declare const VirtualControllerApiAxiosParamCreator: (configuration?: Configurat
8110
8472
  */
8111
8473
  setMotionGroupState: (cell: string, controller: string, motionGroup: string, motionGroupJoints: MotionGroupJoints, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
8112
8474
  /**
8113
- * Changes the operation mode of the virtual robot controller to the specified value. To get the operation mode regardless of the controller type, use [getCurrentMotionGroupState](getCurrentMotionGroupState). > **NOTE** > > The operation mode can only be changed via API when using virtual robot controllers.
8475
+ * Changes the operation mode of the virtual robot controller to the specified value. To get the operation mode regardless of the controller type, use [getCurrentMotionGroupState](#/operations/getCurrentMotionGroupState). > **NOTE** > > The operation mode can only be changed via API when using virtual robot controllers.
8114
8476
  * @summary Set Operation Mode
8115
8477
  * @param {string} cell Unique identifier addressing a cell in all API calls.
8116
8478
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -8146,6 +8508,16 @@ declare const VirtualControllerApiFp: (configuration?: Configuration) => {
8146
8508
  * @throws {RequiredError}
8147
8509
  */
8148
8510
  addVirtualControllerCoordinateSystem(cell: string, controller: string, coordinateSystem: string, coordinateSystemData: CoordinateSystemData, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
8511
+ /**
8512
+ * Adds a motion group configuration for the virtual robot controller. Fields: - Only one of **motion_group_model** or **json_data** should be set. - **motion_group_model**: Identifies a single motion group. See [getMotionGroupModels](#/operations/getMotionGroupModels) for supported types. - **json_data**: Full JSON configuration of the virtual robot controller. This can be obtained from the physical controller\'s configuration via [getVirtualControllerConfiguration](#/operations/getVirtualControllerConfiguration). - **extracted_motion_group_id** (required when using json_data): The motion group identifier to extract from the provided JSON configuration. - **motion_group**: Unique identifier for the motion group to be added. - **initial_joint_position**: Specifies the initial joint position for the added motion group. <!-- theme: info --> > #### NOTE > > When a motion group is added, **the virtual robot is restarted** to apply the new configuration. > > During this restart: > - Robot visualization can temporarily disappear or appear outdated in the UI. > - Motion group changes are not immediately visible in visualizations. > - All connections to virtual robot are closed and re-established, which introduces a short delay before the system is fully operational again. > > The API call itself **does not wait until the restart and re-synchronization are complete**. > This means that immediately after a successful response, the new motion group may not yet be available for use.
8513
+ * @summary Add Motion Group
8514
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
8515
+ * @param {string} controller Unique identifier to address a controller in the cell.
8516
+ * @param {AddVirtualControllerMotionGroupRequest} addVirtualControllerMotionGroupRequest
8517
+ * @param {*} [options] Override http request option.
8518
+ * @throws {RequiredError}
8519
+ */
8520
+ addVirtualControllerMotionGroup(cell: string, controller: string, addVirtualControllerMotionGroupRequest: AddVirtualControllerMotionGroupRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
8149
8521
  /**
8150
8522
  * Adds a new TCP or updates an existing TCP in the motion group. The position and rotation values in the request body are defined within the flange\'s coordinate system. > **NOTE** > > Ensure the TCP\'s position is within the robot\'s reach. Refer to the robot\'s documentation or data sheet for details like joint limits or reach. <!-- theme: info --> > #### NOTE > > When adding or updating a TCP, the **virtual robot is restarted** to apply the new configuration. > > During this restart: > - Robot visualization can temporarily disappear. > - The TCP may not be immediately visible or appear outdated in visualizations. > - All connections to virtual robot are closed and re-established, which introduces a short delay before the TCP is available for operation. > > The API call itself does **not wait until the restart and re-synchronization are complete**. > A successful response indicates that the request was accepted, but the TCP may not yet be visible nor usable.
8151
8523
  * @summary Add TCP
@@ -8169,6 +8541,16 @@ declare const VirtualControllerApiFp: (configuration?: Configuration) => {
8169
8541
  * @throws {RequiredError}
8170
8542
  */
8171
8543
  deleteVirtualControllerCoordinateSystem(cell: string, controller: string, coordinateSystem: string, deleteDependent?: boolean, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
8544
+ /**
8545
+ * Removes a motion group configuration from the virtual controller. <!-- theme: info --> > #### NOTE > > When a motion group is removed, **the virtual robot is restarted** to apply the new configuration. > > During this restart: > - Robot visualization can temporarily disappear or appear outdated in the UI. > - Motion group changes are not immediately visible in visualizations. > - All connections to virtual robot are closed and re-established, which introduces a short delay before the system is fully operational again. > > The API call itself **does not wait until the restart and re-synchronization are complete**.
8546
+ * @summary Delete Motion Group
8547
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
8548
+ * @param {string} controller Unique identifier to address a controller in the cell.
8549
+ * @param {string} motionGroup The motion-group identifier.
8550
+ * @param {*} [options] Override http request option.
8551
+ * @throws {RequiredError}
8552
+ */
8553
+ deleteVirtualControllerMotionGroup(cell: string, controller: string, motionGroup: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
8172
8554
  /**
8173
8555
  * Removes the TCP (Tool Center Point) from the motion group. An unknown TCP is a valid input and will simply be ignored. <!-- theme: info --> > #### NOTE > > When removing a TCP, the **virtual robot is restarted** to apply the new configuration. > > During this restart: > - Robot visualization can temporarily disappear. > - The removal of the TCP may not be immediately visible or appear outdated in visualizations. > - All connections to virtual robot are closed and re-established, which introduces a short delay before the system is fully operational again. > > The API call itself does **not wait until the restart and re-synchronization are complete**. > A successful response indicates that the request was accepted, but the then used TCP may not yet be visible nor usable.
8174
8556
  * @summary Remove TCP
@@ -8181,7 +8563,7 @@ declare const VirtualControllerApiFp: (configuration?: Configuration) => {
8181
8563
  */
8182
8564
  deleteVirtualControllerTcp(cell: string, controller: string, motionGroup: string, tcp: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
8183
8565
  /**
8184
- * Requests the Emergency Stop state of the virtual robot controller. Use [getCurrentMotionGroupState](getCurrentMotionGroupState) to get the Emergency Stop state with `safety_state` regardless of the controller type. > **NOTE** > > The Emergency Stop state can only be changed when using virtual robot controllers.
8566
+ * Requests the Emergency Stop state of the virtual robot controller. Use [getCurrentMotionGroupState](#/operations/getCurrentMotionGroupState) to get the Emergency Stop state with `safety_state` regardless of the controller type. > **NOTE** > > The Emergency Stop state can only be changed when using virtual robot controllers.
8185
8567
  * @summary Get Emergency Stop State
8186
8568
  * @param {string} cell Unique identifier addressing a cell in all API calls.
8187
8569
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -8209,7 +8591,7 @@ declare const VirtualControllerApiFp: (configuration?: Configuration) => {
8209
8591
  */
8210
8592
  getMotionGroups(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<MotionGroupInfo>>>;
8211
8593
  /**
8212
- * Requests the operation mode of the virtual robot controller. To get the operation mode regardless of the controller type, use [getCurrentMotionGroupState](getCurrentMotionGroupState). > **NOTE** > > The operation mode can only be changed via API when using virtual robot controllers.
8594
+ * Requests the operation mode of the virtual robot controller. To get the operation mode regardless of the controller type, use [getCurrentMotionGroupState](#/operations/getCurrentMotionGroupState). > **NOTE** > > The operation mode can only be changed via API when using virtual robot controllers.
8213
8595
  * @summary Get Operation Mode
8214
8596
  * @param {string} cell Unique identifier addressing a cell in all API calls.
8215
8597
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -8247,7 +8629,7 @@ declare const VirtualControllerApiFp: (configuration?: Configuration) => {
8247
8629
  */
8248
8630
  listVirtualControllerTcps(cell: string, controller: string, motionGroup: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<RobotTcp>>>;
8249
8631
  /**
8250
- * Activates or releases the Emergency Stop on the virtual robot controller. Activating the Emergency Stop stops the execution of all motions. The stop is executed on physical controllers immediately not gracefully and not on paths. Due to restricted physical behavior of the virtual robot controller, the Emergency Stop is executed on paths. To return to normal operation the Emergency Stop needs to be released. Use [getCurrentMotionGroupState](getCurrentMotionGroupState) to get the Emergency Stop state with `safety_state` regardless of the controller type. > **NOTE** > > The Emergency Stop state can only be changed via API when using virtual robot controllers.
8632
+ * Activates or releases the Emergency Stop on the virtual robot controller. Activating the Emergency Stop stops the execution of all motions. The stop is executed on physical controllers immediately not gracefully and not on paths. Due to restricted physical behavior of the virtual robot controller, the Emergency Stop is executed on paths. To return to normal operation the Emergency Stop needs to be released. Use [getCurrentMotionGroupState](#/operations/getCurrentMotionGroupState) to get the Emergency Stop state with `safety_state` regardless of the controller type. > **NOTE** > > The Emergency Stop state can only be changed via API when using virtual robot controllers.
8251
8633
  * @summary Push or Release Emergency Stop
8252
8634
  * @param {string} cell Unique identifier addressing a cell in all API calls.
8253
8635
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -8268,7 +8650,7 @@ declare const VirtualControllerApiFp: (configuration?: Configuration) => {
8268
8650
  */
8269
8651
  setMotionGroupState(cell: string, controller: string, motionGroup: string, motionGroupJoints: MotionGroupJoints, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
8270
8652
  /**
8271
- * Changes the operation mode of the virtual robot controller to the specified value. To get the operation mode regardless of the controller type, use [getCurrentMotionGroupState](getCurrentMotionGroupState). > **NOTE** > > The operation mode can only be changed via API when using virtual robot controllers.
8653
+ * Changes the operation mode of the virtual robot controller to the specified value. To get the operation mode regardless of the controller type, use [getCurrentMotionGroupState](#/operations/getCurrentMotionGroupState). > **NOTE** > > The operation mode can only be changed via API when using virtual robot controllers.
8272
8654
  * @summary Set Operation Mode
8273
8655
  * @param {string} cell Unique identifier addressing a cell in all API calls.
8274
8656
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -8304,6 +8686,16 @@ declare const VirtualControllerApiFactory: (configuration?: Configuration, baseP
8304
8686
  * @throws {RequiredError}
8305
8687
  */
8306
8688
  addVirtualControllerCoordinateSystem(cell: string, controller: string, coordinateSystem: string, coordinateSystemData: CoordinateSystemData, options?: RawAxiosRequestConfig): AxiosPromise<void>;
8689
+ /**
8690
+ * Adds a motion group configuration for the virtual robot controller. Fields: - Only one of **motion_group_model** or **json_data** should be set. - **motion_group_model**: Identifies a single motion group. See [getMotionGroupModels](#/operations/getMotionGroupModels) for supported types. - **json_data**: Full JSON configuration of the virtual robot controller. This can be obtained from the physical controller\'s configuration via [getVirtualControllerConfiguration](#/operations/getVirtualControllerConfiguration). - **extracted_motion_group_id** (required when using json_data): The motion group identifier to extract from the provided JSON configuration. - **motion_group**: Unique identifier for the motion group to be added. - **initial_joint_position**: Specifies the initial joint position for the added motion group. <!-- theme: info --> > #### NOTE > > When a motion group is added, **the virtual robot is restarted** to apply the new configuration. > > During this restart: > - Robot visualization can temporarily disappear or appear outdated in the UI. > - Motion group changes are not immediately visible in visualizations. > - All connections to virtual robot are closed and re-established, which introduces a short delay before the system is fully operational again. > > The API call itself **does not wait until the restart and re-synchronization are complete**. > This means that immediately after a successful response, the new motion group may not yet be available for use.
8691
+ * @summary Add Motion Group
8692
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
8693
+ * @param {string} controller Unique identifier to address a controller in the cell.
8694
+ * @param {AddVirtualControllerMotionGroupRequest} addVirtualControllerMotionGroupRequest
8695
+ * @param {*} [options] Override http request option.
8696
+ * @throws {RequiredError}
8697
+ */
8698
+ addVirtualControllerMotionGroup(cell: string, controller: string, addVirtualControllerMotionGroupRequest: AddVirtualControllerMotionGroupRequest, options?: RawAxiosRequestConfig): AxiosPromise<void>;
8307
8699
  /**
8308
8700
  * Adds a new TCP or updates an existing TCP in the motion group. The position and rotation values in the request body are defined within the flange\'s coordinate system. > **NOTE** > > Ensure the TCP\'s position is within the robot\'s reach. Refer to the robot\'s documentation or data sheet for details like joint limits or reach. <!-- theme: info --> > #### NOTE > > When adding or updating a TCP, the **virtual robot is restarted** to apply the new configuration. > > During this restart: > - Robot visualization can temporarily disappear. > - The TCP may not be immediately visible or appear outdated in visualizations. > - All connections to virtual robot are closed and re-established, which introduces a short delay before the TCP is available for operation. > > The API call itself does **not wait until the restart and re-synchronization are complete**. > A successful response indicates that the request was accepted, but the TCP may not yet be visible nor usable.
8309
8701
  * @summary Add TCP
@@ -8327,6 +8719,16 @@ declare const VirtualControllerApiFactory: (configuration?: Configuration, baseP
8327
8719
  * @throws {RequiredError}
8328
8720
  */
8329
8721
  deleteVirtualControllerCoordinateSystem(cell: string, controller: string, coordinateSystem: string, deleteDependent?: boolean, options?: RawAxiosRequestConfig): AxiosPromise<void>;
8722
+ /**
8723
+ * Removes a motion group configuration from the virtual controller. <!-- theme: info --> > #### NOTE > > When a motion group is removed, **the virtual robot is restarted** to apply the new configuration. > > During this restart: > - Robot visualization can temporarily disappear or appear outdated in the UI. > - Motion group changes are not immediately visible in visualizations. > - All connections to virtual robot are closed and re-established, which introduces a short delay before the system is fully operational again. > > The API call itself **does not wait until the restart and re-synchronization are complete**.
8724
+ * @summary Delete Motion Group
8725
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
8726
+ * @param {string} controller Unique identifier to address a controller in the cell.
8727
+ * @param {string} motionGroup The motion-group identifier.
8728
+ * @param {*} [options] Override http request option.
8729
+ * @throws {RequiredError}
8730
+ */
8731
+ deleteVirtualControllerMotionGroup(cell: string, controller: string, motionGroup: string, options?: RawAxiosRequestConfig): AxiosPromise<void>;
8330
8732
  /**
8331
8733
  * Removes the TCP (Tool Center Point) from the motion group. An unknown TCP is a valid input and will simply be ignored. <!-- theme: info --> > #### NOTE > > When removing a TCP, the **virtual robot is restarted** to apply the new configuration. > > During this restart: > - Robot visualization can temporarily disappear. > - The removal of the TCP may not be immediately visible or appear outdated in visualizations. > - All connections to virtual robot are closed and re-established, which introduces a short delay before the system is fully operational again. > > The API call itself does **not wait until the restart and re-synchronization are complete**. > A successful response indicates that the request was accepted, but the then used TCP may not yet be visible nor usable.
8332
8734
  * @summary Remove TCP
@@ -8339,7 +8741,7 @@ declare const VirtualControllerApiFactory: (configuration?: Configuration, baseP
8339
8741
  */
8340
8742
  deleteVirtualControllerTcp(cell: string, controller: string, motionGroup: string, tcp: string, options?: RawAxiosRequestConfig): AxiosPromise<void>;
8341
8743
  /**
8342
- * Requests the Emergency Stop state of the virtual robot controller. Use [getCurrentMotionGroupState](getCurrentMotionGroupState) to get the Emergency Stop state with `safety_state` regardless of the controller type. > **NOTE** > > The Emergency Stop state can only be changed when using virtual robot controllers.
8744
+ * Requests the Emergency Stop state of the virtual robot controller. Use [getCurrentMotionGroupState](#/operations/getCurrentMotionGroupState) to get the Emergency Stop state with `safety_state` regardless of the controller type. > **NOTE** > > The Emergency Stop state can only be changed when using virtual robot controllers.
8343
8745
  * @summary Get Emergency Stop State
8344
8746
  * @param {string} cell Unique identifier addressing a cell in all API calls.
8345
8747
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -8367,7 +8769,7 @@ declare const VirtualControllerApiFactory: (configuration?: Configuration, baseP
8367
8769
  */
8368
8770
  getMotionGroups(cell: string, controller: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<MotionGroupInfo>>;
8369
8771
  /**
8370
- * Requests the operation mode of the virtual robot controller. To get the operation mode regardless of the controller type, use [getCurrentMotionGroupState](getCurrentMotionGroupState). > **NOTE** > > The operation mode can only be changed via API when using virtual robot controllers.
8772
+ * Requests the operation mode of the virtual robot controller. To get the operation mode regardless of the controller type, use [getCurrentMotionGroupState](#/operations/getCurrentMotionGroupState). > **NOTE** > > The operation mode can only be changed via API when using virtual robot controllers.
8371
8773
  * @summary Get Operation Mode
8372
8774
  * @param {string} cell Unique identifier addressing a cell in all API calls.
8373
8775
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -8405,7 +8807,7 @@ declare const VirtualControllerApiFactory: (configuration?: Configuration, baseP
8405
8807
  */
8406
8808
  listVirtualControllerTcps(cell: string, controller: string, motionGroup: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<RobotTcp>>;
8407
8809
  /**
8408
- * Activates or releases the Emergency Stop on the virtual robot controller. Activating the Emergency Stop stops the execution of all motions. The stop is executed on physical controllers immediately not gracefully and not on paths. Due to restricted physical behavior of the virtual robot controller, the Emergency Stop is executed on paths. To return to normal operation the Emergency Stop needs to be released. Use [getCurrentMotionGroupState](getCurrentMotionGroupState) to get the Emergency Stop state with `safety_state` regardless of the controller type. > **NOTE** > > The Emergency Stop state can only be changed via API when using virtual robot controllers.
8810
+ * Activates or releases the Emergency Stop on the virtual robot controller. Activating the Emergency Stop stops the execution of all motions. The stop is executed on physical controllers immediately not gracefully and not on paths. Due to restricted physical behavior of the virtual robot controller, the Emergency Stop is executed on paths. To return to normal operation the Emergency Stop needs to be released. Use [getCurrentMotionGroupState](#/operations/getCurrentMotionGroupState) to get the Emergency Stop state with `safety_state` regardless of the controller type. > **NOTE** > > The Emergency Stop state can only be changed via API when using virtual robot controllers.
8409
8811
  * @summary Push or Release Emergency Stop
8410
8812
  * @param {string} cell Unique identifier addressing a cell in all API calls.
8411
8813
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -8426,7 +8828,7 @@ declare const VirtualControllerApiFactory: (configuration?: Configuration, baseP
8426
8828
  */
8427
8829
  setMotionGroupState(cell: string, controller: string, motionGroup: string, motionGroupJoints: MotionGroupJoints, options?: RawAxiosRequestConfig): AxiosPromise<void>;
8428
8830
  /**
8429
- * Changes the operation mode of the virtual robot controller to the specified value. To get the operation mode regardless of the controller type, use [getCurrentMotionGroupState](getCurrentMotionGroupState). > **NOTE** > > The operation mode can only be changed via API when using virtual robot controllers.
8831
+ * Changes the operation mode of the virtual robot controller to the specified value. To get the operation mode regardless of the controller type, use [getCurrentMotionGroupState](#/operations/getCurrentMotionGroupState). > **NOTE** > > The operation mode can only be changed via API when using virtual robot controllers.
8430
8832
  * @summary Set Operation Mode
8431
8833
  * @param {string} cell Unique identifier addressing a cell in all API calls.
8432
8834
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -8462,6 +8864,16 @@ declare class VirtualControllerApi extends BaseAPI {
8462
8864
  * @throws {RequiredError}
8463
8865
  */
8464
8866
  addVirtualControllerCoordinateSystem(cell: string, controller: string, coordinateSystem: string, coordinateSystemData: CoordinateSystemData, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
8867
+ /**
8868
+ * Adds a motion group configuration for the virtual robot controller. Fields: - Only one of **motion_group_model** or **json_data** should be set. - **motion_group_model**: Identifies a single motion group. See [getMotionGroupModels](#/operations/getMotionGroupModels) for supported types. - **json_data**: Full JSON configuration of the virtual robot controller. This can be obtained from the physical controller\'s configuration via [getVirtualControllerConfiguration](#/operations/getVirtualControllerConfiguration). - **extracted_motion_group_id** (required when using json_data): The motion group identifier to extract from the provided JSON configuration. - **motion_group**: Unique identifier for the motion group to be added. - **initial_joint_position**: Specifies the initial joint position for the added motion group. <!-- theme: info --> > #### NOTE > > When a motion group is added, **the virtual robot is restarted** to apply the new configuration. > > During this restart: > - Robot visualization can temporarily disappear or appear outdated in the UI. > - Motion group changes are not immediately visible in visualizations. > - All connections to virtual robot are closed and re-established, which introduces a short delay before the system is fully operational again. > > The API call itself **does not wait until the restart and re-synchronization are complete**. > This means that immediately after a successful response, the new motion group may not yet be available for use.
8869
+ * @summary Add Motion Group
8870
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
8871
+ * @param {string} controller Unique identifier to address a controller in the cell.
8872
+ * @param {AddVirtualControllerMotionGroupRequest} addVirtualControllerMotionGroupRequest
8873
+ * @param {*} [options] Override http request option.
8874
+ * @throws {RequiredError}
8875
+ */
8876
+ addVirtualControllerMotionGroup(cell: string, controller: string, addVirtualControllerMotionGroupRequest: AddVirtualControllerMotionGroupRequest, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
8465
8877
  /**
8466
8878
  * Adds a new TCP or updates an existing TCP in the motion group. The position and rotation values in the request body are defined within the flange\'s coordinate system. > **NOTE** > > Ensure the TCP\'s position is within the robot\'s reach. Refer to the robot\'s documentation or data sheet for details like joint limits or reach. <!-- theme: info --> > #### NOTE > > When adding or updating a TCP, the **virtual robot is restarted** to apply the new configuration. > > During this restart: > - Robot visualization can temporarily disappear. > - The TCP may not be immediately visible or appear outdated in visualizations. > - All connections to virtual robot are closed and re-established, which introduces a short delay before the TCP is available for operation. > > The API call itself does **not wait until the restart and re-synchronization are complete**. > A successful response indicates that the request was accepted, but the TCP may not yet be visible nor usable.
8467
8879
  * @summary Add TCP
@@ -8485,6 +8897,16 @@ declare class VirtualControllerApi extends BaseAPI {
8485
8897
  * @throws {RequiredError}
8486
8898
  */
8487
8899
  deleteVirtualControllerCoordinateSystem(cell: string, controller: string, coordinateSystem: string, deleteDependent?: boolean, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
8900
+ /**
8901
+ * Removes a motion group configuration from the virtual controller. <!-- theme: info --> > #### NOTE > > When a motion group is removed, **the virtual robot is restarted** to apply the new configuration. > > During this restart: > - Robot visualization can temporarily disappear or appear outdated in the UI. > - Motion group changes are not immediately visible in visualizations. > - All connections to virtual robot are closed and re-established, which introduces a short delay before the system is fully operational again. > > The API call itself **does not wait until the restart and re-synchronization are complete**.
8902
+ * @summary Delete Motion Group
8903
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
8904
+ * @param {string} controller Unique identifier to address a controller in the cell.
8905
+ * @param {string} motionGroup The motion-group identifier.
8906
+ * @param {*} [options] Override http request option.
8907
+ * @throws {RequiredError}
8908
+ */
8909
+ deleteVirtualControllerMotionGroup(cell: string, controller: string, motionGroup: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
8488
8910
  /**
8489
8911
  * Removes the TCP (Tool Center Point) from the motion group. An unknown TCP is a valid input and will simply be ignored. <!-- theme: info --> > #### NOTE > > When removing a TCP, the **virtual robot is restarted** to apply the new configuration. > > During this restart: > - Robot visualization can temporarily disappear. > - The removal of the TCP may not be immediately visible or appear outdated in visualizations. > - All connections to virtual robot are closed and re-established, which introduces a short delay before the system is fully operational again. > > The API call itself does **not wait until the restart and re-synchronization are complete**. > A successful response indicates that the request was accepted, but the then used TCP may not yet be visible nor usable.
8490
8912
  * @summary Remove TCP
@@ -8497,7 +8919,7 @@ declare class VirtualControllerApi extends BaseAPI {
8497
8919
  */
8498
8920
  deleteVirtualControllerTcp(cell: string, controller: string, motionGroup: string, tcp: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
8499
8921
  /**
8500
- * Requests the Emergency Stop state of the virtual robot controller. Use [getCurrentMotionGroupState](getCurrentMotionGroupState) to get the Emergency Stop state with `safety_state` regardless of the controller type. > **NOTE** > > The Emergency Stop state can only be changed when using virtual robot controllers.
8922
+ * Requests the Emergency Stop state of the virtual robot controller. Use [getCurrentMotionGroupState](#/operations/getCurrentMotionGroupState) to get the Emergency Stop state with `safety_state` regardless of the controller type. > **NOTE** > > The Emergency Stop state can only be changed when using virtual robot controllers.
8501
8923
  * @summary Get Emergency Stop State
8502
8924
  * @param {string} cell Unique identifier addressing a cell in all API calls.
8503
8925
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -8525,7 +8947,7 @@ declare class VirtualControllerApi extends BaseAPI {
8525
8947
  */
8526
8948
  getMotionGroups(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<MotionGroupInfo[], any>>;
8527
8949
  /**
8528
- * Requests the operation mode of the virtual robot controller. To get the operation mode regardless of the controller type, use [getCurrentMotionGroupState](getCurrentMotionGroupState). > **NOTE** > > The operation mode can only be changed via API when using virtual robot controllers.
8950
+ * Requests the operation mode of the virtual robot controller. To get the operation mode regardless of the controller type, use [getCurrentMotionGroupState](#/operations/getCurrentMotionGroupState). > **NOTE** > > The operation mode can only be changed via API when using virtual robot controllers.
8529
8951
  * @summary Get Operation Mode
8530
8952
  * @param {string} cell Unique identifier addressing a cell in all API calls.
8531
8953
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -8563,7 +8985,7 @@ declare class VirtualControllerApi extends BaseAPI {
8563
8985
  */
8564
8986
  listVirtualControllerTcps(cell: string, controller: string, motionGroup: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<RobotTcp[], any>>;
8565
8987
  /**
8566
- * Activates or releases the Emergency Stop on the virtual robot controller. Activating the Emergency Stop stops the execution of all motions. The stop is executed on physical controllers immediately not gracefully and not on paths. Due to restricted physical behavior of the virtual robot controller, the Emergency Stop is executed on paths. To return to normal operation the Emergency Stop needs to be released. Use [getCurrentMotionGroupState](getCurrentMotionGroupState) to get the Emergency Stop state with `safety_state` regardless of the controller type. > **NOTE** > > The Emergency Stop state can only be changed via API when using virtual robot controllers.
8988
+ * Activates or releases the Emergency Stop on the virtual robot controller. Activating the Emergency Stop stops the execution of all motions. The stop is executed on physical controllers immediately not gracefully and not on paths. Due to restricted physical behavior of the virtual robot controller, the Emergency Stop is executed on paths. To return to normal operation the Emergency Stop needs to be released. Use [getCurrentMotionGroupState](#/operations/getCurrentMotionGroupState) to get the Emergency Stop state with `safety_state` regardless of the controller type. > **NOTE** > > The Emergency Stop state can only be changed via API when using virtual robot controllers.
8567
8989
  * @summary Push or Release Emergency Stop
8568
8990
  * @param {string} cell Unique identifier addressing a cell in all API calls.
8569
8991
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -8584,7 +9006,7 @@ declare class VirtualControllerApi extends BaseAPI {
8584
9006
  */
8585
9007
  setMotionGroupState(cell: string, controller: string, motionGroup: string, motionGroupJoints: MotionGroupJoints, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
8586
9008
  /**
8587
- * Changes the operation mode of the virtual robot controller to the specified value. To get the operation mode regardless of the controller type, use [getCurrentMotionGroupState](getCurrentMotionGroupState). > **NOTE** > > The operation mode can only be changed via API when using virtual robot controllers.
9009
+ * Changes the operation mode of the virtual robot controller to the specified value. To get the operation mode regardless of the controller type, use [getCurrentMotionGroupState](#/operations/getCurrentMotionGroupState). > **NOTE** > > The operation mode can only be changed via API when using virtual robot controllers.
8588
9010
  * @summary Set Operation Mode
8589
9011
  * @param {string} cell Unique identifier addressing a cell in all API calls.
8590
9012
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -8610,7 +9032,7 @@ declare class VirtualControllerApi extends BaseAPI {
8610
9032
  */
8611
9033
  declare const VirtualControllerBehaviorApiAxiosParamCreator: (configuration?: Configuration) => {
8612
9034
  /**
8613
- * <!-- theme: success --> > Websocket endpoint Sends the **commanded** state, e.g., joint positions, velocities, accelerations, torques, for each motion group of the virtual controller and sets the joint configuration. Use [planTrajectory](planTrajectory) and [executeTrajectory](executeTrajectory) to move motion groups on virtual controllers. Learn more about the [movement behavior of virtual controllers in comparison to physical controllers](executeTrajectory#movement-behavior). > **NOTE** > > Incoming joint configurations are not visualized and their velocity limits are not checked. #### Use cases 1. Creating a robotic application that dynamically adapts to the configured joints on the robot controller, using this stream to feed new joint configurations back to the motion groups.\\ The stream only sends data to the robot controller if a motion is executed.\\ If the robot controller\'s joint configuration differs too much from the incoming joint configuration, a following error occurs. Joint configurations that result in following errors are executed only for motions with a low velocity. 2. Mimic freedrive motions. <!-- theme: danger --> > **DANGER** > > If the incoming joint configuration is set to maximum velocity, the movement to reach this incoming joint configuration > will be executed with maximum speed regardless of safety zones and mechanical limits.
9035
+ * <!-- theme: success --> > Websocket endpoint Sends the **commanded** state, e.g., joint positions, velocities, accelerations, torques, for each motion group of the virtual controller and sets the joint configuration. Use [planTrajectory](#/operations/planTrajectory) and [executeTrajectory](#/operations/executeTrajectory) to move motion groups on virtual controllers. Learn more about the [movement behavior of virtual controllers in comparison to physical controllers](#/operations/executeTrajectory#movement-behavior). > **NOTE** > > Incoming joint configurations are not visualized and their velocity limits are not checked. #### Use cases 1. Creating a robotic application that dynamically adapts to the configured joints on the robot controller, using this stream to feed new joint configurations back to the motion groups.\\ The stream only sends data to the robot controller if a motion is executed.\\ If the robot controller\'s joint configuration differs too much from the incoming joint configuration, a following error occurs. Joint configurations that result in following errors are executed only for motions with a low velocity. 2. Mimic freedrive motions. <!-- theme: danger --> > **DANGER** > > If the incoming joint configuration is set to maximum velocity, the movement to reach this incoming joint configuration > will be executed with maximum speed regardless of safety zones and mechanical limits.
8614
9036
  * @summary Stream Joint Configuration
8615
9037
  * @param {string} cell Unique identifier addressing a cell in all API calls.
8616
9038
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -8629,7 +9051,7 @@ declare const VirtualControllerBehaviorApiAxiosParamCreator: (configuration?: Co
8629
9051
  */
8630
9052
  getCycleTime: (cell: string, controller: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
8631
9053
  /**
8632
- * Get the current virtual controller behavior. See [setVirtualControllerBehavior](setVirtualControllerBehavior) and the body for details.
9054
+ * Get the current virtual controller behavior. See [setVirtualControllerBehavior](#/operations/setVirtualControllerBehavior) and the body for details.
8633
9055
  * @summary Get Behavior
8634
9056
  * @param {string} cell Unique identifier addressing a cell in all API calls.
8635
9057
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -8653,7 +9075,7 @@ declare const VirtualControllerBehaviorApiAxiosParamCreator: (configuration?: Co
8653
9075
  */
8654
9076
  declare const VirtualControllerBehaviorApiFp: (configuration?: Configuration) => {
8655
9077
  /**
8656
- * <!-- theme: success --> > Websocket endpoint Sends the **commanded** state, e.g., joint positions, velocities, accelerations, torques, for each motion group of the virtual controller and sets the joint configuration. Use [planTrajectory](planTrajectory) and [executeTrajectory](executeTrajectory) to move motion groups on virtual controllers. Learn more about the [movement behavior of virtual controllers in comparison to physical controllers](executeTrajectory#movement-behavior). > **NOTE** > > Incoming joint configurations are not visualized and their velocity limits are not checked. #### Use cases 1. Creating a robotic application that dynamically adapts to the configured joints on the robot controller, using this stream to feed new joint configurations back to the motion groups.\\ The stream only sends data to the robot controller if a motion is executed.\\ If the robot controller\'s joint configuration differs too much from the incoming joint configuration, a following error occurs. Joint configurations that result in following errors are executed only for motions with a low velocity. 2. Mimic freedrive motions. <!-- theme: danger --> > **DANGER** > > If the incoming joint configuration is set to maximum velocity, the movement to reach this incoming joint configuration > will be executed with maximum speed regardless of safety zones and mechanical limits.
9078
+ * <!-- theme: success --> > Websocket endpoint Sends the **commanded** state, e.g., joint positions, velocities, accelerations, torques, for each motion group of the virtual controller and sets the joint configuration. Use [planTrajectory](#/operations/planTrajectory) and [executeTrajectory](#/operations/executeTrajectory) to move motion groups on virtual controllers. Learn more about the [movement behavior of virtual controllers in comparison to physical controllers](#/operations/executeTrajectory#movement-behavior). > **NOTE** > > Incoming joint configurations are not visualized and their velocity limits are not checked. #### Use cases 1. Creating a robotic application that dynamically adapts to the configured joints on the robot controller, using this stream to feed new joint configurations back to the motion groups.\\ The stream only sends data to the robot controller if a motion is executed.\\ If the robot controller\'s joint configuration differs too much from the incoming joint configuration, a following error occurs. Joint configurations that result in following errors are executed only for motions with a low velocity. 2. Mimic freedrive motions. <!-- theme: danger --> > **DANGER** > > If the incoming joint configuration is set to maximum velocity, the movement to reach this incoming joint configuration > will be executed with maximum speed regardless of safety zones and mechanical limits.
8657
9079
  * @summary Stream Joint Configuration
8658
9080
  * @param {string} cell Unique identifier addressing a cell in all API calls.
8659
9081
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -8672,7 +9094,7 @@ declare const VirtualControllerBehaviorApiFp: (configuration?: Configuration) =>
8672
9094
  */
8673
9095
  getCycleTime(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CycleTime>>;
8674
9096
  /**
8675
- * Get the current virtual controller behavior. See [setVirtualControllerBehavior](setVirtualControllerBehavior) and the body for details.
9097
+ * Get the current virtual controller behavior. See [setVirtualControllerBehavior](#/operations/setVirtualControllerBehavior) and the body for details.
8676
9098
  * @summary Get Behavior
8677
9099
  * @param {string} cell Unique identifier addressing a cell in all API calls.
8678
9100
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -8696,7 +9118,7 @@ declare const VirtualControllerBehaviorApiFp: (configuration?: Configuration) =>
8696
9118
  */
8697
9119
  declare const VirtualControllerBehaviorApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
8698
9120
  /**
8699
- * <!-- theme: success --> > Websocket endpoint Sends the **commanded** state, e.g., joint positions, velocities, accelerations, torques, for each motion group of the virtual controller and sets the joint configuration. Use [planTrajectory](planTrajectory) and [executeTrajectory](executeTrajectory) to move motion groups on virtual controllers. Learn more about the [movement behavior of virtual controllers in comparison to physical controllers](executeTrajectory#movement-behavior). > **NOTE** > > Incoming joint configurations are not visualized and their velocity limits are not checked. #### Use cases 1. Creating a robotic application that dynamically adapts to the configured joints on the robot controller, using this stream to feed new joint configurations back to the motion groups.\\ The stream only sends data to the robot controller if a motion is executed.\\ If the robot controller\'s joint configuration differs too much from the incoming joint configuration, a following error occurs. Joint configurations that result in following errors are executed only for motions with a low velocity. 2. Mimic freedrive motions. <!-- theme: danger --> > **DANGER** > > If the incoming joint configuration is set to maximum velocity, the movement to reach this incoming joint configuration > will be executed with maximum speed regardless of safety zones and mechanical limits.
9121
+ * <!-- theme: success --> > Websocket endpoint Sends the **commanded** state, e.g., joint positions, velocities, accelerations, torques, for each motion group of the virtual controller and sets the joint configuration. Use [planTrajectory](#/operations/planTrajectory) and [executeTrajectory](#/operations/executeTrajectory) to move motion groups on virtual controllers. Learn more about the [movement behavior of virtual controllers in comparison to physical controllers](#/operations/executeTrajectory#movement-behavior). > **NOTE** > > Incoming joint configurations are not visualized and their velocity limits are not checked. #### Use cases 1. Creating a robotic application that dynamically adapts to the configured joints on the robot controller, using this stream to feed new joint configurations back to the motion groups.\\ The stream only sends data to the robot controller if a motion is executed.\\ If the robot controller\'s joint configuration differs too much from the incoming joint configuration, a following error occurs. Joint configurations that result in following errors are executed only for motions with a low velocity. 2. Mimic freedrive motions. <!-- theme: danger --> > **DANGER** > > If the incoming joint configuration is set to maximum velocity, the movement to reach this incoming joint configuration > will be executed with maximum speed regardless of safety zones and mechanical limits.
8700
9122
  * @summary Stream Joint Configuration
8701
9123
  * @param {string} cell Unique identifier addressing a cell in all API calls.
8702
9124
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -8715,7 +9137,7 @@ declare const VirtualControllerBehaviorApiFactory: (configuration?: Configuratio
8715
9137
  */
8716
9138
  getCycleTime(cell: string, controller: string, options?: RawAxiosRequestConfig): AxiosPromise<CycleTime>;
8717
9139
  /**
8718
- * Get the current virtual controller behavior. See [setVirtualControllerBehavior](setVirtualControllerBehavior) and the body for details.
9140
+ * Get the current virtual controller behavior. See [setVirtualControllerBehavior](#/operations/setVirtualControllerBehavior) and the body for details.
8719
9141
  * @summary Get Behavior
8720
9142
  * @param {string} cell Unique identifier addressing a cell in all API calls.
8721
9143
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -8739,7 +9161,7 @@ declare const VirtualControllerBehaviorApiFactory: (configuration?: Configuratio
8739
9161
  */
8740
9162
  declare class VirtualControllerBehaviorApi extends BaseAPI {
8741
9163
  /**
8742
- * <!-- theme: success --> > Websocket endpoint Sends the **commanded** state, e.g., joint positions, velocities, accelerations, torques, for each motion group of the virtual controller and sets the joint configuration. Use [planTrajectory](planTrajectory) and [executeTrajectory](executeTrajectory) to move motion groups on virtual controllers. Learn more about the [movement behavior of virtual controllers in comparison to physical controllers](executeTrajectory#movement-behavior). > **NOTE** > > Incoming joint configurations are not visualized and their velocity limits are not checked. #### Use cases 1. Creating a robotic application that dynamically adapts to the configured joints on the robot controller, using this stream to feed new joint configurations back to the motion groups.\\ The stream only sends data to the robot controller if a motion is executed.\\ If the robot controller\'s joint configuration differs too much from the incoming joint configuration, a following error occurs. Joint configurations that result in following errors are executed only for motions with a low velocity. 2. Mimic freedrive motions. <!-- theme: danger --> > **DANGER** > > If the incoming joint configuration is set to maximum velocity, the movement to reach this incoming joint configuration > will be executed with maximum speed regardless of safety zones and mechanical limits.
9164
+ * <!-- theme: success --> > Websocket endpoint Sends the **commanded** state, e.g., joint positions, velocities, accelerations, torques, for each motion group of the virtual controller and sets the joint configuration. Use [planTrajectory](#/operations/planTrajectory) and [executeTrajectory](#/operations/executeTrajectory) to move motion groups on virtual controllers. Learn more about the [movement behavior of virtual controllers in comparison to physical controllers](#/operations/executeTrajectory#movement-behavior). > **NOTE** > > Incoming joint configurations are not visualized and their velocity limits are not checked. #### Use cases 1. Creating a robotic application that dynamically adapts to the configured joints on the robot controller, using this stream to feed new joint configurations back to the motion groups.\\ The stream only sends data to the robot controller if a motion is executed.\\ If the robot controller\'s joint configuration differs too much from the incoming joint configuration, a following error occurs. Joint configurations that result in following errors are executed only for motions with a low velocity. 2. Mimic freedrive motions. <!-- theme: danger --> > **DANGER** > > If the incoming joint configuration is set to maximum velocity, the movement to reach this incoming joint configuration > will be executed with maximum speed regardless of safety zones and mechanical limits.
8743
9165
  * @summary Stream Joint Configuration
8744
9166
  * @param {string} cell Unique identifier addressing a cell in all API calls.
8745
9167
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -8758,7 +9180,7 @@ declare class VirtualControllerBehaviorApi extends BaseAPI {
8758
9180
  */
8759
9181
  getCycleTime(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<CycleTime, any>>;
8760
9182
  /**
8761
- * Get the current virtual controller behavior. See [setVirtualControllerBehavior](setVirtualControllerBehavior) and the body for details.
9183
+ * Get the current virtual controller behavior. See [setVirtualControllerBehavior](#/operations/setVirtualControllerBehavior) and the body for details.
8762
9184
  * @summary Get Behavior
8763
9185
  * @param {string} cell Unique identifier addressing a cell in all API calls.
8764
9186
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -8782,7 +9204,7 @@ declare class VirtualControllerBehaviorApi extends BaseAPI {
8782
9204
  */
8783
9205
  declare const VirtualControllerInputsOutputsApiAxiosParamCreator: (configuration?: Configuration) => {
8784
9206
  /**
8785
- * Retrieves the current values of inputs/outputs of the virtual controller. The identifiers of inputs/outputs must be provided in the request. Request all available input/output identifiers via [listVirtualControllerIODescriptions](listVirtualControllerIODescriptions).
9207
+ * Retrieves the current values of inputs/outputs of the virtual controller. The identifiers of inputs/outputs must be provided in the request. Request all available input/output identifiers via [listVirtualControllerIODescriptions](#/operations/listVirtualControllerIODescriptions).
8786
9208
  * @summary Get Input/Output Values
8787
9209
  * @param {string} cell Unique identifier addressing a cell in all API calls.
8788
9210
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -8820,7 +9242,7 @@ declare const VirtualControllerInputsOutputsApiAxiosParamCreator: (configuration
8820
9242
  */
8821
9243
  declare const VirtualControllerInputsOutputsApiFp: (configuration?: Configuration) => {
8822
9244
  /**
8823
- * Retrieves the current values of inputs/outputs of the virtual controller. The identifiers of inputs/outputs must be provided in the request. Request all available input/output identifiers via [listVirtualControllerIODescriptions](listVirtualControllerIODescriptions).
9245
+ * Retrieves the current values of inputs/outputs of the virtual controller. The identifiers of inputs/outputs must be provided in the request. Request all available input/output identifiers via [listVirtualControllerIODescriptions](#/operations/listVirtualControllerIODescriptions).
8824
9246
  * @summary Get Input/Output Values
8825
9247
  * @param {string} cell Unique identifier addressing a cell in all API calls.
8826
9248
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -8858,7 +9280,7 @@ declare const VirtualControllerInputsOutputsApiFp: (configuration?: Configuratio
8858
9280
  */
8859
9281
  declare const VirtualControllerInputsOutputsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
8860
9282
  /**
8861
- * Retrieves the current values of inputs/outputs of the virtual controller. The identifiers of inputs/outputs must be provided in the request. Request all available input/output identifiers via [listVirtualControllerIODescriptions](listVirtualControllerIODescriptions).
9283
+ * Retrieves the current values of inputs/outputs of the virtual controller. The identifiers of inputs/outputs must be provided in the request. Request all available input/output identifiers via [listVirtualControllerIODescriptions](#/operations/listVirtualControllerIODescriptions).
8862
9284
  * @summary Get Input/Output Values
8863
9285
  * @param {string} cell Unique identifier addressing a cell in all API calls.
8864
9286
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -8896,7 +9318,7 @@ declare const VirtualControllerInputsOutputsApiFactory: (configuration?: Configu
8896
9318
  */
8897
9319
  declare class VirtualControllerInputsOutputsApi extends BaseAPI {
8898
9320
  /**
8899
- * Retrieves the current values of inputs/outputs of the virtual controller. The identifiers of inputs/outputs must be provided in the request. Request all available input/output identifiers via [listVirtualControllerIODescriptions](listVirtualControllerIODescriptions).
9321
+ * Retrieves the current values of inputs/outputs of the virtual controller. The identifiers of inputs/outputs must be provided in the request. Request all available input/output identifiers via [listVirtualControllerIODescriptions](#/operations/listVirtualControllerIODescriptions).
8900
9322
  * @summary Get Input/Output Values
8901
9323
  * @param {string} cell Unique identifier addressing a cell in all API calls.
8902
9324
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -8930,4 +9352,4 @@ declare class VirtualControllerInputsOutputsApi extends BaseAPI {
8930
9352
  setIOValues(cell: string, controller: string, iOValue: Array<IOValue>, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
8931
9353
  }
8932
9354
  //#endregion
8933
- export { AbbController, AbbControllerEgmServer, AbbControllerKindEnum, ActivateLicenseRequest, AddTrajectoryError, AddTrajectoryErrorData, AddTrajectoryRequest, AddTrajectoryResponse, ApiVersion, App, ApplicationApi, ApplicationApiAxiosParamCreator, ApplicationApiFactory, ApplicationApiFp, BASE_PATH, BUSInputsOutputsApi, BUSInputsOutputsApiAxiosParamCreator, BUSInputsOutputsApiFactory, BUSInputsOutputsApiFp, BaseAPI, Behavior, BlendingAuto, BlendingAutoBlendingNameEnum, BlendingPosition, BlendingPositionBlendingNameEnum, BlendingSpace, BooleanValue, BooleanValueValueTypeEnum, Box, BoxBoxTypeEnum, BoxShapeTypeEnum, BusIODescription, BusIOModbusClient, BusIOModbusClientBusTypeEnum, BusIOModbusServer, BusIOModbusServerBusTypeEnum, BusIOModbusTCPClient, BusIOModbusTCPClientNetworkTypeEnum, BusIOModbusTCPServer, BusIOModbusTCPServerNetworkTypeEnum, BusIOModbusVirtual, BusIOModbusVirtualBusTypeEnum, BusIOProfinet, BusIOProfinetBusTypeEnum, BusIOProfinetDefaultRoute, BusIOProfinetIpConfig, BusIOProfinetNetwork, BusIOProfinetVirtual, BusIOProfinetVirtualBusTypeEnum, BusIOType, BusIOsState, BusIOsStateEnum, COLLECTION_FORMATS, Capsule, CapsuleShapeTypeEnum, CartesianLimits, Cell, CellApi, CellApiAxiosParamCreator, CellApiFactory, CellApiFp, Collider, ColliderShape, Collision, CollisionContact, CollisionError, CollisionFreeAlgorithm, CollisionSetup, Comparator, Configuration, ConfigurationArchiveStatus, ConfigurationArchiveStatusCreating, ConfigurationArchiveStatusCreatingStatusEnum, ConfigurationArchiveStatusError, ConfigurationArchiveStatusErrorStatusEnum, ConfigurationArchiveStatusSuccess, ConfigurationArchiveStatusSuccessStatusEnum, ConfigurationParameters, ConfigurationResource, ContainerEnvironmentInner, ContainerImage, ContainerImageSecretsInner, ContainerResources, ContainerStorage, ControllerApi, ControllerApiAxiosParamCreator, ControllerApiFactory, ControllerApiFp, ControllerDescription, ControllerInputsOutputsApi, ControllerInputsOutputsApiAxiosParamCreator, ControllerInputsOutputsApiFactory, ControllerInputsOutputsApiFp, ConvexHull, ConvexHullShapeTypeEnum, CoordinateSystem, CoordinateSystemData, CubicSplineParameter, CycleTime, Cylinder, CylinderShapeTypeEnum, DHParameter, Direction, ErrorInvalidJointCount, ErrorInvalidJointCountErrorFeedbackNameEnum, ErrorJointLimitExceeded, ErrorJointLimitExceededErrorFeedbackNameEnum, ErrorJointPositionCollision, ErrorJointPositionCollisionErrorFeedbackNameEnum, ErrorMaxIterationsExceeded, ErrorMaxIterationsExceededErrorFeedbackNameEnum, Execute, ExecuteDetails, ExecuteJoggingRequest, ExecuteJoggingResponse, ExecuteTrajectoryRequest, ExecuteTrajectoryResponse, ExternalJointStreamDatapoint, ExternalJointStreamRequest, FanucController, FanucControllerKindEnum, FeedbackCollision, FeedbackCollisionErrorFeedbackNameEnum, FeedbackJointLimitExceeded, FeedbackJointLimitExceededErrorFeedbackNameEnum, FeedbackOutOfWorkspace, FeedbackOutOfWorkspaceErrorFeedbackNameEnum, FeedbackSingularity, FeedbackSingularityErrorFeedbackNameEnum, Flag, FloatValue, FloatValueValueTypeEnum, ForwardKinematics422Response, ForwardKinematicsRequest, ForwardKinematicsResponse, ForwardKinematicsValidationError, GetTrajectoryResponse, HTTPValidationError, IOBooleanValue, IOBooleanValueValueTypeEnum, IOBoundary, IODescription, IODirection, IOFloatValue, IOFloatValueValueTypeEnum, IOIntegerValue, IOIntegerValueValueTypeEnum, IOOrigin, IOValue, IOValueType, ImageCredentials, InconsistentTrajectorySizeError, InconsistentTrajectorySizeErrorInconsistentTrajectorySize, InitializeJoggingRequest, InitializeJoggingRequestMessageTypeEnum, InitializeJoggingResponse, InitializeJoggingResponseKindEnum, InitializeMovementRequest, InitializeMovementRequestMessageTypeEnum, InitializeMovementRequestTrajectory, InitializeMovementResponse, InitializeMovementResponseKindEnum, IntegerValue, IntegerValueValueTypeEnum, InvalidDofError, InvalidDofErrorInvalidDof, InverseKinematics422Response, InverseKinematicsRequest, InverseKinematicsResponse, InverseKinematicsValidationError, InverseKinematicsValidationErrorAllOfData, JoggingApi, JoggingApiAxiosParamCreator, JoggingApiFactory, JoggingApiFp, JoggingDetails, JoggingDetailsKindEnum, JoggingDetailsState, JoggingPausedByUser, JoggingPausedByUserKindEnum, JoggingPausedNearCollision, JoggingPausedNearCollisionKindEnum, JoggingPausedNearJointLimit, JoggingPausedNearJointLimitKindEnum, JoggingPausedOnIO, JoggingPausedOnIOKindEnum, JoggingRunning, JoggingRunningKindEnum, JointLimitExceededError, JointLimits, JointTrajectory, JointVelocityRequest, JointVelocityRequestMessageTypeEnum, JointVelocityResponse, JointVelocityResponseKindEnum, KinematicModel, KinematicsApi, KinematicsApiAxiosParamCreator, KinematicsApiFactory, KinematicsApiFp, KukaController, KukaControllerKindEnum, KukaControllerRsiServer, License, LicenseApi, LicenseApiAxiosParamCreator, LicenseApiFactory, LicenseApiFp, LicenseStatus, LicenseStatusEnum, LimitRange, LimitSet, LimitsOverride, ListTrajectoriesResponse, Manufacturer, MidpointInsertionAlgorithm, MidpointInsertionAlgorithmAlgorithmNameEnum, ModbusIO, ModbusIOArea, ModbusIOByteOrder, ModbusIOData, ModbusIOTypeEnum, ModelError, MotionCommand, MotionCommandBlending, MotionCommandPath, MotionGroupApi, MotionGroupApiAxiosParamCreator, MotionGroupApiFactory, MotionGroupApiFp, MotionGroupDescription, MotionGroupInfo, MotionGroupJoints, MotionGroupModelsApi, MotionGroupModelsApiAxiosParamCreator, MotionGroupModelsApiFactory, MotionGroupModelsApiFp, MotionGroupSetup, MotionGroupState, MotionGroupStateJointLimitReached, MovementErrorResponse, MovementErrorResponseKindEnum, NanValueError, NanValueErrorNanValue, NetworkDevice, NetworkInterface, NetworkState, NetworkStateConnectionTypeEnum, OpMode, OperatingState, OperationLimits, OperationMode, OrientationType, PathCartesianPTP, PathCartesianPTPPathDefinitionNameEnum, PathCircle, PathCirclePathDefinitionNameEnum, PathCubicSpline, PathCubicSplinePathDefinitionNameEnum, PathJointPTP, PathJointPTPPathDefinitionNameEnum, PathLine, PathLinePathDefinitionNameEnum, PauseJoggingRequest, PauseJoggingRequestMessageTypeEnum, PauseJoggingResponse, PauseJoggingResponseKindEnum, PauseMovementRequest, PauseMovementRequestMessageTypeEnum, PauseMovementResponse, PauseMovementResponseKindEnum, PauseOnIO, Payload, Plan422Response, PlanCollisionFreeFailedResponse, PlanCollisionFreeRequest, PlanCollisionFreeResponse, PlanCollisionFreeResponseResponse, PlanTrajectoryFailedResponse, PlanTrajectoryFailedResponseErrorFeedback, PlanTrajectoryRequest, PlanTrajectoryResponse, PlanTrajectoryResponseResponse, PlanValidationError, PlanValidationErrorAllOfData, Plane, PlaneShapeTypeEnum, PlaybackSpeedRequest, PlaybackSpeedRequestMessageTypeEnum, PlaybackSpeedResponse, PlaybackSpeedResponseKindEnum, Pose, ProfinetDescription, ProfinetIO, ProfinetIOData, ProfinetIODirection, ProfinetIOTypeEnum, ProfinetInputOutputConfig, ProfinetSlotDescription, ProfinetSubSlotDescription, Program, ProgramApi, ProgramApiAxiosParamCreator, ProgramApiFactory, ProgramApiFp, ProgramRun, ProgramRunState, ProgramStartRequest, RRTConnectAlgorithm, RRTConnectAlgorithmAlgorithmNameEnum, Rectangle, RectangleShapeTypeEnum, RectangularCapsule, RectangularCapsuleShapeTypeEnum, ReleaseChannel, RequestArgs, RequiredError, RobotConfigurationsApi, RobotConfigurationsApiAxiosParamCreator, RobotConfigurationsApiFactory, RobotConfigurationsApiFp, RobotController, RobotControllerConfiguration, RobotControllerState, RobotSystemMode, RobotTcp, RobotTcpData, SafetyStateType, ServiceGroup, ServiceStatus, ServiceStatusPhase, ServiceStatusResponse, ServiceStatusSeverity, ServiceStatusStatus, SetIO, SettableRobotSystemMode, SingularityTypeEnum, Sphere, SphereShapeTypeEnum, StartMovementRequest, StartMovementRequestMessageTypeEnum, StartMovementResponse, StartMovementResponseKindEnum, StartOnIO, StoreCollisionComponentsApi, StoreCollisionComponentsApiAxiosParamCreator, StoreCollisionComponentsApiFactory, StoreCollisionComponentsApiFp, StoreCollisionSetupsApi, StoreCollisionSetupsApiAxiosParamCreator, StoreCollisionSetupsApiFactory, StoreCollisionSetupsApiFp, StoreObjectApi, StoreObjectApiAxiosParamCreator, StoreObjectApiFactory, StoreObjectApiFp, StreamIOValuesResponse, SystemApi, SystemApiAxiosParamCreator, SystemApiFactory, SystemApiFp, TcpOffset, TcpRequiredError, TcpVelocityRequest, TcpVelocityRequestMessageTypeEnum, TcpVelocityResponse, TcpVelocityResponseKindEnum, TorqueExceededError, TorqueExceededErrorTorqueExceeded, TrajectoryCachingApi, TrajectoryCachingApiAxiosParamCreator, TrajectoryCachingApiFactory, TrajectoryCachingApiFp, TrajectoryData, TrajectoryDataMessageTypeEnum, TrajectoryDetails, TrajectoryDetailsKindEnum, TrajectoryDetailsState, TrajectoryEnded, TrajectoryEndedKindEnum, TrajectoryExecutionApi, TrajectoryExecutionApiAxiosParamCreator, TrajectoryExecutionApiFactory, TrajectoryExecutionApiFp, TrajectoryId, TrajectoryIdMessageTypeEnum, TrajectoryPausedByUser, TrajectoryPausedByUserKindEnum, TrajectoryPausedOnIO, TrajectoryPausedOnIOKindEnum, TrajectoryPlanningApi, TrajectoryPlanningApiAxiosParamCreator, TrajectoryPlanningApiFactory, TrajectoryPlanningApiFp, TrajectoryRunning, TrajectoryRunningKindEnum, TrajectoryWaitForIO, TrajectoryWaitForIOKindEnum, UnitType, UniversalrobotsController, UniversalrobotsControllerKindEnum, UpdateNovaVersionRequest, ValidationError, ValidationError2, ValidationErrorLocInner, VersionApi, VersionApiAxiosParamCreator, VersionApiFactory, VersionApiFp, VirtualController, VirtualControllerApi, VirtualControllerApiAxiosParamCreator, VirtualControllerApiFactory, VirtualControllerApiFp, VirtualControllerBehaviorApi, VirtualControllerBehaviorApiAxiosParamCreator, VirtualControllerBehaviorApiFactory, VirtualControllerBehaviorApiFp, VirtualControllerInputsOutputsApi, VirtualControllerInputsOutputsApiAxiosParamCreator, VirtualControllerInputsOutputsApiFactory, VirtualControllerInputsOutputsApiFp, VirtualControllerKindEnum, VirtualRobotConfiguration, WaitForIOEventRequest, YaskawaController, YaskawaControllerKindEnum, operationServerMap };
9355
+ export { AbbController, AbbControllerEgmServer, AbbControllerKindEnum, ActivateLicenseRequest, AddTrajectoryError, AddTrajectoryErrorData, AddTrajectoryRequest, AddTrajectoryResponse, AddVirtualControllerMotionGroupRequest, ApiVersion, App, ApplicationApi, ApplicationApiAxiosParamCreator, ApplicationApiFactory, ApplicationApiFp, BASE_PATH, BUSInputsOutputsApi, BUSInputsOutputsApiAxiosParamCreator, BUSInputsOutputsApiFactory, BUSInputsOutputsApiFp, BaseAPI, Behavior, BlendingAuto, BlendingAutoBlendingNameEnum, BlendingPosition, BlendingPositionBlendingNameEnum, BlendingSpace, BooleanValue, BooleanValueValueTypeEnum, Box, BoxBoxTypeEnum, BoxShapeTypeEnum, BusIODescription, BusIOModbusClient, BusIOModbusClientBusTypeEnum, BusIOModbusServer, BusIOModbusServerBusTypeEnum, BusIOModbusTCPClient, BusIOModbusTCPClientNetworkTypeEnum, BusIOModbusTCPServer, BusIOModbusTCPServerNetworkTypeEnum, BusIOModbusVirtual, BusIOModbusVirtualBusTypeEnum, BusIOProfinet, BusIOProfinetBusTypeEnum, BusIOProfinetDefaultRoute, BusIOProfinetIpConfig, BusIOProfinetNetwork, BusIOProfinetVirtual, BusIOProfinetVirtualBusTypeEnum, BusIOType, BusIOsState, BusIOsStateEnum, COLLECTION_FORMATS, Capsule, CapsuleShapeTypeEnum, CartesianLimits, Cell, CellApi, CellApiAxiosParamCreator, CellApiFactory, CellApiFp, Collider, ColliderShape, Collision, CollisionContact, CollisionError, CollisionErrorKindEnum, CollisionFreeAlgorithm, CollisionSetup, Comparator, Configuration, ConfigurationArchiveStatus, ConfigurationArchiveStatusCreating, ConfigurationArchiveStatusCreatingStatusEnum, ConfigurationArchiveStatusError, ConfigurationArchiveStatusErrorStatusEnum, ConfigurationArchiveStatusSuccess, ConfigurationArchiveStatusSuccessStatusEnum, ConfigurationParameters, ConfigurationResource, ContainerEnvironmentInner, ContainerImage, ContainerImageSecretsInner, ContainerResources, ContainerStorage, ControllerApi, ControllerApiAxiosParamCreator, ControllerApiFactory, ControllerApiFp, ControllerDescription, ControllerInputsOutputsApi, ControllerInputsOutputsApiAxiosParamCreator, ControllerInputsOutputsApiFactory, ControllerInputsOutputsApiFp, ConvexHull, ConvexHullShapeTypeEnum, CoordinateSystem, CoordinateSystemData, CubicSplineParameter, CycleTime, Cylinder, CylinderShapeTypeEnum, DHParameter, Direction, ErrorInvalidJointCount, ErrorInvalidJointCountErrorFeedbackNameEnum, ErrorJointLimitExceeded, ErrorJointLimitExceededErrorFeedbackNameEnum, ErrorJointPositionCollision, ErrorJointPositionCollisionErrorFeedbackNameEnum, ErrorMaxIterationsExceeded, ErrorMaxIterationsExceededErrorFeedbackNameEnum, Execute, ExecuteDetails, ExecuteJoggingRequest, ExecuteJoggingResponse, ExecuteTrajectoryRequest, ExecuteTrajectoryResponse, ExternalJointStreamDatapoint, ExternalJointStreamRequest, FanucController, FanucControllerKindEnum, FeedbackCollision, FeedbackCollisionErrorFeedbackNameEnum, FeedbackJointLimitExceeded, FeedbackJointLimitExceededErrorFeedbackNameEnum, FeedbackOutOfWorkspace, FeedbackOutOfWorkspaceErrorFeedbackNameEnum, FeedbackSingularity, FeedbackSingularityErrorFeedbackNameEnum, Flag, FloatValue, FloatValueValueTypeEnum, ForwardKinematics422Response, ForwardKinematicsRequest, ForwardKinematicsResponse, ForwardKinematicsValidationError, GetTrajectoryResponse, HTTPValidationError, IOBooleanValue, IOBooleanValueValueTypeEnum, IOBoundary, IODescription, IODirection, IOFloatValue, IOFloatValueValueTypeEnum, IOIntegerValue, IOIntegerValueValueTypeEnum, IOOrigin, IOValue, IOValueType, ImageCredentials, InconsistentTrajectorySizeError, InconsistentTrajectorySizeErrorInconsistentTrajectorySize, InconsistentTrajectorySizeErrorKindEnum, InitializeJoggingRequest, InitializeJoggingRequestMessageTypeEnum, InitializeJoggingResponse, InitializeJoggingResponseKindEnum, InitializeMovementRequest, InitializeMovementRequestMessageTypeEnum, InitializeMovementRequestTrajectory, InitializeMovementResponse, InitializeMovementResponseKindEnum, IntegerValue, IntegerValueValueTypeEnum, InvalidDofError, InvalidDofErrorInvalidDof, InvalidDofErrorKindEnum, InverseKinematics422Response, InverseKinematicsRequest, InverseKinematicsResponse, InverseKinematicsValidationError, InverseKinematicsValidationErrorAllOfData, JoggingApi, JoggingApiAxiosParamCreator, JoggingApiFactory, JoggingApiFp, JoggingDetails, JoggingDetailsKindEnum, JoggingDetailsState, JoggingPausedByUser, JoggingPausedByUserKindEnum, JoggingPausedNearCollision, JoggingPausedNearCollisionKindEnum, JoggingPausedNearJointLimit, JoggingPausedNearJointLimitKindEnum, JoggingPausedOnIO, JoggingPausedOnIOKindEnum, JoggingRunning, JoggingRunningKindEnum, JointLimitExceededError, JointLimitExceededErrorKindEnum, JointLimits, JointTrajectory, JointTypeEnum, JointVelocityRequest, JointVelocityRequestMessageTypeEnum, JointVelocityResponse, JointVelocityResponseKindEnum, KinematicModel, KinematicsApi, KinematicsApiAxiosParamCreator, KinematicsApiFactory, KinematicsApiFp, KukaController, KukaControllerKindEnum, KukaControllerRsiServer, License, LicenseApi, LicenseApiAxiosParamCreator, LicenseApiFactory, LicenseApiFp, LicenseStatus, LicenseStatusEnum, LimitRange, LimitSet, LimitsOverride, ListTrajectoriesResponse, Manufacturer, MergeTrajectories422Response, MergeTrajectoriesError, MergeTrajectoriesRequest, MergeTrajectoriesResponse, MergeTrajectoriesResponseFeedbackInner, MergeTrajectoriesSegment, MergeTrajectoriesValidationError, MidpointInsertionAlgorithm, MidpointInsertionAlgorithmAlgorithmNameEnum, ModbusIO, ModbusIOArea, ModbusIOByteOrder, ModbusIOData, ModbusIOTypeEnum, ModelError, MotionCommand, MotionCommandBlending, MotionCommandPath, MotionGroupApi, MotionGroupApiAxiosParamCreator, MotionGroupApiFactory, MotionGroupApiFp, MotionGroupDescription, MotionGroupFromJson, MotionGroupFromType, MotionGroupInfo, MotionGroupJoints, MotionGroupModelsApi, MotionGroupModelsApiAxiosParamCreator, MotionGroupModelsApiFactory, MotionGroupModelsApiFp, MotionGroupSetup, MotionGroupState, MotionGroupStateJointLimitReached, MovementErrorResponse, MovementErrorResponseKindEnum, NanValueError, NanValueErrorKindEnum, NanValueErrorNanValue, NetworkDevice, NetworkInterface, NetworkState, NetworkStateConnectionTypeEnum, OpMode, OperatingState, OperationLimits, OperationMode, OrientationType, PathCartesianPTP, PathCartesianPTPPathDefinitionNameEnum, PathCircle, PathCirclePathDefinitionNameEnum, PathCubicSpline, PathCubicSplinePathDefinitionNameEnum, PathJointPTP, PathJointPTPPathDefinitionNameEnum, PathLine, PathLinePathDefinitionNameEnum, PauseJoggingRequest, PauseJoggingRequestMessageTypeEnum, PauseJoggingResponse, PauseJoggingResponseKindEnum, PauseMovementRequest, PauseMovementRequestMessageTypeEnum, PauseMovementResponse, PauseMovementResponseKindEnum, PauseOnIO, Payload, Plan422Response, PlanCollisionFreeFailedResponse, PlanCollisionFreeRequest, PlanCollisionFreeResponse, PlanCollisionFreeResponseResponse, PlanTrajectoryFailedResponse, PlanTrajectoryFailedResponseErrorFeedback, PlanTrajectoryRequest, PlanTrajectoryResponse, PlanTrajectoryResponseResponse, PlanValidationError, PlanValidationErrorAllOfData, Plane, PlaneShapeTypeEnum, PlaybackSpeedRequest, PlaybackSpeedRequestMessageTypeEnum, PlaybackSpeedResponse, PlaybackSpeedResponseKindEnum, Pose, ProfinetDescription, ProfinetIO, ProfinetIOData, ProfinetIODirection, ProfinetIOTypeEnum, ProfinetInputOutputConfig, ProfinetSlotDescription, ProfinetSubSlotDescription, Program, ProgramApi, ProgramApiAxiosParamCreator, ProgramApiFactory, ProgramApiFp, ProgramRun, ProgramRunState, ProgramStartRequest, RRTConnectAlgorithm, RRTConnectAlgorithmAlgorithmNameEnum, Rectangle, RectangleShapeTypeEnum, RectangularCapsule, RectangularCapsuleShapeTypeEnum, ReleaseChannel, RequestArgs, RequiredError, RobotConfigurationsApi, RobotConfigurationsApiAxiosParamCreator, RobotConfigurationsApiFactory, RobotConfigurationsApiFp, RobotController, RobotControllerConfiguration, RobotControllerConfigurationRequest, RobotControllerState, RobotSystemMode, RobotTcp, RobotTcpData, SafetyStateType, ServiceGroup, ServiceStatus, ServiceStatusPhase, ServiceStatusResponse, ServiceStatusSeverity, ServiceStatusStatus, SetIO, SettableRobotSystemMode, SingularityTypeEnum, Sphere, SphereShapeTypeEnum, StartMovementRequest, StartMovementRequestMessageTypeEnum, StartMovementResponse, StartMovementResponseKindEnum, StartOnIO, StoreCollisionComponentsApi, StoreCollisionComponentsApiAxiosParamCreator, StoreCollisionComponentsApiFactory, StoreCollisionComponentsApiFp, StoreCollisionSetupsApi, StoreCollisionSetupsApiAxiosParamCreator, StoreCollisionSetupsApiFactory, StoreCollisionSetupsApiFp, StoreObjectApi, StoreObjectApiAxiosParamCreator, StoreObjectApiFactory, StoreObjectApiFp, StreamIOValuesResponse, SystemApi, SystemApiAxiosParamCreator, SystemApiFactory, SystemApiFp, TcpOffset, TcpRequiredError, TcpRequiredErrorKindEnum, TcpVelocityRequest, TcpVelocityRequestMessageTypeEnum, TcpVelocityResponse, TcpVelocityResponseKindEnum, TorqueExceededError, TorqueExceededErrorKindEnum, TorqueExceededErrorTorqueExceeded, TrajectoryCachingApi, TrajectoryCachingApiAxiosParamCreator, TrajectoryCachingApiFactory, TrajectoryCachingApiFp, TrajectoryData, TrajectoryDataMessageTypeEnum, TrajectoryDetails, TrajectoryDetailsKindEnum, TrajectoryDetailsState, TrajectoryEnded, TrajectoryEndedKindEnum, TrajectoryExecutionApi, TrajectoryExecutionApiAxiosParamCreator, TrajectoryExecutionApiFactory, TrajectoryExecutionApiFp, TrajectoryId, TrajectoryIdMessageTypeEnum, TrajectoryPausedByUser, TrajectoryPausedByUserKindEnum, TrajectoryPausedOnIO, TrajectoryPausedOnIOKindEnum, TrajectoryPlanningApi, TrajectoryPlanningApiAxiosParamCreator, TrajectoryPlanningApiFactory, TrajectoryPlanningApiFp, TrajectoryRunning, TrajectoryRunningKindEnum, TrajectorySection, TrajectoryWaitForIO, TrajectoryWaitForIOKindEnum, UnitType, UniversalrobotsController, UniversalrobotsControllerKindEnum, UpdateCellVersionRequest, UpdateNovaVersionRequest, ValidationError, ValidationError2, ValidationErrorLocInner, VersionApi, VersionApiAxiosParamCreator, VersionApiFactory, VersionApiFp, VirtualController, VirtualControllerApi, VirtualControllerApiAxiosParamCreator, VirtualControllerApiFactory, VirtualControllerApiFp, VirtualControllerBehaviorApi, VirtualControllerBehaviorApiAxiosParamCreator, VirtualControllerBehaviorApiFactory, VirtualControllerBehaviorApiFp, VirtualControllerInputsOutputsApi, VirtualControllerInputsOutputsApiAxiosParamCreator, VirtualControllerInputsOutputsApiFactory, VirtualControllerInputsOutputsApiFp, VirtualControllerKindEnum, VirtualRobotConfiguration, WaitForIOEventRequest, YaskawaController, YaskawaControllerKindEnum, operationServerMap };