@wandelbots/nova-api 25.6.0-dev.31 → 25.6.0-dev.33
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 +89 -69
- package/v2/api.js +74 -74
- package/v2/api.js.map +1 -1
- package/v2/api.ts +107 -89
package/package.json
CHANGED
package/v2/api.d.ts
CHANGED
|
@@ -1728,11 +1728,11 @@ export interface InvalidDofInvalidDof {
|
|
|
1728
1728
|
*/
|
|
1729
1729
|
export interface InverseKinematicsRequest {
|
|
1730
1730
|
/**
|
|
1731
|
-
*
|
|
1732
|
-
* @type {
|
|
1731
|
+
* String identifiying the model of a motion group.
|
|
1732
|
+
* @type {string}
|
|
1733
1733
|
* @memberof InverseKinematicsRequest
|
|
1734
1734
|
*/
|
|
1735
|
-
'
|
|
1735
|
+
'motion_group_model': string;
|
|
1736
1736
|
/**
|
|
1737
1737
|
* List of TCP poses for which the inverse solutions are computed.
|
|
1738
1738
|
* @type {Array<Pose>}
|
|
@@ -1740,19 +1740,31 @@ export interface InverseKinematicsRequest {
|
|
|
1740
1740
|
*/
|
|
1741
1741
|
'tcp_poses': Array<Pose>;
|
|
1742
1742
|
/**
|
|
1743
|
-
*
|
|
1744
|
-
* @type {
|
|
1743
|
+
*
|
|
1744
|
+
* @type {Pose}
|
|
1745
1745
|
* @memberof InverseKinematicsRequest
|
|
1746
1746
|
*/
|
|
1747
|
-
'
|
|
1748
|
-
|
|
1749
|
-
|
|
1747
|
+
'tcp_offset'?: Pose;
|
|
1748
|
+
/**
|
|
1749
|
+
* Offset from the world frame to the motion group base.
|
|
1750
|
+
* @type {Pose}
|
|
1751
|
+
* @memberof InverseKinematicsRequest
|
|
1752
|
+
*/
|
|
1753
|
+
'mounting'?: Pose;
|
|
1750
1754
|
/**
|
|
1751
|
-
*
|
|
1752
|
-
* @type {
|
|
1755
|
+
* Joint position limits in [rad], indexed starting from base.
|
|
1756
|
+
* @type {Array<PlanningLimitsLimitRange>}
|
|
1753
1757
|
* @memberof InverseKinematicsRequest
|
|
1754
1758
|
*/
|
|
1755
|
-
'
|
|
1759
|
+
'joint_position_limits'?: Array<PlanningLimitsLimitRange>;
|
|
1760
|
+
/**
|
|
1761
|
+
* 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.
|
|
1762
|
+
* @type {{ [key: string]: SingleMotionGroupCollisionScene; }}
|
|
1763
|
+
* @memberof InverseKinematicsRequest
|
|
1764
|
+
*/
|
|
1765
|
+
'collision_scenes'?: {
|
|
1766
|
+
[key: string]: SingleMotionGroupCollisionScene;
|
|
1767
|
+
};
|
|
1756
1768
|
}
|
|
1757
1769
|
/**
|
|
1758
1770
|
*
|
|
@@ -3187,7 +3199,7 @@ export type PlaneShapeTypeEnum = typeof PlaneShapeTypeEnum[keyof typeof PlaneSha
|
|
|
3187
3199
|
*/
|
|
3188
3200
|
export interface PlanningLimits {
|
|
3189
3201
|
/**
|
|
3190
|
-
* Joint position limits in [rad],
|
|
3202
|
+
* Joint position limits in [rad], indexed starting from base.
|
|
3191
3203
|
* @type {Array<PlanningLimitsLimitRange>}
|
|
3192
3204
|
* @memberof PlanningLimits
|
|
3193
3205
|
*/
|
|
@@ -3696,11 +3708,13 @@ export interface RobotSetup {
|
|
|
3696
3708
|
*/
|
|
3697
3709
|
'payload'?: Payload;
|
|
3698
3710
|
/**
|
|
3699
|
-
* Collision scenes to be respected by the motion planner. Each contains the single motion group which is planned for.
|
|
3700
|
-
* @type {
|
|
3711
|
+
* 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.
|
|
3712
|
+
* @type {{ [key: string]: SingleMotionGroupCollisionScene; }}
|
|
3701
3713
|
* @memberof RobotSetup
|
|
3702
3714
|
*/
|
|
3703
|
-
'collision_scenes'?:
|
|
3715
|
+
'collision_scenes'?: {
|
|
3716
|
+
[key: string]: SingleMotionGroupCollisionScene;
|
|
3717
|
+
};
|
|
3704
3718
|
}
|
|
3705
3719
|
/**
|
|
3706
3720
|
* Collection of information on the current state of the robot.
|
|
@@ -3947,7 +3961,7 @@ export interface SingleMotionGroupCollisionScene {
|
|
|
3947
3961
|
[key: string]: Collider;
|
|
3948
3962
|
};
|
|
3949
3963
|
/**
|
|
3950
|
-
*
|
|
3964
|
+
* A link chain is a kinematic chain of links that is connected via joints. A motion group can be used to control the motion of the joints in a link chain. A link is a group of colliders that is attached to the link reference frame. The reference frame of a link is obtained after applying all sets of Denavit-Hartenberg-parameters from base to (including) the link index. This means that the reference frame of the link is on the rotation axis of the next joint in the kinematic chain. Example: For a motion group with 2 joints, the collider reference frame (CRF) for link 1 is on the rotation axis of joint 2. The chain looks like: - Origin >> Mounting >> Base >> (CRF Base) Joint 0 >> Link 0 >> (CRF Link 0) Joint 1 >> Link 1 >> (CRF Link 1) Flange (CRF Tool) >> TCP Adjacent links in the kinematic chain of the motion group are not checked for mutual collision.
|
|
3951
3965
|
* @type {Array<{ [key: string]: Collider; }>}
|
|
3952
3966
|
* @memberof SingleMotionGroupCollisionScene
|
|
3953
3967
|
*/
|
|
@@ -3955,13 +3969,19 @@ export interface SingleMotionGroupCollisionScene {
|
|
|
3955
3969
|
[key: string]: Collider;
|
|
3956
3970
|
}>;
|
|
3957
3971
|
/**
|
|
3958
|
-
* A
|
|
3972
|
+
* Defines the shape of a tool. A tool is a dictionary of colliders. All colliders that make up a tool are attached to the flange frame of the motion group.
|
|
3959
3973
|
* @type {{ [key: string]: Collider; }}
|
|
3960
3974
|
* @memberof SingleMotionGroupCollisionScene
|
|
3961
3975
|
*/
|
|
3962
3976
|
'tool'?: {
|
|
3963
3977
|
[key: string]: Collider;
|
|
3964
3978
|
};
|
|
3979
|
+
/**
|
|
3980
|
+
* If true, self-collision detection is enabled for the motion group. See LinkChain documentation for details. Default is true.
|
|
3981
|
+
* @type {boolean}
|
|
3982
|
+
* @memberof SingleMotionGroupCollisionScene
|
|
3983
|
+
*/
|
|
3984
|
+
'motion_group_self_collision_detection'?: boolean;
|
|
3965
3985
|
}
|
|
3966
3986
|
/**
|
|
3967
3987
|
*
|
|
@@ -6105,130 +6125,130 @@ export declare class ControllerInputsOutputsApi extends BaseAPI {
|
|
|
6105
6125
|
waitForIOEvent(cell: string, controller: string, waitForIOEventRequest: WaitForIOEventRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<boolean, any>>;
|
|
6106
6126
|
}
|
|
6107
6127
|
/**
|
|
6108
|
-
*
|
|
6128
|
+
* JoggingApi - axios parameter creator
|
|
6109
6129
|
* @export
|
|
6110
6130
|
*/
|
|
6111
|
-
export declare const
|
|
6131
|
+
export declare const JoggingApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
6112
6132
|
/**
|
|
6113
|
-
*
|
|
6114
|
-
* @summary
|
|
6133
|
+
* <!-- theme: danger --> > Websocket endpoint Provides execution control over a dynamically adaptable jogging motion for a motion group. Jogging describes controlling a motion group by sending real-time commands to move either its joints or the TCP (Tool Center Point). The commands contain target velocities that may change at any time during execution, so the resulting motion cannot be computed upfront. ### Preconditions The motion group is not moved by any other endpoint. ### Requests #### 1. Send InitializeJoggingRequest to configure the jogging. Sets robot controller mode to control mode. Sets rate and coordinate system for the jogging response. #### 2. Send JointVelocityRequest or TcpVelocityRequest to start the jogging motion. #### 3. Change or stop the jogging motion - Change the jogging direction and/or velocity during the jogging motion with JointVelocityRequest or TcpVelocityRequest. - To stop the jogging motion, send zero velocities via either request. ### Responses - InitializeJoggingResponse is sent to signal the success or failure of the InitializeJoggingRequest. - Jogging responses are streamed continuously after an InitializeJoggingRequest is processed. Jogging responses contain the robot controller state and the state of the jogging control. - JoggingErrorResponse with error details is sent in case of an unexpected error, e.g., controller disconnects during jogging. ### Tips and Tricks - In the JoggingResponse, verify that the robot control is in the desired state, e.g. standstill, with JoggingState. - Ensure that the websocket connection remains open until the jogging motion is stopped to avoid unexpected stops.
|
|
6134
|
+
* @summary Execute Jogging
|
|
6115
6135
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
6116
|
-
* @param {
|
|
6136
|
+
* @param {ExecuteJoggingRequest} executeJoggingRequest
|
|
6117
6137
|
* @param {*} [options] Override http request option.
|
|
6118
6138
|
* @throws {RequiredError}
|
|
6119
6139
|
*/
|
|
6120
|
-
|
|
6140
|
+
executeJogging: (cell: string, executeJoggingRequest: ExecuteJoggingRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
6121
6141
|
};
|
|
6122
6142
|
/**
|
|
6123
|
-
*
|
|
6143
|
+
* JoggingApi - functional programming interface
|
|
6124
6144
|
* @export
|
|
6125
6145
|
*/
|
|
6126
|
-
export declare const
|
|
6146
|
+
export declare const JoggingApiFp: (configuration?: Configuration) => {
|
|
6127
6147
|
/**
|
|
6128
|
-
*
|
|
6129
|
-
* @summary
|
|
6148
|
+
* <!-- theme: danger --> > Websocket endpoint Provides execution control over a dynamically adaptable jogging motion for a motion group. Jogging describes controlling a motion group by sending real-time commands to move either its joints or the TCP (Tool Center Point). The commands contain target velocities that may change at any time during execution, so the resulting motion cannot be computed upfront. ### Preconditions The motion group is not moved by any other endpoint. ### Requests #### 1. Send InitializeJoggingRequest to configure the jogging. Sets robot controller mode to control mode. Sets rate and coordinate system for the jogging response. #### 2. Send JointVelocityRequest or TcpVelocityRequest to start the jogging motion. #### 3. Change or stop the jogging motion - Change the jogging direction and/or velocity during the jogging motion with JointVelocityRequest or TcpVelocityRequest. - To stop the jogging motion, send zero velocities via either request. ### Responses - InitializeJoggingResponse is sent to signal the success or failure of the InitializeJoggingRequest. - Jogging responses are streamed continuously after an InitializeJoggingRequest is processed. Jogging responses contain the robot controller state and the state of the jogging control. - JoggingErrorResponse with error details is sent in case of an unexpected error, e.g., controller disconnects during jogging. ### Tips and Tricks - In the JoggingResponse, verify that the robot control is in the desired state, e.g. standstill, with JoggingState. - Ensure that the websocket connection remains open until the jogging motion is stopped to avoid unexpected stops.
|
|
6149
|
+
* @summary Execute Jogging
|
|
6130
6150
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
6131
|
-
* @param {
|
|
6151
|
+
* @param {ExecuteJoggingRequest} executeJoggingRequest
|
|
6132
6152
|
* @param {*} [options] Override http request option.
|
|
6133
6153
|
* @throws {RequiredError}
|
|
6134
6154
|
*/
|
|
6135
|
-
|
|
6155
|
+
executeJogging(cell: string, executeJoggingRequest: ExecuteJoggingRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ExecuteJoggingResponse>>;
|
|
6136
6156
|
};
|
|
6137
6157
|
/**
|
|
6138
|
-
*
|
|
6158
|
+
* JoggingApi - factory interface
|
|
6139
6159
|
* @export
|
|
6140
6160
|
*/
|
|
6141
|
-
export declare const
|
|
6161
|
+
export declare const JoggingApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
6142
6162
|
/**
|
|
6143
|
-
*
|
|
6144
|
-
* @summary
|
|
6163
|
+
* <!-- theme: danger --> > Websocket endpoint Provides execution control over a dynamically adaptable jogging motion for a motion group. Jogging describes controlling a motion group by sending real-time commands to move either its joints or the TCP (Tool Center Point). The commands contain target velocities that may change at any time during execution, so the resulting motion cannot be computed upfront. ### Preconditions The motion group is not moved by any other endpoint. ### Requests #### 1. Send InitializeJoggingRequest to configure the jogging. Sets robot controller mode to control mode. Sets rate and coordinate system for the jogging response. #### 2. Send JointVelocityRequest or TcpVelocityRequest to start the jogging motion. #### 3. Change or stop the jogging motion - Change the jogging direction and/or velocity during the jogging motion with JointVelocityRequest or TcpVelocityRequest. - To stop the jogging motion, send zero velocities via either request. ### Responses - InitializeJoggingResponse is sent to signal the success or failure of the InitializeJoggingRequest. - Jogging responses are streamed continuously after an InitializeJoggingRequest is processed. Jogging responses contain the robot controller state and the state of the jogging control. - JoggingErrorResponse with error details is sent in case of an unexpected error, e.g., controller disconnects during jogging. ### Tips and Tricks - In the JoggingResponse, verify that the robot control is in the desired state, e.g. standstill, with JoggingState. - Ensure that the websocket connection remains open until the jogging motion is stopped to avoid unexpected stops.
|
|
6164
|
+
* @summary Execute Jogging
|
|
6145
6165
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
6146
|
-
* @param {
|
|
6166
|
+
* @param {ExecuteJoggingRequest} executeJoggingRequest
|
|
6147
6167
|
* @param {*} [options] Override http request option.
|
|
6148
6168
|
* @throws {RequiredError}
|
|
6149
6169
|
*/
|
|
6150
|
-
|
|
6170
|
+
executeJogging(cell: string, executeJoggingRequest: ExecuteJoggingRequest, options?: RawAxiosRequestConfig): AxiosPromise<ExecuteJoggingResponse>;
|
|
6151
6171
|
};
|
|
6152
6172
|
/**
|
|
6153
|
-
*
|
|
6173
|
+
* JoggingApi - object-oriented interface
|
|
6154
6174
|
* @export
|
|
6155
|
-
* @class
|
|
6175
|
+
* @class JoggingApi
|
|
6156
6176
|
* @extends {BaseAPI}
|
|
6157
6177
|
*/
|
|
6158
|
-
export declare class
|
|
6178
|
+
export declare class JoggingApi extends BaseAPI {
|
|
6159
6179
|
/**
|
|
6160
|
-
*
|
|
6161
|
-
* @summary
|
|
6180
|
+
* <!-- theme: danger --> > Websocket endpoint Provides execution control over a dynamically adaptable jogging motion for a motion group. Jogging describes controlling a motion group by sending real-time commands to move either its joints or the TCP (Tool Center Point). The commands contain target velocities that may change at any time during execution, so the resulting motion cannot be computed upfront. ### Preconditions The motion group is not moved by any other endpoint. ### Requests #### 1. Send InitializeJoggingRequest to configure the jogging. Sets robot controller mode to control mode. Sets rate and coordinate system for the jogging response. #### 2. Send JointVelocityRequest or TcpVelocityRequest to start the jogging motion. #### 3. Change or stop the jogging motion - Change the jogging direction and/or velocity during the jogging motion with JointVelocityRequest or TcpVelocityRequest. - To stop the jogging motion, send zero velocities via either request. ### Responses - InitializeJoggingResponse is sent to signal the success or failure of the InitializeJoggingRequest. - Jogging responses are streamed continuously after an InitializeJoggingRequest is processed. Jogging responses contain the robot controller state and the state of the jogging control. - JoggingErrorResponse with error details is sent in case of an unexpected error, e.g., controller disconnects during jogging. ### Tips and Tricks - In the JoggingResponse, verify that the robot control is in the desired state, e.g. standstill, with JoggingState. - Ensure that the websocket connection remains open until the jogging motion is stopped to avoid unexpected stops.
|
|
6181
|
+
* @summary Execute Jogging
|
|
6162
6182
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
6163
|
-
* @param {
|
|
6183
|
+
* @param {ExecuteJoggingRequest} executeJoggingRequest
|
|
6164
6184
|
* @param {*} [options] Override http request option.
|
|
6165
6185
|
* @throws {RequiredError}
|
|
6166
|
-
* @memberof
|
|
6186
|
+
* @memberof JoggingApi
|
|
6167
6187
|
*/
|
|
6168
|
-
|
|
6188
|
+
executeJogging(cell: string, executeJoggingRequest: ExecuteJoggingRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ExecuteJoggingResponse, any>>;
|
|
6169
6189
|
}
|
|
6170
6190
|
/**
|
|
6171
|
-
*
|
|
6191
|
+
* KinematicsApi - axios parameter creator
|
|
6172
6192
|
* @export
|
|
6173
6193
|
*/
|
|
6174
|
-
export declare const
|
|
6194
|
+
export declare const KinematicsApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
6175
6195
|
/**
|
|
6176
|
-
*
|
|
6177
|
-
* @summary
|
|
6196
|
+
* Returns the reachable joint positions for a list of given poses.
|
|
6197
|
+
* @summary Inverse kinematics
|
|
6178
6198
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
6179
|
-
* @param {
|
|
6199
|
+
* @param {InverseKinematicsRequest} [inverseKinematicsRequest]
|
|
6180
6200
|
* @param {*} [options] Override http request option.
|
|
6181
6201
|
* @throws {RequiredError}
|
|
6182
6202
|
*/
|
|
6183
|
-
|
|
6203
|
+
inverseKinematics: (cell: string, inverseKinematicsRequest?: InverseKinematicsRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
6184
6204
|
};
|
|
6185
6205
|
/**
|
|
6186
|
-
*
|
|
6206
|
+
* KinematicsApi - functional programming interface
|
|
6187
6207
|
* @export
|
|
6188
6208
|
*/
|
|
6189
|
-
export declare const
|
|
6209
|
+
export declare const KinematicsApiFp: (configuration?: Configuration) => {
|
|
6190
6210
|
/**
|
|
6191
|
-
*
|
|
6192
|
-
* @summary
|
|
6211
|
+
* Returns the reachable joint positions for a list of given poses.
|
|
6212
|
+
* @summary Inverse kinematics
|
|
6193
6213
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
6194
|
-
* @param {
|
|
6214
|
+
* @param {InverseKinematicsRequest} [inverseKinematicsRequest]
|
|
6195
6215
|
* @param {*} [options] Override http request option.
|
|
6196
6216
|
* @throws {RequiredError}
|
|
6197
6217
|
*/
|
|
6198
|
-
|
|
6218
|
+
inverseKinematics(cell: string, inverseKinematicsRequest?: InverseKinematicsRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<InverseKinematicsResponse>>;
|
|
6199
6219
|
};
|
|
6200
6220
|
/**
|
|
6201
|
-
*
|
|
6221
|
+
* KinematicsApi - factory interface
|
|
6202
6222
|
* @export
|
|
6203
6223
|
*/
|
|
6204
|
-
export declare const
|
|
6224
|
+
export declare const KinematicsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
6205
6225
|
/**
|
|
6206
|
-
*
|
|
6207
|
-
* @summary
|
|
6226
|
+
* Returns the reachable joint positions for a list of given poses.
|
|
6227
|
+
* @summary Inverse kinematics
|
|
6208
6228
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
6209
|
-
* @param {
|
|
6229
|
+
* @param {InverseKinematicsRequest} [inverseKinematicsRequest]
|
|
6210
6230
|
* @param {*} [options] Override http request option.
|
|
6211
6231
|
* @throws {RequiredError}
|
|
6212
6232
|
*/
|
|
6213
|
-
|
|
6233
|
+
inverseKinematics(cell: string, inverseKinematicsRequest?: InverseKinematicsRequest, options?: RawAxiosRequestConfig): AxiosPromise<InverseKinematicsResponse>;
|
|
6214
6234
|
};
|
|
6215
6235
|
/**
|
|
6216
|
-
*
|
|
6236
|
+
* KinematicsApi - object-oriented interface
|
|
6217
6237
|
* @export
|
|
6218
|
-
* @class
|
|
6238
|
+
* @class KinematicsApi
|
|
6219
6239
|
* @extends {BaseAPI}
|
|
6220
6240
|
*/
|
|
6221
|
-
export declare class
|
|
6241
|
+
export declare class KinematicsApi extends BaseAPI {
|
|
6222
6242
|
/**
|
|
6223
|
-
*
|
|
6224
|
-
* @summary
|
|
6243
|
+
* Returns the reachable joint positions for a list of given poses.
|
|
6244
|
+
* @summary Inverse kinematics
|
|
6225
6245
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
6226
|
-
* @param {
|
|
6246
|
+
* @param {InverseKinematicsRequest} [inverseKinematicsRequest]
|
|
6227
6247
|
* @param {*} [options] Override http request option.
|
|
6228
6248
|
* @throws {RequiredError}
|
|
6229
|
-
* @memberof
|
|
6249
|
+
* @memberof KinematicsApi
|
|
6230
6250
|
*/
|
|
6231
|
-
|
|
6251
|
+
inverseKinematics(cell: string, inverseKinematicsRequest?: InverseKinematicsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<InverseKinematicsResponse, any>>;
|
|
6232
6252
|
}
|
|
6233
6253
|
/**
|
|
6234
6254
|
* LicenseApi - axios parameter creator
|