@wandelbots/nova-api 25.8.0-dev.6 → 25.8.0-dev.61
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 +1 -1
- package/v1/api.js +1 -1
- package/v1/api.js.map +1 -1
- package/v1/api.ts +1 -1
- package/v2/api.d.ts +565 -152
- package/v2/api.js +402 -51
- package/v2/api.js.map +1 -1
- package/v2/api.ts +774 -148
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
|
*/
|
|
@@ -2691,25 +2735,6 @@ export declare const LicenseStatusEnum: {
|
|
|
2691
2735
|
readonly NotFound: "NOT_FOUND";
|
|
2692
2736
|
};
|
|
2693
2737
|
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
2738
|
/**
|
|
2714
2739
|
* The upper_limit must be greater then the lower_limit.
|
|
2715
2740
|
* @export
|
|
@@ -2759,6 +2784,12 @@ export interface LimitSet {
|
|
|
2759
2784
|
* @memberof LimitSet
|
|
2760
2785
|
*/
|
|
2761
2786
|
'flange'?: CartesianLimits;
|
|
2787
|
+
/**
|
|
2788
|
+
*
|
|
2789
|
+
* @type {JointLimits}
|
|
2790
|
+
* @memberof LimitSet
|
|
2791
|
+
*/
|
|
2792
|
+
'coupled_shoulder_elbow_joint'?: JointLimits;
|
|
2762
2793
|
}
|
|
2763
2794
|
/**
|
|
2764
2795
|
* If a limit is not set, the default value will be used.
|
|
@@ -2830,13 +2861,13 @@ export declare const Manufacturer: {
|
|
|
2830
2861
|
};
|
|
2831
2862
|
export type Manufacturer = typeof Manufacturer[keyof typeof Manufacturer];
|
|
2832
2863
|
/**
|
|
2833
|
-
*
|
|
2864
|
+
*
|
|
2834
2865
|
* @export
|
|
2835
2866
|
* @interface MidpointInsertionAlgorithm
|
|
2836
2867
|
*/
|
|
2837
2868
|
export interface MidpointInsertionAlgorithm {
|
|
2838
2869
|
/**
|
|
2839
|
-
* Algorithm discriminator.
|
|
2870
|
+
* 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
2871
|
* @type {string}
|
|
2841
2872
|
* @memberof MidpointInsertionAlgorithm
|
|
2842
2873
|
*/
|
|
@@ -2924,13 +2955,13 @@ export interface MotionGroupDescription {
|
|
|
2924
2955
|
* @type {Pose}
|
|
2925
2956
|
* @memberof MotionGroupDescription
|
|
2926
2957
|
*/
|
|
2927
|
-
'mounting'
|
|
2958
|
+
'mounting'?: Pose;
|
|
2928
2959
|
/**
|
|
2929
2960
|
* Maps a TCP name to its offset relative to the flange coordinate system. Key must be a TCP identifier. Values are TcpOffsets.
|
|
2930
2961
|
* @type {{ [key: string]: TcpOffset; }}
|
|
2931
2962
|
* @memberof MotionGroupDescription
|
|
2932
2963
|
*/
|
|
2933
|
-
'tcps'
|
|
2964
|
+
'tcps'?: {
|
|
2934
2965
|
[key: string]: TcpOffset;
|
|
2935
2966
|
};
|
|
2936
2967
|
/**
|
|
@@ -2961,10 +2992,10 @@ export interface MotionGroupDescription {
|
|
|
2961
2992
|
};
|
|
2962
2993
|
/**
|
|
2963
2994
|
*
|
|
2964
|
-
* @type {
|
|
2995
|
+
* @type {OperationLimits}
|
|
2965
2996
|
* @memberof MotionGroupDescription
|
|
2966
2997
|
*/
|
|
2967
|
-
'
|
|
2998
|
+
'operation_limits': OperationLimits;
|
|
2968
2999
|
/**
|
|
2969
3000
|
* Maps a payload name to its configuration. Key must be a payload identifier. Values are payload objects.
|
|
2970
3001
|
* @type {{ [key: string]: Payload; }}
|
|
@@ -3697,11 +3728,11 @@ export interface PlanTrajectoryFailedResponse {
|
|
|
3697
3728
|
*/
|
|
3698
3729
|
'error_feedback': PlanTrajectoryFailedResponseErrorFeedback;
|
|
3699
3730
|
/**
|
|
3700
|
-
*
|
|
3731
|
+
* 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
3732
|
* @type {number}
|
|
3702
3733
|
* @memberof PlanTrajectoryFailedResponse
|
|
3703
3734
|
*/
|
|
3704
|
-
'error_location_on_trajectory'
|
|
3735
|
+
'error_location_on_trajectory': number;
|
|
3705
3736
|
/**
|
|
3706
3737
|
* The joint trajectory from the start joint position to the error.
|
|
3707
3738
|
* @type {JointTrajectory}
|
|
@@ -3915,17 +3946,17 @@ export interface ProfinetDescription {
|
|
|
3915
3946
|
*/
|
|
3916
3947
|
'slots'?: Array<ProfinetSlotDescription>;
|
|
3917
3948
|
/**
|
|
3918
|
-
* Name of the PROFINET device
|
|
3949
|
+
* 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
3950
|
* @type {string}
|
|
3920
3951
|
* @memberof ProfinetDescription
|
|
3921
3952
|
*/
|
|
3922
3953
|
'device_name'?: string;
|
|
3923
3954
|
/**
|
|
3924
|
-
*
|
|
3925
|
-
* @type {
|
|
3955
|
+
*
|
|
3956
|
+
* @type {BusIOProfinetIpConfig}
|
|
3926
3957
|
* @memberof ProfinetDescription
|
|
3927
3958
|
*/
|
|
3928
|
-
'
|
|
3959
|
+
'ip_config'?: BusIOProfinetIpConfig;
|
|
3929
3960
|
}
|
|
3930
3961
|
/**
|
|
3931
3962
|
*
|
|
@@ -3934,7 +3965,7 @@ export interface ProfinetDescription {
|
|
|
3934
3965
|
*/
|
|
3935
3966
|
export interface ProfinetIO {
|
|
3936
3967
|
/**
|
|
3937
|
-
* The name of the input/output
|
|
3968
|
+
* 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
3969
|
* @type {string}
|
|
3939
3970
|
* @memberof ProfinetIO
|
|
3940
3971
|
*/
|
|
@@ -3946,25 +3977,25 @@ export interface ProfinetIO {
|
|
|
3946
3977
|
*/
|
|
3947
3978
|
'type': ProfinetIOTypeEnum;
|
|
3948
3979
|
/**
|
|
3949
|
-
* The direction of the input/output
|
|
3980
|
+
* 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
3981
|
* @type {ProfinetIODirection}
|
|
3951
3982
|
* @memberof ProfinetIO
|
|
3952
3983
|
*/
|
|
3953
3984
|
'direction': ProfinetIODirection;
|
|
3954
3985
|
/**
|
|
3955
|
-
* The byte address of the input/output
|
|
3986
|
+
* 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
3987
|
* @type {number}
|
|
3957
3988
|
* @memberof ProfinetIO
|
|
3958
3989
|
*/
|
|
3959
3990
|
'byte_address': number;
|
|
3960
3991
|
/**
|
|
3961
|
-
* The bit address of the input/output
|
|
3992
|
+
* 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
3993
|
* @type {number}
|
|
3963
3994
|
* @memberof ProfinetIO
|
|
3964
3995
|
*/
|
|
3965
3996
|
'bit_address'?: number;
|
|
3966
3997
|
/**
|
|
3967
|
-
* The unique identifier for the input/output value. This identifier is used to reference the specific input/output in the NOVA
|
|
3998
|
+
* 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
3999
|
* @type {string}
|
|
3969
4000
|
* @memberof ProfinetIO
|
|
3970
4001
|
*/
|
|
@@ -3977,7 +4008,7 @@ export interface ProfinetIO {
|
|
|
3977
4008
|
*/
|
|
3978
4009
|
export interface ProfinetIOData {
|
|
3979
4010
|
/**
|
|
3980
|
-
* The name of the input/output
|
|
4011
|
+
* 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
4012
|
* @type {string}
|
|
3982
4013
|
* @memberof ProfinetIOData
|
|
3983
4014
|
*/
|
|
@@ -3989,26 +4020,26 @@ export interface ProfinetIOData {
|
|
|
3989
4020
|
*/
|
|
3990
4021
|
'type': ProfinetIOTypeEnum;
|
|
3991
4022
|
/**
|
|
3992
|
-
* The direction of the input/output
|
|
4023
|
+
* 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
4024
|
* @type {ProfinetIODirection}
|
|
3994
4025
|
* @memberof ProfinetIOData
|
|
3995
4026
|
*/
|
|
3996
4027
|
'direction': ProfinetIODirection;
|
|
3997
4028
|
/**
|
|
3998
|
-
* The byte address of the input/output
|
|
4029
|
+
* 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
4030
|
* @type {number}
|
|
4000
4031
|
* @memberof ProfinetIOData
|
|
4001
4032
|
*/
|
|
4002
4033
|
'byte_address': number;
|
|
4003
4034
|
/**
|
|
4004
|
-
* The bit address of the input/output
|
|
4035
|
+
* 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
4036
|
* @type {number}
|
|
4006
4037
|
* @memberof ProfinetIOData
|
|
4007
4038
|
*/
|
|
4008
4039
|
'bit_address'?: number;
|
|
4009
4040
|
}
|
|
4010
4041
|
/**
|
|
4011
|
-
*
|
|
4042
|
+
* 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
4043
|
* @export
|
|
4013
4044
|
* @enum {string}
|
|
4014
4045
|
*/
|
|
@@ -4019,7 +4050,7 @@ export declare const ProfinetIODirection: {
|
|
|
4019
4050
|
};
|
|
4020
4051
|
export type ProfinetIODirection = typeof ProfinetIODirection[keyof typeof ProfinetIODirection];
|
|
4021
4052
|
/**
|
|
4022
|
-
* Value type of the PROFINET input/output.
|
|
4053
|
+
* Value type of the PROFINET input/output variable. Is used to interpret the corresponding bits correctly.
|
|
4023
4054
|
* @export
|
|
4024
4055
|
* @enum {string}
|
|
4025
4056
|
*/
|
|
@@ -4043,38 +4074,38 @@ export type ProfinetIOTypeEnum = typeof ProfinetIOTypeEnum[keyof typeof Profinet
|
|
|
4043
4074
|
*/
|
|
4044
4075
|
export interface ProfinetInputOutputConfig {
|
|
4045
4076
|
/**
|
|
4046
|
-
* Content of the input
|
|
4077
|
+
* 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
4078
|
* @type {string}
|
|
4048
4079
|
* @memberof ProfinetInputOutputConfig
|
|
4049
4080
|
*/
|
|
4050
4081
|
'config': string;
|
|
4051
4082
|
/**
|
|
4052
|
-
* Offset in bytes for the input
|
|
4083
|
+
* 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
4084
|
* @type {number}
|
|
4054
4085
|
* @memberof ProfinetInputOutputConfig
|
|
4055
4086
|
*/
|
|
4056
4087
|
'input_offset': number;
|
|
4057
4088
|
/**
|
|
4058
|
-
* Offset in bytes for the output
|
|
4089
|
+
* 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
4090
|
* @type {number}
|
|
4060
4091
|
* @memberof ProfinetInputOutputConfig
|
|
4061
4092
|
*/
|
|
4062
4093
|
'output_offset': number;
|
|
4063
4094
|
}
|
|
4064
4095
|
/**
|
|
4065
|
-
*
|
|
4096
|
+
* 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
4097
|
* @export
|
|
4067
4098
|
* @interface ProfinetSlotDescription
|
|
4068
4099
|
*/
|
|
4069
4100
|
export interface ProfinetSlotDescription {
|
|
4070
4101
|
/**
|
|
4071
|
-
* The number of the PROFINET slot.
|
|
4102
|
+
* 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
4103
|
* @type {number}
|
|
4073
4104
|
* @memberof ProfinetSlotDescription
|
|
4074
4105
|
*/
|
|
4075
4106
|
'number': number;
|
|
4076
4107
|
/**
|
|
4077
|
-
* The API number of the PROFINET input
|
|
4108
|
+
* The application process identifier (API) number of the PROFINET input. The API identifies the application relation (AR) that is using the slot.
|
|
4078
4109
|
* @type {number}
|
|
4079
4110
|
* @memberof ProfinetSlotDescription
|
|
4080
4111
|
*/
|
|
@@ -4093,32 +4124,174 @@ export interface ProfinetSlotDescription {
|
|
|
4093
4124
|
*/
|
|
4094
4125
|
export interface ProfinetSubSlotDescription {
|
|
4095
4126
|
/**
|
|
4096
|
-
* The
|
|
4127
|
+
* The number/index of the PROFINET subslot.
|
|
4097
4128
|
* @type {number}
|
|
4098
4129
|
* @memberof ProfinetSubSlotDescription
|
|
4099
4130
|
*/
|
|
4100
4131
|
'number': number;
|
|
4101
4132
|
/**
|
|
4102
|
-
* The
|
|
4133
|
+
* The amount of bytes allocated for the subslot in the input process image buffer.
|
|
4103
4134
|
* @type {number}
|
|
4104
4135
|
* @memberof ProfinetSubSlotDescription
|
|
4105
4136
|
*/
|
|
4106
4137
|
'input_length': number;
|
|
4107
4138
|
/**
|
|
4108
|
-
* The
|
|
4139
|
+
* The amount of bytes allocated for the subslot in the output process image buffer.
|
|
4109
4140
|
* @type {number}
|
|
4110
4141
|
* @memberof ProfinetSubSlotDescription
|
|
4111
4142
|
*/
|
|
4112
4143
|
'output_length': number;
|
|
4113
4144
|
}
|
|
4114
4145
|
/**
|
|
4115
|
-
*
|
|
4146
|
+
* A program is a collection of instructions that are executed in the robot cell.
|
|
4147
|
+
* @export
|
|
4148
|
+
* @interface Program
|
|
4149
|
+
*/
|
|
4150
|
+
export interface Program {
|
|
4151
|
+
/**
|
|
4152
|
+
*
|
|
4153
|
+
* @type {string}
|
|
4154
|
+
* @memberof Program
|
|
4155
|
+
*/
|
|
4156
|
+
'program': string;
|
|
4157
|
+
/**
|
|
4158
|
+
*
|
|
4159
|
+
* @type {string}
|
|
4160
|
+
* @memberof Program
|
|
4161
|
+
*/
|
|
4162
|
+
'name'?: string;
|
|
4163
|
+
/**
|
|
4164
|
+
*
|
|
4165
|
+
* @type {string}
|
|
4166
|
+
* @memberof Program
|
|
4167
|
+
*/
|
|
4168
|
+
'description'?: string;
|
|
4169
|
+
/**
|
|
4170
|
+
*
|
|
4171
|
+
* @type {string}
|
|
4172
|
+
* @memberof Program
|
|
4173
|
+
*/
|
|
4174
|
+
'app': string;
|
|
4175
|
+
/**
|
|
4176
|
+
*
|
|
4177
|
+
* @type {object}
|
|
4178
|
+
* @memberof Program
|
|
4179
|
+
*/
|
|
4180
|
+
'input_schema'?: object;
|
|
4181
|
+
/**
|
|
4182
|
+
*
|
|
4183
|
+
* @type {object}
|
|
4184
|
+
* @memberof Program
|
|
4185
|
+
*/
|
|
4186
|
+
'preconditions'?: object;
|
|
4187
|
+
}
|
|
4188
|
+
/**
|
|
4189
|
+
* Holds the state of a program run.
|
|
4190
|
+
* @export
|
|
4191
|
+
* @interface ProgramRun
|
|
4192
|
+
*/
|
|
4193
|
+
export interface ProgramRun {
|
|
4194
|
+
/**
|
|
4195
|
+
* Unique identifier of the program run
|
|
4196
|
+
* @type {string}
|
|
4197
|
+
* @memberof ProgramRun
|
|
4198
|
+
*/
|
|
4199
|
+
'run': string;
|
|
4200
|
+
/**
|
|
4201
|
+
* Unique identifier of the program
|
|
4202
|
+
* @type {string}
|
|
4203
|
+
* @memberof ProgramRun
|
|
4204
|
+
*/
|
|
4205
|
+
'program': string;
|
|
4206
|
+
/**
|
|
4207
|
+
* State of the program run
|
|
4208
|
+
* @type {ProgramRunState}
|
|
4209
|
+
* @memberof ProgramRun
|
|
4210
|
+
*/
|
|
4211
|
+
'state': ProgramRunState;
|
|
4212
|
+
/**
|
|
4213
|
+
* Logs of the program run
|
|
4214
|
+
* @type {string}
|
|
4215
|
+
* @memberof ProgramRun
|
|
4216
|
+
*/
|
|
4217
|
+
'logs'?: string;
|
|
4218
|
+
/**
|
|
4219
|
+
* Stdout of the program run
|
|
4220
|
+
* @type {string}
|
|
4221
|
+
* @memberof ProgramRun
|
|
4222
|
+
*/
|
|
4223
|
+
'stdout'?: string;
|
|
4224
|
+
/**
|
|
4225
|
+
* Stderr of the program run
|
|
4226
|
+
* @type {string}
|
|
4227
|
+
* @memberof ProgramRun
|
|
4228
|
+
*/
|
|
4229
|
+
'stderr'?: string;
|
|
4230
|
+
/**
|
|
4231
|
+
* Error message of the program run, if any
|
|
4232
|
+
* @type {string}
|
|
4233
|
+
* @memberof ProgramRun
|
|
4234
|
+
*/
|
|
4235
|
+
'error'?: string;
|
|
4236
|
+
/**
|
|
4237
|
+
* Traceback of the program run, if any
|
|
4238
|
+
* @type {string}
|
|
4239
|
+
* @memberof ProgramRun
|
|
4240
|
+
*/
|
|
4241
|
+
'traceback'?: string;
|
|
4242
|
+
/**
|
|
4243
|
+
* Start time of the program run
|
|
4244
|
+
* @type {string}
|
|
4245
|
+
* @memberof ProgramRun
|
|
4246
|
+
*/
|
|
4247
|
+
'start_time'?: string;
|
|
4248
|
+
/**
|
|
4249
|
+
* End time of the program run
|
|
4250
|
+
* @type {string}
|
|
4251
|
+
* @memberof ProgramRun
|
|
4252
|
+
*/
|
|
4253
|
+
'end_time'?: string;
|
|
4254
|
+
/**
|
|
4255
|
+
* Input data of the program run
|
|
4256
|
+
* @type {object}
|
|
4257
|
+
* @memberof ProgramRun
|
|
4258
|
+
*/
|
|
4259
|
+
'input_data'?: object;
|
|
4260
|
+
}
|
|
4261
|
+
/**
|
|
4262
|
+
* The state of a program run.
|
|
4263
|
+
* @export
|
|
4264
|
+
* @enum {string}
|
|
4265
|
+
*/
|
|
4266
|
+
export declare const ProgramRunState: {
|
|
4267
|
+
readonly Preparing: "PREPARING";
|
|
4268
|
+
readonly Running: "RUNNING";
|
|
4269
|
+
readonly Completed: "COMPLETED";
|
|
4270
|
+
readonly Failed: "FAILED";
|
|
4271
|
+
readonly Stopped: "STOPPED";
|
|
4272
|
+
};
|
|
4273
|
+
export type ProgramRunState = typeof ProgramRunState[keyof typeof ProgramRunState];
|
|
4274
|
+
/**
|
|
4275
|
+
* The state of a program run.
|
|
4276
|
+
* @export
|
|
4277
|
+
* @interface ProgramStartRequest
|
|
4278
|
+
*/
|
|
4279
|
+
export interface ProgramStartRequest {
|
|
4280
|
+
/**
|
|
4281
|
+
* The arguments to pass to the program.
|
|
4282
|
+
* @type {object}
|
|
4283
|
+
* @memberof ProgramStartRequest
|
|
4284
|
+
*/
|
|
4285
|
+
'arguments': object;
|
|
4286
|
+
}
|
|
4287
|
+
/**
|
|
4288
|
+
*
|
|
4116
4289
|
* @export
|
|
4117
4290
|
* @interface RRTConnectAlgorithm
|
|
4118
4291
|
*/
|
|
4119
4292
|
export interface RRTConnectAlgorithm {
|
|
4120
4293
|
/**
|
|
4121
|
-
* Algorithm discriminator.
|
|
4294
|
+
* 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
4295
|
* @type {string}
|
|
4123
4296
|
* @memberof RRTConnectAlgorithm
|
|
4124
4297
|
*/
|
|
@@ -4129,6 +4302,30 @@ export interface RRTConnectAlgorithm {
|
|
|
4129
4302
|
* @memberof RRTConnectAlgorithm
|
|
4130
4303
|
*/
|
|
4131
4304
|
'max_iterations'?: number;
|
|
4305
|
+
/**
|
|
4306
|
+
* Maximum step size for tree extension in joint space.
|
|
4307
|
+
* @type {number}
|
|
4308
|
+
* @memberof RRTConnectAlgorithm
|
|
4309
|
+
*/
|
|
4310
|
+
'max_step_size'?: number;
|
|
4311
|
+
/**
|
|
4312
|
+
* Adjust the maximum step size during the search based on the recent success rate of tree expansion.
|
|
4313
|
+
* @type {boolean}
|
|
4314
|
+
* @memberof RRTConnectAlgorithm
|
|
4315
|
+
*/
|
|
4316
|
+
'adaptive_step_size'?: boolean;
|
|
4317
|
+
/**
|
|
4318
|
+
* Apply smoothing after the search has succeeded. This will remove as many intermediate points as possible while keeping the path valid.
|
|
4319
|
+
* @type {boolean}
|
|
4320
|
+
* @memberof RRTConnectAlgorithm
|
|
4321
|
+
*/
|
|
4322
|
+
'apply_smoothing'?: boolean;
|
|
4323
|
+
/**
|
|
4324
|
+
* Apply blending after the search has succeeded and smoothing has been applied. This will apply the largest viable blending at each intermediate point.
|
|
4325
|
+
* @type {boolean}
|
|
4326
|
+
* @memberof RRTConnectAlgorithm
|
|
4327
|
+
*/
|
|
4328
|
+
'apply_blending'?: boolean;
|
|
4132
4329
|
}
|
|
4133
4330
|
export declare const RRTConnectAlgorithmAlgorithmNameEnum: {
|
|
4134
4331
|
readonly RrtConnectAlgorithm: "RRTConnectAlgorithm";
|
|
@@ -4512,6 +4709,25 @@ export interface ServiceStatusStatus {
|
|
|
4512
4709
|
*/
|
|
4513
4710
|
'reason'?: string;
|
|
4514
4711
|
}
|
|
4712
|
+
/**
|
|
4713
|
+
* Defines an input/output that should be set upon reaching a specified location on the trajectory.
|
|
4714
|
+
* @export
|
|
4715
|
+
* @interface SetIO
|
|
4716
|
+
*/
|
|
4717
|
+
export interface SetIO {
|
|
4718
|
+
/**
|
|
4719
|
+
*
|
|
4720
|
+
* @type {IOValue}
|
|
4721
|
+
* @memberof SetIO
|
|
4722
|
+
*/
|
|
4723
|
+
'io': IOValue;
|
|
4724
|
+
/**
|
|
4725
|
+
* The location on the trajectory where the input/output should be set.
|
|
4726
|
+
* @type {number}
|
|
4727
|
+
* @memberof SetIO
|
|
4728
|
+
*/
|
|
4729
|
+
'location': number;
|
|
4730
|
+
}
|
|
4515
4731
|
/**
|
|
4516
4732
|
*
|
|
4517
4733
|
* @export
|
|
@@ -4576,10 +4792,10 @@ export interface StartMovementRequest {
|
|
|
4576
4792
|
'direction'?: Direction;
|
|
4577
4793
|
/**
|
|
4578
4794
|
* 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<
|
|
4795
|
+
* @type {Array<SetIO>}
|
|
4580
4796
|
* @memberof StartMovementRequest
|
|
4581
4797
|
*/
|
|
4582
|
-
'set_outputs'?: Array<
|
|
4798
|
+
'set_outputs'?: Array<SetIO>;
|
|
4583
4799
|
/**
|
|
4584
4800
|
* Defines an input/output that is listened to before the movement. Execution starts if the defined comparator evaluates to `true`.
|
|
4585
4801
|
* @type {StartOnIO}
|
|
@@ -4834,7 +5050,7 @@ export interface TrajectoryDetails {
|
|
|
4834
5050
|
*/
|
|
4835
5051
|
'trajectory': string;
|
|
4836
5052
|
/**
|
|
4837
|
-
*
|
|
5053
|
+
* 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
5054
|
* @type {number}
|
|
4839
5055
|
* @memberof TrajectoryDetails
|
|
4840
5056
|
*/
|
|
@@ -4899,7 +5115,7 @@ export interface TrajectoryId {
|
|
|
4899
5115
|
* @type {string}
|
|
4900
5116
|
* @memberof TrajectoryId
|
|
4901
5117
|
*/
|
|
4902
|
-
'message_type'
|
|
5118
|
+
'message_type': TrajectoryIdMessageTypeEnum;
|
|
4903
5119
|
/**
|
|
4904
5120
|
* The identifier of the trajectory which was returned by the [addTrajectory](addTrajectory) endpoint.
|
|
4905
5121
|
* @type {string}
|
|
@@ -5072,6 +5288,31 @@ export interface ValidationError {
|
|
|
5072
5288
|
[key: string]: any;
|
|
5073
5289
|
};
|
|
5074
5290
|
}
|
|
5291
|
+
/**
|
|
5292
|
+
* A validation error of a program.
|
|
5293
|
+
* @export
|
|
5294
|
+
* @interface ValidationError2
|
|
5295
|
+
*/
|
|
5296
|
+
export interface ValidationError2 {
|
|
5297
|
+
/**
|
|
5298
|
+
*
|
|
5299
|
+
* @type {Array<number>}
|
|
5300
|
+
* @memberof ValidationError2
|
|
5301
|
+
*/
|
|
5302
|
+
'loc': Array<number>;
|
|
5303
|
+
/**
|
|
5304
|
+
*
|
|
5305
|
+
* @type {string}
|
|
5306
|
+
* @memberof ValidationError2
|
|
5307
|
+
*/
|
|
5308
|
+
'msg': string;
|
|
5309
|
+
/**
|
|
5310
|
+
*
|
|
5311
|
+
* @type {string}
|
|
5312
|
+
* @memberof ValidationError2
|
|
5313
|
+
*/
|
|
5314
|
+
'type': string;
|
|
5315
|
+
}
|
|
5075
5316
|
/**
|
|
5076
5317
|
* @type ValidationErrorLocInner
|
|
5077
5318
|
* @export
|
|
@@ -5562,7 +5803,7 @@ export declare class ApplicationApi extends BaseAPI {
|
|
|
5562
5803
|
*/
|
|
5563
5804
|
export declare const BUSInputsOutputsApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
5564
5805
|
/**
|
|
5565
|
-
* Add
|
|
5806
|
+
* Add the BUS inputs/outputs service to the cell. Starts a containerized service that enables BUS connections via the specified ethernet port.
|
|
5566
5807
|
* @summary Add Service
|
|
5567
5808
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5568
5809
|
* @param {BusIOType} busIOType
|
|
@@ -5572,7 +5813,7 @@ export declare const BUSInputsOutputsApiAxiosParamCreator: (configuration?: Conf
|
|
|
5572
5813
|
*/
|
|
5573
5814
|
addBusIOService: (cell: string, busIOType: BusIOType, completionTimeout?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
5574
5815
|
/**
|
|
5575
|
-
* Adds an input/output to or updates an input/output on the PROFINET device.
|
|
5816
|
+
* 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
5817
|
* @summary Add PROFINET Input/Output
|
|
5577
5818
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5578
5819
|
* @param {string} io Unique identifier to address an Input/Output in the cell.
|
|
@@ -5582,7 +5823,7 @@ export declare const BUSInputsOutputsApiAxiosParamCreator: (configuration?: Conf
|
|
|
5582
5823
|
*/
|
|
5583
5824
|
addProfinetIO: (cell: string, io: string, profinetIOData: ProfinetIOData, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
5584
5825
|
/**
|
|
5585
|
-
*
|
|
5826
|
+
* Remove the BUS inputs/outputs service from the cell.
|
|
5586
5827
|
* @summary Clear Service
|
|
5587
5828
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5588
5829
|
* @param {number} [completionTimeout]
|
|
@@ -5591,7 +5832,7 @@ export declare const BUSInputsOutputsApiAxiosParamCreator: (configuration?: Conf
|
|
|
5591
5832
|
*/
|
|
5592
5833
|
clearBusIOService: (cell: string, completionTimeout?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
5593
5834
|
/**
|
|
5594
|
-
* Removes
|
|
5835
|
+
* Removes an input/output variable configuration from the PROFINET device, e.g. NOVA\'s PROFINET service.
|
|
5595
5836
|
* @summary Remove PROFINET Input/Ouptut
|
|
5596
5837
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5597
5838
|
* @param {string} io Unique identifier to address an Input/Output in the cell.
|
|
@@ -5600,7 +5841,7 @@ export declare const BUSInputsOutputsApiAxiosParamCreator: (configuration?: Conf
|
|
|
5600
5841
|
*/
|
|
5601
5842
|
deleteProfinetIO: (cell: string, io: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
5602
5843
|
/**
|
|
5603
|
-
* Get deployed BUS
|
|
5844
|
+
* Get deployed BUS inputs/outputs service.
|
|
5604
5845
|
* @summary Get Service
|
|
5605
5846
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5606
5847
|
* @param {*} [options] Override http request option.
|
|
@@ -5625,7 +5866,7 @@ export declare const BUSInputsOutputsApiAxiosParamCreator: (configuration?: Conf
|
|
|
5625
5866
|
*/
|
|
5626
5867
|
getBusIOValues: (cell: string, ios?: Array<string>, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
5627
5868
|
/**
|
|
5628
|
-
* Get description of PROFINET
|
|
5869
|
+
* Get description of NOVA as a PROFINET device.
|
|
5629
5870
|
* @summary Get PROFINET Description
|
|
5630
5871
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5631
5872
|
* @param {*} [options] Override http request option.
|
|
@@ -5633,7 +5874,7 @@ export declare const BUSInputsOutputsApiAxiosParamCreator: (configuration?: Conf
|
|
|
5633
5874
|
*/
|
|
5634
5875
|
getProfinetDescription: (cell: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
5635
5876
|
/**
|
|
5636
|
-
* Get input/output configuration of the PROFINET device as file.
|
|
5877
|
+
* 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
5878
|
* @summary PROFINET Inputs/Outputs to File
|
|
5638
5879
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5639
5880
|
* @param {number} [inputOffset]
|
|
@@ -5643,7 +5884,7 @@ export declare const BUSInputsOutputsApiAxiosParamCreator: (configuration?: Conf
|
|
|
5643
5884
|
*/
|
|
5644
5885
|
getProfinetIOsFromFile: (cell: string, inputOffset?: number, outputOffset?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
5645
5886
|
/**
|
|
5646
|
-
* List all BUS
|
|
5887
|
+
* 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
5888
|
* @summary List Descriptions
|
|
5648
5889
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5649
5890
|
* @param {*} [options] Override http request option.
|
|
@@ -5651,7 +5892,7 @@ export declare const BUSInputsOutputsApiAxiosParamCreator: (configuration?: Conf
|
|
|
5651
5892
|
*/
|
|
5652
5893
|
listBusIODescriptions: (cell: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
5653
5894
|
/**
|
|
5654
|
-
* List all PROFINET input and
|
|
5895
|
+
* 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
5896
|
* @summary List PROFINET Input/Output Configuration
|
|
5656
5897
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5657
5898
|
* @param {*} [options] Override http request option.
|
|
@@ -5668,7 +5909,7 @@ export declare const BUSInputsOutputsApiAxiosParamCreator: (configuration?: Conf
|
|
|
5668
5909
|
*/
|
|
5669
5910
|
setBusIOValues: (cell: string, iOValue: Array<IOValue>, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
5670
5911
|
/**
|
|
5671
|
-
* Sets inputs/outputs
|
|
5912
|
+
* 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
5913
|
* @summary Set PROFINET Inputs/Outputs from File
|
|
5673
5914
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5674
5915
|
* @param {ProfinetInputOutputConfig} profinetInputOutputConfig
|
|
@@ -5683,7 +5924,7 @@ export declare const BUSInputsOutputsApiAxiosParamCreator: (configuration?: Conf
|
|
|
5683
5924
|
*/
|
|
5684
5925
|
export declare const BUSInputsOutputsApiFp: (configuration?: Configuration) => {
|
|
5685
5926
|
/**
|
|
5686
|
-
* Add
|
|
5927
|
+
* Add the BUS inputs/outputs service to the cell. Starts a containerized service that enables BUS connections via the specified ethernet port.
|
|
5687
5928
|
* @summary Add Service
|
|
5688
5929
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5689
5930
|
* @param {BusIOType} busIOType
|
|
@@ -5693,7 +5934,7 @@ export declare const BUSInputsOutputsApiFp: (configuration?: Configuration) => {
|
|
|
5693
5934
|
*/
|
|
5694
5935
|
addBusIOService(cell: string, busIOType: BusIOType, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
5695
5936
|
/**
|
|
5696
|
-
* Adds an input/output to or updates an input/output on the PROFINET device.
|
|
5937
|
+
* 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
5938
|
* @summary Add PROFINET Input/Output
|
|
5698
5939
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5699
5940
|
* @param {string} io Unique identifier to address an Input/Output in the cell.
|
|
@@ -5703,7 +5944,7 @@ export declare const BUSInputsOutputsApiFp: (configuration?: Configuration) => {
|
|
|
5703
5944
|
*/
|
|
5704
5945
|
addProfinetIO(cell: string, io: string, profinetIOData: ProfinetIOData, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
5705
5946
|
/**
|
|
5706
|
-
*
|
|
5947
|
+
* Remove the BUS inputs/outputs service from the cell.
|
|
5707
5948
|
* @summary Clear Service
|
|
5708
5949
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5709
5950
|
* @param {number} [completionTimeout]
|
|
@@ -5712,7 +5953,7 @@ export declare const BUSInputsOutputsApiFp: (configuration?: Configuration) => {
|
|
|
5712
5953
|
*/
|
|
5713
5954
|
clearBusIOService(cell: string, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
5714
5955
|
/**
|
|
5715
|
-
* Removes
|
|
5956
|
+
* Removes an input/output variable configuration from the PROFINET device, e.g. NOVA\'s PROFINET service.
|
|
5716
5957
|
* @summary Remove PROFINET Input/Ouptut
|
|
5717
5958
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5718
5959
|
* @param {string} io Unique identifier to address an Input/Output in the cell.
|
|
@@ -5721,7 +5962,7 @@ export declare const BUSInputsOutputsApiFp: (configuration?: Configuration) => {
|
|
|
5721
5962
|
*/
|
|
5722
5963
|
deleteProfinetIO(cell: string, io: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
5723
5964
|
/**
|
|
5724
|
-
* Get deployed BUS
|
|
5965
|
+
* Get deployed BUS inputs/outputs service.
|
|
5725
5966
|
* @summary Get Service
|
|
5726
5967
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5727
5968
|
* @param {*} [options] Override http request option.
|
|
@@ -5746,7 +5987,7 @@ export declare const BUSInputsOutputsApiFp: (configuration?: Configuration) => {
|
|
|
5746
5987
|
*/
|
|
5747
5988
|
getBusIOValues(cell: string, ios?: Array<string>, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<IOValue>>>;
|
|
5748
5989
|
/**
|
|
5749
|
-
* Get description of PROFINET
|
|
5990
|
+
* Get description of NOVA as a PROFINET device.
|
|
5750
5991
|
* @summary Get PROFINET Description
|
|
5751
5992
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5752
5993
|
* @param {*} [options] Override http request option.
|
|
@@ -5754,7 +5995,7 @@ export declare const BUSInputsOutputsApiFp: (configuration?: Configuration) => {
|
|
|
5754
5995
|
*/
|
|
5755
5996
|
getProfinetDescription(cell: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ProfinetDescription>>;
|
|
5756
5997
|
/**
|
|
5757
|
-
* Get input/output configuration of the PROFINET device as file.
|
|
5998
|
+
* 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
5999
|
* @summary PROFINET Inputs/Outputs to File
|
|
5759
6000
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5760
6001
|
* @param {number} [inputOffset]
|
|
@@ -5764,15 +6005,15 @@ export declare const BUSInputsOutputsApiFp: (configuration?: Configuration) => {
|
|
|
5764
6005
|
*/
|
|
5765
6006
|
getProfinetIOsFromFile(cell: string, inputOffset?: number, outputOffset?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<string>>;
|
|
5766
6007
|
/**
|
|
5767
|
-
* List all BUS
|
|
6008
|
+
* 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
6009
|
* @summary List Descriptions
|
|
5769
6010
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5770
6011
|
* @param {*} [options] Override http request option.
|
|
5771
6012
|
* @throws {RequiredError}
|
|
5772
6013
|
*/
|
|
5773
|
-
listBusIODescriptions(cell: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<
|
|
6014
|
+
listBusIODescriptions(cell: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<IODescription2>>>;
|
|
5774
6015
|
/**
|
|
5775
|
-
* List all PROFINET input and
|
|
6016
|
+
* 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
6017
|
* @summary List PROFINET Input/Output Configuration
|
|
5777
6018
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5778
6019
|
* @param {*} [options] Override http request option.
|
|
@@ -5789,7 +6030,7 @@ export declare const BUSInputsOutputsApiFp: (configuration?: Configuration) => {
|
|
|
5789
6030
|
*/
|
|
5790
6031
|
setBusIOValues(cell: string, iOValue: Array<IOValue>, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
5791
6032
|
/**
|
|
5792
|
-
* Sets inputs/outputs
|
|
6033
|
+
* 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
6034
|
* @summary Set PROFINET Inputs/Outputs from File
|
|
5794
6035
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5795
6036
|
* @param {ProfinetInputOutputConfig} profinetInputOutputConfig
|
|
@@ -5804,7 +6045,7 @@ export declare const BUSInputsOutputsApiFp: (configuration?: Configuration) => {
|
|
|
5804
6045
|
*/
|
|
5805
6046
|
export declare const BUSInputsOutputsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
5806
6047
|
/**
|
|
5807
|
-
* Add
|
|
6048
|
+
* Add the BUS inputs/outputs service to the cell. Starts a containerized service that enables BUS connections via the specified ethernet port.
|
|
5808
6049
|
* @summary Add Service
|
|
5809
6050
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5810
6051
|
* @param {BusIOType} busIOType
|
|
@@ -5814,7 +6055,7 @@ export declare const BUSInputsOutputsApiFactory: (configuration?: Configuration,
|
|
|
5814
6055
|
*/
|
|
5815
6056
|
addBusIOService(cell: string, busIOType: BusIOType, completionTimeout?: number, options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
5816
6057
|
/**
|
|
5817
|
-
* Adds an input/output to or updates an input/output on the PROFINET device.
|
|
6058
|
+
* 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
6059
|
* @summary Add PROFINET Input/Output
|
|
5819
6060
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5820
6061
|
* @param {string} io Unique identifier to address an Input/Output in the cell.
|
|
@@ -5824,7 +6065,7 @@ export declare const BUSInputsOutputsApiFactory: (configuration?: Configuration,
|
|
|
5824
6065
|
*/
|
|
5825
6066
|
addProfinetIO(cell: string, io: string, profinetIOData: ProfinetIOData, options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
5826
6067
|
/**
|
|
5827
|
-
*
|
|
6068
|
+
* Remove the BUS inputs/outputs service from the cell.
|
|
5828
6069
|
* @summary Clear Service
|
|
5829
6070
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5830
6071
|
* @param {number} [completionTimeout]
|
|
@@ -5833,7 +6074,7 @@ export declare const BUSInputsOutputsApiFactory: (configuration?: Configuration,
|
|
|
5833
6074
|
*/
|
|
5834
6075
|
clearBusIOService(cell: string, completionTimeout?: number, options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
5835
6076
|
/**
|
|
5836
|
-
* Removes
|
|
6077
|
+
* Removes an input/output variable configuration from the PROFINET device, e.g. NOVA\'s PROFINET service.
|
|
5837
6078
|
* @summary Remove PROFINET Input/Ouptut
|
|
5838
6079
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5839
6080
|
* @param {string} io Unique identifier to address an Input/Output in the cell.
|
|
@@ -5842,7 +6083,7 @@ export declare const BUSInputsOutputsApiFactory: (configuration?: Configuration,
|
|
|
5842
6083
|
*/
|
|
5843
6084
|
deleteProfinetIO(cell: string, io: string, options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
5844
6085
|
/**
|
|
5845
|
-
* Get deployed BUS
|
|
6086
|
+
* Get deployed BUS inputs/outputs service.
|
|
5846
6087
|
* @summary Get Service
|
|
5847
6088
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5848
6089
|
* @param {*} [options] Override http request option.
|
|
@@ -5867,7 +6108,7 @@ export declare const BUSInputsOutputsApiFactory: (configuration?: Configuration,
|
|
|
5867
6108
|
*/
|
|
5868
6109
|
getBusIOValues(cell: string, ios?: Array<string>, options?: RawAxiosRequestConfig): AxiosPromise<Array<IOValue>>;
|
|
5869
6110
|
/**
|
|
5870
|
-
* Get description of PROFINET
|
|
6111
|
+
* Get description of NOVA as a PROFINET device.
|
|
5871
6112
|
* @summary Get PROFINET Description
|
|
5872
6113
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5873
6114
|
* @param {*} [options] Override http request option.
|
|
@@ -5875,7 +6116,7 @@ export declare const BUSInputsOutputsApiFactory: (configuration?: Configuration,
|
|
|
5875
6116
|
*/
|
|
5876
6117
|
getProfinetDescription(cell: string, options?: RawAxiosRequestConfig): AxiosPromise<ProfinetDescription>;
|
|
5877
6118
|
/**
|
|
5878
|
-
* Get input/output configuration of the PROFINET device as file.
|
|
6119
|
+
* 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
6120
|
* @summary PROFINET Inputs/Outputs to File
|
|
5880
6121
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5881
6122
|
* @param {number} [inputOffset]
|
|
@@ -5885,15 +6126,15 @@ export declare const BUSInputsOutputsApiFactory: (configuration?: Configuration,
|
|
|
5885
6126
|
*/
|
|
5886
6127
|
getProfinetIOsFromFile(cell: string, inputOffset?: number, outputOffset?: number, options?: RawAxiosRequestConfig): AxiosPromise<string>;
|
|
5887
6128
|
/**
|
|
5888
|
-
* List all BUS
|
|
6129
|
+
* 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
6130
|
* @summary List Descriptions
|
|
5890
6131
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5891
6132
|
* @param {*} [options] Override http request option.
|
|
5892
6133
|
* @throws {RequiredError}
|
|
5893
6134
|
*/
|
|
5894
|
-
listBusIODescriptions(cell: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<
|
|
6135
|
+
listBusIODescriptions(cell: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<IODescription2>>;
|
|
5895
6136
|
/**
|
|
5896
|
-
* List all PROFINET input and
|
|
6137
|
+
* 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
6138
|
* @summary List PROFINET Input/Output Configuration
|
|
5898
6139
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5899
6140
|
* @param {*} [options] Override http request option.
|
|
@@ -5910,7 +6151,7 @@ export declare const BUSInputsOutputsApiFactory: (configuration?: Configuration,
|
|
|
5910
6151
|
*/
|
|
5911
6152
|
setBusIOValues(cell: string, iOValue: Array<IOValue>, options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
5912
6153
|
/**
|
|
5913
|
-
* Sets inputs/outputs
|
|
6154
|
+
* 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
6155
|
* @summary Set PROFINET Inputs/Outputs from File
|
|
5915
6156
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5916
6157
|
* @param {ProfinetInputOutputConfig} profinetInputOutputConfig
|
|
@@ -5927,7 +6168,7 @@ export declare const BUSInputsOutputsApiFactory: (configuration?: Configuration,
|
|
|
5927
6168
|
*/
|
|
5928
6169
|
export declare class BUSInputsOutputsApi extends BaseAPI {
|
|
5929
6170
|
/**
|
|
5930
|
-
* Add
|
|
6171
|
+
* Add the BUS inputs/outputs service to the cell. Starts a containerized service that enables BUS connections via the specified ethernet port.
|
|
5931
6172
|
* @summary Add Service
|
|
5932
6173
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5933
6174
|
* @param {BusIOType} busIOType
|
|
@@ -5938,7 +6179,7 @@ export declare class BUSInputsOutputsApi extends BaseAPI {
|
|
|
5938
6179
|
*/
|
|
5939
6180
|
addBusIOService(cell: string, busIOType: BusIOType, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
5940
6181
|
/**
|
|
5941
|
-
* Adds an input/output to or updates an input/output on the PROFINET device.
|
|
6182
|
+
* 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
6183
|
* @summary Add PROFINET Input/Output
|
|
5943
6184
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5944
6185
|
* @param {string} io Unique identifier to address an Input/Output in the cell.
|
|
@@ -5949,7 +6190,7 @@ export declare class BUSInputsOutputsApi extends BaseAPI {
|
|
|
5949
6190
|
*/
|
|
5950
6191
|
addProfinetIO(cell: string, io: string, profinetIOData: ProfinetIOData, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
5951
6192
|
/**
|
|
5952
|
-
*
|
|
6193
|
+
* Remove the BUS inputs/outputs service from the cell.
|
|
5953
6194
|
* @summary Clear Service
|
|
5954
6195
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5955
6196
|
* @param {number} [completionTimeout]
|
|
@@ -5959,7 +6200,7 @@ export declare class BUSInputsOutputsApi extends BaseAPI {
|
|
|
5959
6200
|
*/
|
|
5960
6201
|
clearBusIOService(cell: string, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
5961
6202
|
/**
|
|
5962
|
-
* Removes
|
|
6203
|
+
* Removes an input/output variable configuration from the PROFINET device, e.g. NOVA\'s PROFINET service.
|
|
5963
6204
|
* @summary Remove PROFINET Input/Ouptut
|
|
5964
6205
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5965
6206
|
* @param {string} io Unique identifier to address an Input/Output in the cell.
|
|
@@ -5969,16 +6210,14 @@ export declare class BUSInputsOutputsApi extends BaseAPI {
|
|
|
5969
6210
|
*/
|
|
5970
6211
|
deleteProfinetIO(cell: string, io: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
5971
6212
|
/**
|
|
5972
|
-
* Get deployed BUS
|
|
6213
|
+
* Get deployed BUS inputs/outputs service.
|
|
5973
6214
|
* @summary Get Service
|
|
5974
6215
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5975
6216
|
* @param {*} [options] Override http request option.
|
|
5976
6217
|
* @throws {RequiredError}
|
|
5977
6218
|
* @memberof BUSInputsOutputsApi
|
|
5978
6219
|
*/
|
|
5979
|
-
getBusIOService(cell: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<
|
|
5980
|
-
bus_type: "profinet";
|
|
5981
|
-
} & BusIOProfinet, any>>;
|
|
6220
|
+
getBusIOService(cell: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<BusIOType, any>>;
|
|
5982
6221
|
/**
|
|
5983
6222
|
* Get the current state of the BUS Inputs/Outputs service.
|
|
5984
6223
|
* @summary State
|
|
@@ -5999,7 +6238,7 @@ export declare class BUSInputsOutputsApi extends BaseAPI {
|
|
|
5999
6238
|
*/
|
|
6000
6239
|
getBusIOValues(cell: string, ios?: Array<string>, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<IOValue[], any>>;
|
|
6001
6240
|
/**
|
|
6002
|
-
* Get description of PROFINET
|
|
6241
|
+
* Get description of NOVA as a PROFINET device.
|
|
6003
6242
|
* @summary Get PROFINET Description
|
|
6004
6243
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
6005
6244
|
* @param {*} [options] Override http request option.
|
|
@@ -6008,7 +6247,7 @@ export declare class BUSInputsOutputsApi extends BaseAPI {
|
|
|
6008
6247
|
*/
|
|
6009
6248
|
getProfinetDescription(cell: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ProfinetDescription, any>>;
|
|
6010
6249
|
/**
|
|
6011
|
-
* Get input/output configuration of the PROFINET device as file.
|
|
6250
|
+
* 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
6251
|
* @summary PROFINET Inputs/Outputs to File
|
|
6013
6252
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
6014
6253
|
* @param {number} [inputOffset]
|
|
@@ -6019,16 +6258,16 @@ export declare class BUSInputsOutputsApi extends BaseAPI {
|
|
|
6019
6258
|
*/
|
|
6020
6259
|
getProfinetIOsFromFile(cell: string, inputOffset?: number, outputOffset?: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<string, any>>;
|
|
6021
6260
|
/**
|
|
6022
|
-
* List all BUS
|
|
6261
|
+
* 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
6262
|
* @summary List Descriptions
|
|
6024
6263
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
6025
6264
|
* @param {*} [options] Override http request option.
|
|
6026
6265
|
* @throws {RequiredError}
|
|
6027
6266
|
* @memberof BUSInputsOutputsApi
|
|
6028
6267
|
*/
|
|
6029
|
-
listBusIODescriptions(cell: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<
|
|
6268
|
+
listBusIODescriptions(cell: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<IODescription2[], any>>;
|
|
6030
6269
|
/**
|
|
6031
|
-
* List all PROFINET input and
|
|
6270
|
+
* 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
6271
|
* @summary List PROFINET Input/Output Configuration
|
|
6033
6272
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
6034
6273
|
* @param {*} [options] Override http request option.
|
|
@@ -6047,7 +6286,7 @@ export declare class BUSInputsOutputsApi extends BaseAPI {
|
|
|
6047
6286
|
*/
|
|
6048
6287
|
setBusIOValues(cell: string, iOValue: Array<IOValue>, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
6049
6288
|
/**
|
|
6050
|
-
* Sets inputs/outputs
|
|
6289
|
+
* 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
6290
|
* @summary Set PROFINET Inputs/Outputs from File
|
|
6052
6291
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
6053
6292
|
* @param {ProfinetInputOutputConfig} profinetInputOutputConfig
|
|
@@ -7637,7 +7876,7 @@ export declare class MotionGroupApi extends BaseAPI {
|
|
|
7637
7876
|
*/
|
|
7638
7877
|
export declare const MotionGroupModelsApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
7639
7878
|
/**
|
|
7640
|
-
* Returns the default collision link chain for a given motion group model. See [
|
|
7879
|
+
* 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
7880
|
* @summary Get Collision Model
|
|
7642
7881
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
7643
7882
|
* @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 +7899,7 @@ export declare const MotionGroupModelsApiAxiosParamCreator: (configuration?: Con
|
|
|
7660
7899
|
*/
|
|
7661
7900
|
export declare const MotionGroupModelsApiFp: (configuration?: Configuration) => {
|
|
7662
7901
|
/**
|
|
7663
|
-
* Returns the default collision link chain for a given motion group model. See [
|
|
7902
|
+
* 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
7903
|
* @summary Get Collision Model
|
|
7665
7904
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
7666
7905
|
* @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 +7924,7 @@ export declare const MotionGroupModelsApiFp: (configuration?: Configuration) =>
|
|
|
7685
7924
|
*/
|
|
7686
7925
|
export declare const MotionGroupModelsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
7687
7926
|
/**
|
|
7688
|
-
* Returns the default collision link chain for a given motion group model. See [
|
|
7927
|
+
* 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
7928
|
* @summary Get Collision Model
|
|
7690
7929
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
7691
7930
|
* @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 +7951,7 @@ export declare const MotionGroupModelsApiFactory: (configuration?: Configuration
|
|
|
7712
7951
|
*/
|
|
7713
7952
|
export declare class MotionGroupModelsApi extends BaseAPI {
|
|
7714
7953
|
/**
|
|
7715
|
-
* Returns the default collision link chain for a given motion group model. See [
|
|
7954
|
+
* 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
7955
|
* @summary Get Collision Model
|
|
7717
7956
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
7718
7957
|
* @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 +7972,180 @@ export declare class MotionGroupModelsApi extends BaseAPI {
|
|
|
7733
7972
|
*/
|
|
7734
7973
|
getMotionGroupModels(cell: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<string[], any>>;
|
|
7735
7974
|
}
|
|
7975
|
+
/**
|
|
7976
|
+
* ProgramApi - axios parameter creator
|
|
7977
|
+
* @export
|
|
7978
|
+
*/
|
|
7979
|
+
export declare const ProgramApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
7980
|
+
/**
|
|
7981
|
+
* Get details of a program.
|
|
7982
|
+
* @summary Get program
|
|
7983
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
7984
|
+
* @param {string} program
|
|
7985
|
+
* @param {*} [options] Override http request option.
|
|
7986
|
+
* @throws {RequiredError}
|
|
7987
|
+
*/
|
|
7988
|
+
getProgram: (cell: string, program: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
7989
|
+
/**
|
|
7990
|
+
* List details of all existing programs.
|
|
7991
|
+
* @summary List programs
|
|
7992
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
7993
|
+
* @param {*} [options] Override http request option.
|
|
7994
|
+
* @throws {RequiredError}
|
|
7995
|
+
*/
|
|
7996
|
+
listPrograms: (cell: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
7997
|
+
/**
|
|
7998
|
+
* This endpoint starts a new program execution. The program will be executed asynchronously.
|
|
7999
|
+
* @summary Start the program
|
|
8000
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8001
|
+
* @param {string} program
|
|
8002
|
+
* @param {ProgramStartRequest} programStartRequest
|
|
8003
|
+
* @param {*} [options] Override http request option.
|
|
8004
|
+
* @throws {RequiredError}
|
|
8005
|
+
*/
|
|
8006
|
+
startProgram: (cell: string, program: string, programStartRequest: ProgramStartRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
8007
|
+
/**
|
|
8008
|
+
* Stop a specific program run.
|
|
8009
|
+
* @summary Stop program run
|
|
8010
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8011
|
+
* @param {string} program
|
|
8012
|
+
* @param {*} [options] Override http request option.
|
|
8013
|
+
* @throws {RequiredError}
|
|
8014
|
+
*/
|
|
8015
|
+
stopProgram: (cell: string, program: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
8016
|
+
};
|
|
8017
|
+
/**
|
|
8018
|
+
* ProgramApi - functional programming interface
|
|
8019
|
+
* @export
|
|
8020
|
+
*/
|
|
8021
|
+
export declare const ProgramApiFp: (configuration?: Configuration) => {
|
|
8022
|
+
/**
|
|
8023
|
+
* Get details of a program.
|
|
8024
|
+
* @summary Get program
|
|
8025
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8026
|
+
* @param {string} program
|
|
8027
|
+
* @param {*} [options] Override http request option.
|
|
8028
|
+
* @throws {RequiredError}
|
|
8029
|
+
*/
|
|
8030
|
+
getProgram(cell: string, program: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Program>>;
|
|
8031
|
+
/**
|
|
8032
|
+
* List details of all existing programs.
|
|
8033
|
+
* @summary List programs
|
|
8034
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8035
|
+
* @param {*} [options] Override http request option.
|
|
8036
|
+
* @throws {RequiredError}
|
|
8037
|
+
*/
|
|
8038
|
+
listPrograms(cell: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<Program>>>;
|
|
8039
|
+
/**
|
|
8040
|
+
* This endpoint starts a new program execution. The program will be executed asynchronously.
|
|
8041
|
+
* @summary Start the program
|
|
8042
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8043
|
+
* @param {string} program
|
|
8044
|
+
* @param {ProgramStartRequest} programStartRequest
|
|
8045
|
+
* @param {*} [options] Override http request option.
|
|
8046
|
+
* @throws {RequiredError}
|
|
8047
|
+
*/
|
|
8048
|
+
startProgram(cell: string, program: string, programStartRequest: ProgramStartRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ProgramRun>>;
|
|
8049
|
+
/**
|
|
8050
|
+
* Stop a specific program run.
|
|
8051
|
+
* @summary Stop program run
|
|
8052
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8053
|
+
* @param {string} program
|
|
8054
|
+
* @param {*} [options] Override http request option.
|
|
8055
|
+
* @throws {RequiredError}
|
|
8056
|
+
*/
|
|
8057
|
+
stopProgram(cell: string, program: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
8058
|
+
};
|
|
8059
|
+
/**
|
|
8060
|
+
* ProgramApi - factory interface
|
|
8061
|
+
* @export
|
|
8062
|
+
*/
|
|
8063
|
+
export declare const ProgramApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
8064
|
+
/**
|
|
8065
|
+
* Get details of a program.
|
|
8066
|
+
* @summary Get program
|
|
8067
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8068
|
+
* @param {string} program
|
|
8069
|
+
* @param {*} [options] Override http request option.
|
|
8070
|
+
* @throws {RequiredError}
|
|
8071
|
+
*/
|
|
8072
|
+
getProgram(cell: string, program: string, options?: RawAxiosRequestConfig): AxiosPromise<Program>;
|
|
8073
|
+
/**
|
|
8074
|
+
* List details of all existing programs.
|
|
8075
|
+
* @summary List programs
|
|
8076
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8077
|
+
* @param {*} [options] Override http request option.
|
|
8078
|
+
* @throws {RequiredError}
|
|
8079
|
+
*/
|
|
8080
|
+
listPrograms(cell: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<Program>>;
|
|
8081
|
+
/**
|
|
8082
|
+
* This endpoint starts a new program execution. The program will be executed asynchronously.
|
|
8083
|
+
* @summary Start the program
|
|
8084
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8085
|
+
* @param {string} program
|
|
8086
|
+
* @param {ProgramStartRequest} programStartRequest
|
|
8087
|
+
* @param {*} [options] Override http request option.
|
|
8088
|
+
* @throws {RequiredError}
|
|
8089
|
+
*/
|
|
8090
|
+
startProgram(cell: string, program: string, programStartRequest: ProgramStartRequest, options?: RawAxiosRequestConfig): AxiosPromise<ProgramRun>;
|
|
8091
|
+
/**
|
|
8092
|
+
* Stop a specific program run.
|
|
8093
|
+
* @summary Stop program run
|
|
8094
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8095
|
+
* @param {string} program
|
|
8096
|
+
* @param {*} [options] Override http request option.
|
|
8097
|
+
* @throws {RequiredError}
|
|
8098
|
+
*/
|
|
8099
|
+
stopProgram(cell: string, program: string, options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
8100
|
+
};
|
|
8101
|
+
/**
|
|
8102
|
+
* ProgramApi - object-oriented interface
|
|
8103
|
+
* @export
|
|
8104
|
+
* @class ProgramApi
|
|
8105
|
+
* @extends {BaseAPI}
|
|
8106
|
+
*/
|
|
8107
|
+
export declare class ProgramApi extends BaseAPI {
|
|
8108
|
+
/**
|
|
8109
|
+
* Get details of a program.
|
|
8110
|
+
* @summary Get program
|
|
8111
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8112
|
+
* @param {string} program
|
|
8113
|
+
* @param {*} [options] Override http request option.
|
|
8114
|
+
* @throws {RequiredError}
|
|
8115
|
+
* @memberof ProgramApi
|
|
8116
|
+
*/
|
|
8117
|
+
getProgram(cell: string, program: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Program, any>>;
|
|
8118
|
+
/**
|
|
8119
|
+
* List details of all existing programs.
|
|
8120
|
+
* @summary List programs
|
|
8121
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8122
|
+
* @param {*} [options] Override http request option.
|
|
8123
|
+
* @throws {RequiredError}
|
|
8124
|
+
* @memberof ProgramApi
|
|
8125
|
+
*/
|
|
8126
|
+
listPrograms(cell: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Program[], any>>;
|
|
8127
|
+
/**
|
|
8128
|
+
* This endpoint starts a new program execution. The program will be executed asynchronously.
|
|
8129
|
+
* @summary Start the program
|
|
8130
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8131
|
+
* @param {string} program
|
|
8132
|
+
* @param {ProgramStartRequest} programStartRequest
|
|
8133
|
+
* @param {*} [options] Override http request option.
|
|
8134
|
+
* @throws {RequiredError}
|
|
8135
|
+
* @memberof ProgramApi
|
|
8136
|
+
*/
|
|
8137
|
+
startProgram(cell: string, program: string, programStartRequest: ProgramStartRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ProgramRun, any>>;
|
|
8138
|
+
/**
|
|
8139
|
+
* Stop a specific program run.
|
|
8140
|
+
* @summary Stop program run
|
|
8141
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8142
|
+
* @param {string} program
|
|
8143
|
+
* @param {*} [options] Override http request option.
|
|
8144
|
+
* @throws {RequiredError}
|
|
8145
|
+
* @memberof ProgramApi
|
|
8146
|
+
*/
|
|
8147
|
+
stopProgram(cell: string, program: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
8148
|
+
}
|
|
7736
8149
|
/**
|
|
7737
8150
|
* StoreCollisionComponentsApi - axios parameter creator
|
|
7738
8151
|
* @export
|
|
@@ -7801,7 +8214,7 @@ export declare const StoreCollisionComponentsApiAxiosParamCreator: (configuratio
|
|
|
7801
8214
|
*/
|
|
7802
8215
|
listCollisionLinkChains: (cell: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
7803
8216
|
/**
|
|
7804
|
-
* Returns
|
|
8217
|
+
* Returns all stored colliders.
|
|
7805
8218
|
* @summary List Colliders
|
|
7806
8219
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
7807
8220
|
* @param {*} [options] Override http request option.
|
|
@@ -7927,7 +8340,7 @@ export declare const StoreCollisionComponentsApiFp: (configuration?: Configurati
|
|
|
7927
8340
|
}>;
|
|
7928
8341
|
}>>;
|
|
7929
8342
|
/**
|
|
7930
|
-
* Returns
|
|
8343
|
+
* Returns all stored colliders.
|
|
7931
8344
|
* @summary List Colliders
|
|
7932
8345
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
7933
8346
|
* @param {*} [options] Override http request option.
|
|
@@ -8063,7 +8476,7 @@ export declare const StoreCollisionComponentsApiFactory: (configuration?: Config
|
|
|
8063
8476
|
}>;
|
|
8064
8477
|
}>;
|
|
8065
8478
|
/**
|
|
8066
|
-
* Returns
|
|
8479
|
+
* Returns all stored colliders.
|
|
8067
8480
|
* @summary List Colliders
|
|
8068
8481
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8069
8482
|
* @param {*} [options] Override http request option.
|
|
@@ -8208,7 +8621,7 @@ export declare class StoreCollisionComponentsApi extends BaseAPI {
|
|
|
8208
8621
|
}[];
|
|
8209
8622
|
}, any>>;
|
|
8210
8623
|
/**
|
|
8211
|
-
* Returns
|
|
8624
|
+
* Returns all stored colliders.
|
|
8212
8625
|
* @summary List Colliders
|
|
8213
8626
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8214
8627
|
* @param {*} [options] Override http request option.
|