@wandelbots/nova-api 25.8.0-dev.4 → 25.8.0-dev.41

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
@@ -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,13 @@ export interface BusIOProfinet {
385
385
  */
386
386
  'bus_type'?: BusIOProfinetBusTypeEnum;
387
387
  /**
388
- * Path to the configuration file.
389
- * @type {string}
390
- * @memberof BusIOProfinet
391
- */
392
- 'config_file_content'?: string;
393
- /**
394
- *
388
+ * Used to enable IP communication through the same physical interface while PN Driver is running.
395
389
  * @type {BusIOProfinetNetwork}
396
390
  * @memberof BusIOProfinet
397
391
  */
398
392
  'network_config'?: BusIOProfinetNetwork;
399
393
  /**
400
- * MAC address for the PROFINET port, should be get from another NOVA API endpoind?
394
+ * MAC address of the physical ethernet interface that you want to use for PROFINET communication.
401
395
  * @type {string}
402
396
  * @memberof BusIOProfinet
403
397
  */
@@ -417,7 +411,7 @@ export const BusIOProfinetBusTypeEnum = {
417
411
  export type BusIOProfinetBusTypeEnum = typeof BusIOProfinetBusTypeEnum[keyof typeof BusIOProfinetBusTypeEnum];
418
412
 
419
413
  /**
420
- * Default route configuration for the PROFINET service. Will be removed before release by automatic default route configuration, if possible.
414
+ * 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
415
  * @export
422
416
  * @interface BusIOProfinetDefaultRoute
423
417
  */
@@ -436,25 +430,25 @@ export interface BusIOProfinetDefaultRoute {
436
430
  'interface': string;
437
431
  }
438
432
  /**
439
- * Network configuration for the PROFINET device
433
+ * 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
434
  * @export
441
435
  * @interface BusIOProfinetIpConfig
442
436
  */
443
437
  export interface BusIOProfinetIpConfig {
444
438
  /**
445
- * IP address for the PROFINET device
439
+ * IP address for the device\'s virtual ethernet interface (pnio1).
446
440
  * @type {string}
447
441
  * @memberof BusIOProfinetIpConfig
448
442
  */
449
443
  'ip': string;
450
444
  /**
451
- * Network mask for the PROFINET device.
445
+ * Network mask for the device\'s virtual ethernet interface (pnio1).
452
446
  * @type {string}
453
447
  * @memberof BusIOProfinetIpConfig
454
448
  */
455
449
  'netmask': string;
456
450
  /**
457
- * Gateway for the PROFINET device
451
+ * Gateway for connections to other devices outside of the virtual ethernet interface\'s subnet.
458
452
  * @type {string}
459
453
  * @memberof BusIOProfinetIpConfig
460
454
  */
@@ -467,7 +461,7 @@ export interface BusIOProfinetIpConfig {
467
461
  */
468
462
  export interface BusIOProfinetNetwork {
469
463
  /**
470
- * Name of the PROFINET device.
464
+ * 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
465
  * @type {string}
472
466
  * @memberof BusIOProfinetNetwork
473
467
  */
@@ -479,14 +473,14 @@ export interface BusIOProfinetNetwork {
479
473
  */
480
474
  'ip_config'?: BusIOProfinetIpConfig;
481
475
  /**
482
- * Content of the PROFINET REMA XML file.
476
+ * 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
477
  * @type {string}
484
478
  * @memberof BusIOProfinetNetwork
485
479
  */
486
480
  'rema_xml_content'?: string;
487
481
  }
488
482
  /**
489
- * Virtual PROFINET BUS Inputs/Outputs Service configuration.
483
+ * Virtual PROFINET BUS inputs/outputs service configuration.
490
484
  * @export
491
485
  * @interface BusIOProfinetVirtual
492
486
  */
@@ -500,7 +494,7 @@ export interface BusIOProfinetVirtual {
500
494
  }
501
495
 
502
496
  export const BusIOProfinetVirtualBusTypeEnum = {
503
- VirtualProfinet: 'virtual_profinet'
497
+ ProfinetVirtual: 'profinet_virtual'
504
498
  } as const;
505
499
 
506
500
  export type BusIOProfinetVirtualBusTypeEnum = typeof BusIOProfinetVirtualBusTypeEnum[keyof typeof BusIOProfinetVirtualBusTypeEnum];
@@ -524,7 +518,7 @@ export interface BusIOsState {
524
518
  */
525
519
  'state': BusIOsStateEnum;
526
520
  /**
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.
521
+ * 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
522
  * @type {string}
529
523
  * @memberof BusIOsState
530
524
  */
@@ -1782,9 +1776,22 @@ export interface GetTrajectoryResponse {
1782
1776
  export interface HTTPValidationError {
1783
1777
  /**
1784
1778
  *
1785
- * @type {Array<ValidationError>}
1779
+ * @type {Array<ValidationError2>}
1786
1780
  * @memberof HTTPValidationError
1787
1781
  */
1782
+ 'detail'?: Array<ValidationError2>;
1783
+ }
1784
+ /**
1785
+ *
1786
+ * @export
1787
+ * @interface HTTPValidationError2
1788
+ */
1789
+ export interface HTTPValidationError2 {
1790
+ /**
1791
+ *
1792
+ * @type {Array<ValidationError>}
1793
+ * @memberof HTTPValidationError2
1794
+ */
1788
1795
  'detail'?: Array<ValidationError>;
1789
1796
  }
1790
1797
  /**
@@ -1876,6 +1883,57 @@ export interface IODescription {
1876
1883
  }
1877
1884
 
1878
1885
 
1886
+ /**
1887
+ *
1888
+ * @export
1889
+ * @interface IODescription2
1890
+ */
1891
+ export interface IODescription2 {
1892
+ /**
1893
+ * Unique identifier of the input/output.
1894
+ * @type {string}
1895
+ * @memberof IODescription2
1896
+ */
1897
+ 'io': string;
1898
+ /**
1899
+ * Descriptive name of the input/output. Customize it using the respective BUS service, e.g. [addProfinetIO](addProfinetIO) for PROFINET service.
1900
+ * @type {string}
1901
+ * @memberof IODescription2
1902
+ */
1903
+ 'name': string;
1904
+ /**
1905
+ *
1906
+ * @type {IODirection}
1907
+ * @memberof IODescription2
1908
+ */
1909
+ 'direction': IODirection;
1910
+ /**
1911
+ *
1912
+ * @type {IOValueType}
1913
+ * @memberof IODescription2
1914
+ */
1915
+ 'value_type': IOValueType;
1916
+ /**
1917
+ *
1918
+ * @type {UnitType}
1919
+ * @memberof IODescription2
1920
+ */
1921
+ 'unit'?: UnitType;
1922
+ /**
1923
+ *
1924
+ * @type {IODescriptionMin}
1925
+ * @memberof IODescription2
1926
+ */
1927
+ 'min'?: IODescriptionMin;
1928
+ /**
1929
+ *
1930
+ * @type {IODescriptionMin}
1931
+ * @memberof IODescription2
1932
+ */
1933
+ 'max'?: IODescriptionMin;
1934
+ }
1935
+
1936
+
1879
1937
  /**
1880
1938
  * @type IODescriptionMin
1881
1939
  * @export
@@ -1941,7 +1999,7 @@ export interface IOIntegerValue {
1941
1999
  */
1942
2000
  'io': string;
1943
2001
  /**
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.
2002
+ * 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
2003
  * @type {string}
1946
2004
  * @memberof IOIntegerValue
1947
2005
  */
@@ -2204,7 +2262,7 @@ export const InitializeMovementResponseKindEnum = {
2204
2262
  export type InitializeMovementResponseKindEnum = typeof InitializeMovementResponseKindEnum[keyof typeof InitializeMovementResponseKindEnum];
2205
2263
 
2206
2264
  /**
2207
- * Value of an input/output with integer representation. > The integral value is transmitted as a string to avoid precision loss during conversion to JSON. > We recommend to use int64 in your implementation. If you want to interact with int64 in numbers, > JS bigint libraries can help you to parse the string into an integral value.
2265
+ * Value of an input/output with integer representation. > The integral value is transmitted as a string to avoid precision loss during conversion to JSON. > Recommended: Use int64 in your implementation. If you want to interact with int64 in numbers, > JS bigint libraries can help you to parse the string into an integral value.
2208
2266
  * @export
2209
2267
  * @interface IntegerValue
2210
2268
  */
@@ -2404,10 +2462,10 @@ export type JoggingDetailsKindEnum = typeof JoggingDetailsKindEnum[keyof typeof
2404
2462
  * @type JoggingDetailsState
2405
2463
  * @export
2406
2464
  */
2407
- export type JoggingDetailsState = JoggingPausedByUser | JoggingPausedNearCollision | JoggingPausedNearJointLimit | JoggingPausedOnIO | JoggingRunning;
2465
+ export type JoggingDetailsState = { kind: 'PAUSED_BY_USER' } & JoggingPausedByUser | { kind: 'PAUSED_NEAR_COLLISION' } & JoggingPausedNearCollision | { kind: 'PAUSED_NEAR_JOINT_LIMIT' } & JoggingPausedNearJointLimit | { kind: 'PAUSED_ON_IO' } & JoggingPausedOnIO | { kind: 'RUNNING' } & JoggingRunning;
2408
2466
 
2409
2467
  /**
2410
- *
2468
+ * User has paused jogging.
2411
2469
  * @export
2412
2470
  * @interface JoggingPausedByUser
2413
2471
  */
@@ -2427,7 +2485,7 @@ export const JoggingPausedByUserKindEnum = {
2427
2485
  export type JoggingPausedByUserKindEnum = typeof JoggingPausedByUserKindEnum[keyof typeof JoggingPausedByUserKindEnum];
2428
2486
 
2429
2487
  /**
2430
- *
2488
+ * Jogging was paused because the motion group neared a collision.
2431
2489
  * @export
2432
2490
  * @interface JoggingPausedNearCollision
2433
2491
  */
@@ -2453,7 +2511,7 @@ export const JoggingPausedNearCollisionKindEnum = {
2453
2511
  export type JoggingPausedNearCollisionKindEnum = typeof JoggingPausedNearCollisionKindEnum[keyof typeof JoggingPausedNearCollisionKindEnum];
2454
2512
 
2455
2513
  /**
2456
- *
2514
+ * Jogging was paused because a joint is near its limit.
2457
2515
  * @export
2458
2516
  * @interface JoggingPausedNearJointLimit
2459
2517
  */
@@ -2479,7 +2537,7 @@ export const JoggingPausedNearJointLimitKindEnum = {
2479
2537
  export type JoggingPausedNearJointLimitKindEnum = typeof JoggingPausedNearJointLimitKindEnum[keyof typeof JoggingPausedNearJointLimitKindEnum];
2480
2538
 
2481
2539
  /**
2482
- *
2540
+ * Jogging was paused because of an I/O event.
2483
2541
  * @export
2484
2542
  * @interface JoggingPausedOnIO
2485
2543
  */
@@ -2499,7 +2557,7 @@ export const JoggingPausedOnIOKindEnum = {
2499
2557
  export type JoggingPausedOnIOKindEnum = typeof JoggingPausedOnIOKindEnum[keyof typeof JoggingPausedOnIOKindEnum];
2500
2558
 
2501
2559
  /**
2502
- *
2560
+ * Jogging is active.
2503
2561
  * @export
2504
2562
  * @interface JoggingRunning
2505
2563
  */
@@ -2869,6 +2927,12 @@ export interface LimitSet {
2869
2927
  * @memberof LimitSet
2870
2928
  */
2871
2929
  'flange'?: CartesianLimits;
2930
+ /**
2931
+ *
2932
+ * @type {JointLimits}
2933
+ * @memberof LimitSet
2934
+ */
2935
+ 'coupled_shoulder_elbow_joint'?: JointLimits;
2872
2936
  }
2873
2937
  /**
2874
2938
  * If a limit is not set, the default value will be used.
@@ -2944,13 +3008,13 @@ export type Manufacturer = typeof Manufacturer[keyof typeof Manufacturer];
2944
3008
 
2945
3009
 
2946
3010
  /**
2947
- * Midpoint insertion algorithm configuration for collision-free path planning. This algorithm iteratively inserts midpoints between the start and target joint position to find collision-free paths.
3011
+ *
2948
3012
  * @export
2949
3013
  * @interface MidpointInsertionAlgorithm
2950
3014
  */
2951
3015
  export interface MidpointInsertionAlgorithm {
2952
3016
  /**
2953
- * Algorithm discriminator.
3017
+ * Algorithm discriminator. Midpoint insertion algorithm configuration for collision-free path planning. This algorithm adds a single midpoint between the start and target joint position to find collision-free paths.
2954
3018
  * @type {string}
2955
3019
  * @memberof MidpointInsertionAlgorithm
2956
3020
  */
@@ -4071,17 +4135,17 @@ export interface ProfinetDescription {
4071
4135
  */
4072
4136
  'slots'?: Array<ProfinetSlotDescription>;
4073
4137
  /**
4074
- * Name of the PROFINET device
4138
+ * Name of Station (NoS) of the PROFINET device. The NoS is used in combination with IPv4 record to identify your device in the PROFINET network. The `device_name` will be used as NoS if no REMA XML file is already present on your NOVA instance and no `rema_xml_content` is provided.
4075
4139
  * @type {string}
4076
4140
  * @memberof ProfinetDescription
4077
4141
  */
4078
4142
  'device_name'?: string;
4079
4143
  /**
4080
- * IP address for the PROFINET device
4081
- * @type {string}
4144
+ *
4145
+ * @type {BusIOProfinetIpConfig}
4082
4146
  * @memberof ProfinetDescription
4083
4147
  */
4084
- 'ip'?: string;
4148
+ 'ip_config'?: BusIOProfinetIpConfig;
4085
4149
  }
4086
4150
  /**
4087
4151
  *
@@ -4090,7 +4154,7 @@ export interface ProfinetDescription {
4090
4154
  */
4091
4155
  export interface ProfinetIO {
4092
4156
  /**
4093
- * The name of the input/output value. This is a human-readable identifier for the value. It can be used to distinguish between different inputs/outputs in the system.
4157
+ * The name of the input/output variable. This is a human-readable identifier for the value. It distinguishes between different inputs/outputs variables in the system. The variables may be used to set bits or bytes at their pointed to address via [setBusIOValues](setBusIOValues).
4094
4158
  * @type {string}
4095
4159
  * @memberof ProfinetIO
4096
4160
  */
@@ -4102,25 +4166,25 @@ export interface ProfinetIO {
4102
4166
  */
4103
4167
  'type': ProfinetIOTypeEnum;
4104
4168
  /**
4105
- * The direction of the input/output value, indicating whether it is an input or output for the device.
4169
+ * The direction of the input/output variable, indicating whether it is an input or output for the PROFINET device, e.g. NOVA\'s PROFINET service.
4106
4170
  * @type {ProfinetIODirection}
4107
4171
  * @memberof ProfinetIO
4108
4172
  */
4109
4173
  'direction': ProfinetIODirection;
4110
4174
  /**
4111
- * The byte address of the input/output value in the PROFINET device. The byte address is used to locate the specific input/output within the device\'s memory or data structure.
4175
+ * The byte address of the input/output variable in the PROFINET device, e.g. NOVA\'s PROFINET service. The byte address is used to locate the specific input/output variable within the device\'s memory or data structure.
4112
4176
  * @type {number}
4113
4177
  * @memberof ProfinetIO
4114
4178
  */
4115
4179
  'byte_address': number;
4116
4180
  /**
4117
- * The bit address of the input/output value within the byte or word address. The bit address is used to specify the exact bit within the byte or word that corresponds to the input/output value.
4181
+ * The bit address of the input/output variable within the byte or word address. The bit address is used to specify the exact bit within the byte or word that corresponds to the input/output variable.
4118
4182
  * @type {number}
4119
4183
  * @memberof ProfinetIO
4120
4184
  */
4121
4185
  'bit_address'?: number;
4122
4186
  /**
4123
- * The unique identifier for the input/output value. This identifier is used to reference the specific input/output in the NOVA system.
4187
+ * The unique identifier for the input/output value. This identifier is used to reference the specific input/output variable in the PROFINET device, e.g. NOVA\'s PROFINET service.
4124
4188
  * @type {string}
4125
4189
  * @memberof ProfinetIO
4126
4190
  */
@@ -4135,7 +4199,7 @@ export interface ProfinetIO {
4135
4199
  */
4136
4200
  export interface ProfinetIOData {
4137
4201
  /**
4138
- * The name of the input/output value. This is a human-readable identifier for the value. It can be used to distinguish between different inputs/outputs in the system.
4202
+ * The name of the input/output variable. This is a human-readable identifier for the value. It distinguishes between different inputs/outputs variables in the system. The variables may be used to set bits or bytes at their pointed to address via [setBusIOValues](setBusIOValues).
4139
4203
  * @type {string}
4140
4204
  * @memberof ProfinetIOData
4141
4205
  */
@@ -4147,19 +4211,19 @@ export interface ProfinetIOData {
4147
4211
  */
4148
4212
  'type': ProfinetIOTypeEnum;
4149
4213
  /**
4150
- * The direction of the input/output value, indicating whether it is an input or output for the device.
4214
+ * The direction of the input/output variable, indicating whether it is an input or output for the PROFINET device, e.g. NOVA\'s PROFINET service.
4151
4215
  * @type {ProfinetIODirection}
4152
4216
  * @memberof ProfinetIOData
4153
4217
  */
4154
4218
  'direction': ProfinetIODirection;
4155
4219
  /**
4156
- * The byte address of the input/output value in the PROFINET device. The byte address is used to locate the specific input/output within the device\'s memory or data structure.
4220
+ * The byte address of the input/output variable in the PROFINET device, e.g. NOVA\'s PROFINET service. The byte address is used to locate the specific input/output variable within the device\'s memory or data structure.
4157
4221
  * @type {number}
4158
4222
  * @memberof ProfinetIOData
4159
4223
  */
4160
4224
  'byte_address': number;
4161
4225
  /**
4162
- * The bit address of the input/output value within the byte or word address. The bit address is used to specify the exact bit within the byte or word that corresponds to the input/output value.
4226
+ * The bit address of the input/output variable within the byte or word address. The bit address is used to specify the exact bit within the byte or word that corresponds to the input/output variable.
4163
4227
  * @type {number}
4164
4228
  * @memberof ProfinetIOData
4165
4229
  */
@@ -4168,7 +4232,7 @@ export interface ProfinetIOData {
4168
4232
 
4169
4233
 
4170
4234
  /**
4171
- * Identifies the input/output type.
4235
+ * The direction of the input/output variable, indicating whether it is an input or output for the PROFINET device, e.g. NOVA\'s PROFINET service.
4172
4236
  * @export
4173
4237
  * @enum {string}
4174
4238
  */
@@ -4183,7 +4247,7 @@ export type ProfinetIODirection = typeof ProfinetIODirection[keyof typeof Profin
4183
4247
 
4184
4248
 
4185
4249
  /**
4186
- * Value type of the PROFINET input/output.
4250
+ * Value type of the PROFINET input/output variable. Is used to interpret the corresponding bits correctly.
4187
4251
  * @export
4188
4252
  * @enum {string}
4189
4253
  */
@@ -4211,38 +4275,38 @@ export type ProfinetIOTypeEnum = typeof ProfinetIOTypeEnum[keyof typeof Profinet
4211
4275
  */
4212
4276
  export interface ProfinetInputOutputConfig {
4213
4277
  /**
4214
- * Content of the input output configuration file.
4278
+ * Content of the input/output variable configuration XML file. The XML File has to be embedded as a string by escaping quotes, line breaks and so forth.
4215
4279
  * @type {string}
4216
4280
  * @memberof ProfinetInputOutputConfig
4217
4281
  */
4218
4282
  'config': string;
4219
4283
  /**
4220
- * Offset in bytes for the input data.
4284
+ * Offset in bytes for the address of the input (perspective of the controller) variables. The offset will be subtracted from to the byte addresses of the sent XML content.
4221
4285
  * @type {number}
4222
4286
  * @memberof ProfinetInputOutputConfig
4223
4287
  */
4224
4288
  'input_offset': number;
4225
4289
  /**
4226
- * Offset in bytes for the output data.
4290
+ * Offset in bytes for the address of the output (perspective of the controller) variables. The offset will be subtracted from to the byte addresses of the sent XML content.
4227
4291
  * @type {number}
4228
4292
  * @memberof ProfinetInputOutputConfig
4229
4293
  */
4230
4294
  'output_offset': number;
4231
4295
  }
4232
4296
  /**
4233
- *
4297
+ * An array of PROFINET slots. PROFINET models each device’s input/output hardware as a hierarchy of slots (modules) and subslots (submodules). A slot can represent a physical or virtual input/output card and each subslot one of its individual channels or functions. Every slot and subslot has unique identifiers that the controller uses to map cyclic input/output data and parameter records to its process image. This slot/subslot separation enables e.g. addressing each input/output stream when establishing input/output application relations (I/O-AR).
4234
4298
  * @export
4235
4299
  * @interface ProfinetSlotDescription
4236
4300
  */
4237
4301
  export interface ProfinetSlotDescription {
4238
4302
  /**
4239
- * The number of the PROFINET slot.
4303
+ * The number/index of the PROFINET slot. Per default, slot 0 is reserved for the device access point (DAP). Slots that are part of the cyclic input/output data exchange start at number 1.
4240
4304
  * @type {number}
4241
4305
  * @memberof ProfinetSlotDescription
4242
4306
  */
4243
4307
  'number': number;
4244
4308
  /**
4245
- * The API number of the PROFINET input, used to identify the specific API for the input.
4309
+ * The application process identifier (API) number of the PROFINET input. The API identifies the application relation (AR) that is using the slot.
4246
4310
  * @type {number}
4247
4311
  * @memberof ProfinetSlotDescription
4248
4312
  */
@@ -4261,32 +4325,180 @@ export interface ProfinetSlotDescription {
4261
4325
  */
4262
4326
  export interface ProfinetSubSlotDescription {
4263
4327
  /**
4264
- * The identifier of the PROFINET subslot.
4328
+ * The number/index of the PROFINET subslot.
4265
4329
  * @type {number}
4266
4330
  * @memberof ProfinetSubSlotDescription
4267
4331
  */
4268
4332
  'number': number;
4269
4333
  /**
4270
- * The length in bytes of the PROFINET input.
4334
+ * The amount of bytes allocated for the subslot in the input process image buffer.
4271
4335
  * @type {number}
4272
4336
  * @memberof ProfinetSubSlotDescription
4273
4337
  */
4274
4338
  'input_length': number;
4275
4339
  /**
4276
- * The length in bytes of the PROFINET output.
4340
+ * The amount of bytes allocated for the subslot in the output process image buffer.
4277
4341
  * @type {number}
4278
4342
  * @memberof ProfinetSubSlotDescription
4279
4343
  */
4280
4344
  'output_length': number;
4281
4345
  }
4282
4346
  /**
4283
- * <!-- theme: danger --> > **Experimental** RRT Connect algorithm configuration for collision-free path planning. Rapidly-exploring Random Trees (RRT) builds trees of valid configurations by randomly sampling the joint space and connecting feasible points. RRT Connect grows two trees simultaneously from start and target positions until they meet. This is a custom implementation optimized for manipulator kinematics and collision checking in industrial contexts.
4347
+ * A program is a collection of instructions that are executed in the robot cell.
4348
+ * @export
4349
+ * @interface Program
4350
+ */
4351
+ export interface Program {
4352
+ /**
4353
+ *
4354
+ * @type {string}
4355
+ * @memberof Program
4356
+ */
4357
+ 'program': string;
4358
+ /**
4359
+ *
4360
+ * @type {string}
4361
+ * @memberof Program
4362
+ */
4363
+ 'name'?: string;
4364
+ /**
4365
+ *
4366
+ * @type {string}
4367
+ * @memberof Program
4368
+ */
4369
+ 'description'?: string;
4370
+ /**
4371
+ *
4372
+ * @type {string}
4373
+ * @memberof Program
4374
+ */
4375
+ 'app': string;
4376
+ /**
4377
+ *
4378
+ * @type {object}
4379
+ * @memberof Program
4380
+ */
4381
+ 'input_schema'?: object;
4382
+ /**
4383
+ *
4384
+ * @type {object}
4385
+ * @memberof Program
4386
+ */
4387
+ 'preconditions'?: object;
4388
+ }
4389
+ /**
4390
+ * Holds the state of a program run.
4391
+ * @export
4392
+ * @interface ProgramRun
4393
+ */
4394
+ export interface ProgramRun {
4395
+ /**
4396
+ * Unique identifier of the program run
4397
+ * @type {string}
4398
+ * @memberof ProgramRun
4399
+ */
4400
+ 'run': string;
4401
+ /**
4402
+ * Unique identifier of the program
4403
+ * @type {string}
4404
+ * @memberof ProgramRun
4405
+ */
4406
+ 'program': string;
4407
+ /**
4408
+ * State of the program run
4409
+ * @type {ProgramRunState}
4410
+ * @memberof ProgramRun
4411
+ */
4412
+ 'state': ProgramRunState;
4413
+ /**
4414
+ * Logs of the program run
4415
+ * @type {string}
4416
+ * @memberof ProgramRun
4417
+ */
4418
+ 'logs'?: string;
4419
+ /**
4420
+ * Stdout of the program run
4421
+ * @type {string}
4422
+ * @memberof ProgramRun
4423
+ */
4424
+ 'stdout'?: string;
4425
+ /**
4426
+ * Stderr of the program run
4427
+ * @type {string}
4428
+ * @memberof ProgramRun
4429
+ */
4430
+ 'stderr'?: string;
4431
+ /**
4432
+ * Error message of the program run, if any
4433
+ * @type {string}
4434
+ * @memberof ProgramRun
4435
+ */
4436
+ 'error'?: string;
4437
+ /**
4438
+ * Traceback of the program run, if any
4439
+ * @type {string}
4440
+ * @memberof ProgramRun
4441
+ */
4442
+ 'traceback'?: string;
4443
+ /**
4444
+ * Start time of the program run
4445
+ * @type {string}
4446
+ * @memberof ProgramRun
4447
+ */
4448
+ 'start_time'?: string;
4449
+ /**
4450
+ * End time of the program run
4451
+ * @type {string}
4452
+ * @memberof ProgramRun
4453
+ */
4454
+ 'end_time'?: string;
4455
+ /**
4456
+ * Input data of the program run
4457
+ * @type {object}
4458
+ * @memberof ProgramRun
4459
+ */
4460
+ 'input_data'?: object;
4461
+ }
4462
+
4463
+
4464
+ /**
4465
+ * The state of a program run.
4466
+ * @export
4467
+ * @enum {string}
4468
+ */
4469
+
4470
+ export const ProgramRunState = {
4471
+ Preparing: 'PREPARING',
4472
+ Running: 'RUNNING',
4473
+ Completed: 'COMPLETED',
4474
+ Failed: 'FAILED',
4475
+ Stopped: 'STOPPED'
4476
+ } as const;
4477
+
4478
+ export type ProgramRunState = typeof ProgramRunState[keyof typeof ProgramRunState];
4479
+
4480
+
4481
+ /**
4482
+ * The state of a program run.
4483
+ * @export
4484
+ * @interface ProgramStartRequest
4485
+ */
4486
+ export interface ProgramStartRequest {
4487
+ /**
4488
+ * The arguments to pass to the program.
4489
+ * @type {object}
4490
+ * @memberof ProgramStartRequest
4491
+ */
4492
+ 'arguments': object;
4493
+ }
4494
+ /**
4495
+ *
4284
4496
  * @export
4285
4497
  * @interface RRTConnectAlgorithm
4286
4498
  */
4287
4499
  export interface RRTConnectAlgorithm {
4288
4500
  /**
4289
- * Algorithm discriminator.
4501
+ * Algorithm discriminator. RRT Connect algorithm configuration for collision-free path planning. Rapidly-exploring Random Trees (RRT) builds trees of valid configurations by randomly sampling the joint space and connecting feasible points with JointPTP motions. RRT Connect grows two trees simultaneously from start and target positions until they meet. This is a custom implementation optimized for manipulator kinematics and collision checking in industrial contexts.
4290
4502
  * @type {string}
4291
4503
  * @memberof RRTConnectAlgorithm
4292
4504
  */
@@ -4297,6 +4509,30 @@ export interface RRTConnectAlgorithm {
4297
4509
  * @memberof RRTConnectAlgorithm
4298
4510
  */
4299
4511
  'max_iterations'?: number;
4512
+ /**
4513
+ * Maximum step size for tree extension in joint space.
4514
+ * @type {number}
4515
+ * @memberof RRTConnectAlgorithm
4516
+ */
4517
+ 'max_step_size'?: number;
4518
+ /**
4519
+ * Adjust the maximum step size during the search based on the recent success rate of tree expansion.
4520
+ * @type {boolean}
4521
+ * @memberof RRTConnectAlgorithm
4522
+ */
4523
+ 'adaptive_step_size'?: boolean;
4524
+ /**
4525
+ * Apply smoothing after the search has succeeded. This will remove as many intermediate points as possible while keeping the path valid.
4526
+ * @type {boolean}
4527
+ * @memberof RRTConnectAlgorithm
4528
+ */
4529
+ 'apply_smoothing'?: boolean;
4530
+ /**
4531
+ * Apply blending after the search has succeeded and smoothing has been applied. This will apply the largest viable blending at each intermediate point.
4532
+ * @type {boolean}
4533
+ * @memberof RRTConnectAlgorithm
4534
+ */
4535
+ 'apply_blending'?: boolean;
4300
4536
  }
4301
4537
 
4302
4538
  export const RRTConnectAlgorithmAlgorithmNameEnum = {
@@ -5105,10 +5341,10 @@ export type TrajectoryDetailsKindEnum = typeof TrajectoryDetailsKindEnum[keyof t
5105
5341
  * @type TrajectoryDetailsState
5106
5342
  * @export
5107
5343
  */
5108
- export type TrajectoryDetailsState = TrajectoryEnded | TrajectoryPausedByUser | TrajectoryPausedOnIO | TrajectoryRunning | TrajectoryWaitForIO;
5344
+ export type TrajectoryDetailsState = { kind: 'END_OF_TRAJECTORY' } & TrajectoryEnded | { kind: 'PAUSED_BY_USER' } & TrajectoryPausedByUser | { kind: 'PAUSED_ON_IO' } & TrajectoryPausedOnIO | { kind: 'RUNNING' } & TrajectoryRunning | { kind: 'WAIT_FOR_IO' } & TrajectoryWaitForIO;
5109
5345
 
5110
5346
  /**
5111
- *
5347
+ * First or last sample (depending on direction) of trajectory has been sent.
5112
5348
  * @export
5113
5349
  * @interface TrajectoryEnded
5114
5350
  */
@@ -5154,7 +5390,7 @@ export const TrajectoryIdMessageTypeEnum = {
5154
5390
  export type TrajectoryIdMessageTypeEnum = typeof TrajectoryIdMessageTypeEnum[keyof typeof TrajectoryIdMessageTypeEnum];
5155
5391
 
5156
5392
  /**
5157
- *
5393
+ * User has paused execution.
5158
5394
  * @export
5159
5395
  * @interface TrajectoryPausedByUser
5160
5396
  */
@@ -5174,7 +5410,7 @@ export const TrajectoryPausedByUserKindEnum = {
5174
5410
  export type TrajectoryPausedByUserKindEnum = typeof TrajectoryPausedByUserKindEnum[keyof typeof TrajectoryPausedByUserKindEnum];
5175
5411
 
5176
5412
  /**
5177
- *
5413
+ * Execution was paused because of an I/O event.
5178
5414
  * @export
5179
5415
  * @interface TrajectoryPausedOnIO
5180
5416
  */
@@ -5194,7 +5430,7 @@ export const TrajectoryPausedOnIOKindEnum = {
5194
5430
  export type TrajectoryPausedOnIOKindEnum = typeof TrajectoryPausedOnIOKindEnum[keyof typeof TrajectoryPausedOnIOKindEnum];
5195
5431
 
5196
5432
  /**
5197
- *
5433
+ * Trajectory is being executed.
5198
5434
  * @export
5199
5435
  * @interface TrajectoryRunning
5200
5436
  */
@@ -5220,7 +5456,7 @@ export const TrajectoryRunningKindEnum = {
5220
5456
  export type TrajectoryRunningKindEnum = typeof TrajectoryRunningKindEnum[keyof typeof TrajectoryRunningKindEnum];
5221
5457
 
5222
5458
  /**
5223
- *
5459
+ * Waiting for an I/O event to start execution.
5224
5460
  * @export
5225
5461
  * @interface TrajectoryWaitForIO
5226
5462
  */
@@ -5333,6 +5569,31 @@ export interface ValidationError {
5333
5569
  */
5334
5570
  'input': { [key: string]: any; };
5335
5571
  }
5572
+ /**
5573
+ * A validation error of a program.
5574
+ * @export
5575
+ * @interface ValidationError2
5576
+ */
5577
+ export interface ValidationError2 {
5578
+ /**
5579
+ *
5580
+ * @type {Array<number>}
5581
+ * @memberof ValidationError2
5582
+ */
5583
+ 'loc': Array<number>;
5584
+ /**
5585
+ *
5586
+ * @type {string}
5587
+ * @memberof ValidationError2
5588
+ */
5589
+ 'msg': string;
5590
+ /**
5591
+ *
5592
+ * @type {string}
5593
+ * @memberof ValidationError2
5594
+ */
5595
+ 'type': string;
5596
+ }
5336
5597
  /**
5337
5598
  * @type ValidationErrorLocInner
5338
5599
  * @export
@@ -6150,7 +6411,7 @@ export class ApplicationApi extends BaseAPI {
6150
6411
  export const BUSInputsOutputsApiAxiosParamCreator = function (configuration?: Configuration) {
6151
6412
  return {
6152
6413
  /**
6153
- * Add a BUS Inputs/Outputs Service to the cell.
6414
+ * Add the BUS inputs/outputs service to the cell. Starts a containerized service that enables BUS connections via the specified ethernet port.
6154
6415
  * @summary Add Service
6155
6416
  * @param {string} cell Unique identifier addressing a cell in all API calls.
6156
6417
  * @param {BusIOType} busIOType
@@ -6203,7 +6464,7 @@ export const BUSInputsOutputsApiAxiosParamCreator = function (configuration?: Co
6203
6464
  };
6204
6465
  },
6205
6466
  /**
6206
- * Adds an input/output to or updates an input/output on the PROFINET device.
6467
+ * 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
6468
  * @summary Add PROFINET Input/Output
6208
6469
  * @param {string} cell Unique identifier addressing a cell in all API calls.
6209
6470
  * @param {string} io Unique identifier to address an Input/Output in the cell.
@@ -6255,7 +6516,7 @@ export const BUSInputsOutputsApiAxiosParamCreator = function (configuration?: Co
6255
6516
  };
6256
6517
  },
6257
6518
  /**
6258
- * Delete BUS Inputs/Outputs Service from the cell.
6519
+ * Remove the BUS inputs/outputs service from the cell.
6259
6520
  * @summary Clear Service
6260
6521
  * @param {string} cell Unique identifier addressing a cell in all API calls.
6261
6522
  * @param {number} [completionTimeout]
@@ -6302,7 +6563,7 @@ export const BUSInputsOutputsApiAxiosParamCreator = function (configuration?: Co
6302
6563
  };
6303
6564
  },
6304
6565
  /**
6305
- * Removes the input/output from the PROFINET device.
6566
+ * Removes an input/output variable configuration from the PROFINET device, e.g. NOVA\'s PROFINET service.
6306
6567
  * @summary Remove PROFINET Input/Ouptut
6307
6568
  * @param {string} cell Unique identifier addressing a cell in all API calls.
6308
6569
  * @param {string} io Unique identifier to address an Input/Output in the cell.
@@ -6348,7 +6609,7 @@ export const BUSInputsOutputsApiAxiosParamCreator = function (configuration?: Co
6348
6609
  };
6349
6610
  },
6350
6611
  /**
6351
- * Get deployed BUS Inputs/Outputs Service.
6612
+ * Get deployed BUS inputs/outputs service.
6352
6613
  * @summary Get Service
6353
6614
  * @param {string} cell Unique identifier addressing a cell in all API calls.
6354
6615
  * @param {*} [options] Override http request option.
@@ -6479,7 +6740,7 @@ export const BUSInputsOutputsApiAxiosParamCreator = function (configuration?: Co
6479
6740
  };
6480
6741
  },
6481
6742
  /**
6482
- * Get description of PROFINET
6743
+ * Get description of NOVA as a PROFINET device.
6483
6744
  * @summary Get PROFINET Description
6484
6745
  * @param {string} cell Unique identifier addressing a cell in all API calls.
6485
6746
  * @param {*} [options] Override http request option.
@@ -6521,7 +6782,7 @@ export const BUSInputsOutputsApiAxiosParamCreator = function (configuration?: Co
6521
6782
  };
6522
6783
  },
6523
6784
  /**
6524
- * Get input/output configuration of the PROFINET device as file.
6785
+ * 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
6786
  * @summary PROFINET Inputs/Outputs to File
6526
6787
  * @param {string} cell Unique identifier addressing a cell in all API calls.
6527
6788
  * @param {number} [inputOffset]
@@ -6573,7 +6834,7 @@ export const BUSInputsOutputsApiAxiosParamCreator = function (configuration?: Co
6573
6834
  };
6574
6835
  },
6575
6836
  /**
6576
- * List all BUS Input/Output descriptions.
6837
+ * 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
6838
  * @summary List Descriptions
6578
6839
  * @param {string} cell Unique identifier addressing a cell in all API calls.
6579
6840
  * @param {*} [options] Override http request option.
@@ -6615,7 +6876,7 @@ export const BUSInputsOutputsApiAxiosParamCreator = function (configuration?: Co
6615
6876
  };
6616
6877
  },
6617
6878
  /**
6618
- * List all PROFINET input and outputs.
6879
+ * 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
6880
  * @summary List PROFINET Input/Output Configuration
6620
6881
  * @param {string} cell Unique identifier addressing a cell in all API calls.
6621
6882
  * @param {*} [options] Override http request option.
@@ -6705,7 +6966,7 @@ export const BUSInputsOutputsApiAxiosParamCreator = function (configuration?: Co
6705
6966
  };
6706
6967
  },
6707
6968
  /**
6708
- * Sets inputs/outputs on the PROFINET device from file.
6969
+ * 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
6970
  * @summary Set PROFINET Inputs/Outputs from File
6710
6971
  * @param {string} cell Unique identifier addressing a cell in all API calls.
6711
6972
  * @param {ProfinetInputOutputConfig} profinetInputOutputConfig
@@ -6763,7 +7024,7 @@ export const BUSInputsOutputsApiFp = function(configuration?: Configuration) {
6763
7024
  const localVarAxiosParamCreator = BUSInputsOutputsApiAxiosParamCreator(configuration)
6764
7025
  return {
6765
7026
  /**
6766
- * Add a BUS Inputs/Outputs Service to the cell.
7027
+ * Add the BUS inputs/outputs service to the cell. Starts a containerized service that enables BUS connections via the specified ethernet port.
6767
7028
  * @summary Add Service
6768
7029
  * @param {string} cell Unique identifier addressing a cell in all API calls.
6769
7030
  * @param {BusIOType} busIOType
@@ -6778,7 +7039,7 @@ export const BUSInputsOutputsApiFp = function(configuration?: Configuration) {
6778
7039
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
6779
7040
  },
6780
7041
  /**
6781
- * Adds an input/output to or updates an input/output on the PROFINET device.
7042
+ * 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
7043
  * @summary Add PROFINET Input/Output
6783
7044
  * @param {string} cell Unique identifier addressing a cell in all API calls.
6784
7045
  * @param {string} io Unique identifier to address an Input/Output in the cell.
@@ -6793,7 +7054,7 @@ export const BUSInputsOutputsApiFp = function(configuration?: Configuration) {
6793
7054
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
6794
7055
  },
6795
7056
  /**
6796
- * Delete BUS Inputs/Outputs Service from the cell.
7057
+ * Remove the BUS inputs/outputs service from the cell.
6797
7058
  * @summary Clear Service
6798
7059
  * @param {string} cell Unique identifier addressing a cell in all API calls.
6799
7060
  * @param {number} [completionTimeout]
@@ -6807,7 +7068,7 @@ export const BUSInputsOutputsApiFp = function(configuration?: Configuration) {
6807
7068
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
6808
7069
  },
6809
7070
  /**
6810
- * Removes the input/output from the PROFINET device.
7071
+ * Removes an input/output variable configuration from the PROFINET device, e.g. NOVA\'s PROFINET service.
6811
7072
  * @summary Remove PROFINET Input/Ouptut
6812
7073
  * @param {string} cell Unique identifier addressing a cell in all API calls.
6813
7074
  * @param {string} io Unique identifier to address an Input/Output in the cell.
@@ -6821,7 +7082,7 @@ export const BUSInputsOutputsApiFp = function(configuration?: Configuration) {
6821
7082
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
6822
7083
  },
6823
7084
  /**
6824
- * Get deployed BUS Inputs/Outputs Service.
7085
+ * Get deployed BUS inputs/outputs service.
6825
7086
  * @summary Get Service
6826
7087
  * @param {string} cell Unique identifier addressing a cell in all API calls.
6827
7088
  * @param {*} [options] Override http request option.
@@ -6861,7 +7122,7 @@ export const BUSInputsOutputsApiFp = function(configuration?: Configuration) {
6861
7122
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
6862
7123
  },
6863
7124
  /**
6864
- * Get description of PROFINET
7125
+ * Get description of NOVA as a PROFINET device.
6865
7126
  * @summary Get PROFINET Description
6866
7127
  * @param {string} cell Unique identifier addressing a cell in all API calls.
6867
7128
  * @param {*} [options] Override http request option.
@@ -6874,7 +7135,7 @@ export const BUSInputsOutputsApiFp = function(configuration?: Configuration) {
6874
7135
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
6875
7136
  },
6876
7137
  /**
6877
- * Get input/output configuration of the PROFINET device as file.
7138
+ * 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
7139
  * @summary PROFINET Inputs/Outputs to File
6879
7140
  * @param {string} cell Unique identifier addressing a cell in all API calls.
6880
7141
  * @param {number} [inputOffset]
@@ -6889,20 +7150,20 @@ export const BUSInputsOutputsApiFp = function(configuration?: Configuration) {
6889
7150
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
6890
7151
  },
6891
7152
  /**
6892
- * List all BUS Input/Output descriptions.
7153
+ * 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
7154
  * @summary List Descriptions
6894
7155
  * @param {string} cell Unique identifier addressing a cell in all API calls.
6895
7156
  * @param {*} [options] Override http request option.
6896
7157
  * @throws {RequiredError}
6897
7158
  */
6898
- async listBusIODescriptions(cell: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<IODescription>>> {
7159
+ async listBusIODescriptions(cell: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<IODescription2>>> {
6899
7160
  const localVarAxiosArgs = await localVarAxiosParamCreator.listBusIODescriptions(cell, options);
6900
7161
  const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
6901
7162
  const localVarOperationServerBasePath = operationServerMap['BUSInputsOutputsApi.listBusIODescriptions']?.[localVarOperationServerIndex]?.url;
6902
7163
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
6903
7164
  },
6904
7165
  /**
6905
- * List all PROFINET input and outputs.
7166
+ * 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
7167
  * @summary List PROFINET Input/Output Configuration
6907
7168
  * @param {string} cell Unique identifier addressing a cell in all API calls.
6908
7169
  * @param {*} [options] Override http request option.
@@ -6929,7 +7190,7 @@ export const BUSInputsOutputsApiFp = function(configuration?: Configuration) {
6929
7190
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
6930
7191
  },
6931
7192
  /**
6932
- * Sets inputs/outputs on the PROFINET device from file.
7193
+ * 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
7194
  * @summary Set PROFINET Inputs/Outputs from File
6934
7195
  * @param {string} cell Unique identifier addressing a cell in all API calls.
6935
7196
  * @param {ProfinetInputOutputConfig} profinetInputOutputConfig
@@ -6953,7 +7214,7 @@ export const BUSInputsOutputsApiFactory = function (configuration?: Configuratio
6953
7214
  const localVarFp = BUSInputsOutputsApiFp(configuration)
6954
7215
  return {
6955
7216
  /**
6956
- * Add a BUS Inputs/Outputs Service to the cell.
7217
+ * Add the BUS inputs/outputs service to the cell. Starts a containerized service that enables BUS connections via the specified ethernet port.
6957
7218
  * @summary Add Service
6958
7219
  * @param {string} cell Unique identifier addressing a cell in all API calls.
6959
7220
  * @param {BusIOType} busIOType
@@ -6965,7 +7226,7 @@ export const BUSInputsOutputsApiFactory = function (configuration?: Configuratio
6965
7226
  return localVarFp.addBusIOService(cell, busIOType, completionTimeout, options).then((request) => request(axios, basePath));
6966
7227
  },
6967
7228
  /**
6968
- * Adds an input/output to or updates an input/output on the PROFINET device.
7229
+ * 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
7230
  * @summary Add PROFINET Input/Output
6970
7231
  * @param {string} cell Unique identifier addressing a cell in all API calls.
6971
7232
  * @param {string} io Unique identifier to address an Input/Output in the cell.
@@ -6977,7 +7238,7 @@ export const BUSInputsOutputsApiFactory = function (configuration?: Configuratio
6977
7238
  return localVarFp.addProfinetIO(cell, io, profinetIOData, options).then((request) => request(axios, basePath));
6978
7239
  },
6979
7240
  /**
6980
- * Delete BUS Inputs/Outputs Service from the cell.
7241
+ * Remove the BUS inputs/outputs service from the cell.
6981
7242
  * @summary Clear Service
6982
7243
  * @param {string} cell Unique identifier addressing a cell in all API calls.
6983
7244
  * @param {number} [completionTimeout]
@@ -6988,7 +7249,7 @@ export const BUSInputsOutputsApiFactory = function (configuration?: Configuratio
6988
7249
  return localVarFp.clearBusIOService(cell, completionTimeout, options).then((request) => request(axios, basePath));
6989
7250
  },
6990
7251
  /**
6991
- * Removes the input/output from the PROFINET device.
7252
+ * Removes an input/output variable configuration from the PROFINET device, e.g. NOVA\'s PROFINET service.
6992
7253
  * @summary Remove PROFINET Input/Ouptut
6993
7254
  * @param {string} cell Unique identifier addressing a cell in all API calls.
6994
7255
  * @param {string} io Unique identifier to address an Input/Output in the cell.
@@ -6999,7 +7260,7 @@ export const BUSInputsOutputsApiFactory = function (configuration?: Configuratio
6999
7260
  return localVarFp.deleteProfinetIO(cell, io, options).then((request) => request(axios, basePath));
7000
7261
  },
7001
7262
  /**
7002
- * Get deployed BUS Inputs/Outputs Service.
7263
+ * Get deployed BUS inputs/outputs service.
7003
7264
  * @summary Get Service
7004
7265
  * @param {string} cell Unique identifier addressing a cell in all API calls.
7005
7266
  * @param {*} [options] Override http request option.
@@ -7030,7 +7291,7 @@ export const BUSInputsOutputsApiFactory = function (configuration?: Configuratio
7030
7291
  return localVarFp.getBusIOValues(cell, ios, options).then((request) => request(axios, basePath));
7031
7292
  },
7032
7293
  /**
7033
- * Get description of PROFINET
7294
+ * Get description of NOVA as a PROFINET device.
7034
7295
  * @summary Get PROFINET Description
7035
7296
  * @param {string} cell Unique identifier addressing a cell in all API calls.
7036
7297
  * @param {*} [options] Override http request option.
@@ -7040,7 +7301,7 @@ export const BUSInputsOutputsApiFactory = function (configuration?: Configuratio
7040
7301
  return localVarFp.getProfinetDescription(cell, options).then((request) => request(axios, basePath));
7041
7302
  },
7042
7303
  /**
7043
- * Get input/output configuration of the PROFINET device as file.
7304
+ * 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
7305
  * @summary PROFINET Inputs/Outputs to File
7045
7306
  * @param {string} cell Unique identifier addressing a cell in all API calls.
7046
7307
  * @param {number} [inputOffset]
@@ -7052,17 +7313,17 @@ export const BUSInputsOutputsApiFactory = function (configuration?: Configuratio
7052
7313
  return localVarFp.getProfinetIOsFromFile(cell, inputOffset, outputOffset, options).then((request) => request(axios, basePath));
7053
7314
  },
7054
7315
  /**
7055
- * List all BUS Input/Output descriptions.
7316
+ * 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
7317
  * @summary List Descriptions
7057
7318
  * @param {string} cell Unique identifier addressing a cell in all API calls.
7058
7319
  * @param {*} [options] Override http request option.
7059
7320
  * @throws {RequiredError}
7060
7321
  */
7061
- listBusIODescriptions(cell: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<IODescription>> {
7322
+ listBusIODescriptions(cell: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<IODescription2>> {
7062
7323
  return localVarFp.listBusIODescriptions(cell, options).then((request) => request(axios, basePath));
7063
7324
  },
7064
7325
  /**
7065
- * List all PROFINET input and outputs.
7326
+ * 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
7327
  * @summary List PROFINET Input/Output Configuration
7067
7328
  * @param {string} cell Unique identifier addressing a cell in all API calls.
7068
7329
  * @param {*} [options] Override http request option.
@@ -7083,7 +7344,7 @@ export const BUSInputsOutputsApiFactory = function (configuration?: Configuratio
7083
7344
  return localVarFp.setBusIOValues(cell, iOValue, options).then((request) => request(axios, basePath));
7084
7345
  },
7085
7346
  /**
7086
- * Sets inputs/outputs on the PROFINET device from file.
7347
+ * 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
7348
  * @summary Set PROFINET Inputs/Outputs from File
7088
7349
  * @param {string} cell Unique identifier addressing a cell in all API calls.
7089
7350
  * @param {ProfinetInputOutputConfig} profinetInputOutputConfig
@@ -7104,7 +7365,7 @@ export const BUSInputsOutputsApiFactory = function (configuration?: Configuratio
7104
7365
  */
7105
7366
  export class BUSInputsOutputsApi extends BaseAPI {
7106
7367
  /**
7107
- * Add a BUS Inputs/Outputs Service to the cell.
7368
+ * Add the BUS inputs/outputs service to the cell. Starts a containerized service that enables BUS connections via the specified ethernet port.
7108
7369
  * @summary Add Service
7109
7370
  * @param {string} cell Unique identifier addressing a cell in all API calls.
7110
7371
  * @param {BusIOType} busIOType
@@ -7118,7 +7379,7 @@ export class BUSInputsOutputsApi extends BaseAPI {
7118
7379
  }
7119
7380
 
7120
7381
  /**
7121
- * Adds an input/output to or updates an input/output on the PROFINET device.
7382
+ * 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
7383
  * @summary Add PROFINET Input/Output
7123
7384
  * @param {string} cell Unique identifier addressing a cell in all API calls.
7124
7385
  * @param {string} io Unique identifier to address an Input/Output in the cell.
@@ -7132,7 +7393,7 @@ export class BUSInputsOutputsApi extends BaseAPI {
7132
7393
  }
7133
7394
 
7134
7395
  /**
7135
- * Delete BUS Inputs/Outputs Service from the cell.
7396
+ * Remove the BUS inputs/outputs service from the cell.
7136
7397
  * @summary Clear Service
7137
7398
  * @param {string} cell Unique identifier addressing a cell in all API calls.
7138
7399
  * @param {number} [completionTimeout]
@@ -7145,7 +7406,7 @@ export class BUSInputsOutputsApi extends BaseAPI {
7145
7406
  }
7146
7407
 
7147
7408
  /**
7148
- * Removes the input/output from the PROFINET device.
7409
+ * Removes an input/output variable configuration from the PROFINET device, e.g. NOVA\'s PROFINET service.
7149
7410
  * @summary Remove PROFINET Input/Ouptut
7150
7411
  * @param {string} cell Unique identifier addressing a cell in all API calls.
7151
7412
  * @param {string} io Unique identifier to address an Input/Output in the cell.
@@ -7158,7 +7419,7 @@ export class BUSInputsOutputsApi extends BaseAPI {
7158
7419
  }
7159
7420
 
7160
7421
  /**
7161
- * Get deployed BUS Inputs/Outputs Service.
7422
+ * Get deployed BUS inputs/outputs service.
7162
7423
  * @summary Get Service
7163
7424
  * @param {string} cell Unique identifier addressing a cell in all API calls.
7164
7425
  * @param {*} [options] Override http request option.
@@ -7195,7 +7456,7 @@ export class BUSInputsOutputsApi extends BaseAPI {
7195
7456
  }
7196
7457
 
7197
7458
  /**
7198
- * Get description of PROFINET
7459
+ * Get description of NOVA as a PROFINET device.
7199
7460
  * @summary Get PROFINET Description
7200
7461
  * @param {string} cell Unique identifier addressing a cell in all API calls.
7201
7462
  * @param {*} [options] Override http request option.
@@ -7207,7 +7468,7 @@ export class BUSInputsOutputsApi extends BaseAPI {
7207
7468
  }
7208
7469
 
7209
7470
  /**
7210
- * Get input/output configuration of the PROFINET device as file.
7471
+ * 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
7472
  * @summary PROFINET Inputs/Outputs to File
7212
7473
  * @param {string} cell Unique identifier addressing a cell in all API calls.
7213
7474
  * @param {number} [inputOffset]
@@ -7221,7 +7482,7 @@ export class BUSInputsOutputsApi extends BaseAPI {
7221
7482
  }
7222
7483
 
7223
7484
  /**
7224
- * List all BUS Input/Output descriptions.
7485
+ * 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
7486
  * @summary List Descriptions
7226
7487
  * @param {string} cell Unique identifier addressing a cell in all API calls.
7227
7488
  * @param {*} [options] Override http request option.
@@ -7233,7 +7494,7 @@ export class BUSInputsOutputsApi extends BaseAPI {
7233
7494
  }
7234
7495
 
7235
7496
  /**
7236
- * List all PROFINET input and outputs.
7497
+ * 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
7498
  * @summary List PROFINET Input/Output Configuration
7238
7499
  * @param {string} cell Unique identifier addressing a cell in all API calls.
7239
7500
  * @param {*} [options] Override http request option.
@@ -7258,7 +7519,7 @@ export class BUSInputsOutputsApi extends BaseAPI {
7258
7519
  }
7259
7520
 
7260
7521
  /**
7261
- * Sets inputs/outputs on the PROFINET device from file.
7522
+ * 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
7523
  * @summary Set PROFINET Inputs/Outputs from File
7263
7524
  * @param {string} cell Unique identifier addressing a cell in all API calls.
7264
7525
  * @param {ProfinetInputOutputConfig} profinetInputOutputConfig
@@ -10725,7 +10986,7 @@ export class MotionGroupApi extends BaseAPI {
10725
10986
  export const MotionGroupModelsApiAxiosParamCreator = function (configuration?: Configuration) {
10726
10987
  return {
10727
10988
  /**
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.
10989
+ * 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
10990
  * @summary Get Collision Model
10730
10991
  * @param {string} cell Unique identifier addressing a cell in all API calls.
10731
10992
  * @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 +11084,7 @@ export const MotionGroupModelsApiFp = function(configuration?: Configuration) {
10823
11084
  const localVarAxiosParamCreator = MotionGroupModelsApiAxiosParamCreator(configuration)
10824
11085
  return {
10825
11086
  /**
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.
11087
+ * 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
11088
  * @summary Get Collision Model
10828
11089
  * @param {string} cell Unique identifier addressing a cell in all API calls.
10829
11090
  * @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 +11121,7 @@ export const MotionGroupModelsApiFactory = function (configuration?: Configurati
10860
11121
  const localVarFp = MotionGroupModelsApiFp(configuration)
10861
11122
  return {
10862
11123
  /**
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.
11124
+ * 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
11125
  * @summary Get Collision Model
10865
11126
  * @param {string} cell Unique identifier addressing a cell in all API calls.
10866
11127
  * @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 +11152,7 @@ export const MotionGroupModelsApiFactory = function (configuration?: Configurati
10891
11152
  */
10892
11153
  export class MotionGroupModelsApi extends BaseAPI {
10893
11154
  /**
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.
11155
+ * 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
11156
  * @summary Get Collision Model
10896
11157
  * @param {string} cell Unique identifier addressing a cell in all API calls.
10897
11158
  * @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 +11179,383 @@ export class MotionGroupModelsApi extends BaseAPI {
10918
11179
 
10919
11180
 
10920
11181
 
11182
+ /**
11183
+ * ProgramApi - axios parameter creator
11184
+ * @export
11185
+ */
11186
+ export const ProgramApiAxiosParamCreator = function (configuration?: Configuration) {
11187
+ return {
11188
+ /**
11189
+ * Get details of a program.
11190
+ * @summary Get program
11191
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
11192
+ * @param {string} program
11193
+ * @param {*} [options] Override http request option.
11194
+ * @throws {RequiredError}
11195
+ */
11196
+ getProgram: async (cell: string, program: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
11197
+ // verify required parameter 'cell' is not null or undefined
11198
+ assertParamExists('getProgram', 'cell', cell)
11199
+ // verify required parameter 'program' is not null or undefined
11200
+ assertParamExists('getProgram', 'program', program)
11201
+ const localVarPath = `/experimental/cells/{cell}/programs/{program}`
11202
+ .replace(`{${"cell"}}`, encodeURIComponent(String(cell)))
11203
+ .replace(`{${"program"}}`, encodeURIComponent(String(program)));
11204
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
11205
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
11206
+ let baseOptions;
11207
+ if (configuration) {
11208
+ baseOptions = configuration.baseOptions;
11209
+ }
11210
+
11211
+ const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
11212
+ const localVarHeaderParameter = {} as any;
11213
+ const localVarQueryParameter = {} as any;
11214
+
11215
+ // authentication BasicAuth required
11216
+ // http basic authentication required
11217
+ setBasicAuthToObject(localVarRequestOptions, configuration)
11218
+
11219
+ // authentication BearerAuth required
11220
+ // http bearer authentication required
11221
+ await setBearerAuthToObject(localVarHeaderParameter, configuration)
11222
+
11223
+
11224
+
11225
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
11226
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
11227
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
11228
+
11229
+ return {
11230
+ url: toPathString(localVarUrlObj),
11231
+ options: localVarRequestOptions,
11232
+ };
11233
+ },
11234
+ /**
11235
+ * List details of all existing programs.
11236
+ * @summary List programs
11237
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
11238
+ * @param {*} [options] Override http request option.
11239
+ * @throws {RequiredError}
11240
+ */
11241
+ listPrograms: async (cell: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
11242
+ // verify required parameter 'cell' is not null or undefined
11243
+ assertParamExists('listPrograms', 'cell', cell)
11244
+ const localVarPath = `/experimental/cells/{cell}/programs`
11245
+ .replace(`{${"cell"}}`, encodeURIComponent(String(cell)));
11246
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
11247
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
11248
+ let baseOptions;
11249
+ if (configuration) {
11250
+ baseOptions = configuration.baseOptions;
11251
+ }
11252
+
11253
+ const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
11254
+ const localVarHeaderParameter = {} as any;
11255
+ const localVarQueryParameter = {} as any;
11256
+
11257
+ // authentication BasicAuth required
11258
+ // http basic authentication required
11259
+ setBasicAuthToObject(localVarRequestOptions, configuration)
11260
+
11261
+ // authentication BearerAuth required
11262
+ // http bearer authentication required
11263
+ await setBearerAuthToObject(localVarHeaderParameter, configuration)
11264
+
11265
+
11266
+
11267
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
11268
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
11269
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
11270
+
11271
+ return {
11272
+ url: toPathString(localVarUrlObj),
11273
+ options: localVarRequestOptions,
11274
+ };
11275
+ },
11276
+ /**
11277
+ * This endpoint starts a new program execution. The program will be executed asynchronously.
11278
+ * @summary Start the program
11279
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
11280
+ * @param {string} program
11281
+ * @param {ProgramStartRequest} programStartRequest
11282
+ * @param {*} [options] Override http request option.
11283
+ * @throws {RequiredError}
11284
+ */
11285
+ startProgram: async (cell: string, program: string, programStartRequest: ProgramStartRequest, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
11286
+ // verify required parameter 'cell' is not null or undefined
11287
+ assertParamExists('startProgram', 'cell', cell)
11288
+ // verify required parameter 'program' is not null or undefined
11289
+ assertParamExists('startProgram', 'program', program)
11290
+ // verify required parameter 'programStartRequest' is not null or undefined
11291
+ assertParamExists('startProgram', 'programStartRequest', programStartRequest)
11292
+ const localVarPath = `/experimental/cells/{cell}/programs/{program}/start`
11293
+ .replace(`{${"cell"}}`, encodeURIComponent(String(cell)))
11294
+ .replace(`{${"program"}}`, encodeURIComponent(String(program)));
11295
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
11296
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
11297
+ let baseOptions;
11298
+ if (configuration) {
11299
+ baseOptions = configuration.baseOptions;
11300
+ }
11301
+
11302
+ const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
11303
+ const localVarHeaderParameter = {} as any;
11304
+ const localVarQueryParameter = {} as any;
11305
+
11306
+ // authentication BasicAuth required
11307
+ // http basic authentication required
11308
+ setBasicAuthToObject(localVarRequestOptions, configuration)
11309
+
11310
+ // authentication BearerAuth required
11311
+ // http bearer authentication required
11312
+ await setBearerAuthToObject(localVarHeaderParameter, configuration)
11313
+
11314
+
11315
+
11316
+ localVarHeaderParameter['Content-Type'] = 'application/json';
11317
+
11318
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
11319
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
11320
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
11321
+ localVarRequestOptions.data = serializeDataIfNeeded(programStartRequest, localVarRequestOptions, configuration)
11322
+
11323
+ return {
11324
+ url: toPathString(localVarUrlObj),
11325
+ options: localVarRequestOptions,
11326
+ };
11327
+ },
11328
+ /**
11329
+ * Stop a specific program run.
11330
+ * @summary Stop program run
11331
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
11332
+ * @param {string} program
11333
+ * @param {*} [options] Override http request option.
11334
+ * @throws {RequiredError}
11335
+ */
11336
+ stopProgram: async (cell: string, program: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
11337
+ // verify required parameter 'cell' is not null or undefined
11338
+ assertParamExists('stopProgram', 'cell', cell)
11339
+ // verify required parameter 'program' is not null or undefined
11340
+ assertParamExists('stopProgram', 'program', program)
11341
+ const localVarPath = `/experimental/cells/{cell}/programs/{program}/stop`
11342
+ .replace(`{${"cell"}}`, encodeURIComponent(String(cell)))
11343
+ .replace(`{${"program"}}`, encodeURIComponent(String(program)));
11344
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
11345
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
11346
+ let baseOptions;
11347
+ if (configuration) {
11348
+ baseOptions = configuration.baseOptions;
11349
+ }
11350
+
11351
+ const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
11352
+ const localVarHeaderParameter = {} as any;
11353
+ const localVarQueryParameter = {} as any;
11354
+
11355
+ // authentication BasicAuth required
11356
+ // http basic authentication required
11357
+ setBasicAuthToObject(localVarRequestOptions, configuration)
11358
+
11359
+ // authentication BearerAuth required
11360
+ // http bearer authentication required
11361
+ await setBearerAuthToObject(localVarHeaderParameter, configuration)
11362
+
11363
+
11364
+
11365
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
11366
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
11367
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
11368
+
11369
+ return {
11370
+ url: toPathString(localVarUrlObj),
11371
+ options: localVarRequestOptions,
11372
+ };
11373
+ },
11374
+ }
11375
+ };
11376
+
11377
+ /**
11378
+ * ProgramApi - functional programming interface
11379
+ * @export
11380
+ */
11381
+ export const ProgramApiFp = function(configuration?: Configuration) {
11382
+ const localVarAxiosParamCreator = ProgramApiAxiosParamCreator(configuration)
11383
+ return {
11384
+ /**
11385
+ * Get details of a program.
11386
+ * @summary Get program
11387
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
11388
+ * @param {string} program
11389
+ * @param {*} [options] Override http request option.
11390
+ * @throws {RequiredError}
11391
+ */
11392
+ async getProgram(cell: string, program: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Program>> {
11393
+ const localVarAxiosArgs = await localVarAxiosParamCreator.getProgram(cell, program, options);
11394
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
11395
+ const localVarOperationServerBasePath = operationServerMap['ProgramApi.getProgram']?.[localVarOperationServerIndex]?.url;
11396
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
11397
+ },
11398
+ /**
11399
+ * List details of all existing programs.
11400
+ * @summary List programs
11401
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
11402
+ * @param {*} [options] Override http request option.
11403
+ * @throws {RequiredError}
11404
+ */
11405
+ async listPrograms(cell: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<Program>>> {
11406
+ const localVarAxiosArgs = await localVarAxiosParamCreator.listPrograms(cell, options);
11407
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
11408
+ const localVarOperationServerBasePath = operationServerMap['ProgramApi.listPrograms']?.[localVarOperationServerIndex]?.url;
11409
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
11410
+ },
11411
+ /**
11412
+ * This endpoint starts a new program execution. The program will be executed asynchronously.
11413
+ * @summary Start the program
11414
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
11415
+ * @param {string} program
11416
+ * @param {ProgramStartRequest} programStartRequest
11417
+ * @param {*} [options] Override http request option.
11418
+ * @throws {RequiredError}
11419
+ */
11420
+ async startProgram(cell: string, program: string, programStartRequest: ProgramStartRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ProgramRun>> {
11421
+ const localVarAxiosArgs = await localVarAxiosParamCreator.startProgram(cell, program, programStartRequest, options);
11422
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
11423
+ const localVarOperationServerBasePath = operationServerMap['ProgramApi.startProgram']?.[localVarOperationServerIndex]?.url;
11424
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
11425
+ },
11426
+ /**
11427
+ * Stop a specific program run.
11428
+ * @summary Stop program run
11429
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
11430
+ * @param {string} program
11431
+ * @param {*} [options] Override http request option.
11432
+ * @throws {RequiredError}
11433
+ */
11434
+ async stopProgram(cell: string, program: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> {
11435
+ const localVarAxiosArgs = await localVarAxiosParamCreator.stopProgram(cell, program, options);
11436
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
11437
+ const localVarOperationServerBasePath = operationServerMap['ProgramApi.stopProgram']?.[localVarOperationServerIndex]?.url;
11438
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
11439
+ },
11440
+ }
11441
+ };
11442
+
11443
+ /**
11444
+ * ProgramApi - factory interface
11445
+ * @export
11446
+ */
11447
+ export const ProgramApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
11448
+ const localVarFp = ProgramApiFp(configuration)
11449
+ return {
11450
+ /**
11451
+ * Get details of a program.
11452
+ * @summary Get program
11453
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
11454
+ * @param {string} program
11455
+ * @param {*} [options] Override http request option.
11456
+ * @throws {RequiredError}
11457
+ */
11458
+ getProgram(cell: string, program: string, options?: RawAxiosRequestConfig): AxiosPromise<Program> {
11459
+ return localVarFp.getProgram(cell, program, options).then((request) => request(axios, basePath));
11460
+ },
11461
+ /**
11462
+ * List details of all existing programs.
11463
+ * @summary List programs
11464
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
11465
+ * @param {*} [options] Override http request option.
11466
+ * @throws {RequiredError}
11467
+ */
11468
+ listPrograms(cell: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<Program>> {
11469
+ return localVarFp.listPrograms(cell, options).then((request) => request(axios, basePath));
11470
+ },
11471
+ /**
11472
+ * This endpoint starts a new program execution. The program will be executed asynchronously.
11473
+ * @summary Start the program
11474
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
11475
+ * @param {string} program
11476
+ * @param {ProgramStartRequest} programStartRequest
11477
+ * @param {*} [options] Override http request option.
11478
+ * @throws {RequiredError}
11479
+ */
11480
+ startProgram(cell: string, program: string, programStartRequest: ProgramStartRequest, options?: RawAxiosRequestConfig): AxiosPromise<ProgramRun> {
11481
+ return localVarFp.startProgram(cell, program, programStartRequest, options).then((request) => request(axios, basePath));
11482
+ },
11483
+ /**
11484
+ * Stop a specific program run.
11485
+ * @summary Stop program run
11486
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
11487
+ * @param {string} program
11488
+ * @param {*} [options] Override http request option.
11489
+ * @throws {RequiredError}
11490
+ */
11491
+ stopProgram(cell: string, program: string, options?: RawAxiosRequestConfig): AxiosPromise<void> {
11492
+ return localVarFp.stopProgram(cell, program, options).then((request) => request(axios, basePath));
11493
+ },
11494
+ };
11495
+ };
11496
+
11497
+ /**
11498
+ * ProgramApi - object-oriented interface
11499
+ * @export
11500
+ * @class ProgramApi
11501
+ * @extends {BaseAPI}
11502
+ */
11503
+ export class ProgramApi extends BaseAPI {
11504
+ /**
11505
+ * Get details of a program.
11506
+ * @summary Get program
11507
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
11508
+ * @param {string} program
11509
+ * @param {*} [options] Override http request option.
11510
+ * @throws {RequiredError}
11511
+ * @memberof ProgramApi
11512
+ */
11513
+ public getProgram(cell: string, program: string, options?: RawAxiosRequestConfig) {
11514
+ return ProgramApiFp(this.configuration).getProgram(cell, program, options).then((request) => request(this.axios, this.basePath));
11515
+ }
11516
+
11517
+ /**
11518
+ * List details of all existing programs.
11519
+ * @summary List programs
11520
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
11521
+ * @param {*} [options] Override http request option.
11522
+ * @throws {RequiredError}
11523
+ * @memberof ProgramApi
11524
+ */
11525
+ public listPrograms(cell: string, options?: RawAxiosRequestConfig) {
11526
+ return ProgramApiFp(this.configuration).listPrograms(cell, options).then((request) => request(this.axios, this.basePath));
11527
+ }
11528
+
11529
+ /**
11530
+ * This endpoint starts a new program execution. The program will be executed asynchronously.
11531
+ * @summary Start the program
11532
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
11533
+ * @param {string} program
11534
+ * @param {ProgramStartRequest} programStartRequest
11535
+ * @param {*} [options] Override http request option.
11536
+ * @throws {RequiredError}
11537
+ * @memberof ProgramApi
11538
+ */
11539
+ public startProgram(cell: string, program: string, programStartRequest: ProgramStartRequest, options?: RawAxiosRequestConfig) {
11540
+ return ProgramApiFp(this.configuration).startProgram(cell, program, programStartRequest, options).then((request) => request(this.axios, this.basePath));
11541
+ }
11542
+
11543
+ /**
11544
+ * Stop a specific program run.
11545
+ * @summary Stop program run
11546
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
11547
+ * @param {string} program
11548
+ * @param {*} [options] Override http request option.
11549
+ * @throws {RequiredError}
11550
+ * @memberof ProgramApi
11551
+ */
11552
+ public stopProgram(cell: string, program: string, options?: RawAxiosRequestConfig) {
11553
+ return ProgramApiFp(this.configuration).stopProgram(cell, program, options).then((request) => request(this.axios, this.basePath));
11554
+ }
11555
+ }
11556
+
11557
+
11558
+
10921
11559
  /**
10922
11560
  * StoreCollisionComponentsApi - axios parameter creator
10923
11561
  * @export
@@ -11243,7 +11881,7 @@ export const StoreCollisionComponentsApiAxiosParamCreator = function (configurat
11243
11881
  };
11244
11882
  },
11245
11883
  /**
11246
- * Returns a list of colliders in a scene. This excludes colliders that are part of a motion group.
11884
+ * Returns all stored colliders.
11247
11885
  * @summary List Colliders
11248
11886
  * @param {string} cell Unique identifier addressing a cell in all API calls.
11249
11887
  * @param {*} [options] Override http request option.
@@ -11590,7 +12228,7 @@ export const StoreCollisionComponentsApiFp = function(configuration?: Configurat
11590
12228
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
11591
12229
  },
11592
12230
  /**
11593
- * Returns a list of colliders in a scene. This excludes colliders that are part of a motion group.
12231
+ * Returns all stored colliders.
11594
12232
  * @summary List Colliders
11595
12233
  * @param {string} cell Unique identifier addressing a cell in all API calls.
11596
12234
  * @param {*} [options] Override http request option.
@@ -11747,7 +12385,7 @@ export const StoreCollisionComponentsApiFactory = function (configuration?: Conf
11747
12385
  return localVarFp.listCollisionLinkChains(cell, options).then((request) => request(axios, basePath));
11748
12386
  },
11749
12387
  /**
11750
- * Returns a list of colliders in a scene. This excludes colliders that are part of a motion group.
12388
+ * Returns all stored colliders.
11751
12389
  * @summary List Colliders
11752
12390
  * @param {string} cell Unique identifier addressing a cell in all API calls.
11753
12391
  * @param {*} [options] Override http request option.
@@ -11903,7 +12541,7 @@ export class StoreCollisionComponentsApi extends BaseAPI {
11903
12541
  }
11904
12542
 
11905
12543
  /**
11906
- * Returns a list of colliders in a scene. This excludes colliders that are part of a motion group.
12544
+ * Returns all stored colliders.
11907
12545
  * @summary List Colliders
11908
12546
  * @param {string} cell Unique identifier addressing a cell in all API calls.
11909
12547
  * @param {*} [options] Override http request option.