@wandelbots/nova-api 25.7.0-dev.3 → 25.7.0-dev.30
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/package.json +1 -1
- package/v1/api.d.ts +10 -7
- package/v1/api.js +8 -5
- package/v1/api.js.map +1 -1
- package/v1/api.ts +10 -7
- package/v1/base.d.ts +1 -1
- package/v1/base.js +1 -1
- package/v1/base.ts +1 -1
- package/v1/common.d.ts +1 -1
- package/v1/common.js +1 -1
- package/v1/common.ts +1 -1
- package/v1/configuration.d.ts +1 -1
- package/v1/configuration.js +1 -1
- package/v1/configuration.ts +1 -1
- package/v1/index.d.ts +1 -1
- package/v1/index.js +1 -1
- package/v1/index.ts +1 -1
- package/v2/api.d.ts +2050 -715
- package/v2/api.js +1649 -413
- package/v2/api.js.map +1 -1
- package/v2/api.ts +2866 -762
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.
|
|
@@ -859,6 +947,37 @@ export interface ContainerStorage {
|
|
|
859
947
|
*/
|
|
860
948
|
'capacity': string;
|
|
861
949
|
}
|
|
950
|
+
/**
|
|
951
|
+
* The data type to describe a robot controller.
|
|
952
|
+
* @export
|
|
953
|
+
* @interface ControllerDescription
|
|
954
|
+
*/
|
|
955
|
+
export interface ControllerDescription {
|
|
956
|
+
/**
|
|
957
|
+
*
|
|
958
|
+
* @type {Array<string>}
|
|
959
|
+
* @memberof ControllerDescription
|
|
960
|
+
*/
|
|
961
|
+
'connected_motion_groups': Array<string>;
|
|
962
|
+
/**
|
|
963
|
+
* Can this controller be moved through freedrive (true), or not (false).
|
|
964
|
+
* @type {boolean}
|
|
965
|
+
* @memberof ControllerDescription
|
|
966
|
+
*/
|
|
967
|
+
'supports_freedrive': boolean;
|
|
968
|
+
/**
|
|
969
|
+
* Can this controller be controlled with NOVA (true) or is it only possible to read data (false).
|
|
970
|
+
* @type {boolean}
|
|
971
|
+
* @memberof ControllerDescription
|
|
972
|
+
*/
|
|
973
|
+
'supports_control': boolean;
|
|
974
|
+
/**
|
|
975
|
+
* True if NOVA supports reading safety zone-, tool- and link-geometries for this motion group. Safety zones are used to define areas where the robot should slow down or stop. If false, NOVA can\'t guarantee that the executed motions respect safety zones defined on the controller.
|
|
976
|
+
* @type {boolean}
|
|
977
|
+
* @memberof ControllerDescription
|
|
978
|
+
*/
|
|
979
|
+
'supports_safety_zones': boolean;
|
|
980
|
+
}
|
|
862
981
|
/**
|
|
863
982
|
* Defines a convex hull encapsulating a set of vertices.
|
|
864
983
|
* @export
|
|
@@ -1071,35 +1190,115 @@ export declare const Direction: {
|
|
|
1071
1190
|
};
|
|
1072
1191
|
export type Direction = typeof Direction[keyof typeof Direction];
|
|
1073
1192
|
/**
|
|
1074
|
-
*
|
|
1193
|
+
* The provided joint data does not match the expected number of joints for this motion group.
|
|
1075
1194
|
* @export
|
|
1076
|
-
* @interface
|
|
1195
|
+
* @interface ErrorInvalidJointCount
|
|
1077
1196
|
*/
|
|
1078
|
-
export interface
|
|
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;
|
|
1079
1210
|
/**
|
|
1080
1211
|
*
|
|
1081
1212
|
* @type {string}
|
|
1082
|
-
* @memberof
|
|
1213
|
+
* @memberof ErrorInvalidJointCount
|
|
1083
1214
|
*/
|
|
1084
|
-
'
|
|
1215
|
+
'error_feedback_name': ErrorInvalidJointCountErrorFeedbackNameEnum;
|
|
1085
1216
|
}
|
|
1086
|
-
export declare const
|
|
1087
|
-
readonly
|
|
1217
|
+
export declare const ErrorInvalidJointCountErrorFeedbackNameEnum: {
|
|
1218
|
+
readonly ErrorInvalidJointCount: "ErrorInvalidJointCount";
|
|
1088
1219
|
};
|
|
1089
|
-
export type
|
|
1220
|
+
export type ErrorInvalidJointCountErrorFeedbackNameEnum = typeof ErrorInvalidJointCountErrorFeedbackNameEnum[keyof typeof ErrorInvalidJointCountErrorFeedbackNameEnum];
|
|
1090
1221
|
/**
|
|
1091
|
-
*
|
|
1222
|
+
* A reference joint position (start or target) exceeds the configured joint limits.
|
|
1092
1223
|
* @export
|
|
1093
|
-
* @interface
|
|
1224
|
+
* @interface ErrorJointLimitExceeded
|
|
1094
1225
|
*/
|
|
1095
|
-
export interface
|
|
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>;
|
|
1096
1239
|
/**
|
|
1097
1240
|
*
|
|
1098
1241
|
* @type {string}
|
|
1099
|
-
* @memberof
|
|
1242
|
+
* @memberof ErrorJointLimitExceeded
|
|
1100
1243
|
*/
|
|
1101
|
-
'
|
|
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;
|
|
1102
1297
|
}
|
|
1298
|
+
export declare const ErrorMaxIterationsExceededErrorFeedbackNameEnum: {
|
|
1299
|
+
readonly ErrorMaxIterationsExceeded: "ErrorMaxIterationsExceeded";
|
|
1300
|
+
};
|
|
1301
|
+
export type ErrorMaxIterationsExceededErrorFeedbackNameEnum = typeof ErrorMaxIterationsExceededErrorFeedbackNameEnum[keyof typeof ErrorMaxIterationsExceededErrorFeedbackNameEnum];
|
|
1103
1302
|
/**
|
|
1104
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.
|
|
1105
1304
|
* @export
|
|
@@ -1358,63 +1557,146 @@ export type FloatValueValueTypeEnum = typeof FloatValueValueTypeEnum[keyof typeo
|
|
|
1358
1557
|
/**
|
|
1359
1558
|
*
|
|
1360
1559
|
* @export
|
|
1361
|
-
* @interface
|
|
1560
|
+
* @interface ForwardKinematics422Response
|
|
1362
1561
|
*/
|
|
1363
|
-
export interface
|
|
1562
|
+
export interface ForwardKinematics422Response {
|
|
1364
1563
|
/**
|
|
1365
1564
|
*
|
|
1366
|
-
* @type {
|
|
1367
|
-
* @memberof
|
|
1565
|
+
* @type {Array<ForwardKinematicsValidationError>}
|
|
1566
|
+
* @memberof ForwardKinematics422Response
|
|
1368
1567
|
*/
|
|
1369
|
-
'
|
|
1568
|
+
'detail'?: Array<ForwardKinematicsValidationError>;
|
|
1370
1569
|
}
|
|
1371
1570
|
/**
|
|
1372
1571
|
*
|
|
1373
1572
|
* @export
|
|
1374
|
-
* @interface
|
|
1573
|
+
* @interface ForwardKinematicsRequest
|
|
1375
1574
|
*/
|
|
1376
|
-
export interface
|
|
1575
|
+
export interface ForwardKinematicsRequest {
|
|
1377
1576
|
/**
|
|
1378
|
-
*
|
|
1577
|
+
* String identifiying the model of a motion group.
|
|
1379
1578
|
* @type {string}
|
|
1380
|
-
* @memberof
|
|
1579
|
+
* @memberof ForwardKinematicsRequest
|
|
1381
1580
|
*/
|
|
1382
|
-
'
|
|
1581
|
+
'motion_group_model': string;
|
|
1383
1582
|
/**
|
|
1384
|
-
*
|
|
1385
|
-
* @type {
|
|
1386
|
-
* @memberof
|
|
1583
|
+
* List of joint positions [rad] for which TCP poses are computed.
|
|
1584
|
+
* @type {Array<Array<number>>}
|
|
1585
|
+
* @memberof ForwardKinematicsRequest
|
|
1387
1586
|
*/
|
|
1388
|
-
'
|
|
1587
|
+
'joint_positions': Array<Array<number>>;
|
|
1389
1588
|
/**
|
|
1390
|
-
*
|
|
1391
|
-
* @type {
|
|
1392
|
-
* @memberof
|
|
1589
|
+
*
|
|
1590
|
+
* @type {Pose}
|
|
1591
|
+
* @memberof ForwardKinematicsRequest
|
|
1393
1592
|
*/
|
|
1394
|
-
'
|
|
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;
|
|
1395
1600
|
}
|
|
1396
1601
|
/**
|
|
1397
1602
|
*
|
|
1398
1603
|
* @export
|
|
1399
|
-
* @interface
|
|
1604
|
+
* @interface ForwardKinematicsResponse
|
|
1400
1605
|
*/
|
|
1401
|
-
export interface
|
|
1606
|
+
export interface ForwardKinematicsResponse {
|
|
1402
1607
|
/**
|
|
1403
|
-
*
|
|
1404
|
-
* @type {Array<
|
|
1405
|
-
* @memberof
|
|
1608
|
+
* List of computed TCP poses corresponding to the input joint positions.
|
|
1609
|
+
* @type {Array<Pose>}
|
|
1610
|
+
* @memberof ForwardKinematicsResponse
|
|
1406
1611
|
*/
|
|
1407
|
-
'
|
|
1612
|
+
'tcp_poses': Array<Pose>;
|
|
1408
1613
|
}
|
|
1409
1614
|
/**
|
|
1410
|
-
*
|
|
1615
|
+
*
|
|
1411
1616
|
* @export
|
|
1412
|
-
* @interface
|
|
1617
|
+
* @interface ForwardKinematicsValidationError
|
|
1413
1618
|
*/
|
|
1414
|
-
export interface
|
|
1619
|
+
export interface ForwardKinematicsValidationError {
|
|
1415
1620
|
/**
|
|
1416
|
-
*
|
|
1417
|
-
* @type {
|
|
1621
|
+
*
|
|
1622
|
+
* @type {Array<ValidationErrorLocInner>}
|
|
1623
|
+
* @memberof ForwardKinematicsValidationError
|
|
1624
|
+
*/
|
|
1625
|
+
'loc': Array<ValidationErrorLocInner>;
|
|
1626
|
+
/**
|
|
1627
|
+
*
|
|
1628
|
+
* @type {string}
|
|
1629
|
+
* @memberof ForwardKinematicsValidationError
|
|
1630
|
+
*/
|
|
1631
|
+
'msg': string;
|
|
1632
|
+
/**
|
|
1633
|
+
*
|
|
1634
|
+
* @type {string}
|
|
1635
|
+
* @memberof ForwardKinematicsValidationError
|
|
1636
|
+
*/
|
|
1637
|
+
'type': string;
|
|
1638
|
+
/**
|
|
1639
|
+
*
|
|
1640
|
+
* @type {{ [key: string]: any; }}
|
|
1641
|
+
* @memberof ForwardKinematicsValidationError
|
|
1642
|
+
*/
|
|
1643
|
+
'input': {
|
|
1644
|
+
[key: string]: any;
|
|
1645
|
+
};
|
|
1646
|
+
/**
|
|
1647
|
+
*
|
|
1648
|
+
* @type {ErrorInvalidJointCount}
|
|
1649
|
+
* @memberof ForwardKinematicsValidationError
|
|
1650
|
+
*/
|
|
1651
|
+
'data'?: ErrorInvalidJointCount;
|
|
1652
|
+
}
|
|
1653
|
+
/**
|
|
1654
|
+
*
|
|
1655
|
+
* @export
|
|
1656
|
+
* @interface 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}
|
|
1418
1700
|
* @memberof IOBooleanValue
|
|
1419
1701
|
*/
|
|
1420
1702
|
'io': string;
|
|
@@ -1859,6 +2141,19 @@ export interface InvalidDofInvalidDof {
|
|
|
1859
2141
|
*/
|
|
1860
2142
|
'joint_position'?: Array<number>;
|
|
1861
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
|
+
}
|
|
1862
2157
|
/**
|
|
1863
2158
|
*
|
|
1864
2159
|
* @export
|
|
@@ -1896,12 +2191,12 @@ export interface InverseKinematicsRequest {
|
|
|
1896
2191
|
*/
|
|
1897
2192
|
'joint_position_limits'?: Array<LimitRange>;
|
|
1898
2193
|
/**
|
|
1899
|
-
* Collision
|
|
1900
|
-
* @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; }}
|
|
1901
2196
|
* @memberof InverseKinematicsRequest
|
|
1902
2197
|
*/
|
|
1903
|
-
'
|
|
1904
|
-
[key: string]:
|
|
2198
|
+
'collision_setups'?: {
|
|
2199
|
+
[key: string]: CollisionSetup;
|
|
1905
2200
|
};
|
|
1906
2201
|
}
|
|
1907
2202
|
/**
|
|
@@ -1917,6 +2212,55 @@ export interface InverseKinematicsResponse {
|
|
|
1917
2212
|
*/
|
|
1918
2213
|
'joints': Array<Array<Array<number>>>;
|
|
1919
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;
|
|
1920
2264
|
/**
|
|
1921
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.
|
|
1922
2266
|
* @export
|
|
@@ -1944,7 +2288,104 @@ export type JoggingDetailsKindEnum = typeof JoggingDetailsKindEnum[keyof typeof
|
|
|
1944
2288
|
* @type JoggingDetailsState
|
|
1945
2289
|
* @export
|
|
1946
2290
|
*/
|
|
1947
|
-
export type JoggingDetailsState =
|
|
2291
|
+
export type JoggingDetailsState = JoggingPausedByUser | JoggingPausedNearCollision | JoggingPausedNearJointLimit | JoggingPausedOnIO | JoggingRunning;
|
|
2292
|
+
/**
|
|
2293
|
+
*
|
|
2294
|
+
* @export
|
|
2295
|
+
* @interface JoggingPausedByUser
|
|
2296
|
+
*/
|
|
2297
|
+
export interface JoggingPausedByUser {
|
|
2298
|
+
/**
|
|
2299
|
+
*
|
|
2300
|
+
* @type {string}
|
|
2301
|
+
* @memberof JoggingPausedByUser
|
|
2302
|
+
*/
|
|
2303
|
+
'kind': JoggingPausedByUserKindEnum;
|
|
2304
|
+
}
|
|
2305
|
+
export declare const JoggingPausedByUserKindEnum: {
|
|
2306
|
+
readonly PausedByUser: "PAUSED_BY_USER";
|
|
2307
|
+
};
|
|
2308
|
+
export type JoggingPausedByUserKindEnum = typeof JoggingPausedByUserKindEnum[keyof typeof JoggingPausedByUserKindEnum];
|
|
2309
|
+
/**
|
|
2310
|
+
*
|
|
2311
|
+
* @export
|
|
2312
|
+
* @interface JoggingPausedNearCollision
|
|
2313
|
+
*/
|
|
2314
|
+
export interface JoggingPausedNearCollision {
|
|
2315
|
+
/**
|
|
2316
|
+
*
|
|
2317
|
+
* @type {string}
|
|
2318
|
+
* @memberof JoggingPausedNearCollision
|
|
2319
|
+
*/
|
|
2320
|
+
'kind': JoggingPausedNearCollisionKindEnum;
|
|
2321
|
+
/**
|
|
2322
|
+
*
|
|
2323
|
+
* @type {string}
|
|
2324
|
+
* @memberof JoggingPausedNearCollision
|
|
2325
|
+
*/
|
|
2326
|
+
'description': string;
|
|
2327
|
+
}
|
|
2328
|
+
export declare const JoggingPausedNearCollisionKindEnum: {
|
|
2329
|
+
readonly PausedNearCollision: "PAUSED_NEAR_COLLISION";
|
|
2330
|
+
};
|
|
2331
|
+
export type JoggingPausedNearCollisionKindEnum = typeof JoggingPausedNearCollisionKindEnum[keyof typeof JoggingPausedNearCollisionKindEnum];
|
|
2332
|
+
/**
|
|
2333
|
+
*
|
|
2334
|
+
* @export
|
|
2335
|
+
* @interface JoggingPausedNearJointLimit
|
|
2336
|
+
*/
|
|
2337
|
+
export interface JoggingPausedNearJointLimit {
|
|
2338
|
+
/**
|
|
2339
|
+
*
|
|
2340
|
+
* @type {string}
|
|
2341
|
+
* @memberof JoggingPausedNearJointLimit
|
|
2342
|
+
*/
|
|
2343
|
+
'kind': JoggingPausedNearJointLimitKindEnum;
|
|
2344
|
+
/**
|
|
2345
|
+
*
|
|
2346
|
+
* @type {Array<number>}
|
|
2347
|
+
* @memberof JoggingPausedNearJointLimit
|
|
2348
|
+
*/
|
|
2349
|
+
'joint_indices': Array<number>;
|
|
2350
|
+
}
|
|
2351
|
+
export declare const JoggingPausedNearJointLimitKindEnum: {
|
|
2352
|
+
readonly PausedNearJointLimit: "PAUSED_NEAR_JOINT_LIMIT";
|
|
2353
|
+
};
|
|
2354
|
+
export type JoggingPausedNearJointLimitKindEnum = typeof JoggingPausedNearJointLimitKindEnum[keyof typeof JoggingPausedNearJointLimitKindEnum];
|
|
2355
|
+
/**
|
|
2356
|
+
*
|
|
2357
|
+
* @export
|
|
2358
|
+
* @interface JoggingPausedOnIO
|
|
2359
|
+
*/
|
|
2360
|
+
export interface JoggingPausedOnIO {
|
|
2361
|
+
/**
|
|
2362
|
+
*
|
|
2363
|
+
* @type {string}
|
|
2364
|
+
* @memberof JoggingPausedOnIO
|
|
2365
|
+
*/
|
|
2366
|
+
'kind': JoggingPausedOnIOKindEnum;
|
|
2367
|
+
}
|
|
2368
|
+
export declare const JoggingPausedOnIOKindEnum: {
|
|
2369
|
+
readonly PausedOnIo: "PAUSED_ON_IO";
|
|
2370
|
+
};
|
|
2371
|
+
export type JoggingPausedOnIOKindEnum = typeof JoggingPausedOnIOKindEnum[keyof typeof JoggingPausedOnIOKindEnum];
|
|
2372
|
+
/**
|
|
2373
|
+
*
|
|
2374
|
+
* @export
|
|
2375
|
+
* @interface JoggingRunning
|
|
2376
|
+
*/
|
|
2377
|
+
export interface JoggingRunning {
|
|
2378
|
+
/**
|
|
2379
|
+
*
|
|
2380
|
+
* @type {string}
|
|
2381
|
+
* @memberof JoggingRunning
|
|
2382
|
+
*/
|
|
2383
|
+
'kind': JoggingRunningKindEnum;
|
|
2384
|
+
}
|
|
2385
|
+
export declare const JoggingRunningKindEnum: {
|
|
2386
|
+
readonly Running: "RUNNING";
|
|
2387
|
+
};
|
|
2388
|
+
export type JoggingRunningKindEnum = typeof JoggingRunningKindEnum[keyof typeof JoggingRunningKindEnum];
|
|
1948
2389
|
/**
|
|
1949
2390
|
*
|
|
1950
2391
|
* @export
|
|
@@ -2366,6 +2807,29 @@ export declare const Manufacturer: {
|
|
|
2366
2807
|
readonly Yaskawa: "yaskawa";
|
|
2367
2808
|
};
|
|
2368
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];
|
|
2369
2833
|
/**
|
|
2370
2834
|
*
|
|
2371
2835
|
* @export
|
|
@@ -2556,6 +3020,57 @@ export interface MotionGroupJoints {
|
|
|
2556
3020
|
*/
|
|
2557
3021
|
'torques'?: Array<number>;
|
|
2558
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
|
+
}
|
|
2559
3074
|
/**
|
|
2560
3075
|
* Presents the current state of the motion group.
|
|
2561
3076
|
* @export
|
|
@@ -3044,131 +3559,109 @@ export interface PauseOnIO {
|
|
|
3044
3559
|
/**
|
|
3045
3560
|
*
|
|
3046
3561
|
* @export
|
|
3047
|
-
* @interface
|
|
3562
|
+
* @interface Payload
|
|
3048
3563
|
*/
|
|
3049
|
-
export interface
|
|
3564
|
+
export interface Payload {
|
|
3050
3565
|
/**
|
|
3051
3566
|
*
|
|
3052
3567
|
* @type {string}
|
|
3053
|
-
* @memberof
|
|
3568
|
+
* @memberof Payload
|
|
3054
3569
|
*/
|
|
3055
|
-
'
|
|
3570
|
+
'name': string;
|
|
3571
|
+
/**
|
|
3572
|
+
* Mass of payload in [kg].
|
|
3573
|
+
* @type {number}
|
|
3574
|
+
* @memberof Payload
|
|
3575
|
+
*/
|
|
3576
|
+
'payload': number;
|
|
3577
|
+
/**
|
|
3578
|
+
* A three-dimensional vector [x, y, z] with double precision.
|
|
3579
|
+
* @type {Array<number>}
|
|
3580
|
+
* @memberof Payload
|
|
3581
|
+
*/
|
|
3582
|
+
'center_of_mass'?: Array<number>;
|
|
3583
|
+
/**
|
|
3584
|
+
* A three-dimensional vector [x, y, z] with double precision.
|
|
3585
|
+
* @type {Array<number>}
|
|
3586
|
+
* @memberof Payload
|
|
3587
|
+
*/
|
|
3588
|
+
'moment_of_inertia'?: Array<number>;
|
|
3056
3589
|
}
|
|
3057
|
-
export declare const PausedByRequestKindEnum: {
|
|
3058
|
-
readonly PausedByUser: "PAUSED_BY_USER";
|
|
3059
|
-
};
|
|
3060
|
-
export type PausedByRequestKindEnum = typeof PausedByRequestKindEnum[keyof typeof PausedByRequestKindEnum];
|
|
3061
3590
|
/**
|
|
3062
3591
|
*
|
|
3063
3592
|
* @export
|
|
3064
|
-
* @interface
|
|
3593
|
+
* @interface Plan422Response
|
|
3065
3594
|
*/
|
|
3066
|
-
export interface
|
|
3595
|
+
export interface Plan422Response {
|
|
3067
3596
|
/**
|
|
3068
3597
|
*
|
|
3069
|
-
* @type {
|
|
3070
|
-
* @memberof
|
|
3598
|
+
* @type {Array<PlanValidationError>}
|
|
3599
|
+
* @memberof Plan422Response
|
|
3071
3600
|
*/
|
|
3072
|
-
'
|
|
3601
|
+
'detail'?: Array<PlanValidationError>;
|
|
3073
3602
|
}
|
|
3074
|
-
export declare const PausedByUserKindEnum: {
|
|
3075
|
-
readonly PausedByUser: "PAUSED_BY_USER";
|
|
3076
|
-
};
|
|
3077
|
-
export type PausedByUserKindEnum = typeof PausedByUserKindEnum[keyof typeof PausedByUserKindEnum];
|
|
3078
3603
|
/**
|
|
3079
|
-
*
|
|
3604
|
+
* Response when collision-free trajectory planning fails. Contains specific feedback about why the planning failed.
|
|
3080
3605
|
* @export
|
|
3081
|
-
* @interface
|
|
3606
|
+
* @interface PlanCollisionFreeFailedResponse
|
|
3082
3607
|
*/
|
|
3083
|
-
export interface
|
|
3084
|
-
/**
|
|
3085
|
-
*
|
|
3086
|
-
* @type {string}
|
|
3087
|
-
* @memberof PausedNearCollision
|
|
3088
|
-
*/
|
|
3089
|
-
'kind': PausedNearCollisionKindEnum;
|
|
3608
|
+
export interface PlanCollisionFreeFailedResponse {
|
|
3090
3609
|
/**
|
|
3091
3610
|
*
|
|
3092
|
-
* @type {
|
|
3093
|
-
* @memberof
|
|
3611
|
+
* @type {ErrorMaxIterationsExceeded}
|
|
3612
|
+
* @memberof PlanCollisionFreeFailedResponse
|
|
3094
3613
|
*/
|
|
3095
|
-
'
|
|
3614
|
+
'error_feedback': ErrorMaxIterationsExceeded;
|
|
3096
3615
|
}
|
|
3097
|
-
export declare const PausedNearCollisionKindEnum: {
|
|
3098
|
-
readonly PausedNearCollision: "PAUSED_NEAR_COLLISION";
|
|
3099
|
-
};
|
|
3100
|
-
export type PausedNearCollisionKindEnum = typeof PausedNearCollisionKindEnum[keyof typeof PausedNearCollisionKindEnum];
|
|
3101
3616
|
/**
|
|
3102
3617
|
*
|
|
3103
3618
|
* @export
|
|
3104
|
-
* @interface
|
|
3619
|
+
* @interface PlanCollisionFreeRequest
|
|
3105
3620
|
*/
|
|
3106
|
-
export interface
|
|
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;
|
|
3107
3628
|
/**
|
|
3108
3629
|
*
|
|
3109
|
-
* @type {
|
|
3110
|
-
* @memberof
|
|
3630
|
+
* @type {Array<number>}
|
|
3631
|
+
* @memberof PlanCollisionFreeRequest
|
|
3111
3632
|
*/
|
|
3112
|
-
'
|
|
3633
|
+
'start_joint_position': Array<number>;
|
|
3113
3634
|
/**
|
|
3114
3635
|
*
|
|
3115
3636
|
* @type {Array<number>}
|
|
3116
|
-
* @memberof
|
|
3637
|
+
* @memberof PlanCollisionFreeRequest
|
|
3117
3638
|
*/
|
|
3118
|
-
'
|
|
3119
|
-
}
|
|
3120
|
-
export declare const PausedNearJointLimitKindEnum: {
|
|
3121
|
-
readonly PausedNearJointLimit: "PAUSED_NEAR_JOINT_LIMIT";
|
|
3122
|
-
};
|
|
3123
|
-
export type PausedNearJointLimitKindEnum = typeof PausedNearJointLimitKindEnum[keyof typeof PausedNearJointLimitKindEnum];
|
|
3124
|
-
/**
|
|
3125
|
-
*
|
|
3126
|
-
* @export
|
|
3127
|
-
* @interface PausedOnIO
|
|
3128
|
-
*/
|
|
3129
|
-
export interface PausedOnIO {
|
|
3639
|
+
'target': Array<number>;
|
|
3130
3640
|
/**
|
|
3131
3641
|
*
|
|
3132
|
-
* @type {
|
|
3133
|
-
* @memberof
|
|
3642
|
+
* @type {CollisionFreeAlgorithm}
|
|
3643
|
+
* @memberof PlanCollisionFreeRequest
|
|
3134
3644
|
*/
|
|
3135
|
-
'
|
|
3645
|
+
'algorithm': CollisionFreeAlgorithm;
|
|
3136
3646
|
}
|
|
3137
|
-
export declare const PausedOnIOKindEnum: {
|
|
3138
|
-
readonly PausedOnIo: "PAUSED_ON_IO";
|
|
3139
|
-
};
|
|
3140
|
-
export type PausedOnIOKindEnum = typeof PausedOnIOKindEnum[keyof typeof PausedOnIOKindEnum];
|
|
3141
3647
|
/**
|
|
3142
|
-
*
|
|
3648
|
+
* Response from collision-free trajectory planning. Contains either a successful joint trajectory or failure information.
|
|
3143
3649
|
* @export
|
|
3144
|
-
* @interface
|
|
3650
|
+
* @interface PlanCollisionFreeResponse
|
|
3145
3651
|
*/
|
|
3146
|
-
export interface
|
|
3652
|
+
export interface PlanCollisionFreeResponse {
|
|
3147
3653
|
/**
|
|
3148
3654
|
*
|
|
3149
|
-
* @type {
|
|
3150
|
-
* @memberof
|
|
3151
|
-
*/
|
|
3152
|
-
'name': string;
|
|
3153
|
-
/**
|
|
3154
|
-
* Mass of payload in [kg].
|
|
3155
|
-
* @type {number}
|
|
3156
|
-
* @memberof Payload
|
|
3157
|
-
*/
|
|
3158
|
-
'payload': number;
|
|
3159
|
-
/**
|
|
3160
|
-
* A three-dimensional vector [x, y, z] with double precision.
|
|
3161
|
-
* @type {Array<number>}
|
|
3162
|
-
* @memberof Payload
|
|
3163
|
-
*/
|
|
3164
|
-
'center_of_mass'?: Array<number>;
|
|
3165
|
-
/**
|
|
3166
|
-
* A three-dimensional vector [x, y, z] with double precision.
|
|
3167
|
-
* @type {Array<number>}
|
|
3168
|
-
* @memberof Payload
|
|
3655
|
+
* @type {PlanCollisionFreeResponseResponse}
|
|
3656
|
+
* @memberof PlanCollisionFreeResponse
|
|
3169
3657
|
*/
|
|
3170
|
-
'
|
|
3658
|
+
'response': PlanCollisionFreeResponseResponse;
|
|
3171
3659
|
}
|
|
3660
|
+
/**
|
|
3661
|
+
* @type PlanCollisionFreeResponseResponse
|
|
3662
|
+
* @export
|
|
3663
|
+
*/
|
|
3664
|
+
export type PlanCollisionFreeResponseResponse = JointTrajectory | PlanCollisionFreeFailedResponse;
|
|
3172
3665
|
/**
|
|
3173
3666
|
*
|
|
3174
3667
|
* @export
|
|
@@ -3207,10 +3700,10 @@ export type PlanTrajectoryFailedResponseErrorFeedback = FeedbackCollision | Feed
|
|
|
3207
3700
|
export interface PlanTrajectoryRequest {
|
|
3208
3701
|
/**
|
|
3209
3702
|
* The data to assemble the robot setup can be retrieved from [getMotionGroupDescription](getMotionGroupDescription) endpoint.
|
|
3210
|
-
* @type {
|
|
3703
|
+
* @type {MotionGroupSetup}
|
|
3211
3704
|
* @memberof PlanTrajectoryRequest
|
|
3212
3705
|
*/
|
|
3213
|
-
'
|
|
3706
|
+
'motion_group_setup': MotionGroupSetup;
|
|
3214
3707
|
/**
|
|
3215
3708
|
*
|
|
3216
3709
|
* @type {Array<number>}
|
|
@@ -3242,6 +3735,57 @@ export interface PlanTrajectoryResponse {
|
|
|
3242
3735
|
* @export
|
|
3243
3736
|
*/
|
|
3244
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;
|
|
3245
3789
|
/**
|
|
3246
3790
|
* Defines an x/y-plane with infinite size.
|
|
3247
3791
|
* @export
|
|
@@ -3324,6 +3868,250 @@ export interface Pose {
|
|
|
3324
3868
|
*/
|
|
3325
3869
|
'orientation'?: Array<number>;
|
|
3326
3870
|
}
|
|
3871
|
+
/**
|
|
3872
|
+
*
|
|
3873
|
+
* @export
|
|
3874
|
+
* @interface ProfinetDescription
|
|
3875
|
+
*/
|
|
3876
|
+
export interface ProfinetDescription {
|
|
3877
|
+
/**
|
|
3878
|
+
* The vendor identifier of the PROFINET device, identifying the manufacturer.
|
|
3879
|
+
* @type {string}
|
|
3880
|
+
* @memberof ProfinetDescription
|
|
3881
|
+
*/
|
|
3882
|
+
'vendor_id': string;
|
|
3883
|
+
/**
|
|
3884
|
+
* The device identifier of the PROFINET device, identifying the specific device within the vendor\'s range.
|
|
3885
|
+
* @type {string}
|
|
3886
|
+
* @memberof ProfinetDescription
|
|
3887
|
+
*/
|
|
3888
|
+
'device_id': string;
|
|
3889
|
+
/**
|
|
3890
|
+
*
|
|
3891
|
+
* @type {Array<ProfinetSlotDescription>}
|
|
3892
|
+
* @memberof ProfinetDescription
|
|
3893
|
+
*/
|
|
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;
|
|
3907
|
+
}
|
|
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];
|
|
3327
4115
|
/**
|
|
3328
4116
|
* Defines an x/y-plane with finite size. Centred around the z-axis.
|
|
3329
4117
|
* @export
|
|
@@ -3405,7 +4193,7 @@ export type ReleaseChannel = typeof ReleaseChannel[keyof typeof ReleaseChannel];
|
|
|
3405
4193
|
*/
|
|
3406
4194
|
export interface RobotController {
|
|
3407
4195
|
/**
|
|
3408
|
-
*
|
|
4196
|
+
* Unique name of controller within the cell. It must be a valid k8s label name as defined by [RFC 1035](https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#rfc-1035-label-names).
|
|
3409
4197
|
* @type {string}
|
|
3410
4198
|
* @memberof RobotController
|
|
3411
4199
|
*/
|
|
@@ -3428,6 +4216,18 @@ export type RobotControllerConfiguration = AbbController | FanucController | Kuk
|
|
|
3428
4216
|
* @interface RobotControllerState
|
|
3429
4217
|
*/
|
|
3430
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>;
|
|
3431
4231
|
/**
|
|
3432
4232
|
* Timestamp indicating when the represented information was received from the robot controller.
|
|
3433
4233
|
* @type {string}
|
|
@@ -3472,67 +4272,16 @@ export interface RobotControllerState {
|
|
|
3472
4272
|
'motion_groups': Array<MotionGroupState>;
|
|
3473
4273
|
}
|
|
3474
4274
|
/**
|
|
3475
|
-
*
|
|
3476
|
-
* @export
|
|
3477
|
-
* @interface RobotSetup
|
|
3478
|
-
*/
|
|
3479
|
-
export interface RobotSetup {
|
|
3480
|
-
/**
|
|
3481
|
-
* String identifiying the model of a motion group.
|
|
3482
|
-
* @type {string}
|
|
3483
|
-
* @memberof RobotSetup
|
|
3484
|
-
*/
|
|
3485
|
-
'motion_group_model': string;
|
|
3486
|
-
/**
|
|
3487
|
-
* [ms] cycle time of the motion group controller. A trajectory for this motion group should be computed to this resolution.
|
|
3488
|
-
* @type {number}
|
|
3489
|
-
* @memberof RobotSetup
|
|
3490
|
-
*/
|
|
3491
|
-
'cycle_time': number;
|
|
3492
|
-
/**
|
|
3493
|
-
* The offset from the world frame to the motion group base.
|
|
3494
|
-
* @type {Pose}
|
|
3495
|
-
* @memberof RobotSetup
|
|
3496
|
-
*/
|
|
3497
|
-
'mounting'?: Pose;
|
|
3498
|
-
/**
|
|
3499
|
-
*
|
|
3500
|
-
* @type {Pose}
|
|
3501
|
-
* @memberof RobotSetup
|
|
3502
|
-
*/
|
|
3503
|
-
'tcp_offset'?: Pose;
|
|
3504
|
-
/**
|
|
3505
|
-
*
|
|
3506
|
-
* @type {LimitSet}
|
|
3507
|
-
* @memberof RobotSetup
|
|
3508
|
-
*/
|
|
3509
|
-
'global_limits'?: LimitSet;
|
|
3510
|
-
/**
|
|
3511
|
-
*
|
|
3512
|
-
* @type {Payload}
|
|
3513
|
-
* @memberof RobotSetup
|
|
3514
|
-
*/
|
|
3515
|
-
'payload'?: Payload;
|
|
3516
|
-
/**
|
|
3517
|
-
* 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.
|
|
3518
|
-
* @type {{ [key: string]: SingleMotionGroupCollisionScene; }}
|
|
3519
|
-
* @memberof RobotSetup
|
|
3520
|
-
*/
|
|
3521
|
-
'collision_scenes'?: {
|
|
3522
|
-
[key: string]: SingleMotionGroupCollisionScene;
|
|
3523
|
-
};
|
|
3524
|
-
}
|
|
3525
|
-
/**
|
|
3526
|
-
* 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.
|
|
3527
4276
|
* @export
|
|
3528
4277
|
* @enum {string}
|
|
3529
4278
|
*/
|
|
3530
4279
|
export declare const RobotSystemMode: {
|
|
3531
|
-
readonly
|
|
3532
|
-
readonly
|
|
3533
|
-
readonly
|
|
3534
|
-
readonly
|
|
3535
|
-
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";
|
|
3536
4285
|
};
|
|
3537
4286
|
export type RobotSystemMode = typeof RobotSystemMode[keyof typeof RobotSystemMode];
|
|
3538
4287
|
/**
|
|
@@ -3604,49 +4353,9 @@ export interface RobotTcpData {
|
|
|
3604
4353
|
'orientation_type'?: OrientationType;
|
|
3605
4354
|
}
|
|
3606
4355
|
/**
|
|
3607
|
-
*
|
|
4356
|
+
* Current safety state of the configured robot controller. Operation modes in which the attached motion groups can be moved are: - SAFETY_STATE_NORMAL - SAFETY_STATE_REDUCED All other modes are considered as non-operational.
|
|
3608
4357
|
* @export
|
|
3609
|
-
* @
|
|
3610
|
-
*/
|
|
3611
|
-
export interface Running {
|
|
3612
|
-
/**
|
|
3613
|
-
*
|
|
3614
|
-
* @type {string}
|
|
3615
|
-
* @memberof Running
|
|
3616
|
-
*/
|
|
3617
|
-
'kind': RunningKindEnum;
|
|
3618
|
-
}
|
|
3619
|
-
export declare const RunningKindEnum: {
|
|
3620
|
-
readonly Running: "RUNNING";
|
|
3621
|
-
};
|
|
3622
|
-
export type RunningKindEnum = typeof RunningKindEnum[keyof typeof RunningKindEnum];
|
|
3623
|
-
/**
|
|
3624
|
-
*
|
|
3625
|
-
* @export
|
|
3626
|
-
* @interface Running1
|
|
3627
|
-
*/
|
|
3628
|
-
export interface Running1 {
|
|
3629
|
-
/**
|
|
3630
|
-
*
|
|
3631
|
-
* @type {string}
|
|
3632
|
-
* @memberof Running1
|
|
3633
|
-
*/
|
|
3634
|
-
'kind': Running1KindEnum;
|
|
3635
|
-
/**
|
|
3636
|
-
* Remaining time in milliseconds (ms) to reach the end of the motion.
|
|
3637
|
-
* @type {number}
|
|
3638
|
-
* @memberof Running1
|
|
3639
|
-
*/
|
|
3640
|
-
'time_to_end': number;
|
|
3641
|
-
}
|
|
3642
|
-
export declare const Running1KindEnum: {
|
|
3643
|
-
readonly Running: "RUNNING";
|
|
3644
|
-
};
|
|
3645
|
-
export type Running1KindEnum = typeof Running1KindEnum[keyof typeof Running1KindEnum];
|
|
3646
|
-
/**
|
|
3647
|
-
* Current safety state of the configured robot controller. Operation modes in which the attached motion groups can be moved are: - SAFETY_STATE_NORMAL - SAFETY_STATE_REDUCED All other modes are considered as non-operational.
|
|
3648
|
-
* @export
|
|
3649
|
-
* @enum {string}
|
|
4358
|
+
* @enum {string}
|
|
3650
4359
|
*/
|
|
3651
4360
|
export declare const SafetyStateType: {
|
|
3652
4361
|
readonly SafetyStateUnknown: "SAFETY_STATE_UNKNOWN";
|
|
@@ -3791,43 +4500,6 @@ export declare const SettableRobotSystemMode: {
|
|
|
3791
4500
|
readonly RobotSystemModeControl: "ROBOT_SYSTEM_MODE_CONTROL";
|
|
3792
4501
|
};
|
|
3793
4502
|
export type SettableRobotSystemMode = typeof SettableRobotSystemMode[keyof typeof SettableRobotSystemMode];
|
|
3794
|
-
/**
|
|
3795
|
-
*
|
|
3796
|
-
* @export
|
|
3797
|
-
* @interface SingleMotionGroupCollisionScene
|
|
3798
|
-
*/
|
|
3799
|
-
export interface SingleMotionGroupCollisionScene {
|
|
3800
|
-
/**
|
|
3801
|
-
* A collection of identifiable colliders.
|
|
3802
|
-
* @type {{ [key: string]: Collider; }}
|
|
3803
|
-
* @memberof SingleMotionGroupCollisionScene
|
|
3804
|
-
*/
|
|
3805
|
-
'static_colliders'?: {
|
|
3806
|
-
[key: string]: Collider;
|
|
3807
|
-
};
|
|
3808
|
-
/**
|
|
3809
|
-
* 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.
|
|
3810
|
-
* @type {Array<{ [key: string]: Collider; }>}
|
|
3811
|
-
* @memberof SingleMotionGroupCollisionScene
|
|
3812
|
-
*/
|
|
3813
|
-
'link_chain'?: Array<{
|
|
3814
|
-
[key: string]: Collider;
|
|
3815
|
-
}>;
|
|
3816
|
-
/**
|
|
3817
|
-
* 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.
|
|
3818
|
-
* @type {{ [key: string]: Collider; }}
|
|
3819
|
-
* @memberof SingleMotionGroupCollisionScene
|
|
3820
|
-
*/
|
|
3821
|
-
'tool'?: {
|
|
3822
|
-
[key: string]: Collider;
|
|
3823
|
-
};
|
|
3824
|
-
/**
|
|
3825
|
-
* If true, self-collision detection is enabled for the motion group. See LinkChain documentation for details. Default is true.
|
|
3826
|
-
* @type {boolean}
|
|
3827
|
-
* @memberof SingleMotionGroupCollisionScene
|
|
3828
|
-
*/
|
|
3829
|
-
'motion_group_self_collision_detection'?: boolean;
|
|
3830
|
-
}
|
|
3831
4503
|
/**
|
|
3832
4504
|
*
|
|
3833
4505
|
* @export
|
|
@@ -3879,7 +4551,7 @@ export interface StartMovementRequest {
|
|
|
3879
4551
|
* @type {Direction}
|
|
3880
4552
|
* @memberof StartMovementRequest
|
|
3881
4553
|
*/
|
|
3882
|
-
'direction'
|
|
4554
|
+
'direction'?: Direction;
|
|
3883
4555
|
/**
|
|
3884
4556
|
* Attaches a list of output commands to the trajectory. The outputs are set to the specified values right after the specified location was reached. If the specified location is located before the start location (forward direction: value is smaller, backward direction: value is bigger), the output is not set.
|
|
3885
4557
|
* @type {Array<IOValue>}
|
|
@@ -4166,7 +4838,24 @@ export type TrajectoryDetailsKindEnum = typeof TrajectoryDetailsKindEnum[keyof t
|
|
|
4166
4838
|
* @type TrajectoryDetailsState
|
|
4167
4839
|
* @export
|
|
4168
4840
|
*/
|
|
4169
|
-
export type TrajectoryDetailsState =
|
|
4841
|
+
export type TrajectoryDetailsState = TrajectoryEnded | TrajectoryPausedByUser | TrajectoryPausedOnIO | TrajectoryRunning | TrajectoryWaitForIO;
|
|
4842
|
+
/**
|
|
4843
|
+
*
|
|
4844
|
+
* @export
|
|
4845
|
+
* @interface TrajectoryEnded
|
|
4846
|
+
*/
|
|
4847
|
+
export interface TrajectoryEnded {
|
|
4848
|
+
/**
|
|
4849
|
+
*
|
|
4850
|
+
* @type {string}
|
|
4851
|
+
* @memberof TrajectoryEnded
|
|
4852
|
+
*/
|
|
4853
|
+
'kind': TrajectoryEndedKindEnum;
|
|
4854
|
+
}
|
|
4855
|
+
export declare const TrajectoryEndedKindEnum: {
|
|
4856
|
+
readonly EndOfTrajectory: "END_OF_TRAJECTORY";
|
|
4857
|
+
};
|
|
4858
|
+
export type TrajectoryEndedKindEnum = typeof TrajectoryEndedKindEnum[keyof typeof TrajectoryEndedKindEnum];
|
|
4170
4859
|
/**
|
|
4171
4860
|
*
|
|
4172
4861
|
* @export
|
|
@@ -4190,6 +4879,80 @@ export declare const TrajectoryIdMessageTypeEnum: {
|
|
|
4190
4879
|
readonly TrajectoryId: "TrajectoryId";
|
|
4191
4880
|
};
|
|
4192
4881
|
export type TrajectoryIdMessageTypeEnum = typeof TrajectoryIdMessageTypeEnum[keyof typeof TrajectoryIdMessageTypeEnum];
|
|
4882
|
+
/**
|
|
4883
|
+
*
|
|
4884
|
+
* @export
|
|
4885
|
+
* @interface TrajectoryPausedByUser
|
|
4886
|
+
*/
|
|
4887
|
+
export interface TrajectoryPausedByUser {
|
|
4888
|
+
/**
|
|
4889
|
+
*
|
|
4890
|
+
* @type {string}
|
|
4891
|
+
* @memberof TrajectoryPausedByUser
|
|
4892
|
+
*/
|
|
4893
|
+
'kind': TrajectoryPausedByUserKindEnum;
|
|
4894
|
+
}
|
|
4895
|
+
export declare const TrajectoryPausedByUserKindEnum: {
|
|
4896
|
+
readonly PausedByUser: "PAUSED_BY_USER";
|
|
4897
|
+
};
|
|
4898
|
+
export type TrajectoryPausedByUserKindEnum = typeof TrajectoryPausedByUserKindEnum[keyof typeof TrajectoryPausedByUserKindEnum];
|
|
4899
|
+
/**
|
|
4900
|
+
*
|
|
4901
|
+
* @export
|
|
4902
|
+
* @interface TrajectoryPausedOnIO
|
|
4903
|
+
*/
|
|
4904
|
+
export interface TrajectoryPausedOnIO {
|
|
4905
|
+
/**
|
|
4906
|
+
*
|
|
4907
|
+
* @type {string}
|
|
4908
|
+
* @memberof TrajectoryPausedOnIO
|
|
4909
|
+
*/
|
|
4910
|
+
'kind': TrajectoryPausedOnIOKindEnum;
|
|
4911
|
+
}
|
|
4912
|
+
export declare const TrajectoryPausedOnIOKindEnum: {
|
|
4913
|
+
readonly PausedOnIo: "PAUSED_ON_IO";
|
|
4914
|
+
};
|
|
4915
|
+
export type TrajectoryPausedOnIOKindEnum = typeof TrajectoryPausedOnIOKindEnum[keyof typeof TrajectoryPausedOnIOKindEnum];
|
|
4916
|
+
/**
|
|
4917
|
+
*
|
|
4918
|
+
* @export
|
|
4919
|
+
* @interface TrajectoryRunning
|
|
4920
|
+
*/
|
|
4921
|
+
export interface TrajectoryRunning {
|
|
4922
|
+
/**
|
|
4923
|
+
*
|
|
4924
|
+
* @type {string}
|
|
4925
|
+
* @memberof TrajectoryRunning
|
|
4926
|
+
*/
|
|
4927
|
+
'kind': TrajectoryRunningKindEnum;
|
|
4928
|
+
/**
|
|
4929
|
+
* Remaining time in milliseconds (ms) to reach the end of the motion.
|
|
4930
|
+
* @type {number}
|
|
4931
|
+
* @memberof TrajectoryRunning
|
|
4932
|
+
*/
|
|
4933
|
+
'time_to_end': number;
|
|
4934
|
+
}
|
|
4935
|
+
export declare const TrajectoryRunningKindEnum: {
|
|
4936
|
+
readonly Running: "RUNNING";
|
|
4937
|
+
};
|
|
4938
|
+
export type TrajectoryRunningKindEnum = typeof TrajectoryRunningKindEnum[keyof typeof TrajectoryRunningKindEnum];
|
|
4939
|
+
/**
|
|
4940
|
+
*
|
|
4941
|
+
* @export
|
|
4942
|
+
* @interface TrajectoryWaitForIO
|
|
4943
|
+
*/
|
|
4944
|
+
export interface TrajectoryWaitForIO {
|
|
4945
|
+
/**
|
|
4946
|
+
*
|
|
4947
|
+
* @type {string}
|
|
4948
|
+
* @memberof TrajectoryWaitForIO
|
|
4949
|
+
*/
|
|
4950
|
+
'kind': TrajectoryWaitForIOKindEnum;
|
|
4951
|
+
}
|
|
4952
|
+
export declare const TrajectoryWaitForIOKindEnum: {
|
|
4953
|
+
readonly WaitForIo: "WAIT_FOR_IO";
|
|
4954
|
+
};
|
|
4955
|
+
export type TrajectoryWaitForIOKindEnum = typeof TrajectoryWaitForIOKindEnum[keyof typeof TrajectoryWaitForIOKindEnum];
|
|
4193
4956
|
/**
|
|
4194
4957
|
* The unit of input/output value.
|
|
4195
4958
|
* @export
|
|
@@ -4268,6 +5031,14 @@ export interface ValidationError {
|
|
|
4268
5031
|
* @memberof ValidationError
|
|
4269
5032
|
*/
|
|
4270
5033
|
'type': string;
|
|
5034
|
+
/**
|
|
5035
|
+
*
|
|
5036
|
+
* @type {{ [key: string]: any; }}
|
|
5037
|
+
* @memberof ValidationError
|
|
5038
|
+
*/
|
|
5039
|
+
'input': {
|
|
5040
|
+
[key: string]: any;
|
|
5041
|
+
};
|
|
4271
5042
|
}
|
|
4272
5043
|
/**
|
|
4273
5044
|
* @type ValidationErrorLocInner
|
|
@@ -4275,7 +5046,7 @@ export interface ValidationError {
|
|
|
4275
5046
|
*/
|
|
4276
5047
|
export type ValidationErrorLocInner = number | string;
|
|
4277
5048
|
/**
|
|
4278
|
-
* The configuration of a virtual robot controller has to contain the manufacturer string, an optional joint position string array and either a type or the
|
|
5049
|
+
* The configuration of a virtual robot controller has to contain the manufacturer string, an optional joint position string array and either a preset `type` **or** the complete JSON configuration.
|
|
4279
5050
|
* @export
|
|
4280
5051
|
* @interface VirtualController
|
|
4281
5052
|
*/
|
|
@@ -4299,7 +5070,7 @@ export interface VirtualController {
|
|
|
4299
5070
|
*/
|
|
4300
5071
|
'type'?: VirtualControllerTypes;
|
|
4301
5072
|
/**
|
|
4302
|
-
*
|
|
5073
|
+
* Complete JSON configuration of the virtual robot controller. Can be obtained from the physical controller\'s configuration via [getVirtualControllerConfiguration](getVirtualControllerConfiguration). If provided, the `type` field should not be used.
|
|
4303
5074
|
* @type {string}
|
|
4304
5075
|
* @memberof VirtualController
|
|
4305
5076
|
*/
|
|
@@ -4309,7 +5080,7 @@ export interface VirtualController {
|
|
|
4309
5080
|
* @type {string}
|
|
4310
5081
|
* @memberof VirtualController
|
|
4311
5082
|
*/
|
|
4312
|
-
'
|
|
5083
|
+
'initial_joint_position'?: string;
|
|
4313
5084
|
}
|
|
4314
5085
|
export declare const VirtualControllerKindEnum: {
|
|
4315
5086
|
readonly VirtualController: "VirtualController";
|
|
@@ -4355,6 +5126,7 @@ export declare const VirtualControllerTypes: {
|
|
|
4355
5126
|
readonly FanucCrx20ial: "fanuc-crx20ial";
|
|
4356
5127
|
readonly FanucCrx25ia: "fanuc-crx25ia";
|
|
4357
5128
|
readonly FanucCrx30ia: "fanuc-crx30ia";
|
|
5129
|
+
readonly FanucCrx5ia: "fanuc-crx5ia";
|
|
4358
5130
|
readonly FanucLrMate200iD: "fanuc-lr_mate_200iD";
|
|
4359
5131
|
readonly FanucLrMate200iD4S: "fanuc-lr_mate_200iD4S";
|
|
4360
5132
|
readonly FanucLrMate200iD7L: "fanuc-lr_mate_200iD7L";
|
|
@@ -4362,6 +5134,7 @@ export declare const VirtualControllerTypes: {
|
|
|
4362
5134
|
readonly FanucM10iD16S: "fanuc-m10iD16S";
|
|
4363
5135
|
readonly FanucM20iD25: "fanuc-m20iD25";
|
|
4364
5136
|
readonly FanucM20iD35: "fanuc-m20iD35";
|
|
5137
|
+
readonly FanucM710iC20L: "fanuc-m710iC20L";
|
|
4365
5138
|
readonly FanucM900iB280L: "fanuc-m900iB280L";
|
|
4366
5139
|
readonly FanucM900iB360E: "fanuc-m900iB360E";
|
|
4367
5140
|
readonly FanucR2000ic125l: "fanuc-r2000ic125l";
|
|
@@ -4449,23 +5222,6 @@ export interface VirtualRobotConfiguration {
|
|
|
4449
5222
|
*/
|
|
4450
5223
|
'content': string;
|
|
4451
5224
|
}
|
|
4452
|
-
/**
|
|
4453
|
-
*
|
|
4454
|
-
* @export
|
|
4455
|
-
* @interface WaitForIO
|
|
4456
|
-
*/
|
|
4457
|
-
export interface WaitForIO {
|
|
4458
|
-
/**
|
|
4459
|
-
*
|
|
4460
|
-
* @type {string}
|
|
4461
|
-
* @memberof WaitForIO
|
|
4462
|
-
*/
|
|
4463
|
-
'kind': WaitForIOKindEnum;
|
|
4464
|
-
}
|
|
4465
|
-
export declare const WaitForIOKindEnum: {
|
|
4466
|
-
readonly WaitForIo: "WAIT_FOR_IO";
|
|
4467
|
-
};
|
|
4468
|
-
export type WaitForIOKindEnum = typeof WaitForIOKindEnum[keyof typeof WaitForIOKindEnum];
|
|
4469
5225
|
/**
|
|
4470
5226
|
* The value to compare with the current value of the input/output.
|
|
4471
5227
|
* @export
|
|
@@ -4496,277 +5252,778 @@ export interface YaskawaController {
|
|
|
4496
5252
|
* @type {string}
|
|
4497
5253
|
* @memberof YaskawaController
|
|
4498
5254
|
*/
|
|
4499
|
-
'kind'?: YaskawaControllerKindEnum;
|
|
5255
|
+
'kind'?: YaskawaControllerKindEnum;
|
|
5256
|
+
/**
|
|
5257
|
+
*
|
|
5258
|
+
* @type {string}
|
|
5259
|
+
* @memberof YaskawaController
|
|
5260
|
+
*/
|
|
5261
|
+
'controller_ip': string;
|
|
5262
|
+
}
|
|
5263
|
+
export declare const YaskawaControllerKindEnum: {
|
|
5264
|
+
readonly YaskawaController: "YaskawaController";
|
|
5265
|
+
};
|
|
5266
|
+
export type YaskawaControllerKindEnum = typeof YaskawaControllerKindEnum[keyof typeof YaskawaControllerKindEnum];
|
|
5267
|
+
/**
|
|
5268
|
+
* ApplicationApi - axios parameter creator
|
|
5269
|
+
* @export
|
|
5270
|
+
*/
|
|
5271
|
+
export declare const ApplicationApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
5272
|
+
/**
|
|
5273
|
+
* 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.
|
|
5274
|
+
* @summary Add Application
|
|
5275
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5276
|
+
* @param {App} app
|
|
5277
|
+
* @param {number} [completionTimeout]
|
|
5278
|
+
* @param {*} [options] Override http request option.
|
|
5279
|
+
* @throws {RequiredError}
|
|
5280
|
+
*/
|
|
5281
|
+
addApp: (cell: string, app: App, completionTimeout?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
5282
|
+
/**
|
|
5283
|
+
* Delete all GUI applications from the cell.
|
|
5284
|
+
* @summary Clear Applications
|
|
5285
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5286
|
+
* @param {number} [completionTimeout]
|
|
5287
|
+
* @param {*} [options] Override http request option.
|
|
5288
|
+
* @throws {RequiredError}
|
|
5289
|
+
*/
|
|
5290
|
+
clearApps: (cell: string, completionTimeout?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
5291
|
+
/**
|
|
5292
|
+
* Delete a GUI application from the cell.
|
|
5293
|
+
* @summary Delete Application
|
|
5294
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5295
|
+
* @param {string} app
|
|
5296
|
+
* @param {number} [completionTimeout]
|
|
5297
|
+
* @param {*} [options] Override http request option.
|
|
5298
|
+
* @throws {RequiredError}
|
|
5299
|
+
*/
|
|
5300
|
+
deleteApp: (cell: string, app: string, completionTimeout?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
5301
|
+
/**
|
|
5302
|
+
* 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.
|
|
5303
|
+
* @summary Configuration
|
|
5304
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5305
|
+
* @param {string} app
|
|
5306
|
+
* @param {*} [options] Override http request option.
|
|
5307
|
+
* @throws {RequiredError}
|
|
5308
|
+
*/
|
|
5309
|
+
getApp: (cell: string, app: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
5310
|
+
/**
|
|
5311
|
+
* 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.
|
|
5312
|
+
* @summary List Applications
|
|
5313
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5314
|
+
* @param {*} [options] Override http request option.
|
|
5315
|
+
* @throws {RequiredError}
|
|
5316
|
+
*/
|
|
5317
|
+
listApps: (cell: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
5318
|
+
/**
|
|
5319
|
+
* Update the configuration of a GUI application in the cell.
|
|
5320
|
+
* @summary Update Configuration
|
|
5321
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5322
|
+
* @param {string} app
|
|
5323
|
+
* @param {App} app2
|
|
5324
|
+
* @param {number} [completionTimeout]
|
|
5325
|
+
* @param {*} [options] Override http request option.
|
|
5326
|
+
* @throws {RequiredError}
|
|
5327
|
+
*/
|
|
5328
|
+
updateApp: (cell: string, app: string, app2: App, completionTimeout?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
5329
|
+
};
|
|
5330
|
+
/**
|
|
5331
|
+
* ApplicationApi - functional programming interface
|
|
5332
|
+
* @export
|
|
5333
|
+
*/
|
|
5334
|
+
export declare const ApplicationApiFp: (configuration?: Configuration) => {
|
|
5335
|
+
/**
|
|
5336
|
+
* 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.
|
|
5337
|
+
* @summary Add Application
|
|
5338
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5339
|
+
* @param {App} app
|
|
5340
|
+
* @param {number} [completionTimeout]
|
|
5341
|
+
* @param {*} [options] Override http request option.
|
|
5342
|
+
* @throws {RequiredError}
|
|
5343
|
+
*/
|
|
5344
|
+
addApp(cell: string, app: App, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
5345
|
+
/**
|
|
5346
|
+
* Delete all GUI applications from the cell.
|
|
5347
|
+
* @summary Clear Applications
|
|
5348
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5349
|
+
* @param {number} [completionTimeout]
|
|
5350
|
+
* @param {*} [options] Override http request option.
|
|
5351
|
+
* @throws {RequiredError}
|
|
5352
|
+
*/
|
|
5353
|
+
clearApps(cell: string, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
5354
|
+
/**
|
|
5355
|
+
* Delete a GUI application from the cell.
|
|
5356
|
+
* @summary Delete Application
|
|
5357
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5358
|
+
* @param {string} app
|
|
5359
|
+
* @param {number} [completionTimeout]
|
|
5360
|
+
* @param {*} [options] Override http request option.
|
|
5361
|
+
* @throws {RequiredError}
|
|
5362
|
+
*/
|
|
5363
|
+
deleteApp(cell: string, app: string, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
5364
|
+
/**
|
|
5365
|
+
* 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.
|
|
5366
|
+
* @summary Configuration
|
|
5367
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5368
|
+
* @param {string} app
|
|
5369
|
+
* @param {*} [options] Override http request option.
|
|
5370
|
+
* @throws {RequiredError}
|
|
5371
|
+
*/
|
|
5372
|
+
getApp(cell: string, app: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<App>>;
|
|
5373
|
+
/**
|
|
5374
|
+
* 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.
|
|
5375
|
+
* @summary List Applications
|
|
5376
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5377
|
+
* @param {*} [options] Override http request option.
|
|
5378
|
+
* @throws {RequiredError}
|
|
5379
|
+
*/
|
|
5380
|
+
listApps(cell: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<string>>>;
|
|
5381
|
+
/**
|
|
5382
|
+
* Update the configuration of a GUI application in the cell.
|
|
5383
|
+
* @summary Update Configuration
|
|
5384
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5385
|
+
* @param {string} app
|
|
5386
|
+
* @param {App} app2
|
|
5387
|
+
* @param {number} [completionTimeout]
|
|
5388
|
+
* @param {*} [options] Override http request option.
|
|
5389
|
+
* @throws {RequiredError}
|
|
5390
|
+
*/
|
|
5391
|
+
updateApp(cell: string, app: string, app2: App, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
5392
|
+
};
|
|
5393
|
+
/**
|
|
5394
|
+
* ApplicationApi - factory interface
|
|
5395
|
+
* @export
|
|
5396
|
+
*/
|
|
5397
|
+
export declare const ApplicationApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
5398
|
+
/**
|
|
5399
|
+
* 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.
|
|
5400
|
+
* @summary Add Application
|
|
5401
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5402
|
+
* @param {App} app
|
|
5403
|
+
* @param {number} [completionTimeout]
|
|
5404
|
+
* @param {*} [options] Override http request option.
|
|
5405
|
+
* @throws {RequiredError}
|
|
5406
|
+
*/
|
|
5407
|
+
addApp(cell: string, app: App, completionTimeout?: number, options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
5408
|
+
/**
|
|
5409
|
+
* Delete all GUI applications from the cell.
|
|
5410
|
+
* @summary Clear Applications
|
|
5411
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5412
|
+
* @param {number} [completionTimeout]
|
|
5413
|
+
* @param {*} [options] Override http request option.
|
|
5414
|
+
* @throws {RequiredError}
|
|
5415
|
+
*/
|
|
5416
|
+
clearApps(cell: string, completionTimeout?: number, options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
5417
|
+
/**
|
|
5418
|
+
* Delete a GUI application from the cell.
|
|
5419
|
+
* @summary Delete Application
|
|
5420
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5421
|
+
* @param {string} app
|
|
5422
|
+
* @param {number} [completionTimeout]
|
|
5423
|
+
* @param {*} [options] Override http request option.
|
|
5424
|
+
* @throws {RequiredError}
|
|
5425
|
+
*/
|
|
5426
|
+
deleteApp(cell: string, app: string, completionTimeout?: number, options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
5427
|
+
/**
|
|
5428
|
+
* 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.
|
|
5429
|
+
* @summary Configuration
|
|
5430
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5431
|
+
* @param {string} app
|
|
5432
|
+
* @param {*} [options] Override http request option.
|
|
5433
|
+
* @throws {RequiredError}
|
|
5434
|
+
*/
|
|
5435
|
+
getApp(cell: string, app: string, options?: RawAxiosRequestConfig): AxiosPromise<App>;
|
|
5436
|
+
/**
|
|
5437
|
+
* 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.
|
|
5438
|
+
* @summary List Applications
|
|
5439
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5440
|
+
* @param {*} [options] Override http request option.
|
|
5441
|
+
* @throws {RequiredError}
|
|
5442
|
+
*/
|
|
5443
|
+
listApps(cell: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<string>>;
|
|
5444
|
+
/**
|
|
5445
|
+
* Update the configuration of a GUI application in the cell.
|
|
5446
|
+
* @summary Update Configuration
|
|
5447
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5448
|
+
* @param {string} app
|
|
5449
|
+
* @param {App} app2
|
|
5450
|
+
* @param {number} [completionTimeout]
|
|
5451
|
+
* @param {*} [options] Override http request option.
|
|
5452
|
+
* @throws {RequiredError}
|
|
5453
|
+
*/
|
|
5454
|
+
updateApp(cell: string, app: string, app2: App, completionTimeout?: number, options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
5455
|
+
};
|
|
5456
|
+
/**
|
|
5457
|
+
* ApplicationApi - object-oriented interface
|
|
5458
|
+
* @export
|
|
5459
|
+
* @class ApplicationApi
|
|
5460
|
+
* @extends {BaseAPI}
|
|
5461
|
+
*/
|
|
5462
|
+
export declare class ApplicationApi extends BaseAPI {
|
|
5463
|
+
/**
|
|
5464
|
+
* 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.
|
|
5465
|
+
* @summary Add Application
|
|
5466
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5467
|
+
* @param {App} app
|
|
5468
|
+
* @param {number} [completionTimeout]
|
|
5469
|
+
* @param {*} [options] Override http request option.
|
|
5470
|
+
* @throws {RequiredError}
|
|
5471
|
+
* @memberof ApplicationApi
|
|
5472
|
+
*/
|
|
5473
|
+
addApp(cell: string, app: App, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
5474
|
+
/**
|
|
5475
|
+
* Delete all GUI applications from the cell.
|
|
5476
|
+
* @summary Clear Applications
|
|
5477
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5478
|
+
* @param {number} [completionTimeout]
|
|
5479
|
+
* @param {*} [options] Override http request option.
|
|
5480
|
+
* @throws {RequiredError}
|
|
5481
|
+
* @memberof ApplicationApi
|
|
5482
|
+
*/
|
|
5483
|
+
clearApps(cell: string, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
5484
|
+
/**
|
|
5485
|
+
* Delete a GUI application from the cell.
|
|
5486
|
+
* @summary Delete Application
|
|
5487
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5488
|
+
* @param {string} app
|
|
5489
|
+
* @param {number} [completionTimeout]
|
|
5490
|
+
* @param {*} [options] Override http request option.
|
|
5491
|
+
* @throws {RequiredError}
|
|
5492
|
+
* @memberof ApplicationApi
|
|
5493
|
+
*/
|
|
5494
|
+
deleteApp(cell: string, app: string, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
5495
|
+
/**
|
|
5496
|
+
* 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.
|
|
5497
|
+
* @summary Configuration
|
|
5498
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5499
|
+
* @param {string} app
|
|
5500
|
+
* @param {*} [options] Override http request option.
|
|
5501
|
+
* @throws {RequiredError}
|
|
5502
|
+
* @memberof ApplicationApi
|
|
5503
|
+
*/
|
|
5504
|
+
getApp(cell: string, app: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<App, any>>;
|
|
5505
|
+
/**
|
|
5506
|
+
* 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.
|
|
5507
|
+
* @summary List Applications
|
|
5508
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5509
|
+
* @param {*} [options] Override http request option.
|
|
5510
|
+
* @throws {RequiredError}
|
|
5511
|
+
* @memberof ApplicationApi
|
|
5512
|
+
*/
|
|
5513
|
+
listApps(cell: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<string[], any>>;
|
|
5514
|
+
/**
|
|
5515
|
+
* Update the configuration of a GUI application in the cell.
|
|
5516
|
+
* @summary Update Configuration
|
|
5517
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5518
|
+
* @param {string} app
|
|
5519
|
+
* @param {App} app2
|
|
5520
|
+
* @param {number} [completionTimeout]
|
|
5521
|
+
* @param {*} [options] Override http request option.
|
|
5522
|
+
* @throws {RequiredError}
|
|
5523
|
+
* @memberof ApplicationApi
|
|
5524
|
+
*/
|
|
5525
|
+
updateApp(cell: string, app: string, app2: App, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
5526
|
+
}
|
|
5527
|
+
/**
|
|
5528
|
+
* BUSInputsOutputsApi - axios parameter creator
|
|
5529
|
+
* @export
|
|
5530
|
+
*/
|
|
5531
|
+
export declare const BUSInputsOutputsApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
5532
|
+
/**
|
|
5533
|
+
* Add a BUS Inputs/Outputs Service to the cell.
|
|
5534
|
+
* @summary Add Service
|
|
5535
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5536
|
+
* @param {BusIOType} busIOType
|
|
5537
|
+
* @param {number} [completionTimeout]
|
|
5538
|
+
* @param {*} [options] Override http request option.
|
|
5539
|
+
* @throws {RequiredError}
|
|
5540
|
+
*/
|
|
5541
|
+
addBusIOService: (cell: string, busIOType: BusIOType, completionTimeout?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
5542
|
+
/**
|
|
5543
|
+
* Adds an input/output to or updates an input/output on the PROFINET device.
|
|
5544
|
+
* @summary Add PROFINET Input/Output
|
|
5545
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5546
|
+
* @param {string} io Unique identifier to address an Input/Output in the cell.
|
|
5547
|
+
* @param {ProfinetIOData} profinetIOData
|
|
5548
|
+
* @param {*} [options] Override http request option.
|
|
5549
|
+
* @throws {RequiredError}
|
|
5550
|
+
*/
|
|
5551
|
+
addProfinetIO: (cell: string, io: string, profinetIOData: ProfinetIOData, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
5552
|
+
/**
|
|
5553
|
+
* Delete BUS Inputs/Outputs Service from the cell.
|
|
5554
|
+
* @summary Clear Service
|
|
5555
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5556
|
+
* @param {number} [completionTimeout]
|
|
5557
|
+
* @param {*} [options] Override http request option.
|
|
5558
|
+
* @throws {RequiredError}
|
|
5559
|
+
*/
|
|
5560
|
+
clearBusIOService: (cell: string, completionTimeout?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
5561
|
+
/**
|
|
5562
|
+
* Removes the input/output from the PROFINET device.
|
|
5563
|
+
* @summary Remove PROFINET Input/Ouptut
|
|
5564
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5565
|
+
* @param {string} io Unique identifier to address an Input/Output in the cell.
|
|
5566
|
+
* @param {*} [options] Override http request option.
|
|
5567
|
+
* @throws {RequiredError}
|
|
5568
|
+
*/
|
|
5569
|
+
deleteProfinetIO: (cell: string, io: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
5570
|
+
/**
|
|
5571
|
+
* Get deployed BUS Inputs/Outputs Service.
|
|
5572
|
+
* @summary Get Service
|
|
5573
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5574
|
+
* @param {*} [options] Override http request option.
|
|
5575
|
+
* @throws {RequiredError}
|
|
5576
|
+
*/
|
|
5577
|
+
getBusIOService: (cell: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
5578
|
+
/**
|
|
5579
|
+
* Get the current state of the BUS Inputs/Outputs service.
|
|
5580
|
+
* @summary State
|
|
5581
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5582
|
+
* @param {*} [options] Override http request option.
|
|
5583
|
+
* @throws {RequiredError}
|
|
5584
|
+
*/
|
|
5585
|
+
getBusIOState: (cell: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
5586
|
+
/**
|
|
5587
|
+
* 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).
|
|
5588
|
+
* @summary Get Input/Output Values
|
|
5589
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5590
|
+
* @param {Array<string>} [ios]
|
|
5591
|
+
* @param {*} [options] Override http request option.
|
|
5592
|
+
* @throws {RequiredError}
|
|
5593
|
+
*/
|
|
5594
|
+
getBusIOValues: (cell: string, ios?: Array<string>, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
5595
|
+
/**
|
|
5596
|
+
* Get description of PROFINET
|
|
5597
|
+
* @summary Get PROFINET Description
|
|
5598
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5599
|
+
* @param {*} [options] Override http request option.
|
|
5600
|
+
* @throws {RequiredError}
|
|
5601
|
+
*/
|
|
5602
|
+
getProfinetDescription: (cell: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
5603
|
+
/**
|
|
5604
|
+
* Get input/output configuration of the PROFINET device as file.
|
|
5605
|
+
* @summary PROFINET Inputs/Outputs to File
|
|
5606
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5607
|
+
* @param {number} [inputOffset]
|
|
5608
|
+
* @param {number} [outputOffset]
|
|
5609
|
+
* @param {*} [options] Override http request option.
|
|
5610
|
+
* @throws {RequiredError}
|
|
5611
|
+
*/
|
|
5612
|
+
getProfinetIOsFromFile: (cell: string, inputOffset?: number, outputOffset?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
5613
|
+
/**
|
|
5614
|
+
* List all BUS Input/Output descriptions.
|
|
5615
|
+
* @summary List Descriptions
|
|
5616
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5617
|
+
* @param {*} [options] Override http request option.
|
|
5618
|
+
* @throws {RequiredError}
|
|
5619
|
+
*/
|
|
5620
|
+
listBusIODescriptions: (cell: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
5621
|
+
/**
|
|
5622
|
+
* List all PROFINET input and outputs.
|
|
5623
|
+
* @summary List PROFINET Input/Output Configuration
|
|
5624
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5625
|
+
* @param {*} [options] Override http request option.
|
|
5626
|
+
* @throws {RequiredError}
|
|
5627
|
+
*/
|
|
5628
|
+
listProfinetIOs: (cell: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
5629
|
+
/**
|
|
5630
|
+
* 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.
|
|
5631
|
+
* @summary Set Output Values
|
|
5632
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5633
|
+
* @param {Array<IOValue>} iOValue
|
|
5634
|
+
* @param {*} [options] Override http request option.
|
|
5635
|
+
* @throws {RequiredError}
|
|
5636
|
+
*/
|
|
5637
|
+
setBusIOValues: (cell: string, iOValue: Array<IOValue>, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
5638
|
+
/**
|
|
5639
|
+
* Sets inputs/outputs on the PROFINET device from file.
|
|
5640
|
+
* @summary Set PROFINET Inputs/Outputs from File
|
|
5641
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5642
|
+
* @param {ProfinetInputOutputConfig} profinetInputOutputConfig
|
|
5643
|
+
* @param {*} [options] Override http request option.
|
|
5644
|
+
* @throws {RequiredError}
|
|
5645
|
+
*/
|
|
5646
|
+
setProfinetIOsFromFile: (cell: string, profinetInputOutputConfig: ProfinetInputOutputConfig, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
5647
|
+
};
|
|
5648
|
+
/**
|
|
5649
|
+
* BUSInputsOutputsApi - functional programming interface
|
|
5650
|
+
* @export
|
|
5651
|
+
*/
|
|
5652
|
+
export declare const BUSInputsOutputsApiFp: (configuration?: Configuration) => {
|
|
5653
|
+
/**
|
|
5654
|
+
* Add a BUS Inputs/Outputs Service to the cell.
|
|
5655
|
+
* @summary Add Service
|
|
5656
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5657
|
+
* @param {BusIOType} busIOType
|
|
5658
|
+
* @param {number} [completionTimeout]
|
|
5659
|
+
* @param {*} [options] Override http request option.
|
|
5660
|
+
* @throws {RequiredError}
|
|
5661
|
+
*/
|
|
5662
|
+
addBusIOService(cell: string, busIOType: BusIOType, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
5663
|
+
/**
|
|
5664
|
+
* Adds an input/output to or updates an input/output on the PROFINET device.
|
|
5665
|
+
* @summary Add PROFINET Input/Output
|
|
5666
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5667
|
+
* @param {string} io Unique identifier to address an Input/Output in the cell.
|
|
5668
|
+
* @param {ProfinetIOData} profinetIOData
|
|
5669
|
+
* @param {*} [options] Override http request option.
|
|
5670
|
+
* @throws {RequiredError}
|
|
5671
|
+
*/
|
|
5672
|
+
addProfinetIO(cell: string, io: string, profinetIOData: ProfinetIOData, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
5673
|
+
/**
|
|
5674
|
+
* Delete BUS Inputs/Outputs Service from the cell.
|
|
5675
|
+
* @summary Clear Service
|
|
5676
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5677
|
+
* @param {number} [completionTimeout]
|
|
5678
|
+
* @param {*} [options] Override http request option.
|
|
5679
|
+
* @throws {RequiredError}
|
|
5680
|
+
*/
|
|
5681
|
+
clearBusIOService(cell: string, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
5682
|
+
/**
|
|
5683
|
+
* Removes the input/output from the PROFINET device.
|
|
5684
|
+
* @summary Remove PROFINET Input/Ouptut
|
|
5685
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5686
|
+
* @param {string} io Unique identifier to address an Input/Output in the cell.
|
|
5687
|
+
* @param {*} [options] Override http request option.
|
|
5688
|
+
* @throws {RequiredError}
|
|
5689
|
+
*/
|
|
5690
|
+
deleteProfinetIO(cell: string, io: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
5691
|
+
/**
|
|
5692
|
+
* Get deployed BUS Inputs/Outputs Service.
|
|
5693
|
+
* @summary Get Service
|
|
5694
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5695
|
+
* @param {*} [options] Override http request option.
|
|
5696
|
+
* @throws {RequiredError}
|
|
5697
|
+
*/
|
|
5698
|
+
getBusIOService(cell: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BusIOType>>;
|
|
5699
|
+
/**
|
|
5700
|
+
* Get the current state of the BUS Inputs/Outputs service.
|
|
5701
|
+
* @summary State
|
|
5702
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5703
|
+
* @param {*} [options] Override http request option.
|
|
5704
|
+
* @throws {RequiredError}
|
|
5705
|
+
*/
|
|
5706
|
+
getBusIOState(cell: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BusIOsState>>;
|
|
5707
|
+
/**
|
|
5708
|
+
* 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).
|
|
5709
|
+
* @summary Get Input/Output Values
|
|
5710
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5711
|
+
* @param {Array<string>} [ios]
|
|
5712
|
+
* @param {*} [options] Override http request option.
|
|
5713
|
+
* @throws {RequiredError}
|
|
5714
|
+
*/
|
|
5715
|
+
getBusIOValues(cell: string, ios?: Array<string>, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<IOValue>>>;
|
|
5716
|
+
/**
|
|
5717
|
+
* Get description of PROFINET
|
|
5718
|
+
* @summary Get PROFINET Description
|
|
5719
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5720
|
+
* @param {*} [options] Override http request option.
|
|
5721
|
+
* @throws {RequiredError}
|
|
5722
|
+
*/
|
|
5723
|
+
getProfinetDescription(cell: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ProfinetDescription>>;
|
|
5724
|
+
/**
|
|
5725
|
+
* Get input/output configuration of the PROFINET device as file.
|
|
5726
|
+
* @summary PROFINET Inputs/Outputs to File
|
|
5727
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5728
|
+
* @param {number} [inputOffset]
|
|
5729
|
+
* @param {number} [outputOffset]
|
|
5730
|
+
* @param {*} [options] Override http request option.
|
|
5731
|
+
* @throws {RequiredError}
|
|
5732
|
+
*/
|
|
5733
|
+
getProfinetIOsFromFile(cell: string, inputOffset?: number, outputOffset?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<string>>;
|
|
5734
|
+
/**
|
|
5735
|
+
* List all BUS Input/Output descriptions.
|
|
5736
|
+
* @summary List Descriptions
|
|
5737
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5738
|
+
* @param {*} [options] Override http request option.
|
|
5739
|
+
* @throws {RequiredError}
|
|
5740
|
+
*/
|
|
5741
|
+
listBusIODescriptions(cell: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<IODescription>>>;
|
|
5742
|
+
/**
|
|
5743
|
+
* List all PROFINET input and outputs.
|
|
5744
|
+
* @summary List PROFINET Input/Output Configuration
|
|
5745
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5746
|
+
* @param {*} [options] Override http request option.
|
|
5747
|
+
* @throws {RequiredError}
|
|
5748
|
+
*/
|
|
5749
|
+
listProfinetIOs(cell: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<ProfinetIO>>>;
|
|
5750
|
+
/**
|
|
5751
|
+
* 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.
|
|
5752
|
+
* @summary Set Output Values
|
|
5753
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5754
|
+
* @param {Array<IOValue>} iOValue
|
|
5755
|
+
* @param {*} [options] Override http request option.
|
|
5756
|
+
* @throws {RequiredError}
|
|
5757
|
+
*/
|
|
5758
|
+
setBusIOValues(cell: string, iOValue: Array<IOValue>, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
4500
5759
|
/**
|
|
4501
|
-
*
|
|
4502
|
-
* @
|
|
4503
|
-
* @
|
|
5760
|
+
* Sets inputs/outputs on the PROFINET device from file.
|
|
5761
|
+
* @summary Set PROFINET Inputs/Outputs from File
|
|
5762
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5763
|
+
* @param {ProfinetInputOutputConfig} profinetInputOutputConfig
|
|
5764
|
+
* @param {*} [options] Override http request option.
|
|
5765
|
+
* @throws {RequiredError}
|
|
4504
5766
|
*/
|
|
4505
|
-
|
|
4506
|
-
}
|
|
4507
|
-
export declare const YaskawaControllerKindEnum: {
|
|
4508
|
-
readonly YaskawaController: "YaskawaController";
|
|
5767
|
+
setProfinetIOsFromFile(cell: string, profinetInputOutputConfig: ProfinetInputOutputConfig, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
4509
5768
|
};
|
|
4510
|
-
export type YaskawaControllerKindEnum = typeof YaskawaControllerKindEnum[keyof typeof YaskawaControllerKindEnum];
|
|
4511
5769
|
/**
|
|
4512
|
-
*
|
|
5770
|
+
* BUSInputsOutputsApi - factory interface
|
|
4513
5771
|
* @export
|
|
4514
5772
|
*/
|
|
4515
|
-
export declare const
|
|
5773
|
+
export declare const BUSInputsOutputsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
4516
5774
|
/**
|
|
4517
|
-
*
|
|
4518
|
-
* @summary Add
|
|
5775
|
+
* Add a BUS Inputs/Outputs Service to the cell.
|
|
5776
|
+
* @summary Add Service
|
|
4519
5777
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
4520
|
-
* @param {
|
|
5778
|
+
* @param {BusIOType} busIOType
|
|
4521
5779
|
* @param {number} [completionTimeout]
|
|
4522
5780
|
* @param {*} [options] Override http request option.
|
|
4523
5781
|
* @throws {RequiredError}
|
|
4524
5782
|
*/
|
|
4525
|
-
|
|
5783
|
+
addBusIOService(cell: string, busIOType: BusIOType, completionTimeout?: number, options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
4526
5784
|
/**
|
|
4527
|
-
*
|
|
4528
|
-
* @summary
|
|
5785
|
+
* Adds an input/output to or updates an input/output on the PROFINET device.
|
|
5786
|
+
* @summary Add PROFINET Input/Output
|
|
4529
5787
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
4530
|
-
* @param {
|
|
5788
|
+
* @param {string} io Unique identifier to address an Input/Output in the cell.
|
|
5789
|
+
* @param {ProfinetIOData} profinetIOData
|
|
4531
5790
|
* @param {*} [options] Override http request option.
|
|
4532
5791
|
* @throws {RequiredError}
|
|
4533
5792
|
*/
|
|
4534
|
-
|
|
5793
|
+
addProfinetIO(cell: string, io: string, profinetIOData: ProfinetIOData, options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
4535
5794
|
/**
|
|
4536
|
-
* Delete
|
|
4537
|
-
* @summary
|
|
5795
|
+
* Delete BUS Inputs/Outputs Service from the cell.
|
|
5796
|
+
* @summary Clear Service
|
|
4538
5797
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
4539
|
-
* @param {string} app
|
|
4540
5798
|
* @param {number} [completionTimeout]
|
|
4541
5799
|
* @param {*} [options] Override http request option.
|
|
4542
5800
|
* @throws {RequiredError}
|
|
4543
5801
|
*/
|
|
4544
|
-
|
|
5802
|
+
clearBusIOService(cell: string, completionTimeout?: number, options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
4545
5803
|
/**
|
|
4546
|
-
*
|
|
4547
|
-
* @summary
|
|
5804
|
+
* Removes the input/output from the PROFINET device.
|
|
5805
|
+
* @summary Remove PROFINET Input/Ouptut
|
|
4548
5806
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
4549
|
-
* @param {string}
|
|
5807
|
+
* @param {string} io Unique identifier to address an Input/Output in the cell.
|
|
4550
5808
|
* @param {*} [options] Override http request option.
|
|
4551
5809
|
* @throws {RequiredError}
|
|
4552
5810
|
*/
|
|
4553
|
-
|
|
5811
|
+
deleteProfinetIO(cell: string, io: string, options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
4554
5812
|
/**
|
|
4555
|
-
*
|
|
4556
|
-
* @summary
|
|
5813
|
+
* Get deployed BUS Inputs/Outputs Service.
|
|
5814
|
+
* @summary Get Service
|
|
4557
5815
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
4558
5816
|
* @param {*} [options] Override http request option.
|
|
4559
5817
|
* @throws {RequiredError}
|
|
4560
5818
|
*/
|
|
4561
|
-
|
|
5819
|
+
getBusIOService(cell: string, options?: RawAxiosRequestConfig): AxiosPromise<BusIOType>;
|
|
4562
5820
|
/**
|
|
4563
|
-
*
|
|
4564
|
-
* @summary
|
|
5821
|
+
* Get the current state of the BUS Inputs/Outputs service.
|
|
5822
|
+
* @summary State
|
|
4565
5823
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
4566
|
-
* @param {string} app
|
|
4567
|
-
* @param {App} app2
|
|
4568
|
-
* @param {number} [completionTimeout]
|
|
4569
5824
|
* @param {*} [options] Override http request option.
|
|
4570
5825
|
* @throws {RequiredError}
|
|
4571
5826
|
*/
|
|
4572
|
-
|
|
4573
|
-
};
|
|
4574
|
-
/**
|
|
4575
|
-
* ApplicationApi - functional programming interface
|
|
4576
|
-
* @export
|
|
4577
|
-
*/
|
|
4578
|
-
export declare const ApplicationApiFp: (configuration?: Configuration) => {
|
|
5827
|
+
getBusIOState(cell: string, options?: RawAxiosRequestConfig): AxiosPromise<BusIOsState>;
|
|
4579
5828
|
/**
|
|
4580
|
-
*
|
|
4581
|
-
* @summary
|
|
5829
|
+
* 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).
|
|
5830
|
+
* @summary Get Input/Output Values
|
|
4582
5831
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
4583
|
-
* @param {
|
|
4584
|
-
* @param {number} [completionTimeout]
|
|
5832
|
+
* @param {Array<string>} [ios]
|
|
4585
5833
|
* @param {*} [options] Override http request option.
|
|
4586
5834
|
* @throws {RequiredError}
|
|
4587
5835
|
*/
|
|
4588
|
-
|
|
5836
|
+
getBusIOValues(cell: string, ios?: Array<string>, options?: RawAxiosRequestConfig): AxiosPromise<Array<IOValue>>;
|
|
4589
5837
|
/**
|
|
4590
|
-
*
|
|
4591
|
-
* @summary
|
|
5838
|
+
* Get description of PROFINET
|
|
5839
|
+
* @summary Get PROFINET Description
|
|
4592
5840
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
4593
|
-
* @param {number} [completionTimeout]
|
|
4594
5841
|
* @param {*} [options] Override http request option.
|
|
4595
5842
|
* @throws {RequiredError}
|
|
4596
5843
|
*/
|
|
4597
|
-
|
|
5844
|
+
getProfinetDescription(cell: string, options?: RawAxiosRequestConfig): AxiosPromise<ProfinetDescription>;
|
|
4598
5845
|
/**
|
|
4599
|
-
*
|
|
4600
|
-
* @summary
|
|
5846
|
+
* Get input/output configuration of the PROFINET device as file.
|
|
5847
|
+
* @summary PROFINET Inputs/Outputs to File
|
|
4601
5848
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
4602
|
-
* @param {
|
|
4603
|
-
* @param {number} [
|
|
5849
|
+
* @param {number} [inputOffset]
|
|
5850
|
+
* @param {number} [outputOffset]
|
|
4604
5851
|
* @param {*} [options] Override http request option.
|
|
4605
5852
|
* @throws {RequiredError}
|
|
4606
5853
|
*/
|
|
4607
|
-
|
|
5854
|
+
getProfinetIOsFromFile(cell: string, inputOffset?: number, outputOffset?: number, options?: RawAxiosRequestConfig): AxiosPromise<string>;
|
|
4608
5855
|
/**
|
|
4609
|
-
*
|
|
4610
|
-
* @summary
|
|
5856
|
+
* List all BUS Input/Output descriptions.
|
|
5857
|
+
* @summary List Descriptions
|
|
4611
5858
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
4612
|
-
* @param {string} app
|
|
4613
5859
|
* @param {*} [options] Override http request option.
|
|
4614
5860
|
* @throws {RequiredError}
|
|
4615
5861
|
*/
|
|
4616
|
-
|
|
5862
|
+
listBusIODescriptions(cell: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<IODescription>>;
|
|
4617
5863
|
/**
|
|
4618
|
-
* List all
|
|
4619
|
-
* @summary List
|
|
5864
|
+
* List all PROFINET input and outputs.
|
|
5865
|
+
* @summary List PROFINET Input/Output Configuration
|
|
4620
5866
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
4621
5867
|
* @param {*} [options] Override http request option.
|
|
4622
5868
|
* @throws {RequiredError}
|
|
4623
5869
|
*/
|
|
4624
|
-
|
|
5870
|
+
listProfinetIOs(cell: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<ProfinetIO>>;
|
|
4625
5871
|
/**
|
|
4626
|
-
*
|
|
4627
|
-
* @summary
|
|
5872
|
+
* 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.
|
|
5873
|
+
* @summary Set Output Values
|
|
4628
5874
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
4629
|
-
* @param {
|
|
4630
|
-
* @param {App} app2
|
|
4631
|
-
* @param {number} [completionTimeout]
|
|
5875
|
+
* @param {Array<IOValue>} iOValue
|
|
4632
5876
|
* @param {*} [options] Override http request option.
|
|
4633
5877
|
* @throws {RequiredError}
|
|
4634
5878
|
*/
|
|
4635
|
-
|
|
5879
|
+
setBusIOValues(cell: string, iOValue: Array<IOValue>, options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
5880
|
+
/**
|
|
5881
|
+
* Sets inputs/outputs on the PROFINET device from file.
|
|
5882
|
+
* @summary Set PROFINET Inputs/Outputs from File
|
|
5883
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5884
|
+
* @param {ProfinetInputOutputConfig} profinetInputOutputConfig
|
|
5885
|
+
* @param {*} [options] Override http request option.
|
|
5886
|
+
* @throws {RequiredError}
|
|
5887
|
+
*/
|
|
5888
|
+
setProfinetIOsFromFile(cell: string, profinetInputOutputConfig: ProfinetInputOutputConfig, options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
4636
5889
|
};
|
|
4637
5890
|
/**
|
|
4638
|
-
*
|
|
5891
|
+
* BUSInputsOutputsApi - object-oriented interface
|
|
4639
5892
|
* @export
|
|
5893
|
+
* @class BUSInputsOutputsApi
|
|
5894
|
+
* @extends {BaseAPI}
|
|
4640
5895
|
*/
|
|
4641
|
-
export declare
|
|
5896
|
+
export declare class BUSInputsOutputsApi extends BaseAPI {
|
|
4642
5897
|
/**
|
|
4643
|
-
*
|
|
4644
|
-
* @summary Add
|
|
5898
|
+
* Add a BUS Inputs/Outputs Service to the cell.
|
|
5899
|
+
* @summary Add Service
|
|
4645
5900
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
4646
|
-
* @param {
|
|
5901
|
+
* @param {BusIOType} busIOType
|
|
4647
5902
|
* @param {number} [completionTimeout]
|
|
4648
5903
|
* @param {*} [options] Override http request option.
|
|
4649
5904
|
* @throws {RequiredError}
|
|
5905
|
+
* @memberof BUSInputsOutputsApi
|
|
4650
5906
|
*/
|
|
4651
|
-
|
|
5907
|
+
addBusIOService(cell: string, busIOType: BusIOType, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
4652
5908
|
/**
|
|
4653
|
-
*
|
|
4654
|
-
* @summary
|
|
5909
|
+
* Adds an input/output to or updates an input/output on the PROFINET device.
|
|
5910
|
+
* @summary Add PROFINET Input/Output
|
|
4655
5911
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
4656
|
-
* @param {
|
|
5912
|
+
* @param {string} io Unique identifier to address an Input/Output in the cell.
|
|
5913
|
+
* @param {ProfinetIOData} profinetIOData
|
|
4657
5914
|
* @param {*} [options] Override http request option.
|
|
4658
5915
|
* @throws {RequiredError}
|
|
5916
|
+
* @memberof BUSInputsOutputsApi
|
|
4659
5917
|
*/
|
|
4660
|
-
|
|
5918
|
+
addProfinetIO(cell: string, io: string, profinetIOData: ProfinetIOData, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
4661
5919
|
/**
|
|
4662
|
-
* Delete
|
|
4663
|
-
* @summary
|
|
5920
|
+
* Delete BUS Inputs/Outputs Service from the cell.
|
|
5921
|
+
* @summary Clear Service
|
|
4664
5922
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
4665
|
-
* @param {string} app
|
|
4666
5923
|
* @param {number} [completionTimeout]
|
|
4667
5924
|
* @param {*} [options] Override http request option.
|
|
4668
5925
|
* @throws {RequiredError}
|
|
5926
|
+
* @memberof BUSInputsOutputsApi
|
|
4669
5927
|
*/
|
|
4670
|
-
|
|
5928
|
+
clearBusIOService(cell: string, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
4671
5929
|
/**
|
|
4672
|
-
*
|
|
4673
|
-
* @summary
|
|
5930
|
+
* Removes the input/output from the PROFINET device.
|
|
5931
|
+
* @summary Remove PROFINET Input/Ouptut
|
|
4674
5932
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
4675
|
-
* @param {string}
|
|
5933
|
+
* @param {string} io Unique identifier to address an Input/Output in the cell.
|
|
4676
5934
|
* @param {*} [options] Override http request option.
|
|
4677
5935
|
* @throws {RequiredError}
|
|
5936
|
+
* @memberof BUSInputsOutputsApi
|
|
4678
5937
|
*/
|
|
4679
|
-
|
|
5938
|
+
deleteProfinetIO(cell: string, io: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
4680
5939
|
/**
|
|
4681
|
-
*
|
|
4682
|
-
* @summary
|
|
5940
|
+
* Get deployed BUS Inputs/Outputs Service.
|
|
5941
|
+
* @summary Get Service
|
|
4683
5942
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
4684
5943
|
* @param {*} [options] Override http request option.
|
|
4685
5944
|
* @throws {RequiredError}
|
|
5945
|
+
* @memberof BUSInputsOutputsApi
|
|
4686
5946
|
*/
|
|
4687
|
-
|
|
5947
|
+
getBusIOService(cell: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<{
|
|
5948
|
+
bus_type: "profinet";
|
|
5949
|
+
} & BusIOProfinet, any>>;
|
|
4688
5950
|
/**
|
|
4689
|
-
*
|
|
4690
|
-
* @summary
|
|
5951
|
+
* Get the current state of the BUS Inputs/Outputs service.
|
|
5952
|
+
* @summary State
|
|
4691
5953
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
4692
|
-
* @param {string} app
|
|
4693
|
-
* @param {App} app2
|
|
4694
|
-
* @param {number} [completionTimeout]
|
|
4695
5954
|
* @param {*} [options] Override http request option.
|
|
4696
5955
|
* @throws {RequiredError}
|
|
5956
|
+
* @memberof BUSInputsOutputsApi
|
|
4697
5957
|
*/
|
|
4698
|
-
|
|
4699
|
-
};
|
|
4700
|
-
/**
|
|
4701
|
-
* ApplicationApi - object-oriented interface
|
|
4702
|
-
* @export
|
|
4703
|
-
* @class ApplicationApi
|
|
4704
|
-
* @extends {BaseAPI}
|
|
4705
|
-
*/
|
|
4706
|
-
export declare class ApplicationApi extends BaseAPI {
|
|
5958
|
+
getBusIOState(cell: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<BusIOsState, any>>;
|
|
4707
5959
|
/**
|
|
4708
|
-
*
|
|
4709
|
-
* @summary
|
|
5960
|
+
* 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).
|
|
5961
|
+
* @summary Get Input/Output Values
|
|
4710
5962
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
4711
|
-
* @param {
|
|
4712
|
-
* @param {number} [completionTimeout]
|
|
5963
|
+
* @param {Array<string>} [ios]
|
|
4713
5964
|
* @param {*} [options] Override http request option.
|
|
4714
5965
|
* @throws {RequiredError}
|
|
4715
|
-
* @memberof
|
|
5966
|
+
* @memberof BUSInputsOutputsApi
|
|
4716
5967
|
*/
|
|
4717
|
-
|
|
5968
|
+
getBusIOValues(cell: string, ios?: Array<string>, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<IOValue[], any>>;
|
|
4718
5969
|
/**
|
|
4719
|
-
*
|
|
4720
|
-
* @summary
|
|
5970
|
+
* Get description of PROFINET
|
|
5971
|
+
* @summary Get PROFINET Description
|
|
4721
5972
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
4722
|
-
* @param {number} [completionTimeout]
|
|
4723
5973
|
* @param {*} [options] Override http request option.
|
|
4724
5974
|
* @throws {RequiredError}
|
|
4725
|
-
* @memberof
|
|
5975
|
+
* @memberof BUSInputsOutputsApi
|
|
4726
5976
|
*/
|
|
4727
|
-
|
|
5977
|
+
getProfinetDescription(cell: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ProfinetDescription, any>>;
|
|
4728
5978
|
/**
|
|
4729
|
-
*
|
|
4730
|
-
* @summary
|
|
5979
|
+
* Get input/output configuration of the PROFINET device as file.
|
|
5980
|
+
* @summary PROFINET Inputs/Outputs to File
|
|
4731
5981
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
4732
|
-
* @param {
|
|
4733
|
-
* @param {number} [
|
|
5982
|
+
* @param {number} [inputOffset]
|
|
5983
|
+
* @param {number} [outputOffset]
|
|
4734
5984
|
* @param {*} [options] Override http request option.
|
|
4735
5985
|
* @throws {RequiredError}
|
|
4736
|
-
* @memberof
|
|
5986
|
+
* @memberof BUSInputsOutputsApi
|
|
4737
5987
|
*/
|
|
4738
|
-
|
|
5988
|
+
getProfinetIOsFromFile(cell: string, inputOffset?: number, outputOffset?: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<string, any>>;
|
|
4739
5989
|
/**
|
|
4740
|
-
*
|
|
4741
|
-
* @summary
|
|
5990
|
+
* List all BUS Input/Output descriptions.
|
|
5991
|
+
* @summary List Descriptions
|
|
4742
5992
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
4743
|
-
* @param {string} app
|
|
4744
5993
|
* @param {*} [options] Override http request option.
|
|
4745
5994
|
* @throws {RequiredError}
|
|
4746
|
-
* @memberof
|
|
5995
|
+
* @memberof BUSInputsOutputsApi
|
|
4747
5996
|
*/
|
|
4748
|
-
|
|
5997
|
+
listBusIODescriptions(cell: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<IODescription[], any>>;
|
|
4749
5998
|
/**
|
|
4750
|
-
* List all
|
|
4751
|
-
* @summary List
|
|
5999
|
+
* List all PROFINET input and outputs.
|
|
6000
|
+
* @summary List PROFINET Input/Output Configuration
|
|
4752
6001
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
4753
6002
|
* @param {*} [options] Override http request option.
|
|
4754
6003
|
* @throws {RequiredError}
|
|
4755
|
-
* @memberof
|
|
6004
|
+
* @memberof BUSInputsOutputsApi
|
|
4756
6005
|
*/
|
|
4757
|
-
|
|
6006
|
+
listProfinetIOs(cell: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ProfinetIO[], any>>;
|
|
4758
6007
|
/**
|
|
4759
|
-
*
|
|
4760
|
-
* @summary
|
|
6008
|
+
* 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.
|
|
6009
|
+
* @summary Set Output Values
|
|
4761
6010
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
4762
|
-
* @param {
|
|
4763
|
-
* @param {App} app2
|
|
4764
|
-
* @param {number} [completionTimeout]
|
|
6011
|
+
* @param {Array<IOValue>} iOValue
|
|
4765
6012
|
* @param {*} [options] Override http request option.
|
|
4766
6013
|
* @throws {RequiredError}
|
|
4767
|
-
* @memberof
|
|
6014
|
+
* @memberof BUSInputsOutputsApi
|
|
4768
6015
|
*/
|
|
4769
|
-
|
|
6016
|
+
setBusIOValues(cell: string, iOValue: Array<IOValue>, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
6017
|
+
/**
|
|
6018
|
+
* Sets inputs/outputs on the PROFINET device from file.
|
|
6019
|
+
* @summary Set PROFINET Inputs/Outputs from File
|
|
6020
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
6021
|
+
* @param {ProfinetInputOutputConfig} profinetInputOutputConfig
|
|
6022
|
+
* @param {*} [options] Override http request option.
|
|
6023
|
+
* @throws {RequiredError}
|
|
6024
|
+
* @memberof BUSInputsOutputsApi
|
|
6025
|
+
*/
|
|
6026
|
+
setProfinetIOsFromFile(cell: string, profinetInputOutputConfig: ProfinetInputOutputConfig, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
4770
6027
|
}
|
|
4771
6028
|
/**
|
|
4772
6029
|
* CellApi - axios parameter creator
|
|
@@ -5075,6 +6332,15 @@ export declare const ControllerApiAxiosParamCreator: (configuration?: Configurat
|
|
|
5075
6332
|
* @throws {RequiredError}
|
|
5076
6333
|
*/
|
|
5077
6334
|
deleteRobotController: (cell: string, controller: string, completionTimeout?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
6335
|
+
/**
|
|
6336
|
+
* Get description of a configured robot controller including a list of connected motion group identifiers. Use [getMotionGroupDescription](getMotionGroupDescription) to get more information about the motion group.
|
|
6337
|
+
* @summary Description
|
|
6338
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
6339
|
+
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
6340
|
+
* @param {*} [options] Override http request option.
|
|
6341
|
+
* @throws {RequiredError}
|
|
6342
|
+
*/
|
|
6343
|
+
getControllerDescription: (cell: string, controller: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
5078
6344
|
/**
|
|
5079
6345
|
* Request a coordinate system specification for a given identifier. Use parameter orientation_type to get the orientation part of the transformation offset of the coordinate system returned in the requested orientation notation. If parameter orientation_type is not set, the orientation part of the transformation offset of the coordinate system is returned in rotation vector notation. The coordinate systems from the robot controller are loaded when the motion group associated with the coordinate system is activated. With deactivation of the motion group, the associated coordinate systems are removed from NOVA. The unique identifier of the coordinate systems from the robot controllers are suffixed with \"On\" + the unique identifier of the robot controller.
|
|
5080
6346
|
* @summary Coordinate System
|
|
@@ -5095,15 +6361,6 @@ export declare const ControllerApiAxiosParamCreator: (configuration?: Configurat
|
|
|
5095
6361
|
* @throws {RequiredError}
|
|
5096
6362
|
*/
|
|
5097
6363
|
getCurrentRobotControllerState: (cell: string, controller: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
5098
|
-
/**
|
|
5099
|
-
* 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).
|
|
5100
|
-
* @summary Current Mode
|
|
5101
|
-
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5102
|
-
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
5103
|
-
* @param {*} [options] Override http request option.
|
|
5104
|
-
* @throws {RequiredError}
|
|
5105
|
-
*/
|
|
5106
|
-
getMode: (cell: string, controller: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
5107
6364
|
/**
|
|
5108
6365
|
* Get the configuration for a robot controller.
|
|
5109
6366
|
* @summary Robot Controller
|
|
@@ -5114,14 +6371,14 @@ export declare const ControllerApiAxiosParamCreator: (configuration?: Configurat
|
|
|
5114
6371
|
*/
|
|
5115
6372
|
getRobotController: (cell: string, controller: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
5116
6373
|
/**
|
|
5117
|
-
* Receive
|
|
5118
|
-
* @summary Virtual
|
|
6374
|
+
* Receive data to configure a virtual robot controller based on another controller. This can be used to create a virtual clone of a specific physical robot. When adding a virtual controller, use the Virtual configuration variant of [addRobotController](addRobotController) and pass the content string from this endpoint as the `json` field. Omit the `type` field that selects a preset configuration which is not required when providing a complete configuration. > **NOTE** > > The output generated by this endpoint can be too large for the site to handle, and may produce an error or incorrect output. > Use `curl` in combination with `> output.json` to capture the output, or use an API client like Postman.
|
|
6375
|
+
* @summary Virtual Controller Configuration
|
|
5119
6376
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5120
6377
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
5121
6378
|
* @param {*} [options] Override http request option.
|
|
5122
6379
|
* @throws {RequiredError}
|
|
5123
6380
|
*/
|
|
5124
|
-
|
|
6381
|
+
getVirtualControllerConfiguration: (cell: string, controller: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
5125
6382
|
/**
|
|
5126
6383
|
* Lists all specifications of coordinate systems from robot controllers. Use parameter orientation_type to get the orientation part of the transformation offset of the coordinate system returned in the requested orientation notation. If parameter orientation_type is not set, the orientation part of the transformation offset of the coordinate system is returned in rotation vector notation. The coordinate systems from the robot controller are loaded when the motion group associated with the coordinate system is activated. With deactivation of the motion group, the associated coordinate systems are removed from NOVA. The unique identifier of the coordinate systems from the robot controllers are suffixed with \"On\" + the unique identifier of the robot controller.
|
|
5127
6384
|
* @summary List Coordinate Systems
|
|
@@ -5161,15 +6418,16 @@ export declare const ControllerApiAxiosParamCreator: (configuration?: Configurat
|
|
|
5161
6418
|
*/
|
|
5162
6419
|
streamFreeDrive: (cell: string, controller: string, responseRate?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
5163
6420
|
/**
|
|
5164
|
-
* <!-- theme: danger --> > Websocket endpoint Receive updates of the state of a robot controller.
|
|
6421
|
+
* <!-- 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.
|
|
5165
6422
|
* @summary Stream State
|
|
5166
6423
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5167
6424
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
5168
6425
|
* @param {number} [responseRate]
|
|
6426
|
+
* @param {number} [addControllerTimeout]
|
|
5169
6427
|
* @param {*} [options] Override http request option.
|
|
5170
6428
|
* @throws {RequiredError}
|
|
5171
6429
|
*/
|
|
5172
|
-
streamRobotControllerState: (cell: string, controller: string, responseRate?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
6430
|
+
streamRobotControllerState: (cell: string, controller: string, responseRate?: number, addControllerTimeout?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
5173
6431
|
/**
|
|
5174
6432
|
* 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.
|
|
5175
6433
|
* @summary Update Robot Controller
|
|
@@ -5216,6 +6474,15 @@ export declare const ControllerApiFp: (configuration?: Configuration) => {
|
|
|
5216
6474
|
* @throws {RequiredError}
|
|
5217
6475
|
*/
|
|
5218
6476
|
deleteRobotController(cell: string, controller: string, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
6477
|
+
/**
|
|
6478
|
+
* Get description of a configured robot controller including a list of connected motion group identifiers. Use [getMotionGroupDescription](getMotionGroupDescription) to get more information about the motion group.
|
|
6479
|
+
* @summary Description
|
|
6480
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
6481
|
+
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
6482
|
+
* @param {*} [options] Override http request option.
|
|
6483
|
+
* @throws {RequiredError}
|
|
6484
|
+
*/
|
|
6485
|
+
getControllerDescription(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ControllerDescription>>;
|
|
5219
6486
|
/**
|
|
5220
6487
|
* Request a coordinate system specification for a given identifier. Use parameter orientation_type to get the orientation part of the transformation offset of the coordinate system returned in the requested orientation notation. If parameter orientation_type is not set, the orientation part of the transformation offset of the coordinate system is returned in rotation vector notation. The coordinate systems from the robot controller are loaded when the motion group associated with the coordinate system is activated. With deactivation of the motion group, the associated coordinate systems are removed from NOVA. The unique identifier of the coordinate systems from the robot controllers are suffixed with \"On\" + the unique identifier of the robot controller.
|
|
5221
6488
|
* @summary Coordinate System
|
|
@@ -5236,15 +6503,6 @@ export declare const ControllerApiFp: (configuration?: Configuration) => {
|
|
|
5236
6503
|
* @throws {RequiredError}
|
|
5237
6504
|
*/
|
|
5238
6505
|
getCurrentRobotControllerState(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<RobotControllerState>>;
|
|
5239
|
-
/**
|
|
5240
|
-
* 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).
|
|
5241
|
-
* @summary Current Mode
|
|
5242
|
-
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5243
|
-
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
5244
|
-
* @param {*} [options] Override http request option.
|
|
5245
|
-
* @throws {RequiredError}
|
|
5246
|
-
*/
|
|
5247
|
-
getMode(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetModeResponse>>;
|
|
5248
6506
|
/**
|
|
5249
6507
|
* Get the configuration for a robot controller.
|
|
5250
6508
|
* @summary Robot Controller
|
|
@@ -5255,14 +6513,14 @@ export declare const ControllerApiFp: (configuration?: Configuration) => {
|
|
|
5255
6513
|
*/
|
|
5256
6514
|
getRobotController(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<RobotController>>;
|
|
5257
6515
|
/**
|
|
5258
|
-
* Receive
|
|
5259
|
-
* @summary Virtual
|
|
6516
|
+
* Receive data to configure a virtual robot controller based on another controller. This can be used to create a virtual clone of a specific physical robot. When adding a virtual controller, use the Virtual configuration variant of [addRobotController](addRobotController) and pass the content string from this endpoint as the `json` field. Omit the `type` field that selects a preset configuration which is not required when providing a complete configuration. > **NOTE** > > The output generated by this endpoint can be too large for the site to handle, and may produce an error or incorrect output. > Use `curl` in combination with `> output.json` to capture the output, or use an API client like Postman.
|
|
6517
|
+
* @summary Virtual Controller Configuration
|
|
5260
6518
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5261
6519
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
5262
6520
|
* @param {*} [options] Override http request option.
|
|
5263
6521
|
* @throws {RequiredError}
|
|
5264
6522
|
*/
|
|
5265
|
-
|
|
6523
|
+
getVirtualControllerConfiguration(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<VirtualRobotConfiguration>>;
|
|
5266
6524
|
/**
|
|
5267
6525
|
* Lists all specifications of coordinate systems from robot controllers. Use parameter orientation_type to get the orientation part of the transformation offset of the coordinate system returned in the requested orientation notation. If parameter orientation_type is not set, the orientation part of the transformation offset of the coordinate system is returned in rotation vector notation. The coordinate systems from the robot controller are loaded when the motion group associated with the coordinate system is activated. With deactivation of the motion group, the associated coordinate systems are removed from NOVA. The unique identifier of the coordinate systems from the robot controllers are suffixed with \"On\" + the unique identifier of the robot controller.
|
|
5268
6526
|
* @summary List Coordinate Systems
|
|
@@ -5302,15 +6560,16 @@ export declare const ControllerApiFp: (configuration?: Configuration) => {
|
|
|
5302
6560
|
*/
|
|
5303
6561
|
streamFreeDrive(cell: string, controller: string, responseRate?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<RobotControllerState>>;
|
|
5304
6562
|
/**
|
|
5305
|
-
* <!-- theme: danger --> > Websocket endpoint Receive updates of the state of a robot controller.
|
|
6563
|
+
* <!-- 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.
|
|
5306
6564
|
* @summary Stream State
|
|
5307
6565
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5308
6566
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
5309
6567
|
* @param {number} [responseRate]
|
|
6568
|
+
* @param {number} [addControllerTimeout]
|
|
5310
6569
|
* @param {*} [options] Override http request option.
|
|
5311
6570
|
* @throws {RequiredError}
|
|
5312
6571
|
*/
|
|
5313
|
-
streamRobotControllerState(cell: string, controller: string, responseRate?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<RobotControllerState>>;
|
|
6572
|
+
streamRobotControllerState(cell: string, controller: string, responseRate?: number, addControllerTimeout?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<RobotControllerState>>;
|
|
5314
6573
|
/**
|
|
5315
6574
|
* 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.
|
|
5316
6575
|
* @summary Update Robot Controller
|
|
@@ -5357,6 +6616,15 @@ export declare const ControllerApiFactory: (configuration?: Configuration, baseP
|
|
|
5357
6616
|
* @throws {RequiredError}
|
|
5358
6617
|
*/
|
|
5359
6618
|
deleteRobotController(cell: string, controller: string, completionTimeout?: number, options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
6619
|
+
/**
|
|
6620
|
+
* Get description of a configured robot controller including a list of connected motion group identifiers. Use [getMotionGroupDescription](getMotionGroupDescription) to get more information about the motion group.
|
|
6621
|
+
* @summary Description
|
|
6622
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
6623
|
+
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
6624
|
+
* @param {*} [options] Override http request option.
|
|
6625
|
+
* @throws {RequiredError}
|
|
6626
|
+
*/
|
|
6627
|
+
getControllerDescription(cell: string, controller: string, options?: RawAxiosRequestConfig): AxiosPromise<ControllerDescription>;
|
|
5360
6628
|
/**
|
|
5361
6629
|
* Request a coordinate system specification for a given identifier. Use parameter orientation_type to get the orientation part of the transformation offset of the coordinate system returned in the requested orientation notation. If parameter orientation_type is not set, the orientation part of the transformation offset of the coordinate system is returned in rotation vector notation. The coordinate systems from the robot controller are loaded when the motion group associated with the coordinate system is activated. With deactivation of the motion group, the associated coordinate systems are removed from NOVA. The unique identifier of the coordinate systems from the robot controllers are suffixed with \"On\" + the unique identifier of the robot controller.
|
|
5362
6630
|
* @summary Coordinate System
|
|
@@ -5377,15 +6645,6 @@ export declare const ControllerApiFactory: (configuration?: Configuration, baseP
|
|
|
5377
6645
|
* @throws {RequiredError}
|
|
5378
6646
|
*/
|
|
5379
6647
|
getCurrentRobotControllerState(cell: string, controller: string, options?: RawAxiosRequestConfig): AxiosPromise<RobotControllerState>;
|
|
5380
|
-
/**
|
|
5381
|
-
* 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).
|
|
5382
|
-
* @summary Current Mode
|
|
5383
|
-
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5384
|
-
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
5385
|
-
* @param {*} [options] Override http request option.
|
|
5386
|
-
* @throws {RequiredError}
|
|
5387
|
-
*/
|
|
5388
|
-
getMode(cell: string, controller: string, options?: RawAxiosRequestConfig): AxiosPromise<GetModeResponse>;
|
|
5389
6648
|
/**
|
|
5390
6649
|
* Get the configuration for a robot controller.
|
|
5391
6650
|
* @summary Robot Controller
|
|
@@ -5396,14 +6655,14 @@ export declare const ControllerApiFactory: (configuration?: Configuration, baseP
|
|
|
5396
6655
|
*/
|
|
5397
6656
|
getRobotController(cell: string, controller: string, options?: RawAxiosRequestConfig): AxiosPromise<RobotController>;
|
|
5398
6657
|
/**
|
|
5399
|
-
* Receive
|
|
5400
|
-
* @summary Virtual
|
|
6658
|
+
* Receive data to configure a virtual robot controller based on another controller. This can be used to create a virtual clone of a specific physical robot. When adding a virtual controller, use the Virtual configuration variant of [addRobotController](addRobotController) and pass the content string from this endpoint as the `json` field. Omit the `type` field that selects a preset configuration which is not required when providing a complete configuration. > **NOTE** > > The output generated by this endpoint can be too large for the site to handle, and may produce an error or incorrect output. > Use `curl` in combination with `> output.json` to capture the output, or use an API client like Postman.
|
|
6659
|
+
* @summary Virtual Controller Configuration
|
|
5401
6660
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5402
6661
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
5403
6662
|
* @param {*} [options] Override http request option.
|
|
5404
6663
|
* @throws {RequiredError}
|
|
5405
6664
|
*/
|
|
5406
|
-
|
|
6665
|
+
getVirtualControllerConfiguration(cell: string, controller: string, options?: RawAxiosRequestConfig): AxiosPromise<VirtualRobotConfiguration>;
|
|
5407
6666
|
/**
|
|
5408
6667
|
* Lists all specifications of coordinate systems from robot controllers. Use parameter orientation_type to get the orientation part of the transformation offset of the coordinate system returned in the requested orientation notation. If parameter orientation_type is not set, the orientation part of the transformation offset of the coordinate system is returned in rotation vector notation. The coordinate systems from the robot controller are loaded when the motion group associated with the coordinate system is activated. With deactivation of the motion group, the associated coordinate systems are removed from NOVA. The unique identifier of the coordinate systems from the robot controllers are suffixed with \"On\" + the unique identifier of the robot controller.
|
|
5409
6668
|
* @summary List Coordinate Systems
|
|
@@ -5443,15 +6702,16 @@ export declare const ControllerApiFactory: (configuration?: Configuration, baseP
|
|
|
5443
6702
|
*/
|
|
5444
6703
|
streamFreeDrive(cell: string, controller: string, responseRate?: number, options?: RawAxiosRequestConfig): AxiosPromise<RobotControllerState>;
|
|
5445
6704
|
/**
|
|
5446
|
-
* <!-- theme: danger --> > Websocket endpoint Receive updates of the state of a robot controller.
|
|
6705
|
+
* <!-- 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.
|
|
5447
6706
|
* @summary Stream State
|
|
5448
6707
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5449
6708
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
5450
6709
|
* @param {number} [responseRate]
|
|
6710
|
+
* @param {number} [addControllerTimeout]
|
|
5451
6711
|
* @param {*} [options] Override http request option.
|
|
5452
6712
|
* @throws {RequiredError}
|
|
5453
6713
|
*/
|
|
5454
|
-
streamRobotControllerState(cell: string, controller: string, responseRate?: number, options?: RawAxiosRequestConfig): AxiosPromise<RobotControllerState>;
|
|
6714
|
+
streamRobotControllerState(cell: string, controller: string, responseRate?: number, addControllerTimeout?: number, options?: RawAxiosRequestConfig): AxiosPromise<RobotControllerState>;
|
|
5455
6715
|
/**
|
|
5456
6716
|
* 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.
|
|
5457
6717
|
* @summary Update Robot Controller
|
|
@@ -5503,6 +6763,16 @@ export declare class ControllerApi extends BaseAPI {
|
|
|
5503
6763
|
* @memberof ControllerApi
|
|
5504
6764
|
*/
|
|
5505
6765
|
deleteRobotController(cell: string, controller: string, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
6766
|
+
/**
|
|
6767
|
+
* Get description of a configured robot controller including a list of connected motion group identifiers. Use [getMotionGroupDescription](getMotionGroupDescription) to get more information about the motion group.
|
|
6768
|
+
* @summary Description
|
|
6769
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
6770
|
+
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
6771
|
+
* @param {*} [options] Override http request option.
|
|
6772
|
+
* @throws {RequiredError}
|
|
6773
|
+
* @memberof ControllerApi
|
|
6774
|
+
*/
|
|
6775
|
+
getControllerDescription(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ControllerDescription, any>>;
|
|
5506
6776
|
/**
|
|
5507
6777
|
* Request a coordinate system specification for a given identifier. Use parameter orientation_type to get the orientation part of the transformation offset of the coordinate system returned in the requested orientation notation. If parameter orientation_type is not set, the orientation part of the transformation offset of the coordinate system is returned in rotation vector notation. The coordinate systems from the robot controller are loaded when the motion group associated with the coordinate system is activated. With deactivation of the motion group, the associated coordinate systems are removed from NOVA. The unique identifier of the coordinate systems from the robot controllers are suffixed with \"On\" + the unique identifier of the robot controller.
|
|
5508
6778
|
* @summary Coordinate System
|
|
@@ -5525,16 +6795,6 @@ export declare class ControllerApi extends BaseAPI {
|
|
|
5525
6795
|
* @memberof ControllerApi
|
|
5526
6796
|
*/
|
|
5527
6797
|
getCurrentRobotControllerState(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<RobotControllerState, any>>;
|
|
5528
|
-
/**
|
|
5529
|
-
* 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).
|
|
5530
|
-
* @summary Current Mode
|
|
5531
|
-
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5532
|
-
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
5533
|
-
* @param {*} [options] Override http request option.
|
|
5534
|
-
* @throws {RequiredError}
|
|
5535
|
-
* @memberof ControllerApi
|
|
5536
|
-
*/
|
|
5537
|
-
getMode(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetModeResponse, any>>;
|
|
5538
6798
|
/**
|
|
5539
6799
|
* Get the configuration for a robot controller.
|
|
5540
6800
|
* @summary Robot Controller
|
|
@@ -5546,15 +6806,15 @@ export declare class ControllerApi extends BaseAPI {
|
|
|
5546
6806
|
*/
|
|
5547
6807
|
getRobotController(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<RobotController, any>>;
|
|
5548
6808
|
/**
|
|
5549
|
-
* Receive
|
|
5550
|
-
* @summary Virtual
|
|
6809
|
+
* Receive data to configure a virtual robot controller based on another controller. This can be used to create a virtual clone of a specific physical robot. When adding a virtual controller, use the Virtual configuration variant of [addRobotController](addRobotController) and pass the content string from this endpoint as the `json` field. Omit the `type` field that selects a preset configuration which is not required when providing a complete configuration. > **NOTE** > > The output generated by this endpoint can be too large for the site to handle, and may produce an error or incorrect output. > Use `curl` in combination with `> output.json` to capture the output, or use an API client like Postman.
|
|
6810
|
+
* @summary Virtual Controller Configuration
|
|
5551
6811
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5552
6812
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
5553
6813
|
* @param {*} [options] Override http request option.
|
|
5554
6814
|
* @throws {RequiredError}
|
|
5555
6815
|
* @memberof ControllerApi
|
|
5556
6816
|
*/
|
|
5557
|
-
|
|
6817
|
+
getVirtualControllerConfiguration(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<VirtualRobotConfiguration, any>>;
|
|
5558
6818
|
/**
|
|
5559
6819
|
* Lists all specifications of coordinate systems from robot controllers. Use parameter orientation_type to get the orientation part of the transformation offset of the coordinate system returned in the requested orientation notation. If parameter orientation_type is not set, the orientation part of the transformation offset of the coordinate system is returned in rotation vector notation. The coordinate systems from the robot controller are loaded when the motion group associated with the coordinate system is activated. With deactivation of the motion group, the associated coordinate systems are removed from NOVA. The unique identifier of the coordinate systems from the robot controllers are suffixed with \"On\" + the unique identifier of the robot controller.
|
|
5560
6820
|
* @summary List Coordinate Systems
|
|
@@ -5598,16 +6858,17 @@ export declare class ControllerApi extends BaseAPI {
|
|
|
5598
6858
|
*/
|
|
5599
6859
|
streamFreeDrive(cell: string, controller: string, responseRate?: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<RobotControllerState, any>>;
|
|
5600
6860
|
/**
|
|
5601
|
-
* <!-- theme: danger --> > Websocket endpoint Receive updates of the state of a robot controller.
|
|
6861
|
+
* <!-- 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.
|
|
5602
6862
|
* @summary Stream State
|
|
5603
6863
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5604
6864
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
5605
6865
|
* @param {number} [responseRate]
|
|
6866
|
+
* @param {number} [addControllerTimeout]
|
|
5606
6867
|
* @param {*} [options] Override http request option.
|
|
5607
6868
|
* @throws {RequiredError}
|
|
5608
6869
|
* @memberof ControllerApi
|
|
5609
6870
|
*/
|
|
5610
|
-
streamRobotControllerState(cell: string, controller: string, responseRate?: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<RobotControllerState, any>>;
|
|
6871
|
+
streamRobotControllerState(cell: string, controller: string, responseRate?: number, addControllerTimeout?: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<RobotControllerState, any>>;
|
|
5611
6872
|
/**
|
|
5612
6873
|
* 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.
|
|
5613
6874
|
* @summary Update Robot Controller
|
|
@@ -5936,6 +7197,15 @@ export declare class JoggingApi extends BaseAPI {
|
|
|
5936
7197
|
* @export
|
|
5937
7198
|
*/
|
|
5938
7199
|
export declare const KinematicsApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
7200
|
+
/**
|
|
7201
|
+
* Returns the TCP poses for a list of given joint positions.
|
|
7202
|
+
* @summary Forward kinematics
|
|
7203
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
7204
|
+
* @param {ForwardKinematicsRequest} [forwardKinematicsRequest]
|
|
7205
|
+
* @param {*} [options] Override http request option.
|
|
7206
|
+
* @throws {RequiredError}
|
|
7207
|
+
*/
|
|
7208
|
+
forwardKinematics: (cell: string, forwardKinematicsRequest?: ForwardKinematicsRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
5939
7209
|
/**
|
|
5940
7210
|
* Returns the reachable joint positions for a list of given poses.
|
|
5941
7211
|
* @summary Inverse kinematics
|
|
@@ -5951,6 +7221,15 @@ export declare const KinematicsApiAxiosParamCreator: (configuration?: Configurat
|
|
|
5951
7221
|
* @export
|
|
5952
7222
|
*/
|
|
5953
7223
|
export declare const KinematicsApiFp: (configuration?: Configuration) => {
|
|
7224
|
+
/**
|
|
7225
|
+
* Returns the TCP poses for a list of given joint positions.
|
|
7226
|
+
* @summary Forward kinematics
|
|
7227
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
7228
|
+
* @param {ForwardKinematicsRequest} [forwardKinematicsRequest]
|
|
7229
|
+
* @param {*} [options] Override http request option.
|
|
7230
|
+
* @throws {RequiredError}
|
|
7231
|
+
*/
|
|
7232
|
+
forwardKinematics(cell: string, forwardKinematicsRequest?: ForwardKinematicsRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ForwardKinematicsResponse>>;
|
|
5954
7233
|
/**
|
|
5955
7234
|
* Returns the reachable joint positions for a list of given poses.
|
|
5956
7235
|
* @summary Inverse kinematics
|
|
@@ -5966,6 +7245,15 @@ export declare const KinematicsApiFp: (configuration?: Configuration) => {
|
|
|
5966
7245
|
* @export
|
|
5967
7246
|
*/
|
|
5968
7247
|
export declare const KinematicsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
7248
|
+
/**
|
|
7249
|
+
* Returns the TCP poses for a list of given joint positions.
|
|
7250
|
+
* @summary Forward kinematics
|
|
7251
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
7252
|
+
* @param {ForwardKinematicsRequest} [forwardKinematicsRequest]
|
|
7253
|
+
* @param {*} [options] Override http request option.
|
|
7254
|
+
* @throws {RequiredError}
|
|
7255
|
+
*/
|
|
7256
|
+
forwardKinematics(cell: string, forwardKinematicsRequest?: ForwardKinematicsRequest, options?: RawAxiosRequestConfig): AxiosPromise<ForwardKinematicsResponse>;
|
|
5969
7257
|
/**
|
|
5970
7258
|
* Returns the reachable joint positions for a list of given poses.
|
|
5971
7259
|
* @summary Inverse kinematics
|
|
@@ -5983,6 +7271,16 @@ export declare const KinematicsApiFactory: (configuration?: Configuration, baseP
|
|
|
5983
7271
|
* @extends {BaseAPI}
|
|
5984
7272
|
*/
|
|
5985
7273
|
export declare class KinematicsApi extends BaseAPI {
|
|
7274
|
+
/**
|
|
7275
|
+
* Returns the TCP poses for a list of given joint positions.
|
|
7276
|
+
* @summary Forward kinematics
|
|
7277
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
7278
|
+
* @param {ForwardKinematicsRequest} [forwardKinematicsRequest]
|
|
7279
|
+
* @param {*} [options] Override http request option.
|
|
7280
|
+
* @throws {RequiredError}
|
|
7281
|
+
* @memberof KinematicsApi
|
|
7282
|
+
*/
|
|
7283
|
+
forwardKinematics(cell: string, forwardKinematicsRequest?: ForwardKinematicsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ForwardKinematicsResponse, any>>;
|
|
5986
7284
|
/**
|
|
5987
7285
|
* Returns the reachable joint positions for a list of given poses.
|
|
5988
7286
|
* @summary Inverse kinematics
|
|
@@ -6944,184 +8242,184 @@ export declare class StoreCollisionComponentsApi extends BaseAPI {
|
|
|
6944
8242
|
}, any>>;
|
|
6945
8243
|
}
|
|
6946
8244
|
/**
|
|
6947
|
-
*
|
|
8245
|
+
* StoreCollisionSetupsApi - axios parameter creator
|
|
6948
8246
|
* @export
|
|
6949
8247
|
*/
|
|
6950
|
-
export declare const
|
|
8248
|
+
export declare const StoreCollisionSetupsApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
6951
8249
|
/**
|
|
6952
|
-
* Deletes the stored
|
|
6953
|
-
* @summary Delete
|
|
8250
|
+
* Deletes the stored collision setup. <!-- theme: danger --> > This will delete persistently stored data.
|
|
8251
|
+
* @summary Delete Collision Setup
|
|
6954
8252
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
6955
|
-
* @param {string}
|
|
8253
|
+
* @param {string} setup Identifier of the collision setup
|
|
6956
8254
|
* @param {*} [options] Override http request option.
|
|
6957
8255
|
* @throws {RequiredError}
|
|
6958
8256
|
*/
|
|
6959
|
-
|
|
8257
|
+
deleteStoredCollisionSetup: (cell: string, setup: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
6960
8258
|
/**
|
|
6961
|
-
* Returns the stored
|
|
6962
|
-
* @summary Get
|
|
8259
|
+
* Returns the stored collision setup.
|
|
8260
|
+
* @summary Get Collision Setup
|
|
6963
8261
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
6964
|
-
* @param {string}
|
|
8262
|
+
* @param {string} setup Identifier of the collision setup
|
|
6965
8263
|
* @param {*} [options] Override http request option.
|
|
6966
8264
|
* @throws {RequiredError}
|
|
6967
8265
|
*/
|
|
6968
|
-
|
|
8266
|
+
getStoredCollisionSetup: (cell: string, setup: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
6969
8267
|
/**
|
|
6970
|
-
* Returns a list of stored
|
|
6971
|
-
* @summary List
|
|
8268
|
+
* Returns a list of stored collision setups.
|
|
8269
|
+
* @summary List Collision Setups
|
|
6972
8270
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
6973
8271
|
* @param {*} [options] Override http request option.
|
|
6974
8272
|
* @throws {RequiredError}
|
|
6975
8273
|
*/
|
|
6976
|
-
|
|
8274
|
+
listStoredCollisionSetups: (cell: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
6977
8275
|
/**
|
|
6978
|
-
*
|
|
6979
|
-
* @summary Store
|
|
8276
|
+
* Stores collision setup. If the collision setup does not exist, it will be created. If the collision setup exists, it will be updated.
|
|
8277
|
+
* @summary Store Collision Setup
|
|
6980
8278
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
6981
|
-
* @param {string}
|
|
6982
|
-
* @param {
|
|
8279
|
+
* @param {string} setup Identifier of the collision setup
|
|
8280
|
+
* @param {CollisionSetup} collisionSetup
|
|
6983
8281
|
* @param {*} [options] Override http request option.
|
|
6984
8282
|
* @throws {RequiredError}
|
|
6985
8283
|
*/
|
|
6986
|
-
|
|
8284
|
+
storeCollisionSetup: (cell: string, setup: string, collisionSetup: CollisionSetup, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
6987
8285
|
};
|
|
6988
8286
|
/**
|
|
6989
|
-
*
|
|
8287
|
+
* StoreCollisionSetupsApi - functional programming interface
|
|
6990
8288
|
* @export
|
|
6991
8289
|
*/
|
|
6992
|
-
export declare const
|
|
8290
|
+
export declare const StoreCollisionSetupsApiFp: (configuration?: Configuration) => {
|
|
6993
8291
|
/**
|
|
6994
|
-
* Deletes the stored
|
|
6995
|
-
* @summary Delete
|
|
8292
|
+
* Deletes the stored collision setup. <!-- theme: danger --> > This will delete persistently stored data.
|
|
8293
|
+
* @summary Delete Collision Setup
|
|
6996
8294
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
6997
|
-
* @param {string}
|
|
8295
|
+
* @param {string} setup Identifier of the collision setup
|
|
6998
8296
|
* @param {*} [options] Override http request option.
|
|
6999
8297
|
* @throws {RequiredError}
|
|
7000
8298
|
*/
|
|
7001
|
-
|
|
8299
|
+
deleteStoredCollisionSetup(cell: string, setup: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
7002
8300
|
/**
|
|
7003
|
-
* Returns the stored
|
|
7004
|
-
* @summary Get
|
|
8301
|
+
* Returns the stored collision setup.
|
|
8302
|
+
* @summary Get Collision Setup
|
|
7005
8303
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
7006
|
-
* @param {string}
|
|
8304
|
+
* @param {string} setup Identifier of the collision setup
|
|
7007
8305
|
* @param {*} [options] Override http request option.
|
|
7008
8306
|
* @throws {RequiredError}
|
|
7009
8307
|
*/
|
|
7010
|
-
|
|
8308
|
+
getStoredCollisionSetup(cell: string, setup: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CollisionSetup>>;
|
|
7011
8309
|
/**
|
|
7012
|
-
* Returns a list of stored
|
|
7013
|
-
* @summary List
|
|
8310
|
+
* Returns a list of stored collision setups.
|
|
8311
|
+
* @summary List Collision Setups
|
|
7014
8312
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
7015
8313
|
* @param {*} [options] Override http request option.
|
|
7016
8314
|
* @throws {RequiredError}
|
|
7017
8315
|
*/
|
|
7018
|
-
|
|
7019
|
-
[key: string]:
|
|
8316
|
+
listStoredCollisionSetups(cell: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<{
|
|
8317
|
+
[key: string]: CollisionSetup;
|
|
7020
8318
|
}>>;
|
|
7021
8319
|
/**
|
|
7022
|
-
*
|
|
7023
|
-
* @summary Store
|
|
8320
|
+
* Stores collision setup. If the collision setup does not exist, it will be created. If the collision setup exists, it will be updated.
|
|
8321
|
+
* @summary Store Collision Setup
|
|
7024
8322
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
7025
|
-
* @param {string}
|
|
7026
|
-
* @param {
|
|
8323
|
+
* @param {string} setup Identifier of the collision setup
|
|
8324
|
+
* @param {CollisionSetup} collisionSetup
|
|
7027
8325
|
* @param {*} [options] Override http request option.
|
|
7028
8326
|
* @throws {RequiredError}
|
|
7029
8327
|
*/
|
|
7030
|
-
|
|
8328
|
+
storeCollisionSetup(cell: string, setup: string, collisionSetup: CollisionSetup, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CollisionSetup>>;
|
|
7031
8329
|
};
|
|
7032
8330
|
/**
|
|
7033
|
-
*
|
|
8331
|
+
* StoreCollisionSetupsApi - factory interface
|
|
7034
8332
|
* @export
|
|
7035
8333
|
*/
|
|
7036
|
-
export declare const
|
|
8334
|
+
export declare const StoreCollisionSetupsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
7037
8335
|
/**
|
|
7038
|
-
* Deletes the stored
|
|
7039
|
-
* @summary Delete
|
|
8336
|
+
* Deletes the stored collision setup. <!-- theme: danger --> > This will delete persistently stored data.
|
|
8337
|
+
* @summary Delete Collision Setup
|
|
7040
8338
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
7041
|
-
* @param {string}
|
|
8339
|
+
* @param {string} setup Identifier of the collision setup
|
|
7042
8340
|
* @param {*} [options] Override http request option.
|
|
7043
8341
|
* @throws {RequiredError}
|
|
7044
8342
|
*/
|
|
7045
|
-
|
|
8343
|
+
deleteStoredCollisionSetup(cell: string, setup: string, options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
7046
8344
|
/**
|
|
7047
|
-
* Returns the stored
|
|
7048
|
-
* @summary Get
|
|
8345
|
+
* Returns the stored collision setup.
|
|
8346
|
+
* @summary Get Collision Setup
|
|
7049
8347
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
7050
|
-
* @param {string}
|
|
8348
|
+
* @param {string} setup Identifier of the collision setup
|
|
7051
8349
|
* @param {*} [options] Override http request option.
|
|
7052
8350
|
* @throws {RequiredError}
|
|
7053
8351
|
*/
|
|
7054
|
-
|
|
8352
|
+
getStoredCollisionSetup(cell: string, setup: string, options?: RawAxiosRequestConfig): AxiosPromise<CollisionSetup>;
|
|
7055
8353
|
/**
|
|
7056
|
-
* Returns a list of stored
|
|
7057
|
-
* @summary List
|
|
8354
|
+
* Returns a list of stored collision setups.
|
|
8355
|
+
* @summary List Collision Setups
|
|
7058
8356
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
7059
8357
|
* @param {*} [options] Override http request option.
|
|
7060
8358
|
* @throws {RequiredError}
|
|
7061
8359
|
*/
|
|
7062
|
-
|
|
7063
|
-
[key: string]:
|
|
8360
|
+
listStoredCollisionSetups(cell: string, options?: RawAxiosRequestConfig): AxiosPromise<{
|
|
8361
|
+
[key: string]: CollisionSetup;
|
|
7064
8362
|
}>;
|
|
7065
8363
|
/**
|
|
7066
|
-
*
|
|
7067
|
-
* @summary Store
|
|
8364
|
+
* Stores collision setup. If the collision setup does not exist, it will be created. If the collision setup exists, it will be updated.
|
|
8365
|
+
* @summary Store Collision Setup
|
|
7068
8366
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
7069
|
-
* @param {string}
|
|
7070
|
-
* @param {
|
|
8367
|
+
* @param {string} setup Identifier of the collision setup
|
|
8368
|
+
* @param {CollisionSetup} collisionSetup
|
|
7071
8369
|
* @param {*} [options] Override http request option.
|
|
7072
8370
|
* @throws {RequiredError}
|
|
7073
8371
|
*/
|
|
7074
|
-
|
|
8372
|
+
storeCollisionSetup(cell: string, setup: string, collisionSetup: CollisionSetup, options?: RawAxiosRequestConfig): AxiosPromise<CollisionSetup>;
|
|
7075
8373
|
};
|
|
7076
8374
|
/**
|
|
7077
|
-
*
|
|
8375
|
+
* StoreCollisionSetupsApi - object-oriented interface
|
|
7078
8376
|
* @export
|
|
7079
|
-
* @class
|
|
8377
|
+
* @class StoreCollisionSetupsApi
|
|
7080
8378
|
* @extends {BaseAPI}
|
|
7081
8379
|
*/
|
|
7082
|
-
export declare class
|
|
8380
|
+
export declare class StoreCollisionSetupsApi extends BaseAPI {
|
|
7083
8381
|
/**
|
|
7084
|
-
* Deletes the stored
|
|
7085
|
-
* @summary Delete
|
|
8382
|
+
* Deletes the stored collision setup. <!-- theme: danger --> > This will delete persistently stored data.
|
|
8383
|
+
* @summary Delete Collision Setup
|
|
7086
8384
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
7087
|
-
* @param {string}
|
|
8385
|
+
* @param {string} setup Identifier of the collision setup
|
|
7088
8386
|
* @param {*} [options] Override http request option.
|
|
7089
8387
|
* @throws {RequiredError}
|
|
7090
|
-
* @memberof
|
|
8388
|
+
* @memberof StoreCollisionSetupsApi
|
|
7091
8389
|
*/
|
|
7092
|
-
|
|
8390
|
+
deleteStoredCollisionSetup(cell: string, setup: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
7093
8391
|
/**
|
|
7094
|
-
* Returns the stored
|
|
7095
|
-
* @summary Get
|
|
8392
|
+
* Returns the stored collision setup.
|
|
8393
|
+
* @summary Get Collision Setup
|
|
7096
8394
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
7097
|
-
* @param {string}
|
|
8395
|
+
* @param {string} setup Identifier of the collision setup
|
|
7098
8396
|
* @param {*} [options] Override http request option.
|
|
7099
8397
|
* @throws {RequiredError}
|
|
7100
|
-
* @memberof
|
|
8398
|
+
* @memberof StoreCollisionSetupsApi
|
|
7101
8399
|
*/
|
|
7102
|
-
|
|
8400
|
+
getStoredCollisionSetup(cell: string, setup: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CollisionSetup, any>>;
|
|
7103
8401
|
/**
|
|
7104
|
-
* Returns a list of stored
|
|
7105
|
-
* @summary List
|
|
8402
|
+
* Returns a list of stored collision setups.
|
|
8403
|
+
* @summary List Collision Setups
|
|
7106
8404
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
7107
8405
|
* @param {*} [options] Override http request option.
|
|
7108
8406
|
* @throws {RequiredError}
|
|
7109
|
-
* @memberof
|
|
8407
|
+
* @memberof StoreCollisionSetupsApi
|
|
7110
8408
|
*/
|
|
7111
|
-
|
|
7112
|
-
[key: string]:
|
|
8409
|
+
listStoredCollisionSetups(cell: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<{
|
|
8410
|
+
[key: string]: CollisionSetup;
|
|
7113
8411
|
}, any>>;
|
|
7114
8412
|
/**
|
|
7115
|
-
*
|
|
7116
|
-
* @summary Store
|
|
8413
|
+
* Stores collision setup. If the collision setup does not exist, it will be created. If the collision setup exists, it will be updated.
|
|
8414
|
+
* @summary Store Collision Setup
|
|
7117
8415
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
7118
|
-
* @param {string}
|
|
7119
|
-
* @param {
|
|
8416
|
+
* @param {string} setup Identifier of the collision setup
|
|
8417
|
+
* @param {CollisionSetup} collisionSetup
|
|
7120
8418
|
* @param {*} [options] Override http request option.
|
|
7121
8419
|
* @throws {RequiredError}
|
|
7122
|
-
* @memberof
|
|
8420
|
+
* @memberof StoreCollisionSetupsApi
|
|
7123
8421
|
*/
|
|
7124
|
-
|
|
8422
|
+
storeCollisionSetup(cell: string, setup: string, collisionSetup: CollisionSetup, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CollisionSetup, any>>;
|
|
7125
8423
|
}
|
|
7126
8424
|
/**
|
|
7127
8425
|
* StoreObjectApi - axios parameter creator
|
|
@@ -7997,6 +9295,15 @@ export declare class TrajectoryExecutionApi extends BaseAPI {
|
|
|
7997
9295
|
* @export
|
|
7998
9296
|
*/
|
|
7999
9297
|
export declare const TrajectoryPlanningApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
9298
|
+
/**
|
|
9299
|
+
* 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.
|
|
9300
|
+
* @summary Plan Collision-Free Trajectory
|
|
9301
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
9302
|
+
* @param {PlanCollisionFreeRequest} [planCollisionFreeRequest]
|
|
9303
|
+
* @param {*} [options] Override http request option.
|
|
9304
|
+
* @throws {RequiredError}
|
|
9305
|
+
*/
|
|
9306
|
+
planCollisionFree: (cell: string, planCollisionFreeRequest?: PlanCollisionFreeRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
8000
9307
|
/**
|
|
8001
9308
|
* 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.
|
|
8002
9309
|
* @summary Plan Trajectory
|
|
@@ -8012,6 +9319,15 @@ export declare const TrajectoryPlanningApiAxiosParamCreator: (configuration?: Co
|
|
|
8012
9319
|
* @export
|
|
8013
9320
|
*/
|
|
8014
9321
|
export declare const TrajectoryPlanningApiFp: (configuration?: Configuration) => {
|
|
9322
|
+
/**
|
|
9323
|
+
* 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.
|
|
9324
|
+
* @summary Plan Collision-Free Trajectory
|
|
9325
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
9326
|
+
* @param {PlanCollisionFreeRequest} [planCollisionFreeRequest]
|
|
9327
|
+
* @param {*} [options] Override http request option.
|
|
9328
|
+
* @throws {RequiredError}
|
|
9329
|
+
*/
|
|
9330
|
+
planCollisionFree(cell: string, planCollisionFreeRequest?: PlanCollisionFreeRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PlanCollisionFreeResponse>>;
|
|
8015
9331
|
/**
|
|
8016
9332
|
* 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.
|
|
8017
9333
|
* @summary Plan Trajectory
|
|
@@ -8027,6 +9343,15 @@ export declare const TrajectoryPlanningApiFp: (configuration?: Configuration) =>
|
|
|
8027
9343
|
* @export
|
|
8028
9344
|
*/
|
|
8029
9345
|
export declare const TrajectoryPlanningApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
9346
|
+
/**
|
|
9347
|
+
* 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.
|
|
9348
|
+
* @summary Plan Collision-Free Trajectory
|
|
9349
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
9350
|
+
* @param {PlanCollisionFreeRequest} [planCollisionFreeRequest]
|
|
9351
|
+
* @param {*} [options] Override http request option.
|
|
9352
|
+
* @throws {RequiredError}
|
|
9353
|
+
*/
|
|
9354
|
+
planCollisionFree(cell: string, planCollisionFreeRequest?: PlanCollisionFreeRequest, options?: RawAxiosRequestConfig): AxiosPromise<PlanCollisionFreeResponse>;
|
|
8030
9355
|
/**
|
|
8031
9356
|
* 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.
|
|
8032
9357
|
* @summary Plan Trajectory
|
|
@@ -8044,6 +9369,16 @@ export declare const TrajectoryPlanningApiFactory: (configuration?: Configuratio
|
|
|
8044
9369
|
* @extends {BaseAPI}
|
|
8045
9370
|
*/
|
|
8046
9371
|
export declare class TrajectoryPlanningApi extends BaseAPI {
|
|
9372
|
+
/**
|
|
9373
|
+
* 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.
|
|
9374
|
+
* @summary Plan Collision-Free Trajectory
|
|
9375
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
9376
|
+
* @param {PlanCollisionFreeRequest} [planCollisionFreeRequest]
|
|
9377
|
+
* @param {*} [options] Override http request option.
|
|
9378
|
+
* @throws {RequiredError}
|
|
9379
|
+
* @memberof TrajectoryPlanningApi
|
|
9380
|
+
*/
|
|
9381
|
+
planCollisionFree(cell: string, planCollisionFreeRequest?: PlanCollisionFreeRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<PlanCollisionFreeResponse, any>>;
|
|
8047
9382
|
/**
|
|
8048
9383
|
* 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.
|
|
8049
9384
|
* @summary Plan Trajectory
|
|
@@ -8070,7 +9405,7 @@ export declare const VirtualControllerApiAxiosParamCreator: (configuration?: Con
|
|
|
8070
9405
|
* @param {*} [options] Override http request option.
|
|
8071
9406
|
* @throws {RequiredError}
|
|
8072
9407
|
*/
|
|
8073
|
-
|
|
9408
|
+
addVirtualControllerCoordinateSystem: (cell: string, controller: string, coordinateSystem: string, coordinateSystemData: CoordinateSystemData, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
8074
9409
|
/**
|
|
8075
9410
|
* Adds a new TCP or updates an existing TCP in the motion group. The position and rotation values in the request body are defined within the flange’s coordinate system. > **NOTE** > > Ensure the TCP\'s position is within the robot\'s reach. Refer to the robot’s documentation or data sheet for details like joint limits or reach.
|
|
8076
9411
|
* @summary Add TCP
|
|
@@ -8082,7 +9417,7 @@ export declare const VirtualControllerApiAxiosParamCreator: (configuration?: Con
|
|
|
8082
9417
|
* @param {*} [options] Override http request option.
|
|
8083
9418
|
* @throws {RequiredError}
|
|
8084
9419
|
*/
|
|
8085
|
-
|
|
9420
|
+
addVirtualControllerTcp: (cell: string, controller: string, motionGroup: string, tcp: string, robotTcpData: RobotTcpData, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
8086
9421
|
/**
|
|
8087
9422
|
* Deletes a coordinate system from the virtual controller. This will remove the coordinate system from the list of coordinate systems and remove all dependent coordinate systems which use the deleted coordinate system as reference.
|
|
8088
9423
|
* @summary Remove Coordinate System
|
|
@@ -8093,7 +9428,7 @@ export declare const VirtualControllerApiAxiosParamCreator: (configuration?: Con
|
|
|
8093
9428
|
* @param {*} [options] Override http request option.
|
|
8094
9429
|
* @throws {RequiredError}
|
|
8095
9430
|
*/
|
|
8096
|
-
|
|
9431
|
+
deleteVirtualControllerCoordinateSystem: (cell: string, controller: string, coordinateSystem: string, deleteDependent?: boolean, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
8097
9432
|
/**
|
|
8098
9433
|
* Removes the TCP from the motion group. An unknown TCP is a valid input.
|
|
8099
9434
|
* @summary Remove TCP
|
|
@@ -8104,7 +9439,7 @@ export declare const VirtualControllerApiAxiosParamCreator: (configuration?: Con
|
|
|
8104
9439
|
* @param {*} [options] Override http request option.
|
|
8105
9440
|
* @throws {RequiredError}
|
|
8106
9441
|
*/
|
|
8107
|
-
|
|
9442
|
+
deleteVirtualControllerTcp: (cell: string, controller: string, motionGroup: string, tcp: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
8108
9443
|
/**
|
|
8109
9444
|
* Requests the Emergency Stop state of the virtual robot controller. Use [getCurrentMotionGroupState](getCurrentMotionGroupState) to get the Emergency Stop state regardless of the controller type. There the Emergency Stop state is visible as the `safety_state`. > **NOTE** > > The Emergency Stop state can only be changed when using virtual robot controllers.
|
|
8110
9445
|
* @summary Get Emergency Stop State
|
|
@@ -8151,7 +9486,7 @@ export declare const VirtualControllerApiAxiosParamCreator: (configuration?: Con
|
|
|
8151
9486
|
* @param {*} [options] Override http request option.
|
|
8152
9487
|
* @throws {RequiredError}
|
|
8153
9488
|
*/
|
|
8154
|
-
|
|
9489
|
+
getVirtualControllerMounting: (cell: string, controller: string, motionGroup: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
8155
9490
|
/**
|
|
8156
9491
|
* Lists all coordinate systems on the robot controller.
|
|
8157
9492
|
* @summary List Coordinate Systems
|
|
@@ -8160,7 +9495,7 @@ export declare const VirtualControllerApiAxiosParamCreator: (configuration?: Con
|
|
|
8160
9495
|
* @param {*} [options] Override http request option.
|
|
8161
9496
|
* @throws {RequiredError}
|
|
8162
9497
|
*/
|
|
8163
|
-
|
|
9498
|
+
listVirtualControllerCoordinateSystems: (cell: string, controller: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
8164
9499
|
/**
|
|
8165
9500
|
* Lists TCPs of the motion group. An empty TCP list is valid, for example for external axes.
|
|
8166
9501
|
* @summary List TCPs
|
|
@@ -8170,7 +9505,7 @@ export declare const VirtualControllerApiAxiosParamCreator: (configuration?: Con
|
|
|
8170
9505
|
* @param {*} [options] Override http request option.
|
|
8171
9506
|
* @throws {RequiredError}
|
|
8172
9507
|
*/
|
|
8173
|
-
|
|
9508
|
+
listVirtualControllerTcps: (cell: string, controller: string, motionGroup: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
8174
9509
|
/**
|
|
8175
9510
|
* Activates or releases the Emergency Stop on the virtual robot controller. Activating the Emergency Stop stops the execution of all motions. The stop is executed on physical controllers immediately not gracefully and not on paths. Due to restricted physical behavior of the virtual robot controller, the Emergency Stop is executed on paths. To return to normal operation the Emergency Stop needs to be released. Use [getCurrentMotionGroupState](getCurrentMotionGroupState) to get the Emergency Stop state regardless of the controller type. There the Emergency Stop state is visible as the `safety_state`. > **NOTE** > > The Emergency Stop state can only be changed via API when using virtual robot controllers.
|
|
8176
9511
|
* @summary Push or Release Emergency Stop
|
|
@@ -8212,7 +9547,7 @@ export declare const VirtualControllerApiAxiosParamCreator: (configuration?: Con
|
|
|
8212
9547
|
* @param {*} [options] Override http request option.
|
|
8213
9548
|
* @throws {RequiredError}
|
|
8214
9549
|
*/
|
|
8215
|
-
|
|
9550
|
+
setVirtualControllerMounting: (cell: string, controller: string, motionGroup: string, coordinateSystem: CoordinateSystem, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
8216
9551
|
};
|
|
8217
9552
|
/**
|
|
8218
9553
|
* VirtualControllerApi - functional programming interface
|
|
@@ -8229,7 +9564,7 @@ export declare const VirtualControllerApiFp: (configuration?: Configuration) =>
|
|
|
8229
9564
|
* @param {*} [options] Override http request option.
|
|
8230
9565
|
* @throws {RequiredError}
|
|
8231
9566
|
*/
|
|
8232
|
-
|
|
9567
|
+
addVirtualControllerCoordinateSystem(cell: string, controller: string, coordinateSystem: string, coordinateSystemData: CoordinateSystemData, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
8233
9568
|
/**
|
|
8234
9569
|
* Adds a new TCP or updates an existing TCP in the motion group. The position and rotation values in the request body are defined within the flange’s coordinate system. > **NOTE** > > Ensure the TCP\'s position is within the robot\'s reach. Refer to the robot’s documentation or data sheet for details like joint limits or reach.
|
|
8235
9570
|
* @summary Add TCP
|
|
@@ -8241,7 +9576,7 @@ export declare const VirtualControllerApiFp: (configuration?: Configuration) =>
|
|
|
8241
9576
|
* @param {*} [options] Override http request option.
|
|
8242
9577
|
* @throws {RequiredError}
|
|
8243
9578
|
*/
|
|
8244
|
-
|
|
9579
|
+
addVirtualControllerTcp(cell: string, controller: string, motionGroup: string, tcp: string, robotTcpData: RobotTcpData, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
8245
9580
|
/**
|
|
8246
9581
|
* Deletes a coordinate system from the virtual controller. This will remove the coordinate system from the list of coordinate systems and remove all dependent coordinate systems which use the deleted coordinate system as reference.
|
|
8247
9582
|
* @summary Remove Coordinate System
|
|
@@ -8252,7 +9587,7 @@ export declare const VirtualControllerApiFp: (configuration?: Configuration) =>
|
|
|
8252
9587
|
* @param {*} [options] Override http request option.
|
|
8253
9588
|
* @throws {RequiredError}
|
|
8254
9589
|
*/
|
|
8255
|
-
|
|
9590
|
+
deleteVirtualControllerCoordinateSystem(cell: string, controller: string, coordinateSystem: string, deleteDependent?: boolean, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
8256
9591
|
/**
|
|
8257
9592
|
* Removes the TCP from the motion group. An unknown TCP is a valid input.
|
|
8258
9593
|
* @summary Remove TCP
|
|
@@ -8263,7 +9598,7 @@ export declare const VirtualControllerApiFp: (configuration?: Configuration) =>
|
|
|
8263
9598
|
* @param {*} [options] Override http request option.
|
|
8264
9599
|
* @throws {RequiredError}
|
|
8265
9600
|
*/
|
|
8266
|
-
|
|
9601
|
+
deleteVirtualControllerTcp(cell: string, controller: string, motionGroup: string, tcp: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
8267
9602
|
/**
|
|
8268
9603
|
* Requests the Emergency Stop state of the virtual robot controller. Use [getCurrentMotionGroupState](getCurrentMotionGroupState) to get the Emergency Stop state regardless of the controller type. There the Emergency Stop state is visible as the `safety_state`. > **NOTE** > > The Emergency Stop state can only be changed when using virtual robot controllers.
|
|
8269
9604
|
* @summary Get Emergency Stop State
|
|
@@ -8310,7 +9645,7 @@ export declare const VirtualControllerApiFp: (configuration?: Configuration) =>
|
|
|
8310
9645
|
* @param {*} [options] Override http request option.
|
|
8311
9646
|
* @throws {RequiredError}
|
|
8312
9647
|
*/
|
|
8313
|
-
|
|
9648
|
+
getVirtualControllerMounting(cell: string, controller: string, motionGroup: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CoordinateSystem>>;
|
|
8314
9649
|
/**
|
|
8315
9650
|
* Lists all coordinate systems on the robot controller.
|
|
8316
9651
|
* @summary List Coordinate Systems
|
|
@@ -8319,7 +9654,7 @@ export declare const VirtualControllerApiFp: (configuration?: Configuration) =>
|
|
|
8319
9654
|
* @param {*} [options] Override http request option.
|
|
8320
9655
|
* @throws {RequiredError}
|
|
8321
9656
|
*/
|
|
8322
|
-
|
|
9657
|
+
listVirtualControllerCoordinateSystems(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<CoordinateSystem>>>;
|
|
8323
9658
|
/**
|
|
8324
9659
|
* Lists TCPs of the motion group. An empty TCP list is valid, for example for external axes.
|
|
8325
9660
|
* @summary List TCPs
|
|
@@ -8329,7 +9664,7 @@ export declare const VirtualControllerApiFp: (configuration?: Configuration) =>
|
|
|
8329
9664
|
* @param {*} [options] Override http request option.
|
|
8330
9665
|
* @throws {RequiredError}
|
|
8331
9666
|
*/
|
|
8332
|
-
|
|
9667
|
+
listVirtualControllerTcps(cell: string, controller: string, motionGroup: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<RobotTcp>>>;
|
|
8333
9668
|
/**
|
|
8334
9669
|
* Activates or releases the Emergency Stop on the virtual robot controller. Activating the Emergency Stop stops the execution of all motions. The stop is executed on physical controllers immediately not gracefully and not on paths. Due to restricted physical behavior of the virtual robot controller, the Emergency Stop is executed on paths. To return to normal operation the Emergency Stop needs to be released. Use [getCurrentMotionGroupState](getCurrentMotionGroupState) to get the Emergency Stop state regardless of the controller type. There the Emergency Stop state is visible as the `safety_state`. > **NOTE** > > The Emergency Stop state can only be changed via API when using virtual robot controllers.
|
|
8335
9670
|
* @summary Push or Release Emergency Stop
|
|
@@ -8371,7 +9706,7 @@ export declare const VirtualControllerApiFp: (configuration?: Configuration) =>
|
|
|
8371
9706
|
* @param {*} [options] Override http request option.
|
|
8372
9707
|
* @throws {RequiredError}
|
|
8373
9708
|
*/
|
|
8374
|
-
|
|
9709
|
+
setVirtualControllerMounting(cell: string, controller: string, motionGroup: string, coordinateSystem: CoordinateSystem, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CoordinateSystem>>;
|
|
8375
9710
|
};
|
|
8376
9711
|
/**
|
|
8377
9712
|
* VirtualControllerApi - factory interface
|
|
@@ -8388,7 +9723,7 @@ export declare const VirtualControllerApiFactory: (configuration?: Configuration
|
|
|
8388
9723
|
* @param {*} [options] Override http request option.
|
|
8389
9724
|
* @throws {RequiredError}
|
|
8390
9725
|
*/
|
|
8391
|
-
|
|
9726
|
+
addVirtualControllerCoordinateSystem(cell: string, controller: string, coordinateSystem: string, coordinateSystemData: CoordinateSystemData, options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
8392
9727
|
/**
|
|
8393
9728
|
* Adds a new TCP or updates an existing TCP in the motion group. The position and rotation values in the request body are defined within the flange’s coordinate system. > **NOTE** > > Ensure the TCP\'s position is within the robot\'s reach. Refer to the robot’s documentation or data sheet for details like joint limits or reach.
|
|
8394
9729
|
* @summary Add TCP
|
|
@@ -8400,7 +9735,7 @@ export declare const VirtualControllerApiFactory: (configuration?: Configuration
|
|
|
8400
9735
|
* @param {*} [options] Override http request option.
|
|
8401
9736
|
* @throws {RequiredError}
|
|
8402
9737
|
*/
|
|
8403
|
-
|
|
9738
|
+
addVirtualControllerTcp(cell: string, controller: string, motionGroup: string, tcp: string, robotTcpData: RobotTcpData, options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
8404
9739
|
/**
|
|
8405
9740
|
* Deletes a coordinate system from the virtual controller. This will remove the coordinate system from the list of coordinate systems and remove all dependent coordinate systems which use the deleted coordinate system as reference.
|
|
8406
9741
|
* @summary Remove Coordinate System
|
|
@@ -8411,7 +9746,7 @@ export declare const VirtualControllerApiFactory: (configuration?: Configuration
|
|
|
8411
9746
|
* @param {*} [options] Override http request option.
|
|
8412
9747
|
* @throws {RequiredError}
|
|
8413
9748
|
*/
|
|
8414
|
-
|
|
9749
|
+
deleteVirtualControllerCoordinateSystem(cell: string, controller: string, coordinateSystem: string, deleteDependent?: boolean, options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
8415
9750
|
/**
|
|
8416
9751
|
* Removes the TCP from the motion group. An unknown TCP is a valid input.
|
|
8417
9752
|
* @summary Remove TCP
|
|
@@ -8422,7 +9757,7 @@ export declare const VirtualControllerApiFactory: (configuration?: Configuration
|
|
|
8422
9757
|
* @param {*} [options] Override http request option.
|
|
8423
9758
|
* @throws {RequiredError}
|
|
8424
9759
|
*/
|
|
8425
|
-
|
|
9760
|
+
deleteVirtualControllerTcp(cell: string, controller: string, motionGroup: string, tcp: string, options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
8426
9761
|
/**
|
|
8427
9762
|
* Requests the Emergency Stop state of the virtual robot controller. Use [getCurrentMotionGroupState](getCurrentMotionGroupState) to get the Emergency Stop state regardless of the controller type. There the Emergency Stop state is visible as the `safety_state`. > **NOTE** > > The Emergency Stop state can only be changed when using virtual robot controllers.
|
|
8428
9763
|
* @summary Get Emergency Stop State
|
|
@@ -8469,7 +9804,7 @@ export declare const VirtualControllerApiFactory: (configuration?: Configuration
|
|
|
8469
9804
|
* @param {*} [options] Override http request option.
|
|
8470
9805
|
* @throws {RequiredError}
|
|
8471
9806
|
*/
|
|
8472
|
-
|
|
9807
|
+
getVirtualControllerMounting(cell: string, controller: string, motionGroup: string, options?: RawAxiosRequestConfig): AxiosPromise<CoordinateSystem>;
|
|
8473
9808
|
/**
|
|
8474
9809
|
* Lists all coordinate systems on the robot controller.
|
|
8475
9810
|
* @summary List Coordinate Systems
|
|
@@ -8478,7 +9813,7 @@ export declare const VirtualControllerApiFactory: (configuration?: Configuration
|
|
|
8478
9813
|
* @param {*} [options] Override http request option.
|
|
8479
9814
|
* @throws {RequiredError}
|
|
8480
9815
|
*/
|
|
8481
|
-
|
|
9816
|
+
listVirtualControllerCoordinateSystems(cell: string, controller: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<CoordinateSystem>>;
|
|
8482
9817
|
/**
|
|
8483
9818
|
* Lists TCPs of the motion group. An empty TCP list is valid, for example for external axes.
|
|
8484
9819
|
* @summary List TCPs
|
|
@@ -8488,7 +9823,7 @@ export declare const VirtualControllerApiFactory: (configuration?: Configuration
|
|
|
8488
9823
|
* @param {*} [options] Override http request option.
|
|
8489
9824
|
* @throws {RequiredError}
|
|
8490
9825
|
*/
|
|
8491
|
-
|
|
9826
|
+
listVirtualControllerTcps(cell: string, controller: string, motionGroup: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<RobotTcp>>;
|
|
8492
9827
|
/**
|
|
8493
9828
|
* Activates or releases the Emergency Stop on the virtual robot controller. Activating the Emergency Stop stops the execution of all motions. The stop is executed on physical controllers immediately not gracefully and not on paths. Due to restricted physical behavior of the virtual robot controller, the Emergency Stop is executed on paths. To return to normal operation the Emergency Stop needs to be released. Use [getCurrentMotionGroupState](getCurrentMotionGroupState) to get the Emergency Stop state regardless of the controller type. There the Emergency Stop state is visible as the `safety_state`. > **NOTE** > > The Emergency Stop state can only be changed via API when using virtual robot controllers.
|
|
8494
9829
|
* @summary Push or Release Emergency Stop
|
|
@@ -8530,7 +9865,7 @@ export declare const VirtualControllerApiFactory: (configuration?: Configuration
|
|
|
8530
9865
|
* @param {*} [options] Override http request option.
|
|
8531
9866
|
* @throws {RequiredError}
|
|
8532
9867
|
*/
|
|
8533
|
-
|
|
9868
|
+
setVirtualControllerMounting(cell: string, controller: string, motionGroup: string, coordinateSystem: CoordinateSystem, options?: RawAxiosRequestConfig): AxiosPromise<CoordinateSystem>;
|
|
8534
9869
|
};
|
|
8535
9870
|
/**
|
|
8536
9871
|
* VirtualControllerApi - object-oriented interface
|
|
@@ -8550,7 +9885,7 @@ export declare class VirtualControllerApi extends BaseAPI {
|
|
|
8550
9885
|
* @throws {RequiredError}
|
|
8551
9886
|
* @memberof VirtualControllerApi
|
|
8552
9887
|
*/
|
|
8553
|
-
|
|
9888
|
+
addVirtualControllerCoordinateSystem(cell: string, controller: string, coordinateSystem: string, coordinateSystemData: CoordinateSystemData, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
8554
9889
|
/**
|
|
8555
9890
|
* Adds a new TCP or updates an existing TCP in the motion group. The position and rotation values in the request body are defined within the flange’s coordinate system. > **NOTE** > > Ensure the TCP\'s position is within the robot\'s reach. Refer to the robot’s documentation or data sheet for details like joint limits or reach.
|
|
8556
9891
|
* @summary Add TCP
|
|
@@ -8563,7 +9898,7 @@ export declare class VirtualControllerApi extends BaseAPI {
|
|
|
8563
9898
|
* @throws {RequiredError}
|
|
8564
9899
|
* @memberof VirtualControllerApi
|
|
8565
9900
|
*/
|
|
8566
|
-
|
|
9901
|
+
addVirtualControllerTcp(cell: string, controller: string, motionGroup: string, tcp: string, robotTcpData: RobotTcpData, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
8567
9902
|
/**
|
|
8568
9903
|
* Deletes a coordinate system from the virtual controller. This will remove the coordinate system from the list of coordinate systems and remove all dependent coordinate systems which use the deleted coordinate system as reference.
|
|
8569
9904
|
* @summary Remove Coordinate System
|
|
@@ -8575,7 +9910,7 @@ export declare class VirtualControllerApi extends BaseAPI {
|
|
|
8575
9910
|
* @throws {RequiredError}
|
|
8576
9911
|
* @memberof VirtualControllerApi
|
|
8577
9912
|
*/
|
|
8578
|
-
|
|
9913
|
+
deleteVirtualControllerCoordinateSystem(cell: string, controller: string, coordinateSystem: string, deleteDependent?: boolean, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
8579
9914
|
/**
|
|
8580
9915
|
* Removes the TCP from the motion group. An unknown TCP is a valid input.
|
|
8581
9916
|
* @summary Remove TCP
|
|
@@ -8587,7 +9922,7 @@ export declare class VirtualControllerApi extends BaseAPI {
|
|
|
8587
9922
|
* @throws {RequiredError}
|
|
8588
9923
|
* @memberof VirtualControllerApi
|
|
8589
9924
|
*/
|
|
8590
|
-
|
|
9925
|
+
deleteVirtualControllerTcp(cell: string, controller: string, motionGroup: string, tcp: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
8591
9926
|
/**
|
|
8592
9927
|
* Requests the Emergency Stop state of the virtual robot controller. Use [getCurrentMotionGroupState](getCurrentMotionGroupState) to get the Emergency Stop state regardless of the controller type. There the Emergency Stop state is visible as the `safety_state`. > **NOTE** > > The Emergency Stop state can only be changed when using virtual robot controllers.
|
|
8593
9928
|
* @summary Get Emergency Stop State
|
|
@@ -8639,7 +9974,7 @@ export declare class VirtualControllerApi extends BaseAPI {
|
|
|
8639
9974
|
* @throws {RequiredError}
|
|
8640
9975
|
* @memberof VirtualControllerApi
|
|
8641
9976
|
*/
|
|
8642
|
-
|
|
9977
|
+
getVirtualControllerMounting(cell: string, controller: string, motionGroup: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CoordinateSystem, any>>;
|
|
8643
9978
|
/**
|
|
8644
9979
|
* Lists all coordinate systems on the robot controller.
|
|
8645
9980
|
* @summary List Coordinate Systems
|
|
@@ -8649,7 +9984,7 @@ export declare class VirtualControllerApi extends BaseAPI {
|
|
|
8649
9984
|
* @throws {RequiredError}
|
|
8650
9985
|
* @memberof VirtualControllerApi
|
|
8651
9986
|
*/
|
|
8652
|
-
|
|
9987
|
+
listVirtualControllerCoordinateSystems(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CoordinateSystem[], any>>;
|
|
8653
9988
|
/**
|
|
8654
9989
|
* Lists TCPs of the motion group. An empty TCP list is valid, for example for external axes.
|
|
8655
9990
|
* @summary List TCPs
|
|
@@ -8660,7 +9995,7 @@ export declare class VirtualControllerApi extends BaseAPI {
|
|
|
8660
9995
|
* @throws {RequiredError}
|
|
8661
9996
|
* @memberof VirtualControllerApi
|
|
8662
9997
|
*/
|
|
8663
|
-
|
|
9998
|
+
listVirtualControllerTcps(cell: string, controller: string, motionGroup: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<RobotTcp[], any>>;
|
|
8664
9999
|
/**
|
|
8665
10000
|
* Activates or releases the Emergency Stop on the virtual robot controller. Activating the Emergency Stop stops the execution of all motions. The stop is executed on physical controllers immediately not gracefully and not on paths. Due to restricted physical behavior of the virtual robot controller, the Emergency Stop is executed on paths. To return to normal operation the Emergency Stop needs to be released. Use [getCurrentMotionGroupState](getCurrentMotionGroupState) to get the Emergency Stop state regardless of the controller type. There the Emergency Stop state is visible as the `safety_state`. > **NOTE** > > The Emergency Stop state can only be changed via API when using virtual robot controllers.
|
|
8666
10001
|
* @summary Push or Release Emergency Stop
|
|
@@ -8706,7 +10041,7 @@ export declare class VirtualControllerApi extends BaseAPI {
|
|
|
8706
10041
|
* @throws {RequiredError}
|
|
8707
10042
|
* @memberof VirtualControllerApi
|
|
8708
10043
|
*/
|
|
8709
|
-
|
|
10044
|
+
setVirtualControllerMounting(cell: string, controller: string, motionGroup: string, coordinateSystem: CoordinateSystem, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CoordinateSystem, any>>;
|
|
8710
10045
|
}
|
|
8711
10046
|
/**
|
|
8712
10047
|
* VirtualControllerBehaviorApi - axios parameter creator
|
|
@@ -8733,14 +10068,14 @@ export declare const VirtualControllerBehaviorApiAxiosParamCreator: (configurati
|
|
|
8733
10068
|
*/
|
|
8734
10069
|
getCycleTime: (cell: string, controller: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
8735
10070
|
/**
|
|
8736
|
-
* Get the current virtual controller behavior - please see the setter [
|
|
10071
|
+
* Get the current virtual controller behavior - please see the setter [setVirtualControllerBehavior](setVirtualControllerBehavior) and the enum for details.
|
|
8737
10072
|
* @summary Get Behavior
|
|
8738
10073
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8739
10074
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
8740
10075
|
* @param {*} [options] Override http request option.
|
|
8741
10076
|
* @throws {RequiredError}
|
|
8742
10077
|
*/
|
|
8743
|
-
|
|
10078
|
+
getVirtualControllerBehavior: (cell: string, controller: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
8744
10079
|
/**
|
|
8745
10080
|
* Set virtual controller behavior.
|
|
8746
10081
|
* @summary Set Behavior
|
|
@@ -8750,7 +10085,7 @@ export declare const VirtualControllerBehaviorApiAxiosParamCreator: (configurati
|
|
|
8750
10085
|
* @param {*} [options] Override http request option.
|
|
8751
10086
|
* @throws {RequiredError}
|
|
8752
10087
|
*/
|
|
8753
|
-
|
|
10088
|
+
setVirtualControllerBehavior: (cell: string, controller: string, behavior?: Behavior, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
8754
10089
|
};
|
|
8755
10090
|
/**
|
|
8756
10091
|
* VirtualControllerBehaviorApi - functional programming interface
|
|
@@ -8777,14 +10112,14 @@ export declare const VirtualControllerBehaviorApiFp: (configuration?: Configurat
|
|
|
8777
10112
|
*/
|
|
8778
10113
|
getCycleTime(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CycleTime>>;
|
|
8779
10114
|
/**
|
|
8780
|
-
* Get the current virtual controller behavior - please see the setter [
|
|
10115
|
+
* Get the current virtual controller behavior - please see the setter [setVirtualControllerBehavior](setVirtualControllerBehavior) and the enum for details.
|
|
8781
10116
|
* @summary Get Behavior
|
|
8782
10117
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8783
10118
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
8784
10119
|
* @param {*} [options] Override http request option.
|
|
8785
10120
|
* @throws {RequiredError}
|
|
8786
10121
|
*/
|
|
8787
|
-
|
|
10122
|
+
getVirtualControllerBehavior(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Behavior>>;
|
|
8788
10123
|
/**
|
|
8789
10124
|
* Set virtual controller behavior.
|
|
8790
10125
|
* @summary Set Behavior
|
|
@@ -8794,7 +10129,7 @@ export declare const VirtualControllerBehaviorApiFp: (configuration?: Configurat
|
|
|
8794
10129
|
* @param {*} [options] Override http request option.
|
|
8795
10130
|
* @throws {RequiredError}
|
|
8796
10131
|
*/
|
|
8797
|
-
|
|
10132
|
+
setVirtualControllerBehavior(cell: string, controller: string, behavior?: Behavior, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
8798
10133
|
};
|
|
8799
10134
|
/**
|
|
8800
10135
|
* VirtualControllerBehaviorApi - factory interface
|
|
@@ -8821,14 +10156,14 @@ export declare const VirtualControllerBehaviorApiFactory: (configuration?: Confi
|
|
|
8821
10156
|
*/
|
|
8822
10157
|
getCycleTime(cell: string, controller: string, options?: RawAxiosRequestConfig): AxiosPromise<CycleTime>;
|
|
8823
10158
|
/**
|
|
8824
|
-
* Get the current virtual controller behavior - please see the setter [
|
|
10159
|
+
* Get the current virtual controller behavior - please see the setter [setVirtualControllerBehavior](setVirtualControllerBehavior) and the enum for details.
|
|
8825
10160
|
* @summary Get Behavior
|
|
8826
10161
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8827
10162
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
8828
10163
|
* @param {*} [options] Override http request option.
|
|
8829
10164
|
* @throws {RequiredError}
|
|
8830
10165
|
*/
|
|
8831
|
-
|
|
10166
|
+
getVirtualControllerBehavior(cell: string, controller: string, options?: RawAxiosRequestConfig): AxiosPromise<Behavior>;
|
|
8832
10167
|
/**
|
|
8833
10168
|
* Set virtual controller behavior.
|
|
8834
10169
|
* @summary Set Behavior
|
|
@@ -8838,7 +10173,7 @@ export declare const VirtualControllerBehaviorApiFactory: (configuration?: Confi
|
|
|
8838
10173
|
* @param {*} [options] Override http request option.
|
|
8839
10174
|
* @throws {RequiredError}
|
|
8840
10175
|
*/
|
|
8841
|
-
|
|
10176
|
+
setVirtualControllerBehavior(cell: string, controller: string, behavior?: Behavior, options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
8842
10177
|
};
|
|
8843
10178
|
/**
|
|
8844
10179
|
* VirtualControllerBehaviorApi - object-oriented interface
|
|
@@ -8869,7 +10204,7 @@ export declare class VirtualControllerBehaviorApi extends BaseAPI {
|
|
|
8869
10204
|
*/
|
|
8870
10205
|
getCycleTime(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CycleTime, any>>;
|
|
8871
10206
|
/**
|
|
8872
|
-
* Get the current virtual controller behavior - please see the setter [
|
|
10207
|
+
* Get the current virtual controller behavior - please see the setter [setVirtualControllerBehavior](setVirtualControllerBehavior) and the enum for details.
|
|
8873
10208
|
* @summary Get Behavior
|
|
8874
10209
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8875
10210
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -8877,7 +10212,7 @@ export declare class VirtualControllerBehaviorApi extends BaseAPI {
|
|
|
8877
10212
|
* @throws {RequiredError}
|
|
8878
10213
|
* @memberof VirtualControllerBehaviorApi
|
|
8879
10214
|
*/
|
|
8880
|
-
|
|
10215
|
+
getVirtualControllerBehavior(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Behavior, any>>;
|
|
8881
10216
|
/**
|
|
8882
10217
|
* Set virtual controller behavior.
|
|
8883
10218
|
* @summary Set Behavior
|
|
@@ -8888,7 +10223,7 @@ export declare class VirtualControllerBehaviorApi extends BaseAPI {
|
|
|
8888
10223
|
* @throws {RequiredError}
|
|
8889
10224
|
* @memberof VirtualControllerBehaviorApi
|
|
8890
10225
|
*/
|
|
8891
|
-
|
|
10226
|
+
setVirtualControllerBehavior(cell: string, controller: string, behavior?: Behavior, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
8892
10227
|
}
|
|
8893
10228
|
/**
|
|
8894
10229
|
* VirtualControllerInputsOutputsApi - axios parameter creator
|
|
@@ -8896,7 +10231,7 @@ export declare class VirtualControllerBehaviorApi extends BaseAPI {
|
|
|
8896
10231
|
*/
|
|
8897
10232
|
export declare const VirtualControllerInputsOutputsApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
8898
10233
|
/**
|
|
8899
|
-
* Retrieves the current values of inputs/outputs of the virtual controller. The identifiers of inputs/outputs must be provided in the request. Request all available input/output identifiers via [
|
|
10234
|
+
* Retrieves the current values of inputs/outputs of the virtual controller. The identifiers of inputs/outputs must be provided in the request. Request all available input/output identifiers via [listVirtualControllerIODescriptions](listVirtualControllerIODescriptions).
|
|
8900
10235
|
* @summary Get Input/Output Values
|
|
8901
10236
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8902
10237
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -8917,7 +10252,7 @@ export declare const VirtualControllerInputsOutputsApiAxiosParamCreator: (config
|
|
|
8917
10252
|
* @param {*} [options] Override http request option.
|
|
8918
10253
|
* @throws {RequiredError}
|
|
8919
10254
|
*/
|
|
8920
|
-
|
|
10255
|
+
listVirtualControllerIODescriptions: (cell: string, controller: string, ios?: Array<string>, direction?: IODirection, valueType?: IOValueType, group?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
8921
10256
|
/**
|
|
8922
10257
|
* Sets a list of values of a virtual controller inputs/outputs.
|
|
8923
10258
|
* @summary Set Input/Ouput Values
|
|
@@ -8935,7 +10270,7 @@ export declare const VirtualControllerInputsOutputsApiAxiosParamCreator: (config
|
|
|
8935
10270
|
*/
|
|
8936
10271
|
export declare const VirtualControllerInputsOutputsApiFp: (configuration?: Configuration) => {
|
|
8937
10272
|
/**
|
|
8938
|
-
* Retrieves the current values of inputs/outputs of the virtual controller. The identifiers of inputs/outputs must be provided in the request. Request all available input/output identifiers via [
|
|
10273
|
+
* Retrieves the current values of inputs/outputs of the virtual controller. The identifiers of inputs/outputs must be provided in the request. Request all available input/output identifiers via [listVirtualControllerIODescriptions](listVirtualControllerIODescriptions).
|
|
8939
10274
|
* @summary Get Input/Output Values
|
|
8940
10275
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8941
10276
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -8956,7 +10291,7 @@ export declare const VirtualControllerInputsOutputsApiFp: (configuration?: Confi
|
|
|
8956
10291
|
* @param {*} [options] Override http request option.
|
|
8957
10292
|
* @throws {RequiredError}
|
|
8958
10293
|
*/
|
|
8959
|
-
|
|
10294
|
+
listVirtualControllerIODescriptions(cell: string, controller: string, ios?: Array<string>, direction?: IODirection, valueType?: IOValueType, group?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<IODescription>>>;
|
|
8960
10295
|
/**
|
|
8961
10296
|
* Sets a list of values of a virtual controller inputs/outputs.
|
|
8962
10297
|
* @summary Set Input/Ouput Values
|
|
@@ -8974,7 +10309,7 @@ export declare const VirtualControllerInputsOutputsApiFp: (configuration?: Confi
|
|
|
8974
10309
|
*/
|
|
8975
10310
|
export declare const VirtualControllerInputsOutputsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
8976
10311
|
/**
|
|
8977
|
-
* Retrieves the current values of inputs/outputs of the virtual controller. The identifiers of inputs/outputs must be provided in the request. Request all available input/output identifiers via [
|
|
10312
|
+
* Retrieves the current values of inputs/outputs of the virtual controller. The identifiers of inputs/outputs must be provided in the request. Request all available input/output identifiers via [listVirtualControllerIODescriptions](listVirtualControllerIODescriptions).
|
|
8978
10313
|
* @summary Get Input/Output Values
|
|
8979
10314
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8980
10315
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -8995,7 +10330,7 @@ export declare const VirtualControllerInputsOutputsApiFactory: (configuration?:
|
|
|
8995
10330
|
* @param {*} [options] Override http request option.
|
|
8996
10331
|
* @throws {RequiredError}
|
|
8997
10332
|
*/
|
|
8998
|
-
|
|
10333
|
+
listVirtualControllerIODescriptions(cell: string, controller: string, ios?: Array<string>, direction?: IODirection, valueType?: IOValueType, group?: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<IODescription>>;
|
|
8999
10334
|
/**
|
|
9000
10335
|
* Sets a list of values of a virtual controller inputs/outputs.
|
|
9001
10336
|
* @summary Set Input/Ouput Values
|
|
@@ -9015,7 +10350,7 @@ export declare const VirtualControllerInputsOutputsApiFactory: (configuration?:
|
|
|
9015
10350
|
*/
|
|
9016
10351
|
export declare class VirtualControllerInputsOutputsApi extends BaseAPI {
|
|
9017
10352
|
/**
|
|
9018
|
-
* Retrieves the current values of inputs/outputs of the virtual controller. The identifiers of inputs/outputs must be provided in the request. Request all available input/output identifiers via [
|
|
10353
|
+
* Retrieves the current values of inputs/outputs of the virtual controller. The identifiers of inputs/outputs must be provided in the request. Request all available input/output identifiers via [listVirtualControllerIODescriptions](listVirtualControllerIODescriptions).
|
|
9019
10354
|
* @summary Get Input/Output Values
|
|
9020
10355
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
9021
10356
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -9038,7 +10373,7 @@ export declare class VirtualControllerInputsOutputsApi extends BaseAPI {
|
|
|
9038
10373
|
* @throws {RequiredError}
|
|
9039
10374
|
* @memberof VirtualControllerInputsOutputsApi
|
|
9040
10375
|
*/
|
|
9041
|
-
|
|
10376
|
+
listVirtualControllerIODescriptions(cell: string, controller: string, ios?: Array<string>, direction?: IODirection, valueType?: IOValueType, group?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<IODescription[], any>>;
|
|
9042
10377
|
/**
|
|
9043
10378
|
* Sets a list of values of a virtual controller inputs/outputs.
|
|
9044
10379
|
* @summary Set Input/Ouput Values
|