@wandelbots/nova-api 25.6.0-dev.30 → 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.
Files changed (5) hide show
  1. package/package.json +1 -1
  2. package/v2/api.d.ts +121 -285
  3. package/v2/api.js +126 -126
  4. package/v2/api.js.map +1 -1
  5. package/v2/api.ts +160 -326
package/v2/api.d.ts CHANGED
@@ -747,92 +747,6 @@ export interface ContainerStorage {
747
747
  */
748
748
  'capacity': string;
749
749
  }
750
- /**
751
- * The data type to describe a robot controller.
752
- * @export
753
- * @interface Controller
754
- */
755
- export interface Controller {
756
- /**
757
- * The unique identifier to address the robot controller in the cell.
758
- * @type {string}
759
- * @memberof Controller
760
- */
761
- 'controller': string;
762
- /**
763
- * The unique identifier to address a robot controller model when configuring the robot controller. Used for evaluation of the robot controller model and to ensure communication with the expected robot controller type.
764
- * @type {string}
765
- * @memberof Controller
766
- */
767
- 'model_name': string;
768
- /**
769
- * Resolvable host name or IP address that connects to the robot controller.
770
- * @type {string}
771
- * @memberof Controller
772
- */
773
- 'host': string;
774
- /**
775
- * True if the user has actively confirmed that it is allowed to install required communication software onto the robot controller. NOTE: Installing third party software on a robot controller can result in liability issues in regard to the actual certified state of the robot system. Please contact your company\'s legal responsible before installing third party software.
776
- * @type {boolean}
777
- * @memberof Controller
778
- */
779
- 'allow_software_install_on_controller': boolean;
780
- /**
781
- * The list of physical connected motion groups as detected by the controller.
782
- * @type {Array<MotionGroupInstance>}
783
- * @memberof Controller
784
- */
785
- 'motion_groups': Array<MotionGroupInstance>;
786
- /**
787
- *
788
- * @type {VersionNumber}
789
- * @memberof Controller
790
- */
791
- 'vendor_software_version'?: VersionNumber;
792
- /**
793
- * Set to true if there was an error while inspecting this instance, e.g. The robot controller is not reachable due to missing network connection or turned off. The instance remains configured but can\'t provide information on the robot controller.
794
- * @type {boolean}
795
- * @memberof Controller
796
- */
797
- 'has_error': boolean;
798
- /**
799
- * If has_error is true, error_details provides detailed background information about the error.
800
- * @type {string}
801
- * @memberof Controller
802
- */
803
- 'error_details'?: string;
804
- /**
805
- * Can this controller be moved through freedrive (true), or not (false).
806
- * @type {boolean}
807
- * @memberof Controller
808
- */
809
- 'supports_freedrive': boolean;
810
- /**
811
- * Can this controller be controlled with NOVA (true) or is it only possible to read data (false).
812
- * @type {boolean}
813
- * @memberof Controller
814
- */
815
- 'supports_control': boolean;
816
- /**
817
- * True if NOVA supports reading safety zone-, tool- and link-geometries for this motion group. Safety zones are used to define areas where the robot should slow down or stop. If false, NOVA can not guarantuee that the executed motions respect safety zones defined by the controller.
818
- * @type {boolean}
819
- * @memberof Controller
820
- */
821
- 'supports_safety_zones': boolean;
822
- }
823
- /**
824
- * The list of configured robot controllers.
825
- * @export
826
- * @interface ControllersList
827
- */
828
- export interface ControllersList {
829
- /**
830
- *
831
- * @type {Array<Controller>}
832
- * @memberof ControllersList
833
- */
834
- 'controllers': Array<Controller>;
835
- }
836
750
  /**
837
751
  * Defines a convex hull encapsulating a set of vertices.
838
752
  * @export
@@ -1814,11 +1728,11 @@ export interface InvalidDofInvalidDof {
1814
1728
  */
1815
1729
  export interface InverseKinematicsRequest {
1816
1730
  /**
1817
- * The data to assemble the robot setup can be retrieved from [getMotionGroupDescription](getMotionGroupDescription) endpoint.
1818
- * @type {RobotSetup}
1731
+ * String identifiying the model of a motion group.
1732
+ * @type {string}
1819
1733
  * @memberof InverseKinematicsRequest
1820
1734
  */
1821
- 'robot_setup': RobotSetup;
1735
+ 'motion_group_model': string;
1822
1736
  /**
1823
1737
  * List of TCP poses for which the inverse solutions are computed.
1824
1738
  * @type {Array<Pose>}
@@ -1826,19 +1740,31 @@ export interface InverseKinematicsRequest {
1826
1740
  */
1827
1741
  'tcp_poses': Array<Pose>;
1828
1742
  /**
1829
- * A collection of identifiable colliders.
1830
- * @type {{ [key: string]: Collider; }}
1743
+ *
1744
+ * @type {Pose}
1831
1745
  * @memberof InverseKinematicsRequest
1832
1746
  */
1833
- 'static_colliders'?: {
1834
- [key: string]: Collider;
1835
- };
1747
+ 'tcp_offset'?: Pose;
1836
1748
  /**
1837
- * Collision motion group.
1838
- * @type {CollisionMotionGroup}
1749
+ * Offset from the world frame to the motion group base.
1750
+ * @type {Pose}
1751
+ * @memberof InverseKinematicsRequest
1752
+ */
1753
+ 'mounting'?: Pose;
1754
+ /**
1755
+ * Joint position limits in [rad], indexed starting from base.
1756
+ * @type {Array<PlanningLimitsLimitRange>}
1839
1757
  * @memberof InverseKinematicsRequest
1840
1758
  */
1841
- 'collision_motion_group'?: CollisionMotionGroup;
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
+ };
1842
1768
  }
1843
1769
  /**
1844
1770
  *
@@ -2503,49 +2429,6 @@ export interface MotionGroupInfos {
2503
2429
  */
2504
2430
  'motion_groups': Array<MotionGroupInfo>;
2505
2431
  }
2506
- /**
2507
- * The data type describes the physically connected motion groups on a robot controller, e.g., a robot arm.
2508
- * @export
2509
- * @interface MotionGroupInstance
2510
- */
2511
- export interface MotionGroupInstance {
2512
- /**
2513
- * Identifier of the motion group.
2514
- * @type {string}
2515
- * @memberof MotionGroupInstance
2516
- */
2517
- 'motion_group': string;
2518
- /**
2519
- * Identifier of the robot controller the motion group is attached to.
2520
- * @type {string}
2521
- * @memberof MotionGroupInstance
2522
- */
2523
- 'controller': string;
2524
- /**
2525
- * The name of the motion group has on the robot controller.
2526
- * @type {string}
2527
- * @memberof MotionGroupInstance
2528
- */
2529
- 'name_from_controller': string;
2530
- /**
2531
- * The robot controller model, if available. Usable for frontend 3D visualization.
2532
- * @type {string}
2533
- * @memberof MotionGroupInstance
2534
- */
2535
- 'model_from_controller': string;
2536
- /**
2537
- * The serial number of the motion group, if available. If not available, the serial number of the robot controller. if available. If not available, then empty.
2538
- * @type {string}
2539
- * @memberof MotionGroupInstance
2540
- */
2541
- 'serial_number'?: string;
2542
- /**
2543
- * True if NOVA supports inverse kinematics for this motion group. Inverse kinematics is used to calculate the joint angles from the end effector position. If inverse kinematics is not supported, cartesian jogging is not possible.
2544
- * @type {boolean}
2545
- * @memberof MotionGroupInstance
2546
- */
2547
- 'has_inverse_kinematics': boolean;
2548
- }
2549
2432
  /**
2550
2433
  * Ensure to provide one value for each joint. See [getMotionGroups](getMotionGroups) for the number of joints. Everything but positions is optional.
2551
2434
  * @export
@@ -3316,7 +3199,7 @@ export type PlaneShapeTypeEnum = typeof PlaneShapeTypeEnum[keyof typeof PlaneSha
3316
3199
  */
3317
3200
  export interface PlanningLimits {
3318
3201
  /**
3319
- * Joint position limits in [rad], configured in the safety setup, starting at base.
3202
+ * Joint position limits in [rad], indexed starting from base.
3320
3203
  * @type {Array<PlanningLimitsLimitRange>}
3321
3204
  * @memberof PlanningLimits
3322
3205
  */
@@ -3825,11 +3708,13 @@ export interface RobotSetup {
3825
3708
  */
3826
3709
  'payload'?: Payload;
3827
3710
  /**
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>}
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; }}
3830
3713
  * @memberof RobotSetup
3831
3714
  */
3832
- 'collision_scenes'?: Array<SingleMotionGroupCollisionScene>;
3715
+ 'collision_scenes'?: {
3716
+ [key: string]: SingleMotionGroupCollisionScene;
3717
+ };
3833
3718
  }
3834
3719
  /**
3835
3720
  * Collection of information on the current state of the robot.
@@ -4076,7 +3961,7 @@ export interface SingleMotionGroupCollisionScene {
4076
3961
  [key: string]: Collider;
4077
3962
  };
4078
3963
  /**
4079
- * 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.
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.
4080
3965
  * @type {Array<{ [key: string]: Collider; }>}
4081
3966
  * @memberof SingleMotionGroupCollisionScene
4082
3967
  */
@@ -4084,13 +3969,19 @@ export interface SingleMotionGroupCollisionScene {
4084
3969
  [key: string]: Collider;
4085
3970
  }>;
4086
3971
  /**
4087
- * A collection of identifiable colliders.
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.
4088
3973
  * @type {{ [key: string]: Collider; }}
4089
3974
  * @memberof SingleMotionGroupCollisionScene
4090
3975
  */
4091
3976
  'tool'?: {
4092
3977
  [key: string]: Collider;
4093
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;
4094
3985
  }
4095
3986
  /**
4096
3987
  *
@@ -4527,61 +4418,6 @@ export interface ValidationError2 {
4527
4418
  * @export
4528
4419
  */
4529
4420
  export type ValidationErrorLocInner = number | string;
4530
- /**
4531
- * A generic representation of a version number.
4532
- * @export
4533
- * @interface VersionNumber
4534
- */
4535
- export interface VersionNumber {
4536
- /**
4537
- *
4538
- * @type {number}
4539
- * @memberof VersionNumber
4540
- */
4541
- 'major_version': number;
4542
- /**
4543
- *
4544
- * @type {number}
4545
- * @memberof VersionNumber
4546
- */
4547
- 'minor_version'?: number;
4548
- /**
4549
- *
4550
- * @type {number}
4551
- * @memberof VersionNumber
4552
- */
4553
- 'build_version'?: number;
4554
- /**
4555
- *
4556
- * @type {number}
4557
- * @memberof VersionNumber
4558
- */
4559
- 'bugfix_version'?: number;
4560
- /**
4561
- * If minor version is a wildcard set to true.
4562
- * @type {boolean}
4563
- * @memberof VersionNumber
4564
- */
4565
- 'minor_version_wildcard'?: boolean;
4566
- /**
4567
- * If build version is a wildcard set to true.
4568
- * @type {boolean}
4569
- * @memberof VersionNumber
4570
- */
4571
- 'build_version_wildcard'?: boolean;
4572
- /**
4573
- * If bugfix version is a wildcard set to true.
4574
- * @type {boolean}
4575
- * @memberof VersionNumber
4576
- */
4577
- 'bugfix_version_wildcard'?: boolean;
4578
- /**
4579
- * A string representation of the version e.g. 1.1.x.x.
4580
- * @type {string}
4581
- * @memberof VersionNumber
4582
- */
4583
- 'string_version'?: string;
4584
- }
4585
4421
  /**
4586
4422
  * The configuration of a virtual robot controller has to contain the manufacturer string, an optional joint position string array and either a type or the full JSON configuration. The JSON config of a physical controller can be obtained via `/cells/{cell}/controllers/{controller}/virtual-robot-configuration`
4587
4423
  * @export
@@ -5546,14 +5382,6 @@ export declare const ControllerApiAxiosParamCreator: (configuration?: Configurat
5546
5382
  * @throws {RequiredError}
5547
5383
  */
5548
5384
  getVirtualRobotConfiguration: (cell: string, controller: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
5549
- /**
5550
- * List all configured robot controllers.
5551
- * @summary List Descriptions
5552
- * @param {string} cell Unique identifier addressing a cell in all API calls.
5553
- * @param {*} [options] Override http request option.
5554
- * @throws {RequiredError}
5555
- */
5556
- listControllers: (cell: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
5557
5385
  /**
5558
5386
  * Lists all specifications of coordinate systems from robot controllers. Use parameter orientation_type to get the orientation part of the transformation offset of the coordinate system returned in the requested orientation notation. If parameter orientation_type is not set, the orientation part of the transformation offset of the coordinate system is returned in rotation vector notation. The coordinate systems from the robot controller are loaded when the motion group associated with the coordinate system is activated. With deactivation of the motion group, the associated coordinate systems are removed from NOVA. The unique identifier of the coordinate systems from the robot controllers are suffixed with \"On\" + the unique identifier of the robot controller.
5559
5387
  * @summary List Coordinate Systems
@@ -5564,6 +5392,14 @@ export declare const ControllerApiAxiosParamCreator: (configuration?: Configurat
5564
5392
  * @throws {RequiredError}
5565
5393
  */
5566
5394
  listCoordinateSystems: (cell: string, controller: string, orientationType?: OrientationType, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
5395
+ /**
5396
+ * List the names of all deployed robot controllers.
5397
+ * @summary List Robot Controllers
5398
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
5399
+ * @param {*} [options] Override http request option.
5400
+ * @throws {RequiredError}
5401
+ */
5402
+ listRobotControllers: (cell: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
5567
5403
  /**
5568
5404
  * Switch between monitor and control usage as default for a robot controller. Monitoring mode is used to read information from the robot controller and control mode is used to command the robot system. As long as the robot controller is connected via network monitoring mode is always possible. To switch to control mode the robot controller must be in `automatic` or `manual` operating mode and safety state \'normal\' or \'reduced\'. If the robot controller is in `manual` operating mode, you have manually confirm the control usage activation on the robot control panel. This manual confirmation can\'t be replaced with this API. Without manual confirmation the robot controller will stay in monitor mode. The robot system will try to activate the required operation mode for the requested usage unless no active call requires a different mode. > **NOTE** > > Some robot controllers prevent the external activation of automatic operating mode. In this case, changing the operating mode manually at the robot controller is mandatory. > **NOTE** > > The current operation mode and safety state can be requested via [getCurrentRobotControllerState](getCurrentRobotControllerState). If a mode change is not possible, the response lists reasons for the failed change.
5569
5405
  * @summary Set Default Mode
@@ -5687,14 +5523,6 @@ export declare const ControllerApiFp: (configuration?: Configuration) => {
5687
5523
  * @throws {RequiredError}
5688
5524
  */
5689
5525
  getVirtualRobotConfiguration(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<VirtualRobotConfiguration>>;
5690
- /**
5691
- * List all configured robot controllers.
5692
- * @summary List Descriptions
5693
- * @param {string} cell Unique identifier addressing a cell in all API calls.
5694
- * @param {*} [options] Override http request option.
5695
- * @throws {RequiredError}
5696
- */
5697
- listControllers(cell: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ControllersList>>;
5698
5526
  /**
5699
5527
  * Lists all specifications of coordinate systems from robot controllers. Use parameter orientation_type to get the orientation part of the transformation offset of the coordinate system returned in the requested orientation notation. If parameter orientation_type is not set, the orientation part of the transformation offset of the coordinate system is returned in rotation vector notation. The coordinate systems from the robot controller are loaded when the motion group associated with the coordinate system is activated. With deactivation of the motion group, the associated coordinate systems are removed from NOVA. The unique identifier of the coordinate systems from the robot controllers are suffixed with \"On\" + the unique identifier of the robot controller.
5700
5528
  * @summary List Coordinate Systems
@@ -5705,6 +5533,14 @@ export declare const ControllerApiFp: (configuration?: Configuration) => {
5705
5533
  * @throws {RequiredError}
5706
5534
  */
5707
5535
  listCoordinateSystems(cell: string, controller: string, orientationType?: OrientationType, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListCoordinateSystemsResponse>>;
5536
+ /**
5537
+ * List the names of all deployed robot controllers.
5538
+ * @summary List Robot Controllers
5539
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
5540
+ * @param {*} [options] Override http request option.
5541
+ * @throws {RequiredError}
5542
+ */
5543
+ listRobotControllers(cell: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<string>>>;
5708
5544
  /**
5709
5545
  * Switch between monitor and control usage as default for a robot controller. Monitoring mode is used to read information from the robot controller and control mode is used to command the robot system. As long as the robot controller is connected via network monitoring mode is always possible. To switch to control mode the robot controller must be in `automatic` or `manual` operating mode and safety state \'normal\' or \'reduced\'. If the robot controller is in `manual` operating mode, you have manually confirm the control usage activation on the robot control panel. This manual confirmation can\'t be replaced with this API. Without manual confirmation the robot controller will stay in monitor mode. The robot system will try to activate the required operation mode for the requested usage unless no active call requires a different mode. > **NOTE** > > Some robot controllers prevent the external activation of automatic operating mode. In this case, changing the operating mode manually at the robot controller is mandatory. > **NOTE** > > The current operation mode and safety state can be requested via [getCurrentRobotControllerState](getCurrentRobotControllerState). If a mode change is not possible, the response lists reasons for the failed change.
5710
5546
  * @summary Set Default Mode
@@ -5828,14 +5664,6 @@ export declare const ControllerApiFactory: (configuration?: Configuration, baseP
5828
5664
  * @throws {RequiredError}
5829
5665
  */
5830
5666
  getVirtualRobotConfiguration(cell: string, controller: string, options?: RawAxiosRequestConfig): AxiosPromise<VirtualRobotConfiguration>;
5831
- /**
5832
- * List all configured robot controllers.
5833
- * @summary List Descriptions
5834
- * @param {string} cell Unique identifier addressing a cell in all API calls.
5835
- * @param {*} [options] Override http request option.
5836
- * @throws {RequiredError}
5837
- */
5838
- listControllers(cell: string, options?: RawAxiosRequestConfig): AxiosPromise<ControllersList>;
5839
5667
  /**
5840
5668
  * Lists all specifications of coordinate systems from robot controllers. Use parameter orientation_type to get the orientation part of the transformation offset of the coordinate system returned in the requested orientation notation. If parameter orientation_type is not set, the orientation part of the transformation offset of the coordinate system is returned in rotation vector notation. The coordinate systems from the robot controller are loaded when the motion group associated with the coordinate system is activated. With deactivation of the motion group, the associated coordinate systems are removed from NOVA. The unique identifier of the coordinate systems from the robot controllers are suffixed with \"On\" + the unique identifier of the robot controller.
5841
5669
  * @summary List Coordinate Systems
@@ -5846,6 +5674,14 @@ export declare const ControllerApiFactory: (configuration?: Configuration, baseP
5846
5674
  * @throws {RequiredError}
5847
5675
  */
5848
5676
  listCoordinateSystems(cell: string, controller: string, orientationType?: OrientationType, options?: RawAxiosRequestConfig): AxiosPromise<ListCoordinateSystemsResponse>;
5677
+ /**
5678
+ * List the names of all deployed robot controllers.
5679
+ * @summary List Robot Controllers
5680
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
5681
+ * @param {*} [options] Override http request option.
5682
+ * @throws {RequiredError}
5683
+ */
5684
+ listRobotControllers(cell: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<string>>;
5849
5685
  /**
5850
5686
  * Switch between monitor and control usage as default for a robot controller. Monitoring mode is used to read information from the robot controller and control mode is used to command the robot system. As long as the robot controller is connected via network monitoring mode is always possible. To switch to control mode the robot controller must be in `automatic` or `manual` operating mode and safety state \'normal\' or \'reduced\'. If the robot controller is in `manual` operating mode, you have manually confirm the control usage activation on the robot control panel. This manual confirmation can\'t be replaced with this API. Without manual confirmation the robot controller will stay in monitor mode. The robot system will try to activate the required operation mode for the requested usage unless no active call requires a different mode. > **NOTE** > > Some robot controllers prevent the external activation of automatic operating mode. In this case, changing the operating mode manually at the robot controller is mandatory. > **NOTE** > > The current operation mode and safety state can be requested via [getCurrentRobotControllerState](getCurrentRobotControllerState). If a mode change is not possible, the response lists reasons for the failed change.
5851
5687
  * @summary Set Default Mode
@@ -5980,25 +5816,25 @@ export declare class ControllerApi extends BaseAPI {
5980
5816
  */
5981
5817
  getVirtualRobotConfiguration(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<VirtualRobotConfiguration, any>>;
5982
5818
  /**
5983
- * List all configured robot controllers.
5984
- * @summary List Descriptions
5819
+ * Lists all specifications of coordinate systems from robot controllers. Use parameter orientation_type to get the orientation part of the transformation offset of the coordinate system returned in the requested orientation notation. If parameter orientation_type is not set, the orientation part of the transformation offset of the coordinate system is returned in rotation vector notation. The coordinate systems from the robot controller are loaded when the motion group associated with the coordinate system is activated. With deactivation of the motion group, the associated coordinate systems are removed from NOVA. The unique identifier of the coordinate systems from the robot controllers are suffixed with \"On\" + the unique identifier of the robot controller.
5820
+ * @summary List Coordinate Systems
5985
5821
  * @param {string} cell Unique identifier addressing a cell in all API calls.
5822
+ * @param {string} controller Unique identifier to address a controller in the cell.
5823
+ * @param {OrientationType} [orientationType]
5986
5824
  * @param {*} [options] Override http request option.
5987
5825
  * @throws {RequiredError}
5988
5826
  * @memberof ControllerApi
5989
5827
  */
5990
- listControllers(cell: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ControllersList, any>>;
5828
+ listCoordinateSystems(cell: string, controller: string, orientationType?: OrientationType, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ListCoordinateSystemsResponse, any>>;
5991
5829
  /**
5992
- * Lists all specifications of coordinate systems from robot controllers. Use parameter orientation_type to get the orientation part of the transformation offset of the coordinate system returned in the requested orientation notation. If parameter orientation_type is not set, the orientation part of the transformation offset of the coordinate system is returned in rotation vector notation. The coordinate systems from the robot controller are loaded when the motion group associated with the coordinate system is activated. With deactivation of the motion group, the associated coordinate systems are removed from NOVA. The unique identifier of the coordinate systems from the robot controllers are suffixed with \"On\" + the unique identifier of the robot controller.
5993
- * @summary List Coordinate Systems
5830
+ * List the names of all deployed robot controllers.
5831
+ * @summary List Robot Controllers
5994
5832
  * @param {string} cell Unique identifier addressing a cell in all API calls.
5995
- * @param {string} controller Unique identifier to address a controller in the cell.
5996
- * @param {OrientationType} [orientationType]
5997
5833
  * @param {*} [options] Override http request option.
5998
5834
  * @throws {RequiredError}
5999
5835
  * @memberof ControllerApi
6000
5836
  */
6001
- listCoordinateSystems(cell: string, controller: string, orientationType?: OrientationType, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ListCoordinateSystemsResponse, any>>;
5837
+ listRobotControllers(cell: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<string[], any>>;
6002
5838
  /**
6003
5839
  * Switch between monitor and control usage as default for a robot controller. Monitoring mode is used to read information from the robot controller and control mode is used to command the robot system. As long as the robot controller is connected via network monitoring mode is always possible. To switch to control mode the robot controller must be in `automatic` or `manual` operating mode and safety state \'normal\' or \'reduced\'. If the robot controller is in `manual` operating mode, you have manually confirm the control usage activation on the robot control panel. This manual confirmation can\'t be replaced with this API. Without manual confirmation the robot controller will stay in monitor mode. The robot system will try to activate the required operation mode for the requested usage unless no active call requires a different mode. > **NOTE** > > Some robot controllers prevent the external activation of automatic operating mode. In this case, changing the operating mode manually at the robot controller is mandatory. > **NOTE** > > The current operation mode and safety state can be requested via [getCurrentRobotControllerState](getCurrentRobotControllerState). If a mode change is not possible, the response lists reasons for the failed change.
6004
5840
  * @summary Set Default Mode
@@ -6289,130 +6125,130 @@ export declare class ControllerInputsOutputsApi extends BaseAPI {
6289
6125
  waitForIOEvent(cell: string, controller: string, waitForIOEventRequest: WaitForIOEventRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<boolean, any>>;
6290
6126
  }
6291
6127
  /**
6292
- * InverseKinematicsApi - axios parameter creator
6128
+ * JoggingApi - axios parameter creator
6293
6129
  * @export
6294
6130
  */
6295
- export declare const InverseKinematicsApiAxiosParamCreator: (configuration?: Configuration) => {
6131
+ export declare const JoggingApiAxiosParamCreator: (configuration?: Configuration) => {
6296
6132
  /**
6297
- * Returns the reachable joint positions for a list of given poses.
6298
- * @summary Inverse kinematics
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
6299
6135
  * @param {string} cell Unique identifier addressing a cell in all API calls.
6300
- * @param {InverseKinematicsRequest} [inverseKinematicsRequest]
6136
+ * @param {ExecuteJoggingRequest} executeJoggingRequest
6301
6137
  * @param {*} [options] Override http request option.
6302
6138
  * @throws {RequiredError}
6303
6139
  */
6304
- inverseKinematics: (cell: string, inverseKinematicsRequest?: InverseKinematicsRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
6140
+ executeJogging: (cell: string, executeJoggingRequest: ExecuteJoggingRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
6305
6141
  };
6306
6142
  /**
6307
- * InverseKinematicsApi - functional programming interface
6143
+ * JoggingApi - functional programming interface
6308
6144
  * @export
6309
6145
  */
6310
- export declare const InverseKinematicsApiFp: (configuration?: Configuration) => {
6146
+ export declare const JoggingApiFp: (configuration?: Configuration) => {
6311
6147
  /**
6312
- * Returns the reachable joint positions for a list of given poses.
6313
- * @summary Inverse kinematics
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
6314
6150
  * @param {string} cell Unique identifier addressing a cell in all API calls.
6315
- * @param {InverseKinematicsRequest} [inverseKinematicsRequest]
6151
+ * @param {ExecuteJoggingRequest} executeJoggingRequest
6316
6152
  * @param {*} [options] Override http request option.
6317
6153
  * @throws {RequiredError}
6318
6154
  */
6319
- inverseKinematics(cell: string, inverseKinematicsRequest?: InverseKinematicsRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<InverseKinematicsResponse>>;
6155
+ executeJogging(cell: string, executeJoggingRequest: ExecuteJoggingRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ExecuteJoggingResponse>>;
6320
6156
  };
6321
6157
  /**
6322
- * InverseKinematicsApi - factory interface
6158
+ * JoggingApi - factory interface
6323
6159
  * @export
6324
6160
  */
6325
- export declare const InverseKinematicsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
6161
+ export declare const JoggingApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
6326
6162
  /**
6327
- * Returns the reachable joint positions for a list of given poses.
6328
- * @summary Inverse kinematics
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
6329
6165
  * @param {string} cell Unique identifier addressing a cell in all API calls.
6330
- * @param {InverseKinematicsRequest} [inverseKinematicsRequest]
6166
+ * @param {ExecuteJoggingRequest} executeJoggingRequest
6331
6167
  * @param {*} [options] Override http request option.
6332
6168
  * @throws {RequiredError}
6333
6169
  */
6334
- inverseKinematics(cell: string, inverseKinematicsRequest?: InverseKinematicsRequest, options?: RawAxiosRequestConfig): AxiosPromise<InverseKinematicsResponse>;
6170
+ executeJogging(cell: string, executeJoggingRequest: ExecuteJoggingRequest, options?: RawAxiosRequestConfig): AxiosPromise<ExecuteJoggingResponse>;
6335
6171
  };
6336
6172
  /**
6337
- * InverseKinematicsApi - object-oriented interface
6173
+ * JoggingApi - object-oriented interface
6338
6174
  * @export
6339
- * @class InverseKinematicsApi
6175
+ * @class JoggingApi
6340
6176
  * @extends {BaseAPI}
6341
6177
  */
6342
- export declare class InverseKinematicsApi extends BaseAPI {
6178
+ export declare class JoggingApi extends BaseAPI {
6343
6179
  /**
6344
- * Returns the reachable joint positions for a list of given poses.
6345
- * @summary Inverse kinematics
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
6346
6182
  * @param {string} cell Unique identifier addressing a cell in all API calls.
6347
- * @param {InverseKinematicsRequest} [inverseKinematicsRequest]
6183
+ * @param {ExecuteJoggingRequest} executeJoggingRequest
6348
6184
  * @param {*} [options] Override http request option.
6349
6185
  * @throws {RequiredError}
6350
- * @memberof InverseKinematicsApi
6186
+ * @memberof JoggingApi
6351
6187
  */
6352
- inverseKinematics(cell: string, inverseKinematicsRequest?: InverseKinematicsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<InverseKinematicsResponse, any>>;
6188
+ executeJogging(cell: string, executeJoggingRequest: ExecuteJoggingRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ExecuteJoggingResponse, any>>;
6353
6189
  }
6354
6190
  /**
6355
- * JoggingApi - axios parameter creator
6191
+ * KinematicsApi - axios parameter creator
6356
6192
  * @export
6357
6193
  */
6358
- export declare const JoggingApiAxiosParamCreator: (configuration?: Configuration) => {
6194
+ export declare const KinematicsApiAxiosParamCreator: (configuration?: Configuration) => {
6359
6195
  /**
6360
- * <!-- 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.
6361
- * @summary Execute Jogging
6196
+ * Returns the reachable joint positions for a list of given poses.
6197
+ * @summary Inverse kinematics
6362
6198
  * @param {string} cell Unique identifier addressing a cell in all API calls.
6363
- * @param {ExecuteJoggingRequest} executeJoggingRequest
6199
+ * @param {InverseKinematicsRequest} [inverseKinematicsRequest]
6364
6200
  * @param {*} [options] Override http request option.
6365
6201
  * @throws {RequiredError}
6366
6202
  */
6367
- executeJogging: (cell: string, executeJoggingRequest: ExecuteJoggingRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
6203
+ inverseKinematics: (cell: string, inverseKinematicsRequest?: InverseKinematicsRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
6368
6204
  };
6369
6205
  /**
6370
- * JoggingApi - functional programming interface
6206
+ * KinematicsApi - functional programming interface
6371
6207
  * @export
6372
6208
  */
6373
- export declare const JoggingApiFp: (configuration?: Configuration) => {
6209
+ export declare const KinematicsApiFp: (configuration?: Configuration) => {
6374
6210
  /**
6375
- * <!-- 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.
6376
- * @summary Execute Jogging
6211
+ * Returns the reachable joint positions for a list of given poses.
6212
+ * @summary Inverse kinematics
6377
6213
  * @param {string} cell Unique identifier addressing a cell in all API calls.
6378
- * @param {ExecuteJoggingRequest} executeJoggingRequest
6214
+ * @param {InverseKinematicsRequest} [inverseKinematicsRequest]
6379
6215
  * @param {*} [options] Override http request option.
6380
6216
  * @throws {RequiredError}
6381
6217
  */
6382
- executeJogging(cell: string, executeJoggingRequest: ExecuteJoggingRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ExecuteJoggingResponse>>;
6218
+ inverseKinematics(cell: string, inverseKinematicsRequest?: InverseKinematicsRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<InverseKinematicsResponse>>;
6383
6219
  };
6384
6220
  /**
6385
- * JoggingApi - factory interface
6221
+ * KinematicsApi - factory interface
6386
6222
  * @export
6387
6223
  */
6388
- export declare const JoggingApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
6224
+ export declare const KinematicsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
6389
6225
  /**
6390
- * <!-- 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.
6391
- * @summary Execute Jogging
6226
+ * Returns the reachable joint positions for a list of given poses.
6227
+ * @summary Inverse kinematics
6392
6228
  * @param {string} cell Unique identifier addressing a cell in all API calls.
6393
- * @param {ExecuteJoggingRequest} executeJoggingRequest
6229
+ * @param {InverseKinematicsRequest} [inverseKinematicsRequest]
6394
6230
  * @param {*} [options] Override http request option.
6395
6231
  * @throws {RequiredError}
6396
6232
  */
6397
- executeJogging(cell: string, executeJoggingRequest: ExecuteJoggingRequest, options?: RawAxiosRequestConfig): AxiosPromise<ExecuteJoggingResponse>;
6233
+ inverseKinematics(cell: string, inverseKinematicsRequest?: InverseKinematicsRequest, options?: RawAxiosRequestConfig): AxiosPromise<InverseKinematicsResponse>;
6398
6234
  };
6399
6235
  /**
6400
- * JoggingApi - object-oriented interface
6236
+ * KinematicsApi - object-oriented interface
6401
6237
  * @export
6402
- * @class JoggingApi
6238
+ * @class KinematicsApi
6403
6239
  * @extends {BaseAPI}
6404
6240
  */
6405
- export declare class JoggingApi extends BaseAPI {
6241
+ export declare class KinematicsApi extends BaseAPI {
6406
6242
  /**
6407
- * <!-- 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.
6408
- * @summary Execute Jogging
6243
+ * Returns the reachable joint positions for a list of given poses.
6244
+ * @summary Inverse kinematics
6409
6245
  * @param {string} cell Unique identifier addressing a cell in all API calls.
6410
- * @param {ExecuteJoggingRequest} executeJoggingRequest
6246
+ * @param {InverseKinematicsRequest} [inverseKinematicsRequest]
6411
6247
  * @param {*} [options] Override http request option.
6412
6248
  * @throws {RequiredError}
6413
- * @memberof JoggingApi
6249
+ * @memberof KinematicsApi
6414
6250
  */
6415
- executeJogging(cell: string, executeJoggingRequest: ExecuteJoggingRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ExecuteJoggingResponse, any>>;
6251
+ inverseKinematics(cell: string, inverseKinematicsRequest?: InverseKinematicsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<InverseKinematicsResponse, any>>;
6416
6252
  }
6417
6253
  /**
6418
6254
  * LicenseApi - axios parameter creator