@wandelbots/nova-api 26.2.0-dev.6 → 26.2.0-dev.61

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 dev
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
  }
@@ -1833,11 +1886,11 @@ type MotionCommandBlending = BlendingAuto | BlendingPosition;
1833
1886
  */
1834
1887
  type MotionCommandPath = PathCartesianPTP | PathCircle | PathCubicSpline | PathJointPTP | PathLine;
1835
1888
  /**
1836
- * The configuration of a motion-group used for motion planning.
1889
+ * 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
1890
  */
1838
1891
  interface MotionGroupDescription {
1839
1892
  /**
1840
- * String identifiying the model of a motion group.
1893
+ * Identifies a single motion group model. See [getMotionGroupModels](#/operations/getMotionGroupModels) for supported types.
1841
1894
  */
1842
1895
  'motion_group_model': string;
1843
1896
  /**
@@ -1882,14 +1935,50 @@ interface MotionGroupDescription {
1882
1935
  */
1883
1936
  'cycle_time'?: number;
1884
1937
  /**
1885
- * The DH parameters describing the motion group geometry, starting from base.
1938
+ * The Denavit-Hartenberg parameters describing the motion group kinematics.
1886
1939
  */
1887
1940
  'dh_parameters'?: Array<DHParameter>;
1941
+ /**
1942
+ * 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.
1943
+ */
1944
+ 'kinematic_chain_offset'?: Pose;
1888
1945
  /**
1889
1946
  * The serial number of the motion group, if available. If not available, the serial number of the robot controller. If not available, empty.
1890
1947
  */
1891
1948
  'serial_number'?: string;
1892
1949
  }
1950
+ interface MotionGroupFromJson {
1951
+ /**
1952
+ * Unique identifier for the motion group to be added.
1953
+ */
1954
+ 'motion_group': string;
1955
+ /**
1956
+ * Full JSON configuration of the virtual robot controller. This can be obtained from the physical controller\'s configuration via [getVirtualControllerConfiguration](#/operations/getVirtualControllerConfiguration).
1957
+ */
1958
+ 'json': string;
1959
+ /**
1960
+ * The identifier of the motion group that needs to be extracted from the provided JSON configuration.
1961
+ */
1962
+ 'extracted_motion_group_id': string;
1963
+ /**
1964
+ * 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.
1965
+ */
1966
+ 'initial_joint_position'?: string;
1967
+ }
1968
+ interface MotionGroupFromType {
1969
+ /**
1970
+ * Unique identifier for the motion group to be added.
1971
+ */
1972
+ 'motion_group': string;
1973
+ /**
1974
+ * Identifies a single motion group model. See [getMotionGroupModels](#/operations/getMotionGroupModels) for supported types.
1975
+ */
1976
+ 'motion_group_model': string;
1977
+ /**
1978
+ * 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.
1979
+ */
1980
+ 'initial_joint_position'?: string;
1981
+ }
1893
1982
  interface MotionGroupInfo {
1894
1983
  /**
1895
1984
  * The unique identifier of the motion group. Use it to refer to the motion group in other calls.
@@ -1905,7 +1994,7 @@ interface MotionGroupInfo {
1905
1994
  'dof': number;
1906
1995
  }
1907
1996
  /**
1908
- * Ensure to provide one value for each joint. See [getMotionGroups](getMotionGroups) for the number of joints. Everything but positions is optional.
1997
+ * Ensure to provide one value for each joint. See [getMotionGroups](#/operations/getMotionGroups) for the number of joints. Everything but positions is optional.
1909
1998
  */
1910
1999
  interface MotionGroupJoints {
1911
2000
  /**
@@ -1927,7 +2016,7 @@ interface MotionGroupJoints {
1927
2016
  }
1928
2017
  interface MotionGroupSetup {
1929
2018
  /**
1930
- * String identifiying the model of a motion group.
2019
+ * Identifies a single motion group model. See [getMotionGroupModels](#/operations/getMotionGroupModels) for supported types.
1931
2020
  */
1932
2021
  'motion_group_model': string;
1933
2022
  /**
@@ -1985,7 +2074,7 @@ interface MotionGroupState {
1985
2074
  */
1986
2075
  'joint_current'?: Array<number>;
1987
2076
  /**
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.
2077
+ * 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
2078
  */
1990
2079
  'flange_pose'?: Pose;
1991
2080
  /**
@@ -1993,7 +2082,7 @@ interface MotionGroupState {
1993
2082
  */
1994
2083
  'tcp'?: string;
1995
2084
  /**
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.
2085
+ * 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
2086
  */
1998
2087
  'tcp_pose'?: Pose;
1999
2088
  /**
@@ -2037,8 +2126,13 @@ declare const MovementErrorResponseKindEnum: {
2037
2126
  };
2038
2127
  type MovementErrorResponseKindEnum = typeof MovementErrorResponseKindEnum[keyof typeof MovementErrorResponseKindEnum];
2039
2128
  interface NanValueError {
2129
+ 'kind': NanValueErrorKindEnum;
2040
2130
  'nan_value'?: NanValueErrorNanValue;
2041
2131
  }
2132
+ declare const NanValueErrorKindEnum: {
2133
+ readonly NanValueError: "NanValueError";
2134
+ };
2135
+ type NanValueErrorKindEnum = typeof NanValueErrorKindEnum[keyof typeof NanValueErrorKindEnum];
2042
2136
  /**
2043
2137
  * Requested joint position contains NaN values.
2044
2138
  */
@@ -2279,11 +2373,11 @@ declare const PauseMovementRequestMessageTypeEnum: {
2279
2373
  };
2280
2374
  type PauseMovementRequestMessageTypeEnum = typeof PauseMovementRequestMessageTypeEnum[keyof typeof PauseMovementRequestMessageTypeEnum];
2281
2375
  /**
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).
2376
+ * 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
2377
  */
2284
2378
  interface PauseMovementResponse {
2285
2379
  /**
2286
- * Error message in case of invalid PauseMovementResquest.
2380
+ * Error message in case of invalid PauseMovementRequest.
2287
2381
  */
2288
2382
  'message'?: string;
2289
2383
  'kind': PauseMovementResponseKindEnum;
@@ -2329,7 +2423,7 @@ interface PlanCollisionFreeFailedResponse {
2329
2423
  }
2330
2424
  interface PlanCollisionFreeRequest {
2331
2425
  /**
2332
- * The data to assemble the robot setup can be retrieved from [getMotionGroupDescription](getMotionGroupDescription) endpoint.
2426
+ * The data to assemble the robot setup can be retrieved from the [getMotionGroupDescription](#/operations/getMotionGroupDescription) endpoint.
2333
2427
  */
2334
2428
  'motion_group_setup': MotionGroupSetup;
2335
2429
  'start_joint_position': Array<number>;
@@ -2349,7 +2443,7 @@ type PlanCollisionFreeResponseResponse = JointTrajectory | PlanCollisionFreeFail
2349
2443
  interface PlanTrajectoryFailedResponse {
2350
2444
  'error_feedback': PlanTrajectoryFailedResponseErrorFeedback;
2351
2445
  /**
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
2446
+ * - 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
2447
  */
2354
2448
  'error_location_on_trajectory': number;
2355
2449
  /**
@@ -2363,7 +2457,7 @@ interface PlanTrajectoryFailedResponse {
2363
2457
  type PlanTrajectoryFailedResponseErrorFeedback = FeedbackCollision | FeedbackJointLimitExceeded | FeedbackOutOfWorkspace | FeedbackSingularity;
2364
2458
  interface PlanTrajectoryRequest {
2365
2459
  /**
2366
- * The data to assemble the robot setup can be retrieved from [getMotionGroupDescription](getMotionGroupDescription) endpoint.
2460
+ * The data to assemble the robot setup can be retrieved from [getMotionGroupDescription](#/operations/getMotionGroupDescription) endpoint.
2367
2461
  */
2368
2462
  'motion_group_setup': MotionGroupSetup;
2369
2463
  'start_joint_position': Array<number>;
@@ -2730,7 +2824,7 @@ declare const RectangularCapsuleShapeTypeEnum: {
2730
2824
  };
2731
2825
  type RectangularCapsuleShapeTypeEnum = typeof RectangularCapsuleShapeTypeEnum[keyof typeof RectangularCapsuleShapeTypeEnum];
2732
2826
  /**
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
2827
+ * The channel that defines what a new Wandelbots NOVA version is. * `next` the latest version * `stable` newest patch of the current version
2734
2828
  */
2735
2829
  declare const ReleaseChannel: {
2736
2830
  readonly Stable: "stable";
@@ -2787,7 +2881,7 @@ interface RobotControllerState {
2787
2881
  'motion_groups': Array<MotionGroupState>;
2788
2882
  }
2789
2883
  /**
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.
2884
+ * 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
2885
  */
2792
2886
  declare const RobotSystemMode: {
2793
2887
  readonly ModeControllerNotConfigured: "MODE_CONTROLLER_NOT_CONFIGURED";
@@ -2911,9 +3005,14 @@ interface SetIO {
2911
3005
  'location': number;
2912
3006
  'io_origin': IOOrigin;
2913
3007
  }
3008
+ /**
3009
+ * Defines available system modes of the robot system. Short versions (no \"ROBOT_SYSTEM_\" prefix) are provided, reusing strings from [getMode](#/operations/getMode) responses.
3010
+ */
2914
3011
  declare const SettableRobotSystemMode: {
2915
3012
  readonly RobotSystemModeMonitor: "ROBOT_SYSTEM_MODE_MONITOR";
3013
+ readonly ModeMonitor: "MODE_MONITOR";
2916
3014
  readonly RobotSystemModeControl: "ROBOT_SYSTEM_MODE_CONTROL";
3015
+ readonly ModeControl: "MODE_CONTROL";
2917
3016
  };
2918
3017
  type SettableRobotSystemMode = typeof SettableRobotSystemMode[keyof typeof SettableRobotSystemMode];
2919
3018
  declare const SingularityTypeEnum: {
@@ -2937,7 +3036,7 @@ declare const SphereShapeTypeEnum: {
2937
3036
  };
2938
3037
  type SphereShapeTypeEnum = typeof SphereShapeTypeEnum[keyof typeof SphereShapeTypeEnum];
2939
3038
  /**
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.
3039
+ * 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
3040
  */
2942
3041
  interface StartMovementRequest {
2943
3042
  /**
@@ -2946,7 +3045,7 @@ interface StartMovementRequest {
2946
3045
  'message_type': StartMovementRequestMessageTypeEnum;
2947
3046
  'direction'?: Direction;
2948
3047
  /**
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
3048
+ * - 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
3049
  */
2951
3050
  'target_location'?: number;
2952
3051
  /**
@@ -2967,7 +3066,7 @@ declare const StartMovementRequestMessageTypeEnum: {
2967
3066
  };
2968
3067
  type StartMovementRequestMessageTypeEnum = typeof StartMovementRequestMessageTypeEnum[keyof typeof StartMovementRequestMessageTypeEnum];
2969
3068
  /**
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.
3069
+ * 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
3070
  */
2972
3071
  interface StartMovementResponse {
2973
3072
  /**
@@ -3016,10 +3115,15 @@ interface TcpOffset {
3016
3115
  * Requested motion group requires TCP to be defined.
3017
3116
  */
3018
3117
  interface TcpRequiredError {
3118
+ 'kind': TcpRequiredErrorKindEnum;
3019
3119
  'tcp_missing'?: any;
3020
3120
  }
3121
+ declare const TcpRequiredErrorKindEnum: {
3122
+ readonly TcpRequiredError: "TcpRequiredError";
3123
+ };
3124
+ type TcpRequiredErrorKindEnum = typeof TcpRequiredErrorKindEnum[keyof typeof TcpRequiredErrorKindEnum];
3021
3125
  /**
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.
3126
+ * 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
3127
  */
3024
3128
  interface TcpVelocityRequest {
3025
3129
  /**
@@ -3058,8 +3162,13 @@ declare const TcpVelocityResponseKindEnum: {
3058
3162
  };
3059
3163
  type TcpVelocityResponseKindEnum = typeof TcpVelocityResponseKindEnum[keyof typeof TcpVelocityResponseKindEnum];
3060
3164
  interface TorqueExceededError {
3165
+ 'kind': TorqueExceededErrorKindEnum;
3061
3166
  'torque_exceeded'?: TorqueExceededErrorTorqueExceeded;
3062
3167
  }
3168
+ declare const TorqueExceededErrorKindEnum: {
3169
+ readonly TorqueExceededError: "TorqueExceededError";
3170
+ };
3171
+ type TorqueExceededErrorKindEnum = typeof TorqueExceededErrorKindEnum[keyof typeof TorqueExceededErrorKindEnum];
3063
3172
  interface TorqueExceededErrorTorqueExceeded {
3064
3173
  /**
3065
3174
  * The torque value that was exceeded.
@@ -3101,7 +3210,7 @@ interface TrajectoryDetails {
3101
3210
  */
3102
3211
  'trajectory': string;
3103
3212
  /**
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
3213
+ * - 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
3214
  */
3106
3215
  'location': number;
3107
3216
  'state': TrajectoryDetailsState;
@@ -3144,7 +3253,7 @@ interface TrajectoryId {
3144
3253
  */
3145
3254
  'message_type': TrajectoryIdMessageTypeEnum;
3146
3255
  /**
3147
- * The identifier of the trajectory which was returned by the [addTrajectory](addTrajectory) endpoint.
3256
+ * The identifier of the trajectory which was returned by the [addTrajectory](#/operations/addTrajectory) endpoint.
3148
3257
  */
3149
3258
  'id': string;
3150
3259
  }
@@ -3223,11 +3332,21 @@ declare const UniversalrobotsControllerKindEnum: {
3223
3332
  readonly UniversalrobotsController: "UniversalrobotsController";
3224
3333
  };
3225
3334
  type UniversalrobotsControllerKindEnum = typeof UniversalrobotsControllerKindEnum[keyof typeof UniversalrobotsControllerKindEnum];
3335
+ /**
3336
+ * Update a single cell\'s Foundation chart version based on the indicated release channel.
3337
+ */
3338
+ interface UpdateCellVersionRequest {
3339
+ 'channel': ReleaseChannel;
3340
+ }
3226
3341
  /**
3227
3342
  * An update is defined by the indicated Wandelbots NOVA release channel.
3228
3343
  */
3229
3344
  interface UpdateNovaVersionRequest {
3230
3345
  'channel': ReleaseChannel;
3346
+ /**
3347
+ * Update unpinned cells during system update. Cells with an explicit chart version are never updated by a system update, regardless of this setting.
3348
+ */
3349
+ 'update_cells'?: boolean;
3231
3350
  }
3232
3351
  interface ValidationError {
3233
3352
  'loc': Array<ValidationErrorLocInner>;
@@ -3250,17 +3369,17 @@ interface ValidationError2 {
3250
3369
  */
3251
3370
  type ValidationErrorLocInner = number | string;
3252
3371
  /**
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.
3372
+ * 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
3373
  */
3255
3374
  interface VirtualController {
3256
3375
  'kind': VirtualControllerKindEnum;
3257
3376
  'manufacturer': Manufacturer;
3258
3377
  /**
3259
- * Preset type of the virtual robot controller. See [getRobotConfigurations](getRobotConfigurations) for supported types.
3378
+ * Preset type of the virtual robot controller. See [getRobotConfigurations](#/operations/getRobotConfigurations) for supported types.
3260
3379
  */
3261
3380
  'type'?: string;
3262
3381
  /**
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.
3382
+ * 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
3383
  */
3265
3384
  'json'?: string;
3266
3385
  /**
@@ -3278,7 +3397,7 @@ interface VirtualRobotConfiguration {
3278
3397
  */
3279
3398
  'name': string;
3280
3399
  /**
3281
- * Content of the configuration file. Copy & paste to the [addRobotController](addRobotController) configuration.json parameter.
3400
+ * Content of the configuration file. Copy & paste to the [addRobotController](#/operations/addRobotController) configuration.json parameter.
3282
3401
  */
3283
3402
  'content': string;
3284
3403
  }
@@ -3337,7 +3456,7 @@ declare const ApplicationApiAxiosParamCreator: (configuration?: Configuration) =
3337
3456
  */
3338
3457
  deleteApp: (cell: string, app: string, completionTimeout?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
3339
3458
  /**
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).
3459
+ * 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
3460
  * @summary Configuration
3342
3461
  * @param {string} cell Unique identifier addressing a cell in all API calls.
3343
3462
  * @param {string} app
@@ -3346,7 +3465,7 @@ declare const ApplicationApiAxiosParamCreator: (configuration?: Configuration) =
3346
3465
  */
3347
3466
  getApp: (cell: string, app: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
3348
3467
  /**
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.
3468
+ * 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
3469
  * @summary List Applications
3351
3470
  * @param {string} cell Unique identifier addressing a cell in all API calls.
3352
3471
  * @param {*} [options] Override http request option.
@@ -3399,7 +3518,7 @@ declare const ApplicationApiFp: (configuration?: Configuration) => {
3399
3518
  */
3400
3519
  deleteApp(cell: string, app: string, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
3401
3520
  /**
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).
3521
+ * 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
3522
  * @summary Configuration
3404
3523
  * @param {string} cell Unique identifier addressing a cell in all API calls.
3405
3524
  * @param {string} app
@@ -3408,7 +3527,7 @@ declare const ApplicationApiFp: (configuration?: Configuration) => {
3408
3527
  */
3409
3528
  getApp(cell: string, app: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<App>>;
3410
3529
  /**
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.
3530
+ * 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
3531
  * @summary List Applications
3413
3532
  * @param {string} cell Unique identifier addressing a cell in all API calls.
3414
3533
  * @param {*} [options] Override http request option.
@@ -3461,7 +3580,7 @@ declare const ApplicationApiFactory: (configuration?: Configuration, basePath?:
3461
3580
  */
3462
3581
  deleteApp(cell: string, app: string, completionTimeout?: number, options?: RawAxiosRequestConfig): AxiosPromise<void>;
3463
3582
  /**
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).
3583
+ * 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
3584
  * @summary Configuration
3466
3585
  * @param {string} cell Unique identifier addressing a cell in all API calls.
3467
3586
  * @param {string} app
@@ -3470,7 +3589,7 @@ declare const ApplicationApiFactory: (configuration?: Configuration, basePath?:
3470
3589
  */
3471
3590
  getApp(cell: string, app: string, options?: RawAxiosRequestConfig): AxiosPromise<App>;
3472
3591
  /**
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.
3592
+ * 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
3593
  * @summary List Applications
3475
3594
  * @param {string} cell Unique identifier addressing a cell in all API calls.
3476
3595
  * @param {*} [options] Override http request option.
@@ -3523,7 +3642,7 @@ declare class ApplicationApi extends BaseAPI {
3523
3642
  */
3524
3643
  deleteApp(cell: string, app: string, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
3525
3644
  /**
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).
3645
+ * 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
3646
  * @summary Configuration
3528
3647
  * @param {string} cell Unique identifier addressing a cell in all API calls.
3529
3648
  * @param {string} app
@@ -3532,7 +3651,7 @@ declare class ApplicationApi extends BaseAPI {
3532
3651
  */
3533
3652
  getApp(cell: string, app: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<App, any>>;
3534
3653
  /**
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.
3654
+ * 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
3655
  * @summary List Applications
3537
3656
  * @param {string} cell Unique identifier addressing a cell in all API calls.
3538
3657
  * @param {*} [options] Override http request option.
@@ -3566,7 +3685,7 @@ declare const BUSInputsOutputsApiAxiosParamCreator: (configuration?: Configurati
3566
3685
  */
3567
3686
  addBusIOService: (cell: string, busIOType: BusIOType, completionTimeout?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
3568
3687
  /**
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).
3688
+ * 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
3689
  * @summary Add MODBUS Input/Output
3571
3690
  * @param {string} cell Unique identifier addressing a cell in all API calls.
3572
3691
  * @param {string} io Unique identifier to address an Input/Output in the cell.
@@ -3576,7 +3695,7 @@ declare const BUSInputsOutputsApiAxiosParamCreator: (configuration?: Configurati
3576
3695
  */
3577
3696
  addModbusIO: (cell: string, io: string, modbusIOData: ModbusIOData, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
3578
3697
  /**
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).
3698
+ * 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
3699
  * @summary Add PROFINET Input/Output
3581
3700
  * @param {string} cell Unique identifier addressing a cell in all API calls.
3582
3701
  * @param {string} io Unique identifier to address an Input/Output in the cell.
@@ -3612,7 +3731,7 @@ declare const BUSInputsOutputsApiAxiosParamCreator: (configuration?: Configurati
3612
3731
  deleteAllProfinetIOs: (cell: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
3613
3732
  /**
3614
3733
  * Removes an input/output variable configuration from the MODBUS device, e.g., NOVA\'s MODBUS service.
3615
- * @summary Remove MODBUS Input/Ouptut
3734
+ * @summary Remove MODBUS Input/Output
3616
3735
  * @param {string} cell Unique identifier addressing a cell in all API calls.
3617
3736
  * @param {string} io Unique identifier to address an Input/Output in the cell.
3618
3737
  * @param {*} [options] Override http request option.
@@ -3645,7 +3764,7 @@ declare const BUSInputsOutputsApiAxiosParamCreator: (configuration?: Configurati
3645
3764
  */
3646
3765
  getBusIOState: (cell: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
3647
3766
  /**
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).
3767
+ * 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
3768
  * @summary Get Input/Output Values
3650
3769
  * @param {string} cell Unique identifier addressing a cell in all API calls.
3651
3770
  * @param {Array<string>} [ios]
@@ -3680,7 +3799,7 @@ declare const BUSInputsOutputsApiAxiosParamCreator: (configuration?: Configurati
3680
3799
  */
3681
3800
  listBusIODescriptions: (cell: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
3682
3801
  /**
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).
3802
+ * 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
3803
  * @summary List MODBUS Input/Output Configuration
3685
3804
  * @param {string} cell Unique identifier addressing a cell in all API calls.
3686
3805
  * @param {*} [options] Override http request option.
@@ -3688,7 +3807,7 @@ declare const BUSInputsOutputsApiAxiosParamCreator: (configuration?: Configurati
3688
3807
  */
3689
3808
  listModbusIOs: (cell: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
3690
3809
  /**
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.
3810
+ * 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
3811
  * @summary List PROFINET Input/Output Configuration
3693
3812
  * @param {string} cell Unique identifier addressing a cell in all API calls.
3694
3813
  * @param {*} [options] Override http request option.
@@ -3696,7 +3815,7 @@ declare const BUSInputsOutputsApiAxiosParamCreator: (configuration?: Configurati
3696
3815
  */
3697
3816
  listProfinetIOs: (cell: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
3698
3817
  /**
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.
3818
+ * 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
3819
  * @summary Set Output Values
3701
3820
  * @param {string} cell Unique identifier addressing a cell in all API calls.
3702
3821
  * @param {Array<IOValue>} iOValue
@@ -3705,7 +3824,7 @@ declare const BUSInputsOutputsApiAxiosParamCreator: (configuration?: Configurati
3705
3824
  */
3706
3825
  setBusIOValues: (cell: string, iOValue: Array<IOValue>, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
3707
3826
  /**
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.
3827
+ * 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
3828
  * @summary Set PROFINET Inputs/Outputs from File
3710
3829
  * @param {string} cell Unique identifier addressing a cell in all API calls.
3711
3830
  * @param {ProfinetInputOutputConfig} profinetInputOutputConfig
@@ -3729,7 +3848,7 @@ declare const BUSInputsOutputsApiFp: (configuration?: Configuration) => {
3729
3848
  */
3730
3849
  addBusIOService(cell: string, busIOType: BusIOType, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
3731
3850
  /**
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).
3851
+ * 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
3852
  * @summary Add MODBUS Input/Output
3734
3853
  * @param {string} cell Unique identifier addressing a cell in all API calls.
3735
3854
  * @param {string} io Unique identifier to address an Input/Output in the cell.
@@ -3739,7 +3858,7 @@ declare const BUSInputsOutputsApiFp: (configuration?: Configuration) => {
3739
3858
  */
3740
3859
  addModbusIO(cell: string, io: string, modbusIOData: ModbusIOData, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
3741
3860
  /**
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).
3861
+ * 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
3862
  * @summary Add PROFINET Input/Output
3744
3863
  * @param {string} cell Unique identifier addressing a cell in all API calls.
3745
3864
  * @param {string} io Unique identifier to address an Input/Output in the cell.
@@ -3775,7 +3894,7 @@ declare const BUSInputsOutputsApiFp: (configuration?: Configuration) => {
3775
3894
  deleteAllProfinetIOs(cell: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
3776
3895
  /**
3777
3896
  * Removes an input/output variable configuration from the MODBUS device, e.g., NOVA\'s MODBUS service.
3778
- * @summary Remove MODBUS Input/Ouptut
3897
+ * @summary Remove MODBUS Input/Output
3779
3898
  * @param {string} cell Unique identifier addressing a cell in all API calls.
3780
3899
  * @param {string} io Unique identifier to address an Input/Output in the cell.
3781
3900
  * @param {*} [options] Override http request option.
@@ -3808,7 +3927,7 @@ declare const BUSInputsOutputsApiFp: (configuration?: Configuration) => {
3808
3927
  */
3809
3928
  getBusIOState(cell: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BusIOsState>>;
3810
3929
  /**
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).
3930
+ * 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
3931
  * @summary Get Input/Output Values
3813
3932
  * @param {string} cell Unique identifier addressing a cell in all API calls.
3814
3933
  * @param {Array<string>} [ios]
@@ -3843,7 +3962,7 @@ declare const BUSInputsOutputsApiFp: (configuration?: Configuration) => {
3843
3962
  */
3844
3963
  listBusIODescriptions(cell: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<BusIODescription>>>;
3845
3964
  /**
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).
3965
+ * 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
3966
  * @summary List MODBUS Input/Output Configuration
3848
3967
  * @param {string} cell Unique identifier addressing a cell in all API calls.
3849
3968
  * @param {*} [options] Override http request option.
@@ -3851,7 +3970,7 @@ declare const BUSInputsOutputsApiFp: (configuration?: Configuration) => {
3851
3970
  */
3852
3971
  listModbusIOs(cell: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<ModbusIO>>>;
3853
3972
  /**
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.
3973
+ * 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
3974
  * @summary List PROFINET Input/Output Configuration
3856
3975
  * @param {string} cell Unique identifier addressing a cell in all API calls.
3857
3976
  * @param {*} [options] Override http request option.
@@ -3859,7 +3978,7 @@ declare const BUSInputsOutputsApiFp: (configuration?: Configuration) => {
3859
3978
  */
3860
3979
  listProfinetIOs(cell: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<ProfinetIO>>>;
3861
3980
  /**
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.
3981
+ * 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
3982
  * @summary Set Output Values
3864
3983
  * @param {string} cell Unique identifier addressing a cell in all API calls.
3865
3984
  * @param {Array<IOValue>} iOValue
@@ -3868,7 +3987,7 @@ declare const BUSInputsOutputsApiFp: (configuration?: Configuration) => {
3868
3987
  */
3869
3988
  setBusIOValues(cell: string, iOValue: Array<IOValue>, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
3870
3989
  /**
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.
3990
+ * 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
3991
  * @summary Set PROFINET Inputs/Outputs from File
3873
3992
  * @param {string} cell Unique identifier addressing a cell in all API calls.
3874
3993
  * @param {ProfinetInputOutputConfig} profinetInputOutputConfig
@@ -3892,7 +4011,7 @@ declare const BUSInputsOutputsApiFactory: (configuration?: Configuration, basePa
3892
4011
  */
3893
4012
  addBusIOService(cell: string, busIOType: BusIOType, completionTimeout?: number, options?: RawAxiosRequestConfig): AxiosPromise<void>;
3894
4013
  /**
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).
4014
+ * 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
4015
  * @summary Add MODBUS Input/Output
3897
4016
  * @param {string} cell Unique identifier addressing a cell in all API calls.
3898
4017
  * @param {string} io Unique identifier to address an Input/Output in the cell.
@@ -3902,7 +4021,7 @@ declare const BUSInputsOutputsApiFactory: (configuration?: Configuration, basePa
3902
4021
  */
3903
4022
  addModbusIO(cell: string, io: string, modbusIOData: ModbusIOData, options?: RawAxiosRequestConfig): AxiosPromise<void>;
3904
4023
  /**
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).
4024
+ * 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
4025
  * @summary Add PROFINET Input/Output
3907
4026
  * @param {string} cell Unique identifier addressing a cell in all API calls.
3908
4027
  * @param {string} io Unique identifier to address an Input/Output in the cell.
@@ -3938,7 +4057,7 @@ declare const BUSInputsOutputsApiFactory: (configuration?: Configuration, basePa
3938
4057
  deleteAllProfinetIOs(cell: string, options?: RawAxiosRequestConfig): AxiosPromise<void>;
3939
4058
  /**
3940
4059
  * Removes an input/output variable configuration from the MODBUS device, e.g., NOVA\'s MODBUS service.
3941
- * @summary Remove MODBUS Input/Ouptut
4060
+ * @summary Remove MODBUS Input/Output
3942
4061
  * @param {string} cell Unique identifier addressing a cell in all API calls.
3943
4062
  * @param {string} io Unique identifier to address an Input/Output in the cell.
3944
4063
  * @param {*} [options] Override http request option.
@@ -3971,7 +4090,7 @@ declare const BUSInputsOutputsApiFactory: (configuration?: Configuration, basePa
3971
4090
  */
3972
4091
  getBusIOState(cell: string, options?: RawAxiosRequestConfig): AxiosPromise<BusIOsState>;
3973
4092
  /**
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).
4093
+ * 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
4094
  * @summary Get Input/Output Values
3976
4095
  * @param {string} cell Unique identifier addressing a cell in all API calls.
3977
4096
  * @param {Array<string>} [ios]
@@ -4006,7 +4125,7 @@ declare const BUSInputsOutputsApiFactory: (configuration?: Configuration, basePa
4006
4125
  */
4007
4126
  listBusIODescriptions(cell: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<BusIODescription>>;
4008
4127
  /**
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).
4128
+ * 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
4129
  * @summary List MODBUS Input/Output Configuration
4011
4130
  * @param {string} cell Unique identifier addressing a cell in all API calls.
4012
4131
  * @param {*} [options] Override http request option.
@@ -4014,7 +4133,7 @@ declare const BUSInputsOutputsApiFactory: (configuration?: Configuration, basePa
4014
4133
  */
4015
4134
  listModbusIOs(cell: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<ModbusIO>>;
4016
4135
  /**
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.
4136
+ * 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
4137
  * @summary List PROFINET Input/Output Configuration
4019
4138
  * @param {string} cell Unique identifier addressing a cell in all API calls.
4020
4139
  * @param {*} [options] Override http request option.
@@ -4022,7 +4141,7 @@ declare const BUSInputsOutputsApiFactory: (configuration?: Configuration, basePa
4022
4141
  */
4023
4142
  listProfinetIOs(cell: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<ProfinetIO>>;
4024
4143
  /**
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.
4144
+ * 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
4145
  * @summary Set Output Values
4027
4146
  * @param {string} cell Unique identifier addressing a cell in all API calls.
4028
4147
  * @param {Array<IOValue>} iOValue
@@ -4031,7 +4150,7 @@ declare const BUSInputsOutputsApiFactory: (configuration?: Configuration, basePa
4031
4150
  */
4032
4151
  setBusIOValues(cell: string, iOValue: Array<IOValue>, options?: RawAxiosRequestConfig): AxiosPromise<void>;
4033
4152
  /**
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.
4153
+ * 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
4154
  * @summary Set PROFINET Inputs/Outputs from File
4036
4155
  * @param {string} cell Unique identifier addressing a cell in all API calls.
4037
4156
  * @param {ProfinetInputOutputConfig} profinetInputOutputConfig
@@ -4055,7 +4174,7 @@ declare class BUSInputsOutputsApi extends BaseAPI {
4055
4174
  */
4056
4175
  addBusIOService(cell: string, busIOType: BusIOType, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
4057
4176
  /**
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).
4177
+ * 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
4178
  * @summary Add MODBUS Input/Output
4060
4179
  * @param {string} cell Unique identifier addressing a cell in all API calls.
4061
4180
  * @param {string} io Unique identifier to address an Input/Output in the cell.
@@ -4065,7 +4184,7 @@ declare class BUSInputsOutputsApi extends BaseAPI {
4065
4184
  */
4066
4185
  addModbusIO(cell: string, io: string, modbusIOData: ModbusIOData, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
4067
4186
  /**
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).
4187
+ * 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
4188
  * @summary Add PROFINET Input/Output
4070
4189
  * @param {string} cell Unique identifier addressing a cell in all API calls.
4071
4190
  * @param {string} io Unique identifier to address an Input/Output in the cell.
@@ -4101,7 +4220,7 @@ declare class BUSInputsOutputsApi extends BaseAPI {
4101
4220
  deleteAllProfinetIOs(cell: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
4102
4221
  /**
4103
4222
  * Removes an input/output variable configuration from the MODBUS device, e.g., NOVA\'s MODBUS service.
4104
- * @summary Remove MODBUS Input/Ouptut
4223
+ * @summary Remove MODBUS Input/Output
4105
4224
  * @param {string} cell Unique identifier addressing a cell in all API calls.
4106
4225
  * @param {string} io Unique identifier to address an Input/Output in the cell.
4107
4226
  * @param {*} [options] Override http request option.
@@ -4134,7 +4253,7 @@ declare class BUSInputsOutputsApi extends BaseAPI {
4134
4253
  */
4135
4254
  getBusIOState(cell: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<BusIOsState, any>>;
4136
4255
  /**
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).
4256
+ * 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
4257
  * @summary Get Input/Output Values
4139
4258
  * @param {string} cell Unique identifier addressing a cell in all API calls.
4140
4259
  * @param {Array<string>} [ios]
@@ -4169,7 +4288,7 @@ declare class BUSInputsOutputsApi extends BaseAPI {
4169
4288
  */
4170
4289
  listBusIODescriptions(cell: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<BusIODescription[], any>>;
4171
4290
  /**
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).
4291
+ * 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
4292
  * @summary List MODBUS Input/Output Configuration
4174
4293
  * @param {string} cell Unique identifier addressing a cell in all API calls.
4175
4294
  * @param {*} [options] Override http request option.
@@ -4177,7 +4296,7 @@ declare class BUSInputsOutputsApi extends BaseAPI {
4177
4296
  */
4178
4297
  listModbusIOs(cell: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<ModbusIO[], any>>;
4179
4298
  /**
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.
4299
+ * 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
4300
  * @summary List PROFINET Input/Output Configuration
4182
4301
  * @param {string} cell Unique identifier addressing a cell in all API calls.
4183
4302
  * @param {*} [options] Override http request option.
@@ -4185,7 +4304,7 @@ declare class BUSInputsOutputsApi extends BaseAPI {
4185
4304
  */
4186
4305
  listProfinetIOs(cell: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<ProfinetIO[], any>>;
4187
4306
  /**
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.
4307
+ * 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
4308
  * @summary Set Output Values
4190
4309
  * @param {string} cell Unique identifier addressing a cell in all API calls.
4191
4310
  * @param {Array<IOValue>} iOValue
@@ -4194,7 +4313,7 @@ declare class BUSInputsOutputsApi extends BaseAPI {
4194
4313
  */
4195
4314
  setBusIOValues(cell: string, iOValue: Array<IOValue>, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
4196
4315
  /**
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.
4316
+ * 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
4317
  * @summary Set PROFINET Inputs/Outputs from File
4199
4318
  * @param {string} cell Unique identifier addressing a cell in all API calls.
4200
4319
  * @param {ProfinetInputOutputConfig} profinetInputOutputConfig
@@ -4207,6 +4326,15 @@ declare class BUSInputsOutputsApi extends BaseAPI {
4207
4326
  * CellApi - axios parameter creator
4208
4327
  */
4209
4328
  declare const CellApiAxiosParamCreator: (configuration?: Configuration) => {
4329
+ /**
4330
+ * Check if a more recent Wandelbots NOVA version is available for the cell. Updates greater than the system version are ignored.
4331
+ * @summary Check Cell Update
4332
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
4333
+ * @param {ReleaseChannel} channel
4334
+ * @param {*} [options] Override http request option.
4335
+ * @throws {RequiredError}
4336
+ */
4337
+ checkCellVersionUpdate: (cell: string, channel: ReleaseChannel, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
4210
4338
  /**
4211
4339
  * Delete an entire cell.
4212
4340
  * @summary Delete Cell
@@ -4267,11 +4395,29 @@ declare const CellApiAxiosParamCreator: (configuration?: Configuration) => {
4267
4395
  * @throws {RequiredError}
4268
4396
  */
4269
4397
  updateCell: (cell: string, cell2: Cell, completionTimeout?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
4398
+ /**
4399
+ * Update the Foundation chart version for a single cell based on a release channel. The resulting version is capped at the current system version.
4400
+ * @summary Update Cell Version
4401
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
4402
+ * @param {UpdateCellVersionRequest} updateCellVersionRequest
4403
+ * @param {*} [options] Override http request option.
4404
+ * @throws {RequiredError}
4405
+ */
4406
+ updateCellVersion: (cell: string, updateCellVersionRequest: UpdateCellVersionRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
4270
4407
  };
4271
4408
  /**
4272
4409
  * CellApi - functional programming interface
4273
4410
  */
4274
4411
  declare const CellApiFp: (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<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<string>>;
4275
4421
  /**
4276
4422
  * Delete an entire cell.
4277
4423
  * @summary Delete Cell
@@ -4332,11 +4478,29 @@ declare const CellApiFp: (configuration?: Configuration) => {
4332
4478
  * @throws {RequiredError}
4333
4479
  */
4334
4480
  updateCell(cell: string, cell2: Cell, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
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<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
4335
4490
  };
4336
4491
  /**
4337
4492
  * CellApi - factory interface
4338
4493
  */
4339
4494
  declare const CellApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
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): AxiosPromise<string>;
4340
4504
  /**
4341
4505
  * Delete an entire cell.
4342
4506
  * @summary Delete Cell
@@ -4397,11 +4561,29 @@ declare const CellApiFactory: (configuration?: Configuration, basePath?: string,
4397
4561
  * @throws {RequiredError}
4398
4562
  */
4399
4563
  updateCell(cell: string, cell2: Cell, completionTimeout?: number, options?: RawAxiosRequestConfig): 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): AxiosPromise<void>;
4400
4573
  };
4401
4574
  /**
4402
4575
  * CellApi - object-oriented interface
4403
4576
  */
4404
4577
  declare class CellApi extends BaseAPI {
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): Promise<axios0.AxiosResponse<string, any>>;
4405
4587
  /**
4406
4588
  * Delete an entire cell.
4407
4589
  * @summary Delete Cell
@@ -4462,6 +4644,15 @@ declare class CellApi extends BaseAPI {
4462
4644
  * @throws {RequiredError}
4463
4645
  */
4464
4646
  updateCell(cell: string, cell2: Cell, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
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): Promise<axios0.AxiosResponse<void, any>>;
4465
4656
  }
4466
4657
  /**
4467
4658
  * ControllerApi - axios parameter creator
@@ -4478,7 +4669,7 @@ declare const ControllerApiAxiosParamCreator: (configuration?: Configuration) =>
4478
4669
  */
4479
4670
  addRobotController: (cell: string, robotController: RobotController, completionTimeout?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
4480
4671
  /**
4481
- * Delete all robot controllers from the cell. To replace all robot controllers in a cell, use this endpoint in combination with [addRobotController](addRobotController).
4672
+ * 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
4673
  * @summary Clear Robot Controllers
4483
4674
  * @param {string} cell Unique identifier addressing a cell in all API calls.
4484
4675
  * @param {number} [completionTimeout]
@@ -4497,7 +4688,7 @@ declare const ControllerApiAxiosParamCreator: (configuration?: Configuration) =>
4497
4688
  */
4498
4689
  deleteRobotController: (cell: string, controller: string, completionTimeout?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
4499
4690
  /**
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.
4691
+ * 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
4692
  * @summary Description
4502
4693
  * @param {string} cell Unique identifier addressing a cell in all API calls.
4503
4694
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -4535,7 +4726,7 @@ declare const ControllerApiAxiosParamCreator: (configuration?: Configuration) =>
4535
4726
  */
4536
4727
  getRobotController: (cell: string, controller: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
4537
4728
  /**
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.
4729
+ * 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
4730
  * @summary Virtual Controller Configuration
4540
4731
  * @param {string} cell Unique identifier addressing a cell in all API calls.
4541
4732
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -4562,7 +4753,7 @@ declare const ControllerApiAxiosParamCreator: (configuration?: Configuration) =>
4562
4753
  */
4563
4754
  listRobotControllers: (cell: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
4564
4755
  /**
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.
4756
+ * 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
4757
  * @summary Set Default Mode
4567
4758
  * @param {string} cell Unique identifier addressing a cell in all API calls.
4568
4759
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -4572,7 +4763,7 @@ declare const ControllerApiAxiosParamCreator: (configuration?: Configuration) =>
4572
4763
  */
4573
4764
  setDefaultMode: (cell: string, controller: string, mode: SettableRobotSystemMode, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
4574
4765
  /**
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.
4766
+ * <!-- 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
4767
  * @summary Stream Free Drive
4577
4768
  * @param {string} cell Unique identifier addressing a cell in all API calls.
4578
4769
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -4582,7 +4773,7 @@ declare const ControllerApiAxiosParamCreator: (configuration?: Configuration) =>
4582
4773
  */
4583
4774
  streamFreeDrive: (cell: string, controller: string, responseRate?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
4584
4775
  /**
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.
4776
+ * <!-- 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
4777
  * @summary Stream State
4587
4778
  * @param {string} cell Unique identifier addressing a cell in all API calls.
4588
4779
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -4593,7 +4784,7 @@ declare const ControllerApiAxiosParamCreator: (configuration?: Configuration) =>
4593
4784
  */
4594
4785
  streamRobotControllerState: (cell: string, controller: string, responseRate?: number, addControllerTimeout?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
4595
4786
  /**
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).
4787
+ * 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
4788
  * @summary Update Robot Controller
4598
4789
  * @param {string} cell Unique identifier addressing a cell in all API calls.
4599
4790
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -4619,7 +4810,7 @@ declare const ControllerApiFp: (configuration?: Configuration) => {
4619
4810
  */
4620
4811
  addRobotController(cell: string, robotController: RobotController, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
4621
4812
  /**
4622
- * Delete all robot controllers from the cell. To replace all robot controllers in a cell, use this endpoint in combination with [addRobotController](addRobotController).
4813
+ * 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
4814
  * @summary Clear Robot Controllers
4624
4815
  * @param {string} cell Unique identifier addressing a cell in all API calls.
4625
4816
  * @param {number} [completionTimeout]
@@ -4638,7 +4829,7 @@ declare const ControllerApiFp: (configuration?: Configuration) => {
4638
4829
  */
4639
4830
  deleteRobotController(cell: string, controller: string, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
4640
4831
  /**
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.
4832
+ * 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
4833
  * @summary Description
4643
4834
  * @param {string} cell Unique identifier addressing a cell in all API calls.
4644
4835
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -4676,7 +4867,7 @@ declare const ControllerApiFp: (configuration?: Configuration) => {
4676
4867
  */
4677
4868
  getRobotController(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<RobotController>>;
4678
4869
  /**
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.
4870
+ * 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
4871
  * @summary Virtual Controller Configuration
4681
4872
  * @param {string} cell Unique identifier addressing a cell in all API calls.
4682
4873
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -4703,7 +4894,7 @@ declare const ControllerApiFp: (configuration?: Configuration) => {
4703
4894
  */
4704
4895
  listRobotControllers(cell: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<string>>>;
4705
4896
  /**
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.
4897
+ * 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
4898
  * @summary Set Default Mode
4708
4899
  * @param {string} cell Unique identifier addressing a cell in all API calls.
4709
4900
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -4713,7 +4904,7 @@ declare const ControllerApiFp: (configuration?: Configuration) => {
4713
4904
  */
4714
4905
  setDefaultMode(cell: string, controller: string, mode: SettableRobotSystemMode, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
4715
4906
  /**
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.
4907
+ * <!-- 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
4908
  * @summary Stream Free Drive
4718
4909
  * @param {string} cell Unique identifier addressing a cell in all API calls.
4719
4910
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -4723,7 +4914,7 @@ declare const ControllerApiFp: (configuration?: Configuration) => {
4723
4914
  */
4724
4915
  streamFreeDrive(cell: string, controller: string, responseRate?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<RobotControllerState>>;
4725
4916
  /**
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.
4917
+ * <!-- 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
4918
  * @summary Stream State
4728
4919
  * @param {string} cell Unique identifier addressing a cell in all API calls.
4729
4920
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -4734,7 +4925,7 @@ declare const ControllerApiFp: (configuration?: Configuration) => {
4734
4925
  */
4735
4926
  streamRobotControllerState(cell: string, controller: string, responseRate?: number, addControllerTimeout?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<RobotControllerState>>;
4736
4927
  /**
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).
4928
+ * 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
4929
  * @summary Update Robot Controller
4739
4930
  * @param {string} cell Unique identifier addressing a cell in all API calls.
4740
4931
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -4760,7 +4951,7 @@ declare const ControllerApiFactory: (configuration?: Configuration, basePath?: s
4760
4951
  */
4761
4952
  addRobotController(cell: string, robotController: RobotController, completionTimeout?: number, options?: RawAxiosRequestConfig): AxiosPromise<void>;
4762
4953
  /**
4763
- * Delete all robot controllers from the cell. To replace all robot controllers in a cell, use this endpoint in combination with [addRobotController](addRobotController).
4954
+ * 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
4955
  * @summary Clear Robot Controllers
4765
4956
  * @param {string} cell Unique identifier addressing a cell in all API calls.
4766
4957
  * @param {number} [completionTimeout]
@@ -4779,7 +4970,7 @@ declare const ControllerApiFactory: (configuration?: Configuration, basePath?: s
4779
4970
  */
4780
4971
  deleteRobotController(cell: string, controller: string, completionTimeout?: number, options?: RawAxiosRequestConfig): AxiosPromise<void>;
4781
4972
  /**
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.
4973
+ * 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
4974
  * @summary Description
4784
4975
  * @param {string} cell Unique identifier addressing a cell in all API calls.
4785
4976
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -4817,7 +5008,7 @@ declare const ControllerApiFactory: (configuration?: Configuration, basePath?: s
4817
5008
  */
4818
5009
  getRobotController(cell: string, controller: string, options?: RawAxiosRequestConfig): AxiosPromise<RobotController>;
4819
5010
  /**
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.
5011
+ * 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
5012
  * @summary Virtual Controller Configuration
4822
5013
  * @param {string} cell Unique identifier addressing a cell in all API calls.
4823
5014
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -4844,7 +5035,7 @@ declare const ControllerApiFactory: (configuration?: Configuration, basePath?: s
4844
5035
  */
4845
5036
  listRobotControllers(cell: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<string>>;
4846
5037
  /**
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.
5038
+ * 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
5039
  * @summary Set Default Mode
4849
5040
  * @param {string} cell Unique identifier addressing a cell in all API calls.
4850
5041
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -4854,7 +5045,7 @@ declare const ControllerApiFactory: (configuration?: Configuration, basePath?: s
4854
5045
  */
4855
5046
  setDefaultMode(cell: string, controller: string, mode: SettableRobotSystemMode, options?: RawAxiosRequestConfig): AxiosPromise<void>;
4856
5047
  /**
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.
5048
+ * <!-- 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
5049
  * @summary Stream Free Drive
4859
5050
  * @param {string} cell Unique identifier addressing a cell in all API calls.
4860
5051
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -4864,7 +5055,7 @@ declare const ControllerApiFactory: (configuration?: Configuration, basePath?: s
4864
5055
  */
4865
5056
  streamFreeDrive(cell: string, controller: string, responseRate?: number, options?: RawAxiosRequestConfig): AxiosPromise<RobotControllerState>;
4866
5057
  /**
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.
5058
+ * <!-- 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
5059
  * @summary Stream State
4869
5060
  * @param {string} cell Unique identifier addressing a cell in all API calls.
4870
5061
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -4875,7 +5066,7 @@ declare const ControllerApiFactory: (configuration?: Configuration, basePath?: s
4875
5066
  */
4876
5067
  streamRobotControllerState(cell: string, controller: string, responseRate?: number, addControllerTimeout?: number, options?: RawAxiosRequestConfig): AxiosPromise<RobotControllerState>;
4877
5068
  /**
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).
5069
+ * 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
5070
  * @summary Update Robot Controller
4880
5071
  * @param {string} cell Unique identifier addressing a cell in all API calls.
4881
5072
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -4901,7 +5092,7 @@ declare class ControllerApi extends BaseAPI {
4901
5092
  */
4902
5093
  addRobotController(cell: string, robotController: RobotController, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
4903
5094
  /**
4904
- * Delete all robot controllers from the cell. To replace all robot controllers in a cell, use this endpoint in combination with [addRobotController](addRobotController).
5095
+ * 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
5096
  * @summary Clear Robot Controllers
4906
5097
  * @param {string} cell Unique identifier addressing a cell in all API calls.
4907
5098
  * @param {number} [completionTimeout]
@@ -4920,7 +5111,7 @@ declare class ControllerApi extends BaseAPI {
4920
5111
  */
4921
5112
  deleteRobotController(cell: string, controller: string, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
4922
5113
  /**
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.
5114
+ * 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
5115
  * @summary Description
4925
5116
  * @param {string} cell Unique identifier addressing a cell in all API calls.
4926
5117
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -4958,7 +5149,7 @@ declare class ControllerApi extends BaseAPI {
4958
5149
  */
4959
5150
  getRobotController(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<RobotController, any>>;
4960
5151
  /**
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.
5152
+ * 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
5153
  * @summary Virtual Controller Configuration
4963
5154
  * @param {string} cell Unique identifier addressing a cell in all API calls.
4964
5155
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -4985,7 +5176,7 @@ declare class ControllerApi extends BaseAPI {
4985
5176
  */
4986
5177
  listRobotControllers(cell: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<string[], any>>;
4987
5178
  /**
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.
5179
+ * 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
5180
  * @summary Set Default Mode
4990
5181
  * @param {string} cell Unique identifier addressing a cell in all API calls.
4991
5182
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -4995,7 +5186,7 @@ declare class ControllerApi extends BaseAPI {
4995
5186
  */
4996
5187
  setDefaultMode(cell: string, controller: string, mode: SettableRobotSystemMode, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
4997
5188
  /**
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.
5189
+ * <!-- 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
5190
  * @summary Stream Free Drive
5000
5191
  * @param {string} cell Unique identifier addressing a cell in all API calls.
5001
5192
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -5005,7 +5196,7 @@ declare class ControllerApi extends BaseAPI {
5005
5196
  */
5006
5197
  streamFreeDrive(cell: string, controller: string, responseRate?: number, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<RobotControllerState, any>>;
5007
5198
  /**
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.
5199
+ * <!-- 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
5200
  * @summary Stream State
5010
5201
  * @param {string} cell Unique identifier addressing a cell in all API calls.
5011
5202
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -5016,7 +5207,7 @@ declare class ControllerApi extends BaseAPI {
5016
5207
  */
5017
5208
  streamRobotControllerState(cell: string, controller: string, responseRate?: number, addControllerTimeout?: number, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<RobotControllerState, any>>;
5018
5209
  /**
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).
5210
+ * 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
5211
  * @summary Update Robot Controller
5021
5212
  * @param {string} cell Unique identifier addressing a cell in all API calls.
5022
5213
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -5045,7 +5236,7 @@ declare const ControllerInputsOutputsApiAxiosParamCreator: (configuration?: Conf
5045
5236
  */
5046
5237
  listIODescriptions: (cell: string, controller: string, ios?: Array<string>, direction?: IODirection, valueType?: IOValueType, group?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
5047
5238
  /**
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).
5239
+ * 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
5240
  * @summary Get Input/Output Values
5050
5241
  * @param {string} cell Unique identifier addressing a cell in all API calls.
5051
5242
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -5055,7 +5246,7 @@ declare const ControllerInputsOutputsApiAxiosParamCreator: (configuration?: Conf
5055
5246
  */
5056
5247
  listIOValues: (cell: string, controller: string, ios?: Array<string>, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
5057
5248
  /**
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.
5249
+ * 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
5250
  * @summary Set Output Values
5060
5251
  * @param {string} cell Unique identifier addressing a cell in all API calls.
5061
5252
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -5075,7 +5266,7 @@ declare const ControllerInputsOutputsApiAxiosParamCreator: (configuration?: Conf
5075
5266
  */
5076
5267
  streamIOValues: (cell: string, controller: string, ios?: Array<string>, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
5077
5268
  /**
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 ```
5269
+ * 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
5270
  * @summary Wait For
5080
5271
  * @param {string} cell Unique identifier addressing a cell in all API calls.
5081
5272
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -5103,7 +5294,7 @@ declare const ControllerInputsOutputsApiFp: (configuration?: Configuration) => {
5103
5294
  */
5104
5295
  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
5296
  /**
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).
5297
+ * 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
5298
  * @summary Get Input/Output Values
5108
5299
  * @param {string} cell Unique identifier addressing a cell in all API calls.
5109
5300
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -5113,7 +5304,7 @@ declare const ControllerInputsOutputsApiFp: (configuration?: Configuration) => {
5113
5304
  */
5114
5305
  listIOValues(cell: string, controller: string, ios?: Array<string>, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<IOValue>>>;
5115
5306
  /**
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.
5307
+ * 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
5308
  * @summary Set Output Values
5118
5309
  * @param {string} cell Unique identifier addressing a cell in all API calls.
5119
5310
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -5133,7 +5324,7 @@ declare const ControllerInputsOutputsApiFp: (configuration?: Configuration) => {
5133
5324
  */
5134
5325
  streamIOValues(cell: string, controller: string, ios?: Array<string>, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<StreamIOValuesResponse>>;
5135
5326
  /**
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 ```
5327
+ * 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
5328
  * @summary Wait For
5138
5329
  * @param {string} cell Unique identifier addressing a cell in all API calls.
5139
5330
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -5161,7 +5352,7 @@ declare const ControllerInputsOutputsApiFactory: (configuration?: Configuration,
5161
5352
  */
5162
5353
  listIODescriptions(cell: string, controller: string, ios?: Array<string>, direction?: IODirection, valueType?: IOValueType, group?: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<IODescription>>;
5163
5354
  /**
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).
5355
+ * 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
5356
  * @summary Get Input/Output Values
5166
5357
  * @param {string} cell Unique identifier addressing a cell in all API calls.
5167
5358
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -5171,7 +5362,7 @@ declare const ControllerInputsOutputsApiFactory: (configuration?: Configuration,
5171
5362
  */
5172
5363
  listIOValues(cell: string, controller: string, ios?: Array<string>, options?: RawAxiosRequestConfig): AxiosPromise<Array<IOValue>>;
5173
5364
  /**
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.
5365
+ * 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
5366
  * @summary Set Output Values
5176
5367
  * @param {string} cell Unique identifier addressing a cell in all API calls.
5177
5368
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -5191,7 +5382,7 @@ declare const ControllerInputsOutputsApiFactory: (configuration?: Configuration,
5191
5382
  */
5192
5383
  streamIOValues(cell: string, controller: string, ios?: Array<string>, options?: RawAxiosRequestConfig): AxiosPromise<StreamIOValuesResponse>;
5193
5384
  /**
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 ```
5385
+ * 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
5386
  * @summary Wait For
5196
5387
  * @param {string} cell Unique identifier addressing a cell in all API calls.
5197
5388
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -5219,7 +5410,7 @@ declare class ControllerInputsOutputsApi extends BaseAPI {
5219
5410
  */
5220
5411
  listIODescriptions(cell: string, controller: string, ios?: Array<string>, direction?: IODirection, valueType?: IOValueType, group?: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<IODescription[], any>>;
5221
5412
  /**
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).
5413
+ * 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
5414
  * @summary Get Input/Output Values
5224
5415
  * @param {string} cell Unique identifier addressing a cell in all API calls.
5225
5416
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -5229,7 +5420,7 @@ declare class ControllerInputsOutputsApi extends BaseAPI {
5229
5420
  */
5230
5421
  listIOValues(cell: string, controller: string, ios?: Array<string>, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<IOValue[], any>>;
5231
5422
  /**
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.
5423
+ * 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
5424
  * @summary Set Output Values
5234
5425
  * @param {string} cell Unique identifier addressing a cell in all API calls.
5235
5426
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -5249,7 +5440,7 @@ declare class ControllerInputsOutputsApi extends BaseAPI {
5249
5440
  */
5250
5441
  streamIOValues(cell: string, controller: string, ios?: Array<string>, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<StreamIOValuesResponse, any>>;
5251
5442
  /**
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 ```
5443
+ * 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
5444
  * @summary Wait For
5254
5445
  * @param {string} cell Unique identifier addressing a cell in all API calls.
5255
5446
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -5264,7 +5455,7 @@ declare class ControllerInputsOutputsApi extends BaseAPI {
5264
5455
  */
5265
5456
  declare const JoggingApiAxiosParamCreator: (configuration?: Configuration) => {
5266
5457
  /**
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.
5458
+ * <!-- 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
5459
  * @summary Execute Jogging
5269
5460
  * @param {string} cell Unique identifier addressing a cell in all API calls.
5270
5461
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -5279,7 +5470,7 @@ declare const JoggingApiAxiosParamCreator: (configuration?: Configuration) => {
5279
5470
  */
5280
5471
  declare const JoggingApiFp: (configuration?: Configuration) => {
5281
5472
  /**
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.
5473
+ * <!-- 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
5474
  * @summary Execute Jogging
5284
5475
  * @param {string} cell Unique identifier addressing a cell in all API calls.
5285
5476
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -5294,7 +5485,7 @@ declare const JoggingApiFp: (configuration?: Configuration) => {
5294
5485
  */
5295
5486
  declare const JoggingApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
5296
5487
  /**
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.
5488
+ * <!-- 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
5489
  * @summary Execute Jogging
5299
5490
  * @param {string} cell Unique identifier addressing a cell in all API calls.
5300
5491
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -5309,7 +5500,7 @@ declare const JoggingApiFactory: (configuration?: Configuration, basePath?: stri
5309
5500
  */
5310
5501
  declare class JoggingApi extends BaseAPI {
5311
5502
  /**
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.
5503
+ * <!-- 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
5504
  * @summary Execute Jogging
5314
5505
  * @param {string} cell Unique identifier addressing a cell in all API calls.
5315
5506
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -5704,25 +5895,25 @@ declare class MotionGroupApi extends BaseAPI {
5704
5895
  */
5705
5896
  declare const MotionGroupModelsApiAxiosParamCreator: (configuration?: Configuration) => {
5706
5897
  /**
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.
5898
+ * 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
5899
  * @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).
5900
+ * @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
5901
  * @param {*} [options] Override http request option.
5711
5902
  * @throws {RequiredError}
5712
5903
  */
5713
5904
  getMotionGroupCollisionModel: (motionGroupModel: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
5714
5905
  /**
5715
- * Returns the GLB asset for the specified motion group model. See [getMotionGroupModels](getMotionGroupModels) for supported identifiers.
5906
+ * Returns the GLB asset for the specified motion group model. See [getMotionGroupModels](#/operations/getMotionGroupModels) for supported identifiers.
5716
5907
  * @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).
5908
+ * @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
5909
  * @param {*} [options] Override http request option.
5719
5910
  * @throws {RequiredError}
5720
5911
  */
5721
5912
  getMotionGroupGlbModel: (motionGroupModel: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
5722
5913
  /**
5723
- * Returns the kinematics model (DH parameters) for the given motion group model. See [getMotionGroupModels](getMotionGroupModels) for supported motion group models.
5914
+ * Returns the kinematics model (DH parameters) for the given motion group model. See [getMotionGroupModels](#/operations/getMotionGroupModels) for supported motion group models.
5724
5915
  * @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).
5916
+ * @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
5917
  * @param {*} [options] Override http request option.
5727
5918
  * @throws {RequiredError}
5728
5919
  */
@@ -5735,9 +5926,9 @@ declare const MotionGroupModelsApiAxiosParamCreator: (configuration?: Configurat
5735
5926
  */
5736
5927
  getMotionGroupModels: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
5737
5928
  /**
5738
- * Returns the USD scene model for the specified motion group model. See [getMotionGroupModels](getMotionGroupModels) for supported identifiers.
5929
+ * Returns the USD scene model for the specified motion group model. See [getMotionGroupModels](#/operations/getMotionGroupModels) for supported identifiers.
5739
5930
  * @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).
5931
+ * @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
5932
  * @param {*} [options] Override http request option.
5742
5933
  * @throws {RequiredError}
5743
5934
  */
@@ -5748,9 +5939,9 @@ declare const MotionGroupModelsApiAxiosParamCreator: (configuration?: Configurat
5748
5939
  */
5749
5940
  declare const MotionGroupModelsApiFp: (configuration?: Configuration) => {
5750
5941
  /**
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.
5942
+ * 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
5943
  * @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).
5944
+ * @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
5945
  * @param {*} [options] Override http request option.
5755
5946
  * @throws {RequiredError}
5756
5947
  */
@@ -5758,17 +5949,17 @@ declare const MotionGroupModelsApiFp: (configuration?: Configuration) => {
5758
5949
  [key: string]: Collider;
5759
5950
  }>>>;
5760
5951
  /**
5761
- * Returns the GLB asset for the specified motion group model. See [getMotionGroupModels](getMotionGroupModels) for supported identifiers.
5952
+ * Returns the GLB asset for the specified motion group model. See [getMotionGroupModels](#/operations/getMotionGroupModels) for supported identifiers.
5762
5953
  * @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).
5954
+ * @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
5955
  * @param {*} [options] Override http request option.
5765
5956
  * @throws {RequiredError}
5766
5957
  */
5767
5958
  getMotionGroupGlbModel(motionGroupModel: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<File>>;
5768
5959
  /**
5769
- * Returns the kinematics model (DH parameters) for the given motion group model. See [getMotionGroupModels](getMotionGroupModels) for supported motion group models.
5960
+ * Returns the kinematics model (DH parameters) for the given motion group model. See [getMotionGroupModels](#/operations/getMotionGroupModels) for supported motion group models.
5770
5961
  * @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).
5962
+ * @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
5963
  * @param {*} [options] Override http request option.
5773
5964
  * @throws {RequiredError}
5774
5965
  */
@@ -5781,9 +5972,9 @@ declare const MotionGroupModelsApiFp: (configuration?: Configuration) => {
5781
5972
  */
5782
5973
  getMotionGroupModels(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<string>>>;
5783
5974
  /**
5784
- * Returns the USD scene model for the specified motion group model. See [getMotionGroupModels](getMotionGroupModels) for supported identifiers.
5975
+ * Returns the USD scene model for the specified motion group model. See [getMotionGroupModels](#/operations/getMotionGroupModels) for supported identifiers.
5785
5976
  * @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).
5977
+ * @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
5978
  * @param {*} [options] Override http request option.
5788
5979
  * @throws {RequiredError}
5789
5980
  */
@@ -5794,9 +5985,9 @@ declare const MotionGroupModelsApiFp: (configuration?: Configuration) => {
5794
5985
  */
5795
5986
  declare const MotionGroupModelsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
5796
5987
  /**
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.
5988
+ * 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
5989
  * @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).
5990
+ * @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
5991
  * @param {*} [options] Override http request option.
5801
5992
  * @throws {RequiredError}
5802
5993
  */
@@ -5804,17 +5995,17 @@ declare const MotionGroupModelsApiFactory: (configuration?: Configuration, baseP
5804
5995
  [key: string]: Collider;
5805
5996
  }>>;
5806
5997
  /**
5807
- * Returns the GLB asset for the specified motion group model. See [getMotionGroupModels](getMotionGroupModels) for supported identifiers.
5998
+ * Returns the GLB asset for the specified motion group model. See [getMotionGroupModels](#/operations/getMotionGroupModels) for supported identifiers.
5808
5999
  * @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).
6000
+ * @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
6001
  * @param {*} [options] Override http request option.
5811
6002
  * @throws {RequiredError}
5812
6003
  */
5813
6004
  getMotionGroupGlbModel(motionGroupModel: string, options?: RawAxiosRequestConfig): AxiosPromise<File>;
5814
6005
  /**
5815
- * Returns the kinematics model (DH parameters) for the given motion group model. See [getMotionGroupModels](getMotionGroupModels) for supported motion group models.
6006
+ * Returns the kinematics model (DH parameters) for the given motion group model. See [getMotionGroupModels](#/operations/getMotionGroupModels) for supported motion group models.
5816
6007
  * @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).
6008
+ * @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
6009
  * @param {*} [options] Override http request option.
5819
6010
  * @throws {RequiredError}
5820
6011
  */
@@ -5827,9 +6018,9 @@ declare const MotionGroupModelsApiFactory: (configuration?: Configuration, baseP
5827
6018
  */
5828
6019
  getMotionGroupModels(options?: RawAxiosRequestConfig): AxiosPromise<Array<string>>;
5829
6020
  /**
5830
- * Returns the USD scene model for the specified motion group model. See [getMotionGroupModels](getMotionGroupModels) for supported identifiers.
6021
+ * Returns the USD scene model for the specified motion group model. See [getMotionGroupModels](#/operations/getMotionGroupModels) for supported identifiers.
5831
6022
  * @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).
6023
+ * @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
6024
  * @param {*} [options] Override http request option.
5834
6025
  * @throws {RequiredError}
5835
6026
  */
@@ -5840,9 +6031,9 @@ declare const MotionGroupModelsApiFactory: (configuration?: Configuration, baseP
5840
6031
  */
5841
6032
  declare class MotionGroupModelsApi extends BaseAPI {
5842
6033
  /**
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.
6034
+ * 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
6035
  * @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).
6036
+ * @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
6037
  * @param {*} [options] Override http request option.
5847
6038
  * @throws {RequiredError}
5848
6039
  */
@@ -5850,17 +6041,17 @@ declare class MotionGroupModelsApi extends BaseAPI {
5850
6041
  [key: string]: Collider;
5851
6042
  }[], any>>;
5852
6043
  /**
5853
- * Returns the GLB asset for the specified motion group model. See [getMotionGroupModels](getMotionGroupModels) for supported identifiers.
6044
+ * Returns the GLB asset for the specified motion group model. See [getMotionGroupModels](#/operations/getMotionGroupModels) for supported identifiers.
5854
6045
  * @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).
6046
+ * @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
6047
  * @param {*} [options] Override http request option.
5857
6048
  * @throws {RequiredError}
5858
6049
  */
5859
6050
  getMotionGroupGlbModel(motionGroupModel: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<File, any>>;
5860
6051
  /**
5861
- * Returns the kinematics model (DH parameters) for the given motion group model. See [getMotionGroupModels](getMotionGroupModels) for supported motion group models.
6052
+ * Returns the kinematics model (DH parameters) for the given motion group model. See [getMotionGroupModels](#/operations/getMotionGroupModels) for supported motion group models.
5862
6053
  * @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).
6054
+ * @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
6055
  * @param {*} [options] Override http request option.
5865
6056
  * @throws {RequiredError}
5866
6057
  */
@@ -5873,9 +6064,9 @@ declare class MotionGroupModelsApi extends BaseAPI {
5873
6064
  */
5874
6065
  getMotionGroupModels(options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<string[], any>>;
5875
6066
  /**
5876
- * Returns the USD scene model for the specified motion group model. See [getMotionGroupModels](getMotionGroupModels) for supported identifiers.
6067
+ * Returns the USD scene model for the specified motion group model. See [getMotionGroupModels](#/operations/getMotionGroupModels) for supported identifiers.
5877
6068
  * @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).
6069
+ * @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
6070
  * @param {*} [options] Override http request option.
5880
6071
  * @throws {RequiredError}
5881
6072
  */
@@ -6961,7 +7152,7 @@ declare const StoreObjectApiAxiosParamCreator: (configuration?: Configuration) =
6961
7152
  */
6962
7153
  listAllObjectKeys: (cell: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
6963
7154
  /**
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.
7155
+ * 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
7156
  * @summary Store Object
6966
7157
  * @param {string} cell Unique identifier addressing a cell in all API calls.
6967
7158
  * @param {string} key
@@ -7022,7 +7213,7 @@ declare const StoreObjectApiFp: (configuration?: Configuration) => {
7022
7213
  */
7023
7214
  listAllObjectKeys(cell: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<string>>>;
7024
7215
  /**
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.
7216
+ * 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
7217
  * @summary Store Object
7027
7218
  * @param {string} cell Unique identifier addressing a cell in all API calls.
7028
7219
  * @param {string} key
@@ -7083,7 +7274,7 @@ declare const StoreObjectApiFactory: (configuration?: Configuration, basePath?:
7083
7274
  */
7084
7275
  listAllObjectKeys(cell: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<string>>;
7085
7276
  /**
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.
7277
+ * 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
7278
  * @summary Store Object
7088
7279
  * @param {string} cell Unique identifier addressing a cell in all API calls.
7089
7280
  * @param {string} key
@@ -7144,7 +7335,7 @@ declare class StoreObjectApi extends BaseAPI {
7144
7335
  */
7145
7336
  listAllObjectKeys(cell: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<string[], any>>;
7146
7337
  /**
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.
7338
+ * 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
7339
  * @summary Store Object
7149
7340
  * @param {string} cell Unique identifier addressing a cell in all API calls.
7150
7341
  * @param {string} key
@@ -7250,7 +7441,7 @@ declare const SystemApiAxiosParamCreator: (configuration?: Configuration) => {
7250
7441
  */
7251
7442
  restoreConfiguration: (body: File, resources?: Array<string>, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
7252
7443
  /**
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.
7444
+ * 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
7445
  * @summary Update Wandelbots NOVA version
7255
7446
  * @param {UpdateNovaVersionRequest} updateNovaVersionRequest
7256
7447
  * @param {*} [options] Override http request option.
@@ -7351,7 +7542,7 @@ declare const SystemApiFp: (configuration?: Configuration) => {
7351
7542
  */
7352
7543
  restoreConfiguration(body: File, resources?: Array<string>, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
7353
7544
  /**
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.
7545
+ * 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
7546
  * @summary Update Wandelbots NOVA version
7356
7547
  * @param {UpdateNovaVersionRequest} updateNovaVersionRequest
7357
7548
  * @param {*} [options] Override http request option.
@@ -7452,7 +7643,7 @@ declare const SystemApiFactory: (configuration?: Configuration, basePath?: strin
7452
7643
  */
7453
7644
  restoreConfiguration(body: File, resources?: Array<string>, options?: RawAxiosRequestConfig): AxiosPromise<void>;
7454
7645
  /**
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.
7646
+ * 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
7647
  * @summary Update Wandelbots NOVA version
7457
7648
  * @param {UpdateNovaVersionRequest} updateNovaVersionRequest
7458
7649
  * @param {*} [options] Override http request option.
@@ -7553,7 +7744,7 @@ declare class SystemApi extends BaseAPI {
7553
7744
  */
7554
7745
  restoreConfiguration(body: File, resources?: Array<string>, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
7555
7746
  /**
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.
7747
+ * 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
7748
  * @summary Update Wandelbots NOVA version
7558
7749
  * @param {UpdateNovaVersionRequest} updateNovaVersionRequest
7559
7750
  * @param {*} [options] Override http request option.
@@ -7566,7 +7757,7 @@ declare class SystemApi extends BaseAPI {
7566
7757
  */
7567
7758
  declare const TrajectoryCachingApiAxiosParamCreator: (configuration?: Configuration) => {
7568
7759
  /**
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.
7760
+ * 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
7761
  * @summary Add Trajectory
7571
7762
  * @param {string} cell Unique identifier addressing a cell in all API calls.
7572
7763
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -7585,7 +7776,7 @@ declare const TrajectoryCachingApiAxiosParamCreator: (configuration?: Configurat
7585
7776
  */
7586
7777
  clearTrajectories: (cell: string, controller: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
7587
7778
  /**
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.
7779
+ * 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
7780
  * @summary Delete Trajectory
7590
7781
  * @param {string} cell Unique identifier addressing a cell in all API calls.
7591
7782
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -7595,7 +7786,7 @@ declare const TrajectoryCachingApiAxiosParamCreator: (configuration?: Configurat
7595
7786
  */
7596
7787
  deleteTrajectory: (cell: string, controller: string, trajectory: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
7597
7788
  /**
7598
- * Get a previously created trajectory from cache. Use [listTrajectories](listTrajectories) to list all cached trajectories.
7789
+ * Get a previously created trajectory from cache. Use [listTrajectories](#/operations/listTrajectories) to list all cached trajectories.
7599
7790
  * @summary Get Trajectory
7600
7791
  * @param {string} cell Unique identifier addressing a cell in all API calls.
7601
7792
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -7605,7 +7796,7 @@ declare const TrajectoryCachingApiAxiosParamCreator: (configuration?: Configurat
7605
7796
  */
7606
7797
  getTrajectory: (cell: string, controller: string, trajectory: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
7607
7798
  /**
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.
7799
+ * 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
7800
  * @summary List Trajectories
7610
7801
  * @param {string} cell Unique identifier addressing a cell in all API calls.
7611
7802
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -7619,7 +7810,7 @@ declare const TrajectoryCachingApiAxiosParamCreator: (configuration?: Configurat
7619
7810
  */
7620
7811
  declare const TrajectoryCachingApiFp: (configuration?: Configuration) => {
7621
7812
  /**
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.
7813
+ * 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
7814
  * @summary Add Trajectory
7624
7815
  * @param {string} cell Unique identifier addressing a cell in all API calls.
7625
7816
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -7638,7 +7829,7 @@ declare const TrajectoryCachingApiFp: (configuration?: Configuration) => {
7638
7829
  */
7639
7830
  clearTrajectories(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
7640
7831
  /**
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.
7832
+ * 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
7833
  * @summary Delete Trajectory
7643
7834
  * @param {string} cell Unique identifier addressing a cell in all API calls.
7644
7835
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -7648,7 +7839,7 @@ declare const TrajectoryCachingApiFp: (configuration?: Configuration) => {
7648
7839
  */
7649
7840
  deleteTrajectory(cell: string, controller: string, trajectory: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
7650
7841
  /**
7651
- * Get a previously created trajectory from cache. Use [listTrajectories](listTrajectories) to list all cached trajectories.
7842
+ * Get a previously created trajectory from cache. Use [listTrajectories](#/operations/listTrajectories) to list all cached trajectories.
7652
7843
  * @summary Get Trajectory
7653
7844
  * @param {string} cell Unique identifier addressing a cell in all API calls.
7654
7845
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -7658,7 +7849,7 @@ declare const TrajectoryCachingApiFp: (configuration?: Configuration) => {
7658
7849
  */
7659
7850
  getTrajectory(cell: string, controller: string, trajectory: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetTrajectoryResponse>>;
7660
7851
  /**
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.
7852
+ * 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
7853
  * @summary List Trajectories
7663
7854
  * @param {string} cell Unique identifier addressing a cell in all API calls.
7664
7855
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -7672,7 +7863,7 @@ declare const TrajectoryCachingApiFp: (configuration?: Configuration) => {
7672
7863
  */
7673
7864
  declare const TrajectoryCachingApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
7674
7865
  /**
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.
7866
+ * 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
7867
  * @summary Add Trajectory
7677
7868
  * @param {string} cell Unique identifier addressing a cell in all API calls.
7678
7869
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -7691,7 +7882,7 @@ declare const TrajectoryCachingApiFactory: (configuration?: Configuration, baseP
7691
7882
  */
7692
7883
  clearTrajectories(cell: string, controller: string, options?: RawAxiosRequestConfig): AxiosPromise<void>;
7693
7884
  /**
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.
7885
+ * 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
7886
  * @summary Delete Trajectory
7696
7887
  * @param {string} cell Unique identifier addressing a cell in all API calls.
7697
7888
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -7701,7 +7892,7 @@ declare const TrajectoryCachingApiFactory: (configuration?: Configuration, baseP
7701
7892
  */
7702
7893
  deleteTrajectory(cell: string, controller: string, trajectory: string, options?: RawAxiosRequestConfig): AxiosPromise<void>;
7703
7894
  /**
7704
- * Get a previously created trajectory from cache. Use [listTrajectories](listTrajectories) to list all cached trajectories.
7895
+ * Get a previously created trajectory from cache. Use [listTrajectories](#/operations/listTrajectories) to list all cached trajectories.
7705
7896
  * @summary Get Trajectory
7706
7897
  * @param {string} cell Unique identifier addressing a cell in all API calls.
7707
7898
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -7711,7 +7902,7 @@ declare const TrajectoryCachingApiFactory: (configuration?: Configuration, baseP
7711
7902
  */
7712
7903
  getTrajectory(cell: string, controller: string, trajectory: string, options?: RawAxiosRequestConfig): AxiosPromise<GetTrajectoryResponse>;
7713
7904
  /**
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.
7905
+ * 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
7906
  * @summary List Trajectories
7716
7907
  * @param {string} cell Unique identifier addressing a cell in all API calls.
7717
7908
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -7725,7 +7916,7 @@ declare const TrajectoryCachingApiFactory: (configuration?: Configuration, baseP
7725
7916
  */
7726
7917
  declare class TrajectoryCachingApi extends BaseAPI {
7727
7918
  /**
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.
7919
+ * 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
7920
  * @summary Add Trajectory
7730
7921
  * @param {string} cell Unique identifier addressing a cell in all API calls.
7731
7922
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -7744,7 +7935,7 @@ declare class TrajectoryCachingApi extends BaseAPI {
7744
7935
  */
7745
7936
  clearTrajectories(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
7746
7937
  /**
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.
7938
+ * 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
7939
  * @summary Delete Trajectory
7749
7940
  * @param {string} cell Unique identifier addressing a cell in all API calls.
7750
7941
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -7754,7 +7945,7 @@ declare class TrajectoryCachingApi extends BaseAPI {
7754
7945
  */
7755
7946
  deleteTrajectory(cell: string, controller: string, trajectory: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
7756
7947
  /**
7757
- * Get a previously created trajectory from cache. Use [listTrajectories](listTrajectories) to list all cached trajectories.
7948
+ * Get a previously created trajectory from cache. Use [listTrajectories](#/operations/listTrajectories) to list all cached trajectories.
7758
7949
  * @summary Get Trajectory
7759
7950
  * @param {string} cell Unique identifier addressing a cell in all API calls.
7760
7951
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -7764,7 +7955,7 @@ declare class TrajectoryCachingApi extends BaseAPI {
7764
7955
  */
7765
7956
  getTrajectory(cell: string, controller: string, trajectory: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<GetTrajectoryResponse, any>>;
7766
7957
  /**
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.
7958
+ * 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
7959
  * @summary List Trajectories
7769
7960
  * @param {string} cell Unique identifier addressing a cell in all API calls.
7770
7961
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -7778,7 +7969,7 @@ declare class TrajectoryCachingApi extends BaseAPI {
7778
7969
  */
7779
7970
  declare const TrajectoryExecutionApiAxiosParamCreator: (configuration?: Configuration) => {
7780
7971
  /**
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.
7972
+ * <!-- 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
7973
  * @summary Execute Trajectory
7783
7974
  * @param {string} cell Unique identifier addressing a cell in all API calls.
7784
7975
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -7793,7 +7984,7 @@ declare const TrajectoryExecutionApiAxiosParamCreator: (configuration?: Configur
7793
7984
  */
7794
7985
  declare const TrajectoryExecutionApiFp: (configuration?: Configuration) => {
7795
7986
  /**
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.
7987
+ * <!-- 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
7988
  * @summary Execute Trajectory
7798
7989
  * @param {string} cell Unique identifier addressing a cell in all API calls.
7799
7990
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -7808,7 +7999,7 @@ declare const TrajectoryExecutionApiFp: (configuration?: Configuration) => {
7808
7999
  */
7809
8000
  declare const TrajectoryExecutionApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
7810
8001
  /**
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.
8002
+ * <!-- 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
8003
  * @summary Execute Trajectory
7813
8004
  * @param {string} cell Unique identifier addressing a cell in all API calls.
7814
8005
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -7823,7 +8014,7 @@ declare const TrajectoryExecutionApiFactory: (configuration?: Configuration, bas
7823
8014
  */
7824
8015
  declare class TrajectoryExecutionApi extends BaseAPI {
7825
8016
  /**
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.
8017
+ * <!-- 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
8018
  * @summary Execute Trajectory
7828
8019
  * @param {string} cell Unique identifier addressing a cell in all API calls.
7829
8020
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -7838,7 +8029,7 @@ declare class TrajectoryExecutionApi extends BaseAPI {
7838
8029
  */
7839
8030
  declare const TrajectoryPlanningApiAxiosParamCreator: (configuration?: Configuration) => {
7840
8031
  /**
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.
8032
+ * 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
8033
  * @summary Plan Collision-Free Trajectory
7843
8034
  * @param {string} cell Unique identifier addressing a cell in all API calls.
7844
8035
  * @param {PlanCollisionFreeRequest} planCollisionFreeRequest
@@ -7847,7 +8038,7 @@ declare const TrajectoryPlanningApiAxiosParamCreator: (configuration?: Configura
7847
8038
  */
7848
8039
  planCollisionFree: (cell: string, planCollisionFreeRequest: PlanCollisionFreeRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
7849
8040
  /**
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.
8041
+ * 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
8042
  * @summary Plan Trajectory
7852
8043
  * @param {string} cell Unique identifier addressing a cell in all API calls.
7853
8044
  * @param {PlanTrajectoryRequest} planTrajectoryRequest
@@ -7861,7 +8052,7 @@ declare const TrajectoryPlanningApiAxiosParamCreator: (configuration?: Configura
7861
8052
  */
7862
8053
  declare const TrajectoryPlanningApiFp: (configuration?: Configuration) => {
7863
8054
  /**
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.
8055
+ * 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
8056
  * @summary Plan Collision-Free Trajectory
7866
8057
  * @param {string} cell Unique identifier addressing a cell in all API calls.
7867
8058
  * @param {PlanCollisionFreeRequest} planCollisionFreeRequest
@@ -7870,7 +8061,7 @@ declare const TrajectoryPlanningApiFp: (configuration?: Configuration) => {
7870
8061
  */
7871
8062
  planCollisionFree(cell: string, planCollisionFreeRequest: PlanCollisionFreeRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PlanCollisionFreeResponse>>;
7872
8063
  /**
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.
8064
+ * 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
8065
  * @summary Plan Trajectory
7875
8066
  * @param {string} cell Unique identifier addressing a cell in all API calls.
7876
8067
  * @param {PlanTrajectoryRequest} planTrajectoryRequest
@@ -7884,7 +8075,7 @@ declare const TrajectoryPlanningApiFp: (configuration?: Configuration) => {
7884
8075
  */
7885
8076
  declare const TrajectoryPlanningApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
7886
8077
  /**
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.
8078
+ * 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
8079
  * @summary Plan Collision-Free Trajectory
7889
8080
  * @param {string} cell Unique identifier addressing a cell in all API calls.
7890
8081
  * @param {PlanCollisionFreeRequest} planCollisionFreeRequest
@@ -7893,7 +8084,7 @@ declare const TrajectoryPlanningApiFactory: (configuration?: Configuration, base
7893
8084
  */
7894
8085
  planCollisionFree(cell: string, planCollisionFreeRequest: PlanCollisionFreeRequest, options?: RawAxiosRequestConfig): AxiosPromise<PlanCollisionFreeResponse>;
7895
8086
  /**
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.
8087
+ * 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
8088
  * @summary Plan Trajectory
7898
8089
  * @param {string} cell Unique identifier addressing a cell in all API calls.
7899
8090
  * @param {PlanTrajectoryRequest} planTrajectoryRequest
@@ -7907,7 +8098,7 @@ declare const TrajectoryPlanningApiFactory: (configuration?: Configuration, base
7907
8098
  */
7908
8099
  declare class TrajectoryPlanningApi extends BaseAPI {
7909
8100
  /**
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.
8101
+ * 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
8102
  * @summary Plan Collision-Free Trajectory
7912
8103
  * @param {string} cell Unique identifier addressing a cell in all API calls.
7913
8104
  * @param {PlanCollisionFreeRequest} planCollisionFreeRequest
@@ -7916,7 +8107,7 @@ declare class TrajectoryPlanningApi extends BaseAPI {
7916
8107
  */
7917
8108
  planCollisionFree(cell: string, planCollisionFreeRequest: PlanCollisionFreeRequest, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<PlanCollisionFreeResponse, any>>;
7918
8109
  /**
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.
8110
+ * 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
8111
  * @summary Plan Trajectory
7921
8112
  * @param {string} cell Unique identifier addressing a cell in all API calls.
7922
8113
  * @param {PlanTrajectoryRequest} planTrajectoryRequest
@@ -7988,6 +8179,16 @@ declare const VirtualControllerApiAxiosParamCreator: (configuration?: Configurat
7988
8179
  * @throws {RequiredError}
7989
8180
  */
7990
8181
  addVirtualControllerCoordinateSystem: (cell: string, controller: string, coordinateSystem: string, coordinateSystemData: CoordinateSystemData, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
8182
+ /**
8183
+ * Adds a motion group configuration for the virtual robot controller. Fields: - Only one of **motion_group_model** or **json** should be set. - **motion_group_model**: Identifies a single motion group. See [getMotionGroupModels](#/operations/getMotionGroupModels) for supported types. - **json**: 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): 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.
8184
+ * @summary Add Motion Group
8185
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
8186
+ * @param {string} controller Unique identifier to address a controller in the cell.
8187
+ * @param {AddVirtualControllerMotionGroupRequest} addVirtualControllerMotionGroupRequest
8188
+ * @param {*} [options] Override http request option.
8189
+ * @throws {RequiredError}
8190
+ */
8191
+ addVirtualControllerMotionGroup: (cell: string, controller: string, addVirtualControllerMotionGroupRequest: AddVirtualControllerMotionGroupRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
7991
8192
  /**
7992
8193
  * 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
8194
  * @summary Add TCP
@@ -8011,6 +8212,16 @@ declare const VirtualControllerApiAxiosParamCreator: (configuration?: Configurat
8011
8212
  * @throws {RequiredError}
8012
8213
  */
8013
8214
  deleteVirtualControllerCoordinateSystem: (cell: string, controller: string, coordinateSystem: string, deleteDependent?: boolean, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
8215
+ /**
8216
+ * 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**.
8217
+ * @summary Delete Motion Group
8218
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
8219
+ * @param {string} controller Unique identifier to address a controller in the cell.
8220
+ * @param {string} motionGroup The motion-group identifier.
8221
+ * @param {*} [options] Override http request option.
8222
+ * @throws {RequiredError}
8223
+ */
8224
+ deleteVirtualControllerMotionGroup: (cell: string, controller: string, motionGroup: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
8014
8225
  /**
8015
8226
  * 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
8227
  * @summary Remove TCP
@@ -8023,7 +8234,7 @@ declare const VirtualControllerApiAxiosParamCreator: (configuration?: Configurat
8023
8234
  */
8024
8235
  deleteVirtualControllerTcp: (cell: string, controller: string, motionGroup: string, tcp: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
8025
8236
  /**
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.
8237
+ * 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
8238
  * @summary Get Emergency Stop State
8028
8239
  * @param {string} cell Unique identifier addressing a cell in all API calls.
8029
8240
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -8051,7 +8262,7 @@ declare const VirtualControllerApiAxiosParamCreator: (configuration?: Configurat
8051
8262
  */
8052
8263
  getMotionGroups: (cell: string, controller: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
8053
8264
  /**
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.
8265
+ * 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
8266
  * @summary Get Operation Mode
8056
8267
  * @param {string} cell Unique identifier addressing a cell in all API calls.
8057
8268
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -8089,7 +8300,7 @@ declare const VirtualControllerApiAxiosParamCreator: (configuration?: Configurat
8089
8300
  */
8090
8301
  listVirtualControllerTcps: (cell: string, controller: string, motionGroup: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
8091
8302
  /**
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.
8303
+ * 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
8304
  * @summary Push or Release Emergency Stop
8094
8305
  * @param {string} cell Unique identifier addressing a cell in all API calls.
8095
8306
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -8110,7 +8321,7 @@ declare const VirtualControllerApiAxiosParamCreator: (configuration?: Configurat
8110
8321
  */
8111
8322
  setMotionGroupState: (cell: string, controller: string, motionGroup: string, motionGroupJoints: MotionGroupJoints, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
8112
8323
  /**
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.
8324
+ * 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
8325
  * @summary Set Operation Mode
8115
8326
  * @param {string} cell Unique identifier addressing a cell in all API calls.
8116
8327
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -8146,6 +8357,16 @@ declare const VirtualControllerApiFp: (configuration?: Configuration) => {
8146
8357
  * @throws {RequiredError}
8147
8358
  */
8148
8359
  addVirtualControllerCoordinateSystem(cell: string, controller: string, coordinateSystem: string, coordinateSystemData: CoordinateSystemData, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
8360
+ /**
8361
+ * Adds a motion group configuration for the virtual robot controller. Fields: - Only one of **motion_group_model** or **json** should be set. - **motion_group_model**: Identifies a single motion group. See [getMotionGroupModels](#/operations/getMotionGroupModels) for supported types. - **json**: 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): 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.
8362
+ * @summary Add Motion Group
8363
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
8364
+ * @param {string} controller Unique identifier to address a controller in the cell.
8365
+ * @param {AddVirtualControllerMotionGroupRequest} addVirtualControllerMotionGroupRequest
8366
+ * @param {*} [options] Override http request option.
8367
+ * @throws {RequiredError}
8368
+ */
8369
+ addVirtualControllerMotionGroup(cell: string, controller: string, addVirtualControllerMotionGroupRequest: AddVirtualControllerMotionGroupRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
8149
8370
  /**
8150
8371
  * 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
8372
  * @summary Add TCP
@@ -8169,6 +8390,16 @@ declare const VirtualControllerApiFp: (configuration?: Configuration) => {
8169
8390
  * @throws {RequiredError}
8170
8391
  */
8171
8392
  deleteVirtualControllerCoordinateSystem(cell: string, controller: string, coordinateSystem: string, deleteDependent?: boolean, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
8393
+ /**
8394
+ * 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**.
8395
+ * @summary Delete Motion Group
8396
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
8397
+ * @param {string} controller Unique identifier to address a controller in the cell.
8398
+ * @param {string} motionGroup The motion-group identifier.
8399
+ * @param {*} [options] Override http request option.
8400
+ * @throws {RequiredError}
8401
+ */
8402
+ deleteVirtualControllerMotionGroup(cell: string, controller: string, motionGroup: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
8172
8403
  /**
8173
8404
  * 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
8405
  * @summary Remove TCP
@@ -8181,7 +8412,7 @@ declare const VirtualControllerApiFp: (configuration?: Configuration) => {
8181
8412
  */
8182
8413
  deleteVirtualControllerTcp(cell: string, controller: string, motionGroup: string, tcp: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
8183
8414
  /**
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.
8415
+ * 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
8416
  * @summary Get Emergency Stop State
8186
8417
  * @param {string} cell Unique identifier addressing a cell in all API calls.
8187
8418
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -8209,7 +8440,7 @@ declare const VirtualControllerApiFp: (configuration?: Configuration) => {
8209
8440
  */
8210
8441
  getMotionGroups(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<MotionGroupInfo>>>;
8211
8442
  /**
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.
8443
+ * 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
8444
  * @summary Get Operation Mode
8214
8445
  * @param {string} cell Unique identifier addressing a cell in all API calls.
8215
8446
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -8247,7 +8478,7 @@ declare const VirtualControllerApiFp: (configuration?: Configuration) => {
8247
8478
  */
8248
8479
  listVirtualControllerTcps(cell: string, controller: string, motionGroup: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<RobotTcp>>>;
8249
8480
  /**
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.
8481
+ * 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
8482
  * @summary Push or Release Emergency Stop
8252
8483
  * @param {string} cell Unique identifier addressing a cell in all API calls.
8253
8484
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -8268,7 +8499,7 @@ declare const VirtualControllerApiFp: (configuration?: Configuration) => {
8268
8499
  */
8269
8500
  setMotionGroupState(cell: string, controller: string, motionGroup: string, motionGroupJoints: MotionGroupJoints, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
8270
8501
  /**
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.
8502
+ * 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
8503
  * @summary Set Operation Mode
8273
8504
  * @param {string} cell Unique identifier addressing a cell in all API calls.
8274
8505
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -8304,6 +8535,16 @@ declare const VirtualControllerApiFactory: (configuration?: Configuration, baseP
8304
8535
  * @throws {RequiredError}
8305
8536
  */
8306
8537
  addVirtualControllerCoordinateSystem(cell: string, controller: string, coordinateSystem: string, coordinateSystemData: CoordinateSystemData, options?: RawAxiosRequestConfig): AxiosPromise<void>;
8538
+ /**
8539
+ * Adds a motion group configuration for the virtual robot controller. Fields: - Only one of **motion_group_model** or **json** should be set. - **motion_group_model**: Identifies a single motion group. See [getMotionGroupModels](#/operations/getMotionGroupModels) for supported types. - **json**: 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): 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.
8540
+ * @summary Add Motion Group
8541
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
8542
+ * @param {string} controller Unique identifier to address a controller in the cell.
8543
+ * @param {AddVirtualControllerMotionGroupRequest} addVirtualControllerMotionGroupRequest
8544
+ * @param {*} [options] Override http request option.
8545
+ * @throws {RequiredError}
8546
+ */
8547
+ addVirtualControllerMotionGroup(cell: string, controller: string, addVirtualControllerMotionGroupRequest: AddVirtualControllerMotionGroupRequest, options?: RawAxiosRequestConfig): AxiosPromise<void>;
8307
8548
  /**
8308
8549
  * 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
8550
  * @summary Add TCP
@@ -8327,6 +8568,16 @@ declare const VirtualControllerApiFactory: (configuration?: Configuration, baseP
8327
8568
  * @throws {RequiredError}
8328
8569
  */
8329
8570
  deleteVirtualControllerCoordinateSystem(cell: string, controller: string, coordinateSystem: string, deleteDependent?: boolean, options?: RawAxiosRequestConfig): AxiosPromise<void>;
8571
+ /**
8572
+ * 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**.
8573
+ * @summary Delete Motion Group
8574
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
8575
+ * @param {string} controller Unique identifier to address a controller in the cell.
8576
+ * @param {string} motionGroup The motion-group identifier.
8577
+ * @param {*} [options] Override http request option.
8578
+ * @throws {RequiredError}
8579
+ */
8580
+ deleteVirtualControllerMotionGroup(cell: string, controller: string, motionGroup: string, options?: RawAxiosRequestConfig): AxiosPromise<void>;
8330
8581
  /**
8331
8582
  * 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
8583
  * @summary Remove TCP
@@ -8339,7 +8590,7 @@ declare const VirtualControllerApiFactory: (configuration?: Configuration, baseP
8339
8590
  */
8340
8591
  deleteVirtualControllerTcp(cell: string, controller: string, motionGroup: string, tcp: string, options?: RawAxiosRequestConfig): AxiosPromise<void>;
8341
8592
  /**
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.
8593
+ * 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
8594
  * @summary Get Emergency Stop State
8344
8595
  * @param {string} cell Unique identifier addressing a cell in all API calls.
8345
8596
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -8367,7 +8618,7 @@ declare const VirtualControllerApiFactory: (configuration?: Configuration, baseP
8367
8618
  */
8368
8619
  getMotionGroups(cell: string, controller: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<MotionGroupInfo>>;
8369
8620
  /**
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.
8621
+ * 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
8622
  * @summary Get Operation Mode
8372
8623
  * @param {string} cell Unique identifier addressing a cell in all API calls.
8373
8624
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -8405,7 +8656,7 @@ declare const VirtualControllerApiFactory: (configuration?: Configuration, baseP
8405
8656
  */
8406
8657
  listVirtualControllerTcps(cell: string, controller: string, motionGroup: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<RobotTcp>>;
8407
8658
  /**
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.
8659
+ * 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
8660
  * @summary Push or Release Emergency Stop
8410
8661
  * @param {string} cell Unique identifier addressing a cell in all API calls.
8411
8662
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -8426,7 +8677,7 @@ declare const VirtualControllerApiFactory: (configuration?: Configuration, baseP
8426
8677
  */
8427
8678
  setMotionGroupState(cell: string, controller: string, motionGroup: string, motionGroupJoints: MotionGroupJoints, options?: RawAxiosRequestConfig): AxiosPromise<void>;
8428
8679
  /**
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.
8680
+ * 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
8681
  * @summary Set Operation Mode
8431
8682
  * @param {string} cell Unique identifier addressing a cell in all API calls.
8432
8683
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -8462,6 +8713,16 @@ declare class VirtualControllerApi extends BaseAPI {
8462
8713
  * @throws {RequiredError}
8463
8714
  */
8464
8715
  addVirtualControllerCoordinateSystem(cell: string, controller: string, coordinateSystem: string, coordinateSystemData: CoordinateSystemData, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
8716
+ /**
8717
+ * Adds a motion group configuration for the virtual robot controller. Fields: - Only one of **motion_group_model** or **json** should be set. - **motion_group_model**: Identifies a single motion group. See [getMotionGroupModels](#/operations/getMotionGroupModels) for supported types. - **json**: 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): 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.
8718
+ * @summary Add Motion Group
8719
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
8720
+ * @param {string} controller Unique identifier to address a controller in the cell.
8721
+ * @param {AddVirtualControllerMotionGroupRequest} addVirtualControllerMotionGroupRequest
8722
+ * @param {*} [options] Override http request option.
8723
+ * @throws {RequiredError}
8724
+ */
8725
+ addVirtualControllerMotionGroup(cell: string, controller: string, addVirtualControllerMotionGroupRequest: AddVirtualControllerMotionGroupRequest, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
8465
8726
  /**
8466
8727
  * 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
8728
  * @summary Add TCP
@@ -8485,6 +8746,16 @@ declare class VirtualControllerApi extends BaseAPI {
8485
8746
  * @throws {RequiredError}
8486
8747
  */
8487
8748
  deleteVirtualControllerCoordinateSystem(cell: string, controller: string, coordinateSystem: string, deleteDependent?: boolean, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
8749
+ /**
8750
+ * 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**.
8751
+ * @summary Delete Motion Group
8752
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
8753
+ * @param {string} controller Unique identifier to address a controller in the cell.
8754
+ * @param {string} motionGroup The motion-group identifier.
8755
+ * @param {*} [options] Override http request option.
8756
+ * @throws {RequiredError}
8757
+ */
8758
+ deleteVirtualControllerMotionGroup(cell: string, controller: string, motionGroup: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
8488
8759
  /**
8489
8760
  * 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
8761
  * @summary Remove TCP
@@ -8497,7 +8768,7 @@ declare class VirtualControllerApi extends BaseAPI {
8497
8768
  */
8498
8769
  deleteVirtualControllerTcp(cell: string, controller: string, motionGroup: string, tcp: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
8499
8770
  /**
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.
8771
+ * 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
8772
  * @summary Get Emergency Stop State
8502
8773
  * @param {string} cell Unique identifier addressing a cell in all API calls.
8503
8774
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -8525,7 +8796,7 @@ declare class VirtualControllerApi extends BaseAPI {
8525
8796
  */
8526
8797
  getMotionGroups(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<MotionGroupInfo[], any>>;
8527
8798
  /**
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.
8799
+ * 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
8800
  * @summary Get Operation Mode
8530
8801
  * @param {string} cell Unique identifier addressing a cell in all API calls.
8531
8802
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -8563,7 +8834,7 @@ declare class VirtualControllerApi extends BaseAPI {
8563
8834
  */
8564
8835
  listVirtualControllerTcps(cell: string, controller: string, motionGroup: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<RobotTcp[], any>>;
8565
8836
  /**
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.
8837
+ * 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
8838
  * @summary Push or Release Emergency Stop
8568
8839
  * @param {string} cell Unique identifier addressing a cell in all API calls.
8569
8840
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -8584,7 +8855,7 @@ declare class VirtualControllerApi extends BaseAPI {
8584
8855
  */
8585
8856
  setMotionGroupState(cell: string, controller: string, motionGroup: string, motionGroupJoints: MotionGroupJoints, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
8586
8857
  /**
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.
8858
+ * 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
8859
  * @summary Set Operation Mode
8589
8860
  * @param {string} cell Unique identifier addressing a cell in all API calls.
8590
8861
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -8610,7 +8881,7 @@ declare class VirtualControllerApi extends BaseAPI {
8610
8881
  */
8611
8882
  declare const VirtualControllerBehaviorApiAxiosParamCreator: (configuration?: Configuration) => {
8612
8883
  /**
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.
8884
+ * <!-- 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
8885
  * @summary Stream Joint Configuration
8615
8886
  * @param {string} cell Unique identifier addressing a cell in all API calls.
8616
8887
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -8629,7 +8900,7 @@ declare const VirtualControllerBehaviorApiAxiosParamCreator: (configuration?: Co
8629
8900
  */
8630
8901
  getCycleTime: (cell: string, controller: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
8631
8902
  /**
8632
- * Get the current virtual controller behavior. See [setVirtualControllerBehavior](setVirtualControllerBehavior) and the body for details.
8903
+ * Get the current virtual controller behavior. See [setVirtualControllerBehavior](#/operations/setVirtualControllerBehavior) and the body for details.
8633
8904
  * @summary Get Behavior
8634
8905
  * @param {string} cell Unique identifier addressing a cell in all API calls.
8635
8906
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -8653,7 +8924,7 @@ declare const VirtualControllerBehaviorApiAxiosParamCreator: (configuration?: Co
8653
8924
  */
8654
8925
  declare const VirtualControllerBehaviorApiFp: (configuration?: Configuration) => {
8655
8926
  /**
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.
8927
+ * <!-- 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
8928
  * @summary Stream Joint Configuration
8658
8929
  * @param {string} cell Unique identifier addressing a cell in all API calls.
8659
8930
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -8672,7 +8943,7 @@ declare const VirtualControllerBehaviorApiFp: (configuration?: Configuration) =>
8672
8943
  */
8673
8944
  getCycleTime(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CycleTime>>;
8674
8945
  /**
8675
- * Get the current virtual controller behavior. See [setVirtualControllerBehavior](setVirtualControllerBehavior) and the body for details.
8946
+ * Get the current virtual controller behavior. See [setVirtualControllerBehavior](#/operations/setVirtualControllerBehavior) and the body for details.
8676
8947
  * @summary Get Behavior
8677
8948
  * @param {string} cell Unique identifier addressing a cell in all API calls.
8678
8949
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -8696,7 +8967,7 @@ declare const VirtualControllerBehaviorApiFp: (configuration?: Configuration) =>
8696
8967
  */
8697
8968
  declare const VirtualControllerBehaviorApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
8698
8969
  /**
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.
8970
+ * <!-- 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
8971
  * @summary Stream Joint Configuration
8701
8972
  * @param {string} cell Unique identifier addressing a cell in all API calls.
8702
8973
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -8715,7 +8986,7 @@ declare const VirtualControllerBehaviorApiFactory: (configuration?: Configuratio
8715
8986
  */
8716
8987
  getCycleTime(cell: string, controller: string, options?: RawAxiosRequestConfig): AxiosPromise<CycleTime>;
8717
8988
  /**
8718
- * Get the current virtual controller behavior. See [setVirtualControllerBehavior](setVirtualControllerBehavior) and the body for details.
8989
+ * Get the current virtual controller behavior. See [setVirtualControllerBehavior](#/operations/setVirtualControllerBehavior) and the body for details.
8719
8990
  * @summary Get Behavior
8720
8991
  * @param {string} cell Unique identifier addressing a cell in all API calls.
8721
8992
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -8739,7 +9010,7 @@ declare const VirtualControllerBehaviorApiFactory: (configuration?: Configuratio
8739
9010
  */
8740
9011
  declare class VirtualControllerBehaviorApi extends BaseAPI {
8741
9012
  /**
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.
9013
+ * <!-- 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
9014
  * @summary Stream Joint Configuration
8744
9015
  * @param {string} cell Unique identifier addressing a cell in all API calls.
8745
9016
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -8758,7 +9029,7 @@ declare class VirtualControllerBehaviorApi extends BaseAPI {
8758
9029
  */
8759
9030
  getCycleTime(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<CycleTime, any>>;
8760
9031
  /**
8761
- * Get the current virtual controller behavior. See [setVirtualControllerBehavior](setVirtualControllerBehavior) and the body for details.
9032
+ * Get the current virtual controller behavior. See [setVirtualControllerBehavior](#/operations/setVirtualControllerBehavior) and the body for details.
8762
9033
  * @summary Get Behavior
8763
9034
  * @param {string} cell Unique identifier addressing a cell in all API calls.
8764
9035
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -8782,7 +9053,7 @@ declare class VirtualControllerBehaviorApi extends BaseAPI {
8782
9053
  */
8783
9054
  declare const VirtualControllerInputsOutputsApiAxiosParamCreator: (configuration?: Configuration) => {
8784
9055
  /**
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).
9056
+ * 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
9057
  * @summary Get Input/Output Values
8787
9058
  * @param {string} cell Unique identifier addressing a cell in all API calls.
8788
9059
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -8820,7 +9091,7 @@ declare const VirtualControllerInputsOutputsApiAxiosParamCreator: (configuration
8820
9091
  */
8821
9092
  declare const VirtualControllerInputsOutputsApiFp: (configuration?: Configuration) => {
8822
9093
  /**
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).
9094
+ * 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
9095
  * @summary Get Input/Output Values
8825
9096
  * @param {string} cell Unique identifier addressing a cell in all API calls.
8826
9097
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -8858,7 +9129,7 @@ declare const VirtualControllerInputsOutputsApiFp: (configuration?: Configuratio
8858
9129
  */
8859
9130
  declare const VirtualControllerInputsOutputsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
8860
9131
  /**
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).
9132
+ * 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
9133
  * @summary Get Input/Output Values
8863
9134
  * @param {string} cell Unique identifier addressing a cell in all API calls.
8864
9135
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -8896,7 +9167,7 @@ declare const VirtualControllerInputsOutputsApiFactory: (configuration?: Configu
8896
9167
  */
8897
9168
  declare class VirtualControllerInputsOutputsApi extends BaseAPI {
8898
9169
  /**
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).
9170
+ * 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
9171
  * @summary Get Input/Output Values
8901
9172
  * @param {string} cell Unique identifier addressing a cell in all API calls.
8902
9173
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -8930,4 +9201,4 @@ declare class VirtualControllerInputsOutputsApi extends BaseAPI {
8930
9201
  setIOValues(cell: string, controller: string, iOValue: Array<IOValue>, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
8931
9202
  }
8932
9203
  //#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 };
9204
+ 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, 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, 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, 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 };