@wandelbots/nova-api 25.8.0-dev.3 → 25.8.0-dev.30
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/package.json +1 -1
- package/v2/api.d.ts +560 -109
- package/v2/api.js +402 -51
- package/v2/api.js.map +1 -1
- package/v2/api.ts +749 -105
package/v2/api.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.
|
|
@@ -2944,13 +3014,13 @@ export type Manufacturer = typeof Manufacturer[keyof typeof Manufacturer];
|
|
|
2944
3014
|
|
|
2945
3015
|
|
|
2946
3016
|
/**
|
|
2947
|
-
*
|
|
3017
|
+
*
|
|
2948
3018
|
* @export
|
|
2949
3019
|
* @interface MidpointInsertionAlgorithm
|
|
2950
3020
|
*/
|
|
2951
3021
|
export interface MidpointInsertionAlgorithm {
|
|
2952
3022
|
/**
|
|
2953
|
-
* Algorithm discriminator.
|
|
3023
|
+
* Algorithm discriminator. Midpoint insertion algorithm configuration for collision-free path planning. This algorithm adds a single midpoint between the start and target joint position to find collision-free paths.
|
|
2954
3024
|
* @type {string}
|
|
2955
3025
|
* @memberof MidpointInsertionAlgorithm
|
|
2956
3026
|
*/
|
|
@@ -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,32 +4331,180 @@ 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
|
}
|
|
4282
4352
|
/**
|
|
4283
|
-
*
|
|
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
|
+
}
|
|
4500
|
+
/**
|
|
4501
|
+
*
|
|
4284
4502
|
* @export
|
|
4285
4503
|
* @interface RRTConnectAlgorithm
|
|
4286
4504
|
*/
|
|
4287
4505
|
export interface RRTConnectAlgorithm {
|
|
4288
4506
|
/**
|
|
4289
|
-
* Algorithm discriminator.
|
|
4507
|
+
* Algorithm discriminator. RRT Connect algorithm configuration for collision-free path planning. Rapidly-exploring Random Trees (RRT) builds trees of valid configurations by randomly sampling the joint space and connecting feasible points with JointPTP motions. RRT Connect grows two trees simultaneously from start and target positions until they meet. This is a custom implementation optimized for manipulator kinematics and collision checking in industrial contexts.
|
|
4290
4508
|
* @type {string}
|
|
4291
4509
|
* @memberof RRTConnectAlgorithm
|
|
4292
4510
|
*/
|
|
@@ -4297,6 +4515,30 @@ export interface RRTConnectAlgorithm {
|
|
|
4297
4515
|
* @memberof RRTConnectAlgorithm
|
|
4298
4516
|
*/
|
|
4299
4517
|
'max_iterations'?: number;
|
|
4518
|
+
/**
|
|
4519
|
+
* Maximum step size for tree extension in joint space.
|
|
4520
|
+
* @type {number}
|
|
4521
|
+
* @memberof RRTConnectAlgorithm
|
|
4522
|
+
*/
|
|
4523
|
+
'max_step_size'?: number;
|
|
4524
|
+
/**
|
|
4525
|
+
* Adjust the maximum step size during the search based on the recent success rate of tree expansion.
|
|
4526
|
+
* @type {boolean}
|
|
4527
|
+
* @memberof RRTConnectAlgorithm
|
|
4528
|
+
*/
|
|
4529
|
+
'adaptive_step_size'?: boolean;
|
|
4530
|
+
/**
|
|
4531
|
+
* Apply smoothing after the search has succeeded. This will remove as many intermediate points as possible while keeping the path valid.
|
|
4532
|
+
* @type {boolean}
|
|
4533
|
+
* @memberof RRTConnectAlgorithm
|
|
4534
|
+
*/
|
|
4535
|
+
'apply_smoothing'?: boolean;
|
|
4536
|
+
/**
|
|
4537
|
+
* Apply blending after the search has succeeded and smoothing has been applied. This will apply the largest viable blending at each intermediate point.
|
|
4538
|
+
* @type {boolean}
|
|
4539
|
+
* @memberof RRTConnectAlgorithm
|
|
4540
|
+
*/
|
|
4541
|
+
'apply_blending'?: boolean;
|
|
4300
4542
|
}
|
|
4301
4543
|
|
|
4302
4544
|
export const RRTConnectAlgorithmAlgorithmNameEnum = {
|
|
@@ -5105,10 +5347,10 @@ export type TrajectoryDetailsKindEnum = typeof TrajectoryDetailsKindEnum[keyof t
|
|
|
5105
5347
|
* @type TrajectoryDetailsState
|
|
5106
5348
|
* @export
|
|
5107
5349
|
*/
|
|
5108
|
-
export type TrajectoryDetailsState = TrajectoryEnded | TrajectoryPausedByUser | TrajectoryPausedOnIO | TrajectoryRunning | TrajectoryWaitForIO;
|
|
5350
|
+
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
5351
|
|
|
5110
5352
|
/**
|
|
5111
|
-
*
|
|
5353
|
+
* First or last sample (depending on direction) of trajectory has been sent.
|
|
5112
5354
|
* @export
|
|
5113
5355
|
* @interface TrajectoryEnded
|
|
5114
5356
|
*/
|
|
@@ -5154,7 +5396,7 @@ export const TrajectoryIdMessageTypeEnum = {
|
|
|
5154
5396
|
export type TrajectoryIdMessageTypeEnum = typeof TrajectoryIdMessageTypeEnum[keyof typeof TrajectoryIdMessageTypeEnum];
|
|
5155
5397
|
|
|
5156
5398
|
/**
|
|
5157
|
-
*
|
|
5399
|
+
* User has paused execution.
|
|
5158
5400
|
* @export
|
|
5159
5401
|
* @interface TrajectoryPausedByUser
|
|
5160
5402
|
*/
|
|
@@ -5174,7 +5416,7 @@ export const TrajectoryPausedByUserKindEnum = {
|
|
|
5174
5416
|
export type TrajectoryPausedByUserKindEnum = typeof TrajectoryPausedByUserKindEnum[keyof typeof TrajectoryPausedByUserKindEnum];
|
|
5175
5417
|
|
|
5176
5418
|
/**
|
|
5177
|
-
*
|
|
5419
|
+
* Execution was paused because of an I/O event.
|
|
5178
5420
|
* @export
|
|
5179
5421
|
* @interface TrajectoryPausedOnIO
|
|
5180
5422
|
*/
|
|
@@ -5194,7 +5436,7 @@ export const TrajectoryPausedOnIOKindEnum = {
|
|
|
5194
5436
|
export type TrajectoryPausedOnIOKindEnum = typeof TrajectoryPausedOnIOKindEnum[keyof typeof TrajectoryPausedOnIOKindEnum];
|
|
5195
5437
|
|
|
5196
5438
|
/**
|
|
5197
|
-
*
|
|
5439
|
+
* Trajectory is being executed.
|
|
5198
5440
|
* @export
|
|
5199
5441
|
* @interface TrajectoryRunning
|
|
5200
5442
|
*/
|
|
@@ -5220,7 +5462,7 @@ export const TrajectoryRunningKindEnum = {
|
|
|
5220
5462
|
export type TrajectoryRunningKindEnum = typeof TrajectoryRunningKindEnum[keyof typeof TrajectoryRunningKindEnum];
|
|
5221
5463
|
|
|
5222
5464
|
/**
|
|
5223
|
-
*
|
|
5465
|
+
* Waiting for an I/O event to start execution.
|
|
5224
5466
|
* @export
|
|
5225
5467
|
* @interface TrajectoryWaitForIO
|
|
5226
5468
|
*/
|
|
@@ -5333,6 +5575,31 @@ export interface ValidationError {
|
|
|
5333
5575
|
*/
|
|
5334
5576
|
'input': { [key: string]: any; };
|
|
5335
5577
|
}
|
|
5578
|
+
/**
|
|
5579
|
+
* A validation error of a program.
|
|
5580
|
+
* @export
|
|
5581
|
+
* @interface ValidationError2
|
|
5582
|
+
*/
|
|
5583
|
+
export interface ValidationError2 {
|
|
5584
|
+
/**
|
|
5585
|
+
*
|
|
5586
|
+
* @type {Array<number>}
|
|
5587
|
+
* @memberof ValidationError2
|
|
5588
|
+
*/
|
|
5589
|
+
'loc': Array<number>;
|
|
5590
|
+
/**
|
|
5591
|
+
*
|
|
5592
|
+
* @type {string}
|
|
5593
|
+
* @memberof ValidationError2
|
|
5594
|
+
*/
|
|
5595
|
+
'msg': string;
|
|
5596
|
+
/**
|
|
5597
|
+
*
|
|
5598
|
+
* @type {string}
|
|
5599
|
+
* @memberof ValidationError2
|
|
5600
|
+
*/
|
|
5601
|
+
'type': string;
|
|
5602
|
+
}
|
|
5336
5603
|
/**
|
|
5337
5604
|
* @type ValidationErrorLocInner
|
|
5338
5605
|
* @export
|
|
@@ -6150,7 +6417,7 @@ export class ApplicationApi extends BaseAPI {
|
|
|
6150
6417
|
export const BUSInputsOutputsApiAxiosParamCreator = function (configuration?: Configuration) {
|
|
6151
6418
|
return {
|
|
6152
6419
|
/**
|
|
6153
|
-
* Add
|
|
6420
|
+
* Add the BUS inputs/outputs service to the cell. Starts a containerized service that enables BUS connections via the specified ethernet port.
|
|
6154
6421
|
* @summary Add Service
|
|
6155
6422
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
6156
6423
|
* @param {BusIOType} busIOType
|
|
@@ -6203,7 +6470,7 @@ export const BUSInputsOutputsApiAxiosParamCreator = function (configuration?: Co
|
|
|
6203
6470
|
};
|
|
6204
6471
|
},
|
|
6205
6472
|
/**
|
|
6206
|
-
* Adds an input/output to or updates an input/output on the PROFINET device.
|
|
6473
|
+
* 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
6474
|
* @summary Add PROFINET Input/Output
|
|
6208
6475
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
6209
6476
|
* @param {string} io Unique identifier to address an Input/Output in the cell.
|
|
@@ -6255,7 +6522,7 @@ export const BUSInputsOutputsApiAxiosParamCreator = function (configuration?: Co
|
|
|
6255
6522
|
};
|
|
6256
6523
|
},
|
|
6257
6524
|
/**
|
|
6258
|
-
*
|
|
6525
|
+
* Remove the BUS inputs/outputs service from the cell.
|
|
6259
6526
|
* @summary Clear Service
|
|
6260
6527
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
6261
6528
|
* @param {number} [completionTimeout]
|
|
@@ -6302,7 +6569,7 @@ export const BUSInputsOutputsApiAxiosParamCreator = function (configuration?: Co
|
|
|
6302
6569
|
};
|
|
6303
6570
|
},
|
|
6304
6571
|
/**
|
|
6305
|
-
* Removes
|
|
6572
|
+
* Removes an input/output variable configuration from the PROFINET device, e.g. NOVA\'s PROFINET service.
|
|
6306
6573
|
* @summary Remove PROFINET Input/Ouptut
|
|
6307
6574
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
6308
6575
|
* @param {string} io Unique identifier to address an Input/Output in the cell.
|
|
@@ -6348,7 +6615,7 @@ export const BUSInputsOutputsApiAxiosParamCreator = function (configuration?: Co
|
|
|
6348
6615
|
};
|
|
6349
6616
|
},
|
|
6350
6617
|
/**
|
|
6351
|
-
* Get deployed BUS
|
|
6618
|
+
* Get deployed BUS inputs/outputs service.
|
|
6352
6619
|
* @summary Get Service
|
|
6353
6620
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
6354
6621
|
* @param {*} [options] Override http request option.
|
|
@@ -6479,7 +6746,7 @@ export const BUSInputsOutputsApiAxiosParamCreator = function (configuration?: Co
|
|
|
6479
6746
|
};
|
|
6480
6747
|
},
|
|
6481
6748
|
/**
|
|
6482
|
-
* Get description of PROFINET
|
|
6749
|
+
* Get description of NOVA as a PROFINET device.
|
|
6483
6750
|
* @summary Get PROFINET Description
|
|
6484
6751
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
6485
6752
|
* @param {*} [options] Override http request option.
|
|
@@ -6521,7 +6788,7 @@ export const BUSInputsOutputsApiAxiosParamCreator = function (configuration?: Co
|
|
|
6521
6788
|
};
|
|
6522
6789
|
},
|
|
6523
6790
|
/**
|
|
6524
|
-
* Get input/output configuration of the PROFINET device as file.
|
|
6791
|
+
* 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
6792
|
* @summary PROFINET Inputs/Outputs to File
|
|
6526
6793
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
6527
6794
|
* @param {number} [inputOffset]
|
|
@@ -6573,7 +6840,7 @@ export const BUSInputsOutputsApiAxiosParamCreator = function (configuration?: Co
|
|
|
6573
6840
|
};
|
|
6574
6841
|
},
|
|
6575
6842
|
/**
|
|
6576
|
-
* List all BUS
|
|
6843
|
+
* 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
6844
|
* @summary List Descriptions
|
|
6578
6845
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
6579
6846
|
* @param {*} [options] Override http request option.
|
|
@@ -6615,7 +6882,7 @@ export const BUSInputsOutputsApiAxiosParamCreator = function (configuration?: Co
|
|
|
6615
6882
|
};
|
|
6616
6883
|
},
|
|
6617
6884
|
/**
|
|
6618
|
-
* List all PROFINET input and
|
|
6885
|
+
* 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
6886
|
* @summary List PROFINET Input/Output Configuration
|
|
6620
6887
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
6621
6888
|
* @param {*} [options] Override http request option.
|
|
@@ -6705,7 +6972,7 @@ export const BUSInputsOutputsApiAxiosParamCreator = function (configuration?: Co
|
|
|
6705
6972
|
};
|
|
6706
6973
|
},
|
|
6707
6974
|
/**
|
|
6708
|
-
* Sets
|
|
6975
|
+
* 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
6976
|
* @summary Set PROFINET Inputs/Outputs from File
|
|
6710
6977
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
6711
6978
|
* @param {ProfinetInputOutputConfig} profinetInputOutputConfig
|
|
@@ -6763,7 +7030,7 @@ export const BUSInputsOutputsApiFp = function(configuration?: Configuration) {
|
|
|
6763
7030
|
const localVarAxiosParamCreator = BUSInputsOutputsApiAxiosParamCreator(configuration)
|
|
6764
7031
|
return {
|
|
6765
7032
|
/**
|
|
6766
|
-
* Add
|
|
7033
|
+
* Add the BUS inputs/outputs service to the cell. Starts a containerized service that enables BUS connections via the specified ethernet port.
|
|
6767
7034
|
* @summary Add Service
|
|
6768
7035
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
6769
7036
|
* @param {BusIOType} busIOType
|
|
@@ -6778,7 +7045,7 @@ export const BUSInputsOutputsApiFp = function(configuration?: Configuration) {
|
|
|
6778
7045
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
6779
7046
|
},
|
|
6780
7047
|
/**
|
|
6781
|
-
* Adds an input/output to or updates an input/output on the PROFINET device.
|
|
7048
|
+
* 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
7049
|
* @summary Add PROFINET Input/Output
|
|
6783
7050
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
6784
7051
|
* @param {string} io Unique identifier to address an Input/Output in the cell.
|
|
@@ -6793,7 +7060,7 @@ export const BUSInputsOutputsApiFp = function(configuration?: Configuration) {
|
|
|
6793
7060
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
6794
7061
|
},
|
|
6795
7062
|
/**
|
|
6796
|
-
*
|
|
7063
|
+
* Remove the BUS inputs/outputs service from the cell.
|
|
6797
7064
|
* @summary Clear Service
|
|
6798
7065
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
6799
7066
|
* @param {number} [completionTimeout]
|
|
@@ -6807,7 +7074,7 @@ export const BUSInputsOutputsApiFp = function(configuration?: Configuration) {
|
|
|
6807
7074
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
6808
7075
|
},
|
|
6809
7076
|
/**
|
|
6810
|
-
* Removes
|
|
7077
|
+
* Removes an input/output variable configuration from the PROFINET device, e.g. NOVA\'s PROFINET service.
|
|
6811
7078
|
* @summary Remove PROFINET Input/Ouptut
|
|
6812
7079
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
6813
7080
|
* @param {string} io Unique identifier to address an Input/Output in the cell.
|
|
@@ -6821,7 +7088,7 @@ export const BUSInputsOutputsApiFp = function(configuration?: Configuration) {
|
|
|
6821
7088
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
6822
7089
|
},
|
|
6823
7090
|
/**
|
|
6824
|
-
* Get deployed BUS
|
|
7091
|
+
* Get deployed BUS inputs/outputs service.
|
|
6825
7092
|
* @summary Get Service
|
|
6826
7093
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
6827
7094
|
* @param {*} [options] Override http request option.
|
|
@@ -6861,7 +7128,7 @@ export const BUSInputsOutputsApiFp = function(configuration?: Configuration) {
|
|
|
6861
7128
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
6862
7129
|
},
|
|
6863
7130
|
/**
|
|
6864
|
-
* Get description of PROFINET
|
|
7131
|
+
* Get description of NOVA as a PROFINET device.
|
|
6865
7132
|
* @summary Get PROFINET Description
|
|
6866
7133
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
6867
7134
|
* @param {*} [options] Override http request option.
|
|
@@ -6874,7 +7141,7 @@ export const BUSInputsOutputsApiFp = function(configuration?: Configuration) {
|
|
|
6874
7141
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
6875
7142
|
},
|
|
6876
7143
|
/**
|
|
6877
|
-
* Get input/output configuration of the PROFINET device as file.
|
|
7144
|
+
* 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
7145
|
* @summary PROFINET Inputs/Outputs to File
|
|
6879
7146
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
6880
7147
|
* @param {number} [inputOffset]
|
|
@@ -6889,20 +7156,20 @@ export const BUSInputsOutputsApiFp = function(configuration?: Configuration) {
|
|
|
6889
7156
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
6890
7157
|
},
|
|
6891
7158
|
/**
|
|
6892
|
-
* List all BUS
|
|
7159
|
+
* 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
7160
|
* @summary List Descriptions
|
|
6894
7161
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
6895
7162
|
* @param {*} [options] Override http request option.
|
|
6896
7163
|
* @throws {RequiredError}
|
|
6897
7164
|
*/
|
|
6898
|
-
async listBusIODescriptions(cell: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<
|
|
7165
|
+
async listBusIODescriptions(cell: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<IODescription2>>> {
|
|
6899
7166
|
const localVarAxiosArgs = await localVarAxiosParamCreator.listBusIODescriptions(cell, options);
|
|
6900
7167
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
6901
7168
|
const localVarOperationServerBasePath = operationServerMap['BUSInputsOutputsApi.listBusIODescriptions']?.[localVarOperationServerIndex]?.url;
|
|
6902
7169
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
6903
7170
|
},
|
|
6904
7171
|
/**
|
|
6905
|
-
* List all PROFINET input and
|
|
7172
|
+
* 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
7173
|
* @summary List PROFINET Input/Output Configuration
|
|
6907
7174
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
6908
7175
|
* @param {*} [options] Override http request option.
|
|
@@ -6929,7 +7196,7 @@ export const BUSInputsOutputsApiFp = function(configuration?: Configuration) {
|
|
|
6929
7196
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
6930
7197
|
},
|
|
6931
7198
|
/**
|
|
6932
|
-
* Sets
|
|
7199
|
+
* 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
7200
|
* @summary Set PROFINET Inputs/Outputs from File
|
|
6934
7201
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
6935
7202
|
* @param {ProfinetInputOutputConfig} profinetInputOutputConfig
|
|
@@ -6953,7 +7220,7 @@ export const BUSInputsOutputsApiFactory = function (configuration?: Configuratio
|
|
|
6953
7220
|
const localVarFp = BUSInputsOutputsApiFp(configuration)
|
|
6954
7221
|
return {
|
|
6955
7222
|
/**
|
|
6956
|
-
* Add
|
|
7223
|
+
* Add the BUS inputs/outputs service to the cell. Starts a containerized service that enables BUS connections via the specified ethernet port.
|
|
6957
7224
|
* @summary Add Service
|
|
6958
7225
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
6959
7226
|
* @param {BusIOType} busIOType
|
|
@@ -6965,7 +7232,7 @@ export const BUSInputsOutputsApiFactory = function (configuration?: Configuratio
|
|
|
6965
7232
|
return localVarFp.addBusIOService(cell, busIOType, completionTimeout, options).then((request) => request(axios, basePath));
|
|
6966
7233
|
},
|
|
6967
7234
|
/**
|
|
6968
|
-
* Adds an input/output to or updates an input/output on the PROFINET device.
|
|
7235
|
+
* 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
7236
|
* @summary Add PROFINET Input/Output
|
|
6970
7237
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
6971
7238
|
* @param {string} io Unique identifier to address an Input/Output in the cell.
|
|
@@ -6977,7 +7244,7 @@ export const BUSInputsOutputsApiFactory = function (configuration?: Configuratio
|
|
|
6977
7244
|
return localVarFp.addProfinetIO(cell, io, profinetIOData, options).then((request) => request(axios, basePath));
|
|
6978
7245
|
},
|
|
6979
7246
|
/**
|
|
6980
|
-
*
|
|
7247
|
+
* Remove the BUS inputs/outputs service from the cell.
|
|
6981
7248
|
* @summary Clear Service
|
|
6982
7249
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
6983
7250
|
* @param {number} [completionTimeout]
|
|
@@ -6988,7 +7255,7 @@ export const BUSInputsOutputsApiFactory = function (configuration?: Configuratio
|
|
|
6988
7255
|
return localVarFp.clearBusIOService(cell, completionTimeout, options).then((request) => request(axios, basePath));
|
|
6989
7256
|
},
|
|
6990
7257
|
/**
|
|
6991
|
-
* Removes
|
|
7258
|
+
* Removes an input/output variable configuration from the PROFINET device, e.g. NOVA\'s PROFINET service.
|
|
6992
7259
|
* @summary Remove PROFINET Input/Ouptut
|
|
6993
7260
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
6994
7261
|
* @param {string} io Unique identifier to address an Input/Output in the cell.
|
|
@@ -6999,7 +7266,7 @@ export const BUSInputsOutputsApiFactory = function (configuration?: Configuratio
|
|
|
6999
7266
|
return localVarFp.deleteProfinetIO(cell, io, options).then((request) => request(axios, basePath));
|
|
7000
7267
|
},
|
|
7001
7268
|
/**
|
|
7002
|
-
* Get deployed BUS
|
|
7269
|
+
* Get deployed BUS inputs/outputs service.
|
|
7003
7270
|
* @summary Get Service
|
|
7004
7271
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
7005
7272
|
* @param {*} [options] Override http request option.
|
|
@@ -7030,7 +7297,7 @@ export const BUSInputsOutputsApiFactory = function (configuration?: Configuratio
|
|
|
7030
7297
|
return localVarFp.getBusIOValues(cell, ios, options).then((request) => request(axios, basePath));
|
|
7031
7298
|
},
|
|
7032
7299
|
/**
|
|
7033
|
-
* Get description of PROFINET
|
|
7300
|
+
* Get description of NOVA as a PROFINET device.
|
|
7034
7301
|
* @summary Get PROFINET Description
|
|
7035
7302
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
7036
7303
|
* @param {*} [options] Override http request option.
|
|
@@ -7040,7 +7307,7 @@ export const BUSInputsOutputsApiFactory = function (configuration?: Configuratio
|
|
|
7040
7307
|
return localVarFp.getProfinetDescription(cell, options).then((request) => request(axios, basePath));
|
|
7041
7308
|
},
|
|
7042
7309
|
/**
|
|
7043
|
-
* Get input/output configuration of the PROFINET device as file.
|
|
7310
|
+
* 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
7311
|
* @summary PROFINET Inputs/Outputs to File
|
|
7045
7312
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
7046
7313
|
* @param {number} [inputOffset]
|
|
@@ -7052,17 +7319,17 @@ export const BUSInputsOutputsApiFactory = function (configuration?: Configuratio
|
|
|
7052
7319
|
return localVarFp.getProfinetIOsFromFile(cell, inputOffset, outputOffset, options).then((request) => request(axios, basePath));
|
|
7053
7320
|
},
|
|
7054
7321
|
/**
|
|
7055
|
-
* List all BUS
|
|
7322
|
+
* 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
7323
|
* @summary List Descriptions
|
|
7057
7324
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
7058
7325
|
* @param {*} [options] Override http request option.
|
|
7059
7326
|
* @throws {RequiredError}
|
|
7060
7327
|
*/
|
|
7061
|
-
listBusIODescriptions(cell: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<
|
|
7328
|
+
listBusIODescriptions(cell: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<IODescription2>> {
|
|
7062
7329
|
return localVarFp.listBusIODescriptions(cell, options).then((request) => request(axios, basePath));
|
|
7063
7330
|
},
|
|
7064
7331
|
/**
|
|
7065
|
-
* List all PROFINET input and
|
|
7332
|
+
* 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
7333
|
* @summary List PROFINET Input/Output Configuration
|
|
7067
7334
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
7068
7335
|
* @param {*} [options] Override http request option.
|
|
@@ -7083,7 +7350,7 @@ export const BUSInputsOutputsApiFactory = function (configuration?: Configuratio
|
|
|
7083
7350
|
return localVarFp.setBusIOValues(cell, iOValue, options).then((request) => request(axios, basePath));
|
|
7084
7351
|
},
|
|
7085
7352
|
/**
|
|
7086
|
-
* Sets
|
|
7353
|
+
* 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
7354
|
* @summary Set PROFINET Inputs/Outputs from File
|
|
7088
7355
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
7089
7356
|
* @param {ProfinetInputOutputConfig} profinetInputOutputConfig
|
|
@@ -7104,7 +7371,7 @@ export const BUSInputsOutputsApiFactory = function (configuration?: Configuratio
|
|
|
7104
7371
|
*/
|
|
7105
7372
|
export class BUSInputsOutputsApi extends BaseAPI {
|
|
7106
7373
|
/**
|
|
7107
|
-
* Add
|
|
7374
|
+
* Add the BUS inputs/outputs service to the cell. Starts a containerized service that enables BUS connections via the specified ethernet port.
|
|
7108
7375
|
* @summary Add Service
|
|
7109
7376
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
7110
7377
|
* @param {BusIOType} busIOType
|
|
@@ -7118,7 +7385,7 @@ export class BUSInputsOutputsApi extends BaseAPI {
|
|
|
7118
7385
|
}
|
|
7119
7386
|
|
|
7120
7387
|
/**
|
|
7121
|
-
* Adds an input/output to or updates an input/output on the PROFINET device.
|
|
7388
|
+
* 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
7389
|
* @summary Add PROFINET Input/Output
|
|
7123
7390
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
7124
7391
|
* @param {string} io Unique identifier to address an Input/Output in the cell.
|
|
@@ -7132,7 +7399,7 @@ export class BUSInputsOutputsApi extends BaseAPI {
|
|
|
7132
7399
|
}
|
|
7133
7400
|
|
|
7134
7401
|
/**
|
|
7135
|
-
*
|
|
7402
|
+
* Remove the BUS inputs/outputs service from the cell.
|
|
7136
7403
|
* @summary Clear Service
|
|
7137
7404
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
7138
7405
|
* @param {number} [completionTimeout]
|
|
@@ -7145,7 +7412,7 @@ export class BUSInputsOutputsApi extends BaseAPI {
|
|
|
7145
7412
|
}
|
|
7146
7413
|
|
|
7147
7414
|
/**
|
|
7148
|
-
* Removes
|
|
7415
|
+
* Removes an input/output variable configuration from the PROFINET device, e.g. NOVA\'s PROFINET service.
|
|
7149
7416
|
* @summary Remove PROFINET Input/Ouptut
|
|
7150
7417
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
7151
7418
|
* @param {string} io Unique identifier to address an Input/Output in the cell.
|
|
@@ -7158,7 +7425,7 @@ export class BUSInputsOutputsApi extends BaseAPI {
|
|
|
7158
7425
|
}
|
|
7159
7426
|
|
|
7160
7427
|
/**
|
|
7161
|
-
* Get deployed BUS
|
|
7428
|
+
* Get deployed BUS inputs/outputs service.
|
|
7162
7429
|
* @summary Get Service
|
|
7163
7430
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
7164
7431
|
* @param {*} [options] Override http request option.
|
|
@@ -7195,7 +7462,7 @@ export class BUSInputsOutputsApi extends BaseAPI {
|
|
|
7195
7462
|
}
|
|
7196
7463
|
|
|
7197
7464
|
/**
|
|
7198
|
-
* Get description of PROFINET
|
|
7465
|
+
* Get description of NOVA as a PROFINET device.
|
|
7199
7466
|
* @summary Get PROFINET Description
|
|
7200
7467
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
7201
7468
|
* @param {*} [options] Override http request option.
|
|
@@ -7207,7 +7474,7 @@ export class BUSInputsOutputsApi extends BaseAPI {
|
|
|
7207
7474
|
}
|
|
7208
7475
|
|
|
7209
7476
|
/**
|
|
7210
|
-
* Get input/output configuration of the PROFINET device as file.
|
|
7477
|
+
* 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
7478
|
* @summary PROFINET Inputs/Outputs to File
|
|
7212
7479
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
7213
7480
|
* @param {number} [inputOffset]
|
|
@@ -7221,7 +7488,7 @@ export class BUSInputsOutputsApi extends BaseAPI {
|
|
|
7221
7488
|
}
|
|
7222
7489
|
|
|
7223
7490
|
/**
|
|
7224
|
-
* List all BUS
|
|
7491
|
+
* 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
7492
|
* @summary List Descriptions
|
|
7226
7493
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
7227
7494
|
* @param {*} [options] Override http request option.
|
|
@@ -7233,7 +7500,7 @@ export class BUSInputsOutputsApi extends BaseAPI {
|
|
|
7233
7500
|
}
|
|
7234
7501
|
|
|
7235
7502
|
/**
|
|
7236
|
-
* List all PROFINET input and
|
|
7503
|
+
* 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
7504
|
* @summary List PROFINET Input/Output Configuration
|
|
7238
7505
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
7239
7506
|
* @param {*} [options] Override http request option.
|
|
@@ -7258,7 +7525,7 @@ export class BUSInputsOutputsApi extends BaseAPI {
|
|
|
7258
7525
|
}
|
|
7259
7526
|
|
|
7260
7527
|
/**
|
|
7261
|
-
* Sets
|
|
7528
|
+
* 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
7529
|
* @summary Set PROFINET Inputs/Outputs from File
|
|
7263
7530
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
7264
7531
|
* @param {ProfinetInputOutputConfig} profinetInputOutputConfig
|
|
@@ -10725,7 +10992,7 @@ export class MotionGroupApi extends BaseAPI {
|
|
|
10725
10992
|
export const MotionGroupModelsApiAxiosParamCreator = function (configuration?: Configuration) {
|
|
10726
10993
|
return {
|
|
10727
10994
|
/**
|
|
10728
|
-
* Returns the default collision link chain for a given motion group model. See [
|
|
10995
|
+
* Returns the default collision link chain for a given motion group model. See [getMotionGroupModels](getMotionGroupModels) for supported motion group models. The default link chain is derived from 3D models and optimized for collision detection within NOVA. The default link chain includes link shapes only. It does not include any attached components like wire feeders or sensors. Attach additional shapes to the link reference frames by extending the link dictionaries before further use. Additional shapes may overlap each other per link and may also overlap the respective link\'s default shape.
|
|
10729
10996
|
* @summary Get Collision Model
|
|
10730
10997
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
10731
10998
|
* @param {string} motionGroupModel Unique identifier for the model of a motion group, e.g. `UniversalRobots_UR10e`. Get the `model` of a configured motion group with [getOptimizerConfiguration](getOptimizerConfiguration).
|
|
@@ -10823,7 +11090,7 @@ export const MotionGroupModelsApiFp = function(configuration?: Configuration) {
|
|
|
10823
11090
|
const localVarAxiosParamCreator = MotionGroupModelsApiAxiosParamCreator(configuration)
|
|
10824
11091
|
return {
|
|
10825
11092
|
/**
|
|
10826
|
-
* Returns the default collision link chain for a given motion group model. See [
|
|
11093
|
+
* Returns the default collision link chain for a given motion group model. See [getMotionGroupModels](getMotionGroupModels) for supported motion group models. The default link chain is derived from 3D models and optimized for collision detection within NOVA. The default link chain includes link shapes only. It does not include any attached components like wire feeders or sensors. Attach additional shapes to the link reference frames by extending the link dictionaries before further use. Additional shapes may overlap each other per link and may also overlap the respective link\'s default shape.
|
|
10827
11094
|
* @summary Get Collision Model
|
|
10828
11095
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
10829
11096
|
* @param {string} motionGroupModel Unique identifier for the model of a motion group, e.g. `UniversalRobots_UR10e`. Get the `model` of a configured motion group with [getOptimizerConfiguration](getOptimizerConfiguration).
|
|
@@ -10860,7 +11127,7 @@ export const MotionGroupModelsApiFactory = function (configuration?: Configurati
|
|
|
10860
11127
|
const localVarFp = MotionGroupModelsApiFp(configuration)
|
|
10861
11128
|
return {
|
|
10862
11129
|
/**
|
|
10863
|
-
* Returns the default collision link chain for a given motion group model. See [
|
|
11130
|
+
* Returns the default collision link chain for a given motion group model. See [getMotionGroupModels](getMotionGroupModels) for supported motion group models. The default link chain is derived from 3D models and optimized for collision detection within NOVA. The default link chain includes link shapes only. It does not include any attached components like wire feeders or sensors. Attach additional shapes to the link reference frames by extending the link dictionaries before further use. Additional shapes may overlap each other per link and may also overlap the respective link\'s default shape.
|
|
10864
11131
|
* @summary Get Collision Model
|
|
10865
11132
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
10866
11133
|
* @param {string} motionGroupModel Unique identifier for the model of a motion group, e.g. `UniversalRobots_UR10e`. Get the `model` of a configured motion group with [getOptimizerConfiguration](getOptimizerConfiguration).
|
|
@@ -10891,7 +11158,7 @@ export const MotionGroupModelsApiFactory = function (configuration?: Configurati
|
|
|
10891
11158
|
*/
|
|
10892
11159
|
export class MotionGroupModelsApi extends BaseAPI {
|
|
10893
11160
|
/**
|
|
10894
|
-
* Returns the default collision link chain for a given motion group model. See [
|
|
11161
|
+
* Returns the default collision link chain for a given motion group model. See [getMotionGroupModels](getMotionGroupModels) for supported motion group models. The default link chain is derived from 3D models and optimized for collision detection within NOVA. The default link chain includes link shapes only. It does not include any attached components like wire feeders or sensors. Attach additional shapes to the link reference frames by extending the link dictionaries before further use. Additional shapes may overlap each other per link and may also overlap the respective link\'s default shape.
|
|
10895
11162
|
* @summary Get Collision Model
|
|
10896
11163
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
10897
11164
|
* @param {string} motionGroupModel Unique identifier for the model of a motion group, e.g. `UniversalRobots_UR10e`. Get the `model` of a configured motion group with [getOptimizerConfiguration](getOptimizerConfiguration).
|
|
@@ -10918,6 +11185,383 @@ export class MotionGroupModelsApi extends BaseAPI {
|
|
|
10918
11185
|
|
|
10919
11186
|
|
|
10920
11187
|
|
|
11188
|
+
/**
|
|
11189
|
+
* ProgramApi - axios parameter creator
|
|
11190
|
+
* @export
|
|
11191
|
+
*/
|
|
11192
|
+
export const ProgramApiAxiosParamCreator = function (configuration?: Configuration) {
|
|
11193
|
+
return {
|
|
11194
|
+
/**
|
|
11195
|
+
* Get details of a program.
|
|
11196
|
+
* @summary Get program
|
|
11197
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
11198
|
+
* @param {string} program
|
|
11199
|
+
* @param {*} [options] Override http request option.
|
|
11200
|
+
* @throws {RequiredError}
|
|
11201
|
+
*/
|
|
11202
|
+
getProgram: async (cell: string, program: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
11203
|
+
// verify required parameter 'cell' is not null or undefined
|
|
11204
|
+
assertParamExists('getProgram', 'cell', cell)
|
|
11205
|
+
// verify required parameter 'program' is not null or undefined
|
|
11206
|
+
assertParamExists('getProgram', 'program', program)
|
|
11207
|
+
const localVarPath = `/experimental/cells/{cell}/programs/{program}`
|
|
11208
|
+
.replace(`{${"cell"}}`, encodeURIComponent(String(cell)))
|
|
11209
|
+
.replace(`{${"program"}}`, encodeURIComponent(String(program)));
|
|
11210
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
11211
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
11212
|
+
let baseOptions;
|
|
11213
|
+
if (configuration) {
|
|
11214
|
+
baseOptions = configuration.baseOptions;
|
|
11215
|
+
}
|
|
11216
|
+
|
|
11217
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
11218
|
+
const localVarHeaderParameter = {} as any;
|
|
11219
|
+
const localVarQueryParameter = {} as any;
|
|
11220
|
+
|
|
11221
|
+
// authentication BasicAuth required
|
|
11222
|
+
// http basic authentication required
|
|
11223
|
+
setBasicAuthToObject(localVarRequestOptions, configuration)
|
|
11224
|
+
|
|
11225
|
+
// authentication BearerAuth required
|
|
11226
|
+
// http bearer authentication required
|
|
11227
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
11228
|
+
|
|
11229
|
+
|
|
11230
|
+
|
|
11231
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
11232
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
11233
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
11234
|
+
|
|
11235
|
+
return {
|
|
11236
|
+
url: toPathString(localVarUrlObj),
|
|
11237
|
+
options: localVarRequestOptions,
|
|
11238
|
+
};
|
|
11239
|
+
},
|
|
11240
|
+
/**
|
|
11241
|
+
* List details of all existing programs.
|
|
11242
|
+
* @summary List programs
|
|
11243
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
11244
|
+
* @param {*} [options] Override http request option.
|
|
11245
|
+
* @throws {RequiredError}
|
|
11246
|
+
*/
|
|
11247
|
+
listPrograms: async (cell: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
11248
|
+
// verify required parameter 'cell' is not null or undefined
|
|
11249
|
+
assertParamExists('listPrograms', 'cell', cell)
|
|
11250
|
+
const localVarPath = `/experimental/cells/{cell}/programs`
|
|
11251
|
+
.replace(`{${"cell"}}`, encodeURIComponent(String(cell)));
|
|
11252
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
11253
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
11254
|
+
let baseOptions;
|
|
11255
|
+
if (configuration) {
|
|
11256
|
+
baseOptions = configuration.baseOptions;
|
|
11257
|
+
}
|
|
11258
|
+
|
|
11259
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
11260
|
+
const localVarHeaderParameter = {} as any;
|
|
11261
|
+
const localVarQueryParameter = {} as any;
|
|
11262
|
+
|
|
11263
|
+
// authentication BasicAuth required
|
|
11264
|
+
// http basic authentication required
|
|
11265
|
+
setBasicAuthToObject(localVarRequestOptions, configuration)
|
|
11266
|
+
|
|
11267
|
+
// authentication BearerAuth required
|
|
11268
|
+
// http bearer authentication required
|
|
11269
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
11270
|
+
|
|
11271
|
+
|
|
11272
|
+
|
|
11273
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
11274
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
11275
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
11276
|
+
|
|
11277
|
+
return {
|
|
11278
|
+
url: toPathString(localVarUrlObj),
|
|
11279
|
+
options: localVarRequestOptions,
|
|
11280
|
+
};
|
|
11281
|
+
},
|
|
11282
|
+
/**
|
|
11283
|
+
* This endpoint starts a new program execution. The program will be executed asynchronously.
|
|
11284
|
+
* @summary Start the program
|
|
11285
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
11286
|
+
* @param {string} program
|
|
11287
|
+
* @param {ProgramStartRequest} programStartRequest
|
|
11288
|
+
* @param {*} [options] Override http request option.
|
|
11289
|
+
* @throws {RequiredError}
|
|
11290
|
+
*/
|
|
11291
|
+
startProgram: async (cell: string, program: string, programStartRequest: ProgramStartRequest, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
11292
|
+
// verify required parameter 'cell' is not null or undefined
|
|
11293
|
+
assertParamExists('startProgram', 'cell', cell)
|
|
11294
|
+
// verify required parameter 'program' is not null or undefined
|
|
11295
|
+
assertParamExists('startProgram', 'program', program)
|
|
11296
|
+
// verify required parameter 'programStartRequest' is not null or undefined
|
|
11297
|
+
assertParamExists('startProgram', 'programStartRequest', programStartRequest)
|
|
11298
|
+
const localVarPath = `/experimental/cells/{cell}/programs/{program}/start`
|
|
11299
|
+
.replace(`{${"cell"}}`, encodeURIComponent(String(cell)))
|
|
11300
|
+
.replace(`{${"program"}}`, encodeURIComponent(String(program)));
|
|
11301
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
11302
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
11303
|
+
let baseOptions;
|
|
11304
|
+
if (configuration) {
|
|
11305
|
+
baseOptions = configuration.baseOptions;
|
|
11306
|
+
}
|
|
11307
|
+
|
|
11308
|
+
const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
|
|
11309
|
+
const localVarHeaderParameter = {} as any;
|
|
11310
|
+
const localVarQueryParameter = {} as any;
|
|
11311
|
+
|
|
11312
|
+
// authentication BasicAuth required
|
|
11313
|
+
// http basic authentication required
|
|
11314
|
+
setBasicAuthToObject(localVarRequestOptions, configuration)
|
|
11315
|
+
|
|
11316
|
+
// authentication BearerAuth required
|
|
11317
|
+
// http bearer authentication required
|
|
11318
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
11319
|
+
|
|
11320
|
+
|
|
11321
|
+
|
|
11322
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
11323
|
+
|
|
11324
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
11325
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
11326
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
11327
|
+
localVarRequestOptions.data = serializeDataIfNeeded(programStartRequest, localVarRequestOptions, configuration)
|
|
11328
|
+
|
|
11329
|
+
return {
|
|
11330
|
+
url: toPathString(localVarUrlObj),
|
|
11331
|
+
options: localVarRequestOptions,
|
|
11332
|
+
};
|
|
11333
|
+
},
|
|
11334
|
+
/**
|
|
11335
|
+
* Stop a specific program run.
|
|
11336
|
+
* @summary Stop program run
|
|
11337
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
11338
|
+
* @param {string} program
|
|
11339
|
+
* @param {*} [options] Override http request option.
|
|
11340
|
+
* @throws {RequiredError}
|
|
11341
|
+
*/
|
|
11342
|
+
stopProgram: async (cell: string, program: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
11343
|
+
// verify required parameter 'cell' is not null or undefined
|
|
11344
|
+
assertParamExists('stopProgram', 'cell', cell)
|
|
11345
|
+
// verify required parameter 'program' is not null or undefined
|
|
11346
|
+
assertParamExists('stopProgram', 'program', program)
|
|
11347
|
+
const localVarPath = `/experimental/cells/{cell}/programs/{program}/stop`
|
|
11348
|
+
.replace(`{${"cell"}}`, encodeURIComponent(String(cell)))
|
|
11349
|
+
.replace(`{${"program"}}`, encodeURIComponent(String(program)));
|
|
11350
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
11351
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
11352
|
+
let baseOptions;
|
|
11353
|
+
if (configuration) {
|
|
11354
|
+
baseOptions = configuration.baseOptions;
|
|
11355
|
+
}
|
|
11356
|
+
|
|
11357
|
+
const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
|
|
11358
|
+
const localVarHeaderParameter = {} as any;
|
|
11359
|
+
const localVarQueryParameter = {} as any;
|
|
11360
|
+
|
|
11361
|
+
// authentication BasicAuth required
|
|
11362
|
+
// http basic authentication required
|
|
11363
|
+
setBasicAuthToObject(localVarRequestOptions, configuration)
|
|
11364
|
+
|
|
11365
|
+
// authentication BearerAuth required
|
|
11366
|
+
// http bearer authentication required
|
|
11367
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
11368
|
+
|
|
11369
|
+
|
|
11370
|
+
|
|
11371
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
11372
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
11373
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
11374
|
+
|
|
11375
|
+
return {
|
|
11376
|
+
url: toPathString(localVarUrlObj),
|
|
11377
|
+
options: localVarRequestOptions,
|
|
11378
|
+
};
|
|
11379
|
+
},
|
|
11380
|
+
}
|
|
11381
|
+
};
|
|
11382
|
+
|
|
11383
|
+
/**
|
|
11384
|
+
* ProgramApi - functional programming interface
|
|
11385
|
+
* @export
|
|
11386
|
+
*/
|
|
11387
|
+
export const ProgramApiFp = function(configuration?: Configuration) {
|
|
11388
|
+
const localVarAxiosParamCreator = ProgramApiAxiosParamCreator(configuration)
|
|
11389
|
+
return {
|
|
11390
|
+
/**
|
|
11391
|
+
* Get details of a program.
|
|
11392
|
+
* @summary Get program
|
|
11393
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
11394
|
+
* @param {string} program
|
|
11395
|
+
* @param {*} [options] Override http request option.
|
|
11396
|
+
* @throws {RequiredError}
|
|
11397
|
+
*/
|
|
11398
|
+
async getProgram(cell: string, program: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Program>> {
|
|
11399
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.getProgram(cell, program, options);
|
|
11400
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
11401
|
+
const localVarOperationServerBasePath = operationServerMap['ProgramApi.getProgram']?.[localVarOperationServerIndex]?.url;
|
|
11402
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
11403
|
+
},
|
|
11404
|
+
/**
|
|
11405
|
+
* List details of all existing programs.
|
|
11406
|
+
* @summary List programs
|
|
11407
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
11408
|
+
* @param {*} [options] Override http request option.
|
|
11409
|
+
* @throws {RequiredError}
|
|
11410
|
+
*/
|
|
11411
|
+
async listPrograms(cell: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<Program>>> {
|
|
11412
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.listPrograms(cell, options);
|
|
11413
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
11414
|
+
const localVarOperationServerBasePath = operationServerMap['ProgramApi.listPrograms']?.[localVarOperationServerIndex]?.url;
|
|
11415
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
11416
|
+
},
|
|
11417
|
+
/**
|
|
11418
|
+
* This endpoint starts a new program execution. The program will be executed asynchronously.
|
|
11419
|
+
* @summary Start the program
|
|
11420
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
11421
|
+
* @param {string} program
|
|
11422
|
+
* @param {ProgramStartRequest} programStartRequest
|
|
11423
|
+
* @param {*} [options] Override http request option.
|
|
11424
|
+
* @throws {RequiredError}
|
|
11425
|
+
*/
|
|
11426
|
+
async startProgram(cell: string, program: string, programStartRequest: ProgramStartRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ProgramRun>> {
|
|
11427
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.startProgram(cell, program, programStartRequest, options);
|
|
11428
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
11429
|
+
const localVarOperationServerBasePath = operationServerMap['ProgramApi.startProgram']?.[localVarOperationServerIndex]?.url;
|
|
11430
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
11431
|
+
},
|
|
11432
|
+
/**
|
|
11433
|
+
* Stop a specific program run.
|
|
11434
|
+
* @summary Stop program run
|
|
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
|
+
async stopProgram(cell: string, program: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> {
|
|
11441
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.stopProgram(cell, program, options);
|
|
11442
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
11443
|
+
const localVarOperationServerBasePath = operationServerMap['ProgramApi.stopProgram']?.[localVarOperationServerIndex]?.url;
|
|
11444
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
11445
|
+
},
|
|
11446
|
+
}
|
|
11447
|
+
};
|
|
11448
|
+
|
|
11449
|
+
/**
|
|
11450
|
+
* ProgramApi - factory interface
|
|
11451
|
+
* @export
|
|
11452
|
+
*/
|
|
11453
|
+
export const ProgramApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
|
|
11454
|
+
const localVarFp = ProgramApiFp(configuration)
|
|
11455
|
+
return {
|
|
11456
|
+
/**
|
|
11457
|
+
* Get details of a program.
|
|
11458
|
+
* @summary Get program
|
|
11459
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
11460
|
+
* @param {string} program
|
|
11461
|
+
* @param {*} [options] Override http request option.
|
|
11462
|
+
* @throws {RequiredError}
|
|
11463
|
+
*/
|
|
11464
|
+
getProgram(cell: string, program: string, options?: RawAxiosRequestConfig): AxiosPromise<Program> {
|
|
11465
|
+
return localVarFp.getProgram(cell, program, options).then((request) => request(axios, basePath));
|
|
11466
|
+
},
|
|
11467
|
+
/**
|
|
11468
|
+
* List details of all existing programs.
|
|
11469
|
+
* @summary List programs
|
|
11470
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
11471
|
+
* @param {*} [options] Override http request option.
|
|
11472
|
+
* @throws {RequiredError}
|
|
11473
|
+
*/
|
|
11474
|
+
listPrograms(cell: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<Program>> {
|
|
11475
|
+
return localVarFp.listPrograms(cell, options).then((request) => request(axios, basePath));
|
|
11476
|
+
},
|
|
11477
|
+
/**
|
|
11478
|
+
* This endpoint starts a new program execution. The program will be executed asynchronously.
|
|
11479
|
+
* @summary Start the program
|
|
11480
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
11481
|
+
* @param {string} program
|
|
11482
|
+
* @param {ProgramStartRequest} programStartRequest
|
|
11483
|
+
* @param {*} [options] Override http request option.
|
|
11484
|
+
* @throws {RequiredError}
|
|
11485
|
+
*/
|
|
11486
|
+
startProgram(cell: string, program: string, programStartRequest: ProgramStartRequest, options?: RawAxiosRequestConfig): AxiosPromise<ProgramRun> {
|
|
11487
|
+
return localVarFp.startProgram(cell, program, programStartRequest, options).then((request) => request(axios, basePath));
|
|
11488
|
+
},
|
|
11489
|
+
/**
|
|
11490
|
+
* Stop a specific program run.
|
|
11491
|
+
* @summary Stop program run
|
|
11492
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
11493
|
+
* @param {string} program
|
|
11494
|
+
* @param {*} [options] Override http request option.
|
|
11495
|
+
* @throws {RequiredError}
|
|
11496
|
+
*/
|
|
11497
|
+
stopProgram(cell: string, program: string, options?: RawAxiosRequestConfig): AxiosPromise<void> {
|
|
11498
|
+
return localVarFp.stopProgram(cell, program, options).then((request) => request(axios, basePath));
|
|
11499
|
+
},
|
|
11500
|
+
};
|
|
11501
|
+
};
|
|
11502
|
+
|
|
11503
|
+
/**
|
|
11504
|
+
* ProgramApi - object-oriented interface
|
|
11505
|
+
* @export
|
|
11506
|
+
* @class ProgramApi
|
|
11507
|
+
* @extends {BaseAPI}
|
|
11508
|
+
*/
|
|
11509
|
+
export class ProgramApi extends BaseAPI {
|
|
11510
|
+
/**
|
|
11511
|
+
* Get details of a program.
|
|
11512
|
+
* @summary Get program
|
|
11513
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
11514
|
+
* @param {string} program
|
|
11515
|
+
* @param {*} [options] Override http request option.
|
|
11516
|
+
* @throws {RequiredError}
|
|
11517
|
+
* @memberof ProgramApi
|
|
11518
|
+
*/
|
|
11519
|
+
public getProgram(cell: string, program: string, options?: RawAxiosRequestConfig) {
|
|
11520
|
+
return ProgramApiFp(this.configuration).getProgram(cell, program, options).then((request) => request(this.axios, this.basePath));
|
|
11521
|
+
}
|
|
11522
|
+
|
|
11523
|
+
/**
|
|
11524
|
+
* List details of all existing programs.
|
|
11525
|
+
* @summary List programs
|
|
11526
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
11527
|
+
* @param {*} [options] Override http request option.
|
|
11528
|
+
* @throws {RequiredError}
|
|
11529
|
+
* @memberof ProgramApi
|
|
11530
|
+
*/
|
|
11531
|
+
public listPrograms(cell: string, options?: RawAxiosRequestConfig) {
|
|
11532
|
+
return ProgramApiFp(this.configuration).listPrograms(cell, options).then((request) => request(this.axios, this.basePath));
|
|
11533
|
+
}
|
|
11534
|
+
|
|
11535
|
+
/**
|
|
11536
|
+
* This endpoint starts a new program execution. The program will be executed asynchronously.
|
|
11537
|
+
* @summary Start the program
|
|
11538
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
11539
|
+
* @param {string} program
|
|
11540
|
+
* @param {ProgramStartRequest} programStartRequest
|
|
11541
|
+
* @param {*} [options] Override http request option.
|
|
11542
|
+
* @throws {RequiredError}
|
|
11543
|
+
* @memberof ProgramApi
|
|
11544
|
+
*/
|
|
11545
|
+
public startProgram(cell: string, program: string, programStartRequest: ProgramStartRequest, options?: RawAxiosRequestConfig) {
|
|
11546
|
+
return ProgramApiFp(this.configuration).startProgram(cell, program, programStartRequest, options).then((request) => request(this.axios, this.basePath));
|
|
11547
|
+
}
|
|
11548
|
+
|
|
11549
|
+
/**
|
|
11550
|
+
* Stop a specific program run.
|
|
11551
|
+
* @summary Stop program run
|
|
11552
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
11553
|
+
* @param {string} program
|
|
11554
|
+
* @param {*} [options] Override http request option.
|
|
11555
|
+
* @throws {RequiredError}
|
|
11556
|
+
* @memberof ProgramApi
|
|
11557
|
+
*/
|
|
11558
|
+
public stopProgram(cell: string, program: string, options?: RawAxiosRequestConfig) {
|
|
11559
|
+
return ProgramApiFp(this.configuration).stopProgram(cell, program, options).then((request) => request(this.axios, this.basePath));
|
|
11560
|
+
}
|
|
11561
|
+
}
|
|
11562
|
+
|
|
11563
|
+
|
|
11564
|
+
|
|
10921
11565
|
/**
|
|
10922
11566
|
* StoreCollisionComponentsApi - axios parameter creator
|
|
10923
11567
|
* @export
|
|
@@ -11243,7 +11887,7 @@ export const StoreCollisionComponentsApiAxiosParamCreator = function (configurat
|
|
|
11243
11887
|
};
|
|
11244
11888
|
},
|
|
11245
11889
|
/**
|
|
11246
|
-
* Returns
|
|
11890
|
+
* Returns all stored colliders.
|
|
11247
11891
|
* @summary List Colliders
|
|
11248
11892
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
11249
11893
|
* @param {*} [options] Override http request option.
|
|
@@ -11590,7 +12234,7 @@ export const StoreCollisionComponentsApiFp = function(configuration?: Configurat
|
|
|
11590
12234
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
11591
12235
|
},
|
|
11592
12236
|
/**
|
|
11593
|
-
* Returns
|
|
12237
|
+
* Returns all stored colliders.
|
|
11594
12238
|
* @summary List Colliders
|
|
11595
12239
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
11596
12240
|
* @param {*} [options] Override http request option.
|
|
@@ -11747,7 +12391,7 @@ export const StoreCollisionComponentsApiFactory = function (configuration?: Conf
|
|
|
11747
12391
|
return localVarFp.listCollisionLinkChains(cell, options).then((request) => request(axios, basePath));
|
|
11748
12392
|
},
|
|
11749
12393
|
/**
|
|
11750
|
-
* Returns
|
|
12394
|
+
* Returns all stored colliders.
|
|
11751
12395
|
* @summary List Colliders
|
|
11752
12396
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
11753
12397
|
* @param {*} [options] Override http request option.
|
|
@@ -11903,7 +12547,7 @@ export class StoreCollisionComponentsApi extends BaseAPI {
|
|
|
11903
12547
|
}
|
|
11904
12548
|
|
|
11905
12549
|
/**
|
|
11906
|
-
* Returns
|
|
12550
|
+
* Returns all stored colliders.
|
|
11907
12551
|
* @summary List Colliders
|
|
11908
12552
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
11909
12553
|
* @param {*} [options] Override http request option.
|