@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/v2/api.ts CHANGED
@@ -1786,11 +1786,11 @@ export interface InvalidDofInvalidDof {
1786
1786
  */
1787
1787
  export interface InverseKinematicsRequest {
1788
1788
  /**
1789
- * The data to assemble the robot setup can be retrieved from [getMotionGroupDescription](getMotionGroupDescription) endpoint.
1790
- * @type {RobotSetup}
1789
+ * String identifiying the model of a motion group.
1790
+ * @type {string}
1791
1791
  * @memberof InverseKinematicsRequest
1792
1792
  */
1793
- 'robot_setup': RobotSetup;
1793
+ 'motion_group_model': string;
1794
1794
  /**
1795
1795
  * List of TCP poses for which the inverse solutions are computed.
1796
1796
  * @type {Array<Pose>}
@@ -1798,17 +1798,29 @@ export interface InverseKinematicsRequest {
1798
1798
  */
1799
1799
  'tcp_poses': Array<Pose>;
1800
1800
  /**
1801
- * A collection of identifiable colliders.
1802
- * @type {{ [key: string]: Collider; }}
1801
+ *
1802
+ * @type {Pose}
1803
1803
  * @memberof InverseKinematicsRequest
1804
1804
  */
1805
- 'static_colliders'?: { [key: string]: Collider; };
1805
+ 'tcp_offset'?: Pose;
1806
1806
  /**
1807
- * Collision motion group.
1808
- * @type {CollisionMotionGroup}
1807
+ * Offset from the world frame to the motion group base.
1808
+ * @type {Pose}
1809
1809
  * @memberof InverseKinematicsRequest
1810
1810
  */
1811
- 'collision_motion_group'?: CollisionMotionGroup;
1811
+ 'mounting'?: Pose;
1812
+ /**
1813
+ * Joint position limits in [rad], indexed starting from base.
1814
+ * @type {Array<PlanningLimitsLimitRange>}
1815
+ * @memberof InverseKinematicsRequest
1816
+ */
1817
+ 'joint_position_limits'?: Array<PlanningLimitsLimitRange>;
1818
+ /**
1819
+ * 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.
1820
+ * @type {{ [key: string]: SingleMotionGroupCollisionScene; }}
1821
+ * @memberof InverseKinematicsRequest
1822
+ */
1823
+ 'collision_scenes'?: { [key: string]: SingleMotionGroupCollisionScene; };
1812
1824
  }
1813
1825
  /**
1814
1826
  *
@@ -3289,7 +3301,7 @@ export type PlaneShapeTypeEnum = typeof PlaneShapeTypeEnum[keyof typeof PlaneSha
3289
3301
  */
3290
3302
  export interface PlanningLimits {
3291
3303
  /**
3292
- * Joint position limits in [rad], configured in the safety setup, starting at base.
3304
+ * Joint position limits in [rad], indexed starting from base.
3293
3305
  * @type {Array<PlanningLimitsLimitRange>}
3294
3306
  * @memberof PlanningLimits
3295
3307
  */
@@ -3825,11 +3837,11 @@ export interface RobotSetup {
3825
3837
  */
3826
3838
  'payload'?: Payload;
3827
3839
  /**
3828
- * Collision scenes to be respected by the motion planner. Each contains the single motion group which is planned for. Every scene is checked individually along the trajectory and independent of the 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.
3829
- * @type {Array<SingleMotionGroupCollisionScene>}
3840
+ * 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.
3841
+ * @type {{ [key: string]: SingleMotionGroupCollisionScene; }}
3830
3842
  * @memberof RobotSetup
3831
3843
  */
3832
- 'collision_scenes'?: Array<SingleMotionGroupCollisionScene>;
3844
+ 'collision_scenes'?: { [key: string]: SingleMotionGroupCollisionScene; };
3833
3845
  }
3834
3846
  /**
3835
3847
  * Collection of information on the current state of the robot.
@@ -4106,17 +4118,23 @@ export interface SingleMotionGroupCollisionScene {
4106
4118
  */
4107
4119
  'static_colliders'?: { [key: string]: Collider; };
4108
4120
  /**
4109
- * The shape of the MotionGroups links to validate against static colliders. Indexed along the kinematic chain, starting with a static base shape before first joint.
4121
+ * 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.
4110
4122
  * @type {Array<{ [key: string]: Collider; }>}
4111
4123
  * @memberof SingleMotionGroupCollisionScene
4112
4124
  */
4113
4125
  'link_chain'?: Array<{ [key: string]: Collider; }>;
4114
4126
  /**
4115
- * A collection of identifiable colliders.
4127
+ * 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.
4116
4128
  * @type {{ [key: string]: Collider; }}
4117
4129
  * @memberof SingleMotionGroupCollisionScene
4118
4130
  */
4119
4131
  'tool'?: { [key: string]: Collider; };
4132
+ /**
4133
+ * If true, self-collision detection is enabled for the motion group. See LinkChain documentation for details. Default is true.
4134
+ * @type {boolean}
4135
+ * @memberof SingleMotionGroupCollisionScene
4136
+ */
4137
+ 'motion_group_self_collision_detection'?: boolean;
4120
4138
  }
4121
4139
  /**
4122
4140
  *
@@ -8114,23 +8132,25 @@ export class ControllerInputsOutputsApi extends BaseAPI {
8114
8132
 
8115
8133
 
8116
8134
  /**
8117
- * InverseKinematicsApi - axios parameter creator
8135
+ * JoggingApi - axios parameter creator
8118
8136
  * @export
8119
8137
  */
8120
- export const InverseKinematicsApiAxiosParamCreator = function (configuration?: Configuration) {
8138
+ export const JoggingApiAxiosParamCreator = function (configuration?: Configuration) {
8121
8139
  return {
8122
8140
  /**
8123
- * Returns the reachable joint positions for a list of given poses.
8124
- * @summary Inverse kinematics
8141
+ * <!-- 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.
8142
+ * @summary Execute Jogging
8125
8143
  * @param {string} cell Unique identifier addressing a cell in all API calls.
8126
- * @param {InverseKinematicsRequest} [inverseKinematicsRequest]
8144
+ * @param {ExecuteJoggingRequest} executeJoggingRequest
8127
8145
  * @param {*} [options] Override http request option.
8128
8146
  * @throws {RequiredError}
8129
8147
  */
8130
- inverseKinematics: async (cell: string, inverseKinematicsRequest?: InverseKinematicsRequest, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
8148
+ executeJogging: async (cell: string, executeJoggingRequest: ExecuteJoggingRequest, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
8131
8149
  // verify required parameter 'cell' is not null or undefined
8132
- assertParamExists('inverseKinematics', 'cell', cell)
8133
- const localVarPath = `/cells/{cell}/kinematic/inverse-kinematics`
8150
+ assertParamExists('executeJogging', 'cell', cell)
8151
+ // verify required parameter 'executeJoggingRequest' is not null or undefined
8152
+ assertParamExists('executeJogging', 'executeJoggingRequest', executeJoggingRequest)
8153
+ const localVarPath = `/cells/{cell}/execution/jogging`
8134
8154
  .replace(`{${"cell"}}`, encodeURIComponent(String(cell)));
8135
8155
  // use dummy base URL string because the URL constructor only accepts absolute URLs.
8136
8156
  const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
@@ -8139,7 +8159,7 @@ export const InverseKinematicsApiAxiosParamCreator = function (configuration?: C
8139
8159
  baseOptions = configuration.baseOptions;
8140
8160
  }
8141
8161
 
8142
- const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
8162
+ const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
8143
8163
  const localVarHeaderParameter = {} as any;
8144
8164
  const localVarQueryParameter = {} as any;
8145
8165
 
@@ -8158,7 +8178,7 @@ export const InverseKinematicsApiAxiosParamCreator = function (configuration?: C
8158
8178
  setSearchParams(localVarUrlObj, localVarQueryParameter);
8159
8179
  let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
8160
8180
  localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
8161
- localVarRequestOptions.data = serializeDataIfNeeded(inverseKinematicsRequest, localVarRequestOptions, configuration)
8181
+ localVarRequestOptions.data = serializeDataIfNeeded(executeJoggingRequest, localVarRequestOptions, configuration)
8162
8182
 
8163
8183
  return {
8164
8184
  url: toPathString(localVarUrlObj),
@@ -8169,93 +8189,91 @@ export const InverseKinematicsApiAxiosParamCreator = function (configuration?: C
8169
8189
  };
8170
8190
 
8171
8191
  /**
8172
- * InverseKinematicsApi - functional programming interface
8192
+ * JoggingApi - functional programming interface
8173
8193
  * @export
8174
8194
  */
8175
- export const InverseKinematicsApiFp = function(configuration?: Configuration) {
8176
- const localVarAxiosParamCreator = InverseKinematicsApiAxiosParamCreator(configuration)
8195
+ export const JoggingApiFp = function(configuration?: Configuration) {
8196
+ const localVarAxiosParamCreator = JoggingApiAxiosParamCreator(configuration)
8177
8197
  return {
8178
8198
  /**
8179
- * Returns the reachable joint positions for a list of given poses.
8180
- * @summary Inverse kinematics
8199
+ * <!-- 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.
8200
+ * @summary Execute Jogging
8181
8201
  * @param {string} cell Unique identifier addressing a cell in all API calls.
8182
- * @param {InverseKinematicsRequest} [inverseKinematicsRequest]
8202
+ * @param {ExecuteJoggingRequest} executeJoggingRequest
8183
8203
  * @param {*} [options] Override http request option.
8184
8204
  * @throws {RequiredError}
8185
8205
  */
8186
- async inverseKinematics(cell: string, inverseKinematicsRequest?: InverseKinematicsRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<InverseKinematicsResponse>> {
8187
- const localVarAxiosArgs = await localVarAxiosParamCreator.inverseKinematics(cell, inverseKinematicsRequest, options);
8206
+ async executeJogging(cell: string, executeJoggingRequest: ExecuteJoggingRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ExecuteJoggingResponse>> {
8207
+ const localVarAxiosArgs = await localVarAxiosParamCreator.executeJogging(cell, executeJoggingRequest, options);
8188
8208
  const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
8189
- const localVarOperationServerBasePath = operationServerMap['InverseKinematicsApi.inverseKinematics']?.[localVarOperationServerIndex]?.url;
8209
+ const localVarOperationServerBasePath = operationServerMap['JoggingApi.executeJogging']?.[localVarOperationServerIndex]?.url;
8190
8210
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
8191
8211
  },
8192
8212
  }
8193
8213
  };
8194
8214
 
8195
8215
  /**
8196
- * InverseKinematicsApi - factory interface
8216
+ * JoggingApi - factory interface
8197
8217
  * @export
8198
8218
  */
8199
- export const InverseKinematicsApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
8200
- const localVarFp = InverseKinematicsApiFp(configuration)
8219
+ export const JoggingApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
8220
+ const localVarFp = JoggingApiFp(configuration)
8201
8221
  return {
8202
8222
  /**
8203
- * Returns the reachable joint positions for a list of given poses.
8204
- * @summary Inverse kinematics
8223
+ * <!-- 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.
8224
+ * @summary Execute Jogging
8205
8225
  * @param {string} cell Unique identifier addressing a cell in all API calls.
8206
- * @param {InverseKinematicsRequest} [inverseKinematicsRequest]
8226
+ * @param {ExecuteJoggingRequest} executeJoggingRequest
8207
8227
  * @param {*} [options] Override http request option.
8208
8228
  * @throws {RequiredError}
8209
8229
  */
8210
- inverseKinematics(cell: string, inverseKinematicsRequest?: InverseKinematicsRequest, options?: RawAxiosRequestConfig): AxiosPromise<InverseKinematicsResponse> {
8211
- return localVarFp.inverseKinematics(cell, inverseKinematicsRequest, options).then((request) => request(axios, basePath));
8230
+ executeJogging(cell: string, executeJoggingRequest: ExecuteJoggingRequest, options?: RawAxiosRequestConfig): AxiosPromise<ExecuteJoggingResponse> {
8231
+ return localVarFp.executeJogging(cell, executeJoggingRequest, options).then((request) => request(axios, basePath));
8212
8232
  },
8213
8233
  };
8214
8234
  };
8215
8235
 
8216
8236
  /**
8217
- * InverseKinematicsApi - object-oriented interface
8237
+ * JoggingApi - object-oriented interface
8218
8238
  * @export
8219
- * @class InverseKinematicsApi
8239
+ * @class JoggingApi
8220
8240
  * @extends {BaseAPI}
8221
8241
  */
8222
- export class InverseKinematicsApi extends BaseAPI {
8242
+ export class JoggingApi extends BaseAPI {
8223
8243
  /**
8224
- * Returns the reachable joint positions for a list of given poses.
8225
- * @summary Inverse kinematics
8244
+ * <!-- 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.
8245
+ * @summary Execute Jogging
8226
8246
  * @param {string} cell Unique identifier addressing a cell in all API calls.
8227
- * @param {InverseKinematicsRequest} [inverseKinematicsRequest]
8247
+ * @param {ExecuteJoggingRequest} executeJoggingRequest
8228
8248
  * @param {*} [options] Override http request option.
8229
8249
  * @throws {RequiredError}
8230
- * @memberof InverseKinematicsApi
8250
+ * @memberof JoggingApi
8231
8251
  */
8232
- public inverseKinematics(cell: string, inverseKinematicsRequest?: InverseKinematicsRequest, options?: RawAxiosRequestConfig) {
8233
- return InverseKinematicsApiFp(this.configuration).inverseKinematics(cell, inverseKinematicsRequest, options).then((request) => request(this.axios, this.basePath));
8252
+ public executeJogging(cell: string, executeJoggingRequest: ExecuteJoggingRequest, options?: RawAxiosRequestConfig) {
8253
+ return JoggingApiFp(this.configuration).executeJogging(cell, executeJoggingRequest, options).then((request) => request(this.axios, this.basePath));
8234
8254
  }
8235
8255
  }
8236
8256
 
8237
8257
 
8238
8258
 
8239
8259
  /**
8240
- * JoggingApi - axios parameter creator
8260
+ * KinematicsApi - axios parameter creator
8241
8261
  * @export
8242
8262
  */
8243
- export const JoggingApiAxiosParamCreator = function (configuration?: Configuration) {
8263
+ export const KinematicsApiAxiosParamCreator = function (configuration?: Configuration) {
8244
8264
  return {
8245
8265
  /**
8246
- * <!-- 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.
8247
- * @summary Execute Jogging
8266
+ * Returns the reachable joint positions for a list of given poses.
8267
+ * @summary Inverse kinematics
8248
8268
  * @param {string} cell Unique identifier addressing a cell in all API calls.
8249
- * @param {ExecuteJoggingRequest} executeJoggingRequest
8269
+ * @param {InverseKinematicsRequest} [inverseKinematicsRequest]
8250
8270
  * @param {*} [options] Override http request option.
8251
8271
  * @throws {RequiredError}
8252
8272
  */
8253
- executeJogging: async (cell: string, executeJoggingRequest: ExecuteJoggingRequest, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
8273
+ inverseKinematics: async (cell: string, inverseKinematicsRequest?: InverseKinematicsRequest, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
8254
8274
  // verify required parameter 'cell' is not null or undefined
8255
- assertParamExists('executeJogging', 'cell', cell)
8256
- // verify required parameter 'executeJoggingRequest' is not null or undefined
8257
- assertParamExists('executeJogging', 'executeJoggingRequest', executeJoggingRequest)
8258
- const localVarPath = `/cells/{cell}/execution/jogging`
8275
+ assertParamExists('inverseKinematics', 'cell', cell)
8276
+ const localVarPath = `/cells/{cell}/kinematic/inverse`
8259
8277
  .replace(`{${"cell"}}`, encodeURIComponent(String(cell)));
8260
8278
  // use dummy base URL string because the URL constructor only accepts absolute URLs.
8261
8279
  const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
@@ -8264,7 +8282,7 @@ export const JoggingApiAxiosParamCreator = function (configuration?: Configurati
8264
8282
  baseOptions = configuration.baseOptions;
8265
8283
  }
8266
8284
 
8267
- const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
8285
+ const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
8268
8286
  const localVarHeaderParameter = {} as any;
8269
8287
  const localVarQueryParameter = {} as any;
8270
8288
 
@@ -8283,7 +8301,7 @@ export const JoggingApiAxiosParamCreator = function (configuration?: Configurati
8283
8301
  setSearchParams(localVarUrlObj, localVarQueryParameter);
8284
8302
  let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
8285
8303
  localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
8286
- localVarRequestOptions.data = serializeDataIfNeeded(executeJoggingRequest, localVarRequestOptions, configuration)
8304
+ localVarRequestOptions.data = serializeDataIfNeeded(inverseKinematicsRequest, localVarRequestOptions, configuration)
8287
8305
 
8288
8306
  return {
8289
8307
  url: toPathString(localVarUrlObj),
@@ -8294,68 +8312,68 @@ export const JoggingApiAxiosParamCreator = function (configuration?: Configurati
8294
8312
  };
8295
8313
 
8296
8314
  /**
8297
- * JoggingApi - functional programming interface
8315
+ * KinematicsApi - functional programming interface
8298
8316
  * @export
8299
8317
  */
8300
- export const JoggingApiFp = function(configuration?: Configuration) {
8301
- const localVarAxiosParamCreator = JoggingApiAxiosParamCreator(configuration)
8318
+ export const KinematicsApiFp = function(configuration?: Configuration) {
8319
+ const localVarAxiosParamCreator = KinematicsApiAxiosParamCreator(configuration)
8302
8320
  return {
8303
8321
  /**
8304
- * <!-- 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.
8305
- * @summary Execute Jogging
8322
+ * Returns the reachable joint positions for a list of given poses.
8323
+ * @summary Inverse kinematics
8306
8324
  * @param {string} cell Unique identifier addressing a cell in all API calls.
8307
- * @param {ExecuteJoggingRequest} executeJoggingRequest
8325
+ * @param {InverseKinematicsRequest} [inverseKinematicsRequest]
8308
8326
  * @param {*} [options] Override http request option.
8309
8327
  * @throws {RequiredError}
8310
8328
  */
8311
- async executeJogging(cell: string, executeJoggingRequest: ExecuteJoggingRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ExecuteJoggingResponse>> {
8312
- const localVarAxiosArgs = await localVarAxiosParamCreator.executeJogging(cell, executeJoggingRequest, options);
8329
+ async inverseKinematics(cell: string, inverseKinematicsRequest?: InverseKinematicsRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<InverseKinematicsResponse>> {
8330
+ const localVarAxiosArgs = await localVarAxiosParamCreator.inverseKinematics(cell, inverseKinematicsRequest, options);
8313
8331
  const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
8314
- const localVarOperationServerBasePath = operationServerMap['JoggingApi.executeJogging']?.[localVarOperationServerIndex]?.url;
8332
+ const localVarOperationServerBasePath = operationServerMap['KinematicsApi.inverseKinematics']?.[localVarOperationServerIndex]?.url;
8315
8333
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
8316
8334
  },
8317
8335
  }
8318
8336
  };
8319
8337
 
8320
8338
  /**
8321
- * JoggingApi - factory interface
8339
+ * KinematicsApi - factory interface
8322
8340
  * @export
8323
8341
  */
8324
- export const JoggingApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
8325
- const localVarFp = JoggingApiFp(configuration)
8342
+ export const KinematicsApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
8343
+ const localVarFp = KinematicsApiFp(configuration)
8326
8344
  return {
8327
8345
  /**
8328
- * <!-- 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.
8329
- * @summary Execute Jogging
8346
+ * Returns the reachable joint positions for a list of given poses.
8347
+ * @summary Inverse kinematics
8330
8348
  * @param {string} cell Unique identifier addressing a cell in all API calls.
8331
- * @param {ExecuteJoggingRequest} executeJoggingRequest
8349
+ * @param {InverseKinematicsRequest} [inverseKinematicsRequest]
8332
8350
  * @param {*} [options] Override http request option.
8333
8351
  * @throws {RequiredError}
8334
8352
  */
8335
- executeJogging(cell: string, executeJoggingRequest: ExecuteJoggingRequest, options?: RawAxiosRequestConfig): AxiosPromise<ExecuteJoggingResponse> {
8336
- return localVarFp.executeJogging(cell, executeJoggingRequest, options).then((request) => request(axios, basePath));
8353
+ inverseKinematics(cell: string, inverseKinematicsRequest?: InverseKinematicsRequest, options?: RawAxiosRequestConfig): AxiosPromise<InverseKinematicsResponse> {
8354
+ return localVarFp.inverseKinematics(cell, inverseKinematicsRequest, options).then((request) => request(axios, basePath));
8337
8355
  },
8338
8356
  };
8339
8357
  };
8340
8358
 
8341
8359
  /**
8342
- * JoggingApi - object-oriented interface
8360
+ * KinematicsApi - object-oriented interface
8343
8361
  * @export
8344
- * @class JoggingApi
8362
+ * @class KinematicsApi
8345
8363
  * @extends {BaseAPI}
8346
8364
  */
8347
- export class JoggingApi extends BaseAPI {
8365
+ export class KinematicsApi extends BaseAPI {
8348
8366
  /**
8349
- * <!-- 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.
8350
- * @summary Execute Jogging
8367
+ * Returns the reachable joint positions for a list of given poses.
8368
+ * @summary Inverse kinematics
8351
8369
  * @param {string} cell Unique identifier addressing a cell in all API calls.
8352
- * @param {ExecuteJoggingRequest} executeJoggingRequest
8370
+ * @param {InverseKinematicsRequest} [inverseKinematicsRequest]
8353
8371
  * @param {*} [options] Override http request option.
8354
8372
  * @throws {RequiredError}
8355
- * @memberof JoggingApi
8373
+ * @memberof KinematicsApi
8356
8374
  */
8357
- public executeJogging(cell: string, executeJoggingRequest: ExecuteJoggingRequest, options?: RawAxiosRequestConfig) {
8358
- return JoggingApiFp(this.configuration).executeJogging(cell, executeJoggingRequest, options).then((request) => request(this.axios, this.basePath));
8375
+ public inverseKinematics(cell: string, inverseKinematicsRequest?: InverseKinematicsRequest, options?: RawAxiosRequestConfig) {
8376
+ return KinematicsApiFp(this.configuration).inverseKinematics(cell, inverseKinematicsRequest, options).then((request) => request(this.axios, this.basePath));
8359
8377
  }
8360
8378
  }
8361
8379