@wandelbots/nova-api 25.7.0-dev.18 → 25.7.0-dev.2
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 +7 -7
- package/v1/api.js +5 -5
- package/v1/api.ts +7 -7
- package/v1/base.d.ts +1 -1
- package/v1/base.js +1 -1
- package/v1/base.ts +1 -1
- package/v1/common.d.ts +1 -1
- package/v1/common.js +1 -1
- package/v1/common.ts +1 -1
- package/v1/configuration.d.ts +1 -1
- package/v1/configuration.js +1 -1
- package/v1/configuration.ts +1 -1
- package/v1/index.d.ts +1 -1
- package/v1/index.js +1 -1
- package/v1/index.ts +1 -1
- package/v2/api.d.ts +793 -864
- package/v2/api.js +1187 -1302
- package/v2/api.js.map +1 -1
- package/v2/api.ts +1541 -1681
package/v2/api.d.ts
CHANGED
|
@@ -210,7 +210,7 @@ export interface App {
|
|
|
210
210
|
'diagnosis_path'?: string;
|
|
211
211
|
}
|
|
212
212
|
/**
|
|
213
|
-
* ## BEHAVIOR_AUTOMATIC This is the default behavior. The motion
|
|
213
|
+
* ## BEHAVIOR_AUTOMATIC This is the default behavior. The motion group instantly takes any commanded joint configuration as actual joint state. Configures the compliance of the virtual robot with the normal ControllerState cycle time. If set, the virtual robot will act like a physical one, e.g. with a cycle time of 8ms to respond to a new joint state command. ## BEHAVIOR_AUTOMATIC_NOT_COMPLY_WITH_CYCLETIME Configures the compliance of the virtual robot with the normal ControllerState cycle time. If set, the robot will respond as fast as possible, limited only by software execution speed. Because of that the execution of a movement requires less time than with BEHAVIOR_AUTOMATIC. ## BEHAVIOR_EXTERNAL_SOURCE The external client is the only source of actual joint state changes. This mode is used to enable third party software indicating the current joint state via [externalJointsStream](externalJointsStream).
|
|
214
214
|
* @export
|
|
215
215
|
* @enum {string}
|
|
216
216
|
*/
|
|
@@ -859,37 +859,6 @@ export interface ContainerStorage {
|
|
|
859
859
|
*/
|
|
860
860
|
'capacity': string;
|
|
861
861
|
}
|
|
862
|
-
/**
|
|
863
|
-
* The data type to describe a robot controller.
|
|
864
|
-
* @export
|
|
865
|
-
* @interface ControllerDescription
|
|
866
|
-
*/
|
|
867
|
-
export interface ControllerDescription {
|
|
868
|
-
/**
|
|
869
|
-
*
|
|
870
|
-
* @type {Array<string>}
|
|
871
|
-
* @memberof ControllerDescription
|
|
872
|
-
*/
|
|
873
|
-
'connected_motion_groups': Array<string>;
|
|
874
|
-
/**
|
|
875
|
-
* Can this controller be moved through freedrive (true), or not (false).
|
|
876
|
-
* @type {boolean}
|
|
877
|
-
* @memberof ControllerDescription
|
|
878
|
-
*/
|
|
879
|
-
'supports_freedrive': boolean;
|
|
880
|
-
/**
|
|
881
|
-
* Can this controller be controlled with NOVA (true) or is it only possible to read data (false).
|
|
882
|
-
* @type {boolean}
|
|
883
|
-
* @memberof ControllerDescription
|
|
884
|
-
*/
|
|
885
|
-
'supports_control': boolean;
|
|
886
|
-
/**
|
|
887
|
-
* True if NOVA supports reading safety zone-, tool- and link-geometries for this motion group. Safety zones are used to define areas where the robot should slow down or stop. If false, NOVA can\'t guarantee that the executed motions respect safety zones defined on the controller.
|
|
888
|
-
* @type {boolean}
|
|
889
|
-
* @memberof ControllerDescription
|
|
890
|
-
*/
|
|
891
|
-
'supports_safety_zones': boolean;
|
|
892
|
-
}
|
|
893
862
|
/**
|
|
894
863
|
* Defines a convex hull encapsulating a set of vertices.
|
|
895
864
|
* @export
|
|
@@ -919,6 +888,12 @@ export type ConvexHullShapeTypeEnum = typeof ConvexHullShapeTypeEnum[keyof typeo
|
|
|
919
888
|
* @interface CoordinateSystem
|
|
920
889
|
*/
|
|
921
890
|
export interface CoordinateSystem {
|
|
891
|
+
/**
|
|
892
|
+
* Unique identifier of the coordinate system.
|
|
893
|
+
* @type {string}
|
|
894
|
+
* @memberof CoordinateSystem
|
|
895
|
+
*/
|
|
896
|
+
'coordinate_system': string;
|
|
922
897
|
/**
|
|
923
898
|
* Human readable name of this coordinate system.
|
|
924
899
|
* @type {string}
|
|
@@ -949,49 +924,19 @@ export interface CoordinateSystem {
|
|
|
949
924
|
* @memberof CoordinateSystem
|
|
950
925
|
*/
|
|
951
926
|
'orientation_type'?: OrientationType;
|
|
952
|
-
/**
|
|
953
|
-
* Unique identifier of the coordinate system.
|
|
954
|
-
* @type {string}
|
|
955
|
-
* @memberof CoordinateSystem
|
|
956
|
-
*/
|
|
957
|
-
'coordinate_system': string;
|
|
958
927
|
}
|
|
959
928
|
/**
|
|
960
929
|
*
|
|
961
930
|
* @export
|
|
962
|
-
* @interface
|
|
931
|
+
* @interface CoordinateSystems
|
|
963
932
|
*/
|
|
964
|
-
export interface
|
|
965
|
-
/**
|
|
966
|
-
* Human readable name of this coordinate system.
|
|
967
|
-
* @type {string}
|
|
968
|
-
* @memberof CoordinateSystemData
|
|
969
|
-
*/
|
|
970
|
-
'name'?: string;
|
|
971
|
-
/**
|
|
972
|
-
* The identifier of the reference coordinate system. Empty if world is used.
|
|
973
|
-
* @type {string}
|
|
974
|
-
* @memberof CoordinateSystemData
|
|
975
|
-
*/
|
|
976
|
-
'reference_coordinate_system'?: string;
|
|
977
|
-
/**
|
|
978
|
-
* A three-dimensional vector [x, y, z] with double precision.
|
|
979
|
-
* @type {Array<number>}
|
|
980
|
-
* @memberof CoordinateSystemData
|
|
981
|
-
*/
|
|
982
|
-
'position'?: Array<number>;
|
|
983
|
-
/**
|
|
984
|
-
* Describes an orientation in 3D space. A tree-to-four-dimensional vector [x, y, z, w] with double precision.
|
|
985
|
-
* @type {Array<number>}
|
|
986
|
-
* @memberof CoordinateSystemData
|
|
987
|
-
*/
|
|
988
|
-
'orientation'?: Array<number>;
|
|
933
|
+
export interface CoordinateSystems {
|
|
989
934
|
/**
|
|
990
935
|
*
|
|
991
|
-
* @type {
|
|
992
|
-
* @memberof
|
|
936
|
+
* @type {Array<CoordinateSystem>}
|
|
937
|
+
* @memberof CoordinateSystems
|
|
993
938
|
*/
|
|
994
|
-
'
|
|
939
|
+
'coordinate_systems': Array<CoordinateSystem>;
|
|
995
940
|
}
|
|
996
941
|
/**
|
|
997
942
|
*
|
|
@@ -1101,6 +1046,36 @@ export declare const Direction: {
|
|
|
1101
1046
|
readonly DirectionBackward: "DIRECTION_BACKWARD";
|
|
1102
1047
|
};
|
|
1103
1048
|
export type Direction = typeof Direction[keyof typeof Direction];
|
|
1049
|
+
/**
|
|
1050
|
+
*
|
|
1051
|
+
* @export
|
|
1052
|
+
* @interface EndOfTrajectory
|
|
1053
|
+
*/
|
|
1054
|
+
export interface EndOfTrajectory {
|
|
1055
|
+
/**
|
|
1056
|
+
*
|
|
1057
|
+
* @type {string}
|
|
1058
|
+
* @memberof EndOfTrajectory
|
|
1059
|
+
*/
|
|
1060
|
+
'kind': EndOfTrajectoryKindEnum;
|
|
1061
|
+
}
|
|
1062
|
+
export declare const EndOfTrajectoryKindEnum: {
|
|
1063
|
+
readonly EndOfTrajectory: "END_OF_TRAJECTORY";
|
|
1064
|
+
};
|
|
1065
|
+
export type EndOfTrajectoryKindEnum = typeof EndOfTrajectoryKindEnum[keyof typeof EndOfTrajectoryKindEnum];
|
|
1066
|
+
/**
|
|
1067
|
+
*
|
|
1068
|
+
* @export
|
|
1069
|
+
* @interface Error2
|
|
1070
|
+
*/
|
|
1071
|
+
export interface Error2 {
|
|
1072
|
+
/**
|
|
1073
|
+
*
|
|
1074
|
+
* @type {string}
|
|
1075
|
+
* @memberof Error2
|
|
1076
|
+
*/
|
|
1077
|
+
'message': string;
|
|
1078
|
+
}
|
|
1104
1079
|
/**
|
|
1105
1080
|
* Details about the state of the motion execution. The details are either for a jogging or a trajectory. If NOVA is not controlling this motion group at the moment, this field is omitted.
|
|
1106
1081
|
* @export
|
|
@@ -1163,23 +1138,41 @@ export interface ExternalJointStreamDatapoint {
|
|
|
1163
1138
|
'motion_group': string;
|
|
1164
1139
|
/**
|
|
1165
1140
|
*
|
|
1166
|
-
* @type {
|
|
1141
|
+
* @type {ExternalJointStreamDatapointValue}
|
|
1167
1142
|
* @memberof ExternalJointStreamDatapoint
|
|
1168
1143
|
*/
|
|
1169
|
-
'value':
|
|
1144
|
+
'value': ExternalJointStreamDatapointValue;
|
|
1170
1145
|
}
|
|
1171
1146
|
/**
|
|
1172
|
-
*
|
|
1147
|
+
* The joint-values of the external joint stream datapoint.
|
|
1173
1148
|
* @export
|
|
1174
|
-
* @interface
|
|
1149
|
+
* @interface ExternalJointStreamDatapointValue
|
|
1175
1150
|
*/
|
|
1176
|
-
export interface
|
|
1151
|
+
export interface ExternalJointStreamDatapointValue {
|
|
1177
1152
|
/**
|
|
1178
|
-
*
|
|
1179
|
-
* @type {Array<
|
|
1180
|
-
* @memberof
|
|
1153
|
+
* The joint positions of the robot.
|
|
1154
|
+
* @type {Array<number>}
|
|
1155
|
+
* @memberof ExternalJointStreamDatapointValue
|
|
1156
|
+
*/
|
|
1157
|
+
'positions': Array<number>;
|
|
1158
|
+
/**
|
|
1159
|
+
* The joint velocities of the robot.
|
|
1160
|
+
* @type {Array<number>}
|
|
1161
|
+
* @memberof ExternalJointStreamDatapointValue
|
|
1162
|
+
*/
|
|
1163
|
+
'velocities': Array<number>;
|
|
1164
|
+
/**
|
|
1165
|
+
* The joint accelerations of the robot.
|
|
1166
|
+
* @type {Array<number>}
|
|
1167
|
+
* @memberof ExternalJointStreamDatapointValue
|
|
1168
|
+
*/
|
|
1169
|
+
'accelerations': Array<number>;
|
|
1170
|
+
/**
|
|
1171
|
+
* The joint torques of the robot.
|
|
1172
|
+
* @type {Array<number>}
|
|
1173
|
+
* @memberof ExternalJointStreamDatapointValue
|
|
1181
1174
|
*/
|
|
1182
|
-
'
|
|
1175
|
+
'torques': Array<number>;
|
|
1183
1176
|
}
|
|
1184
1177
|
/**
|
|
1185
1178
|
* The configuration of a physical FANUC robot controller has to contain IP address of the controller.
|
|
@@ -1945,104 +1938,7 @@ export type JoggingDetailsKindEnum = typeof JoggingDetailsKindEnum[keyof typeof
|
|
|
1945
1938
|
* @type JoggingDetailsState
|
|
1946
1939
|
* @export
|
|
1947
1940
|
*/
|
|
1948
|
-
export type JoggingDetailsState =
|
|
1949
|
-
/**
|
|
1950
|
-
*
|
|
1951
|
-
* @export
|
|
1952
|
-
* @interface JoggingPausedByUser
|
|
1953
|
-
*/
|
|
1954
|
-
export interface JoggingPausedByUser {
|
|
1955
|
-
/**
|
|
1956
|
-
*
|
|
1957
|
-
* @type {string}
|
|
1958
|
-
* @memberof JoggingPausedByUser
|
|
1959
|
-
*/
|
|
1960
|
-
'kind': JoggingPausedByUserKindEnum;
|
|
1961
|
-
}
|
|
1962
|
-
export declare const JoggingPausedByUserKindEnum: {
|
|
1963
|
-
readonly PausedByUser: "PAUSED_BY_USER";
|
|
1964
|
-
};
|
|
1965
|
-
export type JoggingPausedByUserKindEnum = typeof JoggingPausedByUserKindEnum[keyof typeof JoggingPausedByUserKindEnum];
|
|
1966
|
-
/**
|
|
1967
|
-
*
|
|
1968
|
-
* @export
|
|
1969
|
-
* @interface JoggingPausedNearCollision
|
|
1970
|
-
*/
|
|
1971
|
-
export interface JoggingPausedNearCollision {
|
|
1972
|
-
/**
|
|
1973
|
-
*
|
|
1974
|
-
* @type {string}
|
|
1975
|
-
* @memberof JoggingPausedNearCollision
|
|
1976
|
-
*/
|
|
1977
|
-
'kind': JoggingPausedNearCollisionKindEnum;
|
|
1978
|
-
/**
|
|
1979
|
-
*
|
|
1980
|
-
* @type {string}
|
|
1981
|
-
* @memberof JoggingPausedNearCollision
|
|
1982
|
-
*/
|
|
1983
|
-
'description': string;
|
|
1984
|
-
}
|
|
1985
|
-
export declare const JoggingPausedNearCollisionKindEnum: {
|
|
1986
|
-
readonly PausedNearCollision: "PAUSED_NEAR_COLLISION";
|
|
1987
|
-
};
|
|
1988
|
-
export type JoggingPausedNearCollisionKindEnum = typeof JoggingPausedNearCollisionKindEnum[keyof typeof JoggingPausedNearCollisionKindEnum];
|
|
1989
|
-
/**
|
|
1990
|
-
*
|
|
1991
|
-
* @export
|
|
1992
|
-
* @interface JoggingPausedNearJointLimit
|
|
1993
|
-
*/
|
|
1994
|
-
export interface JoggingPausedNearJointLimit {
|
|
1995
|
-
/**
|
|
1996
|
-
*
|
|
1997
|
-
* @type {string}
|
|
1998
|
-
* @memberof JoggingPausedNearJointLimit
|
|
1999
|
-
*/
|
|
2000
|
-
'kind': JoggingPausedNearJointLimitKindEnum;
|
|
2001
|
-
/**
|
|
2002
|
-
*
|
|
2003
|
-
* @type {Array<number>}
|
|
2004
|
-
* @memberof JoggingPausedNearJointLimit
|
|
2005
|
-
*/
|
|
2006
|
-
'joint_indices': Array<number>;
|
|
2007
|
-
}
|
|
2008
|
-
export declare const JoggingPausedNearJointLimitKindEnum: {
|
|
2009
|
-
readonly PausedNearJointLimit: "PAUSED_NEAR_JOINT_LIMIT";
|
|
2010
|
-
};
|
|
2011
|
-
export type JoggingPausedNearJointLimitKindEnum = typeof JoggingPausedNearJointLimitKindEnum[keyof typeof JoggingPausedNearJointLimitKindEnum];
|
|
2012
|
-
/**
|
|
2013
|
-
*
|
|
2014
|
-
* @export
|
|
2015
|
-
* @interface JoggingPausedOnIO
|
|
2016
|
-
*/
|
|
2017
|
-
export interface JoggingPausedOnIO {
|
|
2018
|
-
/**
|
|
2019
|
-
*
|
|
2020
|
-
* @type {string}
|
|
2021
|
-
* @memberof JoggingPausedOnIO
|
|
2022
|
-
*/
|
|
2023
|
-
'kind': JoggingPausedOnIOKindEnum;
|
|
2024
|
-
}
|
|
2025
|
-
export declare const JoggingPausedOnIOKindEnum: {
|
|
2026
|
-
readonly PausedOnIo: "PAUSED_ON_IO";
|
|
2027
|
-
};
|
|
2028
|
-
export type JoggingPausedOnIOKindEnum = typeof JoggingPausedOnIOKindEnum[keyof typeof JoggingPausedOnIOKindEnum];
|
|
2029
|
-
/**
|
|
2030
|
-
*
|
|
2031
|
-
* @export
|
|
2032
|
-
* @interface JoggingRunning
|
|
2033
|
-
*/
|
|
2034
|
-
export interface JoggingRunning {
|
|
2035
|
-
/**
|
|
2036
|
-
*
|
|
2037
|
-
* @type {string}
|
|
2038
|
-
* @memberof JoggingRunning
|
|
2039
|
-
*/
|
|
2040
|
-
'kind': JoggingRunningKindEnum;
|
|
2041
|
-
}
|
|
2042
|
-
export declare const JoggingRunningKindEnum: {
|
|
2043
|
-
readonly Running: "RUNNING";
|
|
2044
|
-
};
|
|
2045
|
-
export type JoggingRunningKindEnum = typeof JoggingRunningKindEnum[keyof typeof JoggingRunningKindEnum];
|
|
1941
|
+
export type JoggingDetailsState = PausedByUser | PausedNearCollision | PausedNearJointLimit | PausedOnIO | Running;
|
|
2046
1942
|
/**
|
|
2047
1943
|
*
|
|
2048
1944
|
* @export
|
|
@@ -2438,6 +2334,19 @@ export interface LimitsOverride {
|
|
|
2438
2334
|
*/
|
|
2439
2335
|
'tcp_orientation_acceleration_limit'?: number;
|
|
2440
2336
|
}
|
|
2337
|
+
/**
|
|
2338
|
+
*
|
|
2339
|
+
* @export
|
|
2340
|
+
* @interface ListCoordinateSystemsResponse
|
|
2341
|
+
*/
|
|
2342
|
+
export interface ListCoordinateSystemsResponse {
|
|
2343
|
+
/**
|
|
2344
|
+
*
|
|
2345
|
+
* @type {Array<CoordinateSystem>}
|
|
2346
|
+
* @memberof ListCoordinateSystemsResponse
|
|
2347
|
+
*/
|
|
2348
|
+
'coordinatesystems'?: Array<CoordinateSystem>;
|
|
2349
|
+
}
|
|
2441
2350
|
/**
|
|
2442
2351
|
*
|
|
2443
2352
|
* @export
|
|
@@ -2519,6 +2428,19 @@ export type MotionCommandBlending = BlendingAuto | BlendingPosition;
|
|
|
2519
2428
|
* @export
|
|
2520
2429
|
*/
|
|
2521
2430
|
export type MotionCommandPath = PathCartesianPTP | PathCircle | PathCubicSpline | PathJointPTP | PathLine;
|
|
2431
|
+
/**
|
|
2432
|
+
*
|
|
2433
|
+
* @export
|
|
2434
|
+
* @interface MotionGroupBehaviorGetter
|
|
2435
|
+
*/
|
|
2436
|
+
export interface MotionGroupBehaviorGetter {
|
|
2437
|
+
/**
|
|
2438
|
+
*
|
|
2439
|
+
* @type {Behavior}
|
|
2440
|
+
* @memberof MotionGroupBehaviorGetter
|
|
2441
|
+
*/
|
|
2442
|
+
'behavior': Behavior;
|
|
2443
|
+
}
|
|
2522
2444
|
/**
|
|
2523
2445
|
* The configuration of a motion-group used for motion planning.
|
|
2524
2446
|
* @export
|
|
@@ -2530,7 +2452,7 @@ export interface MotionGroupDescription {
|
|
|
2530
2452
|
* @type {string}
|
|
2531
2453
|
* @memberof MotionGroupDescription
|
|
2532
2454
|
*/
|
|
2533
|
-
'
|
|
2455
|
+
'motion_group_type': string;
|
|
2534
2456
|
/**
|
|
2535
2457
|
* The offset from the world frame to the motion group base.
|
|
2536
2458
|
* @type {Pose}
|
|
@@ -2623,6 +2545,19 @@ export interface MotionGroupInfo {
|
|
|
2623
2545
|
*/
|
|
2624
2546
|
'dof': number;
|
|
2625
2547
|
}
|
|
2548
|
+
/**
|
|
2549
|
+
*
|
|
2550
|
+
* @export
|
|
2551
|
+
* @interface MotionGroupInfos
|
|
2552
|
+
*/
|
|
2553
|
+
export interface MotionGroupInfos {
|
|
2554
|
+
/**
|
|
2555
|
+
*
|
|
2556
|
+
* @type {Array<MotionGroupInfo>}
|
|
2557
|
+
* @memberof MotionGroupInfos
|
|
2558
|
+
*/
|
|
2559
|
+
'motion_groups': Array<MotionGroupInfo>;
|
|
2560
|
+
}
|
|
2626
2561
|
/**
|
|
2627
2562
|
* Ensure to provide one value for each joint. See [getMotionGroups](getMotionGroups) for the number of joints. Everything but positions is optional.
|
|
2628
2563
|
* @export
|
|
@@ -2784,7 +2719,7 @@ export interface MovementErrorResponse {
|
|
|
2784
2719
|
'kind': MovementErrorResponseKindEnum;
|
|
2785
2720
|
}
|
|
2786
2721
|
export declare const MovementErrorResponseKindEnum: {
|
|
2787
|
-
readonly
|
|
2722
|
+
readonly Error: "ERROR";
|
|
2788
2723
|
};
|
|
2789
2724
|
export type MovementErrorResponseKindEnum = typeof MovementErrorResponseKindEnum[keyof typeof MovementErrorResponseKindEnum];
|
|
2790
2725
|
/**
|
|
@@ -3139,6 +3074,103 @@ export interface PauseOnIO {
|
|
|
3139
3074
|
*/
|
|
3140
3075
|
'comparator': Comparator;
|
|
3141
3076
|
}
|
|
3077
|
+
/**
|
|
3078
|
+
*
|
|
3079
|
+
* @export
|
|
3080
|
+
* @interface PausedByRequest
|
|
3081
|
+
*/
|
|
3082
|
+
export interface PausedByRequest {
|
|
3083
|
+
/**
|
|
3084
|
+
*
|
|
3085
|
+
* @type {string}
|
|
3086
|
+
* @memberof PausedByRequest
|
|
3087
|
+
*/
|
|
3088
|
+
'kind': PausedByRequestKindEnum;
|
|
3089
|
+
}
|
|
3090
|
+
export declare const PausedByRequestKindEnum: {
|
|
3091
|
+
readonly PausedByUser: "PAUSED_BY_USER";
|
|
3092
|
+
};
|
|
3093
|
+
export type PausedByRequestKindEnum = typeof PausedByRequestKindEnum[keyof typeof PausedByRequestKindEnum];
|
|
3094
|
+
/**
|
|
3095
|
+
*
|
|
3096
|
+
* @export
|
|
3097
|
+
* @interface PausedByUser
|
|
3098
|
+
*/
|
|
3099
|
+
export interface PausedByUser {
|
|
3100
|
+
/**
|
|
3101
|
+
*
|
|
3102
|
+
* @type {string}
|
|
3103
|
+
* @memberof PausedByUser
|
|
3104
|
+
*/
|
|
3105
|
+
'kind': PausedByUserKindEnum;
|
|
3106
|
+
}
|
|
3107
|
+
export declare const PausedByUserKindEnum: {
|
|
3108
|
+
readonly PausedByUser: "PAUSED_BY_USER";
|
|
3109
|
+
};
|
|
3110
|
+
export type PausedByUserKindEnum = typeof PausedByUserKindEnum[keyof typeof PausedByUserKindEnum];
|
|
3111
|
+
/**
|
|
3112
|
+
*
|
|
3113
|
+
* @export
|
|
3114
|
+
* @interface PausedNearCollision
|
|
3115
|
+
*/
|
|
3116
|
+
export interface PausedNearCollision {
|
|
3117
|
+
/**
|
|
3118
|
+
*
|
|
3119
|
+
* @type {string}
|
|
3120
|
+
* @memberof PausedNearCollision
|
|
3121
|
+
*/
|
|
3122
|
+
'kind': PausedNearCollisionKindEnum;
|
|
3123
|
+
/**
|
|
3124
|
+
*
|
|
3125
|
+
* @type {string}
|
|
3126
|
+
* @memberof PausedNearCollision
|
|
3127
|
+
*/
|
|
3128
|
+
'description': string;
|
|
3129
|
+
}
|
|
3130
|
+
export declare const PausedNearCollisionKindEnum: {
|
|
3131
|
+
readonly PausedNearCollision: "PAUSED_NEAR_COLLISION";
|
|
3132
|
+
};
|
|
3133
|
+
export type PausedNearCollisionKindEnum = typeof PausedNearCollisionKindEnum[keyof typeof PausedNearCollisionKindEnum];
|
|
3134
|
+
/**
|
|
3135
|
+
*
|
|
3136
|
+
* @export
|
|
3137
|
+
* @interface PausedNearJointLimit
|
|
3138
|
+
*/
|
|
3139
|
+
export interface PausedNearJointLimit {
|
|
3140
|
+
/**
|
|
3141
|
+
*
|
|
3142
|
+
* @type {string}
|
|
3143
|
+
* @memberof PausedNearJointLimit
|
|
3144
|
+
*/
|
|
3145
|
+
'kind': PausedNearJointLimitKindEnum;
|
|
3146
|
+
/**
|
|
3147
|
+
*
|
|
3148
|
+
* @type {Array<number>}
|
|
3149
|
+
* @memberof PausedNearJointLimit
|
|
3150
|
+
*/
|
|
3151
|
+
'joint_indices': Array<number>;
|
|
3152
|
+
}
|
|
3153
|
+
export declare const PausedNearJointLimitKindEnum: {
|
|
3154
|
+
readonly PausedNearJointLimit: "PAUSED_NEAR_JOINT_LIMIT";
|
|
3155
|
+
};
|
|
3156
|
+
export type PausedNearJointLimitKindEnum = typeof PausedNearJointLimitKindEnum[keyof typeof PausedNearJointLimitKindEnum];
|
|
3157
|
+
/**
|
|
3158
|
+
*
|
|
3159
|
+
* @export
|
|
3160
|
+
* @interface PausedOnIO
|
|
3161
|
+
*/
|
|
3162
|
+
export interface PausedOnIO {
|
|
3163
|
+
/**
|
|
3164
|
+
*
|
|
3165
|
+
* @type {string}
|
|
3166
|
+
* @memberof PausedOnIO
|
|
3167
|
+
*/
|
|
3168
|
+
'kind': PausedOnIOKindEnum;
|
|
3169
|
+
}
|
|
3170
|
+
export declare const PausedOnIOKindEnum: {
|
|
3171
|
+
readonly PausedOnIo: "PAUSED_ON_IO";
|
|
3172
|
+
};
|
|
3173
|
+
export type PausedOnIOKindEnum = typeof PausedOnIOKindEnum[keyof typeof PausedOnIOKindEnum];
|
|
3142
3174
|
/**
|
|
3143
3175
|
*
|
|
3144
3176
|
* @export
|
|
@@ -3406,7 +3438,7 @@ export type ReleaseChannel = typeof ReleaseChannel[keyof typeof ReleaseChannel];
|
|
|
3406
3438
|
*/
|
|
3407
3439
|
export interface RobotController {
|
|
3408
3440
|
/**
|
|
3409
|
-
*
|
|
3441
|
+
* A unique name of the Controller inside the Cell. It must be a valid k8s label name as defined by [RFC 1035](https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#rfc-1035-label-names).
|
|
3410
3442
|
* @type {string}
|
|
3411
3443
|
* @memberof RobotController
|
|
3412
3444
|
*/
|
|
@@ -3542,6 +3574,12 @@ export type RobotSystemMode = typeof RobotSystemMode[keyof typeof RobotSystemMod
|
|
|
3542
3574
|
* @interface RobotTcp
|
|
3543
3575
|
*/
|
|
3544
3576
|
export interface RobotTcp {
|
|
3577
|
+
/**
|
|
3578
|
+
* Identifier of this tcp.
|
|
3579
|
+
* @type {string}
|
|
3580
|
+
* @memberof RobotTcp
|
|
3581
|
+
*/
|
|
3582
|
+
'id': string;
|
|
3545
3583
|
/**
|
|
3546
3584
|
* A readable and changeable name for frontend visualization.
|
|
3547
3585
|
* @type {string}
|
|
@@ -3566,44 +3604,60 @@ export interface RobotTcp {
|
|
|
3566
3604
|
* @memberof RobotTcp
|
|
3567
3605
|
*/
|
|
3568
3606
|
'orientation_type'?: OrientationType;
|
|
3569
|
-
/**
|
|
3570
|
-
* Identifier of this tcp.
|
|
3571
|
-
* @type {string}
|
|
3572
|
-
* @memberof RobotTcp
|
|
3573
|
-
*/
|
|
3574
|
-
'id': string;
|
|
3575
3607
|
}
|
|
3576
3608
|
/**
|
|
3577
3609
|
*
|
|
3578
3610
|
* @export
|
|
3579
|
-
* @interface
|
|
3611
|
+
* @interface RobotTcps
|
|
3580
3612
|
*/
|
|
3581
|
-
export interface
|
|
3613
|
+
export interface RobotTcps {
|
|
3582
3614
|
/**
|
|
3583
|
-
*
|
|
3584
|
-
* @type {
|
|
3585
|
-
* @memberof
|
|
3615
|
+
*
|
|
3616
|
+
* @type {Array<RobotTcp>}
|
|
3617
|
+
* @memberof RobotTcps
|
|
3586
3618
|
*/
|
|
3587
|
-
'
|
|
3619
|
+
'tcps': Array<RobotTcp>;
|
|
3620
|
+
}
|
|
3621
|
+
/**
|
|
3622
|
+
*
|
|
3623
|
+
* @export
|
|
3624
|
+
* @interface Running
|
|
3625
|
+
*/
|
|
3626
|
+
export interface Running {
|
|
3588
3627
|
/**
|
|
3589
|
-
*
|
|
3590
|
-
* @type {
|
|
3591
|
-
* @memberof
|
|
3628
|
+
*
|
|
3629
|
+
* @type {string}
|
|
3630
|
+
* @memberof Running
|
|
3592
3631
|
*/
|
|
3593
|
-
'
|
|
3632
|
+
'kind': RunningKindEnum;
|
|
3633
|
+
}
|
|
3634
|
+
export declare const RunningKindEnum: {
|
|
3635
|
+
readonly Running: "RUNNING";
|
|
3636
|
+
};
|
|
3637
|
+
export type RunningKindEnum = typeof RunningKindEnum[keyof typeof RunningKindEnum];
|
|
3638
|
+
/**
|
|
3639
|
+
*
|
|
3640
|
+
* @export
|
|
3641
|
+
* @interface Running1
|
|
3642
|
+
*/
|
|
3643
|
+
export interface Running1 {
|
|
3594
3644
|
/**
|
|
3595
|
-
*
|
|
3596
|
-
* @type {
|
|
3597
|
-
* @memberof
|
|
3645
|
+
*
|
|
3646
|
+
* @type {string}
|
|
3647
|
+
* @memberof Running1
|
|
3598
3648
|
*/
|
|
3599
|
-
'
|
|
3649
|
+
'kind': Running1KindEnum;
|
|
3600
3650
|
/**
|
|
3601
|
-
*
|
|
3602
|
-
* @type {
|
|
3603
|
-
* @memberof
|
|
3651
|
+
* Remaining time in milliseconds (ms) to reach the end of the motion.
|
|
3652
|
+
* @type {number}
|
|
3653
|
+
* @memberof Running1
|
|
3604
3654
|
*/
|
|
3605
|
-
'
|
|
3655
|
+
'time_to_end': number;
|
|
3606
3656
|
}
|
|
3657
|
+
export declare const Running1KindEnum: {
|
|
3658
|
+
readonly Running: "RUNNING";
|
|
3659
|
+
};
|
|
3660
|
+
export type Running1KindEnum = typeof Running1KindEnum[keyof typeof Running1KindEnum];
|
|
3607
3661
|
/**
|
|
3608
3662
|
* Current safety state of the configured robot controller. Operation modes in which the attached motion groups can be moved are: - SAFETY_STATE_NORMAL - SAFETY_STATE_REDUCED All other modes are considered as non-operational.
|
|
3609
3663
|
* @export
|
|
@@ -4127,24 +4181,7 @@ export type TrajectoryDetailsKindEnum = typeof TrajectoryDetailsKindEnum[keyof t
|
|
|
4127
4181
|
* @type TrajectoryDetailsState
|
|
4128
4182
|
* @export
|
|
4129
4183
|
*/
|
|
4130
|
-
export type TrajectoryDetailsState =
|
|
4131
|
-
/**
|
|
4132
|
-
*
|
|
4133
|
-
* @export
|
|
4134
|
-
* @interface TrajectoryEnded
|
|
4135
|
-
*/
|
|
4136
|
-
export interface TrajectoryEnded {
|
|
4137
|
-
/**
|
|
4138
|
-
*
|
|
4139
|
-
* @type {string}
|
|
4140
|
-
* @memberof TrajectoryEnded
|
|
4141
|
-
*/
|
|
4142
|
-
'kind': TrajectoryEndedKindEnum;
|
|
4143
|
-
}
|
|
4144
|
-
export declare const TrajectoryEndedKindEnum: {
|
|
4145
|
-
readonly EndOfTrajectory: "END_OF_TRAJECTORY";
|
|
4146
|
-
};
|
|
4147
|
-
export type TrajectoryEndedKindEnum = typeof TrajectoryEndedKindEnum[keyof typeof TrajectoryEndedKindEnum];
|
|
4184
|
+
export type TrajectoryDetailsState = EndOfTrajectory | PausedByRequest | PausedOnIO | Running1 | WaitForIO;
|
|
4148
4185
|
/**
|
|
4149
4186
|
*
|
|
4150
4187
|
* @export
|
|
@@ -4168,80 +4205,6 @@ export declare const TrajectoryIdMessageTypeEnum: {
|
|
|
4168
4205
|
readonly TrajectoryId: "TrajectoryId";
|
|
4169
4206
|
};
|
|
4170
4207
|
export type TrajectoryIdMessageTypeEnum = typeof TrajectoryIdMessageTypeEnum[keyof typeof TrajectoryIdMessageTypeEnum];
|
|
4171
|
-
/**
|
|
4172
|
-
*
|
|
4173
|
-
* @export
|
|
4174
|
-
* @interface TrajectoryPausedByUser
|
|
4175
|
-
*/
|
|
4176
|
-
export interface TrajectoryPausedByUser {
|
|
4177
|
-
/**
|
|
4178
|
-
*
|
|
4179
|
-
* @type {string}
|
|
4180
|
-
* @memberof TrajectoryPausedByUser
|
|
4181
|
-
*/
|
|
4182
|
-
'kind': TrajectoryPausedByUserKindEnum;
|
|
4183
|
-
}
|
|
4184
|
-
export declare const TrajectoryPausedByUserKindEnum: {
|
|
4185
|
-
readonly PausedByUser: "PAUSED_BY_USER";
|
|
4186
|
-
};
|
|
4187
|
-
export type TrajectoryPausedByUserKindEnum = typeof TrajectoryPausedByUserKindEnum[keyof typeof TrajectoryPausedByUserKindEnum];
|
|
4188
|
-
/**
|
|
4189
|
-
*
|
|
4190
|
-
* @export
|
|
4191
|
-
* @interface TrajectoryPausedOnIO
|
|
4192
|
-
*/
|
|
4193
|
-
export interface TrajectoryPausedOnIO {
|
|
4194
|
-
/**
|
|
4195
|
-
*
|
|
4196
|
-
* @type {string}
|
|
4197
|
-
* @memberof TrajectoryPausedOnIO
|
|
4198
|
-
*/
|
|
4199
|
-
'kind': TrajectoryPausedOnIOKindEnum;
|
|
4200
|
-
}
|
|
4201
|
-
export declare const TrajectoryPausedOnIOKindEnum: {
|
|
4202
|
-
readonly PausedOnIo: "PAUSED_ON_IO";
|
|
4203
|
-
};
|
|
4204
|
-
export type TrajectoryPausedOnIOKindEnum = typeof TrajectoryPausedOnIOKindEnum[keyof typeof TrajectoryPausedOnIOKindEnum];
|
|
4205
|
-
/**
|
|
4206
|
-
*
|
|
4207
|
-
* @export
|
|
4208
|
-
* @interface TrajectoryRunning
|
|
4209
|
-
*/
|
|
4210
|
-
export interface TrajectoryRunning {
|
|
4211
|
-
/**
|
|
4212
|
-
*
|
|
4213
|
-
* @type {string}
|
|
4214
|
-
* @memberof TrajectoryRunning
|
|
4215
|
-
*/
|
|
4216
|
-
'kind': TrajectoryRunningKindEnum;
|
|
4217
|
-
/**
|
|
4218
|
-
* Remaining time in milliseconds (ms) to reach the end of the motion.
|
|
4219
|
-
* @type {number}
|
|
4220
|
-
* @memberof TrajectoryRunning
|
|
4221
|
-
*/
|
|
4222
|
-
'time_to_end': number;
|
|
4223
|
-
}
|
|
4224
|
-
export declare const TrajectoryRunningKindEnum: {
|
|
4225
|
-
readonly Running: "RUNNING";
|
|
4226
|
-
};
|
|
4227
|
-
export type TrajectoryRunningKindEnum = typeof TrajectoryRunningKindEnum[keyof typeof TrajectoryRunningKindEnum];
|
|
4228
|
-
/**
|
|
4229
|
-
*
|
|
4230
|
-
* @export
|
|
4231
|
-
* @interface TrajectoryWaitForIO
|
|
4232
|
-
*/
|
|
4233
|
-
export interface TrajectoryWaitForIO {
|
|
4234
|
-
/**
|
|
4235
|
-
*
|
|
4236
|
-
* @type {string}
|
|
4237
|
-
* @memberof TrajectoryWaitForIO
|
|
4238
|
-
*/
|
|
4239
|
-
'kind': TrajectoryWaitForIOKindEnum;
|
|
4240
|
-
}
|
|
4241
|
-
export declare const TrajectoryWaitForIOKindEnum: {
|
|
4242
|
-
readonly WaitForIo: "WAIT_FOR_IO";
|
|
4243
|
-
};
|
|
4244
|
-
export type TrajectoryWaitForIOKindEnum = typeof TrajectoryWaitForIOKindEnum[keyof typeof TrajectoryWaitForIOKindEnum];
|
|
4245
4208
|
/**
|
|
4246
4209
|
* The unit of input/output value.
|
|
4247
4210
|
* @export
|
|
@@ -4327,7 +4290,7 @@ export interface ValidationError {
|
|
|
4327
4290
|
*/
|
|
4328
4291
|
export type ValidationErrorLocInner = number | string;
|
|
4329
4292
|
/**
|
|
4330
|
-
* The configuration of a virtual robot controller has to contain the manufacturer string, an optional joint position string array and either a
|
|
4293
|
+
* The configuration of a virtual robot controller has to contain the manufacturer string, an optional joint position string array and either a type or the full JSON configuration. The JSON config of a physical controller can be obtained via `/cells/{cell}/controllers/{controller}/virtual-robot-configuration`
|
|
4331
4294
|
* @export
|
|
4332
4295
|
* @interface VirtualController
|
|
4333
4296
|
*/
|
|
@@ -4351,7 +4314,7 @@ export interface VirtualController {
|
|
|
4351
4314
|
*/
|
|
4352
4315
|
'type'?: VirtualControllerTypes;
|
|
4353
4316
|
/**
|
|
4354
|
-
*
|
|
4317
|
+
*
|
|
4355
4318
|
* @type {string}
|
|
4356
4319
|
* @memberof VirtualController
|
|
4357
4320
|
*/
|
|
@@ -4501,6 +4464,23 @@ export interface VirtualRobotConfiguration {
|
|
|
4501
4464
|
*/
|
|
4502
4465
|
'content': string;
|
|
4503
4466
|
}
|
|
4467
|
+
/**
|
|
4468
|
+
*
|
|
4469
|
+
* @export
|
|
4470
|
+
* @interface WaitForIO
|
|
4471
|
+
*/
|
|
4472
|
+
export interface WaitForIO {
|
|
4473
|
+
/**
|
|
4474
|
+
*
|
|
4475
|
+
* @type {string}
|
|
4476
|
+
* @memberof WaitForIO
|
|
4477
|
+
*/
|
|
4478
|
+
'kind': WaitForIOKindEnum;
|
|
4479
|
+
}
|
|
4480
|
+
export declare const WaitForIOKindEnum: {
|
|
4481
|
+
readonly WaitForIo: "WAIT_FOR_IO";
|
|
4482
|
+
};
|
|
4483
|
+
export type WaitForIOKindEnum = typeof WaitForIOKindEnum[keyof typeof WaitForIOKindEnum];
|
|
4504
4484
|
/**
|
|
4505
4485
|
* The value to compare with the current value of the input/output.
|
|
4506
4486
|
* @export
|
|
@@ -5110,15 +5090,6 @@ export declare const ControllerApiAxiosParamCreator: (configuration?: Configurat
|
|
|
5110
5090
|
* @throws {RequiredError}
|
|
5111
5091
|
*/
|
|
5112
5092
|
deleteRobotController: (cell: string, controller: string, completionTimeout?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
5113
|
-
/**
|
|
5114
|
-
* Get description of a configured robot controller including a list of connected motion group identifiers. Use [getMotionGroupDescription](getMotionGroupDescription) to get more information about the motion group.
|
|
5115
|
-
* @summary Description
|
|
5116
|
-
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5117
|
-
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
5118
|
-
* @param {*} [options] Override http request option.
|
|
5119
|
-
* @throws {RequiredError}
|
|
5120
|
-
*/
|
|
5121
|
-
getControllerDescription: (cell: string, controller: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
5122
5093
|
/**
|
|
5123
5094
|
* Request a coordinate system specification for a given identifier. Use parameter orientation_type to get the orientation part of the transformation offset of the coordinate system returned in the requested orientation notation. If parameter orientation_type is not set, the orientation part of the transformation offset of the coordinate system is returned in rotation vector notation. The coordinate systems from the robot controller are loaded when the motion group associated with the coordinate system is activated. With deactivation of the motion group, the associated coordinate systems are removed from NOVA. The unique identifier of the coordinate systems from the robot controllers are suffixed with \"On\" + the unique identifier of the robot controller.
|
|
5124
5095
|
* @summary Coordinate System
|
|
@@ -5158,14 +5129,14 @@ export declare const ControllerApiAxiosParamCreator: (configuration?: Configurat
|
|
|
5158
5129
|
*/
|
|
5159
5130
|
getRobotController: (cell: string, controller: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
5160
5131
|
/**
|
|
5161
|
-
* Receive
|
|
5162
|
-
* @summary Virtual
|
|
5132
|
+
* Receive the configuration for a virtual robot controller. Used to configure a virtual robot controller via [addRobotController](addRobotController). > **NOTE** > > The output generated by this endpoint can be too large for the site to handle, and may produce an error or incorrect output. > Use `curl` in combination with `> output.json` to capture the output, or use an API client like Postman.
|
|
5133
|
+
* @summary Virtual Robot Configuration
|
|
5163
5134
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5164
5135
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
5165
5136
|
* @param {*} [options] Override http request option.
|
|
5166
5137
|
* @throws {RequiredError}
|
|
5167
5138
|
*/
|
|
5168
|
-
|
|
5139
|
+
getVirtualRobotConfiguration: (cell: string, controller: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
5169
5140
|
/**
|
|
5170
5141
|
* Lists all specifications of coordinate systems from robot controllers. Use parameter orientation_type to get the orientation part of the transformation offset of the coordinate system returned in the requested orientation notation. If parameter orientation_type is not set, the orientation part of the transformation offset of the coordinate system is returned in rotation vector notation. The coordinate systems from the robot controller are loaded when the motion group associated with the coordinate system is activated. With deactivation of the motion group, the associated coordinate systems are removed from NOVA. The unique identifier of the coordinate systems from the robot controllers are suffixed with \"On\" + the unique identifier of the robot controller.
|
|
5171
5142
|
* @summary List Coordinate Systems
|
|
@@ -5260,15 +5231,6 @@ export declare const ControllerApiFp: (configuration?: Configuration) => {
|
|
|
5260
5231
|
* @throws {RequiredError}
|
|
5261
5232
|
*/
|
|
5262
5233
|
deleteRobotController(cell: string, controller: string, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
5263
|
-
/**
|
|
5264
|
-
* Get description of a configured robot controller including a list of connected motion group identifiers. Use [getMotionGroupDescription](getMotionGroupDescription) to get more information about the motion group.
|
|
5265
|
-
* @summary Description
|
|
5266
|
-
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5267
|
-
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
5268
|
-
* @param {*} [options] Override http request option.
|
|
5269
|
-
* @throws {RequiredError}
|
|
5270
|
-
*/
|
|
5271
|
-
getControllerDescription(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ControllerDescription>>;
|
|
5272
5234
|
/**
|
|
5273
5235
|
* Request a coordinate system specification for a given identifier. Use parameter orientation_type to get the orientation part of the transformation offset of the coordinate system returned in the requested orientation notation. If parameter orientation_type is not set, the orientation part of the transformation offset of the coordinate system is returned in rotation vector notation. The coordinate systems from the robot controller are loaded when the motion group associated with the coordinate system is activated. With deactivation of the motion group, the associated coordinate systems are removed from NOVA. The unique identifier of the coordinate systems from the robot controllers are suffixed with \"On\" + the unique identifier of the robot controller.
|
|
5274
5236
|
* @summary Coordinate System
|
|
@@ -5308,14 +5270,14 @@ export declare const ControllerApiFp: (configuration?: Configuration) => {
|
|
|
5308
5270
|
*/
|
|
5309
5271
|
getRobotController(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<RobotController>>;
|
|
5310
5272
|
/**
|
|
5311
|
-
* Receive
|
|
5312
|
-
* @summary Virtual
|
|
5273
|
+
* Receive the configuration for a virtual robot controller. Used to configure a virtual robot controller via [addRobotController](addRobotController). > **NOTE** > > The output generated by this endpoint can be too large for the site to handle, and may produce an error or incorrect output. > Use `curl` in combination with `> output.json` to capture the output, or use an API client like Postman.
|
|
5274
|
+
* @summary Virtual Robot Configuration
|
|
5313
5275
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5314
5276
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
5315
5277
|
* @param {*} [options] Override http request option.
|
|
5316
5278
|
* @throws {RequiredError}
|
|
5317
5279
|
*/
|
|
5318
|
-
|
|
5280
|
+
getVirtualRobotConfiguration(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<VirtualRobotConfiguration>>;
|
|
5319
5281
|
/**
|
|
5320
5282
|
* Lists all specifications of coordinate systems from robot controllers. Use parameter orientation_type to get the orientation part of the transformation offset of the coordinate system returned in the requested orientation notation. If parameter orientation_type is not set, the orientation part of the transformation offset of the coordinate system is returned in rotation vector notation. The coordinate systems from the robot controller are loaded when the motion group associated with the coordinate system is activated. With deactivation of the motion group, the associated coordinate systems are removed from NOVA. The unique identifier of the coordinate systems from the robot controllers are suffixed with \"On\" + the unique identifier of the robot controller.
|
|
5321
5283
|
* @summary List Coordinate Systems
|
|
@@ -5325,7 +5287,7 @@ export declare const ControllerApiFp: (configuration?: Configuration) => {
|
|
|
5325
5287
|
* @param {*} [options] Override http request option.
|
|
5326
5288
|
* @throws {RequiredError}
|
|
5327
5289
|
*/
|
|
5328
|
-
listCoordinateSystems(cell: string, controller: string, orientationType?: OrientationType, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<
|
|
5290
|
+
listCoordinateSystems(cell: string, controller: string, orientationType?: OrientationType, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListCoordinateSystemsResponse>>;
|
|
5329
5291
|
/**
|
|
5330
5292
|
* List the names of all deployed robot controllers.
|
|
5331
5293
|
* @summary List Robot Controllers
|
|
@@ -5410,15 +5372,6 @@ export declare const ControllerApiFactory: (configuration?: Configuration, baseP
|
|
|
5410
5372
|
* @throws {RequiredError}
|
|
5411
5373
|
*/
|
|
5412
5374
|
deleteRobotController(cell: string, controller: string, completionTimeout?: number, options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
5413
|
-
/**
|
|
5414
|
-
* Get description of a configured robot controller including a list of connected motion group identifiers. Use [getMotionGroupDescription](getMotionGroupDescription) to get more information about the motion group.
|
|
5415
|
-
* @summary Description
|
|
5416
|
-
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5417
|
-
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
5418
|
-
* @param {*} [options] Override http request option.
|
|
5419
|
-
* @throws {RequiredError}
|
|
5420
|
-
*/
|
|
5421
|
-
getControllerDescription(cell: string, controller: string, options?: RawAxiosRequestConfig): AxiosPromise<ControllerDescription>;
|
|
5422
5375
|
/**
|
|
5423
5376
|
* Request a coordinate system specification for a given identifier. Use parameter orientation_type to get the orientation part of the transformation offset of the coordinate system returned in the requested orientation notation. If parameter orientation_type is not set, the orientation part of the transformation offset of the coordinate system is returned in rotation vector notation. The coordinate systems from the robot controller are loaded when the motion group associated with the coordinate system is activated. With deactivation of the motion group, the associated coordinate systems are removed from NOVA. The unique identifier of the coordinate systems from the robot controllers are suffixed with \"On\" + the unique identifier of the robot controller.
|
|
5424
5377
|
* @summary Coordinate System
|
|
@@ -5458,14 +5411,14 @@ export declare const ControllerApiFactory: (configuration?: Configuration, baseP
|
|
|
5458
5411
|
*/
|
|
5459
5412
|
getRobotController(cell: string, controller: string, options?: RawAxiosRequestConfig): AxiosPromise<RobotController>;
|
|
5460
5413
|
/**
|
|
5461
|
-
* Receive
|
|
5462
|
-
* @summary Virtual
|
|
5414
|
+
* Receive the configuration for a virtual robot controller. Used to configure a virtual robot controller via [addRobotController](addRobotController). > **NOTE** > > The output generated by this endpoint can be too large for the site to handle, and may produce an error or incorrect output. > Use `curl` in combination with `> output.json` to capture the output, or use an API client like Postman.
|
|
5415
|
+
* @summary Virtual Robot Configuration
|
|
5463
5416
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5464
5417
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
5465
5418
|
* @param {*} [options] Override http request option.
|
|
5466
5419
|
* @throws {RequiredError}
|
|
5467
5420
|
*/
|
|
5468
|
-
|
|
5421
|
+
getVirtualRobotConfiguration(cell: string, controller: string, options?: RawAxiosRequestConfig): AxiosPromise<VirtualRobotConfiguration>;
|
|
5469
5422
|
/**
|
|
5470
5423
|
* Lists all specifications of coordinate systems from robot controllers. Use parameter orientation_type to get the orientation part of the transformation offset of the coordinate system returned in the requested orientation notation. If parameter orientation_type is not set, the orientation part of the transformation offset of the coordinate system is returned in rotation vector notation. The coordinate systems from the robot controller are loaded when the motion group associated with the coordinate system is activated. With deactivation of the motion group, the associated coordinate systems are removed from NOVA. The unique identifier of the coordinate systems from the robot controllers are suffixed with \"On\" + the unique identifier of the robot controller.
|
|
5471
5424
|
* @summary List Coordinate Systems
|
|
@@ -5475,7 +5428,7 @@ export declare const ControllerApiFactory: (configuration?: Configuration, baseP
|
|
|
5475
5428
|
* @param {*} [options] Override http request option.
|
|
5476
5429
|
* @throws {RequiredError}
|
|
5477
5430
|
*/
|
|
5478
|
-
listCoordinateSystems(cell: string, controller: string, orientationType?: OrientationType, options?: RawAxiosRequestConfig): AxiosPromise<
|
|
5431
|
+
listCoordinateSystems(cell: string, controller: string, orientationType?: OrientationType, options?: RawAxiosRequestConfig): AxiosPromise<ListCoordinateSystemsResponse>;
|
|
5479
5432
|
/**
|
|
5480
5433
|
* List the names of all deployed robot controllers.
|
|
5481
5434
|
* @summary List Robot Controllers
|
|
@@ -5565,16 +5518,6 @@ export declare class ControllerApi extends BaseAPI {
|
|
|
5565
5518
|
* @memberof ControllerApi
|
|
5566
5519
|
*/
|
|
5567
5520
|
deleteRobotController(cell: string, controller: string, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
5568
|
-
/**
|
|
5569
|
-
* Get description of a configured robot controller including a list of connected motion group identifiers. Use [getMotionGroupDescription](getMotionGroupDescription) to get more information about the motion group.
|
|
5570
|
-
* @summary Description
|
|
5571
|
-
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5572
|
-
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
5573
|
-
* @param {*} [options] Override http request option.
|
|
5574
|
-
* @throws {RequiredError}
|
|
5575
|
-
* @memberof ControllerApi
|
|
5576
|
-
*/
|
|
5577
|
-
getControllerDescription(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ControllerDescription, any>>;
|
|
5578
5521
|
/**
|
|
5579
5522
|
* Request a coordinate system specification for a given identifier. Use parameter orientation_type to get the orientation part of the transformation offset of the coordinate system returned in the requested orientation notation. If parameter orientation_type is not set, the orientation part of the transformation offset of the coordinate system is returned in rotation vector notation. The coordinate systems from the robot controller are loaded when the motion group associated with the coordinate system is activated. With deactivation of the motion group, the associated coordinate systems are removed from NOVA. The unique identifier of the coordinate systems from the robot controllers are suffixed with \"On\" + the unique identifier of the robot controller.
|
|
5580
5523
|
* @summary Coordinate System
|
|
@@ -5618,15 +5561,15 @@ export declare class ControllerApi extends BaseAPI {
|
|
|
5618
5561
|
*/
|
|
5619
5562
|
getRobotController(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<RobotController, any>>;
|
|
5620
5563
|
/**
|
|
5621
|
-
* Receive
|
|
5622
|
-
* @summary Virtual
|
|
5564
|
+
* Receive the configuration for a virtual robot controller. Used to configure a virtual robot controller via [addRobotController](addRobotController). > **NOTE** > > The output generated by this endpoint can be too large for the site to handle, and may produce an error or incorrect output. > Use `curl` in combination with `> output.json` to capture the output, or use an API client like Postman.
|
|
5565
|
+
* @summary Virtual Robot Configuration
|
|
5623
5566
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5624
5567
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
5625
5568
|
* @param {*} [options] Override http request option.
|
|
5626
5569
|
* @throws {RequiredError}
|
|
5627
5570
|
* @memberof ControllerApi
|
|
5628
5571
|
*/
|
|
5629
|
-
|
|
5572
|
+
getVirtualRobotConfiguration(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<VirtualRobotConfiguration, any>>;
|
|
5630
5573
|
/**
|
|
5631
5574
|
* Lists all specifications of coordinate systems from robot controllers. Use parameter orientation_type to get the orientation part of the transformation offset of the coordinate system returned in the requested orientation notation. If parameter orientation_type is not set, the orientation part of the transformation offset of the coordinate system is returned in rotation vector notation. The coordinate systems from the robot controller are loaded when the motion group associated with the coordinate system is activated. With deactivation of the motion group, the associated coordinate systems are removed from NOVA. The unique identifier of the coordinate systems from the robot controllers are suffixed with \"On\" + the unique identifier of the robot controller.
|
|
5632
5575
|
* @summary List Coordinate Systems
|
|
@@ -5637,7 +5580,7 @@ export declare class ControllerApi extends BaseAPI {
|
|
|
5637
5580
|
* @throws {RequiredError}
|
|
5638
5581
|
* @memberof ControllerApi
|
|
5639
5582
|
*/
|
|
5640
|
-
listCoordinateSystems(cell: string, controller: string, orientationType?: OrientationType, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<
|
|
5583
|
+
listCoordinateSystems(cell: string, controller: string, orientationType?: OrientationType, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ListCoordinateSystemsResponse, any>>;
|
|
5641
5584
|
/**
|
|
5642
5585
|
* List the names of all deployed robot controllers.
|
|
5643
5586
|
* @summary List Robot Controllers
|
|
@@ -5945,12 +5888,11 @@ export declare const JoggingApiAxiosParamCreator: (configuration?: Configuration
|
|
|
5945
5888
|
* <!-- theme: danger --> > Websocket endpoint Provides execution control over a dynamically adaptable jogging motion for a motion group. Jogging describes controlling a motion group by sending real-time commands to move either its joints or the TCP (Tool Center Point). The commands contain target velocities that may change at any time during execution, so the resulting motion cannot be computed upfront. ### Preconditions The motion group is not moved by any other endpoint. ### Requests #### 1. Send InitializeJoggingRequest to configure the jogging. Sets robot controller mode to control mode. Sets rate and coordinate system for the jogging response. #### 2. Send JointVelocityRequest or TcpVelocityRequest to start the jogging motion. #### 3. Change or stop the jogging motion - Change the jogging direction and/or velocity during the jogging motion with JointVelocityRequest or TcpVelocityRequest. - To stop the jogging motion, send zero velocities via either request. ### Responses - InitializeJoggingResponse is sent to signal the success or failure of the InitializeJoggingRequest. - Jogging responses are streamed continuously after an InitializeJoggingRequest is processed. Jogging responses contain the robot controller state and the state of the jogging control. - JoggingErrorResponse with error details is sent in case of an unexpected error, e.g., controller disconnects during jogging. ### Tips and Tricks - In the JoggingResponse, verify that the robot control is in the desired state, e.g. standstill, with JoggingState. - Ensure that the websocket connection remains open until the jogging motion is stopped to avoid unexpected stops.
|
|
5946
5889
|
* @summary Execute Jogging
|
|
5947
5890
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5948
|
-
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
5949
5891
|
* @param {ExecuteJoggingRequest} executeJoggingRequest
|
|
5950
5892
|
* @param {*} [options] Override http request option.
|
|
5951
5893
|
* @throws {RequiredError}
|
|
5952
5894
|
*/
|
|
5953
|
-
executeJogging: (cell: string,
|
|
5895
|
+
executeJogging: (cell: string, executeJoggingRequest: ExecuteJoggingRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
5954
5896
|
};
|
|
5955
5897
|
/**
|
|
5956
5898
|
* JoggingApi - functional programming interface
|
|
@@ -5961,12 +5903,11 @@ export declare const JoggingApiFp: (configuration?: Configuration) => {
|
|
|
5961
5903
|
* <!-- theme: danger --> > Websocket endpoint Provides execution control over a dynamically adaptable jogging motion for a motion group. Jogging describes controlling a motion group by sending real-time commands to move either its joints or the TCP (Tool Center Point). The commands contain target velocities that may change at any time during execution, so the resulting motion cannot be computed upfront. ### Preconditions The motion group is not moved by any other endpoint. ### Requests #### 1. Send InitializeJoggingRequest to configure the jogging. Sets robot controller mode to control mode. Sets rate and coordinate system for the jogging response. #### 2. Send JointVelocityRequest or TcpVelocityRequest to start the jogging motion. #### 3. Change or stop the jogging motion - Change the jogging direction and/or velocity during the jogging motion with JointVelocityRequest or TcpVelocityRequest. - To stop the jogging motion, send zero velocities via either request. ### Responses - InitializeJoggingResponse is sent to signal the success or failure of the InitializeJoggingRequest. - Jogging responses are streamed continuously after an InitializeJoggingRequest is processed. Jogging responses contain the robot controller state and the state of the jogging control. - JoggingErrorResponse with error details is sent in case of an unexpected error, e.g., controller disconnects during jogging. ### Tips and Tricks - In the JoggingResponse, verify that the robot control is in the desired state, e.g. standstill, with JoggingState. - Ensure that the websocket connection remains open until the jogging motion is stopped to avoid unexpected stops.
|
|
5962
5904
|
* @summary Execute Jogging
|
|
5963
5905
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5964
|
-
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
5965
5906
|
* @param {ExecuteJoggingRequest} executeJoggingRequest
|
|
5966
5907
|
* @param {*} [options] Override http request option.
|
|
5967
5908
|
* @throws {RequiredError}
|
|
5968
5909
|
*/
|
|
5969
|
-
executeJogging(cell: string,
|
|
5910
|
+
executeJogging(cell: string, executeJoggingRequest: ExecuteJoggingRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ExecuteJoggingResponse>>;
|
|
5970
5911
|
};
|
|
5971
5912
|
/**
|
|
5972
5913
|
* JoggingApi - factory interface
|
|
@@ -5977,12 +5918,11 @@ export declare const JoggingApiFactory: (configuration?: Configuration, basePath
|
|
|
5977
5918
|
* <!-- theme: danger --> > Websocket endpoint Provides execution control over a dynamically adaptable jogging motion for a motion group. Jogging describes controlling a motion group by sending real-time commands to move either its joints or the TCP (Tool Center Point). The commands contain target velocities that may change at any time during execution, so the resulting motion cannot be computed upfront. ### Preconditions The motion group is not moved by any other endpoint. ### Requests #### 1. Send InitializeJoggingRequest to configure the jogging. Sets robot controller mode to control mode. Sets rate and coordinate system for the jogging response. #### 2. Send JointVelocityRequest or TcpVelocityRequest to start the jogging motion. #### 3. Change or stop the jogging motion - Change the jogging direction and/or velocity during the jogging motion with JointVelocityRequest or TcpVelocityRequest. - To stop the jogging motion, send zero velocities via either request. ### Responses - InitializeJoggingResponse is sent to signal the success or failure of the InitializeJoggingRequest. - Jogging responses are streamed continuously after an InitializeJoggingRequest is processed. Jogging responses contain the robot controller state and the state of the jogging control. - JoggingErrorResponse with error details is sent in case of an unexpected error, e.g., controller disconnects during jogging. ### Tips and Tricks - In the JoggingResponse, verify that the robot control is in the desired state, e.g. standstill, with JoggingState. - Ensure that the websocket connection remains open until the jogging motion is stopped to avoid unexpected stops.
|
|
5978
5919
|
* @summary Execute Jogging
|
|
5979
5920
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5980
|
-
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
5981
5921
|
* @param {ExecuteJoggingRequest} executeJoggingRequest
|
|
5982
5922
|
* @param {*} [options] Override http request option.
|
|
5983
5923
|
* @throws {RequiredError}
|
|
5984
5924
|
*/
|
|
5985
|
-
executeJogging(cell: string,
|
|
5925
|
+
executeJogging(cell: string, executeJoggingRequest: ExecuteJoggingRequest, options?: RawAxiosRequestConfig): AxiosPromise<ExecuteJoggingResponse>;
|
|
5986
5926
|
};
|
|
5987
5927
|
/**
|
|
5988
5928
|
* JoggingApi - object-oriented interface
|
|
@@ -5995,13 +5935,12 @@ export declare class JoggingApi extends BaseAPI {
|
|
|
5995
5935
|
* <!-- theme: danger --> > Websocket endpoint Provides execution control over a dynamically adaptable jogging motion for a motion group. Jogging describes controlling a motion group by sending real-time commands to move either its joints or the TCP (Tool Center Point). The commands contain target velocities that may change at any time during execution, so the resulting motion cannot be computed upfront. ### Preconditions The motion group is not moved by any other endpoint. ### Requests #### 1. Send InitializeJoggingRequest to configure the jogging. Sets robot controller mode to control mode. Sets rate and coordinate system for the jogging response. #### 2. Send JointVelocityRequest or TcpVelocityRequest to start the jogging motion. #### 3. Change or stop the jogging motion - Change the jogging direction and/or velocity during the jogging motion with JointVelocityRequest or TcpVelocityRequest. - To stop the jogging motion, send zero velocities via either request. ### Responses - InitializeJoggingResponse is sent to signal the success or failure of the InitializeJoggingRequest. - Jogging responses are streamed continuously after an InitializeJoggingRequest is processed. Jogging responses contain the robot controller state and the state of the jogging control. - JoggingErrorResponse with error details is sent in case of an unexpected error, e.g., controller disconnects during jogging. ### Tips and Tricks - In the JoggingResponse, verify that the robot control is in the desired state, e.g. standstill, with JoggingState. - Ensure that the websocket connection remains open until the jogging motion is stopped to avoid unexpected stops.
|
|
5996
5936
|
* @summary Execute Jogging
|
|
5997
5937
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5998
|
-
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
5999
5938
|
* @param {ExecuteJoggingRequest} executeJoggingRequest
|
|
6000
5939
|
* @param {*} [options] Override http request option.
|
|
6001
5940
|
* @throws {RequiredError}
|
|
6002
5941
|
* @memberof JoggingApi
|
|
6003
5942
|
*/
|
|
6004
|
-
executeJogging(cell: string,
|
|
5943
|
+
executeJogging(cell: string, executeJoggingRequest: ExecuteJoggingRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ExecuteJoggingResponse, any>>;
|
|
6005
5944
|
}
|
|
6006
5945
|
/**
|
|
6007
5946
|
* KinematicsApi - axios parameter creator
|
|
@@ -6221,35 +6160,32 @@ export declare const MotionGroupApiAxiosParamCreator: (configuration?: Configura
|
|
|
6221
6160
|
* Returns the current state of the selected motion group including the current joint position, velocity, pose, and more.
|
|
6222
6161
|
* @summary State
|
|
6223
6162
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
6224
|
-
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
6225
6163
|
* @param {string} motionGroup The motion-group identifier.
|
|
6226
6164
|
* @param {string} [responseCoordinateSystem] Unique identifier addressing a coordinate system to which the responses should be converted. If not set, world coordinate system is used.
|
|
6227
6165
|
* @param {*} [options] Override http request option.
|
|
6228
6166
|
* @throws {RequiredError}
|
|
6229
6167
|
*/
|
|
6230
|
-
getCurrentMotionGroupState: (cell: string,
|
|
6168
|
+
getCurrentMotionGroupState: (cell: string, motionGroup: string, responseCoordinateSystem?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
6231
6169
|
/**
|
|
6232
6170
|
* Get the set of parameters that describe the motion group and its configuration including safety zones, limits, etc. This data might change upon connection to the robot.
|
|
6233
6171
|
* @summary Description
|
|
6234
6172
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
6235
|
-
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
6236
6173
|
* @param {string} motionGroup The motion-group identifier.
|
|
6237
6174
|
* @param {*} [options] Override http request option.
|
|
6238
6175
|
* @throws {RequiredError}
|
|
6239
6176
|
*/
|
|
6240
|
-
getMotionGroupDescription: (cell: string,
|
|
6177
|
+
getMotionGroupDescription: (cell: string, motionGroup: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
6241
6178
|
/**
|
|
6242
6179
|
* <!-- theme: danger --> > Websocket endpoint Receive updates of the motion group state. The stream will be closed from the server if the controller is disconnected.
|
|
6243
6180
|
* @summary Stream State
|
|
6244
6181
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
6245
|
-
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
6246
6182
|
* @param {string} motionGroup The motion-group identifier.
|
|
6247
6183
|
* @param {number} [responseRate] Update rate for the response message in milliseconds (ms). Default is 200 ms. We recommend to use the step rate of the controller or a multiple of the step rate as NOVA updates the state in the controller\'s step rate as well. Minimal response rate is the step rate of controller.
|
|
6248
6184
|
* @param {string} [responseCoordinateSystem] Unique identifier addressing a coordinate system to which the cartesian data of the responses should be converted. Default is the world coordinate system.
|
|
6249
6185
|
* @param {*} [options] Override http request option.
|
|
6250
6186
|
* @throws {RequiredError}
|
|
6251
6187
|
*/
|
|
6252
|
-
streamMotionGroupState: (cell: string,
|
|
6188
|
+
streamMotionGroupState: (cell: string, motionGroup: string, responseRate?: number, responseCoordinateSystem?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
6253
6189
|
};
|
|
6254
6190
|
/**
|
|
6255
6191
|
* MotionGroupApi - functional programming interface
|
|
@@ -6260,35 +6196,32 @@ export declare const MotionGroupApiFp: (configuration?: Configuration) => {
|
|
|
6260
6196
|
* Returns the current state of the selected motion group including the current joint position, velocity, pose, and more.
|
|
6261
6197
|
* @summary State
|
|
6262
6198
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
6263
|
-
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
6264
6199
|
* @param {string} motionGroup The motion-group identifier.
|
|
6265
6200
|
* @param {string} [responseCoordinateSystem] Unique identifier addressing a coordinate system to which the responses should be converted. If not set, world coordinate system is used.
|
|
6266
6201
|
* @param {*} [options] Override http request option.
|
|
6267
6202
|
* @throws {RequiredError}
|
|
6268
6203
|
*/
|
|
6269
|
-
getCurrentMotionGroupState(cell: string,
|
|
6204
|
+
getCurrentMotionGroupState(cell: string, motionGroup: string, responseCoordinateSystem?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<MotionGroupState>>;
|
|
6270
6205
|
/**
|
|
6271
6206
|
* Get the set of parameters that describe the motion group and its configuration including safety zones, limits, etc. This data might change upon connection to the robot.
|
|
6272
6207
|
* @summary Description
|
|
6273
6208
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
6274
|
-
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
6275
6209
|
* @param {string} motionGroup The motion-group identifier.
|
|
6276
6210
|
* @param {*} [options] Override http request option.
|
|
6277
6211
|
* @throws {RequiredError}
|
|
6278
6212
|
*/
|
|
6279
|
-
getMotionGroupDescription(cell: string,
|
|
6213
|
+
getMotionGroupDescription(cell: string, motionGroup: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<MotionGroupDescription>>;
|
|
6280
6214
|
/**
|
|
6281
6215
|
* <!-- theme: danger --> > Websocket endpoint Receive updates of the motion group state. The stream will be closed from the server if the controller is disconnected.
|
|
6282
6216
|
* @summary Stream State
|
|
6283
6217
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
6284
|
-
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
6285
6218
|
* @param {string} motionGroup The motion-group identifier.
|
|
6286
6219
|
* @param {number} [responseRate] Update rate for the response message in milliseconds (ms). Default is 200 ms. We recommend to use the step rate of the controller or a multiple of the step rate as NOVA updates the state in the controller\'s step rate as well. Minimal response rate is the step rate of controller.
|
|
6287
6220
|
* @param {string} [responseCoordinateSystem] Unique identifier addressing a coordinate system to which the cartesian data of the responses should be converted. Default is the world coordinate system.
|
|
6288
6221
|
* @param {*} [options] Override http request option.
|
|
6289
6222
|
* @throws {RequiredError}
|
|
6290
6223
|
*/
|
|
6291
|
-
streamMotionGroupState(cell: string,
|
|
6224
|
+
streamMotionGroupState(cell: string, motionGroup: string, responseRate?: number, responseCoordinateSystem?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<MotionGroupState>>;
|
|
6292
6225
|
};
|
|
6293
6226
|
/**
|
|
6294
6227
|
* MotionGroupApi - factory interface
|
|
@@ -6299,35 +6232,32 @@ export declare const MotionGroupApiFactory: (configuration?: Configuration, base
|
|
|
6299
6232
|
* Returns the current state of the selected motion group including the current joint position, velocity, pose, and more.
|
|
6300
6233
|
* @summary State
|
|
6301
6234
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
6302
|
-
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
6303
6235
|
* @param {string} motionGroup The motion-group identifier.
|
|
6304
6236
|
* @param {string} [responseCoordinateSystem] Unique identifier addressing a coordinate system to which the responses should be converted. If not set, world coordinate system is used.
|
|
6305
6237
|
* @param {*} [options] Override http request option.
|
|
6306
6238
|
* @throws {RequiredError}
|
|
6307
6239
|
*/
|
|
6308
|
-
getCurrentMotionGroupState(cell: string,
|
|
6240
|
+
getCurrentMotionGroupState(cell: string, motionGroup: string, responseCoordinateSystem?: string, options?: RawAxiosRequestConfig): AxiosPromise<MotionGroupState>;
|
|
6309
6241
|
/**
|
|
6310
6242
|
* Get the set of parameters that describe the motion group and its configuration including safety zones, limits, etc. This data might change upon connection to the robot.
|
|
6311
6243
|
* @summary Description
|
|
6312
6244
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
6313
|
-
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
6314
6245
|
* @param {string} motionGroup The motion-group identifier.
|
|
6315
6246
|
* @param {*} [options] Override http request option.
|
|
6316
6247
|
* @throws {RequiredError}
|
|
6317
6248
|
*/
|
|
6318
|
-
getMotionGroupDescription(cell: string,
|
|
6249
|
+
getMotionGroupDescription(cell: string, motionGroup: string, options?: RawAxiosRequestConfig): AxiosPromise<MotionGroupDescription>;
|
|
6319
6250
|
/**
|
|
6320
6251
|
* <!-- theme: danger --> > Websocket endpoint Receive updates of the motion group state. The stream will be closed from the server if the controller is disconnected.
|
|
6321
6252
|
* @summary Stream State
|
|
6322
6253
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
6323
|
-
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
6324
6254
|
* @param {string} motionGroup The motion-group identifier.
|
|
6325
6255
|
* @param {number} [responseRate] Update rate for the response message in milliseconds (ms). Default is 200 ms. We recommend to use the step rate of the controller or a multiple of the step rate as NOVA updates the state in the controller\'s step rate as well. Minimal response rate is the step rate of controller.
|
|
6326
6256
|
* @param {string} [responseCoordinateSystem] Unique identifier addressing a coordinate system to which the cartesian data of the responses should be converted. Default is the world coordinate system.
|
|
6327
6257
|
* @param {*} [options] Override http request option.
|
|
6328
6258
|
* @throws {RequiredError}
|
|
6329
6259
|
*/
|
|
6330
|
-
streamMotionGroupState(cell: string,
|
|
6260
|
+
streamMotionGroupState(cell: string, motionGroup: string, responseRate?: number, responseCoordinateSystem?: string, options?: RawAxiosRequestConfig): AxiosPromise<MotionGroupState>;
|
|
6331
6261
|
};
|
|
6332
6262
|
/**
|
|
6333
6263
|
* MotionGroupApi - object-oriented interface
|
|
@@ -6340,30 +6270,27 @@ export declare class MotionGroupApi extends BaseAPI {
|
|
|
6340
6270
|
* Returns the current state of the selected motion group including the current joint position, velocity, pose, and more.
|
|
6341
6271
|
* @summary State
|
|
6342
6272
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
6343
|
-
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
6344
6273
|
* @param {string} motionGroup The motion-group identifier.
|
|
6345
6274
|
* @param {string} [responseCoordinateSystem] Unique identifier addressing a coordinate system to which the responses should be converted. If not set, world coordinate system is used.
|
|
6346
6275
|
* @param {*} [options] Override http request option.
|
|
6347
6276
|
* @throws {RequiredError}
|
|
6348
6277
|
* @memberof MotionGroupApi
|
|
6349
6278
|
*/
|
|
6350
|
-
getCurrentMotionGroupState(cell: string,
|
|
6279
|
+
getCurrentMotionGroupState(cell: string, motionGroup: string, responseCoordinateSystem?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<MotionGroupState, any>>;
|
|
6351
6280
|
/**
|
|
6352
6281
|
* Get the set of parameters that describe the motion group and its configuration including safety zones, limits, etc. This data might change upon connection to the robot.
|
|
6353
6282
|
* @summary Description
|
|
6354
6283
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
6355
|
-
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
6356
6284
|
* @param {string} motionGroup The motion-group identifier.
|
|
6357
6285
|
* @param {*} [options] Override http request option.
|
|
6358
6286
|
* @throws {RequiredError}
|
|
6359
6287
|
* @memberof MotionGroupApi
|
|
6360
6288
|
*/
|
|
6361
|
-
getMotionGroupDescription(cell: string,
|
|
6289
|
+
getMotionGroupDescription(cell: string, motionGroup: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<MotionGroupDescription, any>>;
|
|
6362
6290
|
/**
|
|
6363
6291
|
* <!-- theme: danger --> > Websocket endpoint Receive updates of the motion group state. The stream will be closed from the server if the controller is disconnected.
|
|
6364
6292
|
* @summary Stream State
|
|
6365
6293
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
6366
|
-
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
6367
6294
|
* @param {string} motionGroup The motion-group identifier.
|
|
6368
6295
|
* @param {number} [responseRate] Update rate for the response message in milliseconds (ms). Default is 200 ms. We recommend to use the step rate of the controller or a multiple of the step rate as NOVA updates the state in the controller\'s step rate as well. Minimal response rate is the step rate of controller.
|
|
6369
6296
|
* @param {string} [responseCoordinateSystem] Unique identifier addressing a coordinate system to which the cartesian data of the responses should be converted. Default is the world coordinate system.
|
|
@@ -6371,7 +6298,7 @@ export declare class MotionGroupApi extends BaseAPI {
|
|
|
6371
6298
|
* @throws {RequiredError}
|
|
6372
6299
|
* @memberof MotionGroupApi
|
|
6373
6300
|
*/
|
|
6374
|
-
streamMotionGroupState(cell: string,
|
|
6301
|
+
streamMotionGroupState(cell: string, motionGroup: string, responseRate?: number, responseCoordinateSystem?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<MotionGroupState, any>>;
|
|
6375
6302
|
}
|
|
6376
6303
|
/**
|
|
6377
6304
|
* MotionGroupModelsApi - axios parameter creator
|
|
@@ -7783,50 +7710,45 @@ export declare const TrajectoryCachingApiAxiosParamCreator: (configuration?: Con
|
|
|
7783
7710
|
* <!-- theme: info --> > Using the trajectory cache is an optional performance optimization. It is not necessary to use the cache to execute trajectories. Loads and validates the data of a trajectory into the execution cache, rendering the trajectory executable. The response contains the result of the validation of the trajectory. Validation can lead to three different results: - Fully valid: The whole trajectory can be executed from start to end. The response will contain an unique identifier which is used to move the robot. - Partially valid: Only parts of the trajectory can be executed. The response will contain an unique identifier to move the robot and information about the failure for the part that is not executable. - Invalid: The trajectory can not be executed. The response will tell you the reason of failure. If the trajectory is at least partially valid, the parts of the trajectory that are valid can be executed using the [executeTrajectory](executeTrajectory) endpoint. The workflow is as follows: - Generate a trajectory with [planTrajectory](planTrajectory) or your own motion planner, - Send the trajectory to this endpoint to validate it and get a unique identifier for it, - The unique identifier will appear in the list of available trajectories, see [listTrajectories](listTrajectories) endpoint, if it is at least partially executable. - Execute your trajectory using the [executeTrajectory](executeTrajectory) endpoint.
|
|
7784
7711
|
* @summary Add Trajectory
|
|
7785
7712
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
7786
|
-
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
7787
7713
|
* @param {AddTrajectoryRequest} addTrajectoryRequest
|
|
7788
7714
|
* @param {*} [options] Override http request option.
|
|
7789
7715
|
* @throws {RequiredError}
|
|
7790
7716
|
*/
|
|
7791
|
-
addTrajectory: (cell: string,
|
|
7717
|
+
addTrajectory: (cell: string, addTrajectoryRequest: AddTrajectoryRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
7792
7718
|
/**
|
|
7793
7719
|
* Clear the trajectory cache.
|
|
7794
7720
|
* @summary Clear Trajectories
|
|
7795
7721
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
7796
|
-
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
7797
7722
|
* @param {*} [options] Override http request option.
|
|
7798
7723
|
* @throws {RequiredError}
|
|
7799
7724
|
*/
|
|
7800
|
-
clearTrajectories: (cell: string,
|
|
7725
|
+
clearTrajectories: (cell: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
7801
7726
|
/**
|
|
7802
7727
|
* Delete a previously created trajectory from cache. Use [listTrajectories](listTrajectories) to list all cached trajectories. Trajectories are removed automatically if the motion group or the corresponding controller is disconnected.
|
|
7803
7728
|
* @summary Delete Trajectory
|
|
7804
7729
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
7805
|
-
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
7806
7730
|
* @param {string} trajectory This represents the unique identifier of a trajectory. Every executable or partially executable trajectory is cached and an unique identifier is returned. Indicate the unique identifier to execute the trajectory or retrieve information on the trajectory.
|
|
7807
7731
|
* @param {*} [options] Override http request option.
|
|
7808
7732
|
* @throws {RequiredError}
|
|
7809
7733
|
*/
|
|
7810
|
-
deleteTrajectory: (cell: string,
|
|
7734
|
+
deleteTrajectory: (cell: string, trajectory: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
7811
7735
|
/**
|
|
7812
7736
|
* Get a previously created trajectory from cache. Use [listTrajectories](listTrajectories) to list all cached trajectories.
|
|
7813
7737
|
* @summary Get Trajectory
|
|
7814
7738
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
7815
|
-
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
7816
7739
|
* @param {string} trajectory This represents the unique identifier of a trajectory. Every executable or partially executable trajectory is cached and an unique identifier is returned. Indicate the unique identifier to execute the trajectory or retrieve information on the trajectory.
|
|
7817
7740
|
* @param {*} [options] Override http request option.
|
|
7818
7741
|
* @throws {RequiredError}
|
|
7819
7742
|
*/
|
|
7820
|
-
getTrajectory: (cell: string,
|
|
7743
|
+
getTrajectory: (cell: string, trajectory: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
7821
7744
|
/**
|
|
7822
7745
|
* List currently cached trajectories. Use [addTrajectory](addTrajectory) to add a new trajectory. Adding trajectories is necessary to execute them. Trajectories are removed if the corresponding motion group or controller disconnects.
|
|
7823
7746
|
* @summary List Trajectories
|
|
7824
7747
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
7825
|
-
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
7826
7748
|
* @param {*} [options] Override http request option.
|
|
7827
7749
|
* @throws {RequiredError}
|
|
7828
7750
|
*/
|
|
7829
|
-
listTrajectories: (cell: string,
|
|
7751
|
+
listTrajectories: (cell: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
7830
7752
|
};
|
|
7831
7753
|
/**
|
|
7832
7754
|
* TrajectoryCachingApi - functional programming interface
|
|
@@ -7837,50 +7759,45 @@ export declare const TrajectoryCachingApiFp: (configuration?: Configuration) =>
|
|
|
7837
7759
|
* <!-- theme: info --> > Using the trajectory cache is an optional performance optimization. It is not necessary to use the cache to execute trajectories. Loads and validates the data of a trajectory into the execution cache, rendering the trajectory executable. The response contains the result of the validation of the trajectory. Validation can lead to three different results: - Fully valid: The whole trajectory can be executed from start to end. The response will contain an unique identifier which is used to move the robot. - Partially valid: Only parts of the trajectory can be executed. The response will contain an unique identifier to move the robot and information about the failure for the part that is not executable. - Invalid: The trajectory can not be executed. The response will tell you the reason of failure. If the trajectory is at least partially valid, the parts of the trajectory that are valid can be executed using the [executeTrajectory](executeTrajectory) endpoint. The workflow is as follows: - Generate a trajectory with [planTrajectory](planTrajectory) or your own motion planner, - Send the trajectory to this endpoint to validate it and get a unique identifier for it, - The unique identifier will appear in the list of available trajectories, see [listTrajectories](listTrajectories) endpoint, if it is at least partially executable. - Execute your trajectory using the [executeTrajectory](executeTrajectory) endpoint.
|
|
7838
7760
|
* @summary Add Trajectory
|
|
7839
7761
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
7840
|
-
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
7841
7762
|
* @param {AddTrajectoryRequest} addTrajectoryRequest
|
|
7842
7763
|
* @param {*} [options] Override http request option.
|
|
7843
7764
|
* @throws {RequiredError}
|
|
7844
7765
|
*/
|
|
7845
|
-
addTrajectory(cell: string,
|
|
7766
|
+
addTrajectory(cell: string, addTrajectoryRequest: AddTrajectoryRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AddTrajectoryResponse>>;
|
|
7846
7767
|
/**
|
|
7847
7768
|
* Clear the trajectory cache.
|
|
7848
7769
|
* @summary Clear Trajectories
|
|
7849
7770
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
7850
|
-
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
7851
7771
|
* @param {*} [options] Override http request option.
|
|
7852
7772
|
* @throws {RequiredError}
|
|
7853
7773
|
*/
|
|
7854
|
-
clearTrajectories(cell: string,
|
|
7774
|
+
clearTrajectories(cell: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
7855
7775
|
/**
|
|
7856
7776
|
* Delete a previously created trajectory from cache. Use [listTrajectories](listTrajectories) to list all cached trajectories. Trajectories are removed automatically if the motion group or the corresponding controller is disconnected.
|
|
7857
7777
|
* @summary Delete Trajectory
|
|
7858
7778
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
7859
|
-
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
7860
7779
|
* @param {string} trajectory This represents the unique identifier of a trajectory. Every executable or partially executable trajectory is cached and an unique identifier is returned. Indicate the unique identifier to execute the trajectory or retrieve information on the trajectory.
|
|
7861
7780
|
* @param {*} [options] Override http request option.
|
|
7862
7781
|
* @throws {RequiredError}
|
|
7863
7782
|
*/
|
|
7864
|
-
deleteTrajectory(cell: string,
|
|
7783
|
+
deleteTrajectory(cell: string, trajectory: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
7865
7784
|
/**
|
|
7866
7785
|
* Get a previously created trajectory from cache. Use [listTrajectories](listTrajectories) to list all cached trajectories.
|
|
7867
7786
|
* @summary Get Trajectory
|
|
7868
7787
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
7869
|
-
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
7870
7788
|
* @param {string} trajectory This represents the unique identifier of a trajectory. Every executable or partially executable trajectory is cached and an unique identifier is returned. Indicate the unique identifier to execute the trajectory or retrieve information on the trajectory.
|
|
7871
7789
|
* @param {*} [options] Override http request option.
|
|
7872
7790
|
* @throws {RequiredError}
|
|
7873
7791
|
*/
|
|
7874
|
-
getTrajectory(cell: string,
|
|
7792
|
+
getTrajectory(cell: string, trajectory: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetTrajectoryResponse>>;
|
|
7875
7793
|
/**
|
|
7876
7794
|
* List currently cached trajectories. Use [addTrajectory](addTrajectory) to add a new trajectory. Adding trajectories is necessary to execute them. Trajectories are removed if the corresponding motion group or controller disconnects.
|
|
7877
7795
|
* @summary List Trajectories
|
|
7878
7796
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
7879
|
-
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
7880
7797
|
* @param {*} [options] Override http request option.
|
|
7881
7798
|
* @throws {RequiredError}
|
|
7882
7799
|
*/
|
|
7883
|
-
listTrajectories(cell: string,
|
|
7800
|
+
listTrajectories(cell: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListTrajectoriesResponse>>;
|
|
7884
7801
|
};
|
|
7885
7802
|
/**
|
|
7886
7803
|
* TrajectoryCachingApi - factory interface
|
|
@@ -7891,50 +7808,45 @@ export declare const TrajectoryCachingApiFactory: (configuration?: Configuration
|
|
|
7891
7808
|
* <!-- theme: info --> > Using the trajectory cache is an optional performance optimization. It is not necessary to use the cache to execute trajectories. Loads and validates the data of a trajectory into the execution cache, rendering the trajectory executable. The response contains the result of the validation of the trajectory. Validation can lead to three different results: - Fully valid: The whole trajectory can be executed from start to end. The response will contain an unique identifier which is used to move the robot. - Partially valid: Only parts of the trajectory can be executed. The response will contain an unique identifier to move the robot and information about the failure for the part that is not executable. - Invalid: The trajectory can not be executed. The response will tell you the reason of failure. If the trajectory is at least partially valid, the parts of the trajectory that are valid can be executed using the [executeTrajectory](executeTrajectory) endpoint. The workflow is as follows: - Generate a trajectory with [planTrajectory](planTrajectory) or your own motion planner, - Send the trajectory to this endpoint to validate it and get a unique identifier for it, - The unique identifier will appear in the list of available trajectories, see [listTrajectories](listTrajectories) endpoint, if it is at least partially executable. - Execute your trajectory using the [executeTrajectory](executeTrajectory) endpoint.
|
|
7892
7809
|
* @summary Add Trajectory
|
|
7893
7810
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
7894
|
-
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
7895
7811
|
* @param {AddTrajectoryRequest} addTrajectoryRequest
|
|
7896
7812
|
* @param {*} [options] Override http request option.
|
|
7897
7813
|
* @throws {RequiredError}
|
|
7898
7814
|
*/
|
|
7899
|
-
addTrajectory(cell: string,
|
|
7815
|
+
addTrajectory(cell: string, addTrajectoryRequest: AddTrajectoryRequest, options?: RawAxiosRequestConfig): AxiosPromise<AddTrajectoryResponse>;
|
|
7900
7816
|
/**
|
|
7901
7817
|
* Clear the trajectory cache.
|
|
7902
7818
|
* @summary Clear Trajectories
|
|
7903
7819
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
7904
|
-
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
7905
7820
|
* @param {*} [options] Override http request option.
|
|
7906
7821
|
* @throws {RequiredError}
|
|
7907
7822
|
*/
|
|
7908
|
-
clearTrajectories(cell: string,
|
|
7823
|
+
clearTrajectories(cell: string, options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
7909
7824
|
/**
|
|
7910
7825
|
* Delete a previously created trajectory from cache. Use [listTrajectories](listTrajectories) to list all cached trajectories. Trajectories are removed automatically if the motion group or the corresponding controller is disconnected.
|
|
7911
7826
|
* @summary Delete Trajectory
|
|
7912
7827
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
7913
|
-
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
7914
7828
|
* @param {string} trajectory This represents the unique identifier of a trajectory. Every executable or partially executable trajectory is cached and an unique identifier is returned. Indicate the unique identifier to execute the trajectory or retrieve information on the trajectory.
|
|
7915
7829
|
* @param {*} [options] Override http request option.
|
|
7916
7830
|
* @throws {RequiredError}
|
|
7917
7831
|
*/
|
|
7918
|
-
deleteTrajectory(cell: string,
|
|
7832
|
+
deleteTrajectory(cell: string, trajectory: string, options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
7919
7833
|
/**
|
|
7920
7834
|
* Get a previously created trajectory from cache. Use [listTrajectories](listTrajectories) to list all cached trajectories.
|
|
7921
7835
|
* @summary Get Trajectory
|
|
7922
7836
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
7923
|
-
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
7924
7837
|
* @param {string} trajectory This represents the unique identifier of a trajectory. Every executable or partially executable trajectory is cached and an unique identifier is returned. Indicate the unique identifier to execute the trajectory or retrieve information on the trajectory.
|
|
7925
7838
|
* @param {*} [options] Override http request option.
|
|
7926
7839
|
* @throws {RequiredError}
|
|
7927
7840
|
*/
|
|
7928
|
-
getTrajectory(cell: string,
|
|
7841
|
+
getTrajectory(cell: string, trajectory: string, options?: RawAxiosRequestConfig): AxiosPromise<GetTrajectoryResponse>;
|
|
7929
7842
|
/**
|
|
7930
7843
|
* List currently cached trajectories. Use [addTrajectory](addTrajectory) to add a new trajectory. Adding trajectories is necessary to execute them. Trajectories are removed if the corresponding motion group or controller disconnects.
|
|
7931
7844
|
* @summary List Trajectories
|
|
7932
7845
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
7933
|
-
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
7934
7846
|
* @param {*} [options] Override http request option.
|
|
7935
7847
|
* @throws {RequiredError}
|
|
7936
7848
|
*/
|
|
7937
|
-
listTrajectories(cell: string,
|
|
7849
|
+
listTrajectories(cell: string, options?: RawAxiosRequestConfig): AxiosPromise<ListTrajectoriesResponse>;
|
|
7938
7850
|
};
|
|
7939
7851
|
/**
|
|
7940
7852
|
* TrajectoryCachingApi - object-oriented interface
|
|
@@ -7947,55 +7859,50 @@ export declare class TrajectoryCachingApi extends BaseAPI {
|
|
|
7947
7859
|
* <!-- theme: info --> > Using the trajectory cache is an optional performance optimization. It is not necessary to use the cache to execute trajectories. Loads and validates the data of a trajectory into the execution cache, rendering the trajectory executable. The response contains the result of the validation of the trajectory. Validation can lead to three different results: - Fully valid: The whole trajectory can be executed from start to end. The response will contain an unique identifier which is used to move the robot. - Partially valid: Only parts of the trajectory can be executed. The response will contain an unique identifier to move the robot and information about the failure for the part that is not executable. - Invalid: The trajectory can not be executed. The response will tell you the reason of failure. If the trajectory is at least partially valid, the parts of the trajectory that are valid can be executed using the [executeTrajectory](executeTrajectory) endpoint. The workflow is as follows: - Generate a trajectory with [planTrajectory](planTrajectory) or your own motion planner, - Send the trajectory to this endpoint to validate it and get a unique identifier for it, - The unique identifier will appear in the list of available trajectories, see [listTrajectories](listTrajectories) endpoint, if it is at least partially executable. - Execute your trajectory using the [executeTrajectory](executeTrajectory) endpoint.
|
|
7948
7860
|
* @summary Add Trajectory
|
|
7949
7861
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
7950
|
-
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
7951
7862
|
* @param {AddTrajectoryRequest} addTrajectoryRequest
|
|
7952
7863
|
* @param {*} [options] Override http request option.
|
|
7953
7864
|
* @throws {RequiredError}
|
|
7954
7865
|
* @memberof TrajectoryCachingApi
|
|
7955
7866
|
*/
|
|
7956
|
-
addTrajectory(cell: string,
|
|
7867
|
+
addTrajectory(cell: string, addTrajectoryRequest: AddTrajectoryRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AddTrajectoryResponse, any>>;
|
|
7957
7868
|
/**
|
|
7958
7869
|
* Clear the trajectory cache.
|
|
7959
7870
|
* @summary Clear Trajectories
|
|
7960
7871
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
7961
|
-
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
7962
7872
|
* @param {*} [options] Override http request option.
|
|
7963
7873
|
* @throws {RequiredError}
|
|
7964
7874
|
* @memberof TrajectoryCachingApi
|
|
7965
7875
|
*/
|
|
7966
|
-
clearTrajectories(cell: string,
|
|
7876
|
+
clearTrajectories(cell: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
7967
7877
|
/**
|
|
7968
7878
|
* Delete a previously created trajectory from cache. Use [listTrajectories](listTrajectories) to list all cached trajectories. Trajectories are removed automatically if the motion group or the corresponding controller is disconnected.
|
|
7969
7879
|
* @summary Delete Trajectory
|
|
7970
7880
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
7971
|
-
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
7972
7881
|
* @param {string} trajectory This represents the unique identifier of a trajectory. Every executable or partially executable trajectory is cached and an unique identifier is returned. Indicate the unique identifier to execute the trajectory or retrieve information on the trajectory.
|
|
7973
7882
|
* @param {*} [options] Override http request option.
|
|
7974
7883
|
* @throws {RequiredError}
|
|
7975
7884
|
* @memberof TrajectoryCachingApi
|
|
7976
7885
|
*/
|
|
7977
|
-
deleteTrajectory(cell: string,
|
|
7886
|
+
deleteTrajectory(cell: string, trajectory: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
7978
7887
|
/**
|
|
7979
7888
|
* Get a previously created trajectory from cache. Use [listTrajectories](listTrajectories) to list all cached trajectories.
|
|
7980
7889
|
* @summary Get Trajectory
|
|
7981
7890
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
7982
|
-
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
7983
7891
|
* @param {string} trajectory This represents the unique identifier of a trajectory. Every executable or partially executable trajectory is cached and an unique identifier is returned. Indicate the unique identifier to execute the trajectory or retrieve information on the trajectory.
|
|
7984
7892
|
* @param {*} [options] Override http request option.
|
|
7985
7893
|
* @throws {RequiredError}
|
|
7986
7894
|
* @memberof TrajectoryCachingApi
|
|
7987
7895
|
*/
|
|
7988
|
-
getTrajectory(cell: string,
|
|
7896
|
+
getTrajectory(cell: string, trajectory: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetTrajectoryResponse, any>>;
|
|
7989
7897
|
/**
|
|
7990
7898
|
* List currently cached trajectories. Use [addTrajectory](addTrajectory) to add a new trajectory. Adding trajectories is necessary to execute them. Trajectories are removed if the corresponding motion group or controller disconnects.
|
|
7991
7899
|
* @summary List Trajectories
|
|
7992
7900
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
7993
|
-
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
7994
7901
|
* @param {*} [options] Override http request option.
|
|
7995
7902
|
* @throws {RequiredError}
|
|
7996
7903
|
* @memberof TrajectoryCachingApi
|
|
7997
7904
|
*/
|
|
7998
|
-
listTrajectories(cell: string,
|
|
7905
|
+
listTrajectories(cell: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ListTrajectoriesResponse, any>>;
|
|
7999
7906
|
}
|
|
8000
7907
|
/**
|
|
8001
7908
|
* TrajectoryExecutionApi - axios parameter creator
|
|
@@ -8006,12 +7913,11 @@ export declare const TrajectoryExecutionApiAxiosParamCreator: (configuration?: C
|
|
|
8006
7913
|
* <!-- theme: danger --> > Websocket endpoint Provides execution control over a previously planned trajectory. Enables the caller to attach input/output actions to the trajectory. Understanding the concept of location: The location or path parameter specifies the exact position along a trajectory. The location is a scalar value that ranges from 0 to `n`, where `n` denotes the number of motion commands, or trajectory segments, e.g. line, p2p, etc. See [planMotion](planMotion). Each integer value of the location corresponds to one motion command, e.g. 3.0 to 3.999 could be a line. ### Preconditions - The motion group\'s control mode is not claimed by any other endpoint. - The motion group\'s joint position are at start location specified with InitializeMovementRequest. - Use [executeToTrajectory](executeToTrajectory) to move the robot to the start location. ### Requests #### 1. Send InitializeMovementRequest to lock the trajectory to this connection The following actions are executed: - Sets robot controller mode to control mode, - Sets start location of the execution Keep in mind that only a single trajectory can be locked to a websocket connection at a time and not unlocked anymore. To execute another trajectory, a new connection must be established. #### 2. Send StartMovementRequest to start the movement Sets direction of movement, default is forward. #### **Optional** - To pause, send PauseMovementRequest before the movement has reached its end location. - Change the movement\'s velocity with PlaybackSpeedRequest after initializing the movement with InitializeMovementRequest. ### Responses - InitializeMovementResponse is sent to signal the success or failure of the InitializeMovementRequest. - Movement responses are streamed after a StartMovementRequest successfully started the movement. Movement responses are streamed in a rate that is defined as the multiple of the controller step-rate closest to but not exceeding the rate configured by InitializeMovementRequest. - Standstill reponse is sent once the movement has finished or has come to a standstill due to a pause. - PauseMovementResponse is sent to signal the success of the PauseMovementRequest. It does not signal the end of the movement. End of movement is signaled by Standstill reponse . - PlaybackSpeedResponse is sent to signal the success of the PlaybackSpeedRequest. - MovementError with error details is sent in case of an unexpected error, e.g. controller disconnects during movement. ### Tips and Tricks - A movement can be paused and resumed by sending PauseMovementRequest and StartMovementRequest. - Send PlaybackSpeedRequest before StartMovementRequest to reduce the velocity of the movement before it starts. - Send PlaybackSpeedRequest repeatedly to implement a slider. The velocity of the motion group can be adjusted with each controller step. Therefore, if your app needs a slider-like UI to alter the velocity of a currently running movement, you can send PlaybackSpeedRequest with different speed values repeatedly during the movement. - A closed trajectory (end and start joint position are equal) can be repeated by sending StartMovementRequest after the movement has finished.
|
|
8007
7914
|
* @summary Execute Trajectory
|
|
8008
7915
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8009
|
-
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
8010
7916
|
* @param {ExecuteTrajectoryRequest} executeTrajectoryRequest
|
|
8011
7917
|
* @param {*} [options] Override http request option.
|
|
8012
7918
|
* @throws {RequiredError}
|
|
8013
7919
|
*/
|
|
8014
|
-
executeTrajectory: (cell: string,
|
|
7920
|
+
executeTrajectory: (cell: string, executeTrajectoryRequest: ExecuteTrajectoryRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
8015
7921
|
};
|
|
8016
7922
|
/**
|
|
8017
7923
|
* TrajectoryExecutionApi - functional programming interface
|
|
@@ -8022,12 +7928,11 @@ export declare const TrajectoryExecutionApiFp: (configuration?: Configuration) =
|
|
|
8022
7928
|
* <!-- theme: danger --> > Websocket endpoint Provides execution control over a previously planned trajectory. Enables the caller to attach input/output actions to the trajectory. Understanding the concept of location: The location or path parameter specifies the exact position along a trajectory. The location is a scalar value that ranges from 0 to `n`, where `n` denotes the number of motion commands, or trajectory segments, e.g. line, p2p, etc. See [planMotion](planMotion). Each integer value of the location corresponds to one motion command, e.g. 3.0 to 3.999 could be a line. ### Preconditions - The motion group\'s control mode is not claimed by any other endpoint. - The motion group\'s joint position are at start location specified with InitializeMovementRequest. - Use [executeToTrajectory](executeToTrajectory) to move the robot to the start location. ### Requests #### 1. Send InitializeMovementRequest to lock the trajectory to this connection The following actions are executed: - Sets robot controller mode to control mode, - Sets start location of the execution Keep in mind that only a single trajectory can be locked to a websocket connection at a time and not unlocked anymore. To execute another trajectory, a new connection must be established. #### 2. Send StartMovementRequest to start the movement Sets direction of movement, default is forward. #### **Optional** - To pause, send PauseMovementRequest before the movement has reached its end location. - Change the movement\'s velocity with PlaybackSpeedRequest after initializing the movement with InitializeMovementRequest. ### Responses - InitializeMovementResponse is sent to signal the success or failure of the InitializeMovementRequest. - Movement responses are streamed after a StartMovementRequest successfully started the movement. Movement responses are streamed in a rate that is defined as the multiple of the controller step-rate closest to but not exceeding the rate configured by InitializeMovementRequest. - Standstill reponse is sent once the movement has finished or has come to a standstill due to a pause. - PauseMovementResponse is sent to signal the success of the PauseMovementRequest. It does not signal the end of the movement. End of movement is signaled by Standstill reponse . - PlaybackSpeedResponse is sent to signal the success of the PlaybackSpeedRequest. - MovementError with error details is sent in case of an unexpected error, e.g. controller disconnects during movement. ### Tips and Tricks - A movement can be paused and resumed by sending PauseMovementRequest and StartMovementRequest. - Send PlaybackSpeedRequest before StartMovementRequest to reduce the velocity of the movement before it starts. - Send PlaybackSpeedRequest repeatedly to implement a slider. The velocity of the motion group can be adjusted with each controller step. Therefore, if your app needs a slider-like UI to alter the velocity of a currently running movement, you can send PlaybackSpeedRequest with different speed values repeatedly during the movement. - A closed trajectory (end and start joint position are equal) can be repeated by sending StartMovementRequest after the movement has finished.
|
|
8023
7929
|
* @summary Execute Trajectory
|
|
8024
7930
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8025
|
-
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
8026
7931
|
* @param {ExecuteTrajectoryRequest} executeTrajectoryRequest
|
|
8027
7932
|
* @param {*} [options] Override http request option.
|
|
8028
7933
|
* @throws {RequiredError}
|
|
8029
7934
|
*/
|
|
8030
|
-
executeTrajectory(cell: string,
|
|
7935
|
+
executeTrajectory(cell: string, executeTrajectoryRequest: ExecuteTrajectoryRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ExecuteTrajectoryResponse>>;
|
|
8031
7936
|
};
|
|
8032
7937
|
/**
|
|
8033
7938
|
* TrajectoryExecutionApi - factory interface
|
|
@@ -8038,12 +7943,11 @@ export declare const TrajectoryExecutionApiFactory: (configuration?: Configurati
|
|
|
8038
7943
|
* <!-- theme: danger --> > Websocket endpoint Provides execution control over a previously planned trajectory. Enables the caller to attach input/output actions to the trajectory. Understanding the concept of location: The location or path parameter specifies the exact position along a trajectory. The location is a scalar value that ranges from 0 to `n`, where `n` denotes the number of motion commands, or trajectory segments, e.g. line, p2p, etc. See [planMotion](planMotion). Each integer value of the location corresponds to one motion command, e.g. 3.0 to 3.999 could be a line. ### Preconditions - The motion group\'s control mode is not claimed by any other endpoint. - The motion group\'s joint position are at start location specified with InitializeMovementRequest. - Use [executeToTrajectory](executeToTrajectory) to move the robot to the start location. ### Requests #### 1. Send InitializeMovementRequest to lock the trajectory to this connection The following actions are executed: - Sets robot controller mode to control mode, - Sets start location of the execution Keep in mind that only a single trajectory can be locked to a websocket connection at a time and not unlocked anymore. To execute another trajectory, a new connection must be established. #### 2. Send StartMovementRequest to start the movement Sets direction of movement, default is forward. #### **Optional** - To pause, send PauseMovementRequest before the movement has reached its end location. - Change the movement\'s velocity with PlaybackSpeedRequest after initializing the movement with InitializeMovementRequest. ### Responses - InitializeMovementResponse is sent to signal the success or failure of the InitializeMovementRequest. - Movement responses are streamed after a StartMovementRequest successfully started the movement. Movement responses are streamed in a rate that is defined as the multiple of the controller step-rate closest to but not exceeding the rate configured by InitializeMovementRequest. - Standstill reponse is sent once the movement has finished or has come to a standstill due to a pause. - PauseMovementResponse is sent to signal the success of the PauseMovementRequest. It does not signal the end of the movement. End of movement is signaled by Standstill reponse . - PlaybackSpeedResponse is sent to signal the success of the PlaybackSpeedRequest. - MovementError with error details is sent in case of an unexpected error, e.g. controller disconnects during movement. ### Tips and Tricks - A movement can be paused and resumed by sending PauseMovementRequest and StartMovementRequest. - Send PlaybackSpeedRequest before StartMovementRequest to reduce the velocity of the movement before it starts. - Send PlaybackSpeedRequest repeatedly to implement a slider. The velocity of the motion group can be adjusted with each controller step. Therefore, if your app needs a slider-like UI to alter the velocity of a currently running movement, you can send PlaybackSpeedRequest with different speed values repeatedly during the movement. - A closed trajectory (end and start joint position are equal) can be repeated by sending StartMovementRequest after the movement has finished.
|
|
8039
7944
|
* @summary Execute Trajectory
|
|
8040
7945
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8041
|
-
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
8042
7946
|
* @param {ExecuteTrajectoryRequest} executeTrajectoryRequest
|
|
8043
7947
|
* @param {*} [options] Override http request option.
|
|
8044
7948
|
* @throws {RequiredError}
|
|
8045
7949
|
*/
|
|
8046
|
-
executeTrajectory(cell: string,
|
|
7950
|
+
executeTrajectory(cell: string, executeTrajectoryRequest: ExecuteTrajectoryRequest, options?: RawAxiosRequestConfig): AxiosPromise<ExecuteTrajectoryResponse>;
|
|
8047
7951
|
};
|
|
8048
7952
|
/**
|
|
8049
7953
|
* TrajectoryExecutionApi - object-oriented interface
|
|
@@ -8056,13 +7960,12 @@ export declare class TrajectoryExecutionApi extends BaseAPI {
|
|
|
8056
7960
|
* <!-- theme: danger --> > Websocket endpoint Provides execution control over a previously planned trajectory. Enables the caller to attach input/output actions to the trajectory. Understanding the concept of location: The location or path parameter specifies the exact position along a trajectory. The location is a scalar value that ranges from 0 to `n`, where `n` denotes the number of motion commands, or trajectory segments, e.g. line, p2p, etc. See [planMotion](planMotion). Each integer value of the location corresponds to one motion command, e.g. 3.0 to 3.999 could be a line. ### Preconditions - The motion group\'s control mode is not claimed by any other endpoint. - The motion group\'s joint position are at start location specified with InitializeMovementRequest. - Use [executeToTrajectory](executeToTrajectory) to move the robot to the start location. ### Requests #### 1. Send InitializeMovementRequest to lock the trajectory to this connection The following actions are executed: - Sets robot controller mode to control mode, - Sets start location of the execution Keep in mind that only a single trajectory can be locked to a websocket connection at a time and not unlocked anymore. To execute another trajectory, a new connection must be established. #### 2. Send StartMovementRequest to start the movement Sets direction of movement, default is forward. #### **Optional** - To pause, send PauseMovementRequest before the movement has reached its end location. - Change the movement\'s velocity with PlaybackSpeedRequest after initializing the movement with InitializeMovementRequest. ### Responses - InitializeMovementResponse is sent to signal the success or failure of the InitializeMovementRequest. - Movement responses are streamed after a StartMovementRequest successfully started the movement. Movement responses are streamed in a rate that is defined as the multiple of the controller step-rate closest to but not exceeding the rate configured by InitializeMovementRequest. - Standstill reponse is sent once the movement has finished or has come to a standstill due to a pause. - PauseMovementResponse is sent to signal the success of the PauseMovementRequest. It does not signal the end of the movement. End of movement is signaled by Standstill reponse . - PlaybackSpeedResponse is sent to signal the success of the PlaybackSpeedRequest. - MovementError with error details is sent in case of an unexpected error, e.g. controller disconnects during movement. ### Tips and Tricks - A movement can be paused and resumed by sending PauseMovementRequest and StartMovementRequest. - Send PlaybackSpeedRequest before StartMovementRequest to reduce the velocity of the movement before it starts. - Send PlaybackSpeedRequest repeatedly to implement a slider. The velocity of the motion group can be adjusted with each controller step. Therefore, if your app needs a slider-like UI to alter the velocity of a currently running movement, you can send PlaybackSpeedRequest with different speed values repeatedly during the movement. - A closed trajectory (end and start joint position are equal) can be repeated by sending StartMovementRequest after the movement has finished.
|
|
8057
7961
|
* @summary Execute Trajectory
|
|
8058
7962
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8059
|
-
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
8060
7963
|
* @param {ExecuteTrajectoryRequest} executeTrajectoryRequest
|
|
8061
7964
|
* @param {*} [options] Override http request option.
|
|
8062
7965
|
* @throws {RequiredError}
|
|
8063
7966
|
* @memberof TrajectoryExecutionApi
|
|
8064
7967
|
*/
|
|
8065
|
-
executeTrajectory(cell: string,
|
|
7968
|
+
executeTrajectory(cell: string, executeTrajectoryRequest: ExecuteTrajectoryRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ExecuteTrajectoryResponse, any>>;
|
|
8066
7969
|
}
|
|
8067
7970
|
/**
|
|
8068
7971
|
* TrajectoryPlanningApi - axios parameter creator
|
|
@@ -8128,64 +8031,79 @@ export declare class TrajectoryPlanningApi extends BaseAPI {
|
|
|
8128
8031
|
planTrajectory(cell: string, planTrajectoryRequest?: PlanTrajectoryRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<PlanTrajectoryResponse, any>>;
|
|
8129
8032
|
}
|
|
8130
8033
|
/**
|
|
8131
|
-
*
|
|
8034
|
+
* VirtualRobotApi - axios parameter creator
|
|
8132
8035
|
* @export
|
|
8133
8036
|
*/
|
|
8134
|
-
export declare const
|
|
8037
|
+
export declare const VirtualRobotApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
8135
8038
|
/**
|
|
8136
|
-
*
|
|
8137
|
-
* @summary
|
|
8039
|
+
* Get the current motion group state which provides values for the joints\' position, velocity and acceleration.
|
|
8040
|
+
* @summary Get Motion Group State
|
|
8138
8041
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8139
8042
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
8140
|
-
* @param {string}
|
|
8141
|
-
* @param {CoordinateSystemData} coordinateSystemData
|
|
8043
|
+
* @param {string} motionGroup The motion-group identifier.
|
|
8142
8044
|
* @param {*} [options] Override http request option.
|
|
8143
8045
|
* @throws {RequiredError}
|
|
8144
8046
|
*/
|
|
8145
|
-
|
|
8047
|
+
getMotionGroupState: (cell: string, controller: string, motionGroup: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
8146
8048
|
/**
|
|
8147
|
-
*
|
|
8148
|
-
* @summary
|
|
8049
|
+
* Gets information on the motion group.
|
|
8050
|
+
* @summary Motion Group Description
|
|
8149
8051
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8150
8052
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
8151
|
-
* @param {string} motionGroup The motion-group identifier.
|
|
8152
|
-
* @param {string} tcp The unique identifier of a TCP.
|
|
8153
|
-
* @param {RobotTcpData} robotTcpData
|
|
8154
8053
|
* @param {*} [options] Override http request option.
|
|
8155
8054
|
* @throws {RequiredError}
|
|
8156
8055
|
*/
|
|
8157
|
-
|
|
8056
|
+
getMotionGroups: (cell: string, controller: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
8158
8057
|
/**
|
|
8159
|
-
*
|
|
8160
|
-
* @summary
|
|
8058
|
+
* 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).
|
|
8059
|
+
* @summary Get Inputs/Outputs
|
|
8161
8060
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8162
8061
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
8163
|
-
* @param {string}
|
|
8164
|
-
* @param {
|
|
8062
|
+
* @param {Array<string>} ios
|
|
8063
|
+
* @param {*} [options] Override http request option.
|
|
8064
|
+
* @throws {RequiredError}
|
|
8065
|
+
*/
|
|
8066
|
+
listIOs: (cell: string, controller: string, ios: Array<string>, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
8067
|
+
/**
|
|
8068
|
+
* 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.
|
|
8069
|
+
* @summary List Input/Output Descriptions
|
|
8070
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8071
|
+
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
8072
|
+
* @param {Array<string>} [ios]
|
|
8073
|
+
* @param {IODirection} [direction] Return only inputs/outputs with the specified direction.
|
|
8074
|
+
* @param {IOValueType} [valueType] Return only inputs/outputs with the specified value type.
|
|
8075
|
+
* @param {string} [group] Return only inputs/outputs from the specified group.
|
|
8165
8076
|
* @param {*} [options] Override http request option.
|
|
8166
8077
|
* @throws {RequiredError}
|
|
8167
8078
|
*/
|
|
8168
|
-
|
|
8079
|
+
listVirtualRobotIODescriptions: (cell: string, controller: string, ios?: Array<string>, direction?: IODirection, valueType?: IOValueType, group?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
8169
8080
|
/**
|
|
8170
|
-
*
|
|
8171
|
-
* @summary
|
|
8081
|
+
* Sets a list of values of a virtual controller inputs/outputs.
|
|
8082
|
+
* @summary Set Input/Ouput Values
|
|
8172
8083
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8173
8084
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
8174
|
-
* @param {
|
|
8175
|
-
* @param {string} tcp The unique identifier of a TCP.
|
|
8085
|
+
* @param {Array<IOValue>} iOValue
|
|
8176
8086
|
* @param {*} [options] Override http request option.
|
|
8177
8087
|
* @throws {RequiredError}
|
|
8178
8088
|
*/
|
|
8179
|
-
|
|
8089
|
+
setIOValues: (cell: string, controller: string, iOValue: Array<IOValue>, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
8180
8090
|
/**
|
|
8181
|
-
*
|
|
8182
|
-
* @summary
|
|
8091
|
+
* 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.
|
|
8092
|
+
* @summary Set Motion Group State
|
|
8183
8093
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8184
8094
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
8095
|
+
* @param {string} motionGroup The motion-group identifier.
|
|
8096
|
+
* @param {MotionGroupJoints} motionGroupJoints
|
|
8185
8097
|
* @param {*} [options] Override http request option.
|
|
8186
8098
|
* @throws {RequiredError}
|
|
8187
8099
|
*/
|
|
8188
|
-
|
|
8100
|
+
setMotionGroupState: (cell: string, controller: string, motionGroup: string, motionGroupJoints: MotionGroupJoints, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
8101
|
+
};
|
|
8102
|
+
/**
|
|
8103
|
+
* VirtualRobotApi - functional programming interface
|
|
8104
|
+
* @export
|
|
8105
|
+
*/
|
|
8106
|
+
export declare const VirtualRobotApiFp: (configuration?: Configuration) => {
|
|
8189
8107
|
/**
|
|
8190
8108
|
* Get the current motion group state which provides values for the joints\' position, velocity and acceleration.
|
|
8191
8109
|
* @summary Get Motion Group State
|
|
@@ -8195,7 +8113,7 @@ export declare const VirtualControllerApiAxiosParamCreator: (configuration?: Con
|
|
|
8195
8113
|
* @param {*} [options] Override http request option.
|
|
8196
8114
|
* @throws {RequiredError}
|
|
8197
8115
|
*/
|
|
8198
|
-
getMotionGroupState
|
|
8116
|
+
getMotionGroupState(cell: string, controller: string, motionGroup: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<MotionGroupJoints>>;
|
|
8199
8117
|
/**
|
|
8200
8118
|
* Gets information on the motion group.
|
|
8201
8119
|
* @summary Motion Group Description
|
|
@@ -8204,297 +8122,365 @@ export declare const VirtualControllerApiAxiosParamCreator: (configuration?: Con
|
|
|
8204
8122
|
* @param {*} [options] Override http request option.
|
|
8205
8123
|
* @throws {RequiredError}
|
|
8206
8124
|
*/
|
|
8207
|
-
getMotionGroups
|
|
8125
|
+
getMotionGroups(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<MotionGroupInfos>>;
|
|
8208
8126
|
/**
|
|
8209
|
-
*
|
|
8210
|
-
* @summary Get
|
|
8127
|
+
* 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).
|
|
8128
|
+
* @summary Get Inputs/Outputs
|
|
8211
8129
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8212
8130
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
8131
|
+
* @param {Array<string>} ios
|
|
8213
8132
|
* @param {*} [options] Override http request option.
|
|
8214
8133
|
* @throws {RequiredError}
|
|
8215
8134
|
*/
|
|
8216
|
-
|
|
8135
|
+
listIOs(cell: string, controller: string, ios: Array<string>, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<IOValue>>>;
|
|
8217
8136
|
/**
|
|
8218
|
-
*
|
|
8219
|
-
* @summary
|
|
8137
|
+
* 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.
|
|
8138
|
+
* @summary List Input/Output Descriptions
|
|
8220
8139
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8221
8140
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
8222
|
-
* @param {string}
|
|
8141
|
+
* @param {Array<string>} [ios]
|
|
8142
|
+
* @param {IODirection} [direction] Return only inputs/outputs with the specified direction.
|
|
8143
|
+
* @param {IOValueType} [valueType] Return only inputs/outputs with the specified value type.
|
|
8144
|
+
* @param {string} [group] Return only inputs/outputs from the specified group.
|
|
8223
8145
|
* @param {*} [options] Override http request option.
|
|
8224
8146
|
* @throws {RequiredError}
|
|
8225
8147
|
*/
|
|
8226
|
-
|
|
8148
|
+
listVirtualRobotIODescriptions(cell: string, controller: string, ios?: Array<string>, direction?: IODirection, valueType?: IOValueType, group?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<IODescription>>>;
|
|
8227
8149
|
/**
|
|
8228
|
-
*
|
|
8229
|
-
* @summary
|
|
8150
|
+
* Sets a list of values of a virtual controller inputs/outputs.
|
|
8151
|
+
* @summary Set Input/Ouput Values
|
|
8230
8152
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8231
8153
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
8154
|
+
* @param {Array<IOValue>} iOValue
|
|
8232
8155
|
* @param {*} [options] Override http request option.
|
|
8233
8156
|
* @throws {RequiredError}
|
|
8234
8157
|
*/
|
|
8235
|
-
|
|
8158
|
+
setIOValues(cell: string, controller: string, iOValue: Array<IOValue>, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
8236
8159
|
/**
|
|
8237
|
-
*
|
|
8238
|
-
* @summary
|
|
8160
|
+
* 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.
|
|
8161
|
+
* @summary Set Motion Group State
|
|
8239
8162
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8240
8163
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
8241
8164
|
* @param {string} motionGroup The motion-group identifier.
|
|
8165
|
+
* @param {MotionGroupJoints} motionGroupJoints
|
|
8242
8166
|
* @param {*} [options] Override http request option.
|
|
8243
8167
|
* @throws {RequiredError}
|
|
8244
8168
|
*/
|
|
8245
|
-
|
|
8169
|
+
setMotionGroupState(cell: string, controller: string, motionGroup: string, motionGroupJoints: MotionGroupJoints, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
8170
|
+
};
|
|
8171
|
+
/**
|
|
8172
|
+
* VirtualRobotApi - factory interface
|
|
8173
|
+
* @export
|
|
8174
|
+
*/
|
|
8175
|
+
export declare const VirtualRobotApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
8246
8176
|
/**
|
|
8247
|
-
*
|
|
8248
|
-
* @summary
|
|
8177
|
+
* Get the current motion group state which provides values for the joints\' position, velocity and acceleration.
|
|
8178
|
+
* @summary Get Motion Group State
|
|
8249
8179
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8250
8180
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
8251
|
-
* @param {
|
|
8181
|
+
* @param {string} motionGroup The motion-group identifier.
|
|
8252
8182
|
* @param {*} [options] Override http request option.
|
|
8253
8183
|
* @throws {RequiredError}
|
|
8254
8184
|
*/
|
|
8255
|
-
|
|
8185
|
+
getMotionGroupState(cell: string, controller: string, motionGroup: string, options?: RawAxiosRequestConfig): AxiosPromise<MotionGroupJoints>;
|
|
8256
8186
|
/**
|
|
8257
|
-
*
|
|
8258
|
-
* @summary
|
|
8187
|
+
* Gets information on the motion group.
|
|
8188
|
+
* @summary Motion Group Description
|
|
8259
8189
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8260
8190
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
8261
|
-
* @param {string} motionGroup The motion-group identifier.
|
|
8262
|
-
* @param {MotionGroupJoints} motionGroupJoints
|
|
8263
8191
|
* @param {*} [options] Override http request option.
|
|
8264
8192
|
* @throws {RequiredError}
|
|
8265
8193
|
*/
|
|
8266
|
-
|
|
8194
|
+
getMotionGroups(cell: string, controller: string, options?: RawAxiosRequestConfig): AxiosPromise<MotionGroupInfos>;
|
|
8267
8195
|
/**
|
|
8268
|
-
*
|
|
8269
|
-
* @summary
|
|
8196
|
+
* 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).
|
|
8197
|
+
* @summary Get Inputs/Outputs
|
|
8270
8198
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8271
8199
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
8272
|
-
* @param {
|
|
8200
|
+
* @param {Array<string>} ios
|
|
8273
8201
|
* @param {*} [options] Override http request option.
|
|
8274
8202
|
* @throws {RequiredError}
|
|
8275
8203
|
*/
|
|
8276
|
-
|
|
8204
|
+
listIOs(cell: string, controller: string, ios: Array<string>, options?: RawAxiosRequestConfig): AxiosPromise<Array<IOValue>>;
|
|
8277
8205
|
/**
|
|
8278
|
-
*
|
|
8279
|
-
* @summary
|
|
8206
|
+
* 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.
|
|
8207
|
+
* @summary List Input/Output Descriptions
|
|
8208
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8209
|
+
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
8210
|
+
* @param {Array<string>} [ios]
|
|
8211
|
+
* @param {IODirection} [direction] Return only inputs/outputs with the specified direction.
|
|
8212
|
+
* @param {IOValueType} [valueType] Return only inputs/outputs with the specified value type.
|
|
8213
|
+
* @param {string} [group] Return only inputs/outputs from the specified group.
|
|
8214
|
+
* @param {*} [options] Override http request option.
|
|
8215
|
+
* @throws {RequiredError}
|
|
8216
|
+
*/
|
|
8217
|
+
listVirtualRobotIODescriptions(cell: string, controller: string, ios?: Array<string>, direction?: IODirection, valueType?: IOValueType, group?: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<IODescription>>;
|
|
8218
|
+
/**
|
|
8219
|
+
* Sets a list of values of a virtual controller inputs/outputs.
|
|
8220
|
+
* @summary Set Input/Ouput Values
|
|
8221
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8222
|
+
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
8223
|
+
* @param {Array<IOValue>} iOValue
|
|
8224
|
+
* @param {*} [options] Override http request option.
|
|
8225
|
+
* @throws {RequiredError}
|
|
8226
|
+
*/
|
|
8227
|
+
setIOValues(cell: string, controller: string, iOValue: Array<IOValue>, options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
8228
|
+
/**
|
|
8229
|
+
* 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.
|
|
8230
|
+
* @summary Set Motion Group State
|
|
8280
8231
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8281
8232
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
8282
8233
|
* @param {string} motionGroup The motion-group identifier.
|
|
8283
|
-
* @param {
|
|
8234
|
+
* @param {MotionGroupJoints} motionGroupJoints
|
|
8284
8235
|
* @param {*} [options] Override http request option.
|
|
8285
8236
|
* @throws {RequiredError}
|
|
8286
8237
|
*/
|
|
8287
|
-
|
|
8238
|
+
setMotionGroupState(cell: string, controller: string, motionGroup: string, motionGroupJoints: MotionGroupJoints, options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
8288
8239
|
};
|
|
8289
8240
|
/**
|
|
8290
|
-
*
|
|
8241
|
+
* VirtualRobotApi - object-oriented interface
|
|
8291
8242
|
* @export
|
|
8243
|
+
* @class VirtualRobotApi
|
|
8244
|
+
* @extends {BaseAPI}
|
|
8292
8245
|
*/
|
|
8293
|
-
export declare
|
|
8246
|
+
export declare class VirtualRobotApi extends BaseAPI {
|
|
8294
8247
|
/**
|
|
8295
|
-
*
|
|
8296
|
-
* @summary
|
|
8248
|
+
* Get the current motion group state which provides values for the joints\' position, velocity and acceleration.
|
|
8249
|
+
* @summary Get Motion Group State
|
|
8297
8250
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8298
8251
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
8299
|
-
* @param {string}
|
|
8300
|
-
* @param {CoordinateSystemData} coordinateSystemData
|
|
8252
|
+
* @param {string} motionGroup The motion-group identifier.
|
|
8301
8253
|
* @param {*} [options] Override http request option.
|
|
8302
8254
|
* @throws {RequiredError}
|
|
8255
|
+
* @memberof VirtualRobotApi
|
|
8303
8256
|
*/
|
|
8304
|
-
|
|
8257
|
+
getMotionGroupState(cell: string, controller: string, motionGroup: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<MotionGroupJoints, any>>;
|
|
8305
8258
|
/**
|
|
8306
|
-
*
|
|
8307
|
-
* @summary
|
|
8259
|
+
* Gets information on the motion group.
|
|
8260
|
+
* @summary Motion Group Description
|
|
8308
8261
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8309
8262
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
8310
|
-
* @param {string} motionGroup The motion-group identifier.
|
|
8311
|
-
* @param {string} tcp The unique identifier of a TCP.
|
|
8312
|
-
* @param {RobotTcpData} robotTcpData
|
|
8313
8263
|
* @param {*} [options] Override http request option.
|
|
8314
8264
|
* @throws {RequiredError}
|
|
8265
|
+
* @memberof VirtualRobotApi
|
|
8315
8266
|
*/
|
|
8316
|
-
|
|
8267
|
+
getMotionGroups(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<MotionGroupInfos, any>>;
|
|
8317
8268
|
/**
|
|
8318
|
-
*
|
|
8319
|
-
* @summary
|
|
8269
|
+
* 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).
|
|
8270
|
+
* @summary Get Inputs/Outputs
|
|
8320
8271
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8321
8272
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
8322
|
-
* @param {string}
|
|
8323
|
-
* @param {boolean} [deleteDependent] If true, all dependent coordinate systems will be deleted as well.
|
|
8273
|
+
* @param {Array<string>} ios
|
|
8324
8274
|
* @param {*} [options] Override http request option.
|
|
8325
8275
|
* @throws {RequiredError}
|
|
8276
|
+
* @memberof VirtualRobotApi
|
|
8326
8277
|
*/
|
|
8327
|
-
|
|
8278
|
+
listIOs(cell: string, controller: string, ios: Array<string>, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<IOValue[], any>>;
|
|
8328
8279
|
/**
|
|
8329
|
-
*
|
|
8330
|
-
* @summary
|
|
8280
|
+
* 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.
|
|
8281
|
+
* @summary List Input/Output Descriptions
|
|
8331
8282
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8332
8283
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
8333
|
-
* @param {string}
|
|
8334
|
-
* @param {
|
|
8284
|
+
* @param {Array<string>} [ios]
|
|
8285
|
+
* @param {IODirection} [direction] Return only inputs/outputs with the specified direction.
|
|
8286
|
+
* @param {IOValueType} [valueType] Return only inputs/outputs with the specified value type.
|
|
8287
|
+
* @param {string} [group] Return only inputs/outputs from the specified group.
|
|
8335
8288
|
* @param {*} [options] Override http request option.
|
|
8336
8289
|
* @throws {RequiredError}
|
|
8290
|
+
* @memberof VirtualRobotApi
|
|
8337
8291
|
*/
|
|
8338
|
-
|
|
8292
|
+
listVirtualRobotIODescriptions(cell: string, controller: string, ios?: Array<string>, direction?: IODirection, valueType?: IOValueType, group?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<IODescription[], any>>;
|
|
8339
8293
|
/**
|
|
8340
|
-
*
|
|
8341
|
-
* @summary
|
|
8294
|
+
* Sets a list of values of a virtual controller inputs/outputs.
|
|
8295
|
+
* @summary Set Input/Ouput Values
|
|
8342
8296
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8343
8297
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
8298
|
+
* @param {Array<IOValue>} iOValue
|
|
8344
8299
|
* @param {*} [options] Override http request option.
|
|
8345
8300
|
* @throws {RequiredError}
|
|
8301
|
+
* @memberof VirtualRobotApi
|
|
8346
8302
|
*/
|
|
8347
|
-
|
|
8303
|
+
setIOValues(cell: string, controller: string, iOValue: Array<IOValue>, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
8348
8304
|
/**
|
|
8349
|
-
*
|
|
8350
|
-
* @summary
|
|
8305
|
+
* 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.
|
|
8306
|
+
* @summary Set Motion Group State
|
|
8351
8307
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8352
8308
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
8353
8309
|
* @param {string} motionGroup The motion-group identifier.
|
|
8310
|
+
* @param {MotionGroupJoints} motionGroupJoints
|
|
8354
8311
|
* @param {*} [options] Override http request option.
|
|
8355
8312
|
* @throws {RequiredError}
|
|
8313
|
+
* @memberof VirtualRobotApi
|
|
8356
8314
|
*/
|
|
8357
|
-
|
|
8315
|
+
setMotionGroupState(cell: string, controller: string, motionGroup: string, motionGroupJoints: MotionGroupJoints, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
8316
|
+
}
|
|
8317
|
+
/**
|
|
8318
|
+
* VirtualRobotBehaviorApi - axios parameter creator
|
|
8319
|
+
* @export
|
|
8320
|
+
*/
|
|
8321
|
+
export declare const VirtualRobotBehaviorApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
8358
8322
|
/**
|
|
8359
|
-
*
|
|
8360
|
-
* @summary
|
|
8323
|
+
* <!-- theme: danger --> > Websocket endpoint This stream provides the commanded joint state and sets a motion groups joint configuration, e.g. to move a motion group. The concept is that an application is using the Motion Service to move a motion group. The Motion Service is commanding the desired joint configuration of a motion group. Physical motion groups move to this joint configuration. With physical motion groups, this takes some time and only works if possible. And you have the *actual* joint state - the current real motion group configuration. Again, this stream is providing *commanded* joint state! It is __not__ providing the *actual* joint state! (Please file a request - if you need a stream of the *actual* joint state) When the virtual controller receives joint commands the joint configuration is immediately adapted to match the incoming joint configurations. CAUTION: Incoming joint configurations are not visualized and their velocity limits are not checked. we don\'t even check limits! Possible use cases are: 1. Creating a robotic application that dynamically adapts to the configured joints on the robot controller, using this stream to feed new joint configurations back to the motion group. The stream only sends data to the robot controller if a motion is executed. If the robot controller\'s joint configuration differs too much from the incoming joint configuration, a following error occurs. Joint configurations that result in following errors are executed only for motions with a low velocity. 2. Mimic Freedrive motions. <!-- theme: danger --> > **DANGER** > > If the incoming joint configuration is set to maximum velocity, the movement to reach this incoming joint configuration > will be executed with maximum speed regardless of safety zones and mechanical limits.
|
|
8324
|
+
* @summary Stream Joint Configuration
|
|
8361
8325
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8362
8326
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
8327
|
+
* @param {ExternalJointStreamDatapoint} externalJointStreamDatapoint
|
|
8363
8328
|
* @param {*} [options] Override http request option.
|
|
8364
8329
|
* @throws {RequiredError}
|
|
8365
8330
|
*/
|
|
8366
|
-
|
|
8331
|
+
externalJointsStream: (cell: string, controller: string, externalJointStreamDatapoint: ExternalJointStreamDatapoint, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
8367
8332
|
/**
|
|
8368
|
-
*
|
|
8369
|
-
* @summary
|
|
8333
|
+
* Get the current robot motion group behavior - please see the setter [setMotionGroupBehavior](setMotionGroupBehavior) and the enum for details.
|
|
8334
|
+
* @summary Behavior
|
|
8370
8335
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8371
8336
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
8337
|
+
* @param {string} motionGroup The motion-group identifier.
|
|
8372
8338
|
* @param {*} [options] Override http request option.
|
|
8373
8339
|
* @throws {RequiredError}
|
|
8374
8340
|
*/
|
|
8375
|
-
|
|
8341
|
+
getMotionGroupBehavior: (cell: string, controller: string, motionGroup: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
8376
8342
|
/**
|
|
8377
|
-
*
|
|
8378
|
-
* @summary
|
|
8343
|
+
* Switch robot motion group behavior.
|
|
8344
|
+
* @summary Switch Behavior
|
|
8379
8345
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8380
8346
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
8381
8347
|
* @param {string} motionGroup The motion-group identifier.
|
|
8348
|
+
* @param {Behavior} [behavior]
|
|
8382
8349
|
* @param {*} [options] Override http request option.
|
|
8383
8350
|
* @throws {RequiredError}
|
|
8384
8351
|
*/
|
|
8385
|
-
|
|
8352
|
+
setMotionGroupBehavior: (cell: string, controller: string, motionGroup: string, behavior?: Behavior, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
8353
|
+
};
|
|
8354
|
+
/**
|
|
8355
|
+
* VirtualRobotBehaviorApi - functional programming interface
|
|
8356
|
+
* @export
|
|
8357
|
+
*/
|
|
8358
|
+
export declare const VirtualRobotBehaviorApiFp: (configuration?: Configuration) => {
|
|
8386
8359
|
/**
|
|
8387
|
-
*
|
|
8388
|
-
* @summary
|
|
8360
|
+
* <!-- theme: danger --> > Websocket endpoint This stream provides the commanded joint state and sets a motion groups joint configuration, e.g. to move a motion group. The concept is that an application is using the Motion Service to move a motion group. The Motion Service is commanding the desired joint configuration of a motion group. Physical motion groups move to this joint configuration. With physical motion groups, this takes some time and only works if possible. And you have the *actual* joint state - the current real motion group configuration. Again, this stream is providing *commanded* joint state! It is __not__ providing the *actual* joint state! (Please file a request - if you need a stream of the *actual* joint state) When the virtual controller receives joint commands the joint configuration is immediately adapted to match the incoming joint configurations. CAUTION: Incoming joint configurations are not visualized and their velocity limits are not checked. we don\'t even check limits! Possible use cases are: 1. Creating a robotic application that dynamically adapts to the configured joints on the robot controller, using this stream to feed new joint configurations back to the motion group. The stream only sends data to the robot controller if a motion is executed. If the robot controller\'s joint configuration differs too much from the incoming joint configuration, a following error occurs. Joint configurations that result in following errors are executed only for motions with a low velocity. 2. Mimic Freedrive motions. <!-- theme: danger --> > **DANGER** > > If the incoming joint configuration is set to maximum velocity, the movement to reach this incoming joint configuration > will be executed with maximum speed regardless of safety zones and mechanical limits.
|
|
8361
|
+
* @summary Stream Joint Configuration
|
|
8389
8362
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8390
8363
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
8364
|
+
* @param {ExternalJointStreamDatapoint} externalJointStreamDatapoint
|
|
8391
8365
|
* @param {*} [options] Override http request option.
|
|
8392
8366
|
* @throws {RequiredError}
|
|
8393
8367
|
*/
|
|
8394
|
-
|
|
8368
|
+
externalJointsStream(cell: string, controller: string, externalJointStreamDatapoint: ExternalJointStreamDatapoint, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<MotionGroupJoints>>;
|
|
8395
8369
|
/**
|
|
8396
|
-
*
|
|
8397
|
-
* @summary
|
|
8370
|
+
* Get the current robot motion group behavior - please see the setter [setMotionGroupBehavior](setMotionGroupBehavior) and the enum for details.
|
|
8371
|
+
* @summary Behavior
|
|
8398
8372
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8399
8373
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
8400
8374
|
* @param {string} motionGroup The motion-group identifier.
|
|
8401
8375
|
* @param {*} [options] Override http request option.
|
|
8402
8376
|
* @throws {RequiredError}
|
|
8403
8377
|
*/
|
|
8404
|
-
|
|
8378
|
+
getMotionGroupBehavior(cell: string, controller: string, motionGroup: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<MotionGroupBehaviorGetter>>;
|
|
8405
8379
|
/**
|
|
8406
|
-
*
|
|
8407
|
-
* @summary
|
|
8380
|
+
* Switch robot motion group behavior.
|
|
8381
|
+
* @summary Switch Behavior
|
|
8408
8382
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8409
8383
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
8410
|
-
* @param {
|
|
8384
|
+
* @param {string} motionGroup The motion-group identifier.
|
|
8385
|
+
* @param {Behavior} [behavior]
|
|
8411
8386
|
* @param {*} [options] Override http request option.
|
|
8412
8387
|
* @throws {RequiredError}
|
|
8413
8388
|
*/
|
|
8414
|
-
|
|
8389
|
+
setMotionGroupBehavior(cell: string, controller: string, motionGroup: string, behavior?: Behavior, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
8390
|
+
};
|
|
8391
|
+
/**
|
|
8392
|
+
* VirtualRobotBehaviorApi - factory interface
|
|
8393
|
+
* @export
|
|
8394
|
+
*/
|
|
8395
|
+
export declare const VirtualRobotBehaviorApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
8415
8396
|
/**
|
|
8416
|
-
*
|
|
8417
|
-
* @summary
|
|
8397
|
+
* <!-- theme: danger --> > Websocket endpoint This stream provides the commanded joint state and sets a motion groups joint configuration, e.g. to move a motion group. The concept is that an application is using the Motion Service to move a motion group. The Motion Service is commanding the desired joint configuration of a motion group. Physical motion groups move to this joint configuration. With physical motion groups, this takes some time and only works if possible. And you have the *actual* joint state - the current real motion group configuration. Again, this stream is providing *commanded* joint state! It is __not__ providing the *actual* joint state! (Please file a request - if you need a stream of the *actual* joint state) When the virtual controller receives joint commands the joint configuration is immediately adapted to match the incoming joint configurations. CAUTION: Incoming joint configurations are not visualized and their velocity limits are not checked. we don\'t even check limits! Possible use cases are: 1. Creating a robotic application that dynamically adapts to the configured joints on the robot controller, using this stream to feed new joint configurations back to the motion group. The stream only sends data to the robot controller if a motion is executed. If the robot controller\'s joint configuration differs too much from the incoming joint configuration, a following error occurs. Joint configurations that result in following errors are executed only for motions with a low velocity. 2. Mimic Freedrive motions. <!-- theme: danger --> > **DANGER** > > If the incoming joint configuration is set to maximum velocity, the movement to reach this incoming joint configuration > will be executed with maximum speed regardless of safety zones and mechanical limits.
|
|
8398
|
+
* @summary Stream Joint Configuration
|
|
8418
8399
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8419
8400
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
8420
|
-
* @param {
|
|
8421
|
-
* @param {MotionGroupJoints} motionGroupJoints
|
|
8401
|
+
* @param {ExternalJointStreamDatapoint} externalJointStreamDatapoint
|
|
8422
8402
|
* @param {*} [options] Override http request option.
|
|
8423
8403
|
* @throws {RequiredError}
|
|
8424
8404
|
*/
|
|
8425
|
-
|
|
8405
|
+
externalJointsStream(cell: string, controller: string, externalJointStreamDatapoint: ExternalJointStreamDatapoint, options?: RawAxiosRequestConfig): AxiosPromise<MotionGroupJoints>;
|
|
8426
8406
|
/**
|
|
8427
|
-
*
|
|
8428
|
-
* @summary
|
|
8407
|
+
* Get the current robot motion group behavior - please see the setter [setMotionGroupBehavior](setMotionGroupBehavior) and the enum for details.
|
|
8408
|
+
* @summary Behavior
|
|
8429
8409
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8430
8410
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
8431
|
-
* @param {
|
|
8411
|
+
* @param {string} motionGroup The motion-group identifier.
|
|
8432
8412
|
* @param {*} [options] Override http request option.
|
|
8433
8413
|
* @throws {RequiredError}
|
|
8434
8414
|
*/
|
|
8435
|
-
|
|
8415
|
+
getMotionGroupBehavior(cell: string, controller: string, motionGroup: string, options?: RawAxiosRequestConfig): AxiosPromise<MotionGroupBehaviorGetter>;
|
|
8436
8416
|
/**
|
|
8437
|
-
*
|
|
8438
|
-
* @summary
|
|
8417
|
+
* Switch robot motion group behavior.
|
|
8418
|
+
* @summary Switch Behavior
|
|
8439
8419
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8440
8420
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
8441
8421
|
* @param {string} motionGroup The motion-group identifier.
|
|
8442
|
-
* @param {
|
|
8422
|
+
* @param {Behavior} [behavior]
|
|
8443
8423
|
* @param {*} [options] Override http request option.
|
|
8444
8424
|
* @throws {RequiredError}
|
|
8445
8425
|
*/
|
|
8446
|
-
|
|
8426
|
+
setMotionGroupBehavior(cell: string, controller: string, motionGroup: string, behavior?: Behavior, options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
8447
8427
|
};
|
|
8448
8428
|
/**
|
|
8449
|
-
*
|
|
8429
|
+
* VirtualRobotBehaviorApi - object-oriented interface
|
|
8450
8430
|
* @export
|
|
8431
|
+
* @class VirtualRobotBehaviorApi
|
|
8432
|
+
* @extends {BaseAPI}
|
|
8451
8433
|
*/
|
|
8452
|
-
export declare
|
|
8434
|
+
export declare class VirtualRobotBehaviorApi extends BaseAPI {
|
|
8453
8435
|
/**
|
|
8454
|
-
*
|
|
8455
|
-
* @summary
|
|
8436
|
+
* <!-- theme: danger --> > Websocket endpoint This stream provides the commanded joint state and sets a motion groups joint configuration, e.g. to move a motion group. The concept is that an application is using the Motion Service to move a motion group. The Motion Service is commanding the desired joint configuration of a motion group. Physical motion groups move to this joint configuration. With physical motion groups, this takes some time and only works if possible. And you have the *actual* joint state - the current real motion group configuration. Again, this stream is providing *commanded* joint state! It is __not__ providing the *actual* joint state! (Please file a request - if you need a stream of the *actual* joint state) When the virtual controller receives joint commands the joint configuration is immediately adapted to match the incoming joint configurations. CAUTION: Incoming joint configurations are not visualized and their velocity limits are not checked. we don\'t even check limits! Possible use cases are: 1. Creating a robotic application that dynamically adapts to the configured joints on the robot controller, using this stream to feed new joint configurations back to the motion group. The stream only sends data to the robot controller if a motion is executed. If the robot controller\'s joint configuration differs too much from the incoming joint configuration, a following error occurs. Joint configurations that result in following errors are executed only for motions with a low velocity. 2. Mimic Freedrive motions. <!-- theme: danger --> > **DANGER** > > If the incoming joint configuration is set to maximum velocity, the movement to reach this incoming joint configuration > will be executed with maximum speed regardless of safety zones and mechanical limits.
|
|
8437
|
+
* @summary Stream Joint Configuration
|
|
8456
8438
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8457
8439
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
8458
|
-
* @param {
|
|
8459
|
-
* @param {CoordinateSystemData} coordinateSystemData
|
|
8440
|
+
* @param {ExternalJointStreamDatapoint} externalJointStreamDatapoint
|
|
8460
8441
|
* @param {*} [options] Override http request option.
|
|
8461
8442
|
* @throws {RequiredError}
|
|
8443
|
+
* @memberof VirtualRobotBehaviorApi
|
|
8462
8444
|
*/
|
|
8463
|
-
|
|
8445
|
+
externalJointsStream(cell: string, controller: string, externalJointStreamDatapoint: ExternalJointStreamDatapoint, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<MotionGroupJoints, any>>;
|
|
8464
8446
|
/**
|
|
8465
|
-
*
|
|
8466
|
-
* @summary
|
|
8447
|
+
* Get the current robot motion group behavior - please see the setter [setMotionGroupBehavior](setMotionGroupBehavior) and the enum for details.
|
|
8448
|
+
* @summary Behavior
|
|
8467
8449
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8468
8450
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
8469
8451
|
* @param {string} motionGroup The motion-group identifier.
|
|
8470
|
-
* @param {string} tcp The unique identifier of a TCP.
|
|
8471
|
-
* @param {RobotTcpData} robotTcpData
|
|
8472
8452
|
* @param {*} [options] Override http request option.
|
|
8473
8453
|
* @throws {RequiredError}
|
|
8454
|
+
* @memberof VirtualRobotBehaviorApi
|
|
8474
8455
|
*/
|
|
8475
|
-
|
|
8456
|
+
getMotionGroupBehavior(cell: string, controller: string, motionGroup: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<MotionGroupBehaviorGetter, any>>;
|
|
8476
8457
|
/**
|
|
8477
|
-
*
|
|
8478
|
-
* @summary
|
|
8458
|
+
* Switch robot motion group behavior.
|
|
8459
|
+
* @summary Switch Behavior
|
|
8479
8460
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8480
8461
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
8481
|
-
* @param {string}
|
|
8482
|
-
* @param {
|
|
8462
|
+
* @param {string} motionGroup The motion-group identifier.
|
|
8463
|
+
* @param {Behavior} [behavior]
|
|
8483
8464
|
* @param {*} [options] Override http request option.
|
|
8484
8465
|
* @throws {RequiredError}
|
|
8466
|
+
* @memberof VirtualRobotBehaviorApi
|
|
8485
8467
|
*/
|
|
8486
|
-
|
|
8468
|
+
setMotionGroupBehavior(cell: string, controller: string, motionGroup: string, behavior?: Behavior, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
8469
|
+
}
|
|
8470
|
+
/**
|
|
8471
|
+
* VirtualRobotModeApi - axios parameter creator
|
|
8472
|
+
* @export
|
|
8473
|
+
*/
|
|
8474
|
+
export declare const VirtualRobotModeApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
8487
8475
|
/**
|
|
8488
|
-
*
|
|
8489
|
-
* @summary
|
|
8476
|
+
* Get the cycle time of controller communication in [ms].
|
|
8477
|
+
* @summary Cycle Time
|
|
8490
8478
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8491
8479
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
8492
|
-
* @param {string} motionGroup The motion-group identifier.
|
|
8493
|
-
* @param {string} tcp The unique identifier of a TCP.
|
|
8494
8480
|
* @param {*} [options] Override http request option.
|
|
8495
8481
|
* @throws {RequiredError}
|
|
8496
8482
|
*/
|
|
8497
|
-
|
|
8483
|
+
getCycleTime: (cell: string, controller: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
8498
8484
|
/**
|
|
8499
8485
|
* Requests the Emergency Stop state of the virtual robot controller. Use [getCurrentMotionGroupState](getCurrentMotionGroupState) to get the Emergency Stop state regardless of the controller type. There the Emergency Stop state is visible as the `safety_state`. > **NOTE** > > The Emergency Stop state can only be changed when using virtual robot controllers.
|
|
8500
8486
|
* @summary Get Emergency Stop State
|
|
@@ -8503,64 +8489,69 @@ export declare const VirtualControllerApiFactory: (configuration?: Configuration
|
|
|
8503
8489
|
* @param {*} [options] Override http request option.
|
|
8504
8490
|
* @throws {RequiredError}
|
|
8505
8491
|
*/
|
|
8506
|
-
getEmergencyStop(cell: string, controller: string, options?: RawAxiosRequestConfig)
|
|
8492
|
+
getEmergencyStop: (cell: string, controller: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
8507
8493
|
/**
|
|
8508
|
-
*
|
|
8509
|
-
* @summary Get
|
|
8494
|
+
* Requests the Operation Mode of the virtual robot controller. 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.
|
|
8495
|
+
* @summary Get Operation Mode
|
|
8510
8496
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8511
8497
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
8512
|
-
* @param {string} motionGroup The motion-group identifier.
|
|
8513
8498
|
* @param {*} [options] Override http request option.
|
|
8514
8499
|
* @throws {RequiredError}
|
|
8515
8500
|
*/
|
|
8516
|
-
|
|
8501
|
+
getOperationMode: (cell: string, controller: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
8517
8502
|
/**
|
|
8518
|
-
*
|
|
8519
|
-
* @summary
|
|
8503
|
+
* Activates or releases the Emergency Stop on the virtual robot controller. Activating the Emergency Stop stops the execution of all motions. The stop is executed on physical controllers immediately not gracefully and not on paths. Due to restricted physical behavior of the virtual robot controller, the Emergency Stop is executed on paths. To return to normal operation the Emergency Stop needs to be released. Use [getCurrentMotionGroupState](getCurrentMotionGroupState) to get the Emergency Stop state regardless of the controller type. There the Emergency Stop state is visible as the `safety_state`. > **NOTE** > > The Emergency Stop state can only be changed via API when using virtual robot controllers.
|
|
8504
|
+
* @summary Push or Release Emergency Stop
|
|
8520
8505
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8521
8506
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
8507
|
+
* @param {boolean} [active]
|
|
8522
8508
|
* @param {*} [options] Override http request option.
|
|
8523
8509
|
* @throws {RequiredError}
|
|
8524
8510
|
*/
|
|
8525
|
-
|
|
8511
|
+
setEmergencyStop: (cell: string, controller: string, active?: boolean, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
8526
8512
|
/**
|
|
8527
|
-
*
|
|
8528
|
-
* @summary
|
|
8513
|
+
* 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.
|
|
8514
|
+
* @summary Set Operation Mode
|
|
8529
8515
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8530
8516
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
8517
|
+
* @param {OperationMode} mode
|
|
8531
8518
|
* @param {*} [options] Override http request option.
|
|
8532
8519
|
* @throws {RequiredError}
|
|
8533
8520
|
*/
|
|
8534
|
-
|
|
8521
|
+
setOperationMode: (cell: string, controller: string, mode: OperationMode, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
8522
|
+
};
|
|
8523
|
+
/**
|
|
8524
|
+
* VirtualRobotModeApi - functional programming interface
|
|
8525
|
+
* @export
|
|
8526
|
+
*/
|
|
8527
|
+
export declare const VirtualRobotModeApiFp: (configuration?: Configuration) => {
|
|
8535
8528
|
/**
|
|
8536
|
-
*
|
|
8537
|
-
* @summary
|
|
8529
|
+
* Get the cycle time of controller communication in [ms].
|
|
8530
|
+
* @summary Cycle Time
|
|
8538
8531
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8539
8532
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
8540
|
-
* @param {string} motionGroup The motion-group identifier.
|
|
8541
8533
|
* @param {*} [options] Override http request option.
|
|
8542
8534
|
* @throws {RequiredError}
|
|
8543
8535
|
*/
|
|
8544
|
-
|
|
8536
|
+
getCycleTime(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CycleTime>>;
|
|
8545
8537
|
/**
|
|
8546
|
-
*
|
|
8547
|
-
* @summary
|
|
8538
|
+
* Requests the Emergency Stop state of the virtual robot controller. Use [getCurrentMotionGroupState](getCurrentMotionGroupState) to get the Emergency Stop state regardless of the controller type. There the Emergency Stop state is visible as the `safety_state`. > **NOTE** > > The Emergency Stop state can only be changed when using virtual robot controllers.
|
|
8539
|
+
* @summary Get Emergency Stop State
|
|
8548
8540
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8549
8541
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
8550
8542
|
* @param {*} [options] Override http request option.
|
|
8551
8543
|
* @throws {RequiredError}
|
|
8552
8544
|
*/
|
|
8553
|
-
|
|
8545
|
+
getEmergencyStop(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Flag>>;
|
|
8554
8546
|
/**
|
|
8555
|
-
*
|
|
8556
|
-
* @summary
|
|
8547
|
+
* Requests the Operation Mode of the virtual robot controller. 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.
|
|
8548
|
+
* @summary Get Operation Mode
|
|
8557
8549
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8558
8550
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
8559
|
-
* @param {string} motionGroup The motion-group identifier.
|
|
8560
8551
|
* @param {*} [options] Override http request option.
|
|
8561
8552
|
* @throws {RequiredError}
|
|
8562
8553
|
*/
|
|
8563
|
-
|
|
8554
|
+
getOperationMode(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<OpMode>>;
|
|
8564
8555
|
/**
|
|
8565
8556
|
* Activates or releases the Emergency Stop on the virtual robot controller. Activating the Emergency Stop stops the execution of all motions. The stop is executed on physical controllers immediately not gracefully and not on paths. Due to restricted physical behavior of the virtual robot controller, the Emergency Stop is executed on paths. To return to normal operation the Emergency Stop needs to be released. Use [getCurrentMotionGroupState](getCurrentMotionGroupState) to get the Emergency Stop state regardless of the controller type. There the Emergency Stop state is visible as the `safety_state`. > **NOTE** > > The Emergency Stop state can only be changed via API when using virtual robot controllers.
|
|
8566
8557
|
* @summary Push or Release Emergency Stop
|
|
@@ -8570,18 +8561,7 @@ export declare const VirtualControllerApiFactory: (configuration?: Configuration
|
|
|
8570
8561
|
* @param {*} [options] Override http request option.
|
|
8571
8562
|
* @throws {RequiredError}
|
|
8572
8563
|
*/
|
|
8573
|
-
setEmergencyStop(cell: string, controller: string, active?: boolean, options?: RawAxiosRequestConfig): AxiosPromise<void
|
|
8574
|
-
/**
|
|
8575
|
-
* 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.
|
|
8576
|
-
* @summary Set Motion Group State
|
|
8577
|
-
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8578
|
-
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
8579
|
-
* @param {string} motionGroup The motion-group identifier.
|
|
8580
|
-
* @param {MotionGroupJoints} motionGroupJoints
|
|
8581
|
-
* @param {*} [options] Override http request option.
|
|
8582
|
-
* @throws {RequiredError}
|
|
8583
|
-
*/
|
|
8584
|
-
setMotionGroupState(cell: string, controller: string, motionGroup: string, motionGroupJoints: MotionGroupJoints, options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
8564
|
+
setEmergencyStop(cell: string, controller: string, active?: boolean, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
8585
8565
|
/**
|
|
8586
8566
|
* 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.
|
|
8587
8567
|
* @summary Set Operation Mode
|
|
@@ -8591,106 +8571,88 @@ export declare const VirtualControllerApiFactory: (configuration?: Configuration
|
|
|
8591
8571
|
* @param {*} [options] Override http request option.
|
|
8592
8572
|
* @throws {RequiredError}
|
|
8593
8573
|
*/
|
|
8594
|
-
setOperationMode(cell: string, controller: string, mode: OperationMode, options?: RawAxiosRequestConfig): AxiosPromise<void
|
|
8595
|
-
/**
|
|
8596
|
-
* Sets motion group mounting by specifying a coordinate system. The motion group will be based on the coordinate system\'s origin. The coordinate system defines a transformation offset. The transformation offset is defined by a unique identifier, a name for front end usage and an offset in another coordinate system referenced by the unique identifier of the reference coordinate system.
|
|
8597
|
-
* @summary Set Mounting
|
|
8598
|
-
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8599
|
-
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
8600
|
-
* @param {string} motionGroup The motion-group identifier.
|
|
8601
|
-
* @param {CoordinateSystem} coordinateSystem
|
|
8602
|
-
* @param {*} [options] Override http request option.
|
|
8603
|
-
* @throws {RequiredError}
|
|
8604
|
-
*/
|
|
8605
|
-
setVirtualControllerMounting(cell: string, controller: string, motionGroup: string, coordinateSystem: CoordinateSystem, options?: RawAxiosRequestConfig): AxiosPromise<CoordinateSystem>;
|
|
8574
|
+
setOperationMode(cell: string, controller: string, mode: OperationMode, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
8606
8575
|
};
|
|
8607
8576
|
/**
|
|
8608
|
-
*
|
|
8577
|
+
* VirtualRobotModeApi - factory interface
|
|
8609
8578
|
* @export
|
|
8610
|
-
* @class VirtualControllerApi
|
|
8611
|
-
* @extends {BaseAPI}
|
|
8612
8579
|
*/
|
|
8613
|
-
export declare
|
|
8580
|
+
export declare const VirtualRobotModeApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
8614
8581
|
/**
|
|
8615
|
-
*
|
|
8616
|
-
* @summary
|
|
8582
|
+
* Get the cycle time of controller communication in [ms].
|
|
8583
|
+
* @summary Cycle Time
|
|
8617
8584
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8618
8585
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
8619
|
-
* @param {string} coordinateSystem Unique identifier addressing a coordinate system.
|
|
8620
|
-
* @param {CoordinateSystemData} coordinateSystemData
|
|
8621
8586
|
* @param {*} [options] Override http request option.
|
|
8622
8587
|
* @throws {RequiredError}
|
|
8623
|
-
* @memberof VirtualControllerApi
|
|
8624
8588
|
*/
|
|
8625
|
-
|
|
8589
|
+
getCycleTime(cell: string, controller: string, options?: RawAxiosRequestConfig): AxiosPromise<CycleTime>;
|
|
8626
8590
|
/**
|
|
8627
|
-
*
|
|
8628
|
-
* @summary
|
|
8591
|
+
* Requests the Emergency Stop state of the virtual robot controller. Use [getCurrentMotionGroupState](getCurrentMotionGroupState) to get the Emergency Stop state regardless of the controller type. There the Emergency Stop state is visible as the `safety_state`. > **NOTE** > > The Emergency Stop state can only be changed when using virtual robot controllers.
|
|
8592
|
+
* @summary Get Emergency Stop State
|
|
8629
8593
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8630
8594
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
8631
|
-
* @param {string} motionGroup The motion-group identifier.
|
|
8632
|
-
* @param {string} tcp The unique identifier of a TCP.
|
|
8633
|
-
* @param {RobotTcpData} robotTcpData
|
|
8634
8595
|
* @param {*} [options] Override http request option.
|
|
8635
8596
|
* @throws {RequiredError}
|
|
8636
|
-
* @memberof VirtualControllerApi
|
|
8637
8597
|
*/
|
|
8638
|
-
|
|
8598
|
+
getEmergencyStop(cell: string, controller: string, options?: RawAxiosRequestConfig): AxiosPromise<Flag>;
|
|
8639
8599
|
/**
|
|
8640
|
-
*
|
|
8641
|
-
* @summary
|
|
8600
|
+
* Requests the Operation Mode of the virtual robot controller. 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.
|
|
8601
|
+
* @summary Get Operation Mode
|
|
8642
8602
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8643
8603
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
8644
|
-
* @param {string} coordinateSystem Unique identifier addressing a coordinate system.
|
|
8645
|
-
* @param {boolean} [deleteDependent] If true, all dependent coordinate systems will be deleted as well.
|
|
8646
8604
|
* @param {*} [options] Override http request option.
|
|
8647
8605
|
* @throws {RequiredError}
|
|
8648
|
-
* @memberof VirtualControllerApi
|
|
8649
8606
|
*/
|
|
8650
|
-
|
|
8607
|
+
getOperationMode(cell: string, controller: string, options?: RawAxiosRequestConfig): AxiosPromise<OpMode>;
|
|
8651
8608
|
/**
|
|
8652
|
-
*
|
|
8653
|
-
* @summary
|
|
8609
|
+
* Activates or releases the Emergency Stop on the virtual robot controller. Activating the Emergency Stop stops the execution of all motions. The stop is executed on physical controllers immediately not gracefully and not on paths. Due to restricted physical behavior of the virtual robot controller, the Emergency Stop is executed on paths. To return to normal operation the Emergency Stop needs to be released. Use [getCurrentMotionGroupState](getCurrentMotionGroupState) to get the Emergency Stop state regardless of the controller type. There the Emergency Stop state is visible as the `safety_state`. > **NOTE** > > The Emergency Stop state can only be changed via API when using virtual robot controllers.
|
|
8610
|
+
* @summary Push or Release Emergency Stop
|
|
8654
8611
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8655
8612
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
8656
|
-
* @param {
|
|
8657
|
-
* @param {string} tcp The unique identifier of a TCP.
|
|
8613
|
+
* @param {boolean} [active]
|
|
8658
8614
|
* @param {*} [options] Override http request option.
|
|
8659
8615
|
* @throws {RequiredError}
|
|
8660
|
-
* @memberof VirtualControllerApi
|
|
8661
8616
|
*/
|
|
8662
|
-
|
|
8617
|
+
setEmergencyStop(cell: string, controller: string, active?: boolean, options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
8663
8618
|
/**
|
|
8664
|
-
*
|
|
8665
|
-
* @summary
|
|
8619
|
+
* 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.
|
|
8620
|
+
* @summary Set Operation Mode
|
|
8666
8621
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8667
8622
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
8623
|
+
* @param {OperationMode} mode
|
|
8668
8624
|
* @param {*} [options] Override http request option.
|
|
8669
8625
|
* @throws {RequiredError}
|
|
8670
|
-
* @memberof VirtualControllerApi
|
|
8671
8626
|
*/
|
|
8672
|
-
|
|
8627
|
+
setOperationMode(cell: string, controller: string, mode: OperationMode, options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
8628
|
+
};
|
|
8629
|
+
/**
|
|
8630
|
+
* VirtualRobotModeApi - object-oriented interface
|
|
8631
|
+
* @export
|
|
8632
|
+
* @class VirtualRobotModeApi
|
|
8633
|
+
* @extends {BaseAPI}
|
|
8634
|
+
*/
|
|
8635
|
+
export declare class VirtualRobotModeApi extends BaseAPI {
|
|
8673
8636
|
/**
|
|
8674
|
-
* Get the
|
|
8675
|
-
* @summary
|
|
8637
|
+
* Get the cycle time of controller communication in [ms].
|
|
8638
|
+
* @summary Cycle Time
|
|
8676
8639
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8677
8640
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
8678
|
-
* @param {string} motionGroup The motion-group identifier.
|
|
8679
8641
|
* @param {*} [options] Override http request option.
|
|
8680
8642
|
* @throws {RequiredError}
|
|
8681
|
-
* @memberof
|
|
8643
|
+
* @memberof VirtualRobotModeApi
|
|
8682
8644
|
*/
|
|
8683
|
-
|
|
8645
|
+
getCycleTime(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CycleTime, any>>;
|
|
8684
8646
|
/**
|
|
8685
|
-
*
|
|
8686
|
-
* @summary
|
|
8647
|
+
* Requests the Emergency Stop state of the virtual robot controller. Use [getCurrentMotionGroupState](getCurrentMotionGroupState) to get the Emergency Stop state regardless of the controller type. There the Emergency Stop state is visible as the `safety_state`. > **NOTE** > > The Emergency Stop state can only be changed when using virtual robot controllers.
|
|
8648
|
+
* @summary Get Emergency Stop State
|
|
8687
8649
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8688
8650
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
8689
8651
|
* @param {*} [options] Override http request option.
|
|
8690
8652
|
* @throws {RequiredError}
|
|
8691
|
-
* @memberof
|
|
8653
|
+
* @memberof VirtualRobotModeApi
|
|
8692
8654
|
*/
|
|
8693
|
-
|
|
8655
|
+
getEmergencyStop(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Flag, any>>;
|
|
8694
8656
|
/**
|
|
8695
8657
|
* Requests the Operation Mode of the virtual robot controller. 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.
|
|
8696
8658
|
* @summary Get Operation Mode
|
|
@@ -8698,428 +8660,395 @@ export declare class VirtualControllerApi extends BaseAPI {
|
|
|
8698
8660
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
8699
8661
|
* @param {*} [options] Override http request option.
|
|
8700
8662
|
* @throws {RequiredError}
|
|
8701
|
-
* @memberof
|
|
8663
|
+
* @memberof VirtualRobotModeApi
|
|
8702
8664
|
*/
|
|
8703
8665
|
getOperationMode(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<OpMode, any>>;
|
|
8704
8666
|
/**
|
|
8705
|
-
*
|
|
8706
|
-
* @summary
|
|
8707
|
-
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8708
|
-
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
8709
|
-
* @param {string} motionGroup The motion-group identifier.
|
|
8710
|
-
* @param {*} [options] Override http request option.
|
|
8711
|
-
* @throws {RequiredError}
|
|
8712
|
-
* @memberof VirtualControllerApi
|
|
8713
|
-
*/
|
|
8714
|
-
getVirtualControllerMounting(cell: string, controller: string, motionGroup: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CoordinateSystem, any>>;
|
|
8715
|
-
/**
|
|
8716
|
-
* Lists all coordinate systems on the robot controller.
|
|
8717
|
-
* @summary List Coordinate Systems
|
|
8667
|
+
* Activates or releases the Emergency Stop on the virtual robot controller. Activating the Emergency Stop stops the execution of all motions. The stop is executed on physical controllers immediately not gracefully and not on paths. Due to restricted physical behavior of the virtual robot controller, the Emergency Stop is executed on paths. To return to normal operation the Emergency Stop needs to be released. Use [getCurrentMotionGroupState](getCurrentMotionGroupState) to get the Emergency Stop state regardless of the controller type. There the Emergency Stop state is visible as the `safety_state`. > **NOTE** > > The Emergency Stop state can only be changed via API when using virtual robot controllers.
|
|
8668
|
+
* @summary Push or Release Emergency Stop
|
|
8718
8669
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8719
8670
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
8671
|
+
* @param {boolean} [active]
|
|
8720
8672
|
* @param {*} [options] Override http request option.
|
|
8721
8673
|
* @throws {RequiredError}
|
|
8722
|
-
* @memberof
|
|
8674
|
+
* @memberof VirtualRobotModeApi
|
|
8723
8675
|
*/
|
|
8724
|
-
|
|
8676
|
+
setEmergencyStop(cell: string, controller: string, active?: boolean, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
8725
8677
|
/**
|
|
8726
|
-
*
|
|
8727
|
-
* @summary
|
|
8678
|
+
* 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.
|
|
8679
|
+
* @summary Set Operation Mode
|
|
8728
8680
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8729
8681
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
8730
|
-
* @param {
|
|
8682
|
+
* @param {OperationMode} mode
|
|
8731
8683
|
* @param {*} [options] Override http request option.
|
|
8732
8684
|
* @throws {RequiredError}
|
|
8733
|
-
* @memberof
|
|
8685
|
+
* @memberof VirtualRobotModeApi
|
|
8734
8686
|
*/
|
|
8735
|
-
|
|
8687
|
+
setOperationMode(cell: string, controller: string, mode: OperationMode, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
8688
|
+
}
|
|
8689
|
+
/**
|
|
8690
|
+
* VirtualRobotSetupApi - axios parameter creator
|
|
8691
|
+
* @export
|
|
8692
|
+
*/
|
|
8693
|
+
export declare const VirtualRobotSetupApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
8736
8694
|
/**
|
|
8737
|
-
*
|
|
8738
|
-
* @summary
|
|
8695
|
+
* Adds a coordinate system to the robot controller.
|
|
8696
|
+
* @summary Add Coordinate Systems
|
|
8739
8697
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8740
8698
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
8741
|
-
* @param {
|
|
8699
|
+
* @param {CoordinateSystem} coordinateSystem
|
|
8742
8700
|
* @param {*} [options] Override http request option.
|
|
8743
8701
|
* @throws {RequiredError}
|
|
8744
|
-
* @memberof VirtualControllerApi
|
|
8745
8702
|
*/
|
|
8746
|
-
|
|
8703
|
+
addVirtualRobotCoordinateSystem: (cell: string, controller: string, coordinateSystem: CoordinateSystem, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
8747
8704
|
/**
|
|
8748
|
-
*
|
|
8749
|
-
* @summary
|
|
8705
|
+
* 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.
|
|
8706
|
+
* @summary Add TCP
|
|
8750
8707
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8751
8708
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
8752
8709
|
* @param {string} motionGroup The motion-group identifier.
|
|
8753
|
-
* @param {
|
|
8710
|
+
* @param {RobotTcp} robotTcp
|
|
8754
8711
|
* @param {*} [options] Override http request option.
|
|
8755
8712
|
* @throws {RequiredError}
|
|
8756
|
-
* @memberof VirtualControllerApi
|
|
8757
8713
|
*/
|
|
8758
|
-
|
|
8714
|
+
addVirtualRobotTcp: (cell: string, controller: string, motionGroup: string, robotTcp: RobotTcp, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
8759
8715
|
/**
|
|
8760
|
-
*
|
|
8761
|
-
* @summary
|
|
8716
|
+
* 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.
|
|
8717
|
+
* @summary Remove Coordinate System
|
|
8762
8718
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8763
8719
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
8764
|
-
* @param {
|
|
8720
|
+
* @param {string} coordinateSystem Unique identifier addressing a coordinate system.
|
|
8721
|
+
* @param {boolean} [deleteDependent] If true, all dependent coordinate systems will be deleted as well.
|
|
8765
8722
|
* @param {*} [options] Override http request option.
|
|
8766
8723
|
* @throws {RequiredError}
|
|
8767
|
-
* @memberof VirtualControllerApi
|
|
8768
8724
|
*/
|
|
8769
|
-
|
|
8725
|
+
deleteVirtualRobotCoordinateSystem: (cell: string, controller: string, coordinateSystem: string, deleteDependent?: boolean, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
8770
8726
|
/**
|
|
8771
|
-
*
|
|
8772
|
-
* @summary
|
|
8727
|
+
* Removes the TCP from the motion group. An unknown TCP is a valid input.
|
|
8728
|
+
* @summary Remove TCP
|
|
8773
8729
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8774
8730
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
8775
8731
|
* @param {string} motionGroup The motion-group identifier.
|
|
8776
|
-
* @param {
|
|
8732
|
+
* @param {string} tcp The unique identifier of a TCP.
|
|
8777
8733
|
* @param {*} [options] Override http request option.
|
|
8778
8734
|
* @throws {RequiredError}
|
|
8779
|
-
* @memberof VirtualControllerApi
|
|
8780
8735
|
*/
|
|
8781
|
-
|
|
8782
|
-
}
|
|
8783
|
-
/**
|
|
8784
|
-
* VirtualControllerBehaviorApi - axios parameter creator
|
|
8785
|
-
* @export
|
|
8786
|
-
*/
|
|
8787
|
-
export declare const VirtualControllerBehaviorApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
8736
|
+
deleteVirtualRobotTcp: (cell: string, controller: string, motionGroup: string, tcp: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
8788
8737
|
/**
|
|
8789
|
-
*
|
|
8790
|
-
* @summary
|
|
8738
|
+
* Gets motion group mounting. The motion group is based on the origin of the returned coordinate system.
|
|
8739
|
+
* @summary Get Mounting
|
|
8791
8740
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8792
8741
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
8793
|
-
* @param {
|
|
8742
|
+
* @param {string} motionGroup The motion-group identifier.
|
|
8794
8743
|
* @param {*} [options] Override http request option.
|
|
8795
8744
|
* @throws {RequiredError}
|
|
8796
8745
|
*/
|
|
8797
|
-
|
|
8746
|
+
getVirtualRobotMounting: (cell: string, controller: string, motionGroup: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
8798
8747
|
/**
|
|
8799
|
-
*
|
|
8800
|
-
* @summary
|
|
8748
|
+
* Lists all coordinate systems on the robot controller.
|
|
8749
|
+
* @summary List Coordinate Systems
|
|
8801
8750
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8802
8751
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
8803
8752
|
* @param {*} [options] Override http request option.
|
|
8804
8753
|
* @throws {RequiredError}
|
|
8805
8754
|
*/
|
|
8806
|
-
|
|
8755
|
+
listVirtualRobotCoordinateSystems: (cell: string, controller: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
8807
8756
|
/**
|
|
8808
|
-
*
|
|
8809
|
-
* @summary
|
|
8757
|
+
* Lists TCPs of the motion group. An empty TCP list is valid, for example for external axes.
|
|
8758
|
+
* @summary List TCPs
|
|
8810
8759
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8811
8760
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
8761
|
+
* @param {string} motionGroup The motion-group identifier.
|
|
8812
8762
|
* @param {*} [options] Override http request option.
|
|
8813
8763
|
* @throws {RequiredError}
|
|
8814
8764
|
*/
|
|
8815
|
-
|
|
8765
|
+
listVirtualRobotTcps: (cell: string, controller: string, motionGroup: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
8816
8766
|
/**
|
|
8817
|
-
*
|
|
8818
|
-
* @summary Set
|
|
8767
|
+
* Sets motion group mounting by specifying a coordinate system. The motion group will be based on the coordinate system\'s origin. The coordinate system defines a transformation offset. The transformation offset is defined by a unique identifier, a name for front end usage and an offset in another coordinate system referenced by the unique identifier of the reference coordinate system.
|
|
8768
|
+
* @summary Set Mounting
|
|
8819
8769
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8820
8770
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
8821
|
-
* @param {
|
|
8771
|
+
* @param {string} motionGroup The motion-group identifier.
|
|
8772
|
+
* @param {CoordinateSystem} coordinateSystem
|
|
8822
8773
|
* @param {*} [options] Override http request option.
|
|
8823
8774
|
* @throws {RequiredError}
|
|
8824
8775
|
*/
|
|
8825
|
-
|
|
8776
|
+
setVirtualRobotMounting: (cell: string, controller: string, motionGroup: string, coordinateSystem: CoordinateSystem, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
8826
8777
|
};
|
|
8827
8778
|
/**
|
|
8828
|
-
*
|
|
8779
|
+
* VirtualRobotSetupApi - functional programming interface
|
|
8829
8780
|
* @export
|
|
8830
8781
|
*/
|
|
8831
|
-
export declare const
|
|
8782
|
+
export declare const VirtualRobotSetupApiFp: (configuration?: Configuration) => {
|
|
8832
8783
|
/**
|
|
8833
|
-
*
|
|
8834
|
-
* @summary
|
|
8784
|
+
* Adds a coordinate system to the robot controller.
|
|
8785
|
+
* @summary Add Coordinate Systems
|
|
8835
8786
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8836
8787
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
8837
|
-
* @param {
|
|
8788
|
+
* @param {CoordinateSystem} coordinateSystem
|
|
8838
8789
|
* @param {*} [options] Override http request option.
|
|
8839
8790
|
* @throws {RequiredError}
|
|
8840
8791
|
*/
|
|
8841
|
-
|
|
8792
|
+
addVirtualRobotCoordinateSystem(cell: string, controller: string, coordinateSystem: CoordinateSystem, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
8842
8793
|
/**
|
|
8843
|
-
*
|
|
8844
|
-
* @summary
|
|
8794
|
+
* 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.
|
|
8795
|
+
* @summary Add TCP
|
|
8845
8796
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8846
8797
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
8798
|
+
* @param {string} motionGroup The motion-group identifier.
|
|
8799
|
+
* @param {RobotTcp} robotTcp
|
|
8847
8800
|
* @param {*} [options] Override http request option.
|
|
8848
8801
|
* @throws {RequiredError}
|
|
8849
8802
|
*/
|
|
8850
|
-
|
|
8803
|
+
addVirtualRobotTcp(cell: string, controller: string, motionGroup: string, robotTcp: RobotTcp, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
8851
8804
|
/**
|
|
8852
|
-
*
|
|
8853
|
-
* @summary
|
|
8805
|
+
* 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.
|
|
8806
|
+
* @summary Remove Coordinate System
|
|
8854
8807
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8855
8808
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
8809
|
+
* @param {string} coordinateSystem Unique identifier addressing a coordinate system.
|
|
8810
|
+
* @param {boolean} [deleteDependent] If true, all dependent coordinate systems will be deleted as well.
|
|
8856
8811
|
* @param {*} [options] Override http request option.
|
|
8857
8812
|
* @throws {RequiredError}
|
|
8858
8813
|
*/
|
|
8859
|
-
|
|
8814
|
+
deleteVirtualRobotCoordinateSystem(cell: string, controller: string, coordinateSystem: string, deleteDependent?: boolean, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
8860
8815
|
/**
|
|
8861
|
-
*
|
|
8862
|
-
* @summary
|
|
8816
|
+
* Removes the TCP from the motion group. An unknown TCP is a valid input.
|
|
8817
|
+
* @summary Remove TCP
|
|
8863
8818
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8864
8819
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
8865
|
-
* @param {
|
|
8820
|
+
* @param {string} motionGroup The motion-group identifier.
|
|
8821
|
+
* @param {string} tcp The unique identifier of a TCP.
|
|
8866
8822
|
* @param {*} [options] Override http request option.
|
|
8867
8823
|
* @throws {RequiredError}
|
|
8868
8824
|
*/
|
|
8869
|
-
|
|
8870
|
-
};
|
|
8871
|
-
/**
|
|
8872
|
-
* VirtualControllerBehaviorApi - factory interface
|
|
8873
|
-
* @export
|
|
8874
|
-
*/
|
|
8875
|
-
export declare const VirtualControllerBehaviorApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
8825
|
+
deleteVirtualRobotTcp(cell: string, controller: string, motionGroup: string, tcp: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
8876
8826
|
/**
|
|
8877
|
-
*
|
|
8878
|
-
* @summary
|
|
8827
|
+
* Gets motion group mounting. The motion group is based on the origin of the returned coordinate system.
|
|
8828
|
+
* @summary Get Mounting
|
|
8879
8829
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8880
8830
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
8881
|
-
* @param {
|
|
8831
|
+
* @param {string} motionGroup The motion-group identifier.
|
|
8882
8832
|
* @param {*} [options] Override http request option.
|
|
8883
8833
|
* @throws {RequiredError}
|
|
8884
8834
|
*/
|
|
8885
|
-
|
|
8835
|
+
getVirtualRobotMounting(cell: string, controller: string, motionGroup: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CoordinateSystem>>;
|
|
8886
8836
|
/**
|
|
8887
|
-
*
|
|
8888
|
-
* @summary
|
|
8837
|
+
* Lists all coordinate systems on the robot controller.
|
|
8838
|
+
* @summary List Coordinate Systems
|
|
8889
8839
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8890
8840
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
8891
8841
|
* @param {*} [options] Override http request option.
|
|
8892
8842
|
* @throws {RequiredError}
|
|
8893
8843
|
*/
|
|
8894
|
-
|
|
8844
|
+
listVirtualRobotCoordinateSystems(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CoordinateSystems>>;
|
|
8895
8845
|
/**
|
|
8896
|
-
*
|
|
8897
|
-
* @summary
|
|
8846
|
+
* Lists TCPs of the motion group. An empty TCP list is valid, for example for external axes.
|
|
8847
|
+
* @summary List TCPs
|
|
8898
8848
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8899
8849
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
8850
|
+
* @param {string} motionGroup The motion-group identifier.
|
|
8900
8851
|
* @param {*} [options] Override http request option.
|
|
8901
8852
|
* @throws {RequiredError}
|
|
8902
8853
|
*/
|
|
8903
|
-
|
|
8854
|
+
listVirtualRobotTcps(cell: string, controller: string, motionGroup: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<RobotTcps>>;
|
|
8904
8855
|
/**
|
|
8905
|
-
*
|
|
8906
|
-
* @summary Set
|
|
8856
|
+
* Sets motion group mounting by specifying a coordinate system. The motion group will be based on the coordinate system\'s origin. The coordinate system defines a transformation offset. The transformation offset is defined by a unique identifier, a name for front end usage and an offset in another coordinate system referenced by the unique identifier of the reference coordinate system.
|
|
8857
|
+
* @summary Set Mounting
|
|
8907
8858
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8908
8859
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
8909
|
-
* @param {
|
|
8860
|
+
* @param {string} motionGroup The motion-group identifier.
|
|
8861
|
+
* @param {CoordinateSystem} coordinateSystem
|
|
8910
8862
|
* @param {*} [options] Override http request option.
|
|
8911
8863
|
* @throws {RequiredError}
|
|
8912
8864
|
*/
|
|
8913
|
-
|
|
8865
|
+
setVirtualRobotMounting(cell: string, controller: string, motionGroup: string, coordinateSystem: CoordinateSystem, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CoordinateSystem>>;
|
|
8914
8866
|
};
|
|
8915
8867
|
/**
|
|
8916
|
-
*
|
|
8868
|
+
* VirtualRobotSetupApi - factory interface
|
|
8917
8869
|
* @export
|
|
8918
|
-
* @class VirtualControllerBehaviorApi
|
|
8919
|
-
* @extends {BaseAPI}
|
|
8920
8870
|
*/
|
|
8921
|
-
export declare
|
|
8871
|
+
export declare const VirtualRobotSetupApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
8922
8872
|
/**
|
|
8923
|
-
*
|
|
8924
|
-
* @summary
|
|
8873
|
+
* Adds a coordinate system to the robot controller.
|
|
8874
|
+
* @summary Add Coordinate Systems
|
|
8925
8875
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8926
8876
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
8927
|
-
* @param {
|
|
8877
|
+
* @param {CoordinateSystem} coordinateSystem
|
|
8928
8878
|
* @param {*} [options] Override http request option.
|
|
8929
8879
|
* @throws {RequiredError}
|
|
8930
|
-
* @memberof VirtualControllerBehaviorApi
|
|
8931
8880
|
*/
|
|
8932
|
-
|
|
8881
|
+
addVirtualRobotCoordinateSystem(cell: string, controller: string, coordinateSystem: CoordinateSystem, options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
8933
8882
|
/**
|
|
8934
|
-
*
|
|
8935
|
-
* @summary
|
|
8883
|
+
* 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.
|
|
8884
|
+
* @summary Add TCP
|
|
8936
8885
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8937
8886
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
8887
|
+
* @param {string} motionGroup The motion-group identifier.
|
|
8888
|
+
* @param {RobotTcp} robotTcp
|
|
8938
8889
|
* @param {*} [options] Override http request option.
|
|
8939
8890
|
* @throws {RequiredError}
|
|
8940
|
-
* @memberof VirtualControllerBehaviorApi
|
|
8941
8891
|
*/
|
|
8942
|
-
|
|
8892
|
+
addVirtualRobotTcp(cell: string, controller: string, motionGroup: string, robotTcp: RobotTcp, options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
8943
8893
|
/**
|
|
8944
|
-
*
|
|
8945
|
-
* @summary
|
|
8894
|
+
* 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.
|
|
8895
|
+
* @summary Remove Coordinate System
|
|
8946
8896
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8947
8897
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
8898
|
+
* @param {string} coordinateSystem Unique identifier addressing a coordinate system.
|
|
8899
|
+
* @param {boolean} [deleteDependent] If true, all dependent coordinate systems will be deleted as well.
|
|
8948
8900
|
* @param {*} [options] Override http request option.
|
|
8949
8901
|
* @throws {RequiredError}
|
|
8950
|
-
* @memberof VirtualControllerBehaviorApi
|
|
8951
8902
|
*/
|
|
8952
|
-
|
|
8903
|
+
deleteVirtualRobotCoordinateSystem(cell: string, controller: string, coordinateSystem: string, deleteDependent?: boolean, options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
8953
8904
|
/**
|
|
8954
|
-
*
|
|
8955
|
-
* @summary
|
|
8905
|
+
* Removes the TCP from the motion group. An unknown TCP is a valid input.
|
|
8906
|
+
* @summary Remove TCP
|
|
8956
8907
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8957
8908
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
8958
|
-
* @param {
|
|
8909
|
+
* @param {string} motionGroup The motion-group identifier.
|
|
8910
|
+
* @param {string} tcp The unique identifier of a TCP.
|
|
8959
8911
|
* @param {*} [options] Override http request option.
|
|
8960
8912
|
* @throws {RequiredError}
|
|
8961
|
-
* @memberof VirtualControllerBehaviorApi
|
|
8962
8913
|
*/
|
|
8963
|
-
|
|
8964
|
-
}
|
|
8965
|
-
/**
|
|
8966
|
-
* VirtualControllerInputsOutputsApi - axios parameter creator
|
|
8967
|
-
* @export
|
|
8968
|
-
*/
|
|
8969
|
-
export declare const VirtualControllerInputsOutputsApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
8914
|
+
deleteVirtualRobotTcp(cell: string, controller: string, motionGroup: string, tcp: string, options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
8970
8915
|
/**
|
|
8971
|
-
*
|
|
8972
|
-
* @summary Get
|
|
8916
|
+
* Gets motion group mounting. The motion group is based on the origin of the returned coordinate system.
|
|
8917
|
+
* @summary Get Mounting
|
|
8973
8918
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8974
8919
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
8975
|
-
* @param {
|
|
8920
|
+
* @param {string} motionGroup The motion-group identifier.
|
|
8976
8921
|
* @param {*} [options] Override http request option.
|
|
8977
8922
|
* @throws {RequiredError}
|
|
8978
8923
|
*/
|
|
8979
|
-
|
|
8924
|
+
getVirtualRobotMounting(cell: string, controller: string, motionGroup: string, options?: RawAxiosRequestConfig): AxiosPromise<CoordinateSystem>;
|
|
8980
8925
|
/**
|
|
8981
|
-
* Lists
|
|
8982
|
-
* @summary List
|
|
8926
|
+
* Lists all coordinate systems on the robot controller.
|
|
8927
|
+
* @summary List Coordinate Systems
|
|
8983
8928
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8984
8929
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
8985
|
-
* @param {Array<string>} [ios]
|
|
8986
|
-
* @param {IODirection} [direction] Return only inputs/outputs with the specified direction.
|
|
8987
|
-
* @param {IOValueType} [valueType] Return only inputs/outputs with the specified value type.
|
|
8988
|
-
* @param {string} [group] Return only inputs/outputs from the specified group.
|
|
8989
8930
|
* @param {*} [options] Override http request option.
|
|
8990
8931
|
* @throws {RequiredError}
|
|
8991
8932
|
*/
|
|
8992
|
-
|
|
8933
|
+
listVirtualRobotCoordinateSystems(cell: string, controller: string, options?: RawAxiosRequestConfig): AxiosPromise<CoordinateSystems>;
|
|
8993
8934
|
/**
|
|
8994
|
-
*
|
|
8995
|
-
* @summary
|
|
8935
|
+
* Lists TCPs of the motion group. An empty TCP list is valid, for example for external axes.
|
|
8936
|
+
* @summary List TCPs
|
|
8996
8937
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8997
8938
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
8998
|
-
* @param {
|
|
8939
|
+
* @param {string} motionGroup The motion-group identifier.
|
|
8999
8940
|
* @param {*} [options] Override http request option.
|
|
9000
8941
|
* @throws {RequiredError}
|
|
9001
8942
|
*/
|
|
9002
|
-
|
|
9003
|
-
};
|
|
9004
|
-
/**
|
|
9005
|
-
* VirtualControllerInputsOutputsApi - functional programming interface
|
|
9006
|
-
* @export
|
|
9007
|
-
*/
|
|
9008
|
-
export declare const VirtualControllerInputsOutputsApiFp: (configuration?: Configuration) => {
|
|
8943
|
+
listVirtualRobotTcps(cell: string, controller: string, motionGroup: string, options?: RawAxiosRequestConfig): AxiosPromise<RobotTcps>;
|
|
9009
8944
|
/**
|
|
9010
|
-
*
|
|
9011
|
-
* @summary
|
|
8945
|
+
* Sets motion group mounting by specifying a coordinate system. The motion group will be based on the coordinate system\'s origin. The coordinate system defines a transformation offset. The transformation offset is defined by a unique identifier, a name for front end usage and an offset in another coordinate system referenced by the unique identifier of the reference coordinate system.
|
|
8946
|
+
* @summary Set Mounting
|
|
9012
8947
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
9013
8948
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
9014
|
-
* @param {
|
|
8949
|
+
* @param {string} motionGroup The motion-group identifier.
|
|
8950
|
+
* @param {CoordinateSystem} coordinateSystem
|
|
9015
8951
|
* @param {*} [options] Override http request option.
|
|
9016
8952
|
* @throws {RequiredError}
|
|
9017
8953
|
*/
|
|
9018
|
-
|
|
8954
|
+
setVirtualRobotMounting(cell: string, controller: string, motionGroup: string, coordinateSystem: CoordinateSystem, options?: RawAxiosRequestConfig): AxiosPromise<CoordinateSystem>;
|
|
8955
|
+
};
|
|
8956
|
+
/**
|
|
8957
|
+
* VirtualRobotSetupApi - object-oriented interface
|
|
8958
|
+
* @export
|
|
8959
|
+
* @class VirtualRobotSetupApi
|
|
8960
|
+
* @extends {BaseAPI}
|
|
8961
|
+
*/
|
|
8962
|
+
export declare class VirtualRobotSetupApi extends BaseAPI {
|
|
9019
8963
|
/**
|
|
9020
|
-
*
|
|
9021
|
-
* @summary
|
|
8964
|
+
* Adds a coordinate system to the robot controller.
|
|
8965
|
+
* @summary Add Coordinate Systems
|
|
9022
8966
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
9023
8967
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
9024
|
-
* @param {
|
|
9025
|
-
* @param {IODirection} [direction] Return only inputs/outputs with the specified direction.
|
|
9026
|
-
* @param {IOValueType} [valueType] Return only inputs/outputs with the specified value type.
|
|
9027
|
-
* @param {string} [group] Return only inputs/outputs from the specified group.
|
|
8968
|
+
* @param {CoordinateSystem} coordinateSystem
|
|
9028
8969
|
* @param {*} [options] Override http request option.
|
|
9029
8970
|
* @throws {RequiredError}
|
|
8971
|
+
* @memberof VirtualRobotSetupApi
|
|
9030
8972
|
*/
|
|
9031
|
-
|
|
8973
|
+
addVirtualRobotCoordinateSystem(cell: string, controller: string, coordinateSystem: CoordinateSystem, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
9032
8974
|
/**
|
|
9033
|
-
*
|
|
9034
|
-
* @summary
|
|
8975
|
+
* 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.
|
|
8976
|
+
* @summary Add TCP
|
|
9035
8977
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
9036
8978
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
9037
|
-
* @param {
|
|
8979
|
+
* @param {string} motionGroup The motion-group identifier.
|
|
8980
|
+
* @param {RobotTcp} robotTcp
|
|
9038
8981
|
* @param {*} [options] Override http request option.
|
|
9039
8982
|
* @throws {RequiredError}
|
|
8983
|
+
* @memberof VirtualRobotSetupApi
|
|
9040
8984
|
*/
|
|
9041
|
-
|
|
9042
|
-
};
|
|
9043
|
-
/**
|
|
9044
|
-
* VirtualControllerInputsOutputsApi - factory interface
|
|
9045
|
-
* @export
|
|
9046
|
-
*/
|
|
9047
|
-
export declare const VirtualControllerInputsOutputsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
8985
|
+
addVirtualRobotTcp(cell: string, controller: string, motionGroup: string, robotTcp: RobotTcp, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
9048
8986
|
/**
|
|
9049
|
-
*
|
|
9050
|
-
* @summary
|
|
8987
|
+
* 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.
|
|
8988
|
+
* @summary Remove Coordinate System
|
|
9051
8989
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
9052
8990
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
9053
|
-
* @param {
|
|
8991
|
+
* @param {string} coordinateSystem Unique identifier addressing a coordinate system.
|
|
8992
|
+
* @param {boolean} [deleteDependent] If true, all dependent coordinate systems will be deleted as well.
|
|
9054
8993
|
* @param {*} [options] Override http request option.
|
|
9055
8994
|
* @throws {RequiredError}
|
|
8995
|
+
* @memberof VirtualRobotSetupApi
|
|
9056
8996
|
*/
|
|
9057
|
-
|
|
8997
|
+
deleteVirtualRobotCoordinateSystem(cell: string, controller: string, coordinateSystem: string, deleteDependent?: boolean, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
9058
8998
|
/**
|
|
9059
|
-
*
|
|
9060
|
-
* @summary
|
|
8999
|
+
* Removes the TCP from the motion group. An unknown TCP is a valid input.
|
|
9000
|
+
* @summary Remove TCP
|
|
9061
9001
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
9062
9002
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
9063
|
-
* @param {
|
|
9064
|
-
* @param {
|
|
9065
|
-
* @param {IOValueType} [valueType] Return only inputs/outputs with the specified value type.
|
|
9066
|
-
* @param {string} [group] Return only inputs/outputs from the specified group.
|
|
9003
|
+
* @param {string} motionGroup The motion-group identifier.
|
|
9004
|
+
* @param {string} tcp The unique identifier of a TCP.
|
|
9067
9005
|
* @param {*} [options] Override http request option.
|
|
9068
9006
|
* @throws {RequiredError}
|
|
9007
|
+
* @memberof VirtualRobotSetupApi
|
|
9069
9008
|
*/
|
|
9070
|
-
|
|
9009
|
+
deleteVirtualRobotTcp(cell: string, controller: string, motionGroup: string, tcp: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
9071
9010
|
/**
|
|
9072
|
-
*
|
|
9073
|
-
* @summary
|
|
9011
|
+
* Gets motion group mounting. The motion group is based on the origin of the returned coordinate system.
|
|
9012
|
+
* @summary Get Mounting
|
|
9074
9013
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
9075
9014
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
9076
|
-
* @param {
|
|
9015
|
+
* @param {string} motionGroup The motion-group identifier.
|
|
9077
9016
|
* @param {*} [options] Override http request option.
|
|
9078
9017
|
* @throws {RequiredError}
|
|
9018
|
+
* @memberof VirtualRobotSetupApi
|
|
9079
9019
|
*/
|
|
9080
|
-
|
|
9081
|
-
};
|
|
9082
|
-
/**
|
|
9083
|
-
* VirtualControllerInputsOutputsApi - object-oriented interface
|
|
9084
|
-
* @export
|
|
9085
|
-
* @class VirtualControllerInputsOutputsApi
|
|
9086
|
-
* @extends {BaseAPI}
|
|
9087
|
-
*/
|
|
9088
|
-
export declare class VirtualControllerInputsOutputsApi extends BaseAPI {
|
|
9020
|
+
getVirtualRobotMounting(cell: string, controller: string, motionGroup: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CoordinateSystem, any>>;
|
|
9089
9021
|
/**
|
|
9090
|
-
*
|
|
9091
|
-
* @summary
|
|
9022
|
+
* Lists all coordinate systems on the robot controller.
|
|
9023
|
+
* @summary List Coordinate Systems
|
|
9092
9024
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
9093
9025
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
9094
|
-
* @param {Array<string>} ios
|
|
9095
9026
|
* @param {*} [options] Override http request option.
|
|
9096
9027
|
* @throws {RequiredError}
|
|
9097
|
-
* @memberof
|
|
9028
|
+
* @memberof VirtualRobotSetupApi
|
|
9098
9029
|
*/
|
|
9099
|
-
|
|
9030
|
+
listVirtualRobotCoordinateSystems(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CoordinateSystems, any>>;
|
|
9100
9031
|
/**
|
|
9101
|
-
* Lists
|
|
9102
|
-
* @summary List
|
|
9032
|
+
* Lists TCPs of the motion group. An empty TCP list is valid, for example for external axes.
|
|
9033
|
+
* @summary List TCPs
|
|
9103
9034
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
9104
9035
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
9105
|
-
* @param {
|
|
9106
|
-
* @param {IODirection} [direction] Return only inputs/outputs with the specified direction.
|
|
9107
|
-
* @param {IOValueType} [valueType] Return only inputs/outputs with the specified value type.
|
|
9108
|
-
* @param {string} [group] Return only inputs/outputs from the specified group.
|
|
9036
|
+
* @param {string} motionGroup The motion-group identifier.
|
|
9109
9037
|
* @param {*} [options] Override http request option.
|
|
9110
9038
|
* @throws {RequiredError}
|
|
9111
|
-
* @memberof
|
|
9039
|
+
* @memberof VirtualRobotSetupApi
|
|
9112
9040
|
*/
|
|
9113
|
-
|
|
9041
|
+
listVirtualRobotTcps(cell: string, controller: string, motionGroup: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<RobotTcps, any>>;
|
|
9114
9042
|
/**
|
|
9115
|
-
* Sets a
|
|
9116
|
-
* @summary Set
|
|
9043
|
+
* Sets motion group mounting by specifying a coordinate system. The motion group will be based on the coordinate system\'s origin. The coordinate system defines a transformation offset. The transformation offset is defined by a unique identifier, a name for front end usage and an offset in another coordinate system referenced by the unique identifier of the reference coordinate system.
|
|
9044
|
+
* @summary Set Mounting
|
|
9117
9045
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
9118
9046
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
9119
|
-
* @param {
|
|
9047
|
+
* @param {string} motionGroup The motion-group identifier.
|
|
9048
|
+
* @param {CoordinateSystem} coordinateSystem
|
|
9120
9049
|
* @param {*} [options] Override http request option.
|
|
9121
9050
|
* @throws {RequiredError}
|
|
9122
|
-
* @memberof
|
|
9051
|
+
* @memberof VirtualRobotSetupApi
|
|
9123
9052
|
*/
|
|
9124
|
-
|
|
9053
|
+
setVirtualRobotMounting(cell: string, controller: string, motionGroup: string, coordinateSystem: CoordinateSystem, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CoordinateSystem, any>>;
|
|
9125
9054
|
}
|