@wandelbots/nova-api 25.8.0-dev.4 → 25.8.0-dev.41
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 +561 -116
- package/v2/api.js +402 -51
- package/v2/api.js.map +1 -1
- package/v2/api.ts +750 -112
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,13 @@ export interface BusIOProfinet {
|
|
|
354
354
|
*/
|
|
355
355
|
'bus_type'?: BusIOProfinetBusTypeEnum;
|
|
356
356
|
/**
|
|
357
|
-
*
|
|
358
|
-
* @type {string}
|
|
359
|
-
* @memberof BusIOProfinet
|
|
360
|
-
*/
|
|
361
|
-
'config_file_content'?: string;
|
|
362
|
-
/**
|
|
363
|
-
*
|
|
357
|
+
* Used to enable IP communication through the same physical interface while PN Driver is running.
|
|
364
358
|
* @type {BusIOProfinetNetwork}
|
|
365
359
|
* @memberof BusIOProfinet
|
|
366
360
|
*/
|
|
367
361
|
'network_config'?: BusIOProfinetNetwork;
|
|
368
362
|
/**
|
|
369
|
-
* MAC address
|
|
363
|
+
* MAC address of the physical ethernet interface that you want to use for PROFINET communication.
|
|
370
364
|
* @type {string}
|
|
371
365
|
* @memberof BusIOProfinet
|
|
372
366
|
*/
|
|
@@ -383,7 +377,7 @@ export declare const BusIOProfinetBusTypeEnum: {
|
|
|
383
377
|
};
|
|
384
378
|
export type BusIOProfinetBusTypeEnum = typeof BusIOProfinetBusTypeEnum[keyof typeof BusIOProfinetBusTypeEnum];
|
|
385
379
|
/**
|
|
386
|
-
*
|
|
380
|
+
* 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
381
|
* @export
|
|
388
382
|
* @interface BusIOProfinetDefaultRoute
|
|
389
383
|
*/
|
|
@@ -402,25 +396,25 @@ export interface BusIOProfinetDefaultRoute {
|
|
|
402
396
|
'interface': string;
|
|
403
397
|
}
|
|
404
398
|
/**
|
|
405
|
-
* Network configuration
|
|
399
|
+
* 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
400
|
* @export
|
|
407
401
|
* @interface BusIOProfinetIpConfig
|
|
408
402
|
*/
|
|
409
403
|
export interface BusIOProfinetIpConfig {
|
|
410
404
|
/**
|
|
411
|
-
* IP address for the
|
|
405
|
+
* IP address for the device\'s virtual ethernet interface (pnio1).
|
|
412
406
|
* @type {string}
|
|
413
407
|
* @memberof BusIOProfinetIpConfig
|
|
414
408
|
*/
|
|
415
409
|
'ip': string;
|
|
416
410
|
/**
|
|
417
|
-
* Network mask for the
|
|
411
|
+
* Network mask for the device\'s virtual ethernet interface (pnio1).
|
|
418
412
|
* @type {string}
|
|
419
413
|
* @memberof BusIOProfinetIpConfig
|
|
420
414
|
*/
|
|
421
415
|
'netmask': string;
|
|
422
416
|
/**
|
|
423
|
-
* Gateway for the
|
|
417
|
+
* Gateway for connections to other devices outside of the virtual ethernet interface\'s subnet.
|
|
424
418
|
* @type {string}
|
|
425
419
|
* @memberof BusIOProfinetIpConfig
|
|
426
420
|
*/
|
|
@@ -433,7 +427,7 @@ export interface BusIOProfinetIpConfig {
|
|
|
433
427
|
*/
|
|
434
428
|
export interface BusIOProfinetNetwork {
|
|
435
429
|
/**
|
|
436
|
-
* Name of the PROFINET device.
|
|
430
|
+
* 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
431
|
* @type {string}
|
|
438
432
|
* @memberof BusIOProfinetNetwork
|
|
439
433
|
*/
|
|
@@ -445,14 +439,14 @@ export interface BusIOProfinetNetwork {
|
|
|
445
439
|
*/
|
|
446
440
|
'ip_config'?: BusIOProfinetIpConfig;
|
|
447
441
|
/**
|
|
448
|
-
* Content of the PROFINET REMA XML file.
|
|
442
|
+
* 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
443
|
* @type {string}
|
|
450
444
|
* @memberof BusIOProfinetNetwork
|
|
451
445
|
*/
|
|
452
446
|
'rema_xml_content'?: string;
|
|
453
447
|
}
|
|
454
448
|
/**
|
|
455
|
-
* Virtual PROFINET BUS
|
|
449
|
+
* Virtual PROFINET BUS inputs/outputs service configuration.
|
|
456
450
|
* @export
|
|
457
451
|
* @interface BusIOProfinetVirtual
|
|
458
452
|
*/
|
|
@@ -465,7 +459,7 @@ export interface BusIOProfinetVirtual {
|
|
|
465
459
|
'bus_type'?: BusIOProfinetVirtualBusTypeEnum;
|
|
466
460
|
}
|
|
467
461
|
export declare const BusIOProfinetVirtualBusTypeEnum: {
|
|
468
|
-
readonly
|
|
462
|
+
readonly ProfinetVirtual: "profinet_virtual";
|
|
469
463
|
};
|
|
470
464
|
export type BusIOProfinetVirtualBusTypeEnum = typeof BusIOProfinetVirtualBusTypeEnum[keyof typeof BusIOProfinetVirtualBusTypeEnum];
|
|
471
465
|
/**
|
|
@@ -490,7 +484,7 @@ export interface BusIOsState {
|
|
|
490
484
|
*/
|
|
491
485
|
'state': BusIOsStateEnum;
|
|
492
486
|
/**
|
|
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.
|
|
487
|
+
* 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
488
|
* @type {string}
|
|
495
489
|
* @memberof BusIOsState
|
|
496
490
|
*/
|
|
@@ -1708,9 +1702,22 @@ export interface GetTrajectoryResponse {
|
|
|
1708
1702
|
export interface HTTPValidationError {
|
|
1709
1703
|
/**
|
|
1710
1704
|
*
|
|
1711
|
-
* @type {Array<
|
|
1705
|
+
* @type {Array<ValidationError2>}
|
|
1712
1706
|
* @memberof HTTPValidationError
|
|
1713
1707
|
*/
|
|
1708
|
+
'detail'?: Array<ValidationError2>;
|
|
1709
|
+
}
|
|
1710
|
+
/**
|
|
1711
|
+
*
|
|
1712
|
+
* @export
|
|
1713
|
+
* @interface HTTPValidationError2
|
|
1714
|
+
*/
|
|
1715
|
+
export interface HTTPValidationError2 {
|
|
1716
|
+
/**
|
|
1717
|
+
*
|
|
1718
|
+
* @type {Array<ValidationError>}
|
|
1719
|
+
* @memberof HTTPValidationError2
|
|
1720
|
+
*/
|
|
1714
1721
|
'detail'?: Array<ValidationError>;
|
|
1715
1722
|
}
|
|
1716
1723
|
/**
|
|
@@ -1797,6 +1804,55 @@ export interface IODescription {
|
|
|
1797
1804
|
*/
|
|
1798
1805
|
'max'?: IODescriptionMin;
|
|
1799
1806
|
}
|
|
1807
|
+
/**
|
|
1808
|
+
*
|
|
1809
|
+
* @export
|
|
1810
|
+
* @interface IODescription2
|
|
1811
|
+
*/
|
|
1812
|
+
export interface IODescription2 {
|
|
1813
|
+
/**
|
|
1814
|
+
* Unique identifier of the input/output.
|
|
1815
|
+
* @type {string}
|
|
1816
|
+
* @memberof IODescription2
|
|
1817
|
+
*/
|
|
1818
|
+
'io': string;
|
|
1819
|
+
/**
|
|
1820
|
+
* Descriptive name of the input/output. Customize it using the respective BUS service, e.g. [addProfinetIO](addProfinetIO) for PROFINET service.
|
|
1821
|
+
* @type {string}
|
|
1822
|
+
* @memberof IODescription2
|
|
1823
|
+
*/
|
|
1824
|
+
'name': string;
|
|
1825
|
+
/**
|
|
1826
|
+
*
|
|
1827
|
+
* @type {IODirection}
|
|
1828
|
+
* @memberof IODescription2
|
|
1829
|
+
*/
|
|
1830
|
+
'direction': IODirection;
|
|
1831
|
+
/**
|
|
1832
|
+
*
|
|
1833
|
+
* @type {IOValueType}
|
|
1834
|
+
* @memberof IODescription2
|
|
1835
|
+
*/
|
|
1836
|
+
'value_type': IOValueType;
|
|
1837
|
+
/**
|
|
1838
|
+
*
|
|
1839
|
+
* @type {UnitType}
|
|
1840
|
+
* @memberof IODescription2
|
|
1841
|
+
*/
|
|
1842
|
+
'unit'?: UnitType;
|
|
1843
|
+
/**
|
|
1844
|
+
*
|
|
1845
|
+
* @type {IODescriptionMin}
|
|
1846
|
+
* @memberof IODescription2
|
|
1847
|
+
*/
|
|
1848
|
+
'min'?: IODescriptionMin;
|
|
1849
|
+
/**
|
|
1850
|
+
*
|
|
1851
|
+
* @type {IODescriptionMin}
|
|
1852
|
+
* @memberof IODescription2
|
|
1853
|
+
*/
|
|
1854
|
+
'max'?: IODescriptionMin;
|
|
1855
|
+
}
|
|
1800
1856
|
/**
|
|
1801
1857
|
* @type IODescriptionMin
|
|
1802
1858
|
* @export
|
|
@@ -1860,7 +1916,7 @@ export interface IOIntegerValue {
|
|
|
1860
1916
|
*/
|
|
1861
1917
|
'io': string;
|
|
1862
1918
|
/**
|
|
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. >
|
|
1919
|
+
* 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
1920
|
* @type {string}
|
|
1865
1921
|
* @memberof IOIntegerValue
|
|
1866
1922
|
*/
|
|
@@ -2112,7 +2168,7 @@ export declare const InitializeMovementResponseKindEnum: {
|
|
|
2112
2168
|
};
|
|
2113
2169
|
export type InitializeMovementResponseKindEnum = typeof InitializeMovementResponseKindEnum[keyof typeof InitializeMovementResponseKindEnum];
|
|
2114
2170
|
/**
|
|
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. >
|
|
2171
|
+
* 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
2172
|
* @export
|
|
2117
2173
|
* @interface IntegerValue
|
|
2118
2174
|
*/
|
|
@@ -2313,9 +2369,19 @@ export type JoggingDetailsKindEnum = typeof JoggingDetailsKindEnum[keyof typeof
|
|
|
2313
2369
|
* @type JoggingDetailsState
|
|
2314
2370
|
* @export
|
|
2315
2371
|
*/
|
|
2316
|
-
export type JoggingDetailsState =
|
|
2372
|
+
export type JoggingDetailsState = {
|
|
2373
|
+
kind: 'PAUSED_BY_USER';
|
|
2374
|
+
} & JoggingPausedByUser | {
|
|
2375
|
+
kind: 'PAUSED_NEAR_COLLISION';
|
|
2376
|
+
} & JoggingPausedNearCollision | {
|
|
2377
|
+
kind: 'PAUSED_NEAR_JOINT_LIMIT';
|
|
2378
|
+
} & JoggingPausedNearJointLimit | {
|
|
2379
|
+
kind: 'PAUSED_ON_IO';
|
|
2380
|
+
} & JoggingPausedOnIO | {
|
|
2381
|
+
kind: 'RUNNING';
|
|
2382
|
+
} & JoggingRunning;
|
|
2317
2383
|
/**
|
|
2318
|
-
*
|
|
2384
|
+
* User has paused jogging.
|
|
2319
2385
|
* @export
|
|
2320
2386
|
* @interface JoggingPausedByUser
|
|
2321
2387
|
*/
|
|
@@ -2332,7 +2398,7 @@ export declare const JoggingPausedByUserKindEnum: {
|
|
|
2332
2398
|
};
|
|
2333
2399
|
export type JoggingPausedByUserKindEnum = typeof JoggingPausedByUserKindEnum[keyof typeof JoggingPausedByUserKindEnum];
|
|
2334
2400
|
/**
|
|
2335
|
-
*
|
|
2401
|
+
* Jogging was paused because the motion group neared a collision.
|
|
2336
2402
|
* @export
|
|
2337
2403
|
* @interface JoggingPausedNearCollision
|
|
2338
2404
|
*/
|
|
@@ -2355,7 +2421,7 @@ export declare const JoggingPausedNearCollisionKindEnum: {
|
|
|
2355
2421
|
};
|
|
2356
2422
|
export type JoggingPausedNearCollisionKindEnum = typeof JoggingPausedNearCollisionKindEnum[keyof typeof JoggingPausedNearCollisionKindEnum];
|
|
2357
2423
|
/**
|
|
2358
|
-
*
|
|
2424
|
+
* Jogging was paused because a joint is near its limit.
|
|
2359
2425
|
* @export
|
|
2360
2426
|
* @interface JoggingPausedNearJointLimit
|
|
2361
2427
|
*/
|
|
@@ -2378,7 +2444,7 @@ export declare const JoggingPausedNearJointLimitKindEnum: {
|
|
|
2378
2444
|
};
|
|
2379
2445
|
export type JoggingPausedNearJointLimitKindEnum = typeof JoggingPausedNearJointLimitKindEnum[keyof typeof JoggingPausedNearJointLimitKindEnum];
|
|
2380
2446
|
/**
|
|
2381
|
-
*
|
|
2447
|
+
* Jogging was paused because of an I/O event.
|
|
2382
2448
|
* @export
|
|
2383
2449
|
* @interface JoggingPausedOnIO
|
|
2384
2450
|
*/
|
|
@@ -2395,7 +2461,7 @@ export declare const JoggingPausedOnIOKindEnum: {
|
|
|
2395
2461
|
};
|
|
2396
2462
|
export type JoggingPausedOnIOKindEnum = typeof JoggingPausedOnIOKindEnum[keyof typeof JoggingPausedOnIOKindEnum];
|
|
2397
2463
|
/**
|
|
2398
|
-
*
|
|
2464
|
+
* Jogging is active.
|
|
2399
2465
|
* @export
|
|
2400
2466
|
* @interface JoggingRunning
|
|
2401
2467
|
*/
|
|
@@ -2749,6 +2815,12 @@ export interface LimitSet {
|
|
|
2749
2815
|
* @memberof LimitSet
|
|
2750
2816
|
*/
|
|
2751
2817
|
'flange'?: CartesianLimits;
|
|
2818
|
+
/**
|
|
2819
|
+
*
|
|
2820
|
+
* @type {JointLimits}
|
|
2821
|
+
* @memberof LimitSet
|
|
2822
|
+
*/
|
|
2823
|
+
'coupled_shoulder_elbow_joint'?: JointLimits;
|
|
2752
2824
|
}
|
|
2753
2825
|
/**
|
|
2754
2826
|
* If a limit is not set, the default value will be used.
|
|
@@ -2820,13 +2892,13 @@ export declare const Manufacturer: {
|
|
|
2820
2892
|
};
|
|
2821
2893
|
export type Manufacturer = typeof Manufacturer[keyof typeof Manufacturer];
|
|
2822
2894
|
/**
|
|
2823
|
-
*
|
|
2895
|
+
*
|
|
2824
2896
|
* @export
|
|
2825
2897
|
* @interface MidpointInsertionAlgorithm
|
|
2826
2898
|
*/
|
|
2827
2899
|
export interface MidpointInsertionAlgorithm {
|
|
2828
2900
|
/**
|
|
2829
|
-
* Algorithm discriminator.
|
|
2901
|
+
* 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
2902
|
* @type {string}
|
|
2831
2903
|
* @memberof MidpointInsertionAlgorithm
|
|
2832
2904
|
*/
|
|
@@ -3905,17 +3977,17 @@ export interface ProfinetDescription {
|
|
|
3905
3977
|
*/
|
|
3906
3978
|
'slots'?: Array<ProfinetSlotDescription>;
|
|
3907
3979
|
/**
|
|
3908
|
-
* Name of the PROFINET device
|
|
3980
|
+
* 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
3981
|
* @type {string}
|
|
3910
3982
|
* @memberof ProfinetDescription
|
|
3911
3983
|
*/
|
|
3912
3984
|
'device_name'?: string;
|
|
3913
3985
|
/**
|
|
3914
|
-
*
|
|
3915
|
-
* @type {
|
|
3986
|
+
*
|
|
3987
|
+
* @type {BusIOProfinetIpConfig}
|
|
3916
3988
|
* @memberof ProfinetDescription
|
|
3917
3989
|
*/
|
|
3918
|
-
'
|
|
3990
|
+
'ip_config'?: BusIOProfinetIpConfig;
|
|
3919
3991
|
}
|
|
3920
3992
|
/**
|
|
3921
3993
|
*
|
|
@@ -3924,7 +3996,7 @@ export interface ProfinetDescription {
|
|
|
3924
3996
|
*/
|
|
3925
3997
|
export interface ProfinetIO {
|
|
3926
3998
|
/**
|
|
3927
|
-
* The name of the input/output
|
|
3999
|
+
* 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
4000
|
* @type {string}
|
|
3929
4001
|
* @memberof ProfinetIO
|
|
3930
4002
|
*/
|
|
@@ -3936,25 +4008,25 @@ export interface ProfinetIO {
|
|
|
3936
4008
|
*/
|
|
3937
4009
|
'type': ProfinetIOTypeEnum;
|
|
3938
4010
|
/**
|
|
3939
|
-
* The direction of the input/output
|
|
4011
|
+
* 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
4012
|
* @type {ProfinetIODirection}
|
|
3941
4013
|
* @memberof ProfinetIO
|
|
3942
4014
|
*/
|
|
3943
4015
|
'direction': ProfinetIODirection;
|
|
3944
4016
|
/**
|
|
3945
|
-
* The byte address of the input/output
|
|
4017
|
+
* 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
4018
|
* @type {number}
|
|
3947
4019
|
* @memberof ProfinetIO
|
|
3948
4020
|
*/
|
|
3949
4021
|
'byte_address': number;
|
|
3950
4022
|
/**
|
|
3951
|
-
* The bit address of the input/output
|
|
4023
|
+
* 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
4024
|
* @type {number}
|
|
3953
4025
|
* @memberof ProfinetIO
|
|
3954
4026
|
*/
|
|
3955
4027
|
'bit_address'?: number;
|
|
3956
4028
|
/**
|
|
3957
|
-
* The unique identifier for the input/output value. This identifier is used to reference the specific input/output in the NOVA
|
|
4029
|
+
* 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
4030
|
* @type {string}
|
|
3959
4031
|
* @memberof ProfinetIO
|
|
3960
4032
|
*/
|
|
@@ -3967,7 +4039,7 @@ export interface ProfinetIO {
|
|
|
3967
4039
|
*/
|
|
3968
4040
|
export interface ProfinetIOData {
|
|
3969
4041
|
/**
|
|
3970
|
-
* The name of the input/output
|
|
4042
|
+
* 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
4043
|
* @type {string}
|
|
3972
4044
|
* @memberof ProfinetIOData
|
|
3973
4045
|
*/
|
|
@@ -3979,26 +4051,26 @@ export interface ProfinetIOData {
|
|
|
3979
4051
|
*/
|
|
3980
4052
|
'type': ProfinetIOTypeEnum;
|
|
3981
4053
|
/**
|
|
3982
|
-
* The direction of the input/output
|
|
4054
|
+
* 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
4055
|
* @type {ProfinetIODirection}
|
|
3984
4056
|
* @memberof ProfinetIOData
|
|
3985
4057
|
*/
|
|
3986
4058
|
'direction': ProfinetIODirection;
|
|
3987
4059
|
/**
|
|
3988
|
-
* The byte address of the input/output
|
|
4060
|
+
* 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
4061
|
* @type {number}
|
|
3990
4062
|
* @memberof ProfinetIOData
|
|
3991
4063
|
*/
|
|
3992
4064
|
'byte_address': number;
|
|
3993
4065
|
/**
|
|
3994
|
-
* The bit address of the input/output
|
|
4066
|
+
* 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
4067
|
* @type {number}
|
|
3996
4068
|
* @memberof ProfinetIOData
|
|
3997
4069
|
*/
|
|
3998
4070
|
'bit_address'?: number;
|
|
3999
4071
|
}
|
|
4000
4072
|
/**
|
|
4001
|
-
*
|
|
4073
|
+
* 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
4074
|
* @export
|
|
4003
4075
|
* @enum {string}
|
|
4004
4076
|
*/
|
|
@@ -4009,7 +4081,7 @@ export declare const ProfinetIODirection: {
|
|
|
4009
4081
|
};
|
|
4010
4082
|
export type ProfinetIODirection = typeof ProfinetIODirection[keyof typeof ProfinetIODirection];
|
|
4011
4083
|
/**
|
|
4012
|
-
* Value type of the PROFINET input/output.
|
|
4084
|
+
* Value type of the PROFINET input/output variable. Is used to interpret the corresponding bits correctly.
|
|
4013
4085
|
* @export
|
|
4014
4086
|
* @enum {string}
|
|
4015
4087
|
*/
|
|
@@ -4033,38 +4105,38 @@ export type ProfinetIOTypeEnum = typeof ProfinetIOTypeEnum[keyof typeof Profinet
|
|
|
4033
4105
|
*/
|
|
4034
4106
|
export interface ProfinetInputOutputConfig {
|
|
4035
4107
|
/**
|
|
4036
|
-
* Content of the input
|
|
4108
|
+
* 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
4109
|
* @type {string}
|
|
4038
4110
|
* @memberof ProfinetInputOutputConfig
|
|
4039
4111
|
*/
|
|
4040
4112
|
'config': string;
|
|
4041
4113
|
/**
|
|
4042
|
-
* Offset in bytes for the input
|
|
4114
|
+
* 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
4115
|
* @type {number}
|
|
4044
4116
|
* @memberof ProfinetInputOutputConfig
|
|
4045
4117
|
*/
|
|
4046
4118
|
'input_offset': number;
|
|
4047
4119
|
/**
|
|
4048
|
-
* Offset in bytes for the output
|
|
4120
|
+
* 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
4121
|
* @type {number}
|
|
4050
4122
|
* @memberof ProfinetInputOutputConfig
|
|
4051
4123
|
*/
|
|
4052
4124
|
'output_offset': number;
|
|
4053
4125
|
}
|
|
4054
4126
|
/**
|
|
4055
|
-
*
|
|
4127
|
+
* 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
4128
|
* @export
|
|
4057
4129
|
* @interface ProfinetSlotDescription
|
|
4058
4130
|
*/
|
|
4059
4131
|
export interface ProfinetSlotDescription {
|
|
4060
4132
|
/**
|
|
4061
|
-
* The number of the PROFINET slot.
|
|
4133
|
+
* 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
4134
|
* @type {number}
|
|
4063
4135
|
* @memberof ProfinetSlotDescription
|
|
4064
4136
|
*/
|
|
4065
4137
|
'number': number;
|
|
4066
4138
|
/**
|
|
4067
|
-
* The API number of the PROFINET input
|
|
4139
|
+
* The application process identifier (API) number of the PROFINET input. The API identifies the application relation (AR) that is using the slot.
|
|
4068
4140
|
* @type {number}
|
|
4069
4141
|
* @memberof ProfinetSlotDescription
|
|
4070
4142
|
*/
|
|
@@ -4083,32 +4155,174 @@ export interface ProfinetSlotDescription {
|
|
|
4083
4155
|
*/
|
|
4084
4156
|
export interface ProfinetSubSlotDescription {
|
|
4085
4157
|
/**
|
|
4086
|
-
* The
|
|
4158
|
+
* The number/index of the PROFINET subslot.
|
|
4087
4159
|
* @type {number}
|
|
4088
4160
|
* @memberof ProfinetSubSlotDescription
|
|
4089
4161
|
*/
|
|
4090
4162
|
'number': number;
|
|
4091
4163
|
/**
|
|
4092
|
-
* The
|
|
4164
|
+
* The amount of bytes allocated for the subslot in the input process image buffer.
|
|
4093
4165
|
* @type {number}
|
|
4094
4166
|
* @memberof ProfinetSubSlotDescription
|
|
4095
4167
|
*/
|
|
4096
4168
|
'input_length': number;
|
|
4097
4169
|
/**
|
|
4098
|
-
* The
|
|
4170
|
+
* The amount of bytes allocated for the subslot in the output process image buffer.
|
|
4099
4171
|
* @type {number}
|
|
4100
4172
|
* @memberof ProfinetSubSlotDescription
|
|
4101
4173
|
*/
|
|
4102
4174
|
'output_length': number;
|
|
4103
4175
|
}
|
|
4104
4176
|
/**
|
|
4105
|
-
*
|
|
4177
|
+
* A program is a collection of instructions that are executed in the robot cell.
|
|
4178
|
+
* @export
|
|
4179
|
+
* @interface Program
|
|
4180
|
+
*/
|
|
4181
|
+
export interface Program {
|
|
4182
|
+
/**
|
|
4183
|
+
*
|
|
4184
|
+
* @type {string}
|
|
4185
|
+
* @memberof Program
|
|
4186
|
+
*/
|
|
4187
|
+
'program': string;
|
|
4188
|
+
/**
|
|
4189
|
+
*
|
|
4190
|
+
* @type {string}
|
|
4191
|
+
* @memberof Program
|
|
4192
|
+
*/
|
|
4193
|
+
'name'?: string;
|
|
4194
|
+
/**
|
|
4195
|
+
*
|
|
4196
|
+
* @type {string}
|
|
4197
|
+
* @memberof Program
|
|
4198
|
+
*/
|
|
4199
|
+
'description'?: string;
|
|
4200
|
+
/**
|
|
4201
|
+
*
|
|
4202
|
+
* @type {string}
|
|
4203
|
+
* @memberof Program
|
|
4204
|
+
*/
|
|
4205
|
+
'app': string;
|
|
4206
|
+
/**
|
|
4207
|
+
*
|
|
4208
|
+
* @type {object}
|
|
4209
|
+
* @memberof Program
|
|
4210
|
+
*/
|
|
4211
|
+
'input_schema'?: object;
|
|
4212
|
+
/**
|
|
4213
|
+
*
|
|
4214
|
+
* @type {object}
|
|
4215
|
+
* @memberof Program
|
|
4216
|
+
*/
|
|
4217
|
+
'preconditions'?: object;
|
|
4218
|
+
}
|
|
4219
|
+
/**
|
|
4220
|
+
* Holds the state of a program run.
|
|
4221
|
+
* @export
|
|
4222
|
+
* @interface ProgramRun
|
|
4223
|
+
*/
|
|
4224
|
+
export interface ProgramRun {
|
|
4225
|
+
/**
|
|
4226
|
+
* Unique identifier of the program run
|
|
4227
|
+
* @type {string}
|
|
4228
|
+
* @memberof ProgramRun
|
|
4229
|
+
*/
|
|
4230
|
+
'run': string;
|
|
4231
|
+
/**
|
|
4232
|
+
* Unique identifier of the program
|
|
4233
|
+
* @type {string}
|
|
4234
|
+
* @memberof ProgramRun
|
|
4235
|
+
*/
|
|
4236
|
+
'program': string;
|
|
4237
|
+
/**
|
|
4238
|
+
* State of the program run
|
|
4239
|
+
* @type {ProgramRunState}
|
|
4240
|
+
* @memberof ProgramRun
|
|
4241
|
+
*/
|
|
4242
|
+
'state': ProgramRunState;
|
|
4243
|
+
/**
|
|
4244
|
+
* Logs of the program run
|
|
4245
|
+
* @type {string}
|
|
4246
|
+
* @memberof ProgramRun
|
|
4247
|
+
*/
|
|
4248
|
+
'logs'?: string;
|
|
4249
|
+
/**
|
|
4250
|
+
* Stdout of the program run
|
|
4251
|
+
* @type {string}
|
|
4252
|
+
* @memberof ProgramRun
|
|
4253
|
+
*/
|
|
4254
|
+
'stdout'?: string;
|
|
4255
|
+
/**
|
|
4256
|
+
* Stderr of the program run
|
|
4257
|
+
* @type {string}
|
|
4258
|
+
* @memberof ProgramRun
|
|
4259
|
+
*/
|
|
4260
|
+
'stderr'?: string;
|
|
4261
|
+
/**
|
|
4262
|
+
* Error message of the program run, if any
|
|
4263
|
+
* @type {string}
|
|
4264
|
+
* @memberof ProgramRun
|
|
4265
|
+
*/
|
|
4266
|
+
'error'?: string;
|
|
4267
|
+
/**
|
|
4268
|
+
* Traceback of the program run, if any
|
|
4269
|
+
* @type {string}
|
|
4270
|
+
* @memberof ProgramRun
|
|
4271
|
+
*/
|
|
4272
|
+
'traceback'?: string;
|
|
4273
|
+
/**
|
|
4274
|
+
* Start time of the program run
|
|
4275
|
+
* @type {string}
|
|
4276
|
+
* @memberof ProgramRun
|
|
4277
|
+
*/
|
|
4278
|
+
'start_time'?: string;
|
|
4279
|
+
/**
|
|
4280
|
+
* End time of the program run
|
|
4281
|
+
* @type {string}
|
|
4282
|
+
* @memberof ProgramRun
|
|
4283
|
+
*/
|
|
4284
|
+
'end_time'?: string;
|
|
4285
|
+
/**
|
|
4286
|
+
* Input data of the program run
|
|
4287
|
+
* @type {object}
|
|
4288
|
+
* @memberof ProgramRun
|
|
4289
|
+
*/
|
|
4290
|
+
'input_data'?: object;
|
|
4291
|
+
}
|
|
4292
|
+
/**
|
|
4293
|
+
* The state of a program run.
|
|
4294
|
+
* @export
|
|
4295
|
+
* @enum {string}
|
|
4296
|
+
*/
|
|
4297
|
+
export declare const ProgramRunState: {
|
|
4298
|
+
readonly Preparing: "PREPARING";
|
|
4299
|
+
readonly Running: "RUNNING";
|
|
4300
|
+
readonly Completed: "COMPLETED";
|
|
4301
|
+
readonly Failed: "FAILED";
|
|
4302
|
+
readonly Stopped: "STOPPED";
|
|
4303
|
+
};
|
|
4304
|
+
export type ProgramRunState = typeof ProgramRunState[keyof typeof ProgramRunState];
|
|
4305
|
+
/**
|
|
4306
|
+
* The state of a program run.
|
|
4307
|
+
* @export
|
|
4308
|
+
* @interface ProgramStartRequest
|
|
4309
|
+
*/
|
|
4310
|
+
export interface ProgramStartRequest {
|
|
4311
|
+
/**
|
|
4312
|
+
* The arguments to pass to the program.
|
|
4313
|
+
* @type {object}
|
|
4314
|
+
* @memberof ProgramStartRequest
|
|
4315
|
+
*/
|
|
4316
|
+
'arguments': object;
|
|
4317
|
+
}
|
|
4318
|
+
/**
|
|
4319
|
+
*
|
|
4106
4320
|
* @export
|
|
4107
4321
|
* @interface RRTConnectAlgorithm
|
|
4108
4322
|
*/
|
|
4109
4323
|
export interface RRTConnectAlgorithm {
|
|
4110
4324
|
/**
|
|
4111
|
-
* Algorithm discriminator.
|
|
4325
|
+
* 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
4326
|
* @type {string}
|
|
4113
4327
|
* @memberof RRTConnectAlgorithm
|
|
4114
4328
|
*/
|
|
@@ -4119,6 +4333,30 @@ export interface RRTConnectAlgorithm {
|
|
|
4119
4333
|
* @memberof RRTConnectAlgorithm
|
|
4120
4334
|
*/
|
|
4121
4335
|
'max_iterations'?: number;
|
|
4336
|
+
/**
|
|
4337
|
+
* Maximum step size for tree extension in joint space.
|
|
4338
|
+
* @type {number}
|
|
4339
|
+
* @memberof RRTConnectAlgorithm
|
|
4340
|
+
*/
|
|
4341
|
+
'max_step_size'?: number;
|
|
4342
|
+
/**
|
|
4343
|
+
* Adjust the maximum step size during the search based on the recent success rate of tree expansion.
|
|
4344
|
+
* @type {boolean}
|
|
4345
|
+
* @memberof RRTConnectAlgorithm
|
|
4346
|
+
*/
|
|
4347
|
+
'adaptive_step_size'?: boolean;
|
|
4348
|
+
/**
|
|
4349
|
+
* Apply smoothing after the search has succeeded. This will remove as many intermediate points as possible while keeping the path valid.
|
|
4350
|
+
* @type {boolean}
|
|
4351
|
+
* @memberof RRTConnectAlgorithm
|
|
4352
|
+
*/
|
|
4353
|
+
'apply_smoothing'?: boolean;
|
|
4354
|
+
/**
|
|
4355
|
+
* Apply blending after the search has succeeded and smoothing has been applied. This will apply the largest viable blending at each intermediate point.
|
|
4356
|
+
* @type {boolean}
|
|
4357
|
+
* @memberof RRTConnectAlgorithm
|
|
4358
|
+
*/
|
|
4359
|
+
'apply_blending'?: boolean;
|
|
4122
4360
|
}
|
|
4123
4361
|
export declare const RRTConnectAlgorithmAlgorithmNameEnum: {
|
|
4124
4362
|
readonly RrtConnectAlgorithm: "RRTConnectAlgorithm";
|
|
@@ -4850,9 +5088,19 @@ export type TrajectoryDetailsKindEnum = typeof TrajectoryDetailsKindEnum[keyof t
|
|
|
4850
5088
|
* @type TrajectoryDetailsState
|
|
4851
5089
|
* @export
|
|
4852
5090
|
*/
|
|
4853
|
-
export type TrajectoryDetailsState =
|
|
5091
|
+
export type TrajectoryDetailsState = {
|
|
5092
|
+
kind: 'END_OF_TRAJECTORY';
|
|
5093
|
+
} & TrajectoryEnded | {
|
|
5094
|
+
kind: 'PAUSED_BY_USER';
|
|
5095
|
+
} & TrajectoryPausedByUser | {
|
|
5096
|
+
kind: 'PAUSED_ON_IO';
|
|
5097
|
+
} & TrajectoryPausedOnIO | {
|
|
5098
|
+
kind: 'RUNNING';
|
|
5099
|
+
} & TrajectoryRunning | {
|
|
5100
|
+
kind: 'WAIT_FOR_IO';
|
|
5101
|
+
} & TrajectoryWaitForIO;
|
|
4854
5102
|
/**
|
|
4855
|
-
*
|
|
5103
|
+
* First or last sample (depending on direction) of trajectory has been sent.
|
|
4856
5104
|
* @export
|
|
4857
5105
|
* @interface TrajectoryEnded
|
|
4858
5106
|
*/
|
|
@@ -4892,7 +5140,7 @@ export declare const TrajectoryIdMessageTypeEnum: {
|
|
|
4892
5140
|
};
|
|
4893
5141
|
export type TrajectoryIdMessageTypeEnum = typeof TrajectoryIdMessageTypeEnum[keyof typeof TrajectoryIdMessageTypeEnum];
|
|
4894
5142
|
/**
|
|
4895
|
-
*
|
|
5143
|
+
* User has paused execution.
|
|
4896
5144
|
* @export
|
|
4897
5145
|
* @interface TrajectoryPausedByUser
|
|
4898
5146
|
*/
|
|
@@ -4909,7 +5157,7 @@ export declare const TrajectoryPausedByUserKindEnum: {
|
|
|
4909
5157
|
};
|
|
4910
5158
|
export type TrajectoryPausedByUserKindEnum = typeof TrajectoryPausedByUserKindEnum[keyof typeof TrajectoryPausedByUserKindEnum];
|
|
4911
5159
|
/**
|
|
4912
|
-
*
|
|
5160
|
+
* Execution was paused because of an I/O event.
|
|
4913
5161
|
* @export
|
|
4914
5162
|
* @interface TrajectoryPausedOnIO
|
|
4915
5163
|
*/
|
|
@@ -4926,7 +5174,7 @@ export declare const TrajectoryPausedOnIOKindEnum: {
|
|
|
4926
5174
|
};
|
|
4927
5175
|
export type TrajectoryPausedOnIOKindEnum = typeof TrajectoryPausedOnIOKindEnum[keyof typeof TrajectoryPausedOnIOKindEnum];
|
|
4928
5176
|
/**
|
|
4929
|
-
*
|
|
5177
|
+
* Trajectory is being executed.
|
|
4930
5178
|
* @export
|
|
4931
5179
|
* @interface TrajectoryRunning
|
|
4932
5180
|
*/
|
|
@@ -4949,7 +5197,7 @@ export declare const TrajectoryRunningKindEnum: {
|
|
|
4949
5197
|
};
|
|
4950
5198
|
export type TrajectoryRunningKindEnum = typeof TrajectoryRunningKindEnum[keyof typeof TrajectoryRunningKindEnum];
|
|
4951
5199
|
/**
|
|
4952
|
-
*
|
|
5200
|
+
* Waiting for an I/O event to start execution.
|
|
4953
5201
|
* @export
|
|
4954
5202
|
* @interface TrajectoryWaitForIO
|
|
4955
5203
|
*/
|
|
@@ -5052,6 +5300,31 @@ export interface ValidationError {
|
|
|
5052
5300
|
[key: string]: any;
|
|
5053
5301
|
};
|
|
5054
5302
|
}
|
|
5303
|
+
/**
|
|
5304
|
+
* A validation error of a program.
|
|
5305
|
+
* @export
|
|
5306
|
+
* @interface ValidationError2
|
|
5307
|
+
*/
|
|
5308
|
+
export interface ValidationError2 {
|
|
5309
|
+
/**
|
|
5310
|
+
*
|
|
5311
|
+
* @type {Array<number>}
|
|
5312
|
+
* @memberof ValidationError2
|
|
5313
|
+
*/
|
|
5314
|
+
'loc': Array<number>;
|
|
5315
|
+
/**
|
|
5316
|
+
*
|
|
5317
|
+
* @type {string}
|
|
5318
|
+
* @memberof ValidationError2
|
|
5319
|
+
*/
|
|
5320
|
+
'msg': string;
|
|
5321
|
+
/**
|
|
5322
|
+
*
|
|
5323
|
+
* @type {string}
|
|
5324
|
+
* @memberof ValidationError2
|
|
5325
|
+
*/
|
|
5326
|
+
'type': string;
|
|
5327
|
+
}
|
|
5055
5328
|
/**
|
|
5056
5329
|
* @type ValidationErrorLocInner
|
|
5057
5330
|
* @export
|
|
@@ -5542,7 +5815,7 @@ export declare class ApplicationApi extends BaseAPI {
|
|
|
5542
5815
|
*/
|
|
5543
5816
|
export declare const BUSInputsOutputsApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
5544
5817
|
/**
|
|
5545
|
-
* Add
|
|
5818
|
+
* Add the BUS inputs/outputs service to the cell. Starts a containerized service that enables BUS connections via the specified ethernet port.
|
|
5546
5819
|
* @summary Add Service
|
|
5547
5820
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5548
5821
|
* @param {BusIOType} busIOType
|
|
@@ -5552,7 +5825,7 @@ export declare const BUSInputsOutputsApiAxiosParamCreator: (configuration?: Conf
|
|
|
5552
5825
|
*/
|
|
5553
5826
|
addBusIOService: (cell: string, busIOType: BusIOType, completionTimeout?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
5554
5827
|
/**
|
|
5555
|
-
* Adds an input/output to or updates an input/output on the PROFINET device.
|
|
5828
|
+
* 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
5829
|
* @summary Add PROFINET Input/Output
|
|
5557
5830
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5558
5831
|
* @param {string} io Unique identifier to address an Input/Output in the cell.
|
|
@@ -5562,7 +5835,7 @@ export declare const BUSInputsOutputsApiAxiosParamCreator: (configuration?: Conf
|
|
|
5562
5835
|
*/
|
|
5563
5836
|
addProfinetIO: (cell: string, io: string, profinetIOData: ProfinetIOData, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
5564
5837
|
/**
|
|
5565
|
-
*
|
|
5838
|
+
* Remove the BUS inputs/outputs service from the cell.
|
|
5566
5839
|
* @summary Clear Service
|
|
5567
5840
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5568
5841
|
* @param {number} [completionTimeout]
|
|
@@ -5571,7 +5844,7 @@ export declare const BUSInputsOutputsApiAxiosParamCreator: (configuration?: Conf
|
|
|
5571
5844
|
*/
|
|
5572
5845
|
clearBusIOService: (cell: string, completionTimeout?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
5573
5846
|
/**
|
|
5574
|
-
* Removes
|
|
5847
|
+
* Removes an input/output variable configuration from the PROFINET device, e.g. NOVA\'s PROFINET service.
|
|
5575
5848
|
* @summary Remove PROFINET Input/Ouptut
|
|
5576
5849
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5577
5850
|
* @param {string} io Unique identifier to address an Input/Output in the cell.
|
|
@@ -5580,7 +5853,7 @@ export declare const BUSInputsOutputsApiAxiosParamCreator: (configuration?: Conf
|
|
|
5580
5853
|
*/
|
|
5581
5854
|
deleteProfinetIO: (cell: string, io: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
5582
5855
|
/**
|
|
5583
|
-
* Get deployed BUS
|
|
5856
|
+
* Get deployed BUS inputs/outputs service.
|
|
5584
5857
|
* @summary Get Service
|
|
5585
5858
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5586
5859
|
* @param {*} [options] Override http request option.
|
|
@@ -5605,7 +5878,7 @@ export declare const BUSInputsOutputsApiAxiosParamCreator: (configuration?: Conf
|
|
|
5605
5878
|
*/
|
|
5606
5879
|
getBusIOValues: (cell: string, ios?: Array<string>, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
5607
5880
|
/**
|
|
5608
|
-
* Get description of PROFINET
|
|
5881
|
+
* Get description of NOVA as a PROFINET device.
|
|
5609
5882
|
* @summary Get PROFINET Description
|
|
5610
5883
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5611
5884
|
* @param {*} [options] Override http request option.
|
|
@@ -5613,7 +5886,7 @@ export declare const BUSInputsOutputsApiAxiosParamCreator: (configuration?: Conf
|
|
|
5613
5886
|
*/
|
|
5614
5887
|
getProfinetDescription: (cell: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
5615
5888
|
/**
|
|
5616
|
-
* Get input/output configuration of the PROFINET device as file.
|
|
5889
|
+
* 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
5890
|
* @summary PROFINET Inputs/Outputs to File
|
|
5618
5891
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5619
5892
|
* @param {number} [inputOffset]
|
|
@@ -5623,7 +5896,7 @@ export declare const BUSInputsOutputsApiAxiosParamCreator: (configuration?: Conf
|
|
|
5623
5896
|
*/
|
|
5624
5897
|
getProfinetIOsFromFile: (cell: string, inputOffset?: number, outputOffset?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
5625
5898
|
/**
|
|
5626
|
-
* List all BUS
|
|
5899
|
+
* 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.
|
|
5627
5900
|
* @summary List Descriptions
|
|
5628
5901
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5629
5902
|
* @param {*} [options] Override http request option.
|
|
@@ -5631,7 +5904,7 @@ export declare const BUSInputsOutputsApiAxiosParamCreator: (configuration?: Conf
|
|
|
5631
5904
|
*/
|
|
5632
5905
|
listBusIODescriptions: (cell: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
5633
5906
|
/**
|
|
5634
|
-
* List all PROFINET input and
|
|
5907
|
+
* 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.
|
|
5635
5908
|
* @summary List PROFINET Input/Output Configuration
|
|
5636
5909
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5637
5910
|
* @param {*} [options] Override http request option.
|
|
@@ -5648,7 +5921,7 @@ export declare const BUSInputsOutputsApiAxiosParamCreator: (configuration?: Conf
|
|
|
5648
5921
|
*/
|
|
5649
5922
|
setBusIOValues: (cell: string, iOValue: Array<IOValue>, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
5650
5923
|
/**
|
|
5651
|
-
* Sets inputs/outputs
|
|
5924
|
+
* 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.
|
|
5652
5925
|
* @summary Set PROFINET Inputs/Outputs from File
|
|
5653
5926
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5654
5927
|
* @param {ProfinetInputOutputConfig} profinetInputOutputConfig
|
|
@@ -5663,7 +5936,7 @@ export declare const BUSInputsOutputsApiAxiosParamCreator: (configuration?: Conf
|
|
|
5663
5936
|
*/
|
|
5664
5937
|
export declare const BUSInputsOutputsApiFp: (configuration?: Configuration) => {
|
|
5665
5938
|
/**
|
|
5666
|
-
* Add
|
|
5939
|
+
* Add the BUS inputs/outputs service to the cell. Starts a containerized service that enables BUS connections via the specified ethernet port.
|
|
5667
5940
|
* @summary Add Service
|
|
5668
5941
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5669
5942
|
* @param {BusIOType} busIOType
|
|
@@ -5673,7 +5946,7 @@ export declare const BUSInputsOutputsApiFp: (configuration?: Configuration) => {
|
|
|
5673
5946
|
*/
|
|
5674
5947
|
addBusIOService(cell: string, busIOType: BusIOType, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
5675
5948
|
/**
|
|
5676
|
-
* Adds an input/output to or updates an input/output on the PROFINET device.
|
|
5949
|
+
* 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
5950
|
* @summary Add PROFINET Input/Output
|
|
5678
5951
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5679
5952
|
* @param {string} io Unique identifier to address an Input/Output in the cell.
|
|
@@ -5683,7 +5956,7 @@ export declare const BUSInputsOutputsApiFp: (configuration?: Configuration) => {
|
|
|
5683
5956
|
*/
|
|
5684
5957
|
addProfinetIO(cell: string, io: string, profinetIOData: ProfinetIOData, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
5685
5958
|
/**
|
|
5686
|
-
*
|
|
5959
|
+
* Remove the BUS inputs/outputs service from the cell.
|
|
5687
5960
|
* @summary Clear Service
|
|
5688
5961
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5689
5962
|
* @param {number} [completionTimeout]
|
|
@@ -5692,7 +5965,7 @@ export declare const BUSInputsOutputsApiFp: (configuration?: Configuration) => {
|
|
|
5692
5965
|
*/
|
|
5693
5966
|
clearBusIOService(cell: string, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
5694
5967
|
/**
|
|
5695
|
-
* Removes
|
|
5968
|
+
* Removes an input/output variable configuration from the PROFINET device, e.g. NOVA\'s PROFINET service.
|
|
5696
5969
|
* @summary Remove PROFINET Input/Ouptut
|
|
5697
5970
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5698
5971
|
* @param {string} io Unique identifier to address an Input/Output in the cell.
|
|
@@ -5701,7 +5974,7 @@ export declare const BUSInputsOutputsApiFp: (configuration?: Configuration) => {
|
|
|
5701
5974
|
*/
|
|
5702
5975
|
deleteProfinetIO(cell: string, io: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
5703
5976
|
/**
|
|
5704
|
-
* Get deployed BUS
|
|
5977
|
+
* Get deployed BUS inputs/outputs service.
|
|
5705
5978
|
* @summary Get Service
|
|
5706
5979
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5707
5980
|
* @param {*} [options] Override http request option.
|
|
@@ -5726,7 +5999,7 @@ export declare const BUSInputsOutputsApiFp: (configuration?: Configuration) => {
|
|
|
5726
5999
|
*/
|
|
5727
6000
|
getBusIOValues(cell: string, ios?: Array<string>, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<IOValue>>>;
|
|
5728
6001
|
/**
|
|
5729
|
-
* Get description of PROFINET
|
|
6002
|
+
* Get description of NOVA as a PROFINET device.
|
|
5730
6003
|
* @summary Get PROFINET Description
|
|
5731
6004
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5732
6005
|
* @param {*} [options] Override http request option.
|
|
@@ -5734,7 +6007,7 @@ export declare const BUSInputsOutputsApiFp: (configuration?: Configuration) => {
|
|
|
5734
6007
|
*/
|
|
5735
6008
|
getProfinetDescription(cell: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ProfinetDescription>>;
|
|
5736
6009
|
/**
|
|
5737
|
-
* Get input/output configuration of the PROFINET device as file.
|
|
6010
|
+
* 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
6011
|
* @summary PROFINET Inputs/Outputs to File
|
|
5739
6012
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5740
6013
|
* @param {number} [inputOffset]
|
|
@@ -5744,15 +6017,15 @@ export declare const BUSInputsOutputsApiFp: (configuration?: Configuration) => {
|
|
|
5744
6017
|
*/
|
|
5745
6018
|
getProfinetIOsFromFile(cell: string, inputOffset?: number, outputOffset?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<string>>;
|
|
5746
6019
|
/**
|
|
5747
|
-
* List all BUS
|
|
6020
|
+
* 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.
|
|
5748
6021
|
* @summary List Descriptions
|
|
5749
6022
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5750
6023
|
* @param {*} [options] Override http request option.
|
|
5751
6024
|
* @throws {RequiredError}
|
|
5752
6025
|
*/
|
|
5753
|
-
listBusIODescriptions(cell: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<
|
|
6026
|
+
listBusIODescriptions(cell: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<IODescription2>>>;
|
|
5754
6027
|
/**
|
|
5755
|
-
* List all PROFINET input and
|
|
6028
|
+
* 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.
|
|
5756
6029
|
* @summary List PROFINET Input/Output Configuration
|
|
5757
6030
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5758
6031
|
* @param {*} [options] Override http request option.
|
|
@@ -5769,7 +6042,7 @@ export declare const BUSInputsOutputsApiFp: (configuration?: Configuration) => {
|
|
|
5769
6042
|
*/
|
|
5770
6043
|
setBusIOValues(cell: string, iOValue: Array<IOValue>, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
5771
6044
|
/**
|
|
5772
|
-
* Sets inputs/outputs
|
|
6045
|
+
* 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.
|
|
5773
6046
|
* @summary Set PROFINET Inputs/Outputs from File
|
|
5774
6047
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5775
6048
|
* @param {ProfinetInputOutputConfig} profinetInputOutputConfig
|
|
@@ -5784,7 +6057,7 @@ export declare const BUSInputsOutputsApiFp: (configuration?: Configuration) => {
|
|
|
5784
6057
|
*/
|
|
5785
6058
|
export declare const BUSInputsOutputsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
5786
6059
|
/**
|
|
5787
|
-
* Add
|
|
6060
|
+
* Add the BUS inputs/outputs service to the cell. Starts a containerized service that enables BUS connections via the specified ethernet port.
|
|
5788
6061
|
* @summary Add Service
|
|
5789
6062
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5790
6063
|
* @param {BusIOType} busIOType
|
|
@@ -5794,7 +6067,7 @@ export declare const BUSInputsOutputsApiFactory: (configuration?: Configuration,
|
|
|
5794
6067
|
*/
|
|
5795
6068
|
addBusIOService(cell: string, busIOType: BusIOType, completionTimeout?: number, options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
5796
6069
|
/**
|
|
5797
|
-
* Adds an input/output to or updates an input/output on the PROFINET device.
|
|
6070
|
+
* 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
6071
|
* @summary Add PROFINET Input/Output
|
|
5799
6072
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5800
6073
|
* @param {string} io Unique identifier to address an Input/Output in the cell.
|
|
@@ -5804,7 +6077,7 @@ export declare const BUSInputsOutputsApiFactory: (configuration?: Configuration,
|
|
|
5804
6077
|
*/
|
|
5805
6078
|
addProfinetIO(cell: string, io: string, profinetIOData: ProfinetIOData, options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
5806
6079
|
/**
|
|
5807
|
-
*
|
|
6080
|
+
* Remove the BUS inputs/outputs service from the cell.
|
|
5808
6081
|
* @summary Clear Service
|
|
5809
6082
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5810
6083
|
* @param {number} [completionTimeout]
|
|
@@ -5813,7 +6086,7 @@ export declare const BUSInputsOutputsApiFactory: (configuration?: Configuration,
|
|
|
5813
6086
|
*/
|
|
5814
6087
|
clearBusIOService(cell: string, completionTimeout?: number, options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
5815
6088
|
/**
|
|
5816
|
-
* Removes
|
|
6089
|
+
* Removes an input/output variable configuration from the PROFINET device, e.g. NOVA\'s PROFINET service.
|
|
5817
6090
|
* @summary Remove PROFINET Input/Ouptut
|
|
5818
6091
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5819
6092
|
* @param {string} io Unique identifier to address an Input/Output in the cell.
|
|
@@ -5822,7 +6095,7 @@ export declare const BUSInputsOutputsApiFactory: (configuration?: Configuration,
|
|
|
5822
6095
|
*/
|
|
5823
6096
|
deleteProfinetIO(cell: string, io: string, options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
5824
6097
|
/**
|
|
5825
|
-
* Get deployed BUS
|
|
6098
|
+
* Get deployed BUS inputs/outputs service.
|
|
5826
6099
|
* @summary Get Service
|
|
5827
6100
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5828
6101
|
* @param {*} [options] Override http request option.
|
|
@@ -5847,7 +6120,7 @@ export declare const BUSInputsOutputsApiFactory: (configuration?: Configuration,
|
|
|
5847
6120
|
*/
|
|
5848
6121
|
getBusIOValues(cell: string, ios?: Array<string>, options?: RawAxiosRequestConfig): AxiosPromise<Array<IOValue>>;
|
|
5849
6122
|
/**
|
|
5850
|
-
* Get description of PROFINET
|
|
6123
|
+
* Get description of NOVA as a PROFINET device.
|
|
5851
6124
|
* @summary Get PROFINET Description
|
|
5852
6125
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5853
6126
|
* @param {*} [options] Override http request option.
|
|
@@ -5855,7 +6128,7 @@ export declare const BUSInputsOutputsApiFactory: (configuration?: Configuration,
|
|
|
5855
6128
|
*/
|
|
5856
6129
|
getProfinetDescription(cell: string, options?: RawAxiosRequestConfig): AxiosPromise<ProfinetDescription>;
|
|
5857
6130
|
/**
|
|
5858
|
-
* Get input/output configuration of the PROFINET device as file.
|
|
6131
|
+
* 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
6132
|
* @summary PROFINET Inputs/Outputs to File
|
|
5860
6133
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5861
6134
|
* @param {number} [inputOffset]
|
|
@@ -5865,15 +6138,15 @@ export declare const BUSInputsOutputsApiFactory: (configuration?: Configuration,
|
|
|
5865
6138
|
*/
|
|
5866
6139
|
getProfinetIOsFromFile(cell: string, inputOffset?: number, outputOffset?: number, options?: RawAxiosRequestConfig): AxiosPromise<string>;
|
|
5867
6140
|
/**
|
|
5868
|
-
* List all BUS
|
|
6141
|
+
* 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.
|
|
5869
6142
|
* @summary List Descriptions
|
|
5870
6143
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5871
6144
|
* @param {*} [options] Override http request option.
|
|
5872
6145
|
* @throws {RequiredError}
|
|
5873
6146
|
*/
|
|
5874
|
-
listBusIODescriptions(cell: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<
|
|
6147
|
+
listBusIODescriptions(cell: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<IODescription2>>;
|
|
5875
6148
|
/**
|
|
5876
|
-
* List all PROFINET input and
|
|
6149
|
+
* 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.
|
|
5877
6150
|
* @summary List PROFINET Input/Output Configuration
|
|
5878
6151
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5879
6152
|
* @param {*} [options] Override http request option.
|
|
@@ -5890,7 +6163,7 @@ export declare const BUSInputsOutputsApiFactory: (configuration?: Configuration,
|
|
|
5890
6163
|
*/
|
|
5891
6164
|
setBusIOValues(cell: string, iOValue: Array<IOValue>, options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
5892
6165
|
/**
|
|
5893
|
-
* Sets inputs/outputs
|
|
6166
|
+
* 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.
|
|
5894
6167
|
* @summary Set PROFINET Inputs/Outputs from File
|
|
5895
6168
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5896
6169
|
* @param {ProfinetInputOutputConfig} profinetInputOutputConfig
|
|
@@ -5907,7 +6180,7 @@ export declare const BUSInputsOutputsApiFactory: (configuration?: Configuration,
|
|
|
5907
6180
|
*/
|
|
5908
6181
|
export declare class BUSInputsOutputsApi extends BaseAPI {
|
|
5909
6182
|
/**
|
|
5910
|
-
* Add
|
|
6183
|
+
* Add the BUS inputs/outputs service to the cell. Starts a containerized service that enables BUS connections via the specified ethernet port.
|
|
5911
6184
|
* @summary Add Service
|
|
5912
6185
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5913
6186
|
* @param {BusIOType} busIOType
|
|
@@ -5918,7 +6191,7 @@ export declare class BUSInputsOutputsApi extends BaseAPI {
|
|
|
5918
6191
|
*/
|
|
5919
6192
|
addBusIOService(cell: string, busIOType: BusIOType, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
5920
6193
|
/**
|
|
5921
|
-
* Adds an input/output to or updates an input/output on the PROFINET device.
|
|
6194
|
+
* 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
6195
|
* @summary Add PROFINET Input/Output
|
|
5923
6196
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5924
6197
|
* @param {string} io Unique identifier to address an Input/Output in the cell.
|
|
@@ -5929,7 +6202,7 @@ export declare class BUSInputsOutputsApi extends BaseAPI {
|
|
|
5929
6202
|
*/
|
|
5930
6203
|
addProfinetIO(cell: string, io: string, profinetIOData: ProfinetIOData, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
5931
6204
|
/**
|
|
5932
|
-
*
|
|
6205
|
+
* Remove the BUS inputs/outputs service from the cell.
|
|
5933
6206
|
* @summary Clear Service
|
|
5934
6207
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5935
6208
|
* @param {number} [completionTimeout]
|
|
@@ -5939,7 +6212,7 @@ export declare class BUSInputsOutputsApi extends BaseAPI {
|
|
|
5939
6212
|
*/
|
|
5940
6213
|
clearBusIOService(cell: string, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
5941
6214
|
/**
|
|
5942
|
-
* Removes
|
|
6215
|
+
* Removes an input/output variable configuration from the PROFINET device, e.g. NOVA\'s PROFINET service.
|
|
5943
6216
|
* @summary Remove PROFINET Input/Ouptut
|
|
5944
6217
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5945
6218
|
* @param {string} io Unique identifier to address an Input/Output in the cell.
|
|
@@ -5949,16 +6222,14 @@ export declare class BUSInputsOutputsApi extends BaseAPI {
|
|
|
5949
6222
|
*/
|
|
5950
6223
|
deleteProfinetIO(cell: string, io: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
5951
6224
|
/**
|
|
5952
|
-
* Get deployed BUS
|
|
6225
|
+
* Get deployed BUS inputs/outputs service.
|
|
5953
6226
|
* @summary Get Service
|
|
5954
6227
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5955
6228
|
* @param {*} [options] Override http request option.
|
|
5956
6229
|
* @throws {RequiredError}
|
|
5957
6230
|
* @memberof BUSInputsOutputsApi
|
|
5958
6231
|
*/
|
|
5959
|
-
getBusIOService(cell: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<
|
|
5960
|
-
bus_type: "profinet";
|
|
5961
|
-
} & BusIOProfinet, any>>;
|
|
6232
|
+
getBusIOService(cell: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<BusIOType, any>>;
|
|
5962
6233
|
/**
|
|
5963
6234
|
* Get the current state of the BUS Inputs/Outputs service.
|
|
5964
6235
|
* @summary State
|
|
@@ -5979,7 +6250,7 @@ export declare class BUSInputsOutputsApi extends BaseAPI {
|
|
|
5979
6250
|
*/
|
|
5980
6251
|
getBusIOValues(cell: string, ios?: Array<string>, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<IOValue[], any>>;
|
|
5981
6252
|
/**
|
|
5982
|
-
* Get description of PROFINET
|
|
6253
|
+
* Get description of NOVA as a PROFINET device.
|
|
5983
6254
|
* @summary Get PROFINET Description
|
|
5984
6255
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5985
6256
|
* @param {*} [options] Override http request option.
|
|
@@ -5988,7 +6259,7 @@ export declare class BUSInputsOutputsApi extends BaseAPI {
|
|
|
5988
6259
|
*/
|
|
5989
6260
|
getProfinetDescription(cell: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ProfinetDescription, any>>;
|
|
5990
6261
|
/**
|
|
5991
|
-
* Get input/output configuration of the PROFINET device as file.
|
|
6262
|
+
* 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
6263
|
* @summary PROFINET Inputs/Outputs to File
|
|
5993
6264
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5994
6265
|
* @param {number} [inputOffset]
|
|
@@ -5999,16 +6270,16 @@ export declare class BUSInputsOutputsApi extends BaseAPI {
|
|
|
5999
6270
|
*/
|
|
6000
6271
|
getProfinetIOsFromFile(cell: string, inputOffset?: number, outputOffset?: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<string, any>>;
|
|
6001
6272
|
/**
|
|
6002
|
-
* List all BUS
|
|
6273
|
+
* 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.
|
|
6003
6274
|
* @summary List Descriptions
|
|
6004
6275
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
6005
6276
|
* @param {*} [options] Override http request option.
|
|
6006
6277
|
* @throws {RequiredError}
|
|
6007
6278
|
* @memberof BUSInputsOutputsApi
|
|
6008
6279
|
*/
|
|
6009
|
-
listBusIODescriptions(cell: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<
|
|
6280
|
+
listBusIODescriptions(cell: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<IODescription2[], any>>;
|
|
6010
6281
|
/**
|
|
6011
|
-
* List all PROFINET input and
|
|
6282
|
+
* 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.
|
|
6012
6283
|
* @summary List PROFINET Input/Output Configuration
|
|
6013
6284
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
6014
6285
|
* @param {*} [options] Override http request option.
|
|
@@ -6027,7 +6298,7 @@ export declare class BUSInputsOutputsApi extends BaseAPI {
|
|
|
6027
6298
|
*/
|
|
6028
6299
|
setBusIOValues(cell: string, iOValue: Array<IOValue>, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
6029
6300
|
/**
|
|
6030
|
-
* Sets inputs/outputs
|
|
6301
|
+
* 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.
|
|
6031
6302
|
* @summary Set PROFINET Inputs/Outputs from File
|
|
6032
6303
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
6033
6304
|
* @param {ProfinetInputOutputConfig} profinetInputOutputConfig
|
|
@@ -7617,7 +7888,7 @@ export declare class MotionGroupApi extends BaseAPI {
|
|
|
7617
7888
|
*/
|
|
7618
7889
|
export declare const MotionGroupModelsApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
7619
7890
|
/**
|
|
7620
|
-
* Returns the default collision link chain for a given motion group model. See [
|
|
7891
|
+
* 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
7892
|
* @summary Get Collision Model
|
|
7622
7893
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
7623
7894
|
* @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 +7911,7 @@ export declare const MotionGroupModelsApiAxiosParamCreator: (configuration?: Con
|
|
|
7640
7911
|
*/
|
|
7641
7912
|
export declare const MotionGroupModelsApiFp: (configuration?: Configuration) => {
|
|
7642
7913
|
/**
|
|
7643
|
-
* Returns the default collision link chain for a given motion group model. See [
|
|
7914
|
+
* 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
7915
|
* @summary Get Collision Model
|
|
7645
7916
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
7646
7917
|
* @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 +7936,7 @@ export declare const MotionGroupModelsApiFp: (configuration?: Configuration) =>
|
|
|
7665
7936
|
*/
|
|
7666
7937
|
export declare const MotionGroupModelsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
7667
7938
|
/**
|
|
7668
|
-
* Returns the default collision link chain for a given motion group model. See [
|
|
7939
|
+
* 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
7940
|
* @summary Get Collision Model
|
|
7670
7941
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
7671
7942
|
* @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 +7963,7 @@ export declare const MotionGroupModelsApiFactory: (configuration?: Configuration
|
|
|
7692
7963
|
*/
|
|
7693
7964
|
export declare class MotionGroupModelsApi extends BaseAPI {
|
|
7694
7965
|
/**
|
|
7695
|
-
* Returns the default collision link chain for a given motion group model. See [
|
|
7966
|
+
* 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
7967
|
* @summary Get Collision Model
|
|
7697
7968
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
7698
7969
|
* @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 +7984,180 @@ export declare class MotionGroupModelsApi extends BaseAPI {
|
|
|
7713
7984
|
*/
|
|
7714
7985
|
getMotionGroupModels(cell: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<string[], any>>;
|
|
7715
7986
|
}
|
|
7987
|
+
/**
|
|
7988
|
+
* ProgramApi - axios parameter creator
|
|
7989
|
+
* @export
|
|
7990
|
+
*/
|
|
7991
|
+
export declare const ProgramApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
7992
|
+
/**
|
|
7993
|
+
* Get details of a program.
|
|
7994
|
+
* @summary Get program
|
|
7995
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
7996
|
+
* @param {string} program
|
|
7997
|
+
* @param {*} [options] Override http request option.
|
|
7998
|
+
* @throws {RequiredError}
|
|
7999
|
+
*/
|
|
8000
|
+
getProgram: (cell: string, program: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
8001
|
+
/**
|
|
8002
|
+
* List details of all existing programs.
|
|
8003
|
+
* @summary List programs
|
|
8004
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8005
|
+
* @param {*} [options] Override http request option.
|
|
8006
|
+
* @throws {RequiredError}
|
|
8007
|
+
*/
|
|
8008
|
+
listPrograms: (cell: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
8009
|
+
/**
|
|
8010
|
+
* This endpoint starts a new program execution. The program will be executed asynchronously.
|
|
8011
|
+
* @summary Start the program
|
|
8012
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8013
|
+
* @param {string} program
|
|
8014
|
+
* @param {ProgramStartRequest} programStartRequest
|
|
8015
|
+
* @param {*} [options] Override http request option.
|
|
8016
|
+
* @throws {RequiredError}
|
|
8017
|
+
*/
|
|
8018
|
+
startProgram: (cell: string, program: string, programStartRequest: ProgramStartRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
8019
|
+
/**
|
|
8020
|
+
* Stop a specific program run.
|
|
8021
|
+
* @summary Stop program run
|
|
8022
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8023
|
+
* @param {string} program
|
|
8024
|
+
* @param {*} [options] Override http request option.
|
|
8025
|
+
* @throws {RequiredError}
|
|
8026
|
+
*/
|
|
8027
|
+
stopProgram: (cell: string, program: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
8028
|
+
};
|
|
8029
|
+
/**
|
|
8030
|
+
* ProgramApi - functional programming interface
|
|
8031
|
+
* @export
|
|
8032
|
+
*/
|
|
8033
|
+
export declare const ProgramApiFp: (configuration?: Configuration) => {
|
|
8034
|
+
/**
|
|
8035
|
+
* Get details of a program.
|
|
8036
|
+
* @summary Get program
|
|
8037
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8038
|
+
* @param {string} program
|
|
8039
|
+
* @param {*} [options] Override http request option.
|
|
8040
|
+
* @throws {RequiredError}
|
|
8041
|
+
*/
|
|
8042
|
+
getProgram(cell: string, program: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Program>>;
|
|
8043
|
+
/**
|
|
8044
|
+
* List details of all existing programs.
|
|
8045
|
+
* @summary List programs
|
|
8046
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8047
|
+
* @param {*} [options] Override http request option.
|
|
8048
|
+
* @throws {RequiredError}
|
|
8049
|
+
*/
|
|
8050
|
+
listPrograms(cell: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<Program>>>;
|
|
8051
|
+
/**
|
|
8052
|
+
* This endpoint starts a new program execution. The program will be executed asynchronously.
|
|
8053
|
+
* @summary Start the program
|
|
8054
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8055
|
+
* @param {string} program
|
|
8056
|
+
* @param {ProgramStartRequest} programStartRequest
|
|
8057
|
+
* @param {*} [options] Override http request option.
|
|
8058
|
+
* @throws {RequiredError}
|
|
8059
|
+
*/
|
|
8060
|
+
startProgram(cell: string, program: string, programStartRequest: ProgramStartRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ProgramRun>>;
|
|
8061
|
+
/**
|
|
8062
|
+
* Stop a specific program run.
|
|
8063
|
+
* @summary Stop program run
|
|
8064
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8065
|
+
* @param {string} program
|
|
8066
|
+
* @param {*} [options] Override http request option.
|
|
8067
|
+
* @throws {RequiredError}
|
|
8068
|
+
*/
|
|
8069
|
+
stopProgram(cell: string, program: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
8070
|
+
};
|
|
8071
|
+
/**
|
|
8072
|
+
* ProgramApi - factory interface
|
|
8073
|
+
* @export
|
|
8074
|
+
*/
|
|
8075
|
+
export declare const ProgramApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
8076
|
+
/**
|
|
8077
|
+
* Get details of a program.
|
|
8078
|
+
* @summary Get program
|
|
8079
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8080
|
+
* @param {string} program
|
|
8081
|
+
* @param {*} [options] Override http request option.
|
|
8082
|
+
* @throws {RequiredError}
|
|
8083
|
+
*/
|
|
8084
|
+
getProgram(cell: string, program: string, options?: RawAxiosRequestConfig): AxiosPromise<Program>;
|
|
8085
|
+
/**
|
|
8086
|
+
* List details of all existing programs.
|
|
8087
|
+
* @summary List programs
|
|
8088
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8089
|
+
* @param {*} [options] Override http request option.
|
|
8090
|
+
* @throws {RequiredError}
|
|
8091
|
+
*/
|
|
8092
|
+
listPrograms(cell: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<Program>>;
|
|
8093
|
+
/**
|
|
8094
|
+
* This endpoint starts a new program execution. The program will be executed asynchronously.
|
|
8095
|
+
* @summary Start the program
|
|
8096
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8097
|
+
* @param {string} program
|
|
8098
|
+
* @param {ProgramStartRequest} programStartRequest
|
|
8099
|
+
* @param {*} [options] Override http request option.
|
|
8100
|
+
* @throws {RequiredError}
|
|
8101
|
+
*/
|
|
8102
|
+
startProgram(cell: string, program: string, programStartRequest: ProgramStartRequest, options?: RawAxiosRequestConfig): AxiosPromise<ProgramRun>;
|
|
8103
|
+
/**
|
|
8104
|
+
* Stop a specific program run.
|
|
8105
|
+
* @summary Stop program run
|
|
8106
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8107
|
+
* @param {string} program
|
|
8108
|
+
* @param {*} [options] Override http request option.
|
|
8109
|
+
* @throws {RequiredError}
|
|
8110
|
+
*/
|
|
8111
|
+
stopProgram(cell: string, program: string, options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
8112
|
+
};
|
|
8113
|
+
/**
|
|
8114
|
+
* ProgramApi - object-oriented interface
|
|
8115
|
+
* @export
|
|
8116
|
+
* @class ProgramApi
|
|
8117
|
+
* @extends {BaseAPI}
|
|
8118
|
+
*/
|
|
8119
|
+
export declare class ProgramApi extends BaseAPI {
|
|
8120
|
+
/**
|
|
8121
|
+
* Get details of a program.
|
|
8122
|
+
* @summary Get program
|
|
8123
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8124
|
+
* @param {string} program
|
|
8125
|
+
* @param {*} [options] Override http request option.
|
|
8126
|
+
* @throws {RequiredError}
|
|
8127
|
+
* @memberof ProgramApi
|
|
8128
|
+
*/
|
|
8129
|
+
getProgram(cell: string, program: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Program, any>>;
|
|
8130
|
+
/**
|
|
8131
|
+
* List details of all existing programs.
|
|
8132
|
+
* @summary List programs
|
|
8133
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8134
|
+
* @param {*} [options] Override http request option.
|
|
8135
|
+
* @throws {RequiredError}
|
|
8136
|
+
* @memberof ProgramApi
|
|
8137
|
+
*/
|
|
8138
|
+
listPrograms(cell: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Program[], any>>;
|
|
8139
|
+
/**
|
|
8140
|
+
* This endpoint starts a new program execution. The program will be executed asynchronously.
|
|
8141
|
+
* @summary Start the program
|
|
8142
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8143
|
+
* @param {string} program
|
|
8144
|
+
* @param {ProgramStartRequest} programStartRequest
|
|
8145
|
+
* @param {*} [options] Override http request option.
|
|
8146
|
+
* @throws {RequiredError}
|
|
8147
|
+
* @memberof ProgramApi
|
|
8148
|
+
*/
|
|
8149
|
+
startProgram(cell: string, program: string, programStartRequest: ProgramStartRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ProgramRun, any>>;
|
|
8150
|
+
/**
|
|
8151
|
+
* Stop a specific program run.
|
|
8152
|
+
* @summary Stop program run
|
|
8153
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8154
|
+
* @param {string} program
|
|
8155
|
+
* @param {*} [options] Override http request option.
|
|
8156
|
+
* @throws {RequiredError}
|
|
8157
|
+
* @memberof ProgramApi
|
|
8158
|
+
*/
|
|
8159
|
+
stopProgram(cell: string, program: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
8160
|
+
}
|
|
7716
8161
|
/**
|
|
7717
8162
|
* StoreCollisionComponentsApi - axios parameter creator
|
|
7718
8163
|
* @export
|
|
@@ -7781,7 +8226,7 @@ export declare const StoreCollisionComponentsApiAxiosParamCreator: (configuratio
|
|
|
7781
8226
|
*/
|
|
7782
8227
|
listCollisionLinkChains: (cell: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
7783
8228
|
/**
|
|
7784
|
-
* Returns
|
|
8229
|
+
* Returns all stored colliders.
|
|
7785
8230
|
* @summary List Colliders
|
|
7786
8231
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
7787
8232
|
* @param {*} [options] Override http request option.
|
|
@@ -7907,7 +8352,7 @@ export declare const StoreCollisionComponentsApiFp: (configuration?: Configurati
|
|
|
7907
8352
|
}>;
|
|
7908
8353
|
}>>;
|
|
7909
8354
|
/**
|
|
7910
|
-
* Returns
|
|
8355
|
+
* Returns all stored colliders.
|
|
7911
8356
|
* @summary List Colliders
|
|
7912
8357
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
7913
8358
|
* @param {*} [options] Override http request option.
|
|
@@ -8043,7 +8488,7 @@ export declare const StoreCollisionComponentsApiFactory: (configuration?: Config
|
|
|
8043
8488
|
}>;
|
|
8044
8489
|
}>;
|
|
8045
8490
|
/**
|
|
8046
|
-
* Returns
|
|
8491
|
+
* Returns all stored colliders.
|
|
8047
8492
|
* @summary List Colliders
|
|
8048
8493
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8049
8494
|
* @param {*} [options] Override http request option.
|
|
@@ -8188,7 +8633,7 @@ export declare class StoreCollisionComponentsApi extends BaseAPI {
|
|
|
8188
8633
|
}[];
|
|
8189
8634
|
}, any>>;
|
|
8190
8635
|
/**
|
|
8191
|
-
* Returns
|
|
8636
|
+
* Returns all stored colliders.
|
|
8192
8637
|
* @summary List Colliders
|
|
8193
8638
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8194
8639
|
* @param {*} [options] Override http request option.
|