@wandelbots/nova-api 25.8.0-dev.9 → 25.8.0-dev.91
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/package.json +1 -1
- package/v1/api.d.ts +31 -21
- package/v1/api.js +25 -21
- package/v1/api.js.map +1 -1
- package/v1/api.ts +31 -21
- package/v2/api.d.ts +631 -176
- package/v2/api.js +437 -75
- package/v2/api.js.map +1 -1
- package/v2/api.ts +857 -183
package/v2/api.d.ts
CHANGED
|
@@ -93,7 +93,7 @@ export interface AddTrajectoryError {
|
|
|
93
93
|
*/
|
|
94
94
|
'message'?: string;
|
|
95
95
|
/**
|
|
96
|
-
* The
|
|
96
|
+
* Location on trajectory where the execution will start. The default value is the start (forward movement) or end (backward movement) of the trajectory. If you want to start your movement from an arbitrary location, e.g. in combination with [streamMoveToTrajectoryViaJointPTP](streamMoveToTrajectoryViaJointPTP), set the location by respecting the following format: - The location is a scalar value that defines a position along a path, typically ranging from 0 to `n`, where `n` denotes the number of motion commands - Each integer value of the location corresponds to a specific motion command, while non-integer values interpolate positions within the segments. - The location is calculated from the joint path
|
|
97
97
|
* @type {number}
|
|
98
98
|
* @memberof AddTrajectoryError
|
|
99
99
|
*/
|
|
@@ -342,7 +342,7 @@ export declare const BoxBoxTypeEnum: {
|
|
|
342
342
|
};
|
|
343
343
|
export type BoxBoxTypeEnum = typeof BoxBoxTypeEnum[keyof typeof BoxBoxTypeEnum];
|
|
344
344
|
/**
|
|
345
|
-
* PROFINET BUS
|
|
345
|
+
* PROFINET BUS inputs/outputs service configuration.
|
|
346
346
|
* @export
|
|
347
347
|
* @interface BusIOProfinet
|
|
348
348
|
*/
|
|
@@ -354,19 +354,19 @@ export interface BusIOProfinet {
|
|
|
354
354
|
*/
|
|
355
355
|
'bus_type'?: BusIOProfinetBusTypeEnum;
|
|
356
356
|
/**
|
|
357
|
-
*
|
|
358
|
-
* @type {
|
|
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
|
-
'
|
|
361
|
+
'network_config'?: BusIOProfinetNetwork;
|
|
362
362
|
/**
|
|
363
|
-
*
|
|
364
|
-
* @type {
|
|
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
|
-
'
|
|
367
|
+
'plc_ip': string;
|
|
368
368
|
/**
|
|
369
|
-
* MAC address
|
|
369
|
+
* MAC address of the physical ethernet interface that you want to use for PROFINET communication.
|
|
370
370
|
* @type {string}
|
|
371
371
|
* @memberof BusIOProfinet
|
|
372
372
|
*/
|
|
@@ -383,7 +383,7 @@ export declare const BusIOProfinetBusTypeEnum: {
|
|
|
383
383
|
};
|
|
384
384
|
export type BusIOProfinetBusTypeEnum = typeof BusIOProfinetBusTypeEnum[keyof typeof BusIOProfinetBusTypeEnum];
|
|
385
385
|
/**
|
|
386
|
-
*
|
|
386
|
+
* Current default route configuration of your NOVA instance. The default route is a setting that tells data where to go if there isn’t a specific path already known for its destination. Usually this will be the path to your router, enabling accessing the internet. On Linux, use `ip route show` to view your default routes and match the output `default via <gateway> dev <interface> ...` to get your gateway and interface.
|
|
387
387
|
* @export
|
|
388
388
|
* @interface BusIOProfinetDefaultRoute
|
|
389
389
|
*/
|
|
@@ -402,25 +402,25 @@ export interface BusIOProfinetDefaultRoute {
|
|
|
402
402
|
'interface': string;
|
|
403
403
|
}
|
|
404
404
|
/**
|
|
405
|
-
* Network configuration
|
|
405
|
+
* Network configuration or IPv4 record of the virtual ethernet interface (pnio1) created by the PROFINET driver. The IPv4 record is used in combination with the Name of Station (NoS) to identify your device in the PROFINET network. The `ip_config` will be used as IPv4 record if no REMA XML file is already present on your machine and no `rema_xml_content` is provided.
|
|
406
406
|
* @export
|
|
407
407
|
* @interface BusIOProfinetIpConfig
|
|
408
408
|
*/
|
|
409
409
|
export interface BusIOProfinetIpConfig {
|
|
410
410
|
/**
|
|
411
|
-
* IP address for the
|
|
411
|
+
* IP address for the device\'s virtual ethernet interface (pnio1).
|
|
412
412
|
* @type {string}
|
|
413
413
|
* @memberof BusIOProfinetIpConfig
|
|
414
414
|
*/
|
|
415
415
|
'ip': string;
|
|
416
416
|
/**
|
|
417
|
-
* Network mask for the
|
|
417
|
+
* Network mask for the device\'s virtual ethernet interface (pnio1).
|
|
418
418
|
* @type {string}
|
|
419
419
|
* @memberof BusIOProfinetIpConfig
|
|
420
420
|
*/
|
|
421
421
|
'netmask': string;
|
|
422
422
|
/**
|
|
423
|
-
* Gateway for the
|
|
423
|
+
* Gateway for connections to other devices outside of the virtual ethernet interface\'s subnet.
|
|
424
424
|
* @type {string}
|
|
425
425
|
* @memberof BusIOProfinetIpConfig
|
|
426
426
|
*/
|
|
@@ -433,7 +433,7 @@ export interface BusIOProfinetIpConfig {
|
|
|
433
433
|
*/
|
|
434
434
|
export interface BusIOProfinetNetwork {
|
|
435
435
|
/**
|
|
436
|
-
* Name of the PROFINET device.
|
|
436
|
+
* Name of Station (NoS) of the PROFINET device. The NoS is used in combination with IPv4 record to identify your device in the PROFINET network. The `device_name` will be used as NoS if no REMA XML file is already present on your machine and no `rema_xml_content` is provided.
|
|
437
437
|
* @type {string}
|
|
438
438
|
* @memberof BusIOProfinetNetwork
|
|
439
439
|
*/
|
|
@@ -445,14 +445,14 @@ export interface BusIOProfinetNetwork {
|
|
|
445
445
|
*/
|
|
446
446
|
'ip_config'?: BusIOProfinetIpConfig;
|
|
447
447
|
/**
|
|
448
|
-
* Content of the PROFINET REMA XML file.
|
|
448
|
+
* Content of the PROFINET REMA XML file. Is used when PROFINET service is added for the first time to create the REMA XML file that holds data to be kept for the next session. Stores information like IP address, Name of Station (NoS) and hardware configuration. If you use a PROFINET controller to assign an IP address to the PROFINET device, this information will be written to the REMA XML file. Refer to the PDF version of the \"PN Driver I/O Base programming interface\" documentation for more information and an example REMA file.
|
|
449
449
|
* @type {string}
|
|
450
450
|
* @memberof BusIOProfinetNetwork
|
|
451
451
|
*/
|
|
452
452
|
'rema_xml_content'?: string;
|
|
453
453
|
}
|
|
454
454
|
/**
|
|
455
|
-
* Virtual PROFINET BUS
|
|
455
|
+
* Virtual PROFINET BUS inputs/outputs service configuration.
|
|
456
456
|
* @export
|
|
457
457
|
* @interface BusIOProfinetVirtual
|
|
458
458
|
*/
|
|
@@ -465,7 +465,7 @@ export interface BusIOProfinetVirtual {
|
|
|
465
465
|
'bus_type'?: BusIOProfinetVirtualBusTypeEnum;
|
|
466
466
|
}
|
|
467
467
|
export declare const BusIOProfinetVirtualBusTypeEnum: {
|
|
468
|
-
readonly
|
|
468
|
+
readonly ProfinetVirtual: "profinet_virtual";
|
|
469
469
|
};
|
|
470
470
|
export type BusIOProfinetVirtualBusTypeEnum = typeof BusIOProfinetVirtualBusTypeEnum[keyof typeof BusIOProfinetVirtualBusTypeEnum];
|
|
471
471
|
/**
|
|
@@ -490,7 +490,7 @@ export interface BusIOsState {
|
|
|
490
490
|
*/
|
|
491
491
|
'state': BusIOsStateEnum;
|
|
492
492
|
/**
|
|
493
|
-
* A message providing additional information on the input/output, e.g. BUS service status, encountered errors. May be empty if no additional information is available.
|
|
493
|
+
* A message providing additional information on the input/output service, e.g. BUS service status, encountered errors. May be empty if no additional information is available.
|
|
494
494
|
* @type {string}
|
|
495
495
|
* @memberof BusIOsState
|
|
496
496
|
*/
|
|
@@ -1708,9 +1708,22 @@ export interface GetTrajectoryResponse {
|
|
|
1708
1708
|
export interface HTTPValidationError {
|
|
1709
1709
|
/**
|
|
1710
1710
|
*
|
|
1711
|
-
* @type {Array<
|
|
1711
|
+
* @type {Array<ValidationError2>}
|
|
1712
1712
|
* @memberof HTTPValidationError
|
|
1713
1713
|
*/
|
|
1714
|
+
'detail'?: Array<ValidationError2>;
|
|
1715
|
+
}
|
|
1716
|
+
/**
|
|
1717
|
+
*
|
|
1718
|
+
* @export
|
|
1719
|
+
* @interface HTTPValidationError2
|
|
1720
|
+
*/
|
|
1721
|
+
export interface HTTPValidationError2 {
|
|
1722
|
+
/**
|
|
1723
|
+
*
|
|
1724
|
+
* @type {Array<ValidationError>}
|
|
1725
|
+
* @memberof HTTPValidationError2
|
|
1726
|
+
*/
|
|
1714
1727
|
'detail'?: Array<ValidationError>;
|
|
1715
1728
|
}
|
|
1716
1729
|
/**
|
|
@@ -1797,6 +1810,55 @@ export interface IODescription {
|
|
|
1797
1810
|
*/
|
|
1798
1811
|
'max'?: IODescriptionMin;
|
|
1799
1812
|
}
|
|
1813
|
+
/**
|
|
1814
|
+
*
|
|
1815
|
+
* @export
|
|
1816
|
+
* @interface IODescription2
|
|
1817
|
+
*/
|
|
1818
|
+
export interface IODescription2 {
|
|
1819
|
+
/**
|
|
1820
|
+
* Unique identifier of the input/output.
|
|
1821
|
+
* @type {string}
|
|
1822
|
+
* @memberof IODescription2
|
|
1823
|
+
*/
|
|
1824
|
+
'io': string;
|
|
1825
|
+
/**
|
|
1826
|
+
* Descriptive name of the input/output. Customize it using the respective BUS service, e.g. [addProfinetIO](addProfinetIO) for PROFINET service.
|
|
1827
|
+
* @type {string}
|
|
1828
|
+
* @memberof IODescription2
|
|
1829
|
+
*/
|
|
1830
|
+
'name': string;
|
|
1831
|
+
/**
|
|
1832
|
+
*
|
|
1833
|
+
* @type {IODirection}
|
|
1834
|
+
* @memberof IODescription2
|
|
1835
|
+
*/
|
|
1836
|
+
'direction': IODirection;
|
|
1837
|
+
/**
|
|
1838
|
+
*
|
|
1839
|
+
* @type {IOValueType}
|
|
1840
|
+
* @memberof IODescription2
|
|
1841
|
+
*/
|
|
1842
|
+
'value_type': IOValueType;
|
|
1843
|
+
/**
|
|
1844
|
+
*
|
|
1845
|
+
* @type {UnitType}
|
|
1846
|
+
* @memberof IODescription2
|
|
1847
|
+
*/
|
|
1848
|
+
'unit'?: UnitType;
|
|
1849
|
+
/**
|
|
1850
|
+
*
|
|
1851
|
+
* @type {IODescriptionMin}
|
|
1852
|
+
* @memberof IODescription2
|
|
1853
|
+
*/
|
|
1854
|
+
'min'?: IODescriptionMin;
|
|
1855
|
+
/**
|
|
1856
|
+
*
|
|
1857
|
+
* @type {IODescriptionMin}
|
|
1858
|
+
* @memberof IODescription2
|
|
1859
|
+
*/
|
|
1860
|
+
'max'?: IODescriptionMin;
|
|
1861
|
+
}
|
|
1800
1862
|
/**
|
|
1801
1863
|
* @type IODescriptionMin
|
|
1802
1864
|
* @export
|
|
@@ -1860,7 +1922,7 @@ export interface IOIntegerValue {
|
|
|
1860
1922
|
*/
|
|
1861
1923
|
'io': string;
|
|
1862
1924
|
/**
|
|
1863
|
-
* Value of an input/output with integer representation. > The integral value is transmitted as a string to avoid precision loss during conversion to JSON. >
|
|
1925
|
+
* Value of an input/output with integer representation. > The integral value is transmitted as a string to avoid precision loss during conversion to JSON. > Recommended: Use int64 in your implementation. If you want to interact with int64 in numbers, > JS bigint libraries can help you to parse the string into an integral value.
|
|
1864
1926
|
* @type {string}
|
|
1865
1927
|
* @memberof IOIntegerValue
|
|
1866
1928
|
*/
|
|
@@ -1876,6 +1938,16 @@ export declare const IOIntegerValueValueTypeEnum: {
|
|
|
1876
1938
|
readonly Integer: "integer";
|
|
1877
1939
|
};
|
|
1878
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];
|
|
1879
1951
|
/**
|
|
1880
1952
|
* @type IOValue
|
|
1881
1953
|
* @export
|
|
@@ -1985,24 +2057,12 @@ export interface InitializeJoggingRequest {
|
|
|
1985
2057
|
* @memberof InitializeJoggingRequest
|
|
1986
2058
|
*/
|
|
1987
2059
|
'tcp'?: string;
|
|
1988
|
-
/**
|
|
1989
|
-
* 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.
|
|
1990
|
-
* @type {number}
|
|
1991
|
-
* @memberof InitializeJoggingRequest
|
|
1992
|
-
*/
|
|
1993
|
-
'response_rate'?: number;
|
|
1994
2060
|
/**
|
|
1995
2061
|
* Unique identifier addressing a coordinate system to which the responses are transformed. If not set, world coordinate system is used.
|
|
1996
2062
|
* @type {string}
|
|
1997
2063
|
* @memberof InitializeJoggingRequest
|
|
1998
2064
|
*/
|
|
1999
2065
|
'response_coordinate_system'?: string;
|
|
2000
|
-
/**
|
|
2001
|
-
* Defines an input/output that is listened to during the movement. Execution pauses if the defined comparator evaluates to `true`.
|
|
2002
|
-
* @type {string}
|
|
2003
|
-
* @memberof InitializeJoggingRequest
|
|
2004
|
-
*/
|
|
2005
|
-
'pause_on_io'?: string;
|
|
2006
2066
|
}
|
|
2007
2067
|
export declare const InitializeJoggingRequestMessageTypeEnum: {
|
|
2008
2068
|
readonly InitializeJoggingRequest: "InitializeJoggingRequest";
|
|
@@ -2055,12 +2115,6 @@ export interface InitializeMovementRequest {
|
|
|
2055
2115
|
* @memberof InitializeMovementRequest
|
|
2056
2116
|
*/
|
|
2057
2117
|
'initial_location'?: number;
|
|
2058
|
-
/**
|
|
2059
|
-
* 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.
|
|
2060
|
-
* @type {number}
|
|
2061
|
-
* @memberof InitializeMovementRequest
|
|
2062
|
-
*/
|
|
2063
|
-
'response_rate'?: number;
|
|
2064
2118
|
/**
|
|
2065
2119
|
* Unique identifier addressing a coordinate system to which the responses are transformed. If not set, world coordinate system is used.
|
|
2066
2120
|
* @type {string}
|
|
@@ -2112,7 +2166,7 @@ export declare const InitializeMovementResponseKindEnum: {
|
|
|
2112
2166
|
};
|
|
2113
2167
|
export type InitializeMovementResponseKindEnum = typeof InitializeMovementResponseKindEnum[keyof typeof InitializeMovementResponseKindEnum];
|
|
2114
2168
|
/**
|
|
2115
|
-
* Value of an input/output with integer representation. > The integral value is transmitted as a string to avoid precision loss during conversion to JSON. >
|
|
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.
|
|
2116
2170
|
* @export
|
|
2117
2171
|
* @interface IntegerValue
|
|
2118
2172
|
*/
|
|
@@ -2484,7 +2538,7 @@ export interface JointTrajectory {
|
|
|
2484
2538
|
*/
|
|
2485
2539
|
'times': Array<number>;
|
|
2486
2540
|
/**
|
|
2487
|
-
*
|
|
2541
|
+
*
|
|
2488
2542
|
* @type {Array<number>}
|
|
2489
2543
|
* @memberof JointTrajectory
|
|
2490
2544
|
*/
|
|
@@ -2566,6 +2620,12 @@ export interface KukaController {
|
|
|
2566
2620
|
* @memberof KukaController
|
|
2567
2621
|
*/
|
|
2568
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;
|
|
2569
2629
|
}
|
|
2570
2630
|
export declare const KukaControllerKindEnum: {
|
|
2571
2631
|
readonly KukaController: "KukaController";
|
|
@@ -2691,25 +2751,6 @@ export declare const LicenseStatusEnum: {
|
|
|
2691
2751
|
readonly NotFound: "NOT_FOUND";
|
|
2692
2752
|
};
|
|
2693
2753
|
export type LicenseStatusEnum = typeof LicenseStatusEnum[keyof typeof LicenseStatusEnum];
|
|
2694
|
-
/**
|
|
2695
|
-
*
|
|
2696
|
-
* @export
|
|
2697
|
-
* @interface LimitConfig
|
|
2698
|
-
*/
|
|
2699
|
-
export interface LimitConfig {
|
|
2700
|
-
/**
|
|
2701
|
-
*
|
|
2702
|
-
* @type {LimitSet}
|
|
2703
|
-
* @memberof LimitConfig
|
|
2704
|
-
*/
|
|
2705
|
-
'physical_limits'?: LimitSet;
|
|
2706
|
-
/**
|
|
2707
|
-
*
|
|
2708
|
-
* @type {OperationLimits}
|
|
2709
|
-
* @memberof LimitConfig
|
|
2710
|
-
*/
|
|
2711
|
-
'operation_limits'?: OperationLimits;
|
|
2712
|
-
}
|
|
2713
2754
|
/**
|
|
2714
2755
|
* The upper_limit must be greater then the lower_limit.
|
|
2715
2756
|
* @export
|
|
@@ -2759,6 +2800,12 @@ export interface LimitSet {
|
|
|
2759
2800
|
* @memberof LimitSet
|
|
2760
2801
|
*/
|
|
2761
2802
|
'flange'?: CartesianLimits;
|
|
2803
|
+
/**
|
|
2804
|
+
*
|
|
2805
|
+
* @type {JointLimits}
|
|
2806
|
+
* @memberof LimitSet
|
|
2807
|
+
*/
|
|
2808
|
+
'coupled_shoulder_elbow_joint'?: JointLimits;
|
|
2762
2809
|
}
|
|
2763
2810
|
/**
|
|
2764
2811
|
* If a limit is not set, the default value will be used.
|
|
@@ -2830,13 +2877,13 @@ export declare const Manufacturer: {
|
|
|
2830
2877
|
};
|
|
2831
2878
|
export type Manufacturer = typeof Manufacturer[keyof typeof Manufacturer];
|
|
2832
2879
|
/**
|
|
2833
|
-
*
|
|
2880
|
+
*
|
|
2834
2881
|
* @export
|
|
2835
2882
|
* @interface MidpointInsertionAlgorithm
|
|
2836
2883
|
*/
|
|
2837
2884
|
export interface MidpointInsertionAlgorithm {
|
|
2838
2885
|
/**
|
|
2839
|
-
* 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.
|
|
2840
2887
|
* @type {string}
|
|
2841
2888
|
* @memberof MidpointInsertionAlgorithm
|
|
2842
2889
|
*/
|
|
@@ -2924,13 +2971,13 @@ export interface MotionGroupDescription {
|
|
|
2924
2971
|
* @type {Pose}
|
|
2925
2972
|
* @memberof MotionGroupDescription
|
|
2926
2973
|
*/
|
|
2927
|
-
'mounting'
|
|
2974
|
+
'mounting'?: Pose;
|
|
2928
2975
|
/**
|
|
2929
2976
|
* Maps a TCP name to its offset relative to the flange coordinate system. Key must be a TCP identifier. Values are TcpOffsets.
|
|
2930
2977
|
* @type {{ [key: string]: TcpOffset; }}
|
|
2931
2978
|
* @memberof MotionGroupDescription
|
|
2932
2979
|
*/
|
|
2933
|
-
'tcps'
|
|
2980
|
+
'tcps'?: {
|
|
2934
2981
|
[key: string]: TcpOffset;
|
|
2935
2982
|
};
|
|
2936
2983
|
/**
|
|
@@ -2961,10 +3008,10 @@ export interface MotionGroupDescription {
|
|
|
2961
3008
|
};
|
|
2962
3009
|
/**
|
|
2963
3010
|
*
|
|
2964
|
-
* @type {
|
|
3011
|
+
* @type {OperationLimits}
|
|
2965
3012
|
* @memberof MotionGroupDescription
|
|
2966
3013
|
*/
|
|
2967
|
-
'
|
|
3014
|
+
'operation_limits': OperationLimits;
|
|
2968
3015
|
/**
|
|
2969
3016
|
* Maps a payload name to its configuration. Key must be a payload identifier. Values are payload objects.
|
|
2970
3017
|
* @type {{ [key: string]: Payload; }}
|
|
@@ -3577,6 +3624,12 @@ export interface PauseOnIO {
|
|
|
3577
3624
|
* @memberof PauseOnIO
|
|
3578
3625
|
*/
|
|
3579
3626
|
'comparator': Comparator;
|
|
3627
|
+
/**
|
|
3628
|
+
*
|
|
3629
|
+
* @type {IOOrigin}
|
|
3630
|
+
* @memberof PauseOnIO
|
|
3631
|
+
*/
|
|
3632
|
+
'io_origin': IOOrigin;
|
|
3580
3633
|
}
|
|
3581
3634
|
/**
|
|
3582
3635
|
*
|
|
@@ -3697,11 +3750,11 @@ export interface PlanTrajectoryFailedResponse {
|
|
|
3697
3750
|
*/
|
|
3698
3751
|
'error_feedback': PlanTrajectoryFailedResponseErrorFeedback;
|
|
3699
3752
|
/**
|
|
3700
|
-
*
|
|
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
|
|
3701
3754
|
* @type {number}
|
|
3702
3755
|
* @memberof PlanTrajectoryFailedResponse
|
|
3703
3756
|
*/
|
|
3704
|
-
'error_location_on_trajectory'
|
|
3757
|
+
'error_location_on_trajectory': number;
|
|
3705
3758
|
/**
|
|
3706
3759
|
* The joint trajectory from the start joint position to the error.
|
|
3707
3760
|
* @type {JointTrajectory}
|
|
@@ -3915,17 +3968,17 @@ export interface ProfinetDescription {
|
|
|
3915
3968
|
*/
|
|
3916
3969
|
'slots'?: Array<ProfinetSlotDescription>;
|
|
3917
3970
|
/**
|
|
3918
|
-
* Name of the PROFINET device
|
|
3971
|
+
* Name of Station (NoS) of the PROFINET device. The NoS is used in combination with IPv4 record to identify your device in the PROFINET network. The `device_name` will be used as NoS if no REMA XML file is already present on your NOVA instance and no `rema_xml_content` is provided.
|
|
3919
3972
|
* @type {string}
|
|
3920
3973
|
* @memberof ProfinetDescription
|
|
3921
3974
|
*/
|
|
3922
3975
|
'device_name'?: string;
|
|
3923
3976
|
/**
|
|
3924
|
-
*
|
|
3925
|
-
* @type {
|
|
3977
|
+
*
|
|
3978
|
+
* @type {BusIOProfinetIpConfig}
|
|
3926
3979
|
* @memberof ProfinetDescription
|
|
3927
3980
|
*/
|
|
3928
|
-
'
|
|
3981
|
+
'ip_config'?: BusIOProfinetIpConfig;
|
|
3929
3982
|
}
|
|
3930
3983
|
/**
|
|
3931
3984
|
*
|
|
@@ -3934,7 +3987,7 @@ export interface ProfinetDescription {
|
|
|
3934
3987
|
*/
|
|
3935
3988
|
export interface ProfinetIO {
|
|
3936
3989
|
/**
|
|
3937
|
-
* The name of the input/output
|
|
3990
|
+
* 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).
|
|
3938
3991
|
* @type {string}
|
|
3939
3992
|
* @memberof ProfinetIO
|
|
3940
3993
|
*/
|
|
@@ -3946,25 +3999,25 @@ export interface ProfinetIO {
|
|
|
3946
3999
|
*/
|
|
3947
4000
|
'type': ProfinetIOTypeEnum;
|
|
3948
4001
|
/**
|
|
3949
|
-
* The direction of the input/output
|
|
4002
|
+
* The direction of the input/output variable, indicating whether it is an input or output for the PROFINET device, e.g. NOVA\'s PROFINET service.
|
|
3950
4003
|
* @type {ProfinetIODirection}
|
|
3951
4004
|
* @memberof ProfinetIO
|
|
3952
4005
|
*/
|
|
3953
4006
|
'direction': ProfinetIODirection;
|
|
3954
4007
|
/**
|
|
3955
|
-
* The byte address of the input/output
|
|
4008
|
+
* The byte address of the input/output variable in the PROFINET device, e.g. NOVA\'s PROFINET service. The byte address is used to locate the specific input/output variable within the device\'s memory or data structure.
|
|
3956
4009
|
* @type {number}
|
|
3957
4010
|
* @memberof ProfinetIO
|
|
3958
4011
|
*/
|
|
3959
4012
|
'byte_address': number;
|
|
3960
4013
|
/**
|
|
3961
|
-
* The bit address of the input/output
|
|
4014
|
+
* The bit address of the input/output variable within the byte or word address. The bit address is used to specify the exact bit within the byte or word that corresponds to the input/output variable.
|
|
3962
4015
|
* @type {number}
|
|
3963
4016
|
* @memberof ProfinetIO
|
|
3964
4017
|
*/
|
|
3965
4018
|
'bit_address'?: number;
|
|
3966
4019
|
/**
|
|
3967
|
-
* The unique identifier for the input/output value. This identifier is used to reference the specific input/output in the NOVA
|
|
4020
|
+
* The unique identifier for the input/output value. This identifier is used to reference the specific input/output variable in the PROFINET device, e.g. NOVA\'s PROFINET service.
|
|
3968
4021
|
* @type {string}
|
|
3969
4022
|
* @memberof ProfinetIO
|
|
3970
4023
|
*/
|
|
@@ -3977,7 +4030,7 @@ export interface ProfinetIO {
|
|
|
3977
4030
|
*/
|
|
3978
4031
|
export interface ProfinetIOData {
|
|
3979
4032
|
/**
|
|
3980
|
-
* The name of the input/output
|
|
4033
|
+
* 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).
|
|
3981
4034
|
* @type {string}
|
|
3982
4035
|
* @memberof ProfinetIOData
|
|
3983
4036
|
*/
|
|
@@ -3989,26 +4042,26 @@ export interface ProfinetIOData {
|
|
|
3989
4042
|
*/
|
|
3990
4043
|
'type': ProfinetIOTypeEnum;
|
|
3991
4044
|
/**
|
|
3992
|
-
* The direction of the input/output
|
|
4045
|
+
* The direction of the input/output variable, indicating whether it is an input or output for the PROFINET device, e.g. NOVA\'s PROFINET service.
|
|
3993
4046
|
* @type {ProfinetIODirection}
|
|
3994
4047
|
* @memberof ProfinetIOData
|
|
3995
4048
|
*/
|
|
3996
4049
|
'direction': ProfinetIODirection;
|
|
3997
4050
|
/**
|
|
3998
|
-
* The byte address of the input/output
|
|
4051
|
+
* The byte address of the input/output variable in the PROFINET device, e.g. NOVA\'s PROFINET service. The byte address is used to locate the specific input/output variable within the device\'s memory or data structure.
|
|
3999
4052
|
* @type {number}
|
|
4000
4053
|
* @memberof ProfinetIOData
|
|
4001
4054
|
*/
|
|
4002
4055
|
'byte_address': number;
|
|
4003
4056
|
/**
|
|
4004
|
-
* The bit address of the input/output
|
|
4057
|
+
* The bit address of the input/output variable within the byte or word address. The bit address is used to specify the exact bit within the byte or word that corresponds to the input/output variable.
|
|
4005
4058
|
* @type {number}
|
|
4006
4059
|
* @memberof ProfinetIOData
|
|
4007
4060
|
*/
|
|
4008
4061
|
'bit_address'?: number;
|
|
4009
4062
|
}
|
|
4010
4063
|
/**
|
|
4011
|
-
*
|
|
4064
|
+
* The direction of the input/output variable, indicating whether it is an input or output for the PROFINET device, e.g. NOVA\'s PROFINET service.
|
|
4012
4065
|
* @export
|
|
4013
4066
|
* @enum {string}
|
|
4014
4067
|
*/
|
|
@@ -4019,7 +4072,7 @@ export declare const ProfinetIODirection: {
|
|
|
4019
4072
|
};
|
|
4020
4073
|
export type ProfinetIODirection = typeof ProfinetIODirection[keyof typeof ProfinetIODirection];
|
|
4021
4074
|
/**
|
|
4022
|
-
* Value type of the PROFINET input/output.
|
|
4075
|
+
* Value type of the PROFINET input/output variable. Is used to interpret the corresponding bits correctly.
|
|
4023
4076
|
* @export
|
|
4024
4077
|
* @enum {string}
|
|
4025
4078
|
*/
|
|
@@ -4043,38 +4096,38 @@ export type ProfinetIOTypeEnum = typeof ProfinetIOTypeEnum[keyof typeof Profinet
|
|
|
4043
4096
|
*/
|
|
4044
4097
|
export interface ProfinetInputOutputConfig {
|
|
4045
4098
|
/**
|
|
4046
|
-
* Content of the input
|
|
4099
|
+
* Content of the input/output variable configuration XML file. The XML File has to be embedded as a string by escaping quotes, line breaks and so forth.
|
|
4047
4100
|
* @type {string}
|
|
4048
4101
|
* @memberof ProfinetInputOutputConfig
|
|
4049
4102
|
*/
|
|
4050
4103
|
'config': string;
|
|
4051
4104
|
/**
|
|
4052
|
-
* Offset in bytes for the input
|
|
4105
|
+
* Offset in bytes for the address of the input (perspective of the controller) variables. The offset will be subtracted from to the byte addresses of the sent XML content.
|
|
4053
4106
|
* @type {number}
|
|
4054
4107
|
* @memberof ProfinetInputOutputConfig
|
|
4055
4108
|
*/
|
|
4056
4109
|
'input_offset': number;
|
|
4057
4110
|
/**
|
|
4058
|
-
* Offset in bytes for the output
|
|
4111
|
+
* Offset in bytes for the address of the output (perspective of the controller) variables. The offset will be subtracted from to the byte addresses of the sent XML content.
|
|
4059
4112
|
* @type {number}
|
|
4060
4113
|
* @memberof ProfinetInputOutputConfig
|
|
4061
4114
|
*/
|
|
4062
4115
|
'output_offset': number;
|
|
4063
4116
|
}
|
|
4064
4117
|
/**
|
|
4065
|
-
*
|
|
4118
|
+
* An array of PROFINET slots. PROFINET models each device’s input/output hardware as a hierarchy of slots (modules) and subslots (submodules). A slot can represent a physical or virtual input/output card and each subslot one of its individual channels or functions. Every slot and subslot has unique identifiers that the controller uses to map cyclic input/output data and parameter records to its process image. This slot/subslot separation enables e.g. addressing each input/output stream when establishing input/output application relations (I/O-AR).
|
|
4066
4119
|
* @export
|
|
4067
4120
|
* @interface ProfinetSlotDescription
|
|
4068
4121
|
*/
|
|
4069
4122
|
export interface ProfinetSlotDescription {
|
|
4070
4123
|
/**
|
|
4071
|
-
* The number of the PROFINET slot.
|
|
4124
|
+
* The number/index of the PROFINET slot. Per default, slot 0 is reserved for the device access point (DAP). Slots that are part of the cyclic input/output data exchange start at number 1.
|
|
4072
4125
|
* @type {number}
|
|
4073
4126
|
* @memberof ProfinetSlotDescription
|
|
4074
4127
|
*/
|
|
4075
4128
|
'number': number;
|
|
4076
4129
|
/**
|
|
4077
|
-
* The API number of the PROFINET input
|
|
4130
|
+
* The application process identifier (API) number of the PROFINET input. The API identifies the application relation (AR) that is using the slot.
|
|
4078
4131
|
* @type {number}
|
|
4079
4132
|
* @memberof ProfinetSlotDescription
|
|
4080
4133
|
*/
|
|
@@ -4093,32 +4146,174 @@ export interface ProfinetSlotDescription {
|
|
|
4093
4146
|
*/
|
|
4094
4147
|
export interface ProfinetSubSlotDescription {
|
|
4095
4148
|
/**
|
|
4096
|
-
* The
|
|
4149
|
+
* The number/index of the PROFINET subslot.
|
|
4097
4150
|
* @type {number}
|
|
4098
4151
|
* @memberof ProfinetSubSlotDescription
|
|
4099
4152
|
*/
|
|
4100
4153
|
'number': number;
|
|
4101
4154
|
/**
|
|
4102
|
-
* The
|
|
4155
|
+
* The amount of bytes allocated for the subslot in the input process image buffer.
|
|
4103
4156
|
* @type {number}
|
|
4104
4157
|
* @memberof ProfinetSubSlotDescription
|
|
4105
4158
|
*/
|
|
4106
4159
|
'input_length': number;
|
|
4107
4160
|
/**
|
|
4108
|
-
* The
|
|
4161
|
+
* The amount of bytes allocated for the subslot in the output process image buffer.
|
|
4109
4162
|
* @type {number}
|
|
4110
4163
|
* @memberof ProfinetSubSlotDescription
|
|
4111
4164
|
*/
|
|
4112
4165
|
'output_length': number;
|
|
4113
4166
|
}
|
|
4114
4167
|
/**
|
|
4115
|
-
*
|
|
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
|
+
*
|
|
4116
4311
|
* @export
|
|
4117
4312
|
* @interface RRTConnectAlgorithm
|
|
4118
4313
|
*/
|
|
4119
4314
|
export interface RRTConnectAlgorithm {
|
|
4120
4315
|
/**
|
|
4121
|
-
* 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.
|
|
4122
4317
|
* @type {string}
|
|
4123
4318
|
* @memberof RRTConnectAlgorithm
|
|
4124
4319
|
*/
|
|
@@ -4129,6 +4324,30 @@ export interface RRTConnectAlgorithm {
|
|
|
4129
4324
|
* @memberof RRTConnectAlgorithm
|
|
4130
4325
|
*/
|
|
4131
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;
|
|
4132
4351
|
}
|
|
4133
4352
|
export declare const RRTConnectAlgorithmAlgorithmNameEnum: {
|
|
4134
4353
|
readonly RrtConnectAlgorithm: "RRTConnectAlgorithm";
|
|
@@ -4512,6 +4731,31 @@ export interface ServiceStatusStatus {
|
|
|
4512
4731
|
*/
|
|
4513
4732
|
'reason'?: string;
|
|
4514
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
|
+
}
|
|
4515
4759
|
/**
|
|
4516
4760
|
*
|
|
4517
4761
|
* @export
|
|
@@ -4574,12 +4818,18 @@ export interface StartMovementRequest {
|
|
|
4574
4818
|
* @memberof StartMovementRequest
|
|
4575
4819
|
*/
|
|
4576
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;
|
|
4577
4827
|
/**
|
|
4578
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.
|
|
4579
|
-
* @type {Array<
|
|
4829
|
+
* @type {Array<SetIO>}
|
|
4580
4830
|
* @memberof StartMovementRequest
|
|
4581
4831
|
*/
|
|
4582
|
-
'set_outputs'?: Array<
|
|
4832
|
+
'set_outputs'?: Array<SetIO>;
|
|
4583
4833
|
/**
|
|
4584
4834
|
* Defines an input/output that is listened to before the movement. Execution starts if the defined comparator evaluates to `true`.
|
|
4585
4835
|
* @type {StartOnIO}
|
|
@@ -4638,6 +4888,12 @@ export interface StartOnIO {
|
|
|
4638
4888
|
* @memberof StartOnIO
|
|
4639
4889
|
*/
|
|
4640
4890
|
'comparator': Comparator;
|
|
4891
|
+
/**
|
|
4892
|
+
*
|
|
4893
|
+
* @type {IOOrigin}
|
|
4894
|
+
* @memberof StartOnIO
|
|
4895
|
+
*/
|
|
4896
|
+
'io_origin': IOOrigin;
|
|
4641
4897
|
}
|
|
4642
4898
|
/**
|
|
4643
4899
|
* Array of input/output values.
|
|
@@ -4834,7 +5090,7 @@ export interface TrajectoryDetails {
|
|
|
4834
5090
|
*/
|
|
4835
5091
|
'trajectory': string;
|
|
4836
5092
|
/**
|
|
4837
|
-
*
|
|
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
|
|
4838
5094
|
* @type {number}
|
|
4839
5095
|
* @memberof TrajectoryDetails
|
|
4840
5096
|
*/
|
|
@@ -4899,7 +5155,7 @@ export interface TrajectoryId {
|
|
|
4899
5155
|
* @type {string}
|
|
4900
5156
|
* @memberof TrajectoryId
|
|
4901
5157
|
*/
|
|
4902
|
-
'message_type'
|
|
5158
|
+
'message_type': TrajectoryIdMessageTypeEnum;
|
|
4903
5159
|
/**
|
|
4904
5160
|
* The identifier of the trajectory which was returned by the [addTrajectory](addTrajectory) endpoint.
|
|
4905
5161
|
* @type {string}
|
|
@@ -5072,6 +5328,31 @@ export interface ValidationError {
|
|
|
5072
5328
|
[key: string]: any;
|
|
5073
5329
|
};
|
|
5074
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
|
+
}
|
|
5075
5356
|
/**
|
|
5076
5357
|
* @type ValidationErrorLocInner
|
|
5077
5358
|
* @export
|
|
@@ -5194,11 +5475,13 @@ export declare const VirtualControllerTypes: {
|
|
|
5194
5475
|
readonly KukaKr4R600: "kuka-kr4_r600";
|
|
5195
5476
|
readonly KukaKr500L3403: "kuka-kr500_l340_3";
|
|
5196
5477
|
readonly KukaKr50R2500: "kuka-kr50_r2500";
|
|
5478
|
+
readonly KukaKr60R3: "kuka-kr60_r3";
|
|
5197
5479
|
readonly KukaKr6R1820: "kuka-kr6_r1820";
|
|
5198
5480
|
readonly KukaKr6R7002: "kuka-kr6_r700_2";
|
|
5199
5481
|
readonly KukaKr6R700Sixx: "kuka-kr6_r700_sixx";
|
|
5200
5482
|
readonly KukaKr6R900: "kuka-kr6_r900";
|
|
5201
5483
|
readonly KukaKr6R9002: "kuka-kr6_r900_2";
|
|
5484
|
+
readonly KukaKr70R2100: "kuka-kr70_r2100";
|
|
5202
5485
|
readonly KukaLbrIisy11R1300: "kuka-lbr_iisy_11_r1300";
|
|
5203
5486
|
readonly UniversalrobotsUr10cb: "universalrobots-ur10cb";
|
|
5204
5487
|
readonly UniversalrobotsUr10e: "universalrobots-ur10e";
|
|
@@ -5562,7 +5845,7 @@ export declare class ApplicationApi extends BaseAPI {
|
|
|
5562
5845
|
*/
|
|
5563
5846
|
export declare const BUSInputsOutputsApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
5564
5847
|
/**
|
|
5565
|
-
* Add
|
|
5848
|
+
* Add the BUS inputs/outputs service to the cell. Starts a containerized service that enables BUS connections via the specified ethernet port.
|
|
5566
5849
|
* @summary Add Service
|
|
5567
5850
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5568
5851
|
* @param {BusIOType} busIOType
|
|
@@ -5572,7 +5855,7 @@ export declare const BUSInputsOutputsApiAxiosParamCreator: (configuration?: Conf
|
|
|
5572
5855
|
*/
|
|
5573
5856
|
addBusIOService: (cell: string, busIOType: BusIOType, completionTimeout?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
5574
5857
|
/**
|
|
5575
|
-
* Adds an input/output to or updates an input/output on the PROFINET device.
|
|
5858
|
+
* Adds an input/output variable to or updates an input/output variable on the PROFINET device, e.g. NOVA\'s PROFINET service. The inputs/outputs map variables to specific memory addresses in the process image. The default process image has buffer lengths of 64 bytes for input and output. The size of the buffer is determined by the `config_file_content` that is passed in [addBusIOService](addBusIOService) and has to be in accordance with the GSDML file describing the PROFINET device. The PROFINET controller as well as NOVA\'s PROFINET service use an input/output variable configuration to interpret the bits of the input/output process image. The NOVA\'s PROFINET service\'s configuration can be viewed via [listProfinetIOs](listProfinetIOs). For the PROFINET controller, e.g. a connected PLC, refer to the corresponding third party software, e.g. TIA portal).
|
|
5576
5859
|
* @summary Add PROFINET Input/Output
|
|
5577
5860
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5578
5861
|
* @param {string} io Unique identifier to address an Input/Output in the cell.
|
|
@@ -5582,7 +5865,7 @@ export declare const BUSInputsOutputsApiAxiosParamCreator: (configuration?: Conf
|
|
|
5582
5865
|
*/
|
|
5583
5866
|
addProfinetIO: (cell: string, io: string, profinetIOData: ProfinetIOData, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
5584
5867
|
/**
|
|
5585
|
-
*
|
|
5868
|
+
* Remove the BUS inputs/outputs service from the cell.
|
|
5586
5869
|
* @summary Clear Service
|
|
5587
5870
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5588
5871
|
* @param {number} [completionTimeout]
|
|
@@ -5591,7 +5874,7 @@ export declare const BUSInputsOutputsApiAxiosParamCreator: (configuration?: Conf
|
|
|
5591
5874
|
*/
|
|
5592
5875
|
clearBusIOService: (cell: string, completionTimeout?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
5593
5876
|
/**
|
|
5594
|
-
* Removes
|
|
5877
|
+
* Removes an input/output variable configuration from the PROFINET device, e.g. NOVA\'s PROFINET service.
|
|
5595
5878
|
* @summary Remove PROFINET Input/Ouptut
|
|
5596
5879
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5597
5880
|
* @param {string} io Unique identifier to address an Input/Output in the cell.
|
|
@@ -5600,7 +5883,7 @@ export declare const BUSInputsOutputsApiAxiosParamCreator: (configuration?: Conf
|
|
|
5600
5883
|
*/
|
|
5601
5884
|
deleteProfinetIO: (cell: string, io: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
5602
5885
|
/**
|
|
5603
|
-
* Get deployed BUS
|
|
5886
|
+
* Get deployed BUS inputs/outputs service.
|
|
5604
5887
|
* @summary Get Service
|
|
5605
5888
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5606
5889
|
* @param {*} [options] Override http request option.
|
|
@@ -5625,7 +5908,7 @@ export declare const BUSInputsOutputsApiAxiosParamCreator: (configuration?: Conf
|
|
|
5625
5908
|
*/
|
|
5626
5909
|
getBusIOValues: (cell: string, ios?: Array<string>, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
5627
5910
|
/**
|
|
5628
|
-
* Get description of PROFINET
|
|
5911
|
+
* Get description of NOVA as a PROFINET device.
|
|
5629
5912
|
* @summary Get PROFINET Description
|
|
5630
5913
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5631
5914
|
* @param {*} [options] Override http request option.
|
|
@@ -5633,7 +5916,7 @@ export declare const BUSInputsOutputsApiAxiosParamCreator: (configuration?: Conf
|
|
|
5633
5916
|
*/
|
|
5634
5917
|
getProfinetDescription: (cell: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
5635
5918
|
/**
|
|
5636
|
-
* Get input/output configuration of the PROFINET device as file.
|
|
5919
|
+
* Get input/output variable configuration of the PROFINET device, e.g. NOVA\'s PROFINET service as file. You can specify byte offsets for the input and output variable addresses to get an XML tagmap that is ready to paste to the third party software, e.g. TIA portal.
|
|
5637
5920
|
* @summary PROFINET Inputs/Outputs to File
|
|
5638
5921
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5639
5922
|
* @param {number} [inputOffset]
|
|
@@ -5643,7 +5926,7 @@ export declare const BUSInputsOutputsApiAxiosParamCreator: (configuration?: Conf
|
|
|
5643
5926
|
*/
|
|
5644
5927
|
getProfinetIOsFromFile: (cell: string, inputOffset?: number, outputOffset?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
5645
5928
|
/**
|
|
5646
|
-
* List all BUS
|
|
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.
|
|
5647
5930
|
* @summary List Descriptions
|
|
5648
5931
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5649
5932
|
* @param {*} [options] Override http request option.
|
|
@@ -5651,7 +5934,7 @@ export declare const BUSInputsOutputsApiAxiosParamCreator: (configuration?: Conf
|
|
|
5651
5934
|
*/
|
|
5652
5935
|
listBusIODescriptions: (cell: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
5653
5936
|
/**
|
|
5654
|
-
* List all PROFINET input and
|
|
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.
|
|
5655
5938
|
* @summary List PROFINET Input/Output Configuration
|
|
5656
5939
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5657
5940
|
* @param {*} [options] Override http request option.
|
|
@@ -5668,7 +5951,7 @@ export declare const BUSInputsOutputsApiAxiosParamCreator: (configuration?: Conf
|
|
|
5668
5951
|
*/
|
|
5669
5952
|
setBusIOValues: (cell: string, iOValue: Array<IOValue>, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
5670
5953
|
/**
|
|
5671
|
-
* Sets inputs/outputs
|
|
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.
|
|
5672
5955
|
* @summary Set PROFINET Inputs/Outputs from File
|
|
5673
5956
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5674
5957
|
* @param {ProfinetInputOutputConfig} profinetInputOutputConfig
|
|
@@ -5683,7 +5966,7 @@ export declare const BUSInputsOutputsApiAxiosParamCreator: (configuration?: Conf
|
|
|
5683
5966
|
*/
|
|
5684
5967
|
export declare const BUSInputsOutputsApiFp: (configuration?: Configuration) => {
|
|
5685
5968
|
/**
|
|
5686
|
-
* Add
|
|
5969
|
+
* Add the BUS inputs/outputs service to the cell. Starts a containerized service that enables BUS connections via the specified ethernet port.
|
|
5687
5970
|
* @summary Add Service
|
|
5688
5971
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5689
5972
|
* @param {BusIOType} busIOType
|
|
@@ -5693,7 +5976,7 @@ export declare const BUSInputsOutputsApiFp: (configuration?: Configuration) => {
|
|
|
5693
5976
|
*/
|
|
5694
5977
|
addBusIOService(cell: string, busIOType: BusIOType, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
5695
5978
|
/**
|
|
5696
|
-
* Adds an input/output to or updates an input/output on the PROFINET device.
|
|
5979
|
+
* Adds an input/output variable to or updates an input/output variable on the PROFINET device, e.g. NOVA\'s PROFINET service. The inputs/outputs map variables to specific memory addresses in the process image. The default process image has buffer lengths of 64 bytes for input and output. The size of the buffer is determined by the `config_file_content` that is passed in [addBusIOService](addBusIOService) and has to be in accordance with the GSDML file describing the PROFINET device. The PROFINET controller as well as NOVA\'s PROFINET service use an input/output variable configuration to interpret the bits of the input/output process image. The NOVA\'s PROFINET service\'s configuration can be viewed via [listProfinetIOs](listProfinetIOs). For the PROFINET controller, e.g. a connected PLC, refer to the corresponding third party software, e.g. TIA portal).
|
|
5697
5980
|
* @summary Add PROFINET Input/Output
|
|
5698
5981
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5699
5982
|
* @param {string} io Unique identifier to address an Input/Output in the cell.
|
|
@@ -5703,7 +5986,7 @@ export declare const BUSInputsOutputsApiFp: (configuration?: Configuration) => {
|
|
|
5703
5986
|
*/
|
|
5704
5987
|
addProfinetIO(cell: string, io: string, profinetIOData: ProfinetIOData, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
5705
5988
|
/**
|
|
5706
|
-
*
|
|
5989
|
+
* Remove the BUS inputs/outputs service from the cell.
|
|
5707
5990
|
* @summary Clear Service
|
|
5708
5991
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5709
5992
|
* @param {number} [completionTimeout]
|
|
@@ -5712,7 +5995,7 @@ export declare const BUSInputsOutputsApiFp: (configuration?: Configuration) => {
|
|
|
5712
5995
|
*/
|
|
5713
5996
|
clearBusIOService(cell: string, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
5714
5997
|
/**
|
|
5715
|
-
* Removes
|
|
5998
|
+
* Removes an input/output variable configuration from the PROFINET device, e.g. NOVA\'s PROFINET service.
|
|
5716
5999
|
* @summary Remove PROFINET Input/Ouptut
|
|
5717
6000
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5718
6001
|
* @param {string} io Unique identifier to address an Input/Output in the cell.
|
|
@@ -5721,7 +6004,7 @@ export declare const BUSInputsOutputsApiFp: (configuration?: Configuration) => {
|
|
|
5721
6004
|
*/
|
|
5722
6005
|
deleteProfinetIO(cell: string, io: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
5723
6006
|
/**
|
|
5724
|
-
* Get deployed BUS
|
|
6007
|
+
* Get deployed BUS inputs/outputs service.
|
|
5725
6008
|
* @summary Get Service
|
|
5726
6009
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5727
6010
|
* @param {*} [options] Override http request option.
|
|
@@ -5746,7 +6029,7 @@ export declare const BUSInputsOutputsApiFp: (configuration?: Configuration) => {
|
|
|
5746
6029
|
*/
|
|
5747
6030
|
getBusIOValues(cell: string, ios?: Array<string>, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<IOValue>>>;
|
|
5748
6031
|
/**
|
|
5749
|
-
* Get description of PROFINET
|
|
6032
|
+
* Get description of NOVA as a PROFINET device.
|
|
5750
6033
|
* @summary Get PROFINET Description
|
|
5751
6034
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5752
6035
|
* @param {*} [options] Override http request option.
|
|
@@ -5754,7 +6037,7 @@ export declare const BUSInputsOutputsApiFp: (configuration?: Configuration) => {
|
|
|
5754
6037
|
*/
|
|
5755
6038
|
getProfinetDescription(cell: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ProfinetDescription>>;
|
|
5756
6039
|
/**
|
|
5757
|
-
* Get input/output configuration of the PROFINET device as file.
|
|
6040
|
+
* Get input/output variable configuration of the PROFINET device, e.g. NOVA\'s PROFINET service as file. You can specify byte offsets for the input and output variable addresses to get an XML tagmap that is ready to paste to the third party software, e.g. TIA portal.
|
|
5758
6041
|
* @summary PROFINET Inputs/Outputs to File
|
|
5759
6042
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5760
6043
|
* @param {number} [inputOffset]
|
|
@@ -5764,15 +6047,15 @@ export declare const BUSInputsOutputsApiFp: (configuration?: Configuration) => {
|
|
|
5764
6047
|
*/
|
|
5765
6048
|
getProfinetIOsFromFile(cell: string, inputOffset?: number, outputOffset?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<string>>;
|
|
5766
6049
|
/**
|
|
5767
|
-
* List all BUS
|
|
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.
|
|
5768
6051
|
* @summary List Descriptions
|
|
5769
6052
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5770
6053
|
* @param {*} [options] Override http request option.
|
|
5771
6054
|
* @throws {RequiredError}
|
|
5772
6055
|
*/
|
|
5773
|
-
listBusIODescriptions(cell: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<
|
|
6056
|
+
listBusIODescriptions(cell: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<IODescription2>>>;
|
|
5774
6057
|
/**
|
|
5775
|
-
* List all PROFINET input and
|
|
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.
|
|
5776
6059
|
* @summary List PROFINET Input/Output Configuration
|
|
5777
6060
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5778
6061
|
* @param {*} [options] Override http request option.
|
|
@@ -5789,7 +6072,7 @@ export declare const BUSInputsOutputsApiFp: (configuration?: Configuration) => {
|
|
|
5789
6072
|
*/
|
|
5790
6073
|
setBusIOValues(cell: string, iOValue: Array<IOValue>, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
5791
6074
|
/**
|
|
5792
|
-
* Sets inputs/outputs
|
|
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.
|
|
5793
6076
|
* @summary Set PROFINET Inputs/Outputs from File
|
|
5794
6077
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5795
6078
|
* @param {ProfinetInputOutputConfig} profinetInputOutputConfig
|
|
@@ -5804,7 +6087,7 @@ export declare const BUSInputsOutputsApiFp: (configuration?: Configuration) => {
|
|
|
5804
6087
|
*/
|
|
5805
6088
|
export declare const BUSInputsOutputsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
5806
6089
|
/**
|
|
5807
|
-
* Add
|
|
6090
|
+
* Add the BUS inputs/outputs service to the cell. Starts a containerized service that enables BUS connections via the specified ethernet port.
|
|
5808
6091
|
* @summary Add Service
|
|
5809
6092
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5810
6093
|
* @param {BusIOType} busIOType
|
|
@@ -5814,7 +6097,7 @@ export declare const BUSInputsOutputsApiFactory: (configuration?: Configuration,
|
|
|
5814
6097
|
*/
|
|
5815
6098
|
addBusIOService(cell: string, busIOType: BusIOType, completionTimeout?: number, options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
5816
6099
|
/**
|
|
5817
|
-
* Adds an input/output to or updates an input/output on the PROFINET device.
|
|
6100
|
+
* Adds an input/output variable to or updates an input/output variable on the PROFINET device, e.g. NOVA\'s PROFINET service. The inputs/outputs map variables to specific memory addresses in the process image. The default process image has buffer lengths of 64 bytes for input and output. The size of the buffer is determined by the `config_file_content` that is passed in [addBusIOService](addBusIOService) and has to be in accordance with the GSDML file describing the PROFINET device. The PROFINET controller as well as NOVA\'s PROFINET service use an input/output variable configuration to interpret the bits of the input/output process image. The NOVA\'s PROFINET service\'s configuration can be viewed via [listProfinetIOs](listProfinetIOs). For the PROFINET controller, e.g. a connected PLC, refer to the corresponding third party software, e.g. TIA portal).
|
|
5818
6101
|
* @summary Add PROFINET Input/Output
|
|
5819
6102
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5820
6103
|
* @param {string} io Unique identifier to address an Input/Output in the cell.
|
|
@@ -5824,7 +6107,7 @@ export declare const BUSInputsOutputsApiFactory: (configuration?: Configuration,
|
|
|
5824
6107
|
*/
|
|
5825
6108
|
addProfinetIO(cell: string, io: string, profinetIOData: ProfinetIOData, options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
5826
6109
|
/**
|
|
5827
|
-
*
|
|
6110
|
+
* Remove the BUS inputs/outputs service from the cell.
|
|
5828
6111
|
* @summary Clear Service
|
|
5829
6112
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5830
6113
|
* @param {number} [completionTimeout]
|
|
@@ -5833,7 +6116,7 @@ export declare const BUSInputsOutputsApiFactory: (configuration?: Configuration,
|
|
|
5833
6116
|
*/
|
|
5834
6117
|
clearBusIOService(cell: string, completionTimeout?: number, options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
5835
6118
|
/**
|
|
5836
|
-
* Removes
|
|
6119
|
+
* Removes an input/output variable configuration from the PROFINET device, e.g. NOVA\'s PROFINET service.
|
|
5837
6120
|
* @summary Remove PROFINET Input/Ouptut
|
|
5838
6121
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5839
6122
|
* @param {string} io Unique identifier to address an Input/Output in the cell.
|
|
@@ -5842,7 +6125,7 @@ export declare const BUSInputsOutputsApiFactory: (configuration?: Configuration,
|
|
|
5842
6125
|
*/
|
|
5843
6126
|
deleteProfinetIO(cell: string, io: string, options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
5844
6127
|
/**
|
|
5845
|
-
* Get deployed BUS
|
|
6128
|
+
* Get deployed BUS inputs/outputs service.
|
|
5846
6129
|
* @summary Get Service
|
|
5847
6130
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5848
6131
|
* @param {*} [options] Override http request option.
|
|
@@ -5867,7 +6150,7 @@ export declare const BUSInputsOutputsApiFactory: (configuration?: Configuration,
|
|
|
5867
6150
|
*/
|
|
5868
6151
|
getBusIOValues(cell: string, ios?: Array<string>, options?: RawAxiosRequestConfig): AxiosPromise<Array<IOValue>>;
|
|
5869
6152
|
/**
|
|
5870
|
-
* Get description of PROFINET
|
|
6153
|
+
* Get description of NOVA as a PROFINET device.
|
|
5871
6154
|
* @summary Get PROFINET Description
|
|
5872
6155
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5873
6156
|
* @param {*} [options] Override http request option.
|
|
@@ -5875,7 +6158,7 @@ export declare const BUSInputsOutputsApiFactory: (configuration?: Configuration,
|
|
|
5875
6158
|
*/
|
|
5876
6159
|
getProfinetDescription(cell: string, options?: RawAxiosRequestConfig): AxiosPromise<ProfinetDescription>;
|
|
5877
6160
|
/**
|
|
5878
|
-
* Get input/output configuration of the PROFINET device as file.
|
|
6161
|
+
* Get input/output variable configuration of the PROFINET device, e.g. NOVA\'s PROFINET service as file. You can specify byte offsets for the input and output variable addresses to get an XML tagmap that is ready to paste to the third party software, e.g. TIA portal.
|
|
5879
6162
|
* @summary PROFINET Inputs/Outputs to File
|
|
5880
6163
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5881
6164
|
* @param {number} [inputOffset]
|
|
@@ -5885,15 +6168,15 @@ export declare const BUSInputsOutputsApiFactory: (configuration?: Configuration,
|
|
|
5885
6168
|
*/
|
|
5886
6169
|
getProfinetIOsFromFile(cell: string, inputOffset?: number, outputOffset?: number, options?: RawAxiosRequestConfig): AxiosPromise<string>;
|
|
5887
6170
|
/**
|
|
5888
|
-
* List all BUS
|
|
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.
|
|
5889
6172
|
* @summary List Descriptions
|
|
5890
6173
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5891
6174
|
* @param {*} [options] Override http request option.
|
|
5892
6175
|
* @throws {RequiredError}
|
|
5893
6176
|
*/
|
|
5894
|
-
listBusIODescriptions(cell: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<
|
|
6177
|
+
listBusIODescriptions(cell: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<IODescription2>>;
|
|
5895
6178
|
/**
|
|
5896
|
-
* List all PROFINET input and
|
|
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.
|
|
5897
6180
|
* @summary List PROFINET Input/Output Configuration
|
|
5898
6181
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5899
6182
|
* @param {*} [options] Override http request option.
|
|
@@ -5910,7 +6193,7 @@ export declare const BUSInputsOutputsApiFactory: (configuration?: Configuration,
|
|
|
5910
6193
|
*/
|
|
5911
6194
|
setBusIOValues(cell: string, iOValue: Array<IOValue>, options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
5912
6195
|
/**
|
|
5913
|
-
* Sets inputs/outputs
|
|
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.
|
|
5914
6197
|
* @summary Set PROFINET Inputs/Outputs from File
|
|
5915
6198
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5916
6199
|
* @param {ProfinetInputOutputConfig} profinetInputOutputConfig
|
|
@@ -5927,7 +6210,7 @@ export declare const BUSInputsOutputsApiFactory: (configuration?: Configuration,
|
|
|
5927
6210
|
*/
|
|
5928
6211
|
export declare class BUSInputsOutputsApi extends BaseAPI {
|
|
5929
6212
|
/**
|
|
5930
|
-
* Add
|
|
6213
|
+
* Add the BUS inputs/outputs service to the cell. Starts a containerized service that enables BUS connections via the specified ethernet port.
|
|
5931
6214
|
* @summary Add Service
|
|
5932
6215
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5933
6216
|
* @param {BusIOType} busIOType
|
|
@@ -5938,7 +6221,7 @@ export declare class BUSInputsOutputsApi extends BaseAPI {
|
|
|
5938
6221
|
*/
|
|
5939
6222
|
addBusIOService(cell: string, busIOType: BusIOType, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
5940
6223
|
/**
|
|
5941
|
-
* Adds an input/output to or updates an input/output on the PROFINET device.
|
|
6224
|
+
* Adds an input/output variable to or updates an input/output variable on the PROFINET device, e.g. NOVA\'s PROFINET service. The inputs/outputs map variables to specific memory addresses in the process image. The default process image has buffer lengths of 64 bytes for input and output. The size of the buffer is determined by the `config_file_content` that is passed in [addBusIOService](addBusIOService) and has to be in accordance with the GSDML file describing the PROFINET device. The PROFINET controller as well as NOVA\'s PROFINET service use an input/output variable configuration to interpret the bits of the input/output process image. The NOVA\'s PROFINET service\'s configuration can be viewed via [listProfinetIOs](listProfinetIOs). For the PROFINET controller, e.g. a connected PLC, refer to the corresponding third party software, e.g. TIA portal).
|
|
5942
6225
|
* @summary Add PROFINET Input/Output
|
|
5943
6226
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5944
6227
|
* @param {string} io Unique identifier to address an Input/Output in the cell.
|
|
@@ -5949,7 +6232,7 @@ export declare class BUSInputsOutputsApi extends BaseAPI {
|
|
|
5949
6232
|
*/
|
|
5950
6233
|
addProfinetIO(cell: string, io: string, profinetIOData: ProfinetIOData, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
5951
6234
|
/**
|
|
5952
|
-
*
|
|
6235
|
+
* Remove the BUS inputs/outputs service from the cell.
|
|
5953
6236
|
* @summary Clear Service
|
|
5954
6237
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5955
6238
|
* @param {number} [completionTimeout]
|
|
@@ -5959,7 +6242,7 @@ export declare class BUSInputsOutputsApi extends BaseAPI {
|
|
|
5959
6242
|
*/
|
|
5960
6243
|
clearBusIOService(cell: string, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
5961
6244
|
/**
|
|
5962
|
-
* Removes
|
|
6245
|
+
* Removes an input/output variable configuration from the PROFINET device, e.g. NOVA\'s PROFINET service.
|
|
5963
6246
|
* @summary Remove PROFINET Input/Ouptut
|
|
5964
6247
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5965
6248
|
* @param {string} io Unique identifier to address an Input/Output in the cell.
|
|
@@ -5969,16 +6252,14 @@ export declare class BUSInputsOutputsApi extends BaseAPI {
|
|
|
5969
6252
|
*/
|
|
5970
6253
|
deleteProfinetIO(cell: string, io: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
5971
6254
|
/**
|
|
5972
|
-
* Get deployed BUS
|
|
6255
|
+
* Get deployed BUS inputs/outputs service.
|
|
5973
6256
|
* @summary Get Service
|
|
5974
6257
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5975
6258
|
* @param {*} [options] Override http request option.
|
|
5976
6259
|
* @throws {RequiredError}
|
|
5977
6260
|
* @memberof BUSInputsOutputsApi
|
|
5978
6261
|
*/
|
|
5979
|
-
getBusIOService(cell: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<
|
|
5980
|
-
bus_type: "profinet";
|
|
5981
|
-
} & BusIOProfinet, any>>;
|
|
6262
|
+
getBusIOService(cell: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<BusIOType, any>>;
|
|
5982
6263
|
/**
|
|
5983
6264
|
* Get the current state of the BUS Inputs/Outputs service.
|
|
5984
6265
|
* @summary State
|
|
@@ -5999,7 +6280,7 @@ export declare class BUSInputsOutputsApi extends BaseAPI {
|
|
|
5999
6280
|
*/
|
|
6000
6281
|
getBusIOValues(cell: string, ios?: Array<string>, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<IOValue[], any>>;
|
|
6001
6282
|
/**
|
|
6002
|
-
* Get description of PROFINET
|
|
6283
|
+
* Get description of NOVA as a PROFINET device.
|
|
6003
6284
|
* @summary Get PROFINET Description
|
|
6004
6285
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
6005
6286
|
* @param {*} [options] Override http request option.
|
|
@@ -6008,7 +6289,7 @@ export declare class BUSInputsOutputsApi extends BaseAPI {
|
|
|
6008
6289
|
*/
|
|
6009
6290
|
getProfinetDescription(cell: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ProfinetDescription, any>>;
|
|
6010
6291
|
/**
|
|
6011
|
-
* Get input/output configuration of the PROFINET device as file.
|
|
6292
|
+
* Get input/output variable configuration of the PROFINET device, e.g. NOVA\'s PROFINET service as file. You can specify byte offsets for the input and output variable addresses to get an XML tagmap that is ready to paste to the third party software, e.g. TIA portal.
|
|
6012
6293
|
* @summary PROFINET Inputs/Outputs to File
|
|
6013
6294
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
6014
6295
|
* @param {number} [inputOffset]
|
|
@@ -6019,16 +6300,16 @@ export declare class BUSInputsOutputsApi extends BaseAPI {
|
|
|
6019
6300
|
*/
|
|
6020
6301
|
getProfinetIOsFromFile(cell: string, inputOffset?: number, outputOffset?: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<string, any>>;
|
|
6021
6302
|
/**
|
|
6022
|
-
* List all BUS
|
|
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.
|
|
6023
6304
|
* @summary List Descriptions
|
|
6024
6305
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
6025
6306
|
* @param {*} [options] Override http request option.
|
|
6026
6307
|
* @throws {RequiredError}
|
|
6027
6308
|
* @memberof BUSInputsOutputsApi
|
|
6028
6309
|
*/
|
|
6029
|
-
listBusIODescriptions(cell: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<
|
|
6310
|
+
listBusIODescriptions(cell: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<IODescription2[], any>>;
|
|
6030
6311
|
/**
|
|
6031
|
-
* List all PROFINET input and
|
|
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.
|
|
6032
6313
|
* @summary List PROFINET Input/Output Configuration
|
|
6033
6314
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
6034
6315
|
* @param {*} [options] Override http request option.
|
|
@@ -6047,7 +6328,7 @@ export declare class BUSInputsOutputsApi extends BaseAPI {
|
|
|
6047
6328
|
*/
|
|
6048
6329
|
setBusIOValues(cell: string, iOValue: Array<IOValue>, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
6049
6330
|
/**
|
|
6050
|
-
* Sets inputs/outputs
|
|
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.
|
|
6051
6332
|
* @summary Set PROFINET Inputs/Outputs from File
|
|
6052
6333
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
6053
6334
|
* @param {ProfinetInputOutputConfig} profinetInputOutputConfig
|
|
@@ -7637,7 +7918,7 @@ export declare class MotionGroupApi extends BaseAPI {
|
|
|
7637
7918
|
*/
|
|
7638
7919
|
export declare const MotionGroupModelsApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
7639
7920
|
/**
|
|
7640
|
-
* Returns the default collision link chain for a given motion group model. See [
|
|
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.
|
|
7641
7922
|
* @summary Get Collision Model
|
|
7642
7923
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
7643
7924
|
* @param {string} motionGroupModel Unique identifier for the model of a motion group, e.g. `UniversalRobots_UR10e`. Get the `model` of a configured motion group with [getOptimizerConfiguration](getOptimizerConfiguration).
|
|
@@ -7660,7 +7941,7 @@ export declare const MotionGroupModelsApiAxiosParamCreator: (configuration?: Con
|
|
|
7660
7941
|
*/
|
|
7661
7942
|
export declare const MotionGroupModelsApiFp: (configuration?: Configuration) => {
|
|
7662
7943
|
/**
|
|
7663
|
-
* Returns the default collision link chain for a given motion group model. See [
|
|
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.
|
|
7664
7945
|
* @summary Get Collision Model
|
|
7665
7946
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
7666
7947
|
* @param {string} motionGroupModel Unique identifier for the model of a motion group, e.g. `UniversalRobots_UR10e`. Get the `model` of a configured motion group with [getOptimizerConfiguration](getOptimizerConfiguration).
|
|
@@ -7685,7 +7966,7 @@ export declare const MotionGroupModelsApiFp: (configuration?: Configuration) =>
|
|
|
7685
7966
|
*/
|
|
7686
7967
|
export declare const MotionGroupModelsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
7687
7968
|
/**
|
|
7688
|
-
* Returns the default collision link chain for a given motion group model. See [
|
|
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.
|
|
7689
7970
|
* @summary Get Collision Model
|
|
7690
7971
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
7691
7972
|
* @param {string} motionGroupModel Unique identifier for the model of a motion group, e.g. `UniversalRobots_UR10e`. Get the `model` of a configured motion group with [getOptimizerConfiguration](getOptimizerConfiguration).
|
|
@@ -7712,7 +7993,7 @@ export declare const MotionGroupModelsApiFactory: (configuration?: Configuration
|
|
|
7712
7993
|
*/
|
|
7713
7994
|
export declare class MotionGroupModelsApi extends BaseAPI {
|
|
7714
7995
|
/**
|
|
7715
|
-
* Returns the default collision link chain for a given motion group model. See [
|
|
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.
|
|
7716
7997
|
* @summary Get Collision Model
|
|
7717
7998
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
7718
7999
|
* @param {string} motionGroupModel Unique identifier for the model of a motion group, e.g. `UniversalRobots_UR10e`. Get the `model` of a configured motion group with [getOptimizerConfiguration](getOptimizerConfiguration).
|
|
@@ -7733,6 +8014,180 @@ export declare class MotionGroupModelsApi extends BaseAPI {
|
|
|
7733
8014
|
*/
|
|
7734
8015
|
getMotionGroupModels(cell: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<string[], any>>;
|
|
7735
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
|
+
}
|
|
7736
8191
|
/**
|
|
7737
8192
|
* StoreCollisionComponentsApi - axios parameter creator
|
|
7738
8193
|
* @export
|
|
@@ -7801,7 +8256,7 @@ export declare const StoreCollisionComponentsApiAxiosParamCreator: (configuratio
|
|
|
7801
8256
|
*/
|
|
7802
8257
|
listCollisionLinkChains: (cell: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
7803
8258
|
/**
|
|
7804
|
-
* Returns
|
|
8259
|
+
* Returns all stored colliders.
|
|
7805
8260
|
* @summary List Colliders
|
|
7806
8261
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
7807
8262
|
* @param {*} [options] Override http request option.
|
|
@@ -7927,7 +8382,7 @@ export declare const StoreCollisionComponentsApiFp: (configuration?: Configurati
|
|
|
7927
8382
|
}>;
|
|
7928
8383
|
}>>;
|
|
7929
8384
|
/**
|
|
7930
|
-
* Returns
|
|
8385
|
+
* Returns all stored colliders.
|
|
7931
8386
|
* @summary List Colliders
|
|
7932
8387
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
7933
8388
|
* @param {*} [options] Override http request option.
|
|
@@ -8063,7 +8518,7 @@ export declare const StoreCollisionComponentsApiFactory: (configuration?: Config
|
|
|
8063
8518
|
}>;
|
|
8064
8519
|
}>;
|
|
8065
8520
|
/**
|
|
8066
|
-
* Returns
|
|
8521
|
+
* Returns all stored colliders.
|
|
8067
8522
|
* @summary List Colliders
|
|
8068
8523
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8069
8524
|
* @param {*} [options] Override http request option.
|
|
@@ -8208,7 +8663,7 @@ export declare class StoreCollisionComponentsApi extends BaseAPI {
|
|
|
8208
8663
|
}[];
|
|
8209
8664
|
}, any>>;
|
|
8210
8665
|
/**
|
|
8211
|
-
* Returns
|
|
8666
|
+
* Returns all stored colliders.
|
|
8212
8667
|
* @summary List Colliders
|
|
8213
8668
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8214
8669
|
* @param {*} [options] Override http request option.
|
|
@@ -9428,7 +9883,7 @@ export declare class TrajectoryPlanningApi extends BaseAPI {
|
|
|
9428
9883
|
*/
|
|
9429
9884
|
export declare const VirtualControllerApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
9430
9885
|
/**
|
|
9431
|
-
* 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.
|
|
9432
9887
|
* @summary Add Coordinate Systems
|
|
9433
9888
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
9434
9889
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -9439,7 +9894,7 @@ export declare const VirtualControllerApiAxiosParamCreator: (configuration?: Con
|
|
|
9439
9894
|
*/
|
|
9440
9895
|
addVirtualControllerCoordinateSystem: (cell: string, controller: string, coordinateSystem: string, coordinateSystemData: CoordinateSystemData, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
9441
9896
|
/**
|
|
9442
|
-
* 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 flange
|
|
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.
|
|
9443
9898
|
* @summary Add TCP
|
|
9444
9899
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
9445
9900
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -9451,8 +9906,8 @@ export declare const VirtualControllerApiAxiosParamCreator: (configuration?: Con
|
|
|
9451
9906
|
*/
|
|
9452
9907
|
addVirtualControllerTcp: (cell: string, controller: string, motionGroup: string, tcp: string, robotTcpData: RobotTcpData, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
9453
9908
|
/**
|
|
9454
|
-
* 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
|
|
9455
|
-
* @summary
|
|
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
|
|
9456
9911
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
9457
9912
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
9458
9913
|
* @param {string} coordinateSystem Unique identifier addressing a coordinate system.
|
|
@@ -9462,7 +9917,7 @@ export declare const VirtualControllerApiAxiosParamCreator: (configuration?: Con
|
|
|
9462
9917
|
*/
|
|
9463
9918
|
deleteVirtualControllerCoordinateSystem: (cell: string, controller: string, coordinateSystem: string, deleteDependent?: boolean, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
9464
9919
|
/**
|
|
9465
|
-
* 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.
|
|
9466
9921
|
* @summary Remove TCP
|
|
9467
9922
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
9468
9923
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -9570,7 +10025,7 @@ export declare const VirtualControllerApiAxiosParamCreator: (configuration?: Con
|
|
|
9570
10025
|
*/
|
|
9571
10026
|
setOperationMode: (cell: string, controller: string, mode: OperationMode, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
9572
10027
|
/**
|
|
9573
|
-
* 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
|
|
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.
|
|
9574
10029
|
* @summary Set Mounting
|
|
9575
10030
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
9576
10031
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -9587,7 +10042,7 @@ export declare const VirtualControllerApiAxiosParamCreator: (configuration?: Con
|
|
|
9587
10042
|
*/
|
|
9588
10043
|
export declare const VirtualControllerApiFp: (configuration?: Configuration) => {
|
|
9589
10044
|
/**
|
|
9590
|
-
* 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.
|
|
9591
10046
|
* @summary Add Coordinate Systems
|
|
9592
10047
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
9593
10048
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -9598,7 +10053,7 @@ export declare const VirtualControllerApiFp: (configuration?: Configuration) =>
|
|
|
9598
10053
|
*/
|
|
9599
10054
|
addVirtualControllerCoordinateSystem(cell: string, controller: string, coordinateSystem: string, coordinateSystemData: CoordinateSystemData, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
9600
10055
|
/**
|
|
9601
|
-
* 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 flange
|
|
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.
|
|
9602
10057
|
* @summary Add TCP
|
|
9603
10058
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
9604
10059
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -9610,8 +10065,8 @@ export declare const VirtualControllerApiFp: (configuration?: Configuration) =>
|
|
|
9610
10065
|
*/
|
|
9611
10066
|
addVirtualControllerTcp(cell: string, controller: string, motionGroup: string, tcp: string, robotTcpData: RobotTcpData, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
9612
10067
|
/**
|
|
9613
|
-
* 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
|
|
9614
|
-
* @summary
|
|
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
|
|
9615
10070
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
9616
10071
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
9617
10072
|
* @param {string} coordinateSystem Unique identifier addressing a coordinate system.
|
|
@@ -9621,7 +10076,7 @@ export declare const VirtualControllerApiFp: (configuration?: Configuration) =>
|
|
|
9621
10076
|
*/
|
|
9622
10077
|
deleteVirtualControllerCoordinateSystem(cell: string, controller: string, coordinateSystem: string, deleteDependent?: boolean, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
9623
10078
|
/**
|
|
9624
|
-
* 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.
|
|
9625
10080
|
* @summary Remove TCP
|
|
9626
10081
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
9627
10082
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -9729,7 +10184,7 @@ export declare const VirtualControllerApiFp: (configuration?: Configuration) =>
|
|
|
9729
10184
|
*/
|
|
9730
10185
|
setOperationMode(cell: string, controller: string, mode: OperationMode, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
9731
10186
|
/**
|
|
9732
|
-
* 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
|
|
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.
|
|
9733
10188
|
* @summary Set Mounting
|
|
9734
10189
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
9735
10190
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -9746,7 +10201,7 @@ export declare const VirtualControllerApiFp: (configuration?: Configuration) =>
|
|
|
9746
10201
|
*/
|
|
9747
10202
|
export declare const VirtualControllerApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
9748
10203
|
/**
|
|
9749
|
-
* 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.
|
|
9750
10205
|
* @summary Add Coordinate Systems
|
|
9751
10206
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
9752
10207
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -9757,7 +10212,7 @@ export declare const VirtualControllerApiFactory: (configuration?: Configuration
|
|
|
9757
10212
|
*/
|
|
9758
10213
|
addVirtualControllerCoordinateSystem(cell: string, controller: string, coordinateSystem: string, coordinateSystemData: CoordinateSystemData, options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
9759
10214
|
/**
|
|
9760
|
-
* 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 flange
|
|
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.
|
|
9761
10216
|
* @summary Add TCP
|
|
9762
10217
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
9763
10218
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -9769,8 +10224,8 @@ export declare const VirtualControllerApiFactory: (configuration?: Configuration
|
|
|
9769
10224
|
*/
|
|
9770
10225
|
addVirtualControllerTcp(cell: string, controller: string, motionGroup: string, tcp: string, robotTcpData: RobotTcpData, options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
9771
10226
|
/**
|
|
9772
|
-
* 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
|
|
9773
|
-
* @summary
|
|
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
|
|
9774
10229
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
9775
10230
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
9776
10231
|
* @param {string} coordinateSystem Unique identifier addressing a coordinate system.
|
|
@@ -9780,7 +10235,7 @@ export declare const VirtualControllerApiFactory: (configuration?: Configuration
|
|
|
9780
10235
|
*/
|
|
9781
10236
|
deleteVirtualControllerCoordinateSystem(cell: string, controller: string, coordinateSystem: string, deleteDependent?: boolean, options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
9782
10237
|
/**
|
|
9783
|
-
* 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.
|
|
9784
10239
|
* @summary Remove TCP
|
|
9785
10240
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
9786
10241
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -9888,7 +10343,7 @@ export declare const VirtualControllerApiFactory: (configuration?: Configuration
|
|
|
9888
10343
|
*/
|
|
9889
10344
|
setOperationMode(cell: string, controller: string, mode: OperationMode, options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
9890
10345
|
/**
|
|
9891
|
-
* 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
|
|
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.
|
|
9892
10347
|
* @summary Set Mounting
|
|
9893
10348
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
9894
10349
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -9907,7 +10362,7 @@ export declare const VirtualControllerApiFactory: (configuration?: Configuration
|
|
|
9907
10362
|
*/
|
|
9908
10363
|
export declare class VirtualControllerApi extends BaseAPI {
|
|
9909
10364
|
/**
|
|
9910
|
-
* 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.
|
|
9911
10366
|
* @summary Add Coordinate Systems
|
|
9912
10367
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
9913
10368
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -9919,7 +10374,7 @@ export declare class VirtualControllerApi extends BaseAPI {
|
|
|
9919
10374
|
*/
|
|
9920
10375
|
addVirtualControllerCoordinateSystem(cell: string, controller: string, coordinateSystem: string, coordinateSystemData: CoordinateSystemData, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
9921
10376
|
/**
|
|
9922
|
-
* 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 flange
|
|
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.
|
|
9923
10378
|
* @summary Add TCP
|
|
9924
10379
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
9925
10380
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -9932,8 +10387,8 @@ export declare class VirtualControllerApi extends BaseAPI {
|
|
|
9932
10387
|
*/
|
|
9933
10388
|
addVirtualControllerTcp(cell: string, controller: string, motionGroup: string, tcp: string, robotTcpData: RobotTcpData, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
9934
10389
|
/**
|
|
9935
|
-
* 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
|
|
9936
|
-
* @summary
|
|
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
|
|
9937
10392
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
9938
10393
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
9939
10394
|
* @param {string} coordinateSystem Unique identifier addressing a coordinate system.
|
|
@@ -9944,7 +10399,7 @@ export declare class VirtualControllerApi extends BaseAPI {
|
|
|
9944
10399
|
*/
|
|
9945
10400
|
deleteVirtualControllerCoordinateSystem(cell: string, controller: string, coordinateSystem: string, deleteDependent?: boolean, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
9946
10401
|
/**
|
|
9947
|
-
* 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.
|
|
9948
10403
|
* @summary Remove TCP
|
|
9949
10404
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
9950
10405
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -10063,7 +10518,7 @@ export declare class VirtualControllerApi extends BaseAPI {
|
|
|
10063
10518
|
*/
|
|
10064
10519
|
setOperationMode(cell: string, controller: string, mode: OperationMode, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
10065
10520
|
/**
|
|
10066
|
-
* 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
|
|
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.
|
|
10067
10522
|
* @summary Set Mounting
|
|
10068
10523
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
10069
10524
|
* @param {string} controller Unique identifier to address a controller in the cell.
|