@wandelbots/nova-api 25.6.0-dev.35 → 25.6.0-dev.36
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/package.json +1 -1
- package/v2/api.d.ts +453 -468
- package/v2/api.js +63 -11
- package/v2/api.js.map +1 -1
- package/v2/api.ts +565 -525
package/v2/api.d.ts
CHANGED
|
@@ -940,6 +940,23 @@ export declare const Direction: {
|
|
|
940
940
|
readonly DirectionBackward: "DIRECTION_BACKWARD";
|
|
941
941
|
};
|
|
942
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];
|
|
943
960
|
/**
|
|
944
961
|
*
|
|
945
962
|
* @export
|
|
@@ -953,16 +970,44 @@ export interface Error2 {
|
|
|
953
970
|
*/
|
|
954
971
|
'message': string;
|
|
955
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;
|
|
956
1001
|
/**
|
|
957
1002
|
* @type ExecuteJoggingRequest
|
|
958
1003
|
* @export
|
|
959
1004
|
*/
|
|
960
|
-
export type ExecuteJoggingRequest = InitializeJoggingRequest | JointVelocityRequest | TcpVelocityRequest;
|
|
1005
|
+
export type ExecuteJoggingRequest = InitializeJoggingRequest | JointVelocityRequest | PauseJoggingRequest | TcpVelocityRequest;
|
|
961
1006
|
/**
|
|
962
1007
|
* @type ExecuteJoggingResponse
|
|
963
1008
|
* @export
|
|
964
1009
|
*/
|
|
965
|
-
export type ExecuteJoggingResponse = InitializeJoggingResponse |
|
|
1010
|
+
export type ExecuteJoggingResponse = InitializeJoggingResponse | JointVelocityResponse | MovementErrorResponse | PauseJoggingResponse | TcpVelocityResponse;
|
|
966
1011
|
/**
|
|
967
1012
|
* @type ExecuteTrajectoryRequest
|
|
968
1013
|
* @export
|
|
@@ -972,7 +1017,7 @@ export type ExecuteTrajectoryRequest = InitializeMovementRequest | PauseMovement
|
|
|
972
1017
|
* @type ExecuteTrajectoryResponse
|
|
973
1018
|
* @export
|
|
974
1019
|
*/
|
|
975
|
-
export type ExecuteTrajectoryResponse = InitializeMovementResponse |
|
|
1020
|
+
export type ExecuteTrajectoryResponse = InitializeMovementResponse | MovementErrorResponse | PauseMovementResponse | PlaybackSpeedResponse | StartMovementResponse;
|
|
976
1021
|
/**
|
|
977
1022
|
* A datapoint inside external joint stream.
|
|
978
1023
|
* @export
|
|
@@ -1558,37 +1603,28 @@ export declare const InitializeJoggingRequestMessageTypeEnum: {
|
|
|
1558
1603
|
};
|
|
1559
1604
|
export type InitializeJoggingRequestMessageTypeEnum = typeof InitializeJoggingRequestMessageTypeEnum[keyof typeof InitializeJoggingRequestMessageTypeEnum];
|
|
1560
1605
|
/**
|
|
1561
|
-
*
|
|
1606
|
+
* Acknowledgment to an InitializeJoggingRequest.
|
|
1562
1607
|
* @export
|
|
1563
1608
|
* @interface InitializeJoggingResponse
|
|
1564
1609
|
*/
|
|
1565
1610
|
export interface InitializeJoggingResponse {
|
|
1566
1611
|
/**
|
|
1567
|
-
*
|
|
1568
|
-
* @type {
|
|
1612
|
+
* Error message in case of invalid InitializeJoggingRequest.
|
|
1613
|
+
* @type {string}
|
|
1569
1614
|
* @memberof InitializeJoggingResponse
|
|
1570
1615
|
*/
|
|
1571
|
-
'
|
|
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;
|
|
1616
|
+
'message'?: string;
|
|
1585
1617
|
/**
|
|
1586
|
-
*
|
|
1618
|
+
*
|
|
1587
1619
|
* @type {string}
|
|
1588
|
-
* @memberof
|
|
1620
|
+
* @memberof InitializeJoggingResponse
|
|
1589
1621
|
*/
|
|
1590
|
-
'
|
|
1622
|
+
'kind': InitializeJoggingResponseKindEnum;
|
|
1591
1623
|
}
|
|
1624
|
+
export declare const InitializeJoggingResponseKindEnum: {
|
|
1625
|
+
readonly InitializeReceived: "INITIALIZE_RECEIVED";
|
|
1626
|
+
};
|
|
1627
|
+
export type InitializeJoggingResponseKindEnum = typeof InitializeJoggingResponseKindEnum[keyof typeof InitializeJoggingResponseKindEnum];
|
|
1592
1628
|
/**
|
|
1593
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.
|
|
1594
1630
|
* @export
|
|
@@ -1647,31 +1683,28 @@ export type InitializeMovementRequestTrajectory = {
|
|
|
1647
1683
|
*/
|
|
1648
1684
|
export interface InitializeMovementResponse {
|
|
1649
1685
|
/**
|
|
1650
|
-
*
|
|
1651
|
-
* @type {
|
|
1686
|
+
* Error message in case of invalid InitializeMovementRequest.
|
|
1687
|
+
* @type {string}
|
|
1652
1688
|
* @memberof InitializeMovementResponse
|
|
1653
1689
|
*/
|
|
1654
|
-
'
|
|
1655
|
-
}
|
|
1656
|
-
/**
|
|
1657
|
-
*
|
|
1658
|
-
* @export
|
|
1659
|
-
* @interface InitializeMovementResponseInitResponse
|
|
1660
|
-
*/
|
|
1661
|
-
export interface InitializeMovementResponseInitResponse {
|
|
1690
|
+
'message'?: string;
|
|
1662
1691
|
/**
|
|
1663
|
-
*
|
|
1664
|
-
* @type {
|
|
1665
|
-
* @memberof
|
|
1692
|
+
* Error can occur if joint trajectory was added by [InitializeMovementRequest](InitializeMovementRequest) and the trajectory is invalid.
|
|
1693
|
+
* @type {AddTrajectoryError}
|
|
1694
|
+
* @memberof InitializeMovementResponse
|
|
1666
1695
|
*/
|
|
1667
|
-
'
|
|
1696
|
+
'add_trajectory_error'?: AddTrajectoryError;
|
|
1668
1697
|
/**
|
|
1669
|
-
*
|
|
1698
|
+
*
|
|
1670
1699
|
* @type {string}
|
|
1671
|
-
* @memberof
|
|
1700
|
+
* @memberof InitializeMovementResponse
|
|
1672
1701
|
*/
|
|
1673
|
-
'
|
|
1702
|
+
'kind': InitializeMovementResponseKindEnum;
|
|
1674
1703
|
}
|
|
1704
|
+
export declare const InitializeMovementResponseKindEnum: {
|
|
1705
|
+
readonly InitializeReceived: "INITIALIZE_RECEIVED";
|
|
1706
|
+
};
|
|
1707
|
+
export type InitializeMovementResponseKindEnum = typeof InitializeMovementResponseKindEnum[keyof typeof InitializeMovementResponseKindEnum];
|
|
1675
1708
|
/**
|
|
1676
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.
|
|
1677
1710
|
* @export
|
|
@@ -1786,159 +1819,33 @@ export interface InverseKinematicsResponse {
|
|
|
1786
1819
|
'joints': Array<Array<Array<number>>>;
|
|
1787
1820
|
}
|
|
1788
1821
|
/**
|
|
1789
|
-
*
|
|
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.
|
|
1790
1823
|
* @export
|
|
1791
|
-
* @interface
|
|
1824
|
+
* @interface JoggingDetails
|
|
1792
1825
|
*/
|
|
1793
|
-
export interface
|
|
1826
|
+
export interface JoggingDetails {
|
|
1794
1827
|
/**
|
|
1795
1828
|
*
|
|
1796
|
-
* @type {
|
|
1797
|
-
* @memberof
|
|
1829
|
+
* @type {JoggingDetailsState}
|
|
1830
|
+
* @memberof JoggingDetails
|
|
1798
1831
|
*/
|
|
1799
|
-
'
|
|
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
|
-
*
|
|
1816
|
-
* @export
|
|
1817
|
-
* @interface JoggingPausedCollision
|
|
1818
|
-
*/
|
|
1819
|
-
export interface JoggingPausedCollision {
|
|
1820
|
-
/**
|
|
1821
|
-
*
|
|
1822
|
-
* @type {JoggingPausedCollisionPausedNearCollision}
|
|
1823
|
-
* @memberof JoggingPausedCollision
|
|
1824
|
-
*/
|
|
1825
|
-
'paused_near_collision': JoggingPausedCollisionPausedNearCollision;
|
|
1826
|
-
}
|
|
1827
|
-
/**
|
|
1828
|
-
*
|
|
1829
|
-
* @export
|
|
1830
|
-
* @interface JoggingPausedCollisionPausedNearCollision
|
|
1831
|
-
*/
|
|
1832
|
-
export interface JoggingPausedCollisionPausedNearCollision {
|
|
1832
|
+
'state': JoggingDetailsState;
|
|
1833
1833
|
/**
|
|
1834
1834
|
*
|
|
1835
1835
|
* @type {string}
|
|
1836
|
-
* @memberof
|
|
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
|
|
1836
|
+
* @memberof JoggingDetails
|
|
1863
1837
|
*/
|
|
1864
|
-
'
|
|
1865
|
-
}
|
|
1866
|
-
/**
|
|
1867
|
-
*
|
|
1868
|
-
* @export
|
|
1869
|
-
* @interface JoggingPausedOnIO
|
|
1870
|
-
*/
|
|
1871
|
-
export interface JoggingPausedOnIO {
|
|
1872
|
-
/**
|
|
1873
|
-
*
|
|
1874
|
-
* @type {object}
|
|
1875
|
-
* @memberof JoggingPausedOnIO
|
|
1876
|
-
*/
|
|
1877
|
-
'paused_on_io': object;
|
|
1878
|
-
}
|
|
1879
|
-
/**
|
|
1880
|
-
*
|
|
1881
|
-
* @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
|
|
1896
|
-
*/
|
|
1897
|
-
export interface JoggingResponse {
|
|
1898
|
-
/**
|
|
1899
|
-
*
|
|
1900
|
-
* @type {JoggingResponseJogging}
|
|
1901
|
-
* @memberof JoggingResponse
|
|
1902
|
-
*/
|
|
1903
|
-
'jogging': JoggingResponseJogging;
|
|
1904
|
-
}
|
|
1905
|
-
/**
|
|
1906
|
-
*
|
|
1907
|
-
* @export
|
|
1908
|
-
* @interface JoggingResponseJogging
|
|
1909
|
-
*/
|
|
1910
|
-
export interface JoggingResponseJogging {
|
|
1911
|
-
/**
|
|
1912
|
-
*
|
|
1913
|
-
* @type {JoggingState}
|
|
1914
|
-
* @memberof JoggingResponseJogging
|
|
1915
|
-
*/
|
|
1916
|
-
'jogging_state': JoggingState;
|
|
1917
|
-
/**
|
|
1918
|
-
*
|
|
1919
|
-
* @type {RobotControllerState}
|
|
1920
|
-
* @memberof JoggingResponseJogging
|
|
1921
|
-
*/
|
|
1922
|
-
'robot_controller_state': RobotControllerState;
|
|
1923
|
-
}
|
|
1924
|
-
/**
|
|
1925
|
-
*
|
|
1926
|
-
* @export
|
|
1927
|
-
* @interface JoggingRunning
|
|
1928
|
-
*/
|
|
1929
|
-
export interface JoggingRunning {
|
|
1930
|
-
/**
|
|
1931
|
-
*
|
|
1932
|
-
* @type {object}
|
|
1933
|
-
* @memberof JoggingRunning
|
|
1934
|
-
*/
|
|
1935
|
-
'running': object;
|
|
1838
|
+
'kind': JoggingDetailsKindEnum;
|
|
1936
1839
|
}
|
|
1840
|
+
export declare const JoggingDetailsKindEnum: {
|
|
1841
|
+
readonly Jogging: "JOGGING";
|
|
1842
|
+
};
|
|
1843
|
+
export type JoggingDetailsKindEnum = typeof JoggingDetailsKindEnum[keyof typeof JoggingDetailsKindEnum];
|
|
1937
1844
|
/**
|
|
1938
|
-
* @type
|
|
1845
|
+
* @type JoggingDetailsState
|
|
1939
1846
|
* @export
|
|
1940
1847
|
*/
|
|
1941
|
-
export type
|
|
1848
|
+
export type JoggingDetailsState = PausedByUser | PausedNearCollision | PausedNearJointLimit | PausedOnIO | Running;
|
|
1942
1849
|
/**
|
|
1943
1850
|
*
|
|
1944
1851
|
* @export
|
|
@@ -2000,6 +1907,29 @@ export declare const JointVelocityRequestMessageTypeEnum: {
|
|
|
2000
1907
|
readonly JointVelocityRequest: "JointVelocityRequest";
|
|
2001
1908
|
};
|
|
2002
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];
|
|
2003
1933
|
/**
|
|
2004
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.
|
|
2005
1935
|
* @export
|
|
@@ -2467,17 +2397,17 @@ export interface MotionGroupJoints {
|
|
|
2467
2397
|
'torques'?: Array<number>;
|
|
2468
2398
|
}
|
|
2469
2399
|
/**
|
|
2470
|
-
*
|
|
2400
|
+
* Presents the current state of the motion group.
|
|
2471
2401
|
* @export
|
|
2472
2402
|
* @interface MotionGroupState
|
|
2473
2403
|
*/
|
|
2474
2404
|
export interface MotionGroupState {
|
|
2475
2405
|
/**
|
|
2476
|
-
* Timestamp
|
|
2406
|
+
* Timestamp for when data was received from the robot controller.
|
|
2477
2407
|
* @type {string}
|
|
2478
2408
|
* @memberof MotionGroupState
|
|
2479
2409
|
*/
|
|
2480
|
-
'timestamp'
|
|
2410
|
+
'timestamp': string;
|
|
2481
2411
|
/**
|
|
2482
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.
|
|
2483
2413
|
* @type {number}
|
|
@@ -2509,59 +2439,59 @@ export interface MotionGroupState {
|
|
|
2509
2439
|
*/
|
|
2510
2440
|
'joint_limit_reached': MotionGroupStateJointLimitReached;
|
|
2511
2441
|
/**
|
|
2512
|
-
* Current joint
|
|
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).
|
|
2442
|
+
* Current joint torque of each joint in [Nm]. Is only available if the robot controller supports it, e.g. available for UR controllers.
|
|
2519
2443
|
* @type {Joints}
|
|
2520
2444
|
* @memberof MotionGroupState
|
|
2521
2445
|
*/
|
|
2522
2446
|
'joint_torque'?: Joints;
|
|
2523
2447
|
/**
|
|
2524
|
-
* Current
|
|
2448
|
+
* Current at TCP in [A]. Is only available if the robot controller supports it, e.g. available for UR controllers.
|
|
2525
2449
|
* @type {Joints}
|
|
2526
2450
|
* @memberof MotionGroupState
|
|
2527
2451
|
*/
|
|
2528
2452
|
'joint_current'?: Joints;
|
|
2529
2453
|
/**
|
|
2530
|
-
* Pose of the
|
|
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.
|
|
2531
2455
|
* @type {Pose}
|
|
2532
2456
|
* @memberof MotionGroupState
|
|
2533
2457
|
*/
|
|
2534
2458
|
'flange_pose'?: Pose;
|
|
2535
2459
|
/**
|
|
2536
|
-
* Unique identifier addressing the TCP
|
|
2460
|
+
* Unique identifier addressing the active TCP. Might not be returned for positioners as some do not support TCPs, depending on the model.
|
|
2537
2461
|
* @type {string}
|
|
2538
2462
|
* @memberof MotionGroupState
|
|
2539
2463
|
*/
|
|
2540
|
-
'tcp'
|
|
2464
|
+
'tcp'?: string;
|
|
2541
2465
|
/**
|
|
2542
|
-
* Pose of the TCP
|
|
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.
|
|
2543
2467
|
* @type {Pose}
|
|
2544
2468
|
* @memberof MotionGroupState
|
|
2545
2469
|
*/
|
|
2546
|
-
'tcp_pose'
|
|
2470
|
+
'tcp_pose'?: Pose;
|
|
2547
2471
|
/**
|
|
2548
|
-
*
|
|
2549
|
-
* @type {
|
|
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}
|
|
2550
2474
|
* @memberof MotionGroupState
|
|
2551
2475
|
*/
|
|
2552
|
-
'
|
|
2476
|
+
'coordinate_system'?: string;
|
|
2553
2477
|
/**
|
|
2554
|
-
* Unique identifier addressing the
|
|
2478
|
+
* Unique identifier addressing the active payload. Only fetchable via GET endpoint, not available in WebSocket.
|
|
2555
2479
|
* @type {string}
|
|
2556
2480
|
* @memberof MotionGroupState
|
|
2557
2481
|
*/
|
|
2558
|
-
'
|
|
2482
|
+
'payload'?: string;
|
|
2559
2483
|
/**
|
|
2560
|
-
*
|
|
2561
|
-
* @type {
|
|
2484
|
+
* Indicates whether the motion group is in standstill. Convenience: Signals that NOVA treats measured joint velocities as 0.
|
|
2485
|
+
* @type {boolean}
|
|
2562
2486
|
* @memberof MotionGroupState
|
|
2563
2487
|
*/
|
|
2564
|
-
'
|
|
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;
|
|
2565
2495
|
}
|
|
2566
2496
|
/**
|
|
2567
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.
|
|
@@ -2576,97 +2506,6 @@ export interface MotionGroupStateJointLimitReached {
|
|
|
2576
2506
|
*/
|
|
2577
2507
|
'limit_reached': Array<boolean>;
|
|
2578
2508
|
}
|
|
2579
|
-
/**
|
|
2580
|
-
* Presents the current state of the motion group.
|
|
2581
|
-
* @export
|
|
2582
|
-
* @interface MotionGroupStateWithoutPayload
|
|
2583
|
-
*/
|
|
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
2509
|
/**
|
|
2671
2510
|
* Collection of information on the current state of the robot.
|
|
2672
2511
|
* @export
|
|
@@ -2693,94 +2532,28 @@ export interface MotionState {
|
|
|
2693
2532
|
'state': RobotState;
|
|
2694
2533
|
}
|
|
2695
2534
|
/**
|
|
2696
|
-
*
|
|
2535
|
+
* Error message in case an error occurs during movement execution.
|
|
2697
2536
|
* @export
|
|
2698
|
-
* @interface
|
|
2537
|
+
* @interface MovementErrorResponse
|
|
2699
2538
|
*/
|
|
2700
|
-
export interface
|
|
2539
|
+
export interface MovementErrorResponse {
|
|
2701
2540
|
/**
|
|
2702
|
-
*
|
|
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>;
|
|
2713
|
-
/**
|
|
2714
|
-
* optional, unique name of base coordinate system, if empty world is used
|
|
2541
|
+
* Detailed error message describing the issue encountered during movement execution.
|
|
2715
2542
|
* @type {string}
|
|
2716
|
-
* @memberof
|
|
2543
|
+
* @memberof MovementErrorResponse
|
|
2717
2544
|
*/
|
|
2718
|
-
'
|
|
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 {
|
|
2545
|
+
'message': string;
|
|
2739
2546
|
/**
|
|
2740
2547
|
*
|
|
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
2548
|
* @type {string}
|
|
2755
|
-
* @memberof
|
|
2756
|
-
*/
|
|
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
|
|
2549
|
+
* @memberof MovementErrorResponse
|
|
2781
2550
|
*/
|
|
2782
|
-
'
|
|
2551
|
+
'kind': MovementErrorResponseKindEnum;
|
|
2783
2552
|
}
|
|
2553
|
+
export declare const MovementErrorResponseKindEnum: {
|
|
2554
|
+
readonly Error: "ERROR";
|
|
2555
|
+
};
|
|
2556
|
+
export type MovementErrorResponseKindEnum = typeof MovementErrorResponseKindEnum[keyof typeof MovementErrorResponseKindEnum];
|
|
2784
2557
|
/**
|
|
2785
2558
|
*
|
|
2786
2559
|
* @export
|
|
@@ -3003,6 +2776,46 @@ export declare const PathLinePathDefinitionNameEnum: {
|
|
|
3003
2776
|
readonly PathLine: "PathLine";
|
|
3004
2777
|
};
|
|
3005
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];
|
|
3006
2819
|
/**
|
|
3007
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.
|
|
3008
2821
|
* @export
|
|
@@ -3015,49 +2828,34 @@ export interface PauseMovementRequest {
|
|
|
3015
2828
|
* @memberof PauseMovementRequest
|
|
3016
2829
|
*/
|
|
3017
2830
|
'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
2831
|
}
|
|
3025
2832
|
export declare const PauseMovementRequestMessageTypeEnum: {
|
|
3026
2833
|
readonly PauseMovementRequest: "PauseMovementRequest";
|
|
3027
2834
|
};
|
|
3028
2835
|
export type PauseMovementRequestMessageTypeEnum = typeof PauseMovementRequestMessageTypeEnum[keyof typeof PauseMovementRequestMessageTypeEnum];
|
|
3029
2836
|
/**
|
|
3030
|
-
*
|
|
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).
|
|
3031
2838
|
* @export
|
|
3032
2839
|
* @interface PauseMovementResponse
|
|
3033
2840
|
*/
|
|
3034
2841
|
export interface PauseMovementResponse {
|
|
3035
2842
|
/**
|
|
3036
|
-
*
|
|
3037
|
-
* @type {
|
|
2843
|
+
* Error message in case of invalid PauseMovementResquest.
|
|
2844
|
+
* @type {string}
|
|
3038
2845
|
* @memberof PauseMovementResponse
|
|
3039
2846
|
*/
|
|
3040
|
-
'
|
|
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;
|
|
2847
|
+
'message'?: string;
|
|
3054
2848
|
/**
|
|
3055
|
-
*
|
|
2849
|
+
*
|
|
3056
2850
|
* @type {string}
|
|
3057
|
-
* @memberof
|
|
2851
|
+
* @memberof PauseMovementResponse
|
|
3058
2852
|
*/
|
|
3059
|
-
'
|
|
2853
|
+
'kind': PauseMovementResponseKindEnum;
|
|
3060
2854
|
}
|
|
2855
|
+
export declare const PauseMovementResponseKindEnum: {
|
|
2856
|
+
readonly PauseReceived: "PAUSE_RECEIVED";
|
|
2857
|
+
};
|
|
2858
|
+
export type PauseMovementResponseKindEnum = typeof PauseMovementResponseKindEnum[keyof typeof PauseMovementResponseKindEnum];
|
|
3061
2859
|
/**
|
|
3062
2860
|
* Defines an input/output that the motion will be paused for. The motion will stop gracefully on path.
|
|
3063
2861
|
* @export
|
|
@@ -3077,6 +2875,103 @@ export interface PauseOnIO {
|
|
|
3077
2875
|
*/
|
|
3078
2876
|
'comparator': Comparator;
|
|
3079
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];
|
|
3080
2975
|
/**
|
|
3081
2976
|
*
|
|
3082
2977
|
* @export
|
|
@@ -3320,31 +3215,28 @@ export declare const PlaybackSpeedRequestMessageTypeEnum: {
|
|
|
3320
3215
|
};
|
|
3321
3216
|
export type PlaybackSpeedRequestMessageTypeEnum = typeof PlaybackSpeedRequestMessageTypeEnum[keyof typeof PlaybackSpeedRequestMessageTypeEnum];
|
|
3322
3217
|
/**
|
|
3323
|
-
*
|
|
3218
|
+
* Acknowledgment for PlaybackSpeedRequest message.
|
|
3324
3219
|
* @export
|
|
3325
3220
|
* @interface PlaybackSpeedResponse
|
|
3326
3221
|
*/
|
|
3327
3222
|
export interface PlaybackSpeedResponse {
|
|
3328
3223
|
/**
|
|
3329
|
-
*
|
|
3330
|
-
* @type {
|
|
3224
|
+
* Error message in case of invalid PlaybackSpeedRequest.
|
|
3225
|
+
* @type {string}
|
|
3331
3226
|
* @memberof PlaybackSpeedResponse
|
|
3332
3227
|
*/
|
|
3333
|
-
'
|
|
3334
|
-
}
|
|
3335
|
-
/**
|
|
3336
|
-
*
|
|
3337
|
-
* @export
|
|
3338
|
-
* @interface PlaybackSpeedResponsePlaybackSpeedResponse
|
|
3339
|
-
*/
|
|
3340
|
-
export interface PlaybackSpeedResponsePlaybackSpeedResponse {
|
|
3228
|
+
'message'?: string;
|
|
3341
3229
|
/**
|
|
3342
|
-
*
|
|
3343
|
-
* @type {
|
|
3344
|
-
* @memberof
|
|
3230
|
+
*
|
|
3231
|
+
* @type {string}
|
|
3232
|
+
* @memberof PlaybackSpeedResponse
|
|
3345
3233
|
*/
|
|
3346
|
-
'
|
|
3234
|
+
'kind': PlaybackSpeedResponseKindEnum;
|
|
3347
3235
|
}
|
|
3236
|
+
export declare const PlaybackSpeedResponseKindEnum: {
|
|
3237
|
+
readonly PlaybackSpeedReceived: "PLAYBACK_SPEED_RECEIVED";
|
|
3238
|
+
};
|
|
3239
|
+
export type PlaybackSpeedResponseKindEnum = typeof PlaybackSpeedResponseKindEnum[keyof typeof PlaybackSpeedResponseKindEnum];
|
|
3348
3240
|
/**
|
|
3349
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.
|
|
3350
3242
|
* @export
|
|
@@ -3804,6 +3696,46 @@ export interface RobotTcps {
|
|
|
3804
3696
|
*/
|
|
3805
3697
|
'tcps': Array<RobotTcp>;
|
|
3806
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];
|
|
3807
3739
|
/**
|
|
3808
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.
|
|
3809
3741
|
* @export
|
|
@@ -4023,56 +3955,6 @@ export declare const SphereShapeTypeEnum: {
|
|
|
4023
3955
|
readonly Sphere: "sphere";
|
|
4024
3956
|
};
|
|
4025
3957
|
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
3958
|
/**
|
|
4077
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.
|
|
4078
3960
|
* @export
|
|
@@ -4114,6 +3996,29 @@ export declare const StartMovementRequestMessageTypeEnum: {
|
|
|
4114
3996
|
readonly StartMovementRequest: "StartMovementRequest";
|
|
4115
3997
|
};
|
|
4116
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];
|
|
4117
4022
|
/**
|
|
4118
4023
|
* Defines an input/output that the motion should wait for to start the execution.
|
|
4119
4024
|
* @export
|
|
@@ -4225,6 +4130,29 @@ export declare const TcpVelocityRequestMessageTypeEnum: {
|
|
|
4225
4130
|
readonly TcpVelocityRequest: "TcpVelocityRequest";
|
|
4226
4131
|
};
|
|
4227
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];
|
|
4228
4156
|
/**
|
|
4229
4157
|
*
|
|
4230
4158
|
* @export
|
|
@@ -4292,6 +4220,46 @@ export declare const TrajectoryDataMessageTypeEnum: {
|
|
|
4292
4220
|
readonly TrajectoryData: "TrajectoryData";
|
|
4293
4221
|
};
|
|
4294
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;
|
|
4295
4263
|
/**
|
|
4296
4264
|
*
|
|
4297
4265
|
* @export
|
|
@@ -4303,7 +4271,7 @@ export interface TrajectoryId {
|
|
|
4303
4271
|
* @type {string}
|
|
4304
4272
|
* @memberof TrajectoryId
|
|
4305
4273
|
*/
|
|
4306
|
-
'message_type'
|
|
4274
|
+
'message_type'?: TrajectoryIdMessageTypeEnum;
|
|
4307
4275
|
/**
|
|
4308
4276
|
* The identifier of the trajectory which was returned by the [addTrajectory](addTrajectory) endpoint.
|
|
4309
4277
|
* @type {string}
|
|
@@ -4599,6 +4567,23 @@ export interface VirtualRobotConfiguration {
|
|
|
4599
4567
|
*/
|
|
4600
4568
|
'content': string;
|
|
4601
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];
|
|
4602
4587
|
/**
|
|
4603
4588
|
* The value to compare with the current value of the input/output.
|
|
4604
4589
|
* @export
|
|
@@ -6472,7 +6457,7 @@ export declare const MotionGroupApiFp: (configuration?: Configuration) => {
|
|
|
6472
6457
|
* @param {*} [options] Override http request option.
|
|
6473
6458
|
* @throws {RequiredError}
|
|
6474
6459
|
*/
|
|
6475
|
-
streamMotionGroupState(cell: string, motionGroup: string, responseRate?: number, responseCoordinateSystem?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<
|
|
6460
|
+
streamMotionGroupState(cell: string, motionGroup: string, responseRate?: number, responseCoordinateSystem?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<MotionGroupState>>;
|
|
6476
6461
|
};
|
|
6477
6462
|
/**
|
|
6478
6463
|
* MotionGroupApi - factory interface
|
|
@@ -6508,7 +6493,7 @@ export declare const MotionGroupApiFactory: (configuration?: Configuration, base
|
|
|
6508
6493
|
* @param {*} [options] Override http request option.
|
|
6509
6494
|
* @throws {RequiredError}
|
|
6510
6495
|
*/
|
|
6511
|
-
streamMotionGroupState(cell: string, motionGroup: string, responseRate?: number, responseCoordinateSystem?: string, options?: RawAxiosRequestConfig): AxiosPromise<
|
|
6496
|
+
streamMotionGroupState(cell: string, motionGroup: string, responseRate?: number, responseCoordinateSystem?: string, options?: RawAxiosRequestConfig): AxiosPromise<MotionGroupState>;
|
|
6512
6497
|
};
|
|
6513
6498
|
/**
|
|
6514
6499
|
* MotionGroupApi - object-oriented interface
|
|
@@ -6549,7 +6534,7 @@ export declare class MotionGroupApi extends BaseAPI {
|
|
|
6549
6534
|
* @throws {RequiredError}
|
|
6550
6535
|
* @memberof MotionGroupApi
|
|
6551
6536
|
*/
|
|
6552
|
-
streamMotionGroupState(cell: string, motionGroup: string, responseRate?: number, responseCoordinateSystem?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<
|
|
6537
|
+
streamMotionGroupState(cell: string, motionGroup: string, responseRate?: number, responseCoordinateSystem?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<MotionGroupState, any>>;
|
|
6553
6538
|
}
|
|
6554
6539
|
/**
|
|
6555
6540
|
* ProgramApi - axios parameter creator
|