@wandelbots/nova-api 25.6.0-dev.36 → 25.6.0-dev.38
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 +182 -251
- package/v2/api.js +0 -256
- package/v2/api.js.map +1 -1
- package/v2/api.ts +182 -405
package/v2/api.ts
CHANGED
|
@@ -122,7 +122,7 @@ export interface AddTrajectoryError {
|
|
|
122
122
|
* @type AddTrajectoryErrorData
|
|
123
123
|
* @export
|
|
124
124
|
*/
|
|
125
|
-
export type AddTrajectoryErrorData =
|
|
125
|
+
export type AddTrajectoryErrorData = CollisionError | InconsitentTrajectorySize | InvalidDof | JointLimitExceeded | NanValue | TcpRequired | TorqueExceeded;
|
|
126
126
|
|
|
127
127
|
/**
|
|
128
128
|
*
|
|
@@ -398,6 +398,37 @@ export const CapsuleShapeTypeEnum = {
|
|
|
398
398
|
|
|
399
399
|
export type CapsuleShapeTypeEnum = typeof CapsuleShapeTypeEnum[keyof typeof CapsuleShapeTypeEnum];
|
|
400
400
|
|
|
401
|
+
/**
|
|
402
|
+
*
|
|
403
|
+
* @export
|
|
404
|
+
* @interface CartesianLimits
|
|
405
|
+
*/
|
|
406
|
+
export interface CartesianLimits {
|
|
407
|
+
/**
|
|
408
|
+
*
|
|
409
|
+
* @type {number}
|
|
410
|
+
* @memberof CartesianLimits
|
|
411
|
+
*/
|
|
412
|
+
'velocity'?: number;
|
|
413
|
+
/**
|
|
414
|
+
*
|
|
415
|
+
* @type {number}
|
|
416
|
+
* @memberof CartesianLimits
|
|
417
|
+
*/
|
|
418
|
+
'acceleration'?: number;
|
|
419
|
+
/**
|
|
420
|
+
*
|
|
421
|
+
* @type {number}
|
|
422
|
+
* @memberof CartesianLimits
|
|
423
|
+
*/
|
|
424
|
+
'orientation_velocity'?: number;
|
|
425
|
+
/**
|
|
426
|
+
*
|
|
427
|
+
* @type {number}
|
|
428
|
+
* @memberof CartesianLimits
|
|
429
|
+
*/
|
|
430
|
+
'orientation_acceleration'?: number;
|
|
431
|
+
}
|
|
401
432
|
/**
|
|
402
433
|
* To create a robot cell, only a valid name is required. Once created, a robot cell provides access to the Wandelbots NOVA foundation services. The configuration can be customized, e.g. robot controllers, also within apps.
|
|
403
434
|
* @export
|
|
@@ -503,19 +534,6 @@ export interface Collision {
|
|
|
503
534
|
*/
|
|
504
535
|
'position_on_b'?: CollisionContact;
|
|
505
536
|
}
|
|
506
|
-
/**
|
|
507
|
-
*
|
|
508
|
-
* @export
|
|
509
|
-
* @interface Collision2
|
|
510
|
-
*/
|
|
511
|
-
export interface Collision2 {
|
|
512
|
-
/**
|
|
513
|
-
*
|
|
514
|
-
* @type {FeedbackCollision}
|
|
515
|
-
* @memberof Collision2
|
|
516
|
-
*/
|
|
517
|
-
'collision'?: FeedbackCollision;
|
|
518
|
-
}
|
|
519
537
|
/**
|
|
520
538
|
*
|
|
521
539
|
* @export
|
|
@@ -535,6 +553,19 @@ export interface CollisionContact {
|
|
|
535
553
|
*/
|
|
536
554
|
'world'?: Array<number>;
|
|
537
555
|
}
|
|
556
|
+
/**
|
|
557
|
+
*
|
|
558
|
+
* @export
|
|
559
|
+
* @interface CollisionError
|
|
560
|
+
*/
|
|
561
|
+
export interface CollisionError {
|
|
562
|
+
/**
|
|
563
|
+
*
|
|
564
|
+
* @type {FeedbackCollision}
|
|
565
|
+
* @memberof CollisionError
|
|
566
|
+
*/
|
|
567
|
+
'collision'?: FeedbackCollision;
|
|
568
|
+
}
|
|
538
569
|
/**
|
|
539
570
|
*
|
|
540
571
|
* @export
|
|
@@ -1856,10 +1887,10 @@ export interface InverseKinematicsRequest {
|
|
|
1856
1887
|
'mounting'?: Pose;
|
|
1857
1888
|
/**
|
|
1858
1889
|
* Joint position limits in [rad], indexed starting from base.
|
|
1859
|
-
* @type {Array<
|
|
1890
|
+
* @type {Array<LimitRange>}
|
|
1860
1891
|
* @memberof InverseKinematicsRequest
|
|
1861
1892
|
*/
|
|
1862
|
-
'joint_position_limits'?: Array<
|
|
1893
|
+
'joint_position_limits'?: Array<LimitRange>;
|
|
1863
1894
|
/**
|
|
1864
1895
|
* Collision scenes to be respected by the motion planner. Each contains the single motion group which is planned for. Scenes are checked individually along the trajectory and independently of other scenes. To respect the safety zones of the controller, fetch the safety zones, link and tool shapes from the controller and add one scene made up of those. To respect the safety zones of the controller and check for collision: 1. Fetch the safety zones, link and tool shapes from the controller. 2. Add the fetched zones, links and tools to a scene. 3. Create other scenes from your own 3D data as needed. 4. Execute this endpoint. 5. The response highlights the scenes in which a collision was detected by key.
|
|
1865
1896
|
* @type {{ [key: string]: SingleMotionGroupCollisionScene; }}
|
|
@@ -1925,6 +1956,37 @@ export interface JointLimitExceeded {
|
|
|
1925
1956
|
*/
|
|
1926
1957
|
'joint_limit_exceeded'?: FeedbackJointLimitExceeded;
|
|
1927
1958
|
}
|
|
1959
|
+
/**
|
|
1960
|
+
*
|
|
1961
|
+
* @export
|
|
1962
|
+
* @interface JointLimits
|
|
1963
|
+
*/
|
|
1964
|
+
export interface JointLimits {
|
|
1965
|
+
/**
|
|
1966
|
+
*
|
|
1967
|
+
* @type {LimitRange}
|
|
1968
|
+
* @memberof JointLimits
|
|
1969
|
+
*/
|
|
1970
|
+
'position'?: LimitRange;
|
|
1971
|
+
/**
|
|
1972
|
+
*
|
|
1973
|
+
* @type {number}
|
|
1974
|
+
* @memberof JointLimits
|
|
1975
|
+
*/
|
|
1976
|
+
'velocity'?: number;
|
|
1977
|
+
/**
|
|
1978
|
+
*
|
|
1979
|
+
* @type {number}
|
|
1980
|
+
* @memberof JointLimits
|
|
1981
|
+
*/
|
|
1982
|
+
'acceleration'?: number;
|
|
1983
|
+
/**
|
|
1984
|
+
*
|
|
1985
|
+
* @type {number}
|
|
1986
|
+
* @memberof JointLimits
|
|
1987
|
+
*/
|
|
1988
|
+
'torque'?: number;
|
|
1989
|
+
}
|
|
1928
1990
|
/**
|
|
1929
1991
|
*
|
|
1930
1992
|
* @export
|
|
@@ -2177,6 +2239,75 @@ export const LicenseStatusEnum = {
|
|
|
2177
2239
|
export type LicenseStatusEnum = typeof LicenseStatusEnum[keyof typeof LicenseStatusEnum];
|
|
2178
2240
|
|
|
2179
2241
|
|
|
2242
|
+
/**
|
|
2243
|
+
*
|
|
2244
|
+
* @export
|
|
2245
|
+
* @interface LimitConfig
|
|
2246
|
+
*/
|
|
2247
|
+
export interface LimitConfig {
|
|
2248
|
+
/**
|
|
2249
|
+
*
|
|
2250
|
+
* @type {LimitSet}
|
|
2251
|
+
* @memberof LimitConfig
|
|
2252
|
+
*/
|
|
2253
|
+
'physical_limits'?: LimitSet;
|
|
2254
|
+
/**
|
|
2255
|
+
*
|
|
2256
|
+
* @type {OperationLimits}
|
|
2257
|
+
* @memberof LimitConfig
|
|
2258
|
+
*/
|
|
2259
|
+
'operation_limits'?: OperationLimits;
|
|
2260
|
+
}
|
|
2261
|
+
/**
|
|
2262
|
+
* The upper_limit must be greater then the lower_limit.
|
|
2263
|
+
* @export
|
|
2264
|
+
* @interface LimitRange
|
|
2265
|
+
*/
|
|
2266
|
+
export interface LimitRange {
|
|
2267
|
+
/**
|
|
2268
|
+
*
|
|
2269
|
+
* @type {number}
|
|
2270
|
+
* @memberof LimitRange
|
|
2271
|
+
*/
|
|
2272
|
+
'lower_limit'?: number;
|
|
2273
|
+
/**
|
|
2274
|
+
*
|
|
2275
|
+
* @type {number}
|
|
2276
|
+
* @memberof LimitRange
|
|
2277
|
+
*/
|
|
2278
|
+
'upper_limit'?: number;
|
|
2279
|
+
}
|
|
2280
|
+
/**
|
|
2281
|
+
*
|
|
2282
|
+
* @export
|
|
2283
|
+
* @interface LimitSet
|
|
2284
|
+
*/
|
|
2285
|
+
export interface LimitSet {
|
|
2286
|
+
/**
|
|
2287
|
+
*
|
|
2288
|
+
* @type {Array<JointLimits>}
|
|
2289
|
+
* @memberof LimitSet
|
|
2290
|
+
*/
|
|
2291
|
+
'joints'?: Array<JointLimits>;
|
|
2292
|
+
/**
|
|
2293
|
+
*
|
|
2294
|
+
* @type {CartesianLimits}
|
|
2295
|
+
* @memberof LimitSet
|
|
2296
|
+
*/
|
|
2297
|
+
'tcp'?: CartesianLimits;
|
|
2298
|
+
/**
|
|
2299
|
+
*
|
|
2300
|
+
* @type {CartesianLimits}
|
|
2301
|
+
* @memberof LimitSet
|
|
2302
|
+
*/
|
|
2303
|
+
'elbow'?: CartesianLimits;
|
|
2304
|
+
/**
|
|
2305
|
+
*
|
|
2306
|
+
* @type {CartesianLimits}
|
|
2307
|
+
* @memberof LimitSet
|
|
2308
|
+
*/
|
|
2309
|
+
'flange'?: CartesianLimits;
|
|
2310
|
+
}
|
|
2180
2311
|
/**
|
|
2181
2312
|
* If a limit is not set, the default value will be used.
|
|
2182
2313
|
* @export
|
|
@@ -2379,10 +2510,10 @@ export interface MotionGroupDescription {
|
|
|
2379
2510
|
'safety_tool_colliders'?: { [key: string]: { [key: string]: Collider; }; };
|
|
2380
2511
|
/**
|
|
2381
2512
|
*
|
|
2382
|
-
* @type {
|
|
2513
|
+
* @type {LimitConfig}
|
|
2383
2514
|
* @memberof MotionGroupDescription
|
|
2384
2515
|
*/
|
|
2385
|
-
'global_limits':
|
|
2516
|
+
'global_limits': LimitConfig;
|
|
2386
2517
|
/**
|
|
2387
2518
|
* Maps a payload name to its configuration. Key must be a payload identifier. Values are payload objects.
|
|
2388
2519
|
* @type {{ [key: string]: Payload; }}
|
|
@@ -2687,6 +2818,37 @@ export const OperatingState = {
|
|
|
2687
2818
|
export type OperatingState = typeof OperatingState[keyof typeof OperatingState];
|
|
2688
2819
|
|
|
2689
2820
|
|
|
2821
|
+
/**
|
|
2822
|
+
*
|
|
2823
|
+
* @export
|
|
2824
|
+
* @interface OperationLimits
|
|
2825
|
+
*/
|
|
2826
|
+
export interface OperationLimits {
|
|
2827
|
+
/**
|
|
2828
|
+
*
|
|
2829
|
+
* @type {LimitSet}
|
|
2830
|
+
* @memberof OperationLimits
|
|
2831
|
+
*/
|
|
2832
|
+
'auto_limits'?: LimitSet;
|
|
2833
|
+
/**
|
|
2834
|
+
*
|
|
2835
|
+
* @type {LimitSet}
|
|
2836
|
+
* @memberof OperationLimits
|
|
2837
|
+
*/
|
|
2838
|
+
'manual_limits'?: LimitSet;
|
|
2839
|
+
/**
|
|
2840
|
+
*
|
|
2841
|
+
* @type {LimitSet}
|
|
2842
|
+
* @memberof OperationLimits
|
|
2843
|
+
*/
|
|
2844
|
+
'manual_t1_limits'?: LimitSet;
|
|
2845
|
+
/**
|
|
2846
|
+
*
|
|
2847
|
+
* @type {LimitSet}
|
|
2848
|
+
* @memberof OperationLimits
|
|
2849
|
+
*/
|
|
2850
|
+
'manual_t2_limits'?: LimitSet;
|
|
2851
|
+
}
|
|
2690
2852
|
/**
|
|
2691
2853
|
* Current operation mode of the configured robot controller. Operation modes in which the attached motion groups can be moved are: - OPERATION_MODE_MANUAL (if enabling switch is pressed) - OPERATION_MODE_MANUAL_T1 (if enabling switch is pressed) - OPERATION_MODE_MANUAL_T2 (if enabling switch is pressed) - OPERATION_MODE_AUTO (without needing to press enabling switch) All other modes are considered as non-operational.
|
|
2692
2854
|
* @export
|
|
@@ -3234,104 +3396,6 @@ export const PlaneShapeTypeEnum = {
|
|
|
3234
3396
|
|
|
3235
3397
|
export type PlaneShapeTypeEnum = typeof PlaneShapeTypeEnum[keyof typeof PlaneShapeTypeEnum];
|
|
3236
3398
|
|
|
3237
|
-
/**
|
|
3238
|
-
* All known joint and cartesian limits of a motion-group. Used for motion planning.
|
|
3239
|
-
* @export
|
|
3240
|
-
* @interface PlanningLimits
|
|
3241
|
-
*/
|
|
3242
|
-
export interface PlanningLimits {
|
|
3243
|
-
/**
|
|
3244
|
-
* Joint position limits in [rad], indexed starting from base.
|
|
3245
|
-
* @type {Array<PlanningLimitsLimitRange>}
|
|
3246
|
-
* @memberof PlanningLimits
|
|
3247
|
-
*/
|
|
3248
|
-
'joint_position_limits'?: Array<PlanningLimitsLimitRange>;
|
|
3249
|
-
/**
|
|
3250
|
-
* Maximum allowed velocity for joints in [rad/s or mm/s] of the safety setup, starting at base.
|
|
3251
|
-
* @type {Array<number>}
|
|
3252
|
-
* @memberof PlanningLimits
|
|
3253
|
-
*/
|
|
3254
|
-
'joint_velocity_limits'?: Array<number>;
|
|
3255
|
-
/**
|
|
3256
|
-
* Maximum allowed acceleration for joints in [rad/s^2 or mm/s^2] of the safety setup, starting at base.
|
|
3257
|
-
* @type {Array<number>}
|
|
3258
|
-
* @memberof PlanningLimits
|
|
3259
|
-
*/
|
|
3260
|
-
'joint_acceleration_limits'?: Array<number>;
|
|
3261
|
-
/**
|
|
3262
|
-
* Maximum allowed torque for joints in [Nm or N] of the safety setup, starting at base.
|
|
3263
|
-
* @type {Array<number>}
|
|
3264
|
-
* @memberof PlanningLimits
|
|
3265
|
-
*/
|
|
3266
|
-
'joint_torque_limits'?: Array<number>;
|
|
3267
|
-
/**
|
|
3268
|
-
* At maximum one dimensional velocity in [mm/s] at TCP allowed.
|
|
3269
|
-
* @type {number}
|
|
3270
|
-
* @memberof PlanningLimits
|
|
3271
|
-
*/
|
|
3272
|
-
'tcp_velocity_limit'?: number;
|
|
3273
|
-
/**
|
|
3274
|
-
* At maximum one dimensional acceleration in [mm/s^2] at TCP allowed.
|
|
3275
|
-
* @type {number}
|
|
3276
|
-
* @memberof PlanningLimits
|
|
3277
|
-
*/
|
|
3278
|
-
'tcp_acceleration_limit'?: number;
|
|
3279
|
-
/**
|
|
3280
|
-
* At maximum one dimensional orientation velocity in [rad/s] at TCP allowed.
|
|
3281
|
-
* @type {number}
|
|
3282
|
-
* @memberof PlanningLimits
|
|
3283
|
-
*/
|
|
3284
|
-
'tcp_orientation_velocity_limit'?: number;
|
|
3285
|
-
/**
|
|
3286
|
-
* At maximum one dimensional orientation acceleration in [rad/s^2] at TCP allowed.
|
|
3287
|
-
* @type {number}
|
|
3288
|
-
* @memberof PlanningLimits
|
|
3289
|
-
*/
|
|
3290
|
-
'tcp_orientation_acceleration_limit'?: number;
|
|
3291
|
-
/**
|
|
3292
|
-
* At maximum one dimensional force in [N] at TCP allowed.
|
|
3293
|
-
* @type {number}
|
|
3294
|
-
* @memberof PlanningLimits
|
|
3295
|
-
*/
|
|
3296
|
-
'tcp_force_limit'?: number;
|
|
3297
|
-
/**
|
|
3298
|
-
* At maximum one dimensional velocity in [mm/s] at the elbow allowed.
|
|
3299
|
-
* @type {number}
|
|
3300
|
-
* @memberof PlanningLimits
|
|
3301
|
-
*/
|
|
3302
|
-
'elbow_velocity_limit'?: number;
|
|
3303
|
-
/**
|
|
3304
|
-
* At maximum one dimensional acceleration in [mm/s^2] at the elbow allowed.
|
|
3305
|
-
* @type {number}
|
|
3306
|
-
* @memberof PlanningLimits
|
|
3307
|
-
*/
|
|
3308
|
-
'elbow_acceleration_limit'?: number;
|
|
3309
|
-
/**
|
|
3310
|
-
* At maximum one dimensional force in [N] at the elbow allowed.
|
|
3311
|
-
* @type {number}
|
|
3312
|
-
* @memberof PlanningLimits
|
|
3313
|
-
*/
|
|
3314
|
-
'elbow_force_limit'?: number;
|
|
3315
|
-
}
|
|
3316
|
-
/**
|
|
3317
|
-
* The upper_limit must be greater then the lower_limit.
|
|
3318
|
-
* @export
|
|
3319
|
-
* @interface PlanningLimitsLimitRange
|
|
3320
|
-
*/
|
|
3321
|
-
export interface PlanningLimitsLimitRange {
|
|
3322
|
-
/**
|
|
3323
|
-
*
|
|
3324
|
-
* @type {number}
|
|
3325
|
-
* @memberof PlanningLimitsLimitRange
|
|
3326
|
-
*/
|
|
3327
|
-
'lower_limit': number;
|
|
3328
|
-
/**
|
|
3329
|
-
*
|
|
3330
|
-
* @type {number}
|
|
3331
|
-
* @memberof PlanningLimitsLimitRange
|
|
3332
|
-
*/
|
|
3333
|
-
'upper_limit': number;
|
|
3334
|
-
}
|
|
3335
3399
|
/**
|
|
3336
3400
|
* Sets velocity for executed movements of the motion, in percent. Send after initializing the connection with InitializeMovementRequest.
|
|
3337
3401
|
* @export
|
|
@@ -3766,10 +3830,10 @@ export interface RobotSetup {
|
|
|
3766
3830
|
'tcp_offset'?: Pose;
|
|
3767
3831
|
/**
|
|
3768
3832
|
*
|
|
3769
|
-
* @type {
|
|
3833
|
+
* @type {LimitSet}
|
|
3770
3834
|
* @memberof RobotSetup
|
|
3771
3835
|
*/
|
|
3772
|
-
'global_limits'?:
|
|
3836
|
+
'global_limits'?: LimitSet;
|
|
3773
3837
|
/**
|
|
3774
3838
|
*
|
|
3775
3839
|
* @type {Payload}
|
|
@@ -5456,293 +5520,6 @@ export class ApplicationApi extends BaseAPI {
|
|
|
5456
5520
|
|
|
5457
5521
|
|
|
5458
5522
|
|
|
5459
|
-
/**
|
|
5460
|
-
* BusIOsApi - axios parameter creator
|
|
5461
|
-
* @export
|
|
5462
|
-
*/
|
|
5463
|
-
export const BusIOsApiAxiosParamCreator = function (configuration?: Configuration) {
|
|
5464
|
-
return {
|
|
5465
|
-
/**
|
|
5466
|
-
* Retrieves the current values of inputs/outputs. The identifiers of the inputs/outputs must be provided in the request. Request all available input/output identifiers via [listBusIODescriptions](listBusIODescriptions).
|
|
5467
|
-
* @summary Get Input/Output Values
|
|
5468
|
-
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5469
|
-
* @param {Array<string>} [ios]
|
|
5470
|
-
* @param {*} [options] Override http request option.
|
|
5471
|
-
* @throws {RequiredError}
|
|
5472
|
-
*/
|
|
5473
|
-
getBusIOValues: async (cell: string, ios?: Array<string>, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
5474
|
-
// verify required parameter 'cell' is not null or undefined
|
|
5475
|
-
assertParamExists('getBusIOValues', 'cell', cell)
|
|
5476
|
-
const localVarPath = `/cells/{cell}/bus-ios/ios/values`
|
|
5477
|
-
.replace(`{${"cell"}}`, encodeURIComponent(String(cell)));
|
|
5478
|
-
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
5479
|
-
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
5480
|
-
let baseOptions;
|
|
5481
|
-
if (configuration) {
|
|
5482
|
-
baseOptions = configuration.baseOptions;
|
|
5483
|
-
}
|
|
5484
|
-
|
|
5485
|
-
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
5486
|
-
const localVarHeaderParameter = {} as any;
|
|
5487
|
-
const localVarQueryParameter = {} as any;
|
|
5488
|
-
|
|
5489
|
-
// authentication BasicAuth required
|
|
5490
|
-
// http basic authentication required
|
|
5491
|
-
setBasicAuthToObject(localVarRequestOptions, configuration)
|
|
5492
|
-
|
|
5493
|
-
// authentication BearerAuth required
|
|
5494
|
-
// http bearer authentication required
|
|
5495
|
-
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
5496
|
-
|
|
5497
|
-
if (ios) {
|
|
5498
|
-
localVarQueryParameter['ios'] = ios;
|
|
5499
|
-
}
|
|
5500
|
-
|
|
5501
|
-
|
|
5502
|
-
|
|
5503
|
-
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
5504
|
-
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
5505
|
-
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
5506
|
-
|
|
5507
|
-
return {
|
|
5508
|
-
url: toPathString(localVarUrlObj),
|
|
5509
|
-
options: localVarRequestOptions,
|
|
5510
|
-
};
|
|
5511
|
-
},
|
|
5512
|
-
/**
|
|
5513
|
-
* List all Bus Input/Outputs.
|
|
5514
|
-
* @summary Configuration
|
|
5515
|
-
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5516
|
-
* @param {*} [options] Override http request option.
|
|
5517
|
-
* @throws {RequiredError}
|
|
5518
|
-
*/
|
|
5519
|
-
listBusIODescriptions: async (cell: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
5520
|
-
// verify required parameter 'cell' is not null or undefined
|
|
5521
|
-
assertParamExists('listBusIODescriptions', 'cell', cell)
|
|
5522
|
-
const localVarPath = `/cells/{cell}/bus-ios/ios/description`
|
|
5523
|
-
.replace(`{${"cell"}}`, encodeURIComponent(String(cell)));
|
|
5524
|
-
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
5525
|
-
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
5526
|
-
let baseOptions;
|
|
5527
|
-
if (configuration) {
|
|
5528
|
-
baseOptions = configuration.baseOptions;
|
|
5529
|
-
}
|
|
5530
|
-
|
|
5531
|
-
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
5532
|
-
const localVarHeaderParameter = {} as any;
|
|
5533
|
-
const localVarQueryParameter = {} as any;
|
|
5534
|
-
|
|
5535
|
-
// authentication BasicAuth required
|
|
5536
|
-
// http basic authentication required
|
|
5537
|
-
setBasicAuthToObject(localVarRequestOptions, configuration)
|
|
5538
|
-
|
|
5539
|
-
// authentication BearerAuth required
|
|
5540
|
-
// http bearer authentication required
|
|
5541
|
-
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
5542
|
-
|
|
5543
|
-
|
|
5544
|
-
|
|
5545
|
-
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
5546
|
-
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
5547
|
-
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
5548
|
-
|
|
5549
|
-
return {
|
|
5550
|
-
url: toPathString(localVarUrlObj),
|
|
5551
|
-
options: localVarRequestOptions,
|
|
5552
|
-
};
|
|
5553
|
-
},
|
|
5554
|
-
/**
|
|
5555
|
-
* Set values of outputs. In case of virtual Bus Input/Outputs, also inputs can be set. All available output identifiers can be requested via [listBusIODescriptions](listBusIODescriptions). The call will return once the values have been set and accepted by the service.
|
|
5556
|
-
* @summary Set Output Values
|
|
5557
|
-
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5558
|
-
* @param {Array<IOValue>} iOValue
|
|
5559
|
-
* @param {*} [options] Override http request option.
|
|
5560
|
-
* @throws {RequiredError}
|
|
5561
|
-
*/
|
|
5562
|
-
setBusIOValues: async (cell: string, iOValue: Array<IOValue>, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
5563
|
-
// verify required parameter 'cell' is not null or undefined
|
|
5564
|
-
assertParamExists('setBusIOValues', 'cell', cell)
|
|
5565
|
-
// verify required parameter 'iOValue' is not null or undefined
|
|
5566
|
-
assertParamExists('setBusIOValues', 'iOValue', iOValue)
|
|
5567
|
-
const localVarPath = `/cells/{cell}/bus-ios/ios/values`
|
|
5568
|
-
.replace(`{${"cell"}}`, encodeURIComponent(String(cell)));
|
|
5569
|
-
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
5570
|
-
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
5571
|
-
let baseOptions;
|
|
5572
|
-
if (configuration) {
|
|
5573
|
-
baseOptions = configuration.baseOptions;
|
|
5574
|
-
}
|
|
5575
|
-
|
|
5576
|
-
const localVarRequestOptions = { method: 'PUT', ...baseOptions, ...options};
|
|
5577
|
-
const localVarHeaderParameter = {} as any;
|
|
5578
|
-
const localVarQueryParameter = {} as any;
|
|
5579
|
-
|
|
5580
|
-
// authentication BasicAuth required
|
|
5581
|
-
// http basic authentication required
|
|
5582
|
-
setBasicAuthToObject(localVarRequestOptions, configuration)
|
|
5583
|
-
|
|
5584
|
-
// authentication BearerAuth required
|
|
5585
|
-
// http bearer authentication required
|
|
5586
|
-
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
5587
|
-
|
|
5588
|
-
|
|
5589
|
-
|
|
5590
|
-
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
5591
|
-
|
|
5592
|
-
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
5593
|
-
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
5594
|
-
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
5595
|
-
localVarRequestOptions.data = serializeDataIfNeeded(iOValue, localVarRequestOptions, configuration)
|
|
5596
|
-
|
|
5597
|
-
return {
|
|
5598
|
-
url: toPathString(localVarUrlObj),
|
|
5599
|
-
options: localVarRequestOptions,
|
|
5600
|
-
};
|
|
5601
|
-
},
|
|
5602
|
-
}
|
|
5603
|
-
};
|
|
5604
|
-
|
|
5605
|
-
/**
|
|
5606
|
-
* BusIOsApi - functional programming interface
|
|
5607
|
-
* @export
|
|
5608
|
-
*/
|
|
5609
|
-
export const BusIOsApiFp = function(configuration?: Configuration) {
|
|
5610
|
-
const localVarAxiosParamCreator = BusIOsApiAxiosParamCreator(configuration)
|
|
5611
|
-
return {
|
|
5612
|
-
/**
|
|
5613
|
-
* Retrieves the current values of inputs/outputs. The identifiers of the inputs/outputs must be provided in the request. Request all available input/output identifiers via [listBusIODescriptions](listBusIODescriptions).
|
|
5614
|
-
* @summary Get Input/Output Values
|
|
5615
|
-
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5616
|
-
* @param {Array<string>} [ios]
|
|
5617
|
-
* @param {*} [options] Override http request option.
|
|
5618
|
-
* @throws {RequiredError}
|
|
5619
|
-
*/
|
|
5620
|
-
async getBusIOValues(cell: string, ios?: Array<string>, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<IOValue>>> {
|
|
5621
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.getBusIOValues(cell, ios, options);
|
|
5622
|
-
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
5623
|
-
const localVarOperationServerBasePath = operationServerMap['BusIOsApi.getBusIOValues']?.[localVarOperationServerIndex]?.url;
|
|
5624
|
-
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
5625
|
-
},
|
|
5626
|
-
/**
|
|
5627
|
-
* List all Bus Input/Outputs.
|
|
5628
|
-
* @summary Configuration
|
|
5629
|
-
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5630
|
-
* @param {*} [options] Override http request option.
|
|
5631
|
-
* @throws {RequiredError}
|
|
5632
|
-
*/
|
|
5633
|
-
async listBusIODescriptions(cell: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<IODescription>>> {
|
|
5634
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.listBusIODescriptions(cell, options);
|
|
5635
|
-
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
5636
|
-
const localVarOperationServerBasePath = operationServerMap['BusIOsApi.listBusIODescriptions']?.[localVarOperationServerIndex]?.url;
|
|
5637
|
-
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
5638
|
-
},
|
|
5639
|
-
/**
|
|
5640
|
-
* Set values of outputs. In case of virtual Bus Input/Outputs, also inputs can be set. All available output identifiers can be requested via [listBusIODescriptions](listBusIODescriptions). The call will return once the values have been set and accepted by the service.
|
|
5641
|
-
* @summary Set Output Values
|
|
5642
|
-
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5643
|
-
* @param {Array<IOValue>} iOValue
|
|
5644
|
-
* @param {*} [options] Override http request option.
|
|
5645
|
-
* @throws {RequiredError}
|
|
5646
|
-
*/
|
|
5647
|
-
async setBusIOValues(cell: string, iOValue: Array<IOValue>, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> {
|
|
5648
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.setBusIOValues(cell, iOValue, options);
|
|
5649
|
-
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
5650
|
-
const localVarOperationServerBasePath = operationServerMap['BusIOsApi.setBusIOValues']?.[localVarOperationServerIndex]?.url;
|
|
5651
|
-
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
5652
|
-
},
|
|
5653
|
-
}
|
|
5654
|
-
};
|
|
5655
|
-
|
|
5656
|
-
/**
|
|
5657
|
-
* BusIOsApi - factory interface
|
|
5658
|
-
* @export
|
|
5659
|
-
*/
|
|
5660
|
-
export const BusIOsApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
|
|
5661
|
-
const localVarFp = BusIOsApiFp(configuration)
|
|
5662
|
-
return {
|
|
5663
|
-
/**
|
|
5664
|
-
* Retrieves the current values of inputs/outputs. The identifiers of the inputs/outputs must be provided in the request. Request all available input/output identifiers via [listBusIODescriptions](listBusIODescriptions).
|
|
5665
|
-
* @summary Get Input/Output Values
|
|
5666
|
-
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5667
|
-
* @param {Array<string>} [ios]
|
|
5668
|
-
* @param {*} [options] Override http request option.
|
|
5669
|
-
* @throws {RequiredError}
|
|
5670
|
-
*/
|
|
5671
|
-
getBusIOValues(cell: string, ios?: Array<string>, options?: RawAxiosRequestConfig): AxiosPromise<Array<IOValue>> {
|
|
5672
|
-
return localVarFp.getBusIOValues(cell, ios, options).then((request) => request(axios, basePath));
|
|
5673
|
-
},
|
|
5674
|
-
/**
|
|
5675
|
-
* List all Bus Input/Outputs.
|
|
5676
|
-
* @summary Configuration
|
|
5677
|
-
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5678
|
-
* @param {*} [options] Override http request option.
|
|
5679
|
-
* @throws {RequiredError}
|
|
5680
|
-
*/
|
|
5681
|
-
listBusIODescriptions(cell: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<IODescription>> {
|
|
5682
|
-
return localVarFp.listBusIODescriptions(cell, options).then((request) => request(axios, basePath));
|
|
5683
|
-
},
|
|
5684
|
-
/**
|
|
5685
|
-
* Set values of outputs. In case of virtual Bus Input/Outputs, also inputs can be set. All available output identifiers can be requested via [listBusIODescriptions](listBusIODescriptions). The call will return once the values have been set and accepted by the service.
|
|
5686
|
-
* @summary Set Output Values
|
|
5687
|
-
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5688
|
-
* @param {Array<IOValue>} iOValue
|
|
5689
|
-
* @param {*} [options] Override http request option.
|
|
5690
|
-
* @throws {RequiredError}
|
|
5691
|
-
*/
|
|
5692
|
-
setBusIOValues(cell: string, iOValue: Array<IOValue>, options?: RawAxiosRequestConfig): AxiosPromise<void> {
|
|
5693
|
-
return localVarFp.setBusIOValues(cell, iOValue, options).then((request) => request(axios, basePath));
|
|
5694
|
-
},
|
|
5695
|
-
};
|
|
5696
|
-
};
|
|
5697
|
-
|
|
5698
|
-
/**
|
|
5699
|
-
* BusIOsApi - object-oriented interface
|
|
5700
|
-
* @export
|
|
5701
|
-
* @class BusIOsApi
|
|
5702
|
-
* @extends {BaseAPI}
|
|
5703
|
-
*/
|
|
5704
|
-
export class BusIOsApi extends BaseAPI {
|
|
5705
|
-
/**
|
|
5706
|
-
* Retrieves the current values of inputs/outputs. The identifiers of the inputs/outputs must be provided in the request. Request all available input/output identifiers via [listBusIODescriptions](listBusIODescriptions).
|
|
5707
|
-
* @summary Get Input/Output Values
|
|
5708
|
-
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5709
|
-
* @param {Array<string>} [ios]
|
|
5710
|
-
* @param {*} [options] Override http request option.
|
|
5711
|
-
* @throws {RequiredError}
|
|
5712
|
-
* @memberof BusIOsApi
|
|
5713
|
-
*/
|
|
5714
|
-
public getBusIOValues(cell: string, ios?: Array<string>, options?: RawAxiosRequestConfig) {
|
|
5715
|
-
return BusIOsApiFp(this.configuration).getBusIOValues(cell, ios, options).then((request) => request(this.axios, this.basePath));
|
|
5716
|
-
}
|
|
5717
|
-
|
|
5718
|
-
/**
|
|
5719
|
-
* List all Bus Input/Outputs.
|
|
5720
|
-
* @summary Configuration
|
|
5721
|
-
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5722
|
-
* @param {*} [options] Override http request option.
|
|
5723
|
-
* @throws {RequiredError}
|
|
5724
|
-
* @memberof BusIOsApi
|
|
5725
|
-
*/
|
|
5726
|
-
public listBusIODescriptions(cell: string, options?: RawAxiosRequestConfig) {
|
|
5727
|
-
return BusIOsApiFp(this.configuration).listBusIODescriptions(cell, options).then((request) => request(this.axios, this.basePath));
|
|
5728
|
-
}
|
|
5729
|
-
|
|
5730
|
-
/**
|
|
5731
|
-
* Set values of outputs. In case of virtual Bus Input/Outputs, also inputs can be set. All available output identifiers can be requested via [listBusIODescriptions](listBusIODescriptions). The call will return once the values have been set and accepted by the service.
|
|
5732
|
-
* @summary Set Output Values
|
|
5733
|
-
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5734
|
-
* @param {Array<IOValue>} iOValue
|
|
5735
|
-
* @param {*} [options] Override http request option.
|
|
5736
|
-
* @throws {RequiredError}
|
|
5737
|
-
* @memberof BusIOsApi
|
|
5738
|
-
*/
|
|
5739
|
-
public setBusIOValues(cell: string, iOValue: Array<IOValue>, options?: RawAxiosRequestConfig) {
|
|
5740
|
-
return BusIOsApiFp(this.configuration).setBusIOValues(cell, iOValue, options).then((request) => request(this.axios, this.basePath));
|
|
5741
|
-
}
|
|
5742
|
-
}
|
|
5743
|
-
|
|
5744
|
-
|
|
5745
|
-
|
|
5746
5523
|
/**
|
|
5747
5524
|
* CellApi - axios parameter creator
|
|
5748
5525
|
* @export
|