@wandelbots/nova-api 25.7.0-dev.2 → 25.7.0-dev.21
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 +869 -798
- package/v2/api.js +1327 -1212
- package/v2/api.js.map +1 -1
- package/v2/api.ts +1674 -1534
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 groups of the controller take 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,6 +859,37 @@ 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
|
+
}
|
|
862
893
|
/**
|
|
863
894
|
* Defines a convex hull encapsulating a set of vertices.
|
|
864
895
|
* @export
|
|
@@ -888,12 +919,6 @@ export type ConvexHullShapeTypeEnum = typeof ConvexHullShapeTypeEnum[keyof typeo
|
|
|
888
919
|
* @interface CoordinateSystem
|
|
889
920
|
*/
|
|
890
921
|
export interface CoordinateSystem {
|
|
891
|
-
/**
|
|
892
|
-
* Unique identifier of the coordinate system.
|
|
893
|
-
* @type {string}
|
|
894
|
-
* @memberof CoordinateSystem
|
|
895
|
-
*/
|
|
896
|
-
'coordinate_system': string;
|
|
897
922
|
/**
|
|
898
923
|
* Human readable name of this coordinate system.
|
|
899
924
|
* @type {string}
|
|
@@ -924,19 +949,49 @@ export interface CoordinateSystem {
|
|
|
924
949
|
* @memberof CoordinateSystem
|
|
925
950
|
*/
|
|
926
951
|
'orientation_type'?: OrientationType;
|
|
952
|
+
/**
|
|
953
|
+
* Unique identifier of the coordinate system.
|
|
954
|
+
* @type {string}
|
|
955
|
+
* @memberof CoordinateSystem
|
|
956
|
+
*/
|
|
957
|
+
'coordinate_system': string;
|
|
927
958
|
}
|
|
928
959
|
/**
|
|
929
960
|
*
|
|
930
961
|
* @export
|
|
931
|
-
* @interface
|
|
962
|
+
* @interface CoordinateSystemData
|
|
932
963
|
*/
|
|
933
|
-
export interface
|
|
964
|
+
export interface CoordinateSystemData {
|
|
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>;
|
|
934
989
|
/**
|
|
935
990
|
*
|
|
936
|
-
* @type {
|
|
937
|
-
* @memberof
|
|
991
|
+
* @type {OrientationType}
|
|
992
|
+
* @memberof CoordinateSystemData
|
|
938
993
|
*/
|
|
939
|
-
'
|
|
994
|
+
'orientation_type'?: OrientationType;
|
|
940
995
|
}
|
|
941
996
|
/**
|
|
942
997
|
*
|
|
@@ -1046,36 +1101,6 @@ export declare const Direction: {
|
|
|
1046
1101
|
readonly DirectionBackward: "DIRECTION_BACKWARD";
|
|
1047
1102
|
};
|
|
1048
1103
|
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
|
-
}
|
|
1079
1104
|
/**
|
|
1080
1105
|
* 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.
|
|
1081
1106
|
* @export
|
|
@@ -1138,41 +1163,23 @@ export interface ExternalJointStreamDatapoint {
|
|
|
1138
1163
|
'motion_group': string;
|
|
1139
1164
|
/**
|
|
1140
1165
|
*
|
|
1141
|
-
* @type {
|
|
1166
|
+
* @type {MotionGroupJoints}
|
|
1142
1167
|
* @memberof ExternalJointStreamDatapoint
|
|
1143
1168
|
*/
|
|
1144
|
-
'value':
|
|
1169
|
+
'value': MotionGroupJoints;
|
|
1145
1170
|
}
|
|
1146
1171
|
/**
|
|
1147
|
-
*
|
|
1172
|
+
*
|
|
1148
1173
|
* @export
|
|
1149
|
-
* @interface
|
|
1174
|
+
* @interface ExternalJointStreamRequest
|
|
1150
1175
|
*/
|
|
1151
|
-
export interface
|
|
1152
|
-
/**
|
|
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>;
|
|
1176
|
+
export interface ExternalJointStreamRequest {
|
|
1164
1177
|
/**
|
|
1165
|
-
*
|
|
1166
|
-
* @type {Array<
|
|
1167
|
-
* @memberof
|
|
1168
|
-
*/
|
|
1169
|
-
'accelerations': Array<number>;
|
|
1170
|
-
/**
|
|
1171
|
-
* The joint torques of the robot.
|
|
1172
|
-
* @type {Array<number>}
|
|
1173
|
-
* @memberof ExternalJointStreamDatapointValue
|
|
1178
|
+
*
|
|
1179
|
+
* @type {Array<ExternalJointStreamDatapoint>}
|
|
1180
|
+
* @memberof ExternalJointStreamRequest
|
|
1174
1181
|
*/
|
|
1175
|
-
'
|
|
1182
|
+
'states': Array<ExternalJointStreamDatapoint>;
|
|
1176
1183
|
}
|
|
1177
1184
|
/**
|
|
1178
1185
|
* The configuration of a physical FANUC robot controller has to contain IP address of the controller.
|
|
@@ -1938,7 +1945,104 @@ export type JoggingDetailsKindEnum = typeof JoggingDetailsKindEnum[keyof typeof
|
|
|
1938
1945
|
* @type JoggingDetailsState
|
|
1939
1946
|
* @export
|
|
1940
1947
|
*/
|
|
1941
|
-
export type JoggingDetailsState =
|
|
1948
|
+
export type JoggingDetailsState = JoggingPausedByUser | JoggingPausedNearCollision | JoggingPausedNearJointLimit | JoggingPausedOnIO | JoggingRunning;
|
|
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];
|
|
1942
2046
|
/**
|
|
1943
2047
|
*
|
|
1944
2048
|
* @export
|
|
@@ -2334,19 +2438,6 @@ export interface LimitsOverride {
|
|
|
2334
2438
|
*/
|
|
2335
2439
|
'tcp_orientation_acceleration_limit'?: number;
|
|
2336
2440
|
}
|
|
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
|
-
}
|
|
2350
2441
|
/**
|
|
2351
2442
|
*
|
|
2352
2443
|
* @export
|
|
@@ -2428,19 +2519,6 @@ export type MotionCommandBlending = BlendingAuto | BlendingPosition;
|
|
|
2428
2519
|
* @export
|
|
2429
2520
|
*/
|
|
2430
2521
|
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
|
-
}
|
|
2444
2522
|
/**
|
|
2445
2523
|
* The configuration of a motion-group used for motion planning.
|
|
2446
2524
|
* @export
|
|
@@ -2452,7 +2530,7 @@ export interface MotionGroupDescription {
|
|
|
2452
2530
|
* @type {string}
|
|
2453
2531
|
* @memberof MotionGroupDescription
|
|
2454
2532
|
*/
|
|
2455
|
-
'
|
|
2533
|
+
'motion_group_model': string;
|
|
2456
2534
|
/**
|
|
2457
2535
|
* The offset from the world frame to the motion group base.
|
|
2458
2536
|
* @type {Pose}
|
|
@@ -2545,19 +2623,6 @@ export interface MotionGroupInfo {
|
|
|
2545
2623
|
*/
|
|
2546
2624
|
'dof': number;
|
|
2547
2625
|
}
|
|
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
|
-
}
|
|
2561
2626
|
/**
|
|
2562
2627
|
* Ensure to provide one value for each joint. See [getMotionGroups](getMotionGroups) for the number of joints. Everything but positions is optional.
|
|
2563
2628
|
* @export
|
|
@@ -2719,7 +2784,7 @@ export interface MovementErrorResponse {
|
|
|
2719
2784
|
'kind': MovementErrorResponseKindEnum;
|
|
2720
2785
|
}
|
|
2721
2786
|
export declare const MovementErrorResponseKindEnum: {
|
|
2722
|
-
readonly
|
|
2787
|
+
readonly MotionError: "MOTION_ERROR";
|
|
2723
2788
|
};
|
|
2724
2789
|
export type MovementErrorResponseKindEnum = typeof MovementErrorResponseKindEnum[keyof typeof MovementErrorResponseKindEnum];
|
|
2725
2790
|
/**
|
|
@@ -3074,103 +3139,6 @@ export interface PauseOnIO {
|
|
|
3074
3139
|
*/
|
|
3075
3140
|
'comparator': Comparator;
|
|
3076
3141
|
}
|
|
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];
|
|
3174
3142
|
/**
|
|
3175
3143
|
*
|
|
3176
3144
|
* @export
|
|
@@ -3438,7 +3406,7 @@ export type ReleaseChannel = typeof ReleaseChannel[keyof typeof ReleaseChannel];
|
|
|
3438
3406
|
*/
|
|
3439
3407
|
export interface RobotController {
|
|
3440
3408
|
/**
|
|
3441
|
-
*
|
|
3409
|
+
* Unique name of controller within 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).
|
|
3442
3410
|
* @type {string}
|
|
3443
3411
|
* @memberof RobotController
|
|
3444
3412
|
*/
|
|
@@ -3574,12 +3542,6 @@ export type RobotSystemMode = typeof RobotSystemMode[keyof typeof RobotSystemMod
|
|
|
3574
3542
|
* @interface RobotTcp
|
|
3575
3543
|
*/
|
|
3576
3544
|
export interface RobotTcp {
|
|
3577
|
-
/**
|
|
3578
|
-
* Identifier of this tcp.
|
|
3579
|
-
* @type {string}
|
|
3580
|
-
* @memberof RobotTcp
|
|
3581
|
-
*/
|
|
3582
|
-
'id': string;
|
|
3583
3545
|
/**
|
|
3584
3546
|
* A readable and changeable name for frontend visualization.
|
|
3585
3547
|
* @type {string}
|
|
@@ -3604,60 +3566,44 @@ export interface RobotTcp {
|
|
|
3604
3566
|
* @memberof RobotTcp
|
|
3605
3567
|
*/
|
|
3606
3568
|
'orientation_type'?: OrientationType;
|
|
3569
|
+
/**
|
|
3570
|
+
* Identifier of this tcp.
|
|
3571
|
+
* @type {string}
|
|
3572
|
+
* @memberof RobotTcp
|
|
3573
|
+
*/
|
|
3574
|
+
'id': string;
|
|
3607
3575
|
}
|
|
3608
3576
|
/**
|
|
3609
3577
|
*
|
|
3610
3578
|
* @export
|
|
3611
|
-
* @interface
|
|
3579
|
+
* @interface RobotTcpData
|
|
3612
3580
|
*/
|
|
3613
|
-
export interface
|
|
3581
|
+
export interface RobotTcpData {
|
|
3614
3582
|
/**
|
|
3615
|
-
*
|
|
3616
|
-
* @type {
|
|
3617
|
-
* @memberof
|
|
3583
|
+
* A readable and changeable name for frontend visualization.
|
|
3584
|
+
* @type {string}
|
|
3585
|
+
* @memberof RobotTcpData
|
|
3618
3586
|
*/
|
|
3619
|
-
'
|
|
3620
|
-
}
|
|
3621
|
-
/**
|
|
3622
|
-
*
|
|
3623
|
-
* @export
|
|
3624
|
-
* @interface Running
|
|
3625
|
-
*/
|
|
3626
|
-
export interface Running {
|
|
3587
|
+
'name'?: string;
|
|
3627
3588
|
/**
|
|
3628
|
-
*
|
|
3629
|
-
* @type {
|
|
3630
|
-
* @memberof
|
|
3589
|
+
* A three-dimensional vector [x, y, z] with double precision.
|
|
3590
|
+
* @type {Array<number>}
|
|
3591
|
+
* @memberof RobotTcpData
|
|
3631
3592
|
*/
|
|
3632
|
-
'
|
|
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 {
|
|
3593
|
+
'position': Array<number>;
|
|
3644
3594
|
/**
|
|
3645
|
-
*
|
|
3646
|
-
* @type {
|
|
3647
|
-
* @memberof
|
|
3595
|
+
* Describes an orientation in 3D space. A tree-to-four-dimensional vector [x, y, z, w] with double precision.
|
|
3596
|
+
* @type {Array<number>}
|
|
3597
|
+
* @memberof RobotTcpData
|
|
3648
3598
|
*/
|
|
3649
|
-
'
|
|
3599
|
+
'orientation'?: Array<number>;
|
|
3650
3600
|
/**
|
|
3651
|
-
*
|
|
3652
|
-
* @type {
|
|
3653
|
-
* @memberof
|
|
3601
|
+
*
|
|
3602
|
+
* @type {OrientationType}
|
|
3603
|
+
* @memberof RobotTcpData
|
|
3654
3604
|
*/
|
|
3655
|
-
'
|
|
3605
|
+
'orientation_type'?: OrientationType;
|
|
3656
3606
|
}
|
|
3657
|
-
export declare const Running1KindEnum: {
|
|
3658
|
-
readonly Running: "RUNNING";
|
|
3659
|
-
};
|
|
3660
|
-
export type Running1KindEnum = typeof Running1KindEnum[keyof typeof Running1KindEnum];
|
|
3661
3607
|
/**
|
|
3662
3608
|
* 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.
|
|
3663
3609
|
* @export
|
|
@@ -3894,7 +3840,7 @@ export interface StartMovementRequest {
|
|
|
3894
3840
|
* @type {Direction}
|
|
3895
3841
|
* @memberof StartMovementRequest
|
|
3896
3842
|
*/
|
|
3897
|
-
'direction'
|
|
3843
|
+
'direction'?: Direction;
|
|
3898
3844
|
/**
|
|
3899
3845
|
* Attaches a list of output commands to the trajectory. The outputs are set to the specified values right after the specified location was reached. If the specified location is located before the start location (forward direction: value is smaller, backward direction: value is bigger), the output is not set.
|
|
3900
3846
|
* @type {Array<IOValue>}
|
|
@@ -4181,7 +4127,24 @@ export type TrajectoryDetailsKindEnum = typeof TrajectoryDetailsKindEnum[keyof t
|
|
|
4181
4127
|
* @type TrajectoryDetailsState
|
|
4182
4128
|
* @export
|
|
4183
4129
|
*/
|
|
4184
|
-
export type TrajectoryDetailsState =
|
|
4130
|
+
export type TrajectoryDetailsState = TrajectoryEnded | TrajectoryPausedByUser | TrajectoryPausedOnIO | TrajectoryRunning | TrajectoryWaitForIO;
|
|
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];
|
|
4185
4148
|
/**
|
|
4186
4149
|
*
|
|
4187
4150
|
* @export
|
|
@@ -4205,6 +4168,80 @@ export declare const TrajectoryIdMessageTypeEnum: {
|
|
|
4205
4168
|
readonly TrajectoryId: "TrajectoryId";
|
|
4206
4169
|
};
|
|
4207
4170
|
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];
|
|
4208
4245
|
/**
|
|
4209
4246
|
* The unit of input/output value.
|
|
4210
4247
|
* @export
|
|
@@ -4290,7 +4327,7 @@ export interface ValidationError {
|
|
|
4290
4327
|
*/
|
|
4291
4328
|
export type ValidationErrorLocInner = number | string;
|
|
4292
4329
|
/**
|
|
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
|
|
4330
|
+
* The configuration of a virtual robot controller has to contain the manufacturer string, an optional joint position string array and either a preset `type` **or** the complete JSON configuration.
|
|
4294
4331
|
* @export
|
|
4295
4332
|
* @interface VirtualController
|
|
4296
4333
|
*/
|
|
@@ -4314,7 +4351,7 @@ export interface VirtualController {
|
|
|
4314
4351
|
*/
|
|
4315
4352
|
'type'?: VirtualControllerTypes;
|
|
4316
4353
|
/**
|
|
4317
|
-
*
|
|
4354
|
+
* Complete JSON configuration of the virtual robot controller. Can be obtained from the physical controller\'s configuration via [getVirtualControllerConfiguration](getVirtualControllerConfiguration). If provided, the `type` field should not be used.
|
|
4318
4355
|
* @type {string}
|
|
4319
4356
|
* @memberof VirtualController
|
|
4320
4357
|
*/
|
|
@@ -4464,23 +4501,6 @@ export interface VirtualRobotConfiguration {
|
|
|
4464
4501
|
*/
|
|
4465
4502
|
'content': string;
|
|
4466
4503
|
}
|
|
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];
|
|
4484
4504
|
/**
|
|
4485
4505
|
* The value to compare with the current value of the input/output.
|
|
4486
4506
|
* @export
|
|
@@ -5090,6 +5110,15 @@ export declare const ControllerApiAxiosParamCreator: (configuration?: Configurat
|
|
|
5090
5110
|
* @throws {RequiredError}
|
|
5091
5111
|
*/
|
|
5092
5112
|
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>;
|
|
5093
5122
|
/**
|
|
5094
5123
|
* 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.
|
|
5095
5124
|
* @summary Coordinate System
|
|
@@ -5129,14 +5158,14 @@ export declare const ControllerApiAxiosParamCreator: (configuration?: Configurat
|
|
|
5129
5158
|
*/
|
|
5130
5159
|
getRobotController: (cell: string, controller: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
5131
5160
|
/**
|
|
5132
|
-
* Receive
|
|
5133
|
-
* @summary Virtual
|
|
5161
|
+
* Receive data to configure a virtual robot controller based on another controller. This can be used to create a virtual clone of a specific physical robot. When adding a virtual controller, use the Virtual configuration variant of [addRobotController](addRobotController) and pass the content string from this endpoint as the `json` field. Omit the `type` field that selects a preset configuration which is not required when providing a complete configuration. > **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.
|
|
5162
|
+
* @summary Virtual Controller Configuration
|
|
5134
5163
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5135
5164
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
5136
5165
|
* @param {*} [options] Override http request option.
|
|
5137
5166
|
* @throws {RequiredError}
|
|
5138
5167
|
*/
|
|
5139
|
-
|
|
5168
|
+
getVirtualControllerConfiguration: (cell: string, controller: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
5140
5169
|
/**
|
|
5141
5170
|
* 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.
|
|
5142
5171
|
* @summary List Coordinate Systems
|
|
@@ -5231,6 +5260,15 @@ export declare const ControllerApiFp: (configuration?: Configuration) => {
|
|
|
5231
5260
|
* @throws {RequiredError}
|
|
5232
5261
|
*/
|
|
5233
5262
|
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>>;
|
|
5234
5272
|
/**
|
|
5235
5273
|
* 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.
|
|
5236
5274
|
* @summary Coordinate System
|
|
@@ -5270,14 +5308,14 @@ export declare const ControllerApiFp: (configuration?: Configuration) => {
|
|
|
5270
5308
|
*/
|
|
5271
5309
|
getRobotController(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<RobotController>>;
|
|
5272
5310
|
/**
|
|
5273
|
-
* Receive
|
|
5274
|
-
* @summary Virtual
|
|
5311
|
+
* Receive data to configure a virtual robot controller based on another controller. This can be used to create a virtual clone of a specific physical robot. When adding a virtual controller, use the Virtual configuration variant of [addRobotController](addRobotController) and pass the content string from this endpoint as the `json` field. Omit the `type` field that selects a preset configuration which is not required when providing a complete configuration. > **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.
|
|
5312
|
+
* @summary Virtual Controller Configuration
|
|
5275
5313
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5276
5314
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
5277
5315
|
* @param {*} [options] Override http request option.
|
|
5278
5316
|
* @throws {RequiredError}
|
|
5279
5317
|
*/
|
|
5280
|
-
|
|
5318
|
+
getVirtualControllerConfiguration(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<VirtualRobotConfiguration>>;
|
|
5281
5319
|
/**
|
|
5282
5320
|
* 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.
|
|
5283
5321
|
* @summary List Coordinate Systems
|
|
@@ -5287,7 +5325,7 @@ export declare const ControllerApiFp: (configuration?: Configuration) => {
|
|
|
5287
5325
|
* @param {*} [options] Override http request option.
|
|
5288
5326
|
* @throws {RequiredError}
|
|
5289
5327
|
*/
|
|
5290
|
-
listCoordinateSystems(cell: string, controller: string, orientationType?: OrientationType, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<
|
|
5328
|
+
listCoordinateSystems(cell: string, controller: string, orientationType?: OrientationType, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<CoordinateSystem>>>;
|
|
5291
5329
|
/**
|
|
5292
5330
|
* List the names of all deployed robot controllers.
|
|
5293
5331
|
* @summary List Robot Controllers
|
|
@@ -5372,6 +5410,15 @@ export declare const ControllerApiFactory: (configuration?: Configuration, baseP
|
|
|
5372
5410
|
* @throws {RequiredError}
|
|
5373
5411
|
*/
|
|
5374
5412
|
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>;
|
|
5375
5422
|
/**
|
|
5376
5423
|
* 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.
|
|
5377
5424
|
* @summary Coordinate System
|
|
@@ -5411,14 +5458,14 @@ export declare const ControllerApiFactory: (configuration?: Configuration, baseP
|
|
|
5411
5458
|
*/
|
|
5412
5459
|
getRobotController(cell: string, controller: string, options?: RawAxiosRequestConfig): AxiosPromise<RobotController>;
|
|
5413
5460
|
/**
|
|
5414
|
-
* Receive
|
|
5415
|
-
* @summary Virtual
|
|
5461
|
+
* Receive data to configure a virtual robot controller based on another controller. This can be used to create a virtual clone of a specific physical robot. When adding a virtual controller, use the Virtual configuration variant of [addRobotController](addRobotController) and pass the content string from this endpoint as the `json` field. Omit the `type` field that selects a preset configuration which is not required when providing a complete configuration. > **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.
|
|
5462
|
+
* @summary Virtual Controller Configuration
|
|
5416
5463
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5417
5464
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
5418
5465
|
* @param {*} [options] Override http request option.
|
|
5419
5466
|
* @throws {RequiredError}
|
|
5420
5467
|
*/
|
|
5421
|
-
|
|
5468
|
+
getVirtualControllerConfiguration(cell: string, controller: string, options?: RawAxiosRequestConfig): AxiosPromise<VirtualRobotConfiguration>;
|
|
5422
5469
|
/**
|
|
5423
5470
|
* 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.
|
|
5424
5471
|
* @summary List Coordinate Systems
|
|
@@ -5428,7 +5475,7 @@ export declare const ControllerApiFactory: (configuration?: Configuration, baseP
|
|
|
5428
5475
|
* @param {*} [options] Override http request option.
|
|
5429
5476
|
* @throws {RequiredError}
|
|
5430
5477
|
*/
|
|
5431
|
-
listCoordinateSystems(cell: string, controller: string, orientationType?: OrientationType, options?: RawAxiosRequestConfig): AxiosPromise<
|
|
5478
|
+
listCoordinateSystems(cell: string, controller: string, orientationType?: OrientationType, options?: RawAxiosRequestConfig): AxiosPromise<Array<CoordinateSystem>>;
|
|
5432
5479
|
/**
|
|
5433
5480
|
* List the names of all deployed robot controllers.
|
|
5434
5481
|
* @summary List Robot Controllers
|
|
@@ -5518,6 +5565,16 @@ export declare class ControllerApi extends BaseAPI {
|
|
|
5518
5565
|
* @memberof ControllerApi
|
|
5519
5566
|
*/
|
|
5520
5567
|
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>>;
|
|
5521
5578
|
/**
|
|
5522
5579
|
* 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.
|
|
5523
5580
|
* @summary Coordinate System
|
|
@@ -5561,15 +5618,15 @@ export declare class ControllerApi extends BaseAPI {
|
|
|
5561
5618
|
*/
|
|
5562
5619
|
getRobotController(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<RobotController, any>>;
|
|
5563
5620
|
/**
|
|
5564
|
-
* Receive
|
|
5565
|
-
* @summary Virtual
|
|
5621
|
+
* Receive data to configure a virtual robot controller based on another controller. This can be used to create a virtual clone of a specific physical robot. When adding a virtual controller, use the Virtual configuration variant of [addRobotController](addRobotController) and pass the content string from this endpoint as the `json` field. Omit the `type` field that selects a preset configuration which is not required when providing a complete configuration. > **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.
|
|
5622
|
+
* @summary Virtual Controller Configuration
|
|
5566
5623
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5567
5624
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
5568
5625
|
* @param {*} [options] Override http request option.
|
|
5569
5626
|
* @throws {RequiredError}
|
|
5570
5627
|
* @memberof ControllerApi
|
|
5571
5628
|
*/
|
|
5572
|
-
|
|
5629
|
+
getVirtualControllerConfiguration(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<VirtualRobotConfiguration, any>>;
|
|
5573
5630
|
/**
|
|
5574
5631
|
* 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.
|
|
5575
5632
|
* @summary List Coordinate Systems
|
|
@@ -5580,7 +5637,7 @@ export declare class ControllerApi extends BaseAPI {
|
|
|
5580
5637
|
* @throws {RequiredError}
|
|
5581
5638
|
* @memberof ControllerApi
|
|
5582
5639
|
*/
|
|
5583
|
-
listCoordinateSystems(cell: string, controller: string, orientationType?: OrientationType, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<
|
|
5640
|
+
listCoordinateSystems(cell: string, controller: string, orientationType?: OrientationType, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CoordinateSystem[], any>>;
|
|
5584
5641
|
/**
|
|
5585
5642
|
* List the names of all deployed robot controllers.
|
|
5586
5643
|
* @summary List Robot Controllers
|
|
@@ -5888,11 +5945,12 @@ export declare const JoggingApiAxiosParamCreator: (configuration?: Configuration
|
|
|
5888
5945
|
* <!-- 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.
|
|
5889
5946
|
* @summary Execute Jogging
|
|
5890
5947
|
* @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.
|
|
5891
5949
|
* @param {ExecuteJoggingRequest} executeJoggingRequest
|
|
5892
5950
|
* @param {*} [options] Override http request option.
|
|
5893
5951
|
* @throws {RequiredError}
|
|
5894
5952
|
*/
|
|
5895
|
-
executeJogging: (cell: string, executeJoggingRequest: ExecuteJoggingRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
5953
|
+
executeJogging: (cell: string, controller: string, executeJoggingRequest: ExecuteJoggingRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
5896
5954
|
};
|
|
5897
5955
|
/**
|
|
5898
5956
|
* JoggingApi - functional programming interface
|
|
@@ -5903,11 +5961,12 @@ export declare const JoggingApiFp: (configuration?: Configuration) => {
|
|
|
5903
5961
|
* <!-- 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.
|
|
5904
5962
|
* @summary Execute Jogging
|
|
5905
5963
|
* @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.
|
|
5906
5965
|
* @param {ExecuteJoggingRequest} executeJoggingRequest
|
|
5907
5966
|
* @param {*} [options] Override http request option.
|
|
5908
5967
|
* @throws {RequiredError}
|
|
5909
5968
|
*/
|
|
5910
|
-
executeJogging(cell: string, executeJoggingRequest: ExecuteJoggingRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ExecuteJoggingResponse>>;
|
|
5969
|
+
executeJogging(cell: string, controller: string, executeJoggingRequest: ExecuteJoggingRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ExecuteJoggingResponse>>;
|
|
5911
5970
|
};
|
|
5912
5971
|
/**
|
|
5913
5972
|
* JoggingApi - factory interface
|
|
@@ -5918,11 +5977,12 @@ export declare const JoggingApiFactory: (configuration?: Configuration, basePath
|
|
|
5918
5977
|
* <!-- 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.
|
|
5919
5978
|
* @summary Execute Jogging
|
|
5920
5979
|
* @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.
|
|
5921
5981
|
* @param {ExecuteJoggingRequest} executeJoggingRequest
|
|
5922
5982
|
* @param {*} [options] Override http request option.
|
|
5923
5983
|
* @throws {RequiredError}
|
|
5924
5984
|
*/
|
|
5925
|
-
executeJogging(cell: string, executeJoggingRequest: ExecuteJoggingRequest, options?: RawAxiosRequestConfig): AxiosPromise<ExecuteJoggingResponse>;
|
|
5985
|
+
executeJogging(cell: string, controller: string, executeJoggingRequest: ExecuteJoggingRequest, options?: RawAxiosRequestConfig): AxiosPromise<ExecuteJoggingResponse>;
|
|
5926
5986
|
};
|
|
5927
5987
|
/**
|
|
5928
5988
|
* JoggingApi - object-oriented interface
|
|
@@ -5935,12 +5995,13 @@ export declare class JoggingApi extends BaseAPI {
|
|
|
5935
5995
|
* <!-- 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.
|
|
5936
5996
|
* @summary Execute Jogging
|
|
5937
5997
|
* @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.
|
|
5938
5999
|
* @param {ExecuteJoggingRequest} executeJoggingRequest
|
|
5939
6000
|
* @param {*} [options] Override http request option.
|
|
5940
6001
|
* @throws {RequiredError}
|
|
5941
6002
|
* @memberof JoggingApi
|
|
5942
6003
|
*/
|
|
5943
|
-
executeJogging(cell: string, executeJoggingRequest: ExecuteJoggingRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ExecuteJoggingResponse, any>>;
|
|
6004
|
+
executeJogging(cell: string, controller: string, executeJoggingRequest: ExecuteJoggingRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ExecuteJoggingResponse, any>>;
|
|
5944
6005
|
}
|
|
5945
6006
|
/**
|
|
5946
6007
|
* KinematicsApi - axios parameter creator
|
|
@@ -6160,32 +6221,35 @@ export declare const MotionGroupApiAxiosParamCreator: (configuration?: Configura
|
|
|
6160
6221
|
* Returns the current state of the selected motion group including the current joint position, velocity, pose, and more.
|
|
6161
6222
|
* @summary State
|
|
6162
6223
|
* @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.
|
|
6163
6225
|
* @param {string} motionGroup The motion-group identifier.
|
|
6164
6226
|
* @param {string} [responseCoordinateSystem] Unique identifier addressing a coordinate system to which the responses should be converted. If not set, world coordinate system is used.
|
|
6165
6227
|
* @param {*} [options] Override http request option.
|
|
6166
6228
|
* @throws {RequiredError}
|
|
6167
6229
|
*/
|
|
6168
|
-
getCurrentMotionGroupState: (cell: string, motionGroup: string, responseCoordinateSystem?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
6230
|
+
getCurrentMotionGroupState: (cell: string, controller: string, motionGroup: string, responseCoordinateSystem?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
6169
6231
|
/**
|
|
6170
6232
|
* 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.
|
|
6171
6233
|
* @summary Description
|
|
6172
6234
|
* @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.
|
|
6173
6236
|
* @param {string} motionGroup The motion-group identifier.
|
|
6174
6237
|
* @param {*} [options] Override http request option.
|
|
6175
6238
|
* @throws {RequiredError}
|
|
6176
6239
|
*/
|
|
6177
|
-
getMotionGroupDescription: (cell: string, motionGroup: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
6240
|
+
getMotionGroupDescription: (cell: string, controller: string, motionGroup: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
6178
6241
|
/**
|
|
6179
6242
|
* <!-- theme: danger --> > Websocket endpoint Receive updates of the motion group state. The stream will be closed from the server if the controller is disconnected.
|
|
6180
6243
|
* @summary Stream State
|
|
6181
6244
|
* @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.
|
|
6182
6246
|
* @param {string} motionGroup The motion-group identifier.
|
|
6183
6247
|
* @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.
|
|
6184
6248
|
* @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.
|
|
6185
6249
|
* @param {*} [options] Override http request option.
|
|
6186
6250
|
* @throws {RequiredError}
|
|
6187
6251
|
*/
|
|
6188
|
-
streamMotionGroupState: (cell: string, motionGroup: string, responseRate?: number, responseCoordinateSystem?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
6252
|
+
streamMotionGroupState: (cell: string, controller: string, motionGroup: string, responseRate?: number, responseCoordinateSystem?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
6189
6253
|
};
|
|
6190
6254
|
/**
|
|
6191
6255
|
* MotionGroupApi - functional programming interface
|
|
@@ -6196,32 +6260,35 @@ export declare const MotionGroupApiFp: (configuration?: Configuration) => {
|
|
|
6196
6260
|
* Returns the current state of the selected motion group including the current joint position, velocity, pose, and more.
|
|
6197
6261
|
* @summary State
|
|
6198
6262
|
* @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.
|
|
6199
6264
|
* @param {string} motionGroup The motion-group identifier.
|
|
6200
6265
|
* @param {string} [responseCoordinateSystem] Unique identifier addressing a coordinate system to which the responses should be converted. If not set, world coordinate system is used.
|
|
6201
6266
|
* @param {*} [options] Override http request option.
|
|
6202
6267
|
* @throws {RequiredError}
|
|
6203
6268
|
*/
|
|
6204
|
-
getCurrentMotionGroupState(cell: string, motionGroup: string, responseCoordinateSystem?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<MotionGroupState>>;
|
|
6269
|
+
getCurrentMotionGroupState(cell: string, controller: string, motionGroup: string, responseCoordinateSystem?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<MotionGroupState>>;
|
|
6205
6270
|
/**
|
|
6206
6271
|
* 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.
|
|
6207
6272
|
* @summary Description
|
|
6208
6273
|
* @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.
|
|
6209
6275
|
* @param {string} motionGroup The motion-group identifier.
|
|
6210
6276
|
* @param {*} [options] Override http request option.
|
|
6211
6277
|
* @throws {RequiredError}
|
|
6212
6278
|
*/
|
|
6213
|
-
getMotionGroupDescription(cell: string, motionGroup: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<MotionGroupDescription>>;
|
|
6279
|
+
getMotionGroupDescription(cell: string, controller: string, motionGroup: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<MotionGroupDescription>>;
|
|
6214
6280
|
/**
|
|
6215
6281
|
* <!-- theme: danger --> > Websocket endpoint Receive updates of the motion group state. The stream will be closed from the server if the controller is disconnected.
|
|
6216
6282
|
* @summary Stream State
|
|
6217
6283
|
* @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.
|
|
6218
6285
|
* @param {string} motionGroup The motion-group identifier.
|
|
6219
6286
|
* @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.
|
|
6220
6287
|
* @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.
|
|
6221
6288
|
* @param {*} [options] Override http request option.
|
|
6222
6289
|
* @throws {RequiredError}
|
|
6223
6290
|
*/
|
|
6224
|
-
streamMotionGroupState(cell: string, motionGroup: string, responseRate?: number, responseCoordinateSystem?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<MotionGroupState>>;
|
|
6291
|
+
streamMotionGroupState(cell: string, controller: string, motionGroup: string, responseRate?: number, responseCoordinateSystem?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<MotionGroupState>>;
|
|
6225
6292
|
};
|
|
6226
6293
|
/**
|
|
6227
6294
|
* MotionGroupApi - factory interface
|
|
@@ -6232,32 +6299,35 @@ export declare const MotionGroupApiFactory: (configuration?: Configuration, base
|
|
|
6232
6299
|
* Returns the current state of the selected motion group including the current joint position, velocity, pose, and more.
|
|
6233
6300
|
* @summary State
|
|
6234
6301
|
* @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.
|
|
6235
6303
|
* @param {string} motionGroup The motion-group identifier.
|
|
6236
6304
|
* @param {string} [responseCoordinateSystem] Unique identifier addressing a coordinate system to which the responses should be converted. If not set, world coordinate system is used.
|
|
6237
6305
|
* @param {*} [options] Override http request option.
|
|
6238
6306
|
* @throws {RequiredError}
|
|
6239
6307
|
*/
|
|
6240
|
-
getCurrentMotionGroupState(cell: string, motionGroup: string, responseCoordinateSystem?: string, options?: RawAxiosRequestConfig): AxiosPromise<MotionGroupState>;
|
|
6308
|
+
getCurrentMotionGroupState(cell: string, controller: string, motionGroup: string, responseCoordinateSystem?: string, options?: RawAxiosRequestConfig): AxiosPromise<MotionGroupState>;
|
|
6241
6309
|
/**
|
|
6242
6310
|
* 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.
|
|
6243
6311
|
* @summary Description
|
|
6244
6312
|
* @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.
|
|
6245
6314
|
* @param {string} motionGroup The motion-group identifier.
|
|
6246
6315
|
* @param {*} [options] Override http request option.
|
|
6247
6316
|
* @throws {RequiredError}
|
|
6248
6317
|
*/
|
|
6249
|
-
getMotionGroupDescription(cell: string, motionGroup: string, options?: RawAxiosRequestConfig): AxiosPromise<MotionGroupDescription>;
|
|
6318
|
+
getMotionGroupDescription(cell: string, controller: string, motionGroup: string, options?: RawAxiosRequestConfig): AxiosPromise<MotionGroupDescription>;
|
|
6250
6319
|
/**
|
|
6251
6320
|
* <!-- theme: danger --> > Websocket endpoint Receive updates of the motion group state. The stream will be closed from the server if the controller is disconnected.
|
|
6252
6321
|
* @summary Stream State
|
|
6253
6322
|
* @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.
|
|
6254
6324
|
* @param {string} motionGroup The motion-group identifier.
|
|
6255
6325
|
* @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.
|
|
6256
6326
|
* @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.
|
|
6257
6327
|
* @param {*} [options] Override http request option.
|
|
6258
6328
|
* @throws {RequiredError}
|
|
6259
6329
|
*/
|
|
6260
|
-
streamMotionGroupState(cell: string, motionGroup: string, responseRate?: number, responseCoordinateSystem?: string, options?: RawAxiosRequestConfig): AxiosPromise<MotionGroupState>;
|
|
6330
|
+
streamMotionGroupState(cell: string, controller: string, motionGroup: string, responseRate?: number, responseCoordinateSystem?: string, options?: RawAxiosRequestConfig): AxiosPromise<MotionGroupState>;
|
|
6261
6331
|
};
|
|
6262
6332
|
/**
|
|
6263
6333
|
* MotionGroupApi - object-oriented interface
|
|
@@ -6270,27 +6340,30 @@ export declare class MotionGroupApi extends BaseAPI {
|
|
|
6270
6340
|
* Returns the current state of the selected motion group including the current joint position, velocity, pose, and more.
|
|
6271
6341
|
* @summary State
|
|
6272
6342
|
* @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.
|
|
6273
6344
|
* @param {string} motionGroup The motion-group identifier.
|
|
6274
6345
|
* @param {string} [responseCoordinateSystem] Unique identifier addressing a coordinate system to which the responses should be converted. If not set, world coordinate system is used.
|
|
6275
6346
|
* @param {*} [options] Override http request option.
|
|
6276
6347
|
* @throws {RequiredError}
|
|
6277
6348
|
* @memberof MotionGroupApi
|
|
6278
6349
|
*/
|
|
6279
|
-
getCurrentMotionGroupState(cell: string, motionGroup: string, responseCoordinateSystem?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<MotionGroupState, any>>;
|
|
6350
|
+
getCurrentMotionGroupState(cell: string, controller: string, motionGroup: string, responseCoordinateSystem?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<MotionGroupState, any>>;
|
|
6280
6351
|
/**
|
|
6281
6352
|
* 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.
|
|
6282
6353
|
* @summary Description
|
|
6283
6354
|
* @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.
|
|
6284
6356
|
* @param {string} motionGroup The motion-group identifier.
|
|
6285
6357
|
* @param {*} [options] Override http request option.
|
|
6286
6358
|
* @throws {RequiredError}
|
|
6287
6359
|
* @memberof MotionGroupApi
|
|
6288
6360
|
*/
|
|
6289
|
-
getMotionGroupDescription(cell: string, motionGroup: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<MotionGroupDescription, any>>;
|
|
6361
|
+
getMotionGroupDescription(cell: string, controller: string, motionGroup: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<MotionGroupDescription, any>>;
|
|
6290
6362
|
/**
|
|
6291
6363
|
* <!-- theme: danger --> > Websocket endpoint Receive updates of the motion group state. The stream will be closed from the server if the controller is disconnected.
|
|
6292
6364
|
* @summary Stream State
|
|
6293
6365
|
* @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.
|
|
6294
6367
|
* @param {string} motionGroup The motion-group identifier.
|
|
6295
6368
|
* @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.
|
|
6296
6369
|
* @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.
|
|
@@ -6298,7 +6371,7 @@ export declare class MotionGroupApi extends BaseAPI {
|
|
|
6298
6371
|
* @throws {RequiredError}
|
|
6299
6372
|
* @memberof MotionGroupApi
|
|
6300
6373
|
*/
|
|
6301
|
-
streamMotionGroupState(cell: string, motionGroup: string, responseRate?: number, responseCoordinateSystem?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<MotionGroupState, any>>;
|
|
6374
|
+
streamMotionGroupState(cell: string, controller: string, motionGroup: string, responseRate?: number, responseCoordinateSystem?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<MotionGroupState, any>>;
|
|
6302
6375
|
}
|
|
6303
6376
|
/**
|
|
6304
6377
|
* MotionGroupModelsApi - axios parameter creator
|
|
@@ -7710,45 +7783,50 @@ export declare const TrajectoryCachingApiAxiosParamCreator: (configuration?: Con
|
|
|
7710
7783
|
* <!-- 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.
|
|
7711
7784
|
* @summary Add Trajectory
|
|
7712
7785
|
* @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.
|
|
7713
7787
|
* @param {AddTrajectoryRequest} addTrajectoryRequest
|
|
7714
7788
|
* @param {*} [options] Override http request option.
|
|
7715
7789
|
* @throws {RequiredError}
|
|
7716
7790
|
*/
|
|
7717
|
-
addTrajectory: (cell: string, addTrajectoryRequest: AddTrajectoryRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
7791
|
+
addTrajectory: (cell: string, controller: string, addTrajectoryRequest: AddTrajectoryRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
7718
7792
|
/**
|
|
7719
7793
|
* Clear the trajectory cache.
|
|
7720
7794
|
* @summary Clear Trajectories
|
|
7721
7795
|
* @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.
|
|
7722
7797
|
* @param {*} [options] Override http request option.
|
|
7723
7798
|
* @throws {RequiredError}
|
|
7724
7799
|
*/
|
|
7725
|
-
clearTrajectories: (cell: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
7800
|
+
clearTrajectories: (cell: string, controller: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
7726
7801
|
/**
|
|
7727
7802
|
* 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.
|
|
7728
7803
|
* @summary Delete Trajectory
|
|
7729
7804
|
* @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.
|
|
7730
7806
|
* @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.
|
|
7731
7807
|
* @param {*} [options] Override http request option.
|
|
7732
7808
|
* @throws {RequiredError}
|
|
7733
7809
|
*/
|
|
7734
|
-
deleteTrajectory: (cell: string, trajectory: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
7810
|
+
deleteTrajectory: (cell: string, controller: string, trajectory: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
7735
7811
|
/**
|
|
7736
7812
|
* Get a previously created trajectory from cache. Use [listTrajectories](listTrajectories) to list all cached trajectories.
|
|
7737
7813
|
* @summary Get Trajectory
|
|
7738
7814
|
* @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.
|
|
7739
7816
|
* @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.
|
|
7740
7817
|
* @param {*} [options] Override http request option.
|
|
7741
7818
|
* @throws {RequiredError}
|
|
7742
7819
|
*/
|
|
7743
|
-
getTrajectory: (cell: string, trajectory: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
7820
|
+
getTrajectory: (cell: string, controller: string, trajectory: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
7744
7821
|
/**
|
|
7745
7822
|
* 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.
|
|
7746
7823
|
* @summary List Trajectories
|
|
7747
7824
|
* @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.
|
|
7748
7826
|
* @param {*} [options] Override http request option.
|
|
7749
7827
|
* @throws {RequiredError}
|
|
7750
7828
|
*/
|
|
7751
|
-
listTrajectories: (cell: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
7829
|
+
listTrajectories: (cell: string, controller: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
7752
7830
|
};
|
|
7753
7831
|
/**
|
|
7754
7832
|
* TrajectoryCachingApi - functional programming interface
|
|
@@ -7759,45 +7837,50 @@ export declare const TrajectoryCachingApiFp: (configuration?: Configuration) =>
|
|
|
7759
7837
|
* <!-- 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.
|
|
7760
7838
|
* @summary Add Trajectory
|
|
7761
7839
|
* @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.
|
|
7762
7841
|
* @param {AddTrajectoryRequest} addTrajectoryRequest
|
|
7763
7842
|
* @param {*} [options] Override http request option.
|
|
7764
7843
|
* @throws {RequiredError}
|
|
7765
7844
|
*/
|
|
7766
|
-
addTrajectory(cell: string, addTrajectoryRequest: AddTrajectoryRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AddTrajectoryResponse>>;
|
|
7845
|
+
addTrajectory(cell: string, controller: string, addTrajectoryRequest: AddTrajectoryRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AddTrajectoryResponse>>;
|
|
7767
7846
|
/**
|
|
7768
7847
|
* Clear the trajectory cache.
|
|
7769
7848
|
* @summary Clear Trajectories
|
|
7770
7849
|
* @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.
|
|
7771
7851
|
* @param {*} [options] Override http request option.
|
|
7772
7852
|
* @throws {RequiredError}
|
|
7773
7853
|
*/
|
|
7774
|
-
clearTrajectories(cell: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
7854
|
+
clearTrajectories(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
7775
7855
|
/**
|
|
7776
7856
|
* 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.
|
|
7777
7857
|
* @summary Delete Trajectory
|
|
7778
7858
|
* @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.
|
|
7779
7860
|
* @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.
|
|
7780
7861
|
* @param {*} [options] Override http request option.
|
|
7781
7862
|
* @throws {RequiredError}
|
|
7782
7863
|
*/
|
|
7783
|
-
deleteTrajectory(cell: string, trajectory: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
7864
|
+
deleteTrajectory(cell: string, controller: string, trajectory: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
7784
7865
|
/**
|
|
7785
7866
|
* Get a previously created trajectory from cache. Use [listTrajectories](listTrajectories) to list all cached trajectories.
|
|
7786
7867
|
* @summary Get Trajectory
|
|
7787
7868
|
* @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.
|
|
7788
7870
|
* @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.
|
|
7789
7871
|
* @param {*} [options] Override http request option.
|
|
7790
7872
|
* @throws {RequiredError}
|
|
7791
7873
|
*/
|
|
7792
|
-
getTrajectory(cell: string, trajectory: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetTrajectoryResponse>>;
|
|
7874
|
+
getTrajectory(cell: string, controller: string, trajectory: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetTrajectoryResponse>>;
|
|
7793
7875
|
/**
|
|
7794
7876
|
* 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.
|
|
7795
7877
|
* @summary List Trajectories
|
|
7796
7878
|
* @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.
|
|
7797
7880
|
* @param {*} [options] Override http request option.
|
|
7798
7881
|
* @throws {RequiredError}
|
|
7799
7882
|
*/
|
|
7800
|
-
listTrajectories(cell: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListTrajectoriesResponse>>;
|
|
7883
|
+
listTrajectories(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListTrajectoriesResponse>>;
|
|
7801
7884
|
};
|
|
7802
7885
|
/**
|
|
7803
7886
|
* TrajectoryCachingApi - factory interface
|
|
@@ -7808,45 +7891,50 @@ export declare const TrajectoryCachingApiFactory: (configuration?: Configuration
|
|
|
7808
7891
|
* <!-- 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.
|
|
7809
7892
|
* @summary Add Trajectory
|
|
7810
7893
|
* @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.
|
|
7811
7895
|
* @param {AddTrajectoryRequest} addTrajectoryRequest
|
|
7812
7896
|
* @param {*} [options] Override http request option.
|
|
7813
7897
|
* @throws {RequiredError}
|
|
7814
7898
|
*/
|
|
7815
|
-
addTrajectory(cell: string, addTrajectoryRequest: AddTrajectoryRequest, options?: RawAxiosRequestConfig): AxiosPromise<AddTrajectoryResponse>;
|
|
7899
|
+
addTrajectory(cell: string, controller: string, addTrajectoryRequest: AddTrajectoryRequest, options?: RawAxiosRequestConfig): AxiosPromise<AddTrajectoryResponse>;
|
|
7816
7900
|
/**
|
|
7817
7901
|
* Clear the trajectory cache.
|
|
7818
7902
|
* @summary Clear Trajectories
|
|
7819
7903
|
* @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.
|
|
7820
7905
|
* @param {*} [options] Override http request option.
|
|
7821
7906
|
* @throws {RequiredError}
|
|
7822
7907
|
*/
|
|
7823
|
-
clearTrajectories(cell: string, options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
7908
|
+
clearTrajectories(cell: string, controller: string, options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
7824
7909
|
/**
|
|
7825
7910
|
* 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.
|
|
7826
7911
|
* @summary Delete Trajectory
|
|
7827
7912
|
* @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.
|
|
7828
7914
|
* @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.
|
|
7829
7915
|
* @param {*} [options] Override http request option.
|
|
7830
7916
|
* @throws {RequiredError}
|
|
7831
7917
|
*/
|
|
7832
|
-
deleteTrajectory(cell: string, trajectory: string, options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
7918
|
+
deleteTrajectory(cell: string, controller: string, trajectory: string, options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
7833
7919
|
/**
|
|
7834
7920
|
* Get a previously created trajectory from cache. Use [listTrajectories](listTrajectories) to list all cached trajectories.
|
|
7835
7921
|
* @summary Get Trajectory
|
|
7836
7922
|
* @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.
|
|
7837
7924
|
* @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.
|
|
7838
7925
|
* @param {*} [options] Override http request option.
|
|
7839
7926
|
* @throws {RequiredError}
|
|
7840
7927
|
*/
|
|
7841
|
-
getTrajectory(cell: string, trajectory: string, options?: RawAxiosRequestConfig): AxiosPromise<GetTrajectoryResponse>;
|
|
7928
|
+
getTrajectory(cell: string, controller: string, trajectory: string, options?: RawAxiosRequestConfig): AxiosPromise<GetTrajectoryResponse>;
|
|
7842
7929
|
/**
|
|
7843
7930
|
* 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.
|
|
7844
7931
|
* @summary List Trajectories
|
|
7845
7932
|
* @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.
|
|
7846
7934
|
* @param {*} [options] Override http request option.
|
|
7847
7935
|
* @throws {RequiredError}
|
|
7848
7936
|
*/
|
|
7849
|
-
listTrajectories(cell: string, options?: RawAxiosRequestConfig): AxiosPromise<ListTrajectoriesResponse>;
|
|
7937
|
+
listTrajectories(cell: string, controller: string, options?: RawAxiosRequestConfig): AxiosPromise<ListTrajectoriesResponse>;
|
|
7850
7938
|
};
|
|
7851
7939
|
/**
|
|
7852
7940
|
* TrajectoryCachingApi - object-oriented interface
|
|
@@ -7859,50 +7947,55 @@ export declare class TrajectoryCachingApi extends BaseAPI {
|
|
|
7859
7947
|
* <!-- 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.
|
|
7860
7948
|
* @summary Add Trajectory
|
|
7861
7949
|
* @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.
|
|
7862
7951
|
* @param {AddTrajectoryRequest} addTrajectoryRequest
|
|
7863
7952
|
* @param {*} [options] Override http request option.
|
|
7864
7953
|
* @throws {RequiredError}
|
|
7865
7954
|
* @memberof TrajectoryCachingApi
|
|
7866
7955
|
*/
|
|
7867
|
-
addTrajectory(cell: string, addTrajectoryRequest: AddTrajectoryRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AddTrajectoryResponse, any>>;
|
|
7956
|
+
addTrajectory(cell: string, controller: string, addTrajectoryRequest: AddTrajectoryRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AddTrajectoryResponse, any>>;
|
|
7868
7957
|
/**
|
|
7869
7958
|
* Clear the trajectory cache.
|
|
7870
7959
|
* @summary Clear Trajectories
|
|
7871
7960
|
* @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.
|
|
7872
7962
|
* @param {*} [options] Override http request option.
|
|
7873
7963
|
* @throws {RequiredError}
|
|
7874
7964
|
* @memberof TrajectoryCachingApi
|
|
7875
7965
|
*/
|
|
7876
|
-
clearTrajectories(cell: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
7966
|
+
clearTrajectories(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
7877
7967
|
/**
|
|
7878
7968
|
* 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.
|
|
7879
7969
|
* @summary Delete Trajectory
|
|
7880
7970
|
* @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.
|
|
7881
7972
|
* @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.
|
|
7882
7973
|
* @param {*} [options] Override http request option.
|
|
7883
7974
|
* @throws {RequiredError}
|
|
7884
7975
|
* @memberof TrajectoryCachingApi
|
|
7885
7976
|
*/
|
|
7886
|
-
deleteTrajectory(cell: string, trajectory: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
7977
|
+
deleteTrajectory(cell: string, controller: string, trajectory: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
7887
7978
|
/**
|
|
7888
7979
|
* Get a previously created trajectory from cache. Use [listTrajectories](listTrajectories) to list all cached trajectories.
|
|
7889
7980
|
* @summary Get Trajectory
|
|
7890
7981
|
* @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.
|
|
7891
7983
|
* @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.
|
|
7892
7984
|
* @param {*} [options] Override http request option.
|
|
7893
7985
|
* @throws {RequiredError}
|
|
7894
7986
|
* @memberof TrajectoryCachingApi
|
|
7895
7987
|
*/
|
|
7896
|
-
getTrajectory(cell: string, trajectory: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetTrajectoryResponse, any>>;
|
|
7988
|
+
getTrajectory(cell: string, controller: string, trajectory: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetTrajectoryResponse, any>>;
|
|
7897
7989
|
/**
|
|
7898
7990
|
* 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.
|
|
7899
7991
|
* @summary List Trajectories
|
|
7900
7992
|
* @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.
|
|
7901
7994
|
* @param {*} [options] Override http request option.
|
|
7902
7995
|
* @throws {RequiredError}
|
|
7903
7996
|
* @memberof TrajectoryCachingApi
|
|
7904
7997
|
*/
|
|
7905
|
-
listTrajectories(cell: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ListTrajectoriesResponse, any>>;
|
|
7998
|
+
listTrajectories(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ListTrajectoriesResponse, any>>;
|
|
7906
7999
|
}
|
|
7907
8000
|
/**
|
|
7908
8001
|
* TrajectoryExecutionApi - axios parameter creator
|
|
@@ -7913,11 +8006,12 @@ export declare const TrajectoryExecutionApiAxiosParamCreator: (configuration?: C
|
|
|
7913
8006
|
* <!-- 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.
|
|
7914
8007
|
* @summary Execute Trajectory
|
|
7915
8008
|
* @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.
|
|
7916
8010
|
* @param {ExecuteTrajectoryRequest} executeTrajectoryRequest
|
|
7917
8011
|
* @param {*} [options] Override http request option.
|
|
7918
8012
|
* @throws {RequiredError}
|
|
7919
8013
|
*/
|
|
7920
|
-
executeTrajectory: (cell: string, executeTrajectoryRequest: ExecuteTrajectoryRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
8014
|
+
executeTrajectory: (cell: string, controller: string, executeTrajectoryRequest: ExecuteTrajectoryRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
7921
8015
|
};
|
|
7922
8016
|
/**
|
|
7923
8017
|
* TrajectoryExecutionApi - functional programming interface
|
|
@@ -7928,11 +8022,12 @@ export declare const TrajectoryExecutionApiFp: (configuration?: Configuration) =
|
|
|
7928
8022
|
* <!-- 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.
|
|
7929
8023
|
* @summary Execute Trajectory
|
|
7930
8024
|
* @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.
|
|
7931
8026
|
* @param {ExecuteTrajectoryRequest} executeTrajectoryRequest
|
|
7932
8027
|
* @param {*} [options] Override http request option.
|
|
7933
8028
|
* @throws {RequiredError}
|
|
7934
8029
|
*/
|
|
7935
|
-
executeTrajectory(cell: string, executeTrajectoryRequest: ExecuteTrajectoryRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ExecuteTrajectoryResponse>>;
|
|
8030
|
+
executeTrajectory(cell: string, controller: string, executeTrajectoryRequest: ExecuteTrajectoryRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ExecuteTrajectoryResponse>>;
|
|
7936
8031
|
};
|
|
7937
8032
|
/**
|
|
7938
8033
|
* TrajectoryExecutionApi - factory interface
|
|
@@ -7943,11 +8038,12 @@ export declare const TrajectoryExecutionApiFactory: (configuration?: Configurati
|
|
|
7943
8038
|
* <!-- 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.
|
|
7944
8039
|
* @summary Execute Trajectory
|
|
7945
8040
|
* @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.
|
|
7946
8042
|
* @param {ExecuteTrajectoryRequest} executeTrajectoryRequest
|
|
7947
8043
|
* @param {*} [options] Override http request option.
|
|
7948
8044
|
* @throws {RequiredError}
|
|
7949
8045
|
*/
|
|
7950
|
-
executeTrajectory(cell: string, executeTrajectoryRequest: ExecuteTrajectoryRequest, options?: RawAxiosRequestConfig): AxiosPromise<ExecuteTrajectoryResponse>;
|
|
8046
|
+
executeTrajectory(cell: string, controller: string, executeTrajectoryRequest: ExecuteTrajectoryRequest, options?: RawAxiosRequestConfig): AxiosPromise<ExecuteTrajectoryResponse>;
|
|
7951
8047
|
};
|
|
7952
8048
|
/**
|
|
7953
8049
|
* TrajectoryExecutionApi - object-oriented interface
|
|
@@ -7960,12 +8056,13 @@ export declare class TrajectoryExecutionApi extends BaseAPI {
|
|
|
7960
8056
|
* <!-- 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.
|
|
7961
8057
|
* @summary Execute Trajectory
|
|
7962
8058
|
* @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.
|
|
7963
8060
|
* @param {ExecuteTrajectoryRequest} executeTrajectoryRequest
|
|
7964
8061
|
* @param {*} [options] Override http request option.
|
|
7965
8062
|
* @throws {RequiredError}
|
|
7966
8063
|
* @memberof TrajectoryExecutionApi
|
|
7967
8064
|
*/
|
|
7968
|
-
executeTrajectory(cell: string, executeTrajectoryRequest: ExecuteTrajectoryRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ExecuteTrajectoryResponse, any>>;
|
|
8065
|
+
executeTrajectory(cell: string, controller: string, executeTrajectoryRequest: ExecuteTrajectoryRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ExecuteTrajectoryResponse, any>>;
|
|
7969
8066
|
}
|
|
7970
8067
|
/**
|
|
7971
8068
|
* TrajectoryPlanningApi - axios parameter creator
|
|
@@ -8031,79 +8128,64 @@ export declare class TrajectoryPlanningApi extends BaseAPI {
|
|
|
8031
8128
|
planTrajectory(cell: string, planTrajectoryRequest?: PlanTrajectoryRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<PlanTrajectoryResponse, any>>;
|
|
8032
8129
|
}
|
|
8033
8130
|
/**
|
|
8034
|
-
*
|
|
8131
|
+
* VirtualControllerApi - axios parameter creator
|
|
8035
8132
|
* @export
|
|
8036
8133
|
*/
|
|
8037
|
-
export declare const
|
|
8038
|
-
/**
|
|
8039
|
-
* Get the current motion group state which provides values for the joints\' position, velocity and acceleration.
|
|
8040
|
-
* @summary Get Motion Group State
|
|
8041
|
-
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8042
|
-
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
8043
|
-
* @param {string} motionGroup The motion-group identifier.
|
|
8044
|
-
* @param {*} [options] Override http request option.
|
|
8045
|
-
* @throws {RequiredError}
|
|
8046
|
-
*/
|
|
8047
|
-
getMotionGroupState: (cell: string, controller: string, motionGroup: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
8134
|
+
export declare const VirtualControllerApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
8048
8135
|
/**
|
|
8049
|
-
*
|
|
8050
|
-
* @summary
|
|
8136
|
+
* Adds a coordinate system to the robot controller.
|
|
8137
|
+
* @summary Add Coordinate Systems
|
|
8051
8138
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8052
8139
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
8140
|
+
* @param {string} coordinateSystem Unique identifier addressing a coordinate system.
|
|
8141
|
+
* @param {CoordinateSystemData} coordinateSystemData
|
|
8053
8142
|
* @param {*} [options] Override http request option.
|
|
8054
8143
|
* @throws {RequiredError}
|
|
8055
8144
|
*/
|
|
8056
|
-
|
|
8145
|
+
addVirtualControllerCoordinateSystem: (cell: string, controller: string, coordinateSystem: string, coordinateSystemData: CoordinateSystemData, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
8057
8146
|
/**
|
|
8058
|
-
*
|
|
8059
|
-
* @summary
|
|
8147
|
+
* 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.
|
|
8148
|
+
* @summary Add TCP
|
|
8060
8149
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8061
8150
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
8062
|
-
* @param {
|
|
8151
|
+
* @param {string} motionGroup The motion-group identifier.
|
|
8152
|
+
* @param {string} tcp The unique identifier of a TCP.
|
|
8153
|
+
* @param {RobotTcpData} robotTcpData
|
|
8063
8154
|
* @param {*} [options] Override http request option.
|
|
8064
8155
|
* @throws {RequiredError}
|
|
8065
8156
|
*/
|
|
8066
|
-
|
|
8157
|
+
addVirtualControllerTcp: (cell: string, controller: string, motionGroup: string, tcp: string, robotTcpData: RobotTcpData, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
8067
8158
|
/**
|
|
8068
|
-
*
|
|
8069
|
-
* @summary
|
|
8159
|
+
* 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.
|
|
8160
|
+
* @summary Remove Coordinate System
|
|
8070
8161
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8071
8162
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
8072
|
-
* @param {
|
|
8073
|
-
* @param {
|
|
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.
|
|
8163
|
+
* @param {string} coordinateSystem Unique identifier addressing a coordinate system.
|
|
8164
|
+
* @param {boolean} [deleteDependent] If true, all dependent coordinate systems will be deleted as well.
|
|
8076
8165
|
* @param {*} [options] Override http request option.
|
|
8077
8166
|
* @throws {RequiredError}
|
|
8078
8167
|
*/
|
|
8079
|
-
|
|
8168
|
+
deleteVirtualControllerCoordinateSystem: (cell: string, controller: string, coordinateSystem: string, deleteDependent?: boolean, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
8080
8169
|
/**
|
|
8081
|
-
*
|
|
8082
|
-
* @summary
|
|
8170
|
+
* Removes the TCP from the motion group. An unknown TCP is a valid input.
|
|
8171
|
+
* @summary Remove TCP
|
|
8083
8172
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8084
8173
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
8085
|
-
* @param {
|
|
8174
|
+
* @param {string} motionGroup The motion-group identifier.
|
|
8175
|
+
* @param {string} tcp The unique identifier of a TCP.
|
|
8086
8176
|
* @param {*} [options] Override http request option.
|
|
8087
8177
|
* @throws {RequiredError}
|
|
8088
8178
|
*/
|
|
8089
|
-
|
|
8179
|
+
deleteVirtualControllerTcp: (cell: string, controller: string, motionGroup: string, tcp: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
8090
8180
|
/**
|
|
8091
|
-
*
|
|
8092
|
-
* @summary
|
|
8181
|
+
* 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.
|
|
8182
|
+
* @summary Get Emergency Stop State
|
|
8093
8183
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8094
8184
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
8095
|
-
* @param {string} motionGroup The motion-group identifier.
|
|
8096
|
-
* @param {MotionGroupJoints} motionGroupJoints
|
|
8097
8185
|
* @param {*} [options] Override http request option.
|
|
8098
8186
|
* @throws {RequiredError}
|
|
8099
8187
|
*/
|
|
8100
|
-
|
|
8101
|
-
};
|
|
8102
|
-
/**
|
|
8103
|
-
* VirtualRobotApi - functional programming interface
|
|
8104
|
-
* @export
|
|
8105
|
-
*/
|
|
8106
|
-
export declare const VirtualRobotApiFp: (configuration?: Configuration) => {
|
|
8188
|
+
getEmergencyStop: (cell: string, controller: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
8107
8189
|
/**
|
|
8108
8190
|
* Get the current motion group state which provides values for the joints\' position, velocity and acceleration.
|
|
8109
8191
|
* @summary Get Motion Group State
|
|
@@ -8113,7 +8195,7 @@ export declare const VirtualRobotApiFp: (configuration?: Configuration) => {
|
|
|
8113
8195
|
* @param {*} [options] Override http request option.
|
|
8114
8196
|
* @throws {RequiredError}
|
|
8115
8197
|
*/
|
|
8116
|
-
getMotionGroupState(cell: string, controller: string, motionGroup: string, options?: RawAxiosRequestConfig)
|
|
8198
|
+
getMotionGroupState: (cell: string, controller: string, motionGroup: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
8117
8199
|
/**
|
|
8118
8200
|
* Gets information on the motion group.
|
|
8119
8201
|
* @summary Motion Group Description
|
|
@@ -8122,365 +8204,297 @@ export declare const VirtualRobotApiFp: (configuration?: Configuration) => {
|
|
|
8122
8204
|
* @param {*} [options] Override http request option.
|
|
8123
8205
|
* @throws {RequiredError}
|
|
8124
8206
|
*/
|
|
8125
|
-
getMotionGroups(cell: string, controller: string, options?: RawAxiosRequestConfig)
|
|
8207
|
+
getMotionGroups: (cell: string, controller: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
8126
8208
|
/**
|
|
8127
|
-
*
|
|
8128
|
-
* @summary Get
|
|
8209
|
+
* 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.
|
|
8210
|
+
* @summary Get Operation Mode
|
|
8129
8211
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8130
8212
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
8131
|
-
* @param {Array<string>} ios
|
|
8132
8213
|
* @param {*} [options] Override http request option.
|
|
8133
8214
|
* @throws {RequiredError}
|
|
8134
8215
|
*/
|
|
8135
|
-
|
|
8216
|
+
getOperationMode: (cell: string, controller: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
8136
8217
|
/**
|
|
8137
|
-
*
|
|
8138
|
-
* @summary
|
|
8218
|
+
* Gets motion group mounting. The motion group is based on the origin of the returned coordinate system.
|
|
8219
|
+
* @summary Get Mounting
|
|
8139
8220
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8140
8221
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
8141
|
-
* @param {
|
|
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.
|
|
8222
|
+
* @param {string} motionGroup The motion-group identifier.
|
|
8145
8223
|
* @param {*} [options] Override http request option.
|
|
8146
8224
|
* @throws {RequiredError}
|
|
8147
8225
|
*/
|
|
8148
|
-
|
|
8226
|
+
getVirtualControllerMounting: (cell: string, controller: string, motionGroup: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
8149
8227
|
/**
|
|
8150
|
-
*
|
|
8151
|
-
* @summary
|
|
8228
|
+
* Lists all coordinate systems on the robot controller.
|
|
8229
|
+
* @summary List Coordinate Systems
|
|
8152
8230
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8153
8231
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
8154
|
-
* @param {Array<IOValue>} iOValue
|
|
8155
8232
|
* @param {*} [options] Override http request option.
|
|
8156
8233
|
* @throws {RequiredError}
|
|
8157
8234
|
*/
|
|
8158
|
-
|
|
8235
|
+
listVirtualControllerCoordinateSystems: (cell: string, controller: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
8159
8236
|
/**
|
|
8160
|
-
*
|
|
8161
|
-
* @summary
|
|
8237
|
+
* Lists TCPs of the motion group. An empty TCP list is valid, for example for external axes.
|
|
8238
|
+
* @summary List TCPs
|
|
8162
8239
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8163
8240
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
8164
8241
|
* @param {string} motionGroup The motion-group identifier.
|
|
8165
|
-
* @param {MotionGroupJoints} motionGroupJoints
|
|
8166
8242
|
* @param {*} [options] Override http request option.
|
|
8167
8243
|
* @throws {RequiredError}
|
|
8168
8244
|
*/
|
|
8169
|
-
|
|
8170
|
-
};
|
|
8171
|
-
/**
|
|
8172
|
-
* VirtualRobotApi - factory interface
|
|
8173
|
-
* @export
|
|
8174
|
-
*/
|
|
8175
|
-
export declare const VirtualRobotApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
8245
|
+
listVirtualControllerTcps: (cell: string, controller: string, motionGroup: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
8176
8246
|
/**
|
|
8177
|
-
*
|
|
8178
|
-
* @summary
|
|
8179
|
-
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8180
|
-
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
8181
|
-
* @param {string} motionGroup The motion-group identifier.
|
|
8182
|
-
* @param {*} [options] Override http request option.
|
|
8183
|
-
* @throws {RequiredError}
|
|
8184
|
-
*/
|
|
8185
|
-
getMotionGroupState(cell: string, controller: string, motionGroup: string, options?: RawAxiosRequestConfig): AxiosPromise<MotionGroupJoints>;
|
|
8186
|
-
/**
|
|
8187
|
-
* Gets information on the motion group.
|
|
8188
|
-
* @summary Motion Group Description
|
|
8189
|
-
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8190
|
-
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
8191
|
-
* @param {*} [options] Override http request option.
|
|
8192
|
-
* @throws {RequiredError}
|
|
8193
|
-
*/
|
|
8194
|
-
getMotionGroups(cell: string, controller: string, options?: RawAxiosRequestConfig): AxiosPromise<MotionGroupInfos>;
|
|
8195
|
-
/**
|
|
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
|
|
8247
|
+
* 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.
|
|
8248
|
+
* @summary Push or Release Emergency Stop
|
|
8198
8249
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8199
8250
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
8200
|
-
* @param {
|
|
8251
|
+
* @param {boolean} [active]
|
|
8201
8252
|
* @param {*} [options] Override http request option.
|
|
8202
8253
|
* @throws {RequiredError}
|
|
8203
8254
|
*/
|
|
8204
|
-
|
|
8255
|
+
setEmergencyStop: (cell: string, controller: string, active?: boolean, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
8205
8256
|
/**
|
|
8206
|
-
*
|
|
8207
|
-
* @summary
|
|
8257
|
+
* 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.
|
|
8258
|
+
* @summary Set Motion Group State
|
|
8208
8259
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8209
8260
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
8210
|
-
* @param {
|
|
8211
|
-
* @param {
|
|
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.
|
|
8261
|
+
* @param {string} motionGroup The motion-group identifier.
|
|
8262
|
+
* @param {MotionGroupJoints} motionGroupJoints
|
|
8214
8263
|
* @param {*} [options] Override http request option.
|
|
8215
8264
|
* @throws {RequiredError}
|
|
8216
8265
|
*/
|
|
8217
|
-
|
|
8266
|
+
setMotionGroupState: (cell: string, controller: string, motionGroup: string, motionGroupJoints: MotionGroupJoints, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
8218
8267
|
/**
|
|
8219
|
-
*
|
|
8220
|
-
* @summary Set
|
|
8268
|
+
* 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.
|
|
8269
|
+
* @summary Set Operation Mode
|
|
8221
8270
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8222
8271
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
8223
|
-
* @param {
|
|
8272
|
+
* @param {OperationMode} mode
|
|
8224
8273
|
* @param {*} [options] Override http request option.
|
|
8225
8274
|
* @throws {RequiredError}
|
|
8226
8275
|
*/
|
|
8227
|
-
|
|
8276
|
+
setOperationMode: (cell: string, controller: string, mode: OperationMode, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
8228
8277
|
/**
|
|
8229
|
-
* Sets
|
|
8230
|
-
* @summary Set
|
|
8278
|
+
* 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.
|
|
8279
|
+
* @summary Set Mounting
|
|
8231
8280
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8232
8281
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
8233
8282
|
* @param {string} motionGroup The motion-group identifier.
|
|
8234
|
-
* @param {
|
|
8283
|
+
* @param {CoordinateSystem} coordinateSystem
|
|
8235
8284
|
* @param {*} [options] Override http request option.
|
|
8236
8285
|
* @throws {RequiredError}
|
|
8237
8286
|
*/
|
|
8238
|
-
|
|
8287
|
+
setVirtualControllerMounting: (cell: string, controller: string, motionGroup: string, coordinateSystem: CoordinateSystem, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
8239
8288
|
};
|
|
8240
8289
|
/**
|
|
8241
|
-
*
|
|
8290
|
+
* VirtualControllerApi - functional programming interface
|
|
8242
8291
|
* @export
|
|
8243
|
-
* @class VirtualRobotApi
|
|
8244
|
-
* @extends {BaseAPI}
|
|
8245
8292
|
*/
|
|
8246
|
-
export declare
|
|
8293
|
+
export declare const VirtualControllerApiFp: (configuration?: Configuration) => {
|
|
8247
8294
|
/**
|
|
8248
|
-
*
|
|
8249
|
-
* @summary
|
|
8295
|
+
* Adds a coordinate system to the robot controller.
|
|
8296
|
+
* @summary Add Coordinate Systems
|
|
8250
8297
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8251
8298
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
8252
|
-
* @param {string}
|
|
8299
|
+
* @param {string} coordinateSystem Unique identifier addressing a coordinate system.
|
|
8300
|
+
* @param {CoordinateSystemData} coordinateSystemData
|
|
8253
8301
|
* @param {*} [options] Override http request option.
|
|
8254
8302
|
* @throws {RequiredError}
|
|
8255
|
-
* @memberof VirtualRobotApi
|
|
8256
8303
|
*/
|
|
8257
|
-
|
|
8304
|
+
addVirtualControllerCoordinateSystem(cell: string, controller: string, coordinateSystem: string, coordinateSystemData: CoordinateSystemData, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
8258
8305
|
/**
|
|
8259
|
-
*
|
|
8260
|
-
* @summary
|
|
8306
|
+
* 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.
|
|
8307
|
+
* @summary Add TCP
|
|
8261
8308
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8262
8309
|
* @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
|
|
8263
8313
|
* @param {*} [options] Override http request option.
|
|
8264
8314
|
* @throws {RequiredError}
|
|
8265
|
-
* @memberof VirtualRobotApi
|
|
8266
8315
|
*/
|
|
8267
|
-
|
|
8316
|
+
addVirtualControllerTcp(cell: string, controller: string, motionGroup: string, tcp: string, robotTcpData: RobotTcpData, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
8268
8317
|
/**
|
|
8269
|
-
*
|
|
8270
|
-
* @summary
|
|
8318
|
+
* 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.
|
|
8319
|
+
* @summary Remove Coordinate System
|
|
8271
8320
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8272
8321
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
8273
|
-
* @param {
|
|
8322
|
+
* @param {string} coordinateSystem Unique identifier addressing a coordinate system.
|
|
8323
|
+
* @param {boolean} [deleteDependent] If true, all dependent coordinate systems will be deleted as well.
|
|
8274
8324
|
* @param {*} [options] Override http request option.
|
|
8275
8325
|
* @throws {RequiredError}
|
|
8276
|
-
* @memberof VirtualRobotApi
|
|
8277
8326
|
*/
|
|
8278
|
-
|
|
8327
|
+
deleteVirtualControllerCoordinateSystem(cell: string, controller: string, coordinateSystem: string, deleteDependent?: boolean, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
8279
8328
|
/**
|
|
8280
|
-
*
|
|
8281
|
-
* @summary
|
|
8329
|
+
* Removes the TCP from the motion group. An unknown TCP is a valid input.
|
|
8330
|
+
* @summary Remove TCP
|
|
8282
8331
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8283
8332
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
8284
|
-
* @param {
|
|
8285
|
-
* @param {
|
|
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.
|
|
8333
|
+
* @param {string} motionGroup The motion-group identifier.
|
|
8334
|
+
* @param {string} tcp The unique identifier of a TCP.
|
|
8288
8335
|
* @param {*} [options] Override http request option.
|
|
8289
8336
|
* @throws {RequiredError}
|
|
8290
|
-
* @memberof VirtualRobotApi
|
|
8291
8337
|
*/
|
|
8292
|
-
|
|
8338
|
+
deleteVirtualControllerTcp(cell: string, controller: string, motionGroup: string, tcp: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
8293
8339
|
/**
|
|
8294
|
-
*
|
|
8295
|
-
* @summary
|
|
8340
|
+
* 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.
|
|
8341
|
+
* @summary Get Emergency Stop State
|
|
8296
8342
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8297
8343
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
8298
|
-
* @param {Array<IOValue>} iOValue
|
|
8299
8344
|
* @param {*} [options] Override http request option.
|
|
8300
8345
|
* @throws {RequiredError}
|
|
8301
|
-
* @memberof VirtualRobotApi
|
|
8302
8346
|
*/
|
|
8303
|
-
|
|
8347
|
+
getEmergencyStop(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Flag>>;
|
|
8304
8348
|
/**
|
|
8305
|
-
*
|
|
8306
|
-
* @summary
|
|
8349
|
+
* Get the current motion group state which provides values for the joints\' position, velocity and acceleration.
|
|
8350
|
+
* @summary Get Motion Group State
|
|
8307
8351
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8308
8352
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
8309
8353
|
* @param {string} motionGroup The motion-group identifier.
|
|
8310
|
-
* @param {MotionGroupJoints} motionGroupJoints
|
|
8311
8354
|
* @param {*} [options] Override http request option.
|
|
8312
8355
|
* @throws {RequiredError}
|
|
8313
|
-
* @memberof VirtualRobotApi
|
|
8314
8356
|
*/
|
|
8315
|
-
|
|
8316
|
-
}
|
|
8317
|
-
/**
|
|
8318
|
-
* VirtualRobotBehaviorApi - axios parameter creator
|
|
8319
|
-
* @export
|
|
8320
|
-
*/
|
|
8321
|
-
export declare const VirtualRobotBehaviorApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
8357
|
+
getMotionGroupState(cell: string, controller: string, motionGroup: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<MotionGroupJoints>>;
|
|
8322
8358
|
/**
|
|
8323
|
-
*
|
|
8324
|
-
* @summary
|
|
8359
|
+
* Gets information on the motion group.
|
|
8360
|
+
* @summary Motion Group Description
|
|
8325
8361
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8326
8362
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
8327
|
-
* @param {ExternalJointStreamDatapoint} externalJointStreamDatapoint
|
|
8328
8363
|
* @param {*} [options] Override http request option.
|
|
8329
8364
|
* @throws {RequiredError}
|
|
8330
8365
|
*/
|
|
8331
|
-
|
|
8366
|
+
getMotionGroups(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<MotionGroupInfo>>>;
|
|
8332
8367
|
/**
|
|
8333
|
-
*
|
|
8334
|
-
* @summary
|
|
8368
|
+
* 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.
|
|
8369
|
+
* @summary Get Operation Mode
|
|
8335
8370
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8336
8371
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
8337
|
-
* @param {string} motionGroup The motion-group identifier.
|
|
8338
8372
|
* @param {*} [options] Override http request option.
|
|
8339
8373
|
* @throws {RequiredError}
|
|
8340
8374
|
*/
|
|
8341
|
-
|
|
8375
|
+
getOperationMode(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<OpMode>>;
|
|
8342
8376
|
/**
|
|
8343
|
-
*
|
|
8344
|
-
* @summary
|
|
8377
|
+
* Gets motion group mounting. The motion group is based on the origin of the returned coordinate system.
|
|
8378
|
+
* @summary Get Mounting
|
|
8345
8379
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8346
8380
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
8347
8381
|
* @param {string} motionGroup The motion-group identifier.
|
|
8348
|
-
* @param {Behavior} [behavior]
|
|
8349
8382
|
* @param {*} [options] Override http request option.
|
|
8350
8383
|
* @throws {RequiredError}
|
|
8351
8384
|
*/
|
|
8352
|
-
|
|
8353
|
-
};
|
|
8354
|
-
/**
|
|
8355
|
-
* VirtualRobotBehaviorApi - functional programming interface
|
|
8356
|
-
* @export
|
|
8357
|
-
*/
|
|
8358
|
-
export declare const VirtualRobotBehaviorApiFp: (configuration?: Configuration) => {
|
|
8385
|
+
getVirtualControllerMounting(cell: string, controller: string, motionGroup: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CoordinateSystem>>;
|
|
8359
8386
|
/**
|
|
8360
|
-
*
|
|
8361
|
-
* @summary
|
|
8387
|
+
* Lists all coordinate systems on the robot controller.
|
|
8388
|
+
* @summary List Coordinate Systems
|
|
8362
8389
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8363
8390
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
8364
|
-
* @param {ExternalJointStreamDatapoint} externalJointStreamDatapoint
|
|
8365
8391
|
* @param {*} [options] Override http request option.
|
|
8366
8392
|
* @throws {RequiredError}
|
|
8367
8393
|
*/
|
|
8368
|
-
|
|
8394
|
+
listVirtualControllerCoordinateSystems(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<CoordinateSystem>>>;
|
|
8369
8395
|
/**
|
|
8370
|
-
*
|
|
8371
|
-
* @summary
|
|
8396
|
+
* Lists TCPs of the motion group. An empty TCP list is valid, for example for external axes.
|
|
8397
|
+
* @summary List TCPs
|
|
8372
8398
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8373
8399
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
8374
8400
|
* @param {string} motionGroup The motion-group identifier.
|
|
8375
8401
|
* @param {*} [options] Override http request option.
|
|
8376
8402
|
* @throws {RequiredError}
|
|
8377
8403
|
*/
|
|
8378
|
-
|
|
8404
|
+
listVirtualControllerTcps(cell: string, controller: string, motionGroup: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<RobotTcp>>>;
|
|
8379
8405
|
/**
|
|
8380
|
-
*
|
|
8381
|
-
* @summary
|
|
8406
|
+
* 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.
|
|
8407
|
+
* @summary Push or Release Emergency Stop
|
|
8382
8408
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8383
8409
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
8384
|
-
* @param {
|
|
8385
|
-
* @param {Behavior} [behavior]
|
|
8410
|
+
* @param {boolean} [active]
|
|
8386
8411
|
* @param {*} [options] Override http request option.
|
|
8387
8412
|
* @throws {RequiredError}
|
|
8388
8413
|
*/
|
|
8389
|
-
|
|
8390
|
-
};
|
|
8391
|
-
/**
|
|
8392
|
-
* VirtualRobotBehaviorApi - factory interface
|
|
8393
|
-
* @export
|
|
8394
|
-
*/
|
|
8395
|
-
export declare const VirtualRobotBehaviorApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
8414
|
+
setEmergencyStop(cell: string, controller: string, active?: boolean, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
8396
8415
|
/**
|
|
8397
|
-
*
|
|
8398
|
-
* @summary
|
|
8416
|
+
* 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.
|
|
8417
|
+
* @summary Set Motion Group State
|
|
8399
8418
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8400
8419
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
8401
|
-
* @param {
|
|
8420
|
+
* @param {string} motionGroup The motion-group identifier.
|
|
8421
|
+
* @param {MotionGroupJoints} motionGroupJoints
|
|
8402
8422
|
* @param {*} [options] Override http request option.
|
|
8403
8423
|
* @throws {RequiredError}
|
|
8404
8424
|
*/
|
|
8405
|
-
|
|
8425
|
+
setMotionGroupState(cell: string, controller: string, motionGroup: string, motionGroupJoints: MotionGroupJoints, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
8406
8426
|
/**
|
|
8407
|
-
*
|
|
8408
|
-
* @summary
|
|
8427
|
+
* 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.
|
|
8428
|
+
* @summary Set Operation Mode
|
|
8409
8429
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8410
8430
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
8411
|
-
* @param {
|
|
8431
|
+
* @param {OperationMode} mode
|
|
8412
8432
|
* @param {*} [options] Override http request option.
|
|
8413
8433
|
* @throws {RequiredError}
|
|
8414
8434
|
*/
|
|
8415
|
-
|
|
8435
|
+
setOperationMode(cell: string, controller: string, mode: OperationMode, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
8416
8436
|
/**
|
|
8417
|
-
*
|
|
8418
|
-
* @summary
|
|
8437
|
+
* 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.
|
|
8438
|
+
* @summary Set Mounting
|
|
8419
8439
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8420
8440
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
8421
8441
|
* @param {string} motionGroup The motion-group identifier.
|
|
8422
|
-
* @param {
|
|
8442
|
+
* @param {CoordinateSystem} coordinateSystem
|
|
8423
8443
|
* @param {*} [options] Override http request option.
|
|
8424
8444
|
* @throws {RequiredError}
|
|
8425
8445
|
*/
|
|
8426
|
-
|
|
8446
|
+
setVirtualControllerMounting(cell: string, controller: string, motionGroup: string, coordinateSystem: CoordinateSystem, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CoordinateSystem>>;
|
|
8427
8447
|
};
|
|
8428
8448
|
/**
|
|
8429
|
-
*
|
|
8449
|
+
* VirtualControllerApi - factory interface
|
|
8430
8450
|
* @export
|
|
8431
|
-
* @class VirtualRobotBehaviorApi
|
|
8432
|
-
* @extends {BaseAPI}
|
|
8433
8451
|
*/
|
|
8434
|
-
export declare
|
|
8452
|
+
export declare const VirtualControllerApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
8435
8453
|
/**
|
|
8436
|
-
*
|
|
8437
|
-
* @summary
|
|
8454
|
+
* Adds a coordinate system to the robot controller.
|
|
8455
|
+
* @summary Add Coordinate Systems
|
|
8438
8456
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8439
8457
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
8440
|
-
* @param {
|
|
8458
|
+
* @param {string} coordinateSystem Unique identifier addressing a coordinate system.
|
|
8459
|
+
* @param {CoordinateSystemData} coordinateSystemData
|
|
8441
8460
|
* @param {*} [options] Override http request option.
|
|
8442
8461
|
* @throws {RequiredError}
|
|
8443
|
-
* @memberof VirtualRobotBehaviorApi
|
|
8444
8462
|
*/
|
|
8445
|
-
|
|
8463
|
+
addVirtualControllerCoordinateSystem(cell: string, controller: string, coordinateSystem: string, coordinateSystemData: CoordinateSystemData, options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
8446
8464
|
/**
|
|
8447
|
-
*
|
|
8448
|
-
* @summary
|
|
8465
|
+
* 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.
|
|
8466
|
+
* @summary Add TCP
|
|
8449
8467
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8450
8468
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
8451
8469
|
* @param {string} motionGroup The motion-group identifier.
|
|
8470
|
+
* @param {string} tcp The unique identifier of a TCP.
|
|
8471
|
+
* @param {RobotTcpData} robotTcpData
|
|
8452
8472
|
* @param {*} [options] Override http request option.
|
|
8453
8473
|
* @throws {RequiredError}
|
|
8454
|
-
* @memberof VirtualRobotBehaviorApi
|
|
8455
8474
|
*/
|
|
8456
|
-
|
|
8475
|
+
addVirtualControllerTcp(cell: string, controller: string, motionGroup: string, tcp: string, robotTcpData: RobotTcpData, options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
8457
8476
|
/**
|
|
8458
|
-
*
|
|
8459
|
-
* @summary
|
|
8477
|
+
* 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.
|
|
8478
|
+
* @summary Remove Coordinate System
|
|
8460
8479
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8461
8480
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
8462
|
-
* @param {string}
|
|
8463
|
-
* @param {
|
|
8481
|
+
* @param {string} coordinateSystem Unique identifier addressing a coordinate system.
|
|
8482
|
+
* @param {boolean} [deleteDependent] If true, all dependent coordinate systems will be deleted as well.
|
|
8464
8483
|
* @param {*} [options] Override http request option.
|
|
8465
8484
|
* @throws {RequiredError}
|
|
8466
|
-
* @memberof VirtualRobotBehaviorApi
|
|
8467
8485
|
*/
|
|
8468
|
-
|
|
8469
|
-
}
|
|
8470
|
-
/**
|
|
8471
|
-
* VirtualRobotModeApi - axios parameter creator
|
|
8472
|
-
* @export
|
|
8473
|
-
*/
|
|
8474
|
-
export declare const VirtualRobotModeApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
8486
|
+
deleteVirtualControllerCoordinateSystem(cell: string, controller: string, coordinateSystem: string, deleteDependent?: boolean, options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
8475
8487
|
/**
|
|
8476
|
-
*
|
|
8477
|
-
* @summary
|
|
8488
|
+
* Removes the TCP from the motion group. An unknown TCP is a valid input.
|
|
8489
|
+
* @summary Remove TCP
|
|
8478
8490
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8479
8491
|
* @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.
|
|
8480
8494
|
* @param {*} [options] Override http request option.
|
|
8481
8495
|
* @throws {RequiredError}
|
|
8482
8496
|
*/
|
|
8483
|
-
|
|
8497
|
+
deleteVirtualControllerTcp(cell: string, controller: string, motionGroup: string, tcp: string, options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
8484
8498
|
/**
|
|
8485
8499
|
* 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.
|
|
8486
8500
|
* @summary Get Emergency Stop State
|
|
@@ -8489,69 +8503,64 @@ export declare const VirtualRobotModeApiAxiosParamCreator: (configuration?: Conf
|
|
|
8489
8503
|
* @param {*} [options] Override http request option.
|
|
8490
8504
|
* @throws {RequiredError}
|
|
8491
8505
|
*/
|
|
8492
|
-
getEmergencyStop
|
|
8506
|
+
getEmergencyStop(cell: string, controller: string, options?: RawAxiosRequestConfig): AxiosPromise<Flag>;
|
|
8493
8507
|
/**
|
|
8494
|
-
*
|
|
8495
|
-
* @summary Get
|
|
8508
|
+
* Get the current motion group state which provides values for the joints\' position, velocity and acceleration.
|
|
8509
|
+
* @summary Get Motion Group State
|
|
8496
8510
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8497
8511
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
8512
|
+
* @param {string} motionGroup The motion-group identifier.
|
|
8498
8513
|
* @param {*} [options] Override http request option.
|
|
8499
8514
|
* @throws {RequiredError}
|
|
8500
8515
|
*/
|
|
8501
|
-
|
|
8516
|
+
getMotionGroupState(cell: string, controller: string, motionGroup: string, options?: RawAxiosRequestConfig): AxiosPromise<MotionGroupJoints>;
|
|
8502
8517
|
/**
|
|
8503
|
-
*
|
|
8504
|
-
* @summary
|
|
8518
|
+
* Gets information on the motion group.
|
|
8519
|
+
* @summary Motion Group Description
|
|
8505
8520
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8506
8521
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
8507
|
-
* @param {boolean} [active]
|
|
8508
8522
|
* @param {*} [options] Override http request option.
|
|
8509
8523
|
* @throws {RequiredError}
|
|
8510
8524
|
*/
|
|
8511
|
-
|
|
8525
|
+
getMotionGroups(cell: string, controller: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<MotionGroupInfo>>;
|
|
8512
8526
|
/**
|
|
8513
|
-
*
|
|
8514
|
-
* @summary
|
|
8527
|
+
* 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.
|
|
8528
|
+
* @summary Get Operation Mode
|
|
8515
8529
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8516
8530
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
8517
|
-
* @param {OperationMode} mode
|
|
8518
8531
|
* @param {*} [options] Override http request option.
|
|
8519
8532
|
* @throws {RequiredError}
|
|
8520
8533
|
*/
|
|
8521
|
-
|
|
8522
|
-
};
|
|
8523
|
-
/**
|
|
8524
|
-
* VirtualRobotModeApi - functional programming interface
|
|
8525
|
-
* @export
|
|
8526
|
-
*/
|
|
8527
|
-
export declare const VirtualRobotModeApiFp: (configuration?: Configuration) => {
|
|
8534
|
+
getOperationMode(cell: string, controller: string, options?: RawAxiosRequestConfig): AxiosPromise<OpMode>;
|
|
8528
8535
|
/**
|
|
8529
|
-
*
|
|
8530
|
-
* @summary
|
|
8536
|
+
* Gets motion group mounting. The motion group is based on the origin of the returned coordinate system.
|
|
8537
|
+
* @summary Get Mounting
|
|
8531
8538
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8532
8539
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
8540
|
+
* @param {string} motionGroup The motion-group identifier.
|
|
8533
8541
|
* @param {*} [options] Override http request option.
|
|
8534
8542
|
* @throws {RequiredError}
|
|
8535
8543
|
*/
|
|
8536
|
-
|
|
8544
|
+
getVirtualControllerMounting(cell: string, controller: string, motionGroup: string, options?: RawAxiosRequestConfig): AxiosPromise<CoordinateSystem>;
|
|
8537
8545
|
/**
|
|
8538
|
-
*
|
|
8539
|
-
* @summary
|
|
8546
|
+
* Lists all coordinate systems on the robot controller.
|
|
8547
|
+
* @summary List Coordinate Systems
|
|
8540
8548
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8541
8549
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
8542
8550
|
* @param {*} [options] Override http request option.
|
|
8543
8551
|
* @throws {RequiredError}
|
|
8544
8552
|
*/
|
|
8545
|
-
|
|
8553
|
+
listVirtualControllerCoordinateSystems(cell: string, controller: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<CoordinateSystem>>;
|
|
8546
8554
|
/**
|
|
8547
|
-
*
|
|
8548
|
-
* @summary
|
|
8555
|
+
* Lists TCPs of the motion group. An empty TCP list is valid, for example for external axes.
|
|
8556
|
+
* @summary List TCPs
|
|
8549
8557
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8550
8558
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
8559
|
+
* @param {string} motionGroup The motion-group identifier.
|
|
8551
8560
|
* @param {*} [options] Override http request option.
|
|
8552
8561
|
* @throws {RequiredError}
|
|
8553
8562
|
*/
|
|
8554
|
-
|
|
8563
|
+
listVirtualControllerTcps(cell: string, controller: string, motionGroup: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<RobotTcp>>;
|
|
8555
8564
|
/**
|
|
8556
8565
|
* 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.
|
|
8557
8566
|
* @summary Push or Release Emergency Stop
|
|
@@ -8561,7 +8570,18 @@ export declare const VirtualRobotModeApiFp: (configuration?: Configuration) => {
|
|
|
8561
8570
|
* @param {*} [options] Override http request option.
|
|
8562
8571
|
* @throws {RequiredError}
|
|
8563
8572
|
*/
|
|
8564
|
-
setEmergencyStop(cell: string, controller: string, active?: boolean, options?: RawAxiosRequestConfig):
|
|
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>;
|
|
8565
8585
|
/**
|
|
8566
8586
|
* 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.
|
|
8567
8587
|
* @summary Set Operation Mode
|
|
@@ -8571,88 +8591,106 @@ export declare const VirtualRobotModeApiFp: (configuration?: Configuration) => {
|
|
|
8571
8591
|
* @param {*} [options] Override http request option.
|
|
8572
8592
|
* @throws {RequiredError}
|
|
8573
8593
|
*/
|
|
8574
|
-
setOperationMode(cell: string, controller: string, mode: OperationMode, options?: RawAxiosRequestConfig):
|
|
8575
|
-
};
|
|
8576
|
-
/**
|
|
8577
|
-
* VirtualRobotModeApi - factory interface
|
|
8578
|
-
* @export
|
|
8579
|
-
*/
|
|
8580
|
-
export declare const VirtualRobotModeApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
8594
|
+
setOperationMode(cell: string, controller: string, mode: OperationMode, options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
8581
8595
|
/**
|
|
8582
|
-
*
|
|
8583
|
-
* @summary
|
|
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
|
|
8584
8598
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8585
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
|
|
8586
8602
|
* @param {*} [options] Override http request option.
|
|
8587
8603
|
* @throws {RequiredError}
|
|
8588
8604
|
*/
|
|
8589
|
-
|
|
8605
|
+
setVirtualControllerMounting(cell: string, controller: string, motionGroup: string, coordinateSystem: CoordinateSystem, options?: RawAxiosRequestConfig): AxiosPromise<CoordinateSystem>;
|
|
8606
|
+
};
|
|
8607
|
+
/**
|
|
8608
|
+
* VirtualControllerApi - object-oriented interface
|
|
8609
|
+
* @export
|
|
8610
|
+
* @class VirtualControllerApi
|
|
8611
|
+
* @extends {BaseAPI}
|
|
8612
|
+
*/
|
|
8613
|
+
export declare class VirtualControllerApi extends BaseAPI {
|
|
8590
8614
|
/**
|
|
8591
|
-
*
|
|
8592
|
-
* @summary
|
|
8615
|
+
* Adds a coordinate system to the robot controller.
|
|
8616
|
+
* @summary Add Coordinate Systems
|
|
8593
8617
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8594
8618
|
* @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
|
|
8595
8621
|
* @param {*} [options] Override http request option.
|
|
8596
8622
|
* @throws {RequiredError}
|
|
8623
|
+
* @memberof VirtualControllerApi
|
|
8597
8624
|
*/
|
|
8598
|
-
|
|
8625
|
+
addVirtualControllerCoordinateSystem(cell: string, controller: string, coordinateSystem: string, coordinateSystemData: CoordinateSystemData, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
8599
8626
|
/**
|
|
8600
|
-
*
|
|
8601
|
-
* @summary
|
|
8627
|
+
* 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.
|
|
8628
|
+
* @summary Add TCP
|
|
8602
8629
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8603
8630
|
* @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
|
|
8604
8634
|
* @param {*} [options] Override http request option.
|
|
8605
8635
|
* @throws {RequiredError}
|
|
8636
|
+
* @memberof VirtualControllerApi
|
|
8606
8637
|
*/
|
|
8607
|
-
|
|
8638
|
+
addVirtualControllerTcp(cell: string, controller: string, motionGroup: string, tcp: string, robotTcpData: RobotTcpData, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
8608
8639
|
/**
|
|
8609
|
-
*
|
|
8610
|
-
* @summary
|
|
8640
|
+
* 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.
|
|
8641
|
+
* @summary Remove Coordinate System
|
|
8611
8642
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8612
8643
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
8613
|
-
* @param {
|
|
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.
|
|
8614
8646
|
* @param {*} [options] Override http request option.
|
|
8615
8647
|
* @throws {RequiredError}
|
|
8648
|
+
* @memberof VirtualControllerApi
|
|
8616
8649
|
*/
|
|
8617
|
-
|
|
8650
|
+
deleteVirtualControllerCoordinateSystem(cell: string, controller: string, coordinateSystem: string, deleteDependent?: boolean, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
8618
8651
|
/**
|
|
8619
|
-
*
|
|
8620
|
-
* @summary
|
|
8652
|
+
* Removes the TCP from the motion group. An unknown TCP is a valid input.
|
|
8653
|
+
* @summary Remove TCP
|
|
8621
8654
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8622
8655
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
8623
|
-
* @param {
|
|
8656
|
+
* @param {string} motionGroup The motion-group identifier.
|
|
8657
|
+
* @param {string} tcp The unique identifier of a TCP.
|
|
8624
8658
|
* @param {*} [options] Override http request option.
|
|
8625
8659
|
* @throws {RequiredError}
|
|
8660
|
+
* @memberof VirtualControllerApi
|
|
8626
8661
|
*/
|
|
8627
|
-
|
|
8628
|
-
};
|
|
8629
|
-
/**
|
|
8630
|
-
* VirtualRobotModeApi - object-oriented interface
|
|
8631
|
-
* @export
|
|
8632
|
-
* @class VirtualRobotModeApi
|
|
8633
|
-
* @extends {BaseAPI}
|
|
8634
|
-
*/
|
|
8635
|
-
export declare class VirtualRobotModeApi extends BaseAPI {
|
|
8662
|
+
deleteVirtualControllerTcp(cell: string, controller: string, motionGroup: string, tcp: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
8636
8663
|
/**
|
|
8637
|
-
*
|
|
8638
|
-
* @summary
|
|
8664
|
+
* 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.
|
|
8665
|
+
* @summary Get Emergency Stop State
|
|
8639
8666
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8640
8667
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
8641
8668
|
* @param {*} [options] Override http request option.
|
|
8642
8669
|
* @throws {RequiredError}
|
|
8643
|
-
* @memberof
|
|
8670
|
+
* @memberof VirtualControllerApi
|
|
8644
8671
|
*/
|
|
8645
|
-
|
|
8672
|
+
getEmergencyStop(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Flag, any>>;
|
|
8646
8673
|
/**
|
|
8647
|
-
*
|
|
8648
|
-
* @summary Get
|
|
8674
|
+
* Get the current motion group state which provides values for the joints\' position, velocity and acceleration.
|
|
8675
|
+
* @summary Get Motion Group State
|
|
8649
8676
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8650
8677
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
8678
|
+
* @param {string} motionGroup The motion-group identifier.
|
|
8651
8679
|
* @param {*} [options] Override http request option.
|
|
8652
8680
|
* @throws {RequiredError}
|
|
8653
|
-
* @memberof
|
|
8681
|
+
* @memberof VirtualControllerApi
|
|
8654
8682
|
*/
|
|
8655
|
-
|
|
8683
|
+
getMotionGroupState(cell: string, controller: string, motionGroup: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<MotionGroupJoints, any>>;
|
|
8684
|
+
/**
|
|
8685
|
+
* Gets information on the motion group.
|
|
8686
|
+
* @summary Motion Group Description
|
|
8687
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8688
|
+
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
8689
|
+
* @param {*} [options] Override http request option.
|
|
8690
|
+
* @throws {RequiredError}
|
|
8691
|
+
* @memberof VirtualControllerApi
|
|
8692
|
+
*/
|
|
8693
|
+
getMotionGroups(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<MotionGroupInfo[], any>>;
|
|
8656
8694
|
/**
|
|
8657
8695
|
* 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.
|
|
8658
8696
|
* @summary Get Operation Mode
|
|
@@ -8660,395 +8698,428 @@ export declare class VirtualRobotModeApi extends BaseAPI {
|
|
|
8660
8698
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
8661
8699
|
* @param {*} [options] Override http request option.
|
|
8662
8700
|
* @throws {RequiredError}
|
|
8663
|
-
* @memberof
|
|
8701
|
+
* @memberof VirtualControllerApi
|
|
8664
8702
|
*/
|
|
8665
8703
|
getOperationMode(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<OpMode, any>>;
|
|
8666
8704
|
/**
|
|
8667
|
-
*
|
|
8668
|
-
* @summary
|
|
8705
|
+
* Gets motion group mounting. The motion group is based on the origin of the returned coordinate system.
|
|
8706
|
+
* @summary Get Mounting
|
|
8669
8707
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8670
8708
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
8671
|
-
* @param {
|
|
8709
|
+
* @param {string} motionGroup The motion-group identifier.
|
|
8672
8710
|
* @param {*} [options] Override http request option.
|
|
8673
8711
|
* @throws {RequiredError}
|
|
8674
|
-
* @memberof
|
|
8712
|
+
* @memberof VirtualControllerApi
|
|
8675
8713
|
*/
|
|
8676
|
-
|
|
8714
|
+
getVirtualControllerMounting(cell: string, controller: string, motionGroup: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CoordinateSystem, any>>;
|
|
8677
8715
|
/**
|
|
8678
|
-
*
|
|
8679
|
-
* @summary
|
|
8716
|
+
* Lists all coordinate systems on the robot controller.
|
|
8717
|
+
* @summary List Coordinate Systems
|
|
8680
8718
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8681
8719
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
8682
|
-
* @param {OperationMode} mode
|
|
8683
8720
|
* @param {*} [options] Override http request option.
|
|
8684
8721
|
* @throws {RequiredError}
|
|
8685
|
-
* @memberof
|
|
8722
|
+
* @memberof VirtualControllerApi
|
|
8686
8723
|
*/
|
|
8687
|
-
|
|
8688
|
-
}
|
|
8689
|
-
/**
|
|
8690
|
-
* VirtualRobotSetupApi - axios parameter creator
|
|
8691
|
-
* @export
|
|
8692
|
-
*/
|
|
8693
|
-
export declare const VirtualRobotSetupApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
8724
|
+
listVirtualControllerCoordinateSystems(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CoordinateSystem[], any>>;
|
|
8694
8725
|
/**
|
|
8695
|
-
*
|
|
8696
|
-
* @summary
|
|
8726
|
+
* Lists TCPs of the motion group. An empty TCP list is valid, for example for external axes.
|
|
8727
|
+
* @summary List TCPs
|
|
8697
8728
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8698
8729
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
8699
|
-
* @param {
|
|
8730
|
+
* @param {string} motionGroup The motion-group identifier.
|
|
8700
8731
|
* @param {*} [options] Override http request option.
|
|
8701
8732
|
* @throws {RequiredError}
|
|
8733
|
+
* @memberof VirtualControllerApi
|
|
8702
8734
|
*/
|
|
8703
|
-
|
|
8735
|
+
listVirtualControllerTcps(cell: string, controller: string, motionGroup: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<RobotTcp[], any>>;
|
|
8704
8736
|
/**
|
|
8705
|
-
*
|
|
8706
|
-
* @summary
|
|
8737
|
+
* 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.
|
|
8738
|
+
* @summary Push or Release Emergency Stop
|
|
8739
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8740
|
+
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
8741
|
+
* @param {boolean} [active]
|
|
8742
|
+
* @param {*} [options] Override http request option.
|
|
8743
|
+
* @throws {RequiredError}
|
|
8744
|
+
* @memberof VirtualControllerApi
|
|
8745
|
+
*/
|
|
8746
|
+
setEmergencyStop(cell: string, controller: string, active?: boolean, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
8747
|
+
/**
|
|
8748
|
+
* 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.
|
|
8749
|
+
* @summary Set Motion Group State
|
|
8707
8750
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8708
8751
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
8709
8752
|
* @param {string} motionGroup The motion-group identifier.
|
|
8710
|
-
* @param {
|
|
8753
|
+
* @param {MotionGroupJoints} motionGroupJoints
|
|
8711
8754
|
* @param {*} [options] Override http request option.
|
|
8712
8755
|
* @throws {RequiredError}
|
|
8756
|
+
* @memberof VirtualControllerApi
|
|
8713
8757
|
*/
|
|
8714
|
-
|
|
8758
|
+
setMotionGroupState(cell: string, controller: string, motionGroup: string, motionGroupJoints: MotionGroupJoints, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
8715
8759
|
/**
|
|
8716
|
-
*
|
|
8717
|
-
* @summary
|
|
8760
|
+
* 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.
|
|
8761
|
+
* @summary Set Operation Mode
|
|
8718
8762
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8719
8763
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
8720
|
-
* @param {
|
|
8721
|
-
* @param {boolean} [deleteDependent] If true, all dependent coordinate systems will be deleted as well.
|
|
8764
|
+
* @param {OperationMode} mode
|
|
8722
8765
|
* @param {*} [options] Override http request option.
|
|
8723
8766
|
* @throws {RequiredError}
|
|
8767
|
+
* @memberof VirtualControllerApi
|
|
8724
8768
|
*/
|
|
8725
|
-
|
|
8769
|
+
setOperationMode(cell: string, controller: string, mode: OperationMode, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
8726
8770
|
/**
|
|
8727
|
-
*
|
|
8728
|
-
* @summary
|
|
8771
|
+
* 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.
|
|
8772
|
+
* @summary Set Mounting
|
|
8729
8773
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8730
8774
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
8731
8775
|
* @param {string} motionGroup The motion-group identifier.
|
|
8732
|
-
* @param {
|
|
8776
|
+
* @param {CoordinateSystem} coordinateSystem
|
|
8733
8777
|
* @param {*} [options] Override http request option.
|
|
8734
8778
|
* @throws {RequiredError}
|
|
8779
|
+
* @memberof VirtualControllerApi
|
|
8735
8780
|
*/
|
|
8736
|
-
|
|
8781
|
+
setVirtualControllerMounting(cell: string, controller: string, motionGroup: string, coordinateSystem: CoordinateSystem, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CoordinateSystem, any>>;
|
|
8782
|
+
}
|
|
8783
|
+
/**
|
|
8784
|
+
* VirtualControllerBehaviorApi - axios parameter creator
|
|
8785
|
+
* @export
|
|
8786
|
+
*/
|
|
8787
|
+
export declare const VirtualControllerBehaviorApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
8737
8788
|
/**
|
|
8738
|
-
*
|
|
8739
|
-
* @summary
|
|
8789
|
+
* <!-- theme: danger --> > Websocket endpoint This stream sends the commanded state (joint positions, velocities, accelerations, torques) for each motion group of the virtual controller and sets the joint configuration. Moving motion groups on virtual controllers can be executed by using Trajectory Planning and Trajectory Execution. Trajectory Execution commands the desired joint configuration to each 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! > **NOTE** > > This stream provides *commanded* joint states, it **doesn\'t provide actual joint states**. When the virtual controller receives joint commands the joint configuration is immediately adapted to match the incoming joint configuration. > **CAUTION** > > Incoming joint configurations are not visualized and their velocity limits are not checked. 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 groups. 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.
|
|
8790
|
+
* @summary Stream Joint Configuration
|
|
8740
8791
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8741
8792
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
8742
|
-
* @param {
|
|
8793
|
+
* @param {ExternalJointStreamRequest} externalJointStreamRequest
|
|
8743
8794
|
* @param {*} [options] Override http request option.
|
|
8744
8795
|
* @throws {RequiredError}
|
|
8745
8796
|
*/
|
|
8746
|
-
|
|
8797
|
+
externalJointsStream: (cell: string, controller: string, externalJointStreamRequest: ExternalJointStreamRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
8747
8798
|
/**
|
|
8748
|
-
*
|
|
8749
|
-
* @summary
|
|
8799
|
+
* Get the cycle time of controller communication in [ms].
|
|
8800
|
+
* @summary Get Cycle Time
|
|
8750
8801
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8751
8802
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
8752
8803
|
* @param {*} [options] Override http request option.
|
|
8753
8804
|
* @throws {RequiredError}
|
|
8754
8805
|
*/
|
|
8755
|
-
|
|
8806
|
+
getCycleTime: (cell: string, controller: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
8756
8807
|
/**
|
|
8757
|
-
*
|
|
8758
|
-
* @summary
|
|
8808
|
+
* Get the current virtual controller behavior - please see the setter [setVirtualControllerBehavior](setVirtualControllerBehavior) and the enum for details.
|
|
8809
|
+
* @summary Get Behavior
|
|
8759
8810
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8760
8811
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
8761
|
-
* @param {string} motionGroup The motion-group identifier.
|
|
8762
8812
|
* @param {*} [options] Override http request option.
|
|
8763
8813
|
* @throws {RequiredError}
|
|
8764
8814
|
*/
|
|
8765
|
-
|
|
8815
|
+
getVirtualControllerBehavior: (cell: string, controller: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
8766
8816
|
/**
|
|
8767
|
-
*
|
|
8768
|
-
* @summary Set
|
|
8817
|
+
* Set virtual controller behavior.
|
|
8818
|
+
* @summary Set Behavior
|
|
8769
8819
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8770
8820
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
8771
|
-
* @param {
|
|
8772
|
-
* @param {CoordinateSystem} coordinateSystem
|
|
8821
|
+
* @param {Behavior} [behavior]
|
|
8773
8822
|
* @param {*} [options] Override http request option.
|
|
8774
8823
|
* @throws {RequiredError}
|
|
8775
8824
|
*/
|
|
8776
|
-
|
|
8825
|
+
setVirtualControllerBehavior: (cell: string, controller: string, behavior?: Behavior, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
8777
8826
|
};
|
|
8778
8827
|
/**
|
|
8779
|
-
*
|
|
8828
|
+
* VirtualControllerBehaviorApi - functional programming interface
|
|
8780
8829
|
* @export
|
|
8781
8830
|
*/
|
|
8782
|
-
export declare const
|
|
8831
|
+
export declare const VirtualControllerBehaviorApiFp: (configuration?: Configuration) => {
|
|
8783
8832
|
/**
|
|
8784
|
-
*
|
|
8785
|
-
* @summary
|
|
8833
|
+
* <!-- theme: danger --> > Websocket endpoint This stream sends the commanded state (joint positions, velocities, accelerations, torques) for each motion group of the virtual controller and sets the joint configuration. Moving motion groups on virtual controllers can be executed by using Trajectory Planning and Trajectory Execution. Trajectory Execution commands the desired joint configuration to each 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! > **NOTE** > > This stream provides *commanded* joint states, it **doesn\'t provide actual joint states**. When the virtual controller receives joint commands the joint configuration is immediately adapted to match the incoming joint configuration. > **CAUTION** > > Incoming joint configurations are not visualized and their velocity limits are not checked. 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 groups. 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.
|
|
8834
|
+
* @summary Stream Joint Configuration
|
|
8786
8835
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8787
8836
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
8788
|
-
* @param {
|
|
8837
|
+
* @param {ExternalJointStreamRequest} externalJointStreamRequest
|
|
8789
8838
|
* @param {*} [options] Override http request option.
|
|
8790
8839
|
* @throws {RequiredError}
|
|
8791
8840
|
*/
|
|
8792
|
-
|
|
8841
|
+
externalJointsStream(cell: string, controller: string, externalJointStreamRequest: ExternalJointStreamRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<ExternalJointStreamDatapoint>>>;
|
|
8793
8842
|
/**
|
|
8794
|
-
*
|
|
8795
|
-
* @summary
|
|
8843
|
+
* Get the cycle time of controller communication in [ms].
|
|
8844
|
+
* @summary Get Cycle Time
|
|
8796
8845
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8797
8846
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
8798
|
-
* @param {string} motionGroup The motion-group identifier.
|
|
8799
|
-
* @param {RobotTcp} robotTcp
|
|
8800
8847
|
* @param {*} [options] Override http request option.
|
|
8801
8848
|
* @throws {RequiredError}
|
|
8802
8849
|
*/
|
|
8803
|
-
|
|
8850
|
+
getCycleTime(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CycleTime>>;
|
|
8804
8851
|
/**
|
|
8805
|
-
*
|
|
8806
|
-
* @summary
|
|
8852
|
+
* Get the current virtual controller behavior - please see the setter [setVirtualControllerBehavior](setVirtualControllerBehavior) and the enum for details.
|
|
8853
|
+
* @summary Get Behavior
|
|
8807
8854
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8808
8855
|
* @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.
|
|
8811
8856
|
* @param {*} [options] Override http request option.
|
|
8812
8857
|
* @throws {RequiredError}
|
|
8813
8858
|
*/
|
|
8814
|
-
|
|
8859
|
+
getVirtualControllerBehavior(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Behavior>>;
|
|
8815
8860
|
/**
|
|
8816
|
-
*
|
|
8817
|
-
* @summary
|
|
8861
|
+
* Set virtual controller behavior.
|
|
8862
|
+
* @summary Set Behavior
|
|
8818
8863
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8819
8864
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
8820
|
-
* @param {
|
|
8821
|
-
* @param {string} tcp The unique identifier of a TCP.
|
|
8865
|
+
* @param {Behavior} [behavior]
|
|
8822
8866
|
* @param {*} [options] Override http request option.
|
|
8823
8867
|
* @throws {RequiredError}
|
|
8824
8868
|
*/
|
|
8825
|
-
|
|
8869
|
+
setVirtualControllerBehavior(cell: string, controller: string, behavior?: Behavior, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
8870
|
+
};
|
|
8871
|
+
/**
|
|
8872
|
+
* VirtualControllerBehaviorApi - factory interface
|
|
8873
|
+
* @export
|
|
8874
|
+
*/
|
|
8875
|
+
export declare const VirtualControllerBehaviorApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
8826
8876
|
/**
|
|
8827
|
-
*
|
|
8828
|
-
* @summary
|
|
8877
|
+
* <!-- theme: danger --> > Websocket endpoint This stream sends the commanded state (joint positions, velocities, accelerations, torques) for each motion group of the virtual controller and sets the joint configuration. Moving motion groups on virtual controllers can be executed by using Trajectory Planning and Trajectory Execution. Trajectory Execution commands the desired joint configuration to each 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! > **NOTE** > > This stream provides *commanded* joint states, it **doesn\'t provide actual joint states**. When the virtual controller receives joint commands the joint configuration is immediately adapted to match the incoming joint configuration. > **CAUTION** > > Incoming joint configurations are not visualized and their velocity limits are not checked. 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 groups. 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.
|
|
8878
|
+
* @summary Stream Joint Configuration
|
|
8829
8879
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8830
8880
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
8831
|
-
* @param {
|
|
8881
|
+
* @param {ExternalJointStreamRequest} externalJointStreamRequest
|
|
8832
8882
|
* @param {*} [options] Override http request option.
|
|
8833
8883
|
* @throws {RequiredError}
|
|
8834
8884
|
*/
|
|
8835
|
-
|
|
8885
|
+
externalJointsStream(cell: string, controller: string, externalJointStreamRequest: ExternalJointStreamRequest, options?: RawAxiosRequestConfig): AxiosPromise<Array<ExternalJointStreamDatapoint>>;
|
|
8836
8886
|
/**
|
|
8837
|
-
*
|
|
8838
|
-
* @summary
|
|
8887
|
+
* Get the cycle time of controller communication in [ms].
|
|
8888
|
+
* @summary Get Cycle Time
|
|
8839
8889
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8840
8890
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
8841
8891
|
* @param {*} [options] Override http request option.
|
|
8842
8892
|
* @throws {RequiredError}
|
|
8843
8893
|
*/
|
|
8844
|
-
|
|
8894
|
+
getCycleTime(cell: string, controller: string, options?: RawAxiosRequestConfig): AxiosPromise<CycleTime>;
|
|
8845
8895
|
/**
|
|
8846
|
-
*
|
|
8847
|
-
* @summary
|
|
8896
|
+
* Get the current virtual controller behavior - please see the setter [setVirtualControllerBehavior](setVirtualControllerBehavior) and the enum for details.
|
|
8897
|
+
* @summary Get Behavior
|
|
8848
8898
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8849
8899
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
8850
|
-
* @param {string} motionGroup The motion-group identifier.
|
|
8851
8900
|
* @param {*} [options] Override http request option.
|
|
8852
8901
|
* @throws {RequiredError}
|
|
8853
8902
|
*/
|
|
8854
|
-
|
|
8903
|
+
getVirtualControllerBehavior(cell: string, controller: string, options?: RawAxiosRequestConfig): AxiosPromise<Behavior>;
|
|
8855
8904
|
/**
|
|
8856
|
-
*
|
|
8857
|
-
* @summary Set
|
|
8905
|
+
* Set virtual controller behavior.
|
|
8906
|
+
* @summary Set Behavior
|
|
8858
8907
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8859
8908
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
8860
|
-
* @param {
|
|
8861
|
-
* @param {CoordinateSystem} coordinateSystem
|
|
8909
|
+
* @param {Behavior} [behavior]
|
|
8862
8910
|
* @param {*} [options] Override http request option.
|
|
8863
8911
|
* @throws {RequiredError}
|
|
8864
8912
|
*/
|
|
8865
|
-
|
|
8913
|
+
setVirtualControllerBehavior(cell: string, controller: string, behavior?: Behavior, options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
8866
8914
|
};
|
|
8867
8915
|
/**
|
|
8868
|
-
*
|
|
8916
|
+
* VirtualControllerBehaviorApi - object-oriented interface
|
|
8869
8917
|
* @export
|
|
8918
|
+
* @class VirtualControllerBehaviorApi
|
|
8919
|
+
* @extends {BaseAPI}
|
|
8870
8920
|
*/
|
|
8871
|
-
export declare
|
|
8921
|
+
export declare class VirtualControllerBehaviorApi extends BaseAPI {
|
|
8872
8922
|
/**
|
|
8873
|
-
*
|
|
8874
|
-
* @summary
|
|
8923
|
+
* <!-- theme: danger --> > Websocket endpoint This stream sends the commanded state (joint positions, velocities, accelerations, torques) for each motion group of the virtual controller and sets the joint configuration. Moving motion groups on virtual controllers can be executed by using Trajectory Planning and Trajectory Execution. Trajectory Execution commands the desired joint configuration to each 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! > **NOTE** > > This stream provides *commanded* joint states, it **doesn\'t provide actual joint states**. When the virtual controller receives joint commands the joint configuration is immediately adapted to match the incoming joint configuration. > **CAUTION** > > Incoming joint configurations are not visualized and their velocity limits are not checked. 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 groups. 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.
|
|
8924
|
+
* @summary Stream Joint Configuration
|
|
8875
8925
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8876
8926
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
8877
|
-
* @param {
|
|
8927
|
+
* @param {ExternalJointStreamRequest} externalJointStreamRequest
|
|
8878
8928
|
* @param {*} [options] Override http request option.
|
|
8879
8929
|
* @throws {RequiredError}
|
|
8930
|
+
* @memberof VirtualControllerBehaviorApi
|
|
8880
8931
|
*/
|
|
8881
|
-
|
|
8932
|
+
externalJointsStream(cell: string, controller: string, externalJointStreamRequest: ExternalJointStreamRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ExternalJointStreamDatapoint[], any>>;
|
|
8882
8933
|
/**
|
|
8883
|
-
*
|
|
8884
|
-
* @summary
|
|
8934
|
+
* Get the cycle time of controller communication in [ms].
|
|
8935
|
+
* @summary Get Cycle Time
|
|
8885
8936
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8886
8937
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
8887
|
-
* @param {string} motionGroup The motion-group identifier.
|
|
8888
|
-
* @param {RobotTcp} robotTcp
|
|
8889
8938
|
* @param {*} [options] Override http request option.
|
|
8890
8939
|
* @throws {RequiredError}
|
|
8940
|
+
* @memberof VirtualControllerBehaviorApi
|
|
8891
8941
|
*/
|
|
8892
|
-
|
|
8942
|
+
getCycleTime(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CycleTime, any>>;
|
|
8893
8943
|
/**
|
|
8894
|
-
*
|
|
8895
|
-
* @summary
|
|
8944
|
+
* Get the current virtual controller behavior - please see the setter [setVirtualControllerBehavior](setVirtualControllerBehavior) and the enum for details.
|
|
8945
|
+
* @summary Get Behavior
|
|
8896
8946
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8897
8947
|
* @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.
|
|
8900
8948
|
* @param {*} [options] Override http request option.
|
|
8901
8949
|
* @throws {RequiredError}
|
|
8950
|
+
* @memberof VirtualControllerBehaviorApi
|
|
8902
8951
|
*/
|
|
8903
|
-
|
|
8952
|
+
getVirtualControllerBehavior(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Behavior, any>>;
|
|
8904
8953
|
/**
|
|
8905
|
-
*
|
|
8906
|
-
* @summary
|
|
8954
|
+
* Set virtual controller behavior.
|
|
8955
|
+
* @summary Set Behavior
|
|
8907
8956
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8908
8957
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
8909
|
-
* @param {
|
|
8910
|
-
* @param {string} tcp The unique identifier of a TCP.
|
|
8958
|
+
* @param {Behavior} [behavior]
|
|
8911
8959
|
* @param {*} [options] Override http request option.
|
|
8912
8960
|
* @throws {RequiredError}
|
|
8961
|
+
* @memberof VirtualControllerBehaviorApi
|
|
8913
8962
|
*/
|
|
8914
|
-
|
|
8963
|
+
setVirtualControllerBehavior(cell: string, controller: string, behavior?: Behavior, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
8964
|
+
}
|
|
8965
|
+
/**
|
|
8966
|
+
* VirtualControllerInputsOutputsApi - axios parameter creator
|
|
8967
|
+
* @export
|
|
8968
|
+
*/
|
|
8969
|
+
export declare const VirtualControllerInputsOutputsApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
8915
8970
|
/**
|
|
8916
|
-
*
|
|
8917
|
-
* @summary Get
|
|
8971
|
+
* 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 [listVirtualControllerIODescriptions](listVirtualControllerIODescriptions).
|
|
8972
|
+
* @summary Get Input/Output Values
|
|
8918
8973
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8919
8974
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
8920
|
-
* @param {string}
|
|
8975
|
+
* @param {Array<string>} ios
|
|
8921
8976
|
* @param {*} [options] Override http request option.
|
|
8922
8977
|
* @throws {RequiredError}
|
|
8923
8978
|
*/
|
|
8924
|
-
|
|
8979
|
+
listIOs: (cell: string, controller: string, ios: Array<string>, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
8925
8980
|
/**
|
|
8926
|
-
* Lists
|
|
8927
|
-
* @summary List
|
|
8981
|
+
* 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.
|
|
8982
|
+
* @summary List Descriptions
|
|
8928
8983
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8929
8984
|
* @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.
|
|
8930
8989
|
* @param {*} [options] Override http request option.
|
|
8931
8990
|
* @throws {RequiredError}
|
|
8932
8991
|
*/
|
|
8933
|
-
|
|
8992
|
+
listVirtualControllerIODescriptions: (cell: string, controller: string, ios?: Array<string>, direction?: IODirection, valueType?: IOValueType, group?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
8934
8993
|
/**
|
|
8935
|
-
*
|
|
8936
|
-
* @summary
|
|
8994
|
+
* Sets a list of values of a virtual controller inputs/outputs.
|
|
8995
|
+
* @summary Set Input/Ouput Values
|
|
8937
8996
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8938
8997
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
8939
|
-
* @param {
|
|
8998
|
+
* @param {Array<IOValue>} iOValue
|
|
8940
8999
|
* @param {*} [options] Override http request option.
|
|
8941
9000
|
* @throws {RequiredError}
|
|
8942
9001
|
*/
|
|
8943
|
-
|
|
9002
|
+
setIOValues: (cell: string, controller: string, iOValue: Array<IOValue>, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
9003
|
+
};
|
|
9004
|
+
/**
|
|
9005
|
+
* VirtualControllerInputsOutputsApi - functional programming interface
|
|
9006
|
+
* @export
|
|
9007
|
+
*/
|
|
9008
|
+
export declare const VirtualControllerInputsOutputsApiFp: (configuration?: Configuration) => {
|
|
8944
9009
|
/**
|
|
8945
|
-
*
|
|
8946
|
-
* @summary
|
|
9010
|
+
* 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 [listVirtualControllerIODescriptions](listVirtualControllerIODescriptions).
|
|
9011
|
+
* @summary Get Input/Output Values
|
|
8947
9012
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8948
9013
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
8949
|
-
* @param {string}
|
|
8950
|
-
* @param {CoordinateSystem} coordinateSystem
|
|
9014
|
+
* @param {Array<string>} ios
|
|
8951
9015
|
* @param {*} [options] Override http request option.
|
|
8952
9016
|
* @throws {RequiredError}
|
|
8953
9017
|
*/
|
|
8954
|
-
|
|
8955
|
-
};
|
|
8956
|
-
/**
|
|
8957
|
-
* VirtualRobotSetupApi - object-oriented interface
|
|
8958
|
-
* @export
|
|
8959
|
-
* @class VirtualRobotSetupApi
|
|
8960
|
-
* @extends {BaseAPI}
|
|
8961
|
-
*/
|
|
8962
|
-
export declare class VirtualRobotSetupApi extends BaseAPI {
|
|
9018
|
+
listIOs(cell: string, controller: string, ios: Array<string>, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<IOValue>>>;
|
|
8963
9019
|
/**
|
|
8964
|
-
*
|
|
8965
|
-
* @summary
|
|
9020
|
+
* 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.
|
|
9021
|
+
* @summary List Descriptions
|
|
8966
9022
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8967
9023
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
8968
|
-
* @param {
|
|
9024
|
+
* @param {Array<string>} [ios]
|
|
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.
|
|
8969
9028
|
* @param {*} [options] Override http request option.
|
|
8970
9029
|
* @throws {RequiredError}
|
|
8971
|
-
* @memberof VirtualRobotSetupApi
|
|
8972
9030
|
*/
|
|
8973
|
-
|
|
9031
|
+
listVirtualControllerIODescriptions(cell: string, controller: string, ios?: Array<string>, direction?: IODirection, valueType?: IOValueType, group?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<IODescription>>>;
|
|
8974
9032
|
/**
|
|
8975
|
-
*
|
|
8976
|
-
* @summary
|
|
9033
|
+
* Sets a list of values of a virtual controller inputs/outputs.
|
|
9034
|
+
* @summary Set Input/Ouput Values
|
|
8977
9035
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8978
9036
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
8979
|
-
* @param {
|
|
8980
|
-
* @param {RobotTcp} robotTcp
|
|
9037
|
+
* @param {Array<IOValue>} iOValue
|
|
8981
9038
|
* @param {*} [options] Override http request option.
|
|
8982
9039
|
* @throws {RequiredError}
|
|
8983
|
-
* @memberof VirtualRobotSetupApi
|
|
8984
9040
|
*/
|
|
8985
|
-
|
|
9041
|
+
setIOValues(cell: string, controller: string, iOValue: Array<IOValue>, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
9042
|
+
};
|
|
9043
|
+
/**
|
|
9044
|
+
* VirtualControllerInputsOutputsApi - factory interface
|
|
9045
|
+
* @export
|
|
9046
|
+
*/
|
|
9047
|
+
export declare const VirtualControllerInputsOutputsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
8986
9048
|
/**
|
|
8987
|
-
*
|
|
8988
|
-
* @summary
|
|
9049
|
+
* 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 [listVirtualControllerIODescriptions](listVirtualControllerIODescriptions).
|
|
9050
|
+
* @summary Get Input/Output Values
|
|
8989
9051
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8990
9052
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
8991
|
-
* @param {string}
|
|
8992
|
-
* @param {boolean} [deleteDependent] If true, all dependent coordinate systems will be deleted as well.
|
|
9053
|
+
* @param {Array<string>} ios
|
|
8993
9054
|
* @param {*} [options] Override http request option.
|
|
8994
9055
|
* @throws {RequiredError}
|
|
8995
|
-
* @memberof VirtualRobotSetupApi
|
|
8996
9056
|
*/
|
|
8997
|
-
|
|
9057
|
+
listIOs(cell: string, controller: string, ios: Array<string>, options?: RawAxiosRequestConfig): AxiosPromise<Array<IOValue>>;
|
|
8998
9058
|
/**
|
|
8999
|
-
*
|
|
9000
|
-
* @summary
|
|
9059
|
+
* 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.
|
|
9060
|
+
* @summary List Descriptions
|
|
9001
9061
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
9002
9062
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
9003
|
-
* @param {string}
|
|
9004
|
-
* @param {
|
|
9063
|
+
* @param {Array<string>} [ios]
|
|
9064
|
+
* @param {IODirection} [direction] Return only inputs/outputs with the specified direction.
|
|
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.
|
|
9005
9067
|
* @param {*} [options] Override http request option.
|
|
9006
9068
|
* @throws {RequiredError}
|
|
9007
|
-
* @memberof VirtualRobotSetupApi
|
|
9008
9069
|
*/
|
|
9009
|
-
|
|
9070
|
+
listVirtualControllerIODescriptions(cell: string, controller: string, ios?: Array<string>, direction?: IODirection, valueType?: IOValueType, group?: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<IODescription>>;
|
|
9010
9071
|
/**
|
|
9011
|
-
*
|
|
9012
|
-
* @summary
|
|
9072
|
+
* Sets a list of values of a virtual controller inputs/outputs.
|
|
9073
|
+
* @summary Set Input/Ouput Values
|
|
9013
9074
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
9014
9075
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
9015
|
-
* @param {
|
|
9076
|
+
* @param {Array<IOValue>} iOValue
|
|
9016
9077
|
* @param {*} [options] Override http request option.
|
|
9017
9078
|
* @throws {RequiredError}
|
|
9018
|
-
* @memberof VirtualRobotSetupApi
|
|
9019
9079
|
*/
|
|
9020
|
-
|
|
9080
|
+
setIOValues(cell: string, controller: string, iOValue: Array<IOValue>, options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
9081
|
+
};
|
|
9082
|
+
/**
|
|
9083
|
+
* VirtualControllerInputsOutputsApi - object-oriented interface
|
|
9084
|
+
* @export
|
|
9085
|
+
* @class VirtualControllerInputsOutputsApi
|
|
9086
|
+
* @extends {BaseAPI}
|
|
9087
|
+
*/
|
|
9088
|
+
export declare class VirtualControllerInputsOutputsApi extends BaseAPI {
|
|
9021
9089
|
/**
|
|
9022
|
-
*
|
|
9023
|
-
* @summary
|
|
9090
|
+
* 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 [listVirtualControllerIODescriptions](listVirtualControllerIODescriptions).
|
|
9091
|
+
* @summary Get Input/Output Values
|
|
9024
9092
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
9025
9093
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
9094
|
+
* @param {Array<string>} ios
|
|
9026
9095
|
* @param {*} [options] Override http request option.
|
|
9027
9096
|
* @throws {RequiredError}
|
|
9028
|
-
* @memberof
|
|
9097
|
+
* @memberof VirtualControllerInputsOutputsApi
|
|
9029
9098
|
*/
|
|
9030
|
-
|
|
9099
|
+
listIOs(cell: string, controller: string, ios: Array<string>, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<IOValue[], any>>;
|
|
9031
9100
|
/**
|
|
9032
|
-
* Lists
|
|
9033
|
-
* @summary List
|
|
9101
|
+
* 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.
|
|
9102
|
+
* @summary List Descriptions
|
|
9034
9103
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
9035
9104
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
9036
|
-
* @param {string}
|
|
9105
|
+
* @param {Array<string>} [ios]
|
|
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.
|
|
9037
9109
|
* @param {*} [options] Override http request option.
|
|
9038
9110
|
* @throws {RequiredError}
|
|
9039
|
-
* @memberof
|
|
9111
|
+
* @memberof VirtualControllerInputsOutputsApi
|
|
9040
9112
|
*/
|
|
9041
|
-
|
|
9113
|
+
listVirtualControllerIODescriptions(cell: string, controller: string, ios?: Array<string>, direction?: IODirection, valueType?: IOValueType, group?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<IODescription[], any>>;
|
|
9042
9114
|
/**
|
|
9043
|
-
* Sets
|
|
9044
|
-
* @summary Set
|
|
9115
|
+
* Sets a list of values of a virtual controller inputs/outputs.
|
|
9116
|
+
* @summary Set Input/Ouput Values
|
|
9045
9117
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
9046
9118
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
9047
|
-
* @param {
|
|
9048
|
-
* @param {CoordinateSystem} coordinateSystem
|
|
9119
|
+
* @param {Array<IOValue>} iOValue
|
|
9049
9120
|
* @param {*} [options] Override http request option.
|
|
9050
9121
|
* @throws {RequiredError}
|
|
9051
|
-
* @memberof
|
|
9122
|
+
* @memberof VirtualControllerInputsOutputsApi
|
|
9052
9123
|
*/
|
|
9053
|
-
|
|
9124
|
+
setIOValues(cell: string, controller: string, iOValue: Array<IOValue>, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
9054
9125
|
}
|