@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.d.ts CHANGED
@@ -93,7 +93,7 @@ export interface AddTrajectoryError {
93
93
  */
94
94
  'message'?: string;
95
95
  /**
96
- * The location of the error in the trajectory.
96
+ * Location on trajectory where the execution will start. The default value is the start (forward movement) or end (backward movement) of the trajectory. If you want to start your movement from an arbitrary location, e.g. in combination with [streamMoveToTrajectoryViaJointPTP](streamMoveToTrajectoryViaJointPTP), set the location by respecting the following format: - The location is a scalar value that defines a position along a path, typically ranging from 0 to `n`, where `n` denotes the number of motion commands - Each integer value of the location corresponds to a specific motion command, while non-integer values interpolate positions within the segments. - The location is calculated from the joint path
97
97
  * @type {number}
98
98
  * @memberof AddTrajectoryError
99
99
  */
@@ -354,17 +354,17 @@ export interface BusIOProfinet {
354
354
  */
355
355
  'bus_type'?: BusIOProfinetBusTypeEnum;
356
356
  /**
357
- * 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.
358
- * @type {string}
357
+ * Used to enable IP communication through the same physical ethernet interface while PROFINET driver is active.
358
+ * @type {BusIOProfinetNetwork}
359
359
  * @memberof BusIOProfinet
360
360
  */
361
- 'config_file_content'?: string;
361
+ 'network_config'?: BusIOProfinetNetwork;
362
362
  /**
363
- * Used to enable IP communication through the same physical interface while PN Driver is running.
364
- * @type {BusIOProfinetNetwork}
363
+ * IP address of the PLC to establish PROFINET communication with. The IP address is used to configure the host machine\'s firewall. The firewall configuration is applied while the BUS input/output service is active. Without proper firewall configuration, PROFINET device discovery, configuration exchanges, and real-time cyclic data communication will fail.
364
+ * @type {string}
365
365
  * @memberof BusIOProfinet
366
366
  */
367
- 'network_config'?: BusIOProfinetNetwork;
367
+ 'plc_ip': string;
368
368
  /**
369
369
  * MAC address of the physical ethernet interface that you want to use for PROFINET communication.
370
370
  * @type {string}
@@ -1708,9 +1708,22 @@ export interface GetTrajectoryResponse {
1708
1708
  export interface HTTPValidationError {
1709
1709
  /**
1710
1710
  *
1711
- * @type {Array<ValidationError>}
1711
+ * @type {Array<ValidationError2>}
1712
1712
  * @memberof HTTPValidationError
1713
1713
  */
1714
+ 'detail'?: Array<ValidationError2>;
1715
+ }
1716
+ /**
1717
+ *
1718
+ * @export
1719
+ * @interface HTTPValidationError2
1720
+ */
1721
+ export interface HTTPValidationError2 {
1722
+ /**
1723
+ *
1724
+ * @type {Array<ValidationError>}
1725
+ * @memberof HTTPValidationError2
1726
+ */
1714
1727
  'detail'?: Array<ValidationError>;
1715
1728
  }
1716
1729
  /**
@@ -1810,7 +1823,7 @@ export interface IODescription2 {
1810
1823
  */
1811
1824
  'io': string;
1812
1825
  /**
1813
- * Descriptive name of the input/output. Customize it using the respective BUS service, e.g. [addProfinetIO](addProfinetIO) for PROFINET service.
1826
+ * Name of the input/output. Customize it using the respective BUS service, e.g. [addProfinetIO](addProfinetIO) for PROFINET service.
1814
1827
  * @type {string}
1815
1828
  * @memberof IODescription2
1816
1829
  */
@@ -1909,7 +1922,7 @@ export interface IOIntegerValue {
1909
1922
  */
1910
1923
  'io': string;
1911
1924
  /**
1912
- * Value of an input/output with integer representation. > The integral value is transmitted as a string to avoid precision loss during conversion to JSON. > We recommend to use int64 in your implementation. If you want to interact with int64 in numbers, > JS bigint libraries can help you to parse the string into an integral value.
1925
+ * Value of an input/output with integer representation. > The integral value is transmitted as a string to avoid precision loss during conversion to JSON. > Recommended: Use int64 in your implementation. If you want to interact with int64 in numbers, > JS bigint libraries can help you to parse the string into an integral value.
1913
1926
  * @type {string}
1914
1927
  * @memberof IOIntegerValue
1915
1928
  */
@@ -1925,6 +1938,16 @@ export declare const IOIntegerValueValueTypeEnum: {
1925
1938
  readonly Integer: "integer";
1926
1939
  };
1927
1940
  export type IOIntegerValueValueTypeEnum = typeof IOIntegerValueValueTypeEnum[keyof typeof IOIntegerValueValueTypeEnum];
1941
+ /**
1942
+ * States the source of the input/output signal.
1943
+ * @export
1944
+ * @enum {string}
1945
+ */
1946
+ export declare const IOOrigin: {
1947
+ readonly Controller: "CONTROLLER";
1948
+ readonly BusIo: "BUS_IO";
1949
+ };
1950
+ export type IOOrigin = typeof IOOrigin[keyof typeof IOOrigin];
1928
1951
  /**
1929
1952
  * @type IOValue
1930
1953
  * @export
@@ -2034,24 +2057,12 @@ export interface InitializeJoggingRequest {
2034
2057
  * @memberof InitializeJoggingRequest
2035
2058
  */
2036
2059
  'tcp'?: string;
2037
- /**
2038
- * 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.
2039
- * @type {number}
2040
- * @memberof InitializeJoggingRequest
2041
- */
2042
- 'response_rate'?: number;
2043
2060
  /**
2044
2061
  * Unique identifier addressing a coordinate system to which the responses are transformed. If not set, world coordinate system is used.
2045
2062
  * @type {string}
2046
2063
  * @memberof InitializeJoggingRequest
2047
2064
  */
2048
2065
  'response_coordinate_system'?: string;
2049
- /**
2050
- * Defines an input/output that is listened to during the movement. Execution pauses if the defined comparator evaluates to `true`.
2051
- * @type {string}
2052
- * @memberof InitializeJoggingRequest
2053
- */
2054
- 'pause_on_io'?: string;
2055
2066
  }
2056
2067
  export declare const InitializeJoggingRequestMessageTypeEnum: {
2057
2068
  readonly InitializeJoggingRequest: "InitializeJoggingRequest";
@@ -2104,12 +2115,6 @@ export interface InitializeMovementRequest {
2104
2115
  * @memberof InitializeMovementRequest
2105
2116
  */
2106
2117
  'initial_location'?: number;
2107
- /**
2108
- * 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.
2109
- * @type {number}
2110
- * @memberof InitializeMovementRequest
2111
- */
2112
- 'response_rate'?: number;
2113
2118
  /**
2114
2119
  * Unique identifier addressing a coordinate system to which the responses are transformed. If not set, world coordinate system is used.
2115
2120
  * @type {string}
@@ -2161,7 +2166,7 @@ export declare const InitializeMovementResponseKindEnum: {
2161
2166
  };
2162
2167
  export type InitializeMovementResponseKindEnum = typeof InitializeMovementResponseKindEnum[keyof typeof InitializeMovementResponseKindEnum];
2163
2168
  /**
2164
- * 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.
2169
+ * 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.
2165
2170
  * @export
2166
2171
  * @interface IntegerValue
2167
2172
  */
@@ -2362,9 +2367,19 @@ export type JoggingDetailsKindEnum = typeof JoggingDetailsKindEnum[keyof typeof
2362
2367
  * @type JoggingDetailsState
2363
2368
  * @export
2364
2369
  */
2365
- export type JoggingDetailsState = JoggingPausedByUser | JoggingPausedNearCollision | JoggingPausedNearJointLimit | JoggingPausedOnIO | JoggingRunning;
2370
+ export type JoggingDetailsState = {
2371
+ kind: 'PAUSED_BY_USER';
2372
+ } & JoggingPausedByUser | {
2373
+ kind: 'PAUSED_NEAR_COLLISION';
2374
+ } & JoggingPausedNearCollision | {
2375
+ kind: 'PAUSED_NEAR_JOINT_LIMIT';
2376
+ } & JoggingPausedNearJointLimit | {
2377
+ kind: 'PAUSED_ON_IO';
2378
+ } & JoggingPausedOnIO | {
2379
+ kind: 'RUNNING';
2380
+ } & JoggingRunning;
2366
2381
  /**
2367
- *
2382
+ * User has paused jogging.
2368
2383
  * @export
2369
2384
  * @interface JoggingPausedByUser
2370
2385
  */
@@ -2381,7 +2396,7 @@ export declare const JoggingPausedByUserKindEnum: {
2381
2396
  };
2382
2397
  export type JoggingPausedByUserKindEnum = typeof JoggingPausedByUserKindEnum[keyof typeof JoggingPausedByUserKindEnum];
2383
2398
  /**
2384
- *
2399
+ * Jogging was paused because the motion group neared a collision.
2385
2400
  * @export
2386
2401
  * @interface JoggingPausedNearCollision
2387
2402
  */
@@ -2404,7 +2419,7 @@ export declare const JoggingPausedNearCollisionKindEnum: {
2404
2419
  };
2405
2420
  export type JoggingPausedNearCollisionKindEnum = typeof JoggingPausedNearCollisionKindEnum[keyof typeof JoggingPausedNearCollisionKindEnum];
2406
2421
  /**
2407
- *
2422
+ * Jogging was paused because a joint is near its limit.
2408
2423
  * @export
2409
2424
  * @interface JoggingPausedNearJointLimit
2410
2425
  */
@@ -2427,7 +2442,7 @@ export declare const JoggingPausedNearJointLimitKindEnum: {
2427
2442
  };
2428
2443
  export type JoggingPausedNearJointLimitKindEnum = typeof JoggingPausedNearJointLimitKindEnum[keyof typeof JoggingPausedNearJointLimitKindEnum];
2429
2444
  /**
2430
- *
2445
+ * Jogging was paused because of an I/O event.
2431
2446
  * @export
2432
2447
  * @interface JoggingPausedOnIO
2433
2448
  */
@@ -2444,7 +2459,7 @@ export declare const JoggingPausedOnIOKindEnum: {
2444
2459
  };
2445
2460
  export type JoggingPausedOnIOKindEnum = typeof JoggingPausedOnIOKindEnum[keyof typeof JoggingPausedOnIOKindEnum];
2446
2461
  /**
2447
- *
2462
+ * Jogging is active.
2448
2463
  * @export
2449
2464
  * @interface JoggingRunning
2450
2465
  */
@@ -2512,10 +2527,10 @@ export interface JointLimits {
2512
2527
  export interface JointTrajectory {
2513
2528
  /**
2514
2529
  * List of joint positions [rad] for each sample. The number of samples must match the number of timestamps provided in the times field.
2515
- * @type {Array<Joints>}
2530
+ * @type {Array<Array<number>>}
2516
2531
  * @memberof JointTrajectory
2517
2532
  */
2518
- 'joint_positions': Array<Joints>;
2533
+ 'joint_positions': Array<Array<number>>;
2519
2534
  /**
2520
2535
  * Timestamp for each sample [s].
2521
2536
  * @type {Array<number>}
@@ -2523,7 +2538,7 @@ export interface JointTrajectory {
2523
2538
  */
2524
2539
  'times': Array<number>;
2525
2540
  /**
2526
- * 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.
2541
+ *
2527
2542
  * @type {Array<number>}
2528
2543
  * @memberof JointTrajectory
2529
2544
  */
@@ -2542,11 +2557,11 @@ export interface JointVelocityRequest {
2542
2557
  */
2543
2558
  'message_type'?: JointVelocityRequestMessageTypeEnum;
2544
2559
  /**
2545
- * in [rad/s]
2546
- * @type {Joints}
2560
+ * This structure describes a set of joint values (e.g. positions, currents, torques) of a motion group. Float precision is the default.
2561
+ * @type {Array<number>}
2547
2562
  * @memberof JointVelocityRequest
2548
2563
  */
2549
- 'velocity': Joints;
2564
+ 'velocity': Array<number>;
2550
2565
  }
2551
2566
  export declare const JointVelocityRequestMessageTypeEnum: {
2552
2567
  readonly JointVelocityRequest: "JointVelocityRequest";
@@ -2575,19 +2590,6 @@ export declare const JointVelocityResponseKindEnum: {
2575
2590
  readonly JointVelocityReceived: "JOINT_VELOCITY_RECEIVED";
2576
2591
  };
2577
2592
  export type JointVelocityResponseKindEnum = typeof JointVelocityResponseKindEnum[keyof typeof JointVelocityResponseKindEnum];
2578
- /**
2579
- * 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.
2580
- * @export
2581
- * @interface Joints
2582
- */
2583
- export interface Joints {
2584
- /**
2585
- *
2586
- * @type {Array<number>}
2587
- * @memberof Joints
2588
- */
2589
- 'joints': Array<number>;
2590
- }
2591
2593
  /**
2592
2594
  * 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.
2593
2595
  * @export
@@ -2618,6 +2620,12 @@ export interface KukaController {
2618
2620
  * @memberof KukaController
2619
2621
  */
2620
2622
  'rsi_server': KukaControllerRsiServer;
2623
+ /**
2624
+ * If true, uses slower cycle time of 12ms instead of 4ms.
2625
+ * @type {boolean}
2626
+ * @memberof KukaController
2627
+ */
2628
+ 'slow_cycle_rate'?: boolean;
2621
2629
  }
2622
2630
  export declare const KukaControllerKindEnum: {
2623
2631
  readonly KukaController: "KukaController";
@@ -2743,25 +2751,6 @@ export declare const LicenseStatusEnum: {
2743
2751
  readonly NotFound: "NOT_FOUND";
2744
2752
  };
2745
2753
  export type LicenseStatusEnum = typeof LicenseStatusEnum[keyof typeof LicenseStatusEnum];
2746
- /**
2747
- *
2748
- * @export
2749
- * @interface LimitConfig
2750
- */
2751
- export interface LimitConfig {
2752
- /**
2753
- *
2754
- * @type {LimitSet}
2755
- * @memberof LimitConfig
2756
- */
2757
- 'physical_limits'?: LimitSet;
2758
- /**
2759
- *
2760
- * @type {OperationLimits}
2761
- * @memberof LimitConfig
2762
- */
2763
- 'operation_limits'?: OperationLimits;
2764
- }
2765
2754
  /**
2766
2755
  * The upper_limit must be greater then the lower_limit.
2767
2756
  * @export
@@ -2811,6 +2800,12 @@ export interface LimitSet {
2811
2800
  * @memberof LimitSet
2812
2801
  */
2813
2802
  'flange'?: CartesianLimits;
2803
+ /**
2804
+ *
2805
+ * @type {JointLimits}
2806
+ * @memberof LimitSet
2807
+ */
2808
+ 'coupled_shoulder_elbow_joint'?: JointLimits;
2814
2809
  }
2815
2810
  /**
2816
2811
  * If a limit is not set, the default value will be used.
@@ -2882,13 +2877,13 @@ export declare const Manufacturer: {
2882
2877
  };
2883
2878
  export type Manufacturer = typeof Manufacturer[keyof typeof Manufacturer];
2884
2879
  /**
2885
- * 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.
2880
+ *
2886
2881
  * @export
2887
2882
  * @interface MidpointInsertionAlgorithm
2888
2883
  */
2889
2884
  export interface MidpointInsertionAlgorithm {
2890
2885
  /**
2891
- * Algorithm discriminator.
2886
+ * 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.
2892
2887
  * @type {string}
2893
2888
  * @memberof MidpointInsertionAlgorithm
2894
2889
  */
@@ -2976,13 +2971,13 @@ export interface MotionGroupDescription {
2976
2971
  * @type {Pose}
2977
2972
  * @memberof MotionGroupDescription
2978
2973
  */
2979
- 'mounting': Pose;
2974
+ 'mounting'?: Pose;
2980
2975
  /**
2981
2976
  * Maps a TCP name to its offset relative to the flange coordinate system. Key must be a TCP identifier. Values are TcpOffsets.
2982
2977
  * @type {{ [key: string]: TcpOffset; }}
2983
2978
  * @memberof MotionGroupDescription
2984
2979
  */
2985
- 'tcps': {
2980
+ 'tcps'?: {
2986
2981
  [key: string]: TcpOffset;
2987
2982
  };
2988
2983
  /**
@@ -3013,10 +3008,10 @@ export interface MotionGroupDescription {
3013
3008
  };
3014
3009
  /**
3015
3010
  *
3016
- * @type {LimitConfig}
3011
+ * @type {OperationLimits}
3017
3012
  * @memberof MotionGroupDescription
3018
3013
  */
3019
- 'global_limits': LimitConfig;
3014
+ 'operation_limits': OperationLimits;
3020
3015
  /**
3021
3016
  * Maps a payload name to its configuration. Key must be a payload identifier. Values are payload objects.
3022
3017
  * @type {{ [key: string]: Payload; }}
@@ -3176,11 +3171,11 @@ export interface MotionGroupState {
3176
3171
  */
3177
3172
  'controller': string;
3178
3173
  /**
3179
- * Current joint position of each joint in [rad]
3180
- * @type {Joints}
3174
+ * This structure describes a set of joint values (e.g. positions, currents, torques) of a motion group. Float precision is the default.
3175
+ * @type {Array<number>}
3181
3176
  * @memberof MotionGroupState
3182
3177
  */
3183
- 'joint_position': Joints;
3178
+ 'joint_position': Array<number>;
3184
3179
  /**
3185
3180
  * Indicates whether the joint is in a limit for all joints of the motion group.
3186
3181
  * @type {MotionGroupStateJointLimitReached}
@@ -3188,17 +3183,17 @@ export interface MotionGroupState {
3188
3183
  */
3189
3184
  'joint_limit_reached': MotionGroupStateJointLimitReached;
3190
3185
  /**
3191
- * Current joint torque of each joint in [Nm]. Is only available if the robot controller supports it, e.g. available for UR controllers.
3192
- * @type {Joints}
3186
+ * This structure describes a set of joint values (e.g. positions, currents, torques) of a motion group. Float precision is the default.
3187
+ * @type {Array<number>}
3193
3188
  * @memberof MotionGroupState
3194
3189
  */
3195
- 'joint_torque'?: Joints;
3190
+ 'joint_torque'?: Array<number>;
3196
3191
  /**
3197
- * Current at TCP in [A]. Is only available if the robot controller supports it, e.g. available for UR controllers.
3198
- * @type {Joints}
3192
+ * This structure describes a set of joint values (e.g. positions, currents, torques) of a motion group. Float precision is the default.
3193
+ * @type {Array<number>}
3199
3194
  * @memberof MotionGroupState
3200
3195
  */
3201
- 'joint_current'?: Joints;
3196
+ 'joint_current'?: Array<number>;
3202
3197
  /**
3203
3198
  * 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.
3204
3199
  * @type {Pose}
@@ -3629,6 +3624,12 @@ export interface PauseOnIO {
3629
3624
  * @memberof PauseOnIO
3630
3625
  */
3631
3626
  'comparator': Comparator;
3627
+ /**
3628
+ *
3629
+ * @type {IOOrigin}
3630
+ * @memberof PauseOnIO
3631
+ */
3632
+ 'io_origin': IOOrigin;
3632
3633
  }
3633
3634
  /**
3634
3635
  *
@@ -3749,11 +3750,11 @@ export interface PlanTrajectoryFailedResponse {
3749
3750
  */
3750
3751
  'error_feedback': PlanTrajectoryFailedResponseErrorFeedback;
3751
3752
  /**
3752
- *
3753
+ * 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
3753
3754
  * @type {number}
3754
3755
  * @memberof PlanTrajectoryFailedResponse
3755
3756
  */
3756
- 'error_location_on_trajectory'?: number;
3757
+ 'error_location_on_trajectory': number;
3757
3758
  /**
3758
3759
  * The joint trajectory from the start joint position to the error.
3759
3760
  * @type {JointTrajectory}
@@ -3986,11 +3987,11 @@ export interface ProfinetDescription {
3986
3987
  */
3987
3988
  export interface ProfinetIO {
3988
3989
  /**
3989
- * 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).
3990
+ * Descriptive name or note for the input/output variable.
3990
3991
  * @type {string}
3991
3992
  * @memberof ProfinetIO
3992
3993
  */
3993
- 'name': string;
3994
+ 'description': string;
3994
3995
  /**
3995
3996
  *
3996
3997
  * @type {ProfinetIOTypeEnum}
@@ -4029,11 +4030,11 @@ export interface ProfinetIO {
4029
4030
  */
4030
4031
  export interface ProfinetIOData {
4031
4032
  /**
4032
- * 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).
4033
+ * Descriptive name or note for the input/output variable.
4033
4034
  * @type {string}
4034
4035
  * @memberof ProfinetIOData
4035
4036
  */
4036
- 'name': string;
4037
+ 'description': string;
4037
4038
  /**
4038
4039
  *
4039
4040
  * @type {ProfinetIOTypeEnum}
@@ -4164,13 +4165,155 @@ export interface ProfinetSubSlotDescription {
4164
4165
  'output_length': number;
4165
4166
  }
4166
4167
  /**
4167
- * <!-- 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.
4168
+ * A program is a collection of instructions that are executed in the robot cell.
4169
+ * @export
4170
+ * @interface Program
4171
+ */
4172
+ export interface Program {
4173
+ /**
4174
+ *
4175
+ * @type {string}
4176
+ * @memberof Program
4177
+ */
4178
+ 'program': string;
4179
+ /**
4180
+ *
4181
+ * @type {string}
4182
+ * @memberof Program
4183
+ */
4184
+ 'name'?: string;
4185
+ /**
4186
+ *
4187
+ * @type {string}
4188
+ * @memberof Program
4189
+ */
4190
+ 'description'?: string;
4191
+ /**
4192
+ *
4193
+ * @type {string}
4194
+ * @memberof Program
4195
+ */
4196
+ 'app': string;
4197
+ /**
4198
+ *
4199
+ * @type {object}
4200
+ * @memberof Program
4201
+ */
4202
+ 'input_schema'?: object;
4203
+ /**
4204
+ *
4205
+ * @type {object}
4206
+ * @memberof Program
4207
+ */
4208
+ 'preconditions'?: object;
4209
+ }
4210
+ /**
4211
+ * Holds the state of a program run.
4212
+ * @export
4213
+ * @interface ProgramRun
4214
+ */
4215
+ export interface ProgramRun {
4216
+ /**
4217
+ * Unique identifier of the program run
4218
+ * @type {string}
4219
+ * @memberof ProgramRun
4220
+ */
4221
+ 'run': string;
4222
+ /**
4223
+ * Unique identifier of the program
4224
+ * @type {string}
4225
+ * @memberof ProgramRun
4226
+ */
4227
+ 'program': string;
4228
+ /**
4229
+ * State of the program run
4230
+ * @type {ProgramRunState}
4231
+ * @memberof ProgramRun
4232
+ */
4233
+ 'state': ProgramRunState;
4234
+ /**
4235
+ * Logs of the program run
4236
+ * @type {string}
4237
+ * @memberof ProgramRun
4238
+ */
4239
+ 'logs'?: string;
4240
+ /**
4241
+ * Stdout of the program run
4242
+ * @type {string}
4243
+ * @memberof ProgramRun
4244
+ */
4245
+ 'stdout'?: string;
4246
+ /**
4247
+ * Stderr of the program run
4248
+ * @type {string}
4249
+ * @memberof ProgramRun
4250
+ */
4251
+ 'stderr'?: string;
4252
+ /**
4253
+ * Error message of the program run, if any
4254
+ * @type {string}
4255
+ * @memberof ProgramRun
4256
+ */
4257
+ 'error'?: string;
4258
+ /**
4259
+ * Traceback of the program run, if any
4260
+ * @type {string}
4261
+ * @memberof ProgramRun
4262
+ */
4263
+ 'traceback'?: string;
4264
+ /**
4265
+ * Start time of the program run
4266
+ * @type {string}
4267
+ * @memberof ProgramRun
4268
+ */
4269
+ 'start_time'?: string;
4270
+ /**
4271
+ * End time of the program run
4272
+ * @type {string}
4273
+ * @memberof ProgramRun
4274
+ */
4275
+ 'end_time'?: string;
4276
+ /**
4277
+ * Input data of the program run
4278
+ * @type {object}
4279
+ * @memberof ProgramRun
4280
+ */
4281
+ 'input_data'?: object;
4282
+ }
4283
+ /**
4284
+ * The state of a program run.
4285
+ * @export
4286
+ * @enum {string}
4287
+ */
4288
+ export declare const ProgramRunState: {
4289
+ readonly Preparing: "PREPARING";
4290
+ readonly Running: "RUNNING";
4291
+ readonly Completed: "COMPLETED";
4292
+ readonly Failed: "FAILED";
4293
+ readonly Stopped: "STOPPED";
4294
+ };
4295
+ export type ProgramRunState = typeof ProgramRunState[keyof typeof ProgramRunState];
4296
+ /**
4297
+ * The state of a program run.
4298
+ * @export
4299
+ * @interface ProgramStartRequest
4300
+ */
4301
+ export interface ProgramStartRequest {
4302
+ /**
4303
+ * The arguments to pass to the program.
4304
+ * @type {object}
4305
+ * @memberof ProgramStartRequest
4306
+ */
4307
+ 'arguments': object;
4308
+ }
4309
+ /**
4310
+ *
4168
4311
  * @export
4169
4312
  * @interface RRTConnectAlgorithm
4170
4313
  */
4171
4314
  export interface RRTConnectAlgorithm {
4172
4315
  /**
4173
- * Algorithm discriminator.
4316
+ * 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.
4174
4317
  * @type {string}
4175
4318
  * @memberof RRTConnectAlgorithm
4176
4319
  */
@@ -4181,6 +4324,30 @@ export interface RRTConnectAlgorithm {
4181
4324
  * @memberof RRTConnectAlgorithm
4182
4325
  */
4183
4326
  'max_iterations'?: number;
4327
+ /**
4328
+ * Maximum step size for tree extension in joint space.
4329
+ * @type {number}
4330
+ * @memberof RRTConnectAlgorithm
4331
+ */
4332
+ 'max_step_size'?: number;
4333
+ /**
4334
+ * Adjust the maximum step size during the search based on the recent success rate of tree expansion.
4335
+ * @type {boolean}
4336
+ * @memberof RRTConnectAlgorithm
4337
+ */
4338
+ 'adaptive_step_size'?: boolean;
4339
+ /**
4340
+ * Apply smoothing after the search has succeeded. This will remove as many intermediate points as possible while keeping the path valid.
4341
+ * @type {boolean}
4342
+ * @memberof RRTConnectAlgorithm
4343
+ */
4344
+ 'apply_smoothing'?: boolean;
4345
+ /**
4346
+ * Apply blending after the search has succeeded and smoothing has been applied. This will apply the largest viable blending at each intermediate point.
4347
+ * @type {boolean}
4348
+ * @memberof RRTConnectAlgorithm
4349
+ */
4350
+ 'apply_blending'?: boolean;
4184
4351
  }
4185
4352
  export declare const RRTConnectAlgorithmAlgorithmNameEnum: {
4186
4353
  readonly RrtConnectAlgorithm: "RRTConnectAlgorithm";
@@ -4564,6 +4731,31 @@ export interface ServiceStatusStatus {
4564
4731
  */
4565
4732
  'reason'?: string;
4566
4733
  }
4734
+ /**
4735
+ * Defines an input/output that should be set upon reaching a specified location on the trajectory.
4736
+ * @export
4737
+ * @interface SetIO
4738
+ */
4739
+ export interface SetIO {
4740
+ /**
4741
+ *
4742
+ * @type {IOValue}
4743
+ * @memberof SetIO
4744
+ */
4745
+ 'io': IOValue;
4746
+ /**
4747
+ * The location on the trajectory where the input/output should be set.
4748
+ * @type {number}
4749
+ * @memberof SetIO
4750
+ */
4751
+ 'location': number;
4752
+ /**
4753
+ *
4754
+ * @type {IOOrigin}
4755
+ * @memberof SetIO
4756
+ */
4757
+ 'io_origin': IOOrigin;
4758
+ }
4567
4759
  /**
4568
4760
  *
4569
4761
  * @export
@@ -4626,12 +4818,18 @@ export interface StartMovementRequest {
4626
4818
  * @memberof StartMovementRequest
4627
4819
  */
4628
4820
  'direction'?: Direction;
4821
+ /**
4822
+ * 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
4823
+ * @type {number}
4824
+ * @memberof StartMovementRequest
4825
+ */
4826
+ 'target_location'?: number;
4629
4827
  /**
4630
4828
  * 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.
4631
- * @type {Array<IOValue>}
4829
+ * @type {Array<SetIO>}
4632
4830
  * @memberof StartMovementRequest
4633
4831
  */
4634
- 'set_outputs'?: Array<IOValue>;
4832
+ 'set_outputs'?: Array<SetIO>;
4635
4833
  /**
4636
4834
  * Defines an input/output that is listened to before the movement. Execution starts if the defined comparator evaluates to `true`.
4637
4835
  * @type {StartOnIO}
@@ -4690,6 +4888,12 @@ export interface StartOnIO {
4690
4888
  * @memberof StartOnIO
4691
4889
  */
4692
4890
  'comparator': Comparator;
4891
+ /**
4892
+ *
4893
+ * @type {IOOrigin}
4894
+ * @memberof StartOnIO
4895
+ */
4896
+ 'io_origin': IOOrigin;
4693
4897
  }
4694
4898
  /**
4695
4899
  * Array of input/output values.
@@ -4886,7 +5090,7 @@ export interface TrajectoryDetails {
4886
5090
  */
4887
5091
  'trajectory': string;
4888
5092
  /**
4889
- * Current location of motion group on the trajectory.
5093
+ * 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
4890
5094
  * @type {number}
4891
5095
  * @memberof TrajectoryDetails
4892
5096
  */
@@ -4912,9 +5116,19 @@ export type TrajectoryDetailsKindEnum = typeof TrajectoryDetailsKindEnum[keyof t
4912
5116
  * @type TrajectoryDetailsState
4913
5117
  * @export
4914
5118
  */
4915
- export type TrajectoryDetailsState = TrajectoryEnded | TrajectoryPausedByUser | TrajectoryPausedOnIO | TrajectoryRunning | TrajectoryWaitForIO;
5119
+ export type TrajectoryDetailsState = {
5120
+ kind: 'END_OF_TRAJECTORY';
5121
+ } & TrajectoryEnded | {
5122
+ kind: 'PAUSED_BY_USER';
5123
+ } & TrajectoryPausedByUser | {
5124
+ kind: 'PAUSED_ON_IO';
5125
+ } & TrajectoryPausedOnIO | {
5126
+ kind: 'RUNNING';
5127
+ } & TrajectoryRunning | {
5128
+ kind: 'WAIT_FOR_IO';
5129
+ } & TrajectoryWaitForIO;
4916
5130
  /**
4917
- *
5131
+ * First or last sample (depending on direction) of trajectory has been sent.
4918
5132
  * @export
4919
5133
  * @interface TrajectoryEnded
4920
5134
  */
@@ -4941,7 +5155,7 @@ export interface TrajectoryId {
4941
5155
  * @type {string}
4942
5156
  * @memberof TrajectoryId
4943
5157
  */
4944
- 'message_type'?: TrajectoryIdMessageTypeEnum;
5158
+ 'message_type': TrajectoryIdMessageTypeEnum;
4945
5159
  /**
4946
5160
  * The identifier of the trajectory which was returned by the [addTrajectory](addTrajectory) endpoint.
4947
5161
  * @type {string}
@@ -4954,7 +5168,7 @@ export declare const TrajectoryIdMessageTypeEnum: {
4954
5168
  };
4955
5169
  export type TrajectoryIdMessageTypeEnum = typeof TrajectoryIdMessageTypeEnum[keyof typeof TrajectoryIdMessageTypeEnum];
4956
5170
  /**
4957
- *
5171
+ * User has paused execution.
4958
5172
  * @export
4959
5173
  * @interface TrajectoryPausedByUser
4960
5174
  */
@@ -4971,7 +5185,7 @@ export declare const TrajectoryPausedByUserKindEnum: {
4971
5185
  };
4972
5186
  export type TrajectoryPausedByUserKindEnum = typeof TrajectoryPausedByUserKindEnum[keyof typeof TrajectoryPausedByUserKindEnum];
4973
5187
  /**
4974
- *
5188
+ * Execution was paused because of an I/O event.
4975
5189
  * @export
4976
5190
  * @interface TrajectoryPausedOnIO
4977
5191
  */
@@ -4988,7 +5202,7 @@ export declare const TrajectoryPausedOnIOKindEnum: {
4988
5202
  };
4989
5203
  export type TrajectoryPausedOnIOKindEnum = typeof TrajectoryPausedOnIOKindEnum[keyof typeof TrajectoryPausedOnIOKindEnum];
4990
5204
  /**
4991
- *
5205
+ * Trajectory is being executed.
4992
5206
  * @export
4993
5207
  * @interface TrajectoryRunning
4994
5208
  */
@@ -5011,7 +5225,7 @@ export declare const TrajectoryRunningKindEnum: {
5011
5225
  };
5012
5226
  export type TrajectoryRunningKindEnum = typeof TrajectoryRunningKindEnum[keyof typeof TrajectoryRunningKindEnum];
5013
5227
  /**
5014
- *
5228
+ * Waiting for an I/O event to start execution.
5015
5229
  * @export
5016
5230
  * @interface TrajectoryWaitForIO
5017
5231
  */
@@ -5114,6 +5328,31 @@ export interface ValidationError {
5114
5328
  [key: string]: any;
5115
5329
  };
5116
5330
  }
5331
+ /**
5332
+ * A validation error of a program.
5333
+ * @export
5334
+ * @interface ValidationError2
5335
+ */
5336
+ export interface ValidationError2 {
5337
+ /**
5338
+ *
5339
+ * @type {Array<number>}
5340
+ * @memberof ValidationError2
5341
+ */
5342
+ 'loc': Array<number>;
5343
+ /**
5344
+ *
5345
+ * @type {string}
5346
+ * @memberof ValidationError2
5347
+ */
5348
+ 'msg': string;
5349
+ /**
5350
+ *
5351
+ * @type {string}
5352
+ * @memberof ValidationError2
5353
+ */
5354
+ 'type': string;
5355
+ }
5117
5356
  /**
5118
5357
  * @type ValidationErrorLocInner
5119
5358
  * @export
@@ -5236,11 +5475,13 @@ export declare const VirtualControllerTypes: {
5236
5475
  readonly KukaKr4R600: "kuka-kr4_r600";
5237
5476
  readonly KukaKr500L3403: "kuka-kr500_l340_3";
5238
5477
  readonly KukaKr50R2500: "kuka-kr50_r2500";
5478
+ readonly KukaKr60R3: "kuka-kr60_r3";
5239
5479
  readonly KukaKr6R1820: "kuka-kr6_r1820";
5240
5480
  readonly KukaKr6R7002: "kuka-kr6_r700_2";
5241
5481
  readonly KukaKr6R700Sixx: "kuka-kr6_r700_sixx";
5242
5482
  readonly KukaKr6R900: "kuka-kr6_r900";
5243
5483
  readonly KukaKr6R9002: "kuka-kr6_r900_2";
5484
+ readonly KukaKr70R2100: "kuka-kr70_r2100";
5244
5485
  readonly KukaLbrIisy11R1300: "kuka-lbr_iisy_11_r1300";
5245
5486
  readonly UniversalrobotsUr10cb: "universalrobots-ur10cb";
5246
5487
  readonly UniversalrobotsUr10e: "universalrobots-ur10e";
@@ -5685,7 +5926,7 @@ export declare const BUSInputsOutputsApiAxiosParamCreator: (configuration?: Conf
5685
5926
  */
5686
5927
  getProfinetIOsFromFile: (cell: string, inputOffset?: number, outputOffset?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
5687
5928
  /**
5688
- * 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.
5929
+ * 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.
5689
5930
  * @summary List Descriptions
5690
5931
  * @param {string} cell Unique identifier addressing a cell in all API calls.
5691
5932
  * @param {*} [options] Override http request option.
@@ -5693,7 +5934,7 @@ export declare const BUSInputsOutputsApiAxiosParamCreator: (configuration?: Conf
5693
5934
  */
5694
5935
  listBusIODescriptions: (cell: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
5695
5936
  /**
5696
- * 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.
5937
+ * 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.
5697
5938
  * @summary List PROFINET Input/Output Configuration
5698
5939
  * @param {string} cell Unique identifier addressing a cell in all API calls.
5699
5940
  * @param {*} [options] Override http request option.
@@ -5710,7 +5951,7 @@ export declare const BUSInputsOutputsApiAxiosParamCreator: (configuration?: Conf
5710
5951
  */
5711
5952
  setBusIOValues: (cell: string, iOValue: Array<IOValue>, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
5712
5953
  /**
5713
- * 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.
5954
+ * 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.
5714
5955
  * @summary Set PROFINET Inputs/Outputs from File
5715
5956
  * @param {string} cell Unique identifier addressing a cell in all API calls.
5716
5957
  * @param {ProfinetInputOutputConfig} profinetInputOutputConfig
@@ -5806,7 +6047,7 @@ export declare const BUSInputsOutputsApiFp: (configuration?: Configuration) => {
5806
6047
  */
5807
6048
  getProfinetIOsFromFile(cell: string, inputOffset?: number, outputOffset?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<string>>;
5808
6049
  /**
5809
- * 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.
6050
+ * 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.
5810
6051
  * @summary List Descriptions
5811
6052
  * @param {string} cell Unique identifier addressing a cell in all API calls.
5812
6053
  * @param {*} [options] Override http request option.
@@ -5814,7 +6055,7 @@ export declare const BUSInputsOutputsApiFp: (configuration?: Configuration) => {
5814
6055
  */
5815
6056
  listBusIODescriptions(cell: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<IODescription2>>>;
5816
6057
  /**
5817
- * 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.
6058
+ * 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.
5818
6059
  * @summary List PROFINET Input/Output Configuration
5819
6060
  * @param {string} cell Unique identifier addressing a cell in all API calls.
5820
6061
  * @param {*} [options] Override http request option.
@@ -5831,7 +6072,7 @@ export declare const BUSInputsOutputsApiFp: (configuration?: Configuration) => {
5831
6072
  */
5832
6073
  setBusIOValues(cell: string, iOValue: Array<IOValue>, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
5833
6074
  /**
5834
- * 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.
6075
+ * 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.
5835
6076
  * @summary Set PROFINET Inputs/Outputs from File
5836
6077
  * @param {string} cell Unique identifier addressing a cell in all API calls.
5837
6078
  * @param {ProfinetInputOutputConfig} profinetInputOutputConfig
@@ -5927,7 +6168,7 @@ export declare const BUSInputsOutputsApiFactory: (configuration?: Configuration,
5927
6168
  */
5928
6169
  getProfinetIOsFromFile(cell: string, inputOffset?: number, outputOffset?: number, options?: RawAxiosRequestConfig): AxiosPromise<string>;
5929
6170
  /**
5930
- * 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.
6171
+ * 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.
5931
6172
  * @summary List Descriptions
5932
6173
  * @param {string} cell Unique identifier addressing a cell in all API calls.
5933
6174
  * @param {*} [options] Override http request option.
@@ -5935,7 +6176,7 @@ export declare const BUSInputsOutputsApiFactory: (configuration?: Configuration,
5935
6176
  */
5936
6177
  listBusIODescriptions(cell: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<IODescription2>>;
5937
6178
  /**
5938
- * 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.
6179
+ * 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.
5939
6180
  * @summary List PROFINET Input/Output Configuration
5940
6181
  * @param {string} cell Unique identifier addressing a cell in all API calls.
5941
6182
  * @param {*} [options] Override http request option.
@@ -5952,7 +6193,7 @@ export declare const BUSInputsOutputsApiFactory: (configuration?: Configuration,
5952
6193
  */
5953
6194
  setBusIOValues(cell: string, iOValue: Array<IOValue>, options?: RawAxiosRequestConfig): AxiosPromise<void>;
5954
6195
  /**
5955
- * 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.
6196
+ * 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.
5956
6197
  * @summary Set PROFINET Inputs/Outputs from File
5957
6198
  * @param {string} cell Unique identifier addressing a cell in all API calls.
5958
6199
  * @param {ProfinetInputOutputConfig} profinetInputOutputConfig
@@ -6059,7 +6300,7 @@ export declare class BUSInputsOutputsApi extends BaseAPI {
6059
6300
  */
6060
6301
  getProfinetIOsFromFile(cell: string, inputOffset?: number, outputOffset?: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<string, any>>;
6061
6302
  /**
6062
- * 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.
6303
+ * 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.
6063
6304
  * @summary List Descriptions
6064
6305
  * @param {string} cell Unique identifier addressing a cell in all API calls.
6065
6306
  * @param {*} [options] Override http request option.
@@ -6068,7 +6309,7 @@ export declare class BUSInputsOutputsApi extends BaseAPI {
6068
6309
  */
6069
6310
  listBusIODescriptions(cell: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<IODescription2[], any>>;
6070
6311
  /**
6071
- * 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.
6312
+ * 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.
6072
6313
  * @summary List PROFINET Input/Output Configuration
6073
6314
  * @param {string} cell Unique identifier addressing a cell in all API calls.
6074
6315
  * @param {*} [options] Override http request option.
@@ -6087,7 +6328,7 @@ export declare class BUSInputsOutputsApi extends BaseAPI {
6087
6328
  */
6088
6329
  setBusIOValues(cell: string, iOValue: Array<IOValue>, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
6089
6330
  /**
6090
- * 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.
6331
+ * 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.
6091
6332
  * @summary Set PROFINET Inputs/Outputs from File
6092
6333
  * @param {string} cell Unique identifier addressing a cell in all API calls.
6093
6334
  * @param {ProfinetInputOutputConfig} profinetInputOutputConfig
@@ -7677,7 +7918,7 @@ export declare class MotionGroupApi extends BaseAPI {
7677
7918
  */
7678
7919
  export declare const MotionGroupModelsApiAxiosParamCreator: (configuration?: Configuration) => {
7679
7920
  /**
7680
- * 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.
7921
+ * 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.
7681
7922
  * @summary Get Collision Model
7682
7923
  * @param {string} cell Unique identifier addressing a cell in all API calls.
7683
7924
  * @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).
@@ -7700,7 +7941,7 @@ export declare const MotionGroupModelsApiAxiosParamCreator: (configuration?: Con
7700
7941
  */
7701
7942
  export declare const MotionGroupModelsApiFp: (configuration?: Configuration) => {
7702
7943
  /**
7703
- * 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.
7944
+ * 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.
7704
7945
  * @summary Get Collision Model
7705
7946
  * @param {string} cell Unique identifier addressing a cell in all API calls.
7706
7947
  * @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).
@@ -7725,7 +7966,7 @@ export declare const MotionGroupModelsApiFp: (configuration?: Configuration) =>
7725
7966
  */
7726
7967
  export declare const MotionGroupModelsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
7727
7968
  /**
7728
- * 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.
7969
+ * 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.
7729
7970
  * @summary Get Collision Model
7730
7971
  * @param {string} cell Unique identifier addressing a cell in all API calls.
7731
7972
  * @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).
@@ -7752,7 +7993,7 @@ export declare const MotionGroupModelsApiFactory: (configuration?: Configuration
7752
7993
  */
7753
7994
  export declare class MotionGroupModelsApi extends BaseAPI {
7754
7995
  /**
7755
- * 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.
7996
+ * 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.
7756
7997
  * @summary Get Collision Model
7757
7998
  * @param {string} cell Unique identifier addressing a cell in all API calls.
7758
7999
  * @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).
@@ -7773,6 +8014,180 @@ export declare class MotionGroupModelsApi extends BaseAPI {
7773
8014
  */
7774
8015
  getMotionGroupModels(cell: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<string[], any>>;
7775
8016
  }
8017
+ /**
8018
+ * ProgramApi - axios parameter creator
8019
+ * @export
8020
+ */
8021
+ export declare const ProgramApiAxiosParamCreator: (configuration?: Configuration) => {
8022
+ /**
8023
+ * Get details of a program.
8024
+ * @summary Get program
8025
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
8026
+ * @param {string} program
8027
+ * @param {*} [options] Override http request option.
8028
+ * @throws {RequiredError}
8029
+ */
8030
+ getProgram: (cell: string, program: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
8031
+ /**
8032
+ * List details of all existing programs.
8033
+ * @summary List programs
8034
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
8035
+ * @param {*} [options] Override http request option.
8036
+ * @throws {RequiredError}
8037
+ */
8038
+ listPrograms: (cell: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
8039
+ /**
8040
+ * This endpoint starts a new program execution. The program will be executed asynchronously.
8041
+ * @summary Start the program
8042
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
8043
+ * @param {string} program
8044
+ * @param {ProgramStartRequest} programStartRequest
8045
+ * @param {*} [options] Override http request option.
8046
+ * @throws {RequiredError}
8047
+ */
8048
+ startProgram: (cell: string, program: string, programStartRequest: ProgramStartRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
8049
+ /**
8050
+ * Stop a specific program run.
8051
+ * @summary Stop program run
8052
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
8053
+ * @param {string} program
8054
+ * @param {*} [options] Override http request option.
8055
+ * @throws {RequiredError}
8056
+ */
8057
+ stopProgram: (cell: string, program: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
8058
+ };
8059
+ /**
8060
+ * ProgramApi - functional programming interface
8061
+ * @export
8062
+ */
8063
+ export declare const ProgramApiFp: (configuration?: Configuration) => {
8064
+ /**
8065
+ * Get details of a program.
8066
+ * @summary Get program
8067
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
8068
+ * @param {string} program
8069
+ * @param {*} [options] Override http request option.
8070
+ * @throws {RequiredError}
8071
+ */
8072
+ getProgram(cell: string, program: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Program>>;
8073
+ /**
8074
+ * List details of all existing programs.
8075
+ * @summary List programs
8076
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
8077
+ * @param {*} [options] Override http request option.
8078
+ * @throws {RequiredError}
8079
+ */
8080
+ listPrograms(cell: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<Program>>>;
8081
+ /**
8082
+ * This endpoint starts a new program execution. The program will be executed asynchronously.
8083
+ * @summary Start the program
8084
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
8085
+ * @param {string} program
8086
+ * @param {ProgramStartRequest} programStartRequest
8087
+ * @param {*} [options] Override http request option.
8088
+ * @throws {RequiredError}
8089
+ */
8090
+ startProgram(cell: string, program: string, programStartRequest: ProgramStartRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ProgramRun>>;
8091
+ /**
8092
+ * Stop a specific program run.
8093
+ * @summary Stop program run
8094
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
8095
+ * @param {string} program
8096
+ * @param {*} [options] Override http request option.
8097
+ * @throws {RequiredError}
8098
+ */
8099
+ stopProgram(cell: string, program: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
8100
+ };
8101
+ /**
8102
+ * ProgramApi - factory interface
8103
+ * @export
8104
+ */
8105
+ export declare const ProgramApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
8106
+ /**
8107
+ * Get details of a program.
8108
+ * @summary Get program
8109
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
8110
+ * @param {string} program
8111
+ * @param {*} [options] Override http request option.
8112
+ * @throws {RequiredError}
8113
+ */
8114
+ getProgram(cell: string, program: string, options?: RawAxiosRequestConfig): AxiosPromise<Program>;
8115
+ /**
8116
+ * List details of all existing programs.
8117
+ * @summary List programs
8118
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
8119
+ * @param {*} [options] Override http request option.
8120
+ * @throws {RequiredError}
8121
+ */
8122
+ listPrograms(cell: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<Program>>;
8123
+ /**
8124
+ * This endpoint starts a new program execution. The program will be executed asynchronously.
8125
+ * @summary Start the program
8126
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
8127
+ * @param {string} program
8128
+ * @param {ProgramStartRequest} programStartRequest
8129
+ * @param {*} [options] Override http request option.
8130
+ * @throws {RequiredError}
8131
+ */
8132
+ startProgram(cell: string, program: string, programStartRequest: ProgramStartRequest, options?: RawAxiosRequestConfig): AxiosPromise<ProgramRun>;
8133
+ /**
8134
+ * Stop a specific program run.
8135
+ * @summary Stop program run
8136
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
8137
+ * @param {string} program
8138
+ * @param {*} [options] Override http request option.
8139
+ * @throws {RequiredError}
8140
+ */
8141
+ stopProgram(cell: string, program: string, options?: RawAxiosRequestConfig): AxiosPromise<void>;
8142
+ };
8143
+ /**
8144
+ * ProgramApi - object-oriented interface
8145
+ * @export
8146
+ * @class ProgramApi
8147
+ * @extends {BaseAPI}
8148
+ */
8149
+ export declare class ProgramApi extends BaseAPI {
8150
+ /**
8151
+ * Get details of a program.
8152
+ * @summary Get program
8153
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
8154
+ * @param {string} program
8155
+ * @param {*} [options] Override http request option.
8156
+ * @throws {RequiredError}
8157
+ * @memberof ProgramApi
8158
+ */
8159
+ getProgram(cell: string, program: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Program, any>>;
8160
+ /**
8161
+ * List details of all existing programs.
8162
+ * @summary List programs
8163
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
8164
+ * @param {*} [options] Override http request option.
8165
+ * @throws {RequiredError}
8166
+ * @memberof ProgramApi
8167
+ */
8168
+ listPrograms(cell: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Program[], any>>;
8169
+ /**
8170
+ * This endpoint starts a new program execution. The program will be executed asynchronously.
8171
+ * @summary Start the program
8172
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
8173
+ * @param {string} program
8174
+ * @param {ProgramStartRequest} programStartRequest
8175
+ * @param {*} [options] Override http request option.
8176
+ * @throws {RequiredError}
8177
+ * @memberof ProgramApi
8178
+ */
8179
+ startProgram(cell: string, program: string, programStartRequest: ProgramStartRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ProgramRun, any>>;
8180
+ /**
8181
+ * Stop a specific program run.
8182
+ * @summary Stop program run
8183
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
8184
+ * @param {string} program
8185
+ * @param {*} [options] Override http request option.
8186
+ * @throws {RequiredError}
8187
+ * @memberof ProgramApi
8188
+ */
8189
+ stopProgram(cell: string, program: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
8190
+ }
7776
8191
  /**
7777
8192
  * StoreCollisionComponentsApi - axios parameter creator
7778
8193
  * @export
@@ -7841,7 +8256,7 @@ export declare const StoreCollisionComponentsApiAxiosParamCreator: (configuratio
7841
8256
  */
7842
8257
  listCollisionLinkChains: (cell: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
7843
8258
  /**
7844
- * Returns a list of colliders in a scene. This excludes colliders that are part of a motion group.
8259
+ * Returns all stored colliders.
7845
8260
  * @summary List Colliders
7846
8261
  * @param {string} cell Unique identifier addressing a cell in all API calls.
7847
8262
  * @param {*} [options] Override http request option.
@@ -7967,7 +8382,7 @@ export declare const StoreCollisionComponentsApiFp: (configuration?: Configurati
7967
8382
  }>;
7968
8383
  }>>;
7969
8384
  /**
7970
- * Returns a list of colliders in a scene. This excludes colliders that are part of a motion group.
8385
+ * Returns all stored colliders.
7971
8386
  * @summary List Colliders
7972
8387
  * @param {string} cell Unique identifier addressing a cell in all API calls.
7973
8388
  * @param {*} [options] Override http request option.
@@ -8103,7 +8518,7 @@ export declare const StoreCollisionComponentsApiFactory: (configuration?: Config
8103
8518
  }>;
8104
8519
  }>;
8105
8520
  /**
8106
- * Returns a list of colliders in a scene. This excludes colliders that are part of a motion group.
8521
+ * Returns all stored colliders.
8107
8522
  * @summary List Colliders
8108
8523
  * @param {string} cell Unique identifier addressing a cell in all API calls.
8109
8524
  * @param {*} [options] Override http request option.
@@ -8248,7 +8663,7 @@ export declare class StoreCollisionComponentsApi extends BaseAPI {
8248
8663
  }[];
8249
8664
  }, any>>;
8250
8665
  /**
8251
- * Returns a list of colliders in a scene. This excludes colliders that are part of a motion group.
8666
+ * Returns all stored colliders.
8252
8667
  * @summary List Colliders
8253
8668
  * @param {string} cell Unique identifier addressing a cell in all API calls.
8254
8669
  * @param {*} [options] Override http request option.
@@ -9468,7 +9883,7 @@ export declare class TrajectoryPlanningApi extends BaseAPI {
9468
9883
  */
9469
9884
  export declare const VirtualControllerApiAxiosParamCreator: (configuration?: Configuration) => {
9470
9885
  /**
9471
- * Adds a coordinate system to the robot controller.
9886
+ * 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.
9472
9887
  * @summary Add Coordinate Systems
9473
9888
  * @param {string} cell Unique identifier addressing a cell in all API calls.
9474
9889
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -9479,7 +9894,7 @@ export declare const VirtualControllerApiAxiosParamCreator: (configuration?: Con
9479
9894
  */
9480
9895
  addVirtualControllerCoordinateSystem: (cell: string, controller: string, coordinateSystem: string, coordinateSystemData: CoordinateSystemData, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
9481
9896
  /**
9482
- * 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.
9897
+ * 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.
9483
9898
  * @summary Add TCP
9484
9899
  * @param {string} cell Unique identifier addressing a cell in all API calls.
9485
9900
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -9491,8 +9906,8 @@ export declare const VirtualControllerApiAxiosParamCreator: (configuration?: Con
9491
9906
  */
9492
9907
  addVirtualControllerTcp: (cell: string, controller: string, motionGroup: string, tcp: string, robotTcpData: RobotTcpData, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
9493
9908
  /**
9494
- * 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.
9495
- * @summary Remove Coordinate System
9909
+ * 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.
9910
+ * @summary Delete Coordinate System
9496
9911
  * @param {string} cell Unique identifier addressing a cell in all API calls.
9497
9912
  * @param {string} controller Unique identifier to address a controller in the cell.
9498
9913
  * @param {string} coordinateSystem Unique identifier addressing a coordinate system.
@@ -9502,7 +9917,7 @@ export declare const VirtualControllerApiAxiosParamCreator: (configuration?: Con
9502
9917
  */
9503
9918
  deleteVirtualControllerCoordinateSystem: (cell: string, controller: string, coordinateSystem: string, deleteDependent?: boolean, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
9504
9919
  /**
9505
- * Removes the TCP from the motion group. An unknown TCP is a valid input.
9920
+ * 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.
9506
9921
  * @summary Remove TCP
9507
9922
  * @param {string} cell Unique identifier addressing a cell in all API calls.
9508
9923
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -9610,7 +10025,7 @@ export declare const VirtualControllerApiAxiosParamCreator: (configuration?: Con
9610
10025
  */
9611
10026
  setOperationMode: (cell: string, controller: string, mode: OperationMode, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
9612
10027
  /**
9613
- * 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.
10028
+ * 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.
9614
10029
  * @summary Set Mounting
9615
10030
  * @param {string} cell Unique identifier addressing a cell in all API calls.
9616
10031
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -9627,7 +10042,7 @@ export declare const VirtualControllerApiAxiosParamCreator: (configuration?: Con
9627
10042
  */
9628
10043
  export declare const VirtualControllerApiFp: (configuration?: Configuration) => {
9629
10044
  /**
9630
- * Adds a coordinate system to the robot controller.
10045
+ * 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.
9631
10046
  * @summary Add Coordinate Systems
9632
10047
  * @param {string} cell Unique identifier addressing a cell in all API calls.
9633
10048
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -9638,7 +10053,7 @@ export declare const VirtualControllerApiFp: (configuration?: Configuration) =>
9638
10053
  */
9639
10054
  addVirtualControllerCoordinateSystem(cell: string, controller: string, coordinateSystem: string, coordinateSystemData: CoordinateSystemData, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
9640
10055
  /**
9641
- * 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.
10056
+ * 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.
9642
10057
  * @summary Add TCP
9643
10058
  * @param {string} cell Unique identifier addressing a cell in all API calls.
9644
10059
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -9650,8 +10065,8 @@ export declare const VirtualControllerApiFp: (configuration?: Configuration) =>
9650
10065
  */
9651
10066
  addVirtualControllerTcp(cell: string, controller: string, motionGroup: string, tcp: string, robotTcpData: RobotTcpData, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
9652
10067
  /**
9653
- * 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.
9654
- * @summary Remove Coordinate System
10068
+ * 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.
10069
+ * @summary Delete Coordinate System
9655
10070
  * @param {string} cell Unique identifier addressing a cell in all API calls.
9656
10071
  * @param {string} controller Unique identifier to address a controller in the cell.
9657
10072
  * @param {string} coordinateSystem Unique identifier addressing a coordinate system.
@@ -9661,7 +10076,7 @@ export declare const VirtualControllerApiFp: (configuration?: Configuration) =>
9661
10076
  */
9662
10077
  deleteVirtualControllerCoordinateSystem(cell: string, controller: string, coordinateSystem: string, deleteDependent?: boolean, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
9663
10078
  /**
9664
- * Removes the TCP from the motion group. An unknown TCP is a valid input.
10079
+ * 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.
9665
10080
  * @summary Remove TCP
9666
10081
  * @param {string} cell Unique identifier addressing a cell in all API calls.
9667
10082
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -9769,7 +10184,7 @@ export declare const VirtualControllerApiFp: (configuration?: Configuration) =>
9769
10184
  */
9770
10185
  setOperationMode(cell: string, controller: string, mode: OperationMode, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
9771
10186
  /**
9772
- * 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.
10187
+ * 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.
9773
10188
  * @summary Set Mounting
9774
10189
  * @param {string} cell Unique identifier addressing a cell in all API calls.
9775
10190
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -9786,7 +10201,7 @@ export declare const VirtualControllerApiFp: (configuration?: Configuration) =>
9786
10201
  */
9787
10202
  export declare const VirtualControllerApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
9788
10203
  /**
9789
- * Adds a coordinate system to the robot controller.
10204
+ * 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.
9790
10205
  * @summary Add Coordinate Systems
9791
10206
  * @param {string} cell Unique identifier addressing a cell in all API calls.
9792
10207
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -9797,7 +10212,7 @@ export declare const VirtualControllerApiFactory: (configuration?: Configuration
9797
10212
  */
9798
10213
  addVirtualControllerCoordinateSystem(cell: string, controller: string, coordinateSystem: string, coordinateSystemData: CoordinateSystemData, options?: RawAxiosRequestConfig): AxiosPromise<void>;
9799
10214
  /**
9800
- * 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.
10215
+ * 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.
9801
10216
  * @summary Add TCP
9802
10217
  * @param {string} cell Unique identifier addressing a cell in all API calls.
9803
10218
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -9809,8 +10224,8 @@ export declare const VirtualControllerApiFactory: (configuration?: Configuration
9809
10224
  */
9810
10225
  addVirtualControllerTcp(cell: string, controller: string, motionGroup: string, tcp: string, robotTcpData: RobotTcpData, options?: RawAxiosRequestConfig): AxiosPromise<void>;
9811
10226
  /**
9812
- * 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.
9813
- * @summary Remove Coordinate System
10227
+ * 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.
10228
+ * @summary Delete Coordinate System
9814
10229
  * @param {string} cell Unique identifier addressing a cell in all API calls.
9815
10230
  * @param {string} controller Unique identifier to address a controller in the cell.
9816
10231
  * @param {string} coordinateSystem Unique identifier addressing a coordinate system.
@@ -9820,7 +10235,7 @@ export declare const VirtualControllerApiFactory: (configuration?: Configuration
9820
10235
  */
9821
10236
  deleteVirtualControllerCoordinateSystem(cell: string, controller: string, coordinateSystem: string, deleteDependent?: boolean, options?: RawAxiosRequestConfig): AxiosPromise<void>;
9822
10237
  /**
9823
- * Removes the TCP from the motion group. An unknown TCP is a valid input.
10238
+ * 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.
9824
10239
  * @summary Remove TCP
9825
10240
  * @param {string} cell Unique identifier addressing a cell in all API calls.
9826
10241
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -9928,7 +10343,7 @@ export declare const VirtualControllerApiFactory: (configuration?: Configuration
9928
10343
  */
9929
10344
  setOperationMode(cell: string, controller: string, mode: OperationMode, options?: RawAxiosRequestConfig): AxiosPromise<void>;
9930
10345
  /**
9931
- * 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.
10346
+ * 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.
9932
10347
  * @summary Set Mounting
9933
10348
  * @param {string} cell Unique identifier addressing a cell in all API calls.
9934
10349
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -9947,7 +10362,7 @@ export declare const VirtualControllerApiFactory: (configuration?: Configuration
9947
10362
  */
9948
10363
  export declare class VirtualControllerApi extends BaseAPI {
9949
10364
  /**
9950
- * Adds a coordinate system to the robot controller.
10365
+ * 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.
9951
10366
  * @summary Add Coordinate Systems
9952
10367
  * @param {string} cell Unique identifier addressing a cell in all API calls.
9953
10368
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -9959,7 +10374,7 @@ export declare class VirtualControllerApi extends BaseAPI {
9959
10374
  */
9960
10375
  addVirtualControllerCoordinateSystem(cell: string, controller: string, coordinateSystem: string, coordinateSystemData: CoordinateSystemData, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
9961
10376
  /**
9962
- * 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.
10377
+ * 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.
9963
10378
  * @summary Add TCP
9964
10379
  * @param {string} cell Unique identifier addressing a cell in all API calls.
9965
10380
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -9972,8 +10387,8 @@ export declare class VirtualControllerApi extends BaseAPI {
9972
10387
  */
9973
10388
  addVirtualControllerTcp(cell: string, controller: string, motionGroup: string, tcp: string, robotTcpData: RobotTcpData, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
9974
10389
  /**
9975
- * 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.
9976
- * @summary Remove Coordinate System
10390
+ * 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.
10391
+ * @summary Delete Coordinate System
9977
10392
  * @param {string} cell Unique identifier addressing a cell in all API calls.
9978
10393
  * @param {string} controller Unique identifier to address a controller in the cell.
9979
10394
  * @param {string} coordinateSystem Unique identifier addressing a coordinate system.
@@ -9984,7 +10399,7 @@ export declare class VirtualControllerApi extends BaseAPI {
9984
10399
  */
9985
10400
  deleteVirtualControllerCoordinateSystem(cell: string, controller: string, coordinateSystem: string, deleteDependent?: boolean, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
9986
10401
  /**
9987
- * Removes the TCP from the motion group. An unknown TCP is a valid input.
10402
+ * 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.
9988
10403
  * @summary Remove TCP
9989
10404
  * @param {string} cell Unique identifier addressing a cell in all API calls.
9990
10405
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -10103,7 +10518,7 @@ export declare class VirtualControllerApi extends BaseAPI {
10103
10518
  */
10104
10519
  setOperationMode(cell: string, controller: string, mode: OperationMode, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
10105
10520
  /**
10106
- * 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.
10521
+ * 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.
10107
10522
  * @summary Set Mounting
10108
10523
  * @param {string} cell Unique identifier addressing a cell in all API calls.
10109
10524
  * @param {string} controller Unique identifier to address a controller in the cell.