@wandelbots/nova-api 25.8.0-dev.8 → 25.8.0-dev.80

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/v2/api.ts CHANGED
@@ -106,7 +106,7 @@ export interface AddTrajectoryError {
106
106
  */
107
107
  'message'?: string;
108
108
  /**
109
- * The location of the error in the trajectory.
109
+ * Location on trajectory where the execution will start. The default value is the start (forward movement) or end (backward movement) of the trajectory. If you want to start your movement from an arbitrary location, e.g. in combination with [streamMoveToTrajectoryViaJointPTP](streamMoveToTrajectoryViaJointPTP), set the location by respecting the following format: - The location is a scalar value that defines a position along a path, typically ranging from 0 to `n`, where `n` denotes the number of motion commands - Each integer value of the location corresponds to a specific motion command, while non-integer values interpolate positions within the segments. - The location is calculated from the joint path
110
110
  * @type {number}
111
111
  * @memberof AddTrajectoryError
112
112
  */
@@ -373,7 +373,7 @@ export const BoxBoxTypeEnum = {
373
373
  export type BoxBoxTypeEnum = typeof BoxBoxTypeEnum[keyof typeof BoxBoxTypeEnum];
374
374
 
375
375
  /**
376
- * PROFINET BUS Inputs/Outputs Service configuration.
376
+ * PROFINET BUS inputs/outputs service configuration.
377
377
  * @export
378
378
  * @interface BusIOProfinet
379
379
  */
@@ -385,19 +385,19 @@ export interface BusIOProfinet {
385
385
  */
386
386
  'bus_type'?: BusIOProfinetBusTypeEnum;
387
387
  /**
388
- * Path to the configuration file.
389
- * @type {string}
388
+ * Used to enable IP communication through the same physical ethernet interface while PROFINET driver is active.
389
+ * @type {BusIOProfinetNetwork}
390
390
  * @memberof BusIOProfinet
391
391
  */
392
- 'config_file_content'?: string;
392
+ 'network_config'?: BusIOProfinetNetwork;
393
393
  /**
394
- *
395
- * @type {BusIOProfinetNetwork}
394
+ * IP address of the PLC to establish PROFINET communication with. The IP address is used to configure the host machine\'s firewall. The firewall configuration is applied while the BUS input/output service is active. Without proper firewall configuration, PROFINET device discovery, configuration exchanges, and real-time cyclic data communication will fail.
395
+ * @type {string}
396
396
  * @memberof BusIOProfinet
397
397
  */
398
- 'network_config'?: BusIOProfinetNetwork;
398
+ 'plc_ip': string;
399
399
  /**
400
- * MAC address for the PROFINET port, should be get from another NOVA API endpoind?
400
+ * MAC address of the physical ethernet interface that you want to use for PROFINET communication.
401
401
  * @type {string}
402
402
  * @memberof BusIOProfinet
403
403
  */
@@ -417,7 +417,7 @@ export const BusIOProfinetBusTypeEnum = {
417
417
  export type BusIOProfinetBusTypeEnum = typeof BusIOProfinetBusTypeEnum[keyof typeof BusIOProfinetBusTypeEnum];
418
418
 
419
419
  /**
420
- * Default route configuration for the PROFINET service. Will be removed before release by automatic default route configuration, if possible.
420
+ * Current default route configuration of your NOVA instance. The default route is a setting that tells data where to go if there isn’t a specific path already known for its destination. Usually this will be the path to your router, enabling accessing the internet. On Linux, use `ip route show` to view your default routes and match the output `default via <gateway> dev <interface> ...` to get your gateway and interface.
421
421
  * @export
422
422
  * @interface BusIOProfinetDefaultRoute
423
423
  */
@@ -436,25 +436,25 @@ export interface BusIOProfinetDefaultRoute {
436
436
  'interface': string;
437
437
  }
438
438
  /**
439
- * Network configuration for the PROFINET device
439
+ * Network configuration or IPv4 record of the virtual ethernet interface (pnio1) created by the PROFINET driver. The IPv4 record is used in combination with the Name of Station (NoS) to identify your device in the PROFINET network. The `ip_config` will be used as IPv4 record if no REMA XML file is already present on your machine and no `rema_xml_content` is provided.
440
440
  * @export
441
441
  * @interface BusIOProfinetIpConfig
442
442
  */
443
443
  export interface BusIOProfinetIpConfig {
444
444
  /**
445
- * IP address for the PROFINET device
445
+ * IP address for the device\'s virtual ethernet interface (pnio1).
446
446
  * @type {string}
447
447
  * @memberof BusIOProfinetIpConfig
448
448
  */
449
449
  'ip': string;
450
450
  /**
451
- * Network mask for the PROFINET device.
451
+ * Network mask for the device\'s virtual ethernet interface (pnio1).
452
452
  * @type {string}
453
453
  * @memberof BusIOProfinetIpConfig
454
454
  */
455
455
  'netmask': string;
456
456
  /**
457
- * Gateway for the PROFINET device
457
+ * Gateway for connections to other devices outside of the virtual ethernet interface\'s subnet.
458
458
  * @type {string}
459
459
  * @memberof BusIOProfinetIpConfig
460
460
  */
@@ -467,7 +467,7 @@ export interface BusIOProfinetIpConfig {
467
467
  */
468
468
  export interface BusIOProfinetNetwork {
469
469
  /**
470
- * Name of the PROFINET device.
470
+ * Name of Station (NoS) of the PROFINET device. The NoS is used in combination with IPv4 record to identify your device in the PROFINET network. The `device_name` will be used as NoS if no REMA XML file is already present on your machine and no `rema_xml_content` is provided.
471
471
  * @type {string}
472
472
  * @memberof BusIOProfinetNetwork
473
473
  */
@@ -479,14 +479,14 @@ export interface BusIOProfinetNetwork {
479
479
  */
480
480
  'ip_config'?: BusIOProfinetIpConfig;
481
481
  /**
482
- * Content of the PROFINET REMA XML file.
482
+ * Content of the PROFINET REMA XML file. Is used when PROFINET service is added for the first time to create the REMA XML file that holds data to be kept for the next session. Stores information like IP address, Name of Station (NoS) and hardware configuration. If you use a PROFINET controller to assign an IP address to the PROFINET device, this information will be written to the REMA XML file. Refer to the PDF version of the \"PN Driver I/O Base programming interface\" documentation for more information and an example REMA file.
483
483
  * @type {string}
484
484
  * @memberof BusIOProfinetNetwork
485
485
  */
486
486
  'rema_xml_content'?: string;
487
487
  }
488
488
  /**
489
- * Virtual PROFINET BUS Inputs/Outputs Service configuration.
489
+ * Virtual PROFINET BUS inputs/outputs service configuration.
490
490
  * @export
491
491
  * @interface BusIOProfinetVirtual
492
492
  */
@@ -500,7 +500,7 @@ export interface BusIOProfinetVirtual {
500
500
  }
501
501
 
502
502
  export const BusIOProfinetVirtualBusTypeEnum = {
503
- VirtualProfinet: 'virtual_profinet'
503
+ ProfinetVirtual: 'profinet_virtual'
504
504
  } as const;
505
505
 
506
506
  export type BusIOProfinetVirtualBusTypeEnum = typeof BusIOProfinetVirtualBusTypeEnum[keyof typeof BusIOProfinetVirtualBusTypeEnum];
@@ -524,7 +524,7 @@ export interface BusIOsState {
524
524
  */
525
525
  'state': BusIOsStateEnum;
526
526
  /**
527
- * A message providing additional information on the input/output, e.g. BUS service status, encountered errors. May be empty if no additional information is available.
527
+ * A message providing additional information on the input/output service, e.g. BUS service status, encountered errors. May be empty if no additional information is available.
528
528
  * @type {string}
529
529
  * @memberof BusIOsState
530
530
  */
@@ -1782,9 +1782,22 @@ export interface GetTrajectoryResponse {
1782
1782
  export interface HTTPValidationError {
1783
1783
  /**
1784
1784
  *
1785
- * @type {Array<ValidationError>}
1785
+ * @type {Array<ValidationError2>}
1786
1786
  * @memberof HTTPValidationError
1787
1787
  */
1788
+ 'detail'?: Array<ValidationError2>;
1789
+ }
1790
+ /**
1791
+ *
1792
+ * @export
1793
+ * @interface HTTPValidationError2
1794
+ */
1795
+ export interface HTTPValidationError2 {
1796
+ /**
1797
+ *
1798
+ * @type {Array<ValidationError>}
1799
+ * @memberof HTTPValidationError2
1800
+ */
1788
1801
  'detail'?: Array<ValidationError>;
1789
1802
  }
1790
1803
  /**
@@ -1876,6 +1889,57 @@ export interface IODescription {
1876
1889
  }
1877
1890
 
1878
1891
 
1892
+ /**
1893
+ *
1894
+ * @export
1895
+ * @interface IODescription2
1896
+ */
1897
+ export interface IODescription2 {
1898
+ /**
1899
+ * Unique identifier of the input/output.
1900
+ * @type {string}
1901
+ * @memberof IODescription2
1902
+ */
1903
+ 'io': string;
1904
+ /**
1905
+ * Descriptive name of the input/output. Customize it using the respective BUS service, e.g. [addProfinetIO](addProfinetIO) for PROFINET service.
1906
+ * @type {string}
1907
+ * @memberof IODescription2
1908
+ */
1909
+ 'name': string;
1910
+ /**
1911
+ *
1912
+ * @type {IODirection}
1913
+ * @memberof IODescription2
1914
+ */
1915
+ 'direction': IODirection;
1916
+ /**
1917
+ *
1918
+ * @type {IOValueType}
1919
+ * @memberof IODescription2
1920
+ */
1921
+ 'value_type': IOValueType;
1922
+ /**
1923
+ *
1924
+ * @type {UnitType}
1925
+ * @memberof IODescription2
1926
+ */
1927
+ 'unit'?: UnitType;
1928
+ /**
1929
+ *
1930
+ * @type {IODescriptionMin}
1931
+ * @memberof IODescription2
1932
+ */
1933
+ 'min'?: IODescriptionMin;
1934
+ /**
1935
+ *
1936
+ * @type {IODescriptionMin}
1937
+ * @memberof IODescription2
1938
+ */
1939
+ 'max'?: IODescriptionMin;
1940
+ }
1941
+
1942
+
1879
1943
  /**
1880
1944
  * @type IODescriptionMin
1881
1945
  * @export
@@ -1941,7 +2005,7 @@ export interface IOIntegerValue {
1941
2005
  */
1942
2006
  'io': string;
1943
2007
  /**
1944
- * Value of an input/output with integer representation. > The integral value is transmitted as a string to avoid precision loss during conversion to JSON. > We recommend to use int64 in your implementation. If you want to interact with int64 in numbers, > JS bigint libraries can help you to parse the string into an integral value.
2008
+ * Value of an input/output with integer representation. > The integral value is transmitted as a string to avoid precision loss during conversion to JSON. > Recommended: Use int64 in your implementation. If you want to interact with int64 in numbers, > JS bigint libraries can help you to parse the string into an integral value.
1945
2009
  * @type {string}
1946
2010
  * @memberof IOIntegerValue
1947
2011
  */
@@ -2068,24 +2132,12 @@ export interface InitializeJoggingRequest {
2068
2132
  * @memberof InitializeJoggingRequest
2069
2133
  */
2070
2134
  'tcp'?: string;
2071
- /**
2072
- * Update rate for the response message in milliseconds (ms). Recommendation: As Wandelbots NOVA updates states in the controller\'s step rate, use either the controller\'s step rate or a multiple of it. Wandelbots NOVA will not interpolate the state but round it to the nearest step rate below the configured response rate. Use [getOptimizerConfiguration](getOptimizerConfiguration) to get the controller\'s step rate. Minimal response rate is the step rate of the controller.
2073
- * @type {number}
2074
- * @memberof InitializeJoggingRequest
2075
- */
2076
- 'response_rate'?: number;
2077
2135
  /**
2078
2136
  * Unique identifier addressing a coordinate system to which the responses are transformed. If not set, world coordinate system is used.
2079
2137
  * @type {string}
2080
2138
  * @memberof InitializeJoggingRequest
2081
2139
  */
2082
2140
  'response_coordinate_system'?: string;
2083
- /**
2084
- * Defines an input/output that is listened to during the movement. Execution pauses if the defined comparator evaluates to `true`.
2085
- * @type {string}
2086
- * @memberof InitializeJoggingRequest
2087
- */
2088
- 'pause_on_io'?: string;
2089
2141
  }
2090
2142
 
2091
2143
  export const InitializeJoggingRequestMessageTypeEnum = {
@@ -2144,12 +2196,6 @@ export interface InitializeMovementRequest {
2144
2196
  * @memberof InitializeMovementRequest
2145
2197
  */
2146
2198
  'initial_location'?: number;
2147
- /**
2148
- * Update rate for the response message in milliseconds (ms). Default is 200 ms. Recommendation: As Wandelbots NOVA updates states in the controller\'s step rate, use either the controller\'s step rate or a multiple of it. Wandelbots NOVA will not interpolate the state but rather round it to the nearest step rate below the configured response rate. Minimal response rate is the step rate of controller.
2149
- * @type {number}
2150
- * @memberof InitializeMovementRequest
2151
- */
2152
- 'response_rate'?: number;
2153
2199
  /**
2154
2200
  * Unique identifier addressing a coordinate system to which the responses are transformed. If not set, world coordinate system is used.
2155
2201
  * @type {string}
@@ -2204,7 +2250,7 @@ export const InitializeMovementResponseKindEnum = {
2204
2250
  export type InitializeMovementResponseKindEnum = typeof InitializeMovementResponseKindEnum[keyof typeof InitializeMovementResponseKindEnum];
2205
2251
 
2206
2252
  /**
2207
- * Value of an input/output with integer representation. > The integral value is transmitted as a string to avoid precision loss during conversion to JSON. > We recommend to use int64 in your implementation. If you want to interact with int64 in numbers, > JS bigint libraries can help you to parse the string into an integral value.
2253
+ * Value of an input/output with integer representation. > The integral value is transmitted as a string to avoid precision loss during conversion to JSON. > Recommended: Use int64 in your implementation. If you want to interact with int64 in numbers, > JS bigint libraries can help you to parse the string into an integral value.
2208
2254
  * @export
2209
2255
  * @interface IntegerValue
2210
2256
  */
@@ -2581,7 +2627,7 @@ export interface JointTrajectory {
2581
2627
  */
2582
2628
  'times': Array<number>;
2583
2629
  /**
2584
- * Location for each sample, scalar value defining a position along a path. Typical range: 0 to `n`, `n` denoting the number of motion commands. Each integer value of the location corresponds to a specific motion command. If provided, the number of samples must match the number of timestamps provided in the times field.
2630
+ *
2585
2631
  * @type {Array<number>}
2586
2632
  * @memberof JointTrajectory
2587
2633
  */
@@ -2669,6 +2715,12 @@ export interface KukaController {
2669
2715
  * @memberof KukaController
2670
2716
  */
2671
2717
  'rsi_server': KukaControllerRsiServer;
2718
+ /**
2719
+ * If true, uses slower cycle time of 12ms instead of 4ms.
2720
+ * @type {boolean}
2721
+ * @memberof KukaController
2722
+ */
2723
+ 'slow_cycle_rate'?: boolean;
2672
2724
  }
2673
2725
 
2674
2726
  export const KukaControllerKindEnum = {
@@ -2801,25 +2853,6 @@ export const LicenseStatusEnum = {
2801
2853
  export type LicenseStatusEnum = typeof LicenseStatusEnum[keyof typeof LicenseStatusEnum];
2802
2854
 
2803
2855
 
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
2856
  /**
2824
2857
  * The upper_limit must be greater then the lower_limit.
2825
2858
  * @export
@@ -2869,6 +2902,12 @@ export interface LimitSet {
2869
2902
  * @memberof LimitSet
2870
2903
  */
2871
2904
  'flange'?: CartesianLimits;
2905
+ /**
2906
+ *
2907
+ * @type {JointLimits}
2908
+ * @memberof LimitSet
2909
+ */
2910
+ 'coupled_shoulder_elbow_joint'?: JointLimits;
2872
2911
  }
2873
2912
  /**
2874
2913
  * If a limit is not set, the default value will be used.
@@ -2944,13 +2983,13 @@ export type Manufacturer = typeof Manufacturer[keyof typeof Manufacturer];
2944
2983
 
2945
2984
 
2946
2985
  /**
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.
2986
+ *
2948
2987
  * @export
2949
2988
  * @interface MidpointInsertionAlgorithm
2950
2989
  */
2951
2990
  export interface MidpointInsertionAlgorithm {
2952
2991
  /**
2953
- * Algorithm discriminator.
2992
+ * 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
2993
  * @type {string}
2955
2994
  * @memberof MidpointInsertionAlgorithm
2956
2995
  */
@@ -3043,13 +3082,13 @@ export interface MotionGroupDescription {
3043
3082
  * @type {Pose}
3044
3083
  * @memberof MotionGroupDescription
3045
3084
  */
3046
- 'mounting': Pose;
3085
+ 'mounting'?: Pose;
3047
3086
  /**
3048
3087
  * Maps a TCP name to its offset relative to the flange coordinate system. Key must be a TCP identifier. Values are TcpOffsets.
3049
3088
  * @type {{ [key: string]: TcpOffset; }}
3050
3089
  * @memberof MotionGroupDescription
3051
3090
  */
3052
- 'tcps': { [key: string]: TcpOffset; };
3091
+ 'tcps'?: { [key: string]: TcpOffset; };
3053
3092
  /**
3054
3093
  * A collection of identifiable colliders.
3055
3094
  * @type {{ [key: string]: Collider; }}
@@ -3070,10 +3109,10 @@ export interface MotionGroupDescription {
3070
3109
  'safety_tool_colliders'?: { [key: string]: { [key: string]: Collider; }; };
3071
3110
  /**
3072
3111
  *
3073
- * @type {LimitConfig}
3112
+ * @type {OperationLimits}
3074
3113
  * @memberof MotionGroupDescription
3075
3114
  */
3076
- 'global_limits': LimitConfig;
3115
+ 'operation_limits': OperationLimits;
3077
3116
  /**
3078
3117
  * Maps a payload name to its configuration. Key must be a payload identifier. Values are payload objects.
3079
3118
  * @type {{ [key: string]: Payload; }}
@@ -3849,11 +3888,11 @@ export interface PlanTrajectoryFailedResponse {
3849
3888
  */
3850
3889
  'error_feedback': PlanTrajectoryFailedResponseErrorFeedback;
3851
3890
  /**
3852
- *
3891
+ * 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
3892
  * @type {number}
3854
3893
  * @memberof PlanTrajectoryFailedResponse
3855
3894
  */
3856
- 'error_location_on_trajectory'?: number;
3895
+ 'error_location_on_trajectory': number;
3857
3896
  /**
3858
3897
  * The joint trajectory from the start joint position to the error.
3859
3898
  * @type {JointTrajectory}
@@ -4071,17 +4110,17 @@ export interface ProfinetDescription {
4071
4110
  */
4072
4111
  'slots'?: Array<ProfinetSlotDescription>;
4073
4112
  /**
4074
- * Name of the PROFINET device
4113
+ * 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
4114
  * @type {string}
4076
4115
  * @memberof ProfinetDescription
4077
4116
  */
4078
4117
  'device_name'?: string;
4079
4118
  /**
4080
- * IP address for the PROFINET device
4081
- * @type {string}
4119
+ *
4120
+ * @type {BusIOProfinetIpConfig}
4082
4121
  * @memberof ProfinetDescription
4083
4122
  */
4084
- 'ip'?: string;
4123
+ 'ip_config'?: BusIOProfinetIpConfig;
4085
4124
  }
4086
4125
  /**
4087
4126
  *
@@ -4090,7 +4129,7 @@ export interface ProfinetDescription {
4090
4129
  */
4091
4130
  export interface ProfinetIO {
4092
4131
  /**
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.
4132
+ * 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
4133
  * @type {string}
4095
4134
  * @memberof ProfinetIO
4096
4135
  */
@@ -4102,25 +4141,25 @@ export interface ProfinetIO {
4102
4141
  */
4103
4142
  'type': ProfinetIOTypeEnum;
4104
4143
  /**
4105
- * The direction of the input/output value, indicating whether it is an input or output for the device.
4144
+ * 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
4145
  * @type {ProfinetIODirection}
4107
4146
  * @memberof ProfinetIO
4108
4147
  */
4109
4148
  'direction': ProfinetIODirection;
4110
4149
  /**
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.
4150
+ * 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
4151
  * @type {number}
4113
4152
  * @memberof ProfinetIO
4114
4153
  */
4115
4154
  'byte_address': number;
4116
4155
  /**
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.
4156
+ * 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
4157
  * @type {number}
4119
4158
  * @memberof ProfinetIO
4120
4159
  */
4121
4160
  'bit_address'?: number;
4122
4161
  /**
4123
- * The unique identifier for the input/output value. This identifier is used to reference the specific input/output in the NOVA system.
4162
+ * 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
4163
  * @type {string}
4125
4164
  * @memberof ProfinetIO
4126
4165
  */
@@ -4135,7 +4174,7 @@ export interface ProfinetIO {
4135
4174
  */
4136
4175
  export interface ProfinetIOData {
4137
4176
  /**
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.
4177
+ * 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
4178
  * @type {string}
4140
4179
  * @memberof ProfinetIOData
4141
4180
  */
@@ -4147,19 +4186,19 @@ export interface ProfinetIOData {
4147
4186
  */
4148
4187
  'type': ProfinetIOTypeEnum;
4149
4188
  /**
4150
- * The direction of the input/output value, indicating whether it is an input or output for the device.
4189
+ * 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
4190
  * @type {ProfinetIODirection}
4152
4191
  * @memberof ProfinetIOData
4153
4192
  */
4154
4193
  'direction': ProfinetIODirection;
4155
4194
  /**
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.
4195
+ * 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
4196
  * @type {number}
4158
4197
  * @memberof ProfinetIOData
4159
4198
  */
4160
4199
  'byte_address': number;
4161
4200
  /**
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.
4201
+ * 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
4202
  * @type {number}
4164
4203
  * @memberof ProfinetIOData
4165
4204
  */
@@ -4168,7 +4207,7 @@ export interface ProfinetIOData {
4168
4207
 
4169
4208
 
4170
4209
  /**
4171
- * Identifies the input/output type.
4210
+ * 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
4211
  * @export
4173
4212
  * @enum {string}
4174
4213
  */
@@ -4183,7 +4222,7 @@ export type ProfinetIODirection = typeof ProfinetIODirection[keyof typeof Profin
4183
4222
 
4184
4223
 
4185
4224
  /**
4186
- * Value type of the PROFINET input/output.
4225
+ * Value type of the PROFINET input/output variable. Is used to interpret the corresponding bits correctly.
4187
4226
  * @export
4188
4227
  * @enum {string}
4189
4228
  */
@@ -4211,38 +4250,38 @@ export type ProfinetIOTypeEnum = typeof ProfinetIOTypeEnum[keyof typeof Profinet
4211
4250
  */
4212
4251
  export interface ProfinetInputOutputConfig {
4213
4252
  /**
4214
- * Content of the input output configuration file.
4253
+ * 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
4254
  * @type {string}
4216
4255
  * @memberof ProfinetInputOutputConfig
4217
4256
  */
4218
4257
  'config': string;
4219
4258
  /**
4220
- * Offset in bytes for the input data.
4259
+ * 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
4260
  * @type {number}
4222
4261
  * @memberof ProfinetInputOutputConfig
4223
4262
  */
4224
4263
  'input_offset': number;
4225
4264
  /**
4226
- * Offset in bytes for the output data.
4265
+ * 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
4266
  * @type {number}
4228
4267
  * @memberof ProfinetInputOutputConfig
4229
4268
  */
4230
4269
  'output_offset': number;
4231
4270
  }
4232
4271
  /**
4233
- *
4272
+ * 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
4273
  * @export
4235
4274
  * @interface ProfinetSlotDescription
4236
4275
  */
4237
4276
  export interface ProfinetSlotDescription {
4238
4277
  /**
4239
- * The number of the PROFINET slot.
4278
+ * 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
4279
  * @type {number}
4241
4280
  * @memberof ProfinetSlotDescription
4242
4281
  */
4243
4282
  'number': number;
4244
4283
  /**
4245
- * The API number of the PROFINET input, used to identify the specific API for the input.
4284
+ * The application process identifier (API) number of the PROFINET input. The API identifies the application relation (AR) that is using the slot.
4246
4285
  * @type {number}
4247
4286
  * @memberof ProfinetSlotDescription
4248
4287
  */
@@ -4261,32 +4300,180 @@ export interface ProfinetSlotDescription {
4261
4300
  */
4262
4301
  export interface ProfinetSubSlotDescription {
4263
4302
  /**
4264
- * The identifier of the PROFINET subslot.
4303
+ * The number/index of the PROFINET subslot.
4265
4304
  * @type {number}
4266
4305
  * @memberof ProfinetSubSlotDescription
4267
4306
  */
4268
4307
  'number': number;
4269
4308
  /**
4270
- * The length in bytes of the PROFINET input.
4309
+ * The amount of bytes allocated for the subslot in the input process image buffer.
4271
4310
  * @type {number}
4272
4311
  * @memberof ProfinetSubSlotDescription
4273
4312
  */
4274
4313
  'input_length': number;
4275
4314
  /**
4276
- * The length in bytes of the PROFINET output.
4315
+ * The amount of bytes allocated for the subslot in the output process image buffer.
4277
4316
  * @type {number}
4278
4317
  * @memberof ProfinetSubSlotDescription
4279
4318
  */
4280
4319
  'output_length': number;
4281
4320
  }
4282
4321
  /**
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.
4322
+ * A program is a collection of instructions that are executed in the robot cell.
4323
+ * @export
4324
+ * @interface Program
4325
+ */
4326
+ export interface Program {
4327
+ /**
4328
+ *
4329
+ * @type {string}
4330
+ * @memberof Program
4331
+ */
4332
+ 'program': string;
4333
+ /**
4334
+ *
4335
+ * @type {string}
4336
+ * @memberof Program
4337
+ */
4338
+ 'name'?: string;
4339
+ /**
4340
+ *
4341
+ * @type {string}
4342
+ * @memberof Program
4343
+ */
4344
+ 'description'?: string;
4345
+ /**
4346
+ *
4347
+ * @type {string}
4348
+ * @memberof Program
4349
+ */
4350
+ 'app': string;
4351
+ /**
4352
+ *
4353
+ * @type {object}
4354
+ * @memberof Program
4355
+ */
4356
+ 'input_schema'?: object;
4357
+ /**
4358
+ *
4359
+ * @type {object}
4360
+ * @memberof Program
4361
+ */
4362
+ 'preconditions'?: object;
4363
+ }
4364
+ /**
4365
+ * Holds the state of a program run.
4366
+ * @export
4367
+ * @interface ProgramRun
4368
+ */
4369
+ export interface ProgramRun {
4370
+ /**
4371
+ * Unique identifier of the program run
4372
+ * @type {string}
4373
+ * @memberof ProgramRun
4374
+ */
4375
+ 'run': string;
4376
+ /**
4377
+ * Unique identifier of the program
4378
+ * @type {string}
4379
+ * @memberof ProgramRun
4380
+ */
4381
+ 'program': string;
4382
+ /**
4383
+ * State of the program run
4384
+ * @type {ProgramRunState}
4385
+ * @memberof ProgramRun
4386
+ */
4387
+ 'state': ProgramRunState;
4388
+ /**
4389
+ * Logs of the program run
4390
+ * @type {string}
4391
+ * @memberof ProgramRun
4392
+ */
4393
+ 'logs'?: string;
4394
+ /**
4395
+ * Stdout of the program run
4396
+ * @type {string}
4397
+ * @memberof ProgramRun
4398
+ */
4399
+ 'stdout'?: string;
4400
+ /**
4401
+ * Stderr of the program run
4402
+ * @type {string}
4403
+ * @memberof ProgramRun
4404
+ */
4405
+ 'stderr'?: string;
4406
+ /**
4407
+ * Error message of the program run, if any
4408
+ * @type {string}
4409
+ * @memberof ProgramRun
4410
+ */
4411
+ 'error'?: string;
4412
+ /**
4413
+ * Traceback of the program run, if any
4414
+ * @type {string}
4415
+ * @memberof ProgramRun
4416
+ */
4417
+ 'traceback'?: string;
4418
+ /**
4419
+ * Start time of the program run
4420
+ * @type {string}
4421
+ * @memberof ProgramRun
4422
+ */
4423
+ 'start_time'?: string;
4424
+ /**
4425
+ * End time of the program run
4426
+ * @type {string}
4427
+ * @memberof ProgramRun
4428
+ */
4429
+ 'end_time'?: string;
4430
+ /**
4431
+ * Input data of the program run
4432
+ * @type {object}
4433
+ * @memberof ProgramRun
4434
+ */
4435
+ 'input_data'?: object;
4436
+ }
4437
+
4438
+
4439
+ /**
4440
+ * The state of a program run.
4441
+ * @export
4442
+ * @enum {string}
4443
+ */
4444
+
4445
+ export const ProgramRunState = {
4446
+ Preparing: 'PREPARING',
4447
+ Running: 'RUNNING',
4448
+ Completed: 'COMPLETED',
4449
+ Failed: 'FAILED',
4450
+ Stopped: 'STOPPED'
4451
+ } as const;
4452
+
4453
+ export type ProgramRunState = typeof ProgramRunState[keyof typeof ProgramRunState];
4454
+
4455
+
4456
+ /**
4457
+ * The state of a program run.
4458
+ * @export
4459
+ * @interface ProgramStartRequest
4460
+ */
4461
+ export interface ProgramStartRequest {
4462
+ /**
4463
+ * The arguments to pass to the program.
4464
+ * @type {object}
4465
+ * @memberof ProgramStartRequest
4466
+ */
4467
+ 'arguments': object;
4468
+ }
4469
+ /**
4470
+ *
4284
4471
  * @export
4285
4472
  * @interface RRTConnectAlgorithm
4286
4473
  */
4287
4474
  export interface RRTConnectAlgorithm {
4288
4475
  /**
4289
- * Algorithm discriminator.
4476
+ * 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
4477
  * @type {string}
4291
4478
  * @memberof RRTConnectAlgorithm
4292
4479
  */
@@ -4297,6 +4484,30 @@ export interface RRTConnectAlgorithm {
4297
4484
  * @memberof RRTConnectAlgorithm
4298
4485
  */
4299
4486
  'max_iterations'?: number;
4487
+ /**
4488
+ * Maximum step size for tree extension in joint space.
4489
+ * @type {number}
4490
+ * @memberof RRTConnectAlgorithm
4491
+ */
4492
+ 'max_step_size'?: number;
4493
+ /**
4494
+ * Adjust the maximum step size during the search based on the recent success rate of tree expansion.
4495
+ * @type {boolean}
4496
+ * @memberof RRTConnectAlgorithm
4497
+ */
4498
+ 'adaptive_step_size'?: boolean;
4499
+ /**
4500
+ * Apply smoothing after the search has succeeded. This will remove as many intermediate points as possible while keeping the path valid.
4501
+ * @type {boolean}
4502
+ * @memberof RRTConnectAlgorithm
4503
+ */
4504
+ 'apply_smoothing'?: boolean;
4505
+ /**
4506
+ * Apply blending after the search has succeeded and smoothing has been applied. This will apply the largest viable blending at each intermediate point.
4507
+ * @type {boolean}
4508
+ * @memberof RRTConnectAlgorithm
4509
+ */
4510
+ 'apply_blending'?: boolean;
4300
4511
  }
4301
4512
 
4302
4513
  export const RRTConnectAlgorithmAlgorithmNameEnum = {
@@ -4726,6 +4937,25 @@ export interface ServiceStatusStatus {
4726
4937
  }
4727
4938
 
4728
4939
 
4940
+ /**
4941
+ * Defines an input/output that should be set upon reaching a specified location on the trajectory.
4942
+ * @export
4943
+ * @interface SetIO
4944
+ */
4945
+ export interface SetIO {
4946
+ /**
4947
+ *
4948
+ * @type {IOValue}
4949
+ * @memberof SetIO
4950
+ */
4951
+ 'io': IOValue;
4952
+ /**
4953
+ * The location on the trajectory where the input/output should be set.
4954
+ * @type {number}
4955
+ * @memberof SetIO
4956
+ */
4957
+ 'location': number;
4958
+ }
4729
4959
  /**
4730
4960
  *
4731
4961
  * @export
@@ -4801,10 +5031,10 @@ export interface StartMovementRequest {
4801
5031
  'direction'?: Direction;
4802
5032
  /**
4803
5033
  * 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>}
5034
+ * @type {Array<SetIO>}
4805
5035
  * @memberof StartMovementRequest
4806
5036
  */
4807
- 'set_outputs'?: Array<IOValue>;
5037
+ 'set_outputs'?: Array<SetIO>;
4808
5038
  /**
4809
5039
  * Defines an input/output that is listened to before the movement. Execution starts if the defined comparator evaluates to `true`.
4810
5040
  * @type {StartOnIO}
@@ -5076,7 +5306,7 @@ export interface TrajectoryDetails {
5076
5306
  */
5077
5307
  'trajectory': string;
5078
5308
  /**
5079
- * Current location of motion group on the trajectory.
5309
+ * 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
5310
  * @type {number}
5081
5311
  * @memberof TrajectoryDetails
5082
5312
  */
@@ -5138,7 +5368,7 @@ export interface TrajectoryId {
5138
5368
  * @type {string}
5139
5369
  * @memberof TrajectoryId
5140
5370
  */
5141
- 'message_type'?: TrajectoryIdMessageTypeEnum;
5371
+ 'message_type': TrajectoryIdMessageTypeEnum;
5142
5372
  /**
5143
5373
  * The identifier of the trajectory which was returned by the [addTrajectory](addTrajectory) endpoint.
5144
5374
  * @type {string}
@@ -5333,6 +5563,31 @@ export interface ValidationError {
5333
5563
  */
5334
5564
  'input': { [key: string]: any; };
5335
5565
  }
5566
+ /**
5567
+ * A validation error of a program.
5568
+ * @export
5569
+ * @interface ValidationError2
5570
+ */
5571
+ export interface ValidationError2 {
5572
+ /**
5573
+ *
5574
+ * @type {Array<number>}
5575
+ * @memberof ValidationError2
5576
+ */
5577
+ 'loc': Array<number>;
5578
+ /**
5579
+ *
5580
+ * @type {string}
5581
+ * @memberof ValidationError2
5582
+ */
5583
+ 'msg': string;
5584
+ /**
5585
+ *
5586
+ * @type {string}
5587
+ * @memberof ValidationError2
5588
+ */
5589
+ 'type': string;
5590
+ }
5336
5591
  /**
5337
5592
  * @type ValidationErrorLocInner
5338
5593
  * @export
@@ -5460,11 +5715,13 @@ export const VirtualControllerTypes = {
5460
5715
  KukaKr4R600: 'kuka-kr4_r600',
5461
5716
  KukaKr500L3403: 'kuka-kr500_l340_3',
5462
5717
  KukaKr50R2500: 'kuka-kr50_r2500',
5718
+ KukaKr60R3: 'kuka-kr60_r3',
5463
5719
  KukaKr6R1820: 'kuka-kr6_r1820',
5464
5720
  KukaKr6R7002: 'kuka-kr6_r700_2',
5465
5721
  KukaKr6R700Sixx: 'kuka-kr6_r700_sixx',
5466
5722
  KukaKr6R900: 'kuka-kr6_r900',
5467
5723
  KukaKr6R9002: 'kuka-kr6_r900_2',
5724
+ KukaKr70R2100: 'kuka-kr70_r2100',
5468
5725
  KukaLbrIisy11R1300: 'kuka-lbr_iisy_11_r1300',
5469
5726
  UniversalrobotsUr10cb: 'universalrobots-ur10cb',
5470
5727
  UniversalrobotsUr10e: 'universalrobots-ur10e',
@@ -6150,7 +6407,7 @@ export class ApplicationApi extends BaseAPI {
6150
6407
  export const BUSInputsOutputsApiAxiosParamCreator = function (configuration?: Configuration) {
6151
6408
  return {
6152
6409
  /**
6153
- * Add a BUS Inputs/Outputs Service to the cell.
6410
+ * Add the BUS inputs/outputs service to the cell. Starts a containerized service that enables BUS connections via the specified ethernet port.
6154
6411
  * @summary Add Service
6155
6412
  * @param {string} cell Unique identifier addressing a cell in all API calls.
6156
6413
  * @param {BusIOType} busIOType
@@ -6203,7 +6460,7 @@ export const BUSInputsOutputsApiAxiosParamCreator = function (configuration?: Co
6203
6460
  };
6204
6461
  },
6205
6462
  /**
6206
- * Adds an input/output to or updates an input/output on the PROFINET device.
6463
+ * 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
6464
  * @summary Add PROFINET Input/Output
6208
6465
  * @param {string} cell Unique identifier addressing a cell in all API calls.
6209
6466
  * @param {string} io Unique identifier to address an Input/Output in the cell.
@@ -6255,7 +6512,7 @@ export const BUSInputsOutputsApiAxiosParamCreator = function (configuration?: Co
6255
6512
  };
6256
6513
  },
6257
6514
  /**
6258
- * Delete BUS Inputs/Outputs Service from the cell.
6515
+ * Remove the BUS inputs/outputs service from the cell.
6259
6516
  * @summary Clear Service
6260
6517
  * @param {string} cell Unique identifier addressing a cell in all API calls.
6261
6518
  * @param {number} [completionTimeout]
@@ -6302,7 +6559,7 @@ export const BUSInputsOutputsApiAxiosParamCreator = function (configuration?: Co
6302
6559
  };
6303
6560
  },
6304
6561
  /**
6305
- * Removes the input/output from the PROFINET device.
6562
+ * Removes an input/output variable configuration from the PROFINET device, e.g. NOVA\'s PROFINET service.
6306
6563
  * @summary Remove PROFINET Input/Ouptut
6307
6564
  * @param {string} cell Unique identifier addressing a cell in all API calls.
6308
6565
  * @param {string} io Unique identifier to address an Input/Output in the cell.
@@ -6348,7 +6605,7 @@ export const BUSInputsOutputsApiAxiosParamCreator = function (configuration?: Co
6348
6605
  };
6349
6606
  },
6350
6607
  /**
6351
- * Get deployed BUS Inputs/Outputs Service.
6608
+ * Get deployed BUS inputs/outputs service.
6352
6609
  * @summary Get Service
6353
6610
  * @param {string} cell Unique identifier addressing a cell in all API calls.
6354
6611
  * @param {*} [options] Override http request option.
@@ -6479,7 +6736,7 @@ export const BUSInputsOutputsApiAxiosParamCreator = function (configuration?: Co
6479
6736
  };
6480
6737
  },
6481
6738
  /**
6482
- * Get description of PROFINET
6739
+ * Get description of NOVA as a PROFINET device.
6483
6740
  * @summary Get PROFINET Description
6484
6741
  * @param {string} cell Unique identifier addressing a cell in all API calls.
6485
6742
  * @param {*} [options] Override http request option.
@@ -6521,7 +6778,7 @@ export const BUSInputsOutputsApiAxiosParamCreator = function (configuration?: Co
6521
6778
  };
6522
6779
  },
6523
6780
  /**
6524
- * Get input/output configuration of the PROFINET device as file.
6781
+ * 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
6782
  * @summary PROFINET Inputs/Outputs to File
6526
6783
  * @param {string} cell Unique identifier addressing a cell in all API calls.
6527
6784
  * @param {number} [inputOffset]
@@ -6573,7 +6830,7 @@ export const BUSInputsOutputsApiAxiosParamCreator = function (configuration?: Co
6573
6830
  };
6574
6831
  },
6575
6832
  /**
6576
- * List all BUS Input/Output descriptions.
6833
+ * 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
6834
  * @summary List Descriptions
6578
6835
  * @param {string} cell Unique identifier addressing a cell in all API calls.
6579
6836
  * @param {*} [options] Override http request option.
@@ -6615,7 +6872,7 @@ export const BUSInputsOutputsApiAxiosParamCreator = function (configuration?: Co
6615
6872
  };
6616
6873
  },
6617
6874
  /**
6618
- * List all PROFINET input and outputs.
6875
+ * 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
6876
  * @summary List PROFINET Input/Output Configuration
6620
6877
  * @param {string} cell Unique identifier addressing a cell in all API calls.
6621
6878
  * @param {*} [options] Override http request option.
@@ -6705,7 +6962,7 @@ export const BUSInputsOutputsApiAxiosParamCreator = function (configuration?: Co
6705
6962
  };
6706
6963
  },
6707
6964
  /**
6708
- * Sets inputs/outputs on the PROFINET device from file.
6965
+ * 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
6966
  * @summary Set PROFINET Inputs/Outputs from File
6710
6967
  * @param {string} cell Unique identifier addressing a cell in all API calls.
6711
6968
  * @param {ProfinetInputOutputConfig} profinetInputOutputConfig
@@ -6763,7 +7020,7 @@ export const BUSInputsOutputsApiFp = function(configuration?: Configuration) {
6763
7020
  const localVarAxiosParamCreator = BUSInputsOutputsApiAxiosParamCreator(configuration)
6764
7021
  return {
6765
7022
  /**
6766
- * Add a BUS Inputs/Outputs Service to the cell.
7023
+ * Add the BUS inputs/outputs service to the cell. Starts a containerized service that enables BUS connections via the specified ethernet port.
6767
7024
  * @summary Add Service
6768
7025
  * @param {string} cell Unique identifier addressing a cell in all API calls.
6769
7026
  * @param {BusIOType} busIOType
@@ -6778,7 +7035,7 @@ export const BUSInputsOutputsApiFp = function(configuration?: Configuration) {
6778
7035
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
6779
7036
  },
6780
7037
  /**
6781
- * Adds an input/output to or updates an input/output on the PROFINET device.
7038
+ * 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
7039
  * @summary Add PROFINET Input/Output
6783
7040
  * @param {string} cell Unique identifier addressing a cell in all API calls.
6784
7041
  * @param {string} io Unique identifier to address an Input/Output in the cell.
@@ -6793,7 +7050,7 @@ export const BUSInputsOutputsApiFp = function(configuration?: Configuration) {
6793
7050
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
6794
7051
  },
6795
7052
  /**
6796
- * Delete BUS Inputs/Outputs Service from the cell.
7053
+ * Remove the BUS inputs/outputs service from the cell.
6797
7054
  * @summary Clear Service
6798
7055
  * @param {string} cell Unique identifier addressing a cell in all API calls.
6799
7056
  * @param {number} [completionTimeout]
@@ -6807,7 +7064,7 @@ export const BUSInputsOutputsApiFp = function(configuration?: Configuration) {
6807
7064
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
6808
7065
  },
6809
7066
  /**
6810
- * Removes the input/output from the PROFINET device.
7067
+ * Removes an input/output variable configuration from the PROFINET device, e.g. NOVA\'s PROFINET service.
6811
7068
  * @summary Remove PROFINET Input/Ouptut
6812
7069
  * @param {string} cell Unique identifier addressing a cell in all API calls.
6813
7070
  * @param {string} io Unique identifier to address an Input/Output in the cell.
@@ -6821,7 +7078,7 @@ export const BUSInputsOutputsApiFp = function(configuration?: Configuration) {
6821
7078
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
6822
7079
  },
6823
7080
  /**
6824
- * Get deployed BUS Inputs/Outputs Service.
7081
+ * Get deployed BUS inputs/outputs service.
6825
7082
  * @summary Get Service
6826
7083
  * @param {string} cell Unique identifier addressing a cell in all API calls.
6827
7084
  * @param {*} [options] Override http request option.
@@ -6861,7 +7118,7 @@ export const BUSInputsOutputsApiFp = function(configuration?: Configuration) {
6861
7118
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
6862
7119
  },
6863
7120
  /**
6864
- * Get description of PROFINET
7121
+ * Get description of NOVA as a PROFINET device.
6865
7122
  * @summary Get PROFINET Description
6866
7123
  * @param {string} cell Unique identifier addressing a cell in all API calls.
6867
7124
  * @param {*} [options] Override http request option.
@@ -6874,7 +7131,7 @@ export const BUSInputsOutputsApiFp = function(configuration?: Configuration) {
6874
7131
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
6875
7132
  },
6876
7133
  /**
6877
- * Get input/output configuration of the PROFINET device as file.
7134
+ * 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
7135
  * @summary PROFINET Inputs/Outputs to File
6879
7136
  * @param {string} cell Unique identifier addressing a cell in all API calls.
6880
7137
  * @param {number} [inputOffset]
@@ -6889,20 +7146,20 @@ export const BUSInputsOutputsApiFp = function(configuration?: Configuration) {
6889
7146
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
6890
7147
  },
6891
7148
  /**
6892
- * List all BUS Input/Output descriptions.
7149
+ * 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
7150
  * @summary List Descriptions
6894
7151
  * @param {string} cell Unique identifier addressing a cell in all API calls.
6895
7152
  * @param {*} [options] Override http request option.
6896
7153
  * @throws {RequiredError}
6897
7154
  */
6898
- async listBusIODescriptions(cell: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<IODescription>>> {
7155
+ async listBusIODescriptions(cell: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<IODescription2>>> {
6899
7156
  const localVarAxiosArgs = await localVarAxiosParamCreator.listBusIODescriptions(cell, options);
6900
7157
  const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
6901
7158
  const localVarOperationServerBasePath = operationServerMap['BUSInputsOutputsApi.listBusIODescriptions']?.[localVarOperationServerIndex]?.url;
6902
7159
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
6903
7160
  },
6904
7161
  /**
6905
- * List all PROFINET input and outputs.
7162
+ * 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
7163
  * @summary List PROFINET Input/Output Configuration
6907
7164
  * @param {string} cell Unique identifier addressing a cell in all API calls.
6908
7165
  * @param {*} [options] Override http request option.
@@ -6929,7 +7186,7 @@ export const BUSInputsOutputsApiFp = function(configuration?: Configuration) {
6929
7186
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
6930
7187
  },
6931
7188
  /**
6932
- * Sets inputs/outputs on the PROFINET device from file.
7189
+ * 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
7190
  * @summary Set PROFINET Inputs/Outputs from File
6934
7191
  * @param {string} cell Unique identifier addressing a cell in all API calls.
6935
7192
  * @param {ProfinetInputOutputConfig} profinetInputOutputConfig
@@ -6953,7 +7210,7 @@ export const BUSInputsOutputsApiFactory = function (configuration?: Configuratio
6953
7210
  const localVarFp = BUSInputsOutputsApiFp(configuration)
6954
7211
  return {
6955
7212
  /**
6956
- * Add a BUS Inputs/Outputs Service to the cell.
7213
+ * Add the BUS inputs/outputs service to the cell. Starts a containerized service that enables BUS connections via the specified ethernet port.
6957
7214
  * @summary Add Service
6958
7215
  * @param {string} cell Unique identifier addressing a cell in all API calls.
6959
7216
  * @param {BusIOType} busIOType
@@ -6965,7 +7222,7 @@ export const BUSInputsOutputsApiFactory = function (configuration?: Configuratio
6965
7222
  return localVarFp.addBusIOService(cell, busIOType, completionTimeout, options).then((request) => request(axios, basePath));
6966
7223
  },
6967
7224
  /**
6968
- * Adds an input/output to or updates an input/output on the PROFINET device.
7225
+ * 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
7226
  * @summary Add PROFINET Input/Output
6970
7227
  * @param {string} cell Unique identifier addressing a cell in all API calls.
6971
7228
  * @param {string} io Unique identifier to address an Input/Output in the cell.
@@ -6977,7 +7234,7 @@ export const BUSInputsOutputsApiFactory = function (configuration?: Configuratio
6977
7234
  return localVarFp.addProfinetIO(cell, io, profinetIOData, options).then((request) => request(axios, basePath));
6978
7235
  },
6979
7236
  /**
6980
- * Delete BUS Inputs/Outputs Service from the cell.
7237
+ * Remove the BUS inputs/outputs service from the cell.
6981
7238
  * @summary Clear Service
6982
7239
  * @param {string} cell Unique identifier addressing a cell in all API calls.
6983
7240
  * @param {number} [completionTimeout]
@@ -6988,7 +7245,7 @@ export const BUSInputsOutputsApiFactory = function (configuration?: Configuratio
6988
7245
  return localVarFp.clearBusIOService(cell, completionTimeout, options).then((request) => request(axios, basePath));
6989
7246
  },
6990
7247
  /**
6991
- * Removes the input/output from the PROFINET device.
7248
+ * Removes an input/output variable configuration from the PROFINET device, e.g. NOVA\'s PROFINET service.
6992
7249
  * @summary Remove PROFINET Input/Ouptut
6993
7250
  * @param {string} cell Unique identifier addressing a cell in all API calls.
6994
7251
  * @param {string} io Unique identifier to address an Input/Output in the cell.
@@ -6999,7 +7256,7 @@ export const BUSInputsOutputsApiFactory = function (configuration?: Configuratio
6999
7256
  return localVarFp.deleteProfinetIO(cell, io, options).then((request) => request(axios, basePath));
7000
7257
  },
7001
7258
  /**
7002
- * Get deployed BUS Inputs/Outputs Service.
7259
+ * Get deployed BUS inputs/outputs service.
7003
7260
  * @summary Get Service
7004
7261
  * @param {string} cell Unique identifier addressing a cell in all API calls.
7005
7262
  * @param {*} [options] Override http request option.
@@ -7030,7 +7287,7 @@ export const BUSInputsOutputsApiFactory = function (configuration?: Configuratio
7030
7287
  return localVarFp.getBusIOValues(cell, ios, options).then((request) => request(axios, basePath));
7031
7288
  },
7032
7289
  /**
7033
- * Get description of PROFINET
7290
+ * Get description of NOVA as a PROFINET device.
7034
7291
  * @summary Get PROFINET Description
7035
7292
  * @param {string} cell Unique identifier addressing a cell in all API calls.
7036
7293
  * @param {*} [options] Override http request option.
@@ -7040,7 +7297,7 @@ export const BUSInputsOutputsApiFactory = function (configuration?: Configuratio
7040
7297
  return localVarFp.getProfinetDescription(cell, options).then((request) => request(axios, basePath));
7041
7298
  },
7042
7299
  /**
7043
- * Get input/output configuration of the PROFINET device as file.
7300
+ * 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
7301
  * @summary PROFINET Inputs/Outputs to File
7045
7302
  * @param {string} cell Unique identifier addressing a cell in all API calls.
7046
7303
  * @param {number} [inputOffset]
@@ -7052,17 +7309,17 @@ export const BUSInputsOutputsApiFactory = function (configuration?: Configuratio
7052
7309
  return localVarFp.getProfinetIOsFromFile(cell, inputOffset, outputOffset, options).then((request) => request(axios, basePath));
7053
7310
  },
7054
7311
  /**
7055
- * List all BUS Input/Output descriptions.
7312
+ * 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
7313
  * @summary List Descriptions
7057
7314
  * @param {string} cell Unique identifier addressing a cell in all API calls.
7058
7315
  * @param {*} [options] Override http request option.
7059
7316
  * @throws {RequiredError}
7060
7317
  */
7061
- listBusIODescriptions(cell: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<IODescription>> {
7318
+ listBusIODescriptions(cell: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<IODescription2>> {
7062
7319
  return localVarFp.listBusIODescriptions(cell, options).then((request) => request(axios, basePath));
7063
7320
  },
7064
7321
  /**
7065
- * List all PROFINET input and outputs.
7322
+ * 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
7323
  * @summary List PROFINET Input/Output Configuration
7067
7324
  * @param {string} cell Unique identifier addressing a cell in all API calls.
7068
7325
  * @param {*} [options] Override http request option.
@@ -7083,7 +7340,7 @@ export const BUSInputsOutputsApiFactory = function (configuration?: Configuratio
7083
7340
  return localVarFp.setBusIOValues(cell, iOValue, options).then((request) => request(axios, basePath));
7084
7341
  },
7085
7342
  /**
7086
- * Sets inputs/outputs on the PROFINET device from file.
7343
+ * 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
7344
  * @summary Set PROFINET Inputs/Outputs from File
7088
7345
  * @param {string} cell Unique identifier addressing a cell in all API calls.
7089
7346
  * @param {ProfinetInputOutputConfig} profinetInputOutputConfig
@@ -7104,7 +7361,7 @@ export const BUSInputsOutputsApiFactory = function (configuration?: Configuratio
7104
7361
  */
7105
7362
  export class BUSInputsOutputsApi extends BaseAPI {
7106
7363
  /**
7107
- * Add a BUS Inputs/Outputs Service to the cell.
7364
+ * Add the BUS inputs/outputs service to the cell. Starts a containerized service that enables BUS connections via the specified ethernet port.
7108
7365
  * @summary Add Service
7109
7366
  * @param {string} cell Unique identifier addressing a cell in all API calls.
7110
7367
  * @param {BusIOType} busIOType
@@ -7118,7 +7375,7 @@ export class BUSInputsOutputsApi extends BaseAPI {
7118
7375
  }
7119
7376
 
7120
7377
  /**
7121
- * Adds an input/output to or updates an input/output on the PROFINET device.
7378
+ * 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
7379
  * @summary Add PROFINET Input/Output
7123
7380
  * @param {string} cell Unique identifier addressing a cell in all API calls.
7124
7381
  * @param {string} io Unique identifier to address an Input/Output in the cell.
@@ -7132,7 +7389,7 @@ export class BUSInputsOutputsApi extends BaseAPI {
7132
7389
  }
7133
7390
 
7134
7391
  /**
7135
- * Delete BUS Inputs/Outputs Service from the cell.
7392
+ * Remove the BUS inputs/outputs service from the cell.
7136
7393
  * @summary Clear Service
7137
7394
  * @param {string} cell Unique identifier addressing a cell in all API calls.
7138
7395
  * @param {number} [completionTimeout]
@@ -7145,7 +7402,7 @@ export class BUSInputsOutputsApi extends BaseAPI {
7145
7402
  }
7146
7403
 
7147
7404
  /**
7148
- * Removes the input/output from the PROFINET device.
7405
+ * Removes an input/output variable configuration from the PROFINET device, e.g. NOVA\'s PROFINET service.
7149
7406
  * @summary Remove PROFINET Input/Ouptut
7150
7407
  * @param {string} cell Unique identifier addressing a cell in all API calls.
7151
7408
  * @param {string} io Unique identifier to address an Input/Output in the cell.
@@ -7158,7 +7415,7 @@ export class BUSInputsOutputsApi extends BaseAPI {
7158
7415
  }
7159
7416
 
7160
7417
  /**
7161
- * Get deployed BUS Inputs/Outputs Service.
7418
+ * Get deployed BUS inputs/outputs service.
7162
7419
  * @summary Get Service
7163
7420
  * @param {string} cell Unique identifier addressing a cell in all API calls.
7164
7421
  * @param {*} [options] Override http request option.
@@ -7195,7 +7452,7 @@ export class BUSInputsOutputsApi extends BaseAPI {
7195
7452
  }
7196
7453
 
7197
7454
  /**
7198
- * Get description of PROFINET
7455
+ * Get description of NOVA as a PROFINET device.
7199
7456
  * @summary Get PROFINET Description
7200
7457
  * @param {string} cell Unique identifier addressing a cell in all API calls.
7201
7458
  * @param {*} [options] Override http request option.
@@ -7207,7 +7464,7 @@ export class BUSInputsOutputsApi extends BaseAPI {
7207
7464
  }
7208
7465
 
7209
7466
  /**
7210
- * Get input/output configuration of the PROFINET device as file.
7467
+ * 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
7468
  * @summary PROFINET Inputs/Outputs to File
7212
7469
  * @param {string} cell Unique identifier addressing a cell in all API calls.
7213
7470
  * @param {number} [inputOffset]
@@ -7221,7 +7478,7 @@ export class BUSInputsOutputsApi extends BaseAPI {
7221
7478
  }
7222
7479
 
7223
7480
  /**
7224
- * List all BUS Input/Output descriptions.
7481
+ * 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
7482
  * @summary List Descriptions
7226
7483
  * @param {string} cell Unique identifier addressing a cell in all API calls.
7227
7484
  * @param {*} [options] Override http request option.
@@ -7233,7 +7490,7 @@ export class BUSInputsOutputsApi extends BaseAPI {
7233
7490
  }
7234
7491
 
7235
7492
  /**
7236
- * List all PROFINET input and outputs.
7493
+ * 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
7494
  * @summary List PROFINET Input/Output Configuration
7238
7495
  * @param {string} cell Unique identifier addressing a cell in all API calls.
7239
7496
  * @param {*} [options] Override http request option.
@@ -7258,7 +7515,7 @@ export class BUSInputsOutputsApi extends BaseAPI {
7258
7515
  }
7259
7516
 
7260
7517
  /**
7261
- * Sets inputs/outputs on the PROFINET device from file.
7518
+ * 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
7519
  * @summary Set PROFINET Inputs/Outputs from File
7263
7520
  * @param {string} cell Unique identifier addressing a cell in all API calls.
7264
7521
  * @param {ProfinetInputOutputConfig} profinetInputOutputConfig
@@ -10725,7 +10982,7 @@ export class MotionGroupApi extends BaseAPI {
10725
10982
  export const MotionGroupModelsApiAxiosParamCreator = function (configuration?: Configuration) {
10726
10983
  return {
10727
10984
  /**
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.
10985
+ * 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
10986
  * @summary Get Collision Model
10730
10987
  * @param {string} cell Unique identifier addressing a cell in all API calls.
10731
10988
  * @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 +11080,7 @@ export const MotionGroupModelsApiFp = function(configuration?: Configuration) {
10823
11080
  const localVarAxiosParamCreator = MotionGroupModelsApiAxiosParamCreator(configuration)
10824
11081
  return {
10825
11082
  /**
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.
11083
+ * 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
11084
  * @summary Get Collision Model
10828
11085
  * @param {string} cell Unique identifier addressing a cell in all API calls.
10829
11086
  * @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 +11117,7 @@ export const MotionGroupModelsApiFactory = function (configuration?: Configurati
10860
11117
  const localVarFp = MotionGroupModelsApiFp(configuration)
10861
11118
  return {
10862
11119
  /**
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.
11120
+ * 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
11121
  * @summary Get Collision Model
10865
11122
  * @param {string} cell Unique identifier addressing a cell in all API calls.
10866
11123
  * @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 +11148,7 @@ export const MotionGroupModelsApiFactory = function (configuration?: Configurati
10891
11148
  */
10892
11149
  export class MotionGroupModelsApi extends BaseAPI {
10893
11150
  /**
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.
11151
+ * 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
11152
  * @summary Get Collision Model
10896
11153
  * @param {string} cell Unique identifier addressing a cell in all API calls.
10897
11154
  * @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 +11175,383 @@ export class MotionGroupModelsApi extends BaseAPI {
10918
11175
 
10919
11176
 
10920
11177
 
11178
+ /**
11179
+ * ProgramApi - axios parameter creator
11180
+ * @export
11181
+ */
11182
+ export const ProgramApiAxiosParamCreator = function (configuration?: Configuration) {
11183
+ return {
11184
+ /**
11185
+ * Get details of a program.
11186
+ * @summary Get program
11187
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
11188
+ * @param {string} program
11189
+ * @param {*} [options] Override http request option.
11190
+ * @throws {RequiredError}
11191
+ */
11192
+ getProgram: async (cell: string, program: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
11193
+ // verify required parameter 'cell' is not null or undefined
11194
+ assertParamExists('getProgram', 'cell', cell)
11195
+ // verify required parameter 'program' is not null or undefined
11196
+ assertParamExists('getProgram', 'program', program)
11197
+ const localVarPath = `/experimental/cells/{cell}/programs/{program}`
11198
+ .replace(`{${"cell"}}`, encodeURIComponent(String(cell)))
11199
+ .replace(`{${"program"}}`, encodeURIComponent(String(program)));
11200
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
11201
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
11202
+ let baseOptions;
11203
+ if (configuration) {
11204
+ baseOptions = configuration.baseOptions;
11205
+ }
11206
+
11207
+ const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
11208
+ const localVarHeaderParameter = {} as any;
11209
+ const localVarQueryParameter = {} as any;
11210
+
11211
+ // authentication BasicAuth required
11212
+ // http basic authentication required
11213
+ setBasicAuthToObject(localVarRequestOptions, configuration)
11214
+
11215
+ // authentication BearerAuth required
11216
+ // http bearer authentication required
11217
+ await setBearerAuthToObject(localVarHeaderParameter, configuration)
11218
+
11219
+
11220
+
11221
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
11222
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
11223
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
11224
+
11225
+ return {
11226
+ url: toPathString(localVarUrlObj),
11227
+ options: localVarRequestOptions,
11228
+ };
11229
+ },
11230
+ /**
11231
+ * List details of all existing programs.
11232
+ * @summary List programs
11233
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
11234
+ * @param {*} [options] Override http request option.
11235
+ * @throws {RequiredError}
11236
+ */
11237
+ listPrograms: async (cell: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
11238
+ // verify required parameter 'cell' is not null or undefined
11239
+ assertParamExists('listPrograms', 'cell', cell)
11240
+ const localVarPath = `/experimental/cells/{cell}/programs`
11241
+ .replace(`{${"cell"}}`, encodeURIComponent(String(cell)));
11242
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
11243
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
11244
+ let baseOptions;
11245
+ if (configuration) {
11246
+ baseOptions = configuration.baseOptions;
11247
+ }
11248
+
11249
+ const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
11250
+ const localVarHeaderParameter = {} as any;
11251
+ const localVarQueryParameter = {} as any;
11252
+
11253
+ // authentication BasicAuth required
11254
+ // http basic authentication required
11255
+ setBasicAuthToObject(localVarRequestOptions, configuration)
11256
+
11257
+ // authentication BearerAuth required
11258
+ // http bearer authentication required
11259
+ await setBearerAuthToObject(localVarHeaderParameter, configuration)
11260
+
11261
+
11262
+
11263
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
11264
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
11265
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
11266
+
11267
+ return {
11268
+ url: toPathString(localVarUrlObj),
11269
+ options: localVarRequestOptions,
11270
+ };
11271
+ },
11272
+ /**
11273
+ * This endpoint starts a new program execution. The program will be executed asynchronously.
11274
+ * @summary Start the program
11275
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
11276
+ * @param {string} program
11277
+ * @param {ProgramStartRequest} programStartRequest
11278
+ * @param {*} [options] Override http request option.
11279
+ * @throws {RequiredError}
11280
+ */
11281
+ startProgram: async (cell: string, program: string, programStartRequest: ProgramStartRequest, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
11282
+ // verify required parameter 'cell' is not null or undefined
11283
+ assertParamExists('startProgram', 'cell', cell)
11284
+ // verify required parameter 'program' is not null or undefined
11285
+ assertParamExists('startProgram', 'program', program)
11286
+ // verify required parameter 'programStartRequest' is not null or undefined
11287
+ assertParamExists('startProgram', 'programStartRequest', programStartRequest)
11288
+ const localVarPath = `/experimental/cells/{cell}/programs/{program}/start`
11289
+ .replace(`{${"cell"}}`, encodeURIComponent(String(cell)))
11290
+ .replace(`{${"program"}}`, encodeURIComponent(String(program)));
11291
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
11292
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
11293
+ let baseOptions;
11294
+ if (configuration) {
11295
+ baseOptions = configuration.baseOptions;
11296
+ }
11297
+
11298
+ const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
11299
+ const localVarHeaderParameter = {} as any;
11300
+ const localVarQueryParameter = {} as any;
11301
+
11302
+ // authentication BasicAuth required
11303
+ // http basic authentication required
11304
+ setBasicAuthToObject(localVarRequestOptions, configuration)
11305
+
11306
+ // authentication BearerAuth required
11307
+ // http bearer authentication required
11308
+ await setBearerAuthToObject(localVarHeaderParameter, configuration)
11309
+
11310
+
11311
+
11312
+ localVarHeaderParameter['Content-Type'] = 'application/json';
11313
+
11314
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
11315
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
11316
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
11317
+ localVarRequestOptions.data = serializeDataIfNeeded(programStartRequest, localVarRequestOptions, configuration)
11318
+
11319
+ return {
11320
+ url: toPathString(localVarUrlObj),
11321
+ options: localVarRequestOptions,
11322
+ };
11323
+ },
11324
+ /**
11325
+ * Stop a specific program run.
11326
+ * @summary Stop program run
11327
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
11328
+ * @param {string} program
11329
+ * @param {*} [options] Override http request option.
11330
+ * @throws {RequiredError}
11331
+ */
11332
+ stopProgram: async (cell: string, program: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
11333
+ // verify required parameter 'cell' is not null or undefined
11334
+ assertParamExists('stopProgram', 'cell', cell)
11335
+ // verify required parameter 'program' is not null or undefined
11336
+ assertParamExists('stopProgram', 'program', program)
11337
+ const localVarPath = `/experimental/cells/{cell}/programs/{program}/stop`
11338
+ .replace(`{${"cell"}}`, encodeURIComponent(String(cell)))
11339
+ .replace(`{${"program"}}`, encodeURIComponent(String(program)));
11340
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
11341
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
11342
+ let baseOptions;
11343
+ if (configuration) {
11344
+ baseOptions = configuration.baseOptions;
11345
+ }
11346
+
11347
+ const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
11348
+ const localVarHeaderParameter = {} as any;
11349
+ const localVarQueryParameter = {} as any;
11350
+
11351
+ // authentication BasicAuth required
11352
+ // http basic authentication required
11353
+ setBasicAuthToObject(localVarRequestOptions, configuration)
11354
+
11355
+ // authentication BearerAuth required
11356
+ // http bearer authentication required
11357
+ await setBearerAuthToObject(localVarHeaderParameter, configuration)
11358
+
11359
+
11360
+
11361
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
11362
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
11363
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
11364
+
11365
+ return {
11366
+ url: toPathString(localVarUrlObj),
11367
+ options: localVarRequestOptions,
11368
+ };
11369
+ },
11370
+ }
11371
+ };
11372
+
11373
+ /**
11374
+ * ProgramApi - functional programming interface
11375
+ * @export
11376
+ */
11377
+ export const ProgramApiFp = function(configuration?: Configuration) {
11378
+ const localVarAxiosParamCreator = ProgramApiAxiosParamCreator(configuration)
11379
+ return {
11380
+ /**
11381
+ * Get details of a program.
11382
+ * @summary Get program
11383
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
11384
+ * @param {string} program
11385
+ * @param {*} [options] Override http request option.
11386
+ * @throws {RequiredError}
11387
+ */
11388
+ async getProgram(cell: string, program: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Program>> {
11389
+ const localVarAxiosArgs = await localVarAxiosParamCreator.getProgram(cell, program, options);
11390
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
11391
+ const localVarOperationServerBasePath = operationServerMap['ProgramApi.getProgram']?.[localVarOperationServerIndex]?.url;
11392
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
11393
+ },
11394
+ /**
11395
+ * List details of all existing programs.
11396
+ * @summary List programs
11397
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
11398
+ * @param {*} [options] Override http request option.
11399
+ * @throws {RequiredError}
11400
+ */
11401
+ async listPrograms(cell: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<Program>>> {
11402
+ const localVarAxiosArgs = await localVarAxiosParamCreator.listPrograms(cell, options);
11403
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
11404
+ const localVarOperationServerBasePath = operationServerMap['ProgramApi.listPrograms']?.[localVarOperationServerIndex]?.url;
11405
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
11406
+ },
11407
+ /**
11408
+ * This endpoint starts a new program execution. The program will be executed asynchronously.
11409
+ * @summary Start the program
11410
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
11411
+ * @param {string} program
11412
+ * @param {ProgramStartRequest} programStartRequest
11413
+ * @param {*} [options] Override http request option.
11414
+ * @throws {RequiredError}
11415
+ */
11416
+ async startProgram(cell: string, program: string, programStartRequest: ProgramStartRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ProgramRun>> {
11417
+ const localVarAxiosArgs = await localVarAxiosParamCreator.startProgram(cell, program, programStartRequest, options);
11418
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
11419
+ const localVarOperationServerBasePath = operationServerMap['ProgramApi.startProgram']?.[localVarOperationServerIndex]?.url;
11420
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
11421
+ },
11422
+ /**
11423
+ * Stop a specific program run.
11424
+ * @summary Stop program run
11425
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
11426
+ * @param {string} program
11427
+ * @param {*} [options] Override http request option.
11428
+ * @throws {RequiredError}
11429
+ */
11430
+ async stopProgram(cell: string, program: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> {
11431
+ const localVarAxiosArgs = await localVarAxiosParamCreator.stopProgram(cell, program, options);
11432
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
11433
+ const localVarOperationServerBasePath = operationServerMap['ProgramApi.stopProgram']?.[localVarOperationServerIndex]?.url;
11434
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
11435
+ },
11436
+ }
11437
+ };
11438
+
11439
+ /**
11440
+ * ProgramApi - factory interface
11441
+ * @export
11442
+ */
11443
+ export const ProgramApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
11444
+ const localVarFp = ProgramApiFp(configuration)
11445
+ return {
11446
+ /**
11447
+ * Get details of a program.
11448
+ * @summary Get program
11449
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
11450
+ * @param {string} program
11451
+ * @param {*} [options] Override http request option.
11452
+ * @throws {RequiredError}
11453
+ */
11454
+ getProgram(cell: string, program: string, options?: RawAxiosRequestConfig): AxiosPromise<Program> {
11455
+ return localVarFp.getProgram(cell, program, options).then((request) => request(axios, basePath));
11456
+ },
11457
+ /**
11458
+ * List details of all existing programs.
11459
+ * @summary List programs
11460
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
11461
+ * @param {*} [options] Override http request option.
11462
+ * @throws {RequiredError}
11463
+ */
11464
+ listPrograms(cell: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<Program>> {
11465
+ return localVarFp.listPrograms(cell, options).then((request) => request(axios, basePath));
11466
+ },
11467
+ /**
11468
+ * This endpoint starts a new program execution. The program will be executed asynchronously.
11469
+ * @summary Start the program
11470
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
11471
+ * @param {string} program
11472
+ * @param {ProgramStartRequest} programStartRequest
11473
+ * @param {*} [options] Override http request option.
11474
+ * @throws {RequiredError}
11475
+ */
11476
+ startProgram(cell: string, program: string, programStartRequest: ProgramStartRequest, options?: RawAxiosRequestConfig): AxiosPromise<ProgramRun> {
11477
+ return localVarFp.startProgram(cell, program, programStartRequest, options).then((request) => request(axios, basePath));
11478
+ },
11479
+ /**
11480
+ * Stop a specific program run.
11481
+ * @summary Stop program run
11482
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
11483
+ * @param {string} program
11484
+ * @param {*} [options] Override http request option.
11485
+ * @throws {RequiredError}
11486
+ */
11487
+ stopProgram(cell: string, program: string, options?: RawAxiosRequestConfig): AxiosPromise<void> {
11488
+ return localVarFp.stopProgram(cell, program, options).then((request) => request(axios, basePath));
11489
+ },
11490
+ };
11491
+ };
11492
+
11493
+ /**
11494
+ * ProgramApi - object-oriented interface
11495
+ * @export
11496
+ * @class ProgramApi
11497
+ * @extends {BaseAPI}
11498
+ */
11499
+ export class ProgramApi extends BaseAPI {
11500
+ /**
11501
+ * Get details of a program.
11502
+ * @summary Get program
11503
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
11504
+ * @param {string} program
11505
+ * @param {*} [options] Override http request option.
11506
+ * @throws {RequiredError}
11507
+ * @memberof ProgramApi
11508
+ */
11509
+ public getProgram(cell: string, program: string, options?: RawAxiosRequestConfig) {
11510
+ return ProgramApiFp(this.configuration).getProgram(cell, program, options).then((request) => request(this.axios, this.basePath));
11511
+ }
11512
+
11513
+ /**
11514
+ * List details of all existing programs.
11515
+ * @summary List programs
11516
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
11517
+ * @param {*} [options] Override http request option.
11518
+ * @throws {RequiredError}
11519
+ * @memberof ProgramApi
11520
+ */
11521
+ public listPrograms(cell: string, options?: RawAxiosRequestConfig) {
11522
+ return ProgramApiFp(this.configuration).listPrograms(cell, options).then((request) => request(this.axios, this.basePath));
11523
+ }
11524
+
11525
+ /**
11526
+ * This endpoint starts a new program execution. The program will be executed asynchronously.
11527
+ * @summary Start the program
11528
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
11529
+ * @param {string} program
11530
+ * @param {ProgramStartRequest} programStartRequest
11531
+ * @param {*} [options] Override http request option.
11532
+ * @throws {RequiredError}
11533
+ * @memberof ProgramApi
11534
+ */
11535
+ public startProgram(cell: string, program: string, programStartRequest: ProgramStartRequest, options?: RawAxiosRequestConfig) {
11536
+ return ProgramApiFp(this.configuration).startProgram(cell, program, programStartRequest, options).then((request) => request(this.axios, this.basePath));
11537
+ }
11538
+
11539
+ /**
11540
+ * Stop a specific program run.
11541
+ * @summary Stop program run
11542
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
11543
+ * @param {string} program
11544
+ * @param {*} [options] Override http request option.
11545
+ * @throws {RequiredError}
11546
+ * @memberof ProgramApi
11547
+ */
11548
+ public stopProgram(cell: string, program: string, options?: RawAxiosRequestConfig) {
11549
+ return ProgramApiFp(this.configuration).stopProgram(cell, program, options).then((request) => request(this.axios, this.basePath));
11550
+ }
11551
+ }
11552
+
11553
+
11554
+
10921
11555
  /**
10922
11556
  * StoreCollisionComponentsApi - axios parameter creator
10923
11557
  * @export
@@ -11243,7 +11877,7 @@ export const StoreCollisionComponentsApiAxiosParamCreator = function (configurat
11243
11877
  };
11244
11878
  },
11245
11879
  /**
11246
- * Returns a list of colliders in a scene. This excludes colliders that are part of a motion group.
11880
+ * Returns all stored colliders.
11247
11881
  * @summary List Colliders
11248
11882
  * @param {string} cell Unique identifier addressing a cell in all API calls.
11249
11883
  * @param {*} [options] Override http request option.
@@ -11590,7 +12224,7 @@ export const StoreCollisionComponentsApiFp = function(configuration?: Configurat
11590
12224
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
11591
12225
  },
11592
12226
  /**
11593
- * Returns a list of colliders in a scene. This excludes colliders that are part of a motion group.
12227
+ * Returns all stored colliders.
11594
12228
  * @summary List Colliders
11595
12229
  * @param {string} cell Unique identifier addressing a cell in all API calls.
11596
12230
  * @param {*} [options] Override http request option.
@@ -11747,7 +12381,7 @@ export const StoreCollisionComponentsApiFactory = function (configuration?: Conf
11747
12381
  return localVarFp.listCollisionLinkChains(cell, options).then((request) => request(axios, basePath));
11748
12382
  },
11749
12383
  /**
11750
- * Returns a list of colliders in a scene. This excludes colliders that are part of a motion group.
12384
+ * Returns all stored colliders.
11751
12385
  * @summary List Colliders
11752
12386
  * @param {string} cell Unique identifier addressing a cell in all API calls.
11753
12387
  * @param {*} [options] Override http request option.
@@ -11903,7 +12537,7 @@ export class StoreCollisionComponentsApi extends BaseAPI {
11903
12537
  }
11904
12538
 
11905
12539
  /**
11906
- * Returns a list of colliders in a scene. This excludes colliders that are part of a motion group.
12540
+ * Returns all stored colliders.
11907
12541
  * @summary List Colliders
11908
12542
  * @param {string} cell Unique identifier addressing a cell in all API calls.
11909
12543
  * @param {*} [options] Override http request option.
@@ -14459,7 +15093,7 @@ export class TrajectoryPlanningApi extends BaseAPI {
14459
15093
  export const VirtualControllerApiAxiosParamCreator = function (configuration?: Configuration) {
14460
15094
  return {
14461
15095
  /**
14462
- * Adds a coordinate system to the robot controller.
15096
+ * 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
15097
  * @summary Add Coordinate Systems
14464
15098
  * @param {string} cell Unique identifier addressing a cell in all API calls.
14465
15099
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -14515,7 +15149,7 @@ export const VirtualControllerApiAxiosParamCreator = function (configuration?: C
14515
15149
  };
14516
15150
  },
14517
15151
  /**
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.
15152
+ * 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
15153
  * @summary Add TCP
14520
15154
  * @param {string} cell Unique identifier addressing a cell in all API calls.
14521
15155
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -14575,8 +15209,8 @@ export const VirtualControllerApiAxiosParamCreator = function (configuration?: C
14575
15209
  };
14576
15210
  },
14577
15211
  /**
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
15212
+ * 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.
15213
+ * @summary Delete Coordinate System
14580
15214
  * @param {string} cell Unique identifier addressing a cell in all API calls.
14581
15215
  * @param {string} controller Unique identifier to address a controller in the cell.
14582
15216
  * @param {string} coordinateSystem Unique identifier addressing a coordinate system.
@@ -14630,7 +15264,7 @@ export const VirtualControllerApiAxiosParamCreator = function (configuration?: C
14630
15264
  };
14631
15265
  },
14632
15266
  /**
14633
- * Removes the TCP from the motion group. An unknown TCP is a valid input.
15267
+ * 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
15268
  * @summary Remove TCP
14635
15269
  * @param {string} cell Unique identifier addressing a cell in all API calls.
14636
15270
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -15178,7 +15812,7 @@ export const VirtualControllerApiAxiosParamCreator = function (configuration?: C
15178
15812
  };
15179
15813
  },
15180
15814
  /**
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.
15815
+ * 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
15816
  * @summary Set Mounting
15183
15817
  * @param {string} cell Unique identifier addressing a cell in all API calls.
15184
15818
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -15244,7 +15878,7 @@ export const VirtualControllerApiFp = function(configuration?: Configuration) {
15244
15878
  const localVarAxiosParamCreator = VirtualControllerApiAxiosParamCreator(configuration)
15245
15879
  return {
15246
15880
  /**
15247
- * Adds a coordinate system to the robot controller.
15881
+ * 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
15882
  * @summary Add Coordinate Systems
15249
15883
  * @param {string} cell Unique identifier addressing a cell in all API calls.
15250
15884
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -15260,7 +15894,7 @@ export const VirtualControllerApiFp = function(configuration?: Configuration) {
15260
15894
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
15261
15895
  },
15262
15896
  /**
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.
15897
+ * 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
15898
  * @summary Add TCP
15265
15899
  * @param {string} cell Unique identifier addressing a cell in all API calls.
15266
15900
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -15277,8 +15911,8 @@ export const VirtualControllerApiFp = function(configuration?: Configuration) {
15277
15911
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
15278
15912
  },
15279
15913
  /**
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
15914
+ * 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.
15915
+ * @summary Delete Coordinate System
15282
15916
  * @param {string} cell Unique identifier addressing a cell in all API calls.
15283
15917
  * @param {string} controller Unique identifier to address a controller in the cell.
15284
15918
  * @param {string} coordinateSystem Unique identifier addressing a coordinate system.
@@ -15293,7 +15927,7 @@ export const VirtualControllerApiFp = function(configuration?: Configuration) {
15293
15927
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
15294
15928
  },
15295
15929
  /**
15296
- * Removes the TCP from the motion group. An unknown TCP is a valid input.
15930
+ * 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
15931
  * @summary Remove TCP
15298
15932
  * @param {string} cell Unique identifier addressing a cell in all API calls.
15299
15933
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -15456,7 +16090,7 @@ export const VirtualControllerApiFp = function(configuration?: Configuration) {
15456
16090
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
15457
16091
  },
15458
16092
  /**
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.
16093
+ * 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
16094
  * @summary Set Mounting
15461
16095
  * @param {string} cell Unique identifier addressing a cell in all API calls.
15462
16096
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -15482,7 +16116,7 @@ export const VirtualControllerApiFactory = function (configuration?: Configurati
15482
16116
  const localVarFp = VirtualControllerApiFp(configuration)
15483
16117
  return {
15484
16118
  /**
15485
- * Adds a coordinate system to the robot controller.
16119
+ * 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
16120
  * @summary Add Coordinate Systems
15487
16121
  * @param {string} cell Unique identifier addressing a cell in all API calls.
15488
16122
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -15495,7 +16129,7 @@ export const VirtualControllerApiFactory = function (configuration?: Configurati
15495
16129
  return localVarFp.addVirtualControllerCoordinateSystem(cell, controller, coordinateSystem, coordinateSystemData, options).then((request) => request(axios, basePath));
15496
16130
  },
15497
16131
  /**
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.
16132
+ * 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
16133
  * @summary Add TCP
15500
16134
  * @param {string} cell Unique identifier addressing a cell in all API calls.
15501
16135
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -15509,8 +16143,8 @@ export const VirtualControllerApiFactory = function (configuration?: Configurati
15509
16143
  return localVarFp.addVirtualControllerTcp(cell, controller, motionGroup, tcp, robotTcpData, options).then((request) => request(axios, basePath));
15510
16144
  },
15511
16145
  /**
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
16146
+ * 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.
16147
+ * @summary Delete Coordinate System
15514
16148
  * @param {string} cell Unique identifier addressing a cell in all API calls.
15515
16149
  * @param {string} controller Unique identifier to address a controller in the cell.
15516
16150
  * @param {string} coordinateSystem Unique identifier addressing a coordinate system.
@@ -15522,7 +16156,7 @@ export const VirtualControllerApiFactory = function (configuration?: Configurati
15522
16156
  return localVarFp.deleteVirtualControllerCoordinateSystem(cell, controller, coordinateSystem, deleteDependent, options).then((request) => request(axios, basePath));
15523
16157
  },
15524
16158
  /**
15525
- * Removes the TCP from the motion group. An unknown TCP is a valid input.
16159
+ * 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
16160
  * @summary Remove TCP
15527
16161
  * @param {string} cell Unique identifier addressing a cell in all API calls.
15528
16162
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -15652,7 +16286,7 @@ export const VirtualControllerApiFactory = function (configuration?: Configurati
15652
16286
  return localVarFp.setOperationMode(cell, controller, mode, options).then((request) => request(axios, basePath));
15653
16287
  },
15654
16288
  /**
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.
16289
+ * 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
16290
  * @summary Set Mounting
15657
16291
  * @param {string} cell Unique identifier addressing a cell in all API calls.
15658
16292
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -15675,7 +16309,7 @@ export const VirtualControllerApiFactory = function (configuration?: Configurati
15675
16309
  */
15676
16310
  export class VirtualControllerApi extends BaseAPI {
15677
16311
  /**
15678
- * Adds a coordinate system to the robot controller.
16312
+ * 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
16313
  * @summary Add Coordinate Systems
15680
16314
  * @param {string} cell Unique identifier addressing a cell in all API calls.
15681
16315
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -15690,7 +16324,7 @@ export class VirtualControllerApi extends BaseAPI {
15690
16324
  }
15691
16325
 
15692
16326
  /**
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.
16327
+ * 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
16328
  * @summary Add TCP
15695
16329
  * @param {string} cell Unique identifier addressing a cell in all API calls.
15696
16330
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -15706,8 +16340,8 @@ export class VirtualControllerApi extends BaseAPI {
15706
16340
  }
15707
16341
 
15708
16342
  /**
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
16343
+ * 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.
16344
+ * @summary Delete Coordinate System
15711
16345
  * @param {string} cell Unique identifier addressing a cell in all API calls.
15712
16346
  * @param {string} controller Unique identifier to address a controller in the cell.
15713
16347
  * @param {string} coordinateSystem Unique identifier addressing a coordinate system.
@@ -15721,7 +16355,7 @@ export class VirtualControllerApi extends BaseAPI {
15721
16355
  }
15722
16356
 
15723
16357
  /**
15724
- * Removes the TCP from the motion group. An unknown TCP is a valid input.
16358
+ * 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
16359
  * @summary Remove TCP
15726
16360
  * @param {string} cell Unique identifier addressing a cell in all API calls.
15727
16361
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -15873,7 +16507,7 @@ export class VirtualControllerApi extends BaseAPI {
15873
16507
  }
15874
16508
 
15875
16509
  /**
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.
16510
+ * 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
16511
  * @summary Set Mounting
15878
16512
  * @param {string} cell Unique identifier addressing a cell in all API calls.
15879
16513
  * @param {string} controller Unique identifier to address a controller in the cell.