@wandelbots/nova-api 25.8.0-dev.8 → 25.8.0-dev.81
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 +597 -176
- package/v2/api.js +428 -75
- package/v2/api.js.map +1 -1
- package/v2/api.ts +806 -172
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
|
*/
|
|
@@ -1985,24 +2047,12 @@ export interface InitializeJoggingRequest {
|
|
|
1985
2047
|
* @memberof InitializeJoggingRequest
|
|
1986
2048
|
*/
|
|
1987
2049
|
'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
2050
|
/**
|
|
1995
2051
|
* Unique identifier addressing a coordinate system to which the responses are transformed. If not set, world coordinate system is used.
|
|
1996
2052
|
* @type {string}
|
|
1997
2053
|
* @memberof InitializeJoggingRequest
|
|
1998
2054
|
*/
|
|
1999
2055
|
'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
2056
|
}
|
|
2007
2057
|
export declare const InitializeJoggingRequestMessageTypeEnum: {
|
|
2008
2058
|
readonly InitializeJoggingRequest: "InitializeJoggingRequest";
|
|
@@ -2055,12 +2105,6 @@ export interface InitializeMovementRequest {
|
|
|
2055
2105
|
* @memberof InitializeMovementRequest
|
|
2056
2106
|
*/
|
|
2057
2107
|
'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
2108
|
/**
|
|
2065
2109
|
* Unique identifier addressing a coordinate system to which the responses are transformed. If not set, world coordinate system is used.
|
|
2066
2110
|
* @type {string}
|
|
@@ -2112,7 +2156,7 @@ export declare const InitializeMovementResponseKindEnum: {
|
|
|
2112
2156
|
};
|
|
2113
2157
|
export type InitializeMovementResponseKindEnum = typeof InitializeMovementResponseKindEnum[keyof typeof InitializeMovementResponseKindEnum];
|
|
2114
2158
|
/**
|
|
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. >
|
|
2159
|
+
* 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
2160
|
* @export
|
|
2117
2161
|
* @interface IntegerValue
|
|
2118
2162
|
*/
|
|
@@ -2484,7 +2528,7 @@ export interface JointTrajectory {
|
|
|
2484
2528
|
*/
|
|
2485
2529
|
'times': Array<number>;
|
|
2486
2530
|
/**
|
|
2487
|
-
*
|
|
2531
|
+
*
|
|
2488
2532
|
* @type {Array<number>}
|
|
2489
2533
|
* @memberof JointTrajectory
|
|
2490
2534
|
*/
|
|
@@ -2566,6 +2610,12 @@ export interface KukaController {
|
|
|
2566
2610
|
* @memberof KukaController
|
|
2567
2611
|
*/
|
|
2568
2612
|
'rsi_server': KukaControllerRsiServer;
|
|
2613
|
+
/**
|
|
2614
|
+
* If true, uses slower cycle time of 12ms instead of 4ms.
|
|
2615
|
+
* @type {boolean}
|
|
2616
|
+
* @memberof KukaController
|
|
2617
|
+
*/
|
|
2618
|
+
'slow_cycle_rate'?: boolean;
|
|
2569
2619
|
}
|
|
2570
2620
|
export declare const KukaControllerKindEnum: {
|
|
2571
2621
|
readonly KukaController: "KukaController";
|
|
@@ -2691,25 +2741,6 @@ export declare const LicenseStatusEnum: {
|
|
|
2691
2741
|
readonly NotFound: "NOT_FOUND";
|
|
2692
2742
|
};
|
|
2693
2743
|
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
2744
|
/**
|
|
2714
2745
|
* The upper_limit must be greater then the lower_limit.
|
|
2715
2746
|
* @export
|
|
@@ -2759,6 +2790,12 @@ export interface LimitSet {
|
|
|
2759
2790
|
* @memberof LimitSet
|
|
2760
2791
|
*/
|
|
2761
2792
|
'flange'?: CartesianLimits;
|
|
2793
|
+
/**
|
|
2794
|
+
*
|
|
2795
|
+
* @type {JointLimits}
|
|
2796
|
+
* @memberof LimitSet
|
|
2797
|
+
*/
|
|
2798
|
+
'coupled_shoulder_elbow_joint'?: JointLimits;
|
|
2762
2799
|
}
|
|
2763
2800
|
/**
|
|
2764
2801
|
* If a limit is not set, the default value will be used.
|
|
@@ -2830,13 +2867,13 @@ export declare const Manufacturer: {
|
|
|
2830
2867
|
};
|
|
2831
2868
|
export type Manufacturer = typeof Manufacturer[keyof typeof Manufacturer];
|
|
2832
2869
|
/**
|
|
2833
|
-
*
|
|
2870
|
+
*
|
|
2834
2871
|
* @export
|
|
2835
2872
|
* @interface MidpointInsertionAlgorithm
|
|
2836
2873
|
*/
|
|
2837
2874
|
export interface MidpointInsertionAlgorithm {
|
|
2838
2875
|
/**
|
|
2839
|
-
* Algorithm discriminator.
|
|
2876
|
+
* 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
2877
|
* @type {string}
|
|
2841
2878
|
* @memberof MidpointInsertionAlgorithm
|
|
2842
2879
|
*/
|
|
@@ -2924,13 +2961,13 @@ export interface MotionGroupDescription {
|
|
|
2924
2961
|
* @type {Pose}
|
|
2925
2962
|
* @memberof MotionGroupDescription
|
|
2926
2963
|
*/
|
|
2927
|
-
'mounting'
|
|
2964
|
+
'mounting'?: Pose;
|
|
2928
2965
|
/**
|
|
2929
2966
|
* Maps a TCP name to its offset relative to the flange coordinate system. Key must be a TCP identifier. Values are TcpOffsets.
|
|
2930
2967
|
* @type {{ [key: string]: TcpOffset; }}
|
|
2931
2968
|
* @memberof MotionGroupDescription
|
|
2932
2969
|
*/
|
|
2933
|
-
'tcps'
|
|
2970
|
+
'tcps'?: {
|
|
2934
2971
|
[key: string]: TcpOffset;
|
|
2935
2972
|
};
|
|
2936
2973
|
/**
|
|
@@ -2961,10 +2998,10 @@ export interface MotionGroupDescription {
|
|
|
2961
2998
|
};
|
|
2962
2999
|
/**
|
|
2963
3000
|
*
|
|
2964
|
-
* @type {
|
|
3001
|
+
* @type {OperationLimits}
|
|
2965
3002
|
* @memberof MotionGroupDescription
|
|
2966
3003
|
*/
|
|
2967
|
-
'
|
|
3004
|
+
'operation_limits': OperationLimits;
|
|
2968
3005
|
/**
|
|
2969
3006
|
* Maps a payload name to its configuration. Key must be a payload identifier. Values are payload objects.
|
|
2970
3007
|
* @type {{ [key: string]: Payload; }}
|
|
@@ -3697,11 +3734,11 @@ export interface PlanTrajectoryFailedResponse {
|
|
|
3697
3734
|
*/
|
|
3698
3735
|
'error_feedback': PlanTrajectoryFailedResponseErrorFeedback;
|
|
3699
3736
|
/**
|
|
3700
|
-
*
|
|
3737
|
+
* 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
3738
|
* @type {number}
|
|
3702
3739
|
* @memberof PlanTrajectoryFailedResponse
|
|
3703
3740
|
*/
|
|
3704
|
-
'error_location_on_trajectory'
|
|
3741
|
+
'error_location_on_trajectory': number;
|
|
3705
3742
|
/**
|
|
3706
3743
|
* The joint trajectory from the start joint position to the error.
|
|
3707
3744
|
* @type {JointTrajectory}
|
|
@@ -3915,17 +3952,17 @@ export interface ProfinetDescription {
|
|
|
3915
3952
|
*/
|
|
3916
3953
|
'slots'?: Array<ProfinetSlotDescription>;
|
|
3917
3954
|
/**
|
|
3918
|
-
* Name of the PROFINET device
|
|
3955
|
+
* 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
3956
|
* @type {string}
|
|
3920
3957
|
* @memberof ProfinetDescription
|
|
3921
3958
|
*/
|
|
3922
3959
|
'device_name'?: string;
|
|
3923
3960
|
/**
|
|
3924
|
-
*
|
|
3925
|
-
* @type {
|
|
3961
|
+
*
|
|
3962
|
+
* @type {BusIOProfinetIpConfig}
|
|
3926
3963
|
* @memberof ProfinetDescription
|
|
3927
3964
|
*/
|
|
3928
|
-
'
|
|
3965
|
+
'ip_config'?: BusIOProfinetIpConfig;
|
|
3929
3966
|
}
|
|
3930
3967
|
/**
|
|
3931
3968
|
*
|
|
@@ -3934,7 +3971,7 @@ export interface ProfinetDescription {
|
|
|
3934
3971
|
*/
|
|
3935
3972
|
export interface ProfinetIO {
|
|
3936
3973
|
/**
|
|
3937
|
-
* The name of the input/output
|
|
3974
|
+
* 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
3975
|
* @type {string}
|
|
3939
3976
|
* @memberof ProfinetIO
|
|
3940
3977
|
*/
|
|
@@ -3946,25 +3983,25 @@ export interface ProfinetIO {
|
|
|
3946
3983
|
*/
|
|
3947
3984
|
'type': ProfinetIOTypeEnum;
|
|
3948
3985
|
/**
|
|
3949
|
-
* The direction of the input/output
|
|
3986
|
+
* 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
3987
|
* @type {ProfinetIODirection}
|
|
3951
3988
|
* @memberof ProfinetIO
|
|
3952
3989
|
*/
|
|
3953
3990
|
'direction': ProfinetIODirection;
|
|
3954
3991
|
/**
|
|
3955
|
-
* The byte address of the input/output
|
|
3992
|
+
* 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
3993
|
* @type {number}
|
|
3957
3994
|
* @memberof ProfinetIO
|
|
3958
3995
|
*/
|
|
3959
3996
|
'byte_address': number;
|
|
3960
3997
|
/**
|
|
3961
|
-
* The bit address of the input/output
|
|
3998
|
+
* 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
3999
|
* @type {number}
|
|
3963
4000
|
* @memberof ProfinetIO
|
|
3964
4001
|
*/
|
|
3965
4002
|
'bit_address'?: number;
|
|
3966
4003
|
/**
|
|
3967
|
-
* The unique identifier for the input/output value. This identifier is used to reference the specific input/output in the NOVA
|
|
4004
|
+
* 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
4005
|
* @type {string}
|
|
3969
4006
|
* @memberof ProfinetIO
|
|
3970
4007
|
*/
|
|
@@ -3977,7 +4014,7 @@ export interface ProfinetIO {
|
|
|
3977
4014
|
*/
|
|
3978
4015
|
export interface ProfinetIOData {
|
|
3979
4016
|
/**
|
|
3980
|
-
* The name of the input/output
|
|
4017
|
+
* 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
4018
|
* @type {string}
|
|
3982
4019
|
* @memberof ProfinetIOData
|
|
3983
4020
|
*/
|
|
@@ -3989,26 +4026,26 @@ export interface ProfinetIOData {
|
|
|
3989
4026
|
*/
|
|
3990
4027
|
'type': ProfinetIOTypeEnum;
|
|
3991
4028
|
/**
|
|
3992
|
-
* The direction of the input/output
|
|
4029
|
+
* 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
4030
|
* @type {ProfinetIODirection}
|
|
3994
4031
|
* @memberof ProfinetIOData
|
|
3995
4032
|
*/
|
|
3996
4033
|
'direction': ProfinetIODirection;
|
|
3997
4034
|
/**
|
|
3998
|
-
* The byte address of the input/output
|
|
4035
|
+
* 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
4036
|
* @type {number}
|
|
4000
4037
|
* @memberof ProfinetIOData
|
|
4001
4038
|
*/
|
|
4002
4039
|
'byte_address': number;
|
|
4003
4040
|
/**
|
|
4004
|
-
* The bit address of the input/output
|
|
4041
|
+
* 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
4042
|
* @type {number}
|
|
4006
4043
|
* @memberof ProfinetIOData
|
|
4007
4044
|
*/
|
|
4008
4045
|
'bit_address'?: number;
|
|
4009
4046
|
}
|
|
4010
4047
|
/**
|
|
4011
|
-
*
|
|
4048
|
+
* 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
4049
|
* @export
|
|
4013
4050
|
* @enum {string}
|
|
4014
4051
|
*/
|
|
@@ -4019,7 +4056,7 @@ export declare const ProfinetIODirection: {
|
|
|
4019
4056
|
};
|
|
4020
4057
|
export type ProfinetIODirection = typeof ProfinetIODirection[keyof typeof ProfinetIODirection];
|
|
4021
4058
|
/**
|
|
4022
|
-
* Value type of the PROFINET input/output.
|
|
4059
|
+
* Value type of the PROFINET input/output variable. Is used to interpret the corresponding bits correctly.
|
|
4023
4060
|
* @export
|
|
4024
4061
|
* @enum {string}
|
|
4025
4062
|
*/
|
|
@@ -4043,38 +4080,38 @@ export type ProfinetIOTypeEnum = typeof ProfinetIOTypeEnum[keyof typeof Profinet
|
|
|
4043
4080
|
*/
|
|
4044
4081
|
export interface ProfinetInputOutputConfig {
|
|
4045
4082
|
/**
|
|
4046
|
-
* Content of the input
|
|
4083
|
+
* 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
4084
|
* @type {string}
|
|
4048
4085
|
* @memberof ProfinetInputOutputConfig
|
|
4049
4086
|
*/
|
|
4050
4087
|
'config': string;
|
|
4051
4088
|
/**
|
|
4052
|
-
* Offset in bytes for the input
|
|
4089
|
+
* 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
4090
|
* @type {number}
|
|
4054
4091
|
* @memberof ProfinetInputOutputConfig
|
|
4055
4092
|
*/
|
|
4056
4093
|
'input_offset': number;
|
|
4057
4094
|
/**
|
|
4058
|
-
* Offset in bytes for the output
|
|
4095
|
+
* 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
4096
|
* @type {number}
|
|
4060
4097
|
* @memberof ProfinetInputOutputConfig
|
|
4061
4098
|
*/
|
|
4062
4099
|
'output_offset': number;
|
|
4063
4100
|
}
|
|
4064
4101
|
/**
|
|
4065
|
-
*
|
|
4102
|
+
* 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
4103
|
* @export
|
|
4067
4104
|
* @interface ProfinetSlotDescription
|
|
4068
4105
|
*/
|
|
4069
4106
|
export interface ProfinetSlotDescription {
|
|
4070
4107
|
/**
|
|
4071
|
-
* The number of the PROFINET slot.
|
|
4108
|
+
* 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
4109
|
* @type {number}
|
|
4073
4110
|
* @memberof ProfinetSlotDescription
|
|
4074
4111
|
*/
|
|
4075
4112
|
'number': number;
|
|
4076
4113
|
/**
|
|
4077
|
-
* The API number of the PROFINET input
|
|
4114
|
+
* The application process identifier (API) number of the PROFINET input. The API identifies the application relation (AR) that is using the slot.
|
|
4078
4115
|
* @type {number}
|
|
4079
4116
|
* @memberof ProfinetSlotDescription
|
|
4080
4117
|
*/
|
|
@@ -4093,32 +4130,174 @@ export interface ProfinetSlotDescription {
|
|
|
4093
4130
|
*/
|
|
4094
4131
|
export interface ProfinetSubSlotDescription {
|
|
4095
4132
|
/**
|
|
4096
|
-
* The
|
|
4133
|
+
* The number/index of the PROFINET subslot.
|
|
4097
4134
|
* @type {number}
|
|
4098
4135
|
* @memberof ProfinetSubSlotDescription
|
|
4099
4136
|
*/
|
|
4100
4137
|
'number': number;
|
|
4101
4138
|
/**
|
|
4102
|
-
* The
|
|
4139
|
+
* The amount of bytes allocated for the subslot in the input process image buffer.
|
|
4103
4140
|
* @type {number}
|
|
4104
4141
|
* @memberof ProfinetSubSlotDescription
|
|
4105
4142
|
*/
|
|
4106
4143
|
'input_length': number;
|
|
4107
4144
|
/**
|
|
4108
|
-
* The
|
|
4145
|
+
* The amount of bytes allocated for the subslot in the output process image buffer.
|
|
4109
4146
|
* @type {number}
|
|
4110
4147
|
* @memberof ProfinetSubSlotDescription
|
|
4111
4148
|
*/
|
|
4112
4149
|
'output_length': number;
|
|
4113
4150
|
}
|
|
4114
4151
|
/**
|
|
4115
|
-
*
|
|
4152
|
+
* A program is a collection of instructions that are executed in the robot cell.
|
|
4153
|
+
* @export
|
|
4154
|
+
* @interface Program
|
|
4155
|
+
*/
|
|
4156
|
+
export interface Program {
|
|
4157
|
+
/**
|
|
4158
|
+
*
|
|
4159
|
+
* @type {string}
|
|
4160
|
+
* @memberof Program
|
|
4161
|
+
*/
|
|
4162
|
+
'program': string;
|
|
4163
|
+
/**
|
|
4164
|
+
*
|
|
4165
|
+
* @type {string}
|
|
4166
|
+
* @memberof Program
|
|
4167
|
+
*/
|
|
4168
|
+
'name'?: string;
|
|
4169
|
+
/**
|
|
4170
|
+
*
|
|
4171
|
+
* @type {string}
|
|
4172
|
+
* @memberof Program
|
|
4173
|
+
*/
|
|
4174
|
+
'description'?: string;
|
|
4175
|
+
/**
|
|
4176
|
+
*
|
|
4177
|
+
* @type {string}
|
|
4178
|
+
* @memberof Program
|
|
4179
|
+
*/
|
|
4180
|
+
'app': string;
|
|
4181
|
+
/**
|
|
4182
|
+
*
|
|
4183
|
+
* @type {object}
|
|
4184
|
+
* @memberof Program
|
|
4185
|
+
*/
|
|
4186
|
+
'input_schema'?: object;
|
|
4187
|
+
/**
|
|
4188
|
+
*
|
|
4189
|
+
* @type {object}
|
|
4190
|
+
* @memberof Program
|
|
4191
|
+
*/
|
|
4192
|
+
'preconditions'?: object;
|
|
4193
|
+
}
|
|
4194
|
+
/**
|
|
4195
|
+
* Holds the state of a program run.
|
|
4196
|
+
* @export
|
|
4197
|
+
* @interface ProgramRun
|
|
4198
|
+
*/
|
|
4199
|
+
export interface ProgramRun {
|
|
4200
|
+
/**
|
|
4201
|
+
* Unique identifier of the program run
|
|
4202
|
+
* @type {string}
|
|
4203
|
+
* @memberof ProgramRun
|
|
4204
|
+
*/
|
|
4205
|
+
'run': string;
|
|
4206
|
+
/**
|
|
4207
|
+
* Unique identifier of the program
|
|
4208
|
+
* @type {string}
|
|
4209
|
+
* @memberof ProgramRun
|
|
4210
|
+
*/
|
|
4211
|
+
'program': string;
|
|
4212
|
+
/**
|
|
4213
|
+
* State of the program run
|
|
4214
|
+
* @type {ProgramRunState}
|
|
4215
|
+
* @memberof ProgramRun
|
|
4216
|
+
*/
|
|
4217
|
+
'state': ProgramRunState;
|
|
4218
|
+
/**
|
|
4219
|
+
* Logs of the program run
|
|
4220
|
+
* @type {string}
|
|
4221
|
+
* @memberof ProgramRun
|
|
4222
|
+
*/
|
|
4223
|
+
'logs'?: string;
|
|
4224
|
+
/**
|
|
4225
|
+
* Stdout of the program run
|
|
4226
|
+
* @type {string}
|
|
4227
|
+
* @memberof ProgramRun
|
|
4228
|
+
*/
|
|
4229
|
+
'stdout'?: string;
|
|
4230
|
+
/**
|
|
4231
|
+
* Stderr of the program run
|
|
4232
|
+
* @type {string}
|
|
4233
|
+
* @memberof ProgramRun
|
|
4234
|
+
*/
|
|
4235
|
+
'stderr'?: string;
|
|
4236
|
+
/**
|
|
4237
|
+
* Error message of the program run, if any
|
|
4238
|
+
* @type {string}
|
|
4239
|
+
* @memberof ProgramRun
|
|
4240
|
+
*/
|
|
4241
|
+
'error'?: string;
|
|
4242
|
+
/**
|
|
4243
|
+
* Traceback of the program run, if any
|
|
4244
|
+
* @type {string}
|
|
4245
|
+
* @memberof ProgramRun
|
|
4246
|
+
*/
|
|
4247
|
+
'traceback'?: string;
|
|
4248
|
+
/**
|
|
4249
|
+
* Start time of the program run
|
|
4250
|
+
* @type {string}
|
|
4251
|
+
* @memberof ProgramRun
|
|
4252
|
+
*/
|
|
4253
|
+
'start_time'?: string;
|
|
4254
|
+
/**
|
|
4255
|
+
* End time of the program run
|
|
4256
|
+
* @type {string}
|
|
4257
|
+
* @memberof ProgramRun
|
|
4258
|
+
*/
|
|
4259
|
+
'end_time'?: string;
|
|
4260
|
+
/**
|
|
4261
|
+
* Input data of the program run
|
|
4262
|
+
* @type {object}
|
|
4263
|
+
* @memberof ProgramRun
|
|
4264
|
+
*/
|
|
4265
|
+
'input_data'?: object;
|
|
4266
|
+
}
|
|
4267
|
+
/**
|
|
4268
|
+
* The state of a program run.
|
|
4269
|
+
* @export
|
|
4270
|
+
* @enum {string}
|
|
4271
|
+
*/
|
|
4272
|
+
export declare const ProgramRunState: {
|
|
4273
|
+
readonly Preparing: "PREPARING";
|
|
4274
|
+
readonly Running: "RUNNING";
|
|
4275
|
+
readonly Completed: "COMPLETED";
|
|
4276
|
+
readonly Failed: "FAILED";
|
|
4277
|
+
readonly Stopped: "STOPPED";
|
|
4278
|
+
};
|
|
4279
|
+
export type ProgramRunState = typeof ProgramRunState[keyof typeof ProgramRunState];
|
|
4280
|
+
/**
|
|
4281
|
+
* The state of a program run.
|
|
4282
|
+
* @export
|
|
4283
|
+
* @interface ProgramStartRequest
|
|
4284
|
+
*/
|
|
4285
|
+
export interface ProgramStartRequest {
|
|
4286
|
+
/**
|
|
4287
|
+
* The arguments to pass to the program.
|
|
4288
|
+
* @type {object}
|
|
4289
|
+
* @memberof ProgramStartRequest
|
|
4290
|
+
*/
|
|
4291
|
+
'arguments': object;
|
|
4292
|
+
}
|
|
4293
|
+
/**
|
|
4294
|
+
*
|
|
4116
4295
|
* @export
|
|
4117
4296
|
* @interface RRTConnectAlgorithm
|
|
4118
4297
|
*/
|
|
4119
4298
|
export interface RRTConnectAlgorithm {
|
|
4120
4299
|
/**
|
|
4121
|
-
* Algorithm discriminator.
|
|
4300
|
+
* 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
4301
|
* @type {string}
|
|
4123
4302
|
* @memberof RRTConnectAlgorithm
|
|
4124
4303
|
*/
|
|
@@ -4129,6 +4308,30 @@ export interface RRTConnectAlgorithm {
|
|
|
4129
4308
|
* @memberof RRTConnectAlgorithm
|
|
4130
4309
|
*/
|
|
4131
4310
|
'max_iterations'?: number;
|
|
4311
|
+
/**
|
|
4312
|
+
* Maximum step size for tree extension in joint space.
|
|
4313
|
+
* @type {number}
|
|
4314
|
+
* @memberof RRTConnectAlgorithm
|
|
4315
|
+
*/
|
|
4316
|
+
'max_step_size'?: number;
|
|
4317
|
+
/**
|
|
4318
|
+
* Adjust the maximum step size during the search based on the recent success rate of tree expansion.
|
|
4319
|
+
* @type {boolean}
|
|
4320
|
+
* @memberof RRTConnectAlgorithm
|
|
4321
|
+
*/
|
|
4322
|
+
'adaptive_step_size'?: boolean;
|
|
4323
|
+
/**
|
|
4324
|
+
* Apply smoothing after the search has succeeded. This will remove as many intermediate points as possible while keeping the path valid.
|
|
4325
|
+
* @type {boolean}
|
|
4326
|
+
* @memberof RRTConnectAlgorithm
|
|
4327
|
+
*/
|
|
4328
|
+
'apply_smoothing'?: boolean;
|
|
4329
|
+
/**
|
|
4330
|
+
* Apply blending after the search has succeeded and smoothing has been applied. This will apply the largest viable blending at each intermediate point.
|
|
4331
|
+
* @type {boolean}
|
|
4332
|
+
* @memberof RRTConnectAlgorithm
|
|
4333
|
+
*/
|
|
4334
|
+
'apply_blending'?: boolean;
|
|
4132
4335
|
}
|
|
4133
4336
|
export declare const RRTConnectAlgorithmAlgorithmNameEnum: {
|
|
4134
4337
|
readonly RrtConnectAlgorithm: "RRTConnectAlgorithm";
|
|
@@ -4512,6 +4715,25 @@ export interface ServiceStatusStatus {
|
|
|
4512
4715
|
*/
|
|
4513
4716
|
'reason'?: string;
|
|
4514
4717
|
}
|
|
4718
|
+
/**
|
|
4719
|
+
* Defines an input/output that should be set upon reaching a specified location on the trajectory.
|
|
4720
|
+
* @export
|
|
4721
|
+
* @interface SetIO
|
|
4722
|
+
*/
|
|
4723
|
+
export interface SetIO {
|
|
4724
|
+
/**
|
|
4725
|
+
*
|
|
4726
|
+
* @type {IOValue}
|
|
4727
|
+
* @memberof SetIO
|
|
4728
|
+
*/
|
|
4729
|
+
'io': IOValue;
|
|
4730
|
+
/**
|
|
4731
|
+
* The location on the trajectory where the input/output should be set.
|
|
4732
|
+
* @type {number}
|
|
4733
|
+
* @memberof SetIO
|
|
4734
|
+
*/
|
|
4735
|
+
'location': number;
|
|
4736
|
+
}
|
|
4515
4737
|
/**
|
|
4516
4738
|
*
|
|
4517
4739
|
* @export
|
|
@@ -4576,10 +4798,10 @@ export interface StartMovementRequest {
|
|
|
4576
4798
|
'direction'?: Direction;
|
|
4577
4799
|
/**
|
|
4578
4800
|
* 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<
|
|
4801
|
+
* @type {Array<SetIO>}
|
|
4580
4802
|
* @memberof StartMovementRequest
|
|
4581
4803
|
*/
|
|
4582
|
-
'set_outputs'?: Array<
|
|
4804
|
+
'set_outputs'?: Array<SetIO>;
|
|
4583
4805
|
/**
|
|
4584
4806
|
* Defines an input/output that is listened to before the movement. Execution starts if the defined comparator evaluates to `true`.
|
|
4585
4807
|
* @type {StartOnIO}
|
|
@@ -4834,7 +5056,7 @@ export interface TrajectoryDetails {
|
|
|
4834
5056
|
*/
|
|
4835
5057
|
'trajectory': string;
|
|
4836
5058
|
/**
|
|
4837
|
-
*
|
|
5059
|
+
* 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
5060
|
* @type {number}
|
|
4839
5061
|
* @memberof TrajectoryDetails
|
|
4840
5062
|
*/
|
|
@@ -4899,7 +5121,7 @@ export interface TrajectoryId {
|
|
|
4899
5121
|
* @type {string}
|
|
4900
5122
|
* @memberof TrajectoryId
|
|
4901
5123
|
*/
|
|
4902
|
-
'message_type'
|
|
5124
|
+
'message_type': TrajectoryIdMessageTypeEnum;
|
|
4903
5125
|
/**
|
|
4904
5126
|
* The identifier of the trajectory which was returned by the [addTrajectory](addTrajectory) endpoint.
|
|
4905
5127
|
* @type {string}
|
|
@@ -5072,6 +5294,31 @@ export interface ValidationError {
|
|
|
5072
5294
|
[key: string]: any;
|
|
5073
5295
|
};
|
|
5074
5296
|
}
|
|
5297
|
+
/**
|
|
5298
|
+
* A validation error of a program.
|
|
5299
|
+
* @export
|
|
5300
|
+
* @interface ValidationError2
|
|
5301
|
+
*/
|
|
5302
|
+
export interface ValidationError2 {
|
|
5303
|
+
/**
|
|
5304
|
+
*
|
|
5305
|
+
* @type {Array<number>}
|
|
5306
|
+
* @memberof ValidationError2
|
|
5307
|
+
*/
|
|
5308
|
+
'loc': Array<number>;
|
|
5309
|
+
/**
|
|
5310
|
+
*
|
|
5311
|
+
* @type {string}
|
|
5312
|
+
* @memberof ValidationError2
|
|
5313
|
+
*/
|
|
5314
|
+
'msg': string;
|
|
5315
|
+
/**
|
|
5316
|
+
*
|
|
5317
|
+
* @type {string}
|
|
5318
|
+
* @memberof ValidationError2
|
|
5319
|
+
*/
|
|
5320
|
+
'type': string;
|
|
5321
|
+
}
|
|
5075
5322
|
/**
|
|
5076
5323
|
* @type ValidationErrorLocInner
|
|
5077
5324
|
* @export
|
|
@@ -5194,11 +5441,13 @@ export declare const VirtualControllerTypes: {
|
|
|
5194
5441
|
readonly KukaKr4R600: "kuka-kr4_r600";
|
|
5195
5442
|
readonly KukaKr500L3403: "kuka-kr500_l340_3";
|
|
5196
5443
|
readonly KukaKr50R2500: "kuka-kr50_r2500";
|
|
5444
|
+
readonly KukaKr60R3: "kuka-kr60_r3";
|
|
5197
5445
|
readonly KukaKr6R1820: "kuka-kr6_r1820";
|
|
5198
5446
|
readonly KukaKr6R7002: "kuka-kr6_r700_2";
|
|
5199
5447
|
readonly KukaKr6R700Sixx: "kuka-kr6_r700_sixx";
|
|
5200
5448
|
readonly KukaKr6R900: "kuka-kr6_r900";
|
|
5201
5449
|
readonly KukaKr6R9002: "kuka-kr6_r900_2";
|
|
5450
|
+
readonly KukaKr70R2100: "kuka-kr70_r2100";
|
|
5202
5451
|
readonly KukaLbrIisy11R1300: "kuka-lbr_iisy_11_r1300";
|
|
5203
5452
|
readonly UniversalrobotsUr10cb: "universalrobots-ur10cb";
|
|
5204
5453
|
readonly UniversalrobotsUr10e: "universalrobots-ur10e";
|
|
@@ -5562,7 +5811,7 @@ export declare class ApplicationApi extends BaseAPI {
|
|
|
5562
5811
|
*/
|
|
5563
5812
|
export declare const BUSInputsOutputsApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
5564
5813
|
/**
|
|
5565
|
-
* Add
|
|
5814
|
+
* Add the BUS inputs/outputs service to the cell. Starts a containerized service that enables BUS connections via the specified ethernet port.
|
|
5566
5815
|
* @summary Add Service
|
|
5567
5816
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5568
5817
|
* @param {BusIOType} busIOType
|
|
@@ -5572,7 +5821,7 @@ export declare const BUSInputsOutputsApiAxiosParamCreator: (configuration?: Conf
|
|
|
5572
5821
|
*/
|
|
5573
5822
|
addBusIOService: (cell: string, busIOType: BusIOType, completionTimeout?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
5574
5823
|
/**
|
|
5575
|
-
* Adds an input/output to or updates an input/output on the PROFINET device.
|
|
5824
|
+
* 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
5825
|
* @summary Add PROFINET Input/Output
|
|
5577
5826
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5578
5827
|
* @param {string} io Unique identifier to address an Input/Output in the cell.
|
|
@@ -5582,7 +5831,7 @@ export declare const BUSInputsOutputsApiAxiosParamCreator: (configuration?: Conf
|
|
|
5582
5831
|
*/
|
|
5583
5832
|
addProfinetIO: (cell: string, io: string, profinetIOData: ProfinetIOData, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
5584
5833
|
/**
|
|
5585
|
-
*
|
|
5834
|
+
* Remove the BUS inputs/outputs service from the cell.
|
|
5586
5835
|
* @summary Clear Service
|
|
5587
5836
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5588
5837
|
* @param {number} [completionTimeout]
|
|
@@ -5591,7 +5840,7 @@ export declare const BUSInputsOutputsApiAxiosParamCreator: (configuration?: Conf
|
|
|
5591
5840
|
*/
|
|
5592
5841
|
clearBusIOService: (cell: string, completionTimeout?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
5593
5842
|
/**
|
|
5594
|
-
* Removes
|
|
5843
|
+
* Removes an input/output variable configuration from the PROFINET device, e.g. NOVA\'s PROFINET service.
|
|
5595
5844
|
* @summary Remove PROFINET Input/Ouptut
|
|
5596
5845
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5597
5846
|
* @param {string} io Unique identifier to address an Input/Output in the cell.
|
|
@@ -5600,7 +5849,7 @@ export declare const BUSInputsOutputsApiAxiosParamCreator: (configuration?: Conf
|
|
|
5600
5849
|
*/
|
|
5601
5850
|
deleteProfinetIO: (cell: string, io: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
5602
5851
|
/**
|
|
5603
|
-
* Get deployed BUS
|
|
5852
|
+
* Get deployed BUS inputs/outputs service.
|
|
5604
5853
|
* @summary Get Service
|
|
5605
5854
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5606
5855
|
* @param {*} [options] Override http request option.
|
|
@@ -5625,7 +5874,7 @@ export declare const BUSInputsOutputsApiAxiosParamCreator: (configuration?: Conf
|
|
|
5625
5874
|
*/
|
|
5626
5875
|
getBusIOValues: (cell: string, ios?: Array<string>, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
5627
5876
|
/**
|
|
5628
|
-
* Get description of PROFINET
|
|
5877
|
+
* Get description of NOVA as a PROFINET device.
|
|
5629
5878
|
* @summary Get PROFINET Description
|
|
5630
5879
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5631
5880
|
* @param {*} [options] Override http request option.
|
|
@@ -5633,7 +5882,7 @@ export declare const BUSInputsOutputsApiAxiosParamCreator: (configuration?: Conf
|
|
|
5633
5882
|
*/
|
|
5634
5883
|
getProfinetDescription: (cell: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
5635
5884
|
/**
|
|
5636
|
-
* Get input/output configuration of the PROFINET device as file.
|
|
5885
|
+
* 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
5886
|
* @summary PROFINET Inputs/Outputs to File
|
|
5638
5887
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5639
5888
|
* @param {number} [inputOffset]
|
|
@@ -5643,7 +5892,7 @@ export declare const BUSInputsOutputsApiAxiosParamCreator: (configuration?: Conf
|
|
|
5643
5892
|
*/
|
|
5644
5893
|
getProfinetIOsFromFile: (cell: string, inputOffset?: number, outputOffset?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
5645
5894
|
/**
|
|
5646
|
-
* List all BUS
|
|
5895
|
+
* 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
5896
|
* @summary List Descriptions
|
|
5648
5897
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5649
5898
|
* @param {*} [options] Override http request option.
|
|
@@ -5651,7 +5900,7 @@ export declare const BUSInputsOutputsApiAxiosParamCreator: (configuration?: Conf
|
|
|
5651
5900
|
*/
|
|
5652
5901
|
listBusIODescriptions: (cell: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
5653
5902
|
/**
|
|
5654
|
-
* List all PROFINET input and
|
|
5903
|
+
* 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
5904
|
* @summary List PROFINET Input/Output Configuration
|
|
5656
5905
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5657
5906
|
* @param {*} [options] Override http request option.
|
|
@@ -5668,7 +5917,7 @@ export declare const BUSInputsOutputsApiAxiosParamCreator: (configuration?: Conf
|
|
|
5668
5917
|
*/
|
|
5669
5918
|
setBusIOValues: (cell: string, iOValue: Array<IOValue>, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
5670
5919
|
/**
|
|
5671
|
-
* Sets inputs/outputs
|
|
5920
|
+
* 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
5921
|
* @summary Set PROFINET Inputs/Outputs from File
|
|
5673
5922
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5674
5923
|
* @param {ProfinetInputOutputConfig} profinetInputOutputConfig
|
|
@@ -5683,7 +5932,7 @@ export declare const BUSInputsOutputsApiAxiosParamCreator: (configuration?: Conf
|
|
|
5683
5932
|
*/
|
|
5684
5933
|
export declare const BUSInputsOutputsApiFp: (configuration?: Configuration) => {
|
|
5685
5934
|
/**
|
|
5686
|
-
* Add
|
|
5935
|
+
* Add the BUS inputs/outputs service to the cell. Starts a containerized service that enables BUS connections via the specified ethernet port.
|
|
5687
5936
|
* @summary Add Service
|
|
5688
5937
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5689
5938
|
* @param {BusIOType} busIOType
|
|
@@ -5693,7 +5942,7 @@ export declare const BUSInputsOutputsApiFp: (configuration?: Configuration) => {
|
|
|
5693
5942
|
*/
|
|
5694
5943
|
addBusIOService(cell: string, busIOType: BusIOType, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
5695
5944
|
/**
|
|
5696
|
-
* Adds an input/output to or updates an input/output on the PROFINET device.
|
|
5945
|
+
* 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
5946
|
* @summary Add PROFINET Input/Output
|
|
5698
5947
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5699
5948
|
* @param {string} io Unique identifier to address an Input/Output in the cell.
|
|
@@ -5703,7 +5952,7 @@ export declare const BUSInputsOutputsApiFp: (configuration?: Configuration) => {
|
|
|
5703
5952
|
*/
|
|
5704
5953
|
addProfinetIO(cell: string, io: string, profinetIOData: ProfinetIOData, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
5705
5954
|
/**
|
|
5706
|
-
*
|
|
5955
|
+
* Remove the BUS inputs/outputs service from the cell.
|
|
5707
5956
|
* @summary Clear Service
|
|
5708
5957
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5709
5958
|
* @param {number} [completionTimeout]
|
|
@@ -5712,7 +5961,7 @@ export declare const BUSInputsOutputsApiFp: (configuration?: Configuration) => {
|
|
|
5712
5961
|
*/
|
|
5713
5962
|
clearBusIOService(cell: string, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
5714
5963
|
/**
|
|
5715
|
-
* Removes
|
|
5964
|
+
* Removes an input/output variable configuration from the PROFINET device, e.g. NOVA\'s PROFINET service.
|
|
5716
5965
|
* @summary Remove PROFINET Input/Ouptut
|
|
5717
5966
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5718
5967
|
* @param {string} io Unique identifier to address an Input/Output in the cell.
|
|
@@ -5721,7 +5970,7 @@ export declare const BUSInputsOutputsApiFp: (configuration?: Configuration) => {
|
|
|
5721
5970
|
*/
|
|
5722
5971
|
deleteProfinetIO(cell: string, io: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
5723
5972
|
/**
|
|
5724
|
-
* Get deployed BUS
|
|
5973
|
+
* Get deployed BUS inputs/outputs service.
|
|
5725
5974
|
* @summary Get Service
|
|
5726
5975
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5727
5976
|
* @param {*} [options] Override http request option.
|
|
@@ -5746,7 +5995,7 @@ export declare const BUSInputsOutputsApiFp: (configuration?: Configuration) => {
|
|
|
5746
5995
|
*/
|
|
5747
5996
|
getBusIOValues(cell: string, ios?: Array<string>, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<IOValue>>>;
|
|
5748
5997
|
/**
|
|
5749
|
-
* Get description of PROFINET
|
|
5998
|
+
* Get description of NOVA as a PROFINET device.
|
|
5750
5999
|
* @summary Get PROFINET Description
|
|
5751
6000
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5752
6001
|
* @param {*} [options] Override http request option.
|
|
@@ -5754,7 +6003,7 @@ export declare const BUSInputsOutputsApiFp: (configuration?: Configuration) => {
|
|
|
5754
6003
|
*/
|
|
5755
6004
|
getProfinetDescription(cell: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ProfinetDescription>>;
|
|
5756
6005
|
/**
|
|
5757
|
-
* Get input/output configuration of the PROFINET device as file.
|
|
6006
|
+
* 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
6007
|
* @summary PROFINET Inputs/Outputs to File
|
|
5759
6008
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5760
6009
|
* @param {number} [inputOffset]
|
|
@@ -5764,15 +6013,15 @@ export declare const BUSInputsOutputsApiFp: (configuration?: Configuration) => {
|
|
|
5764
6013
|
*/
|
|
5765
6014
|
getProfinetIOsFromFile(cell: string, inputOffset?: number, outputOffset?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<string>>;
|
|
5766
6015
|
/**
|
|
5767
|
-
* List all BUS
|
|
6016
|
+
* 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
6017
|
* @summary List Descriptions
|
|
5769
6018
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5770
6019
|
* @param {*} [options] Override http request option.
|
|
5771
6020
|
* @throws {RequiredError}
|
|
5772
6021
|
*/
|
|
5773
|
-
listBusIODescriptions(cell: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<
|
|
6022
|
+
listBusIODescriptions(cell: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<IODescription2>>>;
|
|
5774
6023
|
/**
|
|
5775
|
-
* List all PROFINET input and
|
|
6024
|
+
* 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
6025
|
* @summary List PROFINET Input/Output Configuration
|
|
5777
6026
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5778
6027
|
* @param {*} [options] Override http request option.
|
|
@@ -5789,7 +6038,7 @@ export declare const BUSInputsOutputsApiFp: (configuration?: Configuration) => {
|
|
|
5789
6038
|
*/
|
|
5790
6039
|
setBusIOValues(cell: string, iOValue: Array<IOValue>, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
5791
6040
|
/**
|
|
5792
|
-
* Sets inputs/outputs
|
|
6041
|
+
* 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
6042
|
* @summary Set PROFINET Inputs/Outputs from File
|
|
5794
6043
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5795
6044
|
* @param {ProfinetInputOutputConfig} profinetInputOutputConfig
|
|
@@ -5804,7 +6053,7 @@ export declare const BUSInputsOutputsApiFp: (configuration?: Configuration) => {
|
|
|
5804
6053
|
*/
|
|
5805
6054
|
export declare const BUSInputsOutputsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
5806
6055
|
/**
|
|
5807
|
-
* Add
|
|
6056
|
+
* Add the BUS inputs/outputs service to the cell. Starts a containerized service that enables BUS connections via the specified ethernet port.
|
|
5808
6057
|
* @summary Add Service
|
|
5809
6058
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5810
6059
|
* @param {BusIOType} busIOType
|
|
@@ -5814,7 +6063,7 @@ export declare const BUSInputsOutputsApiFactory: (configuration?: Configuration,
|
|
|
5814
6063
|
*/
|
|
5815
6064
|
addBusIOService(cell: string, busIOType: BusIOType, completionTimeout?: number, options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
5816
6065
|
/**
|
|
5817
|
-
* Adds an input/output to or updates an input/output on the PROFINET device.
|
|
6066
|
+
* 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
6067
|
* @summary Add PROFINET Input/Output
|
|
5819
6068
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5820
6069
|
* @param {string} io Unique identifier to address an Input/Output in the cell.
|
|
@@ -5824,7 +6073,7 @@ export declare const BUSInputsOutputsApiFactory: (configuration?: Configuration,
|
|
|
5824
6073
|
*/
|
|
5825
6074
|
addProfinetIO(cell: string, io: string, profinetIOData: ProfinetIOData, options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
5826
6075
|
/**
|
|
5827
|
-
*
|
|
6076
|
+
* Remove the BUS inputs/outputs service from the cell.
|
|
5828
6077
|
* @summary Clear Service
|
|
5829
6078
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5830
6079
|
* @param {number} [completionTimeout]
|
|
@@ -5833,7 +6082,7 @@ export declare const BUSInputsOutputsApiFactory: (configuration?: Configuration,
|
|
|
5833
6082
|
*/
|
|
5834
6083
|
clearBusIOService(cell: string, completionTimeout?: number, options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
5835
6084
|
/**
|
|
5836
|
-
* Removes
|
|
6085
|
+
* Removes an input/output variable configuration from the PROFINET device, e.g. NOVA\'s PROFINET service.
|
|
5837
6086
|
* @summary Remove PROFINET Input/Ouptut
|
|
5838
6087
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5839
6088
|
* @param {string} io Unique identifier to address an Input/Output in the cell.
|
|
@@ -5842,7 +6091,7 @@ export declare const BUSInputsOutputsApiFactory: (configuration?: Configuration,
|
|
|
5842
6091
|
*/
|
|
5843
6092
|
deleteProfinetIO(cell: string, io: string, options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
5844
6093
|
/**
|
|
5845
|
-
* Get deployed BUS
|
|
6094
|
+
* Get deployed BUS inputs/outputs service.
|
|
5846
6095
|
* @summary Get Service
|
|
5847
6096
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5848
6097
|
* @param {*} [options] Override http request option.
|
|
@@ -5867,7 +6116,7 @@ export declare const BUSInputsOutputsApiFactory: (configuration?: Configuration,
|
|
|
5867
6116
|
*/
|
|
5868
6117
|
getBusIOValues(cell: string, ios?: Array<string>, options?: RawAxiosRequestConfig): AxiosPromise<Array<IOValue>>;
|
|
5869
6118
|
/**
|
|
5870
|
-
* Get description of PROFINET
|
|
6119
|
+
* Get description of NOVA as a PROFINET device.
|
|
5871
6120
|
* @summary Get PROFINET Description
|
|
5872
6121
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5873
6122
|
* @param {*} [options] Override http request option.
|
|
@@ -5875,7 +6124,7 @@ export declare const BUSInputsOutputsApiFactory: (configuration?: Configuration,
|
|
|
5875
6124
|
*/
|
|
5876
6125
|
getProfinetDescription(cell: string, options?: RawAxiosRequestConfig): AxiosPromise<ProfinetDescription>;
|
|
5877
6126
|
/**
|
|
5878
|
-
* Get input/output configuration of the PROFINET device as file.
|
|
6127
|
+
* 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
6128
|
* @summary PROFINET Inputs/Outputs to File
|
|
5880
6129
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5881
6130
|
* @param {number} [inputOffset]
|
|
@@ -5885,15 +6134,15 @@ export declare const BUSInputsOutputsApiFactory: (configuration?: Configuration,
|
|
|
5885
6134
|
*/
|
|
5886
6135
|
getProfinetIOsFromFile(cell: string, inputOffset?: number, outputOffset?: number, options?: RawAxiosRequestConfig): AxiosPromise<string>;
|
|
5887
6136
|
/**
|
|
5888
|
-
* List all BUS
|
|
6137
|
+
* 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
6138
|
* @summary List Descriptions
|
|
5890
6139
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5891
6140
|
* @param {*} [options] Override http request option.
|
|
5892
6141
|
* @throws {RequiredError}
|
|
5893
6142
|
*/
|
|
5894
|
-
listBusIODescriptions(cell: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<
|
|
6143
|
+
listBusIODescriptions(cell: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<IODescription2>>;
|
|
5895
6144
|
/**
|
|
5896
|
-
* List all PROFINET input and
|
|
6145
|
+
* 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
6146
|
* @summary List PROFINET Input/Output Configuration
|
|
5898
6147
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5899
6148
|
* @param {*} [options] Override http request option.
|
|
@@ -5910,7 +6159,7 @@ export declare const BUSInputsOutputsApiFactory: (configuration?: Configuration,
|
|
|
5910
6159
|
*/
|
|
5911
6160
|
setBusIOValues(cell: string, iOValue: Array<IOValue>, options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
5912
6161
|
/**
|
|
5913
|
-
* Sets inputs/outputs
|
|
6162
|
+
* 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
6163
|
* @summary Set PROFINET Inputs/Outputs from File
|
|
5915
6164
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5916
6165
|
* @param {ProfinetInputOutputConfig} profinetInputOutputConfig
|
|
@@ -5927,7 +6176,7 @@ export declare const BUSInputsOutputsApiFactory: (configuration?: Configuration,
|
|
|
5927
6176
|
*/
|
|
5928
6177
|
export declare class BUSInputsOutputsApi extends BaseAPI {
|
|
5929
6178
|
/**
|
|
5930
|
-
* Add
|
|
6179
|
+
* Add the BUS inputs/outputs service to the cell. Starts a containerized service that enables BUS connections via the specified ethernet port.
|
|
5931
6180
|
* @summary Add Service
|
|
5932
6181
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5933
6182
|
* @param {BusIOType} busIOType
|
|
@@ -5938,7 +6187,7 @@ export declare class BUSInputsOutputsApi extends BaseAPI {
|
|
|
5938
6187
|
*/
|
|
5939
6188
|
addBusIOService(cell: string, busIOType: BusIOType, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
5940
6189
|
/**
|
|
5941
|
-
* Adds an input/output to or updates an input/output on the PROFINET device.
|
|
6190
|
+
* 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
6191
|
* @summary Add PROFINET Input/Output
|
|
5943
6192
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5944
6193
|
* @param {string} io Unique identifier to address an Input/Output in the cell.
|
|
@@ -5949,7 +6198,7 @@ export declare class BUSInputsOutputsApi extends BaseAPI {
|
|
|
5949
6198
|
*/
|
|
5950
6199
|
addProfinetIO(cell: string, io: string, profinetIOData: ProfinetIOData, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
5951
6200
|
/**
|
|
5952
|
-
*
|
|
6201
|
+
* Remove the BUS inputs/outputs service from the cell.
|
|
5953
6202
|
* @summary Clear Service
|
|
5954
6203
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5955
6204
|
* @param {number} [completionTimeout]
|
|
@@ -5959,7 +6208,7 @@ export declare class BUSInputsOutputsApi extends BaseAPI {
|
|
|
5959
6208
|
*/
|
|
5960
6209
|
clearBusIOService(cell: string, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
5961
6210
|
/**
|
|
5962
|
-
* Removes
|
|
6211
|
+
* Removes an input/output variable configuration from the PROFINET device, e.g. NOVA\'s PROFINET service.
|
|
5963
6212
|
* @summary Remove PROFINET Input/Ouptut
|
|
5964
6213
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5965
6214
|
* @param {string} io Unique identifier to address an Input/Output in the cell.
|
|
@@ -5969,16 +6218,14 @@ export declare class BUSInputsOutputsApi extends BaseAPI {
|
|
|
5969
6218
|
*/
|
|
5970
6219
|
deleteProfinetIO(cell: string, io: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
5971
6220
|
/**
|
|
5972
|
-
* Get deployed BUS
|
|
6221
|
+
* Get deployed BUS inputs/outputs service.
|
|
5973
6222
|
* @summary Get Service
|
|
5974
6223
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5975
6224
|
* @param {*} [options] Override http request option.
|
|
5976
6225
|
* @throws {RequiredError}
|
|
5977
6226
|
* @memberof BUSInputsOutputsApi
|
|
5978
6227
|
*/
|
|
5979
|
-
getBusIOService(cell: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<
|
|
5980
|
-
bus_type: "profinet";
|
|
5981
|
-
} & BusIOProfinet, any>>;
|
|
6228
|
+
getBusIOService(cell: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<BusIOType, any>>;
|
|
5982
6229
|
/**
|
|
5983
6230
|
* Get the current state of the BUS Inputs/Outputs service.
|
|
5984
6231
|
* @summary State
|
|
@@ -5999,7 +6246,7 @@ export declare class BUSInputsOutputsApi extends BaseAPI {
|
|
|
5999
6246
|
*/
|
|
6000
6247
|
getBusIOValues(cell: string, ios?: Array<string>, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<IOValue[], any>>;
|
|
6001
6248
|
/**
|
|
6002
|
-
* Get description of PROFINET
|
|
6249
|
+
* Get description of NOVA as a PROFINET device.
|
|
6003
6250
|
* @summary Get PROFINET Description
|
|
6004
6251
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
6005
6252
|
* @param {*} [options] Override http request option.
|
|
@@ -6008,7 +6255,7 @@ export declare class BUSInputsOutputsApi extends BaseAPI {
|
|
|
6008
6255
|
*/
|
|
6009
6256
|
getProfinetDescription(cell: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ProfinetDescription, any>>;
|
|
6010
6257
|
/**
|
|
6011
|
-
* Get input/output configuration of the PROFINET device as file.
|
|
6258
|
+
* 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
6259
|
* @summary PROFINET Inputs/Outputs to File
|
|
6013
6260
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
6014
6261
|
* @param {number} [inputOffset]
|
|
@@ -6019,16 +6266,16 @@ export declare class BUSInputsOutputsApi extends BaseAPI {
|
|
|
6019
6266
|
*/
|
|
6020
6267
|
getProfinetIOsFromFile(cell: string, inputOffset?: number, outputOffset?: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<string, any>>;
|
|
6021
6268
|
/**
|
|
6022
|
-
* List all BUS
|
|
6269
|
+
* 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
6270
|
* @summary List Descriptions
|
|
6024
6271
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
6025
6272
|
* @param {*} [options] Override http request option.
|
|
6026
6273
|
* @throws {RequiredError}
|
|
6027
6274
|
* @memberof BUSInputsOutputsApi
|
|
6028
6275
|
*/
|
|
6029
|
-
listBusIODescriptions(cell: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<
|
|
6276
|
+
listBusIODescriptions(cell: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<IODescription2[], any>>;
|
|
6030
6277
|
/**
|
|
6031
|
-
* List all PROFINET input and
|
|
6278
|
+
* 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
6279
|
* @summary List PROFINET Input/Output Configuration
|
|
6033
6280
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
6034
6281
|
* @param {*} [options] Override http request option.
|
|
@@ -6047,7 +6294,7 @@ export declare class BUSInputsOutputsApi extends BaseAPI {
|
|
|
6047
6294
|
*/
|
|
6048
6295
|
setBusIOValues(cell: string, iOValue: Array<IOValue>, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
6049
6296
|
/**
|
|
6050
|
-
* Sets inputs/outputs
|
|
6297
|
+
* 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
6298
|
* @summary Set PROFINET Inputs/Outputs from File
|
|
6052
6299
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
6053
6300
|
* @param {ProfinetInputOutputConfig} profinetInputOutputConfig
|
|
@@ -7637,7 +7884,7 @@ export declare class MotionGroupApi extends BaseAPI {
|
|
|
7637
7884
|
*/
|
|
7638
7885
|
export declare const MotionGroupModelsApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
7639
7886
|
/**
|
|
7640
|
-
* Returns the default collision link chain for a given motion group model. See [
|
|
7887
|
+
* 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
7888
|
* @summary Get Collision Model
|
|
7642
7889
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
7643
7890
|
* @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 +7907,7 @@ export declare const MotionGroupModelsApiAxiosParamCreator: (configuration?: Con
|
|
|
7660
7907
|
*/
|
|
7661
7908
|
export declare const MotionGroupModelsApiFp: (configuration?: Configuration) => {
|
|
7662
7909
|
/**
|
|
7663
|
-
* Returns the default collision link chain for a given motion group model. See [
|
|
7910
|
+
* 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
7911
|
* @summary Get Collision Model
|
|
7665
7912
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
7666
7913
|
* @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 +7932,7 @@ export declare const MotionGroupModelsApiFp: (configuration?: Configuration) =>
|
|
|
7685
7932
|
*/
|
|
7686
7933
|
export declare const MotionGroupModelsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
7687
7934
|
/**
|
|
7688
|
-
* Returns the default collision link chain for a given motion group model. See [
|
|
7935
|
+
* 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
7936
|
* @summary Get Collision Model
|
|
7690
7937
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
7691
7938
|
* @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 +7959,7 @@ export declare const MotionGroupModelsApiFactory: (configuration?: Configuration
|
|
|
7712
7959
|
*/
|
|
7713
7960
|
export declare class MotionGroupModelsApi extends BaseAPI {
|
|
7714
7961
|
/**
|
|
7715
|
-
* Returns the default collision link chain for a given motion group model. See [
|
|
7962
|
+
* 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
7963
|
* @summary Get Collision Model
|
|
7717
7964
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
7718
7965
|
* @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 +7980,180 @@ export declare class MotionGroupModelsApi extends BaseAPI {
|
|
|
7733
7980
|
*/
|
|
7734
7981
|
getMotionGroupModels(cell: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<string[], any>>;
|
|
7735
7982
|
}
|
|
7983
|
+
/**
|
|
7984
|
+
* ProgramApi - axios parameter creator
|
|
7985
|
+
* @export
|
|
7986
|
+
*/
|
|
7987
|
+
export declare const ProgramApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
7988
|
+
/**
|
|
7989
|
+
* Get details of a program.
|
|
7990
|
+
* @summary Get program
|
|
7991
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
7992
|
+
* @param {string} program
|
|
7993
|
+
* @param {*} [options] Override http request option.
|
|
7994
|
+
* @throws {RequiredError}
|
|
7995
|
+
*/
|
|
7996
|
+
getProgram: (cell: string, program: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
7997
|
+
/**
|
|
7998
|
+
* List details of all existing programs.
|
|
7999
|
+
* @summary List programs
|
|
8000
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8001
|
+
* @param {*} [options] Override http request option.
|
|
8002
|
+
* @throws {RequiredError}
|
|
8003
|
+
*/
|
|
8004
|
+
listPrograms: (cell: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
8005
|
+
/**
|
|
8006
|
+
* This endpoint starts a new program execution. The program will be executed asynchronously.
|
|
8007
|
+
* @summary Start the program
|
|
8008
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8009
|
+
* @param {string} program
|
|
8010
|
+
* @param {ProgramStartRequest} programStartRequest
|
|
8011
|
+
* @param {*} [options] Override http request option.
|
|
8012
|
+
* @throws {RequiredError}
|
|
8013
|
+
*/
|
|
8014
|
+
startProgram: (cell: string, program: string, programStartRequest: ProgramStartRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
8015
|
+
/**
|
|
8016
|
+
* Stop a specific program run.
|
|
8017
|
+
* @summary Stop program run
|
|
8018
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8019
|
+
* @param {string} program
|
|
8020
|
+
* @param {*} [options] Override http request option.
|
|
8021
|
+
* @throws {RequiredError}
|
|
8022
|
+
*/
|
|
8023
|
+
stopProgram: (cell: string, program: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
8024
|
+
};
|
|
8025
|
+
/**
|
|
8026
|
+
* ProgramApi - functional programming interface
|
|
8027
|
+
* @export
|
|
8028
|
+
*/
|
|
8029
|
+
export declare const ProgramApiFp: (configuration?: Configuration) => {
|
|
8030
|
+
/**
|
|
8031
|
+
* Get details of a program.
|
|
8032
|
+
* @summary Get program
|
|
8033
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8034
|
+
* @param {string} program
|
|
8035
|
+
* @param {*} [options] Override http request option.
|
|
8036
|
+
* @throws {RequiredError}
|
|
8037
|
+
*/
|
|
8038
|
+
getProgram(cell: string, program: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Program>>;
|
|
8039
|
+
/**
|
|
8040
|
+
* List details of all existing programs.
|
|
8041
|
+
* @summary List programs
|
|
8042
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8043
|
+
* @param {*} [options] Override http request option.
|
|
8044
|
+
* @throws {RequiredError}
|
|
8045
|
+
*/
|
|
8046
|
+
listPrograms(cell: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<Program>>>;
|
|
8047
|
+
/**
|
|
8048
|
+
* This endpoint starts a new program execution. The program will be executed asynchronously.
|
|
8049
|
+
* @summary Start the program
|
|
8050
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8051
|
+
* @param {string} program
|
|
8052
|
+
* @param {ProgramStartRequest} programStartRequest
|
|
8053
|
+
* @param {*} [options] Override http request option.
|
|
8054
|
+
* @throws {RequiredError}
|
|
8055
|
+
*/
|
|
8056
|
+
startProgram(cell: string, program: string, programStartRequest: ProgramStartRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ProgramRun>>;
|
|
8057
|
+
/**
|
|
8058
|
+
* Stop a specific program run.
|
|
8059
|
+
* @summary Stop program run
|
|
8060
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8061
|
+
* @param {string} program
|
|
8062
|
+
* @param {*} [options] Override http request option.
|
|
8063
|
+
* @throws {RequiredError}
|
|
8064
|
+
*/
|
|
8065
|
+
stopProgram(cell: string, program: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
8066
|
+
};
|
|
8067
|
+
/**
|
|
8068
|
+
* ProgramApi - factory interface
|
|
8069
|
+
* @export
|
|
8070
|
+
*/
|
|
8071
|
+
export declare const ProgramApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
8072
|
+
/**
|
|
8073
|
+
* Get details of a program.
|
|
8074
|
+
* @summary Get program
|
|
8075
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8076
|
+
* @param {string} program
|
|
8077
|
+
* @param {*} [options] Override http request option.
|
|
8078
|
+
* @throws {RequiredError}
|
|
8079
|
+
*/
|
|
8080
|
+
getProgram(cell: string, program: string, options?: RawAxiosRequestConfig): AxiosPromise<Program>;
|
|
8081
|
+
/**
|
|
8082
|
+
* List details of all existing programs.
|
|
8083
|
+
* @summary List programs
|
|
8084
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8085
|
+
* @param {*} [options] Override http request option.
|
|
8086
|
+
* @throws {RequiredError}
|
|
8087
|
+
*/
|
|
8088
|
+
listPrograms(cell: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<Program>>;
|
|
8089
|
+
/**
|
|
8090
|
+
* This endpoint starts a new program execution. The program will be executed asynchronously.
|
|
8091
|
+
* @summary Start the program
|
|
8092
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8093
|
+
* @param {string} program
|
|
8094
|
+
* @param {ProgramStartRequest} programStartRequest
|
|
8095
|
+
* @param {*} [options] Override http request option.
|
|
8096
|
+
* @throws {RequiredError}
|
|
8097
|
+
*/
|
|
8098
|
+
startProgram(cell: string, program: string, programStartRequest: ProgramStartRequest, options?: RawAxiosRequestConfig): AxiosPromise<ProgramRun>;
|
|
8099
|
+
/**
|
|
8100
|
+
* Stop a specific program run.
|
|
8101
|
+
* @summary Stop program run
|
|
8102
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8103
|
+
* @param {string} program
|
|
8104
|
+
* @param {*} [options] Override http request option.
|
|
8105
|
+
* @throws {RequiredError}
|
|
8106
|
+
*/
|
|
8107
|
+
stopProgram(cell: string, program: string, options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
8108
|
+
};
|
|
8109
|
+
/**
|
|
8110
|
+
* ProgramApi - object-oriented interface
|
|
8111
|
+
* @export
|
|
8112
|
+
* @class ProgramApi
|
|
8113
|
+
* @extends {BaseAPI}
|
|
8114
|
+
*/
|
|
8115
|
+
export declare class ProgramApi extends BaseAPI {
|
|
8116
|
+
/**
|
|
8117
|
+
* Get details of a program.
|
|
8118
|
+
* @summary Get program
|
|
8119
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8120
|
+
* @param {string} program
|
|
8121
|
+
* @param {*} [options] Override http request option.
|
|
8122
|
+
* @throws {RequiredError}
|
|
8123
|
+
* @memberof ProgramApi
|
|
8124
|
+
*/
|
|
8125
|
+
getProgram(cell: string, program: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Program, any>>;
|
|
8126
|
+
/**
|
|
8127
|
+
* List details of all existing programs.
|
|
8128
|
+
* @summary List programs
|
|
8129
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8130
|
+
* @param {*} [options] Override http request option.
|
|
8131
|
+
* @throws {RequiredError}
|
|
8132
|
+
* @memberof ProgramApi
|
|
8133
|
+
*/
|
|
8134
|
+
listPrograms(cell: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Program[], any>>;
|
|
8135
|
+
/**
|
|
8136
|
+
* This endpoint starts a new program execution. The program will be executed asynchronously.
|
|
8137
|
+
* @summary Start the program
|
|
8138
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8139
|
+
* @param {string} program
|
|
8140
|
+
* @param {ProgramStartRequest} programStartRequest
|
|
8141
|
+
* @param {*} [options] Override http request option.
|
|
8142
|
+
* @throws {RequiredError}
|
|
8143
|
+
* @memberof ProgramApi
|
|
8144
|
+
*/
|
|
8145
|
+
startProgram(cell: string, program: string, programStartRequest: ProgramStartRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ProgramRun, any>>;
|
|
8146
|
+
/**
|
|
8147
|
+
* Stop a specific program run.
|
|
8148
|
+
* @summary Stop program run
|
|
8149
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8150
|
+
* @param {string} program
|
|
8151
|
+
* @param {*} [options] Override http request option.
|
|
8152
|
+
* @throws {RequiredError}
|
|
8153
|
+
* @memberof ProgramApi
|
|
8154
|
+
*/
|
|
8155
|
+
stopProgram(cell: string, program: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
8156
|
+
}
|
|
7736
8157
|
/**
|
|
7737
8158
|
* StoreCollisionComponentsApi - axios parameter creator
|
|
7738
8159
|
* @export
|
|
@@ -7801,7 +8222,7 @@ export declare const StoreCollisionComponentsApiAxiosParamCreator: (configuratio
|
|
|
7801
8222
|
*/
|
|
7802
8223
|
listCollisionLinkChains: (cell: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
7803
8224
|
/**
|
|
7804
|
-
* Returns
|
|
8225
|
+
* Returns all stored colliders.
|
|
7805
8226
|
* @summary List Colliders
|
|
7806
8227
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
7807
8228
|
* @param {*} [options] Override http request option.
|
|
@@ -7927,7 +8348,7 @@ export declare const StoreCollisionComponentsApiFp: (configuration?: Configurati
|
|
|
7927
8348
|
}>;
|
|
7928
8349
|
}>>;
|
|
7929
8350
|
/**
|
|
7930
|
-
* Returns
|
|
8351
|
+
* Returns all stored colliders.
|
|
7931
8352
|
* @summary List Colliders
|
|
7932
8353
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
7933
8354
|
* @param {*} [options] Override http request option.
|
|
@@ -8063,7 +8484,7 @@ export declare const StoreCollisionComponentsApiFactory: (configuration?: Config
|
|
|
8063
8484
|
}>;
|
|
8064
8485
|
}>;
|
|
8065
8486
|
/**
|
|
8066
|
-
* Returns
|
|
8487
|
+
* Returns all stored colliders.
|
|
8067
8488
|
* @summary List Colliders
|
|
8068
8489
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8069
8490
|
* @param {*} [options] Override http request option.
|
|
@@ -8208,7 +8629,7 @@ export declare class StoreCollisionComponentsApi extends BaseAPI {
|
|
|
8208
8629
|
}[];
|
|
8209
8630
|
}, any>>;
|
|
8210
8631
|
/**
|
|
8211
|
-
* Returns
|
|
8632
|
+
* Returns all stored colliders.
|
|
8212
8633
|
* @summary List Colliders
|
|
8213
8634
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8214
8635
|
* @param {*} [options] Override http request option.
|
|
@@ -9428,7 +9849,7 @@ export declare class TrajectoryPlanningApi extends BaseAPI {
|
|
|
9428
9849
|
*/
|
|
9429
9850
|
export declare const VirtualControllerApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
9430
9851
|
/**
|
|
9431
|
-
* Adds a coordinate system to the robot controller.
|
|
9852
|
+
* 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
9853
|
* @summary Add Coordinate Systems
|
|
9433
9854
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
9434
9855
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -9439,7 +9860,7 @@ export declare const VirtualControllerApiAxiosParamCreator: (configuration?: Con
|
|
|
9439
9860
|
*/
|
|
9440
9861
|
addVirtualControllerCoordinateSystem: (cell: string, controller: string, coordinateSystem: string, coordinateSystemData: CoordinateSystemData, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
9441
9862
|
/**
|
|
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
|
|
9863
|
+
* 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
9864
|
* @summary Add TCP
|
|
9444
9865
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
9445
9866
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -9451,8 +9872,8 @@ export declare const VirtualControllerApiAxiosParamCreator: (configuration?: Con
|
|
|
9451
9872
|
*/
|
|
9452
9873
|
addVirtualControllerTcp: (cell: string, controller: string, motionGroup: string, tcp: string, robotTcpData: RobotTcpData, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
9453
9874
|
/**
|
|
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
|
|
9875
|
+
* 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.
|
|
9876
|
+
* @summary Delete Coordinate System
|
|
9456
9877
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
9457
9878
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
9458
9879
|
* @param {string} coordinateSystem Unique identifier addressing a coordinate system.
|
|
@@ -9462,7 +9883,7 @@ export declare const VirtualControllerApiAxiosParamCreator: (configuration?: Con
|
|
|
9462
9883
|
*/
|
|
9463
9884
|
deleteVirtualControllerCoordinateSystem: (cell: string, controller: string, coordinateSystem: string, deleteDependent?: boolean, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
9464
9885
|
/**
|
|
9465
|
-
* Removes the TCP from the motion group. An unknown TCP is a valid input.
|
|
9886
|
+
* 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
9887
|
* @summary Remove TCP
|
|
9467
9888
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
9468
9889
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -9570,7 +9991,7 @@ export declare const VirtualControllerApiAxiosParamCreator: (configuration?: Con
|
|
|
9570
9991
|
*/
|
|
9571
9992
|
setOperationMode: (cell: string, controller: string, mode: OperationMode, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
9572
9993
|
/**
|
|
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
|
|
9994
|
+
* 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
9995
|
* @summary Set Mounting
|
|
9575
9996
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
9576
9997
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -9587,7 +10008,7 @@ export declare const VirtualControllerApiAxiosParamCreator: (configuration?: Con
|
|
|
9587
10008
|
*/
|
|
9588
10009
|
export declare const VirtualControllerApiFp: (configuration?: Configuration) => {
|
|
9589
10010
|
/**
|
|
9590
|
-
* Adds a coordinate system to the robot controller.
|
|
10011
|
+
* 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
10012
|
* @summary Add Coordinate Systems
|
|
9592
10013
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
9593
10014
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -9598,7 +10019,7 @@ export declare const VirtualControllerApiFp: (configuration?: Configuration) =>
|
|
|
9598
10019
|
*/
|
|
9599
10020
|
addVirtualControllerCoordinateSystem(cell: string, controller: string, coordinateSystem: string, coordinateSystemData: CoordinateSystemData, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
9600
10021
|
/**
|
|
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
|
|
10022
|
+
* 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
10023
|
* @summary Add TCP
|
|
9603
10024
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
9604
10025
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -9610,8 +10031,8 @@ export declare const VirtualControllerApiFp: (configuration?: Configuration) =>
|
|
|
9610
10031
|
*/
|
|
9611
10032
|
addVirtualControllerTcp(cell: string, controller: string, motionGroup: string, tcp: string, robotTcpData: RobotTcpData, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
9612
10033
|
/**
|
|
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
|
|
10034
|
+
* 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.
|
|
10035
|
+
* @summary Delete Coordinate System
|
|
9615
10036
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
9616
10037
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
9617
10038
|
* @param {string} coordinateSystem Unique identifier addressing a coordinate system.
|
|
@@ -9621,7 +10042,7 @@ export declare const VirtualControllerApiFp: (configuration?: Configuration) =>
|
|
|
9621
10042
|
*/
|
|
9622
10043
|
deleteVirtualControllerCoordinateSystem(cell: string, controller: string, coordinateSystem: string, deleteDependent?: boolean, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
9623
10044
|
/**
|
|
9624
|
-
* Removes the TCP from the motion group. An unknown TCP is a valid input.
|
|
10045
|
+
* 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
10046
|
* @summary Remove TCP
|
|
9626
10047
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
9627
10048
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -9729,7 +10150,7 @@ export declare const VirtualControllerApiFp: (configuration?: Configuration) =>
|
|
|
9729
10150
|
*/
|
|
9730
10151
|
setOperationMode(cell: string, controller: string, mode: OperationMode, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
9731
10152
|
/**
|
|
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
|
|
10153
|
+
* 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
10154
|
* @summary Set Mounting
|
|
9734
10155
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
9735
10156
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -9746,7 +10167,7 @@ export declare const VirtualControllerApiFp: (configuration?: Configuration) =>
|
|
|
9746
10167
|
*/
|
|
9747
10168
|
export declare const VirtualControllerApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
9748
10169
|
/**
|
|
9749
|
-
* Adds a coordinate system to the robot controller.
|
|
10170
|
+
* 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
10171
|
* @summary Add Coordinate Systems
|
|
9751
10172
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
9752
10173
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -9757,7 +10178,7 @@ export declare const VirtualControllerApiFactory: (configuration?: Configuration
|
|
|
9757
10178
|
*/
|
|
9758
10179
|
addVirtualControllerCoordinateSystem(cell: string, controller: string, coordinateSystem: string, coordinateSystemData: CoordinateSystemData, options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
9759
10180
|
/**
|
|
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
|
|
10181
|
+
* 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
10182
|
* @summary Add TCP
|
|
9762
10183
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
9763
10184
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -9769,8 +10190,8 @@ export declare const VirtualControllerApiFactory: (configuration?: Configuration
|
|
|
9769
10190
|
*/
|
|
9770
10191
|
addVirtualControllerTcp(cell: string, controller: string, motionGroup: string, tcp: string, robotTcpData: RobotTcpData, options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
9771
10192
|
/**
|
|
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
|
|
10193
|
+
* 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.
|
|
10194
|
+
* @summary Delete Coordinate System
|
|
9774
10195
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
9775
10196
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
9776
10197
|
* @param {string} coordinateSystem Unique identifier addressing a coordinate system.
|
|
@@ -9780,7 +10201,7 @@ export declare const VirtualControllerApiFactory: (configuration?: Configuration
|
|
|
9780
10201
|
*/
|
|
9781
10202
|
deleteVirtualControllerCoordinateSystem(cell: string, controller: string, coordinateSystem: string, deleteDependent?: boolean, options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
9782
10203
|
/**
|
|
9783
|
-
* Removes the TCP from the motion group. An unknown TCP is a valid input.
|
|
10204
|
+
* 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
10205
|
* @summary Remove TCP
|
|
9785
10206
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
9786
10207
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -9888,7 +10309,7 @@ export declare const VirtualControllerApiFactory: (configuration?: Configuration
|
|
|
9888
10309
|
*/
|
|
9889
10310
|
setOperationMode(cell: string, controller: string, mode: OperationMode, options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
9890
10311
|
/**
|
|
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
|
|
10312
|
+
* 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
10313
|
* @summary Set Mounting
|
|
9893
10314
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
9894
10315
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -9907,7 +10328,7 @@ export declare const VirtualControllerApiFactory: (configuration?: Configuration
|
|
|
9907
10328
|
*/
|
|
9908
10329
|
export declare class VirtualControllerApi extends BaseAPI {
|
|
9909
10330
|
/**
|
|
9910
|
-
* Adds a coordinate system to the robot controller.
|
|
10331
|
+
* 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
10332
|
* @summary Add Coordinate Systems
|
|
9912
10333
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
9913
10334
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -9919,7 +10340,7 @@ export declare class VirtualControllerApi extends BaseAPI {
|
|
|
9919
10340
|
*/
|
|
9920
10341
|
addVirtualControllerCoordinateSystem(cell: string, controller: string, coordinateSystem: string, coordinateSystemData: CoordinateSystemData, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
9921
10342
|
/**
|
|
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
|
|
10343
|
+
* 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
10344
|
* @summary Add TCP
|
|
9924
10345
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
9925
10346
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -9932,8 +10353,8 @@ export declare class VirtualControllerApi extends BaseAPI {
|
|
|
9932
10353
|
*/
|
|
9933
10354
|
addVirtualControllerTcp(cell: string, controller: string, motionGroup: string, tcp: string, robotTcpData: RobotTcpData, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
9934
10355
|
/**
|
|
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
|
|
10356
|
+
* 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.
|
|
10357
|
+
* @summary Delete Coordinate System
|
|
9937
10358
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
9938
10359
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
9939
10360
|
* @param {string} coordinateSystem Unique identifier addressing a coordinate system.
|
|
@@ -9944,7 +10365,7 @@ export declare class VirtualControllerApi extends BaseAPI {
|
|
|
9944
10365
|
*/
|
|
9945
10366
|
deleteVirtualControllerCoordinateSystem(cell: string, controller: string, coordinateSystem: string, deleteDependent?: boolean, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
9946
10367
|
/**
|
|
9947
|
-
* Removes the TCP from the motion group. An unknown TCP is a valid input.
|
|
10368
|
+
* 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
10369
|
* @summary Remove TCP
|
|
9949
10370
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
9950
10371
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -10063,7 +10484,7 @@ export declare class VirtualControllerApi extends BaseAPI {
|
|
|
10063
10484
|
*/
|
|
10064
10485
|
setOperationMode(cell: string, controller: string, mode: OperationMode, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
10065
10486
|
/**
|
|
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
|
|
10487
|
+
* 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
10488
|
* @summary Set Mounting
|
|
10068
10489
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
10069
10490
|
* @param {string} controller Unique identifier to address a controller in the cell.
|