@wandelbots/nova-api 25.4.0-dev.3 → 25.4.0-dev.31
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/package.json +1 -1
- package/v1/api.d.ts +2 -2
- package/v1/api.ts +2 -2
- package/v2/api.d.ts +467 -357
- package/v2/api.js +457 -100
- package/v2/api.js.map +1 -1
- package/v2/api.ts +727 -404
package/v2/api.d.ts
CHANGED
|
@@ -228,6 +228,12 @@ export interface App {
|
|
|
228
228
|
* @memberof App
|
|
229
229
|
*/
|
|
230
230
|
'storage'?: ContainerStorage;
|
|
231
|
+
/**
|
|
232
|
+
* Defines the URL path suffix used to check the application\'s health status. The complete health check URL is constructed as `/$cell/$name/$health_path`. When the application is working as expected, the endpoint returns an HTTP 200 status code. If not specified, the system will default to using the application icon path suffix (the value of `app_icon`) as the health check endpoint, resulting in `/$cell/$name/$app_icon`. If the health check fails (no response or non-200 status code), the system will automatically restart the application container to restore service.
|
|
233
|
+
* @type {string}
|
|
234
|
+
* @memberof App
|
|
235
|
+
*/
|
|
236
|
+
'health_path'?: string;
|
|
231
237
|
}
|
|
232
238
|
/**
|
|
233
239
|
*
|
|
@@ -410,7 +416,17 @@ export interface BooleanValue {
|
|
|
410
416
|
* @memberof BooleanValue
|
|
411
417
|
*/
|
|
412
418
|
'boolean_value': boolean;
|
|
419
|
+
/**
|
|
420
|
+
*
|
|
421
|
+
* @type {string}
|
|
422
|
+
* @memberof BooleanValue
|
|
423
|
+
*/
|
|
424
|
+
'value_type'?: BooleanValueValueTypeEnum;
|
|
413
425
|
}
|
|
426
|
+
export declare const BooleanValueValueTypeEnum: {
|
|
427
|
+
readonly Boolean: "boolean";
|
|
428
|
+
};
|
|
429
|
+
export type BooleanValueValueTypeEnum = typeof BooleanValueValueTypeEnum[keyof typeof BooleanValueValueTypeEnum];
|
|
414
430
|
/**
|
|
415
431
|
* Defines a cuboid shape centered around an origin.
|
|
416
432
|
* @export
|
|
@@ -566,6 +582,12 @@ export interface Cell {
|
|
|
566
582
|
* @memberof Cell
|
|
567
583
|
*/
|
|
568
584
|
'name': string;
|
|
585
|
+
/**
|
|
586
|
+
* A description of the cell.
|
|
587
|
+
* @type {string}
|
|
588
|
+
* @memberof Cell
|
|
589
|
+
*/
|
|
590
|
+
'description'?: string;
|
|
569
591
|
/**
|
|
570
592
|
*
|
|
571
593
|
* @type {Array<RobotController>}
|
|
@@ -614,10 +636,10 @@ export interface Collider {
|
|
|
614
636
|
'shape': ColliderShape;
|
|
615
637
|
/**
|
|
616
638
|
*
|
|
617
|
-
* @type {
|
|
639
|
+
* @type {Pose}
|
|
618
640
|
* @memberof Collider
|
|
619
641
|
*/
|
|
620
|
-
'pose'?:
|
|
642
|
+
'pose'?: Pose;
|
|
621
643
|
/**
|
|
622
644
|
* Increases the shape\'s size in all dimensions. Applied in [mm]. Can be used to keep a safe distance to the shape.
|
|
623
645
|
* @type {number}
|
|
@@ -870,6 +892,31 @@ export interface Compound {
|
|
|
870
892
|
*/
|
|
871
893
|
'child_geometries': Array<Geometry>;
|
|
872
894
|
}
|
|
895
|
+
/**
|
|
896
|
+
* Configuration resource object.
|
|
897
|
+
* @export
|
|
898
|
+
* @interface ConfigurationResource
|
|
899
|
+
*/
|
|
900
|
+
export interface ConfigurationResource {
|
|
901
|
+
/**
|
|
902
|
+
* Identifier of a configuration resource.
|
|
903
|
+
* @type {string}
|
|
904
|
+
* @memberof ConfigurationResource
|
|
905
|
+
*/
|
|
906
|
+
'id': string;
|
|
907
|
+
/**
|
|
908
|
+
* Human-readable name of the configuration resource.
|
|
909
|
+
* @type {string}
|
|
910
|
+
* @memberof ConfigurationResource
|
|
911
|
+
*/
|
|
912
|
+
'name': string;
|
|
913
|
+
/**
|
|
914
|
+
* Array of configuration resources.
|
|
915
|
+
* @type {Array<ConfigurationResource>}
|
|
916
|
+
* @memberof ConfigurationResource
|
|
917
|
+
*/
|
|
918
|
+
'children'?: Array<ConfigurationResource>;
|
|
919
|
+
}
|
|
873
920
|
/**
|
|
874
921
|
*
|
|
875
922
|
* @export
|
|
@@ -1208,10 +1255,10 @@ export type CreateTriggerRequestConfig = OpcuaNodeValueTriggerConfig;
|
|
|
1208
1255
|
export interface CubicSplineParameter {
|
|
1209
1256
|
/**
|
|
1210
1257
|
*
|
|
1211
|
-
* @type {
|
|
1258
|
+
* @type {Pose}
|
|
1212
1259
|
* @memberof CubicSplineParameter
|
|
1213
1260
|
*/
|
|
1214
|
-
'pose':
|
|
1261
|
+
'pose': Pose;
|
|
1215
1262
|
/**
|
|
1216
1263
|
*
|
|
1217
1264
|
* @type {number}
|
|
@@ -1327,6 +1374,19 @@ export declare const Direction: {
|
|
|
1327
1374
|
readonly DirectionBackward: "DIRECTION_BACKWARD";
|
|
1328
1375
|
};
|
|
1329
1376
|
export type Direction = typeof Direction[keyof typeof Direction];
|
|
1377
|
+
/**
|
|
1378
|
+
*
|
|
1379
|
+
* @export
|
|
1380
|
+
* @interface Error2
|
|
1381
|
+
*/
|
|
1382
|
+
export interface Error2 {
|
|
1383
|
+
/**
|
|
1384
|
+
*
|
|
1385
|
+
* @type {string}
|
|
1386
|
+
* @memberof Error2
|
|
1387
|
+
*/
|
|
1388
|
+
'message': string;
|
|
1389
|
+
}
|
|
1330
1390
|
/**
|
|
1331
1391
|
* @type ExecuteJoggingRequest
|
|
1332
1392
|
* @export
|
|
@@ -1465,10 +1525,10 @@ export interface FeedbackCollision {
|
|
|
1465
1525
|
'joint_position'?: Array<number>;
|
|
1466
1526
|
/**
|
|
1467
1527
|
*
|
|
1468
|
-
* @type {
|
|
1528
|
+
* @type {Pose}
|
|
1469
1529
|
* @memberof FeedbackCollision
|
|
1470
1530
|
*/
|
|
1471
|
-
'tcp_pose'?:
|
|
1531
|
+
'tcp_pose'?: Pose;
|
|
1472
1532
|
/**
|
|
1473
1533
|
*
|
|
1474
1534
|
* @type {string}
|
|
@@ -1517,10 +1577,10 @@ export type FeedbackJointLimitExceededErrorFeedbackNameEnum = typeof FeedbackJoi
|
|
|
1517
1577
|
export interface FeedbackOutOfWorkspace {
|
|
1518
1578
|
/**
|
|
1519
1579
|
*
|
|
1520
|
-
* @type {
|
|
1580
|
+
* @type {Pose}
|
|
1521
1581
|
* @memberof FeedbackOutOfWorkspace
|
|
1522
1582
|
*/
|
|
1523
|
-
'invalid_tcp_pose'?:
|
|
1583
|
+
'invalid_tcp_pose'?: Pose;
|
|
1524
1584
|
/**
|
|
1525
1585
|
*
|
|
1526
1586
|
* @type {string}
|
|
@@ -1586,7 +1646,17 @@ export interface FloatValue {
|
|
|
1586
1646
|
* @memberof FloatValue
|
|
1587
1647
|
*/
|
|
1588
1648
|
'float_value': number;
|
|
1649
|
+
/**
|
|
1650
|
+
*
|
|
1651
|
+
* @type {string}
|
|
1652
|
+
* @memberof FloatValue
|
|
1653
|
+
*/
|
|
1654
|
+
'value_type'?: FloatValueValueTypeEnum;
|
|
1589
1655
|
}
|
|
1656
|
+
export declare const FloatValueValueTypeEnum: {
|
|
1657
|
+
readonly Float: "float";
|
|
1658
|
+
};
|
|
1659
|
+
export type FloatValueValueTypeEnum = typeof FloatValueValueTypeEnum[keyof typeof FloatValueValueTypeEnum];
|
|
1590
1660
|
/**
|
|
1591
1661
|
* Representing a force on a specific point in operational space, e.g. on robot flange.
|
|
1592
1662
|
* @export
|
|
@@ -1773,47 +1843,12 @@ export interface IOBooleanValue {
|
|
|
1773
1843
|
* @type {string}
|
|
1774
1844
|
* @memberof IOBooleanValue
|
|
1775
1845
|
*/
|
|
1776
|
-
'
|
|
1846
|
+
'value_type'?: IOBooleanValueValueTypeEnum;
|
|
1777
1847
|
}
|
|
1778
|
-
export declare const
|
|
1779
|
-
readonly
|
|
1848
|
+
export declare const IOBooleanValueValueTypeEnum: {
|
|
1849
|
+
readonly Boolean: "boolean";
|
|
1780
1850
|
};
|
|
1781
|
-
export type
|
|
1782
|
-
/**
|
|
1783
|
-
*
|
|
1784
|
-
* @export
|
|
1785
|
-
* @interface IOBooleanValue2
|
|
1786
|
-
*/
|
|
1787
|
-
export interface IOBooleanValue2 {
|
|
1788
|
-
/**
|
|
1789
|
-
*
|
|
1790
|
-
* @type {string}
|
|
1791
|
-
* @memberof IOBooleanValue2
|
|
1792
|
-
*/
|
|
1793
|
-
'io': string;
|
|
1794
|
-
/**
|
|
1795
|
-
*
|
|
1796
|
-
* @type {IODirection}
|
|
1797
|
-
* @memberof IOBooleanValue2
|
|
1798
|
-
*/
|
|
1799
|
-
'direction': IODirection;
|
|
1800
|
-
/**
|
|
1801
|
-
*
|
|
1802
|
-
* @type {boolean}
|
|
1803
|
-
* @memberof IOBooleanValue2
|
|
1804
|
-
*/
|
|
1805
|
-
'boolean_value': boolean;
|
|
1806
|
-
/**
|
|
1807
|
-
*
|
|
1808
|
-
* @type {string}
|
|
1809
|
-
* @memberof IOBooleanValue2
|
|
1810
|
-
*/
|
|
1811
|
-
'io_value_type'?: IOBooleanValue2IoValueTypeEnum;
|
|
1812
|
-
}
|
|
1813
|
-
export declare const IOBooleanValue2IoValueTypeEnum: {
|
|
1814
|
-
readonly IoBooleanValue: "IOBooleanValue";
|
|
1815
|
-
};
|
|
1816
|
-
export type IOBooleanValue2IoValueTypeEnum = typeof IOBooleanValue2IoValueTypeEnum[keyof typeof IOBooleanValue2IoValueTypeEnum];
|
|
1851
|
+
export type IOBooleanValueValueTypeEnum = typeof IOBooleanValueValueTypeEnum[keyof typeof IOBooleanValueValueTypeEnum];
|
|
1817
1852
|
/**
|
|
1818
1853
|
*
|
|
1819
1854
|
* @export
|
|
@@ -1843,7 +1878,7 @@ export interface IODescription {
|
|
|
1843
1878
|
* @type {IODirection}
|
|
1844
1879
|
* @memberof IODescription
|
|
1845
1880
|
*/
|
|
1846
|
-
'direction'
|
|
1881
|
+
'direction': IODirection;
|
|
1847
1882
|
/**
|
|
1848
1883
|
*
|
|
1849
1884
|
* @type {IOValueType}
|
|
@@ -1873,7 +1908,13 @@ export interface IODescription {
|
|
|
1873
1908
|
* @type IODescriptionMin
|
|
1874
1909
|
* @export
|
|
1875
1910
|
*/
|
|
1876
|
-
export type IODescriptionMin =
|
|
1911
|
+
export type IODescriptionMin = {
|
|
1912
|
+
value_type: 'boolean';
|
|
1913
|
+
} & BooleanValue | {
|
|
1914
|
+
value_type: 'float';
|
|
1915
|
+
} & FloatValue | {
|
|
1916
|
+
value_type: 'integer';
|
|
1917
|
+
} & IntegerValue;
|
|
1877
1918
|
/**
|
|
1878
1919
|
* Identifies the input/output type.
|
|
1879
1920
|
* @export
|
|
@@ -1907,47 +1948,12 @@ export interface IOFloatValue {
|
|
|
1907
1948
|
* @type {string}
|
|
1908
1949
|
* @memberof IOFloatValue
|
|
1909
1950
|
*/
|
|
1910
|
-
'
|
|
1951
|
+
'value_type'?: IOFloatValueValueTypeEnum;
|
|
1911
1952
|
}
|
|
1912
|
-
export declare const
|
|
1913
|
-
readonly
|
|
1953
|
+
export declare const IOFloatValueValueTypeEnum: {
|
|
1954
|
+
readonly Float: "float";
|
|
1914
1955
|
};
|
|
1915
|
-
export type
|
|
1916
|
-
/**
|
|
1917
|
-
*
|
|
1918
|
-
* @export
|
|
1919
|
-
* @interface IOFloatValue2
|
|
1920
|
-
*/
|
|
1921
|
-
export interface IOFloatValue2 {
|
|
1922
|
-
/**
|
|
1923
|
-
*
|
|
1924
|
-
* @type {string}
|
|
1925
|
-
* @memberof IOFloatValue2
|
|
1926
|
-
*/
|
|
1927
|
-
'io': string;
|
|
1928
|
-
/**
|
|
1929
|
-
*
|
|
1930
|
-
* @type {IODirection}
|
|
1931
|
-
* @memberof IOFloatValue2
|
|
1932
|
-
*/
|
|
1933
|
-
'direction': IODirection;
|
|
1934
|
-
/**
|
|
1935
|
-
*
|
|
1936
|
-
* @type {number}
|
|
1937
|
-
* @memberof IOFloatValue2
|
|
1938
|
-
*/
|
|
1939
|
-
'float_value': number;
|
|
1940
|
-
/**
|
|
1941
|
-
*
|
|
1942
|
-
* @type {string}
|
|
1943
|
-
* @memberof IOFloatValue2
|
|
1944
|
-
*/
|
|
1945
|
-
'io_value_type'?: IOFloatValue2IoValueTypeEnum;
|
|
1946
|
-
}
|
|
1947
|
-
export declare const IOFloatValue2IoValueTypeEnum: {
|
|
1948
|
-
readonly IoFloatValue: "IOFloatValue";
|
|
1949
|
-
};
|
|
1950
|
-
export type IOFloatValue2IoValueTypeEnum = typeof IOFloatValue2IoValueTypeEnum[keyof typeof IOFloatValue2IoValueTypeEnum];
|
|
1956
|
+
export type IOFloatValueValueTypeEnum = typeof IOFloatValueValueTypeEnum[keyof typeof IOFloatValueValueTypeEnum];
|
|
1951
1957
|
/**
|
|
1952
1958
|
* Input/Output integer value representation.
|
|
1953
1959
|
* @export
|
|
@@ -1971,78 +1977,12 @@ export interface IOIntegerValue {
|
|
|
1971
1977
|
* @type {string}
|
|
1972
1978
|
* @memberof IOIntegerValue
|
|
1973
1979
|
*/
|
|
1974
|
-
'
|
|
1980
|
+
'value_type'?: IOIntegerValueValueTypeEnum;
|
|
1975
1981
|
}
|
|
1976
|
-
export declare const
|
|
1977
|
-
readonly
|
|
1982
|
+
export declare const IOIntegerValueValueTypeEnum: {
|
|
1983
|
+
readonly Integer: "integer";
|
|
1978
1984
|
};
|
|
1979
|
-
export type
|
|
1980
|
-
/**
|
|
1981
|
-
*
|
|
1982
|
-
* @export
|
|
1983
|
-
* @interface IOIntegerValue2
|
|
1984
|
-
*/
|
|
1985
|
-
export interface IOIntegerValue2 {
|
|
1986
|
-
/**
|
|
1987
|
-
*
|
|
1988
|
-
* @type {string}
|
|
1989
|
-
* @memberof IOIntegerValue2
|
|
1990
|
-
*/
|
|
1991
|
-
'io': string;
|
|
1992
|
-
/**
|
|
1993
|
-
*
|
|
1994
|
-
* @type {IODirection}
|
|
1995
|
-
* @memberof IOIntegerValue2
|
|
1996
|
-
*/
|
|
1997
|
-
'direction': IODirection;
|
|
1998
|
-
/**
|
|
1999
|
-
*
|
|
2000
|
-
* @type {string}
|
|
2001
|
-
* @memberof IOIntegerValue2
|
|
2002
|
-
*/
|
|
2003
|
-
'integer_value': string;
|
|
2004
|
-
/**
|
|
2005
|
-
*
|
|
2006
|
-
* @type {string}
|
|
2007
|
-
* @memberof IOIntegerValue2
|
|
2008
|
-
*/
|
|
2009
|
-
'io_value_type'?: IOIntegerValue2IoValueTypeEnum;
|
|
2010
|
-
}
|
|
2011
|
-
export declare const IOIntegerValue2IoValueTypeEnum: {
|
|
2012
|
-
readonly IoIntegerValue: "IOIntegerValue";
|
|
2013
|
-
};
|
|
2014
|
-
export type IOIntegerValue2IoValueTypeEnum = typeof IOIntegerValue2IoValueTypeEnum[keyof typeof IOIntegerValue2IoValueTypeEnum];
|
|
2015
|
-
/**
|
|
2016
|
-
* Input/Output value representation. Depending on the input/output type, only one of the value fields will be set.
|
|
2017
|
-
* @export
|
|
2018
|
-
* @interface IOValue
|
|
2019
|
-
*/
|
|
2020
|
-
export interface IOValue {
|
|
2021
|
-
/**
|
|
2022
|
-
* Unique identifier of the input/output.
|
|
2023
|
-
* @type {string}
|
|
2024
|
-
* @memberof IOValue
|
|
2025
|
-
*/
|
|
2026
|
-
'io': string;
|
|
2027
|
-
/**
|
|
2028
|
-
* Value of a digital input/output. This field is only set if the input/output is of type IO_VALUE_BOOLEAN.
|
|
2029
|
-
* @type {boolean}
|
|
2030
|
-
* @memberof IOValue
|
|
2031
|
-
*/
|
|
2032
|
-
'boolean_value'?: boolean;
|
|
2033
|
-
/**
|
|
2034
|
-
* Value of an analog input/output in integer representation. This field is only set if the input/output is of type IO_VALUE_ANALOG_INTEGER. > The integral value is transmitted as a string to avoid precision loss during conversion to JSON. > We recommend to use int64 in your implementation. If you want to interact with int64 in numbers, > there are some JS bigint libraries available to parse the string into an integral value.
|
|
2035
|
-
* @type {string}
|
|
2036
|
-
* @memberof IOValue
|
|
2037
|
-
*/
|
|
2038
|
-
'integer_value'?: string;
|
|
2039
|
-
/**
|
|
2040
|
-
* Value of an analog input/output in floating number representation. This field is only set if the input/output is of type IO_VALUE_ANALOG_FLOATING.
|
|
2041
|
-
* @type {number}
|
|
2042
|
-
* @memberof IOValue
|
|
2043
|
-
*/
|
|
2044
|
-
'float_value'?: number;
|
|
2045
|
-
}
|
|
1985
|
+
export type IOIntegerValueValueTypeEnum = typeof IOIntegerValueValueTypeEnum[keyof typeof IOIntegerValueValueTypeEnum];
|
|
2046
1986
|
/**
|
|
2047
1987
|
* Data type of the input/output.
|
|
2048
1988
|
* @export
|
|
@@ -2054,66 +1994,6 @@ export declare const IOValueType: {
|
|
|
2054
1994
|
readonly IoValueAnalogInteger: "IO_VALUE_ANALOG_INTEGER";
|
|
2055
1995
|
};
|
|
2056
1996
|
export type IOValueType = typeof IOValueType[keyof typeof IOValueType];
|
|
2057
|
-
/**
|
|
2058
|
-
*
|
|
2059
|
-
* @export
|
|
2060
|
-
* @interface IOs
|
|
2061
|
-
*/
|
|
2062
|
-
export interface IOs {
|
|
2063
|
-
/**
|
|
2064
|
-
*
|
|
2065
|
-
* @type {Array<IOsIosInner>}
|
|
2066
|
-
* @memberof IOs
|
|
2067
|
-
*/
|
|
2068
|
-
'ios': Array<IOsIosInner>;
|
|
2069
|
-
}
|
|
2070
|
-
/**
|
|
2071
|
-
*
|
|
2072
|
-
* @export
|
|
2073
|
-
* @interface IOsIosInner
|
|
2074
|
-
*/
|
|
2075
|
-
export interface IOsIosInner {
|
|
2076
|
-
/**
|
|
2077
|
-
*
|
|
2078
|
-
* @type {string}
|
|
2079
|
-
* @memberof IOsIosInner
|
|
2080
|
-
*/
|
|
2081
|
-
'io': string;
|
|
2082
|
-
/**
|
|
2083
|
-
*
|
|
2084
|
-
* @type {IODirection}
|
|
2085
|
-
* @memberof IOsIosInner
|
|
2086
|
-
*/
|
|
2087
|
-
'direction': IODirection;
|
|
2088
|
-
/**
|
|
2089
|
-
*
|
|
2090
|
-
* @type {string}
|
|
2091
|
-
* @memberof IOsIosInner
|
|
2092
|
-
*/
|
|
2093
|
-
'integer_value': string;
|
|
2094
|
-
/**
|
|
2095
|
-
*
|
|
2096
|
-
* @type {string}
|
|
2097
|
-
* @memberof IOsIosInner
|
|
2098
|
-
*/
|
|
2099
|
-
'io_value_type'?: IOsIosInnerIoValueTypeEnum;
|
|
2100
|
-
/**
|
|
2101
|
-
*
|
|
2102
|
-
* @type {boolean}
|
|
2103
|
-
* @memberof IOsIosInner
|
|
2104
|
-
*/
|
|
2105
|
-
'boolean_value': boolean;
|
|
2106
|
-
/**
|
|
2107
|
-
*
|
|
2108
|
-
* @type {number}
|
|
2109
|
-
* @memberof IOsIosInner
|
|
2110
|
-
*/
|
|
2111
|
-
'float_value': number;
|
|
2112
|
-
}
|
|
2113
|
-
export declare const IOsIosInnerIoValueTypeEnum: {
|
|
2114
|
-
readonly IoFloatValue: "IOFloatValue";
|
|
2115
|
-
};
|
|
2116
|
-
export type IOsIosInnerIoValueTypeEnum = typeof IOsIosInnerIoValueTypeEnum[keyof typeof IOsIosInnerIoValueTypeEnum];
|
|
2117
1997
|
/**
|
|
2118
1998
|
* User provided credentials for creating a secret to pull an image from a registry.
|
|
2119
1999
|
* @export
|
|
@@ -2389,18 +2269,28 @@ export interface InitializeMovementResponseInitResponse {
|
|
|
2389
2269
|
'error_message'?: string;
|
|
2390
2270
|
}
|
|
2391
2271
|
/**
|
|
2392
|
-
*
|
|
2272
|
+
* Value of an analog input/output with integer representation. > The integral value is transmitted as a string to avoid precision loss during conversion to JSON. > We recommend to use int64 in your implementation. If you want to interact with int64 in numbers, > there are some JS bigint libraries available to parse the string into an integral value.
|
|
2393
2273
|
* @export
|
|
2394
2274
|
* @interface IntegerValue
|
|
2395
2275
|
*/
|
|
2396
2276
|
export interface IntegerValue {
|
|
2397
2277
|
/**
|
|
2398
|
-
*
|
|
2278
|
+
*
|
|
2399
2279
|
* @type {string}
|
|
2400
2280
|
* @memberof IntegerValue
|
|
2401
2281
|
*/
|
|
2402
2282
|
'integer_value': string;
|
|
2283
|
+
/**
|
|
2284
|
+
*
|
|
2285
|
+
* @type {string}
|
|
2286
|
+
* @memberof IntegerValue
|
|
2287
|
+
*/
|
|
2288
|
+
'value_type'?: IntegerValueValueTypeEnum;
|
|
2403
2289
|
}
|
|
2290
|
+
export declare const IntegerValueValueTypeEnum: {
|
|
2291
|
+
readonly Integer: "integer";
|
|
2292
|
+
};
|
|
2293
|
+
export type IntegerValueValueTypeEnum = typeof IntegerValueValueTypeEnum[keyof typeof IntegerValueValueTypeEnum];
|
|
2404
2294
|
/**
|
|
2405
2295
|
*
|
|
2406
2296
|
* @export
|
|
@@ -3205,7 +3095,7 @@ export interface ModelError {
|
|
|
3205
3095
|
* @type {string}
|
|
3206
3096
|
* @memberof ModelError
|
|
3207
3097
|
*/
|
|
3208
|
-
'code'
|
|
3098
|
+
'code'?: string;
|
|
3209
3099
|
/**
|
|
3210
3100
|
*
|
|
3211
3101
|
* @type {string}
|
|
@@ -3250,7 +3140,7 @@ export type MotionCommandBlending = BlendingAuto | BlendingPosition;
|
|
|
3250
3140
|
*/
|
|
3251
3141
|
export type MotionCommandPath = PathCartesianPTP | PathCircle | PathCubicSpline | PathJointPTP | PathLine;
|
|
3252
3142
|
/**
|
|
3253
|
-
* The data type describes the physically connected motion groups on a robot controller, e.g
|
|
3143
|
+
* The data type describes the physically connected motion groups on a robot controller, e.g., a robot arm.
|
|
3254
3144
|
* @export
|
|
3255
3145
|
* @interface MotionGroup
|
|
3256
3146
|
*/
|
|
@@ -3274,11 +3164,17 @@ export interface MotionGroup {
|
|
|
3274
3164
|
*/
|
|
3275
3165
|
'name_from_controller': string;
|
|
3276
3166
|
/**
|
|
3277
|
-
* The robot controller model if available. Usable for frontend 3D visualization.
|
|
3167
|
+
* The robot controller model, if available. Usable for frontend 3D visualization.
|
|
3278
3168
|
* @type {string}
|
|
3279
3169
|
* @memberof MotionGroup
|
|
3280
3170
|
*/
|
|
3281
3171
|
'model_from_controller': string;
|
|
3172
|
+
/**
|
|
3173
|
+
* The serial number of the motion group, if available. If not available, the serial number of the robot controller. if available. If not available, then empty.
|
|
3174
|
+
* @type {string}
|
|
3175
|
+
* @memberof MotionGroup
|
|
3176
|
+
*/
|
|
3177
|
+
'serial_number'?: string;
|
|
3282
3178
|
}
|
|
3283
3179
|
/**
|
|
3284
3180
|
*
|
|
@@ -3519,11 +3415,17 @@ export interface MotionGroupPhysical {
|
|
|
3519
3415
|
*/
|
|
3520
3416
|
'active': boolean;
|
|
3521
3417
|
/**
|
|
3522
|
-
* The robot controller model if available. Usable for frontend 3D visualization.
|
|
3418
|
+
* The robot controller model, if available. Usable for frontend 3D visualization.
|
|
3523
3419
|
* @type {string}
|
|
3524
3420
|
* @memberof MotionGroupPhysical
|
|
3525
3421
|
*/
|
|
3526
3422
|
'model_from_controller'?: string;
|
|
3423
|
+
/**
|
|
3424
|
+
* The serial number of the motion group, if available. If not available, the serial number of the robot controller. if available. If not available, the response is empty.
|
|
3425
|
+
* @type {string}
|
|
3426
|
+
* @memberof MotionGroupPhysical
|
|
3427
|
+
*/
|
|
3428
|
+
'serial_number'?: string;
|
|
3527
3429
|
}
|
|
3528
3430
|
/**
|
|
3529
3431
|
* Holding static properties of the motion group.
|
|
@@ -3582,10 +3484,10 @@ export interface MotionGroupState {
|
|
|
3582
3484
|
'joint_torque'?: Joints;
|
|
3583
3485
|
/**
|
|
3584
3486
|
* Current position of the Flange (last point of the motion group before the endeffector starts) in [mm]. The position is relative to the response_coordinate_system that is specified in the request. For robot arms a flange pose is always returned, for positioners the flange might not be available, depending on the model.
|
|
3585
|
-
* @type {
|
|
3487
|
+
* @type {PoseInCoordinateSystem}
|
|
3586
3488
|
* @memberof MotionGroupState
|
|
3587
3489
|
*/
|
|
3588
|
-
'flange_pose'?:
|
|
3490
|
+
'flange_pose'?: PoseInCoordinateSystem;
|
|
3589
3491
|
/**
|
|
3590
3492
|
* Current position of the TCP currently selected on the robot control panel. Attention: This TCP is not necessarily the same as specified as `tcp` in the request. If you need the information for the specified TCP, use the tcp_pose in the outer response. Position is in [mm]. The position is relative to the response_coordinate_system that is specified in the request.
|
|
3591
3493
|
* @type {TcpPose}
|
|
@@ -3682,10 +3584,10 @@ export interface Mounting {
|
|
|
3682
3584
|
'coordinate_system': string;
|
|
3683
3585
|
/**
|
|
3684
3586
|
* The pose offset based on world coordinate system of the mounting.
|
|
3685
|
-
* @type {
|
|
3587
|
+
* @type {PoseInCoordinateSystem}
|
|
3686
3588
|
* @memberof Mounting
|
|
3687
3589
|
*/
|
|
3688
|
-
'pose':
|
|
3590
|
+
'pose': PoseInCoordinateSystem;
|
|
3689
3591
|
}
|
|
3690
3592
|
/**
|
|
3691
3593
|
* @type MoveToTrajectoryViaJointPTPResponse
|
|
@@ -3827,6 +3729,16 @@ export interface OpcuaNodeValueTriggerConfig {
|
|
|
3827
3729
|
*/
|
|
3828
3730
|
export interface OpcuaNodeValueTriggerConfigNodeValue {
|
|
3829
3731
|
}
|
|
3732
|
+
/**
|
|
3733
|
+
* The operating state.
|
|
3734
|
+
* @export
|
|
3735
|
+
* @enum {string}
|
|
3736
|
+
*/
|
|
3737
|
+
export declare const OperatingState: {
|
|
3738
|
+
readonly Active: "ACTIVE";
|
|
3739
|
+
readonly Inactive: "INACTIVE";
|
|
3740
|
+
};
|
|
3741
|
+
export type OperatingState = typeof OperatingState[keyof typeof OperatingState];
|
|
3830
3742
|
/**
|
|
3831
3743
|
* Current operation mode of the configured robot controller. Operation modes in which the attached motion groups can be moved are: - OPERATION_MODE_MANUAL (if enabling switch is pressed) - OPERATION_MODE_MANUAL_T1 (if enabling switch is pressed) - OPERATION_MODE_MANUAL_T2 (if enabling switch is pressed) - OPERATION_MODE_AUTO (without needing to press enabling switch) All other modes are considered as non-operational.
|
|
3832
3744
|
* @export
|
|
@@ -3949,10 +3861,10 @@ export interface Path {
|
|
|
3949
3861
|
export interface PathCartesianPTP {
|
|
3950
3862
|
/**
|
|
3951
3863
|
*
|
|
3952
|
-
* @type {
|
|
3864
|
+
* @type {Pose}
|
|
3953
3865
|
* @memberof PathCartesianPTP
|
|
3954
3866
|
*/
|
|
3955
|
-
'target_pose':
|
|
3867
|
+
'target_pose': Pose;
|
|
3956
3868
|
/**
|
|
3957
3869
|
*
|
|
3958
3870
|
* @type {string}
|
|
@@ -3972,16 +3884,16 @@ export type PathCartesianPTPPathDefinitionNameEnum = typeof PathCartesianPTPPath
|
|
|
3972
3884
|
export interface PathCircle {
|
|
3973
3885
|
/**
|
|
3974
3886
|
*
|
|
3975
|
-
* @type {
|
|
3887
|
+
* @type {Pose}
|
|
3976
3888
|
* @memberof PathCircle
|
|
3977
3889
|
*/
|
|
3978
|
-
'via_pose':
|
|
3890
|
+
'via_pose': Pose;
|
|
3979
3891
|
/**
|
|
3980
3892
|
*
|
|
3981
|
-
* @type {
|
|
3893
|
+
* @type {Pose}
|
|
3982
3894
|
* @memberof PathCircle
|
|
3983
3895
|
*/
|
|
3984
|
-
'target_pose':
|
|
3896
|
+
'target_pose': Pose;
|
|
3985
3897
|
/**
|
|
3986
3898
|
*
|
|
3987
3899
|
* @type {string}
|
|
@@ -4047,10 +3959,10 @@ export type PathJointPTPPathDefinitionNameEnum = typeof PathJointPTPPathDefiniti
|
|
|
4047
3959
|
export interface PathLine {
|
|
4048
3960
|
/**
|
|
4049
3961
|
*
|
|
4050
|
-
* @type {
|
|
3962
|
+
* @type {Pose}
|
|
4051
3963
|
* @memberof PathLine
|
|
4052
3964
|
*/
|
|
4053
|
-
'target_pose':
|
|
3965
|
+
'target_pose': Pose;
|
|
4054
3966
|
/**
|
|
4055
3967
|
*
|
|
4056
3968
|
* @type {string}
|
|
@@ -4125,12 +4037,12 @@ export interface PauseMovementResponsePauseResponse {
|
|
|
4125
4037
|
export interface PauseOnIO {
|
|
4126
4038
|
/**
|
|
4127
4039
|
*
|
|
4128
|
-
* @type {
|
|
4040
|
+
* @type {SetOutputValuesRequestInner}
|
|
4129
4041
|
* @memberof PauseOnIO
|
|
4130
4042
|
*/
|
|
4131
|
-
'io':
|
|
4043
|
+
'io': SetOutputValuesRequestInner;
|
|
4132
4044
|
/**
|
|
4133
|
-
* Comparator for the comparison of two values.
|
|
4045
|
+
* Comparator for the comparison of two values. Use the measured I/O as the base value (a) and the expected input/output value as the comparator (b): e.g., a > b.
|
|
4134
4046
|
* @type {Comparator}
|
|
4135
4047
|
* @memberof PauseOnIO
|
|
4136
4048
|
*/
|
|
@@ -4451,7 +4363,7 @@ export interface PointCloud {
|
|
|
4451
4363
|
'pointcloud': string;
|
|
4452
4364
|
}
|
|
4453
4365
|
/**
|
|
4454
|
-
*
|
|
4366
|
+
* Defines a pose in 3D space. A pose is a combination of a position and an orientation. The position is applied before the orientation.
|
|
4455
4367
|
* @export
|
|
4456
4368
|
* @interface Pose
|
|
4457
4369
|
*/
|
|
@@ -4461,38 +4373,38 @@ export interface Pose {
|
|
|
4461
4373
|
* @type {Array<number>}
|
|
4462
4374
|
* @memberof Pose
|
|
4463
4375
|
*/
|
|
4464
|
-
'position'
|
|
4376
|
+
'position'?: Array<number>;
|
|
4465
4377
|
/**
|
|
4466
|
-
* A three-dimensional
|
|
4378
|
+
* Defines a rotation in 3D space. A three-dimensional Vector [rx, ry, rz] with double precision. Rotation is applied around the vector. The angle of rotation equals the length of the vector.
|
|
4467
4379
|
* @type {Array<number>}
|
|
4468
4380
|
* @memberof Pose
|
|
4469
4381
|
*/
|
|
4470
4382
|
'orientation'?: Array<number>;
|
|
4471
|
-
/**
|
|
4472
|
-
* Unique identifier addressing the reference coordinate system of the pose. Default is the world coordinate system.
|
|
4473
|
-
* @type {string}
|
|
4474
|
-
* @memberof Pose
|
|
4475
|
-
*/
|
|
4476
|
-
'coordinate_system'?: string;
|
|
4477
4383
|
}
|
|
4478
4384
|
/**
|
|
4479
|
-
*
|
|
4385
|
+
* Representing a pose in space with its origin in `coordinate_system`. A pose consists of positional coordinates [x, y, z] in millimeters (mm) and orientational coordinates in axis-angle representation [rx, ry, rz] in radian (rad).
|
|
4480
4386
|
* @export
|
|
4481
|
-
* @interface
|
|
4387
|
+
* @interface PoseInCoordinateSystem
|
|
4482
4388
|
*/
|
|
4483
|
-
export interface
|
|
4389
|
+
export interface PoseInCoordinateSystem {
|
|
4484
4390
|
/**
|
|
4485
4391
|
* A three-dimensional vector [x, y, z] with double precision.
|
|
4486
4392
|
* @type {Array<number>}
|
|
4487
|
-
* @memberof
|
|
4393
|
+
* @memberof PoseInCoordinateSystem
|
|
4488
4394
|
*/
|
|
4489
|
-
'position'
|
|
4395
|
+
'position': Array<number>;
|
|
4490
4396
|
/**
|
|
4491
4397
|
* Defines a rotation in 3D space. A three-dimensional Vector [rx, ry, rz] with double precision. Rotation is applied around the vector. The angle of rotation equals the length of the vector.
|
|
4492
4398
|
* @type {Array<number>}
|
|
4493
|
-
* @memberof
|
|
4399
|
+
* @memberof PoseInCoordinateSystem
|
|
4494
4400
|
*/
|
|
4495
4401
|
'orientation'?: Array<number>;
|
|
4402
|
+
/**
|
|
4403
|
+
* Unique identifier addressing the reference coordinate system of the pose. Default is the world coordinate system.
|
|
4404
|
+
* @type {string}
|
|
4405
|
+
* @memberof PoseInCoordinateSystem
|
|
4406
|
+
*/
|
|
4407
|
+
'coordinate_system'?: string;
|
|
4496
4408
|
}
|
|
4497
4409
|
/**
|
|
4498
4410
|
* The metadata of a program.
|
|
@@ -5305,6 +5217,25 @@ export declare const ServiceStatusPhase: {
|
|
|
5305
5217
|
readonly Evicted: "Evicted";
|
|
5306
5218
|
};
|
|
5307
5219
|
export type ServiceStatusPhase = typeof ServiceStatusPhase[keyof typeof ServiceStatusPhase];
|
|
5220
|
+
/**
|
|
5221
|
+
* Response containing both the overall operating state of the cell and detailed status information for each service within the cell. The operating state indicates whether the cell is active or inactive, while the service statuses provide specific health and operational information for individual service running in the cell.
|
|
5222
|
+
* @export
|
|
5223
|
+
* @interface ServiceStatusResponse
|
|
5224
|
+
*/
|
|
5225
|
+
export interface ServiceStatusResponse {
|
|
5226
|
+
/**
|
|
5227
|
+
*
|
|
5228
|
+
* @type {OperatingState}
|
|
5229
|
+
* @memberof ServiceStatusResponse
|
|
5230
|
+
*/
|
|
5231
|
+
'operating_state': OperatingState;
|
|
5232
|
+
/**
|
|
5233
|
+
*
|
|
5234
|
+
* @type {Array<ServiceStatus>}
|
|
5235
|
+
* @memberof ServiceStatusResponse
|
|
5236
|
+
*/
|
|
5237
|
+
'service_status': Array<ServiceStatus>;
|
|
5238
|
+
}
|
|
5308
5239
|
/**
|
|
5309
5240
|
*
|
|
5310
5241
|
* @export
|
|
@@ -5341,35 +5272,22 @@ export interface ServiceStatusStatus {
|
|
|
5341
5272
|
*/
|
|
5342
5273
|
'reason'?: string;
|
|
5343
5274
|
}
|
|
5344
|
-
/**
|
|
5345
|
-
* Defines an input/output that should be set upon reaching a certain location on the trajectory.
|
|
5346
|
-
* @export
|
|
5347
|
-
* @interface SetIO
|
|
5348
|
-
*/
|
|
5349
|
-
export interface SetIO {
|
|
5350
|
-
/**
|
|
5351
|
-
*
|
|
5352
|
-
* @type {IOValue}
|
|
5353
|
-
* @memberof SetIO
|
|
5354
|
-
*/
|
|
5355
|
-
'io': IOValue;
|
|
5356
|
-
/**
|
|
5357
|
-
* The location on the trajectory where the input/output should be set.
|
|
5358
|
-
* @type {number}
|
|
5359
|
-
* @memberof SetIO
|
|
5360
|
-
*/
|
|
5361
|
-
'location': number;
|
|
5362
|
-
}
|
|
5363
5275
|
/**
|
|
5364
5276
|
* @type SetIOValuesRequestInner
|
|
5365
5277
|
* @export
|
|
5366
5278
|
*/
|
|
5367
|
-
export type SetIOValuesRequestInner =
|
|
5279
|
+
export type SetIOValuesRequestInner = IOBooleanValue | IOFloatValue | IOIntegerValue;
|
|
5368
5280
|
/**
|
|
5369
5281
|
* @type SetOutputValuesRequestInner
|
|
5370
5282
|
* @export
|
|
5371
5283
|
*/
|
|
5372
|
-
export type SetOutputValuesRequestInner =
|
|
5284
|
+
export type SetOutputValuesRequestInner = {
|
|
5285
|
+
value_type: 'boolean';
|
|
5286
|
+
} & IOBooleanValue | {
|
|
5287
|
+
value_type: 'float';
|
|
5288
|
+
} & IOFloatValue | {
|
|
5289
|
+
value_type: 'integer';
|
|
5290
|
+
} & IOIntegerValue;
|
|
5373
5291
|
/**
|
|
5374
5292
|
*
|
|
5375
5293
|
* @export
|
|
@@ -5516,10 +5434,10 @@ export interface StartMovementRequest {
|
|
|
5516
5434
|
'direction': Direction;
|
|
5517
5435
|
/**
|
|
5518
5436
|
* Attaches a list of input/output commands to the trajectory. The inputs/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 input/output is not set.
|
|
5519
|
-
* @type {Array<
|
|
5437
|
+
* @type {Array<SetOutputValuesRequestInner>}
|
|
5520
5438
|
* @memberof StartMovementRequest
|
|
5521
5439
|
*/
|
|
5522
|
-
'set_ios'?: Array<
|
|
5440
|
+
'set_ios'?: Array<SetOutputValuesRequestInner>;
|
|
5523
5441
|
/**
|
|
5524
5442
|
* Defines an input/output that is listened to before the movement. Execution starts if the defined comparator evaluates to `true`.
|
|
5525
5443
|
* @type {StartOnIO}
|
|
@@ -5545,12 +5463,12 @@ export type StartMovementRequestMessageTypeEnum = typeof StartMovementRequestMes
|
|
|
5545
5463
|
export interface StartOnIO {
|
|
5546
5464
|
/**
|
|
5547
5465
|
*
|
|
5548
|
-
* @type {
|
|
5466
|
+
* @type {SetOutputValuesRequestInner}
|
|
5549
5467
|
* @memberof StartOnIO
|
|
5550
5468
|
*/
|
|
5551
|
-
'io':
|
|
5469
|
+
'io': SetOutputValuesRequestInner;
|
|
5552
5470
|
/**
|
|
5553
|
-
* Comparator for the comparison of two values.
|
|
5471
|
+
* Comparator for the comparison of two values. Use the measured I/O as the base value (a) and the expected input/output value as the comparator (b): e.g., a > b.
|
|
5554
5472
|
* @type {Comparator}
|
|
5555
5473
|
* @memberof StartOnIO
|
|
5556
5474
|
*/
|
|
@@ -6221,6 +6139,25 @@ export interface VirtualRobotConfiguration {
|
|
|
6221
6139
|
*/
|
|
6222
6140
|
'content': string;
|
|
6223
6141
|
}
|
|
6142
|
+
/**
|
|
6143
|
+
* The value to compare with the current value of the input/output.
|
|
6144
|
+
* @export
|
|
6145
|
+
* @interface WaitForIOEventRequest
|
|
6146
|
+
*/
|
|
6147
|
+
export interface WaitForIOEventRequest {
|
|
6148
|
+
/**
|
|
6149
|
+
*
|
|
6150
|
+
* @type {SetOutputValuesRequestInner}
|
|
6151
|
+
* @memberof WaitForIOEventRequest
|
|
6152
|
+
*/
|
|
6153
|
+
'io': SetOutputValuesRequestInner;
|
|
6154
|
+
/**
|
|
6155
|
+
* Comparator for the comparison of two values. Use the measured I/O as the base value (a) and the expected input/output value as the comparator (b): e.g., a > b.
|
|
6156
|
+
* @type {Comparator}
|
|
6157
|
+
* @memberof WaitForIOEventRequest
|
|
6158
|
+
*/
|
|
6159
|
+
'comparator': Comparator;
|
|
6160
|
+
}
|
|
6224
6161
|
/**
|
|
6225
6162
|
* The configuration of a physical Yaskawa robot controller has to contain IP address of the controller.
|
|
6226
6163
|
* @export
|
|
@@ -6550,6 +6487,15 @@ export declare const CellApiAxiosParamCreator: (configuration?: Configuration) =
|
|
|
6550
6487
|
* @throws {RequiredError}
|
|
6551
6488
|
*/
|
|
6552
6489
|
listCells: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
6490
|
+
/**
|
|
6491
|
+
* Deactivate or activate the services of a cell.
|
|
6492
|
+
* @summary Operating State
|
|
6493
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
6494
|
+
* @param {OperatingState} operatingState Set state of the cell. Active or inactive.
|
|
6495
|
+
* @param {*} [options] Override http request option.
|
|
6496
|
+
* @throws {RequiredError}
|
|
6497
|
+
*/
|
|
6498
|
+
setCellStatus: (cell: string, operatingState: OperatingState, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
6553
6499
|
/**
|
|
6554
6500
|
* Update the definition of the entire Cell.
|
|
6555
6501
|
* @summary Update Configuration
|
|
@@ -6599,7 +6545,7 @@ export declare const CellApiFp: (configuration?: Configuration) => {
|
|
|
6599
6545
|
* @param {*} [options] Override http request option.
|
|
6600
6546
|
* @throws {RequiredError}
|
|
6601
6547
|
*/
|
|
6602
|
-
getCellStatus(cell: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<
|
|
6548
|
+
getCellStatus(cell: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ServiceStatusResponse>>;
|
|
6603
6549
|
/**
|
|
6604
6550
|
* List all deployed cell names. If no cells are deployed, an empty list is returned.
|
|
6605
6551
|
* @summary List Cells
|
|
@@ -6607,6 +6553,15 @@ export declare const CellApiFp: (configuration?: Configuration) => {
|
|
|
6607
6553
|
* @throws {RequiredError}
|
|
6608
6554
|
*/
|
|
6609
6555
|
listCells(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<string>>>;
|
|
6556
|
+
/**
|
|
6557
|
+
* Deactivate or activate the services of a cell.
|
|
6558
|
+
* @summary Operating State
|
|
6559
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
6560
|
+
* @param {OperatingState} operatingState Set state of the cell. Active or inactive.
|
|
6561
|
+
* @param {*} [options] Override http request option.
|
|
6562
|
+
* @throws {RequiredError}
|
|
6563
|
+
*/
|
|
6564
|
+
setCellStatus(cell: string, operatingState: OperatingState, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
6610
6565
|
/**
|
|
6611
6566
|
* Update the definition of the entire Cell.
|
|
6612
6567
|
* @summary Update Configuration
|
|
@@ -6656,7 +6611,7 @@ export declare const CellApiFactory: (configuration?: Configuration, basePath?:
|
|
|
6656
6611
|
* @param {*} [options] Override http request option.
|
|
6657
6612
|
* @throws {RequiredError}
|
|
6658
6613
|
*/
|
|
6659
|
-
getCellStatus(cell: string, options?: RawAxiosRequestConfig): AxiosPromise<
|
|
6614
|
+
getCellStatus(cell: string, options?: RawAxiosRequestConfig): AxiosPromise<ServiceStatusResponse>;
|
|
6660
6615
|
/**
|
|
6661
6616
|
* List all deployed cell names. If no cells are deployed, an empty list is returned.
|
|
6662
6617
|
* @summary List Cells
|
|
@@ -6664,6 +6619,15 @@ export declare const CellApiFactory: (configuration?: Configuration, basePath?:
|
|
|
6664
6619
|
* @throws {RequiredError}
|
|
6665
6620
|
*/
|
|
6666
6621
|
listCells(options?: RawAxiosRequestConfig): AxiosPromise<Array<string>>;
|
|
6622
|
+
/**
|
|
6623
|
+
* Deactivate or activate the services of a cell.
|
|
6624
|
+
* @summary Operating State
|
|
6625
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
6626
|
+
* @param {OperatingState} operatingState Set state of the cell. Active or inactive.
|
|
6627
|
+
* @param {*} [options] Override http request option.
|
|
6628
|
+
* @throws {RequiredError}
|
|
6629
|
+
*/
|
|
6630
|
+
setCellStatus(cell: string, operatingState: OperatingState, options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
6667
6631
|
/**
|
|
6668
6632
|
* Update the definition of the entire Cell.
|
|
6669
6633
|
* @summary Update Configuration
|
|
@@ -6719,7 +6683,7 @@ export declare class CellApi extends BaseAPI {
|
|
|
6719
6683
|
* @throws {RequiredError}
|
|
6720
6684
|
* @memberof CellApi
|
|
6721
6685
|
*/
|
|
6722
|
-
getCellStatus(cell: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<
|
|
6686
|
+
getCellStatus(cell: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ServiceStatusResponse, any>>;
|
|
6723
6687
|
/**
|
|
6724
6688
|
* List all deployed cell names. If no cells are deployed, an empty list is returned.
|
|
6725
6689
|
* @summary List Cells
|
|
@@ -6728,6 +6692,16 @@ export declare class CellApi extends BaseAPI {
|
|
|
6728
6692
|
* @memberof CellApi
|
|
6729
6693
|
*/
|
|
6730
6694
|
listCells(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<string[], any>>;
|
|
6695
|
+
/**
|
|
6696
|
+
* Deactivate or activate the services of a cell.
|
|
6697
|
+
* @summary Operating State
|
|
6698
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
6699
|
+
* @param {OperatingState} operatingState Set state of the cell. Active or inactive.
|
|
6700
|
+
* @param {*} [options] Override http request option.
|
|
6701
|
+
* @throws {RequiredError}
|
|
6702
|
+
* @memberof CellApi
|
|
6703
|
+
*/
|
|
6704
|
+
setCellStatus(cell: string, operatingState: OperatingState, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
6731
6705
|
/**
|
|
6732
6706
|
* Update the definition of the entire Cell.
|
|
6733
6707
|
* @summary Update Configuration
|
|
@@ -7361,15 +7335,11 @@ export declare const ControllerInputsOutputsApiAxiosParamCreator: (configuration
|
|
|
7361
7335
|
* @summary Wait For
|
|
7362
7336
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
7363
7337
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
7364
|
-
* @param {
|
|
7365
|
-
* @param {Comparator} comparisonType
|
|
7366
|
-
* @param {boolean} [booleanValue]
|
|
7367
|
-
* @param {string} [integerValue]
|
|
7368
|
-
* @param {number} [floatValue]
|
|
7338
|
+
* @param {WaitForIOEventRequest} waitForIOEventRequest
|
|
7369
7339
|
* @param {*} [options] Override http request option.
|
|
7370
7340
|
* @throws {RequiredError}
|
|
7371
7341
|
*/
|
|
7372
|
-
waitForIOEvent: (cell: string, controller: string,
|
|
7342
|
+
waitForIOEvent: (cell: string, controller: string, waitForIOEventRequest: WaitForIOEventRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
7373
7343
|
};
|
|
7374
7344
|
/**
|
|
7375
7345
|
* ControllerInputsOutputsApi - functional programming interface
|
|
@@ -7424,15 +7394,11 @@ export declare const ControllerInputsOutputsApiFp: (configuration?: Configuratio
|
|
|
7424
7394
|
* @summary Wait For
|
|
7425
7395
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
7426
7396
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
7427
|
-
* @param {
|
|
7428
|
-
* @param {Comparator} comparisonType
|
|
7429
|
-
* @param {boolean} [booleanValue]
|
|
7430
|
-
* @param {string} [integerValue]
|
|
7431
|
-
* @param {number} [floatValue]
|
|
7397
|
+
* @param {WaitForIOEventRequest} waitForIOEventRequest
|
|
7432
7398
|
* @param {*} [options] Override http request option.
|
|
7433
7399
|
* @throws {RequiredError}
|
|
7434
7400
|
*/
|
|
7435
|
-
waitForIOEvent(cell: string, controller: string,
|
|
7401
|
+
waitForIOEvent(cell: string, controller: string, waitForIOEventRequest: WaitForIOEventRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<boolean>>;
|
|
7436
7402
|
};
|
|
7437
7403
|
/**
|
|
7438
7404
|
* ControllerInputsOutputsApi - factory interface
|
|
@@ -7487,15 +7453,11 @@ export declare const ControllerInputsOutputsApiFactory: (configuration?: Configu
|
|
|
7487
7453
|
* @summary Wait For
|
|
7488
7454
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
7489
7455
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
7490
|
-
* @param {
|
|
7491
|
-
* @param {Comparator} comparisonType
|
|
7492
|
-
* @param {boolean} [booleanValue]
|
|
7493
|
-
* @param {string} [integerValue]
|
|
7494
|
-
* @param {number} [floatValue]
|
|
7456
|
+
* @param {WaitForIOEventRequest} waitForIOEventRequest
|
|
7495
7457
|
* @param {*} [options] Override http request option.
|
|
7496
7458
|
* @throws {RequiredError}
|
|
7497
7459
|
*/
|
|
7498
|
-
waitForIOEvent(cell: string, controller: string,
|
|
7460
|
+
waitForIOEvent(cell: string, controller: string, waitForIOEventRequest: WaitForIOEventRequest, options?: RawAxiosRequestConfig): AxiosPromise<boolean>;
|
|
7499
7461
|
};
|
|
7500
7462
|
/**
|
|
7501
7463
|
* ControllerInputsOutputsApi - object-oriented interface
|
|
@@ -7556,16 +7518,12 @@ export declare class ControllerInputsOutputsApi extends BaseAPI {
|
|
|
7556
7518
|
* @summary Wait For
|
|
7557
7519
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
7558
7520
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
7559
|
-
* @param {
|
|
7560
|
-
* @param {Comparator} comparisonType
|
|
7561
|
-
* @param {boolean} [booleanValue]
|
|
7562
|
-
* @param {string} [integerValue]
|
|
7563
|
-
* @param {number} [floatValue]
|
|
7521
|
+
* @param {WaitForIOEventRequest} waitForIOEventRequest
|
|
7564
7522
|
* @param {*} [options] Override http request option.
|
|
7565
7523
|
* @throws {RequiredError}
|
|
7566
7524
|
* @memberof ControllerInputsOutputsApi
|
|
7567
7525
|
*/
|
|
7568
|
-
waitForIOEvent(cell: string, controller: string,
|
|
7526
|
+
waitForIOEvent(cell: string, controller: string, waitForIOEventRequest: WaitForIOEventRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<boolean, any>>;
|
|
7569
7527
|
}
|
|
7570
7528
|
/**
|
|
7571
7529
|
* CoordinateSystemsApi - axios parameter creator
|
|
@@ -7596,11 +7554,11 @@ export declare const CoordinateSystemsApiAxiosParamCreator: (configuration?: Con
|
|
|
7596
7554
|
* @summary Transform
|
|
7597
7555
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
7598
7556
|
* @param {string} coordinateSystem Unique identifier addressing a coordinate system.
|
|
7599
|
-
* @param {
|
|
7557
|
+
* @param {PoseInCoordinateSystem} poseInCoordinateSystem
|
|
7600
7558
|
* @param {*} [options] Override http request option.
|
|
7601
7559
|
* @throws {RequiredError}
|
|
7602
7560
|
*/
|
|
7603
|
-
transformInCoordinateSystem: (cell: string, coordinateSystem: string,
|
|
7561
|
+
transformInCoordinateSystem: (cell: string, coordinateSystem: string, poseInCoordinateSystem: PoseInCoordinateSystem, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
7604
7562
|
};
|
|
7605
7563
|
/**
|
|
7606
7564
|
* CoordinateSystemsApi - functional programming interface
|
|
@@ -7631,11 +7589,11 @@ export declare const CoordinateSystemsApiFp: (configuration?: Configuration) =>
|
|
|
7631
7589
|
* @summary Transform
|
|
7632
7590
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
7633
7591
|
* @param {string} coordinateSystem Unique identifier addressing a coordinate system.
|
|
7634
|
-
* @param {
|
|
7592
|
+
* @param {PoseInCoordinateSystem} poseInCoordinateSystem
|
|
7635
7593
|
* @param {*} [options] Override http request option.
|
|
7636
7594
|
* @throws {RequiredError}
|
|
7637
7595
|
*/
|
|
7638
|
-
transformInCoordinateSystem(cell: string, coordinateSystem: string,
|
|
7596
|
+
transformInCoordinateSystem(cell: string, coordinateSystem: string, poseInCoordinateSystem: PoseInCoordinateSystem, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PoseInCoordinateSystem>>;
|
|
7639
7597
|
};
|
|
7640
7598
|
/**
|
|
7641
7599
|
* CoordinateSystemsApi - factory interface
|
|
@@ -7666,11 +7624,11 @@ export declare const CoordinateSystemsApiFactory: (configuration?: Configuration
|
|
|
7666
7624
|
* @summary Transform
|
|
7667
7625
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
7668
7626
|
* @param {string} coordinateSystem Unique identifier addressing a coordinate system.
|
|
7669
|
-
* @param {
|
|
7627
|
+
* @param {PoseInCoordinateSystem} poseInCoordinateSystem
|
|
7670
7628
|
* @param {*} [options] Override http request option.
|
|
7671
7629
|
* @throws {RequiredError}
|
|
7672
7630
|
*/
|
|
7673
|
-
transformInCoordinateSystem(cell: string, coordinateSystem: string,
|
|
7631
|
+
transformInCoordinateSystem(cell: string, coordinateSystem: string, poseInCoordinateSystem: PoseInCoordinateSystem, options?: RawAxiosRequestConfig): AxiosPromise<PoseInCoordinateSystem>;
|
|
7674
7632
|
};
|
|
7675
7633
|
/**
|
|
7676
7634
|
* CoordinateSystemsApi - object-oriented interface
|
|
@@ -7705,12 +7663,12 @@ export declare class CoordinateSystemsApi extends BaseAPI {
|
|
|
7705
7663
|
* @summary Transform
|
|
7706
7664
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
7707
7665
|
* @param {string} coordinateSystem Unique identifier addressing a coordinate system.
|
|
7708
|
-
* @param {
|
|
7666
|
+
* @param {PoseInCoordinateSystem} poseInCoordinateSystem
|
|
7709
7667
|
* @param {*} [options] Override http request option.
|
|
7710
7668
|
* @throws {RequiredError}
|
|
7711
7669
|
* @memberof CoordinateSystemsApi
|
|
7712
7670
|
*/
|
|
7713
|
-
transformInCoordinateSystem(cell: string, coordinateSystem: string,
|
|
7671
|
+
transformInCoordinateSystem(cell: string, coordinateSystem: string, poseInCoordinateSystem: PoseInCoordinateSystem, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<PoseInCoordinateSystem, any>>;
|
|
7714
7672
|
}
|
|
7715
7673
|
/**
|
|
7716
7674
|
* JoggingApi - axios parameter creator
|
|
@@ -8662,7 +8620,7 @@ export declare const MotionGroupKinematicsApiFp: (configuration?: Configuration)
|
|
|
8662
8620
|
* @param {*} [options] Override http request option.
|
|
8663
8621
|
* @throws {RequiredError}
|
|
8664
8622
|
*/
|
|
8665
|
-
calculateForwardKinematic(cell: string, motionGroup: string, tcpPoseRequest: TcpPoseRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<
|
|
8623
|
+
calculateForwardKinematic(cell: string, motionGroup: string, tcpPoseRequest: TcpPoseRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PoseInCoordinateSystem>>;
|
|
8666
8624
|
/**
|
|
8667
8625
|
* Calculate the joint positions the motion-group needs to apply for its TCP to be in a specified pose (Inverse Kinematic Solution). If multiple solutions are found, the one nearest to the given specified joint position is picked. * For all supported robot models, except the Fanuc CRX line, the returned joint position is guaranteed to have the same configuration (often referred to as ELBOW_UP, WRIST_DOWN, SHOULDER_RIGHT, f.e.) as the specified reference joint position. If the position limit of any single joint allows it to be in a range larger than 2 PI, the respective joint value in the result will be as close as possible to its reference value. * For the Fanuc CRX line the solution is selected to have the smallest distance measured by the norm of its difference to the reference joint position. The returned joint position is guaranteed to be within the joint limits and not in a singular position of the robot.
|
|
8668
8626
|
* @summary Nearest Joint Position from TCP Pose
|
|
@@ -8707,7 +8665,7 @@ export declare const MotionGroupKinematicsApiFactory: (configuration?: Configura
|
|
|
8707
8665
|
* @param {*} [options] Override http request option.
|
|
8708
8666
|
* @throws {RequiredError}
|
|
8709
8667
|
*/
|
|
8710
|
-
calculateForwardKinematic(cell: string, motionGroup: string, tcpPoseRequest: TcpPoseRequest, options?: RawAxiosRequestConfig): AxiosPromise<
|
|
8668
|
+
calculateForwardKinematic(cell: string, motionGroup: string, tcpPoseRequest: TcpPoseRequest, options?: RawAxiosRequestConfig): AxiosPromise<PoseInCoordinateSystem>;
|
|
8711
8669
|
/**
|
|
8712
8670
|
* Calculate the joint positions the motion-group needs to apply for its TCP to be in a specified pose (Inverse Kinematic Solution). If multiple solutions are found, the one nearest to the given specified joint position is picked. * For all supported robot models, except the Fanuc CRX line, the returned joint position is guaranteed to have the same configuration (often referred to as ELBOW_UP, WRIST_DOWN, SHOULDER_RIGHT, f.e.) as the specified reference joint position. If the position limit of any single joint allows it to be in a range larger than 2 PI, the respective joint value in the result will be as close as possible to its reference value. * For the Fanuc CRX line the solution is selected to have the smallest distance measured by the norm of its difference to the reference joint position. The returned joint position is guaranteed to be within the joint limits and not in a singular position of the robot.
|
|
8713
8671
|
* @summary Nearest Joint Position from TCP Pose
|
|
@@ -8756,7 +8714,7 @@ export declare class MotionGroupKinematicsApi extends BaseAPI {
|
|
|
8756
8714
|
* @throws {RequiredError}
|
|
8757
8715
|
* @memberof MotionGroupKinematicsApi
|
|
8758
8716
|
*/
|
|
8759
|
-
calculateForwardKinematic(cell: string, motionGroup: string, tcpPoseRequest: TcpPoseRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<
|
|
8717
|
+
calculateForwardKinematic(cell: string, motionGroup: string, tcpPoseRequest: TcpPoseRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<PoseInCoordinateSystem, any>>;
|
|
8760
8718
|
/**
|
|
8761
8719
|
* Calculate the joint positions the motion-group needs to apply for its TCP to be in a specified pose (Inverse Kinematic Solution). If multiple solutions are found, the one nearest to the given specified joint position is picked. * For all supported robot models, except the Fanuc CRX line, the returned joint position is guaranteed to have the same configuration (often referred to as ELBOW_UP, WRIST_DOWN, SHOULDER_RIGHT, f.e.) as the specified reference joint position. If the position limit of any single joint allows it to be in a range larger than 2 PI, the respective joint value in the result will be as close as possible to its reference value. * For the Fanuc CRX line the solution is selected to have the smallest distance measured by the norm of its difference to the reference joint position. The returned joint position is guaranteed to be within the joint limits and not in a singular position of the robot.
|
|
8762
8720
|
* @summary Nearest Joint Position from TCP Pose
|
|
@@ -10844,6 +10802,17 @@ export declare class StoreObjectApi extends BaseAPI {
|
|
|
10844
10802
|
* @export
|
|
10845
10803
|
*/
|
|
10846
10804
|
export declare const SystemApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
10805
|
+
/**
|
|
10806
|
+
* Retrieves a configuration backup based on provided resource identifiers.
|
|
10807
|
+
* @summary Retrieve Configuration Backup
|
|
10808
|
+
* @param {Array<string>} resources List of resource identifiers to included in the backup and restore operations.
|
|
10809
|
+
* @param {{ [key: string]: string; }} [metadata] Additional metadata to add to the backup
|
|
10810
|
+
* @param {*} [options] Override http request option.
|
|
10811
|
+
* @throws {RequiredError}
|
|
10812
|
+
*/
|
|
10813
|
+
backupConfiguration: (resources: Array<string>, metadata?: {
|
|
10814
|
+
[key: string]: string;
|
|
10815
|
+
}, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
10847
10816
|
/**
|
|
10848
10817
|
* Check if a more recent Wandelbots NOVA Version is available.
|
|
10849
10818
|
* @summary Check update
|
|
@@ -10873,6 +10842,22 @@ export declare const SystemApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
10873
10842
|
* @throws {RequiredError}
|
|
10874
10843
|
*/
|
|
10875
10844
|
getSystemVersion: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
10845
|
+
/**
|
|
10846
|
+
* Retrieves a list of all available configuration resources for backup purposes.
|
|
10847
|
+
* @summary List Configuration Resources
|
|
10848
|
+
* @param {*} [options] Override http request option.
|
|
10849
|
+
* @throws {RequiredError}
|
|
10850
|
+
*/
|
|
10851
|
+
listConfigurationResources: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
10852
|
+
/**
|
|
10853
|
+
* Restores a previously backed up configuration.
|
|
10854
|
+
* @summary Restore Configuration Backup
|
|
10855
|
+
* @param {Array<string>} resources List of resource identifiers to included in the backup and restore operations.
|
|
10856
|
+
* @param {File} body Backup file stream containing the configuration to restore.
|
|
10857
|
+
* @param {*} [options] Override http request option.
|
|
10858
|
+
* @throws {RequiredError}
|
|
10859
|
+
*/
|
|
10860
|
+
restoreConfiguration: (resources: Array<string>, body: File, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
10876
10861
|
/**
|
|
10877
10862
|
* Update the Wandelbots NOVA version and all attached services. Sending this API Request will trigger an update of all NOVA services that are part of a cell. Previous cells and cell configurations will remain on the instance. If the update fails, the previous Wandelbots NOVA version is restored.
|
|
10878
10863
|
* @summary Update Wandelbots NOVA version
|
|
@@ -10887,6 +10872,17 @@ export declare const SystemApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
10887
10872
|
* @export
|
|
10888
10873
|
*/
|
|
10889
10874
|
export declare const SystemApiFp: (configuration?: Configuration) => {
|
|
10875
|
+
/**
|
|
10876
|
+
* Retrieves a configuration backup based on provided resource identifiers.
|
|
10877
|
+
* @summary Retrieve Configuration Backup
|
|
10878
|
+
* @param {Array<string>} resources List of resource identifiers to included in the backup and restore operations.
|
|
10879
|
+
* @param {{ [key: string]: string; }} [metadata] Additional metadata to add to the backup
|
|
10880
|
+
* @param {*} [options] Override http request option.
|
|
10881
|
+
* @throws {RequiredError}
|
|
10882
|
+
*/
|
|
10883
|
+
backupConfiguration(resources: Array<string>, metadata?: {
|
|
10884
|
+
[key: string]: string;
|
|
10885
|
+
}, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<File>>;
|
|
10890
10886
|
/**
|
|
10891
10887
|
* Check if a more recent Wandelbots NOVA Version is available.
|
|
10892
10888
|
* @summary Check update
|
|
@@ -10916,6 +10912,22 @@ export declare const SystemApiFp: (configuration?: Configuration) => {
|
|
|
10916
10912
|
* @throws {RequiredError}
|
|
10917
10913
|
*/
|
|
10918
10914
|
getSystemVersion(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<string>>;
|
|
10915
|
+
/**
|
|
10916
|
+
* Retrieves a list of all available configuration resources for backup purposes.
|
|
10917
|
+
* @summary List Configuration Resources
|
|
10918
|
+
* @param {*} [options] Override http request option.
|
|
10919
|
+
* @throws {RequiredError}
|
|
10920
|
+
*/
|
|
10921
|
+
listConfigurationResources(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<ConfigurationResource>>>;
|
|
10922
|
+
/**
|
|
10923
|
+
* Restores a previously backed up configuration.
|
|
10924
|
+
* @summary Restore Configuration Backup
|
|
10925
|
+
* @param {Array<string>} resources List of resource identifiers to included in the backup and restore operations.
|
|
10926
|
+
* @param {File} body Backup file stream containing the configuration to restore.
|
|
10927
|
+
* @param {*} [options] Override http request option.
|
|
10928
|
+
* @throws {RequiredError}
|
|
10929
|
+
*/
|
|
10930
|
+
restoreConfiguration(resources: Array<string>, body: File, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
10919
10931
|
/**
|
|
10920
10932
|
* Update the Wandelbots NOVA version and all attached services. Sending this API Request will trigger an update of all NOVA services that are part of a cell. Previous cells and cell configurations will remain on the instance. If the update fails, the previous Wandelbots NOVA version is restored.
|
|
10921
10933
|
* @summary Update Wandelbots NOVA version
|
|
@@ -10930,6 +10942,17 @@ export declare const SystemApiFp: (configuration?: Configuration) => {
|
|
|
10930
10942
|
* @export
|
|
10931
10943
|
*/
|
|
10932
10944
|
export declare const SystemApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
10945
|
+
/**
|
|
10946
|
+
* Retrieves a configuration backup based on provided resource identifiers.
|
|
10947
|
+
* @summary Retrieve Configuration Backup
|
|
10948
|
+
* @param {Array<string>} resources List of resource identifiers to included in the backup and restore operations.
|
|
10949
|
+
* @param {{ [key: string]: string; }} [metadata] Additional metadata to add to the backup
|
|
10950
|
+
* @param {*} [options] Override http request option.
|
|
10951
|
+
* @throws {RequiredError}
|
|
10952
|
+
*/
|
|
10953
|
+
backupConfiguration(resources: Array<string>, metadata?: {
|
|
10954
|
+
[key: string]: string;
|
|
10955
|
+
}, options?: RawAxiosRequestConfig): AxiosPromise<File>;
|
|
10933
10956
|
/**
|
|
10934
10957
|
* Check if a more recent Wandelbots NOVA Version is available.
|
|
10935
10958
|
* @summary Check update
|
|
@@ -10959,6 +10982,22 @@ export declare const SystemApiFactory: (configuration?: Configuration, basePath?
|
|
|
10959
10982
|
* @throws {RequiredError}
|
|
10960
10983
|
*/
|
|
10961
10984
|
getSystemVersion(options?: RawAxiosRequestConfig): AxiosPromise<string>;
|
|
10985
|
+
/**
|
|
10986
|
+
* Retrieves a list of all available configuration resources for backup purposes.
|
|
10987
|
+
* @summary List Configuration Resources
|
|
10988
|
+
* @param {*} [options] Override http request option.
|
|
10989
|
+
* @throws {RequiredError}
|
|
10990
|
+
*/
|
|
10991
|
+
listConfigurationResources(options?: RawAxiosRequestConfig): AxiosPromise<Array<ConfigurationResource>>;
|
|
10992
|
+
/**
|
|
10993
|
+
* Restores a previously backed up configuration.
|
|
10994
|
+
* @summary Restore Configuration Backup
|
|
10995
|
+
* @param {Array<string>} resources List of resource identifiers to included in the backup and restore operations.
|
|
10996
|
+
* @param {File} body Backup file stream containing the configuration to restore.
|
|
10997
|
+
* @param {*} [options] Override http request option.
|
|
10998
|
+
* @throws {RequiredError}
|
|
10999
|
+
*/
|
|
11000
|
+
restoreConfiguration(resources: Array<string>, body: File, options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
10962
11001
|
/**
|
|
10963
11002
|
* Update the Wandelbots NOVA version and all attached services. Sending this API Request will trigger an update of all NOVA services that are part of a cell. Previous cells and cell configurations will remain on the instance. If the update fails, the previous Wandelbots NOVA version is restored.
|
|
10964
11003
|
* @summary Update Wandelbots NOVA version
|
|
@@ -10975,6 +11014,18 @@ export declare const SystemApiFactory: (configuration?: Configuration, basePath?
|
|
|
10975
11014
|
* @extends {BaseAPI}
|
|
10976
11015
|
*/
|
|
10977
11016
|
export declare class SystemApi extends BaseAPI {
|
|
11017
|
+
/**
|
|
11018
|
+
* Retrieves a configuration backup based on provided resource identifiers.
|
|
11019
|
+
* @summary Retrieve Configuration Backup
|
|
11020
|
+
* @param {Array<string>} resources List of resource identifiers to included in the backup and restore operations.
|
|
11021
|
+
* @param {{ [key: string]: string; }} [metadata] Additional metadata to add to the backup
|
|
11022
|
+
* @param {*} [options] Override http request option.
|
|
11023
|
+
* @throws {RequiredError}
|
|
11024
|
+
* @memberof SystemApi
|
|
11025
|
+
*/
|
|
11026
|
+
backupConfiguration(resources: Array<string>, metadata?: {
|
|
11027
|
+
[key: string]: string;
|
|
11028
|
+
}, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<File, any>>;
|
|
10978
11029
|
/**
|
|
10979
11030
|
* Check if a more recent Wandelbots NOVA Version is available.
|
|
10980
11031
|
* @summary Check update
|
|
@@ -11008,6 +11059,24 @@ export declare class SystemApi extends BaseAPI {
|
|
|
11008
11059
|
* @memberof SystemApi
|
|
11009
11060
|
*/
|
|
11010
11061
|
getSystemVersion(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<string, any>>;
|
|
11062
|
+
/**
|
|
11063
|
+
* Retrieves a list of all available configuration resources for backup purposes.
|
|
11064
|
+
* @summary List Configuration Resources
|
|
11065
|
+
* @param {*} [options] Override http request option.
|
|
11066
|
+
* @throws {RequiredError}
|
|
11067
|
+
* @memberof SystemApi
|
|
11068
|
+
*/
|
|
11069
|
+
listConfigurationResources(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ConfigurationResource[], any>>;
|
|
11070
|
+
/**
|
|
11071
|
+
* Restores a previously backed up configuration.
|
|
11072
|
+
* @summary Restore Configuration Backup
|
|
11073
|
+
* @param {Array<string>} resources List of resource identifiers to included in the backup and restore operations.
|
|
11074
|
+
* @param {File} body Backup file stream containing the configuration to restore.
|
|
11075
|
+
* @param {*} [options] Override http request option.
|
|
11076
|
+
* @throws {RequiredError}
|
|
11077
|
+
* @memberof SystemApi
|
|
11078
|
+
*/
|
|
11079
|
+
restoreConfiguration(resources: Array<string>, body: File, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
11011
11080
|
/**
|
|
11012
11081
|
* Update the Wandelbots NOVA version and all attached services. Sending this API Request will trigger an update of all NOVA services that are part of a cell. Previous cells and cell configurations will remain on the instance. If the update fails, the previous Wandelbots NOVA version is restored.
|
|
11013
11082
|
* @summary Update Wandelbots NOVA version
|
|
@@ -11411,18 +11480,28 @@ export declare const VirtualRobotApiAxiosParamCreator: (configuration?: Configur
|
|
|
11411
11480
|
*/
|
|
11412
11481
|
getMotionGroups: (cell: string, controller: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
11413
11482
|
/**
|
|
11414
|
-
*
|
|
11483
|
+
* Retrieves the current values of inputs/outputs of the virtual controller. The identifiers of inputs/outputs must be provided in the request. Request all available input/output identifiers via [listVirtualRobotIODescriptions](listVirtualRobotIODescriptions).
|
|
11415
11484
|
* @summary Get Inputs/Outputs
|
|
11416
11485
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
11417
11486
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
11487
|
+
* @param {Array<string>} ios
|
|
11488
|
+
* @param {*} [options] Override http request option.
|
|
11489
|
+
* @throws {RequiredError}
|
|
11490
|
+
*/
|
|
11491
|
+
listIOs: (cell: string, controller: string, ios: Array<string>, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
11492
|
+
/**
|
|
11493
|
+
* Lists the input/output descriptions of the virtual robot controller. The input/output descriptions contain information like name, type and unit. Available inputs/outputs are defined by the virtual robot controller. Each input/output has a unique identifier. If no identifiers are specified in the request, all available inputs/outputs are retrieved by this endpoint. Exception: When a filter (e.g., direction, value_type, group) is applied, only matching inputs/outputs are returned.
|
|
11494
|
+
* @summary List Input/Output Descriptions
|
|
11495
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
11496
|
+
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
11418
11497
|
* @param {Array<string>} [ios]
|
|
11419
11498
|
* @param {IODirection} [direction] Return only inputs/outputs with the specified direction.
|
|
11420
11499
|
* @param {IOValueType} [valueType] Return only inputs/outputs with the specified value type.
|
|
11421
|
-
* @param {string} [
|
|
11500
|
+
* @param {string} [group] Return only inputs/outputs from the specified group.
|
|
11422
11501
|
* @param {*} [options] Override http request option.
|
|
11423
11502
|
* @throws {RequiredError}
|
|
11424
11503
|
*/
|
|
11425
|
-
|
|
11504
|
+
listVirtualRobotIODescriptions: (cell: string, controller: string, ios?: Array<string>, direction?: IODirection, valueType?: IOValueType, group?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
11426
11505
|
/**
|
|
11427
11506
|
* Sets a list of values of a virtual controller inputs/outputs.
|
|
11428
11507
|
* @summary Set Input/Ouput Values
|
|
@@ -11470,18 +11549,28 @@ export declare const VirtualRobotApiFp: (configuration?: Configuration) => {
|
|
|
11470
11549
|
*/
|
|
11471
11550
|
getMotionGroups(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<MotionGroupInfos>>;
|
|
11472
11551
|
/**
|
|
11473
|
-
*
|
|
11552
|
+
* Retrieves the current values of inputs/outputs of the virtual controller. The identifiers of inputs/outputs must be provided in the request. Request all available input/output identifiers via [listVirtualRobotIODescriptions](listVirtualRobotIODescriptions).
|
|
11474
11553
|
* @summary Get Inputs/Outputs
|
|
11475
11554
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
11476
11555
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
11556
|
+
* @param {Array<string>} ios
|
|
11557
|
+
* @param {*} [options] Override http request option.
|
|
11558
|
+
* @throws {RequiredError}
|
|
11559
|
+
*/
|
|
11560
|
+
listIOs(cell: string, controller: string, ios: Array<string>, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListIOValuesResponse>>;
|
|
11561
|
+
/**
|
|
11562
|
+
* Lists the input/output descriptions of the virtual robot controller. The input/output descriptions contain information like name, type and unit. Available inputs/outputs are defined by the virtual robot controller. Each input/output has a unique identifier. If no identifiers are specified in the request, all available inputs/outputs are retrieved by this endpoint. Exception: When a filter (e.g., direction, value_type, group) is applied, only matching inputs/outputs are returned.
|
|
11563
|
+
* @summary List Input/Output Descriptions
|
|
11564
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
11565
|
+
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
11477
11566
|
* @param {Array<string>} [ios]
|
|
11478
11567
|
* @param {IODirection} [direction] Return only inputs/outputs with the specified direction.
|
|
11479
11568
|
* @param {IOValueType} [valueType] Return only inputs/outputs with the specified value type.
|
|
11480
|
-
* @param {string} [
|
|
11569
|
+
* @param {string} [group] Return only inputs/outputs from the specified group.
|
|
11481
11570
|
* @param {*} [options] Override http request option.
|
|
11482
11571
|
* @throws {RequiredError}
|
|
11483
11572
|
*/
|
|
11484
|
-
|
|
11573
|
+
listVirtualRobotIODescriptions(cell: string, controller: string, ios?: Array<string>, direction?: IODirection, valueType?: IOValueType, group?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListIODescriptionsResponse>>;
|
|
11485
11574
|
/**
|
|
11486
11575
|
* Sets a list of values of a virtual controller inputs/outputs.
|
|
11487
11576
|
* @summary Set Input/Ouput Values
|
|
@@ -11491,7 +11580,7 @@ export declare const VirtualRobotApiFp: (configuration?: Configuration) => {
|
|
|
11491
11580
|
* @param {*} [options] Override http request option.
|
|
11492
11581
|
* @throws {RequiredError}
|
|
11493
11582
|
*/
|
|
11494
|
-
setIOValues(cell: string, controller: string, setIOValuesRequestInner: Array<SetIOValuesRequestInner>, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<
|
|
11583
|
+
setIOValues(cell: string, controller: string, setIOValuesRequestInner: Array<SetIOValuesRequestInner>, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
11495
11584
|
/**
|
|
11496
11585
|
* Sets the values for joint position, joint velocity or joint acceleration of a motion group state. The values are immediately applied to the joints of the motion group. We recommend to only use the endpoint when the motion group is in monitor mode. In case the motion group is controlled, currently jogging or planning motions, the values are overridden by the controller or an error may occur.
|
|
11497
11586
|
* @summary Set Motion Group State
|
|
@@ -11502,7 +11591,7 @@ export declare const VirtualRobotApiFp: (configuration?: Configuration) => {
|
|
|
11502
11591
|
* @param {*} [options] Override http request option.
|
|
11503
11592
|
* @throws {RequiredError}
|
|
11504
11593
|
*/
|
|
11505
|
-
setMotionGroupState(cell: string, controller: string, motionGroup: string, motionGroupJoints: MotionGroupJoints, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<
|
|
11594
|
+
setMotionGroupState(cell: string, controller: string, motionGroup: string, motionGroupJoints: MotionGroupJoints, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
11506
11595
|
};
|
|
11507
11596
|
/**
|
|
11508
11597
|
* VirtualRobotApi - factory interface
|
|
@@ -11529,18 +11618,28 @@ export declare const VirtualRobotApiFactory: (configuration?: Configuration, bas
|
|
|
11529
11618
|
*/
|
|
11530
11619
|
getMotionGroups(cell: string, controller: string, options?: RawAxiosRequestConfig): AxiosPromise<MotionGroupInfos>;
|
|
11531
11620
|
/**
|
|
11532
|
-
*
|
|
11621
|
+
* Retrieves the current values of inputs/outputs of the virtual controller. The identifiers of inputs/outputs must be provided in the request. Request all available input/output identifiers via [listVirtualRobotIODescriptions](listVirtualRobotIODescriptions).
|
|
11533
11622
|
* @summary Get Inputs/Outputs
|
|
11534
11623
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
11535
11624
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
11625
|
+
* @param {Array<string>} ios
|
|
11626
|
+
* @param {*} [options] Override http request option.
|
|
11627
|
+
* @throws {RequiredError}
|
|
11628
|
+
*/
|
|
11629
|
+
listIOs(cell: string, controller: string, ios: Array<string>, options?: RawAxiosRequestConfig): AxiosPromise<ListIOValuesResponse>;
|
|
11630
|
+
/**
|
|
11631
|
+
* Lists the input/output descriptions of the virtual robot controller. The input/output descriptions contain information like name, type and unit. Available inputs/outputs are defined by the virtual robot controller. Each input/output has a unique identifier. If no identifiers are specified in the request, all available inputs/outputs are retrieved by this endpoint. Exception: When a filter (e.g., direction, value_type, group) is applied, only matching inputs/outputs are returned.
|
|
11632
|
+
* @summary List Input/Output Descriptions
|
|
11633
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
11634
|
+
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
11536
11635
|
* @param {Array<string>} [ios]
|
|
11537
11636
|
* @param {IODirection} [direction] Return only inputs/outputs with the specified direction.
|
|
11538
11637
|
* @param {IOValueType} [valueType] Return only inputs/outputs with the specified value type.
|
|
11539
|
-
* @param {string} [
|
|
11638
|
+
* @param {string} [group] Return only inputs/outputs from the specified group.
|
|
11540
11639
|
* @param {*} [options] Override http request option.
|
|
11541
11640
|
* @throws {RequiredError}
|
|
11542
11641
|
*/
|
|
11543
|
-
|
|
11642
|
+
listVirtualRobotIODescriptions(cell: string, controller: string, ios?: Array<string>, direction?: IODirection, valueType?: IOValueType, group?: string, options?: RawAxiosRequestConfig): AxiosPromise<ListIODescriptionsResponse>;
|
|
11544
11643
|
/**
|
|
11545
11644
|
* Sets a list of values of a virtual controller inputs/outputs.
|
|
11546
11645
|
* @summary Set Input/Ouput Values
|
|
@@ -11550,7 +11649,7 @@ export declare const VirtualRobotApiFactory: (configuration?: Configuration, bas
|
|
|
11550
11649
|
* @param {*} [options] Override http request option.
|
|
11551
11650
|
* @throws {RequiredError}
|
|
11552
11651
|
*/
|
|
11553
|
-
setIOValues(cell: string, controller: string, setIOValuesRequestInner: Array<SetIOValuesRequestInner>, options?: RawAxiosRequestConfig): AxiosPromise<
|
|
11652
|
+
setIOValues(cell: string, controller: string, setIOValuesRequestInner: Array<SetIOValuesRequestInner>, options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
11554
11653
|
/**
|
|
11555
11654
|
* Sets the values for joint position, joint velocity or joint acceleration of a motion group state. The values are immediately applied to the joints of the motion group. We recommend to only use the endpoint when the motion group is in monitor mode. In case the motion group is controlled, currently jogging or planning motions, the values are overridden by the controller or an error may occur.
|
|
11556
11655
|
* @summary Set Motion Group State
|
|
@@ -11561,7 +11660,7 @@ export declare const VirtualRobotApiFactory: (configuration?: Configuration, bas
|
|
|
11561
11660
|
* @param {*} [options] Override http request option.
|
|
11562
11661
|
* @throws {RequiredError}
|
|
11563
11662
|
*/
|
|
11564
|
-
setMotionGroupState(cell: string, controller: string, motionGroup: string, motionGroupJoints: MotionGroupJoints, options?: RawAxiosRequestConfig): AxiosPromise<
|
|
11663
|
+
setMotionGroupState(cell: string, controller: string, motionGroup: string, motionGroupJoints: MotionGroupJoints, options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
11565
11664
|
};
|
|
11566
11665
|
/**
|
|
11567
11666
|
* VirtualRobotApi - object-oriented interface
|
|
@@ -11592,19 +11691,30 @@ export declare class VirtualRobotApi extends BaseAPI {
|
|
|
11592
11691
|
*/
|
|
11593
11692
|
getMotionGroups(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<MotionGroupInfos, any>>;
|
|
11594
11693
|
/**
|
|
11595
|
-
*
|
|
11694
|
+
* Retrieves the current values of inputs/outputs of the virtual controller. The identifiers of inputs/outputs must be provided in the request. Request all available input/output identifiers via [listVirtualRobotIODescriptions](listVirtualRobotIODescriptions).
|
|
11596
11695
|
* @summary Get Inputs/Outputs
|
|
11597
11696
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
11598
11697
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
11698
|
+
* @param {Array<string>} ios
|
|
11699
|
+
* @param {*} [options] Override http request option.
|
|
11700
|
+
* @throws {RequiredError}
|
|
11701
|
+
* @memberof VirtualRobotApi
|
|
11702
|
+
*/
|
|
11703
|
+
listIOs(cell: string, controller: string, ios: Array<string>, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ListIOValuesResponse, any>>;
|
|
11704
|
+
/**
|
|
11705
|
+
* Lists the input/output descriptions of the virtual robot controller. The input/output descriptions contain information like name, type and unit. Available inputs/outputs are defined by the virtual robot controller. Each input/output has a unique identifier. If no identifiers are specified in the request, all available inputs/outputs are retrieved by this endpoint. Exception: When a filter (e.g., direction, value_type, group) is applied, only matching inputs/outputs are returned.
|
|
11706
|
+
* @summary List Input/Output Descriptions
|
|
11707
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
11708
|
+
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
11599
11709
|
* @param {Array<string>} [ios]
|
|
11600
11710
|
* @param {IODirection} [direction] Return only inputs/outputs with the specified direction.
|
|
11601
11711
|
* @param {IOValueType} [valueType] Return only inputs/outputs with the specified value type.
|
|
11602
|
-
* @param {string} [
|
|
11712
|
+
* @param {string} [group] Return only inputs/outputs from the specified group.
|
|
11603
11713
|
* @param {*} [options] Override http request option.
|
|
11604
11714
|
* @throws {RequiredError}
|
|
11605
11715
|
* @memberof VirtualRobotApi
|
|
11606
11716
|
*/
|
|
11607
|
-
|
|
11717
|
+
listVirtualRobotIODescriptions(cell: string, controller: string, ios?: Array<string>, direction?: IODirection, valueType?: IOValueType, group?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ListIODescriptionsResponse, any>>;
|
|
11608
11718
|
/**
|
|
11609
11719
|
* Sets a list of values of a virtual controller inputs/outputs.
|
|
11610
11720
|
* @summary Set Input/Ouput Values
|
|
@@ -11615,7 +11725,7 @@ export declare class VirtualRobotApi extends BaseAPI {
|
|
|
11615
11725
|
* @throws {RequiredError}
|
|
11616
11726
|
* @memberof VirtualRobotApi
|
|
11617
11727
|
*/
|
|
11618
|
-
setIOValues(cell: string, controller: string, setIOValuesRequestInner: Array<SetIOValuesRequestInner>, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<
|
|
11728
|
+
setIOValues(cell: string, controller: string, setIOValuesRequestInner: Array<SetIOValuesRequestInner>, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
11619
11729
|
/**
|
|
11620
11730
|
* Sets the values for joint position, joint velocity or joint acceleration of a motion group state. The values are immediately applied to the joints of the motion group. We recommend to only use the endpoint when the motion group is in monitor mode. In case the motion group is controlled, currently jogging or planning motions, the values are overridden by the controller or an error may occur.
|
|
11621
11731
|
* @summary Set Motion Group State
|
|
@@ -11627,7 +11737,7 @@ export declare class VirtualRobotApi extends BaseAPI {
|
|
|
11627
11737
|
* @throws {RequiredError}
|
|
11628
11738
|
* @memberof VirtualRobotApi
|
|
11629
11739
|
*/
|
|
11630
|
-
setMotionGroupState(cell: string, controller: string, motionGroup: string, motionGroupJoints: MotionGroupJoints, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<
|
|
11740
|
+
setMotionGroupState(cell: string, controller: string, motionGroup: string, motionGroupJoints: MotionGroupJoints, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
11631
11741
|
}
|
|
11632
11742
|
/**
|
|
11633
11743
|
* VirtualRobotBehaviorApi - axios parameter creator
|
|
@@ -11701,7 +11811,7 @@ export declare const VirtualRobotBehaviorApiFp: (configuration?: Configuration)
|
|
|
11701
11811
|
* @param {*} [options] Override http request option.
|
|
11702
11812
|
* @throws {RequiredError}
|
|
11703
11813
|
*/
|
|
11704
|
-
setMotionGroupBehavior(cell: string, controller: string, motionGroup: string, behavior?: Behavior, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<
|
|
11814
|
+
setMotionGroupBehavior(cell: string, controller: string, motionGroup: string, behavior?: Behavior, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
11705
11815
|
};
|
|
11706
11816
|
/**
|
|
11707
11817
|
* VirtualRobotBehaviorApi - factory interface
|
|
@@ -11738,7 +11848,7 @@ export declare const VirtualRobotBehaviorApiFactory: (configuration?: Configurat
|
|
|
11738
11848
|
* @param {*} [options] Override http request option.
|
|
11739
11849
|
* @throws {RequiredError}
|
|
11740
11850
|
*/
|
|
11741
|
-
setMotionGroupBehavior(cell: string, controller: string, motionGroup: string, behavior?: Behavior, options?: RawAxiosRequestConfig): AxiosPromise<
|
|
11851
|
+
setMotionGroupBehavior(cell: string, controller: string, motionGroup: string, behavior?: Behavior, options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
11742
11852
|
};
|
|
11743
11853
|
/**
|
|
11744
11854
|
* VirtualRobotBehaviorApi - object-oriented interface
|
|
@@ -11780,7 +11890,7 @@ export declare class VirtualRobotBehaviorApi extends BaseAPI {
|
|
|
11780
11890
|
* @throws {RequiredError}
|
|
11781
11891
|
* @memberof VirtualRobotBehaviorApi
|
|
11782
11892
|
*/
|
|
11783
|
-
setMotionGroupBehavior(cell: string, controller: string, motionGroup: string, behavior?: Behavior, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<
|
|
11893
|
+
setMotionGroupBehavior(cell: string, controller: string, motionGroup: string, behavior?: Behavior, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
11784
11894
|
}
|
|
11785
11895
|
/**
|
|
11786
11896
|
* VirtualRobotModeApi - axios parameter creator
|
|
@@ -11876,7 +11986,7 @@ export declare const VirtualRobotModeApiFp: (configuration?: Configuration) => {
|
|
|
11876
11986
|
* @param {*} [options] Override http request option.
|
|
11877
11987
|
* @throws {RequiredError}
|
|
11878
11988
|
*/
|
|
11879
|
-
setEmergencyStop(cell: string, controller: string, active?: boolean, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<
|
|
11989
|
+
setEmergencyStop(cell: string, controller: string, active?: boolean, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
11880
11990
|
/**
|
|
11881
11991
|
* Changes the Operation Mode of the virtual robot controller to the specified value. To get the Operation Mode regardless of the controller type use [getCurrentMotionGroupState](getCurrentMotionGroupState). > **NOTE** > > The Operating Mode can only change be changed via API when using virtual robot controllers.
|
|
11882
11992
|
* @summary Set Operation Mode
|
|
@@ -11886,7 +11996,7 @@ export declare const VirtualRobotModeApiFp: (configuration?: Configuration) => {
|
|
|
11886
11996
|
* @param {*} [options] Override http request option.
|
|
11887
11997
|
* @throws {RequiredError}
|
|
11888
11998
|
*/
|
|
11889
|
-
setOperationMode(cell: string, controller: string, mode: OperationMode, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<
|
|
11999
|
+
setOperationMode(cell: string, controller: string, mode: OperationMode, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
11890
12000
|
};
|
|
11891
12001
|
/**
|
|
11892
12002
|
* VirtualRobotModeApi - factory interface
|
|
@@ -11929,7 +12039,7 @@ export declare const VirtualRobotModeApiFactory: (configuration?: Configuration,
|
|
|
11929
12039
|
* @param {*} [options] Override http request option.
|
|
11930
12040
|
* @throws {RequiredError}
|
|
11931
12041
|
*/
|
|
11932
|
-
setEmergencyStop(cell: string, controller: string, active?: boolean, options?: RawAxiosRequestConfig): AxiosPromise<
|
|
12042
|
+
setEmergencyStop(cell: string, controller: string, active?: boolean, options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
11933
12043
|
/**
|
|
11934
12044
|
* Changes the Operation Mode of the virtual robot controller to the specified value. To get the Operation Mode regardless of the controller type use [getCurrentMotionGroupState](getCurrentMotionGroupState). > **NOTE** > > The Operating Mode can only change be changed via API when using virtual robot controllers.
|
|
11935
12045
|
* @summary Set Operation Mode
|
|
@@ -11939,7 +12049,7 @@ export declare const VirtualRobotModeApiFactory: (configuration?: Configuration,
|
|
|
11939
12049
|
* @param {*} [options] Override http request option.
|
|
11940
12050
|
* @throws {RequiredError}
|
|
11941
12051
|
*/
|
|
11942
|
-
setOperationMode(cell: string, controller: string, mode: OperationMode, options?: RawAxiosRequestConfig): AxiosPromise<
|
|
12052
|
+
setOperationMode(cell: string, controller: string, mode: OperationMode, options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
11943
12053
|
};
|
|
11944
12054
|
/**
|
|
11945
12055
|
* VirtualRobotModeApi - object-oriented interface
|
|
@@ -11988,7 +12098,7 @@ export declare class VirtualRobotModeApi extends BaseAPI {
|
|
|
11988
12098
|
* @throws {RequiredError}
|
|
11989
12099
|
* @memberof VirtualRobotModeApi
|
|
11990
12100
|
*/
|
|
11991
|
-
setEmergencyStop(cell: string, controller: string, active?: boolean, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<
|
|
12101
|
+
setEmergencyStop(cell: string, controller: string, active?: boolean, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
11992
12102
|
/**
|
|
11993
12103
|
* Changes the Operation Mode of the virtual robot controller to the specified value. To get the Operation Mode regardless of the controller type use [getCurrentMotionGroupState](getCurrentMotionGroupState). > **NOTE** > > The Operating Mode can only change be changed via API when using virtual robot controllers.
|
|
11994
12104
|
* @summary Set Operation Mode
|
|
@@ -11999,7 +12109,7 @@ export declare class VirtualRobotModeApi extends BaseAPI {
|
|
|
11999
12109
|
* @throws {RequiredError}
|
|
12000
12110
|
* @memberof VirtualRobotModeApi
|
|
12001
12111
|
*/
|
|
12002
|
-
setOperationMode(cell: string, controller: string, mode: OperationMode, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<
|
|
12112
|
+
setOperationMode(cell: string, controller: string, mode: OperationMode, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
12003
12113
|
}
|
|
12004
12114
|
/**
|
|
12005
12115
|
* VirtualRobotSetupApi - axios parameter creator
|
|
@@ -12104,7 +12214,7 @@ export declare const VirtualRobotSetupApiFp: (configuration?: Configuration) =>
|
|
|
12104
12214
|
* @param {*} [options] Override http request option.
|
|
12105
12215
|
* @throws {RequiredError}
|
|
12106
12216
|
*/
|
|
12107
|
-
addVirtualRobotCoordinateSystem(cell: string, controller: string, coordinateSystem: CoordinateSystem, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<
|
|
12217
|
+
addVirtualRobotCoordinateSystem(cell: string, controller: string, coordinateSystem: CoordinateSystem, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
12108
12218
|
/**
|
|
12109
12219
|
* Adds a new TCP or updates an existing TCP in the motion group. The position and rotation values in the request body are defined within the flange’s coordinate system. > **NOTE** > > Ensure the TCP\'s position is within the robot\'s reach. Refer to the robot’s documentation or data sheet for details like joint limits or reach.
|
|
12110
12220
|
* @summary Add TCP
|
|
@@ -12115,7 +12225,7 @@ export declare const VirtualRobotSetupApiFp: (configuration?: Configuration) =>
|
|
|
12115
12225
|
* @param {*} [options] Override http request option.
|
|
12116
12226
|
* @throws {RequiredError}
|
|
12117
12227
|
*/
|
|
12118
|
-
addVirtualRobotTcp(cell: string, controller: string, motionGroup: string, robotTcp: RobotTcp, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<
|
|
12228
|
+
addVirtualRobotTcp(cell: string, controller: string, motionGroup: string, robotTcp: RobotTcp, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
12119
12229
|
/**
|
|
12120
12230
|
* Deletes a coordinate system from the virtual controller. This will remove the coordinate system from the list of coordinate systems and remove all dependent coordinate systems which use the deleted coordinate system as reference.
|
|
12121
12231
|
* @summary Remove Coordinate System
|
|
@@ -12126,7 +12236,7 @@ export declare const VirtualRobotSetupApiFp: (configuration?: Configuration) =>
|
|
|
12126
12236
|
* @param {*} [options] Override http request option.
|
|
12127
12237
|
* @throws {RequiredError}
|
|
12128
12238
|
*/
|
|
12129
|
-
deleteVirtualRobotCoordinateSystem(cell: string, controller: string, coordinateSystem: string, deleteDependent?: boolean, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<
|
|
12239
|
+
deleteVirtualRobotCoordinateSystem(cell: string, controller: string, coordinateSystem: string, deleteDependent?: boolean, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
12130
12240
|
/**
|
|
12131
12241
|
* Removes the TCP from the motion group. An unknown TCP is a valid input.
|
|
12132
12242
|
* @summary Remove TCP
|
|
@@ -12137,7 +12247,7 @@ export declare const VirtualRobotSetupApiFp: (configuration?: Configuration) =>
|
|
|
12137
12247
|
* @param {*} [options] Override http request option.
|
|
12138
12248
|
* @throws {RequiredError}
|
|
12139
12249
|
*/
|
|
12140
|
-
deleteVirtualRobotTcp(cell: string, controller: string, motionGroup: string, tcp: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<
|
|
12250
|
+
deleteVirtualRobotTcp(cell: string, controller: string, motionGroup: string, tcp: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
12141
12251
|
/**
|
|
12142
12252
|
* Gets motion group mounting. The motion group is based on the origin of the returned coordinate system.
|
|
12143
12253
|
* @summary Get Mounting
|
|
@@ -12193,7 +12303,7 @@ export declare const VirtualRobotSetupApiFactory: (configuration?: Configuration
|
|
|
12193
12303
|
* @param {*} [options] Override http request option.
|
|
12194
12304
|
* @throws {RequiredError}
|
|
12195
12305
|
*/
|
|
12196
|
-
addVirtualRobotCoordinateSystem(cell: string, controller: string, coordinateSystem: CoordinateSystem, options?: RawAxiosRequestConfig): AxiosPromise<
|
|
12306
|
+
addVirtualRobotCoordinateSystem(cell: string, controller: string, coordinateSystem: CoordinateSystem, options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
12197
12307
|
/**
|
|
12198
12308
|
* Adds a new TCP or updates an existing TCP in the motion group. The position and rotation values in the request body are defined within the flange’s coordinate system. > **NOTE** > > Ensure the TCP\'s position is within the robot\'s reach. Refer to the robot’s documentation or data sheet for details like joint limits or reach.
|
|
12199
12309
|
* @summary Add TCP
|
|
@@ -12204,7 +12314,7 @@ export declare const VirtualRobotSetupApiFactory: (configuration?: Configuration
|
|
|
12204
12314
|
* @param {*} [options] Override http request option.
|
|
12205
12315
|
* @throws {RequiredError}
|
|
12206
12316
|
*/
|
|
12207
|
-
addVirtualRobotTcp(cell: string, controller: string, motionGroup: string, robotTcp: RobotTcp, options?: RawAxiosRequestConfig): AxiosPromise<
|
|
12317
|
+
addVirtualRobotTcp(cell: string, controller: string, motionGroup: string, robotTcp: RobotTcp, options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
12208
12318
|
/**
|
|
12209
12319
|
* Deletes a coordinate system from the virtual controller. This will remove the coordinate system from the list of coordinate systems and remove all dependent coordinate systems which use the deleted coordinate system as reference.
|
|
12210
12320
|
* @summary Remove Coordinate System
|
|
@@ -12215,7 +12325,7 @@ export declare const VirtualRobotSetupApiFactory: (configuration?: Configuration
|
|
|
12215
12325
|
* @param {*} [options] Override http request option.
|
|
12216
12326
|
* @throws {RequiredError}
|
|
12217
12327
|
*/
|
|
12218
|
-
deleteVirtualRobotCoordinateSystem(cell: string, controller: string, coordinateSystem: string, deleteDependent?: boolean, options?: RawAxiosRequestConfig): AxiosPromise<
|
|
12328
|
+
deleteVirtualRobotCoordinateSystem(cell: string, controller: string, coordinateSystem: string, deleteDependent?: boolean, options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
12219
12329
|
/**
|
|
12220
12330
|
* Removes the TCP from the motion group. An unknown TCP is a valid input.
|
|
12221
12331
|
* @summary Remove TCP
|
|
@@ -12226,7 +12336,7 @@ export declare const VirtualRobotSetupApiFactory: (configuration?: Configuration
|
|
|
12226
12336
|
* @param {*} [options] Override http request option.
|
|
12227
12337
|
* @throws {RequiredError}
|
|
12228
12338
|
*/
|
|
12229
|
-
deleteVirtualRobotTcp(cell: string, controller: string, motionGroup: string, tcp: string, options?: RawAxiosRequestConfig): AxiosPromise<
|
|
12339
|
+
deleteVirtualRobotTcp(cell: string, controller: string, motionGroup: string, tcp: string, options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
12230
12340
|
/**
|
|
12231
12341
|
* Gets motion group mounting. The motion group is based on the origin of the returned coordinate system.
|
|
12232
12342
|
* @summary Get Mounting
|
|
@@ -12285,7 +12395,7 @@ export declare class VirtualRobotSetupApi extends BaseAPI {
|
|
|
12285
12395
|
* @throws {RequiredError}
|
|
12286
12396
|
* @memberof VirtualRobotSetupApi
|
|
12287
12397
|
*/
|
|
12288
|
-
addVirtualRobotCoordinateSystem(cell: string, controller: string, coordinateSystem: CoordinateSystem, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<
|
|
12398
|
+
addVirtualRobotCoordinateSystem(cell: string, controller: string, coordinateSystem: CoordinateSystem, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
12289
12399
|
/**
|
|
12290
12400
|
* Adds a new TCP or updates an existing TCP in the motion group. The position and rotation values in the request body are defined within the flange’s coordinate system. > **NOTE** > > Ensure the TCP\'s position is within the robot\'s reach. Refer to the robot’s documentation or data sheet for details like joint limits or reach.
|
|
12291
12401
|
* @summary Add TCP
|
|
@@ -12297,7 +12407,7 @@ export declare class VirtualRobotSetupApi extends BaseAPI {
|
|
|
12297
12407
|
* @throws {RequiredError}
|
|
12298
12408
|
* @memberof VirtualRobotSetupApi
|
|
12299
12409
|
*/
|
|
12300
|
-
addVirtualRobotTcp(cell: string, controller: string, motionGroup: string, robotTcp: RobotTcp, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<
|
|
12410
|
+
addVirtualRobotTcp(cell: string, controller: string, motionGroup: string, robotTcp: RobotTcp, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
12301
12411
|
/**
|
|
12302
12412
|
* Deletes a coordinate system from the virtual controller. This will remove the coordinate system from the list of coordinate systems and remove all dependent coordinate systems which use the deleted coordinate system as reference.
|
|
12303
12413
|
* @summary Remove Coordinate System
|
|
@@ -12309,7 +12419,7 @@ export declare class VirtualRobotSetupApi extends BaseAPI {
|
|
|
12309
12419
|
* @throws {RequiredError}
|
|
12310
12420
|
* @memberof VirtualRobotSetupApi
|
|
12311
12421
|
*/
|
|
12312
|
-
deleteVirtualRobotCoordinateSystem(cell: string, controller: string, coordinateSystem: string, deleteDependent?: boolean, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<
|
|
12422
|
+
deleteVirtualRobotCoordinateSystem(cell: string, controller: string, coordinateSystem: string, deleteDependent?: boolean, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
12313
12423
|
/**
|
|
12314
12424
|
* Removes the TCP from the motion group. An unknown TCP is a valid input.
|
|
12315
12425
|
* @summary Remove TCP
|
|
@@ -12321,7 +12431,7 @@ export declare class VirtualRobotSetupApi extends BaseAPI {
|
|
|
12321
12431
|
* @throws {RequiredError}
|
|
12322
12432
|
* @memberof VirtualRobotSetupApi
|
|
12323
12433
|
*/
|
|
12324
|
-
deleteVirtualRobotTcp(cell: string, controller: string, motionGroup: string, tcp: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<
|
|
12434
|
+
deleteVirtualRobotTcp(cell: string, controller: string, motionGroup: string, tcp: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
12325
12435
|
/**
|
|
12326
12436
|
* Gets motion group mounting. The motion group is based on the origin of the returned coordinate system.
|
|
12327
12437
|
* @summary Get Mounting
|