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

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/v2/api.d.ts CHANGED
@@ -93,7 +93,7 @@ export interface AddTrajectoryError {
93
93
  */
94
94
  'message'?: string;
95
95
  /**
96
- * The location of the error in the trajectory.
96
+ * Location on trajectory where the execution will start. The default value is the start (forward movement) or end (backward movement) of the trajectory. If you want to start your movement from an arbitrary location, e.g. in combination with [streamMoveToTrajectoryViaJointPTP](streamMoveToTrajectoryViaJointPTP), set the location by respecting the following format: - The location is a scalar value that defines a position along a path, typically ranging from 0 to `n`, where `n` denotes the number of motion commands - Each integer value of the location corresponds to a specific motion command, while non-integer values interpolate positions within the segments. - The location is calculated from the joint path
97
97
  * @type {number}
98
98
  * @memberof AddTrajectoryError
99
99
  */
@@ -342,7 +342,7 @@ export declare const BoxBoxTypeEnum: {
342
342
  };
343
343
  export type BoxBoxTypeEnum = typeof BoxBoxTypeEnum[keyof typeof BoxBoxTypeEnum];
344
344
  /**
345
- * PROFINET BUS Inputs/Outputs Service configuration.
345
+ * PROFINET BUS inputs/outputs service configuration.
346
346
  * @export
347
347
  * @interface BusIOProfinet
348
348
  */
@@ -354,19 +354,19 @@ export interface BusIOProfinet {
354
354
  */
355
355
  'bus_type'?: BusIOProfinetBusTypeEnum;
356
356
  /**
357
- * Path to the configuration file.
358
- * @type {string}
357
+ * Used to enable IP communication through the same physical ethernet interface while PROFINET driver is active.
358
+ * @type {BusIOProfinetNetwork}
359
359
  * @memberof BusIOProfinet
360
360
  */
361
- 'config_file_content'?: string;
361
+ 'network_config'?: BusIOProfinetNetwork;
362
362
  /**
363
- *
364
- * @type {BusIOProfinetNetwork}
363
+ * IP address of the PLC to establish PROFINET communication with. The IP address is used to configure the host machine\'s firewall. The firewall configuration is applied while the BUS input/output service is active. Without proper firewall configuration, PROFINET device discovery, configuration exchanges, and real-time cyclic data communication will fail.
364
+ * @type {string}
365
365
  * @memberof BusIOProfinet
366
366
  */
367
- 'network_config'?: BusIOProfinetNetwork;
367
+ 'plc_ip': string;
368
368
  /**
369
- * MAC address for the PROFINET port, should be get from another NOVA API endpoind?
369
+ * MAC address of the physical ethernet interface that you want to use for PROFINET communication.
370
370
  * @type {string}
371
371
  * @memberof BusIOProfinet
372
372
  */
@@ -383,7 +383,7 @@ export declare const BusIOProfinetBusTypeEnum: {
383
383
  };
384
384
  export type BusIOProfinetBusTypeEnum = typeof BusIOProfinetBusTypeEnum[keyof typeof BusIOProfinetBusTypeEnum];
385
385
  /**
386
- * Default route configuration for the PROFINET service. Will be removed before release by automatic default route configuration, if possible.
386
+ * 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.
387
387
  * @export
388
388
  * @interface BusIOProfinetDefaultRoute
389
389
  */
@@ -402,25 +402,25 @@ export interface BusIOProfinetDefaultRoute {
402
402
  'interface': string;
403
403
  }
404
404
  /**
405
- * Network configuration for the PROFINET device
405
+ * 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.
406
406
  * @export
407
407
  * @interface BusIOProfinetIpConfig
408
408
  */
409
409
  export interface BusIOProfinetIpConfig {
410
410
  /**
411
- * IP address for the PROFINET device
411
+ * IP address for the device\'s virtual ethernet interface (pnio1).
412
412
  * @type {string}
413
413
  * @memberof BusIOProfinetIpConfig
414
414
  */
415
415
  'ip': string;
416
416
  /**
417
- * Network mask for the PROFINET device.
417
+ * Network mask for the device\'s virtual ethernet interface (pnio1).
418
418
  * @type {string}
419
419
  * @memberof BusIOProfinetIpConfig
420
420
  */
421
421
  'netmask': string;
422
422
  /**
423
- * Gateway for the PROFINET device
423
+ * Gateway for connections to other devices outside of the virtual ethernet interface\'s subnet.
424
424
  * @type {string}
425
425
  * @memberof BusIOProfinetIpConfig
426
426
  */
@@ -433,7 +433,7 @@ export interface BusIOProfinetIpConfig {
433
433
  */
434
434
  export interface BusIOProfinetNetwork {
435
435
  /**
436
- * Name of the PROFINET device.
436
+ * 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.
437
437
  * @type {string}
438
438
  * @memberof BusIOProfinetNetwork
439
439
  */
@@ -445,14 +445,14 @@ export interface BusIOProfinetNetwork {
445
445
  */
446
446
  'ip_config'?: BusIOProfinetIpConfig;
447
447
  /**
448
- * Content of the PROFINET REMA XML file.
448
+ * 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.
449
449
  * @type {string}
450
450
  * @memberof BusIOProfinetNetwork
451
451
  */
452
452
  'rema_xml_content'?: string;
453
453
  }
454
454
  /**
455
- * Virtual PROFINET BUS Inputs/Outputs Service configuration.
455
+ * Virtual PROFINET BUS inputs/outputs service configuration.
456
456
  * @export
457
457
  * @interface BusIOProfinetVirtual
458
458
  */
@@ -465,7 +465,7 @@ export interface BusIOProfinetVirtual {
465
465
  'bus_type'?: BusIOProfinetVirtualBusTypeEnum;
466
466
  }
467
467
  export declare const BusIOProfinetVirtualBusTypeEnum: {
468
- readonly VirtualProfinet: "virtual_profinet";
468
+ readonly ProfinetVirtual: "profinet_virtual";
469
469
  };
470
470
  export type BusIOProfinetVirtualBusTypeEnum = typeof BusIOProfinetVirtualBusTypeEnum[keyof typeof BusIOProfinetVirtualBusTypeEnum];
471
471
  /**
@@ -490,7 +490,7 @@ export interface BusIOsState {
490
490
  */
491
491
  'state': BusIOsStateEnum;
492
492
  /**
493
- * A message providing additional information on the input/output, e.g. BUS service status, encountered errors. May be empty if no additional information is available.
493
+ * 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.
494
494
  * @type {string}
495
495
  * @memberof BusIOsState
496
496
  */
@@ -1708,9 +1708,22 @@ export interface GetTrajectoryResponse {
1708
1708
  export interface HTTPValidationError {
1709
1709
  /**
1710
1710
  *
1711
- * @type {Array<ValidationError>}
1711
+ * @type {Array<ValidationError2>}
1712
1712
  * @memberof HTTPValidationError
1713
1713
  */
1714
+ 'detail'?: Array<ValidationError2>;
1715
+ }
1716
+ /**
1717
+ *
1718
+ * @export
1719
+ * @interface HTTPValidationError2
1720
+ */
1721
+ export interface HTTPValidationError2 {
1722
+ /**
1723
+ *
1724
+ * @type {Array<ValidationError>}
1725
+ * @memberof HTTPValidationError2
1726
+ */
1714
1727
  'detail'?: Array<ValidationError>;
1715
1728
  }
1716
1729
  /**
@@ -1797,6 +1810,55 @@ export interface IODescription {
1797
1810
  */
1798
1811
  'max'?: IODescriptionMin;
1799
1812
  }
1813
+ /**
1814
+ *
1815
+ * @export
1816
+ * @interface IODescription2
1817
+ */
1818
+ export interface IODescription2 {
1819
+ /**
1820
+ * Unique identifier of the input/output.
1821
+ * @type {string}
1822
+ * @memberof IODescription2
1823
+ */
1824
+ 'io': string;
1825
+ /**
1826
+ * Descriptive name of the input/output. Customize it using the respective BUS service, e.g. [addProfinetIO](addProfinetIO) for PROFINET service.
1827
+ * @type {string}
1828
+ * @memberof IODescription2
1829
+ */
1830
+ 'name': string;
1831
+ /**
1832
+ *
1833
+ * @type {IODirection}
1834
+ * @memberof IODescription2
1835
+ */
1836
+ 'direction': IODirection;
1837
+ /**
1838
+ *
1839
+ * @type {IOValueType}
1840
+ * @memberof IODescription2
1841
+ */
1842
+ 'value_type': IOValueType;
1843
+ /**
1844
+ *
1845
+ * @type {UnitType}
1846
+ * @memberof IODescription2
1847
+ */
1848
+ 'unit'?: UnitType;
1849
+ /**
1850
+ *
1851
+ * @type {IODescriptionMin}
1852
+ * @memberof IODescription2
1853
+ */
1854
+ 'min'?: IODescriptionMin;
1855
+ /**
1856
+ *
1857
+ * @type {IODescriptionMin}
1858
+ * @memberof IODescription2
1859
+ */
1860
+ 'max'?: IODescriptionMin;
1861
+ }
1800
1862
  /**
1801
1863
  * @type IODescriptionMin
1802
1864
  * @export
@@ -1860,7 +1922,7 @@ export interface IOIntegerValue {
1860
1922
  */
1861
1923
  'io': string;
1862
1924
  /**
1863
- * 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.
1925
+ * 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.
1864
1926
  * @type {string}
1865
1927
  * @memberof IOIntegerValue
1866
1928
  */
@@ -1997,12 +2059,6 @@ export interface InitializeJoggingRequest {
1997
2059
  * @memberof InitializeJoggingRequest
1998
2060
  */
1999
2061
  'response_coordinate_system'?: string;
2000
- /**
2001
- * Defines an input/output that is listened to during the movement. Execution pauses if the defined comparator evaluates to `true`.
2002
- * @type {string}
2003
- * @memberof InitializeJoggingRequest
2004
- */
2005
- 'pause_on_io'?: string;
2006
2062
  }
2007
2063
  export declare const InitializeJoggingRequestMessageTypeEnum: {
2008
2064
  readonly InitializeJoggingRequest: "InitializeJoggingRequest";
@@ -2112,7 +2168,7 @@ export declare const InitializeMovementResponseKindEnum: {
2112
2168
  };
2113
2169
  export type InitializeMovementResponseKindEnum = typeof InitializeMovementResponseKindEnum[keyof typeof InitializeMovementResponseKindEnum];
2114
2170
  /**
2115
- * 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.
2171
+ * 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.
2116
2172
  * @export
2117
2173
  * @interface IntegerValue
2118
2174
  */
@@ -2313,9 +2369,19 @@ export type JoggingDetailsKindEnum = typeof JoggingDetailsKindEnum[keyof typeof
2313
2369
  * @type JoggingDetailsState
2314
2370
  * @export
2315
2371
  */
2316
- export type JoggingDetailsState = JoggingPausedByUser | JoggingPausedNearCollision | JoggingPausedNearJointLimit | JoggingPausedOnIO | JoggingRunning;
2372
+ export type JoggingDetailsState = {
2373
+ kind: 'PAUSED_BY_USER';
2374
+ } & JoggingPausedByUser | {
2375
+ kind: 'PAUSED_NEAR_COLLISION';
2376
+ } & JoggingPausedNearCollision | {
2377
+ kind: 'PAUSED_NEAR_JOINT_LIMIT';
2378
+ } & JoggingPausedNearJointLimit | {
2379
+ kind: 'PAUSED_ON_IO';
2380
+ } & JoggingPausedOnIO | {
2381
+ kind: 'RUNNING';
2382
+ } & JoggingRunning;
2317
2383
  /**
2318
- *
2384
+ * User has paused jogging.
2319
2385
  * @export
2320
2386
  * @interface JoggingPausedByUser
2321
2387
  */
@@ -2332,7 +2398,7 @@ export declare const JoggingPausedByUserKindEnum: {
2332
2398
  };
2333
2399
  export type JoggingPausedByUserKindEnum = typeof JoggingPausedByUserKindEnum[keyof typeof JoggingPausedByUserKindEnum];
2334
2400
  /**
2335
- *
2401
+ * Jogging was paused because the motion group neared a collision.
2336
2402
  * @export
2337
2403
  * @interface JoggingPausedNearCollision
2338
2404
  */
@@ -2355,7 +2421,7 @@ export declare const JoggingPausedNearCollisionKindEnum: {
2355
2421
  };
2356
2422
  export type JoggingPausedNearCollisionKindEnum = typeof JoggingPausedNearCollisionKindEnum[keyof typeof JoggingPausedNearCollisionKindEnum];
2357
2423
  /**
2358
- *
2424
+ * Jogging was paused because a joint is near its limit.
2359
2425
  * @export
2360
2426
  * @interface JoggingPausedNearJointLimit
2361
2427
  */
@@ -2378,7 +2444,7 @@ export declare const JoggingPausedNearJointLimitKindEnum: {
2378
2444
  };
2379
2445
  export type JoggingPausedNearJointLimitKindEnum = typeof JoggingPausedNearJointLimitKindEnum[keyof typeof JoggingPausedNearJointLimitKindEnum];
2380
2446
  /**
2381
- *
2447
+ * Jogging was paused because of an I/O event.
2382
2448
  * @export
2383
2449
  * @interface JoggingPausedOnIO
2384
2450
  */
@@ -2395,7 +2461,7 @@ export declare const JoggingPausedOnIOKindEnum: {
2395
2461
  };
2396
2462
  export type JoggingPausedOnIOKindEnum = typeof JoggingPausedOnIOKindEnum[keyof typeof JoggingPausedOnIOKindEnum];
2397
2463
  /**
2398
- *
2464
+ * Jogging is active.
2399
2465
  * @export
2400
2466
  * @interface JoggingRunning
2401
2467
  */
@@ -2474,7 +2540,7 @@ export interface JointTrajectory {
2474
2540
  */
2475
2541
  'times': Array<number>;
2476
2542
  /**
2477
- * Location for each sample, scalar value defining a position along a path. Typical range: 0 to `n`, `n` denoting the number of motion commands. Each integer value of the location corresponds to a specific motion command. If provided, the number of samples must match the number of timestamps provided in the times field.
2543
+ *
2478
2544
  * @type {Array<number>}
2479
2545
  * @memberof JointTrajectory
2480
2546
  */
@@ -2749,6 +2815,12 @@ export interface LimitSet {
2749
2815
  * @memberof LimitSet
2750
2816
  */
2751
2817
  'flange'?: CartesianLimits;
2818
+ /**
2819
+ *
2820
+ * @type {JointLimits}
2821
+ * @memberof LimitSet
2822
+ */
2823
+ 'coupled_shoulder_elbow_joint'?: JointLimits;
2752
2824
  }
2753
2825
  /**
2754
2826
  * If a limit is not set, the default value will be used.
@@ -2820,13 +2892,13 @@ export declare const Manufacturer: {
2820
2892
  };
2821
2893
  export type Manufacturer = typeof Manufacturer[keyof typeof Manufacturer];
2822
2894
  /**
2823
- * 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.
2895
+ *
2824
2896
  * @export
2825
2897
  * @interface MidpointInsertionAlgorithm
2826
2898
  */
2827
2899
  export interface MidpointInsertionAlgorithm {
2828
2900
  /**
2829
- * Algorithm discriminator.
2901
+ * 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.
2830
2902
  * @type {string}
2831
2903
  * @memberof MidpointInsertionAlgorithm
2832
2904
  */
@@ -3687,11 +3759,11 @@ export interface PlanTrajectoryFailedResponse {
3687
3759
  */
3688
3760
  'error_feedback': PlanTrajectoryFailedResponseErrorFeedback;
3689
3761
  /**
3690
- *
3762
+ * Location on trajectory where the execution will start. The default value is the start (forward movement) or end (backward movement) of the trajectory. If you want to start your movement from an arbitrary location, e.g. in combination with [streamMoveToTrajectoryViaJointPTP](streamMoveToTrajectoryViaJointPTP), set the location by respecting the following format: - The location is a scalar value that defines a position along a path, typically ranging from 0 to `n`, where `n` denotes the number of motion commands - Each integer value of the location corresponds to a specific motion command, while non-integer values interpolate positions within the segments. - The location is calculated from the joint path
3691
3763
  * @type {number}
3692
3764
  * @memberof PlanTrajectoryFailedResponse
3693
3765
  */
3694
- 'error_location_on_trajectory'?: number;
3766
+ 'error_location_on_trajectory': number;
3695
3767
  /**
3696
3768
  * The joint trajectory from the start joint position to the error.
3697
3769
  * @type {JointTrajectory}
@@ -3905,17 +3977,17 @@ export interface ProfinetDescription {
3905
3977
  */
3906
3978
  'slots'?: Array<ProfinetSlotDescription>;
3907
3979
  /**
3908
- * Name of the PROFINET device
3980
+ * 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.
3909
3981
  * @type {string}
3910
3982
  * @memberof ProfinetDescription
3911
3983
  */
3912
3984
  'device_name'?: string;
3913
3985
  /**
3914
- * IP address for the PROFINET device
3915
- * @type {string}
3986
+ *
3987
+ * @type {BusIOProfinetIpConfig}
3916
3988
  * @memberof ProfinetDescription
3917
3989
  */
3918
- 'ip'?: string;
3990
+ 'ip_config'?: BusIOProfinetIpConfig;
3919
3991
  }
3920
3992
  /**
3921
3993
  *
@@ -3924,7 +3996,7 @@ export interface ProfinetDescription {
3924
3996
  */
3925
3997
  export interface ProfinetIO {
3926
3998
  /**
3927
- * 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.
3999
+ * 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).
3928
4000
  * @type {string}
3929
4001
  * @memberof ProfinetIO
3930
4002
  */
@@ -3936,25 +4008,25 @@ export interface ProfinetIO {
3936
4008
  */
3937
4009
  'type': ProfinetIOTypeEnum;
3938
4010
  /**
3939
- * The direction of the input/output value, indicating whether it is an input or output for the device.
4011
+ * 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.
3940
4012
  * @type {ProfinetIODirection}
3941
4013
  * @memberof ProfinetIO
3942
4014
  */
3943
4015
  'direction': ProfinetIODirection;
3944
4016
  /**
3945
- * 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.
4017
+ * 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.
3946
4018
  * @type {number}
3947
4019
  * @memberof ProfinetIO
3948
4020
  */
3949
4021
  'byte_address': number;
3950
4022
  /**
3951
- * 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.
4023
+ * 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.
3952
4024
  * @type {number}
3953
4025
  * @memberof ProfinetIO
3954
4026
  */
3955
4027
  'bit_address'?: number;
3956
4028
  /**
3957
- * The unique identifier for the input/output value. This identifier is used to reference the specific input/output in the NOVA system.
4029
+ * 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.
3958
4030
  * @type {string}
3959
4031
  * @memberof ProfinetIO
3960
4032
  */
@@ -3967,7 +4039,7 @@ export interface ProfinetIO {
3967
4039
  */
3968
4040
  export interface ProfinetIOData {
3969
4041
  /**
3970
- * 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.
4042
+ * 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).
3971
4043
  * @type {string}
3972
4044
  * @memberof ProfinetIOData
3973
4045
  */
@@ -3979,26 +4051,26 @@ export interface ProfinetIOData {
3979
4051
  */
3980
4052
  'type': ProfinetIOTypeEnum;
3981
4053
  /**
3982
- * The direction of the input/output value, indicating whether it is an input or output for the device.
4054
+ * 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.
3983
4055
  * @type {ProfinetIODirection}
3984
4056
  * @memberof ProfinetIOData
3985
4057
  */
3986
4058
  'direction': ProfinetIODirection;
3987
4059
  /**
3988
- * 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.
4060
+ * 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.
3989
4061
  * @type {number}
3990
4062
  * @memberof ProfinetIOData
3991
4063
  */
3992
4064
  'byte_address': number;
3993
4065
  /**
3994
- * 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.
4066
+ * 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.
3995
4067
  * @type {number}
3996
4068
  * @memberof ProfinetIOData
3997
4069
  */
3998
4070
  'bit_address'?: number;
3999
4071
  }
4000
4072
  /**
4001
- * Identifies the input/output type.
4073
+ * 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.
4002
4074
  * @export
4003
4075
  * @enum {string}
4004
4076
  */
@@ -4009,7 +4081,7 @@ export declare const ProfinetIODirection: {
4009
4081
  };
4010
4082
  export type ProfinetIODirection = typeof ProfinetIODirection[keyof typeof ProfinetIODirection];
4011
4083
  /**
4012
- * Value type of the PROFINET input/output.
4084
+ * Value type of the PROFINET input/output variable. Is used to interpret the corresponding bits correctly.
4013
4085
  * @export
4014
4086
  * @enum {string}
4015
4087
  */
@@ -4033,38 +4105,38 @@ export type ProfinetIOTypeEnum = typeof ProfinetIOTypeEnum[keyof typeof Profinet
4033
4105
  */
4034
4106
  export interface ProfinetInputOutputConfig {
4035
4107
  /**
4036
- * Content of the input output configuration file.
4108
+ * 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.
4037
4109
  * @type {string}
4038
4110
  * @memberof ProfinetInputOutputConfig
4039
4111
  */
4040
4112
  'config': string;
4041
4113
  /**
4042
- * Offset in bytes for the input data.
4114
+ * 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.
4043
4115
  * @type {number}
4044
4116
  * @memberof ProfinetInputOutputConfig
4045
4117
  */
4046
4118
  'input_offset': number;
4047
4119
  /**
4048
- * Offset in bytes for the output data.
4120
+ * 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.
4049
4121
  * @type {number}
4050
4122
  * @memberof ProfinetInputOutputConfig
4051
4123
  */
4052
4124
  'output_offset': number;
4053
4125
  }
4054
4126
  /**
4055
- *
4127
+ * 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).
4056
4128
  * @export
4057
4129
  * @interface ProfinetSlotDescription
4058
4130
  */
4059
4131
  export interface ProfinetSlotDescription {
4060
4132
  /**
4061
- * The number of the PROFINET slot.
4133
+ * 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.
4062
4134
  * @type {number}
4063
4135
  * @memberof ProfinetSlotDescription
4064
4136
  */
4065
4137
  'number': number;
4066
4138
  /**
4067
- * The API number of the PROFINET input, used to identify the specific API for the input.
4139
+ * The application process identifier (API) number of the PROFINET input. The API identifies the application relation (AR) that is using the slot.
4068
4140
  * @type {number}
4069
4141
  * @memberof ProfinetSlotDescription
4070
4142
  */
@@ -4083,32 +4155,174 @@ export interface ProfinetSlotDescription {
4083
4155
  */
4084
4156
  export interface ProfinetSubSlotDescription {
4085
4157
  /**
4086
- * The identifier of the PROFINET subslot.
4158
+ * The number/index of the PROFINET subslot.
4087
4159
  * @type {number}
4088
4160
  * @memberof ProfinetSubSlotDescription
4089
4161
  */
4090
4162
  'number': number;
4091
4163
  /**
4092
- * The length in bytes of the PROFINET input.
4164
+ * The amount of bytes allocated for the subslot in the input process image buffer.
4093
4165
  * @type {number}
4094
4166
  * @memberof ProfinetSubSlotDescription
4095
4167
  */
4096
4168
  'input_length': number;
4097
4169
  /**
4098
- * The length in bytes of the PROFINET output.
4170
+ * The amount of bytes allocated for the subslot in the output process image buffer.
4099
4171
  * @type {number}
4100
4172
  * @memberof ProfinetSubSlotDescription
4101
4173
  */
4102
4174
  'output_length': number;
4103
4175
  }
4104
4176
  /**
4105
- * <!-- 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.
4177
+ * A program is a collection of instructions that are executed in the robot cell.
4178
+ * @export
4179
+ * @interface Program
4180
+ */
4181
+ export interface Program {
4182
+ /**
4183
+ *
4184
+ * @type {string}
4185
+ * @memberof Program
4186
+ */
4187
+ 'program': string;
4188
+ /**
4189
+ *
4190
+ * @type {string}
4191
+ * @memberof Program
4192
+ */
4193
+ 'name'?: string;
4194
+ /**
4195
+ *
4196
+ * @type {string}
4197
+ * @memberof Program
4198
+ */
4199
+ 'description'?: string;
4200
+ /**
4201
+ *
4202
+ * @type {string}
4203
+ * @memberof Program
4204
+ */
4205
+ 'app': string;
4206
+ /**
4207
+ *
4208
+ * @type {object}
4209
+ * @memberof Program
4210
+ */
4211
+ 'input_schema'?: object;
4212
+ /**
4213
+ *
4214
+ * @type {object}
4215
+ * @memberof Program
4216
+ */
4217
+ 'preconditions'?: object;
4218
+ }
4219
+ /**
4220
+ * Holds the state of a program run.
4221
+ * @export
4222
+ * @interface ProgramRun
4223
+ */
4224
+ export interface ProgramRun {
4225
+ /**
4226
+ * Unique identifier of the program run
4227
+ * @type {string}
4228
+ * @memberof ProgramRun
4229
+ */
4230
+ 'run': string;
4231
+ /**
4232
+ * Unique identifier of the program
4233
+ * @type {string}
4234
+ * @memberof ProgramRun
4235
+ */
4236
+ 'program': string;
4237
+ /**
4238
+ * State of the program run
4239
+ * @type {ProgramRunState}
4240
+ * @memberof ProgramRun
4241
+ */
4242
+ 'state': ProgramRunState;
4243
+ /**
4244
+ * Logs of the program run
4245
+ * @type {string}
4246
+ * @memberof ProgramRun
4247
+ */
4248
+ 'logs'?: string;
4249
+ /**
4250
+ * Stdout of the program run
4251
+ * @type {string}
4252
+ * @memberof ProgramRun
4253
+ */
4254
+ 'stdout'?: string;
4255
+ /**
4256
+ * Stderr of the program run
4257
+ * @type {string}
4258
+ * @memberof ProgramRun
4259
+ */
4260
+ 'stderr'?: string;
4261
+ /**
4262
+ * Error message of the program run, if any
4263
+ * @type {string}
4264
+ * @memberof ProgramRun
4265
+ */
4266
+ 'error'?: string;
4267
+ /**
4268
+ * Traceback of the program run, if any
4269
+ * @type {string}
4270
+ * @memberof ProgramRun
4271
+ */
4272
+ 'traceback'?: string;
4273
+ /**
4274
+ * Start time of the program run
4275
+ * @type {string}
4276
+ * @memberof ProgramRun
4277
+ */
4278
+ 'start_time'?: string;
4279
+ /**
4280
+ * End time of the program run
4281
+ * @type {string}
4282
+ * @memberof ProgramRun
4283
+ */
4284
+ 'end_time'?: string;
4285
+ /**
4286
+ * Input data of the program run
4287
+ * @type {object}
4288
+ * @memberof ProgramRun
4289
+ */
4290
+ 'input_data'?: object;
4291
+ }
4292
+ /**
4293
+ * The state of a program run.
4294
+ * @export
4295
+ * @enum {string}
4296
+ */
4297
+ export declare const ProgramRunState: {
4298
+ readonly Preparing: "PREPARING";
4299
+ readonly Running: "RUNNING";
4300
+ readonly Completed: "COMPLETED";
4301
+ readonly Failed: "FAILED";
4302
+ readonly Stopped: "STOPPED";
4303
+ };
4304
+ export type ProgramRunState = typeof ProgramRunState[keyof typeof ProgramRunState];
4305
+ /**
4306
+ * The state of a program run.
4307
+ * @export
4308
+ * @interface ProgramStartRequest
4309
+ */
4310
+ export interface ProgramStartRequest {
4311
+ /**
4312
+ * The arguments to pass to the program.
4313
+ * @type {object}
4314
+ * @memberof ProgramStartRequest
4315
+ */
4316
+ 'arguments': object;
4317
+ }
4318
+ /**
4319
+ *
4106
4320
  * @export
4107
4321
  * @interface RRTConnectAlgorithm
4108
4322
  */
4109
4323
  export interface RRTConnectAlgorithm {
4110
4324
  /**
4111
- * Algorithm discriminator.
4325
+ * 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.
4112
4326
  * @type {string}
4113
4327
  * @memberof RRTConnectAlgorithm
4114
4328
  */
@@ -4119,6 +4333,30 @@ export interface RRTConnectAlgorithm {
4119
4333
  * @memberof RRTConnectAlgorithm
4120
4334
  */
4121
4335
  'max_iterations'?: number;
4336
+ /**
4337
+ * Maximum step size for tree extension in joint space.
4338
+ * @type {number}
4339
+ * @memberof RRTConnectAlgorithm
4340
+ */
4341
+ 'max_step_size'?: number;
4342
+ /**
4343
+ * Adjust the maximum step size during the search based on the recent success rate of tree expansion.
4344
+ * @type {boolean}
4345
+ * @memberof RRTConnectAlgorithm
4346
+ */
4347
+ 'adaptive_step_size'?: boolean;
4348
+ /**
4349
+ * Apply smoothing after the search has succeeded. This will remove as many intermediate points as possible while keeping the path valid.
4350
+ * @type {boolean}
4351
+ * @memberof RRTConnectAlgorithm
4352
+ */
4353
+ 'apply_smoothing'?: boolean;
4354
+ /**
4355
+ * Apply blending after the search has succeeded and smoothing has been applied. This will apply the largest viable blending at each intermediate point.
4356
+ * @type {boolean}
4357
+ * @memberof RRTConnectAlgorithm
4358
+ */
4359
+ 'apply_blending'?: boolean;
4122
4360
  }
4123
4361
  export declare const RRTConnectAlgorithmAlgorithmNameEnum: {
4124
4362
  readonly RrtConnectAlgorithm: "RRTConnectAlgorithm";
@@ -4502,6 +4740,25 @@ export interface ServiceStatusStatus {
4502
4740
  */
4503
4741
  'reason'?: string;
4504
4742
  }
4743
+ /**
4744
+ * Defines an input/output that should be set upon reaching a specified location on the trajectory.
4745
+ * @export
4746
+ * @interface SetIO
4747
+ */
4748
+ export interface SetIO {
4749
+ /**
4750
+ *
4751
+ * @type {IOValue}
4752
+ * @memberof SetIO
4753
+ */
4754
+ 'io': IOValue;
4755
+ /**
4756
+ * The location on the trajectory where the input/output should be set.
4757
+ * @type {number}
4758
+ * @memberof SetIO
4759
+ */
4760
+ 'location': number;
4761
+ }
4505
4762
  /**
4506
4763
  *
4507
4764
  * @export
@@ -4566,10 +4823,10 @@ export interface StartMovementRequest {
4566
4823
  'direction'?: Direction;
4567
4824
  /**
4568
4825
  * Attaches a list of output commands to the trajectory. The outputs are set to the specified values right after the specified location was reached. If the specified location is located before the start location (forward direction: value is smaller, backward direction: value is bigger), the output is not set.
4569
- * @type {Array<IOValue>}
4826
+ * @type {Array<SetIO>}
4570
4827
  * @memberof StartMovementRequest
4571
4828
  */
4572
- 'set_outputs'?: Array<IOValue>;
4829
+ 'set_outputs'?: Array<SetIO>;
4573
4830
  /**
4574
4831
  * Defines an input/output that is listened to before the movement. Execution starts if the defined comparator evaluates to `true`.
4575
4832
  * @type {StartOnIO}
@@ -4824,7 +5081,7 @@ export interface TrajectoryDetails {
4824
5081
  */
4825
5082
  'trajectory': string;
4826
5083
  /**
4827
- * Current location of motion group on the trajectory.
5084
+ * Location on trajectory where the execution will start. The default value is the start (forward movement) or end (backward movement) of the trajectory. If you want to start your movement from an arbitrary location, e.g. in combination with [streamMoveToTrajectoryViaJointPTP](streamMoveToTrajectoryViaJointPTP), set the location by respecting the following format: - The location is a scalar value that defines a position along a path, typically ranging from 0 to `n`, where `n` denotes the number of motion commands - Each integer value of the location corresponds to a specific motion command, while non-integer values interpolate positions within the segments. - The location is calculated from the joint path
4828
5085
  * @type {number}
4829
5086
  * @memberof TrajectoryDetails
4830
5087
  */
@@ -4850,9 +5107,19 @@ export type TrajectoryDetailsKindEnum = typeof TrajectoryDetailsKindEnum[keyof t
4850
5107
  * @type TrajectoryDetailsState
4851
5108
  * @export
4852
5109
  */
4853
- export type TrajectoryDetailsState = TrajectoryEnded | TrajectoryPausedByUser | TrajectoryPausedOnIO | TrajectoryRunning | TrajectoryWaitForIO;
5110
+ export type TrajectoryDetailsState = {
5111
+ kind: 'END_OF_TRAJECTORY';
5112
+ } & TrajectoryEnded | {
5113
+ kind: 'PAUSED_BY_USER';
5114
+ } & TrajectoryPausedByUser | {
5115
+ kind: 'PAUSED_ON_IO';
5116
+ } & TrajectoryPausedOnIO | {
5117
+ kind: 'RUNNING';
5118
+ } & TrajectoryRunning | {
5119
+ kind: 'WAIT_FOR_IO';
5120
+ } & TrajectoryWaitForIO;
4854
5121
  /**
4855
- *
5122
+ * First or last sample (depending on direction) of trajectory has been sent.
4856
5123
  * @export
4857
5124
  * @interface TrajectoryEnded
4858
5125
  */
@@ -4892,7 +5159,7 @@ export declare const TrajectoryIdMessageTypeEnum: {
4892
5159
  };
4893
5160
  export type TrajectoryIdMessageTypeEnum = typeof TrajectoryIdMessageTypeEnum[keyof typeof TrajectoryIdMessageTypeEnum];
4894
5161
  /**
4895
- *
5162
+ * User has paused execution.
4896
5163
  * @export
4897
5164
  * @interface TrajectoryPausedByUser
4898
5165
  */
@@ -4909,7 +5176,7 @@ export declare const TrajectoryPausedByUserKindEnum: {
4909
5176
  };
4910
5177
  export type TrajectoryPausedByUserKindEnum = typeof TrajectoryPausedByUserKindEnum[keyof typeof TrajectoryPausedByUserKindEnum];
4911
5178
  /**
4912
- *
5179
+ * Execution was paused because of an I/O event.
4913
5180
  * @export
4914
5181
  * @interface TrajectoryPausedOnIO
4915
5182
  */
@@ -4926,7 +5193,7 @@ export declare const TrajectoryPausedOnIOKindEnum: {
4926
5193
  };
4927
5194
  export type TrajectoryPausedOnIOKindEnum = typeof TrajectoryPausedOnIOKindEnum[keyof typeof TrajectoryPausedOnIOKindEnum];
4928
5195
  /**
4929
- *
5196
+ * Trajectory is being executed.
4930
5197
  * @export
4931
5198
  * @interface TrajectoryRunning
4932
5199
  */
@@ -4949,7 +5216,7 @@ export declare const TrajectoryRunningKindEnum: {
4949
5216
  };
4950
5217
  export type TrajectoryRunningKindEnum = typeof TrajectoryRunningKindEnum[keyof typeof TrajectoryRunningKindEnum];
4951
5218
  /**
4952
- *
5219
+ * Waiting for an I/O event to start execution.
4953
5220
  * @export
4954
5221
  * @interface TrajectoryWaitForIO
4955
5222
  */
@@ -5052,6 +5319,31 @@ export interface ValidationError {
5052
5319
  [key: string]: any;
5053
5320
  };
5054
5321
  }
5322
+ /**
5323
+ * A validation error of a program.
5324
+ * @export
5325
+ * @interface ValidationError2
5326
+ */
5327
+ export interface ValidationError2 {
5328
+ /**
5329
+ *
5330
+ * @type {Array<number>}
5331
+ * @memberof ValidationError2
5332
+ */
5333
+ 'loc': Array<number>;
5334
+ /**
5335
+ *
5336
+ * @type {string}
5337
+ * @memberof ValidationError2
5338
+ */
5339
+ 'msg': string;
5340
+ /**
5341
+ *
5342
+ * @type {string}
5343
+ * @memberof ValidationError2
5344
+ */
5345
+ 'type': string;
5346
+ }
5055
5347
  /**
5056
5348
  * @type ValidationErrorLocInner
5057
5349
  * @export
@@ -5542,7 +5834,7 @@ export declare class ApplicationApi extends BaseAPI {
5542
5834
  */
5543
5835
  export declare const BUSInputsOutputsApiAxiosParamCreator: (configuration?: Configuration) => {
5544
5836
  /**
5545
- * Add a BUS Inputs/Outputs Service to the cell.
5837
+ * Add the BUS inputs/outputs service to the cell. Starts a containerized service that enables BUS connections via the specified ethernet port.
5546
5838
  * @summary Add Service
5547
5839
  * @param {string} cell Unique identifier addressing a cell in all API calls.
5548
5840
  * @param {BusIOType} busIOType
@@ -5552,7 +5844,7 @@ export declare const BUSInputsOutputsApiAxiosParamCreator: (configuration?: Conf
5552
5844
  */
5553
5845
  addBusIOService: (cell: string, busIOType: BusIOType, completionTimeout?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
5554
5846
  /**
5555
- * Adds an input/output to or updates an input/output on the PROFINET device.
5847
+ * 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).
5556
5848
  * @summary Add PROFINET Input/Output
5557
5849
  * @param {string} cell Unique identifier addressing a cell in all API calls.
5558
5850
  * @param {string} io Unique identifier to address an Input/Output in the cell.
@@ -5562,7 +5854,7 @@ export declare const BUSInputsOutputsApiAxiosParamCreator: (configuration?: Conf
5562
5854
  */
5563
5855
  addProfinetIO: (cell: string, io: string, profinetIOData: ProfinetIOData, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
5564
5856
  /**
5565
- * Delete BUS Inputs/Outputs Service from the cell.
5857
+ * Remove the BUS inputs/outputs service from the cell.
5566
5858
  * @summary Clear Service
5567
5859
  * @param {string} cell Unique identifier addressing a cell in all API calls.
5568
5860
  * @param {number} [completionTimeout]
@@ -5571,7 +5863,7 @@ export declare const BUSInputsOutputsApiAxiosParamCreator: (configuration?: Conf
5571
5863
  */
5572
5864
  clearBusIOService: (cell: string, completionTimeout?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
5573
5865
  /**
5574
- * Removes the input/output from the PROFINET device.
5866
+ * Removes an input/output variable configuration from the PROFINET device, e.g. NOVA\'s PROFINET service.
5575
5867
  * @summary Remove PROFINET Input/Ouptut
5576
5868
  * @param {string} cell Unique identifier addressing a cell in all API calls.
5577
5869
  * @param {string} io Unique identifier to address an Input/Output in the cell.
@@ -5580,7 +5872,7 @@ export declare const BUSInputsOutputsApiAxiosParamCreator: (configuration?: Conf
5580
5872
  */
5581
5873
  deleteProfinetIO: (cell: string, io: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
5582
5874
  /**
5583
- * Get deployed BUS Inputs/Outputs Service.
5875
+ * Get deployed BUS inputs/outputs service.
5584
5876
  * @summary Get Service
5585
5877
  * @param {string} cell Unique identifier addressing a cell in all API calls.
5586
5878
  * @param {*} [options] Override http request option.
@@ -5605,7 +5897,7 @@ export declare const BUSInputsOutputsApiAxiosParamCreator: (configuration?: Conf
5605
5897
  */
5606
5898
  getBusIOValues: (cell: string, ios?: Array<string>, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
5607
5899
  /**
5608
- * Get description of PROFINET
5900
+ * Get description of NOVA as a PROFINET device.
5609
5901
  * @summary Get PROFINET Description
5610
5902
  * @param {string} cell Unique identifier addressing a cell in all API calls.
5611
5903
  * @param {*} [options] Override http request option.
@@ -5613,7 +5905,7 @@ export declare const BUSInputsOutputsApiAxiosParamCreator: (configuration?: Conf
5613
5905
  */
5614
5906
  getProfinetDescription: (cell: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
5615
5907
  /**
5616
- * Get input/output configuration of the PROFINET device as file.
5908
+ * 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.
5617
5909
  * @summary PROFINET Inputs/Outputs to File
5618
5910
  * @param {string} cell Unique identifier addressing a cell in all API calls.
5619
5911
  * @param {number} [inputOffset]
@@ -5623,7 +5915,7 @@ export declare const BUSInputsOutputsApiAxiosParamCreator: (configuration?: Conf
5623
5915
  */
5624
5916
  getProfinetIOsFromFile: (cell: string, inputOffset?: number, outputOffset?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
5625
5917
  /**
5626
- * List all BUS Input/Output descriptions.
5918
+ * 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.
5627
5919
  * @summary List Descriptions
5628
5920
  * @param {string} cell Unique identifier addressing a cell in all API calls.
5629
5921
  * @param {*} [options] Override http request option.
@@ -5631,7 +5923,7 @@ export declare const BUSInputsOutputsApiAxiosParamCreator: (configuration?: Conf
5631
5923
  */
5632
5924
  listBusIODescriptions: (cell: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
5633
5925
  /**
5634
- * List all PROFINET input and outputs.
5926
+ * 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.
5635
5927
  * @summary List PROFINET Input/Output Configuration
5636
5928
  * @param {string} cell Unique identifier addressing a cell in all API calls.
5637
5929
  * @param {*} [options] Override http request option.
@@ -5648,7 +5940,7 @@ export declare const BUSInputsOutputsApiAxiosParamCreator: (configuration?: Conf
5648
5940
  */
5649
5941
  setBusIOValues: (cell: string, iOValue: Array<IOValue>, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
5650
5942
  /**
5651
- * Sets inputs/outputs on the PROFINET device from file.
5943
+ * 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.
5652
5944
  * @summary Set PROFINET Inputs/Outputs from File
5653
5945
  * @param {string} cell Unique identifier addressing a cell in all API calls.
5654
5946
  * @param {ProfinetInputOutputConfig} profinetInputOutputConfig
@@ -5663,7 +5955,7 @@ export declare const BUSInputsOutputsApiAxiosParamCreator: (configuration?: Conf
5663
5955
  */
5664
5956
  export declare const BUSInputsOutputsApiFp: (configuration?: Configuration) => {
5665
5957
  /**
5666
- * Add a BUS Inputs/Outputs Service to the cell.
5958
+ * Add the BUS inputs/outputs service to the cell. Starts a containerized service that enables BUS connections via the specified ethernet port.
5667
5959
  * @summary Add Service
5668
5960
  * @param {string} cell Unique identifier addressing a cell in all API calls.
5669
5961
  * @param {BusIOType} busIOType
@@ -5673,7 +5965,7 @@ export declare const BUSInputsOutputsApiFp: (configuration?: Configuration) => {
5673
5965
  */
5674
5966
  addBusIOService(cell: string, busIOType: BusIOType, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
5675
5967
  /**
5676
- * Adds an input/output to or updates an input/output on the PROFINET device.
5968
+ * 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).
5677
5969
  * @summary Add PROFINET Input/Output
5678
5970
  * @param {string} cell Unique identifier addressing a cell in all API calls.
5679
5971
  * @param {string} io Unique identifier to address an Input/Output in the cell.
@@ -5683,7 +5975,7 @@ export declare const BUSInputsOutputsApiFp: (configuration?: Configuration) => {
5683
5975
  */
5684
5976
  addProfinetIO(cell: string, io: string, profinetIOData: ProfinetIOData, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
5685
5977
  /**
5686
- * Delete BUS Inputs/Outputs Service from the cell.
5978
+ * Remove the BUS inputs/outputs service from the cell.
5687
5979
  * @summary Clear Service
5688
5980
  * @param {string} cell Unique identifier addressing a cell in all API calls.
5689
5981
  * @param {number} [completionTimeout]
@@ -5692,7 +5984,7 @@ export declare const BUSInputsOutputsApiFp: (configuration?: Configuration) => {
5692
5984
  */
5693
5985
  clearBusIOService(cell: string, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
5694
5986
  /**
5695
- * Removes the input/output from the PROFINET device.
5987
+ * Removes an input/output variable configuration from the PROFINET device, e.g. NOVA\'s PROFINET service.
5696
5988
  * @summary Remove PROFINET Input/Ouptut
5697
5989
  * @param {string} cell Unique identifier addressing a cell in all API calls.
5698
5990
  * @param {string} io Unique identifier to address an Input/Output in the cell.
@@ -5701,7 +5993,7 @@ export declare const BUSInputsOutputsApiFp: (configuration?: Configuration) => {
5701
5993
  */
5702
5994
  deleteProfinetIO(cell: string, io: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
5703
5995
  /**
5704
- * Get deployed BUS Inputs/Outputs Service.
5996
+ * Get deployed BUS inputs/outputs service.
5705
5997
  * @summary Get Service
5706
5998
  * @param {string} cell Unique identifier addressing a cell in all API calls.
5707
5999
  * @param {*} [options] Override http request option.
@@ -5726,7 +6018,7 @@ export declare const BUSInputsOutputsApiFp: (configuration?: Configuration) => {
5726
6018
  */
5727
6019
  getBusIOValues(cell: string, ios?: Array<string>, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<IOValue>>>;
5728
6020
  /**
5729
- * Get description of PROFINET
6021
+ * Get description of NOVA as a PROFINET device.
5730
6022
  * @summary Get PROFINET Description
5731
6023
  * @param {string} cell Unique identifier addressing a cell in all API calls.
5732
6024
  * @param {*} [options] Override http request option.
@@ -5734,7 +6026,7 @@ export declare const BUSInputsOutputsApiFp: (configuration?: Configuration) => {
5734
6026
  */
5735
6027
  getProfinetDescription(cell: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ProfinetDescription>>;
5736
6028
  /**
5737
- * Get input/output configuration of the PROFINET device as file.
6029
+ * 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.
5738
6030
  * @summary PROFINET Inputs/Outputs to File
5739
6031
  * @param {string} cell Unique identifier addressing a cell in all API calls.
5740
6032
  * @param {number} [inputOffset]
@@ -5744,15 +6036,15 @@ export declare const BUSInputsOutputsApiFp: (configuration?: Configuration) => {
5744
6036
  */
5745
6037
  getProfinetIOsFromFile(cell: string, inputOffset?: number, outputOffset?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<string>>;
5746
6038
  /**
5747
- * List all BUS Input/Output descriptions.
6039
+ * 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.
5748
6040
  * @summary List Descriptions
5749
6041
  * @param {string} cell Unique identifier addressing a cell in all API calls.
5750
6042
  * @param {*} [options] Override http request option.
5751
6043
  * @throws {RequiredError}
5752
6044
  */
5753
- listBusIODescriptions(cell: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<IODescription>>>;
6045
+ listBusIODescriptions(cell: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<IODescription2>>>;
5754
6046
  /**
5755
- * List all PROFINET input and outputs.
6047
+ * 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.
5756
6048
  * @summary List PROFINET Input/Output Configuration
5757
6049
  * @param {string} cell Unique identifier addressing a cell in all API calls.
5758
6050
  * @param {*} [options] Override http request option.
@@ -5769,7 +6061,7 @@ export declare const BUSInputsOutputsApiFp: (configuration?: Configuration) => {
5769
6061
  */
5770
6062
  setBusIOValues(cell: string, iOValue: Array<IOValue>, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
5771
6063
  /**
5772
- * Sets inputs/outputs on the PROFINET device from file.
6064
+ * 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.
5773
6065
  * @summary Set PROFINET Inputs/Outputs from File
5774
6066
  * @param {string} cell Unique identifier addressing a cell in all API calls.
5775
6067
  * @param {ProfinetInputOutputConfig} profinetInputOutputConfig
@@ -5784,7 +6076,7 @@ export declare const BUSInputsOutputsApiFp: (configuration?: Configuration) => {
5784
6076
  */
5785
6077
  export declare const BUSInputsOutputsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
5786
6078
  /**
5787
- * Add a BUS Inputs/Outputs Service to the cell.
6079
+ * Add the BUS inputs/outputs service to the cell. Starts a containerized service that enables BUS connections via the specified ethernet port.
5788
6080
  * @summary Add Service
5789
6081
  * @param {string} cell Unique identifier addressing a cell in all API calls.
5790
6082
  * @param {BusIOType} busIOType
@@ -5794,7 +6086,7 @@ export declare const BUSInputsOutputsApiFactory: (configuration?: Configuration,
5794
6086
  */
5795
6087
  addBusIOService(cell: string, busIOType: BusIOType, completionTimeout?: number, options?: RawAxiosRequestConfig): AxiosPromise<void>;
5796
6088
  /**
5797
- * Adds an input/output to or updates an input/output on the PROFINET device.
6089
+ * 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).
5798
6090
  * @summary Add PROFINET Input/Output
5799
6091
  * @param {string} cell Unique identifier addressing a cell in all API calls.
5800
6092
  * @param {string} io Unique identifier to address an Input/Output in the cell.
@@ -5804,7 +6096,7 @@ export declare const BUSInputsOutputsApiFactory: (configuration?: Configuration,
5804
6096
  */
5805
6097
  addProfinetIO(cell: string, io: string, profinetIOData: ProfinetIOData, options?: RawAxiosRequestConfig): AxiosPromise<void>;
5806
6098
  /**
5807
- * Delete BUS Inputs/Outputs Service from the cell.
6099
+ * Remove the BUS inputs/outputs service from the cell.
5808
6100
  * @summary Clear Service
5809
6101
  * @param {string} cell Unique identifier addressing a cell in all API calls.
5810
6102
  * @param {number} [completionTimeout]
@@ -5813,7 +6105,7 @@ export declare const BUSInputsOutputsApiFactory: (configuration?: Configuration,
5813
6105
  */
5814
6106
  clearBusIOService(cell: string, completionTimeout?: number, options?: RawAxiosRequestConfig): AxiosPromise<void>;
5815
6107
  /**
5816
- * Removes the input/output from the PROFINET device.
6108
+ * Removes an input/output variable configuration from the PROFINET device, e.g. NOVA\'s PROFINET service.
5817
6109
  * @summary Remove PROFINET Input/Ouptut
5818
6110
  * @param {string} cell Unique identifier addressing a cell in all API calls.
5819
6111
  * @param {string} io Unique identifier to address an Input/Output in the cell.
@@ -5822,7 +6114,7 @@ export declare const BUSInputsOutputsApiFactory: (configuration?: Configuration,
5822
6114
  */
5823
6115
  deleteProfinetIO(cell: string, io: string, options?: RawAxiosRequestConfig): AxiosPromise<void>;
5824
6116
  /**
5825
- * Get deployed BUS Inputs/Outputs Service.
6117
+ * Get deployed BUS inputs/outputs service.
5826
6118
  * @summary Get Service
5827
6119
  * @param {string} cell Unique identifier addressing a cell in all API calls.
5828
6120
  * @param {*} [options] Override http request option.
@@ -5847,7 +6139,7 @@ export declare const BUSInputsOutputsApiFactory: (configuration?: Configuration,
5847
6139
  */
5848
6140
  getBusIOValues(cell: string, ios?: Array<string>, options?: RawAxiosRequestConfig): AxiosPromise<Array<IOValue>>;
5849
6141
  /**
5850
- * Get description of PROFINET
6142
+ * Get description of NOVA as a PROFINET device.
5851
6143
  * @summary Get PROFINET Description
5852
6144
  * @param {string} cell Unique identifier addressing a cell in all API calls.
5853
6145
  * @param {*} [options] Override http request option.
@@ -5855,7 +6147,7 @@ export declare const BUSInputsOutputsApiFactory: (configuration?: Configuration,
5855
6147
  */
5856
6148
  getProfinetDescription(cell: string, options?: RawAxiosRequestConfig): AxiosPromise<ProfinetDescription>;
5857
6149
  /**
5858
- * Get input/output configuration of the PROFINET device as file.
6150
+ * 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.
5859
6151
  * @summary PROFINET Inputs/Outputs to File
5860
6152
  * @param {string} cell Unique identifier addressing a cell in all API calls.
5861
6153
  * @param {number} [inputOffset]
@@ -5865,15 +6157,15 @@ export declare const BUSInputsOutputsApiFactory: (configuration?: Configuration,
5865
6157
  */
5866
6158
  getProfinetIOsFromFile(cell: string, inputOffset?: number, outputOffset?: number, options?: RawAxiosRequestConfig): AxiosPromise<string>;
5867
6159
  /**
5868
- * List all BUS Input/Output descriptions.
6160
+ * 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.
5869
6161
  * @summary List Descriptions
5870
6162
  * @param {string} cell Unique identifier addressing a cell in all API calls.
5871
6163
  * @param {*} [options] Override http request option.
5872
6164
  * @throws {RequiredError}
5873
6165
  */
5874
- listBusIODescriptions(cell: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<IODescription>>;
6166
+ listBusIODescriptions(cell: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<IODescription2>>;
5875
6167
  /**
5876
- * List all PROFINET input and outputs.
6168
+ * 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.
5877
6169
  * @summary List PROFINET Input/Output Configuration
5878
6170
  * @param {string} cell Unique identifier addressing a cell in all API calls.
5879
6171
  * @param {*} [options] Override http request option.
@@ -5890,7 +6182,7 @@ export declare const BUSInputsOutputsApiFactory: (configuration?: Configuration,
5890
6182
  */
5891
6183
  setBusIOValues(cell: string, iOValue: Array<IOValue>, options?: RawAxiosRequestConfig): AxiosPromise<void>;
5892
6184
  /**
5893
- * Sets inputs/outputs on the PROFINET device from file.
6185
+ * 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.
5894
6186
  * @summary Set PROFINET Inputs/Outputs from File
5895
6187
  * @param {string} cell Unique identifier addressing a cell in all API calls.
5896
6188
  * @param {ProfinetInputOutputConfig} profinetInputOutputConfig
@@ -5907,7 +6199,7 @@ export declare const BUSInputsOutputsApiFactory: (configuration?: Configuration,
5907
6199
  */
5908
6200
  export declare class BUSInputsOutputsApi extends BaseAPI {
5909
6201
  /**
5910
- * Add a BUS Inputs/Outputs Service to the cell.
6202
+ * Add the BUS inputs/outputs service to the cell. Starts a containerized service that enables BUS connections via the specified ethernet port.
5911
6203
  * @summary Add Service
5912
6204
  * @param {string} cell Unique identifier addressing a cell in all API calls.
5913
6205
  * @param {BusIOType} busIOType
@@ -5918,7 +6210,7 @@ export declare class BUSInputsOutputsApi extends BaseAPI {
5918
6210
  */
5919
6211
  addBusIOService(cell: string, busIOType: BusIOType, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
5920
6212
  /**
5921
- * Adds an input/output to or updates an input/output on the PROFINET device.
6213
+ * 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).
5922
6214
  * @summary Add PROFINET Input/Output
5923
6215
  * @param {string} cell Unique identifier addressing a cell in all API calls.
5924
6216
  * @param {string} io Unique identifier to address an Input/Output in the cell.
@@ -5929,7 +6221,7 @@ export declare class BUSInputsOutputsApi extends BaseAPI {
5929
6221
  */
5930
6222
  addProfinetIO(cell: string, io: string, profinetIOData: ProfinetIOData, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
5931
6223
  /**
5932
- * Delete BUS Inputs/Outputs Service from the cell.
6224
+ * Remove the BUS inputs/outputs service from the cell.
5933
6225
  * @summary Clear Service
5934
6226
  * @param {string} cell Unique identifier addressing a cell in all API calls.
5935
6227
  * @param {number} [completionTimeout]
@@ -5939,7 +6231,7 @@ export declare class BUSInputsOutputsApi extends BaseAPI {
5939
6231
  */
5940
6232
  clearBusIOService(cell: string, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
5941
6233
  /**
5942
- * Removes the input/output from the PROFINET device.
6234
+ * Removes an input/output variable configuration from the PROFINET device, e.g. NOVA\'s PROFINET service.
5943
6235
  * @summary Remove PROFINET Input/Ouptut
5944
6236
  * @param {string} cell Unique identifier addressing a cell in all API calls.
5945
6237
  * @param {string} io Unique identifier to address an Input/Output in the cell.
@@ -5949,16 +6241,14 @@ export declare class BUSInputsOutputsApi extends BaseAPI {
5949
6241
  */
5950
6242
  deleteProfinetIO(cell: string, io: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
5951
6243
  /**
5952
- * Get deployed BUS Inputs/Outputs Service.
6244
+ * Get deployed BUS inputs/outputs service.
5953
6245
  * @summary Get Service
5954
6246
  * @param {string} cell Unique identifier addressing a cell in all API calls.
5955
6247
  * @param {*} [options] Override http request option.
5956
6248
  * @throws {RequiredError}
5957
6249
  * @memberof BUSInputsOutputsApi
5958
6250
  */
5959
- getBusIOService(cell: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<{
5960
- bus_type: "profinet";
5961
- } & BusIOProfinet, any>>;
6251
+ getBusIOService(cell: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<BusIOType, any>>;
5962
6252
  /**
5963
6253
  * Get the current state of the BUS Inputs/Outputs service.
5964
6254
  * @summary State
@@ -5979,7 +6269,7 @@ export declare class BUSInputsOutputsApi extends BaseAPI {
5979
6269
  */
5980
6270
  getBusIOValues(cell: string, ios?: Array<string>, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<IOValue[], any>>;
5981
6271
  /**
5982
- * Get description of PROFINET
6272
+ * Get description of NOVA as a PROFINET device.
5983
6273
  * @summary Get PROFINET Description
5984
6274
  * @param {string} cell Unique identifier addressing a cell in all API calls.
5985
6275
  * @param {*} [options] Override http request option.
@@ -5988,7 +6278,7 @@ export declare class BUSInputsOutputsApi extends BaseAPI {
5988
6278
  */
5989
6279
  getProfinetDescription(cell: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ProfinetDescription, any>>;
5990
6280
  /**
5991
- * Get input/output configuration of the PROFINET device as file.
6281
+ * 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.
5992
6282
  * @summary PROFINET Inputs/Outputs to File
5993
6283
  * @param {string} cell Unique identifier addressing a cell in all API calls.
5994
6284
  * @param {number} [inputOffset]
@@ -5999,16 +6289,16 @@ export declare class BUSInputsOutputsApi extends BaseAPI {
5999
6289
  */
6000
6290
  getProfinetIOsFromFile(cell: string, inputOffset?: number, outputOffset?: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<string, any>>;
6001
6291
  /**
6002
- * List all BUS Input/Output descriptions.
6292
+ * 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.
6003
6293
  * @summary List Descriptions
6004
6294
  * @param {string} cell Unique identifier addressing a cell in all API calls.
6005
6295
  * @param {*} [options] Override http request option.
6006
6296
  * @throws {RequiredError}
6007
6297
  * @memberof BUSInputsOutputsApi
6008
6298
  */
6009
- listBusIODescriptions(cell: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<IODescription[], any>>;
6299
+ listBusIODescriptions(cell: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<IODescription2[], any>>;
6010
6300
  /**
6011
- * List all PROFINET input and outputs.
6301
+ * 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.
6012
6302
  * @summary List PROFINET Input/Output Configuration
6013
6303
  * @param {string} cell Unique identifier addressing a cell in all API calls.
6014
6304
  * @param {*} [options] Override http request option.
@@ -6027,7 +6317,7 @@ export declare class BUSInputsOutputsApi extends BaseAPI {
6027
6317
  */
6028
6318
  setBusIOValues(cell: string, iOValue: Array<IOValue>, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
6029
6319
  /**
6030
- * Sets inputs/outputs on the PROFINET device from file.
6320
+ * 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.
6031
6321
  * @summary Set PROFINET Inputs/Outputs from File
6032
6322
  * @param {string} cell Unique identifier addressing a cell in all API calls.
6033
6323
  * @param {ProfinetInputOutputConfig} profinetInputOutputConfig
@@ -7617,7 +7907,7 @@ export declare class MotionGroupApi extends BaseAPI {
7617
7907
  */
7618
7908
  export declare const MotionGroupModelsApiAxiosParamCreator: (configuration?: Configuration) => {
7619
7909
  /**
7620
- * 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.
7910
+ * 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.
7621
7911
  * @summary Get Collision Model
7622
7912
  * @param {string} cell Unique identifier addressing a cell in all API calls.
7623
7913
  * @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).
@@ -7640,7 +7930,7 @@ export declare const MotionGroupModelsApiAxiosParamCreator: (configuration?: Con
7640
7930
  */
7641
7931
  export declare const MotionGroupModelsApiFp: (configuration?: Configuration) => {
7642
7932
  /**
7643
- * 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.
7933
+ * 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.
7644
7934
  * @summary Get Collision Model
7645
7935
  * @param {string} cell Unique identifier addressing a cell in all API calls.
7646
7936
  * @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).
@@ -7665,7 +7955,7 @@ export declare const MotionGroupModelsApiFp: (configuration?: Configuration) =>
7665
7955
  */
7666
7956
  export declare const MotionGroupModelsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
7667
7957
  /**
7668
- * 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.
7958
+ * 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.
7669
7959
  * @summary Get Collision Model
7670
7960
  * @param {string} cell Unique identifier addressing a cell in all API calls.
7671
7961
  * @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).
@@ -7692,7 +7982,7 @@ export declare const MotionGroupModelsApiFactory: (configuration?: Configuration
7692
7982
  */
7693
7983
  export declare class MotionGroupModelsApi extends BaseAPI {
7694
7984
  /**
7695
- * 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.
7985
+ * 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.
7696
7986
  * @summary Get Collision Model
7697
7987
  * @param {string} cell Unique identifier addressing a cell in all API calls.
7698
7988
  * @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).
@@ -7713,6 +8003,180 @@ export declare class MotionGroupModelsApi extends BaseAPI {
7713
8003
  */
7714
8004
  getMotionGroupModels(cell: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<string[], any>>;
7715
8005
  }
8006
+ /**
8007
+ * ProgramApi - axios parameter creator
8008
+ * @export
8009
+ */
8010
+ export declare const ProgramApiAxiosParamCreator: (configuration?: Configuration) => {
8011
+ /**
8012
+ * Get details of a program.
8013
+ * @summary Get program
8014
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
8015
+ * @param {string} program
8016
+ * @param {*} [options] Override http request option.
8017
+ * @throws {RequiredError}
8018
+ */
8019
+ getProgram: (cell: string, program: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
8020
+ /**
8021
+ * List details of all existing programs.
8022
+ * @summary List programs
8023
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
8024
+ * @param {*} [options] Override http request option.
8025
+ * @throws {RequiredError}
8026
+ */
8027
+ listPrograms: (cell: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
8028
+ /**
8029
+ * This endpoint starts a new program execution. The program will be executed asynchronously.
8030
+ * @summary Start the program
8031
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
8032
+ * @param {string} program
8033
+ * @param {ProgramStartRequest} programStartRequest
8034
+ * @param {*} [options] Override http request option.
8035
+ * @throws {RequiredError}
8036
+ */
8037
+ startProgram: (cell: string, program: string, programStartRequest: ProgramStartRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
8038
+ /**
8039
+ * Stop a specific program run.
8040
+ * @summary Stop program run
8041
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
8042
+ * @param {string} program
8043
+ * @param {*} [options] Override http request option.
8044
+ * @throws {RequiredError}
8045
+ */
8046
+ stopProgram: (cell: string, program: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
8047
+ };
8048
+ /**
8049
+ * ProgramApi - functional programming interface
8050
+ * @export
8051
+ */
8052
+ export declare const ProgramApiFp: (configuration?: Configuration) => {
8053
+ /**
8054
+ * Get details of a program.
8055
+ * @summary Get program
8056
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
8057
+ * @param {string} program
8058
+ * @param {*} [options] Override http request option.
8059
+ * @throws {RequiredError}
8060
+ */
8061
+ getProgram(cell: string, program: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Program>>;
8062
+ /**
8063
+ * List details of all existing programs.
8064
+ * @summary List programs
8065
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
8066
+ * @param {*} [options] Override http request option.
8067
+ * @throws {RequiredError}
8068
+ */
8069
+ listPrograms(cell: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<Program>>>;
8070
+ /**
8071
+ * This endpoint starts a new program execution. The program will be executed asynchronously.
8072
+ * @summary Start the program
8073
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
8074
+ * @param {string} program
8075
+ * @param {ProgramStartRequest} programStartRequest
8076
+ * @param {*} [options] Override http request option.
8077
+ * @throws {RequiredError}
8078
+ */
8079
+ startProgram(cell: string, program: string, programStartRequest: ProgramStartRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ProgramRun>>;
8080
+ /**
8081
+ * Stop a specific program run.
8082
+ * @summary Stop program run
8083
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
8084
+ * @param {string} program
8085
+ * @param {*} [options] Override http request option.
8086
+ * @throws {RequiredError}
8087
+ */
8088
+ stopProgram(cell: string, program: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
8089
+ };
8090
+ /**
8091
+ * ProgramApi - factory interface
8092
+ * @export
8093
+ */
8094
+ export declare const ProgramApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
8095
+ /**
8096
+ * Get details of a program.
8097
+ * @summary Get program
8098
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
8099
+ * @param {string} program
8100
+ * @param {*} [options] Override http request option.
8101
+ * @throws {RequiredError}
8102
+ */
8103
+ getProgram(cell: string, program: string, options?: RawAxiosRequestConfig): AxiosPromise<Program>;
8104
+ /**
8105
+ * List details of all existing programs.
8106
+ * @summary List programs
8107
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
8108
+ * @param {*} [options] Override http request option.
8109
+ * @throws {RequiredError}
8110
+ */
8111
+ listPrograms(cell: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<Program>>;
8112
+ /**
8113
+ * This endpoint starts a new program execution. The program will be executed asynchronously.
8114
+ * @summary Start the program
8115
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
8116
+ * @param {string} program
8117
+ * @param {ProgramStartRequest} programStartRequest
8118
+ * @param {*} [options] Override http request option.
8119
+ * @throws {RequiredError}
8120
+ */
8121
+ startProgram(cell: string, program: string, programStartRequest: ProgramStartRequest, options?: RawAxiosRequestConfig): AxiosPromise<ProgramRun>;
8122
+ /**
8123
+ * Stop a specific program run.
8124
+ * @summary Stop program run
8125
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
8126
+ * @param {string} program
8127
+ * @param {*} [options] Override http request option.
8128
+ * @throws {RequiredError}
8129
+ */
8130
+ stopProgram(cell: string, program: string, options?: RawAxiosRequestConfig): AxiosPromise<void>;
8131
+ };
8132
+ /**
8133
+ * ProgramApi - object-oriented interface
8134
+ * @export
8135
+ * @class ProgramApi
8136
+ * @extends {BaseAPI}
8137
+ */
8138
+ export declare class ProgramApi extends BaseAPI {
8139
+ /**
8140
+ * Get details of a program.
8141
+ * @summary Get program
8142
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
8143
+ * @param {string} program
8144
+ * @param {*} [options] Override http request option.
8145
+ * @throws {RequiredError}
8146
+ * @memberof ProgramApi
8147
+ */
8148
+ getProgram(cell: string, program: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Program, any>>;
8149
+ /**
8150
+ * List details of all existing programs.
8151
+ * @summary List programs
8152
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
8153
+ * @param {*} [options] Override http request option.
8154
+ * @throws {RequiredError}
8155
+ * @memberof ProgramApi
8156
+ */
8157
+ listPrograms(cell: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Program[], any>>;
8158
+ /**
8159
+ * This endpoint starts a new program execution. The program will be executed asynchronously.
8160
+ * @summary Start the program
8161
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
8162
+ * @param {string} program
8163
+ * @param {ProgramStartRequest} programStartRequest
8164
+ * @param {*} [options] Override http request option.
8165
+ * @throws {RequiredError}
8166
+ * @memberof ProgramApi
8167
+ */
8168
+ startProgram(cell: string, program: string, programStartRequest: ProgramStartRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ProgramRun, any>>;
8169
+ /**
8170
+ * Stop a specific program run.
8171
+ * @summary Stop program run
8172
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
8173
+ * @param {string} program
8174
+ * @param {*} [options] Override http request option.
8175
+ * @throws {RequiredError}
8176
+ * @memberof ProgramApi
8177
+ */
8178
+ stopProgram(cell: string, program: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
8179
+ }
7716
8180
  /**
7717
8181
  * StoreCollisionComponentsApi - axios parameter creator
7718
8182
  * @export
@@ -7781,7 +8245,7 @@ export declare const StoreCollisionComponentsApiAxiosParamCreator: (configuratio
7781
8245
  */
7782
8246
  listCollisionLinkChains: (cell: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
7783
8247
  /**
7784
- * Returns a list of colliders in a scene. This excludes colliders that are part of a motion group.
8248
+ * Returns all stored colliders.
7785
8249
  * @summary List Colliders
7786
8250
  * @param {string} cell Unique identifier addressing a cell in all API calls.
7787
8251
  * @param {*} [options] Override http request option.
@@ -7907,7 +8371,7 @@ export declare const StoreCollisionComponentsApiFp: (configuration?: Configurati
7907
8371
  }>;
7908
8372
  }>>;
7909
8373
  /**
7910
- * Returns a list of colliders in a scene. This excludes colliders that are part of a motion group.
8374
+ * Returns all stored colliders.
7911
8375
  * @summary List Colliders
7912
8376
  * @param {string} cell Unique identifier addressing a cell in all API calls.
7913
8377
  * @param {*} [options] Override http request option.
@@ -8043,7 +8507,7 @@ export declare const StoreCollisionComponentsApiFactory: (configuration?: Config
8043
8507
  }>;
8044
8508
  }>;
8045
8509
  /**
8046
- * Returns a list of colliders in a scene. This excludes colliders that are part of a motion group.
8510
+ * Returns all stored colliders.
8047
8511
  * @summary List Colliders
8048
8512
  * @param {string} cell Unique identifier addressing a cell in all API calls.
8049
8513
  * @param {*} [options] Override http request option.
@@ -8188,7 +8652,7 @@ export declare class StoreCollisionComponentsApi extends BaseAPI {
8188
8652
  }[];
8189
8653
  }, any>>;
8190
8654
  /**
8191
- * Returns a list of colliders in a scene. This excludes colliders that are part of a motion group.
8655
+ * Returns all stored colliders.
8192
8656
  * @summary List Colliders
8193
8657
  * @param {string} cell Unique identifier addressing a cell in all API calls.
8194
8658
  * @param {*} [options] Override http request option.