@wandelbots/nova-api 25.7.0-dev.26 → 25.7.0-dev.28
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 +1784 -523
- package/v2/api.js +1408 -253
- package/v2/api.js.map +1 -1
- package/v2/api.ts +2460 -480
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,66 +1557,149 @@ 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 {
|
|
1419
|
-
* @memberof
|
|
1621
|
+
*
|
|
1622
|
+
* @type {Array<ValidationErrorLocInner>}
|
|
1623
|
+
* @memberof ForwardKinematicsValidationError
|
|
1420
1624
|
*/
|
|
1421
|
-
'
|
|
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 GetTrajectoryResponse
|
|
1657
|
+
*/
|
|
1658
|
+
export interface GetTrajectoryResponse {
|
|
1659
|
+
/**
|
|
1660
|
+
* Unique identifier of the motion group the trajectory is planned for.
|
|
1661
|
+
* @type {string}
|
|
1662
|
+
* @memberof GetTrajectoryResponse
|
|
1663
|
+
*/
|
|
1664
|
+
'motion_group': string;
|
|
1665
|
+
/**
|
|
1666
|
+
* The trajectory consisting of a list of joint positions and an equal number of corresponding timestamps.
|
|
1667
|
+
* @type {JointTrajectory}
|
|
1668
|
+
* @memberof GetTrajectoryResponse
|
|
1669
|
+
*/
|
|
1670
|
+
'trajectory': JointTrajectory;
|
|
1671
|
+
/**
|
|
1672
|
+
* Unique identifier of the tool the trajectory is planned for.
|
|
1673
|
+
* @type {string}
|
|
1674
|
+
* @memberof GetTrajectoryResponse
|
|
1675
|
+
*/
|
|
1676
|
+
'tcp': string;
|
|
1677
|
+
}
|
|
1678
|
+
/**
|
|
1679
|
+
*
|
|
1680
|
+
* @export
|
|
1681
|
+
* @interface HTTPValidationError
|
|
1682
|
+
*/
|
|
1683
|
+
export interface HTTPValidationError {
|
|
1684
|
+
/**
|
|
1685
|
+
*
|
|
1686
|
+
* @type {Array<ValidationError>}
|
|
1687
|
+
* @memberof HTTPValidationError
|
|
1688
|
+
*/
|
|
1689
|
+
'detail'?: Array<ValidationError>;
|
|
1690
|
+
}
|
|
1691
|
+
/**
|
|
1692
|
+
* Input/Output boolean value representation.
|
|
1693
|
+
* @export
|
|
1694
|
+
* @interface IOBooleanValue
|
|
1695
|
+
*/
|
|
1696
|
+
export interface IOBooleanValue {
|
|
1697
|
+
/**
|
|
1698
|
+
* Unique identifier of the input/output.
|
|
1699
|
+
* @type {string}
|
|
1700
|
+
* @memberof IOBooleanValue
|
|
1701
|
+
*/
|
|
1702
|
+
'io': string;
|
|
1422
1703
|
/**
|
|
1423
1704
|
* Value of a digital input/output.
|
|
1424
1705
|
* @type {boolean}
|
|
@@ -1860,6 +2141,19 @@ export interface InvalidDofInvalidDof {
|
|
|
1860
2141
|
*/
|
|
1861
2142
|
'joint_position'?: Array<number>;
|
|
1862
2143
|
}
|
|
2144
|
+
/**
|
|
2145
|
+
*
|
|
2146
|
+
* @export
|
|
2147
|
+
* @interface InverseKinematics422Response
|
|
2148
|
+
*/
|
|
2149
|
+
export interface InverseKinematics422Response {
|
|
2150
|
+
/**
|
|
2151
|
+
*
|
|
2152
|
+
* @type {Array<InverseKinematicsValidationError>}
|
|
2153
|
+
* @memberof InverseKinematics422Response
|
|
2154
|
+
*/
|
|
2155
|
+
'detail'?: Array<InverseKinematicsValidationError>;
|
|
2156
|
+
}
|
|
1863
2157
|
/**
|
|
1864
2158
|
*
|
|
1865
2159
|
* @export
|
|
@@ -1897,12 +2191,12 @@ export interface InverseKinematicsRequest {
|
|
|
1897
2191
|
*/
|
|
1898
2192
|
'joint_position_limits'?: Array<LimitRange>;
|
|
1899
2193
|
/**
|
|
1900
|
-
* Collision
|
|
1901
|
-
* @type {{ [key: string]:
|
|
2194
|
+
* 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.
|
|
2195
|
+
* @type {{ [key: string]: CollisionSetup; }}
|
|
1902
2196
|
* @memberof InverseKinematicsRequest
|
|
1903
2197
|
*/
|
|
1904
|
-
'
|
|
1905
|
-
[key: string]:
|
|
2198
|
+
'collision_setups'?: {
|
|
2199
|
+
[key: string]: CollisionSetup;
|
|
1906
2200
|
};
|
|
1907
2201
|
}
|
|
1908
2202
|
/**
|
|
@@ -1918,6 +2212,55 @@ export interface InverseKinematicsResponse {
|
|
|
1918
2212
|
*/
|
|
1919
2213
|
'joints': Array<Array<Array<number>>>;
|
|
1920
2214
|
}
|
|
2215
|
+
/**
|
|
2216
|
+
*
|
|
2217
|
+
* @export
|
|
2218
|
+
* @interface InverseKinematicsValidationError
|
|
2219
|
+
*/
|
|
2220
|
+
export interface InverseKinematicsValidationError {
|
|
2221
|
+
/**
|
|
2222
|
+
*
|
|
2223
|
+
* @type {Array<ValidationErrorLocInner>}
|
|
2224
|
+
* @memberof InverseKinematicsValidationError
|
|
2225
|
+
*/
|
|
2226
|
+
'loc': Array<ValidationErrorLocInner>;
|
|
2227
|
+
/**
|
|
2228
|
+
*
|
|
2229
|
+
* @type {string}
|
|
2230
|
+
* @memberof InverseKinematicsValidationError
|
|
2231
|
+
*/
|
|
2232
|
+
'msg': string;
|
|
2233
|
+
/**
|
|
2234
|
+
*
|
|
2235
|
+
* @type {string}
|
|
2236
|
+
* @memberof InverseKinematicsValidationError
|
|
2237
|
+
*/
|
|
2238
|
+
'type': string;
|
|
2239
|
+
/**
|
|
2240
|
+
*
|
|
2241
|
+
* @type {{ [key: string]: any; }}
|
|
2242
|
+
* @memberof InverseKinematicsValidationError
|
|
2243
|
+
*/
|
|
2244
|
+
'input': {
|
|
2245
|
+
[key: string]: any;
|
|
2246
|
+
};
|
|
2247
|
+
/**
|
|
2248
|
+
*
|
|
2249
|
+
* @type {InverseKinematicsValidationErrorAllOfData}
|
|
2250
|
+
* @memberof InverseKinematicsValidationError
|
|
2251
|
+
*/
|
|
2252
|
+
'data'?: InverseKinematicsValidationErrorAllOfData;
|
|
2253
|
+
}
|
|
2254
|
+
/**
|
|
2255
|
+
* @type InverseKinematicsValidationErrorAllOfData
|
|
2256
|
+
* Optional data further specifying the validation error.
|
|
2257
|
+
* @export
|
|
2258
|
+
*/
|
|
2259
|
+
export type InverseKinematicsValidationErrorAllOfData = {
|
|
2260
|
+
error_feedback_name: 'ErrorInvalidJointCount';
|
|
2261
|
+
} & ErrorInvalidJointCount | {
|
|
2262
|
+
error_feedback_name: 'ErrorJointLimitExceeded';
|
|
2263
|
+
} & ErrorJointLimitExceeded;
|
|
1921
2264
|
/**
|
|
1922
2265
|
* 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
2266
|
* @export
|
|
@@ -2464,6 +2807,29 @@ export declare const Manufacturer: {
|
|
|
2464
2807
|
readonly Yaskawa: "yaskawa";
|
|
2465
2808
|
};
|
|
2466
2809
|
export type Manufacturer = typeof Manufacturer[keyof typeof Manufacturer];
|
|
2810
|
+
/**
|
|
2811
|
+
* 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.
|
|
2812
|
+
* @export
|
|
2813
|
+
* @interface MidpointInsertionAlgorithm
|
|
2814
|
+
*/
|
|
2815
|
+
export interface MidpointInsertionAlgorithm {
|
|
2816
|
+
/**
|
|
2817
|
+
* Algorithm discriminator.
|
|
2818
|
+
* @type {string}
|
|
2819
|
+
* @memberof MidpointInsertionAlgorithm
|
|
2820
|
+
*/
|
|
2821
|
+
'algorithm_name': MidpointInsertionAlgorithmAlgorithmNameEnum;
|
|
2822
|
+
/**
|
|
2823
|
+
* Maximum number of iterations for the midpoint insertion algorithm. Higher values increase likelyhood of success, but also computation time (linear).
|
|
2824
|
+
* @type {number}
|
|
2825
|
+
* @memberof MidpointInsertionAlgorithm
|
|
2826
|
+
*/
|
|
2827
|
+
'max_iterations'?: number;
|
|
2828
|
+
}
|
|
2829
|
+
export declare const MidpointInsertionAlgorithmAlgorithmNameEnum: {
|
|
2830
|
+
readonly MidpointInsertionAlgorithm: "MidpointInsertionAlgorithm";
|
|
2831
|
+
};
|
|
2832
|
+
export type MidpointInsertionAlgorithmAlgorithmNameEnum = typeof MidpointInsertionAlgorithmAlgorithmNameEnum[keyof typeof MidpointInsertionAlgorithmAlgorithmNameEnum];
|
|
2467
2833
|
/**
|
|
2468
2834
|
*
|
|
2469
2835
|
* @export
|
|
@@ -2654,6 +3020,57 @@ export interface MotionGroupJoints {
|
|
|
2654
3020
|
*/
|
|
2655
3021
|
'torques'?: Array<number>;
|
|
2656
3022
|
}
|
|
3023
|
+
/**
|
|
3024
|
+
*
|
|
3025
|
+
* @export
|
|
3026
|
+
* @interface MotionGroupSetup
|
|
3027
|
+
*/
|
|
3028
|
+
export interface MotionGroupSetup {
|
|
3029
|
+
/**
|
|
3030
|
+
* String identifiying the model of a motion group.
|
|
3031
|
+
* @type {string}
|
|
3032
|
+
* @memberof MotionGroupSetup
|
|
3033
|
+
*/
|
|
3034
|
+
'motion_group_model': string;
|
|
3035
|
+
/**
|
|
3036
|
+
* [ms] cycle time of the motion group controller. A trajectory for this motion group should be computed to this resolution.
|
|
3037
|
+
* @type {number}
|
|
3038
|
+
* @memberof MotionGroupSetup
|
|
3039
|
+
*/
|
|
3040
|
+
'cycle_time': number;
|
|
3041
|
+
/**
|
|
3042
|
+
* The offset from the world frame to the motion group base.
|
|
3043
|
+
* @type {Pose}
|
|
3044
|
+
* @memberof MotionGroupSetup
|
|
3045
|
+
*/
|
|
3046
|
+
'mounting'?: Pose;
|
|
3047
|
+
/**
|
|
3048
|
+
*
|
|
3049
|
+
* @type {Pose}
|
|
3050
|
+
* @memberof MotionGroupSetup
|
|
3051
|
+
*/
|
|
3052
|
+
'tcp_offset'?: Pose;
|
|
3053
|
+
/**
|
|
3054
|
+
*
|
|
3055
|
+
* @type {LimitSet}
|
|
3056
|
+
* @memberof MotionGroupSetup
|
|
3057
|
+
*/
|
|
3058
|
+
'global_limits'?: LimitSet;
|
|
3059
|
+
/**
|
|
3060
|
+
*
|
|
3061
|
+
* @type {Payload}
|
|
3062
|
+
* @memberof MotionGroupSetup
|
|
3063
|
+
*/
|
|
3064
|
+
'payload'?: Payload;
|
|
3065
|
+
/**
|
|
3066
|
+
* 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.
|
|
3067
|
+
* @type {{ [key: string]: CollisionSetup; }}
|
|
3068
|
+
* @memberof MotionGroupSetup
|
|
3069
|
+
*/
|
|
3070
|
+
'collision_setups'?: {
|
|
3071
|
+
[key: string]: CollisionSetup;
|
|
3072
|
+
};
|
|
3073
|
+
}
|
|
2657
3074
|
/**
|
|
2658
3075
|
* Presents the current state of the motion group.
|
|
2659
3076
|
* @export
|
|
@@ -3170,6 +3587,81 @@ export interface Payload {
|
|
|
3170
3587
|
*/
|
|
3171
3588
|
'moment_of_inertia'?: Array<number>;
|
|
3172
3589
|
}
|
|
3590
|
+
/**
|
|
3591
|
+
*
|
|
3592
|
+
* @export
|
|
3593
|
+
* @interface Plan422Response
|
|
3594
|
+
*/
|
|
3595
|
+
export interface Plan422Response {
|
|
3596
|
+
/**
|
|
3597
|
+
*
|
|
3598
|
+
* @type {Array<PlanValidationError>}
|
|
3599
|
+
* @memberof Plan422Response
|
|
3600
|
+
*/
|
|
3601
|
+
'detail'?: Array<PlanValidationError>;
|
|
3602
|
+
}
|
|
3603
|
+
/**
|
|
3604
|
+
* Response when collision-free trajectory planning fails. Contains specific feedback about why the planning failed.
|
|
3605
|
+
* @export
|
|
3606
|
+
* @interface PlanCollisionFreeFailedResponse
|
|
3607
|
+
*/
|
|
3608
|
+
export interface PlanCollisionFreeFailedResponse {
|
|
3609
|
+
/**
|
|
3610
|
+
*
|
|
3611
|
+
* @type {ErrorMaxIterationsExceeded}
|
|
3612
|
+
* @memberof PlanCollisionFreeFailedResponse
|
|
3613
|
+
*/
|
|
3614
|
+
'error_feedback': ErrorMaxIterationsExceeded;
|
|
3615
|
+
}
|
|
3616
|
+
/**
|
|
3617
|
+
*
|
|
3618
|
+
* @export
|
|
3619
|
+
* @interface PlanCollisionFreeRequest
|
|
3620
|
+
*/
|
|
3621
|
+
export interface PlanCollisionFreeRequest {
|
|
3622
|
+
/**
|
|
3623
|
+
* The data to assemble the robot setup can be retrieved from [getMotionGroupDescription](getMotionGroupDescription) endpoint.
|
|
3624
|
+
* @type {MotionGroupSetup}
|
|
3625
|
+
* @memberof PlanCollisionFreeRequest
|
|
3626
|
+
*/
|
|
3627
|
+
'motion_group_setup': MotionGroupSetup;
|
|
3628
|
+
/**
|
|
3629
|
+
*
|
|
3630
|
+
* @type {Array<number>}
|
|
3631
|
+
* @memberof PlanCollisionFreeRequest
|
|
3632
|
+
*/
|
|
3633
|
+
'start_joint_position': Array<number>;
|
|
3634
|
+
/**
|
|
3635
|
+
*
|
|
3636
|
+
* @type {Array<number>}
|
|
3637
|
+
* @memberof PlanCollisionFreeRequest
|
|
3638
|
+
*/
|
|
3639
|
+
'target': Array<number>;
|
|
3640
|
+
/**
|
|
3641
|
+
*
|
|
3642
|
+
* @type {CollisionFreeAlgorithm}
|
|
3643
|
+
* @memberof PlanCollisionFreeRequest
|
|
3644
|
+
*/
|
|
3645
|
+
'algorithm': CollisionFreeAlgorithm;
|
|
3646
|
+
}
|
|
3647
|
+
/**
|
|
3648
|
+
* Response from collision-free trajectory planning. Contains either a successful joint trajectory or failure information.
|
|
3649
|
+
* @export
|
|
3650
|
+
* @interface PlanCollisionFreeResponse
|
|
3651
|
+
*/
|
|
3652
|
+
export interface PlanCollisionFreeResponse {
|
|
3653
|
+
/**
|
|
3654
|
+
*
|
|
3655
|
+
* @type {PlanCollisionFreeResponseResponse}
|
|
3656
|
+
* @memberof PlanCollisionFreeResponse
|
|
3657
|
+
*/
|
|
3658
|
+
'response': PlanCollisionFreeResponseResponse;
|
|
3659
|
+
}
|
|
3660
|
+
/**
|
|
3661
|
+
* @type PlanCollisionFreeResponseResponse
|
|
3662
|
+
* @export
|
|
3663
|
+
*/
|
|
3664
|
+
export type PlanCollisionFreeResponseResponse = JointTrajectory | PlanCollisionFreeFailedResponse;
|
|
3173
3665
|
/**
|
|
3174
3666
|
*
|
|
3175
3667
|
* @export
|
|
@@ -3208,10 +3700,10 @@ export type PlanTrajectoryFailedResponseErrorFeedback = FeedbackCollision | Feed
|
|
|
3208
3700
|
export interface PlanTrajectoryRequest {
|
|
3209
3701
|
/**
|
|
3210
3702
|
* The data to assemble the robot setup can be retrieved from [getMotionGroupDescription](getMotionGroupDescription) endpoint.
|
|
3211
|
-
* @type {
|
|
3703
|
+
* @type {MotionGroupSetup}
|
|
3212
3704
|
* @memberof PlanTrajectoryRequest
|
|
3213
3705
|
*/
|
|
3214
|
-
'
|
|
3706
|
+
'motion_group_setup': MotionGroupSetup;
|
|
3215
3707
|
/**
|
|
3216
3708
|
*
|
|
3217
3709
|
* @type {Array<number>}
|
|
@@ -3243,6 +3735,57 @@ export interface PlanTrajectoryResponse {
|
|
|
3243
3735
|
* @export
|
|
3244
3736
|
*/
|
|
3245
3737
|
export type PlanTrajectoryResponseResponse = JointTrajectory | PlanTrajectoryFailedResponse;
|
|
3738
|
+
/**
|
|
3739
|
+
*
|
|
3740
|
+
* @export
|
|
3741
|
+
* @interface PlanValidationError
|
|
3742
|
+
*/
|
|
3743
|
+
export interface PlanValidationError {
|
|
3744
|
+
/**
|
|
3745
|
+
*
|
|
3746
|
+
* @type {Array<ValidationErrorLocInner>}
|
|
3747
|
+
* @memberof PlanValidationError
|
|
3748
|
+
*/
|
|
3749
|
+
'loc': Array<ValidationErrorLocInner>;
|
|
3750
|
+
/**
|
|
3751
|
+
*
|
|
3752
|
+
* @type {string}
|
|
3753
|
+
* @memberof PlanValidationError
|
|
3754
|
+
*/
|
|
3755
|
+
'msg': string;
|
|
3756
|
+
/**
|
|
3757
|
+
*
|
|
3758
|
+
* @type {string}
|
|
3759
|
+
* @memberof PlanValidationError
|
|
3760
|
+
*/
|
|
3761
|
+
'type': string;
|
|
3762
|
+
/**
|
|
3763
|
+
*
|
|
3764
|
+
* @type {{ [key: string]: any; }}
|
|
3765
|
+
* @memberof PlanValidationError
|
|
3766
|
+
*/
|
|
3767
|
+
'input': {
|
|
3768
|
+
[key: string]: any;
|
|
3769
|
+
};
|
|
3770
|
+
/**
|
|
3771
|
+
*
|
|
3772
|
+
* @type {PlanValidationErrorAllOfData}
|
|
3773
|
+
* @memberof PlanValidationError
|
|
3774
|
+
*/
|
|
3775
|
+
'data'?: PlanValidationErrorAllOfData;
|
|
3776
|
+
}
|
|
3777
|
+
/**
|
|
3778
|
+
* @type PlanValidationErrorAllOfData
|
|
3779
|
+
* Optional data further specifying the validation error.
|
|
3780
|
+
* @export
|
|
3781
|
+
*/
|
|
3782
|
+
export type PlanValidationErrorAllOfData = {
|
|
3783
|
+
error_feedback_name: 'ErrorInvalidJointCount';
|
|
3784
|
+
} & ErrorInvalidJointCount | {
|
|
3785
|
+
error_feedback_name: 'ErrorJointLimitExceeded';
|
|
3786
|
+
} & ErrorJointLimitExceeded | {
|
|
3787
|
+
error_feedback_name: 'ErrorJointPositionCollision';
|
|
3788
|
+
} & ErrorJointPositionCollision;
|
|
3246
3789
|
/**
|
|
3247
3790
|
* Defines an x/y-plane with infinite size.
|
|
3248
3791
|
* @export
|
|
@@ -3326,32 +3869,276 @@ export interface Pose {
|
|
|
3326
3869
|
'orientation'?: Array<number>;
|
|
3327
3870
|
}
|
|
3328
3871
|
/**
|
|
3329
|
-
*
|
|
3872
|
+
*
|
|
3330
3873
|
* @export
|
|
3331
|
-
* @interface
|
|
3874
|
+
* @interface ProfinetDescription
|
|
3332
3875
|
*/
|
|
3333
|
-
export interface
|
|
3876
|
+
export interface ProfinetDescription {
|
|
3334
3877
|
/**
|
|
3335
|
-
*
|
|
3878
|
+
* The vendor identifier of the PROFINET device, identifying the manufacturer.
|
|
3336
3879
|
* @type {string}
|
|
3337
|
-
* @memberof
|
|
3880
|
+
* @memberof ProfinetDescription
|
|
3338
3881
|
*/
|
|
3339
|
-
'
|
|
3882
|
+
'vendor_id': string;
|
|
3340
3883
|
/**
|
|
3341
|
-
* The
|
|
3342
|
-
* @type {
|
|
3343
|
-
* @memberof
|
|
3884
|
+
* The device identifier of the PROFINET device, identifying the specific device within the vendor\'s range.
|
|
3885
|
+
* @type {string}
|
|
3886
|
+
* @memberof ProfinetDescription
|
|
3344
3887
|
*/
|
|
3345
|
-
'
|
|
3888
|
+
'device_id': string;
|
|
3346
3889
|
/**
|
|
3347
|
-
*
|
|
3348
|
-
* @type {
|
|
3349
|
-
* @memberof
|
|
3890
|
+
*
|
|
3891
|
+
* @type {Array<ProfinetSlotDescription>}
|
|
3892
|
+
* @memberof ProfinetDescription
|
|
3350
3893
|
*/
|
|
3351
|
-
'
|
|
3894
|
+
'slots'?: Array<ProfinetSlotDescription>;
|
|
3895
|
+
/**
|
|
3896
|
+
* Name of the PROFINET device
|
|
3897
|
+
* @type {string}
|
|
3898
|
+
* @memberof ProfinetDescription
|
|
3899
|
+
*/
|
|
3900
|
+
'device_name'?: string;
|
|
3901
|
+
/**
|
|
3902
|
+
* IP address for the PROFINET device
|
|
3903
|
+
* @type {string}
|
|
3904
|
+
* @memberof ProfinetDescription
|
|
3905
|
+
*/
|
|
3906
|
+
'ip'?: string;
|
|
3352
3907
|
}
|
|
3353
|
-
|
|
3354
|
-
|
|
3908
|
+
/**
|
|
3909
|
+
*
|
|
3910
|
+
* @export
|
|
3911
|
+
* @interface ProfinetIO
|
|
3912
|
+
*/
|
|
3913
|
+
export interface ProfinetIO {
|
|
3914
|
+
/**
|
|
3915
|
+
* 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.
|
|
3916
|
+
* @type {string}
|
|
3917
|
+
* @memberof ProfinetIO
|
|
3918
|
+
*/
|
|
3919
|
+
'name': string;
|
|
3920
|
+
/**
|
|
3921
|
+
*
|
|
3922
|
+
* @type {ProfinetIOTypeEnum}
|
|
3923
|
+
* @memberof ProfinetIO
|
|
3924
|
+
*/
|
|
3925
|
+
'type': ProfinetIOTypeEnum;
|
|
3926
|
+
/**
|
|
3927
|
+
* The direction of the input/output value, indicating whether it is an input or output for the device.
|
|
3928
|
+
* @type {ProfinetIODirection}
|
|
3929
|
+
* @memberof ProfinetIO
|
|
3930
|
+
*/
|
|
3931
|
+
'direction': ProfinetIODirection;
|
|
3932
|
+
/**
|
|
3933
|
+
* 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.
|
|
3934
|
+
* @type {number}
|
|
3935
|
+
* @memberof ProfinetIO
|
|
3936
|
+
*/
|
|
3937
|
+
'byte_address': number;
|
|
3938
|
+
/**
|
|
3939
|
+
* 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.
|
|
3940
|
+
* @type {number}
|
|
3941
|
+
* @memberof ProfinetIO
|
|
3942
|
+
*/
|
|
3943
|
+
'bit_address'?: number;
|
|
3944
|
+
/**
|
|
3945
|
+
* The unique identifier for the input/output value. This identifier is used to reference the specific input/output in the NOVA system.
|
|
3946
|
+
* @type {string}
|
|
3947
|
+
* @memberof ProfinetIO
|
|
3948
|
+
*/
|
|
3949
|
+
'io': string;
|
|
3950
|
+
}
|
|
3951
|
+
/**
|
|
3952
|
+
*
|
|
3953
|
+
* @export
|
|
3954
|
+
* @interface ProfinetIOData
|
|
3955
|
+
*/
|
|
3956
|
+
export interface ProfinetIOData {
|
|
3957
|
+
/**
|
|
3958
|
+
* 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.
|
|
3959
|
+
* @type {string}
|
|
3960
|
+
* @memberof ProfinetIOData
|
|
3961
|
+
*/
|
|
3962
|
+
'name': string;
|
|
3963
|
+
/**
|
|
3964
|
+
*
|
|
3965
|
+
* @type {ProfinetIOTypeEnum}
|
|
3966
|
+
* @memberof ProfinetIOData
|
|
3967
|
+
*/
|
|
3968
|
+
'type': ProfinetIOTypeEnum;
|
|
3969
|
+
/**
|
|
3970
|
+
* The direction of the input/output value, indicating whether it is an input or output for the device.
|
|
3971
|
+
* @type {ProfinetIODirection}
|
|
3972
|
+
* @memberof ProfinetIOData
|
|
3973
|
+
*/
|
|
3974
|
+
'direction': ProfinetIODirection;
|
|
3975
|
+
/**
|
|
3976
|
+
* 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.
|
|
3977
|
+
* @type {number}
|
|
3978
|
+
* @memberof ProfinetIOData
|
|
3979
|
+
*/
|
|
3980
|
+
'byte_address': number;
|
|
3981
|
+
/**
|
|
3982
|
+
* 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.
|
|
3983
|
+
* @type {number}
|
|
3984
|
+
* @memberof ProfinetIOData
|
|
3985
|
+
*/
|
|
3986
|
+
'bit_address'?: number;
|
|
3987
|
+
}
|
|
3988
|
+
/**
|
|
3989
|
+
* Identifies the input/output type.
|
|
3990
|
+
* @export
|
|
3991
|
+
* @enum {string}
|
|
3992
|
+
*/
|
|
3993
|
+
export declare const ProfinetIODirection: {
|
|
3994
|
+
readonly ProfinetIoDirectionInput: "PROFINET_IO_DIRECTION_INPUT";
|
|
3995
|
+
readonly ProfinetIoDirectionOutput: "PROFINET_IO_DIRECTION_OUTPUT";
|
|
3996
|
+
readonly ProfinetIoDirectionInout: "PROFINET_IO_DIRECTION_INOUT";
|
|
3997
|
+
};
|
|
3998
|
+
export type ProfinetIODirection = typeof ProfinetIODirection[keyof typeof ProfinetIODirection];
|
|
3999
|
+
/**
|
|
4000
|
+
* Value type of the PROFINET input/output.
|
|
4001
|
+
* @export
|
|
4002
|
+
* @enum {string}
|
|
4003
|
+
*/
|
|
4004
|
+
export declare const ProfinetIOTypeEnum: {
|
|
4005
|
+
readonly ProfinetIoTypeUnknown: "PROFINET_IO_TYPE_UNKNOWN";
|
|
4006
|
+
readonly ProfinetIoTypeBool: "PROFINET_IO_TYPE_BOOL";
|
|
4007
|
+
readonly ProfinetIoTypeUsint: "PROFINET_IO_TYPE_USINT";
|
|
4008
|
+
readonly ProfinetIoTypeSint: "PROFINET_IO_TYPE_SINT";
|
|
4009
|
+
readonly ProfinetIoTypeUint: "PROFINET_IO_TYPE_UINT";
|
|
4010
|
+
readonly ProfinetIoTypeInt: "PROFINET_IO_TYPE_INT";
|
|
4011
|
+
readonly ProfinetIoTypeUdint: "PROFINET_IO_TYPE_UDINT";
|
|
4012
|
+
readonly ProfinetIoTypeDint: "PROFINET_IO_TYPE_DINT";
|
|
4013
|
+
readonly ProfinetIoTypeReal: "PROFINET_IO_TYPE_REAL";
|
|
4014
|
+
readonly ProfinetIoTypeLreal: "PROFINET_IO_TYPE_LREAL";
|
|
4015
|
+
};
|
|
4016
|
+
export type ProfinetIOTypeEnum = typeof ProfinetIOTypeEnum[keyof typeof ProfinetIOTypeEnum];
|
|
4017
|
+
/**
|
|
4018
|
+
*
|
|
4019
|
+
* @export
|
|
4020
|
+
* @interface ProfinetInputOutputConfig
|
|
4021
|
+
*/
|
|
4022
|
+
export interface ProfinetInputOutputConfig {
|
|
4023
|
+
/**
|
|
4024
|
+
* Content of the input output configuration file.
|
|
4025
|
+
* @type {string}
|
|
4026
|
+
* @memberof ProfinetInputOutputConfig
|
|
4027
|
+
*/
|
|
4028
|
+
'config': string;
|
|
4029
|
+
/**
|
|
4030
|
+
* Offset in bytes for the input data.
|
|
4031
|
+
* @type {number}
|
|
4032
|
+
* @memberof ProfinetInputOutputConfig
|
|
4033
|
+
*/
|
|
4034
|
+
'input_offset': number;
|
|
4035
|
+
/**
|
|
4036
|
+
* Offset in bytes for the output data.
|
|
4037
|
+
* @type {number}
|
|
4038
|
+
* @memberof ProfinetInputOutputConfig
|
|
4039
|
+
*/
|
|
4040
|
+
'output_offset': number;
|
|
4041
|
+
}
|
|
4042
|
+
/**
|
|
4043
|
+
*
|
|
4044
|
+
* @export
|
|
4045
|
+
* @interface ProfinetSlotDescription
|
|
4046
|
+
*/
|
|
4047
|
+
export interface ProfinetSlotDescription {
|
|
4048
|
+
/**
|
|
4049
|
+
* The number of the PROFINET slot.
|
|
4050
|
+
* @type {number}
|
|
4051
|
+
* @memberof ProfinetSlotDescription
|
|
4052
|
+
*/
|
|
4053
|
+
'number': number;
|
|
4054
|
+
/**
|
|
4055
|
+
* The API number of the PROFINET input, used to identify the specific API for the input.
|
|
4056
|
+
* @type {number}
|
|
4057
|
+
* @memberof ProfinetSlotDescription
|
|
4058
|
+
*/
|
|
4059
|
+
'api': number;
|
|
4060
|
+
/**
|
|
4061
|
+
* An array of PROFINET subslots.
|
|
4062
|
+
* @type {Array<ProfinetSubSlotDescription>}
|
|
4063
|
+
* @memberof ProfinetSlotDescription
|
|
4064
|
+
*/
|
|
4065
|
+
'subslots': Array<ProfinetSubSlotDescription>;
|
|
4066
|
+
}
|
|
4067
|
+
/**
|
|
4068
|
+
*
|
|
4069
|
+
* @export
|
|
4070
|
+
* @interface ProfinetSubSlotDescription
|
|
4071
|
+
*/
|
|
4072
|
+
export interface ProfinetSubSlotDescription {
|
|
4073
|
+
/**
|
|
4074
|
+
* The identifier of the PROFINET subslot.
|
|
4075
|
+
* @type {number}
|
|
4076
|
+
* @memberof ProfinetSubSlotDescription
|
|
4077
|
+
*/
|
|
4078
|
+
'number': number;
|
|
4079
|
+
/**
|
|
4080
|
+
* The length in bytes of the PROFINET input.
|
|
4081
|
+
* @type {number}
|
|
4082
|
+
* @memberof ProfinetSubSlotDescription
|
|
4083
|
+
*/
|
|
4084
|
+
'input_length': number;
|
|
4085
|
+
/**
|
|
4086
|
+
* The length in bytes of the PROFINET output.
|
|
4087
|
+
* @type {number}
|
|
4088
|
+
* @memberof ProfinetSubSlotDescription
|
|
4089
|
+
*/
|
|
4090
|
+
'output_length': number;
|
|
4091
|
+
}
|
|
4092
|
+
/**
|
|
4093
|
+
* <!-- 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.
|
|
4094
|
+
* @export
|
|
4095
|
+
* @interface RRTConnectAlgorithm
|
|
4096
|
+
*/
|
|
4097
|
+
export interface RRTConnectAlgorithm {
|
|
4098
|
+
/**
|
|
4099
|
+
* Algorithm discriminator.
|
|
4100
|
+
* @type {string}
|
|
4101
|
+
* @memberof RRTConnectAlgorithm
|
|
4102
|
+
*/
|
|
4103
|
+
'algorithm_name': RRTConnectAlgorithmAlgorithmNameEnum;
|
|
4104
|
+
/**
|
|
4105
|
+
* Maximum number of iterations for the RRT Connect algorithm. Higher values increase likelihood of success, but also computation time.
|
|
4106
|
+
* @type {number}
|
|
4107
|
+
* @memberof RRTConnectAlgorithm
|
|
4108
|
+
*/
|
|
4109
|
+
'max_iterations'?: number;
|
|
4110
|
+
}
|
|
4111
|
+
export declare const RRTConnectAlgorithmAlgorithmNameEnum: {
|
|
4112
|
+
readonly RrtConnectAlgorithm: "RRTConnectAlgorithm";
|
|
4113
|
+
};
|
|
4114
|
+
export type RRTConnectAlgorithmAlgorithmNameEnum = typeof RRTConnectAlgorithmAlgorithmNameEnum[keyof typeof RRTConnectAlgorithmAlgorithmNameEnum];
|
|
4115
|
+
/**
|
|
4116
|
+
* Defines an x/y-plane with finite size. Centred around the z-axis.
|
|
4117
|
+
* @export
|
|
4118
|
+
* @interface Rectangle
|
|
4119
|
+
*/
|
|
4120
|
+
export interface Rectangle {
|
|
4121
|
+
/**
|
|
4122
|
+
*
|
|
4123
|
+
* @type {string}
|
|
4124
|
+
* @memberof Rectangle
|
|
4125
|
+
*/
|
|
4126
|
+
'shape_type': RectangleShapeTypeEnum;
|
|
4127
|
+
/**
|
|
4128
|
+
* The dimension in x-direction in [mm].
|
|
4129
|
+
* @type {number}
|
|
4130
|
+
* @memberof Rectangle
|
|
4131
|
+
*/
|
|
4132
|
+
'size_x': number;
|
|
4133
|
+
/**
|
|
4134
|
+
* The dimension in y-direction in [mm].
|
|
4135
|
+
* @type {number}
|
|
4136
|
+
* @memberof Rectangle
|
|
4137
|
+
*/
|
|
4138
|
+
'size_y': number;
|
|
4139
|
+
}
|
|
4140
|
+
export declare const RectangleShapeTypeEnum: {
|
|
4141
|
+
readonly Rectangle: "rectangle";
|
|
3355
4142
|
};
|
|
3356
4143
|
export type RectangleShapeTypeEnum = typeof RectangleShapeTypeEnum[keyof typeof RectangleShapeTypeEnum];
|
|
3357
4144
|
/**
|
|
@@ -3429,6 +4216,18 @@ export type RobotControllerConfiguration = AbbController | FanucController | Kuk
|
|
|
3429
4216
|
* @interface RobotControllerState
|
|
3430
4217
|
*/
|
|
3431
4218
|
export interface RobotControllerState {
|
|
4219
|
+
/**
|
|
4220
|
+
* Mode of communication and control between NOVA and the robot controller.
|
|
4221
|
+
* @type {RobotSystemMode}
|
|
4222
|
+
* @memberof RobotControllerState
|
|
4223
|
+
*/
|
|
4224
|
+
'mode': RobotSystemMode;
|
|
4225
|
+
/**
|
|
4226
|
+
* Last error stack encountered during initialization process or after a controller disconnect. At this stage, it\'s unclear whether the error is fatal. Evaluate `last_error` to decide whether to remove the controller using `deleteController`. Examples: - Delete required: Host resolution fails repeatedly due to an incorrect IP. - Delete not required: Temporary network delay caused a disconnect; the system will auto-reconnect.
|
|
4227
|
+
* @type {Array<string>}
|
|
4228
|
+
* @memberof RobotControllerState
|
|
4229
|
+
*/
|
|
4230
|
+
'last_error'?: Array<string>;
|
|
3432
4231
|
/**
|
|
3433
4232
|
* Timestamp indicating when the represented information was received from the robot controller.
|
|
3434
4233
|
* @type {string}
|
|
@@ -3473,67 +4272,16 @@ export interface RobotControllerState {
|
|
|
3473
4272
|
'motion_groups': Array<MotionGroupState>;
|
|
3474
4273
|
}
|
|
3475
4274
|
/**
|
|
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
|
-
/**
|
|
3527
|
-
* 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.
|
|
4275
|
+
* Defines the current system mode of the robot system, including NOVA communicating with the robot controller. ### MODE_CONTROLLER_NOT_CONFIGURED No controller with the specified identifier is configured. Call [addRobotController](addRobotController) to register a controller. ### MODE_INITIALIZING Indicates that a connection to the robot controller is established or reestablished in case of a disconnect. On success, the controller is set to MODE_MONITOR. On failure, the initialization process is retried until successful or cancelled by the user. ### MODE_MONITOR Read-only mode with an active controller connection. - Receives robot state and I/O signals - Move requests are rejected - No commands are sent to the controller ### MODE_CONTROL Active control mode. **Movement is possible in this mode** The robot is cyclically commanded to hold its current position. The robot state is received in sync with the controller cycle. Motion and jogging requests are accepted and executed. Input/Output interaction is enabled. ### MODE_FREE_DRIVE Read-only mode with servo motors enabled for manual movement (Free Drive). Move requests are rejected. Not supported by all robots: Use [getSupportedModes](getSupportedModes) to check Free Drive availability.
|
|
3528
4276
|
* @export
|
|
3529
4277
|
* @enum {string}
|
|
3530
4278
|
*/
|
|
3531
4279
|
export declare const RobotSystemMode: {
|
|
3532
|
-
readonly
|
|
3533
|
-
readonly
|
|
3534
|
-
readonly
|
|
3535
|
-
readonly
|
|
3536
|
-
readonly
|
|
4280
|
+
readonly ModeControllerNotConfigured: "MODE_CONTROLLER_NOT_CONFIGURED";
|
|
4281
|
+
readonly ModeInitializing: "MODE_INITIALIZING";
|
|
4282
|
+
readonly ModeMonitor: "MODE_MONITOR";
|
|
4283
|
+
readonly ModeControl: "MODE_CONTROL";
|
|
4284
|
+
readonly ModeFreeDrive: "MODE_FREE_DRIVE";
|
|
3537
4285
|
};
|
|
3538
4286
|
export type RobotSystemMode = typeof RobotSystemMode[keyof typeof RobotSystemMode];
|
|
3539
4287
|
/**
|
|
@@ -3752,43 +4500,6 @@ export declare const SettableRobotSystemMode: {
|
|
|
3752
4500
|
readonly RobotSystemModeControl: "ROBOT_SYSTEM_MODE_CONTROL";
|
|
3753
4501
|
};
|
|
3754
4502
|
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
4503
|
/**
|
|
3793
4504
|
*
|
|
3794
4505
|
* @export
|
|
@@ -4320,6 +5031,14 @@ export interface ValidationError {
|
|
|
4320
5031
|
* @memberof ValidationError
|
|
4321
5032
|
*/
|
|
4322
5033
|
'type': string;
|
|
5034
|
+
/**
|
|
5035
|
+
*
|
|
5036
|
+
* @type {{ [key: string]: any; }}
|
|
5037
|
+
* @memberof ValidationError
|
|
5038
|
+
*/
|
|
5039
|
+
'input': {
|
|
5040
|
+
[key: string]: any;
|
|
5041
|
+
};
|
|
4323
5042
|
}
|
|
4324
5043
|
/**
|
|
4325
5044
|
* @type ValidationErrorLocInner
|
|
@@ -4512,296 +5231,797 @@ export interface WaitForIOEventRequest {
|
|
|
4512
5231
|
* @type {IOValue}
|
|
4513
5232
|
* @memberof WaitForIOEventRequest
|
|
4514
5233
|
*/
|
|
4515
|
-
'io': IOValue;
|
|
5234
|
+
'io': IOValue;
|
|
5235
|
+
/**
|
|
5236
|
+
* 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.
|
|
5237
|
+
* @type {Comparator}
|
|
5238
|
+
* @memberof WaitForIOEventRequest
|
|
5239
|
+
*/
|
|
5240
|
+
'comparator': Comparator;
|
|
5241
|
+
}
|
|
5242
|
+
/**
|
|
5243
|
+
* The configuration of a physical Yaskawa robot controller has to contain IP address of the controller.
|
|
5244
|
+
* @export
|
|
5245
|
+
* @interface YaskawaController
|
|
5246
|
+
*/
|
|
5247
|
+
export interface YaskawaController {
|
|
5248
|
+
/**
|
|
5249
|
+
*
|
|
5250
|
+
* @type {string}
|
|
5251
|
+
* @memberof YaskawaController
|
|
5252
|
+
*/
|
|
5253
|
+
'kind'?: YaskawaControllerKindEnum;
|
|
5254
|
+
/**
|
|
5255
|
+
*
|
|
5256
|
+
* @type {string}
|
|
5257
|
+
* @memberof YaskawaController
|
|
5258
|
+
*/
|
|
5259
|
+
'controller_ip': string;
|
|
5260
|
+
}
|
|
5261
|
+
export declare const YaskawaControllerKindEnum: {
|
|
5262
|
+
readonly YaskawaController: "YaskawaController";
|
|
5263
|
+
};
|
|
5264
|
+
export type YaskawaControllerKindEnum = typeof YaskawaControllerKindEnum[keyof typeof YaskawaControllerKindEnum];
|
|
5265
|
+
/**
|
|
5266
|
+
* ApplicationApi - axios parameter creator
|
|
5267
|
+
* @export
|
|
5268
|
+
*/
|
|
5269
|
+
export declare const ApplicationApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
5270
|
+
/**
|
|
5271
|
+
* 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.
|
|
5272
|
+
* @summary Add Application
|
|
5273
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5274
|
+
* @param {App} app
|
|
5275
|
+
* @param {number} [completionTimeout]
|
|
5276
|
+
* @param {*} [options] Override http request option.
|
|
5277
|
+
* @throws {RequiredError}
|
|
5278
|
+
*/
|
|
5279
|
+
addApp: (cell: string, app: App, completionTimeout?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
5280
|
+
/**
|
|
5281
|
+
* Delete all GUI applications from the cell.
|
|
5282
|
+
* @summary Clear Applications
|
|
5283
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5284
|
+
* @param {number} [completionTimeout]
|
|
5285
|
+
* @param {*} [options] Override http request option.
|
|
5286
|
+
* @throws {RequiredError}
|
|
5287
|
+
*/
|
|
5288
|
+
clearApps: (cell: string, completionTimeout?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
5289
|
+
/**
|
|
5290
|
+
* Delete a GUI application from the cell.
|
|
5291
|
+
* @summary Delete Application
|
|
5292
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5293
|
+
* @param {string} app
|
|
5294
|
+
* @param {number} [completionTimeout]
|
|
5295
|
+
* @param {*} [options] Override http request option.
|
|
5296
|
+
* @throws {RequiredError}
|
|
5297
|
+
*/
|
|
5298
|
+
deleteApp: (cell: string, app: string, completionTimeout?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
5299
|
+
/**
|
|
5300
|
+
* 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.
|
|
5301
|
+
* @summary Configuration
|
|
5302
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5303
|
+
* @param {string} app
|
|
5304
|
+
* @param {*} [options] Override http request option.
|
|
5305
|
+
* @throws {RequiredError}
|
|
5306
|
+
*/
|
|
5307
|
+
getApp: (cell: string, app: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
5308
|
+
/**
|
|
5309
|
+
* 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.
|
|
5310
|
+
* @summary List Applications
|
|
5311
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5312
|
+
* @param {*} [options] Override http request option.
|
|
5313
|
+
* @throws {RequiredError}
|
|
5314
|
+
*/
|
|
5315
|
+
listApps: (cell: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
5316
|
+
/**
|
|
5317
|
+
* Update the configuration of a GUI application in the cell.
|
|
5318
|
+
* @summary Update Configuration
|
|
5319
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5320
|
+
* @param {string} app
|
|
5321
|
+
* @param {App} app2
|
|
5322
|
+
* @param {number} [completionTimeout]
|
|
5323
|
+
* @param {*} [options] Override http request option.
|
|
5324
|
+
* @throws {RequiredError}
|
|
5325
|
+
*/
|
|
5326
|
+
updateApp: (cell: string, app: string, app2: App, completionTimeout?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
5327
|
+
};
|
|
5328
|
+
/**
|
|
5329
|
+
* ApplicationApi - functional programming interface
|
|
5330
|
+
* @export
|
|
5331
|
+
*/
|
|
5332
|
+
export declare const ApplicationApiFp: (configuration?: Configuration) => {
|
|
5333
|
+
/**
|
|
5334
|
+
* 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.
|
|
5335
|
+
* @summary Add Application
|
|
5336
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5337
|
+
* @param {App} app
|
|
5338
|
+
* @param {number} [completionTimeout]
|
|
5339
|
+
* @param {*} [options] Override http request option.
|
|
5340
|
+
* @throws {RequiredError}
|
|
5341
|
+
*/
|
|
5342
|
+
addApp(cell: string, app: App, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
5343
|
+
/**
|
|
5344
|
+
* Delete all GUI applications from the cell.
|
|
5345
|
+
* @summary Clear Applications
|
|
5346
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5347
|
+
* @param {number} [completionTimeout]
|
|
5348
|
+
* @param {*} [options] Override http request option.
|
|
5349
|
+
* @throws {RequiredError}
|
|
5350
|
+
*/
|
|
5351
|
+
clearApps(cell: string, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
5352
|
+
/**
|
|
5353
|
+
* Delete a GUI application from the cell.
|
|
5354
|
+
* @summary Delete Application
|
|
5355
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5356
|
+
* @param {string} app
|
|
5357
|
+
* @param {number} [completionTimeout]
|
|
5358
|
+
* @param {*} [options] Override http request option.
|
|
5359
|
+
* @throws {RequiredError}
|
|
5360
|
+
*/
|
|
5361
|
+
deleteApp(cell: string, app: string, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
5362
|
+
/**
|
|
5363
|
+
* 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.
|
|
5364
|
+
* @summary Configuration
|
|
5365
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5366
|
+
* @param {string} app
|
|
5367
|
+
* @param {*} [options] Override http request option.
|
|
5368
|
+
* @throws {RequiredError}
|
|
5369
|
+
*/
|
|
5370
|
+
getApp(cell: string, app: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<App>>;
|
|
5371
|
+
/**
|
|
5372
|
+
* 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.
|
|
5373
|
+
* @summary List Applications
|
|
5374
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5375
|
+
* @param {*} [options] Override http request option.
|
|
5376
|
+
* @throws {RequiredError}
|
|
5377
|
+
*/
|
|
5378
|
+
listApps(cell: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<string>>>;
|
|
5379
|
+
/**
|
|
5380
|
+
* Update the configuration of a GUI application in the cell.
|
|
5381
|
+
* @summary Update Configuration
|
|
5382
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5383
|
+
* @param {string} app
|
|
5384
|
+
* @param {App} app2
|
|
5385
|
+
* @param {number} [completionTimeout]
|
|
5386
|
+
* @param {*} [options] Override http request option.
|
|
5387
|
+
* @throws {RequiredError}
|
|
5388
|
+
*/
|
|
5389
|
+
updateApp(cell: string, app: string, app2: App, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
5390
|
+
};
|
|
5391
|
+
/**
|
|
5392
|
+
* ApplicationApi - factory interface
|
|
5393
|
+
* @export
|
|
5394
|
+
*/
|
|
5395
|
+
export declare const ApplicationApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
5396
|
+
/**
|
|
5397
|
+
* 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.
|
|
5398
|
+
* @summary Add Application
|
|
5399
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5400
|
+
* @param {App} app
|
|
5401
|
+
* @param {number} [completionTimeout]
|
|
5402
|
+
* @param {*} [options] Override http request option.
|
|
5403
|
+
* @throws {RequiredError}
|
|
5404
|
+
*/
|
|
5405
|
+
addApp(cell: string, app: App, completionTimeout?: number, options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
5406
|
+
/**
|
|
5407
|
+
* Delete all GUI applications from the cell.
|
|
5408
|
+
* @summary Clear Applications
|
|
5409
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5410
|
+
* @param {number} [completionTimeout]
|
|
5411
|
+
* @param {*} [options] Override http request option.
|
|
5412
|
+
* @throws {RequiredError}
|
|
5413
|
+
*/
|
|
5414
|
+
clearApps(cell: string, completionTimeout?: number, options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
5415
|
+
/**
|
|
5416
|
+
* Delete a GUI application from the cell.
|
|
5417
|
+
* @summary Delete Application
|
|
5418
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5419
|
+
* @param {string} app
|
|
5420
|
+
* @param {number} [completionTimeout]
|
|
5421
|
+
* @param {*} [options] Override http request option.
|
|
5422
|
+
* @throws {RequiredError}
|
|
5423
|
+
*/
|
|
5424
|
+
deleteApp(cell: string, app: string, completionTimeout?: number, options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
5425
|
+
/**
|
|
5426
|
+
* 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.
|
|
5427
|
+
* @summary Configuration
|
|
5428
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5429
|
+
* @param {string} app
|
|
5430
|
+
* @param {*} [options] Override http request option.
|
|
5431
|
+
* @throws {RequiredError}
|
|
5432
|
+
*/
|
|
5433
|
+
getApp(cell: string, app: string, options?: RawAxiosRequestConfig): AxiosPromise<App>;
|
|
5434
|
+
/**
|
|
5435
|
+
* 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.
|
|
5436
|
+
* @summary List Applications
|
|
5437
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5438
|
+
* @param {*} [options] Override http request option.
|
|
5439
|
+
* @throws {RequiredError}
|
|
5440
|
+
*/
|
|
5441
|
+
listApps(cell: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<string>>;
|
|
5442
|
+
/**
|
|
5443
|
+
* Update the configuration of a GUI application in the cell.
|
|
5444
|
+
* @summary Update Configuration
|
|
5445
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5446
|
+
* @param {string} app
|
|
5447
|
+
* @param {App} app2
|
|
5448
|
+
* @param {number} [completionTimeout]
|
|
5449
|
+
* @param {*} [options] Override http request option.
|
|
5450
|
+
* @throws {RequiredError}
|
|
5451
|
+
*/
|
|
5452
|
+
updateApp(cell: string, app: string, app2: App, completionTimeout?: number, options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
5453
|
+
};
|
|
5454
|
+
/**
|
|
5455
|
+
* ApplicationApi - object-oriented interface
|
|
5456
|
+
* @export
|
|
5457
|
+
* @class ApplicationApi
|
|
5458
|
+
* @extends {BaseAPI}
|
|
5459
|
+
*/
|
|
5460
|
+
export declare class ApplicationApi extends BaseAPI {
|
|
5461
|
+
/**
|
|
5462
|
+
* 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.
|
|
5463
|
+
* @summary Add Application
|
|
5464
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5465
|
+
* @param {App} app
|
|
5466
|
+
* @param {number} [completionTimeout]
|
|
5467
|
+
* @param {*} [options] Override http request option.
|
|
5468
|
+
* @throws {RequiredError}
|
|
5469
|
+
* @memberof ApplicationApi
|
|
5470
|
+
*/
|
|
5471
|
+
addApp(cell: string, app: App, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
5472
|
+
/**
|
|
5473
|
+
* Delete all GUI applications from the cell.
|
|
5474
|
+
* @summary Clear Applications
|
|
5475
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5476
|
+
* @param {number} [completionTimeout]
|
|
5477
|
+
* @param {*} [options] Override http request option.
|
|
5478
|
+
* @throws {RequiredError}
|
|
5479
|
+
* @memberof ApplicationApi
|
|
5480
|
+
*/
|
|
5481
|
+
clearApps(cell: string, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
5482
|
+
/**
|
|
5483
|
+
* Delete a GUI application from the cell.
|
|
5484
|
+
* @summary Delete Application
|
|
5485
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5486
|
+
* @param {string} app
|
|
5487
|
+
* @param {number} [completionTimeout]
|
|
5488
|
+
* @param {*} [options] Override http request option.
|
|
5489
|
+
* @throws {RequiredError}
|
|
5490
|
+
* @memberof ApplicationApi
|
|
5491
|
+
*/
|
|
5492
|
+
deleteApp(cell: string, app: string, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
5493
|
+
/**
|
|
5494
|
+
* 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.
|
|
5495
|
+
* @summary Configuration
|
|
5496
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5497
|
+
* @param {string} app
|
|
5498
|
+
* @param {*} [options] Override http request option.
|
|
5499
|
+
* @throws {RequiredError}
|
|
5500
|
+
* @memberof ApplicationApi
|
|
5501
|
+
*/
|
|
5502
|
+
getApp(cell: string, app: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<App, any>>;
|
|
5503
|
+
/**
|
|
5504
|
+
* 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.
|
|
5505
|
+
* @summary List Applications
|
|
5506
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5507
|
+
* @param {*} [options] Override http request option.
|
|
5508
|
+
* @throws {RequiredError}
|
|
5509
|
+
* @memberof ApplicationApi
|
|
5510
|
+
*/
|
|
5511
|
+
listApps(cell: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<string[], any>>;
|
|
5512
|
+
/**
|
|
5513
|
+
* Update the configuration of a GUI application in the cell.
|
|
5514
|
+
* @summary Update Configuration
|
|
5515
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5516
|
+
* @param {string} app
|
|
5517
|
+
* @param {App} app2
|
|
5518
|
+
* @param {number} [completionTimeout]
|
|
5519
|
+
* @param {*} [options] Override http request option.
|
|
5520
|
+
* @throws {RequiredError}
|
|
5521
|
+
* @memberof ApplicationApi
|
|
5522
|
+
*/
|
|
5523
|
+
updateApp(cell: string, app: string, app2: App, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
5524
|
+
}
|
|
5525
|
+
/**
|
|
5526
|
+
* BUSInputsOutputsApi - axios parameter creator
|
|
5527
|
+
* @export
|
|
5528
|
+
*/
|
|
5529
|
+
export declare const BUSInputsOutputsApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
5530
|
+
/**
|
|
5531
|
+
* Add a BUS Inputs/Outputs Service to the cell.
|
|
5532
|
+
* @summary Add Service
|
|
5533
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5534
|
+
* @param {BusIOType} busIOType
|
|
5535
|
+
* @param {number} [completionTimeout]
|
|
5536
|
+
* @param {*} [options] Override http request option.
|
|
5537
|
+
* @throws {RequiredError}
|
|
5538
|
+
*/
|
|
5539
|
+
addBusIOService: (cell: string, busIOType: BusIOType, completionTimeout?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
5540
|
+
/**
|
|
5541
|
+
* Adds an input/output to or updates an input/output on the PROFINET device.
|
|
5542
|
+
* @summary Add PROFINET Input/Output
|
|
5543
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5544
|
+
* @param {string} io Unique identifier to address an Input/Output in the cell.
|
|
5545
|
+
* @param {ProfinetIOData} profinetIOData
|
|
5546
|
+
* @param {*} [options] Override http request option.
|
|
5547
|
+
* @throws {RequiredError}
|
|
5548
|
+
*/
|
|
5549
|
+
addProfinetIO: (cell: string, io: string, profinetIOData: ProfinetIOData, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
5550
|
+
/**
|
|
5551
|
+
* Delete BUS Inputs/Outputs Service from the cell.
|
|
5552
|
+
* @summary Clear Service
|
|
5553
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5554
|
+
* @param {number} [completionTimeout]
|
|
5555
|
+
* @param {*} [options] Override http request option.
|
|
5556
|
+
* @throws {RequiredError}
|
|
5557
|
+
*/
|
|
5558
|
+
clearBusIOService: (cell: string, completionTimeout?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
5559
|
+
/**
|
|
5560
|
+
* Removes the input/output from the PROFINET device.
|
|
5561
|
+
* @summary Remove PROFINET Input/Ouptut
|
|
5562
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5563
|
+
* @param {string} io Unique identifier to address an Input/Output in the cell.
|
|
5564
|
+
* @param {*} [options] Override http request option.
|
|
5565
|
+
* @throws {RequiredError}
|
|
5566
|
+
*/
|
|
5567
|
+
deleteProfinetIO: (cell: string, io: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
5568
|
+
/**
|
|
5569
|
+
* Get deployed BUS Inputs/Outputs Service.
|
|
5570
|
+
* @summary Get Service
|
|
5571
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5572
|
+
* @param {*} [options] Override http request option.
|
|
5573
|
+
* @throws {RequiredError}
|
|
5574
|
+
*/
|
|
5575
|
+
getBusIOService: (cell: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
5576
|
+
/**
|
|
5577
|
+
* Get the current state of the BUS Inputs/Outputs service.
|
|
5578
|
+
* @summary State
|
|
5579
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5580
|
+
* @param {*} [options] Override http request option.
|
|
5581
|
+
* @throws {RequiredError}
|
|
5582
|
+
*/
|
|
5583
|
+
getBusIOState: (cell: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
5584
|
+
/**
|
|
5585
|
+
* 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).
|
|
5586
|
+
* @summary Get Input/Output Values
|
|
5587
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5588
|
+
* @param {Array<string>} [ios]
|
|
5589
|
+
* @param {*} [options] Override http request option.
|
|
5590
|
+
* @throws {RequiredError}
|
|
5591
|
+
*/
|
|
5592
|
+
getBusIOValues: (cell: string, ios?: Array<string>, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
5593
|
+
/**
|
|
5594
|
+
* Get description of PROFINET
|
|
5595
|
+
* @summary Get PROFINET Description
|
|
5596
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5597
|
+
* @param {*} [options] Override http request option.
|
|
5598
|
+
* @throws {RequiredError}
|
|
5599
|
+
*/
|
|
5600
|
+
getProfinetDescription: (cell: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
5601
|
+
/**
|
|
5602
|
+
* Get input/output configuration of the PROFINET device as file.
|
|
5603
|
+
* @summary PROFINET Inputs/Outputs to File
|
|
5604
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5605
|
+
* @param {number} [inputOffset]
|
|
5606
|
+
* @param {number} [outputOffset]
|
|
5607
|
+
* @param {*} [options] Override http request option.
|
|
5608
|
+
* @throws {RequiredError}
|
|
5609
|
+
*/
|
|
5610
|
+
getProfinetIOsFromFile: (cell: string, inputOffset?: number, outputOffset?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
5611
|
+
/**
|
|
5612
|
+
* List all BUS Input/Output descriptions.
|
|
5613
|
+
* @summary List Descriptions
|
|
5614
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5615
|
+
* @param {*} [options] Override http request option.
|
|
5616
|
+
* @throws {RequiredError}
|
|
5617
|
+
*/
|
|
5618
|
+
listBusIODescriptions: (cell: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
5619
|
+
/**
|
|
5620
|
+
* List all PROFINET input and outputs.
|
|
5621
|
+
* @summary List PROFINET Input/Output Configuration
|
|
5622
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5623
|
+
* @param {*} [options] Override http request option.
|
|
5624
|
+
* @throws {RequiredError}
|
|
5625
|
+
*/
|
|
5626
|
+
listProfinetIOs: (cell: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
5627
|
+
/**
|
|
5628
|
+
* 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.
|
|
5629
|
+
* @summary Set Output Values
|
|
5630
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5631
|
+
* @param {Array<IOValue>} iOValue
|
|
5632
|
+
* @param {*} [options] Override http request option.
|
|
5633
|
+
* @throws {RequiredError}
|
|
5634
|
+
*/
|
|
5635
|
+
setBusIOValues: (cell: string, iOValue: Array<IOValue>, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
5636
|
+
/**
|
|
5637
|
+
* Sets inputs/outputs on the PROFINET device from file.
|
|
5638
|
+
* @summary Set PROFINET Inputs/Outputs from File
|
|
5639
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5640
|
+
* @param {ProfinetInputOutputConfig} profinetInputOutputConfig
|
|
5641
|
+
* @param {*} [options] Override http request option.
|
|
5642
|
+
* @throws {RequiredError}
|
|
5643
|
+
*/
|
|
5644
|
+
setProfinetIOsFromFile: (cell: string, profinetInputOutputConfig: ProfinetInputOutputConfig, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
5645
|
+
};
|
|
5646
|
+
/**
|
|
5647
|
+
* BUSInputsOutputsApi - functional programming interface
|
|
5648
|
+
* @export
|
|
5649
|
+
*/
|
|
5650
|
+
export declare const BUSInputsOutputsApiFp: (configuration?: Configuration) => {
|
|
5651
|
+
/**
|
|
5652
|
+
* Add a BUS Inputs/Outputs Service to the cell.
|
|
5653
|
+
* @summary Add Service
|
|
5654
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5655
|
+
* @param {BusIOType} busIOType
|
|
5656
|
+
* @param {number} [completionTimeout]
|
|
5657
|
+
* @param {*} [options] Override http request option.
|
|
5658
|
+
* @throws {RequiredError}
|
|
5659
|
+
*/
|
|
5660
|
+
addBusIOService(cell: string, busIOType: BusIOType, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
5661
|
+
/**
|
|
5662
|
+
* Adds an input/output to or updates an input/output on the PROFINET device.
|
|
5663
|
+
* @summary Add PROFINET Input/Output
|
|
5664
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5665
|
+
* @param {string} io Unique identifier to address an Input/Output in the cell.
|
|
5666
|
+
* @param {ProfinetIOData} profinetIOData
|
|
5667
|
+
* @param {*} [options] Override http request option.
|
|
5668
|
+
* @throws {RequiredError}
|
|
5669
|
+
*/
|
|
5670
|
+
addProfinetIO(cell: string, io: string, profinetIOData: ProfinetIOData, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
5671
|
+
/**
|
|
5672
|
+
* Delete BUS Inputs/Outputs Service from the cell.
|
|
5673
|
+
* @summary Clear Service
|
|
5674
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5675
|
+
* @param {number} [completionTimeout]
|
|
5676
|
+
* @param {*} [options] Override http request option.
|
|
5677
|
+
* @throws {RequiredError}
|
|
5678
|
+
*/
|
|
5679
|
+
clearBusIOService(cell: string, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
5680
|
+
/**
|
|
5681
|
+
* Removes the input/output from the PROFINET device.
|
|
5682
|
+
* @summary Remove PROFINET Input/Ouptut
|
|
5683
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5684
|
+
* @param {string} io Unique identifier to address an Input/Output in the cell.
|
|
5685
|
+
* @param {*} [options] Override http request option.
|
|
5686
|
+
* @throws {RequiredError}
|
|
5687
|
+
*/
|
|
5688
|
+
deleteProfinetIO(cell: string, io: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
5689
|
+
/**
|
|
5690
|
+
* Get deployed BUS Inputs/Outputs Service.
|
|
5691
|
+
* @summary Get Service
|
|
5692
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5693
|
+
* @param {*} [options] Override http request option.
|
|
5694
|
+
* @throws {RequiredError}
|
|
5695
|
+
*/
|
|
5696
|
+
getBusIOService(cell: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BusIOType>>;
|
|
5697
|
+
/**
|
|
5698
|
+
* Get the current state of the BUS Inputs/Outputs service.
|
|
5699
|
+
* @summary State
|
|
5700
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5701
|
+
* @param {*} [options] Override http request option.
|
|
5702
|
+
* @throws {RequiredError}
|
|
5703
|
+
*/
|
|
5704
|
+
getBusIOState(cell: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BusIOsState>>;
|
|
5705
|
+
/**
|
|
5706
|
+
* 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).
|
|
5707
|
+
* @summary Get Input/Output Values
|
|
5708
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5709
|
+
* @param {Array<string>} [ios]
|
|
5710
|
+
* @param {*} [options] Override http request option.
|
|
5711
|
+
* @throws {RequiredError}
|
|
5712
|
+
*/
|
|
5713
|
+
getBusIOValues(cell: string, ios?: Array<string>, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<IOValue>>>;
|
|
5714
|
+
/**
|
|
5715
|
+
* Get description of PROFINET
|
|
5716
|
+
* @summary Get PROFINET Description
|
|
5717
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5718
|
+
* @param {*} [options] Override http request option.
|
|
5719
|
+
* @throws {RequiredError}
|
|
5720
|
+
*/
|
|
5721
|
+
getProfinetDescription(cell: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ProfinetDescription>>;
|
|
5722
|
+
/**
|
|
5723
|
+
* Get input/output configuration of the PROFINET device as file.
|
|
5724
|
+
* @summary PROFINET Inputs/Outputs to File
|
|
5725
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5726
|
+
* @param {number} [inputOffset]
|
|
5727
|
+
* @param {number} [outputOffset]
|
|
5728
|
+
* @param {*} [options] Override http request option.
|
|
5729
|
+
* @throws {RequiredError}
|
|
5730
|
+
*/
|
|
5731
|
+
getProfinetIOsFromFile(cell: string, inputOffset?: number, outputOffset?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<string>>;
|
|
5732
|
+
/**
|
|
5733
|
+
* List all BUS Input/Output descriptions.
|
|
5734
|
+
* @summary List Descriptions
|
|
5735
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5736
|
+
* @param {*} [options] Override http request option.
|
|
5737
|
+
* @throws {RequiredError}
|
|
5738
|
+
*/
|
|
5739
|
+
listBusIODescriptions(cell: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<IODescription>>>;
|
|
4516
5740
|
/**
|
|
4517
|
-
*
|
|
4518
|
-
* @
|
|
4519
|
-
* @
|
|
5741
|
+
* List all PROFINET input and outputs.
|
|
5742
|
+
* @summary List PROFINET Input/Output Configuration
|
|
5743
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5744
|
+
* @param {*} [options] Override http request option.
|
|
5745
|
+
* @throws {RequiredError}
|
|
4520
5746
|
*/
|
|
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 {
|
|
5747
|
+
listProfinetIOs(cell: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<ProfinetIO>>>;
|
|
4529
5748
|
/**
|
|
4530
|
-
*
|
|
4531
|
-
* @
|
|
4532
|
-
* @
|
|
5749
|
+
* 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.
|
|
5750
|
+
* @summary Set Output Values
|
|
5751
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5752
|
+
* @param {Array<IOValue>} iOValue
|
|
5753
|
+
* @param {*} [options] Override http request option.
|
|
5754
|
+
* @throws {RequiredError}
|
|
4533
5755
|
*/
|
|
4534
|
-
|
|
5756
|
+
setBusIOValues(cell: string, iOValue: Array<IOValue>, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
4535
5757
|
/**
|
|
4536
|
-
*
|
|
4537
|
-
* @
|
|
4538
|
-
* @
|
|
5758
|
+
* Sets inputs/outputs on the PROFINET device from file.
|
|
5759
|
+
* @summary Set PROFINET Inputs/Outputs from File
|
|
5760
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5761
|
+
* @param {ProfinetInputOutputConfig} profinetInputOutputConfig
|
|
5762
|
+
* @param {*} [options] Override http request option.
|
|
5763
|
+
* @throws {RequiredError}
|
|
4539
5764
|
*/
|
|
4540
|
-
|
|
4541
|
-
}
|
|
4542
|
-
export declare const YaskawaControllerKindEnum: {
|
|
4543
|
-
readonly YaskawaController: "YaskawaController";
|
|
5765
|
+
setProfinetIOsFromFile(cell: string, profinetInputOutputConfig: ProfinetInputOutputConfig, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
4544
5766
|
};
|
|
4545
|
-
export type YaskawaControllerKindEnum = typeof YaskawaControllerKindEnum[keyof typeof YaskawaControllerKindEnum];
|
|
4546
5767
|
/**
|
|
4547
|
-
*
|
|
5768
|
+
* BUSInputsOutputsApi - factory interface
|
|
4548
5769
|
* @export
|
|
4549
5770
|
*/
|
|
4550
|
-
export declare const
|
|
5771
|
+
export declare const BUSInputsOutputsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
4551
5772
|
/**
|
|
4552
|
-
*
|
|
4553
|
-
* @summary Add
|
|
5773
|
+
* Add a BUS Inputs/Outputs Service to the cell.
|
|
5774
|
+
* @summary Add Service
|
|
4554
5775
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
4555
|
-
* @param {
|
|
5776
|
+
* @param {BusIOType} busIOType
|
|
4556
5777
|
* @param {number} [completionTimeout]
|
|
4557
5778
|
* @param {*} [options] Override http request option.
|
|
4558
5779
|
* @throws {RequiredError}
|
|
4559
5780
|
*/
|
|
4560
|
-
|
|
5781
|
+
addBusIOService(cell: string, busIOType: BusIOType, completionTimeout?: number, options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
4561
5782
|
/**
|
|
4562
|
-
*
|
|
4563
|
-
* @summary
|
|
5783
|
+
* Adds an input/output to or updates an input/output on the PROFINET device.
|
|
5784
|
+
* @summary Add PROFINET Input/Output
|
|
4564
5785
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
4565
|
-
* @param {
|
|
5786
|
+
* @param {string} io Unique identifier to address an Input/Output in the cell.
|
|
5787
|
+
* @param {ProfinetIOData} profinetIOData
|
|
4566
5788
|
* @param {*} [options] Override http request option.
|
|
4567
5789
|
* @throws {RequiredError}
|
|
4568
5790
|
*/
|
|
4569
|
-
|
|
5791
|
+
addProfinetIO(cell: string, io: string, profinetIOData: ProfinetIOData, options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
4570
5792
|
/**
|
|
4571
|
-
* Delete
|
|
4572
|
-
* @summary
|
|
5793
|
+
* Delete BUS Inputs/Outputs Service from the cell.
|
|
5794
|
+
* @summary Clear Service
|
|
4573
5795
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
4574
|
-
* @param {string} app
|
|
4575
5796
|
* @param {number} [completionTimeout]
|
|
4576
5797
|
* @param {*} [options] Override http request option.
|
|
4577
5798
|
* @throws {RequiredError}
|
|
4578
5799
|
*/
|
|
4579
|
-
|
|
5800
|
+
clearBusIOService(cell: string, completionTimeout?: number, options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
4580
5801
|
/**
|
|
4581
|
-
*
|
|
4582
|
-
* @summary
|
|
5802
|
+
* Removes the input/output from the PROFINET device.
|
|
5803
|
+
* @summary Remove PROFINET Input/Ouptut
|
|
4583
5804
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
4584
|
-
* @param {string}
|
|
5805
|
+
* @param {string} io Unique identifier to address an Input/Output in the cell.
|
|
4585
5806
|
* @param {*} [options] Override http request option.
|
|
4586
5807
|
* @throws {RequiredError}
|
|
4587
5808
|
*/
|
|
4588
|
-
|
|
5809
|
+
deleteProfinetIO(cell: string, io: string, options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
4589
5810
|
/**
|
|
4590
|
-
*
|
|
4591
|
-
* @summary
|
|
5811
|
+
* Get deployed BUS Inputs/Outputs Service.
|
|
5812
|
+
* @summary Get Service
|
|
4592
5813
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
4593
5814
|
* @param {*} [options] Override http request option.
|
|
4594
5815
|
* @throws {RequiredError}
|
|
4595
5816
|
*/
|
|
4596
|
-
|
|
5817
|
+
getBusIOService(cell: string, options?: RawAxiosRequestConfig): AxiosPromise<BusIOType>;
|
|
4597
5818
|
/**
|
|
4598
|
-
*
|
|
4599
|
-
* @summary
|
|
5819
|
+
* Get the current state of the BUS Inputs/Outputs service.
|
|
5820
|
+
* @summary State
|
|
4600
5821
|
* @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
5822
|
* @param {*} [options] Override http request option.
|
|
4605
5823
|
* @throws {RequiredError}
|
|
4606
5824
|
*/
|
|
4607
|
-
|
|
4608
|
-
};
|
|
4609
|
-
/**
|
|
4610
|
-
* ApplicationApi - functional programming interface
|
|
4611
|
-
* @export
|
|
4612
|
-
*/
|
|
4613
|
-
export declare const ApplicationApiFp: (configuration?: Configuration) => {
|
|
5825
|
+
getBusIOState(cell: string, options?: RawAxiosRequestConfig): AxiosPromise<BusIOsState>;
|
|
4614
5826
|
/**
|
|
4615
|
-
*
|
|
4616
|
-
* @summary
|
|
5827
|
+
* 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).
|
|
5828
|
+
* @summary Get Input/Output Values
|
|
4617
5829
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
4618
|
-
* @param {
|
|
4619
|
-
* @param {number} [completionTimeout]
|
|
5830
|
+
* @param {Array<string>} [ios]
|
|
4620
5831
|
* @param {*} [options] Override http request option.
|
|
4621
5832
|
* @throws {RequiredError}
|
|
4622
5833
|
*/
|
|
4623
|
-
|
|
5834
|
+
getBusIOValues(cell: string, ios?: Array<string>, options?: RawAxiosRequestConfig): AxiosPromise<Array<IOValue>>;
|
|
4624
5835
|
/**
|
|
4625
|
-
*
|
|
4626
|
-
* @summary
|
|
5836
|
+
* Get description of PROFINET
|
|
5837
|
+
* @summary Get PROFINET Description
|
|
4627
5838
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
4628
|
-
* @param {number} [completionTimeout]
|
|
4629
5839
|
* @param {*} [options] Override http request option.
|
|
4630
5840
|
* @throws {RequiredError}
|
|
4631
5841
|
*/
|
|
4632
|
-
|
|
5842
|
+
getProfinetDescription(cell: string, options?: RawAxiosRequestConfig): AxiosPromise<ProfinetDescription>;
|
|
4633
5843
|
/**
|
|
4634
|
-
*
|
|
4635
|
-
* @summary
|
|
5844
|
+
* Get input/output configuration of the PROFINET device as file.
|
|
5845
|
+
* @summary PROFINET Inputs/Outputs to File
|
|
4636
5846
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
4637
|
-
* @param {
|
|
4638
|
-
* @param {number} [
|
|
5847
|
+
* @param {number} [inputOffset]
|
|
5848
|
+
* @param {number} [outputOffset]
|
|
4639
5849
|
* @param {*} [options] Override http request option.
|
|
4640
5850
|
* @throws {RequiredError}
|
|
4641
5851
|
*/
|
|
4642
|
-
|
|
5852
|
+
getProfinetIOsFromFile(cell: string, inputOffset?: number, outputOffset?: number, options?: RawAxiosRequestConfig): AxiosPromise<string>;
|
|
4643
5853
|
/**
|
|
4644
|
-
*
|
|
4645
|
-
* @summary
|
|
5854
|
+
* List all BUS Input/Output descriptions.
|
|
5855
|
+
* @summary List Descriptions
|
|
4646
5856
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
4647
|
-
* @param {string} app
|
|
4648
5857
|
* @param {*} [options] Override http request option.
|
|
4649
5858
|
* @throws {RequiredError}
|
|
4650
5859
|
*/
|
|
4651
|
-
|
|
5860
|
+
listBusIODescriptions(cell: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<IODescription>>;
|
|
4652
5861
|
/**
|
|
4653
|
-
* List all
|
|
4654
|
-
* @summary List
|
|
5862
|
+
* List all PROFINET input and outputs.
|
|
5863
|
+
* @summary List PROFINET Input/Output Configuration
|
|
4655
5864
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
4656
5865
|
* @param {*} [options] Override http request option.
|
|
4657
5866
|
* @throws {RequiredError}
|
|
4658
5867
|
*/
|
|
4659
|
-
|
|
5868
|
+
listProfinetIOs(cell: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<ProfinetIO>>;
|
|
4660
5869
|
/**
|
|
4661
|
-
*
|
|
4662
|
-
* @summary
|
|
5870
|
+
* 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.
|
|
5871
|
+
* @summary Set Output Values
|
|
4663
5872
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
4664
|
-
* @param {
|
|
4665
|
-
* @param {App} app2
|
|
4666
|
-
* @param {number} [completionTimeout]
|
|
5873
|
+
* @param {Array<IOValue>} iOValue
|
|
4667
5874
|
* @param {*} [options] Override http request option.
|
|
4668
5875
|
* @throws {RequiredError}
|
|
4669
5876
|
*/
|
|
4670
|
-
|
|
5877
|
+
setBusIOValues(cell: string, iOValue: Array<IOValue>, options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
5878
|
+
/**
|
|
5879
|
+
* Sets inputs/outputs on the PROFINET device from file.
|
|
5880
|
+
* @summary Set PROFINET Inputs/Outputs from File
|
|
5881
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5882
|
+
* @param {ProfinetInputOutputConfig} profinetInputOutputConfig
|
|
5883
|
+
* @param {*} [options] Override http request option.
|
|
5884
|
+
* @throws {RequiredError}
|
|
5885
|
+
*/
|
|
5886
|
+
setProfinetIOsFromFile(cell: string, profinetInputOutputConfig: ProfinetInputOutputConfig, options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
4671
5887
|
};
|
|
4672
5888
|
/**
|
|
4673
|
-
*
|
|
5889
|
+
* BUSInputsOutputsApi - object-oriented interface
|
|
4674
5890
|
* @export
|
|
5891
|
+
* @class BUSInputsOutputsApi
|
|
5892
|
+
* @extends {BaseAPI}
|
|
4675
5893
|
*/
|
|
4676
|
-
export declare
|
|
5894
|
+
export declare class BUSInputsOutputsApi extends BaseAPI {
|
|
4677
5895
|
/**
|
|
4678
|
-
*
|
|
4679
|
-
* @summary Add
|
|
5896
|
+
* Add a BUS Inputs/Outputs Service to the cell.
|
|
5897
|
+
* @summary Add Service
|
|
4680
5898
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
4681
|
-
* @param {
|
|
5899
|
+
* @param {BusIOType} busIOType
|
|
4682
5900
|
* @param {number} [completionTimeout]
|
|
4683
5901
|
* @param {*} [options] Override http request option.
|
|
4684
5902
|
* @throws {RequiredError}
|
|
5903
|
+
* @memberof BUSInputsOutputsApi
|
|
4685
5904
|
*/
|
|
4686
|
-
|
|
5905
|
+
addBusIOService(cell: string, busIOType: BusIOType, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
4687
5906
|
/**
|
|
4688
|
-
*
|
|
4689
|
-
* @summary
|
|
5907
|
+
* Adds an input/output to or updates an input/output on the PROFINET device.
|
|
5908
|
+
* @summary Add PROFINET Input/Output
|
|
4690
5909
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
4691
|
-
* @param {
|
|
5910
|
+
* @param {string} io Unique identifier to address an Input/Output in the cell.
|
|
5911
|
+
* @param {ProfinetIOData} profinetIOData
|
|
4692
5912
|
* @param {*} [options] Override http request option.
|
|
4693
5913
|
* @throws {RequiredError}
|
|
5914
|
+
* @memberof BUSInputsOutputsApi
|
|
4694
5915
|
*/
|
|
4695
|
-
|
|
5916
|
+
addProfinetIO(cell: string, io: string, profinetIOData: ProfinetIOData, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
4696
5917
|
/**
|
|
4697
|
-
* Delete
|
|
4698
|
-
* @summary
|
|
5918
|
+
* Delete BUS Inputs/Outputs Service from the cell.
|
|
5919
|
+
* @summary Clear Service
|
|
4699
5920
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
4700
|
-
* @param {string} app
|
|
4701
5921
|
* @param {number} [completionTimeout]
|
|
4702
5922
|
* @param {*} [options] Override http request option.
|
|
4703
5923
|
* @throws {RequiredError}
|
|
5924
|
+
* @memberof BUSInputsOutputsApi
|
|
4704
5925
|
*/
|
|
4705
|
-
|
|
5926
|
+
clearBusIOService(cell: string, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
4706
5927
|
/**
|
|
4707
|
-
*
|
|
4708
|
-
* @summary
|
|
5928
|
+
* Removes the input/output from the PROFINET device.
|
|
5929
|
+
* @summary Remove PROFINET Input/Ouptut
|
|
4709
5930
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
4710
|
-
* @param {string}
|
|
5931
|
+
* @param {string} io Unique identifier to address an Input/Output in the cell.
|
|
4711
5932
|
* @param {*} [options] Override http request option.
|
|
4712
5933
|
* @throws {RequiredError}
|
|
5934
|
+
* @memberof BUSInputsOutputsApi
|
|
4713
5935
|
*/
|
|
4714
|
-
|
|
5936
|
+
deleteProfinetIO(cell: string, io: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
4715
5937
|
/**
|
|
4716
|
-
*
|
|
4717
|
-
* @summary
|
|
5938
|
+
* Get deployed BUS Inputs/Outputs Service.
|
|
5939
|
+
* @summary Get Service
|
|
4718
5940
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
4719
5941
|
* @param {*} [options] Override http request option.
|
|
4720
5942
|
* @throws {RequiredError}
|
|
5943
|
+
* @memberof BUSInputsOutputsApi
|
|
4721
5944
|
*/
|
|
4722
|
-
|
|
5945
|
+
getBusIOService(cell: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<{
|
|
5946
|
+
bus_type: "profinet";
|
|
5947
|
+
} & BusIOProfinet, any>>;
|
|
4723
5948
|
/**
|
|
4724
|
-
*
|
|
4725
|
-
* @summary
|
|
5949
|
+
* Get the current state of the BUS Inputs/Outputs service.
|
|
5950
|
+
* @summary State
|
|
4726
5951
|
* @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
5952
|
* @param {*} [options] Override http request option.
|
|
4731
5953
|
* @throws {RequiredError}
|
|
5954
|
+
* @memberof BUSInputsOutputsApi
|
|
4732
5955
|
*/
|
|
4733
|
-
|
|
4734
|
-
};
|
|
4735
|
-
/**
|
|
4736
|
-
* ApplicationApi - object-oriented interface
|
|
4737
|
-
* @export
|
|
4738
|
-
* @class ApplicationApi
|
|
4739
|
-
* @extends {BaseAPI}
|
|
4740
|
-
*/
|
|
4741
|
-
export declare class ApplicationApi extends BaseAPI {
|
|
5956
|
+
getBusIOState(cell: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<BusIOsState, any>>;
|
|
4742
5957
|
/**
|
|
4743
|
-
*
|
|
4744
|
-
* @summary
|
|
5958
|
+
* 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).
|
|
5959
|
+
* @summary Get Input/Output Values
|
|
4745
5960
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
4746
|
-
* @param {
|
|
4747
|
-
* @param {number} [completionTimeout]
|
|
5961
|
+
* @param {Array<string>} [ios]
|
|
4748
5962
|
* @param {*} [options] Override http request option.
|
|
4749
5963
|
* @throws {RequiredError}
|
|
4750
|
-
* @memberof
|
|
5964
|
+
* @memberof BUSInputsOutputsApi
|
|
4751
5965
|
*/
|
|
4752
|
-
|
|
5966
|
+
getBusIOValues(cell: string, ios?: Array<string>, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<IOValue[], any>>;
|
|
4753
5967
|
/**
|
|
4754
|
-
*
|
|
4755
|
-
* @summary
|
|
5968
|
+
* Get description of PROFINET
|
|
5969
|
+
* @summary Get PROFINET Description
|
|
4756
5970
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
4757
|
-
* @param {number} [completionTimeout]
|
|
4758
5971
|
* @param {*} [options] Override http request option.
|
|
4759
5972
|
* @throws {RequiredError}
|
|
4760
|
-
* @memberof
|
|
5973
|
+
* @memberof BUSInputsOutputsApi
|
|
4761
5974
|
*/
|
|
4762
|
-
|
|
5975
|
+
getProfinetDescription(cell: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ProfinetDescription, any>>;
|
|
4763
5976
|
/**
|
|
4764
|
-
*
|
|
4765
|
-
* @summary
|
|
5977
|
+
* Get input/output configuration of the PROFINET device as file.
|
|
5978
|
+
* @summary PROFINET Inputs/Outputs to File
|
|
4766
5979
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
4767
|
-
* @param {
|
|
4768
|
-
* @param {number} [
|
|
5980
|
+
* @param {number} [inputOffset]
|
|
5981
|
+
* @param {number} [outputOffset]
|
|
4769
5982
|
* @param {*} [options] Override http request option.
|
|
4770
5983
|
* @throws {RequiredError}
|
|
4771
|
-
* @memberof
|
|
5984
|
+
* @memberof BUSInputsOutputsApi
|
|
4772
5985
|
*/
|
|
4773
|
-
|
|
5986
|
+
getProfinetIOsFromFile(cell: string, inputOffset?: number, outputOffset?: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<string, any>>;
|
|
4774
5987
|
/**
|
|
4775
|
-
*
|
|
4776
|
-
* @summary
|
|
5988
|
+
* List all BUS Input/Output descriptions.
|
|
5989
|
+
* @summary List Descriptions
|
|
4777
5990
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
4778
|
-
* @param {string} app
|
|
4779
5991
|
* @param {*} [options] Override http request option.
|
|
4780
5992
|
* @throws {RequiredError}
|
|
4781
|
-
* @memberof
|
|
5993
|
+
* @memberof BUSInputsOutputsApi
|
|
4782
5994
|
*/
|
|
4783
|
-
|
|
5995
|
+
listBusIODescriptions(cell: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<IODescription[], any>>;
|
|
4784
5996
|
/**
|
|
4785
|
-
* List all
|
|
4786
|
-
* @summary List
|
|
5997
|
+
* List all PROFINET input and outputs.
|
|
5998
|
+
* @summary List PROFINET Input/Output Configuration
|
|
4787
5999
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
4788
6000
|
* @param {*} [options] Override http request option.
|
|
4789
6001
|
* @throws {RequiredError}
|
|
4790
|
-
* @memberof
|
|
6002
|
+
* @memberof BUSInputsOutputsApi
|
|
4791
6003
|
*/
|
|
4792
|
-
|
|
6004
|
+
listProfinetIOs(cell: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ProfinetIO[], any>>;
|
|
4793
6005
|
/**
|
|
4794
|
-
*
|
|
4795
|
-
* @summary
|
|
6006
|
+
* 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.
|
|
6007
|
+
* @summary Set Output Values
|
|
4796
6008
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
4797
|
-
* @param {
|
|
4798
|
-
* @param {App} app2
|
|
4799
|
-
* @param {number} [completionTimeout]
|
|
6009
|
+
* @param {Array<IOValue>} iOValue
|
|
4800
6010
|
* @param {*} [options] Override http request option.
|
|
4801
6011
|
* @throws {RequiredError}
|
|
4802
|
-
* @memberof
|
|
6012
|
+
* @memberof BUSInputsOutputsApi
|
|
4803
6013
|
*/
|
|
4804
|
-
|
|
6014
|
+
setBusIOValues(cell: string, iOValue: Array<IOValue>, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
6015
|
+
/**
|
|
6016
|
+
* Sets inputs/outputs on the PROFINET device from file.
|
|
6017
|
+
* @summary Set PROFINET Inputs/Outputs from File
|
|
6018
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
6019
|
+
* @param {ProfinetInputOutputConfig} profinetInputOutputConfig
|
|
6020
|
+
* @param {*} [options] Override http request option.
|
|
6021
|
+
* @throws {RequiredError}
|
|
6022
|
+
* @memberof BUSInputsOutputsApi
|
|
6023
|
+
*/
|
|
6024
|
+
setProfinetIOsFromFile(cell: string, profinetInputOutputConfig: ProfinetInputOutputConfig, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
4805
6025
|
}
|
|
4806
6026
|
/**
|
|
4807
6027
|
* CellApi - axios parameter creator
|
|
@@ -5139,15 +6359,6 @@ export declare const ControllerApiAxiosParamCreator: (configuration?: Configurat
|
|
|
5139
6359
|
* @throws {RequiredError}
|
|
5140
6360
|
*/
|
|
5141
6361
|
getCurrentRobotControllerState: (cell: string, controller: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
5142
|
-
/**
|
|
5143
|
-
* Get the current robot system mode of a registered robot controller. The robot system mode indicates if a robot controller can be used. See [setDefaultMode](setDefaultMode) for more information about the different modes. The mode is influenced by the operating mode of the robot controller. The operating mode can be changed via [setDefaultMode](setDefaultMode). Request the current operating mode of the robot controller via [getCurrentRobotControllerState](getCurrentRobotControllerState).
|
|
5144
|
-
* @summary Current Mode
|
|
5145
|
-
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5146
|
-
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
5147
|
-
* @param {*} [options] Override http request option.
|
|
5148
|
-
* @throws {RequiredError}
|
|
5149
|
-
*/
|
|
5150
|
-
getMode: (cell: string, controller: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
5151
6362
|
/**
|
|
5152
6363
|
* Get the configuration for a robot controller.
|
|
5153
6364
|
* @summary Robot Controller
|
|
@@ -5205,15 +6416,16 @@ export declare const ControllerApiAxiosParamCreator: (configuration?: Configurat
|
|
|
5205
6416
|
*/
|
|
5206
6417
|
streamFreeDrive: (cell: string, controller: string, responseRate?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
5207
6418
|
/**
|
|
5208
|
-
* <!-- theme: danger --> > Websocket endpoint Receive updates of the state of a robot controller.
|
|
6419
|
+
* <!-- theme: danger --> > Websocket endpoint Receive updates of the state of a robot controller. The stream can be opened before the controller is registered. To register a controller, call [addRobotController](addRobotController). While connecting, the stream sends initialization updates. Once the controller reaches `MODE_MONITOR`, it sends controller state updates.
|
|
5209
6420
|
* @summary Stream State
|
|
5210
6421
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5211
6422
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
5212
6423
|
* @param {number} [responseRate]
|
|
6424
|
+
* @param {number} [addControllerTimeout]
|
|
5213
6425
|
* @param {*} [options] Override http request option.
|
|
5214
6426
|
* @throws {RequiredError}
|
|
5215
6427
|
*/
|
|
5216
|
-
streamRobotControllerState: (cell: string, controller: string, responseRate?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
6428
|
+
streamRobotControllerState: (cell: string, controller: string, responseRate?: number, addControllerTimeout?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
5217
6429
|
/**
|
|
5218
6430
|
* Update the configuration of a robot controller. Reconfigure certain options of a robot controller, or deploy a specific container image of a robot controller. <!-- theme: warning --> > **WARNING** > > Using it in conjunction with the settings app may lead to unpredictable behavior.
|
|
5219
6431
|
* @summary Update Robot Controller
|
|
@@ -5289,15 +6501,6 @@ export declare const ControllerApiFp: (configuration?: Configuration) => {
|
|
|
5289
6501
|
* @throws {RequiredError}
|
|
5290
6502
|
*/
|
|
5291
6503
|
getCurrentRobotControllerState(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<RobotControllerState>>;
|
|
5292
|
-
/**
|
|
5293
|
-
* Get the current robot system mode of a registered robot controller. The robot system mode indicates if a robot controller can be used. See [setDefaultMode](setDefaultMode) for more information about the different modes. The mode is influenced by the operating mode of the robot controller. The operating mode can be changed via [setDefaultMode](setDefaultMode). Request the current operating mode of the robot controller via [getCurrentRobotControllerState](getCurrentRobotControllerState).
|
|
5294
|
-
* @summary Current Mode
|
|
5295
|
-
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5296
|
-
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
5297
|
-
* @param {*} [options] Override http request option.
|
|
5298
|
-
* @throws {RequiredError}
|
|
5299
|
-
*/
|
|
5300
|
-
getMode(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetModeResponse>>;
|
|
5301
6504
|
/**
|
|
5302
6505
|
* Get the configuration for a robot controller.
|
|
5303
6506
|
* @summary Robot Controller
|
|
@@ -5355,15 +6558,16 @@ export declare const ControllerApiFp: (configuration?: Configuration) => {
|
|
|
5355
6558
|
*/
|
|
5356
6559
|
streamFreeDrive(cell: string, controller: string, responseRate?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<RobotControllerState>>;
|
|
5357
6560
|
/**
|
|
5358
|
-
* <!-- theme: danger --> > Websocket endpoint Receive updates of the state of a robot controller.
|
|
6561
|
+
* <!-- theme: danger --> > Websocket endpoint Receive updates of the state of a robot controller. The stream can be opened before the controller is registered. To register a controller, call [addRobotController](addRobotController). While connecting, the stream sends initialization updates. Once the controller reaches `MODE_MONITOR`, it sends controller state updates.
|
|
5359
6562
|
* @summary Stream State
|
|
5360
6563
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5361
6564
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
5362
6565
|
* @param {number} [responseRate]
|
|
6566
|
+
* @param {number} [addControllerTimeout]
|
|
5363
6567
|
* @param {*} [options] Override http request option.
|
|
5364
6568
|
* @throws {RequiredError}
|
|
5365
6569
|
*/
|
|
5366
|
-
streamRobotControllerState(cell: string, controller: string, responseRate?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<RobotControllerState>>;
|
|
6570
|
+
streamRobotControllerState(cell: string, controller: string, responseRate?: number, addControllerTimeout?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<RobotControllerState>>;
|
|
5367
6571
|
/**
|
|
5368
6572
|
* Update the configuration of a robot controller. Reconfigure certain options of a robot controller, or deploy a specific container image of a robot controller. <!-- theme: warning --> > **WARNING** > > Using it in conjunction with the settings app may lead to unpredictable behavior.
|
|
5369
6573
|
* @summary Update Robot Controller
|
|
@@ -5439,15 +6643,6 @@ export declare const ControllerApiFactory: (configuration?: Configuration, baseP
|
|
|
5439
6643
|
* @throws {RequiredError}
|
|
5440
6644
|
*/
|
|
5441
6645
|
getCurrentRobotControllerState(cell: string, controller: string, options?: RawAxiosRequestConfig): AxiosPromise<RobotControllerState>;
|
|
5442
|
-
/**
|
|
5443
|
-
* Get the current robot system mode of a registered robot controller. The robot system mode indicates if a robot controller can be used. See [setDefaultMode](setDefaultMode) for more information about the different modes. The mode is influenced by the operating mode of the robot controller. The operating mode can be changed via [setDefaultMode](setDefaultMode). Request the current operating mode of the robot controller via [getCurrentRobotControllerState](getCurrentRobotControllerState).
|
|
5444
|
-
* @summary Current Mode
|
|
5445
|
-
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5446
|
-
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
5447
|
-
* @param {*} [options] Override http request option.
|
|
5448
|
-
* @throws {RequiredError}
|
|
5449
|
-
*/
|
|
5450
|
-
getMode(cell: string, controller: string, options?: RawAxiosRequestConfig): AxiosPromise<GetModeResponse>;
|
|
5451
6646
|
/**
|
|
5452
6647
|
* Get the configuration for a robot controller.
|
|
5453
6648
|
* @summary Robot Controller
|
|
@@ -5505,15 +6700,16 @@ export declare const ControllerApiFactory: (configuration?: Configuration, baseP
|
|
|
5505
6700
|
*/
|
|
5506
6701
|
streamFreeDrive(cell: string, controller: string, responseRate?: number, options?: RawAxiosRequestConfig): AxiosPromise<RobotControllerState>;
|
|
5507
6702
|
/**
|
|
5508
|
-
* <!-- theme: danger --> > Websocket endpoint Receive updates of the state of a robot controller.
|
|
6703
|
+
* <!-- theme: danger --> > Websocket endpoint Receive updates of the state of a robot controller. The stream can be opened before the controller is registered. To register a controller, call [addRobotController](addRobotController). While connecting, the stream sends initialization updates. Once the controller reaches `MODE_MONITOR`, it sends controller state updates.
|
|
5509
6704
|
* @summary Stream State
|
|
5510
6705
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5511
6706
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
5512
6707
|
* @param {number} [responseRate]
|
|
6708
|
+
* @param {number} [addControllerTimeout]
|
|
5513
6709
|
* @param {*} [options] Override http request option.
|
|
5514
6710
|
* @throws {RequiredError}
|
|
5515
6711
|
*/
|
|
5516
|
-
streamRobotControllerState(cell: string, controller: string, responseRate?: number, options?: RawAxiosRequestConfig): AxiosPromise<RobotControllerState>;
|
|
6712
|
+
streamRobotControllerState(cell: string, controller: string, responseRate?: number, addControllerTimeout?: number, options?: RawAxiosRequestConfig): AxiosPromise<RobotControllerState>;
|
|
5517
6713
|
/**
|
|
5518
6714
|
* Update the configuration of a robot controller. Reconfigure certain options of a robot controller, or deploy a specific container image of a robot controller. <!-- theme: warning --> > **WARNING** > > Using it in conjunction with the settings app may lead to unpredictable behavior.
|
|
5519
6715
|
* @summary Update Robot Controller
|
|
@@ -5597,16 +6793,6 @@ export declare class ControllerApi extends BaseAPI {
|
|
|
5597
6793
|
* @memberof ControllerApi
|
|
5598
6794
|
*/
|
|
5599
6795
|
getCurrentRobotControllerState(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<RobotControllerState, any>>;
|
|
5600
|
-
/**
|
|
5601
|
-
* Get the current robot system mode of a registered robot controller. The robot system mode indicates if a robot controller can be used. See [setDefaultMode](setDefaultMode) for more information about the different modes. The mode is influenced by the operating mode of the robot controller. The operating mode can be changed via [setDefaultMode](setDefaultMode). Request the current operating mode of the robot controller via [getCurrentRobotControllerState](getCurrentRobotControllerState).
|
|
5602
|
-
* @summary Current Mode
|
|
5603
|
-
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5604
|
-
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
5605
|
-
* @param {*} [options] Override http request option.
|
|
5606
|
-
* @throws {RequiredError}
|
|
5607
|
-
* @memberof ControllerApi
|
|
5608
|
-
*/
|
|
5609
|
-
getMode(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetModeResponse, any>>;
|
|
5610
6796
|
/**
|
|
5611
6797
|
* Get the configuration for a robot controller.
|
|
5612
6798
|
* @summary Robot Controller
|
|
@@ -5670,16 +6856,17 @@ export declare class ControllerApi extends BaseAPI {
|
|
|
5670
6856
|
*/
|
|
5671
6857
|
streamFreeDrive(cell: string, controller: string, responseRate?: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<RobotControllerState, any>>;
|
|
5672
6858
|
/**
|
|
5673
|
-
* <!-- theme: danger --> > Websocket endpoint Receive updates of the state of a robot controller.
|
|
6859
|
+
* <!-- theme: danger --> > Websocket endpoint Receive updates of the state of a robot controller. The stream can be opened before the controller is registered. To register a controller, call [addRobotController](addRobotController). While connecting, the stream sends initialization updates. Once the controller reaches `MODE_MONITOR`, it sends controller state updates.
|
|
5674
6860
|
* @summary Stream State
|
|
5675
6861
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5676
6862
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
5677
6863
|
* @param {number} [responseRate]
|
|
6864
|
+
* @param {number} [addControllerTimeout]
|
|
5678
6865
|
* @param {*} [options] Override http request option.
|
|
5679
6866
|
* @throws {RequiredError}
|
|
5680
6867
|
* @memberof ControllerApi
|
|
5681
6868
|
*/
|
|
5682
|
-
streamRobotControllerState(cell: string, controller: string, responseRate?: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<RobotControllerState, any>>;
|
|
6869
|
+
streamRobotControllerState(cell: string, controller: string, responseRate?: number, addControllerTimeout?: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<RobotControllerState, any>>;
|
|
5683
6870
|
/**
|
|
5684
6871
|
* Update the configuration of a robot controller. Reconfigure certain options of a robot controller, or deploy a specific container image of a robot controller. <!-- theme: warning --> > **WARNING** > > Using it in conjunction with the settings app may lead to unpredictable behavior.
|
|
5685
6872
|
* @summary Update Robot Controller
|
|
@@ -6008,6 +7195,15 @@ export declare class JoggingApi extends BaseAPI {
|
|
|
6008
7195
|
* @export
|
|
6009
7196
|
*/
|
|
6010
7197
|
export declare const KinematicsApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
7198
|
+
/**
|
|
7199
|
+
* Returns the TCP poses for a list of given joint positions.
|
|
7200
|
+
* @summary Forward kinematics
|
|
7201
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
7202
|
+
* @param {ForwardKinematicsRequest} [forwardKinematicsRequest]
|
|
7203
|
+
* @param {*} [options] Override http request option.
|
|
7204
|
+
* @throws {RequiredError}
|
|
7205
|
+
*/
|
|
7206
|
+
forwardKinematics: (cell: string, forwardKinematicsRequest?: ForwardKinematicsRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
6011
7207
|
/**
|
|
6012
7208
|
* Returns the reachable joint positions for a list of given poses.
|
|
6013
7209
|
* @summary Inverse kinematics
|
|
@@ -6023,6 +7219,15 @@ export declare const KinematicsApiAxiosParamCreator: (configuration?: Configurat
|
|
|
6023
7219
|
* @export
|
|
6024
7220
|
*/
|
|
6025
7221
|
export declare const KinematicsApiFp: (configuration?: Configuration) => {
|
|
7222
|
+
/**
|
|
7223
|
+
* Returns the TCP poses for a list of given joint positions.
|
|
7224
|
+
* @summary Forward kinematics
|
|
7225
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
7226
|
+
* @param {ForwardKinematicsRequest} [forwardKinematicsRequest]
|
|
7227
|
+
* @param {*} [options] Override http request option.
|
|
7228
|
+
* @throws {RequiredError}
|
|
7229
|
+
*/
|
|
7230
|
+
forwardKinematics(cell: string, forwardKinematicsRequest?: ForwardKinematicsRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ForwardKinematicsResponse>>;
|
|
6026
7231
|
/**
|
|
6027
7232
|
* Returns the reachable joint positions for a list of given poses.
|
|
6028
7233
|
* @summary Inverse kinematics
|
|
@@ -6038,6 +7243,15 @@ export declare const KinematicsApiFp: (configuration?: Configuration) => {
|
|
|
6038
7243
|
* @export
|
|
6039
7244
|
*/
|
|
6040
7245
|
export declare const KinematicsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
7246
|
+
/**
|
|
7247
|
+
* Returns the TCP poses for a list of given joint positions.
|
|
7248
|
+
* @summary Forward kinematics
|
|
7249
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
7250
|
+
* @param {ForwardKinematicsRequest} [forwardKinematicsRequest]
|
|
7251
|
+
* @param {*} [options] Override http request option.
|
|
7252
|
+
* @throws {RequiredError}
|
|
7253
|
+
*/
|
|
7254
|
+
forwardKinematics(cell: string, forwardKinematicsRequest?: ForwardKinematicsRequest, options?: RawAxiosRequestConfig): AxiosPromise<ForwardKinematicsResponse>;
|
|
6041
7255
|
/**
|
|
6042
7256
|
* Returns the reachable joint positions for a list of given poses.
|
|
6043
7257
|
* @summary Inverse kinematics
|
|
@@ -6055,6 +7269,16 @@ export declare const KinematicsApiFactory: (configuration?: Configuration, baseP
|
|
|
6055
7269
|
* @extends {BaseAPI}
|
|
6056
7270
|
*/
|
|
6057
7271
|
export declare class KinematicsApi extends BaseAPI {
|
|
7272
|
+
/**
|
|
7273
|
+
* Returns the TCP poses for a list of given joint positions.
|
|
7274
|
+
* @summary Forward kinematics
|
|
7275
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
7276
|
+
* @param {ForwardKinematicsRequest} [forwardKinematicsRequest]
|
|
7277
|
+
* @param {*} [options] Override http request option.
|
|
7278
|
+
* @throws {RequiredError}
|
|
7279
|
+
* @memberof KinematicsApi
|
|
7280
|
+
*/
|
|
7281
|
+
forwardKinematics(cell: string, forwardKinematicsRequest?: ForwardKinematicsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ForwardKinematicsResponse, any>>;
|
|
6058
7282
|
/**
|
|
6059
7283
|
* Returns the reachable joint positions for a list of given poses.
|
|
6060
7284
|
* @summary Inverse kinematics
|
|
@@ -7016,184 +8240,184 @@ export declare class StoreCollisionComponentsApi extends BaseAPI {
|
|
|
7016
8240
|
}, any>>;
|
|
7017
8241
|
}
|
|
7018
8242
|
/**
|
|
7019
|
-
*
|
|
8243
|
+
* StoreCollisionSetupsApi - axios parameter creator
|
|
7020
8244
|
* @export
|
|
7021
8245
|
*/
|
|
7022
|
-
export declare const
|
|
8246
|
+
export declare const StoreCollisionSetupsApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
7023
8247
|
/**
|
|
7024
|
-
* Deletes the stored
|
|
7025
|
-
* @summary Delete
|
|
8248
|
+
* Deletes the stored collision setup. <!-- theme: danger --> > This will delete persistently stored data.
|
|
8249
|
+
* @summary Delete Collision Setup
|
|
7026
8250
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
7027
|
-
* @param {string}
|
|
8251
|
+
* @param {string} setup Identifier of the collision setup
|
|
7028
8252
|
* @param {*} [options] Override http request option.
|
|
7029
8253
|
* @throws {RequiredError}
|
|
7030
8254
|
*/
|
|
7031
|
-
|
|
8255
|
+
deleteStoredCollisionSetup: (cell: string, setup: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
7032
8256
|
/**
|
|
7033
|
-
* Returns the stored
|
|
7034
|
-
* @summary Get
|
|
8257
|
+
* Returns the stored collision setup.
|
|
8258
|
+
* @summary Get Collision Setup
|
|
7035
8259
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
7036
|
-
* @param {string}
|
|
8260
|
+
* @param {string} setup Identifier of the collision setup
|
|
7037
8261
|
* @param {*} [options] Override http request option.
|
|
7038
8262
|
* @throws {RequiredError}
|
|
7039
8263
|
*/
|
|
7040
|
-
|
|
8264
|
+
getStoredCollisionSetup: (cell: string, setup: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
7041
8265
|
/**
|
|
7042
|
-
* Returns a list of stored
|
|
7043
|
-
* @summary List
|
|
8266
|
+
* Returns a list of stored collision setups.
|
|
8267
|
+
* @summary List Collision Setups
|
|
7044
8268
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
7045
8269
|
* @param {*} [options] Override http request option.
|
|
7046
8270
|
* @throws {RequiredError}
|
|
7047
8271
|
*/
|
|
7048
|
-
|
|
8272
|
+
listStoredCollisionSetups: (cell: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
7049
8273
|
/**
|
|
7050
|
-
*
|
|
7051
|
-
* @summary Store
|
|
8274
|
+
* Stores collision setup. If the collision setup does not exist, it will be created. If the collision setup exists, it will be updated.
|
|
8275
|
+
* @summary Store Collision Setup
|
|
7052
8276
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
7053
|
-
* @param {string}
|
|
7054
|
-
* @param {
|
|
8277
|
+
* @param {string} setup Identifier of the collision setup
|
|
8278
|
+
* @param {CollisionSetup} collisionSetup
|
|
7055
8279
|
* @param {*} [options] Override http request option.
|
|
7056
8280
|
* @throws {RequiredError}
|
|
7057
8281
|
*/
|
|
7058
|
-
|
|
8282
|
+
storeCollisionSetup: (cell: string, setup: string, collisionSetup: CollisionSetup, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
7059
8283
|
};
|
|
7060
8284
|
/**
|
|
7061
|
-
*
|
|
8285
|
+
* StoreCollisionSetupsApi - functional programming interface
|
|
7062
8286
|
* @export
|
|
7063
8287
|
*/
|
|
7064
|
-
export declare const
|
|
8288
|
+
export declare const StoreCollisionSetupsApiFp: (configuration?: Configuration) => {
|
|
7065
8289
|
/**
|
|
7066
|
-
* Deletes the stored
|
|
7067
|
-
* @summary Delete
|
|
8290
|
+
* Deletes the stored collision setup. <!-- theme: danger --> > This will delete persistently stored data.
|
|
8291
|
+
* @summary Delete Collision Setup
|
|
7068
8292
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
7069
|
-
* @param {string}
|
|
8293
|
+
* @param {string} setup Identifier of the collision setup
|
|
7070
8294
|
* @param {*} [options] Override http request option.
|
|
7071
8295
|
* @throws {RequiredError}
|
|
7072
8296
|
*/
|
|
7073
|
-
|
|
8297
|
+
deleteStoredCollisionSetup(cell: string, setup: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
7074
8298
|
/**
|
|
7075
|
-
* Returns the stored
|
|
7076
|
-
* @summary Get
|
|
8299
|
+
* Returns the stored collision setup.
|
|
8300
|
+
* @summary Get Collision Setup
|
|
7077
8301
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
7078
|
-
* @param {string}
|
|
8302
|
+
* @param {string} setup Identifier of the collision setup
|
|
7079
8303
|
* @param {*} [options] Override http request option.
|
|
7080
8304
|
* @throws {RequiredError}
|
|
7081
8305
|
*/
|
|
7082
|
-
|
|
8306
|
+
getStoredCollisionSetup(cell: string, setup: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CollisionSetup>>;
|
|
7083
8307
|
/**
|
|
7084
|
-
* Returns a list of stored
|
|
7085
|
-
* @summary List
|
|
8308
|
+
* Returns a list of stored collision setups.
|
|
8309
|
+
* @summary List Collision Setups
|
|
7086
8310
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
7087
8311
|
* @param {*} [options] Override http request option.
|
|
7088
8312
|
* @throws {RequiredError}
|
|
7089
8313
|
*/
|
|
7090
|
-
|
|
7091
|
-
[key: string]:
|
|
8314
|
+
listStoredCollisionSetups(cell: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<{
|
|
8315
|
+
[key: string]: CollisionSetup;
|
|
7092
8316
|
}>>;
|
|
7093
8317
|
/**
|
|
7094
|
-
*
|
|
7095
|
-
* @summary Store
|
|
8318
|
+
* Stores collision setup. If the collision setup does not exist, it will be created. If the collision setup exists, it will be updated.
|
|
8319
|
+
* @summary Store Collision Setup
|
|
7096
8320
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
7097
|
-
* @param {string}
|
|
7098
|
-
* @param {
|
|
8321
|
+
* @param {string} setup Identifier of the collision setup
|
|
8322
|
+
* @param {CollisionSetup} collisionSetup
|
|
7099
8323
|
* @param {*} [options] Override http request option.
|
|
7100
8324
|
* @throws {RequiredError}
|
|
7101
8325
|
*/
|
|
7102
|
-
|
|
8326
|
+
storeCollisionSetup(cell: string, setup: string, collisionSetup: CollisionSetup, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CollisionSetup>>;
|
|
7103
8327
|
};
|
|
7104
8328
|
/**
|
|
7105
|
-
*
|
|
8329
|
+
* StoreCollisionSetupsApi - factory interface
|
|
7106
8330
|
* @export
|
|
7107
8331
|
*/
|
|
7108
|
-
export declare const
|
|
8332
|
+
export declare const StoreCollisionSetupsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
7109
8333
|
/**
|
|
7110
|
-
* Deletes the stored
|
|
7111
|
-
* @summary Delete
|
|
8334
|
+
* Deletes the stored collision setup. <!-- theme: danger --> > This will delete persistently stored data.
|
|
8335
|
+
* @summary Delete Collision Setup
|
|
7112
8336
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
7113
|
-
* @param {string}
|
|
8337
|
+
* @param {string} setup Identifier of the collision setup
|
|
7114
8338
|
* @param {*} [options] Override http request option.
|
|
7115
8339
|
* @throws {RequiredError}
|
|
7116
8340
|
*/
|
|
7117
|
-
|
|
8341
|
+
deleteStoredCollisionSetup(cell: string, setup: string, options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
7118
8342
|
/**
|
|
7119
|
-
* Returns the stored
|
|
7120
|
-
* @summary Get
|
|
8343
|
+
* Returns the stored collision setup.
|
|
8344
|
+
* @summary Get Collision Setup
|
|
7121
8345
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
7122
|
-
* @param {string}
|
|
8346
|
+
* @param {string} setup Identifier of the collision setup
|
|
7123
8347
|
* @param {*} [options] Override http request option.
|
|
7124
8348
|
* @throws {RequiredError}
|
|
7125
8349
|
*/
|
|
7126
|
-
|
|
8350
|
+
getStoredCollisionSetup(cell: string, setup: string, options?: RawAxiosRequestConfig): AxiosPromise<CollisionSetup>;
|
|
7127
8351
|
/**
|
|
7128
|
-
* Returns a list of stored
|
|
7129
|
-
* @summary List
|
|
8352
|
+
* Returns a list of stored collision setups.
|
|
8353
|
+
* @summary List Collision Setups
|
|
7130
8354
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
7131
8355
|
* @param {*} [options] Override http request option.
|
|
7132
8356
|
* @throws {RequiredError}
|
|
7133
8357
|
*/
|
|
7134
|
-
|
|
7135
|
-
[key: string]:
|
|
8358
|
+
listStoredCollisionSetups(cell: string, options?: RawAxiosRequestConfig): AxiosPromise<{
|
|
8359
|
+
[key: string]: CollisionSetup;
|
|
7136
8360
|
}>;
|
|
7137
8361
|
/**
|
|
7138
|
-
*
|
|
7139
|
-
* @summary Store
|
|
8362
|
+
* Stores collision setup. If the collision setup does not exist, it will be created. If the collision setup exists, it will be updated.
|
|
8363
|
+
* @summary Store Collision Setup
|
|
7140
8364
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
7141
|
-
* @param {string}
|
|
7142
|
-
* @param {
|
|
8365
|
+
* @param {string} setup Identifier of the collision setup
|
|
8366
|
+
* @param {CollisionSetup} collisionSetup
|
|
7143
8367
|
* @param {*} [options] Override http request option.
|
|
7144
8368
|
* @throws {RequiredError}
|
|
7145
8369
|
*/
|
|
7146
|
-
|
|
8370
|
+
storeCollisionSetup(cell: string, setup: string, collisionSetup: CollisionSetup, options?: RawAxiosRequestConfig): AxiosPromise<CollisionSetup>;
|
|
7147
8371
|
};
|
|
7148
8372
|
/**
|
|
7149
|
-
*
|
|
8373
|
+
* StoreCollisionSetupsApi - object-oriented interface
|
|
7150
8374
|
* @export
|
|
7151
|
-
* @class
|
|
8375
|
+
* @class StoreCollisionSetupsApi
|
|
7152
8376
|
* @extends {BaseAPI}
|
|
7153
8377
|
*/
|
|
7154
|
-
export declare class
|
|
8378
|
+
export declare class StoreCollisionSetupsApi extends BaseAPI {
|
|
7155
8379
|
/**
|
|
7156
|
-
* Deletes the stored
|
|
7157
|
-
* @summary Delete
|
|
8380
|
+
* Deletes the stored collision setup. <!-- theme: danger --> > This will delete persistently stored data.
|
|
8381
|
+
* @summary Delete Collision Setup
|
|
7158
8382
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
7159
|
-
* @param {string}
|
|
8383
|
+
* @param {string} setup Identifier of the collision setup
|
|
7160
8384
|
* @param {*} [options] Override http request option.
|
|
7161
8385
|
* @throws {RequiredError}
|
|
7162
|
-
* @memberof
|
|
8386
|
+
* @memberof StoreCollisionSetupsApi
|
|
7163
8387
|
*/
|
|
7164
|
-
|
|
8388
|
+
deleteStoredCollisionSetup(cell: string, setup: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
7165
8389
|
/**
|
|
7166
|
-
* Returns the stored
|
|
7167
|
-
* @summary Get
|
|
8390
|
+
* Returns the stored collision setup.
|
|
8391
|
+
* @summary Get Collision Setup
|
|
7168
8392
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
7169
|
-
* @param {string}
|
|
8393
|
+
* @param {string} setup Identifier of the collision setup
|
|
7170
8394
|
* @param {*} [options] Override http request option.
|
|
7171
8395
|
* @throws {RequiredError}
|
|
7172
|
-
* @memberof
|
|
8396
|
+
* @memberof StoreCollisionSetupsApi
|
|
7173
8397
|
*/
|
|
7174
|
-
|
|
8398
|
+
getStoredCollisionSetup(cell: string, setup: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CollisionSetup, any>>;
|
|
7175
8399
|
/**
|
|
7176
|
-
* Returns a list of stored
|
|
7177
|
-
* @summary List
|
|
8400
|
+
* Returns a list of stored collision setups.
|
|
8401
|
+
* @summary List Collision Setups
|
|
7178
8402
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
7179
8403
|
* @param {*} [options] Override http request option.
|
|
7180
8404
|
* @throws {RequiredError}
|
|
7181
|
-
* @memberof
|
|
8405
|
+
* @memberof StoreCollisionSetupsApi
|
|
7182
8406
|
*/
|
|
7183
|
-
|
|
7184
|
-
[key: string]:
|
|
8407
|
+
listStoredCollisionSetups(cell: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<{
|
|
8408
|
+
[key: string]: CollisionSetup;
|
|
7185
8409
|
}, any>>;
|
|
7186
8410
|
/**
|
|
7187
|
-
*
|
|
7188
|
-
* @summary Store
|
|
8411
|
+
* Stores collision setup. If the collision setup does not exist, it will be created. If the collision setup exists, it will be updated.
|
|
8412
|
+
* @summary Store Collision Setup
|
|
7189
8413
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
7190
|
-
* @param {string}
|
|
7191
|
-
* @param {
|
|
8414
|
+
* @param {string} setup Identifier of the collision setup
|
|
8415
|
+
* @param {CollisionSetup} collisionSetup
|
|
7192
8416
|
* @param {*} [options] Override http request option.
|
|
7193
8417
|
* @throws {RequiredError}
|
|
7194
|
-
* @memberof
|
|
8418
|
+
* @memberof StoreCollisionSetupsApi
|
|
7195
8419
|
*/
|
|
7196
|
-
|
|
8420
|
+
storeCollisionSetup(cell: string, setup: string, collisionSetup: CollisionSetup, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CollisionSetup, any>>;
|
|
7197
8421
|
}
|
|
7198
8422
|
/**
|
|
7199
8423
|
* StoreObjectApi - axios parameter creator
|
|
@@ -8069,6 +9293,15 @@ export declare class TrajectoryExecutionApi extends BaseAPI {
|
|
|
8069
9293
|
* @export
|
|
8070
9294
|
*/
|
|
8071
9295
|
export declare const TrajectoryPlanningApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
9296
|
+
/**
|
|
9297
|
+
* 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.
|
|
9298
|
+
* @summary Plan Collision-Free Trajectory
|
|
9299
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
9300
|
+
* @param {PlanCollisionFreeRequest} [planCollisionFreeRequest]
|
|
9301
|
+
* @param {*} [options] Override http request option.
|
|
9302
|
+
* @throws {RequiredError}
|
|
9303
|
+
*/
|
|
9304
|
+
planCollisionFree: (cell: string, planCollisionFreeRequest?: PlanCollisionFreeRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
8072
9305
|
/**
|
|
8073
9306
|
* 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
9307
|
* @summary Plan Trajectory
|
|
@@ -8084,6 +9317,15 @@ export declare const TrajectoryPlanningApiAxiosParamCreator: (configuration?: Co
|
|
|
8084
9317
|
* @export
|
|
8085
9318
|
*/
|
|
8086
9319
|
export declare const TrajectoryPlanningApiFp: (configuration?: Configuration) => {
|
|
9320
|
+
/**
|
|
9321
|
+
* 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.
|
|
9322
|
+
* @summary Plan Collision-Free Trajectory
|
|
9323
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
9324
|
+
* @param {PlanCollisionFreeRequest} [planCollisionFreeRequest]
|
|
9325
|
+
* @param {*} [options] Override http request option.
|
|
9326
|
+
* @throws {RequiredError}
|
|
9327
|
+
*/
|
|
9328
|
+
planCollisionFree(cell: string, planCollisionFreeRequest?: PlanCollisionFreeRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PlanCollisionFreeResponse>>;
|
|
8087
9329
|
/**
|
|
8088
9330
|
* 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
9331
|
* @summary Plan Trajectory
|
|
@@ -8099,6 +9341,15 @@ export declare const TrajectoryPlanningApiFp: (configuration?: Configuration) =>
|
|
|
8099
9341
|
* @export
|
|
8100
9342
|
*/
|
|
8101
9343
|
export declare const TrajectoryPlanningApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
9344
|
+
/**
|
|
9345
|
+
* 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.
|
|
9346
|
+
* @summary Plan Collision-Free Trajectory
|
|
9347
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
9348
|
+
* @param {PlanCollisionFreeRequest} [planCollisionFreeRequest]
|
|
9349
|
+
* @param {*} [options] Override http request option.
|
|
9350
|
+
* @throws {RequiredError}
|
|
9351
|
+
*/
|
|
9352
|
+
planCollisionFree(cell: string, planCollisionFreeRequest?: PlanCollisionFreeRequest, options?: RawAxiosRequestConfig): AxiosPromise<PlanCollisionFreeResponse>;
|
|
8102
9353
|
/**
|
|
8103
9354
|
* 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
9355
|
* @summary Plan Trajectory
|
|
@@ -8116,6 +9367,16 @@ export declare const TrajectoryPlanningApiFactory: (configuration?: Configuratio
|
|
|
8116
9367
|
* @extends {BaseAPI}
|
|
8117
9368
|
*/
|
|
8118
9369
|
export declare class TrajectoryPlanningApi extends BaseAPI {
|
|
9370
|
+
/**
|
|
9371
|
+
* 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.
|
|
9372
|
+
* @summary Plan Collision-Free Trajectory
|
|
9373
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
9374
|
+
* @param {PlanCollisionFreeRequest} [planCollisionFreeRequest]
|
|
9375
|
+
* @param {*} [options] Override http request option.
|
|
9376
|
+
* @throws {RequiredError}
|
|
9377
|
+
* @memberof TrajectoryPlanningApi
|
|
9378
|
+
*/
|
|
9379
|
+
planCollisionFree(cell: string, planCollisionFreeRequest?: PlanCollisionFreeRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<PlanCollisionFreeResponse, any>>;
|
|
8119
9380
|
/**
|
|
8120
9381
|
* 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
9382
|
* @summary Plan Trajectory
|