@wandelbots/nova-api 25.7.0-dev.26 → 25.7.0-dev.27
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/package.json +1 -1
- package/v2/api.d.ts +1777 -482
- package/v2/api.js +1436 -212
- package/v2/api.js.map +1 -1
- package/v2/api.ts +2452 -393
package/v2/api.d.ts
CHANGED
|
@@ -335,6 +335,173 @@ export declare const BoxBoxTypeEnum: {
|
|
|
335
335
|
readonly Full: "FULL";
|
|
336
336
|
};
|
|
337
337
|
export type BoxBoxTypeEnum = typeof BoxBoxTypeEnum[keyof typeof BoxBoxTypeEnum];
|
|
338
|
+
/**
|
|
339
|
+
* PROFINET BUS Inputs/Outputs Service configuration.
|
|
340
|
+
* @export
|
|
341
|
+
* @interface BusIOProfinet
|
|
342
|
+
*/
|
|
343
|
+
export interface BusIOProfinet {
|
|
344
|
+
/**
|
|
345
|
+
*
|
|
346
|
+
* @type {string}
|
|
347
|
+
* @memberof BusIOProfinet
|
|
348
|
+
*/
|
|
349
|
+
'bus_type'?: BusIOProfinetBusTypeEnum;
|
|
350
|
+
/**
|
|
351
|
+
* Path to the configuration file.
|
|
352
|
+
* @type {string}
|
|
353
|
+
* @memberof BusIOProfinet
|
|
354
|
+
*/
|
|
355
|
+
'config_file_content'?: string;
|
|
356
|
+
/**
|
|
357
|
+
*
|
|
358
|
+
* @type {BusIOProfinetNetwork}
|
|
359
|
+
* @memberof BusIOProfinet
|
|
360
|
+
*/
|
|
361
|
+
'network_config'?: BusIOProfinetNetwork;
|
|
362
|
+
/**
|
|
363
|
+
* MAC address for the PROFINET port, should be get from another NOVA API endpoind?
|
|
364
|
+
* @type {string}
|
|
365
|
+
* @memberof BusIOProfinet
|
|
366
|
+
*/
|
|
367
|
+
'mac': string;
|
|
368
|
+
/**
|
|
369
|
+
*
|
|
370
|
+
* @type {BusIOProfinetDefaultRoute}
|
|
371
|
+
* @memberof BusIOProfinet
|
|
372
|
+
*/
|
|
373
|
+
'default_route': BusIOProfinetDefaultRoute;
|
|
374
|
+
}
|
|
375
|
+
export declare const BusIOProfinetBusTypeEnum: {
|
|
376
|
+
readonly Profinet: "profinet";
|
|
377
|
+
};
|
|
378
|
+
export type BusIOProfinetBusTypeEnum = typeof BusIOProfinetBusTypeEnum[keyof typeof BusIOProfinetBusTypeEnum];
|
|
379
|
+
/**
|
|
380
|
+
* Default route configuration for the PROFINET service. Will be removed before release by automatic default route configuration, if possible.
|
|
381
|
+
* @export
|
|
382
|
+
* @interface BusIOProfinetDefaultRoute
|
|
383
|
+
*/
|
|
384
|
+
export interface BusIOProfinetDefaultRoute {
|
|
385
|
+
/**
|
|
386
|
+
* Gateway for the default route.
|
|
387
|
+
* @type {string}
|
|
388
|
+
* @memberof BusIOProfinetDefaultRoute
|
|
389
|
+
*/
|
|
390
|
+
'gateway': string;
|
|
391
|
+
/**
|
|
392
|
+
* Interface for the default route.
|
|
393
|
+
* @type {string}
|
|
394
|
+
* @memberof BusIOProfinetDefaultRoute
|
|
395
|
+
*/
|
|
396
|
+
'interface': string;
|
|
397
|
+
}
|
|
398
|
+
/**
|
|
399
|
+
* Network configuration for the PROFINET device
|
|
400
|
+
* @export
|
|
401
|
+
* @interface BusIOProfinetIpConfig
|
|
402
|
+
*/
|
|
403
|
+
export interface BusIOProfinetIpConfig {
|
|
404
|
+
/**
|
|
405
|
+
* IP address for the PROFINET device
|
|
406
|
+
* @type {string}
|
|
407
|
+
* @memberof BusIOProfinetIpConfig
|
|
408
|
+
*/
|
|
409
|
+
'ip': string;
|
|
410
|
+
/**
|
|
411
|
+
* Network mask for the PROFINET device.
|
|
412
|
+
* @type {string}
|
|
413
|
+
* @memberof BusIOProfinetIpConfig
|
|
414
|
+
*/
|
|
415
|
+
'netmask': string;
|
|
416
|
+
/**
|
|
417
|
+
* Gateway for the PROFINET device
|
|
418
|
+
* @type {string}
|
|
419
|
+
* @memberof BusIOProfinetIpConfig
|
|
420
|
+
*/
|
|
421
|
+
'gateway': string;
|
|
422
|
+
}
|
|
423
|
+
/**
|
|
424
|
+
*
|
|
425
|
+
* @export
|
|
426
|
+
* @interface BusIOProfinetNetwork
|
|
427
|
+
*/
|
|
428
|
+
export interface BusIOProfinetNetwork {
|
|
429
|
+
/**
|
|
430
|
+
* Name of the PROFINET device.
|
|
431
|
+
* @type {string}
|
|
432
|
+
* @memberof BusIOProfinetNetwork
|
|
433
|
+
*/
|
|
434
|
+
'device_name'?: string;
|
|
435
|
+
/**
|
|
436
|
+
*
|
|
437
|
+
* @type {BusIOProfinetIpConfig}
|
|
438
|
+
* @memberof BusIOProfinetNetwork
|
|
439
|
+
*/
|
|
440
|
+
'ip_config'?: BusIOProfinetIpConfig;
|
|
441
|
+
/**
|
|
442
|
+
* Content of the PROFINET REMA XML file.
|
|
443
|
+
* @type {string}
|
|
444
|
+
* @memberof BusIOProfinetNetwork
|
|
445
|
+
*/
|
|
446
|
+
'rema_xml_content'?: string;
|
|
447
|
+
}
|
|
448
|
+
/**
|
|
449
|
+
* Virtual PROFINET BUS Inputs/Outputs Service configuration.
|
|
450
|
+
* @export
|
|
451
|
+
* @interface BusIOProfinetVirtual
|
|
452
|
+
*/
|
|
453
|
+
export interface BusIOProfinetVirtual {
|
|
454
|
+
/**
|
|
455
|
+
*
|
|
456
|
+
* @type {string}
|
|
457
|
+
* @memberof BusIOProfinetVirtual
|
|
458
|
+
*/
|
|
459
|
+
'bus_type'?: BusIOProfinetVirtualBusTypeEnum;
|
|
460
|
+
}
|
|
461
|
+
export declare const BusIOProfinetVirtualBusTypeEnum: {
|
|
462
|
+
readonly VirtualProfinet: "virtual_profinet";
|
|
463
|
+
};
|
|
464
|
+
export type BusIOProfinetVirtualBusTypeEnum = typeof BusIOProfinetVirtualBusTypeEnum[keyof typeof BusIOProfinetVirtualBusTypeEnum];
|
|
465
|
+
/**
|
|
466
|
+
* @type BusIOType
|
|
467
|
+
* @export
|
|
468
|
+
*/
|
|
469
|
+
export type BusIOType = {
|
|
470
|
+
bus_type: 'profinet';
|
|
471
|
+
} & BusIOProfinet | {
|
|
472
|
+
bus_type: 'profinet_virtual';
|
|
473
|
+
} & BusIOProfinetVirtual;
|
|
474
|
+
/**
|
|
475
|
+
*
|
|
476
|
+
* @export
|
|
477
|
+
* @interface BusIOsState
|
|
478
|
+
*/
|
|
479
|
+
export interface BusIOsState {
|
|
480
|
+
/**
|
|
481
|
+
*
|
|
482
|
+
* @type {BusIOsStateEnum}
|
|
483
|
+
* @memberof BusIOsState
|
|
484
|
+
*/
|
|
485
|
+
'state': BusIOsStateEnum;
|
|
486
|
+
/**
|
|
487
|
+
* A message providing additional information on the input/output, e.g. BUS service status, encountered errors. May be empty if no additional information is available.
|
|
488
|
+
* @type {string}
|
|
489
|
+
* @memberof BusIOsState
|
|
490
|
+
*/
|
|
491
|
+
'message'?: string;
|
|
492
|
+
}
|
|
493
|
+
/**
|
|
494
|
+
* Current state of the BUS input/output service.
|
|
495
|
+
* @export
|
|
496
|
+
* @enum {string}
|
|
497
|
+
*/
|
|
498
|
+
export declare const BusIOsStateEnum: {
|
|
499
|
+
readonly BusIosStateUnknown: "BUS_IOS_STATE_UNKNOWN";
|
|
500
|
+
readonly BusIosStateInitializing: "BUS_IOS_STATE_INITIALIZING";
|
|
501
|
+
readonly BusIosStateConnected: "BUS_IOS_STATE_CONNECTED";
|
|
502
|
+
readonly BusIosStateDisconnected: "BUS_IOS_STATE_DISCONNECTED";
|
|
503
|
+
};
|
|
504
|
+
export type BusIOsStateEnum = typeof BusIOsStateEnum[keyof typeof BusIOsStateEnum];
|
|
338
505
|
/**
|
|
339
506
|
* Defines a cylindrical shape with 2 semi-spheres on the top and bottom. Centred around origin, symmetric around z-axis.
|
|
340
507
|
* @export
|
|
@@ -495,13 +662,13 @@ export interface Collision {
|
|
|
495
662
|
* @type {string}
|
|
496
663
|
* @memberof Collision
|
|
497
664
|
*/
|
|
498
|
-
'
|
|
665
|
+
'id_of_layer'?: string;
|
|
499
666
|
/**
|
|
500
667
|
* A three-dimensional vector [x, y, z] with double precision.
|
|
501
668
|
* @type {Array<number>}
|
|
502
669
|
* @memberof Collision
|
|
503
670
|
*/
|
|
504
|
-
'
|
|
671
|
+
'normal_root_on_b'?: Array<number>;
|
|
505
672
|
/**
|
|
506
673
|
*
|
|
507
674
|
* @type {CollisionContact}
|
|
@@ -532,7 +699,7 @@ export interface CollisionContact {
|
|
|
532
699
|
* @type {Array<number>}
|
|
533
700
|
* @memberof CollisionContact
|
|
534
701
|
*/
|
|
535
|
-
'
|
|
702
|
+
'root'?: Array<number>;
|
|
536
703
|
}
|
|
537
704
|
/**
|
|
538
705
|
*
|
|
@@ -548,50 +715,29 @@ export interface CollisionError {
|
|
|
548
715
|
'collision'?: FeedbackCollision;
|
|
549
716
|
}
|
|
550
717
|
/**
|
|
551
|
-
*
|
|
718
|
+
* @type CollisionFreeAlgorithm
|
|
719
|
+
* Configuration for collision-free path planning algorithms. Different algorithms may have different parameters and behavior.
|
|
552
720
|
* @export
|
|
553
|
-
* @interface CollisionMotionGroup
|
|
554
721
|
*/
|
|
555
|
-
export
|
|
556
|
-
/**
|
|
557
|
-
* A link chain is a kinematic chain of links that is connected via joints. A motion group can be used to control the motion of the joints in a link chain. A link is a group of colliders that is attached to the link reference frame. The reference frame of a link is obtained after applying all sets of Denavit-Hartenberg-parameters from base to (including) the link index. This means that the reference frame of the link is on the rotation axis of the next joint in the kinematic chain. Example: For a motion group with 2 joints, the collider reference frame (CRF) for link 1 is on the rotation axis of joint 2. The chain looks like: - Origin >> Mounting >> Base >> (CRF Base) Joint 0 >> Link 0 >> (CRF Link 0) Joint 1 >> Link 1 >> (CRF Link 1) Flange (CRF Tool) >> TCP Adjacent links in the kinematic chain of the motion group are not checked for mutual collision.
|
|
558
|
-
* @type {Array<{ [key: string]: Collider; }>}
|
|
559
|
-
* @memberof CollisionMotionGroup
|
|
560
|
-
*/
|
|
561
|
-
'link_chain'?: Array<{
|
|
562
|
-
[key: string]: Collider;
|
|
563
|
-
}>;
|
|
564
|
-
/**
|
|
565
|
-
* Defines the shape of a tool. A tool is a dictionary of colliders. All colliders that make up a tool are attached to the flange frame of the motion group.
|
|
566
|
-
* @type {{ [key: string]: Collider; }}
|
|
567
|
-
* @memberof CollisionMotionGroup
|
|
568
|
-
*/
|
|
569
|
-
'tool'?: {
|
|
570
|
-
[key: string]: Collider;
|
|
571
|
-
};
|
|
572
|
-
}
|
|
722
|
+
export type CollisionFreeAlgorithm = MidpointInsertionAlgorithm | RRTConnectAlgorithm;
|
|
573
723
|
/**
|
|
574
724
|
*
|
|
575
725
|
* @export
|
|
576
|
-
* @interface
|
|
726
|
+
* @interface CollisionSetup
|
|
577
727
|
*/
|
|
578
|
-
export interface
|
|
728
|
+
export interface CollisionSetup {
|
|
579
729
|
/**
|
|
580
|
-
*
|
|
581
|
-
* @type {string}
|
|
582
|
-
* @memberof
|
|
583
|
-
*/
|
|
584
|
-
'stored_link_chain'?: string;
|
|
585
|
-
/**
|
|
586
|
-
* References a stored tool.
|
|
587
|
-
* @type {string}
|
|
588
|
-
* @memberof CollisionMotionGroupAssembly
|
|
730
|
+
* A collection of identifiable colliders.
|
|
731
|
+
* @type {{ [key: string]: Collider; }}
|
|
732
|
+
* @memberof CollisionSetup
|
|
589
733
|
*/
|
|
590
|
-
'
|
|
734
|
+
'colliders'?: {
|
|
735
|
+
[key: string]: Collider;
|
|
736
|
+
};
|
|
591
737
|
/**
|
|
592
738
|
* A link chain is a kinematic chain of links that is connected via joints. A motion group can be used to control the motion of the joints in a link chain. A link is a group of colliders that is attached to the link reference frame. The reference frame of a link is obtained after applying all sets of Denavit-Hartenberg-parameters from base to (including) the link index. This means that the reference frame of the link is on the rotation axis of the next joint in the kinematic chain. Example: For a motion group with 2 joints, the collider reference frame (CRF) for link 1 is on the rotation axis of joint 2. The chain looks like: - Origin >> Mounting >> Base >> (CRF Base) Joint 0 >> Link 0 >> (CRF Link 0) Joint 1 >> Link 1 >> (CRF Link 1) Flange (CRF Tool) >> TCP Adjacent links in the kinematic chain of the motion group are not checked for mutual collision.
|
|
593
739
|
* @type {Array<{ [key: string]: Collider; }>}
|
|
594
|
-
* @memberof
|
|
740
|
+
* @memberof CollisionSetup
|
|
595
741
|
*/
|
|
596
742
|
'link_chain'?: Array<{
|
|
597
743
|
[key: string]: Collider;
|
|
@@ -599,75 +745,17 @@ export interface CollisionMotionGroupAssembly {
|
|
|
599
745
|
/**
|
|
600
746
|
* Defines the shape of a tool. A tool is a dictionary of colliders. All colliders that make up a tool are attached to the flange frame of the motion group.
|
|
601
747
|
* @type {{ [key: string]: Collider; }}
|
|
602
|
-
* @memberof
|
|
748
|
+
* @memberof CollisionSetup
|
|
603
749
|
*/
|
|
604
750
|
'tool'?: {
|
|
605
751
|
[key: string]: Collider;
|
|
606
752
|
};
|
|
607
|
-
}
|
|
608
|
-
/**
|
|
609
|
-
* Defines the collision scene. There are two types of objects in the scene: - `colliders`: Each collider is attached directly to the origin of the scene: Origin >> Collider - `motion-groups`: Each motion group is assigned a kinematic chain of links with a special collider, called tool, attached to the last element. The motion group is attached to the origin of the scene via its mounting: Origin >> Mounting >> Motion Group Base >> […]
|
|
610
|
-
* @export
|
|
611
|
-
* @interface CollisionScene
|
|
612
|
-
*/
|
|
613
|
-
export interface CollisionScene {
|
|
614
|
-
/**
|
|
615
|
-
* A collection of identifiable colliders.
|
|
616
|
-
* @type {{ [key: string]: Collider; }}
|
|
617
|
-
* @memberof CollisionScene
|
|
618
|
-
*/
|
|
619
|
-
'colliders'?: {
|
|
620
|
-
[key: string]: Collider;
|
|
621
|
-
};
|
|
622
|
-
/**
|
|
623
|
-
* Maps a Wandelbots NOVA motion group to its configuration in the collision scene. Key must be a motion group identifier. Values are collision motion group objects. A collision motion group defines a motion group in the collision scene. The motion group is attached to the origin of the scene. To relocate the motion group, configure its mounting offset on the physical controller. This ensures that the definition of motion commands and collision scenes use the same coordinate system. The kinematic chain looks like this: - Origin >> Mounting >> Base >> Joint 0 >> Link 0 >> Joint 1 >> […] >> TCP A `tool` is treated like another link attached to the end (flange) of the kinematic chain. All tool colliders are described in the flange frame.
|
|
624
|
-
* @type {{ [key: string]: CollisionMotionGroup; }}
|
|
625
|
-
* @memberof CollisionScene
|
|
626
|
-
*/
|
|
627
|
-
'motion_groups'?: {
|
|
628
|
-
[key: string]: CollisionMotionGroup;
|
|
629
|
-
};
|
|
630
|
-
}
|
|
631
|
-
/**
|
|
632
|
-
* Defines the collision scene assembly. Merges all referenced and new scene components into a single scene. Previously added components with identical identifiers are overwritten within the same group. There is one group for each of the following components: - Colliders attached to the origin of the scene, - Tool per motion group, and - For each link per motion group. The scene is assembled by adding components in the following order. 1. stored_scenes 2. scene 3. stored_colliders 4. colliders 5. stored_link_chains and stored_tools (per motion group) 6. link_chains and tools (per motion group)
|
|
633
|
-
* @export
|
|
634
|
-
* @interface CollisionSceneAssembly
|
|
635
|
-
*/
|
|
636
|
-
export interface CollisionSceneAssembly {
|
|
637
|
-
/**
|
|
638
|
-
* Add stored scenes to the scene via their identifiers. The scenes are merged based on their order in the array. The scene at index zero serves as base. Following scenes overwrite components with identical identifiers, see [Collision Scene Assembly](Collision Scene Assembly).
|
|
639
|
-
* @type {Array<string>}
|
|
640
|
-
* @memberof CollisionSceneAssembly
|
|
641
|
-
*/
|
|
642
|
-
'stored_scenes'?: Array<string>;
|
|
643
|
-
/**
|
|
644
|
-
*
|
|
645
|
-
* @type {CollisionScene}
|
|
646
|
-
* @memberof CollisionSceneAssembly
|
|
647
|
-
*/
|
|
648
|
-
'scene'?: CollisionScene;
|
|
649
|
-
/**
|
|
650
|
-
* Add stored colliders to the scene via their identifiers. The colliders are added to the the origin of the scene.
|
|
651
|
-
* @type {Array<string>}
|
|
652
|
-
* @memberof CollisionSceneAssembly
|
|
653
|
-
*/
|
|
654
|
-
'stored_colliders'?: Array<string>;
|
|
655
|
-
/**
|
|
656
|
-
* A collection of identifiable colliders.
|
|
657
|
-
* @type {{ [key: string]: Collider; }}
|
|
658
|
-
* @memberof CollisionSceneAssembly
|
|
659
|
-
*/
|
|
660
|
-
'colliders'?: {
|
|
661
|
-
[key: string]: Collider;
|
|
662
|
-
};
|
|
663
753
|
/**
|
|
664
|
-
*
|
|
665
|
-
* @type {
|
|
666
|
-
* @memberof
|
|
754
|
+
* If true, self-collision detection is enabled for the motion group. Self-collision detection checks if links in the kinematic chain of the motion group collide with each other. Adjacent links in the kinematic chain of the motion group are not checked for mutual collision. The tool is treated like a link at the end of the kinematic chain. It is checked against all links except the last one. Default is true.
|
|
755
|
+
* @type {boolean}
|
|
756
|
+
* @memberof CollisionSetup
|
|
667
757
|
*/
|
|
668
|
-
'
|
|
669
|
-
[key: string]: CollisionMotionGroupAssembly;
|
|
670
|
-
};
|
|
758
|
+
'self_collision_detection'?: boolean;
|
|
671
759
|
}
|
|
672
760
|
/**
|
|
673
761
|
* Comparator for the comparison of two values. The comparator is used to compare two values and return a boolean result. The default comparator is unknown.
|
|
@@ -1101,6 +1189,116 @@ export declare const Direction: {
|
|
|
1101
1189
|
readonly DirectionBackward: "DIRECTION_BACKWARD";
|
|
1102
1190
|
};
|
|
1103
1191
|
export type Direction = typeof Direction[keyof typeof Direction];
|
|
1192
|
+
/**
|
|
1193
|
+
* The provided joint data does not match the expected number of joints for this motion group.
|
|
1194
|
+
* @export
|
|
1195
|
+
* @interface ErrorInvalidJointCount
|
|
1196
|
+
*/
|
|
1197
|
+
export interface ErrorInvalidJointCount {
|
|
1198
|
+
/**
|
|
1199
|
+
* The expected number of joints for this motion group.
|
|
1200
|
+
* @type {number}
|
|
1201
|
+
* @memberof ErrorInvalidJointCount
|
|
1202
|
+
*/
|
|
1203
|
+
'expected_joint_count': number;
|
|
1204
|
+
/**
|
|
1205
|
+
* The number of provided joints.
|
|
1206
|
+
* @type {number}
|
|
1207
|
+
* @memberof ErrorInvalidJointCount
|
|
1208
|
+
*/
|
|
1209
|
+
'provided_joint_count': number;
|
|
1210
|
+
/**
|
|
1211
|
+
*
|
|
1212
|
+
* @type {string}
|
|
1213
|
+
* @memberof ErrorInvalidJointCount
|
|
1214
|
+
*/
|
|
1215
|
+
'error_feedback_name': ErrorInvalidJointCountErrorFeedbackNameEnum;
|
|
1216
|
+
}
|
|
1217
|
+
export declare const ErrorInvalidJointCountErrorFeedbackNameEnum: {
|
|
1218
|
+
readonly ErrorInvalidJointCount: "ErrorInvalidJointCount";
|
|
1219
|
+
};
|
|
1220
|
+
export type ErrorInvalidJointCountErrorFeedbackNameEnum = typeof ErrorInvalidJointCountErrorFeedbackNameEnum[keyof typeof ErrorInvalidJointCountErrorFeedbackNameEnum];
|
|
1221
|
+
/**
|
|
1222
|
+
* A reference joint position (start or target) exceeds the configured joint limits.
|
|
1223
|
+
* @export
|
|
1224
|
+
* @interface ErrorJointLimitExceeded
|
|
1225
|
+
*/
|
|
1226
|
+
export interface ErrorJointLimitExceeded {
|
|
1227
|
+
/**
|
|
1228
|
+
* Index of the joint exceeding its limits (0-based).
|
|
1229
|
+
* @type {number}
|
|
1230
|
+
* @memberof ErrorJointLimitExceeded
|
|
1231
|
+
*/
|
|
1232
|
+
'joint_index'?: number;
|
|
1233
|
+
/**
|
|
1234
|
+
*
|
|
1235
|
+
* @type {Array<number>}
|
|
1236
|
+
* @memberof ErrorJointLimitExceeded
|
|
1237
|
+
*/
|
|
1238
|
+
'joint_position'?: Array<number>;
|
|
1239
|
+
/**
|
|
1240
|
+
*
|
|
1241
|
+
* @type {string}
|
|
1242
|
+
* @memberof ErrorJointLimitExceeded
|
|
1243
|
+
*/
|
|
1244
|
+
'error_feedback_name': ErrorJointLimitExceededErrorFeedbackNameEnum;
|
|
1245
|
+
}
|
|
1246
|
+
export declare const ErrorJointLimitExceededErrorFeedbackNameEnum: {
|
|
1247
|
+
readonly ErrorJointLimitExceeded: "ErrorJointLimitExceeded";
|
|
1248
|
+
};
|
|
1249
|
+
export type ErrorJointLimitExceededErrorFeedbackNameEnum = typeof ErrorJointLimitExceededErrorFeedbackNameEnum[keyof typeof ErrorJointLimitExceededErrorFeedbackNameEnum];
|
|
1250
|
+
/**
|
|
1251
|
+
* A reference joint position (e.g. start or target joint position) results in collisions that prevent processing.
|
|
1252
|
+
* @export
|
|
1253
|
+
* @interface ErrorJointPositionCollision
|
|
1254
|
+
*/
|
|
1255
|
+
export interface ErrorJointPositionCollision {
|
|
1256
|
+
/**
|
|
1257
|
+
*
|
|
1258
|
+
* @type {Array<Collision>}
|
|
1259
|
+
* @memberof ErrorJointPositionCollision
|
|
1260
|
+
*/
|
|
1261
|
+
'collisions'?: Array<Collision>;
|
|
1262
|
+
/**
|
|
1263
|
+
*
|
|
1264
|
+
* @type {Array<number>}
|
|
1265
|
+
* @memberof ErrorJointPositionCollision
|
|
1266
|
+
*/
|
|
1267
|
+
'joint_position'?: Array<number>;
|
|
1268
|
+
/**
|
|
1269
|
+
*
|
|
1270
|
+
* @type {string}
|
|
1271
|
+
* @memberof ErrorJointPositionCollision
|
|
1272
|
+
*/
|
|
1273
|
+
'error_feedback_name': ErrorJointPositionCollisionErrorFeedbackNameEnum;
|
|
1274
|
+
}
|
|
1275
|
+
export declare const ErrorJointPositionCollisionErrorFeedbackNameEnum: {
|
|
1276
|
+
readonly ErrorJointPositionCollision: "ErrorJointPositionCollision";
|
|
1277
|
+
};
|
|
1278
|
+
export type ErrorJointPositionCollisionErrorFeedbackNameEnum = typeof ErrorJointPositionCollisionErrorFeedbackNameEnum[keyof typeof ErrorJointPositionCollisionErrorFeedbackNameEnum];
|
|
1279
|
+
/**
|
|
1280
|
+
* The collision-free planning algorithm reached its maximum iteration limit without finding a valid path. Increase max_iterations or modify the start/target positions.
|
|
1281
|
+
* @export
|
|
1282
|
+
* @interface ErrorMaxIterationsExceeded
|
|
1283
|
+
*/
|
|
1284
|
+
export interface ErrorMaxIterationsExceeded {
|
|
1285
|
+
/**
|
|
1286
|
+
* The maximum number of iterations that was reached.
|
|
1287
|
+
* @type {number}
|
|
1288
|
+
* @memberof ErrorMaxIterationsExceeded
|
|
1289
|
+
*/
|
|
1290
|
+
'max_iterations'?: number;
|
|
1291
|
+
/**
|
|
1292
|
+
*
|
|
1293
|
+
* @type {string}
|
|
1294
|
+
* @memberof ErrorMaxIterationsExceeded
|
|
1295
|
+
*/
|
|
1296
|
+
'error_feedback_name': ErrorMaxIterationsExceededErrorFeedbackNameEnum;
|
|
1297
|
+
}
|
|
1298
|
+
export declare const ErrorMaxIterationsExceededErrorFeedbackNameEnum: {
|
|
1299
|
+
readonly ErrorMaxIterationsExceeded: "ErrorMaxIterationsExceeded";
|
|
1300
|
+
};
|
|
1301
|
+
export type ErrorMaxIterationsExceededErrorFeedbackNameEnum = typeof ErrorMaxIterationsExceededErrorFeedbackNameEnum[keyof typeof ErrorMaxIterationsExceededErrorFeedbackNameEnum];
|
|
1104
1302
|
/**
|
|
1105
1303
|
* Details about the state of the motion execution. The details are either for a jogging or a trajectory. If NOVA is not controlling this motion group at the moment, this field is omitted.
|
|
1106
1304
|
* @export
|
|
@@ -1359,63 +1557,159 @@ export type FloatValueValueTypeEnum = typeof FloatValueValueTypeEnum[keyof typeo
|
|
|
1359
1557
|
/**
|
|
1360
1558
|
*
|
|
1361
1559
|
* @export
|
|
1362
|
-
* @interface
|
|
1560
|
+
* @interface ForwardKinematics422Response
|
|
1363
1561
|
*/
|
|
1364
|
-
export interface
|
|
1562
|
+
export interface ForwardKinematics422Response {
|
|
1365
1563
|
/**
|
|
1366
1564
|
*
|
|
1367
|
-
* @type {
|
|
1368
|
-
* @memberof
|
|
1565
|
+
* @type {Array<ForwardKinematicsValidationError>}
|
|
1566
|
+
* @memberof ForwardKinematics422Response
|
|
1369
1567
|
*/
|
|
1370
|
-
'
|
|
1568
|
+
'detail'?: Array<ForwardKinematicsValidationError>;
|
|
1371
1569
|
}
|
|
1372
1570
|
/**
|
|
1373
1571
|
*
|
|
1374
1572
|
* @export
|
|
1375
|
-
* @interface
|
|
1573
|
+
* @interface ForwardKinematicsRequest
|
|
1376
1574
|
*/
|
|
1377
|
-
export interface
|
|
1575
|
+
export interface ForwardKinematicsRequest {
|
|
1378
1576
|
/**
|
|
1379
|
-
*
|
|
1577
|
+
* String identifiying the model of a motion group.
|
|
1380
1578
|
* @type {string}
|
|
1381
|
-
* @memberof
|
|
1579
|
+
* @memberof ForwardKinematicsRequest
|
|
1382
1580
|
*/
|
|
1383
|
-
'
|
|
1581
|
+
'motion_group_model': string;
|
|
1384
1582
|
/**
|
|
1385
|
-
*
|
|
1386
|
-
* @type {
|
|
1387
|
-
* @memberof
|
|
1583
|
+
* List of joint positions [rad] for which TCP poses are computed.
|
|
1584
|
+
* @type {Array<Array<number>>}
|
|
1585
|
+
* @memberof ForwardKinematicsRequest
|
|
1388
1586
|
*/
|
|
1389
|
-
'
|
|
1587
|
+
'joint_positions': Array<Array<number>>;
|
|
1390
1588
|
/**
|
|
1391
|
-
*
|
|
1392
|
-
* @type {
|
|
1393
|
-
* @memberof
|
|
1589
|
+
*
|
|
1590
|
+
* @type {Pose}
|
|
1591
|
+
* @memberof ForwardKinematicsRequest
|
|
1394
1592
|
*/
|
|
1395
|
-
'
|
|
1593
|
+
'tcp_offset'?: Pose;
|
|
1594
|
+
/**
|
|
1595
|
+
* Offset from the world frame to the motion group base.
|
|
1596
|
+
* @type {Pose}
|
|
1597
|
+
* @memberof ForwardKinematicsRequest
|
|
1598
|
+
*/
|
|
1599
|
+
'mounting'?: Pose;
|
|
1396
1600
|
}
|
|
1397
1601
|
/**
|
|
1398
1602
|
*
|
|
1399
1603
|
* @export
|
|
1400
|
-
* @interface
|
|
1604
|
+
* @interface ForwardKinematicsResponse
|
|
1401
1605
|
*/
|
|
1402
|
-
export interface
|
|
1606
|
+
export interface ForwardKinematicsResponse {
|
|
1403
1607
|
/**
|
|
1404
|
-
*
|
|
1405
|
-
* @type {Array<
|
|
1406
|
-
* @memberof
|
|
1608
|
+
* List of computed TCP poses corresponding to the input joint positions.
|
|
1609
|
+
* @type {Array<Pose>}
|
|
1610
|
+
* @memberof ForwardKinematicsResponse
|
|
1407
1611
|
*/
|
|
1408
|
-
'
|
|
1612
|
+
'tcp_poses': Array<Pose>;
|
|
1409
1613
|
}
|
|
1410
1614
|
/**
|
|
1411
|
-
*
|
|
1615
|
+
*
|
|
1412
1616
|
* @export
|
|
1413
|
-
* @interface
|
|
1617
|
+
* @interface ForwardKinematicsValidationError
|
|
1414
1618
|
*/
|
|
1415
|
-
export interface
|
|
1619
|
+
export interface ForwardKinematicsValidationError {
|
|
1416
1620
|
/**
|
|
1417
|
-
*
|
|
1418
|
-
* @type {
|
|
1621
|
+
*
|
|
1622
|
+
* @type {Array<ValidationErrorLocInner>}
|
|
1623
|
+
* @memberof ForwardKinematicsValidationError
|
|
1624
|
+
*/
|
|
1625
|
+
'loc': Array<ValidationErrorLocInner>;
|
|
1626
|
+
/**
|
|
1627
|
+
*
|
|
1628
|
+
* @type {string}
|
|
1629
|
+
* @memberof ForwardKinematicsValidationError
|
|
1630
|
+
*/
|
|
1631
|
+
'msg': string;
|
|
1632
|
+
/**
|
|
1633
|
+
*
|
|
1634
|
+
* @type {string}
|
|
1635
|
+
* @memberof ForwardKinematicsValidationError
|
|
1636
|
+
*/
|
|
1637
|
+
'type': string;
|
|
1638
|
+
/**
|
|
1639
|
+
*
|
|
1640
|
+
* @type {{ [key: string]: any; }}
|
|
1641
|
+
* @memberof ForwardKinematicsValidationError
|
|
1642
|
+
*/
|
|
1643
|
+
'input': {
|
|
1644
|
+
[key: string]: any;
|
|
1645
|
+
};
|
|
1646
|
+
/**
|
|
1647
|
+
*
|
|
1648
|
+
* @type {ErrorInvalidJointCount}
|
|
1649
|
+
* @memberof ForwardKinematicsValidationError
|
|
1650
|
+
*/
|
|
1651
|
+
'data'?: ErrorInvalidJointCount;
|
|
1652
|
+
}
|
|
1653
|
+
/**
|
|
1654
|
+
*
|
|
1655
|
+
* @export
|
|
1656
|
+
* @interface GetModeResponse
|
|
1657
|
+
*/
|
|
1658
|
+
export interface GetModeResponse {
|
|
1659
|
+
/**
|
|
1660
|
+
*
|
|
1661
|
+
* @type {RobotSystemMode}
|
|
1662
|
+
* @memberof GetModeResponse
|
|
1663
|
+
*/
|
|
1664
|
+
'robot_system_mode': RobotSystemMode;
|
|
1665
|
+
}
|
|
1666
|
+
/**
|
|
1667
|
+
*
|
|
1668
|
+
* @export
|
|
1669
|
+
* @interface GetTrajectoryResponse
|
|
1670
|
+
*/
|
|
1671
|
+
export interface GetTrajectoryResponse {
|
|
1672
|
+
/**
|
|
1673
|
+
* Unique identifier of the motion group the trajectory is planned for.
|
|
1674
|
+
* @type {string}
|
|
1675
|
+
* @memberof GetTrajectoryResponse
|
|
1676
|
+
*/
|
|
1677
|
+
'motion_group': string;
|
|
1678
|
+
/**
|
|
1679
|
+
* The trajectory consisting of a list of joint positions and an equal number of corresponding timestamps.
|
|
1680
|
+
* @type {JointTrajectory}
|
|
1681
|
+
* @memberof GetTrajectoryResponse
|
|
1682
|
+
*/
|
|
1683
|
+
'trajectory': JointTrajectory;
|
|
1684
|
+
/**
|
|
1685
|
+
* Unique identifier of the tool the trajectory is planned for.
|
|
1686
|
+
* @type {string}
|
|
1687
|
+
* @memberof GetTrajectoryResponse
|
|
1688
|
+
*/
|
|
1689
|
+
'tcp': string;
|
|
1690
|
+
}
|
|
1691
|
+
/**
|
|
1692
|
+
*
|
|
1693
|
+
* @export
|
|
1694
|
+
* @interface HTTPValidationError
|
|
1695
|
+
*/
|
|
1696
|
+
export interface HTTPValidationError {
|
|
1697
|
+
/**
|
|
1698
|
+
*
|
|
1699
|
+
* @type {Array<ValidationError>}
|
|
1700
|
+
* @memberof HTTPValidationError
|
|
1701
|
+
*/
|
|
1702
|
+
'detail'?: Array<ValidationError>;
|
|
1703
|
+
}
|
|
1704
|
+
/**
|
|
1705
|
+
* Input/Output boolean value representation.
|
|
1706
|
+
* @export
|
|
1707
|
+
* @interface IOBooleanValue
|
|
1708
|
+
*/
|
|
1709
|
+
export interface IOBooleanValue {
|
|
1710
|
+
/**
|
|
1711
|
+
* Unique identifier of the input/output.
|
|
1712
|
+
* @type {string}
|
|
1419
1713
|
* @memberof IOBooleanValue
|
|
1420
1714
|
*/
|
|
1421
1715
|
'io': string;
|
|
@@ -1860,6 +2154,19 @@ export interface InvalidDofInvalidDof {
|
|
|
1860
2154
|
*/
|
|
1861
2155
|
'joint_position'?: Array<number>;
|
|
1862
2156
|
}
|
|
2157
|
+
/**
|
|
2158
|
+
*
|
|
2159
|
+
* @export
|
|
2160
|
+
* @interface InverseKinematics422Response
|
|
2161
|
+
*/
|
|
2162
|
+
export interface InverseKinematics422Response {
|
|
2163
|
+
/**
|
|
2164
|
+
*
|
|
2165
|
+
* @type {Array<InverseKinematicsValidationError>}
|
|
2166
|
+
* @memberof InverseKinematics422Response
|
|
2167
|
+
*/
|
|
2168
|
+
'detail'?: Array<InverseKinematicsValidationError>;
|
|
2169
|
+
}
|
|
1863
2170
|
/**
|
|
1864
2171
|
*
|
|
1865
2172
|
* @export
|
|
@@ -1897,12 +2204,12 @@ export interface InverseKinematicsRequest {
|
|
|
1897
2204
|
*/
|
|
1898
2205
|
'joint_position_limits'?: Array<LimitRange>;
|
|
1899
2206
|
/**
|
|
1900
|
-
* Collision
|
|
1901
|
-
* @type {{ [key: string]:
|
|
2207
|
+
* Collision layers to be respected by the motion planner when planning for a single motion group. Each setup represents one layer, e.g. the safety zones and shapes or a fine grained tool and workpiece model. Layers are checked individually along the trajectory and independently of other layers. To respect the safety zones of the controller and check for collision: 1. Fetch the safety zones, link and tool shapes from the controller. 2. Add the fetched zones, links and tools to a layer. 3. Create other layers from your own 3D data as needed. 4. Plan trajectory. 5. The response highlights the layer in which a collision was detected by key.
|
|
2208
|
+
* @type {{ [key: string]: CollisionSetup; }}
|
|
1902
2209
|
* @memberof InverseKinematicsRequest
|
|
1903
2210
|
*/
|
|
1904
|
-
'
|
|
1905
|
-
[key: string]:
|
|
2211
|
+
'collision_setups'?: {
|
|
2212
|
+
[key: string]: CollisionSetup;
|
|
1906
2213
|
};
|
|
1907
2214
|
}
|
|
1908
2215
|
/**
|
|
@@ -1918,6 +2225,55 @@ export interface InverseKinematicsResponse {
|
|
|
1918
2225
|
*/
|
|
1919
2226
|
'joints': Array<Array<Array<number>>>;
|
|
1920
2227
|
}
|
|
2228
|
+
/**
|
|
2229
|
+
*
|
|
2230
|
+
* @export
|
|
2231
|
+
* @interface InverseKinematicsValidationError
|
|
2232
|
+
*/
|
|
2233
|
+
export interface InverseKinematicsValidationError {
|
|
2234
|
+
/**
|
|
2235
|
+
*
|
|
2236
|
+
* @type {Array<ValidationErrorLocInner>}
|
|
2237
|
+
* @memberof InverseKinematicsValidationError
|
|
2238
|
+
*/
|
|
2239
|
+
'loc': Array<ValidationErrorLocInner>;
|
|
2240
|
+
/**
|
|
2241
|
+
*
|
|
2242
|
+
* @type {string}
|
|
2243
|
+
* @memberof InverseKinematicsValidationError
|
|
2244
|
+
*/
|
|
2245
|
+
'msg': string;
|
|
2246
|
+
/**
|
|
2247
|
+
*
|
|
2248
|
+
* @type {string}
|
|
2249
|
+
* @memberof InverseKinematicsValidationError
|
|
2250
|
+
*/
|
|
2251
|
+
'type': string;
|
|
2252
|
+
/**
|
|
2253
|
+
*
|
|
2254
|
+
* @type {{ [key: string]: any; }}
|
|
2255
|
+
* @memberof InverseKinematicsValidationError
|
|
2256
|
+
*/
|
|
2257
|
+
'input': {
|
|
2258
|
+
[key: string]: any;
|
|
2259
|
+
};
|
|
2260
|
+
/**
|
|
2261
|
+
*
|
|
2262
|
+
* @type {InverseKinematicsValidationErrorAllOfData}
|
|
2263
|
+
* @memberof InverseKinematicsValidationError
|
|
2264
|
+
*/
|
|
2265
|
+
'data'?: InverseKinematicsValidationErrorAllOfData;
|
|
2266
|
+
}
|
|
2267
|
+
/**
|
|
2268
|
+
* @type InverseKinematicsValidationErrorAllOfData
|
|
2269
|
+
* Optional data further specifying the validation error.
|
|
2270
|
+
* @export
|
|
2271
|
+
*/
|
|
2272
|
+
export type InverseKinematicsValidationErrorAllOfData = {
|
|
2273
|
+
error_feedback_name: 'ErrorInvalidJointCount';
|
|
2274
|
+
} & ErrorInvalidJointCount | {
|
|
2275
|
+
error_feedback_name: 'ErrorJointLimitExceeded';
|
|
2276
|
+
} & ErrorJointLimitExceeded;
|
|
1921
2277
|
/**
|
|
1922
2278
|
* State of jogging execution. This state is sent during jogging movement, response-rate closest to the nearest multiple of controller step-rate but not exceeding the configured rate. The jogging state can be one of the following: - RUNNING: Jogging is active. - PAUSED_BY_USER: User has paused jogging. - PAUSED_NEAR_JOINT_LIMIT: Jogging was paused because a joint is is near its limit. - PAUSED_NEAR_COLLISION: Jogging was paused because the motion group neared a collision. - PAUSED_ON_IO: Jogging was paused because of an I/O event.
|
|
1923
2279
|
* @export
|
|
@@ -2464,6 +2820,29 @@ export declare const Manufacturer: {
|
|
|
2464
2820
|
readonly Yaskawa: "yaskawa";
|
|
2465
2821
|
};
|
|
2466
2822
|
export type Manufacturer = typeof Manufacturer[keyof typeof Manufacturer];
|
|
2823
|
+
/**
|
|
2824
|
+
* Midpoint insertion algorithm configuration for collision-free path planning. This algorithm iteratively inserts midpoints between the start and target joint position to find collision-free paths.
|
|
2825
|
+
* @export
|
|
2826
|
+
* @interface MidpointInsertionAlgorithm
|
|
2827
|
+
*/
|
|
2828
|
+
export interface MidpointInsertionAlgorithm {
|
|
2829
|
+
/**
|
|
2830
|
+
* Algorithm discriminator.
|
|
2831
|
+
* @type {string}
|
|
2832
|
+
* @memberof MidpointInsertionAlgorithm
|
|
2833
|
+
*/
|
|
2834
|
+
'algorithm_name': MidpointInsertionAlgorithmAlgorithmNameEnum;
|
|
2835
|
+
/**
|
|
2836
|
+
* Maximum number of iterations for the midpoint insertion algorithm. Higher values increase likelyhood of success, but also computation time (linear).
|
|
2837
|
+
* @type {number}
|
|
2838
|
+
* @memberof MidpointInsertionAlgorithm
|
|
2839
|
+
*/
|
|
2840
|
+
'max_iterations'?: number;
|
|
2841
|
+
}
|
|
2842
|
+
export declare const MidpointInsertionAlgorithmAlgorithmNameEnum: {
|
|
2843
|
+
readonly MidpointInsertionAlgorithm: "MidpointInsertionAlgorithm";
|
|
2844
|
+
};
|
|
2845
|
+
export type MidpointInsertionAlgorithmAlgorithmNameEnum = typeof MidpointInsertionAlgorithmAlgorithmNameEnum[keyof typeof MidpointInsertionAlgorithmAlgorithmNameEnum];
|
|
2467
2846
|
/**
|
|
2468
2847
|
*
|
|
2469
2848
|
* @export
|
|
@@ -2654,6 +3033,57 @@ export interface MotionGroupJoints {
|
|
|
2654
3033
|
*/
|
|
2655
3034
|
'torques'?: Array<number>;
|
|
2656
3035
|
}
|
|
3036
|
+
/**
|
|
3037
|
+
*
|
|
3038
|
+
* @export
|
|
3039
|
+
* @interface MotionGroupSetup
|
|
3040
|
+
*/
|
|
3041
|
+
export interface MotionGroupSetup {
|
|
3042
|
+
/**
|
|
3043
|
+
* String identifiying the model of a motion group.
|
|
3044
|
+
* @type {string}
|
|
3045
|
+
* @memberof MotionGroupSetup
|
|
3046
|
+
*/
|
|
3047
|
+
'motion_group_model': string;
|
|
3048
|
+
/**
|
|
3049
|
+
* [ms] cycle time of the motion group controller. A trajectory for this motion group should be computed to this resolution.
|
|
3050
|
+
* @type {number}
|
|
3051
|
+
* @memberof MotionGroupSetup
|
|
3052
|
+
*/
|
|
3053
|
+
'cycle_time': number;
|
|
3054
|
+
/**
|
|
3055
|
+
* The offset from the world frame to the motion group base.
|
|
3056
|
+
* @type {Pose}
|
|
3057
|
+
* @memberof MotionGroupSetup
|
|
3058
|
+
*/
|
|
3059
|
+
'mounting'?: Pose;
|
|
3060
|
+
/**
|
|
3061
|
+
*
|
|
3062
|
+
* @type {Pose}
|
|
3063
|
+
* @memberof MotionGroupSetup
|
|
3064
|
+
*/
|
|
3065
|
+
'tcp_offset'?: Pose;
|
|
3066
|
+
/**
|
|
3067
|
+
*
|
|
3068
|
+
* @type {LimitSet}
|
|
3069
|
+
* @memberof MotionGroupSetup
|
|
3070
|
+
*/
|
|
3071
|
+
'global_limits'?: LimitSet;
|
|
3072
|
+
/**
|
|
3073
|
+
*
|
|
3074
|
+
* @type {Payload}
|
|
3075
|
+
* @memberof MotionGroupSetup
|
|
3076
|
+
*/
|
|
3077
|
+
'payload'?: Payload;
|
|
3078
|
+
/**
|
|
3079
|
+
* Collision layers to be respected by the motion planner when planning for a single motion group. Each setup represents one layer, e.g. the safety zones and shapes or a fine grained tool and workpiece model. Layers are checked individually along the trajectory and independently of other layers. To respect the safety zones of the controller and check for collision: 1. Fetch the safety zones, link and tool shapes from the controller. 2. Add the fetched zones, links and tools to a layer. 3. Create other layers from your own 3D data as needed. 4. Plan trajectory. 5. The response highlights the layer in which a collision was detected by key.
|
|
3080
|
+
* @type {{ [key: string]: CollisionSetup; }}
|
|
3081
|
+
* @memberof MotionGroupSetup
|
|
3082
|
+
*/
|
|
3083
|
+
'collision_setups'?: {
|
|
3084
|
+
[key: string]: CollisionSetup;
|
|
3085
|
+
};
|
|
3086
|
+
}
|
|
2657
3087
|
/**
|
|
2658
3088
|
* Presents the current state of the motion group.
|
|
2659
3089
|
* @export
|
|
@@ -3170,6 +3600,81 @@ export interface Payload {
|
|
|
3170
3600
|
*/
|
|
3171
3601
|
'moment_of_inertia'?: Array<number>;
|
|
3172
3602
|
}
|
|
3603
|
+
/**
|
|
3604
|
+
*
|
|
3605
|
+
* @export
|
|
3606
|
+
* @interface Plan422Response
|
|
3607
|
+
*/
|
|
3608
|
+
export interface Plan422Response {
|
|
3609
|
+
/**
|
|
3610
|
+
*
|
|
3611
|
+
* @type {Array<PlanValidationError>}
|
|
3612
|
+
* @memberof Plan422Response
|
|
3613
|
+
*/
|
|
3614
|
+
'detail'?: Array<PlanValidationError>;
|
|
3615
|
+
}
|
|
3616
|
+
/**
|
|
3617
|
+
* Response when collision-free trajectory planning fails. Contains specific feedback about why the planning failed.
|
|
3618
|
+
* @export
|
|
3619
|
+
* @interface PlanCollisionFreeFailedResponse
|
|
3620
|
+
*/
|
|
3621
|
+
export interface PlanCollisionFreeFailedResponse {
|
|
3622
|
+
/**
|
|
3623
|
+
*
|
|
3624
|
+
* @type {ErrorMaxIterationsExceeded}
|
|
3625
|
+
* @memberof PlanCollisionFreeFailedResponse
|
|
3626
|
+
*/
|
|
3627
|
+
'error_feedback': ErrorMaxIterationsExceeded;
|
|
3628
|
+
}
|
|
3629
|
+
/**
|
|
3630
|
+
*
|
|
3631
|
+
* @export
|
|
3632
|
+
* @interface PlanCollisionFreeRequest
|
|
3633
|
+
*/
|
|
3634
|
+
export interface PlanCollisionFreeRequest {
|
|
3635
|
+
/**
|
|
3636
|
+
* The data to assemble the robot setup can be retrieved from [getMotionGroupDescription](getMotionGroupDescription) endpoint.
|
|
3637
|
+
* @type {MotionGroupSetup}
|
|
3638
|
+
* @memberof PlanCollisionFreeRequest
|
|
3639
|
+
*/
|
|
3640
|
+
'motion_group_setup': MotionGroupSetup;
|
|
3641
|
+
/**
|
|
3642
|
+
*
|
|
3643
|
+
* @type {Array<number>}
|
|
3644
|
+
* @memberof PlanCollisionFreeRequest
|
|
3645
|
+
*/
|
|
3646
|
+
'start_joint_position': Array<number>;
|
|
3647
|
+
/**
|
|
3648
|
+
*
|
|
3649
|
+
* @type {Array<number>}
|
|
3650
|
+
* @memberof PlanCollisionFreeRequest
|
|
3651
|
+
*/
|
|
3652
|
+
'target': Array<number>;
|
|
3653
|
+
/**
|
|
3654
|
+
*
|
|
3655
|
+
* @type {CollisionFreeAlgorithm}
|
|
3656
|
+
* @memberof PlanCollisionFreeRequest
|
|
3657
|
+
*/
|
|
3658
|
+
'algorithm': CollisionFreeAlgorithm;
|
|
3659
|
+
}
|
|
3660
|
+
/**
|
|
3661
|
+
* Response from collision-free trajectory planning. Contains either a successful joint trajectory or failure information.
|
|
3662
|
+
* @export
|
|
3663
|
+
* @interface PlanCollisionFreeResponse
|
|
3664
|
+
*/
|
|
3665
|
+
export interface PlanCollisionFreeResponse {
|
|
3666
|
+
/**
|
|
3667
|
+
*
|
|
3668
|
+
* @type {PlanCollisionFreeResponseResponse}
|
|
3669
|
+
* @memberof PlanCollisionFreeResponse
|
|
3670
|
+
*/
|
|
3671
|
+
'response': PlanCollisionFreeResponseResponse;
|
|
3672
|
+
}
|
|
3673
|
+
/**
|
|
3674
|
+
* @type PlanCollisionFreeResponseResponse
|
|
3675
|
+
* @export
|
|
3676
|
+
*/
|
|
3677
|
+
export type PlanCollisionFreeResponseResponse = JointTrajectory | PlanCollisionFreeFailedResponse;
|
|
3173
3678
|
/**
|
|
3174
3679
|
*
|
|
3175
3680
|
* @export
|
|
@@ -3208,10 +3713,10 @@ export type PlanTrajectoryFailedResponseErrorFeedback = FeedbackCollision | Feed
|
|
|
3208
3713
|
export interface PlanTrajectoryRequest {
|
|
3209
3714
|
/**
|
|
3210
3715
|
* The data to assemble the robot setup can be retrieved from [getMotionGroupDescription](getMotionGroupDescription) endpoint.
|
|
3211
|
-
* @type {
|
|
3716
|
+
* @type {MotionGroupSetup}
|
|
3212
3717
|
* @memberof PlanTrajectoryRequest
|
|
3213
3718
|
*/
|
|
3214
|
-
'
|
|
3719
|
+
'motion_group_setup': MotionGroupSetup;
|
|
3215
3720
|
/**
|
|
3216
3721
|
*
|
|
3217
3722
|
* @type {Array<number>}
|
|
@@ -3243,6 +3748,57 @@ export interface PlanTrajectoryResponse {
|
|
|
3243
3748
|
* @export
|
|
3244
3749
|
*/
|
|
3245
3750
|
export type PlanTrajectoryResponseResponse = JointTrajectory | PlanTrajectoryFailedResponse;
|
|
3751
|
+
/**
|
|
3752
|
+
*
|
|
3753
|
+
* @export
|
|
3754
|
+
* @interface PlanValidationError
|
|
3755
|
+
*/
|
|
3756
|
+
export interface PlanValidationError {
|
|
3757
|
+
/**
|
|
3758
|
+
*
|
|
3759
|
+
* @type {Array<ValidationErrorLocInner>}
|
|
3760
|
+
* @memberof PlanValidationError
|
|
3761
|
+
*/
|
|
3762
|
+
'loc': Array<ValidationErrorLocInner>;
|
|
3763
|
+
/**
|
|
3764
|
+
*
|
|
3765
|
+
* @type {string}
|
|
3766
|
+
* @memberof PlanValidationError
|
|
3767
|
+
*/
|
|
3768
|
+
'msg': string;
|
|
3769
|
+
/**
|
|
3770
|
+
*
|
|
3771
|
+
* @type {string}
|
|
3772
|
+
* @memberof PlanValidationError
|
|
3773
|
+
*/
|
|
3774
|
+
'type': string;
|
|
3775
|
+
/**
|
|
3776
|
+
*
|
|
3777
|
+
* @type {{ [key: string]: any; }}
|
|
3778
|
+
* @memberof PlanValidationError
|
|
3779
|
+
*/
|
|
3780
|
+
'input': {
|
|
3781
|
+
[key: string]: any;
|
|
3782
|
+
};
|
|
3783
|
+
/**
|
|
3784
|
+
*
|
|
3785
|
+
* @type {PlanValidationErrorAllOfData}
|
|
3786
|
+
* @memberof PlanValidationError
|
|
3787
|
+
*/
|
|
3788
|
+
'data'?: PlanValidationErrorAllOfData;
|
|
3789
|
+
}
|
|
3790
|
+
/**
|
|
3791
|
+
* @type PlanValidationErrorAllOfData
|
|
3792
|
+
* Optional data further specifying the validation error.
|
|
3793
|
+
* @export
|
|
3794
|
+
*/
|
|
3795
|
+
export type PlanValidationErrorAllOfData = {
|
|
3796
|
+
error_feedback_name: 'ErrorInvalidJointCount';
|
|
3797
|
+
} & ErrorInvalidJointCount | {
|
|
3798
|
+
error_feedback_name: 'ErrorJointLimitExceeded';
|
|
3799
|
+
} & ErrorJointLimitExceeded | {
|
|
3800
|
+
error_feedback_name: 'ErrorJointPositionCollision';
|
|
3801
|
+
} & ErrorJointPositionCollision;
|
|
3246
3802
|
/**
|
|
3247
3803
|
* Defines an x/y-plane with infinite size.
|
|
3248
3804
|
* @export
|
|
@@ -3326,23 +3882,267 @@ export interface Pose {
|
|
|
3326
3882
|
'orientation'?: Array<number>;
|
|
3327
3883
|
}
|
|
3328
3884
|
/**
|
|
3329
|
-
*
|
|
3885
|
+
*
|
|
3330
3886
|
* @export
|
|
3331
|
-
* @interface
|
|
3887
|
+
* @interface ProfinetDescription
|
|
3332
3888
|
*/
|
|
3333
|
-
export interface
|
|
3889
|
+
export interface ProfinetDescription {
|
|
3334
3890
|
/**
|
|
3335
|
-
*
|
|
3891
|
+
* The vendor identifier of the PROFINET device, identifying the manufacturer.
|
|
3336
3892
|
* @type {string}
|
|
3337
|
-
* @memberof
|
|
3893
|
+
* @memberof ProfinetDescription
|
|
3338
3894
|
*/
|
|
3339
|
-
'
|
|
3895
|
+
'vendor_id': string;
|
|
3340
3896
|
/**
|
|
3341
|
-
* The
|
|
3342
|
-
* @type {
|
|
3343
|
-
* @memberof
|
|
3897
|
+
* The device identifier of the PROFINET device, identifying the specific device within the vendor\'s range.
|
|
3898
|
+
* @type {string}
|
|
3899
|
+
* @memberof ProfinetDescription
|
|
3344
3900
|
*/
|
|
3345
|
-
'
|
|
3901
|
+
'device_id': string;
|
|
3902
|
+
/**
|
|
3903
|
+
*
|
|
3904
|
+
* @type {Array<ProfinetSlotDescription>}
|
|
3905
|
+
* @memberof ProfinetDescription
|
|
3906
|
+
*/
|
|
3907
|
+
'slots'?: Array<ProfinetSlotDescription>;
|
|
3908
|
+
/**
|
|
3909
|
+
* Name of the PROFINET device
|
|
3910
|
+
* @type {string}
|
|
3911
|
+
* @memberof ProfinetDescription
|
|
3912
|
+
*/
|
|
3913
|
+
'device_name'?: string;
|
|
3914
|
+
/**
|
|
3915
|
+
* IP address for the PROFINET device
|
|
3916
|
+
* @type {string}
|
|
3917
|
+
* @memberof ProfinetDescription
|
|
3918
|
+
*/
|
|
3919
|
+
'ip'?: string;
|
|
3920
|
+
}
|
|
3921
|
+
/**
|
|
3922
|
+
*
|
|
3923
|
+
* @export
|
|
3924
|
+
* @interface ProfinetIO
|
|
3925
|
+
*/
|
|
3926
|
+
export interface ProfinetIO {
|
|
3927
|
+
/**
|
|
3928
|
+
* The name of the input/output value. This is a human-readable identifier for the value. It can be used to distinguish between different inputs/outputs in the system.
|
|
3929
|
+
* @type {string}
|
|
3930
|
+
* @memberof ProfinetIO
|
|
3931
|
+
*/
|
|
3932
|
+
'name': string;
|
|
3933
|
+
/**
|
|
3934
|
+
*
|
|
3935
|
+
* @type {ProfinetIOTypeEnum}
|
|
3936
|
+
* @memberof ProfinetIO
|
|
3937
|
+
*/
|
|
3938
|
+
'type': ProfinetIOTypeEnum;
|
|
3939
|
+
/**
|
|
3940
|
+
* The direction of the input/output value, indicating whether it is an input or output for the device.
|
|
3941
|
+
* @type {ProfinetIODirection}
|
|
3942
|
+
* @memberof ProfinetIO
|
|
3943
|
+
*/
|
|
3944
|
+
'direction': ProfinetIODirection;
|
|
3945
|
+
/**
|
|
3946
|
+
* The byte address of the input/output value in the PROFINET device. The byte address is used to locate the specific input/output within the device\'s memory or data structure.
|
|
3947
|
+
* @type {number}
|
|
3948
|
+
* @memberof ProfinetIO
|
|
3949
|
+
*/
|
|
3950
|
+
'byte_address': number;
|
|
3951
|
+
/**
|
|
3952
|
+
* The bit address of the input/output value within the byte or word address. The bit address is used to specify the exact bit within the byte or word that corresponds to the input/output value.
|
|
3953
|
+
* @type {number}
|
|
3954
|
+
* @memberof ProfinetIO
|
|
3955
|
+
*/
|
|
3956
|
+
'bit_address'?: number;
|
|
3957
|
+
/**
|
|
3958
|
+
* The unique identifier for the input/output value. This identifier is used to reference the specific input/output in the NOVA system.
|
|
3959
|
+
* @type {string}
|
|
3960
|
+
* @memberof ProfinetIO
|
|
3961
|
+
*/
|
|
3962
|
+
'io': string;
|
|
3963
|
+
}
|
|
3964
|
+
/**
|
|
3965
|
+
*
|
|
3966
|
+
* @export
|
|
3967
|
+
* @interface ProfinetIOData
|
|
3968
|
+
*/
|
|
3969
|
+
export interface ProfinetIOData {
|
|
3970
|
+
/**
|
|
3971
|
+
* The name of the input/output value. This is a human-readable identifier for the value. It can be used to distinguish between different inputs/outputs in the system.
|
|
3972
|
+
* @type {string}
|
|
3973
|
+
* @memberof ProfinetIOData
|
|
3974
|
+
*/
|
|
3975
|
+
'name': string;
|
|
3976
|
+
/**
|
|
3977
|
+
*
|
|
3978
|
+
* @type {ProfinetIOTypeEnum}
|
|
3979
|
+
* @memberof ProfinetIOData
|
|
3980
|
+
*/
|
|
3981
|
+
'type': ProfinetIOTypeEnum;
|
|
3982
|
+
/**
|
|
3983
|
+
* The direction of the input/output value, indicating whether it is an input or output for the device.
|
|
3984
|
+
* @type {ProfinetIODirection}
|
|
3985
|
+
* @memberof ProfinetIOData
|
|
3986
|
+
*/
|
|
3987
|
+
'direction': ProfinetIODirection;
|
|
3988
|
+
/**
|
|
3989
|
+
* The byte address of the input/output value in the PROFINET device. The byte address is used to locate the specific input/output within the device\'s memory or data structure.
|
|
3990
|
+
* @type {number}
|
|
3991
|
+
* @memberof ProfinetIOData
|
|
3992
|
+
*/
|
|
3993
|
+
'byte_address': number;
|
|
3994
|
+
/**
|
|
3995
|
+
* The bit address of the input/output value within the byte or word address. The bit address is used to specify the exact bit within the byte or word that corresponds to the input/output value.
|
|
3996
|
+
* @type {number}
|
|
3997
|
+
* @memberof ProfinetIOData
|
|
3998
|
+
*/
|
|
3999
|
+
'bit_address'?: number;
|
|
4000
|
+
}
|
|
4001
|
+
/**
|
|
4002
|
+
* Identifies the input/output type.
|
|
4003
|
+
* @export
|
|
4004
|
+
* @enum {string}
|
|
4005
|
+
*/
|
|
4006
|
+
export declare const ProfinetIODirection: {
|
|
4007
|
+
readonly ProfinetIoDirectionInput: "PROFINET_IO_DIRECTION_INPUT";
|
|
4008
|
+
readonly ProfinetIoDirectionOutput: "PROFINET_IO_DIRECTION_OUTPUT";
|
|
4009
|
+
readonly ProfinetIoDirectionInout: "PROFINET_IO_DIRECTION_INOUT";
|
|
4010
|
+
};
|
|
4011
|
+
export type ProfinetIODirection = typeof ProfinetIODirection[keyof typeof ProfinetIODirection];
|
|
4012
|
+
/**
|
|
4013
|
+
* Value type of the PROFINET input/output.
|
|
4014
|
+
* @export
|
|
4015
|
+
* @enum {string}
|
|
4016
|
+
*/
|
|
4017
|
+
export declare const ProfinetIOTypeEnum: {
|
|
4018
|
+
readonly ProfinetIoTypeUnknown: "PROFINET_IO_TYPE_UNKNOWN";
|
|
4019
|
+
readonly ProfinetIoTypeBool: "PROFINET_IO_TYPE_BOOL";
|
|
4020
|
+
readonly ProfinetIoTypeUsint: "PROFINET_IO_TYPE_USINT";
|
|
4021
|
+
readonly ProfinetIoTypeSint: "PROFINET_IO_TYPE_SINT";
|
|
4022
|
+
readonly ProfinetIoTypeUint: "PROFINET_IO_TYPE_UINT";
|
|
4023
|
+
readonly ProfinetIoTypeInt: "PROFINET_IO_TYPE_INT";
|
|
4024
|
+
readonly ProfinetIoTypeUdint: "PROFINET_IO_TYPE_UDINT";
|
|
4025
|
+
readonly ProfinetIoTypeDint: "PROFINET_IO_TYPE_DINT";
|
|
4026
|
+
readonly ProfinetIoTypeReal: "PROFINET_IO_TYPE_REAL";
|
|
4027
|
+
readonly ProfinetIoTypeLreal: "PROFINET_IO_TYPE_LREAL";
|
|
4028
|
+
};
|
|
4029
|
+
export type ProfinetIOTypeEnum = typeof ProfinetIOTypeEnum[keyof typeof ProfinetIOTypeEnum];
|
|
4030
|
+
/**
|
|
4031
|
+
*
|
|
4032
|
+
* @export
|
|
4033
|
+
* @interface ProfinetInputOutputConfig
|
|
4034
|
+
*/
|
|
4035
|
+
export interface ProfinetInputOutputConfig {
|
|
4036
|
+
/**
|
|
4037
|
+
* Content of the input output configuration file.
|
|
4038
|
+
* @type {string}
|
|
4039
|
+
* @memberof ProfinetInputOutputConfig
|
|
4040
|
+
*/
|
|
4041
|
+
'config': string;
|
|
4042
|
+
/**
|
|
4043
|
+
* Offset in bytes for the input data.
|
|
4044
|
+
* @type {number}
|
|
4045
|
+
* @memberof ProfinetInputOutputConfig
|
|
4046
|
+
*/
|
|
4047
|
+
'input_offset': number;
|
|
4048
|
+
/**
|
|
4049
|
+
* Offset in bytes for the output data.
|
|
4050
|
+
* @type {number}
|
|
4051
|
+
* @memberof ProfinetInputOutputConfig
|
|
4052
|
+
*/
|
|
4053
|
+
'output_offset': number;
|
|
4054
|
+
}
|
|
4055
|
+
/**
|
|
4056
|
+
*
|
|
4057
|
+
* @export
|
|
4058
|
+
* @interface ProfinetSlotDescription
|
|
4059
|
+
*/
|
|
4060
|
+
export interface ProfinetSlotDescription {
|
|
4061
|
+
/**
|
|
4062
|
+
* The number of the PROFINET slot.
|
|
4063
|
+
* @type {number}
|
|
4064
|
+
* @memberof ProfinetSlotDescription
|
|
4065
|
+
*/
|
|
4066
|
+
'number': number;
|
|
4067
|
+
/**
|
|
4068
|
+
* The API number of the PROFINET input, used to identify the specific API for the input.
|
|
4069
|
+
* @type {number}
|
|
4070
|
+
* @memberof ProfinetSlotDescription
|
|
4071
|
+
*/
|
|
4072
|
+
'api': number;
|
|
4073
|
+
/**
|
|
4074
|
+
* An array of PROFINET subslots.
|
|
4075
|
+
* @type {Array<ProfinetSubSlotDescription>}
|
|
4076
|
+
* @memberof ProfinetSlotDescription
|
|
4077
|
+
*/
|
|
4078
|
+
'subslots': Array<ProfinetSubSlotDescription>;
|
|
4079
|
+
}
|
|
4080
|
+
/**
|
|
4081
|
+
*
|
|
4082
|
+
* @export
|
|
4083
|
+
* @interface ProfinetSubSlotDescription
|
|
4084
|
+
*/
|
|
4085
|
+
export interface ProfinetSubSlotDescription {
|
|
4086
|
+
/**
|
|
4087
|
+
* The identifier of the PROFINET subslot.
|
|
4088
|
+
* @type {number}
|
|
4089
|
+
* @memberof ProfinetSubSlotDescription
|
|
4090
|
+
*/
|
|
4091
|
+
'number': number;
|
|
4092
|
+
/**
|
|
4093
|
+
* The length in bytes of the PROFINET input.
|
|
4094
|
+
* @type {number}
|
|
4095
|
+
* @memberof ProfinetSubSlotDescription
|
|
4096
|
+
*/
|
|
4097
|
+
'input_length': number;
|
|
4098
|
+
/**
|
|
4099
|
+
* The length in bytes of the PROFINET output.
|
|
4100
|
+
* @type {number}
|
|
4101
|
+
* @memberof ProfinetSubSlotDescription
|
|
4102
|
+
*/
|
|
4103
|
+
'output_length': number;
|
|
4104
|
+
}
|
|
4105
|
+
/**
|
|
4106
|
+
* <!-- theme: danger --> > **Experimental** RRT Connect algorithm configuration for collision-free path planning. Rapidly-exploring Random Trees (RRT) builds trees of valid configurations by randomly sampling the joint space and connecting feasible points. RRT Connect grows two trees simultaneously from start and target positions until they meet. This is a custom implementation optimized for manipulator kinematics and collision checking in industrial contexts.
|
|
4107
|
+
* @export
|
|
4108
|
+
* @interface RRTConnectAlgorithm
|
|
4109
|
+
*/
|
|
4110
|
+
export interface RRTConnectAlgorithm {
|
|
4111
|
+
/**
|
|
4112
|
+
* Algorithm discriminator.
|
|
4113
|
+
* @type {string}
|
|
4114
|
+
* @memberof RRTConnectAlgorithm
|
|
4115
|
+
*/
|
|
4116
|
+
'algorithm_name': RRTConnectAlgorithmAlgorithmNameEnum;
|
|
4117
|
+
/**
|
|
4118
|
+
* Maximum number of iterations for the RRT Connect algorithm. Higher values increase likelihood of success, but also computation time.
|
|
4119
|
+
* @type {number}
|
|
4120
|
+
* @memberof RRTConnectAlgorithm
|
|
4121
|
+
*/
|
|
4122
|
+
'max_iterations'?: number;
|
|
4123
|
+
}
|
|
4124
|
+
export declare const RRTConnectAlgorithmAlgorithmNameEnum: {
|
|
4125
|
+
readonly RrtConnectAlgorithm: "RRTConnectAlgorithm";
|
|
4126
|
+
};
|
|
4127
|
+
export type RRTConnectAlgorithmAlgorithmNameEnum = typeof RRTConnectAlgorithmAlgorithmNameEnum[keyof typeof RRTConnectAlgorithmAlgorithmNameEnum];
|
|
4128
|
+
/**
|
|
4129
|
+
* Defines an x/y-plane with finite size. Centred around the z-axis.
|
|
4130
|
+
* @export
|
|
4131
|
+
* @interface Rectangle
|
|
4132
|
+
*/
|
|
4133
|
+
export interface Rectangle {
|
|
4134
|
+
/**
|
|
4135
|
+
*
|
|
4136
|
+
* @type {string}
|
|
4137
|
+
* @memberof Rectangle
|
|
4138
|
+
*/
|
|
4139
|
+
'shape_type': RectangleShapeTypeEnum;
|
|
4140
|
+
/**
|
|
4141
|
+
* The dimension in x-direction in [mm].
|
|
4142
|
+
* @type {number}
|
|
4143
|
+
* @memberof Rectangle
|
|
4144
|
+
*/
|
|
4145
|
+
'size_x': number;
|
|
3346
4146
|
/**
|
|
3347
4147
|
* The dimension in y-direction in [mm].
|
|
3348
4148
|
* @type {number}
|
|
@@ -3472,57 +4272,6 @@ export interface RobotControllerState {
|
|
|
3472
4272
|
*/
|
|
3473
4273
|
'motion_groups': Array<MotionGroupState>;
|
|
3474
4274
|
}
|
|
3475
|
-
/**
|
|
3476
|
-
*
|
|
3477
|
-
* @export
|
|
3478
|
-
* @interface RobotSetup
|
|
3479
|
-
*/
|
|
3480
|
-
export interface RobotSetup {
|
|
3481
|
-
/**
|
|
3482
|
-
* String identifiying the model of a motion group.
|
|
3483
|
-
* @type {string}
|
|
3484
|
-
* @memberof RobotSetup
|
|
3485
|
-
*/
|
|
3486
|
-
'motion_group_model': string;
|
|
3487
|
-
/**
|
|
3488
|
-
* [ms] cycle time of the motion group controller. A trajectory for this motion group should be computed to this resolution.
|
|
3489
|
-
* @type {number}
|
|
3490
|
-
* @memberof RobotSetup
|
|
3491
|
-
*/
|
|
3492
|
-
'cycle_time': number;
|
|
3493
|
-
/**
|
|
3494
|
-
* The offset from the world frame to the motion group base.
|
|
3495
|
-
* @type {Pose}
|
|
3496
|
-
* @memberof RobotSetup
|
|
3497
|
-
*/
|
|
3498
|
-
'mounting'?: Pose;
|
|
3499
|
-
/**
|
|
3500
|
-
*
|
|
3501
|
-
* @type {Pose}
|
|
3502
|
-
* @memberof RobotSetup
|
|
3503
|
-
*/
|
|
3504
|
-
'tcp_offset'?: Pose;
|
|
3505
|
-
/**
|
|
3506
|
-
*
|
|
3507
|
-
* @type {LimitSet}
|
|
3508
|
-
* @memberof RobotSetup
|
|
3509
|
-
*/
|
|
3510
|
-
'global_limits'?: LimitSet;
|
|
3511
|
-
/**
|
|
3512
|
-
*
|
|
3513
|
-
* @type {Payload}
|
|
3514
|
-
* @memberof RobotSetup
|
|
3515
|
-
*/
|
|
3516
|
-
'payload'?: Payload;
|
|
3517
|
-
/**
|
|
3518
|
-
* Collision scenes to be respected by the motion planner. Each contains the single motion group which is planned for. Scenes are checked individually along the trajectory and independently of other scenes. To respect the safety zones of the controller, fetch the safety zones, link and tool shapes from the controller and add one scene made up of those. To respect the safety zones of the controller and check for collision: 1. Fetch the safety zones, link and tool shapes from the controller. 2. Add the fetched zones, links and tools to a scene. 3. Create other scenes from your own 3D data as needed. 4. Execute this endpoint. 5. The response highlights the scenes in which a collision was detected by key.
|
|
3519
|
-
* @type {{ [key: string]: SingleMotionGroupCollisionScene; }}
|
|
3520
|
-
* @memberof RobotSetup
|
|
3521
|
-
*/
|
|
3522
|
-
'collision_scenes'?: {
|
|
3523
|
-
[key: string]: SingleMotionGroupCollisionScene;
|
|
3524
|
-
};
|
|
3525
|
-
}
|
|
3526
4275
|
/**
|
|
3527
4276
|
* 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.
|
|
3528
4277
|
* @export
|
|
@@ -3752,43 +4501,6 @@ export declare const SettableRobotSystemMode: {
|
|
|
3752
4501
|
readonly RobotSystemModeControl: "ROBOT_SYSTEM_MODE_CONTROL";
|
|
3753
4502
|
};
|
|
3754
4503
|
export type SettableRobotSystemMode = typeof SettableRobotSystemMode[keyof typeof SettableRobotSystemMode];
|
|
3755
|
-
/**
|
|
3756
|
-
*
|
|
3757
|
-
* @export
|
|
3758
|
-
* @interface SingleMotionGroupCollisionScene
|
|
3759
|
-
*/
|
|
3760
|
-
export interface SingleMotionGroupCollisionScene {
|
|
3761
|
-
/**
|
|
3762
|
-
* A collection of identifiable colliders.
|
|
3763
|
-
* @type {{ [key: string]: Collider; }}
|
|
3764
|
-
* @memberof SingleMotionGroupCollisionScene
|
|
3765
|
-
*/
|
|
3766
|
-
'static_colliders'?: {
|
|
3767
|
-
[key: string]: Collider;
|
|
3768
|
-
};
|
|
3769
|
-
/**
|
|
3770
|
-
* A link chain is a kinematic chain of links that is connected via joints. A motion group can be used to control the motion of the joints in a link chain. A link is a group of colliders that is attached to the link reference frame. The reference frame of a link is obtained after applying all sets of Denavit-Hartenberg-parameters from base to (including) the link index. This means that the reference frame of the link is on the rotation axis of the next joint in the kinematic chain. Example: For a motion group with 2 joints, the collider reference frame (CRF) for link 1 is on the rotation axis of joint 2. The chain looks like: - Origin >> Mounting >> Base >> (CRF Base) Joint 0 >> Link 0 >> (CRF Link 0) Joint 1 >> Link 1 >> (CRF Link 1) Flange (CRF Tool) >> TCP Adjacent links in the kinematic chain of the motion group are not checked for mutual collision.
|
|
3771
|
-
* @type {Array<{ [key: string]: Collider; }>}
|
|
3772
|
-
* @memberof SingleMotionGroupCollisionScene
|
|
3773
|
-
*/
|
|
3774
|
-
'link_chain'?: Array<{
|
|
3775
|
-
[key: string]: Collider;
|
|
3776
|
-
}>;
|
|
3777
|
-
/**
|
|
3778
|
-
* Defines the shape of a tool. A tool is a dictionary of colliders. All colliders that make up a tool are attached to the flange frame of the motion group.
|
|
3779
|
-
* @type {{ [key: string]: Collider; }}
|
|
3780
|
-
* @memberof SingleMotionGroupCollisionScene
|
|
3781
|
-
*/
|
|
3782
|
-
'tool'?: {
|
|
3783
|
-
[key: string]: Collider;
|
|
3784
|
-
};
|
|
3785
|
-
/**
|
|
3786
|
-
* If true, self-collision detection is enabled for the motion group. See LinkChain documentation for details. Default is true.
|
|
3787
|
-
* @type {boolean}
|
|
3788
|
-
* @memberof SingleMotionGroupCollisionScene
|
|
3789
|
-
*/
|
|
3790
|
-
'motion_group_self_collision_detection'?: boolean;
|
|
3791
|
-
}
|
|
3792
4504
|
/**
|
|
3793
4505
|
*
|
|
3794
4506
|
* @export
|
|
@@ -4320,6 +5032,14 @@ export interface ValidationError {
|
|
|
4320
5032
|
* @memberof ValidationError
|
|
4321
5033
|
*/
|
|
4322
5034
|
'type': string;
|
|
5035
|
+
/**
|
|
5036
|
+
*
|
|
5037
|
+
* @type {{ [key: string]: any; }}
|
|
5038
|
+
* @memberof ValidationError
|
|
5039
|
+
*/
|
|
5040
|
+
'input': {
|
|
5041
|
+
[key: string]: any;
|
|
5042
|
+
};
|
|
4323
5043
|
}
|
|
4324
5044
|
/**
|
|
4325
5045
|
* @type ValidationErrorLocInner
|
|
@@ -4489,319 +5209,820 @@ export type VirtualControllerTypes = typeof VirtualControllerTypes[keyof typeof
|
|
|
4489
5209
|
*/
|
|
4490
5210
|
export interface VirtualRobotConfiguration {
|
|
4491
5211
|
/**
|
|
4492
|
-
* Name of the configuration file generated by the unique identifier of the controller and a time stamp.
|
|
4493
|
-
* @type {string}
|
|
4494
|
-
* @memberof VirtualRobotConfiguration
|
|
5212
|
+
* Name of the configuration file generated by the unique identifier of the controller and a time stamp.
|
|
5213
|
+
* @type {string}
|
|
5214
|
+
* @memberof VirtualRobotConfiguration
|
|
5215
|
+
*/
|
|
5216
|
+
'name': string;
|
|
5217
|
+
/**
|
|
5218
|
+
* Content of the configuration file. Copy & paste to the [addRobotController](addRobotController) configuration.json parameter.
|
|
5219
|
+
* @type {string}
|
|
5220
|
+
* @memberof VirtualRobotConfiguration
|
|
5221
|
+
*/
|
|
5222
|
+
'content': string;
|
|
5223
|
+
}
|
|
5224
|
+
/**
|
|
5225
|
+
* The value to compare with the current value of the input/output.
|
|
5226
|
+
* @export
|
|
5227
|
+
* @interface WaitForIOEventRequest
|
|
5228
|
+
*/
|
|
5229
|
+
export interface WaitForIOEventRequest {
|
|
5230
|
+
/**
|
|
5231
|
+
*
|
|
5232
|
+
* @type {IOValue}
|
|
5233
|
+
* @memberof WaitForIOEventRequest
|
|
5234
|
+
*/
|
|
5235
|
+
'io': IOValue;
|
|
5236
|
+
/**
|
|
5237
|
+
* Comparator for the comparison of two values. Use the measured I/O as the base value (a) and the expected input/output value as the comparator (b): e.g., a > b.
|
|
5238
|
+
* @type {Comparator}
|
|
5239
|
+
* @memberof WaitForIOEventRequest
|
|
5240
|
+
*/
|
|
5241
|
+
'comparator': Comparator;
|
|
5242
|
+
}
|
|
5243
|
+
/**
|
|
5244
|
+
* The configuration of a physical Yaskawa robot controller has to contain IP address of the controller.
|
|
5245
|
+
* @export
|
|
5246
|
+
* @interface YaskawaController
|
|
5247
|
+
*/
|
|
5248
|
+
export interface YaskawaController {
|
|
5249
|
+
/**
|
|
5250
|
+
*
|
|
5251
|
+
* @type {string}
|
|
5252
|
+
* @memberof YaskawaController
|
|
5253
|
+
*/
|
|
5254
|
+
'kind'?: YaskawaControllerKindEnum;
|
|
5255
|
+
/**
|
|
5256
|
+
*
|
|
5257
|
+
* @type {string}
|
|
5258
|
+
* @memberof YaskawaController
|
|
5259
|
+
*/
|
|
5260
|
+
'controller_ip': string;
|
|
5261
|
+
}
|
|
5262
|
+
export declare const YaskawaControllerKindEnum: {
|
|
5263
|
+
readonly YaskawaController: "YaskawaController";
|
|
5264
|
+
};
|
|
5265
|
+
export type YaskawaControllerKindEnum = typeof YaskawaControllerKindEnum[keyof typeof YaskawaControllerKindEnum];
|
|
5266
|
+
/**
|
|
5267
|
+
* ApplicationApi - axios parameter creator
|
|
5268
|
+
* @export
|
|
5269
|
+
*/
|
|
5270
|
+
export declare const ApplicationApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
5271
|
+
/**
|
|
5272
|
+
* Install a basic, containerized web application to the cell to control robots with a customized frontend. Prerequisites: A Docker hub account or similar container registry account, with valid credentials. After adding the application to the cell, open the application on the Wandelbots NOVA home screen. Read [build your application](/docs/docs/development/) for more information. <!-- theme: none --> > #### Predefined Environment Variables > - `NOVA_API`: The API endpoint accessible from within the application container. > - `NATS_BROKER`: The NATS broker endpoint accessible from within the application container. > - `BASE_PATH`: The application\'s root path, accessible at http://$host/$BASE_PATH > - `CELL_NAME`: The name of the cell hosting the deployed application.
|
|
5273
|
+
* @summary Add Application
|
|
5274
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5275
|
+
* @param {App} app
|
|
5276
|
+
* @param {number} [completionTimeout]
|
|
5277
|
+
* @param {*} [options] Override http request option.
|
|
5278
|
+
* @throws {RequiredError}
|
|
5279
|
+
*/
|
|
5280
|
+
addApp: (cell: string, app: App, completionTimeout?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
5281
|
+
/**
|
|
5282
|
+
* Delete all GUI applications from the cell.
|
|
5283
|
+
* @summary Clear Applications
|
|
5284
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5285
|
+
* @param {number} [completionTimeout]
|
|
5286
|
+
* @param {*} [options] Override http request option.
|
|
5287
|
+
* @throws {RequiredError}
|
|
5288
|
+
*/
|
|
5289
|
+
clearApps: (cell: string, completionTimeout?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
5290
|
+
/**
|
|
5291
|
+
* Delete a GUI application from the cell.
|
|
5292
|
+
* @summary Delete Application
|
|
5293
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5294
|
+
* @param {string} app
|
|
5295
|
+
* @param {number} [completionTimeout]
|
|
5296
|
+
* @param {*} [options] Override http request option.
|
|
5297
|
+
* @throws {RequiredError}
|
|
5298
|
+
*/
|
|
5299
|
+
deleteApp: (cell: string, app: string, completionTimeout?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
5300
|
+
/**
|
|
5301
|
+
* Get the configuration for an active GUI application in the cell. To update the configuration of a GUI application in the cell, use this configuration with the \'Update Configuration\' endpoint.
|
|
5302
|
+
* @summary Configuration
|
|
5303
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5304
|
+
* @param {string} app
|
|
5305
|
+
* @param {*} [options] Override http request option.
|
|
5306
|
+
* @throws {RequiredError}
|
|
5307
|
+
*/
|
|
5308
|
+
getApp: (cell: string, app: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
5309
|
+
/**
|
|
5310
|
+
* List all GUI applications that have been added to a cell. with the \'Add Application\' endpoint. If the cell does not contain GUI applications, the list is returned empty.
|
|
5311
|
+
* @summary List Applications
|
|
5312
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5313
|
+
* @param {*} [options] Override http request option.
|
|
5314
|
+
* @throws {RequiredError}
|
|
5315
|
+
*/
|
|
5316
|
+
listApps: (cell: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
5317
|
+
/**
|
|
5318
|
+
* Update the configuration of a GUI application in the cell.
|
|
5319
|
+
* @summary Update Configuration
|
|
5320
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5321
|
+
* @param {string} app
|
|
5322
|
+
* @param {App} app2
|
|
5323
|
+
* @param {number} [completionTimeout]
|
|
5324
|
+
* @param {*} [options] Override http request option.
|
|
5325
|
+
* @throws {RequiredError}
|
|
5326
|
+
*/
|
|
5327
|
+
updateApp: (cell: string, app: string, app2: App, completionTimeout?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
5328
|
+
};
|
|
5329
|
+
/**
|
|
5330
|
+
* ApplicationApi - functional programming interface
|
|
5331
|
+
* @export
|
|
5332
|
+
*/
|
|
5333
|
+
export declare const ApplicationApiFp: (configuration?: Configuration) => {
|
|
5334
|
+
/**
|
|
5335
|
+
* Install a basic, containerized web application to the cell to control robots with a customized frontend. Prerequisites: A Docker hub account or similar container registry account, with valid credentials. After adding the application to the cell, open the application on the Wandelbots NOVA home screen. Read [build your application](/docs/docs/development/) for more information. <!-- theme: none --> > #### Predefined Environment Variables > - `NOVA_API`: The API endpoint accessible from within the application container. > - `NATS_BROKER`: The NATS broker endpoint accessible from within the application container. > - `BASE_PATH`: The application\'s root path, accessible at http://$host/$BASE_PATH > - `CELL_NAME`: The name of the cell hosting the deployed application.
|
|
5336
|
+
* @summary Add Application
|
|
5337
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5338
|
+
* @param {App} app
|
|
5339
|
+
* @param {number} [completionTimeout]
|
|
5340
|
+
* @param {*} [options] Override http request option.
|
|
5341
|
+
* @throws {RequiredError}
|
|
5342
|
+
*/
|
|
5343
|
+
addApp(cell: string, app: App, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
5344
|
+
/**
|
|
5345
|
+
* Delete all GUI applications from the cell.
|
|
5346
|
+
* @summary Clear Applications
|
|
5347
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5348
|
+
* @param {number} [completionTimeout]
|
|
5349
|
+
* @param {*} [options] Override http request option.
|
|
5350
|
+
* @throws {RequiredError}
|
|
5351
|
+
*/
|
|
5352
|
+
clearApps(cell: string, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
5353
|
+
/**
|
|
5354
|
+
* Delete a GUI application from the cell.
|
|
5355
|
+
* @summary Delete Application
|
|
5356
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5357
|
+
* @param {string} app
|
|
5358
|
+
* @param {number} [completionTimeout]
|
|
5359
|
+
* @param {*} [options] Override http request option.
|
|
5360
|
+
* @throws {RequiredError}
|
|
5361
|
+
*/
|
|
5362
|
+
deleteApp(cell: string, app: string, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
5363
|
+
/**
|
|
5364
|
+
* Get the configuration for an active GUI application in the cell. To update the configuration of a GUI application in the cell, use this configuration with the \'Update Configuration\' endpoint.
|
|
5365
|
+
* @summary Configuration
|
|
5366
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5367
|
+
* @param {string} app
|
|
5368
|
+
* @param {*} [options] Override http request option.
|
|
5369
|
+
* @throws {RequiredError}
|
|
5370
|
+
*/
|
|
5371
|
+
getApp(cell: string, app: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<App>>;
|
|
5372
|
+
/**
|
|
5373
|
+
* List all GUI applications that have been added to a cell. with the \'Add Application\' endpoint. If the cell does not contain GUI applications, the list is returned empty.
|
|
5374
|
+
* @summary List Applications
|
|
5375
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5376
|
+
* @param {*} [options] Override http request option.
|
|
5377
|
+
* @throws {RequiredError}
|
|
5378
|
+
*/
|
|
5379
|
+
listApps(cell: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<string>>>;
|
|
5380
|
+
/**
|
|
5381
|
+
* Update the configuration of a GUI application in the cell.
|
|
5382
|
+
* @summary Update Configuration
|
|
5383
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5384
|
+
* @param {string} app
|
|
5385
|
+
* @param {App} app2
|
|
5386
|
+
* @param {number} [completionTimeout]
|
|
5387
|
+
* @param {*} [options] Override http request option.
|
|
5388
|
+
* @throws {RequiredError}
|
|
5389
|
+
*/
|
|
5390
|
+
updateApp(cell: string, app: string, app2: App, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
5391
|
+
};
|
|
5392
|
+
/**
|
|
5393
|
+
* ApplicationApi - factory interface
|
|
5394
|
+
* @export
|
|
5395
|
+
*/
|
|
5396
|
+
export declare const ApplicationApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
5397
|
+
/**
|
|
5398
|
+
* Install a basic, containerized web application to the cell to control robots with a customized frontend. Prerequisites: A Docker hub account or similar container registry account, with valid credentials. After adding the application to the cell, open the application on the Wandelbots NOVA home screen. Read [build your application](/docs/docs/development/) for more information. <!-- theme: none --> > #### Predefined Environment Variables > - `NOVA_API`: The API endpoint accessible from within the application container. > - `NATS_BROKER`: The NATS broker endpoint accessible from within the application container. > - `BASE_PATH`: The application\'s root path, accessible at http://$host/$BASE_PATH > - `CELL_NAME`: The name of the cell hosting the deployed application.
|
|
5399
|
+
* @summary Add Application
|
|
5400
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5401
|
+
* @param {App} app
|
|
5402
|
+
* @param {number} [completionTimeout]
|
|
5403
|
+
* @param {*} [options] Override http request option.
|
|
5404
|
+
* @throws {RequiredError}
|
|
5405
|
+
*/
|
|
5406
|
+
addApp(cell: string, app: App, completionTimeout?: number, options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
5407
|
+
/**
|
|
5408
|
+
* Delete all GUI applications from the cell.
|
|
5409
|
+
* @summary Clear Applications
|
|
5410
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5411
|
+
* @param {number} [completionTimeout]
|
|
5412
|
+
* @param {*} [options] Override http request option.
|
|
5413
|
+
* @throws {RequiredError}
|
|
5414
|
+
*/
|
|
5415
|
+
clearApps(cell: string, completionTimeout?: number, options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
5416
|
+
/**
|
|
5417
|
+
* Delete a GUI application from the cell.
|
|
5418
|
+
* @summary Delete Application
|
|
5419
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5420
|
+
* @param {string} app
|
|
5421
|
+
* @param {number} [completionTimeout]
|
|
5422
|
+
* @param {*} [options] Override http request option.
|
|
5423
|
+
* @throws {RequiredError}
|
|
5424
|
+
*/
|
|
5425
|
+
deleteApp(cell: string, app: string, completionTimeout?: number, options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
5426
|
+
/**
|
|
5427
|
+
* Get the configuration for an active GUI application in the cell. To update the configuration of a GUI application in the cell, use this configuration with the \'Update Configuration\' endpoint.
|
|
5428
|
+
* @summary Configuration
|
|
5429
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5430
|
+
* @param {string} app
|
|
5431
|
+
* @param {*} [options] Override http request option.
|
|
5432
|
+
* @throws {RequiredError}
|
|
5433
|
+
*/
|
|
5434
|
+
getApp(cell: string, app: string, options?: RawAxiosRequestConfig): AxiosPromise<App>;
|
|
5435
|
+
/**
|
|
5436
|
+
* List all GUI applications that have been added to a cell. with the \'Add Application\' endpoint. If the cell does not contain GUI applications, the list is returned empty.
|
|
5437
|
+
* @summary List Applications
|
|
5438
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5439
|
+
* @param {*} [options] Override http request option.
|
|
5440
|
+
* @throws {RequiredError}
|
|
5441
|
+
*/
|
|
5442
|
+
listApps(cell: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<string>>;
|
|
5443
|
+
/**
|
|
5444
|
+
* Update the configuration of a GUI application in the cell.
|
|
5445
|
+
* @summary Update Configuration
|
|
5446
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5447
|
+
* @param {string} app
|
|
5448
|
+
* @param {App} app2
|
|
5449
|
+
* @param {number} [completionTimeout]
|
|
5450
|
+
* @param {*} [options] Override http request option.
|
|
5451
|
+
* @throws {RequiredError}
|
|
5452
|
+
*/
|
|
5453
|
+
updateApp(cell: string, app: string, app2: App, completionTimeout?: number, options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
5454
|
+
};
|
|
5455
|
+
/**
|
|
5456
|
+
* ApplicationApi - object-oriented interface
|
|
5457
|
+
* @export
|
|
5458
|
+
* @class ApplicationApi
|
|
5459
|
+
* @extends {BaseAPI}
|
|
5460
|
+
*/
|
|
5461
|
+
export declare class ApplicationApi extends BaseAPI {
|
|
5462
|
+
/**
|
|
5463
|
+
* Install a basic, containerized web application to the cell to control robots with a customized frontend. Prerequisites: A Docker hub account or similar container registry account, with valid credentials. After adding the application to the cell, open the application on the Wandelbots NOVA home screen. Read [build your application](/docs/docs/development/) for more information. <!-- theme: none --> > #### Predefined Environment Variables > - `NOVA_API`: The API endpoint accessible from within the application container. > - `NATS_BROKER`: The NATS broker endpoint accessible from within the application container. > - `BASE_PATH`: The application\'s root path, accessible at http://$host/$BASE_PATH > - `CELL_NAME`: The name of the cell hosting the deployed application.
|
|
5464
|
+
* @summary Add Application
|
|
5465
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5466
|
+
* @param {App} app
|
|
5467
|
+
* @param {number} [completionTimeout]
|
|
5468
|
+
* @param {*} [options] Override http request option.
|
|
5469
|
+
* @throws {RequiredError}
|
|
5470
|
+
* @memberof ApplicationApi
|
|
5471
|
+
*/
|
|
5472
|
+
addApp(cell: string, app: App, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
5473
|
+
/**
|
|
5474
|
+
* Delete all GUI applications from the cell.
|
|
5475
|
+
* @summary Clear Applications
|
|
5476
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5477
|
+
* @param {number} [completionTimeout]
|
|
5478
|
+
* @param {*} [options] Override http request option.
|
|
5479
|
+
* @throws {RequiredError}
|
|
5480
|
+
* @memberof ApplicationApi
|
|
5481
|
+
*/
|
|
5482
|
+
clearApps(cell: string, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
5483
|
+
/**
|
|
5484
|
+
* Delete a GUI application from the cell.
|
|
5485
|
+
* @summary Delete Application
|
|
5486
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5487
|
+
* @param {string} app
|
|
5488
|
+
* @param {number} [completionTimeout]
|
|
5489
|
+
* @param {*} [options] Override http request option.
|
|
5490
|
+
* @throws {RequiredError}
|
|
5491
|
+
* @memberof ApplicationApi
|
|
5492
|
+
*/
|
|
5493
|
+
deleteApp(cell: string, app: string, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
5494
|
+
/**
|
|
5495
|
+
* Get the configuration for an active GUI application in the cell. To update the configuration of a GUI application in the cell, use this configuration with the \'Update Configuration\' endpoint.
|
|
5496
|
+
* @summary Configuration
|
|
5497
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5498
|
+
* @param {string} app
|
|
5499
|
+
* @param {*} [options] Override http request option.
|
|
5500
|
+
* @throws {RequiredError}
|
|
5501
|
+
* @memberof ApplicationApi
|
|
5502
|
+
*/
|
|
5503
|
+
getApp(cell: string, app: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<App, any>>;
|
|
5504
|
+
/**
|
|
5505
|
+
* List all GUI applications that have been added to a cell. with the \'Add Application\' endpoint. If the cell does not contain GUI applications, the list is returned empty.
|
|
5506
|
+
* @summary List Applications
|
|
5507
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5508
|
+
* @param {*} [options] Override http request option.
|
|
5509
|
+
* @throws {RequiredError}
|
|
5510
|
+
* @memberof ApplicationApi
|
|
5511
|
+
*/
|
|
5512
|
+
listApps(cell: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<string[], any>>;
|
|
5513
|
+
/**
|
|
5514
|
+
* Update the configuration of a GUI application in the cell.
|
|
5515
|
+
* @summary Update Configuration
|
|
5516
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5517
|
+
* @param {string} app
|
|
5518
|
+
* @param {App} app2
|
|
5519
|
+
* @param {number} [completionTimeout]
|
|
5520
|
+
* @param {*} [options] Override http request option.
|
|
5521
|
+
* @throws {RequiredError}
|
|
5522
|
+
* @memberof ApplicationApi
|
|
5523
|
+
*/
|
|
5524
|
+
updateApp(cell: string, app: string, app2: App, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
5525
|
+
}
|
|
5526
|
+
/**
|
|
5527
|
+
* BUSInputsOutputsApi - axios parameter creator
|
|
5528
|
+
* @export
|
|
5529
|
+
*/
|
|
5530
|
+
export declare const BUSInputsOutputsApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
5531
|
+
/**
|
|
5532
|
+
* Add a BUS Inputs/Outputs Service to the cell.
|
|
5533
|
+
* @summary Add Service
|
|
5534
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5535
|
+
* @param {BusIOType} busIOType
|
|
5536
|
+
* @param {number} [completionTimeout]
|
|
5537
|
+
* @param {*} [options] Override http request option.
|
|
5538
|
+
* @throws {RequiredError}
|
|
5539
|
+
*/
|
|
5540
|
+
addBusIOService: (cell: string, busIOType: BusIOType, completionTimeout?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
5541
|
+
/**
|
|
5542
|
+
* Adds an input/output to or updates an input/output on the PROFINET device.
|
|
5543
|
+
* @summary Add PROFINET Input/Output
|
|
5544
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5545
|
+
* @param {string} io Unique identifier to address an Input/Output in the cell.
|
|
5546
|
+
* @param {ProfinetIOData} profinetIOData
|
|
5547
|
+
* @param {*} [options] Override http request option.
|
|
5548
|
+
* @throws {RequiredError}
|
|
5549
|
+
*/
|
|
5550
|
+
addProfinetIO: (cell: string, io: string, profinetIOData: ProfinetIOData, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
5551
|
+
/**
|
|
5552
|
+
* Delete BUS Inputs/Outputs Service from the cell.
|
|
5553
|
+
* @summary Clear Service
|
|
5554
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5555
|
+
* @param {number} [completionTimeout]
|
|
5556
|
+
* @param {*} [options] Override http request option.
|
|
5557
|
+
* @throws {RequiredError}
|
|
5558
|
+
*/
|
|
5559
|
+
clearBusIOService: (cell: string, completionTimeout?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
5560
|
+
/**
|
|
5561
|
+
* Removes the input/output from the PROFINET device.
|
|
5562
|
+
* @summary Remove PROFINET Input/Ouptut
|
|
5563
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5564
|
+
* @param {string} io Unique identifier to address an Input/Output in the cell.
|
|
5565
|
+
* @param {*} [options] Override http request option.
|
|
5566
|
+
* @throws {RequiredError}
|
|
5567
|
+
*/
|
|
5568
|
+
deleteProfinetIO: (cell: string, io: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
5569
|
+
/**
|
|
5570
|
+
* Get deployed BUS Inputs/Outputs Service.
|
|
5571
|
+
* @summary Get Service
|
|
5572
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5573
|
+
* @param {*} [options] Override http request option.
|
|
5574
|
+
* @throws {RequiredError}
|
|
5575
|
+
*/
|
|
5576
|
+
getBusIOService: (cell: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
5577
|
+
/**
|
|
5578
|
+
* Get the current state of the BUS Inputs/Outputs service.
|
|
5579
|
+
* @summary State
|
|
5580
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5581
|
+
* @param {*} [options] Override http request option.
|
|
5582
|
+
* @throws {RequiredError}
|
|
5583
|
+
*/
|
|
5584
|
+
getBusIOState: (cell: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
5585
|
+
/**
|
|
5586
|
+
* Retrieves the current values of inputs/outputs. The identifiers of the inputs/outputs must be provided in the request. Request all available input/output identifiers via [listBusIODescriptions](listBusIODescriptions).
|
|
5587
|
+
* @summary Get Input/Output Values
|
|
5588
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5589
|
+
* @param {Array<string>} [ios]
|
|
5590
|
+
* @param {*} [options] Override http request option.
|
|
5591
|
+
* @throws {RequiredError}
|
|
5592
|
+
*/
|
|
5593
|
+
getBusIOValues: (cell: string, ios?: Array<string>, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
5594
|
+
/**
|
|
5595
|
+
* Get description of PROFINET
|
|
5596
|
+
* @summary Get PROFINET Description
|
|
5597
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5598
|
+
* @param {*} [options] Override http request option.
|
|
5599
|
+
* @throws {RequiredError}
|
|
5600
|
+
*/
|
|
5601
|
+
getProfinetDescription: (cell: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
5602
|
+
/**
|
|
5603
|
+
* Get input/output configuration of the PROFINET device as file.
|
|
5604
|
+
* @summary PROFINET Inputs/Outputs to File
|
|
5605
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5606
|
+
* @param {number} [inputOffset]
|
|
5607
|
+
* @param {number} [outputOffset]
|
|
5608
|
+
* @param {*} [options] Override http request option.
|
|
5609
|
+
* @throws {RequiredError}
|
|
5610
|
+
*/
|
|
5611
|
+
getProfinetIOsFromFile: (cell: string, inputOffset?: number, outputOffset?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
5612
|
+
/**
|
|
5613
|
+
* List all BUS Input/Output descriptions.
|
|
5614
|
+
* @summary List Descriptions
|
|
5615
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5616
|
+
* @param {*} [options] Override http request option.
|
|
5617
|
+
* @throws {RequiredError}
|
|
5618
|
+
*/
|
|
5619
|
+
listBusIODescriptions: (cell: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
5620
|
+
/**
|
|
5621
|
+
* List all PROFINET input and outputs.
|
|
5622
|
+
* @summary List PROFINET Input/Output Configuration
|
|
5623
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5624
|
+
* @param {*} [options] Override http request option.
|
|
5625
|
+
* @throws {RequiredError}
|
|
5626
|
+
*/
|
|
5627
|
+
listProfinetIOs: (cell: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
5628
|
+
/**
|
|
5629
|
+
* Set values of outputs. In case of virtual Bus Input/Outputs, also inputs can be set. All available output identifiers can be requested via [listBusIODescriptions](listBusIODescriptions). The call will return once the values have been set and accepted by the service.
|
|
5630
|
+
* @summary Set Output Values
|
|
5631
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5632
|
+
* @param {Array<IOValue>} iOValue
|
|
5633
|
+
* @param {*} [options] Override http request option.
|
|
5634
|
+
* @throws {RequiredError}
|
|
5635
|
+
*/
|
|
5636
|
+
setBusIOValues: (cell: string, iOValue: Array<IOValue>, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
5637
|
+
/**
|
|
5638
|
+
* Sets inputs/outputs on the PROFINET device from file.
|
|
5639
|
+
* @summary Set PROFINET Inputs/Outputs from File
|
|
5640
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5641
|
+
* @param {ProfinetInputOutputConfig} profinetInputOutputConfig
|
|
5642
|
+
* @param {*} [options] Override http request option.
|
|
5643
|
+
* @throws {RequiredError}
|
|
5644
|
+
*/
|
|
5645
|
+
setProfinetIOsFromFile: (cell: string, profinetInputOutputConfig: ProfinetInputOutputConfig, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
5646
|
+
};
|
|
5647
|
+
/**
|
|
5648
|
+
* BUSInputsOutputsApi - functional programming interface
|
|
5649
|
+
* @export
|
|
5650
|
+
*/
|
|
5651
|
+
export declare const BUSInputsOutputsApiFp: (configuration?: Configuration) => {
|
|
5652
|
+
/**
|
|
5653
|
+
* Add a BUS Inputs/Outputs Service to the cell.
|
|
5654
|
+
* @summary Add Service
|
|
5655
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5656
|
+
* @param {BusIOType} busIOType
|
|
5657
|
+
* @param {number} [completionTimeout]
|
|
5658
|
+
* @param {*} [options] Override http request option.
|
|
5659
|
+
* @throws {RequiredError}
|
|
5660
|
+
*/
|
|
5661
|
+
addBusIOService(cell: string, busIOType: BusIOType, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
5662
|
+
/**
|
|
5663
|
+
* Adds an input/output to or updates an input/output on the PROFINET device.
|
|
5664
|
+
* @summary Add PROFINET Input/Output
|
|
5665
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5666
|
+
* @param {string} io Unique identifier to address an Input/Output in the cell.
|
|
5667
|
+
* @param {ProfinetIOData} profinetIOData
|
|
5668
|
+
* @param {*} [options] Override http request option.
|
|
5669
|
+
* @throws {RequiredError}
|
|
5670
|
+
*/
|
|
5671
|
+
addProfinetIO(cell: string, io: string, profinetIOData: ProfinetIOData, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
5672
|
+
/**
|
|
5673
|
+
* Delete BUS Inputs/Outputs Service from the cell.
|
|
5674
|
+
* @summary Clear Service
|
|
5675
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5676
|
+
* @param {number} [completionTimeout]
|
|
5677
|
+
* @param {*} [options] Override http request option.
|
|
5678
|
+
* @throws {RequiredError}
|
|
5679
|
+
*/
|
|
5680
|
+
clearBusIOService(cell: string, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
5681
|
+
/**
|
|
5682
|
+
* Removes the input/output from the PROFINET device.
|
|
5683
|
+
* @summary Remove PROFINET Input/Ouptut
|
|
5684
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5685
|
+
* @param {string} io Unique identifier to address an Input/Output in the cell.
|
|
5686
|
+
* @param {*} [options] Override http request option.
|
|
5687
|
+
* @throws {RequiredError}
|
|
5688
|
+
*/
|
|
5689
|
+
deleteProfinetIO(cell: string, io: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
5690
|
+
/**
|
|
5691
|
+
* Get deployed BUS Inputs/Outputs Service.
|
|
5692
|
+
* @summary Get Service
|
|
5693
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5694
|
+
* @param {*} [options] Override http request option.
|
|
5695
|
+
* @throws {RequiredError}
|
|
5696
|
+
*/
|
|
5697
|
+
getBusIOService(cell: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BusIOType>>;
|
|
5698
|
+
/**
|
|
5699
|
+
* Get the current state of the BUS Inputs/Outputs service.
|
|
5700
|
+
* @summary State
|
|
5701
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5702
|
+
* @param {*} [options] Override http request option.
|
|
5703
|
+
* @throws {RequiredError}
|
|
5704
|
+
*/
|
|
5705
|
+
getBusIOState(cell: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BusIOsState>>;
|
|
5706
|
+
/**
|
|
5707
|
+
* Retrieves the current values of inputs/outputs. The identifiers of the inputs/outputs must be provided in the request. Request all available input/output identifiers via [listBusIODescriptions](listBusIODescriptions).
|
|
5708
|
+
* @summary Get Input/Output Values
|
|
5709
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5710
|
+
* @param {Array<string>} [ios]
|
|
5711
|
+
* @param {*} [options] Override http request option.
|
|
5712
|
+
* @throws {RequiredError}
|
|
5713
|
+
*/
|
|
5714
|
+
getBusIOValues(cell: string, ios?: Array<string>, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<IOValue>>>;
|
|
5715
|
+
/**
|
|
5716
|
+
* Get description of PROFINET
|
|
5717
|
+
* @summary Get PROFINET Description
|
|
5718
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5719
|
+
* @param {*} [options] Override http request option.
|
|
5720
|
+
* @throws {RequiredError}
|
|
4495
5721
|
*/
|
|
4496
|
-
|
|
5722
|
+
getProfinetDescription(cell: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ProfinetDescription>>;
|
|
4497
5723
|
/**
|
|
4498
|
-
*
|
|
4499
|
-
* @
|
|
4500
|
-
* @
|
|
5724
|
+
* Get input/output configuration of the PROFINET device as file.
|
|
5725
|
+
* @summary PROFINET Inputs/Outputs to File
|
|
5726
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5727
|
+
* @param {number} [inputOffset]
|
|
5728
|
+
* @param {number} [outputOffset]
|
|
5729
|
+
* @param {*} [options] Override http request option.
|
|
5730
|
+
* @throws {RequiredError}
|
|
4501
5731
|
*/
|
|
4502
|
-
|
|
4503
|
-
}
|
|
4504
|
-
/**
|
|
4505
|
-
* The value to compare with the current value of the input/output.
|
|
4506
|
-
* @export
|
|
4507
|
-
* @interface WaitForIOEventRequest
|
|
4508
|
-
*/
|
|
4509
|
-
export interface WaitForIOEventRequest {
|
|
5732
|
+
getProfinetIOsFromFile(cell: string, inputOffset?: number, outputOffset?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<string>>;
|
|
4510
5733
|
/**
|
|
4511
|
-
*
|
|
4512
|
-
* @
|
|
4513
|
-
* @
|
|
5734
|
+
* List all BUS Input/Output descriptions.
|
|
5735
|
+
* @summary List Descriptions
|
|
5736
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5737
|
+
* @param {*} [options] Override http request option.
|
|
5738
|
+
* @throws {RequiredError}
|
|
4514
5739
|
*/
|
|
4515
|
-
|
|
5740
|
+
listBusIODescriptions(cell: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<IODescription>>>;
|
|
4516
5741
|
/**
|
|
4517
|
-
*
|
|
4518
|
-
* @
|
|
4519
|
-
* @
|
|
5742
|
+
* List all PROFINET input and outputs.
|
|
5743
|
+
* @summary List PROFINET Input/Output Configuration
|
|
5744
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5745
|
+
* @param {*} [options] Override http request option.
|
|
5746
|
+
* @throws {RequiredError}
|
|
4520
5747
|
*/
|
|
4521
|
-
|
|
4522
|
-
}
|
|
4523
|
-
/**
|
|
4524
|
-
* The configuration of a physical Yaskawa robot controller has to contain IP address of the controller.
|
|
4525
|
-
* @export
|
|
4526
|
-
* @interface YaskawaController
|
|
4527
|
-
*/
|
|
4528
|
-
export interface YaskawaController {
|
|
5748
|
+
listProfinetIOs(cell: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<ProfinetIO>>>;
|
|
4529
5749
|
/**
|
|
4530
|
-
*
|
|
4531
|
-
* @
|
|
4532
|
-
* @
|
|
5750
|
+
* Set values of outputs. In case of virtual Bus Input/Outputs, also inputs can be set. All available output identifiers can be requested via [listBusIODescriptions](listBusIODescriptions). The call will return once the values have been set and accepted by the service.
|
|
5751
|
+
* @summary Set Output Values
|
|
5752
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5753
|
+
* @param {Array<IOValue>} iOValue
|
|
5754
|
+
* @param {*} [options] Override http request option.
|
|
5755
|
+
* @throws {RequiredError}
|
|
4533
5756
|
*/
|
|
4534
|
-
|
|
5757
|
+
setBusIOValues(cell: string, iOValue: Array<IOValue>, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
4535
5758
|
/**
|
|
4536
|
-
*
|
|
4537
|
-
* @
|
|
4538
|
-
* @
|
|
5759
|
+
* Sets inputs/outputs on the PROFINET device from file.
|
|
5760
|
+
* @summary Set PROFINET Inputs/Outputs from File
|
|
5761
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5762
|
+
* @param {ProfinetInputOutputConfig} profinetInputOutputConfig
|
|
5763
|
+
* @param {*} [options] Override http request option.
|
|
5764
|
+
* @throws {RequiredError}
|
|
4539
5765
|
*/
|
|
4540
|
-
|
|
4541
|
-
}
|
|
4542
|
-
export declare const YaskawaControllerKindEnum: {
|
|
4543
|
-
readonly YaskawaController: "YaskawaController";
|
|
5766
|
+
setProfinetIOsFromFile(cell: string, profinetInputOutputConfig: ProfinetInputOutputConfig, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
4544
5767
|
};
|
|
4545
|
-
export type YaskawaControllerKindEnum = typeof YaskawaControllerKindEnum[keyof typeof YaskawaControllerKindEnum];
|
|
4546
5768
|
/**
|
|
4547
|
-
*
|
|
5769
|
+
* BUSInputsOutputsApi - factory interface
|
|
4548
5770
|
* @export
|
|
4549
5771
|
*/
|
|
4550
|
-
export declare const
|
|
5772
|
+
export declare const BUSInputsOutputsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
4551
5773
|
/**
|
|
4552
|
-
*
|
|
4553
|
-
* @summary Add
|
|
5774
|
+
* Add a BUS Inputs/Outputs Service to the cell.
|
|
5775
|
+
* @summary Add Service
|
|
4554
5776
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
4555
|
-
* @param {
|
|
5777
|
+
* @param {BusIOType} busIOType
|
|
4556
5778
|
* @param {number} [completionTimeout]
|
|
4557
5779
|
* @param {*} [options] Override http request option.
|
|
4558
5780
|
* @throws {RequiredError}
|
|
4559
5781
|
*/
|
|
4560
|
-
|
|
5782
|
+
addBusIOService(cell: string, busIOType: BusIOType, completionTimeout?: number, options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
4561
5783
|
/**
|
|
4562
|
-
*
|
|
4563
|
-
* @summary
|
|
5784
|
+
* Adds an input/output to or updates an input/output on the PROFINET device.
|
|
5785
|
+
* @summary Add PROFINET Input/Output
|
|
4564
5786
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
4565
|
-
* @param {
|
|
5787
|
+
* @param {string} io Unique identifier to address an Input/Output in the cell.
|
|
5788
|
+
* @param {ProfinetIOData} profinetIOData
|
|
4566
5789
|
* @param {*} [options] Override http request option.
|
|
4567
5790
|
* @throws {RequiredError}
|
|
4568
5791
|
*/
|
|
4569
|
-
|
|
5792
|
+
addProfinetIO(cell: string, io: string, profinetIOData: ProfinetIOData, options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
4570
5793
|
/**
|
|
4571
|
-
* Delete
|
|
4572
|
-
* @summary
|
|
5794
|
+
* Delete BUS Inputs/Outputs Service from the cell.
|
|
5795
|
+
* @summary Clear Service
|
|
4573
5796
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
4574
|
-
* @param {string} app
|
|
4575
5797
|
* @param {number} [completionTimeout]
|
|
4576
5798
|
* @param {*} [options] Override http request option.
|
|
4577
5799
|
* @throws {RequiredError}
|
|
4578
5800
|
*/
|
|
4579
|
-
|
|
5801
|
+
clearBusIOService(cell: string, completionTimeout?: number, options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
4580
5802
|
/**
|
|
4581
|
-
*
|
|
4582
|
-
* @summary
|
|
5803
|
+
* Removes the input/output from the PROFINET device.
|
|
5804
|
+
* @summary Remove PROFINET Input/Ouptut
|
|
4583
5805
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
4584
|
-
* @param {string}
|
|
5806
|
+
* @param {string} io Unique identifier to address an Input/Output in the cell.
|
|
4585
5807
|
* @param {*} [options] Override http request option.
|
|
4586
5808
|
* @throws {RequiredError}
|
|
4587
5809
|
*/
|
|
4588
|
-
|
|
5810
|
+
deleteProfinetIO(cell: string, io: string, options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
4589
5811
|
/**
|
|
4590
|
-
*
|
|
4591
|
-
* @summary
|
|
5812
|
+
* Get deployed BUS Inputs/Outputs Service.
|
|
5813
|
+
* @summary Get Service
|
|
4592
5814
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
4593
5815
|
* @param {*} [options] Override http request option.
|
|
4594
5816
|
* @throws {RequiredError}
|
|
4595
5817
|
*/
|
|
4596
|
-
|
|
5818
|
+
getBusIOService(cell: string, options?: RawAxiosRequestConfig): AxiosPromise<BusIOType>;
|
|
4597
5819
|
/**
|
|
4598
|
-
*
|
|
4599
|
-
* @summary
|
|
5820
|
+
* Get the current state of the BUS Inputs/Outputs service.
|
|
5821
|
+
* @summary State
|
|
4600
5822
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
4601
|
-
* @param {string} app
|
|
4602
|
-
* @param {App} app2
|
|
4603
|
-
* @param {number} [completionTimeout]
|
|
4604
5823
|
* @param {*} [options] Override http request option.
|
|
4605
5824
|
* @throws {RequiredError}
|
|
4606
5825
|
*/
|
|
4607
|
-
|
|
4608
|
-
};
|
|
4609
|
-
/**
|
|
4610
|
-
* ApplicationApi - functional programming interface
|
|
4611
|
-
* @export
|
|
4612
|
-
*/
|
|
4613
|
-
export declare const ApplicationApiFp: (configuration?: Configuration) => {
|
|
5826
|
+
getBusIOState(cell: string, options?: RawAxiosRequestConfig): AxiosPromise<BusIOsState>;
|
|
4614
5827
|
/**
|
|
4615
|
-
*
|
|
4616
|
-
* @summary
|
|
5828
|
+
* Retrieves the current values of inputs/outputs. The identifiers of the inputs/outputs must be provided in the request. Request all available input/output identifiers via [listBusIODescriptions](listBusIODescriptions).
|
|
5829
|
+
* @summary Get Input/Output Values
|
|
4617
5830
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
4618
|
-
* @param {
|
|
4619
|
-
* @param {number} [completionTimeout]
|
|
5831
|
+
* @param {Array<string>} [ios]
|
|
4620
5832
|
* @param {*} [options] Override http request option.
|
|
4621
5833
|
* @throws {RequiredError}
|
|
4622
5834
|
*/
|
|
4623
|
-
|
|
5835
|
+
getBusIOValues(cell: string, ios?: Array<string>, options?: RawAxiosRequestConfig): AxiosPromise<Array<IOValue>>;
|
|
4624
5836
|
/**
|
|
4625
|
-
*
|
|
4626
|
-
* @summary
|
|
5837
|
+
* Get description of PROFINET
|
|
5838
|
+
* @summary Get PROFINET Description
|
|
4627
5839
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
4628
|
-
* @param {number} [completionTimeout]
|
|
4629
5840
|
* @param {*} [options] Override http request option.
|
|
4630
5841
|
* @throws {RequiredError}
|
|
4631
5842
|
*/
|
|
4632
|
-
|
|
5843
|
+
getProfinetDescription(cell: string, options?: RawAxiosRequestConfig): AxiosPromise<ProfinetDescription>;
|
|
4633
5844
|
/**
|
|
4634
|
-
*
|
|
4635
|
-
* @summary
|
|
5845
|
+
* Get input/output configuration of the PROFINET device as file.
|
|
5846
|
+
* @summary PROFINET Inputs/Outputs to File
|
|
4636
5847
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
4637
|
-
* @param {
|
|
4638
|
-
* @param {number} [
|
|
5848
|
+
* @param {number} [inputOffset]
|
|
5849
|
+
* @param {number} [outputOffset]
|
|
4639
5850
|
* @param {*} [options] Override http request option.
|
|
4640
5851
|
* @throws {RequiredError}
|
|
4641
5852
|
*/
|
|
4642
|
-
|
|
5853
|
+
getProfinetIOsFromFile(cell: string, inputOffset?: number, outputOffset?: number, options?: RawAxiosRequestConfig): AxiosPromise<string>;
|
|
4643
5854
|
/**
|
|
4644
|
-
*
|
|
4645
|
-
* @summary
|
|
5855
|
+
* List all BUS Input/Output descriptions.
|
|
5856
|
+
* @summary List Descriptions
|
|
4646
5857
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
4647
|
-
* @param {string} app
|
|
4648
5858
|
* @param {*} [options] Override http request option.
|
|
4649
5859
|
* @throws {RequiredError}
|
|
4650
5860
|
*/
|
|
4651
|
-
|
|
5861
|
+
listBusIODescriptions(cell: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<IODescription>>;
|
|
4652
5862
|
/**
|
|
4653
|
-
* List all
|
|
4654
|
-
* @summary List
|
|
5863
|
+
* List all PROFINET input and outputs.
|
|
5864
|
+
* @summary List PROFINET Input/Output Configuration
|
|
4655
5865
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
4656
5866
|
* @param {*} [options] Override http request option.
|
|
4657
5867
|
* @throws {RequiredError}
|
|
4658
5868
|
*/
|
|
4659
|
-
|
|
5869
|
+
listProfinetIOs(cell: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<ProfinetIO>>;
|
|
4660
5870
|
/**
|
|
4661
|
-
*
|
|
4662
|
-
* @summary
|
|
5871
|
+
* Set values of outputs. In case of virtual Bus Input/Outputs, also inputs can be set. All available output identifiers can be requested via [listBusIODescriptions](listBusIODescriptions). The call will return once the values have been set and accepted by the service.
|
|
5872
|
+
* @summary Set Output Values
|
|
4663
5873
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
4664
|
-
* @param {
|
|
4665
|
-
* @param {App} app2
|
|
4666
|
-
* @param {number} [completionTimeout]
|
|
5874
|
+
* @param {Array<IOValue>} iOValue
|
|
4667
5875
|
* @param {*} [options] Override http request option.
|
|
4668
5876
|
* @throws {RequiredError}
|
|
4669
5877
|
*/
|
|
4670
|
-
|
|
5878
|
+
setBusIOValues(cell: string, iOValue: Array<IOValue>, options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
5879
|
+
/**
|
|
5880
|
+
* Sets inputs/outputs on the PROFINET device from file.
|
|
5881
|
+
* @summary Set PROFINET Inputs/Outputs from File
|
|
5882
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5883
|
+
* @param {ProfinetInputOutputConfig} profinetInputOutputConfig
|
|
5884
|
+
* @param {*} [options] Override http request option.
|
|
5885
|
+
* @throws {RequiredError}
|
|
5886
|
+
*/
|
|
5887
|
+
setProfinetIOsFromFile(cell: string, profinetInputOutputConfig: ProfinetInputOutputConfig, options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
4671
5888
|
};
|
|
4672
5889
|
/**
|
|
4673
|
-
*
|
|
5890
|
+
* BUSInputsOutputsApi - object-oriented interface
|
|
4674
5891
|
* @export
|
|
5892
|
+
* @class BUSInputsOutputsApi
|
|
5893
|
+
* @extends {BaseAPI}
|
|
4675
5894
|
*/
|
|
4676
|
-
export declare
|
|
5895
|
+
export declare class BUSInputsOutputsApi extends BaseAPI {
|
|
4677
5896
|
/**
|
|
4678
|
-
*
|
|
4679
|
-
* @summary Add
|
|
5897
|
+
* Add a BUS Inputs/Outputs Service to the cell.
|
|
5898
|
+
* @summary Add Service
|
|
4680
5899
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
4681
|
-
* @param {
|
|
5900
|
+
* @param {BusIOType} busIOType
|
|
4682
5901
|
* @param {number} [completionTimeout]
|
|
4683
5902
|
* @param {*} [options] Override http request option.
|
|
4684
5903
|
* @throws {RequiredError}
|
|
5904
|
+
* @memberof BUSInputsOutputsApi
|
|
4685
5905
|
*/
|
|
4686
|
-
|
|
5906
|
+
addBusIOService(cell: string, busIOType: BusIOType, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
4687
5907
|
/**
|
|
4688
|
-
*
|
|
4689
|
-
* @summary
|
|
5908
|
+
* Adds an input/output to or updates an input/output on the PROFINET device.
|
|
5909
|
+
* @summary Add PROFINET Input/Output
|
|
4690
5910
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
4691
|
-
* @param {
|
|
5911
|
+
* @param {string} io Unique identifier to address an Input/Output in the cell.
|
|
5912
|
+
* @param {ProfinetIOData} profinetIOData
|
|
4692
5913
|
* @param {*} [options] Override http request option.
|
|
4693
5914
|
* @throws {RequiredError}
|
|
5915
|
+
* @memberof BUSInputsOutputsApi
|
|
4694
5916
|
*/
|
|
4695
|
-
|
|
5917
|
+
addProfinetIO(cell: string, io: string, profinetIOData: ProfinetIOData, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
4696
5918
|
/**
|
|
4697
|
-
* Delete
|
|
4698
|
-
* @summary
|
|
5919
|
+
* Delete BUS Inputs/Outputs Service from the cell.
|
|
5920
|
+
* @summary Clear Service
|
|
4699
5921
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
4700
|
-
* @param {string} app
|
|
4701
5922
|
* @param {number} [completionTimeout]
|
|
4702
5923
|
* @param {*} [options] Override http request option.
|
|
4703
5924
|
* @throws {RequiredError}
|
|
5925
|
+
* @memberof BUSInputsOutputsApi
|
|
4704
5926
|
*/
|
|
4705
|
-
|
|
5927
|
+
clearBusIOService(cell: string, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
4706
5928
|
/**
|
|
4707
|
-
*
|
|
4708
|
-
* @summary
|
|
5929
|
+
* Removes the input/output from the PROFINET device.
|
|
5930
|
+
* @summary Remove PROFINET Input/Ouptut
|
|
4709
5931
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
4710
|
-
* @param {string}
|
|
5932
|
+
* @param {string} io Unique identifier to address an Input/Output in the cell.
|
|
4711
5933
|
* @param {*} [options] Override http request option.
|
|
4712
5934
|
* @throws {RequiredError}
|
|
5935
|
+
* @memberof BUSInputsOutputsApi
|
|
4713
5936
|
*/
|
|
4714
|
-
|
|
5937
|
+
deleteProfinetIO(cell: string, io: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
4715
5938
|
/**
|
|
4716
|
-
*
|
|
4717
|
-
* @summary
|
|
5939
|
+
* Get deployed BUS Inputs/Outputs Service.
|
|
5940
|
+
* @summary Get Service
|
|
4718
5941
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
4719
5942
|
* @param {*} [options] Override http request option.
|
|
4720
5943
|
* @throws {RequiredError}
|
|
5944
|
+
* @memberof BUSInputsOutputsApi
|
|
4721
5945
|
*/
|
|
4722
|
-
|
|
5946
|
+
getBusIOService(cell: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<{
|
|
5947
|
+
bus_type: "profinet";
|
|
5948
|
+
} & BusIOProfinet, any>>;
|
|
4723
5949
|
/**
|
|
4724
|
-
*
|
|
4725
|
-
* @summary
|
|
5950
|
+
* Get the current state of the BUS Inputs/Outputs service.
|
|
5951
|
+
* @summary State
|
|
4726
5952
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
4727
|
-
* @param {string} app
|
|
4728
|
-
* @param {App} app2
|
|
4729
|
-
* @param {number} [completionTimeout]
|
|
4730
5953
|
* @param {*} [options] Override http request option.
|
|
4731
5954
|
* @throws {RequiredError}
|
|
5955
|
+
* @memberof BUSInputsOutputsApi
|
|
4732
5956
|
*/
|
|
4733
|
-
|
|
4734
|
-
};
|
|
4735
|
-
/**
|
|
4736
|
-
* ApplicationApi - object-oriented interface
|
|
4737
|
-
* @export
|
|
4738
|
-
* @class ApplicationApi
|
|
4739
|
-
* @extends {BaseAPI}
|
|
4740
|
-
*/
|
|
4741
|
-
export declare class ApplicationApi extends BaseAPI {
|
|
5957
|
+
getBusIOState(cell: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<BusIOsState, any>>;
|
|
4742
5958
|
/**
|
|
4743
|
-
*
|
|
4744
|
-
* @summary
|
|
5959
|
+
* Retrieves the current values of inputs/outputs. The identifiers of the inputs/outputs must be provided in the request. Request all available input/output identifiers via [listBusIODescriptions](listBusIODescriptions).
|
|
5960
|
+
* @summary Get Input/Output Values
|
|
4745
5961
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
4746
|
-
* @param {
|
|
4747
|
-
* @param {number} [completionTimeout]
|
|
5962
|
+
* @param {Array<string>} [ios]
|
|
4748
5963
|
* @param {*} [options] Override http request option.
|
|
4749
5964
|
* @throws {RequiredError}
|
|
4750
|
-
* @memberof
|
|
5965
|
+
* @memberof BUSInputsOutputsApi
|
|
4751
5966
|
*/
|
|
4752
|
-
|
|
5967
|
+
getBusIOValues(cell: string, ios?: Array<string>, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<IOValue[], any>>;
|
|
4753
5968
|
/**
|
|
4754
|
-
*
|
|
4755
|
-
* @summary
|
|
5969
|
+
* Get description of PROFINET
|
|
5970
|
+
* @summary Get PROFINET Description
|
|
4756
5971
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
4757
|
-
* @param {number} [completionTimeout]
|
|
4758
5972
|
* @param {*} [options] Override http request option.
|
|
4759
5973
|
* @throws {RequiredError}
|
|
4760
|
-
* @memberof
|
|
5974
|
+
* @memberof BUSInputsOutputsApi
|
|
4761
5975
|
*/
|
|
4762
|
-
|
|
5976
|
+
getProfinetDescription(cell: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ProfinetDescription, any>>;
|
|
4763
5977
|
/**
|
|
4764
|
-
*
|
|
4765
|
-
* @summary
|
|
5978
|
+
* Get input/output configuration of the PROFINET device as file.
|
|
5979
|
+
* @summary PROFINET Inputs/Outputs to File
|
|
4766
5980
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
4767
|
-
* @param {
|
|
4768
|
-
* @param {number} [
|
|
5981
|
+
* @param {number} [inputOffset]
|
|
5982
|
+
* @param {number} [outputOffset]
|
|
4769
5983
|
* @param {*} [options] Override http request option.
|
|
4770
5984
|
* @throws {RequiredError}
|
|
4771
|
-
* @memberof
|
|
5985
|
+
* @memberof BUSInputsOutputsApi
|
|
4772
5986
|
*/
|
|
4773
|
-
|
|
5987
|
+
getProfinetIOsFromFile(cell: string, inputOffset?: number, outputOffset?: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<string, any>>;
|
|
4774
5988
|
/**
|
|
4775
|
-
*
|
|
4776
|
-
* @summary
|
|
5989
|
+
* List all BUS Input/Output descriptions.
|
|
5990
|
+
* @summary List Descriptions
|
|
4777
5991
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
4778
|
-
* @param {string} app
|
|
4779
5992
|
* @param {*} [options] Override http request option.
|
|
4780
5993
|
* @throws {RequiredError}
|
|
4781
|
-
* @memberof
|
|
5994
|
+
* @memberof BUSInputsOutputsApi
|
|
4782
5995
|
*/
|
|
4783
|
-
|
|
5996
|
+
listBusIODescriptions(cell: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<IODescription[], any>>;
|
|
4784
5997
|
/**
|
|
4785
|
-
* List all
|
|
4786
|
-
* @summary List
|
|
5998
|
+
* List all PROFINET input and outputs.
|
|
5999
|
+
* @summary List PROFINET Input/Output Configuration
|
|
4787
6000
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
4788
6001
|
* @param {*} [options] Override http request option.
|
|
4789
6002
|
* @throws {RequiredError}
|
|
4790
|
-
* @memberof
|
|
6003
|
+
* @memberof BUSInputsOutputsApi
|
|
4791
6004
|
*/
|
|
4792
|
-
|
|
6005
|
+
listProfinetIOs(cell: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ProfinetIO[], any>>;
|
|
4793
6006
|
/**
|
|
4794
|
-
*
|
|
4795
|
-
* @summary
|
|
6007
|
+
* Set values of outputs. In case of virtual Bus Input/Outputs, also inputs can be set. All available output identifiers can be requested via [listBusIODescriptions](listBusIODescriptions). The call will return once the values have been set and accepted by the service.
|
|
6008
|
+
* @summary Set Output Values
|
|
4796
6009
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
4797
|
-
* @param {
|
|
4798
|
-
* @param {App} app2
|
|
4799
|
-
* @param {number} [completionTimeout]
|
|
6010
|
+
* @param {Array<IOValue>} iOValue
|
|
4800
6011
|
* @param {*} [options] Override http request option.
|
|
4801
6012
|
* @throws {RequiredError}
|
|
4802
|
-
* @memberof
|
|
6013
|
+
* @memberof BUSInputsOutputsApi
|
|
4803
6014
|
*/
|
|
4804
|
-
|
|
6015
|
+
setBusIOValues(cell: string, iOValue: Array<IOValue>, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
6016
|
+
/**
|
|
6017
|
+
* Sets inputs/outputs on the PROFINET device from file.
|
|
6018
|
+
* @summary Set PROFINET Inputs/Outputs from File
|
|
6019
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
6020
|
+
* @param {ProfinetInputOutputConfig} profinetInputOutputConfig
|
|
6021
|
+
* @param {*} [options] Override http request option.
|
|
6022
|
+
* @throws {RequiredError}
|
|
6023
|
+
* @memberof BUSInputsOutputsApi
|
|
6024
|
+
*/
|
|
6025
|
+
setProfinetIOsFromFile(cell: string, profinetInputOutputConfig: ProfinetInputOutputConfig, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
4805
6026
|
}
|
|
4806
6027
|
/**
|
|
4807
6028
|
* CellApi - axios parameter creator
|
|
@@ -6008,6 +7229,15 @@ export declare class JoggingApi extends BaseAPI {
|
|
|
6008
7229
|
* @export
|
|
6009
7230
|
*/
|
|
6010
7231
|
export declare const KinematicsApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
7232
|
+
/**
|
|
7233
|
+
* Returns the TCP poses for a list of given joint positions.
|
|
7234
|
+
* @summary Forward kinematics
|
|
7235
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
7236
|
+
* @param {ForwardKinematicsRequest} [forwardKinematicsRequest]
|
|
7237
|
+
* @param {*} [options] Override http request option.
|
|
7238
|
+
* @throws {RequiredError}
|
|
7239
|
+
*/
|
|
7240
|
+
forwardKinematics: (cell: string, forwardKinematicsRequest?: ForwardKinematicsRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
6011
7241
|
/**
|
|
6012
7242
|
* Returns the reachable joint positions for a list of given poses.
|
|
6013
7243
|
* @summary Inverse kinematics
|
|
@@ -6023,6 +7253,15 @@ export declare const KinematicsApiAxiosParamCreator: (configuration?: Configurat
|
|
|
6023
7253
|
* @export
|
|
6024
7254
|
*/
|
|
6025
7255
|
export declare const KinematicsApiFp: (configuration?: Configuration) => {
|
|
7256
|
+
/**
|
|
7257
|
+
* Returns the TCP poses for a list of given joint positions.
|
|
7258
|
+
* @summary Forward kinematics
|
|
7259
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
7260
|
+
* @param {ForwardKinematicsRequest} [forwardKinematicsRequest]
|
|
7261
|
+
* @param {*} [options] Override http request option.
|
|
7262
|
+
* @throws {RequiredError}
|
|
7263
|
+
*/
|
|
7264
|
+
forwardKinematics(cell: string, forwardKinematicsRequest?: ForwardKinematicsRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ForwardKinematicsResponse>>;
|
|
6026
7265
|
/**
|
|
6027
7266
|
* Returns the reachable joint positions for a list of given poses.
|
|
6028
7267
|
* @summary Inverse kinematics
|
|
@@ -6038,6 +7277,15 @@ export declare const KinematicsApiFp: (configuration?: Configuration) => {
|
|
|
6038
7277
|
* @export
|
|
6039
7278
|
*/
|
|
6040
7279
|
export declare const KinematicsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
7280
|
+
/**
|
|
7281
|
+
* Returns the TCP poses for a list of given joint positions.
|
|
7282
|
+
* @summary Forward kinematics
|
|
7283
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
7284
|
+
* @param {ForwardKinematicsRequest} [forwardKinematicsRequest]
|
|
7285
|
+
* @param {*} [options] Override http request option.
|
|
7286
|
+
* @throws {RequiredError}
|
|
7287
|
+
*/
|
|
7288
|
+
forwardKinematics(cell: string, forwardKinematicsRequest?: ForwardKinematicsRequest, options?: RawAxiosRequestConfig): AxiosPromise<ForwardKinematicsResponse>;
|
|
6041
7289
|
/**
|
|
6042
7290
|
* Returns the reachable joint positions for a list of given poses.
|
|
6043
7291
|
* @summary Inverse kinematics
|
|
@@ -6055,6 +7303,16 @@ export declare const KinematicsApiFactory: (configuration?: Configuration, baseP
|
|
|
6055
7303
|
* @extends {BaseAPI}
|
|
6056
7304
|
*/
|
|
6057
7305
|
export declare class KinematicsApi extends BaseAPI {
|
|
7306
|
+
/**
|
|
7307
|
+
* Returns the TCP poses for a list of given joint positions.
|
|
7308
|
+
* @summary Forward kinematics
|
|
7309
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
7310
|
+
* @param {ForwardKinematicsRequest} [forwardKinematicsRequest]
|
|
7311
|
+
* @param {*} [options] Override http request option.
|
|
7312
|
+
* @throws {RequiredError}
|
|
7313
|
+
* @memberof KinematicsApi
|
|
7314
|
+
*/
|
|
7315
|
+
forwardKinematics(cell: string, forwardKinematicsRequest?: ForwardKinematicsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ForwardKinematicsResponse, any>>;
|
|
6058
7316
|
/**
|
|
6059
7317
|
* Returns the reachable joint positions for a list of given poses.
|
|
6060
7318
|
* @summary Inverse kinematics
|
|
@@ -7016,184 +8274,184 @@ export declare class StoreCollisionComponentsApi extends BaseAPI {
|
|
|
7016
8274
|
}, any>>;
|
|
7017
8275
|
}
|
|
7018
8276
|
/**
|
|
7019
|
-
*
|
|
8277
|
+
* StoreCollisionSetupsApi - axios parameter creator
|
|
7020
8278
|
* @export
|
|
7021
8279
|
*/
|
|
7022
|
-
export declare const
|
|
8280
|
+
export declare const StoreCollisionSetupsApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
7023
8281
|
/**
|
|
7024
|
-
* Deletes the stored
|
|
7025
|
-
* @summary Delete
|
|
8282
|
+
* Deletes the stored collision setup. <!-- theme: danger --> > This will delete persistently stored data.
|
|
8283
|
+
* @summary Delete Collision Setup
|
|
7026
8284
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
7027
|
-
* @param {string}
|
|
8285
|
+
* @param {string} setup Identifier of the collision setup
|
|
7028
8286
|
* @param {*} [options] Override http request option.
|
|
7029
8287
|
* @throws {RequiredError}
|
|
7030
8288
|
*/
|
|
7031
|
-
|
|
8289
|
+
deleteStoredCollisionSetup: (cell: string, setup: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
7032
8290
|
/**
|
|
7033
|
-
* Returns the stored
|
|
7034
|
-
* @summary Get
|
|
8291
|
+
* Returns the stored collision setup.
|
|
8292
|
+
* @summary Get Collision Setup
|
|
7035
8293
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
7036
|
-
* @param {string}
|
|
8294
|
+
* @param {string} setup Identifier of the collision setup
|
|
7037
8295
|
* @param {*} [options] Override http request option.
|
|
7038
8296
|
* @throws {RequiredError}
|
|
7039
8297
|
*/
|
|
7040
|
-
|
|
8298
|
+
getStoredCollisionSetup: (cell: string, setup: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
7041
8299
|
/**
|
|
7042
|
-
* Returns a list of stored
|
|
7043
|
-
* @summary List
|
|
8300
|
+
* Returns a list of stored collision setups.
|
|
8301
|
+
* @summary List Collision Setups
|
|
7044
8302
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
7045
8303
|
* @param {*} [options] Override http request option.
|
|
7046
8304
|
* @throws {RequiredError}
|
|
7047
8305
|
*/
|
|
7048
|
-
|
|
8306
|
+
listStoredCollisionSetups: (cell: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
7049
8307
|
/**
|
|
7050
|
-
*
|
|
7051
|
-
* @summary Store
|
|
8308
|
+
* Stores collision setup. If the collision setup does not exist, it will be created. If the collision setup exists, it will be updated.
|
|
8309
|
+
* @summary Store Collision Setup
|
|
7052
8310
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
7053
|
-
* @param {string}
|
|
7054
|
-
* @param {
|
|
8311
|
+
* @param {string} setup Identifier of the collision setup
|
|
8312
|
+
* @param {CollisionSetup} collisionSetup
|
|
7055
8313
|
* @param {*} [options] Override http request option.
|
|
7056
8314
|
* @throws {RequiredError}
|
|
7057
8315
|
*/
|
|
7058
|
-
|
|
8316
|
+
storeCollisionSetup: (cell: string, setup: string, collisionSetup: CollisionSetup, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
7059
8317
|
};
|
|
7060
8318
|
/**
|
|
7061
|
-
*
|
|
8319
|
+
* StoreCollisionSetupsApi - functional programming interface
|
|
7062
8320
|
* @export
|
|
7063
8321
|
*/
|
|
7064
|
-
export declare const
|
|
8322
|
+
export declare const StoreCollisionSetupsApiFp: (configuration?: Configuration) => {
|
|
7065
8323
|
/**
|
|
7066
|
-
* Deletes the stored
|
|
7067
|
-
* @summary Delete
|
|
8324
|
+
* Deletes the stored collision setup. <!-- theme: danger --> > This will delete persistently stored data.
|
|
8325
|
+
* @summary Delete Collision Setup
|
|
7068
8326
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
7069
|
-
* @param {string}
|
|
8327
|
+
* @param {string} setup Identifier of the collision setup
|
|
7070
8328
|
* @param {*} [options] Override http request option.
|
|
7071
8329
|
* @throws {RequiredError}
|
|
7072
8330
|
*/
|
|
7073
|
-
|
|
8331
|
+
deleteStoredCollisionSetup(cell: string, setup: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
7074
8332
|
/**
|
|
7075
|
-
* Returns the stored
|
|
7076
|
-
* @summary Get
|
|
8333
|
+
* Returns the stored collision setup.
|
|
8334
|
+
* @summary Get Collision Setup
|
|
7077
8335
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
7078
|
-
* @param {string}
|
|
8336
|
+
* @param {string} setup Identifier of the collision setup
|
|
7079
8337
|
* @param {*} [options] Override http request option.
|
|
7080
8338
|
* @throws {RequiredError}
|
|
7081
8339
|
*/
|
|
7082
|
-
|
|
8340
|
+
getStoredCollisionSetup(cell: string, setup: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CollisionSetup>>;
|
|
7083
8341
|
/**
|
|
7084
|
-
* Returns a list of stored
|
|
7085
|
-
* @summary List
|
|
8342
|
+
* Returns a list of stored collision setups.
|
|
8343
|
+
* @summary List Collision Setups
|
|
7086
8344
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
7087
8345
|
* @param {*} [options] Override http request option.
|
|
7088
8346
|
* @throws {RequiredError}
|
|
7089
8347
|
*/
|
|
7090
|
-
|
|
7091
|
-
[key: string]:
|
|
8348
|
+
listStoredCollisionSetups(cell: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<{
|
|
8349
|
+
[key: string]: CollisionSetup;
|
|
7092
8350
|
}>>;
|
|
7093
8351
|
/**
|
|
7094
|
-
*
|
|
7095
|
-
* @summary Store
|
|
8352
|
+
* Stores collision setup. If the collision setup does not exist, it will be created. If the collision setup exists, it will be updated.
|
|
8353
|
+
* @summary Store Collision Setup
|
|
7096
8354
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
7097
|
-
* @param {string}
|
|
7098
|
-
* @param {
|
|
8355
|
+
* @param {string} setup Identifier of the collision setup
|
|
8356
|
+
* @param {CollisionSetup} collisionSetup
|
|
7099
8357
|
* @param {*} [options] Override http request option.
|
|
7100
8358
|
* @throws {RequiredError}
|
|
7101
8359
|
*/
|
|
7102
|
-
|
|
8360
|
+
storeCollisionSetup(cell: string, setup: string, collisionSetup: CollisionSetup, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CollisionSetup>>;
|
|
7103
8361
|
};
|
|
7104
8362
|
/**
|
|
7105
|
-
*
|
|
8363
|
+
* StoreCollisionSetupsApi - factory interface
|
|
7106
8364
|
* @export
|
|
7107
8365
|
*/
|
|
7108
|
-
export declare const
|
|
8366
|
+
export declare const StoreCollisionSetupsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
7109
8367
|
/**
|
|
7110
|
-
* Deletes the stored
|
|
7111
|
-
* @summary Delete
|
|
8368
|
+
* Deletes the stored collision setup. <!-- theme: danger --> > This will delete persistently stored data.
|
|
8369
|
+
* @summary Delete Collision Setup
|
|
7112
8370
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
7113
|
-
* @param {string}
|
|
8371
|
+
* @param {string} setup Identifier of the collision setup
|
|
7114
8372
|
* @param {*} [options] Override http request option.
|
|
7115
8373
|
* @throws {RequiredError}
|
|
7116
8374
|
*/
|
|
7117
|
-
|
|
8375
|
+
deleteStoredCollisionSetup(cell: string, setup: string, options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
7118
8376
|
/**
|
|
7119
|
-
* Returns the stored
|
|
7120
|
-
* @summary Get
|
|
8377
|
+
* Returns the stored collision setup.
|
|
8378
|
+
* @summary Get Collision Setup
|
|
7121
8379
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
7122
|
-
* @param {string}
|
|
8380
|
+
* @param {string} setup Identifier of the collision setup
|
|
7123
8381
|
* @param {*} [options] Override http request option.
|
|
7124
8382
|
* @throws {RequiredError}
|
|
7125
8383
|
*/
|
|
7126
|
-
|
|
8384
|
+
getStoredCollisionSetup(cell: string, setup: string, options?: RawAxiosRequestConfig): AxiosPromise<CollisionSetup>;
|
|
7127
8385
|
/**
|
|
7128
|
-
* Returns a list of stored
|
|
7129
|
-
* @summary List
|
|
8386
|
+
* Returns a list of stored collision setups.
|
|
8387
|
+
* @summary List Collision Setups
|
|
7130
8388
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
7131
8389
|
* @param {*} [options] Override http request option.
|
|
7132
8390
|
* @throws {RequiredError}
|
|
7133
8391
|
*/
|
|
7134
|
-
|
|
7135
|
-
[key: string]:
|
|
8392
|
+
listStoredCollisionSetups(cell: string, options?: RawAxiosRequestConfig): AxiosPromise<{
|
|
8393
|
+
[key: string]: CollisionSetup;
|
|
7136
8394
|
}>;
|
|
7137
8395
|
/**
|
|
7138
|
-
*
|
|
7139
|
-
* @summary Store
|
|
8396
|
+
* Stores collision setup. If the collision setup does not exist, it will be created. If the collision setup exists, it will be updated.
|
|
8397
|
+
* @summary Store Collision Setup
|
|
7140
8398
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
7141
|
-
* @param {string}
|
|
7142
|
-
* @param {
|
|
8399
|
+
* @param {string} setup Identifier of the collision setup
|
|
8400
|
+
* @param {CollisionSetup} collisionSetup
|
|
7143
8401
|
* @param {*} [options] Override http request option.
|
|
7144
8402
|
* @throws {RequiredError}
|
|
7145
8403
|
*/
|
|
7146
|
-
|
|
8404
|
+
storeCollisionSetup(cell: string, setup: string, collisionSetup: CollisionSetup, options?: RawAxiosRequestConfig): AxiosPromise<CollisionSetup>;
|
|
7147
8405
|
};
|
|
7148
8406
|
/**
|
|
7149
|
-
*
|
|
8407
|
+
* StoreCollisionSetupsApi - object-oriented interface
|
|
7150
8408
|
* @export
|
|
7151
|
-
* @class
|
|
8409
|
+
* @class StoreCollisionSetupsApi
|
|
7152
8410
|
* @extends {BaseAPI}
|
|
7153
8411
|
*/
|
|
7154
|
-
export declare class
|
|
8412
|
+
export declare class StoreCollisionSetupsApi extends BaseAPI {
|
|
7155
8413
|
/**
|
|
7156
|
-
* Deletes the stored
|
|
7157
|
-
* @summary Delete
|
|
8414
|
+
* Deletes the stored collision setup. <!-- theme: danger --> > This will delete persistently stored data.
|
|
8415
|
+
* @summary Delete Collision Setup
|
|
7158
8416
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
7159
|
-
* @param {string}
|
|
8417
|
+
* @param {string} setup Identifier of the collision setup
|
|
7160
8418
|
* @param {*} [options] Override http request option.
|
|
7161
8419
|
* @throws {RequiredError}
|
|
7162
|
-
* @memberof
|
|
8420
|
+
* @memberof StoreCollisionSetupsApi
|
|
7163
8421
|
*/
|
|
7164
|
-
|
|
8422
|
+
deleteStoredCollisionSetup(cell: string, setup: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
7165
8423
|
/**
|
|
7166
|
-
* Returns the stored
|
|
7167
|
-
* @summary Get
|
|
8424
|
+
* Returns the stored collision setup.
|
|
8425
|
+
* @summary Get Collision Setup
|
|
7168
8426
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
7169
|
-
* @param {string}
|
|
8427
|
+
* @param {string} setup Identifier of the collision setup
|
|
7170
8428
|
* @param {*} [options] Override http request option.
|
|
7171
8429
|
* @throws {RequiredError}
|
|
7172
|
-
* @memberof
|
|
8430
|
+
* @memberof StoreCollisionSetupsApi
|
|
7173
8431
|
*/
|
|
7174
|
-
|
|
8432
|
+
getStoredCollisionSetup(cell: string, setup: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CollisionSetup, any>>;
|
|
7175
8433
|
/**
|
|
7176
|
-
* Returns a list of stored
|
|
7177
|
-
* @summary List
|
|
8434
|
+
* Returns a list of stored collision setups.
|
|
8435
|
+
* @summary List Collision Setups
|
|
7178
8436
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
7179
8437
|
* @param {*} [options] Override http request option.
|
|
7180
8438
|
* @throws {RequiredError}
|
|
7181
|
-
* @memberof
|
|
8439
|
+
* @memberof StoreCollisionSetupsApi
|
|
7182
8440
|
*/
|
|
7183
|
-
|
|
7184
|
-
[key: string]:
|
|
8441
|
+
listStoredCollisionSetups(cell: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<{
|
|
8442
|
+
[key: string]: CollisionSetup;
|
|
7185
8443
|
}, any>>;
|
|
7186
8444
|
/**
|
|
7187
|
-
*
|
|
7188
|
-
* @summary Store
|
|
8445
|
+
* Stores collision setup. If the collision setup does not exist, it will be created. If the collision setup exists, it will be updated.
|
|
8446
|
+
* @summary Store Collision Setup
|
|
7189
8447
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
7190
|
-
* @param {string}
|
|
7191
|
-
* @param {
|
|
8448
|
+
* @param {string} setup Identifier of the collision setup
|
|
8449
|
+
* @param {CollisionSetup} collisionSetup
|
|
7192
8450
|
* @param {*} [options] Override http request option.
|
|
7193
8451
|
* @throws {RequiredError}
|
|
7194
|
-
* @memberof
|
|
8452
|
+
* @memberof StoreCollisionSetupsApi
|
|
7195
8453
|
*/
|
|
7196
|
-
|
|
8454
|
+
storeCollisionSetup(cell: string, setup: string, collisionSetup: CollisionSetup, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CollisionSetup, any>>;
|
|
7197
8455
|
}
|
|
7198
8456
|
/**
|
|
7199
8457
|
* StoreObjectApi - axios parameter creator
|
|
@@ -8069,6 +9327,15 @@ export declare class TrajectoryExecutionApi extends BaseAPI {
|
|
|
8069
9327
|
* @export
|
|
8070
9328
|
*/
|
|
8071
9329
|
export declare const TrajectoryPlanningApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
9330
|
+
/**
|
|
9331
|
+
* Plans a collision-free trajectory for a single motion group using point-to-point (PTP) motions. This endpoint is specifically designed for collision-free path planning algorithms that find a trajectory from a start joint position to a target position while avoiding obstacles. Use the following workflow to execute a planned collision-free trajectory: 1. Plan a collision-free trajectory. 2. Optional: Load the planned trajectory into the cache using the [addTrajectory](addTrajectory) endpoint. 3. Execute the (cached) trajectory using the [executeTrajectory](executeTrajectory) endpoint. If the trajectory planning fails due to collision or algorithm constraints, the response will contain error information about the failure.
|
|
9332
|
+
* @summary Plan Collision-Free Trajectory
|
|
9333
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
9334
|
+
* @param {PlanCollisionFreeRequest} [planCollisionFreeRequest]
|
|
9335
|
+
* @param {*} [options] Override http request option.
|
|
9336
|
+
* @throws {RequiredError}
|
|
9337
|
+
*/
|
|
9338
|
+
planCollisionFree: (cell: string, planCollisionFreeRequest?: PlanCollisionFreeRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
8072
9339
|
/**
|
|
8073
9340
|
* Plans a new trajectory for a single motion group. Describe the trajectory as a sequence of motion commands that the robots TCP should follow. Use the following workflow to execute a planned trajectory: 1. Plan a trajectory. 2. Optional: Load the planned trajectory into the cache using the [addTrajectory](addTrajectory) endpoint. 3. Execute the (cached) trajectory using the [executeTrajectory](executeTrajectory) endpoint. If the trajectory is not executable, the [PlanTrajectoryResponse](PlanTrajectoryResponse) will contain the joint trajectory up until the error, e.g. all samples until a collision occurs. EXCEPTION: If a CartesianPTP or JointPTP motion command has an invalid target, the response will contain the trajectory up until the start of the invalid PTP motion.
|
|
8074
9341
|
* @summary Plan Trajectory
|
|
@@ -8084,6 +9351,15 @@ export declare const TrajectoryPlanningApiAxiosParamCreator: (configuration?: Co
|
|
|
8084
9351
|
* @export
|
|
8085
9352
|
*/
|
|
8086
9353
|
export declare const TrajectoryPlanningApiFp: (configuration?: Configuration) => {
|
|
9354
|
+
/**
|
|
9355
|
+
* Plans a collision-free trajectory for a single motion group using point-to-point (PTP) motions. This endpoint is specifically designed for collision-free path planning algorithms that find a trajectory from a start joint position to a target position while avoiding obstacles. Use the following workflow to execute a planned collision-free trajectory: 1. Plan a collision-free trajectory. 2. Optional: Load the planned trajectory into the cache using the [addTrajectory](addTrajectory) endpoint. 3. Execute the (cached) trajectory using the [executeTrajectory](executeTrajectory) endpoint. If the trajectory planning fails due to collision or algorithm constraints, the response will contain error information about the failure.
|
|
9356
|
+
* @summary Plan Collision-Free Trajectory
|
|
9357
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
9358
|
+
* @param {PlanCollisionFreeRequest} [planCollisionFreeRequest]
|
|
9359
|
+
* @param {*} [options] Override http request option.
|
|
9360
|
+
* @throws {RequiredError}
|
|
9361
|
+
*/
|
|
9362
|
+
planCollisionFree(cell: string, planCollisionFreeRequest?: PlanCollisionFreeRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PlanCollisionFreeResponse>>;
|
|
8087
9363
|
/**
|
|
8088
9364
|
* Plans a new trajectory for a single motion group. Describe the trajectory as a sequence of motion commands that the robots TCP should follow. Use the following workflow to execute a planned trajectory: 1. Plan a trajectory. 2. Optional: Load the planned trajectory into the cache using the [addTrajectory](addTrajectory) endpoint. 3. Execute the (cached) trajectory using the [executeTrajectory](executeTrajectory) endpoint. If the trajectory is not executable, the [PlanTrajectoryResponse](PlanTrajectoryResponse) will contain the joint trajectory up until the error, e.g. all samples until a collision occurs. EXCEPTION: If a CartesianPTP or JointPTP motion command has an invalid target, the response will contain the trajectory up until the start of the invalid PTP motion.
|
|
8089
9365
|
* @summary Plan Trajectory
|
|
@@ -8099,6 +9375,15 @@ export declare const TrajectoryPlanningApiFp: (configuration?: Configuration) =>
|
|
|
8099
9375
|
* @export
|
|
8100
9376
|
*/
|
|
8101
9377
|
export declare const TrajectoryPlanningApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
9378
|
+
/**
|
|
9379
|
+
* Plans a collision-free trajectory for a single motion group using point-to-point (PTP) motions. This endpoint is specifically designed for collision-free path planning algorithms that find a trajectory from a start joint position to a target position while avoiding obstacles. Use the following workflow to execute a planned collision-free trajectory: 1. Plan a collision-free trajectory. 2. Optional: Load the planned trajectory into the cache using the [addTrajectory](addTrajectory) endpoint. 3. Execute the (cached) trajectory using the [executeTrajectory](executeTrajectory) endpoint. If the trajectory planning fails due to collision or algorithm constraints, the response will contain error information about the failure.
|
|
9380
|
+
* @summary Plan Collision-Free Trajectory
|
|
9381
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
9382
|
+
* @param {PlanCollisionFreeRequest} [planCollisionFreeRequest]
|
|
9383
|
+
* @param {*} [options] Override http request option.
|
|
9384
|
+
* @throws {RequiredError}
|
|
9385
|
+
*/
|
|
9386
|
+
planCollisionFree(cell: string, planCollisionFreeRequest?: PlanCollisionFreeRequest, options?: RawAxiosRequestConfig): AxiosPromise<PlanCollisionFreeResponse>;
|
|
8102
9387
|
/**
|
|
8103
9388
|
* Plans a new trajectory for a single motion group. Describe the trajectory as a sequence of motion commands that the robots TCP should follow. Use the following workflow to execute a planned trajectory: 1. Plan a trajectory. 2. Optional: Load the planned trajectory into the cache using the [addTrajectory](addTrajectory) endpoint. 3. Execute the (cached) trajectory using the [executeTrajectory](executeTrajectory) endpoint. If the trajectory is not executable, the [PlanTrajectoryResponse](PlanTrajectoryResponse) will contain the joint trajectory up until the error, e.g. all samples until a collision occurs. EXCEPTION: If a CartesianPTP or JointPTP motion command has an invalid target, the response will contain the trajectory up until the start of the invalid PTP motion.
|
|
8104
9389
|
* @summary Plan Trajectory
|
|
@@ -8116,6 +9401,16 @@ export declare const TrajectoryPlanningApiFactory: (configuration?: Configuratio
|
|
|
8116
9401
|
* @extends {BaseAPI}
|
|
8117
9402
|
*/
|
|
8118
9403
|
export declare class TrajectoryPlanningApi extends BaseAPI {
|
|
9404
|
+
/**
|
|
9405
|
+
* Plans a collision-free trajectory for a single motion group using point-to-point (PTP) motions. This endpoint is specifically designed for collision-free path planning algorithms that find a trajectory from a start joint position to a target position while avoiding obstacles. Use the following workflow to execute a planned collision-free trajectory: 1. Plan a collision-free trajectory. 2. Optional: Load the planned trajectory into the cache using the [addTrajectory](addTrajectory) endpoint. 3. Execute the (cached) trajectory using the [executeTrajectory](executeTrajectory) endpoint. If the trajectory planning fails due to collision or algorithm constraints, the response will contain error information about the failure.
|
|
9406
|
+
* @summary Plan Collision-Free Trajectory
|
|
9407
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
9408
|
+
* @param {PlanCollisionFreeRequest} [planCollisionFreeRequest]
|
|
9409
|
+
* @param {*} [options] Override http request option.
|
|
9410
|
+
* @throws {RequiredError}
|
|
9411
|
+
* @memberof TrajectoryPlanningApi
|
|
9412
|
+
*/
|
|
9413
|
+
planCollisionFree(cell: string, planCollisionFreeRequest?: PlanCollisionFreeRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<PlanCollisionFreeResponse, any>>;
|
|
8119
9414
|
/**
|
|
8120
9415
|
* Plans a new trajectory for a single motion group. Describe the trajectory as a sequence of motion commands that the robots TCP should follow. Use the following workflow to execute a planned trajectory: 1. Plan a trajectory. 2. Optional: Load the planned trajectory into the cache using the [addTrajectory](addTrajectory) endpoint. 3. Execute the (cached) trajectory using the [executeTrajectory](executeTrajectory) endpoint. If the trajectory is not executable, the [PlanTrajectoryResponse](PlanTrajectoryResponse) will contain the joint trajectory up until the error, e.g. all samples until a collision occurs. EXCEPTION: If a CartesianPTP or JointPTP motion command has an invalid target, the response will contain the trajectory up until the start of the invalid PTP motion.
|
|
8121
9416
|
* @summary Plan Trajectory
|