@wandelbots/nova-api 25.7.2-rc.2 → 25.8.0-dev.100

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
  */
@@ -385,19 +385,19 @@ export interface BusIOProfinet {
385
385
  */
386
386
  'bus_type'?: BusIOProfinetBusTypeEnum;
387
387
  /**
388
- * Content of Configuration XML file for PROFINET device, typically known as PND_IOD.xml. Leave empty for the default configuration. Refer to the official PROFINET driver documentation for further information.
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
- * Used to enable IP communication through the same physical interface while PN Driver is running.
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 of the physical ethernet interface that you want to use for PROFINET communication.
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
  */
@@ -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
  /**
@@ -1889,7 +1902,7 @@ export interface IODescription2 {
1889
1902
  */
1890
1903
  'io': string;
1891
1904
  /**
1892
- * Descriptive name of the input/output. Customize it using the respective BUS service, e.g. [addProfinetIO](addProfinetIO) for PROFINET service.
1905
+ * Name of the input/output. Customize it using the respective BUS service, e.g. [addProfinetIO](addProfinetIO) for PROFINET service.
1893
1906
  * @type {string}
1894
1907
  * @memberof IODescription2
1895
1908
  */
@@ -1992,7 +2005,7 @@ export interface IOIntegerValue {
1992
2005
  */
1993
2006
  'io': string;
1994
2007
  /**
1995
- * 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.
1996
2009
  * @type {string}
1997
2010
  * @memberof IOIntegerValue
1998
2011
  */
@@ -2011,6 +2024,20 @@ export const IOIntegerValueValueTypeEnum = {
2011
2024
 
2012
2025
  export type IOIntegerValueValueTypeEnum = typeof IOIntegerValueValueTypeEnum[keyof typeof IOIntegerValueValueTypeEnum];
2013
2026
 
2027
+ /**
2028
+ * States the source of the input/output signal.
2029
+ * @export
2030
+ * @enum {string}
2031
+ */
2032
+
2033
+ export const IOOrigin = {
2034
+ Controller: 'CONTROLLER',
2035
+ BusIo: 'BUS_IO'
2036
+ } as const;
2037
+
2038
+ export type IOOrigin = typeof IOOrigin[keyof typeof IOOrigin];
2039
+
2040
+
2014
2041
  /**
2015
2042
  * @type IOValue
2016
2043
  * @export
@@ -2119,24 +2146,12 @@ export interface InitializeJoggingRequest {
2119
2146
  * @memberof InitializeJoggingRequest
2120
2147
  */
2121
2148
  'tcp'?: string;
2122
- /**
2123
- * 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.
2124
- * @type {number}
2125
- * @memberof InitializeJoggingRequest
2126
- */
2127
- 'response_rate'?: number;
2128
2149
  /**
2129
2150
  * Unique identifier addressing a coordinate system to which the responses are transformed. If not set, world coordinate system is used.
2130
2151
  * @type {string}
2131
2152
  * @memberof InitializeJoggingRequest
2132
2153
  */
2133
2154
  'response_coordinate_system'?: string;
2134
- /**
2135
- * Defines an input/output that is listened to during the movement. Execution pauses if the defined comparator evaluates to `true`.
2136
- * @type {string}
2137
- * @memberof InitializeJoggingRequest
2138
- */
2139
- 'pause_on_io'?: string;
2140
2155
  }
2141
2156
 
2142
2157
  export const InitializeJoggingRequestMessageTypeEnum = {
@@ -2195,12 +2210,6 @@ export interface InitializeMovementRequest {
2195
2210
  * @memberof InitializeMovementRequest
2196
2211
  */
2197
2212
  'initial_location'?: number;
2198
- /**
2199
- * 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.
2200
- * @type {number}
2201
- * @memberof InitializeMovementRequest
2202
- */
2203
- 'response_rate'?: number;
2204
2213
  /**
2205
2214
  * Unique identifier addressing a coordinate system to which the responses are transformed. If not set, world coordinate system is used.
2206
2215
  * @type {string}
@@ -2255,7 +2264,7 @@ export const InitializeMovementResponseKindEnum = {
2255
2264
  export type InitializeMovementResponseKindEnum = typeof InitializeMovementResponseKindEnum[keyof typeof InitializeMovementResponseKindEnum];
2256
2265
 
2257
2266
  /**
2258
- * Value of an input/output with integer representation. > The integral value is transmitted as a string to avoid precision loss during conversion to JSON. > We recommend to use int64 in your implementation. If you want to interact with int64 in numbers, > JS bigint libraries can help you to parse the string into an integral value.
2267
+ * Value of an input/output with integer representation. > The integral value is transmitted as a string to avoid precision loss during conversion to JSON. > Recommended: Use int64 in your implementation. If you want to interact with int64 in numbers, > JS bigint libraries can help you to parse the string into an integral value.
2259
2268
  * @export
2260
2269
  * @interface IntegerValue
2261
2270
  */
@@ -2455,10 +2464,10 @@ export type JoggingDetailsKindEnum = typeof JoggingDetailsKindEnum[keyof typeof
2455
2464
  * @type JoggingDetailsState
2456
2465
  * @export
2457
2466
  */
2458
- export type JoggingDetailsState = JoggingPausedByUser | JoggingPausedNearCollision | JoggingPausedNearJointLimit | JoggingPausedOnIO | JoggingRunning;
2467
+ export type JoggingDetailsState = { kind: 'PAUSED_BY_USER' } & JoggingPausedByUser | { kind: 'PAUSED_NEAR_COLLISION' } & JoggingPausedNearCollision | { kind: 'PAUSED_NEAR_JOINT_LIMIT' } & JoggingPausedNearJointLimit | { kind: 'PAUSED_ON_IO' } & JoggingPausedOnIO | { kind: 'RUNNING' } & JoggingRunning;
2459
2468
 
2460
2469
  /**
2461
- *
2470
+ * User has paused jogging.
2462
2471
  * @export
2463
2472
  * @interface JoggingPausedByUser
2464
2473
  */
@@ -2478,7 +2487,7 @@ export const JoggingPausedByUserKindEnum = {
2478
2487
  export type JoggingPausedByUserKindEnum = typeof JoggingPausedByUserKindEnum[keyof typeof JoggingPausedByUserKindEnum];
2479
2488
 
2480
2489
  /**
2481
- *
2490
+ * Jogging was paused because the motion group neared a collision.
2482
2491
  * @export
2483
2492
  * @interface JoggingPausedNearCollision
2484
2493
  */
@@ -2504,7 +2513,7 @@ export const JoggingPausedNearCollisionKindEnum = {
2504
2513
  export type JoggingPausedNearCollisionKindEnum = typeof JoggingPausedNearCollisionKindEnum[keyof typeof JoggingPausedNearCollisionKindEnum];
2505
2514
 
2506
2515
  /**
2507
- *
2516
+ * Jogging was paused because a joint is near its limit.
2508
2517
  * @export
2509
2518
  * @interface JoggingPausedNearJointLimit
2510
2519
  */
@@ -2530,7 +2539,7 @@ export const JoggingPausedNearJointLimitKindEnum = {
2530
2539
  export type JoggingPausedNearJointLimitKindEnum = typeof JoggingPausedNearJointLimitKindEnum[keyof typeof JoggingPausedNearJointLimitKindEnum];
2531
2540
 
2532
2541
  /**
2533
- *
2542
+ * Jogging was paused because of an I/O event.
2534
2543
  * @export
2535
2544
  * @interface JoggingPausedOnIO
2536
2545
  */
@@ -2550,7 +2559,7 @@ export const JoggingPausedOnIOKindEnum = {
2550
2559
  export type JoggingPausedOnIOKindEnum = typeof JoggingPausedOnIOKindEnum[keyof typeof JoggingPausedOnIOKindEnum];
2551
2560
 
2552
2561
  /**
2553
- *
2562
+ * Jogging is active.
2554
2563
  * @export
2555
2564
  * @interface JoggingRunning
2556
2565
  */
@@ -2621,10 +2630,10 @@ export interface JointLimits {
2621
2630
  export interface JointTrajectory {
2622
2631
  /**
2623
2632
  * List of joint positions [rad] for each sample. The number of samples must match the number of timestamps provided in the times field.
2624
- * @type {Array<Joints>}
2633
+ * @type {Array<Array<number>>}
2625
2634
  * @memberof JointTrajectory
2626
2635
  */
2627
- 'joint_positions': Array<Joints>;
2636
+ 'joint_positions': Array<Array<number>>;
2628
2637
  /**
2629
2638
  * Timestamp for each sample [s].
2630
2639
  * @type {Array<number>}
@@ -2632,7 +2641,7 @@ export interface JointTrajectory {
2632
2641
  */
2633
2642
  'times': Array<number>;
2634
2643
  /**
2635
- * Location for each sample, scalar value defining a position along a path. Typical range: 0 to `n`, `n` denoting the number of motion commands. Each integer value of the location corresponds to a specific motion command. If provided, the number of samples must match the number of timestamps provided in the times field.
2644
+ *
2636
2645
  * @type {Array<number>}
2637
2646
  * @memberof JointTrajectory
2638
2647
  */
@@ -2651,11 +2660,11 @@ export interface JointVelocityRequest {
2651
2660
  */
2652
2661
  'message_type'?: JointVelocityRequestMessageTypeEnum;
2653
2662
  /**
2654
- * in [rad/s]
2655
- * @type {Joints}
2663
+ * This structure describes a set of joint values (e.g. positions, currents, torques) of a motion group. Float precision is the default.
2664
+ * @type {Array<number>}
2656
2665
  * @memberof JointVelocityRequest
2657
2666
  */
2658
- 'velocity': Joints;
2667
+ 'velocity': Array<number>;
2659
2668
  }
2660
2669
 
2661
2670
  export const JointVelocityRequestMessageTypeEnum = {
@@ -2690,19 +2699,6 @@ export const JointVelocityResponseKindEnum = {
2690
2699
 
2691
2700
  export type JointVelocityResponseKindEnum = typeof JointVelocityResponseKindEnum[keyof typeof JointVelocityResponseKindEnum];
2692
2701
 
2693
- /**
2694
- * This structure describes a set of joint values of a motion group. We call a set of joint values describing the current position in joint space of a motion group a \"joint position\". Joint position was chosen as the term to be consistent with the terms \"joint velocity\" and \"joint acceleration\". `joints` must have as many entries as the motion group\'s degrees of freedom to be valid. Float precision is the default.
2695
- * @export
2696
- * @interface Joints
2697
- */
2698
- export interface Joints {
2699
- /**
2700
- *
2701
- * @type {Array<number>}
2702
- * @memberof Joints
2703
- */
2704
- 'joints': Array<number>;
2705
- }
2706
2702
  /**
2707
2703
  * The configuration of a physical KUKA robot controller has to contain an IP address. Additionally an RSI server configuration has to be specified in order to control the robot. Deploying the server is a functionality of this API.
2708
2704
  * @export
@@ -2733,6 +2729,12 @@ export interface KukaController {
2733
2729
  * @memberof KukaController
2734
2730
  */
2735
2731
  'rsi_server': KukaControllerRsiServer;
2732
+ /**
2733
+ * If true, uses slower cycle time of 12ms instead of 4ms.
2734
+ * @type {boolean}
2735
+ * @memberof KukaController
2736
+ */
2737
+ 'slow_cycle_rate'?: boolean;
2736
2738
  }
2737
2739
 
2738
2740
  export const KukaControllerKindEnum = {
@@ -2865,25 +2867,6 @@ export const LicenseStatusEnum = {
2865
2867
  export type LicenseStatusEnum = typeof LicenseStatusEnum[keyof typeof LicenseStatusEnum];
2866
2868
 
2867
2869
 
2868
- /**
2869
- *
2870
- * @export
2871
- * @interface LimitConfig
2872
- */
2873
- export interface LimitConfig {
2874
- /**
2875
- *
2876
- * @type {LimitSet}
2877
- * @memberof LimitConfig
2878
- */
2879
- 'physical_limits'?: LimitSet;
2880
- /**
2881
- *
2882
- * @type {OperationLimits}
2883
- * @memberof LimitConfig
2884
- */
2885
- 'operation_limits'?: OperationLimits;
2886
- }
2887
2870
  /**
2888
2871
  * The upper_limit must be greater then the lower_limit.
2889
2872
  * @export
@@ -2933,6 +2916,12 @@ export interface LimitSet {
2933
2916
  * @memberof LimitSet
2934
2917
  */
2935
2918
  'flange'?: CartesianLimits;
2919
+ /**
2920
+ *
2921
+ * @type {JointLimits}
2922
+ * @memberof LimitSet
2923
+ */
2924
+ 'coupled_shoulder_elbow_joint'?: JointLimits;
2936
2925
  }
2937
2926
  /**
2938
2927
  * If a limit is not set, the default value will be used.
@@ -3008,13 +2997,13 @@ export type Manufacturer = typeof Manufacturer[keyof typeof Manufacturer];
3008
2997
 
3009
2998
 
3010
2999
  /**
3011
- * Midpoint insertion algorithm configuration for collision-free path planning. This algorithm iteratively inserts midpoints between the start and target joint position to find collision-free paths.
3000
+ *
3012
3001
  * @export
3013
3002
  * @interface MidpointInsertionAlgorithm
3014
3003
  */
3015
3004
  export interface MidpointInsertionAlgorithm {
3016
3005
  /**
3017
- * Algorithm discriminator.
3006
+ * Algorithm discriminator. Midpoint insertion algorithm configuration for collision-free path planning. This algorithm adds a single midpoint between the start and target joint position to find collision-free paths.
3018
3007
  * @type {string}
3019
3008
  * @memberof MidpointInsertionAlgorithm
3020
3009
  */
@@ -3107,13 +3096,13 @@ export interface MotionGroupDescription {
3107
3096
  * @type {Pose}
3108
3097
  * @memberof MotionGroupDescription
3109
3098
  */
3110
- 'mounting': Pose;
3099
+ 'mounting'?: Pose;
3111
3100
  /**
3112
3101
  * Maps a TCP name to its offset relative to the flange coordinate system. Key must be a TCP identifier. Values are TcpOffsets.
3113
3102
  * @type {{ [key: string]: TcpOffset; }}
3114
3103
  * @memberof MotionGroupDescription
3115
3104
  */
3116
- 'tcps': { [key: string]: TcpOffset; };
3105
+ 'tcps'?: { [key: string]: TcpOffset; };
3117
3106
  /**
3118
3107
  * A collection of identifiable colliders.
3119
3108
  * @type {{ [key: string]: Collider; }}
@@ -3134,10 +3123,10 @@ export interface MotionGroupDescription {
3134
3123
  'safety_tool_colliders'?: { [key: string]: { [key: string]: Collider; }; };
3135
3124
  /**
3136
3125
  *
3137
- * @type {LimitConfig}
3126
+ * @type {OperationLimits}
3138
3127
  * @memberof MotionGroupDescription
3139
3128
  */
3140
- 'global_limits': LimitConfig;
3129
+ 'operation_limits': OperationLimits;
3141
3130
  /**
3142
3131
  * Maps a payload name to its configuration. Key must be a payload identifier. Values are payload objects.
3143
3132
  * @type {{ [key: string]: Payload; }}
@@ -3293,11 +3282,11 @@ export interface MotionGroupState {
3293
3282
  */
3294
3283
  'controller': string;
3295
3284
  /**
3296
- * Current joint position of each joint in [rad]
3297
- * @type {Joints}
3285
+ * This structure describes a set of joint values (e.g. positions, currents, torques) of a motion group. Float precision is the default.
3286
+ * @type {Array<number>}
3298
3287
  * @memberof MotionGroupState
3299
3288
  */
3300
- 'joint_position': Joints;
3289
+ 'joint_position': Array<number>;
3301
3290
  /**
3302
3291
  * Indicates whether the joint is in a limit for all joints of the motion group.
3303
3292
  * @type {MotionGroupStateJointLimitReached}
@@ -3305,17 +3294,17 @@ export interface MotionGroupState {
3305
3294
  */
3306
3295
  'joint_limit_reached': MotionGroupStateJointLimitReached;
3307
3296
  /**
3308
- * Current joint torque of each joint in [Nm]. Is only available if the robot controller supports it, e.g. available for UR controllers.
3309
- * @type {Joints}
3297
+ * This structure describes a set of joint values (e.g. positions, currents, torques) of a motion group. Float precision is the default.
3298
+ * @type {Array<number>}
3310
3299
  * @memberof MotionGroupState
3311
3300
  */
3312
- 'joint_torque'?: Joints;
3301
+ 'joint_torque'?: Array<number>;
3313
3302
  /**
3314
- * Current at TCP in [A]. Is only available if the robot controller supports it, e.g. available for UR controllers.
3315
- * @type {Joints}
3303
+ * This structure describes a set of joint values (e.g. positions, currents, torques) of a motion group. Float precision is the default.
3304
+ * @type {Array<number>}
3316
3305
  * @memberof MotionGroupState
3317
3306
  */
3318
- 'joint_current'?: Joints;
3307
+ 'joint_current'?: Array<number>;
3319
3308
  /**
3320
3309
  * Pose of the flange. Positions are in [mm]. Oriantations are in [rad]. The pose is relative to the response_coordinate_system specified in the request. For robot arms a flange pose is always returned, for positioners the flange might not be available, depending on the model.
3321
3310
  * @type {Pose}
@@ -3790,6 +3779,12 @@ export interface PauseOnIO {
3790
3779
  * @memberof PauseOnIO
3791
3780
  */
3792
3781
  'comparator': Comparator;
3782
+ /**
3783
+ *
3784
+ * @type {IOOrigin}
3785
+ * @memberof PauseOnIO
3786
+ */
3787
+ 'io_origin': IOOrigin;
3793
3788
  }
3794
3789
 
3795
3790
 
@@ -3913,11 +3908,11 @@ export interface PlanTrajectoryFailedResponse {
3913
3908
  */
3914
3909
  'error_feedback': PlanTrajectoryFailedResponseErrorFeedback;
3915
3910
  /**
3916
- *
3911
+ * Location on trajectory where the execution will start. The default value is the start (forward movement) or end (backward movement) of the trajectory. If you want to start your movement from an arbitrary location, e.g. in combination with [streamMoveToTrajectoryViaJointPTP](streamMoveToTrajectoryViaJointPTP), set the location by respecting the following format: - The location is a scalar value that defines a position along a path, typically ranging from 0 to `n`, where `n` denotes the number of motion commands - Each integer value of the location corresponds to a specific motion command, while non-integer values interpolate positions within the segments. - The location is calculated from the joint path
3917
3912
  * @type {number}
3918
3913
  * @memberof PlanTrajectoryFailedResponse
3919
3914
  */
3920
- 'error_location_on_trajectory'?: number;
3915
+ 'error_location_on_trajectory': number;
3921
3916
  /**
3922
3917
  * The joint trajectory from the start joint position to the error.
3923
3918
  * @type {JointTrajectory}
@@ -4154,11 +4149,11 @@ export interface ProfinetDescription {
4154
4149
  */
4155
4150
  export interface ProfinetIO {
4156
4151
  /**
4157
- * The name of the input/output variable. This is a human-readable identifier for the value. It distinguishes between different inputs/outputs variables in the system. The variables may be used to set bits or bytes at their pointed to address via [setBusIOValues](setBusIOValues).
4152
+ * Descriptive name or note for the input/output variable.
4158
4153
  * @type {string}
4159
4154
  * @memberof ProfinetIO
4160
4155
  */
4161
- 'name': string;
4156
+ 'description': string;
4162
4157
  /**
4163
4158
  *
4164
4159
  * @type {ProfinetIOTypeEnum}
@@ -4199,11 +4194,11 @@ export interface ProfinetIO {
4199
4194
  */
4200
4195
  export interface ProfinetIOData {
4201
4196
  /**
4202
- * The name of the input/output variable. This is a human-readable identifier for the value. It distinguishes between different inputs/outputs variables in the system. The variables may be used to set bits or bytes at their pointed to address via [setBusIOValues](setBusIOValues).
4197
+ * Descriptive name or note for the input/output variable.
4203
4198
  * @type {string}
4204
4199
  * @memberof ProfinetIOData
4205
4200
  */
4206
- 'name': string;
4201
+ 'description': string;
4207
4202
  /**
4208
4203
  *
4209
4204
  * @type {ProfinetIOTypeEnum}
@@ -4344,13 +4339,161 @@ export interface ProfinetSubSlotDescription {
4344
4339
  'output_length': number;
4345
4340
  }
4346
4341
  /**
4347
- * <!-- theme: danger --> > **Experimental** RRT Connect algorithm configuration for collision-free path planning. Rapidly-exploring Random Trees (RRT) builds trees of valid configurations by randomly sampling the joint space and connecting feasible points. RRT Connect grows two trees simultaneously from start and target positions until they meet. This is a custom implementation optimized for manipulator kinematics and collision checking in industrial contexts.
4342
+ * A program is a collection of instructions that are executed in the robot cell.
4343
+ * @export
4344
+ * @interface Program
4345
+ */
4346
+ export interface Program {
4347
+ /**
4348
+ *
4349
+ * @type {string}
4350
+ * @memberof Program
4351
+ */
4352
+ 'program': string;
4353
+ /**
4354
+ *
4355
+ * @type {string}
4356
+ * @memberof Program
4357
+ */
4358
+ 'name'?: string;
4359
+ /**
4360
+ *
4361
+ * @type {string}
4362
+ * @memberof Program
4363
+ */
4364
+ 'description'?: string;
4365
+ /**
4366
+ *
4367
+ * @type {string}
4368
+ * @memberof Program
4369
+ */
4370
+ 'app': string;
4371
+ /**
4372
+ *
4373
+ * @type {object}
4374
+ * @memberof Program
4375
+ */
4376
+ 'input_schema'?: object;
4377
+ /**
4378
+ *
4379
+ * @type {object}
4380
+ * @memberof Program
4381
+ */
4382
+ 'preconditions'?: object;
4383
+ }
4384
+ /**
4385
+ * Holds the state of a program run.
4386
+ * @export
4387
+ * @interface ProgramRun
4388
+ */
4389
+ export interface ProgramRun {
4390
+ /**
4391
+ * Unique identifier of the program run
4392
+ * @type {string}
4393
+ * @memberof ProgramRun
4394
+ */
4395
+ 'run': string;
4396
+ /**
4397
+ * Unique identifier of the program
4398
+ * @type {string}
4399
+ * @memberof ProgramRun
4400
+ */
4401
+ 'program': string;
4402
+ /**
4403
+ * State of the program run
4404
+ * @type {ProgramRunState}
4405
+ * @memberof ProgramRun
4406
+ */
4407
+ 'state': ProgramRunState;
4408
+ /**
4409
+ * Logs of the program run
4410
+ * @type {string}
4411
+ * @memberof ProgramRun
4412
+ */
4413
+ 'logs'?: string;
4414
+ /**
4415
+ * Stdout of the program run
4416
+ * @type {string}
4417
+ * @memberof ProgramRun
4418
+ */
4419
+ 'stdout'?: string;
4420
+ /**
4421
+ * Stderr of the program run
4422
+ * @type {string}
4423
+ * @memberof ProgramRun
4424
+ */
4425
+ 'stderr'?: string;
4426
+ /**
4427
+ * Error message of the program run, if any
4428
+ * @type {string}
4429
+ * @memberof ProgramRun
4430
+ */
4431
+ 'error'?: string;
4432
+ /**
4433
+ * Traceback of the program run, if any
4434
+ * @type {string}
4435
+ * @memberof ProgramRun
4436
+ */
4437
+ 'traceback'?: string;
4438
+ /**
4439
+ * Start time of the program run
4440
+ * @type {string}
4441
+ * @memberof ProgramRun
4442
+ */
4443
+ 'start_time'?: string;
4444
+ /**
4445
+ * End time of the program run
4446
+ * @type {string}
4447
+ * @memberof ProgramRun
4448
+ */
4449
+ 'end_time'?: string;
4450
+ /**
4451
+ * Input data of the program run
4452
+ * @type {object}
4453
+ * @memberof ProgramRun
4454
+ */
4455
+ 'input_data'?: object;
4456
+ }
4457
+
4458
+
4459
+ /**
4460
+ * The state of a program run.
4461
+ * @export
4462
+ * @enum {string}
4463
+ */
4464
+
4465
+ export const ProgramRunState = {
4466
+ Preparing: 'PREPARING',
4467
+ Running: 'RUNNING',
4468
+ Completed: 'COMPLETED',
4469
+ Failed: 'FAILED',
4470
+ Stopped: 'STOPPED'
4471
+ } as const;
4472
+
4473
+ export type ProgramRunState = typeof ProgramRunState[keyof typeof ProgramRunState];
4474
+
4475
+
4476
+ /**
4477
+ * The state of a program run.
4478
+ * @export
4479
+ * @interface ProgramStartRequest
4480
+ */
4481
+ export interface ProgramStartRequest {
4482
+ /**
4483
+ * The arguments to pass to the program.
4484
+ * @type {object}
4485
+ * @memberof ProgramStartRequest
4486
+ */
4487
+ 'arguments': object;
4488
+ }
4489
+ /**
4490
+ *
4348
4491
  * @export
4349
4492
  * @interface RRTConnectAlgorithm
4350
4493
  */
4351
4494
  export interface RRTConnectAlgorithm {
4352
4495
  /**
4353
- * Algorithm discriminator.
4496
+ * Algorithm discriminator. RRT Connect algorithm configuration for collision-free path planning. Rapidly-exploring Random Trees (RRT) builds trees of valid configurations by randomly sampling the joint space and connecting feasible points with JointPTP motions. RRT Connect grows two trees simultaneously from start and target positions until they meet. This is a custom implementation optimized for manipulator kinematics and collision checking in industrial contexts.
4354
4497
  * @type {string}
4355
4498
  * @memberof RRTConnectAlgorithm
4356
4499
  */
@@ -4361,6 +4504,30 @@ export interface RRTConnectAlgorithm {
4361
4504
  * @memberof RRTConnectAlgorithm
4362
4505
  */
4363
4506
  'max_iterations'?: number;
4507
+ /**
4508
+ * Maximum step size for tree extension in joint space.
4509
+ * @type {number}
4510
+ * @memberof RRTConnectAlgorithm
4511
+ */
4512
+ 'max_step_size'?: number;
4513
+ /**
4514
+ * Adjust the maximum step size during the search based on the recent success rate of tree expansion.
4515
+ * @type {boolean}
4516
+ * @memberof RRTConnectAlgorithm
4517
+ */
4518
+ 'adaptive_step_size'?: boolean;
4519
+ /**
4520
+ * Apply smoothing after the search has succeeded. This will remove as many intermediate points as possible while keeping the path valid.
4521
+ * @type {boolean}
4522
+ * @memberof RRTConnectAlgorithm
4523
+ */
4524
+ 'apply_smoothing'?: boolean;
4525
+ /**
4526
+ * Apply blending after the search has succeeded and smoothing has been applied. This will apply the largest viable blending at each intermediate point.
4527
+ * @type {boolean}
4528
+ * @memberof RRTConnectAlgorithm
4529
+ */
4530
+ 'apply_blending'?: boolean;
4364
4531
  }
4365
4532
 
4366
4533
  export const RRTConnectAlgorithmAlgorithmNameEnum = {
@@ -4790,6 +4957,33 @@ export interface ServiceStatusStatus {
4790
4957
  }
4791
4958
 
4792
4959
 
4960
+ /**
4961
+ * Defines an input/output that should be set upon reaching a specified location on the trajectory.
4962
+ * @export
4963
+ * @interface SetIO
4964
+ */
4965
+ export interface SetIO {
4966
+ /**
4967
+ *
4968
+ * @type {IOValue}
4969
+ * @memberof SetIO
4970
+ */
4971
+ 'io': IOValue;
4972
+ /**
4973
+ * The location on the trajectory where the input/output should be set.
4974
+ * @type {number}
4975
+ * @memberof SetIO
4976
+ */
4977
+ 'location': number;
4978
+ /**
4979
+ *
4980
+ * @type {IOOrigin}
4981
+ * @memberof SetIO
4982
+ */
4983
+ 'io_origin': IOOrigin;
4984
+ }
4985
+
4986
+
4793
4987
  /**
4794
4988
  *
4795
4989
  * @export
@@ -4863,12 +5057,18 @@ export interface StartMovementRequest {
4863
5057
  * @memberof StartMovementRequest
4864
5058
  */
4865
5059
  'direction'?: Direction;
5060
+ /**
5061
+ * Location on trajectory where the execution will start. The default value is the start (forward movement) or end (backward movement) of the trajectory. If you want to start your movement from an arbitrary location, e.g. in combination with [streamMoveToTrajectoryViaJointPTP](streamMoveToTrajectoryViaJointPTP), set the location by respecting the following format: - The location is a scalar value that defines a position along a path, typically ranging from 0 to `n`, where `n` denotes the number of motion commands - Each integer value of the location corresponds to a specific motion command, while non-integer values interpolate positions within the segments. - The location is calculated from the joint path
5062
+ * @type {number}
5063
+ * @memberof StartMovementRequest
5064
+ */
5065
+ 'target_location'?: number;
4866
5066
  /**
4867
5067
  * Attaches a list of output commands to the trajectory. The outputs are set to the specified values right after the specified location was reached. If the specified location is located before the start location (forward direction: value is smaller, backward direction: value is bigger), the output is not set.
4868
- * @type {Array<IOValue>}
5068
+ * @type {Array<SetIO>}
4869
5069
  * @memberof StartMovementRequest
4870
5070
  */
4871
- 'set_outputs'?: Array<IOValue>;
5071
+ 'set_outputs'?: Array<SetIO>;
4872
5072
  /**
4873
5073
  * Defines an input/output that is listened to before the movement. Execution starts if the defined comparator evaluates to `true`.
4874
5074
  * @type {StartOnIO}
@@ -4933,6 +5133,12 @@ export interface StartOnIO {
4933
5133
  * @memberof StartOnIO
4934
5134
  */
4935
5135
  'comparator': Comparator;
5136
+ /**
5137
+ *
5138
+ * @type {IOOrigin}
5139
+ * @memberof StartOnIO
5140
+ */
5141
+ 'io_origin': IOOrigin;
4936
5142
  }
4937
5143
 
4938
5144
 
@@ -5140,7 +5346,7 @@ export interface TrajectoryDetails {
5140
5346
  */
5141
5347
  'trajectory': string;
5142
5348
  /**
5143
- * Current location of motion group on the trajectory.
5349
+ * Location on trajectory where the execution will start. The default value is the start (forward movement) or end (backward movement) of the trajectory. If you want to start your movement from an arbitrary location, e.g. in combination with [streamMoveToTrajectoryViaJointPTP](streamMoveToTrajectoryViaJointPTP), set the location by respecting the following format: - The location is a scalar value that defines a position along a path, typically ranging from 0 to `n`, where `n` denotes the number of motion commands - Each integer value of the location corresponds to a specific motion command, while non-integer values interpolate positions within the segments. - The location is calculated from the joint path
5144
5350
  * @type {number}
5145
5351
  * @memberof TrajectoryDetails
5146
5352
  */
@@ -5169,10 +5375,10 @@ export type TrajectoryDetailsKindEnum = typeof TrajectoryDetailsKindEnum[keyof t
5169
5375
  * @type TrajectoryDetailsState
5170
5376
  * @export
5171
5377
  */
5172
- export type TrajectoryDetailsState = TrajectoryEnded | TrajectoryPausedByUser | TrajectoryPausedOnIO | TrajectoryRunning | TrajectoryWaitForIO;
5378
+ export type TrajectoryDetailsState = { kind: 'END_OF_TRAJECTORY' } & TrajectoryEnded | { kind: 'PAUSED_BY_USER' } & TrajectoryPausedByUser | { kind: 'PAUSED_ON_IO' } & TrajectoryPausedOnIO | { kind: 'RUNNING' } & TrajectoryRunning | { kind: 'WAIT_FOR_IO' } & TrajectoryWaitForIO;
5173
5379
 
5174
5380
  /**
5175
- *
5381
+ * First or last sample (depending on direction) of trajectory has been sent.
5176
5382
  * @export
5177
5383
  * @interface TrajectoryEnded
5178
5384
  */
@@ -5202,7 +5408,7 @@ export interface TrajectoryId {
5202
5408
  * @type {string}
5203
5409
  * @memberof TrajectoryId
5204
5410
  */
5205
- 'message_type'?: TrajectoryIdMessageTypeEnum;
5411
+ 'message_type': TrajectoryIdMessageTypeEnum;
5206
5412
  /**
5207
5413
  * The identifier of the trajectory which was returned by the [addTrajectory](addTrajectory) endpoint.
5208
5414
  * @type {string}
@@ -5218,7 +5424,7 @@ export const TrajectoryIdMessageTypeEnum = {
5218
5424
  export type TrajectoryIdMessageTypeEnum = typeof TrajectoryIdMessageTypeEnum[keyof typeof TrajectoryIdMessageTypeEnum];
5219
5425
 
5220
5426
  /**
5221
- *
5427
+ * User has paused execution.
5222
5428
  * @export
5223
5429
  * @interface TrajectoryPausedByUser
5224
5430
  */
@@ -5238,7 +5444,7 @@ export const TrajectoryPausedByUserKindEnum = {
5238
5444
  export type TrajectoryPausedByUserKindEnum = typeof TrajectoryPausedByUserKindEnum[keyof typeof TrajectoryPausedByUserKindEnum];
5239
5445
 
5240
5446
  /**
5241
- *
5447
+ * Execution was paused because of an I/O event.
5242
5448
  * @export
5243
5449
  * @interface TrajectoryPausedOnIO
5244
5450
  */
@@ -5258,7 +5464,7 @@ export const TrajectoryPausedOnIOKindEnum = {
5258
5464
  export type TrajectoryPausedOnIOKindEnum = typeof TrajectoryPausedOnIOKindEnum[keyof typeof TrajectoryPausedOnIOKindEnum];
5259
5465
 
5260
5466
  /**
5261
- *
5467
+ * Trajectory is being executed.
5262
5468
  * @export
5263
5469
  * @interface TrajectoryRunning
5264
5470
  */
@@ -5284,7 +5490,7 @@ export const TrajectoryRunningKindEnum = {
5284
5490
  export type TrajectoryRunningKindEnum = typeof TrajectoryRunningKindEnum[keyof typeof TrajectoryRunningKindEnum];
5285
5491
 
5286
5492
  /**
5287
- *
5493
+ * Waiting for an I/O event to start execution.
5288
5494
  * @export
5289
5495
  * @interface TrajectoryWaitForIO
5290
5496
  */
@@ -5397,6 +5603,31 @@ export interface ValidationError {
5397
5603
  */
5398
5604
  'input': { [key: string]: any; };
5399
5605
  }
5606
+ /**
5607
+ * A validation error of a program.
5608
+ * @export
5609
+ * @interface ValidationError2
5610
+ */
5611
+ export interface ValidationError2 {
5612
+ /**
5613
+ *
5614
+ * @type {Array<number>}
5615
+ * @memberof ValidationError2
5616
+ */
5617
+ 'loc': Array<number>;
5618
+ /**
5619
+ *
5620
+ * @type {string}
5621
+ * @memberof ValidationError2
5622
+ */
5623
+ 'msg': string;
5624
+ /**
5625
+ *
5626
+ * @type {string}
5627
+ * @memberof ValidationError2
5628
+ */
5629
+ 'type': string;
5630
+ }
5400
5631
  /**
5401
5632
  * @type ValidationErrorLocInner
5402
5633
  * @export
@@ -5524,11 +5755,13 @@ export const VirtualControllerTypes = {
5524
5755
  KukaKr4R600: 'kuka-kr4_r600',
5525
5756
  KukaKr500L3403: 'kuka-kr500_l340_3',
5526
5757
  KukaKr50R2500: 'kuka-kr50_r2500',
5758
+ KukaKr60R3: 'kuka-kr60_r3',
5527
5759
  KukaKr6R1820: 'kuka-kr6_r1820',
5528
5760
  KukaKr6R7002: 'kuka-kr6_r700_2',
5529
5761
  KukaKr6R700Sixx: 'kuka-kr6_r700_sixx',
5530
5762
  KukaKr6R900: 'kuka-kr6_r900',
5531
5763
  KukaKr6R9002: 'kuka-kr6_r900_2',
5764
+ KukaKr70R2100: 'kuka-kr70_r2100',
5532
5765
  KukaLbrIisy11R1300: 'kuka-lbr_iisy_11_r1300',
5533
5766
  UniversalrobotsUr10cb: 'universalrobots-ur10cb',
5534
5767
  UniversalrobotsUr10e: 'universalrobots-ur10e',
@@ -6637,7 +6870,7 @@ export const BUSInputsOutputsApiAxiosParamCreator = function (configuration?: Co
6637
6870
  };
6638
6871
  },
6639
6872
  /**
6640
- * 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 I/O direction is given in perspective of the BUS service.
6873
+ * List all input/output descriptions for configured BUS services. The input/output descriptions contain information such as the name, the type and the unit. The input/output direction is given in perspective of the BUS service.
6641
6874
  * @summary List Descriptions
6642
6875
  * @param {string} cell Unique identifier addressing a cell in all API calls.
6643
6876
  * @param {*} [options] Override http request option.
@@ -6679,7 +6912,7 @@ export const BUSInputsOutputsApiAxiosParamCreator = function (configuration?: Co
6679
6912
  };
6680
6913
  },
6681
6914
  /**
6682
- * 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 I/O 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 I/O 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.
6915
+ * List descriptions for all configured input/output variables of the PROFINET service. The input/output descriptions contain information such as the name, the type and the unit. The input/output direction is given in perspective of the PROFINET Device, e.g. the configured PROFINET service. The byte and bit addresses are the locations in the PROFINET input/output process image the variable points to. The PROFINET controller as well as NOVA\'s PROFINET service use an input/output variable configuration to interpret the bits of the input and output process image. The NOVA PROFINET service\'s configuration is modified via [addProfinetIO](addProfinetIO) and [setProfinetIOsFromFile](setProfinetIOsFromFile). For the PROFINET controller, e.g. a connected PLC, refer to the corresponding third party software, e.g. TIA portal.
6683
6916
  * @summary List PROFINET Input/Output Configuration
6684
6917
  * @param {string} cell Unique identifier addressing a cell in all API calls.
6685
6918
  * @param {*} [options] Override http request option.
@@ -6769,7 +7002,7 @@ export const BUSInputsOutputsApiAxiosParamCreator = function (configuration?: Co
6769
7002
  };
6770
7003
  },
6771
7004
  /**
6772
- * 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 (i.e. a connected PLC), refer to the corresponding engineering system (i.e. TIA portal). You can export the variable configuration of the PROFINET controller as XML file from you engineering system, i.e. 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, meaning that you can paste the exported XML file here without modifying.
7005
+ * Sets input/output variable configuration on the PROFINET device (i.e. NOVA\'s PROFINET service) from XML file. The inputs/outputs map variables to specific memory addresses in the process image. The default process image has buffer lengths of 64 bytes for input and output. The size of the buffer is determined by the `config_file_content` that is passed in [addBusIOService](addBusIOService) and has to be in accordance with the GSDML file describing the PROFINET device. The PROFINET controller as well as NOVA\'s PROFINET service use an input/output variable configuration to interpret the bits of the input/output process image. The NOVA\'s PROFINET service\'s configuration can be viewed via [listProfinetIOs](listProfinetIOs). For the PROFINET controller, e.g. a connected PLC, refer to the corresponding engineering system, e.g. TIA portal. You can export the variable configuration of the PROFINET controller as XML file from your engineering system, e.g. TIA portal. The endpoint is built so that the perspective of input and output (PROFINET Device\'s input is PROFINET Controller\'s output) is internally handled (PROFINET device input is PROFINET controller output), meaning that you can paste the exported XML file here without modifying.
6773
7006
  * @summary Set PROFINET Inputs/Outputs from File
6774
7007
  * @param {string} cell Unique identifier addressing a cell in all API calls.
6775
7008
  * @param {ProfinetInputOutputConfig} profinetInputOutputConfig
@@ -6953,7 +7186,7 @@ export const BUSInputsOutputsApiFp = function(configuration?: Configuration) {
6953
7186
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
6954
7187
  },
6955
7188
  /**
6956
- * 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 I/O direction is given in perspective of the BUS service.
7189
+ * List all input/output descriptions for configured BUS services. The input/output descriptions contain information such as the name, the type and the unit. The input/output direction is given in perspective of the BUS service.
6957
7190
  * @summary List Descriptions
6958
7191
  * @param {string} cell Unique identifier addressing a cell in all API calls.
6959
7192
  * @param {*} [options] Override http request option.
@@ -6966,7 +7199,7 @@ export const BUSInputsOutputsApiFp = function(configuration?: Configuration) {
6966
7199
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
6967
7200
  },
6968
7201
  /**
6969
- * 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 I/O 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 I/O 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.
7202
+ * List descriptions for all configured input/output variables of the PROFINET service. The input/output descriptions contain information such as the name, the type and the unit. The input/output direction is given in perspective of the PROFINET Device, e.g. the configured PROFINET service. The byte and bit addresses are the locations in the PROFINET input/output process image the variable points to. The PROFINET controller as well as NOVA\'s PROFINET service use an input/output variable configuration to interpret the bits of the input and output process image. The NOVA PROFINET service\'s configuration is modified via [addProfinetIO](addProfinetIO) and [setProfinetIOsFromFile](setProfinetIOsFromFile). For the PROFINET controller, e.g. a connected PLC, refer to the corresponding third party software, e.g. TIA portal.
6970
7203
  * @summary List PROFINET Input/Output Configuration
6971
7204
  * @param {string} cell Unique identifier addressing a cell in all API calls.
6972
7205
  * @param {*} [options] Override http request option.
@@ -6993,7 +7226,7 @@ export const BUSInputsOutputsApiFp = function(configuration?: Configuration) {
6993
7226
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
6994
7227
  },
6995
7228
  /**
6996
- * 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 (i.e. a connected PLC), refer to the corresponding engineering system (i.e. TIA portal). You can export the variable configuration of the PROFINET controller as XML file from you engineering system, i.e. 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, meaning that you can paste the exported XML file here without modifying.
7229
+ * Sets input/output variable configuration on the PROFINET device (i.e. NOVA\'s PROFINET service) from XML file. The inputs/outputs map variables to specific memory addresses in the process image. The default process image has buffer lengths of 64 bytes for input and output. The size of the buffer is determined by the `config_file_content` that is passed in [addBusIOService](addBusIOService) and has to be in accordance with the GSDML file describing the PROFINET device. The PROFINET controller as well as NOVA\'s PROFINET service use an input/output variable configuration to interpret the bits of the input/output process image. The NOVA\'s PROFINET service\'s configuration can be viewed via [listProfinetIOs](listProfinetIOs). For the PROFINET controller, e.g. a connected PLC, refer to the corresponding engineering system, e.g. TIA portal. You can export the variable configuration of the PROFINET controller as XML file from your engineering system, e.g. TIA portal. The endpoint is built so that the perspective of input and output (PROFINET Device\'s input is PROFINET Controller\'s output) is internally handled (PROFINET device input is PROFINET controller output), meaning that you can paste the exported XML file here without modifying.
6997
7230
  * @summary Set PROFINET Inputs/Outputs from File
6998
7231
  * @param {string} cell Unique identifier addressing a cell in all API calls.
6999
7232
  * @param {ProfinetInputOutputConfig} profinetInputOutputConfig
@@ -7116,7 +7349,7 @@ export const BUSInputsOutputsApiFactory = function (configuration?: Configuratio
7116
7349
  return localVarFp.getProfinetIOsFromFile(cell, inputOffset, outputOffset, options).then((request) => request(axios, basePath));
7117
7350
  },
7118
7351
  /**
7119
- * 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 I/O direction is given in perspective of the BUS service.
7352
+ * List all input/output descriptions for configured BUS services. The input/output descriptions contain information such as the name, the type and the unit. The input/output direction is given in perspective of the BUS service.
7120
7353
  * @summary List Descriptions
7121
7354
  * @param {string} cell Unique identifier addressing a cell in all API calls.
7122
7355
  * @param {*} [options] Override http request option.
@@ -7126,7 +7359,7 @@ export const BUSInputsOutputsApiFactory = function (configuration?: Configuratio
7126
7359
  return localVarFp.listBusIODescriptions(cell, options).then((request) => request(axios, basePath));
7127
7360
  },
7128
7361
  /**
7129
- * 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 I/O 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 I/O 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.
7362
+ * List descriptions for all configured input/output variables of the PROFINET service. The input/output descriptions contain information such as the name, the type and the unit. The input/output direction is given in perspective of the PROFINET Device, e.g. the configured PROFINET service. The byte and bit addresses are the locations in the PROFINET input/output process image the variable points to. The PROFINET controller as well as NOVA\'s PROFINET service use an input/output variable configuration to interpret the bits of the input and output process image. The NOVA PROFINET service\'s configuration is modified via [addProfinetIO](addProfinetIO) and [setProfinetIOsFromFile](setProfinetIOsFromFile). For the PROFINET controller, e.g. a connected PLC, refer to the corresponding third party software, e.g. TIA portal.
7130
7363
  * @summary List PROFINET Input/Output Configuration
7131
7364
  * @param {string} cell Unique identifier addressing a cell in all API calls.
7132
7365
  * @param {*} [options] Override http request option.
@@ -7147,7 +7380,7 @@ export const BUSInputsOutputsApiFactory = function (configuration?: Configuratio
7147
7380
  return localVarFp.setBusIOValues(cell, iOValue, options).then((request) => request(axios, basePath));
7148
7381
  },
7149
7382
  /**
7150
- * 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 (i.e. a connected PLC), refer to the corresponding engineering system (i.e. TIA portal). You can export the variable configuration of the PROFINET controller as XML file from you engineering system, i.e. 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, meaning that you can paste the exported XML file here without modifying.
7383
+ * Sets input/output variable configuration on the PROFINET device (i.e. NOVA\'s PROFINET service) from XML file. The inputs/outputs map variables to specific memory addresses in the process image. The default process image has buffer lengths of 64 bytes for input and output. The size of the buffer is determined by the `config_file_content` that is passed in [addBusIOService](addBusIOService) and has to be in accordance with the GSDML file describing the PROFINET device. The PROFINET controller as well as NOVA\'s PROFINET service use an input/output variable configuration to interpret the bits of the input/output process image. The NOVA\'s PROFINET service\'s configuration can be viewed via [listProfinetIOs](listProfinetIOs). For the PROFINET controller, e.g. a connected PLC, refer to the corresponding engineering system, e.g. TIA portal. You can export the variable configuration of the PROFINET controller as XML file from your engineering system, e.g. TIA portal. The endpoint is built so that the perspective of input and output (PROFINET Device\'s input is PROFINET Controller\'s output) is internally handled (PROFINET device input is PROFINET controller output), meaning that you can paste the exported XML file here without modifying.
7151
7384
  * @summary Set PROFINET Inputs/Outputs from File
7152
7385
  * @param {string} cell Unique identifier addressing a cell in all API calls.
7153
7386
  * @param {ProfinetInputOutputConfig} profinetInputOutputConfig
@@ -7285,7 +7518,7 @@ export class BUSInputsOutputsApi extends BaseAPI {
7285
7518
  }
7286
7519
 
7287
7520
  /**
7288
- * 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 I/O direction is given in perspective of the BUS service.
7521
+ * List all input/output descriptions for configured BUS services. The input/output descriptions contain information such as the name, the type and the unit. The input/output direction is given in perspective of the BUS service.
7289
7522
  * @summary List Descriptions
7290
7523
  * @param {string} cell Unique identifier addressing a cell in all API calls.
7291
7524
  * @param {*} [options] Override http request option.
@@ -7297,7 +7530,7 @@ export class BUSInputsOutputsApi extends BaseAPI {
7297
7530
  }
7298
7531
 
7299
7532
  /**
7300
- * 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 I/O 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 I/O 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.
7533
+ * List descriptions for all configured input/output variables of the PROFINET service. The input/output descriptions contain information such as the name, the type and the unit. The input/output direction is given in perspective of the PROFINET Device, e.g. the configured PROFINET service. The byte and bit addresses are the locations in the PROFINET input/output process image the variable points to. The PROFINET controller as well as NOVA\'s PROFINET service use an input/output variable configuration to interpret the bits of the input and output process image. The NOVA PROFINET service\'s configuration is modified via [addProfinetIO](addProfinetIO) and [setProfinetIOsFromFile](setProfinetIOsFromFile). For the PROFINET controller, e.g. a connected PLC, refer to the corresponding third party software, e.g. TIA portal.
7301
7534
  * @summary List PROFINET Input/Output Configuration
7302
7535
  * @param {string} cell Unique identifier addressing a cell in all API calls.
7303
7536
  * @param {*} [options] Override http request option.
@@ -7322,7 +7555,7 @@ export class BUSInputsOutputsApi extends BaseAPI {
7322
7555
  }
7323
7556
 
7324
7557
  /**
7325
- * 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 (i.e. a connected PLC), refer to the corresponding engineering system (i.e. TIA portal). You can export the variable configuration of the PROFINET controller as XML file from you engineering system, i.e. 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, meaning that you can paste the exported XML file here without modifying.
7558
+ * Sets input/output variable configuration on the PROFINET device (i.e. NOVA\'s PROFINET service) from XML file. The inputs/outputs map variables to specific memory addresses in the process image. The default process image has buffer lengths of 64 bytes for input and output. The size of the buffer is determined by the `config_file_content` that is passed in [addBusIOService](addBusIOService) and has to be in accordance with the GSDML file describing the PROFINET device. The PROFINET controller as well as NOVA\'s PROFINET service use an input/output variable configuration to interpret the bits of the input/output process image. The NOVA\'s PROFINET service\'s configuration can be viewed via [listProfinetIOs](listProfinetIOs). For the PROFINET controller, e.g. a connected PLC, refer to the corresponding engineering system, e.g. TIA portal. You can export the variable configuration of the PROFINET controller as XML file from your engineering system, e.g. TIA portal. The endpoint is built so that the perspective of input and output (PROFINET Device\'s input is PROFINET Controller\'s output) is internally handled (PROFINET device input is PROFINET controller output), meaning that you can paste the exported XML file here without modifying.
7326
7559
  * @summary Set PROFINET Inputs/Outputs from File
7327
7560
  * @param {string} cell Unique identifier addressing a cell in all API calls.
7328
7561
  * @param {ProfinetInputOutputConfig} profinetInputOutputConfig
@@ -10789,7 +11022,7 @@ export class MotionGroupApi extends BaseAPI {
10789
11022
  export const MotionGroupModelsApiAxiosParamCreator = function (configuration?: Configuration) {
10790
11023
  return {
10791
11024
  /**
10792
- * Returns the default collision link chain for a given motion group model. See [getMotionGroupDescription](getMotionGroupDescription) for supported motion group models. The default link chain is derived from 3D models and optimized for collision detection within NOVA. The default link chain includes link shapes only. It does not include any attached components like wire feeders or sensors. Use the `stored_link_chain` or `link_chain` field in [storeCollisionScene](storeCollisionScene) to attach additional shapes to the link reference frames. Additional shapes may overlap each other per link and may also overlap the respective link\'s default shape.
11025
+ * Returns the default collision link chain for a given motion group model. See [getMotionGroupModels](getMotionGroupModels) for supported motion group models. The default link chain is derived from 3D models and optimized for collision detection within NOVA. The default link chain includes link shapes only. It does not include any attached components like wire feeders or sensors. Attach additional shapes to the link reference frames by extending the link dictionaries before further use. Additional shapes may overlap each other per link and may also overlap the respective link\'s default shape.
10793
11026
  * @summary Get Collision Model
10794
11027
  * @param {string} cell Unique identifier addressing a cell in all API calls.
10795
11028
  * @param {string} motionGroupModel Unique identifier for the model of a motion group, e.g. &#x60;UniversalRobots_UR10e&#x60;. Get the &#x60;model&#x60; of a configured motion group with [getOptimizerConfiguration](getOptimizerConfiguration).
@@ -10887,7 +11120,7 @@ export const MotionGroupModelsApiFp = function(configuration?: Configuration) {
10887
11120
  const localVarAxiosParamCreator = MotionGroupModelsApiAxiosParamCreator(configuration)
10888
11121
  return {
10889
11122
  /**
10890
- * Returns the default collision link chain for a given motion group model. See [getMotionGroupDescription](getMotionGroupDescription) for supported motion group models. The default link chain is derived from 3D models and optimized for collision detection within NOVA. The default link chain includes link shapes only. It does not include any attached components like wire feeders or sensors. Use the `stored_link_chain` or `link_chain` field in [storeCollisionScene](storeCollisionScene) to attach additional shapes to the link reference frames. Additional shapes may overlap each other per link and may also overlap the respective link\'s default shape.
11123
+ * Returns the default collision link chain for a given motion group model. See [getMotionGroupModels](getMotionGroupModels) for supported motion group models. The default link chain is derived from 3D models and optimized for collision detection within NOVA. The default link chain includes link shapes only. It does not include any attached components like wire feeders or sensors. Attach additional shapes to the link reference frames by extending the link dictionaries before further use. Additional shapes may overlap each other per link and may also overlap the respective link\'s default shape.
10891
11124
  * @summary Get Collision Model
10892
11125
  * @param {string} cell Unique identifier addressing a cell in all API calls.
10893
11126
  * @param {string} motionGroupModel Unique identifier for the model of a motion group, e.g. &#x60;UniversalRobots_UR10e&#x60;. Get the &#x60;model&#x60; of a configured motion group with [getOptimizerConfiguration](getOptimizerConfiguration).
@@ -10924,7 +11157,7 @@ export const MotionGroupModelsApiFactory = function (configuration?: Configurati
10924
11157
  const localVarFp = MotionGroupModelsApiFp(configuration)
10925
11158
  return {
10926
11159
  /**
10927
- * Returns the default collision link chain for a given motion group model. See [getMotionGroupDescription](getMotionGroupDescription) for supported motion group models. The default link chain is derived from 3D models and optimized for collision detection within NOVA. The default link chain includes link shapes only. It does not include any attached components like wire feeders or sensors. Use the `stored_link_chain` or `link_chain` field in [storeCollisionScene](storeCollisionScene) to attach additional shapes to the link reference frames. Additional shapes may overlap each other per link and may also overlap the respective link\'s default shape.
11160
+ * Returns the default collision link chain for a given motion group model. See [getMotionGroupModels](getMotionGroupModels) for supported motion group models. The default link chain is derived from 3D models and optimized for collision detection within NOVA. The default link chain includes link shapes only. It does not include any attached components like wire feeders or sensors. Attach additional shapes to the link reference frames by extending the link dictionaries before further use. Additional shapes may overlap each other per link and may also overlap the respective link\'s default shape.
10928
11161
  * @summary Get Collision Model
10929
11162
  * @param {string} cell Unique identifier addressing a cell in all API calls.
10930
11163
  * @param {string} motionGroupModel Unique identifier for the model of a motion group, e.g. &#x60;UniversalRobots_UR10e&#x60;. Get the &#x60;model&#x60; of a configured motion group with [getOptimizerConfiguration](getOptimizerConfiguration).
@@ -10955,7 +11188,7 @@ export const MotionGroupModelsApiFactory = function (configuration?: Configurati
10955
11188
  */
10956
11189
  export class MotionGroupModelsApi extends BaseAPI {
10957
11190
  /**
10958
- * Returns the default collision link chain for a given motion group model. See [getMotionGroupDescription](getMotionGroupDescription) for supported motion group models. The default link chain is derived from 3D models and optimized for collision detection within NOVA. The default link chain includes link shapes only. It does not include any attached components like wire feeders or sensors. Use the `stored_link_chain` or `link_chain` field in [storeCollisionScene](storeCollisionScene) to attach additional shapes to the link reference frames. Additional shapes may overlap each other per link and may also overlap the respective link\'s default shape.
11191
+ * Returns the default collision link chain for a given motion group model. See [getMotionGroupModels](getMotionGroupModels) for supported motion group models. The default link chain is derived from 3D models and optimized for collision detection within NOVA. The default link chain includes link shapes only. It does not include any attached components like wire feeders or sensors. Attach additional shapes to the link reference frames by extending the link dictionaries before further use. Additional shapes may overlap each other per link and may also overlap the respective link\'s default shape.
10959
11192
  * @summary Get Collision Model
10960
11193
  * @param {string} cell Unique identifier addressing a cell in all API calls.
10961
11194
  * @param {string} motionGroupModel Unique identifier for the model of a motion group, e.g. &#x60;UniversalRobots_UR10e&#x60;. Get the &#x60;model&#x60; of a configured motion group with [getOptimizerConfiguration](getOptimizerConfiguration).
@@ -10982,6 +11215,383 @@ export class MotionGroupModelsApi extends BaseAPI {
10982
11215
 
10983
11216
 
10984
11217
 
11218
+ /**
11219
+ * ProgramApi - axios parameter creator
11220
+ * @export
11221
+ */
11222
+ export const ProgramApiAxiosParamCreator = function (configuration?: Configuration) {
11223
+ return {
11224
+ /**
11225
+ * Get details of a program.
11226
+ * @summary Get program
11227
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
11228
+ * @param {string} program
11229
+ * @param {*} [options] Override http request option.
11230
+ * @throws {RequiredError}
11231
+ */
11232
+ getProgram: async (cell: string, program: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
11233
+ // verify required parameter 'cell' is not null or undefined
11234
+ assertParamExists('getProgram', 'cell', cell)
11235
+ // verify required parameter 'program' is not null or undefined
11236
+ assertParamExists('getProgram', 'program', program)
11237
+ const localVarPath = `/experimental/cells/{cell}/programs/{program}`
11238
+ .replace(`{${"cell"}}`, encodeURIComponent(String(cell)))
11239
+ .replace(`{${"program"}}`, encodeURIComponent(String(program)));
11240
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
11241
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
11242
+ let baseOptions;
11243
+ if (configuration) {
11244
+ baseOptions = configuration.baseOptions;
11245
+ }
11246
+
11247
+ const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
11248
+ const localVarHeaderParameter = {} as any;
11249
+ const localVarQueryParameter = {} as any;
11250
+
11251
+ // authentication BasicAuth required
11252
+ // http basic authentication required
11253
+ setBasicAuthToObject(localVarRequestOptions, configuration)
11254
+
11255
+ // authentication BearerAuth required
11256
+ // http bearer authentication required
11257
+ await setBearerAuthToObject(localVarHeaderParameter, configuration)
11258
+
11259
+
11260
+
11261
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
11262
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
11263
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
11264
+
11265
+ return {
11266
+ url: toPathString(localVarUrlObj),
11267
+ options: localVarRequestOptions,
11268
+ };
11269
+ },
11270
+ /**
11271
+ * List details of all existing programs.
11272
+ * @summary List programs
11273
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
11274
+ * @param {*} [options] Override http request option.
11275
+ * @throws {RequiredError}
11276
+ */
11277
+ listPrograms: async (cell: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
11278
+ // verify required parameter 'cell' is not null or undefined
11279
+ assertParamExists('listPrograms', 'cell', cell)
11280
+ const localVarPath = `/experimental/cells/{cell}/programs`
11281
+ .replace(`{${"cell"}}`, encodeURIComponent(String(cell)));
11282
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
11283
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
11284
+ let baseOptions;
11285
+ if (configuration) {
11286
+ baseOptions = configuration.baseOptions;
11287
+ }
11288
+
11289
+ const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
11290
+ const localVarHeaderParameter = {} as any;
11291
+ const localVarQueryParameter = {} as any;
11292
+
11293
+ // authentication BasicAuth required
11294
+ // http basic authentication required
11295
+ setBasicAuthToObject(localVarRequestOptions, configuration)
11296
+
11297
+ // authentication BearerAuth required
11298
+ // http bearer authentication required
11299
+ await setBearerAuthToObject(localVarHeaderParameter, configuration)
11300
+
11301
+
11302
+
11303
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
11304
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
11305
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
11306
+
11307
+ return {
11308
+ url: toPathString(localVarUrlObj),
11309
+ options: localVarRequestOptions,
11310
+ };
11311
+ },
11312
+ /**
11313
+ * This endpoint starts a new program execution. The program will be executed asynchronously.
11314
+ * @summary Start the program
11315
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
11316
+ * @param {string} program
11317
+ * @param {ProgramStartRequest} programStartRequest
11318
+ * @param {*} [options] Override http request option.
11319
+ * @throws {RequiredError}
11320
+ */
11321
+ startProgram: async (cell: string, program: string, programStartRequest: ProgramStartRequest, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
11322
+ // verify required parameter 'cell' is not null or undefined
11323
+ assertParamExists('startProgram', 'cell', cell)
11324
+ // verify required parameter 'program' is not null or undefined
11325
+ assertParamExists('startProgram', 'program', program)
11326
+ // verify required parameter 'programStartRequest' is not null or undefined
11327
+ assertParamExists('startProgram', 'programStartRequest', programStartRequest)
11328
+ const localVarPath = `/experimental/cells/{cell}/programs/{program}/start`
11329
+ .replace(`{${"cell"}}`, encodeURIComponent(String(cell)))
11330
+ .replace(`{${"program"}}`, encodeURIComponent(String(program)));
11331
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
11332
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
11333
+ let baseOptions;
11334
+ if (configuration) {
11335
+ baseOptions = configuration.baseOptions;
11336
+ }
11337
+
11338
+ const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
11339
+ const localVarHeaderParameter = {} as any;
11340
+ const localVarQueryParameter = {} as any;
11341
+
11342
+ // authentication BasicAuth required
11343
+ // http basic authentication required
11344
+ setBasicAuthToObject(localVarRequestOptions, configuration)
11345
+
11346
+ // authentication BearerAuth required
11347
+ // http bearer authentication required
11348
+ await setBearerAuthToObject(localVarHeaderParameter, configuration)
11349
+
11350
+
11351
+
11352
+ localVarHeaderParameter['Content-Type'] = 'application/json';
11353
+
11354
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
11355
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
11356
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
11357
+ localVarRequestOptions.data = serializeDataIfNeeded(programStartRequest, localVarRequestOptions, configuration)
11358
+
11359
+ return {
11360
+ url: toPathString(localVarUrlObj),
11361
+ options: localVarRequestOptions,
11362
+ };
11363
+ },
11364
+ /**
11365
+ * Stop a specific program run.
11366
+ * @summary Stop program run
11367
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
11368
+ * @param {string} program
11369
+ * @param {*} [options] Override http request option.
11370
+ * @throws {RequiredError}
11371
+ */
11372
+ stopProgram: async (cell: string, program: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
11373
+ // verify required parameter 'cell' is not null or undefined
11374
+ assertParamExists('stopProgram', 'cell', cell)
11375
+ // verify required parameter 'program' is not null or undefined
11376
+ assertParamExists('stopProgram', 'program', program)
11377
+ const localVarPath = `/experimental/cells/{cell}/programs/{program}/stop`
11378
+ .replace(`{${"cell"}}`, encodeURIComponent(String(cell)))
11379
+ .replace(`{${"program"}}`, encodeURIComponent(String(program)));
11380
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
11381
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
11382
+ let baseOptions;
11383
+ if (configuration) {
11384
+ baseOptions = configuration.baseOptions;
11385
+ }
11386
+
11387
+ const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
11388
+ const localVarHeaderParameter = {} as any;
11389
+ const localVarQueryParameter = {} as any;
11390
+
11391
+ // authentication BasicAuth required
11392
+ // http basic authentication required
11393
+ setBasicAuthToObject(localVarRequestOptions, configuration)
11394
+
11395
+ // authentication BearerAuth required
11396
+ // http bearer authentication required
11397
+ await setBearerAuthToObject(localVarHeaderParameter, configuration)
11398
+
11399
+
11400
+
11401
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
11402
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
11403
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
11404
+
11405
+ return {
11406
+ url: toPathString(localVarUrlObj),
11407
+ options: localVarRequestOptions,
11408
+ };
11409
+ },
11410
+ }
11411
+ };
11412
+
11413
+ /**
11414
+ * ProgramApi - functional programming interface
11415
+ * @export
11416
+ */
11417
+ export const ProgramApiFp = function(configuration?: Configuration) {
11418
+ const localVarAxiosParamCreator = ProgramApiAxiosParamCreator(configuration)
11419
+ return {
11420
+ /**
11421
+ * Get details of a program.
11422
+ * @summary Get program
11423
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
11424
+ * @param {string} program
11425
+ * @param {*} [options] Override http request option.
11426
+ * @throws {RequiredError}
11427
+ */
11428
+ async getProgram(cell: string, program: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Program>> {
11429
+ const localVarAxiosArgs = await localVarAxiosParamCreator.getProgram(cell, program, options);
11430
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
11431
+ const localVarOperationServerBasePath = operationServerMap['ProgramApi.getProgram']?.[localVarOperationServerIndex]?.url;
11432
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
11433
+ },
11434
+ /**
11435
+ * List details of all existing programs.
11436
+ * @summary List programs
11437
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
11438
+ * @param {*} [options] Override http request option.
11439
+ * @throws {RequiredError}
11440
+ */
11441
+ async listPrograms(cell: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<Program>>> {
11442
+ const localVarAxiosArgs = await localVarAxiosParamCreator.listPrograms(cell, options);
11443
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
11444
+ const localVarOperationServerBasePath = operationServerMap['ProgramApi.listPrograms']?.[localVarOperationServerIndex]?.url;
11445
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
11446
+ },
11447
+ /**
11448
+ * This endpoint starts a new program execution. The program will be executed asynchronously.
11449
+ * @summary Start the program
11450
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
11451
+ * @param {string} program
11452
+ * @param {ProgramStartRequest} programStartRequest
11453
+ * @param {*} [options] Override http request option.
11454
+ * @throws {RequiredError}
11455
+ */
11456
+ async startProgram(cell: string, program: string, programStartRequest: ProgramStartRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ProgramRun>> {
11457
+ const localVarAxiosArgs = await localVarAxiosParamCreator.startProgram(cell, program, programStartRequest, options);
11458
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
11459
+ const localVarOperationServerBasePath = operationServerMap['ProgramApi.startProgram']?.[localVarOperationServerIndex]?.url;
11460
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
11461
+ },
11462
+ /**
11463
+ * Stop a specific program run.
11464
+ * @summary Stop program run
11465
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
11466
+ * @param {string} program
11467
+ * @param {*} [options] Override http request option.
11468
+ * @throws {RequiredError}
11469
+ */
11470
+ async stopProgram(cell: string, program: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> {
11471
+ const localVarAxiosArgs = await localVarAxiosParamCreator.stopProgram(cell, program, options);
11472
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
11473
+ const localVarOperationServerBasePath = operationServerMap['ProgramApi.stopProgram']?.[localVarOperationServerIndex]?.url;
11474
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
11475
+ },
11476
+ }
11477
+ };
11478
+
11479
+ /**
11480
+ * ProgramApi - factory interface
11481
+ * @export
11482
+ */
11483
+ export const ProgramApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
11484
+ const localVarFp = ProgramApiFp(configuration)
11485
+ return {
11486
+ /**
11487
+ * Get details of a program.
11488
+ * @summary Get program
11489
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
11490
+ * @param {string} program
11491
+ * @param {*} [options] Override http request option.
11492
+ * @throws {RequiredError}
11493
+ */
11494
+ getProgram(cell: string, program: string, options?: RawAxiosRequestConfig): AxiosPromise<Program> {
11495
+ return localVarFp.getProgram(cell, program, options).then((request) => request(axios, basePath));
11496
+ },
11497
+ /**
11498
+ * List details of all existing programs.
11499
+ * @summary List programs
11500
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
11501
+ * @param {*} [options] Override http request option.
11502
+ * @throws {RequiredError}
11503
+ */
11504
+ listPrograms(cell: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<Program>> {
11505
+ return localVarFp.listPrograms(cell, options).then((request) => request(axios, basePath));
11506
+ },
11507
+ /**
11508
+ * This endpoint starts a new program execution. The program will be executed asynchronously.
11509
+ * @summary Start the program
11510
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
11511
+ * @param {string} program
11512
+ * @param {ProgramStartRequest} programStartRequest
11513
+ * @param {*} [options] Override http request option.
11514
+ * @throws {RequiredError}
11515
+ */
11516
+ startProgram(cell: string, program: string, programStartRequest: ProgramStartRequest, options?: RawAxiosRequestConfig): AxiosPromise<ProgramRun> {
11517
+ return localVarFp.startProgram(cell, program, programStartRequest, options).then((request) => request(axios, basePath));
11518
+ },
11519
+ /**
11520
+ * Stop a specific program run.
11521
+ * @summary Stop program run
11522
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
11523
+ * @param {string} program
11524
+ * @param {*} [options] Override http request option.
11525
+ * @throws {RequiredError}
11526
+ */
11527
+ stopProgram(cell: string, program: string, options?: RawAxiosRequestConfig): AxiosPromise<void> {
11528
+ return localVarFp.stopProgram(cell, program, options).then((request) => request(axios, basePath));
11529
+ },
11530
+ };
11531
+ };
11532
+
11533
+ /**
11534
+ * ProgramApi - object-oriented interface
11535
+ * @export
11536
+ * @class ProgramApi
11537
+ * @extends {BaseAPI}
11538
+ */
11539
+ export class ProgramApi extends BaseAPI {
11540
+ /**
11541
+ * Get details of a program.
11542
+ * @summary Get program
11543
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
11544
+ * @param {string} program
11545
+ * @param {*} [options] Override http request option.
11546
+ * @throws {RequiredError}
11547
+ * @memberof ProgramApi
11548
+ */
11549
+ public getProgram(cell: string, program: string, options?: RawAxiosRequestConfig) {
11550
+ return ProgramApiFp(this.configuration).getProgram(cell, program, options).then((request) => request(this.axios, this.basePath));
11551
+ }
11552
+
11553
+ /**
11554
+ * List details of all existing programs.
11555
+ * @summary List programs
11556
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
11557
+ * @param {*} [options] Override http request option.
11558
+ * @throws {RequiredError}
11559
+ * @memberof ProgramApi
11560
+ */
11561
+ public listPrograms(cell: string, options?: RawAxiosRequestConfig) {
11562
+ return ProgramApiFp(this.configuration).listPrograms(cell, options).then((request) => request(this.axios, this.basePath));
11563
+ }
11564
+
11565
+ /**
11566
+ * This endpoint starts a new program execution. The program will be executed asynchronously.
11567
+ * @summary Start the program
11568
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
11569
+ * @param {string} program
11570
+ * @param {ProgramStartRequest} programStartRequest
11571
+ * @param {*} [options] Override http request option.
11572
+ * @throws {RequiredError}
11573
+ * @memberof ProgramApi
11574
+ */
11575
+ public startProgram(cell: string, program: string, programStartRequest: ProgramStartRequest, options?: RawAxiosRequestConfig) {
11576
+ return ProgramApiFp(this.configuration).startProgram(cell, program, programStartRequest, options).then((request) => request(this.axios, this.basePath));
11577
+ }
11578
+
11579
+ /**
11580
+ * Stop a specific program run.
11581
+ * @summary Stop program run
11582
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
11583
+ * @param {string} program
11584
+ * @param {*} [options] Override http request option.
11585
+ * @throws {RequiredError}
11586
+ * @memberof ProgramApi
11587
+ */
11588
+ public stopProgram(cell: string, program: string, options?: RawAxiosRequestConfig) {
11589
+ return ProgramApiFp(this.configuration).stopProgram(cell, program, options).then((request) => request(this.axios, this.basePath));
11590
+ }
11591
+ }
11592
+
11593
+
11594
+
10985
11595
  /**
10986
11596
  * StoreCollisionComponentsApi - axios parameter creator
10987
11597
  * @export
@@ -11307,7 +11917,7 @@ export const StoreCollisionComponentsApiAxiosParamCreator = function (configurat
11307
11917
  };
11308
11918
  },
11309
11919
  /**
11310
- * Returns a list of colliders in a scene. This excludes colliders that are part of a motion group.
11920
+ * Returns all stored colliders.
11311
11921
  * @summary List Colliders
11312
11922
  * @param {string} cell Unique identifier addressing a cell in all API calls.
11313
11923
  * @param {*} [options] Override http request option.
@@ -11654,7 +12264,7 @@ export const StoreCollisionComponentsApiFp = function(configuration?: Configurat
11654
12264
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
11655
12265
  },
11656
12266
  /**
11657
- * Returns a list of colliders in a scene. This excludes colliders that are part of a motion group.
12267
+ * Returns all stored colliders.
11658
12268
  * @summary List Colliders
11659
12269
  * @param {string} cell Unique identifier addressing a cell in all API calls.
11660
12270
  * @param {*} [options] Override http request option.
@@ -11811,7 +12421,7 @@ export const StoreCollisionComponentsApiFactory = function (configuration?: Conf
11811
12421
  return localVarFp.listCollisionLinkChains(cell, options).then((request) => request(axios, basePath));
11812
12422
  },
11813
12423
  /**
11814
- * Returns a list of colliders in a scene. This excludes colliders that are part of a motion group.
12424
+ * Returns all stored colliders.
11815
12425
  * @summary List Colliders
11816
12426
  * @param {string} cell Unique identifier addressing a cell in all API calls.
11817
12427
  * @param {*} [options] Override http request option.
@@ -11967,7 +12577,7 @@ export class StoreCollisionComponentsApi extends BaseAPI {
11967
12577
  }
11968
12578
 
11969
12579
  /**
11970
- * Returns a list of colliders in a scene. This excludes colliders that are part of a motion group.
12580
+ * Returns all stored colliders.
11971
12581
  * @summary List Colliders
11972
12582
  * @param {string} cell Unique identifier addressing a cell in all API calls.
11973
12583
  * @param {*} [options] Override http request option.
@@ -14523,7 +15133,7 @@ export class TrajectoryPlanningApi extends BaseAPI {
14523
15133
  export const VirtualControllerApiAxiosParamCreator = function (configuration?: Configuration) {
14524
15134
  return {
14525
15135
  /**
14526
- * Adds a coordinate system to the robot controller.
15136
+ * Adds a coordinate system to the robot controller. **Important notes:** - When a new coordinate system is added/removed, the **virtual robot is restarted** in the background in order to apply the new configuration. - During this restart: - Robot visualization may temporarily disappear or appear outdated in the UI. - coordinate system changes are not immediately visible in visualizations. - All existing connections to the virtual robot are closed and re-established, which introduces a short delay before the system is fully operational again. - The API call itself does **not wait until the restart and re-synchronization are complete**. This means that immediately after a successful response, the new coordinate system may not yet be available for visualization or program execution.
14527
15137
  * @summary Add Coordinate Systems
14528
15138
  * @param {string} cell Unique identifier addressing a cell in all API calls.
14529
15139
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -14579,7 +15189,7 @@ export const VirtualControllerApiAxiosParamCreator = function (configuration?: C
14579
15189
  };
14580
15190
  },
14581
15191
  /**
14582
- * Adds a new TCP or updates an existing TCP in the motion group. The position and rotation values in the request body are defined within the flanges coordinate system. > **NOTE** > > Ensure the TCP\'s position is within the robot\'s reach. Refer to the robots documentation or data sheet for details like joint limits or reach.
15192
+ * Adds a new TCP (Tool Center Point) or updates an existing TCP in the motion group. The position and rotation values in the request body are defined within the flange\'s coordinate system. > **NOTE** > Ensure the TCP\'s position is within the robot\'s reach. Refer to the robot\'s documentation or data sheet for details like joint limits or reach. **Important notes:** - Adding or updating a TCP triggers a **virtual robot restart** to apply the new configuration. - During this restart: - The robot visualization in the UI may temporarily disappear. - The TCP visualization may not immediately appear, or may look outdated during the first test/rerun. - All active connections to the virtual robot are closed and then re-established. This creates a delay before the TCP is available in both the UI and robot programs. - The API call itself does **not wait until the restart and synchronization are complete**. Even if the request succeeds, the new or updated TCP may not yet be visible in the GUI or available for use.
14583
15193
  * @summary Add TCP
14584
15194
  * @param {string} cell Unique identifier addressing a cell in all API calls.
14585
15195
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -14639,8 +15249,8 @@ export const VirtualControllerApiAxiosParamCreator = function (configuration?: C
14639
15249
  };
14640
15250
  },
14641
15251
  /**
14642
- * 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.
14643
- * @summary Remove Coordinate System
15252
+ * Deletes a coordinate system from the virtual controller. This will remove the coordinate system from the list of coordinate systems and also remove all dependent coordinate systems that use the deleted coordinate system as reference. **Important notes:** - When a new coordinate system is added/removed, the **virtual robot is restarted** in the background in order to apply the new configuration. - During this restart: - Robot visualization may temporarily disappear or appear outdated in the UI. - coordinate system changes are not immediately visible in visualizations. - All existing connections to the virtual robot are closed and re-established, which introduces a short delay before the system is fully operational again. - The API call itself does **not wait until the restart and re-synchronization are complete**. This means that immediately after a successful response, the new coordinate system may not yet be available for visualization or program execution.
15253
+ * @summary Delete Coordinate System
14644
15254
  * @param {string} cell Unique identifier addressing a cell in all API calls.
14645
15255
  * @param {string} controller Unique identifier to address a controller in the cell.
14646
15256
  * @param {string} coordinateSystem Unique identifier addressing a coordinate system.
@@ -14694,7 +15304,7 @@ export const VirtualControllerApiAxiosParamCreator = function (configuration?: C
14694
15304
  };
14695
15305
  },
14696
15306
  /**
14697
- * Removes the TCP from the motion group. An unknown TCP is a valid input.
15307
+ * Removes the TCP (Tool Center Point) from the motion group. An unknown TCP is a valid input and will simply be ignored. **Important notes:** - Removing or updating a TCP triggers a **virtual robot restart** to apply the new configuration. - During this restart: - The robot visualization in the UI may temporarily disappear. - The TCP visualization may not immediately appear, or may look outdated during the first test/rerun. - All active connections to the virtual robot are closed and then re-established. This creates a delay before the TCP is available in both the UI and robot programs. - The API call itself does **not wait until the restart and synchronization are complete**. Even if the request succeeds, the new or updated TCP may not yet be visible in the GUI or available for use.
14698
15308
  * @summary Remove TCP
14699
15309
  * @param {string} cell Unique identifier addressing a cell in all API calls.
14700
15310
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -15242,7 +15852,7 @@ export const VirtualControllerApiAxiosParamCreator = function (configuration?: C
15242
15852
  };
15243
15853
  },
15244
15854
  /**
15245
- * Sets motion group mounting by specifying a coordinate system. The motion group will be based on the coordinate system\'s origin. The coordinate system defines a transformation offset. The transformation offset is defined by a unique identifier, a name for front end usage and an offset in another coordinate system referenced by the unique identifier of the reference coordinate system.
15855
+ * Sets the motion group mounting by specifying a coordinate system. The motion group will be based on the coordinate system\'s origin. The coordinate system defines a transformation offset, which consists of: - A unique identifier - A user-facing name - An offset in another coordinate system, referenced by the unique identifier of the reference coordinate system. **Important notes:** - Changing the mounting configuration is treated as a setup change. - When the mounting is set to a new coordinate system, the **virtual robot restarts** in the background to apply the new configuration. - During this process: - Robot visualization may temporarily disappear or not reflect the new mounting immediately. - Motion group state and coordinate system alignment may not be instantly updated in the UI. - All connections to the virtual robot are closed and then re-established, which can cause a short delay before the system is ready again. - The API call itself does **not wait until the restart and synchronization are complete**. A successful response indicates that the request was accepted, but the updated mounting may not yet be visible.
15246
15856
  * @summary Set Mounting
15247
15857
  * @param {string} cell Unique identifier addressing a cell in all API calls.
15248
15858
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -15308,7 +15918,7 @@ export const VirtualControllerApiFp = function(configuration?: Configuration) {
15308
15918
  const localVarAxiosParamCreator = VirtualControllerApiAxiosParamCreator(configuration)
15309
15919
  return {
15310
15920
  /**
15311
- * Adds a coordinate system to the robot controller.
15921
+ * Adds a coordinate system to the robot controller. **Important notes:** - When a new coordinate system is added/removed, the **virtual robot is restarted** in the background in order to apply the new configuration. - During this restart: - Robot visualization may temporarily disappear or appear outdated in the UI. - coordinate system changes are not immediately visible in visualizations. - All existing connections to the virtual robot are closed and re-established, which introduces a short delay before the system is fully operational again. - The API call itself does **not wait until the restart and re-synchronization are complete**. This means that immediately after a successful response, the new coordinate system may not yet be available for visualization or program execution.
15312
15922
  * @summary Add Coordinate Systems
15313
15923
  * @param {string} cell Unique identifier addressing a cell in all API calls.
15314
15924
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -15324,7 +15934,7 @@ export const VirtualControllerApiFp = function(configuration?: Configuration) {
15324
15934
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
15325
15935
  },
15326
15936
  /**
15327
- * Adds a new TCP or updates an existing TCP in the motion group. The position and rotation values in the request body are defined within the flanges coordinate system. > **NOTE** > > Ensure the TCP\'s position is within the robot\'s reach. Refer to the robots documentation or data sheet for details like joint limits or reach.
15937
+ * Adds a new TCP (Tool Center Point) or updates an existing TCP in the motion group. The position and rotation values in the request body are defined within the flange\'s coordinate system. > **NOTE** > Ensure the TCP\'s position is within the robot\'s reach. Refer to the robot\'s documentation or data sheet for details like joint limits or reach. **Important notes:** - Adding or updating a TCP triggers a **virtual robot restart** to apply the new configuration. - During this restart: - The robot visualization in the UI may temporarily disappear. - The TCP visualization may not immediately appear, or may look outdated during the first test/rerun. - All active connections to the virtual robot are closed and then re-established. This creates a delay before the TCP is available in both the UI and robot programs. - The API call itself does **not wait until the restart and synchronization are complete**. Even if the request succeeds, the new or updated TCP may not yet be visible in the GUI or available for use.
15328
15938
  * @summary Add TCP
15329
15939
  * @param {string} cell Unique identifier addressing a cell in all API calls.
15330
15940
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -15341,8 +15951,8 @@ export const VirtualControllerApiFp = function(configuration?: Configuration) {
15341
15951
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
15342
15952
  },
15343
15953
  /**
15344
- * 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.
15345
- * @summary Remove Coordinate System
15954
+ * Deletes a coordinate system from the virtual controller. This will remove the coordinate system from the list of coordinate systems and also remove all dependent coordinate systems that use the deleted coordinate system as reference. **Important notes:** - When a new coordinate system is added/removed, the **virtual robot is restarted** in the background in order to apply the new configuration. - During this restart: - Robot visualization may temporarily disappear or appear outdated in the UI. - coordinate system changes are not immediately visible in visualizations. - All existing connections to the virtual robot are closed and re-established, which introduces a short delay before the system is fully operational again. - The API call itself does **not wait until the restart and re-synchronization are complete**. This means that immediately after a successful response, the new coordinate system may not yet be available for visualization or program execution.
15955
+ * @summary Delete Coordinate System
15346
15956
  * @param {string} cell Unique identifier addressing a cell in all API calls.
15347
15957
  * @param {string} controller Unique identifier to address a controller in the cell.
15348
15958
  * @param {string} coordinateSystem Unique identifier addressing a coordinate system.
@@ -15357,7 +15967,7 @@ export const VirtualControllerApiFp = function(configuration?: Configuration) {
15357
15967
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
15358
15968
  },
15359
15969
  /**
15360
- * Removes the TCP from the motion group. An unknown TCP is a valid input.
15970
+ * Removes the TCP (Tool Center Point) from the motion group. An unknown TCP is a valid input and will simply be ignored. **Important notes:** - Removing or updating a TCP triggers a **virtual robot restart** to apply the new configuration. - During this restart: - The robot visualization in the UI may temporarily disappear. - The TCP visualization may not immediately appear, or may look outdated during the first test/rerun. - All active connections to the virtual robot are closed and then re-established. This creates a delay before the TCP is available in both the UI and robot programs. - The API call itself does **not wait until the restart and synchronization are complete**. Even if the request succeeds, the new or updated TCP may not yet be visible in the GUI or available for use.
15361
15971
  * @summary Remove TCP
15362
15972
  * @param {string} cell Unique identifier addressing a cell in all API calls.
15363
15973
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -15520,7 +16130,7 @@ export const VirtualControllerApiFp = function(configuration?: Configuration) {
15520
16130
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
15521
16131
  },
15522
16132
  /**
15523
- * Sets motion group mounting by specifying a coordinate system. The motion group will be based on the coordinate system\'s origin. The coordinate system defines a transformation offset. The transformation offset is defined by a unique identifier, a name for front end usage and an offset in another coordinate system referenced by the unique identifier of the reference coordinate system.
16133
+ * Sets the motion group mounting by specifying a coordinate system. The motion group will be based on the coordinate system\'s origin. The coordinate system defines a transformation offset, which consists of: - A unique identifier - A user-facing name - An offset in another coordinate system, referenced by the unique identifier of the reference coordinate system. **Important notes:** - Changing the mounting configuration is treated as a setup change. - When the mounting is set to a new coordinate system, the **virtual robot restarts** in the background to apply the new configuration. - During this process: - Robot visualization may temporarily disappear or not reflect the new mounting immediately. - Motion group state and coordinate system alignment may not be instantly updated in the UI. - All connections to the virtual robot are closed and then re-established, which can cause a short delay before the system is ready again. - The API call itself does **not wait until the restart and synchronization are complete**. A successful response indicates that the request was accepted, but the updated mounting may not yet be visible.
15524
16134
  * @summary Set Mounting
15525
16135
  * @param {string} cell Unique identifier addressing a cell in all API calls.
15526
16136
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -15546,7 +16156,7 @@ export const VirtualControllerApiFactory = function (configuration?: Configurati
15546
16156
  const localVarFp = VirtualControllerApiFp(configuration)
15547
16157
  return {
15548
16158
  /**
15549
- * Adds a coordinate system to the robot controller.
16159
+ * Adds a coordinate system to the robot controller. **Important notes:** - When a new coordinate system is added/removed, the **virtual robot is restarted** in the background in order to apply the new configuration. - During this restart: - Robot visualization may temporarily disappear or appear outdated in the UI. - coordinate system changes are not immediately visible in visualizations. - All existing connections to the virtual robot are closed and re-established, which introduces a short delay before the system is fully operational again. - The API call itself does **not wait until the restart and re-synchronization are complete**. This means that immediately after a successful response, the new coordinate system may not yet be available for visualization or program execution.
15550
16160
  * @summary Add Coordinate Systems
15551
16161
  * @param {string} cell Unique identifier addressing a cell in all API calls.
15552
16162
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -15559,7 +16169,7 @@ export const VirtualControllerApiFactory = function (configuration?: Configurati
15559
16169
  return localVarFp.addVirtualControllerCoordinateSystem(cell, controller, coordinateSystem, coordinateSystemData, options).then((request) => request(axios, basePath));
15560
16170
  },
15561
16171
  /**
15562
- * Adds a new TCP or updates an existing TCP in the motion group. The position and rotation values in the request body are defined within the flanges coordinate system. > **NOTE** > > Ensure the TCP\'s position is within the robot\'s reach. Refer to the robots documentation or data sheet for details like joint limits or reach.
16172
+ * Adds a new TCP (Tool Center Point) or updates an existing TCP in the motion group. The position and rotation values in the request body are defined within the flange\'s coordinate system. > **NOTE** > Ensure the TCP\'s position is within the robot\'s reach. Refer to the robot\'s documentation or data sheet for details like joint limits or reach. **Important notes:** - Adding or updating a TCP triggers a **virtual robot restart** to apply the new configuration. - During this restart: - The robot visualization in the UI may temporarily disappear. - The TCP visualization may not immediately appear, or may look outdated during the first test/rerun. - All active connections to the virtual robot are closed and then re-established. This creates a delay before the TCP is available in both the UI and robot programs. - The API call itself does **not wait until the restart and synchronization are complete**. Even if the request succeeds, the new or updated TCP may not yet be visible in the GUI or available for use.
15563
16173
  * @summary Add TCP
15564
16174
  * @param {string} cell Unique identifier addressing a cell in all API calls.
15565
16175
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -15573,8 +16183,8 @@ export const VirtualControllerApiFactory = function (configuration?: Configurati
15573
16183
  return localVarFp.addVirtualControllerTcp(cell, controller, motionGroup, tcp, robotTcpData, options).then((request) => request(axios, basePath));
15574
16184
  },
15575
16185
  /**
15576
- * 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.
15577
- * @summary Remove Coordinate System
16186
+ * Deletes a coordinate system from the virtual controller. This will remove the coordinate system from the list of coordinate systems and also remove all dependent coordinate systems that use the deleted coordinate system as reference. **Important notes:** - When a new coordinate system is added/removed, the **virtual robot is restarted** in the background in order to apply the new configuration. - During this restart: - Robot visualization may temporarily disappear or appear outdated in the UI. - coordinate system changes are not immediately visible in visualizations. - All existing connections to the virtual robot are closed and re-established, which introduces a short delay before the system is fully operational again. - The API call itself does **not wait until the restart and re-synchronization are complete**. This means that immediately after a successful response, the new coordinate system may not yet be available for visualization or program execution.
16187
+ * @summary Delete Coordinate System
15578
16188
  * @param {string} cell Unique identifier addressing a cell in all API calls.
15579
16189
  * @param {string} controller Unique identifier to address a controller in the cell.
15580
16190
  * @param {string} coordinateSystem Unique identifier addressing a coordinate system.
@@ -15586,7 +16196,7 @@ export const VirtualControllerApiFactory = function (configuration?: Configurati
15586
16196
  return localVarFp.deleteVirtualControllerCoordinateSystem(cell, controller, coordinateSystem, deleteDependent, options).then((request) => request(axios, basePath));
15587
16197
  },
15588
16198
  /**
15589
- * Removes the TCP from the motion group. An unknown TCP is a valid input.
16199
+ * Removes the TCP (Tool Center Point) from the motion group. An unknown TCP is a valid input and will simply be ignored. **Important notes:** - Removing or updating a TCP triggers a **virtual robot restart** to apply the new configuration. - During this restart: - The robot visualization in the UI may temporarily disappear. - The TCP visualization may not immediately appear, or may look outdated during the first test/rerun. - All active connections to the virtual robot are closed and then re-established. This creates a delay before the TCP is available in both the UI and robot programs. - The API call itself does **not wait until the restart and synchronization are complete**. Even if the request succeeds, the new or updated TCP may not yet be visible in the GUI or available for use.
15590
16200
  * @summary Remove TCP
15591
16201
  * @param {string} cell Unique identifier addressing a cell in all API calls.
15592
16202
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -15716,7 +16326,7 @@ export const VirtualControllerApiFactory = function (configuration?: Configurati
15716
16326
  return localVarFp.setOperationMode(cell, controller, mode, options).then((request) => request(axios, basePath));
15717
16327
  },
15718
16328
  /**
15719
- * Sets motion group mounting by specifying a coordinate system. The motion group will be based on the coordinate system\'s origin. The coordinate system defines a transformation offset. The transformation offset is defined by a unique identifier, a name for front end usage and an offset in another coordinate system referenced by the unique identifier of the reference coordinate system.
16329
+ * Sets the motion group mounting by specifying a coordinate system. The motion group will be based on the coordinate system\'s origin. The coordinate system defines a transformation offset, which consists of: - A unique identifier - A user-facing name - An offset in another coordinate system, referenced by the unique identifier of the reference coordinate system. **Important notes:** - Changing the mounting configuration is treated as a setup change. - When the mounting is set to a new coordinate system, the **virtual robot restarts** in the background to apply the new configuration. - During this process: - Robot visualization may temporarily disappear or not reflect the new mounting immediately. - Motion group state and coordinate system alignment may not be instantly updated in the UI. - All connections to the virtual robot are closed and then re-established, which can cause a short delay before the system is ready again. - The API call itself does **not wait until the restart and synchronization are complete**. A successful response indicates that the request was accepted, but the updated mounting may not yet be visible.
15720
16330
  * @summary Set Mounting
15721
16331
  * @param {string} cell Unique identifier addressing a cell in all API calls.
15722
16332
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -15739,7 +16349,7 @@ export const VirtualControllerApiFactory = function (configuration?: Configurati
15739
16349
  */
15740
16350
  export class VirtualControllerApi extends BaseAPI {
15741
16351
  /**
15742
- * Adds a coordinate system to the robot controller.
16352
+ * Adds a coordinate system to the robot controller. **Important notes:** - When a new coordinate system is added/removed, the **virtual robot is restarted** in the background in order to apply the new configuration. - During this restart: - Robot visualization may temporarily disappear or appear outdated in the UI. - coordinate system changes are not immediately visible in visualizations. - All existing connections to the virtual robot are closed and re-established, which introduces a short delay before the system is fully operational again. - The API call itself does **not wait until the restart and re-synchronization are complete**. This means that immediately after a successful response, the new coordinate system may not yet be available for visualization or program execution.
15743
16353
  * @summary Add Coordinate Systems
15744
16354
  * @param {string} cell Unique identifier addressing a cell in all API calls.
15745
16355
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -15754,7 +16364,7 @@ export class VirtualControllerApi extends BaseAPI {
15754
16364
  }
15755
16365
 
15756
16366
  /**
15757
- * Adds a new TCP or updates an existing TCP in the motion group. The position and rotation values in the request body are defined within the flanges coordinate system. > **NOTE** > > Ensure the TCP\'s position is within the robot\'s reach. Refer to the robots documentation or data sheet for details like joint limits or reach.
16367
+ * Adds a new TCP (Tool Center Point) or updates an existing TCP in the motion group. The position and rotation values in the request body are defined within the flange\'s coordinate system. > **NOTE** > Ensure the TCP\'s position is within the robot\'s reach. Refer to the robot\'s documentation or data sheet for details like joint limits or reach. **Important notes:** - Adding or updating a TCP triggers a **virtual robot restart** to apply the new configuration. - During this restart: - The robot visualization in the UI may temporarily disappear. - The TCP visualization may not immediately appear, or may look outdated during the first test/rerun. - All active connections to the virtual robot are closed and then re-established. This creates a delay before the TCP is available in both the UI and robot programs. - The API call itself does **not wait until the restart and synchronization are complete**. Even if the request succeeds, the new or updated TCP may not yet be visible in the GUI or available for use.
15758
16368
  * @summary Add TCP
15759
16369
  * @param {string} cell Unique identifier addressing a cell in all API calls.
15760
16370
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -15770,8 +16380,8 @@ export class VirtualControllerApi extends BaseAPI {
15770
16380
  }
15771
16381
 
15772
16382
  /**
15773
- * 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.
15774
- * @summary Remove Coordinate System
16383
+ * Deletes a coordinate system from the virtual controller. This will remove the coordinate system from the list of coordinate systems and also remove all dependent coordinate systems that use the deleted coordinate system as reference. **Important notes:** - When a new coordinate system is added/removed, the **virtual robot is restarted** in the background in order to apply the new configuration. - During this restart: - Robot visualization may temporarily disappear or appear outdated in the UI. - coordinate system changes are not immediately visible in visualizations. - All existing connections to the virtual robot are closed and re-established, which introduces a short delay before the system is fully operational again. - The API call itself does **not wait until the restart and re-synchronization are complete**. This means that immediately after a successful response, the new coordinate system may not yet be available for visualization or program execution.
16384
+ * @summary Delete Coordinate System
15775
16385
  * @param {string} cell Unique identifier addressing a cell in all API calls.
15776
16386
  * @param {string} controller Unique identifier to address a controller in the cell.
15777
16387
  * @param {string} coordinateSystem Unique identifier addressing a coordinate system.
@@ -15785,7 +16395,7 @@ export class VirtualControllerApi extends BaseAPI {
15785
16395
  }
15786
16396
 
15787
16397
  /**
15788
- * Removes the TCP from the motion group. An unknown TCP is a valid input.
16398
+ * Removes the TCP (Tool Center Point) from the motion group. An unknown TCP is a valid input and will simply be ignored. **Important notes:** - Removing or updating a TCP triggers a **virtual robot restart** to apply the new configuration. - During this restart: - The robot visualization in the UI may temporarily disappear. - The TCP visualization may not immediately appear, or may look outdated during the first test/rerun. - All active connections to the virtual robot are closed and then re-established. This creates a delay before the TCP is available in both the UI and robot programs. - The API call itself does **not wait until the restart and synchronization are complete**. Even if the request succeeds, the new or updated TCP may not yet be visible in the GUI or available for use.
15789
16399
  * @summary Remove TCP
15790
16400
  * @param {string} cell Unique identifier addressing a cell in all API calls.
15791
16401
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -15937,7 +16547,7 @@ export class VirtualControllerApi extends BaseAPI {
15937
16547
  }
15938
16548
 
15939
16549
  /**
15940
- * Sets motion group mounting by specifying a coordinate system. The motion group will be based on the coordinate system\'s origin. The coordinate system defines a transformation offset. The transformation offset is defined by a unique identifier, a name for front end usage and an offset in another coordinate system referenced by the unique identifier of the reference coordinate system.
16550
+ * Sets the motion group mounting by specifying a coordinate system. The motion group will be based on the coordinate system\'s origin. The coordinate system defines a transformation offset, which consists of: - A unique identifier - A user-facing name - An offset in another coordinate system, referenced by the unique identifier of the reference coordinate system. **Important notes:** - Changing the mounting configuration is treated as a setup change. - When the mounting is set to a new coordinate system, the **virtual robot restarts** in the background to apply the new configuration. - During this process: - Robot visualization may temporarily disappear or not reflect the new mounting immediately. - Motion group state and coordinate system alignment may not be instantly updated in the UI. - All connections to the virtual robot are closed and then re-established, which can cause a short delay before the system is ready again. - The API call itself does **not wait until the restart and synchronization are complete**. A successful response indicates that the request was accepted, but the updated mounting may not yet be visible.
15941
16551
  * @summary Set Mounting
15942
16552
  * @param {string} cell Unique identifier addressing a cell in all API calls.
15943
16553
  * @param {string} controller Unique identifier to address a controller in the cell.