@wandelbots/nova-api 25.7.0-dev.2 → 25.7.0-dev.3
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 +596 -597
- package/v2/api.js +1254 -1218
- package/v2/api.js.map +1 -1
- package/v2/api.ts +1351 -1333
package/v2/api.ts
CHANGED
|
@@ -224,7 +224,7 @@ export interface App {
|
|
|
224
224
|
'diagnosis_path'?: string;
|
|
225
225
|
}
|
|
226
226
|
/**
|
|
227
|
-
* ## BEHAVIOR_AUTOMATIC This is the default behavior. The motion
|
|
227
|
+
* ## BEHAVIOR_AUTOMATIC This is the default behavior. The motion groups of the controller take commanded joint configuration as actual joint state. Configures the compliance of the virtual robot with the normal ControllerState cycle time. If set, the virtual robot will act like a physical one, e.g. with a cycle time of 8ms to respond to a new joint state command. ## BEHAVIOR_AUTOMATIC_NOT_COMPLY_WITH_CYCLETIME Configures the compliance of the virtual robot with the normal ControllerState cycle time. If set, the robot will respond as fast as possible, limited only by software execution speed. Because of that the execution of a movement requires less time than with BEHAVIOR_AUTOMATIC. ## BEHAVIOR_EXTERNAL_SOURCE The external client is the only source of actual joint state changes. This mode is used to enable third party software indicating the current joint state via [externalJointsStream](externalJointsStream).
|
|
228
228
|
* @export
|
|
229
229
|
* @enum {string}
|
|
230
230
|
*/
|
|
@@ -902,12 +902,6 @@ export type ConvexHullShapeTypeEnum = typeof ConvexHullShapeTypeEnum[keyof typeo
|
|
|
902
902
|
* @interface CoordinateSystem
|
|
903
903
|
*/
|
|
904
904
|
export interface CoordinateSystem {
|
|
905
|
-
/**
|
|
906
|
-
* Unique identifier of the coordinate system.
|
|
907
|
-
* @type {string}
|
|
908
|
-
* @memberof CoordinateSystem
|
|
909
|
-
*/
|
|
910
|
-
'coordinate_system': string;
|
|
911
905
|
/**
|
|
912
906
|
* Human readable name of this coordinate system.
|
|
913
907
|
* @type {string}
|
|
@@ -938,22 +932,54 @@ export interface CoordinateSystem {
|
|
|
938
932
|
* @memberof CoordinateSystem
|
|
939
933
|
*/
|
|
940
934
|
'orientation_type'?: OrientationType;
|
|
935
|
+
/**
|
|
936
|
+
* Unique identifier of the coordinate system.
|
|
937
|
+
* @type {string}
|
|
938
|
+
* @memberof CoordinateSystem
|
|
939
|
+
*/
|
|
940
|
+
'coordinate_system': string;
|
|
941
941
|
}
|
|
942
942
|
|
|
943
943
|
|
|
944
944
|
/**
|
|
945
945
|
*
|
|
946
946
|
* @export
|
|
947
|
-
* @interface
|
|
947
|
+
* @interface CoordinateSystemData
|
|
948
948
|
*/
|
|
949
|
-
export interface
|
|
949
|
+
export interface CoordinateSystemData {
|
|
950
|
+
/**
|
|
951
|
+
* Human readable name of this coordinate system.
|
|
952
|
+
* @type {string}
|
|
953
|
+
* @memberof CoordinateSystemData
|
|
954
|
+
*/
|
|
955
|
+
'name'?: string;
|
|
956
|
+
/**
|
|
957
|
+
* The identifier of the reference coordinate system. Empty if world is used.
|
|
958
|
+
* @type {string}
|
|
959
|
+
* @memberof CoordinateSystemData
|
|
960
|
+
*/
|
|
961
|
+
'reference_coordinate_system'?: string;
|
|
962
|
+
/**
|
|
963
|
+
* A three-dimensional vector [x, y, z] with double precision.
|
|
964
|
+
* @type {Array<number>}
|
|
965
|
+
* @memberof CoordinateSystemData
|
|
966
|
+
*/
|
|
967
|
+
'position'?: Array<number>;
|
|
968
|
+
/**
|
|
969
|
+
* Describes an orientation in 3D space. A tree-to-four-dimensional vector [x, y, z, w] with double precision.
|
|
970
|
+
* @type {Array<number>}
|
|
971
|
+
* @memberof CoordinateSystemData
|
|
972
|
+
*/
|
|
973
|
+
'orientation'?: Array<number>;
|
|
950
974
|
/**
|
|
951
975
|
*
|
|
952
|
-
* @type {
|
|
953
|
-
* @memberof
|
|
976
|
+
* @type {OrientationType}
|
|
977
|
+
* @memberof CoordinateSystemData
|
|
954
978
|
*/
|
|
955
|
-
'
|
|
979
|
+
'orientation_type'?: OrientationType;
|
|
956
980
|
}
|
|
981
|
+
|
|
982
|
+
|
|
957
983
|
/**
|
|
958
984
|
*
|
|
959
985
|
* @export
|
|
@@ -1165,41 +1191,23 @@ export interface ExternalJointStreamDatapoint {
|
|
|
1165
1191
|
'motion_group': string;
|
|
1166
1192
|
/**
|
|
1167
1193
|
*
|
|
1168
|
-
* @type {
|
|
1194
|
+
* @type {MotionGroupJoints}
|
|
1169
1195
|
* @memberof ExternalJointStreamDatapoint
|
|
1170
1196
|
*/
|
|
1171
|
-
'value':
|
|
1197
|
+
'value': MotionGroupJoints;
|
|
1172
1198
|
}
|
|
1173
1199
|
/**
|
|
1174
|
-
*
|
|
1200
|
+
*
|
|
1175
1201
|
* @export
|
|
1176
|
-
* @interface
|
|
1202
|
+
* @interface ExternalJointStreamRequest
|
|
1177
1203
|
*/
|
|
1178
|
-
export interface
|
|
1179
|
-
/**
|
|
1180
|
-
* The joint positions of the robot.
|
|
1181
|
-
* @type {Array<number>}
|
|
1182
|
-
* @memberof ExternalJointStreamDatapointValue
|
|
1183
|
-
*/
|
|
1184
|
-
'positions': Array<number>;
|
|
1185
|
-
/**
|
|
1186
|
-
* The joint velocities of the robot.
|
|
1187
|
-
* @type {Array<number>}
|
|
1188
|
-
* @memberof ExternalJointStreamDatapointValue
|
|
1189
|
-
*/
|
|
1190
|
-
'velocities': Array<number>;
|
|
1204
|
+
export interface ExternalJointStreamRequest {
|
|
1191
1205
|
/**
|
|
1192
|
-
*
|
|
1193
|
-
* @type {Array<
|
|
1194
|
-
* @memberof
|
|
1195
|
-
*/
|
|
1196
|
-
'accelerations': Array<number>;
|
|
1197
|
-
/**
|
|
1198
|
-
* The joint torques of the robot.
|
|
1199
|
-
* @type {Array<number>}
|
|
1200
|
-
* @memberof ExternalJointStreamDatapointValue
|
|
1206
|
+
*
|
|
1207
|
+
* @type {Array<ExternalJointStreamDatapoint>}
|
|
1208
|
+
* @memberof ExternalJointStreamRequest
|
|
1201
1209
|
*/
|
|
1202
|
-
'
|
|
1210
|
+
'states': Array<ExternalJointStreamDatapoint>;
|
|
1203
1211
|
}
|
|
1204
1212
|
/**
|
|
1205
1213
|
* The configuration of a physical FANUC robot controller has to contain IP address of the controller.
|
|
@@ -2417,19 +2425,6 @@ export interface LimitsOverride {
|
|
|
2417
2425
|
*/
|
|
2418
2426
|
'tcp_orientation_acceleration_limit'?: number;
|
|
2419
2427
|
}
|
|
2420
|
-
/**
|
|
2421
|
-
*
|
|
2422
|
-
* @export
|
|
2423
|
-
* @interface ListCoordinateSystemsResponse
|
|
2424
|
-
*/
|
|
2425
|
-
export interface ListCoordinateSystemsResponse {
|
|
2426
|
-
/**
|
|
2427
|
-
*
|
|
2428
|
-
* @type {Array<CoordinateSystem>}
|
|
2429
|
-
* @memberof ListCoordinateSystemsResponse
|
|
2430
|
-
*/
|
|
2431
|
-
'coordinatesystems'?: Array<CoordinateSystem>;
|
|
2432
|
-
}
|
|
2433
2428
|
/**
|
|
2434
2429
|
*
|
|
2435
2430
|
* @export
|
|
@@ -2517,21 +2512,6 @@ export type MotionCommandBlending = BlendingAuto | BlendingPosition;
|
|
|
2517
2512
|
*/
|
|
2518
2513
|
export type MotionCommandPath = PathCartesianPTP | PathCircle | PathCubicSpline | PathJointPTP | PathLine;
|
|
2519
2514
|
|
|
2520
|
-
/**
|
|
2521
|
-
*
|
|
2522
|
-
* @export
|
|
2523
|
-
* @interface MotionGroupBehaviorGetter
|
|
2524
|
-
*/
|
|
2525
|
-
export interface MotionGroupBehaviorGetter {
|
|
2526
|
-
/**
|
|
2527
|
-
*
|
|
2528
|
-
* @type {Behavior}
|
|
2529
|
-
* @memberof MotionGroupBehaviorGetter
|
|
2530
|
-
*/
|
|
2531
|
-
'behavior': Behavior;
|
|
2532
|
-
}
|
|
2533
|
-
|
|
2534
|
-
|
|
2535
2515
|
/**
|
|
2536
2516
|
* The configuration of a motion-group used for motion planning.
|
|
2537
2517
|
* @export
|
|
@@ -2543,7 +2523,7 @@ export interface MotionGroupDescription {
|
|
|
2543
2523
|
* @type {string}
|
|
2544
2524
|
* @memberof MotionGroupDescription
|
|
2545
2525
|
*/
|
|
2546
|
-
'
|
|
2526
|
+
'motion_group_model': string;
|
|
2547
2527
|
/**
|
|
2548
2528
|
* The offset from the world frame to the motion group base.
|
|
2549
2529
|
* @type {Pose}
|
|
@@ -2624,19 +2604,6 @@ export interface MotionGroupInfo {
|
|
|
2624
2604
|
*/
|
|
2625
2605
|
'dof': number;
|
|
2626
2606
|
}
|
|
2627
|
-
/**
|
|
2628
|
-
*
|
|
2629
|
-
* @export
|
|
2630
|
-
* @interface MotionGroupInfos
|
|
2631
|
-
*/
|
|
2632
|
-
export interface MotionGroupInfos {
|
|
2633
|
-
/**
|
|
2634
|
-
*
|
|
2635
|
-
* @type {Array<MotionGroupInfo>}
|
|
2636
|
-
* @memberof MotionGroupInfos
|
|
2637
|
-
*/
|
|
2638
|
-
'motion_groups': Array<MotionGroupInfo>;
|
|
2639
|
-
}
|
|
2640
2607
|
/**
|
|
2641
2608
|
* Ensure to provide one value for each joint. See [getMotionGroups](getMotionGroups) for the number of joints. Everything but positions is optional.
|
|
2642
2609
|
* @export
|
|
@@ -2799,7 +2766,7 @@ export interface MovementErrorResponse {
|
|
|
2799
2766
|
}
|
|
2800
2767
|
|
|
2801
2768
|
export const MovementErrorResponseKindEnum = {
|
|
2802
|
-
|
|
2769
|
+
MotionError: 'MOTION_ERROR'
|
|
2803
2770
|
} as const;
|
|
2804
2771
|
|
|
2805
2772
|
export type MovementErrorResponseKindEnum = typeof MovementErrorResponseKindEnum[keyof typeof MovementErrorResponseKindEnum];
|
|
@@ -3740,12 +3707,6 @@ export type RobotSystemMode = typeof RobotSystemMode[keyof typeof RobotSystemMod
|
|
|
3740
3707
|
* @interface RobotTcp
|
|
3741
3708
|
*/
|
|
3742
3709
|
export interface RobotTcp {
|
|
3743
|
-
/**
|
|
3744
|
-
* Identifier of this tcp.
|
|
3745
|
-
* @type {string}
|
|
3746
|
-
* @memberof RobotTcp
|
|
3747
|
-
*/
|
|
3748
|
-
'id': string;
|
|
3749
3710
|
/**
|
|
3750
3711
|
* A readable and changeable name for frontend visualization.
|
|
3751
3712
|
* @type {string}
|
|
@@ -3770,22 +3731,48 @@ export interface RobotTcp {
|
|
|
3770
3731
|
* @memberof RobotTcp
|
|
3771
3732
|
*/
|
|
3772
3733
|
'orientation_type'?: OrientationType;
|
|
3734
|
+
/**
|
|
3735
|
+
* Identifier of this tcp.
|
|
3736
|
+
* @type {string}
|
|
3737
|
+
* @memberof RobotTcp
|
|
3738
|
+
*/
|
|
3739
|
+
'id': string;
|
|
3773
3740
|
}
|
|
3774
3741
|
|
|
3775
3742
|
|
|
3776
3743
|
/**
|
|
3777
3744
|
*
|
|
3778
3745
|
* @export
|
|
3779
|
-
* @interface
|
|
3746
|
+
* @interface RobotTcpData
|
|
3780
3747
|
*/
|
|
3781
|
-
export interface
|
|
3748
|
+
export interface RobotTcpData {
|
|
3749
|
+
/**
|
|
3750
|
+
* A readable and changeable name for frontend visualization.
|
|
3751
|
+
* @type {string}
|
|
3752
|
+
* @memberof RobotTcpData
|
|
3753
|
+
*/
|
|
3754
|
+
'name'?: string;
|
|
3755
|
+
/**
|
|
3756
|
+
* A three-dimensional vector [x, y, z] with double precision.
|
|
3757
|
+
* @type {Array<number>}
|
|
3758
|
+
* @memberof RobotTcpData
|
|
3759
|
+
*/
|
|
3760
|
+
'position': Array<number>;
|
|
3761
|
+
/**
|
|
3762
|
+
* Describes an orientation in 3D space. A tree-to-four-dimensional vector [x, y, z, w] with double precision.
|
|
3763
|
+
* @type {Array<number>}
|
|
3764
|
+
* @memberof RobotTcpData
|
|
3765
|
+
*/
|
|
3766
|
+
'orientation'?: Array<number>;
|
|
3782
3767
|
/**
|
|
3783
3768
|
*
|
|
3784
|
-
* @type {
|
|
3785
|
-
* @memberof
|
|
3769
|
+
* @type {OrientationType}
|
|
3770
|
+
* @memberof RobotTcpData
|
|
3786
3771
|
*/
|
|
3787
|
-
'
|
|
3772
|
+
'orientation_type'?: OrientationType;
|
|
3788
3773
|
}
|
|
3774
|
+
|
|
3775
|
+
|
|
3789
3776
|
/**
|
|
3790
3777
|
*
|
|
3791
3778
|
* @export
|
|
@@ -6798,7 +6785,7 @@ export const ControllerApiFp = function(configuration?: Configuration) {
|
|
|
6798
6785
|
* @param {*} [options] Override http request option.
|
|
6799
6786
|
* @throws {RequiredError}
|
|
6800
6787
|
*/
|
|
6801
|
-
async listCoordinateSystems(cell: string, controller: string, orientationType?: OrientationType, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<
|
|
6788
|
+
async listCoordinateSystems(cell: string, controller: string, orientationType?: OrientationType, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<CoordinateSystem>>> {
|
|
6802
6789
|
const localVarAxiosArgs = await localVarAxiosParamCreator.listCoordinateSystems(cell, controller, orientationType, options);
|
|
6803
6790
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
6804
6791
|
const localVarOperationServerBasePath = operationServerMap['ControllerApi.listCoordinateSystems']?.[localVarOperationServerIndex]?.url;
|
|
@@ -6989,7 +6976,7 @@ export const ControllerApiFactory = function (configuration?: Configuration, bas
|
|
|
6989
6976
|
* @param {*} [options] Override http request option.
|
|
6990
6977
|
* @throws {RequiredError}
|
|
6991
6978
|
*/
|
|
6992
|
-
listCoordinateSystems(cell: string, controller: string, orientationType?: OrientationType, options?: RawAxiosRequestConfig): AxiosPromise<
|
|
6979
|
+
listCoordinateSystems(cell: string, controller: string, orientationType?: OrientationType, options?: RawAxiosRequestConfig): AxiosPromise<Array<CoordinateSystem>> {
|
|
6993
6980
|
return localVarFp.listCoordinateSystems(cell, controller, orientationType, options).then((request) => request(axios, basePath));
|
|
6994
6981
|
},
|
|
6995
6982
|
/**
|
|
@@ -7790,17 +7777,21 @@ export const JoggingApiAxiosParamCreator = function (configuration?: Configurati
|
|
|
7790
7777
|
* <!-- 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.
|
|
7791
7778
|
* @summary Execute Jogging
|
|
7792
7779
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
7780
|
+
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
7793
7781
|
* @param {ExecuteJoggingRequest} executeJoggingRequest
|
|
7794
7782
|
* @param {*} [options] Override http request option.
|
|
7795
7783
|
* @throws {RequiredError}
|
|
7796
7784
|
*/
|
|
7797
|
-
executeJogging: async (cell: string, executeJoggingRequest: ExecuteJoggingRequest, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
7785
|
+
executeJogging: async (cell: string, controller: string, executeJoggingRequest: ExecuteJoggingRequest, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
7798
7786
|
// verify required parameter 'cell' is not null or undefined
|
|
7799
7787
|
assertParamExists('executeJogging', 'cell', cell)
|
|
7788
|
+
// verify required parameter 'controller' is not null or undefined
|
|
7789
|
+
assertParamExists('executeJogging', 'controller', controller)
|
|
7800
7790
|
// verify required parameter 'executeJoggingRequest' is not null or undefined
|
|
7801
7791
|
assertParamExists('executeJogging', 'executeJoggingRequest', executeJoggingRequest)
|
|
7802
|
-
const localVarPath = `/cells/{cell}/execution/jogging`
|
|
7803
|
-
.replace(`{${"cell"}}`, encodeURIComponent(String(cell)))
|
|
7792
|
+
const localVarPath = `/cells/{cell}/controllers/{controller}/execution/jogging`
|
|
7793
|
+
.replace(`{${"cell"}}`, encodeURIComponent(String(cell)))
|
|
7794
|
+
.replace(`{${"controller"}}`, encodeURIComponent(String(controller)));
|
|
7804
7795
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
7805
7796
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
7806
7797
|
let baseOptions;
|
|
@@ -7848,12 +7839,13 @@ export const JoggingApiFp = function(configuration?: Configuration) {
|
|
|
7848
7839
|
* <!-- 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.
|
|
7849
7840
|
* @summary Execute Jogging
|
|
7850
7841
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
7842
|
+
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
7851
7843
|
* @param {ExecuteJoggingRequest} executeJoggingRequest
|
|
7852
7844
|
* @param {*} [options] Override http request option.
|
|
7853
7845
|
* @throws {RequiredError}
|
|
7854
7846
|
*/
|
|
7855
|
-
async executeJogging(cell: string, executeJoggingRequest: ExecuteJoggingRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ExecuteJoggingResponse>> {
|
|
7856
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.executeJogging(cell, executeJoggingRequest, options);
|
|
7847
|
+
async executeJogging(cell: string, controller: string, executeJoggingRequest: ExecuteJoggingRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ExecuteJoggingResponse>> {
|
|
7848
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.executeJogging(cell, controller, executeJoggingRequest, options);
|
|
7857
7849
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
7858
7850
|
const localVarOperationServerBasePath = operationServerMap['JoggingApi.executeJogging']?.[localVarOperationServerIndex]?.url;
|
|
7859
7851
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
@@ -7872,12 +7864,13 @@ export const JoggingApiFactory = function (configuration?: Configuration, basePa
|
|
|
7872
7864
|
* <!-- 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.
|
|
7873
7865
|
* @summary Execute Jogging
|
|
7874
7866
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
7867
|
+
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
7875
7868
|
* @param {ExecuteJoggingRequest} executeJoggingRequest
|
|
7876
7869
|
* @param {*} [options] Override http request option.
|
|
7877
7870
|
* @throws {RequiredError}
|
|
7878
7871
|
*/
|
|
7879
|
-
executeJogging(cell: string, executeJoggingRequest: ExecuteJoggingRequest, options?: RawAxiosRequestConfig): AxiosPromise<ExecuteJoggingResponse> {
|
|
7880
|
-
return localVarFp.executeJogging(cell, executeJoggingRequest, options).then((request) => request(axios, basePath));
|
|
7872
|
+
executeJogging(cell: string, controller: string, executeJoggingRequest: ExecuteJoggingRequest, options?: RawAxiosRequestConfig): AxiosPromise<ExecuteJoggingResponse> {
|
|
7873
|
+
return localVarFp.executeJogging(cell, controller, executeJoggingRequest, options).then((request) => request(axios, basePath));
|
|
7881
7874
|
},
|
|
7882
7875
|
};
|
|
7883
7876
|
};
|
|
@@ -7893,13 +7886,14 @@ export class JoggingApi extends BaseAPI {
|
|
|
7893
7886
|
* <!-- 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.
|
|
7894
7887
|
* @summary Execute Jogging
|
|
7895
7888
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
7889
|
+
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
7896
7890
|
* @param {ExecuteJoggingRequest} executeJoggingRequest
|
|
7897
7891
|
* @param {*} [options] Override http request option.
|
|
7898
7892
|
* @throws {RequiredError}
|
|
7899
7893
|
* @memberof JoggingApi
|
|
7900
7894
|
*/
|
|
7901
|
-
public executeJogging(cell: string, executeJoggingRequest: ExecuteJoggingRequest, options?: RawAxiosRequestConfig) {
|
|
7902
|
-
return JoggingApiFp(this.configuration).executeJogging(cell, executeJoggingRequest, options).then((request) => request(this.axios, this.basePath));
|
|
7895
|
+
public executeJogging(cell: string, controller: string, executeJoggingRequest: ExecuteJoggingRequest, options?: RawAxiosRequestConfig) {
|
|
7896
|
+
return JoggingApiFp(this.configuration).executeJogging(cell, controller, executeJoggingRequest, options).then((request) => request(this.axios, this.basePath));
|
|
7903
7897
|
}
|
|
7904
7898
|
}
|
|
7905
7899
|
|
|
@@ -8366,18 +8360,22 @@ export const MotionGroupApiAxiosParamCreator = function (configuration?: Configu
|
|
|
8366
8360
|
* Returns the current state of the selected motion group including the current joint position, velocity, pose, and more.
|
|
8367
8361
|
* @summary State
|
|
8368
8362
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8363
|
+
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
8369
8364
|
* @param {string} motionGroup The motion-group identifier.
|
|
8370
8365
|
* @param {string} [responseCoordinateSystem] Unique identifier addressing a coordinate system to which the responses should be converted. If not set, world coordinate system is used.
|
|
8371
8366
|
* @param {*} [options] Override http request option.
|
|
8372
8367
|
* @throws {RequiredError}
|
|
8373
8368
|
*/
|
|
8374
|
-
getCurrentMotionGroupState: async (cell: string, motionGroup: string, responseCoordinateSystem?: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
8369
|
+
getCurrentMotionGroupState: async (cell: string, controller: string, motionGroup: string, responseCoordinateSystem?: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
8375
8370
|
// verify required parameter 'cell' is not null or undefined
|
|
8376
8371
|
assertParamExists('getCurrentMotionGroupState', 'cell', cell)
|
|
8372
|
+
// verify required parameter 'controller' is not null or undefined
|
|
8373
|
+
assertParamExists('getCurrentMotionGroupState', 'controller', controller)
|
|
8377
8374
|
// verify required parameter 'motionGroup' is not null or undefined
|
|
8378
8375
|
assertParamExists('getCurrentMotionGroupState', 'motionGroup', motionGroup)
|
|
8379
|
-
const localVarPath = `/cells/{cell}/motion-groups/{motion-group}/state`
|
|
8376
|
+
const localVarPath = `/cells/{cell}/controllers/{controller}/motion-groups/{motion-group}/state`
|
|
8380
8377
|
.replace(`{${"cell"}}`, encodeURIComponent(String(cell)))
|
|
8378
|
+
.replace(`{${"controller"}}`, encodeURIComponent(String(controller)))
|
|
8381
8379
|
.replace(`{${"motion-group"}}`, encodeURIComponent(String(motionGroup)));
|
|
8382
8380
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
8383
8381
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
@@ -8417,17 +8415,21 @@ export const MotionGroupApiAxiosParamCreator = function (configuration?: Configu
|
|
|
8417
8415
|
* Get the set of parameters that describe the motion group and its configuration including safety zones, limits, etc. This data might change upon connection to the robot.
|
|
8418
8416
|
* @summary Description
|
|
8419
8417
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8418
|
+
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
8420
8419
|
* @param {string} motionGroup The motion-group identifier.
|
|
8421
8420
|
* @param {*} [options] Override http request option.
|
|
8422
8421
|
* @throws {RequiredError}
|
|
8423
8422
|
*/
|
|
8424
|
-
getMotionGroupDescription: async (cell: string, motionGroup: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
8423
|
+
getMotionGroupDescription: async (cell: string, controller: string, motionGroup: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
8425
8424
|
// verify required parameter 'cell' is not null or undefined
|
|
8426
8425
|
assertParamExists('getMotionGroupDescription', 'cell', cell)
|
|
8426
|
+
// verify required parameter 'controller' is not null or undefined
|
|
8427
|
+
assertParamExists('getMotionGroupDescription', 'controller', controller)
|
|
8427
8428
|
// verify required parameter 'motionGroup' is not null or undefined
|
|
8428
8429
|
assertParamExists('getMotionGroupDescription', 'motionGroup', motionGroup)
|
|
8429
|
-
const localVarPath = `/cells/{cell}/motion-groups/{motion-group}/description`
|
|
8430
|
+
const localVarPath = `/cells/{cell}/controllers/{controller}/motion-groups/{motion-group}/description`
|
|
8430
8431
|
.replace(`{${"cell"}}`, encodeURIComponent(String(cell)))
|
|
8432
|
+
.replace(`{${"controller"}}`, encodeURIComponent(String(controller)))
|
|
8431
8433
|
.replace(`{${"motion-group"}}`, encodeURIComponent(String(motionGroup)));
|
|
8432
8434
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
8433
8435
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
@@ -8463,19 +8465,23 @@ export const MotionGroupApiAxiosParamCreator = function (configuration?: Configu
|
|
|
8463
8465
|
* <!-- theme: danger --> > Websocket endpoint Receive updates of the motion group state. The stream will be closed from the server if the controller is disconnected.
|
|
8464
8466
|
* @summary Stream State
|
|
8465
8467
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8468
|
+
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
8466
8469
|
* @param {string} motionGroup The motion-group identifier.
|
|
8467
8470
|
* @param {number} [responseRate] Update rate for the response message in milliseconds (ms). Default is 200 ms. We recommend to use the step rate of the controller or a multiple of the step rate as NOVA updates the state in the controller\'s step rate as well. Minimal response rate is the step rate of controller.
|
|
8468
8471
|
* @param {string} [responseCoordinateSystem] Unique identifier addressing a coordinate system to which the cartesian data of the responses should be converted. Default is the world coordinate system.
|
|
8469
8472
|
* @param {*} [options] Override http request option.
|
|
8470
8473
|
* @throws {RequiredError}
|
|
8471
8474
|
*/
|
|
8472
|
-
streamMotionGroupState: async (cell: string, motionGroup: string, responseRate?: number, responseCoordinateSystem?: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
8475
|
+
streamMotionGroupState: async (cell: string, controller: string, motionGroup: string, responseRate?: number, responseCoordinateSystem?: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
8473
8476
|
// verify required parameter 'cell' is not null or undefined
|
|
8474
8477
|
assertParamExists('streamMotionGroupState', 'cell', cell)
|
|
8478
|
+
// verify required parameter 'controller' is not null or undefined
|
|
8479
|
+
assertParamExists('streamMotionGroupState', 'controller', controller)
|
|
8475
8480
|
// verify required parameter 'motionGroup' is not null or undefined
|
|
8476
8481
|
assertParamExists('streamMotionGroupState', 'motionGroup', motionGroup)
|
|
8477
|
-
const localVarPath = `/cells/{cell}/motion-groups/{motion-group}/state-stream`
|
|
8482
|
+
const localVarPath = `/cells/{cell}/controllers/{controller}/motion-groups/{motion-group}/state-stream`
|
|
8478
8483
|
.replace(`{${"cell"}}`, encodeURIComponent(String(cell)))
|
|
8484
|
+
.replace(`{${"controller"}}`, encodeURIComponent(String(controller)))
|
|
8479
8485
|
.replace(`{${"motion-group"}}`, encodeURIComponent(String(motionGroup)));
|
|
8480
8486
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
8481
8487
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
@@ -8529,13 +8535,14 @@ export const MotionGroupApiFp = function(configuration?: Configuration) {
|
|
|
8529
8535
|
* Returns the current state of the selected motion group including the current joint position, velocity, pose, and more.
|
|
8530
8536
|
* @summary State
|
|
8531
8537
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8538
|
+
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
8532
8539
|
* @param {string} motionGroup The motion-group identifier.
|
|
8533
8540
|
* @param {string} [responseCoordinateSystem] Unique identifier addressing a coordinate system to which the responses should be converted. If not set, world coordinate system is used.
|
|
8534
8541
|
* @param {*} [options] Override http request option.
|
|
8535
8542
|
* @throws {RequiredError}
|
|
8536
8543
|
*/
|
|
8537
|
-
async getCurrentMotionGroupState(cell: string, motionGroup: string, responseCoordinateSystem?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<MotionGroupState>> {
|
|
8538
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.getCurrentMotionGroupState(cell, motionGroup, responseCoordinateSystem, options);
|
|
8544
|
+
async getCurrentMotionGroupState(cell: string, controller: string, motionGroup: string, responseCoordinateSystem?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<MotionGroupState>> {
|
|
8545
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.getCurrentMotionGroupState(cell, controller, motionGroup, responseCoordinateSystem, options);
|
|
8539
8546
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
8540
8547
|
const localVarOperationServerBasePath = operationServerMap['MotionGroupApi.getCurrentMotionGroupState']?.[localVarOperationServerIndex]?.url;
|
|
8541
8548
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
@@ -8544,12 +8551,13 @@ export const MotionGroupApiFp = function(configuration?: Configuration) {
|
|
|
8544
8551
|
* Get the set of parameters that describe the motion group and its configuration including safety zones, limits, etc. This data might change upon connection to the robot.
|
|
8545
8552
|
* @summary Description
|
|
8546
8553
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8554
|
+
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
8547
8555
|
* @param {string} motionGroup The motion-group identifier.
|
|
8548
8556
|
* @param {*} [options] Override http request option.
|
|
8549
8557
|
* @throws {RequiredError}
|
|
8550
8558
|
*/
|
|
8551
|
-
async getMotionGroupDescription(cell: string, motionGroup: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<MotionGroupDescription>> {
|
|
8552
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.getMotionGroupDescription(cell, motionGroup, options);
|
|
8559
|
+
async getMotionGroupDescription(cell: string, controller: string, motionGroup: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<MotionGroupDescription>> {
|
|
8560
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.getMotionGroupDescription(cell, controller, motionGroup, options);
|
|
8553
8561
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
8554
8562
|
const localVarOperationServerBasePath = operationServerMap['MotionGroupApi.getMotionGroupDescription']?.[localVarOperationServerIndex]?.url;
|
|
8555
8563
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
@@ -8558,14 +8566,15 @@ export const MotionGroupApiFp = function(configuration?: Configuration) {
|
|
|
8558
8566
|
* <!-- theme: danger --> > Websocket endpoint Receive updates of the motion group state. The stream will be closed from the server if the controller is disconnected.
|
|
8559
8567
|
* @summary Stream State
|
|
8560
8568
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8569
|
+
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
8561
8570
|
* @param {string} motionGroup The motion-group identifier.
|
|
8562
8571
|
* @param {number} [responseRate] Update rate for the response message in milliseconds (ms). Default is 200 ms. We recommend to use the step rate of the controller or a multiple of the step rate as NOVA updates the state in the controller\'s step rate as well. Minimal response rate is the step rate of controller.
|
|
8563
8572
|
* @param {string} [responseCoordinateSystem] Unique identifier addressing a coordinate system to which the cartesian data of the responses should be converted. Default is the world coordinate system.
|
|
8564
8573
|
* @param {*} [options] Override http request option.
|
|
8565
8574
|
* @throws {RequiredError}
|
|
8566
8575
|
*/
|
|
8567
|
-
async streamMotionGroupState(cell: string, motionGroup: string, responseRate?: number, responseCoordinateSystem?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<MotionGroupState>> {
|
|
8568
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.streamMotionGroupState(cell, motionGroup, responseRate, responseCoordinateSystem, options);
|
|
8576
|
+
async streamMotionGroupState(cell: string, controller: string, motionGroup: string, responseRate?: number, responseCoordinateSystem?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<MotionGroupState>> {
|
|
8577
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.streamMotionGroupState(cell, controller, motionGroup, responseRate, responseCoordinateSystem, options);
|
|
8569
8578
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
8570
8579
|
const localVarOperationServerBasePath = operationServerMap['MotionGroupApi.streamMotionGroupState']?.[localVarOperationServerIndex]?.url;
|
|
8571
8580
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
@@ -8584,37 +8593,40 @@ export const MotionGroupApiFactory = function (configuration?: Configuration, ba
|
|
|
8584
8593
|
* Returns the current state of the selected motion group including the current joint position, velocity, pose, and more.
|
|
8585
8594
|
* @summary State
|
|
8586
8595
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8596
|
+
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
8587
8597
|
* @param {string} motionGroup The motion-group identifier.
|
|
8588
8598
|
* @param {string} [responseCoordinateSystem] Unique identifier addressing a coordinate system to which the responses should be converted. If not set, world coordinate system is used.
|
|
8589
8599
|
* @param {*} [options] Override http request option.
|
|
8590
8600
|
* @throws {RequiredError}
|
|
8591
8601
|
*/
|
|
8592
|
-
getCurrentMotionGroupState(cell: string, motionGroup: string, responseCoordinateSystem?: string, options?: RawAxiosRequestConfig): AxiosPromise<MotionGroupState> {
|
|
8593
|
-
return localVarFp.getCurrentMotionGroupState(cell, motionGroup, responseCoordinateSystem, options).then((request) => request(axios, basePath));
|
|
8602
|
+
getCurrentMotionGroupState(cell: string, controller: string, motionGroup: string, responseCoordinateSystem?: string, options?: RawAxiosRequestConfig): AxiosPromise<MotionGroupState> {
|
|
8603
|
+
return localVarFp.getCurrentMotionGroupState(cell, controller, motionGroup, responseCoordinateSystem, options).then((request) => request(axios, basePath));
|
|
8594
8604
|
},
|
|
8595
8605
|
/**
|
|
8596
8606
|
* Get the set of parameters that describe the motion group and its configuration including safety zones, limits, etc. This data might change upon connection to the robot.
|
|
8597
8607
|
* @summary Description
|
|
8598
8608
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8609
|
+
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
8599
8610
|
* @param {string} motionGroup The motion-group identifier.
|
|
8600
8611
|
* @param {*} [options] Override http request option.
|
|
8601
8612
|
* @throws {RequiredError}
|
|
8602
8613
|
*/
|
|
8603
|
-
getMotionGroupDescription(cell: string, motionGroup: string, options?: RawAxiosRequestConfig): AxiosPromise<MotionGroupDescription> {
|
|
8604
|
-
return localVarFp.getMotionGroupDescription(cell, motionGroup, options).then((request) => request(axios, basePath));
|
|
8614
|
+
getMotionGroupDescription(cell: string, controller: string, motionGroup: string, options?: RawAxiosRequestConfig): AxiosPromise<MotionGroupDescription> {
|
|
8615
|
+
return localVarFp.getMotionGroupDescription(cell, controller, motionGroup, options).then((request) => request(axios, basePath));
|
|
8605
8616
|
},
|
|
8606
8617
|
/**
|
|
8607
8618
|
* <!-- theme: danger --> > Websocket endpoint Receive updates of the motion group state. The stream will be closed from the server if the controller is disconnected.
|
|
8608
8619
|
* @summary Stream State
|
|
8609
8620
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8621
|
+
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
8610
8622
|
* @param {string} motionGroup The motion-group identifier.
|
|
8611
8623
|
* @param {number} [responseRate] Update rate for the response message in milliseconds (ms). Default is 200 ms. We recommend to use the step rate of the controller or a multiple of the step rate as NOVA updates the state in the controller\'s step rate as well. Minimal response rate is the step rate of controller.
|
|
8612
8624
|
* @param {string} [responseCoordinateSystem] Unique identifier addressing a coordinate system to which the cartesian data of the responses should be converted. Default is the world coordinate system.
|
|
8613
8625
|
* @param {*} [options] Override http request option.
|
|
8614
8626
|
* @throws {RequiredError}
|
|
8615
8627
|
*/
|
|
8616
|
-
streamMotionGroupState(cell: string, motionGroup: string, responseRate?: number, responseCoordinateSystem?: string, options?: RawAxiosRequestConfig): AxiosPromise<MotionGroupState> {
|
|
8617
|
-
return localVarFp.streamMotionGroupState(cell, motionGroup, responseRate, responseCoordinateSystem, options).then((request) => request(axios, basePath));
|
|
8628
|
+
streamMotionGroupState(cell: string, controller: string, motionGroup: string, responseRate?: number, responseCoordinateSystem?: string, options?: RawAxiosRequestConfig): AxiosPromise<MotionGroupState> {
|
|
8629
|
+
return localVarFp.streamMotionGroupState(cell, controller, motionGroup, responseRate, responseCoordinateSystem, options).then((request) => request(axios, basePath));
|
|
8618
8630
|
},
|
|
8619
8631
|
};
|
|
8620
8632
|
};
|
|
@@ -8630,33 +8642,36 @@ export class MotionGroupApi extends BaseAPI {
|
|
|
8630
8642
|
* Returns the current state of the selected motion group including the current joint position, velocity, pose, and more.
|
|
8631
8643
|
* @summary State
|
|
8632
8644
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8645
|
+
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
8633
8646
|
* @param {string} motionGroup The motion-group identifier.
|
|
8634
8647
|
* @param {string} [responseCoordinateSystem] Unique identifier addressing a coordinate system to which the responses should be converted. If not set, world coordinate system is used.
|
|
8635
8648
|
* @param {*} [options] Override http request option.
|
|
8636
8649
|
* @throws {RequiredError}
|
|
8637
8650
|
* @memberof MotionGroupApi
|
|
8638
8651
|
*/
|
|
8639
|
-
public getCurrentMotionGroupState(cell: string, motionGroup: string, responseCoordinateSystem?: string, options?: RawAxiosRequestConfig) {
|
|
8640
|
-
return MotionGroupApiFp(this.configuration).getCurrentMotionGroupState(cell, motionGroup, responseCoordinateSystem, options).then((request) => request(this.axios, this.basePath));
|
|
8652
|
+
public getCurrentMotionGroupState(cell: string, controller: string, motionGroup: string, responseCoordinateSystem?: string, options?: RawAxiosRequestConfig) {
|
|
8653
|
+
return MotionGroupApiFp(this.configuration).getCurrentMotionGroupState(cell, controller, motionGroup, responseCoordinateSystem, options).then((request) => request(this.axios, this.basePath));
|
|
8641
8654
|
}
|
|
8642
8655
|
|
|
8643
8656
|
/**
|
|
8644
8657
|
* Get the set of parameters that describe the motion group and its configuration including safety zones, limits, etc. This data might change upon connection to the robot.
|
|
8645
8658
|
* @summary Description
|
|
8646
8659
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8660
|
+
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
8647
8661
|
* @param {string} motionGroup The motion-group identifier.
|
|
8648
8662
|
* @param {*} [options] Override http request option.
|
|
8649
8663
|
* @throws {RequiredError}
|
|
8650
8664
|
* @memberof MotionGroupApi
|
|
8651
8665
|
*/
|
|
8652
|
-
public getMotionGroupDescription(cell: string, motionGroup: string, options?: RawAxiosRequestConfig) {
|
|
8653
|
-
return MotionGroupApiFp(this.configuration).getMotionGroupDescription(cell, motionGroup, options).then((request) => request(this.axios, this.basePath));
|
|
8666
|
+
public getMotionGroupDescription(cell: string, controller: string, motionGroup: string, options?: RawAxiosRequestConfig) {
|
|
8667
|
+
return MotionGroupApiFp(this.configuration).getMotionGroupDescription(cell, controller, motionGroup, options).then((request) => request(this.axios, this.basePath));
|
|
8654
8668
|
}
|
|
8655
8669
|
|
|
8656
8670
|
/**
|
|
8657
8671
|
* <!-- theme: danger --> > Websocket endpoint Receive updates of the motion group state. The stream will be closed from the server if the controller is disconnected.
|
|
8658
8672
|
* @summary Stream State
|
|
8659
8673
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8674
|
+
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
8660
8675
|
* @param {string} motionGroup The motion-group identifier.
|
|
8661
8676
|
* @param {number} [responseRate] Update rate for the response message in milliseconds (ms). Default is 200 ms. We recommend to use the step rate of the controller or a multiple of the step rate as NOVA updates the state in the controller\'s step rate as well. Minimal response rate is the step rate of controller.
|
|
8662
8677
|
* @param {string} [responseCoordinateSystem] Unique identifier addressing a coordinate system to which the cartesian data of the responses should be converted. Default is the world coordinate system.
|
|
@@ -8664,8 +8679,8 @@ export class MotionGroupApi extends BaseAPI {
|
|
|
8664
8679
|
* @throws {RequiredError}
|
|
8665
8680
|
* @memberof MotionGroupApi
|
|
8666
8681
|
*/
|
|
8667
|
-
public streamMotionGroupState(cell: string, motionGroup: string, responseRate?: number, responseCoordinateSystem?: string, options?: RawAxiosRequestConfig) {
|
|
8668
|
-
return MotionGroupApiFp(this.configuration).streamMotionGroupState(cell, motionGroup, responseRate, responseCoordinateSystem, options).then((request) => request(this.axios, this.basePath));
|
|
8682
|
+
public streamMotionGroupState(cell: string, controller: string, motionGroup: string, responseRate?: number, responseCoordinateSystem?: string, options?: RawAxiosRequestConfig) {
|
|
8683
|
+
return MotionGroupApiFp(this.configuration).streamMotionGroupState(cell, controller, motionGroup, responseRate, responseCoordinateSystem, options).then((request) => request(this.axios, this.basePath));
|
|
8669
8684
|
}
|
|
8670
8685
|
}
|
|
8671
8686
|
|
|
@@ -11596,17 +11611,21 @@ export const TrajectoryCachingApiAxiosParamCreator = function (configuration?: C
|
|
|
11596
11611
|
* <!-- theme: info --> > Using the trajectory cache is an optional performance optimization. It is not necessary to use the cache to execute trajectories. Loads and validates the data of a trajectory into the execution cache, rendering the trajectory executable. The response contains the result of the validation of the trajectory. Validation can lead to three different results: - Fully valid: The whole trajectory can be executed from start to end. The response will contain an unique identifier which is used to move the robot. - Partially valid: Only parts of the trajectory can be executed. The response will contain an unique identifier to move the robot and information about the failure for the part that is not executable. - Invalid: The trajectory can not be executed. The response will tell you the reason of failure. If the trajectory is at least partially valid, the parts of the trajectory that are valid can be executed using the [executeTrajectory](executeTrajectory) endpoint. The workflow is as follows: - Generate a trajectory with [planTrajectory](planTrajectory) or your own motion planner, - Send the trajectory to this endpoint to validate it and get a unique identifier for it, - The unique identifier will appear in the list of available trajectories, see [listTrajectories](listTrajectories) endpoint, if it is at least partially executable. - Execute your trajectory using the [executeTrajectory](executeTrajectory) endpoint.
|
|
11597
11612
|
* @summary Add Trajectory
|
|
11598
11613
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
11614
|
+
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
11599
11615
|
* @param {AddTrajectoryRequest} addTrajectoryRequest
|
|
11600
11616
|
* @param {*} [options] Override http request option.
|
|
11601
11617
|
* @throws {RequiredError}
|
|
11602
11618
|
*/
|
|
11603
|
-
addTrajectory: async (cell: string, addTrajectoryRequest: AddTrajectoryRequest, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
11619
|
+
addTrajectory: async (cell: string, controller: string, addTrajectoryRequest: AddTrajectoryRequest, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
11604
11620
|
// verify required parameter 'cell' is not null or undefined
|
|
11605
11621
|
assertParamExists('addTrajectory', 'cell', cell)
|
|
11622
|
+
// verify required parameter 'controller' is not null or undefined
|
|
11623
|
+
assertParamExists('addTrajectory', 'controller', controller)
|
|
11606
11624
|
// verify required parameter 'addTrajectoryRequest' is not null or undefined
|
|
11607
11625
|
assertParamExists('addTrajectory', 'addTrajectoryRequest', addTrajectoryRequest)
|
|
11608
|
-
const localVarPath = `/cells/{cell}/trajectories`
|
|
11609
|
-
.replace(`{${"cell"}}`, encodeURIComponent(String(cell)))
|
|
11626
|
+
const localVarPath = `/cells/{cell}/controllers/{controller}/trajectories`
|
|
11627
|
+
.replace(`{${"cell"}}`, encodeURIComponent(String(cell)))
|
|
11628
|
+
.replace(`{${"controller"}}`, encodeURIComponent(String(controller)));
|
|
11610
11629
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
11611
11630
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
11612
11631
|
let baseOptions;
|
|
@@ -11644,14 +11663,18 @@ export const TrajectoryCachingApiAxiosParamCreator = function (configuration?: C
|
|
|
11644
11663
|
* Clear the trajectory cache.
|
|
11645
11664
|
* @summary Clear Trajectories
|
|
11646
11665
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
11666
|
+
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
11647
11667
|
* @param {*} [options] Override http request option.
|
|
11648
11668
|
* @throws {RequiredError}
|
|
11649
11669
|
*/
|
|
11650
|
-
clearTrajectories: async (cell: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
11670
|
+
clearTrajectories: async (cell: string, controller: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
11651
11671
|
// verify required parameter 'cell' is not null or undefined
|
|
11652
11672
|
assertParamExists('clearTrajectories', 'cell', cell)
|
|
11653
|
-
|
|
11654
|
-
|
|
11673
|
+
// verify required parameter 'controller' is not null or undefined
|
|
11674
|
+
assertParamExists('clearTrajectories', 'controller', controller)
|
|
11675
|
+
const localVarPath = `/cells/{cell}/controllers/{controller}/trajectories`
|
|
11676
|
+
.replace(`{${"cell"}}`, encodeURIComponent(String(cell)))
|
|
11677
|
+
.replace(`{${"controller"}}`, encodeURIComponent(String(controller)));
|
|
11655
11678
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
11656
11679
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
11657
11680
|
let baseOptions;
|
|
@@ -11686,17 +11709,21 @@ export const TrajectoryCachingApiAxiosParamCreator = function (configuration?: C
|
|
|
11686
11709
|
* Delete a previously created trajectory from cache. Use [listTrajectories](listTrajectories) to list all cached trajectories. Trajectories are removed automatically if the motion group or the corresponding controller is disconnected.
|
|
11687
11710
|
* @summary Delete Trajectory
|
|
11688
11711
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
11712
|
+
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
11689
11713
|
* @param {string} trajectory This represents the unique identifier of a trajectory. Every executable or partially executable trajectory is cached and an unique identifier is returned. Indicate the unique identifier to execute the trajectory or retrieve information on the trajectory.
|
|
11690
11714
|
* @param {*} [options] Override http request option.
|
|
11691
11715
|
* @throws {RequiredError}
|
|
11692
11716
|
*/
|
|
11693
|
-
deleteTrajectory: async (cell: string, trajectory: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
11717
|
+
deleteTrajectory: async (cell: string, controller: string, trajectory: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
11694
11718
|
// verify required parameter 'cell' is not null or undefined
|
|
11695
11719
|
assertParamExists('deleteTrajectory', 'cell', cell)
|
|
11720
|
+
// verify required parameter 'controller' is not null or undefined
|
|
11721
|
+
assertParamExists('deleteTrajectory', 'controller', controller)
|
|
11696
11722
|
// verify required parameter 'trajectory' is not null or undefined
|
|
11697
11723
|
assertParamExists('deleteTrajectory', 'trajectory', trajectory)
|
|
11698
|
-
const localVarPath = `/cells/{cell}/trajectories/{trajectory}`
|
|
11724
|
+
const localVarPath = `/cells/{cell}/controllers/{controller}/trajectories/{trajectory}`
|
|
11699
11725
|
.replace(`{${"cell"}}`, encodeURIComponent(String(cell)))
|
|
11726
|
+
.replace(`{${"controller"}}`, encodeURIComponent(String(controller)))
|
|
11700
11727
|
.replace(`{${"trajectory"}}`, encodeURIComponent(String(trajectory)));
|
|
11701
11728
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
11702
11729
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
@@ -11732,17 +11759,21 @@ export const TrajectoryCachingApiAxiosParamCreator = function (configuration?: C
|
|
|
11732
11759
|
* Get a previously created trajectory from cache. Use [listTrajectories](listTrajectories) to list all cached trajectories.
|
|
11733
11760
|
* @summary Get Trajectory
|
|
11734
11761
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
11762
|
+
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
11735
11763
|
* @param {string} trajectory This represents the unique identifier of a trajectory. Every executable or partially executable trajectory is cached and an unique identifier is returned. Indicate the unique identifier to execute the trajectory or retrieve information on the trajectory.
|
|
11736
11764
|
* @param {*} [options] Override http request option.
|
|
11737
11765
|
* @throws {RequiredError}
|
|
11738
11766
|
*/
|
|
11739
|
-
getTrajectory: async (cell: string, trajectory: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
11767
|
+
getTrajectory: async (cell: string, controller: string, trajectory: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
11740
11768
|
// verify required parameter 'cell' is not null or undefined
|
|
11741
11769
|
assertParamExists('getTrajectory', 'cell', cell)
|
|
11770
|
+
// verify required parameter 'controller' is not null or undefined
|
|
11771
|
+
assertParamExists('getTrajectory', 'controller', controller)
|
|
11742
11772
|
// verify required parameter 'trajectory' is not null or undefined
|
|
11743
11773
|
assertParamExists('getTrajectory', 'trajectory', trajectory)
|
|
11744
|
-
const localVarPath = `/cells/{cell}/trajectories/{trajectory}`
|
|
11774
|
+
const localVarPath = `/cells/{cell}/controllers/{controller}/trajectories/{trajectory}`
|
|
11745
11775
|
.replace(`{${"cell"}}`, encodeURIComponent(String(cell)))
|
|
11776
|
+
.replace(`{${"controller"}}`, encodeURIComponent(String(controller)))
|
|
11746
11777
|
.replace(`{${"trajectory"}}`, encodeURIComponent(String(trajectory)));
|
|
11747
11778
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
11748
11779
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
@@ -11778,14 +11809,18 @@ export const TrajectoryCachingApiAxiosParamCreator = function (configuration?: C
|
|
|
11778
11809
|
* List currently cached trajectories. Use [addTrajectory](addTrajectory) to add a new trajectory. Adding trajectories is necessary to execute them. Trajectories are removed if the corresponding motion group or controller disconnects.
|
|
11779
11810
|
* @summary List Trajectories
|
|
11780
11811
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
11812
|
+
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
11781
11813
|
* @param {*} [options] Override http request option.
|
|
11782
11814
|
* @throws {RequiredError}
|
|
11783
11815
|
*/
|
|
11784
|
-
listTrajectories: async (cell: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
11816
|
+
listTrajectories: async (cell: string, controller: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
11785
11817
|
// verify required parameter 'cell' is not null or undefined
|
|
11786
11818
|
assertParamExists('listTrajectories', 'cell', cell)
|
|
11787
|
-
|
|
11788
|
-
|
|
11819
|
+
// verify required parameter 'controller' is not null or undefined
|
|
11820
|
+
assertParamExists('listTrajectories', 'controller', controller)
|
|
11821
|
+
const localVarPath = `/cells/{cell}/controllers/{controller}/trajectories`
|
|
11822
|
+
.replace(`{${"cell"}}`, encodeURIComponent(String(cell)))
|
|
11823
|
+
.replace(`{${"controller"}}`, encodeURIComponent(String(controller)));
|
|
11789
11824
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
11790
11825
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
11791
11826
|
let baseOptions;
|
|
@@ -11830,12 +11865,13 @@ export const TrajectoryCachingApiFp = function(configuration?: Configuration) {
|
|
|
11830
11865
|
* <!-- theme: info --> > Using the trajectory cache is an optional performance optimization. It is not necessary to use the cache to execute trajectories. Loads and validates the data of a trajectory into the execution cache, rendering the trajectory executable. The response contains the result of the validation of the trajectory. Validation can lead to three different results: - Fully valid: The whole trajectory can be executed from start to end. The response will contain an unique identifier which is used to move the robot. - Partially valid: Only parts of the trajectory can be executed. The response will contain an unique identifier to move the robot and information about the failure for the part that is not executable. - Invalid: The trajectory can not be executed. The response will tell you the reason of failure. If the trajectory is at least partially valid, the parts of the trajectory that are valid can be executed using the [executeTrajectory](executeTrajectory) endpoint. The workflow is as follows: - Generate a trajectory with [planTrajectory](planTrajectory) or your own motion planner, - Send the trajectory to this endpoint to validate it and get a unique identifier for it, - The unique identifier will appear in the list of available trajectories, see [listTrajectories](listTrajectories) endpoint, if it is at least partially executable. - Execute your trajectory using the [executeTrajectory](executeTrajectory) endpoint.
|
|
11831
11866
|
* @summary Add Trajectory
|
|
11832
11867
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
11868
|
+
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
11833
11869
|
* @param {AddTrajectoryRequest} addTrajectoryRequest
|
|
11834
11870
|
* @param {*} [options] Override http request option.
|
|
11835
11871
|
* @throws {RequiredError}
|
|
11836
11872
|
*/
|
|
11837
|
-
async addTrajectory(cell: string, addTrajectoryRequest: AddTrajectoryRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AddTrajectoryResponse>> {
|
|
11838
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.addTrajectory(cell, addTrajectoryRequest, options);
|
|
11873
|
+
async addTrajectory(cell: string, controller: string, addTrajectoryRequest: AddTrajectoryRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AddTrajectoryResponse>> {
|
|
11874
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.addTrajectory(cell, controller, addTrajectoryRequest, options);
|
|
11839
11875
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
11840
11876
|
const localVarOperationServerBasePath = operationServerMap['TrajectoryCachingApi.addTrajectory']?.[localVarOperationServerIndex]?.url;
|
|
11841
11877
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
@@ -11844,11 +11880,12 @@ export const TrajectoryCachingApiFp = function(configuration?: Configuration) {
|
|
|
11844
11880
|
* Clear the trajectory cache.
|
|
11845
11881
|
* @summary Clear Trajectories
|
|
11846
11882
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
11883
|
+
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
11847
11884
|
* @param {*} [options] Override http request option.
|
|
11848
11885
|
* @throws {RequiredError}
|
|
11849
11886
|
*/
|
|
11850
|
-
async clearTrajectories(cell: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> {
|
|
11851
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.clearTrajectories(cell, options);
|
|
11887
|
+
async clearTrajectories(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> {
|
|
11888
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.clearTrajectories(cell, controller, options);
|
|
11852
11889
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
11853
11890
|
const localVarOperationServerBasePath = operationServerMap['TrajectoryCachingApi.clearTrajectories']?.[localVarOperationServerIndex]?.url;
|
|
11854
11891
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
@@ -11857,12 +11894,13 @@ export const TrajectoryCachingApiFp = function(configuration?: Configuration) {
|
|
|
11857
11894
|
* Delete a previously created trajectory from cache. Use [listTrajectories](listTrajectories) to list all cached trajectories. Trajectories are removed automatically if the motion group or the corresponding controller is disconnected.
|
|
11858
11895
|
* @summary Delete Trajectory
|
|
11859
11896
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
11897
|
+
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
11860
11898
|
* @param {string} trajectory This represents the unique identifier of a trajectory. Every executable or partially executable trajectory is cached and an unique identifier is returned. Indicate the unique identifier to execute the trajectory or retrieve information on the trajectory.
|
|
11861
11899
|
* @param {*} [options] Override http request option.
|
|
11862
11900
|
* @throws {RequiredError}
|
|
11863
11901
|
*/
|
|
11864
|
-
async deleteTrajectory(cell: string, trajectory: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> {
|
|
11865
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.deleteTrajectory(cell, trajectory, options);
|
|
11902
|
+
async deleteTrajectory(cell: string, controller: string, trajectory: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> {
|
|
11903
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.deleteTrajectory(cell, controller, trajectory, options);
|
|
11866
11904
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
11867
11905
|
const localVarOperationServerBasePath = operationServerMap['TrajectoryCachingApi.deleteTrajectory']?.[localVarOperationServerIndex]?.url;
|
|
11868
11906
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
@@ -11871,12 +11909,13 @@ export const TrajectoryCachingApiFp = function(configuration?: Configuration) {
|
|
|
11871
11909
|
* Get a previously created trajectory from cache. Use [listTrajectories](listTrajectories) to list all cached trajectories.
|
|
11872
11910
|
* @summary Get Trajectory
|
|
11873
11911
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
11912
|
+
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
11874
11913
|
* @param {string} trajectory This represents the unique identifier of a trajectory. Every executable or partially executable trajectory is cached and an unique identifier is returned. Indicate the unique identifier to execute the trajectory or retrieve information on the trajectory.
|
|
11875
11914
|
* @param {*} [options] Override http request option.
|
|
11876
11915
|
* @throws {RequiredError}
|
|
11877
11916
|
*/
|
|
11878
|
-
async getTrajectory(cell: string, trajectory: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetTrajectoryResponse>> {
|
|
11879
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.getTrajectory(cell, trajectory, options);
|
|
11917
|
+
async getTrajectory(cell: string, controller: string, trajectory: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetTrajectoryResponse>> {
|
|
11918
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.getTrajectory(cell, controller, trajectory, options);
|
|
11880
11919
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
11881
11920
|
const localVarOperationServerBasePath = operationServerMap['TrajectoryCachingApi.getTrajectory']?.[localVarOperationServerIndex]?.url;
|
|
11882
11921
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
@@ -11885,11 +11924,12 @@ export const TrajectoryCachingApiFp = function(configuration?: Configuration) {
|
|
|
11885
11924
|
* List currently cached trajectories. Use [addTrajectory](addTrajectory) to add a new trajectory. Adding trajectories is necessary to execute them. Trajectories are removed if the corresponding motion group or controller disconnects.
|
|
11886
11925
|
* @summary List Trajectories
|
|
11887
11926
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
11927
|
+
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
11888
11928
|
* @param {*} [options] Override http request option.
|
|
11889
11929
|
* @throws {RequiredError}
|
|
11890
11930
|
*/
|
|
11891
|
-
async listTrajectories(cell: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListTrajectoriesResponse>> {
|
|
11892
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.listTrajectories(cell, options);
|
|
11931
|
+
async listTrajectories(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListTrajectoriesResponse>> {
|
|
11932
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.listTrajectories(cell, controller, options);
|
|
11893
11933
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
11894
11934
|
const localVarOperationServerBasePath = operationServerMap['TrajectoryCachingApi.listTrajectories']?.[localVarOperationServerIndex]?.url;
|
|
11895
11935
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
@@ -11908,54 +11948,59 @@ export const TrajectoryCachingApiFactory = function (configuration?: Configurati
|
|
|
11908
11948
|
* <!-- theme: info --> > Using the trajectory cache is an optional performance optimization. It is not necessary to use the cache to execute trajectories. Loads and validates the data of a trajectory into the execution cache, rendering the trajectory executable. The response contains the result of the validation of the trajectory. Validation can lead to three different results: - Fully valid: The whole trajectory can be executed from start to end. The response will contain an unique identifier which is used to move the robot. - Partially valid: Only parts of the trajectory can be executed. The response will contain an unique identifier to move the robot and information about the failure for the part that is not executable. - Invalid: The trajectory can not be executed. The response will tell you the reason of failure. If the trajectory is at least partially valid, the parts of the trajectory that are valid can be executed using the [executeTrajectory](executeTrajectory) endpoint. The workflow is as follows: - Generate a trajectory with [planTrajectory](planTrajectory) or your own motion planner, - Send the trajectory to this endpoint to validate it and get a unique identifier for it, - The unique identifier will appear in the list of available trajectories, see [listTrajectories](listTrajectories) endpoint, if it is at least partially executable. - Execute your trajectory using the [executeTrajectory](executeTrajectory) endpoint.
|
|
11909
11949
|
* @summary Add Trajectory
|
|
11910
11950
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
11951
|
+
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
11911
11952
|
* @param {AddTrajectoryRequest} addTrajectoryRequest
|
|
11912
11953
|
* @param {*} [options] Override http request option.
|
|
11913
11954
|
* @throws {RequiredError}
|
|
11914
11955
|
*/
|
|
11915
|
-
addTrajectory(cell: string, addTrajectoryRequest: AddTrajectoryRequest, options?: RawAxiosRequestConfig): AxiosPromise<AddTrajectoryResponse> {
|
|
11916
|
-
return localVarFp.addTrajectory(cell, addTrajectoryRequest, options).then((request) => request(axios, basePath));
|
|
11956
|
+
addTrajectory(cell: string, controller: string, addTrajectoryRequest: AddTrajectoryRequest, options?: RawAxiosRequestConfig): AxiosPromise<AddTrajectoryResponse> {
|
|
11957
|
+
return localVarFp.addTrajectory(cell, controller, addTrajectoryRequest, options).then((request) => request(axios, basePath));
|
|
11917
11958
|
},
|
|
11918
11959
|
/**
|
|
11919
11960
|
* Clear the trajectory cache.
|
|
11920
11961
|
* @summary Clear Trajectories
|
|
11921
11962
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
11963
|
+
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
11922
11964
|
* @param {*} [options] Override http request option.
|
|
11923
11965
|
* @throws {RequiredError}
|
|
11924
11966
|
*/
|
|
11925
|
-
clearTrajectories(cell: string, options?: RawAxiosRequestConfig): AxiosPromise<void> {
|
|
11926
|
-
return localVarFp.clearTrajectories(cell, options).then((request) => request(axios, basePath));
|
|
11967
|
+
clearTrajectories(cell: string, controller: string, options?: RawAxiosRequestConfig): AxiosPromise<void> {
|
|
11968
|
+
return localVarFp.clearTrajectories(cell, controller, options).then((request) => request(axios, basePath));
|
|
11927
11969
|
},
|
|
11928
11970
|
/**
|
|
11929
11971
|
* Delete a previously created trajectory from cache. Use [listTrajectories](listTrajectories) to list all cached trajectories. Trajectories are removed automatically if the motion group or the corresponding controller is disconnected.
|
|
11930
11972
|
* @summary Delete Trajectory
|
|
11931
11973
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
11974
|
+
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
11932
11975
|
* @param {string} trajectory This represents the unique identifier of a trajectory. Every executable or partially executable trajectory is cached and an unique identifier is returned. Indicate the unique identifier to execute the trajectory or retrieve information on the trajectory.
|
|
11933
11976
|
* @param {*} [options] Override http request option.
|
|
11934
11977
|
* @throws {RequiredError}
|
|
11935
11978
|
*/
|
|
11936
|
-
deleteTrajectory(cell: string, trajectory: string, options?: RawAxiosRequestConfig): AxiosPromise<void> {
|
|
11937
|
-
return localVarFp.deleteTrajectory(cell, trajectory, options).then((request) => request(axios, basePath));
|
|
11979
|
+
deleteTrajectory(cell: string, controller: string, trajectory: string, options?: RawAxiosRequestConfig): AxiosPromise<void> {
|
|
11980
|
+
return localVarFp.deleteTrajectory(cell, controller, trajectory, options).then((request) => request(axios, basePath));
|
|
11938
11981
|
},
|
|
11939
11982
|
/**
|
|
11940
11983
|
* Get a previously created trajectory from cache. Use [listTrajectories](listTrajectories) to list all cached trajectories.
|
|
11941
11984
|
* @summary Get Trajectory
|
|
11942
11985
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
11986
|
+
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
11943
11987
|
* @param {string} trajectory This represents the unique identifier of a trajectory. Every executable or partially executable trajectory is cached and an unique identifier is returned. Indicate the unique identifier to execute the trajectory or retrieve information on the trajectory.
|
|
11944
11988
|
* @param {*} [options] Override http request option.
|
|
11945
11989
|
* @throws {RequiredError}
|
|
11946
11990
|
*/
|
|
11947
|
-
getTrajectory(cell: string, trajectory: string, options?: RawAxiosRequestConfig): AxiosPromise<GetTrajectoryResponse> {
|
|
11948
|
-
return localVarFp.getTrajectory(cell, trajectory, options).then((request) => request(axios, basePath));
|
|
11991
|
+
getTrajectory(cell: string, controller: string, trajectory: string, options?: RawAxiosRequestConfig): AxiosPromise<GetTrajectoryResponse> {
|
|
11992
|
+
return localVarFp.getTrajectory(cell, controller, trajectory, options).then((request) => request(axios, basePath));
|
|
11949
11993
|
},
|
|
11950
11994
|
/**
|
|
11951
11995
|
* List currently cached trajectories. Use [addTrajectory](addTrajectory) to add a new trajectory. Adding trajectories is necessary to execute them. Trajectories are removed if the corresponding motion group or controller disconnects.
|
|
11952
11996
|
* @summary List Trajectories
|
|
11953
11997
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
11998
|
+
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
11954
11999
|
* @param {*} [options] Override http request option.
|
|
11955
12000
|
* @throws {RequiredError}
|
|
11956
12001
|
*/
|
|
11957
|
-
listTrajectories(cell: string, options?: RawAxiosRequestConfig): AxiosPromise<ListTrajectoriesResponse> {
|
|
11958
|
-
return localVarFp.listTrajectories(cell, options).then((request) => request(axios, basePath));
|
|
12002
|
+
listTrajectories(cell: string, controller: string, options?: RawAxiosRequestConfig): AxiosPromise<ListTrajectoriesResponse> {
|
|
12003
|
+
return localVarFp.listTrajectories(cell, controller, options).then((request) => request(axios, basePath));
|
|
11959
12004
|
},
|
|
11960
12005
|
};
|
|
11961
12006
|
};
|
|
@@ -11971,63 +12016,68 @@ export class TrajectoryCachingApi extends BaseAPI {
|
|
|
11971
12016
|
* <!-- theme: info --> > Using the trajectory cache is an optional performance optimization. It is not necessary to use the cache to execute trajectories. Loads and validates the data of a trajectory into the execution cache, rendering the trajectory executable. The response contains the result of the validation of the trajectory. Validation can lead to three different results: - Fully valid: The whole trajectory can be executed from start to end. The response will contain an unique identifier which is used to move the robot. - Partially valid: Only parts of the trajectory can be executed. The response will contain an unique identifier to move the robot and information about the failure for the part that is not executable. - Invalid: The trajectory can not be executed. The response will tell you the reason of failure. If the trajectory is at least partially valid, the parts of the trajectory that are valid can be executed using the [executeTrajectory](executeTrajectory) endpoint. The workflow is as follows: - Generate a trajectory with [planTrajectory](planTrajectory) or your own motion planner, - Send the trajectory to this endpoint to validate it and get a unique identifier for it, - The unique identifier will appear in the list of available trajectories, see [listTrajectories](listTrajectories) endpoint, if it is at least partially executable. - Execute your trajectory using the [executeTrajectory](executeTrajectory) endpoint.
|
|
11972
12017
|
* @summary Add Trajectory
|
|
11973
12018
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
12019
|
+
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
11974
12020
|
* @param {AddTrajectoryRequest} addTrajectoryRequest
|
|
11975
12021
|
* @param {*} [options] Override http request option.
|
|
11976
12022
|
* @throws {RequiredError}
|
|
11977
12023
|
* @memberof TrajectoryCachingApi
|
|
11978
12024
|
*/
|
|
11979
|
-
public addTrajectory(cell: string, addTrajectoryRequest: AddTrajectoryRequest, options?: RawAxiosRequestConfig) {
|
|
11980
|
-
return TrajectoryCachingApiFp(this.configuration).addTrajectory(cell, addTrajectoryRequest, options).then((request) => request(this.axios, this.basePath));
|
|
12025
|
+
public addTrajectory(cell: string, controller: string, addTrajectoryRequest: AddTrajectoryRequest, options?: RawAxiosRequestConfig) {
|
|
12026
|
+
return TrajectoryCachingApiFp(this.configuration).addTrajectory(cell, controller, addTrajectoryRequest, options).then((request) => request(this.axios, this.basePath));
|
|
11981
12027
|
}
|
|
11982
12028
|
|
|
11983
12029
|
/**
|
|
11984
12030
|
* Clear the trajectory cache.
|
|
11985
12031
|
* @summary Clear Trajectories
|
|
11986
12032
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
12033
|
+
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
11987
12034
|
* @param {*} [options] Override http request option.
|
|
11988
12035
|
* @throws {RequiredError}
|
|
11989
12036
|
* @memberof TrajectoryCachingApi
|
|
11990
12037
|
*/
|
|
11991
|
-
public clearTrajectories(cell: string, options?: RawAxiosRequestConfig) {
|
|
11992
|
-
return TrajectoryCachingApiFp(this.configuration).clearTrajectories(cell, options).then((request) => request(this.axios, this.basePath));
|
|
12038
|
+
public clearTrajectories(cell: string, controller: string, options?: RawAxiosRequestConfig) {
|
|
12039
|
+
return TrajectoryCachingApiFp(this.configuration).clearTrajectories(cell, controller, options).then((request) => request(this.axios, this.basePath));
|
|
11993
12040
|
}
|
|
11994
12041
|
|
|
11995
12042
|
/**
|
|
11996
12043
|
* Delete a previously created trajectory from cache. Use [listTrajectories](listTrajectories) to list all cached trajectories. Trajectories are removed automatically if the motion group or the corresponding controller is disconnected.
|
|
11997
12044
|
* @summary Delete Trajectory
|
|
11998
12045
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
12046
|
+
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
11999
12047
|
* @param {string} trajectory This represents the unique identifier of a trajectory. Every executable or partially executable trajectory is cached and an unique identifier is returned. Indicate the unique identifier to execute the trajectory or retrieve information on the trajectory.
|
|
12000
12048
|
* @param {*} [options] Override http request option.
|
|
12001
12049
|
* @throws {RequiredError}
|
|
12002
12050
|
* @memberof TrajectoryCachingApi
|
|
12003
12051
|
*/
|
|
12004
|
-
public deleteTrajectory(cell: string, trajectory: string, options?: RawAxiosRequestConfig) {
|
|
12005
|
-
return TrajectoryCachingApiFp(this.configuration).deleteTrajectory(cell, trajectory, options).then((request) => request(this.axios, this.basePath));
|
|
12052
|
+
public deleteTrajectory(cell: string, controller: string, trajectory: string, options?: RawAxiosRequestConfig) {
|
|
12053
|
+
return TrajectoryCachingApiFp(this.configuration).deleteTrajectory(cell, controller, trajectory, options).then((request) => request(this.axios, this.basePath));
|
|
12006
12054
|
}
|
|
12007
12055
|
|
|
12008
12056
|
/**
|
|
12009
12057
|
* Get a previously created trajectory from cache. Use [listTrajectories](listTrajectories) to list all cached trajectories.
|
|
12010
12058
|
* @summary Get Trajectory
|
|
12011
12059
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
12060
|
+
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
12012
12061
|
* @param {string} trajectory This represents the unique identifier of a trajectory. Every executable or partially executable trajectory is cached and an unique identifier is returned. Indicate the unique identifier to execute the trajectory or retrieve information on the trajectory.
|
|
12013
12062
|
* @param {*} [options] Override http request option.
|
|
12014
12063
|
* @throws {RequiredError}
|
|
12015
12064
|
* @memberof TrajectoryCachingApi
|
|
12016
12065
|
*/
|
|
12017
|
-
public getTrajectory(cell: string, trajectory: string, options?: RawAxiosRequestConfig) {
|
|
12018
|
-
return TrajectoryCachingApiFp(this.configuration).getTrajectory(cell, trajectory, options).then((request) => request(this.axios, this.basePath));
|
|
12066
|
+
public getTrajectory(cell: string, controller: string, trajectory: string, options?: RawAxiosRequestConfig) {
|
|
12067
|
+
return TrajectoryCachingApiFp(this.configuration).getTrajectory(cell, controller, trajectory, options).then((request) => request(this.axios, this.basePath));
|
|
12019
12068
|
}
|
|
12020
12069
|
|
|
12021
12070
|
/**
|
|
12022
12071
|
* List currently cached trajectories. Use [addTrajectory](addTrajectory) to add a new trajectory. Adding trajectories is necessary to execute them. Trajectories are removed if the corresponding motion group or controller disconnects.
|
|
12023
12072
|
* @summary List Trajectories
|
|
12024
12073
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
12074
|
+
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
12025
12075
|
* @param {*} [options] Override http request option.
|
|
12026
12076
|
* @throws {RequiredError}
|
|
12027
12077
|
* @memberof TrajectoryCachingApi
|
|
12028
12078
|
*/
|
|
12029
|
-
public listTrajectories(cell: string, options?: RawAxiosRequestConfig) {
|
|
12030
|
-
return TrajectoryCachingApiFp(this.configuration).listTrajectories(cell, options).then((request) => request(this.axios, this.basePath));
|
|
12079
|
+
public listTrajectories(cell: string, controller: string, options?: RawAxiosRequestConfig) {
|
|
12080
|
+
return TrajectoryCachingApiFp(this.configuration).listTrajectories(cell, controller, options).then((request) => request(this.axios, this.basePath));
|
|
12031
12081
|
}
|
|
12032
12082
|
}
|
|
12033
12083
|
|
|
@@ -12043,17 +12093,21 @@ export const TrajectoryExecutionApiAxiosParamCreator = function (configuration?:
|
|
|
12043
12093
|
* <!-- theme: danger --> > Websocket endpoint Provides execution control over a previously planned trajectory. Enables the caller to attach input/output actions to the trajectory. Understanding the concept of location: The location or path parameter specifies the exact position along a trajectory. The location is a scalar value that ranges from 0 to `n`, where `n` denotes the number of motion commands, or trajectory segments, e.g. line, p2p, etc. See [planMotion](planMotion). Each integer value of the location corresponds to one motion command, e.g. 3.0 to 3.999 could be a line. ### Preconditions - The motion group\'s control mode is not claimed by any other endpoint. - The motion group\'s joint position are at start location specified with InitializeMovementRequest. - Use [executeToTrajectory](executeToTrajectory) to move the robot to the start location. ### Requests #### 1. Send InitializeMovementRequest to lock the trajectory to this connection The following actions are executed: - Sets robot controller mode to control mode, - Sets start location of the execution Keep in mind that only a single trajectory can be locked to a websocket connection at a time and not unlocked anymore. To execute another trajectory, a new connection must be established. #### 2. Send StartMovementRequest to start the movement Sets direction of movement, default is forward. #### **Optional** - To pause, send PauseMovementRequest before the movement has reached its end location. - Change the movement\'s velocity with PlaybackSpeedRequest after initializing the movement with InitializeMovementRequest. ### Responses - InitializeMovementResponse is sent to signal the success or failure of the InitializeMovementRequest. - Movement responses are streamed after a StartMovementRequest successfully started the movement. Movement responses are streamed in a rate that is defined as the multiple of the controller step-rate closest to but not exceeding the rate configured by InitializeMovementRequest. - Standstill reponse is sent once the movement has finished or has come to a standstill due to a pause. - PauseMovementResponse is sent to signal the success of the PauseMovementRequest. It does not signal the end of the movement. End of movement is signaled by Standstill reponse . - PlaybackSpeedResponse is sent to signal the success of the PlaybackSpeedRequest. - MovementError with error details is sent in case of an unexpected error, e.g. controller disconnects during movement. ### Tips and Tricks - A movement can be paused and resumed by sending PauseMovementRequest and StartMovementRequest. - Send PlaybackSpeedRequest before StartMovementRequest to reduce the velocity of the movement before it starts. - Send PlaybackSpeedRequest repeatedly to implement a slider. The velocity of the motion group can be adjusted with each controller step. Therefore, if your app needs a slider-like UI to alter the velocity of a currently running movement, you can send PlaybackSpeedRequest with different speed values repeatedly during the movement. - A closed trajectory (end and start joint position are equal) can be repeated by sending StartMovementRequest after the movement has finished.
|
|
12044
12094
|
* @summary Execute Trajectory
|
|
12045
12095
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
12096
|
+
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
12046
12097
|
* @param {ExecuteTrajectoryRequest} executeTrajectoryRequest
|
|
12047
12098
|
* @param {*} [options] Override http request option.
|
|
12048
12099
|
* @throws {RequiredError}
|
|
12049
12100
|
*/
|
|
12050
|
-
executeTrajectory: async (cell: string, executeTrajectoryRequest: ExecuteTrajectoryRequest, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
12101
|
+
executeTrajectory: async (cell: string, controller: string, executeTrajectoryRequest: ExecuteTrajectoryRequest, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
12051
12102
|
// verify required parameter 'cell' is not null or undefined
|
|
12052
12103
|
assertParamExists('executeTrajectory', 'cell', cell)
|
|
12104
|
+
// verify required parameter 'controller' is not null or undefined
|
|
12105
|
+
assertParamExists('executeTrajectory', 'controller', controller)
|
|
12053
12106
|
// verify required parameter 'executeTrajectoryRequest' is not null or undefined
|
|
12054
12107
|
assertParamExists('executeTrajectory', 'executeTrajectoryRequest', executeTrajectoryRequest)
|
|
12055
|
-
const localVarPath = `/cells/{cell}/execution/trajectory`
|
|
12056
|
-
.replace(`{${"cell"}}`, encodeURIComponent(String(cell)))
|
|
12108
|
+
const localVarPath = `/cells/{cell}/controllers/{controller}/execution/trajectory`
|
|
12109
|
+
.replace(`{${"cell"}}`, encodeURIComponent(String(cell)))
|
|
12110
|
+
.replace(`{${"controller"}}`, encodeURIComponent(String(controller)));
|
|
12057
12111
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
12058
12112
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
12059
12113
|
let baseOptions;
|
|
@@ -12101,12 +12155,13 @@ export const TrajectoryExecutionApiFp = function(configuration?: Configuration)
|
|
|
12101
12155
|
* <!-- theme: danger --> > Websocket endpoint Provides execution control over a previously planned trajectory. Enables the caller to attach input/output actions to the trajectory. Understanding the concept of location: The location or path parameter specifies the exact position along a trajectory. The location is a scalar value that ranges from 0 to `n`, where `n` denotes the number of motion commands, or trajectory segments, e.g. line, p2p, etc. See [planMotion](planMotion). Each integer value of the location corresponds to one motion command, e.g. 3.0 to 3.999 could be a line. ### Preconditions - The motion group\'s control mode is not claimed by any other endpoint. - The motion group\'s joint position are at start location specified with InitializeMovementRequest. - Use [executeToTrajectory](executeToTrajectory) to move the robot to the start location. ### Requests #### 1. Send InitializeMovementRequest to lock the trajectory to this connection The following actions are executed: - Sets robot controller mode to control mode, - Sets start location of the execution Keep in mind that only a single trajectory can be locked to a websocket connection at a time and not unlocked anymore. To execute another trajectory, a new connection must be established. #### 2. Send StartMovementRequest to start the movement Sets direction of movement, default is forward. #### **Optional** - To pause, send PauseMovementRequest before the movement has reached its end location. - Change the movement\'s velocity with PlaybackSpeedRequest after initializing the movement with InitializeMovementRequest. ### Responses - InitializeMovementResponse is sent to signal the success or failure of the InitializeMovementRequest. - Movement responses are streamed after a StartMovementRequest successfully started the movement. Movement responses are streamed in a rate that is defined as the multiple of the controller step-rate closest to but not exceeding the rate configured by InitializeMovementRequest. - Standstill reponse is sent once the movement has finished or has come to a standstill due to a pause. - PauseMovementResponse is sent to signal the success of the PauseMovementRequest. It does not signal the end of the movement. End of movement is signaled by Standstill reponse . - PlaybackSpeedResponse is sent to signal the success of the PlaybackSpeedRequest. - MovementError with error details is sent in case of an unexpected error, e.g. controller disconnects during movement. ### Tips and Tricks - A movement can be paused and resumed by sending PauseMovementRequest and StartMovementRequest. - Send PlaybackSpeedRequest before StartMovementRequest to reduce the velocity of the movement before it starts. - Send PlaybackSpeedRequest repeatedly to implement a slider. The velocity of the motion group can be adjusted with each controller step. Therefore, if your app needs a slider-like UI to alter the velocity of a currently running movement, you can send PlaybackSpeedRequest with different speed values repeatedly during the movement. - A closed trajectory (end and start joint position are equal) can be repeated by sending StartMovementRequest after the movement has finished.
|
|
12102
12156
|
* @summary Execute Trajectory
|
|
12103
12157
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
12158
|
+
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
12104
12159
|
* @param {ExecuteTrajectoryRequest} executeTrajectoryRequest
|
|
12105
12160
|
* @param {*} [options] Override http request option.
|
|
12106
12161
|
* @throws {RequiredError}
|
|
12107
12162
|
*/
|
|
12108
|
-
async executeTrajectory(cell: string, executeTrajectoryRequest: ExecuteTrajectoryRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ExecuteTrajectoryResponse>> {
|
|
12109
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.executeTrajectory(cell, executeTrajectoryRequest, options);
|
|
12163
|
+
async executeTrajectory(cell: string, controller: string, executeTrajectoryRequest: ExecuteTrajectoryRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ExecuteTrajectoryResponse>> {
|
|
12164
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.executeTrajectory(cell, controller, executeTrajectoryRequest, options);
|
|
12110
12165
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
12111
12166
|
const localVarOperationServerBasePath = operationServerMap['TrajectoryExecutionApi.executeTrajectory']?.[localVarOperationServerIndex]?.url;
|
|
12112
12167
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
@@ -12125,12 +12180,13 @@ export const TrajectoryExecutionApiFactory = function (configuration?: Configura
|
|
|
12125
12180
|
* <!-- theme: danger --> > Websocket endpoint Provides execution control over a previously planned trajectory. Enables the caller to attach input/output actions to the trajectory. Understanding the concept of location: The location or path parameter specifies the exact position along a trajectory. The location is a scalar value that ranges from 0 to `n`, where `n` denotes the number of motion commands, or trajectory segments, e.g. line, p2p, etc. See [planMotion](planMotion). Each integer value of the location corresponds to one motion command, e.g. 3.0 to 3.999 could be a line. ### Preconditions - The motion group\'s control mode is not claimed by any other endpoint. - The motion group\'s joint position are at start location specified with InitializeMovementRequest. - Use [executeToTrajectory](executeToTrajectory) to move the robot to the start location. ### Requests #### 1. Send InitializeMovementRequest to lock the trajectory to this connection The following actions are executed: - Sets robot controller mode to control mode, - Sets start location of the execution Keep in mind that only a single trajectory can be locked to a websocket connection at a time and not unlocked anymore. To execute another trajectory, a new connection must be established. #### 2. Send StartMovementRequest to start the movement Sets direction of movement, default is forward. #### **Optional** - To pause, send PauseMovementRequest before the movement has reached its end location. - Change the movement\'s velocity with PlaybackSpeedRequest after initializing the movement with InitializeMovementRequest. ### Responses - InitializeMovementResponse is sent to signal the success or failure of the InitializeMovementRequest. - Movement responses are streamed after a StartMovementRequest successfully started the movement. Movement responses are streamed in a rate that is defined as the multiple of the controller step-rate closest to but not exceeding the rate configured by InitializeMovementRequest. - Standstill reponse is sent once the movement has finished or has come to a standstill due to a pause. - PauseMovementResponse is sent to signal the success of the PauseMovementRequest. It does not signal the end of the movement. End of movement is signaled by Standstill reponse . - PlaybackSpeedResponse is sent to signal the success of the PlaybackSpeedRequest. - MovementError with error details is sent in case of an unexpected error, e.g. controller disconnects during movement. ### Tips and Tricks - A movement can be paused and resumed by sending PauseMovementRequest and StartMovementRequest. - Send PlaybackSpeedRequest before StartMovementRequest to reduce the velocity of the movement before it starts. - Send PlaybackSpeedRequest repeatedly to implement a slider. The velocity of the motion group can be adjusted with each controller step. Therefore, if your app needs a slider-like UI to alter the velocity of a currently running movement, you can send PlaybackSpeedRequest with different speed values repeatedly during the movement. - A closed trajectory (end and start joint position are equal) can be repeated by sending StartMovementRequest after the movement has finished.
|
|
12126
12181
|
* @summary Execute Trajectory
|
|
12127
12182
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
12183
|
+
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
12128
12184
|
* @param {ExecuteTrajectoryRequest} executeTrajectoryRequest
|
|
12129
12185
|
* @param {*} [options] Override http request option.
|
|
12130
12186
|
* @throws {RequiredError}
|
|
12131
12187
|
*/
|
|
12132
|
-
executeTrajectory(cell: string, executeTrajectoryRequest: ExecuteTrajectoryRequest, options?: RawAxiosRequestConfig): AxiosPromise<ExecuteTrajectoryResponse> {
|
|
12133
|
-
return localVarFp.executeTrajectory(cell, executeTrajectoryRequest, options).then((request) => request(axios, basePath));
|
|
12188
|
+
executeTrajectory(cell: string, controller: string, executeTrajectoryRequest: ExecuteTrajectoryRequest, options?: RawAxiosRequestConfig): AxiosPromise<ExecuteTrajectoryResponse> {
|
|
12189
|
+
return localVarFp.executeTrajectory(cell, controller, executeTrajectoryRequest, options).then((request) => request(axios, basePath));
|
|
12134
12190
|
},
|
|
12135
12191
|
};
|
|
12136
12192
|
};
|
|
@@ -12146,13 +12202,14 @@ export class TrajectoryExecutionApi extends BaseAPI {
|
|
|
12146
12202
|
* <!-- theme: danger --> > Websocket endpoint Provides execution control over a previously planned trajectory. Enables the caller to attach input/output actions to the trajectory. Understanding the concept of location: The location or path parameter specifies the exact position along a trajectory. The location is a scalar value that ranges from 0 to `n`, where `n` denotes the number of motion commands, or trajectory segments, e.g. line, p2p, etc. See [planMotion](planMotion). Each integer value of the location corresponds to one motion command, e.g. 3.0 to 3.999 could be a line. ### Preconditions - The motion group\'s control mode is not claimed by any other endpoint. - The motion group\'s joint position are at start location specified with InitializeMovementRequest. - Use [executeToTrajectory](executeToTrajectory) to move the robot to the start location. ### Requests #### 1. Send InitializeMovementRequest to lock the trajectory to this connection The following actions are executed: - Sets robot controller mode to control mode, - Sets start location of the execution Keep in mind that only a single trajectory can be locked to a websocket connection at a time and not unlocked anymore. To execute another trajectory, a new connection must be established. #### 2. Send StartMovementRequest to start the movement Sets direction of movement, default is forward. #### **Optional** - To pause, send PauseMovementRequest before the movement has reached its end location. - Change the movement\'s velocity with PlaybackSpeedRequest after initializing the movement with InitializeMovementRequest. ### Responses - InitializeMovementResponse is sent to signal the success or failure of the InitializeMovementRequest. - Movement responses are streamed after a StartMovementRequest successfully started the movement. Movement responses are streamed in a rate that is defined as the multiple of the controller step-rate closest to but not exceeding the rate configured by InitializeMovementRequest. - Standstill reponse is sent once the movement has finished or has come to a standstill due to a pause. - PauseMovementResponse is sent to signal the success of the PauseMovementRequest. It does not signal the end of the movement. End of movement is signaled by Standstill reponse . - PlaybackSpeedResponse is sent to signal the success of the PlaybackSpeedRequest. - MovementError with error details is sent in case of an unexpected error, e.g. controller disconnects during movement. ### Tips and Tricks - A movement can be paused and resumed by sending PauseMovementRequest and StartMovementRequest. - Send PlaybackSpeedRequest before StartMovementRequest to reduce the velocity of the movement before it starts. - Send PlaybackSpeedRequest repeatedly to implement a slider. The velocity of the motion group can be adjusted with each controller step. Therefore, if your app needs a slider-like UI to alter the velocity of a currently running movement, you can send PlaybackSpeedRequest with different speed values repeatedly during the movement. - A closed trajectory (end and start joint position are equal) can be repeated by sending StartMovementRequest after the movement has finished.
|
|
12147
12203
|
* @summary Execute Trajectory
|
|
12148
12204
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
12205
|
+
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
12149
12206
|
* @param {ExecuteTrajectoryRequest} executeTrajectoryRequest
|
|
12150
12207
|
* @param {*} [options] Override http request option.
|
|
12151
12208
|
* @throws {RequiredError}
|
|
12152
12209
|
* @memberof TrajectoryExecutionApi
|
|
12153
12210
|
*/
|
|
12154
|
-
public executeTrajectory(cell: string, executeTrajectoryRequest: ExecuteTrajectoryRequest, options?: RawAxiosRequestConfig) {
|
|
12155
|
-
return TrajectoryExecutionApiFp(this.configuration).executeTrajectory(cell, executeTrajectoryRequest, options).then((request) => request(this.axios, this.basePath));
|
|
12211
|
+
public executeTrajectory(cell: string, controller: string, executeTrajectoryRequest: ExecuteTrajectoryRequest, options?: RawAxiosRequestConfig) {
|
|
12212
|
+
return TrajectoryExecutionApiFp(this.configuration).executeTrajectory(cell, controller, executeTrajectoryRequest, options).then((request) => request(this.axios, this.basePath));
|
|
12156
12213
|
}
|
|
12157
12214
|
}
|
|
12158
12215
|
|
|
@@ -12282,31 +12339,34 @@ export class TrajectoryPlanningApi extends BaseAPI {
|
|
|
12282
12339
|
|
|
12283
12340
|
|
|
12284
12341
|
/**
|
|
12285
|
-
*
|
|
12342
|
+
* VirtualControllerApi - axios parameter creator
|
|
12286
12343
|
* @export
|
|
12287
12344
|
*/
|
|
12288
|
-
export const
|
|
12345
|
+
export const VirtualControllerApiAxiosParamCreator = function (configuration?: Configuration) {
|
|
12289
12346
|
return {
|
|
12290
12347
|
/**
|
|
12291
|
-
*
|
|
12292
|
-
* @summary
|
|
12348
|
+
* Adds a coordinate system to the robot controller.
|
|
12349
|
+
* @summary Add Coordinate Systems
|
|
12293
12350
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
12294
12351
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
12295
|
-
* @param {string}
|
|
12352
|
+
* @param {string} coordinateSystem Unique identifier addressing a coordinate system.
|
|
12353
|
+
* @param {CoordinateSystemData} coordinateSystemData
|
|
12296
12354
|
* @param {*} [options] Override http request option.
|
|
12297
12355
|
* @throws {RequiredError}
|
|
12298
12356
|
*/
|
|
12299
|
-
|
|
12357
|
+
addVirtualRobotCoordinateSystem: async (cell: string, controller: string, coordinateSystem: string, coordinateSystemData: CoordinateSystemData, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
12300
12358
|
// verify required parameter 'cell' is not null or undefined
|
|
12301
|
-
assertParamExists('
|
|
12359
|
+
assertParamExists('addVirtualRobotCoordinateSystem', 'cell', cell)
|
|
12302
12360
|
// verify required parameter 'controller' is not null or undefined
|
|
12303
|
-
assertParamExists('
|
|
12304
|
-
// verify required parameter '
|
|
12305
|
-
assertParamExists('
|
|
12306
|
-
|
|
12361
|
+
assertParamExists('addVirtualRobotCoordinateSystem', 'controller', controller)
|
|
12362
|
+
// verify required parameter 'coordinateSystem' is not null or undefined
|
|
12363
|
+
assertParamExists('addVirtualRobotCoordinateSystem', 'coordinateSystem', coordinateSystem)
|
|
12364
|
+
// verify required parameter 'coordinateSystemData' is not null or undefined
|
|
12365
|
+
assertParamExists('addVirtualRobotCoordinateSystem', 'coordinateSystemData', coordinateSystemData)
|
|
12366
|
+
const localVarPath = `/cells/{cell}/virtual-controllers/{controller}/coordinate-systems/{coordinate-system}`
|
|
12307
12367
|
.replace(`{${"cell"}}`, encodeURIComponent(String(cell)))
|
|
12308
12368
|
.replace(`{${"controller"}}`, encodeURIComponent(String(controller)))
|
|
12309
|
-
.replace(`{${"
|
|
12369
|
+
.replace(`{${"coordinate-system"}}`, encodeURIComponent(String(coordinateSystem)));
|
|
12310
12370
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
12311
12371
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
12312
12372
|
let baseOptions;
|
|
@@ -12314,7 +12374,7 @@ export const VirtualRobotApiAxiosParamCreator = function (configuration?: Config
|
|
|
12314
12374
|
baseOptions = configuration.baseOptions;
|
|
12315
12375
|
}
|
|
12316
12376
|
|
|
12317
|
-
const localVarRequestOptions = { method: '
|
|
12377
|
+
const localVarRequestOptions = { method: 'PUT', ...baseOptions, ...options};
|
|
12318
12378
|
const localVarHeaderParameter = {} as any;
|
|
12319
12379
|
const localVarQueryParameter = {} as any;
|
|
12320
12380
|
|
|
@@ -12328,9 +12388,12 @@ export const VirtualRobotApiAxiosParamCreator = function (configuration?: Config
|
|
|
12328
12388
|
|
|
12329
12389
|
|
|
12330
12390
|
|
|
12391
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
12392
|
+
|
|
12331
12393
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
12332
12394
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
12333
12395
|
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
12396
|
+
localVarRequestOptions.data = serializeDataIfNeeded(coordinateSystemData, localVarRequestOptions, configuration)
|
|
12334
12397
|
|
|
12335
12398
|
return {
|
|
12336
12399
|
url: toPathString(localVarUrlObj),
|
|
@@ -12338,21 +12401,32 @@ export const VirtualRobotApiAxiosParamCreator = function (configuration?: Config
|
|
|
12338
12401
|
};
|
|
12339
12402
|
},
|
|
12340
12403
|
/**
|
|
12341
|
-
*
|
|
12342
|
-
* @summary
|
|
12404
|
+
* Adds a new TCP or updates an existing TCP in the motion group. The position and rotation values in the request body are defined within the flange’s coordinate system. > **NOTE** > > Ensure the TCP\'s position is within the robot\'s reach. Refer to the robot’s documentation or data sheet for details like joint limits or reach.
|
|
12405
|
+
* @summary Add TCP
|
|
12343
12406
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
12344
12407
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
12408
|
+
* @param {string} motionGroup The motion-group identifier.
|
|
12409
|
+
* @param {string} tcp The unique identifier of a TCP.
|
|
12410
|
+
* @param {RobotTcpData} robotTcpData
|
|
12345
12411
|
* @param {*} [options] Override http request option.
|
|
12346
12412
|
* @throws {RequiredError}
|
|
12347
12413
|
*/
|
|
12348
|
-
|
|
12414
|
+
addVirtualRobotTcp: async (cell: string, controller: string, motionGroup: string, tcp: string, robotTcpData: RobotTcpData, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
12349
12415
|
// verify required parameter 'cell' is not null or undefined
|
|
12350
|
-
assertParamExists('
|
|
12416
|
+
assertParamExists('addVirtualRobotTcp', 'cell', cell)
|
|
12351
12417
|
// verify required parameter 'controller' is not null or undefined
|
|
12352
|
-
assertParamExists('
|
|
12353
|
-
|
|
12418
|
+
assertParamExists('addVirtualRobotTcp', 'controller', controller)
|
|
12419
|
+
// verify required parameter 'motionGroup' is not null or undefined
|
|
12420
|
+
assertParamExists('addVirtualRobotTcp', 'motionGroup', motionGroup)
|
|
12421
|
+
// verify required parameter 'tcp' is not null or undefined
|
|
12422
|
+
assertParamExists('addVirtualRobotTcp', 'tcp', tcp)
|
|
12423
|
+
// verify required parameter 'robotTcpData' is not null or undefined
|
|
12424
|
+
assertParamExists('addVirtualRobotTcp', 'robotTcpData', robotTcpData)
|
|
12425
|
+
const localVarPath = `/cells/{cell}/virtual-controllers/{controller}/motion-groups/{motion-group}/tcps/{tcp}`
|
|
12354
12426
|
.replace(`{${"cell"}}`, encodeURIComponent(String(cell)))
|
|
12355
|
-
.replace(`{${"controller"}}`, encodeURIComponent(String(controller)))
|
|
12427
|
+
.replace(`{${"controller"}}`, encodeURIComponent(String(controller)))
|
|
12428
|
+
.replace(`{${"motion-group"}}`, encodeURIComponent(String(motionGroup)))
|
|
12429
|
+
.replace(`{${"tcp"}}`, encodeURIComponent(String(tcp)));
|
|
12356
12430
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
12357
12431
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
12358
12432
|
let baseOptions;
|
|
@@ -12360,7 +12434,7 @@ export const VirtualRobotApiAxiosParamCreator = function (configuration?: Config
|
|
|
12360
12434
|
baseOptions = configuration.baseOptions;
|
|
12361
12435
|
}
|
|
12362
12436
|
|
|
12363
|
-
const localVarRequestOptions = { method: '
|
|
12437
|
+
const localVarRequestOptions = { method: 'PUT', ...baseOptions, ...options};
|
|
12364
12438
|
const localVarHeaderParameter = {} as any;
|
|
12365
12439
|
const localVarQueryParameter = {} as any;
|
|
12366
12440
|
|
|
@@ -12374,9 +12448,12 @@ export const VirtualRobotApiAxiosParamCreator = function (configuration?: Config
|
|
|
12374
12448
|
|
|
12375
12449
|
|
|
12376
12450
|
|
|
12451
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
12452
|
+
|
|
12377
12453
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
12378
12454
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
12379
12455
|
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
12456
|
+
localVarRequestOptions.data = serializeDataIfNeeded(robotTcpData, localVarRequestOptions, configuration)
|
|
12380
12457
|
|
|
12381
12458
|
return {
|
|
12382
12459
|
url: toPathString(localVarUrlObj),
|
|
@@ -12384,24 +12461,26 @@ export const VirtualRobotApiAxiosParamCreator = function (configuration?: Config
|
|
|
12384
12461
|
};
|
|
12385
12462
|
},
|
|
12386
12463
|
/**
|
|
12387
|
-
*
|
|
12388
|
-
* @summary
|
|
12464
|
+
* Deletes a coordinate system from the virtual controller. This will remove the coordinate system from the list of coordinate systems and remove all dependent coordinate systems which use the deleted coordinate system as reference.
|
|
12465
|
+
* @summary Remove Coordinate System
|
|
12389
12466
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
12390
12467
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
12391
|
-
* @param {
|
|
12468
|
+
* @param {string} coordinateSystem Unique identifier addressing a coordinate system.
|
|
12469
|
+
* @param {boolean} [deleteDependent] If true, all dependent coordinate systems will be deleted as well.
|
|
12392
12470
|
* @param {*} [options] Override http request option.
|
|
12393
12471
|
* @throws {RequiredError}
|
|
12394
12472
|
*/
|
|
12395
|
-
|
|
12473
|
+
deleteVirtualRobotCoordinateSystem: async (cell: string, controller: string, coordinateSystem: string, deleteDependent?: boolean, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
12396
12474
|
// verify required parameter 'cell' is not null or undefined
|
|
12397
|
-
assertParamExists('
|
|
12475
|
+
assertParamExists('deleteVirtualRobotCoordinateSystem', 'cell', cell)
|
|
12398
12476
|
// verify required parameter 'controller' is not null or undefined
|
|
12399
|
-
assertParamExists('
|
|
12400
|
-
// verify required parameter '
|
|
12401
|
-
assertParamExists('
|
|
12402
|
-
const localVarPath = `/cells/{cell}/controllers/{controller}/
|
|
12477
|
+
assertParamExists('deleteVirtualRobotCoordinateSystem', 'controller', controller)
|
|
12478
|
+
// verify required parameter 'coordinateSystem' is not null or undefined
|
|
12479
|
+
assertParamExists('deleteVirtualRobotCoordinateSystem', 'coordinateSystem', coordinateSystem)
|
|
12480
|
+
const localVarPath = `/cells/{cell}/virtual-controllers/{controller}/coordinate-systems/{coordinate-system}`
|
|
12403
12481
|
.replace(`{${"cell"}}`, encodeURIComponent(String(cell)))
|
|
12404
|
-
.replace(`{${"controller"}}`, encodeURIComponent(String(controller)))
|
|
12482
|
+
.replace(`{${"controller"}}`, encodeURIComponent(String(controller)))
|
|
12483
|
+
.replace(`{${"coordinate-system"}}`, encodeURIComponent(String(coordinateSystem)));
|
|
12405
12484
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
12406
12485
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
12407
12486
|
let baseOptions;
|
|
@@ -12409,7 +12488,7 @@ export const VirtualRobotApiAxiosParamCreator = function (configuration?: Config
|
|
|
12409
12488
|
baseOptions = configuration.baseOptions;
|
|
12410
12489
|
}
|
|
12411
12490
|
|
|
12412
|
-
const localVarRequestOptions = { method: '
|
|
12491
|
+
const localVarRequestOptions = { method: 'DELETE', ...baseOptions, ...options};
|
|
12413
12492
|
const localVarHeaderParameter = {} as any;
|
|
12414
12493
|
const localVarQueryParameter = {} as any;
|
|
12415
12494
|
|
|
@@ -12421,8 +12500,8 @@ export const VirtualRobotApiAxiosParamCreator = function (configuration?: Config
|
|
|
12421
12500
|
// http bearer authentication required
|
|
12422
12501
|
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
12423
12502
|
|
|
12424
|
-
if (
|
|
12425
|
-
localVarQueryParameter['
|
|
12503
|
+
if (deleteDependent !== undefined) {
|
|
12504
|
+
localVarQueryParameter['delete_dependent'] = deleteDependent;
|
|
12426
12505
|
}
|
|
12427
12506
|
|
|
12428
12507
|
|
|
@@ -12437,25 +12516,29 @@ export const VirtualRobotApiAxiosParamCreator = function (configuration?: Config
|
|
|
12437
12516
|
};
|
|
12438
12517
|
},
|
|
12439
12518
|
/**
|
|
12440
|
-
*
|
|
12441
|
-
* @summary
|
|
12519
|
+
* Removes the TCP from the motion group. An unknown TCP is a valid input.
|
|
12520
|
+
* @summary Remove TCP
|
|
12442
12521
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
12443
12522
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
12444
|
-
* @param {
|
|
12445
|
-
* @param {
|
|
12446
|
-
* @param {IOValueType} [valueType] Return only inputs/outputs with the specified value type.
|
|
12447
|
-
* @param {string} [group] Return only inputs/outputs from the specified group.
|
|
12523
|
+
* @param {string} motionGroup The motion-group identifier.
|
|
12524
|
+
* @param {string} tcp The unique identifier of a TCP.
|
|
12448
12525
|
* @param {*} [options] Override http request option.
|
|
12449
12526
|
* @throws {RequiredError}
|
|
12450
12527
|
*/
|
|
12451
|
-
|
|
12528
|
+
deleteVirtualRobotTcp: async (cell: string, controller: string, motionGroup: string, tcp: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
12452
12529
|
// verify required parameter 'cell' is not null or undefined
|
|
12453
|
-
assertParamExists('
|
|
12530
|
+
assertParamExists('deleteVirtualRobotTcp', 'cell', cell)
|
|
12454
12531
|
// verify required parameter 'controller' is not null or undefined
|
|
12455
|
-
assertParamExists('
|
|
12456
|
-
|
|
12532
|
+
assertParamExists('deleteVirtualRobotTcp', 'controller', controller)
|
|
12533
|
+
// verify required parameter 'motionGroup' is not null or undefined
|
|
12534
|
+
assertParamExists('deleteVirtualRobotTcp', 'motionGroup', motionGroup)
|
|
12535
|
+
// verify required parameter 'tcp' is not null or undefined
|
|
12536
|
+
assertParamExists('deleteVirtualRobotTcp', 'tcp', tcp)
|
|
12537
|
+
const localVarPath = `/cells/{cell}/virtual-controllers/{controller}/motion-groups/{motion-group}/tcps/{tcp}`
|
|
12457
12538
|
.replace(`{${"cell"}}`, encodeURIComponent(String(cell)))
|
|
12458
|
-
.replace(`{${"controller"}}`, encodeURIComponent(String(controller)))
|
|
12539
|
+
.replace(`{${"controller"}}`, encodeURIComponent(String(controller)))
|
|
12540
|
+
.replace(`{${"motion-group"}}`, encodeURIComponent(String(motionGroup)))
|
|
12541
|
+
.replace(`{${"tcp"}}`, encodeURIComponent(String(tcp)));
|
|
12459
12542
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
12460
12543
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
12461
12544
|
let baseOptions;
|
|
@@ -12463,7 +12546,7 @@ export const VirtualRobotApiAxiosParamCreator = function (configuration?: Config
|
|
|
12463
12546
|
baseOptions = configuration.baseOptions;
|
|
12464
12547
|
}
|
|
12465
12548
|
|
|
12466
|
-
const localVarRequestOptions = { method: '
|
|
12549
|
+
const localVarRequestOptions = { method: 'DELETE', ...baseOptions, ...options};
|
|
12467
12550
|
const localVarHeaderParameter = {} as any;
|
|
12468
12551
|
const localVarQueryParameter = {} as any;
|
|
12469
12552
|
|
|
@@ -12475,22 +12558,6 @@ export const VirtualRobotApiAxiosParamCreator = function (configuration?: Config
|
|
|
12475
12558
|
// http bearer authentication required
|
|
12476
12559
|
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
12477
12560
|
|
|
12478
|
-
if (ios) {
|
|
12479
|
-
localVarQueryParameter['ios'] = ios;
|
|
12480
|
-
}
|
|
12481
|
-
|
|
12482
|
-
if (direction !== undefined) {
|
|
12483
|
-
localVarQueryParameter['direction'] = direction;
|
|
12484
|
-
}
|
|
12485
|
-
|
|
12486
|
-
if (valueType !== undefined) {
|
|
12487
|
-
localVarQueryParameter['value_type'] = valueType;
|
|
12488
|
-
}
|
|
12489
|
-
|
|
12490
|
-
if (group !== undefined) {
|
|
12491
|
-
localVarQueryParameter['group'] = group;
|
|
12492
|
-
}
|
|
12493
|
-
|
|
12494
12561
|
|
|
12495
12562
|
|
|
12496
12563
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
@@ -12503,22 +12570,19 @@ export const VirtualRobotApiAxiosParamCreator = function (configuration?: Config
|
|
|
12503
12570
|
};
|
|
12504
12571
|
},
|
|
12505
12572
|
/**
|
|
12506
|
-
*
|
|
12507
|
-
* @summary
|
|
12573
|
+
* Requests the Emergency Stop state of the virtual robot controller. Use [getCurrentMotionGroupState](getCurrentMotionGroupState) to get the Emergency Stop state regardless of the controller type. There the Emergency Stop state is visible as the `safety_state`. > **NOTE** > > The Emergency Stop state can only be changed when using virtual robot controllers.
|
|
12574
|
+
* @summary Get Emergency Stop State
|
|
12508
12575
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
12509
12576
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
12510
|
-
* @param {Array<IOValue>} iOValue
|
|
12511
12577
|
* @param {*} [options] Override http request option.
|
|
12512
12578
|
* @throws {RequiredError}
|
|
12513
12579
|
*/
|
|
12514
|
-
|
|
12580
|
+
getEmergencyStop: async (cell: string, controller: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
12515
12581
|
// verify required parameter 'cell' is not null or undefined
|
|
12516
|
-
assertParamExists('
|
|
12582
|
+
assertParamExists('getEmergencyStop', 'cell', cell)
|
|
12517
12583
|
// verify required parameter 'controller' is not null or undefined
|
|
12518
|
-
assertParamExists('
|
|
12519
|
-
|
|
12520
|
-
assertParamExists('setIOValues', 'iOValue', iOValue)
|
|
12521
|
-
const localVarPath = `/cells/{cell}/controllers/{controller}/teach-pendant/ios`
|
|
12584
|
+
assertParamExists('getEmergencyStop', 'controller', controller)
|
|
12585
|
+
const localVarPath = `/cells/{cell}/virtual-controllers/{controller}/emergency-stop`
|
|
12522
12586
|
.replace(`{${"cell"}}`, encodeURIComponent(String(cell)))
|
|
12523
12587
|
.replace(`{${"controller"}}`, encodeURIComponent(String(controller)));
|
|
12524
12588
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
@@ -12528,7 +12592,7 @@ export const VirtualRobotApiAxiosParamCreator = function (configuration?: Config
|
|
|
12528
12592
|
baseOptions = configuration.baseOptions;
|
|
12529
12593
|
}
|
|
12530
12594
|
|
|
12531
|
-
const localVarRequestOptions = { method: '
|
|
12595
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
12532
12596
|
const localVarHeaderParameter = {} as any;
|
|
12533
12597
|
const localVarQueryParameter = {} as any;
|
|
12534
12598
|
|
|
@@ -12542,12 +12606,9 @@ export const VirtualRobotApiAxiosParamCreator = function (configuration?: Config
|
|
|
12542
12606
|
|
|
12543
12607
|
|
|
12544
12608
|
|
|
12545
|
-
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
12546
|
-
|
|
12547
12609
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
12548
12610
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
12549
12611
|
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
12550
|
-
localVarRequestOptions.data = serializeDataIfNeeded(iOValue, localVarRequestOptions, configuration)
|
|
12551
12612
|
|
|
12552
12613
|
return {
|
|
12553
12614
|
url: toPathString(localVarUrlObj),
|
|
@@ -12555,25 +12616,22 @@ export const VirtualRobotApiAxiosParamCreator = function (configuration?: Config
|
|
|
12555
12616
|
};
|
|
12556
12617
|
},
|
|
12557
12618
|
/**
|
|
12558
|
-
*
|
|
12559
|
-
* @summary
|
|
12619
|
+
* Get the current motion group state which provides values for the joints\' position, velocity and acceleration.
|
|
12620
|
+
* @summary Get Motion Group State
|
|
12560
12621
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
12561
12622
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
12562
12623
|
* @param {string} motionGroup The motion-group identifier.
|
|
12563
|
-
* @param {MotionGroupJoints} motionGroupJoints
|
|
12564
12624
|
* @param {*} [options] Override http request option.
|
|
12565
12625
|
* @throws {RequiredError}
|
|
12566
12626
|
*/
|
|
12567
|
-
|
|
12627
|
+
getMotionGroupState: async (cell: string, controller: string, motionGroup: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
12568
12628
|
// verify required parameter 'cell' is not null or undefined
|
|
12569
|
-
assertParamExists('
|
|
12629
|
+
assertParamExists('getMotionGroupState', 'cell', cell)
|
|
12570
12630
|
// verify required parameter 'controller' is not null or undefined
|
|
12571
|
-
assertParamExists('
|
|
12631
|
+
assertParamExists('getMotionGroupState', 'controller', controller)
|
|
12572
12632
|
// verify required parameter 'motionGroup' is not null or undefined
|
|
12573
|
-
assertParamExists('
|
|
12574
|
-
|
|
12575
|
-
assertParamExists('setMotionGroupState', 'motionGroupJoints', motionGroupJoints)
|
|
12576
|
-
const localVarPath = `/cells/{cell}/controllers/{controller}/teach-pendant/motion-groups/{motion-group}`
|
|
12633
|
+
assertParamExists('getMotionGroupState', 'motionGroup', motionGroup)
|
|
12634
|
+
const localVarPath = `/cells/{cell}/virtual-controllers/{controller}/motion-groups/{motion-group}/state`
|
|
12577
12635
|
.replace(`{${"cell"}}`, encodeURIComponent(String(cell)))
|
|
12578
12636
|
.replace(`{${"controller"}}`, encodeURIComponent(String(controller)))
|
|
12579
12637
|
.replace(`{${"motion-group"}}`, encodeURIComponent(String(motionGroup)));
|
|
@@ -12584,7 +12642,7 @@ export const VirtualRobotApiAxiosParamCreator = function (configuration?: Config
|
|
|
12584
12642
|
baseOptions = configuration.baseOptions;
|
|
12585
12643
|
}
|
|
12586
12644
|
|
|
12587
|
-
const localVarRequestOptions = { method: '
|
|
12645
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
12588
12646
|
const localVarHeaderParameter = {} as any;
|
|
12589
12647
|
const localVarQueryParameter = {} as any;
|
|
12590
12648
|
|
|
@@ -12598,43 +12656,15 @@ export const VirtualRobotApiAxiosParamCreator = function (configuration?: Config
|
|
|
12598
12656
|
|
|
12599
12657
|
|
|
12600
12658
|
|
|
12601
|
-
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
12602
|
-
|
|
12603
12659
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
12604
12660
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
12605
12661
|
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
12606
|
-
localVarRequestOptions.data = serializeDataIfNeeded(motionGroupJoints, localVarRequestOptions, configuration)
|
|
12607
12662
|
|
|
12608
12663
|
return {
|
|
12609
12664
|
url: toPathString(localVarUrlObj),
|
|
12610
12665
|
options: localVarRequestOptions,
|
|
12611
12666
|
};
|
|
12612
12667
|
},
|
|
12613
|
-
}
|
|
12614
|
-
};
|
|
12615
|
-
|
|
12616
|
-
/**
|
|
12617
|
-
* VirtualRobotApi - functional programming interface
|
|
12618
|
-
* @export
|
|
12619
|
-
*/
|
|
12620
|
-
export const VirtualRobotApiFp = function(configuration?: Configuration) {
|
|
12621
|
-
const localVarAxiosParamCreator = VirtualRobotApiAxiosParamCreator(configuration)
|
|
12622
|
-
return {
|
|
12623
|
-
/**
|
|
12624
|
-
* Get the current motion group state which provides values for the joints\' position, velocity and acceleration.
|
|
12625
|
-
* @summary Get Motion Group State
|
|
12626
|
-
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
12627
|
-
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
12628
|
-
* @param {string} motionGroup The motion-group identifier.
|
|
12629
|
-
* @param {*} [options] Override http request option.
|
|
12630
|
-
* @throws {RequiredError}
|
|
12631
|
-
*/
|
|
12632
|
-
async getMotionGroupState(cell: string, controller: string, motionGroup: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<MotionGroupJoints>> {
|
|
12633
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.getMotionGroupState(cell, controller, motionGroup, options);
|
|
12634
|
-
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
12635
|
-
const localVarOperationServerBasePath = operationServerMap['VirtualRobotApi.getMotionGroupState']?.[localVarOperationServerIndex]?.url;
|
|
12636
|
-
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
12637
|
-
},
|
|
12638
12668
|
/**
|
|
12639
12669
|
* Gets information on the motion group.
|
|
12640
12670
|
* @summary Motion Group Description
|
|
@@ -12643,286 +12673,206 @@ export const VirtualRobotApiFp = function(configuration?: Configuration) {
|
|
|
12643
12673
|
* @param {*} [options] Override http request option.
|
|
12644
12674
|
* @throws {RequiredError}
|
|
12645
12675
|
*/
|
|
12646
|
-
async
|
|
12647
|
-
|
|
12648
|
-
|
|
12649
|
-
|
|
12650
|
-
|
|
12651
|
-
|
|
12652
|
-
|
|
12653
|
-
|
|
12654
|
-
|
|
12655
|
-
|
|
12656
|
-
|
|
12657
|
-
|
|
12658
|
-
|
|
12659
|
-
|
|
12660
|
-
|
|
12661
|
-
|
|
12662
|
-
const
|
|
12663
|
-
const
|
|
12664
|
-
|
|
12665
|
-
|
|
12676
|
+
getMotionGroups: async (cell: string, controller: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
12677
|
+
// verify required parameter 'cell' is not null or undefined
|
|
12678
|
+
assertParamExists('getMotionGroups', 'cell', cell)
|
|
12679
|
+
// verify required parameter 'controller' is not null or undefined
|
|
12680
|
+
assertParamExists('getMotionGroups', 'controller', controller)
|
|
12681
|
+
const localVarPath = `/cells/{cell}/virtual-controllers/{controller}/motion-groups`
|
|
12682
|
+
.replace(`{${"cell"}}`, encodeURIComponent(String(cell)))
|
|
12683
|
+
.replace(`{${"controller"}}`, encodeURIComponent(String(controller)));
|
|
12684
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
12685
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
12686
|
+
let baseOptions;
|
|
12687
|
+
if (configuration) {
|
|
12688
|
+
baseOptions = configuration.baseOptions;
|
|
12689
|
+
}
|
|
12690
|
+
|
|
12691
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
12692
|
+
const localVarHeaderParameter = {} as any;
|
|
12693
|
+
const localVarQueryParameter = {} as any;
|
|
12694
|
+
|
|
12695
|
+
// authentication BasicAuth required
|
|
12696
|
+
// http basic authentication required
|
|
12697
|
+
setBasicAuthToObject(localVarRequestOptions, configuration)
|
|
12698
|
+
|
|
12699
|
+
// authentication BearerAuth required
|
|
12700
|
+
// http bearer authentication required
|
|
12701
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
12702
|
+
|
|
12703
|
+
|
|
12704
|
+
|
|
12705
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
12706
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
12707
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
12708
|
+
|
|
12709
|
+
return {
|
|
12710
|
+
url: toPathString(localVarUrlObj),
|
|
12711
|
+
options: localVarRequestOptions,
|
|
12712
|
+
};
|
|
12666
12713
|
},
|
|
12667
12714
|
/**
|
|
12668
|
-
*
|
|
12669
|
-
* @summary
|
|
12715
|
+
* Requests the Operation Mode of the virtual robot controller. To get the Operation Mode regardless of the controller type use [getCurrentMotionGroupState](getCurrentMotionGroupState). **Note:** The Operating Mode can only change be changed via API when using virtual robot controllers.
|
|
12716
|
+
* @summary Get Operation Mode
|
|
12670
12717
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
12671
12718
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
12672
|
-
* @param {Array<string>} [ios]
|
|
12673
|
-
* @param {IODirection} [direction] Return only inputs/outputs with the specified direction.
|
|
12674
|
-
* @param {IOValueType} [valueType] Return only inputs/outputs with the specified value type.
|
|
12675
|
-
* @param {string} [group] Return only inputs/outputs from the specified group.
|
|
12676
12719
|
* @param {*} [options] Override http request option.
|
|
12677
12720
|
* @throws {RequiredError}
|
|
12678
12721
|
*/
|
|
12679
|
-
async
|
|
12680
|
-
|
|
12681
|
-
|
|
12682
|
-
|
|
12683
|
-
|
|
12722
|
+
getOperationMode: async (cell: string, controller: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
12723
|
+
// verify required parameter 'cell' is not null or undefined
|
|
12724
|
+
assertParamExists('getOperationMode', 'cell', cell)
|
|
12725
|
+
// verify required parameter 'controller' is not null or undefined
|
|
12726
|
+
assertParamExists('getOperationMode', 'controller', controller)
|
|
12727
|
+
const localVarPath = `/cells/{cell}/virtual-controllers/{controller}/operationmode`
|
|
12728
|
+
.replace(`{${"cell"}}`, encodeURIComponent(String(cell)))
|
|
12729
|
+
.replace(`{${"controller"}}`, encodeURIComponent(String(controller)));
|
|
12730
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
12731
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
12732
|
+
let baseOptions;
|
|
12733
|
+
if (configuration) {
|
|
12734
|
+
baseOptions = configuration.baseOptions;
|
|
12735
|
+
}
|
|
12736
|
+
|
|
12737
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
12738
|
+
const localVarHeaderParameter = {} as any;
|
|
12739
|
+
const localVarQueryParameter = {} as any;
|
|
12740
|
+
|
|
12741
|
+
// authentication BasicAuth required
|
|
12742
|
+
// http basic authentication required
|
|
12743
|
+
setBasicAuthToObject(localVarRequestOptions, configuration)
|
|
12744
|
+
|
|
12745
|
+
// authentication BearerAuth required
|
|
12746
|
+
// http bearer authentication required
|
|
12747
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
12748
|
+
|
|
12749
|
+
|
|
12750
|
+
|
|
12751
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
12752
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
12753
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
12754
|
+
|
|
12755
|
+
return {
|
|
12756
|
+
url: toPathString(localVarUrlObj),
|
|
12757
|
+
options: localVarRequestOptions,
|
|
12758
|
+
};
|
|
12684
12759
|
},
|
|
12685
12760
|
/**
|
|
12686
|
-
*
|
|
12687
|
-
* @summary
|
|
12761
|
+
* Gets motion group mounting. The motion group is based on the origin of the returned coordinate system.
|
|
12762
|
+
* @summary Get Mounting
|
|
12688
12763
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
12689
12764
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
12690
|
-
* @param {
|
|
12765
|
+
* @param {string} motionGroup The motion-group identifier.
|
|
12691
12766
|
* @param {*} [options] Override http request option.
|
|
12692
12767
|
* @throws {RequiredError}
|
|
12693
12768
|
*/
|
|
12694
|
-
async
|
|
12695
|
-
|
|
12696
|
-
|
|
12697
|
-
|
|
12698
|
-
|
|
12769
|
+
getVirtualRobotMounting: async (cell: string, controller: string, motionGroup: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
12770
|
+
// verify required parameter 'cell' is not null or undefined
|
|
12771
|
+
assertParamExists('getVirtualRobotMounting', 'cell', cell)
|
|
12772
|
+
// verify required parameter 'controller' is not null or undefined
|
|
12773
|
+
assertParamExists('getVirtualRobotMounting', 'controller', controller)
|
|
12774
|
+
// verify required parameter 'motionGroup' is not null or undefined
|
|
12775
|
+
assertParamExists('getVirtualRobotMounting', 'motionGroup', motionGroup)
|
|
12776
|
+
const localVarPath = `/cells/{cell}/virtual-controllers/{controller}/motion-groups/{motion-group}/mounting`
|
|
12777
|
+
.replace(`{${"cell"}}`, encodeURIComponent(String(cell)))
|
|
12778
|
+
.replace(`{${"controller"}}`, encodeURIComponent(String(controller)))
|
|
12779
|
+
.replace(`{${"motion-group"}}`, encodeURIComponent(String(motionGroup)));
|
|
12780
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
12781
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
12782
|
+
let baseOptions;
|
|
12783
|
+
if (configuration) {
|
|
12784
|
+
baseOptions = configuration.baseOptions;
|
|
12785
|
+
}
|
|
12786
|
+
|
|
12787
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
12788
|
+
const localVarHeaderParameter = {} as any;
|
|
12789
|
+
const localVarQueryParameter = {} as any;
|
|
12790
|
+
|
|
12791
|
+
// authentication BasicAuth required
|
|
12792
|
+
// http basic authentication required
|
|
12793
|
+
setBasicAuthToObject(localVarRequestOptions, configuration)
|
|
12794
|
+
|
|
12795
|
+
// authentication BearerAuth required
|
|
12796
|
+
// http bearer authentication required
|
|
12797
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
12798
|
+
|
|
12799
|
+
|
|
12800
|
+
|
|
12801
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
12802
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
12803
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
12804
|
+
|
|
12805
|
+
return {
|
|
12806
|
+
url: toPathString(localVarUrlObj),
|
|
12807
|
+
options: localVarRequestOptions,
|
|
12808
|
+
};
|
|
12699
12809
|
},
|
|
12700
12810
|
/**
|
|
12701
|
-
*
|
|
12702
|
-
* @summary
|
|
12811
|
+
* Lists all coordinate systems on the robot controller.
|
|
12812
|
+
* @summary List Coordinate Systems
|
|
12703
12813
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
12704
12814
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
12705
|
-
* @param {string} motionGroup The motion-group identifier.
|
|
12706
|
-
* @param {MotionGroupJoints} motionGroupJoints
|
|
12707
12815
|
* @param {*} [options] Override http request option.
|
|
12708
12816
|
* @throws {RequiredError}
|
|
12709
12817
|
*/
|
|
12710
|
-
async
|
|
12711
|
-
|
|
12712
|
-
|
|
12713
|
-
|
|
12714
|
-
|
|
12715
|
-
|
|
12716
|
-
|
|
12717
|
-
};
|
|
12718
|
-
|
|
12719
|
-
|
|
12720
|
-
|
|
12721
|
-
|
|
12722
|
-
|
|
12723
|
-
|
|
12724
|
-
const localVarFp = VirtualRobotApiFp(configuration)
|
|
12725
|
-
return {
|
|
12726
|
-
/**
|
|
12727
|
-
* Get the current motion group state which provides values for the joints\' position, velocity and acceleration.
|
|
12728
|
-
* @summary Get Motion Group State
|
|
12729
|
-
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
12730
|
-
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
12731
|
-
* @param {string} motionGroup The motion-group identifier.
|
|
12732
|
-
* @param {*} [options] Override http request option.
|
|
12733
|
-
* @throws {RequiredError}
|
|
12734
|
-
*/
|
|
12735
|
-
getMotionGroupState(cell: string, controller: string, motionGroup: string, options?: RawAxiosRequestConfig): AxiosPromise<MotionGroupJoints> {
|
|
12736
|
-
return localVarFp.getMotionGroupState(cell, controller, motionGroup, options).then((request) => request(axios, basePath));
|
|
12737
|
-
},
|
|
12738
|
-
/**
|
|
12739
|
-
* Gets information on the motion group.
|
|
12740
|
-
* @summary Motion Group Description
|
|
12741
|
-
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
12742
|
-
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
12743
|
-
* @param {*} [options] Override http request option.
|
|
12744
|
-
* @throws {RequiredError}
|
|
12745
|
-
*/
|
|
12746
|
-
getMotionGroups(cell: string, controller: string, options?: RawAxiosRequestConfig): AxiosPromise<MotionGroupInfos> {
|
|
12747
|
-
return localVarFp.getMotionGroups(cell, controller, options).then((request) => request(axios, basePath));
|
|
12748
|
-
},
|
|
12749
|
-
/**
|
|
12750
|
-
* Retrieves the current values of inputs/outputs of the virtual controller. The identifiers of inputs/outputs must be provided in the request. Request all available input/output identifiers via [listVirtualRobotIODescriptions](listVirtualRobotIODescriptions).
|
|
12751
|
-
* @summary Get Inputs/Outputs
|
|
12752
|
-
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
12753
|
-
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
12754
|
-
* @param {Array<string>} ios
|
|
12755
|
-
* @param {*} [options] Override http request option.
|
|
12756
|
-
* @throws {RequiredError}
|
|
12757
|
-
*/
|
|
12758
|
-
listIOs(cell: string, controller: string, ios: Array<string>, options?: RawAxiosRequestConfig): AxiosPromise<Array<IOValue>> {
|
|
12759
|
-
return localVarFp.listIOs(cell, controller, ios, options).then((request) => request(axios, basePath));
|
|
12760
|
-
},
|
|
12761
|
-
/**
|
|
12762
|
-
* Lists the input/output descriptions of the virtual robot controller. The input/output descriptions contain information like name, type and unit. Available inputs/outputs are defined by the virtual robot controller. Each input/output has a unique identifier. If no identifiers are specified in the request, all available inputs/outputs are retrieved by this endpoint. Exception: When a filter (e.g., direction, value_type, group) is applied, only matching inputs/outputs are returned.
|
|
12763
|
-
* @summary List Input/Output Descriptions
|
|
12764
|
-
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
12765
|
-
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
12766
|
-
* @param {Array<string>} [ios]
|
|
12767
|
-
* @param {IODirection} [direction] Return only inputs/outputs with the specified direction.
|
|
12768
|
-
* @param {IOValueType} [valueType] Return only inputs/outputs with the specified value type.
|
|
12769
|
-
* @param {string} [group] Return only inputs/outputs from the specified group.
|
|
12770
|
-
* @param {*} [options] Override http request option.
|
|
12771
|
-
* @throws {RequiredError}
|
|
12772
|
-
*/
|
|
12773
|
-
listVirtualRobotIODescriptions(cell: string, controller: string, ios?: Array<string>, direction?: IODirection, valueType?: IOValueType, group?: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<IODescription>> {
|
|
12774
|
-
return localVarFp.listVirtualRobotIODescriptions(cell, controller, ios, direction, valueType, group, options).then((request) => request(axios, basePath));
|
|
12775
|
-
},
|
|
12776
|
-
/**
|
|
12777
|
-
* Sets a list of values of a virtual controller inputs/outputs.
|
|
12778
|
-
* @summary Set Input/Ouput Values
|
|
12779
|
-
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
12780
|
-
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
12781
|
-
* @param {Array<IOValue>} iOValue
|
|
12782
|
-
* @param {*} [options] Override http request option.
|
|
12783
|
-
* @throws {RequiredError}
|
|
12784
|
-
*/
|
|
12785
|
-
setIOValues(cell: string, controller: string, iOValue: Array<IOValue>, options?: RawAxiosRequestConfig): AxiosPromise<void> {
|
|
12786
|
-
return localVarFp.setIOValues(cell, controller, iOValue, options).then((request) => request(axios, basePath));
|
|
12787
|
-
},
|
|
12788
|
-
/**
|
|
12789
|
-
* Sets the values for joint position, joint velocity or joint acceleration of a motion group state. The values are immediately applied to the joints of the motion group. We recommend to only use the endpoint when the motion group is in monitor mode. In case the motion group is controlled, currently jogging or planning motions, the values are overridden by the controller or an error may occur.
|
|
12790
|
-
* @summary Set Motion Group State
|
|
12791
|
-
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
12792
|
-
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
12793
|
-
* @param {string} motionGroup The motion-group identifier.
|
|
12794
|
-
* @param {MotionGroupJoints} motionGroupJoints
|
|
12795
|
-
* @param {*} [options] Override http request option.
|
|
12796
|
-
* @throws {RequiredError}
|
|
12797
|
-
*/
|
|
12798
|
-
setMotionGroupState(cell: string, controller: string, motionGroup: string, motionGroupJoints: MotionGroupJoints, options?: RawAxiosRequestConfig): AxiosPromise<void> {
|
|
12799
|
-
return localVarFp.setMotionGroupState(cell, controller, motionGroup, motionGroupJoints, options).then((request) => request(axios, basePath));
|
|
12800
|
-
},
|
|
12801
|
-
};
|
|
12802
|
-
};
|
|
12803
|
-
|
|
12804
|
-
/**
|
|
12805
|
-
* VirtualRobotApi - object-oriented interface
|
|
12806
|
-
* @export
|
|
12807
|
-
* @class VirtualRobotApi
|
|
12808
|
-
* @extends {BaseAPI}
|
|
12809
|
-
*/
|
|
12810
|
-
export class VirtualRobotApi extends BaseAPI {
|
|
12811
|
-
/**
|
|
12812
|
-
* Get the current motion group state which provides values for the joints\' position, velocity and acceleration.
|
|
12813
|
-
* @summary Get Motion Group State
|
|
12814
|
-
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
12815
|
-
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
12816
|
-
* @param {string} motionGroup The motion-group identifier.
|
|
12817
|
-
* @param {*} [options] Override http request option.
|
|
12818
|
-
* @throws {RequiredError}
|
|
12819
|
-
* @memberof VirtualRobotApi
|
|
12820
|
-
*/
|
|
12821
|
-
public getMotionGroupState(cell: string, controller: string, motionGroup: string, options?: RawAxiosRequestConfig) {
|
|
12822
|
-
return VirtualRobotApiFp(this.configuration).getMotionGroupState(cell, controller, motionGroup, options).then((request) => request(this.axios, this.basePath));
|
|
12823
|
-
}
|
|
12824
|
-
|
|
12825
|
-
/**
|
|
12826
|
-
* Gets information on the motion group.
|
|
12827
|
-
* @summary Motion Group Description
|
|
12828
|
-
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
12829
|
-
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
12830
|
-
* @param {*} [options] Override http request option.
|
|
12831
|
-
* @throws {RequiredError}
|
|
12832
|
-
* @memberof VirtualRobotApi
|
|
12833
|
-
*/
|
|
12834
|
-
public getMotionGroups(cell: string, controller: string, options?: RawAxiosRequestConfig) {
|
|
12835
|
-
return VirtualRobotApiFp(this.configuration).getMotionGroups(cell, controller, options).then((request) => request(this.axios, this.basePath));
|
|
12836
|
-
}
|
|
12837
|
-
|
|
12838
|
-
/**
|
|
12839
|
-
* Retrieves the current values of inputs/outputs of the virtual controller. The identifiers of inputs/outputs must be provided in the request. Request all available input/output identifiers via [listVirtualRobotIODescriptions](listVirtualRobotIODescriptions).
|
|
12840
|
-
* @summary Get Inputs/Outputs
|
|
12841
|
-
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
12842
|
-
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
12843
|
-
* @param {Array<string>} ios
|
|
12844
|
-
* @param {*} [options] Override http request option.
|
|
12845
|
-
* @throws {RequiredError}
|
|
12846
|
-
* @memberof VirtualRobotApi
|
|
12847
|
-
*/
|
|
12848
|
-
public listIOs(cell: string, controller: string, ios: Array<string>, options?: RawAxiosRequestConfig) {
|
|
12849
|
-
return VirtualRobotApiFp(this.configuration).listIOs(cell, controller, ios, options).then((request) => request(this.axios, this.basePath));
|
|
12850
|
-
}
|
|
12818
|
+
listVirtualRobotCoordinateSystems: async (cell: string, controller: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
12819
|
+
// verify required parameter 'cell' is not null or undefined
|
|
12820
|
+
assertParamExists('listVirtualRobotCoordinateSystems', 'cell', cell)
|
|
12821
|
+
// verify required parameter 'controller' is not null or undefined
|
|
12822
|
+
assertParamExists('listVirtualRobotCoordinateSystems', 'controller', controller)
|
|
12823
|
+
const localVarPath = `/cells/{cell}/virtual-controllers/{controller}/coordinate-systems`
|
|
12824
|
+
.replace(`{${"cell"}}`, encodeURIComponent(String(cell)))
|
|
12825
|
+
.replace(`{${"controller"}}`, encodeURIComponent(String(controller)));
|
|
12826
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
12827
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
12828
|
+
let baseOptions;
|
|
12829
|
+
if (configuration) {
|
|
12830
|
+
baseOptions = configuration.baseOptions;
|
|
12831
|
+
}
|
|
12851
12832
|
|
|
12852
|
-
|
|
12853
|
-
|
|
12854
|
-
|
|
12855
|
-
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
12856
|
-
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
12857
|
-
* @param {Array<string>} [ios]
|
|
12858
|
-
* @param {IODirection} [direction] Return only inputs/outputs with the specified direction.
|
|
12859
|
-
* @param {IOValueType} [valueType] Return only inputs/outputs with the specified value type.
|
|
12860
|
-
* @param {string} [group] Return only inputs/outputs from the specified group.
|
|
12861
|
-
* @param {*} [options] Override http request option.
|
|
12862
|
-
* @throws {RequiredError}
|
|
12863
|
-
* @memberof VirtualRobotApi
|
|
12864
|
-
*/
|
|
12865
|
-
public listVirtualRobotIODescriptions(cell: string, controller: string, ios?: Array<string>, direction?: IODirection, valueType?: IOValueType, group?: string, options?: RawAxiosRequestConfig) {
|
|
12866
|
-
return VirtualRobotApiFp(this.configuration).listVirtualRobotIODescriptions(cell, controller, ios, direction, valueType, group, options).then((request) => request(this.axios, this.basePath));
|
|
12867
|
-
}
|
|
12833
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
12834
|
+
const localVarHeaderParameter = {} as any;
|
|
12835
|
+
const localVarQueryParameter = {} as any;
|
|
12868
12836
|
|
|
12869
|
-
|
|
12870
|
-
|
|
12871
|
-
|
|
12872
|
-
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
12873
|
-
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
12874
|
-
* @param {Array<IOValue>} iOValue
|
|
12875
|
-
* @param {*} [options] Override http request option.
|
|
12876
|
-
* @throws {RequiredError}
|
|
12877
|
-
* @memberof VirtualRobotApi
|
|
12878
|
-
*/
|
|
12879
|
-
public setIOValues(cell: string, controller: string, iOValue: Array<IOValue>, options?: RawAxiosRequestConfig) {
|
|
12880
|
-
return VirtualRobotApiFp(this.configuration).setIOValues(cell, controller, iOValue, options).then((request) => request(this.axios, this.basePath));
|
|
12881
|
-
}
|
|
12837
|
+
// authentication BasicAuth required
|
|
12838
|
+
// http basic authentication required
|
|
12839
|
+
setBasicAuthToObject(localVarRequestOptions, configuration)
|
|
12882
12840
|
|
|
12883
|
-
|
|
12884
|
-
|
|
12885
|
-
|
|
12886
|
-
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
12887
|
-
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
12888
|
-
* @param {string} motionGroup The motion-group identifier.
|
|
12889
|
-
* @param {MotionGroupJoints} motionGroupJoints
|
|
12890
|
-
* @param {*} [options] Override http request option.
|
|
12891
|
-
* @throws {RequiredError}
|
|
12892
|
-
* @memberof VirtualRobotApi
|
|
12893
|
-
*/
|
|
12894
|
-
public setMotionGroupState(cell: string, controller: string, motionGroup: string, motionGroupJoints: MotionGroupJoints, options?: RawAxiosRequestConfig) {
|
|
12895
|
-
return VirtualRobotApiFp(this.configuration).setMotionGroupState(cell, controller, motionGroup, motionGroupJoints, options).then((request) => request(this.axios, this.basePath));
|
|
12896
|
-
}
|
|
12897
|
-
}
|
|
12841
|
+
// authentication BearerAuth required
|
|
12842
|
+
// http bearer authentication required
|
|
12843
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
12898
12844
|
|
|
12899
12845
|
|
|
12846
|
+
|
|
12847
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
12848
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
12849
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
12900
12850
|
|
|
12901
|
-
|
|
12902
|
-
|
|
12903
|
-
|
|
12904
|
-
|
|
12905
|
-
|
|
12906
|
-
return {
|
|
12851
|
+
return {
|
|
12852
|
+
url: toPathString(localVarUrlObj),
|
|
12853
|
+
options: localVarRequestOptions,
|
|
12854
|
+
};
|
|
12855
|
+
},
|
|
12907
12856
|
/**
|
|
12908
|
-
*
|
|
12909
|
-
* @summary
|
|
12857
|
+
* Lists TCPs of the motion group. An empty TCP list is valid, for example for external axes.
|
|
12858
|
+
* @summary List TCPs
|
|
12910
12859
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
12911
12860
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
12912
|
-
* @param {
|
|
12861
|
+
* @param {string} motionGroup The motion-group identifier.
|
|
12913
12862
|
* @param {*} [options] Override http request option.
|
|
12914
12863
|
* @throws {RequiredError}
|
|
12915
12864
|
*/
|
|
12916
|
-
|
|
12865
|
+
listVirtualRobotTcps: async (cell: string, controller: string, motionGroup: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
12917
12866
|
// verify required parameter 'cell' is not null or undefined
|
|
12918
|
-
assertParamExists('
|
|
12867
|
+
assertParamExists('listVirtualRobotTcps', 'cell', cell)
|
|
12919
12868
|
// verify required parameter 'controller' is not null or undefined
|
|
12920
|
-
assertParamExists('
|
|
12921
|
-
// verify required parameter '
|
|
12922
|
-
assertParamExists('
|
|
12923
|
-
const localVarPath = `/cells/{cell}/controllers/{controller}/
|
|
12869
|
+
assertParamExists('listVirtualRobotTcps', 'controller', controller)
|
|
12870
|
+
// verify required parameter 'motionGroup' is not null or undefined
|
|
12871
|
+
assertParamExists('listVirtualRobotTcps', 'motionGroup', motionGroup)
|
|
12872
|
+
const localVarPath = `/cells/{cell}/virtual-controllers/{controller}/motion-groups/{motion-group}/tcps`
|
|
12924
12873
|
.replace(`{${"cell"}}`, encodeURIComponent(String(cell)))
|
|
12925
|
-
.replace(`{${"controller"}}`, encodeURIComponent(String(controller)))
|
|
12874
|
+
.replace(`{${"controller"}}`, encodeURIComponent(String(controller)))
|
|
12875
|
+
.replace(`{${"motion-group"}}`, encodeURIComponent(String(motionGroup)));
|
|
12926
12876
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
12927
12877
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
12928
12878
|
let baseOptions;
|
|
@@ -12944,12 +12894,9 @@ export const VirtualRobotBehaviorApiAxiosParamCreator = function (configuration?
|
|
|
12944
12894
|
|
|
12945
12895
|
|
|
12946
12896
|
|
|
12947
|
-
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
12948
|
-
|
|
12949
12897
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
12950
12898
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
12951
12899
|
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
12952
|
-
localVarRequestOptions.data = serializeDataIfNeeded(externalJointStreamDatapoint, localVarRequestOptions, configuration)
|
|
12953
12900
|
|
|
12954
12901
|
return {
|
|
12955
12902
|
url: toPathString(localVarUrlObj),
|
|
@@ -12957,25 +12904,22 @@ export const VirtualRobotBehaviorApiAxiosParamCreator = function (configuration?
|
|
|
12957
12904
|
};
|
|
12958
12905
|
},
|
|
12959
12906
|
/**
|
|
12960
|
-
*
|
|
12961
|
-
* @summary
|
|
12907
|
+
* Activates or releases the Emergency Stop on the virtual robot controller. Activating the Emergency Stop stops the execution of all motions. The stop is executed on physical controllers immediately not gracefully and not on paths. Due to restricted physical behavior of the virtual robot controller, the Emergency Stop is executed on paths. To return to normal operation the Emergency Stop needs to be released. Use [getCurrentMotionGroupState](getCurrentMotionGroupState) to get the Emergency Stop state regardless of the controller type. There the Emergency Stop state is visible as the `safety_state`. > **NOTE** > > The Emergency Stop state can only be changed via API when using virtual robot controllers.
|
|
12908
|
+
* @summary Push or Release Emergency Stop
|
|
12962
12909
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
12963
12910
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
12964
|
-
* @param {
|
|
12911
|
+
* @param {boolean} [active]
|
|
12965
12912
|
* @param {*} [options] Override http request option.
|
|
12966
12913
|
* @throws {RequiredError}
|
|
12967
12914
|
*/
|
|
12968
|
-
|
|
12915
|
+
setEmergencyStop: async (cell: string, controller: string, active?: boolean, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
12969
12916
|
// verify required parameter 'cell' is not null or undefined
|
|
12970
|
-
assertParamExists('
|
|
12917
|
+
assertParamExists('setEmergencyStop', 'cell', cell)
|
|
12971
12918
|
// verify required parameter 'controller' is not null or undefined
|
|
12972
|
-
assertParamExists('
|
|
12973
|
-
|
|
12974
|
-
assertParamExists('getMotionGroupBehavior', 'motionGroup', motionGroup)
|
|
12975
|
-
const localVarPath = `/cells/{cell}/controllers/{controller}/teach-pendant/motion-groups/{motion-group}/behavior`
|
|
12919
|
+
assertParamExists('setEmergencyStop', 'controller', controller)
|
|
12920
|
+
const localVarPath = `/cells/{cell}/virtual-controllers/{controller}/emergency-stop`
|
|
12976
12921
|
.replace(`{${"cell"}}`, encodeURIComponent(String(cell)))
|
|
12977
|
-
.replace(`{${"controller"}}`, encodeURIComponent(String(controller)))
|
|
12978
|
-
.replace(`{${"motion-group"}}`, encodeURIComponent(String(motionGroup)));
|
|
12922
|
+
.replace(`{${"controller"}}`, encodeURIComponent(String(controller)));
|
|
12979
12923
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
12980
12924
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
12981
12925
|
let baseOptions;
|
|
@@ -12983,7 +12927,7 @@ export const VirtualRobotBehaviorApiAxiosParamCreator = function (configuration?
|
|
|
12983
12927
|
baseOptions = configuration.baseOptions;
|
|
12984
12928
|
}
|
|
12985
12929
|
|
|
12986
|
-
const localVarRequestOptions = { method: '
|
|
12930
|
+
const localVarRequestOptions = { method: 'PUT', ...baseOptions, ...options};
|
|
12987
12931
|
const localVarHeaderParameter = {} as any;
|
|
12988
12932
|
const localVarQueryParameter = {} as any;
|
|
12989
12933
|
|
|
@@ -12995,6 +12939,10 @@ export const VirtualRobotBehaviorApiAxiosParamCreator = function (configuration?
|
|
|
12995
12939
|
// http bearer authentication required
|
|
12996
12940
|
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
12997
12941
|
|
|
12942
|
+
if (active !== undefined) {
|
|
12943
|
+
localVarQueryParameter['active'] = active;
|
|
12944
|
+
}
|
|
12945
|
+
|
|
12998
12946
|
|
|
12999
12947
|
|
|
13000
12948
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
@@ -13007,23 +12955,25 @@ export const VirtualRobotBehaviorApiAxiosParamCreator = function (configuration?
|
|
|
13007
12955
|
};
|
|
13008
12956
|
},
|
|
13009
12957
|
/**
|
|
13010
|
-
*
|
|
13011
|
-
* @summary
|
|
12958
|
+
* Sets the values for joint position, joint velocity or joint acceleration of a motion group state. The values are immediately applied to the joints of the motion group. We recommend to only use the endpoint when the motion group is in monitor mode. In case the motion group is controlled, currently jogging or planning motions, the values are overridden by the controller or an error may occur.
|
|
12959
|
+
* @summary Set Motion Group State
|
|
13012
12960
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
13013
12961
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
13014
12962
|
* @param {string} motionGroup The motion-group identifier.
|
|
13015
|
-
* @param {
|
|
12963
|
+
* @param {MotionGroupJoints} motionGroupJoints
|
|
13016
12964
|
* @param {*} [options] Override http request option.
|
|
13017
12965
|
* @throws {RequiredError}
|
|
13018
12966
|
*/
|
|
13019
|
-
|
|
12967
|
+
setMotionGroupState: async (cell: string, controller: string, motionGroup: string, motionGroupJoints: MotionGroupJoints, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
13020
12968
|
// verify required parameter 'cell' is not null or undefined
|
|
13021
|
-
assertParamExists('
|
|
12969
|
+
assertParamExists('setMotionGroupState', 'cell', cell)
|
|
13022
12970
|
// verify required parameter 'controller' is not null or undefined
|
|
13023
|
-
assertParamExists('
|
|
12971
|
+
assertParamExists('setMotionGroupState', 'controller', controller)
|
|
13024
12972
|
// verify required parameter 'motionGroup' is not null or undefined
|
|
13025
|
-
assertParamExists('
|
|
13026
|
-
|
|
12973
|
+
assertParamExists('setMotionGroupState', 'motionGroup', motionGroup)
|
|
12974
|
+
// verify required parameter 'motionGroupJoints' is not null or undefined
|
|
12975
|
+
assertParamExists('setMotionGroupState', 'motionGroupJoints', motionGroupJoints)
|
|
12976
|
+
const localVarPath = `/cells/{cell}/virtual-controllers/{controller}/motion-groups/{motion-group}/state`
|
|
13027
12977
|
.replace(`{${"cell"}}`, encodeURIComponent(String(cell)))
|
|
13028
12978
|
.replace(`{${"controller"}}`, encodeURIComponent(String(controller)))
|
|
13029
12979
|
.replace(`{${"motion-group"}}`, encodeURIComponent(String(motionGroup)));
|
|
@@ -13046,200 +12996,37 @@ export const VirtualRobotBehaviorApiAxiosParamCreator = function (configuration?
|
|
|
13046
12996
|
// http bearer authentication required
|
|
13047
12997
|
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
13048
12998
|
|
|
13049
|
-
if (behavior !== undefined) {
|
|
13050
|
-
localVarQueryParameter['behavior'] = behavior;
|
|
13051
|
-
}
|
|
13052
|
-
|
|
13053
12999
|
|
|
13054
13000
|
|
|
13001
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
13002
|
+
|
|
13055
13003
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
13056
13004
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
13057
13005
|
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
13006
|
+
localVarRequestOptions.data = serializeDataIfNeeded(motionGroupJoints, localVarRequestOptions, configuration)
|
|
13058
13007
|
|
|
13059
13008
|
return {
|
|
13060
13009
|
url: toPathString(localVarUrlObj),
|
|
13061
13010
|
options: localVarRequestOptions,
|
|
13062
13011
|
};
|
|
13063
13012
|
},
|
|
13064
|
-
}
|
|
13065
|
-
};
|
|
13066
|
-
|
|
13067
|
-
/**
|
|
13068
|
-
* VirtualRobotBehaviorApi - functional programming interface
|
|
13069
|
-
* @export
|
|
13070
|
-
*/
|
|
13071
|
-
export const VirtualRobotBehaviorApiFp = function(configuration?: Configuration) {
|
|
13072
|
-
const localVarAxiosParamCreator = VirtualRobotBehaviorApiAxiosParamCreator(configuration)
|
|
13073
|
-
return {
|
|
13074
|
-
/**
|
|
13075
|
-
* <!-- theme: danger --> > Websocket endpoint This stream provides the commanded joint state and sets a motion groups joint configuration, e.g. to move a motion group. The concept is that an application is using the Motion Service to move a motion group. The Motion Service is commanding the desired joint configuration of a motion group. Physical motion groups move to this joint configuration. With physical motion groups, this takes some time and only works if possible. And you have the *actual* joint state - the current real motion group configuration. Again, this stream is providing *commanded* joint state! It is __not__ providing the *actual* joint state! (Please file a request - if you need a stream of the *actual* joint state) When the virtual controller receives joint commands the joint configuration is immediately adapted to match the incoming joint configurations. CAUTION: Incoming joint configurations are not visualized and their velocity limits are not checked. we don\'t even check limits! Possible use cases are: 1. Creating a robotic application that dynamically adapts to the configured joints on the robot controller, using this stream to feed new joint configurations back to the motion group. The stream only sends data to the robot controller if a motion is executed. If the robot controller\'s joint configuration differs too much from the incoming joint configuration, a following error occurs. Joint configurations that result in following errors are executed only for motions with a low velocity. 2. Mimic Freedrive motions. <!-- theme: danger --> > **DANGER** > > If the incoming joint configuration is set to maximum velocity, the movement to reach this incoming joint configuration > will be executed with maximum speed regardless of safety zones and mechanical limits.
|
|
13076
|
-
* @summary Stream Joint Configuration
|
|
13077
|
-
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
13078
|
-
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
13079
|
-
* @param {ExternalJointStreamDatapoint} externalJointStreamDatapoint
|
|
13080
|
-
* @param {*} [options] Override http request option.
|
|
13081
|
-
* @throws {RequiredError}
|
|
13082
|
-
*/
|
|
13083
|
-
async externalJointsStream(cell: string, controller: string, externalJointStreamDatapoint: ExternalJointStreamDatapoint, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<MotionGroupJoints>> {
|
|
13084
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.externalJointsStream(cell, controller, externalJointStreamDatapoint, options);
|
|
13085
|
-
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
13086
|
-
const localVarOperationServerBasePath = operationServerMap['VirtualRobotBehaviorApi.externalJointsStream']?.[localVarOperationServerIndex]?.url;
|
|
13087
|
-
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
13088
|
-
},
|
|
13089
13013
|
/**
|
|
13090
|
-
*
|
|
13091
|
-
* @summary
|
|
13014
|
+
* Changes the Operation Mode of the virtual robot controller to the specified value. To get the Operation Mode regardless of the controller type use [getCurrentMotionGroupState](getCurrentMotionGroupState). > **NOTE** > > The Operating Mode can only change be changed via API when using virtual robot controllers.
|
|
13015
|
+
* @summary Set Operation Mode
|
|
13092
13016
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
13093
13017
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
13094
|
-
* @param {
|
|
13018
|
+
* @param {OperationMode} mode
|
|
13095
13019
|
* @param {*} [options] Override http request option.
|
|
13096
13020
|
* @throws {RequiredError}
|
|
13097
13021
|
*/
|
|
13098
|
-
async
|
|
13099
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.getMotionGroupBehavior(cell, controller, motionGroup, options);
|
|
13100
|
-
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
13101
|
-
const localVarOperationServerBasePath = operationServerMap['VirtualRobotBehaviorApi.getMotionGroupBehavior']?.[localVarOperationServerIndex]?.url;
|
|
13102
|
-
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
13103
|
-
},
|
|
13104
|
-
/**
|
|
13105
|
-
* Switch robot motion group behavior.
|
|
13106
|
-
* @summary Switch Behavior
|
|
13107
|
-
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
13108
|
-
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
13109
|
-
* @param {string} motionGroup The motion-group identifier.
|
|
13110
|
-
* @param {Behavior} [behavior]
|
|
13111
|
-
* @param {*} [options] Override http request option.
|
|
13112
|
-
* @throws {RequiredError}
|
|
13113
|
-
*/
|
|
13114
|
-
async setMotionGroupBehavior(cell: string, controller: string, motionGroup: string, behavior?: Behavior, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> {
|
|
13115
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.setMotionGroupBehavior(cell, controller, motionGroup, behavior, options);
|
|
13116
|
-
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
13117
|
-
const localVarOperationServerBasePath = operationServerMap['VirtualRobotBehaviorApi.setMotionGroupBehavior']?.[localVarOperationServerIndex]?.url;
|
|
13118
|
-
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
13119
|
-
},
|
|
13120
|
-
}
|
|
13121
|
-
};
|
|
13122
|
-
|
|
13123
|
-
/**
|
|
13124
|
-
* VirtualRobotBehaviorApi - factory interface
|
|
13125
|
-
* @export
|
|
13126
|
-
*/
|
|
13127
|
-
export const VirtualRobotBehaviorApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
|
|
13128
|
-
const localVarFp = VirtualRobotBehaviorApiFp(configuration)
|
|
13129
|
-
return {
|
|
13130
|
-
/**
|
|
13131
|
-
* <!-- theme: danger --> > Websocket endpoint This stream provides the commanded joint state and sets a motion groups joint configuration, e.g. to move a motion group. The concept is that an application is using the Motion Service to move a motion group. The Motion Service is commanding the desired joint configuration of a motion group. Physical motion groups move to this joint configuration. With physical motion groups, this takes some time and only works if possible. And you have the *actual* joint state - the current real motion group configuration. Again, this stream is providing *commanded* joint state! It is __not__ providing the *actual* joint state! (Please file a request - if you need a stream of the *actual* joint state) When the virtual controller receives joint commands the joint configuration is immediately adapted to match the incoming joint configurations. CAUTION: Incoming joint configurations are not visualized and their velocity limits are not checked. we don\'t even check limits! Possible use cases are: 1. Creating a robotic application that dynamically adapts to the configured joints on the robot controller, using this stream to feed new joint configurations back to the motion group. The stream only sends data to the robot controller if a motion is executed. If the robot controller\'s joint configuration differs too much from the incoming joint configuration, a following error occurs. Joint configurations that result in following errors are executed only for motions with a low velocity. 2. Mimic Freedrive motions. <!-- theme: danger --> > **DANGER** > > If the incoming joint configuration is set to maximum velocity, the movement to reach this incoming joint configuration > will be executed with maximum speed regardless of safety zones and mechanical limits.
|
|
13132
|
-
* @summary Stream Joint Configuration
|
|
13133
|
-
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
13134
|
-
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
13135
|
-
* @param {ExternalJointStreamDatapoint} externalJointStreamDatapoint
|
|
13136
|
-
* @param {*} [options] Override http request option.
|
|
13137
|
-
* @throws {RequiredError}
|
|
13138
|
-
*/
|
|
13139
|
-
externalJointsStream(cell: string, controller: string, externalJointStreamDatapoint: ExternalJointStreamDatapoint, options?: RawAxiosRequestConfig): AxiosPromise<MotionGroupJoints> {
|
|
13140
|
-
return localVarFp.externalJointsStream(cell, controller, externalJointStreamDatapoint, options).then((request) => request(axios, basePath));
|
|
13141
|
-
},
|
|
13142
|
-
/**
|
|
13143
|
-
* Get the current robot motion group behavior - please see the setter [setMotionGroupBehavior](setMotionGroupBehavior) and the enum for details.
|
|
13144
|
-
* @summary Behavior
|
|
13145
|
-
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
13146
|
-
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
13147
|
-
* @param {string} motionGroup The motion-group identifier.
|
|
13148
|
-
* @param {*} [options] Override http request option.
|
|
13149
|
-
* @throws {RequiredError}
|
|
13150
|
-
*/
|
|
13151
|
-
getMotionGroupBehavior(cell: string, controller: string, motionGroup: string, options?: RawAxiosRequestConfig): AxiosPromise<MotionGroupBehaviorGetter> {
|
|
13152
|
-
return localVarFp.getMotionGroupBehavior(cell, controller, motionGroup, options).then((request) => request(axios, basePath));
|
|
13153
|
-
},
|
|
13154
|
-
/**
|
|
13155
|
-
* Switch robot motion group behavior.
|
|
13156
|
-
* @summary Switch Behavior
|
|
13157
|
-
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
13158
|
-
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
13159
|
-
* @param {string} motionGroup The motion-group identifier.
|
|
13160
|
-
* @param {Behavior} [behavior]
|
|
13161
|
-
* @param {*} [options] Override http request option.
|
|
13162
|
-
* @throws {RequiredError}
|
|
13163
|
-
*/
|
|
13164
|
-
setMotionGroupBehavior(cell: string, controller: string, motionGroup: string, behavior?: Behavior, options?: RawAxiosRequestConfig): AxiosPromise<void> {
|
|
13165
|
-
return localVarFp.setMotionGroupBehavior(cell, controller, motionGroup, behavior, options).then((request) => request(axios, basePath));
|
|
13166
|
-
},
|
|
13167
|
-
};
|
|
13168
|
-
};
|
|
13169
|
-
|
|
13170
|
-
/**
|
|
13171
|
-
* VirtualRobotBehaviorApi - object-oriented interface
|
|
13172
|
-
* @export
|
|
13173
|
-
* @class VirtualRobotBehaviorApi
|
|
13174
|
-
* @extends {BaseAPI}
|
|
13175
|
-
*/
|
|
13176
|
-
export class VirtualRobotBehaviorApi extends BaseAPI {
|
|
13177
|
-
/**
|
|
13178
|
-
* <!-- theme: danger --> > Websocket endpoint This stream provides the commanded joint state and sets a motion groups joint configuration, e.g. to move a motion group. The concept is that an application is using the Motion Service to move a motion group. The Motion Service is commanding the desired joint configuration of a motion group. Physical motion groups move to this joint configuration. With physical motion groups, this takes some time and only works if possible. And you have the *actual* joint state - the current real motion group configuration. Again, this stream is providing *commanded* joint state! It is __not__ providing the *actual* joint state! (Please file a request - if you need a stream of the *actual* joint state) When the virtual controller receives joint commands the joint configuration is immediately adapted to match the incoming joint configurations. CAUTION: Incoming joint configurations are not visualized and their velocity limits are not checked. we don\'t even check limits! Possible use cases are: 1. Creating a robotic application that dynamically adapts to the configured joints on the robot controller, using this stream to feed new joint configurations back to the motion group. The stream only sends data to the robot controller if a motion is executed. If the robot controller\'s joint configuration differs too much from the incoming joint configuration, a following error occurs. Joint configurations that result in following errors are executed only for motions with a low velocity. 2. Mimic Freedrive motions. <!-- theme: danger --> > **DANGER** > > If the incoming joint configuration is set to maximum velocity, the movement to reach this incoming joint configuration > will be executed with maximum speed regardless of safety zones and mechanical limits.
|
|
13179
|
-
* @summary Stream Joint Configuration
|
|
13180
|
-
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
13181
|
-
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
13182
|
-
* @param {ExternalJointStreamDatapoint} externalJointStreamDatapoint
|
|
13183
|
-
* @param {*} [options] Override http request option.
|
|
13184
|
-
* @throws {RequiredError}
|
|
13185
|
-
* @memberof VirtualRobotBehaviorApi
|
|
13186
|
-
*/
|
|
13187
|
-
public externalJointsStream(cell: string, controller: string, externalJointStreamDatapoint: ExternalJointStreamDatapoint, options?: RawAxiosRequestConfig) {
|
|
13188
|
-
return VirtualRobotBehaviorApiFp(this.configuration).externalJointsStream(cell, controller, externalJointStreamDatapoint, options).then((request) => request(this.axios, this.basePath));
|
|
13189
|
-
}
|
|
13190
|
-
|
|
13191
|
-
/**
|
|
13192
|
-
* Get the current robot motion group behavior - please see the setter [setMotionGroupBehavior](setMotionGroupBehavior) and the enum for details.
|
|
13193
|
-
* @summary Behavior
|
|
13194
|
-
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
13195
|
-
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
13196
|
-
* @param {string} motionGroup The motion-group identifier.
|
|
13197
|
-
* @param {*} [options] Override http request option.
|
|
13198
|
-
* @throws {RequiredError}
|
|
13199
|
-
* @memberof VirtualRobotBehaviorApi
|
|
13200
|
-
*/
|
|
13201
|
-
public getMotionGroupBehavior(cell: string, controller: string, motionGroup: string, options?: RawAxiosRequestConfig) {
|
|
13202
|
-
return VirtualRobotBehaviorApiFp(this.configuration).getMotionGroupBehavior(cell, controller, motionGroup, options).then((request) => request(this.axios, this.basePath));
|
|
13203
|
-
}
|
|
13204
|
-
|
|
13205
|
-
/**
|
|
13206
|
-
* Switch robot motion group behavior.
|
|
13207
|
-
* @summary Switch Behavior
|
|
13208
|
-
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
13209
|
-
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
13210
|
-
* @param {string} motionGroup The motion-group identifier.
|
|
13211
|
-
* @param {Behavior} [behavior]
|
|
13212
|
-
* @param {*} [options] Override http request option.
|
|
13213
|
-
* @throws {RequiredError}
|
|
13214
|
-
* @memberof VirtualRobotBehaviorApi
|
|
13215
|
-
*/
|
|
13216
|
-
public setMotionGroupBehavior(cell: string, controller: string, motionGroup: string, behavior?: Behavior, options?: RawAxiosRequestConfig) {
|
|
13217
|
-
return VirtualRobotBehaviorApiFp(this.configuration).setMotionGroupBehavior(cell, controller, motionGroup, behavior, options).then((request) => request(this.axios, this.basePath));
|
|
13218
|
-
}
|
|
13219
|
-
}
|
|
13220
|
-
|
|
13221
|
-
|
|
13222
|
-
|
|
13223
|
-
/**
|
|
13224
|
-
* VirtualRobotModeApi - axios parameter creator
|
|
13225
|
-
* @export
|
|
13226
|
-
*/
|
|
13227
|
-
export const VirtualRobotModeApiAxiosParamCreator = function (configuration?: Configuration) {
|
|
13228
|
-
return {
|
|
13229
|
-
/**
|
|
13230
|
-
* Get the cycle time of controller communication in [ms].
|
|
13231
|
-
* @summary Cycle Time
|
|
13232
|
-
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
13233
|
-
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
13234
|
-
* @param {*} [options] Override http request option.
|
|
13235
|
-
* @throws {RequiredError}
|
|
13236
|
-
*/
|
|
13237
|
-
getCycleTime: async (cell: string, controller: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
13022
|
+
setOperationMode: async (cell: string, controller: string, mode: OperationMode, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
13238
13023
|
// verify required parameter 'cell' is not null or undefined
|
|
13239
|
-
assertParamExists('
|
|
13024
|
+
assertParamExists('setOperationMode', 'cell', cell)
|
|
13240
13025
|
// verify required parameter 'controller' is not null or undefined
|
|
13241
|
-
assertParamExists('
|
|
13242
|
-
|
|
13026
|
+
assertParamExists('setOperationMode', 'controller', controller)
|
|
13027
|
+
// verify required parameter 'mode' is not null or undefined
|
|
13028
|
+
assertParamExists('setOperationMode', 'mode', mode)
|
|
13029
|
+
const localVarPath = `/cells/{cell}/virtual-controllers/{controller}/operationmode`
|
|
13243
13030
|
.replace(`{${"cell"}}`, encodeURIComponent(String(cell)))
|
|
13244
13031
|
.replace(`{${"controller"}}`, encodeURIComponent(String(controller)));
|
|
13245
13032
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
@@ -13249,7 +13036,7 @@ export const VirtualRobotModeApiAxiosParamCreator = function (configuration?: Co
|
|
|
13249
13036
|
baseOptions = configuration.baseOptions;
|
|
13250
13037
|
}
|
|
13251
13038
|
|
|
13252
|
-
const localVarRequestOptions = { method: '
|
|
13039
|
+
const localVarRequestOptions = { method: 'PUT', ...baseOptions, ...options};
|
|
13253
13040
|
const localVarHeaderParameter = {} as any;
|
|
13254
13041
|
const localVarQueryParameter = {} as any;
|
|
13255
13042
|
|
|
@@ -13261,6 +13048,10 @@ export const VirtualRobotModeApiAxiosParamCreator = function (configuration?: Co
|
|
|
13261
13048
|
// http bearer authentication required
|
|
13262
13049
|
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
13263
13050
|
|
|
13051
|
+
if (mode !== undefined) {
|
|
13052
|
+
localVarQueryParameter['mode'] = mode;
|
|
13053
|
+
}
|
|
13054
|
+
|
|
13264
13055
|
|
|
13265
13056
|
|
|
13266
13057
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
@@ -13273,21 +13064,28 @@ export const VirtualRobotModeApiAxiosParamCreator = function (configuration?: Co
|
|
|
13273
13064
|
};
|
|
13274
13065
|
},
|
|
13275
13066
|
/**
|
|
13276
|
-
*
|
|
13277
|
-
* @summary
|
|
13067
|
+
* Sets motion group mounting by specifying a coordinate system. The motion group will be based on the coordinate system\'s origin. The coordinate system defines a transformation offset. The transformation offset is defined by a unique identifier, a name for front end usage and an offset in another coordinate system referenced by the unique identifier of the reference coordinate system.
|
|
13068
|
+
* @summary Set Mounting
|
|
13278
13069
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
13279
13070
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
13071
|
+
* @param {string} motionGroup The motion-group identifier.
|
|
13072
|
+
* @param {CoordinateSystem} coordinateSystem
|
|
13280
13073
|
* @param {*} [options] Override http request option.
|
|
13281
13074
|
* @throws {RequiredError}
|
|
13282
13075
|
*/
|
|
13283
|
-
|
|
13076
|
+
setVirtualRobotMounting: async (cell: string, controller: string, motionGroup: string, coordinateSystem: CoordinateSystem, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
13284
13077
|
// verify required parameter 'cell' is not null or undefined
|
|
13285
|
-
assertParamExists('
|
|
13078
|
+
assertParamExists('setVirtualRobotMounting', 'cell', cell)
|
|
13286
13079
|
// verify required parameter 'controller' is not null or undefined
|
|
13287
|
-
assertParamExists('
|
|
13288
|
-
|
|
13080
|
+
assertParamExists('setVirtualRobotMounting', 'controller', controller)
|
|
13081
|
+
// verify required parameter 'motionGroup' is not null or undefined
|
|
13082
|
+
assertParamExists('setVirtualRobotMounting', 'motionGroup', motionGroup)
|
|
13083
|
+
// verify required parameter 'coordinateSystem' is not null or undefined
|
|
13084
|
+
assertParamExists('setVirtualRobotMounting', 'coordinateSystem', coordinateSystem)
|
|
13085
|
+
const localVarPath = `/cells/{cell}/virtual-controllers/{controller}/motion-groups/{motion-group}/mounting`
|
|
13289
13086
|
.replace(`{${"cell"}}`, encodeURIComponent(String(cell)))
|
|
13290
|
-
.replace(`{${"controller"}}`, encodeURIComponent(String(controller)))
|
|
13087
|
+
.replace(`{${"controller"}}`, encodeURIComponent(String(controller)))
|
|
13088
|
+
.replace(`{${"motion-group"}}`, encodeURIComponent(String(motionGroup)));
|
|
13291
13089
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
13292
13090
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
13293
13091
|
let baseOptions;
|
|
@@ -13295,7 +13093,7 @@ export const VirtualRobotModeApiAxiosParamCreator = function (configuration?: Co
|
|
|
13295
13093
|
baseOptions = configuration.baseOptions;
|
|
13296
13094
|
}
|
|
13297
13095
|
|
|
13298
|
-
const localVarRequestOptions = { method: '
|
|
13096
|
+
const localVarRequestOptions = { method: 'PUT', ...baseOptions, ...options};
|
|
13299
13097
|
const localVarHeaderParameter = {} as any;
|
|
13300
13098
|
const localVarQueryParameter = {} as any;
|
|
13301
13099
|
|
|
@@ -13309,187 +13107,91 @@ export const VirtualRobotModeApiAxiosParamCreator = function (configuration?: Co
|
|
|
13309
13107
|
|
|
13310
13108
|
|
|
13311
13109
|
|
|
13110
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
13111
|
+
|
|
13312
13112
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
13313
13113
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
13314
13114
|
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
13115
|
+
localVarRequestOptions.data = serializeDataIfNeeded(coordinateSystem, localVarRequestOptions, configuration)
|
|
13315
13116
|
|
|
13316
13117
|
return {
|
|
13317
13118
|
url: toPathString(localVarUrlObj),
|
|
13318
13119
|
options: localVarRequestOptions,
|
|
13319
13120
|
};
|
|
13320
13121
|
},
|
|
13122
|
+
}
|
|
13123
|
+
};
|
|
13124
|
+
|
|
13125
|
+
/**
|
|
13126
|
+
* VirtualControllerApi - functional programming interface
|
|
13127
|
+
* @export
|
|
13128
|
+
*/
|
|
13129
|
+
export const VirtualControllerApiFp = function(configuration?: Configuration) {
|
|
13130
|
+
const localVarAxiosParamCreator = VirtualControllerApiAxiosParamCreator(configuration)
|
|
13131
|
+
return {
|
|
13321
13132
|
/**
|
|
13322
|
-
*
|
|
13323
|
-
* @summary
|
|
13133
|
+
* Adds a coordinate system to the robot controller.
|
|
13134
|
+
* @summary Add Coordinate Systems
|
|
13324
13135
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
13325
13136
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
13137
|
+
* @param {string} coordinateSystem Unique identifier addressing a coordinate system.
|
|
13138
|
+
* @param {CoordinateSystemData} coordinateSystemData
|
|
13326
13139
|
* @param {*} [options] Override http request option.
|
|
13327
13140
|
* @throws {RequiredError}
|
|
13328
13141
|
*/
|
|
13329
|
-
|
|
13330
|
-
|
|
13331
|
-
|
|
13332
|
-
|
|
13333
|
-
|
|
13334
|
-
const localVarPath = `/cells/{cell}/controllers/{controller}/teach-pendant/operationmode`
|
|
13335
|
-
.replace(`{${"cell"}}`, encodeURIComponent(String(cell)))
|
|
13336
|
-
.replace(`{${"controller"}}`, encodeURIComponent(String(controller)));
|
|
13337
|
-
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
13338
|
-
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
13339
|
-
let baseOptions;
|
|
13340
|
-
if (configuration) {
|
|
13341
|
-
baseOptions = configuration.baseOptions;
|
|
13342
|
-
}
|
|
13343
|
-
|
|
13344
|
-
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
13345
|
-
const localVarHeaderParameter = {} as any;
|
|
13346
|
-
const localVarQueryParameter = {} as any;
|
|
13347
|
-
|
|
13348
|
-
// authentication BasicAuth required
|
|
13349
|
-
// http basic authentication required
|
|
13350
|
-
setBasicAuthToObject(localVarRequestOptions, configuration)
|
|
13351
|
-
|
|
13352
|
-
// authentication BearerAuth required
|
|
13353
|
-
// http bearer authentication required
|
|
13354
|
-
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
13355
|
-
|
|
13356
|
-
|
|
13357
|
-
|
|
13358
|
-
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
13359
|
-
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
13360
|
-
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
13361
|
-
|
|
13362
|
-
return {
|
|
13363
|
-
url: toPathString(localVarUrlObj),
|
|
13364
|
-
options: localVarRequestOptions,
|
|
13365
|
-
};
|
|
13142
|
+
async addVirtualRobotCoordinateSystem(cell: string, controller: string, coordinateSystem: string, coordinateSystemData: CoordinateSystemData, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> {
|
|
13143
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.addVirtualRobotCoordinateSystem(cell, controller, coordinateSystem, coordinateSystemData, options);
|
|
13144
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
13145
|
+
const localVarOperationServerBasePath = operationServerMap['VirtualControllerApi.addVirtualRobotCoordinateSystem']?.[localVarOperationServerIndex]?.url;
|
|
13146
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
13366
13147
|
},
|
|
13367
13148
|
/**
|
|
13368
|
-
*
|
|
13369
|
-
* @summary
|
|
13149
|
+
* Adds a new TCP or updates an existing TCP in the motion group. The position and rotation values in the request body are defined within the flange’s coordinate system. > **NOTE** > > Ensure the TCP\'s position is within the robot\'s reach. Refer to the robot’s documentation or data sheet for details like joint limits or reach.
|
|
13150
|
+
* @summary Add TCP
|
|
13370
13151
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
13371
13152
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
13372
|
-
* @param {
|
|
13153
|
+
* @param {string} motionGroup The motion-group identifier.
|
|
13154
|
+
* @param {string} tcp The unique identifier of a TCP.
|
|
13155
|
+
* @param {RobotTcpData} robotTcpData
|
|
13373
13156
|
* @param {*} [options] Override http request option.
|
|
13374
13157
|
* @throws {RequiredError}
|
|
13375
13158
|
*/
|
|
13376
|
-
|
|
13377
|
-
|
|
13378
|
-
|
|
13379
|
-
|
|
13380
|
-
|
|
13381
|
-
const localVarPath = `/cells/{cell}/controllers/{controller}/teach-pendant/emergency-stop`
|
|
13382
|
-
.replace(`{${"cell"}}`, encodeURIComponent(String(cell)))
|
|
13383
|
-
.replace(`{${"controller"}}`, encodeURIComponent(String(controller)));
|
|
13384
|
-
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
13385
|
-
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
13386
|
-
let baseOptions;
|
|
13387
|
-
if (configuration) {
|
|
13388
|
-
baseOptions = configuration.baseOptions;
|
|
13389
|
-
}
|
|
13390
|
-
|
|
13391
|
-
const localVarRequestOptions = { method: 'PUT', ...baseOptions, ...options};
|
|
13392
|
-
const localVarHeaderParameter = {} as any;
|
|
13393
|
-
const localVarQueryParameter = {} as any;
|
|
13394
|
-
|
|
13395
|
-
// authentication BasicAuth required
|
|
13396
|
-
// http basic authentication required
|
|
13397
|
-
setBasicAuthToObject(localVarRequestOptions, configuration)
|
|
13398
|
-
|
|
13399
|
-
// authentication BearerAuth required
|
|
13400
|
-
// http bearer authentication required
|
|
13401
|
-
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
13402
|
-
|
|
13403
|
-
if (active !== undefined) {
|
|
13404
|
-
localVarQueryParameter['active'] = active;
|
|
13405
|
-
}
|
|
13406
|
-
|
|
13407
|
-
|
|
13408
|
-
|
|
13409
|
-
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
13410
|
-
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
13411
|
-
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
13412
|
-
|
|
13413
|
-
return {
|
|
13414
|
-
url: toPathString(localVarUrlObj),
|
|
13415
|
-
options: localVarRequestOptions,
|
|
13416
|
-
};
|
|
13159
|
+
async addVirtualRobotTcp(cell: string, controller: string, motionGroup: string, tcp: string, robotTcpData: RobotTcpData, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> {
|
|
13160
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.addVirtualRobotTcp(cell, controller, motionGroup, tcp, robotTcpData, options);
|
|
13161
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
13162
|
+
const localVarOperationServerBasePath = operationServerMap['VirtualControllerApi.addVirtualRobotTcp']?.[localVarOperationServerIndex]?.url;
|
|
13163
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
13417
13164
|
},
|
|
13418
13165
|
/**
|
|
13419
|
-
*
|
|
13420
|
-
* @summary
|
|
13166
|
+
* Deletes a coordinate system from the virtual controller. This will remove the coordinate system from the list of coordinate systems and remove all dependent coordinate systems which use the deleted coordinate system as reference.
|
|
13167
|
+
* @summary Remove Coordinate System
|
|
13421
13168
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
13422
13169
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
13423
|
-
* @param {
|
|
13170
|
+
* @param {string} coordinateSystem Unique identifier addressing a coordinate system.
|
|
13171
|
+
* @param {boolean} [deleteDependent] If true, all dependent coordinate systems will be deleted as well.
|
|
13424
13172
|
* @param {*} [options] Override http request option.
|
|
13425
13173
|
* @throws {RequiredError}
|
|
13426
13174
|
*/
|
|
13427
|
-
|
|
13428
|
-
|
|
13429
|
-
|
|
13430
|
-
|
|
13431
|
-
|
|
13432
|
-
// verify required parameter 'mode' is not null or undefined
|
|
13433
|
-
assertParamExists('setOperationMode', 'mode', mode)
|
|
13434
|
-
const localVarPath = `/cells/{cell}/controllers/{controller}/teach-pendant/operationmode`
|
|
13435
|
-
.replace(`{${"cell"}}`, encodeURIComponent(String(cell)))
|
|
13436
|
-
.replace(`{${"controller"}}`, encodeURIComponent(String(controller)));
|
|
13437
|
-
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
13438
|
-
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
13439
|
-
let baseOptions;
|
|
13440
|
-
if (configuration) {
|
|
13441
|
-
baseOptions = configuration.baseOptions;
|
|
13442
|
-
}
|
|
13443
|
-
|
|
13444
|
-
const localVarRequestOptions = { method: 'PUT', ...baseOptions, ...options};
|
|
13445
|
-
const localVarHeaderParameter = {} as any;
|
|
13446
|
-
const localVarQueryParameter = {} as any;
|
|
13447
|
-
|
|
13448
|
-
// authentication BasicAuth required
|
|
13449
|
-
// http basic authentication required
|
|
13450
|
-
setBasicAuthToObject(localVarRequestOptions, configuration)
|
|
13451
|
-
|
|
13452
|
-
// authentication BearerAuth required
|
|
13453
|
-
// http bearer authentication required
|
|
13454
|
-
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
13455
|
-
|
|
13456
|
-
if (mode !== undefined) {
|
|
13457
|
-
localVarQueryParameter['mode'] = mode;
|
|
13458
|
-
}
|
|
13459
|
-
|
|
13460
|
-
|
|
13461
|
-
|
|
13462
|
-
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
13463
|
-
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
13464
|
-
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
13465
|
-
|
|
13466
|
-
return {
|
|
13467
|
-
url: toPathString(localVarUrlObj),
|
|
13468
|
-
options: localVarRequestOptions,
|
|
13469
|
-
};
|
|
13175
|
+
async deleteVirtualRobotCoordinateSystem(cell: string, controller: string, coordinateSystem: string, deleteDependent?: boolean, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> {
|
|
13176
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.deleteVirtualRobotCoordinateSystem(cell, controller, coordinateSystem, deleteDependent, options);
|
|
13177
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
13178
|
+
const localVarOperationServerBasePath = operationServerMap['VirtualControllerApi.deleteVirtualRobotCoordinateSystem']?.[localVarOperationServerIndex]?.url;
|
|
13179
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
13470
13180
|
},
|
|
13471
|
-
}
|
|
13472
|
-
};
|
|
13473
|
-
|
|
13474
|
-
/**
|
|
13475
|
-
* VirtualRobotModeApi - functional programming interface
|
|
13476
|
-
* @export
|
|
13477
|
-
*/
|
|
13478
|
-
export const VirtualRobotModeApiFp = function(configuration?: Configuration) {
|
|
13479
|
-
const localVarAxiosParamCreator = VirtualRobotModeApiAxiosParamCreator(configuration)
|
|
13480
|
-
return {
|
|
13481
13181
|
/**
|
|
13482
|
-
*
|
|
13483
|
-
* @summary
|
|
13182
|
+
* Removes the TCP from the motion group. An unknown TCP is a valid input.
|
|
13183
|
+
* @summary Remove TCP
|
|
13484
13184
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
13485
13185
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
13186
|
+
* @param {string} motionGroup The motion-group identifier.
|
|
13187
|
+
* @param {string} tcp The unique identifier of a TCP.
|
|
13486
13188
|
* @param {*} [options] Override http request option.
|
|
13487
13189
|
* @throws {RequiredError}
|
|
13488
13190
|
*/
|
|
13489
|
-
async
|
|
13490
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.
|
|
13191
|
+
async deleteVirtualRobotTcp(cell: string, controller: string, motionGroup: string, tcp: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> {
|
|
13192
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.deleteVirtualRobotTcp(cell, controller, motionGroup, tcp, options);
|
|
13491
13193
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
13492
|
-
const localVarOperationServerBasePath = operationServerMap['
|
|
13194
|
+
const localVarOperationServerBasePath = operationServerMap['VirtualControllerApi.deleteVirtualRobotTcp']?.[localVarOperationServerIndex]?.url;
|
|
13493
13195
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
13494
13196
|
},
|
|
13495
13197
|
/**
|
|
@@ -13503,7 +13205,36 @@ export const VirtualRobotModeApiFp = function(configuration?: Configuration) {
|
|
|
13503
13205
|
async getEmergencyStop(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Flag>> {
|
|
13504
13206
|
const localVarAxiosArgs = await localVarAxiosParamCreator.getEmergencyStop(cell, controller, options);
|
|
13505
13207
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
13506
|
-
const localVarOperationServerBasePath = operationServerMap['
|
|
13208
|
+
const localVarOperationServerBasePath = operationServerMap['VirtualControllerApi.getEmergencyStop']?.[localVarOperationServerIndex]?.url;
|
|
13209
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
13210
|
+
},
|
|
13211
|
+
/**
|
|
13212
|
+
* Get the current motion group state which provides values for the joints\' position, velocity and acceleration.
|
|
13213
|
+
* @summary Get Motion Group State
|
|
13214
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
13215
|
+
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
13216
|
+
* @param {string} motionGroup The motion-group identifier.
|
|
13217
|
+
* @param {*} [options] Override http request option.
|
|
13218
|
+
* @throws {RequiredError}
|
|
13219
|
+
*/
|
|
13220
|
+
async getMotionGroupState(cell: string, controller: string, motionGroup: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<MotionGroupJoints>> {
|
|
13221
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.getMotionGroupState(cell, controller, motionGroup, options);
|
|
13222
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
13223
|
+
const localVarOperationServerBasePath = operationServerMap['VirtualControllerApi.getMotionGroupState']?.[localVarOperationServerIndex]?.url;
|
|
13224
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
13225
|
+
},
|
|
13226
|
+
/**
|
|
13227
|
+
* Gets information on the motion group.
|
|
13228
|
+
* @summary Motion Group Description
|
|
13229
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
13230
|
+
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
13231
|
+
* @param {*} [options] Override http request option.
|
|
13232
|
+
* @throws {RequiredError}
|
|
13233
|
+
*/
|
|
13234
|
+
async getMotionGroups(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<MotionGroupInfo>>> {
|
|
13235
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.getMotionGroups(cell, controller, options);
|
|
13236
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
13237
|
+
const localVarOperationServerBasePath = operationServerMap['VirtualControllerApi.getMotionGroups']?.[localVarOperationServerIndex]?.url;
|
|
13507
13238
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
13508
13239
|
},
|
|
13509
13240
|
/**
|
|
@@ -13517,7 +13248,51 @@ export const VirtualRobotModeApiFp = function(configuration?: Configuration) {
|
|
|
13517
13248
|
async getOperationMode(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<OpMode>> {
|
|
13518
13249
|
const localVarAxiosArgs = await localVarAxiosParamCreator.getOperationMode(cell, controller, options);
|
|
13519
13250
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
13520
|
-
const localVarOperationServerBasePath = operationServerMap['
|
|
13251
|
+
const localVarOperationServerBasePath = operationServerMap['VirtualControllerApi.getOperationMode']?.[localVarOperationServerIndex]?.url;
|
|
13252
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
13253
|
+
},
|
|
13254
|
+
/**
|
|
13255
|
+
* Gets motion group mounting. The motion group is based on the origin of the returned coordinate system.
|
|
13256
|
+
* @summary Get Mounting
|
|
13257
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
13258
|
+
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
13259
|
+
* @param {string} motionGroup The motion-group identifier.
|
|
13260
|
+
* @param {*} [options] Override http request option.
|
|
13261
|
+
* @throws {RequiredError}
|
|
13262
|
+
*/
|
|
13263
|
+
async getVirtualRobotMounting(cell: string, controller: string, motionGroup: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CoordinateSystem>> {
|
|
13264
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.getVirtualRobotMounting(cell, controller, motionGroup, options);
|
|
13265
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
13266
|
+
const localVarOperationServerBasePath = operationServerMap['VirtualControllerApi.getVirtualRobotMounting']?.[localVarOperationServerIndex]?.url;
|
|
13267
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
13268
|
+
},
|
|
13269
|
+
/**
|
|
13270
|
+
* Lists all coordinate systems on the robot controller.
|
|
13271
|
+
* @summary List Coordinate Systems
|
|
13272
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
13273
|
+
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
13274
|
+
* @param {*} [options] Override http request option.
|
|
13275
|
+
* @throws {RequiredError}
|
|
13276
|
+
*/
|
|
13277
|
+
async listVirtualRobotCoordinateSystems(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<CoordinateSystem>>> {
|
|
13278
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.listVirtualRobotCoordinateSystems(cell, controller, options);
|
|
13279
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
13280
|
+
const localVarOperationServerBasePath = operationServerMap['VirtualControllerApi.listVirtualRobotCoordinateSystems']?.[localVarOperationServerIndex]?.url;
|
|
13281
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
13282
|
+
},
|
|
13283
|
+
/**
|
|
13284
|
+
* Lists TCPs of the motion group. An empty TCP list is valid, for example for external axes.
|
|
13285
|
+
* @summary List TCPs
|
|
13286
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
13287
|
+
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
13288
|
+
* @param {string} motionGroup The motion-group identifier.
|
|
13289
|
+
* @param {*} [options] Override http request option.
|
|
13290
|
+
* @throws {RequiredError}
|
|
13291
|
+
*/
|
|
13292
|
+
async listVirtualRobotTcps(cell: string, controller: string, motionGroup: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<RobotTcp>>> {
|
|
13293
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.listVirtualRobotTcps(cell, controller, motionGroup, options);
|
|
13294
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
13295
|
+
const localVarOperationServerBasePath = operationServerMap['VirtualControllerApi.listVirtualRobotTcps']?.[localVarOperationServerIndex]?.url;
|
|
13521
13296
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
13522
13297
|
},
|
|
13523
13298
|
/**
|
|
@@ -13532,7 +13307,23 @@ export const VirtualRobotModeApiFp = function(configuration?: Configuration) {
|
|
|
13532
13307
|
async setEmergencyStop(cell: string, controller: string, active?: boolean, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> {
|
|
13533
13308
|
const localVarAxiosArgs = await localVarAxiosParamCreator.setEmergencyStop(cell, controller, active, options);
|
|
13534
13309
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
13535
|
-
const localVarOperationServerBasePath = operationServerMap['
|
|
13310
|
+
const localVarOperationServerBasePath = operationServerMap['VirtualControllerApi.setEmergencyStop']?.[localVarOperationServerIndex]?.url;
|
|
13311
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
13312
|
+
},
|
|
13313
|
+
/**
|
|
13314
|
+
* Sets the values for joint position, joint velocity or joint acceleration of a motion group state. The values are immediately applied to the joints of the motion group. We recommend to only use the endpoint when the motion group is in monitor mode. In case the motion group is controlled, currently jogging or planning motions, the values are overridden by the controller or an error may occur.
|
|
13315
|
+
* @summary Set Motion Group State
|
|
13316
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
13317
|
+
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
13318
|
+
* @param {string} motionGroup The motion-group identifier.
|
|
13319
|
+
* @param {MotionGroupJoints} motionGroupJoints
|
|
13320
|
+
* @param {*} [options] Override http request option.
|
|
13321
|
+
* @throws {RequiredError}
|
|
13322
|
+
*/
|
|
13323
|
+
async setMotionGroupState(cell: string, controller: string, motionGroup: string, motionGroupJoints: MotionGroupJoints, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> {
|
|
13324
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.setMotionGroupState(cell, controller, motionGroup, motionGroupJoints, options);
|
|
13325
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
13326
|
+
const localVarOperationServerBasePath = operationServerMap['VirtualControllerApi.setMotionGroupState']?.[localVarOperationServerIndex]?.url;
|
|
13536
13327
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
13537
13328
|
},
|
|
13538
13329
|
/**
|
|
@@ -13547,29 +13338,87 @@ export const VirtualRobotModeApiFp = function(configuration?: Configuration) {
|
|
|
13547
13338
|
async setOperationMode(cell: string, controller: string, mode: OperationMode, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> {
|
|
13548
13339
|
const localVarAxiosArgs = await localVarAxiosParamCreator.setOperationMode(cell, controller, mode, options);
|
|
13549
13340
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
13550
|
-
const localVarOperationServerBasePath = operationServerMap['
|
|
13341
|
+
const localVarOperationServerBasePath = operationServerMap['VirtualControllerApi.setOperationMode']?.[localVarOperationServerIndex]?.url;
|
|
13342
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
13343
|
+
},
|
|
13344
|
+
/**
|
|
13345
|
+
* Sets motion group mounting by specifying a coordinate system. The motion group will be based on the coordinate system\'s origin. The coordinate system defines a transformation offset. The transformation offset is defined by a unique identifier, a name for front end usage and an offset in another coordinate system referenced by the unique identifier of the reference coordinate system.
|
|
13346
|
+
* @summary Set Mounting
|
|
13347
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
13348
|
+
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
13349
|
+
* @param {string} motionGroup The motion-group identifier.
|
|
13350
|
+
* @param {CoordinateSystem} coordinateSystem
|
|
13351
|
+
* @param {*} [options] Override http request option.
|
|
13352
|
+
* @throws {RequiredError}
|
|
13353
|
+
*/
|
|
13354
|
+
async setVirtualRobotMounting(cell: string, controller: string, motionGroup: string, coordinateSystem: CoordinateSystem, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CoordinateSystem>> {
|
|
13355
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.setVirtualRobotMounting(cell, controller, motionGroup, coordinateSystem, options);
|
|
13356
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
13357
|
+
const localVarOperationServerBasePath = operationServerMap['VirtualControllerApi.setVirtualRobotMounting']?.[localVarOperationServerIndex]?.url;
|
|
13551
13358
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
13552
13359
|
},
|
|
13553
13360
|
}
|
|
13554
13361
|
};
|
|
13555
13362
|
|
|
13556
13363
|
/**
|
|
13557
|
-
*
|
|
13364
|
+
* VirtualControllerApi - factory interface
|
|
13558
13365
|
* @export
|
|
13559
13366
|
*/
|
|
13560
|
-
export const
|
|
13561
|
-
const localVarFp =
|
|
13367
|
+
export const VirtualControllerApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
|
|
13368
|
+
const localVarFp = VirtualControllerApiFp(configuration)
|
|
13562
13369
|
return {
|
|
13563
13370
|
/**
|
|
13564
|
-
*
|
|
13565
|
-
* @summary
|
|
13371
|
+
* Adds a coordinate system to the robot controller.
|
|
13372
|
+
* @summary Add Coordinate Systems
|
|
13566
13373
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
13567
13374
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
13375
|
+
* @param {string} coordinateSystem Unique identifier addressing a coordinate system.
|
|
13376
|
+
* @param {CoordinateSystemData} coordinateSystemData
|
|
13568
13377
|
* @param {*} [options] Override http request option.
|
|
13569
13378
|
* @throws {RequiredError}
|
|
13570
13379
|
*/
|
|
13571
|
-
|
|
13572
|
-
return localVarFp.
|
|
13380
|
+
addVirtualRobotCoordinateSystem(cell: string, controller: string, coordinateSystem: string, coordinateSystemData: CoordinateSystemData, options?: RawAxiosRequestConfig): AxiosPromise<void> {
|
|
13381
|
+
return localVarFp.addVirtualRobotCoordinateSystem(cell, controller, coordinateSystem, coordinateSystemData, options).then((request) => request(axios, basePath));
|
|
13382
|
+
},
|
|
13383
|
+
/**
|
|
13384
|
+
* Adds a new TCP or updates an existing TCP in the motion group. The position and rotation values in the request body are defined within the flange’s coordinate system. > **NOTE** > > Ensure the TCP\'s position is within the robot\'s reach. Refer to the robot’s documentation or data sheet for details like joint limits or reach.
|
|
13385
|
+
* @summary Add TCP
|
|
13386
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
13387
|
+
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
13388
|
+
* @param {string} motionGroup The motion-group identifier.
|
|
13389
|
+
* @param {string} tcp The unique identifier of a TCP.
|
|
13390
|
+
* @param {RobotTcpData} robotTcpData
|
|
13391
|
+
* @param {*} [options] Override http request option.
|
|
13392
|
+
* @throws {RequiredError}
|
|
13393
|
+
*/
|
|
13394
|
+
addVirtualRobotTcp(cell: string, controller: string, motionGroup: string, tcp: string, robotTcpData: RobotTcpData, options?: RawAxiosRequestConfig): AxiosPromise<void> {
|
|
13395
|
+
return localVarFp.addVirtualRobotTcp(cell, controller, motionGroup, tcp, robotTcpData, options).then((request) => request(axios, basePath));
|
|
13396
|
+
},
|
|
13397
|
+
/**
|
|
13398
|
+
* Deletes a coordinate system from the virtual controller. This will remove the coordinate system from the list of coordinate systems and remove all dependent coordinate systems which use the deleted coordinate system as reference.
|
|
13399
|
+
* @summary Remove Coordinate System
|
|
13400
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
13401
|
+
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
13402
|
+
* @param {string} coordinateSystem Unique identifier addressing a coordinate system.
|
|
13403
|
+
* @param {boolean} [deleteDependent] If true, all dependent coordinate systems will be deleted as well.
|
|
13404
|
+
* @param {*} [options] Override http request option.
|
|
13405
|
+
* @throws {RequiredError}
|
|
13406
|
+
*/
|
|
13407
|
+
deleteVirtualRobotCoordinateSystem(cell: string, controller: string, coordinateSystem: string, deleteDependent?: boolean, options?: RawAxiosRequestConfig): AxiosPromise<void> {
|
|
13408
|
+
return localVarFp.deleteVirtualRobotCoordinateSystem(cell, controller, coordinateSystem, deleteDependent, options).then((request) => request(axios, basePath));
|
|
13409
|
+
},
|
|
13410
|
+
/**
|
|
13411
|
+
* Removes the TCP from the motion group. An unknown TCP is a valid input.
|
|
13412
|
+
* @summary Remove TCP
|
|
13413
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
13414
|
+
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
13415
|
+
* @param {string} motionGroup The motion-group identifier.
|
|
13416
|
+
* @param {string} tcp The unique identifier of a TCP.
|
|
13417
|
+
* @param {*} [options] Override http request option.
|
|
13418
|
+
* @throws {RequiredError}
|
|
13419
|
+
*/
|
|
13420
|
+
deleteVirtualRobotTcp(cell: string, controller: string, motionGroup: string, tcp: string, options?: RawAxiosRequestConfig): AxiosPromise<void> {
|
|
13421
|
+
return localVarFp.deleteVirtualRobotTcp(cell, controller, motionGroup, tcp, options).then((request) => request(axios, basePath));
|
|
13573
13422
|
},
|
|
13574
13423
|
/**
|
|
13575
13424
|
* Requests the Emergency Stop state of the virtual robot controller. Use [getCurrentMotionGroupState](getCurrentMotionGroupState) to get the Emergency Stop state regardless of the controller type. There the Emergency Stop state is visible as the `safety_state`. > **NOTE** > > The Emergency Stop state can only be changed when using virtual robot controllers.
|
|
@@ -13582,6 +13431,29 @@ export const VirtualRobotModeApiFactory = function (configuration?: Configuratio
|
|
|
13582
13431
|
getEmergencyStop(cell: string, controller: string, options?: RawAxiosRequestConfig): AxiosPromise<Flag> {
|
|
13583
13432
|
return localVarFp.getEmergencyStop(cell, controller, options).then((request) => request(axios, basePath));
|
|
13584
13433
|
},
|
|
13434
|
+
/**
|
|
13435
|
+
* Get the current motion group state which provides values for the joints\' position, velocity and acceleration.
|
|
13436
|
+
* @summary Get Motion Group State
|
|
13437
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
13438
|
+
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
13439
|
+
* @param {string} motionGroup The motion-group identifier.
|
|
13440
|
+
* @param {*} [options] Override http request option.
|
|
13441
|
+
* @throws {RequiredError}
|
|
13442
|
+
*/
|
|
13443
|
+
getMotionGroupState(cell: string, controller: string, motionGroup: string, options?: RawAxiosRequestConfig): AxiosPromise<MotionGroupJoints> {
|
|
13444
|
+
return localVarFp.getMotionGroupState(cell, controller, motionGroup, options).then((request) => request(axios, basePath));
|
|
13445
|
+
},
|
|
13446
|
+
/**
|
|
13447
|
+
* Gets information on the motion group.
|
|
13448
|
+
* @summary Motion Group Description
|
|
13449
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
13450
|
+
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
13451
|
+
* @param {*} [options] Override http request option.
|
|
13452
|
+
* @throws {RequiredError}
|
|
13453
|
+
*/
|
|
13454
|
+
getMotionGroups(cell: string, controller: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<MotionGroupInfo>> {
|
|
13455
|
+
return localVarFp.getMotionGroups(cell, controller, options).then((request) => request(axios, basePath));
|
|
13456
|
+
},
|
|
13585
13457
|
/**
|
|
13586
13458
|
* Requests the Operation Mode of the virtual robot controller. To get the Operation Mode regardless of the controller type use [getCurrentMotionGroupState](getCurrentMotionGroupState). **Note:** The Operating Mode can only change be changed via API when using virtual robot controllers.
|
|
13587
13459
|
* @summary Get Operation Mode
|
|
@@ -13593,6 +13465,41 @@ export const VirtualRobotModeApiFactory = function (configuration?: Configuratio
|
|
|
13593
13465
|
getOperationMode(cell: string, controller: string, options?: RawAxiosRequestConfig): AxiosPromise<OpMode> {
|
|
13594
13466
|
return localVarFp.getOperationMode(cell, controller, options).then((request) => request(axios, basePath));
|
|
13595
13467
|
},
|
|
13468
|
+
/**
|
|
13469
|
+
* Gets motion group mounting. The motion group is based on the origin of the returned coordinate system.
|
|
13470
|
+
* @summary Get Mounting
|
|
13471
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
13472
|
+
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
13473
|
+
* @param {string} motionGroup The motion-group identifier.
|
|
13474
|
+
* @param {*} [options] Override http request option.
|
|
13475
|
+
* @throws {RequiredError}
|
|
13476
|
+
*/
|
|
13477
|
+
getVirtualRobotMounting(cell: string, controller: string, motionGroup: string, options?: RawAxiosRequestConfig): AxiosPromise<CoordinateSystem> {
|
|
13478
|
+
return localVarFp.getVirtualRobotMounting(cell, controller, motionGroup, options).then((request) => request(axios, basePath));
|
|
13479
|
+
},
|
|
13480
|
+
/**
|
|
13481
|
+
* Lists all coordinate systems on the robot controller.
|
|
13482
|
+
* @summary List Coordinate Systems
|
|
13483
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
13484
|
+
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
13485
|
+
* @param {*} [options] Override http request option.
|
|
13486
|
+
* @throws {RequiredError}
|
|
13487
|
+
*/
|
|
13488
|
+
listVirtualRobotCoordinateSystems(cell: string, controller: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<CoordinateSystem>> {
|
|
13489
|
+
return localVarFp.listVirtualRobotCoordinateSystems(cell, controller, options).then((request) => request(axios, basePath));
|
|
13490
|
+
},
|
|
13491
|
+
/**
|
|
13492
|
+
* Lists TCPs of the motion group. An empty TCP list is valid, for example for external axes.
|
|
13493
|
+
* @summary List TCPs
|
|
13494
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
13495
|
+
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
13496
|
+
* @param {string} motionGroup The motion-group identifier.
|
|
13497
|
+
* @param {*} [options] Override http request option.
|
|
13498
|
+
* @throws {RequiredError}
|
|
13499
|
+
*/
|
|
13500
|
+
listVirtualRobotTcps(cell: string, controller: string, motionGroup: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<RobotTcp>> {
|
|
13501
|
+
return localVarFp.listVirtualRobotTcps(cell, controller, motionGroup, options).then((request) => request(axios, basePath));
|
|
13502
|
+
},
|
|
13596
13503
|
/**
|
|
13597
13504
|
* Activates or releases the Emergency Stop on the virtual robot controller. Activating the Emergency Stop stops the execution of all motions. The stop is executed on physical controllers immediately not gracefully and not on paths. Due to restricted physical behavior of the virtual robot controller, the Emergency Stop is executed on paths. To return to normal operation the Emergency Stop needs to be released. Use [getCurrentMotionGroupState](getCurrentMotionGroupState) to get the Emergency Stop state regardless of the controller type. There the Emergency Stop state is visible as the `safety_state`. > **NOTE** > > The Emergency Stop state can only be changed via API when using virtual robot controllers.
|
|
13598
13505
|
* @summary Push or Release Emergency Stop
|
|
@@ -13605,6 +13512,19 @@ export const VirtualRobotModeApiFactory = function (configuration?: Configuratio
|
|
|
13605
13512
|
setEmergencyStop(cell: string, controller: string, active?: boolean, options?: RawAxiosRequestConfig): AxiosPromise<void> {
|
|
13606
13513
|
return localVarFp.setEmergencyStop(cell, controller, active, options).then((request) => request(axios, basePath));
|
|
13607
13514
|
},
|
|
13515
|
+
/**
|
|
13516
|
+
* Sets the values for joint position, joint velocity or joint acceleration of a motion group state. The values are immediately applied to the joints of the motion group. We recommend to only use the endpoint when the motion group is in monitor mode. In case the motion group is controlled, currently jogging or planning motions, the values are overridden by the controller or an error may occur.
|
|
13517
|
+
* @summary Set Motion Group State
|
|
13518
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
13519
|
+
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
13520
|
+
* @param {string} motionGroup The motion-group identifier.
|
|
13521
|
+
* @param {MotionGroupJoints} motionGroupJoints
|
|
13522
|
+
* @param {*} [options] Override http request option.
|
|
13523
|
+
* @throws {RequiredError}
|
|
13524
|
+
*/
|
|
13525
|
+
setMotionGroupState(cell: string, controller: string, motionGroup: string, motionGroupJoints: MotionGroupJoints, options?: RawAxiosRequestConfig): AxiosPromise<void> {
|
|
13526
|
+
return localVarFp.setMotionGroupState(cell, controller, motionGroup, motionGroupJoints, options).then((request) => request(axios, basePath));
|
|
13527
|
+
},
|
|
13608
13528
|
/**
|
|
13609
13529
|
* Changes the Operation Mode of the virtual robot controller to the specified value. To get the Operation Mode regardless of the controller type use [getCurrentMotionGroupState](getCurrentMotionGroupState). > **NOTE** > > The Operating Mode can only change be changed via API when using virtual robot controllers.
|
|
13610
13530
|
* @summary Set Operation Mode
|
|
@@ -13617,27 +13537,88 @@ export const VirtualRobotModeApiFactory = function (configuration?: Configuratio
|
|
|
13617
13537
|
setOperationMode(cell: string, controller: string, mode: OperationMode, options?: RawAxiosRequestConfig): AxiosPromise<void> {
|
|
13618
13538
|
return localVarFp.setOperationMode(cell, controller, mode, options).then((request) => request(axios, basePath));
|
|
13619
13539
|
},
|
|
13620
|
-
|
|
13621
|
-
|
|
13622
|
-
|
|
13623
|
-
|
|
13624
|
-
|
|
13625
|
-
|
|
13626
|
-
|
|
13627
|
-
|
|
13540
|
+
/**
|
|
13541
|
+
* Sets motion group mounting by specifying a coordinate system. The motion group will be based on the coordinate system\'s origin. The coordinate system defines a transformation offset. The transformation offset is defined by a unique identifier, a name for front end usage and an offset in another coordinate system referenced by the unique identifier of the reference coordinate system.
|
|
13542
|
+
* @summary Set Mounting
|
|
13543
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
13544
|
+
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
13545
|
+
* @param {string} motionGroup The motion-group identifier.
|
|
13546
|
+
* @param {CoordinateSystem} coordinateSystem
|
|
13547
|
+
* @param {*} [options] Override http request option.
|
|
13548
|
+
* @throws {RequiredError}
|
|
13549
|
+
*/
|
|
13550
|
+
setVirtualRobotMounting(cell: string, controller: string, motionGroup: string, coordinateSystem: CoordinateSystem, options?: RawAxiosRequestConfig): AxiosPromise<CoordinateSystem> {
|
|
13551
|
+
return localVarFp.setVirtualRobotMounting(cell, controller, motionGroup, coordinateSystem, options).then((request) => request(axios, basePath));
|
|
13552
|
+
},
|
|
13553
|
+
};
|
|
13554
|
+
};
|
|
13555
|
+
|
|
13556
|
+
/**
|
|
13557
|
+
* VirtualControllerApi - object-oriented interface
|
|
13558
|
+
* @export
|
|
13559
|
+
* @class VirtualControllerApi
|
|
13560
|
+
* @extends {BaseAPI}
|
|
13628
13561
|
*/
|
|
13629
|
-
export class
|
|
13562
|
+
export class VirtualControllerApi extends BaseAPI {
|
|
13630
13563
|
/**
|
|
13631
|
-
*
|
|
13632
|
-
* @summary
|
|
13564
|
+
* Adds a coordinate system to the robot controller.
|
|
13565
|
+
* @summary Add Coordinate Systems
|
|
13633
13566
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
13634
13567
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
13568
|
+
* @param {string} coordinateSystem Unique identifier addressing a coordinate system.
|
|
13569
|
+
* @param {CoordinateSystemData} coordinateSystemData
|
|
13635
13570
|
* @param {*} [options] Override http request option.
|
|
13636
13571
|
* @throws {RequiredError}
|
|
13637
|
-
* @memberof
|
|
13572
|
+
* @memberof VirtualControllerApi
|
|
13638
13573
|
*/
|
|
13639
|
-
public
|
|
13640
|
-
return
|
|
13574
|
+
public addVirtualRobotCoordinateSystem(cell: string, controller: string, coordinateSystem: string, coordinateSystemData: CoordinateSystemData, options?: RawAxiosRequestConfig) {
|
|
13575
|
+
return VirtualControllerApiFp(this.configuration).addVirtualRobotCoordinateSystem(cell, controller, coordinateSystem, coordinateSystemData, options).then((request) => request(this.axios, this.basePath));
|
|
13576
|
+
}
|
|
13577
|
+
|
|
13578
|
+
/**
|
|
13579
|
+
* Adds a new TCP or updates an existing TCP in the motion group. The position and rotation values in the request body are defined within the flange’s coordinate system. > **NOTE** > > Ensure the TCP\'s position is within the robot\'s reach. Refer to the robot’s documentation or data sheet for details like joint limits or reach.
|
|
13580
|
+
* @summary Add TCP
|
|
13581
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
13582
|
+
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
13583
|
+
* @param {string} motionGroup The motion-group identifier.
|
|
13584
|
+
* @param {string} tcp The unique identifier of a TCP.
|
|
13585
|
+
* @param {RobotTcpData} robotTcpData
|
|
13586
|
+
* @param {*} [options] Override http request option.
|
|
13587
|
+
* @throws {RequiredError}
|
|
13588
|
+
* @memberof VirtualControllerApi
|
|
13589
|
+
*/
|
|
13590
|
+
public addVirtualRobotTcp(cell: string, controller: string, motionGroup: string, tcp: string, robotTcpData: RobotTcpData, options?: RawAxiosRequestConfig) {
|
|
13591
|
+
return VirtualControllerApiFp(this.configuration).addVirtualRobotTcp(cell, controller, motionGroup, tcp, robotTcpData, options).then((request) => request(this.axios, this.basePath));
|
|
13592
|
+
}
|
|
13593
|
+
|
|
13594
|
+
/**
|
|
13595
|
+
* Deletes a coordinate system from the virtual controller. This will remove the coordinate system from the list of coordinate systems and remove all dependent coordinate systems which use the deleted coordinate system as reference.
|
|
13596
|
+
* @summary Remove Coordinate System
|
|
13597
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
13598
|
+
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
13599
|
+
* @param {string} coordinateSystem Unique identifier addressing a coordinate system.
|
|
13600
|
+
* @param {boolean} [deleteDependent] If true, all dependent coordinate systems will be deleted as well.
|
|
13601
|
+
* @param {*} [options] Override http request option.
|
|
13602
|
+
* @throws {RequiredError}
|
|
13603
|
+
* @memberof VirtualControllerApi
|
|
13604
|
+
*/
|
|
13605
|
+
public deleteVirtualRobotCoordinateSystem(cell: string, controller: string, coordinateSystem: string, deleteDependent?: boolean, options?: RawAxiosRequestConfig) {
|
|
13606
|
+
return VirtualControllerApiFp(this.configuration).deleteVirtualRobotCoordinateSystem(cell, controller, coordinateSystem, deleteDependent, options).then((request) => request(this.axios, this.basePath));
|
|
13607
|
+
}
|
|
13608
|
+
|
|
13609
|
+
/**
|
|
13610
|
+
* Removes the TCP from the motion group. An unknown TCP is a valid input.
|
|
13611
|
+
* @summary Remove TCP
|
|
13612
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
13613
|
+
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
13614
|
+
* @param {string} motionGroup The motion-group identifier.
|
|
13615
|
+
* @param {string} tcp The unique identifier of a TCP.
|
|
13616
|
+
* @param {*} [options] Override http request option.
|
|
13617
|
+
* @throws {RequiredError}
|
|
13618
|
+
* @memberof VirtualControllerApi
|
|
13619
|
+
*/
|
|
13620
|
+
public deleteVirtualRobotTcp(cell: string, controller: string, motionGroup: string, tcp: string, options?: RawAxiosRequestConfig) {
|
|
13621
|
+
return VirtualControllerApiFp(this.configuration).deleteVirtualRobotTcp(cell, controller, motionGroup, tcp, options).then((request) => request(this.axios, this.basePath));
|
|
13641
13622
|
}
|
|
13642
13623
|
|
|
13643
13624
|
/**
|
|
@@ -13647,10 +13628,37 @@ export class VirtualRobotModeApi extends BaseAPI {
|
|
|
13647
13628
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
13648
13629
|
* @param {*} [options] Override http request option.
|
|
13649
13630
|
* @throws {RequiredError}
|
|
13650
|
-
* @memberof
|
|
13631
|
+
* @memberof VirtualControllerApi
|
|
13651
13632
|
*/
|
|
13652
13633
|
public getEmergencyStop(cell: string, controller: string, options?: RawAxiosRequestConfig) {
|
|
13653
|
-
return
|
|
13634
|
+
return VirtualControllerApiFp(this.configuration).getEmergencyStop(cell, controller, options).then((request) => request(this.axios, this.basePath));
|
|
13635
|
+
}
|
|
13636
|
+
|
|
13637
|
+
/**
|
|
13638
|
+
* Get the current motion group state which provides values for the joints\' position, velocity and acceleration.
|
|
13639
|
+
* @summary Get Motion Group State
|
|
13640
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
13641
|
+
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
13642
|
+
* @param {string} motionGroup The motion-group identifier.
|
|
13643
|
+
* @param {*} [options] Override http request option.
|
|
13644
|
+
* @throws {RequiredError}
|
|
13645
|
+
* @memberof VirtualControllerApi
|
|
13646
|
+
*/
|
|
13647
|
+
public getMotionGroupState(cell: string, controller: string, motionGroup: string, options?: RawAxiosRequestConfig) {
|
|
13648
|
+
return VirtualControllerApiFp(this.configuration).getMotionGroupState(cell, controller, motionGroup, options).then((request) => request(this.axios, this.basePath));
|
|
13649
|
+
}
|
|
13650
|
+
|
|
13651
|
+
/**
|
|
13652
|
+
* Gets information on the motion group.
|
|
13653
|
+
* @summary Motion Group Description
|
|
13654
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
13655
|
+
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
13656
|
+
* @param {*} [options] Override http request option.
|
|
13657
|
+
* @throws {RequiredError}
|
|
13658
|
+
* @memberof VirtualControllerApi
|
|
13659
|
+
*/
|
|
13660
|
+
public getMotionGroups(cell: string, controller: string, options?: RawAxiosRequestConfig) {
|
|
13661
|
+
return VirtualControllerApiFp(this.configuration).getMotionGroups(cell, controller, options).then((request) => request(this.axios, this.basePath));
|
|
13654
13662
|
}
|
|
13655
13663
|
|
|
13656
13664
|
/**
|
|
@@ -13660,10 +13668,51 @@ export class VirtualRobotModeApi extends BaseAPI {
|
|
|
13660
13668
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
13661
13669
|
* @param {*} [options] Override http request option.
|
|
13662
13670
|
* @throws {RequiredError}
|
|
13663
|
-
* @memberof
|
|
13671
|
+
* @memberof VirtualControllerApi
|
|
13664
13672
|
*/
|
|
13665
13673
|
public getOperationMode(cell: string, controller: string, options?: RawAxiosRequestConfig) {
|
|
13666
|
-
return
|
|
13674
|
+
return VirtualControllerApiFp(this.configuration).getOperationMode(cell, controller, options).then((request) => request(this.axios, this.basePath));
|
|
13675
|
+
}
|
|
13676
|
+
|
|
13677
|
+
/**
|
|
13678
|
+
* Gets motion group mounting. The motion group is based on the origin of the returned coordinate system.
|
|
13679
|
+
* @summary Get Mounting
|
|
13680
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
13681
|
+
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
13682
|
+
* @param {string} motionGroup The motion-group identifier.
|
|
13683
|
+
* @param {*} [options] Override http request option.
|
|
13684
|
+
* @throws {RequiredError}
|
|
13685
|
+
* @memberof VirtualControllerApi
|
|
13686
|
+
*/
|
|
13687
|
+
public getVirtualRobotMounting(cell: string, controller: string, motionGroup: string, options?: RawAxiosRequestConfig) {
|
|
13688
|
+
return VirtualControllerApiFp(this.configuration).getVirtualRobotMounting(cell, controller, motionGroup, options).then((request) => request(this.axios, this.basePath));
|
|
13689
|
+
}
|
|
13690
|
+
|
|
13691
|
+
/**
|
|
13692
|
+
* Lists all coordinate systems on the robot controller.
|
|
13693
|
+
* @summary List Coordinate Systems
|
|
13694
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
13695
|
+
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
13696
|
+
* @param {*} [options] Override http request option.
|
|
13697
|
+
* @throws {RequiredError}
|
|
13698
|
+
* @memberof VirtualControllerApi
|
|
13699
|
+
*/
|
|
13700
|
+
public listVirtualRobotCoordinateSystems(cell: string, controller: string, options?: RawAxiosRequestConfig) {
|
|
13701
|
+
return VirtualControllerApiFp(this.configuration).listVirtualRobotCoordinateSystems(cell, controller, options).then((request) => request(this.axios, this.basePath));
|
|
13702
|
+
}
|
|
13703
|
+
|
|
13704
|
+
/**
|
|
13705
|
+
* Lists TCPs of the motion group. An empty TCP list is valid, for example for external axes.
|
|
13706
|
+
* @summary List TCPs
|
|
13707
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
13708
|
+
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
13709
|
+
* @param {string} motionGroup The motion-group identifier.
|
|
13710
|
+
* @param {*} [options] Override http request option.
|
|
13711
|
+
* @throws {RequiredError}
|
|
13712
|
+
* @memberof VirtualControllerApi
|
|
13713
|
+
*/
|
|
13714
|
+
public listVirtualRobotTcps(cell: string, controller: string, motionGroup: string, options?: RawAxiosRequestConfig) {
|
|
13715
|
+
return VirtualControllerApiFp(this.configuration).listVirtualRobotTcps(cell, controller, motionGroup, options).then((request) => request(this.axios, this.basePath));
|
|
13667
13716
|
}
|
|
13668
13717
|
|
|
13669
13718
|
/**
|
|
@@ -13674,10 +13723,25 @@ export class VirtualRobotModeApi extends BaseAPI {
|
|
|
13674
13723
|
* @param {boolean} [active]
|
|
13675
13724
|
* @param {*} [options] Override http request option.
|
|
13676
13725
|
* @throws {RequiredError}
|
|
13677
|
-
* @memberof
|
|
13726
|
+
* @memberof VirtualControllerApi
|
|
13678
13727
|
*/
|
|
13679
13728
|
public setEmergencyStop(cell: string, controller: string, active?: boolean, options?: RawAxiosRequestConfig) {
|
|
13680
|
-
return
|
|
13729
|
+
return VirtualControllerApiFp(this.configuration).setEmergencyStop(cell, controller, active, options).then((request) => request(this.axios, this.basePath));
|
|
13730
|
+
}
|
|
13731
|
+
|
|
13732
|
+
/**
|
|
13733
|
+
* Sets the values for joint position, joint velocity or joint acceleration of a motion group state. The values are immediately applied to the joints of the motion group. We recommend to only use the endpoint when the motion group is in monitor mode. In case the motion group is controlled, currently jogging or planning motions, the values are overridden by the controller or an error may occur.
|
|
13734
|
+
* @summary Set Motion Group State
|
|
13735
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
13736
|
+
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
13737
|
+
* @param {string} motionGroup The motion-group identifier.
|
|
13738
|
+
* @param {MotionGroupJoints} motionGroupJoints
|
|
13739
|
+
* @param {*} [options] Override http request option.
|
|
13740
|
+
* @throws {RequiredError}
|
|
13741
|
+
* @memberof VirtualControllerApi
|
|
13742
|
+
*/
|
|
13743
|
+
public setMotionGroupState(cell: string, controller: string, motionGroup: string, motionGroupJoints: MotionGroupJoints, options?: RawAxiosRequestConfig) {
|
|
13744
|
+
return VirtualControllerApiFp(this.configuration).setMotionGroupState(cell, controller, motionGroup, motionGroupJoints, options).then((request) => request(this.axios, this.basePath));
|
|
13681
13745
|
}
|
|
13682
13746
|
|
|
13683
13747
|
/**
|
|
@@ -13688,38 +13752,53 @@ export class VirtualRobotModeApi extends BaseAPI {
|
|
|
13688
13752
|
* @param {OperationMode} mode
|
|
13689
13753
|
* @param {*} [options] Override http request option.
|
|
13690
13754
|
* @throws {RequiredError}
|
|
13691
|
-
* @memberof
|
|
13755
|
+
* @memberof VirtualControllerApi
|
|
13692
13756
|
*/
|
|
13693
13757
|
public setOperationMode(cell: string, controller: string, mode: OperationMode, options?: RawAxiosRequestConfig) {
|
|
13694
|
-
return
|
|
13758
|
+
return VirtualControllerApiFp(this.configuration).setOperationMode(cell, controller, mode, options).then((request) => request(this.axios, this.basePath));
|
|
13759
|
+
}
|
|
13760
|
+
|
|
13761
|
+
/**
|
|
13762
|
+
* Sets motion group mounting by specifying a coordinate system. The motion group will be based on the coordinate system\'s origin. The coordinate system defines a transformation offset. The transformation offset is defined by a unique identifier, a name for front end usage and an offset in another coordinate system referenced by the unique identifier of the reference coordinate system.
|
|
13763
|
+
* @summary Set Mounting
|
|
13764
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
13765
|
+
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
13766
|
+
* @param {string} motionGroup The motion-group identifier.
|
|
13767
|
+
* @param {CoordinateSystem} coordinateSystem
|
|
13768
|
+
* @param {*} [options] Override http request option.
|
|
13769
|
+
* @throws {RequiredError}
|
|
13770
|
+
* @memberof VirtualControllerApi
|
|
13771
|
+
*/
|
|
13772
|
+
public setVirtualRobotMounting(cell: string, controller: string, motionGroup: string, coordinateSystem: CoordinateSystem, options?: RawAxiosRequestConfig) {
|
|
13773
|
+
return VirtualControllerApiFp(this.configuration).setVirtualRobotMounting(cell, controller, motionGroup, coordinateSystem, options).then((request) => request(this.axios, this.basePath));
|
|
13695
13774
|
}
|
|
13696
13775
|
}
|
|
13697
13776
|
|
|
13698
13777
|
|
|
13699
13778
|
|
|
13700
13779
|
/**
|
|
13701
|
-
*
|
|
13780
|
+
* VirtualControllerBehaviorApi - axios parameter creator
|
|
13702
13781
|
* @export
|
|
13703
13782
|
*/
|
|
13704
|
-
export const
|
|
13783
|
+
export const VirtualControllerBehaviorApiAxiosParamCreator = function (configuration?: Configuration) {
|
|
13705
13784
|
return {
|
|
13706
13785
|
/**
|
|
13707
|
-
*
|
|
13708
|
-
* @summary
|
|
13786
|
+
* <!-- theme: danger --> > Websocket endpoint This stream sends the commanded state (joint positions, velocities, accelerations, torques) for each motion group of the virtual controller and sets the joint configuration. Moving motion groups on virtual controllers can be executed by using Trajectory Planning and Trajectory Execution. Trajectory Execution commands the desired joint configuration to each motion group. Physical motion groups move to this joint configuration. With physical motion groups, this takes some time and only works if possible. And you have the *actual* joint state - the current real motion group configuration. Again, this stream is providing *commanded* joint state! > **NOTE** > > This stream provides *commanded* joint states, it **doesn\'t provide actual joint states**. When the virtual controller receives joint commands the joint configuration is immediately adapted to match the incoming joint configuration. > **CAUTION** > > Incoming joint configurations are not visualized and their velocity limits are not checked. Possible use cases are: 1. Creating a robotic application that dynamically adapts to the configured joints on the robot controller, using this stream to feed new joint configurations back to the motion groups. The stream only sends data to the robot controller if a motion is executed. If the robot controller\'s joint configuration differs too much from the incoming joint configuration, a following error occurs. Joint configurations that result in following errors are executed only for motions with a low velocity. 2. Mimic Freedrive motions. <!-- theme: danger --> > **DANGER** > > If the incoming joint configuration is set to maximum velocity, the movement to reach this incoming joint configuration > will be executed with maximum speed regardless of safety zones and mechanical limits.
|
|
13787
|
+
* @summary Stream Joint Configuration
|
|
13709
13788
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
13710
13789
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
13711
|
-
* @param {
|
|
13790
|
+
* @param {ExternalJointStreamRequest} externalJointStreamRequest
|
|
13712
13791
|
* @param {*} [options] Override http request option.
|
|
13713
13792
|
* @throws {RequiredError}
|
|
13714
13793
|
*/
|
|
13715
|
-
|
|
13794
|
+
externalJointsStream: async (cell: string, controller: string, externalJointStreamRequest: ExternalJointStreamRequest, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
13716
13795
|
// verify required parameter 'cell' is not null or undefined
|
|
13717
|
-
assertParamExists('
|
|
13796
|
+
assertParamExists('externalJointsStream', 'cell', cell)
|
|
13718
13797
|
// verify required parameter 'controller' is not null or undefined
|
|
13719
|
-
assertParamExists('
|
|
13720
|
-
// verify required parameter '
|
|
13721
|
-
assertParamExists('
|
|
13722
|
-
const localVarPath = `/cells/{cell}/controllers/{controller}/
|
|
13798
|
+
assertParamExists('externalJointsStream', 'controller', controller)
|
|
13799
|
+
// verify required parameter 'externalJointStreamRequest' is not null or undefined
|
|
13800
|
+
assertParamExists('externalJointsStream', 'externalJointStreamRequest', externalJointStreamRequest)
|
|
13801
|
+
const localVarPath = `/cells/{cell}/virtual-controllers/{controller}/external-joints-stream`
|
|
13723
13802
|
.replace(`{${"cell"}}`, encodeURIComponent(String(cell)))
|
|
13724
13803
|
.replace(`{${"controller"}}`, encodeURIComponent(String(controller)));
|
|
13725
13804
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
@@ -13729,7 +13808,7 @@ export const VirtualRobotSetupApiAxiosParamCreator = function (configuration?: C
|
|
|
13729
13808
|
baseOptions = configuration.baseOptions;
|
|
13730
13809
|
}
|
|
13731
13810
|
|
|
13732
|
-
const localVarRequestOptions = { method: '
|
|
13811
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
13733
13812
|
const localVarHeaderParameter = {} as any;
|
|
13734
13813
|
const localVarQueryParameter = {} as any;
|
|
13735
13814
|
|
|
@@ -13748,7 +13827,7 @@ export const VirtualRobotSetupApiAxiosParamCreator = function (configuration?: C
|
|
|
13748
13827
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
13749
13828
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
13750
13829
|
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
13751
|
-
localVarRequestOptions.data = serializeDataIfNeeded(
|
|
13830
|
+
localVarRequestOptions.data = serializeDataIfNeeded(externalJointStreamRequest, localVarRequestOptions, configuration)
|
|
13752
13831
|
|
|
13753
13832
|
return {
|
|
13754
13833
|
url: toPathString(localVarUrlObj),
|
|
@@ -13756,28 +13835,21 @@ export const VirtualRobotSetupApiAxiosParamCreator = function (configuration?: C
|
|
|
13756
13835
|
};
|
|
13757
13836
|
},
|
|
13758
13837
|
/**
|
|
13759
|
-
*
|
|
13760
|
-
* @summary
|
|
13838
|
+
* Get the cycle time of controller communication in [ms].
|
|
13839
|
+
* @summary Get Cycle Time
|
|
13761
13840
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
13762
13841
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
13763
|
-
* @param {string} motionGroup The motion-group identifier.
|
|
13764
|
-
* @param {RobotTcp} robotTcp
|
|
13765
13842
|
* @param {*} [options] Override http request option.
|
|
13766
13843
|
* @throws {RequiredError}
|
|
13767
13844
|
*/
|
|
13768
|
-
|
|
13845
|
+
getCycleTime: async (cell: string, controller: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
13769
13846
|
// verify required parameter 'cell' is not null or undefined
|
|
13770
|
-
assertParamExists('
|
|
13847
|
+
assertParamExists('getCycleTime', 'cell', cell)
|
|
13771
13848
|
// verify required parameter 'controller' is not null or undefined
|
|
13772
|
-
assertParamExists('
|
|
13773
|
-
|
|
13774
|
-
assertParamExists('addVirtualRobotTcp', 'motionGroup', motionGroup)
|
|
13775
|
-
// verify required parameter 'robotTcp' is not null or undefined
|
|
13776
|
-
assertParamExists('addVirtualRobotTcp', 'robotTcp', robotTcp)
|
|
13777
|
-
const localVarPath = `/cells/{cell}/controllers/{controller}/teach-pendant/motion-groups/{motion-group}/tcps`
|
|
13849
|
+
assertParamExists('getCycleTime', 'controller', controller)
|
|
13850
|
+
const localVarPath = `/cells/{cell}/virtual-controllers/{controller}/cycle-time`
|
|
13778
13851
|
.replace(`{${"cell"}}`, encodeURIComponent(String(cell)))
|
|
13779
|
-
.replace(`{${"controller"}}`, encodeURIComponent(String(controller)))
|
|
13780
|
-
.replace(`{${"motion-group"}}`, encodeURIComponent(String(motionGroup)));
|
|
13852
|
+
.replace(`{${"controller"}}`, encodeURIComponent(String(controller)));
|
|
13781
13853
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
13782
13854
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
13783
13855
|
let baseOptions;
|
|
@@ -13785,7 +13857,7 @@ export const VirtualRobotSetupApiAxiosParamCreator = function (configuration?: C
|
|
|
13785
13857
|
baseOptions = configuration.baseOptions;
|
|
13786
13858
|
}
|
|
13787
13859
|
|
|
13788
|
-
const localVarRequestOptions = { method: '
|
|
13860
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
13789
13861
|
const localVarHeaderParameter = {} as any;
|
|
13790
13862
|
const localVarQueryParameter = {} as any;
|
|
13791
13863
|
|
|
@@ -13799,12 +13871,9 @@ export const VirtualRobotSetupApiAxiosParamCreator = function (configuration?: C
|
|
|
13799
13871
|
|
|
13800
13872
|
|
|
13801
13873
|
|
|
13802
|
-
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
13803
|
-
|
|
13804
13874
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
13805
13875
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
13806
13876
|
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
13807
|
-
localVarRequestOptions.data = serializeDataIfNeeded(robotTcp, localVarRequestOptions, configuration)
|
|
13808
13877
|
|
|
13809
13878
|
return {
|
|
13810
13879
|
url: toPathString(localVarUrlObj),
|
|
@@ -13812,26 +13881,21 @@ export const VirtualRobotSetupApiAxiosParamCreator = function (configuration?: C
|
|
|
13812
13881
|
};
|
|
13813
13882
|
},
|
|
13814
13883
|
/**
|
|
13815
|
-
*
|
|
13816
|
-
* @summary
|
|
13884
|
+
* Get the current virtual controller behavior - please see the setter [setVirtualRobotBehavior](setVirtualRobotBehavior) and the enum for details.
|
|
13885
|
+
* @summary Get Behavior
|
|
13817
13886
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
13818
13887
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
13819
|
-
* @param {string} coordinateSystem Unique identifier addressing a coordinate system.
|
|
13820
|
-
* @param {boolean} [deleteDependent] If true, all dependent coordinate systems will be deleted as well.
|
|
13821
13888
|
* @param {*} [options] Override http request option.
|
|
13822
13889
|
* @throws {RequiredError}
|
|
13823
13890
|
*/
|
|
13824
|
-
|
|
13891
|
+
getVirtualRobotBehavior: async (cell: string, controller: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
13825
13892
|
// verify required parameter 'cell' is not null or undefined
|
|
13826
|
-
assertParamExists('
|
|
13893
|
+
assertParamExists('getVirtualRobotBehavior', 'cell', cell)
|
|
13827
13894
|
// verify required parameter 'controller' is not null or undefined
|
|
13828
|
-
assertParamExists('
|
|
13829
|
-
|
|
13830
|
-
assertParamExists('deleteVirtualRobotCoordinateSystem', 'coordinateSystem', coordinateSystem)
|
|
13831
|
-
const localVarPath = `/cells/{cell}/controllers/{controller}/teach-pendant/coordinate-systems/{coordinate-system}`
|
|
13895
|
+
assertParamExists('getVirtualRobotBehavior', 'controller', controller)
|
|
13896
|
+
const localVarPath = `/cells/{cell}/virtual-controllers/{controller}/behavior`
|
|
13832
13897
|
.replace(`{${"cell"}}`, encodeURIComponent(String(cell)))
|
|
13833
|
-
.replace(`{${"controller"}}`, encodeURIComponent(String(controller)))
|
|
13834
|
-
.replace(`{${"coordinate-system"}}`, encodeURIComponent(String(coordinateSystem)));
|
|
13898
|
+
.replace(`{${"controller"}}`, encodeURIComponent(String(controller)));
|
|
13835
13899
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
13836
13900
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
13837
13901
|
let baseOptions;
|
|
@@ -13839,7 +13903,7 @@ export const VirtualRobotSetupApiAxiosParamCreator = function (configuration?: C
|
|
|
13839
13903
|
baseOptions = configuration.baseOptions;
|
|
13840
13904
|
}
|
|
13841
13905
|
|
|
13842
|
-
const localVarRequestOptions = { method: '
|
|
13906
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
13843
13907
|
const localVarHeaderParameter = {} as any;
|
|
13844
13908
|
const localVarQueryParameter = {} as any;
|
|
13845
13909
|
|
|
@@ -13851,10 +13915,6 @@ export const VirtualRobotSetupApiAxiosParamCreator = function (configuration?: C
|
|
|
13851
13915
|
// http bearer authentication required
|
|
13852
13916
|
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
13853
13917
|
|
|
13854
|
-
if (deleteDependent !== undefined) {
|
|
13855
|
-
localVarQueryParameter['delete_dependent'] = deleteDependent;
|
|
13856
|
-
}
|
|
13857
|
-
|
|
13858
13918
|
|
|
13859
13919
|
|
|
13860
13920
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
@@ -13867,29 +13927,22 @@ export const VirtualRobotSetupApiAxiosParamCreator = function (configuration?: C
|
|
|
13867
13927
|
};
|
|
13868
13928
|
},
|
|
13869
13929
|
/**
|
|
13870
|
-
*
|
|
13871
|
-
* @summary
|
|
13930
|
+
* Set virtual controller behavior.
|
|
13931
|
+
* @summary Set Behavior
|
|
13872
13932
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
13873
13933
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
13874
|
-
* @param {
|
|
13875
|
-
* @param {string} tcp The unique identifier of a TCP.
|
|
13934
|
+
* @param {Behavior} [behavior]
|
|
13876
13935
|
* @param {*} [options] Override http request option.
|
|
13877
13936
|
* @throws {RequiredError}
|
|
13878
13937
|
*/
|
|
13879
|
-
|
|
13938
|
+
setVirtualRobotBehavior: async (cell: string, controller: string, behavior?: Behavior, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
13880
13939
|
// verify required parameter 'cell' is not null or undefined
|
|
13881
|
-
assertParamExists('
|
|
13940
|
+
assertParamExists('setVirtualRobotBehavior', 'cell', cell)
|
|
13882
13941
|
// verify required parameter 'controller' is not null or undefined
|
|
13883
|
-
assertParamExists('
|
|
13884
|
-
|
|
13885
|
-
assertParamExists('deleteVirtualRobotTcp', 'motionGroup', motionGroup)
|
|
13886
|
-
// verify required parameter 'tcp' is not null or undefined
|
|
13887
|
-
assertParamExists('deleteVirtualRobotTcp', 'tcp', tcp)
|
|
13888
|
-
const localVarPath = `/cells/{cell}/controllers/{controller}/teach-pendant/motion-groups/{motion-group}/tcps/{tcp}`
|
|
13942
|
+
assertParamExists('setVirtualRobotBehavior', 'controller', controller)
|
|
13943
|
+
const localVarPath = `/cells/{cell}/virtual-controllers/{controller}/behavior`
|
|
13889
13944
|
.replace(`{${"cell"}}`, encodeURIComponent(String(cell)))
|
|
13890
|
-
.replace(`{${"controller"}}`, encodeURIComponent(String(controller)))
|
|
13891
|
-
.replace(`{${"motion-group"}}`, encodeURIComponent(String(motionGroup)))
|
|
13892
|
-
.replace(`{${"tcp"}}`, encodeURIComponent(String(tcp)));
|
|
13945
|
+
.replace(`{${"controller"}}`, encodeURIComponent(String(controller)));
|
|
13893
13946
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
13894
13947
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
13895
13948
|
let baseOptions;
|
|
@@ -13897,7 +13950,7 @@ export const VirtualRobotSetupApiAxiosParamCreator = function (configuration?: C
|
|
|
13897
13950
|
baseOptions = configuration.baseOptions;
|
|
13898
13951
|
}
|
|
13899
13952
|
|
|
13900
|
-
const localVarRequestOptions = { method: '
|
|
13953
|
+
const localVarRequestOptions = { method: 'PUT', ...baseOptions, ...options};
|
|
13901
13954
|
const localVarHeaderParameter = {} as any;
|
|
13902
13955
|
const localVarQueryParameter = {} as any;
|
|
13903
13956
|
|
|
@@ -13909,6 +13962,10 @@ export const VirtualRobotSetupApiAxiosParamCreator = function (configuration?: C
|
|
|
13909
13962
|
// http bearer authentication required
|
|
13910
13963
|
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
13911
13964
|
|
|
13965
|
+
if (behavior !== undefined) {
|
|
13966
|
+
localVarQueryParameter['behavior'] = behavior;
|
|
13967
|
+
}
|
|
13968
|
+
|
|
13912
13969
|
|
|
13913
13970
|
|
|
13914
13971
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
@@ -13920,70 +13977,220 @@ export const VirtualRobotSetupApiAxiosParamCreator = function (configuration?: C
|
|
|
13920
13977
|
options: localVarRequestOptions,
|
|
13921
13978
|
};
|
|
13922
13979
|
},
|
|
13980
|
+
}
|
|
13981
|
+
};
|
|
13982
|
+
|
|
13983
|
+
/**
|
|
13984
|
+
* VirtualControllerBehaviorApi - functional programming interface
|
|
13985
|
+
* @export
|
|
13986
|
+
*/
|
|
13987
|
+
export const VirtualControllerBehaviorApiFp = function(configuration?: Configuration) {
|
|
13988
|
+
const localVarAxiosParamCreator = VirtualControllerBehaviorApiAxiosParamCreator(configuration)
|
|
13989
|
+
return {
|
|
13923
13990
|
/**
|
|
13924
|
-
*
|
|
13925
|
-
* @summary
|
|
13991
|
+
* <!-- theme: danger --> > Websocket endpoint This stream sends the commanded state (joint positions, velocities, accelerations, torques) for each motion group of the virtual controller and sets the joint configuration. Moving motion groups on virtual controllers can be executed by using Trajectory Planning and Trajectory Execution. Trajectory Execution commands the desired joint configuration to each motion group. Physical motion groups move to this joint configuration. With physical motion groups, this takes some time and only works if possible. And you have the *actual* joint state - the current real motion group configuration. Again, this stream is providing *commanded* joint state! > **NOTE** > > This stream provides *commanded* joint states, it **doesn\'t provide actual joint states**. When the virtual controller receives joint commands the joint configuration is immediately adapted to match the incoming joint configuration. > **CAUTION** > > Incoming joint configurations are not visualized and their velocity limits are not checked. Possible use cases are: 1. Creating a robotic application that dynamically adapts to the configured joints on the robot controller, using this stream to feed new joint configurations back to the motion groups. The stream only sends data to the robot controller if a motion is executed. If the robot controller\'s joint configuration differs too much from the incoming joint configuration, a following error occurs. Joint configurations that result in following errors are executed only for motions with a low velocity. 2. Mimic Freedrive motions. <!-- theme: danger --> > **DANGER** > > If the incoming joint configuration is set to maximum velocity, the movement to reach this incoming joint configuration > will be executed with maximum speed regardless of safety zones and mechanical limits.
|
|
13992
|
+
* @summary Stream Joint Configuration
|
|
13926
13993
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
13927
13994
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
13928
|
-
* @param {
|
|
13995
|
+
* @param {ExternalJointStreamRequest} externalJointStreamRequest
|
|
13929
13996
|
* @param {*} [options] Override http request option.
|
|
13930
13997
|
* @throws {RequiredError}
|
|
13931
13998
|
*/
|
|
13932
|
-
|
|
13933
|
-
|
|
13934
|
-
|
|
13935
|
-
|
|
13936
|
-
|
|
13937
|
-
|
|
13938
|
-
|
|
13939
|
-
|
|
13940
|
-
|
|
13941
|
-
|
|
13942
|
-
|
|
13943
|
-
|
|
13944
|
-
|
|
13945
|
-
|
|
13946
|
-
|
|
13947
|
-
|
|
13948
|
-
|
|
13949
|
-
|
|
13950
|
-
|
|
13951
|
-
|
|
13952
|
-
|
|
13953
|
-
|
|
13954
|
-
|
|
13955
|
-
|
|
13956
|
-
|
|
13957
|
-
|
|
13958
|
-
|
|
13959
|
-
|
|
13960
|
-
|
|
13999
|
+
async externalJointsStream(cell: string, controller: string, externalJointStreamRequest: ExternalJointStreamRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<ExternalJointStreamDatapoint>>> {
|
|
14000
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.externalJointsStream(cell, controller, externalJointStreamRequest, options);
|
|
14001
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
14002
|
+
const localVarOperationServerBasePath = operationServerMap['VirtualControllerBehaviorApi.externalJointsStream']?.[localVarOperationServerIndex]?.url;
|
|
14003
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
14004
|
+
},
|
|
14005
|
+
/**
|
|
14006
|
+
* Get the cycle time of controller communication in [ms].
|
|
14007
|
+
* @summary Get Cycle Time
|
|
14008
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
14009
|
+
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
14010
|
+
* @param {*} [options] Override http request option.
|
|
14011
|
+
* @throws {RequiredError}
|
|
14012
|
+
*/
|
|
14013
|
+
async getCycleTime(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CycleTime>> {
|
|
14014
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.getCycleTime(cell, controller, options);
|
|
14015
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
14016
|
+
const localVarOperationServerBasePath = operationServerMap['VirtualControllerBehaviorApi.getCycleTime']?.[localVarOperationServerIndex]?.url;
|
|
14017
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
14018
|
+
},
|
|
14019
|
+
/**
|
|
14020
|
+
* Get the current virtual controller behavior - please see the setter [setVirtualRobotBehavior](setVirtualRobotBehavior) and the enum for details.
|
|
14021
|
+
* @summary Get Behavior
|
|
14022
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
14023
|
+
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
14024
|
+
* @param {*} [options] Override http request option.
|
|
14025
|
+
* @throws {RequiredError}
|
|
14026
|
+
*/
|
|
14027
|
+
async getVirtualRobotBehavior(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Behavior>> {
|
|
14028
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.getVirtualRobotBehavior(cell, controller, options);
|
|
14029
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
14030
|
+
const localVarOperationServerBasePath = operationServerMap['VirtualControllerBehaviorApi.getVirtualRobotBehavior']?.[localVarOperationServerIndex]?.url;
|
|
14031
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
14032
|
+
},
|
|
14033
|
+
/**
|
|
14034
|
+
* Set virtual controller behavior.
|
|
14035
|
+
* @summary Set Behavior
|
|
14036
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
14037
|
+
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
14038
|
+
* @param {Behavior} [behavior]
|
|
14039
|
+
* @param {*} [options] Override http request option.
|
|
14040
|
+
* @throws {RequiredError}
|
|
14041
|
+
*/
|
|
14042
|
+
async setVirtualRobotBehavior(cell: string, controller: string, behavior?: Behavior, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> {
|
|
14043
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.setVirtualRobotBehavior(cell, controller, behavior, options);
|
|
14044
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
14045
|
+
const localVarOperationServerBasePath = operationServerMap['VirtualControllerBehaviorApi.setVirtualRobotBehavior']?.[localVarOperationServerIndex]?.url;
|
|
14046
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
14047
|
+
},
|
|
14048
|
+
}
|
|
14049
|
+
};
|
|
13961
14050
|
|
|
14051
|
+
/**
|
|
14052
|
+
* VirtualControllerBehaviorApi - factory interface
|
|
14053
|
+
* @export
|
|
14054
|
+
*/
|
|
14055
|
+
export const VirtualControllerBehaviorApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
|
|
14056
|
+
const localVarFp = VirtualControllerBehaviorApiFp(configuration)
|
|
14057
|
+
return {
|
|
14058
|
+
/**
|
|
14059
|
+
* <!-- theme: danger --> > Websocket endpoint This stream sends the commanded state (joint positions, velocities, accelerations, torques) for each motion group of the virtual controller and sets the joint configuration. Moving motion groups on virtual controllers can be executed by using Trajectory Planning and Trajectory Execution. Trajectory Execution commands the desired joint configuration to each motion group. Physical motion groups move to this joint configuration. With physical motion groups, this takes some time and only works if possible. And you have the *actual* joint state - the current real motion group configuration. Again, this stream is providing *commanded* joint state! > **NOTE** > > This stream provides *commanded* joint states, it **doesn\'t provide actual joint states**. When the virtual controller receives joint commands the joint configuration is immediately adapted to match the incoming joint configuration. > **CAUTION** > > Incoming joint configurations are not visualized and their velocity limits are not checked. Possible use cases are: 1. Creating a robotic application that dynamically adapts to the configured joints on the robot controller, using this stream to feed new joint configurations back to the motion groups. The stream only sends data to the robot controller if a motion is executed. If the robot controller\'s joint configuration differs too much from the incoming joint configuration, a following error occurs. Joint configurations that result in following errors are executed only for motions with a low velocity. 2. Mimic Freedrive motions. <!-- theme: danger --> > **DANGER** > > If the incoming joint configuration is set to maximum velocity, the movement to reach this incoming joint configuration > will be executed with maximum speed regardless of safety zones and mechanical limits.
|
|
14060
|
+
* @summary Stream Joint Configuration
|
|
14061
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
14062
|
+
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
14063
|
+
* @param {ExternalJointStreamRequest} externalJointStreamRequest
|
|
14064
|
+
* @param {*} [options] Override http request option.
|
|
14065
|
+
* @throws {RequiredError}
|
|
14066
|
+
*/
|
|
14067
|
+
externalJointsStream(cell: string, controller: string, externalJointStreamRequest: ExternalJointStreamRequest, options?: RawAxiosRequestConfig): AxiosPromise<Array<ExternalJointStreamDatapoint>> {
|
|
14068
|
+
return localVarFp.externalJointsStream(cell, controller, externalJointStreamRequest, options).then((request) => request(axios, basePath));
|
|
14069
|
+
},
|
|
14070
|
+
/**
|
|
14071
|
+
* Get the cycle time of controller communication in [ms].
|
|
14072
|
+
* @summary Get Cycle Time
|
|
14073
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
14074
|
+
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
14075
|
+
* @param {*} [options] Override http request option.
|
|
14076
|
+
* @throws {RequiredError}
|
|
14077
|
+
*/
|
|
14078
|
+
getCycleTime(cell: string, controller: string, options?: RawAxiosRequestConfig): AxiosPromise<CycleTime> {
|
|
14079
|
+
return localVarFp.getCycleTime(cell, controller, options).then((request) => request(axios, basePath));
|
|
14080
|
+
},
|
|
14081
|
+
/**
|
|
14082
|
+
* Get the current virtual controller behavior - please see the setter [setVirtualRobotBehavior](setVirtualRobotBehavior) and the enum for details.
|
|
14083
|
+
* @summary Get Behavior
|
|
14084
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
14085
|
+
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
14086
|
+
* @param {*} [options] Override http request option.
|
|
14087
|
+
* @throws {RequiredError}
|
|
14088
|
+
*/
|
|
14089
|
+
getVirtualRobotBehavior(cell: string, controller: string, options?: RawAxiosRequestConfig): AxiosPromise<Behavior> {
|
|
14090
|
+
return localVarFp.getVirtualRobotBehavior(cell, controller, options).then((request) => request(axios, basePath));
|
|
14091
|
+
},
|
|
14092
|
+
/**
|
|
14093
|
+
* Set virtual controller behavior.
|
|
14094
|
+
* @summary Set Behavior
|
|
14095
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
14096
|
+
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
14097
|
+
* @param {Behavior} [behavior]
|
|
14098
|
+
* @param {*} [options] Override http request option.
|
|
14099
|
+
* @throws {RequiredError}
|
|
14100
|
+
*/
|
|
14101
|
+
setVirtualRobotBehavior(cell: string, controller: string, behavior?: Behavior, options?: RawAxiosRequestConfig): AxiosPromise<void> {
|
|
14102
|
+
return localVarFp.setVirtualRobotBehavior(cell, controller, behavior, options).then((request) => request(axios, basePath));
|
|
14103
|
+
},
|
|
14104
|
+
};
|
|
14105
|
+
};
|
|
13962
14106
|
|
|
13963
|
-
|
|
13964
|
-
|
|
13965
|
-
|
|
13966
|
-
|
|
14107
|
+
/**
|
|
14108
|
+
* VirtualControllerBehaviorApi - object-oriented interface
|
|
14109
|
+
* @export
|
|
14110
|
+
* @class VirtualControllerBehaviorApi
|
|
14111
|
+
* @extends {BaseAPI}
|
|
14112
|
+
*/
|
|
14113
|
+
export class VirtualControllerBehaviorApi extends BaseAPI {
|
|
14114
|
+
/**
|
|
14115
|
+
* <!-- theme: danger --> > Websocket endpoint This stream sends the commanded state (joint positions, velocities, accelerations, torques) for each motion group of the virtual controller and sets the joint configuration. Moving motion groups on virtual controllers can be executed by using Trajectory Planning and Trajectory Execution. Trajectory Execution commands the desired joint configuration to each motion group. Physical motion groups move to this joint configuration. With physical motion groups, this takes some time and only works if possible. And you have the *actual* joint state - the current real motion group configuration. Again, this stream is providing *commanded* joint state! > **NOTE** > > This stream provides *commanded* joint states, it **doesn\'t provide actual joint states**. When the virtual controller receives joint commands the joint configuration is immediately adapted to match the incoming joint configuration. > **CAUTION** > > Incoming joint configurations are not visualized and their velocity limits are not checked. Possible use cases are: 1. Creating a robotic application that dynamically adapts to the configured joints on the robot controller, using this stream to feed new joint configurations back to the motion groups. The stream only sends data to the robot controller if a motion is executed. If the robot controller\'s joint configuration differs too much from the incoming joint configuration, a following error occurs. Joint configurations that result in following errors are executed only for motions with a low velocity. 2. Mimic Freedrive motions. <!-- theme: danger --> > **DANGER** > > If the incoming joint configuration is set to maximum velocity, the movement to reach this incoming joint configuration > will be executed with maximum speed regardless of safety zones and mechanical limits.
|
|
14116
|
+
* @summary Stream Joint Configuration
|
|
14117
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
14118
|
+
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
14119
|
+
* @param {ExternalJointStreamRequest} externalJointStreamRequest
|
|
14120
|
+
* @param {*} [options] Override http request option.
|
|
14121
|
+
* @throws {RequiredError}
|
|
14122
|
+
* @memberof VirtualControllerBehaviorApi
|
|
14123
|
+
*/
|
|
14124
|
+
public externalJointsStream(cell: string, controller: string, externalJointStreamRequest: ExternalJointStreamRequest, options?: RawAxiosRequestConfig) {
|
|
14125
|
+
return VirtualControllerBehaviorApiFp(this.configuration).externalJointsStream(cell, controller, externalJointStreamRequest, options).then((request) => request(this.axios, this.basePath));
|
|
14126
|
+
}
|
|
13967
14127
|
|
|
13968
|
-
|
|
13969
|
-
|
|
13970
|
-
|
|
13971
|
-
|
|
13972
|
-
|
|
14128
|
+
/**
|
|
14129
|
+
* Get the cycle time of controller communication in [ms].
|
|
14130
|
+
* @summary Get Cycle Time
|
|
14131
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
14132
|
+
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
14133
|
+
* @param {*} [options] Override http request option.
|
|
14134
|
+
* @throws {RequiredError}
|
|
14135
|
+
* @memberof VirtualControllerBehaviorApi
|
|
14136
|
+
*/
|
|
14137
|
+
public getCycleTime(cell: string, controller: string, options?: RawAxiosRequestConfig) {
|
|
14138
|
+
return VirtualControllerBehaviorApiFp(this.configuration).getCycleTime(cell, controller, options).then((request) => request(this.axios, this.basePath));
|
|
14139
|
+
}
|
|
14140
|
+
|
|
14141
|
+
/**
|
|
14142
|
+
* Get the current virtual controller behavior - please see the setter [setVirtualRobotBehavior](setVirtualRobotBehavior) and the enum for details.
|
|
14143
|
+
* @summary Get Behavior
|
|
14144
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
14145
|
+
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
14146
|
+
* @param {*} [options] Override http request option.
|
|
14147
|
+
* @throws {RequiredError}
|
|
14148
|
+
* @memberof VirtualControllerBehaviorApi
|
|
14149
|
+
*/
|
|
14150
|
+
public getVirtualRobotBehavior(cell: string, controller: string, options?: RawAxiosRequestConfig) {
|
|
14151
|
+
return VirtualControllerBehaviorApiFp(this.configuration).getVirtualRobotBehavior(cell, controller, options).then((request) => request(this.axios, this.basePath));
|
|
14152
|
+
}
|
|
14153
|
+
|
|
14154
|
+
/**
|
|
14155
|
+
* Set virtual controller behavior.
|
|
14156
|
+
* @summary Set Behavior
|
|
14157
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
14158
|
+
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
14159
|
+
* @param {Behavior} [behavior]
|
|
14160
|
+
* @param {*} [options] Override http request option.
|
|
14161
|
+
* @throws {RequiredError}
|
|
14162
|
+
* @memberof VirtualControllerBehaviorApi
|
|
14163
|
+
*/
|
|
14164
|
+
public setVirtualRobotBehavior(cell: string, controller: string, behavior?: Behavior, options?: RawAxiosRequestConfig) {
|
|
14165
|
+
return VirtualControllerBehaviorApiFp(this.configuration).setVirtualRobotBehavior(cell, controller, behavior, options).then((request) => request(this.axios, this.basePath));
|
|
14166
|
+
}
|
|
14167
|
+
}
|
|
14168
|
+
|
|
14169
|
+
|
|
14170
|
+
|
|
14171
|
+
/**
|
|
14172
|
+
* VirtualControllerInputsOutputsApi - axios parameter creator
|
|
14173
|
+
* @export
|
|
14174
|
+
*/
|
|
14175
|
+
export const VirtualControllerInputsOutputsApiAxiosParamCreator = function (configuration?: Configuration) {
|
|
14176
|
+
return {
|
|
13973
14177
|
/**
|
|
13974
|
-
*
|
|
13975
|
-
* @summary
|
|
14178
|
+
* Retrieves the current values of inputs/outputs of the virtual controller. The identifiers of inputs/outputs must be provided in the request. Request all available input/output identifiers via [listVirtualRobotIODescriptions](listVirtualRobotIODescriptions).
|
|
14179
|
+
* @summary Get Input/Output Values
|
|
13976
14180
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
13977
14181
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
14182
|
+
* @param {Array<string>} ios
|
|
13978
14183
|
* @param {*} [options] Override http request option.
|
|
13979
14184
|
* @throws {RequiredError}
|
|
13980
14185
|
*/
|
|
13981
|
-
|
|
14186
|
+
listIOs: async (cell: string, controller: string, ios: Array<string>, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
13982
14187
|
// verify required parameter 'cell' is not null or undefined
|
|
13983
|
-
assertParamExists('
|
|
14188
|
+
assertParamExists('listIOs', 'cell', cell)
|
|
13984
14189
|
// verify required parameter 'controller' is not null or undefined
|
|
13985
|
-
assertParamExists('
|
|
13986
|
-
|
|
14190
|
+
assertParamExists('listIOs', 'controller', controller)
|
|
14191
|
+
// verify required parameter 'ios' is not null or undefined
|
|
14192
|
+
assertParamExists('listIOs', 'ios', ios)
|
|
14193
|
+
const localVarPath = `/cells/{cell}/virtual-controllers/{controller}/ios/values`
|
|
13987
14194
|
.replace(`{${"cell"}}`, encodeURIComponent(String(cell)))
|
|
13988
14195
|
.replace(`{${"controller"}}`, encodeURIComponent(String(controller)));
|
|
13989
14196
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
@@ -14005,6 +14212,10 @@ export const VirtualRobotSetupApiAxiosParamCreator = function (configuration?: C
|
|
|
14005
14212
|
// http bearer authentication required
|
|
14006
14213
|
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
14007
14214
|
|
|
14215
|
+
if (ios) {
|
|
14216
|
+
localVarQueryParameter['ios'] = ios;
|
|
14217
|
+
}
|
|
14218
|
+
|
|
14008
14219
|
|
|
14009
14220
|
|
|
14010
14221
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
@@ -14017,25 +14228,25 @@ export const VirtualRobotSetupApiAxiosParamCreator = function (configuration?: C
|
|
|
14017
14228
|
};
|
|
14018
14229
|
},
|
|
14019
14230
|
/**
|
|
14020
|
-
* Lists
|
|
14021
|
-
* @summary List
|
|
14231
|
+
* Lists the input/output descriptions of the virtual robot controller. The input/output descriptions contain information like name, type and unit. Available inputs/outputs are defined by the virtual robot controller. Each input/output has a unique identifier. If no identifiers are specified in the request, all available inputs/outputs are retrieved by this endpoint. Exception: When a filter (e.g., direction, value_type, group) is applied, only matching inputs/outputs are returned.
|
|
14232
|
+
* @summary List Descriptions
|
|
14022
14233
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
14023
14234
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
14024
|
-
* @param {string}
|
|
14235
|
+
* @param {Array<string>} [ios]
|
|
14236
|
+
* @param {IODirection} [direction] Return only inputs/outputs with the specified direction.
|
|
14237
|
+
* @param {IOValueType} [valueType] Return only inputs/outputs with the specified value type.
|
|
14238
|
+
* @param {string} [group] Return only inputs/outputs from the specified group.
|
|
14025
14239
|
* @param {*} [options] Override http request option.
|
|
14026
14240
|
* @throws {RequiredError}
|
|
14027
14241
|
*/
|
|
14028
|
-
|
|
14242
|
+
listVirtualRobotIODescriptions: async (cell: string, controller: string, ios?: Array<string>, direction?: IODirection, valueType?: IOValueType, group?: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
14029
14243
|
// verify required parameter 'cell' is not null or undefined
|
|
14030
|
-
assertParamExists('
|
|
14244
|
+
assertParamExists('listVirtualRobotIODescriptions', 'cell', cell)
|
|
14031
14245
|
// verify required parameter 'controller' is not null or undefined
|
|
14032
|
-
assertParamExists('
|
|
14033
|
-
|
|
14034
|
-
assertParamExists('listVirtualRobotTcps', 'motionGroup', motionGroup)
|
|
14035
|
-
const localVarPath = `/cells/{cell}/controllers/{controller}/teach-pendant/motion-groups/{motion-group}/tcps`
|
|
14246
|
+
assertParamExists('listVirtualRobotIODescriptions', 'controller', controller)
|
|
14247
|
+
const localVarPath = `/cells/{cell}/virtual-controllers/{controller}/ios/description`
|
|
14036
14248
|
.replace(`{${"cell"}}`, encodeURIComponent(String(cell)))
|
|
14037
|
-
.replace(`{${"controller"}}`, encodeURIComponent(String(controller)))
|
|
14038
|
-
.replace(`{${"motion-group"}}`, encodeURIComponent(String(motionGroup)));
|
|
14249
|
+
.replace(`{${"controller"}}`, encodeURIComponent(String(controller)));
|
|
14039
14250
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
14040
14251
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
14041
14252
|
let baseOptions;
|
|
@@ -14055,6 +14266,22 @@ export const VirtualRobotSetupApiAxiosParamCreator = function (configuration?: C
|
|
|
14055
14266
|
// http bearer authentication required
|
|
14056
14267
|
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
14057
14268
|
|
|
14269
|
+
if (ios) {
|
|
14270
|
+
localVarQueryParameter['ios'] = ios;
|
|
14271
|
+
}
|
|
14272
|
+
|
|
14273
|
+
if (direction !== undefined) {
|
|
14274
|
+
localVarQueryParameter['direction'] = direction;
|
|
14275
|
+
}
|
|
14276
|
+
|
|
14277
|
+
if (valueType !== undefined) {
|
|
14278
|
+
localVarQueryParameter['value_type'] = valueType;
|
|
14279
|
+
}
|
|
14280
|
+
|
|
14281
|
+
if (group !== undefined) {
|
|
14282
|
+
localVarQueryParameter['group'] = group;
|
|
14283
|
+
}
|
|
14284
|
+
|
|
14058
14285
|
|
|
14059
14286
|
|
|
14060
14287
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
@@ -14067,28 +14294,24 @@ export const VirtualRobotSetupApiAxiosParamCreator = function (configuration?: C
|
|
|
14067
14294
|
};
|
|
14068
14295
|
},
|
|
14069
14296
|
/**
|
|
14070
|
-
* Sets
|
|
14071
|
-
* @summary Set
|
|
14297
|
+
* Sets a list of values of a virtual controller inputs/outputs.
|
|
14298
|
+
* @summary Set Input/Ouput Values
|
|
14072
14299
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
14073
14300
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
14074
|
-
* @param {
|
|
14075
|
-
* @param {CoordinateSystem} coordinateSystem
|
|
14301
|
+
* @param {Array<IOValue>} iOValue
|
|
14076
14302
|
* @param {*} [options] Override http request option.
|
|
14077
14303
|
* @throws {RequiredError}
|
|
14078
14304
|
*/
|
|
14079
|
-
|
|
14305
|
+
setIOValues: async (cell: string, controller: string, iOValue: Array<IOValue>, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
14080
14306
|
// verify required parameter 'cell' is not null or undefined
|
|
14081
|
-
assertParamExists('
|
|
14307
|
+
assertParamExists('setIOValues', 'cell', cell)
|
|
14082
14308
|
// verify required parameter 'controller' is not null or undefined
|
|
14083
|
-
assertParamExists('
|
|
14084
|
-
// verify required parameter '
|
|
14085
|
-
assertParamExists('
|
|
14086
|
-
|
|
14087
|
-
assertParamExists('setVirtualRobotMounting', 'coordinateSystem', coordinateSystem)
|
|
14088
|
-
const localVarPath = `/cells/{cell}/controllers/{controller}/teach-pendant/motion-groups/{motion-group}/mounting`
|
|
14309
|
+
assertParamExists('setIOValues', 'controller', controller)
|
|
14310
|
+
// verify required parameter 'iOValue' is not null or undefined
|
|
14311
|
+
assertParamExists('setIOValues', 'iOValue', iOValue)
|
|
14312
|
+
const localVarPath = `/cells/{cell}/virtual-controllers/{controller}/ios/values`
|
|
14089
14313
|
.replace(`{${"cell"}}`, encodeURIComponent(String(cell)))
|
|
14090
|
-
.replace(`{${"controller"}}`, encodeURIComponent(String(controller)))
|
|
14091
|
-
.replace(`{${"motion-group"}}`, encodeURIComponent(String(motionGroup)));
|
|
14314
|
+
.replace(`{${"controller"}}`, encodeURIComponent(String(controller)));
|
|
14092
14315
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
14093
14316
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
14094
14317
|
let baseOptions;
|
|
@@ -14115,7 +14338,7 @@ export const VirtualRobotSetupApiAxiosParamCreator = function (configuration?: C
|
|
|
14115
14338
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
14116
14339
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
14117
14340
|
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
14118
|
-
localVarRequestOptions.data = serializeDataIfNeeded(
|
|
14341
|
+
localVarRequestOptions.data = serializeDataIfNeeded(iOValue, localVarRequestOptions, configuration)
|
|
14119
14342
|
|
|
14120
14343
|
return {
|
|
14121
14344
|
url: toPathString(localVarUrlObj),
|
|
@@ -14126,367 +14349,162 @@ export const VirtualRobotSetupApiAxiosParamCreator = function (configuration?: C
|
|
|
14126
14349
|
};
|
|
14127
14350
|
|
|
14128
14351
|
/**
|
|
14129
|
-
*
|
|
14352
|
+
* VirtualControllerInputsOutputsApi - functional programming interface
|
|
14130
14353
|
* @export
|
|
14131
14354
|
*/
|
|
14132
|
-
export const
|
|
14133
|
-
const localVarAxiosParamCreator =
|
|
14355
|
+
export const VirtualControllerInputsOutputsApiFp = function(configuration?: Configuration) {
|
|
14356
|
+
const localVarAxiosParamCreator = VirtualControllerInputsOutputsApiAxiosParamCreator(configuration)
|
|
14134
14357
|
return {
|
|
14135
14358
|
/**
|
|
14136
|
-
*
|
|
14137
|
-
* @summary
|
|
14138
|
-
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
14139
|
-
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
14140
|
-
* @param {CoordinateSystem} coordinateSystem
|
|
14141
|
-
* @param {*} [options] Override http request option.
|
|
14142
|
-
* @throws {RequiredError}
|
|
14143
|
-
*/
|
|
14144
|
-
async addVirtualRobotCoordinateSystem(cell: string, controller: string, coordinateSystem: CoordinateSystem, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> {
|
|
14145
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.addVirtualRobotCoordinateSystem(cell, controller, coordinateSystem, options);
|
|
14146
|
-
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
14147
|
-
const localVarOperationServerBasePath = operationServerMap['VirtualRobotSetupApi.addVirtualRobotCoordinateSystem']?.[localVarOperationServerIndex]?.url;
|
|
14148
|
-
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
14149
|
-
},
|
|
14150
|
-
/**
|
|
14151
|
-
* Adds a new TCP or updates an existing TCP in the motion group. The position and rotation values in the request body are defined within the flange’s coordinate system. > **NOTE** > > Ensure the TCP\'s position is within the robot\'s reach. Refer to the robot’s documentation or data sheet for details like joint limits or reach.
|
|
14152
|
-
* @summary Add TCP
|
|
14153
|
-
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
14154
|
-
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
14155
|
-
* @param {string} motionGroup The motion-group identifier.
|
|
14156
|
-
* @param {RobotTcp} robotTcp
|
|
14157
|
-
* @param {*} [options] Override http request option.
|
|
14158
|
-
* @throws {RequiredError}
|
|
14159
|
-
*/
|
|
14160
|
-
async addVirtualRobotTcp(cell: string, controller: string, motionGroup: string, robotTcp: RobotTcp, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> {
|
|
14161
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.addVirtualRobotTcp(cell, controller, motionGroup, robotTcp, options);
|
|
14162
|
-
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
14163
|
-
const localVarOperationServerBasePath = operationServerMap['VirtualRobotSetupApi.addVirtualRobotTcp']?.[localVarOperationServerIndex]?.url;
|
|
14164
|
-
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
14165
|
-
},
|
|
14166
|
-
/**
|
|
14167
|
-
* Deletes a coordinate system from the virtual controller. This will remove the coordinate system from the list of coordinate systems and remove all dependent coordinate systems which use the deleted coordinate system as reference.
|
|
14168
|
-
* @summary Remove Coordinate System
|
|
14169
|
-
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
14170
|
-
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
14171
|
-
* @param {string} coordinateSystem Unique identifier addressing a coordinate system.
|
|
14172
|
-
* @param {boolean} [deleteDependent] If true, all dependent coordinate systems will be deleted as well.
|
|
14173
|
-
* @param {*} [options] Override http request option.
|
|
14174
|
-
* @throws {RequiredError}
|
|
14175
|
-
*/
|
|
14176
|
-
async deleteVirtualRobotCoordinateSystem(cell: string, controller: string, coordinateSystem: string, deleteDependent?: boolean, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> {
|
|
14177
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.deleteVirtualRobotCoordinateSystem(cell, controller, coordinateSystem, deleteDependent, options);
|
|
14178
|
-
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
14179
|
-
const localVarOperationServerBasePath = operationServerMap['VirtualRobotSetupApi.deleteVirtualRobotCoordinateSystem']?.[localVarOperationServerIndex]?.url;
|
|
14180
|
-
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
14181
|
-
},
|
|
14182
|
-
/**
|
|
14183
|
-
* Removes the TCP from the motion group. An unknown TCP is a valid input.
|
|
14184
|
-
* @summary Remove TCP
|
|
14185
|
-
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
14186
|
-
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
14187
|
-
* @param {string} motionGroup The motion-group identifier.
|
|
14188
|
-
* @param {string} tcp The unique identifier of a TCP.
|
|
14189
|
-
* @param {*} [options] Override http request option.
|
|
14190
|
-
* @throws {RequiredError}
|
|
14191
|
-
*/
|
|
14192
|
-
async deleteVirtualRobotTcp(cell: string, controller: string, motionGroup: string, tcp: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> {
|
|
14193
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.deleteVirtualRobotTcp(cell, controller, motionGroup, tcp, options);
|
|
14194
|
-
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
14195
|
-
const localVarOperationServerBasePath = operationServerMap['VirtualRobotSetupApi.deleteVirtualRobotTcp']?.[localVarOperationServerIndex]?.url;
|
|
14196
|
-
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
14197
|
-
},
|
|
14198
|
-
/**
|
|
14199
|
-
* Gets motion group mounting. The motion group is based on the origin of the returned coordinate system.
|
|
14200
|
-
* @summary Get Mounting
|
|
14201
|
-
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
14202
|
-
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
14203
|
-
* @param {string} motionGroup The motion-group identifier.
|
|
14204
|
-
* @param {*} [options] Override http request option.
|
|
14205
|
-
* @throws {RequiredError}
|
|
14206
|
-
*/
|
|
14207
|
-
async getVirtualRobotMounting(cell: string, controller: string, motionGroup: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CoordinateSystem>> {
|
|
14208
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.getVirtualRobotMounting(cell, controller, motionGroup, options);
|
|
14209
|
-
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
14210
|
-
const localVarOperationServerBasePath = operationServerMap['VirtualRobotSetupApi.getVirtualRobotMounting']?.[localVarOperationServerIndex]?.url;
|
|
14211
|
-
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
14212
|
-
},
|
|
14213
|
-
/**
|
|
14214
|
-
* Lists all coordinate systems on the robot controller.
|
|
14215
|
-
* @summary List Coordinate Systems
|
|
14359
|
+
* Retrieves the current values of inputs/outputs of the virtual controller. The identifiers of inputs/outputs must be provided in the request. Request all available input/output identifiers via [listVirtualRobotIODescriptions](listVirtualRobotIODescriptions).
|
|
14360
|
+
* @summary Get Input/Output Values
|
|
14216
14361
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
14217
14362
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
14363
|
+
* @param {Array<string>} ios
|
|
14218
14364
|
* @param {*} [options] Override http request option.
|
|
14219
14365
|
* @throws {RequiredError}
|
|
14220
14366
|
*/
|
|
14221
|
-
async
|
|
14222
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.
|
|
14367
|
+
async listIOs(cell: string, controller: string, ios: Array<string>, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<IOValue>>> {
|
|
14368
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.listIOs(cell, controller, ios, options);
|
|
14223
14369
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
14224
|
-
const localVarOperationServerBasePath = operationServerMap['
|
|
14370
|
+
const localVarOperationServerBasePath = operationServerMap['VirtualControllerInputsOutputsApi.listIOs']?.[localVarOperationServerIndex]?.url;
|
|
14225
14371
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
14226
14372
|
},
|
|
14227
14373
|
/**
|
|
14228
|
-
* Lists
|
|
14229
|
-
* @summary List
|
|
14374
|
+
* Lists the input/output descriptions of the virtual robot controller. The input/output descriptions contain information like name, type and unit. Available inputs/outputs are defined by the virtual robot controller. Each input/output has a unique identifier. If no identifiers are specified in the request, all available inputs/outputs are retrieved by this endpoint. Exception: When a filter (e.g., direction, value_type, group) is applied, only matching inputs/outputs are returned.
|
|
14375
|
+
* @summary List Descriptions
|
|
14230
14376
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
14231
14377
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
14232
|
-
* @param {string}
|
|
14378
|
+
* @param {Array<string>} [ios]
|
|
14379
|
+
* @param {IODirection} [direction] Return only inputs/outputs with the specified direction.
|
|
14380
|
+
* @param {IOValueType} [valueType] Return only inputs/outputs with the specified value type.
|
|
14381
|
+
* @param {string} [group] Return only inputs/outputs from the specified group.
|
|
14233
14382
|
* @param {*} [options] Override http request option.
|
|
14234
14383
|
* @throws {RequiredError}
|
|
14235
14384
|
*/
|
|
14236
|
-
async
|
|
14237
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.
|
|
14385
|
+
async listVirtualRobotIODescriptions(cell: string, controller: string, ios?: Array<string>, direction?: IODirection, valueType?: IOValueType, group?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<IODescription>>> {
|
|
14386
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.listVirtualRobotIODescriptions(cell, controller, ios, direction, valueType, group, options);
|
|
14238
14387
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
14239
|
-
const localVarOperationServerBasePath = operationServerMap['
|
|
14388
|
+
const localVarOperationServerBasePath = operationServerMap['VirtualControllerInputsOutputsApi.listVirtualRobotIODescriptions']?.[localVarOperationServerIndex]?.url;
|
|
14240
14389
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
14241
14390
|
},
|
|
14242
14391
|
/**
|
|
14243
|
-
* Sets
|
|
14244
|
-
* @summary Set
|
|
14392
|
+
* Sets a list of values of a virtual controller inputs/outputs.
|
|
14393
|
+
* @summary Set Input/Ouput Values
|
|
14245
14394
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
14246
14395
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
14247
|
-
* @param {
|
|
14248
|
-
* @param {CoordinateSystem} coordinateSystem
|
|
14396
|
+
* @param {Array<IOValue>} iOValue
|
|
14249
14397
|
* @param {*} [options] Override http request option.
|
|
14250
14398
|
* @throws {RequiredError}
|
|
14251
14399
|
*/
|
|
14252
|
-
async
|
|
14253
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.
|
|
14400
|
+
async setIOValues(cell: string, controller: string, iOValue: Array<IOValue>, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> {
|
|
14401
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.setIOValues(cell, controller, iOValue, options);
|
|
14254
14402
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
14255
|
-
const localVarOperationServerBasePath = operationServerMap['
|
|
14403
|
+
const localVarOperationServerBasePath = operationServerMap['VirtualControllerInputsOutputsApi.setIOValues']?.[localVarOperationServerIndex]?.url;
|
|
14256
14404
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
14257
14405
|
},
|
|
14258
14406
|
}
|
|
14259
14407
|
};
|
|
14260
14408
|
|
|
14261
14409
|
/**
|
|
14262
|
-
*
|
|
14410
|
+
* VirtualControllerInputsOutputsApi - factory interface
|
|
14263
14411
|
* @export
|
|
14264
14412
|
*/
|
|
14265
|
-
export const
|
|
14266
|
-
const localVarFp =
|
|
14413
|
+
export const VirtualControllerInputsOutputsApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
|
|
14414
|
+
const localVarFp = VirtualControllerInputsOutputsApiFp(configuration)
|
|
14267
14415
|
return {
|
|
14268
14416
|
/**
|
|
14269
|
-
*
|
|
14270
|
-
* @summary
|
|
14271
|
-
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
14272
|
-
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
14273
|
-
* @param {CoordinateSystem} coordinateSystem
|
|
14274
|
-
* @param {*} [options] Override http request option.
|
|
14275
|
-
* @throws {RequiredError}
|
|
14276
|
-
*/
|
|
14277
|
-
addVirtualRobotCoordinateSystem(cell: string, controller: string, coordinateSystem: CoordinateSystem, options?: RawAxiosRequestConfig): AxiosPromise<void> {
|
|
14278
|
-
return localVarFp.addVirtualRobotCoordinateSystem(cell, controller, coordinateSystem, options).then((request) => request(axios, basePath));
|
|
14279
|
-
},
|
|
14280
|
-
/**
|
|
14281
|
-
* Adds a new TCP or updates an existing TCP in the motion group. The position and rotation values in the request body are defined within the flange’s coordinate system. > **NOTE** > > Ensure the TCP\'s position is within the robot\'s reach. Refer to the robot’s documentation or data sheet for details like joint limits or reach.
|
|
14282
|
-
* @summary Add TCP
|
|
14283
|
-
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
14284
|
-
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
14285
|
-
* @param {string} motionGroup The motion-group identifier.
|
|
14286
|
-
* @param {RobotTcp} robotTcp
|
|
14287
|
-
* @param {*} [options] Override http request option.
|
|
14288
|
-
* @throws {RequiredError}
|
|
14289
|
-
*/
|
|
14290
|
-
addVirtualRobotTcp(cell: string, controller: string, motionGroup: string, robotTcp: RobotTcp, options?: RawAxiosRequestConfig): AxiosPromise<void> {
|
|
14291
|
-
return localVarFp.addVirtualRobotTcp(cell, controller, motionGroup, robotTcp, options).then((request) => request(axios, basePath));
|
|
14292
|
-
},
|
|
14293
|
-
/**
|
|
14294
|
-
* Deletes a coordinate system from the virtual controller. This will remove the coordinate system from the list of coordinate systems and remove all dependent coordinate systems which use the deleted coordinate system as reference.
|
|
14295
|
-
* @summary Remove Coordinate System
|
|
14296
|
-
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
14297
|
-
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
14298
|
-
* @param {string} coordinateSystem Unique identifier addressing a coordinate system.
|
|
14299
|
-
* @param {boolean} [deleteDependent] If true, all dependent coordinate systems will be deleted as well.
|
|
14300
|
-
* @param {*} [options] Override http request option.
|
|
14301
|
-
* @throws {RequiredError}
|
|
14302
|
-
*/
|
|
14303
|
-
deleteVirtualRobotCoordinateSystem(cell: string, controller: string, coordinateSystem: string, deleteDependent?: boolean, options?: RawAxiosRequestConfig): AxiosPromise<void> {
|
|
14304
|
-
return localVarFp.deleteVirtualRobotCoordinateSystem(cell, controller, coordinateSystem, deleteDependent, options).then((request) => request(axios, basePath));
|
|
14305
|
-
},
|
|
14306
|
-
/**
|
|
14307
|
-
* Removes the TCP from the motion group. An unknown TCP is a valid input.
|
|
14308
|
-
* @summary Remove TCP
|
|
14309
|
-
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
14310
|
-
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
14311
|
-
* @param {string} motionGroup The motion-group identifier.
|
|
14312
|
-
* @param {string} tcp The unique identifier of a TCP.
|
|
14313
|
-
* @param {*} [options] Override http request option.
|
|
14314
|
-
* @throws {RequiredError}
|
|
14315
|
-
*/
|
|
14316
|
-
deleteVirtualRobotTcp(cell: string, controller: string, motionGroup: string, tcp: string, options?: RawAxiosRequestConfig): AxiosPromise<void> {
|
|
14317
|
-
return localVarFp.deleteVirtualRobotTcp(cell, controller, motionGroup, tcp, options).then((request) => request(axios, basePath));
|
|
14318
|
-
},
|
|
14319
|
-
/**
|
|
14320
|
-
* Gets motion group mounting. The motion group is based on the origin of the returned coordinate system.
|
|
14321
|
-
* @summary Get Mounting
|
|
14322
|
-
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
14323
|
-
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
14324
|
-
* @param {string} motionGroup The motion-group identifier.
|
|
14325
|
-
* @param {*} [options] Override http request option.
|
|
14326
|
-
* @throws {RequiredError}
|
|
14327
|
-
*/
|
|
14328
|
-
getVirtualRobotMounting(cell: string, controller: string, motionGroup: string, options?: RawAxiosRequestConfig): AxiosPromise<CoordinateSystem> {
|
|
14329
|
-
return localVarFp.getVirtualRobotMounting(cell, controller, motionGroup, options).then((request) => request(axios, basePath));
|
|
14330
|
-
},
|
|
14331
|
-
/**
|
|
14332
|
-
* Lists all coordinate systems on the robot controller.
|
|
14333
|
-
* @summary List Coordinate Systems
|
|
14417
|
+
* Retrieves the current values of inputs/outputs of the virtual controller. The identifiers of inputs/outputs must be provided in the request. Request all available input/output identifiers via [listVirtualRobotIODescriptions](listVirtualRobotIODescriptions).
|
|
14418
|
+
* @summary Get Input/Output Values
|
|
14334
14419
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
14335
14420
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
14421
|
+
* @param {Array<string>} ios
|
|
14336
14422
|
* @param {*} [options] Override http request option.
|
|
14337
14423
|
* @throws {RequiredError}
|
|
14338
14424
|
*/
|
|
14339
|
-
|
|
14340
|
-
return localVarFp.
|
|
14425
|
+
listIOs(cell: string, controller: string, ios: Array<string>, options?: RawAxiosRequestConfig): AxiosPromise<Array<IOValue>> {
|
|
14426
|
+
return localVarFp.listIOs(cell, controller, ios, options).then((request) => request(axios, basePath));
|
|
14341
14427
|
},
|
|
14342
14428
|
/**
|
|
14343
|
-
* Lists
|
|
14344
|
-
* @summary List
|
|
14429
|
+
* Lists the input/output descriptions of the virtual robot controller. The input/output descriptions contain information like name, type and unit. Available inputs/outputs are defined by the virtual robot controller. Each input/output has a unique identifier. If no identifiers are specified in the request, all available inputs/outputs are retrieved by this endpoint. Exception: When a filter (e.g., direction, value_type, group) is applied, only matching inputs/outputs are returned.
|
|
14430
|
+
* @summary List Descriptions
|
|
14345
14431
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
14346
14432
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
14347
|
-
* @param {string}
|
|
14433
|
+
* @param {Array<string>} [ios]
|
|
14434
|
+
* @param {IODirection} [direction] Return only inputs/outputs with the specified direction.
|
|
14435
|
+
* @param {IOValueType} [valueType] Return only inputs/outputs with the specified value type.
|
|
14436
|
+
* @param {string} [group] Return only inputs/outputs from the specified group.
|
|
14348
14437
|
* @param {*} [options] Override http request option.
|
|
14349
14438
|
* @throws {RequiredError}
|
|
14350
14439
|
*/
|
|
14351
|
-
|
|
14352
|
-
return localVarFp.
|
|
14440
|
+
listVirtualRobotIODescriptions(cell: string, controller: string, ios?: Array<string>, direction?: IODirection, valueType?: IOValueType, group?: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<IODescription>> {
|
|
14441
|
+
return localVarFp.listVirtualRobotIODescriptions(cell, controller, ios, direction, valueType, group, options).then((request) => request(axios, basePath));
|
|
14353
14442
|
},
|
|
14354
14443
|
/**
|
|
14355
|
-
* Sets
|
|
14356
|
-
* @summary Set
|
|
14444
|
+
* Sets a list of values of a virtual controller inputs/outputs.
|
|
14445
|
+
* @summary Set Input/Ouput Values
|
|
14357
14446
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
14358
14447
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
14359
|
-
* @param {
|
|
14360
|
-
* @param {CoordinateSystem} coordinateSystem
|
|
14448
|
+
* @param {Array<IOValue>} iOValue
|
|
14361
14449
|
* @param {*} [options] Override http request option.
|
|
14362
14450
|
* @throws {RequiredError}
|
|
14363
14451
|
*/
|
|
14364
|
-
|
|
14365
|
-
return localVarFp.
|
|
14452
|
+
setIOValues(cell: string, controller: string, iOValue: Array<IOValue>, options?: RawAxiosRequestConfig): AxiosPromise<void> {
|
|
14453
|
+
return localVarFp.setIOValues(cell, controller, iOValue, options).then((request) => request(axios, basePath));
|
|
14366
14454
|
},
|
|
14367
14455
|
};
|
|
14368
14456
|
};
|
|
14369
14457
|
|
|
14370
14458
|
/**
|
|
14371
|
-
*
|
|
14459
|
+
* VirtualControllerInputsOutputsApi - object-oriented interface
|
|
14372
14460
|
* @export
|
|
14373
|
-
* @class
|
|
14461
|
+
* @class VirtualControllerInputsOutputsApi
|
|
14374
14462
|
* @extends {BaseAPI}
|
|
14375
14463
|
*/
|
|
14376
|
-
export class
|
|
14377
|
-
/**
|
|
14378
|
-
* Adds a coordinate system to the robot controller.
|
|
14379
|
-
* @summary Add Coordinate Systems
|
|
14380
|
-
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
14381
|
-
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
14382
|
-
* @param {CoordinateSystem} coordinateSystem
|
|
14383
|
-
* @param {*} [options] Override http request option.
|
|
14384
|
-
* @throws {RequiredError}
|
|
14385
|
-
* @memberof VirtualRobotSetupApi
|
|
14386
|
-
*/
|
|
14387
|
-
public addVirtualRobotCoordinateSystem(cell: string, controller: string, coordinateSystem: CoordinateSystem, options?: RawAxiosRequestConfig) {
|
|
14388
|
-
return VirtualRobotSetupApiFp(this.configuration).addVirtualRobotCoordinateSystem(cell, controller, coordinateSystem, options).then((request) => request(this.axios, this.basePath));
|
|
14389
|
-
}
|
|
14390
|
-
|
|
14391
|
-
/**
|
|
14392
|
-
* Adds a new TCP or updates an existing TCP in the motion group. The position and rotation values in the request body are defined within the flange’s coordinate system. > **NOTE** > > Ensure the TCP\'s position is within the robot\'s reach. Refer to the robot’s documentation or data sheet for details like joint limits or reach.
|
|
14393
|
-
* @summary Add TCP
|
|
14394
|
-
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
14395
|
-
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
14396
|
-
* @param {string} motionGroup The motion-group identifier.
|
|
14397
|
-
* @param {RobotTcp} robotTcp
|
|
14398
|
-
* @param {*} [options] Override http request option.
|
|
14399
|
-
* @throws {RequiredError}
|
|
14400
|
-
* @memberof VirtualRobotSetupApi
|
|
14401
|
-
*/
|
|
14402
|
-
public addVirtualRobotTcp(cell: string, controller: string, motionGroup: string, robotTcp: RobotTcp, options?: RawAxiosRequestConfig) {
|
|
14403
|
-
return VirtualRobotSetupApiFp(this.configuration).addVirtualRobotTcp(cell, controller, motionGroup, robotTcp, options).then((request) => request(this.axios, this.basePath));
|
|
14404
|
-
}
|
|
14405
|
-
|
|
14406
|
-
/**
|
|
14407
|
-
* Deletes a coordinate system from the virtual controller. This will remove the coordinate system from the list of coordinate systems and remove all dependent coordinate systems which use the deleted coordinate system as reference.
|
|
14408
|
-
* @summary Remove Coordinate System
|
|
14409
|
-
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
14410
|
-
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
14411
|
-
* @param {string} coordinateSystem Unique identifier addressing a coordinate system.
|
|
14412
|
-
* @param {boolean} [deleteDependent] If true, all dependent coordinate systems will be deleted as well.
|
|
14413
|
-
* @param {*} [options] Override http request option.
|
|
14414
|
-
* @throws {RequiredError}
|
|
14415
|
-
* @memberof VirtualRobotSetupApi
|
|
14416
|
-
*/
|
|
14417
|
-
public deleteVirtualRobotCoordinateSystem(cell: string, controller: string, coordinateSystem: string, deleteDependent?: boolean, options?: RawAxiosRequestConfig) {
|
|
14418
|
-
return VirtualRobotSetupApiFp(this.configuration).deleteVirtualRobotCoordinateSystem(cell, controller, coordinateSystem, deleteDependent, options).then((request) => request(this.axios, this.basePath));
|
|
14419
|
-
}
|
|
14420
|
-
|
|
14421
|
-
/**
|
|
14422
|
-
* Removes the TCP from the motion group. An unknown TCP is a valid input.
|
|
14423
|
-
* @summary Remove TCP
|
|
14424
|
-
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
14425
|
-
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
14426
|
-
* @param {string} motionGroup The motion-group identifier.
|
|
14427
|
-
* @param {string} tcp The unique identifier of a TCP.
|
|
14428
|
-
* @param {*} [options] Override http request option.
|
|
14429
|
-
* @throws {RequiredError}
|
|
14430
|
-
* @memberof VirtualRobotSetupApi
|
|
14431
|
-
*/
|
|
14432
|
-
public deleteVirtualRobotTcp(cell: string, controller: string, motionGroup: string, tcp: string, options?: RawAxiosRequestConfig) {
|
|
14433
|
-
return VirtualRobotSetupApiFp(this.configuration).deleteVirtualRobotTcp(cell, controller, motionGroup, tcp, options).then((request) => request(this.axios, this.basePath));
|
|
14434
|
-
}
|
|
14435
|
-
|
|
14436
|
-
/**
|
|
14437
|
-
* Gets motion group mounting. The motion group is based on the origin of the returned coordinate system.
|
|
14438
|
-
* @summary Get Mounting
|
|
14439
|
-
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
14440
|
-
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
14441
|
-
* @param {string} motionGroup The motion-group identifier.
|
|
14442
|
-
* @param {*} [options] Override http request option.
|
|
14443
|
-
* @throws {RequiredError}
|
|
14444
|
-
* @memberof VirtualRobotSetupApi
|
|
14445
|
-
*/
|
|
14446
|
-
public getVirtualRobotMounting(cell: string, controller: string, motionGroup: string, options?: RawAxiosRequestConfig) {
|
|
14447
|
-
return VirtualRobotSetupApiFp(this.configuration).getVirtualRobotMounting(cell, controller, motionGroup, options).then((request) => request(this.axios, this.basePath));
|
|
14448
|
-
}
|
|
14449
|
-
|
|
14464
|
+
export class VirtualControllerInputsOutputsApi extends BaseAPI {
|
|
14450
14465
|
/**
|
|
14451
|
-
*
|
|
14452
|
-
* @summary
|
|
14466
|
+
* Retrieves the current values of inputs/outputs of the virtual controller. The identifiers of inputs/outputs must be provided in the request. Request all available input/output identifiers via [listVirtualRobotIODescriptions](listVirtualRobotIODescriptions).
|
|
14467
|
+
* @summary Get Input/Output Values
|
|
14453
14468
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
14454
14469
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
14470
|
+
* @param {Array<string>} ios
|
|
14455
14471
|
* @param {*} [options] Override http request option.
|
|
14456
14472
|
* @throws {RequiredError}
|
|
14457
|
-
* @memberof
|
|
14473
|
+
* @memberof VirtualControllerInputsOutputsApi
|
|
14458
14474
|
*/
|
|
14459
|
-
public
|
|
14460
|
-
return
|
|
14475
|
+
public listIOs(cell: string, controller: string, ios: Array<string>, options?: RawAxiosRequestConfig) {
|
|
14476
|
+
return VirtualControllerInputsOutputsApiFp(this.configuration).listIOs(cell, controller, ios, options).then((request) => request(this.axios, this.basePath));
|
|
14461
14477
|
}
|
|
14462
14478
|
|
|
14463
14479
|
/**
|
|
14464
|
-
* Lists
|
|
14465
|
-
* @summary List
|
|
14480
|
+
* Lists the input/output descriptions of the virtual robot controller. The input/output descriptions contain information like name, type and unit. Available inputs/outputs are defined by the virtual robot controller. Each input/output has a unique identifier. If no identifiers are specified in the request, all available inputs/outputs are retrieved by this endpoint. Exception: When a filter (e.g., direction, value_type, group) is applied, only matching inputs/outputs are returned.
|
|
14481
|
+
* @summary List Descriptions
|
|
14466
14482
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
14467
14483
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
14468
|
-
* @param {string}
|
|
14484
|
+
* @param {Array<string>} [ios]
|
|
14485
|
+
* @param {IODirection} [direction] Return only inputs/outputs with the specified direction.
|
|
14486
|
+
* @param {IOValueType} [valueType] Return only inputs/outputs with the specified value type.
|
|
14487
|
+
* @param {string} [group] Return only inputs/outputs from the specified group.
|
|
14469
14488
|
* @param {*} [options] Override http request option.
|
|
14470
14489
|
* @throws {RequiredError}
|
|
14471
|
-
* @memberof
|
|
14490
|
+
* @memberof VirtualControllerInputsOutputsApi
|
|
14472
14491
|
*/
|
|
14473
|
-
public
|
|
14474
|
-
return
|
|
14492
|
+
public listVirtualRobotIODescriptions(cell: string, controller: string, ios?: Array<string>, direction?: IODirection, valueType?: IOValueType, group?: string, options?: RawAxiosRequestConfig) {
|
|
14493
|
+
return VirtualControllerInputsOutputsApiFp(this.configuration).listVirtualRobotIODescriptions(cell, controller, ios, direction, valueType, group, options).then((request) => request(this.axios, this.basePath));
|
|
14475
14494
|
}
|
|
14476
14495
|
|
|
14477
14496
|
/**
|
|
14478
|
-
* Sets
|
|
14479
|
-
* @summary Set
|
|
14497
|
+
* Sets a list of values of a virtual controller inputs/outputs.
|
|
14498
|
+
* @summary Set Input/Ouput Values
|
|
14480
14499
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
14481
14500
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
14482
|
-
* @param {
|
|
14483
|
-
* @param {CoordinateSystem} coordinateSystem
|
|
14501
|
+
* @param {Array<IOValue>} iOValue
|
|
14484
14502
|
* @param {*} [options] Override http request option.
|
|
14485
14503
|
* @throws {RequiredError}
|
|
14486
|
-
* @memberof
|
|
14504
|
+
* @memberof VirtualControllerInputsOutputsApi
|
|
14487
14505
|
*/
|
|
14488
|
-
public
|
|
14489
|
-
return
|
|
14506
|
+
public setIOValues(cell: string, controller: string, iOValue: Array<IOValue>, options?: RawAxiosRequestConfig) {
|
|
14507
|
+
return VirtualControllerInputsOutputsApiFp(this.configuration).setIOValues(cell, controller, iOValue, options).then((request) => request(this.axios, this.basePath));
|
|
14490
14508
|
}
|
|
14491
14509
|
}
|
|
14492
14510
|
|