@wandelbots/nova-api 25.8.0-dev.9 → 25.8.0-dev.91

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/v2/api.ts CHANGED
@@ -106,7 +106,7 @@ export interface AddTrajectoryError {
106
106
  */
107
107
  'message'?: string;
108
108
  /**
109
- * The location of the error in the trajectory.
109
+ * Location on trajectory where the execution will start. The default value is the start (forward movement) or end (backward movement) of the trajectory. If you want to start your movement from an arbitrary location, e.g. in combination with [streamMoveToTrajectoryViaJointPTP](streamMoveToTrajectoryViaJointPTP), set the location by respecting the following format: - The location is a scalar value that defines a position along a path, typically ranging from 0 to `n`, where `n` denotes the number of motion commands - Each integer value of the location corresponds to a specific motion command, while non-integer values interpolate positions within the segments. - The location is calculated from the joint path
110
110
  * @type {number}
111
111
  * @memberof AddTrajectoryError
112
112
  */
@@ -373,7 +373,7 @@ export const BoxBoxTypeEnum = {
373
373
  export type BoxBoxTypeEnum = typeof BoxBoxTypeEnum[keyof typeof BoxBoxTypeEnum];
374
374
 
375
375
  /**
376
- * PROFINET BUS Inputs/Outputs Service configuration.
376
+ * PROFINET BUS inputs/outputs service configuration.
377
377
  * @export
378
378
  * @interface BusIOProfinet
379
379
  */
@@ -385,19 +385,19 @@ export interface BusIOProfinet {
385
385
  */
386
386
  'bus_type'?: BusIOProfinetBusTypeEnum;
387
387
  /**
388
- * Path to the configuration file.
389
- * @type {string}
388
+ * Used to enable IP communication through the same physical ethernet interface while PROFINET driver is active.
389
+ * @type {BusIOProfinetNetwork}
390
390
  * @memberof BusIOProfinet
391
391
  */
392
- 'config_file_content'?: string;
392
+ 'network_config'?: BusIOProfinetNetwork;
393
393
  /**
394
- *
395
- * @type {BusIOProfinetNetwork}
394
+ * IP address of the PLC to establish PROFINET communication with. The IP address is used to configure the host machine\'s firewall. The firewall configuration is applied while the BUS input/output service is active. Without proper firewall configuration, PROFINET device discovery, configuration exchanges, and real-time cyclic data communication will fail.
395
+ * @type {string}
396
396
  * @memberof BusIOProfinet
397
397
  */
398
- 'network_config'?: BusIOProfinetNetwork;
398
+ 'plc_ip': string;
399
399
  /**
400
- * MAC address for the PROFINET port, should be get from another NOVA API endpoind?
400
+ * MAC address of the physical ethernet interface that you want to use for PROFINET communication.
401
401
  * @type {string}
402
402
  * @memberof BusIOProfinet
403
403
  */
@@ -417,7 +417,7 @@ export const BusIOProfinetBusTypeEnum = {
417
417
  export type BusIOProfinetBusTypeEnum = typeof BusIOProfinetBusTypeEnum[keyof typeof BusIOProfinetBusTypeEnum];
418
418
 
419
419
  /**
420
- * Default route configuration for the PROFINET service. Will be removed before release by automatic default route configuration, if possible.
420
+ * Current default route configuration of your NOVA instance. The default route is a setting that tells data where to go if there isn’t a specific path already known for its destination. Usually this will be the path to your router, enabling accessing the internet. On Linux, use `ip route show` to view your default routes and match the output `default via <gateway> dev <interface> ...` to get your gateway and interface.
421
421
  * @export
422
422
  * @interface BusIOProfinetDefaultRoute
423
423
  */
@@ -436,25 +436,25 @@ export interface BusIOProfinetDefaultRoute {
436
436
  'interface': string;
437
437
  }
438
438
  /**
439
- * Network configuration for the PROFINET device
439
+ * Network configuration or IPv4 record of the virtual ethernet interface (pnio1) created by the PROFINET driver. The IPv4 record is used in combination with the Name of Station (NoS) to identify your device in the PROFINET network. The `ip_config` will be used as IPv4 record if no REMA XML file is already present on your machine and no `rema_xml_content` is provided.
440
440
  * @export
441
441
  * @interface BusIOProfinetIpConfig
442
442
  */
443
443
  export interface BusIOProfinetIpConfig {
444
444
  /**
445
- * IP address for the PROFINET device
445
+ * IP address for the device\'s virtual ethernet interface (pnio1).
446
446
  * @type {string}
447
447
  * @memberof BusIOProfinetIpConfig
448
448
  */
449
449
  'ip': string;
450
450
  /**
451
- * Network mask for the PROFINET device.
451
+ * Network mask for the device\'s virtual ethernet interface (pnio1).
452
452
  * @type {string}
453
453
  * @memberof BusIOProfinetIpConfig
454
454
  */
455
455
  'netmask': string;
456
456
  /**
457
- * Gateway for the PROFINET device
457
+ * Gateway for connections to other devices outside of the virtual ethernet interface\'s subnet.
458
458
  * @type {string}
459
459
  * @memberof BusIOProfinetIpConfig
460
460
  */
@@ -467,7 +467,7 @@ export interface BusIOProfinetIpConfig {
467
467
  */
468
468
  export interface BusIOProfinetNetwork {
469
469
  /**
470
- * Name of the PROFINET device.
470
+ * Name of Station (NoS) of the PROFINET device. The NoS is used in combination with IPv4 record to identify your device in the PROFINET network. The `device_name` will be used as NoS if no REMA XML file is already present on your machine and no `rema_xml_content` is provided.
471
471
  * @type {string}
472
472
  * @memberof BusIOProfinetNetwork
473
473
  */
@@ -479,14 +479,14 @@ export interface BusIOProfinetNetwork {
479
479
  */
480
480
  'ip_config'?: BusIOProfinetIpConfig;
481
481
  /**
482
- * Content of the PROFINET REMA XML file.
482
+ * Content of the PROFINET REMA XML file. Is used when PROFINET service is added for the first time to create the REMA XML file that holds data to be kept for the next session. Stores information like IP address, Name of Station (NoS) and hardware configuration. If you use a PROFINET controller to assign an IP address to the PROFINET device, this information will be written to the REMA XML file. Refer to the PDF version of the \"PN Driver I/O Base programming interface\" documentation for more information and an example REMA file.
483
483
  * @type {string}
484
484
  * @memberof BusIOProfinetNetwork
485
485
  */
486
486
  'rema_xml_content'?: string;
487
487
  }
488
488
  /**
489
- * Virtual PROFINET BUS Inputs/Outputs Service configuration.
489
+ * Virtual PROFINET BUS inputs/outputs service configuration.
490
490
  * @export
491
491
  * @interface BusIOProfinetVirtual
492
492
  */
@@ -500,7 +500,7 @@ export interface BusIOProfinetVirtual {
500
500
  }
501
501
 
502
502
  export const BusIOProfinetVirtualBusTypeEnum = {
503
- VirtualProfinet: 'virtual_profinet'
503
+ ProfinetVirtual: 'profinet_virtual'
504
504
  } as const;
505
505
 
506
506
  export type BusIOProfinetVirtualBusTypeEnum = typeof BusIOProfinetVirtualBusTypeEnum[keyof typeof BusIOProfinetVirtualBusTypeEnum];
@@ -524,7 +524,7 @@ export interface BusIOsState {
524
524
  */
525
525
  'state': BusIOsStateEnum;
526
526
  /**
527
- * A message providing additional information on the input/output, e.g. BUS service status, encountered errors. May be empty if no additional information is available.
527
+ * A message providing additional information on the input/output service, e.g. BUS service status, encountered errors. May be empty if no additional information is available.
528
528
  * @type {string}
529
529
  * @memberof BusIOsState
530
530
  */
@@ -1782,9 +1782,22 @@ export interface GetTrajectoryResponse {
1782
1782
  export interface HTTPValidationError {
1783
1783
  /**
1784
1784
  *
1785
- * @type {Array<ValidationError>}
1785
+ * @type {Array<ValidationError2>}
1786
1786
  * @memberof HTTPValidationError
1787
1787
  */
1788
+ 'detail'?: Array<ValidationError2>;
1789
+ }
1790
+ /**
1791
+ *
1792
+ * @export
1793
+ * @interface HTTPValidationError2
1794
+ */
1795
+ export interface HTTPValidationError2 {
1796
+ /**
1797
+ *
1798
+ * @type {Array<ValidationError>}
1799
+ * @memberof HTTPValidationError2
1800
+ */
1788
1801
  'detail'?: Array<ValidationError>;
1789
1802
  }
1790
1803
  /**
@@ -1876,6 +1889,57 @@ export interface IODescription {
1876
1889
  }
1877
1890
 
1878
1891
 
1892
+ /**
1893
+ *
1894
+ * @export
1895
+ * @interface IODescription2
1896
+ */
1897
+ export interface IODescription2 {
1898
+ /**
1899
+ * Unique identifier of the input/output.
1900
+ * @type {string}
1901
+ * @memberof IODescription2
1902
+ */
1903
+ 'io': string;
1904
+ /**
1905
+ * Descriptive name of the input/output. Customize it using the respective BUS service, e.g. [addProfinetIO](addProfinetIO) for PROFINET service.
1906
+ * @type {string}
1907
+ * @memberof IODescription2
1908
+ */
1909
+ 'name': string;
1910
+ /**
1911
+ *
1912
+ * @type {IODirection}
1913
+ * @memberof IODescription2
1914
+ */
1915
+ 'direction': IODirection;
1916
+ /**
1917
+ *
1918
+ * @type {IOValueType}
1919
+ * @memberof IODescription2
1920
+ */
1921
+ 'value_type': IOValueType;
1922
+ /**
1923
+ *
1924
+ * @type {UnitType}
1925
+ * @memberof IODescription2
1926
+ */
1927
+ 'unit'?: UnitType;
1928
+ /**
1929
+ *
1930
+ * @type {IODescriptionMin}
1931
+ * @memberof IODescription2
1932
+ */
1933
+ 'min'?: IODescriptionMin;
1934
+ /**
1935
+ *
1936
+ * @type {IODescriptionMin}
1937
+ * @memberof IODescription2
1938
+ */
1939
+ 'max'?: IODescriptionMin;
1940
+ }
1941
+
1942
+
1879
1943
  /**
1880
1944
  * @type IODescriptionMin
1881
1945
  * @export
@@ -1941,7 +2005,7 @@ export interface IOIntegerValue {
1941
2005
  */
1942
2006
  'io': string;
1943
2007
  /**
1944
- * Value of an input/output with integer representation. > The integral value is transmitted as a string to avoid precision loss during conversion to JSON. > We recommend to use int64 in your implementation. If you want to interact with int64 in numbers, > JS bigint libraries can help you to parse the string into an integral value.
2008
+ * Value of an input/output with integer representation. > The integral value is transmitted as a string to avoid precision loss during conversion to JSON. > Recommended: Use int64 in your implementation. If you want to interact with int64 in numbers, > JS bigint libraries can help you to parse the string into an integral value.
1945
2009
  * @type {string}
1946
2010
  * @memberof IOIntegerValue
1947
2011
  */
@@ -1960,6 +2024,20 @@ export const IOIntegerValueValueTypeEnum = {
1960
2024
 
1961
2025
  export type IOIntegerValueValueTypeEnum = typeof IOIntegerValueValueTypeEnum[keyof typeof IOIntegerValueValueTypeEnum];
1962
2026
 
2027
+ /**
2028
+ * States the source of the input/output signal.
2029
+ * @export
2030
+ * @enum {string}
2031
+ */
2032
+
2033
+ export const IOOrigin = {
2034
+ Controller: 'CONTROLLER',
2035
+ BusIo: 'BUS_IO'
2036
+ } as const;
2037
+
2038
+ export type IOOrigin = typeof IOOrigin[keyof typeof IOOrigin];
2039
+
2040
+
1963
2041
  /**
1964
2042
  * @type IOValue
1965
2043
  * @export
@@ -2068,24 +2146,12 @@ export interface InitializeJoggingRequest {
2068
2146
  * @memberof InitializeJoggingRequest
2069
2147
  */
2070
2148
  'tcp'?: string;
2071
- /**
2072
- * Update rate for the response message in milliseconds (ms). Recommendation: As Wandelbots NOVA updates states in the controller\'s step rate, use either the controller\'s step rate or a multiple of it. Wandelbots NOVA will not interpolate the state but round it to the nearest step rate below the configured response rate. Use [getOptimizerConfiguration](getOptimizerConfiguration) to get the controller\'s step rate. Minimal response rate is the step rate of the controller.
2073
- * @type {number}
2074
- * @memberof InitializeJoggingRequest
2075
- */
2076
- 'response_rate'?: number;
2077
2149
  /**
2078
2150
  * Unique identifier addressing a coordinate system to which the responses are transformed. If not set, world coordinate system is used.
2079
2151
  * @type {string}
2080
2152
  * @memberof InitializeJoggingRequest
2081
2153
  */
2082
2154
  'response_coordinate_system'?: string;
2083
- /**
2084
- * Defines an input/output that is listened to during the movement. Execution pauses if the defined comparator evaluates to `true`.
2085
- * @type {string}
2086
- * @memberof InitializeJoggingRequest
2087
- */
2088
- 'pause_on_io'?: string;
2089
2155
  }
2090
2156
 
2091
2157
  export const InitializeJoggingRequestMessageTypeEnum = {
@@ -2144,12 +2210,6 @@ export interface InitializeMovementRequest {
2144
2210
  * @memberof InitializeMovementRequest
2145
2211
  */
2146
2212
  'initial_location'?: number;
2147
- /**
2148
- * Update rate for the response message in milliseconds (ms). Default is 200 ms. Recommendation: As Wandelbots NOVA updates states in the controller\'s step rate, use either the controller\'s step rate or a multiple of it. Wandelbots NOVA will not interpolate the state but rather round it to the nearest step rate below the configured response rate. Minimal response rate is the step rate of controller.
2149
- * @type {number}
2150
- * @memberof InitializeMovementRequest
2151
- */
2152
- 'response_rate'?: number;
2153
2213
  /**
2154
2214
  * Unique identifier addressing a coordinate system to which the responses are transformed. If not set, world coordinate system is used.
2155
2215
  * @type {string}
@@ -2204,7 +2264,7 @@ export const InitializeMovementResponseKindEnum = {
2204
2264
  export type InitializeMovementResponseKindEnum = typeof InitializeMovementResponseKindEnum[keyof typeof InitializeMovementResponseKindEnum];
2205
2265
 
2206
2266
  /**
2207
- * Value of an input/output with integer representation. > The integral value is transmitted as a string to avoid precision loss during conversion to JSON. > We recommend to use int64 in your implementation. If you want to interact with int64 in numbers, > JS bigint libraries can help you to parse the string into an integral value.
2267
+ * Value of an input/output with integer representation. > The integral value is transmitted as a string to avoid precision loss during conversion to JSON. > Recommended: Use int64 in your implementation. If you want to interact with int64 in numbers, > JS bigint libraries can help you to parse the string into an integral value.
2208
2268
  * @export
2209
2269
  * @interface IntegerValue
2210
2270
  */
@@ -2581,7 +2641,7 @@ export interface JointTrajectory {
2581
2641
  */
2582
2642
  'times': Array<number>;
2583
2643
  /**
2584
- * Location for each sample, scalar value defining a position along a path. Typical range: 0 to `n`, `n` denoting the number of motion commands. Each integer value of the location corresponds to a specific motion command. If provided, the number of samples must match the number of timestamps provided in the times field.
2644
+ *
2585
2645
  * @type {Array<number>}
2586
2646
  * @memberof JointTrajectory
2587
2647
  */
@@ -2669,6 +2729,12 @@ export interface KukaController {
2669
2729
  * @memberof KukaController
2670
2730
  */
2671
2731
  'rsi_server': KukaControllerRsiServer;
2732
+ /**
2733
+ * If true, uses slower cycle time of 12ms instead of 4ms.
2734
+ * @type {boolean}
2735
+ * @memberof KukaController
2736
+ */
2737
+ 'slow_cycle_rate'?: boolean;
2672
2738
  }
2673
2739
 
2674
2740
  export const KukaControllerKindEnum = {
@@ -2801,25 +2867,6 @@ export const LicenseStatusEnum = {
2801
2867
  export type LicenseStatusEnum = typeof LicenseStatusEnum[keyof typeof LicenseStatusEnum];
2802
2868
 
2803
2869
 
2804
- /**
2805
- *
2806
- * @export
2807
- * @interface LimitConfig
2808
- */
2809
- export interface LimitConfig {
2810
- /**
2811
- *
2812
- * @type {LimitSet}
2813
- * @memberof LimitConfig
2814
- */
2815
- 'physical_limits'?: LimitSet;
2816
- /**
2817
- *
2818
- * @type {OperationLimits}
2819
- * @memberof LimitConfig
2820
- */
2821
- 'operation_limits'?: OperationLimits;
2822
- }
2823
2870
  /**
2824
2871
  * The upper_limit must be greater then the lower_limit.
2825
2872
  * @export
@@ -2869,6 +2916,12 @@ export interface LimitSet {
2869
2916
  * @memberof LimitSet
2870
2917
  */
2871
2918
  'flange'?: CartesianLimits;
2919
+ /**
2920
+ *
2921
+ * @type {JointLimits}
2922
+ * @memberof LimitSet
2923
+ */
2924
+ 'coupled_shoulder_elbow_joint'?: JointLimits;
2872
2925
  }
2873
2926
  /**
2874
2927
  * If a limit is not set, the default value will be used.
@@ -2944,13 +2997,13 @@ export type Manufacturer = typeof Manufacturer[keyof typeof Manufacturer];
2944
2997
 
2945
2998
 
2946
2999
  /**
2947
- * Midpoint insertion algorithm configuration for collision-free path planning. This algorithm iteratively inserts midpoints between the start and target joint position to find collision-free paths.
3000
+ *
2948
3001
  * @export
2949
3002
  * @interface MidpointInsertionAlgorithm
2950
3003
  */
2951
3004
  export interface MidpointInsertionAlgorithm {
2952
3005
  /**
2953
- * Algorithm discriminator.
3006
+ * Algorithm discriminator. Midpoint insertion algorithm configuration for collision-free path planning. This algorithm adds a single midpoint between the start and target joint position to find collision-free paths.
2954
3007
  * @type {string}
2955
3008
  * @memberof MidpointInsertionAlgorithm
2956
3009
  */
@@ -3043,13 +3096,13 @@ export interface MotionGroupDescription {
3043
3096
  * @type {Pose}
3044
3097
  * @memberof MotionGroupDescription
3045
3098
  */
3046
- 'mounting': Pose;
3099
+ 'mounting'?: Pose;
3047
3100
  /**
3048
3101
  * Maps a TCP name to its offset relative to the flange coordinate system. Key must be a TCP identifier. Values are TcpOffsets.
3049
3102
  * @type {{ [key: string]: TcpOffset; }}
3050
3103
  * @memberof MotionGroupDescription
3051
3104
  */
3052
- 'tcps': { [key: string]: TcpOffset; };
3105
+ 'tcps'?: { [key: string]: TcpOffset; };
3053
3106
  /**
3054
3107
  * A collection of identifiable colliders.
3055
3108
  * @type {{ [key: string]: Collider; }}
@@ -3070,10 +3123,10 @@ export interface MotionGroupDescription {
3070
3123
  'safety_tool_colliders'?: { [key: string]: { [key: string]: Collider; }; };
3071
3124
  /**
3072
3125
  *
3073
- * @type {LimitConfig}
3126
+ * @type {OperationLimits}
3074
3127
  * @memberof MotionGroupDescription
3075
3128
  */
3076
- 'global_limits': LimitConfig;
3129
+ 'operation_limits': OperationLimits;
3077
3130
  /**
3078
3131
  * Maps a payload name to its configuration. Key must be a payload identifier. Values are payload objects.
3079
3132
  * @type {{ [key: string]: Payload; }}
@@ -3726,6 +3779,12 @@ export interface PauseOnIO {
3726
3779
  * @memberof PauseOnIO
3727
3780
  */
3728
3781
  'comparator': Comparator;
3782
+ /**
3783
+ *
3784
+ * @type {IOOrigin}
3785
+ * @memberof PauseOnIO
3786
+ */
3787
+ 'io_origin': IOOrigin;
3729
3788
  }
3730
3789
 
3731
3790
 
@@ -3849,11 +3908,11 @@ export interface PlanTrajectoryFailedResponse {
3849
3908
  */
3850
3909
  'error_feedback': PlanTrajectoryFailedResponseErrorFeedback;
3851
3910
  /**
3852
- *
3911
+ * Location on trajectory where the execution will start. The default value is the start (forward movement) or end (backward movement) of the trajectory. If you want to start your movement from an arbitrary location, e.g. in combination with [streamMoveToTrajectoryViaJointPTP](streamMoveToTrajectoryViaJointPTP), set the location by respecting the following format: - The location is a scalar value that defines a position along a path, typically ranging from 0 to `n`, where `n` denotes the number of motion commands - Each integer value of the location corresponds to a specific motion command, while non-integer values interpolate positions within the segments. - The location is calculated from the joint path
3853
3912
  * @type {number}
3854
3913
  * @memberof PlanTrajectoryFailedResponse
3855
3914
  */
3856
- 'error_location_on_trajectory'?: number;
3915
+ 'error_location_on_trajectory': number;
3857
3916
  /**
3858
3917
  * The joint trajectory from the start joint position to the error.
3859
3918
  * @type {JointTrajectory}
@@ -4071,17 +4130,17 @@ export interface ProfinetDescription {
4071
4130
  */
4072
4131
  'slots'?: Array<ProfinetSlotDescription>;
4073
4132
  /**
4074
- * Name of the PROFINET device
4133
+ * Name of Station (NoS) of the PROFINET device. The NoS is used in combination with IPv4 record to identify your device in the PROFINET network. The `device_name` will be used as NoS if no REMA XML file is already present on your NOVA instance and no `rema_xml_content` is provided.
4075
4134
  * @type {string}
4076
4135
  * @memberof ProfinetDescription
4077
4136
  */
4078
4137
  'device_name'?: string;
4079
4138
  /**
4080
- * IP address for the PROFINET device
4081
- * @type {string}
4139
+ *
4140
+ * @type {BusIOProfinetIpConfig}
4082
4141
  * @memberof ProfinetDescription
4083
4142
  */
4084
- 'ip'?: string;
4143
+ 'ip_config'?: BusIOProfinetIpConfig;
4085
4144
  }
4086
4145
  /**
4087
4146
  *
@@ -4090,7 +4149,7 @@ export interface ProfinetDescription {
4090
4149
  */
4091
4150
  export interface ProfinetIO {
4092
4151
  /**
4093
- * The name of the input/output value. This is a human-readable identifier for the value. It can be used to distinguish between different inputs/outputs in the system.
4152
+ * The name of the input/output variable. This is a human-readable identifier for the value. It distinguishes between different inputs/outputs variables in the system. The variables may be used to set bits or bytes at their pointed to address via [setBusIOValues](setBusIOValues).
4094
4153
  * @type {string}
4095
4154
  * @memberof ProfinetIO
4096
4155
  */
@@ -4102,25 +4161,25 @@ export interface ProfinetIO {
4102
4161
  */
4103
4162
  'type': ProfinetIOTypeEnum;
4104
4163
  /**
4105
- * The direction of the input/output value, indicating whether it is an input or output for the device.
4164
+ * The direction of the input/output variable, indicating whether it is an input or output for the PROFINET device, e.g. NOVA\'s PROFINET service.
4106
4165
  * @type {ProfinetIODirection}
4107
4166
  * @memberof ProfinetIO
4108
4167
  */
4109
4168
  'direction': ProfinetIODirection;
4110
4169
  /**
4111
- * The byte address of the input/output value in the PROFINET device. The byte address is used to locate the specific input/output within the device\'s memory or data structure.
4170
+ * The byte address of the input/output variable in the PROFINET device, e.g. NOVA\'s PROFINET service. The byte address is used to locate the specific input/output variable within the device\'s memory or data structure.
4112
4171
  * @type {number}
4113
4172
  * @memberof ProfinetIO
4114
4173
  */
4115
4174
  'byte_address': number;
4116
4175
  /**
4117
- * The bit address of the input/output value within the byte or word address. The bit address is used to specify the exact bit within the byte or word that corresponds to the input/output value.
4176
+ * The bit address of the input/output variable within the byte or word address. The bit address is used to specify the exact bit within the byte or word that corresponds to the input/output variable.
4118
4177
  * @type {number}
4119
4178
  * @memberof ProfinetIO
4120
4179
  */
4121
4180
  'bit_address'?: number;
4122
4181
  /**
4123
- * The unique identifier for the input/output value. This identifier is used to reference the specific input/output in the NOVA system.
4182
+ * The unique identifier for the input/output value. This identifier is used to reference the specific input/output variable in the PROFINET device, e.g. NOVA\'s PROFINET service.
4124
4183
  * @type {string}
4125
4184
  * @memberof ProfinetIO
4126
4185
  */
@@ -4135,7 +4194,7 @@ export interface ProfinetIO {
4135
4194
  */
4136
4195
  export interface ProfinetIOData {
4137
4196
  /**
4138
- * The name of the input/output value. This is a human-readable identifier for the value. It can be used to distinguish between different inputs/outputs in the system.
4197
+ * The name of the input/output variable. This is a human-readable identifier for the value. It distinguishes between different inputs/outputs variables in the system. The variables may be used to set bits or bytes at their pointed to address via [setBusIOValues](setBusIOValues).
4139
4198
  * @type {string}
4140
4199
  * @memberof ProfinetIOData
4141
4200
  */
@@ -4147,19 +4206,19 @@ export interface ProfinetIOData {
4147
4206
  */
4148
4207
  'type': ProfinetIOTypeEnum;
4149
4208
  /**
4150
- * The direction of the input/output value, indicating whether it is an input or output for the device.
4209
+ * The direction of the input/output variable, indicating whether it is an input or output for the PROFINET device, e.g. NOVA\'s PROFINET service.
4151
4210
  * @type {ProfinetIODirection}
4152
4211
  * @memberof ProfinetIOData
4153
4212
  */
4154
4213
  'direction': ProfinetIODirection;
4155
4214
  /**
4156
- * The byte address of the input/output value in the PROFINET device. The byte address is used to locate the specific input/output within the device\'s memory or data structure.
4215
+ * The byte address of the input/output variable in the PROFINET device, e.g. NOVA\'s PROFINET service. The byte address is used to locate the specific input/output variable within the device\'s memory or data structure.
4157
4216
  * @type {number}
4158
4217
  * @memberof ProfinetIOData
4159
4218
  */
4160
4219
  'byte_address': number;
4161
4220
  /**
4162
- * The bit address of the input/output value within the byte or word address. The bit address is used to specify the exact bit within the byte or word that corresponds to the input/output value.
4221
+ * The bit address of the input/output variable within the byte or word address. The bit address is used to specify the exact bit within the byte or word that corresponds to the input/output variable.
4163
4222
  * @type {number}
4164
4223
  * @memberof ProfinetIOData
4165
4224
  */
@@ -4168,7 +4227,7 @@ export interface ProfinetIOData {
4168
4227
 
4169
4228
 
4170
4229
  /**
4171
- * Identifies the input/output type.
4230
+ * The direction of the input/output variable, indicating whether it is an input or output for the PROFINET device, e.g. NOVA\'s PROFINET service.
4172
4231
  * @export
4173
4232
  * @enum {string}
4174
4233
  */
@@ -4183,7 +4242,7 @@ export type ProfinetIODirection = typeof ProfinetIODirection[keyof typeof Profin
4183
4242
 
4184
4243
 
4185
4244
  /**
4186
- * Value type of the PROFINET input/output.
4245
+ * Value type of the PROFINET input/output variable. Is used to interpret the corresponding bits correctly.
4187
4246
  * @export
4188
4247
  * @enum {string}
4189
4248
  */
@@ -4211,38 +4270,38 @@ export type ProfinetIOTypeEnum = typeof ProfinetIOTypeEnum[keyof typeof Profinet
4211
4270
  */
4212
4271
  export interface ProfinetInputOutputConfig {
4213
4272
  /**
4214
- * Content of the input output configuration file.
4273
+ * Content of the input/output variable configuration XML file. The XML File has to be embedded as a string by escaping quotes, line breaks and so forth.
4215
4274
  * @type {string}
4216
4275
  * @memberof ProfinetInputOutputConfig
4217
4276
  */
4218
4277
  'config': string;
4219
4278
  /**
4220
- * Offset in bytes for the input data.
4279
+ * Offset in bytes for the address of the input (perspective of the controller) variables. The offset will be subtracted from to the byte addresses of the sent XML content.
4221
4280
  * @type {number}
4222
4281
  * @memberof ProfinetInputOutputConfig
4223
4282
  */
4224
4283
  'input_offset': number;
4225
4284
  /**
4226
- * Offset in bytes for the output data.
4285
+ * Offset in bytes for the address of the output (perspective of the controller) variables. The offset will be subtracted from to the byte addresses of the sent XML content.
4227
4286
  * @type {number}
4228
4287
  * @memberof ProfinetInputOutputConfig
4229
4288
  */
4230
4289
  'output_offset': number;
4231
4290
  }
4232
4291
  /**
4233
- *
4292
+ * An array of PROFINET slots. PROFINET models each device’s input/output hardware as a hierarchy of slots (modules) and subslots (submodules). A slot can represent a physical or virtual input/output card and each subslot one of its individual channels or functions. Every slot and subslot has unique identifiers that the controller uses to map cyclic input/output data and parameter records to its process image. This slot/subslot separation enables e.g. addressing each input/output stream when establishing input/output application relations (I/O-AR).
4234
4293
  * @export
4235
4294
  * @interface ProfinetSlotDescription
4236
4295
  */
4237
4296
  export interface ProfinetSlotDescription {
4238
4297
  /**
4239
- * The number of the PROFINET slot.
4298
+ * The number/index of the PROFINET slot. Per default, slot 0 is reserved for the device access point (DAP). Slots that are part of the cyclic input/output data exchange start at number 1.
4240
4299
  * @type {number}
4241
4300
  * @memberof ProfinetSlotDescription
4242
4301
  */
4243
4302
  'number': number;
4244
4303
  /**
4245
- * The API number of the PROFINET input, used to identify the specific API for the input.
4304
+ * The application process identifier (API) number of the PROFINET input. The API identifies the application relation (AR) that is using the slot.
4246
4305
  * @type {number}
4247
4306
  * @memberof ProfinetSlotDescription
4248
4307
  */
@@ -4261,32 +4320,180 @@ export interface ProfinetSlotDescription {
4261
4320
  */
4262
4321
  export interface ProfinetSubSlotDescription {
4263
4322
  /**
4264
- * The identifier of the PROFINET subslot.
4323
+ * The number/index of the PROFINET subslot.
4265
4324
  * @type {number}
4266
4325
  * @memberof ProfinetSubSlotDescription
4267
4326
  */
4268
4327
  'number': number;
4269
4328
  /**
4270
- * The length in bytes of the PROFINET input.
4329
+ * The amount of bytes allocated for the subslot in the input process image buffer.
4271
4330
  * @type {number}
4272
4331
  * @memberof ProfinetSubSlotDescription
4273
4332
  */
4274
4333
  'input_length': number;
4275
4334
  /**
4276
- * The length in bytes of the PROFINET output.
4335
+ * The amount of bytes allocated for the subslot in the output process image buffer.
4277
4336
  * @type {number}
4278
4337
  * @memberof ProfinetSubSlotDescription
4279
4338
  */
4280
4339
  'output_length': number;
4281
4340
  }
4282
4341
  /**
4283
- * <!-- theme: danger --> > **Experimental** RRT Connect algorithm configuration for collision-free path planning. Rapidly-exploring Random Trees (RRT) builds trees of valid configurations by randomly sampling the joint space and connecting feasible points. RRT Connect grows two trees simultaneously from start and target positions until they meet. This is a custom implementation optimized for manipulator kinematics and collision checking in industrial contexts.
4342
+ * A program is a collection of instructions that are executed in the robot cell.
4343
+ * @export
4344
+ * @interface Program
4345
+ */
4346
+ export interface Program {
4347
+ /**
4348
+ *
4349
+ * @type {string}
4350
+ * @memberof Program
4351
+ */
4352
+ 'program': string;
4353
+ /**
4354
+ *
4355
+ * @type {string}
4356
+ * @memberof Program
4357
+ */
4358
+ 'name'?: string;
4359
+ /**
4360
+ *
4361
+ * @type {string}
4362
+ * @memberof Program
4363
+ */
4364
+ 'description'?: string;
4365
+ /**
4366
+ *
4367
+ * @type {string}
4368
+ * @memberof Program
4369
+ */
4370
+ 'app': string;
4371
+ /**
4372
+ *
4373
+ * @type {object}
4374
+ * @memberof Program
4375
+ */
4376
+ 'input_schema'?: object;
4377
+ /**
4378
+ *
4379
+ * @type {object}
4380
+ * @memberof Program
4381
+ */
4382
+ 'preconditions'?: object;
4383
+ }
4384
+ /**
4385
+ * Holds the state of a program run.
4386
+ * @export
4387
+ * @interface ProgramRun
4388
+ */
4389
+ export interface ProgramRun {
4390
+ /**
4391
+ * Unique identifier of the program run
4392
+ * @type {string}
4393
+ * @memberof ProgramRun
4394
+ */
4395
+ 'run': string;
4396
+ /**
4397
+ * Unique identifier of the program
4398
+ * @type {string}
4399
+ * @memberof ProgramRun
4400
+ */
4401
+ 'program': string;
4402
+ /**
4403
+ * State of the program run
4404
+ * @type {ProgramRunState}
4405
+ * @memberof ProgramRun
4406
+ */
4407
+ 'state': ProgramRunState;
4408
+ /**
4409
+ * Logs of the program run
4410
+ * @type {string}
4411
+ * @memberof ProgramRun
4412
+ */
4413
+ 'logs'?: string;
4414
+ /**
4415
+ * Stdout of the program run
4416
+ * @type {string}
4417
+ * @memberof ProgramRun
4418
+ */
4419
+ 'stdout'?: string;
4420
+ /**
4421
+ * Stderr of the program run
4422
+ * @type {string}
4423
+ * @memberof ProgramRun
4424
+ */
4425
+ 'stderr'?: string;
4426
+ /**
4427
+ * Error message of the program run, if any
4428
+ * @type {string}
4429
+ * @memberof ProgramRun
4430
+ */
4431
+ 'error'?: string;
4432
+ /**
4433
+ * Traceback of the program run, if any
4434
+ * @type {string}
4435
+ * @memberof ProgramRun
4436
+ */
4437
+ 'traceback'?: string;
4438
+ /**
4439
+ * Start time of the program run
4440
+ * @type {string}
4441
+ * @memberof ProgramRun
4442
+ */
4443
+ 'start_time'?: string;
4444
+ /**
4445
+ * End time of the program run
4446
+ * @type {string}
4447
+ * @memberof ProgramRun
4448
+ */
4449
+ 'end_time'?: string;
4450
+ /**
4451
+ * Input data of the program run
4452
+ * @type {object}
4453
+ * @memberof ProgramRun
4454
+ */
4455
+ 'input_data'?: object;
4456
+ }
4457
+
4458
+
4459
+ /**
4460
+ * The state of a program run.
4461
+ * @export
4462
+ * @enum {string}
4463
+ */
4464
+
4465
+ export const ProgramRunState = {
4466
+ Preparing: 'PREPARING',
4467
+ Running: 'RUNNING',
4468
+ Completed: 'COMPLETED',
4469
+ Failed: 'FAILED',
4470
+ Stopped: 'STOPPED'
4471
+ } as const;
4472
+
4473
+ export type ProgramRunState = typeof ProgramRunState[keyof typeof ProgramRunState];
4474
+
4475
+
4476
+ /**
4477
+ * The state of a program run.
4478
+ * @export
4479
+ * @interface ProgramStartRequest
4480
+ */
4481
+ export interface ProgramStartRequest {
4482
+ /**
4483
+ * The arguments to pass to the program.
4484
+ * @type {object}
4485
+ * @memberof ProgramStartRequest
4486
+ */
4487
+ 'arguments': object;
4488
+ }
4489
+ /**
4490
+ *
4284
4491
  * @export
4285
4492
  * @interface RRTConnectAlgorithm
4286
4493
  */
4287
4494
  export interface RRTConnectAlgorithm {
4288
4495
  /**
4289
- * Algorithm discriminator.
4496
+ * Algorithm discriminator. RRT Connect algorithm configuration for collision-free path planning. Rapidly-exploring Random Trees (RRT) builds trees of valid configurations by randomly sampling the joint space and connecting feasible points with JointPTP motions. RRT Connect grows two trees simultaneously from start and target positions until they meet. This is a custom implementation optimized for manipulator kinematics and collision checking in industrial contexts.
4290
4497
  * @type {string}
4291
4498
  * @memberof RRTConnectAlgorithm
4292
4499
  */
@@ -4297,6 +4504,30 @@ export interface RRTConnectAlgorithm {
4297
4504
  * @memberof RRTConnectAlgorithm
4298
4505
  */
4299
4506
  'max_iterations'?: number;
4507
+ /**
4508
+ * Maximum step size for tree extension in joint space.
4509
+ * @type {number}
4510
+ * @memberof RRTConnectAlgorithm
4511
+ */
4512
+ 'max_step_size'?: number;
4513
+ /**
4514
+ * Adjust the maximum step size during the search based on the recent success rate of tree expansion.
4515
+ * @type {boolean}
4516
+ * @memberof RRTConnectAlgorithm
4517
+ */
4518
+ 'adaptive_step_size'?: boolean;
4519
+ /**
4520
+ * Apply smoothing after the search has succeeded. This will remove as many intermediate points as possible while keeping the path valid.
4521
+ * @type {boolean}
4522
+ * @memberof RRTConnectAlgorithm
4523
+ */
4524
+ 'apply_smoothing'?: boolean;
4525
+ /**
4526
+ * Apply blending after the search has succeeded and smoothing has been applied. This will apply the largest viable blending at each intermediate point.
4527
+ * @type {boolean}
4528
+ * @memberof RRTConnectAlgorithm
4529
+ */
4530
+ 'apply_blending'?: boolean;
4300
4531
  }
4301
4532
 
4302
4533
  export const RRTConnectAlgorithmAlgorithmNameEnum = {
@@ -4726,6 +4957,33 @@ export interface ServiceStatusStatus {
4726
4957
  }
4727
4958
 
4728
4959
 
4960
+ /**
4961
+ * Defines an input/output that should be set upon reaching a specified location on the trajectory.
4962
+ * @export
4963
+ * @interface SetIO
4964
+ */
4965
+ export interface SetIO {
4966
+ /**
4967
+ *
4968
+ * @type {IOValue}
4969
+ * @memberof SetIO
4970
+ */
4971
+ 'io': IOValue;
4972
+ /**
4973
+ * The location on the trajectory where the input/output should be set.
4974
+ * @type {number}
4975
+ * @memberof SetIO
4976
+ */
4977
+ 'location': number;
4978
+ /**
4979
+ *
4980
+ * @type {IOOrigin}
4981
+ * @memberof SetIO
4982
+ */
4983
+ 'io_origin': IOOrigin;
4984
+ }
4985
+
4986
+
4729
4987
  /**
4730
4988
  *
4731
4989
  * @export
@@ -4799,12 +5057,18 @@ export interface StartMovementRequest {
4799
5057
  * @memberof StartMovementRequest
4800
5058
  */
4801
5059
  'direction'?: Direction;
5060
+ /**
5061
+ * 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
5062
+ * @type {number}
5063
+ * @memberof StartMovementRequest
5064
+ */
5065
+ 'target_location'?: number;
4802
5066
  /**
4803
5067
  * Attaches a list of output commands to the trajectory. The outputs are set to the specified values right after the specified location was reached. If the specified location is located before the start location (forward direction: value is smaller, backward direction: value is bigger), the output is not set.
4804
- * @type {Array<IOValue>}
5068
+ * @type {Array<SetIO>}
4805
5069
  * @memberof StartMovementRequest
4806
5070
  */
4807
- 'set_outputs'?: Array<IOValue>;
5071
+ 'set_outputs'?: Array<SetIO>;
4808
5072
  /**
4809
5073
  * Defines an input/output that is listened to before the movement. Execution starts if the defined comparator evaluates to `true`.
4810
5074
  * @type {StartOnIO}
@@ -4869,6 +5133,12 @@ export interface StartOnIO {
4869
5133
  * @memberof StartOnIO
4870
5134
  */
4871
5135
  'comparator': Comparator;
5136
+ /**
5137
+ *
5138
+ * @type {IOOrigin}
5139
+ * @memberof StartOnIO
5140
+ */
5141
+ 'io_origin': IOOrigin;
4872
5142
  }
4873
5143
 
4874
5144
 
@@ -5076,7 +5346,7 @@ export interface TrajectoryDetails {
5076
5346
  */
5077
5347
  'trajectory': string;
5078
5348
  /**
5079
- * Current location of motion group on the trajectory.
5349
+ * Location on trajectory where the execution will start. The default value is the start (forward movement) or end (backward movement) of the trajectory. If you want to start your movement from an arbitrary location, e.g. in combination with [streamMoveToTrajectoryViaJointPTP](streamMoveToTrajectoryViaJointPTP), set the location by respecting the following format: - The location is a scalar value that defines a position along a path, typically ranging from 0 to `n`, where `n` denotes the number of motion commands - Each integer value of the location corresponds to a specific motion command, while non-integer values interpolate positions within the segments. - The location is calculated from the joint path
5080
5350
  * @type {number}
5081
5351
  * @memberof TrajectoryDetails
5082
5352
  */
@@ -5138,7 +5408,7 @@ export interface TrajectoryId {
5138
5408
  * @type {string}
5139
5409
  * @memberof TrajectoryId
5140
5410
  */
5141
- 'message_type'?: TrajectoryIdMessageTypeEnum;
5411
+ 'message_type': TrajectoryIdMessageTypeEnum;
5142
5412
  /**
5143
5413
  * The identifier of the trajectory which was returned by the [addTrajectory](addTrajectory) endpoint.
5144
5414
  * @type {string}
@@ -5334,21 +5604,46 @@ export interface ValidationError {
5334
5604
  'input': { [key: string]: any; };
5335
5605
  }
5336
5606
  /**
5337
- * @type ValidationErrorLocInner
5338
- * @export
5339
- */
5340
- export type ValidationErrorLocInner = number | string;
5341
-
5342
- /**
5343
- * The configuration of a virtual robot controller has to contain the manufacturer string, an optional joint position string array and either a preset `type` **or** the complete JSON configuration.
5607
+ * A validation error of a program.
5344
5608
  * @export
5345
- * @interface VirtualController
5609
+ * @interface ValidationError2
5346
5610
  */
5347
- export interface VirtualController {
5611
+ export interface ValidationError2 {
5348
5612
  /**
5349
5613
  *
5350
- * @type {string}
5351
- * @memberof VirtualController
5614
+ * @type {Array<number>}
5615
+ * @memberof ValidationError2
5616
+ */
5617
+ 'loc': Array<number>;
5618
+ /**
5619
+ *
5620
+ * @type {string}
5621
+ * @memberof ValidationError2
5622
+ */
5623
+ 'msg': string;
5624
+ /**
5625
+ *
5626
+ * @type {string}
5627
+ * @memberof ValidationError2
5628
+ */
5629
+ 'type': string;
5630
+ }
5631
+ /**
5632
+ * @type ValidationErrorLocInner
5633
+ * @export
5634
+ */
5635
+ export type ValidationErrorLocInner = number | string;
5636
+
5637
+ /**
5638
+ * The configuration of a virtual robot controller has to contain the manufacturer string, an optional joint position string array and either a preset `type` **or** the complete JSON configuration.
5639
+ * @export
5640
+ * @interface VirtualController
5641
+ */
5642
+ export interface VirtualController {
5643
+ /**
5644
+ *
5645
+ * @type {string}
5646
+ * @memberof VirtualController
5352
5647
  */
5353
5648
  'kind'?: VirtualControllerKindEnum;
5354
5649
  /**
@@ -5460,11 +5755,13 @@ export const VirtualControllerTypes = {
5460
5755
  KukaKr4R600: 'kuka-kr4_r600',
5461
5756
  KukaKr500L3403: 'kuka-kr500_l340_3',
5462
5757
  KukaKr50R2500: 'kuka-kr50_r2500',
5758
+ KukaKr60R3: 'kuka-kr60_r3',
5463
5759
  KukaKr6R1820: 'kuka-kr6_r1820',
5464
5760
  KukaKr6R7002: 'kuka-kr6_r700_2',
5465
5761
  KukaKr6R700Sixx: 'kuka-kr6_r700_sixx',
5466
5762
  KukaKr6R900: 'kuka-kr6_r900',
5467
5763
  KukaKr6R9002: 'kuka-kr6_r900_2',
5764
+ KukaKr70R2100: 'kuka-kr70_r2100',
5468
5765
  KukaLbrIisy11R1300: 'kuka-lbr_iisy_11_r1300',
5469
5766
  UniversalrobotsUr10cb: 'universalrobots-ur10cb',
5470
5767
  UniversalrobotsUr10e: 'universalrobots-ur10e',
@@ -6150,7 +6447,7 @@ export class ApplicationApi extends BaseAPI {
6150
6447
  export const BUSInputsOutputsApiAxiosParamCreator = function (configuration?: Configuration) {
6151
6448
  return {
6152
6449
  /**
6153
- * Add a BUS Inputs/Outputs Service to the cell.
6450
+ * Add the BUS inputs/outputs service to the cell. Starts a containerized service that enables BUS connections via the specified ethernet port.
6154
6451
  * @summary Add Service
6155
6452
  * @param {string} cell Unique identifier addressing a cell in all API calls.
6156
6453
  * @param {BusIOType} busIOType
@@ -6203,7 +6500,7 @@ export const BUSInputsOutputsApiAxiosParamCreator = function (configuration?: Co
6203
6500
  };
6204
6501
  },
6205
6502
  /**
6206
- * Adds an input/output to or updates an input/output on the PROFINET device.
6503
+ * Adds an input/output variable to or updates an input/output variable on the PROFINET device, e.g. NOVA\'s PROFINET service. The inputs/outputs map variables to specific memory addresses in the process image. The default process image has buffer lengths of 64 bytes for input and output. The size of the buffer is determined by the `config_file_content` that is passed in [addBusIOService](addBusIOService) and has to be in accordance with the GSDML file describing the PROFINET device. The PROFINET controller as well as NOVA\'s PROFINET service use an input/output variable configuration to interpret the bits of the input/output process image. The NOVA\'s PROFINET service\'s configuration can be viewed via [listProfinetIOs](listProfinetIOs). For the PROFINET controller, e.g. a connected PLC, refer to the corresponding third party software, e.g. TIA portal).
6207
6504
  * @summary Add PROFINET Input/Output
6208
6505
  * @param {string} cell Unique identifier addressing a cell in all API calls.
6209
6506
  * @param {string} io Unique identifier to address an Input/Output in the cell.
@@ -6255,7 +6552,7 @@ export const BUSInputsOutputsApiAxiosParamCreator = function (configuration?: Co
6255
6552
  };
6256
6553
  },
6257
6554
  /**
6258
- * Delete BUS Inputs/Outputs Service from the cell.
6555
+ * Remove the BUS inputs/outputs service from the cell.
6259
6556
  * @summary Clear Service
6260
6557
  * @param {string} cell Unique identifier addressing a cell in all API calls.
6261
6558
  * @param {number} [completionTimeout]
@@ -6302,7 +6599,7 @@ export const BUSInputsOutputsApiAxiosParamCreator = function (configuration?: Co
6302
6599
  };
6303
6600
  },
6304
6601
  /**
6305
- * Removes the input/output from the PROFINET device.
6602
+ * Removes an input/output variable configuration from the PROFINET device, e.g. NOVA\'s PROFINET service.
6306
6603
  * @summary Remove PROFINET Input/Ouptut
6307
6604
  * @param {string} cell Unique identifier addressing a cell in all API calls.
6308
6605
  * @param {string} io Unique identifier to address an Input/Output in the cell.
@@ -6348,7 +6645,7 @@ export const BUSInputsOutputsApiAxiosParamCreator = function (configuration?: Co
6348
6645
  };
6349
6646
  },
6350
6647
  /**
6351
- * Get deployed BUS Inputs/Outputs Service.
6648
+ * Get deployed BUS inputs/outputs service.
6352
6649
  * @summary Get Service
6353
6650
  * @param {string} cell Unique identifier addressing a cell in all API calls.
6354
6651
  * @param {*} [options] Override http request option.
@@ -6479,7 +6776,7 @@ export const BUSInputsOutputsApiAxiosParamCreator = function (configuration?: Co
6479
6776
  };
6480
6777
  },
6481
6778
  /**
6482
- * Get description of PROFINET
6779
+ * Get description of NOVA as a PROFINET device.
6483
6780
  * @summary Get PROFINET Description
6484
6781
  * @param {string} cell Unique identifier addressing a cell in all API calls.
6485
6782
  * @param {*} [options] Override http request option.
@@ -6521,7 +6818,7 @@ export const BUSInputsOutputsApiAxiosParamCreator = function (configuration?: Co
6521
6818
  };
6522
6819
  },
6523
6820
  /**
6524
- * Get input/output configuration of the PROFINET device as file.
6821
+ * Get input/output variable configuration of the PROFINET device, e.g. NOVA\'s PROFINET service as file. You can specify byte offsets for the input and output variable addresses to get an XML tagmap that is ready to paste to the third party software, e.g. TIA portal.
6525
6822
  * @summary PROFINET Inputs/Outputs to File
6526
6823
  * @param {string} cell Unique identifier addressing a cell in all API calls.
6527
6824
  * @param {number} [inputOffset]
@@ -6573,7 +6870,7 @@ export const BUSInputsOutputsApiAxiosParamCreator = function (configuration?: Co
6573
6870
  };
6574
6871
  },
6575
6872
  /**
6576
- * List all BUS Input/Output descriptions.
6873
+ * List all input/output descriptions for configured BUS services. The input/output descriptions contain information such as the name, the type and the unit. The input/output direction is given in perspective of the BUS service.
6577
6874
  * @summary List Descriptions
6578
6875
  * @param {string} cell Unique identifier addressing a cell in all API calls.
6579
6876
  * @param {*} [options] Override http request option.
@@ -6615,7 +6912,7 @@ export const BUSInputsOutputsApiAxiosParamCreator = function (configuration?: Co
6615
6912
  };
6616
6913
  },
6617
6914
  /**
6618
- * List all PROFINET input and outputs.
6915
+ * List descriptions for all configured input/output variables of the PROFINET service. The input/output descriptions contain information such as the name, the type and the unit. The input/output direction is given in perspective of the PROFINET Device, e.g. the configured PROFINET service. The byte and bit addresses are the locations in the PROFINET input/output process image the variable points to. The PROFINET controller as well as NOVA\'s PROFINET service use an input/output variable configuration to interpret the bits of the input and output process image. The NOVA PROFINET service\'s configuration is modified via [addProfinetIO](addProfinetIO) and [setProfinetIOsFromFile](setProfinetIOsFromFile). For the PROFINET controller, e.g. a connected PLC, refer to the corresponding third party software, e.g. TIA portal.
6619
6916
  * @summary List PROFINET Input/Output Configuration
6620
6917
  * @param {string} cell Unique identifier addressing a cell in all API calls.
6621
6918
  * @param {*} [options] Override http request option.
@@ -6705,7 +7002,7 @@ export const BUSInputsOutputsApiAxiosParamCreator = function (configuration?: Co
6705
7002
  };
6706
7003
  },
6707
7004
  /**
6708
- * Sets inputs/outputs on the PROFINET device from file.
7005
+ * Sets input/output variable configuration on the PROFINET device (i.e. NOVA\'s PROFINET service) from XML file. The inputs/outputs map variables to specific memory addresses in the process image. The default process image has buffer lengths of 64 bytes for input and output. The size of the buffer is determined by the `config_file_content` that is passed in [addBusIOService](addBusIOService) and has to be in accordance with the GSDML file describing the PROFINET device. The PROFINET controller as well as NOVA\'s PROFINET service use an input/output variable configuration to interpret the bits of the input/output process image. The NOVA\'s PROFINET service\'s configuration can be viewed via [listProfinetIOs](listProfinetIOs). For the PROFINET controller, e.g. a connected PLC, refer to the corresponding engineering system, e.g. TIA portal. You can export the variable configuration of the PROFINET controller as XML file from your engineering system, e.g. TIA portal. The endpoint is built so that the perspective of input and output (PROFINET Device\'s input is PROFINET Controller\'s output) is internally handled (PROFINET device input is PROFINET controller output), meaning that you can paste the exported XML file here without modifying.
6709
7006
  * @summary Set PROFINET Inputs/Outputs from File
6710
7007
  * @param {string} cell Unique identifier addressing a cell in all API calls.
6711
7008
  * @param {ProfinetInputOutputConfig} profinetInputOutputConfig
@@ -6763,7 +7060,7 @@ export const BUSInputsOutputsApiFp = function(configuration?: Configuration) {
6763
7060
  const localVarAxiosParamCreator = BUSInputsOutputsApiAxiosParamCreator(configuration)
6764
7061
  return {
6765
7062
  /**
6766
- * Add a BUS Inputs/Outputs Service to the cell.
7063
+ * Add the BUS inputs/outputs service to the cell. Starts a containerized service that enables BUS connections via the specified ethernet port.
6767
7064
  * @summary Add Service
6768
7065
  * @param {string} cell Unique identifier addressing a cell in all API calls.
6769
7066
  * @param {BusIOType} busIOType
@@ -6778,7 +7075,7 @@ export const BUSInputsOutputsApiFp = function(configuration?: Configuration) {
6778
7075
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
6779
7076
  },
6780
7077
  /**
6781
- * Adds an input/output to or updates an input/output on the PROFINET device.
7078
+ * Adds an input/output variable to or updates an input/output variable on the PROFINET device, e.g. NOVA\'s PROFINET service. The inputs/outputs map variables to specific memory addresses in the process image. The default process image has buffer lengths of 64 bytes for input and output. The size of the buffer is determined by the `config_file_content` that is passed in [addBusIOService](addBusIOService) and has to be in accordance with the GSDML file describing the PROFINET device. The PROFINET controller as well as NOVA\'s PROFINET service use an input/output variable configuration to interpret the bits of the input/output process image. The NOVA\'s PROFINET service\'s configuration can be viewed via [listProfinetIOs](listProfinetIOs). For the PROFINET controller, e.g. a connected PLC, refer to the corresponding third party software, e.g. TIA portal).
6782
7079
  * @summary Add PROFINET Input/Output
6783
7080
  * @param {string} cell Unique identifier addressing a cell in all API calls.
6784
7081
  * @param {string} io Unique identifier to address an Input/Output in the cell.
@@ -6793,7 +7090,7 @@ export const BUSInputsOutputsApiFp = function(configuration?: Configuration) {
6793
7090
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
6794
7091
  },
6795
7092
  /**
6796
- * Delete BUS Inputs/Outputs Service from the cell.
7093
+ * Remove the BUS inputs/outputs service from the cell.
6797
7094
  * @summary Clear Service
6798
7095
  * @param {string} cell Unique identifier addressing a cell in all API calls.
6799
7096
  * @param {number} [completionTimeout]
@@ -6807,7 +7104,7 @@ export const BUSInputsOutputsApiFp = function(configuration?: Configuration) {
6807
7104
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
6808
7105
  },
6809
7106
  /**
6810
- * Removes the input/output from the PROFINET device.
7107
+ * Removes an input/output variable configuration from the PROFINET device, e.g. NOVA\'s PROFINET service.
6811
7108
  * @summary Remove PROFINET Input/Ouptut
6812
7109
  * @param {string} cell Unique identifier addressing a cell in all API calls.
6813
7110
  * @param {string} io Unique identifier to address an Input/Output in the cell.
@@ -6821,7 +7118,7 @@ export const BUSInputsOutputsApiFp = function(configuration?: Configuration) {
6821
7118
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
6822
7119
  },
6823
7120
  /**
6824
- * Get deployed BUS Inputs/Outputs Service.
7121
+ * Get deployed BUS inputs/outputs service.
6825
7122
  * @summary Get Service
6826
7123
  * @param {string} cell Unique identifier addressing a cell in all API calls.
6827
7124
  * @param {*} [options] Override http request option.
@@ -6861,7 +7158,7 @@ export const BUSInputsOutputsApiFp = function(configuration?: Configuration) {
6861
7158
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
6862
7159
  },
6863
7160
  /**
6864
- * Get description of PROFINET
7161
+ * Get description of NOVA as a PROFINET device.
6865
7162
  * @summary Get PROFINET Description
6866
7163
  * @param {string} cell Unique identifier addressing a cell in all API calls.
6867
7164
  * @param {*} [options] Override http request option.
@@ -6874,7 +7171,7 @@ export const BUSInputsOutputsApiFp = function(configuration?: Configuration) {
6874
7171
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
6875
7172
  },
6876
7173
  /**
6877
- * Get input/output configuration of the PROFINET device as file.
7174
+ * Get input/output variable configuration of the PROFINET device, e.g. NOVA\'s PROFINET service as file. You can specify byte offsets for the input and output variable addresses to get an XML tagmap that is ready to paste to the third party software, e.g. TIA portal.
6878
7175
  * @summary PROFINET Inputs/Outputs to File
6879
7176
  * @param {string} cell Unique identifier addressing a cell in all API calls.
6880
7177
  * @param {number} [inputOffset]
@@ -6889,20 +7186,20 @@ export const BUSInputsOutputsApiFp = function(configuration?: Configuration) {
6889
7186
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
6890
7187
  },
6891
7188
  /**
6892
- * List all BUS Input/Output descriptions.
7189
+ * List all input/output descriptions for configured BUS services. The input/output descriptions contain information such as the name, the type and the unit. The input/output direction is given in perspective of the BUS service.
6893
7190
  * @summary List Descriptions
6894
7191
  * @param {string} cell Unique identifier addressing a cell in all API calls.
6895
7192
  * @param {*} [options] Override http request option.
6896
7193
  * @throws {RequiredError}
6897
7194
  */
6898
- async listBusIODescriptions(cell: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<IODescription>>> {
7195
+ async listBusIODescriptions(cell: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<IODescription2>>> {
6899
7196
  const localVarAxiosArgs = await localVarAxiosParamCreator.listBusIODescriptions(cell, options);
6900
7197
  const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
6901
7198
  const localVarOperationServerBasePath = operationServerMap['BUSInputsOutputsApi.listBusIODescriptions']?.[localVarOperationServerIndex]?.url;
6902
7199
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
6903
7200
  },
6904
7201
  /**
6905
- * List all PROFINET input and outputs.
7202
+ * List descriptions for all configured input/output variables of the PROFINET service. The input/output descriptions contain information such as the name, the type and the unit. The input/output direction is given in perspective of the PROFINET Device, e.g. the configured PROFINET service. The byte and bit addresses are the locations in the PROFINET input/output process image the variable points to. The PROFINET controller as well as NOVA\'s PROFINET service use an input/output variable configuration to interpret the bits of the input and output process image. The NOVA PROFINET service\'s configuration is modified via [addProfinetIO](addProfinetIO) and [setProfinetIOsFromFile](setProfinetIOsFromFile). For the PROFINET controller, e.g. a connected PLC, refer to the corresponding third party software, e.g. TIA portal.
6906
7203
  * @summary List PROFINET Input/Output Configuration
6907
7204
  * @param {string} cell Unique identifier addressing a cell in all API calls.
6908
7205
  * @param {*} [options] Override http request option.
@@ -6929,7 +7226,7 @@ export const BUSInputsOutputsApiFp = function(configuration?: Configuration) {
6929
7226
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
6930
7227
  },
6931
7228
  /**
6932
- * Sets inputs/outputs on the PROFINET device from file.
7229
+ * Sets input/output variable configuration on the PROFINET device (i.e. NOVA\'s PROFINET service) from XML file. The inputs/outputs map variables to specific memory addresses in the process image. The default process image has buffer lengths of 64 bytes for input and output. The size of the buffer is determined by the `config_file_content` that is passed in [addBusIOService](addBusIOService) and has to be in accordance with the GSDML file describing the PROFINET device. The PROFINET controller as well as NOVA\'s PROFINET service use an input/output variable configuration to interpret the bits of the input/output process image. The NOVA\'s PROFINET service\'s configuration can be viewed via [listProfinetIOs](listProfinetIOs). For the PROFINET controller, e.g. a connected PLC, refer to the corresponding engineering system, e.g. TIA portal. You can export the variable configuration of the PROFINET controller as XML file from your engineering system, e.g. TIA portal. The endpoint is built so that the perspective of input and output (PROFINET Device\'s input is PROFINET Controller\'s output) is internally handled (PROFINET device input is PROFINET controller output), meaning that you can paste the exported XML file here without modifying.
6933
7230
  * @summary Set PROFINET Inputs/Outputs from File
6934
7231
  * @param {string} cell Unique identifier addressing a cell in all API calls.
6935
7232
  * @param {ProfinetInputOutputConfig} profinetInputOutputConfig
@@ -6953,7 +7250,7 @@ export const BUSInputsOutputsApiFactory = function (configuration?: Configuratio
6953
7250
  const localVarFp = BUSInputsOutputsApiFp(configuration)
6954
7251
  return {
6955
7252
  /**
6956
- * Add a BUS Inputs/Outputs Service to the cell.
7253
+ * Add the BUS inputs/outputs service to the cell. Starts a containerized service that enables BUS connections via the specified ethernet port.
6957
7254
  * @summary Add Service
6958
7255
  * @param {string} cell Unique identifier addressing a cell in all API calls.
6959
7256
  * @param {BusIOType} busIOType
@@ -6965,7 +7262,7 @@ export const BUSInputsOutputsApiFactory = function (configuration?: Configuratio
6965
7262
  return localVarFp.addBusIOService(cell, busIOType, completionTimeout, options).then((request) => request(axios, basePath));
6966
7263
  },
6967
7264
  /**
6968
- * Adds an input/output to or updates an input/output on the PROFINET device.
7265
+ * Adds an input/output variable to or updates an input/output variable on the PROFINET device, e.g. NOVA\'s PROFINET service. The inputs/outputs map variables to specific memory addresses in the process image. The default process image has buffer lengths of 64 bytes for input and output. The size of the buffer is determined by the `config_file_content` that is passed in [addBusIOService](addBusIOService) and has to be in accordance with the GSDML file describing the PROFINET device. The PROFINET controller as well as NOVA\'s PROFINET service use an input/output variable configuration to interpret the bits of the input/output process image. The NOVA\'s PROFINET service\'s configuration can be viewed via [listProfinetIOs](listProfinetIOs). For the PROFINET controller, e.g. a connected PLC, refer to the corresponding third party software, e.g. TIA portal).
6969
7266
  * @summary Add PROFINET Input/Output
6970
7267
  * @param {string} cell Unique identifier addressing a cell in all API calls.
6971
7268
  * @param {string} io Unique identifier to address an Input/Output in the cell.
@@ -6977,7 +7274,7 @@ export const BUSInputsOutputsApiFactory = function (configuration?: Configuratio
6977
7274
  return localVarFp.addProfinetIO(cell, io, profinetIOData, options).then((request) => request(axios, basePath));
6978
7275
  },
6979
7276
  /**
6980
- * Delete BUS Inputs/Outputs Service from the cell.
7277
+ * Remove the BUS inputs/outputs service from the cell.
6981
7278
  * @summary Clear Service
6982
7279
  * @param {string} cell Unique identifier addressing a cell in all API calls.
6983
7280
  * @param {number} [completionTimeout]
@@ -6988,7 +7285,7 @@ export const BUSInputsOutputsApiFactory = function (configuration?: Configuratio
6988
7285
  return localVarFp.clearBusIOService(cell, completionTimeout, options).then((request) => request(axios, basePath));
6989
7286
  },
6990
7287
  /**
6991
- * Removes the input/output from the PROFINET device.
7288
+ * Removes an input/output variable configuration from the PROFINET device, e.g. NOVA\'s PROFINET service.
6992
7289
  * @summary Remove PROFINET Input/Ouptut
6993
7290
  * @param {string} cell Unique identifier addressing a cell in all API calls.
6994
7291
  * @param {string} io Unique identifier to address an Input/Output in the cell.
@@ -6999,7 +7296,7 @@ export const BUSInputsOutputsApiFactory = function (configuration?: Configuratio
6999
7296
  return localVarFp.deleteProfinetIO(cell, io, options).then((request) => request(axios, basePath));
7000
7297
  },
7001
7298
  /**
7002
- * Get deployed BUS Inputs/Outputs Service.
7299
+ * Get deployed BUS inputs/outputs service.
7003
7300
  * @summary Get Service
7004
7301
  * @param {string} cell Unique identifier addressing a cell in all API calls.
7005
7302
  * @param {*} [options] Override http request option.
@@ -7030,7 +7327,7 @@ export const BUSInputsOutputsApiFactory = function (configuration?: Configuratio
7030
7327
  return localVarFp.getBusIOValues(cell, ios, options).then((request) => request(axios, basePath));
7031
7328
  },
7032
7329
  /**
7033
- * Get description of PROFINET
7330
+ * Get description of NOVA as a PROFINET device.
7034
7331
  * @summary Get PROFINET Description
7035
7332
  * @param {string} cell Unique identifier addressing a cell in all API calls.
7036
7333
  * @param {*} [options] Override http request option.
@@ -7040,7 +7337,7 @@ export const BUSInputsOutputsApiFactory = function (configuration?: Configuratio
7040
7337
  return localVarFp.getProfinetDescription(cell, options).then((request) => request(axios, basePath));
7041
7338
  },
7042
7339
  /**
7043
- * Get input/output configuration of the PROFINET device as file.
7340
+ * Get input/output variable configuration of the PROFINET device, e.g. NOVA\'s PROFINET service as file. You can specify byte offsets for the input and output variable addresses to get an XML tagmap that is ready to paste to the third party software, e.g. TIA portal.
7044
7341
  * @summary PROFINET Inputs/Outputs to File
7045
7342
  * @param {string} cell Unique identifier addressing a cell in all API calls.
7046
7343
  * @param {number} [inputOffset]
@@ -7052,17 +7349,17 @@ export const BUSInputsOutputsApiFactory = function (configuration?: Configuratio
7052
7349
  return localVarFp.getProfinetIOsFromFile(cell, inputOffset, outputOffset, options).then((request) => request(axios, basePath));
7053
7350
  },
7054
7351
  /**
7055
- * List all BUS Input/Output descriptions.
7352
+ * List all input/output descriptions for configured BUS services. The input/output descriptions contain information such as the name, the type and the unit. The input/output direction is given in perspective of the BUS service.
7056
7353
  * @summary List Descriptions
7057
7354
  * @param {string} cell Unique identifier addressing a cell in all API calls.
7058
7355
  * @param {*} [options] Override http request option.
7059
7356
  * @throws {RequiredError}
7060
7357
  */
7061
- listBusIODescriptions(cell: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<IODescription>> {
7358
+ listBusIODescriptions(cell: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<IODescription2>> {
7062
7359
  return localVarFp.listBusIODescriptions(cell, options).then((request) => request(axios, basePath));
7063
7360
  },
7064
7361
  /**
7065
- * List all PROFINET input and outputs.
7362
+ * List descriptions for all configured input/output variables of the PROFINET service. The input/output descriptions contain information such as the name, the type and the unit. The input/output direction is given in perspective of the PROFINET Device, e.g. the configured PROFINET service. The byte and bit addresses are the locations in the PROFINET input/output process image the variable points to. The PROFINET controller as well as NOVA\'s PROFINET service use an input/output variable configuration to interpret the bits of the input and output process image. The NOVA PROFINET service\'s configuration is modified via [addProfinetIO](addProfinetIO) and [setProfinetIOsFromFile](setProfinetIOsFromFile). For the PROFINET controller, e.g. a connected PLC, refer to the corresponding third party software, e.g. TIA portal.
7066
7363
  * @summary List PROFINET Input/Output Configuration
7067
7364
  * @param {string} cell Unique identifier addressing a cell in all API calls.
7068
7365
  * @param {*} [options] Override http request option.
@@ -7083,7 +7380,7 @@ export const BUSInputsOutputsApiFactory = function (configuration?: Configuratio
7083
7380
  return localVarFp.setBusIOValues(cell, iOValue, options).then((request) => request(axios, basePath));
7084
7381
  },
7085
7382
  /**
7086
- * Sets inputs/outputs on the PROFINET device from file.
7383
+ * Sets input/output variable configuration on the PROFINET device (i.e. NOVA\'s PROFINET service) from XML file. The inputs/outputs map variables to specific memory addresses in the process image. The default process image has buffer lengths of 64 bytes for input and output. The size of the buffer is determined by the `config_file_content` that is passed in [addBusIOService](addBusIOService) and has to be in accordance with the GSDML file describing the PROFINET device. The PROFINET controller as well as NOVA\'s PROFINET service use an input/output variable configuration to interpret the bits of the input/output process image. The NOVA\'s PROFINET service\'s configuration can be viewed via [listProfinetIOs](listProfinetIOs). For the PROFINET controller, e.g. a connected PLC, refer to the corresponding engineering system, e.g. TIA portal. You can export the variable configuration of the PROFINET controller as XML file from your engineering system, e.g. TIA portal. The endpoint is built so that the perspective of input and output (PROFINET Device\'s input is PROFINET Controller\'s output) is internally handled (PROFINET device input is PROFINET controller output), meaning that you can paste the exported XML file here without modifying.
7087
7384
  * @summary Set PROFINET Inputs/Outputs from File
7088
7385
  * @param {string} cell Unique identifier addressing a cell in all API calls.
7089
7386
  * @param {ProfinetInputOutputConfig} profinetInputOutputConfig
@@ -7104,7 +7401,7 @@ export const BUSInputsOutputsApiFactory = function (configuration?: Configuratio
7104
7401
  */
7105
7402
  export class BUSInputsOutputsApi extends BaseAPI {
7106
7403
  /**
7107
- * Add a BUS Inputs/Outputs Service to the cell.
7404
+ * Add the BUS inputs/outputs service to the cell. Starts a containerized service that enables BUS connections via the specified ethernet port.
7108
7405
  * @summary Add Service
7109
7406
  * @param {string} cell Unique identifier addressing a cell in all API calls.
7110
7407
  * @param {BusIOType} busIOType
@@ -7118,7 +7415,7 @@ export class BUSInputsOutputsApi extends BaseAPI {
7118
7415
  }
7119
7416
 
7120
7417
  /**
7121
- * Adds an input/output to or updates an input/output on the PROFINET device.
7418
+ * Adds an input/output variable to or updates an input/output variable on the PROFINET device, e.g. NOVA\'s PROFINET service. The inputs/outputs map variables to specific memory addresses in the process image. The default process image has buffer lengths of 64 bytes for input and output. The size of the buffer is determined by the `config_file_content` that is passed in [addBusIOService](addBusIOService) and has to be in accordance with the GSDML file describing the PROFINET device. The PROFINET controller as well as NOVA\'s PROFINET service use an input/output variable configuration to interpret the bits of the input/output process image. The NOVA\'s PROFINET service\'s configuration can be viewed via [listProfinetIOs](listProfinetIOs). For the PROFINET controller, e.g. a connected PLC, refer to the corresponding third party software, e.g. TIA portal).
7122
7419
  * @summary Add PROFINET Input/Output
7123
7420
  * @param {string} cell Unique identifier addressing a cell in all API calls.
7124
7421
  * @param {string} io Unique identifier to address an Input/Output in the cell.
@@ -7132,7 +7429,7 @@ export class BUSInputsOutputsApi extends BaseAPI {
7132
7429
  }
7133
7430
 
7134
7431
  /**
7135
- * Delete BUS Inputs/Outputs Service from the cell.
7432
+ * Remove the BUS inputs/outputs service from the cell.
7136
7433
  * @summary Clear Service
7137
7434
  * @param {string} cell Unique identifier addressing a cell in all API calls.
7138
7435
  * @param {number} [completionTimeout]
@@ -7145,7 +7442,7 @@ export class BUSInputsOutputsApi extends BaseAPI {
7145
7442
  }
7146
7443
 
7147
7444
  /**
7148
- * Removes the input/output from the PROFINET device.
7445
+ * Removes an input/output variable configuration from the PROFINET device, e.g. NOVA\'s PROFINET service.
7149
7446
  * @summary Remove PROFINET Input/Ouptut
7150
7447
  * @param {string} cell Unique identifier addressing a cell in all API calls.
7151
7448
  * @param {string} io Unique identifier to address an Input/Output in the cell.
@@ -7158,7 +7455,7 @@ export class BUSInputsOutputsApi extends BaseAPI {
7158
7455
  }
7159
7456
 
7160
7457
  /**
7161
- * Get deployed BUS Inputs/Outputs Service.
7458
+ * Get deployed BUS inputs/outputs service.
7162
7459
  * @summary Get Service
7163
7460
  * @param {string} cell Unique identifier addressing a cell in all API calls.
7164
7461
  * @param {*} [options] Override http request option.
@@ -7195,7 +7492,7 @@ export class BUSInputsOutputsApi extends BaseAPI {
7195
7492
  }
7196
7493
 
7197
7494
  /**
7198
- * Get description of PROFINET
7495
+ * Get description of NOVA as a PROFINET device.
7199
7496
  * @summary Get PROFINET Description
7200
7497
  * @param {string} cell Unique identifier addressing a cell in all API calls.
7201
7498
  * @param {*} [options] Override http request option.
@@ -7207,7 +7504,7 @@ export class BUSInputsOutputsApi extends BaseAPI {
7207
7504
  }
7208
7505
 
7209
7506
  /**
7210
- * Get input/output configuration of the PROFINET device as file.
7507
+ * Get input/output variable configuration of the PROFINET device, e.g. NOVA\'s PROFINET service as file. You can specify byte offsets for the input and output variable addresses to get an XML tagmap that is ready to paste to the third party software, e.g. TIA portal.
7211
7508
  * @summary PROFINET Inputs/Outputs to File
7212
7509
  * @param {string} cell Unique identifier addressing a cell in all API calls.
7213
7510
  * @param {number} [inputOffset]
@@ -7221,7 +7518,7 @@ export class BUSInputsOutputsApi extends BaseAPI {
7221
7518
  }
7222
7519
 
7223
7520
  /**
7224
- * List all BUS Input/Output descriptions.
7521
+ * List all input/output descriptions for configured BUS services. The input/output descriptions contain information such as the name, the type and the unit. The input/output direction is given in perspective of the BUS service.
7225
7522
  * @summary List Descriptions
7226
7523
  * @param {string} cell Unique identifier addressing a cell in all API calls.
7227
7524
  * @param {*} [options] Override http request option.
@@ -7233,7 +7530,7 @@ export class BUSInputsOutputsApi extends BaseAPI {
7233
7530
  }
7234
7531
 
7235
7532
  /**
7236
- * List all PROFINET input and outputs.
7533
+ * List descriptions for all configured input/output variables of the PROFINET service. The input/output descriptions contain information such as the name, the type and the unit. The input/output direction is given in perspective of the PROFINET Device, e.g. the configured PROFINET service. The byte and bit addresses are the locations in the PROFINET input/output process image the variable points to. The PROFINET controller as well as NOVA\'s PROFINET service use an input/output variable configuration to interpret the bits of the input and output process image. The NOVA PROFINET service\'s configuration is modified via [addProfinetIO](addProfinetIO) and [setProfinetIOsFromFile](setProfinetIOsFromFile). For the PROFINET controller, e.g. a connected PLC, refer to the corresponding third party software, e.g. TIA portal.
7237
7534
  * @summary List PROFINET Input/Output Configuration
7238
7535
  * @param {string} cell Unique identifier addressing a cell in all API calls.
7239
7536
  * @param {*} [options] Override http request option.
@@ -7258,7 +7555,7 @@ export class BUSInputsOutputsApi extends BaseAPI {
7258
7555
  }
7259
7556
 
7260
7557
  /**
7261
- * Sets inputs/outputs on the PROFINET device from file.
7558
+ * Sets input/output variable configuration on the PROFINET device (i.e. NOVA\'s PROFINET service) from XML file. The inputs/outputs map variables to specific memory addresses in the process image. The default process image has buffer lengths of 64 bytes for input and output. The size of the buffer is determined by the `config_file_content` that is passed in [addBusIOService](addBusIOService) and has to be in accordance with the GSDML file describing the PROFINET device. The PROFINET controller as well as NOVA\'s PROFINET service use an input/output variable configuration to interpret the bits of the input/output process image. The NOVA\'s PROFINET service\'s configuration can be viewed via [listProfinetIOs](listProfinetIOs). For the PROFINET controller, e.g. a connected PLC, refer to the corresponding engineering system, e.g. TIA portal. You can export the variable configuration of the PROFINET controller as XML file from your engineering system, e.g. TIA portal. The endpoint is built so that the perspective of input and output (PROFINET Device\'s input is PROFINET Controller\'s output) is internally handled (PROFINET device input is PROFINET controller output), meaning that you can paste the exported XML file here without modifying.
7262
7559
  * @summary Set PROFINET Inputs/Outputs from File
7263
7560
  * @param {string} cell Unique identifier addressing a cell in all API calls.
7264
7561
  * @param {ProfinetInputOutputConfig} profinetInputOutputConfig
@@ -10725,7 +11022,7 @@ export class MotionGroupApi extends BaseAPI {
10725
11022
  export const MotionGroupModelsApiAxiosParamCreator = function (configuration?: Configuration) {
10726
11023
  return {
10727
11024
  /**
10728
- * Returns the default collision link chain for a given motion group model. See [getMotionGroupDescription](getMotionGroupDescription) for supported motion group models. The default link chain is derived from 3D models and optimized for collision detection within NOVA. The default link chain includes link shapes only. It does not include any attached components like wire feeders or sensors. Use the `stored_link_chain` or `link_chain` field in [storeCollisionScene](storeCollisionScene) to attach additional shapes to the link reference frames. Additional shapes may overlap each other per link and may also overlap the respective link\'s default shape.
11025
+ * Returns the default collision link chain for a given motion group model. See [getMotionGroupModels](getMotionGroupModels) for supported motion group models. The default link chain is derived from 3D models and optimized for collision detection within NOVA. The default link chain includes link shapes only. It does not include any attached components like wire feeders or sensors. Attach additional shapes to the link reference frames by extending the link dictionaries before further use. Additional shapes may overlap each other per link and may also overlap the respective link\'s default shape.
10729
11026
  * @summary Get Collision Model
10730
11027
  * @param {string} cell Unique identifier addressing a cell in all API calls.
10731
11028
  * @param {string} motionGroupModel Unique identifier for the model of a motion group, e.g. &#x60;UniversalRobots_UR10e&#x60;. Get the &#x60;model&#x60; of a configured motion group with [getOptimizerConfiguration](getOptimizerConfiguration).
@@ -10823,7 +11120,7 @@ export const MotionGroupModelsApiFp = function(configuration?: Configuration) {
10823
11120
  const localVarAxiosParamCreator = MotionGroupModelsApiAxiosParamCreator(configuration)
10824
11121
  return {
10825
11122
  /**
10826
- * Returns the default collision link chain for a given motion group model. See [getMotionGroupDescription](getMotionGroupDescription) for supported motion group models. The default link chain is derived from 3D models and optimized for collision detection within NOVA. The default link chain includes link shapes only. It does not include any attached components like wire feeders or sensors. Use the `stored_link_chain` or `link_chain` field in [storeCollisionScene](storeCollisionScene) to attach additional shapes to the link reference frames. Additional shapes may overlap each other per link and may also overlap the respective link\'s default shape.
11123
+ * Returns the default collision link chain for a given motion group model. See [getMotionGroupModels](getMotionGroupModels) for supported motion group models. The default link chain is derived from 3D models and optimized for collision detection within NOVA. The default link chain includes link shapes only. It does not include any attached components like wire feeders or sensors. Attach additional shapes to the link reference frames by extending the link dictionaries before further use. Additional shapes may overlap each other per link and may also overlap the respective link\'s default shape.
10827
11124
  * @summary Get Collision Model
10828
11125
  * @param {string} cell Unique identifier addressing a cell in all API calls.
10829
11126
  * @param {string} motionGroupModel Unique identifier for the model of a motion group, e.g. &#x60;UniversalRobots_UR10e&#x60;. Get the &#x60;model&#x60; of a configured motion group with [getOptimizerConfiguration](getOptimizerConfiguration).
@@ -10860,7 +11157,7 @@ export const MotionGroupModelsApiFactory = function (configuration?: Configurati
10860
11157
  const localVarFp = MotionGroupModelsApiFp(configuration)
10861
11158
  return {
10862
11159
  /**
10863
- * Returns the default collision link chain for a given motion group model. See [getMotionGroupDescription](getMotionGroupDescription) for supported motion group models. The default link chain is derived from 3D models and optimized for collision detection within NOVA. The default link chain includes link shapes only. It does not include any attached components like wire feeders or sensors. Use the `stored_link_chain` or `link_chain` field in [storeCollisionScene](storeCollisionScene) to attach additional shapes to the link reference frames. Additional shapes may overlap each other per link and may also overlap the respective link\'s default shape.
11160
+ * Returns the default collision link chain for a given motion group model. See [getMotionGroupModels](getMotionGroupModels) for supported motion group models. The default link chain is derived from 3D models and optimized for collision detection within NOVA. The default link chain includes link shapes only. It does not include any attached components like wire feeders or sensors. Attach additional shapes to the link reference frames by extending the link dictionaries before further use. Additional shapes may overlap each other per link and may also overlap the respective link\'s default shape.
10864
11161
  * @summary Get Collision Model
10865
11162
  * @param {string} cell Unique identifier addressing a cell in all API calls.
10866
11163
  * @param {string} motionGroupModel Unique identifier for the model of a motion group, e.g. &#x60;UniversalRobots_UR10e&#x60;. Get the &#x60;model&#x60; of a configured motion group with [getOptimizerConfiguration](getOptimizerConfiguration).
@@ -10891,7 +11188,7 @@ export const MotionGroupModelsApiFactory = function (configuration?: Configurati
10891
11188
  */
10892
11189
  export class MotionGroupModelsApi extends BaseAPI {
10893
11190
  /**
10894
- * Returns the default collision link chain for a given motion group model. See [getMotionGroupDescription](getMotionGroupDescription) for supported motion group models. The default link chain is derived from 3D models and optimized for collision detection within NOVA. The default link chain includes link shapes only. It does not include any attached components like wire feeders or sensors. Use the `stored_link_chain` or `link_chain` field in [storeCollisionScene](storeCollisionScene) to attach additional shapes to the link reference frames. Additional shapes may overlap each other per link and may also overlap the respective link\'s default shape.
11191
+ * Returns the default collision link chain for a given motion group model. See [getMotionGroupModels](getMotionGroupModels) for supported motion group models. The default link chain is derived from 3D models and optimized for collision detection within NOVA. The default link chain includes link shapes only. It does not include any attached components like wire feeders or sensors. Attach additional shapes to the link reference frames by extending the link dictionaries before further use. Additional shapes may overlap each other per link and may also overlap the respective link\'s default shape.
10895
11192
  * @summary Get Collision Model
10896
11193
  * @param {string} cell Unique identifier addressing a cell in all API calls.
10897
11194
  * @param {string} motionGroupModel Unique identifier for the model of a motion group, e.g. &#x60;UniversalRobots_UR10e&#x60;. Get the &#x60;model&#x60; of a configured motion group with [getOptimizerConfiguration](getOptimizerConfiguration).
@@ -10918,6 +11215,383 @@ export class MotionGroupModelsApi extends BaseAPI {
10918
11215
 
10919
11216
 
10920
11217
 
11218
+ /**
11219
+ * ProgramApi - axios parameter creator
11220
+ * @export
11221
+ */
11222
+ export const ProgramApiAxiosParamCreator = function (configuration?: Configuration) {
11223
+ return {
11224
+ /**
11225
+ * Get details of a program.
11226
+ * @summary Get program
11227
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
11228
+ * @param {string} program
11229
+ * @param {*} [options] Override http request option.
11230
+ * @throws {RequiredError}
11231
+ */
11232
+ getProgram: async (cell: string, program: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
11233
+ // verify required parameter 'cell' is not null or undefined
11234
+ assertParamExists('getProgram', 'cell', cell)
11235
+ // verify required parameter 'program' is not null or undefined
11236
+ assertParamExists('getProgram', 'program', program)
11237
+ const localVarPath = `/experimental/cells/{cell}/programs/{program}`
11238
+ .replace(`{${"cell"}}`, encodeURIComponent(String(cell)))
11239
+ .replace(`{${"program"}}`, encodeURIComponent(String(program)));
11240
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
11241
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
11242
+ let baseOptions;
11243
+ if (configuration) {
11244
+ baseOptions = configuration.baseOptions;
11245
+ }
11246
+
11247
+ const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
11248
+ const localVarHeaderParameter = {} as any;
11249
+ const localVarQueryParameter = {} as any;
11250
+
11251
+ // authentication BasicAuth required
11252
+ // http basic authentication required
11253
+ setBasicAuthToObject(localVarRequestOptions, configuration)
11254
+
11255
+ // authentication BearerAuth required
11256
+ // http bearer authentication required
11257
+ await setBearerAuthToObject(localVarHeaderParameter, configuration)
11258
+
11259
+
11260
+
11261
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
11262
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
11263
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
11264
+
11265
+ return {
11266
+ url: toPathString(localVarUrlObj),
11267
+ options: localVarRequestOptions,
11268
+ };
11269
+ },
11270
+ /**
11271
+ * List details of all existing programs.
11272
+ * @summary List programs
11273
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
11274
+ * @param {*} [options] Override http request option.
11275
+ * @throws {RequiredError}
11276
+ */
11277
+ listPrograms: async (cell: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
11278
+ // verify required parameter 'cell' is not null or undefined
11279
+ assertParamExists('listPrograms', 'cell', cell)
11280
+ const localVarPath = `/experimental/cells/{cell}/programs`
11281
+ .replace(`{${"cell"}}`, encodeURIComponent(String(cell)));
11282
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
11283
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
11284
+ let baseOptions;
11285
+ if (configuration) {
11286
+ baseOptions = configuration.baseOptions;
11287
+ }
11288
+
11289
+ const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
11290
+ const localVarHeaderParameter = {} as any;
11291
+ const localVarQueryParameter = {} as any;
11292
+
11293
+ // authentication BasicAuth required
11294
+ // http basic authentication required
11295
+ setBasicAuthToObject(localVarRequestOptions, configuration)
11296
+
11297
+ // authentication BearerAuth required
11298
+ // http bearer authentication required
11299
+ await setBearerAuthToObject(localVarHeaderParameter, configuration)
11300
+
11301
+
11302
+
11303
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
11304
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
11305
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
11306
+
11307
+ return {
11308
+ url: toPathString(localVarUrlObj),
11309
+ options: localVarRequestOptions,
11310
+ };
11311
+ },
11312
+ /**
11313
+ * This endpoint starts a new program execution. The program will be executed asynchronously.
11314
+ * @summary Start the program
11315
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
11316
+ * @param {string} program
11317
+ * @param {ProgramStartRequest} programStartRequest
11318
+ * @param {*} [options] Override http request option.
11319
+ * @throws {RequiredError}
11320
+ */
11321
+ startProgram: async (cell: string, program: string, programStartRequest: ProgramStartRequest, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
11322
+ // verify required parameter 'cell' is not null or undefined
11323
+ assertParamExists('startProgram', 'cell', cell)
11324
+ // verify required parameter 'program' is not null or undefined
11325
+ assertParamExists('startProgram', 'program', program)
11326
+ // verify required parameter 'programStartRequest' is not null or undefined
11327
+ assertParamExists('startProgram', 'programStartRequest', programStartRequest)
11328
+ const localVarPath = `/experimental/cells/{cell}/programs/{program}/start`
11329
+ .replace(`{${"cell"}}`, encodeURIComponent(String(cell)))
11330
+ .replace(`{${"program"}}`, encodeURIComponent(String(program)));
11331
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
11332
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
11333
+ let baseOptions;
11334
+ if (configuration) {
11335
+ baseOptions = configuration.baseOptions;
11336
+ }
11337
+
11338
+ const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
11339
+ const localVarHeaderParameter = {} as any;
11340
+ const localVarQueryParameter = {} as any;
11341
+
11342
+ // authentication BasicAuth required
11343
+ // http basic authentication required
11344
+ setBasicAuthToObject(localVarRequestOptions, configuration)
11345
+
11346
+ // authentication BearerAuth required
11347
+ // http bearer authentication required
11348
+ await setBearerAuthToObject(localVarHeaderParameter, configuration)
11349
+
11350
+
11351
+
11352
+ localVarHeaderParameter['Content-Type'] = 'application/json';
11353
+
11354
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
11355
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
11356
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
11357
+ localVarRequestOptions.data = serializeDataIfNeeded(programStartRequest, localVarRequestOptions, configuration)
11358
+
11359
+ return {
11360
+ url: toPathString(localVarUrlObj),
11361
+ options: localVarRequestOptions,
11362
+ };
11363
+ },
11364
+ /**
11365
+ * Stop a specific program run.
11366
+ * @summary Stop program run
11367
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
11368
+ * @param {string} program
11369
+ * @param {*} [options] Override http request option.
11370
+ * @throws {RequiredError}
11371
+ */
11372
+ stopProgram: async (cell: string, program: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
11373
+ // verify required parameter 'cell' is not null or undefined
11374
+ assertParamExists('stopProgram', 'cell', cell)
11375
+ // verify required parameter 'program' is not null or undefined
11376
+ assertParamExists('stopProgram', 'program', program)
11377
+ const localVarPath = `/experimental/cells/{cell}/programs/{program}/stop`
11378
+ .replace(`{${"cell"}}`, encodeURIComponent(String(cell)))
11379
+ .replace(`{${"program"}}`, encodeURIComponent(String(program)));
11380
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
11381
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
11382
+ let baseOptions;
11383
+ if (configuration) {
11384
+ baseOptions = configuration.baseOptions;
11385
+ }
11386
+
11387
+ const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
11388
+ const localVarHeaderParameter = {} as any;
11389
+ const localVarQueryParameter = {} as any;
11390
+
11391
+ // authentication BasicAuth required
11392
+ // http basic authentication required
11393
+ setBasicAuthToObject(localVarRequestOptions, configuration)
11394
+
11395
+ // authentication BearerAuth required
11396
+ // http bearer authentication required
11397
+ await setBearerAuthToObject(localVarHeaderParameter, configuration)
11398
+
11399
+
11400
+
11401
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
11402
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
11403
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
11404
+
11405
+ return {
11406
+ url: toPathString(localVarUrlObj),
11407
+ options: localVarRequestOptions,
11408
+ };
11409
+ },
11410
+ }
11411
+ };
11412
+
11413
+ /**
11414
+ * ProgramApi - functional programming interface
11415
+ * @export
11416
+ */
11417
+ export const ProgramApiFp = function(configuration?: Configuration) {
11418
+ const localVarAxiosParamCreator = ProgramApiAxiosParamCreator(configuration)
11419
+ return {
11420
+ /**
11421
+ * Get details of a program.
11422
+ * @summary Get program
11423
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
11424
+ * @param {string} program
11425
+ * @param {*} [options] Override http request option.
11426
+ * @throws {RequiredError}
11427
+ */
11428
+ async getProgram(cell: string, program: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Program>> {
11429
+ const localVarAxiosArgs = await localVarAxiosParamCreator.getProgram(cell, program, options);
11430
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
11431
+ const localVarOperationServerBasePath = operationServerMap['ProgramApi.getProgram']?.[localVarOperationServerIndex]?.url;
11432
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
11433
+ },
11434
+ /**
11435
+ * List details of all existing programs.
11436
+ * @summary List programs
11437
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
11438
+ * @param {*} [options] Override http request option.
11439
+ * @throws {RequiredError}
11440
+ */
11441
+ async listPrograms(cell: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<Program>>> {
11442
+ const localVarAxiosArgs = await localVarAxiosParamCreator.listPrograms(cell, options);
11443
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
11444
+ const localVarOperationServerBasePath = operationServerMap['ProgramApi.listPrograms']?.[localVarOperationServerIndex]?.url;
11445
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
11446
+ },
11447
+ /**
11448
+ * This endpoint starts a new program execution. The program will be executed asynchronously.
11449
+ * @summary Start the program
11450
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
11451
+ * @param {string} program
11452
+ * @param {ProgramStartRequest} programStartRequest
11453
+ * @param {*} [options] Override http request option.
11454
+ * @throws {RequiredError}
11455
+ */
11456
+ async startProgram(cell: string, program: string, programStartRequest: ProgramStartRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ProgramRun>> {
11457
+ const localVarAxiosArgs = await localVarAxiosParamCreator.startProgram(cell, program, programStartRequest, options);
11458
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
11459
+ const localVarOperationServerBasePath = operationServerMap['ProgramApi.startProgram']?.[localVarOperationServerIndex]?.url;
11460
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
11461
+ },
11462
+ /**
11463
+ * Stop a specific program run.
11464
+ * @summary Stop program run
11465
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
11466
+ * @param {string} program
11467
+ * @param {*} [options] Override http request option.
11468
+ * @throws {RequiredError}
11469
+ */
11470
+ async stopProgram(cell: string, program: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> {
11471
+ const localVarAxiosArgs = await localVarAxiosParamCreator.stopProgram(cell, program, options);
11472
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
11473
+ const localVarOperationServerBasePath = operationServerMap['ProgramApi.stopProgram']?.[localVarOperationServerIndex]?.url;
11474
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
11475
+ },
11476
+ }
11477
+ };
11478
+
11479
+ /**
11480
+ * ProgramApi - factory interface
11481
+ * @export
11482
+ */
11483
+ export const ProgramApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
11484
+ const localVarFp = ProgramApiFp(configuration)
11485
+ return {
11486
+ /**
11487
+ * Get details of a program.
11488
+ * @summary Get program
11489
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
11490
+ * @param {string} program
11491
+ * @param {*} [options] Override http request option.
11492
+ * @throws {RequiredError}
11493
+ */
11494
+ getProgram(cell: string, program: string, options?: RawAxiosRequestConfig): AxiosPromise<Program> {
11495
+ return localVarFp.getProgram(cell, program, options).then((request) => request(axios, basePath));
11496
+ },
11497
+ /**
11498
+ * List details of all existing programs.
11499
+ * @summary List programs
11500
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
11501
+ * @param {*} [options] Override http request option.
11502
+ * @throws {RequiredError}
11503
+ */
11504
+ listPrograms(cell: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<Program>> {
11505
+ return localVarFp.listPrograms(cell, options).then((request) => request(axios, basePath));
11506
+ },
11507
+ /**
11508
+ * This endpoint starts a new program execution. The program will be executed asynchronously.
11509
+ * @summary Start the program
11510
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
11511
+ * @param {string} program
11512
+ * @param {ProgramStartRequest} programStartRequest
11513
+ * @param {*} [options] Override http request option.
11514
+ * @throws {RequiredError}
11515
+ */
11516
+ startProgram(cell: string, program: string, programStartRequest: ProgramStartRequest, options?: RawAxiosRequestConfig): AxiosPromise<ProgramRun> {
11517
+ return localVarFp.startProgram(cell, program, programStartRequest, options).then((request) => request(axios, basePath));
11518
+ },
11519
+ /**
11520
+ * Stop a specific program run.
11521
+ * @summary Stop program run
11522
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
11523
+ * @param {string} program
11524
+ * @param {*} [options] Override http request option.
11525
+ * @throws {RequiredError}
11526
+ */
11527
+ stopProgram(cell: string, program: string, options?: RawAxiosRequestConfig): AxiosPromise<void> {
11528
+ return localVarFp.stopProgram(cell, program, options).then((request) => request(axios, basePath));
11529
+ },
11530
+ };
11531
+ };
11532
+
11533
+ /**
11534
+ * ProgramApi - object-oriented interface
11535
+ * @export
11536
+ * @class ProgramApi
11537
+ * @extends {BaseAPI}
11538
+ */
11539
+ export class ProgramApi extends BaseAPI {
11540
+ /**
11541
+ * Get details of a program.
11542
+ * @summary Get program
11543
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
11544
+ * @param {string} program
11545
+ * @param {*} [options] Override http request option.
11546
+ * @throws {RequiredError}
11547
+ * @memberof ProgramApi
11548
+ */
11549
+ public getProgram(cell: string, program: string, options?: RawAxiosRequestConfig) {
11550
+ return ProgramApiFp(this.configuration).getProgram(cell, program, options).then((request) => request(this.axios, this.basePath));
11551
+ }
11552
+
11553
+ /**
11554
+ * List details of all existing programs.
11555
+ * @summary List programs
11556
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
11557
+ * @param {*} [options] Override http request option.
11558
+ * @throws {RequiredError}
11559
+ * @memberof ProgramApi
11560
+ */
11561
+ public listPrograms(cell: string, options?: RawAxiosRequestConfig) {
11562
+ return ProgramApiFp(this.configuration).listPrograms(cell, options).then((request) => request(this.axios, this.basePath));
11563
+ }
11564
+
11565
+ /**
11566
+ * This endpoint starts a new program execution. The program will be executed asynchronously.
11567
+ * @summary Start the program
11568
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
11569
+ * @param {string} program
11570
+ * @param {ProgramStartRequest} programStartRequest
11571
+ * @param {*} [options] Override http request option.
11572
+ * @throws {RequiredError}
11573
+ * @memberof ProgramApi
11574
+ */
11575
+ public startProgram(cell: string, program: string, programStartRequest: ProgramStartRequest, options?: RawAxiosRequestConfig) {
11576
+ return ProgramApiFp(this.configuration).startProgram(cell, program, programStartRequest, options).then((request) => request(this.axios, this.basePath));
11577
+ }
11578
+
11579
+ /**
11580
+ * Stop a specific program run.
11581
+ * @summary Stop program run
11582
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
11583
+ * @param {string} program
11584
+ * @param {*} [options] Override http request option.
11585
+ * @throws {RequiredError}
11586
+ * @memberof ProgramApi
11587
+ */
11588
+ public stopProgram(cell: string, program: string, options?: RawAxiosRequestConfig) {
11589
+ return ProgramApiFp(this.configuration).stopProgram(cell, program, options).then((request) => request(this.axios, this.basePath));
11590
+ }
11591
+ }
11592
+
11593
+
11594
+
10921
11595
  /**
10922
11596
  * StoreCollisionComponentsApi - axios parameter creator
10923
11597
  * @export
@@ -11243,7 +11917,7 @@ export const StoreCollisionComponentsApiAxiosParamCreator = function (configurat
11243
11917
  };
11244
11918
  },
11245
11919
  /**
11246
- * Returns a list of colliders in a scene. This excludes colliders that are part of a motion group.
11920
+ * Returns all stored colliders.
11247
11921
  * @summary List Colliders
11248
11922
  * @param {string} cell Unique identifier addressing a cell in all API calls.
11249
11923
  * @param {*} [options] Override http request option.
@@ -11590,7 +12264,7 @@ export const StoreCollisionComponentsApiFp = function(configuration?: Configurat
11590
12264
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
11591
12265
  },
11592
12266
  /**
11593
- * Returns a list of colliders in a scene. This excludes colliders that are part of a motion group.
12267
+ * Returns all stored colliders.
11594
12268
  * @summary List Colliders
11595
12269
  * @param {string} cell Unique identifier addressing a cell in all API calls.
11596
12270
  * @param {*} [options] Override http request option.
@@ -11747,7 +12421,7 @@ export const StoreCollisionComponentsApiFactory = function (configuration?: Conf
11747
12421
  return localVarFp.listCollisionLinkChains(cell, options).then((request) => request(axios, basePath));
11748
12422
  },
11749
12423
  /**
11750
- * Returns a list of colliders in a scene. This excludes colliders that are part of a motion group.
12424
+ * Returns all stored colliders.
11751
12425
  * @summary List Colliders
11752
12426
  * @param {string} cell Unique identifier addressing a cell in all API calls.
11753
12427
  * @param {*} [options] Override http request option.
@@ -11903,7 +12577,7 @@ export class StoreCollisionComponentsApi extends BaseAPI {
11903
12577
  }
11904
12578
 
11905
12579
  /**
11906
- * Returns a list of colliders in a scene. This excludes colliders that are part of a motion group.
12580
+ * Returns all stored colliders.
11907
12581
  * @summary List Colliders
11908
12582
  * @param {string} cell Unique identifier addressing a cell in all API calls.
11909
12583
  * @param {*} [options] Override http request option.
@@ -14459,7 +15133,7 @@ export class TrajectoryPlanningApi extends BaseAPI {
14459
15133
  export const VirtualControllerApiAxiosParamCreator = function (configuration?: Configuration) {
14460
15134
  return {
14461
15135
  /**
14462
- * Adds a coordinate system to the robot controller.
15136
+ * Adds a coordinate system to the robot controller. **Important notes:** - When a new coordinate system is added/removed, the **virtual robot is restarted** in the background in order to apply the new configuration. - During this restart: - Robot visualization may temporarily disappear or appear outdated in the UI. - coordinate system changes are not immediately visible in visualizations. - All existing connections to the virtual robot are closed and re-established, which introduces a short delay before the system is fully operational again. - The API call itself does **not wait until the restart and re-synchronization are complete**. This means that immediately after a successful response, the new coordinate system may not yet be available for visualization or program execution.
14463
15137
  * @summary Add Coordinate Systems
14464
15138
  * @param {string} cell Unique identifier addressing a cell in all API calls.
14465
15139
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -14515,7 +15189,7 @@ export const VirtualControllerApiAxiosParamCreator = function (configuration?: C
14515
15189
  };
14516
15190
  },
14517
15191
  /**
14518
- * Adds a new TCP or updates an existing TCP in the motion group. The position and rotation values in the request body are defined within the flanges coordinate system. > **NOTE** > > Ensure the TCP\'s position is within the robot\'s reach. Refer to the robots documentation or data sheet for details like joint limits or reach.
15192
+ * Adds a new TCP (Tool Center Point) or updates an existing TCP in the motion group. The position and rotation values in the request body are defined within the flange\'s coordinate system. > **NOTE** > Ensure the TCP\'s position is within the robot\'s reach. Refer to the robot\'s documentation or data sheet for details like joint limits or reach. **Important notes:** - Adding or updating a TCP triggers a **virtual robot restart** to apply the new configuration. - During this restart: - The robot visualization in the UI may temporarily disappear. - The TCP visualization may not immediately appear, or may look outdated during the first test/rerun. - All active connections to the virtual robot are closed and then re-established. This creates a delay before the TCP is available in both the UI and robot programs. - The API call itself does **not wait until the restart and synchronization are complete**. Even if the request succeeds, the new or updated TCP may not yet be visible in the GUI or available for use.
14519
15193
  * @summary Add TCP
14520
15194
  * @param {string} cell Unique identifier addressing a cell in all API calls.
14521
15195
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -14575,8 +15249,8 @@ export const VirtualControllerApiAxiosParamCreator = function (configuration?: C
14575
15249
  };
14576
15250
  },
14577
15251
  /**
14578
- * Deletes a coordinate system from the virtual controller. This will remove the coordinate system from the list of coordinate systems and remove all dependent coordinate systems which use the deleted coordinate system as reference.
14579
- * @summary Remove Coordinate System
15252
+ * Deletes a coordinate system from the virtual controller. This will remove the coordinate system from the list of coordinate systems and also remove all dependent coordinate systems that use the deleted coordinate system as reference. **Important notes:** - When a new coordinate system is added/removed, the **virtual robot is restarted** in the background in order to apply the new configuration. - During this restart: - Robot visualization may temporarily disappear or appear outdated in the UI. - coordinate system changes are not immediately visible in visualizations. - All existing connections to the virtual robot are closed and re-established, which introduces a short delay before the system is fully operational again. - The API call itself does **not wait until the restart and re-synchronization are complete**. This means that immediately after a successful response, the new coordinate system may not yet be available for visualization or program execution.
15253
+ * @summary Delete Coordinate System
14580
15254
  * @param {string} cell Unique identifier addressing a cell in all API calls.
14581
15255
  * @param {string} controller Unique identifier to address a controller in the cell.
14582
15256
  * @param {string} coordinateSystem Unique identifier addressing a coordinate system.
@@ -14630,7 +15304,7 @@ export const VirtualControllerApiAxiosParamCreator = function (configuration?: C
14630
15304
  };
14631
15305
  },
14632
15306
  /**
14633
- * Removes the TCP from the motion group. An unknown TCP is a valid input.
15307
+ * Removes the TCP (Tool Center Point) from the motion group. An unknown TCP is a valid input and will simply be ignored. **Important notes:** - Removing or updating a TCP triggers a **virtual robot restart** to apply the new configuration. - During this restart: - The robot visualization in the UI may temporarily disappear. - The TCP visualization may not immediately appear, or may look outdated during the first test/rerun. - All active connections to the virtual robot are closed and then re-established. This creates a delay before the TCP is available in both the UI and robot programs. - The API call itself does **not wait until the restart and synchronization are complete**. Even if the request succeeds, the new or updated TCP may not yet be visible in the GUI or available for use.
14634
15308
  * @summary Remove TCP
14635
15309
  * @param {string} cell Unique identifier addressing a cell in all API calls.
14636
15310
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -15178,7 +15852,7 @@ export const VirtualControllerApiAxiosParamCreator = function (configuration?: C
15178
15852
  };
15179
15853
  },
15180
15854
  /**
15181
- * Sets motion group mounting by specifying a coordinate system. The motion group will be based on the coordinate system\'s origin. The coordinate system defines a transformation offset. The transformation offset is defined by a unique identifier, a name for front end usage and an offset in another coordinate system referenced by the unique identifier of the reference coordinate system.
15855
+ * Sets the motion group mounting by specifying a coordinate system. The motion group will be based on the coordinate system\'s origin. The coordinate system defines a transformation offset, which consists of: - A unique identifier - A user-facing name - An offset in another coordinate system, referenced by the unique identifier of the reference coordinate system. **Important notes:** - Changing the mounting configuration is treated as a setup change. - When the mounting is set to a new coordinate system, the **virtual robot restarts** in the background to apply the new configuration. - During this process: - Robot visualization may temporarily disappear or not reflect the new mounting immediately. - Motion group state and coordinate system alignment may not be instantly updated in the UI. - All connections to the virtual robot are closed and then re-established, which can cause a short delay before the system is ready again. - The API call itself does **not wait until the restart and synchronization are complete**. A successful response indicates that the request was accepted, but the updated mounting may not yet be visible.
15182
15856
  * @summary Set Mounting
15183
15857
  * @param {string} cell Unique identifier addressing a cell in all API calls.
15184
15858
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -15244,7 +15918,7 @@ export const VirtualControllerApiFp = function(configuration?: Configuration) {
15244
15918
  const localVarAxiosParamCreator = VirtualControllerApiAxiosParamCreator(configuration)
15245
15919
  return {
15246
15920
  /**
15247
- * Adds a coordinate system to the robot controller.
15921
+ * Adds a coordinate system to the robot controller. **Important notes:** - When a new coordinate system is added/removed, the **virtual robot is restarted** in the background in order to apply the new configuration. - During this restart: - Robot visualization may temporarily disappear or appear outdated in the UI. - coordinate system changes are not immediately visible in visualizations. - All existing connections to the virtual robot are closed and re-established, which introduces a short delay before the system is fully operational again. - The API call itself does **not wait until the restart and re-synchronization are complete**. This means that immediately after a successful response, the new coordinate system may not yet be available for visualization or program execution.
15248
15922
  * @summary Add Coordinate Systems
15249
15923
  * @param {string} cell Unique identifier addressing a cell in all API calls.
15250
15924
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -15260,7 +15934,7 @@ export const VirtualControllerApiFp = function(configuration?: Configuration) {
15260
15934
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
15261
15935
  },
15262
15936
  /**
15263
- * Adds a new TCP or updates an existing TCP in the motion group. The position and rotation values in the request body are defined within the flanges coordinate system. > **NOTE** > > Ensure the TCP\'s position is within the robot\'s reach. Refer to the robots documentation or data sheet for details like joint limits or reach.
15937
+ * Adds a new TCP (Tool Center Point) or updates an existing TCP in the motion group. The position and rotation values in the request body are defined within the flange\'s coordinate system. > **NOTE** > Ensure the TCP\'s position is within the robot\'s reach. Refer to the robot\'s documentation or data sheet for details like joint limits or reach. **Important notes:** - Adding or updating a TCP triggers a **virtual robot restart** to apply the new configuration. - During this restart: - The robot visualization in the UI may temporarily disappear. - The TCP visualization may not immediately appear, or may look outdated during the first test/rerun. - All active connections to the virtual robot are closed and then re-established. This creates a delay before the TCP is available in both the UI and robot programs. - The API call itself does **not wait until the restart and synchronization are complete**. Even if the request succeeds, the new or updated TCP may not yet be visible in the GUI or available for use.
15264
15938
  * @summary Add TCP
15265
15939
  * @param {string} cell Unique identifier addressing a cell in all API calls.
15266
15940
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -15277,8 +15951,8 @@ export const VirtualControllerApiFp = function(configuration?: Configuration) {
15277
15951
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
15278
15952
  },
15279
15953
  /**
15280
- * Deletes a coordinate system from the virtual controller. This will remove the coordinate system from the list of coordinate systems and remove all dependent coordinate systems which use the deleted coordinate system as reference.
15281
- * @summary Remove Coordinate System
15954
+ * Deletes a coordinate system from the virtual controller. This will remove the coordinate system from the list of coordinate systems and also remove all dependent coordinate systems that use the deleted coordinate system as reference. **Important notes:** - When a new coordinate system is added/removed, the **virtual robot is restarted** in the background in order to apply the new configuration. - During this restart: - Robot visualization may temporarily disappear or appear outdated in the UI. - coordinate system changes are not immediately visible in visualizations. - All existing connections to the virtual robot are closed and re-established, which introduces a short delay before the system is fully operational again. - The API call itself does **not wait until the restart and re-synchronization are complete**. This means that immediately after a successful response, the new coordinate system may not yet be available for visualization or program execution.
15955
+ * @summary Delete Coordinate System
15282
15956
  * @param {string} cell Unique identifier addressing a cell in all API calls.
15283
15957
  * @param {string} controller Unique identifier to address a controller in the cell.
15284
15958
  * @param {string} coordinateSystem Unique identifier addressing a coordinate system.
@@ -15293,7 +15967,7 @@ export const VirtualControllerApiFp = function(configuration?: Configuration) {
15293
15967
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
15294
15968
  },
15295
15969
  /**
15296
- * Removes the TCP from the motion group. An unknown TCP is a valid input.
15970
+ * Removes the TCP (Tool Center Point) from the motion group. An unknown TCP is a valid input and will simply be ignored. **Important notes:** - Removing or updating a TCP triggers a **virtual robot restart** to apply the new configuration. - During this restart: - The robot visualization in the UI may temporarily disappear. - The TCP visualization may not immediately appear, or may look outdated during the first test/rerun. - All active connections to the virtual robot are closed and then re-established. This creates a delay before the TCP is available in both the UI and robot programs. - The API call itself does **not wait until the restart and synchronization are complete**. Even if the request succeeds, the new or updated TCP may not yet be visible in the GUI or available for use.
15297
15971
  * @summary Remove TCP
15298
15972
  * @param {string} cell Unique identifier addressing a cell in all API calls.
15299
15973
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -15456,7 +16130,7 @@ export const VirtualControllerApiFp = function(configuration?: Configuration) {
15456
16130
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
15457
16131
  },
15458
16132
  /**
15459
- * Sets motion group mounting by specifying a coordinate system. The motion group will be based on the coordinate system\'s origin. The coordinate system defines a transformation offset. The transformation offset is defined by a unique identifier, a name for front end usage and an offset in another coordinate system referenced by the unique identifier of the reference coordinate system.
16133
+ * Sets the motion group mounting by specifying a coordinate system. The motion group will be based on the coordinate system\'s origin. The coordinate system defines a transformation offset, which consists of: - A unique identifier - A user-facing name - An offset in another coordinate system, referenced by the unique identifier of the reference coordinate system. **Important notes:** - Changing the mounting configuration is treated as a setup change. - When the mounting is set to a new coordinate system, the **virtual robot restarts** in the background to apply the new configuration. - During this process: - Robot visualization may temporarily disappear or not reflect the new mounting immediately. - Motion group state and coordinate system alignment may not be instantly updated in the UI. - All connections to the virtual robot are closed and then re-established, which can cause a short delay before the system is ready again. - The API call itself does **not wait until the restart and synchronization are complete**. A successful response indicates that the request was accepted, but the updated mounting may not yet be visible.
15460
16134
  * @summary Set Mounting
15461
16135
  * @param {string} cell Unique identifier addressing a cell in all API calls.
15462
16136
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -15482,7 +16156,7 @@ export const VirtualControllerApiFactory = function (configuration?: Configurati
15482
16156
  const localVarFp = VirtualControllerApiFp(configuration)
15483
16157
  return {
15484
16158
  /**
15485
- * Adds a coordinate system to the robot controller.
16159
+ * Adds a coordinate system to the robot controller. **Important notes:** - When a new coordinate system is added/removed, the **virtual robot is restarted** in the background in order to apply the new configuration. - During this restart: - Robot visualization may temporarily disappear or appear outdated in the UI. - coordinate system changes are not immediately visible in visualizations. - All existing connections to the virtual robot are closed and re-established, which introduces a short delay before the system is fully operational again. - The API call itself does **not wait until the restart and re-synchronization are complete**. This means that immediately after a successful response, the new coordinate system may not yet be available for visualization or program execution.
15486
16160
  * @summary Add Coordinate Systems
15487
16161
  * @param {string} cell Unique identifier addressing a cell in all API calls.
15488
16162
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -15495,7 +16169,7 @@ export const VirtualControllerApiFactory = function (configuration?: Configurati
15495
16169
  return localVarFp.addVirtualControllerCoordinateSystem(cell, controller, coordinateSystem, coordinateSystemData, options).then((request) => request(axios, basePath));
15496
16170
  },
15497
16171
  /**
15498
- * Adds a new TCP or updates an existing TCP in the motion group. The position and rotation values in the request body are defined within the flanges coordinate system. > **NOTE** > > Ensure the TCP\'s position is within the robot\'s reach. Refer to the robots documentation or data sheet for details like joint limits or reach.
16172
+ * Adds a new TCP (Tool Center Point) or updates an existing TCP in the motion group. The position and rotation values in the request body are defined within the flange\'s coordinate system. > **NOTE** > Ensure the TCP\'s position is within the robot\'s reach. Refer to the robot\'s documentation or data sheet for details like joint limits or reach. **Important notes:** - Adding or updating a TCP triggers a **virtual robot restart** to apply the new configuration. - During this restart: - The robot visualization in the UI may temporarily disappear. - The TCP visualization may not immediately appear, or may look outdated during the first test/rerun. - All active connections to the virtual robot are closed and then re-established. This creates a delay before the TCP is available in both the UI and robot programs. - The API call itself does **not wait until the restart and synchronization are complete**. Even if the request succeeds, the new or updated TCP may not yet be visible in the GUI or available for use.
15499
16173
  * @summary Add TCP
15500
16174
  * @param {string} cell Unique identifier addressing a cell in all API calls.
15501
16175
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -15509,8 +16183,8 @@ export const VirtualControllerApiFactory = function (configuration?: Configurati
15509
16183
  return localVarFp.addVirtualControllerTcp(cell, controller, motionGroup, tcp, robotTcpData, options).then((request) => request(axios, basePath));
15510
16184
  },
15511
16185
  /**
15512
- * Deletes a coordinate system from the virtual controller. This will remove the coordinate system from the list of coordinate systems and remove all dependent coordinate systems which use the deleted coordinate system as reference.
15513
- * @summary Remove Coordinate System
16186
+ * Deletes a coordinate system from the virtual controller. This will remove the coordinate system from the list of coordinate systems and also remove all dependent coordinate systems that use the deleted coordinate system as reference. **Important notes:** - When a new coordinate system is added/removed, the **virtual robot is restarted** in the background in order to apply the new configuration. - During this restart: - Robot visualization may temporarily disappear or appear outdated in the UI. - coordinate system changes are not immediately visible in visualizations. - All existing connections to the virtual robot are closed and re-established, which introduces a short delay before the system is fully operational again. - The API call itself does **not wait until the restart and re-synchronization are complete**. This means that immediately after a successful response, the new coordinate system may not yet be available for visualization or program execution.
16187
+ * @summary Delete Coordinate System
15514
16188
  * @param {string} cell Unique identifier addressing a cell in all API calls.
15515
16189
  * @param {string} controller Unique identifier to address a controller in the cell.
15516
16190
  * @param {string} coordinateSystem Unique identifier addressing a coordinate system.
@@ -15522,7 +16196,7 @@ export const VirtualControllerApiFactory = function (configuration?: Configurati
15522
16196
  return localVarFp.deleteVirtualControllerCoordinateSystem(cell, controller, coordinateSystem, deleteDependent, options).then((request) => request(axios, basePath));
15523
16197
  },
15524
16198
  /**
15525
- * Removes the TCP from the motion group. An unknown TCP is a valid input.
16199
+ * Removes the TCP (Tool Center Point) from the motion group. An unknown TCP is a valid input and will simply be ignored. **Important notes:** - Removing or updating a TCP triggers a **virtual robot restart** to apply the new configuration. - During this restart: - The robot visualization in the UI may temporarily disappear. - The TCP visualization may not immediately appear, or may look outdated during the first test/rerun. - All active connections to the virtual robot are closed and then re-established. This creates a delay before the TCP is available in both the UI and robot programs. - The API call itself does **not wait until the restart and synchronization are complete**. Even if the request succeeds, the new or updated TCP may not yet be visible in the GUI or available for use.
15526
16200
  * @summary Remove TCP
15527
16201
  * @param {string} cell Unique identifier addressing a cell in all API calls.
15528
16202
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -15652,7 +16326,7 @@ export const VirtualControllerApiFactory = function (configuration?: Configurati
15652
16326
  return localVarFp.setOperationMode(cell, controller, mode, options).then((request) => request(axios, basePath));
15653
16327
  },
15654
16328
  /**
15655
- * Sets motion group mounting by specifying a coordinate system. The motion group will be based on the coordinate system\'s origin. The coordinate system defines a transformation offset. The transformation offset is defined by a unique identifier, a name for front end usage and an offset in another coordinate system referenced by the unique identifier of the reference coordinate system.
16329
+ * Sets the motion group mounting by specifying a coordinate system. The motion group will be based on the coordinate system\'s origin. The coordinate system defines a transformation offset, which consists of: - A unique identifier - A user-facing name - An offset in another coordinate system, referenced by the unique identifier of the reference coordinate system. **Important notes:** - Changing the mounting configuration is treated as a setup change. - When the mounting is set to a new coordinate system, the **virtual robot restarts** in the background to apply the new configuration. - During this process: - Robot visualization may temporarily disappear or not reflect the new mounting immediately. - Motion group state and coordinate system alignment may not be instantly updated in the UI. - All connections to the virtual robot are closed and then re-established, which can cause a short delay before the system is ready again. - The API call itself does **not wait until the restart and synchronization are complete**. A successful response indicates that the request was accepted, but the updated mounting may not yet be visible.
15656
16330
  * @summary Set Mounting
15657
16331
  * @param {string} cell Unique identifier addressing a cell in all API calls.
15658
16332
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -15675,7 +16349,7 @@ export const VirtualControllerApiFactory = function (configuration?: Configurati
15675
16349
  */
15676
16350
  export class VirtualControllerApi extends BaseAPI {
15677
16351
  /**
15678
- * Adds a coordinate system to the robot controller.
16352
+ * Adds a coordinate system to the robot controller. **Important notes:** - When a new coordinate system is added/removed, the **virtual robot is restarted** in the background in order to apply the new configuration. - During this restart: - Robot visualization may temporarily disappear or appear outdated in the UI. - coordinate system changes are not immediately visible in visualizations. - All existing connections to the virtual robot are closed and re-established, which introduces a short delay before the system is fully operational again. - The API call itself does **not wait until the restart and re-synchronization are complete**. This means that immediately after a successful response, the new coordinate system may not yet be available for visualization or program execution.
15679
16353
  * @summary Add Coordinate Systems
15680
16354
  * @param {string} cell Unique identifier addressing a cell in all API calls.
15681
16355
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -15690,7 +16364,7 @@ export class VirtualControllerApi extends BaseAPI {
15690
16364
  }
15691
16365
 
15692
16366
  /**
15693
- * Adds a new TCP or updates an existing TCP in the motion group. The position and rotation values in the request body are defined within the flanges coordinate system. > **NOTE** > > Ensure the TCP\'s position is within the robot\'s reach. Refer to the robots documentation or data sheet for details like joint limits or reach.
16367
+ * Adds a new TCP (Tool Center Point) or updates an existing TCP in the motion group. The position and rotation values in the request body are defined within the flange\'s coordinate system. > **NOTE** > Ensure the TCP\'s position is within the robot\'s reach. Refer to the robot\'s documentation or data sheet for details like joint limits or reach. **Important notes:** - Adding or updating a TCP triggers a **virtual robot restart** to apply the new configuration. - During this restart: - The robot visualization in the UI may temporarily disappear. - The TCP visualization may not immediately appear, or may look outdated during the first test/rerun. - All active connections to the virtual robot are closed and then re-established. This creates a delay before the TCP is available in both the UI and robot programs. - The API call itself does **not wait until the restart and synchronization are complete**. Even if the request succeeds, the new or updated TCP may not yet be visible in the GUI or available for use.
15694
16368
  * @summary Add TCP
15695
16369
  * @param {string} cell Unique identifier addressing a cell in all API calls.
15696
16370
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -15706,8 +16380,8 @@ export class VirtualControllerApi extends BaseAPI {
15706
16380
  }
15707
16381
 
15708
16382
  /**
15709
- * Deletes a coordinate system from the virtual controller. This will remove the coordinate system from the list of coordinate systems and remove all dependent coordinate systems which use the deleted coordinate system as reference.
15710
- * @summary Remove Coordinate System
16383
+ * Deletes a coordinate system from the virtual controller. This will remove the coordinate system from the list of coordinate systems and also remove all dependent coordinate systems that use the deleted coordinate system as reference. **Important notes:** - When a new coordinate system is added/removed, the **virtual robot is restarted** in the background in order to apply the new configuration. - During this restart: - Robot visualization may temporarily disappear or appear outdated in the UI. - coordinate system changes are not immediately visible in visualizations. - All existing connections to the virtual robot are closed and re-established, which introduces a short delay before the system is fully operational again. - The API call itself does **not wait until the restart and re-synchronization are complete**. This means that immediately after a successful response, the new coordinate system may not yet be available for visualization or program execution.
16384
+ * @summary Delete Coordinate System
15711
16385
  * @param {string} cell Unique identifier addressing a cell in all API calls.
15712
16386
  * @param {string} controller Unique identifier to address a controller in the cell.
15713
16387
  * @param {string} coordinateSystem Unique identifier addressing a coordinate system.
@@ -15721,7 +16395,7 @@ export class VirtualControllerApi extends BaseAPI {
15721
16395
  }
15722
16396
 
15723
16397
  /**
15724
- * Removes the TCP from the motion group. An unknown TCP is a valid input.
16398
+ * Removes the TCP (Tool Center Point) from the motion group. An unknown TCP is a valid input and will simply be ignored. **Important notes:** - Removing or updating a TCP triggers a **virtual robot restart** to apply the new configuration. - During this restart: - The robot visualization in the UI may temporarily disappear. - The TCP visualization may not immediately appear, or may look outdated during the first test/rerun. - All active connections to the virtual robot are closed and then re-established. This creates a delay before the TCP is available in both the UI and robot programs. - The API call itself does **not wait until the restart and synchronization are complete**. Even if the request succeeds, the new or updated TCP may not yet be visible in the GUI or available for use.
15725
16399
  * @summary Remove TCP
15726
16400
  * @param {string} cell Unique identifier addressing a cell in all API calls.
15727
16401
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -15873,7 +16547,7 @@ export class VirtualControllerApi extends BaseAPI {
15873
16547
  }
15874
16548
 
15875
16549
  /**
15876
- * Sets motion group mounting by specifying a coordinate system. The motion group will be based on the coordinate system\'s origin. The coordinate system defines a transformation offset. The transformation offset is defined by a unique identifier, a name for front end usage and an offset in another coordinate system referenced by the unique identifier of the reference coordinate system.
16550
+ * Sets the motion group mounting by specifying a coordinate system. The motion group will be based on the coordinate system\'s origin. The coordinate system defines a transformation offset, which consists of: - A unique identifier - A user-facing name - An offset in another coordinate system, referenced by the unique identifier of the reference coordinate system. **Important notes:** - Changing the mounting configuration is treated as a setup change. - When the mounting is set to a new coordinate system, the **virtual robot restarts** in the background to apply the new configuration. - During this process: - Robot visualization may temporarily disappear or not reflect the new mounting immediately. - Motion group state and coordinate system alignment may not be instantly updated in the UI. - All connections to the virtual robot are closed and then re-established, which can cause a short delay before the system is ready again. - The API call itself does **not wait until the restart and synchronization are complete**. A successful response indicates that the request was accepted, but the updated mounting may not yet be visible.
15877
16551
  * @summary Set Mounting
15878
16552
  * @param {string} cell Unique identifier addressing a cell in all API calls.
15879
16553
  * @param {string} controller Unique identifier to address a controller in the cell.