@wandelbots/nova-api 26.2.0-dev.4 → 26.2.0-dev.54

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;
@@ -188,11 +188,11 @@ interface AddTrajectoryRequest {
188
188
  'tcp'?: string;
189
189
  }
190
190
  /**
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).
191
+ * 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
192
  */
193
193
  interface AddTrajectoryResponse {
194
194
  /**
195
- * The unique identifier of the trajectory. Use this identifier to execute the trajectory with the [executeTrajectory](executeTrajectory) endpoint.
195
+ * The unique identifier of the trajectory. Use this identifier to execute the trajectory with the [executeTrajectory](#/operations/executeTrajectory) endpoint.
196
196
  */
197
197
  'trajectory'?: string;
198
198
  /**
@@ -200,6 +200,11 @@ interface AddTrajectoryResponse {
200
200
  */
201
201
  'error'?: AddTrajectoryError;
202
202
  }
203
+ /**
204
+ * @type AddVirtualControllerMotionGroupRequest
205
+ * 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.
206
+ */
207
+ type AddVirtualControllerMotionGroupRequest = MotionGroupFromJson | MotionGroupFromType;
203
208
  interface ApiVersion {
204
209
  /**
205
210
  * The version of the API.
@@ -239,7 +244,7 @@ interface App {
239
244
  'diagnosis_path'?: string;
240
245
  }
241
246
  /**
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).
247
+ * ## 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
248
  */
244
249
  declare const Behavior: {
245
250
  readonly BehaviorAutomatic: "BEHAVIOR_AUTOMATIC";
@@ -349,7 +354,7 @@ interface BusIODescription {
349
354
  */
350
355
  'io': string;
351
356
  /**
352
- * Name of the input/output. Customize it using the respective BUS service, e.g., [addProfinetIO](addProfinetIO) for PROFINET service.
357
+ * Name of the input/output. Customize it using the respective BUS service, e.g., [addProfinetIO](#/operations/addProfinetIO) for PROFINET service.
353
358
  */
354
359
  'name': string;
355
360
  'direction': IODirection;
@@ -576,6 +581,10 @@ interface Cell {
576
581
  * 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
582
  */
578
583
  'name': string;
584
+ /**
585
+ * Wandelbots NOVA version of the cell. This version must not exceed the current system version.
586
+ */
587
+ 'version'?: string;
579
588
  /**
580
589
  * A description of the cell.
581
590
  */
@@ -777,7 +786,7 @@ interface ContainerResources {
777
786
  'memory_limit'?: string;
778
787
  }
779
788
  /**
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).
789
+ * 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
790
  */
782
791
  interface ContainerStorage {
783
792
  'mount_path': string;
@@ -912,6 +921,7 @@ interface DHParameter {
912
921
  * True, if rotation direction of joint is reversed.
913
922
  */
914
923
  'reverse_rotation_direction'?: boolean;
924
+ 'type'?: JointTypeEnum;
915
925
  }
916
926
  /**
917
927
  * The direction in which the trajectory is executed. Default: Forward.
@@ -985,7 +995,7 @@ type ErrorMaxIterationsExceededErrorFeedbackNameEnum = typeof ErrorMaxIterations
985
995
  */
986
996
  interface Execute {
987
997
  /**
988
- * Commanded joint position of each joint in [rad]. This command was sent in the time step the corresponding state was received.
998
+ * 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
999
  */
990
1000
  'joint_position': Array<number>;
991
1001
  'details'?: ExecuteDetails;
@@ -1122,11 +1132,11 @@ interface ForwardKinematics422Response {
1122
1132
  }
1123
1133
  interface ForwardKinematicsRequest {
1124
1134
  /**
1125
- * String identifiying the model of a motion group.
1135
+ * Identifies a single motion group model. See [getMotionGroupModels](#/operations/getMotionGroupModels) for supported types.
1126
1136
  */
1127
1137
  'motion_group_model': string;
1128
1138
  /**
1129
- * List of joint positions [rad] for which TCP poses are computed.
1139
+ * 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
1140
  */
1131
1141
  'joint_positions': Array<Array<number>>;
1132
1142
  'tcp_offset'?: Pose;
@@ -1343,7 +1353,7 @@ interface InitializeMovementRequest {
1343
1353
  'message_type': InitializeMovementRequestMessageTypeEnum;
1344
1354
  'trajectory': InitializeMovementRequestTrajectory;
1345
1355
  /**
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
1356
+ * - 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
1357
  */
1348
1358
  'initial_location'?: number;
1349
1359
  /**
@@ -1369,7 +1379,7 @@ interface InitializeMovementResponse {
1369
1379
  */
1370
1380
  'message'?: string;
1371
1381
  /**
1372
- * Error can occur if joint trajectory was added by [InitializeMovementRequest](InitializeMovementRequest) and the trajectory is invalid.
1382
+ * Error can occur if joint trajectory was added by InitializeMovementRequest and the trajectory is invalid.
1373
1383
  */
1374
1384
  'add_trajectory_error'?: AddTrajectoryError;
1375
1385
  'kind': InitializeMovementResponseKindEnum;
@@ -1407,7 +1417,7 @@ interface InverseKinematics422Response {
1407
1417
  }
1408
1418
  interface InverseKinematicsRequest {
1409
1419
  /**
1410
- * String identifiying the model of a motion group.
1420
+ * Identifies a single motion group model. See [getMotionGroupModels](#/operations/getMotionGroupModels) for supported types.
1411
1421
  */
1412
1422
  'motion_group_model': string;
1413
1423
  /**
@@ -1420,7 +1430,7 @@ interface InverseKinematicsRequest {
1420
1430
  */
1421
1431
  'mounting'?: Pose;
1422
1432
  /**
1423
- * Joint position limits in [rad], indexed starting from base.
1433
+ * 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
1434
  */
1425
1435
  'joint_position_limits'?: Array<LimitRange>;
1426
1436
  /**
@@ -1536,7 +1546,7 @@ interface JointLimits {
1536
1546
  }
1537
1547
  interface JointTrajectory {
1538
1548
  /**
1539
- * List of joint positions [rad] for each sample. The number of samples must match the number of timestamps provided in the times field.
1549
+ * 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
1550
  */
1541
1551
  'joint_positions': Array<Array<number>>;
1542
1552
  /**
@@ -1545,6 +1555,11 @@ interface JointTrajectory {
1545
1555
  'times': Array<number>;
1546
1556
  'locations': Array<number>;
1547
1557
  }
1558
+ declare const JointTypeEnum: {
1559
+ readonly RevoluteJoint: "REVOLUTE_JOINT";
1560
+ readonly PrismaticJoint: "PRISMATIC_JOINT";
1561
+ };
1562
+ type JointTypeEnum = typeof JointTypeEnum[keyof typeof JointTypeEnum];
1548
1563
  /**
1549
1564
  * Sets target joint velocities for jogging a motion group.
1550
1565
  */
@@ -1581,6 +1596,10 @@ type JointVelocityResponseKindEnum = typeof JointVelocityResponseKindEnum[keyof
1581
1596
  */
1582
1597
  interface KinematicModel {
1583
1598
  'dh_parameters'?: Array<DHParameter>;
1599
+ /**
1600
+ * Constant coordinate transformation between the motion group base frame and the start of the kinematic chain modeled by Denavit-Hartenberg parameters.
1601
+ */
1602
+ 'kinematic_chain_offset'?: Pose;
1584
1603
  /**
1585
1604
  * Optional name of the inverse kinematics solver.
1586
1605
  */
@@ -1711,7 +1730,7 @@ interface LimitsOverride {
1711
1730
  }
1712
1731
  interface ListTrajectoriesResponse {
1713
1732
  /**
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.
1733
+ * 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
1734
  */
1716
1735
  'trajectories'?: Array<string>;
1717
1736
  }
@@ -1833,11 +1852,11 @@ type MotionCommandBlending = BlendingAuto | BlendingPosition;
1833
1852
  */
1834
1853
  type MotionCommandPath = PathCartesianPTP | PathCircle | PathCubicSpline | PathJointPTP | PathLine;
1835
1854
  /**
1836
- * The configuration of a motion-group used for motion planning.
1855
+ * 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
1856
  */
1838
1857
  interface MotionGroupDescription {
1839
1858
  /**
1840
- * String identifiying the model of a motion group.
1859
+ * Identifies a single motion group model. See [getMotionGroupModels](#/operations/getMotionGroupModels) for supported types.
1841
1860
  */
1842
1861
  'motion_group_model': string;
1843
1862
  /**
@@ -1882,14 +1901,50 @@ interface MotionGroupDescription {
1882
1901
  */
1883
1902
  'cycle_time'?: number;
1884
1903
  /**
1885
- * The DH parameters describing the motion group geometry, starting from base.
1904
+ * The Denavit-Hartenberg parameters describing the motion group kinematics.
1886
1905
  */
1887
1906
  'dh_parameters'?: Array<DHParameter>;
1907
+ /**
1908
+ * 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.
1909
+ */
1910
+ 'kinematic_chain_offset'?: Pose;
1888
1911
  /**
1889
1912
  * The serial number of the motion group, if available. If not available, the serial number of the robot controller. If not available, empty.
1890
1913
  */
1891
1914
  'serial_number'?: string;
1892
1915
  }
1916
+ interface MotionGroupFromJson {
1917
+ /**
1918
+ * Unique identifier for the motion group to be added.
1919
+ */
1920
+ 'motion_group': string;
1921
+ /**
1922
+ * Full JSON configuration of the virtual robot controller. This can be obtained from the physical controller\'s configuration via [getVirtualControllerConfiguration](#/operations/getVirtualControllerConfiguration).
1923
+ */
1924
+ 'json': string;
1925
+ /**
1926
+ * The identifier of the motion group that needs to be extracted from the provided JSON configuration.
1927
+ */
1928
+ 'extracted_motion_group_id': string;
1929
+ /**
1930
+ * 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.
1931
+ */
1932
+ 'initial_joint_position'?: string;
1933
+ }
1934
+ interface MotionGroupFromType {
1935
+ /**
1936
+ * Unique identifier for the motion group to be added.
1937
+ */
1938
+ 'motion_group': string;
1939
+ /**
1940
+ * Identifies a single motion group model. See [getMotionGroupModels](#/operations/getMotionGroupModels) for supported types.
1941
+ */
1942
+ 'motion_group_model': string;
1943
+ /**
1944
+ * 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.
1945
+ */
1946
+ 'initial_joint_position'?: string;
1947
+ }
1893
1948
  interface MotionGroupInfo {
1894
1949
  /**
1895
1950
  * The unique identifier of the motion group. Use it to refer to the motion group in other calls.
@@ -1905,7 +1960,7 @@ interface MotionGroupInfo {
1905
1960
  'dof': number;
1906
1961
  }
1907
1962
  /**
1908
- * Ensure to provide one value for each joint. See [getMotionGroups](getMotionGroups) for the number of joints. Everything but positions is optional.
1963
+ * Ensure to provide one value for each joint. See [getMotionGroups](#/operations/getMotionGroups) for the number of joints. Everything but positions is optional.
1909
1964
  */
1910
1965
  interface MotionGroupJoints {
1911
1966
  /**
@@ -1927,7 +1982,7 @@ interface MotionGroupJoints {
1927
1982
  }
1928
1983
  interface MotionGroupSetup {
1929
1984
  /**
1930
- * String identifiying the model of a motion group.
1985
+ * Identifies a single motion group model. See [getMotionGroupModels](#/operations/getMotionGroupModels) for supported types.
1931
1986
  */
1932
1987
  'motion_group_model': string;
1933
1988
  /**
@@ -1985,7 +2040,7 @@ interface MotionGroupState {
1985
2040
  */
1986
2041
  'joint_current'?: Array<number>;
1987
2042
  /**
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.
2043
+ * 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
2044
  */
1990
2045
  'flange_pose'?: Pose;
1991
2046
  /**
@@ -1993,7 +2048,7 @@ interface MotionGroupState {
1993
2048
  */
1994
2049
  'tcp'?: string;
1995
2050
  /**
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.
2051
+ * 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
2052
  */
1998
2053
  'tcp_pose'?: Pose;
1999
2054
  /**
@@ -2279,11 +2334,11 @@ declare const PauseMovementRequestMessageTypeEnum: {
2279
2334
  };
2280
2335
  type PauseMovementRequestMessageTypeEnum = typeof PauseMovementRequestMessageTypeEnum[keyof typeof PauseMovementRequestMessageTypeEnum];
2281
2336
  /**
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).
2337
+ * 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
2338
  */
2284
2339
  interface PauseMovementResponse {
2285
2340
  /**
2286
- * Error message in case of invalid PauseMovementResquest.
2341
+ * Error message in case of invalid PauseMovementRequest.
2287
2342
  */
2288
2343
  'message'?: string;
2289
2344
  'kind': PauseMovementResponseKindEnum;
@@ -2329,7 +2384,7 @@ interface PlanCollisionFreeFailedResponse {
2329
2384
  }
2330
2385
  interface PlanCollisionFreeRequest {
2331
2386
  /**
2332
- * The data to assemble the robot setup can be retrieved from [getMotionGroupDescription](getMotionGroupDescription) endpoint.
2387
+ * The data to assemble the robot setup can be retrieved from the [getMotionGroupDescription](#/operations/getMotionGroupDescription) endpoint.
2333
2388
  */
2334
2389
  'motion_group_setup': MotionGroupSetup;
2335
2390
  'start_joint_position': Array<number>;
@@ -2349,7 +2404,7 @@ type PlanCollisionFreeResponseResponse = JointTrajectory | PlanCollisionFreeFail
2349
2404
  interface PlanTrajectoryFailedResponse {
2350
2405
  'error_feedback': PlanTrajectoryFailedResponseErrorFeedback;
2351
2406
  /**
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
2407
+ * - 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
2408
  */
2354
2409
  'error_location_on_trajectory': number;
2355
2410
  /**
@@ -2363,7 +2418,7 @@ interface PlanTrajectoryFailedResponse {
2363
2418
  type PlanTrajectoryFailedResponseErrorFeedback = FeedbackCollision | FeedbackJointLimitExceeded | FeedbackOutOfWorkspace | FeedbackSingularity;
2364
2419
  interface PlanTrajectoryRequest {
2365
2420
  /**
2366
- * The data to assemble the robot setup can be retrieved from [getMotionGroupDescription](getMotionGroupDescription) endpoint.
2421
+ * The data to assemble the robot setup can be retrieved from [getMotionGroupDescription](#/operations/getMotionGroupDescription) endpoint.
2367
2422
  */
2368
2423
  'motion_group_setup': MotionGroupSetup;
2369
2424
  'start_joint_position': Array<number>;
@@ -2730,7 +2785,7 @@ declare const RectangularCapsuleShapeTypeEnum: {
2730
2785
  };
2731
2786
  type RectangularCapsuleShapeTypeEnum = typeof RectangularCapsuleShapeTypeEnum[keyof typeof RectangularCapsuleShapeTypeEnum];
2732
2787
  /**
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
2788
+ * The channel that defines what a new Wandelbots NOVA version is. * `next` the latest version * `stable` newest patch of the current version
2734
2789
  */
2735
2790
  declare const ReleaseChannel: {
2736
2791
  readonly Stable: "stable";
@@ -2787,7 +2842,7 @@ interface RobotControllerState {
2787
2842
  'motion_groups': Array<MotionGroupState>;
2788
2843
  }
2789
2844
  /**
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.
2845
+ * 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
2846
  */
2792
2847
  declare const RobotSystemMode: {
2793
2848
  readonly ModeControllerNotConfigured: "MODE_CONTROLLER_NOT_CONFIGURED";
@@ -2911,9 +2966,14 @@ interface SetIO {
2911
2966
  'location': number;
2912
2967
  'io_origin': IOOrigin;
2913
2968
  }
2969
+ /**
2970
+ * Defines available system modes of the robot system. Short versions (no \"ROBOT_SYSTEM_\" prefix) are provided, reusing strings from [getMode](#/operations/getMode) responses.
2971
+ */
2914
2972
  declare const SettableRobotSystemMode: {
2915
2973
  readonly RobotSystemModeMonitor: "ROBOT_SYSTEM_MODE_MONITOR";
2974
+ readonly ModeMonitor: "MODE_MONITOR";
2916
2975
  readonly RobotSystemModeControl: "ROBOT_SYSTEM_MODE_CONTROL";
2976
+ readonly ModeControl: "MODE_CONTROL";
2917
2977
  };
2918
2978
  type SettableRobotSystemMode = typeof SettableRobotSystemMode[keyof typeof SettableRobotSystemMode];
2919
2979
  declare const SingularityTypeEnum: {
@@ -2937,7 +2997,7 @@ declare const SphereShapeTypeEnum: {
2937
2997
  };
2938
2998
  type SphereShapeTypeEnum = typeof SphereShapeTypeEnum[keyof typeof SphereShapeTypeEnum];
2939
2999
  /**
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.
3000
+ * 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
3001
  */
2942
3002
  interface StartMovementRequest {
2943
3003
  /**
@@ -2946,7 +3006,7 @@ interface StartMovementRequest {
2946
3006
  'message_type': StartMovementRequestMessageTypeEnum;
2947
3007
  'direction'?: Direction;
2948
3008
  /**
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
3009
+ * - 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
3010
  */
2951
3011
  'target_location'?: number;
2952
3012
  /**
@@ -2967,7 +3027,7 @@ declare const StartMovementRequestMessageTypeEnum: {
2967
3027
  };
2968
3028
  type StartMovementRequestMessageTypeEnum = typeof StartMovementRequestMessageTypeEnum[keyof typeof StartMovementRequestMessageTypeEnum];
2969
3029
  /**
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.
3030
+ * 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
3031
  */
2972
3032
  interface StartMovementResponse {
2973
3033
  /**
@@ -3019,7 +3079,7 @@ interface TcpRequiredError {
3019
3079
  'tcp_missing'?: any;
3020
3080
  }
3021
3081
  /**
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.
3082
+ * 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
3083
  */
3024
3084
  interface TcpVelocityRequest {
3025
3085
  /**
@@ -3101,7 +3161,7 @@ interface TrajectoryDetails {
3101
3161
  */
3102
3162
  'trajectory': string;
3103
3163
  /**
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
3164
+ * - 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
3165
  */
3106
3166
  'location': number;
3107
3167
  'state': TrajectoryDetailsState;
@@ -3144,7 +3204,7 @@ interface TrajectoryId {
3144
3204
  */
3145
3205
  'message_type': TrajectoryIdMessageTypeEnum;
3146
3206
  /**
3147
- * The identifier of the trajectory which was returned by the [addTrajectory](addTrajectory) endpoint.
3207
+ * The identifier of the trajectory which was returned by the [addTrajectory](#/operations/addTrajectory) endpoint.
3148
3208
  */
3149
3209
  'id': string;
3150
3210
  }
@@ -3223,11 +3283,21 @@ declare const UniversalrobotsControllerKindEnum: {
3223
3283
  readonly UniversalrobotsController: "UniversalrobotsController";
3224
3284
  };
3225
3285
  type UniversalrobotsControllerKindEnum = typeof UniversalrobotsControllerKindEnum[keyof typeof UniversalrobotsControllerKindEnum];
3286
+ /**
3287
+ * Update a single cell\'s Foundation chart version based on the indicated release channel.
3288
+ */
3289
+ interface UpdateCellVersionRequest {
3290
+ 'channel': ReleaseChannel;
3291
+ }
3226
3292
  /**
3227
3293
  * An update is defined by the indicated Wandelbots NOVA release channel.
3228
3294
  */
3229
3295
  interface UpdateNovaVersionRequest {
3230
3296
  'channel': ReleaseChannel;
3297
+ /**
3298
+ * Update unpinned cells during system update. Cells with an explicit chart version are never updated by a system update, regardless of this setting.
3299
+ */
3300
+ 'update_cells'?: boolean;
3231
3301
  }
3232
3302
  interface ValidationError {
3233
3303
  'loc': Array<ValidationErrorLocInner>;
@@ -3250,17 +3320,17 @@ interface ValidationError2 {
3250
3320
  */
3251
3321
  type ValidationErrorLocInner = number | string;
3252
3322
  /**
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.
3323
+ * 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
3324
  */
3255
3325
  interface VirtualController {
3256
3326
  'kind': VirtualControllerKindEnum;
3257
3327
  'manufacturer': Manufacturer;
3258
3328
  /**
3259
- * Preset type of the virtual robot controller. See [getRobotConfigurations](getRobotConfigurations) for supported types.
3329
+ * Preset type of the virtual robot controller. See [getRobotConfigurations](#/operations/getRobotConfigurations) for supported types.
3260
3330
  */
3261
3331
  'type'?: string;
3262
3332
  /**
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.
3333
+ * 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
3334
  */
3265
3335
  'json'?: string;
3266
3336
  /**
@@ -3278,7 +3348,7 @@ interface VirtualRobotConfiguration {
3278
3348
  */
3279
3349
  'name': string;
3280
3350
  /**
3281
- * Content of the configuration file. Copy & paste to the [addRobotController](addRobotController) configuration.json parameter.
3351
+ * Content of the configuration file. Copy & paste to the [addRobotController](#/operations/addRobotController) configuration.json parameter.
3282
3352
  */
3283
3353
  'content': string;
3284
3354
  }
@@ -3337,7 +3407,7 @@ declare const ApplicationApiAxiosParamCreator: (configuration?: Configuration) =
3337
3407
  */
3338
3408
  deleteApp: (cell: string, app: string, completionTimeout?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
3339
3409
  /**
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).
3410
+ * 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
3411
  * @summary Configuration
3342
3412
  * @param {string} cell Unique identifier addressing a cell in all API calls.
3343
3413
  * @param {string} app
@@ -3346,7 +3416,7 @@ declare const ApplicationApiAxiosParamCreator: (configuration?: Configuration) =
3346
3416
  */
3347
3417
  getApp: (cell: string, app: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
3348
3418
  /**
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.
3419
+ * 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
3420
  * @summary List Applications
3351
3421
  * @param {string} cell Unique identifier addressing a cell in all API calls.
3352
3422
  * @param {*} [options] Override http request option.
@@ -3399,7 +3469,7 @@ declare const ApplicationApiFp: (configuration?: Configuration) => {
3399
3469
  */
3400
3470
  deleteApp(cell: string, app: string, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
3401
3471
  /**
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).
3472
+ * 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
3473
  * @summary Configuration
3404
3474
  * @param {string} cell Unique identifier addressing a cell in all API calls.
3405
3475
  * @param {string} app
@@ -3408,7 +3478,7 @@ declare const ApplicationApiFp: (configuration?: Configuration) => {
3408
3478
  */
3409
3479
  getApp(cell: string, app: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<App>>;
3410
3480
  /**
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.
3481
+ * 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
3482
  * @summary List Applications
3413
3483
  * @param {string} cell Unique identifier addressing a cell in all API calls.
3414
3484
  * @param {*} [options] Override http request option.
@@ -3461,7 +3531,7 @@ declare const ApplicationApiFactory: (configuration?: Configuration, basePath?:
3461
3531
  */
3462
3532
  deleteApp(cell: string, app: string, completionTimeout?: number, options?: RawAxiosRequestConfig): AxiosPromise<void>;
3463
3533
  /**
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).
3534
+ * 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
3535
  * @summary Configuration
3466
3536
  * @param {string} cell Unique identifier addressing a cell in all API calls.
3467
3537
  * @param {string} app
@@ -3470,7 +3540,7 @@ declare const ApplicationApiFactory: (configuration?: Configuration, basePath?:
3470
3540
  */
3471
3541
  getApp(cell: string, app: string, options?: RawAxiosRequestConfig): AxiosPromise<App>;
3472
3542
  /**
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.
3543
+ * 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
3544
  * @summary List Applications
3475
3545
  * @param {string} cell Unique identifier addressing a cell in all API calls.
3476
3546
  * @param {*} [options] Override http request option.
@@ -3523,7 +3593,7 @@ declare class ApplicationApi extends BaseAPI {
3523
3593
  */
3524
3594
  deleteApp(cell: string, app: string, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
3525
3595
  /**
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).
3596
+ * 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
3597
  * @summary Configuration
3528
3598
  * @param {string} cell Unique identifier addressing a cell in all API calls.
3529
3599
  * @param {string} app
@@ -3532,7 +3602,7 @@ declare class ApplicationApi extends BaseAPI {
3532
3602
  */
3533
3603
  getApp(cell: string, app: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<App, any>>;
3534
3604
  /**
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.
3605
+ * 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
3606
  * @summary List Applications
3537
3607
  * @param {string} cell Unique identifier addressing a cell in all API calls.
3538
3608
  * @param {*} [options] Override http request option.
@@ -3566,7 +3636,7 @@ declare const BUSInputsOutputsApiAxiosParamCreator: (configuration?: Configurati
3566
3636
  */
3567
3637
  addBusIOService: (cell: string, busIOType: BusIOType, completionTimeout?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
3568
3638
  /**
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).
3639
+ * 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
3640
  * @summary Add MODBUS Input/Output
3571
3641
  * @param {string} cell Unique identifier addressing a cell in all API calls.
3572
3642
  * @param {string} io Unique identifier to address an Input/Output in the cell.
@@ -3576,7 +3646,7 @@ declare const BUSInputsOutputsApiAxiosParamCreator: (configuration?: Configurati
3576
3646
  */
3577
3647
  addModbusIO: (cell: string, io: string, modbusIOData: ModbusIOData, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
3578
3648
  /**
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).
3649
+ * 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
3650
  * @summary Add PROFINET Input/Output
3581
3651
  * @param {string} cell Unique identifier addressing a cell in all API calls.
3582
3652
  * @param {string} io Unique identifier to address an Input/Output in the cell.
@@ -3612,7 +3682,7 @@ declare const BUSInputsOutputsApiAxiosParamCreator: (configuration?: Configurati
3612
3682
  deleteAllProfinetIOs: (cell: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
3613
3683
  /**
3614
3684
  * Removes an input/output variable configuration from the MODBUS device, e.g., NOVA\'s MODBUS service.
3615
- * @summary Remove MODBUS Input/Ouptut
3685
+ * @summary Remove MODBUS Input/Output
3616
3686
  * @param {string} cell Unique identifier addressing a cell in all API calls.
3617
3687
  * @param {string} io Unique identifier to address an Input/Output in the cell.
3618
3688
  * @param {*} [options] Override http request option.
@@ -3645,7 +3715,7 @@ declare const BUSInputsOutputsApiAxiosParamCreator: (configuration?: Configurati
3645
3715
  */
3646
3716
  getBusIOState: (cell: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
3647
3717
  /**
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).
3718
+ * 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
3719
  * @summary Get Input/Output Values
3650
3720
  * @param {string} cell Unique identifier addressing a cell in all API calls.
3651
3721
  * @param {Array<string>} [ios]
@@ -3680,7 +3750,7 @@ declare const BUSInputsOutputsApiAxiosParamCreator: (configuration?: Configurati
3680
3750
  */
3681
3751
  listBusIODescriptions: (cell: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
3682
3752
  /**
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).
3753
+ * 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
3754
  * @summary List MODBUS Input/Output Configuration
3685
3755
  * @param {string} cell Unique identifier addressing a cell in all API calls.
3686
3756
  * @param {*} [options] Override http request option.
@@ -3688,7 +3758,7 @@ declare const BUSInputsOutputsApiAxiosParamCreator: (configuration?: Configurati
3688
3758
  */
3689
3759
  listModbusIOs: (cell: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
3690
3760
  /**
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.
3761
+ * 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
3762
  * @summary List PROFINET Input/Output Configuration
3693
3763
  * @param {string} cell Unique identifier addressing a cell in all API calls.
3694
3764
  * @param {*} [options] Override http request option.
@@ -3696,7 +3766,7 @@ declare const BUSInputsOutputsApiAxiosParamCreator: (configuration?: Configurati
3696
3766
  */
3697
3767
  listProfinetIOs: (cell: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
3698
3768
  /**
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.
3769
+ * 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
3770
  * @summary Set Output Values
3701
3771
  * @param {string} cell Unique identifier addressing a cell in all API calls.
3702
3772
  * @param {Array<IOValue>} iOValue
@@ -3705,7 +3775,7 @@ declare const BUSInputsOutputsApiAxiosParamCreator: (configuration?: Configurati
3705
3775
  */
3706
3776
  setBusIOValues: (cell: string, iOValue: Array<IOValue>, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
3707
3777
  /**
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.
3778
+ * 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
3779
  * @summary Set PROFINET Inputs/Outputs from File
3710
3780
  * @param {string} cell Unique identifier addressing a cell in all API calls.
3711
3781
  * @param {ProfinetInputOutputConfig} profinetInputOutputConfig
@@ -3729,7 +3799,7 @@ declare const BUSInputsOutputsApiFp: (configuration?: Configuration) => {
3729
3799
  */
3730
3800
  addBusIOService(cell: string, busIOType: BusIOType, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
3731
3801
  /**
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).
3802
+ * 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
3803
  * @summary Add MODBUS Input/Output
3734
3804
  * @param {string} cell Unique identifier addressing a cell in all API calls.
3735
3805
  * @param {string} io Unique identifier to address an Input/Output in the cell.
@@ -3739,7 +3809,7 @@ declare const BUSInputsOutputsApiFp: (configuration?: Configuration) => {
3739
3809
  */
3740
3810
  addModbusIO(cell: string, io: string, modbusIOData: ModbusIOData, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
3741
3811
  /**
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).
3812
+ * 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
3813
  * @summary Add PROFINET Input/Output
3744
3814
  * @param {string} cell Unique identifier addressing a cell in all API calls.
3745
3815
  * @param {string} io Unique identifier to address an Input/Output in the cell.
@@ -3775,7 +3845,7 @@ declare const BUSInputsOutputsApiFp: (configuration?: Configuration) => {
3775
3845
  deleteAllProfinetIOs(cell: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
3776
3846
  /**
3777
3847
  * Removes an input/output variable configuration from the MODBUS device, e.g., NOVA\'s MODBUS service.
3778
- * @summary Remove MODBUS Input/Ouptut
3848
+ * @summary Remove MODBUS Input/Output
3779
3849
  * @param {string} cell Unique identifier addressing a cell in all API calls.
3780
3850
  * @param {string} io Unique identifier to address an Input/Output in the cell.
3781
3851
  * @param {*} [options] Override http request option.
@@ -3808,7 +3878,7 @@ declare const BUSInputsOutputsApiFp: (configuration?: Configuration) => {
3808
3878
  */
3809
3879
  getBusIOState(cell: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BusIOsState>>;
3810
3880
  /**
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).
3881
+ * 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
3882
  * @summary Get Input/Output Values
3813
3883
  * @param {string} cell Unique identifier addressing a cell in all API calls.
3814
3884
  * @param {Array<string>} [ios]
@@ -3843,7 +3913,7 @@ declare const BUSInputsOutputsApiFp: (configuration?: Configuration) => {
3843
3913
  */
3844
3914
  listBusIODescriptions(cell: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<BusIODescription>>>;
3845
3915
  /**
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).
3916
+ * 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
3917
  * @summary List MODBUS Input/Output Configuration
3848
3918
  * @param {string} cell Unique identifier addressing a cell in all API calls.
3849
3919
  * @param {*} [options] Override http request option.
@@ -3851,7 +3921,7 @@ declare const BUSInputsOutputsApiFp: (configuration?: Configuration) => {
3851
3921
  */
3852
3922
  listModbusIOs(cell: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<ModbusIO>>>;
3853
3923
  /**
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.
3924
+ * 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
3925
  * @summary List PROFINET Input/Output Configuration
3856
3926
  * @param {string} cell Unique identifier addressing a cell in all API calls.
3857
3927
  * @param {*} [options] Override http request option.
@@ -3859,7 +3929,7 @@ declare const BUSInputsOutputsApiFp: (configuration?: Configuration) => {
3859
3929
  */
3860
3930
  listProfinetIOs(cell: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<ProfinetIO>>>;
3861
3931
  /**
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.
3932
+ * 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
3933
  * @summary Set Output Values
3864
3934
  * @param {string} cell Unique identifier addressing a cell in all API calls.
3865
3935
  * @param {Array<IOValue>} iOValue
@@ -3868,7 +3938,7 @@ declare const BUSInputsOutputsApiFp: (configuration?: Configuration) => {
3868
3938
  */
3869
3939
  setBusIOValues(cell: string, iOValue: Array<IOValue>, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
3870
3940
  /**
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.
3941
+ * 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
3942
  * @summary Set PROFINET Inputs/Outputs from File
3873
3943
  * @param {string} cell Unique identifier addressing a cell in all API calls.
3874
3944
  * @param {ProfinetInputOutputConfig} profinetInputOutputConfig
@@ -3892,7 +3962,7 @@ declare const BUSInputsOutputsApiFactory: (configuration?: Configuration, basePa
3892
3962
  */
3893
3963
  addBusIOService(cell: string, busIOType: BusIOType, completionTimeout?: number, options?: RawAxiosRequestConfig): AxiosPromise<void>;
3894
3964
  /**
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).
3965
+ * 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
3966
  * @summary Add MODBUS Input/Output
3897
3967
  * @param {string} cell Unique identifier addressing a cell in all API calls.
3898
3968
  * @param {string} io Unique identifier to address an Input/Output in the cell.
@@ -3902,7 +3972,7 @@ declare const BUSInputsOutputsApiFactory: (configuration?: Configuration, basePa
3902
3972
  */
3903
3973
  addModbusIO(cell: string, io: string, modbusIOData: ModbusIOData, options?: RawAxiosRequestConfig): AxiosPromise<void>;
3904
3974
  /**
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).
3975
+ * 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
3976
  * @summary Add PROFINET Input/Output
3907
3977
  * @param {string} cell Unique identifier addressing a cell in all API calls.
3908
3978
  * @param {string} io Unique identifier to address an Input/Output in the cell.
@@ -3938,7 +4008,7 @@ declare const BUSInputsOutputsApiFactory: (configuration?: Configuration, basePa
3938
4008
  deleteAllProfinetIOs(cell: string, options?: RawAxiosRequestConfig): AxiosPromise<void>;
3939
4009
  /**
3940
4010
  * Removes an input/output variable configuration from the MODBUS device, e.g., NOVA\'s MODBUS service.
3941
- * @summary Remove MODBUS Input/Ouptut
4011
+ * @summary Remove MODBUS Input/Output
3942
4012
  * @param {string} cell Unique identifier addressing a cell in all API calls.
3943
4013
  * @param {string} io Unique identifier to address an Input/Output in the cell.
3944
4014
  * @param {*} [options] Override http request option.
@@ -3971,7 +4041,7 @@ declare const BUSInputsOutputsApiFactory: (configuration?: Configuration, basePa
3971
4041
  */
3972
4042
  getBusIOState(cell: string, options?: RawAxiosRequestConfig): AxiosPromise<BusIOsState>;
3973
4043
  /**
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).
4044
+ * 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
4045
  * @summary Get Input/Output Values
3976
4046
  * @param {string} cell Unique identifier addressing a cell in all API calls.
3977
4047
  * @param {Array<string>} [ios]
@@ -4006,7 +4076,7 @@ declare const BUSInputsOutputsApiFactory: (configuration?: Configuration, basePa
4006
4076
  */
4007
4077
  listBusIODescriptions(cell: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<BusIODescription>>;
4008
4078
  /**
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).
4079
+ * 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
4080
  * @summary List MODBUS Input/Output Configuration
4011
4081
  * @param {string} cell Unique identifier addressing a cell in all API calls.
4012
4082
  * @param {*} [options] Override http request option.
@@ -4014,7 +4084,7 @@ declare const BUSInputsOutputsApiFactory: (configuration?: Configuration, basePa
4014
4084
  */
4015
4085
  listModbusIOs(cell: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<ModbusIO>>;
4016
4086
  /**
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.
4087
+ * 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
4088
  * @summary List PROFINET Input/Output Configuration
4019
4089
  * @param {string} cell Unique identifier addressing a cell in all API calls.
4020
4090
  * @param {*} [options] Override http request option.
@@ -4022,7 +4092,7 @@ declare const BUSInputsOutputsApiFactory: (configuration?: Configuration, basePa
4022
4092
  */
4023
4093
  listProfinetIOs(cell: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<ProfinetIO>>;
4024
4094
  /**
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.
4095
+ * 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
4096
  * @summary Set Output Values
4027
4097
  * @param {string} cell Unique identifier addressing a cell in all API calls.
4028
4098
  * @param {Array<IOValue>} iOValue
@@ -4031,7 +4101,7 @@ declare const BUSInputsOutputsApiFactory: (configuration?: Configuration, basePa
4031
4101
  */
4032
4102
  setBusIOValues(cell: string, iOValue: Array<IOValue>, options?: RawAxiosRequestConfig): AxiosPromise<void>;
4033
4103
  /**
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.
4104
+ * 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
4105
  * @summary Set PROFINET Inputs/Outputs from File
4036
4106
  * @param {string} cell Unique identifier addressing a cell in all API calls.
4037
4107
  * @param {ProfinetInputOutputConfig} profinetInputOutputConfig
@@ -4055,7 +4125,7 @@ declare class BUSInputsOutputsApi extends BaseAPI {
4055
4125
  */
4056
4126
  addBusIOService(cell: string, busIOType: BusIOType, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
4057
4127
  /**
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).
4128
+ * 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
4129
  * @summary Add MODBUS Input/Output
4060
4130
  * @param {string} cell Unique identifier addressing a cell in all API calls.
4061
4131
  * @param {string} io Unique identifier to address an Input/Output in the cell.
@@ -4065,7 +4135,7 @@ declare class BUSInputsOutputsApi extends BaseAPI {
4065
4135
  */
4066
4136
  addModbusIO(cell: string, io: string, modbusIOData: ModbusIOData, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
4067
4137
  /**
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).
4138
+ * 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
4139
  * @summary Add PROFINET Input/Output
4070
4140
  * @param {string} cell Unique identifier addressing a cell in all API calls.
4071
4141
  * @param {string} io Unique identifier to address an Input/Output in the cell.
@@ -4101,7 +4171,7 @@ declare class BUSInputsOutputsApi extends BaseAPI {
4101
4171
  deleteAllProfinetIOs(cell: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
4102
4172
  /**
4103
4173
  * Removes an input/output variable configuration from the MODBUS device, e.g., NOVA\'s MODBUS service.
4104
- * @summary Remove MODBUS Input/Ouptut
4174
+ * @summary Remove MODBUS Input/Output
4105
4175
  * @param {string} cell Unique identifier addressing a cell in all API calls.
4106
4176
  * @param {string} io Unique identifier to address an Input/Output in the cell.
4107
4177
  * @param {*} [options] Override http request option.
@@ -4134,7 +4204,7 @@ declare class BUSInputsOutputsApi extends BaseAPI {
4134
4204
  */
4135
4205
  getBusIOState(cell: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<BusIOsState, any>>;
4136
4206
  /**
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).
4207
+ * 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
4208
  * @summary Get Input/Output Values
4139
4209
  * @param {string} cell Unique identifier addressing a cell in all API calls.
4140
4210
  * @param {Array<string>} [ios]
@@ -4169,7 +4239,7 @@ declare class BUSInputsOutputsApi extends BaseAPI {
4169
4239
  */
4170
4240
  listBusIODescriptions(cell: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<BusIODescription[], any>>;
4171
4241
  /**
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).
4242
+ * 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
4243
  * @summary List MODBUS Input/Output Configuration
4174
4244
  * @param {string} cell Unique identifier addressing a cell in all API calls.
4175
4245
  * @param {*} [options] Override http request option.
@@ -4177,7 +4247,7 @@ declare class BUSInputsOutputsApi extends BaseAPI {
4177
4247
  */
4178
4248
  listModbusIOs(cell: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<ModbusIO[], any>>;
4179
4249
  /**
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.
4250
+ * 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
4251
  * @summary List PROFINET Input/Output Configuration
4182
4252
  * @param {string} cell Unique identifier addressing a cell in all API calls.
4183
4253
  * @param {*} [options] Override http request option.
@@ -4185,7 +4255,7 @@ declare class BUSInputsOutputsApi extends BaseAPI {
4185
4255
  */
4186
4256
  listProfinetIOs(cell: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<ProfinetIO[], any>>;
4187
4257
  /**
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.
4258
+ * 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
4259
  * @summary Set Output Values
4190
4260
  * @param {string} cell Unique identifier addressing a cell in all API calls.
4191
4261
  * @param {Array<IOValue>} iOValue
@@ -4194,7 +4264,7 @@ declare class BUSInputsOutputsApi extends BaseAPI {
4194
4264
  */
4195
4265
  setBusIOValues(cell: string, iOValue: Array<IOValue>, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
4196
4266
  /**
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.
4267
+ * 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
4268
  * @summary Set PROFINET Inputs/Outputs from File
4199
4269
  * @param {string} cell Unique identifier addressing a cell in all API calls.
4200
4270
  * @param {ProfinetInputOutputConfig} profinetInputOutputConfig
@@ -4207,6 +4277,15 @@ declare class BUSInputsOutputsApi extends BaseAPI {
4207
4277
  * CellApi - axios parameter creator
4208
4278
  */
4209
4279
  declare const CellApiAxiosParamCreator: (configuration?: Configuration) => {
4280
+ /**
4281
+ * Check if a more recent Wandelbots NOVA version is available for the cell. Updates greater than the system version are ignored.
4282
+ * @summary Check Cell Update
4283
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
4284
+ * @param {ReleaseChannel} channel
4285
+ * @param {*} [options] Override http request option.
4286
+ * @throws {RequiredError}
4287
+ */
4288
+ checkCellVersionUpdate: (cell: string, channel: ReleaseChannel, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
4210
4289
  /**
4211
4290
  * Delete an entire cell.
4212
4291
  * @summary Delete Cell
@@ -4267,11 +4346,29 @@ declare const CellApiAxiosParamCreator: (configuration?: Configuration) => {
4267
4346
  * @throws {RequiredError}
4268
4347
  */
4269
4348
  updateCell: (cell: string, cell2: Cell, completionTimeout?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
4349
+ /**
4350
+ * Update the Foundation chart version for a single cell based on a release channel. The resulting version is capped at the current system version.
4351
+ * @summary Update Cell Version
4352
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
4353
+ * @param {UpdateCellVersionRequest} updateCellVersionRequest
4354
+ * @param {*} [options] Override http request option.
4355
+ * @throws {RequiredError}
4356
+ */
4357
+ updateCellVersion: (cell: string, updateCellVersionRequest: UpdateCellVersionRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
4270
4358
  };
4271
4359
  /**
4272
4360
  * CellApi - functional programming interface
4273
4361
  */
4274
4362
  declare const CellApiFp: (configuration?: Configuration) => {
4363
+ /**
4364
+ * Check if a more recent Wandelbots NOVA version is available for the cell. Updates greater than the system version are ignored.
4365
+ * @summary Check Cell Update
4366
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
4367
+ * @param {ReleaseChannel} channel
4368
+ * @param {*} [options] Override http request option.
4369
+ * @throws {RequiredError}
4370
+ */
4371
+ checkCellVersionUpdate(cell: string, channel: ReleaseChannel, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<string>>;
4275
4372
  /**
4276
4373
  * Delete an entire cell.
4277
4374
  * @summary Delete Cell
@@ -4332,11 +4429,29 @@ declare const CellApiFp: (configuration?: Configuration) => {
4332
4429
  * @throws {RequiredError}
4333
4430
  */
4334
4431
  updateCell(cell: string, cell2: Cell, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
4432
+ /**
4433
+ * Update the Foundation chart version for a single cell based on a release channel. The resulting version is capped at the current system version.
4434
+ * @summary Update Cell Version
4435
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
4436
+ * @param {UpdateCellVersionRequest} updateCellVersionRequest
4437
+ * @param {*} [options] Override http request option.
4438
+ * @throws {RequiredError}
4439
+ */
4440
+ updateCellVersion(cell: string, updateCellVersionRequest: UpdateCellVersionRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
4335
4441
  };
4336
4442
  /**
4337
4443
  * CellApi - factory interface
4338
4444
  */
4339
4445
  declare const CellApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
4446
+ /**
4447
+ * Check if a more recent Wandelbots NOVA version is available for the cell. Updates greater than the system version are ignored.
4448
+ * @summary Check Cell Update
4449
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
4450
+ * @param {ReleaseChannel} channel
4451
+ * @param {*} [options] Override http request option.
4452
+ * @throws {RequiredError}
4453
+ */
4454
+ checkCellVersionUpdate(cell: string, channel: ReleaseChannel, options?: RawAxiosRequestConfig): AxiosPromise<string>;
4340
4455
  /**
4341
4456
  * Delete an entire cell.
4342
4457
  * @summary Delete Cell
@@ -4397,11 +4512,29 @@ declare const CellApiFactory: (configuration?: Configuration, basePath?: string,
4397
4512
  * @throws {RequiredError}
4398
4513
  */
4399
4514
  updateCell(cell: string, cell2: Cell, completionTimeout?: number, options?: RawAxiosRequestConfig): AxiosPromise<void>;
4515
+ /**
4516
+ * Update the Foundation chart version for a single cell based on a release channel. The resulting version is capped at the current system version.
4517
+ * @summary Update Cell Version
4518
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
4519
+ * @param {UpdateCellVersionRequest} updateCellVersionRequest
4520
+ * @param {*} [options] Override http request option.
4521
+ * @throws {RequiredError}
4522
+ */
4523
+ updateCellVersion(cell: string, updateCellVersionRequest: UpdateCellVersionRequest, options?: RawAxiosRequestConfig): AxiosPromise<void>;
4400
4524
  };
4401
4525
  /**
4402
4526
  * CellApi - object-oriented interface
4403
4527
  */
4404
4528
  declare class CellApi extends BaseAPI {
4529
+ /**
4530
+ * Check if a more recent Wandelbots NOVA version is available for the cell. Updates greater than the system version are ignored.
4531
+ * @summary Check Cell Update
4532
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
4533
+ * @param {ReleaseChannel} channel
4534
+ * @param {*} [options] Override http request option.
4535
+ * @throws {RequiredError}
4536
+ */
4537
+ checkCellVersionUpdate(cell: string, channel: ReleaseChannel, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<string, any>>;
4405
4538
  /**
4406
4539
  * Delete an entire cell.
4407
4540
  * @summary Delete Cell
@@ -4462,6 +4595,15 @@ declare class CellApi extends BaseAPI {
4462
4595
  * @throws {RequiredError}
4463
4596
  */
4464
4597
  updateCell(cell: string, cell2: Cell, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
4598
+ /**
4599
+ * Update the Foundation chart version for a single cell based on a release channel. The resulting version is capped at the current system version.
4600
+ * @summary Update Cell Version
4601
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
4602
+ * @param {UpdateCellVersionRequest} updateCellVersionRequest
4603
+ * @param {*} [options] Override http request option.
4604
+ * @throws {RequiredError}
4605
+ */
4606
+ updateCellVersion(cell: string, updateCellVersionRequest: UpdateCellVersionRequest, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
4465
4607
  }
4466
4608
  /**
4467
4609
  * ControllerApi - axios parameter creator
@@ -4478,7 +4620,7 @@ declare const ControllerApiAxiosParamCreator: (configuration?: Configuration) =>
4478
4620
  */
4479
4621
  addRobotController: (cell: string, robotController: RobotController, completionTimeout?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
4480
4622
  /**
4481
- * Delete all robot controllers from the cell. To replace all robot controllers in a cell, use this endpoint in combination with [addRobotController](addRobotController).
4623
+ * 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
4624
  * @summary Clear Robot Controllers
4483
4625
  * @param {string} cell Unique identifier addressing a cell in all API calls.
4484
4626
  * @param {number} [completionTimeout]
@@ -4497,7 +4639,7 @@ declare const ControllerApiAxiosParamCreator: (configuration?: Configuration) =>
4497
4639
  */
4498
4640
  deleteRobotController: (cell: string, controller: string, completionTimeout?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
4499
4641
  /**
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.
4642
+ * 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
4643
  * @summary Description
4502
4644
  * @param {string} cell Unique identifier addressing a cell in all API calls.
4503
4645
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -4535,7 +4677,7 @@ declare const ControllerApiAxiosParamCreator: (configuration?: Configuration) =>
4535
4677
  */
4536
4678
  getRobotController: (cell: string, controller: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
4537
4679
  /**
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.
4680
+ * 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
4681
  * @summary Virtual Controller Configuration
4540
4682
  * @param {string} cell Unique identifier addressing a cell in all API calls.
4541
4683
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -4562,7 +4704,7 @@ declare const ControllerApiAxiosParamCreator: (configuration?: Configuration) =>
4562
4704
  */
4563
4705
  listRobotControllers: (cell: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
4564
4706
  /**
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.
4707
+ * 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
4708
  * @summary Set Default Mode
4567
4709
  * @param {string} cell Unique identifier addressing a cell in all API calls.
4568
4710
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -4572,7 +4714,7 @@ declare const ControllerApiAxiosParamCreator: (configuration?: Configuration) =>
4572
4714
  */
4573
4715
  setDefaultMode: (cell: string, controller: string, mode: SettableRobotSystemMode, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
4574
4716
  /**
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.
4717
+ * <!-- 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
4718
  * @summary Stream Free Drive
4577
4719
  * @param {string} cell Unique identifier addressing a cell in all API calls.
4578
4720
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -4582,7 +4724,7 @@ declare const ControllerApiAxiosParamCreator: (configuration?: Configuration) =>
4582
4724
  */
4583
4725
  streamFreeDrive: (cell: string, controller: string, responseRate?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
4584
4726
  /**
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.
4727
+ * <!-- 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
4728
  * @summary Stream State
4587
4729
  * @param {string} cell Unique identifier addressing a cell in all API calls.
4588
4730
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -4593,7 +4735,7 @@ declare const ControllerApiAxiosParamCreator: (configuration?: Configuration) =>
4593
4735
  */
4594
4736
  streamRobotControllerState: (cell: string, controller: string, responseRate?: number, addControllerTimeout?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
4595
4737
  /**
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).
4738
+ * 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
4739
  * @summary Update Robot Controller
4598
4740
  * @param {string} cell Unique identifier addressing a cell in all API calls.
4599
4741
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -4619,7 +4761,7 @@ declare const ControllerApiFp: (configuration?: Configuration) => {
4619
4761
  */
4620
4762
  addRobotController(cell: string, robotController: RobotController, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
4621
4763
  /**
4622
- * Delete all robot controllers from the cell. To replace all robot controllers in a cell, use this endpoint in combination with [addRobotController](addRobotController).
4764
+ * 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
4765
  * @summary Clear Robot Controllers
4624
4766
  * @param {string} cell Unique identifier addressing a cell in all API calls.
4625
4767
  * @param {number} [completionTimeout]
@@ -4638,7 +4780,7 @@ declare const ControllerApiFp: (configuration?: Configuration) => {
4638
4780
  */
4639
4781
  deleteRobotController(cell: string, controller: string, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
4640
4782
  /**
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.
4783
+ * 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
4784
  * @summary Description
4643
4785
  * @param {string} cell Unique identifier addressing a cell in all API calls.
4644
4786
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -4676,7 +4818,7 @@ declare const ControllerApiFp: (configuration?: Configuration) => {
4676
4818
  */
4677
4819
  getRobotController(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<RobotController>>;
4678
4820
  /**
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.
4821
+ * 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
4822
  * @summary Virtual Controller Configuration
4681
4823
  * @param {string} cell Unique identifier addressing a cell in all API calls.
4682
4824
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -4703,7 +4845,7 @@ declare const ControllerApiFp: (configuration?: Configuration) => {
4703
4845
  */
4704
4846
  listRobotControllers(cell: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<string>>>;
4705
4847
  /**
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.
4848
+ * 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
4849
  * @summary Set Default Mode
4708
4850
  * @param {string} cell Unique identifier addressing a cell in all API calls.
4709
4851
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -4713,7 +4855,7 @@ declare const ControllerApiFp: (configuration?: Configuration) => {
4713
4855
  */
4714
4856
  setDefaultMode(cell: string, controller: string, mode: SettableRobotSystemMode, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
4715
4857
  /**
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.
4858
+ * <!-- 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
4859
  * @summary Stream Free Drive
4718
4860
  * @param {string} cell Unique identifier addressing a cell in all API calls.
4719
4861
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -4723,7 +4865,7 @@ declare const ControllerApiFp: (configuration?: Configuration) => {
4723
4865
  */
4724
4866
  streamFreeDrive(cell: string, controller: string, responseRate?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<RobotControllerState>>;
4725
4867
  /**
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.
4868
+ * <!-- 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
4869
  * @summary Stream State
4728
4870
  * @param {string} cell Unique identifier addressing a cell in all API calls.
4729
4871
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -4734,7 +4876,7 @@ declare const ControllerApiFp: (configuration?: Configuration) => {
4734
4876
  */
4735
4877
  streamRobotControllerState(cell: string, controller: string, responseRate?: number, addControllerTimeout?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<RobotControllerState>>;
4736
4878
  /**
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).
4879
+ * 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
4880
  * @summary Update Robot Controller
4739
4881
  * @param {string} cell Unique identifier addressing a cell in all API calls.
4740
4882
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -4760,7 +4902,7 @@ declare const ControllerApiFactory: (configuration?: Configuration, basePath?: s
4760
4902
  */
4761
4903
  addRobotController(cell: string, robotController: RobotController, completionTimeout?: number, options?: RawAxiosRequestConfig): AxiosPromise<void>;
4762
4904
  /**
4763
- * Delete all robot controllers from the cell. To replace all robot controllers in a cell, use this endpoint in combination with [addRobotController](addRobotController).
4905
+ * 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
4906
  * @summary Clear Robot Controllers
4765
4907
  * @param {string} cell Unique identifier addressing a cell in all API calls.
4766
4908
  * @param {number} [completionTimeout]
@@ -4779,7 +4921,7 @@ declare const ControllerApiFactory: (configuration?: Configuration, basePath?: s
4779
4921
  */
4780
4922
  deleteRobotController(cell: string, controller: string, completionTimeout?: number, options?: RawAxiosRequestConfig): AxiosPromise<void>;
4781
4923
  /**
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.
4924
+ * 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
4925
  * @summary Description
4784
4926
  * @param {string} cell Unique identifier addressing a cell in all API calls.
4785
4927
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -4817,7 +4959,7 @@ declare const ControllerApiFactory: (configuration?: Configuration, basePath?: s
4817
4959
  */
4818
4960
  getRobotController(cell: string, controller: string, options?: RawAxiosRequestConfig): AxiosPromise<RobotController>;
4819
4961
  /**
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.
4962
+ * 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
4963
  * @summary Virtual Controller Configuration
4822
4964
  * @param {string} cell Unique identifier addressing a cell in all API calls.
4823
4965
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -4844,7 +4986,7 @@ declare const ControllerApiFactory: (configuration?: Configuration, basePath?: s
4844
4986
  */
4845
4987
  listRobotControllers(cell: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<string>>;
4846
4988
  /**
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.
4989
+ * 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
4990
  * @summary Set Default Mode
4849
4991
  * @param {string} cell Unique identifier addressing a cell in all API calls.
4850
4992
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -4854,7 +4996,7 @@ declare const ControllerApiFactory: (configuration?: Configuration, basePath?: s
4854
4996
  */
4855
4997
  setDefaultMode(cell: string, controller: string, mode: SettableRobotSystemMode, options?: RawAxiosRequestConfig): AxiosPromise<void>;
4856
4998
  /**
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.
4999
+ * <!-- 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
5000
  * @summary Stream Free Drive
4859
5001
  * @param {string} cell Unique identifier addressing a cell in all API calls.
4860
5002
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -4864,7 +5006,7 @@ declare const ControllerApiFactory: (configuration?: Configuration, basePath?: s
4864
5006
  */
4865
5007
  streamFreeDrive(cell: string, controller: string, responseRate?: number, options?: RawAxiosRequestConfig): AxiosPromise<RobotControllerState>;
4866
5008
  /**
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.
5009
+ * <!-- 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
5010
  * @summary Stream State
4869
5011
  * @param {string} cell Unique identifier addressing a cell in all API calls.
4870
5012
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -4875,7 +5017,7 @@ declare const ControllerApiFactory: (configuration?: Configuration, basePath?: s
4875
5017
  */
4876
5018
  streamRobotControllerState(cell: string, controller: string, responseRate?: number, addControllerTimeout?: number, options?: RawAxiosRequestConfig): AxiosPromise<RobotControllerState>;
4877
5019
  /**
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).
5020
+ * 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
5021
  * @summary Update Robot Controller
4880
5022
  * @param {string} cell Unique identifier addressing a cell in all API calls.
4881
5023
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -4901,7 +5043,7 @@ declare class ControllerApi extends BaseAPI {
4901
5043
  */
4902
5044
  addRobotController(cell: string, robotController: RobotController, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
4903
5045
  /**
4904
- * Delete all robot controllers from the cell. To replace all robot controllers in a cell, use this endpoint in combination with [addRobotController](addRobotController).
5046
+ * 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
5047
  * @summary Clear Robot Controllers
4906
5048
  * @param {string} cell Unique identifier addressing a cell in all API calls.
4907
5049
  * @param {number} [completionTimeout]
@@ -4920,7 +5062,7 @@ declare class ControllerApi extends BaseAPI {
4920
5062
  */
4921
5063
  deleteRobotController(cell: string, controller: string, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
4922
5064
  /**
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.
5065
+ * 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
5066
  * @summary Description
4925
5067
  * @param {string} cell Unique identifier addressing a cell in all API calls.
4926
5068
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -4958,7 +5100,7 @@ declare class ControllerApi extends BaseAPI {
4958
5100
  */
4959
5101
  getRobotController(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<RobotController, any>>;
4960
5102
  /**
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.
5103
+ * 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
5104
  * @summary Virtual Controller Configuration
4963
5105
  * @param {string} cell Unique identifier addressing a cell in all API calls.
4964
5106
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -4985,7 +5127,7 @@ declare class ControllerApi extends BaseAPI {
4985
5127
  */
4986
5128
  listRobotControllers(cell: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<string[], any>>;
4987
5129
  /**
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.
5130
+ * 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
5131
  * @summary Set Default Mode
4990
5132
  * @param {string} cell Unique identifier addressing a cell in all API calls.
4991
5133
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -4995,7 +5137,7 @@ declare class ControllerApi extends BaseAPI {
4995
5137
  */
4996
5138
  setDefaultMode(cell: string, controller: string, mode: SettableRobotSystemMode, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
4997
5139
  /**
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.
5140
+ * <!-- 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
5141
  * @summary Stream Free Drive
5000
5142
  * @param {string} cell Unique identifier addressing a cell in all API calls.
5001
5143
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -5005,7 +5147,7 @@ declare class ControllerApi extends BaseAPI {
5005
5147
  */
5006
5148
  streamFreeDrive(cell: string, controller: string, responseRate?: number, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<RobotControllerState, any>>;
5007
5149
  /**
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.
5150
+ * <!-- 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
5151
  * @summary Stream State
5010
5152
  * @param {string} cell Unique identifier addressing a cell in all API calls.
5011
5153
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -5016,7 +5158,7 @@ declare class ControllerApi extends BaseAPI {
5016
5158
  */
5017
5159
  streamRobotControllerState(cell: string, controller: string, responseRate?: number, addControllerTimeout?: number, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<RobotControllerState, any>>;
5018
5160
  /**
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).
5161
+ * 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
5162
  * @summary Update Robot Controller
5021
5163
  * @param {string} cell Unique identifier addressing a cell in all API calls.
5022
5164
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -5045,7 +5187,7 @@ declare const ControllerInputsOutputsApiAxiosParamCreator: (configuration?: Conf
5045
5187
  */
5046
5188
  listIODescriptions: (cell: string, controller: string, ios?: Array<string>, direction?: IODirection, valueType?: IOValueType, group?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
5047
5189
  /**
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).
5190
+ * 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
5191
  * @summary Get Input/Output Values
5050
5192
  * @param {string} cell Unique identifier addressing a cell in all API calls.
5051
5193
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -5055,7 +5197,7 @@ declare const ControllerInputsOutputsApiAxiosParamCreator: (configuration?: Conf
5055
5197
  */
5056
5198
  listIOValues: (cell: string, controller: string, ios?: Array<string>, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
5057
5199
  /**
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.
5200
+ * 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
5201
  * @summary Set Output Values
5060
5202
  * @param {string} cell Unique identifier addressing a cell in all API calls.
5061
5203
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -5075,7 +5217,7 @@ declare const ControllerInputsOutputsApiAxiosParamCreator: (configuration?: Conf
5075
5217
  */
5076
5218
  streamIOValues: (cell: string, controller: string, ios?: Array<string>, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
5077
5219
  /**
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 ```
5220
+ * 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
5221
  * @summary Wait For
5080
5222
  * @param {string} cell Unique identifier addressing a cell in all API calls.
5081
5223
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -5103,7 +5245,7 @@ declare const ControllerInputsOutputsApiFp: (configuration?: Configuration) => {
5103
5245
  */
5104
5246
  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
5247
  /**
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).
5248
+ * 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
5249
  * @summary Get Input/Output Values
5108
5250
  * @param {string} cell Unique identifier addressing a cell in all API calls.
5109
5251
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -5113,7 +5255,7 @@ declare const ControllerInputsOutputsApiFp: (configuration?: Configuration) => {
5113
5255
  */
5114
5256
  listIOValues(cell: string, controller: string, ios?: Array<string>, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<IOValue>>>;
5115
5257
  /**
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.
5258
+ * 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
5259
  * @summary Set Output Values
5118
5260
  * @param {string} cell Unique identifier addressing a cell in all API calls.
5119
5261
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -5133,7 +5275,7 @@ declare const ControllerInputsOutputsApiFp: (configuration?: Configuration) => {
5133
5275
  */
5134
5276
  streamIOValues(cell: string, controller: string, ios?: Array<string>, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<StreamIOValuesResponse>>;
5135
5277
  /**
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 ```
5278
+ * 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
5279
  * @summary Wait For
5138
5280
  * @param {string} cell Unique identifier addressing a cell in all API calls.
5139
5281
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -5161,7 +5303,7 @@ declare const ControllerInputsOutputsApiFactory: (configuration?: Configuration,
5161
5303
  */
5162
5304
  listIODescriptions(cell: string, controller: string, ios?: Array<string>, direction?: IODirection, valueType?: IOValueType, group?: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<IODescription>>;
5163
5305
  /**
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).
5306
+ * 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
5307
  * @summary Get Input/Output Values
5166
5308
  * @param {string} cell Unique identifier addressing a cell in all API calls.
5167
5309
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -5171,7 +5313,7 @@ declare const ControllerInputsOutputsApiFactory: (configuration?: Configuration,
5171
5313
  */
5172
5314
  listIOValues(cell: string, controller: string, ios?: Array<string>, options?: RawAxiosRequestConfig): AxiosPromise<Array<IOValue>>;
5173
5315
  /**
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.
5316
+ * 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
5317
  * @summary Set Output Values
5176
5318
  * @param {string} cell Unique identifier addressing a cell in all API calls.
5177
5319
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -5191,7 +5333,7 @@ declare const ControllerInputsOutputsApiFactory: (configuration?: Configuration,
5191
5333
  */
5192
5334
  streamIOValues(cell: string, controller: string, ios?: Array<string>, options?: RawAxiosRequestConfig): AxiosPromise<StreamIOValuesResponse>;
5193
5335
  /**
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 ```
5336
+ * 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
5337
  * @summary Wait For
5196
5338
  * @param {string} cell Unique identifier addressing a cell in all API calls.
5197
5339
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -5219,7 +5361,7 @@ declare class ControllerInputsOutputsApi extends BaseAPI {
5219
5361
  */
5220
5362
  listIODescriptions(cell: string, controller: string, ios?: Array<string>, direction?: IODirection, valueType?: IOValueType, group?: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<IODescription[], any>>;
5221
5363
  /**
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).
5364
+ * 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
5365
  * @summary Get Input/Output Values
5224
5366
  * @param {string} cell Unique identifier addressing a cell in all API calls.
5225
5367
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -5229,7 +5371,7 @@ declare class ControllerInputsOutputsApi extends BaseAPI {
5229
5371
  */
5230
5372
  listIOValues(cell: string, controller: string, ios?: Array<string>, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<IOValue[], any>>;
5231
5373
  /**
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.
5374
+ * 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
5375
  * @summary Set Output Values
5234
5376
  * @param {string} cell Unique identifier addressing a cell in all API calls.
5235
5377
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -5249,7 +5391,7 @@ declare class ControllerInputsOutputsApi extends BaseAPI {
5249
5391
  */
5250
5392
  streamIOValues(cell: string, controller: string, ios?: Array<string>, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<StreamIOValuesResponse, any>>;
5251
5393
  /**
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 ```
5394
+ * 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
5395
  * @summary Wait For
5254
5396
  * @param {string} cell Unique identifier addressing a cell in all API calls.
5255
5397
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -5264,7 +5406,7 @@ declare class ControllerInputsOutputsApi extends BaseAPI {
5264
5406
  */
5265
5407
  declare const JoggingApiAxiosParamCreator: (configuration?: Configuration) => {
5266
5408
  /**
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.
5409
+ * <!-- 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
5410
  * @summary Execute Jogging
5269
5411
  * @param {string} cell Unique identifier addressing a cell in all API calls.
5270
5412
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -5279,7 +5421,7 @@ declare const JoggingApiAxiosParamCreator: (configuration?: Configuration) => {
5279
5421
  */
5280
5422
  declare const JoggingApiFp: (configuration?: Configuration) => {
5281
5423
  /**
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.
5424
+ * <!-- 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
5425
  * @summary Execute Jogging
5284
5426
  * @param {string} cell Unique identifier addressing a cell in all API calls.
5285
5427
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -5294,7 +5436,7 @@ declare const JoggingApiFp: (configuration?: Configuration) => {
5294
5436
  */
5295
5437
  declare const JoggingApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
5296
5438
  /**
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.
5439
+ * <!-- 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
5440
  * @summary Execute Jogging
5299
5441
  * @param {string} cell Unique identifier addressing a cell in all API calls.
5300
5442
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -5309,7 +5451,7 @@ declare const JoggingApiFactory: (configuration?: Configuration, basePath?: stri
5309
5451
  */
5310
5452
  declare class JoggingApi extends BaseAPI {
5311
5453
  /**
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.
5454
+ * <!-- 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
5455
  * @summary Execute Jogging
5314
5456
  * @param {string} cell Unique identifier addressing a cell in all API calls.
5315
5457
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -5704,25 +5846,25 @@ declare class MotionGroupApi extends BaseAPI {
5704
5846
  */
5705
5847
  declare const MotionGroupModelsApiAxiosParamCreator: (configuration?: Configuration) => {
5706
5848
  /**
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.
5849
+ * 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
5850
  * @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).
5851
+ * @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
5852
  * @param {*} [options] Override http request option.
5711
5853
  * @throws {RequiredError}
5712
5854
  */
5713
5855
  getMotionGroupCollisionModel: (motionGroupModel: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
5714
5856
  /**
5715
- * Returns the GLB asset for the specified motion group model. See [getMotionGroupModels](getMotionGroupModels) for supported identifiers.
5857
+ * Returns the GLB asset for the specified motion group model. See [getMotionGroupModels](#/operations/getMotionGroupModels) for supported identifiers.
5716
5858
  * @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).
5859
+ * @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
5860
  * @param {*} [options] Override http request option.
5719
5861
  * @throws {RequiredError}
5720
5862
  */
5721
5863
  getMotionGroupGlbModel: (motionGroupModel: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
5722
5864
  /**
5723
- * Returns the kinematics model (DH parameters) for the given motion group model. See [getMotionGroupModels](getMotionGroupModels) for supported motion group models.
5865
+ * Returns the kinematics model (DH parameters) for the given motion group model. See [getMotionGroupModels](#/operations/getMotionGroupModels) for supported motion group models.
5724
5866
  * @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).
5867
+ * @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
5868
  * @param {*} [options] Override http request option.
5727
5869
  * @throws {RequiredError}
5728
5870
  */
@@ -5735,9 +5877,9 @@ declare const MotionGroupModelsApiAxiosParamCreator: (configuration?: Configurat
5735
5877
  */
5736
5878
  getMotionGroupModels: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
5737
5879
  /**
5738
- * Returns the USD scene model for the specified motion group model. See [getMotionGroupModels](getMotionGroupModels) for supported identifiers.
5880
+ * Returns the USD scene model for the specified motion group model. See [getMotionGroupModels](#/operations/getMotionGroupModels) for supported identifiers.
5739
5881
  * @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).
5882
+ * @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
5883
  * @param {*} [options] Override http request option.
5742
5884
  * @throws {RequiredError}
5743
5885
  */
@@ -5748,9 +5890,9 @@ declare const MotionGroupModelsApiAxiosParamCreator: (configuration?: Configurat
5748
5890
  */
5749
5891
  declare const MotionGroupModelsApiFp: (configuration?: Configuration) => {
5750
5892
  /**
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.
5893
+ * 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
5894
  * @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).
5895
+ * @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
5896
  * @param {*} [options] Override http request option.
5755
5897
  * @throws {RequiredError}
5756
5898
  */
@@ -5758,17 +5900,17 @@ declare const MotionGroupModelsApiFp: (configuration?: Configuration) => {
5758
5900
  [key: string]: Collider;
5759
5901
  }>>>;
5760
5902
  /**
5761
- * Returns the GLB asset for the specified motion group model. See [getMotionGroupModels](getMotionGroupModels) for supported identifiers.
5903
+ * Returns the GLB asset for the specified motion group model. See [getMotionGroupModels](#/operations/getMotionGroupModels) for supported identifiers.
5762
5904
  * @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).
5905
+ * @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
5906
  * @param {*} [options] Override http request option.
5765
5907
  * @throws {RequiredError}
5766
5908
  */
5767
5909
  getMotionGroupGlbModel(motionGroupModel: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<File>>;
5768
5910
  /**
5769
- * Returns the kinematics model (DH parameters) for the given motion group model. See [getMotionGroupModels](getMotionGroupModels) for supported motion group models.
5911
+ * Returns the kinematics model (DH parameters) for the given motion group model. See [getMotionGroupModels](#/operations/getMotionGroupModels) for supported motion group models.
5770
5912
  * @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).
5913
+ * @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
5914
  * @param {*} [options] Override http request option.
5773
5915
  * @throws {RequiredError}
5774
5916
  */
@@ -5781,9 +5923,9 @@ declare const MotionGroupModelsApiFp: (configuration?: Configuration) => {
5781
5923
  */
5782
5924
  getMotionGroupModels(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<string>>>;
5783
5925
  /**
5784
- * Returns the USD scene model for the specified motion group model. See [getMotionGroupModels](getMotionGroupModels) for supported identifiers.
5926
+ * Returns the USD scene model for the specified motion group model. See [getMotionGroupModels](#/operations/getMotionGroupModels) for supported identifiers.
5785
5927
  * @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).
5928
+ * @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
5929
  * @param {*} [options] Override http request option.
5788
5930
  * @throws {RequiredError}
5789
5931
  */
@@ -5794,9 +5936,9 @@ declare const MotionGroupModelsApiFp: (configuration?: Configuration) => {
5794
5936
  */
5795
5937
  declare const MotionGroupModelsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
5796
5938
  /**
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.
5939
+ * 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
5940
  * @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).
5941
+ * @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
5942
  * @param {*} [options] Override http request option.
5801
5943
  * @throws {RequiredError}
5802
5944
  */
@@ -5804,17 +5946,17 @@ declare const MotionGroupModelsApiFactory: (configuration?: Configuration, baseP
5804
5946
  [key: string]: Collider;
5805
5947
  }>>;
5806
5948
  /**
5807
- * Returns the GLB asset for the specified motion group model. See [getMotionGroupModels](getMotionGroupModels) for supported identifiers.
5949
+ * Returns the GLB asset for the specified motion group model. See [getMotionGroupModels](#/operations/getMotionGroupModels) for supported identifiers.
5808
5950
  * @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).
5951
+ * @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
5952
  * @param {*} [options] Override http request option.
5811
5953
  * @throws {RequiredError}
5812
5954
  */
5813
5955
  getMotionGroupGlbModel(motionGroupModel: string, options?: RawAxiosRequestConfig): AxiosPromise<File>;
5814
5956
  /**
5815
- * Returns the kinematics model (DH parameters) for the given motion group model. See [getMotionGroupModels](getMotionGroupModels) for supported motion group models.
5957
+ * Returns the kinematics model (DH parameters) for the given motion group model. See [getMotionGroupModels](#/operations/getMotionGroupModels) for supported motion group models.
5816
5958
  * @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).
5959
+ * @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
5960
  * @param {*} [options] Override http request option.
5819
5961
  * @throws {RequiredError}
5820
5962
  */
@@ -5827,9 +5969,9 @@ declare const MotionGroupModelsApiFactory: (configuration?: Configuration, baseP
5827
5969
  */
5828
5970
  getMotionGroupModels(options?: RawAxiosRequestConfig): AxiosPromise<Array<string>>;
5829
5971
  /**
5830
- * Returns the USD scene model for the specified motion group model. See [getMotionGroupModels](getMotionGroupModels) for supported identifiers.
5972
+ * Returns the USD scene model for the specified motion group model. See [getMotionGroupModels](#/operations/getMotionGroupModels) for supported identifiers.
5831
5973
  * @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).
5974
+ * @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
5975
  * @param {*} [options] Override http request option.
5834
5976
  * @throws {RequiredError}
5835
5977
  */
@@ -5840,9 +5982,9 @@ declare const MotionGroupModelsApiFactory: (configuration?: Configuration, baseP
5840
5982
  */
5841
5983
  declare class MotionGroupModelsApi extends BaseAPI {
5842
5984
  /**
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.
5985
+ * 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
5986
  * @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).
5987
+ * @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
5988
  * @param {*} [options] Override http request option.
5847
5989
  * @throws {RequiredError}
5848
5990
  */
@@ -5850,17 +5992,17 @@ declare class MotionGroupModelsApi extends BaseAPI {
5850
5992
  [key: string]: Collider;
5851
5993
  }[], any>>;
5852
5994
  /**
5853
- * Returns the GLB asset for the specified motion group model. See [getMotionGroupModels](getMotionGroupModels) for supported identifiers.
5995
+ * Returns the GLB asset for the specified motion group model. See [getMotionGroupModels](#/operations/getMotionGroupModels) for supported identifiers.
5854
5996
  * @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).
5997
+ * @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
5998
  * @param {*} [options] Override http request option.
5857
5999
  * @throws {RequiredError}
5858
6000
  */
5859
6001
  getMotionGroupGlbModel(motionGroupModel: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<File, any>>;
5860
6002
  /**
5861
- * Returns the kinematics model (DH parameters) for the given motion group model. See [getMotionGroupModels](getMotionGroupModels) for supported motion group models.
6003
+ * Returns the kinematics model (DH parameters) for the given motion group model. See [getMotionGroupModels](#/operations/getMotionGroupModels) for supported motion group models.
5862
6004
  * @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).
6005
+ * @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
6006
  * @param {*} [options] Override http request option.
5865
6007
  * @throws {RequiredError}
5866
6008
  */
@@ -5873,9 +6015,9 @@ declare class MotionGroupModelsApi extends BaseAPI {
5873
6015
  */
5874
6016
  getMotionGroupModels(options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<string[], any>>;
5875
6017
  /**
5876
- * Returns the USD scene model for the specified motion group model. See [getMotionGroupModels](getMotionGroupModels) for supported identifiers.
6018
+ * Returns the USD scene model for the specified motion group model. See [getMotionGroupModels](#/operations/getMotionGroupModels) for supported identifiers.
5877
6019
  * @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).
6020
+ * @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
6021
  * @param {*} [options] Override http request option.
5880
6022
  * @throws {RequiredError}
5881
6023
  */
@@ -6961,7 +7103,7 @@ declare const StoreObjectApiAxiosParamCreator: (configuration?: Configuration) =
6961
7103
  */
6962
7104
  listAllObjectKeys: (cell: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
6963
7105
  /**
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.
7106
+ * 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
7107
  * @summary Store Object
6966
7108
  * @param {string} cell Unique identifier addressing a cell in all API calls.
6967
7109
  * @param {string} key
@@ -7022,7 +7164,7 @@ declare const StoreObjectApiFp: (configuration?: Configuration) => {
7022
7164
  */
7023
7165
  listAllObjectKeys(cell: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<string>>>;
7024
7166
  /**
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.
7167
+ * 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
7168
  * @summary Store Object
7027
7169
  * @param {string} cell Unique identifier addressing a cell in all API calls.
7028
7170
  * @param {string} key
@@ -7083,7 +7225,7 @@ declare const StoreObjectApiFactory: (configuration?: Configuration, basePath?:
7083
7225
  */
7084
7226
  listAllObjectKeys(cell: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<string>>;
7085
7227
  /**
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.
7228
+ * 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
7229
  * @summary Store Object
7088
7230
  * @param {string} cell Unique identifier addressing a cell in all API calls.
7089
7231
  * @param {string} key
@@ -7144,7 +7286,7 @@ declare class StoreObjectApi extends BaseAPI {
7144
7286
  */
7145
7287
  listAllObjectKeys(cell: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<string[], any>>;
7146
7288
  /**
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.
7289
+ * 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
7290
  * @summary Store Object
7149
7291
  * @param {string} cell Unique identifier addressing a cell in all API calls.
7150
7292
  * @param {string} key
@@ -7250,7 +7392,7 @@ declare const SystemApiAxiosParamCreator: (configuration?: Configuration) => {
7250
7392
  */
7251
7393
  restoreConfiguration: (body: File, resources?: Array<string>, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
7252
7394
  /**
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.
7395
+ * 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
7396
  * @summary Update Wandelbots NOVA version
7255
7397
  * @param {UpdateNovaVersionRequest} updateNovaVersionRequest
7256
7398
  * @param {*} [options] Override http request option.
@@ -7351,7 +7493,7 @@ declare const SystemApiFp: (configuration?: Configuration) => {
7351
7493
  */
7352
7494
  restoreConfiguration(body: File, resources?: Array<string>, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
7353
7495
  /**
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.
7496
+ * 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
7497
  * @summary Update Wandelbots NOVA version
7356
7498
  * @param {UpdateNovaVersionRequest} updateNovaVersionRequest
7357
7499
  * @param {*} [options] Override http request option.
@@ -7452,7 +7594,7 @@ declare const SystemApiFactory: (configuration?: Configuration, basePath?: strin
7452
7594
  */
7453
7595
  restoreConfiguration(body: File, resources?: Array<string>, options?: RawAxiosRequestConfig): AxiosPromise<void>;
7454
7596
  /**
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.
7597
+ * 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
7598
  * @summary Update Wandelbots NOVA version
7457
7599
  * @param {UpdateNovaVersionRequest} updateNovaVersionRequest
7458
7600
  * @param {*} [options] Override http request option.
@@ -7553,7 +7695,7 @@ declare class SystemApi extends BaseAPI {
7553
7695
  */
7554
7696
  restoreConfiguration(body: File, resources?: Array<string>, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
7555
7697
  /**
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.
7698
+ * 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
7699
  * @summary Update Wandelbots NOVA version
7558
7700
  * @param {UpdateNovaVersionRequest} updateNovaVersionRequest
7559
7701
  * @param {*} [options] Override http request option.
@@ -7566,7 +7708,7 @@ declare class SystemApi extends BaseAPI {
7566
7708
  */
7567
7709
  declare const TrajectoryCachingApiAxiosParamCreator: (configuration?: Configuration) => {
7568
7710
  /**
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.
7711
+ * 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
7712
  * @summary Add Trajectory
7571
7713
  * @param {string} cell Unique identifier addressing a cell in all API calls.
7572
7714
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -7585,7 +7727,7 @@ declare const TrajectoryCachingApiAxiosParamCreator: (configuration?: Configurat
7585
7727
  */
7586
7728
  clearTrajectories: (cell: string, controller: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
7587
7729
  /**
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.
7730
+ * 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
7731
  * @summary Delete Trajectory
7590
7732
  * @param {string} cell Unique identifier addressing a cell in all API calls.
7591
7733
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -7595,7 +7737,7 @@ declare const TrajectoryCachingApiAxiosParamCreator: (configuration?: Configurat
7595
7737
  */
7596
7738
  deleteTrajectory: (cell: string, controller: string, trajectory: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
7597
7739
  /**
7598
- * Get a previously created trajectory from cache. Use [listTrajectories](listTrajectories) to list all cached trajectories.
7740
+ * Get a previously created trajectory from cache. Use [listTrajectories](#/operations/listTrajectories) to list all cached trajectories.
7599
7741
  * @summary Get Trajectory
7600
7742
  * @param {string} cell Unique identifier addressing a cell in all API calls.
7601
7743
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -7605,7 +7747,7 @@ declare const TrajectoryCachingApiAxiosParamCreator: (configuration?: Configurat
7605
7747
  */
7606
7748
  getTrajectory: (cell: string, controller: string, trajectory: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
7607
7749
  /**
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.
7750
+ * 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
7751
  * @summary List Trajectories
7610
7752
  * @param {string} cell Unique identifier addressing a cell in all API calls.
7611
7753
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -7619,7 +7761,7 @@ declare const TrajectoryCachingApiAxiosParamCreator: (configuration?: Configurat
7619
7761
  */
7620
7762
  declare const TrajectoryCachingApiFp: (configuration?: Configuration) => {
7621
7763
  /**
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.
7764
+ * 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
7765
  * @summary Add Trajectory
7624
7766
  * @param {string} cell Unique identifier addressing a cell in all API calls.
7625
7767
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -7638,7 +7780,7 @@ declare const TrajectoryCachingApiFp: (configuration?: Configuration) => {
7638
7780
  */
7639
7781
  clearTrajectories(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
7640
7782
  /**
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.
7783
+ * 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
7784
  * @summary Delete Trajectory
7643
7785
  * @param {string} cell Unique identifier addressing a cell in all API calls.
7644
7786
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -7648,7 +7790,7 @@ declare const TrajectoryCachingApiFp: (configuration?: Configuration) => {
7648
7790
  */
7649
7791
  deleteTrajectory(cell: string, controller: string, trajectory: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
7650
7792
  /**
7651
- * Get a previously created trajectory from cache. Use [listTrajectories](listTrajectories) to list all cached trajectories.
7793
+ * Get a previously created trajectory from cache. Use [listTrajectories](#/operations/listTrajectories) to list all cached trajectories.
7652
7794
  * @summary Get Trajectory
7653
7795
  * @param {string} cell Unique identifier addressing a cell in all API calls.
7654
7796
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -7658,7 +7800,7 @@ declare const TrajectoryCachingApiFp: (configuration?: Configuration) => {
7658
7800
  */
7659
7801
  getTrajectory(cell: string, controller: string, trajectory: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetTrajectoryResponse>>;
7660
7802
  /**
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.
7803
+ * 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
7804
  * @summary List Trajectories
7663
7805
  * @param {string} cell Unique identifier addressing a cell in all API calls.
7664
7806
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -7672,7 +7814,7 @@ declare const TrajectoryCachingApiFp: (configuration?: Configuration) => {
7672
7814
  */
7673
7815
  declare const TrajectoryCachingApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
7674
7816
  /**
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.
7817
+ * 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
7818
  * @summary Add Trajectory
7677
7819
  * @param {string} cell Unique identifier addressing a cell in all API calls.
7678
7820
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -7691,7 +7833,7 @@ declare const TrajectoryCachingApiFactory: (configuration?: Configuration, baseP
7691
7833
  */
7692
7834
  clearTrajectories(cell: string, controller: string, options?: RawAxiosRequestConfig): AxiosPromise<void>;
7693
7835
  /**
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.
7836
+ * 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
7837
  * @summary Delete Trajectory
7696
7838
  * @param {string} cell Unique identifier addressing a cell in all API calls.
7697
7839
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -7701,7 +7843,7 @@ declare const TrajectoryCachingApiFactory: (configuration?: Configuration, baseP
7701
7843
  */
7702
7844
  deleteTrajectory(cell: string, controller: string, trajectory: string, options?: RawAxiosRequestConfig): AxiosPromise<void>;
7703
7845
  /**
7704
- * Get a previously created trajectory from cache. Use [listTrajectories](listTrajectories) to list all cached trajectories.
7846
+ * Get a previously created trajectory from cache. Use [listTrajectories](#/operations/listTrajectories) to list all cached trajectories.
7705
7847
  * @summary Get Trajectory
7706
7848
  * @param {string} cell Unique identifier addressing a cell in all API calls.
7707
7849
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -7711,7 +7853,7 @@ declare const TrajectoryCachingApiFactory: (configuration?: Configuration, baseP
7711
7853
  */
7712
7854
  getTrajectory(cell: string, controller: string, trajectory: string, options?: RawAxiosRequestConfig): AxiosPromise<GetTrajectoryResponse>;
7713
7855
  /**
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.
7856
+ * 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
7857
  * @summary List Trajectories
7716
7858
  * @param {string} cell Unique identifier addressing a cell in all API calls.
7717
7859
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -7725,7 +7867,7 @@ declare const TrajectoryCachingApiFactory: (configuration?: Configuration, baseP
7725
7867
  */
7726
7868
  declare class TrajectoryCachingApi extends BaseAPI {
7727
7869
  /**
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.
7870
+ * 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
7871
  * @summary Add Trajectory
7730
7872
  * @param {string} cell Unique identifier addressing a cell in all API calls.
7731
7873
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -7744,7 +7886,7 @@ declare class TrajectoryCachingApi extends BaseAPI {
7744
7886
  */
7745
7887
  clearTrajectories(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
7746
7888
  /**
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.
7889
+ * 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
7890
  * @summary Delete Trajectory
7749
7891
  * @param {string} cell Unique identifier addressing a cell in all API calls.
7750
7892
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -7754,7 +7896,7 @@ declare class TrajectoryCachingApi extends BaseAPI {
7754
7896
  */
7755
7897
  deleteTrajectory(cell: string, controller: string, trajectory: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
7756
7898
  /**
7757
- * Get a previously created trajectory from cache. Use [listTrajectories](listTrajectories) to list all cached trajectories.
7899
+ * Get a previously created trajectory from cache. Use [listTrajectories](#/operations/listTrajectories) to list all cached trajectories.
7758
7900
  * @summary Get Trajectory
7759
7901
  * @param {string} cell Unique identifier addressing a cell in all API calls.
7760
7902
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -7764,7 +7906,7 @@ declare class TrajectoryCachingApi extends BaseAPI {
7764
7906
  */
7765
7907
  getTrajectory(cell: string, controller: string, trajectory: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<GetTrajectoryResponse, any>>;
7766
7908
  /**
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.
7909
+ * 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
7910
  * @summary List Trajectories
7769
7911
  * @param {string} cell Unique identifier addressing a cell in all API calls.
7770
7912
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -7778,7 +7920,7 @@ declare class TrajectoryCachingApi extends BaseAPI {
7778
7920
  */
7779
7921
  declare const TrajectoryExecutionApiAxiosParamCreator: (configuration?: Configuration) => {
7780
7922
  /**
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.
7923
+ * <!-- 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
7924
  * @summary Execute Trajectory
7783
7925
  * @param {string} cell Unique identifier addressing a cell in all API calls.
7784
7926
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -7793,7 +7935,7 @@ declare const TrajectoryExecutionApiAxiosParamCreator: (configuration?: Configur
7793
7935
  */
7794
7936
  declare const TrajectoryExecutionApiFp: (configuration?: Configuration) => {
7795
7937
  /**
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.
7938
+ * <!-- 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
7939
  * @summary Execute Trajectory
7798
7940
  * @param {string} cell Unique identifier addressing a cell in all API calls.
7799
7941
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -7808,7 +7950,7 @@ declare const TrajectoryExecutionApiFp: (configuration?: Configuration) => {
7808
7950
  */
7809
7951
  declare const TrajectoryExecutionApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
7810
7952
  /**
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.
7953
+ * <!-- 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
7954
  * @summary Execute Trajectory
7813
7955
  * @param {string} cell Unique identifier addressing a cell in all API calls.
7814
7956
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -7823,7 +7965,7 @@ declare const TrajectoryExecutionApiFactory: (configuration?: Configuration, bas
7823
7965
  */
7824
7966
  declare class TrajectoryExecutionApi extends BaseAPI {
7825
7967
  /**
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.
7968
+ * <!-- 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
7969
  * @summary Execute Trajectory
7828
7970
  * @param {string} cell Unique identifier addressing a cell in all API calls.
7829
7971
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -7838,7 +7980,7 @@ declare class TrajectoryExecutionApi extends BaseAPI {
7838
7980
  */
7839
7981
  declare const TrajectoryPlanningApiAxiosParamCreator: (configuration?: Configuration) => {
7840
7982
  /**
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.
7983
+ * 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
7984
  * @summary Plan Collision-Free Trajectory
7843
7985
  * @param {string} cell Unique identifier addressing a cell in all API calls.
7844
7986
  * @param {PlanCollisionFreeRequest} planCollisionFreeRequest
@@ -7847,7 +7989,7 @@ declare const TrajectoryPlanningApiAxiosParamCreator: (configuration?: Configura
7847
7989
  */
7848
7990
  planCollisionFree: (cell: string, planCollisionFreeRequest: PlanCollisionFreeRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
7849
7991
  /**
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.
7992
+ * 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
7993
  * @summary Plan Trajectory
7852
7994
  * @param {string} cell Unique identifier addressing a cell in all API calls.
7853
7995
  * @param {PlanTrajectoryRequest} planTrajectoryRequest
@@ -7861,7 +8003,7 @@ declare const TrajectoryPlanningApiAxiosParamCreator: (configuration?: Configura
7861
8003
  */
7862
8004
  declare const TrajectoryPlanningApiFp: (configuration?: Configuration) => {
7863
8005
  /**
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.
8006
+ * 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
8007
  * @summary Plan Collision-Free Trajectory
7866
8008
  * @param {string} cell Unique identifier addressing a cell in all API calls.
7867
8009
  * @param {PlanCollisionFreeRequest} planCollisionFreeRequest
@@ -7870,7 +8012,7 @@ declare const TrajectoryPlanningApiFp: (configuration?: Configuration) => {
7870
8012
  */
7871
8013
  planCollisionFree(cell: string, planCollisionFreeRequest: PlanCollisionFreeRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PlanCollisionFreeResponse>>;
7872
8014
  /**
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.
8015
+ * 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
8016
  * @summary Plan Trajectory
7875
8017
  * @param {string} cell Unique identifier addressing a cell in all API calls.
7876
8018
  * @param {PlanTrajectoryRequest} planTrajectoryRequest
@@ -7884,7 +8026,7 @@ declare const TrajectoryPlanningApiFp: (configuration?: Configuration) => {
7884
8026
  */
7885
8027
  declare const TrajectoryPlanningApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
7886
8028
  /**
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.
8029
+ * 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
8030
  * @summary Plan Collision-Free Trajectory
7889
8031
  * @param {string} cell Unique identifier addressing a cell in all API calls.
7890
8032
  * @param {PlanCollisionFreeRequest} planCollisionFreeRequest
@@ -7893,7 +8035,7 @@ declare const TrajectoryPlanningApiFactory: (configuration?: Configuration, base
7893
8035
  */
7894
8036
  planCollisionFree(cell: string, planCollisionFreeRequest: PlanCollisionFreeRequest, options?: RawAxiosRequestConfig): AxiosPromise<PlanCollisionFreeResponse>;
7895
8037
  /**
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.
8038
+ * 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
8039
  * @summary Plan Trajectory
7898
8040
  * @param {string} cell Unique identifier addressing a cell in all API calls.
7899
8041
  * @param {PlanTrajectoryRequest} planTrajectoryRequest
@@ -7907,7 +8049,7 @@ declare const TrajectoryPlanningApiFactory: (configuration?: Configuration, base
7907
8049
  */
7908
8050
  declare class TrajectoryPlanningApi extends BaseAPI {
7909
8051
  /**
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.
8052
+ * 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
8053
  * @summary Plan Collision-Free Trajectory
7912
8054
  * @param {string} cell Unique identifier addressing a cell in all API calls.
7913
8055
  * @param {PlanCollisionFreeRequest} planCollisionFreeRequest
@@ -7916,7 +8058,7 @@ declare class TrajectoryPlanningApi extends BaseAPI {
7916
8058
  */
7917
8059
  planCollisionFree(cell: string, planCollisionFreeRequest: PlanCollisionFreeRequest, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<PlanCollisionFreeResponse, any>>;
7918
8060
  /**
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.
8061
+ * 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
8062
  * @summary Plan Trajectory
7921
8063
  * @param {string} cell Unique identifier addressing a cell in all API calls.
7922
8064
  * @param {PlanTrajectoryRequest} planTrajectoryRequest
@@ -7988,6 +8130,16 @@ declare const VirtualControllerApiAxiosParamCreator: (configuration?: Configurat
7988
8130
  * @throws {RequiredError}
7989
8131
  */
7990
8132
  addVirtualControllerCoordinateSystem: (cell: string, controller: string, coordinateSystem: string, coordinateSystemData: CoordinateSystemData, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
8133
+ /**
8134
+ * 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.
8135
+ * @summary Add Motion Group
8136
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
8137
+ * @param {string} controller Unique identifier to address a controller in the cell.
8138
+ * @param {AddVirtualControllerMotionGroupRequest} addVirtualControllerMotionGroupRequest
8139
+ * @param {*} [options] Override http request option.
8140
+ * @throws {RequiredError}
8141
+ */
8142
+ addVirtualControllerMotionGroup: (cell: string, controller: string, addVirtualControllerMotionGroupRequest: AddVirtualControllerMotionGroupRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
7991
8143
  /**
7992
8144
  * 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
8145
  * @summary Add TCP
@@ -8011,6 +8163,16 @@ declare const VirtualControllerApiAxiosParamCreator: (configuration?: Configurat
8011
8163
  * @throws {RequiredError}
8012
8164
  */
8013
8165
  deleteVirtualControllerCoordinateSystem: (cell: string, controller: string, coordinateSystem: string, deleteDependent?: boolean, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
8166
+ /**
8167
+ * 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**.
8168
+ * @summary Delete Motion Group
8169
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
8170
+ * @param {string} controller Unique identifier to address a controller in the cell.
8171
+ * @param {string} motionGroup The motion-group identifier.
8172
+ * @param {*} [options] Override http request option.
8173
+ * @throws {RequiredError}
8174
+ */
8175
+ deleteVirtualControllerMotionGroup: (cell: string, controller: string, motionGroup: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
8014
8176
  /**
8015
8177
  * 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
8178
  * @summary Remove TCP
@@ -8023,7 +8185,7 @@ declare const VirtualControllerApiAxiosParamCreator: (configuration?: Configurat
8023
8185
  */
8024
8186
  deleteVirtualControllerTcp: (cell: string, controller: string, motionGroup: string, tcp: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
8025
8187
  /**
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.
8188
+ * 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
8189
  * @summary Get Emergency Stop State
8028
8190
  * @param {string} cell Unique identifier addressing a cell in all API calls.
8029
8191
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -8051,7 +8213,7 @@ declare const VirtualControllerApiAxiosParamCreator: (configuration?: Configurat
8051
8213
  */
8052
8214
  getMotionGroups: (cell: string, controller: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
8053
8215
  /**
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.
8216
+ * 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
8217
  * @summary Get Operation Mode
8056
8218
  * @param {string} cell Unique identifier addressing a cell in all API calls.
8057
8219
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -8089,7 +8251,7 @@ declare const VirtualControllerApiAxiosParamCreator: (configuration?: Configurat
8089
8251
  */
8090
8252
  listVirtualControllerTcps: (cell: string, controller: string, motionGroup: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
8091
8253
  /**
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.
8254
+ * 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
8255
  * @summary Push or Release Emergency Stop
8094
8256
  * @param {string} cell Unique identifier addressing a cell in all API calls.
8095
8257
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -8110,7 +8272,7 @@ declare const VirtualControllerApiAxiosParamCreator: (configuration?: Configurat
8110
8272
  */
8111
8273
  setMotionGroupState: (cell: string, controller: string, motionGroup: string, motionGroupJoints: MotionGroupJoints, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
8112
8274
  /**
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.
8275
+ * 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
8276
  * @summary Set Operation Mode
8115
8277
  * @param {string} cell Unique identifier addressing a cell in all API calls.
8116
8278
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -8146,6 +8308,16 @@ declare const VirtualControllerApiFp: (configuration?: Configuration) => {
8146
8308
  * @throws {RequiredError}
8147
8309
  */
8148
8310
  addVirtualControllerCoordinateSystem(cell: string, controller: string, coordinateSystem: string, coordinateSystemData: CoordinateSystemData, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
8311
+ /**
8312
+ * 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.
8313
+ * @summary Add Motion Group
8314
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
8315
+ * @param {string} controller Unique identifier to address a controller in the cell.
8316
+ * @param {AddVirtualControllerMotionGroupRequest} addVirtualControllerMotionGroupRequest
8317
+ * @param {*} [options] Override http request option.
8318
+ * @throws {RequiredError}
8319
+ */
8320
+ addVirtualControllerMotionGroup(cell: string, controller: string, addVirtualControllerMotionGroupRequest: AddVirtualControllerMotionGroupRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
8149
8321
  /**
8150
8322
  * 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
8323
  * @summary Add TCP
@@ -8169,6 +8341,16 @@ declare const VirtualControllerApiFp: (configuration?: Configuration) => {
8169
8341
  * @throws {RequiredError}
8170
8342
  */
8171
8343
  deleteVirtualControllerCoordinateSystem(cell: string, controller: string, coordinateSystem: string, deleteDependent?: boolean, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
8344
+ /**
8345
+ * 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**.
8346
+ * @summary Delete Motion Group
8347
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
8348
+ * @param {string} controller Unique identifier to address a controller in the cell.
8349
+ * @param {string} motionGroup The motion-group identifier.
8350
+ * @param {*} [options] Override http request option.
8351
+ * @throws {RequiredError}
8352
+ */
8353
+ deleteVirtualControllerMotionGroup(cell: string, controller: string, motionGroup: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
8172
8354
  /**
8173
8355
  * 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
8356
  * @summary Remove TCP
@@ -8181,7 +8363,7 @@ declare const VirtualControllerApiFp: (configuration?: Configuration) => {
8181
8363
  */
8182
8364
  deleteVirtualControllerTcp(cell: string, controller: string, motionGroup: string, tcp: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
8183
8365
  /**
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.
8366
+ * 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
8367
  * @summary Get Emergency Stop State
8186
8368
  * @param {string} cell Unique identifier addressing a cell in all API calls.
8187
8369
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -8209,7 +8391,7 @@ declare const VirtualControllerApiFp: (configuration?: Configuration) => {
8209
8391
  */
8210
8392
  getMotionGroups(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<MotionGroupInfo>>>;
8211
8393
  /**
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.
8394
+ * 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
8395
  * @summary Get Operation Mode
8214
8396
  * @param {string} cell Unique identifier addressing a cell in all API calls.
8215
8397
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -8247,7 +8429,7 @@ declare const VirtualControllerApiFp: (configuration?: Configuration) => {
8247
8429
  */
8248
8430
  listVirtualControllerTcps(cell: string, controller: string, motionGroup: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<RobotTcp>>>;
8249
8431
  /**
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.
8432
+ * 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
8433
  * @summary Push or Release Emergency Stop
8252
8434
  * @param {string} cell Unique identifier addressing a cell in all API calls.
8253
8435
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -8268,7 +8450,7 @@ declare const VirtualControllerApiFp: (configuration?: Configuration) => {
8268
8450
  */
8269
8451
  setMotionGroupState(cell: string, controller: string, motionGroup: string, motionGroupJoints: MotionGroupJoints, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
8270
8452
  /**
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.
8453
+ * 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
8454
  * @summary Set Operation Mode
8273
8455
  * @param {string} cell Unique identifier addressing a cell in all API calls.
8274
8456
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -8304,6 +8486,16 @@ declare const VirtualControllerApiFactory: (configuration?: Configuration, baseP
8304
8486
  * @throws {RequiredError}
8305
8487
  */
8306
8488
  addVirtualControllerCoordinateSystem(cell: string, controller: string, coordinateSystem: string, coordinateSystemData: CoordinateSystemData, options?: RawAxiosRequestConfig): AxiosPromise<void>;
8489
+ /**
8490
+ * 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.
8491
+ * @summary Add Motion Group
8492
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
8493
+ * @param {string} controller Unique identifier to address a controller in the cell.
8494
+ * @param {AddVirtualControllerMotionGroupRequest} addVirtualControllerMotionGroupRequest
8495
+ * @param {*} [options] Override http request option.
8496
+ * @throws {RequiredError}
8497
+ */
8498
+ addVirtualControllerMotionGroup(cell: string, controller: string, addVirtualControllerMotionGroupRequest: AddVirtualControllerMotionGroupRequest, options?: RawAxiosRequestConfig): AxiosPromise<void>;
8307
8499
  /**
8308
8500
  * 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
8501
  * @summary Add TCP
@@ -8327,6 +8519,16 @@ declare const VirtualControllerApiFactory: (configuration?: Configuration, baseP
8327
8519
  * @throws {RequiredError}
8328
8520
  */
8329
8521
  deleteVirtualControllerCoordinateSystem(cell: string, controller: string, coordinateSystem: string, deleteDependent?: boolean, options?: RawAxiosRequestConfig): AxiosPromise<void>;
8522
+ /**
8523
+ * 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**.
8524
+ * @summary Delete Motion Group
8525
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
8526
+ * @param {string} controller Unique identifier to address a controller in the cell.
8527
+ * @param {string} motionGroup The motion-group identifier.
8528
+ * @param {*} [options] Override http request option.
8529
+ * @throws {RequiredError}
8530
+ */
8531
+ deleteVirtualControllerMotionGroup(cell: string, controller: string, motionGroup: string, options?: RawAxiosRequestConfig): AxiosPromise<void>;
8330
8532
  /**
8331
8533
  * 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
8534
  * @summary Remove TCP
@@ -8339,7 +8541,7 @@ declare const VirtualControllerApiFactory: (configuration?: Configuration, baseP
8339
8541
  */
8340
8542
  deleteVirtualControllerTcp(cell: string, controller: string, motionGroup: string, tcp: string, options?: RawAxiosRequestConfig): AxiosPromise<void>;
8341
8543
  /**
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.
8544
+ * 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
8545
  * @summary Get Emergency Stop State
8344
8546
  * @param {string} cell Unique identifier addressing a cell in all API calls.
8345
8547
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -8367,7 +8569,7 @@ declare const VirtualControllerApiFactory: (configuration?: Configuration, baseP
8367
8569
  */
8368
8570
  getMotionGroups(cell: string, controller: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<MotionGroupInfo>>;
8369
8571
  /**
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.
8572
+ * 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
8573
  * @summary Get Operation Mode
8372
8574
  * @param {string} cell Unique identifier addressing a cell in all API calls.
8373
8575
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -8405,7 +8607,7 @@ declare const VirtualControllerApiFactory: (configuration?: Configuration, baseP
8405
8607
  */
8406
8608
  listVirtualControllerTcps(cell: string, controller: string, motionGroup: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<RobotTcp>>;
8407
8609
  /**
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.
8610
+ * 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
8611
  * @summary Push or Release Emergency Stop
8410
8612
  * @param {string} cell Unique identifier addressing a cell in all API calls.
8411
8613
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -8426,7 +8628,7 @@ declare const VirtualControllerApiFactory: (configuration?: Configuration, baseP
8426
8628
  */
8427
8629
  setMotionGroupState(cell: string, controller: string, motionGroup: string, motionGroupJoints: MotionGroupJoints, options?: RawAxiosRequestConfig): AxiosPromise<void>;
8428
8630
  /**
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.
8631
+ * 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
8632
  * @summary Set Operation Mode
8431
8633
  * @param {string} cell Unique identifier addressing a cell in all API calls.
8432
8634
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -8462,6 +8664,16 @@ declare class VirtualControllerApi extends BaseAPI {
8462
8664
  * @throws {RequiredError}
8463
8665
  */
8464
8666
  addVirtualControllerCoordinateSystem(cell: string, controller: string, coordinateSystem: string, coordinateSystemData: CoordinateSystemData, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
8667
+ /**
8668
+ * 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.
8669
+ * @summary Add Motion Group
8670
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
8671
+ * @param {string} controller Unique identifier to address a controller in the cell.
8672
+ * @param {AddVirtualControllerMotionGroupRequest} addVirtualControllerMotionGroupRequest
8673
+ * @param {*} [options] Override http request option.
8674
+ * @throws {RequiredError}
8675
+ */
8676
+ addVirtualControllerMotionGroup(cell: string, controller: string, addVirtualControllerMotionGroupRequest: AddVirtualControllerMotionGroupRequest, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
8465
8677
  /**
8466
8678
  * 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
8679
  * @summary Add TCP
@@ -8485,6 +8697,16 @@ declare class VirtualControllerApi extends BaseAPI {
8485
8697
  * @throws {RequiredError}
8486
8698
  */
8487
8699
  deleteVirtualControllerCoordinateSystem(cell: string, controller: string, coordinateSystem: string, deleteDependent?: boolean, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
8700
+ /**
8701
+ * 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**.
8702
+ * @summary Delete Motion Group
8703
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
8704
+ * @param {string} controller Unique identifier to address a controller in the cell.
8705
+ * @param {string} motionGroup The motion-group identifier.
8706
+ * @param {*} [options] Override http request option.
8707
+ * @throws {RequiredError}
8708
+ */
8709
+ deleteVirtualControllerMotionGroup(cell: string, controller: string, motionGroup: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
8488
8710
  /**
8489
8711
  * 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
8712
  * @summary Remove TCP
@@ -8497,7 +8719,7 @@ declare class VirtualControllerApi extends BaseAPI {
8497
8719
  */
8498
8720
  deleteVirtualControllerTcp(cell: string, controller: string, motionGroup: string, tcp: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
8499
8721
  /**
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.
8722
+ * 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
8723
  * @summary Get Emergency Stop State
8502
8724
  * @param {string} cell Unique identifier addressing a cell in all API calls.
8503
8725
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -8525,7 +8747,7 @@ declare class VirtualControllerApi extends BaseAPI {
8525
8747
  */
8526
8748
  getMotionGroups(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<MotionGroupInfo[], any>>;
8527
8749
  /**
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.
8750
+ * 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
8751
  * @summary Get Operation Mode
8530
8752
  * @param {string} cell Unique identifier addressing a cell in all API calls.
8531
8753
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -8563,7 +8785,7 @@ declare class VirtualControllerApi extends BaseAPI {
8563
8785
  */
8564
8786
  listVirtualControllerTcps(cell: string, controller: string, motionGroup: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<RobotTcp[], any>>;
8565
8787
  /**
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.
8788
+ * 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
8789
  * @summary Push or Release Emergency Stop
8568
8790
  * @param {string} cell Unique identifier addressing a cell in all API calls.
8569
8791
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -8584,7 +8806,7 @@ declare class VirtualControllerApi extends BaseAPI {
8584
8806
  */
8585
8807
  setMotionGroupState(cell: string, controller: string, motionGroup: string, motionGroupJoints: MotionGroupJoints, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
8586
8808
  /**
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.
8809
+ * 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
8810
  * @summary Set Operation Mode
8589
8811
  * @param {string} cell Unique identifier addressing a cell in all API calls.
8590
8812
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -8610,7 +8832,7 @@ declare class VirtualControllerApi extends BaseAPI {
8610
8832
  */
8611
8833
  declare const VirtualControllerBehaviorApiAxiosParamCreator: (configuration?: Configuration) => {
8612
8834
  /**
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.
8835
+ * <!-- 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
8836
  * @summary Stream Joint Configuration
8615
8837
  * @param {string} cell Unique identifier addressing a cell in all API calls.
8616
8838
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -8629,7 +8851,7 @@ declare const VirtualControllerBehaviorApiAxiosParamCreator: (configuration?: Co
8629
8851
  */
8630
8852
  getCycleTime: (cell: string, controller: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
8631
8853
  /**
8632
- * Get the current virtual controller behavior. See [setVirtualControllerBehavior](setVirtualControllerBehavior) and the body for details.
8854
+ * Get the current virtual controller behavior. See [setVirtualControllerBehavior](#/operations/setVirtualControllerBehavior) and the body for details.
8633
8855
  * @summary Get Behavior
8634
8856
  * @param {string} cell Unique identifier addressing a cell in all API calls.
8635
8857
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -8653,7 +8875,7 @@ declare const VirtualControllerBehaviorApiAxiosParamCreator: (configuration?: Co
8653
8875
  */
8654
8876
  declare const VirtualControllerBehaviorApiFp: (configuration?: Configuration) => {
8655
8877
  /**
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.
8878
+ * <!-- 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
8879
  * @summary Stream Joint Configuration
8658
8880
  * @param {string} cell Unique identifier addressing a cell in all API calls.
8659
8881
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -8672,7 +8894,7 @@ declare const VirtualControllerBehaviorApiFp: (configuration?: Configuration) =>
8672
8894
  */
8673
8895
  getCycleTime(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CycleTime>>;
8674
8896
  /**
8675
- * Get the current virtual controller behavior. See [setVirtualControllerBehavior](setVirtualControllerBehavior) and the body for details.
8897
+ * Get the current virtual controller behavior. See [setVirtualControllerBehavior](#/operations/setVirtualControllerBehavior) and the body for details.
8676
8898
  * @summary Get Behavior
8677
8899
  * @param {string} cell Unique identifier addressing a cell in all API calls.
8678
8900
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -8696,7 +8918,7 @@ declare const VirtualControllerBehaviorApiFp: (configuration?: Configuration) =>
8696
8918
  */
8697
8919
  declare const VirtualControllerBehaviorApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
8698
8920
  /**
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.
8921
+ * <!-- 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
8922
  * @summary Stream Joint Configuration
8701
8923
  * @param {string} cell Unique identifier addressing a cell in all API calls.
8702
8924
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -8715,7 +8937,7 @@ declare const VirtualControllerBehaviorApiFactory: (configuration?: Configuratio
8715
8937
  */
8716
8938
  getCycleTime(cell: string, controller: string, options?: RawAxiosRequestConfig): AxiosPromise<CycleTime>;
8717
8939
  /**
8718
- * Get the current virtual controller behavior. See [setVirtualControllerBehavior](setVirtualControllerBehavior) and the body for details.
8940
+ * Get the current virtual controller behavior. See [setVirtualControllerBehavior](#/operations/setVirtualControllerBehavior) and the body for details.
8719
8941
  * @summary Get Behavior
8720
8942
  * @param {string} cell Unique identifier addressing a cell in all API calls.
8721
8943
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -8739,7 +8961,7 @@ declare const VirtualControllerBehaviorApiFactory: (configuration?: Configuratio
8739
8961
  */
8740
8962
  declare class VirtualControllerBehaviorApi extends BaseAPI {
8741
8963
  /**
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.
8964
+ * <!-- 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
8965
  * @summary Stream Joint Configuration
8744
8966
  * @param {string} cell Unique identifier addressing a cell in all API calls.
8745
8967
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -8758,7 +8980,7 @@ declare class VirtualControllerBehaviorApi extends BaseAPI {
8758
8980
  */
8759
8981
  getCycleTime(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<CycleTime, any>>;
8760
8982
  /**
8761
- * Get the current virtual controller behavior. See [setVirtualControllerBehavior](setVirtualControllerBehavior) and the body for details.
8983
+ * Get the current virtual controller behavior. See [setVirtualControllerBehavior](#/operations/setVirtualControllerBehavior) and the body for details.
8762
8984
  * @summary Get Behavior
8763
8985
  * @param {string} cell Unique identifier addressing a cell in all API calls.
8764
8986
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -8782,7 +9004,7 @@ declare class VirtualControllerBehaviorApi extends BaseAPI {
8782
9004
  */
8783
9005
  declare const VirtualControllerInputsOutputsApiAxiosParamCreator: (configuration?: Configuration) => {
8784
9006
  /**
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).
9007
+ * 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
9008
  * @summary Get Input/Output Values
8787
9009
  * @param {string} cell Unique identifier addressing a cell in all API calls.
8788
9010
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -8820,7 +9042,7 @@ declare const VirtualControllerInputsOutputsApiAxiosParamCreator: (configuration
8820
9042
  */
8821
9043
  declare const VirtualControllerInputsOutputsApiFp: (configuration?: Configuration) => {
8822
9044
  /**
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).
9045
+ * Retrieves the current values of inputs/outputs of the virtual controller. The identifiers of inputs/outputs must be provided in the request. Request all available input/output identifiers via [listVirtualControllerIODescriptions](#/operations/listVirtualControllerIODescriptions).
8824
9046
  * @summary Get Input/Output Values
8825
9047
  * @param {string} cell Unique identifier addressing a cell in all API calls.
8826
9048
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -8858,7 +9080,7 @@ declare const VirtualControllerInputsOutputsApiFp: (configuration?: Configuratio
8858
9080
  */
8859
9081
  declare const VirtualControllerInputsOutputsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
8860
9082
  /**
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).
9083
+ * 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
9084
  * @summary Get Input/Output Values
8863
9085
  * @param {string} cell Unique identifier addressing a cell in all API calls.
8864
9086
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -8896,7 +9118,7 @@ declare const VirtualControllerInputsOutputsApiFactory: (configuration?: Configu
8896
9118
  */
8897
9119
  declare class VirtualControllerInputsOutputsApi extends BaseAPI {
8898
9120
  /**
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).
9121
+ * 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
9122
  * @summary Get Input/Output Values
8901
9123
  * @param {string} cell Unique identifier addressing a cell in all API calls.
8902
9124
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -8930,4 +9152,4 @@ declare class VirtualControllerInputsOutputsApi extends BaseAPI {
8930
9152
  setIOValues(cell: string, controller: string, iOValue: Array<IOValue>, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
8931
9153
  }
8932
9154
  //#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 };
9155
+ 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, 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, 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, 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, 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 };