@wandelbots/nova-api 25.7.0-rc.2 → 25.8.0-dev.10

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/v2/api.d.ts CHANGED
@@ -341,6 +341,173 @@ export declare const BoxBoxTypeEnum: {
341
341
  readonly Full: "FULL";
342
342
  };
343
343
  export type BoxBoxTypeEnum = typeof BoxBoxTypeEnum[keyof typeof BoxBoxTypeEnum];
344
+ /**
345
+ * PROFINET BUS Inputs/Outputs Service configuration.
346
+ * @export
347
+ * @interface BusIOProfinet
348
+ */
349
+ export interface BusIOProfinet {
350
+ /**
351
+ *
352
+ * @type {string}
353
+ * @memberof BusIOProfinet
354
+ */
355
+ 'bus_type'?: BusIOProfinetBusTypeEnum;
356
+ /**
357
+ * Path to the configuration file.
358
+ * @type {string}
359
+ * @memberof BusIOProfinet
360
+ */
361
+ 'config_file_content'?: string;
362
+ /**
363
+ *
364
+ * @type {BusIOProfinetNetwork}
365
+ * @memberof BusIOProfinet
366
+ */
367
+ 'network_config'?: BusIOProfinetNetwork;
368
+ /**
369
+ * MAC address for the PROFINET port, should be get from another NOVA API endpoind?
370
+ * @type {string}
371
+ * @memberof BusIOProfinet
372
+ */
373
+ 'mac': string;
374
+ /**
375
+ *
376
+ * @type {BusIOProfinetDefaultRoute}
377
+ * @memberof BusIOProfinet
378
+ */
379
+ 'default_route': BusIOProfinetDefaultRoute;
380
+ }
381
+ export declare const BusIOProfinetBusTypeEnum: {
382
+ readonly Profinet: "profinet";
383
+ };
384
+ export type BusIOProfinetBusTypeEnum = typeof BusIOProfinetBusTypeEnum[keyof typeof BusIOProfinetBusTypeEnum];
385
+ /**
386
+ * Default route configuration for the PROFINET service. Will be removed before release by automatic default route configuration, if possible.
387
+ * @export
388
+ * @interface BusIOProfinetDefaultRoute
389
+ */
390
+ export interface BusIOProfinetDefaultRoute {
391
+ /**
392
+ * Gateway for the default route.
393
+ * @type {string}
394
+ * @memberof BusIOProfinetDefaultRoute
395
+ */
396
+ 'gateway': string;
397
+ /**
398
+ * Interface for the default route.
399
+ * @type {string}
400
+ * @memberof BusIOProfinetDefaultRoute
401
+ */
402
+ 'interface': string;
403
+ }
404
+ /**
405
+ * Network configuration for the PROFINET device
406
+ * @export
407
+ * @interface BusIOProfinetIpConfig
408
+ */
409
+ export interface BusIOProfinetIpConfig {
410
+ /**
411
+ * IP address for the PROFINET device
412
+ * @type {string}
413
+ * @memberof BusIOProfinetIpConfig
414
+ */
415
+ 'ip': string;
416
+ /**
417
+ * Network mask for the PROFINET device.
418
+ * @type {string}
419
+ * @memberof BusIOProfinetIpConfig
420
+ */
421
+ 'netmask': string;
422
+ /**
423
+ * Gateway for the PROFINET device
424
+ * @type {string}
425
+ * @memberof BusIOProfinetIpConfig
426
+ */
427
+ 'gateway': string;
428
+ }
429
+ /**
430
+ *
431
+ * @export
432
+ * @interface BusIOProfinetNetwork
433
+ */
434
+ export interface BusIOProfinetNetwork {
435
+ /**
436
+ * Name of the PROFINET device.
437
+ * @type {string}
438
+ * @memberof BusIOProfinetNetwork
439
+ */
440
+ 'device_name'?: string;
441
+ /**
442
+ *
443
+ * @type {BusIOProfinetIpConfig}
444
+ * @memberof BusIOProfinetNetwork
445
+ */
446
+ 'ip_config'?: BusIOProfinetIpConfig;
447
+ /**
448
+ * Content of the PROFINET REMA XML file.
449
+ * @type {string}
450
+ * @memberof BusIOProfinetNetwork
451
+ */
452
+ 'rema_xml_content'?: string;
453
+ }
454
+ /**
455
+ * Virtual PROFINET BUS Inputs/Outputs Service configuration.
456
+ * @export
457
+ * @interface BusIOProfinetVirtual
458
+ */
459
+ export interface BusIOProfinetVirtual {
460
+ /**
461
+ *
462
+ * @type {string}
463
+ * @memberof BusIOProfinetVirtual
464
+ */
465
+ 'bus_type'?: BusIOProfinetVirtualBusTypeEnum;
466
+ }
467
+ export declare const BusIOProfinetVirtualBusTypeEnum: {
468
+ readonly VirtualProfinet: "virtual_profinet";
469
+ };
470
+ export type BusIOProfinetVirtualBusTypeEnum = typeof BusIOProfinetVirtualBusTypeEnum[keyof typeof BusIOProfinetVirtualBusTypeEnum];
471
+ /**
472
+ * @type BusIOType
473
+ * @export
474
+ */
475
+ export type BusIOType = {
476
+ bus_type: 'profinet';
477
+ } & BusIOProfinet | {
478
+ bus_type: 'profinet_virtual';
479
+ } & BusIOProfinetVirtual;
480
+ /**
481
+ *
482
+ * @export
483
+ * @interface BusIOsState
484
+ */
485
+ export interface BusIOsState {
486
+ /**
487
+ *
488
+ * @type {BusIOsStateEnum}
489
+ * @memberof BusIOsState
490
+ */
491
+ 'state': BusIOsStateEnum;
492
+ /**
493
+ * 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.
494
+ * @type {string}
495
+ * @memberof BusIOsState
496
+ */
497
+ 'message'?: string;
498
+ }
499
+ /**
500
+ * Current state of the BUS input/output service.
501
+ * @export
502
+ * @enum {string}
503
+ */
504
+ export declare const BusIOsStateEnum: {
505
+ readonly BusIosStateUnknown: "BUS_IOS_STATE_UNKNOWN";
506
+ readonly BusIosStateInitializing: "BUS_IOS_STATE_INITIALIZING";
507
+ readonly BusIosStateConnected: "BUS_IOS_STATE_CONNECTED";
508
+ readonly BusIosStateDisconnected: "BUS_IOS_STATE_DISCONNECTED";
509
+ };
510
+ export type BusIOsStateEnum = typeof BusIOsStateEnum[keyof typeof BusIOsStateEnum];
344
511
  /**
345
512
  * Defines a cylindrical shape with 2 semi-spheres on the top and bottom. Centred around origin, symmetric around z-axis.
346
513
  * @export
@@ -2146,9 +2313,19 @@ export type JoggingDetailsKindEnum = typeof JoggingDetailsKindEnum[keyof typeof
2146
2313
  * @type JoggingDetailsState
2147
2314
  * @export
2148
2315
  */
2149
- export type JoggingDetailsState = JoggingPausedByUser | JoggingPausedNearCollision | JoggingPausedNearJointLimit | JoggingPausedOnIO | JoggingRunning;
2316
+ export type JoggingDetailsState = {
2317
+ kind: 'PAUSED_BY_USER';
2318
+ } & JoggingPausedByUser | {
2319
+ kind: 'PAUSED_NEAR_COLLISION';
2320
+ } & JoggingPausedNearCollision | {
2321
+ kind: 'PAUSED_NEAR_JOINT_LIMIT';
2322
+ } & JoggingPausedNearJointLimit | {
2323
+ kind: 'PAUSED_ON_IO';
2324
+ } & JoggingPausedOnIO | {
2325
+ kind: 'RUNNING';
2326
+ } & JoggingRunning;
2150
2327
  /**
2151
- *
2328
+ * User has paused jogging.
2152
2329
  * @export
2153
2330
  * @interface JoggingPausedByUser
2154
2331
  */
@@ -2165,7 +2342,7 @@ export declare const JoggingPausedByUserKindEnum: {
2165
2342
  };
2166
2343
  export type JoggingPausedByUserKindEnum = typeof JoggingPausedByUserKindEnum[keyof typeof JoggingPausedByUserKindEnum];
2167
2344
  /**
2168
- *
2345
+ * Jogging was paused because the motion group neared a collision.
2169
2346
  * @export
2170
2347
  * @interface JoggingPausedNearCollision
2171
2348
  */
@@ -2188,7 +2365,7 @@ export declare const JoggingPausedNearCollisionKindEnum: {
2188
2365
  };
2189
2366
  export type JoggingPausedNearCollisionKindEnum = typeof JoggingPausedNearCollisionKindEnum[keyof typeof JoggingPausedNearCollisionKindEnum];
2190
2367
  /**
2191
- *
2368
+ * Jogging was paused because a joint is near its limit.
2192
2369
  * @export
2193
2370
  * @interface JoggingPausedNearJointLimit
2194
2371
  */
@@ -2211,7 +2388,7 @@ export declare const JoggingPausedNearJointLimitKindEnum: {
2211
2388
  };
2212
2389
  export type JoggingPausedNearJointLimitKindEnum = typeof JoggingPausedNearJointLimitKindEnum[keyof typeof JoggingPausedNearJointLimitKindEnum];
2213
2390
  /**
2214
- *
2391
+ * Jogging was paused because of an I/O event.
2215
2392
  * @export
2216
2393
  * @interface JoggingPausedOnIO
2217
2394
  */
@@ -2228,7 +2405,7 @@ export declare const JoggingPausedOnIOKindEnum: {
2228
2405
  };
2229
2406
  export type JoggingPausedOnIOKindEnum = typeof JoggingPausedOnIOKindEnum[keyof typeof JoggingPausedOnIOKindEnum];
2230
2407
  /**
2231
- *
2408
+ * Jogging is active.
2232
2409
  * @export
2233
2410
  * @interface JoggingRunning
2234
2411
  */
@@ -2296,10 +2473,10 @@ export interface JointLimits {
2296
2473
  export interface JointTrajectory {
2297
2474
  /**
2298
2475
  * List of joint positions [rad] for each sample. The number of samples must match the number of timestamps provided in the times field.
2299
- * @type {Array<Joints>}
2476
+ * @type {Array<Array<number>>}
2300
2477
  * @memberof JointTrajectory
2301
2478
  */
2302
- 'joint_positions': Array<Joints>;
2479
+ 'joint_positions': Array<Array<number>>;
2303
2480
  /**
2304
2481
  * Timestamp for each sample [s].
2305
2482
  * @type {Array<number>}
@@ -2326,11 +2503,11 @@ export interface JointVelocityRequest {
2326
2503
  */
2327
2504
  'message_type'?: JointVelocityRequestMessageTypeEnum;
2328
2505
  /**
2329
- * in [rad/s]
2330
- * @type {Joints}
2506
+ * This structure describes a set of joint values (e.g. positions, currents, torques) of a motion group. Float precision is the default.
2507
+ * @type {Array<number>}
2331
2508
  * @memberof JointVelocityRequest
2332
2509
  */
2333
- 'velocity': Joints;
2510
+ 'velocity': Array<number>;
2334
2511
  }
2335
2512
  export declare const JointVelocityRequestMessageTypeEnum: {
2336
2513
  readonly JointVelocityRequest: "JointVelocityRequest";
@@ -2359,19 +2536,6 @@ export declare const JointVelocityResponseKindEnum: {
2359
2536
  readonly JointVelocityReceived: "JOINT_VELOCITY_RECEIVED";
2360
2537
  };
2361
2538
  export type JointVelocityResponseKindEnum = typeof JointVelocityResponseKindEnum[keyof typeof JointVelocityResponseKindEnum];
2362
- /**
2363
- * 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.
2364
- * @export
2365
- * @interface Joints
2366
- */
2367
- export interface Joints {
2368
- /**
2369
- *
2370
- * @type {Array<number>}
2371
- * @memberof Joints
2372
- */
2373
- 'joints': Array<number>;
2374
- }
2375
2539
  /**
2376
2540
  * 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.
2377
2541
  * @export
@@ -2960,11 +3124,11 @@ export interface MotionGroupState {
2960
3124
  */
2961
3125
  'controller': string;
2962
3126
  /**
2963
- * Current joint position of each joint in [rad]
2964
- * @type {Joints}
3127
+ * This structure describes a set of joint values (e.g. positions, currents, torques) of a motion group. Float precision is the default.
3128
+ * @type {Array<number>}
2965
3129
  * @memberof MotionGroupState
2966
3130
  */
2967
- 'joint_position': Joints;
3131
+ 'joint_position': Array<number>;
2968
3132
  /**
2969
3133
  * Indicates whether the joint is in a limit for all joints of the motion group.
2970
3134
  * @type {MotionGroupStateJointLimitReached}
@@ -2972,17 +3136,17 @@ export interface MotionGroupState {
2972
3136
  */
2973
3137
  'joint_limit_reached': MotionGroupStateJointLimitReached;
2974
3138
  /**
2975
- * Current joint torque of each joint in [Nm]. Is only available if the robot controller supports it, e.g. available for UR controllers.
2976
- * @type {Joints}
3139
+ * This structure describes a set of joint values (e.g. positions, currents, torques) of a motion group. Float precision is the default.
3140
+ * @type {Array<number>}
2977
3141
  * @memberof MotionGroupState
2978
3142
  */
2979
- 'joint_torque'?: Joints;
3143
+ 'joint_torque'?: Array<number>;
2980
3144
  /**
2981
- * Current at TCP in [A]. Is only available if the robot controller supports it, e.g. available for UR controllers.
2982
- * @type {Joints}
3145
+ * This structure describes a set of joint values (e.g. positions, currents, torques) of a motion group. Float precision is the default.
3146
+ * @type {Array<number>}
2983
3147
  * @memberof MotionGroupState
2984
3148
  */
2985
- 'joint_current'?: Joints;
3149
+ 'joint_current'?: Array<number>;
2986
3150
  /**
2987
3151
  * 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.
2988
3152
  * @type {Pose}
@@ -3726,6 +3890,227 @@ export interface Pose {
3726
3890
  */
3727
3891
  'orientation'?: Array<number>;
3728
3892
  }
3893
+ /**
3894
+ *
3895
+ * @export
3896
+ * @interface ProfinetDescription
3897
+ */
3898
+ export interface ProfinetDescription {
3899
+ /**
3900
+ * The vendor identifier of the PROFINET device, identifying the manufacturer.
3901
+ * @type {string}
3902
+ * @memberof ProfinetDescription
3903
+ */
3904
+ 'vendor_id': string;
3905
+ /**
3906
+ * The device identifier of the PROFINET device, identifying the specific device within the vendor\'s range.
3907
+ * @type {string}
3908
+ * @memberof ProfinetDescription
3909
+ */
3910
+ 'device_id': string;
3911
+ /**
3912
+ *
3913
+ * @type {Array<ProfinetSlotDescription>}
3914
+ * @memberof ProfinetDescription
3915
+ */
3916
+ 'slots'?: Array<ProfinetSlotDescription>;
3917
+ /**
3918
+ * Name of the PROFINET device
3919
+ * @type {string}
3920
+ * @memberof ProfinetDescription
3921
+ */
3922
+ 'device_name'?: string;
3923
+ /**
3924
+ * IP address for the PROFINET device
3925
+ * @type {string}
3926
+ * @memberof ProfinetDescription
3927
+ */
3928
+ 'ip'?: string;
3929
+ }
3930
+ /**
3931
+ *
3932
+ * @export
3933
+ * @interface ProfinetIO
3934
+ */
3935
+ export interface ProfinetIO {
3936
+ /**
3937
+ * 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.
3938
+ * @type {string}
3939
+ * @memberof ProfinetIO
3940
+ */
3941
+ 'name': string;
3942
+ /**
3943
+ *
3944
+ * @type {ProfinetIOTypeEnum}
3945
+ * @memberof ProfinetIO
3946
+ */
3947
+ 'type': ProfinetIOTypeEnum;
3948
+ /**
3949
+ * The direction of the input/output value, indicating whether it is an input or output for the device.
3950
+ * @type {ProfinetIODirection}
3951
+ * @memberof ProfinetIO
3952
+ */
3953
+ 'direction': ProfinetIODirection;
3954
+ /**
3955
+ * 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.
3956
+ * @type {number}
3957
+ * @memberof ProfinetIO
3958
+ */
3959
+ 'byte_address': number;
3960
+ /**
3961
+ * 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.
3962
+ * @type {number}
3963
+ * @memberof ProfinetIO
3964
+ */
3965
+ 'bit_address'?: number;
3966
+ /**
3967
+ * The unique identifier for the input/output value. This identifier is used to reference the specific input/output in the NOVA system.
3968
+ * @type {string}
3969
+ * @memberof ProfinetIO
3970
+ */
3971
+ 'io': string;
3972
+ }
3973
+ /**
3974
+ *
3975
+ * @export
3976
+ * @interface ProfinetIOData
3977
+ */
3978
+ export interface ProfinetIOData {
3979
+ /**
3980
+ * 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.
3981
+ * @type {string}
3982
+ * @memberof ProfinetIOData
3983
+ */
3984
+ 'name': string;
3985
+ /**
3986
+ *
3987
+ * @type {ProfinetIOTypeEnum}
3988
+ * @memberof ProfinetIOData
3989
+ */
3990
+ 'type': ProfinetIOTypeEnum;
3991
+ /**
3992
+ * The direction of the input/output value, indicating whether it is an input or output for the device.
3993
+ * @type {ProfinetIODirection}
3994
+ * @memberof ProfinetIOData
3995
+ */
3996
+ 'direction': ProfinetIODirection;
3997
+ /**
3998
+ * 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.
3999
+ * @type {number}
4000
+ * @memberof ProfinetIOData
4001
+ */
4002
+ 'byte_address': number;
4003
+ /**
4004
+ * 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.
4005
+ * @type {number}
4006
+ * @memberof ProfinetIOData
4007
+ */
4008
+ 'bit_address'?: number;
4009
+ }
4010
+ /**
4011
+ * Identifies the input/output type.
4012
+ * @export
4013
+ * @enum {string}
4014
+ */
4015
+ export declare const ProfinetIODirection: {
4016
+ readonly ProfinetIoDirectionInput: "PROFINET_IO_DIRECTION_INPUT";
4017
+ readonly ProfinetIoDirectionOutput: "PROFINET_IO_DIRECTION_OUTPUT";
4018
+ readonly ProfinetIoDirectionInout: "PROFINET_IO_DIRECTION_INOUT";
4019
+ };
4020
+ export type ProfinetIODirection = typeof ProfinetIODirection[keyof typeof ProfinetIODirection];
4021
+ /**
4022
+ * Value type of the PROFINET input/output.
4023
+ * @export
4024
+ * @enum {string}
4025
+ */
4026
+ export declare const ProfinetIOTypeEnum: {
4027
+ readonly ProfinetIoTypeUnknown: "PROFINET_IO_TYPE_UNKNOWN";
4028
+ readonly ProfinetIoTypeBool: "PROFINET_IO_TYPE_BOOL";
4029
+ readonly ProfinetIoTypeUsint: "PROFINET_IO_TYPE_USINT";
4030
+ readonly ProfinetIoTypeSint: "PROFINET_IO_TYPE_SINT";
4031
+ readonly ProfinetIoTypeUint: "PROFINET_IO_TYPE_UINT";
4032
+ readonly ProfinetIoTypeInt: "PROFINET_IO_TYPE_INT";
4033
+ readonly ProfinetIoTypeUdint: "PROFINET_IO_TYPE_UDINT";
4034
+ readonly ProfinetIoTypeDint: "PROFINET_IO_TYPE_DINT";
4035
+ readonly ProfinetIoTypeReal: "PROFINET_IO_TYPE_REAL";
4036
+ readonly ProfinetIoTypeLreal: "PROFINET_IO_TYPE_LREAL";
4037
+ };
4038
+ export type ProfinetIOTypeEnum = typeof ProfinetIOTypeEnum[keyof typeof ProfinetIOTypeEnum];
4039
+ /**
4040
+ *
4041
+ * @export
4042
+ * @interface ProfinetInputOutputConfig
4043
+ */
4044
+ export interface ProfinetInputOutputConfig {
4045
+ /**
4046
+ * Content of the input output configuration file.
4047
+ * @type {string}
4048
+ * @memberof ProfinetInputOutputConfig
4049
+ */
4050
+ 'config': string;
4051
+ /**
4052
+ * Offset in bytes for the input data.
4053
+ * @type {number}
4054
+ * @memberof ProfinetInputOutputConfig
4055
+ */
4056
+ 'input_offset': number;
4057
+ /**
4058
+ * Offset in bytes for the output data.
4059
+ * @type {number}
4060
+ * @memberof ProfinetInputOutputConfig
4061
+ */
4062
+ 'output_offset': number;
4063
+ }
4064
+ /**
4065
+ *
4066
+ * @export
4067
+ * @interface ProfinetSlotDescription
4068
+ */
4069
+ export interface ProfinetSlotDescription {
4070
+ /**
4071
+ * The number of the PROFINET slot.
4072
+ * @type {number}
4073
+ * @memberof ProfinetSlotDescription
4074
+ */
4075
+ 'number': number;
4076
+ /**
4077
+ * The API number of the PROFINET input, used to identify the specific API for the input.
4078
+ * @type {number}
4079
+ * @memberof ProfinetSlotDescription
4080
+ */
4081
+ 'api': number;
4082
+ /**
4083
+ * An array of PROFINET subslots.
4084
+ * @type {Array<ProfinetSubSlotDescription>}
4085
+ * @memberof ProfinetSlotDescription
4086
+ */
4087
+ 'subslots': Array<ProfinetSubSlotDescription>;
4088
+ }
4089
+ /**
4090
+ *
4091
+ * @export
4092
+ * @interface ProfinetSubSlotDescription
4093
+ */
4094
+ export interface ProfinetSubSlotDescription {
4095
+ /**
4096
+ * The identifier of the PROFINET subslot.
4097
+ * @type {number}
4098
+ * @memberof ProfinetSubSlotDescription
4099
+ */
4100
+ 'number': number;
4101
+ /**
4102
+ * The length in bytes of the PROFINET input.
4103
+ * @type {number}
4104
+ * @memberof ProfinetSubSlotDescription
4105
+ */
4106
+ 'input_length': number;
4107
+ /**
4108
+ * The length in bytes of the PROFINET output.
4109
+ * @type {number}
4110
+ * @memberof ProfinetSubSlotDescription
4111
+ */
4112
+ 'output_length': number;
4113
+ }
3729
4114
  /**
3730
4115
  * <!-- 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.
3731
4116
  * @export
@@ -4475,9 +4860,19 @@ export type TrajectoryDetailsKindEnum = typeof TrajectoryDetailsKindEnum[keyof t
4475
4860
  * @type TrajectoryDetailsState
4476
4861
  * @export
4477
4862
  */
4478
- export type TrajectoryDetailsState = TrajectoryEnded | TrajectoryPausedByUser | TrajectoryPausedOnIO | TrajectoryRunning | TrajectoryWaitForIO;
4863
+ export type TrajectoryDetailsState = {
4864
+ kind: 'END_OF_TRAJECTORY';
4865
+ } & TrajectoryEnded | {
4866
+ kind: 'PAUSED_BY_USER';
4867
+ } & TrajectoryPausedByUser | {
4868
+ kind: 'PAUSED_ON_IO';
4869
+ } & TrajectoryPausedOnIO | {
4870
+ kind: 'RUNNING';
4871
+ } & TrajectoryRunning | {
4872
+ kind: 'WAIT_FOR_IO';
4873
+ } & TrajectoryWaitForIO;
4479
4874
  /**
4480
- *
4875
+ * First or last sample (depending on direction) of trajectory has been sent.
4481
4876
  * @export
4482
4877
  * @interface TrajectoryEnded
4483
4878
  */
@@ -4517,7 +4912,7 @@ export declare const TrajectoryIdMessageTypeEnum: {
4517
4912
  };
4518
4913
  export type TrajectoryIdMessageTypeEnum = typeof TrajectoryIdMessageTypeEnum[keyof typeof TrajectoryIdMessageTypeEnum];
4519
4914
  /**
4520
- *
4915
+ * User has paused execution.
4521
4916
  * @export
4522
4917
  * @interface TrajectoryPausedByUser
4523
4918
  */
@@ -4534,7 +4929,7 @@ export declare const TrajectoryPausedByUserKindEnum: {
4534
4929
  };
4535
4930
  export type TrajectoryPausedByUserKindEnum = typeof TrajectoryPausedByUserKindEnum[keyof typeof TrajectoryPausedByUserKindEnum];
4536
4931
  /**
4537
- *
4932
+ * Execution was paused because of an I/O event.
4538
4933
  * @export
4539
4934
  * @interface TrajectoryPausedOnIO
4540
4935
  */
@@ -4551,7 +4946,7 @@ export declare const TrajectoryPausedOnIOKindEnum: {
4551
4946
  };
4552
4947
  export type TrajectoryPausedOnIOKindEnum = typeof TrajectoryPausedOnIOKindEnum[keyof typeof TrajectoryPausedOnIOKindEnum];
4553
4948
  /**
4554
- *
4949
+ * Trajectory is being executed.
4555
4950
  * @export
4556
4951
  * @interface TrajectoryRunning
4557
4952
  */
@@ -4574,7 +4969,7 @@ export declare const TrajectoryRunningKindEnum: {
4574
4969
  };
4575
4970
  export type TrajectoryRunningKindEnum = typeof TrajectoryRunningKindEnum[keyof typeof TrajectoryRunningKindEnum];
4576
4971
  /**
4577
- *
4972
+ * Waiting for an I/O event to start execution.
4578
4973
  * @export
4579
4974
  * @interface TrajectoryWaitForIO
4580
4975
  */
@@ -5161,6 +5556,507 @@ export declare class ApplicationApi extends BaseAPI {
5161
5556
  */
5162
5557
  updateApp(cell: string, app: string, app2: App, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
5163
5558
  }
5559
+ /**
5560
+ * BUSInputsOutputsApi - axios parameter creator
5561
+ * @export
5562
+ */
5563
+ export declare const BUSInputsOutputsApiAxiosParamCreator: (configuration?: Configuration) => {
5564
+ /**
5565
+ * Add a BUS Inputs/Outputs Service to the cell.
5566
+ * @summary Add Service
5567
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
5568
+ * @param {BusIOType} busIOType
5569
+ * @param {number} [completionTimeout]
5570
+ * @param {*} [options] Override http request option.
5571
+ * @throws {RequiredError}
5572
+ */
5573
+ addBusIOService: (cell: string, busIOType: BusIOType, completionTimeout?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
5574
+ /**
5575
+ * Adds an input/output to or updates an input/output on the PROFINET device.
5576
+ * @summary Add PROFINET Input/Output
5577
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
5578
+ * @param {string} io Unique identifier to address an Input/Output in the cell.
5579
+ * @param {ProfinetIOData} profinetIOData
5580
+ * @param {*} [options] Override http request option.
5581
+ * @throws {RequiredError}
5582
+ */
5583
+ addProfinetIO: (cell: string, io: string, profinetIOData: ProfinetIOData, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
5584
+ /**
5585
+ * Delete BUS Inputs/Outputs Service from the cell.
5586
+ * @summary Clear Service
5587
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
5588
+ * @param {number} [completionTimeout]
5589
+ * @param {*} [options] Override http request option.
5590
+ * @throws {RequiredError}
5591
+ */
5592
+ clearBusIOService: (cell: string, completionTimeout?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
5593
+ /**
5594
+ * Removes the input/output from the PROFINET device.
5595
+ * @summary Remove PROFINET Input/Ouptut
5596
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
5597
+ * @param {string} io Unique identifier to address an Input/Output in the cell.
5598
+ * @param {*} [options] Override http request option.
5599
+ * @throws {RequiredError}
5600
+ */
5601
+ deleteProfinetIO: (cell: string, io: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
5602
+ /**
5603
+ * Get deployed BUS Inputs/Outputs Service.
5604
+ * @summary Get Service
5605
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
5606
+ * @param {*} [options] Override http request option.
5607
+ * @throws {RequiredError}
5608
+ */
5609
+ getBusIOService: (cell: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
5610
+ /**
5611
+ * Get the current state of the BUS Inputs/Outputs service.
5612
+ * @summary State
5613
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
5614
+ * @param {*} [options] Override http request option.
5615
+ * @throws {RequiredError}
5616
+ */
5617
+ getBusIOState: (cell: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
5618
+ /**
5619
+ * 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).
5620
+ * @summary Get Input/Output Values
5621
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
5622
+ * @param {Array<string>} [ios]
5623
+ * @param {*} [options] Override http request option.
5624
+ * @throws {RequiredError}
5625
+ */
5626
+ getBusIOValues: (cell: string, ios?: Array<string>, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
5627
+ /**
5628
+ * Get description of PROFINET
5629
+ * @summary Get PROFINET Description
5630
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
5631
+ * @param {*} [options] Override http request option.
5632
+ * @throws {RequiredError}
5633
+ */
5634
+ getProfinetDescription: (cell: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
5635
+ /**
5636
+ * Get input/output configuration of the PROFINET device as file.
5637
+ * @summary PROFINET Inputs/Outputs to File
5638
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
5639
+ * @param {number} [inputOffset]
5640
+ * @param {number} [outputOffset]
5641
+ * @param {*} [options] Override http request option.
5642
+ * @throws {RequiredError}
5643
+ */
5644
+ getProfinetIOsFromFile: (cell: string, inputOffset?: number, outputOffset?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
5645
+ /**
5646
+ * List all BUS Input/Output descriptions.
5647
+ * @summary List Descriptions
5648
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
5649
+ * @param {*} [options] Override http request option.
5650
+ * @throws {RequiredError}
5651
+ */
5652
+ listBusIODescriptions: (cell: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
5653
+ /**
5654
+ * List all PROFINET input and outputs.
5655
+ * @summary List PROFINET Input/Output Configuration
5656
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
5657
+ * @param {*} [options] Override http request option.
5658
+ * @throws {RequiredError}
5659
+ */
5660
+ listProfinetIOs: (cell: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
5661
+ /**
5662
+ * 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.
5663
+ * @summary Set Output Values
5664
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
5665
+ * @param {Array<IOValue>} iOValue
5666
+ * @param {*} [options] Override http request option.
5667
+ * @throws {RequiredError}
5668
+ */
5669
+ setBusIOValues: (cell: string, iOValue: Array<IOValue>, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
5670
+ /**
5671
+ * Sets inputs/outputs on the PROFINET device from file.
5672
+ * @summary Set PROFINET Inputs/Outputs from File
5673
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
5674
+ * @param {ProfinetInputOutputConfig} profinetInputOutputConfig
5675
+ * @param {*} [options] Override http request option.
5676
+ * @throws {RequiredError}
5677
+ */
5678
+ setProfinetIOsFromFile: (cell: string, profinetInputOutputConfig: ProfinetInputOutputConfig, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
5679
+ };
5680
+ /**
5681
+ * BUSInputsOutputsApi - functional programming interface
5682
+ * @export
5683
+ */
5684
+ export declare const BUSInputsOutputsApiFp: (configuration?: Configuration) => {
5685
+ /**
5686
+ * Add a BUS Inputs/Outputs Service to the cell.
5687
+ * @summary Add Service
5688
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
5689
+ * @param {BusIOType} busIOType
5690
+ * @param {number} [completionTimeout]
5691
+ * @param {*} [options] Override http request option.
5692
+ * @throws {RequiredError}
5693
+ */
5694
+ addBusIOService(cell: string, busIOType: BusIOType, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
5695
+ /**
5696
+ * Adds an input/output to or updates an input/output on the PROFINET device.
5697
+ * @summary Add PROFINET Input/Output
5698
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
5699
+ * @param {string} io Unique identifier to address an Input/Output in the cell.
5700
+ * @param {ProfinetIOData} profinetIOData
5701
+ * @param {*} [options] Override http request option.
5702
+ * @throws {RequiredError}
5703
+ */
5704
+ addProfinetIO(cell: string, io: string, profinetIOData: ProfinetIOData, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
5705
+ /**
5706
+ * Delete BUS Inputs/Outputs Service from the cell.
5707
+ * @summary Clear Service
5708
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
5709
+ * @param {number} [completionTimeout]
5710
+ * @param {*} [options] Override http request option.
5711
+ * @throws {RequiredError}
5712
+ */
5713
+ clearBusIOService(cell: string, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
5714
+ /**
5715
+ * Removes the input/output from the PROFINET device.
5716
+ * @summary Remove PROFINET Input/Ouptut
5717
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
5718
+ * @param {string} io Unique identifier to address an Input/Output in the cell.
5719
+ * @param {*} [options] Override http request option.
5720
+ * @throws {RequiredError}
5721
+ */
5722
+ deleteProfinetIO(cell: string, io: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
5723
+ /**
5724
+ * Get deployed BUS Inputs/Outputs Service.
5725
+ * @summary Get Service
5726
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
5727
+ * @param {*} [options] Override http request option.
5728
+ * @throws {RequiredError}
5729
+ */
5730
+ getBusIOService(cell: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BusIOType>>;
5731
+ /**
5732
+ * Get the current state of the BUS Inputs/Outputs service.
5733
+ * @summary State
5734
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
5735
+ * @param {*} [options] Override http request option.
5736
+ * @throws {RequiredError}
5737
+ */
5738
+ getBusIOState(cell: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BusIOsState>>;
5739
+ /**
5740
+ * 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).
5741
+ * @summary Get Input/Output Values
5742
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
5743
+ * @param {Array<string>} [ios]
5744
+ * @param {*} [options] Override http request option.
5745
+ * @throws {RequiredError}
5746
+ */
5747
+ getBusIOValues(cell: string, ios?: Array<string>, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<IOValue>>>;
5748
+ /**
5749
+ * Get description of PROFINET
5750
+ * @summary Get PROFINET Description
5751
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
5752
+ * @param {*} [options] Override http request option.
5753
+ * @throws {RequiredError}
5754
+ */
5755
+ getProfinetDescription(cell: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ProfinetDescription>>;
5756
+ /**
5757
+ * Get input/output configuration of the PROFINET device as file.
5758
+ * @summary PROFINET Inputs/Outputs to File
5759
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
5760
+ * @param {number} [inputOffset]
5761
+ * @param {number} [outputOffset]
5762
+ * @param {*} [options] Override http request option.
5763
+ * @throws {RequiredError}
5764
+ */
5765
+ getProfinetIOsFromFile(cell: string, inputOffset?: number, outputOffset?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<string>>;
5766
+ /**
5767
+ * List all BUS Input/Output descriptions.
5768
+ * @summary List Descriptions
5769
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
5770
+ * @param {*} [options] Override http request option.
5771
+ * @throws {RequiredError}
5772
+ */
5773
+ listBusIODescriptions(cell: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<IODescription>>>;
5774
+ /**
5775
+ * List all PROFINET input and outputs.
5776
+ * @summary List PROFINET Input/Output Configuration
5777
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
5778
+ * @param {*} [options] Override http request option.
5779
+ * @throws {RequiredError}
5780
+ */
5781
+ listProfinetIOs(cell: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<ProfinetIO>>>;
5782
+ /**
5783
+ * 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.
5784
+ * @summary Set Output Values
5785
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
5786
+ * @param {Array<IOValue>} iOValue
5787
+ * @param {*} [options] Override http request option.
5788
+ * @throws {RequiredError}
5789
+ */
5790
+ setBusIOValues(cell: string, iOValue: Array<IOValue>, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
5791
+ /**
5792
+ * Sets inputs/outputs on the PROFINET device from file.
5793
+ * @summary Set PROFINET Inputs/Outputs from File
5794
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
5795
+ * @param {ProfinetInputOutputConfig} profinetInputOutputConfig
5796
+ * @param {*} [options] Override http request option.
5797
+ * @throws {RequiredError}
5798
+ */
5799
+ setProfinetIOsFromFile(cell: string, profinetInputOutputConfig: ProfinetInputOutputConfig, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
5800
+ };
5801
+ /**
5802
+ * BUSInputsOutputsApi - factory interface
5803
+ * @export
5804
+ */
5805
+ export declare const BUSInputsOutputsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
5806
+ /**
5807
+ * Add a BUS Inputs/Outputs Service to the cell.
5808
+ * @summary Add Service
5809
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
5810
+ * @param {BusIOType} busIOType
5811
+ * @param {number} [completionTimeout]
5812
+ * @param {*} [options] Override http request option.
5813
+ * @throws {RequiredError}
5814
+ */
5815
+ addBusIOService(cell: string, busIOType: BusIOType, completionTimeout?: number, options?: RawAxiosRequestConfig): AxiosPromise<void>;
5816
+ /**
5817
+ * Adds an input/output to or updates an input/output on the PROFINET device.
5818
+ * @summary Add PROFINET Input/Output
5819
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
5820
+ * @param {string} io Unique identifier to address an Input/Output in the cell.
5821
+ * @param {ProfinetIOData} profinetIOData
5822
+ * @param {*} [options] Override http request option.
5823
+ * @throws {RequiredError}
5824
+ */
5825
+ addProfinetIO(cell: string, io: string, profinetIOData: ProfinetIOData, options?: RawAxiosRequestConfig): AxiosPromise<void>;
5826
+ /**
5827
+ * Delete BUS Inputs/Outputs Service from the cell.
5828
+ * @summary Clear Service
5829
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
5830
+ * @param {number} [completionTimeout]
5831
+ * @param {*} [options] Override http request option.
5832
+ * @throws {RequiredError}
5833
+ */
5834
+ clearBusIOService(cell: string, completionTimeout?: number, options?: RawAxiosRequestConfig): AxiosPromise<void>;
5835
+ /**
5836
+ * Removes the input/output from the PROFINET device.
5837
+ * @summary Remove PROFINET Input/Ouptut
5838
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
5839
+ * @param {string} io Unique identifier to address an Input/Output in the cell.
5840
+ * @param {*} [options] Override http request option.
5841
+ * @throws {RequiredError}
5842
+ */
5843
+ deleteProfinetIO(cell: string, io: string, options?: RawAxiosRequestConfig): AxiosPromise<void>;
5844
+ /**
5845
+ * Get deployed BUS Inputs/Outputs Service.
5846
+ * @summary Get Service
5847
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
5848
+ * @param {*} [options] Override http request option.
5849
+ * @throws {RequiredError}
5850
+ */
5851
+ getBusIOService(cell: string, options?: RawAxiosRequestConfig): AxiosPromise<BusIOType>;
5852
+ /**
5853
+ * Get the current state of the BUS Inputs/Outputs service.
5854
+ * @summary State
5855
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
5856
+ * @param {*} [options] Override http request option.
5857
+ * @throws {RequiredError}
5858
+ */
5859
+ getBusIOState(cell: string, options?: RawAxiosRequestConfig): AxiosPromise<BusIOsState>;
5860
+ /**
5861
+ * 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).
5862
+ * @summary Get Input/Output Values
5863
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
5864
+ * @param {Array<string>} [ios]
5865
+ * @param {*} [options] Override http request option.
5866
+ * @throws {RequiredError}
5867
+ */
5868
+ getBusIOValues(cell: string, ios?: Array<string>, options?: RawAxiosRequestConfig): AxiosPromise<Array<IOValue>>;
5869
+ /**
5870
+ * Get description of PROFINET
5871
+ * @summary Get PROFINET Description
5872
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
5873
+ * @param {*} [options] Override http request option.
5874
+ * @throws {RequiredError}
5875
+ */
5876
+ getProfinetDescription(cell: string, options?: RawAxiosRequestConfig): AxiosPromise<ProfinetDescription>;
5877
+ /**
5878
+ * Get input/output configuration of the PROFINET device as file.
5879
+ * @summary PROFINET Inputs/Outputs to File
5880
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
5881
+ * @param {number} [inputOffset]
5882
+ * @param {number} [outputOffset]
5883
+ * @param {*} [options] Override http request option.
5884
+ * @throws {RequiredError}
5885
+ */
5886
+ getProfinetIOsFromFile(cell: string, inputOffset?: number, outputOffset?: number, options?: RawAxiosRequestConfig): AxiosPromise<string>;
5887
+ /**
5888
+ * List all BUS Input/Output descriptions.
5889
+ * @summary List Descriptions
5890
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
5891
+ * @param {*} [options] Override http request option.
5892
+ * @throws {RequiredError}
5893
+ */
5894
+ listBusIODescriptions(cell: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<IODescription>>;
5895
+ /**
5896
+ * List all PROFINET input and outputs.
5897
+ * @summary List PROFINET Input/Output Configuration
5898
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
5899
+ * @param {*} [options] Override http request option.
5900
+ * @throws {RequiredError}
5901
+ */
5902
+ listProfinetIOs(cell: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<ProfinetIO>>;
5903
+ /**
5904
+ * 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.
5905
+ * @summary Set Output Values
5906
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
5907
+ * @param {Array<IOValue>} iOValue
5908
+ * @param {*} [options] Override http request option.
5909
+ * @throws {RequiredError}
5910
+ */
5911
+ setBusIOValues(cell: string, iOValue: Array<IOValue>, options?: RawAxiosRequestConfig): AxiosPromise<void>;
5912
+ /**
5913
+ * Sets inputs/outputs on the PROFINET device from file.
5914
+ * @summary Set PROFINET Inputs/Outputs from File
5915
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
5916
+ * @param {ProfinetInputOutputConfig} profinetInputOutputConfig
5917
+ * @param {*} [options] Override http request option.
5918
+ * @throws {RequiredError}
5919
+ */
5920
+ setProfinetIOsFromFile(cell: string, profinetInputOutputConfig: ProfinetInputOutputConfig, options?: RawAxiosRequestConfig): AxiosPromise<void>;
5921
+ };
5922
+ /**
5923
+ * BUSInputsOutputsApi - object-oriented interface
5924
+ * @export
5925
+ * @class BUSInputsOutputsApi
5926
+ * @extends {BaseAPI}
5927
+ */
5928
+ export declare class BUSInputsOutputsApi extends BaseAPI {
5929
+ /**
5930
+ * Add a BUS Inputs/Outputs Service to the cell.
5931
+ * @summary Add Service
5932
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
5933
+ * @param {BusIOType} busIOType
5934
+ * @param {number} [completionTimeout]
5935
+ * @param {*} [options] Override http request option.
5936
+ * @throws {RequiredError}
5937
+ * @memberof BUSInputsOutputsApi
5938
+ */
5939
+ addBusIOService(cell: string, busIOType: BusIOType, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
5940
+ /**
5941
+ * Adds an input/output to or updates an input/output on the PROFINET device.
5942
+ * @summary Add PROFINET Input/Output
5943
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
5944
+ * @param {string} io Unique identifier to address an Input/Output in the cell.
5945
+ * @param {ProfinetIOData} profinetIOData
5946
+ * @param {*} [options] Override http request option.
5947
+ * @throws {RequiredError}
5948
+ * @memberof BUSInputsOutputsApi
5949
+ */
5950
+ addProfinetIO(cell: string, io: string, profinetIOData: ProfinetIOData, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
5951
+ /**
5952
+ * Delete BUS Inputs/Outputs Service from the cell.
5953
+ * @summary Clear Service
5954
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
5955
+ * @param {number} [completionTimeout]
5956
+ * @param {*} [options] Override http request option.
5957
+ * @throws {RequiredError}
5958
+ * @memberof BUSInputsOutputsApi
5959
+ */
5960
+ clearBusIOService(cell: string, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
5961
+ /**
5962
+ * Removes the input/output from the PROFINET device.
5963
+ * @summary Remove PROFINET Input/Ouptut
5964
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
5965
+ * @param {string} io Unique identifier to address an Input/Output in the cell.
5966
+ * @param {*} [options] Override http request option.
5967
+ * @throws {RequiredError}
5968
+ * @memberof BUSInputsOutputsApi
5969
+ */
5970
+ deleteProfinetIO(cell: string, io: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
5971
+ /**
5972
+ * Get deployed BUS Inputs/Outputs Service.
5973
+ * @summary Get Service
5974
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
5975
+ * @param {*} [options] Override http request option.
5976
+ * @throws {RequiredError}
5977
+ * @memberof BUSInputsOutputsApi
5978
+ */
5979
+ getBusIOService(cell: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<{
5980
+ bus_type: "profinet";
5981
+ } & BusIOProfinet, any>>;
5982
+ /**
5983
+ * Get the current state of the BUS Inputs/Outputs service.
5984
+ * @summary State
5985
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
5986
+ * @param {*} [options] Override http request option.
5987
+ * @throws {RequiredError}
5988
+ * @memberof BUSInputsOutputsApi
5989
+ */
5990
+ getBusIOState(cell: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<BusIOsState, any>>;
5991
+ /**
5992
+ * 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).
5993
+ * @summary Get Input/Output Values
5994
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
5995
+ * @param {Array<string>} [ios]
5996
+ * @param {*} [options] Override http request option.
5997
+ * @throws {RequiredError}
5998
+ * @memberof BUSInputsOutputsApi
5999
+ */
6000
+ getBusIOValues(cell: string, ios?: Array<string>, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<IOValue[], any>>;
6001
+ /**
6002
+ * Get description of PROFINET
6003
+ * @summary Get PROFINET Description
6004
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
6005
+ * @param {*} [options] Override http request option.
6006
+ * @throws {RequiredError}
6007
+ * @memberof BUSInputsOutputsApi
6008
+ */
6009
+ getProfinetDescription(cell: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ProfinetDescription, any>>;
6010
+ /**
6011
+ * Get input/output configuration of the PROFINET device as file.
6012
+ * @summary PROFINET Inputs/Outputs to File
6013
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
6014
+ * @param {number} [inputOffset]
6015
+ * @param {number} [outputOffset]
6016
+ * @param {*} [options] Override http request option.
6017
+ * @throws {RequiredError}
6018
+ * @memberof BUSInputsOutputsApi
6019
+ */
6020
+ getProfinetIOsFromFile(cell: string, inputOffset?: number, outputOffset?: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<string, any>>;
6021
+ /**
6022
+ * List all BUS Input/Output descriptions.
6023
+ * @summary List Descriptions
6024
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
6025
+ * @param {*} [options] Override http request option.
6026
+ * @throws {RequiredError}
6027
+ * @memberof BUSInputsOutputsApi
6028
+ */
6029
+ listBusIODescriptions(cell: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<IODescription[], any>>;
6030
+ /**
6031
+ * List all PROFINET input and outputs.
6032
+ * @summary List PROFINET Input/Output Configuration
6033
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
6034
+ * @param {*} [options] Override http request option.
6035
+ * @throws {RequiredError}
6036
+ * @memberof BUSInputsOutputsApi
6037
+ */
6038
+ listProfinetIOs(cell: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ProfinetIO[], any>>;
6039
+ /**
6040
+ * 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.
6041
+ * @summary Set Output Values
6042
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
6043
+ * @param {Array<IOValue>} iOValue
6044
+ * @param {*} [options] Override http request option.
6045
+ * @throws {RequiredError}
6046
+ * @memberof BUSInputsOutputsApi
6047
+ */
6048
+ setBusIOValues(cell: string, iOValue: Array<IOValue>, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
6049
+ /**
6050
+ * Sets inputs/outputs on the PROFINET device from file.
6051
+ * @summary Set PROFINET Inputs/Outputs from File
6052
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
6053
+ * @param {ProfinetInputOutputConfig} profinetInputOutputConfig
6054
+ * @param {*} [options] Override http request option.
6055
+ * @throws {RequiredError}
6056
+ * @memberof BUSInputsOutputsApi
6057
+ */
6058
+ setProfinetIOsFromFile(cell: string, profinetInputOutputConfig: ProfinetInputOutputConfig, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
6059
+ }
5164
6060
  /**
5165
6061
  * CellApi - axios parameter creator
5166
6062
  * @export