@wandelbots/nova-api 25.8.0-dev.2 → 25.8.0-dev.20
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 +524 -97
- package/v2/api.js +394 -43
- package/v2/api.js.map +1 -1
- package/v2/api.ts +713 -93
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.
|
|
@@ -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,24 +4161,166 @@ 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
|
}
|
|
4182
|
+
/**
|
|
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
|
+
}
|
|
4104
4324
|
/**
|
|
4105
4325
|
* <!-- theme: danger --> > **Experimental** 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. 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.
|
|
4106
4326
|
* @export
|
|
@@ -4850,9 +5070,19 @@ export type TrajectoryDetailsKindEnum = typeof TrajectoryDetailsKindEnum[keyof t
|
|
|
4850
5070
|
* @type TrajectoryDetailsState
|
|
4851
5071
|
* @export
|
|
4852
5072
|
*/
|
|
4853
|
-
export type TrajectoryDetailsState =
|
|
5073
|
+
export type TrajectoryDetailsState = {
|
|
5074
|
+
kind: 'END_OF_TRAJECTORY';
|
|
5075
|
+
} & TrajectoryEnded | {
|
|
5076
|
+
kind: 'PAUSED_BY_USER';
|
|
5077
|
+
} & TrajectoryPausedByUser | {
|
|
5078
|
+
kind: 'PAUSED_ON_IO';
|
|
5079
|
+
} & TrajectoryPausedOnIO | {
|
|
5080
|
+
kind: 'RUNNING';
|
|
5081
|
+
} & TrajectoryRunning | {
|
|
5082
|
+
kind: 'WAIT_FOR_IO';
|
|
5083
|
+
} & TrajectoryWaitForIO;
|
|
4854
5084
|
/**
|
|
4855
|
-
*
|
|
5085
|
+
* First or last sample (depending on direction) of trajectory has been sent.
|
|
4856
5086
|
* @export
|
|
4857
5087
|
* @interface TrajectoryEnded
|
|
4858
5088
|
*/
|
|
@@ -4892,7 +5122,7 @@ export declare const TrajectoryIdMessageTypeEnum: {
|
|
|
4892
5122
|
};
|
|
4893
5123
|
export type TrajectoryIdMessageTypeEnum = typeof TrajectoryIdMessageTypeEnum[keyof typeof TrajectoryIdMessageTypeEnum];
|
|
4894
5124
|
/**
|
|
4895
|
-
*
|
|
5125
|
+
* User has paused execution.
|
|
4896
5126
|
* @export
|
|
4897
5127
|
* @interface TrajectoryPausedByUser
|
|
4898
5128
|
*/
|
|
@@ -4909,7 +5139,7 @@ export declare const TrajectoryPausedByUserKindEnum: {
|
|
|
4909
5139
|
};
|
|
4910
5140
|
export type TrajectoryPausedByUserKindEnum = typeof TrajectoryPausedByUserKindEnum[keyof typeof TrajectoryPausedByUserKindEnum];
|
|
4911
5141
|
/**
|
|
4912
|
-
*
|
|
5142
|
+
* Execution was paused because of an I/O event.
|
|
4913
5143
|
* @export
|
|
4914
5144
|
* @interface TrajectoryPausedOnIO
|
|
4915
5145
|
*/
|
|
@@ -4926,7 +5156,7 @@ export declare const TrajectoryPausedOnIOKindEnum: {
|
|
|
4926
5156
|
};
|
|
4927
5157
|
export type TrajectoryPausedOnIOKindEnum = typeof TrajectoryPausedOnIOKindEnum[keyof typeof TrajectoryPausedOnIOKindEnum];
|
|
4928
5158
|
/**
|
|
4929
|
-
*
|
|
5159
|
+
* Trajectory is being executed.
|
|
4930
5160
|
* @export
|
|
4931
5161
|
* @interface TrajectoryRunning
|
|
4932
5162
|
*/
|
|
@@ -4949,7 +5179,7 @@ export declare const TrajectoryRunningKindEnum: {
|
|
|
4949
5179
|
};
|
|
4950
5180
|
export type TrajectoryRunningKindEnum = typeof TrajectoryRunningKindEnum[keyof typeof TrajectoryRunningKindEnum];
|
|
4951
5181
|
/**
|
|
4952
|
-
*
|
|
5182
|
+
* Waiting for an I/O event to start execution.
|
|
4953
5183
|
* @export
|
|
4954
5184
|
* @interface TrajectoryWaitForIO
|
|
4955
5185
|
*/
|
|
@@ -5052,6 +5282,31 @@ export interface ValidationError {
|
|
|
5052
5282
|
[key: string]: any;
|
|
5053
5283
|
};
|
|
5054
5284
|
}
|
|
5285
|
+
/**
|
|
5286
|
+
* A validation error of a program.
|
|
5287
|
+
* @export
|
|
5288
|
+
* @interface ValidationError2
|
|
5289
|
+
*/
|
|
5290
|
+
export interface ValidationError2 {
|
|
5291
|
+
/**
|
|
5292
|
+
*
|
|
5293
|
+
* @type {Array<number>}
|
|
5294
|
+
* @memberof ValidationError2
|
|
5295
|
+
*/
|
|
5296
|
+
'loc': Array<number>;
|
|
5297
|
+
/**
|
|
5298
|
+
*
|
|
5299
|
+
* @type {string}
|
|
5300
|
+
* @memberof ValidationError2
|
|
5301
|
+
*/
|
|
5302
|
+
'msg': string;
|
|
5303
|
+
/**
|
|
5304
|
+
*
|
|
5305
|
+
* @type {string}
|
|
5306
|
+
* @memberof ValidationError2
|
|
5307
|
+
*/
|
|
5308
|
+
'type': string;
|
|
5309
|
+
}
|
|
5055
5310
|
/**
|
|
5056
5311
|
* @type ValidationErrorLocInner
|
|
5057
5312
|
* @export
|
|
@@ -5542,7 +5797,7 @@ export declare class ApplicationApi extends BaseAPI {
|
|
|
5542
5797
|
*/
|
|
5543
5798
|
export declare const BUSInputsOutputsApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
5544
5799
|
/**
|
|
5545
|
-
* Add
|
|
5800
|
+
* Add the BUS inputs/outputs service to the cell. Starts a containerized service that enables BUS connections via the specified ethernet port.
|
|
5546
5801
|
* @summary Add Service
|
|
5547
5802
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5548
5803
|
* @param {BusIOType} busIOType
|
|
@@ -5552,7 +5807,7 @@ export declare const BUSInputsOutputsApiAxiosParamCreator: (configuration?: Conf
|
|
|
5552
5807
|
*/
|
|
5553
5808
|
addBusIOService: (cell: string, busIOType: BusIOType, completionTimeout?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
5554
5809
|
/**
|
|
5555
|
-
* Adds an input/output to or updates an input/output on the PROFINET device.
|
|
5810
|
+
* 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
5811
|
* @summary Add PROFINET Input/Output
|
|
5557
5812
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5558
5813
|
* @param {string} io Unique identifier to address an Input/Output in the cell.
|
|
@@ -5562,7 +5817,7 @@ export declare const BUSInputsOutputsApiAxiosParamCreator: (configuration?: Conf
|
|
|
5562
5817
|
*/
|
|
5563
5818
|
addProfinetIO: (cell: string, io: string, profinetIOData: ProfinetIOData, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
5564
5819
|
/**
|
|
5565
|
-
*
|
|
5820
|
+
* Remove the BUS inputs/outputs service from the cell.
|
|
5566
5821
|
* @summary Clear Service
|
|
5567
5822
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5568
5823
|
* @param {number} [completionTimeout]
|
|
@@ -5571,7 +5826,7 @@ export declare const BUSInputsOutputsApiAxiosParamCreator: (configuration?: Conf
|
|
|
5571
5826
|
*/
|
|
5572
5827
|
clearBusIOService: (cell: string, completionTimeout?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
5573
5828
|
/**
|
|
5574
|
-
* Removes
|
|
5829
|
+
* Removes an input/output variable configuration from the PROFINET device, e.g. NOVA\'s PROFINET service.
|
|
5575
5830
|
* @summary Remove PROFINET Input/Ouptut
|
|
5576
5831
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5577
5832
|
* @param {string} io Unique identifier to address an Input/Output in the cell.
|
|
@@ -5580,7 +5835,7 @@ export declare const BUSInputsOutputsApiAxiosParamCreator: (configuration?: Conf
|
|
|
5580
5835
|
*/
|
|
5581
5836
|
deleteProfinetIO: (cell: string, io: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
5582
5837
|
/**
|
|
5583
|
-
* Get deployed BUS
|
|
5838
|
+
* Get deployed BUS inputs/outputs service.
|
|
5584
5839
|
* @summary Get Service
|
|
5585
5840
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5586
5841
|
* @param {*} [options] Override http request option.
|
|
@@ -5605,7 +5860,7 @@ export declare const BUSInputsOutputsApiAxiosParamCreator: (configuration?: Conf
|
|
|
5605
5860
|
*/
|
|
5606
5861
|
getBusIOValues: (cell: string, ios?: Array<string>, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
5607
5862
|
/**
|
|
5608
|
-
* Get description of PROFINET
|
|
5863
|
+
* Get description of NOVA as a PROFINET device.
|
|
5609
5864
|
* @summary Get PROFINET Description
|
|
5610
5865
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5611
5866
|
* @param {*} [options] Override http request option.
|
|
@@ -5613,7 +5868,7 @@ export declare const BUSInputsOutputsApiAxiosParamCreator: (configuration?: Conf
|
|
|
5613
5868
|
*/
|
|
5614
5869
|
getProfinetDescription: (cell: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
5615
5870
|
/**
|
|
5616
|
-
* Get input/output configuration of the PROFINET device as file.
|
|
5871
|
+
* 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
5872
|
* @summary PROFINET Inputs/Outputs to File
|
|
5618
5873
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5619
5874
|
* @param {number} [inputOffset]
|
|
@@ -5623,7 +5878,7 @@ export declare const BUSInputsOutputsApiAxiosParamCreator: (configuration?: Conf
|
|
|
5623
5878
|
*/
|
|
5624
5879
|
getProfinetIOsFromFile: (cell: string, inputOffset?: number, outputOffset?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
5625
5880
|
/**
|
|
5626
|
-
* List all BUS
|
|
5881
|
+
* 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
5882
|
* @summary List Descriptions
|
|
5628
5883
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5629
5884
|
* @param {*} [options] Override http request option.
|
|
@@ -5631,7 +5886,7 @@ export declare const BUSInputsOutputsApiAxiosParamCreator: (configuration?: Conf
|
|
|
5631
5886
|
*/
|
|
5632
5887
|
listBusIODescriptions: (cell: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
5633
5888
|
/**
|
|
5634
|
-
* List all PROFINET input and
|
|
5889
|
+
* 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
5890
|
* @summary List PROFINET Input/Output Configuration
|
|
5636
5891
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5637
5892
|
* @param {*} [options] Override http request option.
|
|
@@ -5648,7 +5903,7 @@ export declare const BUSInputsOutputsApiAxiosParamCreator: (configuration?: Conf
|
|
|
5648
5903
|
*/
|
|
5649
5904
|
setBusIOValues: (cell: string, iOValue: Array<IOValue>, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
5650
5905
|
/**
|
|
5651
|
-
* Sets
|
|
5906
|
+
* 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
5907
|
* @summary Set PROFINET Inputs/Outputs from File
|
|
5653
5908
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5654
5909
|
* @param {ProfinetInputOutputConfig} profinetInputOutputConfig
|
|
@@ -5663,7 +5918,7 @@ export declare const BUSInputsOutputsApiAxiosParamCreator: (configuration?: Conf
|
|
|
5663
5918
|
*/
|
|
5664
5919
|
export declare const BUSInputsOutputsApiFp: (configuration?: Configuration) => {
|
|
5665
5920
|
/**
|
|
5666
|
-
* Add
|
|
5921
|
+
* Add the BUS inputs/outputs service to the cell. Starts a containerized service that enables BUS connections via the specified ethernet port.
|
|
5667
5922
|
* @summary Add Service
|
|
5668
5923
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5669
5924
|
* @param {BusIOType} busIOType
|
|
@@ -5673,7 +5928,7 @@ export declare const BUSInputsOutputsApiFp: (configuration?: Configuration) => {
|
|
|
5673
5928
|
*/
|
|
5674
5929
|
addBusIOService(cell: string, busIOType: BusIOType, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
5675
5930
|
/**
|
|
5676
|
-
* Adds an input/output to or updates an input/output on the PROFINET device.
|
|
5931
|
+
* 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
5932
|
* @summary Add PROFINET Input/Output
|
|
5678
5933
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5679
5934
|
* @param {string} io Unique identifier to address an Input/Output in the cell.
|
|
@@ -5683,7 +5938,7 @@ export declare const BUSInputsOutputsApiFp: (configuration?: Configuration) => {
|
|
|
5683
5938
|
*/
|
|
5684
5939
|
addProfinetIO(cell: string, io: string, profinetIOData: ProfinetIOData, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
5685
5940
|
/**
|
|
5686
|
-
*
|
|
5941
|
+
* Remove the BUS inputs/outputs service from the cell.
|
|
5687
5942
|
* @summary Clear Service
|
|
5688
5943
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5689
5944
|
* @param {number} [completionTimeout]
|
|
@@ -5692,7 +5947,7 @@ export declare const BUSInputsOutputsApiFp: (configuration?: Configuration) => {
|
|
|
5692
5947
|
*/
|
|
5693
5948
|
clearBusIOService(cell: string, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
5694
5949
|
/**
|
|
5695
|
-
* Removes
|
|
5950
|
+
* Removes an input/output variable configuration from the PROFINET device, e.g. NOVA\'s PROFINET service.
|
|
5696
5951
|
* @summary Remove PROFINET Input/Ouptut
|
|
5697
5952
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5698
5953
|
* @param {string} io Unique identifier to address an Input/Output in the cell.
|
|
@@ -5701,7 +5956,7 @@ export declare const BUSInputsOutputsApiFp: (configuration?: Configuration) => {
|
|
|
5701
5956
|
*/
|
|
5702
5957
|
deleteProfinetIO(cell: string, io: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
5703
5958
|
/**
|
|
5704
|
-
* Get deployed BUS
|
|
5959
|
+
* Get deployed BUS inputs/outputs service.
|
|
5705
5960
|
* @summary Get Service
|
|
5706
5961
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5707
5962
|
* @param {*} [options] Override http request option.
|
|
@@ -5726,7 +5981,7 @@ export declare const BUSInputsOutputsApiFp: (configuration?: Configuration) => {
|
|
|
5726
5981
|
*/
|
|
5727
5982
|
getBusIOValues(cell: string, ios?: Array<string>, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<IOValue>>>;
|
|
5728
5983
|
/**
|
|
5729
|
-
* Get description of PROFINET
|
|
5984
|
+
* Get description of NOVA as a PROFINET device.
|
|
5730
5985
|
* @summary Get PROFINET Description
|
|
5731
5986
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5732
5987
|
* @param {*} [options] Override http request option.
|
|
@@ -5734,7 +5989,7 @@ export declare const BUSInputsOutputsApiFp: (configuration?: Configuration) => {
|
|
|
5734
5989
|
*/
|
|
5735
5990
|
getProfinetDescription(cell: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ProfinetDescription>>;
|
|
5736
5991
|
/**
|
|
5737
|
-
* Get input/output configuration of the PROFINET device as file.
|
|
5992
|
+
* 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
5993
|
* @summary PROFINET Inputs/Outputs to File
|
|
5739
5994
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5740
5995
|
* @param {number} [inputOffset]
|
|
@@ -5744,15 +5999,15 @@ export declare const BUSInputsOutputsApiFp: (configuration?: Configuration) => {
|
|
|
5744
5999
|
*/
|
|
5745
6000
|
getProfinetIOsFromFile(cell: string, inputOffset?: number, outputOffset?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<string>>;
|
|
5746
6001
|
/**
|
|
5747
|
-
* List all BUS
|
|
6002
|
+
* 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
6003
|
* @summary List Descriptions
|
|
5749
6004
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5750
6005
|
* @param {*} [options] Override http request option.
|
|
5751
6006
|
* @throws {RequiredError}
|
|
5752
6007
|
*/
|
|
5753
|
-
listBusIODescriptions(cell: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<
|
|
6008
|
+
listBusIODescriptions(cell: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<IODescription2>>>;
|
|
5754
6009
|
/**
|
|
5755
|
-
* List all PROFINET input and
|
|
6010
|
+
* 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
6011
|
* @summary List PROFINET Input/Output Configuration
|
|
5757
6012
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5758
6013
|
* @param {*} [options] Override http request option.
|
|
@@ -5769,7 +6024,7 @@ export declare const BUSInputsOutputsApiFp: (configuration?: Configuration) => {
|
|
|
5769
6024
|
*/
|
|
5770
6025
|
setBusIOValues(cell: string, iOValue: Array<IOValue>, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
5771
6026
|
/**
|
|
5772
|
-
* Sets
|
|
6027
|
+
* 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
6028
|
* @summary Set PROFINET Inputs/Outputs from File
|
|
5774
6029
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5775
6030
|
* @param {ProfinetInputOutputConfig} profinetInputOutputConfig
|
|
@@ -5784,7 +6039,7 @@ export declare const BUSInputsOutputsApiFp: (configuration?: Configuration) => {
|
|
|
5784
6039
|
*/
|
|
5785
6040
|
export declare const BUSInputsOutputsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
5786
6041
|
/**
|
|
5787
|
-
* Add
|
|
6042
|
+
* Add the BUS inputs/outputs service to the cell. Starts a containerized service that enables BUS connections via the specified ethernet port.
|
|
5788
6043
|
* @summary Add Service
|
|
5789
6044
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5790
6045
|
* @param {BusIOType} busIOType
|
|
@@ -5794,7 +6049,7 @@ export declare const BUSInputsOutputsApiFactory: (configuration?: Configuration,
|
|
|
5794
6049
|
*/
|
|
5795
6050
|
addBusIOService(cell: string, busIOType: BusIOType, completionTimeout?: number, options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
5796
6051
|
/**
|
|
5797
|
-
* Adds an input/output to or updates an input/output on the PROFINET device.
|
|
6052
|
+
* 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
6053
|
* @summary Add PROFINET Input/Output
|
|
5799
6054
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5800
6055
|
* @param {string} io Unique identifier to address an Input/Output in the cell.
|
|
@@ -5804,7 +6059,7 @@ export declare const BUSInputsOutputsApiFactory: (configuration?: Configuration,
|
|
|
5804
6059
|
*/
|
|
5805
6060
|
addProfinetIO(cell: string, io: string, profinetIOData: ProfinetIOData, options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
5806
6061
|
/**
|
|
5807
|
-
*
|
|
6062
|
+
* Remove the BUS inputs/outputs service from the cell.
|
|
5808
6063
|
* @summary Clear Service
|
|
5809
6064
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5810
6065
|
* @param {number} [completionTimeout]
|
|
@@ -5813,7 +6068,7 @@ export declare const BUSInputsOutputsApiFactory: (configuration?: Configuration,
|
|
|
5813
6068
|
*/
|
|
5814
6069
|
clearBusIOService(cell: string, completionTimeout?: number, options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
5815
6070
|
/**
|
|
5816
|
-
* Removes
|
|
6071
|
+
* Removes an input/output variable configuration from the PROFINET device, e.g. NOVA\'s PROFINET service.
|
|
5817
6072
|
* @summary Remove PROFINET Input/Ouptut
|
|
5818
6073
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5819
6074
|
* @param {string} io Unique identifier to address an Input/Output in the cell.
|
|
@@ -5822,7 +6077,7 @@ export declare const BUSInputsOutputsApiFactory: (configuration?: Configuration,
|
|
|
5822
6077
|
*/
|
|
5823
6078
|
deleteProfinetIO(cell: string, io: string, options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
5824
6079
|
/**
|
|
5825
|
-
* Get deployed BUS
|
|
6080
|
+
* Get deployed BUS inputs/outputs service.
|
|
5826
6081
|
* @summary Get Service
|
|
5827
6082
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5828
6083
|
* @param {*} [options] Override http request option.
|
|
@@ -5847,7 +6102,7 @@ export declare const BUSInputsOutputsApiFactory: (configuration?: Configuration,
|
|
|
5847
6102
|
*/
|
|
5848
6103
|
getBusIOValues(cell: string, ios?: Array<string>, options?: RawAxiosRequestConfig): AxiosPromise<Array<IOValue>>;
|
|
5849
6104
|
/**
|
|
5850
|
-
* Get description of PROFINET
|
|
6105
|
+
* Get description of NOVA as a PROFINET device.
|
|
5851
6106
|
* @summary Get PROFINET Description
|
|
5852
6107
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5853
6108
|
* @param {*} [options] Override http request option.
|
|
@@ -5855,7 +6110,7 @@ export declare const BUSInputsOutputsApiFactory: (configuration?: Configuration,
|
|
|
5855
6110
|
*/
|
|
5856
6111
|
getProfinetDescription(cell: string, options?: RawAxiosRequestConfig): AxiosPromise<ProfinetDescription>;
|
|
5857
6112
|
/**
|
|
5858
|
-
* Get input/output configuration of the PROFINET device as file.
|
|
6113
|
+
* 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
6114
|
* @summary PROFINET Inputs/Outputs to File
|
|
5860
6115
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5861
6116
|
* @param {number} [inputOffset]
|
|
@@ -5865,15 +6120,15 @@ export declare const BUSInputsOutputsApiFactory: (configuration?: Configuration,
|
|
|
5865
6120
|
*/
|
|
5866
6121
|
getProfinetIOsFromFile(cell: string, inputOffset?: number, outputOffset?: number, options?: RawAxiosRequestConfig): AxiosPromise<string>;
|
|
5867
6122
|
/**
|
|
5868
|
-
* List all BUS
|
|
6123
|
+
* 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
6124
|
* @summary List Descriptions
|
|
5870
6125
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5871
6126
|
* @param {*} [options] Override http request option.
|
|
5872
6127
|
* @throws {RequiredError}
|
|
5873
6128
|
*/
|
|
5874
|
-
listBusIODescriptions(cell: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<
|
|
6129
|
+
listBusIODescriptions(cell: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<IODescription2>>;
|
|
5875
6130
|
/**
|
|
5876
|
-
* List all PROFINET input and
|
|
6131
|
+
* 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
6132
|
* @summary List PROFINET Input/Output Configuration
|
|
5878
6133
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5879
6134
|
* @param {*} [options] Override http request option.
|
|
@@ -5890,7 +6145,7 @@ export declare const BUSInputsOutputsApiFactory: (configuration?: Configuration,
|
|
|
5890
6145
|
*/
|
|
5891
6146
|
setBusIOValues(cell: string, iOValue: Array<IOValue>, options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
5892
6147
|
/**
|
|
5893
|
-
* Sets
|
|
6148
|
+
* 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
6149
|
* @summary Set PROFINET Inputs/Outputs from File
|
|
5895
6150
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5896
6151
|
* @param {ProfinetInputOutputConfig} profinetInputOutputConfig
|
|
@@ -5907,7 +6162,7 @@ export declare const BUSInputsOutputsApiFactory: (configuration?: Configuration,
|
|
|
5907
6162
|
*/
|
|
5908
6163
|
export declare class BUSInputsOutputsApi extends BaseAPI {
|
|
5909
6164
|
/**
|
|
5910
|
-
* Add
|
|
6165
|
+
* Add the BUS inputs/outputs service to the cell. Starts a containerized service that enables BUS connections via the specified ethernet port.
|
|
5911
6166
|
* @summary Add Service
|
|
5912
6167
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5913
6168
|
* @param {BusIOType} busIOType
|
|
@@ -5918,7 +6173,7 @@ export declare class BUSInputsOutputsApi extends BaseAPI {
|
|
|
5918
6173
|
*/
|
|
5919
6174
|
addBusIOService(cell: string, busIOType: BusIOType, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
5920
6175
|
/**
|
|
5921
|
-
* Adds an input/output to or updates an input/output on the PROFINET device.
|
|
6176
|
+
* 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
6177
|
* @summary Add PROFINET Input/Output
|
|
5923
6178
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5924
6179
|
* @param {string} io Unique identifier to address an Input/Output in the cell.
|
|
@@ -5929,7 +6184,7 @@ export declare class BUSInputsOutputsApi extends BaseAPI {
|
|
|
5929
6184
|
*/
|
|
5930
6185
|
addProfinetIO(cell: string, io: string, profinetIOData: ProfinetIOData, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
5931
6186
|
/**
|
|
5932
|
-
*
|
|
6187
|
+
* Remove the BUS inputs/outputs service from the cell.
|
|
5933
6188
|
* @summary Clear Service
|
|
5934
6189
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5935
6190
|
* @param {number} [completionTimeout]
|
|
@@ -5939,7 +6194,7 @@ export declare class BUSInputsOutputsApi extends BaseAPI {
|
|
|
5939
6194
|
*/
|
|
5940
6195
|
clearBusIOService(cell: string, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
5941
6196
|
/**
|
|
5942
|
-
* Removes
|
|
6197
|
+
* Removes an input/output variable configuration from the PROFINET device, e.g. NOVA\'s PROFINET service.
|
|
5943
6198
|
* @summary Remove PROFINET Input/Ouptut
|
|
5944
6199
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5945
6200
|
* @param {string} io Unique identifier to address an Input/Output in the cell.
|
|
@@ -5949,16 +6204,14 @@ export declare class BUSInputsOutputsApi extends BaseAPI {
|
|
|
5949
6204
|
*/
|
|
5950
6205
|
deleteProfinetIO(cell: string, io: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
5951
6206
|
/**
|
|
5952
|
-
* Get deployed BUS
|
|
6207
|
+
* Get deployed BUS inputs/outputs service.
|
|
5953
6208
|
* @summary Get Service
|
|
5954
6209
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5955
6210
|
* @param {*} [options] Override http request option.
|
|
5956
6211
|
* @throws {RequiredError}
|
|
5957
6212
|
* @memberof BUSInputsOutputsApi
|
|
5958
6213
|
*/
|
|
5959
|
-
getBusIOService(cell: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<
|
|
5960
|
-
bus_type: "profinet";
|
|
5961
|
-
} & BusIOProfinet, any>>;
|
|
6214
|
+
getBusIOService(cell: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<BusIOType, any>>;
|
|
5962
6215
|
/**
|
|
5963
6216
|
* Get the current state of the BUS Inputs/Outputs service.
|
|
5964
6217
|
* @summary State
|
|
@@ -5979,7 +6232,7 @@ export declare class BUSInputsOutputsApi extends BaseAPI {
|
|
|
5979
6232
|
*/
|
|
5980
6233
|
getBusIOValues(cell: string, ios?: Array<string>, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<IOValue[], any>>;
|
|
5981
6234
|
/**
|
|
5982
|
-
* Get description of PROFINET
|
|
6235
|
+
* Get description of NOVA as a PROFINET device.
|
|
5983
6236
|
* @summary Get PROFINET Description
|
|
5984
6237
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5985
6238
|
* @param {*} [options] Override http request option.
|
|
@@ -5988,7 +6241,7 @@ export declare class BUSInputsOutputsApi extends BaseAPI {
|
|
|
5988
6241
|
*/
|
|
5989
6242
|
getProfinetDescription(cell: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ProfinetDescription, any>>;
|
|
5990
6243
|
/**
|
|
5991
|
-
* Get input/output configuration of the PROFINET device as file.
|
|
6244
|
+
* 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
6245
|
* @summary PROFINET Inputs/Outputs to File
|
|
5993
6246
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5994
6247
|
* @param {number} [inputOffset]
|
|
@@ -5999,16 +6252,16 @@ export declare class BUSInputsOutputsApi extends BaseAPI {
|
|
|
5999
6252
|
*/
|
|
6000
6253
|
getProfinetIOsFromFile(cell: string, inputOffset?: number, outputOffset?: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<string, any>>;
|
|
6001
6254
|
/**
|
|
6002
|
-
* List all BUS
|
|
6255
|
+
* 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
6256
|
* @summary List Descriptions
|
|
6004
6257
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
6005
6258
|
* @param {*} [options] Override http request option.
|
|
6006
6259
|
* @throws {RequiredError}
|
|
6007
6260
|
* @memberof BUSInputsOutputsApi
|
|
6008
6261
|
*/
|
|
6009
|
-
listBusIODescriptions(cell: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<
|
|
6262
|
+
listBusIODescriptions(cell: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<IODescription2[], any>>;
|
|
6010
6263
|
/**
|
|
6011
|
-
* List all PROFINET input and
|
|
6264
|
+
* 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
6265
|
* @summary List PROFINET Input/Output Configuration
|
|
6013
6266
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
6014
6267
|
* @param {*} [options] Override http request option.
|
|
@@ -6027,7 +6280,7 @@ export declare class BUSInputsOutputsApi extends BaseAPI {
|
|
|
6027
6280
|
*/
|
|
6028
6281
|
setBusIOValues(cell: string, iOValue: Array<IOValue>, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
6029
6282
|
/**
|
|
6030
|
-
* Sets
|
|
6283
|
+
* 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
6284
|
* @summary Set PROFINET Inputs/Outputs from File
|
|
6032
6285
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
6033
6286
|
* @param {ProfinetInputOutputConfig} profinetInputOutputConfig
|
|
@@ -7713,6 +7966,180 @@ export declare class MotionGroupModelsApi extends BaseAPI {
|
|
|
7713
7966
|
*/
|
|
7714
7967
|
getMotionGroupModels(cell: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<string[], any>>;
|
|
7715
7968
|
}
|
|
7969
|
+
/**
|
|
7970
|
+
* ProgramApi - axios parameter creator
|
|
7971
|
+
* @export
|
|
7972
|
+
*/
|
|
7973
|
+
export declare const ProgramApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
7974
|
+
/**
|
|
7975
|
+
* Get details of a program.
|
|
7976
|
+
* @summary Get program
|
|
7977
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
7978
|
+
* @param {string} program
|
|
7979
|
+
* @param {*} [options] Override http request option.
|
|
7980
|
+
* @throws {RequiredError}
|
|
7981
|
+
*/
|
|
7982
|
+
getProgram: (cell: string, program: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
7983
|
+
/**
|
|
7984
|
+
* List details of all existing programs.
|
|
7985
|
+
* @summary List programs
|
|
7986
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
7987
|
+
* @param {*} [options] Override http request option.
|
|
7988
|
+
* @throws {RequiredError}
|
|
7989
|
+
*/
|
|
7990
|
+
listPrograms: (cell: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
7991
|
+
/**
|
|
7992
|
+
* This endpoint starts a new program execution. The program will be executed asynchronously.
|
|
7993
|
+
* @summary Start the program
|
|
7994
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
7995
|
+
* @param {string} program
|
|
7996
|
+
* @param {ProgramStartRequest} programStartRequest
|
|
7997
|
+
* @param {*} [options] Override http request option.
|
|
7998
|
+
* @throws {RequiredError}
|
|
7999
|
+
*/
|
|
8000
|
+
startProgram: (cell: string, program: string, programStartRequest: ProgramStartRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
8001
|
+
/**
|
|
8002
|
+
* Stop a specific program run.
|
|
8003
|
+
* @summary Stop program run
|
|
8004
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8005
|
+
* @param {string} program
|
|
8006
|
+
* @param {*} [options] Override http request option.
|
|
8007
|
+
* @throws {RequiredError}
|
|
8008
|
+
*/
|
|
8009
|
+
stopProgram: (cell: string, program: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
8010
|
+
};
|
|
8011
|
+
/**
|
|
8012
|
+
* ProgramApi - functional programming interface
|
|
8013
|
+
* @export
|
|
8014
|
+
*/
|
|
8015
|
+
export declare const ProgramApiFp: (configuration?: Configuration) => {
|
|
8016
|
+
/**
|
|
8017
|
+
* Get details of a program.
|
|
8018
|
+
* @summary Get program
|
|
8019
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8020
|
+
* @param {string} program
|
|
8021
|
+
* @param {*} [options] Override http request option.
|
|
8022
|
+
* @throws {RequiredError}
|
|
8023
|
+
*/
|
|
8024
|
+
getProgram(cell: string, program: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Program>>;
|
|
8025
|
+
/**
|
|
8026
|
+
* List details of all existing programs.
|
|
8027
|
+
* @summary List programs
|
|
8028
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8029
|
+
* @param {*} [options] Override http request option.
|
|
8030
|
+
* @throws {RequiredError}
|
|
8031
|
+
*/
|
|
8032
|
+
listPrograms(cell: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<Program>>>;
|
|
8033
|
+
/**
|
|
8034
|
+
* This endpoint starts a new program execution. The program will be executed asynchronously.
|
|
8035
|
+
* @summary Start the program
|
|
8036
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8037
|
+
* @param {string} program
|
|
8038
|
+
* @param {ProgramStartRequest} programStartRequest
|
|
8039
|
+
* @param {*} [options] Override http request option.
|
|
8040
|
+
* @throws {RequiredError}
|
|
8041
|
+
*/
|
|
8042
|
+
startProgram(cell: string, program: string, programStartRequest: ProgramStartRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ProgramRun>>;
|
|
8043
|
+
/**
|
|
8044
|
+
* Stop a specific program run.
|
|
8045
|
+
* @summary Stop program run
|
|
8046
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8047
|
+
* @param {string} program
|
|
8048
|
+
* @param {*} [options] Override http request option.
|
|
8049
|
+
* @throws {RequiredError}
|
|
8050
|
+
*/
|
|
8051
|
+
stopProgram(cell: string, program: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
8052
|
+
};
|
|
8053
|
+
/**
|
|
8054
|
+
* ProgramApi - factory interface
|
|
8055
|
+
* @export
|
|
8056
|
+
*/
|
|
8057
|
+
export declare const ProgramApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
8058
|
+
/**
|
|
8059
|
+
* Get details of a program.
|
|
8060
|
+
* @summary Get program
|
|
8061
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8062
|
+
* @param {string} program
|
|
8063
|
+
* @param {*} [options] Override http request option.
|
|
8064
|
+
* @throws {RequiredError}
|
|
8065
|
+
*/
|
|
8066
|
+
getProgram(cell: string, program: string, options?: RawAxiosRequestConfig): AxiosPromise<Program>;
|
|
8067
|
+
/**
|
|
8068
|
+
* List details of all existing programs.
|
|
8069
|
+
* @summary List programs
|
|
8070
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8071
|
+
* @param {*} [options] Override http request option.
|
|
8072
|
+
* @throws {RequiredError}
|
|
8073
|
+
*/
|
|
8074
|
+
listPrograms(cell: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<Program>>;
|
|
8075
|
+
/**
|
|
8076
|
+
* This endpoint starts a new program execution. The program will be executed asynchronously.
|
|
8077
|
+
* @summary Start the program
|
|
8078
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8079
|
+
* @param {string} program
|
|
8080
|
+
* @param {ProgramStartRequest} programStartRequest
|
|
8081
|
+
* @param {*} [options] Override http request option.
|
|
8082
|
+
* @throws {RequiredError}
|
|
8083
|
+
*/
|
|
8084
|
+
startProgram(cell: string, program: string, programStartRequest: ProgramStartRequest, options?: RawAxiosRequestConfig): AxiosPromise<ProgramRun>;
|
|
8085
|
+
/**
|
|
8086
|
+
* Stop a specific program run.
|
|
8087
|
+
* @summary Stop program run
|
|
8088
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8089
|
+
* @param {string} program
|
|
8090
|
+
* @param {*} [options] Override http request option.
|
|
8091
|
+
* @throws {RequiredError}
|
|
8092
|
+
*/
|
|
8093
|
+
stopProgram(cell: string, program: string, options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
8094
|
+
};
|
|
8095
|
+
/**
|
|
8096
|
+
* ProgramApi - object-oriented interface
|
|
8097
|
+
* @export
|
|
8098
|
+
* @class ProgramApi
|
|
8099
|
+
* @extends {BaseAPI}
|
|
8100
|
+
*/
|
|
8101
|
+
export declare class ProgramApi extends BaseAPI {
|
|
8102
|
+
/**
|
|
8103
|
+
* Get details of a program.
|
|
8104
|
+
* @summary Get program
|
|
8105
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8106
|
+
* @param {string} program
|
|
8107
|
+
* @param {*} [options] Override http request option.
|
|
8108
|
+
* @throws {RequiredError}
|
|
8109
|
+
* @memberof ProgramApi
|
|
8110
|
+
*/
|
|
8111
|
+
getProgram(cell: string, program: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Program, any>>;
|
|
8112
|
+
/**
|
|
8113
|
+
* List details of all existing programs.
|
|
8114
|
+
* @summary List programs
|
|
8115
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8116
|
+
* @param {*} [options] Override http request option.
|
|
8117
|
+
* @throws {RequiredError}
|
|
8118
|
+
* @memberof ProgramApi
|
|
8119
|
+
*/
|
|
8120
|
+
listPrograms(cell: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Program[], any>>;
|
|
8121
|
+
/**
|
|
8122
|
+
* This endpoint starts a new program execution. The program will be executed asynchronously.
|
|
8123
|
+
* @summary Start the program
|
|
8124
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8125
|
+
* @param {string} program
|
|
8126
|
+
* @param {ProgramStartRequest} programStartRequest
|
|
8127
|
+
* @param {*} [options] Override http request option.
|
|
8128
|
+
* @throws {RequiredError}
|
|
8129
|
+
* @memberof ProgramApi
|
|
8130
|
+
*/
|
|
8131
|
+
startProgram(cell: string, program: string, programStartRequest: ProgramStartRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ProgramRun, any>>;
|
|
8132
|
+
/**
|
|
8133
|
+
* Stop a specific program run.
|
|
8134
|
+
* @summary Stop program run
|
|
8135
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8136
|
+
* @param {string} program
|
|
8137
|
+
* @param {*} [options] Override http request option.
|
|
8138
|
+
* @throws {RequiredError}
|
|
8139
|
+
* @memberof ProgramApi
|
|
8140
|
+
*/
|
|
8141
|
+
stopProgram(cell: string, program: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
8142
|
+
}
|
|
7716
8143
|
/**
|
|
7717
8144
|
* StoreCollisionComponentsApi - axios parameter creator
|
|
7718
8145
|
* @export
|