@wandelbots/nova-api 25.6.0-dev.34 → 25.6.0-dev.36

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/v2/api.ts CHANGED
@@ -216,6 +216,12 @@ export interface App {
216
216
  * @memberof App
217
217
  */
218
218
  'health_path'?: string;
219
+ /**
220
+ * Defines the URL path suffix used to provide an endpoint for diagnosis data collection. The complete diagnosis check URL is constructed as `/$cell/$name/$diagnosis_path`. The endpoint is called when a diagnosis package is requested via the diagnosis API. The endpoint needs to return the data within a zip file `application/zip` response.
221
+ * @type {string}
222
+ * @memberof App
223
+ */
224
+ 'diagnosis_path'?: string;
219
225
  }
220
226
  /**
221
227
  * ## BEHAVIOR_AUTOMATIC This is the default behavior. The motion group instantly takes any 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).
@@ -953,6 +959,26 @@ export const Direction = {
953
959
  export type Direction = typeof Direction[keyof typeof Direction];
954
960
 
955
961
 
962
+ /**
963
+ *
964
+ * @export
965
+ * @interface EndOfTrajectory
966
+ */
967
+ export interface EndOfTrajectory {
968
+ /**
969
+ *
970
+ * @type {string}
971
+ * @memberof EndOfTrajectory
972
+ */
973
+ 'kind': EndOfTrajectoryKindEnum;
974
+ }
975
+
976
+ export const EndOfTrajectoryKindEnum = {
977
+ EndOfTrajectory: 'END_OF_TRAJECTORY'
978
+ } as const;
979
+
980
+ export type EndOfTrajectoryKindEnum = typeof EndOfTrajectoryKindEnum[keyof typeof EndOfTrajectoryKindEnum];
981
+
956
982
  /**
957
983
  *
958
984
  * @export
@@ -966,17 +992,42 @@ export interface Error2 {
966
992
  */
967
993
  'message': string;
968
994
  }
995
+ /**
996
+ * Details about the state of the motion execution. The details are either for a jogging or a trajectory. If NOVA is not controlling this motion group at the moment, this field is omitted.
997
+ * @export
998
+ * @interface Execute
999
+ */
1000
+ export interface Execute {
1001
+ /**
1002
+ * Commanded joint position of each joint in [rad]. This command was sent in the time step the corresponding state was received.
1003
+ * @type {Array<number>}
1004
+ * @memberof Execute
1005
+ */
1006
+ 'joint_position': Array<number>;
1007
+ /**
1008
+ *
1009
+ * @type {ExecuteDetails}
1010
+ * @memberof Execute
1011
+ */
1012
+ 'details'?: ExecuteDetails;
1013
+ }
1014
+ /**
1015
+ * @type ExecuteDetails
1016
+ * @export
1017
+ */
1018
+ export type ExecuteDetails = { kind: 'JOGGING' } & JoggingDetails | { kind: 'TRAJECTORY' } & TrajectoryDetails;
1019
+
969
1020
  /**
970
1021
  * @type ExecuteJoggingRequest
971
1022
  * @export
972
1023
  */
973
- export type ExecuteJoggingRequest = InitializeJoggingRequest | JointVelocityRequest | TcpVelocityRequest;
1024
+ export type ExecuteJoggingRequest = InitializeJoggingRequest | JointVelocityRequest | PauseJoggingRequest | TcpVelocityRequest;
974
1025
 
975
1026
  /**
976
1027
  * @type ExecuteJoggingResponse
977
1028
  * @export
978
1029
  */
979
- export type ExecuteJoggingResponse = InitializeJoggingResponse | JoggingErrorResponse | JoggingResponse;
1030
+ export type ExecuteJoggingResponse = InitializeJoggingResponse | JointVelocityResponse | MovementErrorResponse | PauseJoggingResponse | TcpVelocityResponse;
980
1031
 
981
1032
  /**
982
1033
  * @type ExecuteTrajectoryRequest
@@ -988,7 +1039,7 @@ export type ExecuteTrajectoryRequest = InitializeMovementRequest | PauseMovement
988
1039
  * @type ExecuteTrajectoryResponse
989
1040
  * @export
990
1041
  */
991
- export type ExecuteTrajectoryResponse = InitializeMovementResponse | Movement | MovementError | PauseMovementResponse | PlaybackSpeedResponse | Standstill;
1042
+ export type ExecuteTrajectoryResponse = InitializeMovementResponse | MovementErrorResponse | PauseMovementResponse | PlaybackSpeedResponse | StartMovementResponse;
992
1043
 
993
1044
  /**
994
1045
  * A datapoint inside external joint stream.
@@ -1607,37 +1658,31 @@ export const InitializeJoggingRequestMessageTypeEnum = {
1607
1658
  export type InitializeJoggingRequestMessageTypeEnum = typeof InitializeJoggingRequestMessageTypeEnum[keyof typeof InitializeJoggingRequestMessageTypeEnum];
1608
1659
 
1609
1660
  /**
1610
- * Response to an InitializeJoggingRequest.
1661
+ * Acknowledgment to an InitializeJoggingRequest.
1611
1662
  * @export
1612
1663
  * @interface InitializeJoggingResponse
1613
1664
  */
1614
1665
  export interface InitializeJoggingResponse {
1615
1666
  /**
1616
- *
1617
- * @type {InitializeJoggingResponseInitResponse}
1667
+ * Error message in case of invalid InitializeJoggingRequest.
1668
+ * @type {string}
1618
1669
  * @memberof InitializeJoggingResponse
1619
1670
  */
1620
- 'init_response': InitializeJoggingResponseInitResponse;
1621
- }
1622
- /**
1623
- *
1624
- * @export
1625
- * @interface InitializeJoggingResponseInitResponse
1626
- */
1627
- export interface InitializeJoggingResponseInitResponse {
1628
- /**
1629
- * Indicates if the jogging control is ready for execution.
1630
- * @type {boolean}
1631
- * @memberof InitializeJoggingResponseInitResponse
1632
- */
1633
- 'succeeded': boolean;
1671
+ 'message'?: string;
1634
1672
  /**
1635
- * Error message in case of invalid InitializeMovementRequest.
1673
+ *
1636
1674
  * @type {string}
1637
- * @memberof InitializeJoggingResponseInitResponse
1675
+ * @memberof InitializeJoggingResponse
1638
1676
  */
1639
- 'error_message'?: string;
1677
+ 'kind': InitializeJoggingResponseKindEnum;
1640
1678
  }
1679
+
1680
+ export const InitializeJoggingResponseKindEnum = {
1681
+ InitializeReceived: 'INITIALIZE_RECEIVED'
1682
+ } as const;
1683
+
1684
+ export type InitializeJoggingResponseKindEnum = typeof InitializeJoggingResponseKindEnum[keyof typeof InitializeJoggingResponseKindEnum];
1685
+
1641
1686
  /**
1642
1687
  * Sets up connection by locking a trajectory for execution. The robot controller mode is set to control mode. ATTENTION: This request has to be sent before any StartMovementRequest is sent. If initializing the movement was successful, no further movements can be initialized. To execute another trajectory, another connection has to be established.
1643
1688
  * @export
@@ -1696,31 +1741,31 @@ export type InitializeMovementRequestTrajectory = { message_type: 'TrajectoryDat
1696
1741
  */
1697
1742
  export interface InitializeMovementResponse {
1698
1743
  /**
1699
- *
1700
- * @type {InitializeMovementResponseInitResponse}
1744
+ * Error message in case of invalid InitializeMovementRequest.
1745
+ * @type {string}
1701
1746
  * @memberof InitializeMovementResponse
1702
1747
  */
1703
- 'init_response': InitializeMovementResponseInitResponse;
1704
- }
1705
- /**
1706
- *
1707
- * @export
1708
- * @interface InitializeMovementResponseInitResponse
1709
- */
1710
- export interface InitializeMovementResponseInitResponse {
1748
+ 'message'?: string;
1711
1749
  /**
1712
- * Indicates if the trajectory was successfully locked and is ready for execution by sending a StartMovementRequest. Send PlaybackSpeedRequest to override the planned velocity.
1713
- * @type {boolean}
1714
- * @memberof InitializeMovementResponseInitResponse
1750
+ * Error can occur if joint trajectory was added by [InitializeMovementRequest](InitializeMovementRequest) and the trajectory is invalid.
1751
+ * @type {AddTrajectoryError}
1752
+ * @memberof InitializeMovementResponse
1715
1753
  */
1716
- 'succeeded': boolean;
1754
+ 'add_trajectory_error'?: AddTrajectoryError;
1717
1755
  /**
1718
- * Error message in case of invalid InitializeMovementRequest.
1756
+ *
1719
1757
  * @type {string}
1720
- * @memberof InitializeMovementResponseInitResponse
1758
+ * @memberof InitializeMovementResponse
1721
1759
  */
1722
- 'error_message'?: string;
1760
+ 'kind': InitializeMovementResponseKindEnum;
1723
1761
  }
1762
+
1763
+ export const InitializeMovementResponseKindEnum = {
1764
+ InitializeReceived: 'INITIALIZE_RECEIVED'
1765
+ } as const;
1766
+
1767
+ export type InitializeMovementResponseKindEnum = typeof InitializeMovementResponseKindEnum[keyof typeof InitializeMovementResponseKindEnum];
1768
+
1724
1769
  /**
1725
1770
  * Value of an input/output with integer representation. > The integral value is transmitted as a string to avoid precision loss during conversion to JSON. > We recommend to use int64 in your implementation. If you want to interact with int64 in numbers, > JS bigint libraries can help you to parse the string into an integral value.
1726
1771
  * @export
@@ -1836,159 +1881,36 @@ export interface InverseKinematicsResponse {
1836
1881
  'joints': Array<Array<Array<number>>>;
1837
1882
  }
1838
1883
  /**
1839
- * Response signalling an error during jogging execution. This response is sent in case of an unexpected error, e.g. controller disconnects.
1840
- * @export
1841
- * @interface JoggingErrorResponse
1842
- */
1843
- export interface JoggingErrorResponse {
1844
- /**
1845
- *
1846
- * @type {JoggingErrorResponseError}
1847
- * @memberof JoggingErrorResponse
1848
- */
1849
- 'error': JoggingErrorResponseError;
1850
- }
1851
- /**
1852
- *
1853
- * @export
1854
- * @interface JoggingErrorResponseError
1855
- */
1856
- export interface JoggingErrorResponseError {
1857
- /**
1858
- * Error description.
1859
- * @type {string}
1860
- * @memberof JoggingErrorResponseError
1861
- */
1862
- 'error_message': string;
1863
- }
1864
- /**
1865
- *
1884
+ * State of jogging execution. This state is sent during jogging movement, response-rate closest to the nearest multiple of controller step-rate but not exceeding the configured rate. The jogging state can be one of the following: - RUNNING: Jogging is active. - PAUSED_BY_USER: User has paused jogging. - PAUSED_NEAR_JOINT_LIMIT: Jogging was paused because a joint is is near its limit. - PAUSED_NEAR_COLLISION: Jogging was paused because the motion group neared a collision. - PAUSED_ON_IO: Jogging was paused because of an I/O event.
1866
1885
  * @export
1867
- * @interface JoggingPausedCollision
1886
+ * @interface JoggingDetails
1868
1887
  */
1869
- export interface JoggingPausedCollision {
1888
+ export interface JoggingDetails {
1870
1889
  /**
1871
1890
  *
1872
- * @type {JoggingPausedCollisionPausedNearCollision}
1873
- * @memberof JoggingPausedCollision
1891
+ * @type {JoggingDetailsState}
1892
+ * @memberof JoggingDetails
1874
1893
  */
1875
- 'paused_near_collision': JoggingPausedCollisionPausedNearCollision;
1876
- }
1877
- /**
1878
- *
1879
- * @export
1880
- * @interface JoggingPausedCollisionPausedNearCollision
1881
- */
1882
- export interface JoggingPausedCollisionPausedNearCollision {
1894
+ 'state': JoggingDetailsState;
1883
1895
  /**
1884
1896
  *
1885
1897
  * @type {string}
1886
- * @memberof JoggingPausedCollisionPausedNearCollision
1887
- */
1888
- 'description'?: string;
1889
- }
1890
- /**
1891
- *
1892
- * @export
1893
- * @interface JoggingPausedJointLimit
1894
- */
1895
- export interface JoggingPausedJointLimit {
1896
- /**
1897
- *
1898
- * @type {JoggingPausedJointLimitPausedNearJointLimit}
1899
- * @memberof JoggingPausedJointLimit
1900
- */
1901
- 'paused_near_joint_limit': JoggingPausedJointLimitPausedNearJointLimit;
1902
- }
1903
- /**
1904
- *
1905
- * @export
1906
- * @interface JoggingPausedJointLimitPausedNearJointLimit
1907
- */
1908
- export interface JoggingPausedJointLimitPausedNearJointLimit {
1909
- /**
1910
- *
1911
- * @type {Array<number>}
1912
- * @memberof JoggingPausedJointLimitPausedNearJointLimit
1913
- */
1914
- 'joint_indices'?: Array<number>;
1915
- }
1916
- /**
1917
- *
1918
- * @export
1919
- * @interface JoggingPausedOnIO
1920
- */
1921
- export interface JoggingPausedOnIO {
1922
- /**
1923
- *
1924
- * @type {object}
1925
- * @memberof JoggingPausedOnIO
1926
- */
1927
- 'paused_on_io': object;
1928
- }
1929
- /**
1930
- *
1931
- * @export
1932
- * @interface JoggingPausedUserRequest
1933
- */
1934
- export interface JoggingPausedUserRequest {
1935
- /**
1936
- *
1937
- * @type {object}
1938
- * @memberof JoggingPausedUserRequest
1939
- */
1940
- 'paused_by_user_request': object;
1941
- }
1942
- /**
1943
- * Sent during jogging movement, response-rate closest to the nearest multiple of controller step-rate but not exceeding the configured rate.
1944
- * @export
1945
- * @interface JoggingResponse
1946
- */
1947
- export interface JoggingResponse {
1948
- /**
1949
- *
1950
- * @type {JoggingResponseJogging}
1951
- * @memberof JoggingResponse
1952
- */
1953
- 'jogging': JoggingResponseJogging;
1954
- }
1955
- /**
1956
- *
1957
- * @export
1958
- * @interface JoggingResponseJogging
1959
- */
1960
- export interface JoggingResponseJogging {
1961
- /**
1962
- *
1963
- * @type {JoggingState}
1964
- * @memberof JoggingResponseJogging
1965
- */
1966
- 'jogging_state': JoggingState;
1967
- /**
1968
- *
1969
- * @type {RobotControllerState}
1970
- * @memberof JoggingResponseJogging
1971
- */
1972
- 'robot_controller_state': RobotControllerState;
1973
- }
1974
- /**
1975
- *
1976
- * @export
1977
- * @interface JoggingRunning
1978
- */
1979
- export interface JoggingRunning {
1980
- /**
1981
- *
1982
- * @type {object}
1983
- * @memberof JoggingRunning
1898
+ * @memberof JoggingDetails
1984
1899
  */
1985
- 'running': object;
1900
+ 'kind': JoggingDetailsKindEnum;
1986
1901
  }
1902
+
1903
+ export const JoggingDetailsKindEnum = {
1904
+ Jogging: 'JOGGING'
1905
+ } as const;
1906
+
1907
+ export type JoggingDetailsKindEnum = typeof JoggingDetailsKindEnum[keyof typeof JoggingDetailsKindEnum];
1908
+
1987
1909
  /**
1988
- * @type JoggingState
1910
+ * @type JoggingDetailsState
1989
1911
  * @export
1990
1912
  */
1991
- export type JoggingState = JoggingPausedCollision | JoggingPausedJointLimit | JoggingPausedOnIO | JoggingPausedUserRequest | JoggingRunning;
1913
+ export type JoggingDetailsState = PausedByUser | PausedNearCollision | PausedNearJointLimit | PausedOnIO | Running;
1992
1914
 
1993
1915
  /**
1994
1916
  *
@@ -2054,6 +1976,32 @@ export const JointVelocityRequestMessageTypeEnum = {
2054
1976
 
2055
1977
  export type JointVelocityRequestMessageTypeEnum = typeof JointVelocityRequestMessageTypeEnum[keyof typeof JointVelocityRequestMessageTypeEnum];
2056
1978
 
1979
+ /**
1980
+ * Acknowledgment to a JointVelocityRequest.
1981
+ * @export
1982
+ * @interface JointVelocityResponse
1983
+ */
1984
+ export interface JointVelocityResponse {
1985
+ /**
1986
+ * Error message in case of invalid JointVelocityRequest.
1987
+ * @type {string}
1988
+ * @memberof JointVelocityResponse
1989
+ */
1990
+ 'message'?: string;
1991
+ /**
1992
+ *
1993
+ * @type {string}
1994
+ * @memberof JointVelocityResponse
1995
+ */
1996
+ 'kind': JointVelocityResponseKindEnum;
1997
+ }
1998
+
1999
+ export const JointVelocityResponseKindEnum = {
2000
+ JointVelocityReceived: 'JOINT_VELOCITY_RECEIVED'
2001
+ } as const;
2002
+
2003
+ export type JointVelocityResponseKindEnum = typeof JointVelocityResponseKindEnum[keyof typeof JointVelocityResponseKindEnum];
2004
+
2057
2005
  /**
2058
2006
  * This structure describes a set of joint values of a motion group. We call a set of joint values describing the current position in joint space of a motion group a \"joint position\". Joint position was chosen as the term to be consistent with the terms \"joint velocity\" and \"joint acceleration\". `joints` must have as many entries as the motion group\'s degrees of freedom to be valid. Float precision is the default.
2059
2007
  * @export
@@ -2524,17 +2472,17 @@ export interface MotionGroupJoints {
2524
2472
  'torques'?: Array<number>;
2525
2473
  }
2526
2474
  /**
2527
- *
2475
+ * Presents the current state of the motion group.
2528
2476
  * @export
2529
2477
  * @interface MotionGroupState
2530
2478
  */
2531
2479
  export interface MotionGroupState {
2532
2480
  /**
2533
- * Timestamp indicating when the represented information was received from the robot controller.
2481
+ * Timestamp for when data was received from the robot controller.
2534
2482
  * @type {string}
2535
2483
  * @memberof MotionGroupState
2536
2484
  */
2537
- 'timestamp'?: string;
2485
+ 'timestamp': string;
2538
2486
  /**
2539
2487
  * Sequence number of the controller state. It starts with 0 upon establishing the connection with a physical controller. The sequence number is reset when the connection to the physical controller is closed and re-established.
2540
2488
  * @type {number}
@@ -2566,59 +2514,59 @@ export interface MotionGroupState {
2566
2514
  */
2567
2515
  'joint_limit_reached': MotionGroupStateJointLimitReached;
2568
2516
  /**
2569
- * Current joint velocity of each joint in [rad/s]
2570
- * @type {Joints}
2571
- * @memberof MotionGroupState
2572
- */
2573
- 'joint_velocity': Joints;
2574
- /**
2575
- * Current joint torque of each joint in [Nm]. Is only available if the robot controller supports it (e.g. available for UR Controllers).
2517
+ * Current joint torque of each joint in [Nm]. Is only available if the robot controller supports it, e.g. available for UR controllers.
2576
2518
  * @type {Joints}
2577
2519
  * @memberof MotionGroupState
2578
2520
  */
2579
2521
  'joint_torque'?: Joints;
2580
2522
  /**
2581
- * Current Current at TCP in [A]. Is only available if the robot controller supports it, e.g. available for UR Controllers.
2523
+ * Current at TCP in [A]. Is only available if the robot controller supports it, e.g. available for UR controllers.
2582
2524
  * @type {Joints}
2583
2525
  * @memberof MotionGroupState
2584
2526
  */
2585
2527
  'joint_current'?: Joints;
2586
2528
  /**
2587
- * Pose of the Flange (last point of the motion group before the endeffector starts). Positions are in [mm]. Oriantations are in [rad]. The pose is relative to the response_coordinate_system that is 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.
2529
+ * 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.
2588
2530
  * @type {Pose}
2589
2531
  * @memberof MotionGroupState
2590
2532
  */
2591
2533
  'flange_pose'?: Pose;
2592
2534
  /**
2593
- * Unique identifier addressing the TCP currently set.
2535
+ * Unique identifier addressing the active TCP. Might not be returned for positioners as some do not support TCPs, depending on the model.
2594
2536
  * @type {string}
2595
2537
  * @memberof MotionGroupState
2596
2538
  */
2597
- 'tcp': string;
2539
+ 'tcp'?: string;
2598
2540
  /**
2599
- * Pose of the TCP currently selected on the robot control panel. Positions are in [mm]. Oriantations are in [rad]. The pose is relative to the response_coordinate_system that is specified in the request.
2541
+ * 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.
2600
2542
  * @type {Pose}
2601
2543
  * @memberof MotionGroupState
2602
2544
  */
2603
- 'tcp_pose': Pose;
2545
+ 'tcp_pose'?: Pose;
2604
2546
  /**
2605
- * Current velocity at TCP in [mm/s]. If `tcp` is not specified, the velocity at the flange is returned. The velocity is relative to the response_coordinate_system specified in the request.
2606
- * @type {MotionVector}
2547
+ * Unique identifier addressing the reference coordinate system of the cartesian data. Might not be returned for positioners as some do not support TCPs, depending on the model. Default: world coordinate system of corresponding controller.
2548
+ * @type {string}
2607
2549
  * @memberof MotionGroupState
2608
2550
  */
2609
- 'tcp_velocity': MotionVector;
2551
+ 'coordinate_system'?: string;
2610
2552
  /**
2611
- * Unique identifier addressing the reference coordinate system of the cartesian data. Default is the world coordinate system of corresponding controller.
2553
+ * Unique identifier addressing the active payload. Only fetchable via GET endpoint, not available in WebSocket.
2612
2554
  * @type {string}
2613
2555
  * @memberof MotionGroupState
2614
2556
  */
2615
- 'coordinate_system': string;
2557
+ 'payload'?: string;
2616
2558
  /**
2617
- * Unique identifier addressing the Payload currently set. Only fetchable via GET endpoint, not available in WebSocket.
2618
- * @type {string}
2559
+ * Indicates whether the motion group is in standstill. Convenience: Signals that NOVA treats measured joint velocities as 0.
2560
+ * @type {boolean}
2619
2561
  * @memberof MotionGroupState
2620
2562
  */
2621
- 'payload'?: string;
2563
+ 'standstill': boolean;
2564
+ /**
2565
+ * Data that was commanded to the motion group. Includes additional data on NOVA\'s execution components for executing trajectories and jogging. This is a convenience field to indicate the last command sent to the motion group. It is not available in all cases, e.g. if the motion group is not moved by NOVA.
2566
+ * @type {Execute}
2567
+ * @memberof MotionGroupState
2568
+ */
2569
+ 'execute'?: Execute;
2622
2570
  }
2623
2571
  /**
2624
2572
  * Indicates which joint of the motion group is in a limit. If a joint is in its limit, only this joint can be moved. Movements that affect any other joints are not executed.
@@ -2633,97 +2581,6 @@ export interface MotionGroupStateJointLimitReached {
2633
2581
  */
2634
2582
  'limit_reached': Array<boolean>;
2635
2583
  }
2636
- /**
2637
- * Presents the current state of the motion group.
2638
- * @export
2639
- * @interface MotionGroupStateWithoutPayload
2640
- */
2641
- export interface MotionGroupStateWithoutPayload {
2642
- /**
2643
- * Timestamp indicating when the represented information was received from the robot controller.
2644
- * @type {string}
2645
- * @memberof MotionGroupStateWithoutPayload
2646
- */
2647
- 'timestamp'?: string;
2648
- /**
2649
- * Sequence number of the controller state. It starts with 0 upon establishing the connection with a physical controller. The sequence number is reset when the connection to the physical controller is closed and re-established.
2650
- * @type {number}
2651
- * @memberof MotionGroupStateWithoutPayload
2652
- */
2653
- 'sequence_number': number;
2654
- /**
2655
- * Identifier of the motion group.
2656
- * @type {string}
2657
- * @memberof MotionGroupStateWithoutPayload
2658
- */
2659
- 'motion_group': string;
2660
- /**
2661
- * Convenience: Identifier of the robot controller the motion group is attached to.
2662
- * @type {string}
2663
- * @memberof MotionGroupStateWithoutPayload
2664
- */
2665
- 'controller': string;
2666
- /**
2667
- * Current joint position of each joint in [rad]
2668
- * @type {Joints}
2669
- * @memberof MotionGroupStateWithoutPayload
2670
- */
2671
- 'joint_position': Joints;
2672
- /**
2673
- * Indicates whether the joint is in a limit for all joints of the motion group.
2674
- * @type {MotionGroupStateJointLimitReached}
2675
- * @memberof MotionGroupStateWithoutPayload
2676
- */
2677
- 'joint_limit_reached': MotionGroupStateJointLimitReached;
2678
- /**
2679
- * Current joint velocity of each joint in [rad/s]
2680
- * @type {Joints}
2681
- * @memberof MotionGroupStateWithoutPayload
2682
- */
2683
- 'joint_velocity': Joints;
2684
- /**
2685
- * Current joint torque of each joint in [Nm]. Is only available if the robot controller supports it (e.g. available for UR Controllers).
2686
- * @type {Joints}
2687
- * @memberof MotionGroupStateWithoutPayload
2688
- */
2689
- 'joint_torque'?: Joints;
2690
- /**
2691
- * Current Current at TCP in [A]. Is only available if the robot controller supports it, e.g. available for UR Controllers.
2692
- * @type {Joints}
2693
- * @memberof MotionGroupStateWithoutPayload
2694
- */
2695
- 'joint_current'?: Joints;
2696
- /**
2697
- * Pose of the Flange (last point of the motion group before the endeffector starts). Positions are in [mm]. Oriantations are in [rad]. The pose is relative to the response_coordinate_system that is 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.
2698
- * @type {Pose}
2699
- * @memberof MotionGroupStateWithoutPayload
2700
- */
2701
- 'flange_pose'?: Pose;
2702
- /**
2703
- * Unique identifier addressing the TCP currently set.
2704
- * @type {string}
2705
- * @memberof MotionGroupStateWithoutPayload
2706
- */
2707
- 'tcp': string;
2708
- /**
2709
- * Pose of the TCP currently selected on the robot control panel. Positions are in [mm]. Oriantations are in [rad]. The pose is relative to the response_coordinate_system that is specified in the request.
2710
- * @type {Pose}
2711
- * @memberof MotionGroupStateWithoutPayload
2712
- */
2713
- 'tcp_pose': Pose;
2714
- /**
2715
- * Current velocity at TCP in [mm/s]. If `tcp` is not specified, the velocity at the flange is returned. The velocity is relative to the response_coordinate_system specified in the request.
2716
- * @type {MotionVector}
2717
- * @memberof MotionGroupStateWithoutPayload
2718
- */
2719
- 'tcp_velocity': MotionVector;
2720
- /**
2721
- * Unique identifier addressing the reference coordinate system of the cartesian data. Default is the world coordinate system of corresponding controller.
2722
- * @type {string}
2723
- * @memberof MotionGroupStateWithoutPayload
2724
- */
2725
- 'coordinate_system': string;
2726
- }
2727
2584
  /**
2728
2585
  * Collection of information on the current state of the robot.
2729
2586
  * @export
@@ -2750,94 +2607,31 @@ export interface MotionState {
2750
2607
  'state': RobotState;
2751
2608
  }
2752
2609
  /**
2753
- *
2610
+ * Error message in case an error occurs during movement execution.
2754
2611
  * @export
2755
- * @interface MotionVector
2612
+ * @interface MovementErrorResponse
2756
2613
  */
2757
- export interface MotionVector {
2614
+ export interface MovementErrorResponse {
2758
2615
  /**
2759
- * A three-dimensional vector [x, y, z] with double precision.
2760
- * @type {Array<number>}
2761
- * @memberof MotionVector
2762
- */
2763
- 'linear'?: Array<number>;
2764
- /**
2765
- * A three-dimensional vector [x, y, z] with double precision.
2766
- * @type {Array<number>}
2767
- * @memberof MotionVector
2768
- */
2769
- 'angular'?: Array<number>;
2770
- /**
2771
- * optional, unique name of base coordinate system, if empty world is used
2616
+ * Detailed error message describing the issue encountered during movement execution.
2772
2617
  * @type {string}
2773
- * @memberof MotionVector
2618
+ * @memberof MovementErrorResponse
2774
2619
  */
2775
- 'coordinate_system'?: string;
2776
- }
2777
- /**
2778
- * Sent during trajectory movement, response-rate closest to the nearest multiple of controller step-rate but not exceeding the configured rate.
2779
- * @export
2780
- * @interface Movement
2781
- */
2782
- export interface Movement {
2783
- /**
2784
- *
2785
- * @type {MovementMovement}
2786
- * @memberof Movement
2787
- */
2788
- 'movement': MovementMovement;
2789
- }
2790
- /**
2791
- * Response signalling an error during trajectory execution. This response is sent in case of an unexpected error , e.g. controller disconnects. The error details are described in the error_message field.
2792
- * @export
2793
- * @interface MovementError
2794
- */
2795
- export interface MovementError {
2620
+ 'message': string;
2796
2621
  /**
2797
2622
  *
2798
- * @type {MovementErrorError}
2799
- * @memberof MovementError
2800
- */
2801
- 'error': MovementErrorError;
2802
- }
2803
- /**
2804
- *
2805
- * @export
2806
- * @interface MovementErrorError
2807
- */
2808
- export interface MovementErrorError {
2809
- /**
2810
- * Human-readable error details that describes the error.
2811
2623
  * @type {string}
2812
- * @memberof MovementErrorError
2624
+ * @memberof MovementErrorResponse
2813
2625
  */
2814
- 'error_message': string;
2815
- }
2816
- /**
2817
- *
2818
- * @export
2819
- * @interface MovementMovement
2820
- */
2821
- export interface MovementMovement {
2822
- /**
2823
- * Remaining time in milliseconds (ms) to reach the end of the motion.
2824
- * @type {number}
2825
- * @memberof MovementMovement
2826
- */
2827
- 'time_to_end': number;
2828
- /**
2829
- * Current location of motion group on the trajectory.
2830
- * @type {number}
2831
- * @memberof MovementMovement
2832
- */
2833
- 'current_location': number;
2834
- /**
2835
- * Current state of the robot controller and moving motion group.
2836
- * @type {RobotControllerState}
2837
- * @memberof MovementMovement
2838
- */
2839
- 'state': RobotControllerState;
2626
+ 'kind': MovementErrorResponseKindEnum;
2840
2627
  }
2628
+
2629
+ export const MovementErrorResponseKindEnum = {
2630
+ Error: 'ERROR'
2631
+ } as const;
2632
+
2633
+ export type MovementErrorResponseKindEnum = typeof MovementErrorResponseKindEnum[keyof typeof MovementErrorResponseKindEnum];
2634
+
2841
2635
  /**
2842
2636
  *
2843
2637
  * @export
@@ -3089,6 +2883,52 @@ export const PathLinePathDefinitionNameEnum = {
3089
2883
 
3090
2884
  export type PathLinePathDefinitionNameEnum = typeof PathLinePathDefinitionNameEnum[keyof typeof PathLinePathDefinitionNameEnum];
3091
2885
 
2886
+ /**
2887
+ * Request to pause jogging. If successful, `execute` jogging state in [MotionGroupState](MotionGroupState.yaml) is set to `PAUSED_BY_USER`.
2888
+ * @export
2889
+ * @interface PauseJoggingRequest
2890
+ */
2891
+ export interface PauseJoggingRequest {
2892
+ /**
2893
+ * Type specifier for server, set automatically.
2894
+ * @type {string}
2895
+ * @memberof PauseJoggingRequest
2896
+ */
2897
+ 'message_type'?: PauseJoggingRequestMessageTypeEnum;
2898
+ }
2899
+
2900
+ export const PauseJoggingRequestMessageTypeEnum = {
2901
+ PauseJoggingRequest: 'PauseJoggingRequest'
2902
+ } as const;
2903
+
2904
+ export type PauseJoggingRequestMessageTypeEnum = typeof PauseJoggingRequestMessageTypeEnum[keyof typeof PauseJoggingRequestMessageTypeEnum];
2905
+
2906
+ /**
2907
+ * Acknowledgment to a PauseJoggingRequest.
2908
+ * @export
2909
+ * @interface PauseJoggingResponse
2910
+ */
2911
+ export interface PauseJoggingResponse {
2912
+ /**
2913
+ * Error message in case of invalid PauseJoggingRequest.
2914
+ * @type {string}
2915
+ * @memberof PauseJoggingResponse
2916
+ */
2917
+ 'message'?: string;
2918
+ /**
2919
+ *
2920
+ * @type {string}
2921
+ * @memberof PauseJoggingResponse
2922
+ */
2923
+ 'kind': PauseJoggingResponseKindEnum;
2924
+ }
2925
+
2926
+ export const PauseJoggingResponseKindEnum = {
2927
+ PauseReceived: 'PAUSE_RECEIVED'
2928
+ } as const;
2929
+
2930
+ export type PauseJoggingResponseKindEnum = typeof PauseJoggingResponseKindEnum[keyof typeof PauseJoggingResponseKindEnum];
2931
+
3092
2932
  /**
3093
2933
  * Request to pause the movement execution. Movement pauses as soon as a [Standstill](Standstill.yaml) is sent back to the client. Resume movement with StartMovementRequest.
3094
2934
  * @export
@@ -3101,12 +2941,6 @@ export interface PauseMovementRequest {
3101
2941
  * @memberof PauseMovementRequest
3102
2942
  */
3103
2943
  'message_type'?: PauseMovementRequestMessageTypeEnum;
3104
- /**
3105
- * Defaults to `true`. Set to true to get a response signalling successful initiation to pause the movement.
3106
- * @type {boolean}
3107
- * @memberof PauseMovementRequest
3108
- */
3109
- 'send_response'?: boolean;
3110
2944
  }
3111
2945
 
3112
2946
  export const PauseMovementRequestMessageTypeEnum = {
@@ -3116,37 +2950,31 @@ export const PauseMovementRequestMessageTypeEnum = {
3116
2950
  export type PauseMovementRequestMessageTypeEnum = typeof PauseMovementRequestMessageTypeEnum[keyof typeof PauseMovementRequestMessageTypeEnum];
3117
2951
 
3118
2952
  /**
3119
- * Response 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).
2953
+ * 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).
3120
2954
  * @export
3121
2955
  * @interface PauseMovementResponse
3122
2956
  */
3123
2957
  export interface PauseMovementResponse {
3124
2958
  /**
3125
- *
3126
- * @type {PauseMovementResponsePauseResponse}
2959
+ * Error message in case of invalid PauseMovementResquest.
2960
+ * @type {string}
3127
2961
  * @memberof PauseMovementResponse
3128
2962
  */
3129
- 'pause_response': PauseMovementResponsePauseResponse;
3130
- }
3131
- /**
3132
- *
3133
- * @export
3134
- * @interface PauseMovementResponsePauseResponse
3135
- */
3136
- export interface PauseMovementResponsePauseResponse {
3137
- /**
3138
- * Indicates if PauseMovementRequest can be executed.
3139
- * @type {boolean}
3140
- * @memberof PauseMovementResponsePauseResponse
3141
- */
3142
- 'succeeded': boolean;
2963
+ 'message'?: string;
3143
2964
  /**
3144
- * Error message in case of invalid PauseMovementRequest or failure while claiming motion.
2965
+ *
3145
2966
  * @type {string}
3146
- * @memberof PauseMovementResponsePauseResponse
2967
+ * @memberof PauseMovementResponse
3147
2968
  */
3148
- 'error_message'?: string;
2969
+ 'kind': PauseMovementResponseKindEnum;
3149
2970
  }
2971
+
2972
+ export const PauseMovementResponseKindEnum = {
2973
+ PauseReceived: 'PAUSE_RECEIVED'
2974
+ } as const;
2975
+
2976
+ export type PauseMovementResponseKindEnum = typeof PauseMovementResponseKindEnum[keyof typeof PauseMovementResponseKindEnum];
2977
+
3150
2978
  /**
3151
2979
  * Defines an input/output that the motion will be paused for. The motion will stop gracefully on path.
3152
2980
  * @export
@@ -3168,6 +2996,118 @@ export interface PauseOnIO {
3168
2996
  }
3169
2997
 
3170
2998
 
2999
+ /**
3000
+ *
3001
+ * @export
3002
+ * @interface PausedByRequest
3003
+ */
3004
+ export interface PausedByRequest {
3005
+ /**
3006
+ *
3007
+ * @type {string}
3008
+ * @memberof PausedByRequest
3009
+ */
3010
+ 'kind': PausedByRequestKindEnum;
3011
+ }
3012
+
3013
+ export const PausedByRequestKindEnum = {
3014
+ PausedByUser: 'PAUSED_BY_USER'
3015
+ } as const;
3016
+
3017
+ export type PausedByRequestKindEnum = typeof PausedByRequestKindEnum[keyof typeof PausedByRequestKindEnum];
3018
+
3019
+ /**
3020
+ *
3021
+ * @export
3022
+ * @interface PausedByUser
3023
+ */
3024
+ export interface PausedByUser {
3025
+ /**
3026
+ *
3027
+ * @type {string}
3028
+ * @memberof PausedByUser
3029
+ */
3030
+ 'kind': PausedByUserKindEnum;
3031
+ }
3032
+
3033
+ export const PausedByUserKindEnum = {
3034
+ PausedByUser: 'PAUSED_BY_USER'
3035
+ } as const;
3036
+
3037
+ export type PausedByUserKindEnum = typeof PausedByUserKindEnum[keyof typeof PausedByUserKindEnum];
3038
+
3039
+ /**
3040
+ *
3041
+ * @export
3042
+ * @interface PausedNearCollision
3043
+ */
3044
+ export interface PausedNearCollision {
3045
+ /**
3046
+ *
3047
+ * @type {string}
3048
+ * @memberof PausedNearCollision
3049
+ */
3050
+ 'kind': PausedNearCollisionKindEnum;
3051
+ /**
3052
+ *
3053
+ * @type {string}
3054
+ * @memberof PausedNearCollision
3055
+ */
3056
+ 'description': string;
3057
+ }
3058
+
3059
+ export const PausedNearCollisionKindEnum = {
3060
+ PausedNearCollision: 'PAUSED_NEAR_COLLISION'
3061
+ } as const;
3062
+
3063
+ export type PausedNearCollisionKindEnum = typeof PausedNearCollisionKindEnum[keyof typeof PausedNearCollisionKindEnum];
3064
+
3065
+ /**
3066
+ *
3067
+ * @export
3068
+ * @interface PausedNearJointLimit
3069
+ */
3070
+ export interface PausedNearJointLimit {
3071
+ /**
3072
+ *
3073
+ * @type {string}
3074
+ * @memberof PausedNearJointLimit
3075
+ */
3076
+ 'kind': PausedNearJointLimitKindEnum;
3077
+ /**
3078
+ *
3079
+ * @type {Array<number>}
3080
+ * @memberof PausedNearJointLimit
3081
+ */
3082
+ 'joint_indices': Array<number>;
3083
+ }
3084
+
3085
+ export const PausedNearJointLimitKindEnum = {
3086
+ PausedNearJointLimit: 'PAUSED_NEAR_JOINT_LIMIT'
3087
+ } as const;
3088
+
3089
+ export type PausedNearJointLimitKindEnum = typeof PausedNearJointLimitKindEnum[keyof typeof PausedNearJointLimitKindEnum];
3090
+
3091
+ /**
3092
+ *
3093
+ * @export
3094
+ * @interface PausedOnIO
3095
+ */
3096
+ export interface PausedOnIO {
3097
+ /**
3098
+ *
3099
+ * @type {string}
3100
+ * @memberof PausedOnIO
3101
+ */
3102
+ 'kind': PausedOnIOKindEnum;
3103
+ }
3104
+
3105
+ export const PausedOnIOKindEnum = {
3106
+ PausedOnIo: 'PAUSED_ON_IO'
3107
+ } as const;
3108
+
3109
+ export type PausedOnIOKindEnum = typeof PausedOnIOKindEnum[keyof typeof PausedOnIOKindEnum];
3110
+
3171
3111
  /**
3172
3112
  *
3173
3113
  * @export
@@ -3419,31 +3359,31 @@ export const PlaybackSpeedRequestMessageTypeEnum = {
3419
3359
  export type PlaybackSpeedRequestMessageTypeEnum = typeof PlaybackSpeedRequestMessageTypeEnum[keyof typeof PlaybackSpeedRequestMessageTypeEnum];
3420
3360
 
3421
3361
  /**
3422
- *
3362
+ * Acknowledgment for PlaybackSpeedRequest message.
3423
3363
  * @export
3424
3364
  * @interface PlaybackSpeedResponse
3425
3365
  */
3426
3366
  export interface PlaybackSpeedResponse {
3427
3367
  /**
3428
- *
3429
- * @type {PlaybackSpeedResponsePlaybackSpeedResponse}
3368
+ * Error message in case of invalid PlaybackSpeedRequest.
3369
+ * @type {string}
3430
3370
  * @memberof PlaybackSpeedResponse
3431
3371
  */
3432
- 'playback_speed_response': PlaybackSpeedResponsePlaybackSpeedResponse;
3433
- }
3434
- /**
3435
- *
3436
- * @export
3437
- * @interface PlaybackSpeedResponsePlaybackSpeedResponse
3438
- */
3439
- export interface PlaybackSpeedResponsePlaybackSpeedResponse {
3372
+ 'message'?: string;
3440
3373
  /**
3441
- * Value of the requested playback speed in percent [%].
3442
- * @type {number}
3443
- * @memberof PlaybackSpeedResponsePlaybackSpeedResponse
3374
+ *
3375
+ * @type {string}
3376
+ * @memberof PlaybackSpeedResponse
3444
3377
  */
3445
- 'requested_value': number;
3378
+ 'kind': PlaybackSpeedResponseKindEnum;
3446
3379
  }
3380
+
3381
+ export const PlaybackSpeedResponseKindEnum = {
3382
+ PlaybackSpeedReceived: 'PLAYBACK_SPEED_RECEIVED'
3383
+ } as const;
3384
+
3385
+ export type PlaybackSpeedResponseKindEnum = typeof PlaybackSpeedResponseKindEnum[keyof typeof PlaybackSpeedResponseKindEnum];
3386
+
3447
3387
  /**
3448
3388
  * Defines a pose in 3D space. A pose is a combination of a position and an orientation. The position is applied before the orientation.
3449
3389
  * @export
@@ -3931,6 +3871,52 @@ export interface RobotTcps {
3931
3871
  */
3932
3872
  'tcps': Array<RobotTcp>;
3933
3873
  }
3874
+ /**
3875
+ *
3876
+ * @export
3877
+ * @interface Running
3878
+ */
3879
+ export interface Running {
3880
+ /**
3881
+ *
3882
+ * @type {string}
3883
+ * @memberof Running
3884
+ */
3885
+ 'kind': RunningKindEnum;
3886
+ }
3887
+
3888
+ export const RunningKindEnum = {
3889
+ Running: 'RUNNING'
3890
+ } as const;
3891
+
3892
+ export type RunningKindEnum = typeof RunningKindEnum[keyof typeof RunningKindEnum];
3893
+
3894
+ /**
3895
+ *
3896
+ * @export
3897
+ * @interface Running1
3898
+ */
3899
+ export interface Running1 {
3900
+ /**
3901
+ *
3902
+ * @type {string}
3903
+ * @memberof Running1
3904
+ */
3905
+ 'kind': Running1KindEnum;
3906
+ /**
3907
+ * Remaining time in milliseconds (ms) to reach the end of the motion.
3908
+ * @type {number}
3909
+ * @memberof Running1
3910
+ */
3911
+ 'time_to_end': number;
3912
+ }
3913
+
3914
+ export const Running1KindEnum = {
3915
+ Running: 'RUNNING'
3916
+ } as const;
3917
+
3918
+ export type Running1KindEnum = typeof Running1KindEnum[keyof typeof Running1KindEnum];
3919
+
3934
3920
  /**
3935
3921
  * Current safety state of the configured robot controller. Operation modes in which the attached motion groups can be moved are: - SAFETY_STATE_NORMAL - SAFETY_STATE_REDUCED All other modes are considered as non-operational.
3936
3922
  * @export
@@ -4177,62 +4163,6 @@ export const SphereShapeTypeEnum = {
4177
4163
 
4178
4164
  export type SphereShapeTypeEnum = typeof SphereShapeTypeEnum[keyof typeof SphereShapeTypeEnum];
4179
4165
 
4180
- /**
4181
- * The response will be sent one time at the end of every execution signalling that the motion group has stopped moving.
4182
- * @export
4183
- * @interface Standstill
4184
- */
4185
- export interface Standstill {
4186
- /**
4187
- *
4188
- * @type {StandstillStandstill}
4189
- * @memberof Standstill
4190
- */
4191
- 'standstill': StandstillStandstill;
4192
- }
4193
- /**
4194
- * The reason why the movement is paused.
4195
- * @export
4196
- * @enum {string}
4197
- */
4198
-
4199
- export const StandstillReason = {
4200
- ReasonMotionEnded: 'REASON_MOTION_ENDED',
4201
- ReasonUserPausedMotion: 'REASON_USER_PAUSED_MOTION',
4202
- ReasonWaitingForIo: 'REASON_WAITING_FOR_IO',
4203
- ReasonPausedOnIo: 'REASON_PAUSED_ON_IO'
4204
- } as const;
4205
-
4206
- export type StandstillReason = typeof StandstillReason[keyof typeof StandstillReason];
4207
-
4208
-
4209
- /**
4210
- *
4211
- * @export
4212
- * @interface StandstillStandstill
4213
- */
4214
- export interface StandstillStandstill {
4215
- /**
4216
- *
4217
- * @type {StandstillReason}
4218
- * @memberof StandstillStandstill
4219
- */
4220
- 'reason': StandstillReason;
4221
- /**
4222
- *
4223
- * @type {number}
4224
- * @memberof StandstillStandstill
4225
- */
4226
- 'location': number;
4227
- /**
4228
- * Current state of the controller and motion group which came to a standstill.
4229
- * @type {RobotControllerState}
4230
- * @memberof StandstillStandstill
4231
- */
4232
- 'state': RobotControllerState;
4233
- }
4234
-
4235
-
4236
4166
  /**
4237
4167
  * 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.
4238
4168
  * @export
@@ -4277,6 +4207,32 @@ export const StartMovementRequestMessageTypeEnum = {
4277
4207
 
4278
4208
  export type StartMovementRequestMessageTypeEnum = typeof StartMovementRequestMessageTypeEnum[keyof typeof StartMovementRequestMessageTypeEnum];
4279
4209
 
4210
+ /**
4211
+ * 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.
4212
+ * @export
4213
+ * @interface StartMovementResponse
4214
+ */
4215
+ export interface StartMovementResponse {
4216
+ /**
4217
+ * Error message in case of invalid StartMovementResquest.
4218
+ * @type {string}
4219
+ * @memberof StartMovementResponse
4220
+ */
4221
+ 'message'?: string;
4222
+ /**
4223
+ *
4224
+ * @type {string}
4225
+ * @memberof StartMovementResponse
4226
+ */
4227
+ 'kind': StartMovementResponseKindEnum;
4228
+ }
4229
+
4230
+ export const StartMovementResponseKindEnum = {
4231
+ StartReceived: 'START_RECEIVED'
4232
+ } as const;
4233
+
4234
+ export type StartMovementResponseKindEnum = typeof StartMovementResponseKindEnum[keyof typeof StartMovementResponseKindEnum];
4235
+
4280
4236
  /**
4281
4237
  * Defines an input/output that the motion should wait for to start the execution.
4282
4238
  * @export
@@ -4393,6 +4349,32 @@ export const TcpVelocityRequestMessageTypeEnum = {
4393
4349
 
4394
4350
  export type TcpVelocityRequestMessageTypeEnum = typeof TcpVelocityRequestMessageTypeEnum[keyof typeof TcpVelocityRequestMessageTypeEnum];
4395
4351
 
4352
+ /**
4353
+ * Acknowledgment to a TcpVelocityRequest.
4354
+ * @export
4355
+ * @interface TcpVelocityResponse
4356
+ */
4357
+ export interface TcpVelocityResponse {
4358
+ /**
4359
+ * Error message in case of invalid TcpVelocityRequest.
4360
+ * @type {string}
4361
+ * @memberof TcpVelocityResponse
4362
+ */
4363
+ 'message'?: string;
4364
+ /**
4365
+ *
4366
+ * @type {string}
4367
+ * @memberof TcpVelocityResponse
4368
+ */
4369
+ 'kind': TcpVelocityResponseKindEnum;
4370
+ }
4371
+
4372
+ export const TcpVelocityResponseKindEnum = {
4373
+ TcpVelocityReceived: 'TCP_VELOCITY_RECEIVED'
4374
+ } as const;
4375
+
4376
+ export type TcpVelocityResponseKindEnum = typeof TcpVelocityResponseKindEnum[keyof typeof TcpVelocityResponseKindEnum];
4377
+
4396
4378
  /**
4397
4379
  *
4398
4380
  * @export
@@ -4463,6 +4445,50 @@ export const TrajectoryDataMessageTypeEnum = {
4463
4445
 
4464
4446
  export type TrajectoryDataMessageTypeEnum = typeof TrajectoryDataMessageTypeEnum[keyof typeof TrajectoryDataMessageTypeEnum];
4465
4447
 
4448
+ /**
4449
+ * State of trajectory execution. This state is sent during trajectory movement, response-rate closest to the nearest multiple of controller step-rate but not exceeding the configured rate. The trajectory state can be one of the following: - RUNNING: Trajectory is being executed. - PAUSED_BY_USER: User has paused execution. - END_OF_TRAJECTORY: First or last sample (depending on direction) of trajectory has been sent. - WAIT_FOR_IO: Waiting for an I/O event to start execution. - PAUSED_ON_IO: Execution was paused because of an I/O event.
4450
+ * @export
4451
+ * @interface TrajectoryDetails
4452
+ */
4453
+ export interface TrajectoryDetails {
4454
+ /**
4455
+ * Unique identifier of the trajectory being executed.
4456
+ * @type {string}
4457
+ * @memberof TrajectoryDetails
4458
+ */
4459
+ 'trajectory': string;
4460
+ /**
4461
+ * Current location of motion group on the trajectory.
4462
+ * @type {number}
4463
+ * @memberof TrajectoryDetails
4464
+ */
4465
+ 'location': number;
4466
+ /**
4467
+ *
4468
+ * @type {TrajectoryDetailsState}
4469
+ * @memberof TrajectoryDetails
4470
+ */
4471
+ 'state': TrajectoryDetailsState;
4472
+ /**
4473
+ * Discriminator for OpenApi generators, which is always \"TRAJECTORY\" for this schema.
4474
+ * @type {string}
4475
+ * @memberof TrajectoryDetails
4476
+ */
4477
+ 'kind': TrajectoryDetailsKindEnum;
4478
+ }
4479
+
4480
+ export const TrajectoryDetailsKindEnum = {
4481
+ Trajectory: 'TRAJECTORY'
4482
+ } as const;
4483
+
4484
+ export type TrajectoryDetailsKindEnum = typeof TrajectoryDetailsKindEnum[keyof typeof TrajectoryDetailsKindEnum];
4485
+
4486
+ /**
4487
+ * @type TrajectoryDetailsState
4488
+ * @export
4489
+ */
4490
+ export type TrajectoryDetailsState = EndOfTrajectory | PausedByRequest | PausedOnIO | Running1 | WaitForIO;
4491
+
4466
4492
  /**
4467
4493
  *
4468
4494
  * @export
@@ -4474,7 +4500,7 @@ export interface TrajectoryId {
4474
4500
  * @type {string}
4475
4501
  * @memberof TrajectoryId
4476
4502
  */
4477
- 'message_type': TrajectoryIdMessageTypeEnum;
4503
+ 'message_type'?: TrajectoryIdMessageTypeEnum;
4478
4504
  /**
4479
4505
  * The identifier of the trajectory which was returned by the [addTrajectory](addTrajectory) endpoint.
4480
4506
  * @type {string}
@@ -4790,6 +4816,26 @@ export interface VirtualRobotConfiguration {
4790
4816
  */
4791
4817
  'content': string;
4792
4818
  }
4819
+ /**
4820
+ *
4821
+ * @export
4822
+ * @interface WaitForIO
4823
+ */
4824
+ export interface WaitForIO {
4825
+ /**
4826
+ *
4827
+ * @type {string}
4828
+ * @memberof WaitForIO
4829
+ */
4830
+ 'kind': WaitForIOKindEnum;
4831
+ }
4832
+
4833
+ export const WaitForIOKindEnum = {
4834
+ WaitForIo: 'WAIT_FOR_IO'
4835
+ } as const;
4836
+
4837
+ export type WaitForIOKindEnum = typeof WaitForIOKindEnum[keyof typeof WaitForIOKindEnum];
4838
+
4793
4839
  /**
4794
4840
  * The value to compare with the current value of the input/output.
4795
4841
  * @export
@@ -8915,7 +8961,7 @@ export const MotionGroupApiFp = function(configuration?: Configuration) {
8915
8961
  * @param {*} [options] Override http request option.
8916
8962
  * @throws {RequiredError}
8917
8963
  */
8918
- async streamMotionGroupState(cell: string, motionGroup: string, responseRate?: number, responseCoordinateSystem?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<MotionGroupStateWithoutPayload>> {
8964
+ async streamMotionGroupState(cell: string, motionGroup: string, responseRate?: number, responseCoordinateSystem?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<MotionGroupState>> {
8919
8965
  const localVarAxiosArgs = await localVarAxiosParamCreator.streamMotionGroupState(cell, motionGroup, responseRate, responseCoordinateSystem, options);
8920
8966
  const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
8921
8967
  const localVarOperationServerBasePath = operationServerMap['MotionGroupApi.streamMotionGroupState']?.[localVarOperationServerIndex]?.url;
@@ -8964,7 +9010,7 @@ export const MotionGroupApiFactory = function (configuration?: Configuration, ba
8964
9010
  * @param {*} [options] Override http request option.
8965
9011
  * @throws {RequiredError}
8966
9012
  */
8967
- streamMotionGroupState(cell: string, motionGroup: string, responseRate?: number, responseCoordinateSystem?: string, options?: RawAxiosRequestConfig): AxiosPromise<MotionGroupStateWithoutPayload> {
9013
+ streamMotionGroupState(cell: string, motionGroup: string, responseRate?: number, responseCoordinateSystem?: string, options?: RawAxiosRequestConfig): AxiosPromise<MotionGroupState> {
8968
9014
  return localVarFp.streamMotionGroupState(cell, motionGroup, responseRate, responseCoordinateSystem, options).then((request) => request(axios, basePath));
8969
9015
  },
8970
9016
  };