@wandelbots/nova-api 25.8.0-dev.3 → 25.8.0-dev.31
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/v2/api.d.ts +560 -109
- package/v2/api.js +402 -51
- package/v2/api.js.map +1 -1
- package/v2/api.ts +749 -105
package/v2/api.d.ts
CHANGED
|
@@ -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
|
-
*
|
|
357
|
+
* Content of Configuration XML file for PROFINET device, typically known as PND_IOD.xml. Leave empty for the default configuration. Refer to the official PROFINET driver documentation for further information.
|
|
358
358
|
* @type {string}
|
|
359
359
|
* @memberof BusIOProfinet
|
|
360
360
|
*/
|
|
361
361
|
'config_file_content'?: string;
|
|
362
362
|
/**
|
|
363
|
-
*
|
|
363
|
+
* Used to enable IP communication through the same physical interface while PN Driver is running.
|
|
364
364
|
* @type {BusIOProfinetNetwork}
|
|
365
365
|
* @memberof BusIOProfinet
|
|
366
366
|
*/
|
|
367
367
|
'network_config'?: BusIOProfinetNetwork;
|
|
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
|
|
@@ -2313,9 +2375,19 @@ export type JoggingDetailsKindEnum = typeof JoggingDetailsKindEnum[keyof typeof
|
|
|
2313
2375
|
* @type JoggingDetailsState
|
|
2314
2376
|
* @export
|
|
2315
2377
|
*/
|
|
2316
|
-
export type JoggingDetailsState =
|
|
2378
|
+
export type JoggingDetailsState = {
|
|
2379
|
+
kind: 'PAUSED_BY_USER';
|
|
2380
|
+
} & JoggingPausedByUser | {
|
|
2381
|
+
kind: 'PAUSED_NEAR_COLLISION';
|
|
2382
|
+
} & JoggingPausedNearCollision | {
|
|
2383
|
+
kind: 'PAUSED_NEAR_JOINT_LIMIT';
|
|
2384
|
+
} & JoggingPausedNearJointLimit | {
|
|
2385
|
+
kind: 'PAUSED_ON_IO';
|
|
2386
|
+
} & JoggingPausedOnIO | {
|
|
2387
|
+
kind: 'RUNNING';
|
|
2388
|
+
} & JoggingRunning;
|
|
2317
2389
|
/**
|
|
2318
|
-
*
|
|
2390
|
+
* User has paused jogging.
|
|
2319
2391
|
* @export
|
|
2320
2392
|
* @interface JoggingPausedByUser
|
|
2321
2393
|
*/
|
|
@@ -2332,7 +2404,7 @@ export declare const JoggingPausedByUserKindEnum: {
|
|
|
2332
2404
|
};
|
|
2333
2405
|
export type JoggingPausedByUserKindEnum = typeof JoggingPausedByUserKindEnum[keyof typeof JoggingPausedByUserKindEnum];
|
|
2334
2406
|
/**
|
|
2335
|
-
*
|
|
2407
|
+
* Jogging was paused because the motion group neared a collision.
|
|
2336
2408
|
* @export
|
|
2337
2409
|
* @interface JoggingPausedNearCollision
|
|
2338
2410
|
*/
|
|
@@ -2355,7 +2427,7 @@ export declare const JoggingPausedNearCollisionKindEnum: {
|
|
|
2355
2427
|
};
|
|
2356
2428
|
export type JoggingPausedNearCollisionKindEnum = typeof JoggingPausedNearCollisionKindEnum[keyof typeof JoggingPausedNearCollisionKindEnum];
|
|
2357
2429
|
/**
|
|
2358
|
-
*
|
|
2430
|
+
* Jogging was paused because a joint is near its limit.
|
|
2359
2431
|
* @export
|
|
2360
2432
|
* @interface JoggingPausedNearJointLimit
|
|
2361
2433
|
*/
|
|
@@ -2378,7 +2450,7 @@ export declare const JoggingPausedNearJointLimitKindEnum: {
|
|
|
2378
2450
|
};
|
|
2379
2451
|
export type JoggingPausedNearJointLimitKindEnum = typeof JoggingPausedNearJointLimitKindEnum[keyof typeof JoggingPausedNearJointLimitKindEnum];
|
|
2380
2452
|
/**
|
|
2381
|
-
*
|
|
2453
|
+
* Jogging was paused because of an I/O event.
|
|
2382
2454
|
* @export
|
|
2383
2455
|
* @interface JoggingPausedOnIO
|
|
2384
2456
|
*/
|
|
@@ -2395,7 +2467,7 @@ export declare const JoggingPausedOnIOKindEnum: {
|
|
|
2395
2467
|
};
|
|
2396
2468
|
export type JoggingPausedOnIOKindEnum = typeof JoggingPausedOnIOKindEnum[keyof typeof JoggingPausedOnIOKindEnum];
|
|
2397
2469
|
/**
|
|
2398
|
-
*
|
|
2470
|
+
* Jogging is active.
|
|
2399
2471
|
* @export
|
|
2400
2472
|
* @interface JoggingRunning
|
|
2401
2473
|
*/
|
|
@@ -2749,6 +2821,12 @@ export interface LimitSet {
|
|
|
2749
2821
|
* @memberof LimitSet
|
|
2750
2822
|
*/
|
|
2751
2823
|
'flange'?: CartesianLimits;
|
|
2824
|
+
/**
|
|
2825
|
+
*
|
|
2826
|
+
* @type {JointLimits}
|
|
2827
|
+
* @memberof LimitSet
|
|
2828
|
+
*/
|
|
2829
|
+
'coupled_shoulder_elbow_joint'?: JointLimits;
|
|
2752
2830
|
}
|
|
2753
2831
|
/**
|
|
2754
2832
|
* If a limit is not set, the default value will be used.
|
|
@@ -2820,13 +2898,13 @@ export declare const Manufacturer: {
|
|
|
2820
2898
|
};
|
|
2821
2899
|
export type Manufacturer = typeof Manufacturer[keyof typeof Manufacturer];
|
|
2822
2900
|
/**
|
|
2823
|
-
*
|
|
2901
|
+
*
|
|
2824
2902
|
* @export
|
|
2825
2903
|
* @interface MidpointInsertionAlgorithm
|
|
2826
2904
|
*/
|
|
2827
2905
|
export interface MidpointInsertionAlgorithm {
|
|
2828
2906
|
/**
|
|
2829
|
-
* Algorithm discriminator.
|
|
2907
|
+
* 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.
|
|
2830
2908
|
* @type {string}
|
|
2831
2909
|
* @memberof MidpointInsertionAlgorithm
|
|
2832
2910
|
*/
|
|
@@ -3905,17 +3983,17 @@ export interface ProfinetDescription {
|
|
|
3905
3983
|
*/
|
|
3906
3984
|
'slots'?: Array<ProfinetSlotDescription>;
|
|
3907
3985
|
/**
|
|
3908
|
-
* Name of the PROFINET device
|
|
3986
|
+
* 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.
|
|
3909
3987
|
* @type {string}
|
|
3910
3988
|
* @memberof ProfinetDescription
|
|
3911
3989
|
*/
|
|
3912
3990
|
'device_name'?: string;
|
|
3913
3991
|
/**
|
|
3914
|
-
*
|
|
3915
|
-
* @type {
|
|
3992
|
+
*
|
|
3993
|
+
* @type {BusIOProfinetIpConfig}
|
|
3916
3994
|
* @memberof ProfinetDescription
|
|
3917
3995
|
*/
|
|
3918
|
-
'
|
|
3996
|
+
'ip_config'?: BusIOProfinetIpConfig;
|
|
3919
3997
|
}
|
|
3920
3998
|
/**
|
|
3921
3999
|
*
|
|
@@ -3924,7 +4002,7 @@ export interface ProfinetDescription {
|
|
|
3924
4002
|
*/
|
|
3925
4003
|
export interface ProfinetIO {
|
|
3926
4004
|
/**
|
|
3927
|
-
* The name of the input/output
|
|
4005
|
+
* 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).
|
|
3928
4006
|
* @type {string}
|
|
3929
4007
|
* @memberof ProfinetIO
|
|
3930
4008
|
*/
|
|
@@ -3936,25 +4014,25 @@ export interface ProfinetIO {
|
|
|
3936
4014
|
*/
|
|
3937
4015
|
'type': ProfinetIOTypeEnum;
|
|
3938
4016
|
/**
|
|
3939
|
-
* The direction of the input/output
|
|
4017
|
+
* 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.
|
|
3940
4018
|
* @type {ProfinetIODirection}
|
|
3941
4019
|
* @memberof ProfinetIO
|
|
3942
4020
|
*/
|
|
3943
4021
|
'direction': ProfinetIODirection;
|
|
3944
4022
|
/**
|
|
3945
|
-
* The byte address of the input/output
|
|
4023
|
+
* 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.
|
|
3946
4024
|
* @type {number}
|
|
3947
4025
|
* @memberof ProfinetIO
|
|
3948
4026
|
*/
|
|
3949
4027
|
'byte_address': number;
|
|
3950
4028
|
/**
|
|
3951
|
-
* The bit address of the input/output
|
|
4029
|
+
* 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.
|
|
3952
4030
|
* @type {number}
|
|
3953
4031
|
* @memberof ProfinetIO
|
|
3954
4032
|
*/
|
|
3955
4033
|
'bit_address'?: number;
|
|
3956
4034
|
/**
|
|
3957
|
-
* The unique identifier for the input/output value. This identifier is used to reference the specific input/output in the NOVA
|
|
4035
|
+
* 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.
|
|
3958
4036
|
* @type {string}
|
|
3959
4037
|
* @memberof ProfinetIO
|
|
3960
4038
|
*/
|
|
@@ -3967,7 +4045,7 @@ export interface ProfinetIO {
|
|
|
3967
4045
|
*/
|
|
3968
4046
|
export interface ProfinetIOData {
|
|
3969
4047
|
/**
|
|
3970
|
-
* The name of the input/output
|
|
4048
|
+
* 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).
|
|
3971
4049
|
* @type {string}
|
|
3972
4050
|
* @memberof ProfinetIOData
|
|
3973
4051
|
*/
|
|
@@ -3979,26 +4057,26 @@ export interface ProfinetIOData {
|
|
|
3979
4057
|
*/
|
|
3980
4058
|
'type': ProfinetIOTypeEnum;
|
|
3981
4059
|
/**
|
|
3982
|
-
* The direction of the input/output
|
|
4060
|
+
* 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.
|
|
3983
4061
|
* @type {ProfinetIODirection}
|
|
3984
4062
|
* @memberof ProfinetIOData
|
|
3985
4063
|
*/
|
|
3986
4064
|
'direction': ProfinetIODirection;
|
|
3987
4065
|
/**
|
|
3988
|
-
* The byte address of the input/output
|
|
4066
|
+
* 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.
|
|
3989
4067
|
* @type {number}
|
|
3990
4068
|
* @memberof ProfinetIOData
|
|
3991
4069
|
*/
|
|
3992
4070
|
'byte_address': number;
|
|
3993
4071
|
/**
|
|
3994
|
-
* The bit address of the input/output
|
|
4072
|
+
* 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.
|
|
3995
4073
|
* @type {number}
|
|
3996
4074
|
* @memberof ProfinetIOData
|
|
3997
4075
|
*/
|
|
3998
4076
|
'bit_address'?: number;
|
|
3999
4077
|
}
|
|
4000
4078
|
/**
|
|
4001
|
-
*
|
|
4079
|
+
* 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.
|
|
4002
4080
|
* @export
|
|
4003
4081
|
* @enum {string}
|
|
4004
4082
|
*/
|
|
@@ -4009,7 +4087,7 @@ export declare const ProfinetIODirection: {
|
|
|
4009
4087
|
};
|
|
4010
4088
|
export type ProfinetIODirection = typeof ProfinetIODirection[keyof typeof ProfinetIODirection];
|
|
4011
4089
|
/**
|
|
4012
|
-
* Value type of the PROFINET input/output.
|
|
4090
|
+
* Value type of the PROFINET input/output variable. Is used to interpret the corresponding bits correctly.
|
|
4013
4091
|
* @export
|
|
4014
4092
|
* @enum {string}
|
|
4015
4093
|
*/
|
|
@@ -4033,38 +4111,38 @@ export type ProfinetIOTypeEnum = typeof ProfinetIOTypeEnum[keyof typeof Profinet
|
|
|
4033
4111
|
*/
|
|
4034
4112
|
export interface ProfinetInputOutputConfig {
|
|
4035
4113
|
/**
|
|
4036
|
-
* Content of the input
|
|
4114
|
+
* 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.
|
|
4037
4115
|
* @type {string}
|
|
4038
4116
|
* @memberof ProfinetInputOutputConfig
|
|
4039
4117
|
*/
|
|
4040
4118
|
'config': string;
|
|
4041
4119
|
/**
|
|
4042
|
-
* Offset in bytes for the input
|
|
4120
|
+
* 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.
|
|
4043
4121
|
* @type {number}
|
|
4044
4122
|
* @memberof ProfinetInputOutputConfig
|
|
4045
4123
|
*/
|
|
4046
4124
|
'input_offset': number;
|
|
4047
4125
|
/**
|
|
4048
|
-
* Offset in bytes for the output
|
|
4126
|
+
* 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.
|
|
4049
4127
|
* @type {number}
|
|
4050
4128
|
* @memberof ProfinetInputOutputConfig
|
|
4051
4129
|
*/
|
|
4052
4130
|
'output_offset': number;
|
|
4053
4131
|
}
|
|
4054
4132
|
/**
|
|
4055
|
-
*
|
|
4133
|
+
* 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).
|
|
4056
4134
|
* @export
|
|
4057
4135
|
* @interface ProfinetSlotDescription
|
|
4058
4136
|
*/
|
|
4059
4137
|
export interface ProfinetSlotDescription {
|
|
4060
4138
|
/**
|
|
4061
|
-
* The number of the PROFINET slot.
|
|
4139
|
+
* 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.
|
|
4062
4140
|
* @type {number}
|
|
4063
4141
|
* @memberof ProfinetSlotDescription
|
|
4064
4142
|
*/
|
|
4065
4143
|
'number': number;
|
|
4066
4144
|
/**
|
|
4067
|
-
* The API number of the PROFINET input
|
|
4145
|
+
* The application process identifier (API) number of the PROFINET input. The API identifies the application relation (AR) that is using the slot.
|
|
4068
4146
|
* @type {number}
|
|
4069
4147
|
* @memberof ProfinetSlotDescription
|
|
4070
4148
|
*/
|
|
@@ -4083,32 +4161,174 @@ export interface ProfinetSlotDescription {
|
|
|
4083
4161
|
*/
|
|
4084
4162
|
export interface ProfinetSubSlotDescription {
|
|
4085
4163
|
/**
|
|
4086
|
-
* The
|
|
4164
|
+
* The number/index of the PROFINET subslot.
|
|
4087
4165
|
* @type {number}
|
|
4088
4166
|
* @memberof ProfinetSubSlotDescription
|
|
4089
4167
|
*/
|
|
4090
4168
|
'number': number;
|
|
4091
4169
|
/**
|
|
4092
|
-
* The
|
|
4170
|
+
* The amount of bytes allocated for the subslot in the input process image buffer.
|
|
4093
4171
|
* @type {number}
|
|
4094
4172
|
* @memberof ProfinetSubSlotDescription
|
|
4095
4173
|
*/
|
|
4096
4174
|
'input_length': number;
|
|
4097
4175
|
/**
|
|
4098
|
-
* The
|
|
4176
|
+
* The amount of bytes allocated for the subslot in the output process image buffer.
|
|
4099
4177
|
* @type {number}
|
|
4100
4178
|
* @memberof ProfinetSubSlotDescription
|
|
4101
4179
|
*/
|
|
4102
4180
|
'output_length': number;
|
|
4103
4181
|
}
|
|
4104
4182
|
/**
|
|
4105
|
-
*
|
|
4183
|
+
* A program is a collection of instructions that are executed in the robot cell.
|
|
4184
|
+
* @export
|
|
4185
|
+
* @interface Program
|
|
4186
|
+
*/
|
|
4187
|
+
export interface Program {
|
|
4188
|
+
/**
|
|
4189
|
+
*
|
|
4190
|
+
* @type {string}
|
|
4191
|
+
* @memberof Program
|
|
4192
|
+
*/
|
|
4193
|
+
'program': string;
|
|
4194
|
+
/**
|
|
4195
|
+
*
|
|
4196
|
+
* @type {string}
|
|
4197
|
+
* @memberof Program
|
|
4198
|
+
*/
|
|
4199
|
+
'name'?: string;
|
|
4200
|
+
/**
|
|
4201
|
+
*
|
|
4202
|
+
* @type {string}
|
|
4203
|
+
* @memberof Program
|
|
4204
|
+
*/
|
|
4205
|
+
'description'?: string;
|
|
4206
|
+
/**
|
|
4207
|
+
*
|
|
4208
|
+
* @type {string}
|
|
4209
|
+
* @memberof Program
|
|
4210
|
+
*/
|
|
4211
|
+
'app': string;
|
|
4212
|
+
/**
|
|
4213
|
+
*
|
|
4214
|
+
* @type {object}
|
|
4215
|
+
* @memberof Program
|
|
4216
|
+
*/
|
|
4217
|
+
'input_schema'?: object;
|
|
4218
|
+
/**
|
|
4219
|
+
*
|
|
4220
|
+
* @type {object}
|
|
4221
|
+
* @memberof Program
|
|
4222
|
+
*/
|
|
4223
|
+
'preconditions'?: object;
|
|
4224
|
+
}
|
|
4225
|
+
/**
|
|
4226
|
+
* Holds the state of a program run.
|
|
4227
|
+
* @export
|
|
4228
|
+
* @interface ProgramRun
|
|
4229
|
+
*/
|
|
4230
|
+
export interface ProgramRun {
|
|
4231
|
+
/**
|
|
4232
|
+
* Unique identifier of the program run
|
|
4233
|
+
* @type {string}
|
|
4234
|
+
* @memberof ProgramRun
|
|
4235
|
+
*/
|
|
4236
|
+
'run': string;
|
|
4237
|
+
/**
|
|
4238
|
+
* Unique identifier of the program
|
|
4239
|
+
* @type {string}
|
|
4240
|
+
* @memberof ProgramRun
|
|
4241
|
+
*/
|
|
4242
|
+
'program': string;
|
|
4243
|
+
/**
|
|
4244
|
+
* State of the program run
|
|
4245
|
+
* @type {ProgramRunState}
|
|
4246
|
+
* @memberof ProgramRun
|
|
4247
|
+
*/
|
|
4248
|
+
'state': ProgramRunState;
|
|
4249
|
+
/**
|
|
4250
|
+
* Logs of the program run
|
|
4251
|
+
* @type {string}
|
|
4252
|
+
* @memberof ProgramRun
|
|
4253
|
+
*/
|
|
4254
|
+
'logs'?: string;
|
|
4255
|
+
/**
|
|
4256
|
+
* Stdout of the program run
|
|
4257
|
+
* @type {string}
|
|
4258
|
+
* @memberof ProgramRun
|
|
4259
|
+
*/
|
|
4260
|
+
'stdout'?: string;
|
|
4261
|
+
/**
|
|
4262
|
+
* Stderr of the program run
|
|
4263
|
+
* @type {string}
|
|
4264
|
+
* @memberof ProgramRun
|
|
4265
|
+
*/
|
|
4266
|
+
'stderr'?: string;
|
|
4267
|
+
/**
|
|
4268
|
+
* Error message of the program run, if any
|
|
4269
|
+
* @type {string}
|
|
4270
|
+
* @memberof ProgramRun
|
|
4271
|
+
*/
|
|
4272
|
+
'error'?: string;
|
|
4273
|
+
/**
|
|
4274
|
+
* Traceback of the program run, if any
|
|
4275
|
+
* @type {string}
|
|
4276
|
+
* @memberof ProgramRun
|
|
4277
|
+
*/
|
|
4278
|
+
'traceback'?: string;
|
|
4279
|
+
/**
|
|
4280
|
+
* Start time of the program run
|
|
4281
|
+
* @type {string}
|
|
4282
|
+
* @memberof ProgramRun
|
|
4283
|
+
*/
|
|
4284
|
+
'start_time'?: string;
|
|
4285
|
+
/**
|
|
4286
|
+
* End time of the program run
|
|
4287
|
+
* @type {string}
|
|
4288
|
+
* @memberof ProgramRun
|
|
4289
|
+
*/
|
|
4290
|
+
'end_time'?: string;
|
|
4291
|
+
/**
|
|
4292
|
+
* Input data of the program run
|
|
4293
|
+
* @type {object}
|
|
4294
|
+
* @memberof ProgramRun
|
|
4295
|
+
*/
|
|
4296
|
+
'input_data'?: object;
|
|
4297
|
+
}
|
|
4298
|
+
/**
|
|
4299
|
+
* The state of a program run.
|
|
4300
|
+
* @export
|
|
4301
|
+
* @enum {string}
|
|
4302
|
+
*/
|
|
4303
|
+
export declare const ProgramRunState: {
|
|
4304
|
+
readonly Preparing: "PREPARING";
|
|
4305
|
+
readonly Running: "RUNNING";
|
|
4306
|
+
readonly Completed: "COMPLETED";
|
|
4307
|
+
readonly Failed: "FAILED";
|
|
4308
|
+
readonly Stopped: "STOPPED";
|
|
4309
|
+
};
|
|
4310
|
+
export type ProgramRunState = typeof ProgramRunState[keyof typeof ProgramRunState];
|
|
4311
|
+
/**
|
|
4312
|
+
* The state of a program run.
|
|
4313
|
+
* @export
|
|
4314
|
+
* @interface ProgramStartRequest
|
|
4315
|
+
*/
|
|
4316
|
+
export interface ProgramStartRequest {
|
|
4317
|
+
/**
|
|
4318
|
+
* The arguments to pass to the program.
|
|
4319
|
+
* @type {object}
|
|
4320
|
+
* @memberof ProgramStartRequest
|
|
4321
|
+
*/
|
|
4322
|
+
'arguments': object;
|
|
4323
|
+
}
|
|
4324
|
+
/**
|
|
4325
|
+
*
|
|
4106
4326
|
* @export
|
|
4107
4327
|
* @interface RRTConnectAlgorithm
|
|
4108
4328
|
*/
|
|
4109
4329
|
export interface RRTConnectAlgorithm {
|
|
4110
4330
|
/**
|
|
4111
|
-
* Algorithm discriminator.
|
|
4331
|
+
* 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.
|
|
4112
4332
|
* @type {string}
|
|
4113
4333
|
* @memberof RRTConnectAlgorithm
|
|
4114
4334
|
*/
|
|
@@ -4119,6 +4339,30 @@ export interface RRTConnectAlgorithm {
|
|
|
4119
4339
|
* @memberof RRTConnectAlgorithm
|
|
4120
4340
|
*/
|
|
4121
4341
|
'max_iterations'?: number;
|
|
4342
|
+
/**
|
|
4343
|
+
* Maximum step size for tree extension in joint space.
|
|
4344
|
+
* @type {number}
|
|
4345
|
+
* @memberof RRTConnectAlgorithm
|
|
4346
|
+
*/
|
|
4347
|
+
'max_step_size'?: number;
|
|
4348
|
+
/**
|
|
4349
|
+
* Adjust the maximum step size during the search based on the recent success rate of tree expansion.
|
|
4350
|
+
* @type {boolean}
|
|
4351
|
+
* @memberof RRTConnectAlgorithm
|
|
4352
|
+
*/
|
|
4353
|
+
'adaptive_step_size'?: boolean;
|
|
4354
|
+
/**
|
|
4355
|
+
* Apply smoothing after the search has succeeded. This will remove as many intermediate points as possible while keeping the path valid.
|
|
4356
|
+
* @type {boolean}
|
|
4357
|
+
* @memberof RRTConnectAlgorithm
|
|
4358
|
+
*/
|
|
4359
|
+
'apply_smoothing'?: boolean;
|
|
4360
|
+
/**
|
|
4361
|
+
* Apply blending after the search has succeeded and smoothing has been applied. This will apply the largest viable blending at each intermediate point.
|
|
4362
|
+
* @type {boolean}
|
|
4363
|
+
* @memberof RRTConnectAlgorithm
|
|
4364
|
+
*/
|
|
4365
|
+
'apply_blending'?: boolean;
|
|
4122
4366
|
}
|
|
4123
4367
|
export declare const RRTConnectAlgorithmAlgorithmNameEnum: {
|
|
4124
4368
|
readonly RrtConnectAlgorithm: "RRTConnectAlgorithm";
|
|
@@ -4850,9 +5094,19 @@ export type TrajectoryDetailsKindEnum = typeof TrajectoryDetailsKindEnum[keyof t
|
|
|
4850
5094
|
* @type TrajectoryDetailsState
|
|
4851
5095
|
* @export
|
|
4852
5096
|
*/
|
|
4853
|
-
export type TrajectoryDetailsState =
|
|
5097
|
+
export type TrajectoryDetailsState = {
|
|
5098
|
+
kind: 'END_OF_TRAJECTORY';
|
|
5099
|
+
} & TrajectoryEnded | {
|
|
5100
|
+
kind: 'PAUSED_BY_USER';
|
|
5101
|
+
} & TrajectoryPausedByUser | {
|
|
5102
|
+
kind: 'PAUSED_ON_IO';
|
|
5103
|
+
} & TrajectoryPausedOnIO | {
|
|
5104
|
+
kind: 'RUNNING';
|
|
5105
|
+
} & TrajectoryRunning | {
|
|
5106
|
+
kind: 'WAIT_FOR_IO';
|
|
5107
|
+
} & TrajectoryWaitForIO;
|
|
4854
5108
|
/**
|
|
4855
|
-
*
|
|
5109
|
+
* First or last sample (depending on direction) of trajectory has been sent.
|
|
4856
5110
|
* @export
|
|
4857
5111
|
* @interface TrajectoryEnded
|
|
4858
5112
|
*/
|
|
@@ -4892,7 +5146,7 @@ export declare const TrajectoryIdMessageTypeEnum: {
|
|
|
4892
5146
|
};
|
|
4893
5147
|
export type TrajectoryIdMessageTypeEnum = typeof TrajectoryIdMessageTypeEnum[keyof typeof TrajectoryIdMessageTypeEnum];
|
|
4894
5148
|
/**
|
|
4895
|
-
*
|
|
5149
|
+
* User has paused execution.
|
|
4896
5150
|
* @export
|
|
4897
5151
|
* @interface TrajectoryPausedByUser
|
|
4898
5152
|
*/
|
|
@@ -4909,7 +5163,7 @@ export declare const TrajectoryPausedByUserKindEnum: {
|
|
|
4909
5163
|
};
|
|
4910
5164
|
export type TrajectoryPausedByUserKindEnum = typeof TrajectoryPausedByUserKindEnum[keyof typeof TrajectoryPausedByUserKindEnum];
|
|
4911
5165
|
/**
|
|
4912
|
-
*
|
|
5166
|
+
* Execution was paused because of an I/O event.
|
|
4913
5167
|
* @export
|
|
4914
5168
|
* @interface TrajectoryPausedOnIO
|
|
4915
5169
|
*/
|
|
@@ -4926,7 +5180,7 @@ export declare const TrajectoryPausedOnIOKindEnum: {
|
|
|
4926
5180
|
};
|
|
4927
5181
|
export type TrajectoryPausedOnIOKindEnum = typeof TrajectoryPausedOnIOKindEnum[keyof typeof TrajectoryPausedOnIOKindEnum];
|
|
4928
5182
|
/**
|
|
4929
|
-
*
|
|
5183
|
+
* Trajectory is being executed.
|
|
4930
5184
|
* @export
|
|
4931
5185
|
* @interface TrajectoryRunning
|
|
4932
5186
|
*/
|
|
@@ -4949,7 +5203,7 @@ export declare const TrajectoryRunningKindEnum: {
|
|
|
4949
5203
|
};
|
|
4950
5204
|
export type TrajectoryRunningKindEnum = typeof TrajectoryRunningKindEnum[keyof typeof TrajectoryRunningKindEnum];
|
|
4951
5205
|
/**
|
|
4952
|
-
*
|
|
5206
|
+
* Waiting for an I/O event to start execution.
|
|
4953
5207
|
* @export
|
|
4954
5208
|
* @interface TrajectoryWaitForIO
|
|
4955
5209
|
*/
|
|
@@ -5052,6 +5306,31 @@ export interface ValidationError {
|
|
|
5052
5306
|
[key: string]: any;
|
|
5053
5307
|
};
|
|
5054
5308
|
}
|
|
5309
|
+
/**
|
|
5310
|
+
* A validation error of a program.
|
|
5311
|
+
* @export
|
|
5312
|
+
* @interface ValidationError2
|
|
5313
|
+
*/
|
|
5314
|
+
export interface ValidationError2 {
|
|
5315
|
+
/**
|
|
5316
|
+
*
|
|
5317
|
+
* @type {Array<number>}
|
|
5318
|
+
* @memberof ValidationError2
|
|
5319
|
+
*/
|
|
5320
|
+
'loc': Array<number>;
|
|
5321
|
+
/**
|
|
5322
|
+
*
|
|
5323
|
+
* @type {string}
|
|
5324
|
+
* @memberof ValidationError2
|
|
5325
|
+
*/
|
|
5326
|
+
'msg': string;
|
|
5327
|
+
/**
|
|
5328
|
+
*
|
|
5329
|
+
* @type {string}
|
|
5330
|
+
* @memberof ValidationError2
|
|
5331
|
+
*/
|
|
5332
|
+
'type': string;
|
|
5333
|
+
}
|
|
5055
5334
|
/**
|
|
5056
5335
|
* @type ValidationErrorLocInner
|
|
5057
5336
|
* @export
|
|
@@ -5542,7 +5821,7 @@ export declare class ApplicationApi extends BaseAPI {
|
|
|
5542
5821
|
*/
|
|
5543
5822
|
export declare const BUSInputsOutputsApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
5544
5823
|
/**
|
|
5545
|
-
* Add
|
|
5824
|
+
* Add the BUS inputs/outputs service to the cell. Starts a containerized service that enables BUS connections via the specified ethernet port.
|
|
5546
5825
|
* @summary Add Service
|
|
5547
5826
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5548
5827
|
* @param {BusIOType} busIOType
|
|
@@ -5552,7 +5831,7 @@ export declare const BUSInputsOutputsApiAxiosParamCreator: (configuration?: Conf
|
|
|
5552
5831
|
*/
|
|
5553
5832
|
addBusIOService: (cell: string, busIOType: BusIOType, completionTimeout?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
5554
5833
|
/**
|
|
5555
|
-
* Adds an input/output to or updates an input/output on the PROFINET device.
|
|
5834
|
+
* 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).
|
|
5556
5835
|
* @summary Add PROFINET Input/Output
|
|
5557
5836
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5558
5837
|
* @param {string} io Unique identifier to address an Input/Output in the cell.
|
|
@@ -5562,7 +5841,7 @@ export declare const BUSInputsOutputsApiAxiosParamCreator: (configuration?: Conf
|
|
|
5562
5841
|
*/
|
|
5563
5842
|
addProfinetIO: (cell: string, io: string, profinetIOData: ProfinetIOData, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
5564
5843
|
/**
|
|
5565
|
-
*
|
|
5844
|
+
* Remove the BUS inputs/outputs service from the cell.
|
|
5566
5845
|
* @summary Clear Service
|
|
5567
5846
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5568
5847
|
* @param {number} [completionTimeout]
|
|
@@ -5571,7 +5850,7 @@ export declare const BUSInputsOutputsApiAxiosParamCreator: (configuration?: Conf
|
|
|
5571
5850
|
*/
|
|
5572
5851
|
clearBusIOService: (cell: string, completionTimeout?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
5573
5852
|
/**
|
|
5574
|
-
* Removes
|
|
5853
|
+
* Removes an input/output variable configuration from the PROFINET device, e.g. NOVA\'s PROFINET service.
|
|
5575
5854
|
* @summary Remove PROFINET Input/Ouptut
|
|
5576
5855
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5577
5856
|
* @param {string} io Unique identifier to address an Input/Output in the cell.
|
|
@@ -5580,7 +5859,7 @@ export declare const BUSInputsOutputsApiAxiosParamCreator: (configuration?: Conf
|
|
|
5580
5859
|
*/
|
|
5581
5860
|
deleteProfinetIO: (cell: string, io: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
5582
5861
|
/**
|
|
5583
|
-
* Get deployed BUS
|
|
5862
|
+
* Get deployed BUS inputs/outputs service.
|
|
5584
5863
|
* @summary Get Service
|
|
5585
5864
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5586
5865
|
* @param {*} [options] Override http request option.
|
|
@@ -5605,7 +5884,7 @@ export declare const BUSInputsOutputsApiAxiosParamCreator: (configuration?: Conf
|
|
|
5605
5884
|
*/
|
|
5606
5885
|
getBusIOValues: (cell: string, ios?: Array<string>, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
5607
5886
|
/**
|
|
5608
|
-
* Get description of PROFINET
|
|
5887
|
+
* Get description of NOVA as a PROFINET device.
|
|
5609
5888
|
* @summary Get PROFINET Description
|
|
5610
5889
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5611
5890
|
* @param {*} [options] Override http request option.
|
|
@@ -5613,7 +5892,7 @@ export declare const BUSInputsOutputsApiAxiosParamCreator: (configuration?: Conf
|
|
|
5613
5892
|
*/
|
|
5614
5893
|
getProfinetDescription: (cell: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
5615
5894
|
/**
|
|
5616
|
-
* Get input/output configuration of the PROFINET device as file.
|
|
5895
|
+
* 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.
|
|
5617
5896
|
* @summary PROFINET Inputs/Outputs to File
|
|
5618
5897
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5619
5898
|
* @param {number} [inputOffset]
|
|
@@ -5623,7 +5902,7 @@ export declare const BUSInputsOutputsApiAxiosParamCreator: (configuration?: Conf
|
|
|
5623
5902
|
*/
|
|
5624
5903
|
getProfinetIOsFromFile: (cell: string, inputOffset?: number, outputOffset?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
5625
5904
|
/**
|
|
5626
|
-
* List all BUS
|
|
5905
|
+
* List all input/output descriptions for configured BUS services. The input/output descriptions contain information such as the name, the type and the unit. The I/O direction is given in perspective of the BUS service.
|
|
5627
5906
|
* @summary List Descriptions
|
|
5628
5907
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5629
5908
|
* @param {*} [options] Override http request option.
|
|
@@ -5631,7 +5910,7 @@ export declare const BUSInputsOutputsApiAxiosParamCreator: (configuration?: Conf
|
|
|
5631
5910
|
*/
|
|
5632
5911
|
listBusIODescriptions: (cell: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
5633
5912
|
/**
|
|
5634
|
-
* List all PROFINET input and
|
|
5913
|
+
* List descriptions for all configured input/output variables of the PROFINET service. The input/output descriptions contain information such as the name, the type and the unit. The I/O direction is given in perspective of the PROFINET Device, e.g. the configured PROFINET service. The byte and bit addresses are the locations in the PROFINET input/output process image the variable points to. The PROFINET controller as well as NOVA\'s PROFINET service use an I/O variable configuration to interpret the bits of the input and output process image. The NOVA PROFINET service\'s configuration is modified via [addProfinetIO](addProfinetIO) and [setProfinetIOsFromFile](setProfinetIOsFromFile). For the PROFINET controller, e.g. a connected PLC, refer to the corresponding third party software, e.g. TIA portal.
|
|
5635
5914
|
* @summary List PROFINET Input/Output Configuration
|
|
5636
5915
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5637
5916
|
* @param {*} [options] Override http request option.
|
|
@@ -5648,7 +5927,7 @@ export declare const BUSInputsOutputsApiAxiosParamCreator: (configuration?: Conf
|
|
|
5648
5927
|
*/
|
|
5649
5928
|
setBusIOValues: (cell: string, iOValue: Array<IOValue>, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
5650
5929
|
/**
|
|
5651
|
-
* Sets
|
|
5930
|
+
* Sets Input/Output variable configuration on the PROFINET device (i.e. NOVA\'s PROFINET service) from XML file. The Inputs/Outputs map variables to specific memory addresses in the process image. The default process image has buffer lengths of 64 bytes for input and output. The size of the buffer is determined by the `config_file_content` that is passed in [addBusIOService](addBusIOService) and has to be in accordance with the GSDML file describing the PROFINET device. The PROFINET controller as well as NOVA\'s PROFINET service use an input/output variable configuration to interpret the bits of the input/output process image. The NOVA\'s PROFINET service\'s configuration can be viewed via [listProfinetIOs](listProfinetIOs). For the PROFINET controller (i.e. a connected PLC), refer to the corresponding engineering system (i.e. TIA portal). You can export the variable configuration of the PROFINET controller as XML file from you engineering system, i.e. TIA portal. The endpoint is built so that the perspective of input and output (PROFINET Device\'s input is PROFINET Controller\'s output) is internally handled, meaning that you can paste the exported XML file here without modifying.
|
|
5652
5931
|
* @summary Set PROFINET Inputs/Outputs from File
|
|
5653
5932
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5654
5933
|
* @param {ProfinetInputOutputConfig} profinetInputOutputConfig
|
|
@@ -5663,7 +5942,7 @@ export declare const BUSInputsOutputsApiAxiosParamCreator: (configuration?: Conf
|
|
|
5663
5942
|
*/
|
|
5664
5943
|
export declare const BUSInputsOutputsApiFp: (configuration?: Configuration) => {
|
|
5665
5944
|
/**
|
|
5666
|
-
* Add
|
|
5945
|
+
* Add the BUS inputs/outputs service to the cell. Starts a containerized service that enables BUS connections via the specified ethernet port.
|
|
5667
5946
|
* @summary Add Service
|
|
5668
5947
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5669
5948
|
* @param {BusIOType} busIOType
|
|
@@ -5673,7 +5952,7 @@ export declare const BUSInputsOutputsApiFp: (configuration?: Configuration) => {
|
|
|
5673
5952
|
*/
|
|
5674
5953
|
addBusIOService(cell: string, busIOType: BusIOType, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
5675
5954
|
/**
|
|
5676
|
-
* Adds an input/output to or updates an input/output on the PROFINET device.
|
|
5955
|
+
* 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).
|
|
5677
5956
|
* @summary Add PROFINET Input/Output
|
|
5678
5957
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5679
5958
|
* @param {string} io Unique identifier to address an Input/Output in the cell.
|
|
@@ -5683,7 +5962,7 @@ export declare const BUSInputsOutputsApiFp: (configuration?: Configuration) => {
|
|
|
5683
5962
|
*/
|
|
5684
5963
|
addProfinetIO(cell: string, io: string, profinetIOData: ProfinetIOData, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
5685
5964
|
/**
|
|
5686
|
-
*
|
|
5965
|
+
* Remove the BUS inputs/outputs service from the cell.
|
|
5687
5966
|
* @summary Clear Service
|
|
5688
5967
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5689
5968
|
* @param {number} [completionTimeout]
|
|
@@ -5692,7 +5971,7 @@ export declare const BUSInputsOutputsApiFp: (configuration?: Configuration) => {
|
|
|
5692
5971
|
*/
|
|
5693
5972
|
clearBusIOService(cell: string, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
5694
5973
|
/**
|
|
5695
|
-
* Removes
|
|
5974
|
+
* Removes an input/output variable configuration from the PROFINET device, e.g. NOVA\'s PROFINET service.
|
|
5696
5975
|
* @summary Remove PROFINET Input/Ouptut
|
|
5697
5976
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5698
5977
|
* @param {string} io Unique identifier to address an Input/Output in the cell.
|
|
@@ -5701,7 +5980,7 @@ export declare const BUSInputsOutputsApiFp: (configuration?: Configuration) => {
|
|
|
5701
5980
|
*/
|
|
5702
5981
|
deleteProfinetIO(cell: string, io: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
5703
5982
|
/**
|
|
5704
|
-
* Get deployed BUS
|
|
5983
|
+
* Get deployed BUS inputs/outputs service.
|
|
5705
5984
|
* @summary Get Service
|
|
5706
5985
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5707
5986
|
* @param {*} [options] Override http request option.
|
|
@@ -5726,7 +6005,7 @@ export declare const BUSInputsOutputsApiFp: (configuration?: Configuration) => {
|
|
|
5726
6005
|
*/
|
|
5727
6006
|
getBusIOValues(cell: string, ios?: Array<string>, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<IOValue>>>;
|
|
5728
6007
|
/**
|
|
5729
|
-
* Get description of PROFINET
|
|
6008
|
+
* Get description of NOVA as a PROFINET device.
|
|
5730
6009
|
* @summary Get PROFINET Description
|
|
5731
6010
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5732
6011
|
* @param {*} [options] Override http request option.
|
|
@@ -5734,7 +6013,7 @@ export declare const BUSInputsOutputsApiFp: (configuration?: Configuration) => {
|
|
|
5734
6013
|
*/
|
|
5735
6014
|
getProfinetDescription(cell: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ProfinetDescription>>;
|
|
5736
6015
|
/**
|
|
5737
|
-
* Get input/output configuration of the PROFINET device as file.
|
|
6016
|
+
* 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.
|
|
5738
6017
|
* @summary PROFINET Inputs/Outputs to File
|
|
5739
6018
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5740
6019
|
* @param {number} [inputOffset]
|
|
@@ -5744,15 +6023,15 @@ export declare const BUSInputsOutputsApiFp: (configuration?: Configuration) => {
|
|
|
5744
6023
|
*/
|
|
5745
6024
|
getProfinetIOsFromFile(cell: string, inputOffset?: number, outputOffset?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<string>>;
|
|
5746
6025
|
/**
|
|
5747
|
-
* List all BUS
|
|
6026
|
+
* List all input/output descriptions for configured BUS services. The input/output descriptions contain information such as the name, the type and the unit. The I/O direction is given in perspective of the BUS service.
|
|
5748
6027
|
* @summary List Descriptions
|
|
5749
6028
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5750
6029
|
* @param {*} [options] Override http request option.
|
|
5751
6030
|
* @throws {RequiredError}
|
|
5752
6031
|
*/
|
|
5753
|
-
listBusIODescriptions(cell: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<
|
|
6032
|
+
listBusIODescriptions(cell: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<IODescription2>>>;
|
|
5754
6033
|
/**
|
|
5755
|
-
* List all PROFINET input and
|
|
6034
|
+
* List descriptions for all configured input/output variables of the PROFINET service. The input/output descriptions contain information such as the name, the type and the unit. The I/O direction is given in perspective of the PROFINET Device, e.g. the configured PROFINET service. The byte and bit addresses are the locations in the PROFINET input/output process image the variable points to. The PROFINET controller as well as NOVA\'s PROFINET service use an I/O variable configuration to interpret the bits of the input and output process image. The NOVA PROFINET service\'s configuration is modified via [addProfinetIO](addProfinetIO) and [setProfinetIOsFromFile](setProfinetIOsFromFile). For the PROFINET controller, e.g. a connected PLC, refer to the corresponding third party software, e.g. TIA portal.
|
|
5756
6035
|
* @summary List PROFINET Input/Output Configuration
|
|
5757
6036
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5758
6037
|
* @param {*} [options] Override http request option.
|
|
@@ -5769,7 +6048,7 @@ export declare const BUSInputsOutputsApiFp: (configuration?: Configuration) => {
|
|
|
5769
6048
|
*/
|
|
5770
6049
|
setBusIOValues(cell: string, iOValue: Array<IOValue>, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
5771
6050
|
/**
|
|
5772
|
-
* Sets
|
|
6051
|
+
* Sets Input/Output variable configuration on the PROFINET device (i.e. NOVA\'s PROFINET service) from XML file. The Inputs/Outputs map variables to specific memory addresses in the process image. The default process image has buffer lengths of 64 bytes for input and output. The size of the buffer is determined by the `config_file_content` that is passed in [addBusIOService](addBusIOService) and has to be in accordance with the GSDML file describing the PROFINET device. The PROFINET controller as well as NOVA\'s PROFINET service use an input/output variable configuration to interpret the bits of the input/output process image. The NOVA\'s PROFINET service\'s configuration can be viewed via [listProfinetIOs](listProfinetIOs). For the PROFINET controller (i.e. a connected PLC), refer to the corresponding engineering system (i.e. TIA portal). You can export the variable configuration of the PROFINET controller as XML file from you engineering system, i.e. TIA portal. The endpoint is built so that the perspective of input and output (PROFINET Device\'s input is PROFINET Controller\'s output) is internally handled, meaning that you can paste the exported XML file here without modifying.
|
|
5773
6052
|
* @summary Set PROFINET Inputs/Outputs from File
|
|
5774
6053
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5775
6054
|
* @param {ProfinetInputOutputConfig} profinetInputOutputConfig
|
|
@@ -5784,7 +6063,7 @@ export declare const BUSInputsOutputsApiFp: (configuration?: Configuration) => {
|
|
|
5784
6063
|
*/
|
|
5785
6064
|
export declare const BUSInputsOutputsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
5786
6065
|
/**
|
|
5787
|
-
* Add
|
|
6066
|
+
* Add the BUS inputs/outputs service to the cell. Starts a containerized service that enables BUS connections via the specified ethernet port.
|
|
5788
6067
|
* @summary Add Service
|
|
5789
6068
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5790
6069
|
* @param {BusIOType} busIOType
|
|
@@ -5794,7 +6073,7 @@ export declare const BUSInputsOutputsApiFactory: (configuration?: Configuration,
|
|
|
5794
6073
|
*/
|
|
5795
6074
|
addBusIOService(cell: string, busIOType: BusIOType, completionTimeout?: number, options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
5796
6075
|
/**
|
|
5797
|
-
* Adds an input/output to or updates an input/output on the PROFINET device.
|
|
6076
|
+
* 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).
|
|
5798
6077
|
* @summary Add PROFINET Input/Output
|
|
5799
6078
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5800
6079
|
* @param {string} io Unique identifier to address an Input/Output in the cell.
|
|
@@ -5804,7 +6083,7 @@ export declare const BUSInputsOutputsApiFactory: (configuration?: Configuration,
|
|
|
5804
6083
|
*/
|
|
5805
6084
|
addProfinetIO(cell: string, io: string, profinetIOData: ProfinetIOData, options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
5806
6085
|
/**
|
|
5807
|
-
*
|
|
6086
|
+
* Remove the BUS inputs/outputs service from the cell.
|
|
5808
6087
|
* @summary Clear Service
|
|
5809
6088
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5810
6089
|
* @param {number} [completionTimeout]
|
|
@@ -5813,7 +6092,7 @@ export declare const BUSInputsOutputsApiFactory: (configuration?: Configuration,
|
|
|
5813
6092
|
*/
|
|
5814
6093
|
clearBusIOService(cell: string, completionTimeout?: number, options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
5815
6094
|
/**
|
|
5816
|
-
* Removes
|
|
6095
|
+
* Removes an input/output variable configuration from the PROFINET device, e.g. NOVA\'s PROFINET service.
|
|
5817
6096
|
* @summary Remove PROFINET Input/Ouptut
|
|
5818
6097
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5819
6098
|
* @param {string} io Unique identifier to address an Input/Output in the cell.
|
|
@@ -5822,7 +6101,7 @@ export declare const BUSInputsOutputsApiFactory: (configuration?: Configuration,
|
|
|
5822
6101
|
*/
|
|
5823
6102
|
deleteProfinetIO(cell: string, io: string, options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
5824
6103
|
/**
|
|
5825
|
-
* Get deployed BUS
|
|
6104
|
+
* Get deployed BUS inputs/outputs service.
|
|
5826
6105
|
* @summary Get Service
|
|
5827
6106
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5828
6107
|
* @param {*} [options] Override http request option.
|
|
@@ -5847,7 +6126,7 @@ export declare const BUSInputsOutputsApiFactory: (configuration?: Configuration,
|
|
|
5847
6126
|
*/
|
|
5848
6127
|
getBusIOValues(cell: string, ios?: Array<string>, options?: RawAxiosRequestConfig): AxiosPromise<Array<IOValue>>;
|
|
5849
6128
|
/**
|
|
5850
|
-
* Get description of PROFINET
|
|
6129
|
+
* Get description of NOVA as a PROFINET device.
|
|
5851
6130
|
* @summary Get PROFINET Description
|
|
5852
6131
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5853
6132
|
* @param {*} [options] Override http request option.
|
|
@@ -5855,7 +6134,7 @@ export declare const BUSInputsOutputsApiFactory: (configuration?: Configuration,
|
|
|
5855
6134
|
*/
|
|
5856
6135
|
getProfinetDescription(cell: string, options?: RawAxiosRequestConfig): AxiosPromise<ProfinetDescription>;
|
|
5857
6136
|
/**
|
|
5858
|
-
* Get input/output configuration of the PROFINET device as file.
|
|
6137
|
+
* 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.
|
|
5859
6138
|
* @summary PROFINET Inputs/Outputs to File
|
|
5860
6139
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5861
6140
|
* @param {number} [inputOffset]
|
|
@@ -5865,15 +6144,15 @@ export declare const BUSInputsOutputsApiFactory: (configuration?: Configuration,
|
|
|
5865
6144
|
*/
|
|
5866
6145
|
getProfinetIOsFromFile(cell: string, inputOffset?: number, outputOffset?: number, options?: RawAxiosRequestConfig): AxiosPromise<string>;
|
|
5867
6146
|
/**
|
|
5868
|
-
* List all BUS
|
|
6147
|
+
* List all input/output descriptions for configured BUS services. The input/output descriptions contain information such as the name, the type and the unit. The I/O direction is given in perspective of the BUS service.
|
|
5869
6148
|
* @summary List Descriptions
|
|
5870
6149
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5871
6150
|
* @param {*} [options] Override http request option.
|
|
5872
6151
|
* @throws {RequiredError}
|
|
5873
6152
|
*/
|
|
5874
|
-
listBusIODescriptions(cell: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<
|
|
6153
|
+
listBusIODescriptions(cell: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<IODescription2>>;
|
|
5875
6154
|
/**
|
|
5876
|
-
* List all PROFINET input and
|
|
6155
|
+
* List descriptions for all configured input/output variables of the PROFINET service. The input/output descriptions contain information such as the name, the type and the unit. The I/O direction is given in perspective of the PROFINET Device, e.g. the configured PROFINET service. The byte and bit addresses are the locations in the PROFINET input/output process image the variable points to. The PROFINET controller as well as NOVA\'s PROFINET service use an I/O variable configuration to interpret the bits of the input and output process image. The NOVA PROFINET service\'s configuration is modified via [addProfinetIO](addProfinetIO) and [setProfinetIOsFromFile](setProfinetIOsFromFile). For the PROFINET controller, e.g. a connected PLC, refer to the corresponding third party software, e.g. TIA portal.
|
|
5877
6156
|
* @summary List PROFINET Input/Output Configuration
|
|
5878
6157
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5879
6158
|
* @param {*} [options] Override http request option.
|
|
@@ -5890,7 +6169,7 @@ export declare const BUSInputsOutputsApiFactory: (configuration?: Configuration,
|
|
|
5890
6169
|
*/
|
|
5891
6170
|
setBusIOValues(cell: string, iOValue: Array<IOValue>, options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
5892
6171
|
/**
|
|
5893
|
-
* Sets
|
|
6172
|
+
* Sets Input/Output variable configuration on the PROFINET device (i.e. NOVA\'s PROFINET service) from XML file. The Inputs/Outputs map variables to specific memory addresses in the process image. The default process image has buffer lengths of 64 bytes for input and output. The size of the buffer is determined by the `config_file_content` that is passed in [addBusIOService](addBusIOService) and has to be in accordance with the GSDML file describing the PROFINET device. The PROFINET controller as well as NOVA\'s PROFINET service use an input/output variable configuration to interpret the bits of the input/output process image. The NOVA\'s PROFINET service\'s configuration can be viewed via [listProfinetIOs](listProfinetIOs). For the PROFINET controller (i.e. a connected PLC), refer to the corresponding engineering system (i.e. TIA portal). You can export the variable configuration of the PROFINET controller as XML file from you engineering system, i.e. TIA portal. The endpoint is built so that the perspective of input and output (PROFINET Device\'s input is PROFINET Controller\'s output) is internally handled, meaning that you can paste the exported XML file here without modifying.
|
|
5894
6173
|
* @summary Set PROFINET Inputs/Outputs from File
|
|
5895
6174
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5896
6175
|
* @param {ProfinetInputOutputConfig} profinetInputOutputConfig
|
|
@@ -5907,7 +6186,7 @@ export declare const BUSInputsOutputsApiFactory: (configuration?: Configuration,
|
|
|
5907
6186
|
*/
|
|
5908
6187
|
export declare class BUSInputsOutputsApi extends BaseAPI {
|
|
5909
6188
|
/**
|
|
5910
|
-
* Add
|
|
6189
|
+
* Add the BUS inputs/outputs service to the cell. Starts a containerized service that enables BUS connections via the specified ethernet port.
|
|
5911
6190
|
* @summary Add Service
|
|
5912
6191
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5913
6192
|
* @param {BusIOType} busIOType
|
|
@@ -5918,7 +6197,7 @@ export declare class BUSInputsOutputsApi extends BaseAPI {
|
|
|
5918
6197
|
*/
|
|
5919
6198
|
addBusIOService(cell: string, busIOType: BusIOType, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
5920
6199
|
/**
|
|
5921
|
-
* Adds an input/output to or updates an input/output on the PROFINET device.
|
|
6200
|
+
* 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).
|
|
5922
6201
|
* @summary Add PROFINET Input/Output
|
|
5923
6202
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5924
6203
|
* @param {string} io Unique identifier to address an Input/Output in the cell.
|
|
@@ -5929,7 +6208,7 @@ export declare class BUSInputsOutputsApi extends BaseAPI {
|
|
|
5929
6208
|
*/
|
|
5930
6209
|
addProfinetIO(cell: string, io: string, profinetIOData: ProfinetIOData, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
5931
6210
|
/**
|
|
5932
|
-
*
|
|
6211
|
+
* Remove the BUS inputs/outputs service from the cell.
|
|
5933
6212
|
* @summary Clear Service
|
|
5934
6213
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5935
6214
|
* @param {number} [completionTimeout]
|
|
@@ -5939,7 +6218,7 @@ export declare class BUSInputsOutputsApi extends BaseAPI {
|
|
|
5939
6218
|
*/
|
|
5940
6219
|
clearBusIOService(cell: string, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
5941
6220
|
/**
|
|
5942
|
-
* Removes
|
|
6221
|
+
* Removes an input/output variable configuration from the PROFINET device, e.g. NOVA\'s PROFINET service.
|
|
5943
6222
|
* @summary Remove PROFINET Input/Ouptut
|
|
5944
6223
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5945
6224
|
* @param {string} io Unique identifier to address an Input/Output in the cell.
|
|
@@ -5949,16 +6228,14 @@ export declare class BUSInputsOutputsApi extends BaseAPI {
|
|
|
5949
6228
|
*/
|
|
5950
6229
|
deleteProfinetIO(cell: string, io: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
5951
6230
|
/**
|
|
5952
|
-
* Get deployed BUS
|
|
6231
|
+
* Get deployed BUS inputs/outputs service.
|
|
5953
6232
|
* @summary Get Service
|
|
5954
6233
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5955
6234
|
* @param {*} [options] Override http request option.
|
|
5956
6235
|
* @throws {RequiredError}
|
|
5957
6236
|
* @memberof BUSInputsOutputsApi
|
|
5958
6237
|
*/
|
|
5959
|
-
getBusIOService(cell: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<
|
|
5960
|
-
bus_type: "profinet";
|
|
5961
|
-
} & BusIOProfinet, any>>;
|
|
6238
|
+
getBusIOService(cell: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<BusIOType, any>>;
|
|
5962
6239
|
/**
|
|
5963
6240
|
* Get the current state of the BUS Inputs/Outputs service.
|
|
5964
6241
|
* @summary State
|
|
@@ -5979,7 +6256,7 @@ export declare class BUSInputsOutputsApi extends BaseAPI {
|
|
|
5979
6256
|
*/
|
|
5980
6257
|
getBusIOValues(cell: string, ios?: Array<string>, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<IOValue[], any>>;
|
|
5981
6258
|
/**
|
|
5982
|
-
* Get description of PROFINET
|
|
6259
|
+
* Get description of NOVA as a PROFINET device.
|
|
5983
6260
|
* @summary Get PROFINET Description
|
|
5984
6261
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5985
6262
|
* @param {*} [options] Override http request option.
|
|
@@ -5988,7 +6265,7 @@ export declare class BUSInputsOutputsApi extends BaseAPI {
|
|
|
5988
6265
|
*/
|
|
5989
6266
|
getProfinetDescription(cell: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ProfinetDescription, any>>;
|
|
5990
6267
|
/**
|
|
5991
|
-
* Get input/output configuration of the PROFINET device as file.
|
|
6268
|
+
* 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.
|
|
5992
6269
|
* @summary PROFINET Inputs/Outputs to File
|
|
5993
6270
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5994
6271
|
* @param {number} [inputOffset]
|
|
@@ -5999,16 +6276,16 @@ export declare class BUSInputsOutputsApi extends BaseAPI {
|
|
|
5999
6276
|
*/
|
|
6000
6277
|
getProfinetIOsFromFile(cell: string, inputOffset?: number, outputOffset?: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<string, any>>;
|
|
6001
6278
|
/**
|
|
6002
|
-
* List all BUS
|
|
6279
|
+
* List all input/output descriptions for configured BUS services. The input/output descriptions contain information such as the name, the type and the unit. The I/O direction is given in perspective of the BUS service.
|
|
6003
6280
|
* @summary List Descriptions
|
|
6004
6281
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
6005
6282
|
* @param {*} [options] Override http request option.
|
|
6006
6283
|
* @throws {RequiredError}
|
|
6007
6284
|
* @memberof BUSInputsOutputsApi
|
|
6008
6285
|
*/
|
|
6009
|
-
listBusIODescriptions(cell: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<
|
|
6286
|
+
listBusIODescriptions(cell: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<IODescription2[], any>>;
|
|
6010
6287
|
/**
|
|
6011
|
-
* List all PROFINET input and
|
|
6288
|
+
* List descriptions for all configured input/output variables of the PROFINET service. The input/output descriptions contain information such as the name, the type and the unit. The I/O direction is given in perspective of the PROFINET Device, e.g. the configured PROFINET service. The byte and bit addresses are the locations in the PROFINET input/output process image the variable points to. The PROFINET controller as well as NOVA\'s PROFINET service use an I/O variable configuration to interpret the bits of the input and output process image. The NOVA PROFINET service\'s configuration is modified via [addProfinetIO](addProfinetIO) and [setProfinetIOsFromFile](setProfinetIOsFromFile). For the PROFINET controller, e.g. a connected PLC, refer to the corresponding third party software, e.g. TIA portal.
|
|
6012
6289
|
* @summary List PROFINET Input/Output Configuration
|
|
6013
6290
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
6014
6291
|
* @param {*} [options] Override http request option.
|
|
@@ -6027,7 +6304,7 @@ export declare class BUSInputsOutputsApi extends BaseAPI {
|
|
|
6027
6304
|
*/
|
|
6028
6305
|
setBusIOValues(cell: string, iOValue: Array<IOValue>, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
6029
6306
|
/**
|
|
6030
|
-
* Sets
|
|
6307
|
+
* Sets Input/Output variable configuration on the PROFINET device (i.e. NOVA\'s PROFINET service) from XML file. The Inputs/Outputs map variables to specific memory addresses in the process image. The default process image has buffer lengths of 64 bytes for input and output. The size of the buffer is determined by the `config_file_content` that is passed in [addBusIOService](addBusIOService) and has to be in accordance with the GSDML file describing the PROFINET device. The PROFINET controller as well as NOVA\'s PROFINET service use an input/output variable configuration to interpret the bits of the input/output process image. The NOVA\'s PROFINET service\'s configuration can be viewed via [listProfinetIOs](listProfinetIOs). For the PROFINET controller (i.e. a connected PLC), refer to the corresponding engineering system (i.e. TIA portal). You can export the variable configuration of the PROFINET controller as XML file from you engineering system, i.e. TIA portal. The endpoint is built so that the perspective of input and output (PROFINET Device\'s input is PROFINET Controller\'s output) is internally handled, meaning that you can paste the exported XML file here without modifying.
|
|
6031
6308
|
* @summary Set PROFINET Inputs/Outputs from File
|
|
6032
6309
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
6033
6310
|
* @param {ProfinetInputOutputConfig} profinetInputOutputConfig
|
|
@@ -7617,7 +7894,7 @@ export declare class MotionGroupApi extends BaseAPI {
|
|
|
7617
7894
|
*/
|
|
7618
7895
|
export declare const MotionGroupModelsApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
7619
7896
|
/**
|
|
7620
|
-
* Returns the default collision link chain for a given motion group model. See [
|
|
7897
|
+
* 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.
|
|
7621
7898
|
* @summary Get Collision Model
|
|
7622
7899
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
7623
7900
|
* @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).
|
|
@@ -7640,7 +7917,7 @@ export declare const MotionGroupModelsApiAxiosParamCreator: (configuration?: Con
|
|
|
7640
7917
|
*/
|
|
7641
7918
|
export declare const MotionGroupModelsApiFp: (configuration?: Configuration) => {
|
|
7642
7919
|
/**
|
|
7643
|
-
* Returns the default collision link chain for a given motion group model. See [
|
|
7920
|
+
* 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.
|
|
7644
7921
|
* @summary Get Collision Model
|
|
7645
7922
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
7646
7923
|
* @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).
|
|
@@ -7665,7 +7942,7 @@ export declare const MotionGroupModelsApiFp: (configuration?: Configuration) =>
|
|
|
7665
7942
|
*/
|
|
7666
7943
|
export declare const MotionGroupModelsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
7667
7944
|
/**
|
|
7668
|
-
* Returns the default collision link chain for a given motion group model. See [
|
|
7945
|
+
* 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.
|
|
7669
7946
|
* @summary Get Collision Model
|
|
7670
7947
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
7671
7948
|
* @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).
|
|
@@ -7692,7 +7969,7 @@ export declare const MotionGroupModelsApiFactory: (configuration?: Configuration
|
|
|
7692
7969
|
*/
|
|
7693
7970
|
export declare class MotionGroupModelsApi extends BaseAPI {
|
|
7694
7971
|
/**
|
|
7695
|
-
* Returns the default collision link chain for a given motion group model. See [
|
|
7972
|
+
* 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.
|
|
7696
7973
|
* @summary Get Collision Model
|
|
7697
7974
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
7698
7975
|
* @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).
|
|
@@ -7713,6 +7990,180 @@ export declare class MotionGroupModelsApi extends BaseAPI {
|
|
|
7713
7990
|
*/
|
|
7714
7991
|
getMotionGroupModels(cell: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<string[], any>>;
|
|
7715
7992
|
}
|
|
7993
|
+
/**
|
|
7994
|
+
* ProgramApi - axios parameter creator
|
|
7995
|
+
* @export
|
|
7996
|
+
*/
|
|
7997
|
+
export declare const ProgramApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
7998
|
+
/**
|
|
7999
|
+
* Get details of a program.
|
|
8000
|
+
* @summary Get program
|
|
8001
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8002
|
+
* @param {string} program
|
|
8003
|
+
* @param {*} [options] Override http request option.
|
|
8004
|
+
* @throws {RequiredError}
|
|
8005
|
+
*/
|
|
8006
|
+
getProgram: (cell: string, program: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
8007
|
+
/**
|
|
8008
|
+
* List details of all existing programs.
|
|
8009
|
+
* @summary List programs
|
|
8010
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8011
|
+
* @param {*} [options] Override http request option.
|
|
8012
|
+
* @throws {RequiredError}
|
|
8013
|
+
*/
|
|
8014
|
+
listPrograms: (cell: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
8015
|
+
/**
|
|
8016
|
+
* This endpoint starts a new program execution. The program will be executed asynchronously.
|
|
8017
|
+
* @summary Start the program
|
|
8018
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8019
|
+
* @param {string} program
|
|
8020
|
+
* @param {ProgramStartRequest} programStartRequest
|
|
8021
|
+
* @param {*} [options] Override http request option.
|
|
8022
|
+
* @throws {RequiredError}
|
|
8023
|
+
*/
|
|
8024
|
+
startProgram: (cell: string, program: string, programStartRequest: ProgramStartRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
8025
|
+
/**
|
|
8026
|
+
* Stop a specific program run.
|
|
8027
|
+
* @summary Stop program run
|
|
8028
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8029
|
+
* @param {string} program
|
|
8030
|
+
* @param {*} [options] Override http request option.
|
|
8031
|
+
* @throws {RequiredError}
|
|
8032
|
+
*/
|
|
8033
|
+
stopProgram: (cell: string, program: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
8034
|
+
};
|
|
8035
|
+
/**
|
|
8036
|
+
* ProgramApi - functional programming interface
|
|
8037
|
+
* @export
|
|
8038
|
+
*/
|
|
8039
|
+
export declare const ProgramApiFp: (configuration?: Configuration) => {
|
|
8040
|
+
/**
|
|
8041
|
+
* Get details of a program.
|
|
8042
|
+
* @summary Get program
|
|
8043
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8044
|
+
* @param {string} program
|
|
8045
|
+
* @param {*} [options] Override http request option.
|
|
8046
|
+
* @throws {RequiredError}
|
|
8047
|
+
*/
|
|
8048
|
+
getProgram(cell: string, program: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Program>>;
|
|
8049
|
+
/**
|
|
8050
|
+
* List details of all existing programs.
|
|
8051
|
+
* @summary List programs
|
|
8052
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8053
|
+
* @param {*} [options] Override http request option.
|
|
8054
|
+
* @throws {RequiredError}
|
|
8055
|
+
*/
|
|
8056
|
+
listPrograms(cell: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<Program>>>;
|
|
8057
|
+
/**
|
|
8058
|
+
* This endpoint starts a new program execution. The program will be executed asynchronously.
|
|
8059
|
+
* @summary Start the program
|
|
8060
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8061
|
+
* @param {string} program
|
|
8062
|
+
* @param {ProgramStartRequest} programStartRequest
|
|
8063
|
+
* @param {*} [options] Override http request option.
|
|
8064
|
+
* @throws {RequiredError}
|
|
8065
|
+
*/
|
|
8066
|
+
startProgram(cell: string, program: string, programStartRequest: ProgramStartRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ProgramRun>>;
|
|
8067
|
+
/**
|
|
8068
|
+
* Stop a specific program run.
|
|
8069
|
+
* @summary Stop program run
|
|
8070
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8071
|
+
* @param {string} program
|
|
8072
|
+
* @param {*} [options] Override http request option.
|
|
8073
|
+
* @throws {RequiredError}
|
|
8074
|
+
*/
|
|
8075
|
+
stopProgram(cell: string, program: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
8076
|
+
};
|
|
8077
|
+
/**
|
|
8078
|
+
* ProgramApi - factory interface
|
|
8079
|
+
* @export
|
|
8080
|
+
*/
|
|
8081
|
+
export declare const ProgramApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
8082
|
+
/**
|
|
8083
|
+
* Get details of a program.
|
|
8084
|
+
* @summary Get program
|
|
8085
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8086
|
+
* @param {string} program
|
|
8087
|
+
* @param {*} [options] Override http request option.
|
|
8088
|
+
* @throws {RequiredError}
|
|
8089
|
+
*/
|
|
8090
|
+
getProgram(cell: string, program: string, options?: RawAxiosRequestConfig): AxiosPromise<Program>;
|
|
8091
|
+
/**
|
|
8092
|
+
* List details of all existing programs.
|
|
8093
|
+
* @summary List programs
|
|
8094
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8095
|
+
* @param {*} [options] Override http request option.
|
|
8096
|
+
* @throws {RequiredError}
|
|
8097
|
+
*/
|
|
8098
|
+
listPrograms(cell: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<Program>>;
|
|
8099
|
+
/**
|
|
8100
|
+
* This endpoint starts a new program execution. The program will be executed asynchronously.
|
|
8101
|
+
* @summary Start the program
|
|
8102
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8103
|
+
* @param {string} program
|
|
8104
|
+
* @param {ProgramStartRequest} programStartRequest
|
|
8105
|
+
* @param {*} [options] Override http request option.
|
|
8106
|
+
* @throws {RequiredError}
|
|
8107
|
+
*/
|
|
8108
|
+
startProgram(cell: string, program: string, programStartRequest: ProgramStartRequest, options?: RawAxiosRequestConfig): AxiosPromise<ProgramRun>;
|
|
8109
|
+
/**
|
|
8110
|
+
* Stop a specific program run.
|
|
8111
|
+
* @summary Stop program run
|
|
8112
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8113
|
+
* @param {string} program
|
|
8114
|
+
* @param {*} [options] Override http request option.
|
|
8115
|
+
* @throws {RequiredError}
|
|
8116
|
+
*/
|
|
8117
|
+
stopProgram(cell: string, program: string, options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
8118
|
+
};
|
|
8119
|
+
/**
|
|
8120
|
+
* ProgramApi - object-oriented interface
|
|
8121
|
+
* @export
|
|
8122
|
+
* @class ProgramApi
|
|
8123
|
+
* @extends {BaseAPI}
|
|
8124
|
+
*/
|
|
8125
|
+
export declare class ProgramApi extends BaseAPI {
|
|
8126
|
+
/**
|
|
8127
|
+
* Get details of a program.
|
|
8128
|
+
* @summary Get program
|
|
8129
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8130
|
+
* @param {string} program
|
|
8131
|
+
* @param {*} [options] Override http request option.
|
|
8132
|
+
* @throws {RequiredError}
|
|
8133
|
+
* @memberof ProgramApi
|
|
8134
|
+
*/
|
|
8135
|
+
getProgram(cell: string, program: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Program, any>>;
|
|
8136
|
+
/**
|
|
8137
|
+
* List details of all existing programs.
|
|
8138
|
+
* @summary List programs
|
|
8139
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8140
|
+
* @param {*} [options] Override http request option.
|
|
8141
|
+
* @throws {RequiredError}
|
|
8142
|
+
* @memberof ProgramApi
|
|
8143
|
+
*/
|
|
8144
|
+
listPrograms(cell: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Program[], any>>;
|
|
8145
|
+
/**
|
|
8146
|
+
* This endpoint starts a new program execution. The program will be executed asynchronously.
|
|
8147
|
+
* @summary Start the program
|
|
8148
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8149
|
+
* @param {string} program
|
|
8150
|
+
* @param {ProgramStartRequest} programStartRequest
|
|
8151
|
+
* @param {*} [options] Override http request option.
|
|
8152
|
+
* @throws {RequiredError}
|
|
8153
|
+
* @memberof ProgramApi
|
|
8154
|
+
*/
|
|
8155
|
+
startProgram(cell: string, program: string, programStartRequest: ProgramStartRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ProgramRun, any>>;
|
|
8156
|
+
/**
|
|
8157
|
+
* Stop a specific program run.
|
|
8158
|
+
* @summary Stop program run
|
|
8159
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8160
|
+
* @param {string} program
|
|
8161
|
+
* @param {*} [options] Override http request option.
|
|
8162
|
+
* @throws {RequiredError}
|
|
8163
|
+
* @memberof ProgramApi
|
|
8164
|
+
*/
|
|
8165
|
+
stopProgram(cell: string, program: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
8166
|
+
}
|
|
7716
8167
|
/**
|
|
7717
8168
|
* StoreCollisionComponentsApi - axios parameter creator
|
|
7718
8169
|
* @export
|
|
@@ -7781,7 +8232,7 @@ export declare const StoreCollisionComponentsApiAxiosParamCreator: (configuratio
|
|
|
7781
8232
|
*/
|
|
7782
8233
|
listCollisionLinkChains: (cell: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
7783
8234
|
/**
|
|
7784
|
-
* Returns
|
|
8235
|
+
* Returns all stored colliders.
|
|
7785
8236
|
* @summary List Colliders
|
|
7786
8237
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
7787
8238
|
* @param {*} [options] Override http request option.
|
|
@@ -7907,7 +8358,7 @@ export declare const StoreCollisionComponentsApiFp: (configuration?: Configurati
|
|
|
7907
8358
|
}>;
|
|
7908
8359
|
}>>;
|
|
7909
8360
|
/**
|
|
7910
|
-
* Returns
|
|
8361
|
+
* Returns all stored colliders.
|
|
7911
8362
|
* @summary List Colliders
|
|
7912
8363
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
7913
8364
|
* @param {*} [options] Override http request option.
|
|
@@ -8043,7 +8494,7 @@ export declare const StoreCollisionComponentsApiFactory: (configuration?: Config
|
|
|
8043
8494
|
}>;
|
|
8044
8495
|
}>;
|
|
8045
8496
|
/**
|
|
8046
|
-
* Returns
|
|
8497
|
+
* Returns all stored colliders.
|
|
8047
8498
|
* @summary List Colliders
|
|
8048
8499
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8049
8500
|
* @param {*} [options] Override http request option.
|
|
@@ -8188,7 +8639,7 @@ export declare class StoreCollisionComponentsApi extends BaseAPI {
|
|
|
8188
8639
|
}[];
|
|
8189
8640
|
}, any>>;
|
|
8190
8641
|
/**
|
|
8191
|
-
* Returns
|
|
8642
|
+
* Returns all stored colliders.
|
|
8192
8643
|
* @summary List Colliders
|
|
8193
8644
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8194
8645
|
* @param {*} [options] Override http request option.
|