@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.d.ts CHANGED
@@ -202,6 +202,12 @@ export interface App {
202
202
  * @memberof App
203
203
  */
204
204
  'health_path'?: string;
205
+ /**
206
+ * 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.
207
+ * @type {string}
208
+ * @memberof App
209
+ */
210
+ 'diagnosis_path'?: string;
205
211
  }
206
212
  /**
207
213
  * ## 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).
@@ -934,6 +940,23 @@ export declare const Direction: {
934
940
  readonly DirectionBackward: "DIRECTION_BACKWARD";
935
941
  };
936
942
  export type Direction = typeof Direction[keyof typeof Direction];
943
+ /**
944
+ *
945
+ * @export
946
+ * @interface EndOfTrajectory
947
+ */
948
+ export interface EndOfTrajectory {
949
+ /**
950
+ *
951
+ * @type {string}
952
+ * @memberof EndOfTrajectory
953
+ */
954
+ 'kind': EndOfTrajectoryKindEnum;
955
+ }
956
+ export declare const EndOfTrajectoryKindEnum: {
957
+ readonly EndOfTrajectory: "END_OF_TRAJECTORY";
958
+ };
959
+ export type EndOfTrajectoryKindEnum = typeof EndOfTrajectoryKindEnum[keyof typeof EndOfTrajectoryKindEnum];
937
960
  /**
938
961
  *
939
962
  * @export
@@ -947,16 +970,44 @@ export interface Error2 {
947
970
  */
948
971
  'message': string;
949
972
  }
973
+ /**
974
+ * 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.
975
+ * @export
976
+ * @interface Execute
977
+ */
978
+ export interface Execute {
979
+ /**
980
+ * Commanded joint position of each joint in [rad]. This command was sent in the time step the corresponding state was received.
981
+ * @type {Array<number>}
982
+ * @memberof Execute
983
+ */
984
+ 'joint_position': Array<number>;
985
+ /**
986
+ *
987
+ * @type {ExecuteDetails}
988
+ * @memberof Execute
989
+ */
990
+ 'details'?: ExecuteDetails;
991
+ }
992
+ /**
993
+ * @type ExecuteDetails
994
+ * @export
995
+ */
996
+ export type ExecuteDetails = {
997
+ kind: 'JOGGING';
998
+ } & JoggingDetails | {
999
+ kind: 'TRAJECTORY';
1000
+ } & TrajectoryDetails;
950
1001
  /**
951
1002
  * @type ExecuteJoggingRequest
952
1003
  * @export
953
1004
  */
954
- export type ExecuteJoggingRequest = InitializeJoggingRequest | JointVelocityRequest | TcpVelocityRequest;
1005
+ export type ExecuteJoggingRequest = InitializeJoggingRequest | JointVelocityRequest | PauseJoggingRequest | TcpVelocityRequest;
955
1006
  /**
956
1007
  * @type ExecuteJoggingResponse
957
1008
  * @export
958
1009
  */
959
- export type ExecuteJoggingResponse = InitializeJoggingResponse | JoggingErrorResponse | JoggingResponse;
1010
+ export type ExecuteJoggingResponse = InitializeJoggingResponse | JointVelocityResponse | MovementErrorResponse | PauseJoggingResponse | TcpVelocityResponse;
960
1011
  /**
961
1012
  * @type ExecuteTrajectoryRequest
962
1013
  * @export
@@ -966,7 +1017,7 @@ export type ExecuteTrajectoryRequest = InitializeMovementRequest | PauseMovement
966
1017
  * @type ExecuteTrajectoryResponse
967
1018
  * @export
968
1019
  */
969
- export type ExecuteTrajectoryResponse = InitializeMovementResponse | Movement | MovementError | PauseMovementResponse | PlaybackSpeedResponse | Standstill;
1020
+ export type ExecuteTrajectoryResponse = InitializeMovementResponse | MovementErrorResponse | PauseMovementResponse | PlaybackSpeedResponse | StartMovementResponse;
970
1021
  /**
971
1022
  * A datapoint inside external joint stream.
972
1023
  * @export
@@ -1552,37 +1603,28 @@ export declare const InitializeJoggingRequestMessageTypeEnum: {
1552
1603
  };
1553
1604
  export type InitializeJoggingRequestMessageTypeEnum = typeof InitializeJoggingRequestMessageTypeEnum[keyof typeof InitializeJoggingRequestMessageTypeEnum];
1554
1605
  /**
1555
- * Response to an InitializeJoggingRequest.
1606
+ * Acknowledgment to an InitializeJoggingRequest.
1556
1607
  * @export
1557
1608
  * @interface InitializeJoggingResponse
1558
1609
  */
1559
1610
  export interface InitializeJoggingResponse {
1560
1611
  /**
1561
- *
1562
- * @type {InitializeJoggingResponseInitResponse}
1612
+ * Error message in case of invalid InitializeJoggingRequest.
1613
+ * @type {string}
1563
1614
  * @memberof InitializeJoggingResponse
1564
1615
  */
1565
- 'init_response': InitializeJoggingResponseInitResponse;
1566
- }
1567
- /**
1568
- *
1569
- * @export
1570
- * @interface InitializeJoggingResponseInitResponse
1571
- */
1572
- export interface InitializeJoggingResponseInitResponse {
1573
- /**
1574
- * Indicates if the jogging control is ready for execution.
1575
- * @type {boolean}
1576
- * @memberof InitializeJoggingResponseInitResponse
1577
- */
1578
- 'succeeded': boolean;
1616
+ 'message'?: string;
1579
1617
  /**
1580
- * Error message in case of invalid InitializeMovementRequest.
1618
+ *
1581
1619
  * @type {string}
1582
- * @memberof InitializeJoggingResponseInitResponse
1620
+ * @memberof InitializeJoggingResponse
1583
1621
  */
1584
- 'error_message'?: string;
1622
+ 'kind': InitializeJoggingResponseKindEnum;
1585
1623
  }
1624
+ export declare const InitializeJoggingResponseKindEnum: {
1625
+ readonly InitializeReceived: "INITIALIZE_RECEIVED";
1626
+ };
1627
+ export type InitializeJoggingResponseKindEnum = typeof InitializeJoggingResponseKindEnum[keyof typeof InitializeJoggingResponseKindEnum];
1586
1628
  /**
1587
1629
  * 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.
1588
1630
  * @export
@@ -1641,31 +1683,28 @@ export type InitializeMovementRequestTrajectory = {
1641
1683
  */
1642
1684
  export interface InitializeMovementResponse {
1643
1685
  /**
1644
- *
1645
- * @type {InitializeMovementResponseInitResponse}
1686
+ * Error message in case of invalid InitializeMovementRequest.
1687
+ * @type {string}
1646
1688
  * @memberof InitializeMovementResponse
1647
1689
  */
1648
- 'init_response': InitializeMovementResponseInitResponse;
1649
- }
1650
- /**
1651
- *
1652
- * @export
1653
- * @interface InitializeMovementResponseInitResponse
1654
- */
1655
- export interface InitializeMovementResponseInitResponse {
1690
+ 'message'?: string;
1656
1691
  /**
1657
- * Indicates if the trajectory was successfully locked and is ready for execution by sending a StartMovementRequest. Send PlaybackSpeedRequest to override the planned velocity.
1658
- * @type {boolean}
1659
- * @memberof InitializeMovementResponseInitResponse
1692
+ * Error can occur if joint trajectory was added by [InitializeMovementRequest](InitializeMovementRequest) and the trajectory is invalid.
1693
+ * @type {AddTrajectoryError}
1694
+ * @memberof InitializeMovementResponse
1660
1695
  */
1661
- 'succeeded': boolean;
1696
+ 'add_trajectory_error'?: AddTrajectoryError;
1662
1697
  /**
1663
- * Error message in case of invalid InitializeMovementRequest.
1698
+ *
1664
1699
  * @type {string}
1665
- * @memberof InitializeMovementResponseInitResponse
1700
+ * @memberof InitializeMovementResponse
1666
1701
  */
1667
- 'error_message'?: string;
1702
+ 'kind': InitializeMovementResponseKindEnum;
1668
1703
  }
1704
+ export declare const InitializeMovementResponseKindEnum: {
1705
+ readonly InitializeReceived: "INITIALIZE_RECEIVED";
1706
+ };
1707
+ export type InitializeMovementResponseKindEnum = typeof InitializeMovementResponseKindEnum[keyof typeof InitializeMovementResponseKindEnum];
1669
1708
  /**
1670
1709
  * 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.
1671
1710
  * @export
@@ -1780,159 +1819,33 @@ export interface InverseKinematicsResponse {
1780
1819
  'joints': Array<Array<Array<number>>>;
1781
1820
  }
1782
1821
  /**
1783
- * Response signalling an error during jogging execution. This response is sent in case of an unexpected error, e.g. controller disconnects.
1784
- * @export
1785
- * @interface JoggingErrorResponse
1786
- */
1787
- export interface JoggingErrorResponse {
1788
- /**
1789
- *
1790
- * @type {JoggingErrorResponseError}
1791
- * @memberof JoggingErrorResponse
1792
- */
1793
- 'error': JoggingErrorResponseError;
1794
- }
1795
- /**
1796
- *
1797
- * @export
1798
- * @interface JoggingErrorResponseError
1799
- */
1800
- export interface JoggingErrorResponseError {
1801
- /**
1802
- * Error description.
1803
- * @type {string}
1804
- * @memberof JoggingErrorResponseError
1805
- */
1806
- 'error_message': string;
1807
- }
1808
- /**
1809
- *
1822
+ * 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.
1810
1823
  * @export
1811
- * @interface JoggingPausedCollision
1824
+ * @interface JoggingDetails
1812
1825
  */
1813
- export interface JoggingPausedCollision {
1826
+ export interface JoggingDetails {
1814
1827
  /**
1815
1828
  *
1816
- * @type {JoggingPausedCollisionPausedNearCollision}
1817
- * @memberof JoggingPausedCollision
1829
+ * @type {JoggingDetailsState}
1830
+ * @memberof JoggingDetails
1818
1831
  */
1819
- 'paused_near_collision': JoggingPausedCollisionPausedNearCollision;
1820
- }
1821
- /**
1822
- *
1823
- * @export
1824
- * @interface JoggingPausedCollisionPausedNearCollision
1825
- */
1826
- export interface JoggingPausedCollisionPausedNearCollision {
1832
+ 'state': JoggingDetailsState;
1827
1833
  /**
1828
1834
  *
1829
1835
  * @type {string}
1830
- * @memberof JoggingPausedCollisionPausedNearCollision
1831
- */
1832
- 'description'?: string;
1833
- }
1834
- /**
1835
- *
1836
- * @export
1837
- * @interface JoggingPausedJointLimit
1838
- */
1839
- export interface JoggingPausedJointLimit {
1840
- /**
1841
- *
1842
- * @type {JoggingPausedJointLimitPausedNearJointLimit}
1843
- * @memberof JoggingPausedJointLimit
1844
- */
1845
- 'paused_near_joint_limit': JoggingPausedJointLimitPausedNearJointLimit;
1846
- }
1847
- /**
1848
- *
1849
- * @export
1850
- * @interface JoggingPausedJointLimitPausedNearJointLimit
1851
- */
1852
- export interface JoggingPausedJointLimitPausedNearJointLimit {
1853
- /**
1854
- *
1855
- * @type {Array<number>}
1856
- * @memberof JoggingPausedJointLimitPausedNearJointLimit
1857
- */
1858
- 'joint_indices'?: Array<number>;
1859
- }
1860
- /**
1861
- *
1862
- * @export
1863
- * @interface JoggingPausedOnIO
1864
- */
1865
- export interface JoggingPausedOnIO {
1866
- /**
1867
- *
1868
- * @type {object}
1869
- * @memberof JoggingPausedOnIO
1870
- */
1871
- 'paused_on_io': object;
1872
- }
1873
- /**
1874
- *
1875
- * @export
1876
- * @interface JoggingPausedUserRequest
1877
- */
1878
- export interface JoggingPausedUserRequest {
1879
- /**
1880
- *
1881
- * @type {object}
1882
- * @memberof JoggingPausedUserRequest
1883
- */
1884
- 'paused_by_user_request': object;
1885
- }
1886
- /**
1887
- * Sent during jogging movement, response-rate closest to the nearest multiple of controller step-rate but not exceeding the configured rate.
1888
- * @export
1889
- * @interface JoggingResponse
1890
- */
1891
- export interface JoggingResponse {
1892
- /**
1893
- *
1894
- * @type {JoggingResponseJogging}
1895
- * @memberof JoggingResponse
1836
+ * @memberof JoggingDetails
1896
1837
  */
1897
- 'jogging': JoggingResponseJogging;
1898
- }
1899
- /**
1900
- *
1901
- * @export
1902
- * @interface JoggingResponseJogging
1903
- */
1904
- export interface JoggingResponseJogging {
1905
- /**
1906
- *
1907
- * @type {JoggingState}
1908
- * @memberof JoggingResponseJogging
1909
- */
1910
- 'jogging_state': JoggingState;
1911
- /**
1912
- *
1913
- * @type {RobotControllerState}
1914
- * @memberof JoggingResponseJogging
1915
- */
1916
- 'robot_controller_state': RobotControllerState;
1917
- }
1918
- /**
1919
- *
1920
- * @export
1921
- * @interface JoggingRunning
1922
- */
1923
- export interface JoggingRunning {
1924
- /**
1925
- *
1926
- * @type {object}
1927
- * @memberof JoggingRunning
1928
- */
1929
- 'running': object;
1838
+ 'kind': JoggingDetailsKindEnum;
1930
1839
  }
1840
+ export declare const JoggingDetailsKindEnum: {
1841
+ readonly Jogging: "JOGGING";
1842
+ };
1843
+ export type JoggingDetailsKindEnum = typeof JoggingDetailsKindEnum[keyof typeof JoggingDetailsKindEnum];
1931
1844
  /**
1932
- * @type JoggingState
1845
+ * @type JoggingDetailsState
1933
1846
  * @export
1934
1847
  */
1935
- export type JoggingState = JoggingPausedCollision | JoggingPausedJointLimit | JoggingPausedOnIO | JoggingPausedUserRequest | JoggingRunning;
1848
+ export type JoggingDetailsState = PausedByUser | PausedNearCollision | PausedNearJointLimit | PausedOnIO | Running;
1936
1849
  /**
1937
1850
  *
1938
1851
  * @export
@@ -1994,6 +1907,29 @@ export declare const JointVelocityRequestMessageTypeEnum: {
1994
1907
  readonly JointVelocityRequest: "JointVelocityRequest";
1995
1908
  };
1996
1909
  export type JointVelocityRequestMessageTypeEnum = typeof JointVelocityRequestMessageTypeEnum[keyof typeof JointVelocityRequestMessageTypeEnum];
1910
+ /**
1911
+ * Acknowledgment to a JointVelocityRequest.
1912
+ * @export
1913
+ * @interface JointVelocityResponse
1914
+ */
1915
+ export interface JointVelocityResponse {
1916
+ /**
1917
+ * Error message in case of invalid JointVelocityRequest.
1918
+ * @type {string}
1919
+ * @memberof JointVelocityResponse
1920
+ */
1921
+ 'message'?: string;
1922
+ /**
1923
+ *
1924
+ * @type {string}
1925
+ * @memberof JointVelocityResponse
1926
+ */
1927
+ 'kind': JointVelocityResponseKindEnum;
1928
+ }
1929
+ export declare const JointVelocityResponseKindEnum: {
1930
+ readonly JointVelocityReceived: "JOINT_VELOCITY_RECEIVED";
1931
+ };
1932
+ export type JointVelocityResponseKindEnum = typeof JointVelocityResponseKindEnum[keyof typeof JointVelocityResponseKindEnum];
1997
1933
  /**
1998
1934
  * 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.
1999
1935
  * @export
@@ -2461,17 +2397,17 @@ export interface MotionGroupJoints {
2461
2397
  'torques'?: Array<number>;
2462
2398
  }
2463
2399
  /**
2464
- *
2400
+ * Presents the current state of the motion group.
2465
2401
  * @export
2466
2402
  * @interface MotionGroupState
2467
2403
  */
2468
2404
  export interface MotionGroupState {
2469
2405
  /**
2470
- * Timestamp indicating when the represented information was received from the robot controller.
2406
+ * Timestamp for when data was received from the robot controller.
2471
2407
  * @type {string}
2472
2408
  * @memberof MotionGroupState
2473
2409
  */
2474
- 'timestamp'?: string;
2410
+ 'timestamp': string;
2475
2411
  /**
2476
2412
  * 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.
2477
2413
  * @type {number}
@@ -2503,59 +2439,59 @@ export interface MotionGroupState {
2503
2439
  */
2504
2440
  'joint_limit_reached': MotionGroupStateJointLimitReached;
2505
2441
  /**
2506
- * Current joint velocity of each joint in [rad/s]
2507
- * @type {Joints}
2508
- * @memberof MotionGroupState
2509
- */
2510
- 'joint_velocity': Joints;
2511
- /**
2512
- * Current joint torque of each joint in [Nm]. Is only available if the robot controller supports it (e.g. available for UR Controllers).
2442
+ * Current joint torque of each joint in [Nm]. Is only available if the robot controller supports it, e.g. available for UR controllers.
2513
2443
  * @type {Joints}
2514
2444
  * @memberof MotionGroupState
2515
2445
  */
2516
2446
  'joint_torque'?: Joints;
2517
2447
  /**
2518
- * Current Current at TCP in [A]. Is only available if the robot controller supports it, e.g. available for UR Controllers.
2448
+ * Current at TCP in [A]. Is only available if the robot controller supports it, e.g. available for UR controllers.
2519
2449
  * @type {Joints}
2520
2450
  * @memberof MotionGroupState
2521
2451
  */
2522
2452
  'joint_current'?: Joints;
2523
2453
  /**
2524
- * 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.
2454
+ * 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.
2525
2455
  * @type {Pose}
2526
2456
  * @memberof MotionGroupState
2527
2457
  */
2528
2458
  'flange_pose'?: Pose;
2529
2459
  /**
2530
- * Unique identifier addressing the TCP currently set.
2460
+ * Unique identifier addressing the active TCP. Might not be returned for positioners as some do not support TCPs, depending on the model.
2531
2461
  * @type {string}
2532
2462
  * @memberof MotionGroupState
2533
2463
  */
2534
- 'tcp': string;
2464
+ 'tcp'?: string;
2535
2465
  /**
2536
- * 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.
2466
+ * 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.
2537
2467
  * @type {Pose}
2538
2468
  * @memberof MotionGroupState
2539
2469
  */
2540
- 'tcp_pose': Pose;
2470
+ 'tcp_pose'?: Pose;
2541
2471
  /**
2542
- * 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.
2543
- * @type {MotionVector}
2472
+ * 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.
2473
+ * @type {string}
2544
2474
  * @memberof MotionGroupState
2545
2475
  */
2546
- 'tcp_velocity': MotionVector;
2476
+ 'coordinate_system'?: string;
2547
2477
  /**
2548
- * Unique identifier addressing the reference coordinate system of the cartesian data. Default is the world coordinate system of corresponding controller.
2478
+ * Unique identifier addressing the active payload. Only fetchable via GET endpoint, not available in WebSocket.
2549
2479
  * @type {string}
2550
2480
  * @memberof MotionGroupState
2551
2481
  */
2552
- 'coordinate_system': string;
2482
+ 'payload'?: string;
2553
2483
  /**
2554
- * Unique identifier addressing the Payload currently set. Only fetchable via GET endpoint, not available in WebSocket.
2555
- * @type {string}
2484
+ * Indicates whether the motion group is in standstill. Convenience: Signals that NOVA treats measured joint velocities as 0.
2485
+ * @type {boolean}
2556
2486
  * @memberof MotionGroupState
2557
2487
  */
2558
- 'payload'?: string;
2488
+ 'standstill': boolean;
2489
+ /**
2490
+ * 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.
2491
+ * @type {Execute}
2492
+ * @memberof MotionGroupState
2493
+ */
2494
+ 'execute'?: Execute;
2559
2495
  }
2560
2496
  /**
2561
2497
  * 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.
@@ -2570,97 +2506,6 @@ export interface MotionGroupStateJointLimitReached {
2570
2506
  */
2571
2507
  'limit_reached': Array<boolean>;
2572
2508
  }
2573
- /**
2574
- * Presents the current state of the motion group.
2575
- * @export
2576
- * @interface MotionGroupStateWithoutPayload
2577
- */
2578
- export interface MotionGroupStateWithoutPayload {
2579
- /**
2580
- * Timestamp indicating when the represented information was received from the robot controller.
2581
- * @type {string}
2582
- * @memberof MotionGroupStateWithoutPayload
2583
- */
2584
- 'timestamp'?: string;
2585
- /**
2586
- * 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.
2587
- * @type {number}
2588
- * @memberof MotionGroupStateWithoutPayload
2589
- */
2590
- 'sequence_number': number;
2591
- /**
2592
- * Identifier of the motion group.
2593
- * @type {string}
2594
- * @memberof MotionGroupStateWithoutPayload
2595
- */
2596
- 'motion_group': string;
2597
- /**
2598
- * Convenience: Identifier of the robot controller the motion group is attached to.
2599
- * @type {string}
2600
- * @memberof MotionGroupStateWithoutPayload
2601
- */
2602
- 'controller': string;
2603
- /**
2604
- * Current joint position of each joint in [rad]
2605
- * @type {Joints}
2606
- * @memberof MotionGroupStateWithoutPayload
2607
- */
2608
- 'joint_position': Joints;
2609
- /**
2610
- * Indicates whether the joint is in a limit for all joints of the motion group.
2611
- * @type {MotionGroupStateJointLimitReached}
2612
- * @memberof MotionGroupStateWithoutPayload
2613
- */
2614
- 'joint_limit_reached': MotionGroupStateJointLimitReached;
2615
- /**
2616
- * Current joint velocity of each joint in [rad/s]
2617
- * @type {Joints}
2618
- * @memberof MotionGroupStateWithoutPayload
2619
- */
2620
- 'joint_velocity': Joints;
2621
- /**
2622
- * Current joint torque of each joint in [Nm]. Is only available if the robot controller supports it (e.g. available for UR Controllers).
2623
- * @type {Joints}
2624
- * @memberof MotionGroupStateWithoutPayload
2625
- */
2626
- 'joint_torque'?: Joints;
2627
- /**
2628
- * Current Current at TCP in [A]. Is only available if the robot controller supports it, e.g. available for UR Controllers.
2629
- * @type {Joints}
2630
- * @memberof MotionGroupStateWithoutPayload
2631
- */
2632
- 'joint_current'?: Joints;
2633
- /**
2634
- * 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.
2635
- * @type {Pose}
2636
- * @memberof MotionGroupStateWithoutPayload
2637
- */
2638
- 'flange_pose'?: Pose;
2639
- /**
2640
- * Unique identifier addressing the TCP currently set.
2641
- * @type {string}
2642
- * @memberof MotionGroupStateWithoutPayload
2643
- */
2644
- 'tcp': string;
2645
- /**
2646
- * 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.
2647
- * @type {Pose}
2648
- * @memberof MotionGroupStateWithoutPayload
2649
- */
2650
- 'tcp_pose': Pose;
2651
- /**
2652
- * 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.
2653
- * @type {MotionVector}
2654
- * @memberof MotionGroupStateWithoutPayload
2655
- */
2656
- 'tcp_velocity': MotionVector;
2657
- /**
2658
- * Unique identifier addressing the reference coordinate system of the cartesian data. Default is the world coordinate system of corresponding controller.
2659
- * @type {string}
2660
- * @memberof MotionGroupStateWithoutPayload
2661
- */
2662
- 'coordinate_system': string;
2663
- }
2664
2509
  /**
2665
2510
  * Collection of information on the current state of the robot.
2666
2511
  * @export
@@ -2687,94 +2532,28 @@ export interface MotionState {
2687
2532
  'state': RobotState;
2688
2533
  }
2689
2534
  /**
2690
- *
2535
+ * Error message in case an error occurs during movement execution.
2691
2536
  * @export
2692
- * @interface MotionVector
2537
+ * @interface MovementErrorResponse
2693
2538
  */
2694
- export interface MotionVector {
2539
+ export interface MovementErrorResponse {
2695
2540
  /**
2696
- * A three-dimensional vector [x, y, z] with double precision.
2697
- * @type {Array<number>}
2698
- * @memberof MotionVector
2699
- */
2700
- 'linear'?: Array<number>;
2701
- /**
2702
- * A three-dimensional vector [x, y, z] with double precision.
2703
- * @type {Array<number>}
2704
- * @memberof MotionVector
2705
- */
2706
- 'angular'?: Array<number>;
2707
- /**
2708
- * optional, unique name of base coordinate system, if empty world is used
2541
+ * Detailed error message describing the issue encountered during movement execution.
2709
2542
  * @type {string}
2710
- * @memberof MotionVector
2711
- */
2712
- 'coordinate_system'?: string;
2713
- }
2714
- /**
2715
- * Sent during trajectory movement, response-rate closest to the nearest multiple of controller step-rate but not exceeding the configured rate.
2716
- * @export
2717
- * @interface Movement
2718
- */
2719
- export interface Movement {
2720
- /**
2721
- *
2722
- * @type {MovementMovement}
2723
- * @memberof Movement
2543
+ * @memberof MovementErrorResponse
2724
2544
  */
2725
- 'movement': MovementMovement;
2726
- }
2727
- /**
2728
- * 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.
2729
- * @export
2730
- * @interface MovementError
2731
- */
2732
- export interface MovementError {
2545
+ 'message': string;
2733
2546
  /**
2734
2547
  *
2735
- * @type {MovementErrorError}
2736
- * @memberof MovementError
2737
- */
2738
- 'error': MovementErrorError;
2739
- }
2740
- /**
2741
- *
2742
- * @export
2743
- * @interface MovementErrorError
2744
- */
2745
- export interface MovementErrorError {
2746
- /**
2747
- * Human-readable error details that describes the error.
2748
2548
  * @type {string}
2749
- * @memberof MovementErrorError
2750
- */
2751
- 'error_message': string;
2752
- }
2753
- /**
2754
- *
2755
- * @export
2756
- * @interface MovementMovement
2757
- */
2758
- export interface MovementMovement {
2759
- /**
2760
- * Remaining time in milliseconds (ms) to reach the end of the motion.
2761
- * @type {number}
2762
- * @memberof MovementMovement
2763
- */
2764
- 'time_to_end': number;
2765
- /**
2766
- * Current location of motion group on the trajectory.
2767
- * @type {number}
2768
- * @memberof MovementMovement
2769
- */
2770
- 'current_location': number;
2771
- /**
2772
- * Current state of the robot controller and moving motion group.
2773
- * @type {RobotControllerState}
2774
- * @memberof MovementMovement
2549
+ * @memberof MovementErrorResponse
2775
2550
  */
2776
- 'state': RobotControllerState;
2551
+ 'kind': MovementErrorResponseKindEnum;
2777
2552
  }
2553
+ export declare const MovementErrorResponseKindEnum: {
2554
+ readonly Error: "ERROR";
2555
+ };
2556
+ export type MovementErrorResponseKindEnum = typeof MovementErrorResponseKindEnum[keyof typeof MovementErrorResponseKindEnum];
2778
2557
  /**
2779
2558
  *
2780
2559
  * @export
@@ -2997,6 +2776,46 @@ export declare const PathLinePathDefinitionNameEnum: {
2997
2776
  readonly PathLine: "PathLine";
2998
2777
  };
2999
2778
  export type PathLinePathDefinitionNameEnum = typeof PathLinePathDefinitionNameEnum[keyof typeof PathLinePathDefinitionNameEnum];
2779
+ /**
2780
+ * Request to pause jogging. If successful, `execute` jogging state in [MotionGroupState](MotionGroupState.yaml) is set to `PAUSED_BY_USER`.
2781
+ * @export
2782
+ * @interface PauseJoggingRequest
2783
+ */
2784
+ export interface PauseJoggingRequest {
2785
+ /**
2786
+ * Type specifier for server, set automatically.
2787
+ * @type {string}
2788
+ * @memberof PauseJoggingRequest
2789
+ */
2790
+ 'message_type'?: PauseJoggingRequestMessageTypeEnum;
2791
+ }
2792
+ export declare const PauseJoggingRequestMessageTypeEnum: {
2793
+ readonly PauseJoggingRequest: "PauseJoggingRequest";
2794
+ };
2795
+ export type PauseJoggingRequestMessageTypeEnum = typeof PauseJoggingRequestMessageTypeEnum[keyof typeof PauseJoggingRequestMessageTypeEnum];
2796
+ /**
2797
+ * Acknowledgment to a PauseJoggingRequest.
2798
+ * @export
2799
+ * @interface PauseJoggingResponse
2800
+ */
2801
+ export interface PauseJoggingResponse {
2802
+ /**
2803
+ * Error message in case of invalid PauseJoggingRequest.
2804
+ * @type {string}
2805
+ * @memberof PauseJoggingResponse
2806
+ */
2807
+ 'message'?: string;
2808
+ /**
2809
+ *
2810
+ * @type {string}
2811
+ * @memberof PauseJoggingResponse
2812
+ */
2813
+ 'kind': PauseJoggingResponseKindEnum;
2814
+ }
2815
+ export declare const PauseJoggingResponseKindEnum: {
2816
+ readonly PauseReceived: "PAUSE_RECEIVED";
2817
+ };
2818
+ export type PauseJoggingResponseKindEnum = typeof PauseJoggingResponseKindEnum[keyof typeof PauseJoggingResponseKindEnum];
3000
2819
  /**
3001
2820
  * 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.
3002
2821
  * @export
@@ -3009,49 +2828,34 @@ export interface PauseMovementRequest {
3009
2828
  * @memberof PauseMovementRequest
3010
2829
  */
3011
2830
  'message_type'?: PauseMovementRequestMessageTypeEnum;
3012
- /**
3013
- * Defaults to `true`. Set to true to get a response signalling successful initiation to pause the movement.
3014
- * @type {boolean}
3015
- * @memberof PauseMovementRequest
3016
- */
3017
- 'send_response'?: boolean;
3018
2831
  }
3019
2832
  export declare const PauseMovementRequestMessageTypeEnum: {
3020
2833
  readonly PauseMovementRequest: "PauseMovementRequest";
3021
2834
  };
3022
2835
  export type PauseMovementRequestMessageTypeEnum = typeof PauseMovementRequestMessageTypeEnum[keyof typeof PauseMovementRequestMessageTypeEnum];
3023
2836
  /**
3024
- * 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).
2837
+ * 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).
3025
2838
  * @export
3026
2839
  * @interface PauseMovementResponse
3027
2840
  */
3028
2841
  export interface PauseMovementResponse {
3029
2842
  /**
3030
- *
3031
- * @type {PauseMovementResponsePauseResponse}
2843
+ * Error message in case of invalid PauseMovementResquest.
2844
+ * @type {string}
3032
2845
  * @memberof PauseMovementResponse
3033
2846
  */
3034
- 'pause_response': PauseMovementResponsePauseResponse;
3035
- }
3036
- /**
3037
- *
3038
- * @export
3039
- * @interface PauseMovementResponsePauseResponse
3040
- */
3041
- export interface PauseMovementResponsePauseResponse {
3042
- /**
3043
- * Indicates if PauseMovementRequest can be executed.
3044
- * @type {boolean}
3045
- * @memberof PauseMovementResponsePauseResponse
3046
- */
3047
- 'succeeded': boolean;
2847
+ 'message'?: string;
3048
2848
  /**
3049
- * Error message in case of invalid PauseMovementRequest or failure while claiming motion.
2849
+ *
3050
2850
  * @type {string}
3051
- * @memberof PauseMovementResponsePauseResponse
2851
+ * @memberof PauseMovementResponse
3052
2852
  */
3053
- 'error_message'?: string;
2853
+ 'kind': PauseMovementResponseKindEnum;
3054
2854
  }
2855
+ export declare const PauseMovementResponseKindEnum: {
2856
+ readonly PauseReceived: "PAUSE_RECEIVED";
2857
+ };
2858
+ export type PauseMovementResponseKindEnum = typeof PauseMovementResponseKindEnum[keyof typeof PauseMovementResponseKindEnum];
3055
2859
  /**
3056
2860
  * Defines an input/output that the motion will be paused for. The motion will stop gracefully on path.
3057
2861
  * @export
@@ -3071,6 +2875,103 @@ export interface PauseOnIO {
3071
2875
  */
3072
2876
  'comparator': Comparator;
3073
2877
  }
2878
+ /**
2879
+ *
2880
+ * @export
2881
+ * @interface PausedByRequest
2882
+ */
2883
+ export interface PausedByRequest {
2884
+ /**
2885
+ *
2886
+ * @type {string}
2887
+ * @memberof PausedByRequest
2888
+ */
2889
+ 'kind': PausedByRequestKindEnum;
2890
+ }
2891
+ export declare const PausedByRequestKindEnum: {
2892
+ readonly PausedByUser: "PAUSED_BY_USER";
2893
+ };
2894
+ export type PausedByRequestKindEnum = typeof PausedByRequestKindEnum[keyof typeof PausedByRequestKindEnum];
2895
+ /**
2896
+ *
2897
+ * @export
2898
+ * @interface PausedByUser
2899
+ */
2900
+ export interface PausedByUser {
2901
+ /**
2902
+ *
2903
+ * @type {string}
2904
+ * @memberof PausedByUser
2905
+ */
2906
+ 'kind': PausedByUserKindEnum;
2907
+ }
2908
+ export declare const PausedByUserKindEnum: {
2909
+ readonly PausedByUser: "PAUSED_BY_USER";
2910
+ };
2911
+ export type PausedByUserKindEnum = typeof PausedByUserKindEnum[keyof typeof PausedByUserKindEnum];
2912
+ /**
2913
+ *
2914
+ * @export
2915
+ * @interface PausedNearCollision
2916
+ */
2917
+ export interface PausedNearCollision {
2918
+ /**
2919
+ *
2920
+ * @type {string}
2921
+ * @memberof PausedNearCollision
2922
+ */
2923
+ 'kind': PausedNearCollisionKindEnum;
2924
+ /**
2925
+ *
2926
+ * @type {string}
2927
+ * @memberof PausedNearCollision
2928
+ */
2929
+ 'description': string;
2930
+ }
2931
+ export declare const PausedNearCollisionKindEnum: {
2932
+ readonly PausedNearCollision: "PAUSED_NEAR_COLLISION";
2933
+ };
2934
+ export type PausedNearCollisionKindEnum = typeof PausedNearCollisionKindEnum[keyof typeof PausedNearCollisionKindEnum];
2935
+ /**
2936
+ *
2937
+ * @export
2938
+ * @interface PausedNearJointLimit
2939
+ */
2940
+ export interface PausedNearJointLimit {
2941
+ /**
2942
+ *
2943
+ * @type {string}
2944
+ * @memberof PausedNearJointLimit
2945
+ */
2946
+ 'kind': PausedNearJointLimitKindEnum;
2947
+ /**
2948
+ *
2949
+ * @type {Array<number>}
2950
+ * @memberof PausedNearJointLimit
2951
+ */
2952
+ 'joint_indices': Array<number>;
2953
+ }
2954
+ export declare const PausedNearJointLimitKindEnum: {
2955
+ readonly PausedNearJointLimit: "PAUSED_NEAR_JOINT_LIMIT";
2956
+ };
2957
+ export type PausedNearJointLimitKindEnum = typeof PausedNearJointLimitKindEnum[keyof typeof PausedNearJointLimitKindEnum];
2958
+ /**
2959
+ *
2960
+ * @export
2961
+ * @interface PausedOnIO
2962
+ */
2963
+ export interface PausedOnIO {
2964
+ /**
2965
+ *
2966
+ * @type {string}
2967
+ * @memberof PausedOnIO
2968
+ */
2969
+ 'kind': PausedOnIOKindEnum;
2970
+ }
2971
+ export declare const PausedOnIOKindEnum: {
2972
+ readonly PausedOnIo: "PAUSED_ON_IO";
2973
+ };
2974
+ export type PausedOnIOKindEnum = typeof PausedOnIOKindEnum[keyof typeof PausedOnIOKindEnum];
3074
2975
  /**
3075
2976
  *
3076
2977
  * @export
@@ -3314,31 +3215,28 @@ export declare const PlaybackSpeedRequestMessageTypeEnum: {
3314
3215
  };
3315
3216
  export type PlaybackSpeedRequestMessageTypeEnum = typeof PlaybackSpeedRequestMessageTypeEnum[keyof typeof PlaybackSpeedRequestMessageTypeEnum];
3316
3217
  /**
3317
- *
3218
+ * Acknowledgment for PlaybackSpeedRequest message.
3318
3219
  * @export
3319
3220
  * @interface PlaybackSpeedResponse
3320
3221
  */
3321
3222
  export interface PlaybackSpeedResponse {
3322
3223
  /**
3323
- *
3324
- * @type {PlaybackSpeedResponsePlaybackSpeedResponse}
3224
+ * Error message in case of invalid PlaybackSpeedRequest.
3225
+ * @type {string}
3325
3226
  * @memberof PlaybackSpeedResponse
3326
3227
  */
3327
- 'playback_speed_response': PlaybackSpeedResponsePlaybackSpeedResponse;
3328
- }
3329
- /**
3330
- *
3331
- * @export
3332
- * @interface PlaybackSpeedResponsePlaybackSpeedResponse
3333
- */
3334
- export interface PlaybackSpeedResponsePlaybackSpeedResponse {
3228
+ 'message'?: string;
3335
3229
  /**
3336
- * Value of the requested playback speed in percent [%].
3337
- * @type {number}
3338
- * @memberof PlaybackSpeedResponsePlaybackSpeedResponse
3230
+ *
3231
+ * @type {string}
3232
+ * @memberof PlaybackSpeedResponse
3339
3233
  */
3340
- 'requested_value': number;
3234
+ 'kind': PlaybackSpeedResponseKindEnum;
3341
3235
  }
3236
+ export declare const PlaybackSpeedResponseKindEnum: {
3237
+ readonly PlaybackSpeedReceived: "PLAYBACK_SPEED_RECEIVED";
3238
+ };
3239
+ export type PlaybackSpeedResponseKindEnum = typeof PlaybackSpeedResponseKindEnum[keyof typeof PlaybackSpeedResponseKindEnum];
3342
3240
  /**
3343
3241
  * Defines a pose in 3D space. A pose is a combination of a position and an orientation. The position is applied before the orientation.
3344
3242
  * @export
@@ -3798,6 +3696,46 @@ export interface RobotTcps {
3798
3696
  */
3799
3697
  'tcps': Array<RobotTcp>;
3800
3698
  }
3699
+ /**
3700
+ *
3701
+ * @export
3702
+ * @interface Running
3703
+ */
3704
+ export interface Running {
3705
+ /**
3706
+ *
3707
+ * @type {string}
3708
+ * @memberof Running
3709
+ */
3710
+ 'kind': RunningKindEnum;
3711
+ }
3712
+ export declare const RunningKindEnum: {
3713
+ readonly Running: "RUNNING";
3714
+ };
3715
+ export type RunningKindEnum = typeof RunningKindEnum[keyof typeof RunningKindEnum];
3716
+ /**
3717
+ *
3718
+ * @export
3719
+ * @interface Running1
3720
+ */
3721
+ export interface Running1 {
3722
+ /**
3723
+ *
3724
+ * @type {string}
3725
+ * @memberof Running1
3726
+ */
3727
+ 'kind': Running1KindEnum;
3728
+ /**
3729
+ * Remaining time in milliseconds (ms) to reach the end of the motion.
3730
+ * @type {number}
3731
+ * @memberof Running1
3732
+ */
3733
+ 'time_to_end': number;
3734
+ }
3735
+ export declare const Running1KindEnum: {
3736
+ readonly Running: "RUNNING";
3737
+ };
3738
+ export type Running1KindEnum = typeof Running1KindEnum[keyof typeof Running1KindEnum];
3801
3739
  /**
3802
3740
  * 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.
3803
3741
  * @export
@@ -4017,56 +3955,6 @@ export declare const SphereShapeTypeEnum: {
4017
3955
  readonly Sphere: "sphere";
4018
3956
  };
4019
3957
  export type SphereShapeTypeEnum = typeof SphereShapeTypeEnum[keyof typeof SphereShapeTypeEnum];
4020
- /**
4021
- * The response will be sent one time at the end of every execution signalling that the motion group has stopped moving.
4022
- * @export
4023
- * @interface Standstill
4024
- */
4025
- export interface Standstill {
4026
- /**
4027
- *
4028
- * @type {StandstillStandstill}
4029
- * @memberof Standstill
4030
- */
4031
- 'standstill': StandstillStandstill;
4032
- }
4033
- /**
4034
- * The reason why the movement is paused.
4035
- * @export
4036
- * @enum {string}
4037
- */
4038
- export declare const StandstillReason: {
4039
- readonly ReasonMotionEnded: "REASON_MOTION_ENDED";
4040
- readonly ReasonUserPausedMotion: "REASON_USER_PAUSED_MOTION";
4041
- readonly ReasonWaitingForIo: "REASON_WAITING_FOR_IO";
4042
- readonly ReasonPausedOnIo: "REASON_PAUSED_ON_IO";
4043
- };
4044
- export type StandstillReason = typeof StandstillReason[keyof typeof StandstillReason];
4045
- /**
4046
- *
4047
- * @export
4048
- * @interface StandstillStandstill
4049
- */
4050
- export interface StandstillStandstill {
4051
- /**
4052
- *
4053
- * @type {StandstillReason}
4054
- * @memberof StandstillStandstill
4055
- */
4056
- 'reason': StandstillReason;
4057
- /**
4058
- *
4059
- * @type {number}
4060
- * @memberof StandstillStandstill
4061
- */
4062
- 'location': number;
4063
- /**
4064
- * Current state of the controller and motion group which came to a standstill.
4065
- * @type {RobotControllerState}
4066
- * @memberof StandstillStandstill
4067
- */
4068
- 'state': RobotControllerState;
4069
- }
4070
3958
  /**
4071
3959
  * 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.
4072
3960
  * @export
@@ -4108,6 +3996,29 @@ export declare const StartMovementRequestMessageTypeEnum: {
4108
3996
  readonly StartMovementRequest: "StartMovementRequest";
4109
3997
  };
4110
3998
  export type StartMovementRequestMessageTypeEnum = typeof StartMovementRequestMessageTypeEnum[keyof typeof StartMovementRequestMessageTypeEnum];
3999
+ /**
4000
+ * 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.
4001
+ * @export
4002
+ * @interface StartMovementResponse
4003
+ */
4004
+ export interface StartMovementResponse {
4005
+ /**
4006
+ * Error message in case of invalid StartMovementResquest.
4007
+ * @type {string}
4008
+ * @memberof StartMovementResponse
4009
+ */
4010
+ 'message'?: string;
4011
+ /**
4012
+ *
4013
+ * @type {string}
4014
+ * @memberof StartMovementResponse
4015
+ */
4016
+ 'kind': StartMovementResponseKindEnum;
4017
+ }
4018
+ export declare const StartMovementResponseKindEnum: {
4019
+ readonly StartReceived: "START_RECEIVED";
4020
+ };
4021
+ export type StartMovementResponseKindEnum = typeof StartMovementResponseKindEnum[keyof typeof StartMovementResponseKindEnum];
4111
4022
  /**
4112
4023
  * Defines an input/output that the motion should wait for to start the execution.
4113
4024
  * @export
@@ -4219,6 +4130,29 @@ export declare const TcpVelocityRequestMessageTypeEnum: {
4219
4130
  readonly TcpVelocityRequest: "TcpVelocityRequest";
4220
4131
  };
4221
4132
  export type TcpVelocityRequestMessageTypeEnum = typeof TcpVelocityRequestMessageTypeEnum[keyof typeof TcpVelocityRequestMessageTypeEnum];
4133
+ /**
4134
+ * Acknowledgment to a TcpVelocityRequest.
4135
+ * @export
4136
+ * @interface TcpVelocityResponse
4137
+ */
4138
+ export interface TcpVelocityResponse {
4139
+ /**
4140
+ * Error message in case of invalid TcpVelocityRequest.
4141
+ * @type {string}
4142
+ * @memberof TcpVelocityResponse
4143
+ */
4144
+ 'message'?: string;
4145
+ /**
4146
+ *
4147
+ * @type {string}
4148
+ * @memberof TcpVelocityResponse
4149
+ */
4150
+ 'kind': TcpVelocityResponseKindEnum;
4151
+ }
4152
+ export declare const TcpVelocityResponseKindEnum: {
4153
+ readonly TcpVelocityReceived: "TCP_VELOCITY_RECEIVED";
4154
+ };
4155
+ export type TcpVelocityResponseKindEnum = typeof TcpVelocityResponseKindEnum[keyof typeof TcpVelocityResponseKindEnum];
4222
4156
  /**
4223
4157
  *
4224
4158
  * @export
@@ -4286,6 +4220,46 @@ export declare const TrajectoryDataMessageTypeEnum: {
4286
4220
  readonly TrajectoryData: "TrajectoryData";
4287
4221
  };
4288
4222
  export type TrajectoryDataMessageTypeEnum = typeof TrajectoryDataMessageTypeEnum[keyof typeof TrajectoryDataMessageTypeEnum];
4223
+ /**
4224
+ * 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.
4225
+ * @export
4226
+ * @interface TrajectoryDetails
4227
+ */
4228
+ export interface TrajectoryDetails {
4229
+ /**
4230
+ * Unique identifier of the trajectory being executed.
4231
+ * @type {string}
4232
+ * @memberof TrajectoryDetails
4233
+ */
4234
+ 'trajectory': string;
4235
+ /**
4236
+ * Current location of motion group on the trajectory.
4237
+ * @type {number}
4238
+ * @memberof TrajectoryDetails
4239
+ */
4240
+ 'location': number;
4241
+ /**
4242
+ *
4243
+ * @type {TrajectoryDetailsState}
4244
+ * @memberof TrajectoryDetails
4245
+ */
4246
+ 'state': TrajectoryDetailsState;
4247
+ /**
4248
+ * Discriminator for OpenApi generators, which is always \"TRAJECTORY\" for this schema.
4249
+ * @type {string}
4250
+ * @memberof TrajectoryDetails
4251
+ */
4252
+ 'kind': TrajectoryDetailsKindEnum;
4253
+ }
4254
+ export declare const TrajectoryDetailsKindEnum: {
4255
+ readonly Trajectory: "TRAJECTORY";
4256
+ };
4257
+ export type TrajectoryDetailsKindEnum = typeof TrajectoryDetailsKindEnum[keyof typeof TrajectoryDetailsKindEnum];
4258
+ /**
4259
+ * @type TrajectoryDetailsState
4260
+ * @export
4261
+ */
4262
+ export type TrajectoryDetailsState = EndOfTrajectory | PausedByRequest | PausedOnIO | Running1 | WaitForIO;
4289
4263
  /**
4290
4264
  *
4291
4265
  * @export
@@ -4297,7 +4271,7 @@ export interface TrajectoryId {
4297
4271
  * @type {string}
4298
4272
  * @memberof TrajectoryId
4299
4273
  */
4300
- 'message_type': TrajectoryIdMessageTypeEnum;
4274
+ 'message_type'?: TrajectoryIdMessageTypeEnum;
4301
4275
  /**
4302
4276
  * The identifier of the trajectory which was returned by the [addTrajectory](addTrajectory) endpoint.
4303
4277
  * @type {string}
@@ -4593,6 +4567,23 @@ export interface VirtualRobotConfiguration {
4593
4567
  */
4594
4568
  'content': string;
4595
4569
  }
4570
+ /**
4571
+ *
4572
+ * @export
4573
+ * @interface WaitForIO
4574
+ */
4575
+ export interface WaitForIO {
4576
+ /**
4577
+ *
4578
+ * @type {string}
4579
+ * @memberof WaitForIO
4580
+ */
4581
+ 'kind': WaitForIOKindEnum;
4582
+ }
4583
+ export declare const WaitForIOKindEnum: {
4584
+ readonly WaitForIo: "WAIT_FOR_IO";
4585
+ };
4586
+ export type WaitForIOKindEnum = typeof WaitForIOKindEnum[keyof typeof WaitForIOKindEnum];
4596
4587
  /**
4597
4588
  * The value to compare with the current value of the input/output.
4598
4589
  * @export
@@ -6466,7 +6457,7 @@ export declare const MotionGroupApiFp: (configuration?: Configuration) => {
6466
6457
  * @param {*} [options] Override http request option.
6467
6458
  * @throws {RequiredError}
6468
6459
  */
6469
- streamMotionGroupState(cell: string, motionGroup: string, responseRate?: number, responseCoordinateSystem?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<MotionGroupStateWithoutPayload>>;
6460
+ streamMotionGroupState(cell: string, motionGroup: string, responseRate?: number, responseCoordinateSystem?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<MotionGroupState>>;
6470
6461
  };
6471
6462
  /**
6472
6463
  * MotionGroupApi - factory interface
@@ -6502,7 +6493,7 @@ export declare const MotionGroupApiFactory: (configuration?: Configuration, base
6502
6493
  * @param {*} [options] Override http request option.
6503
6494
  * @throws {RequiredError}
6504
6495
  */
6505
- streamMotionGroupState(cell: string, motionGroup: string, responseRate?: number, responseCoordinateSystem?: string, options?: RawAxiosRequestConfig): AxiosPromise<MotionGroupStateWithoutPayload>;
6496
+ streamMotionGroupState(cell: string, motionGroup: string, responseRate?: number, responseCoordinateSystem?: string, options?: RawAxiosRequestConfig): AxiosPromise<MotionGroupState>;
6506
6497
  };
6507
6498
  /**
6508
6499
  * MotionGroupApi - object-oriented interface
@@ -6543,7 +6534,7 @@ export declare class MotionGroupApi extends BaseAPI {
6543
6534
  * @throws {RequiredError}
6544
6535
  * @memberof MotionGroupApi
6545
6536
  */
6546
- streamMotionGroupState(cell: string, motionGroup: string, responseRate?: number, responseCoordinateSystem?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<MotionGroupStateWithoutPayload, any>>;
6537
+ streamMotionGroupState(cell: string, motionGroup: string, responseRate?: number, responseCoordinateSystem?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<MotionGroupState, any>>;
6547
6538
  }
6548
6539
  /**
6549
6540
  * ProgramApi - axios parameter creator