@wandelbots/nova-api 25.7.0-rc.2 → 25.8.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 +903 -27
- package/v2/api.js +1056 -0
- package/v2/api.js.map +1 -1
- package/v2/api.ts +1553 -27
package/v2/api.ts
CHANGED
|
@@ -372,6 +372,182 @@ export const BoxBoxTypeEnum = {
|
|
|
372
372
|
|
|
373
373
|
export type BoxBoxTypeEnum = typeof BoxBoxTypeEnum[keyof typeof BoxBoxTypeEnum];
|
|
374
374
|
|
|
375
|
+
/**
|
|
376
|
+
* PROFINET BUS Inputs/Outputs Service configuration.
|
|
377
|
+
* @export
|
|
378
|
+
* @interface BusIOProfinet
|
|
379
|
+
*/
|
|
380
|
+
export interface BusIOProfinet {
|
|
381
|
+
/**
|
|
382
|
+
*
|
|
383
|
+
* @type {string}
|
|
384
|
+
* @memberof BusIOProfinet
|
|
385
|
+
*/
|
|
386
|
+
'bus_type'?: BusIOProfinetBusTypeEnum;
|
|
387
|
+
/**
|
|
388
|
+
* Path to the configuration file.
|
|
389
|
+
* @type {string}
|
|
390
|
+
* @memberof BusIOProfinet
|
|
391
|
+
*/
|
|
392
|
+
'config_file_content'?: string;
|
|
393
|
+
/**
|
|
394
|
+
*
|
|
395
|
+
* @type {BusIOProfinetNetwork}
|
|
396
|
+
* @memberof BusIOProfinet
|
|
397
|
+
*/
|
|
398
|
+
'network_config'?: BusIOProfinetNetwork;
|
|
399
|
+
/**
|
|
400
|
+
* MAC address for the PROFINET port, should be get from another NOVA API endpoind?
|
|
401
|
+
* @type {string}
|
|
402
|
+
* @memberof BusIOProfinet
|
|
403
|
+
*/
|
|
404
|
+
'mac': string;
|
|
405
|
+
/**
|
|
406
|
+
*
|
|
407
|
+
* @type {BusIOProfinetDefaultRoute}
|
|
408
|
+
* @memberof BusIOProfinet
|
|
409
|
+
*/
|
|
410
|
+
'default_route': BusIOProfinetDefaultRoute;
|
|
411
|
+
}
|
|
412
|
+
|
|
413
|
+
export const BusIOProfinetBusTypeEnum = {
|
|
414
|
+
Profinet: 'profinet'
|
|
415
|
+
} as const;
|
|
416
|
+
|
|
417
|
+
export type BusIOProfinetBusTypeEnum = typeof BusIOProfinetBusTypeEnum[keyof typeof BusIOProfinetBusTypeEnum];
|
|
418
|
+
|
|
419
|
+
/**
|
|
420
|
+
* Default route configuration for the PROFINET service. Will be removed before release by automatic default route configuration, if possible.
|
|
421
|
+
* @export
|
|
422
|
+
* @interface BusIOProfinetDefaultRoute
|
|
423
|
+
*/
|
|
424
|
+
export interface BusIOProfinetDefaultRoute {
|
|
425
|
+
/**
|
|
426
|
+
* Gateway for the default route.
|
|
427
|
+
* @type {string}
|
|
428
|
+
* @memberof BusIOProfinetDefaultRoute
|
|
429
|
+
*/
|
|
430
|
+
'gateway': string;
|
|
431
|
+
/**
|
|
432
|
+
* Interface for the default route.
|
|
433
|
+
* @type {string}
|
|
434
|
+
* @memberof BusIOProfinetDefaultRoute
|
|
435
|
+
*/
|
|
436
|
+
'interface': string;
|
|
437
|
+
}
|
|
438
|
+
/**
|
|
439
|
+
* Network configuration for the PROFINET device
|
|
440
|
+
* @export
|
|
441
|
+
* @interface BusIOProfinetIpConfig
|
|
442
|
+
*/
|
|
443
|
+
export interface BusIOProfinetIpConfig {
|
|
444
|
+
/**
|
|
445
|
+
* IP address for the PROFINET device
|
|
446
|
+
* @type {string}
|
|
447
|
+
* @memberof BusIOProfinetIpConfig
|
|
448
|
+
*/
|
|
449
|
+
'ip': string;
|
|
450
|
+
/**
|
|
451
|
+
* Network mask for the PROFINET device.
|
|
452
|
+
* @type {string}
|
|
453
|
+
* @memberof BusIOProfinetIpConfig
|
|
454
|
+
*/
|
|
455
|
+
'netmask': string;
|
|
456
|
+
/**
|
|
457
|
+
* Gateway for the PROFINET device
|
|
458
|
+
* @type {string}
|
|
459
|
+
* @memberof BusIOProfinetIpConfig
|
|
460
|
+
*/
|
|
461
|
+
'gateway': string;
|
|
462
|
+
}
|
|
463
|
+
/**
|
|
464
|
+
*
|
|
465
|
+
* @export
|
|
466
|
+
* @interface BusIOProfinetNetwork
|
|
467
|
+
*/
|
|
468
|
+
export interface BusIOProfinetNetwork {
|
|
469
|
+
/**
|
|
470
|
+
* Name of the PROFINET device.
|
|
471
|
+
* @type {string}
|
|
472
|
+
* @memberof BusIOProfinetNetwork
|
|
473
|
+
*/
|
|
474
|
+
'device_name'?: string;
|
|
475
|
+
/**
|
|
476
|
+
*
|
|
477
|
+
* @type {BusIOProfinetIpConfig}
|
|
478
|
+
* @memberof BusIOProfinetNetwork
|
|
479
|
+
*/
|
|
480
|
+
'ip_config'?: BusIOProfinetIpConfig;
|
|
481
|
+
/**
|
|
482
|
+
* Content of the PROFINET REMA XML file.
|
|
483
|
+
* @type {string}
|
|
484
|
+
* @memberof BusIOProfinetNetwork
|
|
485
|
+
*/
|
|
486
|
+
'rema_xml_content'?: string;
|
|
487
|
+
}
|
|
488
|
+
/**
|
|
489
|
+
* Virtual PROFINET BUS Inputs/Outputs Service configuration.
|
|
490
|
+
* @export
|
|
491
|
+
* @interface BusIOProfinetVirtual
|
|
492
|
+
*/
|
|
493
|
+
export interface BusIOProfinetVirtual {
|
|
494
|
+
/**
|
|
495
|
+
*
|
|
496
|
+
* @type {string}
|
|
497
|
+
* @memberof BusIOProfinetVirtual
|
|
498
|
+
*/
|
|
499
|
+
'bus_type'?: BusIOProfinetVirtualBusTypeEnum;
|
|
500
|
+
}
|
|
501
|
+
|
|
502
|
+
export const BusIOProfinetVirtualBusTypeEnum = {
|
|
503
|
+
VirtualProfinet: 'virtual_profinet'
|
|
504
|
+
} as const;
|
|
505
|
+
|
|
506
|
+
export type BusIOProfinetVirtualBusTypeEnum = typeof BusIOProfinetVirtualBusTypeEnum[keyof typeof BusIOProfinetVirtualBusTypeEnum];
|
|
507
|
+
|
|
508
|
+
/**
|
|
509
|
+
* @type BusIOType
|
|
510
|
+
* @export
|
|
511
|
+
*/
|
|
512
|
+
export type BusIOType = { bus_type: 'profinet' } & BusIOProfinet | { bus_type: 'profinet_virtual' } & BusIOProfinetVirtual;
|
|
513
|
+
|
|
514
|
+
/**
|
|
515
|
+
*
|
|
516
|
+
* @export
|
|
517
|
+
* @interface BusIOsState
|
|
518
|
+
*/
|
|
519
|
+
export interface BusIOsState {
|
|
520
|
+
/**
|
|
521
|
+
*
|
|
522
|
+
* @type {BusIOsStateEnum}
|
|
523
|
+
* @memberof BusIOsState
|
|
524
|
+
*/
|
|
525
|
+
'state': BusIOsStateEnum;
|
|
526
|
+
/**
|
|
527
|
+
* A message providing additional information on the input/output, e.g. BUS service status, encountered errors. May be empty if no additional information is available.
|
|
528
|
+
* @type {string}
|
|
529
|
+
* @memberof BusIOsState
|
|
530
|
+
*/
|
|
531
|
+
'message'?: string;
|
|
532
|
+
}
|
|
533
|
+
|
|
534
|
+
|
|
535
|
+
/**
|
|
536
|
+
* Current state of the BUS input/output service.
|
|
537
|
+
* @export
|
|
538
|
+
* @enum {string}
|
|
539
|
+
*/
|
|
540
|
+
|
|
541
|
+
export const BusIOsStateEnum = {
|
|
542
|
+
BusIosStateUnknown: 'BUS_IOS_STATE_UNKNOWN',
|
|
543
|
+
BusIosStateInitializing: 'BUS_IOS_STATE_INITIALIZING',
|
|
544
|
+
BusIosStateConnected: 'BUS_IOS_STATE_CONNECTED',
|
|
545
|
+
BusIosStateDisconnected: 'BUS_IOS_STATE_DISCONNECTED'
|
|
546
|
+
} as const;
|
|
547
|
+
|
|
548
|
+
export type BusIOsStateEnum = typeof BusIOsStateEnum[keyof typeof BusIOsStateEnum];
|
|
549
|
+
|
|
550
|
+
|
|
375
551
|
/**
|
|
376
552
|
* Defines a cylindrical shape with 2 semi-spheres on the top and bottom. Centred around origin, symmetric around z-axis.
|
|
377
553
|
* @export
|
|
@@ -2394,10 +2570,10 @@ export interface JointLimits {
|
|
|
2394
2570
|
export interface JointTrajectory {
|
|
2395
2571
|
/**
|
|
2396
2572
|
* List of joint positions [rad] for each sample. The number of samples must match the number of timestamps provided in the times field.
|
|
2397
|
-
* @type {Array<
|
|
2573
|
+
* @type {Array<Array<number>>}
|
|
2398
2574
|
* @memberof JointTrajectory
|
|
2399
2575
|
*/
|
|
2400
|
-
'joint_positions': Array<
|
|
2576
|
+
'joint_positions': Array<Array<number>>;
|
|
2401
2577
|
/**
|
|
2402
2578
|
* Timestamp for each sample [s].
|
|
2403
2579
|
* @type {Array<number>}
|
|
@@ -2424,11 +2600,11 @@ export interface JointVelocityRequest {
|
|
|
2424
2600
|
*/
|
|
2425
2601
|
'message_type'?: JointVelocityRequestMessageTypeEnum;
|
|
2426
2602
|
/**
|
|
2427
|
-
*
|
|
2428
|
-
* @type {
|
|
2603
|
+
* This structure describes a set of joint values (e.g. positions, currents, torques) of a motion group. Float precision is the default.
|
|
2604
|
+
* @type {Array<number>}
|
|
2429
2605
|
* @memberof JointVelocityRequest
|
|
2430
2606
|
*/
|
|
2431
|
-
'velocity':
|
|
2607
|
+
'velocity': Array<number>;
|
|
2432
2608
|
}
|
|
2433
2609
|
|
|
2434
2610
|
export const JointVelocityRequestMessageTypeEnum = {
|
|
@@ -2463,19 +2639,6 @@ export const JointVelocityResponseKindEnum = {
|
|
|
2463
2639
|
|
|
2464
2640
|
export type JointVelocityResponseKindEnum = typeof JointVelocityResponseKindEnum[keyof typeof JointVelocityResponseKindEnum];
|
|
2465
2641
|
|
|
2466
|
-
/**
|
|
2467
|
-
* This structure describes a set of joint values of a motion group. We call a set of joint values describing the current position in joint space of a motion group a \"joint position\". Joint position was chosen as the term to be consistent with the terms \"joint velocity\" and \"joint acceleration\". `joints` must have as many entries as the motion group\'s degrees of freedom to be valid. Float precision is the default.
|
|
2468
|
-
* @export
|
|
2469
|
-
* @interface Joints
|
|
2470
|
-
*/
|
|
2471
|
-
export interface Joints {
|
|
2472
|
-
/**
|
|
2473
|
-
*
|
|
2474
|
-
* @type {Array<number>}
|
|
2475
|
-
* @memberof Joints
|
|
2476
|
-
*/
|
|
2477
|
-
'joints': Array<number>;
|
|
2478
|
-
}
|
|
2479
2642
|
/**
|
|
2480
2643
|
* The configuration of a physical KUKA robot controller has to contain an IP address. Additionally an RSI server configuration has to be specified in order to control the robot. Deploying the server is a functionality of this API.
|
|
2481
2644
|
* @export
|
|
@@ -3066,11 +3229,11 @@ export interface MotionGroupState {
|
|
|
3066
3229
|
*/
|
|
3067
3230
|
'controller': string;
|
|
3068
3231
|
/**
|
|
3069
|
-
*
|
|
3070
|
-
* @type {
|
|
3232
|
+
* This structure describes a set of joint values (e.g. positions, currents, torques) of a motion group. Float precision is the default.
|
|
3233
|
+
* @type {Array<number>}
|
|
3071
3234
|
* @memberof MotionGroupState
|
|
3072
3235
|
*/
|
|
3073
|
-
'joint_position':
|
|
3236
|
+
'joint_position': Array<number>;
|
|
3074
3237
|
/**
|
|
3075
3238
|
* Indicates whether the joint is in a limit for all joints of the motion group.
|
|
3076
3239
|
* @type {MotionGroupStateJointLimitReached}
|
|
@@ -3078,17 +3241,17 @@ export interface MotionGroupState {
|
|
|
3078
3241
|
*/
|
|
3079
3242
|
'joint_limit_reached': MotionGroupStateJointLimitReached;
|
|
3080
3243
|
/**
|
|
3081
|
-
*
|
|
3082
|
-
* @type {
|
|
3244
|
+
* This structure describes a set of joint values (e.g. positions, currents, torques) of a motion group. Float precision is the default.
|
|
3245
|
+
* @type {Array<number>}
|
|
3083
3246
|
* @memberof MotionGroupState
|
|
3084
3247
|
*/
|
|
3085
|
-
'joint_torque'?:
|
|
3248
|
+
'joint_torque'?: Array<number>;
|
|
3086
3249
|
/**
|
|
3087
|
-
*
|
|
3088
|
-
* @type {
|
|
3250
|
+
* This structure describes a set of joint values (e.g. positions, currents, torques) of a motion group. Float precision is the default.
|
|
3251
|
+
* @type {Array<number>}
|
|
3089
3252
|
* @memberof MotionGroupState
|
|
3090
3253
|
*/
|
|
3091
|
-
'joint_current'?:
|
|
3254
|
+
'joint_current'?: Array<number>;
|
|
3092
3255
|
/**
|
|
3093
3256
|
* Pose of the flange. Positions are in [mm]. Oriantations are in [rad]. The pose is relative to the response_coordinate_system specified in the request. For robot arms a flange pose is always returned, for positioners the flange might not be available, depending on the model.
|
|
3094
3257
|
* @type {Pose}
|
|
@@ -3883,6 +4046,239 @@ export interface Pose {
|
|
|
3883
4046
|
*/
|
|
3884
4047
|
'orientation'?: Array<number>;
|
|
3885
4048
|
}
|
|
4049
|
+
/**
|
|
4050
|
+
*
|
|
4051
|
+
* @export
|
|
4052
|
+
* @interface ProfinetDescription
|
|
4053
|
+
*/
|
|
4054
|
+
export interface ProfinetDescription {
|
|
4055
|
+
/**
|
|
4056
|
+
* The vendor identifier of the PROFINET device, identifying the manufacturer.
|
|
4057
|
+
* @type {string}
|
|
4058
|
+
* @memberof ProfinetDescription
|
|
4059
|
+
*/
|
|
4060
|
+
'vendor_id': string;
|
|
4061
|
+
/**
|
|
4062
|
+
* The device identifier of the PROFINET device, identifying the specific device within the vendor\'s range.
|
|
4063
|
+
* @type {string}
|
|
4064
|
+
* @memberof ProfinetDescription
|
|
4065
|
+
*/
|
|
4066
|
+
'device_id': string;
|
|
4067
|
+
/**
|
|
4068
|
+
*
|
|
4069
|
+
* @type {Array<ProfinetSlotDescription>}
|
|
4070
|
+
* @memberof ProfinetDescription
|
|
4071
|
+
*/
|
|
4072
|
+
'slots'?: Array<ProfinetSlotDescription>;
|
|
4073
|
+
/**
|
|
4074
|
+
* Name of the PROFINET device
|
|
4075
|
+
* @type {string}
|
|
4076
|
+
* @memberof ProfinetDescription
|
|
4077
|
+
*/
|
|
4078
|
+
'device_name'?: string;
|
|
4079
|
+
/**
|
|
4080
|
+
* IP address for the PROFINET device
|
|
4081
|
+
* @type {string}
|
|
4082
|
+
* @memberof ProfinetDescription
|
|
4083
|
+
*/
|
|
4084
|
+
'ip'?: string;
|
|
4085
|
+
}
|
|
4086
|
+
/**
|
|
4087
|
+
*
|
|
4088
|
+
* @export
|
|
4089
|
+
* @interface ProfinetIO
|
|
4090
|
+
*/
|
|
4091
|
+
export interface ProfinetIO {
|
|
4092
|
+
/**
|
|
4093
|
+
* The name of the input/output value. This is a human-readable identifier for the value. It can be used to distinguish between different inputs/outputs in the system.
|
|
4094
|
+
* @type {string}
|
|
4095
|
+
* @memberof ProfinetIO
|
|
4096
|
+
*/
|
|
4097
|
+
'name': string;
|
|
4098
|
+
/**
|
|
4099
|
+
*
|
|
4100
|
+
* @type {ProfinetIOTypeEnum}
|
|
4101
|
+
* @memberof ProfinetIO
|
|
4102
|
+
*/
|
|
4103
|
+
'type': ProfinetIOTypeEnum;
|
|
4104
|
+
/**
|
|
4105
|
+
* The direction of the input/output value, indicating whether it is an input or output for the device.
|
|
4106
|
+
* @type {ProfinetIODirection}
|
|
4107
|
+
* @memberof ProfinetIO
|
|
4108
|
+
*/
|
|
4109
|
+
'direction': ProfinetIODirection;
|
|
4110
|
+
/**
|
|
4111
|
+
* The byte address of the input/output value in the PROFINET device. The byte address is used to locate the specific input/output within the device\'s memory or data structure.
|
|
4112
|
+
* @type {number}
|
|
4113
|
+
* @memberof ProfinetIO
|
|
4114
|
+
*/
|
|
4115
|
+
'byte_address': number;
|
|
4116
|
+
/**
|
|
4117
|
+
* The bit address of the input/output value within the byte or word address. The bit address is used to specify the exact bit within the byte or word that corresponds to the input/output value.
|
|
4118
|
+
* @type {number}
|
|
4119
|
+
* @memberof ProfinetIO
|
|
4120
|
+
*/
|
|
4121
|
+
'bit_address'?: number;
|
|
4122
|
+
/**
|
|
4123
|
+
* The unique identifier for the input/output value. This identifier is used to reference the specific input/output in the NOVA system.
|
|
4124
|
+
* @type {string}
|
|
4125
|
+
* @memberof ProfinetIO
|
|
4126
|
+
*/
|
|
4127
|
+
'io': string;
|
|
4128
|
+
}
|
|
4129
|
+
|
|
4130
|
+
|
|
4131
|
+
/**
|
|
4132
|
+
*
|
|
4133
|
+
* @export
|
|
4134
|
+
* @interface ProfinetIOData
|
|
4135
|
+
*/
|
|
4136
|
+
export interface ProfinetIOData {
|
|
4137
|
+
/**
|
|
4138
|
+
* The name of the input/output value. This is a human-readable identifier for the value. It can be used to distinguish between different inputs/outputs in the system.
|
|
4139
|
+
* @type {string}
|
|
4140
|
+
* @memberof ProfinetIOData
|
|
4141
|
+
*/
|
|
4142
|
+
'name': string;
|
|
4143
|
+
/**
|
|
4144
|
+
*
|
|
4145
|
+
* @type {ProfinetIOTypeEnum}
|
|
4146
|
+
* @memberof ProfinetIOData
|
|
4147
|
+
*/
|
|
4148
|
+
'type': ProfinetIOTypeEnum;
|
|
4149
|
+
/**
|
|
4150
|
+
* The direction of the input/output value, indicating whether it is an input or output for the device.
|
|
4151
|
+
* @type {ProfinetIODirection}
|
|
4152
|
+
* @memberof ProfinetIOData
|
|
4153
|
+
*/
|
|
4154
|
+
'direction': ProfinetIODirection;
|
|
4155
|
+
/**
|
|
4156
|
+
* The byte address of the input/output value in the PROFINET device. The byte address is used to locate the specific input/output within the device\'s memory or data structure.
|
|
4157
|
+
* @type {number}
|
|
4158
|
+
* @memberof ProfinetIOData
|
|
4159
|
+
*/
|
|
4160
|
+
'byte_address': number;
|
|
4161
|
+
/**
|
|
4162
|
+
* The bit address of the input/output value within the byte or word address. The bit address is used to specify the exact bit within the byte or word that corresponds to the input/output value.
|
|
4163
|
+
* @type {number}
|
|
4164
|
+
* @memberof ProfinetIOData
|
|
4165
|
+
*/
|
|
4166
|
+
'bit_address'?: number;
|
|
4167
|
+
}
|
|
4168
|
+
|
|
4169
|
+
|
|
4170
|
+
/**
|
|
4171
|
+
* Identifies the input/output type.
|
|
4172
|
+
* @export
|
|
4173
|
+
* @enum {string}
|
|
4174
|
+
*/
|
|
4175
|
+
|
|
4176
|
+
export const ProfinetIODirection = {
|
|
4177
|
+
ProfinetIoDirectionInput: 'PROFINET_IO_DIRECTION_INPUT',
|
|
4178
|
+
ProfinetIoDirectionOutput: 'PROFINET_IO_DIRECTION_OUTPUT',
|
|
4179
|
+
ProfinetIoDirectionInout: 'PROFINET_IO_DIRECTION_INOUT'
|
|
4180
|
+
} as const;
|
|
4181
|
+
|
|
4182
|
+
export type ProfinetIODirection = typeof ProfinetIODirection[keyof typeof ProfinetIODirection];
|
|
4183
|
+
|
|
4184
|
+
|
|
4185
|
+
/**
|
|
4186
|
+
* Value type of the PROFINET input/output.
|
|
4187
|
+
* @export
|
|
4188
|
+
* @enum {string}
|
|
4189
|
+
*/
|
|
4190
|
+
|
|
4191
|
+
export const ProfinetIOTypeEnum = {
|
|
4192
|
+
ProfinetIoTypeUnknown: 'PROFINET_IO_TYPE_UNKNOWN',
|
|
4193
|
+
ProfinetIoTypeBool: 'PROFINET_IO_TYPE_BOOL',
|
|
4194
|
+
ProfinetIoTypeUsint: 'PROFINET_IO_TYPE_USINT',
|
|
4195
|
+
ProfinetIoTypeSint: 'PROFINET_IO_TYPE_SINT',
|
|
4196
|
+
ProfinetIoTypeUint: 'PROFINET_IO_TYPE_UINT',
|
|
4197
|
+
ProfinetIoTypeInt: 'PROFINET_IO_TYPE_INT',
|
|
4198
|
+
ProfinetIoTypeUdint: 'PROFINET_IO_TYPE_UDINT',
|
|
4199
|
+
ProfinetIoTypeDint: 'PROFINET_IO_TYPE_DINT',
|
|
4200
|
+
ProfinetIoTypeReal: 'PROFINET_IO_TYPE_REAL',
|
|
4201
|
+
ProfinetIoTypeLreal: 'PROFINET_IO_TYPE_LREAL'
|
|
4202
|
+
} as const;
|
|
4203
|
+
|
|
4204
|
+
export type ProfinetIOTypeEnum = typeof ProfinetIOTypeEnum[keyof typeof ProfinetIOTypeEnum];
|
|
4205
|
+
|
|
4206
|
+
|
|
4207
|
+
/**
|
|
4208
|
+
*
|
|
4209
|
+
* @export
|
|
4210
|
+
* @interface ProfinetInputOutputConfig
|
|
4211
|
+
*/
|
|
4212
|
+
export interface ProfinetInputOutputConfig {
|
|
4213
|
+
/**
|
|
4214
|
+
* Content of the input output configuration file.
|
|
4215
|
+
* @type {string}
|
|
4216
|
+
* @memberof ProfinetInputOutputConfig
|
|
4217
|
+
*/
|
|
4218
|
+
'config': string;
|
|
4219
|
+
/**
|
|
4220
|
+
* Offset in bytes for the input data.
|
|
4221
|
+
* @type {number}
|
|
4222
|
+
* @memberof ProfinetInputOutputConfig
|
|
4223
|
+
*/
|
|
4224
|
+
'input_offset': number;
|
|
4225
|
+
/**
|
|
4226
|
+
* Offset in bytes for the output data.
|
|
4227
|
+
* @type {number}
|
|
4228
|
+
* @memberof ProfinetInputOutputConfig
|
|
4229
|
+
*/
|
|
4230
|
+
'output_offset': number;
|
|
4231
|
+
}
|
|
4232
|
+
/**
|
|
4233
|
+
*
|
|
4234
|
+
* @export
|
|
4235
|
+
* @interface ProfinetSlotDescription
|
|
4236
|
+
*/
|
|
4237
|
+
export interface ProfinetSlotDescription {
|
|
4238
|
+
/**
|
|
4239
|
+
* The number of the PROFINET slot.
|
|
4240
|
+
* @type {number}
|
|
4241
|
+
* @memberof ProfinetSlotDescription
|
|
4242
|
+
*/
|
|
4243
|
+
'number': number;
|
|
4244
|
+
/**
|
|
4245
|
+
* The API number of the PROFINET input, used to identify the specific API for the input.
|
|
4246
|
+
* @type {number}
|
|
4247
|
+
* @memberof ProfinetSlotDescription
|
|
4248
|
+
*/
|
|
4249
|
+
'api': number;
|
|
4250
|
+
/**
|
|
4251
|
+
* An array of PROFINET subslots.
|
|
4252
|
+
* @type {Array<ProfinetSubSlotDescription>}
|
|
4253
|
+
* @memberof ProfinetSlotDescription
|
|
4254
|
+
*/
|
|
4255
|
+
'subslots': Array<ProfinetSubSlotDescription>;
|
|
4256
|
+
}
|
|
4257
|
+
/**
|
|
4258
|
+
*
|
|
4259
|
+
* @export
|
|
4260
|
+
* @interface ProfinetSubSlotDescription
|
|
4261
|
+
*/
|
|
4262
|
+
export interface ProfinetSubSlotDescription {
|
|
4263
|
+
/**
|
|
4264
|
+
* The identifier of the PROFINET subslot.
|
|
4265
|
+
* @type {number}
|
|
4266
|
+
* @memberof ProfinetSubSlotDescription
|
|
4267
|
+
*/
|
|
4268
|
+
'number': number;
|
|
4269
|
+
/**
|
|
4270
|
+
* The length in bytes of the PROFINET input.
|
|
4271
|
+
* @type {number}
|
|
4272
|
+
* @memberof ProfinetSubSlotDescription
|
|
4273
|
+
*/
|
|
4274
|
+
'input_length': number;
|
|
4275
|
+
/**
|
|
4276
|
+
* The length in bytes of the PROFINET output.
|
|
4277
|
+
* @type {number}
|
|
4278
|
+
* @memberof ProfinetSubSlotDescription
|
|
4279
|
+
*/
|
|
4280
|
+
'output_length': number;
|
|
4281
|
+
}
|
|
3886
4282
|
/**
|
|
3887
4283
|
* <!-- theme: danger --> > **Experimental** RRT Connect algorithm configuration for collision-free path planning. Rapidly-exploring Random Trees (RRT) builds trees of valid configurations by randomly sampling the joint space and connecting feasible points. RRT Connect grows two trees simultaneously from start and target positions until they meet. This is a custom implementation optimized for manipulator kinematics and collision checking in industrial contexts.
|
|
3888
4284
|
* @export
|
|
@@ -5747,6 +6143,1136 @@ export class ApplicationApi extends BaseAPI {
|
|
|
5747
6143
|
|
|
5748
6144
|
|
|
5749
6145
|
|
|
6146
|
+
/**
|
|
6147
|
+
* BUSInputsOutputsApi - axios parameter creator
|
|
6148
|
+
* @export
|
|
6149
|
+
*/
|
|
6150
|
+
export const BUSInputsOutputsApiAxiosParamCreator = function (configuration?: Configuration) {
|
|
6151
|
+
return {
|
|
6152
|
+
/**
|
|
6153
|
+
* Add a BUS Inputs/Outputs Service to the cell.
|
|
6154
|
+
* @summary Add Service
|
|
6155
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
6156
|
+
* @param {BusIOType} busIOType
|
|
6157
|
+
* @param {number} [completionTimeout]
|
|
6158
|
+
* @param {*} [options] Override http request option.
|
|
6159
|
+
* @throws {RequiredError}
|
|
6160
|
+
*/
|
|
6161
|
+
addBusIOService: async (cell: string, busIOType: BusIOType, completionTimeout?: number, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
6162
|
+
// verify required parameter 'cell' is not null or undefined
|
|
6163
|
+
assertParamExists('addBusIOService', 'cell', cell)
|
|
6164
|
+
// verify required parameter 'busIOType' is not null or undefined
|
|
6165
|
+
assertParamExists('addBusIOService', 'busIOType', busIOType)
|
|
6166
|
+
const localVarPath = `/cells/{cell}/bus-ios`
|
|
6167
|
+
.replace(`{${"cell"}}`, encodeURIComponent(String(cell)));
|
|
6168
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
6169
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
6170
|
+
let baseOptions;
|
|
6171
|
+
if (configuration) {
|
|
6172
|
+
baseOptions = configuration.baseOptions;
|
|
6173
|
+
}
|
|
6174
|
+
|
|
6175
|
+
const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
|
|
6176
|
+
const localVarHeaderParameter = {} as any;
|
|
6177
|
+
const localVarQueryParameter = {} as any;
|
|
6178
|
+
|
|
6179
|
+
// authentication BasicAuth required
|
|
6180
|
+
// http basic authentication required
|
|
6181
|
+
setBasicAuthToObject(localVarRequestOptions, configuration)
|
|
6182
|
+
|
|
6183
|
+
// authentication BearerAuth required
|
|
6184
|
+
// http bearer authentication required
|
|
6185
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
6186
|
+
|
|
6187
|
+
if (completionTimeout !== undefined) {
|
|
6188
|
+
localVarQueryParameter['completion_timeout'] = completionTimeout;
|
|
6189
|
+
}
|
|
6190
|
+
|
|
6191
|
+
|
|
6192
|
+
|
|
6193
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
6194
|
+
|
|
6195
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
6196
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
6197
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
6198
|
+
localVarRequestOptions.data = serializeDataIfNeeded(busIOType, localVarRequestOptions, configuration)
|
|
6199
|
+
|
|
6200
|
+
return {
|
|
6201
|
+
url: toPathString(localVarUrlObj),
|
|
6202
|
+
options: localVarRequestOptions,
|
|
6203
|
+
};
|
|
6204
|
+
},
|
|
6205
|
+
/**
|
|
6206
|
+
* Adds an input/output to or updates an input/output on the PROFINET device.
|
|
6207
|
+
* @summary Add PROFINET Input/Output
|
|
6208
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
6209
|
+
* @param {string} io Unique identifier to address an Input/Output in the cell.
|
|
6210
|
+
* @param {ProfinetIOData} profinetIOData
|
|
6211
|
+
* @param {*} [options] Override http request option.
|
|
6212
|
+
* @throws {RequiredError}
|
|
6213
|
+
*/
|
|
6214
|
+
addProfinetIO: async (cell: string, io: string, profinetIOData: ProfinetIOData, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
6215
|
+
// verify required parameter 'cell' is not null or undefined
|
|
6216
|
+
assertParamExists('addProfinetIO', 'cell', cell)
|
|
6217
|
+
// verify required parameter 'io' is not null or undefined
|
|
6218
|
+
assertParamExists('addProfinetIO', 'io', io)
|
|
6219
|
+
// verify required parameter 'profinetIOData' is not null or undefined
|
|
6220
|
+
assertParamExists('addProfinetIO', 'profinetIOData', profinetIOData)
|
|
6221
|
+
const localVarPath = `/cells/{cell}/bus-ios/profinet/ios/{io}`
|
|
6222
|
+
.replace(`{${"cell"}}`, encodeURIComponent(String(cell)))
|
|
6223
|
+
.replace(`{${"io"}}`, encodeURIComponent(String(io)));
|
|
6224
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
6225
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
6226
|
+
let baseOptions;
|
|
6227
|
+
if (configuration) {
|
|
6228
|
+
baseOptions = configuration.baseOptions;
|
|
6229
|
+
}
|
|
6230
|
+
|
|
6231
|
+
const localVarRequestOptions = { method: 'PUT', ...baseOptions, ...options};
|
|
6232
|
+
const localVarHeaderParameter = {} as any;
|
|
6233
|
+
const localVarQueryParameter = {} as any;
|
|
6234
|
+
|
|
6235
|
+
// authentication BasicAuth required
|
|
6236
|
+
// http basic authentication required
|
|
6237
|
+
setBasicAuthToObject(localVarRequestOptions, configuration)
|
|
6238
|
+
|
|
6239
|
+
// authentication BearerAuth required
|
|
6240
|
+
// http bearer authentication required
|
|
6241
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
6242
|
+
|
|
6243
|
+
|
|
6244
|
+
|
|
6245
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
6246
|
+
|
|
6247
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
6248
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
6249
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
6250
|
+
localVarRequestOptions.data = serializeDataIfNeeded(profinetIOData, localVarRequestOptions, configuration)
|
|
6251
|
+
|
|
6252
|
+
return {
|
|
6253
|
+
url: toPathString(localVarUrlObj),
|
|
6254
|
+
options: localVarRequestOptions,
|
|
6255
|
+
};
|
|
6256
|
+
},
|
|
6257
|
+
/**
|
|
6258
|
+
* Delete BUS Inputs/Outputs Service from the cell.
|
|
6259
|
+
* @summary Clear Service
|
|
6260
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
6261
|
+
* @param {number} [completionTimeout]
|
|
6262
|
+
* @param {*} [options] Override http request option.
|
|
6263
|
+
* @throws {RequiredError}
|
|
6264
|
+
*/
|
|
6265
|
+
clearBusIOService: async (cell: string, completionTimeout?: number, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
6266
|
+
// verify required parameter 'cell' is not null or undefined
|
|
6267
|
+
assertParamExists('clearBusIOService', 'cell', cell)
|
|
6268
|
+
const localVarPath = `/cells/{cell}/bus-ios`
|
|
6269
|
+
.replace(`{${"cell"}}`, encodeURIComponent(String(cell)));
|
|
6270
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
6271
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
6272
|
+
let baseOptions;
|
|
6273
|
+
if (configuration) {
|
|
6274
|
+
baseOptions = configuration.baseOptions;
|
|
6275
|
+
}
|
|
6276
|
+
|
|
6277
|
+
const localVarRequestOptions = { method: 'DELETE', ...baseOptions, ...options};
|
|
6278
|
+
const localVarHeaderParameter = {} as any;
|
|
6279
|
+
const localVarQueryParameter = {} as any;
|
|
6280
|
+
|
|
6281
|
+
// authentication BasicAuth required
|
|
6282
|
+
// http basic authentication required
|
|
6283
|
+
setBasicAuthToObject(localVarRequestOptions, configuration)
|
|
6284
|
+
|
|
6285
|
+
// authentication BearerAuth required
|
|
6286
|
+
// http bearer authentication required
|
|
6287
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
6288
|
+
|
|
6289
|
+
if (completionTimeout !== undefined) {
|
|
6290
|
+
localVarQueryParameter['completion_timeout'] = completionTimeout;
|
|
6291
|
+
}
|
|
6292
|
+
|
|
6293
|
+
|
|
6294
|
+
|
|
6295
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
6296
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
6297
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
6298
|
+
|
|
6299
|
+
return {
|
|
6300
|
+
url: toPathString(localVarUrlObj),
|
|
6301
|
+
options: localVarRequestOptions,
|
|
6302
|
+
};
|
|
6303
|
+
},
|
|
6304
|
+
/**
|
|
6305
|
+
* Removes the input/output from the PROFINET device.
|
|
6306
|
+
* @summary Remove PROFINET Input/Ouptut
|
|
6307
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
6308
|
+
* @param {string} io Unique identifier to address an Input/Output in the cell.
|
|
6309
|
+
* @param {*} [options] Override http request option.
|
|
6310
|
+
* @throws {RequiredError}
|
|
6311
|
+
*/
|
|
6312
|
+
deleteProfinetIO: async (cell: string, io: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
6313
|
+
// verify required parameter 'cell' is not null or undefined
|
|
6314
|
+
assertParamExists('deleteProfinetIO', 'cell', cell)
|
|
6315
|
+
// verify required parameter 'io' is not null or undefined
|
|
6316
|
+
assertParamExists('deleteProfinetIO', 'io', io)
|
|
6317
|
+
const localVarPath = `/cells/{cell}/bus-ios/profinet/ios/{io}`
|
|
6318
|
+
.replace(`{${"cell"}}`, encodeURIComponent(String(cell)))
|
|
6319
|
+
.replace(`{${"io"}}`, encodeURIComponent(String(io)));
|
|
6320
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
6321
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
6322
|
+
let baseOptions;
|
|
6323
|
+
if (configuration) {
|
|
6324
|
+
baseOptions = configuration.baseOptions;
|
|
6325
|
+
}
|
|
6326
|
+
|
|
6327
|
+
const localVarRequestOptions = { method: 'DELETE', ...baseOptions, ...options};
|
|
6328
|
+
const localVarHeaderParameter = {} as any;
|
|
6329
|
+
const localVarQueryParameter = {} as any;
|
|
6330
|
+
|
|
6331
|
+
// authentication BasicAuth required
|
|
6332
|
+
// http basic authentication required
|
|
6333
|
+
setBasicAuthToObject(localVarRequestOptions, configuration)
|
|
6334
|
+
|
|
6335
|
+
// authentication BearerAuth required
|
|
6336
|
+
// http bearer authentication required
|
|
6337
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
6338
|
+
|
|
6339
|
+
|
|
6340
|
+
|
|
6341
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
6342
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
6343
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
6344
|
+
|
|
6345
|
+
return {
|
|
6346
|
+
url: toPathString(localVarUrlObj),
|
|
6347
|
+
options: localVarRequestOptions,
|
|
6348
|
+
};
|
|
6349
|
+
},
|
|
6350
|
+
/**
|
|
6351
|
+
* Get deployed BUS Inputs/Outputs Service.
|
|
6352
|
+
* @summary Get Service
|
|
6353
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
6354
|
+
* @param {*} [options] Override http request option.
|
|
6355
|
+
* @throws {RequiredError}
|
|
6356
|
+
*/
|
|
6357
|
+
getBusIOService: async (cell: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
6358
|
+
// verify required parameter 'cell' is not null or undefined
|
|
6359
|
+
assertParamExists('getBusIOService', 'cell', cell)
|
|
6360
|
+
const localVarPath = `/cells/{cell}/bus-ios`
|
|
6361
|
+
.replace(`{${"cell"}}`, encodeURIComponent(String(cell)));
|
|
6362
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
6363
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
6364
|
+
let baseOptions;
|
|
6365
|
+
if (configuration) {
|
|
6366
|
+
baseOptions = configuration.baseOptions;
|
|
6367
|
+
}
|
|
6368
|
+
|
|
6369
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
6370
|
+
const localVarHeaderParameter = {} as any;
|
|
6371
|
+
const localVarQueryParameter = {} as any;
|
|
6372
|
+
|
|
6373
|
+
// authentication BasicAuth required
|
|
6374
|
+
// http basic authentication required
|
|
6375
|
+
setBasicAuthToObject(localVarRequestOptions, configuration)
|
|
6376
|
+
|
|
6377
|
+
// authentication BearerAuth required
|
|
6378
|
+
// http bearer authentication required
|
|
6379
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
6380
|
+
|
|
6381
|
+
|
|
6382
|
+
|
|
6383
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
6384
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
6385
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
6386
|
+
|
|
6387
|
+
return {
|
|
6388
|
+
url: toPathString(localVarUrlObj),
|
|
6389
|
+
options: localVarRequestOptions,
|
|
6390
|
+
};
|
|
6391
|
+
},
|
|
6392
|
+
/**
|
|
6393
|
+
* Get the current state of the BUS Inputs/Outputs service.
|
|
6394
|
+
* @summary State
|
|
6395
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
6396
|
+
* @param {*} [options] Override http request option.
|
|
6397
|
+
* @throws {RequiredError}
|
|
6398
|
+
*/
|
|
6399
|
+
getBusIOState: async (cell: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
6400
|
+
// verify required parameter 'cell' is not null or undefined
|
|
6401
|
+
assertParamExists('getBusIOState', 'cell', cell)
|
|
6402
|
+
const localVarPath = `/cells/{cell}/bus-ios/state`
|
|
6403
|
+
.replace(`{${"cell"}}`, encodeURIComponent(String(cell)));
|
|
6404
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
6405
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
6406
|
+
let baseOptions;
|
|
6407
|
+
if (configuration) {
|
|
6408
|
+
baseOptions = configuration.baseOptions;
|
|
6409
|
+
}
|
|
6410
|
+
|
|
6411
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
6412
|
+
const localVarHeaderParameter = {} as any;
|
|
6413
|
+
const localVarQueryParameter = {} as any;
|
|
6414
|
+
|
|
6415
|
+
// authentication BasicAuth required
|
|
6416
|
+
// http basic authentication required
|
|
6417
|
+
setBasicAuthToObject(localVarRequestOptions, configuration)
|
|
6418
|
+
|
|
6419
|
+
// authentication BearerAuth required
|
|
6420
|
+
// http bearer authentication required
|
|
6421
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
6422
|
+
|
|
6423
|
+
|
|
6424
|
+
|
|
6425
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
6426
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
6427
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
6428
|
+
|
|
6429
|
+
return {
|
|
6430
|
+
url: toPathString(localVarUrlObj),
|
|
6431
|
+
options: localVarRequestOptions,
|
|
6432
|
+
};
|
|
6433
|
+
},
|
|
6434
|
+
/**
|
|
6435
|
+
* 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).
|
|
6436
|
+
* @summary Get Input/Output Values
|
|
6437
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
6438
|
+
* @param {Array<string>} [ios]
|
|
6439
|
+
* @param {*} [options] Override http request option.
|
|
6440
|
+
* @throws {RequiredError}
|
|
6441
|
+
*/
|
|
6442
|
+
getBusIOValues: async (cell: string, ios?: Array<string>, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
6443
|
+
// verify required parameter 'cell' is not null or undefined
|
|
6444
|
+
assertParamExists('getBusIOValues', 'cell', cell)
|
|
6445
|
+
const localVarPath = `/cells/{cell}/bus-ios/ios/values`
|
|
6446
|
+
.replace(`{${"cell"}}`, encodeURIComponent(String(cell)));
|
|
6447
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
6448
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
6449
|
+
let baseOptions;
|
|
6450
|
+
if (configuration) {
|
|
6451
|
+
baseOptions = configuration.baseOptions;
|
|
6452
|
+
}
|
|
6453
|
+
|
|
6454
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
6455
|
+
const localVarHeaderParameter = {} as any;
|
|
6456
|
+
const localVarQueryParameter = {} as any;
|
|
6457
|
+
|
|
6458
|
+
// authentication BasicAuth required
|
|
6459
|
+
// http basic authentication required
|
|
6460
|
+
setBasicAuthToObject(localVarRequestOptions, configuration)
|
|
6461
|
+
|
|
6462
|
+
// authentication BearerAuth required
|
|
6463
|
+
// http bearer authentication required
|
|
6464
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
6465
|
+
|
|
6466
|
+
if (ios) {
|
|
6467
|
+
localVarQueryParameter['ios'] = ios;
|
|
6468
|
+
}
|
|
6469
|
+
|
|
6470
|
+
|
|
6471
|
+
|
|
6472
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
6473
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
6474
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
6475
|
+
|
|
6476
|
+
return {
|
|
6477
|
+
url: toPathString(localVarUrlObj),
|
|
6478
|
+
options: localVarRequestOptions,
|
|
6479
|
+
};
|
|
6480
|
+
},
|
|
6481
|
+
/**
|
|
6482
|
+
* Get description of PROFINET
|
|
6483
|
+
* @summary Get PROFINET Description
|
|
6484
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
6485
|
+
* @param {*} [options] Override http request option.
|
|
6486
|
+
* @throws {RequiredError}
|
|
6487
|
+
*/
|
|
6488
|
+
getProfinetDescription: async (cell: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
6489
|
+
// verify required parameter 'cell' is not null or undefined
|
|
6490
|
+
assertParamExists('getProfinetDescription', 'cell', cell)
|
|
6491
|
+
const localVarPath = `/cells/{cell}/bus-ios/profinet/description`
|
|
6492
|
+
.replace(`{${"cell"}}`, encodeURIComponent(String(cell)));
|
|
6493
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
6494
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
6495
|
+
let baseOptions;
|
|
6496
|
+
if (configuration) {
|
|
6497
|
+
baseOptions = configuration.baseOptions;
|
|
6498
|
+
}
|
|
6499
|
+
|
|
6500
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
6501
|
+
const localVarHeaderParameter = {} as any;
|
|
6502
|
+
const localVarQueryParameter = {} as any;
|
|
6503
|
+
|
|
6504
|
+
// authentication BasicAuth required
|
|
6505
|
+
// http basic authentication required
|
|
6506
|
+
setBasicAuthToObject(localVarRequestOptions, configuration)
|
|
6507
|
+
|
|
6508
|
+
// authentication BearerAuth required
|
|
6509
|
+
// http bearer authentication required
|
|
6510
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
6511
|
+
|
|
6512
|
+
|
|
6513
|
+
|
|
6514
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
6515
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
6516
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
6517
|
+
|
|
6518
|
+
return {
|
|
6519
|
+
url: toPathString(localVarUrlObj),
|
|
6520
|
+
options: localVarRequestOptions,
|
|
6521
|
+
};
|
|
6522
|
+
},
|
|
6523
|
+
/**
|
|
6524
|
+
* Get input/output configuration of the PROFINET device as file.
|
|
6525
|
+
* @summary PROFINET Inputs/Outputs to File
|
|
6526
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
6527
|
+
* @param {number} [inputOffset]
|
|
6528
|
+
* @param {number} [outputOffset]
|
|
6529
|
+
* @param {*} [options] Override http request option.
|
|
6530
|
+
* @throws {RequiredError}
|
|
6531
|
+
*/
|
|
6532
|
+
getProfinetIOsFromFile: async (cell: string, inputOffset?: number, outputOffset?: number, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
6533
|
+
// verify required parameter 'cell' is not null or undefined
|
|
6534
|
+
assertParamExists('getProfinetIOsFromFile', 'cell', cell)
|
|
6535
|
+
const localVarPath = `/cells/{cell}/bus-ios/profinet/iofile`
|
|
6536
|
+
.replace(`{${"cell"}}`, encodeURIComponent(String(cell)));
|
|
6537
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
6538
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
6539
|
+
let baseOptions;
|
|
6540
|
+
if (configuration) {
|
|
6541
|
+
baseOptions = configuration.baseOptions;
|
|
6542
|
+
}
|
|
6543
|
+
|
|
6544
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
6545
|
+
const localVarHeaderParameter = {} as any;
|
|
6546
|
+
const localVarQueryParameter = {} as any;
|
|
6547
|
+
|
|
6548
|
+
// authentication BasicAuth required
|
|
6549
|
+
// http basic authentication required
|
|
6550
|
+
setBasicAuthToObject(localVarRequestOptions, configuration)
|
|
6551
|
+
|
|
6552
|
+
// authentication BearerAuth required
|
|
6553
|
+
// http bearer authentication required
|
|
6554
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
6555
|
+
|
|
6556
|
+
if (inputOffset !== undefined) {
|
|
6557
|
+
localVarQueryParameter['input_offset'] = inputOffset;
|
|
6558
|
+
}
|
|
6559
|
+
|
|
6560
|
+
if (outputOffset !== undefined) {
|
|
6561
|
+
localVarQueryParameter['output_offset'] = outputOffset;
|
|
6562
|
+
}
|
|
6563
|
+
|
|
6564
|
+
|
|
6565
|
+
|
|
6566
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
6567
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
6568
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
6569
|
+
|
|
6570
|
+
return {
|
|
6571
|
+
url: toPathString(localVarUrlObj),
|
|
6572
|
+
options: localVarRequestOptions,
|
|
6573
|
+
};
|
|
6574
|
+
},
|
|
6575
|
+
/**
|
|
6576
|
+
* List all BUS Input/Output descriptions.
|
|
6577
|
+
* @summary List Descriptions
|
|
6578
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
6579
|
+
* @param {*} [options] Override http request option.
|
|
6580
|
+
* @throws {RequiredError}
|
|
6581
|
+
*/
|
|
6582
|
+
listBusIODescriptions: async (cell: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
6583
|
+
// verify required parameter 'cell' is not null or undefined
|
|
6584
|
+
assertParamExists('listBusIODescriptions', 'cell', cell)
|
|
6585
|
+
const localVarPath = `/cells/{cell}/bus-ios/ios/description`
|
|
6586
|
+
.replace(`{${"cell"}}`, encodeURIComponent(String(cell)));
|
|
6587
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
6588
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
6589
|
+
let baseOptions;
|
|
6590
|
+
if (configuration) {
|
|
6591
|
+
baseOptions = configuration.baseOptions;
|
|
6592
|
+
}
|
|
6593
|
+
|
|
6594
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
6595
|
+
const localVarHeaderParameter = {} as any;
|
|
6596
|
+
const localVarQueryParameter = {} as any;
|
|
6597
|
+
|
|
6598
|
+
// authentication BasicAuth required
|
|
6599
|
+
// http basic authentication required
|
|
6600
|
+
setBasicAuthToObject(localVarRequestOptions, configuration)
|
|
6601
|
+
|
|
6602
|
+
// authentication BearerAuth required
|
|
6603
|
+
// http bearer authentication required
|
|
6604
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
6605
|
+
|
|
6606
|
+
|
|
6607
|
+
|
|
6608
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
6609
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
6610
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
6611
|
+
|
|
6612
|
+
return {
|
|
6613
|
+
url: toPathString(localVarUrlObj),
|
|
6614
|
+
options: localVarRequestOptions,
|
|
6615
|
+
};
|
|
6616
|
+
},
|
|
6617
|
+
/**
|
|
6618
|
+
* List all PROFINET input and outputs.
|
|
6619
|
+
* @summary List PROFINET Input/Output Configuration
|
|
6620
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
6621
|
+
* @param {*} [options] Override http request option.
|
|
6622
|
+
* @throws {RequiredError}
|
|
6623
|
+
*/
|
|
6624
|
+
listProfinetIOs: async (cell: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
6625
|
+
// verify required parameter 'cell' is not null or undefined
|
|
6626
|
+
assertParamExists('listProfinetIOs', 'cell', cell)
|
|
6627
|
+
const localVarPath = `/cells/{cell}/bus-ios/profinet/ios`
|
|
6628
|
+
.replace(`{${"cell"}}`, encodeURIComponent(String(cell)));
|
|
6629
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
6630
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
6631
|
+
let baseOptions;
|
|
6632
|
+
if (configuration) {
|
|
6633
|
+
baseOptions = configuration.baseOptions;
|
|
6634
|
+
}
|
|
6635
|
+
|
|
6636
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
6637
|
+
const localVarHeaderParameter = {} as any;
|
|
6638
|
+
const localVarQueryParameter = {} as any;
|
|
6639
|
+
|
|
6640
|
+
// authentication BasicAuth required
|
|
6641
|
+
// http basic authentication required
|
|
6642
|
+
setBasicAuthToObject(localVarRequestOptions, configuration)
|
|
6643
|
+
|
|
6644
|
+
// authentication BearerAuth required
|
|
6645
|
+
// http bearer authentication required
|
|
6646
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
6647
|
+
|
|
6648
|
+
|
|
6649
|
+
|
|
6650
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
6651
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
6652
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
6653
|
+
|
|
6654
|
+
return {
|
|
6655
|
+
url: toPathString(localVarUrlObj),
|
|
6656
|
+
options: localVarRequestOptions,
|
|
6657
|
+
};
|
|
6658
|
+
},
|
|
6659
|
+
/**
|
|
6660
|
+
* 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.
|
|
6661
|
+
* @summary Set Output Values
|
|
6662
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
6663
|
+
* @param {Array<IOValue>} iOValue
|
|
6664
|
+
* @param {*} [options] Override http request option.
|
|
6665
|
+
* @throws {RequiredError}
|
|
6666
|
+
*/
|
|
6667
|
+
setBusIOValues: async (cell: string, iOValue: Array<IOValue>, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
6668
|
+
// verify required parameter 'cell' is not null or undefined
|
|
6669
|
+
assertParamExists('setBusIOValues', 'cell', cell)
|
|
6670
|
+
// verify required parameter 'iOValue' is not null or undefined
|
|
6671
|
+
assertParamExists('setBusIOValues', 'iOValue', iOValue)
|
|
6672
|
+
const localVarPath = `/cells/{cell}/bus-ios/ios/values`
|
|
6673
|
+
.replace(`{${"cell"}}`, encodeURIComponent(String(cell)));
|
|
6674
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
6675
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
6676
|
+
let baseOptions;
|
|
6677
|
+
if (configuration) {
|
|
6678
|
+
baseOptions = configuration.baseOptions;
|
|
6679
|
+
}
|
|
6680
|
+
|
|
6681
|
+
const localVarRequestOptions = { method: 'PUT', ...baseOptions, ...options};
|
|
6682
|
+
const localVarHeaderParameter = {} as any;
|
|
6683
|
+
const localVarQueryParameter = {} as any;
|
|
6684
|
+
|
|
6685
|
+
// authentication BasicAuth required
|
|
6686
|
+
// http basic authentication required
|
|
6687
|
+
setBasicAuthToObject(localVarRequestOptions, configuration)
|
|
6688
|
+
|
|
6689
|
+
// authentication BearerAuth required
|
|
6690
|
+
// http bearer authentication required
|
|
6691
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
6692
|
+
|
|
6693
|
+
|
|
6694
|
+
|
|
6695
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
6696
|
+
|
|
6697
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
6698
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
6699
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
6700
|
+
localVarRequestOptions.data = serializeDataIfNeeded(iOValue, localVarRequestOptions, configuration)
|
|
6701
|
+
|
|
6702
|
+
return {
|
|
6703
|
+
url: toPathString(localVarUrlObj),
|
|
6704
|
+
options: localVarRequestOptions,
|
|
6705
|
+
};
|
|
6706
|
+
},
|
|
6707
|
+
/**
|
|
6708
|
+
* Sets inputs/outputs on the PROFINET device from file.
|
|
6709
|
+
* @summary Set PROFINET Inputs/Outputs from File
|
|
6710
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
6711
|
+
* @param {ProfinetInputOutputConfig} profinetInputOutputConfig
|
|
6712
|
+
* @param {*} [options] Override http request option.
|
|
6713
|
+
* @throws {RequiredError}
|
|
6714
|
+
*/
|
|
6715
|
+
setProfinetIOsFromFile: async (cell: string, profinetInputOutputConfig: ProfinetInputOutputConfig, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
6716
|
+
// verify required parameter 'cell' is not null or undefined
|
|
6717
|
+
assertParamExists('setProfinetIOsFromFile', 'cell', cell)
|
|
6718
|
+
// verify required parameter 'profinetInputOutputConfig' is not null or undefined
|
|
6719
|
+
assertParamExists('setProfinetIOsFromFile', 'profinetInputOutputConfig', profinetInputOutputConfig)
|
|
6720
|
+
const localVarPath = `/cells/{cell}/bus-ios/profinet/iofile`
|
|
6721
|
+
.replace(`{${"cell"}}`, encodeURIComponent(String(cell)));
|
|
6722
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
6723
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
6724
|
+
let baseOptions;
|
|
6725
|
+
if (configuration) {
|
|
6726
|
+
baseOptions = configuration.baseOptions;
|
|
6727
|
+
}
|
|
6728
|
+
|
|
6729
|
+
const localVarRequestOptions = { method: 'PUT', ...baseOptions, ...options};
|
|
6730
|
+
const localVarHeaderParameter = {} as any;
|
|
6731
|
+
const localVarQueryParameter = {} as any;
|
|
6732
|
+
|
|
6733
|
+
// authentication BasicAuth required
|
|
6734
|
+
// http basic authentication required
|
|
6735
|
+
setBasicAuthToObject(localVarRequestOptions, configuration)
|
|
6736
|
+
|
|
6737
|
+
// authentication BearerAuth required
|
|
6738
|
+
// http bearer authentication required
|
|
6739
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
6740
|
+
|
|
6741
|
+
|
|
6742
|
+
|
|
6743
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
6744
|
+
|
|
6745
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
6746
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
6747
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
6748
|
+
localVarRequestOptions.data = serializeDataIfNeeded(profinetInputOutputConfig, localVarRequestOptions, configuration)
|
|
6749
|
+
|
|
6750
|
+
return {
|
|
6751
|
+
url: toPathString(localVarUrlObj),
|
|
6752
|
+
options: localVarRequestOptions,
|
|
6753
|
+
};
|
|
6754
|
+
},
|
|
6755
|
+
}
|
|
6756
|
+
};
|
|
6757
|
+
|
|
6758
|
+
/**
|
|
6759
|
+
* BUSInputsOutputsApi - functional programming interface
|
|
6760
|
+
* @export
|
|
6761
|
+
*/
|
|
6762
|
+
export const BUSInputsOutputsApiFp = function(configuration?: Configuration) {
|
|
6763
|
+
const localVarAxiosParamCreator = BUSInputsOutputsApiAxiosParamCreator(configuration)
|
|
6764
|
+
return {
|
|
6765
|
+
/**
|
|
6766
|
+
* Add a BUS Inputs/Outputs Service to the cell.
|
|
6767
|
+
* @summary Add Service
|
|
6768
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
6769
|
+
* @param {BusIOType} busIOType
|
|
6770
|
+
* @param {number} [completionTimeout]
|
|
6771
|
+
* @param {*} [options] Override http request option.
|
|
6772
|
+
* @throws {RequiredError}
|
|
6773
|
+
*/
|
|
6774
|
+
async addBusIOService(cell: string, busIOType: BusIOType, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> {
|
|
6775
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.addBusIOService(cell, busIOType, completionTimeout, options);
|
|
6776
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
6777
|
+
const localVarOperationServerBasePath = operationServerMap['BUSInputsOutputsApi.addBusIOService']?.[localVarOperationServerIndex]?.url;
|
|
6778
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
6779
|
+
},
|
|
6780
|
+
/**
|
|
6781
|
+
* Adds an input/output to or updates an input/output on the PROFINET device.
|
|
6782
|
+
* @summary Add PROFINET Input/Output
|
|
6783
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
6784
|
+
* @param {string} io Unique identifier to address an Input/Output in the cell.
|
|
6785
|
+
* @param {ProfinetIOData} profinetIOData
|
|
6786
|
+
* @param {*} [options] Override http request option.
|
|
6787
|
+
* @throws {RequiredError}
|
|
6788
|
+
*/
|
|
6789
|
+
async addProfinetIO(cell: string, io: string, profinetIOData: ProfinetIOData, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> {
|
|
6790
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.addProfinetIO(cell, io, profinetIOData, options);
|
|
6791
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
6792
|
+
const localVarOperationServerBasePath = operationServerMap['BUSInputsOutputsApi.addProfinetIO']?.[localVarOperationServerIndex]?.url;
|
|
6793
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
6794
|
+
},
|
|
6795
|
+
/**
|
|
6796
|
+
* Delete BUS Inputs/Outputs Service from the cell.
|
|
6797
|
+
* @summary Clear Service
|
|
6798
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
6799
|
+
* @param {number} [completionTimeout]
|
|
6800
|
+
* @param {*} [options] Override http request option.
|
|
6801
|
+
* @throws {RequiredError}
|
|
6802
|
+
*/
|
|
6803
|
+
async clearBusIOService(cell: string, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> {
|
|
6804
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.clearBusIOService(cell, completionTimeout, options);
|
|
6805
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
6806
|
+
const localVarOperationServerBasePath = operationServerMap['BUSInputsOutputsApi.clearBusIOService']?.[localVarOperationServerIndex]?.url;
|
|
6807
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
6808
|
+
},
|
|
6809
|
+
/**
|
|
6810
|
+
* Removes the input/output from the PROFINET device.
|
|
6811
|
+
* @summary Remove PROFINET Input/Ouptut
|
|
6812
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
6813
|
+
* @param {string} io Unique identifier to address an Input/Output in the cell.
|
|
6814
|
+
* @param {*} [options] Override http request option.
|
|
6815
|
+
* @throws {RequiredError}
|
|
6816
|
+
*/
|
|
6817
|
+
async deleteProfinetIO(cell: string, io: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> {
|
|
6818
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.deleteProfinetIO(cell, io, options);
|
|
6819
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
6820
|
+
const localVarOperationServerBasePath = operationServerMap['BUSInputsOutputsApi.deleteProfinetIO']?.[localVarOperationServerIndex]?.url;
|
|
6821
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
6822
|
+
},
|
|
6823
|
+
/**
|
|
6824
|
+
* Get deployed BUS Inputs/Outputs Service.
|
|
6825
|
+
* @summary Get Service
|
|
6826
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
6827
|
+
* @param {*} [options] Override http request option.
|
|
6828
|
+
* @throws {RequiredError}
|
|
6829
|
+
*/
|
|
6830
|
+
async getBusIOService(cell: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BusIOType>> {
|
|
6831
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.getBusIOService(cell, options);
|
|
6832
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
6833
|
+
const localVarOperationServerBasePath = operationServerMap['BUSInputsOutputsApi.getBusIOService']?.[localVarOperationServerIndex]?.url;
|
|
6834
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
6835
|
+
},
|
|
6836
|
+
/**
|
|
6837
|
+
* Get the current state of the BUS Inputs/Outputs service.
|
|
6838
|
+
* @summary State
|
|
6839
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
6840
|
+
* @param {*} [options] Override http request option.
|
|
6841
|
+
* @throws {RequiredError}
|
|
6842
|
+
*/
|
|
6843
|
+
async getBusIOState(cell: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BusIOsState>> {
|
|
6844
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.getBusIOState(cell, options);
|
|
6845
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
6846
|
+
const localVarOperationServerBasePath = operationServerMap['BUSInputsOutputsApi.getBusIOState']?.[localVarOperationServerIndex]?.url;
|
|
6847
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
6848
|
+
},
|
|
6849
|
+
/**
|
|
6850
|
+
* 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).
|
|
6851
|
+
* @summary Get Input/Output Values
|
|
6852
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
6853
|
+
* @param {Array<string>} [ios]
|
|
6854
|
+
* @param {*} [options] Override http request option.
|
|
6855
|
+
* @throws {RequiredError}
|
|
6856
|
+
*/
|
|
6857
|
+
async getBusIOValues(cell: string, ios?: Array<string>, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<IOValue>>> {
|
|
6858
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.getBusIOValues(cell, ios, options);
|
|
6859
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
6860
|
+
const localVarOperationServerBasePath = operationServerMap['BUSInputsOutputsApi.getBusIOValues']?.[localVarOperationServerIndex]?.url;
|
|
6861
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
6862
|
+
},
|
|
6863
|
+
/**
|
|
6864
|
+
* Get description of PROFINET
|
|
6865
|
+
* @summary Get PROFINET Description
|
|
6866
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
6867
|
+
* @param {*} [options] Override http request option.
|
|
6868
|
+
* @throws {RequiredError}
|
|
6869
|
+
*/
|
|
6870
|
+
async getProfinetDescription(cell: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ProfinetDescription>> {
|
|
6871
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.getProfinetDescription(cell, options);
|
|
6872
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
6873
|
+
const localVarOperationServerBasePath = operationServerMap['BUSInputsOutputsApi.getProfinetDescription']?.[localVarOperationServerIndex]?.url;
|
|
6874
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
6875
|
+
},
|
|
6876
|
+
/**
|
|
6877
|
+
* Get input/output configuration of the PROFINET device as file.
|
|
6878
|
+
* @summary PROFINET Inputs/Outputs to File
|
|
6879
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
6880
|
+
* @param {number} [inputOffset]
|
|
6881
|
+
* @param {number} [outputOffset]
|
|
6882
|
+
* @param {*} [options] Override http request option.
|
|
6883
|
+
* @throws {RequiredError}
|
|
6884
|
+
*/
|
|
6885
|
+
async getProfinetIOsFromFile(cell: string, inputOffset?: number, outputOffset?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<string>> {
|
|
6886
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.getProfinetIOsFromFile(cell, inputOffset, outputOffset, options);
|
|
6887
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
6888
|
+
const localVarOperationServerBasePath = operationServerMap['BUSInputsOutputsApi.getProfinetIOsFromFile']?.[localVarOperationServerIndex]?.url;
|
|
6889
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
6890
|
+
},
|
|
6891
|
+
/**
|
|
6892
|
+
* List all BUS Input/Output descriptions.
|
|
6893
|
+
* @summary List Descriptions
|
|
6894
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
6895
|
+
* @param {*} [options] Override http request option.
|
|
6896
|
+
* @throws {RequiredError}
|
|
6897
|
+
*/
|
|
6898
|
+
async listBusIODescriptions(cell: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<IODescription>>> {
|
|
6899
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.listBusIODescriptions(cell, options);
|
|
6900
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
6901
|
+
const localVarOperationServerBasePath = operationServerMap['BUSInputsOutputsApi.listBusIODescriptions']?.[localVarOperationServerIndex]?.url;
|
|
6902
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
6903
|
+
},
|
|
6904
|
+
/**
|
|
6905
|
+
* List all PROFINET input and outputs.
|
|
6906
|
+
* @summary List PROFINET Input/Output Configuration
|
|
6907
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
6908
|
+
* @param {*} [options] Override http request option.
|
|
6909
|
+
* @throws {RequiredError}
|
|
6910
|
+
*/
|
|
6911
|
+
async listProfinetIOs(cell: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<ProfinetIO>>> {
|
|
6912
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.listProfinetIOs(cell, options);
|
|
6913
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
6914
|
+
const localVarOperationServerBasePath = operationServerMap['BUSInputsOutputsApi.listProfinetIOs']?.[localVarOperationServerIndex]?.url;
|
|
6915
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
6916
|
+
},
|
|
6917
|
+
/**
|
|
6918
|
+
* 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.
|
|
6919
|
+
* @summary Set Output Values
|
|
6920
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
6921
|
+
* @param {Array<IOValue>} iOValue
|
|
6922
|
+
* @param {*} [options] Override http request option.
|
|
6923
|
+
* @throws {RequiredError}
|
|
6924
|
+
*/
|
|
6925
|
+
async setBusIOValues(cell: string, iOValue: Array<IOValue>, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> {
|
|
6926
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.setBusIOValues(cell, iOValue, options);
|
|
6927
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
6928
|
+
const localVarOperationServerBasePath = operationServerMap['BUSInputsOutputsApi.setBusIOValues']?.[localVarOperationServerIndex]?.url;
|
|
6929
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
6930
|
+
},
|
|
6931
|
+
/**
|
|
6932
|
+
* Sets inputs/outputs on the PROFINET device from file.
|
|
6933
|
+
* @summary Set PROFINET Inputs/Outputs from File
|
|
6934
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
6935
|
+
* @param {ProfinetInputOutputConfig} profinetInputOutputConfig
|
|
6936
|
+
* @param {*} [options] Override http request option.
|
|
6937
|
+
* @throws {RequiredError}
|
|
6938
|
+
*/
|
|
6939
|
+
async setProfinetIOsFromFile(cell: string, profinetInputOutputConfig: ProfinetInputOutputConfig, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> {
|
|
6940
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.setProfinetIOsFromFile(cell, profinetInputOutputConfig, options);
|
|
6941
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
6942
|
+
const localVarOperationServerBasePath = operationServerMap['BUSInputsOutputsApi.setProfinetIOsFromFile']?.[localVarOperationServerIndex]?.url;
|
|
6943
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
6944
|
+
},
|
|
6945
|
+
}
|
|
6946
|
+
};
|
|
6947
|
+
|
|
6948
|
+
/**
|
|
6949
|
+
* BUSInputsOutputsApi - factory interface
|
|
6950
|
+
* @export
|
|
6951
|
+
*/
|
|
6952
|
+
export const BUSInputsOutputsApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
|
|
6953
|
+
const localVarFp = BUSInputsOutputsApiFp(configuration)
|
|
6954
|
+
return {
|
|
6955
|
+
/**
|
|
6956
|
+
* Add a BUS Inputs/Outputs Service to the cell.
|
|
6957
|
+
* @summary Add Service
|
|
6958
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
6959
|
+
* @param {BusIOType} busIOType
|
|
6960
|
+
* @param {number} [completionTimeout]
|
|
6961
|
+
* @param {*} [options] Override http request option.
|
|
6962
|
+
* @throws {RequiredError}
|
|
6963
|
+
*/
|
|
6964
|
+
addBusIOService(cell: string, busIOType: BusIOType, completionTimeout?: number, options?: RawAxiosRequestConfig): AxiosPromise<void> {
|
|
6965
|
+
return localVarFp.addBusIOService(cell, busIOType, completionTimeout, options).then((request) => request(axios, basePath));
|
|
6966
|
+
},
|
|
6967
|
+
/**
|
|
6968
|
+
* Adds an input/output to or updates an input/output on the PROFINET device.
|
|
6969
|
+
* @summary Add PROFINET Input/Output
|
|
6970
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
6971
|
+
* @param {string} io Unique identifier to address an Input/Output in the cell.
|
|
6972
|
+
* @param {ProfinetIOData} profinetIOData
|
|
6973
|
+
* @param {*} [options] Override http request option.
|
|
6974
|
+
* @throws {RequiredError}
|
|
6975
|
+
*/
|
|
6976
|
+
addProfinetIO(cell: string, io: string, profinetIOData: ProfinetIOData, options?: RawAxiosRequestConfig): AxiosPromise<void> {
|
|
6977
|
+
return localVarFp.addProfinetIO(cell, io, profinetIOData, options).then((request) => request(axios, basePath));
|
|
6978
|
+
},
|
|
6979
|
+
/**
|
|
6980
|
+
* Delete BUS Inputs/Outputs Service from the cell.
|
|
6981
|
+
* @summary Clear Service
|
|
6982
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
6983
|
+
* @param {number} [completionTimeout]
|
|
6984
|
+
* @param {*} [options] Override http request option.
|
|
6985
|
+
* @throws {RequiredError}
|
|
6986
|
+
*/
|
|
6987
|
+
clearBusIOService(cell: string, completionTimeout?: number, options?: RawAxiosRequestConfig): AxiosPromise<void> {
|
|
6988
|
+
return localVarFp.clearBusIOService(cell, completionTimeout, options).then((request) => request(axios, basePath));
|
|
6989
|
+
},
|
|
6990
|
+
/**
|
|
6991
|
+
* Removes the input/output from the PROFINET device.
|
|
6992
|
+
* @summary Remove PROFINET Input/Ouptut
|
|
6993
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
6994
|
+
* @param {string} io Unique identifier to address an Input/Output in the cell.
|
|
6995
|
+
* @param {*} [options] Override http request option.
|
|
6996
|
+
* @throws {RequiredError}
|
|
6997
|
+
*/
|
|
6998
|
+
deleteProfinetIO(cell: string, io: string, options?: RawAxiosRequestConfig): AxiosPromise<void> {
|
|
6999
|
+
return localVarFp.deleteProfinetIO(cell, io, options).then((request) => request(axios, basePath));
|
|
7000
|
+
},
|
|
7001
|
+
/**
|
|
7002
|
+
* Get deployed BUS Inputs/Outputs Service.
|
|
7003
|
+
* @summary Get Service
|
|
7004
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
7005
|
+
* @param {*} [options] Override http request option.
|
|
7006
|
+
* @throws {RequiredError}
|
|
7007
|
+
*/
|
|
7008
|
+
getBusIOService(cell: string, options?: RawAxiosRequestConfig): AxiosPromise<BusIOType> {
|
|
7009
|
+
return localVarFp.getBusIOService(cell, options).then((request) => request(axios, basePath));
|
|
7010
|
+
},
|
|
7011
|
+
/**
|
|
7012
|
+
* Get the current state of the BUS Inputs/Outputs service.
|
|
7013
|
+
* @summary State
|
|
7014
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
7015
|
+
* @param {*} [options] Override http request option.
|
|
7016
|
+
* @throws {RequiredError}
|
|
7017
|
+
*/
|
|
7018
|
+
getBusIOState(cell: string, options?: RawAxiosRequestConfig): AxiosPromise<BusIOsState> {
|
|
7019
|
+
return localVarFp.getBusIOState(cell, options).then((request) => request(axios, basePath));
|
|
7020
|
+
},
|
|
7021
|
+
/**
|
|
7022
|
+
* 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).
|
|
7023
|
+
* @summary Get Input/Output Values
|
|
7024
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
7025
|
+
* @param {Array<string>} [ios]
|
|
7026
|
+
* @param {*} [options] Override http request option.
|
|
7027
|
+
* @throws {RequiredError}
|
|
7028
|
+
*/
|
|
7029
|
+
getBusIOValues(cell: string, ios?: Array<string>, options?: RawAxiosRequestConfig): AxiosPromise<Array<IOValue>> {
|
|
7030
|
+
return localVarFp.getBusIOValues(cell, ios, options).then((request) => request(axios, basePath));
|
|
7031
|
+
},
|
|
7032
|
+
/**
|
|
7033
|
+
* Get description of PROFINET
|
|
7034
|
+
* @summary Get PROFINET Description
|
|
7035
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
7036
|
+
* @param {*} [options] Override http request option.
|
|
7037
|
+
* @throws {RequiredError}
|
|
7038
|
+
*/
|
|
7039
|
+
getProfinetDescription(cell: string, options?: RawAxiosRequestConfig): AxiosPromise<ProfinetDescription> {
|
|
7040
|
+
return localVarFp.getProfinetDescription(cell, options).then((request) => request(axios, basePath));
|
|
7041
|
+
},
|
|
7042
|
+
/**
|
|
7043
|
+
* Get input/output configuration of the PROFINET device as file.
|
|
7044
|
+
* @summary PROFINET Inputs/Outputs to File
|
|
7045
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
7046
|
+
* @param {number} [inputOffset]
|
|
7047
|
+
* @param {number} [outputOffset]
|
|
7048
|
+
* @param {*} [options] Override http request option.
|
|
7049
|
+
* @throws {RequiredError}
|
|
7050
|
+
*/
|
|
7051
|
+
getProfinetIOsFromFile(cell: string, inputOffset?: number, outputOffset?: number, options?: RawAxiosRequestConfig): AxiosPromise<string> {
|
|
7052
|
+
return localVarFp.getProfinetIOsFromFile(cell, inputOffset, outputOffset, options).then((request) => request(axios, basePath));
|
|
7053
|
+
},
|
|
7054
|
+
/**
|
|
7055
|
+
* List all BUS Input/Output descriptions.
|
|
7056
|
+
* @summary List Descriptions
|
|
7057
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
7058
|
+
* @param {*} [options] Override http request option.
|
|
7059
|
+
* @throws {RequiredError}
|
|
7060
|
+
*/
|
|
7061
|
+
listBusIODescriptions(cell: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<IODescription>> {
|
|
7062
|
+
return localVarFp.listBusIODescriptions(cell, options).then((request) => request(axios, basePath));
|
|
7063
|
+
},
|
|
7064
|
+
/**
|
|
7065
|
+
* List all PROFINET input and outputs.
|
|
7066
|
+
* @summary List PROFINET Input/Output Configuration
|
|
7067
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
7068
|
+
* @param {*} [options] Override http request option.
|
|
7069
|
+
* @throws {RequiredError}
|
|
7070
|
+
*/
|
|
7071
|
+
listProfinetIOs(cell: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<ProfinetIO>> {
|
|
7072
|
+
return localVarFp.listProfinetIOs(cell, options).then((request) => request(axios, basePath));
|
|
7073
|
+
},
|
|
7074
|
+
/**
|
|
7075
|
+
* 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.
|
|
7076
|
+
* @summary Set Output Values
|
|
7077
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
7078
|
+
* @param {Array<IOValue>} iOValue
|
|
7079
|
+
* @param {*} [options] Override http request option.
|
|
7080
|
+
* @throws {RequiredError}
|
|
7081
|
+
*/
|
|
7082
|
+
setBusIOValues(cell: string, iOValue: Array<IOValue>, options?: RawAxiosRequestConfig): AxiosPromise<void> {
|
|
7083
|
+
return localVarFp.setBusIOValues(cell, iOValue, options).then((request) => request(axios, basePath));
|
|
7084
|
+
},
|
|
7085
|
+
/**
|
|
7086
|
+
* Sets inputs/outputs on the PROFINET device from file.
|
|
7087
|
+
* @summary Set PROFINET Inputs/Outputs from File
|
|
7088
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
7089
|
+
* @param {ProfinetInputOutputConfig} profinetInputOutputConfig
|
|
7090
|
+
* @param {*} [options] Override http request option.
|
|
7091
|
+
* @throws {RequiredError}
|
|
7092
|
+
*/
|
|
7093
|
+
setProfinetIOsFromFile(cell: string, profinetInputOutputConfig: ProfinetInputOutputConfig, options?: RawAxiosRequestConfig): AxiosPromise<void> {
|
|
7094
|
+
return localVarFp.setProfinetIOsFromFile(cell, profinetInputOutputConfig, options).then((request) => request(axios, basePath));
|
|
7095
|
+
},
|
|
7096
|
+
};
|
|
7097
|
+
};
|
|
7098
|
+
|
|
7099
|
+
/**
|
|
7100
|
+
* BUSInputsOutputsApi - object-oriented interface
|
|
7101
|
+
* @export
|
|
7102
|
+
* @class BUSInputsOutputsApi
|
|
7103
|
+
* @extends {BaseAPI}
|
|
7104
|
+
*/
|
|
7105
|
+
export class BUSInputsOutputsApi extends BaseAPI {
|
|
7106
|
+
/**
|
|
7107
|
+
* Add a BUS Inputs/Outputs Service to the cell.
|
|
7108
|
+
* @summary Add Service
|
|
7109
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
7110
|
+
* @param {BusIOType} busIOType
|
|
7111
|
+
* @param {number} [completionTimeout]
|
|
7112
|
+
* @param {*} [options] Override http request option.
|
|
7113
|
+
* @throws {RequiredError}
|
|
7114
|
+
* @memberof BUSInputsOutputsApi
|
|
7115
|
+
*/
|
|
7116
|
+
public addBusIOService(cell: string, busIOType: BusIOType, completionTimeout?: number, options?: RawAxiosRequestConfig) {
|
|
7117
|
+
return BUSInputsOutputsApiFp(this.configuration).addBusIOService(cell, busIOType, completionTimeout, options).then((request) => request(this.axios, this.basePath));
|
|
7118
|
+
}
|
|
7119
|
+
|
|
7120
|
+
/**
|
|
7121
|
+
* Adds an input/output to or updates an input/output on the PROFINET device.
|
|
7122
|
+
* @summary Add PROFINET Input/Output
|
|
7123
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
7124
|
+
* @param {string} io Unique identifier to address an Input/Output in the cell.
|
|
7125
|
+
* @param {ProfinetIOData} profinetIOData
|
|
7126
|
+
* @param {*} [options] Override http request option.
|
|
7127
|
+
* @throws {RequiredError}
|
|
7128
|
+
* @memberof BUSInputsOutputsApi
|
|
7129
|
+
*/
|
|
7130
|
+
public addProfinetIO(cell: string, io: string, profinetIOData: ProfinetIOData, options?: RawAxiosRequestConfig) {
|
|
7131
|
+
return BUSInputsOutputsApiFp(this.configuration).addProfinetIO(cell, io, profinetIOData, options).then((request) => request(this.axios, this.basePath));
|
|
7132
|
+
}
|
|
7133
|
+
|
|
7134
|
+
/**
|
|
7135
|
+
* Delete BUS Inputs/Outputs Service from the cell.
|
|
7136
|
+
* @summary Clear Service
|
|
7137
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
7138
|
+
* @param {number} [completionTimeout]
|
|
7139
|
+
* @param {*} [options] Override http request option.
|
|
7140
|
+
* @throws {RequiredError}
|
|
7141
|
+
* @memberof BUSInputsOutputsApi
|
|
7142
|
+
*/
|
|
7143
|
+
public clearBusIOService(cell: string, completionTimeout?: number, options?: RawAxiosRequestConfig) {
|
|
7144
|
+
return BUSInputsOutputsApiFp(this.configuration).clearBusIOService(cell, completionTimeout, options).then((request) => request(this.axios, this.basePath));
|
|
7145
|
+
}
|
|
7146
|
+
|
|
7147
|
+
/**
|
|
7148
|
+
* Removes the input/output from the PROFINET device.
|
|
7149
|
+
* @summary Remove PROFINET Input/Ouptut
|
|
7150
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
7151
|
+
* @param {string} io Unique identifier to address an Input/Output in the cell.
|
|
7152
|
+
* @param {*} [options] Override http request option.
|
|
7153
|
+
* @throws {RequiredError}
|
|
7154
|
+
* @memberof BUSInputsOutputsApi
|
|
7155
|
+
*/
|
|
7156
|
+
public deleteProfinetIO(cell: string, io: string, options?: RawAxiosRequestConfig) {
|
|
7157
|
+
return BUSInputsOutputsApiFp(this.configuration).deleteProfinetIO(cell, io, options).then((request) => request(this.axios, this.basePath));
|
|
7158
|
+
}
|
|
7159
|
+
|
|
7160
|
+
/**
|
|
7161
|
+
* Get deployed BUS Inputs/Outputs Service.
|
|
7162
|
+
* @summary Get Service
|
|
7163
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
7164
|
+
* @param {*} [options] Override http request option.
|
|
7165
|
+
* @throws {RequiredError}
|
|
7166
|
+
* @memberof BUSInputsOutputsApi
|
|
7167
|
+
*/
|
|
7168
|
+
public getBusIOService(cell: string, options?: RawAxiosRequestConfig) {
|
|
7169
|
+
return BUSInputsOutputsApiFp(this.configuration).getBusIOService(cell, options).then((request) => request(this.axios, this.basePath));
|
|
7170
|
+
}
|
|
7171
|
+
|
|
7172
|
+
/**
|
|
7173
|
+
* Get the current state of the BUS Inputs/Outputs service.
|
|
7174
|
+
* @summary State
|
|
7175
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
7176
|
+
* @param {*} [options] Override http request option.
|
|
7177
|
+
* @throws {RequiredError}
|
|
7178
|
+
* @memberof BUSInputsOutputsApi
|
|
7179
|
+
*/
|
|
7180
|
+
public getBusIOState(cell: string, options?: RawAxiosRequestConfig) {
|
|
7181
|
+
return BUSInputsOutputsApiFp(this.configuration).getBusIOState(cell, options).then((request) => request(this.axios, this.basePath));
|
|
7182
|
+
}
|
|
7183
|
+
|
|
7184
|
+
/**
|
|
7185
|
+
* 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).
|
|
7186
|
+
* @summary Get Input/Output Values
|
|
7187
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
7188
|
+
* @param {Array<string>} [ios]
|
|
7189
|
+
* @param {*} [options] Override http request option.
|
|
7190
|
+
* @throws {RequiredError}
|
|
7191
|
+
* @memberof BUSInputsOutputsApi
|
|
7192
|
+
*/
|
|
7193
|
+
public getBusIOValues(cell: string, ios?: Array<string>, options?: RawAxiosRequestConfig) {
|
|
7194
|
+
return BUSInputsOutputsApiFp(this.configuration).getBusIOValues(cell, ios, options).then((request) => request(this.axios, this.basePath));
|
|
7195
|
+
}
|
|
7196
|
+
|
|
7197
|
+
/**
|
|
7198
|
+
* Get description of PROFINET
|
|
7199
|
+
* @summary Get PROFINET Description
|
|
7200
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
7201
|
+
* @param {*} [options] Override http request option.
|
|
7202
|
+
* @throws {RequiredError}
|
|
7203
|
+
* @memberof BUSInputsOutputsApi
|
|
7204
|
+
*/
|
|
7205
|
+
public getProfinetDescription(cell: string, options?: RawAxiosRequestConfig) {
|
|
7206
|
+
return BUSInputsOutputsApiFp(this.configuration).getProfinetDescription(cell, options).then((request) => request(this.axios, this.basePath));
|
|
7207
|
+
}
|
|
7208
|
+
|
|
7209
|
+
/**
|
|
7210
|
+
* Get input/output configuration of the PROFINET device as file.
|
|
7211
|
+
* @summary PROFINET Inputs/Outputs to File
|
|
7212
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
7213
|
+
* @param {number} [inputOffset]
|
|
7214
|
+
* @param {number} [outputOffset]
|
|
7215
|
+
* @param {*} [options] Override http request option.
|
|
7216
|
+
* @throws {RequiredError}
|
|
7217
|
+
* @memberof BUSInputsOutputsApi
|
|
7218
|
+
*/
|
|
7219
|
+
public getProfinetIOsFromFile(cell: string, inputOffset?: number, outputOffset?: number, options?: RawAxiosRequestConfig) {
|
|
7220
|
+
return BUSInputsOutputsApiFp(this.configuration).getProfinetIOsFromFile(cell, inputOffset, outputOffset, options).then((request) => request(this.axios, this.basePath));
|
|
7221
|
+
}
|
|
7222
|
+
|
|
7223
|
+
/**
|
|
7224
|
+
* List all BUS Input/Output descriptions.
|
|
7225
|
+
* @summary List Descriptions
|
|
7226
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
7227
|
+
* @param {*} [options] Override http request option.
|
|
7228
|
+
* @throws {RequiredError}
|
|
7229
|
+
* @memberof BUSInputsOutputsApi
|
|
7230
|
+
*/
|
|
7231
|
+
public listBusIODescriptions(cell: string, options?: RawAxiosRequestConfig) {
|
|
7232
|
+
return BUSInputsOutputsApiFp(this.configuration).listBusIODescriptions(cell, options).then((request) => request(this.axios, this.basePath));
|
|
7233
|
+
}
|
|
7234
|
+
|
|
7235
|
+
/**
|
|
7236
|
+
* List all PROFINET input and outputs.
|
|
7237
|
+
* @summary List PROFINET Input/Output Configuration
|
|
7238
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
7239
|
+
* @param {*} [options] Override http request option.
|
|
7240
|
+
* @throws {RequiredError}
|
|
7241
|
+
* @memberof BUSInputsOutputsApi
|
|
7242
|
+
*/
|
|
7243
|
+
public listProfinetIOs(cell: string, options?: RawAxiosRequestConfig) {
|
|
7244
|
+
return BUSInputsOutputsApiFp(this.configuration).listProfinetIOs(cell, options).then((request) => request(this.axios, this.basePath));
|
|
7245
|
+
}
|
|
7246
|
+
|
|
7247
|
+
/**
|
|
7248
|
+
* 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.
|
|
7249
|
+
* @summary Set Output Values
|
|
7250
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
7251
|
+
* @param {Array<IOValue>} iOValue
|
|
7252
|
+
* @param {*} [options] Override http request option.
|
|
7253
|
+
* @throws {RequiredError}
|
|
7254
|
+
* @memberof BUSInputsOutputsApi
|
|
7255
|
+
*/
|
|
7256
|
+
public setBusIOValues(cell: string, iOValue: Array<IOValue>, options?: RawAxiosRequestConfig) {
|
|
7257
|
+
return BUSInputsOutputsApiFp(this.configuration).setBusIOValues(cell, iOValue, options).then((request) => request(this.axios, this.basePath));
|
|
7258
|
+
}
|
|
7259
|
+
|
|
7260
|
+
/**
|
|
7261
|
+
* Sets inputs/outputs on the PROFINET device from file.
|
|
7262
|
+
* @summary Set PROFINET Inputs/Outputs from File
|
|
7263
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
7264
|
+
* @param {ProfinetInputOutputConfig} profinetInputOutputConfig
|
|
7265
|
+
* @param {*} [options] Override http request option.
|
|
7266
|
+
* @throws {RequiredError}
|
|
7267
|
+
* @memberof BUSInputsOutputsApi
|
|
7268
|
+
*/
|
|
7269
|
+
public setProfinetIOsFromFile(cell: string, profinetInputOutputConfig: ProfinetInputOutputConfig, options?: RawAxiosRequestConfig) {
|
|
7270
|
+
return BUSInputsOutputsApiFp(this.configuration).setProfinetIOsFromFile(cell, profinetInputOutputConfig, options).then((request) => request(this.axios, this.basePath));
|
|
7271
|
+
}
|
|
7272
|
+
}
|
|
7273
|
+
|
|
7274
|
+
|
|
7275
|
+
|
|
5750
7276
|
/**
|
|
5751
7277
|
* CellApi - axios parameter creator
|
|
5752
7278
|
* @export
|