@wandelbots/nova-api 25.6.0-dev.35 → 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
@@ -959,6 +959,26 @@ export const Direction = {
959
959
  export type Direction = typeof Direction[keyof typeof Direction];
960
960
 
961
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
+
962
982
  /**
963
983
  *
964
984
  * @export
@@ -972,17 +992,42 @@ export interface Error2 {
972
992
  */
973
993
  'message': string;
974
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
+
975
1020
  /**
976
1021
  * @type ExecuteJoggingRequest
977
1022
  * @export
978
1023
  */
979
- export type ExecuteJoggingRequest = InitializeJoggingRequest | JointVelocityRequest | TcpVelocityRequest;
1024
+ export type ExecuteJoggingRequest = InitializeJoggingRequest | JointVelocityRequest | PauseJoggingRequest | TcpVelocityRequest;
980
1025
 
981
1026
  /**
982
1027
  * @type ExecuteJoggingResponse
983
1028
  * @export
984
1029
  */
985
- export type ExecuteJoggingResponse = InitializeJoggingResponse | JoggingErrorResponse | JoggingResponse;
1030
+ export type ExecuteJoggingResponse = InitializeJoggingResponse | JointVelocityResponse | MovementErrorResponse | PauseJoggingResponse | TcpVelocityResponse;
986
1031
 
987
1032
  /**
988
1033
  * @type ExecuteTrajectoryRequest
@@ -994,7 +1039,7 @@ export type ExecuteTrajectoryRequest = InitializeMovementRequest | PauseMovement
994
1039
  * @type ExecuteTrajectoryResponse
995
1040
  * @export
996
1041
  */
997
- export type ExecuteTrajectoryResponse = InitializeMovementResponse | Movement | MovementError | PauseMovementResponse | PlaybackSpeedResponse | Standstill;
1042
+ export type ExecuteTrajectoryResponse = InitializeMovementResponse | MovementErrorResponse | PauseMovementResponse | PlaybackSpeedResponse | StartMovementResponse;
998
1043
 
999
1044
  /**
1000
1045
  * A datapoint inside external joint stream.
@@ -1613,37 +1658,31 @@ export const InitializeJoggingRequestMessageTypeEnum = {
1613
1658
  export type InitializeJoggingRequestMessageTypeEnum = typeof InitializeJoggingRequestMessageTypeEnum[keyof typeof InitializeJoggingRequestMessageTypeEnum];
1614
1659
 
1615
1660
  /**
1616
- * Response to an InitializeJoggingRequest.
1661
+ * Acknowledgment to an InitializeJoggingRequest.
1617
1662
  * @export
1618
1663
  * @interface InitializeJoggingResponse
1619
1664
  */
1620
1665
  export interface InitializeJoggingResponse {
1621
1666
  /**
1622
- *
1623
- * @type {InitializeJoggingResponseInitResponse}
1667
+ * Error message in case of invalid InitializeJoggingRequest.
1668
+ * @type {string}
1624
1669
  * @memberof InitializeJoggingResponse
1625
1670
  */
1626
- 'init_response': InitializeJoggingResponseInitResponse;
1627
- }
1628
- /**
1629
- *
1630
- * @export
1631
- * @interface InitializeJoggingResponseInitResponse
1632
- */
1633
- export interface InitializeJoggingResponseInitResponse {
1634
- /**
1635
- * Indicates if the jogging control is ready for execution.
1636
- * @type {boolean}
1637
- * @memberof InitializeJoggingResponseInitResponse
1638
- */
1639
- 'succeeded': boolean;
1671
+ 'message'?: string;
1640
1672
  /**
1641
- * Error message in case of invalid InitializeMovementRequest.
1673
+ *
1642
1674
  * @type {string}
1643
- * @memberof InitializeJoggingResponseInitResponse
1675
+ * @memberof InitializeJoggingResponse
1644
1676
  */
1645
- 'error_message'?: string;
1677
+ 'kind': InitializeJoggingResponseKindEnum;
1646
1678
  }
1679
+
1680
+ export const InitializeJoggingResponseKindEnum = {
1681
+ InitializeReceived: 'INITIALIZE_RECEIVED'
1682
+ } as const;
1683
+
1684
+ export type InitializeJoggingResponseKindEnum = typeof InitializeJoggingResponseKindEnum[keyof typeof InitializeJoggingResponseKindEnum];
1685
+
1647
1686
  /**
1648
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.
1649
1688
  * @export
@@ -1702,31 +1741,31 @@ export type InitializeMovementRequestTrajectory = { message_type: 'TrajectoryDat
1702
1741
  */
1703
1742
  export interface InitializeMovementResponse {
1704
1743
  /**
1705
- *
1706
- * @type {InitializeMovementResponseInitResponse}
1744
+ * Error message in case of invalid InitializeMovementRequest.
1745
+ * @type {string}
1707
1746
  * @memberof InitializeMovementResponse
1708
1747
  */
1709
- 'init_response': InitializeMovementResponseInitResponse;
1710
- }
1711
- /**
1712
- *
1713
- * @export
1714
- * @interface InitializeMovementResponseInitResponse
1715
- */
1716
- export interface InitializeMovementResponseInitResponse {
1748
+ 'message'?: string;
1717
1749
  /**
1718
- * Indicates if the trajectory was successfully locked and is ready for execution by sending a StartMovementRequest. Send PlaybackSpeedRequest to override the planned velocity.
1719
- * @type {boolean}
1720
- * @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
1721
1753
  */
1722
- 'succeeded': boolean;
1754
+ 'add_trajectory_error'?: AddTrajectoryError;
1723
1755
  /**
1724
- * Error message in case of invalid InitializeMovementRequest.
1756
+ *
1725
1757
  * @type {string}
1726
- * @memberof InitializeMovementResponseInitResponse
1758
+ * @memberof InitializeMovementResponse
1727
1759
  */
1728
- 'error_message'?: string;
1760
+ 'kind': InitializeMovementResponseKindEnum;
1729
1761
  }
1762
+
1763
+ export const InitializeMovementResponseKindEnum = {
1764
+ InitializeReceived: 'INITIALIZE_RECEIVED'
1765
+ } as const;
1766
+
1767
+ export type InitializeMovementResponseKindEnum = typeof InitializeMovementResponseKindEnum[keyof typeof InitializeMovementResponseKindEnum];
1768
+
1730
1769
  /**
1731
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.
1732
1771
  * @export
@@ -1842,159 +1881,36 @@ export interface InverseKinematicsResponse {
1842
1881
  'joints': Array<Array<Array<number>>>;
1843
1882
  }
1844
1883
  /**
1845
- * Response signalling an error during jogging execution. This response is sent in case of an unexpected error, e.g. controller disconnects.
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.
1846
1885
  * @export
1847
- * @interface JoggingErrorResponse
1886
+ * @interface JoggingDetails
1848
1887
  */
1849
- export interface JoggingErrorResponse {
1888
+ export interface JoggingDetails {
1850
1889
  /**
1851
1890
  *
1852
- * @type {JoggingErrorResponseError}
1853
- * @memberof JoggingErrorResponse
1891
+ * @type {JoggingDetailsState}
1892
+ * @memberof JoggingDetails
1854
1893
  */
1855
- 'error': JoggingErrorResponseError;
1856
- }
1857
- /**
1858
- *
1859
- * @export
1860
- * @interface JoggingErrorResponseError
1861
- */
1862
- export interface JoggingErrorResponseError {
1863
- /**
1864
- * Error description.
1865
- * @type {string}
1866
- * @memberof JoggingErrorResponseError
1867
- */
1868
- 'error_message': string;
1869
- }
1870
- /**
1871
- *
1872
- * @export
1873
- * @interface JoggingPausedCollision
1874
- */
1875
- export interface JoggingPausedCollision {
1876
- /**
1877
- *
1878
- * @type {JoggingPausedCollisionPausedNearCollision}
1879
- * @memberof JoggingPausedCollision
1880
- */
1881
- 'paused_near_collision': JoggingPausedCollisionPausedNearCollision;
1882
- }
1883
- /**
1884
- *
1885
- * @export
1886
- * @interface JoggingPausedCollisionPausedNearCollision
1887
- */
1888
- export interface JoggingPausedCollisionPausedNearCollision {
1894
+ 'state': JoggingDetailsState;
1889
1895
  /**
1890
1896
  *
1891
1897
  * @type {string}
1892
- * @memberof JoggingPausedCollisionPausedNearCollision
1893
- */
1894
- 'description'?: string;
1895
- }
1896
- /**
1897
- *
1898
- * @export
1899
- * @interface JoggingPausedJointLimit
1900
- */
1901
- export interface JoggingPausedJointLimit {
1902
- /**
1903
- *
1904
- * @type {JoggingPausedJointLimitPausedNearJointLimit}
1905
- * @memberof JoggingPausedJointLimit
1906
- */
1907
- 'paused_near_joint_limit': JoggingPausedJointLimitPausedNearJointLimit;
1908
- }
1909
- /**
1910
- *
1911
- * @export
1912
- * @interface JoggingPausedJointLimitPausedNearJointLimit
1913
- */
1914
- export interface JoggingPausedJointLimitPausedNearJointLimit {
1915
- /**
1916
- *
1917
- * @type {Array<number>}
1918
- * @memberof JoggingPausedJointLimitPausedNearJointLimit
1919
- */
1920
- 'joint_indices'?: Array<number>;
1921
- }
1922
- /**
1923
- *
1924
- * @export
1925
- * @interface JoggingPausedOnIO
1926
- */
1927
- export interface JoggingPausedOnIO {
1928
- /**
1929
- *
1930
- * @type {object}
1931
- * @memberof JoggingPausedOnIO
1898
+ * @memberof JoggingDetails
1932
1899
  */
1933
- 'paused_on_io': object;
1934
- }
1935
- /**
1936
- *
1937
- * @export
1938
- * @interface JoggingPausedUserRequest
1939
- */
1940
- export interface JoggingPausedUserRequest {
1941
- /**
1942
- *
1943
- * @type {object}
1944
- * @memberof JoggingPausedUserRequest
1945
- */
1946
- 'paused_by_user_request': object;
1947
- }
1948
- /**
1949
- * Sent during jogging movement, response-rate closest to the nearest multiple of controller step-rate but not exceeding the configured rate.
1950
- * @export
1951
- * @interface JoggingResponse
1952
- */
1953
- export interface JoggingResponse {
1954
- /**
1955
- *
1956
- * @type {JoggingResponseJogging}
1957
- * @memberof JoggingResponse
1958
- */
1959
- 'jogging': JoggingResponseJogging;
1960
- }
1961
- /**
1962
- *
1963
- * @export
1964
- * @interface JoggingResponseJogging
1965
- */
1966
- export interface JoggingResponseJogging {
1967
- /**
1968
- *
1969
- * @type {JoggingState}
1970
- * @memberof JoggingResponseJogging
1971
- */
1972
- 'jogging_state': JoggingState;
1973
- /**
1974
- *
1975
- * @type {RobotControllerState}
1976
- * @memberof JoggingResponseJogging
1977
- */
1978
- 'robot_controller_state': RobotControllerState;
1979
- }
1980
- /**
1981
- *
1982
- * @export
1983
- * @interface JoggingRunning
1984
- */
1985
- export interface JoggingRunning {
1986
- /**
1987
- *
1988
- * @type {object}
1989
- * @memberof JoggingRunning
1990
- */
1991
- 'running': object;
1900
+ 'kind': JoggingDetailsKindEnum;
1992
1901
  }
1902
+
1903
+ export const JoggingDetailsKindEnum = {
1904
+ Jogging: 'JOGGING'
1905
+ } as const;
1906
+
1907
+ export type JoggingDetailsKindEnum = typeof JoggingDetailsKindEnum[keyof typeof JoggingDetailsKindEnum];
1908
+
1993
1909
  /**
1994
- * @type JoggingState
1910
+ * @type JoggingDetailsState
1995
1911
  * @export
1996
1912
  */
1997
- export type JoggingState = JoggingPausedCollision | JoggingPausedJointLimit | JoggingPausedOnIO | JoggingPausedUserRequest | JoggingRunning;
1913
+ export type JoggingDetailsState = PausedByUser | PausedNearCollision | PausedNearJointLimit | PausedOnIO | Running;
1998
1914
 
1999
1915
  /**
2000
1916
  *
@@ -2060,6 +1976,32 @@ export const JointVelocityRequestMessageTypeEnum = {
2060
1976
 
2061
1977
  export type JointVelocityRequestMessageTypeEnum = typeof JointVelocityRequestMessageTypeEnum[keyof typeof JointVelocityRequestMessageTypeEnum];
2062
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
+
2063
2005
  /**
2064
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.
2065
2007
  * @export
@@ -2530,17 +2472,17 @@ export interface MotionGroupJoints {
2530
2472
  'torques'?: Array<number>;
2531
2473
  }
2532
2474
  /**
2533
- *
2475
+ * Presents the current state of the motion group.
2534
2476
  * @export
2535
2477
  * @interface MotionGroupState
2536
2478
  */
2537
2479
  export interface MotionGroupState {
2538
2480
  /**
2539
- * Timestamp indicating when the represented information was received from the robot controller.
2481
+ * Timestamp for when data was received from the robot controller.
2540
2482
  * @type {string}
2541
2483
  * @memberof MotionGroupState
2542
2484
  */
2543
- 'timestamp'?: string;
2485
+ 'timestamp': string;
2544
2486
  /**
2545
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.
2546
2488
  * @type {number}
@@ -2572,59 +2514,59 @@ export interface MotionGroupState {
2572
2514
  */
2573
2515
  'joint_limit_reached': MotionGroupStateJointLimitReached;
2574
2516
  /**
2575
- * Current joint velocity of each joint in [rad/s]
2576
- * @type {Joints}
2577
- * @memberof MotionGroupState
2578
- */
2579
- 'joint_velocity': Joints;
2580
- /**
2581
- * 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.
2582
2518
  * @type {Joints}
2583
2519
  * @memberof MotionGroupState
2584
2520
  */
2585
2521
  'joint_torque'?: Joints;
2586
2522
  /**
2587
- * 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.
2588
2524
  * @type {Joints}
2589
2525
  * @memberof MotionGroupState
2590
2526
  */
2591
2527
  'joint_current'?: Joints;
2592
2528
  /**
2593
- * 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.
2594
2530
  * @type {Pose}
2595
2531
  * @memberof MotionGroupState
2596
2532
  */
2597
2533
  'flange_pose'?: Pose;
2598
2534
  /**
2599
- * 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.
2600
2536
  * @type {string}
2601
2537
  * @memberof MotionGroupState
2602
2538
  */
2603
- 'tcp': string;
2539
+ 'tcp'?: string;
2604
2540
  /**
2605
- * 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.
2606
2542
  * @type {Pose}
2607
2543
  * @memberof MotionGroupState
2608
2544
  */
2609
- 'tcp_pose': Pose;
2545
+ 'tcp_pose'?: Pose;
2610
2546
  /**
2611
- * 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.
2612
- * @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}
2613
2549
  * @memberof MotionGroupState
2614
2550
  */
2615
- 'tcp_velocity': MotionVector;
2551
+ 'coordinate_system'?: string;
2616
2552
  /**
2617
- * 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.
2618
2554
  * @type {string}
2619
2555
  * @memberof MotionGroupState
2620
2556
  */
2621
- 'coordinate_system': string;
2557
+ 'payload'?: string;
2622
2558
  /**
2623
- * Unique identifier addressing the Payload currently set. Only fetchable via GET endpoint, not available in WebSocket.
2624
- * @type {string}
2559
+ * Indicates whether the motion group is in standstill. Convenience: Signals that NOVA treats measured joint velocities as 0.
2560
+ * @type {boolean}
2625
2561
  * @memberof MotionGroupState
2626
2562
  */
2627
- '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;
2628
2570
  }
2629
2571
  /**
2630
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.
@@ -2639,97 +2581,6 @@ export interface MotionGroupStateJointLimitReached {
2639
2581
  */
2640
2582
  'limit_reached': Array<boolean>;
2641
2583
  }
2642
- /**
2643
- * Presents the current state of the motion group.
2644
- * @export
2645
- * @interface MotionGroupStateWithoutPayload
2646
- */
2647
- export interface MotionGroupStateWithoutPayload {
2648
- /**
2649
- * Timestamp indicating when the represented information was received from the robot controller.
2650
- * @type {string}
2651
- * @memberof MotionGroupStateWithoutPayload
2652
- */
2653
- 'timestamp'?: string;
2654
- /**
2655
- * 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.
2656
- * @type {number}
2657
- * @memberof MotionGroupStateWithoutPayload
2658
- */
2659
- 'sequence_number': number;
2660
- /**
2661
- * Identifier of the motion group.
2662
- * @type {string}
2663
- * @memberof MotionGroupStateWithoutPayload
2664
- */
2665
- 'motion_group': string;
2666
- /**
2667
- * Convenience: Identifier of the robot controller the motion group is attached to.
2668
- * @type {string}
2669
- * @memberof MotionGroupStateWithoutPayload
2670
- */
2671
- 'controller': string;
2672
- /**
2673
- * Current joint position of each joint in [rad]
2674
- * @type {Joints}
2675
- * @memberof MotionGroupStateWithoutPayload
2676
- */
2677
- 'joint_position': Joints;
2678
- /**
2679
- * Indicates whether the joint is in a limit for all joints of the motion group.
2680
- * @type {MotionGroupStateJointLimitReached}
2681
- * @memberof MotionGroupStateWithoutPayload
2682
- */
2683
- 'joint_limit_reached': MotionGroupStateJointLimitReached;
2684
- /**
2685
- * Current joint velocity of each joint in [rad/s]
2686
- * @type {Joints}
2687
- * @memberof MotionGroupStateWithoutPayload
2688
- */
2689
- 'joint_velocity': Joints;
2690
- /**
2691
- * Current joint torque of each joint in [Nm]. Is only available if the robot controller supports it (e.g. available for UR Controllers).
2692
- * @type {Joints}
2693
- * @memberof MotionGroupStateWithoutPayload
2694
- */
2695
- 'joint_torque'?: Joints;
2696
- /**
2697
- * Current Current at TCP in [A]. Is only available if the robot controller supports it, e.g. available for UR Controllers.
2698
- * @type {Joints}
2699
- * @memberof MotionGroupStateWithoutPayload
2700
- */
2701
- 'joint_current'?: Joints;
2702
- /**
2703
- * 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.
2704
- * @type {Pose}
2705
- * @memberof MotionGroupStateWithoutPayload
2706
- */
2707
- 'flange_pose'?: Pose;
2708
- /**
2709
- * Unique identifier addressing the TCP currently set.
2710
- * @type {string}
2711
- * @memberof MotionGroupStateWithoutPayload
2712
- */
2713
- 'tcp': string;
2714
- /**
2715
- * 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.
2716
- * @type {Pose}
2717
- * @memberof MotionGroupStateWithoutPayload
2718
- */
2719
- 'tcp_pose': Pose;
2720
- /**
2721
- * 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.
2722
- * @type {MotionVector}
2723
- * @memberof MotionGroupStateWithoutPayload
2724
- */
2725
- 'tcp_velocity': MotionVector;
2726
- /**
2727
- * Unique identifier addressing the reference coordinate system of the cartesian data. Default is the world coordinate system of corresponding controller.
2728
- * @type {string}
2729
- * @memberof MotionGroupStateWithoutPayload
2730
- */
2731
- 'coordinate_system': string;
2732
- }
2733
2584
  /**
2734
2585
  * Collection of information on the current state of the robot.
2735
2586
  * @export
@@ -2756,94 +2607,31 @@ export interface MotionState {
2756
2607
  'state': RobotState;
2757
2608
  }
2758
2609
  /**
2759
- *
2610
+ * Error message in case an error occurs during movement execution.
2760
2611
  * @export
2761
- * @interface MotionVector
2612
+ * @interface MovementErrorResponse
2762
2613
  */
2763
- export interface MotionVector {
2614
+ export interface MovementErrorResponse {
2764
2615
  /**
2765
- * A three-dimensional vector [x, y, z] with double precision.
2766
- * @type {Array<number>}
2767
- * @memberof MotionVector
2768
- */
2769
- 'linear'?: Array<number>;
2770
- /**
2771
- * A three-dimensional vector [x, y, z] with double precision.
2772
- * @type {Array<number>}
2773
- * @memberof MotionVector
2774
- */
2775
- 'angular'?: Array<number>;
2776
- /**
2777
- * optional, unique name of base coordinate system, if empty world is used
2616
+ * Detailed error message describing the issue encountered during movement execution.
2778
2617
  * @type {string}
2779
- * @memberof MotionVector
2780
- */
2781
- 'coordinate_system'?: string;
2782
- }
2783
- /**
2784
- * Sent during trajectory movement, response-rate closest to the nearest multiple of controller step-rate but not exceeding the configured rate.
2785
- * @export
2786
- * @interface Movement
2787
- */
2788
- export interface Movement {
2789
- /**
2790
- *
2791
- * @type {MovementMovement}
2792
- * @memberof Movement
2618
+ * @memberof MovementErrorResponse
2793
2619
  */
2794
- 'movement': MovementMovement;
2795
- }
2796
- /**
2797
- * 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.
2798
- * @export
2799
- * @interface MovementError
2800
- */
2801
- export interface MovementError {
2620
+ 'message': string;
2802
2621
  /**
2803
2622
  *
2804
- * @type {MovementErrorError}
2805
- * @memberof MovementError
2806
- */
2807
- 'error': MovementErrorError;
2808
- }
2809
- /**
2810
- *
2811
- * @export
2812
- * @interface MovementErrorError
2813
- */
2814
- export interface MovementErrorError {
2815
- /**
2816
- * Human-readable error details that describes the error.
2817
2623
  * @type {string}
2818
- * @memberof MovementErrorError
2624
+ * @memberof MovementErrorResponse
2819
2625
  */
2820
- 'error_message': string;
2821
- }
2822
- /**
2823
- *
2824
- * @export
2825
- * @interface MovementMovement
2826
- */
2827
- export interface MovementMovement {
2828
- /**
2829
- * Remaining time in milliseconds (ms) to reach the end of the motion.
2830
- * @type {number}
2831
- * @memberof MovementMovement
2832
- */
2833
- 'time_to_end': number;
2834
- /**
2835
- * Current location of motion group on the trajectory.
2836
- * @type {number}
2837
- * @memberof MovementMovement
2838
- */
2839
- 'current_location': number;
2840
- /**
2841
- * Current state of the robot controller and moving motion group.
2842
- * @type {RobotControllerState}
2843
- * @memberof MovementMovement
2844
- */
2845
- 'state': RobotControllerState;
2626
+ 'kind': MovementErrorResponseKindEnum;
2846
2627
  }
2628
+
2629
+ export const MovementErrorResponseKindEnum = {
2630
+ Error: 'ERROR'
2631
+ } as const;
2632
+
2633
+ export type MovementErrorResponseKindEnum = typeof MovementErrorResponseKindEnum[keyof typeof MovementErrorResponseKindEnum];
2634
+
2847
2635
  /**
2848
2636
  *
2849
2637
  * @export
@@ -3028,151 +2816,297 @@ export interface PathCubicSpline {
3028
2816
  * @type {Array<CubicSplineParameter>}
3029
2817
  * @memberof PathCubicSpline
3030
2818
  */
3031
- 'parameters': Array<CubicSplineParameter>;
2819
+ 'parameters': Array<CubicSplineParameter>;
2820
+ /**
2821
+ *
2822
+ * @type {string}
2823
+ * @memberof PathCubicSpline
2824
+ */
2825
+ 'path_definition_name': PathCubicSplinePathDefinitionNameEnum;
2826
+ }
2827
+
2828
+ export const PathCubicSplinePathDefinitionNameEnum = {
2829
+ PathCubicSpline: 'PathCubicSpline'
2830
+ } as const;
2831
+
2832
+ export type PathCubicSplinePathDefinitionNameEnum = typeof PathCubicSplinePathDefinitionNameEnum[keyof typeof PathCubicSplinePathDefinitionNameEnum];
2833
+
2834
+ /**
2835
+ * A joint point-to-point represents a line in joint space. All joints will be moved synchronously.
2836
+ * @export
2837
+ * @interface PathJointPTP
2838
+ */
2839
+ export interface PathJointPTP {
2840
+ /**
2841
+ *
2842
+ * @type {Array<number>}
2843
+ * @memberof PathJointPTP
2844
+ */
2845
+ 'target_joint_position': Array<number>;
2846
+ /**
2847
+ *
2848
+ * @type {string}
2849
+ * @memberof PathJointPTP
2850
+ */
2851
+ 'path_definition_name': PathJointPTPPathDefinitionNameEnum;
2852
+ }
2853
+
2854
+ export const PathJointPTPPathDefinitionNameEnum = {
2855
+ PathJointPtp: 'PathJointPTP'
2856
+ } as const;
2857
+
2858
+ export type PathJointPTPPathDefinitionNameEnum = typeof PathJointPTPPathDefinitionNameEnum[keyof typeof PathJointPTPPathDefinitionNameEnum];
2859
+
2860
+ /**
2861
+ * A line represents a straight line from start position to indicated target position. The orientation is calculated via a quaternion [slerp](https://en.wikipedia.org/wiki/Slerp) from start orientation to indicated target orientation.
2862
+ * @export
2863
+ * @interface PathLine
2864
+ */
2865
+ export interface PathLine {
2866
+ /**
2867
+ *
2868
+ * @type {Pose}
2869
+ * @memberof PathLine
2870
+ */
2871
+ 'target_pose': Pose;
2872
+ /**
2873
+ *
2874
+ * @type {string}
2875
+ * @memberof PathLine
2876
+ */
2877
+ 'path_definition_name': PathLinePathDefinitionNameEnum;
2878
+ }
2879
+
2880
+ export const PathLinePathDefinitionNameEnum = {
2881
+ PathLine: 'PathLine'
2882
+ } as const;
2883
+
2884
+ export type PathLinePathDefinitionNameEnum = typeof PathLinePathDefinitionNameEnum[keyof typeof PathLinePathDefinitionNameEnum];
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
+
2932
+ /**
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.
2934
+ * @export
2935
+ * @interface PauseMovementRequest
2936
+ */
2937
+ export interface PauseMovementRequest {
2938
+ /**
2939
+ * Type specifier for server, set automatically.
2940
+ * @type {string}
2941
+ * @memberof PauseMovementRequest
2942
+ */
2943
+ 'message_type'?: PauseMovementRequestMessageTypeEnum;
2944
+ }
2945
+
2946
+ export const PauseMovementRequestMessageTypeEnum = {
2947
+ PauseMovementRequest: 'PauseMovementRequest'
2948
+ } as const;
2949
+
2950
+ export type PauseMovementRequestMessageTypeEnum = typeof PauseMovementRequestMessageTypeEnum[keyof typeof PauseMovementRequestMessageTypeEnum];
2951
+
2952
+ /**
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).
2954
+ * @export
2955
+ * @interface PauseMovementResponse
2956
+ */
2957
+ export interface PauseMovementResponse {
2958
+ /**
2959
+ * Error message in case of invalid PauseMovementResquest.
2960
+ * @type {string}
2961
+ * @memberof PauseMovementResponse
2962
+ */
2963
+ 'message'?: string;
3032
2964
  /**
3033
2965
  *
3034
2966
  * @type {string}
3035
- * @memberof PathCubicSpline
2967
+ * @memberof PauseMovementResponse
3036
2968
  */
3037
- 'path_definition_name': PathCubicSplinePathDefinitionNameEnum;
2969
+ 'kind': PauseMovementResponseKindEnum;
3038
2970
  }
3039
2971
 
3040
- export const PathCubicSplinePathDefinitionNameEnum = {
3041
- PathCubicSpline: 'PathCubicSpline'
2972
+ export const PauseMovementResponseKindEnum = {
2973
+ PauseReceived: 'PAUSE_RECEIVED'
3042
2974
  } as const;
3043
2975
 
3044
- export type PathCubicSplinePathDefinitionNameEnum = typeof PathCubicSplinePathDefinitionNameEnum[keyof typeof PathCubicSplinePathDefinitionNameEnum];
2976
+ export type PauseMovementResponseKindEnum = typeof PauseMovementResponseKindEnum[keyof typeof PauseMovementResponseKindEnum];
3045
2977
 
3046
2978
  /**
3047
- * A joint point-to-point represents a line in joint space. All joints will be moved synchronously.
2979
+ * Defines an input/output that the motion will be paused for. The motion will stop gracefully on path.
3048
2980
  * @export
3049
- * @interface PathJointPTP
2981
+ * @interface PauseOnIO
3050
2982
  */
3051
- export interface PathJointPTP {
2983
+ export interface PauseOnIO {
3052
2984
  /**
3053
2985
  *
3054
- * @type {Array<number>}
3055
- * @memberof PathJointPTP
2986
+ * @type {IOValue}
2987
+ * @memberof PauseOnIO
3056
2988
  */
3057
- 'target_joint_position': Array<number>;
2989
+ 'io': IOValue;
3058
2990
  /**
3059
- *
3060
- * @type {string}
3061
- * @memberof PathJointPTP
2991
+ * Comparator for the comparison of two values. Use the measured I/O as the base value (a) and the expected input/output value as the comparator (b): e.g., a > b.
2992
+ * @type {Comparator}
2993
+ * @memberof PauseOnIO
3062
2994
  */
3063
- 'path_definition_name': PathJointPTPPathDefinitionNameEnum;
2995
+ 'comparator': Comparator;
3064
2996
  }
3065
2997
 
3066
- export const PathJointPTPPathDefinitionNameEnum = {
3067
- PathJointPtp: 'PathJointPTP'
3068
- } as const;
3069
-
3070
- export type PathJointPTPPathDefinitionNameEnum = typeof PathJointPTPPathDefinitionNameEnum[keyof typeof PathJointPTPPathDefinitionNameEnum];
3071
2998
 
3072
2999
  /**
3073
- * A line represents a straight line from start position to indicated target position. The orientation is calculated via a quaternion [slerp](https://en.wikipedia.org/wiki/Slerp) from start orientation to indicated target orientation.
3000
+ *
3074
3001
  * @export
3075
- * @interface PathLine
3002
+ * @interface PausedByRequest
3076
3003
  */
3077
- export interface PathLine {
3078
- /**
3079
- *
3080
- * @type {Pose}
3081
- * @memberof PathLine
3082
- */
3083
- 'target_pose': Pose;
3004
+ export interface PausedByRequest {
3084
3005
  /**
3085
3006
  *
3086
3007
  * @type {string}
3087
- * @memberof PathLine
3008
+ * @memberof PausedByRequest
3088
3009
  */
3089
- 'path_definition_name': PathLinePathDefinitionNameEnum;
3010
+ 'kind': PausedByRequestKindEnum;
3090
3011
  }
3091
3012
 
3092
- export const PathLinePathDefinitionNameEnum = {
3093
- PathLine: 'PathLine'
3013
+ export const PausedByRequestKindEnum = {
3014
+ PausedByUser: 'PAUSED_BY_USER'
3094
3015
  } as const;
3095
3016
 
3096
- export type PathLinePathDefinitionNameEnum = typeof PathLinePathDefinitionNameEnum[keyof typeof PathLinePathDefinitionNameEnum];
3017
+ export type PausedByRequestKindEnum = typeof PausedByRequestKindEnum[keyof typeof PausedByRequestKindEnum];
3097
3018
 
3098
3019
  /**
3099
- * 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.
3020
+ *
3100
3021
  * @export
3101
- * @interface PauseMovementRequest
3022
+ * @interface PausedByUser
3102
3023
  */
3103
- export interface PauseMovementRequest {
3024
+ export interface PausedByUser {
3104
3025
  /**
3105
- * Type specifier for server, set automatically.
3026
+ *
3106
3027
  * @type {string}
3107
- * @memberof PauseMovementRequest
3108
- */
3109
- 'message_type'?: PauseMovementRequestMessageTypeEnum;
3110
- /**
3111
- * Defaults to `true`. Set to true to get a response signalling successful initiation to pause the movement.
3112
- * @type {boolean}
3113
- * @memberof PauseMovementRequest
3028
+ * @memberof PausedByUser
3114
3029
  */
3115
- 'send_response'?: boolean;
3030
+ 'kind': PausedByUserKindEnum;
3116
3031
  }
3117
3032
 
3118
- export const PauseMovementRequestMessageTypeEnum = {
3119
- PauseMovementRequest: 'PauseMovementRequest'
3033
+ export const PausedByUserKindEnum = {
3034
+ PausedByUser: 'PAUSED_BY_USER'
3120
3035
  } as const;
3121
3036
 
3122
- export type PauseMovementRequestMessageTypeEnum = typeof PauseMovementRequestMessageTypeEnum[keyof typeof PauseMovementRequestMessageTypeEnum];
3037
+ export type PausedByUserKindEnum = typeof PausedByUserKindEnum[keyof typeof PausedByUserKindEnum];
3123
3038
 
3124
3039
  /**
3125
- * 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).
3040
+ *
3126
3041
  * @export
3127
- * @interface PauseMovementResponse
3042
+ * @interface PausedNearCollision
3128
3043
  */
3129
- export interface PauseMovementResponse {
3044
+ export interface PausedNearCollision {
3130
3045
  /**
3131
3046
  *
3132
- * @type {PauseMovementResponsePauseResponse}
3133
- * @memberof PauseMovementResponse
3047
+ * @type {string}
3048
+ * @memberof PausedNearCollision
3049
+ */
3050
+ 'kind': PausedNearCollisionKindEnum;
3051
+ /**
3052
+ *
3053
+ * @type {string}
3054
+ * @memberof PausedNearCollision
3134
3055
  */
3135
- 'pause_response': PauseMovementResponsePauseResponse;
3056
+ 'description': string;
3136
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
+
3137
3065
  /**
3138
3066
  *
3139
3067
  * @export
3140
- * @interface PauseMovementResponsePauseResponse
3068
+ * @interface PausedNearJointLimit
3141
3069
  */
3142
- export interface PauseMovementResponsePauseResponse {
3070
+ export interface PausedNearJointLimit {
3143
3071
  /**
3144
- * Indicates if PauseMovementRequest can be executed.
3145
- * @type {boolean}
3146
- * @memberof PauseMovementResponsePauseResponse
3072
+ *
3073
+ * @type {string}
3074
+ * @memberof PausedNearJointLimit
3147
3075
  */
3148
- 'succeeded': boolean;
3076
+ 'kind': PausedNearJointLimitKindEnum;
3149
3077
  /**
3150
- * Error message in case of invalid PauseMovementRequest or failure while claiming motion.
3151
- * @type {string}
3152
- * @memberof PauseMovementResponsePauseResponse
3078
+ *
3079
+ * @type {Array<number>}
3080
+ * @memberof PausedNearJointLimit
3153
3081
  */
3154
- 'error_message'?: string;
3082
+ 'joint_indices': Array<number>;
3155
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
+
3156
3091
  /**
3157
- * Defines an input/output that the motion will be paused for. The motion will stop gracefully on path.
3092
+ *
3158
3093
  * @export
3159
- * @interface PauseOnIO
3094
+ * @interface PausedOnIO
3160
3095
  */
3161
- export interface PauseOnIO {
3096
+ export interface PausedOnIO {
3162
3097
  /**
3163
3098
  *
3164
- * @type {IOValue}
3165
- * @memberof PauseOnIO
3166
- */
3167
- 'io': IOValue;
3168
- /**
3169
- * Comparator for the comparison of two values. Use the measured I/O as the base value (a) and the expected input/output value as the comparator (b): e.g., a > b.
3170
- * @type {Comparator}
3171
- * @memberof PauseOnIO
3099
+ * @type {string}
3100
+ * @memberof PausedOnIO
3172
3101
  */
3173
- 'comparator': Comparator;
3102
+ 'kind': PausedOnIOKindEnum;
3174
3103
  }
3175
3104
 
3105
+ export const PausedOnIOKindEnum = {
3106
+ PausedOnIo: 'PAUSED_ON_IO'
3107
+ } as const;
3108
+
3109
+ export type PausedOnIOKindEnum = typeof PausedOnIOKindEnum[keyof typeof PausedOnIOKindEnum];
3176
3110
 
3177
3111
  /**
3178
3112
  *
@@ -3425,31 +3359,31 @@ export const PlaybackSpeedRequestMessageTypeEnum = {
3425
3359
  export type PlaybackSpeedRequestMessageTypeEnum = typeof PlaybackSpeedRequestMessageTypeEnum[keyof typeof PlaybackSpeedRequestMessageTypeEnum];
3426
3360
 
3427
3361
  /**
3428
- *
3362
+ * Acknowledgment for PlaybackSpeedRequest message.
3429
3363
  * @export
3430
3364
  * @interface PlaybackSpeedResponse
3431
3365
  */
3432
3366
  export interface PlaybackSpeedResponse {
3433
3367
  /**
3434
- *
3435
- * @type {PlaybackSpeedResponsePlaybackSpeedResponse}
3368
+ * Error message in case of invalid PlaybackSpeedRequest.
3369
+ * @type {string}
3436
3370
  * @memberof PlaybackSpeedResponse
3437
3371
  */
3438
- 'playback_speed_response': PlaybackSpeedResponsePlaybackSpeedResponse;
3439
- }
3440
- /**
3441
- *
3442
- * @export
3443
- * @interface PlaybackSpeedResponsePlaybackSpeedResponse
3444
- */
3445
- export interface PlaybackSpeedResponsePlaybackSpeedResponse {
3372
+ 'message'?: string;
3446
3373
  /**
3447
- * Value of the requested playback speed in percent [%].
3448
- * @type {number}
3449
- * @memberof PlaybackSpeedResponsePlaybackSpeedResponse
3374
+ *
3375
+ * @type {string}
3376
+ * @memberof PlaybackSpeedResponse
3450
3377
  */
3451
- 'requested_value': number;
3378
+ 'kind': PlaybackSpeedResponseKindEnum;
3452
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
+
3453
3387
  /**
3454
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.
3455
3389
  * @export
@@ -3937,6 +3871,52 @@ export interface RobotTcps {
3937
3871
  */
3938
3872
  'tcps': Array<RobotTcp>;
3939
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
+
3940
3920
  /**
3941
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.
3942
3922
  * @export
@@ -4183,62 +4163,6 @@ export const SphereShapeTypeEnum = {
4183
4163
 
4184
4164
  export type SphereShapeTypeEnum = typeof SphereShapeTypeEnum[keyof typeof SphereShapeTypeEnum];
4185
4165
 
4186
- /**
4187
- * The response will be sent one time at the end of every execution signalling that the motion group has stopped moving.
4188
- * @export
4189
- * @interface Standstill
4190
- */
4191
- export interface Standstill {
4192
- /**
4193
- *
4194
- * @type {StandstillStandstill}
4195
- * @memberof Standstill
4196
- */
4197
- 'standstill': StandstillStandstill;
4198
- }
4199
- /**
4200
- * The reason why the movement is paused.
4201
- * @export
4202
- * @enum {string}
4203
- */
4204
-
4205
- export const StandstillReason = {
4206
- ReasonMotionEnded: 'REASON_MOTION_ENDED',
4207
- ReasonUserPausedMotion: 'REASON_USER_PAUSED_MOTION',
4208
- ReasonWaitingForIo: 'REASON_WAITING_FOR_IO',
4209
- ReasonPausedOnIo: 'REASON_PAUSED_ON_IO'
4210
- } as const;
4211
-
4212
- export type StandstillReason = typeof StandstillReason[keyof typeof StandstillReason];
4213
-
4214
-
4215
- /**
4216
- *
4217
- * @export
4218
- * @interface StandstillStandstill
4219
- */
4220
- export interface StandstillStandstill {
4221
- /**
4222
- *
4223
- * @type {StandstillReason}
4224
- * @memberof StandstillStandstill
4225
- */
4226
- 'reason': StandstillReason;
4227
- /**
4228
- *
4229
- * @type {number}
4230
- * @memberof StandstillStandstill
4231
- */
4232
- 'location': number;
4233
- /**
4234
- * Current state of the controller and motion group which came to a standstill.
4235
- * @type {RobotControllerState}
4236
- * @memberof StandstillStandstill
4237
- */
4238
- 'state': RobotControllerState;
4239
- }
4240
-
4241
-
4242
4166
  /**
4243
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.
4244
4168
  * @export
@@ -4283,6 +4207,32 @@ export const StartMovementRequestMessageTypeEnum = {
4283
4207
 
4284
4208
  export type StartMovementRequestMessageTypeEnum = typeof StartMovementRequestMessageTypeEnum[keyof typeof StartMovementRequestMessageTypeEnum];
4285
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
+
4286
4236
  /**
4287
4237
  * Defines an input/output that the motion should wait for to start the execution.
4288
4238
  * @export
@@ -4399,6 +4349,32 @@ export const TcpVelocityRequestMessageTypeEnum = {
4399
4349
 
4400
4350
  export type TcpVelocityRequestMessageTypeEnum = typeof TcpVelocityRequestMessageTypeEnum[keyof typeof TcpVelocityRequestMessageTypeEnum];
4401
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
+
4402
4378
  /**
4403
4379
  *
4404
4380
  * @export
@@ -4469,6 +4445,50 @@ export const TrajectoryDataMessageTypeEnum = {
4469
4445
 
4470
4446
  export type TrajectoryDataMessageTypeEnum = typeof TrajectoryDataMessageTypeEnum[keyof typeof TrajectoryDataMessageTypeEnum];
4471
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
+
4472
4492
  /**
4473
4493
  *
4474
4494
  * @export
@@ -4480,7 +4500,7 @@ export interface TrajectoryId {
4480
4500
  * @type {string}
4481
4501
  * @memberof TrajectoryId
4482
4502
  */
4483
- 'message_type': TrajectoryIdMessageTypeEnum;
4503
+ 'message_type'?: TrajectoryIdMessageTypeEnum;
4484
4504
  /**
4485
4505
  * The identifier of the trajectory which was returned by the [addTrajectory](addTrajectory) endpoint.
4486
4506
  * @type {string}
@@ -4796,6 +4816,26 @@ export interface VirtualRobotConfiguration {
4796
4816
  */
4797
4817
  'content': string;
4798
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
+
4799
4839
  /**
4800
4840
  * The value to compare with the current value of the input/output.
4801
4841
  * @export
@@ -8921,7 +8961,7 @@ export const MotionGroupApiFp = function(configuration?: Configuration) {
8921
8961
  * @param {*} [options] Override http request option.
8922
8962
  * @throws {RequiredError}
8923
8963
  */
8924
- 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>> {
8925
8965
  const localVarAxiosArgs = await localVarAxiosParamCreator.streamMotionGroupState(cell, motionGroup, responseRate, responseCoordinateSystem, options);
8926
8966
  const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
8927
8967
  const localVarOperationServerBasePath = operationServerMap['MotionGroupApi.streamMotionGroupState']?.[localVarOperationServerIndex]?.url;
@@ -8970,7 +9010,7 @@ export const MotionGroupApiFactory = function (configuration?: Configuration, ba
8970
9010
  * @param {*} [options] Override http request option.
8971
9011
  * @throws {RequiredError}
8972
9012
  */
8973
- 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> {
8974
9014
  return localVarFp.streamMotionGroupState(cell, motionGroup, responseRate, responseCoordinateSystem, options).then((request) => request(axios, basePath));
8975
9015
  },
8976
9016
  };