@wandelbots/nova-api 25.6.0-dev.35 → 25.6.0-dev.37

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
@@ -109,7 +109,7 @@ export interface AddTrajectoryError {
109
109
  * @type AddTrajectoryErrorData
110
110
  * @export
111
111
  */
112
- export type AddTrajectoryErrorData = Collision2 | InconsitentTrajectorySize | InvalidDof | JointLimitExceeded | NanValue | TcpRequired | TorqueExceeded;
112
+ export type AddTrajectoryErrorData = CollisionError | InconsitentTrajectorySize | InvalidDof | JointLimitExceeded | NanValue | TcpRequired | TorqueExceeded;
113
113
  /**
114
114
  *
115
115
  * @export
@@ -364,6 +364,37 @@ export declare const CapsuleShapeTypeEnum: {
364
364
  readonly Capsule: "capsule";
365
365
  };
366
366
  export type CapsuleShapeTypeEnum = typeof CapsuleShapeTypeEnum[keyof typeof CapsuleShapeTypeEnum];
367
+ /**
368
+ *
369
+ * @export
370
+ * @interface CartesianLimits
371
+ */
372
+ export interface CartesianLimits {
373
+ /**
374
+ *
375
+ * @type {number}
376
+ * @memberof CartesianLimits
377
+ */
378
+ 'velocity'?: number;
379
+ /**
380
+ *
381
+ * @type {number}
382
+ * @memberof CartesianLimits
383
+ */
384
+ 'acceleration'?: number;
385
+ /**
386
+ *
387
+ * @type {number}
388
+ * @memberof CartesianLimits
389
+ */
390
+ 'orientation_velocity'?: number;
391
+ /**
392
+ *
393
+ * @type {number}
394
+ * @memberof CartesianLimits
395
+ */
396
+ 'orientation_acceleration'?: number;
397
+ }
367
398
  /**
368
399
  * To create a robot cell, only a valid name is required. Once created, a robot cell provides access to the Wandelbots NOVA foundation services. The configuration can be customized, e.g. robot controllers, also within apps.
369
400
  * @export
@@ -484,19 +515,6 @@ export interface Collision {
484
515
  */
485
516
  'position_on_b'?: CollisionContact;
486
517
  }
487
- /**
488
- *
489
- * @export
490
- * @interface Collision2
491
- */
492
- export interface Collision2 {
493
- /**
494
- *
495
- * @type {FeedbackCollision}
496
- * @memberof Collision2
497
- */
498
- 'collision'?: FeedbackCollision;
499
- }
500
518
  /**
501
519
  *
502
520
  * @export
@@ -516,6 +534,19 @@ export interface CollisionContact {
516
534
  */
517
535
  'world'?: Array<number>;
518
536
  }
537
+ /**
538
+ *
539
+ * @export
540
+ * @interface CollisionError
541
+ */
542
+ export interface CollisionError {
543
+ /**
544
+ *
545
+ * @type {FeedbackCollision}
546
+ * @memberof CollisionError
547
+ */
548
+ 'collision'?: FeedbackCollision;
549
+ }
519
550
  /**
520
551
  *
521
552
  * @export
@@ -940,6 +971,23 @@ export declare const Direction: {
940
971
  readonly DirectionBackward: "DIRECTION_BACKWARD";
941
972
  };
942
973
  export type Direction = typeof Direction[keyof typeof Direction];
974
+ /**
975
+ *
976
+ * @export
977
+ * @interface EndOfTrajectory
978
+ */
979
+ export interface EndOfTrajectory {
980
+ /**
981
+ *
982
+ * @type {string}
983
+ * @memberof EndOfTrajectory
984
+ */
985
+ 'kind': EndOfTrajectoryKindEnum;
986
+ }
987
+ export declare const EndOfTrajectoryKindEnum: {
988
+ readonly EndOfTrajectory: "END_OF_TRAJECTORY";
989
+ };
990
+ export type EndOfTrajectoryKindEnum = typeof EndOfTrajectoryKindEnum[keyof typeof EndOfTrajectoryKindEnum];
943
991
  /**
944
992
  *
945
993
  * @export
@@ -953,16 +1001,44 @@ export interface Error2 {
953
1001
  */
954
1002
  'message': string;
955
1003
  }
1004
+ /**
1005
+ * 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.
1006
+ * @export
1007
+ * @interface Execute
1008
+ */
1009
+ export interface Execute {
1010
+ /**
1011
+ * Commanded joint position of each joint in [rad]. This command was sent in the time step the corresponding state was received.
1012
+ * @type {Array<number>}
1013
+ * @memberof Execute
1014
+ */
1015
+ 'joint_position': Array<number>;
1016
+ /**
1017
+ *
1018
+ * @type {ExecuteDetails}
1019
+ * @memberof Execute
1020
+ */
1021
+ 'details'?: ExecuteDetails;
1022
+ }
1023
+ /**
1024
+ * @type ExecuteDetails
1025
+ * @export
1026
+ */
1027
+ export type ExecuteDetails = {
1028
+ kind: 'JOGGING';
1029
+ } & JoggingDetails | {
1030
+ kind: 'TRAJECTORY';
1031
+ } & TrajectoryDetails;
956
1032
  /**
957
1033
  * @type ExecuteJoggingRequest
958
1034
  * @export
959
1035
  */
960
- export type ExecuteJoggingRequest = InitializeJoggingRequest | JointVelocityRequest | TcpVelocityRequest;
1036
+ export type ExecuteJoggingRequest = InitializeJoggingRequest | JointVelocityRequest | PauseJoggingRequest | TcpVelocityRequest;
961
1037
  /**
962
1038
  * @type ExecuteJoggingResponse
963
1039
  * @export
964
1040
  */
965
- export type ExecuteJoggingResponse = InitializeJoggingResponse | JoggingErrorResponse | JoggingResponse;
1041
+ export type ExecuteJoggingResponse = InitializeJoggingResponse | JointVelocityResponse | MovementErrorResponse | PauseJoggingResponse | TcpVelocityResponse;
966
1042
  /**
967
1043
  * @type ExecuteTrajectoryRequest
968
1044
  * @export
@@ -972,7 +1048,7 @@ export type ExecuteTrajectoryRequest = InitializeMovementRequest | PauseMovement
972
1048
  * @type ExecuteTrajectoryResponse
973
1049
  * @export
974
1050
  */
975
- export type ExecuteTrajectoryResponse = InitializeMovementResponse | Movement | MovementError | PauseMovementResponse | PlaybackSpeedResponse | Standstill;
1051
+ export type ExecuteTrajectoryResponse = InitializeMovementResponse | MovementErrorResponse | PauseMovementResponse | PlaybackSpeedResponse | StartMovementResponse;
976
1052
  /**
977
1053
  * A datapoint inside external joint stream.
978
1054
  * @export
@@ -1558,37 +1634,28 @@ export declare const InitializeJoggingRequestMessageTypeEnum: {
1558
1634
  };
1559
1635
  export type InitializeJoggingRequestMessageTypeEnum = typeof InitializeJoggingRequestMessageTypeEnum[keyof typeof InitializeJoggingRequestMessageTypeEnum];
1560
1636
  /**
1561
- * Response to an InitializeJoggingRequest.
1637
+ * Acknowledgment to an InitializeJoggingRequest.
1562
1638
  * @export
1563
1639
  * @interface InitializeJoggingResponse
1564
1640
  */
1565
1641
  export interface InitializeJoggingResponse {
1566
1642
  /**
1567
- *
1568
- * @type {InitializeJoggingResponseInitResponse}
1643
+ * Error message in case of invalid InitializeJoggingRequest.
1644
+ * @type {string}
1569
1645
  * @memberof InitializeJoggingResponse
1570
1646
  */
1571
- 'init_response': InitializeJoggingResponseInitResponse;
1572
- }
1573
- /**
1574
- *
1575
- * @export
1576
- * @interface InitializeJoggingResponseInitResponse
1577
- */
1578
- export interface InitializeJoggingResponseInitResponse {
1579
- /**
1580
- * Indicates if the jogging control is ready for execution.
1581
- * @type {boolean}
1582
- * @memberof InitializeJoggingResponseInitResponse
1583
- */
1584
- 'succeeded': boolean;
1647
+ 'message'?: string;
1585
1648
  /**
1586
- * Error message in case of invalid InitializeMovementRequest.
1649
+ *
1587
1650
  * @type {string}
1588
- * @memberof InitializeJoggingResponseInitResponse
1651
+ * @memberof InitializeJoggingResponse
1589
1652
  */
1590
- 'error_message'?: string;
1653
+ 'kind': InitializeJoggingResponseKindEnum;
1591
1654
  }
1655
+ export declare const InitializeJoggingResponseKindEnum: {
1656
+ readonly InitializeReceived: "INITIALIZE_RECEIVED";
1657
+ };
1658
+ export type InitializeJoggingResponseKindEnum = typeof InitializeJoggingResponseKindEnum[keyof typeof InitializeJoggingResponseKindEnum];
1592
1659
  /**
1593
1660
  * 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.
1594
1661
  * @export
@@ -1647,31 +1714,28 @@ export type InitializeMovementRequestTrajectory = {
1647
1714
  */
1648
1715
  export interface InitializeMovementResponse {
1649
1716
  /**
1650
- *
1651
- * @type {InitializeMovementResponseInitResponse}
1717
+ * Error message in case of invalid InitializeMovementRequest.
1718
+ * @type {string}
1652
1719
  * @memberof InitializeMovementResponse
1653
1720
  */
1654
- 'init_response': InitializeMovementResponseInitResponse;
1655
- }
1656
- /**
1657
- *
1658
- * @export
1659
- * @interface InitializeMovementResponseInitResponse
1660
- */
1661
- export interface InitializeMovementResponseInitResponse {
1721
+ 'message'?: string;
1662
1722
  /**
1663
- * Indicates if the trajectory was successfully locked and is ready for execution by sending a StartMovementRequest. Send PlaybackSpeedRequest to override the planned velocity.
1664
- * @type {boolean}
1665
- * @memberof InitializeMovementResponseInitResponse
1723
+ * Error can occur if joint trajectory was added by [InitializeMovementRequest](InitializeMovementRequest) and the trajectory is invalid.
1724
+ * @type {AddTrajectoryError}
1725
+ * @memberof InitializeMovementResponse
1666
1726
  */
1667
- 'succeeded': boolean;
1727
+ 'add_trajectory_error'?: AddTrajectoryError;
1668
1728
  /**
1669
- * Error message in case of invalid InitializeMovementRequest.
1729
+ *
1670
1730
  * @type {string}
1671
- * @memberof InitializeMovementResponseInitResponse
1731
+ * @memberof InitializeMovementResponse
1672
1732
  */
1673
- 'error_message'?: string;
1733
+ 'kind': InitializeMovementResponseKindEnum;
1674
1734
  }
1735
+ export declare const InitializeMovementResponseKindEnum: {
1736
+ readonly InitializeReceived: "INITIALIZE_RECEIVED";
1737
+ };
1738
+ export type InitializeMovementResponseKindEnum = typeof InitializeMovementResponseKindEnum[keyof typeof InitializeMovementResponseKindEnum];
1675
1739
  /**
1676
1740
  * 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.
1677
1741
  * @export
@@ -1759,10 +1823,10 @@ export interface InverseKinematicsRequest {
1759
1823
  'mounting'?: Pose;
1760
1824
  /**
1761
1825
  * Joint position limits in [rad], indexed starting from base.
1762
- * @type {Array<PlanningLimitsLimitRange>}
1826
+ * @type {Array<LimitRange>}
1763
1827
  * @memberof InverseKinematicsRequest
1764
1828
  */
1765
- 'joint_position_limits'?: Array<PlanningLimitsLimitRange>;
1829
+ 'joint_position_limits'?: Array<LimitRange>;
1766
1830
  /**
1767
1831
  * Collision scenes to be respected by the motion planner. Each contains the single motion group which is planned for. Scenes are checked individually along the trajectory and independently of other scenes. To respect the safety zones of the controller, fetch the safety zones, link and tool shapes from the controller and add one scene made up of those. To respect the safety zones of the controller and check for collision: 1. Fetch the safety zones, link and tool shapes from the controller. 2. Add the fetched zones, links and tools to a scene. 3. Create other scenes from your own 3D data as needed. 4. Execute this endpoint. 5. The response highlights the scenes in which a collision was detected by key.
1768
1832
  * @type {{ [key: string]: SingleMotionGroupCollisionScene; }}
@@ -1786,171 +1850,76 @@ export interface InverseKinematicsResponse {
1786
1850
  'joints': Array<Array<Array<number>>>;
1787
1851
  }
1788
1852
  /**
1789
- * Response signalling an error during jogging execution. This response is sent in case of an unexpected error, e.g. controller disconnects.
1790
- * @export
1791
- * @interface JoggingErrorResponse
1792
- */
1793
- export interface JoggingErrorResponse {
1794
- /**
1795
- *
1796
- * @type {JoggingErrorResponseError}
1797
- * @memberof JoggingErrorResponse
1798
- */
1799
- 'error': JoggingErrorResponseError;
1800
- }
1801
- /**
1802
- *
1803
- * @export
1804
- * @interface JoggingErrorResponseError
1805
- */
1806
- export interface JoggingErrorResponseError {
1807
- /**
1808
- * Error description.
1809
- * @type {string}
1810
- * @memberof JoggingErrorResponseError
1811
- */
1812
- 'error_message': string;
1813
- }
1814
- /**
1815
- *
1853
+ * 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.
1816
1854
  * @export
1817
- * @interface JoggingPausedCollision
1855
+ * @interface JoggingDetails
1818
1856
  */
1819
- export interface JoggingPausedCollision {
1857
+ export interface JoggingDetails {
1820
1858
  /**
1821
1859
  *
1822
- * @type {JoggingPausedCollisionPausedNearCollision}
1823
- * @memberof JoggingPausedCollision
1860
+ * @type {JoggingDetailsState}
1861
+ * @memberof JoggingDetails
1824
1862
  */
1825
- 'paused_near_collision': JoggingPausedCollisionPausedNearCollision;
1826
- }
1827
- /**
1828
- *
1829
- * @export
1830
- * @interface JoggingPausedCollisionPausedNearCollision
1831
- */
1832
- export interface JoggingPausedCollisionPausedNearCollision {
1863
+ 'state': JoggingDetailsState;
1833
1864
  /**
1834
1865
  *
1835
1866
  * @type {string}
1836
- * @memberof JoggingPausedCollisionPausedNearCollision
1837
- */
1838
- 'description'?: string;
1839
- }
1840
- /**
1841
- *
1842
- * @export
1843
- * @interface JoggingPausedJointLimit
1844
- */
1845
- export interface JoggingPausedJointLimit {
1846
- /**
1847
- *
1848
- * @type {JoggingPausedJointLimitPausedNearJointLimit}
1849
- * @memberof JoggingPausedJointLimit
1850
- */
1851
- 'paused_near_joint_limit': JoggingPausedJointLimitPausedNearJointLimit;
1852
- }
1853
- /**
1854
- *
1855
- * @export
1856
- * @interface JoggingPausedJointLimitPausedNearJointLimit
1857
- */
1858
- export interface JoggingPausedJointLimitPausedNearJointLimit {
1859
- /**
1860
- *
1861
- * @type {Array<number>}
1862
- * @memberof JoggingPausedJointLimitPausedNearJointLimit
1867
+ * @memberof JoggingDetails
1863
1868
  */
1864
- 'joint_indices'?: Array<number>;
1869
+ 'kind': JoggingDetailsKindEnum;
1865
1870
  }
1871
+ export declare const JoggingDetailsKindEnum: {
1872
+ readonly Jogging: "JOGGING";
1873
+ };
1874
+ export type JoggingDetailsKindEnum = typeof JoggingDetailsKindEnum[keyof typeof JoggingDetailsKindEnum];
1866
1875
  /**
1867
- *
1876
+ * @type JoggingDetailsState
1868
1877
  * @export
1869
- * @interface JoggingPausedOnIO
1870
1878
  */
1871
- export interface JoggingPausedOnIO {
1872
- /**
1873
- *
1874
- * @type {object}
1875
- * @memberof JoggingPausedOnIO
1876
- */
1877
- 'paused_on_io': object;
1878
- }
1879
+ export type JoggingDetailsState = PausedByUser | PausedNearCollision | PausedNearJointLimit | PausedOnIO | Running;
1879
1880
  /**
1880
1881
  *
1881
1882
  * @export
1882
- * @interface JoggingPausedUserRequest
1883
- */
1884
- export interface JoggingPausedUserRequest {
1885
- /**
1886
- *
1887
- * @type {object}
1888
- * @memberof JoggingPausedUserRequest
1889
- */
1890
- 'paused_by_user_request': object;
1891
- }
1892
- /**
1893
- * Sent during jogging movement, response-rate closest to the nearest multiple of controller step-rate but not exceeding the configured rate.
1894
- * @export
1895
- * @interface JoggingResponse
1883
+ * @interface JointLimitExceeded
1896
1884
  */
1897
- export interface JoggingResponse {
1885
+ export interface JointLimitExceeded {
1898
1886
  /**
1899
1887
  *
1900
- * @type {JoggingResponseJogging}
1901
- * @memberof JoggingResponse
1888
+ * @type {FeedbackJointLimitExceeded}
1889
+ * @memberof JointLimitExceeded
1902
1890
  */
1903
- 'jogging': JoggingResponseJogging;
1891
+ 'joint_limit_exceeded'?: FeedbackJointLimitExceeded;
1904
1892
  }
1905
1893
  /**
1906
1894
  *
1907
1895
  * @export
1908
- * @interface JoggingResponseJogging
1896
+ * @interface JointLimits
1909
1897
  */
1910
- export interface JoggingResponseJogging {
1898
+ export interface JointLimits {
1911
1899
  /**
1912
1900
  *
1913
- * @type {JoggingState}
1914
- * @memberof JoggingResponseJogging
1901
+ * @type {LimitRange}
1902
+ * @memberof JointLimits
1915
1903
  */
1916
- 'jogging_state': JoggingState;
1904
+ 'position'?: LimitRange;
1917
1905
  /**
1918
1906
  *
1919
- * @type {RobotControllerState}
1920
- * @memberof JoggingResponseJogging
1907
+ * @type {number}
1908
+ * @memberof JointLimits
1921
1909
  */
1922
- 'robot_controller_state': RobotControllerState;
1923
- }
1924
- /**
1925
- *
1926
- * @export
1927
- * @interface JoggingRunning
1928
- */
1929
- export interface JoggingRunning {
1910
+ 'velocity'?: number;
1930
1911
  /**
1931
1912
  *
1932
- * @type {object}
1933
- * @memberof JoggingRunning
1913
+ * @type {number}
1914
+ * @memberof JointLimits
1934
1915
  */
1935
- 'running': object;
1936
- }
1937
- /**
1938
- * @type JoggingState
1939
- * @export
1940
- */
1941
- export type JoggingState = JoggingPausedCollision | JoggingPausedJointLimit | JoggingPausedOnIO | JoggingPausedUserRequest | JoggingRunning;
1942
- /**
1943
- *
1944
- * @export
1945
- * @interface JointLimitExceeded
1946
- */
1947
- export interface JointLimitExceeded {
1916
+ 'acceleration'?: number;
1948
1917
  /**
1949
1918
  *
1950
- * @type {FeedbackJointLimitExceeded}
1951
- * @memberof JointLimitExceeded
1919
+ * @type {number}
1920
+ * @memberof JointLimits
1952
1921
  */
1953
- 'joint_limit_exceeded'?: FeedbackJointLimitExceeded;
1922
+ 'torque'?: number;
1954
1923
  }
1955
1924
  /**
1956
1925
  *
@@ -2000,6 +1969,29 @@ export declare const JointVelocityRequestMessageTypeEnum: {
2000
1969
  readonly JointVelocityRequest: "JointVelocityRequest";
2001
1970
  };
2002
1971
  export type JointVelocityRequestMessageTypeEnum = typeof JointVelocityRequestMessageTypeEnum[keyof typeof JointVelocityRequestMessageTypeEnum];
1972
+ /**
1973
+ * Acknowledgment to a JointVelocityRequest.
1974
+ * @export
1975
+ * @interface JointVelocityResponse
1976
+ */
1977
+ export interface JointVelocityResponse {
1978
+ /**
1979
+ * Error message in case of invalid JointVelocityRequest.
1980
+ * @type {string}
1981
+ * @memberof JointVelocityResponse
1982
+ */
1983
+ 'message'?: string;
1984
+ /**
1985
+ *
1986
+ * @type {string}
1987
+ * @memberof JointVelocityResponse
1988
+ */
1989
+ 'kind': JointVelocityResponseKindEnum;
1990
+ }
1991
+ export declare const JointVelocityResponseKindEnum: {
1992
+ readonly JointVelocityReceived: "JOINT_VELOCITY_RECEIVED";
1993
+ };
1994
+ export type JointVelocityResponseKindEnum = typeof JointVelocityResponseKindEnum[keyof typeof JointVelocityResponseKindEnum];
2003
1995
  /**
2004
1996
  * 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.
2005
1997
  * @export
@@ -2168,6 +2160,75 @@ export declare const LicenseStatusEnum: {
2168
2160
  readonly NotFound: "NOT_FOUND";
2169
2161
  };
2170
2162
  export type LicenseStatusEnum = typeof LicenseStatusEnum[keyof typeof LicenseStatusEnum];
2163
+ /**
2164
+ *
2165
+ * @export
2166
+ * @interface LimitConfig
2167
+ */
2168
+ export interface LimitConfig {
2169
+ /**
2170
+ *
2171
+ * @type {LimitSet}
2172
+ * @memberof LimitConfig
2173
+ */
2174
+ 'physical_limits'?: LimitSet;
2175
+ /**
2176
+ *
2177
+ * @type {OperationLimits}
2178
+ * @memberof LimitConfig
2179
+ */
2180
+ 'operation_limits'?: OperationLimits;
2181
+ }
2182
+ /**
2183
+ * The upper_limit must be greater then the lower_limit.
2184
+ * @export
2185
+ * @interface LimitRange
2186
+ */
2187
+ export interface LimitRange {
2188
+ /**
2189
+ *
2190
+ * @type {number}
2191
+ * @memberof LimitRange
2192
+ */
2193
+ 'lower_limit'?: number;
2194
+ /**
2195
+ *
2196
+ * @type {number}
2197
+ * @memberof LimitRange
2198
+ */
2199
+ 'upper_limit'?: number;
2200
+ }
2201
+ /**
2202
+ *
2203
+ * @export
2204
+ * @interface LimitSet
2205
+ */
2206
+ export interface LimitSet {
2207
+ /**
2208
+ *
2209
+ * @type {Array<JointLimits>}
2210
+ * @memberof LimitSet
2211
+ */
2212
+ 'joints'?: Array<JointLimits>;
2213
+ /**
2214
+ *
2215
+ * @type {CartesianLimits}
2216
+ * @memberof LimitSet
2217
+ */
2218
+ 'tcp'?: CartesianLimits;
2219
+ /**
2220
+ *
2221
+ * @type {CartesianLimits}
2222
+ * @memberof LimitSet
2223
+ */
2224
+ 'elbow'?: CartesianLimits;
2225
+ /**
2226
+ *
2227
+ * @type {CartesianLimits}
2228
+ * @memberof LimitSet
2229
+ */
2230
+ 'flange'?: CartesianLimits;
2231
+ }
2171
2232
  /**
2172
2233
  * If a limit is not set, the default value will be used.
2173
2234
  * @export
@@ -2372,10 +2433,10 @@ export interface MotionGroupDescription {
2372
2433
  };
2373
2434
  /**
2374
2435
  *
2375
- * @type {PlanningLimits}
2436
+ * @type {LimitConfig}
2376
2437
  * @memberof MotionGroupDescription
2377
2438
  */
2378
- 'global_limits': PlanningLimits;
2439
+ 'global_limits': LimitConfig;
2379
2440
  /**
2380
2441
  * Maps a payload name to its configuration. Key must be a payload identifier. Values are payload objects.
2381
2442
  * @type {{ [key: string]: Payload; }}
@@ -2467,17 +2528,17 @@ export interface MotionGroupJoints {
2467
2528
  'torques'?: Array<number>;
2468
2529
  }
2469
2530
  /**
2470
- *
2531
+ * Presents the current state of the motion group.
2471
2532
  * @export
2472
2533
  * @interface MotionGroupState
2473
2534
  */
2474
2535
  export interface MotionGroupState {
2475
2536
  /**
2476
- * Timestamp indicating when the represented information was received from the robot controller.
2537
+ * Timestamp for when data was received from the robot controller.
2477
2538
  * @type {string}
2478
2539
  * @memberof MotionGroupState
2479
2540
  */
2480
- 'timestamp'?: string;
2541
+ 'timestamp': string;
2481
2542
  /**
2482
2543
  * 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.
2483
2544
  * @type {number}
@@ -2509,59 +2570,59 @@ export interface MotionGroupState {
2509
2570
  */
2510
2571
  'joint_limit_reached': MotionGroupStateJointLimitReached;
2511
2572
  /**
2512
- * Current joint velocity of each joint in [rad/s]
2513
- * @type {Joints}
2514
- * @memberof MotionGroupState
2515
- */
2516
- 'joint_velocity': Joints;
2517
- /**
2518
- * Current joint torque of each joint in [Nm]. Is only available if the robot controller supports it (e.g. available for UR Controllers).
2573
+ * Current joint torque of each joint in [Nm]. Is only available if the robot controller supports it, e.g. available for UR controllers.
2519
2574
  * @type {Joints}
2520
2575
  * @memberof MotionGroupState
2521
2576
  */
2522
2577
  'joint_torque'?: Joints;
2523
2578
  /**
2524
- * Current Current at TCP in [A]. Is only available if the robot controller supports it, e.g. available for UR Controllers.
2579
+ * Current at TCP in [A]. Is only available if the robot controller supports it, e.g. available for UR controllers.
2525
2580
  * @type {Joints}
2526
2581
  * @memberof MotionGroupState
2527
2582
  */
2528
2583
  'joint_current'?: Joints;
2529
2584
  /**
2530
- * 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.
2585
+ * 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.
2531
2586
  * @type {Pose}
2532
2587
  * @memberof MotionGroupState
2533
2588
  */
2534
2589
  'flange_pose'?: Pose;
2535
2590
  /**
2536
- * Unique identifier addressing the TCP currently set.
2591
+ * Unique identifier addressing the active TCP. Might not be returned for positioners as some do not support TCPs, depending on the model.
2537
2592
  * @type {string}
2538
2593
  * @memberof MotionGroupState
2539
2594
  */
2540
- 'tcp': string;
2595
+ 'tcp'?: string;
2541
2596
  /**
2542
- * 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.
2597
+ * 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.
2543
2598
  * @type {Pose}
2544
2599
  * @memberof MotionGroupState
2545
2600
  */
2546
- 'tcp_pose': Pose;
2601
+ 'tcp_pose'?: Pose;
2547
2602
  /**
2548
- * 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.
2549
- * @type {MotionVector}
2603
+ * 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.
2604
+ * @type {string}
2550
2605
  * @memberof MotionGroupState
2551
2606
  */
2552
- 'tcp_velocity': MotionVector;
2607
+ 'coordinate_system'?: string;
2553
2608
  /**
2554
- * Unique identifier addressing the reference coordinate system of the cartesian data. Default is the world coordinate system of corresponding controller.
2609
+ * Unique identifier addressing the active payload. Only fetchable via GET endpoint, not available in WebSocket.
2555
2610
  * @type {string}
2556
2611
  * @memberof MotionGroupState
2557
2612
  */
2558
- 'coordinate_system': string;
2613
+ 'payload'?: string;
2559
2614
  /**
2560
- * Unique identifier addressing the Payload currently set. Only fetchable via GET endpoint, not available in WebSocket.
2561
- * @type {string}
2615
+ * Indicates whether the motion group is in standstill. Convenience: Signals that NOVA treats measured joint velocities as 0.
2616
+ * @type {boolean}
2562
2617
  * @memberof MotionGroupState
2563
2618
  */
2564
- 'payload'?: string;
2619
+ 'standstill': boolean;
2620
+ /**
2621
+ * 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.
2622
+ * @type {Execute}
2623
+ * @memberof MotionGroupState
2624
+ */
2625
+ 'execute'?: Execute;
2565
2626
  }
2566
2627
  /**
2567
2628
  * 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.
@@ -2577,102 +2638,11 @@ export interface MotionGroupStateJointLimitReached {
2577
2638
  'limit_reached': Array<boolean>;
2578
2639
  }
2579
2640
  /**
2580
- * Presents the current state of the motion group.
2641
+ * Collection of information on the current state of the robot.
2581
2642
  * @export
2582
- * @interface MotionGroupStateWithoutPayload
2643
+ * @interface MotionState
2583
2644
  */
2584
- export interface MotionGroupStateWithoutPayload {
2585
- /**
2586
- * Timestamp indicating when the represented information was received from the robot controller.
2587
- * @type {string}
2588
- * @memberof MotionGroupStateWithoutPayload
2589
- */
2590
- 'timestamp'?: string;
2591
- /**
2592
- * 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.
2593
- * @type {number}
2594
- * @memberof MotionGroupStateWithoutPayload
2595
- */
2596
- 'sequence_number': number;
2597
- /**
2598
- * Identifier of the motion group.
2599
- * @type {string}
2600
- * @memberof MotionGroupStateWithoutPayload
2601
- */
2602
- 'motion_group': string;
2603
- /**
2604
- * Convenience: Identifier of the robot controller the motion group is attached to.
2605
- * @type {string}
2606
- * @memberof MotionGroupStateWithoutPayload
2607
- */
2608
- 'controller': string;
2609
- /**
2610
- * Current joint position of each joint in [rad]
2611
- * @type {Joints}
2612
- * @memberof MotionGroupStateWithoutPayload
2613
- */
2614
- 'joint_position': Joints;
2615
- /**
2616
- * Indicates whether the joint is in a limit for all joints of the motion group.
2617
- * @type {MotionGroupStateJointLimitReached}
2618
- * @memberof MotionGroupStateWithoutPayload
2619
- */
2620
- 'joint_limit_reached': MotionGroupStateJointLimitReached;
2621
- /**
2622
- * Current joint velocity of each joint in [rad/s]
2623
- * @type {Joints}
2624
- * @memberof MotionGroupStateWithoutPayload
2625
- */
2626
- 'joint_velocity': Joints;
2627
- /**
2628
- * Current joint torque of each joint in [Nm]. Is only available if the robot controller supports it (e.g. available for UR Controllers).
2629
- * @type {Joints}
2630
- * @memberof MotionGroupStateWithoutPayload
2631
- */
2632
- 'joint_torque'?: Joints;
2633
- /**
2634
- * Current Current at TCP in [A]. Is only available if the robot controller supports it, e.g. available for UR Controllers.
2635
- * @type {Joints}
2636
- * @memberof MotionGroupStateWithoutPayload
2637
- */
2638
- 'joint_current'?: Joints;
2639
- /**
2640
- * 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.
2641
- * @type {Pose}
2642
- * @memberof MotionGroupStateWithoutPayload
2643
- */
2644
- 'flange_pose'?: Pose;
2645
- /**
2646
- * Unique identifier addressing the TCP currently set.
2647
- * @type {string}
2648
- * @memberof MotionGroupStateWithoutPayload
2649
- */
2650
- 'tcp': string;
2651
- /**
2652
- * 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.
2653
- * @type {Pose}
2654
- * @memberof MotionGroupStateWithoutPayload
2655
- */
2656
- 'tcp_pose': Pose;
2657
- /**
2658
- * 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.
2659
- * @type {MotionVector}
2660
- * @memberof MotionGroupStateWithoutPayload
2661
- */
2662
- 'tcp_velocity': MotionVector;
2663
- /**
2664
- * Unique identifier addressing the reference coordinate system of the cartesian data. Default is the world coordinate system of corresponding controller.
2665
- * @type {string}
2666
- * @memberof MotionGroupStateWithoutPayload
2667
- */
2668
- 'coordinate_system': string;
2669
- }
2670
- /**
2671
- * Collection of information on the current state of the robot.
2672
- * @export
2673
- * @interface MotionState
2674
- */
2675
- export interface MotionState {
2645
+ export interface MotionState {
2676
2646
  /**
2677
2647
  * Unique identifier of the motion group that executed the program
2678
2648
  * @type {string}
@@ -2693,94 +2663,28 @@ export interface MotionState {
2693
2663
  'state': RobotState;
2694
2664
  }
2695
2665
  /**
2696
- *
2666
+ * Error message in case an error occurs during movement execution.
2697
2667
  * @export
2698
- * @interface MotionVector
2668
+ * @interface MovementErrorResponse
2699
2669
  */
2700
- export interface MotionVector {
2701
- /**
2702
- * A three-dimensional vector [x, y, z] with double precision.
2703
- * @type {Array<number>}
2704
- * @memberof MotionVector
2705
- */
2706
- 'linear'?: Array<number>;
2707
- /**
2708
- * A three-dimensional vector [x, y, z] with double precision.
2709
- * @type {Array<number>}
2710
- * @memberof MotionVector
2711
- */
2712
- 'angular'?: Array<number>;
2670
+ export interface MovementErrorResponse {
2713
2671
  /**
2714
- * optional, unique name of base coordinate system, if empty world is used
2672
+ * Detailed error message describing the issue encountered during movement execution.
2715
2673
  * @type {string}
2716
- * @memberof MotionVector
2674
+ * @memberof MovementErrorResponse
2717
2675
  */
2718
- 'coordinate_system'?: string;
2719
- }
2720
- /**
2721
- * Sent during trajectory movement, response-rate closest to the nearest multiple of controller step-rate but not exceeding the configured rate.
2722
- * @export
2723
- * @interface Movement
2724
- */
2725
- export interface Movement {
2726
- /**
2727
- *
2728
- * @type {MovementMovement}
2729
- * @memberof Movement
2730
- */
2731
- 'movement': MovementMovement;
2732
- }
2733
- /**
2734
- * 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.
2735
- * @export
2736
- * @interface MovementError
2737
- */
2738
- export interface MovementError {
2676
+ 'message': string;
2739
2677
  /**
2740
2678
  *
2741
- * @type {MovementErrorError}
2742
- * @memberof MovementError
2743
- */
2744
- 'error': MovementErrorError;
2745
- }
2746
- /**
2747
- *
2748
- * @export
2749
- * @interface MovementErrorError
2750
- */
2751
- export interface MovementErrorError {
2752
- /**
2753
- * Human-readable error details that describes the error.
2754
2679
  * @type {string}
2755
- * @memberof MovementErrorError
2680
+ * @memberof MovementErrorResponse
2756
2681
  */
2757
- 'error_message': string;
2758
- }
2759
- /**
2760
- *
2761
- * @export
2762
- * @interface MovementMovement
2763
- */
2764
- export interface MovementMovement {
2765
- /**
2766
- * Remaining time in milliseconds (ms) to reach the end of the motion.
2767
- * @type {number}
2768
- * @memberof MovementMovement
2769
- */
2770
- 'time_to_end': number;
2771
- /**
2772
- * Current location of motion group on the trajectory.
2773
- * @type {number}
2774
- * @memberof MovementMovement
2775
- */
2776
- 'current_location': number;
2777
- /**
2778
- * Current state of the robot controller and moving motion group.
2779
- * @type {RobotControllerState}
2780
- * @memberof MovementMovement
2781
- */
2782
- 'state': RobotControllerState;
2682
+ 'kind': MovementErrorResponseKindEnum;
2783
2683
  }
2684
+ export declare const MovementErrorResponseKindEnum: {
2685
+ readonly Error: "ERROR";
2686
+ };
2687
+ export type MovementErrorResponseKindEnum = typeof MovementErrorResponseKindEnum[keyof typeof MovementErrorResponseKindEnum];
2784
2688
  /**
2785
2689
  *
2786
2690
  * @export
@@ -2830,6 +2734,37 @@ export declare const OperatingState: {
2830
2734
  readonly Inactive: "INACTIVE";
2831
2735
  };
2832
2736
  export type OperatingState = typeof OperatingState[keyof typeof OperatingState];
2737
+ /**
2738
+ *
2739
+ * @export
2740
+ * @interface OperationLimits
2741
+ */
2742
+ export interface OperationLimits {
2743
+ /**
2744
+ *
2745
+ * @type {LimitSet}
2746
+ * @memberof OperationLimits
2747
+ */
2748
+ 'auto_limits'?: LimitSet;
2749
+ /**
2750
+ *
2751
+ * @type {LimitSet}
2752
+ * @memberof OperationLimits
2753
+ */
2754
+ 'manual_limits'?: LimitSet;
2755
+ /**
2756
+ *
2757
+ * @type {LimitSet}
2758
+ * @memberof OperationLimits
2759
+ */
2760
+ 'manual_t1_limits'?: LimitSet;
2761
+ /**
2762
+ *
2763
+ * @type {LimitSet}
2764
+ * @memberof OperationLimits
2765
+ */
2766
+ 'manual_t2_limits'?: LimitSet;
2767
+ }
2833
2768
  /**
2834
2769
  * Current operation mode of the configured robot controller. Operation modes in which the attached motion groups can be moved are: - OPERATION_MODE_MANUAL (if enabling switch is pressed) - OPERATION_MODE_MANUAL_T1 (if enabling switch is pressed) - OPERATION_MODE_MANUAL_T2 (if enabling switch is pressed) - OPERATION_MODE_AUTO (without needing to press enabling switch) All other modes are considered as non-operational.
2835
2770
  * @export
@@ -3003,6 +2938,46 @@ export declare const PathLinePathDefinitionNameEnum: {
3003
2938
  readonly PathLine: "PathLine";
3004
2939
  };
3005
2940
  export type PathLinePathDefinitionNameEnum = typeof PathLinePathDefinitionNameEnum[keyof typeof PathLinePathDefinitionNameEnum];
2941
+ /**
2942
+ * Request to pause jogging. If successful, `execute` jogging state in [MotionGroupState](MotionGroupState.yaml) is set to `PAUSED_BY_USER`.
2943
+ * @export
2944
+ * @interface PauseJoggingRequest
2945
+ */
2946
+ export interface PauseJoggingRequest {
2947
+ /**
2948
+ * Type specifier for server, set automatically.
2949
+ * @type {string}
2950
+ * @memberof PauseJoggingRequest
2951
+ */
2952
+ 'message_type'?: PauseJoggingRequestMessageTypeEnum;
2953
+ }
2954
+ export declare const PauseJoggingRequestMessageTypeEnum: {
2955
+ readonly PauseJoggingRequest: "PauseJoggingRequest";
2956
+ };
2957
+ export type PauseJoggingRequestMessageTypeEnum = typeof PauseJoggingRequestMessageTypeEnum[keyof typeof PauseJoggingRequestMessageTypeEnum];
2958
+ /**
2959
+ * Acknowledgment to a PauseJoggingRequest.
2960
+ * @export
2961
+ * @interface PauseJoggingResponse
2962
+ */
2963
+ export interface PauseJoggingResponse {
2964
+ /**
2965
+ * Error message in case of invalid PauseJoggingRequest.
2966
+ * @type {string}
2967
+ * @memberof PauseJoggingResponse
2968
+ */
2969
+ 'message'?: string;
2970
+ /**
2971
+ *
2972
+ * @type {string}
2973
+ * @memberof PauseJoggingResponse
2974
+ */
2975
+ 'kind': PauseJoggingResponseKindEnum;
2976
+ }
2977
+ export declare const PauseJoggingResponseKindEnum: {
2978
+ readonly PauseReceived: "PAUSE_RECEIVED";
2979
+ };
2980
+ export type PauseJoggingResponseKindEnum = typeof PauseJoggingResponseKindEnum[keyof typeof PauseJoggingResponseKindEnum];
3006
2981
  /**
3007
2982
  * 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.
3008
2983
  * @export
@@ -3015,49 +2990,34 @@ export interface PauseMovementRequest {
3015
2990
  * @memberof PauseMovementRequest
3016
2991
  */
3017
2992
  'message_type'?: PauseMovementRequestMessageTypeEnum;
3018
- /**
3019
- * Defaults to `true`. Set to true to get a response signalling successful initiation to pause the movement.
3020
- * @type {boolean}
3021
- * @memberof PauseMovementRequest
3022
- */
3023
- 'send_response'?: boolean;
3024
2993
  }
3025
2994
  export declare const PauseMovementRequestMessageTypeEnum: {
3026
2995
  readonly PauseMovementRequest: "PauseMovementRequest";
3027
2996
  };
3028
2997
  export type PauseMovementRequestMessageTypeEnum = typeof PauseMovementRequestMessageTypeEnum[keyof typeof PauseMovementRequestMessageTypeEnum];
3029
2998
  /**
3030
- * 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).
2999
+ * 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).
3031
3000
  * @export
3032
3001
  * @interface PauseMovementResponse
3033
3002
  */
3034
3003
  export interface PauseMovementResponse {
3035
3004
  /**
3036
- *
3037
- * @type {PauseMovementResponsePauseResponse}
3005
+ * Error message in case of invalid PauseMovementResquest.
3006
+ * @type {string}
3038
3007
  * @memberof PauseMovementResponse
3039
3008
  */
3040
- 'pause_response': PauseMovementResponsePauseResponse;
3041
- }
3042
- /**
3043
- *
3044
- * @export
3045
- * @interface PauseMovementResponsePauseResponse
3046
- */
3047
- export interface PauseMovementResponsePauseResponse {
3048
- /**
3049
- * Indicates if PauseMovementRequest can be executed.
3050
- * @type {boolean}
3051
- * @memberof PauseMovementResponsePauseResponse
3052
- */
3053
- 'succeeded': boolean;
3009
+ 'message'?: string;
3054
3010
  /**
3055
- * Error message in case of invalid PauseMovementRequest or failure while claiming motion.
3011
+ *
3056
3012
  * @type {string}
3057
- * @memberof PauseMovementResponsePauseResponse
3013
+ * @memberof PauseMovementResponse
3058
3014
  */
3059
- 'error_message'?: string;
3015
+ 'kind': PauseMovementResponseKindEnum;
3060
3016
  }
3017
+ export declare const PauseMovementResponseKindEnum: {
3018
+ readonly PauseReceived: "PAUSE_RECEIVED";
3019
+ };
3020
+ export type PauseMovementResponseKindEnum = typeof PauseMovementResponseKindEnum[keyof typeof PauseMovementResponseKindEnum];
3061
3021
  /**
3062
3022
  * Defines an input/output that the motion will be paused for. The motion will stop gracefully on path.
3063
3023
  * @export
@@ -3077,6 +3037,103 @@ export interface PauseOnIO {
3077
3037
  */
3078
3038
  'comparator': Comparator;
3079
3039
  }
3040
+ /**
3041
+ *
3042
+ * @export
3043
+ * @interface PausedByRequest
3044
+ */
3045
+ export interface PausedByRequest {
3046
+ /**
3047
+ *
3048
+ * @type {string}
3049
+ * @memberof PausedByRequest
3050
+ */
3051
+ 'kind': PausedByRequestKindEnum;
3052
+ }
3053
+ export declare const PausedByRequestKindEnum: {
3054
+ readonly PausedByUser: "PAUSED_BY_USER";
3055
+ };
3056
+ export type PausedByRequestKindEnum = typeof PausedByRequestKindEnum[keyof typeof PausedByRequestKindEnum];
3057
+ /**
3058
+ *
3059
+ * @export
3060
+ * @interface PausedByUser
3061
+ */
3062
+ export interface PausedByUser {
3063
+ /**
3064
+ *
3065
+ * @type {string}
3066
+ * @memberof PausedByUser
3067
+ */
3068
+ 'kind': PausedByUserKindEnum;
3069
+ }
3070
+ export declare const PausedByUserKindEnum: {
3071
+ readonly PausedByUser: "PAUSED_BY_USER";
3072
+ };
3073
+ export type PausedByUserKindEnum = typeof PausedByUserKindEnum[keyof typeof PausedByUserKindEnum];
3074
+ /**
3075
+ *
3076
+ * @export
3077
+ * @interface PausedNearCollision
3078
+ */
3079
+ export interface PausedNearCollision {
3080
+ /**
3081
+ *
3082
+ * @type {string}
3083
+ * @memberof PausedNearCollision
3084
+ */
3085
+ 'kind': PausedNearCollisionKindEnum;
3086
+ /**
3087
+ *
3088
+ * @type {string}
3089
+ * @memberof PausedNearCollision
3090
+ */
3091
+ 'description': string;
3092
+ }
3093
+ export declare const PausedNearCollisionKindEnum: {
3094
+ readonly PausedNearCollision: "PAUSED_NEAR_COLLISION";
3095
+ };
3096
+ export type PausedNearCollisionKindEnum = typeof PausedNearCollisionKindEnum[keyof typeof PausedNearCollisionKindEnum];
3097
+ /**
3098
+ *
3099
+ * @export
3100
+ * @interface PausedNearJointLimit
3101
+ */
3102
+ export interface PausedNearJointLimit {
3103
+ /**
3104
+ *
3105
+ * @type {string}
3106
+ * @memberof PausedNearJointLimit
3107
+ */
3108
+ 'kind': PausedNearJointLimitKindEnum;
3109
+ /**
3110
+ *
3111
+ * @type {Array<number>}
3112
+ * @memberof PausedNearJointLimit
3113
+ */
3114
+ 'joint_indices': Array<number>;
3115
+ }
3116
+ export declare const PausedNearJointLimitKindEnum: {
3117
+ readonly PausedNearJointLimit: "PAUSED_NEAR_JOINT_LIMIT";
3118
+ };
3119
+ export type PausedNearJointLimitKindEnum = typeof PausedNearJointLimitKindEnum[keyof typeof PausedNearJointLimitKindEnum];
3120
+ /**
3121
+ *
3122
+ * @export
3123
+ * @interface PausedOnIO
3124
+ */
3125
+ export interface PausedOnIO {
3126
+ /**
3127
+ *
3128
+ * @type {string}
3129
+ * @memberof PausedOnIO
3130
+ */
3131
+ 'kind': PausedOnIOKindEnum;
3132
+ }
3133
+ export declare const PausedOnIOKindEnum: {
3134
+ readonly PausedOnIo: "PAUSED_ON_IO";
3135
+ };
3136
+ export type PausedOnIOKindEnum = typeof PausedOnIOKindEnum[keyof typeof PausedOnIOKindEnum];
3080
3137
  /**
3081
3138
  *
3082
3139
  * @export
@@ -3198,104 +3255,6 @@ export declare const PlaneShapeTypeEnum: {
3198
3255
  readonly Plane: "plane";
3199
3256
  };
3200
3257
  export type PlaneShapeTypeEnum = typeof PlaneShapeTypeEnum[keyof typeof PlaneShapeTypeEnum];
3201
- /**
3202
- * All known joint and cartesian limits of a motion-group. Used for motion planning.
3203
- * @export
3204
- * @interface PlanningLimits
3205
- */
3206
- export interface PlanningLimits {
3207
- /**
3208
- * Joint position limits in [rad], indexed starting from base.
3209
- * @type {Array<PlanningLimitsLimitRange>}
3210
- * @memberof PlanningLimits
3211
- */
3212
- 'joint_position_limits'?: Array<PlanningLimitsLimitRange>;
3213
- /**
3214
- * Maximum allowed velocity for joints in [rad/s or mm/s] of the safety setup, starting at base.
3215
- * @type {Array<number>}
3216
- * @memberof PlanningLimits
3217
- */
3218
- 'joint_velocity_limits'?: Array<number>;
3219
- /**
3220
- * Maximum allowed acceleration for joints in [rad/s^2 or mm/s^2] of the safety setup, starting at base.
3221
- * @type {Array<number>}
3222
- * @memberof PlanningLimits
3223
- */
3224
- 'joint_acceleration_limits'?: Array<number>;
3225
- /**
3226
- * Maximum allowed torque for joints in [Nm or N] of the safety setup, starting at base.
3227
- * @type {Array<number>}
3228
- * @memberof PlanningLimits
3229
- */
3230
- 'joint_torque_limits'?: Array<number>;
3231
- /**
3232
- * At maximum one dimensional velocity in [mm/s] at TCP allowed.
3233
- * @type {number}
3234
- * @memberof PlanningLimits
3235
- */
3236
- 'tcp_velocity_limit'?: number;
3237
- /**
3238
- * At maximum one dimensional acceleration in [mm/s^2] at TCP allowed.
3239
- * @type {number}
3240
- * @memberof PlanningLimits
3241
- */
3242
- 'tcp_acceleration_limit'?: number;
3243
- /**
3244
- * At maximum one dimensional orientation velocity in [rad/s] at TCP allowed.
3245
- * @type {number}
3246
- * @memberof PlanningLimits
3247
- */
3248
- 'tcp_orientation_velocity_limit'?: number;
3249
- /**
3250
- * At maximum one dimensional orientation acceleration in [rad/s^2] at TCP allowed.
3251
- * @type {number}
3252
- * @memberof PlanningLimits
3253
- */
3254
- 'tcp_orientation_acceleration_limit'?: number;
3255
- /**
3256
- * At maximum one dimensional force in [N] at TCP allowed.
3257
- * @type {number}
3258
- * @memberof PlanningLimits
3259
- */
3260
- 'tcp_force_limit'?: number;
3261
- /**
3262
- * At maximum one dimensional velocity in [mm/s] at the elbow allowed.
3263
- * @type {number}
3264
- * @memberof PlanningLimits
3265
- */
3266
- 'elbow_velocity_limit'?: number;
3267
- /**
3268
- * At maximum one dimensional acceleration in [mm/s^2] at the elbow allowed.
3269
- * @type {number}
3270
- * @memberof PlanningLimits
3271
- */
3272
- 'elbow_acceleration_limit'?: number;
3273
- /**
3274
- * At maximum one dimensional force in [N] at the elbow allowed.
3275
- * @type {number}
3276
- * @memberof PlanningLimits
3277
- */
3278
- 'elbow_force_limit'?: number;
3279
- }
3280
- /**
3281
- * The upper_limit must be greater then the lower_limit.
3282
- * @export
3283
- * @interface PlanningLimitsLimitRange
3284
- */
3285
- export interface PlanningLimitsLimitRange {
3286
- /**
3287
- *
3288
- * @type {number}
3289
- * @memberof PlanningLimitsLimitRange
3290
- */
3291
- 'lower_limit': number;
3292
- /**
3293
- *
3294
- * @type {number}
3295
- * @memberof PlanningLimitsLimitRange
3296
- */
3297
- 'upper_limit': number;
3298
- }
3299
3258
  /**
3300
3259
  * Sets velocity for executed movements of the motion, in percent. Send after initializing the connection with InitializeMovementRequest.
3301
3260
  * @export
@@ -3320,31 +3279,28 @@ export declare const PlaybackSpeedRequestMessageTypeEnum: {
3320
3279
  };
3321
3280
  export type PlaybackSpeedRequestMessageTypeEnum = typeof PlaybackSpeedRequestMessageTypeEnum[keyof typeof PlaybackSpeedRequestMessageTypeEnum];
3322
3281
  /**
3323
- *
3282
+ * Acknowledgment for PlaybackSpeedRequest message.
3324
3283
  * @export
3325
3284
  * @interface PlaybackSpeedResponse
3326
3285
  */
3327
3286
  export interface PlaybackSpeedResponse {
3328
3287
  /**
3329
- *
3330
- * @type {PlaybackSpeedResponsePlaybackSpeedResponse}
3288
+ * Error message in case of invalid PlaybackSpeedRequest.
3289
+ * @type {string}
3331
3290
  * @memberof PlaybackSpeedResponse
3332
3291
  */
3333
- 'playback_speed_response': PlaybackSpeedResponsePlaybackSpeedResponse;
3334
- }
3335
- /**
3336
- *
3337
- * @export
3338
- * @interface PlaybackSpeedResponsePlaybackSpeedResponse
3339
- */
3340
- export interface PlaybackSpeedResponsePlaybackSpeedResponse {
3292
+ 'message'?: string;
3341
3293
  /**
3342
- * Value of the requested playback speed in percent [%].
3343
- * @type {number}
3344
- * @memberof PlaybackSpeedResponsePlaybackSpeedResponse
3294
+ *
3295
+ * @type {string}
3296
+ * @memberof PlaybackSpeedResponse
3345
3297
  */
3346
- 'requested_value': number;
3298
+ 'kind': PlaybackSpeedResponseKindEnum;
3347
3299
  }
3300
+ export declare const PlaybackSpeedResponseKindEnum: {
3301
+ readonly PlaybackSpeedReceived: "PLAYBACK_SPEED_RECEIVED";
3302
+ };
3303
+ export type PlaybackSpeedResponseKindEnum = typeof PlaybackSpeedResponseKindEnum[keyof typeof PlaybackSpeedResponseKindEnum];
3348
3304
  /**
3349
3305
  * Defines a pose in 3D space. A pose is a combination of a position and an orientation. The position is applied before the orientation.
3350
3306
  * @export
@@ -3703,10 +3659,10 @@ export interface RobotSetup {
3703
3659
  'tcp_offset'?: Pose;
3704
3660
  /**
3705
3661
  *
3706
- * @type {PlanningLimits}
3662
+ * @type {LimitSet}
3707
3663
  * @memberof RobotSetup
3708
3664
  */
3709
- 'global_limits'?: PlanningLimits;
3665
+ 'global_limits'?: LimitSet;
3710
3666
  /**
3711
3667
  *
3712
3668
  * @type {Payload}
@@ -3804,6 +3760,46 @@ export interface RobotTcps {
3804
3760
  */
3805
3761
  'tcps': Array<RobotTcp>;
3806
3762
  }
3763
+ /**
3764
+ *
3765
+ * @export
3766
+ * @interface Running
3767
+ */
3768
+ export interface Running {
3769
+ /**
3770
+ *
3771
+ * @type {string}
3772
+ * @memberof Running
3773
+ */
3774
+ 'kind': RunningKindEnum;
3775
+ }
3776
+ export declare const RunningKindEnum: {
3777
+ readonly Running: "RUNNING";
3778
+ };
3779
+ export type RunningKindEnum = typeof RunningKindEnum[keyof typeof RunningKindEnum];
3780
+ /**
3781
+ *
3782
+ * @export
3783
+ * @interface Running1
3784
+ */
3785
+ export interface Running1 {
3786
+ /**
3787
+ *
3788
+ * @type {string}
3789
+ * @memberof Running1
3790
+ */
3791
+ 'kind': Running1KindEnum;
3792
+ /**
3793
+ * Remaining time in milliseconds (ms) to reach the end of the motion.
3794
+ * @type {number}
3795
+ * @memberof Running1
3796
+ */
3797
+ 'time_to_end': number;
3798
+ }
3799
+ export declare const Running1KindEnum: {
3800
+ readonly Running: "RUNNING";
3801
+ };
3802
+ export type Running1KindEnum = typeof Running1KindEnum[keyof typeof Running1KindEnum];
3807
3803
  /**
3808
3804
  * 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.
3809
3805
  * @export
@@ -4023,56 +4019,6 @@ export declare const SphereShapeTypeEnum: {
4023
4019
  readonly Sphere: "sphere";
4024
4020
  };
4025
4021
  export type SphereShapeTypeEnum = typeof SphereShapeTypeEnum[keyof typeof SphereShapeTypeEnum];
4026
- /**
4027
- * The response will be sent one time at the end of every execution signalling that the motion group has stopped moving.
4028
- * @export
4029
- * @interface Standstill
4030
- */
4031
- export interface Standstill {
4032
- /**
4033
- *
4034
- * @type {StandstillStandstill}
4035
- * @memberof Standstill
4036
- */
4037
- 'standstill': StandstillStandstill;
4038
- }
4039
- /**
4040
- * The reason why the movement is paused.
4041
- * @export
4042
- * @enum {string}
4043
- */
4044
- export declare const StandstillReason: {
4045
- readonly ReasonMotionEnded: "REASON_MOTION_ENDED";
4046
- readonly ReasonUserPausedMotion: "REASON_USER_PAUSED_MOTION";
4047
- readonly ReasonWaitingForIo: "REASON_WAITING_FOR_IO";
4048
- readonly ReasonPausedOnIo: "REASON_PAUSED_ON_IO";
4049
- };
4050
- export type StandstillReason = typeof StandstillReason[keyof typeof StandstillReason];
4051
- /**
4052
- *
4053
- * @export
4054
- * @interface StandstillStandstill
4055
- */
4056
- export interface StandstillStandstill {
4057
- /**
4058
- *
4059
- * @type {StandstillReason}
4060
- * @memberof StandstillStandstill
4061
- */
4062
- 'reason': StandstillReason;
4063
- /**
4064
- *
4065
- * @type {number}
4066
- * @memberof StandstillStandstill
4067
- */
4068
- 'location': number;
4069
- /**
4070
- * Current state of the controller and motion group which came to a standstill.
4071
- * @type {RobotControllerState}
4072
- * @memberof StandstillStandstill
4073
- */
4074
- 'state': RobotControllerState;
4075
- }
4076
4022
  /**
4077
4023
  * 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.
4078
4024
  * @export
@@ -4114,6 +4060,29 @@ export declare const StartMovementRequestMessageTypeEnum: {
4114
4060
  readonly StartMovementRequest: "StartMovementRequest";
4115
4061
  };
4116
4062
  export type StartMovementRequestMessageTypeEnum = typeof StartMovementRequestMessageTypeEnum[keyof typeof StartMovementRequestMessageTypeEnum];
4063
+ /**
4064
+ * 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.
4065
+ * @export
4066
+ * @interface StartMovementResponse
4067
+ */
4068
+ export interface StartMovementResponse {
4069
+ /**
4070
+ * Error message in case of invalid StartMovementResquest.
4071
+ * @type {string}
4072
+ * @memberof StartMovementResponse
4073
+ */
4074
+ 'message'?: string;
4075
+ /**
4076
+ *
4077
+ * @type {string}
4078
+ * @memberof StartMovementResponse
4079
+ */
4080
+ 'kind': StartMovementResponseKindEnum;
4081
+ }
4082
+ export declare const StartMovementResponseKindEnum: {
4083
+ readonly StartReceived: "START_RECEIVED";
4084
+ };
4085
+ export type StartMovementResponseKindEnum = typeof StartMovementResponseKindEnum[keyof typeof StartMovementResponseKindEnum];
4117
4086
  /**
4118
4087
  * Defines an input/output that the motion should wait for to start the execution.
4119
4088
  * @export
@@ -4225,6 +4194,29 @@ export declare const TcpVelocityRequestMessageTypeEnum: {
4225
4194
  readonly TcpVelocityRequest: "TcpVelocityRequest";
4226
4195
  };
4227
4196
  export type TcpVelocityRequestMessageTypeEnum = typeof TcpVelocityRequestMessageTypeEnum[keyof typeof TcpVelocityRequestMessageTypeEnum];
4197
+ /**
4198
+ * Acknowledgment to a TcpVelocityRequest.
4199
+ * @export
4200
+ * @interface TcpVelocityResponse
4201
+ */
4202
+ export interface TcpVelocityResponse {
4203
+ /**
4204
+ * Error message in case of invalid TcpVelocityRequest.
4205
+ * @type {string}
4206
+ * @memberof TcpVelocityResponse
4207
+ */
4208
+ 'message'?: string;
4209
+ /**
4210
+ *
4211
+ * @type {string}
4212
+ * @memberof TcpVelocityResponse
4213
+ */
4214
+ 'kind': TcpVelocityResponseKindEnum;
4215
+ }
4216
+ export declare const TcpVelocityResponseKindEnum: {
4217
+ readonly TcpVelocityReceived: "TCP_VELOCITY_RECEIVED";
4218
+ };
4219
+ export type TcpVelocityResponseKindEnum = typeof TcpVelocityResponseKindEnum[keyof typeof TcpVelocityResponseKindEnum];
4228
4220
  /**
4229
4221
  *
4230
4222
  * @export
@@ -4292,6 +4284,46 @@ export declare const TrajectoryDataMessageTypeEnum: {
4292
4284
  readonly TrajectoryData: "TrajectoryData";
4293
4285
  };
4294
4286
  export type TrajectoryDataMessageTypeEnum = typeof TrajectoryDataMessageTypeEnum[keyof typeof TrajectoryDataMessageTypeEnum];
4287
+ /**
4288
+ * 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.
4289
+ * @export
4290
+ * @interface TrajectoryDetails
4291
+ */
4292
+ export interface TrajectoryDetails {
4293
+ /**
4294
+ * Unique identifier of the trajectory being executed.
4295
+ * @type {string}
4296
+ * @memberof TrajectoryDetails
4297
+ */
4298
+ 'trajectory': string;
4299
+ /**
4300
+ * Current location of motion group on the trajectory.
4301
+ * @type {number}
4302
+ * @memberof TrajectoryDetails
4303
+ */
4304
+ 'location': number;
4305
+ /**
4306
+ *
4307
+ * @type {TrajectoryDetailsState}
4308
+ * @memberof TrajectoryDetails
4309
+ */
4310
+ 'state': TrajectoryDetailsState;
4311
+ /**
4312
+ * Discriminator for OpenApi generators, which is always \"TRAJECTORY\" for this schema.
4313
+ * @type {string}
4314
+ * @memberof TrajectoryDetails
4315
+ */
4316
+ 'kind': TrajectoryDetailsKindEnum;
4317
+ }
4318
+ export declare const TrajectoryDetailsKindEnum: {
4319
+ readonly Trajectory: "TRAJECTORY";
4320
+ };
4321
+ export type TrajectoryDetailsKindEnum = typeof TrajectoryDetailsKindEnum[keyof typeof TrajectoryDetailsKindEnum];
4322
+ /**
4323
+ * @type TrajectoryDetailsState
4324
+ * @export
4325
+ */
4326
+ export type TrajectoryDetailsState = EndOfTrajectory | PausedByRequest | PausedOnIO | Running1 | WaitForIO;
4295
4327
  /**
4296
4328
  *
4297
4329
  * @export
@@ -4303,7 +4335,7 @@ export interface TrajectoryId {
4303
4335
  * @type {string}
4304
4336
  * @memberof TrajectoryId
4305
4337
  */
4306
- 'message_type': TrajectoryIdMessageTypeEnum;
4338
+ 'message_type'?: TrajectoryIdMessageTypeEnum;
4307
4339
  /**
4308
4340
  * The identifier of the trajectory which was returned by the [addTrajectory](addTrajectory) endpoint.
4309
4341
  * @type {string}
@@ -4599,6 +4631,23 @@ export interface VirtualRobotConfiguration {
4599
4631
  */
4600
4632
  'content': string;
4601
4633
  }
4634
+ /**
4635
+ *
4636
+ * @export
4637
+ * @interface WaitForIO
4638
+ */
4639
+ export interface WaitForIO {
4640
+ /**
4641
+ *
4642
+ * @type {string}
4643
+ * @memberof WaitForIO
4644
+ */
4645
+ 'kind': WaitForIOKindEnum;
4646
+ }
4647
+ export declare const WaitForIOKindEnum: {
4648
+ readonly WaitForIo: "WAIT_FOR_IO";
4649
+ };
4650
+ export type WaitForIOKindEnum = typeof WaitForIOKindEnum[keyof typeof WaitForIOKindEnum];
4602
4651
  /**
4603
4652
  * The value to compare with the current value of the input/output.
4604
4653
  * @export
@@ -6472,7 +6521,7 @@ export declare const MotionGroupApiFp: (configuration?: Configuration) => {
6472
6521
  * @param {*} [options] Override http request option.
6473
6522
  * @throws {RequiredError}
6474
6523
  */
6475
- streamMotionGroupState(cell: string, motionGroup: string, responseRate?: number, responseCoordinateSystem?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<MotionGroupStateWithoutPayload>>;
6524
+ streamMotionGroupState(cell: string, motionGroup: string, responseRate?: number, responseCoordinateSystem?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<MotionGroupState>>;
6476
6525
  };
6477
6526
  /**
6478
6527
  * MotionGroupApi - factory interface
@@ -6508,7 +6557,7 @@ export declare const MotionGroupApiFactory: (configuration?: Configuration, base
6508
6557
  * @param {*} [options] Override http request option.
6509
6558
  * @throws {RequiredError}
6510
6559
  */
6511
- streamMotionGroupState(cell: string, motionGroup: string, responseRate?: number, responseCoordinateSystem?: string, options?: RawAxiosRequestConfig): AxiosPromise<MotionGroupStateWithoutPayload>;
6560
+ streamMotionGroupState(cell: string, motionGroup: string, responseRate?: number, responseCoordinateSystem?: string, options?: RawAxiosRequestConfig): AxiosPromise<MotionGroupState>;
6512
6561
  };
6513
6562
  /**
6514
6563
  * MotionGroupApi - object-oriented interface
@@ -6549,7 +6598,7 @@ export declare class MotionGroupApi extends BaseAPI {
6549
6598
  * @throws {RequiredError}
6550
6599
  * @memberof MotionGroupApi
6551
6600
  */
6552
- streamMotionGroupState(cell: string, motionGroup: string, responseRate?: number, responseCoordinateSystem?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<MotionGroupStateWithoutPayload, any>>;
6601
+ streamMotionGroupState(cell: string, motionGroup: string, responseRate?: number, responseCoordinateSystem?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<MotionGroupState, any>>;
6553
6602
  }
6554
6603
  /**
6555
6604
  * ProgramApi - axios parameter creator