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

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
  */
@@ -2068,24 +2132,12 @@ export interface InitializeJoggingRequest {
2068
2132
  * @memberof InitializeJoggingRequest
2069
2133
  */
2070
2134
  'tcp'?: string;
2071
- /**
2072
- * Update rate for the response message in milliseconds (ms). Recommendation: As Wandelbots NOVA updates states in the controller\'s step rate, use either the controller\'s step rate or a multiple of it. Wandelbots NOVA will not interpolate the state but round it to the nearest step rate below the configured response rate. Use [getOptimizerConfiguration](getOptimizerConfiguration) to get the controller\'s step rate. Minimal response rate is the step rate of the controller.
2073
- * @type {number}
2074
- * @memberof InitializeJoggingRequest
2075
- */
2076
- 'response_rate'?: number;
2077
2135
  /**
2078
2136
  * Unique identifier addressing a coordinate system to which the responses are transformed. If not set, world coordinate system is used.
2079
2137
  * @type {string}
2080
2138
  * @memberof InitializeJoggingRequest
2081
2139
  */
2082
2140
  '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
2141
  }
2090
2142
 
2091
2143
  export const InitializeJoggingRequestMessageTypeEnum = {
@@ -2144,12 +2196,6 @@ export interface InitializeMovementRequest {
2144
2196
  * @memberof InitializeMovementRequest
2145
2197
  */
2146
2198
  'initial_location'?: number;
2147
- /**
2148
- * Update rate for the response message in milliseconds (ms). Default is 200 ms. Recommendation: As Wandelbots NOVA updates states in the controller\'s step rate, use either the controller\'s step rate or a multiple of it. Wandelbots NOVA will not interpolate the state but rather round it to the nearest step rate below the configured response rate. Minimal response rate is the step rate of controller.
2149
- * @type {number}
2150
- * @memberof InitializeMovementRequest
2151
- */
2152
- 'response_rate'?: number;
2153
2199
  /**
2154
2200
  * Unique identifier addressing a coordinate system to which the responses are transformed. If not set, world coordinate system is used.
2155
2201
  * @type {string}
@@ -2204,7 +2250,7 @@ export const InitializeMovementResponseKindEnum = {
2204
2250
  export type InitializeMovementResponseKindEnum = typeof InitializeMovementResponseKindEnum[keyof typeof InitializeMovementResponseKindEnum];
2205
2251
 
2206
2252
  /**
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.
2253
+ * 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
2254
  * @export
2209
2255
  * @interface IntegerValue
2210
2256
  */
@@ -2404,10 +2450,10 @@ export type JoggingDetailsKindEnum = typeof JoggingDetailsKindEnum[keyof typeof
2404
2450
  * @type JoggingDetailsState
2405
2451
  * @export
2406
2452
  */
2407
- export type JoggingDetailsState = JoggingPausedByUser | JoggingPausedNearCollision | JoggingPausedNearJointLimit | JoggingPausedOnIO | JoggingRunning;
2453
+ 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
2454
 
2409
2455
  /**
2410
- *
2456
+ * User has paused jogging.
2411
2457
  * @export
2412
2458
  * @interface JoggingPausedByUser
2413
2459
  */
@@ -2427,7 +2473,7 @@ export const JoggingPausedByUserKindEnum = {
2427
2473
  export type JoggingPausedByUserKindEnum = typeof JoggingPausedByUserKindEnum[keyof typeof JoggingPausedByUserKindEnum];
2428
2474
 
2429
2475
  /**
2430
- *
2476
+ * Jogging was paused because the motion group neared a collision.
2431
2477
  * @export
2432
2478
  * @interface JoggingPausedNearCollision
2433
2479
  */
@@ -2453,7 +2499,7 @@ export const JoggingPausedNearCollisionKindEnum = {
2453
2499
  export type JoggingPausedNearCollisionKindEnum = typeof JoggingPausedNearCollisionKindEnum[keyof typeof JoggingPausedNearCollisionKindEnum];
2454
2500
 
2455
2501
  /**
2456
- *
2502
+ * Jogging was paused because a joint is near its limit.
2457
2503
  * @export
2458
2504
  * @interface JoggingPausedNearJointLimit
2459
2505
  */
@@ -2479,7 +2525,7 @@ export const JoggingPausedNearJointLimitKindEnum = {
2479
2525
  export type JoggingPausedNearJointLimitKindEnum = typeof JoggingPausedNearJointLimitKindEnum[keyof typeof JoggingPausedNearJointLimitKindEnum];
2480
2526
 
2481
2527
  /**
2482
- *
2528
+ * Jogging was paused because of an I/O event.
2483
2529
  * @export
2484
2530
  * @interface JoggingPausedOnIO
2485
2531
  */
@@ -2499,7 +2545,7 @@ export const JoggingPausedOnIOKindEnum = {
2499
2545
  export type JoggingPausedOnIOKindEnum = typeof JoggingPausedOnIOKindEnum[keyof typeof JoggingPausedOnIOKindEnum];
2500
2546
 
2501
2547
  /**
2502
- *
2548
+ * Jogging is active.
2503
2549
  * @export
2504
2550
  * @interface JoggingRunning
2505
2551
  */
@@ -2581,7 +2627,7 @@ export interface JointTrajectory {
2581
2627
  */
2582
2628
  'times': Array<number>;
2583
2629
  /**
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.
2630
+ *
2585
2631
  * @type {Array<number>}
2586
2632
  * @memberof JointTrajectory
2587
2633
  */
@@ -2869,6 +2915,12 @@ export interface LimitSet {
2869
2915
  * @memberof LimitSet
2870
2916
  */
2871
2917
  'flange'?: CartesianLimits;
2918
+ /**
2919
+ *
2920
+ * @type {JointLimits}
2921
+ * @memberof LimitSet
2922
+ */
2923
+ 'coupled_shoulder_elbow_joint'?: JointLimits;
2872
2924
  }
2873
2925
  /**
2874
2926
  * If a limit is not set, the default value will be used.
@@ -2944,13 +2996,13 @@ export type Manufacturer = typeof Manufacturer[keyof typeof Manufacturer];
2944
2996
 
2945
2997
 
2946
2998
  /**
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.
2999
+ *
2948
3000
  * @export
2949
3001
  * @interface MidpointInsertionAlgorithm
2950
3002
  */
2951
3003
  export interface MidpointInsertionAlgorithm {
2952
3004
  /**
2953
- * Algorithm discriminator.
3005
+ * 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
3006
  * @type {string}
2955
3007
  * @memberof MidpointInsertionAlgorithm
2956
3008
  */
@@ -3849,11 +3901,11 @@ export interface PlanTrajectoryFailedResponse {
3849
3901
  */
3850
3902
  'error_feedback': PlanTrajectoryFailedResponseErrorFeedback;
3851
3903
  /**
3852
- *
3904
+ * 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
3905
  * @type {number}
3854
3906
  * @memberof PlanTrajectoryFailedResponse
3855
3907
  */
3856
- 'error_location_on_trajectory'?: number;
3908
+ 'error_location_on_trajectory': number;
3857
3909
  /**
3858
3910
  * The joint trajectory from the start joint position to the error.
3859
3911
  * @type {JointTrajectory}
@@ -4071,17 +4123,17 @@ export interface ProfinetDescription {
4071
4123
  */
4072
4124
  'slots'?: Array<ProfinetSlotDescription>;
4073
4125
  /**
4074
- * Name of the PROFINET device
4126
+ * 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
4127
  * @type {string}
4076
4128
  * @memberof ProfinetDescription
4077
4129
  */
4078
4130
  'device_name'?: string;
4079
4131
  /**
4080
- * IP address for the PROFINET device
4081
- * @type {string}
4132
+ *
4133
+ * @type {BusIOProfinetIpConfig}
4082
4134
  * @memberof ProfinetDescription
4083
4135
  */
4084
- 'ip'?: string;
4136
+ 'ip_config'?: BusIOProfinetIpConfig;
4085
4137
  }
4086
4138
  /**
4087
4139
  *
@@ -4090,7 +4142,7 @@ export interface ProfinetDescription {
4090
4142
  */
4091
4143
  export interface ProfinetIO {
4092
4144
  /**
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.
4145
+ * 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
4146
  * @type {string}
4095
4147
  * @memberof ProfinetIO
4096
4148
  */
@@ -4102,25 +4154,25 @@ export interface ProfinetIO {
4102
4154
  */
4103
4155
  'type': ProfinetIOTypeEnum;
4104
4156
  /**
4105
- * The direction of the input/output value, indicating whether it is an input or output for the device.
4157
+ * 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
4158
  * @type {ProfinetIODirection}
4107
4159
  * @memberof ProfinetIO
4108
4160
  */
4109
4161
  'direction': ProfinetIODirection;
4110
4162
  /**
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.
4163
+ * 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
4164
  * @type {number}
4113
4165
  * @memberof ProfinetIO
4114
4166
  */
4115
4167
  'byte_address': number;
4116
4168
  /**
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.
4169
+ * 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
4170
  * @type {number}
4119
4171
  * @memberof ProfinetIO
4120
4172
  */
4121
4173
  'bit_address'?: number;
4122
4174
  /**
4123
- * The unique identifier for the input/output value. This identifier is used to reference the specific input/output in the NOVA system.
4175
+ * 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
4176
  * @type {string}
4125
4177
  * @memberof ProfinetIO
4126
4178
  */
@@ -4135,7 +4187,7 @@ export interface ProfinetIO {
4135
4187
  */
4136
4188
  export interface ProfinetIOData {
4137
4189
  /**
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.
4190
+ * 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
4191
  * @type {string}
4140
4192
  * @memberof ProfinetIOData
4141
4193
  */
@@ -4147,19 +4199,19 @@ export interface ProfinetIOData {
4147
4199
  */
4148
4200
  'type': ProfinetIOTypeEnum;
4149
4201
  /**
4150
- * The direction of the input/output value, indicating whether it is an input or output for the device.
4202
+ * 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
4203
  * @type {ProfinetIODirection}
4152
4204
  * @memberof ProfinetIOData
4153
4205
  */
4154
4206
  'direction': ProfinetIODirection;
4155
4207
  /**
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.
4208
+ * 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
4209
  * @type {number}
4158
4210
  * @memberof ProfinetIOData
4159
4211
  */
4160
4212
  'byte_address': number;
4161
4213
  /**
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.
4214
+ * 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
4215
  * @type {number}
4164
4216
  * @memberof ProfinetIOData
4165
4217
  */
@@ -4168,7 +4220,7 @@ export interface ProfinetIOData {
4168
4220
 
4169
4221
 
4170
4222
  /**
4171
- * Identifies the input/output type.
4223
+ * 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
4224
  * @export
4173
4225
  * @enum {string}
4174
4226
  */
@@ -4183,7 +4235,7 @@ export type ProfinetIODirection = typeof ProfinetIODirection[keyof typeof Profin
4183
4235
 
4184
4236
 
4185
4237
  /**
4186
- * Value type of the PROFINET input/output.
4238
+ * Value type of the PROFINET input/output variable. Is used to interpret the corresponding bits correctly.
4187
4239
  * @export
4188
4240
  * @enum {string}
4189
4241
  */
@@ -4211,38 +4263,38 @@ export type ProfinetIOTypeEnum = typeof ProfinetIOTypeEnum[keyof typeof Profinet
4211
4263
  */
4212
4264
  export interface ProfinetInputOutputConfig {
4213
4265
  /**
4214
- * Content of the input output configuration file.
4266
+ * 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
4267
  * @type {string}
4216
4268
  * @memberof ProfinetInputOutputConfig
4217
4269
  */
4218
4270
  'config': string;
4219
4271
  /**
4220
- * Offset in bytes for the input data.
4272
+ * 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
4273
  * @type {number}
4222
4274
  * @memberof ProfinetInputOutputConfig
4223
4275
  */
4224
4276
  'input_offset': number;
4225
4277
  /**
4226
- * Offset in bytes for the output data.
4278
+ * 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
4279
  * @type {number}
4228
4280
  * @memberof ProfinetInputOutputConfig
4229
4281
  */
4230
4282
  'output_offset': number;
4231
4283
  }
4232
4284
  /**
4233
- *
4285
+ * 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
4286
  * @export
4235
4287
  * @interface ProfinetSlotDescription
4236
4288
  */
4237
4289
  export interface ProfinetSlotDescription {
4238
4290
  /**
4239
- * The number of the PROFINET slot.
4291
+ * 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
4292
  * @type {number}
4241
4293
  * @memberof ProfinetSlotDescription
4242
4294
  */
4243
4295
  'number': number;
4244
4296
  /**
4245
- * The API number of the PROFINET input, used to identify the specific API for the input.
4297
+ * The application process identifier (API) number of the PROFINET input. The API identifies the application relation (AR) that is using the slot.
4246
4298
  * @type {number}
4247
4299
  * @memberof ProfinetSlotDescription
4248
4300
  */
@@ -4261,32 +4313,180 @@ export interface ProfinetSlotDescription {
4261
4313
  */
4262
4314
  export interface ProfinetSubSlotDescription {
4263
4315
  /**
4264
- * The identifier of the PROFINET subslot.
4316
+ * The number/index of the PROFINET subslot.
4265
4317
  * @type {number}
4266
4318
  * @memberof ProfinetSubSlotDescription
4267
4319
  */
4268
4320
  'number': number;
4269
4321
  /**
4270
- * The length in bytes of the PROFINET input.
4322
+ * The amount of bytes allocated for the subslot in the input process image buffer.
4271
4323
  * @type {number}
4272
4324
  * @memberof ProfinetSubSlotDescription
4273
4325
  */
4274
4326
  'input_length': number;
4275
4327
  /**
4276
- * The length in bytes of the PROFINET output.
4328
+ * The amount of bytes allocated for the subslot in the output process image buffer.
4277
4329
  * @type {number}
4278
4330
  * @memberof ProfinetSubSlotDescription
4279
4331
  */
4280
4332
  'output_length': number;
4281
4333
  }
4282
4334
  /**
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.
4335
+ * A program is a collection of instructions that are executed in the robot cell.
4336
+ * @export
4337
+ * @interface Program
4338
+ */
4339
+ export interface Program {
4340
+ /**
4341
+ *
4342
+ * @type {string}
4343
+ * @memberof Program
4344
+ */
4345
+ 'program': string;
4346
+ /**
4347
+ *
4348
+ * @type {string}
4349
+ * @memberof Program
4350
+ */
4351
+ 'name'?: string;
4352
+ /**
4353
+ *
4354
+ * @type {string}
4355
+ * @memberof Program
4356
+ */
4357
+ 'description'?: string;
4358
+ /**
4359
+ *
4360
+ * @type {string}
4361
+ * @memberof Program
4362
+ */
4363
+ 'app': string;
4364
+ /**
4365
+ *
4366
+ * @type {object}
4367
+ * @memberof Program
4368
+ */
4369
+ 'input_schema'?: object;
4370
+ /**
4371
+ *
4372
+ * @type {object}
4373
+ * @memberof Program
4374
+ */
4375
+ 'preconditions'?: object;
4376
+ }
4377
+ /**
4378
+ * Holds the state of a program run.
4379
+ * @export
4380
+ * @interface ProgramRun
4381
+ */
4382
+ export interface ProgramRun {
4383
+ /**
4384
+ * Unique identifier of the program run
4385
+ * @type {string}
4386
+ * @memberof ProgramRun
4387
+ */
4388
+ 'run': string;
4389
+ /**
4390
+ * Unique identifier of the program
4391
+ * @type {string}
4392
+ * @memberof ProgramRun
4393
+ */
4394
+ 'program': string;
4395
+ /**
4396
+ * State of the program run
4397
+ * @type {ProgramRunState}
4398
+ * @memberof ProgramRun
4399
+ */
4400
+ 'state': ProgramRunState;
4401
+ /**
4402
+ * Logs of the program run
4403
+ * @type {string}
4404
+ * @memberof ProgramRun
4405
+ */
4406
+ 'logs'?: string;
4407
+ /**
4408
+ * Stdout of the program run
4409
+ * @type {string}
4410
+ * @memberof ProgramRun
4411
+ */
4412
+ 'stdout'?: string;
4413
+ /**
4414
+ * Stderr of the program run
4415
+ * @type {string}
4416
+ * @memberof ProgramRun
4417
+ */
4418
+ 'stderr'?: string;
4419
+ /**
4420
+ * Error message of the program run, if any
4421
+ * @type {string}
4422
+ * @memberof ProgramRun
4423
+ */
4424
+ 'error'?: string;
4425
+ /**
4426
+ * Traceback of the program run, if any
4427
+ * @type {string}
4428
+ * @memberof ProgramRun
4429
+ */
4430
+ 'traceback'?: string;
4431
+ /**
4432
+ * Start time of the program run
4433
+ * @type {string}
4434
+ * @memberof ProgramRun
4435
+ */
4436
+ 'start_time'?: string;
4437
+ /**
4438
+ * End time of the program run
4439
+ * @type {string}
4440
+ * @memberof ProgramRun
4441
+ */
4442
+ 'end_time'?: string;
4443
+ /**
4444
+ * Input data of the program run
4445
+ * @type {object}
4446
+ * @memberof ProgramRun
4447
+ */
4448
+ 'input_data'?: object;
4449
+ }
4450
+
4451
+
4452
+ /**
4453
+ * The state of a program run.
4454
+ * @export
4455
+ * @enum {string}
4456
+ */
4457
+
4458
+ export const ProgramRunState = {
4459
+ Preparing: 'PREPARING',
4460
+ Running: 'RUNNING',
4461
+ Completed: 'COMPLETED',
4462
+ Failed: 'FAILED',
4463
+ Stopped: 'STOPPED'
4464
+ } as const;
4465
+
4466
+ export type ProgramRunState = typeof ProgramRunState[keyof typeof ProgramRunState];
4467
+
4468
+
4469
+ /**
4470
+ * The state of a program run.
4471
+ * @export
4472
+ * @interface ProgramStartRequest
4473
+ */
4474
+ export interface ProgramStartRequest {
4475
+ /**
4476
+ * The arguments to pass to the program.
4477
+ * @type {object}
4478
+ * @memberof ProgramStartRequest
4479
+ */
4480
+ 'arguments': object;
4481
+ }
4482
+ /**
4483
+ *
4284
4484
  * @export
4285
4485
  * @interface RRTConnectAlgorithm
4286
4486
  */
4287
4487
  export interface RRTConnectAlgorithm {
4288
4488
  /**
4289
- * Algorithm discriminator.
4489
+ * 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
4490
  * @type {string}
4291
4491
  * @memberof RRTConnectAlgorithm
4292
4492
  */
@@ -4297,6 +4497,30 @@ export interface RRTConnectAlgorithm {
4297
4497
  * @memberof RRTConnectAlgorithm
4298
4498
  */
4299
4499
  'max_iterations'?: number;
4500
+ /**
4501
+ * Maximum step size for tree extension in joint space.
4502
+ * @type {number}
4503
+ * @memberof RRTConnectAlgorithm
4504
+ */
4505
+ 'max_step_size'?: number;
4506
+ /**
4507
+ * Adjust the maximum step size during the search based on the recent success rate of tree expansion.
4508
+ * @type {boolean}
4509
+ * @memberof RRTConnectAlgorithm
4510
+ */
4511
+ 'adaptive_step_size'?: boolean;
4512
+ /**
4513
+ * Apply smoothing after the search has succeeded. This will remove as many intermediate points as possible while keeping the path valid.
4514
+ * @type {boolean}
4515
+ * @memberof RRTConnectAlgorithm
4516
+ */
4517
+ 'apply_smoothing'?: boolean;
4518
+ /**
4519
+ * Apply blending after the search has succeeded and smoothing has been applied. This will apply the largest viable blending at each intermediate point.
4520
+ * @type {boolean}
4521
+ * @memberof RRTConnectAlgorithm
4522
+ */
4523
+ 'apply_blending'?: boolean;
4300
4524
  }
4301
4525
 
4302
4526
  export const RRTConnectAlgorithmAlgorithmNameEnum = {
@@ -4726,6 +4950,25 @@ export interface ServiceStatusStatus {
4726
4950
  }
4727
4951
 
4728
4952
 
4953
+ /**
4954
+ * Defines an input/output that should be set upon reaching a specified location on the trajectory.
4955
+ * @export
4956
+ * @interface SetIO
4957
+ */
4958
+ export interface SetIO {
4959
+ /**
4960
+ *
4961
+ * @type {IOValue}
4962
+ * @memberof SetIO
4963
+ */
4964
+ 'io': IOValue;
4965
+ /**
4966
+ * The location on the trajectory where the input/output should be set.
4967
+ * @type {number}
4968
+ * @memberof SetIO
4969
+ */
4970
+ 'location': number;
4971
+ }
4729
4972
  /**
4730
4973
  *
4731
4974
  * @export
@@ -4801,10 +5044,10 @@ export interface StartMovementRequest {
4801
5044
  'direction'?: Direction;
4802
5045
  /**
4803
5046
  * 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>}
5047
+ * @type {Array<SetIO>}
4805
5048
  * @memberof StartMovementRequest
4806
5049
  */
4807
- 'set_outputs'?: Array<IOValue>;
5050
+ 'set_outputs'?: Array<SetIO>;
4808
5051
  /**
4809
5052
  * Defines an input/output that is listened to before the movement. Execution starts if the defined comparator evaluates to `true`.
4810
5053
  * @type {StartOnIO}
@@ -5076,7 +5319,7 @@ export interface TrajectoryDetails {
5076
5319
  */
5077
5320
  'trajectory': string;
5078
5321
  /**
5079
- * Current location of motion group on the trajectory.
5322
+ * 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
5323
  * @type {number}
5081
5324
  * @memberof TrajectoryDetails
5082
5325
  */
@@ -5105,10 +5348,10 @@ export type TrajectoryDetailsKindEnum = typeof TrajectoryDetailsKindEnum[keyof t
5105
5348
  * @type TrajectoryDetailsState
5106
5349
  * @export
5107
5350
  */
5108
- export type TrajectoryDetailsState = TrajectoryEnded | TrajectoryPausedByUser | TrajectoryPausedOnIO | TrajectoryRunning | TrajectoryWaitForIO;
5351
+ 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
5352
 
5110
5353
  /**
5111
- *
5354
+ * First or last sample (depending on direction) of trajectory has been sent.
5112
5355
  * @export
5113
5356
  * @interface TrajectoryEnded
5114
5357
  */
@@ -5154,7 +5397,7 @@ export const TrajectoryIdMessageTypeEnum = {
5154
5397
  export type TrajectoryIdMessageTypeEnum = typeof TrajectoryIdMessageTypeEnum[keyof typeof TrajectoryIdMessageTypeEnum];
5155
5398
 
5156
5399
  /**
5157
- *
5400
+ * User has paused execution.
5158
5401
  * @export
5159
5402
  * @interface TrajectoryPausedByUser
5160
5403
  */
@@ -5174,7 +5417,7 @@ export const TrajectoryPausedByUserKindEnum = {
5174
5417
  export type TrajectoryPausedByUserKindEnum = typeof TrajectoryPausedByUserKindEnum[keyof typeof TrajectoryPausedByUserKindEnum];
5175
5418
 
5176
5419
  /**
5177
- *
5420
+ * Execution was paused because of an I/O event.
5178
5421
  * @export
5179
5422
  * @interface TrajectoryPausedOnIO
5180
5423
  */
@@ -5194,7 +5437,7 @@ export const TrajectoryPausedOnIOKindEnum = {
5194
5437
  export type TrajectoryPausedOnIOKindEnum = typeof TrajectoryPausedOnIOKindEnum[keyof typeof TrajectoryPausedOnIOKindEnum];
5195
5438
 
5196
5439
  /**
5197
- *
5440
+ * Trajectory is being executed.
5198
5441
  * @export
5199
5442
  * @interface TrajectoryRunning
5200
5443
  */
@@ -5220,7 +5463,7 @@ export const TrajectoryRunningKindEnum = {
5220
5463
  export type TrajectoryRunningKindEnum = typeof TrajectoryRunningKindEnum[keyof typeof TrajectoryRunningKindEnum];
5221
5464
 
5222
5465
  /**
5223
- *
5466
+ * Waiting for an I/O event to start execution.
5224
5467
  * @export
5225
5468
  * @interface TrajectoryWaitForIO
5226
5469
  */
@@ -5333,6 +5576,31 @@ export interface ValidationError {
5333
5576
  */
5334
5577
  'input': { [key: string]: any; };
5335
5578
  }
5579
+ /**
5580
+ * A validation error of a program.
5581
+ * @export
5582
+ * @interface ValidationError2
5583
+ */
5584
+ export interface ValidationError2 {
5585
+ /**
5586
+ *
5587
+ * @type {Array<number>}
5588
+ * @memberof ValidationError2
5589
+ */
5590
+ 'loc': Array<number>;
5591
+ /**
5592
+ *
5593
+ * @type {string}
5594
+ * @memberof ValidationError2
5595
+ */
5596
+ 'msg': string;
5597
+ /**
5598
+ *
5599
+ * @type {string}
5600
+ * @memberof ValidationError2
5601
+ */
5602
+ 'type': string;
5603
+ }
5336
5604
  /**
5337
5605
  * @type ValidationErrorLocInner
5338
5606
  * @export
@@ -6150,7 +6418,7 @@ export class ApplicationApi extends BaseAPI {
6150
6418
  export const BUSInputsOutputsApiAxiosParamCreator = function (configuration?: Configuration) {
6151
6419
  return {
6152
6420
  /**
6153
- * Add a BUS Inputs/Outputs Service to the cell.
6421
+ * Add the BUS inputs/outputs service to the cell. Starts a containerized service that enables BUS connections via the specified ethernet port.
6154
6422
  * @summary Add Service
6155
6423
  * @param {string} cell Unique identifier addressing a cell in all API calls.
6156
6424
  * @param {BusIOType} busIOType
@@ -6203,7 +6471,7 @@ export const BUSInputsOutputsApiAxiosParamCreator = function (configuration?: Co
6203
6471
  };
6204
6472
  },
6205
6473
  /**
6206
- * Adds an input/output to or updates an input/output on the PROFINET device.
6474
+ * 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
6475
  * @summary Add PROFINET Input/Output
6208
6476
  * @param {string} cell Unique identifier addressing a cell in all API calls.
6209
6477
  * @param {string} io Unique identifier to address an Input/Output in the cell.
@@ -6255,7 +6523,7 @@ export const BUSInputsOutputsApiAxiosParamCreator = function (configuration?: Co
6255
6523
  };
6256
6524
  },
6257
6525
  /**
6258
- * Delete BUS Inputs/Outputs Service from the cell.
6526
+ * Remove the BUS inputs/outputs service from the cell.
6259
6527
  * @summary Clear Service
6260
6528
  * @param {string} cell Unique identifier addressing a cell in all API calls.
6261
6529
  * @param {number} [completionTimeout]
@@ -6302,7 +6570,7 @@ export const BUSInputsOutputsApiAxiosParamCreator = function (configuration?: Co
6302
6570
  };
6303
6571
  },
6304
6572
  /**
6305
- * Removes the input/output from the PROFINET device.
6573
+ * Removes an input/output variable configuration from the PROFINET device, e.g. NOVA\'s PROFINET service.
6306
6574
  * @summary Remove PROFINET Input/Ouptut
6307
6575
  * @param {string} cell Unique identifier addressing a cell in all API calls.
6308
6576
  * @param {string} io Unique identifier to address an Input/Output in the cell.
@@ -6348,7 +6616,7 @@ export const BUSInputsOutputsApiAxiosParamCreator = function (configuration?: Co
6348
6616
  };
6349
6617
  },
6350
6618
  /**
6351
- * Get deployed BUS Inputs/Outputs Service.
6619
+ * Get deployed BUS inputs/outputs service.
6352
6620
  * @summary Get Service
6353
6621
  * @param {string} cell Unique identifier addressing a cell in all API calls.
6354
6622
  * @param {*} [options] Override http request option.
@@ -6479,7 +6747,7 @@ export const BUSInputsOutputsApiAxiosParamCreator = function (configuration?: Co
6479
6747
  };
6480
6748
  },
6481
6749
  /**
6482
- * Get description of PROFINET
6750
+ * Get description of NOVA as a PROFINET device.
6483
6751
  * @summary Get PROFINET Description
6484
6752
  * @param {string} cell Unique identifier addressing a cell in all API calls.
6485
6753
  * @param {*} [options] Override http request option.
@@ -6521,7 +6789,7 @@ export const BUSInputsOutputsApiAxiosParamCreator = function (configuration?: Co
6521
6789
  };
6522
6790
  },
6523
6791
  /**
6524
- * Get input/output configuration of the PROFINET device as file.
6792
+ * 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
6793
  * @summary PROFINET Inputs/Outputs to File
6526
6794
  * @param {string} cell Unique identifier addressing a cell in all API calls.
6527
6795
  * @param {number} [inputOffset]
@@ -6573,7 +6841,7 @@ export const BUSInputsOutputsApiAxiosParamCreator = function (configuration?: Co
6573
6841
  };
6574
6842
  },
6575
6843
  /**
6576
- * List all BUS Input/Output descriptions.
6844
+ * 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
6845
  * @summary List Descriptions
6578
6846
  * @param {string} cell Unique identifier addressing a cell in all API calls.
6579
6847
  * @param {*} [options] Override http request option.
@@ -6615,7 +6883,7 @@ export const BUSInputsOutputsApiAxiosParamCreator = function (configuration?: Co
6615
6883
  };
6616
6884
  },
6617
6885
  /**
6618
- * List all PROFINET input and outputs.
6886
+ * 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
6887
  * @summary List PROFINET Input/Output Configuration
6620
6888
  * @param {string} cell Unique identifier addressing a cell in all API calls.
6621
6889
  * @param {*} [options] Override http request option.
@@ -6705,7 +6973,7 @@ export const BUSInputsOutputsApiAxiosParamCreator = function (configuration?: Co
6705
6973
  };
6706
6974
  },
6707
6975
  /**
6708
- * Sets inputs/outputs on the PROFINET device from file.
6976
+ * 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
6977
  * @summary Set PROFINET Inputs/Outputs from File
6710
6978
  * @param {string} cell Unique identifier addressing a cell in all API calls.
6711
6979
  * @param {ProfinetInputOutputConfig} profinetInputOutputConfig
@@ -6763,7 +7031,7 @@ export const BUSInputsOutputsApiFp = function(configuration?: Configuration) {
6763
7031
  const localVarAxiosParamCreator = BUSInputsOutputsApiAxiosParamCreator(configuration)
6764
7032
  return {
6765
7033
  /**
6766
- * Add a BUS Inputs/Outputs Service to the cell.
7034
+ * Add the BUS inputs/outputs service to the cell. Starts a containerized service that enables BUS connections via the specified ethernet port.
6767
7035
  * @summary Add Service
6768
7036
  * @param {string} cell Unique identifier addressing a cell in all API calls.
6769
7037
  * @param {BusIOType} busIOType
@@ -6778,7 +7046,7 @@ export const BUSInputsOutputsApiFp = function(configuration?: Configuration) {
6778
7046
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
6779
7047
  },
6780
7048
  /**
6781
- * Adds an input/output to or updates an input/output on the PROFINET device.
7049
+ * 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
7050
  * @summary Add PROFINET Input/Output
6783
7051
  * @param {string} cell Unique identifier addressing a cell in all API calls.
6784
7052
  * @param {string} io Unique identifier to address an Input/Output in the cell.
@@ -6793,7 +7061,7 @@ export const BUSInputsOutputsApiFp = function(configuration?: Configuration) {
6793
7061
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
6794
7062
  },
6795
7063
  /**
6796
- * Delete BUS Inputs/Outputs Service from the cell.
7064
+ * Remove the BUS inputs/outputs service from the cell.
6797
7065
  * @summary Clear Service
6798
7066
  * @param {string} cell Unique identifier addressing a cell in all API calls.
6799
7067
  * @param {number} [completionTimeout]
@@ -6807,7 +7075,7 @@ export const BUSInputsOutputsApiFp = function(configuration?: Configuration) {
6807
7075
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
6808
7076
  },
6809
7077
  /**
6810
- * Removes the input/output from the PROFINET device.
7078
+ * Removes an input/output variable configuration from the PROFINET device, e.g. NOVA\'s PROFINET service.
6811
7079
  * @summary Remove PROFINET Input/Ouptut
6812
7080
  * @param {string} cell Unique identifier addressing a cell in all API calls.
6813
7081
  * @param {string} io Unique identifier to address an Input/Output in the cell.
@@ -6821,7 +7089,7 @@ export const BUSInputsOutputsApiFp = function(configuration?: Configuration) {
6821
7089
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
6822
7090
  },
6823
7091
  /**
6824
- * Get deployed BUS Inputs/Outputs Service.
7092
+ * Get deployed BUS inputs/outputs service.
6825
7093
  * @summary Get Service
6826
7094
  * @param {string} cell Unique identifier addressing a cell in all API calls.
6827
7095
  * @param {*} [options] Override http request option.
@@ -6861,7 +7129,7 @@ export const BUSInputsOutputsApiFp = function(configuration?: Configuration) {
6861
7129
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
6862
7130
  },
6863
7131
  /**
6864
- * Get description of PROFINET
7132
+ * Get description of NOVA as a PROFINET device.
6865
7133
  * @summary Get PROFINET Description
6866
7134
  * @param {string} cell Unique identifier addressing a cell in all API calls.
6867
7135
  * @param {*} [options] Override http request option.
@@ -6874,7 +7142,7 @@ export const BUSInputsOutputsApiFp = function(configuration?: Configuration) {
6874
7142
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
6875
7143
  },
6876
7144
  /**
6877
- * Get input/output configuration of the PROFINET device as file.
7145
+ * 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
7146
  * @summary PROFINET Inputs/Outputs to File
6879
7147
  * @param {string} cell Unique identifier addressing a cell in all API calls.
6880
7148
  * @param {number} [inputOffset]
@@ -6889,20 +7157,20 @@ export const BUSInputsOutputsApiFp = function(configuration?: Configuration) {
6889
7157
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
6890
7158
  },
6891
7159
  /**
6892
- * List all BUS Input/Output descriptions.
7160
+ * 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
7161
  * @summary List Descriptions
6894
7162
  * @param {string} cell Unique identifier addressing a cell in all API calls.
6895
7163
  * @param {*} [options] Override http request option.
6896
7164
  * @throws {RequiredError}
6897
7165
  */
6898
- async listBusIODescriptions(cell: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<IODescription>>> {
7166
+ async listBusIODescriptions(cell: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<IODescription2>>> {
6899
7167
  const localVarAxiosArgs = await localVarAxiosParamCreator.listBusIODescriptions(cell, options);
6900
7168
  const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
6901
7169
  const localVarOperationServerBasePath = operationServerMap['BUSInputsOutputsApi.listBusIODescriptions']?.[localVarOperationServerIndex]?.url;
6902
7170
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
6903
7171
  },
6904
7172
  /**
6905
- * List all PROFINET input and outputs.
7173
+ * 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
7174
  * @summary List PROFINET Input/Output Configuration
6907
7175
  * @param {string} cell Unique identifier addressing a cell in all API calls.
6908
7176
  * @param {*} [options] Override http request option.
@@ -6929,7 +7197,7 @@ export const BUSInputsOutputsApiFp = function(configuration?: Configuration) {
6929
7197
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
6930
7198
  },
6931
7199
  /**
6932
- * Sets inputs/outputs on the PROFINET device from file.
7200
+ * 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
7201
  * @summary Set PROFINET Inputs/Outputs from File
6934
7202
  * @param {string} cell Unique identifier addressing a cell in all API calls.
6935
7203
  * @param {ProfinetInputOutputConfig} profinetInputOutputConfig
@@ -6953,7 +7221,7 @@ export const BUSInputsOutputsApiFactory = function (configuration?: Configuratio
6953
7221
  const localVarFp = BUSInputsOutputsApiFp(configuration)
6954
7222
  return {
6955
7223
  /**
6956
- * Add a BUS Inputs/Outputs Service to the cell.
7224
+ * Add the BUS inputs/outputs service to the cell. Starts a containerized service that enables BUS connections via the specified ethernet port.
6957
7225
  * @summary Add Service
6958
7226
  * @param {string} cell Unique identifier addressing a cell in all API calls.
6959
7227
  * @param {BusIOType} busIOType
@@ -6965,7 +7233,7 @@ export const BUSInputsOutputsApiFactory = function (configuration?: Configuratio
6965
7233
  return localVarFp.addBusIOService(cell, busIOType, completionTimeout, options).then((request) => request(axios, basePath));
6966
7234
  },
6967
7235
  /**
6968
- * Adds an input/output to or updates an input/output on the PROFINET device.
7236
+ * 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
7237
  * @summary Add PROFINET Input/Output
6970
7238
  * @param {string} cell Unique identifier addressing a cell in all API calls.
6971
7239
  * @param {string} io Unique identifier to address an Input/Output in the cell.
@@ -6977,7 +7245,7 @@ export const BUSInputsOutputsApiFactory = function (configuration?: Configuratio
6977
7245
  return localVarFp.addProfinetIO(cell, io, profinetIOData, options).then((request) => request(axios, basePath));
6978
7246
  },
6979
7247
  /**
6980
- * Delete BUS Inputs/Outputs Service from the cell.
7248
+ * Remove the BUS inputs/outputs service from the cell.
6981
7249
  * @summary Clear Service
6982
7250
  * @param {string} cell Unique identifier addressing a cell in all API calls.
6983
7251
  * @param {number} [completionTimeout]
@@ -6988,7 +7256,7 @@ export const BUSInputsOutputsApiFactory = function (configuration?: Configuratio
6988
7256
  return localVarFp.clearBusIOService(cell, completionTimeout, options).then((request) => request(axios, basePath));
6989
7257
  },
6990
7258
  /**
6991
- * Removes the input/output from the PROFINET device.
7259
+ * Removes an input/output variable configuration from the PROFINET device, e.g. NOVA\'s PROFINET service.
6992
7260
  * @summary Remove PROFINET Input/Ouptut
6993
7261
  * @param {string} cell Unique identifier addressing a cell in all API calls.
6994
7262
  * @param {string} io Unique identifier to address an Input/Output in the cell.
@@ -6999,7 +7267,7 @@ export const BUSInputsOutputsApiFactory = function (configuration?: Configuratio
6999
7267
  return localVarFp.deleteProfinetIO(cell, io, options).then((request) => request(axios, basePath));
7000
7268
  },
7001
7269
  /**
7002
- * Get deployed BUS Inputs/Outputs Service.
7270
+ * Get deployed BUS inputs/outputs service.
7003
7271
  * @summary Get Service
7004
7272
  * @param {string} cell Unique identifier addressing a cell in all API calls.
7005
7273
  * @param {*} [options] Override http request option.
@@ -7030,7 +7298,7 @@ export const BUSInputsOutputsApiFactory = function (configuration?: Configuratio
7030
7298
  return localVarFp.getBusIOValues(cell, ios, options).then((request) => request(axios, basePath));
7031
7299
  },
7032
7300
  /**
7033
- * Get description of PROFINET
7301
+ * Get description of NOVA as a PROFINET device.
7034
7302
  * @summary Get PROFINET Description
7035
7303
  * @param {string} cell Unique identifier addressing a cell in all API calls.
7036
7304
  * @param {*} [options] Override http request option.
@@ -7040,7 +7308,7 @@ export const BUSInputsOutputsApiFactory = function (configuration?: Configuratio
7040
7308
  return localVarFp.getProfinetDescription(cell, options).then((request) => request(axios, basePath));
7041
7309
  },
7042
7310
  /**
7043
- * Get input/output configuration of the PROFINET device as file.
7311
+ * 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
7312
  * @summary PROFINET Inputs/Outputs to File
7045
7313
  * @param {string} cell Unique identifier addressing a cell in all API calls.
7046
7314
  * @param {number} [inputOffset]
@@ -7052,17 +7320,17 @@ export const BUSInputsOutputsApiFactory = function (configuration?: Configuratio
7052
7320
  return localVarFp.getProfinetIOsFromFile(cell, inputOffset, outputOffset, options).then((request) => request(axios, basePath));
7053
7321
  },
7054
7322
  /**
7055
- * List all BUS Input/Output descriptions.
7323
+ * 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
7324
  * @summary List Descriptions
7057
7325
  * @param {string} cell Unique identifier addressing a cell in all API calls.
7058
7326
  * @param {*} [options] Override http request option.
7059
7327
  * @throws {RequiredError}
7060
7328
  */
7061
- listBusIODescriptions(cell: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<IODescription>> {
7329
+ listBusIODescriptions(cell: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<IODescription2>> {
7062
7330
  return localVarFp.listBusIODescriptions(cell, options).then((request) => request(axios, basePath));
7063
7331
  },
7064
7332
  /**
7065
- * List all PROFINET input and outputs.
7333
+ * 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
7334
  * @summary List PROFINET Input/Output Configuration
7067
7335
  * @param {string} cell Unique identifier addressing a cell in all API calls.
7068
7336
  * @param {*} [options] Override http request option.
@@ -7083,7 +7351,7 @@ export const BUSInputsOutputsApiFactory = function (configuration?: Configuratio
7083
7351
  return localVarFp.setBusIOValues(cell, iOValue, options).then((request) => request(axios, basePath));
7084
7352
  },
7085
7353
  /**
7086
- * Sets inputs/outputs on the PROFINET device from file.
7354
+ * 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
7355
  * @summary Set PROFINET Inputs/Outputs from File
7088
7356
  * @param {string} cell Unique identifier addressing a cell in all API calls.
7089
7357
  * @param {ProfinetInputOutputConfig} profinetInputOutputConfig
@@ -7104,7 +7372,7 @@ export const BUSInputsOutputsApiFactory = function (configuration?: Configuratio
7104
7372
  */
7105
7373
  export class BUSInputsOutputsApi extends BaseAPI {
7106
7374
  /**
7107
- * Add a BUS Inputs/Outputs Service to the cell.
7375
+ * Add the BUS inputs/outputs service to the cell. Starts a containerized service that enables BUS connections via the specified ethernet port.
7108
7376
  * @summary Add Service
7109
7377
  * @param {string} cell Unique identifier addressing a cell in all API calls.
7110
7378
  * @param {BusIOType} busIOType
@@ -7118,7 +7386,7 @@ export class BUSInputsOutputsApi extends BaseAPI {
7118
7386
  }
7119
7387
 
7120
7388
  /**
7121
- * Adds an input/output to or updates an input/output on the PROFINET device.
7389
+ * 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
7390
  * @summary Add PROFINET Input/Output
7123
7391
  * @param {string} cell Unique identifier addressing a cell in all API calls.
7124
7392
  * @param {string} io Unique identifier to address an Input/Output in the cell.
@@ -7132,7 +7400,7 @@ export class BUSInputsOutputsApi extends BaseAPI {
7132
7400
  }
7133
7401
 
7134
7402
  /**
7135
- * Delete BUS Inputs/Outputs Service from the cell.
7403
+ * Remove the BUS inputs/outputs service from the cell.
7136
7404
  * @summary Clear Service
7137
7405
  * @param {string} cell Unique identifier addressing a cell in all API calls.
7138
7406
  * @param {number} [completionTimeout]
@@ -7145,7 +7413,7 @@ export class BUSInputsOutputsApi extends BaseAPI {
7145
7413
  }
7146
7414
 
7147
7415
  /**
7148
- * Removes the input/output from the PROFINET device.
7416
+ * Removes an input/output variable configuration from the PROFINET device, e.g. NOVA\'s PROFINET service.
7149
7417
  * @summary Remove PROFINET Input/Ouptut
7150
7418
  * @param {string} cell Unique identifier addressing a cell in all API calls.
7151
7419
  * @param {string} io Unique identifier to address an Input/Output in the cell.
@@ -7158,7 +7426,7 @@ export class BUSInputsOutputsApi extends BaseAPI {
7158
7426
  }
7159
7427
 
7160
7428
  /**
7161
- * Get deployed BUS Inputs/Outputs Service.
7429
+ * Get deployed BUS inputs/outputs service.
7162
7430
  * @summary Get Service
7163
7431
  * @param {string} cell Unique identifier addressing a cell in all API calls.
7164
7432
  * @param {*} [options] Override http request option.
@@ -7195,7 +7463,7 @@ export class BUSInputsOutputsApi extends BaseAPI {
7195
7463
  }
7196
7464
 
7197
7465
  /**
7198
- * Get description of PROFINET
7466
+ * Get description of NOVA as a PROFINET device.
7199
7467
  * @summary Get PROFINET Description
7200
7468
  * @param {string} cell Unique identifier addressing a cell in all API calls.
7201
7469
  * @param {*} [options] Override http request option.
@@ -7207,7 +7475,7 @@ export class BUSInputsOutputsApi extends BaseAPI {
7207
7475
  }
7208
7476
 
7209
7477
  /**
7210
- * Get input/output configuration of the PROFINET device as file.
7478
+ * 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
7479
  * @summary PROFINET Inputs/Outputs to File
7212
7480
  * @param {string} cell Unique identifier addressing a cell in all API calls.
7213
7481
  * @param {number} [inputOffset]
@@ -7221,7 +7489,7 @@ export class BUSInputsOutputsApi extends BaseAPI {
7221
7489
  }
7222
7490
 
7223
7491
  /**
7224
- * List all BUS Input/Output descriptions.
7492
+ * 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
7493
  * @summary List Descriptions
7226
7494
  * @param {string} cell Unique identifier addressing a cell in all API calls.
7227
7495
  * @param {*} [options] Override http request option.
@@ -7233,7 +7501,7 @@ export class BUSInputsOutputsApi extends BaseAPI {
7233
7501
  }
7234
7502
 
7235
7503
  /**
7236
- * List all PROFINET input and outputs.
7504
+ * 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
7505
  * @summary List PROFINET Input/Output Configuration
7238
7506
  * @param {string} cell Unique identifier addressing a cell in all API calls.
7239
7507
  * @param {*} [options] Override http request option.
@@ -7258,7 +7526,7 @@ export class BUSInputsOutputsApi extends BaseAPI {
7258
7526
  }
7259
7527
 
7260
7528
  /**
7261
- * Sets inputs/outputs on the PROFINET device from file.
7529
+ * 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
7530
  * @summary Set PROFINET Inputs/Outputs from File
7263
7531
  * @param {string} cell Unique identifier addressing a cell in all API calls.
7264
7532
  * @param {ProfinetInputOutputConfig} profinetInputOutputConfig
@@ -10725,7 +10993,7 @@ export class MotionGroupApi extends BaseAPI {
10725
10993
  export const MotionGroupModelsApiAxiosParamCreator = function (configuration?: Configuration) {
10726
10994
  return {
10727
10995
  /**
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.
10996
+ * 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
10997
  * @summary Get Collision Model
10730
10998
  * @param {string} cell Unique identifier addressing a cell in all API calls.
10731
10999
  * @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 +11091,7 @@ export const MotionGroupModelsApiFp = function(configuration?: Configuration) {
10823
11091
  const localVarAxiosParamCreator = MotionGroupModelsApiAxiosParamCreator(configuration)
10824
11092
  return {
10825
11093
  /**
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.
11094
+ * 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
11095
  * @summary Get Collision Model
10828
11096
  * @param {string} cell Unique identifier addressing a cell in all API calls.
10829
11097
  * @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 +11128,7 @@ export const MotionGroupModelsApiFactory = function (configuration?: Configurati
10860
11128
  const localVarFp = MotionGroupModelsApiFp(configuration)
10861
11129
  return {
10862
11130
  /**
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.
11131
+ * 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
11132
  * @summary Get Collision Model
10865
11133
  * @param {string} cell Unique identifier addressing a cell in all API calls.
10866
11134
  * @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 +11159,7 @@ export const MotionGroupModelsApiFactory = function (configuration?: Configurati
10891
11159
  */
10892
11160
  export class MotionGroupModelsApi extends BaseAPI {
10893
11161
  /**
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.
11162
+ * 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
11163
  * @summary Get Collision Model
10896
11164
  * @param {string} cell Unique identifier addressing a cell in all API calls.
10897
11165
  * @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 +11186,383 @@ export class MotionGroupModelsApi extends BaseAPI {
10918
11186
 
10919
11187
 
10920
11188
 
11189
+ /**
11190
+ * ProgramApi - axios parameter creator
11191
+ * @export
11192
+ */
11193
+ export const ProgramApiAxiosParamCreator = function (configuration?: Configuration) {
11194
+ return {
11195
+ /**
11196
+ * Get details of a program.
11197
+ * @summary Get program
11198
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
11199
+ * @param {string} program
11200
+ * @param {*} [options] Override http request option.
11201
+ * @throws {RequiredError}
11202
+ */
11203
+ getProgram: async (cell: string, program: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
11204
+ // verify required parameter 'cell' is not null or undefined
11205
+ assertParamExists('getProgram', 'cell', cell)
11206
+ // verify required parameter 'program' is not null or undefined
11207
+ assertParamExists('getProgram', 'program', program)
11208
+ const localVarPath = `/experimental/cells/{cell}/programs/{program}`
11209
+ .replace(`{${"cell"}}`, encodeURIComponent(String(cell)))
11210
+ .replace(`{${"program"}}`, encodeURIComponent(String(program)));
11211
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
11212
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
11213
+ let baseOptions;
11214
+ if (configuration) {
11215
+ baseOptions = configuration.baseOptions;
11216
+ }
11217
+
11218
+ const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
11219
+ const localVarHeaderParameter = {} as any;
11220
+ const localVarQueryParameter = {} as any;
11221
+
11222
+ // authentication BasicAuth required
11223
+ // http basic authentication required
11224
+ setBasicAuthToObject(localVarRequestOptions, configuration)
11225
+
11226
+ // authentication BearerAuth required
11227
+ // http bearer authentication required
11228
+ await setBearerAuthToObject(localVarHeaderParameter, configuration)
11229
+
11230
+
11231
+
11232
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
11233
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
11234
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
11235
+
11236
+ return {
11237
+ url: toPathString(localVarUrlObj),
11238
+ options: localVarRequestOptions,
11239
+ };
11240
+ },
11241
+ /**
11242
+ * List details of all existing programs.
11243
+ * @summary List programs
11244
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
11245
+ * @param {*} [options] Override http request option.
11246
+ * @throws {RequiredError}
11247
+ */
11248
+ listPrograms: async (cell: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
11249
+ // verify required parameter 'cell' is not null or undefined
11250
+ assertParamExists('listPrograms', 'cell', cell)
11251
+ const localVarPath = `/experimental/cells/{cell}/programs`
11252
+ .replace(`{${"cell"}}`, encodeURIComponent(String(cell)));
11253
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
11254
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
11255
+ let baseOptions;
11256
+ if (configuration) {
11257
+ baseOptions = configuration.baseOptions;
11258
+ }
11259
+
11260
+ const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
11261
+ const localVarHeaderParameter = {} as any;
11262
+ const localVarQueryParameter = {} as any;
11263
+
11264
+ // authentication BasicAuth required
11265
+ // http basic authentication required
11266
+ setBasicAuthToObject(localVarRequestOptions, configuration)
11267
+
11268
+ // authentication BearerAuth required
11269
+ // http bearer authentication required
11270
+ await setBearerAuthToObject(localVarHeaderParameter, configuration)
11271
+
11272
+
11273
+
11274
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
11275
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
11276
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
11277
+
11278
+ return {
11279
+ url: toPathString(localVarUrlObj),
11280
+ options: localVarRequestOptions,
11281
+ };
11282
+ },
11283
+ /**
11284
+ * This endpoint starts a new program execution. The program will be executed asynchronously.
11285
+ * @summary Start the program
11286
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
11287
+ * @param {string} program
11288
+ * @param {ProgramStartRequest} programStartRequest
11289
+ * @param {*} [options] Override http request option.
11290
+ * @throws {RequiredError}
11291
+ */
11292
+ startProgram: async (cell: string, program: string, programStartRequest: ProgramStartRequest, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
11293
+ // verify required parameter 'cell' is not null or undefined
11294
+ assertParamExists('startProgram', 'cell', cell)
11295
+ // verify required parameter 'program' is not null or undefined
11296
+ assertParamExists('startProgram', 'program', program)
11297
+ // verify required parameter 'programStartRequest' is not null or undefined
11298
+ assertParamExists('startProgram', 'programStartRequest', programStartRequest)
11299
+ const localVarPath = `/experimental/cells/{cell}/programs/{program}/start`
11300
+ .replace(`{${"cell"}}`, encodeURIComponent(String(cell)))
11301
+ .replace(`{${"program"}}`, encodeURIComponent(String(program)));
11302
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
11303
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
11304
+ let baseOptions;
11305
+ if (configuration) {
11306
+ baseOptions = configuration.baseOptions;
11307
+ }
11308
+
11309
+ const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
11310
+ const localVarHeaderParameter = {} as any;
11311
+ const localVarQueryParameter = {} as any;
11312
+
11313
+ // authentication BasicAuth required
11314
+ // http basic authentication required
11315
+ setBasicAuthToObject(localVarRequestOptions, configuration)
11316
+
11317
+ // authentication BearerAuth required
11318
+ // http bearer authentication required
11319
+ await setBearerAuthToObject(localVarHeaderParameter, configuration)
11320
+
11321
+
11322
+
11323
+ localVarHeaderParameter['Content-Type'] = 'application/json';
11324
+
11325
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
11326
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
11327
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
11328
+ localVarRequestOptions.data = serializeDataIfNeeded(programStartRequest, localVarRequestOptions, configuration)
11329
+
11330
+ return {
11331
+ url: toPathString(localVarUrlObj),
11332
+ options: localVarRequestOptions,
11333
+ };
11334
+ },
11335
+ /**
11336
+ * Stop a specific program run.
11337
+ * @summary Stop program run
11338
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
11339
+ * @param {string} program
11340
+ * @param {*} [options] Override http request option.
11341
+ * @throws {RequiredError}
11342
+ */
11343
+ stopProgram: async (cell: string, program: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
11344
+ // verify required parameter 'cell' is not null or undefined
11345
+ assertParamExists('stopProgram', 'cell', cell)
11346
+ // verify required parameter 'program' is not null or undefined
11347
+ assertParamExists('stopProgram', 'program', program)
11348
+ const localVarPath = `/experimental/cells/{cell}/programs/{program}/stop`
11349
+ .replace(`{${"cell"}}`, encodeURIComponent(String(cell)))
11350
+ .replace(`{${"program"}}`, encodeURIComponent(String(program)));
11351
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
11352
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
11353
+ let baseOptions;
11354
+ if (configuration) {
11355
+ baseOptions = configuration.baseOptions;
11356
+ }
11357
+
11358
+ const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
11359
+ const localVarHeaderParameter = {} as any;
11360
+ const localVarQueryParameter = {} as any;
11361
+
11362
+ // authentication BasicAuth required
11363
+ // http basic authentication required
11364
+ setBasicAuthToObject(localVarRequestOptions, configuration)
11365
+
11366
+ // authentication BearerAuth required
11367
+ // http bearer authentication required
11368
+ await setBearerAuthToObject(localVarHeaderParameter, configuration)
11369
+
11370
+
11371
+
11372
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
11373
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
11374
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
11375
+
11376
+ return {
11377
+ url: toPathString(localVarUrlObj),
11378
+ options: localVarRequestOptions,
11379
+ };
11380
+ },
11381
+ }
11382
+ };
11383
+
11384
+ /**
11385
+ * ProgramApi - functional programming interface
11386
+ * @export
11387
+ */
11388
+ export const ProgramApiFp = function(configuration?: Configuration) {
11389
+ const localVarAxiosParamCreator = ProgramApiAxiosParamCreator(configuration)
11390
+ return {
11391
+ /**
11392
+ * Get details of a program.
11393
+ * @summary Get program
11394
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
11395
+ * @param {string} program
11396
+ * @param {*} [options] Override http request option.
11397
+ * @throws {RequiredError}
11398
+ */
11399
+ async getProgram(cell: string, program: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Program>> {
11400
+ const localVarAxiosArgs = await localVarAxiosParamCreator.getProgram(cell, program, options);
11401
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
11402
+ const localVarOperationServerBasePath = operationServerMap['ProgramApi.getProgram']?.[localVarOperationServerIndex]?.url;
11403
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
11404
+ },
11405
+ /**
11406
+ * List details of all existing programs.
11407
+ * @summary List programs
11408
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
11409
+ * @param {*} [options] Override http request option.
11410
+ * @throws {RequiredError}
11411
+ */
11412
+ async listPrograms(cell: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<Program>>> {
11413
+ const localVarAxiosArgs = await localVarAxiosParamCreator.listPrograms(cell, options);
11414
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
11415
+ const localVarOperationServerBasePath = operationServerMap['ProgramApi.listPrograms']?.[localVarOperationServerIndex]?.url;
11416
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
11417
+ },
11418
+ /**
11419
+ * This endpoint starts a new program execution. The program will be executed asynchronously.
11420
+ * @summary Start the program
11421
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
11422
+ * @param {string} program
11423
+ * @param {ProgramStartRequest} programStartRequest
11424
+ * @param {*} [options] Override http request option.
11425
+ * @throws {RequiredError}
11426
+ */
11427
+ async startProgram(cell: string, program: string, programStartRequest: ProgramStartRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ProgramRun>> {
11428
+ const localVarAxiosArgs = await localVarAxiosParamCreator.startProgram(cell, program, programStartRequest, options);
11429
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
11430
+ const localVarOperationServerBasePath = operationServerMap['ProgramApi.startProgram']?.[localVarOperationServerIndex]?.url;
11431
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
11432
+ },
11433
+ /**
11434
+ * Stop a specific program run.
11435
+ * @summary Stop program run
11436
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
11437
+ * @param {string} program
11438
+ * @param {*} [options] Override http request option.
11439
+ * @throws {RequiredError}
11440
+ */
11441
+ async stopProgram(cell: string, program: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> {
11442
+ const localVarAxiosArgs = await localVarAxiosParamCreator.stopProgram(cell, program, options);
11443
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
11444
+ const localVarOperationServerBasePath = operationServerMap['ProgramApi.stopProgram']?.[localVarOperationServerIndex]?.url;
11445
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
11446
+ },
11447
+ }
11448
+ };
11449
+
11450
+ /**
11451
+ * ProgramApi - factory interface
11452
+ * @export
11453
+ */
11454
+ export const ProgramApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
11455
+ const localVarFp = ProgramApiFp(configuration)
11456
+ return {
11457
+ /**
11458
+ * Get details of a program.
11459
+ * @summary Get program
11460
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
11461
+ * @param {string} program
11462
+ * @param {*} [options] Override http request option.
11463
+ * @throws {RequiredError}
11464
+ */
11465
+ getProgram(cell: string, program: string, options?: RawAxiosRequestConfig): AxiosPromise<Program> {
11466
+ return localVarFp.getProgram(cell, program, options).then((request) => request(axios, basePath));
11467
+ },
11468
+ /**
11469
+ * List details of all existing programs.
11470
+ * @summary List programs
11471
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
11472
+ * @param {*} [options] Override http request option.
11473
+ * @throws {RequiredError}
11474
+ */
11475
+ listPrograms(cell: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<Program>> {
11476
+ return localVarFp.listPrograms(cell, options).then((request) => request(axios, basePath));
11477
+ },
11478
+ /**
11479
+ * This endpoint starts a new program execution. The program will be executed asynchronously.
11480
+ * @summary Start the program
11481
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
11482
+ * @param {string} program
11483
+ * @param {ProgramStartRequest} programStartRequest
11484
+ * @param {*} [options] Override http request option.
11485
+ * @throws {RequiredError}
11486
+ */
11487
+ startProgram(cell: string, program: string, programStartRequest: ProgramStartRequest, options?: RawAxiosRequestConfig): AxiosPromise<ProgramRun> {
11488
+ return localVarFp.startProgram(cell, program, programStartRequest, options).then((request) => request(axios, basePath));
11489
+ },
11490
+ /**
11491
+ * Stop a specific program run.
11492
+ * @summary Stop program run
11493
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
11494
+ * @param {string} program
11495
+ * @param {*} [options] Override http request option.
11496
+ * @throws {RequiredError}
11497
+ */
11498
+ stopProgram(cell: string, program: string, options?: RawAxiosRequestConfig): AxiosPromise<void> {
11499
+ return localVarFp.stopProgram(cell, program, options).then((request) => request(axios, basePath));
11500
+ },
11501
+ };
11502
+ };
11503
+
11504
+ /**
11505
+ * ProgramApi - object-oriented interface
11506
+ * @export
11507
+ * @class ProgramApi
11508
+ * @extends {BaseAPI}
11509
+ */
11510
+ export class ProgramApi extends BaseAPI {
11511
+ /**
11512
+ * Get details of a program.
11513
+ * @summary Get program
11514
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
11515
+ * @param {string} program
11516
+ * @param {*} [options] Override http request option.
11517
+ * @throws {RequiredError}
11518
+ * @memberof ProgramApi
11519
+ */
11520
+ public getProgram(cell: string, program: string, options?: RawAxiosRequestConfig) {
11521
+ return ProgramApiFp(this.configuration).getProgram(cell, program, options).then((request) => request(this.axios, this.basePath));
11522
+ }
11523
+
11524
+ /**
11525
+ * List details of all existing programs.
11526
+ * @summary List programs
11527
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
11528
+ * @param {*} [options] Override http request option.
11529
+ * @throws {RequiredError}
11530
+ * @memberof ProgramApi
11531
+ */
11532
+ public listPrograms(cell: string, options?: RawAxiosRequestConfig) {
11533
+ return ProgramApiFp(this.configuration).listPrograms(cell, options).then((request) => request(this.axios, this.basePath));
11534
+ }
11535
+
11536
+ /**
11537
+ * This endpoint starts a new program execution. The program will be executed asynchronously.
11538
+ * @summary Start the program
11539
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
11540
+ * @param {string} program
11541
+ * @param {ProgramStartRequest} programStartRequest
11542
+ * @param {*} [options] Override http request option.
11543
+ * @throws {RequiredError}
11544
+ * @memberof ProgramApi
11545
+ */
11546
+ public startProgram(cell: string, program: string, programStartRequest: ProgramStartRequest, options?: RawAxiosRequestConfig) {
11547
+ return ProgramApiFp(this.configuration).startProgram(cell, program, programStartRequest, options).then((request) => request(this.axios, this.basePath));
11548
+ }
11549
+
11550
+ /**
11551
+ * Stop a specific program run.
11552
+ * @summary Stop program run
11553
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
11554
+ * @param {string} program
11555
+ * @param {*} [options] Override http request option.
11556
+ * @throws {RequiredError}
11557
+ * @memberof ProgramApi
11558
+ */
11559
+ public stopProgram(cell: string, program: string, options?: RawAxiosRequestConfig) {
11560
+ return ProgramApiFp(this.configuration).stopProgram(cell, program, options).then((request) => request(this.axios, this.basePath));
11561
+ }
11562
+ }
11563
+
11564
+
11565
+
10921
11566
  /**
10922
11567
  * StoreCollisionComponentsApi - axios parameter creator
10923
11568
  * @export
@@ -11243,7 +11888,7 @@ export const StoreCollisionComponentsApiAxiosParamCreator = function (configurat
11243
11888
  };
11244
11889
  },
11245
11890
  /**
11246
- * Returns a list of colliders in a scene. This excludes colliders that are part of a motion group.
11891
+ * Returns all stored colliders.
11247
11892
  * @summary List Colliders
11248
11893
  * @param {string} cell Unique identifier addressing a cell in all API calls.
11249
11894
  * @param {*} [options] Override http request option.
@@ -11590,7 +12235,7 @@ export const StoreCollisionComponentsApiFp = function(configuration?: Configurat
11590
12235
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
11591
12236
  },
11592
12237
  /**
11593
- * Returns a list of colliders in a scene. This excludes colliders that are part of a motion group.
12238
+ * Returns all stored colliders.
11594
12239
  * @summary List Colliders
11595
12240
  * @param {string} cell Unique identifier addressing a cell in all API calls.
11596
12241
  * @param {*} [options] Override http request option.
@@ -11747,7 +12392,7 @@ export const StoreCollisionComponentsApiFactory = function (configuration?: Conf
11747
12392
  return localVarFp.listCollisionLinkChains(cell, options).then((request) => request(axios, basePath));
11748
12393
  },
11749
12394
  /**
11750
- * Returns a list of colliders in a scene. This excludes colliders that are part of a motion group.
12395
+ * Returns all stored colliders.
11751
12396
  * @summary List Colliders
11752
12397
  * @param {string} cell Unique identifier addressing a cell in all API calls.
11753
12398
  * @param {*} [options] Override http request option.
@@ -11903,7 +12548,7 @@ export class StoreCollisionComponentsApi extends BaseAPI {
11903
12548
  }
11904
12549
 
11905
12550
  /**
11906
- * Returns a list of colliders in a scene. This excludes colliders that are part of a motion group.
12551
+ * Returns all stored colliders.
11907
12552
  * @summary List Colliders
11908
12553
  * @param {string} cell Unique identifier addressing a cell in all API calls.
11909
12554
  * @param {*} [options] Override http request option.