@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.
- package/package.json +1 -1
- package/v2/api.d.ts +121 -285
- package/v2/api.js +126 -126
- package/v2/api.js.map +1 -1
- package/v2/api.ts +160 -326
package/v2/api.ts
CHANGED
|
@@ -754,92 +754,6 @@ export interface ContainerStorage {
|
|
|
754
754
|
*/
|
|
755
755
|
'capacity': string;
|
|
756
756
|
}
|
|
757
|
-
/**
|
|
758
|
-
* The data type to describe a robot controller.
|
|
759
|
-
* @export
|
|
760
|
-
* @interface Controller
|
|
761
|
-
*/
|
|
762
|
-
export interface Controller {
|
|
763
|
-
/**
|
|
764
|
-
* The unique identifier to address the robot controller in the cell.
|
|
765
|
-
* @type {string}
|
|
766
|
-
* @memberof Controller
|
|
767
|
-
*/
|
|
768
|
-
'controller': string;
|
|
769
|
-
/**
|
|
770
|
-
* 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.
|
|
771
|
-
* @type {string}
|
|
772
|
-
* @memberof Controller
|
|
773
|
-
*/
|
|
774
|
-
'model_name': string;
|
|
775
|
-
/**
|
|
776
|
-
* Resolvable host name or IP address that connects to the robot controller.
|
|
777
|
-
* @type {string}
|
|
778
|
-
* @memberof Controller
|
|
779
|
-
*/
|
|
780
|
-
'host': string;
|
|
781
|
-
/**
|
|
782
|
-
* 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.
|
|
783
|
-
* @type {boolean}
|
|
784
|
-
* @memberof Controller
|
|
785
|
-
*/
|
|
786
|
-
'allow_software_install_on_controller': boolean;
|
|
787
|
-
/**
|
|
788
|
-
* The list of physical connected motion groups as detected by the controller.
|
|
789
|
-
* @type {Array<MotionGroupInstance>}
|
|
790
|
-
* @memberof Controller
|
|
791
|
-
*/
|
|
792
|
-
'motion_groups': Array<MotionGroupInstance>;
|
|
793
|
-
/**
|
|
794
|
-
*
|
|
795
|
-
* @type {VersionNumber}
|
|
796
|
-
* @memberof Controller
|
|
797
|
-
*/
|
|
798
|
-
'vendor_software_version'?: VersionNumber;
|
|
799
|
-
/**
|
|
800
|
-
* 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.
|
|
801
|
-
* @type {boolean}
|
|
802
|
-
* @memberof Controller
|
|
803
|
-
*/
|
|
804
|
-
'has_error': boolean;
|
|
805
|
-
/**
|
|
806
|
-
* If has_error is true, error_details provides detailed background information about the error.
|
|
807
|
-
* @type {string}
|
|
808
|
-
* @memberof Controller
|
|
809
|
-
*/
|
|
810
|
-
'error_details'?: string;
|
|
811
|
-
/**
|
|
812
|
-
* Can this controller be moved through freedrive (true), or not (false).
|
|
813
|
-
* @type {boolean}
|
|
814
|
-
* @memberof Controller
|
|
815
|
-
*/
|
|
816
|
-
'supports_freedrive': boolean;
|
|
817
|
-
/**
|
|
818
|
-
* Can this controller be controlled with NOVA (true) or is it only possible to read data (false).
|
|
819
|
-
* @type {boolean}
|
|
820
|
-
* @memberof Controller
|
|
821
|
-
*/
|
|
822
|
-
'supports_control': boolean;
|
|
823
|
-
/**
|
|
824
|
-
* 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.
|
|
825
|
-
* @type {boolean}
|
|
826
|
-
* @memberof Controller
|
|
827
|
-
*/
|
|
828
|
-
'supports_safety_zones': boolean;
|
|
829
|
-
}
|
|
830
|
-
/**
|
|
831
|
-
* The list of configured robot controllers.
|
|
832
|
-
* @export
|
|
833
|
-
* @interface ControllersList
|
|
834
|
-
*/
|
|
835
|
-
export interface ControllersList {
|
|
836
|
-
/**
|
|
837
|
-
*
|
|
838
|
-
* @type {Array<Controller>}
|
|
839
|
-
* @memberof ControllersList
|
|
840
|
-
*/
|
|
841
|
-
'controllers': Array<Controller>;
|
|
842
|
-
}
|
|
843
757
|
/**
|
|
844
758
|
* Defines a convex hull encapsulating a set of vertices.
|
|
845
759
|
* @export
|
|
@@ -1872,11 +1786,11 @@ export interface InvalidDofInvalidDof {
|
|
|
1872
1786
|
*/
|
|
1873
1787
|
export interface InverseKinematicsRequest {
|
|
1874
1788
|
/**
|
|
1875
|
-
*
|
|
1876
|
-
* @type {
|
|
1789
|
+
* String identifiying the model of a motion group.
|
|
1790
|
+
* @type {string}
|
|
1877
1791
|
* @memberof InverseKinematicsRequest
|
|
1878
1792
|
*/
|
|
1879
|
-
'
|
|
1793
|
+
'motion_group_model': string;
|
|
1880
1794
|
/**
|
|
1881
1795
|
* List of TCP poses for which the inverse solutions are computed.
|
|
1882
1796
|
* @type {Array<Pose>}
|
|
@@ -1884,17 +1798,29 @@ export interface InverseKinematicsRequest {
|
|
|
1884
1798
|
*/
|
|
1885
1799
|
'tcp_poses': Array<Pose>;
|
|
1886
1800
|
/**
|
|
1887
|
-
*
|
|
1888
|
-
* @type {
|
|
1801
|
+
*
|
|
1802
|
+
* @type {Pose}
|
|
1889
1803
|
* @memberof InverseKinematicsRequest
|
|
1890
1804
|
*/
|
|
1891
|
-
'
|
|
1805
|
+
'tcp_offset'?: Pose;
|
|
1806
|
+
/**
|
|
1807
|
+
* Offset from the world frame to the motion group base.
|
|
1808
|
+
* @type {Pose}
|
|
1809
|
+
* @memberof InverseKinematicsRequest
|
|
1810
|
+
*/
|
|
1811
|
+
'mounting'?: Pose;
|
|
1892
1812
|
/**
|
|
1893
|
-
*
|
|
1894
|
-
* @type {
|
|
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; }}
|
|
1895
1821
|
* @memberof InverseKinematicsRequest
|
|
1896
1822
|
*/
|
|
1897
|
-
'
|
|
1823
|
+
'collision_scenes'?: { [key: string]: SingleMotionGroupCollisionScene; };
|
|
1898
1824
|
}
|
|
1899
1825
|
/**
|
|
1900
1826
|
*
|
|
@@ -2566,49 +2492,6 @@ export interface MotionGroupInfos {
|
|
|
2566
2492
|
*/
|
|
2567
2493
|
'motion_groups': Array<MotionGroupInfo>;
|
|
2568
2494
|
}
|
|
2569
|
-
/**
|
|
2570
|
-
* The data type describes the physically connected motion groups on a robot controller, e.g., a robot arm.
|
|
2571
|
-
* @export
|
|
2572
|
-
* @interface MotionGroupInstance
|
|
2573
|
-
*/
|
|
2574
|
-
export interface MotionGroupInstance {
|
|
2575
|
-
/**
|
|
2576
|
-
* Identifier of the motion group.
|
|
2577
|
-
* @type {string}
|
|
2578
|
-
* @memberof MotionGroupInstance
|
|
2579
|
-
*/
|
|
2580
|
-
'motion_group': string;
|
|
2581
|
-
/**
|
|
2582
|
-
* Identifier of the robot controller the motion group is attached to.
|
|
2583
|
-
* @type {string}
|
|
2584
|
-
* @memberof MotionGroupInstance
|
|
2585
|
-
*/
|
|
2586
|
-
'controller': string;
|
|
2587
|
-
/**
|
|
2588
|
-
* The name of the motion group has on the robot controller.
|
|
2589
|
-
* @type {string}
|
|
2590
|
-
* @memberof MotionGroupInstance
|
|
2591
|
-
*/
|
|
2592
|
-
'name_from_controller': string;
|
|
2593
|
-
/**
|
|
2594
|
-
* The robot controller model, if available. Usable for frontend 3D visualization.
|
|
2595
|
-
* @type {string}
|
|
2596
|
-
* @memberof MotionGroupInstance
|
|
2597
|
-
*/
|
|
2598
|
-
'model_from_controller': string;
|
|
2599
|
-
/**
|
|
2600
|
-
* 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.
|
|
2601
|
-
* @type {string}
|
|
2602
|
-
* @memberof MotionGroupInstance
|
|
2603
|
-
*/
|
|
2604
|
-
'serial_number'?: string;
|
|
2605
|
-
/**
|
|
2606
|
-
* 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.
|
|
2607
|
-
* @type {boolean}
|
|
2608
|
-
* @memberof MotionGroupInstance
|
|
2609
|
-
*/
|
|
2610
|
-
'has_inverse_kinematics': boolean;
|
|
2611
|
-
}
|
|
2612
2495
|
/**
|
|
2613
2496
|
* Ensure to provide one value for each joint. See [getMotionGroups](getMotionGroups) for the number of joints. Everything but positions is optional.
|
|
2614
2497
|
* @export
|
|
@@ -3418,7 +3301,7 @@ export type PlaneShapeTypeEnum = typeof PlaneShapeTypeEnum[keyof typeof PlaneSha
|
|
|
3418
3301
|
*/
|
|
3419
3302
|
export interface PlanningLimits {
|
|
3420
3303
|
/**
|
|
3421
|
-
* Joint position limits in [rad],
|
|
3304
|
+
* Joint position limits in [rad], indexed starting from base.
|
|
3422
3305
|
* @type {Array<PlanningLimitsLimitRange>}
|
|
3423
3306
|
* @memberof PlanningLimits
|
|
3424
3307
|
*/
|
|
@@ -3954,11 +3837,11 @@ export interface RobotSetup {
|
|
|
3954
3837
|
*/
|
|
3955
3838
|
'payload'?: Payload;
|
|
3956
3839
|
/**
|
|
3957
|
-
* Collision scenes to be respected by the motion planner. Each contains the single motion group which is planned for.
|
|
3958
|
-
* @type {
|
|
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; }}
|
|
3959
3842
|
* @memberof RobotSetup
|
|
3960
3843
|
*/
|
|
3961
|
-
'collision_scenes'?:
|
|
3844
|
+
'collision_scenes'?: { [key: string]: SingleMotionGroupCollisionScene; };
|
|
3962
3845
|
}
|
|
3963
3846
|
/**
|
|
3964
3847
|
* Collection of information on the current state of the robot.
|
|
@@ -4235,17 +4118,23 @@ export interface SingleMotionGroupCollisionScene {
|
|
|
4235
4118
|
*/
|
|
4236
4119
|
'static_colliders'?: { [key: string]: Collider; };
|
|
4237
4120
|
/**
|
|
4238
|
-
*
|
|
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.
|
|
4239
4122
|
* @type {Array<{ [key: string]: Collider; }>}
|
|
4240
4123
|
* @memberof SingleMotionGroupCollisionScene
|
|
4241
4124
|
*/
|
|
4242
4125
|
'link_chain'?: Array<{ [key: string]: Collider; }>;
|
|
4243
4126
|
/**
|
|
4244
|
-
* A
|
|
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.
|
|
4245
4128
|
* @type {{ [key: string]: Collider; }}
|
|
4246
4129
|
* @memberof SingleMotionGroupCollisionScene
|
|
4247
4130
|
*/
|
|
4248
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;
|
|
4249
4138
|
}
|
|
4250
4139
|
/**
|
|
4251
4140
|
*
|
|
@@ -4719,61 +4608,6 @@ export interface ValidationError2 {
|
|
|
4719
4608
|
*/
|
|
4720
4609
|
export type ValidationErrorLocInner = number | string;
|
|
4721
4610
|
|
|
4722
|
-
/**
|
|
4723
|
-
* A generic representation of a version number.
|
|
4724
|
-
* @export
|
|
4725
|
-
* @interface VersionNumber
|
|
4726
|
-
*/
|
|
4727
|
-
export interface VersionNumber {
|
|
4728
|
-
/**
|
|
4729
|
-
*
|
|
4730
|
-
* @type {number}
|
|
4731
|
-
* @memberof VersionNumber
|
|
4732
|
-
*/
|
|
4733
|
-
'major_version': number;
|
|
4734
|
-
/**
|
|
4735
|
-
*
|
|
4736
|
-
* @type {number}
|
|
4737
|
-
* @memberof VersionNumber
|
|
4738
|
-
*/
|
|
4739
|
-
'minor_version'?: number;
|
|
4740
|
-
/**
|
|
4741
|
-
*
|
|
4742
|
-
* @type {number}
|
|
4743
|
-
* @memberof VersionNumber
|
|
4744
|
-
*/
|
|
4745
|
-
'build_version'?: number;
|
|
4746
|
-
/**
|
|
4747
|
-
*
|
|
4748
|
-
* @type {number}
|
|
4749
|
-
* @memberof VersionNumber
|
|
4750
|
-
*/
|
|
4751
|
-
'bugfix_version'?: number;
|
|
4752
|
-
/**
|
|
4753
|
-
* If minor version is a wildcard set to true.
|
|
4754
|
-
* @type {boolean}
|
|
4755
|
-
* @memberof VersionNumber
|
|
4756
|
-
*/
|
|
4757
|
-
'minor_version_wildcard'?: boolean;
|
|
4758
|
-
/**
|
|
4759
|
-
* If build version is a wildcard set to true.
|
|
4760
|
-
* @type {boolean}
|
|
4761
|
-
* @memberof VersionNumber
|
|
4762
|
-
*/
|
|
4763
|
-
'build_version_wildcard'?: boolean;
|
|
4764
|
-
/**
|
|
4765
|
-
* If bugfix version is a wildcard set to true.
|
|
4766
|
-
* @type {boolean}
|
|
4767
|
-
* @memberof VersionNumber
|
|
4768
|
-
*/
|
|
4769
|
-
'bugfix_version_wildcard'?: boolean;
|
|
4770
|
-
/**
|
|
4771
|
-
* A string representation of the version e.g. 1.1.x.x.
|
|
4772
|
-
* @type {string}
|
|
4773
|
-
* @memberof VersionNumber
|
|
4774
|
-
*/
|
|
4775
|
-
'string_version'?: string;
|
|
4776
|
-
}
|
|
4777
4611
|
/**
|
|
4778
4612
|
* 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`
|
|
4779
4613
|
* @export
|
|
@@ -6876,17 +6710,22 @@ export const ControllerApiAxiosParamCreator = function (configuration?: Configur
|
|
|
6876
6710
|
};
|
|
6877
6711
|
},
|
|
6878
6712
|
/**
|
|
6879
|
-
*
|
|
6880
|
-
* @summary List
|
|
6713
|
+
* 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.
|
|
6714
|
+
* @summary List Coordinate Systems
|
|
6881
6715
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
6716
|
+
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
6717
|
+
* @param {OrientationType} [orientationType]
|
|
6882
6718
|
* @param {*} [options] Override http request option.
|
|
6883
6719
|
* @throws {RequiredError}
|
|
6884
6720
|
*/
|
|
6885
|
-
|
|
6721
|
+
listCoordinateSystems: async (cell: string, controller: string, orientationType?: OrientationType, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
6886
6722
|
// verify required parameter 'cell' is not null or undefined
|
|
6887
|
-
assertParamExists('
|
|
6888
|
-
|
|
6889
|
-
|
|
6723
|
+
assertParamExists('listCoordinateSystems', 'cell', cell)
|
|
6724
|
+
// verify required parameter 'controller' is not null or undefined
|
|
6725
|
+
assertParamExists('listCoordinateSystems', 'controller', controller)
|
|
6726
|
+
const localVarPath = `/cells/{cell}/controllers/{controller}/coordinate-systems`
|
|
6727
|
+
.replace(`{${"cell"}}`, encodeURIComponent(String(cell)))
|
|
6728
|
+
.replace(`{${"controller"}}`, encodeURIComponent(String(controller)));
|
|
6890
6729
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
6891
6730
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
6892
6731
|
let baseOptions;
|
|
@@ -6906,6 +6745,10 @@ export const ControllerApiAxiosParamCreator = function (configuration?: Configur
|
|
|
6906
6745
|
// http bearer authentication required
|
|
6907
6746
|
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
6908
6747
|
|
|
6748
|
+
if (orientationType !== undefined) {
|
|
6749
|
+
localVarQueryParameter['orientation_type'] = orientationType;
|
|
6750
|
+
}
|
|
6751
|
+
|
|
6909
6752
|
|
|
6910
6753
|
|
|
6911
6754
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
@@ -6918,22 +6761,17 @@ export const ControllerApiAxiosParamCreator = function (configuration?: Configur
|
|
|
6918
6761
|
};
|
|
6919
6762
|
},
|
|
6920
6763
|
/**
|
|
6921
|
-
*
|
|
6922
|
-
* @summary List
|
|
6764
|
+
* List the names of all deployed robot controllers.
|
|
6765
|
+
* @summary List Robot Controllers
|
|
6923
6766
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
6924
|
-
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
6925
|
-
* @param {OrientationType} [orientationType]
|
|
6926
6767
|
* @param {*} [options] Override http request option.
|
|
6927
6768
|
* @throws {RequiredError}
|
|
6928
6769
|
*/
|
|
6929
|
-
|
|
6770
|
+
listRobotControllers: async (cell: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
6930
6771
|
// verify required parameter 'cell' is not null or undefined
|
|
6931
|
-
assertParamExists('
|
|
6932
|
-
|
|
6933
|
-
|
|
6934
|
-
const localVarPath = `/cells/{cell}/controllers/{controller}/coordinate-systems`
|
|
6935
|
-
.replace(`{${"cell"}}`, encodeURIComponent(String(cell)))
|
|
6936
|
-
.replace(`{${"controller"}}`, encodeURIComponent(String(controller)));
|
|
6772
|
+
assertParamExists('listRobotControllers', 'cell', cell)
|
|
6773
|
+
const localVarPath = `/cells/{cell}/controllers`
|
|
6774
|
+
.replace(`{${"cell"}}`, encodeURIComponent(String(cell)));
|
|
6937
6775
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
6938
6776
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
6939
6777
|
let baseOptions;
|
|
@@ -6953,10 +6791,6 @@ export const ControllerApiAxiosParamCreator = function (configuration?: Configur
|
|
|
6953
6791
|
// http bearer authentication required
|
|
6954
6792
|
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
6955
6793
|
|
|
6956
|
-
if (orientationType !== undefined) {
|
|
6957
|
-
localVarQueryParameter['orientation_type'] = orientationType;
|
|
6958
|
-
}
|
|
6959
|
-
|
|
6960
6794
|
|
|
6961
6795
|
|
|
6962
6796
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
@@ -7307,31 +7141,31 @@ export const ControllerApiFp = function(configuration?: Configuration) {
|
|
|
7307
7141
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
7308
7142
|
},
|
|
7309
7143
|
/**
|
|
7310
|
-
*
|
|
7311
|
-
* @summary List
|
|
7144
|
+
* 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.
|
|
7145
|
+
* @summary List Coordinate Systems
|
|
7312
7146
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
7147
|
+
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
7148
|
+
* @param {OrientationType} [orientationType]
|
|
7313
7149
|
* @param {*} [options] Override http request option.
|
|
7314
7150
|
* @throws {RequiredError}
|
|
7315
7151
|
*/
|
|
7316
|
-
async
|
|
7317
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.
|
|
7152
|
+
async listCoordinateSystems(cell: string, controller: string, orientationType?: OrientationType, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListCoordinateSystemsResponse>> {
|
|
7153
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.listCoordinateSystems(cell, controller, orientationType, options);
|
|
7318
7154
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
7319
|
-
const localVarOperationServerBasePath = operationServerMap['ControllerApi.
|
|
7155
|
+
const localVarOperationServerBasePath = operationServerMap['ControllerApi.listCoordinateSystems']?.[localVarOperationServerIndex]?.url;
|
|
7320
7156
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
7321
7157
|
},
|
|
7322
7158
|
/**
|
|
7323
|
-
*
|
|
7324
|
-
* @summary List
|
|
7159
|
+
* List the names of all deployed robot controllers.
|
|
7160
|
+
* @summary List Robot Controllers
|
|
7325
7161
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
7326
|
-
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
7327
|
-
* @param {OrientationType} [orientationType]
|
|
7328
7162
|
* @param {*} [options] Override http request option.
|
|
7329
7163
|
* @throws {RequiredError}
|
|
7330
7164
|
*/
|
|
7331
|
-
async
|
|
7332
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.
|
|
7165
|
+
async listRobotControllers(cell: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<string>>> {
|
|
7166
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.listRobotControllers(cell, options);
|
|
7333
7167
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
7334
|
-
const localVarOperationServerBasePath = operationServerMap['ControllerApi.
|
|
7168
|
+
const localVarOperationServerBasePath = operationServerMap['ControllerApi.listRobotControllers']?.[localVarOperationServerIndex]?.url;
|
|
7335
7169
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
7336
7170
|
},
|
|
7337
7171
|
/**
|
|
@@ -7497,16 +7331,6 @@ export const ControllerApiFactory = function (configuration?: Configuration, bas
|
|
|
7497
7331
|
getVirtualRobotConfiguration(cell: string, controller: string, options?: RawAxiosRequestConfig): AxiosPromise<VirtualRobotConfiguration> {
|
|
7498
7332
|
return localVarFp.getVirtualRobotConfiguration(cell, controller, options).then((request) => request(axios, basePath));
|
|
7499
7333
|
},
|
|
7500
|
-
/**
|
|
7501
|
-
* List all configured robot controllers.
|
|
7502
|
-
* @summary List Descriptions
|
|
7503
|
-
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
7504
|
-
* @param {*} [options] Override http request option.
|
|
7505
|
-
* @throws {RequiredError}
|
|
7506
|
-
*/
|
|
7507
|
-
listControllers(cell: string, options?: RawAxiosRequestConfig): AxiosPromise<ControllersList> {
|
|
7508
|
-
return localVarFp.listControllers(cell, options).then((request) => request(axios, basePath));
|
|
7509
|
-
},
|
|
7510
7334
|
/**
|
|
7511
7335
|
* 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.
|
|
7512
7336
|
* @summary List Coordinate Systems
|
|
@@ -7519,6 +7343,16 @@ export const ControllerApiFactory = function (configuration?: Configuration, bas
|
|
|
7519
7343
|
listCoordinateSystems(cell: string, controller: string, orientationType?: OrientationType, options?: RawAxiosRequestConfig): AxiosPromise<ListCoordinateSystemsResponse> {
|
|
7520
7344
|
return localVarFp.listCoordinateSystems(cell, controller, orientationType, options).then((request) => request(axios, basePath));
|
|
7521
7345
|
},
|
|
7346
|
+
/**
|
|
7347
|
+
* List the names of all deployed robot controllers.
|
|
7348
|
+
* @summary List Robot Controllers
|
|
7349
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
7350
|
+
* @param {*} [options] Override http request option.
|
|
7351
|
+
* @throws {RequiredError}
|
|
7352
|
+
*/
|
|
7353
|
+
listRobotControllers(cell: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<string>> {
|
|
7354
|
+
return localVarFp.listRobotControllers(cell, options).then((request) => request(axios, basePath));
|
|
7355
|
+
},
|
|
7522
7356
|
/**
|
|
7523
7357
|
* 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.
|
|
7524
7358
|
* @summary Set Default Mode
|
|
@@ -7687,29 +7521,29 @@ export class ControllerApi extends BaseAPI {
|
|
|
7687
7521
|
}
|
|
7688
7522
|
|
|
7689
7523
|
/**
|
|
7690
|
-
*
|
|
7691
|
-
* @summary List
|
|
7524
|
+
* 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.
|
|
7525
|
+
* @summary List Coordinate Systems
|
|
7692
7526
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
7527
|
+
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
7528
|
+
* @param {OrientationType} [orientationType]
|
|
7693
7529
|
* @param {*} [options] Override http request option.
|
|
7694
7530
|
* @throws {RequiredError}
|
|
7695
7531
|
* @memberof ControllerApi
|
|
7696
7532
|
*/
|
|
7697
|
-
public
|
|
7698
|
-
return ControllerApiFp(this.configuration).
|
|
7533
|
+
public listCoordinateSystems(cell: string, controller: string, orientationType?: OrientationType, options?: RawAxiosRequestConfig) {
|
|
7534
|
+
return ControllerApiFp(this.configuration).listCoordinateSystems(cell, controller, orientationType, options).then((request) => request(this.axios, this.basePath));
|
|
7699
7535
|
}
|
|
7700
7536
|
|
|
7701
7537
|
/**
|
|
7702
|
-
*
|
|
7703
|
-
* @summary List
|
|
7538
|
+
* List the names of all deployed robot controllers.
|
|
7539
|
+
* @summary List Robot Controllers
|
|
7704
7540
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
7705
|
-
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
7706
|
-
* @param {OrientationType} [orientationType]
|
|
7707
7541
|
* @param {*} [options] Override http request option.
|
|
7708
7542
|
* @throws {RequiredError}
|
|
7709
7543
|
* @memberof ControllerApi
|
|
7710
7544
|
*/
|
|
7711
|
-
public
|
|
7712
|
-
return ControllerApiFp(this.configuration).
|
|
7545
|
+
public listRobotControllers(cell: string, options?: RawAxiosRequestConfig) {
|
|
7546
|
+
return ControllerApiFp(this.configuration).listRobotControllers(cell, options).then((request) => request(this.axios, this.basePath));
|
|
7713
7547
|
}
|
|
7714
7548
|
|
|
7715
7549
|
/**
|
|
@@ -8298,23 +8132,25 @@ export class ControllerInputsOutputsApi extends BaseAPI {
|
|
|
8298
8132
|
|
|
8299
8133
|
|
|
8300
8134
|
/**
|
|
8301
|
-
*
|
|
8135
|
+
* JoggingApi - axios parameter creator
|
|
8302
8136
|
* @export
|
|
8303
8137
|
*/
|
|
8304
|
-
export const
|
|
8138
|
+
export const JoggingApiAxiosParamCreator = function (configuration?: Configuration) {
|
|
8305
8139
|
return {
|
|
8306
8140
|
/**
|
|
8307
|
-
*
|
|
8308
|
-
* @summary
|
|
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
|
|
8309
8143
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8310
|
-
* @param {
|
|
8144
|
+
* @param {ExecuteJoggingRequest} executeJoggingRequest
|
|
8311
8145
|
* @param {*} [options] Override http request option.
|
|
8312
8146
|
* @throws {RequiredError}
|
|
8313
8147
|
*/
|
|
8314
|
-
|
|
8148
|
+
executeJogging: async (cell: string, executeJoggingRequest: ExecuteJoggingRequest, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
8315
8149
|
// verify required parameter 'cell' is not null or undefined
|
|
8316
|
-
assertParamExists('
|
|
8317
|
-
|
|
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`
|
|
8318
8154
|
.replace(`{${"cell"}}`, encodeURIComponent(String(cell)));
|
|
8319
8155
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
8320
8156
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
@@ -8323,7 +8159,7 @@ export const InverseKinematicsApiAxiosParamCreator = function (configuration?: C
|
|
|
8323
8159
|
baseOptions = configuration.baseOptions;
|
|
8324
8160
|
}
|
|
8325
8161
|
|
|
8326
|
-
const localVarRequestOptions = { method: '
|
|
8162
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
8327
8163
|
const localVarHeaderParameter = {} as any;
|
|
8328
8164
|
const localVarQueryParameter = {} as any;
|
|
8329
8165
|
|
|
@@ -8342,7 +8178,7 @@ export const InverseKinematicsApiAxiosParamCreator = function (configuration?: C
|
|
|
8342
8178
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
8343
8179
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
8344
8180
|
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
8345
|
-
localVarRequestOptions.data = serializeDataIfNeeded(
|
|
8181
|
+
localVarRequestOptions.data = serializeDataIfNeeded(executeJoggingRequest, localVarRequestOptions, configuration)
|
|
8346
8182
|
|
|
8347
8183
|
return {
|
|
8348
8184
|
url: toPathString(localVarUrlObj),
|
|
@@ -8353,93 +8189,91 @@ export const InverseKinematicsApiAxiosParamCreator = function (configuration?: C
|
|
|
8353
8189
|
};
|
|
8354
8190
|
|
|
8355
8191
|
/**
|
|
8356
|
-
*
|
|
8192
|
+
* JoggingApi - functional programming interface
|
|
8357
8193
|
* @export
|
|
8358
8194
|
*/
|
|
8359
|
-
export const
|
|
8360
|
-
const localVarAxiosParamCreator =
|
|
8195
|
+
export const JoggingApiFp = function(configuration?: Configuration) {
|
|
8196
|
+
const localVarAxiosParamCreator = JoggingApiAxiosParamCreator(configuration)
|
|
8361
8197
|
return {
|
|
8362
8198
|
/**
|
|
8363
|
-
*
|
|
8364
|
-
* @summary
|
|
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
|
|
8365
8201
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8366
|
-
* @param {
|
|
8202
|
+
* @param {ExecuteJoggingRequest} executeJoggingRequest
|
|
8367
8203
|
* @param {*} [options] Override http request option.
|
|
8368
8204
|
* @throws {RequiredError}
|
|
8369
8205
|
*/
|
|
8370
|
-
async
|
|
8371
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.
|
|
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);
|
|
8372
8208
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
8373
|
-
const localVarOperationServerBasePath = operationServerMap['
|
|
8209
|
+
const localVarOperationServerBasePath = operationServerMap['JoggingApi.executeJogging']?.[localVarOperationServerIndex]?.url;
|
|
8374
8210
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
8375
8211
|
},
|
|
8376
8212
|
}
|
|
8377
8213
|
};
|
|
8378
8214
|
|
|
8379
8215
|
/**
|
|
8380
|
-
*
|
|
8216
|
+
* JoggingApi - factory interface
|
|
8381
8217
|
* @export
|
|
8382
8218
|
*/
|
|
8383
|
-
export const
|
|
8384
|
-
const localVarFp =
|
|
8219
|
+
export const JoggingApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
|
|
8220
|
+
const localVarFp = JoggingApiFp(configuration)
|
|
8385
8221
|
return {
|
|
8386
8222
|
/**
|
|
8387
|
-
*
|
|
8388
|
-
* @summary
|
|
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
|
|
8389
8225
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8390
|
-
* @param {
|
|
8226
|
+
* @param {ExecuteJoggingRequest} executeJoggingRequest
|
|
8391
8227
|
* @param {*} [options] Override http request option.
|
|
8392
8228
|
* @throws {RequiredError}
|
|
8393
8229
|
*/
|
|
8394
|
-
|
|
8395
|
-
return localVarFp.
|
|
8230
|
+
executeJogging(cell: string, executeJoggingRequest: ExecuteJoggingRequest, options?: RawAxiosRequestConfig): AxiosPromise<ExecuteJoggingResponse> {
|
|
8231
|
+
return localVarFp.executeJogging(cell, executeJoggingRequest, options).then((request) => request(axios, basePath));
|
|
8396
8232
|
},
|
|
8397
8233
|
};
|
|
8398
8234
|
};
|
|
8399
8235
|
|
|
8400
8236
|
/**
|
|
8401
|
-
*
|
|
8237
|
+
* JoggingApi - object-oriented interface
|
|
8402
8238
|
* @export
|
|
8403
|
-
* @class
|
|
8239
|
+
* @class JoggingApi
|
|
8404
8240
|
* @extends {BaseAPI}
|
|
8405
8241
|
*/
|
|
8406
|
-
export class
|
|
8242
|
+
export class JoggingApi extends BaseAPI {
|
|
8407
8243
|
/**
|
|
8408
|
-
*
|
|
8409
|
-
* @summary
|
|
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
|
|
8410
8246
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8411
|
-
* @param {
|
|
8247
|
+
* @param {ExecuteJoggingRequest} executeJoggingRequest
|
|
8412
8248
|
* @param {*} [options] Override http request option.
|
|
8413
8249
|
* @throws {RequiredError}
|
|
8414
|
-
* @memberof
|
|
8250
|
+
* @memberof JoggingApi
|
|
8415
8251
|
*/
|
|
8416
|
-
public
|
|
8417
|
-
return
|
|
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));
|
|
8418
8254
|
}
|
|
8419
8255
|
}
|
|
8420
8256
|
|
|
8421
8257
|
|
|
8422
8258
|
|
|
8423
8259
|
/**
|
|
8424
|
-
*
|
|
8260
|
+
* KinematicsApi - axios parameter creator
|
|
8425
8261
|
* @export
|
|
8426
8262
|
*/
|
|
8427
|
-
export const
|
|
8263
|
+
export const KinematicsApiAxiosParamCreator = function (configuration?: Configuration) {
|
|
8428
8264
|
return {
|
|
8429
8265
|
/**
|
|
8430
|
-
*
|
|
8431
|
-
* @summary
|
|
8266
|
+
* Returns the reachable joint positions for a list of given poses.
|
|
8267
|
+
* @summary Inverse kinematics
|
|
8432
8268
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8433
|
-
* @param {
|
|
8269
|
+
* @param {InverseKinematicsRequest} [inverseKinematicsRequest]
|
|
8434
8270
|
* @param {*} [options] Override http request option.
|
|
8435
8271
|
* @throws {RequiredError}
|
|
8436
8272
|
*/
|
|
8437
|
-
|
|
8273
|
+
inverseKinematics: async (cell: string, inverseKinematicsRequest?: InverseKinematicsRequest, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
8438
8274
|
// verify required parameter 'cell' is not null or undefined
|
|
8439
|
-
assertParamExists('
|
|
8440
|
-
|
|
8441
|
-
assertParamExists('executeJogging', 'executeJoggingRequest', executeJoggingRequest)
|
|
8442
|
-
const localVarPath = `/cells/{cell}/execution/jogging`
|
|
8275
|
+
assertParamExists('inverseKinematics', 'cell', cell)
|
|
8276
|
+
const localVarPath = `/cells/{cell}/kinematic/inverse`
|
|
8443
8277
|
.replace(`{${"cell"}}`, encodeURIComponent(String(cell)));
|
|
8444
8278
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
8445
8279
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
@@ -8448,7 +8282,7 @@ export const JoggingApiAxiosParamCreator = function (configuration?: Configurati
|
|
|
8448
8282
|
baseOptions = configuration.baseOptions;
|
|
8449
8283
|
}
|
|
8450
8284
|
|
|
8451
|
-
const localVarRequestOptions = { method: '
|
|
8285
|
+
const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
|
|
8452
8286
|
const localVarHeaderParameter = {} as any;
|
|
8453
8287
|
const localVarQueryParameter = {} as any;
|
|
8454
8288
|
|
|
@@ -8467,7 +8301,7 @@ export const JoggingApiAxiosParamCreator = function (configuration?: Configurati
|
|
|
8467
8301
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
8468
8302
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
8469
8303
|
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
8470
|
-
localVarRequestOptions.data = serializeDataIfNeeded(
|
|
8304
|
+
localVarRequestOptions.data = serializeDataIfNeeded(inverseKinematicsRequest, localVarRequestOptions, configuration)
|
|
8471
8305
|
|
|
8472
8306
|
return {
|
|
8473
8307
|
url: toPathString(localVarUrlObj),
|
|
@@ -8478,68 +8312,68 @@ export const JoggingApiAxiosParamCreator = function (configuration?: Configurati
|
|
|
8478
8312
|
};
|
|
8479
8313
|
|
|
8480
8314
|
/**
|
|
8481
|
-
*
|
|
8315
|
+
* KinematicsApi - functional programming interface
|
|
8482
8316
|
* @export
|
|
8483
8317
|
*/
|
|
8484
|
-
export const
|
|
8485
|
-
const localVarAxiosParamCreator =
|
|
8318
|
+
export const KinematicsApiFp = function(configuration?: Configuration) {
|
|
8319
|
+
const localVarAxiosParamCreator = KinematicsApiAxiosParamCreator(configuration)
|
|
8486
8320
|
return {
|
|
8487
8321
|
/**
|
|
8488
|
-
*
|
|
8489
|
-
* @summary
|
|
8322
|
+
* Returns the reachable joint positions for a list of given poses.
|
|
8323
|
+
* @summary Inverse kinematics
|
|
8490
8324
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8491
|
-
* @param {
|
|
8325
|
+
* @param {InverseKinematicsRequest} [inverseKinematicsRequest]
|
|
8492
8326
|
* @param {*} [options] Override http request option.
|
|
8493
8327
|
* @throws {RequiredError}
|
|
8494
8328
|
*/
|
|
8495
|
-
async
|
|
8496
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.
|
|
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);
|
|
8497
8331
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
8498
|
-
const localVarOperationServerBasePath = operationServerMap['
|
|
8332
|
+
const localVarOperationServerBasePath = operationServerMap['KinematicsApi.inverseKinematics']?.[localVarOperationServerIndex]?.url;
|
|
8499
8333
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
8500
8334
|
},
|
|
8501
8335
|
}
|
|
8502
8336
|
};
|
|
8503
8337
|
|
|
8504
8338
|
/**
|
|
8505
|
-
*
|
|
8339
|
+
* KinematicsApi - factory interface
|
|
8506
8340
|
* @export
|
|
8507
8341
|
*/
|
|
8508
|
-
export const
|
|
8509
|
-
const localVarFp =
|
|
8342
|
+
export const KinematicsApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
|
|
8343
|
+
const localVarFp = KinematicsApiFp(configuration)
|
|
8510
8344
|
return {
|
|
8511
8345
|
/**
|
|
8512
|
-
*
|
|
8513
|
-
* @summary
|
|
8346
|
+
* Returns the reachable joint positions for a list of given poses.
|
|
8347
|
+
* @summary Inverse kinematics
|
|
8514
8348
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8515
|
-
* @param {
|
|
8349
|
+
* @param {InverseKinematicsRequest} [inverseKinematicsRequest]
|
|
8516
8350
|
* @param {*} [options] Override http request option.
|
|
8517
8351
|
* @throws {RequiredError}
|
|
8518
8352
|
*/
|
|
8519
|
-
|
|
8520
|
-
return localVarFp.
|
|
8353
|
+
inverseKinematics(cell: string, inverseKinematicsRequest?: InverseKinematicsRequest, options?: RawAxiosRequestConfig): AxiosPromise<InverseKinematicsResponse> {
|
|
8354
|
+
return localVarFp.inverseKinematics(cell, inverseKinematicsRequest, options).then((request) => request(axios, basePath));
|
|
8521
8355
|
},
|
|
8522
8356
|
};
|
|
8523
8357
|
};
|
|
8524
8358
|
|
|
8525
8359
|
/**
|
|
8526
|
-
*
|
|
8360
|
+
* KinematicsApi - object-oriented interface
|
|
8527
8361
|
* @export
|
|
8528
|
-
* @class
|
|
8362
|
+
* @class KinematicsApi
|
|
8529
8363
|
* @extends {BaseAPI}
|
|
8530
8364
|
*/
|
|
8531
|
-
export class
|
|
8365
|
+
export class KinematicsApi extends BaseAPI {
|
|
8532
8366
|
/**
|
|
8533
|
-
*
|
|
8534
|
-
* @summary
|
|
8367
|
+
* Returns the reachable joint positions for a list of given poses.
|
|
8368
|
+
* @summary Inverse kinematics
|
|
8535
8369
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8536
|
-
* @param {
|
|
8370
|
+
* @param {InverseKinematicsRequest} [inverseKinematicsRequest]
|
|
8537
8371
|
* @param {*} [options] Override http request option.
|
|
8538
8372
|
* @throws {RequiredError}
|
|
8539
|
-
* @memberof
|
|
8373
|
+
* @memberof KinematicsApi
|
|
8540
8374
|
*/
|
|
8541
|
-
public
|
|
8542
|
-
return
|
|
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));
|
|
8543
8377
|
}
|
|
8544
8378
|
}
|
|
8545
8379
|
|