@wandelbots/nova-api 25.4.0-dev.27 → 25.4.0-dev.29
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/v1/api.d.ts +2 -2
- package/v1/api.ts +2 -2
- package/v2/api.d.ts +220 -349
- package/v2/api.js +150 -99
- package/v2/api.js.map +1 -1
- package/v2/api.ts +286 -394
package/v2/api.js
CHANGED
|
@@ -36,6 +36,9 @@ export const BlendingAutoBlendingNameEnum = {
|
|
|
36
36
|
export const BlendingPositionBlendingNameEnum = {
|
|
37
37
|
BlendingPosition: 'BlendingPosition'
|
|
38
38
|
};
|
|
39
|
+
export const BooleanValueValueTypeEnum = {
|
|
40
|
+
Boolean: 'boolean'
|
|
41
|
+
};
|
|
39
42
|
export const BoxTypeEnum = {
|
|
40
43
|
TypeHollow: 'TYPE_HOLLOW',
|
|
41
44
|
TypeFull: 'TYPE_FULL'
|
|
@@ -93,11 +96,11 @@ export const FeedbackOutOfWorkspaceErrorFeedbackNameEnum = {
|
|
|
93
96
|
export const FeedbackSingularityErrorFeedbackNameEnum = {
|
|
94
97
|
FeedbackSingularity: 'FeedbackSingularity'
|
|
95
98
|
};
|
|
96
|
-
export const
|
|
97
|
-
|
|
99
|
+
export const FloatValueValueTypeEnum = {
|
|
100
|
+
Float: 'float'
|
|
98
101
|
};
|
|
99
|
-
export const
|
|
100
|
-
|
|
102
|
+
export const IOBooleanValueValueTypeEnum = {
|
|
103
|
+
Boolean: 'boolean'
|
|
101
104
|
};
|
|
102
105
|
/**
|
|
103
106
|
* Identifies the input/output type.
|
|
@@ -108,17 +111,11 @@ export const IODirection = {
|
|
|
108
111
|
IoTypeInput: 'IO_TYPE_INPUT',
|
|
109
112
|
IoTypeOutput: 'IO_TYPE_OUTPUT'
|
|
110
113
|
};
|
|
111
|
-
export const
|
|
112
|
-
|
|
113
|
-
};
|
|
114
|
-
export const IOFloatValue2IoValueTypeEnum = {
|
|
115
|
-
IoFloatValue: 'IOFloatValue'
|
|
116
|
-
};
|
|
117
|
-
export const IOIntegerValueIoValueTypeEnum = {
|
|
118
|
-
IoIntegerValue: 'IOIntegerValue'
|
|
114
|
+
export const IOFloatValueValueTypeEnum = {
|
|
115
|
+
Float: 'float'
|
|
119
116
|
};
|
|
120
|
-
export const
|
|
121
|
-
|
|
117
|
+
export const IOIntegerValueValueTypeEnum = {
|
|
118
|
+
Integer: 'integer'
|
|
122
119
|
};
|
|
123
120
|
/**
|
|
124
121
|
* Data type of the input/output.
|
|
@@ -130,15 +127,15 @@ export const IOValueType = {
|
|
|
130
127
|
IoValueAnalogFloat: 'IO_VALUE_ANALOG_FLOAT',
|
|
131
128
|
IoValueAnalogInteger: 'IO_VALUE_ANALOG_INTEGER'
|
|
132
129
|
};
|
|
133
|
-
export const IOsIosInnerIoValueTypeEnum = {
|
|
134
|
-
IoFloatValue: 'IOFloatValue'
|
|
135
|
-
};
|
|
136
130
|
export const InitializeJoggingRequestMessageTypeEnum = {
|
|
137
131
|
InitializeJoggingRequest: 'InitializeJoggingRequest'
|
|
138
132
|
};
|
|
139
133
|
export const InitializeMovementRequestMessageTypeEnum = {
|
|
140
134
|
InitializeMovementRequest: 'InitializeMovementRequest'
|
|
141
135
|
};
|
|
136
|
+
export const IntegerValueValueTypeEnum = {
|
|
137
|
+
Integer: 'integer'
|
|
138
|
+
};
|
|
142
139
|
/**
|
|
143
140
|
* Definition of the joint where the limits are applied.
|
|
144
141
|
* @export
|
|
@@ -3067,23 +3064,17 @@ export const ControllerInputsOutputsApiAxiosParamCreator = function (configurati
|
|
|
3067
3064
|
* @summary Wait For
|
|
3068
3065
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
3069
3066
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
3070
|
-
* @param {
|
|
3071
|
-
* @param {Comparator} comparisonType
|
|
3072
|
-
* @param {boolean} [booleanValue]
|
|
3073
|
-
* @param {string} [integerValue]
|
|
3074
|
-
* @param {number} [floatValue]
|
|
3067
|
+
* @param {WaitForIOEventRequest} waitForIOEventRequest
|
|
3075
3068
|
* @param {*} [options] Override http request option.
|
|
3076
3069
|
* @throws {RequiredError}
|
|
3077
3070
|
*/
|
|
3078
|
-
waitForIOEvent: async (cell, controller,
|
|
3071
|
+
waitForIOEvent: async (cell, controller, waitForIOEventRequest, options = {}) => {
|
|
3079
3072
|
// verify required parameter 'cell' is not null or undefined
|
|
3080
3073
|
assertParamExists('waitForIOEvent', 'cell', cell);
|
|
3081
3074
|
// verify required parameter 'controller' is not null or undefined
|
|
3082
3075
|
assertParamExists('waitForIOEvent', 'controller', controller);
|
|
3083
|
-
// verify required parameter '
|
|
3084
|
-
assertParamExists('waitForIOEvent', '
|
|
3085
|
-
// verify required parameter 'comparisonType' is not null or undefined
|
|
3086
|
-
assertParamExists('waitForIOEvent', 'comparisonType', comparisonType);
|
|
3076
|
+
// verify required parameter 'waitForIOEventRequest' is not null or undefined
|
|
3077
|
+
assertParamExists('waitForIOEvent', 'waitForIOEventRequest', waitForIOEventRequest);
|
|
3087
3078
|
const localVarPath = `/cells/{cell}/controllers/{controller}/ios/wait-for`
|
|
3088
3079
|
.replace(`{${"cell"}}`, encodeURIComponent(String(cell)))
|
|
3089
3080
|
.replace(`{${"controller"}}`, encodeURIComponent(String(controller)));
|
|
@@ -3093,7 +3084,7 @@ export const ControllerInputsOutputsApiAxiosParamCreator = function (configurati
|
|
|
3093
3084
|
if (configuration) {
|
|
3094
3085
|
baseOptions = configuration.baseOptions;
|
|
3095
3086
|
}
|
|
3096
|
-
const localVarRequestOptions = { method: '
|
|
3087
|
+
const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options };
|
|
3097
3088
|
const localVarHeaderParameter = {};
|
|
3098
3089
|
const localVarQueryParameter = {};
|
|
3099
3090
|
// authentication BasicAuth required
|
|
@@ -3102,24 +3093,11 @@ export const ControllerInputsOutputsApiAxiosParamCreator = function (configurati
|
|
|
3102
3093
|
// authentication BearerAuth required
|
|
3103
3094
|
// http bearer authentication required
|
|
3104
3095
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
3105
|
-
|
|
3106
|
-
localVarQueryParameter['io'] = io;
|
|
3107
|
-
}
|
|
3108
|
-
if (comparisonType !== undefined) {
|
|
3109
|
-
localVarQueryParameter['comparison_type'] = comparisonType;
|
|
3110
|
-
}
|
|
3111
|
-
if (booleanValue !== undefined) {
|
|
3112
|
-
localVarQueryParameter['boolean_value'] = booleanValue;
|
|
3113
|
-
}
|
|
3114
|
-
if (integerValue !== undefined) {
|
|
3115
|
-
localVarQueryParameter['integer_value'] = integerValue;
|
|
3116
|
-
}
|
|
3117
|
-
if (floatValue !== undefined) {
|
|
3118
|
-
localVarQueryParameter['float_value'] = floatValue;
|
|
3119
|
-
}
|
|
3096
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
3120
3097
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
3121
3098
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
3122
3099
|
localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
|
|
3100
|
+
localVarRequestOptions.data = serializeDataIfNeeded(waitForIOEventRequest, localVarRequestOptions, configuration);
|
|
3123
3101
|
return {
|
|
3124
3102
|
url: toPathString(localVarUrlObj),
|
|
3125
3103
|
options: localVarRequestOptions,
|
|
@@ -3202,16 +3180,12 @@ export const ControllerInputsOutputsApiFp = function (configuration) {
|
|
|
3202
3180
|
* @summary Wait For
|
|
3203
3181
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
3204
3182
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
3205
|
-
* @param {
|
|
3206
|
-
* @param {Comparator} comparisonType
|
|
3207
|
-
* @param {boolean} [booleanValue]
|
|
3208
|
-
* @param {string} [integerValue]
|
|
3209
|
-
* @param {number} [floatValue]
|
|
3183
|
+
* @param {WaitForIOEventRequest} waitForIOEventRequest
|
|
3210
3184
|
* @param {*} [options] Override http request option.
|
|
3211
3185
|
* @throws {RequiredError}
|
|
3212
3186
|
*/
|
|
3213
|
-
async waitForIOEvent(cell, controller,
|
|
3214
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.waitForIOEvent(cell, controller,
|
|
3187
|
+
async waitForIOEvent(cell, controller, waitForIOEventRequest, options) {
|
|
3188
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.waitForIOEvent(cell, controller, waitForIOEventRequest, options);
|
|
3215
3189
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
3216
3190
|
const localVarOperationServerBasePath = operationServerMap['ControllerInputsOutputsApi.waitForIOEvent']?.[localVarOperationServerIndex]?.url;
|
|
3217
3191
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
@@ -3281,16 +3255,12 @@ export const ControllerInputsOutputsApiFactory = function (configuration, basePa
|
|
|
3281
3255
|
* @summary Wait For
|
|
3282
3256
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
3283
3257
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
3284
|
-
* @param {
|
|
3285
|
-
* @param {Comparator} comparisonType
|
|
3286
|
-
* @param {boolean} [booleanValue]
|
|
3287
|
-
* @param {string} [integerValue]
|
|
3288
|
-
* @param {number} [floatValue]
|
|
3258
|
+
* @param {WaitForIOEventRequest} waitForIOEventRequest
|
|
3289
3259
|
* @param {*} [options] Override http request option.
|
|
3290
3260
|
* @throws {RequiredError}
|
|
3291
3261
|
*/
|
|
3292
|
-
waitForIOEvent(cell, controller,
|
|
3293
|
-
return localVarFp.waitForIOEvent(cell, controller,
|
|
3262
|
+
waitForIOEvent(cell, controller, waitForIOEventRequest, options) {
|
|
3263
|
+
return localVarFp.waitForIOEvent(cell, controller, waitForIOEventRequest, options).then((request) => request(axios, basePath));
|
|
3294
3264
|
},
|
|
3295
3265
|
};
|
|
3296
3266
|
};
|
|
@@ -3361,17 +3331,13 @@ export class ControllerInputsOutputsApi extends BaseAPI {
|
|
|
3361
3331
|
* @summary Wait For
|
|
3362
3332
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
3363
3333
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
3364
|
-
* @param {
|
|
3365
|
-
* @param {Comparator} comparisonType
|
|
3366
|
-
* @param {boolean} [booleanValue]
|
|
3367
|
-
* @param {string} [integerValue]
|
|
3368
|
-
* @param {number} [floatValue]
|
|
3334
|
+
* @param {WaitForIOEventRequest} waitForIOEventRequest
|
|
3369
3335
|
* @param {*} [options] Override http request option.
|
|
3370
3336
|
* @throws {RequiredError}
|
|
3371
3337
|
* @memberof ControllerInputsOutputsApi
|
|
3372
3338
|
*/
|
|
3373
|
-
waitForIOEvent(cell, controller,
|
|
3374
|
-
return ControllerInputsOutputsApiFp(this.configuration).waitForIOEvent(cell, controller,
|
|
3339
|
+
waitForIOEvent(cell, controller, waitForIOEventRequest, options) {
|
|
3340
|
+
return ControllerInputsOutputsApiFp(this.configuration).waitForIOEvent(cell, controller, waitForIOEventRequest, options).then((request) => request(this.axios, this.basePath));
|
|
3375
3341
|
}
|
|
3376
3342
|
}
|
|
3377
3343
|
/**
|
|
@@ -3467,17 +3433,17 @@ export const CoordinateSystemsApiAxiosParamCreator = function (configuration) {
|
|
|
3467
3433
|
* @summary Transform
|
|
3468
3434
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
3469
3435
|
* @param {string} coordinateSystem Unique identifier addressing a coordinate system.
|
|
3470
|
-
* @param {
|
|
3436
|
+
* @param {PoseInCoordinateSystem} poseInCoordinateSystem
|
|
3471
3437
|
* @param {*} [options] Override http request option.
|
|
3472
3438
|
* @throws {RequiredError}
|
|
3473
3439
|
*/
|
|
3474
|
-
transformInCoordinateSystem: async (cell, coordinateSystem,
|
|
3440
|
+
transformInCoordinateSystem: async (cell, coordinateSystem, poseInCoordinateSystem, options = {}) => {
|
|
3475
3441
|
// verify required parameter 'cell' is not null or undefined
|
|
3476
3442
|
assertParamExists('transformInCoordinateSystem', 'cell', cell);
|
|
3477
3443
|
// verify required parameter 'coordinateSystem' is not null or undefined
|
|
3478
3444
|
assertParamExists('transformInCoordinateSystem', 'coordinateSystem', coordinateSystem);
|
|
3479
|
-
// verify required parameter '
|
|
3480
|
-
assertParamExists('transformInCoordinateSystem', '
|
|
3445
|
+
// verify required parameter 'poseInCoordinateSystem' is not null or undefined
|
|
3446
|
+
assertParamExists('transformInCoordinateSystem', 'poseInCoordinateSystem', poseInCoordinateSystem);
|
|
3481
3447
|
const localVarPath = `/cells/{cell}/coordinate-systems/{coordinate-system}/transform`
|
|
3482
3448
|
.replace(`{${"cell"}}`, encodeURIComponent(String(cell)))
|
|
3483
3449
|
.replace(`{${"coordinate-system"}}`, encodeURIComponent(String(coordinateSystem)));
|
|
@@ -3500,7 +3466,7 @@ export const CoordinateSystemsApiAxiosParamCreator = function (configuration) {
|
|
|
3500
3466
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
3501
3467
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
3502
3468
|
localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
|
|
3503
|
-
localVarRequestOptions.data = serializeDataIfNeeded(
|
|
3469
|
+
localVarRequestOptions.data = serializeDataIfNeeded(poseInCoordinateSystem, localVarRequestOptions, configuration);
|
|
3504
3470
|
return {
|
|
3505
3471
|
url: toPathString(localVarUrlObj),
|
|
3506
3472
|
options: localVarRequestOptions,
|
|
@@ -3549,12 +3515,12 @@ export const CoordinateSystemsApiFp = function (configuration) {
|
|
|
3549
3515
|
* @summary Transform
|
|
3550
3516
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
3551
3517
|
* @param {string} coordinateSystem Unique identifier addressing a coordinate system.
|
|
3552
|
-
* @param {
|
|
3518
|
+
* @param {PoseInCoordinateSystem} poseInCoordinateSystem
|
|
3553
3519
|
* @param {*} [options] Override http request option.
|
|
3554
3520
|
* @throws {RequiredError}
|
|
3555
3521
|
*/
|
|
3556
|
-
async transformInCoordinateSystem(cell, coordinateSystem,
|
|
3557
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.transformInCoordinateSystem(cell, coordinateSystem,
|
|
3522
|
+
async transformInCoordinateSystem(cell, coordinateSystem, poseInCoordinateSystem, options) {
|
|
3523
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.transformInCoordinateSystem(cell, coordinateSystem, poseInCoordinateSystem, options);
|
|
3558
3524
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
3559
3525
|
const localVarOperationServerBasePath = operationServerMap['CoordinateSystemsApi.transformInCoordinateSystem']?.[localVarOperationServerIndex]?.url;
|
|
3560
3526
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
@@ -3596,12 +3562,12 @@ export const CoordinateSystemsApiFactory = function (configuration, basePath, ax
|
|
|
3596
3562
|
* @summary Transform
|
|
3597
3563
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
3598
3564
|
* @param {string} coordinateSystem Unique identifier addressing a coordinate system.
|
|
3599
|
-
* @param {
|
|
3565
|
+
* @param {PoseInCoordinateSystem} poseInCoordinateSystem
|
|
3600
3566
|
* @param {*} [options] Override http request option.
|
|
3601
3567
|
* @throws {RequiredError}
|
|
3602
3568
|
*/
|
|
3603
|
-
transformInCoordinateSystem(cell, coordinateSystem,
|
|
3604
|
-
return localVarFp.transformInCoordinateSystem(cell, coordinateSystem,
|
|
3569
|
+
transformInCoordinateSystem(cell, coordinateSystem, poseInCoordinateSystem, options) {
|
|
3570
|
+
return localVarFp.transformInCoordinateSystem(cell, coordinateSystem, poseInCoordinateSystem, options).then((request) => request(axios, basePath));
|
|
3605
3571
|
},
|
|
3606
3572
|
};
|
|
3607
3573
|
};
|
|
@@ -3642,13 +3608,13 @@ export class CoordinateSystemsApi extends BaseAPI {
|
|
|
3642
3608
|
* @summary Transform
|
|
3643
3609
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
3644
3610
|
* @param {string} coordinateSystem Unique identifier addressing a coordinate system.
|
|
3645
|
-
* @param {
|
|
3611
|
+
* @param {PoseInCoordinateSystem} poseInCoordinateSystem
|
|
3646
3612
|
* @param {*} [options] Override http request option.
|
|
3647
3613
|
* @throws {RequiredError}
|
|
3648
3614
|
* @memberof CoordinateSystemsApi
|
|
3649
3615
|
*/
|
|
3650
|
-
transformInCoordinateSystem(cell, coordinateSystem,
|
|
3651
|
-
return CoordinateSystemsApiFp(this.configuration).transformInCoordinateSystem(cell, coordinateSystem,
|
|
3616
|
+
transformInCoordinateSystem(cell, coordinateSystem, poseInCoordinateSystem, options) {
|
|
3617
|
+
return CoordinateSystemsApiFp(this.configuration).transformInCoordinateSystem(cell, coordinateSystem, poseInCoordinateSystem, options).then((request) => request(this.axios, this.basePath));
|
|
3652
3618
|
}
|
|
3653
3619
|
}
|
|
3654
3620
|
/**
|
|
@@ -11067,22 +11033,21 @@ export const VirtualRobotApiAxiosParamCreator = function (configuration) {
|
|
|
11067
11033
|
};
|
|
11068
11034
|
},
|
|
11069
11035
|
/**
|
|
11070
|
-
*
|
|
11036
|
+
* 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).
|
|
11071
11037
|
* @summary Get Inputs/Outputs
|
|
11072
11038
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
11073
11039
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
11074
|
-
* @param {Array<string>}
|
|
11075
|
-
* @param {IODirection} [direction] Return only inputs/outputs with the specified direction.
|
|
11076
|
-
* @param {IOValueType} [valueType] Return only inputs/outputs with the specified value type.
|
|
11077
|
-
* @param {string} [prefix] Return only inputs/outputs with the specified prefix of unique identifier.
|
|
11040
|
+
* @param {Array<string>} ios
|
|
11078
11041
|
* @param {*} [options] Override http request option.
|
|
11079
11042
|
* @throws {RequiredError}
|
|
11080
11043
|
*/
|
|
11081
|
-
listIOs: async (cell, controller, ios,
|
|
11044
|
+
listIOs: async (cell, controller, ios, options = {}) => {
|
|
11082
11045
|
// verify required parameter 'cell' is not null or undefined
|
|
11083
11046
|
assertParamExists('listIOs', 'cell', cell);
|
|
11084
11047
|
// verify required parameter 'controller' is not null or undefined
|
|
11085
11048
|
assertParamExists('listIOs', 'controller', controller);
|
|
11049
|
+
// verify required parameter 'ios' is not null or undefined
|
|
11050
|
+
assertParamExists('listIOs', 'ios', ios);
|
|
11086
11051
|
const localVarPath = `/cells/{cell}/controllers/{controller}/teach-pendant/ios`
|
|
11087
11052
|
.replace(`{${"cell"}}`, encodeURIComponent(String(cell)))
|
|
11088
11053
|
.replace(`{${"controller"}}`, encodeURIComponent(String(controller)));
|
|
@@ -11104,14 +11069,60 @@ export const VirtualRobotApiAxiosParamCreator = function (configuration) {
|
|
|
11104
11069
|
if (ios) {
|
|
11105
11070
|
localVarQueryParameter['ios'] = ios;
|
|
11106
11071
|
}
|
|
11072
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
11073
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
11074
|
+
localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
|
|
11075
|
+
return {
|
|
11076
|
+
url: toPathString(localVarUrlObj),
|
|
11077
|
+
options: localVarRequestOptions,
|
|
11078
|
+
};
|
|
11079
|
+
},
|
|
11080
|
+
/**
|
|
11081
|
+
* 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.
|
|
11082
|
+
* @summary List Input/Output Descriptions
|
|
11083
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
11084
|
+
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
11085
|
+
* @param {Array<string>} [ios]
|
|
11086
|
+
* @param {IODirection} [direction] Return only inputs/outputs with the specified direction.
|
|
11087
|
+
* @param {IOValueType} [valueType] Return only inputs/outputs with the specified value type.
|
|
11088
|
+
* @param {string} [group] Return only inputs/outputs from the specified group.
|
|
11089
|
+
* @param {*} [options] Override http request option.
|
|
11090
|
+
* @throws {RequiredError}
|
|
11091
|
+
*/
|
|
11092
|
+
listVirtualRobotIODescriptions: async (cell, controller, ios, direction, valueType, group, options = {}) => {
|
|
11093
|
+
// verify required parameter 'cell' is not null or undefined
|
|
11094
|
+
assertParamExists('listVirtualRobotIODescriptions', 'cell', cell);
|
|
11095
|
+
// verify required parameter 'controller' is not null or undefined
|
|
11096
|
+
assertParamExists('listVirtualRobotIODescriptions', 'controller', controller);
|
|
11097
|
+
const localVarPath = `/cells/{cell}/controllers/{controller}/teach-pendant/ios/description`
|
|
11098
|
+
.replace(`{${"cell"}}`, encodeURIComponent(String(cell)))
|
|
11099
|
+
.replace(`{${"controller"}}`, encodeURIComponent(String(controller)));
|
|
11100
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
11101
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
11102
|
+
let baseOptions;
|
|
11103
|
+
if (configuration) {
|
|
11104
|
+
baseOptions = configuration.baseOptions;
|
|
11105
|
+
}
|
|
11106
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options };
|
|
11107
|
+
const localVarHeaderParameter = {};
|
|
11108
|
+
const localVarQueryParameter = {};
|
|
11109
|
+
// authentication BasicAuth required
|
|
11110
|
+
// http basic authentication required
|
|
11111
|
+
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
11112
|
+
// authentication BearerAuth required
|
|
11113
|
+
// http bearer authentication required
|
|
11114
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
11115
|
+
if (ios) {
|
|
11116
|
+
localVarQueryParameter['ios'] = ios;
|
|
11117
|
+
}
|
|
11107
11118
|
if (direction !== undefined) {
|
|
11108
11119
|
localVarQueryParameter['direction'] = direction;
|
|
11109
11120
|
}
|
|
11110
11121
|
if (valueType !== undefined) {
|
|
11111
11122
|
localVarQueryParameter['value_type'] = valueType;
|
|
11112
11123
|
}
|
|
11113
|
-
if (
|
|
11114
|
-
localVarQueryParameter['
|
|
11124
|
+
if (group !== undefined) {
|
|
11125
|
+
localVarQueryParameter['group'] = group;
|
|
11115
11126
|
}
|
|
11116
11127
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
11117
11128
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
@@ -11252,21 +11263,36 @@ export const VirtualRobotApiFp = function (configuration) {
|
|
|
11252
11263
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
11253
11264
|
},
|
|
11254
11265
|
/**
|
|
11255
|
-
*
|
|
11266
|
+
* 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).
|
|
11256
11267
|
* @summary Get Inputs/Outputs
|
|
11257
11268
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
11258
11269
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
11270
|
+
* @param {Array<string>} ios
|
|
11271
|
+
* @param {*} [options] Override http request option.
|
|
11272
|
+
* @throws {RequiredError}
|
|
11273
|
+
*/
|
|
11274
|
+
async listIOs(cell, controller, ios, options) {
|
|
11275
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.listIOs(cell, controller, ios, options);
|
|
11276
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
11277
|
+
const localVarOperationServerBasePath = operationServerMap['VirtualRobotApi.listIOs']?.[localVarOperationServerIndex]?.url;
|
|
11278
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
11279
|
+
},
|
|
11280
|
+
/**
|
|
11281
|
+
* 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.
|
|
11282
|
+
* @summary List Input/Output Descriptions
|
|
11283
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
11284
|
+
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
11259
11285
|
* @param {Array<string>} [ios]
|
|
11260
11286
|
* @param {IODirection} [direction] Return only inputs/outputs with the specified direction.
|
|
11261
11287
|
* @param {IOValueType} [valueType] Return only inputs/outputs with the specified value type.
|
|
11262
|
-
* @param {string} [
|
|
11288
|
+
* @param {string} [group] Return only inputs/outputs from the specified group.
|
|
11263
11289
|
* @param {*} [options] Override http request option.
|
|
11264
11290
|
* @throws {RequiredError}
|
|
11265
11291
|
*/
|
|
11266
|
-
async
|
|
11267
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.
|
|
11292
|
+
async listVirtualRobotIODescriptions(cell, controller, ios, direction, valueType, group, options) {
|
|
11293
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.listVirtualRobotIODescriptions(cell, controller, ios, direction, valueType, group, options);
|
|
11268
11294
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
11269
|
-
const localVarOperationServerBasePath = operationServerMap['VirtualRobotApi.
|
|
11295
|
+
const localVarOperationServerBasePath = operationServerMap['VirtualRobotApi.listVirtualRobotIODescriptions']?.[localVarOperationServerIndex]?.url;
|
|
11270
11296
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
11271
11297
|
},
|
|
11272
11298
|
/**
|
|
@@ -11333,19 +11359,31 @@ export const VirtualRobotApiFactory = function (configuration, basePath, axios)
|
|
|
11333
11359
|
return localVarFp.getMotionGroups(cell, controller, options).then((request) => request(axios, basePath));
|
|
11334
11360
|
},
|
|
11335
11361
|
/**
|
|
11336
|
-
*
|
|
11362
|
+
* 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).
|
|
11337
11363
|
* @summary Get Inputs/Outputs
|
|
11338
11364
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
11339
11365
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
11366
|
+
* @param {Array<string>} ios
|
|
11367
|
+
* @param {*} [options] Override http request option.
|
|
11368
|
+
* @throws {RequiredError}
|
|
11369
|
+
*/
|
|
11370
|
+
listIOs(cell, controller, ios, options) {
|
|
11371
|
+
return localVarFp.listIOs(cell, controller, ios, options).then((request) => request(axios, basePath));
|
|
11372
|
+
},
|
|
11373
|
+
/**
|
|
11374
|
+
* 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.
|
|
11375
|
+
* @summary List Input/Output Descriptions
|
|
11376
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
11377
|
+
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
11340
11378
|
* @param {Array<string>} [ios]
|
|
11341
11379
|
* @param {IODirection} [direction] Return only inputs/outputs with the specified direction.
|
|
11342
11380
|
* @param {IOValueType} [valueType] Return only inputs/outputs with the specified value type.
|
|
11343
|
-
* @param {string} [
|
|
11381
|
+
* @param {string} [group] Return only inputs/outputs from the specified group.
|
|
11344
11382
|
* @param {*} [options] Override http request option.
|
|
11345
11383
|
* @throws {RequiredError}
|
|
11346
11384
|
*/
|
|
11347
|
-
|
|
11348
|
-
return localVarFp.
|
|
11385
|
+
listVirtualRobotIODescriptions(cell, controller, ios, direction, valueType, group, options) {
|
|
11386
|
+
return localVarFp.listVirtualRobotIODescriptions(cell, controller, ios, direction, valueType, group, options).then((request) => request(axios, basePath));
|
|
11349
11387
|
},
|
|
11350
11388
|
/**
|
|
11351
11389
|
* Sets a list of values of a virtual controller inputs/outputs.
|
|
@@ -11407,20 +11445,33 @@ export class VirtualRobotApi extends BaseAPI {
|
|
|
11407
11445
|
return VirtualRobotApiFp(this.configuration).getMotionGroups(cell, controller, options).then((request) => request(this.axios, this.basePath));
|
|
11408
11446
|
}
|
|
11409
11447
|
/**
|
|
11410
|
-
*
|
|
11448
|
+
* 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).
|
|
11411
11449
|
* @summary Get Inputs/Outputs
|
|
11412
11450
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
11413
11451
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
11452
|
+
* @param {Array<string>} ios
|
|
11453
|
+
* @param {*} [options] Override http request option.
|
|
11454
|
+
* @throws {RequiredError}
|
|
11455
|
+
* @memberof VirtualRobotApi
|
|
11456
|
+
*/
|
|
11457
|
+
listIOs(cell, controller, ios, options) {
|
|
11458
|
+
return VirtualRobotApiFp(this.configuration).listIOs(cell, controller, ios, options).then((request) => request(this.axios, this.basePath));
|
|
11459
|
+
}
|
|
11460
|
+
/**
|
|
11461
|
+
* 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.
|
|
11462
|
+
* @summary List Input/Output Descriptions
|
|
11463
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
11464
|
+
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
11414
11465
|
* @param {Array<string>} [ios]
|
|
11415
11466
|
* @param {IODirection} [direction] Return only inputs/outputs with the specified direction.
|
|
11416
11467
|
* @param {IOValueType} [valueType] Return only inputs/outputs with the specified value type.
|
|
11417
|
-
* @param {string} [
|
|
11468
|
+
* @param {string} [group] Return only inputs/outputs from the specified group.
|
|
11418
11469
|
* @param {*} [options] Override http request option.
|
|
11419
11470
|
* @throws {RequiredError}
|
|
11420
11471
|
* @memberof VirtualRobotApi
|
|
11421
11472
|
*/
|
|
11422
|
-
|
|
11423
|
-
return VirtualRobotApiFp(this.configuration).
|
|
11473
|
+
listVirtualRobotIODescriptions(cell, controller, ios, direction, valueType, group, options) {
|
|
11474
|
+
return VirtualRobotApiFp(this.configuration).listVirtualRobotIODescriptions(cell, controller, ios, direction, valueType, group, options).then((request) => request(this.axios, this.basePath));
|
|
11424
11475
|
}
|
|
11425
11476
|
/**
|
|
11426
11477
|
* Sets a list of values of a virtual controller inputs/outputs.
|