@wandelbots/nova-api 25.5.0-dev.9 → 25.6.0-dev.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/package.json +1 -1
- package/v1/api.d.ts +77 -5
- package/v1/api.js +19 -2
- package/v1/api.js.map +1 -1
- package/v1/api.ts +78 -5
- package/v2/api.d.ts +338 -557
- package/v2/api.js +273 -252
- package/v2/api.js.map +1 -1
- package/v2/api.ts +438 -646
package/v2/api.d.ts
CHANGED
|
@@ -193,7 +193,7 @@ export interface AllJointPositionsResponse {
|
|
|
193
193
|
*/
|
|
194
194
|
export interface App {
|
|
195
195
|
/**
|
|
196
|
-
* The name of the provided application. The name must be unique within the cell and is used as a identifier for addressing the application in all API calls , e.g. when updating the application. It also defines where the application is reachable (/$cell/$name).
|
|
196
|
+
* The name of the provided application. The name must be unique within the cell and is used as a identifier for addressing the application in all API calls , e.g. when updating the application. It also defines where the application is reachable (/$cell/$name). 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).
|
|
197
197
|
* @type {string}
|
|
198
198
|
* @memberof App
|
|
199
199
|
*/
|
|
@@ -235,118 +235,6 @@ export interface App {
|
|
|
235
235
|
*/
|
|
236
236
|
'health_path'?: string;
|
|
237
237
|
}
|
|
238
|
-
/**
|
|
239
|
-
*
|
|
240
|
-
* @export
|
|
241
|
-
* @interface ArrayInput
|
|
242
|
-
*/
|
|
243
|
-
export interface ArrayInput {
|
|
244
|
-
/**
|
|
245
|
-
*
|
|
246
|
-
* @type {Array<ArrayInputArrayInner>}
|
|
247
|
-
* @memberof ArrayInput
|
|
248
|
-
*/
|
|
249
|
-
'array': Array<ArrayInputArrayInner>;
|
|
250
|
-
}
|
|
251
|
-
/**
|
|
252
|
-
*
|
|
253
|
-
* @export
|
|
254
|
-
* @interface ArrayInputArrayInner
|
|
255
|
-
*/
|
|
256
|
-
export interface ArrayInputArrayInner {
|
|
257
|
-
/**
|
|
258
|
-
*
|
|
259
|
-
* @type {Array<any>}
|
|
260
|
-
* @memberof ArrayInputArrayInner
|
|
261
|
-
*/
|
|
262
|
-
'pose': Array<any>;
|
|
263
|
-
/**
|
|
264
|
-
*
|
|
265
|
-
* @type {Array<any>}
|
|
266
|
-
* @memberof ArrayInputArrayInner
|
|
267
|
-
*/
|
|
268
|
-
'position': Array<any>;
|
|
269
|
-
/**
|
|
270
|
-
*
|
|
271
|
-
* @type {Array<any>}
|
|
272
|
-
* @memberof ArrayInputArrayInner
|
|
273
|
-
*/
|
|
274
|
-
'orientation': Array<any>;
|
|
275
|
-
/**
|
|
276
|
-
*
|
|
277
|
-
* @type {string}
|
|
278
|
-
* @memberof ArrayInputArrayInner
|
|
279
|
-
*/
|
|
280
|
-
'image': string;
|
|
281
|
-
/**
|
|
282
|
-
*
|
|
283
|
-
* @type {string}
|
|
284
|
-
* @memberof ArrayInputArrayInner
|
|
285
|
-
*/
|
|
286
|
-
'pointcloud': string;
|
|
287
|
-
/**
|
|
288
|
-
*
|
|
289
|
-
* @type {Array<ArrayInputArrayInner>}
|
|
290
|
-
* @memberof ArrayInputArrayInner
|
|
291
|
-
*/
|
|
292
|
-
'array': Array<ArrayInputArrayInner>;
|
|
293
|
-
}
|
|
294
|
-
/**
|
|
295
|
-
*
|
|
296
|
-
* @export
|
|
297
|
-
* @interface ArrayOutput
|
|
298
|
-
*/
|
|
299
|
-
export interface ArrayOutput {
|
|
300
|
-
/**
|
|
301
|
-
*
|
|
302
|
-
* @type {Array<ArrayOutputArrayInner>}
|
|
303
|
-
* @memberof ArrayOutput
|
|
304
|
-
*/
|
|
305
|
-
'array': Array<ArrayOutputArrayInner>;
|
|
306
|
-
}
|
|
307
|
-
/**
|
|
308
|
-
*
|
|
309
|
-
* @export
|
|
310
|
-
* @interface ArrayOutputArrayInner
|
|
311
|
-
*/
|
|
312
|
-
export interface ArrayOutputArrayInner {
|
|
313
|
-
/**
|
|
314
|
-
*
|
|
315
|
-
* @type {Array<any>}
|
|
316
|
-
* @memberof ArrayOutputArrayInner
|
|
317
|
-
*/
|
|
318
|
-
'pose': Array<any>;
|
|
319
|
-
/**
|
|
320
|
-
*
|
|
321
|
-
* @type {Array<any>}
|
|
322
|
-
* @memberof ArrayOutputArrayInner
|
|
323
|
-
*/
|
|
324
|
-
'position': Array<any>;
|
|
325
|
-
/**
|
|
326
|
-
*
|
|
327
|
-
* @type {Array<any>}
|
|
328
|
-
* @memberof ArrayOutputArrayInner
|
|
329
|
-
*/
|
|
330
|
-
'orientation': Array<any>;
|
|
331
|
-
/**
|
|
332
|
-
*
|
|
333
|
-
* @type {string}
|
|
334
|
-
* @memberof ArrayOutputArrayInner
|
|
335
|
-
*/
|
|
336
|
-
'image': string;
|
|
337
|
-
/**
|
|
338
|
-
*
|
|
339
|
-
* @type {string}
|
|
340
|
-
* @memberof ArrayOutputArrayInner
|
|
341
|
-
*/
|
|
342
|
-
'pointcloud': string;
|
|
343
|
-
/**
|
|
344
|
-
*
|
|
345
|
-
* @type {Array<ArrayOutputArrayInner>}
|
|
346
|
-
* @memberof ArrayOutputArrayInner
|
|
347
|
-
*/
|
|
348
|
-
'array': Array<ArrayOutputArrayInner>;
|
|
349
|
-
}
|
|
350
238
|
/**
|
|
351
239
|
* ## BEHAVIOR_AUTOMATIC This is the default behavior. The motion group instantly takes any commanded joint configuration as actual joint state. Configures the compliance of the virtual robot with the normal ControllerState cycle time. If set, the virtual robot will act like a physical one, e.g. with a cycle time of 8ms to respond to a new joint state command. ## BEHAVIOR_AUTOMATIC_NOT_COMPLY_WITH_CYCLETIME Configures the compliance of the virtual robot with the normal ControllerState cycle time. If set, the robot will respond as fast as possible, limited only by software execution speed. Because of that the execution of a movement requires less time than with BEHAVIOR_AUTOMATIC. ## BEHAVIOR_EXTERNAL_SOURCE The external client is the only source of actual joint state changes. This mode is used to enable third party software indicating the current joint state via [externalJointsStream](externalJointsStream).
|
|
352
240
|
* @export
|
|
@@ -557,19 +445,6 @@ export declare const Capsule2ShapeTypeEnum: {
|
|
|
557
445
|
readonly Capsule: "capsule";
|
|
558
446
|
};
|
|
559
447
|
export type Capsule2ShapeTypeEnum = typeof Capsule2ShapeTypeEnum[keyof typeof Capsule2ShapeTypeEnum];
|
|
560
|
-
/**
|
|
561
|
-
*
|
|
562
|
-
* @export
|
|
563
|
-
* @interface Capture
|
|
564
|
-
*/
|
|
565
|
-
export interface Capture {
|
|
566
|
-
/**
|
|
567
|
-
*
|
|
568
|
-
* @type {string}
|
|
569
|
-
* @memberof Capture
|
|
570
|
-
*/
|
|
571
|
-
'image': string;
|
|
572
|
-
}
|
|
573
448
|
/**
|
|
574
449
|
* To create a robot cell, only a valid name is required. Once created, a robot cell provides access to the Wandelbots NOVA foundation services. The configuration can be customized, e.g. robot controllers, also within apps.
|
|
575
450
|
* @export
|
|
@@ -601,27 +476,6 @@ export interface Cell {
|
|
|
601
476
|
*/
|
|
602
477
|
'apps'?: Array<App>;
|
|
603
478
|
}
|
|
604
|
-
/**
|
|
605
|
-
*
|
|
606
|
-
* @export
|
|
607
|
-
* @interface CodeWithArguments
|
|
608
|
-
*/
|
|
609
|
-
export interface CodeWithArguments {
|
|
610
|
-
/**
|
|
611
|
-
* Wandelscript code string which describes a Wandelscript Program as content/json.
|
|
612
|
-
* @type {string}
|
|
613
|
-
* @memberof CodeWithArguments
|
|
614
|
-
*/
|
|
615
|
-
'code': string;
|
|
616
|
-
/**
|
|
617
|
-
*
|
|
618
|
-
* @type {{ [key: string]: ArrayInputArrayInner; }}
|
|
619
|
-
* @memberof CodeWithArguments
|
|
620
|
-
*/
|
|
621
|
-
'initial_state'?: {
|
|
622
|
-
[key: string]: ArrayInputArrayInner;
|
|
623
|
-
} | null;
|
|
624
|
-
}
|
|
625
479
|
/**
|
|
626
480
|
* Defines a collider with a single shape. A collider is an object that is used for collision detection. It defines the `shape` that is attached with the offset of `pose` to a reference frame. Use colliders to: - Define the shape of a workpiece. The reference frame is the scene origin. - Define the shape of a link in a motion group. The reference frame is the link coordinate system. - Define the shape of a tool. The reference frame is the flange coordinate system.
|
|
627
481
|
* @export
|
|
@@ -1139,7 +993,7 @@ export interface CoordinateSystem {
|
|
|
1139
993
|
* @type {string}
|
|
1140
994
|
* @memberof CoordinateSystem
|
|
1141
995
|
*/
|
|
1142
|
-
'
|
|
996
|
+
'reference_coordinate_system'?: string;
|
|
1143
997
|
/**
|
|
1144
998
|
* A three-dimensional vector [x, y, z] with double precision.
|
|
1145
999
|
* @type {Array<number>}
|
|
@@ -1175,26 +1029,26 @@ export interface CoordinateSystems {
|
|
|
1175
1029
|
/**
|
|
1176
1030
|
*
|
|
1177
1031
|
* @export
|
|
1178
|
-
* @interface
|
|
1032
|
+
* @interface CreateProgramOperatorRun200Response
|
|
1179
1033
|
*/
|
|
1180
|
-
export interface
|
|
1034
|
+
export interface CreateProgramOperatorRun200Response {
|
|
1181
1035
|
/**
|
|
1182
1036
|
* The identifier of the program run for further inspection of the running program.
|
|
1183
1037
|
* @type {string}
|
|
1184
|
-
* @memberof
|
|
1038
|
+
* @memberof CreateProgramOperatorRun200Response
|
|
1185
1039
|
*/
|
|
1186
1040
|
'id'?: string;
|
|
1187
1041
|
}
|
|
1188
1042
|
/**
|
|
1189
1043
|
*
|
|
1190
1044
|
* @export
|
|
1191
|
-
* @interface
|
|
1045
|
+
* @interface CreateProgramOperatorRunRequest
|
|
1192
1046
|
*/
|
|
1193
|
-
export interface
|
|
1047
|
+
export interface CreateProgramOperatorRunRequest {
|
|
1194
1048
|
/**
|
|
1195
1049
|
* The identifier of the program stored in the program library.
|
|
1196
1050
|
* @type {string}
|
|
1197
|
-
* @memberof
|
|
1051
|
+
* @memberof CreateProgramOperatorRunRequest
|
|
1198
1052
|
*/
|
|
1199
1053
|
'program_id': string;
|
|
1200
1054
|
}
|
|
@@ -1237,16 +1091,11 @@ export interface CreateTriggerRequest {
|
|
|
1237
1091
|
'type': TriggerType;
|
|
1238
1092
|
/**
|
|
1239
1093
|
*
|
|
1240
|
-
* @type {
|
|
1094
|
+
* @type {OpcuaNodeValueTriggerConfig}
|
|
1241
1095
|
* @memberof CreateTriggerRequest
|
|
1242
1096
|
*/
|
|
1243
|
-
'config'?:
|
|
1097
|
+
'config'?: OpcuaNodeValueTriggerConfig;
|
|
1244
1098
|
}
|
|
1245
|
-
/**
|
|
1246
|
-
* @type CreateTriggerRequestConfig
|
|
1247
|
-
* @export
|
|
1248
|
-
*/
|
|
1249
|
-
export type CreateTriggerRequestConfig = OpcuaNodeValueTriggerConfig;
|
|
1250
1099
|
/**
|
|
1251
1100
|
*
|
|
1252
1101
|
* @export
|
|
@@ -1407,31 +1256,6 @@ export type ExecuteTrajectoryRequest = InitializeMovementRequest | PauseMovement
|
|
|
1407
1256
|
* @export
|
|
1408
1257
|
*/
|
|
1409
1258
|
export type ExecuteTrajectoryResponse = InitializeMovementResponse | Movement | MovementError | PauseMovementResponse | PlaybackSpeedResponse | Standstill;
|
|
1410
|
-
/**
|
|
1411
|
-
* The ExecutionResult object contains the execution results of a robot. Arguments: motion_group_id: The unique identifier of the motion group motion_duration: The total execution duration of the motion group paths: The paths of the motion group as list of Path objects
|
|
1412
|
-
* @export
|
|
1413
|
-
* @interface ExecutionResult
|
|
1414
|
-
*/
|
|
1415
|
-
export interface ExecutionResult {
|
|
1416
|
-
/**
|
|
1417
|
-
*
|
|
1418
|
-
* @type {string}
|
|
1419
|
-
* @memberof ExecutionResult
|
|
1420
|
-
*/
|
|
1421
|
-
'motion_group_id': string;
|
|
1422
|
-
/**
|
|
1423
|
-
*
|
|
1424
|
-
* @type {number}
|
|
1425
|
-
* @memberof ExecutionResult
|
|
1426
|
-
*/
|
|
1427
|
-
'motion_duration': number;
|
|
1428
|
-
/**
|
|
1429
|
-
*
|
|
1430
|
-
* @type {Array<Path>}
|
|
1431
|
-
* @memberof ExecutionResult
|
|
1432
|
-
*/
|
|
1433
|
-
'paths': Array<Path>;
|
|
1434
|
-
}
|
|
1435
1259
|
/**
|
|
1436
1260
|
* A datapoint inside external joint stream.
|
|
1437
1261
|
* @export
|
|
@@ -1758,13 +1582,13 @@ export interface Geometry {
|
|
|
1758
1582
|
/**
|
|
1759
1583
|
*
|
|
1760
1584
|
* @export
|
|
1761
|
-
* @interface
|
|
1585
|
+
* @interface GetAllProgramOperatorRuns200Response
|
|
1762
1586
|
*/
|
|
1763
|
-
export interface
|
|
1587
|
+
export interface GetAllProgramOperatorRuns200Response {
|
|
1764
1588
|
/**
|
|
1765
1589
|
*
|
|
1766
1590
|
* @type {Array<ProgramRunObject>}
|
|
1767
|
-
* @memberof
|
|
1591
|
+
* @memberof GetAllProgramOperatorRuns200Response
|
|
1768
1592
|
*/
|
|
1769
1593
|
'program_runs'?: Array<ProgramRunObject>;
|
|
1770
1594
|
}
|
|
@@ -1807,6 +1631,19 @@ export interface HTTPValidationError {
|
|
|
1807
1631
|
*/
|
|
1808
1632
|
'detail'?: Array<ValidationError>;
|
|
1809
1633
|
}
|
|
1634
|
+
/**
|
|
1635
|
+
*
|
|
1636
|
+
* @export
|
|
1637
|
+
* @interface HTTPValidationError2
|
|
1638
|
+
*/
|
|
1639
|
+
export interface HTTPValidationError2 {
|
|
1640
|
+
/**
|
|
1641
|
+
*
|
|
1642
|
+
* @type {Array<ValidationError2>}
|
|
1643
|
+
* @memberof HTTPValidationError2
|
|
1644
|
+
*/
|
|
1645
|
+
'detail'?: Array<ValidationError2>;
|
|
1646
|
+
}
|
|
1810
1647
|
/**
|
|
1811
1648
|
* Input/Output boolean value representation.
|
|
1812
1649
|
* @export
|
|
@@ -3291,6 +3128,7 @@ export declare const MotionGroupModel: {
|
|
|
3291
3128
|
readonly FanucArcMate50iD: "FANUC_ARC_Mate_50iD";
|
|
3292
3129
|
readonly FanucArcMate50iD7L: "FANUC_ARC_Mate_50iD7L";
|
|
3293
3130
|
readonly FanucArcMate100iD: "FANUC_ARC_Mate_100iD";
|
|
3131
|
+
readonly FanucArcMate100iD16S: "FANUC_ARC_Mate_100iD16S";
|
|
3294
3132
|
readonly FanucArcMate100iD8L: "FANUC_ARC_Mate_100iD8L";
|
|
3295
3133
|
readonly FanucArcMate100iD10L: "FANUC_ARC_Mate_100iD10L";
|
|
3296
3134
|
readonly FanucArcMate120iD: "FANUC_ARC_Mate_120iD";
|
|
@@ -3354,12 +3192,13 @@ export declare const MotionGroupModel: {
|
|
|
3354
3192
|
readonly YaskawaTurn1: "Yaskawa_TURN1";
|
|
3355
3193
|
readonly YaskawaTurn2: "Yaskawa_TURN2";
|
|
3356
3194
|
readonly YaskawaTurn3: "Yaskawa_TURN3";
|
|
3357
|
-
readonly
|
|
3195
|
+
readonly KukaKr150R2: "KUKA_KR150_R2";
|
|
3358
3196
|
readonly KukaKr4R600: "KUKA_KR4_R600";
|
|
3359
3197
|
readonly KukaKr6R700: "KUKA_KR6_R700";
|
|
3360
3198
|
readonly KukaKr6R7002: "KUKA_KR6_R700_2";
|
|
3361
3199
|
readonly KukaKr6R900: "KUKA_KR6_R900";
|
|
3362
3200
|
readonly KukaKr6R9002: "KUKA_KR6_R900_2";
|
|
3201
|
+
readonly KukaKr6R1820: "KUKA_KR6_R1820";
|
|
3363
3202
|
readonly KukaKr10R900: "KUKA_KR10_R900";
|
|
3364
3203
|
readonly KukaKr10R9002: "KUKA_KR10_R900_2";
|
|
3365
3204
|
readonly KukaKr10R1100: "KUKA_KR10_R1100";
|
|
@@ -3371,6 +3210,7 @@ export declare const MotionGroupModel: {
|
|
|
3371
3210
|
readonly KukaKr16R20102: "KUKA_KR16_R2010_2";
|
|
3372
3211
|
readonly KukaKr20R1810: "KUKA_KR20_R1810";
|
|
3373
3212
|
readonly KukaKr20R18102: "KUKA_KR20_R1810_2";
|
|
3213
|
+
readonly KukaKr30R3: "KUKA_KR30_R3";
|
|
3374
3214
|
readonly KukaKr50R2500: "KUKA_KR50_R2500";
|
|
3375
3215
|
readonly KukaKr120R2700: "KUKA_KR120_R2700";
|
|
3376
3216
|
readonly KukaKr120R27002: "KUKA_KR120_R2700_2";
|
|
@@ -3724,12 +3564,11 @@ export interface OpcuaNodeValueTriggerConfig {
|
|
|
3724
3564
|
'node_value': OpcuaNodeValueTriggerConfigNodeValue;
|
|
3725
3565
|
}
|
|
3726
3566
|
/**
|
|
3567
|
+
* @type OpcuaNodeValueTriggerConfigNodeValue
|
|
3727
3568
|
* Value to trigger the program when matched.
|
|
3728
3569
|
* @export
|
|
3729
|
-
* @interface OpcuaNodeValueTriggerConfigNodeValue
|
|
3730
3570
|
*/
|
|
3731
|
-
export
|
|
3732
|
-
}
|
|
3571
|
+
export type OpcuaNodeValueTriggerConfigNodeValue = boolean | number | string;
|
|
3733
3572
|
/**
|
|
3734
3573
|
* The operating state.
|
|
3735
3574
|
* @export
|
|
@@ -3841,19 +3680,6 @@ export declare const OrientationType: {
|
|
|
3841
3680
|
readonly EulerAnglesExtrinsicZxy: "EULER_ANGLES_EXTRINSIC_ZXY";
|
|
3842
3681
|
};
|
|
3843
3682
|
export type OrientationType = typeof OrientationType[keyof typeof OrientationType];
|
|
3844
|
-
/**
|
|
3845
|
-
*
|
|
3846
|
-
* @export
|
|
3847
|
-
* @interface Path
|
|
3848
|
-
*/
|
|
3849
|
-
export interface Path {
|
|
3850
|
-
/**
|
|
3851
|
-
*
|
|
3852
|
-
* @type {Array<RobotState>}
|
|
3853
|
-
* @memberof Path
|
|
3854
|
-
*/
|
|
3855
|
-
'poses'?: Array<RobotState>;
|
|
3856
|
-
}
|
|
3857
3683
|
/**
|
|
3858
3684
|
* A cartesian point-to-point is representing a joint point-to-point motion from start point to the indicated target pose. The target pose is a joint point-to-point given in cartesian space. The target joint configuration will be calculated to be in the same kinematic configuration as the start point is. If that is not possible, planning will fail.
|
|
3859
3685
|
* @export
|
|
@@ -4350,19 +4176,6 @@ export interface PlaybackSpeedResponsePlaybackSpeedResponse {
|
|
|
4350
4176
|
*/
|
|
4351
4177
|
'requested_value': number;
|
|
4352
4178
|
}
|
|
4353
|
-
/**
|
|
4354
|
-
*
|
|
4355
|
-
* @export
|
|
4356
|
-
* @interface PointCloud
|
|
4357
|
-
*/
|
|
4358
|
-
export interface PointCloud {
|
|
4359
|
-
/**
|
|
4360
|
-
*
|
|
4361
|
-
* @type {string}
|
|
4362
|
-
* @memberof PointCloud
|
|
4363
|
-
*/
|
|
4364
|
-
'pointcloud': string;
|
|
4365
|
-
}
|
|
4366
4179
|
/**
|
|
4367
4180
|
* Defines a pose in 3D space. A pose is a combination of a position and an orientation. The position is applied before the orientation.
|
|
4368
4181
|
* @export
|
|
@@ -4410,71 +4223,100 @@ export interface PoseInCoordinateSystem {
|
|
|
4410
4223
|
/**
|
|
4411
4224
|
*
|
|
4412
4225
|
* @export
|
|
4226
|
+
* @interface ProgramRequest
|
|
4227
|
+
*/
|
|
4228
|
+
export interface ProgramRequest {
|
|
4229
|
+
/**
|
|
4230
|
+
*
|
|
4231
|
+
* @type {string}
|
|
4232
|
+
* @memberof ProgramRequest
|
|
4233
|
+
*/
|
|
4234
|
+
'program': string;
|
|
4235
|
+
/**
|
|
4236
|
+
* Identifier of the default robot to use for execution
|
|
4237
|
+
* @type {string}
|
|
4238
|
+
* @memberof ProgramRequest
|
|
4239
|
+
*/
|
|
4240
|
+
'default_robot'?: string;
|
|
4241
|
+
/**
|
|
4242
|
+
* Identifier of the default TCP to use for execution
|
|
4243
|
+
* @type {string}
|
|
4244
|
+
* @memberof ProgramRequest
|
|
4245
|
+
*/
|
|
4246
|
+
'default_tcp'?: string;
|
|
4247
|
+
/**
|
|
4248
|
+
* Initial arguments that are available within the program
|
|
4249
|
+
* @type {object}
|
|
4250
|
+
* @memberof ProgramRequest
|
|
4251
|
+
*/
|
|
4252
|
+
'run_args'?: object;
|
|
4253
|
+
}
|
|
4254
|
+
/**
|
|
4255
|
+
* Holds the state of a program run.
|
|
4256
|
+
* @export
|
|
4413
4257
|
* @interface ProgramRun
|
|
4414
4258
|
*/
|
|
4415
4259
|
export interface ProgramRun {
|
|
4416
4260
|
/**
|
|
4417
|
-
*
|
|
4261
|
+
* Unique identifier of the program run
|
|
4418
4262
|
* @type {string}
|
|
4419
4263
|
* @memberof ProgramRun
|
|
4420
4264
|
*/
|
|
4421
4265
|
'id': string;
|
|
4422
4266
|
/**
|
|
4423
|
-
*
|
|
4267
|
+
* State of the program run
|
|
4424
4268
|
* @type {ProgramRunState}
|
|
4425
4269
|
* @memberof ProgramRun
|
|
4426
4270
|
*/
|
|
4427
4271
|
'state': ProgramRunState;
|
|
4428
4272
|
/**
|
|
4429
|
-
*
|
|
4273
|
+
* Logs of the program run
|
|
4430
4274
|
* @type {string}
|
|
4431
4275
|
* @memberof ProgramRun
|
|
4432
4276
|
*/
|
|
4433
4277
|
'logs'?: string;
|
|
4434
4278
|
/**
|
|
4435
|
-
*
|
|
4279
|
+
* Stdout of the program run
|
|
4436
4280
|
* @type {string}
|
|
4437
4281
|
* @memberof ProgramRun
|
|
4438
4282
|
*/
|
|
4439
4283
|
'stdout'?: string;
|
|
4440
4284
|
/**
|
|
4441
|
-
*
|
|
4442
|
-
* @type {
|
|
4285
|
+
* Stores runtime variables of the run
|
|
4286
|
+
* @type {object}
|
|
4443
4287
|
* @memberof ProgramRun
|
|
4444
4288
|
*/
|
|
4445
|
-
'store'?:
|
|
4446
|
-
[key: string]: StoreValue;
|
|
4447
|
-
};
|
|
4289
|
+
'store'?: object;
|
|
4448
4290
|
/**
|
|
4449
|
-
*
|
|
4291
|
+
* Error message of the program run, if any
|
|
4450
4292
|
* @type {string}
|
|
4451
4293
|
* @memberof ProgramRun
|
|
4452
4294
|
*/
|
|
4453
|
-
'error'?: string
|
|
4295
|
+
'error'?: string;
|
|
4454
4296
|
/**
|
|
4455
|
-
*
|
|
4297
|
+
* Traceback of the program run, if any
|
|
4456
4298
|
* @type {string}
|
|
4457
4299
|
* @memberof ProgramRun
|
|
4458
4300
|
*/
|
|
4459
|
-
'traceback'?: string
|
|
4301
|
+
'traceback'?: string;
|
|
4460
4302
|
/**
|
|
4461
|
-
*
|
|
4303
|
+
* Start time of the program run
|
|
4462
4304
|
* @type {number}
|
|
4463
4305
|
* @memberof ProgramRun
|
|
4464
4306
|
*/
|
|
4465
|
-
'start_time'?: number
|
|
4307
|
+
'start_time'?: number;
|
|
4466
4308
|
/**
|
|
4467
|
-
*
|
|
4309
|
+
* End time of the program run
|
|
4468
4310
|
* @type {number}
|
|
4469
4311
|
* @memberof ProgramRun
|
|
4470
4312
|
*/
|
|
4471
|
-
'end_time'?: number
|
|
4313
|
+
'end_time'?: number;
|
|
4472
4314
|
/**
|
|
4473
|
-
*
|
|
4474
|
-
* @type {Array<
|
|
4315
|
+
* Execution results of the program run
|
|
4316
|
+
* @type {Array<ProgramRunResult>}
|
|
4475
4317
|
* @memberof ProgramRun
|
|
4476
4318
|
*/
|
|
4477
|
-
'execution_results'?: Array<
|
|
4319
|
+
'execution_results'?: Array<ProgramRunResult>;
|
|
4478
4320
|
}
|
|
4479
4321
|
/**
|
|
4480
4322
|
*
|
|
@@ -4522,93 +4364,60 @@ export interface ProgramRunObject {
|
|
|
4522
4364
|
/**
|
|
4523
4365
|
*
|
|
4524
4366
|
* @export
|
|
4525
|
-
* @
|
|
4526
|
-
*/
|
|
4527
|
-
export declare const ProgramRunState: {
|
|
4528
|
-
readonly NotStarted: "not started";
|
|
4529
|
-
readonly Running: "running";
|
|
4530
|
-
readonly Completed: "completed";
|
|
4531
|
-
readonly Failed: "failed";
|
|
4532
|
-
readonly Stopped: "stopped";
|
|
4533
|
-
};
|
|
4534
|
-
export type ProgramRunState = typeof ProgramRunState[keyof typeof ProgramRunState];
|
|
4535
|
-
/**
|
|
4536
|
-
*
|
|
4537
|
-
* @export
|
|
4538
|
-
* @interface ProgramRunnerReference
|
|
4367
|
+
* @interface ProgramRunReference
|
|
4539
4368
|
*/
|
|
4540
|
-
export interface
|
|
4369
|
+
export interface ProgramRunReference {
|
|
4541
4370
|
/**
|
|
4542
4371
|
*
|
|
4543
4372
|
* @type {string}
|
|
4544
|
-
* @memberof
|
|
4373
|
+
* @memberof ProgramRunReference
|
|
4545
4374
|
*/
|
|
4546
4375
|
'id': string;
|
|
4547
4376
|
/**
|
|
4548
4377
|
*
|
|
4549
4378
|
* @type {ProgramRunState}
|
|
4550
|
-
* @memberof
|
|
4379
|
+
* @memberof ProgramRunReference
|
|
4551
4380
|
*/
|
|
4552
4381
|
'state': ProgramRunState;
|
|
4553
4382
|
}
|
|
4554
4383
|
/**
|
|
4555
|
-
*
|
|
4384
|
+
* The ProgramRunResult object contains the execution results of a robot. Arguments: motion_group_id: The unique identifier of the motion group motion_duration: The total execution duration of the motion group paths: The paths of the motion group as list of Path objects
|
|
4556
4385
|
* @export
|
|
4557
|
-
* @interface
|
|
4386
|
+
* @interface ProgramRunResult
|
|
4558
4387
|
*/
|
|
4559
|
-
export interface
|
|
4388
|
+
export interface ProgramRunResult {
|
|
4560
4389
|
/**
|
|
4561
|
-
*
|
|
4562
|
-
* @type {
|
|
4563
|
-
* @memberof
|
|
4564
|
-
*/
|
|
4565
|
-
'position': Array<any>;
|
|
4566
|
-
/**
|
|
4567
|
-
*
|
|
4568
|
-
* @type {Array<any>}
|
|
4569
|
-
* @memberof PyjectoryDatatypesCorePose
|
|
4390
|
+
* Unique identifier of the motion group that was executed
|
|
4391
|
+
* @type {string}
|
|
4392
|
+
* @memberof ProgramRunResult
|
|
4570
4393
|
*/
|
|
4571
|
-
'
|
|
4572
|
-
}
|
|
4573
|
-
/**
|
|
4574
|
-
* Rotation vector, defined in [rx, ry, rz] with floating numbers. The rotation is represented in vector3 using an axis-angle representation: axis.normalized * angle (angle in radians). Must be defined for the first pose of a path. If not defined for the rest of the path, the previous orientation will be used.
|
|
4575
|
-
* @export
|
|
4576
|
-
* @interface PyjectoryDatatypesSerializerOrientation
|
|
4577
|
-
*/
|
|
4578
|
-
export interface PyjectoryDatatypesSerializerOrientation {
|
|
4394
|
+
'motion_group_id': string;
|
|
4579
4395
|
/**
|
|
4580
|
-
*
|
|
4581
|
-
* @type {
|
|
4582
|
-
* @memberof
|
|
4396
|
+
* Total execution duration of the motion group
|
|
4397
|
+
* @type {number}
|
|
4398
|
+
* @memberof ProgramRunResult
|
|
4583
4399
|
*/
|
|
4584
|
-
'
|
|
4585
|
-
}
|
|
4586
|
-
/**
|
|
4587
|
-
* Object\'s position and orientaton, defined in [x, y, z, rx, ry, rz]. x,y,z are defined in millimeters. rx,ry,rz are defined in radians.
|
|
4588
|
-
* @export
|
|
4589
|
-
* @interface PyjectoryDatatypesSerializerPose
|
|
4590
|
-
*/
|
|
4591
|
-
export interface PyjectoryDatatypesSerializerPose {
|
|
4400
|
+
'motion_duration': number;
|
|
4592
4401
|
/**
|
|
4593
|
-
*
|
|
4594
|
-
* @type {Array<
|
|
4595
|
-
* @memberof
|
|
4402
|
+
* Paths of the motion group as list of Path objects
|
|
4403
|
+
* @type {Array<Array<RobotState>>}
|
|
4404
|
+
* @memberof ProgramRunResult
|
|
4596
4405
|
*/
|
|
4597
|
-
'
|
|
4406
|
+
'paths': Array<Array<RobotState>>;
|
|
4598
4407
|
}
|
|
4599
4408
|
/**
|
|
4600
|
-
*
|
|
4409
|
+
*
|
|
4601
4410
|
* @export
|
|
4602
|
-
* @
|
|
4411
|
+
* @enum {string}
|
|
4603
4412
|
*/
|
|
4604
|
-
export
|
|
4605
|
-
|
|
4606
|
-
|
|
4607
|
-
|
|
4608
|
-
|
|
4609
|
-
|
|
4610
|
-
|
|
4611
|
-
|
|
4413
|
+
export declare const ProgramRunState: {
|
|
4414
|
+
readonly NotStarted: "not started";
|
|
4415
|
+
readonly Running: "running";
|
|
4416
|
+
readonly Completed: "completed";
|
|
4417
|
+
readonly Failed: "failed";
|
|
4418
|
+
readonly Stopped: "stopped";
|
|
4419
|
+
};
|
|
4420
|
+
export type ProgramRunState = typeof ProgramRunState[keyof typeof ProgramRunState];
|
|
4612
4421
|
/**
|
|
4613
4422
|
* Defines an x-y plane with finite size.
|
|
4614
4423
|
* @export
|
|
@@ -4727,48 +4536,6 @@ export declare const ReleaseChannel: {
|
|
|
4727
4536
|
readonly Next: "next";
|
|
4728
4537
|
};
|
|
4729
4538
|
export type ReleaseChannel = typeof ReleaseChannel[keyof typeof ReleaseChannel];
|
|
4730
|
-
/**
|
|
4731
|
-
* Wandelscript code string which describes a Program as text/plain
|
|
4732
|
-
* @export
|
|
4733
|
-
* @interface Request
|
|
4734
|
-
*/
|
|
4735
|
-
export interface Request {
|
|
4736
|
-
/**
|
|
4737
|
-
* Wandelscript code string which describes a Wandelscript Program as content/json.
|
|
4738
|
-
* @type {string}
|
|
4739
|
-
* @memberof Request
|
|
4740
|
-
*/
|
|
4741
|
-
'code': string;
|
|
4742
|
-
/**
|
|
4743
|
-
*
|
|
4744
|
-
* @type {{ [key: string]: ArrayInputArrayInner; }}
|
|
4745
|
-
* @memberof Request
|
|
4746
|
-
*/
|
|
4747
|
-
'initial_state'?: {
|
|
4748
|
-
[key: string]: ArrayInputArrayInner;
|
|
4749
|
-
};
|
|
4750
|
-
}
|
|
4751
|
-
/**
|
|
4752
|
-
* Wandelscript code string which describes a program
|
|
4753
|
-
* @export
|
|
4754
|
-
* @interface Request1
|
|
4755
|
-
*/
|
|
4756
|
-
export interface Request1 {
|
|
4757
|
-
/**
|
|
4758
|
-
* Wandelscript code string which describes a Wandelscript Program as content/json.
|
|
4759
|
-
* @type {string}
|
|
4760
|
-
* @memberof Request1
|
|
4761
|
-
*/
|
|
4762
|
-
'code': string;
|
|
4763
|
-
/**
|
|
4764
|
-
*
|
|
4765
|
-
* @type {{ [key: string]: ArrayInputArrayInner; }}
|
|
4766
|
-
* @memberof Request1
|
|
4767
|
-
*/
|
|
4768
|
-
'initial_state'?: {
|
|
4769
|
-
[key: string]: ArrayInputArrayInner;
|
|
4770
|
-
};
|
|
4771
|
-
}
|
|
4772
4539
|
/**
|
|
4773
4540
|
* The configuration of a physical or virtual robot controller.
|
|
4774
4541
|
* @export
|
|
@@ -4856,23 +4623,23 @@ export interface RobotLinkGeometry {
|
|
|
4856
4623
|
'geometry': Geometry;
|
|
4857
4624
|
}
|
|
4858
4625
|
/**
|
|
4859
|
-
* Collection of information on the current state of the robot
|
|
4626
|
+
* Collection of information on the current state of the robot.
|
|
4860
4627
|
* @export
|
|
4861
4628
|
* @interface RobotState
|
|
4862
4629
|
*/
|
|
4863
4630
|
export interface RobotState {
|
|
4864
4631
|
/**
|
|
4865
4632
|
*
|
|
4866
|
-
* @type {
|
|
4633
|
+
* @type {Pose}
|
|
4867
4634
|
* @memberof RobotState
|
|
4868
4635
|
*/
|
|
4869
|
-
'pose':
|
|
4636
|
+
'pose': Pose;
|
|
4870
4637
|
/**
|
|
4871
4638
|
*
|
|
4872
4639
|
* @type {Array<number>}
|
|
4873
4640
|
* @memberof RobotState
|
|
4874
4641
|
*/
|
|
4875
|
-
'joints'?: Array<number
|
|
4642
|
+
'joints'?: Array<number>;
|
|
4876
4643
|
}
|
|
4877
4644
|
/**
|
|
4878
4645
|
* The system mode of the robot system. ### ROBOT_SYSTEM_MODE_UNDEFINED Indicates that the robot controller is currently performing a mode transition. ### ROBOT_SYSTEM_MODE_DISCONNECT There is no communication with the robot controller at all. All connections are closed. No command is sent to the robot controller while in this mode. No input/output interaction is possible in this mode! All move requests will be rejected in this mode! ### ROBOT_SYSTEM_MODE_MONITOR A connection to the robot controller is established to only read the robot controller state. No command is sent to the robot controller while in this mode. It is possible to receive input/output information. All move requests will be rejected in this mode! ### ROBOT_SYSTEM_MODE_CONTROL An active connection is established with the robot controller and the robot system is cyclic commanded to stay in its actual position. The robot controller state is received in the cycle time of the robot controller. Requests via the MotionService and JoggingService will be processed and executed in this mode. Input/Output interaction is possible in this mode! **In this mode the robot system can be commanded to move.** ### ROBOT_SYSTEM_MODE_FREE_DRIVE Like ROBOT_SYSTEM_MODE_MONITOR a connection to the robot controller is established to only read the robot controller state. The difference is that the motion groups can be moved by the user (Free Drive). Thus, the servo motors are turned on. All move requests will be rejected in this mode! **This mode is not supported by every robot!** Use [getSupportedModes](getSupportedModes) to evaluate if the device support free drive.
|
|
@@ -5134,6 +4901,18 @@ export interface SafetyZoneLimits {
|
|
|
5134
4901
|
*/
|
|
5135
4902
|
'limits': PlanningLimits;
|
|
5136
4903
|
}
|
|
4904
|
+
/**
|
|
4905
|
+
*
|
|
4906
|
+
* @export
|
|
4907
|
+
* @enum {string}
|
|
4908
|
+
*/
|
|
4909
|
+
export declare const ServiceGroup: {
|
|
4910
|
+
readonly SystemService: "SystemService";
|
|
4911
|
+
readonly CellService: "CellService";
|
|
4912
|
+
readonly RobotController: "RobotController";
|
|
4913
|
+
readonly App: "App";
|
|
4914
|
+
};
|
|
4915
|
+
export type ServiceGroup = typeof ServiceGroup[keyof typeof ServiceGroup];
|
|
5137
4916
|
/**
|
|
5138
4917
|
*
|
|
5139
4918
|
* @export
|
|
@@ -5146,6 +4925,12 @@ export interface ServiceStatus {
|
|
|
5146
4925
|
* @memberof ServiceStatus
|
|
5147
4926
|
*/
|
|
5148
4927
|
'service': string;
|
|
4928
|
+
/**
|
|
4929
|
+
*
|
|
4930
|
+
* @type {ServiceGroup}
|
|
4931
|
+
* @memberof ServiceStatus
|
|
4932
|
+
*/
|
|
4933
|
+
'group': ServiceGroup;
|
|
5149
4934
|
/**
|
|
5150
4935
|
*
|
|
5151
4936
|
* @type {ServiceStatusStatus}
|
|
@@ -5432,49 +5217,6 @@ export interface StartOnIO {
|
|
|
5432
5217
|
*/
|
|
5433
5218
|
'comparator': Comparator;
|
|
5434
5219
|
}
|
|
5435
|
-
/**
|
|
5436
|
-
*
|
|
5437
|
-
* @export
|
|
5438
|
-
* @interface StoreValue
|
|
5439
|
-
*/
|
|
5440
|
-
export interface StoreValue {
|
|
5441
|
-
/**
|
|
5442
|
-
*
|
|
5443
|
-
* @type {Array<any>}
|
|
5444
|
-
* @memberof StoreValue
|
|
5445
|
-
*/
|
|
5446
|
-
'pose': Array<any>;
|
|
5447
|
-
/**
|
|
5448
|
-
*
|
|
5449
|
-
* @type {Array<any>}
|
|
5450
|
-
* @memberof StoreValue
|
|
5451
|
-
*/
|
|
5452
|
-
'position': Array<any>;
|
|
5453
|
-
/**
|
|
5454
|
-
*
|
|
5455
|
-
* @type {Array<any>}
|
|
5456
|
-
* @memberof StoreValue
|
|
5457
|
-
*/
|
|
5458
|
-
'orientation': Array<any>;
|
|
5459
|
-
/**
|
|
5460
|
-
*
|
|
5461
|
-
* @type {string}
|
|
5462
|
-
* @memberof StoreValue
|
|
5463
|
-
*/
|
|
5464
|
-
'image': string;
|
|
5465
|
-
/**
|
|
5466
|
-
*
|
|
5467
|
-
* @type {string}
|
|
5468
|
-
* @memberof StoreValue
|
|
5469
|
-
*/
|
|
5470
|
-
'pointcloud': string;
|
|
5471
|
-
/**
|
|
5472
|
-
*
|
|
5473
|
-
* @type {Array<ArrayOutputArrayInner>}
|
|
5474
|
-
* @memberof StoreValue
|
|
5475
|
-
*/
|
|
5476
|
-
'array': Array<ArrayOutputArrayInner>;
|
|
5477
|
-
}
|
|
5478
5220
|
/**
|
|
5479
5221
|
* Representing a robot pose in operational space aware of a configured TCP.
|
|
5480
5222
|
* @export
|
|
@@ -5648,6 +5390,12 @@ export interface TrajectoryData {
|
|
|
5648
5390
|
* @memberof TrajectoryData
|
|
5649
5391
|
*/
|
|
5650
5392
|
'message_type': TrajectoryDataMessageTypeEnum;
|
|
5393
|
+
/**
|
|
5394
|
+
* Identifier of the motion-group.
|
|
5395
|
+
* @type {string}
|
|
5396
|
+
* @memberof TrajectoryData
|
|
5397
|
+
*/
|
|
5398
|
+
'motion_group'?: string;
|
|
5651
5399
|
/**
|
|
5652
5400
|
* The trajectory consisting of a list of joint positions and an equal number of corresponding timestamps.
|
|
5653
5401
|
* @type {JointTrajectory}
|
|
@@ -5720,10 +5468,10 @@ export interface TriggerObject {
|
|
|
5720
5468
|
'type': TriggerType;
|
|
5721
5469
|
/**
|
|
5722
5470
|
*
|
|
5723
|
-
* @type {
|
|
5471
|
+
* @type {OpcuaNodeValueTriggerConfig}
|
|
5724
5472
|
* @memberof TriggerObject
|
|
5725
5473
|
*/
|
|
5726
|
-
'config':
|
|
5474
|
+
'config': OpcuaNodeValueTriggerConfig;
|
|
5727
5475
|
/**
|
|
5728
5476
|
* ISO 8601 date-time format when the trigger was created.
|
|
5729
5477
|
* @type {string}
|
|
@@ -5826,10 +5574,10 @@ export interface UpdateTriggerRequest {
|
|
|
5826
5574
|
'enabled'?: boolean;
|
|
5827
5575
|
/**
|
|
5828
5576
|
*
|
|
5829
|
-
* @type {
|
|
5577
|
+
* @type {OpcuaNodeValueTriggerConfig}
|
|
5830
5578
|
* @memberof UpdateTriggerRequest
|
|
5831
5579
|
*/
|
|
5832
|
-
'config'?:
|
|
5580
|
+
'config'?: OpcuaNodeValueTriggerConfig;
|
|
5833
5581
|
}
|
|
5834
5582
|
/**
|
|
5835
5583
|
*
|
|
@@ -5859,10 +5607,33 @@ export interface ValidationError {
|
|
|
5859
5607
|
/**
|
|
5860
5608
|
*
|
|
5861
5609
|
* @export
|
|
5862
|
-
* @interface
|
|
5610
|
+
* @interface ValidationError2
|
|
5863
5611
|
*/
|
|
5864
|
-
export interface
|
|
5612
|
+
export interface ValidationError2 {
|
|
5613
|
+
/**
|
|
5614
|
+
*
|
|
5615
|
+
* @type {Array<number>}
|
|
5616
|
+
* @memberof ValidationError2
|
|
5617
|
+
*/
|
|
5618
|
+
'loc': Array<number>;
|
|
5619
|
+
/**
|
|
5620
|
+
*
|
|
5621
|
+
* @type {string}
|
|
5622
|
+
* @memberof ValidationError2
|
|
5623
|
+
*/
|
|
5624
|
+
'msg': string;
|
|
5625
|
+
/**
|
|
5626
|
+
*
|
|
5627
|
+
* @type {string}
|
|
5628
|
+
* @memberof ValidationError2
|
|
5629
|
+
*/
|
|
5630
|
+
'type': string;
|
|
5865
5631
|
}
|
|
5632
|
+
/**
|
|
5633
|
+
* @type ValidationErrorLocInner
|
|
5634
|
+
* @export
|
|
5635
|
+
*/
|
|
5636
|
+
export type ValidationErrorLocInner = number | string;
|
|
5866
5637
|
/**
|
|
5867
5638
|
* A generic representation of a version number.
|
|
5868
5639
|
* @export
|
|
@@ -6000,6 +5771,7 @@ export declare const VirtualControllerTypes: {
|
|
|
6000
5771
|
readonly AbbIrb460025020: "abb-irb4600_250_20";
|
|
6001
5772
|
readonly AbbIrb460025540: "abb-irb4600_255_40";
|
|
6002
5773
|
readonly FanucArcMate100iD: "fanuc-arc_mate_100iD";
|
|
5774
|
+
readonly FanucArcMate100iD16S: "fanuc-arc_mate_100iD16S";
|
|
6003
5775
|
readonly FanucArcMate120iD: "fanuc-arc_mate_120iD";
|
|
6004
5776
|
readonly FanucArcMate120iD12L: "fanuc-arc_mate_120iD12L";
|
|
6005
5777
|
readonly FanucArcMate120iD35: "fanuc-arc_mate_120iD35";
|
|
@@ -6015,6 +5787,7 @@ export declare const VirtualControllerTypes: {
|
|
|
6015
5787
|
readonly FanucLrMate200iD4S: "fanuc-lr_mate_200iD4S";
|
|
6016
5788
|
readonly FanucLrMate200iD7L: "fanuc-lr_mate_200iD7L";
|
|
6017
5789
|
readonly FanucM10iD12: "fanuc-m10iD12";
|
|
5790
|
+
readonly FanucM10iD16S: "fanuc-m10iD16S";
|
|
6018
5791
|
readonly FanucM20iD25: "fanuc-m20iD25";
|
|
6019
5792
|
readonly FanucM20iD35: "fanuc-m20iD35";
|
|
6020
5793
|
readonly FanucM900iB280L: "fanuc-m900iB280L";
|
|
@@ -6027,7 +5800,7 @@ export declare const VirtualControllerTypes: {
|
|
|
6027
5800
|
readonly KukaKr10R9002: "kuka-kr10_r900_2";
|
|
6028
5801
|
readonly KukaKr120R27002: "kuka-kr120_r2700_2";
|
|
6029
5802
|
readonly KukaKr12R18102: "kuka-kr12_r1810_2";
|
|
6030
|
-
readonly
|
|
5803
|
+
readonly KukaKr150R2: "kuka-kr150_r2";
|
|
6031
5804
|
readonly KukaKr16R16102: "kuka-kr16_r1610_2";
|
|
6032
5805
|
readonly KukaKr16R20102: "kuka-kr16_r2010_2";
|
|
6033
5806
|
readonly KukaKr20R1810: "kuka-kr20_r1810";
|
|
@@ -6037,10 +5810,12 @@ export declare const VirtualControllerTypes: {
|
|
|
6037
5810
|
readonly KukaKr210R33002: "kuka-kr210_r3300_2";
|
|
6038
5811
|
readonly KukaKr240R2700: "kuka-kr240_r2700";
|
|
6039
5812
|
readonly KukaKr250R27002: "kuka-kr250_r2700_2";
|
|
5813
|
+
readonly KukaKr30R3: "kuka-kr30_r3";
|
|
6040
5814
|
readonly KukaKr360L2403: "kuka-kr360_l240_3";
|
|
6041
5815
|
readonly KukaKr4R600: "kuka-kr4_r600";
|
|
6042
5816
|
readonly KukaKr500L3403: "kuka-kr500_l340_3";
|
|
6043
5817
|
readonly KukaKr50R2500: "kuka-kr50_r2500";
|
|
5818
|
+
readonly KukaKr6R1820: "kuka-kr6_r1820";
|
|
6044
5819
|
readonly KukaKr6R7002: "kuka-kr6_r700_2";
|
|
6045
5820
|
readonly KukaKr6R700Sixx: "kuka-kr6_r700_sixx";
|
|
6046
5821
|
readonly KukaKr6R900: "kuka-kr6_r900";
|
|
@@ -6059,11 +5834,21 @@ export declare const VirtualControllerTypes: {
|
|
|
6059
5834
|
readonly YaskawaAr3120: "yaskawa-ar3120";
|
|
6060
5835
|
readonly YaskawaAr700: "yaskawa-ar700";
|
|
6061
5836
|
readonly YaskawaAr900: "yaskawa-ar900";
|
|
5837
|
+
readonly YaskawaGp110: "yaskawa-gp110";
|
|
6062
5838
|
readonly YaskawaGp12: "yaskawa-gp12";
|
|
5839
|
+
readonly YaskawaGp180: "yaskawa-gp180";
|
|
5840
|
+
readonly YaskawaGp180120: "yaskawa-gp180-120";
|
|
6063
5841
|
readonly YaskawaGp20hl: "yaskawa-gp20hl";
|
|
5842
|
+
readonly YaskawaGp215: "yaskawa-gp215";
|
|
5843
|
+
readonly YaskawaGp225: "yaskawa-gp225";
|
|
6064
5844
|
readonly YaskawaGp25: "yaskawa-gp25";
|
|
5845
|
+
readonly YaskawaGp250: "yaskawa-gp250";
|
|
6065
5846
|
readonly YaskawaGp2512: "yaskawa-gp25_12";
|
|
5847
|
+
readonly YaskawaGp280: "yaskawa-gp280";
|
|
5848
|
+
readonly YaskawaGp35L: "yaskawa-gp35L";
|
|
5849
|
+
readonly YaskawaGp400: "yaskawa-gp400";
|
|
6066
5850
|
readonly YaskawaGp50: "yaskawa-gp50";
|
|
5851
|
+
readonly YaskawaGp600: "yaskawa-gp600";
|
|
6067
5852
|
readonly YaskawaGp7: "yaskawa-gp7";
|
|
6068
5853
|
readonly YaskawaGp8: "yaskawa-gp8";
|
|
6069
5854
|
readonly YaskawaGp88: "yaskawa-gp88";
|
|
@@ -8694,76 +8479,75 @@ export declare class MotionGroupKinematicsApi extends BaseAPI {
|
|
|
8694
8479
|
*/
|
|
8695
8480
|
export declare const ProgramApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
8696
8481
|
/**
|
|
8697
|
-
* This endpoint accepts a program
|
|
8698
|
-
* @summary Create
|
|
8482
|
+
* This endpoint accepts a program and if desired, initial arguments (in the form of a dict). The program will be executed asynchronously. It returns a program run reference which can be used to query the state of the program run. ## Receiving state updates Receive state updates of the program run via polling the `/programs/runs/{run_id}/` ### Via polling You can receive updates about the state of the program run by polling the `/programs/runs/{run_id}/` endpoint.
|
|
8483
|
+
* @summary Create program run
|
|
8699
8484
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8700
|
-
* @param {
|
|
8485
|
+
* @param {ProgramRequest} programRequest
|
|
8701
8486
|
* @param {*} [options] Override http request option.
|
|
8702
8487
|
* @throws {RequiredError}
|
|
8703
8488
|
*/
|
|
8704
|
-
|
|
8489
|
+
createProgramRun: (cell: string, programRequest: ProgramRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
8705
8490
|
/**
|
|
8706
|
-
* Execute a program
|
|
8707
|
-
* @summary Execute
|
|
8491
|
+
* Execute a program synchronously. The execute operation will be started from the current joint configuration of any addressed robot(s). Addressed robots have to be in control mode for the execute operation to succeed. A request to this endpoint will block this endpoint until the program has been executed, or until an error occurs. The executed movement is returned in case of a successful execution. Otherwise an error (e.g. out of reach, singularity), is returned.
|
|
8492
|
+
* @summary Execute program
|
|
8708
8493
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8709
|
-
* @param {
|
|
8494
|
+
* @param {ProgramRequest} programRequest
|
|
8710
8495
|
* @param {*} [options] Override http request option.
|
|
8711
8496
|
* @throws {RequiredError}
|
|
8712
8497
|
*/
|
|
8713
|
-
executeProgram: (cell: string,
|
|
8498
|
+
executeProgram: (cell: string, programRequest: ProgramRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
8714
8499
|
/**
|
|
8715
|
-
* Returns information about a program currently executed.
|
|
8716
|
-
* @summary Get
|
|
8500
|
+
* Returns information about a program currently executed. When a program is finished: Program response, result, collected logs, .. When a program is running: Running status, current executed line, ...
|
|
8501
|
+
* @summary Get program run
|
|
8717
8502
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8718
|
-
* @param {string}
|
|
8503
|
+
* @param {string} run
|
|
8719
8504
|
* @param {*} [options] Override http request option.
|
|
8720
8505
|
* @throws {RequiredError}
|
|
8721
8506
|
*/
|
|
8722
|
-
|
|
8507
|
+
getProgramRun: (cell: string, run: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
8723
8508
|
/**
|
|
8724
|
-
* Get details about all existing
|
|
8725
|
-
* @summary List
|
|
8509
|
+
* Get details about all existing runs
|
|
8510
|
+
* @summary List programs
|
|
8726
8511
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8727
8512
|
* @param {*} [options] Override http request option.
|
|
8728
8513
|
* @throws {RequiredError}
|
|
8729
8514
|
*/
|
|
8730
|
-
|
|
8515
|
+
getProgramRuns: (cell: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
8731
8516
|
/**
|
|
8732
|
-
*
|
|
8733
|
-
* @summary
|
|
8517
|
+
* Simulate a program given as text/plain
|
|
8518
|
+
* @summary Simulate program
|
|
8734
8519
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8735
|
-
* @param {
|
|
8520
|
+
* @param {ProgramRequest} programRequest
|
|
8736
8521
|
* @param {*} [options] Override http request option.
|
|
8737
8522
|
* @throws {RequiredError}
|
|
8738
8523
|
*/
|
|
8739
|
-
|
|
8524
|
+
simulateProgram: (cell: string, programRequest: ProgramRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
8740
8525
|
/**
|
|
8741
|
-
*
|
|
8742
|
-
* @summary
|
|
8526
|
+
* Stop all runs
|
|
8527
|
+
* @summary Stop all programs
|
|
8743
8528
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8744
|
-
* @param {Request} request
|
|
8745
|
-
* @param {string} [identifier]
|
|
8746
8529
|
* @param {*} [options] Override http request option.
|
|
8747
8530
|
* @throws {RequiredError}
|
|
8748
8531
|
*/
|
|
8749
|
-
|
|
8532
|
+
stopAllPrograms: (cell: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
8750
8533
|
/**
|
|
8751
|
-
* Stop
|
|
8752
|
-
* @summary Stop
|
|
8534
|
+
* Stop a specific program run.
|
|
8535
|
+
* @summary Stop program run
|
|
8753
8536
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8537
|
+
* @param {string} run
|
|
8754
8538
|
* @param {*} [options] Override http request option.
|
|
8755
8539
|
* @throws {RequiredError}
|
|
8756
8540
|
*/
|
|
8757
|
-
|
|
8541
|
+
stopProgramRun: (cell: string, run: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
8758
8542
|
/**
|
|
8759
|
-
*
|
|
8760
|
-
* @summary
|
|
8543
|
+
* Validate a program
|
|
8544
|
+
* @summary Validate program
|
|
8761
8545
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8762
|
-
* @param {
|
|
8546
|
+
* @param {ProgramRequest} programRequest
|
|
8763
8547
|
* @param {*} [options] Override http request option.
|
|
8764
8548
|
* @throws {RequiredError}
|
|
8765
8549
|
*/
|
|
8766
|
-
|
|
8550
|
+
validateProgram: (cell: string, programRequest: ProgramRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
8767
8551
|
};
|
|
8768
8552
|
/**
|
|
8769
8553
|
* ProgramApi - functional programming interface
|
|
@@ -8771,76 +8555,75 @@ export declare const ProgramApiAxiosParamCreator: (configuration?: Configuration
|
|
|
8771
8555
|
*/
|
|
8772
8556
|
export declare const ProgramApiFp: (configuration?: Configuration) => {
|
|
8773
8557
|
/**
|
|
8774
|
-
* This endpoint accepts a program
|
|
8775
|
-
* @summary Create
|
|
8558
|
+
* This endpoint accepts a program and if desired, initial arguments (in the form of a dict). The program will be executed asynchronously. It returns a program run reference which can be used to query the state of the program run. ## Receiving state updates Receive state updates of the program run via polling the `/programs/runs/{run_id}/` ### Via polling You can receive updates about the state of the program run by polling the `/programs/runs/{run_id}/` endpoint.
|
|
8559
|
+
* @summary Create program run
|
|
8776
8560
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8777
|
-
* @param {
|
|
8561
|
+
* @param {ProgramRequest} programRequest
|
|
8778
8562
|
* @param {*} [options] Override http request option.
|
|
8779
8563
|
* @throws {RequiredError}
|
|
8780
8564
|
*/
|
|
8781
|
-
|
|
8565
|
+
createProgramRun(cell: string, programRequest: ProgramRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ProgramRunReference>>;
|
|
8782
8566
|
/**
|
|
8783
|
-
* Execute a program
|
|
8784
|
-
* @summary Execute
|
|
8567
|
+
* Execute a program synchronously. The execute operation will be started from the current joint configuration of any addressed robot(s). Addressed robots have to be in control mode for the execute operation to succeed. A request to this endpoint will block this endpoint until the program has been executed, or until an error occurs. The executed movement is returned in case of a successful execution. Otherwise an error (e.g. out of reach, singularity), is returned.
|
|
8568
|
+
* @summary Execute program
|
|
8785
8569
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8786
|
-
* @param {
|
|
8570
|
+
* @param {ProgramRequest} programRequest
|
|
8787
8571
|
* @param {*} [options] Override http request option.
|
|
8788
8572
|
* @throws {RequiredError}
|
|
8789
8573
|
*/
|
|
8790
|
-
executeProgram(cell: string,
|
|
8574
|
+
executeProgram(cell: string, programRequest: ProgramRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ProgramRun>>;
|
|
8791
8575
|
/**
|
|
8792
|
-
* Returns information about a program currently executed.
|
|
8793
|
-
* @summary Get
|
|
8576
|
+
* Returns information about a program currently executed. When a program is finished: Program response, result, collected logs, .. When a program is running: Running status, current executed line, ...
|
|
8577
|
+
* @summary Get program run
|
|
8794
8578
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8795
|
-
* @param {string}
|
|
8579
|
+
* @param {string} run
|
|
8796
8580
|
* @param {*} [options] Override http request option.
|
|
8797
8581
|
* @throws {RequiredError}
|
|
8798
8582
|
*/
|
|
8799
|
-
|
|
8583
|
+
getProgramRun(cell: string, run: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ProgramRun>>;
|
|
8800
8584
|
/**
|
|
8801
|
-
* Get details about all existing
|
|
8802
|
-
* @summary List
|
|
8585
|
+
* Get details about all existing runs
|
|
8586
|
+
* @summary List programs
|
|
8803
8587
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8804
8588
|
* @param {*} [options] Override http request option.
|
|
8805
8589
|
* @throws {RequiredError}
|
|
8806
8590
|
*/
|
|
8807
|
-
|
|
8591
|
+
getProgramRuns(cell: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<ProgramRunReference>>>;
|
|
8808
8592
|
/**
|
|
8809
|
-
*
|
|
8810
|
-
* @summary
|
|
8593
|
+
* Simulate a program given as text/plain
|
|
8594
|
+
* @summary Simulate program
|
|
8811
8595
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8812
|
-
* @param {
|
|
8596
|
+
* @param {ProgramRequest} programRequest
|
|
8813
8597
|
* @param {*} [options] Override http request option.
|
|
8814
8598
|
* @throws {RequiredError}
|
|
8815
8599
|
*/
|
|
8816
|
-
|
|
8600
|
+
simulateProgram(cell: string, programRequest: ProgramRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ProgramRun>>;
|
|
8817
8601
|
/**
|
|
8818
|
-
*
|
|
8819
|
-
* @summary
|
|
8602
|
+
* Stop all runs
|
|
8603
|
+
* @summary Stop all programs
|
|
8820
8604
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8821
|
-
* @param {Request} request
|
|
8822
|
-
* @param {string} [identifier]
|
|
8823
8605
|
* @param {*} [options] Override http request option.
|
|
8824
8606
|
* @throws {RequiredError}
|
|
8825
8607
|
*/
|
|
8826
|
-
|
|
8608
|
+
stopAllPrograms(cell: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
8827
8609
|
/**
|
|
8828
|
-
* Stop
|
|
8829
|
-
* @summary Stop
|
|
8610
|
+
* Stop a specific program run.
|
|
8611
|
+
* @summary Stop program run
|
|
8830
8612
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8613
|
+
* @param {string} run
|
|
8831
8614
|
* @param {*} [options] Override http request option.
|
|
8832
8615
|
* @throws {RequiredError}
|
|
8833
8616
|
*/
|
|
8834
|
-
|
|
8617
|
+
stopProgramRun(cell: string, run: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
8835
8618
|
/**
|
|
8836
|
-
*
|
|
8837
|
-
* @summary
|
|
8619
|
+
* Validate a program
|
|
8620
|
+
* @summary Validate program
|
|
8838
8621
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8839
|
-
* @param {
|
|
8622
|
+
* @param {ProgramRequest} programRequest
|
|
8840
8623
|
* @param {*} [options] Override http request option.
|
|
8841
8624
|
* @throws {RequiredError}
|
|
8842
8625
|
*/
|
|
8843
|
-
|
|
8626
|
+
validateProgram(cell: string, programRequest: ProgramRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
8844
8627
|
};
|
|
8845
8628
|
/**
|
|
8846
8629
|
* ProgramApi - factory interface
|
|
@@ -8848,76 +8631,75 @@ export declare const ProgramApiFp: (configuration?: Configuration) => {
|
|
|
8848
8631
|
*/
|
|
8849
8632
|
export declare const ProgramApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
8850
8633
|
/**
|
|
8851
|
-
* This endpoint accepts a program
|
|
8852
|
-
* @summary Create
|
|
8634
|
+
* This endpoint accepts a program and if desired, initial arguments (in the form of a dict). The program will be executed asynchronously. It returns a program run reference which can be used to query the state of the program run. ## Receiving state updates Receive state updates of the program run via polling the `/programs/runs/{run_id}/` ### Via polling You can receive updates about the state of the program run by polling the `/programs/runs/{run_id}/` endpoint.
|
|
8635
|
+
* @summary Create program run
|
|
8853
8636
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8854
|
-
* @param {
|
|
8637
|
+
* @param {ProgramRequest} programRequest
|
|
8855
8638
|
* @param {*} [options] Override http request option.
|
|
8856
8639
|
* @throws {RequiredError}
|
|
8857
8640
|
*/
|
|
8858
|
-
|
|
8641
|
+
createProgramRun(cell: string, programRequest: ProgramRequest, options?: RawAxiosRequestConfig): AxiosPromise<ProgramRunReference>;
|
|
8859
8642
|
/**
|
|
8860
|
-
* Execute a program
|
|
8861
|
-
* @summary Execute
|
|
8643
|
+
* Execute a program synchronously. The execute operation will be started from the current joint configuration of any addressed robot(s). Addressed robots have to be in control mode for the execute operation to succeed. A request to this endpoint will block this endpoint until the program has been executed, or until an error occurs. The executed movement is returned in case of a successful execution. Otherwise an error (e.g. out of reach, singularity), is returned.
|
|
8644
|
+
* @summary Execute program
|
|
8862
8645
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8863
|
-
* @param {
|
|
8646
|
+
* @param {ProgramRequest} programRequest
|
|
8864
8647
|
* @param {*} [options] Override http request option.
|
|
8865
8648
|
* @throws {RequiredError}
|
|
8866
8649
|
*/
|
|
8867
|
-
executeProgram(cell: string,
|
|
8650
|
+
executeProgram(cell: string, programRequest: ProgramRequest, options?: RawAxiosRequestConfig): AxiosPromise<ProgramRun>;
|
|
8868
8651
|
/**
|
|
8869
|
-
* Returns information about a program currently executed.
|
|
8870
|
-
* @summary Get
|
|
8652
|
+
* Returns information about a program currently executed. When a program is finished: Program response, result, collected logs, .. When a program is running: Running status, current executed line, ...
|
|
8653
|
+
* @summary Get program run
|
|
8871
8654
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8872
|
-
* @param {string}
|
|
8655
|
+
* @param {string} run
|
|
8873
8656
|
* @param {*} [options] Override http request option.
|
|
8874
8657
|
* @throws {RequiredError}
|
|
8875
8658
|
*/
|
|
8876
|
-
|
|
8659
|
+
getProgramRun(cell: string, run: string, options?: RawAxiosRequestConfig): AxiosPromise<ProgramRun>;
|
|
8877
8660
|
/**
|
|
8878
|
-
* Get details about all existing
|
|
8879
|
-
* @summary List
|
|
8661
|
+
* Get details about all existing runs
|
|
8662
|
+
* @summary List programs
|
|
8880
8663
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8881
8664
|
* @param {*} [options] Override http request option.
|
|
8882
8665
|
* @throws {RequiredError}
|
|
8883
8666
|
*/
|
|
8884
|
-
|
|
8667
|
+
getProgramRuns(cell: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<ProgramRunReference>>;
|
|
8885
8668
|
/**
|
|
8886
|
-
*
|
|
8887
|
-
* @summary
|
|
8669
|
+
* Simulate a program given as text/plain
|
|
8670
|
+
* @summary Simulate program
|
|
8888
8671
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8889
|
-
* @param {
|
|
8672
|
+
* @param {ProgramRequest} programRequest
|
|
8890
8673
|
* @param {*} [options] Override http request option.
|
|
8891
8674
|
* @throws {RequiredError}
|
|
8892
8675
|
*/
|
|
8893
|
-
|
|
8676
|
+
simulateProgram(cell: string, programRequest: ProgramRequest, options?: RawAxiosRequestConfig): AxiosPromise<ProgramRun>;
|
|
8894
8677
|
/**
|
|
8895
|
-
*
|
|
8896
|
-
* @summary
|
|
8678
|
+
* Stop all runs
|
|
8679
|
+
* @summary Stop all programs
|
|
8897
8680
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8898
|
-
* @param {Request} request
|
|
8899
|
-
* @param {string} [identifier]
|
|
8900
8681
|
* @param {*} [options] Override http request option.
|
|
8901
8682
|
* @throws {RequiredError}
|
|
8902
8683
|
*/
|
|
8903
|
-
|
|
8684
|
+
stopAllPrograms(cell: string, options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
8904
8685
|
/**
|
|
8905
|
-
* Stop
|
|
8906
|
-
* @summary Stop
|
|
8686
|
+
* Stop a specific program run.
|
|
8687
|
+
* @summary Stop program run
|
|
8907
8688
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8689
|
+
* @param {string} run
|
|
8908
8690
|
* @param {*} [options] Override http request option.
|
|
8909
8691
|
* @throws {RequiredError}
|
|
8910
8692
|
*/
|
|
8911
|
-
|
|
8693
|
+
stopProgramRun(cell: string, run: string, options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
8912
8694
|
/**
|
|
8913
|
-
*
|
|
8914
|
-
* @summary
|
|
8695
|
+
* Validate a program
|
|
8696
|
+
* @summary Validate program
|
|
8915
8697
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8916
|
-
* @param {
|
|
8698
|
+
* @param {ProgramRequest} programRequest
|
|
8917
8699
|
* @param {*} [options] Override http request option.
|
|
8918
8700
|
* @throws {RequiredError}
|
|
8919
8701
|
*/
|
|
8920
|
-
|
|
8702
|
+
validateProgram(cell: string, programRequest: ProgramRequest, options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
8921
8703
|
};
|
|
8922
8704
|
/**
|
|
8923
8705
|
* ProgramApi - object-oriented interface
|
|
@@ -8927,84 +8709,83 @@ export declare const ProgramApiFactory: (configuration?: Configuration, basePath
|
|
|
8927
8709
|
*/
|
|
8928
8710
|
export declare class ProgramApi extends BaseAPI {
|
|
8929
8711
|
/**
|
|
8930
|
-
* This endpoint accepts a program
|
|
8931
|
-
* @summary Create
|
|
8712
|
+
* This endpoint accepts a program and if desired, initial arguments (in the form of a dict). The program will be executed asynchronously. It returns a program run reference which can be used to query the state of the program run. ## Receiving state updates Receive state updates of the program run via polling the `/programs/runs/{run_id}/` ### Via polling You can receive updates about the state of the program run by polling the `/programs/runs/{run_id}/` endpoint.
|
|
8713
|
+
* @summary Create program run
|
|
8932
8714
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8933
|
-
* @param {
|
|
8715
|
+
* @param {ProgramRequest} programRequest
|
|
8934
8716
|
* @param {*} [options] Override http request option.
|
|
8935
8717
|
* @throws {RequiredError}
|
|
8936
8718
|
* @memberof ProgramApi
|
|
8937
8719
|
*/
|
|
8938
|
-
|
|
8720
|
+
createProgramRun(cell: string, programRequest: ProgramRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ProgramRunReference, any>>;
|
|
8939
8721
|
/**
|
|
8940
|
-
* Execute a program
|
|
8941
|
-
* @summary Execute
|
|
8722
|
+
* Execute a program synchronously. The execute operation will be started from the current joint configuration of any addressed robot(s). Addressed robots have to be in control mode for the execute operation to succeed. A request to this endpoint will block this endpoint until the program has been executed, or until an error occurs. The executed movement is returned in case of a successful execution. Otherwise an error (e.g. out of reach, singularity), is returned.
|
|
8723
|
+
* @summary Execute program
|
|
8942
8724
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8943
|
-
* @param {
|
|
8725
|
+
* @param {ProgramRequest} programRequest
|
|
8944
8726
|
* @param {*} [options] Override http request option.
|
|
8945
8727
|
* @throws {RequiredError}
|
|
8946
8728
|
* @memberof ProgramApi
|
|
8947
8729
|
*/
|
|
8948
|
-
executeProgram(cell: string,
|
|
8730
|
+
executeProgram(cell: string, programRequest: ProgramRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ProgramRun, any>>;
|
|
8949
8731
|
/**
|
|
8950
|
-
* Returns information about a program currently executed.
|
|
8951
|
-
* @summary Get
|
|
8732
|
+
* Returns information about a program currently executed. When a program is finished: Program response, result, collected logs, .. When a program is running: Running status, current executed line, ...
|
|
8733
|
+
* @summary Get program run
|
|
8952
8734
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8953
|
-
* @param {string}
|
|
8735
|
+
* @param {string} run
|
|
8954
8736
|
* @param {*} [options] Override http request option.
|
|
8955
8737
|
* @throws {RequiredError}
|
|
8956
8738
|
* @memberof ProgramApi
|
|
8957
8739
|
*/
|
|
8958
|
-
|
|
8740
|
+
getProgramRun(cell: string, run: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ProgramRun, any>>;
|
|
8959
8741
|
/**
|
|
8960
|
-
* Get details about all existing
|
|
8961
|
-
* @summary List
|
|
8742
|
+
* Get details about all existing runs
|
|
8743
|
+
* @summary List programs
|
|
8962
8744
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8963
8745
|
* @param {*} [options] Override http request option.
|
|
8964
8746
|
* @throws {RequiredError}
|
|
8965
8747
|
* @memberof ProgramApi
|
|
8966
8748
|
*/
|
|
8967
|
-
|
|
8749
|
+
getProgramRuns(cell: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ProgramRunReference[], any>>;
|
|
8968
8750
|
/**
|
|
8969
|
-
*
|
|
8970
|
-
* @summary
|
|
8751
|
+
* Simulate a program given as text/plain
|
|
8752
|
+
* @summary Simulate program
|
|
8971
8753
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8972
|
-
* @param {
|
|
8754
|
+
* @param {ProgramRequest} programRequest
|
|
8973
8755
|
* @param {*} [options] Override http request option.
|
|
8974
8756
|
* @throws {RequiredError}
|
|
8975
8757
|
* @memberof ProgramApi
|
|
8976
8758
|
*/
|
|
8977
|
-
|
|
8759
|
+
simulateProgram(cell: string, programRequest: ProgramRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ProgramRun, any>>;
|
|
8978
8760
|
/**
|
|
8979
|
-
*
|
|
8980
|
-
* @summary
|
|
8761
|
+
* Stop all runs
|
|
8762
|
+
* @summary Stop all programs
|
|
8981
8763
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8982
|
-
* @param {Request} request
|
|
8983
|
-
* @param {string} [identifier]
|
|
8984
8764
|
* @param {*} [options] Override http request option.
|
|
8985
8765
|
* @throws {RequiredError}
|
|
8986
8766
|
* @memberof ProgramApi
|
|
8987
8767
|
*/
|
|
8988
|
-
|
|
8768
|
+
stopAllPrograms(cell: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
8989
8769
|
/**
|
|
8990
|
-
* Stop
|
|
8991
|
-
* @summary Stop
|
|
8770
|
+
* Stop a specific program run.
|
|
8771
|
+
* @summary Stop program run
|
|
8992
8772
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8773
|
+
* @param {string} run
|
|
8993
8774
|
* @param {*} [options] Override http request option.
|
|
8994
8775
|
* @throws {RequiredError}
|
|
8995
8776
|
* @memberof ProgramApi
|
|
8996
8777
|
*/
|
|
8997
|
-
|
|
8778
|
+
stopProgramRun(cell: string, run: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
8998
8779
|
/**
|
|
8999
|
-
*
|
|
9000
|
-
* @summary
|
|
8780
|
+
* Validate a program
|
|
8781
|
+
* @summary Validate program
|
|
9001
8782
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
9002
|
-
* @param {
|
|
8783
|
+
* @param {ProgramRequest} programRequest
|
|
9003
8784
|
* @param {*} [options] Override http request option.
|
|
9004
8785
|
* @throws {RequiredError}
|
|
9005
8786
|
* @memberof ProgramApi
|
|
9006
8787
|
*/
|
|
9007
|
-
|
|
8788
|
+
validateProgram(cell: string, programRequest: ProgramRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
9008
8789
|
}
|
|
9009
8790
|
/**
|
|
9010
8791
|
* ProgramOperatorApi - axios parameter creator
|
|
@@ -9012,14 +8793,14 @@ export declare class ProgramApi extends BaseAPI {
|
|
|
9012
8793
|
*/
|
|
9013
8794
|
export declare const ProgramOperatorApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
9014
8795
|
/**
|
|
9015
|
-
* <!-- theme: danger -->
|
|
8796
|
+
* <!-- theme: danger --> > **Experimental** This endpoint initiates the execution of a program stored in the program library. A program is started with the a specific program identifier that exists in the program library.
|
|
9016
8797
|
* @summary Run Program from Library
|
|
9017
8798
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
9018
|
-
* @param {
|
|
8799
|
+
* @param {CreateProgramOperatorRunRequest} createProgramOperatorRunRequest
|
|
9019
8800
|
* @param {*} [options] Override http request option.
|
|
9020
8801
|
* @throws {RequiredError}
|
|
9021
8802
|
*/
|
|
9022
|
-
|
|
8803
|
+
createProgramOperatorRun: (cell: string, createProgramOperatorRunRequest: CreateProgramOperatorRunRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
9023
8804
|
/**
|
|
9024
8805
|
* <!-- theme: danger --> > **Experimental** Creates a new trigger that automatically runs a program when certain conditions are met. Each trigger has a different configuration, and the configuration must be valid for the provided trigger type.
|
|
9025
8806
|
* @summary Create Trigger
|
|
@@ -9039,16 +8820,16 @@ export declare const ProgramOperatorApiAxiosParamCreator: (configuration?: Confi
|
|
|
9039
8820
|
*/
|
|
9040
8821
|
deleteTrigger: (trigger: string, cell: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
9041
8822
|
/**
|
|
9042
|
-
* <!-- theme: danger -->
|
|
8823
|
+
* <!-- theme: danger --> > **Experimental** Retrieves all program runs, including past and current executions. Use the optional `state` parameter to filter the results by their status.
|
|
9043
8824
|
* @summary Get All Program Runs
|
|
9044
8825
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
9045
8826
|
* @param {string} [state]
|
|
9046
8827
|
* @param {*} [options] Override http request option.
|
|
9047
8828
|
* @throws {RequiredError}
|
|
9048
8829
|
*/
|
|
9049
|
-
|
|
8830
|
+
getAllProgramOperatorRuns: (cell: string, state?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
9050
8831
|
/**
|
|
9051
|
-
* <!-- theme: danger --> > **Experimental** Returns all triggers in the system with the program runs caused by each trigger. You can use the program run
|
|
8832
|
+
* <!-- theme: danger --> > **Experimental** Returns all triggers in the system with the program runs caused by each trigger. You can use the program run identifier to get more details about a specific program run.
|
|
9052
8833
|
* @summary Get All Triggers
|
|
9053
8834
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
9054
8835
|
* @param {*} [options] Override http request option.
|
|
@@ -9056,14 +8837,14 @@ export declare const ProgramOperatorApiAxiosParamCreator: (configuration?: Confi
|
|
|
9056
8837
|
*/
|
|
9057
8838
|
getAllTriggers: (cell: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
9058
8839
|
/**
|
|
9059
|
-
* <!-- theme: danger -->
|
|
8840
|
+
* <!-- theme: danger --> > **Experimental** Retrieves detailed information about a specific program run.
|
|
9060
8841
|
* @summary Get Program Run
|
|
9061
8842
|
* @param {string} run
|
|
9062
8843
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
9063
8844
|
* @param {*} [options] Override http request option.
|
|
9064
8845
|
* @throws {RequiredError}
|
|
9065
8846
|
*/
|
|
9066
|
-
|
|
8847
|
+
getProgramOperatorRun: (run: string, cell: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
9067
8848
|
/**
|
|
9068
8849
|
* <!-- theme: danger --> > **Experimental** Retrieves detailed information about a specific trigger.
|
|
9069
8850
|
* @summary Get Trigger
|
|
@@ -9076,7 +8857,7 @@ export declare const ProgramOperatorApiAxiosParamCreator: (configuration?: Confi
|
|
|
9076
8857
|
/**
|
|
9077
8858
|
* <!-- theme: danger --> > **Experimental** Updates the details of an existing trigger The exact behavior of switching a trigger from active to inactive or vice versa is not defined yet.
|
|
9078
8859
|
* @summary Update Trigger
|
|
9079
|
-
* @param {string} trigger
|
|
8860
|
+
* @param {string} trigger The identifier of the trigger.
|
|
9080
8861
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
9081
8862
|
* @param {UpdateTriggerRequest} updateTriggerRequest
|
|
9082
8863
|
* @param {*} [options] Override http request option.
|
|
@@ -9090,14 +8871,14 @@ export declare const ProgramOperatorApiAxiosParamCreator: (configuration?: Confi
|
|
|
9090
8871
|
*/
|
|
9091
8872
|
export declare const ProgramOperatorApiFp: (configuration?: Configuration) => {
|
|
9092
8873
|
/**
|
|
9093
|
-
* <!-- theme: danger -->
|
|
8874
|
+
* <!-- theme: danger --> > **Experimental** This endpoint initiates the execution of a program stored in the program library. A program is started with the a specific program identifier that exists in the program library.
|
|
9094
8875
|
* @summary Run Program from Library
|
|
9095
8876
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
9096
|
-
* @param {
|
|
8877
|
+
* @param {CreateProgramOperatorRunRequest} createProgramOperatorRunRequest
|
|
9097
8878
|
* @param {*} [options] Override http request option.
|
|
9098
8879
|
* @throws {RequiredError}
|
|
9099
8880
|
*/
|
|
9100
|
-
|
|
8881
|
+
createProgramOperatorRun(cell: string, createProgramOperatorRunRequest: CreateProgramOperatorRunRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateProgramOperatorRun200Response>>;
|
|
9101
8882
|
/**
|
|
9102
8883
|
* <!-- theme: danger --> > **Experimental** Creates a new trigger that automatically runs a program when certain conditions are met. Each trigger has a different configuration, and the configuration must be valid for the provided trigger type.
|
|
9103
8884
|
* @summary Create Trigger
|
|
@@ -9117,16 +8898,16 @@ export declare const ProgramOperatorApiFp: (configuration?: Configuration) => {
|
|
|
9117
8898
|
*/
|
|
9118
8899
|
deleteTrigger(trigger: string, cell: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
9119
8900
|
/**
|
|
9120
|
-
* <!-- theme: danger -->
|
|
8901
|
+
* <!-- theme: danger --> > **Experimental** Retrieves all program runs, including past and current executions. Use the optional `state` parameter to filter the results by their status.
|
|
9121
8902
|
* @summary Get All Program Runs
|
|
9122
8903
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
9123
8904
|
* @param {string} [state]
|
|
9124
8905
|
* @param {*} [options] Override http request option.
|
|
9125
8906
|
* @throws {RequiredError}
|
|
9126
8907
|
*/
|
|
9127
|
-
|
|
8908
|
+
getAllProgramOperatorRuns(cell: string, state?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetAllProgramOperatorRuns200Response>>;
|
|
9128
8909
|
/**
|
|
9129
|
-
* <!-- theme: danger --> > **Experimental** Returns all triggers in the system with the program runs caused by each trigger. You can use the program run
|
|
8910
|
+
* <!-- theme: danger --> > **Experimental** Returns all triggers in the system with the program runs caused by each trigger. You can use the program run identifier to get more details about a specific program run.
|
|
9130
8911
|
* @summary Get All Triggers
|
|
9131
8912
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
9132
8913
|
* @param {*} [options] Override http request option.
|
|
@@ -9134,14 +8915,14 @@ export declare const ProgramOperatorApiFp: (configuration?: Configuration) => {
|
|
|
9134
8915
|
*/
|
|
9135
8916
|
getAllTriggers(cell: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetAllTriggers200Response>>;
|
|
9136
8917
|
/**
|
|
9137
|
-
* <!-- theme: danger -->
|
|
8918
|
+
* <!-- theme: danger --> > **Experimental** Retrieves detailed information about a specific program run.
|
|
9138
8919
|
* @summary Get Program Run
|
|
9139
8920
|
* @param {string} run
|
|
9140
8921
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
9141
8922
|
* @param {*} [options] Override http request option.
|
|
9142
8923
|
* @throws {RequiredError}
|
|
9143
8924
|
*/
|
|
9144
|
-
|
|
8925
|
+
getProgramOperatorRun(run: string, cell: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ProgramRunObject>>;
|
|
9145
8926
|
/**
|
|
9146
8927
|
* <!-- theme: danger --> > **Experimental** Retrieves detailed information about a specific trigger.
|
|
9147
8928
|
* @summary Get Trigger
|
|
@@ -9154,7 +8935,7 @@ export declare const ProgramOperatorApiFp: (configuration?: Configuration) => {
|
|
|
9154
8935
|
/**
|
|
9155
8936
|
* <!-- theme: danger --> > **Experimental** Updates the details of an existing trigger The exact behavior of switching a trigger from active to inactive or vice versa is not defined yet.
|
|
9156
8937
|
* @summary Update Trigger
|
|
9157
|
-
* @param {string} trigger
|
|
8938
|
+
* @param {string} trigger The identifier of the trigger.
|
|
9158
8939
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
9159
8940
|
* @param {UpdateTriggerRequest} updateTriggerRequest
|
|
9160
8941
|
* @param {*} [options] Override http request option.
|
|
@@ -9168,14 +8949,14 @@ export declare const ProgramOperatorApiFp: (configuration?: Configuration) => {
|
|
|
9168
8949
|
*/
|
|
9169
8950
|
export declare const ProgramOperatorApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
9170
8951
|
/**
|
|
9171
|
-
* <!-- theme: danger -->
|
|
8952
|
+
* <!-- theme: danger --> > **Experimental** This endpoint initiates the execution of a program stored in the program library. A program is started with the a specific program identifier that exists in the program library.
|
|
9172
8953
|
* @summary Run Program from Library
|
|
9173
8954
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
9174
|
-
* @param {
|
|
8955
|
+
* @param {CreateProgramOperatorRunRequest} createProgramOperatorRunRequest
|
|
9175
8956
|
* @param {*} [options] Override http request option.
|
|
9176
8957
|
* @throws {RequiredError}
|
|
9177
8958
|
*/
|
|
9178
|
-
|
|
8959
|
+
createProgramOperatorRun(cell: string, createProgramOperatorRunRequest: CreateProgramOperatorRunRequest, options?: RawAxiosRequestConfig): AxiosPromise<CreateProgramOperatorRun200Response>;
|
|
9179
8960
|
/**
|
|
9180
8961
|
* <!-- theme: danger --> > **Experimental** Creates a new trigger that automatically runs a program when certain conditions are met. Each trigger has a different configuration, and the configuration must be valid for the provided trigger type.
|
|
9181
8962
|
* @summary Create Trigger
|
|
@@ -9195,16 +8976,16 @@ export declare const ProgramOperatorApiFactory: (configuration?: Configuration,
|
|
|
9195
8976
|
*/
|
|
9196
8977
|
deleteTrigger(trigger: string, cell: string, options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
9197
8978
|
/**
|
|
9198
|
-
* <!-- theme: danger -->
|
|
8979
|
+
* <!-- theme: danger --> > **Experimental** Retrieves all program runs, including past and current executions. Use the optional `state` parameter to filter the results by their status.
|
|
9199
8980
|
* @summary Get All Program Runs
|
|
9200
8981
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
9201
8982
|
* @param {string} [state]
|
|
9202
8983
|
* @param {*} [options] Override http request option.
|
|
9203
8984
|
* @throws {RequiredError}
|
|
9204
8985
|
*/
|
|
9205
|
-
|
|
8986
|
+
getAllProgramOperatorRuns(cell: string, state?: string, options?: RawAxiosRequestConfig): AxiosPromise<GetAllProgramOperatorRuns200Response>;
|
|
9206
8987
|
/**
|
|
9207
|
-
* <!-- theme: danger --> > **Experimental** Returns all triggers in the system with the program runs caused by each trigger. You can use the program run
|
|
8988
|
+
* <!-- theme: danger --> > **Experimental** Returns all triggers in the system with the program runs caused by each trigger. You can use the program run identifier to get more details about a specific program run.
|
|
9208
8989
|
* @summary Get All Triggers
|
|
9209
8990
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
9210
8991
|
* @param {*} [options] Override http request option.
|
|
@@ -9212,14 +8993,14 @@ export declare const ProgramOperatorApiFactory: (configuration?: Configuration,
|
|
|
9212
8993
|
*/
|
|
9213
8994
|
getAllTriggers(cell: string, options?: RawAxiosRequestConfig): AxiosPromise<GetAllTriggers200Response>;
|
|
9214
8995
|
/**
|
|
9215
|
-
* <!-- theme: danger -->
|
|
8996
|
+
* <!-- theme: danger --> > **Experimental** Retrieves detailed information about a specific program run.
|
|
9216
8997
|
* @summary Get Program Run
|
|
9217
8998
|
* @param {string} run
|
|
9218
8999
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
9219
9000
|
* @param {*} [options] Override http request option.
|
|
9220
9001
|
* @throws {RequiredError}
|
|
9221
9002
|
*/
|
|
9222
|
-
|
|
9003
|
+
getProgramOperatorRun(run: string, cell: string, options?: RawAxiosRequestConfig): AxiosPromise<ProgramRunObject>;
|
|
9223
9004
|
/**
|
|
9224
9005
|
* <!-- theme: danger --> > **Experimental** Retrieves detailed information about a specific trigger.
|
|
9225
9006
|
* @summary Get Trigger
|
|
@@ -9232,7 +9013,7 @@ export declare const ProgramOperatorApiFactory: (configuration?: Configuration,
|
|
|
9232
9013
|
/**
|
|
9233
9014
|
* <!-- theme: danger --> > **Experimental** Updates the details of an existing trigger The exact behavior of switching a trigger from active to inactive or vice versa is not defined yet.
|
|
9234
9015
|
* @summary Update Trigger
|
|
9235
|
-
* @param {string} trigger
|
|
9016
|
+
* @param {string} trigger The identifier of the trigger.
|
|
9236
9017
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
9237
9018
|
* @param {UpdateTriggerRequest} updateTriggerRequest
|
|
9238
9019
|
* @param {*} [options] Override http request option.
|
|
@@ -9248,15 +9029,15 @@ export declare const ProgramOperatorApiFactory: (configuration?: Configuration,
|
|
|
9248
9029
|
*/
|
|
9249
9030
|
export declare class ProgramOperatorApi extends BaseAPI {
|
|
9250
9031
|
/**
|
|
9251
|
-
* <!-- theme: danger -->
|
|
9032
|
+
* <!-- theme: danger --> > **Experimental** This endpoint initiates the execution of a program stored in the program library. A program is started with the a specific program identifier that exists in the program library.
|
|
9252
9033
|
* @summary Run Program from Library
|
|
9253
9034
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
9254
|
-
* @param {
|
|
9035
|
+
* @param {CreateProgramOperatorRunRequest} createProgramOperatorRunRequest
|
|
9255
9036
|
* @param {*} [options] Override http request option.
|
|
9256
9037
|
* @throws {RequiredError}
|
|
9257
9038
|
* @memberof ProgramOperatorApi
|
|
9258
9039
|
*/
|
|
9259
|
-
|
|
9040
|
+
createProgramOperatorRun(cell: string, createProgramOperatorRunRequest: CreateProgramOperatorRunRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateProgramOperatorRun200Response, any>>;
|
|
9260
9041
|
/**
|
|
9261
9042
|
* <!-- theme: danger --> > **Experimental** Creates a new trigger that automatically runs a program when certain conditions are met. Each trigger has a different configuration, and the configuration must be valid for the provided trigger type.
|
|
9262
9043
|
* @summary Create Trigger
|
|
@@ -9278,7 +9059,7 @@ export declare class ProgramOperatorApi extends BaseAPI {
|
|
|
9278
9059
|
*/
|
|
9279
9060
|
deleteTrigger(trigger: string, cell: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
9280
9061
|
/**
|
|
9281
|
-
* <!-- theme: danger -->
|
|
9062
|
+
* <!-- theme: danger --> > **Experimental** Retrieves all program runs, including past and current executions. Use the optional `state` parameter to filter the results by their status.
|
|
9282
9063
|
* @summary Get All Program Runs
|
|
9283
9064
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
9284
9065
|
* @param {string} [state]
|
|
@@ -9286,9 +9067,9 @@ export declare class ProgramOperatorApi extends BaseAPI {
|
|
|
9286
9067
|
* @throws {RequiredError}
|
|
9287
9068
|
* @memberof ProgramOperatorApi
|
|
9288
9069
|
*/
|
|
9289
|
-
|
|
9070
|
+
getAllProgramOperatorRuns(cell: string, state?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetAllProgramOperatorRuns200Response, any>>;
|
|
9290
9071
|
/**
|
|
9291
|
-
* <!-- theme: danger --> > **Experimental** Returns all triggers in the system with the program runs caused by each trigger. You can use the program run
|
|
9072
|
+
* <!-- theme: danger --> > **Experimental** Returns all triggers in the system with the program runs caused by each trigger. You can use the program run identifier to get more details about a specific program run.
|
|
9292
9073
|
* @summary Get All Triggers
|
|
9293
9074
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
9294
9075
|
* @param {*} [options] Override http request option.
|
|
@@ -9297,7 +9078,7 @@ export declare class ProgramOperatorApi extends BaseAPI {
|
|
|
9297
9078
|
*/
|
|
9298
9079
|
getAllTriggers(cell: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetAllTriggers200Response, any>>;
|
|
9299
9080
|
/**
|
|
9300
|
-
* <!-- theme: danger -->
|
|
9081
|
+
* <!-- theme: danger --> > **Experimental** Retrieves detailed information about a specific program run.
|
|
9301
9082
|
* @summary Get Program Run
|
|
9302
9083
|
* @param {string} run
|
|
9303
9084
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
@@ -9305,7 +9086,7 @@ export declare class ProgramOperatorApi extends BaseAPI {
|
|
|
9305
9086
|
* @throws {RequiredError}
|
|
9306
9087
|
* @memberof ProgramOperatorApi
|
|
9307
9088
|
*/
|
|
9308
|
-
|
|
9089
|
+
getProgramOperatorRun(run: string, cell: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ProgramRunObject, any>>;
|
|
9309
9090
|
/**
|
|
9310
9091
|
* <!-- theme: danger --> > **Experimental** Retrieves detailed information about a specific trigger.
|
|
9311
9092
|
* @summary Get Trigger
|
|
@@ -9319,7 +9100,7 @@ export declare class ProgramOperatorApi extends BaseAPI {
|
|
|
9319
9100
|
/**
|
|
9320
9101
|
* <!-- theme: danger --> > **Experimental** Updates the details of an existing trigger The exact behavior of switching a trigger from active to inactive or vice versa is not defined yet.
|
|
9321
9102
|
* @summary Update Trigger
|
|
9322
|
-
* @param {string} trigger
|
|
9103
|
+
* @param {string} trigger The identifier of the trigger.
|
|
9323
9104
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
9324
9105
|
* @param {UpdateTriggerRequest} updateTriggerRequest
|
|
9325
9106
|
* @param {*} [options] Override http request option.
|