@wandelbots/nova-api 25.8.0-dev.6 → 25.8.0-dev.60
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/v1/api.d.ts +1 -1
- package/v1/api.js +1 -1
- package/v1/api.js.map +1 -1
- package/v1/api.ts +1 -1
- package/v2/api.d.ts +565 -152
- package/v2/api.js +402 -51
- package/v2/api.js.map +1 -1
- package/v2/api.ts +774 -148
package/v2/api.ts
CHANGED
|
@@ -106,7 +106,7 @@ export interface AddTrajectoryError {
|
|
|
106
106
|
*/
|
|
107
107
|
'message'?: string;
|
|
108
108
|
/**
|
|
109
|
-
* The
|
|
109
|
+
* Location on trajectory where the execution will start. The default value is the start (forward movement) or end (backward movement) of the trajectory. If you want to start your movement from an arbitrary location, e.g. in combination with [streamMoveToTrajectoryViaJointPTP](streamMoveToTrajectoryViaJointPTP), set the location by respecting the following format: - The location is a scalar value that defines a position along a path, typically ranging from 0 to `n`, where `n` denotes the number of motion commands - Each integer value of the location corresponds to a specific motion command, while non-integer values interpolate positions within the segments. - The location is calculated from the joint path
|
|
110
110
|
* @type {number}
|
|
111
111
|
* @memberof AddTrajectoryError
|
|
112
112
|
*/
|
|
@@ -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
|
-
*
|
|
389
|
-
* @type {
|
|
388
|
+
* Used to enable IP communication through the same physical ethernet interface while PROFINET driver is active.
|
|
389
|
+
* @type {BusIOProfinetNetwork}
|
|
390
390
|
* @memberof BusIOProfinet
|
|
391
391
|
*/
|
|
392
|
-
'
|
|
392
|
+
'network_config'?: BusIOProfinetNetwork;
|
|
393
393
|
/**
|
|
394
|
-
*
|
|
395
|
-
* @type {
|
|
394
|
+
* IP address of the PLC to establish PROFINET communication with. The IP address is used to configure the host machine\'s firewall. The firewall configuration is applied while the BUS input/output service is active. Without proper firewall configuration, PROFINET device discovery, configuration exchanges, and real-time cyclic data communication will fail.
|
|
395
|
+
* @type {string}
|
|
396
396
|
* @memberof BusIOProfinet
|
|
397
397
|
*/
|
|
398
|
-
'
|
|
398
|
+
'plc_ip': string;
|
|
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
|
|
@@ -1941,7 +2005,7 @@ export interface IOIntegerValue {
|
|
|
1941
2005
|
*/
|
|
1942
2006
|
'io': string;
|
|
1943
2007
|
/**
|
|
1944
|
-
* Value of an input/output with integer representation. > The integral value is transmitted as a string to avoid precision loss during conversion to JSON. >
|
|
2008
|
+
* Value of an input/output with integer representation. > The integral value is transmitted as a string to avoid precision loss during conversion to JSON. > Recommended: Use int64 in your implementation. If you want to interact with int64 in numbers, > JS bigint libraries can help you to parse the string into an integral value.
|
|
1945
2009
|
* @type {string}
|
|
1946
2010
|
* @memberof IOIntegerValue
|
|
1947
2011
|
*/
|
|
@@ -2068,24 +2132,12 @@ export interface InitializeJoggingRequest {
|
|
|
2068
2132
|
* @memberof InitializeJoggingRequest
|
|
2069
2133
|
*/
|
|
2070
2134
|
'tcp'?: string;
|
|
2071
|
-
/**
|
|
2072
|
-
* Update rate for the response message in milliseconds (ms). Recommendation: As Wandelbots NOVA updates states in the controller\'s step rate, use either the controller\'s step rate or a multiple of it. Wandelbots NOVA will not interpolate the state but round it to the nearest step rate below the configured response rate. Use [getOptimizerConfiguration](getOptimizerConfiguration) to get the controller\'s step rate. Minimal response rate is the step rate of the controller.
|
|
2073
|
-
* @type {number}
|
|
2074
|
-
* @memberof InitializeJoggingRequest
|
|
2075
|
-
*/
|
|
2076
|
-
'response_rate'?: number;
|
|
2077
2135
|
/**
|
|
2078
2136
|
* Unique identifier addressing a coordinate system to which the responses are transformed. If not set, world coordinate system is used.
|
|
2079
2137
|
* @type {string}
|
|
2080
2138
|
* @memberof InitializeJoggingRequest
|
|
2081
2139
|
*/
|
|
2082
2140
|
'response_coordinate_system'?: string;
|
|
2083
|
-
/**
|
|
2084
|
-
* Defines an input/output that is listened to during the movement. Execution pauses if the defined comparator evaluates to `true`.
|
|
2085
|
-
* @type {string}
|
|
2086
|
-
* @memberof InitializeJoggingRequest
|
|
2087
|
-
*/
|
|
2088
|
-
'pause_on_io'?: string;
|
|
2089
2141
|
}
|
|
2090
2142
|
|
|
2091
2143
|
export const InitializeJoggingRequestMessageTypeEnum = {
|
|
@@ -2144,12 +2196,6 @@ export interface InitializeMovementRequest {
|
|
|
2144
2196
|
* @memberof InitializeMovementRequest
|
|
2145
2197
|
*/
|
|
2146
2198
|
'initial_location'?: number;
|
|
2147
|
-
/**
|
|
2148
|
-
* Update rate for the response message in milliseconds (ms). Default is 200 ms. Recommendation: As Wandelbots NOVA updates states in the controller\'s step rate, use either the controller\'s step rate or a multiple of it. Wandelbots NOVA will not interpolate the state but rather round it to the nearest step rate below the configured response rate. Minimal response rate is the step rate of controller.
|
|
2149
|
-
* @type {number}
|
|
2150
|
-
* @memberof InitializeMovementRequest
|
|
2151
|
-
*/
|
|
2152
|
-
'response_rate'?: number;
|
|
2153
2199
|
/**
|
|
2154
2200
|
* Unique identifier addressing a coordinate system to which the responses are transformed. If not set, world coordinate system is used.
|
|
2155
2201
|
* @type {string}
|
|
@@ -2204,7 +2250,7 @@ export const InitializeMovementResponseKindEnum = {
|
|
|
2204
2250
|
export type InitializeMovementResponseKindEnum = typeof InitializeMovementResponseKindEnum[keyof typeof InitializeMovementResponseKindEnum];
|
|
2205
2251
|
|
|
2206
2252
|
/**
|
|
2207
|
-
* Value of an input/output with integer representation. > The integral value is transmitted as a string to avoid precision loss during conversion to JSON. >
|
|
2253
|
+
* Value of an input/output with integer representation. > The integral value is transmitted as a string to avoid precision loss during conversion to JSON. > Recommended: Use int64 in your implementation. If you want to interact with int64 in numbers, > JS bigint libraries can help you to parse the string into an integral value.
|
|
2208
2254
|
* @export
|
|
2209
2255
|
* @interface IntegerValue
|
|
2210
2256
|
*/
|
|
@@ -2581,7 +2627,7 @@ export interface JointTrajectory {
|
|
|
2581
2627
|
*/
|
|
2582
2628
|
'times': Array<number>;
|
|
2583
2629
|
/**
|
|
2584
|
-
*
|
|
2630
|
+
*
|
|
2585
2631
|
* @type {Array<number>}
|
|
2586
2632
|
* @memberof JointTrajectory
|
|
2587
2633
|
*/
|
|
@@ -2801,25 +2847,6 @@ export const LicenseStatusEnum = {
|
|
|
2801
2847
|
export type LicenseStatusEnum = typeof LicenseStatusEnum[keyof typeof LicenseStatusEnum];
|
|
2802
2848
|
|
|
2803
2849
|
|
|
2804
|
-
/**
|
|
2805
|
-
*
|
|
2806
|
-
* @export
|
|
2807
|
-
* @interface LimitConfig
|
|
2808
|
-
*/
|
|
2809
|
-
export interface LimitConfig {
|
|
2810
|
-
/**
|
|
2811
|
-
*
|
|
2812
|
-
* @type {LimitSet}
|
|
2813
|
-
* @memberof LimitConfig
|
|
2814
|
-
*/
|
|
2815
|
-
'physical_limits'?: LimitSet;
|
|
2816
|
-
/**
|
|
2817
|
-
*
|
|
2818
|
-
* @type {OperationLimits}
|
|
2819
|
-
* @memberof LimitConfig
|
|
2820
|
-
*/
|
|
2821
|
-
'operation_limits'?: OperationLimits;
|
|
2822
|
-
}
|
|
2823
2850
|
/**
|
|
2824
2851
|
* The upper_limit must be greater then the lower_limit.
|
|
2825
2852
|
* @export
|
|
@@ -2869,6 +2896,12 @@ export interface LimitSet {
|
|
|
2869
2896
|
* @memberof LimitSet
|
|
2870
2897
|
*/
|
|
2871
2898
|
'flange'?: CartesianLimits;
|
|
2899
|
+
/**
|
|
2900
|
+
*
|
|
2901
|
+
* @type {JointLimits}
|
|
2902
|
+
* @memberof LimitSet
|
|
2903
|
+
*/
|
|
2904
|
+
'coupled_shoulder_elbow_joint'?: JointLimits;
|
|
2872
2905
|
}
|
|
2873
2906
|
/**
|
|
2874
2907
|
* If a limit is not set, the default value will be used.
|
|
@@ -2944,13 +2977,13 @@ export type Manufacturer = typeof Manufacturer[keyof typeof Manufacturer];
|
|
|
2944
2977
|
|
|
2945
2978
|
|
|
2946
2979
|
/**
|
|
2947
|
-
*
|
|
2980
|
+
*
|
|
2948
2981
|
* @export
|
|
2949
2982
|
* @interface MidpointInsertionAlgorithm
|
|
2950
2983
|
*/
|
|
2951
2984
|
export interface MidpointInsertionAlgorithm {
|
|
2952
2985
|
/**
|
|
2953
|
-
* Algorithm discriminator.
|
|
2986
|
+
* 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
2987
|
* @type {string}
|
|
2955
2988
|
* @memberof MidpointInsertionAlgorithm
|
|
2956
2989
|
*/
|
|
@@ -3043,13 +3076,13 @@ export interface MotionGroupDescription {
|
|
|
3043
3076
|
* @type {Pose}
|
|
3044
3077
|
* @memberof MotionGroupDescription
|
|
3045
3078
|
*/
|
|
3046
|
-
'mounting'
|
|
3079
|
+
'mounting'?: Pose;
|
|
3047
3080
|
/**
|
|
3048
3081
|
* Maps a TCP name to its offset relative to the flange coordinate system. Key must be a TCP identifier. Values are TcpOffsets.
|
|
3049
3082
|
* @type {{ [key: string]: TcpOffset; }}
|
|
3050
3083
|
* @memberof MotionGroupDescription
|
|
3051
3084
|
*/
|
|
3052
|
-
'tcps'
|
|
3085
|
+
'tcps'?: { [key: string]: TcpOffset; };
|
|
3053
3086
|
/**
|
|
3054
3087
|
* A collection of identifiable colliders.
|
|
3055
3088
|
* @type {{ [key: string]: Collider; }}
|
|
@@ -3070,10 +3103,10 @@ export interface MotionGroupDescription {
|
|
|
3070
3103
|
'safety_tool_colliders'?: { [key: string]: { [key: string]: Collider; }; };
|
|
3071
3104
|
/**
|
|
3072
3105
|
*
|
|
3073
|
-
* @type {
|
|
3106
|
+
* @type {OperationLimits}
|
|
3074
3107
|
* @memberof MotionGroupDescription
|
|
3075
3108
|
*/
|
|
3076
|
-
'
|
|
3109
|
+
'operation_limits': OperationLimits;
|
|
3077
3110
|
/**
|
|
3078
3111
|
* Maps a payload name to its configuration. Key must be a payload identifier. Values are payload objects.
|
|
3079
3112
|
* @type {{ [key: string]: Payload; }}
|
|
@@ -3849,11 +3882,11 @@ export interface PlanTrajectoryFailedResponse {
|
|
|
3849
3882
|
*/
|
|
3850
3883
|
'error_feedback': PlanTrajectoryFailedResponseErrorFeedback;
|
|
3851
3884
|
/**
|
|
3852
|
-
*
|
|
3885
|
+
* Location on trajectory where the execution will start. The default value is the start (forward movement) or end (backward movement) of the trajectory. If you want to start your movement from an arbitrary location, e.g. in combination with [streamMoveToTrajectoryViaJointPTP](streamMoveToTrajectoryViaJointPTP), set the location by respecting the following format: - The location is a scalar value that defines a position along a path, typically ranging from 0 to `n`, where `n` denotes the number of motion commands - Each integer value of the location corresponds to a specific motion command, while non-integer values interpolate positions within the segments. - The location is calculated from the joint path
|
|
3853
3886
|
* @type {number}
|
|
3854
3887
|
* @memberof PlanTrajectoryFailedResponse
|
|
3855
3888
|
*/
|
|
3856
|
-
'error_location_on_trajectory'
|
|
3889
|
+
'error_location_on_trajectory': number;
|
|
3857
3890
|
/**
|
|
3858
3891
|
* The joint trajectory from the start joint position to the error.
|
|
3859
3892
|
* @type {JointTrajectory}
|
|
@@ -4071,17 +4104,17 @@ export interface ProfinetDescription {
|
|
|
4071
4104
|
*/
|
|
4072
4105
|
'slots'?: Array<ProfinetSlotDescription>;
|
|
4073
4106
|
/**
|
|
4074
|
-
* Name of the PROFINET device
|
|
4107
|
+
* 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
4108
|
* @type {string}
|
|
4076
4109
|
* @memberof ProfinetDescription
|
|
4077
4110
|
*/
|
|
4078
4111
|
'device_name'?: string;
|
|
4079
4112
|
/**
|
|
4080
|
-
*
|
|
4081
|
-
* @type {
|
|
4113
|
+
*
|
|
4114
|
+
* @type {BusIOProfinetIpConfig}
|
|
4082
4115
|
* @memberof ProfinetDescription
|
|
4083
4116
|
*/
|
|
4084
|
-
'
|
|
4117
|
+
'ip_config'?: BusIOProfinetIpConfig;
|
|
4085
4118
|
}
|
|
4086
4119
|
/**
|
|
4087
4120
|
*
|
|
@@ -4090,7 +4123,7 @@ export interface ProfinetDescription {
|
|
|
4090
4123
|
*/
|
|
4091
4124
|
export interface ProfinetIO {
|
|
4092
4125
|
/**
|
|
4093
|
-
* The name of the input/output
|
|
4126
|
+
* 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
4127
|
* @type {string}
|
|
4095
4128
|
* @memberof ProfinetIO
|
|
4096
4129
|
*/
|
|
@@ -4102,25 +4135,25 @@ export interface ProfinetIO {
|
|
|
4102
4135
|
*/
|
|
4103
4136
|
'type': ProfinetIOTypeEnum;
|
|
4104
4137
|
/**
|
|
4105
|
-
* The direction of the input/output
|
|
4138
|
+
* 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
4139
|
* @type {ProfinetIODirection}
|
|
4107
4140
|
* @memberof ProfinetIO
|
|
4108
4141
|
*/
|
|
4109
4142
|
'direction': ProfinetIODirection;
|
|
4110
4143
|
/**
|
|
4111
|
-
* The byte address of the input/output
|
|
4144
|
+
* 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
4145
|
* @type {number}
|
|
4113
4146
|
* @memberof ProfinetIO
|
|
4114
4147
|
*/
|
|
4115
4148
|
'byte_address': number;
|
|
4116
4149
|
/**
|
|
4117
|
-
* The bit address of the input/output
|
|
4150
|
+
* 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
4151
|
* @type {number}
|
|
4119
4152
|
* @memberof ProfinetIO
|
|
4120
4153
|
*/
|
|
4121
4154
|
'bit_address'?: number;
|
|
4122
4155
|
/**
|
|
4123
|
-
* The unique identifier for the input/output value. This identifier is used to reference the specific input/output in the NOVA
|
|
4156
|
+
* 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
4157
|
* @type {string}
|
|
4125
4158
|
* @memberof ProfinetIO
|
|
4126
4159
|
*/
|
|
@@ -4135,7 +4168,7 @@ export interface ProfinetIO {
|
|
|
4135
4168
|
*/
|
|
4136
4169
|
export interface ProfinetIOData {
|
|
4137
4170
|
/**
|
|
4138
|
-
* The name of the input/output
|
|
4171
|
+
* 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
4172
|
* @type {string}
|
|
4140
4173
|
* @memberof ProfinetIOData
|
|
4141
4174
|
*/
|
|
@@ -4147,19 +4180,19 @@ export interface ProfinetIOData {
|
|
|
4147
4180
|
*/
|
|
4148
4181
|
'type': ProfinetIOTypeEnum;
|
|
4149
4182
|
/**
|
|
4150
|
-
* The direction of the input/output
|
|
4183
|
+
* 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
4184
|
* @type {ProfinetIODirection}
|
|
4152
4185
|
* @memberof ProfinetIOData
|
|
4153
4186
|
*/
|
|
4154
4187
|
'direction': ProfinetIODirection;
|
|
4155
4188
|
/**
|
|
4156
|
-
* The byte address of the input/output
|
|
4189
|
+
* 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
4190
|
* @type {number}
|
|
4158
4191
|
* @memberof ProfinetIOData
|
|
4159
4192
|
*/
|
|
4160
4193
|
'byte_address': number;
|
|
4161
4194
|
/**
|
|
4162
|
-
* The bit address of the input/output
|
|
4195
|
+
* 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
4196
|
* @type {number}
|
|
4164
4197
|
* @memberof ProfinetIOData
|
|
4165
4198
|
*/
|
|
@@ -4168,7 +4201,7 @@ export interface ProfinetIOData {
|
|
|
4168
4201
|
|
|
4169
4202
|
|
|
4170
4203
|
/**
|
|
4171
|
-
*
|
|
4204
|
+
* 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
4205
|
* @export
|
|
4173
4206
|
* @enum {string}
|
|
4174
4207
|
*/
|
|
@@ -4183,7 +4216,7 @@ export type ProfinetIODirection = typeof ProfinetIODirection[keyof typeof Profin
|
|
|
4183
4216
|
|
|
4184
4217
|
|
|
4185
4218
|
/**
|
|
4186
|
-
* Value type of the PROFINET input/output.
|
|
4219
|
+
* Value type of the PROFINET input/output variable. Is used to interpret the corresponding bits correctly.
|
|
4187
4220
|
* @export
|
|
4188
4221
|
* @enum {string}
|
|
4189
4222
|
*/
|
|
@@ -4211,38 +4244,38 @@ export type ProfinetIOTypeEnum = typeof ProfinetIOTypeEnum[keyof typeof Profinet
|
|
|
4211
4244
|
*/
|
|
4212
4245
|
export interface ProfinetInputOutputConfig {
|
|
4213
4246
|
/**
|
|
4214
|
-
* Content of the input
|
|
4247
|
+
* 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
4248
|
* @type {string}
|
|
4216
4249
|
* @memberof ProfinetInputOutputConfig
|
|
4217
4250
|
*/
|
|
4218
4251
|
'config': string;
|
|
4219
4252
|
/**
|
|
4220
|
-
* Offset in bytes for the input
|
|
4253
|
+
* 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
4254
|
* @type {number}
|
|
4222
4255
|
* @memberof ProfinetInputOutputConfig
|
|
4223
4256
|
*/
|
|
4224
4257
|
'input_offset': number;
|
|
4225
4258
|
/**
|
|
4226
|
-
* Offset in bytes for the output
|
|
4259
|
+
* 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
4260
|
* @type {number}
|
|
4228
4261
|
* @memberof ProfinetInputOutputConfig
|
|
4229
4262
|
*/
|
|
4230
4263
|
'output_offset': number;
|
|
4231
4264
|
}
|
|
4232
4265
|
/**
|
|
4233
|
-
*
|
|
4266
|
+
* 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
4267
|
* @export
|
|
4235
4268
|
* @interface ProfinetSlotDescription
|
|
4236
4269
|
*/
|
|
4237
4270
|
export interface ProfinetSlotDescription {
|
|
4238
4271
|
/**
|
|
4239
|
-
* The number of the PROFINET slot.
|
|
4272
|
+
* 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
4273
|
* @type {number}
|
|
4241
4274
|
* @memberof ProfinetSlotDescription
|
|
4242
4275
|
*/
|
|
4243
4276
|
'number': number;
|
|
4244
4277
|
/**
|
|
4245
|
-
* The API number of the PROFINET input
|
|
4278
|
+
* The application process identifier (API) number of the PROFINET input. The API identifies the application relation (AR) that is using the slot.
|
|
4246
4279
|
* @type {number}
|
|
4247
4280
|
* @memberof ProfinetSlotDescription
|
|
4248
4281
|
*/
|
|
@@ -4261,32 +4294,180 @@ export interface ProfinetSlotDescription {
|
|
|
4261
4294
|
*/
|
|
4262
4295
|
export interface ProfinetSubSlotDescription {
|
|
4263
4296
|
/**
|
|
4264
|
-
* The
|
|
4297
|
+
* The number/index of the PROFINET subslot.
|
|
4265
4298
|
* @type {number}
|
|
4266
4299
|
* @memberof ProfinetSubSlotDescription
|
|
4267
4300
|
*/
|
|
4268
4301
|
'number': number;
|
|
4269
4302
|
/**
|
|
4270
|
-
* The
|
|
4303
|
+
* The amount of bytes allocated for the subslot in the input process image buffer.
|
|
4271
4304
|
* @type {number}
|
|
4272
4305
|
* @memberof ProfinetSubSlotDescription
|
|
4273
4306
|
*/
|
|
4274
4307
|
'input_length': number;
|
|
4275
4308
|
/**
|
|
4276
|
-
* The
|
|
4309
|
+
* The amount of bytes allocated for the subslot in the output process image buffer.
|
|
4277
4310
|
* @type {number}
|
|
4278
4311
|
* @memberof ProfinetSubSlotDescription
|
|
4279
4312
|
*/
|
|
4280
4313
|
'output_length': number;
|
|
4281
4314
|
}
|
|
4282
4315
|
/**
|
|
4283
|
-
*
|
|
4316
|
+
* A program is a collection of instructions that are executed in the robot cell.
|
|
4317
|
+
* @export
|
|
4318
|
+
* @interface Program
|
|
4319
|
+
*/
|
|
4320
|
+
export interface Program {
|
|
4321
|
+
/**
|
|
4322
|
+
*
|
|
4323
|
+
* @type {string}
|
|
4324
|
+
* @memberof Program
|
|
4325
|
+
*/
|
|
4326
|
+
'program': string;
|
|
4327
|
+
/**
|
|
4328
|
+
*
|
|
4329
|
+
* @type {string}
|
|
4330
|
+
* @memberof Program
|
|
4331
|
+
*/
|
|
4332
|
+
'name'?: string;
|
|
4333
|
+
/**
|
|
4334
|
+
*
|
|
4335
|
+
* @type {string}
|
|
4336
|
+
* @memberof Program
|
|
4337
|
+
*/
|
|
4338
|
+
'description'?: string;
|
|
4339
|
+
/**
|
|
4340
|
+
*
|
|
4341
|
+
* @type {string}
|
|
4342
|
+
* @memberof Program
|
|
4343
|
+
*/
|
|
4344
|
+
'app': string;
|
|
4345
|
+
/**
|
|
4346
|
+
*
|
|
4347
|
+
* @type {object}
|
|
4348
|
+
* @memberof Program
|
|
4349
|
+
*/
|
|
4350
|
+
'input_schema'?: object;
|
|
4351
|
+
/**
|
|
4352
|
+
*
|
|
4353
|
+
* @type {object}
|
|
4354
|
+
* @memberof Program
|
|
4355
|
+
*/
|
|
4356
|
+
'preconditions'?: object;
|
|
4357
|
+
}
|
|
4358
|
+
/**
|
|
4359
|
+
* Holds the state of a program run.
|
|
4360
|
+
* @export
|
|
4361
|
+
* @interface ProgramRun
|
|
4362
|
+
*/
|
|
4363
|
+
export interface ProgramRun {
|
|
4364
|
+
/**
|
|
4365
|
+
* Unique identifier of the program run
|
|
4366
|
+
* @type {string}
|
|
4367
|
+
* @memberof ProgramRun
|
|
4368
|
+
*/
|
|
4369
|
+
'run': string;
|
|
4370
|
+
/**
|
|
4371
|
+
* Unique identifier of the program
|
|
4372
|
+
* @type {string}
|
|
4373
|
+
* @memberof ProgramRun
|
|
4374
|
+
*/
|
|
4375
|
+
'program': string;
|
|
4376
|
+
/**
|
|
4377
|
+
* State of the program run
|
|
4378
|
+
* @type {ProgramRunState}
|
|
4379
|
+
* @memberof ProgramRun
|
|
4380
|
+
*/
|
|
4381
|
+
'state': ProgramRunState;
|
|
4382
|
+
/**
|
|
4383
|
+
* Logs of the program run
|
|
4384
|
+
* @type {string}
|
|
4385
|
+
* @memberof ProgramRun
|
|
4386
|
+
*/
|
|
4387
|
+
'logs'?: string;
|
|
4388
|
+
/**
|
|
4389
|
+
* Stdout of the program run
|
|
4390
|
+
* @type {string}
|
|
4391
|
+
* @memberof ProgramRun
|
|
4392
|
+
*/
|
|
4393
|
+
'stdout'?: string;
|
|
4394
|
+
/**
|
|
4395
|
+
* Stderr of the program run
|
|
4396
|
+
* @type {string}
|
|
4397
|
+
* @memberof ProgramRun
|
|
4398
|
+
*/
|
|
4399
|
+
'stderr'?: string;
|
|
4400
|
+
/**
|
|
4401
|
+
* Error message of the program run, if any
|
|
4402
|
+
* @type {string}
|
|
4403
|
+
* @memberof ProgramRun
|
|
4404
|
+
*/
|
|
4405
|
+
'error'?: string;
|
|
4406
|
+
/**
|
|
4407
|
+
* Traceback of the program run, if any
|
|
4408
|
+
* @type {string}
|
|
4409
|
+
* @memberof ProgramRun
|
|
4410
|
+
*/
|
|
4411
|
+
'traceback'?: string;
|
|
4412
|
+
/**
|
|
4413
|
+
* Start time of the program run
|
|
4414
|
+
* @type {string}
|
|
4415
|
+
* @memberof ProgramRun
|
|
4416
|
+
*/
|
|
4417
|
+
'start_time'?: string;
|
|
4418
|
+
/**
|
|
4419
|
+
* End time of the program run
|
|
4420
|
+
* @type {string}
|
|
4421
|
+
* @memberof ProgramRun
|
|
4422
|
+
*/
|
|
4423
|
+
'end_time'?: string;
|
|
4424
|
+
/**
|
|
4425
|
+
* Input data of the program run
|
|
4426
|
+
* @type {object}
|
|
4427
|
+
* @memberof ProgramRun
|
|
4428
|
+
*/
|
|
4429
|
+
'input_data'?: object;
|
|
4430
|
+
}
|
|
4431
|
+
|
|
4432
|
+
|
|
4433
|
+
/**
|
|
4434
|
+
* The state of a program run.
|
|
4435
|
+
* @export
|
|
4436
|
+
* @enum {string}
|
|
4437
|
+
*/
|
|
4438
|
+
|
|
4439
|
+
export const ProgramRunState = {
|
|
4440
|
+
Preparing: 'PREPARING',
|
|
4441
|
+
Running: 'RUNNING',
|
|
4442
|
+
Completed: 'COMPLETED',
|
|
4443
|
+
Failed: 'FAILED',
|
|
4444
|
+
Stopped: 'STOPPED'
|
|
4445
|
+
} as const;
|
|
4446
|
+
|
|
4447
|
+
export type ProgramRunState = typeof ProgramRunState[keyof typeof ProgramRunState];
|
|
4448
|
+
|
|
4449
|
+
|
|
4450
|
+
/**
|
|
4451
|
+
* The state of a program run.
|
|
4452
|
+
* @export
|
|
4453
|
+
* @interface ProgramStartRequest
|
|
4454
|
+
*/
|
|
4455
|
+
export interface ProgramStartRequest {
|
|
4456
|
+
/**
|
|
4457
|
+
* The arguments to pass to the program.
|
|
4458
|
+
* @type {object}
|
|
4459
|
+
* @memberof ProgramStartRequest
|
|
4460
|
+
*/
|
|
4461
|
+
'arguments': object;
|
|
4462
|
+
}
|
|
4463
|
+
/**
|
|
4464
|
+
*
|
|
4284
4465
|
* @export
|
|
4285
4466
|
* @interface RRTConnectAlgorithm
|
|
4286
4467
|
*/
|
|
4287
4468
|
export interface RRTConnectAlgorithm {
|
|
4288
4469
|
/**
|
|
4289
|
-
* Algorithm discriminator.
|
|
4470
|
+
* 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
4471
|
* @type {string}
|
|
4291
4472
|
* @memberof RRTConnectAlgorithm
|
|
4292
4473
|
*/
|
|
@@ -4297,6 +4478,30 @@ export interface RRTConnectAlgorithm {
|
|
|
4297
4478
|
* @memberof RRTConnectAlgorithm
|
|
4298
4479
|
*/
|
|
4299
4480
|
'max_iterations'?: number;
|
|
4481
|
+
/**
|
|
4482
|
+
* Maximum step size for tree extension in joint space.
|
|
4483
|
+
* @type {number}
|
|
4484
|
+
* @memberof RRTConnectAlgorithm
|
|
4485
|
+
*/
|
|
4486
|
+
'max_step_size'?: number;
|
|
4487
|
+
/**
|
|
4488
|
+
* Adjust the maximum step size during the search based on the recent success rate of tree expansion.
|
|
4489
|
+
* @type {boolean}
|
|
4490
|
+
* @memberof RRTConnectAlgorithm
|
|
4491
|
+
*/
|
|
4492
|
+
'adaptive_step_size'?: boolean;
|
|
4493
|
+
/**
|
|
4494
|
+
* Apply smoothing after the search has succeeded. This will remove as many intermediate points as possible while keeping the path valid.
|
|
4495
|
+
* @type {boolean}
|
|
4496
|
+
* @memberof RRTConnectAlgorithm
|
|
4497
|
+
*/
|
|
4498
|
+
'apply_smoothing'?: boolean;
|
|
4499
|
+
/**
|
|
4500
|
+
* Apply blending after the search has succeeded and smoothing has been applied. This will apply the largest viable blending at each intermediate point.
|
|
4501
|
+
* @type {boolean}
|
|
4502
|
+
* @memberof RRTConnectAlgorithm
|
|
4503
|
+
*/
|
|
4504
|
+
'apply_blending'?: boolean;
|
|
4300
4505
|
}
|
|
4301
4506
|
|
|
4302
4507
|
export const RRTConnectAlgorithmAlgorithmNameEnum = {
|
|
@@ -4726,6 +4931,25 @@ export interface ServiceStatusStatus {
|
|
|
4726
4931
|
}
|
|
4727
4932
|
|
|
4728
4933
|
|
|
4934
|
+
/**
|
|
4935
|
+
* Defines an input/output that should be set upon reaching a specified location on the trajectory.
|
|
4936
|
+
* @export
|
|
4937
|
+
* @interface SetIO
|
|
4938
|
+
*/
|
|
4939
|
+
export interface SetIO {
|
|
4940
|
+
/**
|
|
4941
|
+
*
|
|
4942
|
+
* @type {IOValue}
|
|
4943
|
+
* @memberof SetIO
|
|
4944
|
+
*/
|
|
4945
|
+
'io': IOValue;
|
|
4946
|
+
/**
|
|
4947
|
+
* The location on the trajectory where the input/output should be set.
|
|
4948
|
+
* @type {number}
|
|
4949
|
+
* @memberof SetIO
|
|
4950
|
+
*/
|
|
4951
|
+
'location': number;
|
|
4952
|
+
}
|
|
4729
4953
|
/**
|
|
4730
4954
|
*
|
|
4731
4955
|
* @export
|
|
@@ -4801,10 +5025,10 @@ export interface StartMovementRequest {
|
|
|
4801
5025
|
'direction'?: Direction;
|
|
4802
5026
|
/**
|
|
4803
5027
|
* Attaches a list of output commands to the trajectory. The outputs are set to the specified values right after the specified location was reached. If the specified location is located before the start location (forward direction: value is smaller, backward direction: value is bigger), the output is not set.
|
|
4804
|
-
* @type {Array<
|
|
5028
|
+
* @type {Array<SetIO>}
|
|
4805
5029
|
* @memberof StartMovementRequest
|
|
4806
5030
|
*/
|
|
4807
|
-
'set_outputs'?: Array<
|
|
5031
|
+
'set_outputs'?: Array<SetIO>;
|
|
4808
5032
|
/**
|
|
4809
5033
|
* Defines an input/output that is listened to before the movement. Execution starts if the defined comparator evaluates to `true`.
|
|
4810
5034
|
* @type {StartOnIO}
|
|
@@ -5076,7 +5300,7 @@ export interface TrajectoryDetails {
|
|
|
5076
5300
|
*/
|
|
5077
5301
|
'trajectory': string;
|
|
5078
5302
|
/**
|
|
5079
|
-
*
|
|
5303
|
+
* Location on trajectory where the execution will start. The default value is the start (forward movement) or end (backward movement) of the trajectory. If you want to start your movement from an arbitrary location, e.g. in combination with [streamMoveToTrajectoryViaJointPTP](streamMoveToTrajectoryViaJointPTP), set the location by respecting the following format: - The location is a scalar value that defines a position along a path, typically ranging from 0 to `n`, where `n` denotes the number of motion commands - Each integer value of the location corresponds to a specific motion command, while non-integer values interpolate positions within the segments. - The location is calculated from the joint path
|
|
5080
5304
|
* @type {number}
|
|
5081
5305
|
* @memberof TrajectoryDetails
|
|
5082
5306
|
*/
|
|
@@ -5138,7 +5362,7 @@ export interface TrajectoryId {
|
|
|
5138
5362
|
* @type {string}
|
|
5139
5363
|
* @memberof TrajectoryId
|
|
5140
5364
|
*/
|
|
5141
|
-
'message_type'
|
|
5365
|
+
'message_type': TrajectoryIdMessageTypeEnum;
|
|
5142
5366
|
/**
|
|
5143
5367
|
* The identifier of the trajectory which was returned by the [addTrajectory](addTrajectory) endpoint.
|
|
5144
5368
|
* @type {string}
|
|
@@ -5333,6 +5557,31 @@ export interface ValidationError {
|
|
|
5333
5557
|
*/
|
|
5334
5558
|
'input': { [key: string]: any; };
|
|
5335
5559
|
}
|
|
5560
|
+
/**
|
|
5561
|
+
* A validation error of a program.
|
|
5562
|
+
* @export
|
|
5563
|
+
* @interface ValidationError2
|
|
5564
|
+
*/
|
|
5565
|
+
export interface ValidationError2 {
|
|
5566
|
+
/**
|
|
5567
|
+
*
|
|
5568
|
+
* @type {Array<number>}
|
|
5569
|
+
* @memberof ValidationError2
|
|
5570
|
+
*/
|
|
5571
|
+
'loc': Array<number>;
|
|
5572
|
+
/**
|
|
5573
|
+
*
|
|
5574
|
+
* @type {string}
|
|
5575
|
+
* @memberof ValidationError2
|
|
5576
|
+
*/
|
|
5577
|
+
'msg': string;
|
|
5578
|
+
/**
|
|
5579
|
+
*
|
|
5580
|
+
* @type {string}
|
|
5581
|
+
* @memberof ValidationError2
|
|
5582
|
+
*/
|
|
5583
|
+
'type': string;
|
|
5584
|
+
}
|
|
5336
5585
|
/**
|
|
5337
5586
|
* @type ValidationErrorLocInner
|
|
5338
5587
|
* @export
|
|
@@ -6150,7 +6399,7 @@ export class ApplicationApi extends BaseAPI {
|
|
|
6150
6399
|
export const BUSInputsOutputsApiAxiosParamCreator = function (configuration?: Configuration) {
|
|
6151
6400
|
return {
|
|
6152
6401
|
/**
|
|
6153
|
-
* Add
|
|
6402
|
+
* Add the BUS inputs/outputs service to the cell. Starts a containerized service that enables BUS connections via the specified ethernet port.
|
|
6154
6403
|
* @summary Add Service
|
|
6155
6404
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
6156
6405
|
* @param {BusIOType} busIOType
|
|
@@ -6203,7 +6452,7 @@ export const BUSInputsOutputsApiAxiosParamCreator = function (configuration?: Co
|
|
|
6203
6452
|
};
|
|
6204
6453
|
},
|
|
6205
6454
|
/**
|
|
6206
|
-
* Adds an input/output to or updates an input/output on the PROFINET device.
|
|
6455
|
+
* 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
6456
|
* @summary Add PROFINET Input/Output
|
|
6208
6457
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
6209
6458
|
* @param {string} io Unique identifier to address an Input/Output in the cell.
|
|
@@ -6255,7 +6504,7 @@ export const BUSInputsOutputsApiAxiosParamCreator = function (configuration?: Co
|
|
|
6255
6504
|
};
|
|
6256
6505
|
},
|
|
6257
6506
|
/**
|
|
6258
|
-
*
|
|
6507
|
+
* Remove the BUS inputs/outputs service from the cell.
|
|
6259
6508
|
* @summary Clear Service
|
|
6260
6509
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
6261
6510
|
* @param {number} [completionTimeout]
|
|
@@ -6302,7 +6551,7 @@ export const BUSInputsOutputsApiAxiosParamCreator = function (configuration?: Co
|
|
|
6302
6551
|
};
|
|
6303
6552
|
},
|
|
6304
6553
|
/**
|
|
6305
|
-
* Removes
|
|
6554
|
+
* Removes an input/output variable configuration from the PROFINET device, e.g. NOVA\'s PROFINET service.
|
|
6306
6555
|
* @summary Remove PROFINET Input/Ouptut
|
|
6307
6556
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
6308
6557
|
* @param {string} io Unique identifier to address an Input/Output in the cell.
|
|
@@ -6348,7 +6597,7 @@ export const BUSInputsOutputsApiAxiosParamCreator = function (configuration?: Co
|
|
|
6348
6597
|
};
|
|
6349
6598
|
},
|
|
6350
6599
|
/**
|
|
6351
|
-
* Get deployed BUS
|
|
6600
|
+
* Get deployed BUS inputs/outputs service.
|
|
6352
6601
|
* @summary Get Service
|
|
6353
6602
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
6354
6603
|
* @param {*} [options] Override http request option.
|
|
@@ -6479,7 +6728,7 @@ export const BUSInputsOutputsApiAxiosParamCreator = function (configuration?: Co
|
|
|
6479
6728
|
};
|
|
6480
6729
|
},
|
|
6481
6730
|
/**
|
|
6482
|
-
* Get description of PROFINET
|
|
6731
|
+
* Get description of NOVA as a PROFINET device.
|
|
6483
6732
|
* @summary Get PROFINET Description
|
|
6484
6733
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
6485
6734
|
* @param {*} [options] Override http request option.
|
|
@@ -6521,7 +6770,7 @@ export const BUSInputsOutputsApiAxiosParamCreator = function (configuration?: Co
|
|
|
6521
6770
|
};
|
|
6522
6771
|
},
|
|
6523
6772
|
/**
|
|
6524
|
-
* Get input/output configuration of the PROFINET device as file.
|
|
6773
|
+
* 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
6774
|
* @summary PROFINET Inputs/Outputs to File
|
|
6526
6775
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
6527
6776
|
* @param {number} [inputOffset]
|
|
@@ -6573,7 +6822,7 @@ export const BUSInputsOutputsApiAxiosParamCreator = function (configuration?: Co
|
|
|
6573
6822
|
};
|
|
6574
6823
|
},
|
|
6575
6824
|
/**
|
|
6576
|
-
* List all BUS
|
|
6825
|
+
* List all input/output descriptions for configured BUS services. The input/output descriptions contain information such as the name, the type and the unit. The input/output direction is given in perspective of the BUS service.
|
|
6577
6826
|
* @summary List Descriptions
|
|
6578
6827
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
6579
6828
|
* @param {*} [options] Override http request option.
|
|
@@ -6615,7 +6864,7 @@ export const BUSInputsOutputsApiAxiosParamCreator = function (configuration?: Co
|
|
|
6615
6864
|
};
|
|
6616
6865
|
},
|
|
6617
6866
|
/**
|
|
6618
|
-
* List all PROFINET input and
|
|
6867
|
+
* List descriptions for all configured input/output variables of the PROFINET service. The input/output descriptions contain information such as the name, the type and the unit. The input/output direction is given in perspective of the PROFINET Device, e.g. the configured PROFINET service. The byte and bit addresses are the locations in the PROFINET input/output process image the variable points to. The PROFINET controller as well as NOVA\'s PROFINET service use an input/output variable configuration to interpret the bits of the input and output process image. The NOVA PROFINET service\'s configuration is modified via [addProfinetIO](addProfinetIO) and [setProfinetIOsFromFile](setProfinetIOsFromFile). For the PROFINET controller, e.g. a connected PLC, refer to the corresponding third party software, e.g. TIA portal.
|
|
6619
6868
|
* @summary List PROFINET Input/Output Configuration
|
|
6620
6869
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
6621
6870
|
* @param {*} [options] Override http request option.
|
|
@@ -6705,7 +6954,7 @@ export const BUSInputsOutputsApiAxiosParamCreator = function (configuration?: Co
|
|
|
6705
6954
|
};
|
|
6706
6955
|
},
|
|
6707
6956
|
/**
|
|
6708
|
-
* Sets inputs/outputs
|
|
6957
|
+
* Sets input/output variable configuration on the PROFINET device (i.e. NOVA\'s PROFINET service) from XML file. The inputs/outputs map variables to specific memory addresses in the process image. The default process image has buffer lengths of 64 bytes for input and output. The size of the buffer is determined by the `config_file_content` that is passed in [addBusIOService](addBusIOService) and has to be in accordance with the GSDML file describing the PROFINET device. The PROFINET controller as well as NOVA\'s PROFINET service use an input/output variable configuration to interpret the bits of the input/output process image. The NOVA\'s PROFINET service\'s configuration can be viewed via [listProfinetIOs](listProfinetIOs). For the PROFINET controller, e.g. a connected PLC, refer to the corresponding engineering system, e.g. TIA portal. You can export the variable configuration of the PROFINET controller as XML file from your engineering system, e.g. TIA portal. The endpoint is built so that the perspective of input and output (PROFINET Device\'s input is PROFINET Controller\'s output) is internally handled (PROFINET device input is PROFINET controller output), meaning that you can paste the exported XML file here without modifying.
|
|
6709
6958
|
* @summary Set PROFINET Inputs/Outputs from File
|
|
6710
6959
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
6711
6960
|
* @param {ProfinetInputOutputConfig} profinetInputOutputConfig
|
|
@@ -6763,7 +7012,7 @@ export const BUSInputsOutputsApiFp = function(configuration?: Configuration) {
|
|
|
6763
7012
|
const localVarAxiosParamCreator = BUSInputsOutputsApiAxiosParamCreator(configuration)
|
|
6764
7013
|
return {
|
|
6765
7014
|
/**
|
|
6766
|
-
* Add
|
|
7015
|
+
* Add the BUS inputs/outputs service to the cell. Starts a containerized service that enables BUS connections via the specified ethernet port.
|
|
6767
7016
|
* @summary Add Service
|
|
6768
7017
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
6769
7018
|
* @param {BusIOType} busIOType
|
|
@@ -6778,7 +7027,7 @@ export const BUSInputsOutputsApiFp = function(configuration?: Configuration) {
|
|
|
6778
7027
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
6779
7028
|
},
|
|
6780
7029
|
/**
|
|
6781
|
-
* Adds an input/output to or updates an input/output on the PROFINET device.
|
|
7030
|
+
* 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
7031
|
* @summary Add PROFINET Input/Output
|
|
6783
7032
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
6784
7033
|
* @param {string} io Unique identifier to address an Input/Output in the cell.
|
|
@@ -6793,7 +7042,7 @@ export const BUSInputsOutputsApiFp = function(configuration?: Configuration) {
|
|
|
6793
7042
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
6794
7043
|
},
|
|
6795
7044
|
/**
|
|
6796
|
-
*
|
|
7045
|
+
* Remove the BUS inputs/outputs service from the cell.
|
|
6797
7046
|
* @summary Clear Service
|
|
6798
7047
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
6799
7048
|
* @param {number} [completionTimeout]
|
|
@@ -6807,7 +7056,7 @@ export const BUSInputsOutputsApiFp = function(configuration?: Configuration) {
|
|
|
6807
7056
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
6808
7057
|
},
|
|
6809
7058
|
/**
|
|
6810
|
-
* Removes
|
|
7059
|
+
* Removes an input/output variable configuration from the PROFINET device, e.g. NOVA\'s PROFINET service.
|
|
6811
7060
|
* @summary Remove PROFINET Input/Ouptut
|
|
6812
7061
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
6813
7062
|
* @param {string} io Unique identifier to address an Input/Output in the cell.
|
|
@@ -6821,7 +7070,7 @@ export const BUSInputsOutputsApiFp = function(configuration?: Configuration) {
|
|
|
6821
7070
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
6822
7071
|
},
|
|
6823
7072
|
/**
|
|
6824
|
-
* Get deployed BUS
|
|
7073
|
+
* Get deployed BUS inputs/outputs service.
|
|
6825
7074
|
* @summary Get Service
|
|
6826
7075
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
6827
7076
|
* @param {*} [options] Override http request option.
|
|
@@ -6861,7 +7110,7 @@ export const BUSInputsOutputsApiFp = function(configuration?: Configuration) {
|
|
|
6861
7110
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
6862
7111
|
},
|
|
6863
7112
|
/**
|
|
6864
|
-
* Get description of PROFINET
|
|
7113
|
+
* Get description of NOVA as a PROFINET device.
|
|
6865
7114
|
* @summary Get PROFINET Description
|
|
6866
7115
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
6867
7116
|
* @param {*} [options] Override http request option.
|
|
@@ -6874,7 +7123,7 @@ export const BUSInputsOutputsApiFp = function(configuration?: Configuration) {
|
|
|
6874
7123
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
6875
7124
|
},
|
|
6876
7125
|
/**
|
|
6877
|
-
* Get input/output configuration of the PROFINET device as file.
|
|
7126
|
+
* 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
7127
|
* @summary PROFINET Inputs/Outputs to File
|
|
6879
7128
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
6880
7129
|
* @param {number} [inputOffset]
|
|
@@ -6889,20 +7138,20 @@ export const BUSInputsOutputsApiFp = function(configuration?: Configuration) {
|
|
|
6889
7138
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
6890
7139
|
},
|
|
6891
7140
|
/**
|
|
6892
|
-
* List all BUS
|
|
7141
|
+
* List all input/output descriptions for configured BUS services. The input/output descriptions contain information such as the name, the type and the unit. The input/output direction is given in perspective of the BUS service.
|
|
6893
7142
|
* @summary List Descriptions
|
|
6894
7143
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
6895
7144
|
* @param {*} [options] Override http request option.
|
|
6896
7145
|
* @throws {RequiredError}
|
|
6897
7146
|
*/
|
|
6898
|
-
async listBusIODescriptions(cell: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<
|
|
7147
|
+
async listBusIODescriptions(cell: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<IODescription2>>> {
|
|
6899
7148
|
const localVarAxiosArgs = await localVarAxiosParamCreator.listBusIODescriptions(cell, options);
|
|
6900
7149
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
6901
7150
|
const localVarOperationServerBasePath = operationServerMap['BUSInputsOutputsApi.listBusIODescriptions']?.[localVarOperationServerIndex]?.url;
|
|
6902
7151
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
6903
7152
|
},
|
|
6904
7153
|
/**
|
|
6905
|
-
* List all PROFINET input and
|
|
7154
|
+
* List descriptions for all configured input/output variables of the PROFINET service. The input/output descriptions contain information such as the name, the type and the unit. The input/output direction is given in perspective of the PROFINET Device, e.g. the configured PROFINET service. The byte and bit addresses are the locations in the PROFINET input/output process image the variable points to. The PROFINET controller as well as NOVA\'s PROFINET service use an input/output variable configuration to interpret the bits of the input and output process image. The NOVA PROFINET service\'s configuration is modified via [addProfinetIO](addProfinetIO) and [setProfinetIOsFromFile](setProfinetIOsFromFile). For the PROFINET controller, e.g. a connected PLC, refer to the corresponding third party software, e.g. TIA portal.
|
|
6906
7155
|
* @summary List PROFINET Input/Output Configuration
|
|
6907
7156
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
6908
7157
|
* @param {*} [options] Override http request option.
|
|
@@ -6929,7 +7178,7 @@ export const BUSInputsOutputsApiFp = function(configuration?: Configuration) {
|
|
|
6929
7178
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
6930
7179
|
},
|
|
6931
7180
|
/**
|
|
6932
|
-
* Sets inputs/outputs
|
|
7181
|
+
* Sets input/output variable configuration on the PROFINET device (i.e. NOVA\'s PROFINET service) from XML file. The inputs/outputs map variables to specific memory addresses in the process image. The default process image has buffer lengths of 64 bytes for input and output. The size of the buffer is determined by the `config_file_content` that is passed in [addBusIOService](addBusIOService) and has to be in accordance with the GSDML file describing the PROFINET device. The PROFINET controller as well as NOVA\'s PROFINET service use an input/output variable configuration to interpret the bits of the input/output process image. The NOVA\'s PROFINET service\'s configuration can be viewed via [listProfinetIOs](listProfinetIOs). For the PROFINET controller, e.g. a connected PLC, refer to the corresponding engineering system, e.g. TIA portal. You can export the variable configuration of the PROFINET controller as XML file from your engineering system, e.g. TIA portal. The endpoint is built so that the perspective of input and output (PROFINET Device\'s input is PROFINET Controller\'s output) is internally handled (PROFINET device input is PROFINET controller output), meaning that you can paste the exported XML file here without modifying.
|
|
6933
7182
|
* @summary Set PROFINET Inputs/Outputs from File
|
|
6934
7183
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
6935
7184
|
* @param {ProfinetInputOutputConfig} profinetInputOutputConfig
|
|
@@ -6953,7 +7202,7 @@ export const BUSInputsOutputsApiFactory = function (configuration?: Configuratio
|
|
|
6953
7202
|
const localVarFp = BUSInputsOutputsApiFp(configuration)
|
|
6954
7203
|
return {
|
|
6955
7204
|
/**
|
|
6956
|
-
* Add
|
|
7205
|
+
* Add the BUS inputs/outputs service to the cell. Starts a containerized service that enables BUS connections via the specified ethernet port.
|
|
6957
7206
|
* @summary Add Service
|
|
6958
7207
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
6959
7208
|
* @param {BusIOType} busIOType
|
|
@@ -6965,7 +7214,7 @@ export const BUSInputsOutputsApiFactory = function (configuration?: Configuratio
|
|
|
6965
7214
|
return localVarFp.addBusIOService(cell, busIOType, completionTimeout, options).then((request) => request(axios, basePath));
|
|
6966
7215
|
},
|
|
6967
7216
|
/**
|
|
6968
|
-
* Adds an input/output to or updates an input/output on the PROFINET device.
|
|
7217
|
+
* 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
7218
|
* @summary Add PROFINET Input/Output
|
|
6970
7219
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
6971
7220
|
* @param {string} io Unique identifier to address an Input/Output in the cell.
|
|
@@ -6977,7 +7226,7 @@ export const BUSInputsOutputsApiFactory = function (configuration?: Configuratio
|
|
|
6977
7226
|
return localVarFp.addProfinetIO(cell, io, profinetIOData, options).then((request) => request(axios, basePath));
|
|
6978
7227
|
},
|
|
6979
7228
|
/**
|
|
6980
|
-
*
|
|
7229
|
+
* Remove the BUS inputs/outputs service from the cell.
|
|
6981
7230
|
* @summary Clear Service
|
|
6982
7231
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
6983
7232
|
* @param {number} [completionTimeout]
|
|
@@ -6988,7 +7237,7 @@ export const BUSInputsOutputsApiFactory = function (configuration?: Configuratio
|
|
|
6988
7237
|
return localVarFp.clearBusIOService(cell, completionTimeout, options).then((request) => request(axios, basePath));
|
|
6989
7238
|
},
|
|
6990
7239
|
/**
|
|
6991
|
-
* Removes
|
|
7240
|
+
* Removes an input/output variable configuration from the PROFINET device, e.g. NOVA\'s PROFINET service.
|
|
6992
7241
|
* @summary Remove PROFINET Input/Ouptut
|
|
6993
7242
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
6994
7243
|
* @param {string} io Unique identifier to address an Input/Output in the cell.
|
|
@@ -6999,7 +7248,7 @@ export const BUSInputsOutputsApiFactory = function (configuration?: Configuratio
|
|
|
6999
7248
|
return localVarFp.deleteProfinetIO(cell, io, options).then((request) => request(axios, basePath));
|
|
7000
7249
|
},
|
|
7001
7250
|
/**
|
|
7002
|
-
* Get deployed BUS
|
|
7251
|
+
* Get deployed BUS inputs/outputs service.
|
|
7003
7252
|
* @summary Get Service
|
|
7004
7253
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
7005
7254
|
* @param {*} [options] Override http request option.
|
|
@@ -7030,7 +7279,7 @@ export const BUSInputsOutputsApiFactory = function (configuration?: Configuratio
|
|
|
7030
7279
|
return localVarFp.getBusIOValues(cell, ios, options).then((request) => request(axios, basePath));
|
|
7031
7280
|
},
|
|
7032
7281
|
/**
|
|
7033
|
-
* Get description of PROFINET
|
|
7282
|
+
* Get description of NOVA as a PROFINET device.
|
|
7034
7283
|
* @summary Get PROFINET Description
|
|
7035
7284
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
7036
7285
|
* @param {*} [options] Override http request option.
|
|
@@ -7040,7 +7289,7 @@ export const BUSInputsOutputsApiFactory = function (configuration?: Configuratio
|
|
|
7040
7289
|
return localVarFp.getProfinetDescription(cell, options).then((request) => request(axios, basePath));
|
|
7041
7290
|
},
|
|
7042
7291
|
/**
|
|
7043
|
-
* Get input/output configuration of the PROFINET device as file.
|
|
7292
|
+
* 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
7293
|
* @summary PROFINET Inputs/Outputs to File
|
|
7045
7294
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
7046
7295
|
* @param {number} [inputOffset]
|
|
@@ -7052,17 +7301,17 @@ export const BUSInputsOutputsApiFactory = function (configuration?: Configuratio
|
|
|
7052
7301
|
return localVarFp.getProfinetIOsFromFile(cell, inputOffset, outputOffset, options).then((request) => request(axios, basePath));
|
|
7053
7302
|
},
|
|
7054
7303
|
/**
|
|
7055
|
-
* List all BUS
|
|
7304
|
+
* List all input/output descriptions for configured BUS services. The input/output descriptions contain information such as the name, the type and the unit. The input/output direction is given in perspective of the BUS service.
|
|
7056
7305
|
* @summary List Descriptions
|
|
7057
7306
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
7058
7307
|
* @param {*} [options] Override http request option.
|
|
7059
7308
|
* @throws {RequiredError}
|
|
7060
7309
|
*/
|
|
7061
|
-
listBusIODescriptions(cell: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<
|
|
7310
|
+
listBusIODescriptions(cell: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<IODescription2>> {
|
|
7062
7311
|
return localVarFp.listBusIODescriptions(cell, options).then((request) => request(axios, basePath));
|
|
7063
7312
|
},
|
|
7064
7313
|
/**
|
|
7065
|
-
* List all PROFINET input and
|
|
7314
|
+
* List descriptions for all configured input/output variables of the PROFINET service. The input/output descriptions contain information such as the name, the type and the unit. The input/output direction is given in perspective of the PROFINET Device, e.g. the configured PROFINET service. The byte and bit addresses are the locations in the PROFINET input/output process image the variable points to. The PROFINET controller as well as NOVA\'s PROFINET service use an input/output variable configuration to interpret the bits of the input and output process image. The NOVA PROFINET service\'s configuration is modified via [addProfinetIO](addProfinetIO) and [setProfinetIOsFromFile](setProfinetIOsFromFile). For the PROFINET controller, e.g. a connected PLC, refer to the corresponding third party software, e.g. TIA portal.
|
|
7066
7315
|
* @summary List PROFINET Input/Output Configuration
|
|
7067
7316
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
7068
7317
|
* @param {*} [options] Override http request option.
|
|
@@ -7083,7 +7332,7 @@ export const BUSInputsOutputsApiFactory = function (configuration?: Configuratio
|
|
|
7083
7332
|
return localVarFp.setBusIOValues(cell, iOValue, options).then((request) => request(axios, basePath));
|
|
7084
7333
|
},
|
|
7085
7334
|
/**
|
|
7086
|
-
* Sets inputs/outputs
|
|
7335
|
+
* Sets input/output variable configuration on the PROFINET device (i.e. NOVA\'s PROFINET service) from XML file. The inputs/outputs map variables to specific memory addresses in the process image. The default process image has buffer lengths of 64 bytes for input and output. The size of the buffer is determined by the `config_file_content` that is passed in [addBusIOService](addBusIOService) and has to be in accordance with the GSDML file describing the PROFINET device. The PROFINET controller as well as NOVA\'s PROFINET service use an input/output variable configuration to interpret the bits of the input/output process image. The NOVA\'s PROFINET service\'s configuration can be viewed via [listProfinetIOs](listProfinetIOs). For the PROFINET controller, e.g. a connected PLC, refer to the corresponding engineering system, e.g. TIA portal. You can export the variable configuration of the PROFINET controller as XML file from your engineering system, e.g. TIA portal. The endpoint is built so that the perspective of input and output (PROFINET Device\'s input is PROFINET Controller\'s output) is internally handled (PROFINET device input is PROFINET controller output), meaning that you can paste the exported XML file here without modifying.
|
|
7087
7336
|
* @summary Set PROFINET Inputs/Outputs from File
|
|
7088
7337
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
7089
7338
|
* @param {ProfinetInputOutputConfig} profinetInputOutputConfig
|
|
@@ -7104,7 +7353,7 @@ export const BUSInputsOutputsApiFactory = function (configuration?: Configuratio
|
|
|
7104
7353
|
*/
|
|
7105
7354
|
export class BUSInputsOutputsApi extends BaseAPI {
|
|
7106
7355
|
/**
|
|
7107
|
-
* Add
|
|
7356
|
+
* Add the BUS inputs/outputs service to the cell. Starts a containerized service that enables BUS connections via the specified ethernet port.
|
|
7108
7357
|
* @summary Add Service
|
|
7109
7358
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
7110
7359
|
* @param {BusIOType} busIOType
|
|
@@ -7118,7 +7367,7 @@ export class BUSInputsOutputsApi extends BaseAPI {
|
|
|
7118
7367
|
}
|
|
7119
7368
|
|
|
7120
7369
|
/**
|
|
7121
|
-
* Adds an input/output to or updates an input/output on the PROFINET device.
|
|
7370
|
+
* 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
7371
|
* @summary Add PROFINET Input/Output
|
|
7123
7372
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
7124
7373
|
* @param {string} io Unique identifier to address an Input/Output in the cell.
|
|
@@ -7132,7 +7381,7 @@ export class BUSInputsOutputsApi extends BaseAPI {
|
|
|
7132
7381
|
}
|
|
7133
7382
|
|
|
7134
7383
|
/**
|
|
7135
|
-
*
|
|
7384
|
+
* Remove the BUS inputs/outputs service from the cell.
|
|
7136
7385
|
* @summary Clear Service
|
|
7137
7386
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
7138
7387
|
* @param {number} [completionTimeout]
|
|
@@ -7145,7 +7394,7 @@ export class BUSInputsOutputsApi extends BaseAPI {
|
|
|
7145
7394
|
}
|
|
7146
7395
|
|
|
7147
7396
|
/**
|
|
7148
|
-
* Removes
|
|
7397
|
+
* Removes an input/output variable configuration from the PROFINET device, e.g. NOVA\'s PROFINET service.
|
|
7149
7398
|
* @summary Remove PROFINET Input/Ouptut
|
|
7150
7399
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
7151
7400
|
* @param {string} io Unique identifier to address an Input/Output in the cell.
|
|
@@ -7158,7 +7407,7 @@ export class BUSInputsOutputsApi extends BaseAPI {
|
|
|
7158
7407
|
}
|
|
7159
7408
|
|
|
7160
7409
|
/**
|
|
7161
|
-
* Get deployed BUS
|
|
7410
|
+
* Get deployed BUS inputs/outputs service.
|
|
7162
7411
|
* @summary Get Service
|
|
7163
7412
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
7164
7413
|
* @param {*} [options] Override http request option.
|
|
@@ -7195,7 +7444,7 @@ export class BUSInputsOutputsApi extends BaseAPI {
|
|
|
7195
7444
|
}
|
|
7196
7445
|
|
|
7197
7446
|
/**
|
|
7198
|
-
* Get description of PROFINET
|
|
7447
|
+
* Get description of NOVA as a PROFINET device.
|
|
7199
7448
|
* @summary Get PROFINET Description
|
|
7200
7449
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
7201
7450
|
* @param {*} [options] Override http request option.
|
|
@@ -7207,7 +7456,7 @@ export class BUSInputsOutputsApi extends BaseAPI {
|
|
|
7207
7456
|
}
|
|
7208
7457
|
|
|
7209
7458
|
/**
|
|
7210
|
-
* Get input/output configuration of the PROFINET device as file.
|
|
7459
|
+
* 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
7460
|
* @summary PROFINET Inputs/Outputs to File
|
|
7212
7461
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
7213
7462
|
* @param {number} [inputOffset]
|
|
@@ -7221,7 +7470,7 @@ export class BUSInputsOutputsApi extends BaseAPI {
|
|
|
7221
7470
|
}
|
|
7222
7471
|
|
|
7223
7472
|
/**
|
|
7224
|
-
* List all BUS
|
|
7473
|
+
* List all input/output descriptions for configured BUS services. The input/output descriptions contain information such as the name, the type and the unit. The input/output direction is given in perspective of the BUS service.
|
|
7225
7474
|
* @summary List Descriptions
|
|
7226
7475
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
7227
7476
|
* @param {*} [options] Override http request option.
|
|
@@ -7233,7 +7482,7 @@ export class BUSInputsOutputsApi extends BaseAPI {
|
|
|
7233
7482
|
}
|
|
7234
7483
|
|
|
7235
7484
|
/**
|
|
7236
|
-
* List all PROFINET input and
|
|
7485
|
+
* List descriptions for all configured input/output variables of the PROFINET service. The input/output descriptions contain information such as the name, the type and the unit. The input/output direction is given in perspective of the PROFINET Device, e.g. the configured PROFINET service. The byte and bit addresses are the locations in the PROFINET input/output process image the variable points to. The PROFINET controller as well as NOVA\'s PROFINET service use an input/output variable configuration to interpret the bits of the input and output process image. The NOVA PROFINET service\'s configuration is modified via [addProfinetIO](addProfinetIO) and [setProfinetIOsFromFile](setProfinetIOsFromFile). For the PROFINET controller, e.g. a connected PLC, refer to the corresponding third party software, e.g. TIA portal.
|
|
7237
7486
|
* @summary List PROFINET Input/Output Configuration
|
|
7238
7487
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
7239
7488
|
* @param {*} [options] Override http request option.
|
|
@@ -7258,7 +7507,7 @@ export class BUSInputsOutputsApi extends BaseAPI {
|
|
|
7258
7507
|
}
|
|
7259
7508
|
|
|
7260
7509
|
/**
|
|
7261
|
-
* Sets inputs/outputs
|
|
7510
|
+
* Sets input/output variable configuration on the PROFINET device (i.e. NOVA\'s PROFINET service) from XML file. The inputs/outputs map variables to specific memory addresses in the process image. The default process image has buffer lengths of 64 bytes for input and output. The size of the buffer is determined by the `config_file_content` that is passed in [addBusIOService](addBusIOService) and has to be in accordance with the GSDML file describing the PROFINET device. The PROFINET controller as well as NOVA\'s PROFINET service use an input/output variable configuration to interpret the bits of the input/output process image. The NOVA\'s PROFINET service\'s configuration can be viewed via [listProfinetIOs](listProfinetIOs). For the PROFINET controller, e.g. a connected PLC, refer to the corresponding engineering system, e.g. TIA portal. You can export the variable configuration of the PROFINET controller as XML file from your engineering system, e.g. TIA portal. The endpoint is built so that the perspective of input and output (PROFINET Device\'s input is PROFINET Controller\'s output) is internally handled (PROFINET device input is PROFINET controller output), meaning that you can paste the exported XML file here without modifying.
|
|
7262
7511
|
* @summary Set PROFINET Inputs/Outputs from File
|
|
7263
7512
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
7264
7513
|
* @param {ProfinetInputOutputConfig} profinetInputOutputConfig
|
|
@@ -10725,7 +10974,7 @@ export class MotionGroupApi extends BaseAPI {
|
|
|
10725
10974
|
export const MotionGroupModelsApiAxiosParamCreator = function (configuration?: Configuration) {
|
|
10726
10975
|
return {
|
|
10727
10976
|
/**
|
|
10728
|
-
* Returns the default collision link chain for a given motion group model. See [
|
|
10977
|
+
* 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
10978
|
* @summary Get Collision Model
|
|
10730
10979
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
10731
10980
|
* @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 +11072,7 @@ export const MotionGroupModelsApiFp = function(configuration?: Configuration) {
|
|
|
10823
11072
|
const localVarAxiosParamCreator = MotionGroupModelsApiAxiosParamCreator(configuration)
|
|
10824
11073
|
return {
|
|
10825
11074
|
/**
|
|
10826
|
-
* Returns the default collision link chain for a given motion group model. See [
|
|
11075
|
+
* 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
11076
|
* @summary Get Collision Model
|
|
10828
11077
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
10829
11078
|
* @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 +11109,7 @@ export const MotionGroupModelsApiFactory = function (configuration?: Configurati
|
|
|
10860
11109
|
const localVarFp = MotionGroupModelsApiFp(configuration)
|
|
10861
11110
|
return {
|
|
10862
11111
|
/**
|
|
10863
|
-
* Returns the default collision link chain for a given motion group model. See [
|
|
11112
|
+
* 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
11113
|
* @summary Get Collision Model
|
|
10865
11114
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
10866
11115
|
* @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 +11140,7 @@ export const MotionGroupModelsApiFactory = function (configuration?: Configurati
|
|
|
10891
11140
|
*/
|
|
10892
11141
|
export class MotionGroupModelsApi extends BaseAPI {
|
|
10893
11142
|
/**
|
|
10894
|
-
* Returns the default collision link chain for a given motion group model. See [
|
|
11143
|
+
* 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
11144
|
* @summary Get Collision Model
|
|
10896
11145
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
10897
11146
|
* @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 +11167,383 @@ export class MotionGroupModelsApi extends BaseAPI {
|
|
|
10918
11167
|
|
|
10919
11168
|
|
|
10920
11169
|
|
|
11170
|
+
/**
|
|
11171
|
+
* ProgramApi - axios parameter creator
|
|
11172
|
+
* @export
|
|
11173
|
+
*/
|
|
11174
|
+
export const ProgramApiAxiosParamCreator = function (configuration?: Configuration) {
|
|
11175
|
+
return {
|
|
11176
|
+
/**
|
|
11177
|
+
* Get details of a program.
|
|
11178
|
+
* @summary Get program
|
|
11179
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
11180
|
+
* @param {string} program
|
|
11181
|
+
* @param {*} [options] Override http request option.
|
|
11182
|
+
* @throws {RequiredError}
|
|
11183
|
+
*/
|
|
11184
|
+
getProgram: async (cell: string, program: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
11185
|
+
// verify required parameter 'cell' is not null or undefined
|
|
11186
|
+
assertParamExists('getProgram', 'cell', cell)
|
|
11187
|
+
// verify required parameter 'program' is not null or undefined
|
|
11188
|
+
assertParamExists('getProgram', 'program', program)
|
|
11189
|
+
const localVarPath = `/experimental/cells/{cell}/programs/{program}`
|
|
11190
|
+
.replace(`{${"cell"}}`, encodeURIComponent(String(cell)))
|
|
11191
|
+
.replace(`{${"program"}}`, encodeURIComponent(String(program)));
|
|
11192
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
11193
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
11194
|
+
let baseOptions;
|
|
11195
|
+
if (configuration) {
|
|
11196
|
+
baseOptions = configuration.baseOptions;
|
|
11197
|
+
}
|
|
11198
|
+
|
|
11199
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
11200
|
+
const localVarHeaderParameter = {} as any;
|
|
11201
|
+
const localVarQueryParameter = {} as any;
|
|
11202
|
+
|
|
11203
|
+
// authentication BasicAuth required
|
|
11204
|
+
// http basic authentication required
|
|
11205
|
+
setBasicAuthToObject(localVarRequestOptions, configuration)
|
|
11206
|
+
|
|
11207
|
+
// authentication BearerAuth required
|
|
11208
|
+
// http bearer authentication required
|
|
11209
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
11210
|
+
|
|
11211
|
+
|
|
11212
|
+
|
|
11213
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
11214
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
11215
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
11216
|
+
|
|
11217
|
+
return {
|
|
11218
|
+
url: toPathString(localVarUrlObj),
|
|
11219
|
+
options: localVarRequestOptions,
|
|
11220
|
+
};
|
|
11221
|
+
},
|
|
11222
|
+
/**
|
|
11223
|
+
* List details of all existing programs.
|
|
11224
|
+
* @summary List programs
|
|
11225
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
11226
|
+
* @param {*} [options] Override http request option.
|
|
11227
|
+
* @throws {RequiredError}
|
|
11228
|
+
*/
|
|
11229
|
+
listPrograms: async (cell: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
11230
|
+
// verify required parameter 'cell' is not null or undefined
|
|
11231
|
+
assertParamExists('listPrograms', 'cell', cell)
|
|
11232
|
+
const localVarPath = `/experimental/cells/{cell}/programs`
|
|
11233
|
+
.replace(`{${"cell"}}`, encodeURIComponent(String(cell)));
|
|
11234
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
11235
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
11236
|
+
let baseOptions;
|
|
11237
|
+
if (configuration) {
|
|
11238
|
+
baseOptions = configuration.baseOptions;
|
|
11239
|
+
}
|
|
11240
|
+
|
|
11241
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
11242
|
+
const localVarHeaderParameter = {} as any;
|
|
11243
|
+
const localVarQueryParameter = {} as any;
|
|
11244
|
+
|
|
11245
|
+
// authentication BasicAuth required
|
|
11246
|
+
// http basic authentication required
|
|
11247
|
+
setBasicAuthToObject(localVarRequestOptions, configuration)
|
|
11248
|
+
|
|
11249
|
+
// authentication BearerAuth required
|
|
11250
|
+
// http bearer authentication required
|
|
11251
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
11252
|
+
|
|
11253
|
+
|
|
11254
|
+
|
|
11255
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
11256
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
11257
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
11258
|
+
|
|
11259
|
+
return {
|
|
11260
|
+
url: toPathString(localVarUrlObj),
|
|
11261
|
+
options: localVarRequestOptions,
|
|
11262
|
+
};
|
|
11263
|
+
},
|
|
11264
|
+
/**
|
|
11265
|
+
* This endpoint starts a new program execution. The program will be executed asynchronously.
|
|
11266
|
+
* @summary Start the program
|
|
11267
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
11268
|
+
* @param {string} program
|
|
11269
|
+
* @param {ProgramStartRequest} programStartRequest
|
|
11270
|
+
* @param {*} [options] Override http request option.
|
|
11271
|
+
* @throws {RequiredError}
|
|
11272
|
+
*/
|
|
11273
|
+
startProgram: async (cell: string, program: string, programStartRequest: ProgramStartRequest, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
11274
|
+
// verify required parameter 'cell' is not null or undefined
|
|
11275
|
+
assertParamExists('startProgram', 'cell', cell)
|
|
11276
|
+
// verify required parameter 'program' is not null or undefined
|
|
11277
|
+
assertParamExists('startProgram', 'program', program)
|
|
11278
|
+
// verify required parameter 'programStartRequest' is not null or undefined
|
|
11279
|
+
assertParamExists('startProgram', 'programStartRequest', programStartRequest)
|
|
11280
|
+
const localVarPath = `/experimental/cells/{cell}/programs/{program}/start`
|
|
11281
|
+
.replace(`{${"cell"}}`, encodeURIComponent(String(cell)))
|
|
11282
|
+
.replace(`{${"program"}}`, encodeURIComponent(String(program)));
|
|
11283
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
11284
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
11285
|
+
let baseOptions;
|
|
11286
|
+
if (configuration) {
|
|
11287
|
+
baseOptions = configuration.baseOptions;
|
|
11288
|
+
}
|
|
11289
|
+
|
|
11290
|
+
const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
|
|
11291
|
+
const localVarHeaderParameter = {} as any;
|
|
11292
|
+
const localVarQueryParameter = {} as any;
|
|
11293
|
+
|
|
11294
|
+
// authentication BasicAuth required
|
|
11295
|
+
// http basic authentication required
|
|
11296
|
+
setBasicAuthToObject(localVarRequestOptions, configuration)
|
|
11297
|
+
|
|
11298
|
+
// authentication BearerAuth required
|
|
11299
|
+
// http bearer authentication required
|
|
11300
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
11301
|
+
|
|
11302
|
+
|
|
11303
|
+
|
|
11304
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
11305
|
+
|
|
11306
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
11307
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
11308
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
11309
|
+
localVarRequestOptions.data = serializeDataIfNeeded(programStartRequest, localVarRequestOptions, configuration)
|
|
11310
|
+
|
|
11311
|
+
return {
|
|
11312
|
+
url: toPathString(localVarUrlObj),
|
|
11313
|
+
options: localVarRequestOptions,
|
|
11314
|
+
};
|
|
11315
|
+
},
|
|
11316
|
+
/**
|
|
11317
|
+
* Stop a specific program run.
|
|
11318
|
+
* @summary Stop program run
|
|
11319
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
11320
|
+
* @param {string} program
|
|
11321
|
+
* @param {*} [options] Override http request option.
|
|
11322
|
+
* @throws {RequiredError}
|
|
11323
|
+
*/
|
|
11324
|
+
stopProgram: async (cell: string, program: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
11325
|
+
// verify required parameter 'cell' is not null or undefined
|
|
11326
|
+
assertParamExists('stopProgram', 'cell', cell)
|
|
11327
|
+
// verify required parameter 'program' is not null or undefined
|
|
11328
|
+
assertParamExists('stopProgram', 'program', program)
|
|
11329
|
+
const localVarPath = `/experimental/cells/{cell}/programs/{program}/stop`
|
|
11330
|
+
.replace(`{${"cell"}}`, encodeURIComponent(String(cell)))
|
|
11331
|
+
.replace(`{${"program"}}`, encodeURIComponent(String(program)));
|
|
11332
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
11333
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
11334
|
+
let baseOptions;
|
|
11335
|
+
if (configuration) {
|
|
11336
|
+
baseOptions = configuration.baseOptions;
|
|
11337
|
+
}
|
|
11338
|
+
|
|
11339
|
+
const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
|
|
11340
|
+
const localVarHeaderParameter = {} as any;
|
|
11341
|
+
const localVarQueryParameter = {} as any;
|
|
11342
|
+
|
|
11343
|
+
// authentication BasicAuth required
|
|
11344
|
+
// http basic authentication required
|
|
11345
|
+
setBasicAuthToObject(localVarRequestOptions, configuration)
|
|
11346
|
+
|
|
11347
|
+
// authentication BearerAuth required
|
|
11348
|
+
// http bearer authentication required
|
|
11349
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
11350
|
+
|
|
11351
|
+
|
|
11352
|
+
|
|
11353
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
11354
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
11355
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
11356
|
+
|
|
11357
|
+
return {
|
|
11358
|
+
url: toPathString(localVarUrlObj),
|
|
11359
|
+
options: localVarRequestOptions,
|
|
11360
|
+
};
|
|
11361
|
+
},
|
|
11362
|
+
}
|
|
11363
|
+
};
|
|
11364
|
+
|
|
11365
|
+
/**
|
|
11366
|
+
* ProgramApi - functional programming interface
|
|
11367
|
+
* @export
|
|
11368
|
+
*/
|
|
11369
|
+
export const ProgramApiFp = function(configuration?: Configuration) {
|
|
11370
|
+
const localVarAxiosParamCreator = ProgramApiAxiosParamCreator(configuration)
|
|
11371
|
+
return {
|
|
11372
|
+
/**
|
|
11373
|
+
* Get details of a program.
|
|
11374
|
+
* @summary Get program
|
|
11375
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
11376
|
+
* @param {string} program
|
|
11377
|
+
* @param {*} [options] Override http request option.
|
|
11378
|
+
* @throws {RequiredError}
|
|
11379
|
+
*/
|
|
11380
|
+
async getProgram(cell: string, program: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Program>> {
|
|
11381
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.getProgram(cell, program, options);
|
|
11382
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
11383
|
+
const localVarOperationServerBasePath = operationServerMap['ProgramApi.getProgram']?.[localVarOperationServerIndex]?.url;
|
|
11384
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
11385
|
+
},
|
|
11386
|
+
/**
|
|
11387
|
+
* List details of all existing programs.
|
|
11388
|
+
* @summary List programs
|
|
11389
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
11390
|
+
* @param {*} [options] Override http request option.
|
|
11391
|
+
* @throws {RequiredError}
|
|
11392
|
+
*/
|
|
11393
|
+
async listPrograms(cell: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<Program>>> {
|
|
11394
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.listPrograms(cell, options);
|
|
11395
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
11396
|
+
const localVarOperationServerBasePath = operationServerMap['ProgramApi.listPrograms']?.[localVarOperationServerIndex]?.url;
|
|
11397
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
11398
|
+
},
|
|
11399
|
+
/**
|
|
11400
|
+
* This endpoint starts a new program execution. The program will be executed asynchronously.
|
|
11401
|
+
* @summary Start the program
|
|
11402
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
11403
|
+
* @param {string} program
|
|
11404
|
+
* @param {ProgramStartRequest} programStartRequest
|
|
11405
|
+
* @param {*} [options] Override http request option.
|
|
11406
|
+
* @throws {RequiredError}
|
|
11407
|
+
*/
|
|
11408
|
+
async startProgram(cell: string, program: string, programStartRequest: ProgramStartRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ProgramRun>> {
|
|
11409
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.startProgram(cell, program, programStartRequest, options);
|
|
11410
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
11411
|
+
const localVarOperationServerBasePath = operationServerMap['ProgramApi.startProgram']?.[localVarOperationServerIndex]?.url;
|
|
11412
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
11413
|
+
},
|
|
11414
|
+
/**
|
|
11415
|
+
* Stop a specific program run.
|
|
11416
|
+
* @summary Stop program run
|
|
11417
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
11418
|
+
* @param {string} program
|
|
11419
|
+
* @param {*} [options] Override http request option.
|
|
11420
|
+
* @throws {RequiredError}
|
|
11421
|
+
*/
|
|
11422
|
+
async stopProgram(cell: string, program: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> {
|
|
11423
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.stopProgram(cell, program, options);
|
|
11424
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
11425
|
+
const localVarOperationServerBasePath = operationServerMap['ProgramApi.stopProgram']?.[localVarOperationServerIndex]?.url;
|
|
11426
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
11427
|
+
},
|
|
11428
|
+
}
|
|
11429
|
+
};
|
|
11430
|
+
|
|
11431
|
+
/**
|
|
11432
|
+
* ProgramApi - factory interface
|
|
11433
|
+
* @export
|
|
11434
|
+
*/
|
|
11435
|
+
export const ProgramApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
|
|
11436
|
+
const localVarFp = ProgramApiFp(configuration)
|
|
11437
|
+
return {
|
|
11438
|
+
/**
|
|
11439
|
+
* Get details of a program.
|
|
11440
|
+
* @summary Get program
|
|
11441
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
11442
|
+
* @param {string} program
|
|
11443
|
+
* @param {*} [options] Override http request option.
|
|
11444
|
+
* @throws {RequiredError}
|
|
11445
|
+
*/
|
|
11446
|
+
getProgram(cell: string, program: string, options?: RawAxiosRequestConfig): AxiosPromise<Program> {
|
|
11447
|
+
return localVarFp.getProgram(cell, program, options).then((request) => request(axios, basePath));
|
|
11448
|
+
},
|
|
11449
|
+
/**
|
|
11450
|
+
* List details of all existing programs.
|
|
11451
|
+
* @summary List programs
|
|
11452
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
11453
|
+
* @param {*} [options] Override http request option.
|
|
11454
|
+
* @throws {RequiredError}
|
|
11455
|
+
*/
|
|
11456
|
+
listPrograms(cell: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<Program>> {
|
|
11457
|
+
return localVarFp.listPrograms(cell, options).then((request) => request(axios, basePath));
|
|
11458
|
+
},
|
|
11459
|
+
/**
|
|
11460
|
+
* This endpoint starts a new program execution. The program will be executed asynchronously.
|
|
11461
|
+
* @summary Start the program
|
|
11462
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
11463
|
+
* @param {string} program
|
|
11464
|
+
* @param {ProgramStartRequest} programStartRequest
|
|
11465
|
+
* @param {*} [options] Override http request option.
|
|
11466
|
+
* @throws {RequiredError}
|
|
11467
|
+
*/
|
|
11468
|
+
startProgram(cell: string, program: string, programStartRequest: ProgramStartRequest, options?: RawAxiosRequestConfig): AxiosPromise<ProgramRun> {
|
|
11469
|
+
return localVarFp.startProgram(cell, program, programStartRequest, options).then((request) => request(axios, basePath));
|
|
11470
|
+
},
|
|
11471
|
+
/**
|
|
11472
|
+
* Stop a specific program run.
|
|
11473
|
+
* @summary Stop program run
|
|
11474
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
11475
|
+
* @param {string} program
|
|
11476
|
+
* @param {*} [options] Override http request option.
|
|
11477
|
+
* @throws {RequiredError}
|
|
11478
|
+
*/
|
|
11479
|
+
stopProgram(cell: string, program: string, options?: RawAxiosRequestConfig): AxiosPromise<void> {
|
|
11480
|
+
return localVarFp.stopProgram(cell, program, options).then((request) => request(axios, basePath));
|
|
11481
|
+
},
|
|
11482
|
+
};
|
|
11483
|
+
};
|
|
11484
|
+
|
|
11485
|
+
/**
|
|
11486
|
+
* ProgramApi - object-oriented interface
|
|
11487
|
+
* @export
|
|
11488
|
+
* @class ProgramApi
|
|
11489
|
+
* @extends {BaseAPI}
|
|
11490
|
+
*/
|
|
11491
|
+
export class ProgramApi extends BaseAPI {
|
|
11492
|
+
/**
|
|
11493
|
+
* Get details of a program.
|
|
11494
|
+
* @summary Get program
|
|
11495
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
11496
|
+
* @param {string} program
|
|
11497
|
+
* @param {*} [options] Override http request option.
|
|
11498
|
+
* @throws {RequiredError}
|
|
11499
|
+
* @memberof ProgramApi
|
|
11500
|
+
*/
|
|
11501
|
+
public getProgram(cell: string, program: string, options?: RawAxiosRequestConfig) {
|
|
11502
|
+
return ProgramApiFp(this.configuration).getProgram(cell, program, options).then((request) => request(this.axios, this.basePath));
|
|
11503
|
+
}
|
|
11504
|
+
|
|
11505
|
+
/**
|
|
11506
|
+
* List details of all existing programs.
|
|
11507
|
+
* @summary List programs
|
|
11508
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
11509
|
+
* @param {*} [options] Override http request option.
|
|
11510
|
+
* @throws {RequiredError}
|
|
11511
|
+
* @memberof ProgramApi
|
|
11512
|
+
*/
|
|
11513
|
+
public listPrograms(cell: string, options?: RawAxiosRequestConfig) {
|
|
11514
|
+
return ProgramApiFp(this.configuration).listPrograms(cell, options).then((request) => request(this.axios, this.basePath));
|
|
11515
|
+
}
|
|
11516
|
+
|
|
11517
|
+
/**
|
|
11518
|
+
* This endpoint starts a new program execution. The program will be executed asynchronously.
|
|
11519
|
+
* @summary Start the program
|
|
11520
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
11521
|
+
* @param {string} program
|
|
11522
|
+
* @param {ProgramStartRequest} programStartRequest
|
|
11523
|
+
* @param {*} [options] Override http request option.
|
|
11524
|
+
* @throws {RequiredError}
|
|
11525
|
+
* @memberof ProgramApi
|
|
11526
|
+
*/
|
|
11527
|
+
public startProgram(cell: string, program: string, programStartRequest: ProgramStartRequest, options?: RawAxiosRequestConfig) {
|
|
11528
|
+
return ProgramApiFp(this.configuration).startProgram(cell, program, programStartRequest, options).then((request) => request(this.axios, this.basePath));
|
|
11529
|
+
}
|
|
11530
|
+
|
|
11531
|
+
/**
|
|
11532
|
+
* Stop a specific program run.
|
|
11533
|
+
* @summary Stop program run
|
|
11534
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
11535
|
+
* @param {string} program
|
|
11536
|
+
* @param {*} [options] Override http request option.
|
|
11537
|
+
* @throws {RequiredError}
|
|
11538
|
+
* @memberof ProgramApi
|
|
11539
|
+
*/
|
|
11540
|
+
public stopProgram(cell: string, program: string, options?: RawAxiosRequestConfig) {
|
|
11541
|
+
return ProgramApiFp(this.configuration).stopProgram(cell, program, options).then((request) => request(this.axios, this.basePath));
|
|
11542
|
+
}
|
|
11543
|
+
}
|
|
11544
|
+
|
|
11545
|
+
|
|
11546
|
+
|
|
10921
11547
|
/**
|
|
10922
11548
|
* StoreCollisionComponentsApi - axios parameter creator
|
|
10923
11549
|
* @export
|
|
@@ -11243,7 +11869,7 @@ export const StoreCollisionComponentsApiAxiosParamCreator = function (configurat
|
|
|
11243
11869
|
};
|
|
11244
11870
|
},
|
|
11245
11871
|
/**
|
|
11246
|
-
* Returns
|
|
11872
|
+
* Returns all stored colliders.
|
|
11247
11873
|
* @summary List Colliders
|
|
11248
11874
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
11249
11875
|
* @param {*} [options] Override http request option.
|
|
@@ -11590,7 +12216,7 @@ export const StoreCollisionComponentsApiFp = function(configuration?: Configurat
|
|
|
11590
12216
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
11591
12217
|
},
|
|
11592
12218
|
/**
|
|
11593
|
-
* Returns
|
|
12219
|
+
* Returns all stored colliders.
|
|
11594
12220
|
* @summary List Colliders
|
|
11595
12221
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
11596
12222
|
* @param {*} [options] Override http request option.
|
|
@@ -11747,7 +12373,7 @@ export const StoreCollisionComponentsApiFactory = function (configuration?: Conf
|
|
|
11747
12373
|
return localVarFp.listCollisionLinkChains(cell, options).then((request) => request(axios, basePath));
|
|
11748
12374
|
},
|
|
11749
12375
|
/**
|
|
11750
|
-
* Returns
|
|
12376
|
+
* Returns all stored colliders.
|
|
11751
12377
|
* @summary List Colliders
|
|
11752
12378
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
11753
12379
|
* @param {*} [options] Override http request option.
|
|
@@ -11903,7 +12529,7 @@ export class StoreCollisionComponentsApi extends BaseAPI {
|
|
|
11903
12529
|
}
|
|
11904
12530
|
|
|
11905
12531
|
/**
|
|
11906
|
-
* Returns
|
|
12532
|
+
* Returns all stored colliders.
|
|
11907
12533
|
* @summary List Colliders
|
|
11908
12534
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
11909
12535
|
* @param {*} [options] Override http request option.
|