@wandelbots/nova-api 25.8.0-dev.7 → 25.8.0-dev.71

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
  */
@@ -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
  */
@@ -2801,25 +2847,6 @@ export const LicenseStatusEnum = {
2801
2847
  export type LicenseStatusEnum = typeof LicenseStatusEnum[keyof typeof LicenseStatusEnum];
2802
2848
 
2803
2849
 
2804
- /**
2805
- *
2806
- * @export
2807
- * @interface LimitConfig
2808
- */
2809
- export interface LimitConfig {
2810
- /**
2811
- *
2812
- * @type {LimitSet}
2813
- * @memberof LimitConfig
2814
- */
2815
- 'physical_limits'?: LimitSet;
2816
- /**
2817
- *
2818
- * @type {OperationLimits}
2819
- * @memberof LimitConfig
2820
- */
2821
- 'operation_limits'?: OperationLimits;
2822
- }
2823
2850
  /**
2824
2851
  * The upper_limit must be greater then the lower_limit.
2825
2852
  * @export
@@ -2869,6 +2896,12 @@ export interface LimitSet {
2869
2896
  * @memberof LimitSet
2870
2897
  */
2871
2898
  'flange'?: CartesianLimits;
2899
+ /**
2900
+ *
2901
+ * @type {JointLimits}
2902
+ * @memberof LimitSet
2903
+ */
2904
+ 'coupled_shoulder_elbow_joint'?: JointLimits;
2872
2905
  }
2873
2906
  /**
2874
2907
  * If a limit is not set, the default value will be used.
@@ -2944,13 +2977,13 @@ export type Manufacturer = typeof Manufacturer[keyof typeof Manufacturer];
2944
2977
 
2945
2978
 
2946
2979
  /**
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.
2980
+ *
2948
2981
  * @export
2949
2982
  * @interface MidpointInsertionAlgorithm
2950
2983
  */
2951
2984
  export interface MidpointInsertionAlgorithm {
2952
2985
  /**
2953
- * Algorithm discriminator.
2986
+ * 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
2987
  * @type {string}
2955
2988
  * @memberof MidpointInsertionAlgorithm
2956
2989
  */
@@ -3043,13 +3076,13 @@ export interface MotionGroupDescription {
3043
3076
  * @type {Pose}
3044
3077
  * @memberof MotionGroupDescription
3045
3078
  */
3046
- 'mounting': Pose;
3079
+ 'mounting'?: Pose;
3047
3080
  /**
3048
3081
  * Maps a TCP name to its offset relative to the flange coordinate system. Key must be a TCP identifier. Values are TcpOffsets.
3049
3082
  * @type {{ [key: string]: TcpOffset; }}
3050
3083
  * @memberof MotionGroupDescription
3051
3084
  */
3052
- 'tcps': { [key: string]: TcpOffset; };
3085
+ 'tcps'?: { [key: string]: TcpOffset; };
3053
3086
  /**
3054
3087
  * A collection of identifiable colliders.
3055
3088
  * @type {{ [key: string]: Collider; }}
@@ -3070,10 +3103,10 @@ export interface MotionGroupDescription {
3070
3103
  'safety_tool_colliders'?: { [key: string]: { [key: string]: Collider; }; };
3071
3104
  /**
3072
3105
  *
3073
- * @type {LimitConfig}
3106
+ * @type {OperationLimits}
3074
3107
  * @memberof MotionGroupDescription
3075
3108
  */
3076
- 'global_limits': LimitConfig;
3109
+ 'operation_limits': OperationLimits;
3077
3110
  /**
3078
3111
  * Maps a payload name to its configuration. Key must be a payload identifier. Values are payload objects.
3079
3112
  * @type {{ [key: string]: Payload; }}
@@ -3849,11 +3882,11 @@ export interface PlanTrajectoryFailedResponse {
3849
3882
  */
3850
3883
  'error_feedback': PlanTrajectoryFailedResponseErrorFeedback;
3851
3884
  /**
3852
- *
3885
+ * 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
3886
  * @type {number}
3854
3887
  * @memberof PlanTrajectoryFailedResponse
3855
3888
  */
3856
- 'error_location_on_trajectory'?: number;
3889
+ 'error_location_on_trajectory': number;
3857
3890
  /**
3858
3891
  * The joint trajectory from the start joint position to the error.
3859
3892
  * @type {JointTrajectory}
@@ -4071,17 +4104,17 @@ export interface ProfinetDescription {
4071
4104
  */
4072
4105
  'slots'?: Array<ProfinetSlotDescription>;
4073
4106
  /**
4074
- * Name of the PROFINET device
4107
+ * 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
4108
  * @type {string}
4076
4109
  * @memberof ProfinetDescription
4077
4110
  */
4078
4111
  'device_name'?: string;
4079
4112
  /**
4080
- * IP address for the PROFINET device
4081
- * @type {string}
4113
+ *
4114
+ * @type {BusIOProfinetIpConfig}
4082
4115
  * @memberof ProfinetDescription
4083
4116
  */
4084
- 'ip'?: string;
4117
+ 'ip_config'?: BusIOProfinetIpConfig;
4085
4118
  }
4086
4119
  /**
4087
4120
  *
@@ -4090,7 +4123,7 @@ export interface ProfinetDescription {
4090
4123
  */
4091
4124
  export interface ProfinetIO {
4092
4125
  /**
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.
4126
+ * 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
4127
  * @type {string}
4095
4128
  * @memberof ProfinetIO
4096
4129
  */
@@ -4102,25 +4135,25 @@ export interface ProfinetIO {
4102
4135
  */
4103
4136
  'type': ProfinetIOTypeEnum;
4104
4137
  /**
4105
- * The direction of the input/output value, indicating whether it is an input or output for the device.
4138
+ * 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
4139
  * @type {ProfinetIODirection}
4107
4140
  * @memberof ProfinetIO
4108
4141
  */
4109
4142
  'direction': ProfinetIODirection;
4110
4143
  /**
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.
4144
+ * 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
4145
  * @type {number}
4113
4146
  * @memberof ProfinetIO
4114
4147
  */
4115
4148
  'byte_address': number;
4116
4149
  /**
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.
4150
+ * 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
4151
  * @type {number}
4119
4152
  * @memberof ProfinetIO
4120
4153
  */
4121
4154
  'bit_address'?: number;
4122
4155
  /**
4123
- * The unique identifier for the input/output value. This identifier is used to reference the specific input/output in the NOVA system.
4156
+ * 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
4157
  * @type {string}
4125
4158
  * @memberof ProfinetIO
4126
4159
  */
@@ -4135,7 +4168,7 @@ export interface ProfinetIO {
4135
4168
  */
4136
4169
  export interface ProfinetIOData {
4137
4170
  /**
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.
4171
+ * 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
4172
  * @type {string}
4140
4173
  * @memberof ProfinetIOData
4141
4174
  */
@@ -4147,19 +4180,19 @@ export interface ProfinetIOData {
4147
4180
  */
4148
4181
  'type': ProfinetIOTypeEnum;
4149
4182
  /**
4150
- * The direction of the input/output value, indicating whether it is an input or output for the device.
4183
+ * 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
4184
  * @type {ProfinetIODirection}
4152
4185
  * @memberof ProfinetIOData
4153
4186
  */
4154
4187
  'direction': ProfinetIODirection;
4155
4188
  /**
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.
4189
+ * 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
4190
  * @type {number}
4158
4191
  * @memberof ProfinetIOData
4159
4192
  */
4160
4193
  'byte_address': number;
4161
4194
  /**
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.
4195
+ * 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
4196
  * @type {number}
4164
4197
  * @memberof ProfinetIOData
4165
4198
  */
@@ -4168,7 +4201,7 @@ export interface ProfinetIOData {
4168
4201
 
4169
4202
 
4170
4203
  /**
4171
- * Identifies the input/output type.
4204
+ * 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
4205
  * @export
4173
4206
  * @enum {string}
4174
4207
  */
@@ -4183,7 +4216,7 @@ export type ProfinetIODirection = typeof ProfinetIODirection[keyof typeof Profin
4183
4216
 
4184
4217
 
4185
4218
  /**
4186
- * Value type of the PROFINET input/output.
4219
+ * Value type of the PROFINET input/output variable. Is used to interpret the corresponding bits correctly.
4187
4220
  * @export
4188
4221
  * @enum {string}
4189
4222
  */
@@ -4211,38 +4244,38 @@ export type ProfinetIOTypeEnum = typeof ProfinetIOTypeEnum[keyof typeof Profinet
4211
4244
  */
4212
4245
  export interface ProfinetInputOutputConfig {
4213
4246
  /**
4214
- * Content of the input output configuration file.
4247
+ * 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
4248
  * @type {string}
4216
4249
  * @memberof ProfinetInputOutputConfig
4217
4250
  */
4218
4251
  'config': string;
4219
4252
  /**
4220
- * Offset in bytes for the input data.
4253
+ * 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
4254
  * @type {number}
4222
4255
  * @memberof ProfinetInputOutputConfig
4223
4256
  */
4224
4257
  'input_offset': number;
4225
4258
  /**
4226
- * Offset in bytes for the output data.
4259
+ * 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
4260
  * @type {number}
4228
4261
  * @memberof ProfinetInputOutputConfig
4229
4262
  */
4230
4263
  'output_offset': number;
4231
4264
  }
4232
4265
  /**
4233
- *
4266
+ * 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
4267
  * @export
4235
4268
  * @interface ProfinetSlotDescription
4236
4269
  */
4237
4270
  export interface ProfinetSlotDescription {
4238
4271
  /**
4239
- * The number of the PROFINET slot.
4272
+ * 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
4273
  * @type {number}
4241
4274
  * @memberof ProfinetSlotDescription
4242
4275
  */
4243
4276
  'number': number;
4244
4277
  /**
4245
- * The API number of the PROFINET input, used to identify the specific API for the input.
4278
+ * The application process identifier (API) number of the PROFINET input. The API identifies the application relation (AR) that is using the slot.
4246
4279
  * @type {number}
4247
4280
  * @memberof ProfinetSlotDescription
4248
4281
  */
@@ -4261,32 +4294,180 @@ export interface ProfinetSlotDescription {
4261
4294
  */
4262
4295
  export interface ProfinetSubSlotDescription {
4263
4296
  /**
4264
- * The identifier of the PROFINET subslot.
4297
+ * The number/index of the PROFINET subslot.
4265
4298
  * @type {number}
4266
4299
  * @memberof ProfinetSubSlotDescription
4267
4300
  */
4268
4301
  'number': number;
4269
4302
  /**
4270
- * The length in bytes of the PROFINET input.
4303
+ * The amount of bytes allocated for the subslot in the input process image buffer.
4271
4304
  * @type {number}
4272
4305
  * @memberof ProfinetSubSlotDescription
4273
4306
  */
4274
4307
  'input_length': number;
4275
4308
  /**
4276
- * The length in bytes of the PROFINET output.
4309
+ * The amount of bytes allocated for the subslot in the output process image buffer.
4277
4310
  * @type {number}
4278
4311
  * @memberof ProfinetSubSlotDescription
4279
4312
  */
4280
4313
  'output_length': number;
4281
4314
  }
4282
4315
  /**
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.
4316
+ * A program is a collection of instructions that are executed in the robot cell.
4317
+ * @export
4318
+ * @interface Program
4319
+ */
4320
+ export interface Program {
4321
+ /**
4322
+ *
4323
+ * @type {string}
4324
+ * @memberof Program
4325
+ */
4326
+ 'program': string;
4327
+ /**
4328
+ *
4329
+ * @type {string}
4330
+ * @memberof Program
4331
+ */
4332
+ 'name'?: string;
4333
+ /**
4334
+ *
4335
+ * @type {string}
4336
+ * @memberof Program
4337
+ */
4338
+ 'description'?: string;
4339
+ /**
4340
+ *
4341
+ * @type {string}
4342
+ * @memberof Program
4343
+ */
4344
+ 'app': string;
4345
+ /**
4346
+ *
4347
+ * @type {object}
4348
+ * @memberof Program
4349
+ */
4350
+ 'input_schema'?: object;
4351
+ /**
4352
+ *
4353
+ * @type {object}
4354
+ * @memberof Program
4355
+ */
4356
+ 'preconditions'?: object;
4357
+ }
4358
+ /**
4359
+ * Holds the state of a program run.
4360
+ * @export
4361
+ * @interface ProgramRun
4362
+ */
4363
+ export interface ProgramRun {
4364
+ /**
4365
+ * Unique identifier of the program run
4366
+ * @type {string}
4367
+ * @memberof ProgramRun
4368
+ */
4369
+ 'run': string;
4370
+ /**
4371
+ * Unique identifier of the program
4372
+ * @type {string}
4373
+ * @memberof ProgramRun
4374
+ */
4375
+ 'program': string;
4376
+ /**
4377
+ * State of the program run
4378
+ * @type {ProgramRunState}
4379
+ * @memberof ProgramRun
4380
+ */
4381
+ 'state': ProgramRunState;
4382
+ /**
4383
+ * Logs of the program run
4384
+ * @type {string}
4385
+ * @memberof ProgramRun
4386
+ */
4387
+ 'logs'?: string;
4388
+ /**
4389
+ * Stdout of the program run
4390
+ * @type {string}
4391
+ * @memberof ProgramRun
4392
+ */
4393
+ 'stdout'?: string;
4394
+ /**
4395
+ * Stderr of the program run
4396
+ * @type {string}
4397
+ * @memberof ProgramRun
4398
+ */
4399
+ 'stderr'?: string;
4400
+ /**
4401
+ * Error message of the program run, if any
4402
+ * @type {string}
4403
+ * @memberof ProgramRun
4404
+ */
4405
+ 'error'?: string;
4406
+ /**
4407
+ * Traceback of the program run, if any
4408
+ * @type {string}
4409
+ * @memberof ProgramRun
4410
+ */
4411
+ 'traceback'?: string;
4412
+ /**
4413
+ * Start time of the program run
4414
+ * @type {string}
4415
+ * @memberof ProgramRun
4416
+ */
4417
+ 'start_time'?: string;
4418
+ /**
4419
+ * End time of the program run
4420
+ * @type {string}
4421
+ * @memberof ProgramRun
4422
+ */
4423
+ 'end_time'?: string;
4424
+ /**
4425
+ * Input data of the program run
4426
+ * @type {object}
4427
+ * @memberof ProgramRun
4428
+ */
4429
+ 'input_data'?: object;
4430
+ }
4431
+
4432
+
4433
+ /**
4434
+ * The state of a program run.
4435
+ * @export
4436
+ * @enum {string}
4437
+ */
4438
+
4439
+ export const ProgramRunState = {
4440
+ Preparing: 'PREPARING',
4441
+ Running: 'RUNNING',
4442
+ Completed: 'COMPLETED',
4443
+ Failed: 'FAILED',
4444
+ Stopped: 'STOPPED'
4445
+ } as const;
4446
+
4447
+ export type ProgramRunState = typeof ProgramRunState[keyof typeof ProgramRunState];
4448
+
4449
+
4450
+ /**
4451
+ * The state of a program run.
4452
+ * @export
4453
+ * @interface ProgramStartRequest
4454
+ */
4455
+ export interface ProgramStartRequest {
4456
+ /**
4457
+ * The arguments to pass to the program.
4458
+ * @type {object}
4459
+ * @memberof ProgramStartRequest
4460
+ */
4461
+ 'arguments': object;
4462
+ }
4463
+ /**
4464
+ *
4284
4465
  * @export
4285
4466
  * @interface RRTConnectAlgorithm
4286
4467
  */
4287
4468
  export interface RRTConnectAlgorithm {
4288
4469
  /**
4289
- * Algorithm discriminator.
4470
+ * 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
4471
  * @type {string}
4291
4472
  * @memberof RRTConnectAlgorithm
4292
4473
  */
@@ -4297,6 +4478,30 @@ export interface RRTConnectAlgorithm {
4297
4478
  * @memberof RRTConnectAlgorithm
4298
4479
  */
4299
4480
  'max_iterations'?: number;
4481
+ /**
4482
+ * Maximum step size for tree extension in joint space.
4483
+ * @type {number}
4484
+ * @memberof RRTConnectAlgorithm
4485
+ */
4486
+ 'max_step_size'?: number;
4487
+ /**
4488
+ * Adjust the maximum step size during the search based on the recent success rate of tree expansion.
4489
+ * @type {boolean}
4490
+ * @memberof RRTConnectAlgorithm
4491
+ */
4492
+ 'adaptive_step_size'?: boolean;
4493
+ /**
4494
+ * Apply smoothing after the search has succeeded. This will remove as many intermediate points as possible while keeping the path valid.
4495
+ * @type {boolean}
4496
+ * @memberof RRTConnectAlgorithm
4497
+ */
4498
+ 'apply_smoothing'?: boolean;
4499
+ /**
4500
+ * Apply blending after the search has succeeded and smoothing has been applied. This will apply the largest viable blending at each intermediate point.
4501
+ * @type {boolean}
4502
+ * @memberof RRTConnectAlgorithm
4503
+ */
4504
+ 'apply_blending'?: boolean;
4300
4505
  }
4301
4506
 
4302
4507
  export const RRTConnectAlgorithmAlgorithmNameEnum = {
@@ -4726,6 +4931,25 @@ export interface ServiceStatusStatus {
4726
4931
  }
4727
4932
 
4728
4933
 
4934
+ /**
4935
+ * Defines an input/output that should be set upon reaching a specified location on the trajectory.
4936
+ * @export
4937
+ * @interface SetIO
4938
+ */
4939
+ export interface SetIO {
4940
+ /**
4941
+ *
4942
+ * @type {IOValue}
4943
+ * @memberof SetIO
4944
+ */
4945
+ 'io': IOValue;
4946
+ /**
4947
+ * The location on the trajectory where the input/output should be set.
4948
+ * @type {number}
4949
+ * @memberof SetIO
4950
+ */
4951
+ 'location': number;
4952
+ }
4729
4953
  /**
4730
4954
  *
4731
4955
  * @export
@@ -4801,10 +5025,10 @@ export interface StartMovementRequest {
4801
5025
  'direction'?: Direction;
4802
5026
  /**
4803
5027
  * 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>}
5028
+ * @type {Array<SetIO>}
4805
5029
  * @memberof StartMovementRequest
4806
5030
  */
4807
- 'set_outputs'?: Array<IOValue>;
5031
+ 'set_outputs'?: Array<SetIO>;
4808
5032
  /**
4809
5033
  * Defines an input/output that is listened to before the movement. Execution starts if the defined comparator evaluates to `true`.
4810
5034
  * @type {StartOnIO}
@@ -5076,7 +5300,7 @@ export interface TrajectoryDetails {
5076
5300
  */
5077
5301
  'trajectory': string;
5078
5302
  /**
5079
- * Current location of motion group on the trajectory.
5303
+ * 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
5304
  * @type {number}
5081
5305
  * @memberof TrajectoryDetails
5082
5306
  */
@@ -5138,7 +5362,7 @@ export interface TrajectoryId {
5138
5362
  * @type {string}
5139
5363
  * @memberof TrajectoryId
5140
5364
  */
5141
- 'message_type'?: TrajectoryIdMessageTypeEnum;
5365
+ 'message_type': TrajectoryIdMessageTypeEnum;
5142
5366
  /**
5143
5367
  * The identifier of the trajectory which was returned by the [addTrajectory](addTrajectory) endpoint.
5144
5368
  * @type {string}
@@ -5333,6 +5557,31 @@ export interface ValidationError {
5333
5557
  */
5334
5558
  'input': { [key: string]: any; };
5335
5559
  }
5560
+ /**
5561
+ * A validation error of a program.
5562
+ * @export
5563
+ * @interface ValidationError2
5564
+ */
5565
+ export interface ValidationError2 {
5566
+ /**
5567
+ *
5568
+ * @type {Array<number>}
5569
+ * @memberof ValidationError2
5570
+ */
5571
+ 'loc': Array<number>;
5572
+ /**
5573
+ *
5574
+ * @type {string}
5575
+ * @memberof ValidationError2
5576
+ */
5577
+ 'msg': string;
5578
+ /**
5579
+ *
5580
+ * @type {string}
5581
+ * @memberof ValidationError2
5582
+ */
5583
+ 'type': string;
5584
+ }
5336
5585
  /**
5337
5586
  * @type ValidationErrorLocInner
5338
5587
  * @export
@@ -5460,11 +5709,13 @@ export const VirtualControllerTypes = {
5460
5709
  KukaKr4R600: 'kuka-kr4_r600',
5461
5710
  KukaKr500L3403: 'kuka-kr500_l340_3',
5462
5711
  KukaKr50R2500: 'kuka-kr50_r2500',
5712
+ KukaKr60R3: 'kuka-kr60_r3',
5463
5713
  KukaKr6R1820: 'kuka-kr6_r1820',
5464
5714
  KukaKr6R7002: 'kuka-kr6_r700_2',
5465
5715
  KukaKr6R700Sixx: 'kuka-kr6_r700_sixx',
5466
5716
  KukaKr6R900: 'kuka-kr6_r900',
5467
5717
  KukaKr6R9002: 'kuka-kr6_r900_2',
5718
+ KukaKr70R2100: 'kuka-kr70_r2100',
5468
5719
  KukaLbrIisy11R1300: 'kuka-lbr_iisy_11_r1300',
5469
5720
  UniversalrobotsUr10cb: 'universalrobots-ur10cb',
5470
5721
  UniversalrobotsUr10e: 'universalrobots-ur10e',
@@ -6150,7 +6401,7 @@ export class ApplicationApi extends BaseAPI {
6150
6401
  export const BUSInputsOutputsApiAxiosParamCreator = function (configuration?: Configuration) {
6151
6402
  return {
6152
6403
  /**
6153
- * Add a BUS Inputs/Outputs Service to the cell.
6404
+ * Add the BUS inputs/outputs service to the cell. Starts a containerized service that enables BUS connections via the specified ethernet port.
6154
6405
  * @summary Add Service
6155
6406
  * @param {string} cell Unique identifier addressing a cell in all API calls.
6156
6407
  * @param {BusIOType} busIOType
@@ -6203,7 +6454,7 @@ export const BUSInputsOutputsApiAxiosParamCreator = function (configuration?: Co
6203
6454
  };
6204
6455
  },
6205
6456
  /**
6206
- * Adds an input/output to or updates an input/output on the PROFINET device.
6457
+ * 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
6458
  * @summary Add PROFINET Input/Output
6208
6459
  * @param {string} cell Unique identifier addressing a cell in all API calls.
6209
6460
  * @param {string} io Unique identifier to address an Input/Output in the cell.
@@ -6255,7 +6506,7 @@ export const BUSInputsOutputsApiAxiosParamCreator = function (configuration?: Co
6255
6506
  };
6256
6507
  },
6257
6508
  /**
6258
- * Delete BUS Inputs/Outputs Service from the cell.
6509
+ * Remove the BUS inputs/outputs service from the cell.
6259
6510
  * @summary Clear Service
6260
6511
  * @param {string} cell Unique identifier addressing a cell in all API calls.
6261
6512
  * @param {number} [completionTimeout]
@@ -6302,7 +6553,7 @@ export const BUSInputsOutputsApiAxiosParamCreator = function (configuration?: Co
6302
6553
  };
6303
6554
  },
6304
6555
  /**
6305
- * Removes the input/output from the PROFINET device.
6556
+ * Removes an input/output variable configuration from the PROFINET device, e.g. NOVA\'s PROFINET service.
6306
6557
  * @summary Remove PROFINET Input/Ouptut
6307
6558
  * @param {string} cell Unique identifier addressing a cell in all API calls.
6308
6559
  * @param {string} io Unique identifier to address an Input/Output in the cell.
@@ -6348,7 +6599,7 @@ export const BUSInputsOutputsApiAxiosParamCreator = function (configuration?: Co
6348
6599
  };
6349
6600
  },
6350
6601
  /**
6351
- * Get deployed BUS Inputs/Outputs Service.
6602
+ * Get deployed BUS inputs/outputs service.
6352
6603
  * @summary Get Service
6353
6604
  * @param {string} cell Unique identifier addressing a cell in all API calls.
6354
6605
  * @param {*} [options] Override http request option.
@@ -6479,7 +6730,7 @@ export const BUSInputsOutputsApiAxiosParamCreator = function (configuration?: Co
6479
6730
  };
6480
6731
  },
6481
6732
  /**
6482
- * Get description of PROFINET
6733
+ * Get description of NOVA as a PROFINET device.
6483
6734
  * @summary Get PROFINET Description
6484
6735
  * @param {string} cell Unique identifier addressing a cell in all API calls.
6485
6736
  * @param {*} [options] Override http request option.
@@ -6521,7 +6772,7 @@ export const BUSInputsOutputsApiAxiosParamCreator = function (configuration?: Co
6521
6772
  };
6522
6773
  },
6523
6774
  /**
6524
- * Get input/output configuration of the PROFINET device as file.
6775
+ * 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
6776
  * @summary PROFINET Inputs/Outputs to File
6526
6777
  * @param {string} cell Unique identifier addressing a cell in all API calls.
6527
6778
  * @param {number} [inputOffset]
@@ -6573,7 +6824,7 @@ export const BUSInputsOutputsApiAxiosParamCreator = function (configuration?: Co
6573
6824
  };
6574
6825
  },
6575
6826
  /**
6576
- * List all BUS Input/Output descriptions.
6827
+ * 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
6828
  * @summary List Descriptions
6578
6829
  * @param {string} cell Unique identifier addressing a cell in all API calls.
6579
6830
  * @param {*} [options] Override http request option.
@@ -6615,7 +6866,7 @@ export const BUSInputsOutputsApiAxiosParamCreator = function (configuration?: Co
6615
6866
  };
6616
6867
  },
6617
6868
  /**
6618
- * List all PROFINET input and outputs.
6869
+ * 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
6870
  * @summary List PROFINET Input/Output Configuration
6620
6871
  * @param {string} cell Unique identifier addressing a cell in all API calls.
6621
6872
  * @param {*} [options] Override http request option.
@@ -6705,7 +6956,7 @@ export const BUSInputsOutputsApiAxiosParamCreator = function (configuration?: Co
6705
6956
  };
6706
6957
  },
6707
6958
  /**
6708
- * Sets inputs/outputs on the PROFINET device from file.
6959
+ * 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
6960
  * @summary Set PROFINET Inputs/Outputs from File
6710
6961
  * @param {string} cell Unique identifier addressing a cell in all API calls.
6711
6962
  * @param {ProfinetInputOutputConfig} profinetInputOutputConfig
@@ -6763,7 +7014,7 @@ export const BUSInputsOutputsApiFp = function(configuration?: Configuration) {
6763
7014
  const localVarAxiosParamCreator = BUSInputsOutputsApiAxiosParamCreator(configuration)
6764
7015
  return {
6765
7016
  /**
6766
- * Add a BUS Inputs/Outputs Service to the cell.
7017
+ * Add the BUS inputs/outputs service to the cell. Starts a containerized service that enables BUS connections via the specified ethernet port.
6767
7018
  * @summary Add Service
6768
7019
  * @param {string} cell Unique identifier addressing a cell in all API calls.
6769
7020
  * @param {BusIOType} busIOType
@@ -6778,7 +7029,7 @@ export const BUSInputsOutputsApiFp = function(configuration?: Configuration) {
6778
7029
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
6779
7030
  },
6780
7031
  /**
6781
- * Adds an input/output to or updates an input/output on the PROFINET device.
7032
+ * 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
7033
  * @summary Add PROFINET Input/Output
6783
7034
  * @param {string} cell Unique identifier addressing a cell in all API calls.
6784
7035
  * @param {string} io Unique identifier to address an Input/Output in the cell.
@@ -6793,7 +7044,7 @@ export const BUSInputsOutputsApiFp = function(configuration?: Configuration) {
6793
7044
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
6794
7045
  },
6795
7046
  /**
6796
- * Delete BUS Inputs/Outputs Service from the cell.
7047
+ * Remove the BUS inputs/outputs service from the cell.
6797
7048
  * @summary Clear Service
6798
7049
  * @param {string} cell Unique identifier addressing a cell in all API calls.
6799
7050
  * @param {number} [completionTimeout]
@@ -6807,7 +7058,7 @@ export const BUSInputsOutputsApiFp = function(configuration?: Configuration) {
6807
7058
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
6808
7059
  },
6809
7060
  /**
6810
- * Removes the input/output from the PROFINET device.
7061
+ * Removes an input/output variable configuration from the PROFINET device, e.g. NOVA\'s PROFINET service.
6811
7062
  * @summary Remove PROFINET Input/Ouptut
6812
7063
  * @param {string} cell Unique identifier addressing a cell in all API calls.
6813
7064
  * @param {string} io Unique identifier to address an Input/Output in the cell.
@@ -6821,7 +7072,7 @@ export const BUSInputsOutputsApiFp = function(configuration?: Configuration) {
6821
7072
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
6822
7073
  },
6823
7074
  /**
6824
- * Get deployed BUS Inputs/Outputs Service.
7075
+ * Get deployed BUS inputs/outputs service.
6825
7076
  * @summary Get Service
6826
7077
  * @param {string} cell Unique identifier addressing a cell in all API calls.
6827
7078
  * @param {*} [options] Override http request option.
@@ -6861,7 +7112,7 @@ export const BUSInputsOutputsApiFp = function(configuration?: Configuration) {
6861
7112
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
6862
7113
  },
6863
7114
  /**
6864
- * Get description of PROFINET
7115
+ * Get description of NOVA as a PROFINET device.
6865
7116
  * @summary Get PROFINET Description
6866
7117
  * @param {string} cell Unique identifier addressing a cell in all API calls.
6867
7118
  * @param {*} [options] Override http request option.
@@ -6874,7 +7125,7 @@ export const BUSInputsOutputsApiFp = function(configuration?: Configuration) {
6874
7125
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
6875
7126
  },
6876
7127
  /**
6877
- * Get input/output configuration of the PROFINET device as file.
7128
+ * 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
7129
  * @summary PROFINET Inputs/Outputs to File
6879
7130
  * @param {string} cell Unique identifier addressing a cell in all API calls.
6880
7131
  * @param {number} [inputOffset]
@@ -6889,20 +7140,20 @@ export const BUSInputsOutputsApiFp = function(configuration?: Configuration) {
6889
7140
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
6890
7141
  },
6891
7142
  /**
6892
- * List all BUS Input/Output descriptions.
7143
+ * 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
7144
  * @summary List Descriptions
6894
7145
  * @param {string} cell Unique identifier addressing a cell in all API calls.
6895
7146
  * @param {*} [options] Override http request option.
6896
7147
  * @throws {RequiredError}
6897
7148
  */
6898
- async listBusIODescriptions(cell: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<IODescription>>> {
7149
+ async listBusIODescriptions(cell: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<IODescription2>>> {
6899
7150
  const localVarAxiosArgs = await localVarAxiosParamCreator.listBusIODescriptions(cell, options);
6900
7151
  const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
6901
7152
  const localVarOperationServerBasePath = operationServerMap['BUSInputsOutputsApi.listBusIODescriptions']?.[localVarOperationServerIndex]?.url;
6902
7153
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
6903
7154
  },
6904
7155
  /**
6905
- * List all PROFINET input and outputs.
7156
+ * 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
7157
  * @summary List PROFINET Input/Output Configuration
6907
7158
  * @param {string} cell Unique identifier addressing a cell in all API calls.
6908
7159
  * @param {*} [options] Override http request option.
@@ -6929,7 +7180,7 @@ export const BUSInputsOutputsApiFp = function(configuration?: Configuration) {
6929
7180
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
6930
7181
  },
6931
7182
  /**
6932
- * Sets inputs/outputs on the PROFINET device from file.
7183
+ * 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
7184
  * @summary Set PROFINET Inputs/Outputs from File
6934
7185
  * @param {string} cell Unique identifier addressing a cell in all API calls.
6935
7186
  * @param {ProfinetInputOutputConfig} profinetInputOutputConfig
@@ -6953,7 +7204,7 @@ export const BUSInputsOutputsApiFactory = function (configuration?: Configuratio
6953
7204
  const localVarFp = BUSInputsOutputsApiFp(configuration)
6954
7205
  return {
6955
7206
  /**
6956
- * Add a BUS Inputs/Outputs Service to the cell.
7207
+ * Add the BUS inputs/outputs service to the cell. Starts a containerized service that enables BUS connections via the specified ethernet port.
6957
7208
  * @summary Add Service
6958
7209
  * @param {string} cell Unique identifier addressing a cell in all API calls.
6959
7210
  * @param {BusIOType} busIOType
@@ -6965,7 +7216,7 @@ export const BUSInputsOutputsApiFactory = function (configuration?: Configuratio
6965
7216
  return localVarFp.addBusIOService(cell, busIOType, completionTimeout, options).then((request) => request(axios, basePath));
6966
7217
  },
6967
7218
  /**
6968
- * Adds an input/output to or updates an input/output on the PROFINET device.
7219
+ * 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
7220
  * @summary Add PROFINET Input/Output
6970
7221
  * @param {string} cell Unique identifier addressing a cell in all API calls.
6971
7222
  * @param {string} io Unique identifier to address an Input/Output in the cell.
@@ -6977,7 +7228,7 @@ export const BUSInputsOutputsApiFactory = function (configuration?: Configuratio
6977
7228
  return localVarFp.addProfinetIO(cell, io, profinetIOData, options).then((request) => request(axios, basePath));
6978
7229
  },
6979
7230
  /**
6980
- * Delete BUS Inputs/Outputs Service from the cell.
7231
+ * Remove the BUS inputs/outputs service from the cell.
6981
7232
  * @summary Clear Service
6982
7233
  * @param {string} cell Unique identifier addressing a cell in all API calls.
6983
7234
  * @param {number} [completionTimeout]
@@ -6988,7 +7239,7 @@ export const BUSInputsOutputsApiFactory = function (configuration?: Configuratio
6988
7239
  return localVarFp.clearBusIOService(cell, completionTimeout, options).then((request) => request(axios, basePath));
6989
7240
  },
6990
7241
  /**
6991
- * Removes the input/output from the PROFINET device.
7242
+ * Removes an input/output variable configuration from the PROFINET device, e.g. NOVA\'s PROFINET service.
6992
7243
  * @summary Remove PROFINET Input/Ouptut
6993
7244
  * @param {string} cell Unique identifier addressing a cell in all API calls.
6994
7245
  * @param {string} io Unique identifier to address an Input/Output in the cell.
@@ -6999,7 +7250,7 @@ export const BUSInputsOutputsApiFactory = function (configuration?: Configuratio
6999
7250
  return localVarFp.deleteProfinetIO(cell, io, options).then((request) => request(axios, basePath));
7000
7251
  },
7001
7252
  /**
7002
- * Get deployed BUS Inputs/Outputs Service.
7253
+ * Get deployed BUS inputs/outputs service.
7003
7254
  * @summary Get Service
7004
7255
  * @param {string} cell Unique identifier addressing a cell in all API calls.
7005
7256
  * @param {*} [options] Override http request option.
@@ -7030,7 +7281,7 @@ export const BUSInputsOutputsApiFactory = function (configuration?: Configuratio
7030
7281
  return localVarFp.getBusIOValues(cell, ios, options).then((request) => request(axios, basePath));
7031
7282
  },
7032
7283
  /**
7033
- * Get description of PROFINET
7284
+ * Get description of NOVA as a PROFINET device.
7034
7285
  * @summary Get PROFINET Description
7035
7286
  * @param {string} cell Unique identifier addressing a cell in all API calls.
7036
7287
  * @param {*} [options] Override http request option.
@@ -7040,7 +7291,7 @@ export const BUSInputsOutputsApiFactory = function (configuration?: Configuratio
7040
7291
  return localVarFp.getProfinetDescription(cell, options).then((request) => request(axios, basePath));
7041
7292
  },
7042
7293
  /**
7043
- * Get input/output configuration of the PROFINET device as file.
7294
+ * 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
7295
  * @summary PROFINET Inputs/Outputs to File
7045
7296
  * @param {string} cell Unique identifier addressing a cell in all API calls.
7046
7297
  * @param {number} [inputOffset]
@@ -7052,17 +7303,17 @@ export const BUSInputsOutputsApiFactory = function (configuration?: Configuratio
7052
7303
  return localVarFp.getProfinetIOsFromFile(cell, inputOffset, outputOffset, options).then((request) => request(axios, basePath));
7053
7304
  },
7054
7305
  /**
7055
- * List all BUS Input/Output descriptions.
7306
+ * 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
7307
  * @summary List Descriptions
7057
7308
  * @param {string} cell Unique identifier addressing a cell in all API calls.
7058
7309
  * @param {*} [options] Override http request option.
7059
7310
  * @throws {RequiredError}
7060
7311
  */
7061
- listBusIODescriptions(cell: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<IODescription>> {
7312
+ listBusIODescriptions(cell: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<IODescription2>> {
7062
7313
  return localVarFp.listBusIODescriptions(cell, options).then((request) => request(axios, basePath));
7063
7314
  },
7064
7315
  /**
7065
- * List all PROFINET input and outputs.
7316
+ * 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
7317
  * @summary List PROFINET Input/Output Configuration
7067
7318
  * @param {string} cell Unique identifier addressing a cell in all API calls.
7068
7319
  * @param {*} [options] Override http request option.
@@ -7083,7 +7334,7 @@ export const BUSInputsOutputsApiFactory = function (configuration?: Configuratio
7083
7334
  return localVarFp.setBusIOValues(cell, iOValue, options).then((request) => request(axios, basePath));
7084
7335
  },
7085
7336
  /**
7086
- * Sets inputs/outputs on the PROFINET device from file.
7337
+ * 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
7338
  * @summary Set PROFINET Inputs/Outputs from File
7088
7339
  * @param {string} cell Unique identifier addressing a cell in all API calls.
7089
7340
  * @param {ProfinetInputOutputConfig} profinetInputOutputConfig
@@ -7104,7 +7355,7 @@ export const BUSInputsOutputsApiFactory = function (configuration?: Configuratio
7104
7355
  */
7105
7356
  export class BUSInputsOutputsApi extends BaseAPI {
7106
7357
  /**
7107
- * Add a BUS Inputs/Outputs Service to the cell.
7358
+ * Add the BUS inputs/outputs service to the cell. Starts a containerized service that enables BUS connections via the specified ethernet port.
7108
7359
  * @summary Add Service
7109
7360
  * @param {string} cell Unique identifier addressing a cell in all API calls.
7110
7361
  * @param {BusIOType} busIOType
@@ -7118,7 +7369,7 @@ export class BUSInputsOutputsApi extends BaseAPI {
7118
7369
  }
7119
7370
 
7120
7371
  /**
7121
- * Adds an input/output to or updates an input/output on the PROFINET device.
7372
+ * 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
7373
  * @summary Add PROFINET Input/Output
7123
7374
  * @param {string} cell Unique identifier addressing a cell in all API calls.
7124
7375
  * @param {string} io Unique identifier to address an Input/Output in the cell.
@@ -7132,7 +7383,7 @@ export class BUSInputsOutputsApi extends BaseAPI {
7132
7383
  }
7133
7384
 
7134
7385
  /**
7135
- * Delete BUS Inputs/Outputs Service from the cell.
7386
+ * Remove the BUS inputs/outputs service from the cell.
7136
7387
  * @summary Clear Service
7137
7388
  * @param {string} cell Unique identifier addressing a cell in all API calls.
7138
7389
  * @param {number} [completionTimeout]
@@ -7145,7 +7396,7 @@ export class BUSInputsOutputsApi extends BaseAPI {
7145
7396
  }
7146
7397
 
7147
7398
  /**
7148
- * Removes the input/output from the PROFINET device.
7399
+ * Removes an input/output variable configuration from the PROFINET device, e.g. NOVA\'s PROFINET service.
7149
7400
  * @summary Remove PROFINET Input/Ouptut
7150
7401
  * @param {string} cell Unique identifier addressing a cell in all API calls.
7151
7402
  * @param {string} io Unique identifier to address an Input/Output in the cell.
@@ -7158,7 +7409,7 @@ export class BUSInputsOutputsApi extends BaseAPI {
7158
7409
  }
7159
7410
 
7160
7411
  /**
7161
- * Get deployed BUS Inputs/Outputs Service.
7412
+ * Get deployed BUS inputs/outputs service.
7162
7413
  * @summary Get Service
7163
7414
  * @param {string} cell Unique identifier addressing a cell in all API calls.
7164
7415
  * @param {*} [options] Override http request option.
@@ -7195,7 +7446,7 @@ export class BUSInputsOutputsApi extends BaseAPI {
7195
7446
  }
7196
7447
 
7197
7448
  /**
7198
- * Get description of PROFINET
7449
+ * Get description of NOVA as a PROFINET device.
7199
7450
  * @summary Get PROFINET Description
7200
7451
  * @param {string} cell Unique identifier addressing a cell in all API calls.
7201
7452
  * @param {*} [options] Override http request option.
@@ -7207,7 +7458,7 @@ export class BUSInputsOutputsApi extends BaseAPI {
7207
7458
  }
7208
7459
 
7209
7460
  /**
7210
- * Get input/output configuration of the PROFINET device as file.
7461
+ * 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
7462
  * @summary PROFINET Inputs/Outputs to File
7212
7463
  * @param {string} cell Unique identifier addressing a cell in all API calls.
7213
7464
  * @param {number} [inputOffset]
@@ -7221,7 +7472,7 @@ export class BUSInputsOutputsApi extends BaseAPI {
7221
7472
  }
7222
7473
 
7223
7474
  /**
7224
- * List all BUS Input/Output descriptions.
7475
+ * 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
7476
  * @summary List Descriptions
7226
7477
  * @param {string} cell Unique identifier addressing a cell in all API calls.
7227
7478
  * @param {*} [options] Override http request option.
@@ -7233,7 +7484,7 @@ export class BUSInputsOutputsApi extends BaseAPI {
7233
7484
  }
7234
7485
 
7235
7486
  /**
7236
- * List all PROFINET input and outputs.
7487
+ * 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
7488
  * @summary List PROFINET Input/Output Configuration
7238
7489
  * @param {string} cell Unique identifier addressing a cell in all API calls.
7239
7490
  * @param {*} [options] Override http request option.
@@ -7258,7 +7509,7 @@ export class BUSInputsOutputsApi extends BaseAPI {
7258
7509
  }
7259
7510
 
7260
7511
  /**
7261
- * Sets inputs/outputs on the PROFINET device from file.
7512
+ * 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
7513
  * @summary Set PROFINET Inputs/Outputs from File
7263
7514
  * @param {string} cell Unique identifier addressing a cell in all API calls.
7264
7515
  * @param {ProfinetInputOutputConfig} profinetInputOutputConfig
@@ -10725,7 +10976,7 @@ export class MotionGroupApi extends BaseAPI {
10725
10976
  export const MotionGroupModelsApiAxiosParamCreator = function (configuration?: Configuration) {
10726
10977
  return {
10727
10978
  /**
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.
10979
+ * 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
10980
  * @summary Get Collision Model
10730
10981
  * @param {string} cell Unique identifier addressing a cell in all API calls.
10731
10982
  * @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 +11074,7 @@ export const MotionGroupModelsApiFp = function(configuration?: Configuration) {
10823
11074
  const localVarAxiosParamCreator = MotionGroupModelsApiAxiosParamCreator(configuration)
10824
11075
  return {
10825
11076
  /**
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.
11077
+ * 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
11078
  * @summary Get Collision Model
10828
11079
  * @param {string} cell Unique identifier addressing a cell in all API calls.
10829
11080
  * @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 +11111,7 @@ export const MotionGroupModelsApiFactory = function (configuration?: Configurati
10860
11111
  const localVarFp = MotionGroupModelsApiFp(configuration)
10861
11112
  return {
10862
11113
  /**
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.
11114
+ * 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
11115
  * @summary Get Collision Model
10865
11116
  * @param {string} cell Unique identifier addressing a cell in all API calls.
10866
11117
  * @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 +11142,7 @@ export const MotionGroupModelsApiFactory = function (configuration?: Configurati
10891
11142
  */
10892
11143
  export class MotionGroupModelsApi extends BaseAPI {
10893
11144
  /**
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.
11145
+ * 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
11146
  * @summary Get Collision Model
10896
11147
  * @param {string} cell Unique identifier addressing a cell in all API calls.
10897
11148
  * @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 +11169,383 @@ export class MotionGroupModelsApi extends BaseAPI {
10918
11169
 
10919
11170
 
10920
11171
 
11172
+ /**
11173
+ * ProgramApi - axios parameter creator
11174
+ * @export
11175
+ */
11176
+ export const ProgramApiAxiosParamCreator = function (configuration?: Configuration) {
11177
+ return {
11178
+ /**
11179
+ * Get details of a program.
11180
+ * @summary Get program
11181
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
11182
+ * @param {string} program
11183
+ * @param {*} [options] Override http request option.
11184
+ * @throws {RequiredError}
11185
+ */
11186
+ getProgram: async (cell: string, program: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
11187
+ // verify required parameter 'cell' is not null or undefined
11188
+ assertParamExists('getProgram', 'cell', cell)
11189
+ // verify required parameter 'program' is not null or undefined
11190
+ assertParamExists('getProgram', 'program', program)
11191
+ const localVarPath = `/experimental/cells/{cell}/programs/{program}`
11192
+ .replace(`{${"cell"}}`, encodeURIComponent(String(cell)))
11193
+ .replace(`{${"program"}}`, encodeURIComponent(String(program)));
11194
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
11195
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
11196
+ let baseOptions;
11197
+ if (configuration) {
11198
+ baseOptions = configuration.baseOptions;
11199
+ }
11200
+
11201
+ const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
11202
+ const localVarHeaderParameter = {} as any;
11203
+ const localVarQueryParameter = {} as any;
11204
+
11205
+ // authentication BasicAuth required
11206
+ // http basic authentication required
11207
+ setBasicAuthToObject(localVarRequestOptions, configuration)
11208
+
11209
+ // authentication BearerAuth required
11210
+ // http bearer authentication required
11211
+ await setBearerAuthToObject(localVarHeaderParameter, configuration)
11212
+
11213
+
11214
+
11215
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
11216
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
11217
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
11218
+
11219
+ return {
11220
+ url: toPathString(localVarUrlObj),
11221
+ options: localVarRequestOptions,
11222
+ };
11223
+ },
11224
+ /**
11225
+ * List details of all existing programs.
11226
+ * @summary List programs
11227
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
11228
+ * @param {*} [options] Override http request option.
11229
+ * @throws {RequiredError}
11230
+ */
11231
+ listPrograms: async (cell: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
11232
+ // verify required parameter 'cell' is not null or undefined
11233
+ assertParamExists('listPrograms', 'cell', cell)
11234
+ const localVarPath = `/experimental/cells/{cell}/programs`
11235
+ .replace(`{${"cell"}}`, encodeURIComponent(String(cell)));
11236
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
11237
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
11238
+ let baseOptions;
11239
+ if (configuration) {
11240
+ baseOptions = configuration.baseOptions;
11241
+ }
11242
+
11243
+ const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
11244
+ const localVarHeaderParameter = {} as any;
11245
+ const localVarQueryParameter = {} as any;
11246
+
11247
+ // authentication BasicAuth required
11248
+ // http basic authentication required
11249
+ setBasicAuthToObject(localVarRequestOptions, configuration)
11250
+
11251
+ // authentication BearerAuth required
11252
+ // http bearer authentication required
11253
+ await setBearerAuthToObject(localVarHeaderParameter, configuration)
11254
+
11255
+
11256
+
11257
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
11258
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
11259
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
11260
+
11261
+ return {
11262
+ url: toPathString(localVarUrlObj),
11263
+ options: localVarRequestOptions,
11264
+ };
11265
+ },
11266
+ /**
11267
+ * This endpoint starts a new program execution. The program will be executed asynchronously.
11268
+ * @summary Start the program
11269
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
11270
+ * @param {string} program
11271
+ * @param {ProgramStartRequest} programStartRequest
11272
+ * @param {*} [options] Override http request option.
11273
+ * @throws {RequiredError}
11274
+ */
11275
+ startProgram: async (cell: string, program: string, programStartRequest: ProgramStartRequest, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
11276
+ // verify required parameter 'cell' is not null or undefined
11277
+ assertParamExists('startProgram', 'cell', cell)
11278
+ // verify required parameter 'program' is not null or undefined
11279
+ assertParamExists('startProgram', 'program', program)
11280
+ // verify required parameter 'programStartRequest' is not null or undefined
11281
+ assertParamExists('startProgram', 'programStartRequest', programStartRequest)
11282
+ const localVarPath = `/experimental/cells/{cell}/programs/{program}/start`
11283
+ .replace(`{${"cell"}}`, encodeURIComponent(String(cell)))
11284
+ .replace(`{${"program"}}`, encodeURIComponent(String(program)));
11285
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
11286
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
11287
+ let baseOptions;
11288
+ if (configuration) {
11289
+ baseOptions = configuration.baseOptions;
11290
+ }
11291
+
11292
+ const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
11293
+ const localVarHeaderParameter = {} as any;
11294
+ const localVarQueryParameter = {} as any;
11295
+
11296
+ // authentication BasicAuth required
11297
+ // http basic authentication required
11298
+ setBasicAuthToObject(localVarRequestOptions, configuration)
11299
+
11300
+ // authentication BearerAuth required
11301
+ // http bearer authentication required
11302
+ await setBearerAuthToObject(localVarHeaderParameter, configuration)
11303
+
11304
+
11305
+
11306
+ localVarHeaderParameter['Content-Type'] = 'application/json';
11307
+
11308
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
11309
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
11310
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
11311
+ localVarRequestOptions.data = serializeDataIfNeeded(programStartRequest, localVarRequestOptions, configuration)
11312
+
11313
+ return {
11314
+ url: toPathString(localVarUrlObj),
11315
+ options: localVarRequestOptions,
11316
+ };
11317
+ },
11318
+ /**
11319
+ * Stop a specific program run.
11320
+ * @summary Stop program run
11321
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
11322
+ * @param {string} program
11323
+ * @param {*} [options] Override http request option.
11324
+ * @throws {RequiredError}
11325
+ */
11326
+ stopProgram: async (cell: string, program: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
11327
+ // verify required parameter 'cell' is not null or undefined
11328
+ assertParamExists('stopProgram', 'cell', cell)
11329
+ // verify required parameter 'program' is not null or undefined
11330
+ assertParamExists('stopProgram', 'program', program)
11331
+ const localVarPath = `/experimental/cells/{cell}/programs/{program}/stop`
11332
+ .replace(`{${"cell"}}`, encodeURIComponent(String(cell)))
11333
+ .replace(`{${"program"}}`, encodeURIComponent(String(program)));
11334
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
11335
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
11336
+ let baseOptions;
11337
+ if (configuration) {
11338
+ baseOptions = configuration.baseOptions;
11339
+ }
11340
+
11341
+ const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
11342
+ const localVarHeaderParameter = {} as any;
11343
+ const localVarQueryParameter = {} as any;
11344
+
11345
+ // authentication BasicAuth required
11346
+ // http basic authentication required
11347
+ setBasicAuthToObject(localVarRequestOptions, configuration)
11348
+
11349
+ // authentication BearerAuth required
11350
+ // http bearer authentication required
11351
+ await setBearerAuthToObject(localVarHeaderParameter, configuration)
11352
+
11353
+
11354
+
11355
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
11356
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
11357
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
11358
+
11359
+ return {
11360
+ url: toPathString(localVarUrlObj),
11361
+ options: localVarRequestOptions,
11362
+ };
11363
+ },
11364
+ }
11365
+ };
11366
+
11367
+ /**
11368
+ * ProgramApi - functional programming interface
11369
+ * @export
11370
+ */
11371
+ export const ProgramApiFp = function(configuration?: Configuration) {
11372
+ const localVarAxiosParamCreator = ProgramApiAxiosParamCreator(configuration)
11373
+ return {
11374
+ /**
11375
+ * Get details of a program.
11376
+ * @summary Get program
11377
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
11378
+ * @param {string} program
11379
+ * @param {*} [options] Override http request option.
11380
+ * @throws {RequiredError}
11381
+ */
11382
+ async getProgram(cell: string, program: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Program>> {
11383
+ const localVarAxiosArgs = await localVarAxiosParamCreator.getProgram(cell, program, options);
11384
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
11385
+ const localVarOperationServerBasePath = operationServerMap['ProgramApi.getProgram']?.[localVarOperationServerIndex]?.url;
11386
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
11387
+ },
11388
+ /**
11389
+ * List details of all existing programs.
11390
+ * @summary List programs
11391
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
11392
+ * @param {*} [options] Override http request option.
11393
+ * @throws {RequiredError}
11394
+ */
11395
+ async listPrograms(cell: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<Program>>> {
11396
+ const localVarAxiosArgs = await localVarAxiosParamCreator.listPrograms(cell, options);
11397
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
11398
+ const localVarOperationServerBasePath = operationServerMap['ProgramApi.listPrograms']?.[localVarOperationServerIndex]?.url;
11399
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
11400
+ },
11401
+ /**
11402
+ * This endpoint starts a new program execution. The program will be executed asynchronously.
11403
+ * @summary Start the program
11404
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
11405
+ * @param {string} program
11406
+ * @param {ProgramStartRequest} programStartRequest
11407
+ * @param {*} [options] Override http request option.
11408
+ * @throws {RequiredError}
11409
+ */
11410
+ async startProgram(cell: string, program: string, programStartRequest: ProgramStartRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ProgramRun>> {
11411
+ const localVarAxiosArgs = await localVarAxiosParamCreator.startProgram(cell, program, programStartRequest, options);
11412
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
11413
+ const localVarOperationServerBasePath = operationServerMap['ProgramApi.startProgram']?.[localVarOperationServerIndex]?.url;
11414
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
11415
+ },
11416
+ /**
11417
+ * Stop a specific program run.
11418
+ * @summary Stop program run
11419
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
11420
+ * @param {string} program
11421
+ * @param {*} [options] Override http request option.
11422
+ * @throws {RequiredError}
11423
+ */
11424
+ async stopProgram(cell: string, program: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> {
11425
+ const localVarAxiosArgs = await localVarAxiosParamCreator.stopProgram(cell, program, options);
11426
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
11427
+ const localVarOperationServerBasePath = operationServerMap['ProgramApi.stopProgram']?.[localVarOperationServerIndex]?.url;
11428
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
11429
+ },
11430
+ }
11431
+ };
11432
+
11433
+ /**
11434
+ * ProgramApi - factory interface
11435
+ * @export
11436
+ */
11437
+ export const ProgramApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
11438
+ const localVarFp = ProgramApiFp(configuration)
11439
+ return {
11440
+ /**
11441
+ * Get details of a program.
11442
+ * @summary Get program
11443
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
11444
+ * @param {string} program
11445
+ * @param {*} [options] Override http request option.
11446
+ * @throws {RequiredError}
11447
+ */
11448
+ getProgram(cell: string, program: string, options?: RawAxiosRequestConfig): AxiosPromise<Program> {
11449
+ return localVarFp.getProgram(cell, program, options).then((request) => request(axios, basePath));
11450
+ },
11451
+ /**
11452
+ * List details of all existing programs.
11453
+ * @summary List programs
11454
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
11455
+ * @param {*} [options] Override http request option.
11456
+ * @throws {RequiredError}
11457
+ */
11458
+ listPrograms(cell: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<Program>> {
11459
+ return localVarFp.listPrograms(cell, options).then((request) => request(axios, basePath));
11460
+ },
11461
+ /**
11462
+ * This endpoint starts a new program execution. The program will be executed asynchronously.
11463
+ * @summary Start the program
11464
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
11465
+ * @param {string} program
11466
+ * @param {ProgramStartRequest} programStartRequest
11467
+ * @param {*} [options] Override http request option.
11468
+ * @throws {RequiredError}
11469
+ */
11470
+ startProgram(cell: string, program: string, programStartRequest: ProgramStartRequest, options?: RawAxiosRequestConfig): AxiosPromise<ProgramRun> {
11471
+ return localVarFp.startProgram(cell, program, programStartRequest, options).then((request) => request(axios, basePath));
11472
+ },
11473
+ /**
11474
+ * Stop a specific program run.
11475
+ * @summary Stop program run
11476
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
11477
+ * @param {string} program
11478
+ * @param {*} [options] Override http request option.
11479
+ * @throws {RequiredError}
11480
+ */
11481
+ stopProgram(cell: string, program: string, options?: RawAxiosRequestConfig): AxiosPromise<void> {
11482
+ return localVarFp.stopProgram(cell, program, options).then((request) => request(axios, basePath));
11483
+ },
11484
+ };
11485
+ };
11486
+
11487
+ /**
11488
+ * ProgramApi - object-oriented interface
11489
+ * @export
11490
+ * @class ProgramApi
11491
+ * @extends {BaseAPI}
11492
+ */
11493
+ export class ProgramApi extends BaseAPI {
11494
+ /**
11495
+ * Get details of a program.
11496
+ * @summary Get program
11497
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
11498
+ * @param {string} program
11499
+ * @param {*} [options] Override http request option.
11500
+ * @throws {RequiredError}
11501
+ * @memberof ProgramApi
11502
+ */
11503
+ public getProgram(cell: string, program: string, options?: RawAxiosRequestConfig) {
11504
+ return ProgramApiFp(this.configuration).getProgram(cell, program, options).then((request) => request(this.axios, this.basePath));
11505
+ }
11506
+
11507
+ /**
11508
+ * List details of all existing programs.
11509
+ * @summary List programs
11510
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
11511
+ * @param {*} [options] Override http request option.
11512
+ * @throws {RequiredError}
11513
+ * @memberof ProgramApi
11514
+ */
11515
+ public listPrograms(cell: string, options?: RawAxiosRequestConfig) {
11516
+ return ProgramApiFp(this.configuration).listPrograms(cell, options).then((request) => request(this.axios, this.basePath));
11517
+ }
11518
+
11519
+ /**
11520
+ * This endpoint starts a new program execution. The program will be executed asynchronously.
11521
+ * @summary Start the program
11522
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
11523
+ * @param {string} program
11524
+ * @param {ProgramStartRequest} programStartRequest
11525
+ * @param {*} [options] Override http request option.
11526
+ * @throws {RequiredError}
11527
+ * @memberof ProgramApi
11528
+ */
11529
+ public startProgram(cell: string, program: string, programStartRequest: ProgramStartRequest, options?: RawAxiosRequestConfig) {
11530
+ return ProgramApiFp(this.configuration).startProgram(cell, program, programStartRequest, options).then((request) => request(this.axios, this.basePath));
11531
+ }
11532
+
11533
+ /**
11534
+ * Stop a specific program run.
11535
+ * @summary Stop program run
11536
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
11537
+ * @param {string} program
11538
+ * @param {*} [options] Override http request option.
11539
+ * @throws {RequiredError}
11540
+ * @memberof ProgramApi
11541
+ */
11542
+ public stopProgram(cell: string, program: string, options?: RawAxiosRequestConfig) {
11543
+ return ProgramApiFp(this.configuration).stopProgram(cell, program, options).then((request) => request(this.axios, this.basePath));
11544
+ }
11545
+ }
11546
+
11547
+
11548
+
10921
11549
  /**
10922
11550
  * StoreCollisionComponentsApi - axios parameter creator
10923
11551
  * @export
@@ -11243,7 +11871,7 @@ export const StoreCollisionComponentsApiAxiosParamCreator = function (configurat
11243
11871
  };
11244
11872
  },
11245
11873
  /**
11246
- * Returns a list of colliders in a scene. This excludes colliders that are part of a motion group.
11874
+ * Returns all stored colliders.
11247
11875
  * @summary List Colliders
11248
11876
  * @param {string} cell Unique identifier addressing a cell in all API calls.
11249
11877
  * @param {*} [options] Override http request option.
@@ -11590,7 +12218,7 @@ export const StoreCollisionComponentsApiFp = function(configuration?: Configurat
11590
12218
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
11591
12219
  },
11592
12220
  /**
11593
- * Returns a list of colliders in a scene. This excludes colliders that are part of a motion group.
12221
+ * Returns all stored colliders.
11594
12222
  * @summary List Colliders
11595
12223
  * @param {string} cell Unique identifier addressing a cell in all API calls.
11596
12224
  * @param {*} [options] Override http request option.
@@ -11747,7 +12375,7 @@ export const StoreCollisionComponentsApiFactory = function (configuration?: Conf
11747
12375
  return localVarFp.listCollisionLinkChains(cell, options).then((request) => request(axios, basePath));
11748
12376
  },
11749
12377
  /**
11750
- * Returns a list of colliders in a scene. This excludes colliders that are part of a motion group.
12378
+ * Returns all stored colliders.
11751
12379
  * @summary List Colliders
11752
12380
  * @param {string} cell Unique identifier addressing a cell in all API calls.
11753
12381
  * @param {*} [options] Override http request option.
@@ -11903,7 +12531,7 @@ export class StoreCollisionComponentsApi extends BaseAPI {
11903
12531
  }
11904
12532
 
11905
12533
  /**
11906
- * Returns a list of colliders in a scene. This excludes colliders that are part of a motion group.
12534
+ * Returns all stored colliders.
11907
12535
  * @summary List Colliders
11908
12536
  * @param {string} cell Unique identifier addressing a cell in all API calls.
11909
12537
  * @param {*} [options] Override http request option.