@wandelbots/nova-api 25.6.0-dev.30 → 25.6.0-dev.31
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 +32 -216
- package/v2/api.js +52 -52
- package/v2/api.js.map +1 -1
- package/v2/api.ts +53 -237
package/package.json
CHANGED
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
|
|
@@ -2503,49 +2417,6 @@ export interface MotionGroupInfos {
|
|
|
2503
2417
|
*/
|
|
2504
2418
|
'motion_groups': Array<MotionGroupInfo>;
|
|
2505
2419
|
}
|
|
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
2420
|
/**
|
|
2550
2421
|
* Ensure to provide one value for each joint. See [getMotionGroups](getMotionGroups) for the number of joints. Everything but positions is optional.
|
|
2551
2422
|
* @export
|
|
@@ -4527,61 +4398,6 @@ export interface ValidationError2 {
|
|
|
4527
4398
|
* @export
|
|
4528
4399
|
*/
|
|
4529
4400
|
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
4401
|
/**
|
|
4586
4402
|
* 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
4403
|
* @export
|
|
@@ -5546,14 +5362,6 @@ export declare const ControllerApiAxiosParamCreator: (configuration?: Configurat
|
|
|
5546
5362
|
* @throws {RequiredError}
|
|
5547
5363
|
*/
|
|
5548
5364
|
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
5365
|
/**
|
|
5558
5366
|
* 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
5367
|
* @summary List Coordinate Systems
|
|
@@ -5564,6 +5372,14 @@ export declare const ControllerApiAxiosParamCreator: (configuration?: Configurat
|
|
|
5564
5372
|
* @throws {RequiredError}
|
|
5565
5373
|
*/
|
|
5566
5374
|
listCoordinateSystems: (cell: string, controller: string, orientationType?: OrientationType, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
5375
|
+
/**
|
|
5376
|
+
* List the names of all deployed robot controllers.
|
|
5377
|
+
* @summary List Robot Controllers
|
|
5378
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5379
|
+
* @param {*} [options] Override http request option.
|
|
5380
|
+
* @throws {RequiredError}
|
|
5381
|
+
*/
|
|
5382
|
+
listRobotControllers: (cell: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
5567
5383
|
/**
|
|
5568
5384
|
* 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
5385
|
* @summary Set Default Mode
|
|
@@ -5687,14 +5503,6 @@ export declare const ControllerApiFp: (configuration?: Configuration) => {
|
|
|
5687
5503
|
* @throws {RequiredError}
|
|
5688
5504
|
*/
|
|
5689
5505
|
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
5506
|
/**
|
|
5699
5507
|
* 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
5508
|
* @summary List Coordinate Systems
|
|
@@ -5705,6 +5513,14 @@ export declare const ControllerApiFp: (configuration?: Configuration) => {
|
|
|
5705
5513
|
* @throws {RequiredError}
|
|
5706
5514
|
*/
|
|
5707
5515
|
listCoordinateSystems(cell: string, controller: string, orientationType?: OrientationType, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListCoordinateSystemsResponse>>;
|
|
5516
|
+
/**
|
|
5517
|
+
* List the names of all deployed robot controllers.
|
|
5518
|
+
* @summary List Robot Controllers
|
|
5519
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5520
|
+
* @param {*} [options] Override http request option.
|
|
5521
|
+
* @throws {RequiredError}
|
|
5522
|
+
*/
|
|
5523
|
+
listRobotControllers(cell: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<string>>>;
|
|
5708
5524
|
/**
|
|
5709
5525
|
* 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
5526
|
* @summary Set Default Mode
|
|
@@ -5828,14 +5644,6 @@ export declare const ControllerApiFactory: (configuration?: Configuration, baseP
|
|
|
5828
5644
|
* @throws {RequiredError}
|
|
5829
5645
|
*/
|
|
5830
5646
|
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
5647
|
/**
|
|
5840
5648
|
* 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
5649
|
* @summary List Coordinate Systems
|
|
@@ -5846,6 +5654,14 @@ export declare const ControllerApiFactory: (configuration?: Configuration, baseP
|
|
|
5846
5654
|
* @throws {RequiredError}
|
|
5847
5655
|
*/
|
|
5848
5656
|
listCoordinateSystems(cell: string, controller: string, orientationType?: OrientationType, options?: RawAxiosRequestConfig): AxiosPromise<ListCoordinateSystemsResponse>;
|
|
5657
|
+
/**
|
|
5658
|
+
* List the names of all deployed robot controllers.
|
|
5659
|
+
* @summary List Robot Controllers
|
|
5660
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5661
|
+
* @param {*} [options] Override http request option.
|
|
5662
|
+
* @throws {RequiredError}
|
|
5663
|
+
*/
|
|
5664
|
+
listRobotControllers(cell: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<string>>;
|
|
5849
5665
|
/**
|
|
5850
5666
|
* 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
5667
|
* @summary Set Default Mode
|
|
@@ -5980,25 +5796,25 @@ export declare class ControllerApi extends BaseAPI {
|
|
|
5980
5796
|
*/
|
|
5981
5797
|
getVirtualRobotConfiguration(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<VirtualRobotConfiguration, any>>;
|
|
5982
5798
|
/**
|
|
5983
|
-
*
|
|
5984
|
-
* @summary List
|
|
5799
|
+
* 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.
|
|
5800
|
+
* @summary List Coordinate Systems
|
|
5985
5801
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5802
|
+
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
5803
|
+
* @param {OrientationType} [orientationType]
|
|
5986
5804
|
* @param {*} [options] Override http request option.
|
|
5987
5805
|
* @throws {RequiredError}
|
|
5988
5806
|
* @memberof ControllerApi
|
|
5989
5807
|
*/
|
|
5990
|
-
|
|
5808
|
+
listCoordinateSystems(cell: string, controller: string, orientationType?: OrientationType, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ListCoordinateSystemsResponse, any>>;
|
|
5991
5809
|
/**
|
|
5992
|
-
*
|
|
5993
|
-
* @summary List
|
|
5810
|
+
* List the names of all deployed robot controllers.
|
|
5811
|
+
* @summary List Robot Controllers
|
|
5994
5812
|
* @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
5813
|
* @param {*} [options] Override http request option.
|
|
5998
5814
|
* @throws {RequiredError}
|
|
5999
5815
|
* @memberof ControllerApi
|
|
6000
5816
|
*/
|
|
6001
|
-
|
|
5817
|
+
listRobotControllers(cell: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<string[], any>>;
|
|
6002
5818
|
/**
|
|
6003
5819
|
* 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
5820
|
* @summary Set Default Mode
|
package/v2/api.js
CHANGED
|
@@ -2192,17 +2192,22 @@ export const ControllerApiAxiosParamCreator = function (configuration) {
|
|
|
2192
2192
|
};
|
|
2193
2193
|
},
|
|
2194
2194
|
/**
|
|
2195
|
-
*
|
|
2196
|
-
* @summary List
|
|
2195
|
+
* 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.
|
|
2196
|
+
* @summary List Coordinate Systems
|
|
2197
2197
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
2198
|
+
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
2199
|
+
* @param {OrientationType} [orientationType]
|
|
2198
2200
|
* @param {*} [options] Override http request option.
|
|
2199
2201
|
* @throws {RequiredError}
|
|
2200
2202
|
*/
|
|
2201
|
-
|
|
2203
|
+
listCoordinateSystems: async (cell, controller, orientationType, options = {}) => {
|
|
2202
2204
|
// verify required parameter 'cell' is not null or undefined
|
|
2203
|
-
assertParamExists('
|
|
2204
|
-
|
|
2205
|
-
|
|
2205
|
+
assertParamExists('listCoordinateSystems', 'cell', cell);
|
|
2206
|
+
// verify required parameter 'controller' is not null or undefined
|
|
2207
|
+
assertParamExists('listCoordinateSystems', 'controller', controller);
|
|
2208
|
+
const localVarPath = `/cells/{cell}/controllers/{controller}/coordinate-systems`
|
|
2209
|
+
.replace(`{${"cell"}}`, encodeURIComponent(String(cell)))
|
|
2210
|
+
.replace(`{${"controller"}}`, encodeURIComponent(String(controller)));
|
|
2206
2211
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
2207
2212
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
2208
2213
|
let baseOptions;
|
|
@@ -2218,6 +2223,9 @@ export const ControllerApiAxiosParamCreator = function (configuration) {
|
|
|
2218
2223
|
// authentication BearerAuth required
|
|
2219
2224
|
// http bearer authentication required
|
|
2220
2225
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
2226
|
+
if (orientationType !== undefined) {
|
|
2227
|
+
localVarQueryParameter['orientation_type'] = orientationType;
|
|
2228
|
+
}
|
|
2221
2229
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
2222
2230
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
2223
2231
|
localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
|
|
@@ -2227,22 +2235,17 @@ export const ControllerApiAxiosParamCreator = function (configuration) {
|
|
|
2227
2235
|
};
|
|
2228
2236
|
},
|
|
2229
2237
|
/**
|
|
2230
|
-
*
|
|
2231
|
-
* @summary List
|
|
2238
|
+
* List the names of all deployed robot controllers.
|
|
2239
|
+
* @summary List Robot Controllers
|
|
2232
2240
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
2233
|
-
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
2234
|
-
* @param {OrientationType} [orientationType]
|
|
2235
2241
|
* @param {*} [options] Override http request option.
|
|
2236
2242
|
* @throws {RequiredError}
|
|
2237
2243
|
*/
|
|
2238
|
-
|
|
2244
|
+
listRobotControllers: async (cell, options = {}) => {
|
|
2239
2245
|
// verify required parameter 'cell' is not null or undefined
|
|
2240
|
-
assertParamExists('
|
|
2241
|
-
|
|
2242
|
-
|
|
2243
|
-
const localVarPath = `/cells/{cell}/controllers/{controller}/coordinate-systems`
|
|
2244
|
-
.replace(`{${"cell"}}`, encodeURIComponent(String(cell)))
|
|
2245
|
-
.replace(`{${"controller"}}`, encodeURIComponent(String(controller)));
|
|
2246
|
+
assertParamExists('listRobotControllers', 'cell', cell);
|
|
2247
|
+
const localVarPath = `/cells/{cell}/controllers`
|
|
2248
|
+
.replace(`{${"cell"}}`, encodeURIComponent(String(cell)));
|
|
2246
2249
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
2247
2250
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
2248
2251
|
let baseOptions;
|
|
@@ -2258,9 +2261,6 @@ export const ControllerApiAxiosParamCreator = function (configuration) {
|
|
|
2258
2261
|
// authentication BearerAuth required
|
|
2259
2262
|
// http bearer authentication required
|
|
2260
2263
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
2261
|
-
if (orientationType !== undefined) {
|
|
2262
|
-
localVarQueryParameter['orientation_type'] = orientationType;
|
|
2263
|
-
}
|
|
2264
2264
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
2265
2265
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
2266
2266
|
localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
|
|
@@ -2574,31 +2574,31 @@ export const ControllerApiFp = function (configuration) {
|
|
|
2574
2574
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
2575
2575
|
},
|
|
2576
2576
|
/**
|
|
2577
|
-
*
|
|
2578
|
-
* @summary List
|
|
2577
|
+
* 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.
|
|
2578
|
+
* @summary List Coordinate Systems
|
|
2579
2579
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
2580
|
+
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
2581
|
+
* @param {OrientationType} [orientationType]
|
|
2580
2582
|
* @param {*} [options] Override http request option.
|
|
2581
2583
|
* @throws {RequiredError}
|
|
2582
2584
|
*/
|
|
2583
|
-
async
|
|
2584
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.
|
|
2585
|
+
async listCoordinateSystems(cell, controller, orientationType, options) {
|
|
2586
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.listCoordinateSystems(cell, controller, orientationType, options);
|
|
2585
2587
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
2586
|
-
const localVarOperationServerBasePath = operationServerMap['ControllerApi.
|
|
2588
|
+
const localVarOperationServerBasePath = operationServerMap['ControllerApi.listCoordinateSystems']?.[localVarOperationServerIndex]?.url;
|
|
2587
2589
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
2588
2590
|
},
|
|
2589
2591
|
/**
|
|
2590
|
-
*
|
|
2591
|
-
* @summary List
|
|
2592
|
+
* List the names of all deployed robot controllers.
|
|
2593
|
+
* @summary List Robot Controllers
|
|
2592
2594
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
2593
|
-
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
2594
|
-
* @param {OrientationType} [orientationType]
|
|
2595
2595
|
* @param {*} [options] Override http request option.
|
|
2596
2596
|
* @throws {RequiredError}
|
|
2597
2597
|
*/
|
|
2598
|
-
async
|
|
2599
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.
|
|
2598
|
+
async listRobotControllers(cell, options) {
|
|
2599
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.listRobotControllers(cell, options);
|
|
2600
2600
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
2601
|
-
const localVarOperationServerBasePath = operationServerMap['ControllerApi.
|
|
2601
|
+
const localVarOperationServerBasePath = operationServerMap['ControllerApi.listRobotControllers']?.[localVarOperationServerIndex]?.url;
|
|
2602
2602
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
2603
2603
|
},
|
|
2604
2604
|
/**
|
|
@@ -2763,16 +2763,6 @@ export const ControllerApiFactory = function (configuration, basePath, axios) {
|
|
|
2763
2763
|
getVirtualRobotConfiguration(cell, controller, options) {
|
|
2764
2764
|
return localVarFp.getVirtualRobotConfiguration(cell, controller, options).then((request) => request(axios, basePath));
|
|
2765
2765
|
},
|
|
2766
|
-
/**
|
|
2767
|
-
* List all configured robot controllers.
|
|
2768
|
-
* @summary List Descriptions
|
|
2769
|
-
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
2770
|
-
* @param {*} [options] Override http request option.
|
|
2771
|
-
* @throws {RequiredError}
|
|
2772
|
-
*/
|
|
2773
|
-
listControllers(cell, options) {
|
|
2774
|
-
return localVarFp.listControllers(cell, options).then((request) => request(axios, basePath));
|
|
2775
|
-
},
|
|
2776
2766
|
/**
|
|
2777
2767
|
* 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.
|
|
2778
2768
|
* @summary List Coordinate Systems
|
|
@@ -2785,6 +2775,16 @@ export const ControllerApiFactory = function (configuration, basePath, axios) {
|
|
|
2785
2775
|
listCoordinateSystems(cell, controller, orientationType, options) {
|
|
2786
2776
|
return localVarFp.listCoordinateSystems(cell, controller, orientationType, options).then((request) => request(axios, basePath));
|
|
2787
2777
|
},
|
|
2778
|
+
/**
|
|
2779
|
+
* List the names of all deployed robot controllers.
|
|
2780
|
+
* @summary List Robot Controllers
|
|
2781
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
2782
|
+
* @param {*} [options] Override http request option.
|
|
2783
|
+
* @throws {RequiredError}
|
|
2784
|
+
*/
|
|
2785
|
+
listRobotControllers(cell, options) {
|
|
2786
|
+
return localVarFp.listRobotControllers(cell, options).then((request) => request(axios, basePath));
|
|
2787
|
+
},
|
|
2788
2788
|
/**
|
|
2789
2789
|
* 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.
|
|
2790
2790
|
* @summary Set Default Mode
|
|
@@ -2944,28 +2944,28 @@ export class ControllerApi extends BaseAPI {
|
|
|
2944
2944
|
return ControllerApiFp(this.configuration).getVirtualRobotConfiguration(cell, controller, options).then((request) => request(this.axios, this.basePath));
|
|
2945
2945
|
}
|
|
2946
2946
|
/**
|
|
2947
|
-
*
|
|
2948
|
-
* @summary List
|
|
2947
|
+
* 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.
|
|
2948
|
+
* @summary List Coordinate Systems
|
|
2949
2949
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
2950
|
+
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
2951
|
+
* @param {OrientationType} [orientationType]
|
|
2950
2952
|
* @param {*} [options] Override http request option.
|
|
2951
2953
|
* @throws {RequiredError}
|
|
2952
2954
|
* @memberof ControllerApi
|
|
2953
2955
|
*/
|
|
2954
|
-
|
|
2955
|
-
return ControllerApiFp(this.configuration).
|
|
2956
|
+
listCoordinateSystems(cell, controller, orientationType, options) {
|
|
2957
|
+
return ControllerApiFp(this.configuration).listCoordinateSystems(cell, controller, orientationType, options).then((request) => request(this.axios, this.basePath));
|
|
2956
2958
|
}
|
|
2957
2959
|
/**
|
|
2958
|
-
*
|
|
2959
|
-
* @summary List
|
|
2960
|
+
* List the names of all deployed robot controllers.
|
|
2961
|
+
* @summary List Robot Controllers
|
|
2960
2962
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
2961
|
-
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
2962
|
-
* @param {OrientationType} [orientationType]
|
|
2963
2963
|
* @param {*} [options] Override http request option.
|
|
2964
2964
|
* @throws {RequiredError}
|
|
2965
2965
|
* @memberof ControllerApi
|
|
2966
2966
|
*/
|
|
2967
|
-
|
|
2968
|
-
return ControllerApiFp(this.configuration).
|
|
2967
|
+
listRobotControllers(cell, options) {
|
|
2968
|
+
return ControllerApiFp(this.configuration).listRobotControllers(cell, options).then((request) => request(this.axios, this.basePath));
|
|
2969
2969
|
}
|
|
2970
2970
|
/**
|
|
2971
2971
|
* 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.
|