@wandelbots/nova-api 25.8.0-dev.5 → 25.8.0-dev.50

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.ts CHANGED
@@ -106,7 +106,7 @@ export interface AddTrajectoryError {
106
106
  */
107
107
  'message'?: string;
108
108
  /**
109
- * The location of the error in the trajectory.
109
+ * Location on trajectory where the execution will start. The default value is the start (forward movement) or end (backward movement) of the trajectory. If you want to start your movement from an arbitrary location, e.g. in combination with [streamMoveToTrajectoryViaJointPTP](streamMoveToTrajectoryViaJointPTP), set the location by respecting the following format: - The location is a scalar value that defines a position along a path, typically ranging from 0 to `n`, where `n` denotes the number of motion commands - Each integer value of the location corresponds to a specific motion command, while non-integer values interpolate positions within the segments. - The location is calculated from the joint path
110
110
  * @type {number}
111
111
  * @memberof AddTrajectoryError
112
112
  */
@@ -373,7 +373,7 @@ export const BoxBoxTypeEnum = {
373
373
  export type BoxBoxTypeEnum = typeof BoxBoxTypeEnum[keyof typeof BoxBoxTypeEnum];
374
374
 
375
375
  /**
376
- * PROFINET BUS Inputs/Outputs Service configuration.
376
+ * PROFINET BUS inputs/outputs service configuration.
377
377
  * @export
378
378
  * @interface BusIOProfinet
379
379
  */
@@ -385,19 +385,19 @@ export interface BusIOProfinet {
385
385
  */
386
386
  'bus_type'?: BusIOProfinetBusTypeEnum;
387
387
  /**
388
- * Path to the configuration file.
389
- * @type {string}
388
+ * Used to enable IP communication through the same physical ethernet interface while PROFINET driver is active.
389
+ * @type {BusIOProfinetNetwork}
390
390
  * @memberof BusIOProfinet
391
391
  */
392
- 'config_file_content'?: string;
392
+ 'network_config'?: BusIOProfinetNetwork;
393
393
  /**
394
- *
395
- * @type {BusIOProfinetNetwork}
394
+ * IP address of the PLC to establish PROFINET communication with. The IP address is used to configure the host machine\'s firewall. The firewall configuration is applied while the BUS input/output service is active. Without proper firewall configuration, PROFINET device discovery, configuration exchanges, and real-time cyclic data communication will fail.
395
+ * @type {string}
396
396
  * @memberof BusIOProfinet
397
397
  */
398
- 'network_config'?: BusIOProfinetNetwork;
398
+ 'plc_ip': string;
399
399
  /**
400
- * MAC address for the PROFINET port, should be get from another NOVA API endpoind?
400
+ * MAC address of the physical ethernet interface that you want to use for PROFINET communication.
401
401
  * @type {string}
402
402
  * @memberof BusIOProfinet
403
403
  */
@@ -417,7 +417,7 @@ export const BusIOProfinetBusTypeEnum = {
417
417
  export type BusIOProfinetBusTypeEnum = typeof BusIOProfinetBusTypeEnum[keyof typeof BusIOProfinetBusTypeEnum];
418
418
 
419
419
  /**
420
- * Default route configuration for the PROFINET service. Will be removed before release by automatic default route configuration, if possible.
420
+ * Current default route configuration of your NOVA instance. The default route is a setting that tells data where to go if there isn’t a specific path already known for its destination. Usually this will be the path to your router, enabling accessing the internet. On Linux, use `ip route show` to view your default routes and match the output `default via <gateway> dev <interface> ...` to get your gateway and interface.
421
421
  * @export
422
422
  * @interface BusIOProfinetDefaultRoute
423
423
  */
@@ -436,25 +436,25 @@ export interface BusIOProfinetDefaultRoute {
436
436
  'interface': string;
437
437
  }
438
438
  /**
439
- * Network configuration for the PROFINET device
439
+ * Network configuration or IPv4 record of the virtual ethernet interface (pnio1) created by the PROFINET driver. The IPv4 record is used in combination with the Name of Station (NoS) to identify your device in the PROFINET network. The `ip_config` will be used as IPv4 record if no REMA XML file is already present on your machine and no `rema_xml_content` is provided.
440
440
  * @export
441
441
  * @interface BusIOProfinetIpConfig
442
442
  */
443
443
  export interface BusIOProfinetIpConfig {
444
444
  /**
445
- * IP address for the PROFINET device
445
+ * IP address for the device\'s virtual ethernet interface (pnio1).
446
446
  * @type {string}
447
447
  * @memberof BusIOProfinetIpConfig
448
448
  */
449
449
  'ip': string;
450
450
  /**
451
- * Network mask for the PROFINET device.
451
+ * Network mask for the device\'s virtual ethernet interface (pnio1).
452
452
  * @type {string}
453
453
  * @memberof BusIOProfinetIpConfig
454
454
  */
455
455
  'netmask': string;
456
456
  /**
457
- * Gateway for the PROFINET device
457
+ * Gateway for connections to other devices outside of the virtual ethernet interface\'s subnet.
458
458
  * @type {string}
459
459
  * @memberof BusIOProfinetIpConfig
460
460
  */
@@ -467,7 +467,7 @@ export interface BusIOProfinetIpConfig {
467
467
  */
468
468
  export interface BusIOProfinetNetwork {
469
469
  /**
470
- * Name of the PROFINET device.
470
+ * Name of Station (NoS) of the PROFINET device. The NoS is used in combination with IPv4 record to identify your device in the PROFINET network. The `device_name` will be used as NoS if no REMA XML file is already present on your machine and no `rema_xml_content` is provided.
471
471
  * @type {string}
472
472
  * @memberof BusIOProfinetNetwork
473
473
  */
@@ -479,14 +479,14 @@ export interface BusIOProfinetNetwork {
479
479
  */
480
480
  'ip_config'?: BusIOProfinetIpConfig;
481
481
  /**
482
- * Content of the PROFINET REMA XML file.
482
+ * Content of the PROFINET REMA XML file. Is used when PROFINET service is added for the first time to create the REMA XML file that holds data to be kept for the next session. Stores information like IP address, Name of Station (NoS) and hardware configuration. If you use a PROFINET controller to assign an IP address to the PROFINET device, this information will be written to the REMA XML file. Refer to the PDF version of the \"PN Driver I/O Base programming interface\" documentation for more information and an example REMA file.
483
483
  * @type {string}
484
484
  * @memberof BusIOProfinetNetwork
485
485
  */
486
486
  'rema_xml_content'?: string;
487
487
  }
488
488
  /**
489
- * Virtual PROFINET BUS Inputs/Outputs Service configuration.
489
+ * Virtual PROFINET BUS inputs/outputs service configuration.
490
490
  * @export
491
491
  * @interface BusIOProfinetVirtual
492
492
  */
@@ -500,7 +500,7 @@ export interface BusIOProfinetVirtual {
500
500
  }
501
501
 
502
502
  export const BusIOProfinetVirtualBusTypeEnum = {
503
- VirtualProfinet: 'virtual_profinet'
503
+ ProfinetVirtual: 'profinet_virtual'
504
504
  } as const;
505
505
 
506
506
  export type BusIOProfinetVirtualBusTypeEnum = typeof BusIOProfinetVirtualBusTypeEnum[keyof typeof BusIOProfinetVirtualBusTypeEnum];
@@ -524,7 +524,7 @@ export interface BusIOsState {
524
524
  */
525
525
  'state': BusIOsStateEnum;
526
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.
527
+ * A message providing additional information on the input/output service, e.g. BUS service status, encountered errors. May be empty if no additional information is available.
528
528
  * @type {string}
529
529
  * @memberof BusIOsState
530
530
  */
@@ -1782,9 +1782,22 @@ export interface GetTrajectoryResponse {
1782
1782
  export interface HTTPValidationError {
1783
1783
  /**
1784
1784
  *
1785
- * @type {Array<ValidationError>}
1785
+ * @type {Array<ValidationError2>}
1786
1786
  * @memberof HTTPValidationError
1787
1787
  */
1788
+ 'detail'?: Array<ValidationError2>;
1789
+ }
1790
+ /**
1791
+ *
1792
+ * @export
1793
+ * @interface HTTPValidationError2
1794
+ */
1795
+ export interface HTTPValidationError2 {
1796
+ /**
1797
+ *
1798
+ * @type {Array<ValidationError>}
1799
+ * @memberof HTTPValidationError2
1800
+ */
1788
1801
  'detail'?: Array<ValidationError>;
1789
1802
  }
1790
1803
  /**
@@ -1876,6 +1889,57 @@ export interface IODescription {
1876
1889
  }
1877
1890
 
1878
1891
 
1892
+ /**
1893
+ *
1894
+ * @export
1895
+ * @interface IODescription2
1896
+ */
1897
+ export interface IODescription2 {
1898
+ /**
1899
+ * Unique identifier of the input/output.
1900
+ * @type {string}
1901
+ * @memberof IODescription2
1902
+ */
1903
+ 'io': string;
1904
+ /**
1905
+ * Descriptive name of the input/output. Customize it using the respective BUS service, e.g. [addProfinetIO](addProfinetIO) for PROFINET service.
1906
+ * @type {string}
1907
+ * @memberof IODescription2
1908
+ */
1909
+ 'name': string;
1910
+ /**
1911
+ *
1912
+ * @type {IODirection}
1913
+ * @memberof IODescription2
1914
+ */
1915
+ 'direction': IODirection;
1916
+ /**
1917
+ *
1918
+ * @type {IOValueType}
1919
+ * @memberof IODescription2
1920
+ */
1921
+ 'value_type': IOValueType;
1922
+ /**
1923
+ *
1924
+ * @type {UnitType}
1925
+ * @memberof IODescription2
1926
+ */
1927
+ 'unit'?: UnitType;
1928
+ /**
1929
+ *
1930
+ * @type {IODescriptionMin}
1931
+ * @memberof IODescription2
1932
+ */
1933
+ 'min'?: IODescriptionMin;
1934
+ /**
1935
+ *
1936
+ * @type {IODescriptionMin}
1937
+ * @memberof IODescription2
1938
+ */
1939
+ 'max'?: IODescriptionMin;
1940
+ }
1941
+
1942
+
1879
1943
  /**
1880
1944
  * @type IODescriptionMin
1881
1945
  * @export
@@ -1941,7 +2005,7 @@ export interface IOIntegerValue {
1941
2005
  */
1942
2006
  'io': string;
1943
2007
  /**
1944
- * Value of an input/output with integer representation. > The integral value is transmitted as a string to avoid precision loss during conversion to JSON. > We recommend to use int64 in your implementation. If you want to interact with int64 in numbers, > JS bigint libraries can help you to parse the string into an integral value.
2008
+ * Value of an input/output with integer representation. > The integral value is transmitted as a string to avoid precision loss during conversion to JSON. > Recommended: Use int64 in your implementation. If you want to interact with int64 in numbers, > JS bigint libraries can help you to parse the string into an integral value.
1945
2009
  * @type {string}
1946
2010
  * @memberof IOIntegerValue
1947
2011
  */
@@ -2080,12 +2144,6 @@ export interface InitializeJoggingRequest {
2080
2144
  * @memberof InitializeJoggingRequest
2081
2145
  */
2082
2146
  'response_coordinate_system'?: string;
2083
- /**
2084
- * Defines an input/output that is listened to during the movement. Execution pauses if the defined comparator evaluates to `true`.
2085
- * @type {string}
2086
- * @memberof InitializeJoggingRequest
2087
- */
2088
- 'pause_on_io'?: string;
2089
2147
  }
2090
2148
 
2091
2149
  export const InitializeJoggingRequestMessageTypeEnum = {
@@ -2204,7 +2262,7 @@ export const InitializeMovementResponseKindEnum = {
2204
2262
  export type InitializeMovementResponseKindEnum = typeof InitializeMovementResponseKindEnum[keyof typeof InitializeMovementResponseKindEnum];
2205
2263
 
2206
2264
  /**
2207
- * Value of an input/output with integer representation. > The integral value is transmitted as a string to avoid precision loss during conversion to JSON. > We recommend to use int64 in your implementation. If you want to interact with int64 in numbers, > JS bigint libraries can help you to parse the string into an integral value.
2265
+ * Value of an input/output with integer representation. > The integral value is transmitted as a string to avoid precision loss during conversion to JSON. > Recommended: Use int64 in your implementation. If you want to interact with int64 in numbers, > JS bigint libraries can help you to parse the string into an integral value.
2208
2266
  * @export
2209
2267
  * @interface IntegerValue
2210
2268
  */
@@ -2404,10 +2462,10 @@ export type JoggingDetailsKindEnum = typeof JoggingDetailsKindEnum[keyof typeof
2404
2462
  * @type JoggingDetailsState
2405
2463
  * @export
2406
2464
  */
2407
- export type JoggingDetailsState = JoggingPausedByUser | JoggingPausedNearCollision | JoggingPausedNearJointLimit | JoggingPausedOnIO | JoggingRunning;
2465
+ export type JoggingDetailsState = { kind: 'PAUSED_BY_USER' } & JoggingPausedByUser | { kind: 'PAUSED_NEAR_COLLISION' } & JoggingPausedNearCollision | { kind: 'PAUSED_NEAR_JOINT_LIMIT' } & JoggingPausedNearJointLimit | { kind: 'PAUSED_ON_IO' } & JoggingPausedOnIO | { kind: 'RUNNING' } & JoggingRunning;
2408
2466
 
2409
2467
  /**
2410
- *
2468
+ * User has paused jogging.
2411
2469
  * @export
2412
2470
  * @interface JoggingPausedByUser
2413
2471
  */
@@ -2427,7 +2485,7 @@ export const JoggingPausedByUserKindEnum = {
2427
2485
  export type JoggingPausedByUserKindEnum = typeof JoggingPausedByUserKindEnum[keyof typeof JoggingPausedByUserKindEnum];
2428
2486
 
2429
2487
  /**
2430
- *
2488
+ * Jogging was paused because the motion group neared a collision.
2431
2489
  * @export
2432
2490
  * @interface JoggingPausedNearCollision
2433
2491
  */
@@ -2453,7 +2511,7 @@ export const JoggingPausedNearCollisionKindEnum = {
2453
2511
  export type JoggingPausedNearCollisionKindEnum = typeof JoggingPausedNearCollisionKindEnum[keyof typeof JoggingPausedNearCollisionKindEnum];
2454
2512
 
2455
2513
  /**
2456
- *
2514
+ * Jogging was paused because a joint is near its limit.
2457
2515
  * @export
2458
2516
  * @interface JoggingPausedNearJointLimit
2459
2517
  */
@@ -2479,7 +2537,7 @@ export const JoggingPausedNearJointLimitKindEnum = {
2479
2537
  export type JoggingPausedNearJointLimitKindEnum = typeof JoggingPausedNearJointLimitKindEnum[keyof typeof JoggingPausedNearJointLimitKindEnum];
2480
2538
 
2481
2539
  /**
2482
- *
2540
+ * Jogging was paused because of an I/O event.
2483
2541
  * @export
2484
2542
  * @interface JoggingPausedOnIO
2485
2543
  */
@@ -2499,7 +2557,7 @@ export const JoggingPausedOnIOKindEnum = {
2499
2557
  export type JoggingPausedOnIOKindEnum = typeof JoggingPausedOnIOKindEnum[keyof typeof JoggingPausedOnIOKindEnum];
2500
2558
 
2501
2559
  /**
2502
- *
2560
+ * Jogging is active.
2503
2561
  * @export
2504
2562
  * @interface JoggingRunning
2505
2563
  */
@@ -2581,7 +2639,7 @@ export interface JointTrajectory {
2581
2639
  */
2582
2640
  'times': Array<number>;
2583
2641
  /**
2584
- * Location for each sample, scalar value defining a position along a path. Typical range: 0 to `n`, `n` denoting the number of motion commands. Each integer value of the location corresponds to a specific motion command. If provided, the number of samples must match the number of timestamps provided in the times field.
2642
+ *
2585
2643
  * @type {Array<number>}
2586
2644
  * @memberof JointTrajectory
2587
2645
  */
@@ -2869,6 +2927,12 @@ export interface LimitSet {
2869
2927
  * @memberof LimitSet
2870
2928
  */
2871
2929
  'flange'?: CartesianLimits;
2930
+ /**
2931
+ *
2932
+ * @type {JointLimits}
2933
+ * @memberof LimitSet
2934
+ */
2935
+ 'coupled_shoulder_elbow_joint'?: JointLimits;
2872
2936
  }
2873
2937
  /**
2874
2938
  * If a limit is not set, the default value will be used.
@@ -2944,13 +3008,13 @@ export type Manufacturer = typeof Manufacturer[keyof typeof Manufacturer];
2944
3008
 
2945
3009
 
2946
3010
  /**
2947
- * Midpoint insertion algorithm configuration for collision-free path planning. This algorithm iteratively inserts midpoints between the start and target joint position to find collision-free paths.
3011
+ *
2948
3012
  * @export
2949
3013
  * @interface MidpointInsertionAlgorithm
2950
3014
  */
2951
3015
  export interface MidpointInsertionAlgorithm {
2952
3016
  /**
2953
- * Algorithm discriminator.
3017
+ * Algorithm discriminator. Midpoint insertion algorithm configuration for collision-free path planning. This algorithm adds a single midpoint between the start and target joint position to find collision-free paths.
2954
3018
  * @type {string}
2955
3019
  * @memberof MidpointInsertionAlgorithm
2956
3020
  */
@@ -3849,11 +3913,11 @@ export interface PlanTrajectoryFailedResponse {
3849
3913
  */
3850
3914
  'error_feedback': PlanTrajectoryFailedResponseErrorFeedback;
3851
3915
  /**
3852
- *
3916
+ * Location on trajectory where the execution will start. The default value is the start (forward movement) or end (backward movement) of the trajectory. If you want to start your movement from an arbitrary location, e.g. in combination with [streamMoveToTrajectoryViaJointPTP](streamMoveToTrajectoryViaJointPTP), set the location by respecting the following format: - The location is a scalar value that defines a position along a path, typically ranging from 0 to `n`, where `n` denotes the number of motion commands - Each integer value of the location corresponds to a specific motion command, while non-integer values interpolate positions within the segments. - The location is calculated from the joint path
3853
3917
  * @type {number}
3854
3918
  * @memberof PlanTrajectoryFailedResponse
3855
3919
  */
3856
- 'error_location_on_trajectory'?: number;
3920
+ 'error_location_on_trajectory': number;
3857
3921
  /**
3858
3922
  * The joint trajectory from the start joint position to the error.
3859
3923
  * @type {JointTrajectory}
@@ -4071,17 +4135,17 @@ export interface ProfinetDescription {
4071
4135
  */
4072
4136
  'slots'?: Array<ProfinetSlotDescription>;
4073
4137
  /**
4074
- * Name of the PROFINET device
4138
+ * Name of Station (NoS) of the PROFINET device. The NoS is used in combination with IPv4 record to identify your device in the PROFINET network. The `device_name` will be used as NoS if no REMA XML file is already present on your NOVA instance and no `rema_xml_content` is provided.
4075
4139
  * @type {string}
4076
4140
  * @memberof ProfinetDescription
4077
4141
  */
4078
4142
  'device_name'?: string;
4079
4143
  /**
4080
- * IP address for the PROFINET device
4081
- * @type {string}
4144
+ *
4145
+ * @type {BusIOProfinetIpConfig}
4082
4146
  * @memberof ProfinetDescription
4083
4147
  */
4084
- 'ip'?: string;
4148
+ 'ip_config'?: BusIOProfinetIpConfig;
4085
4149
  }
4086
4150
  /**
4087
4151
  *
@@ -4090,7 +4154,7 @@ export interface ProfinetDescription {
4090
4154
  */
4091
4155
  export interface ProfinetIO {
4092
4156
  /**
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.
4157
+ * The name of the input/output variable. This is a human-readable identifier for the value. It distinguishes between different inputs/outputs variables in the system. The variables may be used to set bits or bytes at their pointed to address via [setBusIOValues](setBusIOValues).
4094
4158
  * @type {string}
4095
4159
  * @memberof ProfinetIO
4096
4160
  */
@@ -4102,25 +4166,25 @@ export interface ProfinetIO {
4102
4166
  */
4103
4167
  'type': ProfinetIOTypeEnum;
4104
4168
  /**
4105
- * The direction of the input/output value, indicating whether it is an input or output for the device.
4169
+ * The direction of the input/output variable, indicating whether it is an input or output for the PROFINET device, e.g. NOVA\'s PROFINET service.
4106
4170
  * @type {ProfinetIODirection}
4107
4171
  * @memberof ProfinetIO
4108
4172
  */
4109
4173
  'direction': ProfinetIODirection;
4110
4174
  /**
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.
4175
+ * The byte address of the input/output variable in the PROFINET device, e.g. NOVA\'s PROFINET service. The byte address is used to locate the specific input/output variable within the device\'s memory or data structure.
4112
4176
  * @type {number}
4113
4177
  * @memberof ProfinetIO
4114
4178
  */
4115
4179
  'byte_address': number;
4116
4180
  /**
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.
4181
+ * The bit address of the input/output variable 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 variable.
4118
4182
  * @type {number}
4119
4183
  * @memberof ProfinetIO
4120
4184
  */
4121
4185
  'bit_address'?: number;
4122
4186
  /**
4123
- * The unique identifier for the input/output value. This identifier is used to reference the specific input/output in the NOVA system.
4187
+ * The unique identifier for the input/output value. This identifier is used to reference the specific input/output variable in the PROFINET device, e.g. NOVA\'s PROFINET service.
4124
4188
  * @type {string}
4125
4189
  * @memberof ProfinetIO
4126
4190
  */
@@ -4135,7 +4199,7 @@ export interface ProfinetIO {
4135
4199
  */
4136
4200
  export interface ProfinetIOData {
4137
4201
  /**
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.
4202
+ * The name of the input/output variable. This is a human-readable identifier for the value. It distinguishes between different inputs/outputs variables in the system. The variables may be used to set bits or bytes at their pointed to address via [setBusIOValues](setBusIOValues).
4139
4203
  * @type {string}
4140
4204
  * @memberof ProfinetIOData
4141
4205
  */
@@ -4147,19 +4211,19 @@ export interface ProfinetIOData {
4147
4211
  */
4148
4212
  'type': ProfinetIOTypeEnum;
4149
4213
  /**
4150
- * The direction of the input/output value, indicating whether it is an input or output for the device.
4214
+ * The direction of the input/output variable, indicating whether it is an input or output for the PROFINET device, e.g. NOVA\'s PROFINET service.
4151
4215
  * @type {ProfinetIODirection}
4152
4216
  * @memberof ProfinetIOData
4153
4217
  */
4154
4218
  'direction': ProfinetIODirection;
4155
4219
  /**
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.
4220
+ * The byte address of the input/output variable in the PROFINET device, e.g. NOVA\'s PROFINET service. The byte address is used to locate the specific input/output variable within the device\'s memory or data structure.
4157
4221
  * @type {number}
4158
4222
  * @memberof ProfinetIOData
4159
4223
  */
4160
4224
  'byte_address': number;
4161
4225
  /**
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.
4226
+ * The bit address of the input/output variable 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 variable.
4163
4227
  * @type {number}
4164
4228
  * @memberof ProfinetIOData
4165
4229
  */
@@ -4168,7 +4232,7 @@ export interface ProfinetIOData {
4168
4232
 
4169
4233
 
4170
4234
  /**
4171
- * Identifies the input/output type.
4235
+ * The direction of the input/output variable, indicating whether it is an input or output for the PROFINET device, e.g. NOVA\'s PROFINET service.
4172
4236
  * @export
4173
4237
  * @enum {string}
4174
4238
  */
@@ -4183,7 +4247,7 @@ export type ProfinetIODirection = typeof ProfinetIODirection[keyof typeof Profin
4183
4247
 
4184
4248
 
4185
4249
  /**
4186
- * Value type of the PROFINET input/output.
4250
+ * Value type of the PROFINET input/output variable. Is used to interpret the corresponding bits correctly.
4187
4251
  * @export
4188
4252
  * @enum {string}
4189
4253
  */
@@ -4211,38 +4275,38 @@ export type ProfinetIOTypeEnum = typeof ProfinetIOTypeEnum[keyof typeof Profinet
4211
4275
  */
4212
4276
  export interface ProfinetInputOutputConfig {
4213
4277
  /**
4214
- * Content of the input output configuration file.
4278
+ * Content of the input/output variable configuration XML file. The XML File has to be embedded as a string by escaping quotes, line breaks and so forth.
4215
4279
  * @type {string}
4216
4280
  * @memberof ProfinetInputOutputConfig
4217
4281
  */
4218
4282
  'config': string;
4219
4283
  /**
4220
- * Offset in bytes for the input data.
4284
+ * Offset in bytes for the address of the input (perspective of the controller) variables. The offset will be subtracted from to the byte addresses of the sent XML content.
4221
4285
  * @type {number}
4222
4286
  * @memberof ProfinetInputOutputConfig
4223
4287
  */
4224
4288
  'input_offset': number;
4225
4289
  /**
4226
- * Offset in bytes for the output data.
4290
+ * Offset in bytes for the address of the output (perspective of the controller) variables. The offset will be subtracted from to the byte addresses of the sent XML content.
4227
4291
  * @type {number}
4228
4292
  * @memberof ProfinetInputOutputConfig
4229
4293
  */
4230
4294
  'output_offset': number;
4231
4295
  }
4232
4296
  /**
4233
- *
4297
+ * An array of PROFINET slots. PROFINET models each device’s input/output hardware as a hierarchy of slots (modules) and subslots (submodules). A slot can represent a physical or virtual input/output card and each subslot one of its individual channels or functions. Every slot and subslot has unique identifiers that the controller uses to map cyclic input/output data and parameter records to its process image. This slot/subslot separation enables e.g. addressing each input/output stream when establishing input/output application relations (I/O-AR).
4234
4298
  * @export
4235
4299
  * @interface ProfinetSlotDescription
4236
4300
  */
4237
4301
  export interface ProfinetSlotDescription {
4238
4302
  /**
4239
- * The number of the PROFINET slot.
4303
+ * The number/index of the PROFINET slot. Per default, slot 0 is reserved for the device access point (DAP). Slots that are part of the cyclic input/output data exchange start at number 1.
4240
4304
  * @type {number}
4241
4305
  * @memberof ProfinetSlotDescription
4242
4306
  */
4243
4307
  'number': number;
4244
4308
  /**
4245
- * The API number of the PROFINET input, used to identify the specific API for the input.
4309
+ * The application process identifier (API) number of the PROFINET input. The API identifies the application relation (AR) that is using the slot.
4246
4310
  * @type {number}
4247
4311
  * @memberof ProfinetSlotDescription
4248
4312
  */
@@ -4261,32 +4325,180 @@ export interface ProfinetSlotDescription {
4261
4325
  */
4262
4326
  export interface ProfinetSubSlotDescription {
4263
4327
  /**
4264
- * The identifier of the PROFINET subslot.
4328
+ * The number/index of the PROFINET subslot.
4265
4329
  * @type {number}
4266
4330
  * @memberof ProfinetSubSlotDescription
4267
4331
  */
4268
4332
  'number': number;
4269
4333
  /**
4270
- * The length in bytes of the PROFINET input.
4334
+ * The amount of bytes allocated for the subslot in the input process image buffer.
4271
4335
  * @type {number}
4272
4336
  * @memberof ProfinetSubSlotDescription
4273
4337
  */
4274
4338
  'input_length': number;
4275
4339
  /**
4276
- * The length in bytes of the PROFINET output.
4340
+ * The amount of bytes allocated for the subslot in the output process image buffer.
4277
4341
  * @type {number}
4278
4342
  * @memberof ProfinetSubSlotDescription
4279
4343
  */
4280
4344
  'output_length': number;
4281
4345
  }
4282
4346
  /**
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.
4347
+ * A program is a collection of instructions that are executed in the robot cell.
4348
+ * @export
4349
+ * @interface Program
4350
+ */
4351
+ export interface Program {
4352
+ /**
4353
+ *
4354
+ * @type {string}
4355
+ * @memberof Program
4356
+ */
4357
+ 'program': string;
4358
+ /**
4359
+ *
4360
+ * @type {string}
4361
+ * @memberof Program
4362
+ */
4363
+ 'name'?: string;
4364
+ /**
4365
+ *
4366
+ * @type {string}
4367
+ * @memberof Program
4368
+ */
4369
+ 'description'?: string;
4370
+ /**
4371
+ *
4372
+ * @type {string}
4373
+ * @memberof Program
4374
+ */
4375
+ 'app': string;
4376
+ /**
4377
+ *
4378
+ * @type {object}
4379
+ * @memberof Program
4380
+ */
4381
+ 'input_schema'?: object;
4382
+ /**
4383
+ *
4384
+ * @type {object}
4385
+ * @memberof Program
4386
+ */
4387
+ 'preconditions'?: object;
4388
+ }
4389
+ /**
4390
+ * Holds the state of a program run.
4391
+ * @export
4392
+ * @interface ProgramRun
4393
+ */
4394
+ export interface ProgramRun {
4395
+ /**
4396
+ * Unique identifier of the program run
4397
+ * @type {string}
4398
+ * @memberof ProgramRun
4399
+ */
4400
+ 'run': string;
4401
+ /**
4402
+ * Unique identifier of the program
4403
+ * @type {string}
4404
+ * @memberof ProgramRun
4405
+ */
4406
+ 'program': string;
4407
+ /**
4408
+ * State of the program run
4409
+ * @type {ProgramRunState}
4410
+ * @memberof ProgramRun
4411
+ */
4412
+ 'state': ProgramRunState;
4413
+ /**
4414
+ * Logs of the program run
4415
+ * @type {string}
4416
+ * @memberof ProgramRun
4417
+ */
4418
+ 'logs'?: string;
4419
+ /**
4420
+ * Stdout of the program run
4421
+ * @type {string}
4422
+ * @memberof ProgramRun
4423
+ */
4424
+ 'stdout'?: string;
4425
+ /**
4426
+ * Stderr of the program run
4427
+ * @type {string}
4428
+ * @memberof ProgramRun
4429
+ */
4430
+ 'stderr'?: string;
4431
+ /**
4432
+ * Error message of the program run, if any
4433
+ * @type {string}
4434
+ * @memberof ProgramRun
4435
+ */
4436
+ 'error'?: string;
4437
+ /**
4438
+ * Traceback of the program run, if any
4439
+ * @type {string}
4440
+ * @memberof ProgramRun
4441
+ */
4442
+ 'traceback'?: string;
4443
+ /**
4444
+ * Start time of the program run
4445
+ * @type {string}
4446
+ * @memberof ProgramRun
4447
+ */
4448
+ 'start_time'?: string;
4449
+ /**
4450
+ * End time of the program run
4451
+ * @type {string}
4452
+ * @memberof ProgramRun
4453
+ */
4454
+ 'end_time'?: string;
4455
+ /**
4456
+ * Input data of the program run
4457
+ * @type {object}
4458
+ * @memberof ProgramRun
4459
+ */
4460
+ 'input_data'?: object;
4461
+ }
4462
+
4463
+
4464
+ /**
4465
+ * The state of a program run.
4466
+ * @export
4467
+ * @enum {string}
4468
+ */
4469
+
4470
+ export const ProgramRunState = {
4471
+ Preparing: 'PREPARING',
4472
+ Running: 'RUNNING',
4473
+ Completed: 'COMPLETED',
4474
+ Failed: 'FAILED',
4475
+ Stopped: 'STOPPED'
4476
+ } as const;
4477
+
4478
+ export type ProgramRunState = typeof ProgramRunState[keyof typeof ProgramRunState];
4479
+
4480
+
4481
+ /**
4482
+ * The state of a program run.
4483
+ * @export
4484
+ * @interface ProgramStartRequest
4485
+ */
4486
+ export interface ProgramStartRequest {
4487
+ /**
4488
+ * The arguments to pass to the program.
4489
+ * @type {object}
4490
+ * @memberof ProgramStartRequest
4491
+ */
4492
+ 'arguments': object;
4493
+ }
4494
+ /**
4495
+ *
4284
4496
  * @export
4285
4497
  * @interface RRTConnectAlgorithm
4286
4498
  */
4287
4499
  export interface RRTConnectAlgorithm {
4288
4500
  /**
4289
- * Algorithm discriminator.
4501
+ * Algorithm discriminator. 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 with JointPTP motions. 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.
4290
4502
  * @type {string}
4291
4503
  * @memberof RRTConnectAlgorithm
4292
4504
  */
@@ -4297,6 +4509,30 @@ export interface RRTConnectAlgorithm {
4297
4509
  * @memberof RRTConnectAlgorithm
4298
4510
  */
4299
4511
  'max_iterations'?: number;
4512
+ /**
4513
+ * Maximum step size for tree extension in joint space.
4514
+ * @type {number}
4515
+ * @memberof RRTConnectAlgorithm
4516
+ */
4517
+ 'max_step_size'?: number;
4518
+ /**
4519
+ * Adjust the maximum step size during the search based on the recent success rate of tree expansion.
4520
+ * @type {boolean}
4521
+ * @memberof RRTConnectAlgorithm
4522
+ */
4523
+ 'adaptive_step_size'?: boolean;
4524
+ /**
4525
+ * Apply smoothing after the search has succeeded. This will remove as many intermediate points as possible while keeping the path valid.
4526
+ * @type {boolean}
4527
+ * @memberof RRTConnectAlgorithm
4528
+ */
4529
+ 'apply_smoothing'?: boolean;
4530
+ /**
4531
+ * Apply blending after the search has succeeded and smoothing has been applied. This will apply the largest viable blending at each intermediate point.
4532
+ * @type {boolean}
4533
+ * @memberof RRTConnectAlgorithm
4534
+ */
4535
+ 'apply_blending'?: boolean;
4300
4536
  }
4301
4537
 
4302
4538
  export const RRTConnectAlgorithmAlgorithmNameEnum = {
@@ -4726,6 +4962,25 @@ export interface ServiceStatusStatus {
4726
4962
  }
4727
4963
 
4728
4964
 
4965
+ /**
4966
+ * Defines an input/output that should be set upon reaching a specified location on the trajectory.
4967
+ * @export
4968
+ * @interface SetIO
4969
+ */
4970
+ export interface SetIO {
4971
+ /**
4972
+ *
4973
+ * @type {IOValue}
4974
+ * @memberof SetIO
4975
+ */
4976
+ 'io': IOValue;
4977
+ /**
4978
+ * The location on the trajectory where the input/output should be set.
4979
+ * @type {number}
4980
+ * @memberof SetIO
4981
+ */
4982
+ 'location': number;
4983
+ }
4729
4984
  /**
4730
4985
  *
4731
4986
  * @export
@@ -4801,10 +5056,10 @@ export interface StartMovementRequest {
4801
5056
  'direction'?: Direction;
4802
5057
  /**
4803
5058
  * Attaches a list of output commands to the trajectory. The outputs are set to the specified values right after the specified location was reached. If the specified location is located before the start location (forward direction: value is smaller, backward direction: value is bigger), the output is not set.
4804
- * @type {Array<IOValue>}
5059
+ * @type {Array<SetIO>}
4805
5060
  * @memberof StartMovementRequest
4806
5061
  */
4807
- 'set_outputs'?: Array<IOValue>;
5062
+ 'set_outputs'?: Array<SetIO>;
4808
5063
  /**
4809
5064
  * Defines an input/output that is listened to before the movement. Execution starts if the defined comparator evaluates to `true`.
4810
5065
  * @type {StartOnIO}
@@ -5076,7 +5331,7 @@ export interface TrajectoryDetails {
5076
5331
  */
5077
5332
  'trajectory': string;
5078
5333
  /**
5079
- * Current location of motion group on the trajectory.
5334
+ * Location on trajectory where the execution will start. The default value is the start (forward movement) or end (backward movement) of the trajectory. If you want to start your movement from an arbitrary location, e.g. in combination with [streamMoveToTrajectoryViaJointPTP](streamMoveToTrajectoryViaJointPTP), set the location by respecting the following format: - The location is a scalar value that defines a position along a path, typically ranging from 0 to `n`, where `n` denotes the number of motion commands - Each integer value of the location corresponds to a specific motion command, while non-integer values interpolate positions within the segments. - The location is calculated from the joint path
5080
5335
  * @type {number}
5081
5336
  * @memberof TrajectoryDetails
5082
5337
  */
@@ -5105,10 +5360,10 @@ export type TrajectoryDetailsKindEnum = typeof TrajectoryDetailsKindEnum[keyof t
5105
5360
  * @type TrajectoryDetailsState
5106
5361
  * @export
5107
5362
  */
5108
- export type TrajectoryDetailsState = TrajectoryEnded | TrajectoryPausedByUser | TrajectoryPausedOnIO | TrajectoryRunning | TrajectoryWaitForIO;
5363
+ export type TrajectoryDetailsState = { kind: 'END_OF_TRAJECTORY' } & TrajectoryEnded | { kind: 'PAUSED_BY_USER' } & TrajectoryPausedByUser | { kind: 'PAUSED_ON_IO' } & TrajectoryPausedOnIO | { kind: 'RUNNING' } & TrajectoryRunning | { kind: 'WAIT_FOR_IO' } & TrajectoryWaitForIO;
5109
5364
 
5110
5365
  /**
5111
- *
5366
+ * First or last sample (depending on direction) of trajectory has been sent.
5112
5367
  * @export
5113
5368
  * @interface TrajectoryEnded
5114
5369
  */
@@ -5154,7 +5409,7 @@ export const TrajectoryIdMessageTypeEnum = {
5154
5409
  export type TrajectoryIdMessageTypeEnum = typeof TrajectoryIdMessageTypeEnum[keyof typeof TrajectoryIdMessageTypeEnum];
5155
5410
 
5156
5411
  /**
5157
- *
5412
+ * User has paused execution.
5158
5413
  * @export
5159
5414
  * @interface TrajectoryPausedByUser
5160
5415
  */
@@ -5174,7 +5429,7 @@ export const TrajectoryPausedByUserKindEnum = {
5174
5429
  export type TrajectoryPausedByUserKindEnum = typeof TrajectoryPausedByUserKindEnum[keyof typeof TrajectoryPausedByUserKindEnum];
5175
5430
 
5176
5431
  /**
5177
- *
5432
+ * Execution was paused because of an I/O event.
5178
5433
  * @export
5179
5434
  * @interface TrajectoryPausedOnIO
5180
5435
  */
@@ -5194,7 +5449,7 @@ export const TrajectoryPausedOnIOKindEnum = {
5194
5449
  export type TrajectoryPausedOnIOKindEnum = typeof TrajectoryPausedOnIOKindEnum[keyof typeof TrajectoryPausedOnIOKindEnum];
5195
5450
 
5196
5451
  /**
5197
- *
5452
+ * Trajectory is being executed.
5198
5453
  * @export
5199
5454
  * @interface TrajectoryRunning
5200
5455
  */
@@ -5220,7 +5475,7 @@ export const TrajectoryRunningKindEnum = {
5220
5475
  export type TrajectoryRunningKindEnum = typeof TrajectoryRunningKindEnum[keyof typeof TrajectoryRunningKindEnum];
5221
5476
 
5222
5477
  /**
5223
- *
5478
+ * Waiting for an I/O event to start execution.
5224
5479
  * @export
5225
5480
  * @interface TrajectoryWaitForIO
5226
5481
  */
@@ -5333,6 +5588,31 @@ export interface ValidationError {
5333
5588
  */
5334
5589
  'input': { [key: string]: any; };
5335
5590
  }
5591
+ /**
5592
+ * A validation error of a program.
5593
+ * @export
5594
+ * @interface ValidationError2
5595
+ */
5596
+ export interface ValidationError2 {
5597
+ /**
5598
+ *
5599
+ * @type {Array<number>}
5600
+ * @memberof ValidationError2
5601
+ */
5602
+ 'loc': Array<number>;
5603
+ /**
5604
+ *
5605
+ * @type {string}
5606
+ * @memberof ValidationError2
5607
+ */
5608
+ 'msg': string;
5609
+ /**
5610
+ *
5611
+ * @type {string}
5612
+ * @memberof ValidationError2
5613
+ */
5614
+ 'type': string;
5615
+ }
5336
5616
  /**
5337
5617
  * @type ValidationErrorLocInner
5338
5618
  * @export
@@ -6150,7 +6430,7 @@ export class ApplicationApi extends BaseAPI {
6150
6430
  export const BUSInputsOutputsApiAxiosParamCreator = function (configuration?: Configuration) {
6151
6431
  return {
6152
6432
  /**
6153
- * Add a BUS Inputs/Outputs Service to the cell.
6433
+ * Add the BUS inputs/outputs service to the cell. Starts a containerized service that enables BUS connections via the specified ethernet port.
6154
6434
  * @summary Add Service
6155
6435
  * @param {string} cell Unique identifier addressing a cell in all API calls.
6156
6436
  * @param {BusIOType} busIOType
@@ -6203,7 +6483,7 @@ export const BUSInputsOutputsApiAxiosParamCreator = function (configuration?: Co
6203
6483
  };
6204
6484
  },
6205
6485
  /**
6206
- * Adds an input/output to or updates an input/output on the PROFINET device.
6486
+ * Adds an input/output variable to or updates an input/output variable on the PROFINET device, e.g. NOVA\'s PROFINET service. The inputs/outputs map variables to specific memory addresses in the process image. The default process image has buffer lengths of 64 bytes for input and output. The size of the buffer is determined by the `config_file_content` that is passed in [addBusIOService](addBusIOService) and has to be in accordance with the GSDML file describing the PROFINET device. The PROFINET controller as well as NOVA\'s PROFINET service use an input/output variable configuration to interpret the bits of the input/output process image. The NOVA\'s PROFINET service\'s configuration can be viewed via [listProfinetIOs](listProfinetIOs). For the PROFINET controller, e.g. a connected PLC, refer to the corresponding third party software, e.g. TIA portal).
6207
6487
  * @summary Add PROFINET Input/Output
6208
6488
  * @param {string} cell Unique identifier addressing a cell in all API calls.
6209
6489
  * @param {string} io Unique identifier to address an Input/Output in the cell.
@@ -6255,7 +6535,7 @@ export const BUSInputsOutputsApiAxiosParamCreator = function (configuration?: Co
6255
6535
  };
6256
6536
  },
6257
6537
  /**
6258
- * Delete BUS Inputs/Outputs Service from the cell.
6538
+ * Remove the BUS inputs/outputs service from the cell.
6259
6539
  * @summary Clear Service
6260
6540
  * @param {string} cell Unique identifier addressing a cell in all API calls.
6261
6541
  * @param {number} [completionTimeout]
@@ -6302,7 +6582,7 @@ export const BUSInputsOutputsApiAxiosParamCreator = function (configuration?: Co
6302
6582
  };
6303
6583
  },
6304
6584
  /**
6305
- * Removes the input/output from the PROFINET device.
6585
+ * Removes an input/output variable configuration from the PROFINET device, e.g. NOVA\'s PROFINET service.
6306
6586
  * @summary Remove PROFINET Input/Ouptut
6307
6587
  * @param {string} cell Unique identifier addressing a cell in all API calls.
6308
6588
  * @param {string} io Unique identifier to address an Input/Output in the cell.
@@ -6348,7 +6628,7 @@ export const BUSInputsOutputsApiAxiosParamCreator = function (configuration?: Co
6348
6628
  };
6349
6629
  },
6350
6630
  /**
6351
- * Get deployed BUS Inputs/Outputs Service.
6631
+ * Get deployed BUS inputs/outputs service.
6352
6632
  * @summary Get Service
6353
6633
  * @param {string} cell Unique identifier addressing a cell in all API calls.
6354
6634
  * @param {*} [options] Override http request option.
@@ -6479,7 +6759,7 @@ export const BUSInputsOutputsApiAxiosParamCreator = function (configuration?: Co
6479
6759
  };
6480
6760
  },
6481
6761
  /**
6482
- * Get description of PROFINET
6762
+ * Get description of NOVA as a PROFINET device.
6483
6763
  * @summary Get PROFINET Description
6484
6764
  * @param {string} cell Unique identifier addressing a cell in all API calls.
6485
6765
  * @param {*} [options] Override http request option.
@@ -6521,7 +6801,7 @@ export const BUSInputsOutputsApiAxiosParamCreator = function (configuration?: Co
6521
6801
  };
6522
6802
  },
6523
6803
  /**
6524
- * Get input/output configuration of the PROFINET device as file.
6804
+ * Get input/output variable configuration of the PROFINET device, e.g. NOVA\'s PROFINET service as file. You can specify byte offsets for the input and output variable addresses to get an XML tagmap that is ready to paste to the third party software, e.g. TIA portal.
6525
6805
  * @summary PROFINET Inputs/Outputs to File
6526
6806
  * @param {string} cell Unique identifier addressing a cell in all API calls.
6527
6807
  * @param {number} [inputOffset]
@@ -6573,7 +6853,7 @@ export const BUSInputsOutputsApiAxiosParamCreator = function (configuration?: Co
6573
6853
  };
6574
6854
  },
6575
6855
  /**
6576
- * List all BUS Input/Output descriptions.
6856
+ * List all input/output descriptions for configured BUS services. The input/output descriptions contain information such as the name, the type and the unit. The input/output direction is given in perspective of the BUS service.
6577
6857
  * @summary List Descriptions
6578
6858
  * @param {string} cell Unique identifier addressing a cell in all API calls.
6579
6859
  * @param {*} [options] Override http request option.
@@ -6615,7 +6895,7 @@ export const BUSInputsOutputsApiAxiosParamCreator = function (configuration?: Co
6615
6895
  };
6616
6896
  },
6617
6897
  /**
6618
- * List all PROFINET input and outputs.
6898
+ * List descriptions for all configured input/output variables of the PROFINET service. The input/output descriptions contain information such as the name, the type and the unit. The input/output direction is given in perspective of the PROFINET Device, e.g. the configured PROFINET service. The byte and bit addresses are the locations in the PROFINET input/output process image the variable points to. The PROFINET controller as well as NOVA\'s PROFINET service use an input/output variable configuration to interpret the bits of the input and output process image. The NOVA PROFINET service\'s configuration is modified via [addProfinetIO](addProfinetIO) and [setProfinetIOsFromFile](setProfinetIOsFromFile). For the PROFINET controller, e.g. a connected PLC, refer to the corresponding third party software, e.g. TIA portal.
6619
6899
  * @summary List PROFINET Input/Output Configuration
6620
6900
  * @param {string} cell Unique identifier addressing a cell in all API calls.
6621
6901
  * @param {*} [options] Override http request option.
@@ -6705,7 +6985,7 @@ export const BUSInputsOutputsApiAxiosParamCreator = function (configuration?: Co
6705
6985
  };
6706
6986
  },
6707
6987
  /**
6708
- * Sets inputs/outputs on the PROFINET device from file.
6988
+ * Sets input/output variable configuration on the PROFINET device (i.e. NOVA\'s PROFINET service) from XML file. The inputs/outputs map variables to specific memory addresses in the process image. The default process image has buffer lengths of 64 bytes for input and output. The size of the buffer is determined by the `config_file_content` that is passed in [addBusIOService](addBusIOService) and has to be in accordance with the GSDML file describing the PROFINET device. The PROFINET controller as well as NOVA\'s PROFINET service use an input/output variable configuration to interpret the bits of the input/output process image. The NOVA\'s PROFINET service\'s configuration can be viewed via [listProfinetIOs](listProfinetIOs). For the PROFINET controller, e.g. a connected PLC, refer to the corresponding engineering system, e.g. TIA portal. You can export the variable configuration of the PROFINET controller as XML file from your engineering system, e.g. TIA portal. The endpoint is built so that the perspective of input and output (PROFINET Device\'s input is PROFINET Controller\'s output) is internally handled (PROFINET device input is PROFINET controller output), meaning that you can paste the exported XML file here without modifying.
6709
6989
  * @summary Set PROFINET Inputs/Outputs from File
6710
6990
  * @param {string} cell Unique identifier addressing a cell in all API calls.
6711
6991
  * @param {ProfinetInputOutputConfig} profinetInputOutputConfig
@@ -6763,7 +7043,7 @@ export const BUSInputsOutputsApiFp = function(configuration?: Configuration) {
6763
7043
  const localVarAxiosParamCreator = BUSInputsOutputsApiAxiosParamCreator(configuration)
6764
7044
  return {
6765
7045
  /**
6766
- * Add a BUS Inputs/Outputs Service to the cell.
7046
+ * Add the BUS inputs/outputs service to the cell. Starts a containerized service that enables BUS connections via the specified ethernet port.
6767
7047
  * @summary Add Service
6768
7048
  * @param {string} cell Unique identifier addressing a cell in all API calls.
6769
7049
  * @param {BusIOType} busIOType
@@ -6778,7 +7058,7 @@ export const BUSInputsOutputsApiFp = function(configuration?: Configuration) {
6778
7058
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
6779
7059
  },
6780
7060
  /**
6781
- * Adds an input/output to or updates an input/output on the PROFINET device.
7061
+ * Adds an input/output variable to or updates an input/output variable on the PROFINET device, e.g. NOVA\'s PROFINET service. The inputs/outputs map variables to specific memory addresses in the process image. The default process image has buffer lengths of 64 bytes for input and output. The size of the buffer is determined by the `config_file_content` that is passed in [addBusIOService](addBusIOService) and has to be in accordance with the GSDML file describing the PROFINET device. The PROFINET controller as well as NOVA\'s PROFINET service use an input/output variable configuration to interpret the bits of the input/output process image. The NOVA\'s PROFINET service\'s configuration can be viewed via [listProfinetIOs](listProfinetIOs). For the PROFINET controller, e.g. a connected PLC, refer to the corresponding third party software, e.g. TIA portal).
6782
7062
  * @summary Add PROFINET Input/Output
6783
7063
  * @param {string} cell Unique identifier addressing a cell in all API calls.
6784
7064
  * @param {string} io Unique identifier to address an Input/Output in the cell.
@@ -6793,7 +7073,7 @@ export const BUSInputsOutputsApiFp = function(configuration?: Configuration) {
6793
7073
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
6794
7074
  },
6795
7075
  /**
6796
- * Delete BUS Inputs/Outputs Service from the cell.
7076
+ * Remove the BUS inputs/outputs service from the cell.
6797
7077
  * @summary Clear Service
6798
7078
  * @param {string} cell Unique identifier addressing a cell in all API calls.
6799
7079
  * @param {number} [completionTimeout]
@@ -6807,7 +7087,7 @@ export const BUSInputsOutputsApiFp = function(configuration?: Configuration) {
6807
7087
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
6808
7088
  },
6809
7089
  /**
6810
- * Removes the input/output from the PROFINET device.
7090
+ * Removes an input/output variable configuration from the PROFINET device, e.g. NOVA\'s PROFINET service.
6811
7091
  * @summary Remove PROFINET Input/Ouptut
6812
7092
  * @param {string} cell Unique identifier addressing a cell in all API calls.
6813
7093
  * @param {string} io Unique identifier to address an Input/Output in the cell.
@@ -6821,7 +7101,7 @@ export const BUSInputsOutputsApiFp = function(configuration?: Configuration) {
6821
7101
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
6822
7102
  },
6823
7103
  /**
6824
- * Get deployed BUS Inputs/Outputs Service.
7104
+ * Get deployed BUS inputs/outputs service.
6825
7105
  * @summary Get Service
6826
7106
  * @param {string} cell Unique identifier addressing a cell in all API calls.
6827
7107
  * @param {*} [options] Override http request option.
@@ -6861,7 +7141,7 @@ export const BUSInputsOutputsApiFp = function(configuration?: Configuration) {
6861
7141
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
6862
7142
  },
6863
7143
  /**
6864
- * Get description of PROFINET
7144
+ * Get description of NOVA as a PROFINET device.
6865
7145
  * @summary Get PROFINET Description
6866
7146
  * @param {string} cell Unique identifier addressing a cell in all API calls.
6867
7147
  * @param {*} [options] Override http request option.
@@ -6874,7 +7154,7 @@ export const BUSInputsOutputsApiFp = function(configuration?: Configuration) {
6874
7154
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
6875
7155
  },
6876
7156
  /**
6877
- * Get input/output configuration of the PROFINET device as file.
7157
+ * Get input/output variable configuration of the PROFINET device, e.g. NOVA\'s PROFINET service as file. You can specify byte offsets for the input and output variable addresses to get an XML tagmap that is ready to paste to the third party software, e.g. TIA portal.
6878
7158
  * @summary PROFINET Inputs/Outputs to File
6879
7159
  * @param {string} cell Unique identifier addressing a cell in all API calls.
6880
7160
  * @param {number} [inputOffset]
@@ -6889,20 +7169,20 @@ export const BUSInputsOutputsApiFp = function(configuration?: Configuration) {
6889
7169
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
6890
7170
  },
6891
7171
  /**
6892
- * List all BUS Input/Output descriptions.
7172
+ * List all input/output descriptions for configured BUS services. The input/output descriptions contain information such as the name, the type and the unit. The input/output direction is given in perspective of the BUS service.
6893
7173
  * @summary List Descriptions
6894
7174
  * @param {string} cell Unique identifier addressing a cell in all API calls.
6895
7175
  * @param {*} [options] Override http request option.
6896
7176
  * @throws {RequiredError}
6897
7177
  */
6898
- async listBusIODescriptions(cell: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<IODescription>>> {
7178
+ async listBusIODescriptions(cell: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<IODescription2>>> {
6899
7179
  const localVarAxiosArgs = await localVarAxiosParamCreator.listBusIODescriptions(cell, options);
6900
7180
  const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
6901
7181
  const localVarOperationServerBasePath = operationServerMap['BUSInputsOutputsApi.listBusIODescriptions']?.[localVarOperationServerIndex]?.url;
6902
7182
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
6903
7183
  },
6904
7184
  /**
6905
- * List all PROFINET input and outputs.
7185
+ * List descriptions for all configured input/output variables of the PROFINET service. The input/output descriptions contain information such as the name, the type and the unit. The input/output direction is given in perspective of the PROFINET Device, e.g. the configured PROFINET service. The byte and bit addresses are the locations in the PROFINET input/output process image the variable points to. The PROFINET controller as well as NOVA\'s PROFINET service use an input/output variable configuration to interpret the bits of the input and output process image. The NOVA PROFINET service\'s configuration is modified via [addProfinetIO](addProfinetIO) and [setProfinetIOsFromFile](setProfinetIOsFromFile). For the PROFINET controller, e.g. a connected PLC, refer to the corresponding third party software, e.g. TIA portal.
6906
7186
  * @summary List PROFINET Input/Output Configuration
6907
7187
  * @param {string} cell Unique identifier addressing a cell in all API calls.
6908
7188
  * @param {*} [options] Override http request option.
@@ -6929,7 +7209,7 @@ export const BUSInputsOutputsApiFp = function(configuration?: Configuration) {
6929
7209
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
6930
7210
  },
6931
7211
  /**
6932
- * Sets inputs/outputs on the PROFINET device from file.
7212
+ * Sets input/output variable configuration on the PROFINET device (i.e. NOVA\'s PROFINET service) from XML file. The inputs/outputs map variables to specific memory addresses in the process image. The default process image has buffer lengths of 64 bytes for input and output. The size of the buffer is determined by the `config_file_content` that is passed in [addBusIOService](addBusIOService) and has to be in accordance with the GSDML file describing the PROFINET device. The PROFINET controller as well as NOVA\'s PROFINET service use an input/output variable configuration to interpret the bits of the input/output process image. The NOVA\'s PROFINET service\'s configuration can be viewed via [listProfinetIOs](listProfinetIOs). For the PROFINET controller, e.g. a connected PLC, refer to the corresponding engineering system, e.g. TIA portal. You can export the variable configuration of the PROFINET controller as XML file from your engineering system, e.g. TIA portal. The endpoint is built so that the perspective of input and output (PROFINET Device\'s input is PROFINET Controller\'s output) is internally handled (PROFINET device input is PROFINET controller output), meaning that you can paste the exported XML file here without modifying.
6933
7213
  * @summary Set PROFINET Inputs/Outputs from File
6934
7214
  * @param {string} cell Unique identifier addressing a cell in all API calls.
6935
7215
  * @param {ProfinetInputOutputConfig} profinetInputOutputConfig
@@ -6953,7 +7233,7 @@ export const BUSInputsOutputsApiFactory = function (configuration?: Configuratio
6953
7233
  const localVarFp = BUSInputsOutputsApiFp(configuration)
6954
7234
  return {
6955
7235
  /**
6956
- * Add a BUS Inputs/Outputs Service to the cell.
7236
+ * Add the BUS inputs/outputs service to the cell. Starts a containerized service that enables BUS connections via the specified ethernet port.
6957
7237
  * @summary Add Service
6958
7238
  * @param {string} cell Unique identifier addressing a cell in all API calls.
6959
7239
  * @param {BusIOType} busIOType
@@ -6965,7 +7245,7 @@ export const BUSInputsOutputsApiFactory = function (configuration?: Configuratio
6965
7245
  return localVarFp.addBusIOService(cell, busIOType, completionTimeout, options).then((request) => request(axios, basePath));
6966
7246
  },
6967
7247
  /**
6968
- * Adds an input/output to or updates an input/output on the PROFINET device.
7248
+ * Adds an input/output variable to or updates an input/output variable on the PROFINET device, e.g. NOVA\'s PROFINET service. The inputs/outputs map variables to specific memory addresses in the process image. The default process image has buffer lengths of 64 bytes for input and output. The size of the buffer is determined by the `config_file_content` that is passed in [addBusIOService](addBusIOService) and has to be in accordance with the GSDML file describing the PROFINET device. The PROFINET controller as well as NOVA\'s PROFINET service use an input/output variable configuration to interpret the bits of the input/output process image. The NOVA\'s PROFINET service\'s configuration can be viewed via [listProfinetIOs](listProfinetIOs). For the PROFINET controller, e.g. a connected PLC, refer to the corresponding third party software, e.g. TIA portal).
6969
7249
  * @summary Add PROFINET Input/Output
6970
7250
  * @param {string} cell Unique identifier addressing a cell in all API calls.
6971
7251
  * @param {string} io Unique identifier to address an Input/Output in the cell.
@@ -6977,7 +7257,7 @@ export const BUSInputsOutputsApiFactory = function (configuration?: Configuratio
6977
7257
  return localVarFp.addProfinetIO(cell, io, profinetIOData, options).then((request) => request(axios, basePath));
6978
7258
  },
6979
7259
  /**
6980
- * Delete BUS Inputs/Outputs Service from the cell.
7260
+ * Remove the BUS inputs/outputs service from the cell.
6981
7261
  * @summary Clear Service
6982
7262
  * @param {string} cell Unique identifier addressing a cell in all API calls.
6983
7263
  * @param {number} [completionTimeout]
@@ -6988,7 +7268,7 @@ export const BUSInputsOutputsApiFactory = function (configuration?: Configuratio
6988
7268
  return localVarFp.clearBusIOService(cell, completionTimeout, options).then((request) => request(axios, basePath));
6989
7269
  },
6990
7270
  /**
6991
- * Removes the input/output from the PROFINET device.
7271
+ * Removes an input/output variable configuration from the PROFINET device, e.g. NOVA\'s PROFINET service.
6992
7272
  * @summary Remove PROFINET Input/Ouptut
6993
7273
  * @param {string} cell Unique identifier addressing a cell in all API calls.
6994
7274
  * @param {string} io Unique identifier to address an Input/Output in the cell.
@@ -6999,7 +7279,7 @@ export const BUSInputsOutputsApiFactory = function (configuration?: Configuratio
6999
7279
  return localVarFp.deleteProfinetIO(cell, io, options).then((request) => request(axios, basePath));
7000
7280
  },
7001
7281
  /**
7002
- * Get deployed BUS Inputs/Outputs Service.
7282
+ * Get deployed BUS inputs/outputs service.
7003
7283
  * @summary Get Service
7004
7284
  * @param {string} cell Unique identifier addressing a cell in all API calls.
7005
7285
  * @param {*} [options] Override http request option.
@@ -7030,7 +7310,7 @@ export const BUSInputsOutputsApiFactory = function (configuration?: Configuratio
7030
7310
  return localVarFp.getBusIOValues(cell, ios, options).then((request) => request(axios, basePath));
7031
7311
  },
7032
7312
  /**
7033
- * Get description of PROFINET
7313
+ * Get description of NOVA as a PROFINET device.
7034
7314
  * @summary Get PROFINET Description
7035
7315
  * @param {string} cell Unique identifier addressing a cell in all API calls.
7036
7316
  * @param {*} [options] Override http request option.
@@ -7040,7 +7320,7 @@ export const BUSInputsOutputsApiFactory = function (configuration?: Configuratio
7040
7320
  return localVarFp.getProfinetDescription(cell, options).then((request) => request(axios, basePath));
7041
7321
  },
7042
7322
  /**
7043
- * Get input/output configuration of the PROFINET device as file.
7323
+ * Get input/output variable configuration of the PROFINET device, e.g. NOVA\'s PROFINET service as file. You can specify byte offsets for the input and output variable addresses to get an XML tagmap that is ready to paste to the third party software, e.g. TIA portal.
7044
7324
  * @summary PROFINET Inputs/Outputs to File
7045
7325
  * @param {string} cell Unique identifier addressing a cell in all API calls.
7046
7326
  * @param {number} [inputOffset]
@@ -7052,17 +7332,17 @@ export const BUSInputsOutputsApiFactory = function (configuration?: Configuratio
7052
7332
  return localVarFp.getProfinetIOsFromFile(cell, inputOffset, outputOffset, options).then((request) => request(axios, basePath));
7053
7333
  },
7054
7334
  /**
7055
- * List all BUS Input/Output descriptions.
7335
+ * List all input/output descriptions for configured BUS services. The input/output descriptions contain information such as the name, the type and the unit. The input/output direction is given in perspective of the BUS service.
7056
7336
  * @summary List Descriptions
7057
7337
  * @param {string} cell Unique identifier addressing a cell in all API calls.
7058
7338
  * @param {*} [options] Override http request option.
7059
7339
  * @throws {RequiredError}
7060
7340
  */
7061
- listBusIODescriptions(cell: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<IODescription>> {
7341
+ listBusIODescriptions(cell: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<IODescription2>> {
7062
7342
  return localVarFp.listBusIODescriptions(cell, options).then((request) => request(axios, basePath));
7063
7343
  },
7064
7344
  /**
7065
- * List all PROFINET input and outputs.
7345
+ * List descriptions for all configured input/output variables of the PROFINET service. The input/output descriptions contain information such as the name, the type and the unit. The input/output direction is given in perspective of the PROFINET Device, e.g. the configured PROFINET service. The byte and bit addresses are the locations in the PROFINET input/output process image the variable points to. The PROFINET controller as well as NOVA\'s PROFINET service use an input/output variable configuration to interpret the bits of the input and output process image. The NOVA PROFINET service\'s configuration is modified via [addProfinetIO](addProfinetIO) and [setProfinetIOsFromFile](setProfinetIOsFromFile). For the PROFINET controller, e.g. a connected PLC, refer to the corresponding third party software, e.g. TIA portal.
7066
7346
  * @summary List PROFINET Input/Output Configuration
7067
7347
  * @param {string} cell Unique identifier addressing a cell in all API calls.
7068
7348
  * @param {*} [options] Override http request option.
@@ -7083,7 +7363,7 @@ export const BUSInputsOutputsApiFactory = function (configuration?: Configuratio
7083
7363
  return localVarFp.setBusIOValues(cell, iOValue, options).then((request) => request(axios, basePath));
7084
7364
  },
7085
7365
  /**
7086
- * Sets inputs/outputs on the PROFINET device from file.
7366
+ * Sets input/output variable configuration on the PROFINET device (i.e. NOVA\'s PROFINET service) from XML file. The inputs/outputs map variables to specific memory addresses in the process image. The default process image has buffer lengths of 64 bytes for input and output. The size of the buffer is determined by the `config_file_content` that is passed in [addBusIOService](addBusIOService) and has to be in accordance with the GSDML file describing the PROFINET device. The PROFINET controller as well as NOVA\'s PROFINET service use an input/output variable configuration to interpret the bits of the input/output process image. The NOVA\'s PROFINET service\'s configuration can be viewed via [listProfinetIOs](listProfinetIOs). For the PROFINET controller, e.g. a connected PLC, refer to the corresponding engineering system, e.g. TIA portal. You can export the variable configuration of the PROFINET controller as XML file from your engineering system, e.g. TIA portal. The endpoint is built so that the perspective of input and output (PROFINET Device\'s input is PROFINET Controller\'s output) is internally handled (PROFINET device input is PROFINET controller output), meaning that you can paste the exported XML file here without modifying.
7087
7367
  * @summary Set PROFINET Inputs/Outputs from File
7088
7368
  * @param {string} cell Unique identifier addressing a cell in all API calls.
7089
7369
  * @param {ProfinetInputOutputConfig} profinetInputOutputConfig
@@ -7104,7 +7384,7 @@ export const BUSInputsOutputsApiFactory = function (configuration?: Configuratio
7104
7384
  */
7105
7385
  export class BUSInputsOutputsApi extends BaseAPI {
7106
7386
  /**
7107
- * Add a BUS Inputs/Outputs Service to the cell.
7387
+ * Add the BUS inputs/outputs service to the cell. Starts a containerized service that enables BUS connections via the specified ethernet port.
7108
7388
  * @summary Add Service
7109
7389
  * @param {string} cell Unique identifier addressing a cell in all API calls.
7110
7390
  * @param {BusIOType} busIOType
@@ -7118,7 +7398,7 @@ export class BUSInputsOutputsApi extends BaseAPI {
7118
7398
  }
7119
7399
 
7120
7400
  /**
7121
- * Adds an input/output to or updates an input/output on the PROFINET device.
7401
+ * Adds an input/output variable to or updates an input/output variable on the PROFINET device, e.g. NOVA\'s PROFINET service. The inputs/outputs map variables to specific memory addresses in the process image. The default process image has buffer lengths of 64 bytes for input and output. The size of the buffer is determined by the `config_file_content` that is passed in [addBusIOService](addBusIOService) and has to be in accordance with the GSDML file describing the PROFINET device. The PROFINET controller as well as NOVA\'s PROFINET service use an input/output variable configuration to interpret the bits of the input/output process image. The NOVA\'s PROFINET service\'s configuration can be viewed via [listProfinetIOs](listProfinetIOs). For the PROFINET controller, e.g. a connected PLC, refer to the corresponding third party software, e.g. TIA portal).
7122
7402
  * @summary Add PROFINET Input/Output
7123
7403
  * @param {string} cell Unique identifier addressing a cell in all API calls.
7124
7404
  * @param {string} io Unique identifier to address an Input/Output in the cell.
@@ -7132,7 +7412,7 @@ export class BUSInputsOutputsApi extends BaseAPI {
7132
7412
  }
7133
7413
 
7134
7414
  /**
7135
- * Delete BUS Inputs/Outputs Service from the cell.
7415
+ * Remove the BUS inputs/outputs service from the cell.
7136
7416
  * @summary Clear Service
7137
7417
  * @param {string} cell Unique identifier addressing a cell in all API calls.
7138
7418
  * @param {number} [completionTimeout]
@@ -7145,7 +7425,7 @@ export class BUSInputsOutputsApi extends BaseAPI {
7145
7425
  }
7146
7426
 
7147
7427
  /**
7148
- * Removes the input/output from the PROFINET device.
7428
+ * Removes an input/output variable configuration from the PROFINET device, e.g. NOVA\'s PROFINET service.
7149
7429
  * @summary Remove PROFINET Input/Ouptut
7150
7430
  * @param {string} cell Unique identifier addressing a cell in all API calls.
7151
7431
  * @param {string} io Unique identifier to address an Input/Output in the cell.
@@ -7158,7 +7438,7 @@ export class BUSInputsOutputsApi extends BaseAPI {
7158
7438
  }
7159
7439
 
7160
7440
  /**
7161
- * Get deployed BUS Inputs/Outputs Service.
7441
+ * Get deployed BUS inputs/outputs service.
7162
7442
  * @summary Get Service
7163
7443
  * @param {string} cell Unique identifier addressing a cell in all API calls.
7164
7444
  * @param {*} [options] Override http request option.
@@ -7195,7 +7475,7 @@ export class BUSInputsOutputsApi extends BaseAPI {
7195
7475
  }
7196
7476
 
7197
7477
  /**
7198
- * Get description of PROFINET
7478
+ * Get description of NOVA as a PROFINET device.
7199
7479
  * @summary Get PROFINET Description
7200
7480
  * @param {string} cell Unique identifier addressing a cell in all API calls.
7201
7481
  * @param {*} [options] Override http request option.
@@ -7207,7 +7487,7 @@ export class BUSInputsOutputsApi extends BaseAPI {
7207
7487
  }
7208
7488
 
7209
7489
  /**
7210
- * Get input/output configuration of the PROFINET device as file.
7490
+ * Get input/output variable configuration of the PROFINET device, e.g. NOVA\'s PROFINET service as file. You can specify byte offsets for the input and output variable addresses to get an XML tagmap that is ready to paste to the third party software, e.g. TIA portal.
7211
7491
  * @summary PROFINET Inputs/Outputs to File
7212
7492
  * @param {string} cell Unique identifier addressing a cell in all API calls.
7213
7493
  * @param {number} [inputOffset]
@@ -7221,7 +7501,7 @@ export class BUSInputsOutputsApi extends BaseAPI {
7221
7501
  }
7222
7502
 
7223
7503
  /**
7224
- * List all BUS Input/Output descriptions.
7504
+ * List all input/output descriptions for configured BUS services. The input/output descriptions contain information such as the name, the type and the unit. The input/output direction is given in perspective of the BUS service.
7225
7505
  * @summary List Descriptions
7226
7506
  * @param {string} cell Unique identifier addressing a cell in all API calls.
7227
7507
  * @param {*} [options] Override http request option.
@@ -7233,7 +7513,7 @@ export class BUSInputsOutputsApi extends BaseAPI {
7233
7513
  }
7234
7514
 
7235
7515
  /**
7236
- * List all PROFINET input and outputs.
7516
+ * List descriptions for all configured input/output variables of the PROFINET service. The input/output descriptions contain information such as the name, the type and the unit. The input/output direction is given in perspective of the PROFINET Device, e.g. the configured PROFINET service. The byte and bit addresses are the locations in the PROFINET input/output process image the variable points to. The PROFINET controller as well as NOVA\'s PROFINET service use an input/output variable configuration to interpret the bits of the input and output process image. The NOVA PROFINET service\'s configuration is modified via [addProfinetIO](addProfinetIO) and [setProfinetIOsFromFile](setProfinetIOsFromFile). For the PROFINET controller, e.g. a connected PLC, refer to the corresponding third party software, e.g. TIA portal.
7237
7517
  * @summary List PROFINET Input/Output Configuration
7238
7518
  * @param {string} cell Unique identifier addressing a cell in all API calls.
7239
7519
  * @param {*} [options] Override http request option.
@@ -7258,7 +7538,7 @@ export class BUSInputsOutputsApi extends BaseAPI {
7258
7538
  }
7259
7539
 
7260
7540
  /**
7261
- * Sets inputs/outputs on the PROFINET device from file.
7541
+ * Sets input/output variable configuration on the PROFINET device (i.e. NOVA\'s PROFINET service) from XML file. The inputs/outputs map variables to specific memory addresses in the process image. The default process image has buffer lengths of 64 bytes for input and output. The size of the buffer is determined by the `config_file_content` that is passed in [addBusIOService](addBusIOService) and has to be in accordance with the GSDML file describing the PROFINET device. The PROFINET controller as well as NOVA\'s PROFINET service use an input/output variable configuration to interpret the bits of the input/output process image. The NOVA\'s PROFINET service\'s configuration can be viewed via [listProfinetIOs](listProfinetIOs). For the PROFINET controller, e.g. a connected PLC, refer to the corresponding engineering system, e.g. TIA portal. You can export the variable configuration of the PROFINET controller as XML file from your engineering system, e.g. TIA portal. The endpoint is built so that the perspective of input and output (PROFINET Device\'s input is PROFINET Controller\'s output) is internally handled (PROFINET device input is PROFINET controller output), meaning that you can paste the exported XML file here without modifying.
7262
7542
  * @summary Set PROFINET Inputs/Outputs from File
7263
7543
  * @param {string} cell Unique identifier addressing a cell in all API calls.
7264
7544
  * @param {ProfinetInputOutputConfig} profinetInputOutputConfig
@@ -10725,7 +11005,7 @@ export class MotionGroupApi extends BaseAPI {
10725
11005
  export const MotionGroupModelsApiAxiosParamCreator = function (configuration?: Configuration) {
10726
11006
  return {
10727
11007
  /**
10728
- * Returns the default collision link chain for a given motion group model. See [getMotionGroupDescription](getMotionGroupDescription) for supported motion group models. The default link chain is derived from 3D models and optimized for collision detection within NOVA. The default link chain includes link shapes only. It does not include any attached components like wire feeders or sensors. Use the `stored_link_chain` or `link_chain` field in [storeCollisionScene](storeCollisionScene) to attach additional shapes to the link reference frames. Additional shapes may overlap each other per link and may also overlap the respective link\'s default shape.
11008
+ * Returns the default collision link chain for a given motion group model. See [getMotionGroupModels](getMotionGroupModels) for supported motion group models. The default link chain is derived from 3D models and optimized for collision detection within NOVA. The default link chain includes link shapes only. It does not include any attached components like wire feeders or sensors. Attach additional shapes to the link reference frames by extending the link dictionaries before further use. Additional shapes may overlap each other per link and may also overlap the respective link\'s default shape.
10729
11009
  * @summary Get Collision Model
10730
11010
  * @param {string} cell Unique identifier addressing a cell in all API calls.
10731
11011
  * @param {string} motionGroupModel Unique identifier for the model of a motion group, e.g. &#x60;UniversalRobots_UR10e&#x60;. Get the &#x60;model&#x60; of a configured motion group with [getOptimizerConfiguration](getOptimizerConfiguration).
@@ -10823,7 +11103,7 @@ export const MotionGroupModelsApiFp = function(configuration?: Configuration) {
10823
11103
  const localVarAxiosParamCreator = MotionGroupModelsApiAxiosParamCreator(configuration)
10824
11104
  return {
10825
11105
  /**
10826
- * Returns the default collision link chain for a given motion group model. See [getMotionGroupDescription](getMotionGroupDescription) for supported motion group models. The default link chain is derived from 3D models and optimized for collision detection within NOVA. The default link chain includes link shapes only. It does not include any attached components like wire feeders or sensors. Use the `stored_link_chain` or `link_chain` field in [storeCollisionScene](storeCollisionScene) to attach additional shapes to the link reference frames. Additional shapes may overlap each other per link and may also overlap the respective link\'s default shape.
11106
+ * Returns the default collision link chain for a given motion group model. See [getMotionGroupModels](getMotionGroupModels) for supported motion group models. The default link chain is derived from 3D models and optimized for collision detection within NOVA. The default link chain includes link shapes only. It does not include any attached components like wire feeders or sensors. Attach additional shapes to the link reference frames by extending the link dictionaries before further use. Additional shapes may overlap each other per link and may also overlap the respective link\'s default shape.
10827
11107
  * @summary Get Collision Model
10828
11108
  * @param {string} cell Unique identifier addressing a cell in all API calls.
10829
11109
  * @param {string} motionGroupModel Unique identifier for the model of a motion group, e.g. &#x60;UniversalRobots_UR10e&#x60;. Get the &#x60;model&#x60; of a configured motion group with [getOptimizerConfiguration](getOptimizerConfiguration).
@@ -10860,7 +11140,7 @@ export const MotionGroupModelsApiFactory = function (configuration?: Configurati
10860
11140
  const localVarFp = MotionGroupModelsApiFp(configuration)
10861
11141
  return {
10862
11142
  /**
10863
- * Returns the default collision link chain for a given motion group model. See [getMotionGroupDescription](getMotionGroupDescription) for supported motion group models. The default link chain is derived from 3D models and optimized for collision detection within NOVA. The default link chain includes link shapes only. It does not include any attached components like wire feeders or sensors. Use the `stored_link_chain` or `link_chain` field in [storeCollisionScene](storeCollisionScene) to attach additional shapes to the link reference frames. Additional shapes may overlap each other per link and may also overlap the respective link\'s default shape.
11143
+ * Returns the default collision link chain for a given motion group model. See [getMotionGroupModels](getMotionGroupModels) for supported motion group models. The default link chain is derived from 3D models and optimized for collision detection within NOVA. The default link chain includes link shapes only. It does not include any attached components like wire feeders or sensors. Attach additional shapes to the link reference frames by extending the link dictionaries before further use. Additional shapes may overlap each other per link and may also overlap the respective link\'s default shape.
10864
11144
  * @summary Get Collision Model
10865
11145
  * @param {string} cell Unique identifier addressing a cell in all API calls.
10866
11146
  * @param {string} motionGroupModel Unique identifier for the model of a motion group, e.g. &#x60;UniversalRobots_UR10e&#x60;. Get the &#x60;model&#x60; of a configured motion group with [getOptimizerConfiguration](getOptimizerConfiguration).
@@ -10891,7 +11171,7 @@ export const MotionGroupModelsApiFactory = function (configuration?: Configurati
10891
11171
  */
10892
11172
  export class MotionGroupModelsApi extends BaseAPI {
10893
11173
  /**
10894
- * Returns the default collision link chain for a given motion group model. See [getMotionGroupDescription](getMotionGroupDescription) for supported motion group models. The default link chain is derived from 3D models and optimized for collision detection within NOVA. The default link chain includes link shapes only. It does not include any attached components like wire feeders or sensors. Use the `stored_link_chain` or `link_chain` field in [storeCollisionScene](storeCollisionScene) to attach additional shapes to the link reference frames. Additional shapes may overlap each other per link and may also overlap the respective link\'s default shape.
11174
+ * Returns the default collision link chain for a given motion group model. See [getMotionGroupModels](getMotionGroupModels) for supported motion group models. The default link chain is derived from 3D models and optimized for collision detection within NOVA. The default link chain includes link shapes only. It does not include any attached components like wire feeders or sensors. Attach additional shapes to the link reference frames by extending the link dictionaries before further use. Additional shapes may overlap each other per link and may also overlap the respective link\'s default shape.
10895
11175
  * @summary Get Collision Model
10896
11176
  * @param {string} cell Unique identifier addressing a cell in all API calls.
10897
11177
  * @param {string} motionGroupModel Unique identifier for the model of a motion group, e.g. &#x60;UniversalRobots_UR10e&#x60;. Get the &#x60;model&#x60; of a configured motion group with [getOptimizerConfiguration](getOptimizerConfiguration).
@@ -10918,6 +11198,383 @@ export class MotionGroupModelsApi extends BaseAPI {
10918
11198
 
10919
11199
 
10920
11200
 
11201
+ /**
11202
+ * ProgramApi - axios parameter creator
11203
+ * @export
11204
+ */
11205
+ export const ProgramApiAxiosParamCreator = function (configuration?: Configuration) {
11206
+ return {
11207
+ /**
11208
+ * Get details of a program.
11209
+ * @summary Get program
11210
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
11211
+ * @param {string} program
11212
+ * @param {*} [options] Override http request option.
11213
+ * @throws {RequiredError}
11214
+ */
11215
+ getProgram: async (cell: string, program: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
11216
+ // verify required parameter 'cell' is not null or undefined
11217
+ assertParamExists('getProgram', 'cell', cell)
11218
+ // verify required parameter 'program' is not null or undefined
11219
+ assertParamExists('getProgram', 'program', program)
11220
+ const localVarPath = `/experimental/cells/{cell}/programs/{program}`
11221
+ .replace(`{${"cell"}}`, encodeURIComponent(String(cell)))
11222
+ .replace(`{${"program"}}`, encodeURIComponent(String(program)));
11223
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
11224
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
11225
+ let baseOptions;
11226
+ if (configuration) {
11227
+ baseOptions = configuration.baseOptions;
11228
+ }
11229
+
11230
+ const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
11231
+ const localVarHeaderParameter = {} as any;
11232
+ const localVarQueryParameter = {} as any;
11233
+
11234
+ // authentication BasicAuth required
11235
+ // http basic authentication required
11236
+ setBasicAuthToObject(localVarRequestOptions, configuration)
11237
+
11238
+ // authentication BearerAuth required
11239
+ // http bearer authentication required
11240
+ await setBearerAuthToObject(localVarHeaderParameter, configuration)
11241
+
11242
+
11243
+
11244
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
11245
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
11246
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
11247
+
11248
+ return {
11249
+ url: toPathString(localVarUrlObj),
11250
+ options: localVarRequestOptions,
11251
+ };
11252
+ },
11253
+ /**
11254
+ * List details of all existing programs.
11255
+ * @summary List programs
11256
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
11257
+ * @param {*} [options] Override http request option.
11258
+ * @throws {RequiredError}
11259
+ */
11260
+ listPrograms: async (cell: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
11261
+ // verify required parameter 'cell' is not null or undefined
11262
+ assertParamExists('listPrograms', 'cell', cell)
11263
+ const localVarPath = `/experimental/cells/{cell}/programs`
11264
+ .replace(`{${"cell"}}`, encodeURIComponent(String(cell)));
11265
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
11266
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
11267
+ let baseOptions;
11268
+ if (configuration) {
11269
+ baseOptions = configuration.baseOptions;
11270
+ }
11271
+
11272
+ const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
11273
+ const localVarHeaderParameter = {} as any;
11274
+ const localVarQueryParameter = {} as any;
11275
+
11276
+ // authentication BasicAuth required
11277
+ // http basic authentication required
11278
+ setBasicAuthToObject(localVarRequestOptions, configuration)
11279
+
11280
+ // authentication BearerAuth required
11281
+ // http bearer authentication required
11282
+ await setBearerAuthToObject(localVarHeaderParameter, configuration)
11283
+
11284
+
11285
+
11286
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
11287
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
11288
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
11289
+
11290
+ return {
11291
+ url: toPathString(localVarUrlObj),
11292
+ options: localVarRequestOptions,
11293
+ };
11294
+ },
11295
+ /**
11296
+ * This endpoint starts a new program execution. The program will be executed asynchronously.
11297
+ * @summary Start the program
11298
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
11299
+ * @param {string} program
11300
+ * @param {ProgramStartRequest} programStartRequest
11301
+ * @param {*} [options] Override http request option.
11302
+ * @throws {RequiredError}
11303
+ */
11304
+ startProgram: async (cell: string, program: string, programStartRequest: ProgramStartRequest, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
11305
+ // verify required parameter 'cell' is not null or undefined
11306
+ assertParamExists('startProgram', 'cell', cell)
11307
+ // verify required parameter 'program' is not null or undefined
11308
+ assertParamExists('startProgram', 'program', program)
11309
+ // verify required parameter 'programStartRequest' is not null or undefined
11310
+ assertParamExists('startProgram', 'programStartRequest', programStartRequest)
11311
+ const localVarPath = `/experimental/cells/{cell}/programs/{program}/start`
11312
+ .replace(`{${"cell"}}`, encodeURIComponent(String(cell)))
11313
+ .replace(`{${"program"}}`, encodeURIComponent(String(program)));
11314
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
11315
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
11316
+ let baseOptions;
11317
+ if (configuration) {
11318
+ baseOptions = configuration.baseOptions;
11319
+ }
11320
+
11321
+ const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
11322
+ const localVarHeaderParameter = {} as any;
11323
+ const localVarQueryParameter = {} as any;
11324
+
11325
+ // authentication BasicAuth required
11326
+ // http basic authentication required
11327
+ setBasicAuthToObject(localVarRequestOptions, configuration)
11328
+
11329
+ // authentication BearerAuth required
11330
+ // http bearer authentication required
11331
+ await setBearerAuthToObject(localVarHeaderParameter, configuration)
11332
+
11333
+
11334
+
11335
+ localVarHeaderParameter['Content-Type'] = 'application/json';
11336
+
11337
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
11338
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
11339
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
11340
+ localVarRequestOptions.data = serializeDataIfNeeded(programStartRequest, localVarRequestOptions, configuration)
11341
+
11342
+ return {
11343
+ url: toPathString(localVarUrlObj),
11344
+ options: localVarRequestOptions,
11345
+ };
11346
+ },
11347
+ /**
11348
+ * Stop a specific program run.
11349
+ * @summary Stop program run
11350
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
11351
+ * @param {string} program
11352
+ * @param {*} [options] Override http request option.
11353
+ * @throws {RequiredError}
11354
+ */
11355
+ stopProgram: async (cell: string, program: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
11356
+ // verify required parameter 'cell' is not null or undefined
11357
+ assertParamExists('stopProgram', 'cell', cell)
11358
+ // verify required parameter 'program' is not null or undefined
11359
+ assertParamExists('stopProgram', 'program', program)
11360
+ const localVarPath = `/experimental/cells/{cell}/programs/{program}/stop`
11361
+ .replace(`{${"cell"}}`, encodeURIComponent(String(cell)))
11362
+ .replace(`{${"program"}}`, encodeURIComponent(String(program)));
11363
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
11364
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
11365
+ let baseOptions;
11366
+ if (configuration) {
11367
+ baseOptions = configuration.baseOptions;
11368
+ }
11369
+
11370
+ const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
11371
+ const localVarHeaderParameter = {} as any;
11372
+ const localVarQueryParameter = {} as any;
11373
+
11374
+ // authentication BasicAuth required
11375
+ // http basic authentication required
11376
+ setBasicAuthToObject(localVarRequestOptions, configuration)
11377
+
11378
+ // authentication BearerAuth required
11379
+ // http bearer authentication required
11380
+ await setBearerAuthToObject(localVarHeaderParameter, configuration)
11381
+
11382
+
11383
+
11384
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
11385
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
11386
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
11387
+
11388
+ return {
11389
+ url: toPathString(localVarUrlObj),
11390
+ options: localVarRequestOptions,
11391
+ };
11392
+ },
11393
+ }
11394
+ };
11395
+
11396
+ /**
11397
+ * ProgramApi - functional programming interface
11398
+ * @export
11399
+ */
11400
+ export const ProgramApiFp = function(configuration?: Configuration) {
11401
+ const localVarAxiosParamCreator = ProgramApiAxiosParamCreator(configuration)
11402
+ return {
11403
+ /**
11404
+ * Get details of a program.
11405
+ * @summary Get program
11406
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
11407
+ * @param {string} program
11408
+ * @param {*} [options] Override http request option.
11409
+ * @throws {RequiredError}
11410
+ */
11411
+ async getProgram(cell: string, program: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Program>> {
11412
+ const localVarAxiosArgs = await localVarAxiosParamCreator.getProgram(cell, program, options);
11413
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
11414
+ const localVarOperationServerBasePath = operationServerMap['ProgramApi.getProgram']?.[localVarOperationServerIndex]?.url;
11415
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
11416
+ },
11417
+ /**
11418
+ * List details of all existing programs.
11419
+ * @summary List programs
11420
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
11421
+ * @param {*} [options] Override http request option.
11422
+ * @throws {RequiredError}
11423
+ */
11424
+ async listPrograms(cell: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<Program>>> {
11425
+ const localVarAxiosArgs = await localVarAxiosParamCreator.listPrograms(cell, options);
11426
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
11427
+ const localVarOperationServerBasePath = operationServerMap['ProgramApi.listPrograms']?.[localVarOperationServerIndex]?.url;
11428
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
11429
+ },
11430
+ /**
11431
+ * This endpoint starts a new program execution. The program will be executed asynchronously.
11432
+ * @summary Start the program
11433
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
11434
+ * @param {string} program
11435
+ * @param {ProgramStartRequest} programStartRequest
11436
+ * @param {*} [options] Override http request option.
11437
+ * @throws {RequiredError}
11438
+ */
11439
+ async startProgram(cell: string, program: string, programStartRequest: ProgramStartRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ProgramRun>> {
11440
+ const localVarAxiosArgs = await localVarAxiosParamCreator.startProgram(cell, program, programStartRequest, options);
11441
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
11442
+ const localVarOperationServerBasePath = operationServerMap['ProgramApi.startProgram']?.[localVarOperationServerIndex]?.url;
11443
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
11444
+ },
11445
+ /**
11446
+ * Stop a specific program run.
11447
+ * @summary Stop program run
11448
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
11449
+ * @param {string} program
11450
+ * @param {*} [options] Override http request option.
11451
+ * @throws {RequiredError}
11452
+ */
11453
+ async stopProgram(cell: string, program: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> {
11454
+ const localVarAxiosArgs = await localVarAxiosParamCreator.stopProgram(cell, program, options);
11455
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
11456
+ const localVarOperationServerBasePath = operationServerMap['ProgramApi.stopProgram']?.[localVarOperationServerIndex]?.url;
11457
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
11458
+ },
11459
+ }
11460
+ };
11461
+
11462
+ /**
11463
+ * ProgramApi - factory interface
11464
+ * @export
11465
+ */
11466
+ export const ProgramApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
11467
+ const localVarFp = ProgramApiFp(configuration)
11468
+ return {
11469
+ /**
11470
+ * Get details of a program.
11471
+ * @summary Get program
11472
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
11473
+ * @param {string} program
11474
+ * @param {*} [options] Override http request option.
11475
+ * @throws {RequiredError}
11476
+ */
11477
+ getProgram(cell: string, program: string, options?: RawAxiosRequestConfig): AxiosPromise<Program> {
11478
+ return localVarFp.getProgram(cell, program, options).then((request) => request(axios, basePath));
11479
+ },
11480
+ /**
11481
+ * List details of all existing programs.
11482
+ * @summary List programs
11483
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
11484
+ * @param {*} [options] Override http request option.
11485
+ * @throws {RequiredError}
11486
+ */
11487
+ listPrograms(cell: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<Program>> {
11488
+ return localVarFp.listPrograms(cell, options).then((request) => request(axios, basePath));
11489
+ },
11490
+ /**
11491
+ * This endpoint starts a new program execution. The program will be executed asynchronously.
11492
+ * @summary Start the program
11493
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
11494
+ * @param {string} program
11495
+ * @param {ProgramStartRequest} programStartRequest
11496
+ * @param {*} [options] Override http request option.
11497
+ * @throws {RequiredError}
11498
+ */
11499
+ startProgram(cell: string, program: string, programStartRequest: ProgramStartRequest, options?: RawAxiosRequestConfig): AxiosPromise<ProgramRun> {
11500
+ return localVarFp.startProgram(cell, program, programStartRequest, options).then((request) => request(axios, basePath));
11501
+ },
11502
+ /**
11503
+ * Stop a specific program run.
11504
+ * @summary Stop program run
11505
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
11506
+ * @param {string} program
11507
+ * @param {*} [options] Override http request option.
11508
+ * @throws {RequiredError}
11509
+ */
11510
+ stopProgram(cell: string, program: string, options?: RawAxiosRequestConfig): AxiosPromise<void> {
11511
+ return localVarFp.stopProgram(cell, program, options).then((request) => request(axios, basePath));
11512
+ },
11513
+ };
11514
+ };
11515
+
11516
+ /**
11517
+ * ProgramApi - object-oriented interface
11518
+ * @export
11519
+ * @class ProgramApi
11520
+ * @extends {BaseAPI}
11521
+ */
11522
+ export class ProgramApi extends BaseAPI {
11523
+ /**
11524
+ * Get details of a program.
11525
+ * @summary Get program
11526
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
11527
+ * @param {string} program
11528
+ * @param {*} [options] Override http request option.
11529
+ * @throws {RequiredError}
11530
+ * @memberof ProgramApi
11531
+ */
11532
+ public getProgram(cell: string, program: string, options?: RawAxiosRequestConfig) {
11533
+ return ProgramApiFp(this.configuration).getProgram(cell, program, options).then((request) => request(this.axios, this.basePath));
11534
+ }
11535
+
11536
+ /**
11537
+ * List details of all existing programs.
11538
+ * @summary List programs
11539
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
11540
+ * @param {*} [options] Override http request option.
11541
+ * @throws {RequiredError}
11542
+ * @memberof ProgramApi
11543
+ */
11544
+ public listPrograms(cell: string, options?: RawAxiosRequestConfig) {
11545
+ return ProgramApiFp(this.configuration).listPrograms(cell, options).then((request) => request(this.axios, this.basePath));
11546
+ }
11547
+
11548
+ /**
11549
+ * This endpoint starts a new program execution. The program will be executed asynchronously.
11550
+ * @summary Start the program
11551
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
11552
+ * @param {string} program
11553
+ * @param {ProgramStartRequest} programStartRequest
11554
+ * @param {*} [options] Override http request option.
11555
+ * @throws {RequiredError}
11556
+ * @memberof ProgramApi
11557
+ */
11558
+ public startProgram(cell: string, program: string, programStartRequest: ProgramStartRequest, options?: RawAxiosRequestConfig) {
11559
+ return ProgramApiFp(this.configuration).startProgram(cell, program, programStartRequest, options).then((request) => request(this.axios, this.basePath));
11560
+ }
11561
+
11562
+ /**
11563
+ * Stop a specific program run.
11564
+ * @summary Stop program run
11565
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
11566
+ * @param {string} program
11567
+ * @param {*} [options] Override http request option.
11568
+ * @throws {RequiredError}
11569
+ * @memberof ProgramApi
11570
+ */
11571
+ public stopProgram(cell: string, program: string, options?: RawAxiosRequestConfig) {
11572
+ return ProgramApiFp(this.configuration).stopProgram(cell, program, options).then((request) => request(this.axios, this.basePath));
11573
+ }
11574
+ }
11575
+
11576
+
11577
+
10921
11578
  /**
10922
11579
  * StoreCollisionComponentsApi - axios parameter creator
10923
11580
  * @export
@@ -11243,7 +11900,7 @@ export const StoreCollisionComponentsApiAxiosParamCreator = function (configurat
11243
11900
  };
11244
11901
  },
11245
11902
  /**
11246
- * Returns a list of colliders in a scene. This excludes colliders that are part of a motion group.
11903
+ * Returns all stored colliders.
11247
11904
  * @summary List Colliders
11248
11905
  * @param {string} cell Unique identifier addressing a cell in all API calls.
11249
11906
  * @param {*} [options] Override http request option.
@@ -11590,7 +12247,7 @@ export const StoreCollisionComponentsApiFp = function(configuration?: Configurat
11590
12247
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
11591
12248
  },
11592
12249
  /**
11593
- * Returns a list of colliders in a scene. This excludes colliders that are part of a motion group.
12250
+ * Returns all stored colliders.
11594
12251
  * @summary List Colliders
11595
12252
  * @param {string} cell Unique identifier addressing a cell in all API calls.
11596
12253
  * @param {*} [options] Override http request option.
@@ -11747,7 +12404,7 @@ export const StoreCollisionComponentsApiFactory = function (configuration?: Conf
11747
12404
  return localVarFp.listCollisionLinkChains(cell, options).then((request) => request(axios, basePath));
11748
12405
  },
11749
12406
  /**
11750
- * Returns a list of colliders in a scene. This excludes colliders that are part of a motion group.
12407
+ * Returns all stored colliders.
11751
12408
  * @summary List Colliders
11752
12409
  * @param {string} cell Unique identifier addressing a cell in all API calls.
11753
12410
  * @param {*} [options] Override http request option.
@@ -11903,7 +12560,7 @@ export class StoreCollisionComponentsApi extends BaseAPI {
11903
12560
  }
11904
12561
 
11905
12562
  /**
11906
- * Returns a list of colliders in a scene. This excludes colliders that are part of a motion group.
12563
+ * Returns all stored colliders.
11907
12564
  * @summary List Colliders
11908
12565
  * @param {string} cell Unique identifier addressing a cell in all API calls.
11909
12566
  * @param {*} [options] Override http request option.