@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.ts
CHANGED
|
@@ -373,7 +373,7 @@ export const BoxBoxTypeEnum = {
|
|
|
373
373
|
export type BoxBoxTypeEnum = typeof BoxBoxTypeEnum[keyof typeof BoxBoxTypeEnum];
|
|
374
374
|
|
|
375
375
|
/**
|
|
376
|
-
* PROFINET BUS
|
|
376
|
+
* PROFINET BUS inputs/outputs service configuration.
|
|
377
377
|
* @export
|
|
378
378
|
* @interface BusIOProfinet
|
|
379
379
|
*/
|
|
@@ -385,19 +385,19 @@ export interface BusIOProfinet {
|
|
|
385
385
|
*/
|
|
386
386
|
'bus_type'?: BusIOProfinetBusTypeEnum;
|
|
387
387
|
/**
|
|
388
|
-
*
|
|
388
|
+
* 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.
|
|
389
389
|
* @type {string}
|
|
390
390
|
* @memberof BusIOProfinet
|
|
391
391
|
*/
|
|
392
392
|
'config_file_content'?: string;
|
|
393
393
|
/**
|
|
394
|
-
*
|
|
394
|
+
* Used to enable IP communication through the same physical interface while PN Driver is running.
|
|
395
395
|
* @type {BusIOProfinetNetwork}
|
|
396
396
|
* @memberof BusIOProfinet
|
|
397
397
|
*/
|
|
398
398
|
'network_config'?: BusIOProfinetNetwork;
|
|
399
399
|
/**
|
|
400
|
-
* MAC address
|
|
400
|
+
* MAC address of the physical ethernet interface that you want to use for PROFINET communication.
|
|
401
401
|
* @type {string}
|
|
402
402
|
* @memberof BusIOProfinet
|
|
403
403
|
*/
|
|
@@ -417,7 +417,7 @@ export const BusIOProfinetBusTypeEnum = {
|
|
|
417
417
|
export type BusIOProfinetBusTypeEnum = typeof BusIOProfinetBusTypeEnum[keyof typeof BusIOProfinetBusTypeEnum];
|
|
418
418
|
|
|
419
419
|
/**
|
|
420
|
-
*
|
|
420
|
+
* 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.
|
|
421
421
|
* @export
|
|
422
422
|
* @interface BusIOProfinetDefaultRoute
|
|
423
423
|
*/
|
|
@@ -436,25 +436,25 @@ export interface BusIOProfinetDefaultRoute {
|
|
|
436
436
|
'interface': string;
|
|
437
437
|
}
|
|
438
438
|
/**
|
|
439
|
-
* Network configuration
|
|
439
|
+
* 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.
|
|
440
440
|
* @export
|
|
441
441
|
* @interface BusIOProfinetIpConfig
|
|
442
442
|
*/
|
|
443
443
|
export interface BusIOProfinetIpConfig {
|
|
444
444
|
/**
|
|
445
|
-
* IP address for the
|
|
445
|
+
* IP address for the device\'s virtual ethernet interface (pnio1).
|
|
446
446
|
* @type {string}
|
|
447
447
|
* @memberof BusIOProfinetIpConfig
|
|
448
448
|
*/
|
|
449
449
|
'ip': string;
|
|
450
450
|
/**
|
|
451
|
-
* Network mask for the
|
|
451
|
+
* Network mask for the device\'s virtual ethernet interface (pnio1).
|
|
452
452
|
* @type {string}
|
|
453
453
|
* @memberof BusIOProfinetIpConfig
|
|
454
454
|
*/
|
|
455
455
|
'netmask': string;
|
|
456
456
|
/**
|
|
457
|
-
* Gateway for the
|
|
457
|
+
* Gateway for connections to other devices outside of the virtual ethernet interface\'s subnet.
|
|
458
458
|
* @type {string}
|
|
459
459
|
* @memberof BusIOProfinetIpConfig
|
|
460
460
|
*/
|
|
@@ -467,7 +467,7 @@ export interface BusIOProfinetIpConfig {
|
|
|
467
467
|
*/
|
|
468
468
|
export interface BusIOProfinetNetwork {
|
|
469
469
|
/**
|
|
470
|
-
* Name of the PROFINET device.
|
|
470
|
+
* 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.
|
|
471
471
|
* @type {string}
|
|
472
472
|
* @memberof BusIOProfinetNetwork
|
|
473
473
|
*/
|
|
@@ -479,14 +479,14 @@ export interface BusIOProfinetNetwork {
|
|
|
479
479
|
*/
|
|
480
480
|
'ip_config'?: BusIOProfinetIpConfig;
|
|
481
481
|
/**
|
|
482
|
-
* Content of the PROFINET REMA XML file.
|
|
482
|
+
* 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.
|
|
483
483
|
* @type {string}
|
|
484
484
|
* @memberof BusIOProfinetNetwork
|
|
485
485
|
*/
|
|
486
486
|
'rema_xml_content'?: string;
|
|
487
487
|
}
|
|
488
488
|
/**
|
|
489
|
-
* Virtual PROFINET BUS
|
|
489
|
+
* Virtual PROFINET BUS inputs/outputs service configuration.
|
|
490
490
|
* @export
|
|
491
491
|
* @interface BusIOProfinetVirtual
|
|
492
492
|
*/
|
|
@@ -500,7 +500,7 @@ export interface BusIOProfinetVirtual {
|
|
|
500
500
|
}
|
|
501
501
|
|
|
502
502
|
export const BusIOProfinetVirtualBusTypeEnum = {
|
|
503
|
-
|
|
503
|
+
ProfinetVirtual: 'profinet_virtual'
|
|
504
504
|
} as const;
|
|
505
505
|
|
|
506
506
|
export type BusIOProfinetVirtualBusTypeEnum = typeof BusIOProfinetVirtualBusTypeEnum[keyof typeof BusIOProfinetVirtualBusTypeEnum];
|
|
@@ -524,7 +524,7 @@ export interface BusIOsState {
|
|
|
524
524
|
*/
|
|
525
525
|
'state': BusIOsStateEnum;
|
|
526
526
|
/**
|
|
527
|
-
* 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.
|
|
527
|
+
* 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.
|
|
528
528
|
* @type {string}
|
|
529
529
|
* @memberof BusIOsState
|
|
530
530
|
*/
|
|
@@ -1782,9 +1782,22 @@ export interface GetTrajectoryResponse {
|
|
|
1782
1782
|
export interface HTTPValidationError {
|
|
1783
1783
|
/**
|
|
1784
1784
|
*
|
|
1785
|
-
* @type {Array<
|
|
1785
|
+
* @type {Array<ValidationError2>}
|
|
1786
1786
|
* @memberof HTTPValidationError
|
|
1787
1787
|
*/
|
|
1788
|
+
'detail'?: Array<ValidationError2>;
|
|
1789
|
+
}
|
|
1790
|
+
/**
|
|
1791
|
+
*
|
|
1792
|
+
* @export
|
|
1793
|
+
* @interface HTTPValidationError2
|
|
1794
|
+
*/
|
|
1795
|
+
export interface HTTPValidationError2 {
|
|
1796
|
+
/**
|
|
1797
|
+
*
|
|
1798
|
+
* @type {Array<ValidationError>}
|
|
1799
|
+
* @memberof HTTPValidationError2
|
|
1800
|
+
*/
|
|
1788
1801
|
'detail'?: Array<ValidationError>;
|
|
1789
1802
|
}
|
|
1790
1803
|
/**
|
|
@@ -1876,6 +1889,57 @@ export interface IODescription {
|
|
|
1876
1889
|
}
|
|
1877
1890
|
|
|
1878
1891
|
|
|
1892
|
+
/**
|
|
1893
|
+
*
|
|
1894
|
+
* @export
|
|
1895
|
+
* @interface IODescription2
|
|
1896
|
+
*/
|
|
1897
|
+
export interface IODescription2 {
|
|
1898
|
+
/**
|
|
1899
|
+
* Unique identifier of the input/output.
|
|
1900
|
+
* @type {string}
|
|
1901
|
+
* @memberof IODescription2
|
|
1902
|
+
*/
|
|
1903
|
+
'io': string;
|
|
1904
|
+
/**
|
|
1905
|
+
* Descriptive name of the input/output. Customize it using the respective BUS service, e.g. [addProfinetIO](addProfinetIO) for PROFINET service.
|
|
1906
|
+
* @type {string}
|
|
1907
|
+
* @memberof IODescription2
|
|
1908
|
+
*/
|
|
1909
|
+
'name': string;
|
|
1910
|
+
/**
|
|
1911
|
+
*
|
|
1912
|
+
* @type {IODirection}
|
|
1913
|
+
* @memberof IODescription2
|
|
1914
|
+
*/
|
|
1915
|
+
'direction': IODirection;
|
|
1916
|
+
/**
|
|
1917
|
+
*
|
|
1918
|
+
* @type {IOValueType}
|
|
1919
|
+
* @memberof IODescription2
|
|
1920
|
+
*/
|
|
1921
|
+
'value_type': IOValueType;
|
|
1922
|
+
/**
|
|
1923
|
+
*
|
|
1924
|
+
* @type {UnitType}
|
|
1925
|
+
* @memberof IODescription2
|
|
1926
|
+
*/
|
|
1927
|
+
'unit'?: UnitType;
|
|
1928
|
+
/**
|
|
1929
|
+
*
|
|
1930
|
+
* @type {IODescriptionMin}
|
|
1931
|
+
* @memberof IODescription2
|
|
1932
|
+
*/
|
|
1933
|
+
'min'?: IODescriptionMin;
|
|
1934
|
+
/**
|
|
1935
|
+
*
|
|
1936
|
+
* @type {IODescriptionMin}
|
|
1937
|
+
* @memberof IODescription2
|
|
1938
|
+
*/
|
|
1939
|
+
'max'?: IODescriptionMin;
|
|
1940
|
+
}
|
|
1941
|
+
|
|
1942
|
+
|
|
1879
1943
|
/**
|
|
1880
1944
|
* @type IODescriptionMin
|
|
1881
1945
|
* @export
|
|
@@ -2404,10 +2468,10 @@ export type JoggingDetailsKindEnum = typeof JoggingDetailsKindEnum[keyof typeof
|
|
|
2404
2468
|
* @type JoggingDetailsState
|
|
2405
2469
|
* @export
|
|
2406
2470
|
*/
|
|
2407
|
-
export type JoggingDetailsState = JoggingPausedByUser | JoggingPausedNearCollision | JoggingPausedNearJointLimit | JoggingPausedOnIO | JoggingRunning;
|
|
2471
|
+
export type JoggingDetailsState = { kind: 'PAUSED_BY_USER' } & JoggingPausedByUser | { kind: 'PAUSED_NEAR_COLLISION' } & JoggingPausedNearCollision | { kind: 'PAUSED_NEAR_JOINT_LIMIT' } & JoggingPausedNearJointLimit | { kind: 'PAUSED_ON_IO' } & JoggingPausedOnIO | { kind: 'RUNNING' } & JoggingRunning;
|
|
2408
2472
|
|
|
2409
2473
|
/**
|
|
2410
|
-
*
|
|
2474
|
+
* User has paused jogging.
|
|
2411
2475
|
* @export
|
|
2412
2476
|
* @interface JoggingPausedByUser
|
|
2413
2477
|
*/
|
|
@@ -2427,7 +2491,7 @@ export const JoggingPausedByUserKindEnum = {
|
|
|
2427
2491
|
export type JoggingPausedByUserKindEnum = typeof JoggingPausedByUserKindEnum[keyof typeof JoggingPausedByUserKindEnum];
|
|
2428
2492
|
|
|
2429
2493
|
/**
|
|
2430
|
-
*
|
|
2494
|
+
* Jogging was paused because the motion group neared a collision.
|
|
2431
2495
|
* @export
|
|
2432
2496
|
* @interface JoggingPausedNearCollision
|
|
2433
2497
|
*/
|
|
@@ -2453,7 +2517,7 @@ export const JoggingPausedNearCollisionKindEnum = {
|
|
|
2453
2517
|
export type JoggingPausedNearCollisionKindEnum = typeof JoggingPausedNearCollisionKindEnum[keyof typeof JoggingPausedNearCollisionKindEnum];
|
|
2454
2518
|
|
|
2455
2519
|
/**
|
|
2456
|
-
*
|
|
2520
|
+
* Jogging was paused because a joint is near its limit.
|
|
2457
2521
|
* @export
|
|
2458
2522
|
* @interface JoggingPausedNearJointLimit
|
|
2459
2523
|
*/
|
|
@@ -2479,7 +2543,7 @@ export const JoggingPausedNearJointLimitKindEnum = {
|
|
|
2479
2543
|
export type JoggingPausedNearJointLimitKindEnum = typeof JoggingPausedNearJointLimitKindEnum[keyof typeof JoggingPausedNearJointLimitKindEnum];
|
|
2480
2544
|
|
|
2481
2545
|
/**
|
|
2482
|
-
*
|
|
2546
|
+
* Jogging was paused because of an I/O event.
|
|
2483
2547
|
* @export
|
|
2484
2548
|
* @interface JoggingPausedOnIO
|
|
2485
2549
|
*/
|
|
@@ -2499,7 +2563,7 @@ export const JoggingPausedOnIOKindEnum = {
|
|
|
2499
2563
|
export type JoggingPausedOnIOKindEnum = typeof JoggingPausedOnIOKindEnum[keyof typeof JoggingPausedOnIOKindEnum];
|
|
2500
2564
|
|
|
2501
2565
|
/**
|
|
2502
|
-
*
|
|
2566
|
+
* Jogging is active.
|
|
2503
2567
|
* @export
|
|
2504
2568
|
* @interface JoggingRunning
|
|
2505
2569
|
*/
|
|
@@ -2869,6 +2933,12 @@ export interface LimitSet {
|
|
|
2869
2933
|
* @memberof LimitSet
|
|
2870
2934
|
*/
|
|
2871
2935
|
'flange'?: CartesianLimits;
|
|
2936
|
+
/**
|
|
2937
|
+
*
|
|
2938
|
+
* @type {JointLimits}
|
|
2939
|
+
* @memberof LimitSet
|
|
2940
|
+
*/
|
|
2941
|
+
'coupled_shoulder_elbow_joint'?: JointLimits;
|
|
2872
2942
|
}
|
|
2873
2943
|
/**
|
|
2874
2944
|
* If a limit is not set, the default value will be used.
|
|
@@ -4071,17 +4141,17 @@ export interface ProfinetDescription {
|
|
|
4071
4141
|
*/
|
|
4072
4142
|
'slots'?: Array<ProfinetSlotDescription>;
|
|
4073
4143
|
/**
|
|
4074
|
-
* Name of the PROFINET device
|
|
4144
|
+
* 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.
|
|
4075
4145
|
* @type {string}
|
|
4076
4146
|
* @memberof ProfinetDescription
|
|
4077
4147
|
*/
|
|
4078
4148
|
'device_name'?: string;
|
|
4079
4149
|
/**
|
|
4080
|
-
*
|
|
4081
|
-
* @type {
|
|
4150
|
+
*
|
|
4151
|
+
* @type {BusIOProfinetIpConfig}
|
|
4082
4152
|
* @memberof ProfinetDescription
|
|
4083
4153
|
*/
|
|
4084
|
-
'
|
|
4154
|
+
'ip_config'?: BusIOProfinetIpConfig;
|
|
4085
4155
|
}
|
|
4086
4156
|
/**
|
|
4087
4157
|
*
|
|
@@ -4090,7 +4160,7 @@ export interface ProfinetDescription {
|
|
|
4090
4160
|
*/
|
|
4091
4161
|
export interface ProfinetIO {
|
|
4092
4162
|
/**
|
|
4093
|
-
* The name of the input/output
|
|
4163
|
+
* 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).
|
|
4094
4164
|
* @type {string}
|
|
4095
4165
|
* @memberof ProfinetIO
|
|
4096
4166
|
*/
|
|
@@ -4102,25 +4172,25 @@ export interface ProfinetIO {
|
|
|
4102
4172
|
*/
|
|
4103
4173
|
'type': ProfinetIOTypeEnum;
|
|
4104
4174
|
/**
|
|
4105
|
-
* The direction of the input/output
|
|
4175
|
+
* 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.
|
|
4106
4176
|
* @type {ProfinetIODirection}
|
|
4107
4177
|
* @memberof ProfinetIO
|
|
4108
4178
|
*/
|
|
4109
4179
|
'direction': ProfinetIODirection;
|
|
4110
4180
|
/**
|
|
4111
|
-
* The byte address of the input/output
|
|
4181
|
+
* 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.
|
|
4112
4182
|
* @type {number}
|
|
4113
4183
|
* @memberof ProfinetIO
|
|
4114
4184
|
*/
|
|
4115
4185
|
'byte_address': number;
|
|
4116
4186
|
/**
|
|
4117
|
-
* The bit address of the input/output
|
|
4187
|
+
* 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.
|
|
4118
4188
|
* @type {number}
|
|
4119
4189
|
* @memberof ProfinetIO
|
|
4120
4190
|
*/
|
|
4121
4191
|
'bit_address'?: number;
|
|
4122
4192
|
/**
|
|
4123
|
-
* The unique identifier for the input/output value. This identifier is used to reference the specific input/output in the NOVA
|
|
4193
|
+
* 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.
|
|
4124
4194
|
* @type {string}
|
|
4125
4195
|
* @memberof ProfinetIO
|
|
4126
4196
|
*/
|
|
@@ -4135,7 +4205,7 @@ export interface ProfinetIO {
|
|
|
4135
4205
|
*/
|
|
4136
4206
|
export interface ProfinetIOData {
|
|
4137
4207
|
/**
|
|
4138
|
-
* The name of the input/output
|
|
4208
|
+
* 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).
|
|
4139
4209
|
* @type {string}
|
|
4140
4210
|
* @memberof ProfinetIOData
|
|
4141
4211
|
*/
|
|
@@ -4147,19 +4217,19 @@ export interface ProfinetIOData {
|
|
|
4147
4217
|
*/
|
|
4148
4218
|
'type': ProfinetIOTypeEnum;
|
|
4149
4219
|
/**
|
|
4150
|
-
* The direction of the input/output
|
|
4220
|
+
* 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.
|
|
4151
4221
|
* @type {ProfinetIODirection}
|
|
4152
4222
|
* @memberof ProfinetIOData
|
|
4153
4223
|
*/
|
|
4154
4224
|
'direction': ProfinetIODirection;
|
|
4155
4225
|
/**
|
|
4156
|
-
* The byte address of the input/output
|
|
4226
|
+
* 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.
|
|
4157
4227
|
* @type {number}
|
|
4158
4228
|
* @memberof ProfinetIOData
|
|
4159
4229
|
*/
|
|
4160
4230
|
'byte_address': number;
|
|
4161
4231
|
/**
|
|
4162
|
-
* The bit address of the input/output
|
|
4232
|
+
* 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.
|
|
4163
4233
|
* @type {number}
|
|
4164
4234
|
* @memberof ProfinetIOData
|
|
4165
4235
|
*/
|
|
@@ -4168,7 +4238,7 @@ export interface ProfinetIOData {
|
|
|
4168
4238
|
|
|
4169
4239
|
|
|
4170
4240
|
/**
|
|
4171
|
-
*
|
|
4241
|
+
* 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.
|
|
4172
4242
|
* @export
|
|
4173
4243
|
* @enum {string}
|
|
4174
4244
|
*/
|
|
@@ -4183,7 +4253,7 @@ export type ProfinetIODirection = typeof ProfinetIODirection[keyof typeof Profin
|
|
|
4183
4253
|
|
|
4184
4254
|
|
|
4185
4255
|
/**
|
|
4186
|
-
* Value type of the PROFINET input/output.
|
|
4256
|
+
* Value type of the PROFINET input/output variable. Is used to interpret the corresponding bits correctly.
|
|
4187
4257
|
* @export
|
|
4188
4258
|
* @enum {string}
|
|
4189
4259
|
*/
|
|
@@ -4211,38 +4281,38 @@ export type ProfinetIOTypeEnum = typeof ProfinetIOTypeEnum[keyof typeof Profinet
|
|
|
4211
4281
|
*/
|
|
4212
4282
|
export interface ProfinetInputOutputConfig {
|
|
4213
4283
|
/**
|
|
4214
|
-
* Content of the input
|
|
4284
|
+
* 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.
|
|
4215
4285
|
* @type {string}
|
|
4216
4286
|
* @memberof ProfinetInputOutputConfig
|
|
4217
4287
|
*/
|
|
4218
4288
|
'config': string;
|
|
4219
4289
|
/**
|
|
4220
|
-
* Offset in bytes for the input
|
|
4290
|
+
* 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.
|
|
4221
4291
|
* @type {number}
|
|
4222
4292
|
* @memberof ProfinetInputOutputConfig
|
|
4223
4293
|
*/
|
|
4224
4294
|
'input_offset': number;
|
|
4225
4295
|
/**
|
|
4226
|
-
* Offset in bytes for the output
|
|
4296
|
+
* 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.
|
|
4227
4297
|
* @type {number}
|
|
4228
4298
|
* @memberof ProfinetInputOutputConfig
|
|
4229
4299
|
*/
|
|
4230
4300
|
'output_offset': number;
|
|
4231
4301
|
}
|
|
4232
4302
|
/**
|
|
4233
|
-
*
|
|
4303
|
+
* 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).
|
|
4234
4304
|
* @export
|
|
4235
4305
|
* @interface ProfinetSlotDescription
|
|
4236
4306
|
*/
|
|
4237
4307
|
export interface ProfinetSlotDescription {
|
|
4238
4308
|
/**
|
|
4239
|
-
* The number of the PROFINET slot.
|
|
4309
|
+
* 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.
|
|
4240
4310
|
* @type {number}
|
|
4241
4311
|
* @memberof ProfinetSlotDescription
|
|
4242
4312
|
*/
|
|
4243
4313
|
'number': number;
|
|
4244
4314
|
/**
|
|
4245
|
-
* The API number of the PROFINET input
|
|
4315
|
+
* The application process identifier (API) number of the PROFINET input. The API identifies the application relation (AR) that is using the slot.
|
|
4246
4316
|
* @type {number}
|
|
4247
4317
|
* @memberof ProfinetSlotDescription
|
|
4248
4318
|
*/
|
|
@@ -4261,24 +4331,172 @@ export interface ProfinetSlotDescription {
|
|
|
4261
4331
|
*/
|
|
4262
4332
|
export interface ProfinetSubSlotDescription {
|
|
4263
4333
|
/**
|
|
4264
|
-
* The
|
|
4334
|
+
* The number/index of the PROFINET subslot.
|
|
4265
4335
|
* @type {number}
|
|
4266
4336
|
* @memberof ProfinetSubSlotDescription
|
|
4267
4337
|
*/
|
|
4268
4338
|
'number': number;
|
|
4269
4339
|
/**
|
|
4270
|
-
* The
|
|
4340
|
+
* The amount of bytes allocated for the subslot in the input process image buffer.
|
|
4271
4341
|
* @type {number}
|
|
4272
4342
|
* @memberof ProfinetSubSlotDescription
|
|
4273
4343
|
*/
|
|
4274
4344
|
'input_length': number;
|
|
4275
4345
|
/**
|
|
4276
|
-
* The
|
|
4346
|
+
* The amount of bytes allocated for the subslot in the output process image buffer.
|
|
4277
4347
|
* @type {number}
|
|
4278
4348
|
* @memberof ProfinetSubSlotDescription
|
|
4279
4349
|
*/
|
|
4280
4350
|
'output_length': number;
|
|
4281
4351
|
}
|
|
4352
|
+
/**
|
|
4353
|
+
* A program is a collection of instructions that are executed in the robot cell.
|
|
4354
|
+
* @export
|
|
4355
|
+
* @interface Program
|
|
4356
|
+
*/
|
|
4357
|
+
export interface Program {
|
|
4358
|
+
/**
|
|
4359
|
+
*
|
|
4360
|
+
* @type {string}
|
|
4361
|
+
* @memberof Program
|
|
4362
|
+
*/
|
|
4363
|
+
'program': string;
|
|
4364
|
+
/**
|
|
4365
|
+
*
|
|
4366
|
+
* @type {string}
|
|
4367
|
+
* @memberof Program
|
|
4368
|
+
*/
|
|
4369
|
+
'name'?: string;
|
|
4370
|
+
/**
|
|
4371
|
+
*
|
|
4372
|
+
* @type {string}
|
|
4373
|
+
* @memberof Program
|
|
4374
|
+
*/
|
|
4375
|
+
'description'?: string;
|
|
4376
|
+
/**
|
|
4377
|
+
*
|
|
4378
|
+
* @type {string}
|
|
4379
|
+
* @memberof Program
|
|
4380
|
+
*/
|
|
4381
|
+
'app': string;
|
|
4382
|
+
/**
|
|
4383
|
+
*
|
|
4384
|
+
* @type {object}
|
|
4385
|
+
* @memberof Program
|
|
4386
|
+
*/
|
|
4387
|
+
'input_schema'?: object;
|
|
4388
|
+
/**
|
|
4389
|
+
*
|
|
4390
|
+
* @type {object}
|
|
4391
|
+
* @memberof Program
|
|
4392
|
+
*/
|
|
4393
|
+
'preconditions'?: object;
|
|
4394
|
+
}
|
|
4395
|
+
/**
|
|
4396
|
+
* Holds the state of a program run.
|
|
4397
|
+
* @export
|
|
4398
|
+
* @interface ProgramRun
|
|
4399
|
+
*/
|
|
4400
|
+
export interface ProgramRun {
|
|
4401
|
+
/**
|
|
4402
|
+
* Unique identifier of the program run
|
|
4403
|
+
* @type {string}
|
|
4404
|
+
* @memberof ProgramRun
|
|
4405
|
+
*/
|
|
4406
|
+
'run': string;
|
|
4407
|
+
/**
|
|
4408
|
+
* Unique identifier of the program
|
|
4409
|
+
* @type {string}
|
|
4410
|
+
* @memberof ProgramRun
|
|
4411
|
+
*/
|
|
4412
|
+
'program': string;
|
|
4413
|
+
/**
|
|
4414
|
+
* State of the program run
|
|
4415
|
+
* @type {ProgramRunState}
|
|
4416
|
+
* @memberof ProgramRun
|
|
4417
|
+
*/
|
|
4418
|
+
'state': ProgramRunState;
|
|
4419
|
+
/**
|
|
4420
|
+
* Logs of the program run
|
|
4421
|
+
* @type {string}
|
|
4422
|
+
* @memberof ProgramRun
|
|
4423
|
+
*/
|
|
4424
|
+
'logs'?: string;
|
|
4425
|
+
/**
|
|
4426
|
+
* Stdout of the program run
|
|
4427
|
+
* @type {string}
|
|
4428
|
+
* @memberof ProgramRun
|
|
4429
|
+
*/
|
|
4430
|
+
'stdout'?: string;
|
|
4431
|
+
/**
|
|
4432
|
+
* Stderr of the program run
|
|
4433
|
+
* @type {string}
|
|
4434
|
+
* @memberof ProgramRun
|
|
4435
|
+
*/
|
|
4436
|
+
'stderr'?: string;
|
|
4437
|
+
/**
|
|
4438
|
+
* Error message of the program run, if any
|
|
4439
|
+
* @type {string}
|
|
4440
|
+
* @memberof ProgramRun
|
|
4441
|
+
*/
|
|
4442
|
+
'error'?: string;
|
|
4443
|
+
/**
|
|
4444
|
+
* Traceback of the program run, if any
|
|
4445
|
+
* @type {string}
|
|
4446
|
+
* @memberof ProgramRun
|
|
4447
|
+
*/
|
|
4448
|
+
'traceback'?: string;
|
|
4449
|
+
/**
|
|
4450
|
+
* Start time of the program run
|
|
4451
|
+
* @type {string}
|
|
4452
|
+
* @memberof ProgramRun
|
|
4453
|
+
*/
|
|
4454
|
+
'start_time'?: string;
|
|
4455
|
+
/**
|
|
4456
|
+
* End time of the program run
|
|
4457
|
+
* @type {string}
|
|
4458
|
+
* @memberof ProgramRun
|
|
4459
|
+
*/
|
|
4460
|
+
'end_time'?: string;
|
|
4461
|
+
/**
|
|
4462
|
+
* Input data of the program run
|
|
4463
|
+
* @type {object}
|
|
4464
|
+
* @memberof ProgramRun
|
|
4465
|
+
*/
|
|
4466
|
+
'input_data'?: object;
|
|
4467
|
+
}
|
|
4468
|
+
|
|
4469
|
+
|
|
4470
|
+
/**
|
|
4471
|
+
* The state of a program run.
|
|
4472
|
+
* @export
|
|
4473
|
+
* @enum {string}
|
|
4474
|
+
*/
|
|
4475
|
+
|
|
4476
|
+
export const ProgramRunState = {
|
|
4477
|
+
Preparing: 'PREPARING',
|
|
4478
|
+
Running: 'RUNNING',
|
|
4479
|
+
Completed: 'COMPLETED',
|
|
4480
|
+
Failed: 'FAILED',
|
|
4481
|
+
Stopped: 'STOPPED'
|
|
4482
|
+
} as const;
|
|
4483
|
+
|
|
4484
|
+
export type ProgramRunState = typeof ProgramRunState[keyof typeof ProgramRunState];
|
|
4485
|
+
|
|
4486
|
+
|
|
4487
|
+
/**
|
|
4488
|
+
* The state of a program run.
|
|
4489
|
+
* @export
|
|
4490
|
+
* @interface ProgramStartRequest
|
|
4491
|
+
*/
|
|
4492
|
+
export interface ProgramStartRequest {
|
|
4493
|
+
/**
|
|
4494
|
+
* The arguments to pass to the program.
|
|
4495
|
+
* @type {object}
|
|
4496
|
+
* @memberof ProgramStartRequest
|
|
4497
|
+
*/
|
|
4498
|
+
'arguments': object;
|
|
4499
|
+
}
|
|
4282
4500
|
/**
|
|
4283
4501
|
* <!-- 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.
|
|
4284
4502
|
* @export
|
|
@@ -5105,10 +5323,10 @@ export type TrajectoryDetailsKindEnum = typeof TrajectoryDetailsKindEnum[keyof t
|
|
|
5105
5323
|
* @type TrajectoryDetailsState
|
|
5106
5324
|
* @export
|
|
5107
5325
|
*/
|
|
5108
|
-
export type TrajectoryDetailsState = TrajectoryEnded | TrajectoryPausedByUser | TrajectoryPausedOnIO | TrajectoryRunning | TrajectoryWaitForIO;
|
|
5326
|
+
export type TrajectoryDetailsState = { kind: 'END_OF_TRAJECTORY' } & TrajectoryEnded | { kind: 'PAUSED_BY_USER' } & TrajectoryPausedByUser | { kind: 'PAUSED_ON_IO' } & TrajectoryPausedOnIO | { kind: 'RUNNING' } & TrajectoryRunning | { kind: 'WAIT_FOR_IO' } & TrajectoryWaitForIO;
|
|
5109
5327
|
|
|
5110
5328
|
/**
|
|
5111
|
-
*
|
|
5329
|
+
* First or last sample (depending on direction) of trajectory has been sent.
|
|
5112
5330
|
* @export
|
|
5113
5331
|
* @interface TrajectoryEnded
|
|
5114
5332
|
*/
|
|
@@ -5154,7 +5372,7 @@ export const TrajectoryIdMessageTypeEnum = {
|
|
|
5154
5372
|
export type TrajectoryIdMessageTypeEnum = typeof TrajectoryIdMessageTypeEnum[keyof typeof TrajectoryIdMessageTypeEnum];
|
|
5155
5373
|
|
|
5156
5374
|
/**
|
|
5157
|
-
*
|
|
5375
|
+
* User has paused execution.
|
|
5158
5376
|
* @export
|
|
5159
5377
|
* @interface TrajectoryPausedByUser
|
|
5160
5378
|
*/
|
|
@@ -5174,7 +5392,7 @@ export const TrajectoryPausedByUserKindEnum = {
|
|
|
5174
5392
|
export type TrajectoryPausedByUserKindEnum = typeof TrajectoryPausedByUserKindEnum[keyof typeof TrajectoryPausedByUserKindEnum];
|
|
5175
5393
|
|
|
5176
5394
|
/**
|
|
5177
|
-
*
|
|
5395
|
+
* Execution was paused because of an I/O event.
|
|
5178
5396
|
* @export
|
|
5179
5397
|
* @interface TrajectoryPausedOnIO
|
|
5180
5398
|
*/
|
|
@@ -5194,7 +5412,7 @@ export const TrajectoryPausedOnIOKindEnum = {
|
|
|
5194
5412
|
export type TrajectoryPausedOnIOKindEnum = typeof TrajectoryPausedOnIOKindEnum[keyof typeof TrajectoryPausedOnIOKindEnum];
|
|
5195
5413
|
|
|
5196
5414
|
/**
|
|
5197
|
-
*
|
|
5415
|
+
* Trajectory is being executed.
|
|
5198
5416
|
* @export
|
|
5199
5417
|
* @interface TrajectoryRunning
|
|
5200
5418
|
*/
|
|
@@ -5220,7 +5438,7 @@ export const TrajectoryRunningKindEnum = {
|
|
|
5220
5438
|
export type TrajectoryRunningKindEnum = typeof TrajectoryRunningKindEnum[keyof typeof TrajectoryRunningKindEnum];
|
|
5221
5439
|
|
|
5222
5440
|
/**
|
|
5223
|
-
*
|
|
5441
|
+
* Waiting for an I/O event to start execution.
|
|
5224
5442
|
* @export
|
|
5225
5443
|
* @interface TrajectoryWaitForIO
|
|
5226
5444
|
*/
|
|
@@ -5333,6 +5551,31 @@ export interface ValidationError {
|
|
|
5333
5551
|
*/
|
|
5334
5552
|
'input': { [key: string]: any; };
|
|
5335
5553
|
}
|
|
5554
|
+
/**
|
|
5555
|
+
* A validation error of a program.
|
|
5556
|
+
* @export
|
|
5557
|
+
* @interface ValidationError2
|
|
5558
|
+
*/
|
|
5559
|
+
export interface ValidationError2 {
|
|
5560
|
+
/**
|
|
5561
|
+
*
|
|
5562
|
+
* @type {Array<number>}
|
|
5563
|
+
* @memberof ValidationError2
|
|
5564
|
+
*/
|
|
5565
|
+
'loc': Array<number>;
|
|
5566
|
+
/**
|
|
5567
|
+
*
|
|
5568
|
+
* @type {string}
|
|
5569
|
+
* @memberof ValidationError2
|
|
5570
|
+
*/
|
|
5571
|
+
'msg': string;
|
|
5572
|
+
/**
|
|
5573
|
+
*
|
|
5574
|
+
* @type {string}
|
|
5575
|
+
* @memberof ValidationError2
|
|
5576
|
+
*/
|
|
5577
|
+
'type': string;
|
|
5578
|
+
}
|
|
5336
5579
|
/**
|
|
5337
5580
|
* @type ValidationErrorLocInner
|
|
5338
5581
|
* @export
|
|
@@ -6150,7 +6393,7 @@ export class ApplicationApi extends BaseAPI {
|
|
|
6150
6393
|
export const BUSInputsOutputsApiAxiosParamCreator = function (configuration?: Configuration) {
|
|
6151
6394
|
return {
|
|
6152
6395
|
/**
|
|
6153
|
-
* Add
|
|
6396
|
+
* Add the BUS inputs/outputs service to the cell. Starts a containerized service that enables BUS connections via the specified ethernet port.
|
|
6154
6397
|
* @summary Add Service
|
|
6155
6398
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
6156
6399
|
* @param {BusIOType} busIOType
|
|
@@ -6203,7 +6446,7 @@ export const BUSInputsOutputsApiAxiosParamCreator = function (configuration?: Co
|
|
|
6203
6446
|
};
|
|
6204
6447
|
},
|
|
6205
6448
|
/**
|
|
6206
|
-
* Adds an input/output to or updates an input/output on the PROFINET device.
|
|
6449
|
+
* 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).
|
|
6207
6450
|
* @summary Add PROFINET Input/Output
|
|
6208
6451
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
6209
6452
|
* @param {string} io Unique identifier to address an Input/Output in the cell.
|
|
@@ -6255,7 +6498,7 @@ export const BUSInputsOutputsApiAxiosParamCreator = function (configuration?: Co
|
|
|
6255
6498
|
};
|
|
6256
6499
|
},
|
|
6257
6500
|
/**
|
|
6258
|
-
*
|
|
6501
|
+
* Remove the BUS inputs/outputs service from the cell.
|
|
6259
6502
|
* @summary Clear Service
|
|
6260
6503
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
6261
6504
|
* @param {number} [completionTimeout]
|
|
@@ -6302,7 +6545,7 @@ export const BUSInputsOutputsApiAxiosParamCreator = function (configuration?: Co
|
|
|
6302
6545
|
};
|
|
6303
6546
|
},
|
|
6304
6547
|
/**
|
|
6305
|
-
* Removes
|
|
6548
|
+
* Removes an input/output variable configuration from the PROFINET device, e.g. NOVA\'s PROFINET service.
|
|
6306
6549
|
* @summary Remove PROFINET Input/Ouptut
|
|
6307
6550
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
6308
6551
|
* @param {string} io Unique identifier to address an Input/Output in the cell.
|
|
@@ -6348,7 +6591,7 @@ export const BUSInputsOutputsApiAxiosParamCreator = function (configuration?: Co
|
|
|
6348
6591
|
};
|
|
6349
6592
|
},
|
|
6350
6593
|
/**
|
|
6351
|
-
* Get deployed BUS
|
|
6594
|
+
* Get deployed BUS inputs/outputs service.
|
|
6352
6595
|
* @summary Get Service
|
|
6353
6596
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
6354
6597
|
* @param {*} [options] Override http request option.
|
|
@@ -6479,7 +6722,7 @@ export const BUSInputsOutputsApiAxiosParamCreator = function (configuration?: Co
|
|
|
6479
6722
|
};
|
|
6480
6723
|
},
|
|
6481
6724
|
/**
|
|
6482
|
-
* Get description of PROFINET
|
|
6725
|
+
* Get description of NOVA as a PROFINET device.
|
|
6483
6726
|
* @summary Get PROFINET Description
|
|
6484
6727
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
6485
6728
|
* @param {*} [options] Override http request option.
|
|
@@ -6521,7 +6764,7 @@ export const BUSInputsOutputsApiAxiosParamCreator = function (configuration?: Co
|
|
|
6521
6764
|
};
|
|
6522
6765
|
},
|
|
6523
6766
|
/**
|
|
6524
|
-
* Get input/output configuration of the PROFINET device as file.
|
|
6767
|
+
* 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.
|
|
6525
6768
|
* @summary PROFINET Inputs/Outputs to File
|
|
6526
6769
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
6527
6770
|
* @param {number} [inputOffset]
|
|
@@ -6573,7 +6816,7 @@ export const BUSInputsOutputsApiAxiosParamCreator = function (configuration?: Co
|
|
|
6573
6816
|
};
|
|
6574
6817
|
},
|
|
6575
6818
|
/**
|
|
6576
|
-
* List all BUS
|
|
6819
|
+
* 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.
|
|
6577
6820
|
* @summary List Descriptions
|
|
6578
6821
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
6579
6822
|
* @param {*} [options] Override http request option.
|
|
@@ -6615,7 +6858,7 @@ export const BUSInputsOutputsApiAxiosParamCreator = function (configuration?: Co
|
|
|
6615
6858
|
};
|
|
6616
6859
|
},
|
|
6617
6860
|
/**
|
|
6618
|
-
* List all PROFINET input and
|
|
6861
|
+
* 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.
|
|
6619
6862
|
* @summary List PROFINET Input/Output Configuration
|
|
6620
6863
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
6621
6864
|
* @param {*} [options] Override http request option.
|
|
@@ -6705,7 +6948,7 @@ export const BUSInputsOutputsApiAxiosParamCreator = function (configuration?: Co
|
|
|
6705
6948
|
};
|
|
6706
6949
|
},
|
|
6707
6950
|
/**
|
|
6708
|
-
* Sets
|
|
6951
|
+
* 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.
|
|
6709
6952
|
* @summary Set PROFINET Inputs/Outputs from File
|
|
6710
6953
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
6711
6954
|
* @param {ProfinetInputOutputConfig} profinetInputOutputConfig
|
|
@@ -6763,7 +7006,7 @@ export const BUSInputsOutputsApiFp = function(configuration?: Configuration) {
|
|
|
6763
7006
|
const localVarAxiosParamCreator = BUSInputsOutputsApiAxiosParamCreator(configuration)
|
|
6764
7007
|
return {
|
|
6765
7008
|
/**
|
|
6766
|
-
* Add
|
|
7009
|
+
* Add the BUS inputs/outputs service to the cell. Starts a containerized service that enables BUS connections via the specified ethernet port.
|
|
6767
7010
|
* @summary Add Service
|
|
6768
7011
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
6769
7012
|
* @param {BusIOType} busIOType
|
|
@@ -6778,7 +7021,7 @@ export const BUSInputsOutputsApiFp = function(configuration?: Configuration) {
|
|
|
6778
7021
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
6779
7022
|
},
|
|
6780
7023
|
/**
|
|
6781
|
-
* Adds an input/output to or updates an input/output on the PROFINET device.
|
|
7024
|
+
* 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).
|
|
6782
7025
|
* @summary Add PROFINET Input/Output
|
|
6783
7026
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
6784
7027
|
* @param {string} io Unique identifier to address an Input/Output in the cell.
|
|
@@ -6793,7 +7036,7 @@ export const BUSInputsOutputsApiFp = function(configuration?: Configuration) {
|
|
|
6793
7036
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
6794
7037
|
},
|
|
6795
7038
|
/**
|
|
6796
|
-
*
|
|
7039
|
+
* Remove the BUS inputs/outputs service from the cell.
|
|
6797
7040
|
* @summary Clear Service
|
|
6798
7041
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
6799
7042
|
* @param {number} [completionTimeout]
|
|
@@ -6807,7 +7050,7 @@ export const BUSInputsOutputsApiFp = function(configuration?: Configuration) {
|
|
|
6807
7050
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
6808
7051
|
},
|
|
6809
7052
|
/**
|
|
6810
|
-
* Removes
|
|
7053
|
+
* Removes an input/output variable configuration from the PROFINET device, e.g. NOVA\'s PROFINET service.
|
|
6811
7054
|
* @summary Remove PROFINET Input/Ouptut
|
|
6812
7055
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
6813
7056
|
* @param {string} io Unique identifier to address an Input/Output in the cell.
|
|
@@ -6821,7 +7064,7 @@ export const BUSInputsOutputsApiFp = function(configuration?: Configuration) {
|
|
|
6821
7064
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
6822
7065
|
},
|
|
6823
7066
|
/**
|
|
6824
|
-
* Get deployed BUS
|
|
7067
|
+
* Get deployed BUS inputs/outputs service.
|
|
6825
7068
|
* @summary Get Service
|
|
6826
7069
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
6827
7070
|
* @param {*} [options] Override http request option.
|
|
@@ -6861,7 +7104,7 @@ export const BUSInputsOutputsApiFp = function(configuration?: Configuration) {
|
|
|
6861
7104
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
6862
7105
|
},
|
|
6863
7106
|
/**
|
|
6864
|
-
* Get description of PROFINET
|
|
7107
|
+
* Get description of NOVA as a PROFINET device.
|
|
6865
7108
|
* @summary Get PROFINET Description
|
|
6866
7109
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
6867
7110
|
* @param {*} [options] Override http request option.
|
|
@@ -6874,7 +7117,7 @@ export const BUSInputsOutputsApiFp = function(configuration?: Configuration) {
|
|
|
6874
7117
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
6875
7118
|
},
|
|
6876
7119
|
/**
|
|
6877
|
-
* Get input/output configuration of the PROFINET device as file.
|
|
7120
|
+
* 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.
|
|
6878
7121
|
* @summary PROFINET Inputs/Outputs to File
|
|
6879
7122
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
6880
7123
|
* @param {number} [inputOffset]
|
|
@@ -6889,20 +7132,20 @@ export const BUSInputsOutputsApiFp = function(configuration?: Configuration) {
|
|
|
6889
7132
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
6890
7133
|
},
|
|
6891
7134
|
/**
|
|
6892
|
-
* List all BUS
|
|
7135
|
+
* 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.
|
|
6893
7136
|
* @summary List Descriptions
|
|
6894
7137
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
6895
7138
|
* @param {*} [options] Override http request option.
|
|
6896
7139
|
* @throws {RequiredError}
|
|
6897
7140
|
*/
|
|
6898
|
-
async listBusIODescriptions(cell: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<
|
|
7141
|
+
async listBusIODescriptions(cell: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<IODescription2>>> {
|
|
6899
7142
|
const localVarAxiosArgs = await localVarAxiosParamCreator.listBusIODescriptions(cell, options);
|
|
6900
7143
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
6901
7144
|
const localVarOperationServerBasePath = operationServerMap['BUSInputsOutputsApi.listBusIODescriptions']?.[localVarOperationServerIndex]?.url;
|
|
6902
7145
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
6903
7146
|
},
|
|
6904
7147
|
/**
|
|
6905
|
-
* List all PROFINET input and
|
|
7148
|
+
* 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.
|
|
6906
7149
|
* @summary List PROFINET Input/Output Configuration
|
|
6907
7150
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
6908
7151
|
* @param {*} [options] Override http request option.
|
|
@@ -6929,7 +7172,7 @@ export const BUSInputsOutputsApiFp = function(configuration?: Configuration) {
|
|
|
6929
7172
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
6930
7173
|
},
|
|
6931
7174
|
/**
|
|
6932
|
-
* Sets
|
|
7175
|
+
* 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.
|
|
6933
7176
|
* @summary Set PROFINET Inputs/Outputs from File
|
|
6934
7177
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
6935
7178
|
* @param {ProfinetInputOutputConfig} profinetInputOutputConfig
|
|
@@ -6953,7 +7196,7 @@ export const BUSInputsOutputsApiFactory = function (configuration?: Configuratio
|
|
|
6953
7196
|
const localVarFp = BUSInputsOutputsApiFp(configuration)
|
|
6954
7197
|
return {
|
|
6955
7198
|
/**
|
|
6956
|
-
* Add
|
|
7199
|
+
* Add the BUS inputs/outputs service to the cell. Starts a containerized service that enables BUS connections via the specified ethernet port.
|
|
6957
7200
|
* @summary Add Service
|
|
6958
7201
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
6959
7202
|
* @param {BusIOType} busIOType
|
|
@@ -6965,7 +7208,7 @@ export const BUSInputsOutputsApiFactory = function (configuration?: Configuratio
|
|
|
6965
7208
|
return localVarFp.addBusIOService(cell, busIOType, completionTimeout, options).then((request) => request(axios, basePath));
|
|
6966
7209
|
},
|
|
6967
7210
|
/**
|
|
6968
|
-
* Adds an input/output to or updates an input/output on the PROFINET device.
|
|
7211
|
+
* 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).
|
|
6969
7212
|
* @summary Add PROFINET Input/Output
|
|
6970
7213
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
6971
7214
|
* @param {string} io Unique identifier to address an Input/Output in the cell.
|
|
@@ -6977,7 +7220,7 @@ export const BUSInputsOutputsApiFactory = function (configuration?: Configuratio
|
|
|
6977
7220
|
return localVarFp.addProfinetIO(cell, io, profinetIOData, options).then((request) => request(axios, basePath));
|
|
6978
7221
|
},
|
|
6979
7222
|
/**
|
|
6980
|
-
*
|
|
7223
|
+
* Remove the BUS inputs/outputs service from the cell.
|
|
6981
7224
|
* @summary Clear Service
|
|
6982
7225
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
6983
7226
|
* @param {number} [completionTimeout]
|
|
@@ -6988,7 +7231,7 @@ export const BUSInputsOutputsApiFactory = function (configuration?: Configuratio
|
|
|
6988
7231
|
return localVarFp.clearBusIOService(cell, completionTimeout, options).then((request) => request(axios, basePath));
|
|
6989
7232
|
},
|
|
6990
7233
|
/**
|
|
6991
|
-
* Removes
|
|
7234
|
+
* Removes an input/output variable configuration from the PROFINET device, e.g. NOVA\'s PROFINET service.
|
|
6992
7235
|
* @summary Remove PROFINET Input/Ouptut
|
|
6993
7236
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
6994
7237
|
* @param {string} io Unique identifier to address an Input/Output in the cell.
|
|
@@ -6999,7 +7242,7 @@ export const BUSInputsOutputsApiFactory = function (configuration?: Configuratio
|
|
|
6999
7242
|
return localVarFp.deleteProfinetIO(cell, io, options).then((request) => request(axios, basePath));
|
|
7000
7243
|
},
|
|
7001
7244
|
/**
|
|
7002
|
-
* Get deployed BUS
|
|
7245
|
+
* Get deployed BUS inputs/outputs service.
|
|
7003
7246
|
* @summary Get Service
|
|
7004
7247
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
7005
7248
|
* @param {*} [options] Override http request option.
|
|
@@ -7030,7 +7273,7 @@ export const BUSInputsOutputsApiFactory = function (configuration?: Configuratio
|
|
|
7030
7273
|
return localVarFp.getBusIOValues(cell, ios, options).then((request) => request(axios, basePath));
|
|
7031
7274
|
},
|
|
7032
7275
|
/**
|
|
7033
|
-
* Get description of PROFINET
|
|
7276
|
+
* Get description of NOVA as a PROFINET device.
|
|
7034
7277
|
* @summary Get PROFINET Description
|
|
7035
7278
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
7036
7279
|
* @param {*} [options] Override http request option.
|
|
@@ -7040,7 +7283,7 @@ export const BUSInputsOutputsApiFactory = function (configuration?: Configuratio
|
|
|
7040
7283
|
return localVarFp.getProfinetDescription(cell, options).then((request) => request(axios, basePath));
|
|
7041
7284
|
},
|
|
7042
7285
|
/**
|
|
7043
|
-
* Get input/output configuration of the PROFINET device as file.
|
|
7286
|
+
* 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.
|
|
7044
7287
|
* @summary PROFINET Inputs/Outputs to File
|
|
7045
7288
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
7046
7289
|
* @param {number} [inputOffset]
|
|
@@ -7052,17 +7295,17 @@ export const BUSInputsOutputsApiFactory = function (configuration?: Configuratio
|
|
|
7052
7295
|
return localVarFp.getProfinetIOsFromFile(cell, inputOffset, outputOffset, options).then((request) => request(axios, basePath));
|
|
7053
7296
|
},
|
|
7054
7297
|
/**
|
|
7055
|
-
* List all BUS
|
|
7298
|
+
* 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.
|
|
7056
7299
|
* @summary List Descriptions
|
|
7057
7300
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
7058
7301
|
* @param {*} [options] Override http request option.
|
|
7059
7302
|
* @throws {RequiredError}
|
|
7060
7303
|
*/
|
|
7061
|
-
listBusIODescriptions(cell: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<
|
|
7304
|
+
listBusIODescriptions(cell: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<IODescription2>> {
|
|
7062
7305
|
return localVarFp.listBusIODescriptions(cell, options).then((request) => request(axios, basePath));
|
|
7063
7306
|
},
|
|
7064
7307
|
/**
|
|
7065
|
-
* List all PROFINET input and
|
|
7308
|
+
* 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.
|
|
7066
7309
|
* @summary List PROFINET Input/Output Configuration
|
|
7067
7310
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
7068
7311
|
* @param {*} [options] Override http request option.
|
|
@@ -7083,7 +7326,7 @@ export const BUSInputsOutputsApiFactory = function (configuration?: Configuratio
|
|
|
7083
7326
|
return localVarFp.setBusIOValues(cell, iOValue, options).then((request) => request(axios, basePath));
|
|
7084
7327
|
},
|
|
7085
7328
|
/**
|
|
7086
|
-
* Sets
|
|
7329
|
+
* 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.
|
|
7087
7330
|
* @summary Set PROFINET Inputs/Outputs from File
|
|
7088
7331
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
7089
7332
|
* @param {ProfinetInputOutputConfig} profinetInputOutputConfig
|
|
@@ -7104,7 +7347,7 @@ export const BUSInputsOutputsApiFactory = function (configuration?: Configuratio
|
|
|
7104
7347
|
*/
|
|
7105
7348
|
export class BUSInputsOutputsApi extends BaseAPI {
|
|
7106
7349
|
/**
|
|
7107
|
-
* Add
|
|
7350
|
+
* Add the BUS inputs/outputs service to the cell. Starts a containerized service that enables BUS connections via the specified ethernet port.
|
|
7108
7351
|
* @summary Add Service
|
|
7109
7352
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
7110
7353
|
* @param {BusIOType} busIOType
|
|
@@ -7118,7 +7361,7 @@ export class BUSInputsOutputsApi extends BaseAPI {
|
|
|
7118
7361
|
}
|
|
7119
7362
|
|
|
7120
7363
|
/**
|
|
7121
|
-
* Adds an input/output to or updates an input/output on the PROFINET device.
|
|
7364
|
+
* 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).
|
|
7122
7365
|
* @summary Add PROFINET Input/Output
|
|
7123
7366
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
7124
7367
|
* @param {string} io Unique identifier to address an Input/Output in the cell.
|
|
@@ -7132,7 +7375,7 @@ export class BUSInputsOutputsApi extends BaseAPI {
|
|
|
7132
7375
|
}
|
|
7133
7376
|
|
|
7134
7377
|
/**
|
|
7135
|
-
*
|
|
7378
|
+
* Remove the BUS inputs/outputs service from the cell.
|
|
7136
7379
|
* @summary Clear Service
|
|
7137
7380
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
7138
7381
|
* @param {number} [completionTimeout]
|
|
@@ -7145,7 +7388,7 @@ export class BUSInputsOutputsApi extends BaseAPI {
|
|
|
7145
7388
|
}
|
|
7146
7389
|
|
|
7147
7390
|
/**
|
|
7148
|
-
* Removes
|
|
7391
|
+
* Removes an input/output variable configuration from the PROFINET device, e.g. NOVA\'s PROFINET service.
|
|
7149
7392
|
* @summary Remove PROFINET Input/Ouptut
|
|
7150
7393
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
7151
7394
|
* @param {string} io Unique identifier to address an Input/Output in the cell.
|
|
@@ -7158,7 +7401,7 @@ export class BUSInputsOutputsApi extends BaseAPI {
|
|
|
7158
7401
|
}
|
|
7159
7402
|
|
|
7160
7403
|
/**
|
|
7161
|
-
* Get deployed BUS
|
|
7404
|
+
* Get deployed BUS inputs/outputs service.
|
|
7162
7405
|
* @summary Get Service
|
|
7163
7406
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
7164
7407
|
* @param {*} [options] Override http request option.
|
|
@@ -7195,7 +7438,7 @@ export class BUSInputsOutputsApi extends BaseAPI {
|
|
|
7195
7438
|
}
|
|
7196
7439
|
|
|
7197
7440
|
/**
|
|
7198
|
-
* Get description of PROFINET
|
|
7441
|
+
* Get description of NOVA as a PROFINET device.
|
|
7199
7442
|
* @summary Get PROFINET Description
|
|
7200
7443
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
7201
7444
|
* @param {*} [options] Override http request option.
|
|
@@ -7207,7 +7450,7 @@ export class BUSInputsOutputsApi extends BaseAPI {
|
|
|
7207
7450
|
}
|
|
7208
7451
|
|
|
7209
7452
|
/**
|
|
7210
|
-
* Get input/output configuration of the PROFINET device as file.
|
|
7453
|
+
* 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.
|
|
7211
7454
|
* @summary PROFINET Inputs/Outputs to File
|
|
7212
7455
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
7213
7456
|
* @param {number} [inputOffset]
|
|
@@ -7221,7 +7464,7 @@ export class BUSInputsOutputsApi extends BaseAPI {
|
|
|
7221
7464
|
}
|
|
7222
7465
|
|
|
7223
7466
|
/**
|
|
7224
|
-
* List all BUS
|
|
7467
|
+
* 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.
|
|
7225
7468
|
* @summary List Descriptions
|
|
7226
7469
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
7227
7470
|
* @param {*} [options] Override http request option.
|
|
@@ -7233,7 +7476,7 @@ export class BUSInputsOutputsApi extends BaseAPI {
|
|
|
7233
7476
|
}
|
|
7234
7477
|
|
|
7235
7478
|
/**
|
|
7236
|
-
* List all PROFINET input and
|
|
7479
|
+
* 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.
|
|
7237
7480
|
* @summary List PROFINET Input/Output Configuration
|
|
7238
7481
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
7239
7482
|
* @param {*} [options] Override http request option.
|
|
@@ -7258,7 +7501,7 @@ export class BUSInputsOutputsApi extends BaseAPI {
|
|
|
7258
7501
|
}
|
|
7259
7502
|
|
|
7260
7503
|
/**
|
|
7261
|
-
* Sets
|
|
7504
|
+
* 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.
|
|
7262
7505
|
* @summary Set PROFINET Inputs/Outputs from File
|
|
7263
7506
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
7264
7507
|
* @param {ProfinetInputOutputConfig} profinetInputOutputConfig
|
|
@@ -10918,6 +11161,383 @@ export class MotionGroupModelsApi extends BaseAPI {
|
|
|
10918
11161
|
|
|
10919
11162
|
|
|
10920
11163
|
|
|
11164
|
+
/**
|
|
11165
|
+
* ProgramApi - axios parameter creator
|
|
11166
|
+
* @export
|
|
11167
|
+
*/
|
|
11168
|
+
export const ProgramApiAxiosParamCreator = function (configuration?: Configuration) {
|
|
11169
|
+
return {
|
|
11170
|
+
/**
|
|
11171
|
+
* Get details of a program.
|
|
11172
|
+
* @summary Get program
|
|
11173
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
11174
|
+
* @param {string} program
|
|
11175
|
+
* @param {*} [options] Override http request option.
|
|
11176
|
+
* @throws {RequiredError}
|
|
11177
|
+
*/
|
|
11178
|
+
getProgram: async (cell: string, program: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
11179
|
+
// verify required parameter 'cell' is not null or undefined
|
|
11180
|
+
assertParamExists('getProgram', 'cell', cell)
|
|
11181
|
+
// verify required parameter 'program' is not null or undefined
|
|
11182
|
+
assertParamExists('getProgram', 'program', program)
|
|
11183
|
+
const localVarPath = `/experimental/cells/{cell}/programs/{program}`
|
|
11184
|
+
.replace(`{${"cell"}}`, encodeURIComponent(String(cell)))
|
|
11185
|
+
.replace(`{${"program"}}`, encodeURIComponent(String(program)));
|
|
11186
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
11187
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
11188
|
+
let baseOptions;
|
|
11189
|
+
if (configuration) {
|
|
11190
|
+
baseOptions = configuration.baseOptions;
|
|
11191
|
+
}
|
|
11192
|
+
|
|
11193
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
11194
|
+
const localVarHeaderParameter = {} as any;
|
|
11195
|
+
const localVarQueryParameter = {} as any;
|
|
11196
|
+
|
|
11197
|
+
// authentication BasicAuth required
|
|
11198
|
+
// http basic authentication required
|
|
11199
|
+
setBasicAuthToObject(localVarRequestOptions, configuration)
|
|
11200
|
+
|
|
11201
|
+
// authentication BearerAuth required
|
|
11202
|
+
// http bearer authentication required
|
|
11203
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
11204
|
+
|
|
11205
|
+
|
|
11206
|
+
|
|
11207
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
11208
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
11209
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
11210
|
+
|
|
11211
|
+
return {
|
|
11212
|
+
url: toPathString(localVarUrlObj),
|
|
11213
|
+
options: localVarRequestOptions,
|
|
11214
|
+
};
|
|
11215
|
+
},
|
|
11216
|
+
/**
|
|
11217
|
+
* List details of all existing programs.
|
|
11218
|
+
* @summary List programs
|
|
11219
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
11220
|
+
* @param {*} [options] Override http request option.
|
|
11221
|
+
* @throws {RequiredError}
|
|
11222
|
+
*/
|
|
11223
|
+
listPrograms: async (cell: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
11224
|
+
// verify required parameter 'cell' is not null or undefined
|
|
11225
|
+
assertParamExists('listPrograms', 'cell', cell)
|
|
11226
|
+
const localVarPath = `/experimental/cells/{cell}/programs`
|
|
11227
|
+
.replace(`{${"cell"}}`, encodeURIComponent(String(cell)));
|
|
11228
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
11229
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
11230
|
+
let baseOptions;
|
|
11231
|
+
if (configuration) {
|
|
11232
|
+
baseOptions = configuration.baseOptions;
|
|
11233
|
+
}
|
|
11234
|
+
|
|
11235
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
11236
|
+
const localVarHeaderParameter = {} as any;
|
|
11237
|
+
const localVarQueryParameter = {} as any;
|
|
11238
|
+
|
|
11239
|
+
// authentication BasicAuth required
|
|
11240
|
+
// http basic authentication required
|
|
11241
|
+
setBasicAuthToObject(localVarRequestOptions, configuration)
|
|
11242
|
+
|
|
11243
|
+
// authentication BearerAuth required
|
|
11244
|
+
// http bearer authentication required
|
|
11245
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
11246
|
+
|
|
11247
|
+
|
|
11248
|
+
|
|
11249
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
11250
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
11251
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
11252
|
+
|
|
11253
|
+
return {
|
|
11254
|
+
url: toPathString(localVarUrlObj),
|
|
11255
|
+
options: localVarRequestOptions,
|
|
11256
|
+
};
|
|
11257
|
+
},
|
|
11258
|
+
/**
|
|
11259
|
+
* This endpoint starts a new program execution. The program will be executed asynchronously.
|
|
11260
|
+
* @summary Start the program
|
|
11261
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
11262
|
+
* @param {string} program
|
|
11263
|
+
* @param {ProgramStartRequest} programStartRequest
|
|
11264
|
+
* @param {*} [options] Override http request option.
|
|
11265
|
+
* @throws {RequiredError}
|
|
11266
|
+
*/
|
|
11267
|
+
startProgram: async (cell: string, program: string, programStartRequest: ProgramStartRequest, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
11268
|
+
// verify required parameter 'cell' is not null or undefined
|
|
11269
|
+
assertParamExists('startProgram', 'cell', cell)
|
|
11270
|
+
// verify required parameter 'program' is not null or undefined
|
|
11271
|
+
assertParamExists('startProgram', 'program', program)
|
|
11272
|
+
// verify required parameter 'programStartRequest' is not null or undefined
|
|
11273
|
+
assertParamExists('startProgram', 'programStartRequest', programStartRequest)
|
|
11274
|
+
const localVarPath = `/experimental/cells/{cell}/programs/{program}/start`
|
|
11275
|
+
.replace(`{${"cell"}}`, encodeURIComponent(String(cell)))
|
|
11276
|
+
.replace(`{${"program"}}`, encodeURIComponent(String(program)));
|
|
11277
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
11278
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
11279
|
+
let baseOptions;
|
|
11280
|
+
if (configuration) {
|
|
11281
|
+
baseOptions = configuration.baseOptions;
|
|
11282
|
+
}
|
|
11283
|
+
|
|
11284
|
+
const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
|
|
11285
|
+
const localVarHeaderParameter = {} as any;
|
|
11286
|
+
const localVarQueryParameter = {} as any;
|
|
11287
|
+
|
|
11288
|
+
// authentication BasicAuth required
|
|
11289
|
+
// http basic authentication required
|
|
11290
|
+
setBasicAuthToObject(localVarRequestOptions, configuration)
|
|
11291
|
+
|
|
11292
|
+
// authentication BearerAuth required
|
|
11293
|
+
// http bearer authentication required
|
|
11294
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
11295
|
+
|
|
11296
|
+
|
|
11297
|
+
|
|
11298
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
11299
|
+
|
|
11300
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
11301
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
11302
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
11303
|
+
localVarRequestOptions.data = serializeDataIfNeeded(programStartRequest, localVarRequestOptions, configuration)
|
|
11304
|
+
|
|
11305
|
+
return {
|
|
11306
|
+
url: toPathString(localVarUrlObj),
|
|
11307
|
+
options: localVarRequestOptions,
|
|
11308
|
+
};
|
|
11309
|
+
},
|
|
11310
|
+
/**
|
|
11311
|
+
* Stop a specific program run.
|
|
11312
|
+
* @summary Stop program run
|
|
11313
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
11314
|
+
* @param {string} program
|
|
11315
|
+
* @param {*} [options] Override http request option.
|
|
11316
|
+
* @throws {RequiredError}
|
|
11317
|
+
*/
|
|
11318
|
+
stopProgram: async (cell: string, program: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
11319
|
+
// verify required parameter 'cell' is not null or undefined
|
|
11320
|
+
assertParamExists('stopProgram', 'cell', cell)
|
|
11321
|
+
// verify required parameter 'program' is not null or undefined
|
|
11322
|
+
assertParamExists('stopProgram', 'program', program)
|
|
11323
|
+
const localVarPath = `/experimental/cells/{cell}/programs/{program}/stop`
|
|
11324
|
+
.replace(`{${"cell"}}`, encodeURIComponent(String(cell)))
|
|
11325
|
+
.replace(`{${"program"}}`, encodeURIComponent(String(program)));
|
|
11326
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
11327
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
11328
|
+
let baseOptions;
|
|
11329
|
+
if (configuration) {
|
|
11330
|
+
baseOptions = configuration.baseOptions;
|
|
11331
|
+
}
|
|
11332
|
+
|
|
11333
|
+
const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
|
|
11334
|
+
const localVarHeaderParameter = {} as any;
|
|
11335
|
+
const localVarQueryParameter = {} as any;
|
|
11336
|
+
|
|
11337
|
+
// authentication BasicAuth required
|
|
11338
|
+
// http basic authentication required
|
|
11339
|
+
setBasicAuthToObject(localVarRequestOptions, configuration)
|
|
11340
|
+
|
|
11341
|
+
// authentication BearerAuth required
|
|
11342
|
+
// http bearer authentication required
|
|
11343
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
11344
|
+
|
|
11345
|
+
|
|
11346
|
+
|
|
11347
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
11348
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
11349
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
11350
|
+
|
|
11351
|
+
return {
|
|
11352
|
+
url: toPathString(localVarUrlObj),
|
|
11353
|
+
options: localVarRequestOptions,
|
|
11354
|
+
};
|
|
11355
|
+
},
|
|
11356
|
+
}
|
|
11357
|
+
};
|
|
11358
|
+
|
|
11359
|
+
/**
|
|
11360
|
+
* ProgramApi - functional programming interface
|
|
11361
|
+
* @export
|
|
11362
|
+
*/
|
|
11363
|
+
export const ProgramApiFp = function(configuration?: Configuration) {
|
|
11364
|
+
const localVarAxiosParamCreator = ProgramApiAxiosParamCreator(configuration)
|
|
11365
|
+
return {
|
|
11366
|
+
/**
|
|
11367
|
+
* Get details of a program.
|
|
11368
|
+
* @summary Get program
|
|
11369
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
11370
|
+
* @param {string} program
|
|
11371
|
+
* @param {*} [options] Override http request option.
|
|
11372
|
+
* @throws {RequiredError}
|
|
11373
|
+
*/
|
|
11374
|
+
async getProgram(cell: string, program: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Program>> {
|
|
11375
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.getProgram(cell, program, options);
|
|
11376
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
11377
|
+
const localVarOperationServerBasePath = operationServerMap['ProgramApi.getProgram']?.[localVarOperationServerIndex]?.url;
|
|
11378
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
11379
|
+
},
|
|
11380
|
+
/**
|
|
11381
|
+
* List details of all existing programs.
|
|
11382
|
+
* @summary List programs
|
|
11383
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
11384
|
+
* @param {*} [options] Override http request option.
|
|
11385
|
+
* @throws {RequiredError}
|
|
11386
|
+
*/
|
|
11387
|
+
async listPrograms(cell: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<Program>>> {
|
|
11388
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.listPrograms(cell, options);
|
|
11389
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
11390
|
+
const localVarOperationServerBasePath = operationServerMap['ProgramApi.listPrograms']?.[localVarOperationServerIndex]?.url;
|
|
11391
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
11392
|
+
},
|
|
11393
|
+
/**
|
|
11394
|
+
* This endpoint starts a new program execution. The program will be executed asynchronously.
|
|
11395
|
+
* @summary Start the program
|
|
11396
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
11397
|
+
* @param {string} program
|
|
11398
|
+
* @param {ProgramStartRequest} programStartRequest
|
|
11399
|
+
* @param {*} [options] Override http request option.
|
|
11400
|
+
* @throws {RequiredError}
|
|
11401
|
+
*/
|
|
11402
|
+
async startProgram(cell: string, program: string, programStartRequest: ProgramStartRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ProgramRun>> {
|
|
11403
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.startProgram(cell, program, programStartRequest, options);
|
|
11404
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
11405
|
+
const localVarOperationServerBasePath = operationServerMap['ProgramApi.startProgram']?.[localVarOperationServerIndex]?.url;
|
|
11406
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
11407
|
+
},
|
|
11408
|
+
/**
|
|
11409
|
+
* Stop a specific program run.
|
|
11410
|
+
* @summary Stop program run
|
|
11411
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
11412
|
+
* @param {string} program
|
|
11413
|
+
* @param {*} [options] Override http request option.
|
|
11414
|
+
* @throws {RequiredError}
|
|
11415
|
+
*/
|
|
11416
|
+
async stopProgram(cell: string, program: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> {
|
|
11417
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.stopProgram(cell, program, options);
|
|
11418
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
11419
|
+
const localVarOperationServerBasePath = operationServerMap['ProgramApi.stopProgram']?.[localVarOperationServerIndex]?.url;
|
|
11420
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
11421
|
+
},
|
|
11422
|
+
}
|
|
11423
|
+
};
|
|
11424
|
+
|
|
11425
|
+
/**
|
|
11426
|
+
* ProgramApi - factory interface
|
|
11427
|
+
* @export
|
|
11428
|
+
*/
|
|
11429
|
+
export const ProgramApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
|
|
11430
|
+
const localVarFp = ProgramApiFp(configuration)
|
|
11431
|
+
return {
|
|
11432
|
+
/**
|
|
11433
|
+
* Get details of a program.
|
|
11434
|
+
* @summary Get program
|
|
11435
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
11436
|
+
* @param {string} program
|
|
11437
|
+
* @param {*} [options] Override http request option.
|
|
11438
|
+
* @throws {RequiredError}
|
|
11439
|
+
*/
|
|
11440
|
+
getProgram(cell: string, program: string, options?: RawAxiosRequestConfig): AxiosPromise<Program> {
|
|
11441
|
+
return localVarFp.getProgram(cell, program, options).then((request) => request(axios, basePath));
|
|
11442
|
+
},
|
|
11443
|
+
/**
|
|
11444
|
+
* List details of all existing programs.
|
|
11445
|
+
* @summary List programs
|
|
11446
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
11447
|
+
* @param {*} [options] Override http request option.
|
|
11448
|
+
* @throws {RequiredError}
|
|
11449
|
+
*/
|
|
11450
|
+
listPrograms(cell: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<Program>> {
|
|
11451
|
+
return localVarFp.listPrograms(cell, options).then((request) => request(axios, basePath));
|
|
11452
|
+
},
|
|
11453
|
+
/**
|
|
11454
|
+
* This endpoint starts a new program execution. The program will be executed asynchronously.
|
|
11455
|
+
* @summary Start the program
|
|
11456
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
11457
|
+
* @param {string} program
|
|
11458
|
+
* @param {ProgramStartRequest} programStartRequest
|
|
11459
|
+
* @param {*} [options] Override http request option.
|
|
11460
|
+
* @throws {RequiredError}
|
|
11461
|
+
*/
|
|
11462
|
+
startProgram(cell: string, program: string, programStartRequest: ProgramStartRequest, options?: RawAxiosRequestConfig): AxiosPromise<ProgramRun> {
|
|
11463
|
+
return localVarFp.startProgram(cell, program, programStartRequest, options).then((request) => request(axios, basePath));
|
|
11464
|
+
},
|
|
11465
|
+
/**
|
|
11466
|
+
* Stop a specific program run.
|
|
11467
|
+
* @summary Stop program run
|
|
11468
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
11469
|
+
* @param {string} program
|
|
11470
|
+
* @param {*} [options] Override http request option.
|
|
11471
|
+
* @throws {RequiredError}
|
|
11472
|
+
*/
|
|
11473
|
+
stopProgram(cell: string, program: string, options?: RawAxiosRequestConfig): AxiosPromise<void> {
|
|
11474
|
+
return localVarFp.stopProgram(cell, program, options).then((request) => request(axios, basePath));
|
|
11475
|
+
},
|
|
11476
|
+
};
|
|
11477
|
+
};
|
|
11478
|
+
|
|
11479
|
+
/**
|
|
11480
|
+
* ProgramApi - object-oriented interface
|
|
11481
|
+
* @export
|
|
11482
|
+
* @class ProgramApi
|
|
11483
|
+
* @extends {BaseAPI}
|
|
11484
|
+
*/
|
|
11485
|
+
export class ProgramApi extends BaseAPI {
|
|
11486
|
+
/**
|
|
11487
|
+
* Get details of a program.
|
|
11488
|
+
* @summary Get program
|
|
11489
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
11490
|
+
* @param {string} program
|
|
11491
|
+
* @param {*} [options] Override http request option.
|
|
11492
|
+
* @throws {RequiredError}
|
|
11493
|
+
* @memberof ProgramApi
|
|
11494
|
+
*/
|
|
11495
|
+
public getProgram(cell: string, program: string, options?: RawAxiosRequestConfig) {
|
|
11496
|
+
return ProgramApiFp(this.configuration).getProgram(cell, program, options).then((request) => request(this.axios, this.basePath));
|
|
11497
|
+
}
|
|
11498
|
+
|
|
11499
|
+
/**
|
|
11500
|
+
* List details of all existing programs.
|
|
11501
|
+
* @summary List programs
|
|
11502
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
11503
|
+
* @param {*} [options] Override http request option.
|
|
11504
|
+
* @throws {RequiredError}
|
|
11505
|
+
* @memberof ProgramApi
|
|
11506
|
+
*/
|
|
11507
|
+
public listPrograms(cell: string, options?: RawAxiosRequestConfig) {
|
|
11508
|
+
return ProgramApiFp(this.configuration).listPrograms(cell, options).then((request) => request(this.axios, this.basePath));
|
|
11509
|
+
}
|
|
11510
|
+
|
|
11511
|
+
/**
|
|
11512
|
+
* This endpoint starts a new program execution. The program will be executed asynchronously.
|
|
11513
|
+
* @summary Start the program
|
|
11514
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
11515
|
+
* @param {string} program
|
|
11516
|
+
* @param {ProgramStartRequest} programStartRequest
|
|
11517
|
+
* @param {*} [options] Override http request option.
|
|
11518
|
+
* @throws {RequiredError}
|
|
11519
|
+
* @memberof ProgramApi
|
|
11520
|
+
*/
|
|
11521
|
+
public startProgram(cell: string, program: string, programStartRequest: ProgramStartRequest, options?: RawAxiosRequestConfig) {
|
|
11522
|
+
return ProgramApiFp(this.configuration).startProgram(cell, program, programStartRequest, options).then((request) => request(this.axios, this.basePath));
|
|
11523
|
+
}
|
|
11524
|
+
|
|
11525
|
+
/**
|
|
11526
|
+
* Stop a specific program run.
|
|
11527
|
+
* @summary Stop program run
|
|
11528
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
11529
|
+
* @param {string} program
|
|
11530
|
+
* @param {*} [options] Override http request option.
|
|
11531
|
+
* @throws {RequiredError}
|
|
11532
|
+
* @memberof ProgramApi
|
|
11533
|
+
*/
|
|
11534
|
+
public stopProgram(cell: string, program: string, options?: RawAxiosRequestConfig) {
|
|
11535
|
+
return ProgramApiFp(this.configuration).stopProgram(cell, program, options).then((request) => request(this.axios, this.basePath));
|
|
11536
|
+
}
|
|
11537
|
+
}
|
|
11538
|
+
|
|
11539
|
+
|
|
11540
|
+
|
|
10921
11541
|
/**
|
|
10922
11542
|
* StoreCollisionComponentsApi - axios parameter creator
|
|
10923
11543
|
* @export
|