@wandelbots/nova-api 25.8.0-dev.5 → 25.8.0-dev.51
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/package.json +1 -1
- package/v2/api.d.ts +592 -140
- package/v2/api.js +402 -51
- package/v2/api.js.map +1 -1
- package/v2/api.ts +781 -136
package/v2/api.d.ts
CHANGED
|
@@ -93,7 +93,7 @@ export interface AddTrajectoryError {
|
|
|
93
93
|
*/
|
|
94
94
|
'message'?: string;
|
|
95
95
|
/**
|
|
96
|
-
* The
|
|
96
|
+
* 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
|
|
97
97
|
* @type {number}
|
|
98
98
|
* @memberof AddTrajectoryError
|
|
99
99
|
*/
|
|
@@ -342,7 +342,7 @@ export declare const BoxBoxTypeEnum: {
|
|
|
342
342
|
};
|
|
343
343
|
export type BoxBoxTypeEnum = typeof BoxBoxTypeEnum[keyof typeof BoxBoxTypeEnum];
|
|
344
344
|
/**
|
|
345
|
-
* PROFINET BUS
|
|
345
|
+
* PROFINET BUS inputs/outputs service configuration.
|
|
346
346
|
* @export
|
|
347
347
|
* @interface BusIOProfinet
|
|
348
348
|
*/
|
|
@@ -354,19 +354,19 @@ export interface BusIOProfinet {
|
|
|
354
354
|
*/
|
|
355
355
|
'bus_type'?: BusIOProfinetBusTypeEnum;
|
|
356
356
|
/**
|
|
357
|
-
*
|
|
358
|
-
* @type {
|
|
357
|
+
* Used to enable IP communication through the same physical ethernet interface while PROFINET driver is active.
|
|
358
|
+
* @type {BusIOProfinetNetwork}
|
|
359
359
|
* @memberof BusIOProfinet
|
|
360
360
|
*/
|
|
361
|
-
'
|
|
361
|
+
'network_config'?: BusIOProfinetNetwork;
|
|
362
362
|
/**
|
|
363
|
-
*
|
|
364
|
-
* @type {
|
|
363
|
+
* 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.
|
|
364
|
+
* @type {string}
|
|
365
365
|
* @memberof BusIOProfinet
|
|
366
366
|
*/
|
|
367
|
-
'
|
|
367
|
+
'plc_ip': string;
|
|
368
368
|
/**
|
|
369
|
-
* MAC address
|
|
369
|
+
* MAC address of the physical ethernet interface that you want to use for PROFINET communication.
|
|
370
370
|
* @type {string}
|
|
371
371
|
* @memberof BusIOProfinet
|
|
372
372
|
*/
|
|
@@ -383,7 +383,7 @@ export declare const BusIOProfinetBusTypeEnum: {
|
|
|
383
383
|
};
|
|
384
384
|
export type BusIOProfinetBusTypeEnum = typeof BusIOProfinetBusTypeEnum[keyof typeof BusIOProfinetBusTypeEnum];
|
|
385
385
|
/**
|
|
386
|
-
*
|
|
386
|
+
* Current default route configuration of your NOVA instance. The default route is a setting that tells data where to go if there isn’t a specific path already known for its destination. Usually this will be the path to your router, enabling accessing the internet. On Linux, use `ip route show` to view your default routes and match the output `default via <gateway> dev <interface> ...` to get your gateway and interface.
|
|
387
387
|
* @export
|
|
388
388
|
* @interface BusIOProfinetDefaultRoute
|
|
389
389
|
*/
|
|
@@ -402,25 +402,25 @@ export interface BusIOProfinetDefaultRoute {
|
|
|
402
402
|
'interface': string;
|
|
403
403
|
}
|
|
404
404
|
/**
|
|
405
|
-
* Network configuration
|
|
405
|
+
* Network configuration or IPv4 record of the virtual ethernet interface (pnio1) created by the PROFINET driver. The IPv4 record is used in combination with the Name of Station (NoS) to identify your device in the PROFINET network. The `ip_config` will be used as IPv4 record if no REMA XML file is already present on your machine and no `rema_xml_content` is provided.
|
|
406
406
|
* @export
|
|
407
407
|
* @interface BusIOProfinetIpConfig
|
|
408
408
|
*/
|
|
409
409
|
export interface BusIOProfinetIpConfig {
|
|
410
410
|
/**
|
|
411
|
-
* IP address for the
|
|
411
|
+
* IP address for the device\'s virtual ethernet interface (pnio1).
|
|
412
412
|
* @type {string}
|
|
413
413
|
* @memberof BusIOProfinetIpConfig
|
|
414
414
|
*/
|
|
415
415
|
'ip': string;
|
|
416
416
|
/**
|
|
417
|
-
* Network mask for the
|
|
417
|
+
* Network mask for the device\'s virtual ethernet interface (pnio1).
|
|
418
418
|
* @type {string}
|
|
419
419
|
* @memberof BusIOProfinetIpConfig
|
|
420
420
|
*/
|
|
421
421
|
'netmask': string;
|
|
422
422
|
/**
|
|
423
|
-
* Gateway for the
|
|
423
|
+
* Gateway for connections to other devices outside of the virtual ethernet interface\'s subnet.
|
|
424
424
|
* @type {string}
|
|
425
425
|
* @memberof BusIOProfinetIpConfig
|
|
426
426
|
*/
|
|
@@ -433,7 +433,7 @@ export interface BusIOProfinetIpConfig {
|
|
|
433
433
|
*/
|
|
434
434
|
export interface BusIOProfinetNetwork {
|
|
435
435
|
/**
|
|
436
|
-
* Name of the PROFINET device.
|
|
436
|
+
* Name of Station (NoS) of the PROFINET device. The NoS is used in combination with IPv4 record to identify your device in the PROFINET network. The `device_name` will be used as NoS if no REMA XML file is already present on your machine and no `rema_xml_content` is provided.
|
|
437
437
|
* @type {string}
|
|
438
438
|
* @memberof BusIOProfinetNetwork
|
|
439
439
|
*/
|
|
@@ -445,14 +445,14 @@ export interface BusIOProfinetNetwork {
|
|
|
445
445
|
*/
|
|
446
446
|
'ip_config'?: BusIOProfinetIpConfig;
|
|
447
447
|
/**
|
|
448
|
-
* Content of the PROFINET REMA XML file.
|
|
448
|
+
* Content of the PROFINET REMA XML file. Is used when PROFINET service is added for the first time to create the REMA XML file that holds data to be kept for the next session. Stores information like IP address, Name of Station (NoS) and hardware configuration. If you use a PROFINET controller to assign an IP address to the PROFINET device, this information will be written to the REMA XML file. Refer to the PDF version of the \"PN Driver I/O Base programming interface\" documentation for more information and an example REMA file.
|
|
449
449
|
* @type {string}
|
|
450
450
|
* @memberof BusIOProfinetNetwork
|
|
451
451
|
*/
|
|
452
452
|
'rema_xml_content'?: string;
|
|
453
453
|
}
|
|
454
454
|
/**
|
|
455
|
-
* Virtual PROFINET BUS
|
|
455
|
+
* Virtual PROFINET BUS inputs/outputs service configuration.
|
|
456
456
|
* @export
|
|
457
457
|
* @interface BusIOProfinetVirtual
|
|
458
458
|
*/
|
|
@@ -465,7 +465,7 @@ export interface BusIOProfinetVirtual {
|
|
|
465
465
|
'bus_type'?: BusIOProfinetVirtualBusTypeEnum;
|
|
466
466
|
}
|
|
467
467
|
export declare const BusIOProfinetVirtualBusTypeEnum: {
|
|
468
|
-
readonly
|
|
468
|
+
readonly ProfinetVirtual: "profinet_virtual";
|
|
469
469
|
};
|
|
470
470
|
export type BusIOProfinetVirtualBusTypeEnum = typeof BusIOProfinetVirtualBusTypeEnum[keyof typeof BusIOProfinetVirtualBusTypeEnum];
|
|
471
471
|
/**
|
|
@@ -490,7 +490,7 @@ export interface BusIOsState {
|
|
|
490
490
|
*/
|
|
491
491
|
'state': BusIOsStateEnum;
|
|
492
492
|
/**
|
|
493
|
-
* A message providing additional information on the input/output, e.g. BUS service status, encountered errors. May be empty if no additional information is available.
|
|
493
|
+
* A message providing additional information on the input/output service, e.g. BUS service status, encountered errors. May be empty if no additional information is available.
|
|
494
494
|
* @type {string}
|
|
495
495
|
* @memberof BusIOsState
|
|
496
496
|
*/
|
|
@@ -1708,9 +1708,22 @@ export interface GetTrajectoryResponse {
|
|
|
1708
1708
|
export interface HTTPValidationError {
|
|
1709
1709
|
/**
|
|
1710
1710
|
*
|
|
1711
|
-
* @type {Array<
|
|
1711
|
+
* @type {Array<ValidationError2>}
|
|
1712
1712
|
* @memberof HTTPValidationError
|
|
1713
1713
|
*/
|
|
1714
|
+
'detail'?: Array<ValidationError2>;
|
|
1715
|
+
}
|
|
1716
|
+
/**
|
|
1717
|
+
*
|
|
1718
|
+
* @export
|
|
1719
|
+
* @interface HTTPValidationError2
|
|
1720
|
+
*/
|
|
1721
|
+
export interface HTTPValidationError2 {
|
|
1722
|
+
/**
|
|
1723
|
+
*
|
|
1724
|
+
* @type {Array<ValidationError>}
|
|
1725
|
+
* @memberof HTTPValidationError2
|
|
1726
|
+
*/
|
|
1714
1727
|
'detail'?: Array<ValidationError>;
|
|
1715
1728
|
}
|
|
1716
1729
|
/**
|
|
@@ -1797,6 +1810,55 @@ export interface IODescription {
|
|
|
1797
1810
|
*/
|
|
1798
1811
|
'max'?: IODescriptionMin;
|
|
1799
1812
|
}
|
|
1813
|
+
/**
|
|
1814
|
+
*
|
|
1815
|
+
* @export
|
|
1816
|
+
* @interface IODescription2
|
|
1817
|
+
*/
|
|
1818
|
+
export interface IODescription2 {
|
|
1819
|
+
/**
|
|
1820
|
+
* Unique identifier of the input/output.
|
|
1821
|
+
* @type {string}
|
|
1822
|
+
* @memberof IODescription2
|
|
1823
|
+
*/
|
|
1824
|
+
'io': string;
|
|
1825
|
+
/**
|
|
1826
|
+
* Descriptive name of the input/output. Customize it using the respective BUS service, e.g. [addProfinetIO](addProfinetIO) for PROFINET service.
|
|
1827
|
+
* @type {string}
|
|
1828
|
+
* @memberof IODescription2
|
|
1829
|
+
*/
|
|
1830
|
+
'name': string;
|
|
1831
|
+
/**
|
|
1832
|
+
*
|
|
1833
|
+
* @type {IODirection}
|
|
1834
|
+
* @memberof IODescription2
|
|
1835
|
+
*/
|
|
1836
|
+
'direction': IODirection;
|
|
1837
|
+
/**
|
|
1838
|
+
*
|
|
1839
|
+
* @type {IOValueType}
|
|
1840
|
+
* @memberof IODescription2
|
|
1841
|
+
*/
|
|
1842
|
+
'value_type': IOValueType;
|
|
1843
|
+
/**
|
|
1844
|
+
*
|
|
1845
|
+
* @type {UnitType}
|
|
1846
|
+
* @memberof IODescription2
|
|
1847
|
+
*/
|
|
1848
|
+
'unit'?: UnitType;
|
|
1849
|
+
/**
|
|
1850
|
+
*
|
|
1851
|
+
* @type {IODescriptionMin}
|
|
1852
|
+
* @memberof IODescription2
|
|
1853
|
+
*/
|
|
1854
|
+
'min'?: IODescriptionMin;
|
|
1855
|
+
/**
|
|
1856
|
+
*
|
|
1857
|
+
* @type {IODescriptionMin}
|
|
1858
|
+
* @memberof IODescription2
|
|
1859
|
+
*/
|
|
1860
|
+
'max'?: IODescriptionMin;
|
|
1861
|
+
}
|
|
1800
1862
|
/**
|
|
1801
1863
|
* @type IODescriptionMin
|
|
1802
1864
|
* @export
|
|
@@ -1860,7 +1922,7 @@ export interface IOIntegerValue {
|
|
|
1860
1922
|
*/
|
|
1861
1923
|
'io': string;
|
|
1862
1924
|
/**
|
|
1863
|
-
* Value of an input/output with integer representation. > The integral value is transmitted as a string to avoid precision loss during conversion to JSON. >
|
|
1925
|
+
* Value of an input/output with integer representation. > The integral value is transmitted as a string to avoid precision loss during conversion to JSON. > Recommended: Use int64 in your implementation. If you want to interact with int64 in numbers, > JS bigint libraries can help you to parse the string into an integral value.
|
|
1864
1926
|
* @type {string}
|
|
1865
1927
|
* @memberof IOIntegerValue
|
|
1866
1928
|
*/
|
|
@@ -1985,24 +2047,12 @@ export interface InitializeJoggingRequest {
|
|
|
1985
2047
|
* @memberof InitializeJoggingRequest
|
|
1986
2048
|
*/
|
|
1987
2049
|
'tcp'?: string;
|
|
1988
|
-
/**
|
|
1989
|
-
* 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.
|
|
1990
|
-
* @type {number}
|
|
1991
|
-
* @memberof InitializeJoggingRequest
|
|
1992
|
-
*/
|
|
1993
|
-
'response_rate'?: number;
|
|
1994
2050
|
/**
|
|
1995
2051
|
* Unique identifier addressing a coordinate system to which the responses are transformed. If not set, world coordinate system is used.
|
|
1996
2052
|
* @type {string}
|
|
1997
2053
|
* @memberof InitializeJoggingRequest
|
|
1998
2054
|
*/
|
|
1999
2055
|
'response_coordinate_system'?: string;
|
|
2000
|
-
/**
|
|
2001
|
-
* Defines an input/output that is listened to during the movement. Execution pauses if the defined comparator evaluates to `true`.
|
|
2002
|
-
* @type {string}
|
|
2003
|
-
* @memberof InitializeJoggingRequest
|
|
2004
|
-
*/
|
|
2005
|
-
'pause_on_io'?: string;
|
|
2006
2056
|
}
|
|
2007
2057
|
export declare const InitializeJoggingRequestMessageTypeEnum: {
|
|
2008
2058
|
readonly InitializeJoggingRequest: "InitializeJoggingRequest";
|
|
@@ -2055,12 +2105,6 @@ export interface InitializeMovementRequest {
|
|
|
2055
2105
|
* @memberof InitializeMovementRequest
|
|
2056
2106
|
*/
|
|
2057
2107
|
'initial_location'?: number;
|
|
2058
|
-
/**
|
|
2059
|
-
* 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.
|
|
2060
|
-
* @type {number}
|
|
2061
|
-
* @memberof InitializeMovementRequest
|
|
2062
|
-
*/
|
|
2063
|
-
'response_rate'?: number;
|
|
2064
2108
|
/**
|
|
2065
2109
|
* Unique identifier addressing a coordinate system to which the responses are transformed. If not set, world coordinate system is used.
|
|
2066
2110
|
* @type {string}
|
|
@@ -2112,7 +2156,7 @@ export declare const InitializeMovementResponseKindEnum: {
|
|
|
2112
2156
|
};
|
|
2113
2157
|
export type InitializeMovementResponseKindEnum = typeof InitializeMovementResponseKindEnum[keyof typeof InitializeMovementResponseKindEnum];
|
|
2114
2158
|
/**
|
|
2115
|
-
* Value of an input/output with integer representation. > The integral value is transmitted as a string to avoid precision loss during conversion to JSON. >
|
|
2159
|
+
* Value of an input/output with integer representation. > The integral value is transmitted as a string to avoid precision loss during conversion to JSON. > Recommended: Use int64 in your implementation. If you want to interact with int64 in numbers, > JS bigint libraries can help you to parse the string into an integral value.
|
|
2116
2160
|
* @export
|
|
2117
2161
|
* @interface IntegerValue
|
|
2118
2162
|
*/
|
|
@@ -2313,9 +2357,19 @@ export type JoggingDetailsKindEnum = typeof JoggingDetailsKindEnum[keyof typeof
|
|
|
2313
2357
|
* @type JoggingDetailsState
|
|
2314
2358
|
* @export
|
|
2315
2359
|
*/
|
|
2316
|
-
export type JoggingDetailsState =
|
|
2360
|
+
export type JoggingDetailsState = {
|
|
2361
|
+
kind: 'PAUSED_BY_USER';
|
|
2362
|
+
} & JoggingPausedByUser | {
|
|
2363
|
+
kind: 'PAUSED_NEAR_COLLISION';
|
|
2364
|
+
} & JoggingPausedNearCollision | {
|
|
2365
|
+
kind: 'PAUSED_NEAR_JOINT_LIMIT';
|
|
2366
|
+
} & JoggingPausedNearJointLimit | {
|
|
2367
|
+
kind: 'PAUSED_ON_IO';
|
|
2368
|
+
} & JoggingPausedOnIO | {
|
|
2369
|
+
kind: 'RUNNING';
|
|
2370
|
+
} & JoggingRunning;
|
|
2317
2371
|
/**
|
|
2318
|
-
*
|
|
2372
|
+
* User has paused jogging.
|
|
2319
2373
|
* @export
|
|
2320
2374
|
* @interface JoggingPausedByUser
|
|
2321
2375
|
*/
|
|
@@ -2332,7 +2386,7 @@ export declare const JoggingPausedByUserKindEnum: {
|
|
|
2332
2386
|
};
|
|
2333
2387
|
export type JoggingPausedByUserKindEnum = typeof JoggingPausedByUserKindEnum[keyof typeof JoggingPausedByUserKindEnum];
|
|
2334
2388
|
/**
|
|
2335
|
-
*
|
|
2389
|
+
* Jogging was paused because the motion group neared a collision.
|
|
2336
2390
|
* @export
|
|
2337
2391
|
* @interface JoggingPausedNearCollision
|
|
2338
2392
|
*/
|
|
@@ -2355,7 +2409,7 @@ export declare const JoggingPausedNearCollisionKindEnum: {
|
|
|
2355
2409
|
};
|
|
2356
2410
|
export type JoggingPausedNearCollisionKindEnum = typeof JoggingPausedNearCollisionKindEnum[keyof typeof JoggingPausedNearCollisionKindEnum];
|
|
2357
2411
|
/**
|
|
2358
|
-
*
|
|
2412
|
+
* Jogging was paused because a joint is near its limit.
|
|
2359
2413
|
* @export
|
|
2360
2414
|
* @interface JoggingPausedNearJointLimit
|
|
2361
2415
|
*/
|
|
@@ -2378,7 +2432,7 @@ export declare const JoggingPausedNearJointLimitKindEnum: {
|
|
|
2378
2432
|
};
|
|
2379
2433
|
export type JoggingPausedNearJointLimitKindEnum = typeof JoggingPausedNearJointLimitKindEnum[keyof typeof JoggingPausedNearJointLimitKindEnum];
|
|
2380
2434
|
/**
|
|
2381
|
-
*
|
|
2435
|
+
* Jogging was paused because of an I/O event.
|
|
2382
2436
|
* @export
|
|
2383
2437
|
* @interface JoggingPausedOnIO
|
|
2384
2438
|
*/
|
|
@@ -2395,7 +2449,7 @@ export declare const JoggingPausedOnIOKindEnum: {
|
|
|
2395
2449
|
};
|
|
2396
2450
|
export type JoggingPausedOnIOKindEnum = typeof JoggingPausedOnIOKindEnum[keyof typeof JoggingPausedOnIOKindEnum];
|
|
2397
2451
|
/**
|
|
2398
|
-
*
|
|
2452
|
+
* Jogging is active.
|
|
2399
2453
|
* @export
|
|
2400
2454
|
* @interface JoggingRunning
|
|
2401
2455
|
*/
|
|
@@ -2474,7 +2528,7 @@ export interface JointTrajectory {
|
|
|
2474
2528
|
*/
|
|
2475
2529
|
'times': Array<number>;
|
|
2476
2530
|
/**
|
|
2477
|
-
*
|
|
2531
|
+
*
|
|
2478
2532
|
* @type {Array<number>}
|
|
2479
2533
|
* @memberof JointTrajectory
|
|
2480
2534
|
*/
|
|
@@ -2749,6 +2803,12 @@ export interface LimitSet {
|
|
|
2749
2803
|
* @memberof LimitSet
|
|
2750
2804
|
*/
|
|
2751
2805
|
'flange'?: CartesianLimits;
|
|
2806
|
+
/**
|
|
2807
|
+
*
|
|
2808
|
+
* @type {JointLimits}
|
|
2809
|
+
* @memberof LimitSet
|
|
2810
|
+
*/
|
|
2811
|
+
'coupled_shoulder_elbow_joint'?: JointLimits;
|
|
2752
2812
|
}
|
|
2753
2813
|
/**
|
|
2754
2814
|
* If a limit is not set, the default value will be used.
|
|
@@ -2820,13 +2880,13 @@ export declare const Manufacturer: {
|
|
|
2820
2880
|
};
|
|
2821
2881
|
export type Manufacturer = typeof Manufacturer[keyof typeof Manufacturer];
|
|
2822
2882
|
/**
|
|
2823
|
-
*
|
|
2883
|
+
*
|
|
2824
2884
|
* @export
|
|
2825
2885
|
* @interface MidpointInsertionAlgorithm
|
|
2826
2886
|
*/
|
|
2827
2887
|
export interface MidpointInsertionAlgorithm {
|
|
2828
2888
|
/**
|
|
2829
|
-
* Algorithm discriminator.
|
|
2889
|
+
* Algorithm discriminator. Midpoint insertion algorithm configuration for collision-free path planning. This algorithm adds a single midpoint between the start and target joint position to find collision-free paths.
|
|
2830
2890
|
* @type {string}
|
|
2831
2891
|
* @memberof MidpointInsertionAlgorithm
|
|
2832
2892
|
*/
|
|
@@ -3687,11 +3747,11 @@ export interface PlanTrajectoryFailedResponse {
|
|
|
3687
3747
|
*/
|
|
3688
3748
|
'error_feedback': PlanTrajectoryFailedResponseErrorFeedback;
|
|
3689
3749
|
/**
|
|
3690
|
-
*
|
|
3750
|
+
* 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
|
|
3691
3751
|
* @type {number}
|
|
3692
3752
|
* @memberof PlanTrajectoryFailedResponse
|
|
3693
3753
|
*/
|
|
3694
|
-
'error_location_on_trajectory'
|
|
3754
|
+
'error_location_on_trajectory': number;
|
|
3695
3755
|
/**
|
|
3696
3756
|
* The joint trajectory from the start joint position to the error.
|
|
3697
3757
|
* @type {JointTrajectory}
|
|
@@ -3905,17 +3965,17 @@ export interface ProfinetDescription {
|
|
|
3905
3965
|
*/
|
|
3906
3966
|
'slots'?: Array<ProfinetSlotDescription>;
|
|
3907
3967
|
/**
|
|
3908
|
-
* Name of the PROFINET device
|
|
3968
|
+
* Name of Station (NoS) of the PROFINET device. The NoS is used in combination with IPv4 record to identify your device in the PROFINET network. The `device_name` will be used as NoS if no REMA XML file is already present on your NOVA instance and no `rema_xml_content` is provided.
|
|
3909
3969
|
* @type {string}
|
|
3910
3970
|
* @memberof ProfinetDescription
|
|
3911
3971
|
*/
|
|
3912
3972
|
'device_name'?: string;
|
|
3913
3973
|
/**
|
|
3914
|
-
*
|
|
3915
|
-
* @type {
|
|
3974
|
+
*
|
|
3975
|
+
* @type {BusIOProfinetIpConfig}
|
|
3916
3976
|
* @memberof ProfinetDescription
|
|
3917
3977
|
*/
|
|
3918
|
-
'
|
|
3978
|
+
'ip_config'?: BusIOProfinetIpConfig;
|
|
3919
3979
|
}
|
|
3920
3980
|
/**
|
|
3921
3981
|
*
|
|
@@ -3924,7 +3984,7 @@ export interface ProfinetDescription {
|
|
|
3924
3984
|
*/
|
|
3925
3985
|
export interface ProfinetIO {
|
|
3926
3986
|
/**
|
|
3927
|
-
* The name of the input/output
|
|
3987
|
+
* The name of the input/output variable. This is a human-readable identifier for the value. It distinguishes between different inputs/outputs variables in the system. The variables may be used to set bits or bytes at their pointed to address via [setBusIOValues](setBusIOValues).
|
|
3928
3988
|
* @type {string}
|
|
3929
3989
|
* @memberof ProfinetIO
|
|
3930
3990
|
*/
|
|
@@ -3936,25 +3996,25 @@ export interface ProfinetIO {
|
|
|
3936
3996
|
*/
|
|
3937
3997
|
'type': ProfinetIOTypeEnum;
|
|
3938
3998
|
/**
|
|
3939
|
-
* The direction of the input/output
|
|
3999
|
+
* The direction of the input/output variable, indicating whether it is an input or output for the PROFINET device, e.g. NOVA\'s PROFINET service.
|
|
3940
4000
|
* @type {ProfinetIODirection}
|
|
3941
4001
|
* @memberof ProfinetIO
|
|
3942
4002
|
*/
|
|
3943
4003
|
'direction': ProfinetIODirection;
|
|
3944
4004
|
/**
|
|
3945
|
-
* The byte address of the input/output
|
|
4005
|
+
* The byte address of the input/output variable in the PROFINET device, e.g. NOVA\'s PROFINET service. The byte address is used to locate the specific input/output variable within the device\'s memory or data structure.
|
|
3946
4006
|
* @type {number}
|
|
3947
4007
|
* @memberof ProfinetIO
|
|
3948
4008
|
*/
|
|
3949
4009
|
'byte_address': number;
|
|
3950
4010
|
/**
|
|
3951
|
-
* The bit address of the input/output
|
|
4011
|
+
* The bit address of the input/output variable within the byte or word address. The bit address is used to specify the exact bit within the byte or word that corresponds to the input/output variable.
|
|
3952
4012
|
* @type {number}
|
|
3953
4013
|
* @memberof ProfinetIO
|
|
3954
4014
|
*/
|
|
3955
4015
|
'bit_address'?: number;
|
|
3956
4016
|
/**
|
|
3957
|
-
* The unique identifier for the input/output value. This identifier is used to reference the specific input/output in the NOVA
|
|
4017
|
+
* The unique identifier for the input/output value. This identifier is used to reference the specific input/output variable in the PROFINET device, e.g. NOVA\'s PROFINET service.
|
|
3958
4018
|
* @type {string}
|
|
3959
4019
|
* @memberof ProfinetIO
|
|
3960
4020
|
*/
|
|
@@ -3967,7 +4027,7 @@ export interface ProfinetIO {
|
|
|
3967
4027
|
*/
|
|
3968
4028
|
export interface ProfinetIOData {
|
|
3969
4029
|
/**
|
|
3970
|
-
* The name of the input/output
|
|
4030
|
+
* The name of the input/output variable. This is a human-readable identifier for the value. It distinguishes between different inputs/outputs variables in the system. The variables may be used to set bits or bytes at their pointed to address via [setBusIOValues](setBusIOValues).
|
|
3971
4031
|
* @type {string}
|
|
3972
4032
|
* @memberof ProfinetIOData
|
|
3973
4033
|
*/
|
|
@@ -3979,26 +4039,26 @@ export interface ProfinetIOData {
|
|
|
3979
4039
|
*/
|
|
3980
4040
|
'type': ProfinetIOTypeEnum;
|
|
3981
4041
|
/**
|
|
3982
|
-
* The direction of the input/output
|
|
4042
|
+
* The direction of the input/output variable, indicating whether it is an input or output for the PROFINET device, e.g. NOVA\'s PROFINET service.
|
|
3983
4043
|
* @type {ProfinetIODirection}
|
|
3984
4044
|
* @memberof ProfinetIOData
|
|
3985
4045
|
*/
|
|
3986
4046
|
'direction': ProfinetIODirection;
|
|
3987
4047
|
/**
|
|
3988
|
-
* The byte address of the input/output
|
|
4048
|
+
* The byte address of the input/output variable in the PROFINET device, e.g. NOVA\'s PROFINET service. The byte address is used to locate the specific input/output variable within the device\'s memory or data structure.
|
|
3989
4049
|
* @type {number}
|
|
3990
4050
|
* @memberof ProfinetIOData
|
|
3991
4051
|
*/
|
|
3992
4052
|
'byte_address': number;
|
|
3993
4053
|
/**
|
|
3994
|
-
* The bit address of the input/output
|
|
4054
|
+
* The bit address of the input/output variable within the byte or word address. The bit address is used to specify the exact bit within the byte or word that corresponds to the input/output variable.
|
|
3995
4055
|
* @type {number}
|
|
3996
4056
|
* @memberof ProfinetIOData
|
|
3997
4057
|
*/
|
|
3998
4058
|
'bit_address'?: number;
|
|
3999
4059
|
}
|
|
4000
4060
|
/**
|
|
4001
|
-
*
|
|
4061
|
+
* The direction of the input/output variable, indicating whether it is an input or output for the PROFINET device, e.g. NOVA\'s PROFINET service.
|
|
4002
4062
|
* @export
|
|
4003
4063
|
* @enum {string}
|
|
4004
4064
|
*/
|
|
@@ -4009,7 +4069,7 @@ export declare const ProfinetIODirection: {
|
|
|
4009
4069
|
};
|
|
4010
4070
|
export type ProfinetIODirection = typeof ProfinetIODirection[keyof typeof ProfinetIODirection];
|
|
4011
4071
|
/**
|
|
4012
|
-
* Value type of the PROFINET input/output.
|
|
4072
|
+
* Value type of the PROFINET input/output variable. Is used to interpret the corresponding bits correctly.
|
|
4013
4073
|
* @export
|
|
4014
4074
|
* @enum {string}
|
|
4015
4075
|
*/
|
|
@@ -4033,38 +4093,38 @@ export type ProfinetIOTypeEnum = typeof ProfinetIOTypeEnum[keyof typeof Profinet
|
|
|
4033
4093
|
*/
|
|
4034
4094
|
export interface ProfinetInputOutputConfig {
|
|
4035
4095
|
/**
|
|
4036
|
-
* Content of the input
|
|
4096
|
+
* Content of the input/output variable configuration XML file. The XML File has to be embedded as a string by escaping quotes, line breaks and so forth.
|
|
4037
4097
|
* @type {string}
|
|
4038
4098
|
* @memberof ProfinetInputOutputConfig
|
|
4039
4099
|
*/
|
|
4040
4100
|
'config': string;
|
|
4041
4101
|
/**
|
|
4042
|
-
* Offset in bytes for the input
|
|
4102
|
+
* Offset in bytes for the address of the input (perspective of the controller) variables. The offset will be subtracted from to the byte addresses of the sent XML content.
|
|
4043
4103
|
* @type {number}
|
|
4044
4104
|
* @memberof ProfinetInputOutputConfig
|
|
4045
4105
|
*/
|
|
4046
4106
|
'input_offset': number;
|
|
4047
4107
|
/**
|
|
4048
|
-
* Offset in bytes for the output
|
|
4108
|
+
* Offset in bytes for the address of the output (perspective of the controller) variables. The offset will be subtracted from to the byte addresses of the sent XML content.
|
|
4049
4109
|
* @type {number}
|
|
4050
4110
|
* @memberof ProfinetInputOutputConfig
|
|
4051
4111
|
*/
|
|
4052
4112
|
'output_offset': number;
|
|
4053
4113
|
}
|
|
4054
4114
|
/**
|
|
4055
|
-
*
|
|
4115
|
+
* An array of PROFINET slots. PROFINET models each device’s input/output hardware as a hierarchy of slots (modules) and subslots (submodules). A slot can represent a physical or virtual input/output card and each subslot one of its individual channels or functions. Every slot and subslot has unique identifiers that the controller uses to map cyclic input/output data and parameter records to its process image. This slot/subslot separation enables e.g. addressing each input/output stream when establishing input/output application relations (I/O-AR).
|
|
4056
4116
|
* @export
|
|
4057
4117
|
* @interface ProfinetSlotDescription
|
|
4058
4118
|
*/
|
|
4059
4119
|
export interface ProfinetSlotDescription {
|
|
4060
4120
|
/**
|
|
4061
|
-
* The number of the PROFINET slot.
|
|
4121
|
+
* The number/index of the PROFINET slot. Per default, slot 0 is reserved for the device access point (DAP). Slots that are part of the cyclic input/output data exchange start at number 1.
|
|
4062
4122
|
* @type {number}
|
|
4063
4123
|
* @memberof ProfinetSlotDescription
|
|
4064
4124
|
*/
|
|
4065
4125
|
'number': number;
|
|
4066
4126
|
/**
|
|
4067
|
-
* The API number of the PROFINET input
|
|
4127
|
+
* The application process identifier (API) number of the PROFINET input. The API identifies the application relation (AR) that is using the slot.
|
|
4068
4128
|
* @type {number}
|
|
4069
4129
|
* @memberof ProfinetSlotDescription
|
|
4070
4130
|
*/
|
|
@@ -4083,32 +4143,174 @@ export interface ProfinetSlotDescription {
|
|
|
4083
4143
|
*/
|
|
4084
4144
|
export interface ProfinetSubSlotDescription {
|
|
4085
4145
|
/**
|
|
4086
|
-
* The
|
|
4146
|
+
* The number/index of the PROFINET subslot.
|
|
4087
4147
|
* @type {number}
|
|
4088
4148
|
* @memberof ProfinetSubSlotDescription
|
|
4089
4149
|
*/
|
|
4090
4150
|
'number': number;
|
|
4091
4151
|
/**
|
|
4092
|
-
* The
|
|
4152
|
+
* The amount of bytes allocated for the subslot in the input process image buffer.
|
|
4093
4153
|
* @type {number}
|
|
4094
4154
|
* @memberof ProfinetSubSlotDescription
|
|
4095
4155
|
*/
|
|
4096
4156
|
'input_length': number;
|
|
4097
4157
|
/**
|
|
4098
|
-
* The
|
|
4158
|
+
* The amount of bytes allocated for the subslot in the output process image buffer.
|
|
4099
4159
|
* @type {number}
|
|
4100
4160
|
* @memberof ProfinetSubSlotDescription
|
|
4101
4161
|
*/
|
|
4102
4162
|
'output_length': number;
|
|
4103
4163
|
}
|
|
4104
4164
|
/**
|
|
4105
|
-
*
|
|
4165
|
+
* A program is a collection of instructions that are executed in the robot cell.
|
|
4166
|
+
* @export
|
|
4167
|
+
* @interface Program
|
|
4168
|
+
*/
|
|
4169
|
+
export interface Program {
|
|
4170
|
+
/**
|
|
4171
|
+
*
|
|
4172
|
+
* @type {string}
|
|
4173
|
+
* @memberof Program
|
|
4174
|
+
*/
|
|
4175
|
+
'program': string;
|
|
4176
|
+
/**
|
|
4177
|
+
*
|
|
4178
|
+
* @type {string}
|
|
4179
|
+
* @memberof Program
|
|
4180
|
+
*/
|
|
4181
|
+
'name'?: string;
|
|
4182
|
+
/**
|
|
4183
|
+
*
|
|
4184
|
+
* @type {string}
|
|
4185
|
+
* @memberof Program
|
|
4186
|
+
*/
|
|
4187
|
+
'description'?: string;
|
|
4188
|
+
/**
|
|
4189
|
+
*
|
|
4190
|
+
* @type {string}
|
|
4191
|
+
* @memberof Program
|
|
4192
|
+
*/
|
|
4193
|
+
'app': string;
|
|
4194
|
+
/**
|
|
4195
|
+
*
|
|
4196
|
+
* @type {object}
|
|
4197
|
+
* @memberof Program
|
|
4198
|
+
*/
|
|
4199
|
+
'input_schema'?: object;
|
|
4200
|
+
/**
|
|
4201
|
+
*
|
|
4202
|
+
* @type {object}
|
|
4203
|
+
* @memberof Program
|
|
4204
|
+
*/
|
|
4205
|
+
'preconditions'?: object;
|
|
4206
|
+
}
|
|
4207
|
+
/**
|
|
4208
|
+
* Holds the state of a program run.
|
|
4209
|
+
* @export
|
|
4210
|
+
* @interface ProgramRun
|
|
4211
|
+
*/
|
|
4212
|
+
export interface ProgramRun {
|
|
4213
|
+
/**
|
|
4214
|
+
* Unique identifier of the program run
|
|
4215
|
+
* @type {string}
|
|
4216
|
+
* @memberof ProgramRun
|
|
4217
|
+
*/
|
|
4218
|
+
'run': string;
|
|
4219
|
+
/**
|
|
4220
|
+
* Unique identifier of the program
|
|
4221
|
+
* @type {string}
|
|
4222
|
+
* @memberof ProgramRun
|
|
4223
|
+
*/
|
|
4224
|
+
'program': string;
|
|
4225
|
+
/**
|
|
4226
|
+
* State of the program run
|
|
4227
|
+
* @type {ProgramRunState}
|
|
4228
|
+
* @memberof ProgramRun
|
|
4229
|
+
*/
|
|
4230
|
+
'state': ProgramRunState;
|
|
4231
|
+
/**
|
|
4232
|
+
* Logs of the program run
|
|
4233
|
+
* @type {string}
|
|
4234
|
+
* @memberof ProgramRun
|
|
4235
|
+
*/
|
|
4236
|
+
'logs'?: string;
|
|
4237
|
+
/**
|
|
4238
|
+
* Stdout of the program run
|
|
4239
|
+
* @type {string}
|
|
4240
|
+
* @memberof ProgramRun
|
|
4241
|
+
*/
|
|
4242
|
+
'stdout'?: string;
|
|
4243
|
+
/**
|
|
4244
|
+
* Stderr of the program run
|
|
4245
|
+
* @type {string}
|
|
4246
|
+
* @memberof ProgramRun
|
|
4247
|
+
*/
|
|
4248
|
+
'stderr'?: string;
|
|
4249
|
+
/**
|
|
4250
|
+
* Error message of the program run, if any
|
|
4251
|
+
* @type {string}
|
|
4252
|
+
* @memberof ProgramRun
|
|
4253
|
+
*/
|
|
4254
|
+
'error'?: string;
|
|
4255
|
+
/**
|
|
4256
|
+
* Traceback of the program run, if any
|
|
4257
|
+
* @type {string}
|
|
4258
|
+
* @memberof ProgramRun
|
|
4259
|
+
*/
|
|
4260
|
+
'traceback'?: string;
|
|
4261
|
+
/**
|
|
4262
|
+
* Start time of the program run
|
|
4263
|
+
* @type {string}
|
|
4264
|
+
* @memberof ProgramRun
|
|
4265
|
+
*/
|
|
4266
|
+
'start_time'?: string;
|
|
4267
|
+
/**
|
|
4268
|
+
* End time of the program run
|
|
4269
|
+
* @type {string}
|
|
4270
|
+
* @memberof ProgramRun
|
|
4271
|
+
*/
|
|
4272
|
+
'end_time'?: string;
|
|
4273
|
+
/**
|
|
4274
|
+
* Input data of the program run
|
|
4275
|
+
* @type {object}
|
|
4276
|
+
* @memberof ProgramRun
|
|
4277
|
+
*/
|
|
4278
|
+
'input_data'?: object;
|
|
4279
|
+
}
|
|
4280
|
+
/**
|
|
4281
|
+
* The state of a program run.
|
|
4282
|
+
* @export
|
|
4283
|
+
* @enum {string}
|
|
4284
|
+
*/
|
|
4285
|
+
export declare const ProgramRunState: {
|
|
4286
|
+
readonly Preparing: "PREPARING";
|
|
4287
|
+
readonly Running: "RUNNING";
|
|
4288
|
+
readonly Completed: "COMPLETED";
|
|
4289
|
+
readonly Failed: "FAILED";
|
|
4290
|
+
readonly Stopped: "STOPPED";
|
|
4291
|
+
};
|
|
4292
|
+
export type ProgramRunState = typeof ProgramRunState[keyof typeof ProgramRunState];
|
|
4293
|
+
/**
|
|
4294
|
+
* The state of a program run.
|
|
4295
|
+
* @export
|
|
4296
|
+
* @interface ProgramStartRequest
|
|
4297
|
+
*/
|
|
4298
|
+
export interface ProgramStartRequest {
|
|
4299
|
+
/**
|
|
4300
|
+
* The arguments to pass to the program.
|
|
4301
|
+
* @type {object}
|
|
4302
|
+
* @memberof ProgramStartRequest
|
|
4303
|
+
*/
|
|
4304
|
+
'arguments': object;
|
|
4305
|
+
}
|
|
4306
|
+
/**
|
|
4307
|
+
*
|
|
4106
4308
|
* @export
|
|
4107
4309
|
* @interface RRTConnectAlgorithm
|
|
4108
4310
|
*/
|
|
4109
4311
|
export interface RRTConnectAlgorithm {
|
|
4110
4312
|
/**
|
|
4111
|
-
* Algorithm discriminator.
|
|
4313
|
+
* Algorithm discriminator. RRT Connect algorithm configuration for collision-free path planning. Rapidly-exploring Random Trees (RRT) builds trees of valid configurations by randomly sampling the joint space and connecting feasible points with JointPTP motions. RRT Connect grows two trees simultaneously from start and target positions until they meet. This is a custom implementation optimized for manipulator kinematics and collision checking in industrial contexts.
|
|
4112
4314
|
* @type {string}
|
|
4113
4315
|
* @memberof RRTConnectAlgorithm
|
|
4114
4316
|
*/
|
|
@@ -4119,6 +4321,30 @@ export interface RRTConnectAlgorithm {
|
|
|
4119
4321
|
* @memberof RRTConnectAlgorithm
|
|
4120
4322
|
*/
|
|
4121
4323
|
'max_iterations'?: number;
|
|
4324
|
+
/**
|
|
4325
|
+
* Maximum step size for tree extension in joint space.
|
|
4326
|
+
* @type {number}
|
|
4327
|
+
* @memberof RRTConnectAlgorithm
|
|
4328
|
+
*/
|
|
4329
|
+
'max_step_size'?: number;
|
|
4330
|
+
/**
|
|
4331
|
+
* Adjust the maximum step size during the search based on the recent success rate of tree expansion.
|
|
4332
|
+
* @type {boolean}
|
|
4333
|
+
* @memberof RRTConnectAlgorithm
|
|
4334
|
+
*/
|
|
4335
|
+
'adaptive_step_size'?: boolean;
|
|
4336
|
+
/**
|
|
4337
|
+
* Apply smoothing after the search has succeeded. This will remove as many intermediate points as possible while keeping the path valid.
|
|
4338
|
+
* @type {boolean}
|
|
4339
|
+
* @memberof RRTConnectAlgorithm
|
|
4340
|
+
*/
|
|
4341
|
+
'apply_smoothing'?: boolean;
|
|
4342
|
+
/**
|
|
4343
|
+
* Apply blending after the search has succeeded and smoothing has been applied. This will apply the largest viable blending at each intermediate point.
|
|
4344
|
+
* @type {boolean}
|
|
4345
|
+
* @memberof RRTConnectAlgorithm
|
|
4346
|
+
*/
|
|
4347
|
+
'apply_blending'?: boolean;
|
|
4122
4348
|
}
|
|
4123
4349
|
export declare const RRTConnectAlgorithmAlgorithmNameEnum: {
|
|
4124
4350
|
readonly RrtConnectAlgorithm: "RRTConnectAlgorithm";
|
|
@@ -4502,6 +4728,25 @@ export interface ServiceStatusStatus {
|
|
|
4502
4728
|
*/
|
|
4503
4729
|
'reason'?: string;
|
|
4504
4730
|
}
|
|
4731
|
+
/**
|
|
4732
|
+
* Defines an input/output that should be set upon reaching a specified location on the trajectory.
|
|
4733
|
+
* @export
|
|
4734
|
+
* @interface SetIO
|
|
4735
|
+
*/
|
|
4736
|
+
export interface SetIO {
|
|
4737
|
+
/**
|
|
4738
|
+
*
|
|
4739
|
+
* @type {IOValue}
|
|
4740
|
+
* @memberof SetIO
|
|
4741
|
+
*/
|
|
4742
|
+
'io': IOValue;
|
|
4743
|
+
/**
|
|
4744
|
+
* The location on the trajectory where the input/output should be set.
|
|
4745
|
+
* @type {number}
|
|
4746
|
+
* @memberof SetIO
|
|
4747
|
+
*/
|
|
4748
|
+
'location': number;
|
|
4749
|
+
}
|
|
4505
4750
|
/**
|
|
4506
4751
|
*
|
|
4507
4752
|
* @export
|
|
@@ -4566,10 +4811,10 @@ export interface StartMovementRequest {
|
|
|
4566
4811
|
'direction'?: Direction;
|
|
4567
4812
|
/**
|
|
4568
4813
|
* 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.
|
|
4569
|
-
* @type {Array<
|
|
4814
|
+
* @type {Array<SetIO>}
|
|
4570
4815
|
* @memberof StartMovementRequest
|
|
4571
4816
|
*/
|
|
4572
|
-
'set_outputs'?: Array<
|
|
4817
|
+
'set_outputs'?: Array<SetIO>;
|
|
4573
4818
|
/**
|
|
4574
4819
|
* Defines an input/output that is listened to before the movement. Execution starts if the defined comparator evaluates to `true`.
|
|
4575
4820
|
* @type {StartOnIO}
|
|
@@ -4824,7 +5069,7 @@ export interface TrajectoryDetails {
|
|
|
4824
5069
|
*/
|
|
4825
5070
|
'trajectory': string;
|
|
4826
5071
|
/**
|
|
4827
|
-
*
|
|
5072
|
+
* 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
|
|
4828
5073
|
* @type {number}
|
|
4829
5074
|
* @memberof TrajectoryDetails
|
|
4830
5075
|
*/
|
|
@@ -4850,9 +5095,19 @@ export type TrajectoryDetailsKindEnum = typeof TrajectoryDetailsKindEnum[keyof t
|
|
|
4850
5095
|
* @type TrajectoryDetailsState
|
|
4851
5096
|
* @export
|
|
4852
5097
|
*/
|
|
4853
|
-
export type TrajectoryDetailsState =
|
|
5098
|
+
export type TrajectoryDetailsState = {
|
|
5099
|
+
kind: 'END_OF_TRAJECTORY';
|
|
5100
|
+
} & TrajectoryEnded | {
|
|
5101
|
+
kind: 'PAUSED_BY_USER';
|
|
5102
|
+
} & TrajectoryPausedByUser | {
|
|
5103
|
+
kind: 'PAUSED_ON_IO';
|
|
5104
|
+
} & TrajectoryPausedOnIO | {
|
|
5105
|
+
kind: 'RUNNING';
|
|
5106
|
+
} & TrajectoryRunning | {
|
|
5107
|
+
kind: 'WAIT_FOR_IO';
|
|
5108
|
+
} & TrajectoryWaitForIO;
|
|
4854
5109
|
/**
|
|
4855
|
-
*
|
|
5110
|
+
* First or last sample (depending on direction) of trajectory has been sent.
|
|
4856
5111
|
* @export
|
|
4857
5112
|
* @interface TrajectoryEnded
|
|
4858
5113
|
*/
|
|
@@ -4892,7 +5147,7 @@ export declare const TrajectoryIdMessageTypeEnum: {
|
|
|
4892
5147
|
};
|
|
4893
5148
|
export type TrajectoryIdMessageTypeEnum = typeof TrajectoryIdMessageTypeEnum[keyof typeof TrajectoryIdMessageTypeEnum];
|
|
4894
5149
|
/**
|
|
4895
|
-
*
|
|
5150
|
+
* User has paused execution.
|
|
4896
5151
|
* @export
|
|
4897
5152
|
* @interface TrajectoryPausedByUser
|
|
4898
5153
|
*/
|
|
@@ -4909,7 +5164,7 @@ export declare const TrajectoryPausedByUserKindEnum: {
|
|
|
4909
5164
|
};
|
|
4910
5165
|
export type TrajectoryPausedByUserKindEnum = typeof TrajectoryPausedByUserKindEnum[keyof typeof TrajectoryPausedByUserKindEnum];
|
|
4911
5166
|
/**
|
|
4912
|
-
*
|
|
5167
|
+
* Execution was paused because of an I/O event.
|
|
4913
5168
|
* @export
|
|
4914
5169
|
* @interface TrajectoryPausedOnIO
|
|
4915
5170
|
*/
|
|
@@ -4926,7 +5181,7 @@ export declare const TrajectoryPausedOnIOKindEnum: {
|
|
|
4926
5181
|
};
|
|
4927
5182
|
export type TrajectoryPausedOnIOKindEnum = typeof TrajectoryPausedOnIOKindEnum[keyof typeof TrajectoryPausedOnIOKindEnum];
|
|
4928
5183
|
/**
|
|
4929
|
-
*
|
|
5184
|
+
* Trajectory is being executed.
|
|
4930
5185
|
* @export
|
|
4931
5186
|
* @interface TrajectoryRunning
|
|
4932
5187
|
*/
|
|
@@ -4949,7 +5204,7 @@ export declare const TrajectoryRunningKindEnum: {
|
|
|
4949
5204
|
};
|
|
4950
5205
|
export type TrajectoryRunningKindEnum = typeof TrajectoryRunningKindEnum[keyof typeof TrajectoryRunningKindEnum];
|
|
4951
5206
|
/**
|
|
4952
|
-
*
|
|
5207
|
+
* Waiting for an I/O event to start execution.
|
|
4953
5208
|
* @export
|
|
4954
5209
|
* @interface TrajectoryWaitForIO
|
|
4955
5210
|
*/
|
|
@@ -5052,6 +5307,31 @@ export interface ValidationError {
|
|
|
5052
5307
|
[key: string]: any;
|
|
5053
5308
|
};
|
|
5054
5309
|
}
|
|
5310
|
+
/**
|
|
5311
|
+
* A validation error of a program.
|
|
5312
|
+
* @export
|
|
5313
|
+
* @interface ValidationError2
|
|
5314
|
+
*/
|
|
5315
|
+
export interface ValidationError2 {
|
|
5316
|
+
/**
|
|
5317
|
+
*
|
|
5318
|
+
* @type {Array<number>}
|
|
5319
|
+
* @memberof ValidationError2
|
|
5320
|
+
*/
|
|
5321
|
+
'loc': Array<number>;
|
|
5322
|
+
/**
|
|
5323
|
+
*
|
|
5324
|
+
* @type {string}
|
|
5325
|
+
* @memberof ValidationError2
|
|
5326
|
+
*/
|
|
5327
|
+
'msg': string;
|
|
5328
|
+
/**
|
|
5329
|
+
*
|
|
5330
|
+
* @type {string}
|
|
5331
|
+
* @memberof ValidationError2
|
|
5332
|
+
*/
|
|
5333
|
+
'type': string;
|
|
5334
|
+
}
|
|
5055
5335
|
/**
|
|
5056
5336
|
* @type ValidationErrorLocInner
|
|
5057
5337
|
* @export
|
|
@@ -5542,7 +5822,7 @@ export declare class ApplicationApi extends BaseAPI {
|
|
|
5542
5822
|
*/
|
|
5543
5823
|
export declare const BUSInputsOutputsApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
5544
5824
|
/**
|
|
5545
|
-
* Add
|
|
5825
|
+
* Add the BUS inputs/outputs service to the cell. Starts a containerized service that enables BUS connections via the specified ethernet port.
|
|
5546
5826
|
* @summary Add Service
|
|
5547
5827
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5548
5828
|
* @param {BusIOType} busIOType
|
|
@@ -5552,7 +5832,7 @@ export declare const BUSInputsOutputsApiAxiosParamCreator: (configuration?: Conf
|
|
|
5552
5832
|
*/
|
|
5553
5833
|
addBusIOService: (cell: string, busIOType: BusIOType, completionTimeout?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
5554
5834
|
/**
|
|
5555
|
-
* Adds an input/output to or updates an input/output on the PROFINET device.
|
|
5835
|
+
* Adds an input/output variable to or updates an input/output variable on the PROFINET device, e.g. NOVA\'s PROFINET service. The inputs/outputs map variables to specific memory addresses in the process image. The default process image has buffer lengths of 64 bytes for input and output. The size of the buffer is determined by the `config_file_content` that is passed in [addBusIOService](addBusIOService) and has to be in accordance with the GSDML file describing the PROFINET device. The PROFINET controller as well as NOVA\'s PROFINET service use an input/output variable configuration to interpret the bits of the input/output process image. The NOVA\'s PROFINET service\'s configuration can be viewed via [listProfinetIOs](listProfinetIOs). For the PROFINET controller, e.g. a connected PLC, refer to the corresponding third party software, e.g. TIA portal).
|
|
5556
5836
|
* @summary Add PROFINET Input/Output
|
|
5557
5837
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5558
5838
|
* @param {string} io Unique identifier to address an Input/Output in the cell.
|
|
@@ -5562,7 +5842,7 @@ export declare const BUSInputsOutputsApiAxiosParamCreator: (configuration?: Conf
|
|
|
5562
5842
|
*/
|
|
5563
5843
|
addProfinetIO: (cell: string, io: string, profinetIOData: ProfinetIOData, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
5564
5844
|
/**
|
|
5565
|
-
*
|
|
5845
|
+
* Remove the BUS inputs/outputs service from the cell.
|
|
5566
5846
|
* @summary Clear Service
|
|
5567
5847
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5568
5848
|
* @param {number} [completionTimeout]
|
|
@@ -5571,7 +5851,7 @@ export declare const BUSInputsOutputsApiAxiosParamCreator: (configuration?: Conf
|
|
|
5571
5851
|
*/
|
|
5572
5852
|
clearBusIOService: (cell: string, completionTimeout?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
5573
5853
|
/**
|
|
5574
|
-
* Removes
|
|
5854
|
+
* Removes an input/output variable configuration from the PROFINET device, e.g. NOVA\'s PROFINET service.
|
|
5575
5855
|
* @summary Remove PROFINET Input/Ouptut
|
|
5576
5856
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5577
5857
|
* @param {string} io Unique identifier to address an Input/Output in the cell.
|
|
@@ -5580,7 +5860,7 @@ export declare const BUSInputsOutputsApiAxiosParamCreator: (configuration?: Conf
|
|
|
5580
5860
|
*/
|
|
5581
5861
|
deleteProfinetIO: (cell: string, io: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
5582
5862
|
/**
|
|
5583
|
-
* Get deployed BUS
|
|
5863
|
+
* Get deployed BUS inputs/outputs service.
|
|
5584
5864
|
* @summary Get Service
|
|
5585
5865
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5586
5866
|
* @param {*} [options] Override http request option.
|
|
@@ -5605,7 +5885,7 @@ export declare const BUSInputsOutputsApiAxiosParamCreator: (configuration?: Conf
|
|
|
5605
5885
|
*/
|
|
5606
5886
|
getBusIOValues: (cell: string, ios?: Array<string>, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
5607
5887
|
/**
|
|
5608
|
-
* Get description of PROFINET
|
|
5888
|
+
* Get description of NOVA as a PROFINET device.
|
|
5609
5889
|
* @summary Get PROFINET Description
|
|
5610
5890
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5611
5891
|
* @param {*} [options] Override http request option.
|
|
@@ -5613,7 +5893,7 @@ export declare const BUSInputsOutputsApiAxiosParamCreator: (configuration?: Conf
|
|
|
5613
5893
|
*/
|
|
5614
5894
|
getProfinetDescription: (cell: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
5615
5895
|
/**
|
|
5616
|
-
* Get input/output configuration of the PROFINET device as file.
|
|
5896
|
+
* Get input/output variable configuration of the PROFINET device, e.g. NOVA\'s PROFINET service as file. You can specify byte offsets for the input and output variable addresses to get an XML tagmap that is ready to paste to the third party software, e.g. TIA portal.
|
|
5617
5897
|
* @summary PROFINET Inputs/Outputs to File
|
|
5618
5898
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5619
5899
|
* @param {number} [inputOffset]
|
|
@@ -5623,7 +5903,7 @@ export declare const BUSInputsOutputsApiAxiosParamCreator: (configuration?: Conf
|
|
|
5623
5903
|
*/
|
|
5624
5904
|
getProfinetIOsFromFile: (cell: string, inputOffset?: number, outputOffset?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
5625
5905
|
/**
|
|
5626
|
-
* List all BUS
|
|
5906
|
+
* List all input/output descriptions for configured BUS services. The input/output descriptions contain information such as the name, the type and the unit. The input/output direction is given in perspective of the BUS service.
|
|
5627
5907
|
* @summary List Descriptions
|
|
5628
5908
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5629
5909
|
* @param {*} [options] Override http request option.
|
|
@@ -5631,7 +5911,7 @@ export declare const BUSInputsOutputsApiAxiosParamCreator: (configuration?: Conf
|
|
|
5631
5911
|
*/
|
|
5632
5912
|
listBusIODescriptions: (cell: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
5633
5913
|
/**
|
|
5634
|
-
* List all PROFINET input and
|
|
5914
|
+
* List descriptions for all configured input/output variables of the PROFINET service. The input/output descriptions contain information such as the name, the type and the unit. The input/output direction is given in perspective of the PROFINET Device, e.g. the configured PROFINET service. The byte and bit addresses are the locations in the PROFINET input/output process image the variable points to. The PROFINET controller as well as NOVA\'s PROFINET service use an input/output variable configuration to interpret the bits of the input and output process image. The NOVA PROFINET service\'s configuration is modified via [addProfinetIO](addProfinetIO) and [setProfinetIOsFromFile](setProfinetIOsFromFile). For the PROFINET controller, e.g. a connected PLC, refer to the corresponding third party software, e.g. TIA portal.
|
|
5635
5915
|
* @summary List PROFINET Input/Output Configuration
|
|
5636
5916
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5637
5917
|
* @param {*} [options] Override http request option.
|
|
@@ -5648,7 +5928,7 @@ export declare const BUSInputsOutputsApiAxiosParamCreator: (configuration?: Conf
|
|
|
5648
5928
|
*/
|
|
5649
5929
|
setBusIOValues: (cell: string, iOValue: Array<IOValue>, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
5650
5930
|
/**
|
|
5651
|
-
* Sets inputs/outputs
|
|
5931
|
+
* Sets input/output variable configuration on the PROFINET device (i.e. NOVA\'s PROFINET service) from XML file. The inputs/outputs map variables to specific memory addresses in the process image. The default process image has buffer lengths of 64 bytes for input and output. The size of the buffer is determined by the `config_file_content` that is passed in [addBusIOService](addBusIOService) and has to be in accordance with the GSDML file describing the PROFINET device. The PROFINET controller as well as NOVA\'s PROFINET service use an input/output variable configuration to interpret the bits of the input/output process image. The NOVA\'s PROFINET service\'s configuration can be viewed via [listProfinetIOs](listProfinetIOs). For the PROFINET controller, e.g. a connected PLC, refer to the corresponding engineering system, e.g. TIA portal. You can export the variable configuration of the PROFINET controller as XML file from your engineering system, e.g. TIA portal. The endpoint is built so that the perspective of input and output (PROFINET Device\'s input is PROFINET Controller\'s output) is internally handled (PROFINET device input is PROFINET controller output), meaning that you can paste the exported XML file here without modifying.
|
|
5652
5932
|
* @summary Set PROFINET Inputs/Outputs from File
|
|
5653
5933
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5654
5934
|
* @param {ProfinetInputOutputConfig} profinetInputOutputConfig
|
|
@@ -5663,7 +5943,7 @@ export declare const BUSInputsOutputsApiAxiosParamCreator: (configuration?: Conf
|
|
|
5663
5943
|
*/
|
|
5664
5944
|
export declare const BUSInputsOutputsApiFp: (configuration?: Configuration) => {
|
|
5665
5945
|
/**
|
|
5666
|
-
* Add
|
|
5946
|
+
* Add the BUS inputs/outputs service to the cell. Starts a containerized service that enables BUS connections via the specified ethernet port.
|
|
5667
5947
|
* @summary Add Service
|
|
5668
5948
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5669
5949
|
* @param {BusIOType} busIOType
|
|
@@ -5673,7 +5953,7 @@ export declare const BUSInputsOutputsApiFp: (configuration?: Configuration) => {
|
|
|
5673
5953
|
*/
|
|
5674
5954
|
addBusIOService(cell: string, busIOType: BusIOType, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
5675
5955
|
/**
|
|
5676
|
-
* Adds an input/output to or updates an input/output on the PROFINET device.
|
|
5956
|
+
* Adds an input/output variable to or updates an input/output variable on the PROFINET device, e.g. NOVA\'s PROFINET service. The inputs/outputs map variables to specific memory addresses in the process image. The default process image has buffer lengths of 64 bytes for input and output. The size of the buffer is determined by the `config_file_content` that is passed in [addBusIOService](addBusIOService) and has to be in accordance with the GSDML file describing the PROFINET device. The PROFINET controller as well as NOVA\'s PROFINET service use an input/output variable configuration to interpret the bits of the input/output process image. The NOVA\'s PROFINET service\'s configuration can be viewed via [listProfinetIOs](listProfinetIOs). For the PROFINET controller, e.g. a connected PLC, refer to the corresponding third party software, e.g. TIA portal).
|
|
5677
5957
|
* @summary Add PROFINET Input/Output
|
|
5678
5958
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5679
5959
|
* @param {string} io Unique identifier to address an Input/Output in the cell.
|
|
@@ -5683,7 +5963,7 @@ export declare const BUSInputsOutputsApiFp: (configuration?: Configuration) => {
|
|
|
5683
5963
|
*/
|
|
5684
5964
|
addProfinetIO(cell: string, io: string, profinetIOData: ProfinetIOData, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
5685
5965
|
/**
|
|
5686
|
-
*
|
|
5966
|
+
* Remove the BUS inputs/outputs service from the cell.
|
|
5687
5967
|
* @summary Clear Service
|
|
5688
5968
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5689
5969
|
* @param {number} [completionTimeout]
|
|
@@ -5692,7 +5972,7 @@ export declare const BUSInputsOutputsApiFp: (configuration?: Configuration) => {
|
|
|
5692
5972
|
*/
|
|
5693
5973
|
clearBusIOService(cell: string, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
5694
5974
|
/**
|
|
5695
|
-
* Removes
|
|
5975
|
+
* Removes an input/output variable configuration from the PROFINET device, e.g. NOVA\'s PROFINET service.
|
|
5696
5976
|
* @summary Remove PROFINET Input/Ouptut
|
|
5697
5977
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5698
5978
|
* @param {string} io Unique identifier to address an Input/Output in the cell.
|
|
@@ -5701,7 +5981,7 @@ export declare const BUSInputsOutputsApiFp: (configuration?: Configuration) => {
|
|
|
5701
5981
|
*/
|
|
5702
5982
|
deleteProfinetIO(cell: string, io: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
5703
5983
|
/**
|
|
5704
|
-
* Get deployed BUS
|
|
5984
|
+
* Get deployed BUS inputs/outputs service.
|
|
5705
5985
|
* @summary Get Service
|
|
5706
5986
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5707
5987
|
* @param {*} [options] Override http request option.
|
|
@@ -5726,7 +6006,7 @@ export declare const BUSInputsOutputsApiFp: (configuration?: Configuration) => {
|
|
|
5726
6006
|
*/
|
|
5727
6007
|
getBusIOValues(cell: string, ios?: Array<string>, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<IOValue>>>;
|
|
5728
6008
|
/**
|
|
5729
|
-
* Get description of PROFINET
|
|
6009
|
+
* Get description of NOVA as a PROFINET device.
|
|
5730
6010
|
* @summary Get PROFINET Description
|
|
5731
6011
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5732
6012
|
* @param {*} [options] Override http request option.
|
|
@@ -5734,7 +6014,7 @@ export declare const BUSInputsOutputsApiFp: (configuration?: Configuration) => {
|
|
|
5734
6014
|
*/
|
|
5735
6015
|
getProfinetDescription(cell: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ProfinetDescription>>;
|
|
5736
6016
|
/**
|
|
5737
|
-
* Get input/output configuration of the PROFINET device as file.
|
|
6017
|
+
* Get input/output variable configuration of the PROFINET device, e.g. NOVA\'s PROFINET service as file. You can specify byte offsets for the input and output variable addresses to get an XML tagmap that is ready to paste to the third party software, e.g. TIA portal.
|
|
5738
6018
|
* @summary PROFINET Inputs/Outputs to File
|
|
5739
6019
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5740
6020
|
* @param {number} [inputOffset]
|
|
@@ -5744,15 +6024,15 @@ export declare const BUSInputsOutputsApiFp: (configuration?: Configuration) => {
|
|
|
5744
6024
|
*/
|
|
5745
6025
|
getProfinetIOsFromFile(cell: string, inputOffset?: number, outputOffset?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<string>>;
|
|
5746
6026
|
/**
|
|
5747
|
-
* List all BUS
|
|
6027
|
+
* List all input/output descriptions for configured BUS services. The input/output descriptions contain information such as the name, the type and the unit. The input/output direction is given in perspective of the BUS service.
|
|
5748
6028
|
* @summary List Descriptions
|
|
5749
6029
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5750
6030
|
* @param {*} [options] Override http request option.
|
|
5751
6031
|
* @throws {RequiredError}
|
|
5752
6032
|
*/
|
|
5753
|
-
listBusIODescriptions(cell: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<
|
|
6033
|
+
listBusIODescriptions(cell: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<IODescription2>>>;
|
|
5754
6034
|
/**
|
|
5755
|
-
* List all PROFINET input and
|
|
6035
|
+
* List descriptions for all configured input/output variables of the PROFINET service. The input/output descriptions contain information such as the name, the type and the unit. The input/output direction is given in perspective of the PROFINET Device, e.g. the configured PROFINET service. The byte and bit addresses are the locations in the PROFINET input/output process image the variable points to. The PROFINET controller as well as NOVA\'s PROFINET service use an input/output variable configuration to interpret the bits of the input and output process image. The NOVA PROFINET service\'s configuration is modified via [addProfinetIO](addProfinetIO) and [setProfinetIOsFromFile](setProfinetIOsFromFile). For the PROFINET controller, e.g. a connected PLC, refer to the corresponding third party software, e.g. TIA portal.
|
|
5756
6036
|
* @summary List PROFINET Input/Output Configuration
|
|
5757
6037
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5758
6038
|
* @param {*} [options] Override http request option.
|
|
@@ -5769,7 +6049,7 @@ export declare const BUSInputsOutputsApiFp: (configuration?: Configuration) => {
|
|
|
5769
6049
|
*/
|
|
5770
6050
|
setBusIOValues(cell: string, iOValue: Array<IOValue>, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
5771
6051
|
/**
|
|
5772
|
-
* Sets inputs/outputs
|
|
6052
|
+
* Sets input/output variable configuration on the PROFINET device (i.e. NOVA\'s PROFINET service) from XML file. The inputs/outputs map variables to specific memory addresses in the process image. The default process image has buffer lengths of 64 bytes for input and output. The size of the buffer is determined by the `config_file_content` that is passed in [addBusIOService](addBusIOService) and has to be in accordance with the GSDML file describing the PROFINET device. The PROFINET controller as well as NOVA\'s PROFINET service use an input/output variable configuration to interpret the bits of the input/output process image. The NOVA\'s PROFINET service\'s configuration can be viewed via [listProfinetIOs](listProfinetIOs). For the PROFINET controller, e.g. a connected PLC, refer to the corresponding engineering system, e.g. TIA portal. You can export the variable configuration of the PROFINET controller as XML file from your engineering system, e.g. TIA portal. The endpoint is built so that the perspective of input and output (PROFINET Device\'s input is PROFINET Controller\'s output) is internally handled (PROFINET device input is PROFINET controller output), meaning that you can paste the exported XML file here without modifying.
|
|
5773
6053
|
* @summary Set PROFINET Inputs/Outputs from File
|
|
5774
6054
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5775
6055
|
* @param {ProfinetInputOutputConfig} profinetInputOutputConfig
|
|
@@ -5784,7 +6064,7 @@ export declare const BUSInputsOutputsApiFp: (configuration?: Configuration) => {
|
|
|
5784
6064
|
*/
|
|
5785
6065
|
export declare const BUSInputsOutputsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
5786
6066
|
/**
|
|
5787
|
-
* Add
|
|
6067
|
+
* Add the BUS inputs/outputs service to the cell. Starts a containerized service that enables BUS connections via the specified ethernet port.
|
|
5788
6068
|
* @summary Add Service
|
|
5789
6069
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5790
6070
|
* @param {BusIOType} busIOType
|
|
@@ -5794,7 +6074,7 @@ export declare const BUSInputsOutputsApiFactory: (configuration?: Configuration,
|
|
|
5794
6074
|
*/
|
|
5795
6075
|
addBusIOService(cell: string, busIOType: BusIOType, completionTimeout?: number, options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
5796
6076
|
/**
|
|
5797
|
-
* Adds an input/output to or updates an input/output on the PROFINET device.
|
|
6077
|
+
* Adds an input/output variable to or updates an input/output variable on the PROFINET device, e.g. NOVA\'s PROFINET service. The inputs/outputs map variables to specific memory addresses in the process image. The default process image has buffer lengths of 64 bytes for input and output. The size of the buffer is determined by the `config_file_content` that is passed in [addBusIOService](addBusIOService) and has to be in accordance with the GSDML file describing the PROFINET device. The PROFINET controller as well as NOVA\'s PROFINET service use an input/output variable configuration to interpret the bits of the input/output process image. The NOVA\'s PROFINET service\'s configuration can be viewed via [listProfinetIOs](listProfinetIOs). For the PROFINET controller, e.g. a connected PLC, refer to the corresponding third party software, e.g. TIA portal).
|
|
5798
6078
|
* @summary Add PROFINET Input/Output
|
|
5799
6079
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5800
6080
|
* @param {string} io Unique identifier to address an Input/Output in the cell.
|
|
@@ -5804,7 +6084,7 @@ export declare const BUSInputsOutputsApiFactory: (configuration?: Configuration,
|
|
|
5804
6084
|
*/
|
|
5805
6085
|
addProfinetIO(cell: string, io: string, profinetIOData: ProfinetIOData, options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
5806
6086
|
/**
|
|
5807
|
-
*
|
|
6087
|
+
* Remove the BUS inputs/outputs service from the cell.
|
|
5808
6088
|
* @summary Clear Service
|
|
5809
6089
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5810
6090
|
* @param {number} [completionTimeout]
|
|
@@ -5813,7 +6093,7 @@ export declare const BUSInputsOutputsApiFactory: (configuration?: Configuration,
|
|
|
5813
6093
|
*/
|
|
5814
6094
|
clearBusIOService(cell: string, completionTimeout?: number, options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
5815
6095
|
/**
|
|
5816
|
-
* Removes
|
|
6096
|
+
* Removes an input/output variable configuration from the PROFINET device, e.g. NOVA\'s PROFINET service.
|
|
5817
6097
|
* @summary Remove PROFINET Input/Ouptut
|
|
5818
6098
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5819
6099
|
* @param {string} io Unique identifier to address an Input/Output in the cell.
|
|
@@ -5822,7 +6102,7 @@ export declare const BUSInputsOutputsApiFactory: (configuration?: Configuration,
|
|
|
5822
6102
|
*/
|
|
5823
6103
|
deleteProfinetIO(cell: string, io: string, options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
5824
6104
|
/**
|
|
5825
|
-
* Get deployed BUS
|
|
6105
|
+
* Get deployed BUS inputs/outputs service.
|
|
5826
6106
|
* @summary Get Service
|
|
5827
6107
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5828
6108
|
* @param {*} [options] Override http request option.
|
|
@@ -5847,7 +6127,7 @@ export declare const BUSInputsOutputsApiFactory: (configuration?: Configuration,
|
|
|
5847
6127
|
*/
|
|
5848
6128
|
getBusIOValues(cell: string, ios?: Array<string>, options?: RawAxiosRequestConfig): AxiosPromise<Array<IOValue>>;
|
|
5849
6129
|
/**
|
|
5850
|
-
* Get description of PROFINET
|
|
6130
|
+
* Get description of NOVA as a PROFINET device.
|
|
5851
6131
|
* @summary Get PROFINET Description
|
|
5852
6132
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5853
6133
|
* @param {*} [options] Override http request option.
|
|
@@ -5855,7 +6135,7 @@ export declare const BUSInputsOutputsApiFactory: (configuration?: Configuration,
|
|
|
5855
6135
|
*/
|
|
5856
6136
|
getProfinetDescription(cell: string, options?: RawAxiosRequestConfig): AxiosPromise<ProfinetDescription>;
|
|
5857
6137
|
/**
|
|
5858
|
-
* Get input/output configuration of the PROFINET device as file.
|
|
6138
|
+
* Get input/output variable configuration of the PROFINET device, e.g. NOVA\'s PROFINET service as file. You can specify byte offsets for the input and output variable addresses to get an XML tagmap that is ready to paste to the third party software, e.g. TIA portal.
|
|
5859
6139
|
* @summary PROFINET Inputs/Outputs to File
|
|
5860
6140
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5861
6141
|
* @param {number} [inputOffset]
|
|
@@ -5865,15 +6145,15 @@ export declare const BUSInputsOutputsApiFactory: (configuration?: Configuration,
|
|
|
5865
6145
|
*/
|
|
5866
6146
|
getProfinetIOsFromFile(cell: string, inputOffset?: number, outputOffset?: number, options?: RawAxiosRequestConfig): AxiosPromise<string>;
|
|
5867
6147
|
/**
|
|
5868
|
-
* List all BUS
|
|
6148
|
+
* List all input/output descriptions for configured BUS services. The input/output descriptions contain information such as the name, the type and the unit. The input/output direction is given in perspective of the BUS service.
|
|
5869
6149
|
* @summary List Descriptions
|
|
5870
6150
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5871
6151
|
* @param {*} [options] Override http request option.
|
|
5872
6152
|
* @throws {RequiredError}
|
|
5873
6153
|
*/
|
|
5874
|
-
listBusIODescriptions(cell: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<
|
|
6154
|
+
listBusIODescriptions(cell: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<IODescription2>>;
|
|
5875
6155
|
/**
|
|
5876
|
-
* List all PROFINET input and
|
|
6156
|
+
* List descriptions for all configured input/output variables of the PROFINET service. The input/output descriptions contain information such as the name, the type and the unit. The input/output direction is given in perspective of the PROFINET Device, e.g. the configured PROFINET service. The byte and bit addresses are the locations in the PROFINET input/output process image the variable points to. The PROFINET controller as well as NOVA\'s PROFINET service use an input/output variable configuration to interpret the bits of the input and output process image. The NOVA PROFINET service\'s configuration is modified via [addProfinetIO](addProfinetIO) and [setProfinetIOsFromFile](setProfinetIOsFromFile). For the PROFINET controller, e.g. a connected PLC, refer to the corresponding third party software, e.g. TIA portal.
|
|
5877
6157
|
* @summary List PROFINET Input/Output Configuration
|
|
5878
6158
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5879
6159
|
* @param {*} [options] Override http request option.
|
|
@@ -5890,7 +6170,7 @@ export declare const BUSInputsOutputsApiFactory: (configuration?: Configuration,
|
|
|
5890
6170
|
*/
|
|
5891
6171
|
setBusIOValues(cell: string, iOValue: Array<IOValue>, options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
5892
6172
|
/**
|
|
5893
|
-
* Sets inputs/outputs
|
|
6173
|
+
* Sets input/output variable configuration on the PROFINET device (i.e. NOVA\'s PROFINET service) from XML file. The inputs/outputs map variables to specific memory addresses in the process image. The default process image has buffer lengths of 64 bytes for input and output. The size of the buffer is determined by the `config_file_content` that is passed in [addBusIOService](addBusIOService) and has to be in accordance with the GSDML file describing the PROFINET device. The PROFINET controller as well as NOVA\'s PROFINET service use an input/output variable configuration to interpret the bits of the input/output process image. The NOVA\'s PROFINET service\'s configuration can be viewed via [listProfinetIOs](listProfinetIOs). For the PROFINET controller, e.g. a connected PLC, refer to the corresponding engineering system, e.g. TIA portal. You can export the variable configuration of the PROFINET controller as XML file from your engineering system, e.g. TIA portal. The endpoint is built so that the perspective of input and output (PROFINET Device\'s input is PROFINET Controller\'s output) is internally handled (PROFINET device input is PROFINET controller output), meaning that you can paste the exported XML file here without modifying.
|
|
5894
6174
|
* @summary Set PROFINET Inputs/Outputs from File
|
|
5895
6175
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5896
6176
|
* @param {ProfinetInputOutputConfig} profinetInputOutputConfig
|
|
@@ -5907,7 +6187,7 @@ export declare const BUSInputsOutputsApiFactory: (configuration?: Configuration,
|
|
|
5907
6187
|
*/
|
|
5908
6188
|
export declare class BUSInputsOutputsApi extends BaseAPI {
|
|
5909
6189
|
/**
|
|
5910
|
-
* Add
|
|
6190
|
+
* Add the BUS inputs/outputs service to the cell. Starts a containerized service that enables BUS connections via the specified ethernet port.
|
|
5911
6191
|
* @summary Add Service
|
|
5912
6192
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5913
6193
|
* @param {BusIOType} busIOType
|
|
@@ -5918,7 +6198,7 @@ export declare class BUSInputsOutputsApi extends BaseAPI {
|
|
|
5918
6198
|
*/
|
|
5919
6199
|
addBusIOService(cell: string, busIOType: BusIOType, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
5920
6200
|
/**
|
|
5921
|
-
* Adds an input/output to or updates an input/output on the PROFINET device.
|
|
6201
|
+
* Adds an input/output variable to or updates an input/output variable on the PROFINET device, e.g. NOVA\'s PROFINET service. The inputs/outputs map variables to specific memory addresses in the process image. The default process image has buffer lengths of 64 bytes for input and output. The size of the buffer is determined by the `config_file_content` that is passed in [addBusIOService](addBusIOService) and has to be in accordance with the GSDML file describing the PROFINET device. The PROFINET controller as well as NOVA\'s PROFINET service use an input/output variable configuration to interpret the bits of the input/output process image. The NOVA\'s PROFINET service\'s configuration can be viewed via [listProfinetIOs](listProfinetIOs). For the PROFINET controller, e.g. a connected PLC, refer to the corresponding third party software, e.g. TIA portal).
|
|
5922
6202
|
* @summary Add PROFINET Input/Output
|
|
5923
6203
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5924
6204
|
* @param {string} io Unique identifier to address an Input/Output in the cell.
|
|
@@ -5929,7 +6209,7 @@ export declare class BUSInputsOutputsApi extends BaseAPI {
|
|
|
5929
6209
|
*/
|
|
5930
6210
|
addProfinetIO(cell: string, io: string, profinetIOData: ProfinetIOData, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
5931
6211
|
/**
|
|
5932
|
-
*
|
|
6212
|
+
* Remove the BUS inputs/outputs service from the cell.
|
|
5933
6213
|
* @summary Clear Service
|
|
5934
6214
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5935
6215
|
* @param {number} [completionTimeout]
|
|
@@ -5939,7 +6219,7 @@ export declare class BUSInputsOutputsApi extends BaseAPI {
|
|
|
5939
6219
|
*/
|
|
5940
6220
|
clearBusIOService(cell: string, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
5941
6221
|
/**
|
|
5942
|
-
* Removes
|
|
6222
|
+
* Removes an input/output variable configuration from the PROFINET device, e.g. NOVA\'s PROFINET service.
|
|
5943
6223
|
* @summary Remove PROFINET Input/Ouptut
|
|
5944
6224
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5945
6225
|
* @param {string} io Unique identifier to address an Input/Output in the cell.
|
|
@@ -5949,16 +6229,14 @@ export declare class BUSInputsOutputsApi extends BaseAPI {
|
|
|
5949
6229
|
*/
|
|
5950
6230
|
deleteProfinetIO(cell: string, io: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
5951
6231
|
/**
|
|
5952
|
-
* Get deployed BUS
|
|
6232
|
+
* Get deployed BUS inputs/outputs service.
|
|
5953
6233
|
* @summary Get Service
|
|
5954
6234
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5955
6235
|
* @param {*} [options] Override http request option.
|
|
5956
6236
|
* @throws {RequiredError}
|
|
5957
6237
|
* @memberof BUSInputsOutputsApi
|
|
5958
6238
|
*/
|
|
5959
|
-
getBusIOService(cell: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<
|
|
5960
|
-
bus_type: "profinet";
|
|
5961
|
-
} & BusIOProfinet, any>>;
|
|
6239
|
+
getBusIOService(cell: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<BusIOType, any>>;
|
|
5962
6240
|
/**
|
|
5963
6241
|
* Get the current state of the BUS Inputs/Outputs service.
|
|
5964
6242
|
* @summary State
|
|
@@ -5979,7 +6257,7 @@ export declare class BUSInputsOutputsApi extends BaseAPI {
|
|
|
5979
6257
|
*/
|
|
5980
6258
|
getBusIOValues(cell: string, ios?: Array<string>, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<IOValue[], any>>;
|
|
5981
6259
|
/**
|
|
5982
|
-
* Get description of PROFINET
|
|
6260
|
+
* Get description of NOVA as a PROFINET device.
|
|
5983
6261
|
* @summary Get PROFINET Description
|
|
5984
6262
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5985
6263
|
* @param {*} [options] Override http request option.
|
|
@@ -5988,7 +6266,7 @@ export declare class BUSInputsOutputsApi extends BaseAPI {
|
|
|
5988
6266
|
*/
|
|
5989
6267
|
getProfinetDescription(cell: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ProfinetDescription, any>>;
|
|
5990
6268
|
/**
|
|
5991
|
-
* Get input/output configuration of the PROFINET device as file.
|
|
6269
|
+
* Get input/output variable configuration of the PROFINET device, e.g. NOVA\'s PROFINET service as file. You can specify byte offsets for the input and output variable addresses to get an XML tagmap that is ready to paste to the third party software, e.g. TIA portal.
|
|
5992
6270
|
* @summary PROFINET Inputs/Outputs to File
|
|
5993
6271
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5994
6272
|
* @param {number} [inputOffset]
|
|
@@ -5999,16 +6277,16 @@ export declare class BUSInputsOutputsApi extends BaseAPI {
|
|
|
5999
6277
|
*/
|
|
6000
6278
|
getProfinetIOsFromFile(cell: string, inputOffset?: number, outputOffset?: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<string, any>>;
|
|
6001
6279
|
/**
|
|
6002
|
-
* List all BUS
|
|
6280
|
+
* List all input/output descriptions for configured BUS services. The input/output descriptions contain information such as the name, the type and the unit. The input/output direction is given in perspective of the BUS service.
|
|
6003
6281
|
* @summary List Descriptions
|
|
6004
6282
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
6005
6283
|
* @param {*} [options] Override http request option.
|
|
6006
6284
|
* @throws {RequiredError}
|
|
6007
6285
|
* @memberof BUSInputsOutputsApi
|
|
6008
6286
|
*/
|
|
6009
|
-
listBusIODescriptions(cell: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<
|
|
6287
|
+
listBusIODescriptions(cell: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<IODescription2[], any>>;
|
|
6010
6288
|
/**
|
|
6011
|
-
* List all PROFINET input and
|
|
6289
|
+
* List descriptions for all configured input/output variables of the PROFINET service. The input/output descriptions contain information such as the name, the type and the unit. The input/output direction is given in perspective of the PROFINET Device, e.g. the configured PROFINET service. The byte and bit addresses are the locations in the PROFINET input/output process image the variable points to. The PROFINET controller as well as NOVA\'s PROFINET service use an input/output variable configuration to interpret the bits of the input and output process image. The NOVA PROFINET service\'s configuration is modified via [addProfinetIO](addProfinetIO) and [setProfinetIOsFromFile](setProfinetIOsFromFile). For the PROFINET controller, e.g. a connected PLC, refer to the corresponding third party software, e.g. TIA portal.
|
|
6012
6290
|
* @summary List PROFINET Input/Output Configuration
|
|
6013
6291
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
6014
6292
|
* @param {*} [options] Override http request option.
|
|
@@ -6027,7 +6305,7 @@ export declare class BUSInputsOutputsApi extends BaseAPI {
|
|
|
6027
6305
|
*/
|
|
6028
6306
|
setBusIOValues(cell: string, iOValue: Array<IOValue>, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
6029
6307
|
/**
|
|
6030
|
-
* Sets inputs/outputs
|
|
6308
|
+
* Sets input/output variable configuration on the PROFINET device (i.e. NOVA\'s PROFINET service) from XML file. The inputs/outputs map variables to specific memory addresses in the process image. The default process image has buffer lengths of 64 bytes for input and output. The size of the buffer is determined by the `config_file_content` that is passed in [addBusIOService](addBusIOService) and has to be in accordance with the GSDML file describing the PROFINET device. The PROFINET controller as well as NOVA\'s PROFINET service use an input/output variable configuration to interpret the bits of the input/output process image. The NOVA\'s PROFINET service\'s configuration can be viewed via [listProfinetIOs](listProfinetIOs). For the PROFINET controller, e.g. a connected PLC, refer to the corresponding engineering system, e.g. TIA portal. You can export the variable configuration of the PROFINET controller as XML file from your engineering system, e.g. TIA portal. The endpoint is built so that the perspective of input and output (PROFINET Device\'s input is PROFINET Controller\'s output) is internally handled (PROFINET device input is PROFINET controller output), meaning that you can paste the exported XML file here without modifying.
|
|
6031
6309
|
* @summary Set PROFINET Inputs/Outputs from File
|
|
6032
6310
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
6033
6311
|
* @param {ProfinetInputOutputConfig} profinetInputOutputConfig
|
|
@@ -7617,7 +7895,7 @@ export declare class MotionGroupApi extends BaseAPI {
|
|
|
7617
7895
|
*/
|
|
7618
7896
|
export declare const MotionGroupModelsApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
7619
7897
|
/**
|
|
7620
|
-
* Returns the default collision link chain for a given motion group model. See [
|
|
7898
|
+
* Returns the default collision link chain for a given motion group model. See [getMotionGroupModels](getMotionGroupModels) for supported motion group models. The default link chain is derived from 3D models and optimized for collision detection within NOVA. The default link chain includes link shapes only. It does not include any attached components like wire feeders or sensors. Attach additional shapes to the link reference frames by extending the link dictionaries before further use. Additional shapes may overlap each other per link and may also overlap the respective link\'s default shape.
|
|
7621
7899
|
* @summary Get Collision Model
|
|
7622
7900
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
7623
7901
|
* @param {string} motionGroupModel Unique identifier for the model of a motion group, e.g. `UniversalRobots_UR10e`. Get the `model` of a configured motion group with [getOptimizerConfiguration](getOptimizerConfiguration).
|
|
@@ -7640,7 +7918,7 @@ export declare const MotionGroupModelsApiAxiosParamCreator: (configuration?: Con
|
|
|
7640
7918
|
*/
|
|
7641
7919
|
export declare const MotionGroupModelsApiFp: (configuration?: Configuration) => {
|
|
7642
7920
|
/**
|
|
7643
|
-
* Returns the default collision link chain for a given motion group model. See [
|
|
7921
|
+
* Returns the default collision link chain for a given motion group model. See [getMotionGroupModels](getMotionGroupModels) for supported motion group models. The default link chain is derived from 3D models and optimized for collision detection within NOVA. The default link chain includes link shapes only. It does not include any attached components like wire feeders or sensors. Attach additional shapes to the link reference frames by extending the link dictionaries before further use. Additional shapes may overlap each other per link and may also overlap the respective link\'s default shape.
|
|
7644
7922
|
* @summary Get Collision Model
|
|
7645
7923
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
7646
7924
|
* @param {string} motionGroupModel Unique identifier for the model of a motion group, e.g. `UniversalRobots_UR10e`. Get the `model` of a configured motion group with [getOptimizerConfiguration](getOptimizerConfiguration).
|
|
@@ -7665,7 +7943,7 @@ export declare const MotionGroupModelsApiFp: (configuration?: Configuration) =>
|
|
|
7665
7943
|
*/
|
|
7666
7944
|
export declare const MotionGroupModelsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
7667
7945
|
/**
|
|
7668
|
-
* Returns the default collision link chain for a given motion group model. See [
|
|
7946
|
+
* Returns the default collision link chain for a given motion group model. See [getMotionGroupModels](getMotionGroupModels) for supported motion group models. The default link chain is derived from 3D models and optimized for collision detection within NOVA. The default link chain includes link shapes only. It does not include any attached components like wire feeders or sensors. Attach additional shapes to the link reference frames by extending the link dictionaries before further use. Additional shapes may overlap each other per link and may also overlap the respective link\'s default shape.
|
|
7669
7947
|
* @summary Get Collision Model
|
|
7670
7948
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
7671
7949
|
* @param {string} motionGroupModel Unique identifier for the model of a motion group, e.g. `UniversalRobots_UR10e`. Get the `model` of a configured motion group with [getOptimizerConfiguration](getOptimizerConfiguration).
|
|
@@ -7692,7 +7970,7 @@ export declare const MotionGroupModelsApiFactory: (configuration?: Configuration
|
|
|
7692
7970
|
*/
|
|
7693
7971
|
export declare class MotionGroupModelsApi extends BaseAPI {
|
|
7694
7972
|
/**
|
|
7695
|
-
* Returns the default collision link chain for a given motion group model. See [
|
|
7973
|
+
* Returns the default collision link chain for a given motion group model. See [getMotionGroupModels](getMotionGroupModels) for supported motion group models. The default link chain is derived from 3D models and optimized for collision detection within NOVA. The default link chain includes link shapes only. It does not include any attached components like wire feeders or sensors. Attach additional shapes to the link reference frames by extending the link dictionaries before further use. Additional shapes may overlap each other per link and may also overlap the respective link\'s default shape.
|
|
7696
7974
|
* @summary Get Collision Model
|
|
7697
7975
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
7698
7976
|
* @param {string} motionGroupModel Unique identifier for the model of a motion group, e.g. `UniversalRobots_UR10e`. Get the `model` of a configured motion group with [getOptimizerConfiguration](getOptimizerConfiguration).
|
|
@@ -7713,6 +7991,180 @@ export declare class MotionGroupModelsApi extends BaseAPI {
|
|
|
7713
7991
|
*/
|
|
7714
7992
|
getMotionGroupModels(cell: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<string[], any>>;
|
|
7715
7993
|
}
|
|
7994
|
+
/**
|
|
7995
|
+
* ProgramApi - axios parameter creator
|
|
7996
|
+
* @export
|
|
7997
|
+
*/
|
|
7998
|
+
export declare const ProgramApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
7999
|
+
/**
|
|
8000
|
+
* Get details of a program.
|
|
8001
|
+
* @summary Get program
|
|
8002
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8003
|
+
* @param {string} program
|
|
8004
|
+
* @param {*} [options] Override http request option.
|
|
8005
|
+
* @throws {RequiredError}
|
|
8006
|
+
*/
|
|
8007
|
+
getProgram: (cell: string, program: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
8008
|
+
/**
|
|
8009
|
+
* List details of all existing programs.
|
|
8010
|
+
* @summary List programs
|
|
8011
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8012
|
+
* @param {*} [options] Override http request option.
|
|
8013
|
+
* @throws {RequiredError}
|
|
8014
|
+
*/
|
|
8015
|
+
listPrograms: (cell: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
8016
|
+
/**
|
|
8017
|
+
* This endpoint starts a new program execution. The program will be executed asynchronously.
|
|
8018
|
+
* @summary Start the program
|
|
8019
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8020
|
+
* @param {string} program
|
|
8021
|
+
* @param {ProgramStartRequest} programStartRequest
|
|
8022
|
+
* @param {*} [options] Override http request option.
|
|
8023
|
+
* @throws {RequiredError}
|
|
8024
|
+
*/
|
|
8025
|
+
startProgram: (cell: string, program: string, programStartRequest: ProgramStartRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
8026
|
+
/**
|
|
8027
|
+
* Stop a specific program run.
|
|
8028
|
+
* @summary Stop program run
|
|
8029
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8030
|
+
* @param {string} program
|
|
8031
|
+
* @param {*} [options] Override http request option.
|
|
8032
|
+
* @throws {RequiredError}
|
|
8033
|
+
*/
|
|
8034
|
+
stopProgram: (cell: string, program: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
8035
|
+
};
|
|
8036
|
+
/**
|
|
8037
|
+
* ProgramApi - functional programming interface
|
|
8038
|
+
* @export
|
|
8039
|
+
*/
|
|
8040
|
+
export declare const ProgramApiFp: (configuration?: Configuration) => {
|
|
8041
|
+
/**
|
|
8042
|
+
* Get details of a program.
|
|
8043
|
+
* @summary Get program
|
|
8044
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8045
|
+
* @param {string} program
|
|
8046
|
+
* @param {*} [options] Override http request option.
|
|
8047
|
+
* @throws {RequiredError}
|
|
8048
|
+
*/
|
|
8049
|
+
getProgram(cell: string, program: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Program>>;
|
|
8050
|
+
/**
|
|
8051
|
+
* List details of all existing programs.
|
|
8052
|
+
* @summary List programs
|
|
8053
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8054
|
+
* @param {*} [options] Override http request option.
|
|
8055
|
+
* @throws {RequiredError}
|
|
8056
|
+
*/
|
|
8057
|
+
listPrograms(cell: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<Program>>>;
|
|
8058
|
+
/**
|
|
8059
|
+
* This endpoint starts a new program execution. The program will be executed asynchronously.
|
|
8060
|
+
* @summary Start the program
|
|
8061
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8062
|
+
* @param {string} program
|
|
8063
|
+
* @param {ProgramStartRequest} programStartRequest
|
|
8064
|
+
* @param {*} [options] Override http request option.
|
|
8065
|
+
* @throws {RequiredError}
|
|
8066
|
+
*/
|
|
8067
|
+
startProgram(cell: string, program: string, programStartRequest: ProgramStartRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ProgramRun>>;
|
|
8068
|
+
/**
|
|
8069
|
+
* Stop a specific program run.
|
|
8070
|
+
* @summary Stop program run
|
|
8071
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8072
|
+
* @param {string} program
|
|
8073
|
+
* @param {*} [options] Override http request option.
|
|
8074
|
+
* @throws {RequiredError}
|
|
8075
|
+
*/
|
|
8076
|
+
stopProgram(cell: string, program: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
8077
|
+
};
|
|
8078
|
+
/**
|
|
8079
|
+
* ProgramApi - factory interface
|
|
8080
|
+
* @export
|
|
8081
|
+
*/
|
|
8082
|
+
export declare const ProgramApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
8083
|
+
/**
|
|
8084
|
+
* Get details of a program.
|
|
8085
|
+
* @summary Get program
|
|
8086
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8087
|
+
* @param {string} program
|
|
8088
|
+
* @param {*} [options] Override http request option.
|
|
8089
|
+
* @throws {RequiredError}
|
|
8090
|
+
*/
|
|
8091
|
+
getProgram(cell: string, program: string, options?: RawAxiosRequestConfig): AxiosPromise<Program>;
|
|
8092
|
+
/**
|
|
8093
|
+
* List details of all existing programs.
|
|
8094
|
+
* @summary List programs
|
|
8095
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8096
|
+
* @param {*} [options] Override http request option.
|
|
8097
|
+
* @throws {RequiredError}
|
|
8098
|
+
*/
|
|
8099
|
+
listPrograms(cell: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<Program>>;
|
|
8100
|
+
/**
|
|
8101
|
+
* This endpoint starts a new program execution. The program will be executed asynchronously.
|
|
8102
|
+
* @summary Start the program
|
|
8103
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8104
|
+
* @param {string} program
|
|
8105
|
+
* @param {ProgramStartRequest} programStartRequest
|
|
8106
|
+
* @param {*} [options] Override http request option.
|
|
8107
|
+
* @throws {RequiredError}
|
|
8108
|
+
*/
|
|
8109
|
+
startProgram(cell: string, program: string, programStartRequest: ProgramStartRequest, options?: RawAxiosRequestConfig): AxiosPromise<ProgramRun>;
|
|
8110
|
+
/**
|
|
8111
|
+
* Stop a specific program run.
|
|
8112
|
+
* @summary Stop program run
|
|
8113
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8114
|
+
* @param {string} program
|
|
8115
|
+
* @param {*} [options] Override http request option.
|
|
8116
|
+
* @throws {RequiredError}
|
|
8117
|
+
*/
|
|
8118
|
+
stopProgram(cell: string, program: string, options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
8119
|
+
};
|
|
8120
|
+
/**
|
|
8121
|
+
* ProgramApi - object-oriented interface
|
|
8122
|
+
* @export
|
|
8123
|
+
* @class ProgramApi
|
|
8124
|
+
* @extends {BaseAPI}
|
|
8125
|
+
*/
|
|
8126
|
+
export declare class ProgramApi extends BaseAPI {
|
|
8127
|
+
/**
|
|
8128
|
+
* Get details of a program.
|
|
8129
|
+
* @summary Get program
|
|
8130
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8131
|
+
* @param {string} program
|
|
8132
|
+
* @param {*} [options] Override http request option.
|
|
8133
|
+
* @throws {RequiredError}
|
|
8134
|
+
* @memberof ProgramApi
|
|
8135
|
+
*/
|
|
8136
|
+
getProgram(cell: string, program: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Program, any>>;
|
|
8137
|
+
/**
|
|
8138
|
+
* List details of all existing programs.
|
|
8139
|
+
* @summary List programs
|
|
8140
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8141
|
+
* @param {*} [options] Override http request option.
|
|
8142
|
+
* @throws {RequiredError}
|
|
8143
|
+
* @memberof ProgramApi
|
|
8144
|
+
*/
|
|
8145
|
+
listPrograms(cell: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Program[], any>>;
|
|
8146
|
+
/**
|
|
8147
|
+
* This endpoint starts a new program execution. The program will be executed asynchronously.
|
|
8148
|
+
* @summary Start the program
|
|
8149
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8150
|
+
* @param {string} program
|
|
8151
|
+
* @param {ProgramStartRequest} programStartRequest
|
|
8152
|
+
* @param {*} [options] Override http request option.
|
|
8153
|
+
* @throws {RequiredError}
|
|
8154
|
+
* @memberof ProgramApi
|
|
8155
|
+
*/
|
|
8156
|
+
startProgram(cell: string, program: string, programStartRequest: ProgramStartRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ProgramRun, any>>;
|
|
8157
|
+
/**
|
|
8158
|
+
* Stop a specific program run.
|
|
8159
|
+
* @summary Stop program run
|
|
8160
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8161
|
+
* @param {string} program
|
|
8162
|
+
* @param {*} [options] Override http request option.
|
|
8163
|
+
* @throws {RequiredError}
|
|
8164
|
+
* @memberof ProgramApi
|
|
8165
|
+
*/
|
|
8166
|
+
stopProgram(cell: string, program: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
8167
|
+
}
|
|
7716
8168
|
/**
|
|
7717
8169
|
* StoreCollisionComponentsApi - axios parameter creator
|
|
7718
8170
|
* @export
|
|
@@ -7781,7 +8233,7 @@ export declare const StoreCollisionComponentsApiAxiosParamCreator: (configuratio
|
|
|
7781
8233
|
*/
|
|
7782
8234
|
listCollisionLinkChains: (cell: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
7783
8235
|
/**
|
|
7784
|
-
* Returns
|
|
8236
|
+
* Returns all stored colliders.
|
|
7785
8237
|
* @summary List Colliders
|
|
7786
8238
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
7787
8239
|
* @param {*} [options] Override http request option.
|
|
@@ -7907,7 +8359,7 @@ export declare const StoreCollisionComponentsApiFp: (configuration?: Configurati
|
|
|
7907
8359
|
}>;
|
|
7908
8360
|
}>>;
|
|
7909
8361
|
/**
|
|
7910
|
-
* Returns
|
|
8362
|
+
* Returns all stored colliders.
|
|
7911
8363
|
* @summary List Colliders
|
|
7912
8364
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
7913
8365
|
* @param {*} [options] Override http request option.
|
|
@@ -8043,7 +8495,7 @@ export declare const StoreCollisionComponentsApiFactory: (configuration?: Config
|
|
|
8043
8495
|
}>;
|
|
8044
8496
|
}>;
|
|
8045
8497
|
/**
|
|
8046
|
-
* Returns
|
|
8498
|
+
* Returns all stored colliders.
|
|
8047
8499
|
* @summary List Colliders
|
|
8048
8500
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8049
8501
|
* @param {*} [options] Override http request option.
|
|
@@ -8188,7 +8640,7 @@ export declare class StoreCollisionComponentsApi extends BaseAPI {
|
|
|
8188
8640
|
}[];
|
|
8189
8641
|
}, any>>;
|
|
8190
8642
|
/**
|
|
8191
|
-
* Returns
|
|
8643
|
+
* Returns all stored colliders.
|
|
8192
8644
|
* @summary List Colliders
|
|
8193
8645
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8194
8646
|
* @param {*} [options] Override http request option.
|