@wandelbots/nova-api 25.6.0-dev.31 → 25.6.0-dev.32

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.js CHANGED
@@ -3494,23 +3494,25 @@ export class ControllerInputsOutputsApi extends BaseAPI {
3494
3494
  }
3495
3495
  }
3496
3496
  /**
3497
- * InverseKinematicsApi - axios parameter creator
3497
+ * JoggingApi - axios parameter creator
3498
3498
  * @export
3499
3499
  */
3500
- export const InverseKinematicsApiAxiosParamCreator = function (configuration) {
3500
+ export const JoggingApiAxiosParamCreator = function (configuration) {
3501
3501
  return {
3502
3502
  /**
3503
- * Returns the reachable joint positions for a list of given poses.
3504
- * @summary Inverse kinematics
3503
+ * <!-- 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.
3504
+ * @summary Execute Jogging
3505
3505
  * @param {string} cell Unique identifier addressing a cell in all API calls.
3506
- * @param {InverseKinematicsRequest} [inverseKinematicsRequest]
3506
+ * @param {ExecuteJoggingRequest} executeJoggingRequest
3507
3507
  * @param {*} [options] Override http request option.
3508
3508
  * @throws {RequiredError}
3509
3509
  */
3510
- inverseKinematics: async (cell, inverseKinematicsRequest, options = {}) => {
3510
+ executeJogging: async (cell, executeJoggingRequest, options = {}) => {
3511
3511
  // verify required parameter 'cell' is not null or undefined
3512
- assertParamExists('inverseKinematics', 'cell', cell);
3513
- const localVarPath = `/cells/{cell}/kinematic/inverse-kinematics`
3512
+ assertParamExists('executeJogging', 'cell', cell);
3513
+ // verify required parameter 'executeJoggingRequest' is not null or undefined
3514
+ assertParamExists('executeJogging', 'executeJoggingRequest', executeJoggingRequest);
3515
+ const localVarPath = `/cells/{cell}/execution/jogging`
3514
3516
  .replace(`{${"cell"}}`, encodeURIComponent(String(cell)));
3515
3517
  // use dummy base URL string because the URL constructor only accepts absolute URLs.
3516
3518
  const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
@@ -3518,7 +3520,7 @@ export const InverseKinematicsApiAxiosParamCreator = function (configuration) {
3518
3520
  if (configuration) {
3519
3521
  baseOptions = configuration.baseOptions;
3520
3522
  }
3521
- const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options };
3523
+ const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options };
3522
3524
  const localVarHeaderParameter = {};
3523
3525
  const localVarQueryParameter = {};
3524
3526
  // authentication BasicAuth required
@@ -3531,7 +3533,7 @@ export const InverseKinematicsApiAxiosParamCreator = function (configuration) {
3531
3533
  setSearchParams(localVarUrlObj, localVarQueryParameter);
3532
3534
  let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
3533
3535
  localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
3534
- localVarRequestOptions.data = serializeDataIfNeeded(inverseKinematicsRequest, localVarRequestOptions, configuration);
3536
+ localVarRequestOptions.data = serializeDataIfNeeded(executeJoggingRequest, localVarRequestOptions, configuration);
3535
3537
  return {
3536
3538
  url: toPathString(localVarUrlObj),
3537
3539
  options: localVarRequestOptions,
@@ -3540,88 +3542,86 @@ export const InverseKinematicsApiAxiosParamCreator = function (configuration) {
3540
3542
  };
3541
3543
  };
3542
3544
  /**
3543
- * InverseKinematicsApi - functional programming interface
3545
+ * JoggingApi - functional programming interface
3544
3546
  * @export
3545
3547
  */
3546
- export const InverseKinematicsApiFp = function (configuration) {
3547
- const localVarAxiosParamCreator = InverseKinematicsApiAxiosParamCreator(configuration);
3548
+ export const JoggingApiFp = function (configuration) {
3549
+ const localVarAxiosParamCreator = JoggingApiAxiosParamCreator(configuration);
3548
3550
  return {
3549
3551
  /**
3550
- * Returns the reachable joint positions for a list of given poses.
3551
- * @summary Inverse kinematics
3552
+ * <!-- 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.
3553
+ * @summary Execute Jogging
3552
3554
  * @param {string} cell Unique identifier addressing a cell in all API calls.
3553
- * @param {InverseKinematicsRequest} [inverseKinematicsRequest]
3555
+ * @param {ExecuteJoggingRequest} executeJoggingRequest
3554
3556
  * @param {*} [options] Override http request option.
3555
3557
  * @throws {RequiredError}
3556
3558
  */
3557
- async inverseKinematics(cell, inverseKinematicsRequest, options) {
3558
- const localVarAxiosArgs = await localVarAxiosParamCreator.inverseKinematics(cell, inverseKinematicsRequest, options);
3559
+ async executeJogging(cell, executeJoggingRequest, options) {
3560
+ const localVarAxiosArgs = await localVarAxiosParamCreator.executeJogging(cell, executeJoggingRequest, options);
3559
3561
  const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
3560
- const localVarOperationServerBasePath = operationServerMap['InverseKinematicsApi.inverseKinematics']?.[localVarOperationServerIndex]?.url;
3562
+ const localVarOperationServerBasePath = operationServerMap['JoggingApi.executeJogging']?.[localVarOperationServerIndex]?.url;
3561
3563
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
3562
3564
  },
3563
3565
  };
3564
3566
  };
3565
3567
  /**
3566
- * InverseKinematicsApi - factory interface
3568
+ * JoggingApi - factory interface
3567
3569
  * @export
3568
3570
  */
3569
- export const InverseKinematicsApiFactory = function (configuration, basePath, axios) {
3570
- const localVarFp = InverseKinematicsApiFp(configuration);
3571
+ export const JoggingApiFactory = function (configuration, basePath, axios) {
3572
+ const localVarFp = JoggingApiFp(configuration);
3571
3573
  return {
3572
3574
  /**
3573
- * Returns the reachable joint positions for a list of given poses.
3574
- * @summary Inverse kinematics
3575
+ * <!-- 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.
3576
+ * @summary Execute Jogging
3575
3577
  * @param {string} cell Unique identifier addressing a cell in all API calls.
3576
- * @param {InverseKinematicsRequest} [inverseKinematicsRequest]
3578
+ * @param {ExecuteJoggingRequest} executeJoggingRequest
3577
3579
  * @param {*} [options] Override http request option.
3578
3580
  * @throws {RequiredError}
3579
3581
  */
3580
- inverseKinematics(cell, inverseKinematicsRequest, options) {
3581
- return localVarFp.inverseKinematics(cell, inverseKinematicsRequest, options).then((request) => request(axios, basePath));
3582
+ executeJogging(cell, executeJoggingRequest, options) {
3583
+ return localVarFp.executeJogging(cell, executeJoggingRequest, options).then((request) => request(axios, basePath));
3582
3584
  },
3583
3585
  };
3584
3586
  };
3585
3587
  /**
3586
- * InverseKinematicsApi - object-oriented interface
3588
+ * JoggingApi - object-oriented interface
3587
3589
  * @export
3588
- * @class InverseKinematicsApi
3590
+ * @class JoggingApi
3589
3591
  * @extends {BaseAPI}
3590
3592
  */
3591
- export class InverseKinematicsApi extends BaseAPI {
3593
+ export class JoggingApi extends BaseAPI {
3592
3594
  /**
3593
- * Returns the reachable joint positions for a list of given poses.
3594
- * @summary Inverse kinematics
3595
+ * <!-- 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.
3596
+ * @summary Execute Jogging
3595
3597
  * @param {string} cell Unique identifier addressing a cell in all API calls.
3596
- * @param {InverseKinematicsRequest} [inverseKinematicsRequest]
3598
+ * @param {ExecuteJoggingRequest} executeJoggingRequest
3597
3599
  * @param {*} [options] Override http request option.
3598
3600
  * @throws {RequiredError}
3599
- * @memberof InverseKinematicsApi
3601
+ * @memberof JoggingApi
3600
3602
  */
3601
- inverseKinematics(cell, inverseKinematicsRequest, options) {
3602
- return InverseKinematicsApiFp(this.configuration).inverseKinematics(cell, inverseKinematicsRequest, options).then((request) => request(this.axios, this.basePath));
3603
+ executeJogging(cell, executeJoggingRequest, options) {
3604
+ return JoggingApiFp(this.configuration).executeJogging(cell, executeJoggingRequest, options).then((request) => request(this.axios, this.basePath));
3603
3605
  }
3604
3606
  }
3605
3607
  /**
3606
- * JoggingApi - axios parameter creator
3608
+ * KinematicsApi - axios parameter creator
3607
3609
  * @export
3608
3610
  */
3609
- export const JoggingApiAxiosParamCreator = function (configuration) {
3611
+ export const KinematicsApiAxiosParamCreator = function (configuration) {
3610
3612
  return {
3611
3613
  /**
3612
- * <!-- 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.
3613
- * @summary Execute Jogging
3614
+ * Returns the reachable joint positions for a list of given poses.
3615
+ * @summary Inverse kinematics
3614
3616
  * @param {string} cell Unique identifier addressing a cell in all API calls.
3615
- * @param {ExecuteJoggingRequest} executeJoggingRequest
3617
+ * @param {InverseKinematicsRequest} [inverseKinematicsRequest]
3616
3618
  * @param {*} [options] Override http request option.
3617
3619
  * @throws {RequiredError}
3618
3620
  */
3619
- executeJogging: async (cell, executeJoggingRequest, options = {}) => {
3621
+ inverseKinematics: async (cell, inverseKinematicsRequest, options = {}) => {
3620
3622
  // verify required parameter 'cell' is not null or undefined
3621
- assertParamExists('executeJogging', 'cell', cell);
3622
- // verify required parameter 'executeJoggingRequest' is not null or undefined
3623
- assertParamExists('executeJogging', 'executeJoggingRequest', executeJoggingRequest);
3624
- const localVarPath = `/cells/{cell}/execution/jogging`
3623
+ assertParamExists('inverseKinematics', 'cell', cell);
3624
+ const localVarPath = `/cells/{cell}/kinematic/inverse`
3625
3625
  .replace(`{${"cell"}}`, encodeURIComponent(String(cell)));
3626
3626
  // use dummy base URL string because the URL constructor only accepts absolute URLs.
3627
3627
  const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
@@ -3629,7 +3629,7 @@ export const JoggingApiAxiosParamCreator = function (configuration) {
3629
3629
  if (configuration) {
3630
3630
  baseOptions = configuration.baseOptions;
3631
3631
  }
3632
- const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options };
3632
+ const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options };
3633
3633
  const localVarHeaderParameter = {};
3634
3634
  const localVarQueryParameter = {};
3635
3635
  // authentication BasicAuth required
@@ -3642,7 +3642,7 @@ export const JoggingApiAxiosParamCreator = function (configuration) {
3642
3642
  setSearchParams(localVarUrlObj, localVarQueryParameter);
3643
3643
  let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
3644
3644
  localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
3645
- localVarRequestOptions.data = serializeDataIfNeeded(executeJoggingRequest, localVarRequestOptions, configuration);
3645
+ localVarRequestOptions.data = serializeDataIfNeeded(inverseKinematicsRequest, localVarRequestOptions, configuration);
3646
3646
  return {
3647
3647
  url: toPathString(localVarUrlObj),
3648
3648
  options: localVarRequestOptions,
@@ -3651,66 +3651,66 @@ export const JoggingApiAxiosParamCreator = function (configuration) {
3651
3651
  };
3652
3652
  };
3653
3653
  /**
3654
- * JoggingApi - functional programming interface
3654
+ * KinematicsApi - functional programming interface
3655
3655
  * @export
3656
3656
  */
3657
- export const JoggingApiFp = function (configuration) {
3658
- const localVarAxiosParamCreator = JoggingApiAxiosParamCreator(configuration);
3657
+ export const KinematicsApiFp = function (configuration) {
3658
+ const localVarAxiosParamCreator = KinematicsApiAxiosParamCreator(configuration);
3659
3659
  return {
3660
3660
  /**
3661
- * <!-- 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.
3662
- * @summary Execute Jogging
3661
+ * Returns the reachable joint positions for a list of given poses.
3662
+ * @summary Inverse kinematics
3663
3663
  * @param {string} cell Unique identifier addressing a cell in all API calls.
3664
- * @param {ExecuteJoggingRequest} executeJoggingRequest
3664
+ * @param {InverseKinematicsRequest} [inverseKinematicsRequest]
3665
3665
  * @param {*} [options] Override http request option.
3666
3666
  * @throws {RequiredError}
3667
3667
  */
3668
- async executeJogging(cell, executeJoggingRequest, options) {
3669
- const localVarAxiosArgs = await localVarAxiosParamCreator.executeJogging(cell, executeJoggingRequest, options);
3668
+ async inverseKinematics(cell, inverseKinematicsRequest, options) {
3669
+ const localVarAxiosArgs = await localVarAxiosParamCreator.inverseKinematics(cell, inverseKinematicsRequest, options);
3670
3670
  const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
3671
- const localVarOperationServerBasePath = operationServerMap['JoggingApi.executeJogging']?.[localVarOperationServerIndex]?.url;
3671
+ const localVarOperationServerBasePath = operationServerMap['KinematicsApi.inverseKinematics']?.[localVarOperationServerIndex]?.url;
3672
3672
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
3673
3673
  },
3674
3674
  };
3675
3675
  };
3676
3676
  /**
3677
- * JoggingApi - factory interface
3677
+ * KinematicsApi - factory interface
3678
3678
  * @export
3679
3679
  */
3680
- export const JoggingApiFactory = function (configuration, basePath, axios) {
3681
- const localVarFp = JoggingApiFp(configuration);
3680
+ export const KinematicsApiFactory = function (configuration, basePath, axios) {
3681
+ const localVarFp = KinematicsApiFp(configuration);
3682
3682
  return {
3683
3683
  /**
3684
- * <!-- 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.
3685
- * @summary Execute Jogging
3684
+ * Returns the reachable joint positions for a list of given poses.
3685
+ * @summary Inverse kinematics
3686
3686
  * @param {string} cell Unique identifier addressing a cell in all API calls.
3687
- * @param {ExecuteJoggingRequest} executeJoggingRequest
3687
+ * @param {InverseKinematicsRequest} [inverseKinematicsRequest]
3688
3688
  * @param {*} [options] Override http request option.
3689
3689
  * @throws {RequiredError}
3690
3690
  */
3691
- executeJogging(cell, executeJoggingRequest, options) {
3692
- return localVarFp.executeJogging(cell, executeJoggingRequest, options).then((request) => request(axios, basePath));
3691
+ inverseKinematics(cell, inverseKinematicsRequest, options) {
3692
+ return localVarFp.inverseKinematics(cell, inverseKinematicsRequest, options).then((request) => request(axios, basePath));
3693
3693
  },
3694
3694
  };
3695
3695
  };
3696
3696
  /**
3697
- * JoggingApi - object-oriented interface
3697
+ * KinematicsApi - object-oriented interface
3698
3698
  * @export
3699
- * @class JoggingApi
3699
+ * @class KinematicsApi
3700
3700
  * @extends {BaseAPI}
3701
3701
  */
3702
- export class JoggingApi extends BaseAPI {
3702
+ export class KinematicsApi extends BaseAPI {
3703
3703
  /**
3704
- * <!-- 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.
3705
- * @summary Execute Jogging
3704
+ * Returns the reachable joint positions for a list of given poses.
3705
+ * @summary Inverse kinematics
3706
3706
  * @param {string} cell Unique identifier addressing a cell in all API calls.
3707
- * @param {ExecuteJoggingRequest} executeJoggingRequest
3707
+ * @param {InverseKinematicsRequest} [inverseKinematicsRequest]
3708
3708
  * @param {*} [options] Override http request option.
3709
3709
  * @throws {RequiredError}
3710
- * @memberof JoggingApi
3710
+ * @memberof KinematicsApi
3711
3711
  */
3712
- executeJogging(cell, executeJoggingRequest, options) {
3713
- return JoggingApiFp(this.configuration).executeJogging(cell, executeJoggingRequest, options).then((request) => request(this.axios, this.basePath));
3712
+ inverseKinematics(cell, inverseKinematicsRequest, options) {
3713
+ return KinematicsApiFp(this.configuration).inverseKinematics(cell, inverseKinematicsRequest, options).then((request) => request(this.axios, this.basePath));
3714
3714
  }
3715
3715
  }
3716
3716
  /**