@wandelbots/nova-api 25.7.0-dev.9 → 25.8.0-dev.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/package.json +1 -1
- package/v1/api.d.ts +5 -1
- package/v1/api.js +5 -1
- package/v1/api.js.map +1 -1
- package/v1/api.ts +5 -1
- 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 +2009 -717
- package/v2/api.js +1449 -291
- package/v2/api.js.map +1 -1
- package/v2/api.ts +2767 -755
package/v2/api.ts
CHANGED
|
@@ -210,6 +210,12 @@ export interface App {
|
|
|
210
210
|
* @memberof App
|
|
211
211
|
*/
|
|
212
212
|
'storage'?: ContainerStorage;
|
|
213
|
+
/**
|
|
214
|
+
*
|
|
215
|
+
* @type {ContainerResources}
|
|
216
|
+
* @memberof App
|
|
217
|
+
*/
|
|
218
|
+
'resources'?: ContainerResources;
|
|
213
219
|
/**
|
|
214
220
|
* Defines the URL path suffix used to check the application\'s health status. The complete health check URL is constructed as `/$cell/$name/$health_path`. When the application is working as expected, the endpoint returns an HTTP 200 status code. If not specified, the system will default to using the application icon path suffix (the value of `app_icon`) as the health check endpoint, resulting in `/$cell/$name/$app_icon`. If the health check fails (no response or non-200 status code), the system will automatically restart the application container to restore service.
|
|
215
221
|
* @type {string}
|
|
@@ -366,6 +372,182 @@ export const BoxBoxTypeEnum = {
|
|
|
366
372
|
|
|
367
373
|
export type BoxBoxTypeEnum = typeof BoxBoxTypeEnum[keyof typeof BoxBoxTypeEnum];
|
|
368
374
|
|
|
375
|
+
/**
|
|
376
|
+
* PROFINET BUS Inputs/Outputs Service configuration.
|
|
377
|
+
* @export
|
|
378
|
+
* @interface BusIOProfinet
|
|
379
|
+
*/
|
|
380
|
+
export interface BusIOProfinet {
|
|
381
|
+
/**
|
|
382
|
+
*
|
|
383
|
+
* @type {string}
|
|
384
|
+
* @memberof BusIOProfinet
|
|
385
|
+
*/
|
|
386
|
+
'bus_type'?: BusIOProfinetBusTypeEnum;
|
|
387
|
+
/**
|
|
388
|
+
* Path to the configuration file.
|
|
389
|
+
* @type {string}
|
|
390
|
+
* @memberof BusIOProfinet
|
|
391
|
+
*/
|
|
392
|
+
'config_file_content'?: string;
|
|
393
|
+
/**
|
|
394
|
+
*
|
|
395
|
+
* @type {BusIOProfinetNetwork}
|
|
396
|
+
* @memberof BusIOProfinet
|
|
397
|
+
*/
|
|
398
|
+
'network_config'?: BusIOProfinetNetwork;
|
|
399
|
+
/**
|
|
400
|
+
* MAC address for the PROFINET port, should be get from another NOVA API endpoind?
|
|
401
|
+
* @type {string}
|
|
402
|
+
* @memberof BusIOProfinet
|
|
403
|
+
*/
|
|
404
|
+
'mac': string;
|
|
405
|
+
/**
|
|
406
|
+
*
|
|
407
|
+
* @type {BusIOProfinetDefaultRoute}
|
|
408
|
+
* @memberof BusIOProfinet
|
|
409
|
+
*/
|
|
410
|
+
'default_route': BusIOProfinetDefaultRoute;
|
|
411
|
+
}
|
|
412
|
+
|
|
413
|
+
export const BusIOProfinetBusTypeEnum = {
|
|
414
|
+
Profinet: 'profinet'
|
|
415
|
+
} as const;
|
|
416
|
+
|
|
417
|
+
export type BusIOProfinetBusTypeEnum = typeof BusIOProfinetBusTypeEnum[keyof typeof BusIOProfinetBusTypeEnum];
|
|
418
|
+
|
|
419
|
+
/**
|
|
420
|
+
* Default route configuration for the PROFINET service. Will be removed before release by automatic default route configuration, if possible.
|
|
421
|
+
* @export
|
|
422
|
+
* @interface BusIOProfinetDefaultRoute
|
|
423
|
+
*/
|
|
424
|
+
export interface BusIOProfinetDefaultRoute {
|
|
425
|
+
/**
|
|
426
|
+
* Gateway for the default route.
|
|
427
|
+
* @type {string}
|
|
428
|
+
* @memberof BusIOProfinetDefaultRoute
|
|
429
|
+
*/
|
|
430
|
+
'gateway': string;
|
|
431
|
+
/**
|
|
432
|
+
* Interface for the default route.
|
|
433
|
+
* @type {string}
|
|
434
|
+
* @memberof BusIOProfinetDefaultRoute
|
|
435
|
+
*/
|
|
436
|
+
'interface': string;
|
|
437
|
+
}
|
|
438
|
+
/**
|
|
439
|
+
* Network configuration for the PROFINET device
|
|
440
|
+
* @export
|
|
441
|
+
* @interface BusIOProfinetIpConfig
|
|
442
|
+
*/
|
|
443
|
+
export interface BusIOProfinetIpConfig {
|
|
444
|
+
/**
|
|
445
|
+
* IP address for the PROFINET device
|
|
446
|
+
* @type {string}
|
|
447
|
+
* @memberof BusIOProfinetIpConfig
|
|
448
|
+
*/
|
|
449
|
+
'ip': string;
|
|
450
|
+
/**
|
|
451
|
+
* Network mask for the PROFINET device.
|
|
452
|
+
* @type {string}
|
|
453
|
+
* @memberof BusIOProfinetIpConfig
|
|
454
|
+
*/
|
|
455
|
+
'netmask': string;
|
|
456
|
+
/**
|
|
457
|
+
* Gateway for the PROFINET device
|
|
458
|
+
* @type {string}
|
|
459
|
+
* @memberof BusIOProfinetIpConfig
|
|
460
|
+
*/
|
|
461
|
+
'gateway': string;
|
|
462
|
+
}
|
|
463
|
+
/**
|
|
464
|
+
*
|
|
465
|
+
* @export
|
|
466
|
+
* @interface BusIOProfinetNetwork
|
|
467
|
+
*/
|
|
468
|
+
export interface BusIOProfinetNetwork {
|
|
469
|
+
/**
|
|
470
|
+
* Name of the PROFINET device.
|
|
471
|
+
* @type {string}
|
|
472
|
+
* @memberof BusIOProfinetNetwork
|
|
473
|
+
*/
|
|
474
|
+
'device_name'?: string;
|
|
475
|
+
/**
|
|
476
|
+
*
|
|
477
|
+
* @type {BusIOProfinetIpConfig}
|
|
478
|
+
* @memberof BusIOProfinetNetwork
|
|
479
|
+
*/
|
|
480
|
+
'ip_config'?: BusIOProfinetIpConfig;
|
|
481
|
+
/**
|
|
482
|
+
* Content of the PROFINET REMA XML file.
|
|
483
|
+
* @type {string}
|
|
484
|
+
* @memberof BusIOProfinetNetwork
|
|
485
|
+
*/
|
|
486
|
+
'rema_xml_content'?: string;
|
|
487
|
+
}
|
|
488
|
+
/**
|
|
489
|
+
* Virtual PROFINET BUS Inputs/Outputs Service configuration.
|
|
490
|
+
* @export
|
|
491
|
+
* @interface BusIOProfinetVirtual
|
|
492
|
+
*/
|
|
493
|
+
export interface BusIOProfinetVirtual {
|
|
494
|
+
/**
|
|
495
|
+
*
|
|
496
|
+
* @type {string}
|
|
497
|
+
* @memberof BusIOProfinetVirtual
|
|
498
|
+
*/
|
|
499
|
+
'bus_type'?: BusIOProfinetVirtualBusTypeEnum;
|
|
500
|
+
}
|
|
501
|
+
|
|
502
|
+
export const BusIOProfinetVirtualBusTypeEnum = {
|
|
503
|
+
VirtualProfinet: 'virtual_profinet'
|
|
504
|
+
} as const;
|
|
505
|
+
|
|
506
|
+
export type BusIOProfinetVirtualBusTypeEnum = typeof BusIOProfinetVirtualBusTypeEnum[keyof typeof BusIOProfinetVirtualBusTypeEnum];
|
|
507
|
+
|
|
508
|
+
/**
|
|
509
|
+
* @type BusIOType
|
|
510
|
+
* @export
|
|
511
|
+
*/
|
|
512
|
+
export type BusIOType = { bus_type: 'profinet' } & BusIOProfinet | { bus_type: 'profinet_virtual' } & BusIOProfinetVirtual;
|
|
513
|
+
|
|
514
|
+
/**
|
|
515
|
+
*
|
|
516
|
+
* @export
|
|
517
|
+
* @interface BusIOsState
|
|
518
|
+
*/
|
|
519
|
+
export interface BusIOsState {
|
|
520
|
+
/**
|
|
521
|
+
*
|
|
522
|
+
* @type {BusIOsStateEnum}
|
|
523
|
+
* @memberof BusIOsState
|
|
524
|
+
*/
|
|
525
|
+
'state': BusIOsStateEnum;
|
|
526
|
+
/**
|
|
527
|
+
* 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.
|
|
528
|
+
* @type {string}
|
|
529
|
+
* @memberof BusIOsState
|
|
530
|
+
*/
|
|
531
|
+
'message'?: string;
|
|
532
|
+
}
|
|
533
|
+
|
|
534
|
+
|
|
535
|
+
/**
|
|
536
|
+
* Current state of the BUS input/output service.
|
|
537
|
+
* @export
|
|
538
|
+
* @enum {string}
|
|
539
|
+
*/
|
|
540
|
+
|
|
541
|
+
export const BusIOsStateEnum = {
|
|
542
|
+
BusIosStateUnknown: 'BUS_IOS_STATE_UNKNOWN',
|
|
543
|
+
BusIosStateInitializing: 'BUS_IOS_STATE_INITIALIZING',
|
|
544
|
+
BusIosStateConnected: 'BUS_IOS_STATE_CONNECTED',
|
|
545
|
+
BusIosStateDisconnected: 'BUS_IOS_STATE_DISCONNECTED'
|
|
546
|
+
} as const;
|
|
547
|
+
|
|
548
|
+
export type BusIOsStateEnum = typeof BusIOsStateEnum[keyof typeof BusIOsStateEnum];
|
|
549
|
+
|
|
550
|
+
|
|
369
551
|
/**
|
|
370
552
|
* Defines a cylindrical shape with 2 semi-spheres on the top and bottom. Centred around origin, symmetric around z-axis.
|
|
371
553
|
* @export
|
|
@@ -514,13 +696,13 @@ export interface Collision {
|
|
|
514
696
|
* @type {string}
|
|
515
697
|
* @memberof Collision
|
|
516
698
|
*/
|
|
517
|
-
'
|
|
699
|
+
'id_of_layer'?: string;
|
|
518
700
|
/**
|
|
519
701
|
* A three-dimensional vector [x, y, z] with double precision.
|
|
520
702
|
* @type {Array<number>}
|
|
521
703
|
* @memberof Collision
|
|
522
704
|
*/
|
|
523
|
-
'
|
|
705
|
+
'normal_root_on_b'?: Array<number>;
|
|
524
706
|
/**
|
|
525
707
|
*
|
|
526
708
|
* @type {CollisionContact}
|
|
@@ -551,7 +733,7 @@ export interface CollisionContact {
|
|
|
551
733
|
* @type {Array<number>}
|
|
552
734
|
* @memberof CollisionContact
|
|
553
735
|
*/
|
|
554
|
-
'
|
|
736
|
+
'root'?: Array<number>;
|
|
555
737
|
}
|
|
556
738
|
/**
|
|
557
739
|
*
|
|
@@ -567,110 +749,42 @@ export interface CollisionError {
|
|
|
567
749
|
'collision'?: FeedbackCollision;
|
|
568
750
|
}
|
|
569
751
|
/**
|
|
570
|
-
*
|
|
752
|
+
* @type CollisionFreeAlgorithm
|
|
753
|
+
* Configuration for collision-free path planning algorithms. Different algorithms may have different parameters and behavior.
|
|
571
754
|
* @export
|
|
572
|
-
* @interface CollisionMotionGroup
|
|
573
755
|
*/
|
|
574
|
-
export
|
|
575
|
-
|
|
576
|
-
* 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.
|
|
577
|
-
* @type {Array<{ [key: string]: Collider; }>}
|
|
578
|
-
* @memberof CollisionMotionGroup
|
|
579
|
-
*/
|
|
580
|
-
'link_chain'?: Array<{ [key: string]: Collider; }>;
|
|
581
|
-
/**
|
|
582
|
-
* 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.
|
|
583
|
-
* @type {{ [key: string]: Collider; }}
|
|
584
|
-
* @memberof CollisionMotionGroup
|
|
585
|
-
*/
|
|
586
|
-
'tool'?: { [key: string]: Collider; };
|
|
587
|
-
}
|
|
756
|
+
export type CollisionFreeAlgorithm = MidpointInsertionAlgorithm | RRTConnectAlgorithm;
|
|
757
|
+
|
|
588
758
|
/**
|
|
589
759
|
*
|
|
590
760
|
* @export
|
|
591
|
-
* @interface
|
|
761
|
+
* @interface CollisionSetup
|
|
592
762
|
*/
|
|
593
|
-
export interface
|
|
594
|
-
/**
|
|
595
|
-
* References a stored link chain.
|
|
596
|
-
* @type {string}
|
|
597
|
-
* @memberof CollisionMotionGroupAssembly
|
|
598
|
-
*/
|
|
599
|
-
'stored_link_chain'?: string;
|
|
763
|
+
export interface CollisionSetup {
|
|
600
764
|
/**
|
|
601
|
-
*
|
|
602
|
-
* @type {string}
|
|
603
|
-
* @memberof
|
|
765
|
+
* A collection of identifiable colliders.
|
|
766
|
+
* @type {{ [key: string]: Collider; }}
|
|
767
|
+
* @memberof CollisionSetup
|
|
604
768
|
*/
|
|
605
|
-
'
|
|
769
|
+
'colliders'?: { [key: string]: Collider; };
|
|
606
770
|
/**
|
|
607
771
|
* 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.
|
|
608
772
|
* @type {Array<{ [key: string]: Collider; }>}
|
|
609
|
-
* @memberof
|
|
773
|
+
* @memberof CollisionSetup
|
|
610
774
|
*/
|
|
611
775
|
'link_chain'?: Array<{ [key: string]: Collider; }>;
|
|
612
776
|
/**
|
|
613
777
|
* 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.
|
|
614
778
|
* @type {{ [key: string]: Collider; }}
|
|
615
|
-
* @memberof
|
|
779
|
+
* @memberof CollisionSetup
|
|
616
780
|
*/
|
|
617
781
|
'tool'?: { [key: string]: Collider; };
|
|
618
|
-
}
|
|
619
|
-
/**
|
|
620
|
-
* 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 >> […]
|
|
621
|
-
* @export
|
|
622
|
-
* @interface CollisionScene
|
|
623
|
-
*/
|
|
624
|
-
export interface CollisionScene {
|
|
625
|
-
/**
|
|
626
|
-
* A collection of identifiable colliders.
|
|
627
|
-
* @type {{ [key: string]: Collider; }}
|
|
628
|
-
* @memberof CollisionScene
|
|
629
|
-
*/
|
|
630
|
-
'colliders'?: { [key: string]: Collider; };
|
|
631
|
-
/**
|
|
632
|
-
* 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.
|
|
633
|
-
* @type {{ [key: string]: CollisionMotionGroup; }}
|
|
634
|
-
* @memberof CollisionScene
|
|
635
|
-
*/
|
|
636
|
-
'motion_groups'?: { [key: string]: CollisionMotionGroup; };
|
|
637
|
-
}
|
|
638
|
-
/**
|
|
639
|
-
* 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)
|
|
640
|
-
* @export
|
|
641
|
-
* @interface CollisionSceneAssembly
|
|
642
|
-
*/
|
|
643
|
-
export interface CollisionSceneAssembly {
|
|
644
|
-
/**
|
|
645
|
-
* 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).
|
|
646
|
-
* @type {Array<string>}
|
|
647
|
-
* @memberof CollisionSceneAssembly
|
|
648
|
-
*/
|
|
649
|
-
'stored_scenes'?: Array<string>;
|
|
650
|
-
/**
|
|
651
|
-
*
|
|
652
|
-
* @type {CollisionScene}
|
|
653
|
-
* @memberof CollisionSceneAssembly
|
|
654
|
-
*/
|
|
655
|
-
'scene'?: CollisionScene;
|
|
656
|
-
/**
|
|
657
|
-
* Add stored colliders to the scene via their identifiers. The colliders are added to the the origin of the scene.
|
|
658
|
-
* @type {Array<string>}
|
|
659
|
-
* @memberof CollisionSceneAssembly
|
|
660
|
-
*/
|
|
661
|
-
'stored_colliders'?: Array<string>;
|
|
662
|
-
/**
|
|
663
|
-
* A collection of identifiable colliders.
|
|
664
|
-
* @type {{ [key: string]: Collider; }}
|
|
665
|
-
* @memberof CollisionSceneAssembly
|
|
666
|
-
*/
|
|
667
|
-
'colliders'?: { [key: string]: Collider; };
|
|
668
782
|
/**
|
|
669
|
-
*
|
|
670
|
-
* @type {
|
|
671
|
-
* @memberof
|
|
783
|
+
* 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.
|
|
784
|
+
* @type {boolean}
|
|
785
|
+
* @memberof CollisionSetup
|
|
672
786
|
*/
|
|
673
|
-
'
|
|
787
|
+
'self_collision_detection'?: boolean;
|
|
674
788
|
}
|
|
675
789
|
/**
|
|
676
790
|
* 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.
|
|
@@ -851,6 +965,25 @@ export interface ContainerImageSecretsInner {
|
|
|
851
965
|
*/
|
|
852
966
|
'name': string;
|
|
853
967
|
}
|
|
968
|
+
/**
|
|
969
|
+
* Additional resources that the application requires.
|
|
970
|
+
* @export
|
|
971
|
+
* @interface ContainerResources
|
|
972
|
+
*/
|
|
973
|
+
export interface ContainerResources {
|
|
974
|
+
/**
|
|
975
|
+
* Number of GPUs the application requires.
|
|
976
|
+
* @type {number}
|
|
977
|
+
* @memberof ContainerResources
|
|
978
|
+
*/
|
|
979
|
+
'intel_gpu'?: number;
|
|
980
|
+
/**
|
|
981
|
+
* The maximum memory allocated to this application.
|
|
982
|
+
* @type {string}
|
|
983
|
+
* @memberof ContainerResources
|
|
984
|
+
*/
|
|
985
|
+
'memory_limit'?: string;
|
|
986
|
+
}
|
|
854
987
|
/**
|
|
855
988
|
* The path and capacity of a volume that retains data across application restarts. The maximal requestable capacity is 300Mi. If you need more capacity consider using [storeObject](storeObject).
|
|
856
989
|
* @export
|
|
@@ -1127,24 +1260,126 @@ export type Direction = typeof Direction[keyof typeof Direction];
|
|
|
1127
1260
|
|
|
1128
1261
|
|
|
1129
1262
|
/**
|
|
1130
|
-
*
|
|
1263
|
+
* The provided joint data does not match the expected number of joints for this motion group.
|
|
1131
1264
|
* @export
|
|
1132
|
-
* @interface
|
|
1265
|
+
* @interface ErrorInvalidJointCount
|
|
1133
1266
|
*/
|
|
1134
|
-
export interface
|
|
1267
|
+
export interface ErrorInvalidJointCount {
|
|
1268
|
+
/**
|
|
1269
|
+
* The expected number of joints for this motion group.
|
|
1270
|
+
* @type {number}
|
|
1271
|
+
* @memberof ErrorInvalidJointCount
|
|
1272
|
+
*/
|
|
1273
|
+
'expected_joint_count': number;
|
|
1274
|
+
/**
|
|
1275
|
+
* The number of provided joints.
|
|
1276
|
+
* @type {number}
|
|
1277
|
+
* @memberof ErrorInvalidJointCount
|
|
1278
|
+
*/
|
|
1279
|
+
'provided_joint_count': number;
|
|
1135
1280
|
/**
|
|
1136
1281
|
*
|
|
1137
1282
|
* @type {string}
|
|
1138
|
-
* @memberof
|
|
1283
|
+
* @memberof ErrorInvalidJointCount
|
|
1139
1284
|
*/
|
|
1140
|
-
'
|
|
1285
|
+
'error_feedback_name': ErrorInvalidJointCountErrorFeedbackNameEnum;
|
|
1141
1286
|
}
|
|
1142
1287
|
|
|
1143
|
-
export const
|
|
1144
|
-
|
|
1288
|
+
export const ErrorInvalidJointCountErrorFeedbackNameEnum = {
|
|
1289
|
+
ErrorInvalidJointCount: 'ErrorInvalidJointCount'
|
|
1290
|
+
} as const;
|
|
1291
|
+
|
|
1292
|
+
export type ErrorInvalidJointCountErrorFeedbackNameEnum = typeof ErrorInvalidJointCountErrorFeedbackNameEnum[keyof typeof ErrorInvalidJointCountErrorFeedbackNameEnum];
|
|
1293
|
+
|
|
1294
|
+
/**
|
|
1295
|
+
* A reference joint position (start or target) exceeds the configured joint limits.
|
|
1296
|
+
* @export
|
|
1297
|
+
* @interface ErrorJointLimitExceeded
|
|
1298
|
+
*/
|
|
1299
|
+
export interface ErrorJointLimitExceeded {
|
|
1300
|
+
/**
|
|
1301
|
+
* Index of the joint exceeding its limits (0-based).
|
|
1302
|
+
* @type {number}
|
|
1303
|
+
* @memberof ErrorJointLimitExceeded
|
|
1304
|
+
*/
|
|
1305
|
+
'joint_index'?: number;
|
|
1306
|
+
/**
|
|
1307
|
+
*
|
|
1308
|
+
* @type {Array<number>}
|
|
1309
|
+
* @memberof ErrorJointLimitExceeded
|
|
1310
|
+
*/
|
|
1311
|
+
'joint_position'?: Array<number>;
|
|
1312
|
+
/**
|
|
1313
|
+
*
|
|
1314
|
+
* @type {string}
|
|
1315
|
+
* @memberof ErrorJointLimitExceeded
|
|
1316
|
+
*/
|
|
1317
|
+
'error_feedback_name': ErrorJointLimitExceededErrorFeedbackNameEnum;
|
|
1318
|
+
}
|
|
1319
|
+
|
|
1320
|
+
export const ErrorJointLimitExceededErrorFeedbackNameEnum = {
|
|
1321
|
+
ErrorJointLimitExceeded: 'ErrorJointLimitExceeded'
|
|
1322
|
+
} as const;
|
|
1323
|
+
|
|
1324
|
+
export type ErrorJointLimitExceededErrorFeedbackNameEnum = typeof ErrorJointLimitExceededErrorFeedbackNameEnum[keyof typeof ErrorJointLimitExceededErrorFeedbackNameEnum];
|
|
1325
|
+
|
|
1326
|
+
/**
|
|
1327
|
+
* A reference joint position (e.g. start or target joint position) results in collisions that prevent processing.
|
|
1328
|
+
* @export
|
|
1329
|
+
* @interface ErrorJointPositionCollision
|
|
1330
|
+
*/
|
|
1331
|
+
export interface ErrorJointPositionCollision {
|
|
1332
|
+
/**
|
|
1333
|
+
*
|
|
1334
|
+
* @type {Array<Collision>}
|
|
1335
|
+
* @memberof ErrorJointPositionCollision
|
|
1336
|
+
*/
|
|
1337
|
+
'collisions'?: Array<Collision>;
|
|
1338
|
+
/**
|
|
1339
|
+
*
|
|
1340
|
+
* @type {Array<number>}
|
|
1341
|
+
* @memberof ErrorJointPositionCollision
|
|
1342
|
+
*/
|
|
1343
|
+
'joint_position'?: Array<number>;
|
|
1344
|
+
/**
|
|
1345
|
+
*
|
|
1346
|
+
* @type {string}
|
|
1347
|
+
* @memberof ErrorJointPositionCollision
|
|
1348
|
+
*/
|
|
1349
|
+
'error_feedback_name': ErrorJointPositionCollisionErrorFeedbackNameEnum;
|
|
1350
|
+
}
|
|
1351
|
+
|
|
1352
|
+
export const ErrorJointPositionCollisionErrorFeedbackNameEnum = {
|
|
1353
|
+
ErrorJointPositionCollision: 'ErrorJointPositionCollision'
|
|
1354
|
+
} as const;
|
|
1355
|
+
|
|
1356
|
+
export type ErrorJointPositionCollisionErrorFeedbackNameEnum = typeof ErrorJointPositionCollisionErrorFeedbackNameEnum[keyof typeof ErrorJointPositionCollisionErrorFeedbackNameEnum];
|
|
1357
|
+
|
|
1358
|
+
/**
|
|
1359
|
+
* The collision-free planning algorithm reached its maximum iteration limit without finding a valid path. Increase max_iterations or modify the start/target positions.
|
|
1360
|
+
* @export
|
|
1361
|
+
* @interface ErrorMaxIterationsExceeded
|
|
1362
|
+
*/
|
|
1363
|
+
export interface ErrorMaxIterationsExceeded {
|
|
1364
|
+
/**
|
|
1365
|
+
* The maximum number of iterations that was reached.
|
|
1366
|
+
* @type {number}
|
|
1367
|
+
* @memberof ErrorMaxIterationsExceeded
|
|
1368
|
+
*/
|
|
1369
|
+
'max_iterations'?: number;
|
|
1370
|
+
/**
|
|
1371
|
+
*
|
|
1372
|
+
* @type {string}
|
|
1373
|
+
* @memberof ErrorMaxIterationsExceeded
|
|
1374
|
+
*/
|
|
1375
|
+
'error_feedback_name': ErrorMaxIterationsExceededErrorFeedbackNameEnum;
|
|
1376
|
+
}
|
|
1377
|
+
|
|
1378
|
+
export const ErrorMaxIterationsExceededErrorFeedbackNameEnum = {
|
|
1379
|
+
ErrorMaxIterationsExceeded: 'ErrorMaxIterationsExceeded'
|
|
1145
1380
|
} as const;
|
|
1146
1381
|
|
|
1147
|
-
export type
|
|
1382
|
+
export type ErrorMaxIterationsExceededErrorFeedbackNameEnum = typeof ErrorMaxIterationsExceededErrorFeedbackNameEnum[keyof typeof ErrorMaxIterationsExceededErrorFeedbackNameEnum];
|
|
1148
1383
|
|
|
1149
1384
|
/**
|
|
1150
1385
|
* 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.
|
|
@@ -1423,46 +1658,125 @@ export type FloatValueValueTypeEnum = typeof FloatValueValueTypeEnum[keyof typeo
|
|
|
1423
1658
|
/**
|
|
1424
1659
|
*
|
|
1425
1660
|
* @export
|
|
1426
|
-
* @interface
|
|
1661
|
+
* @interface ForwardKinematics422Response
|
|
1427
1662
|
*/
|
|
1428
|
-
export interface
|
|
1663
|
+
export interface ForwardKinematics422Response {
|
|
1429
1664
|
/**
|
|
1430
1665
|
*
|
|
1431
|
-
* @type {
|
|
1432
|
-
* @memberof
|
|
1666
|
+
* @type {Array<ForwardKinematicsValidationError>}
|
|
1667
|
+
* @memberof ForwardKinematics422Response
|
|
1433
1668
|
*/
|
|
1434
|
-
'
|
|
1669
|
+
'detail'?: Array<ForwardKinematicsValidationError>;
|
|
1435
1670
|
}
|
|
1436
|
-
|
|
1437
|
-
|
|
1438
1671
|
/**
|
|
1439
1672
|
*
|
|
1440
1673
|
* @export
|
|
1441
|
-
* @interface
|
|
1674
|
+
* @interface ForwardKinematicsRequest
|
|
1442
1675
|
*/
|
|
1443
|
-
export interface
|
|
1676
|
+
export interface ForwardKinematicsRequest {
|
|
1444
1677
|
/**
|
|
1445
|
-
*
|
|
1678
|
+
* String identifiying the model of a motion group.
|
|
1446
1679
|
* @type {string}
|
|
1447
|
-
* @memberof
|
|
1680
|
+
* @memberof ForwardKinematicsRequest
|
|
1448
1681
|
*/
|
|
1449
|
-
'
|
|
1682
|
+
'motion_group_model': string;
|
|
1450
1683
|
/**
|
|
1451
|
-
*
|
|
1452
|
-
* @type {
|
|
1453
|
-
* @memberof
|
|
1684
|
+
* List of joint positions [rad] for which TCP poses are computed.
|
|
1685
|
+
* @type {Array<Array<number>>}
|
|
1686
|
+
* @memberof ForwardKinematicsRequest
|
|
1454
1687
|
*/
|
|
1455
|
-
'
|
|
1688
|
+
'joint_positions': Array<Array<number>>;
|
|
1456
1689
|
/**
|
|
1457
|
-
*
|
|
1458
|
-
* @type {
|
|
1459
|
-
* @memberof
|
|
1690
|
+
*
|
|
1691
|
+
* @type {Pose}
|
|
1692
|
+
* @memberof ForwardKinematicsRequest
|
|
1460
1693
|
*/
|
|
1461
|
-
'
|
|
1462
|
-
|
|
1463
|
-
|
|
1464
|
-
|
|
1465
|
-
|
|
1694
|
+
'tcp_offset'?: Pose;
|
|
1695
|
+
/**
|
|
1696
|
+
* Offset from the world frame to the motion group base.
|
|
1697
|
+
* @type {Pose}
|
|
1698
|
+
* @memberof ForwardKinematicsRequest
|
|
1699
|
+
*/
|
|
1700
|
+
'mounting'?: Pose;
|
|
1701
|
+
}
|
|
1702
|
+
/**
|
|
1703
|
+
*
|
|
1704
|
+
* @export
|
|
1705
|
+
* @interface ForwardKinematicsResponse
|
|
1706
|
+
*/
|
|
1707
|
+
export interface ForwardKinematicsResponse {
|
|
1708
|
+
/**
|
|
1709
|
+
* List of computed TCP poses corresponding to the input joint positions.
|
|
1710
|
+
* @type {Array<Pose>}
|
|
1711
|
+
* @memberof ForwardKinematicsResponse
|
|
1712
|
+
*/
|
|
1713
|
+
'tcp_poses': Array<Pose>;
|
|
1714
|
+
}
|
|
1715
|
+
/**
|
|
1716
|
+
*
|
|
1717
|
+
* @export
|
|
1718
|
+
* @interface ForwardKinematicsValidationError
|
|
1719
|
+
*/
|
|
1720
|
+
export interface ForwardKinematicsValidationError {
|
|
1721
|
+
/**
|
|
1722
|
+
*
|
|
1723
|
+
* @type {Array<ValidationErrorLocInner>}
|
|
1724
|
+
* @memberof ForwardKinematicsValidationError
|
|
1725
|
+
*/
|
|
1726
|
+
'loc': Array<ValidationErrorLocInner>;
|
|
1727
|
+
/**
|
|
1728
|
+
*
|
|
1729
|
+
* @type {string}
|
|
1730
|
+
* @memberof ForwardKinematicsValidationError
|
|
1731
|
+
*/
|
|
1732
|
+
'msg': string;
|
|
1733
|
+
/**
|
|
1734
|
+
*
|
|
1735
|
+
* @type {string}
|
|
1736
|
+
* @memberof ForwardKinematicsValidationError
|
|
1737
|
+
*/
|
|
1738
|
+
'type': string;
|
|
1739
|
+
/**
|
|
1740
|
+
*
|
|
1741
|
+
* @type {{ [key: string]: any; }}
|
|
1742
|
+
* @memberof ForwardKinematicsValidationError
|
|
1743
|
+
*/
|
|
1744
|
+
'input': { [key: string]: any; };
|
|
1745
|
+
/**
|
|
1746
|
+
*
|
|
1747
|
+
* @type {ErrorInvalidJointCount}
|
|
1748
|
+
* @memberof ForwardKinematicsValidationError
|
|
1749
|
+
*/
|
|
1750
|
+
'data'?: ErrorInvalidJointCount;
|
|
1751
|
+
}
|
|
1752
|
+
/**
|
|
1753
|
+
*
|
|
1754
|
+
* @export
|
|
1755
|
+
* @interface GetTrajectoryResponse
|
|
1756
|
+
*/
|
|
1757
|
+
export interface GetTrajectoryResponse {
|
|
1758
|
+
/**
|
|
1759
|
+
* Unique identifier of the motion group the trajectory is planned for.
|
|
1760
|
+
* @type {string}
|
|
1761
|
+
* @memberof GetTrajectoryResponse
|
|
1762
|
+
*/
|
|
1763
|
+
'motion_group': string;
|
|
1764
|
+
/**
|
|
1765
|
+
* The trajectory consisting of a list of joint positions and an equal number of corresponding timestamps.
|
|
1766
|
+
* @type {JointTrajectory}
|
|
1767
|
+
* @memberof GetTrajectoryResponse
|
|
1768
|
+
*/
|
|
1769
|
+
'trajectory': JointTrajectory;
|
|
1770
|
+
/**
|
|
1771
|
+
* Unique identifier of the tool the trajectory is planned for.
|
|
1772
|
+
* @type {string}
|
|
1773
|
+
* @memberof GetTrajectoryResponse
|
|
1774
|
+
*/
|
|
1775
|
+
'tcp': string;
|
|
1776
|
+
}
|
|
1777
|
+
/**
|
|
1778
|
+
*
|
|
1779
|
+
* @export
|
|
1466
1780
|
* @interface HTTPValidationError
|
|
1467
1781
|
*/
|
|
1468
1782
|
export interface HTTPValidationError {
|
|
@@ -1947,6 +2261,19 @@ export interface InvalidDofInvalidDof {
|
|
|
1947
2261
|
*/
|
|
1948
2262
|
'joint_position'?: Array<number>;
|
|
1949
2263
|
}
|
|
2264
|
+
/**
|
|
2265
|
+
*
|
|
2266
|
+
* @export
|
|
2267
|
+
* @interface InverseKinematics422Response
|
|
2268
|
+
*/
|
|
2269
|
+
export interface InverseKinematics422Response {
|
|
2270
|
+
/**
|
|
2271
|
+
*
|
|
2272
|
+
* @type {Array<InverseKinematicsValidationError>}
|
|
2273
|
+
* @memberof InverseKinematics422Response
|
|
2274
|
+
*/
|
|
2275
|
+
'detail'?: Array<InverseKinematicsValidationError>;
|
|
2276
|
+
}
|
|
1950
2277
|
/**
|
|
1951
2278
|
*
|
|
1952
2279
|
* @export
|
|
@@ -1984,11 +2311,11 @@ export interface InverseKinematicsRequest {
|
|
|
1984
2311
|
*/
|
|
1985
2312
|
'joint_position_limits'?: Array<LimitRange>;
|
|
1986
2313
|
/**
|
|
1987
|
-
* Collision
|
|
1988
|
-
* @type {{ [key: string]:
|
|
2314
|
+
* 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.
|
|
2315
|
+
* @type {{ [key: string]: CollisionSetup; }}
|
|
1989
2316
|
* @memberof InverseKinematicsRequest
|
|
1990
2317
|
*/
|
|
1991
|
-
'
|
|
2318
|
+
'collision_setups'?: { [key: string]: CollisionSetup; };
|
|
1992
2319
|
}
|
|
1993
2320
|
/**
|
|
1994
2321
|
*
|
|
@@ -2003,6 +2330,50 @@ export interface InverseKinematicsResponse {
|
|
|
2003
2330
|
*/
|
|
2004
2331
|
'joints': Array<Array<Array<number>>>;
|
|
2005
2332
|
}
|
|
2333
|
+
/**
|
|
2334
|
+
*
|
|
2335
|
+
* @export
|
|
2336
|
+
* @interface InverseKinematicsValidationError
|
|
2337
|
+
*/
|
|
2338
|
+
export interface InverseKinematicsValidationError {
|
|
2339
|
+
/**
|
|
2340
|
+
*
|
|
2341
|
+
* @type {Array<ValidationErrorLocInner>}
|
|
2342
|
+
* @memberof InverseKinematicsValidationError
|
|
2343
|
+
*/
|
|
2344
|
+
'loc': Array<ValidationErrorLocInner>;
|
|
2345
|
+
/**
|
|
2346
|
+
*
|
|
2347
|
+
* @type {string}
|
|
2348
|
+
* @memberof InverseKinematicsValidationError
|
|
2349
|
+
*/
|
|
2350
|
+
'msg': string;
|
|
2351
|
+
/**
|
|
2352
|
+
*
|
|
2353
|
+
* @type {string}
|
|
2354
|
+
* @memberof InverseKinematicsValidationError
|
|
2355
|
+
*/
|
|
2356
|
+
'type': string;
|
|
2357
|
+
/**
|
|
2358
|
+
*
|
|
2359
|
+
* @type {{ [key: string]: any; }}
|
|
2360
|
+
* @memberof InverseKinematicsValidationError
|
|
2361
|
+
*/
|
|
2362
|
+
'input': { [key: string]: any; };
|
|
2363
|
+
/**
|
|
2364
|
+
*
|
|
2365
|
+
* @type {InverseKinematicsValidationErrorAllOfData}
|
|
2366
|
+
* @memberof InverseKinematicsValidationError
|
|
2367
|
+
*/
|
|
2368
|
+
'data'?: InverseKinematicsValidationErrorAllOfData;
|
|
2369
|
+
}
|
|
2370
|
+
/**
|
|
2371
|
+
* @type InverseKinematicsValidationErrorAllOfData
|
|
2372
|
+
* Optional data further specifying the validation error.
|
|
2373
|
+
* @export
|
|
2374
|
+
*/
|
|
2375
|
+
export type InverseKinematicsValidationErrorAllOfData = { error_feedback_name: 'ErrorInvalidJointCount' } & ErrorInvalidJointCount | { error_feedback_name: 'ErrorJointLimitExceeded' } & ErrorJointLimitExceeded;
|
|
2376
|
+
|
|
2006
2377
|
/**
|
|
2007
2378
|
* 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.
|
|
2008
2379
|
* @export
|
|
@@ -2033,7 +2404,119 @@ export type JoggingDetailsKindEnum = typeof JoggingDetailsKindEnum[keyof typeof
|
|
|
2033
2404
|
* @type JoggingDetailsState
|
|
2034
2405
|
* @export
|
|
2035
2406
|
*/
|
|
2036
|
-
export type JoggingDetailsState =
|
|
2407
|
+
export type JoggingDetailsState = JoggingPausedByUser | JoggingPausedNearCollision | JoggingPausedNearJointLimit | JoggingPausedOnIO | JoggingRunning;
|
|
2408
|
+
|
|
2409
|
+
/**
|
|
2410
|
+
*
|
|
2411
|
+
* @export
|
|
2412
|
+
* @interface JoggingPausedByUser
|
|
2413
|
+
*/
|
|
2414
|
+
export interface JoggingPausedByUser {
|
|
2415
|
+
/**
|
|
2416
|
+
*
|
|
2417
|
+
* @type {string}
|
|
2418
|
+
* @memberof JoggingPausedByUser
|
|
2419
|
+
*/
|
|
2420
|
+
'kind': JoggingPausedByUserKindEnum;
|
|
2421
|
+
}
|
|
2422
|
+
|
|
2423
|
+
export const JoggingPausedByUserKindEnum = {
|
|
2424
|
+
PausedByUser: 'PAUSED_BY_USER'
|
|
2425
|
+
} as const;
|
|
2426
|
+
|
|
2427
|
+
export type JoggingPausedByUserKindEnum = typeof JoggingPausedByUserKindEnum[keyof typeof JoggingPausedByUserKindEnum];
|
|
2428
|
+
|
|
2429
|
+
/**
|
|
2430
|
+
*
|
|
2431
|
+
* @export
|
|
2432
|
+
* @interface JoggingPausedNearCollision
|
|
2433
|
+
*/
|
|
2434
|
+
export interface JoggingPausedNearCollision {
|
|
2435
|
+
/**
|
|
2436
|
+
*
|
|
2437
|
+
* @type {string}
|
|
2438
|
+
* @memberof JoggingPausedNearCollision
|
|
2439
|
+
*/
|
|
2440
|
+
'kind': JoggingPausedNearCollisionKindEnum;
|
|
2441
|
+
/**
|
|
2442
|
+
*
|
|
2443
|
+
* @type {string}
|
|
2444
|
+
* @memberof JoggingPausedNearCollision
|
|
2445
|
+
*/
|
|
2446
|
+
'description': string;
|
|
2447
|
+
}
|
|
2448
|
+
|
|
2449
|
+
export const JoggingPausedNearCollisionKindEnum = {
|
|
2450
|
+
PausedNearCollision: 'PAUSED_NEAR_COLLISION'
|
|
2451
|
+
} as const;
|
|
2452
|
+
|
|
2453
|
+
export type JoggingPausedNearCollisionKindEnum = typeof JoggingPausedNearCollisionKindEnum[keyof typeof JoggingPausedNearCollisionKindEnum];
|
|
2454
|
+
|
|
2455
|
+
/**
|
|
2456
|
+
*
|
|
2457
|
+
* @export
|
|
2458
|
+
* @interface JoggingPausedNearJointLimit
|
|
2459
|
+
*/
|
|
2460
|
+
export interface JoggingPausedNearJointLimit {
|
|
2461
|
+
/**
|
|
2462
|
+
*
|
|
2463
|
+
* @type {string}
|
|
2464
|
+
* @memberof JoggingPausedNearJointLimit
|
|
2465
|
+
*/
|
|
2466
|
+
'kind': JoggingPausedNearJointLimitKindEnum;
|
|
2467
|
+
/**
|
|
2468
|
+
*
|
|
2469
|
+
* @type {Array<number>}
|
|
2470
|
+
* @memberof JoggingPausedNearJointLimit
|
|
2471
|
+
*/
|
|
2472
|
+
'joint_indices': Array<number>;
|
|
2473
|
+
}
|
|
2474
|
+
|
|
2475
|
+
export const JoggingPausedNearJointLimitKindEnum = {
|
|
2476
|
+
PausedNearJointLimit: 'PAUSED_NEAR_JOINT_LIMIT'
|
|
2477
|
+
} as const;
|
|
2478
|
+
|
|
2479
|
+
export type JoggingPausedNearJointLimitKindEnum = typeof JoggingPausedNearJointLimitKindEnum[keyof typeof JoggingPausedNearJointLimitKindEnum];
|
|
2480
|
+
|
|
2481
|
+
/**
|
|
2482
|
+
*
|
|
2483
|
+
* @export
|
|
2484
|
+
* @interface JoggingPausedOnIO
|
|
2485
|
+
*/
|
|
2486
|
+
export interface JoggingPausedOnIO {
|
|
2487
|
+
/**
|
|
2488
|
+
*
|
|
2489
|
+
* @type {string}
|
|
2490
|
+
* @memberof JoggingPausedOnIO
|
|
2491
|
+
*/
|
|
2492
|
+
'kind': JoggingPausedOnIOKindEnum;
|
|
2493
|
+
}
|
|
2494
|
+
|
|
2495
|
+
export const JoggingPausedOnIOKindEnum = {
|
|
2496
|
+
PausedOnIo: 'PAUSED_ON_IO'
|
|
2497
|
+
} as const;
|
|
2498
|
+
|
|
2499
|
+
export type JoggingPausedOnIOKindEnum = typeof JoggingPausedOnIOKindEnum[keyof typeof JoggingPausedOnIOKindEnum];
|
|
2500
|
+
|
|
2501
|
+
/**
|
|
2502
|
+
*
|
|
2503
|
+
* @export
|
|
2504
|
+
* @interface JoggingRunning
|
|
2505
|
+
*/
|
|
2506
|
+
export interface JoggingRunning {
|
|
2507
|
+
/**
|
|
2508
|
+
*
|
|
2509
|
+
* @type {string}
|
|
2510
|
+
* @memberof JoggingRunning
|
|
2511
|
+
*/
|
|
2512
|
+
'kind': JoggingRunningKindEnum;
|
|
2513
|
+
}
|
|
2514
|
+
|
|
2515
|
+
export const JoggingRunningKindEnum = {
|
|
2516
|
+
Running: 'RUNNING'
|
|
2517
|
+
} as const;
|
|
2518
|
+
|
|
2519
|
+
export type JoggingRunningKindEnum = typeof JoggingRunningKindEnum[keyof typeof JoggingRunningKindEnum];
|
|
2037
2520
|
|
|
2038
2521
|
/**
|
|
2039
2522
|
*
|
|
@@ -2087,10 +2570,10 @@ export interface JointLimits {
|
|
|
2087
2570
|
export interface JointTrajectory {
|
|
2088
2571
|
/**
|
|
2089
2572
|
* List of joint positions [rad] for each sample. The number of samples must match the number of timestamps provided in the times field.
|
|
2090
|
-
* @type {Array<
|
|
2573
|
+
* @type {Array<Array<number>>}
|
|
2091
2574
|
* @memberof JointTrajectory
|
|
2092
2575
|
*/
|
|
2093
|
-
'joint_positions': Array<
|
|
2576
|
+
'joint_positions': Array<Array<number>>;
|
|
2094
2577
|
/**
|
|
2095
2578
|
* Timestamp for each sample [s].
|
|
2096
2579
|
* @type {Array<number>}
|
|
@@ -2117,11 +2600,11 @@ export interface JointVelocityRequest {
|
|
|
2117
2600
|
*/
|
|
2118
2601
|
'message_type'?: JointVelocityRequestMessageTypeEnum;
|
|
2119
2602
|
/**
|
|
2120
|
-
*
|
|
2121
|
-
* @type {
|
|
2603
|
+
* This structure describes a set of joint values (e.g. positions, currents, torques) of a motion group. Float precision is the default.
|
|
2604
|
+
* @type {Array<number>}
|
|
2122
2605
|
* @memberof JointVelocityRequest
|
|
2123
2606
|
*/
|
|
2124
|
-
'velocity':
|
|
2607
|
+
'velocity': Array<number>;
|
|
2125
2608
|
}
|
|
2126
2609
|
|
|
2127
2610
|
export const JointVelocityRequestMessageTypeEnum = {
|
|
@@ -2156,19 +2639,6 @@ export const JointVelocityResponseKindEnum = {
|
|
|
2156
2639
|
|
|
2157
2640
|
export type JointVelocityResponseKindEnum = typeof JointVelocityResponseKindEnum[keyof typeof JointVelocityResponseKindEnum];
|
|
2158
2641
|
|
|
2159
|
-
/**
|
|
2160
|
-
* This structure describes a set of joint values of a motion group. We call a set of joint values describing the current position in joint space of a motion group a \"joint position\". Joint position was chosen as the term to be consistent with the terms \"joint velocity\" and \"joint acceleration\". `joints` must have as many entries as the motion group\'s degrees of freedom to be valid. Float precision is the default.
|
|
2161
|
-
* @export
|
|
2162
|
-
* @interface Joints
|
|
2163
|
-
*/
|
|
2164
|
-
export interface Joints {
|
|
2165
|
-
/**
|
|
2166
|
-
*
|
|
2167
|
-
* @type {Array<number>}
|
|
2168
|
-
* @memberof Joints
|
|
2169
|
-
*/
|
|
2170
|
-
'joints': Array<number>;
|
|
2171
|
-
}
|
|
2172
2642
|
/**
|
|
2173
2643
|
* The configuration of a physical KUKA robot controller has to contain an IP address. Additionally an RSI server configuration has to be specified in order to control the robot. Deploying the server is a functionality of this API.
|
|
2174
2644
|
* @export
|
|
@@ -2473,6 +2943,32 @@ export const Manufacturer = {
|
|
|
2473
2943
|
export type Manufacturer = typeof Manufacturer[keyof typeof Manufacturer];
|
|
2474
2944
|
|
|
2475
2945
|
|
|
2946
|
+
/**
|
|
2947
|
+
* 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.
|
|
2948
|
+
* @export
|
|
2949
|
+
* @interface MidpointInsertionAlgorithm
|
|
2950
|
+
*/
|
|
2951
|
+
export interface MidpointInsertionAlgorithm {
|
|
2952
|
+
/**
|
|
2953
|
+
* Algorithm discriminator.
|
|
2954
|
+
* @type {string}
|
|
2955
|
+
* @memberof MidpointInsertionAlgorithm
|
|
2956
|
+
*/
|
|
2957
|
+
'algorithm_name': MidpointInsertionAlgorithmAlgorithmNameEnum;
|
|
2958
|
+
/**
|
|
2959
|
+
* Maximum number of iterations for the midpoint insertion algorithm. Higher values increase likelyhood of success, but also computation time (linear).
|
|
2960
|
+
* @type {number}
|
|
2961
|
+
* @memberof MidpointInsertionAlgorithm
|
|
2962
|
+
*/
|
|
2963
|
+
'max_iterations'?: number;
|
|
2964
|
+
}
|
|
2965
|
+
|
|
2966
|
+
export const MidpointInsertionAlgorithmAlgorithmNameEnum = {
|
|
2967
|
+
MidpointInsertionAlgorithm: 'MidpointInsertionAlgorithm'
|
|
2968
|
+
} as const;
|
|
2969
|
+
|
|
2970
|
+
export type MidpointInsertionAlgorithmAlgorithmNameEnum = typeof MidpointInsertionAlgorithmAlgorithmNameEnum[keyof typeof MidpointInsertionAlgorithmAlgorithmNameEnum];
|
|
2971
|
+
|
|
2476
2972
|
/**
|
|
2477
2973
|
*
|
|
2478
2974
|
* @export
|
|
@@ -2653,6 +3149,55 @@ export interface MotionGroupJoints {
|
|
|
2653
3149
|
*/
|
|
2654
3150
|
'torques'?: Array<number>;
|
|
2655
3151
|
}
|
|
3152
|
+
/**
|
|
3153
|
+
*
|
|
3154
|
+
* @export
|
|
3155
|
+
* @interface MotionGroupSetup
|
|
3156
|
+
*/
|
|
3157
|
+
export interface MotionGroupSetup {
|
|
3158
|
+
/**
|
|
3159
|
+
* String identifiying the model of a motion group.
|
|
3160
|
+
* @type {string}
|
|
3161
|
+
* @memberof MotionGroupSetup
|
|
3162
|
+
*/
|
|
3163
|
+
'motion_group_model': string;
|
|
3164
|
+
/**
|
|
3165
|
+
* [ms] cycle time of the motion group controller. A trajectory for this motion group should be computed to this resolution.
|
|
3166
|
+
* @type {number}
|
|
3167
|
+
* @memberof MotionGroupSetup
|
|
3168
|
+
*/
|
|
3169
|
+
'cycle_time': number;
|
|
3170
|
+
/**
|
|
3171
|
+
* The offset from the world frame to the motion group base.
|
|
3172
|
+
* @type {Pose}
|
|
3173
|
+
* @memberof MotionGroupSetup
|
|
3174
|
+
*/
|
|
3175
|
+
'mounting'?: Pose;
|
|
3176
|
+
/**
|
|
3177
|
+
*
|
|
3178
|
+
* @type {Pose}
|
|
3179
|
+
* @memberof MotionGroupSetup
|
|
3180
|
+
*/
|
|
3181
|
+
'tcp_offset'?: Pose;
|
|
3182
|
+
/**
|
|
3183
|
+
*
|
|
3184
|
+
* @type {LimitSet}
|
|
3185
|
+
* @memberof MotionGroupSetup
|
|
3186
|
+
*/
|
|
3187
|
+
'global_limits'?: LimitSet;
|
|
3188
|
+
/**
|
|
3189
|
+
*
|
|
3190
|
+
* @type {Payload}
|
|
3191
|
+
* @memberof MotionGroupSetup
|
|
3192
|
+
*/
|
|
3193
|
+
'payload'?: Payload;
|
|
3194
|
+
/**
|
|
3195
|
+
* 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.
|
|
3196
|
+
* @type {{ [key: string]: CollisionSetup; }}
|
|
3197
|
+
* @memberof MotionGroupSetup
|
|
3198
|
+
*/
|
|
3199
|
+
'collision_setups'?: { [key: string]: CollisionSetup; };
|
|
3200
|
+
}
|
|
2656
3201
|
/**
|
|
2657
3202
|
* Presents the current state of the motion group.
|
|
2658
3203
|
* @export
|
|
@@ -2684,11 +3229,11 @@ export interface MotionGroupState {
|
|
|
2684
3229
|
*/
|
|
2685
3230
|
'controller': string;
|
|
2686
3231
|
/**
|
|
2687
|
-
*
|
|
2688
|
-
* @type {
|
|
3232
|
+
* This structure describes a set of joint values (e.g. positions, currents, torques) of a motion group. Float precision is the default.
|
|
3233
|
+
* @type {Array<number>}
|
|
2689
3234
|
* @memberof MotionGroupState
|
|
2690
3235
|
*/
|
|
2691
|
-
'joint_position':
|
|
3236
|
+
'joint_position': Array<number>;
|
|
2692
3237
|
/**
|
|
2693
3238
|
* Indicates whether the joint is in a limit for all joints of the motion group.
|
|
2694
3239
|
* @type {MotionGroupStateJointLimitReached}
|
|
@@ -2696,17 +3241,17 @@ export interface MotionGroupState {
|
|
|
2696
3241
|
*/
|
|
2697
3242
|
'joint_limit_reached': MotionGroupStateJointLimitReached;
|
|
2698
3243
|
/**
|
|
2699
|
-
*
|
|
2700
|
-
* @type {
|
|
3244
|
+
* This structure describes a set of joint values (e.g. positions, currents, torques) of a motion group. Float precision is the default.
|
|
3245
|
+
* @type {Array<number>}
|
|
2701
3246
|
* @memberof MotionGroupState
|
|
2702
3247
|
*/
|
|
2703
|
-
'joint_torque'?:
|
|
3248
|
+
'joint_torque'?: Array<number>;
|
|
2704
3249
|
/**
|
|
2705
|
-
*
|
|
2706
|
-
* @type {
|
|
3250
|
+
* This structure describes a set of joint values (e.g. positions, currents, torques) of a motion group. Float precision is the default.
|
|
3251
|
+
* @type {Array<number>}
|
|
2707
3252
|
* @memberof MotionGroupState
|
|
2708
3253
|
*/
|
|
2709
|
-
'joint_current'?:
|
|
3254
|
+
'joint_current'?: Array<number>;
|
|
2710
3255
|
/**
|
|
2711
3256
|
* Pose of the flange. Positions are in [mm]. Oriantations are in [rad]. The pose is relative to the response_coordinate_system specified in the request. For robot arms a flange pose is always returned, for positioners the flange might not be available, depending on the model.
|
|
2712
3257
|
* @type {Pose}
|
|
@@ -3187,146 +3732,110 @@ export interface PauseOnIO {
|
|
|
3187
3732
|
/**
|
|
3188
3733
|
*
|
|
3189
3734
|
* @export
|
|
3190
|
-
* @interface
|
|
3735
|
+
* @interface Payload
|
|
3191
3736
|
*/
|
|
3192
|
-
export interface
|
|
3737
|
+
export interface Payload {
|
|
3193
3738
|
/**
|
|
3194
3739
|
*
|
|
3195
3740
|
* @type {string}
|
|
3196
|
-
* @memberof
|
|
3741
|
+
* @memberof Payload
|
|
3197
3742
|
*/
|
|
3198
|
-
'
|
|
3743
|
+
'name': string;
|
|
3744
|
+
/**
|
|
3745
|
+
* Mass of payload in [kg].
|
|
3746
|
+
* @type {number}
|
|
3747
|
+
* @memberof Payload
|
|
3748
|
+
*/
|
|
3749
|
+
'payload': number;
|
|
3750
|
+
/**
|
|
3751
|
+
* A three-dimensional vector [x, y, z] with double precision.
|
|
3752
|
+
* @type {Array<number>}
|
|
3753
|
+
* @memberof Payload
|
|
3754
|
+
*/
|
|
3755
|
+
'center_of_mass'?: Array<number>;
|
|
3756
|
+
/**
|
|
3757
|
+
* A three-dimensional vector [x, y, z] with double precision.
|
|
3758
|
+
* @type {Array<number>}
|
|
3759
|
+
* @memberof Payload
|
|
3760
|
+
*/
|
|
3761
|
+
'moment_of_inertia'?: Array<number>;
|
|
3199
3762
|
}
|
|
3200
|
-
|
|
3201
|
-
export const PausedByRequestKindEnum = {
|
|
3202
|
-
PausedByUser: 'PAUSED_BY_USER'
|
|
3203
|
-
} as const;
|
|
3204
|
-
|
|
3205
|
-
export type PausedByRequestKindEnum = typeof PausedByRequestKindEnum[keyof typeof PausedByRequestKindEnum];
|
|
3206
|
-
|
|
3207
3763
|
/**
|
|
3208
3764
|
*
|
|
3209
3765
|
* @export
|
|
3210
|
-
* @interface
|
|
3766
|
+
* @interface Plan422Response
|
|
3211
3767
|
*/
|
|
3212
|
-
export interface
|
|
3768
|
+
export interface Plan422Response {
|
|
3213
3769
|
/**
|
|
3214
3770
|
*
|
|
3215
|
-
* @type {
|
|
3216
|
-
* @memberof
|
|
3771
|
+
* @type {Array<PlanValidationError>}
|
|
3772
|
+
* @memberof Plan422Response
|
|
3217
3773
|
*/
|
|
3218
|
-
'
|
|
3774
|
+
'detail'?: Array<PlanValidationError>;
|
|
3219
3775
|
}
|
|
3220
|
-
|
|
3221
|
-
export const PausedByUserKindEnum = {
|
|
3222
|
-
PausedByUser: 'PAUSED_BY_USER'
|
|
3223
|
-
} as const;
|
|
3224
|
-
|
|
3225
|
-
export type PausedByUserKindEnum = typeof PausedByUserKindEnum[keyof typeof PausedByUserKindEnum];
|
|
3226
|
-
|
|
3227
3776
|
/**
|
|
3228
|
-
*
|
|
3777
|
+
* Response when collision-free trajectory planning fails. Contains specific feedback about why the planning failed.
|
|
3229
3778
|
* @export
|
|
3230
|
-
* @interface
|
|
3779
|
+
* @interface PlanCollisionFreeFailedResponse
|
|
3231
3780
|
*/
|
|
3232
|
-
export interface
|
|
3233
|
-
/**
|
|
3234
|
-
*
|
|
3235
|
-
* @type {string}
|
|
3236
|
-
* @memberof PausedNearCollision
|
|
3237
|
-
*/
|
|
3238
|
-
'kind': PausedNearCollisionKindEnum;
|
|
3781
|
+
export interface PlanCollisionFreeFailedResponse {
|
|
3239
3782
|
/**
|
|
3240
3783
|
*
|
|
3241
|
-
* @type {
|
|
3242
|
-
* @memberof
|
|
3784
|
+
* @type {ErrorMaxIterationsExceeded}
|
|
3785
|
+
* @memberof PlanCollisionFreeFailedResponse
|
|
3243
3786
|
*/
|
|
3244
|
-
'
|
|
3787
|
+
'error_feedback': ErrorMaxIterationsExceeded;
|
|
3245
3788
|
}
|
|
3246
|
-
|
|
3247
|
-
export const PausedNearCollisionKindEnum = {
|
|
3248
|
-
PausedNearCollision: 'PAUSED_NEAR_COLLISION'
|
|
3249
|
-
} as const;
|
|
3250
|
-
|
|
3251
|
-
export type PausedNearCollisionKindEnum = typeof PausedNearCollisionKindEnum[keyof typeof PausedNearCollisionKindEnum];
|
|
3252
|
-
|
|
3253
3789
|
/**
|
|
3254
3790
|
*
|
|
3255
3791
|
* @export
|
|
3256
|
-
* @interface
|
|
3792
|
+
* @interface PlanCollisionFreeRequest
|
|
3257
3793
|
*/
|
|
3258
|
-
export interface
|
|
3794
|
+
export interface PlanCollisionFreeRequest {
|
|
3795
|
+
/**
|
|
3796
|
+
* The data to assemble the robot setup can be retrieved from [getMotionGroupDescription](getMotionGroupDescription) endpoint.
|
|
3797
|
+
* @type {MotionGroupSetup}
|
|
3798
|
+
* @memberof PlanCollisionFreeRequest
|
|
3799
|
+
*/
|
|
3800
|
+
'motion_group_setup': MotionGroupSetup;
|
|
3259
3801
|
/**
|
|
3260
3802
|
*
|
|
3261
|
-
* @type {
|
|
3262
|
-
* @memberof
|
|
3803
|
+
* @type {Array<number>}
|
|
3804
|
+
* @memberof PlanCollisionFreeRequest
|
|
3263
3805
|
*/
|
|
3264
|
-
'
|
|
3806
|
+
'start_joint_position': Array<number>;
|
|
3265
3807
|
/**
|
|
3266
3808
|
*
|
|
3267
3809
|
* @type {Array<number>}
|
|
3268
|
-
* @memberof
|
|
3810
|
+
* @memberof PlanCollisionFreeRequest
|
|
3269
3811
|
*/
|
|
3270
|
-
'
|
|
3271
|
-
}
|
|
3272
|
-
|
|
3273
|
-
export const PausedNearJointLimitKindEnum = {
|
|
3274
|
-
PausedNearJointLimit: 'PAUSED_NEAR_JOINT_LIMIT'
|
|
3275
|
-
} as const;
|
|
3276
|
-
|
|
3277
|
-
export type PausedNearJointLimitKindEnum = typeof PausedNearJointLimitKindEnum[keyof typeof PausedNearJointLimitKindEnum];
|
|
3278
|
-
|
|
3279
|
-
/**
|
|
3280
|
-
*
|
|
3281
|
-
* @export
|
|
3282
|
-
* @interface PausedOnIO
|
|
3283
|
-
*/
|
|
3284
|
-
export interface PausedOnIO {
|
|
3812
|
+
'target': Array<number>;
|
|
3285
3813
|
/**
|
|
3286
3814
|
*
|
|
3287
|
-
* @type {
|
|
3288
|
-
* @memberof
|
|
3815
|
+
* @type {CollisionFreeAlgorithm}
|
|
3816
|
+
* @memberof PlanCollisionFreeRequest
|
|
3289
3817
|
*/
|
|
3290
|
-
'
|
|
3818
|
+
'algorithm': CollisionFreeAlgorithm;
|
|
3291
3819
|
}
|
|
3292
|
-
|
|
3293
|
-
export const PausedOnIOKindEnum = {
|
|
3294
|
-
PausedOnIo: 'PAUSED_ON_IO'
|
|
3295
|
-
} as const;
|
|
3296
|
-
|
|
3297
|
-
export type PausedOnIOKindEnum = typeof PausedOnIOKindEnum[keyof typeof PausedOnIOKindEnum];
|
|
3298
|
-
|
|
3299
3820
|
/**
|
|
3300
|
-
*
|
|
3821
|
+
* Response from collision-free trajectory planning. Contains either a successful joint trajectory or failure information.
|
|
3301
3822
|
* @export
|
|
3302
|
-
* @interface
|
|
3823
|
+
* @interface PlanCollisionFreeResponse
|
|
3303
3824
|
*/
|
|
3304
|
-
export interface
|
|
3825
|
+
export interface PlanCollisionFreeResponse {
|
|
3305
3826
|
/**
|
|
3306
3827
|
*
|
|
3307
|
-
* @type {
|
|
3308
|
-
* @memberof
|
|
3309
|
-
*/
|
|
3310
|
-
'name': string;
|
|
3311
|
-
/**
|
|
3312
|
-
* Mass of payload in [kg].
|
|
3313
|
-
* @type {number}
|
|
3314
|
-
* @memberof Payload
|
|
3315
|
-
*/
|
|
3316
|
-
'payload': number;
|
|
3317
|
-
/**
|
|
3318
|
-
* A three-dimensional vector [x, y, z] with double precision.
|
|
3319
|
-
* @type {Array<number>}
|
|
3320
|
-
* @memberof Payload
|
|
3321
|
-
*/
|
|
3322
|
-
'center_of_mass'?: Array<number>;
|
|
3323
|
-
/**
|
|
3324
|
-
* A three-dimensional vector [x, y, z] with double precision.
|
|
3325
|
-
* @type {Array<number>}
|
|
3326
|
-
* @memberof Payload
|
|
3828
|
+
* @type {PlanCollisionFreeResponseResponse}
|
|
3829
|
+
* @memberof PlanCollisionFreeResponse
|
|
3327
3830
|
*/
|
|
3328
|
-
'
|
|
3831
|
+
'response': PlanCollisionFreeResponseResponse;
|
|
3329
3832
|
}
|
|
3833
|
+
/**
|
|
3834
|
+
* @type PlanCollisionFreeResponseResponse
|
|
3835
|
+
* @export
|
|
3836
|
+
*/
|
|
3837
|
+
export type PlanCollisionFreeResponseResponse = JointTrajectory | PlanCollisionFreeFailedResponse;
|
|
3838
|
+
|
|
3330
3839
|
/**
|
|
3331
3840
|
*
|
|
3332
3841
|
* @export
|
|
@@ -3366,10 +3875,10 @@ export type PlanTrajectoryFailedResponseErrorFeedback = FeedbackCollision | Feed
|
|
|
3366
3875
|
export interface PlanTrajectoryRequest {
|
|
3367
3876
|
/**
|
|
3368
3877
|
* The data to assemble the robot setup can be retrieved from [getMotionGroupDescription](getMotionGroupDescription) endpoint.
|
|
3369
|
-
* @type {
|
|
3878
|
+
* @type {MotionGroupSetup}
|
|
3370
3879
|
* @memberof PlanTrajectoryRequest
|
|
3371
3880
|
*/
|
|
3372
|
-
'
|
|
3881
|
+
'motion_group_setup': MotionGroupSetup;
|
|
3373
3882
|
/**
|
|
3374
3883
|
*
|
|
3375
3884
|
* @type {Array<number>}
|
|
@@ -3402,6 +3911,50 @@ export interface PlanTrajectoryResponse {
|
|
|
3402
3911
|
*/
|
|
3403
3912
|
export type PlanTrajectoryResponseResponse = JointTrajectory | PlanTrajectoryFailedResponse;
|
|
3404
3913
|
|
|
3914
|
+
/**
|
|
3915
|
+
*
|
|
3916
|
+
* @export
|
|
3917
|
+
* @interface PlanValidationError
|
|
3918
|
+
*/
|
|
3919
|
+
export interface PlanValidationError {
|
|
3920
|
+
/**
|
|
3921
|
+
*
|
|
3922
|
+
* @type {Array<ValidationErrorLocInner>}
|
|
3923
|
+
* @memberof PlanValidationError
|
|
3924
|
+
*/
|
|
3925
|
+
'loc': Array<ValidationErrorLocInner>;
|
|
3926
|
+
/**
|
|
3927
|
+
*
|
|
3928
|
+
* @type {string}
|
|
3929
|
+
* @memberof PlanValidationError
|
|
3930
|
+
*/
|
|
3931
|
+
'msg': string;
|
|
3932
|
+
/**
|
|
3933
|
+
*
|
|
3934
|
+
* @type {string}
|
|
3935
|
+
* @memberof PlanValidationError
|
|
3936
|
+
*/
|
|
3937
|
+
'type': string;
|
|
3938
|
+
/**
|
|
3939
|
+
*
|
|
3940
|
+
* @type {{ [key: string]: any; }}
|
|
3941
|
+
* @memberof PlanValidationError
|
|
3942
|
+
*/
|
|
3943
|
+
'input': { [key: string]: any; };
|
|
3944
|
+
/**
|
|
3945
|
+
*
|
|
3946
|
+
* @type {PlanValidationErrorAllOfData}
|
|
3947
|
+
* @memberof PlanValidationError
|
|
3948
|
+
*/
|
|
3949
|
+
'data'?: PlanValidationErrorAllOfData;
|
|
3950
|
+
}
|
|
3951
|
+
/**
|
|
3952
|
+
* @type PlanValidationErrorAllOfData
|
|
3953
|
+
* Optional data further specifying the validation error.
|
|
3954
|
+
* @export
|
|
3955
|
+
*/
|
|
3956
|
+
export type PlanValidationErrorAllOfData = { error_feedback_name: 'ErrorInvalidJointCount' } & ErrorInvalidJointCount | { error_feedback_name: 'ErrorJointLimitExceeded' } & ErrorJointLimitExceeded | { error_feedback_name: 'ErrorJointPositionCollision' } & ErrorJointPositionCollision;
|
|
3957
|
+
|
|
3405
3958
|
/**
|
|
3406
3959
|
* Defines an x/y-plane with infinite size.
|
|
3407
3960
|
* @export
|
|
@@ -3494,226 +4047,448 @@ export interface Pose {
|
|
|
3494
4047
|
'orientation'?: Array<number>;
|
|
3495
4048
|
}
|
|
3496
4049
|
/**
|
|
3497
|
-
*
|
|
4050
|
+
*
|
|
3498
4051
|
* @export
|
|
3499
|
-
* @interface
|
|
4052
|
+
* @interface ProfinetDescription
|
|
3500
4053
|
*/
|
|
3501
|
-
export interface
|
|
4054
|
+
export interface ProfinetDescription {
|
|
4055
|
+
/**
|
|
4056
|
+
* The vendor identifier of the PROFINET device, identifying the manufacturer.
|
|
4057
|
+
* @type {string}
|
|
4058
|
+
* @memberof ProfinetDescription
|
|
4059
|
+
*/
|
|
4060
|
+
'vendor_id': string;
|
|
4061
|
+
/**
|
|
4062
|
+
* The device identifier of the PROFINET device, identifying the specific device within the vendor\'s range.
|
|
4063
|
+
* @type {string}
|
|
4064
|
+
* @memberof ProfinetDescription
|
|
4065
|
+
*/
|
|
4066
|
+
'device_id': string;
|
|
3502
4067
|
/**
|
|
3503
4068
|
*
|
|
4069
|
+
* @type {Array<ProfinetSlotDescription>}
|
|
4070
|
+
* @memberof ProfinetDescription
|
|
4071
|
+
*/
|
|
4072
|
+
'slots'?: Array<ProfinetSlotDescription>;
|
|
4073
|
+
/**
|
|
4074
|
+
* Name of the PROFINET device
|
|
3504
4075
|
* @type {string}
|
|
3505
|
-
* @memberof
|
|
4076
|
+
* @memberof ProfinetDescription
|
|
3506
4077
|
*/
|
|
3507
|
-
'
|
|
4078
|
+
'device_name'?: string;
|
|
3508
4079
|
/**
|
|
3509
|
-
*
|
|
4080
|
+
* IP address for the PROFINET device
|
|
4081
|
+
* @type {string}
|
|
4082
|
+
* @memberof ProfinetDescription
|
|
4083
|
+
*/
|
|
4084
|
+
'ip'?: string;
|
|
4085
|
+
}
|
|
4086
|
+
/**
|
|
4087
|
+
*
|
|
4088
|
+
* @export
|
|
4089
|
+
* @interface ProfinetIO
|
|
4090
|
+
*/
|
|
4091
|
+
export interface ProfinetIO {
|
|
4092
|
+
/**
|
|
4093
|
+
* 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.
|
|
4094
|
+
* @type {string}
|
|
4095
|
+
* @memberof ProfinetIO
|
|
4096
|
+
*/
|
|
4097
|
+
'name': string;
|
|
4098
|
+
/**
|
|
4099
|
+
*
|
|
4100
|
+
* @type {ProfinetIOTypeEnum}
|
|
4101
|
+
* @memberof ProfinetIO
|
|
4102
|
+
*/
|
|
4103
|
+
'type': ProfinetIOTypeEnum;
|
|
4104
|
+
/**
|
|
4105
|
+
* The direction of the input/output value, indicating whether it is an input or output for the device.
|
|
4106
|
+
* @type {ProfinetIODirection}
|
|
4107
|
+
* @memberof ProfinetIO
|
|
4108
|
+
*/
|
|
4109
|
+
'direction': ProfinetIODirection;
|
|
4110
|
+
/**
|
|
4111
|
+
* 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.
|
|
3510
4112
|
* @type {number}
|
|
3511
|
-
* @memberof
|
|
4113
|
+
* @memberof ProfinetIO
|
|
3512
4114
|
*/
|
|
3513
|
-
'
|
|
4115
|
+
'byte_address': number;
|
|
3514
4116
|
/**
|
|
3515
|
-
* The
|
|
4117
|
+
* 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.
|
|
3516
4118
|
* @type {number}
|
|
3517
|
-
* @memberof
|
|
4119
|
+
* @memberof ProfinetIO
|
|
3518
4120
|
*/
|
|
3519
|
-
'
|
|
4121
|
+
'bit_address'?: number;
|
|
4122
|
+
/**
|
|
4123
|
+
* The unique identifier for the input/output value. This identifier is used to reference the specific input/output in the NOVA system.
|
|
4124
|
+
* @type {string}
|
|
4125
|
+
* @memberof ProfinetIO
|
|
4126
|
+
*/
|
|
4127
|
+
'io': string;
|
|
3520
4128
|
}
|
|
3521
4129
|
|
|
3522
|
-
export const RectangleShapeTypeEnum = {
|
|
3523
|
-
Rectangle: 'rectangle'
|
|
3524
|
-
} as const;
|
|
3525
|
-
|
|
3526
|
-
export type RectangleShapeTypeEnum = typeof RectangleShapeTypeEnum[keyof typeof RectangleShapeTypeEnum];
|
|
3527
4130
|
|
|
3528
4131
|
/**
|
|
3529
|
-
*
|
|
4132
|
+
*
|
|
3530
4133
|
* @export
|
|
3531
|
-
* @interface
|
|
4134
|
+
* @interface ProfinetIOData
|
|
3532
4135
|
*/
|
|
3533
|
-
export interface
|
|
4136
|
+
export interface ProfinetIOData {
|
|
3534
4137
|
/**
|
|
3535
|
-
*
|
|
4138
|
+
* 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.
|
|
3536
4139
|
* @type {string}
|
|
3537
|
-
* @memberof
|
|
4140
|
+
* @memberof ProfinetIOData
|
|
3538
4141
|
*/
|
|
3539
|
-
'
|
|
4142
|
+
'name': string;
|
|
3540
4143
|
/**
|
|
3541
|
-
*
|
|
3542
|
-
* @type {
|
|
3543
|
-
* @memberof
|
|
4144
|
+
*
|
|
4145
|
+
* @type {ProfinetIOTypeEnum}
|
|
4146
|
+
* @memberof ProfinetIOData
|
|
3544
4147
|
*/
|
|
3545
|
-
'
|
|
4148
|
+
'type': ProfinetIOTypeEnum;
|
|
3546
4149
|
/**
|
|
3547
|
-
* The
|
|
4150
|
+
* The direction of the input/output value, indicating whether it is an input or output for the device.
|
|
4151
|
+
* @type {ProfinetIODirection}
|
|
4152
|
+
* @memberof ProfinetIOData
|
|
4153
|
+
*/
|
|
4154
|
+
'direction': ProfinetIODirection;
|
|
4155
|
+
/**
|
|
4156
|
+
* 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.
|
|
3548
4157
|
* @type {number}
|
|
3549
|
-
* @memberof
|
|
4158
|
+
* @memberof ProfinetIOData
|
|
3550
4159
|
*/
|
|
3551
|
-
'
|
|
4160
|
+
'byte_address': number;
|
|
3552
4161
|
/**
|
|
3553
|
-
* The
|
|
4162
|
+
* 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.
|
|
3554
4163
|
* @type {number}
|
|
3555
|
-
* @memberof
|
|
4164
|
+
* @memberof ProfinetIOData
|
|
3556
4165
|
*/
|
|
3557
|
-
'
|
|
4166
|
+
'bit_address'?: number;
|
|
3558
4167
|
}
|
|
3559
4168
|
|
|
3560
|
-
|
|
3561
|
-
|
|
4169
|
+
|
|
4170
|
+
/**
|
|
4171
|
+
* Identifies the input/output type.
|
|
4172
|
+
* @export
|
|
4173
|
+
* @enum {string}
|
|
4174
|
+
*/
|
|
4175
|
+
|
|
4176
|
+
export const ProfinetIODirection = {
|
|
4177
|
+
ProfinetIoDirectionInput: 'PROFINET_IO_DIRECTION_INPUT',
|
|
4178
|
+
ProfinetIoDirectionOutput: 'PROFINET_IO_DIRECTION_OUTPUT',
|
|
4179
|
+
ProfinetIoDirectionInout: 'PROFINET_IO_DIRECTION_INOUT'
|
|
3562
4180
|
} as const;
|
|
3563
4181
|
|
|
3564
|
-
export type
|
|
4182
|
+
export type ProfinetIODirection = typeof ProfinetIODirection[keyof typeof ProfinetIODirection];
|
|
4183
|
+
|
|
3565
4184
|
|
|
3566
4185
|
/**
|
|
3567
|
-
*
|
|
4186
|
+
* Value type of the PROFINET input/output.
|
|
3568
4187
|
* @export
|
|
3569
4188
|
* @enum {string}
|
|
3570
4189
|
*/
|
|
3571
4190
|
|
|
3572
|
-
export const
|
|
3573
|
-
|
|
3574
|
-
|
|
4191
|
+
export const ProfinetIOTypeEnum = {
|
|
4192
|
+
ProfinetIoTypeUnknown: 'PROFINET_IO_TYPE_UNKNOWN',
|
|
4193
|
+
ProfinetIoTypeBool: 'PROFINET_IO_TYPE_BOOL',
|
|
4194
|
+
ProfinetIoTypeUsint: 'PROFINET_IO_TYPE_USINT',
|
|
4195
|
+
ProfinetIoTypeSint: 'PROFINET_IO_TYPE_SINT',
|
|
4196
|
+
ProfinetIoTypeUint: 'PROFINET_IO_TYPE_UINT',
|
|
4197
|
+
ProfinetIoTypeInt: 'PROFINET_IO_TYPE_INT',
|
|
4198
|
+
ProfinetIoTypeUdint: 'PROFINET_IO_TYPE_UDINT',
|
|
4199
|
+
ProfinetIoTypeDint: 'PROFINET_IO_TYPE_DINT',
|
|
4200
|
+
ProfinetIoTypeReal: 'PROFINET_IO_TYPE_REAL',
|
|
4201
|
+
ProfinetIoTypeLreal: 'PROFINET_IO_TYPE_LREAL'
|
|
3575
4202
|
} as const;
|
|
3576
4203
|
|
|
3577
|
-
export type
|
|
4204
|
+
export type ProfinetIOTypeEnum = typeof ProfinetIOTypeEnum[keyof typeof ProfinetIOTypeEnum];
|
|
3578
4205
|
|
|
3579
4206
|
|
|
3580
4207
|
/**
|
|
3581
|
-
*
|
|
4208
|
+
*
|
|
3582
4209
|
* @export
|
|
3583
|
-
* @interface
|
|
4210
|
+
* @interface ProfinetInputOutputConfig
|
|
3584
4211
|
*/
|
|
3585
|
-
export interface
|
|
4212
|
+
export interface ProfinetInputOutputConfig {
|
|
3586
4213
|
/**
|
|
3587
|
-
*
|
|
4214
|
+
* Content of the input output configuration file.
|
|
3588
4215
|
* @type {string}
|
|
3589
|
-
* @memberof
|
|
4216
|
+
* @memberof ProfinetInputOutputConfig
|
|
3590
4217
|
*/
|
|
3591
|
-
'
|
|
4218
|
+
'config': string;
|
|
3592
4219
|
/**
|
|
3593
|
-
*
|
|
3594
|
-
* @type {
|
|
3595
|
-
* @memberof
|
|
4220
|
+
* Offset in bytes for the input data.
|
|
4221
|
+
* @type {number}
|
|
4222
|
+
* @memberof ProfinetInputOutputConfig
|
|
3596
4223
|
*/
|
|
3597
|
-
'
|
|
4224
|
+
'input_offset': number;
|
|
4225
|
+
/**
|
|
4226
|
+
* Offset in bytes for the output data.
|
|
4227
|
+
* @type {number}
|
|
4228
|
+
* @memberof ProfinetInputOutputConfig
|
|
4229
|
+
*/
|
|
4230
|
+
'output_offset': number;
|
|
3598
4231
|
}
|
|
3599
4232
|
/**
|
|
3600
|
-
*
|
|
4233
|
+
*
|
|
3601
4234
|
* @export
|
|
4235
|
+
* @interface ProfinetSlotDescription
|
|
3602
4236
|
*/
|
|
3603
|
-
export
|
|
3604
|
-
|
|
4237
|
+
export interface ProfinetSlotDescription {
|
|
4238
|
+
/**
|
|
4239
|
+
* The number of the PROFINET slot.
|
|
4240
|
+
* @type {number}
|
|
4241
|
+
* @memberof ProfinetSlotDescription
|
|
4242
|
+
*/
|
|
4243
|
+
'number': number;
|
|
4244
|
+
/**
|
|
4245
|
+
* The API number of the PROFINET input, used to identify the specific API for the input.
|
|
4246
|
+
* @type {number}
|
|
4247
|
+
* @memberof ProfinetSlotDescription
|
|
4248
|
+
*/
|
|
4249
|
+
'api': number;
|
|
4250
|
+
/**
|
|
4251
|
+
* An array of PROFINET subslots.
|
|
4252
|
+
* @type {Array<ProfinetSubSlotDescription>}
|
|
4253
|
+
* @memberof ProfinetSlotDescription
|
|
4254
|
+
*/
|
|
4255
|
+
'subslots': Array<ProfinetSubSlotDescription>;
|
|
4256
|
+
}
|
|
3605
4257
|
/**
|
|
3606
|
-
*
|
|
4258
|
+
*
|
|
3607
4259
|
* @export
|
|
3608
|
-
* @interface
|
|
4260
|
+
* @interface ProfinetSubSlotDescription
|
|
3609
4261
|
*/
|
|
3610
|
-
export interface
|
|
4262
|
+
export interface ProfinetSubSlotDescription {
|
|
3611
4263
|
/**
|
|
3612
|
-
*
|
|
3613
|
-
* @type {
|
|
3614
|
-
* @memberof
|
|
4264
|
+
* The identifier of the PROFINET subslot.
|
|
4265
|
+
* @type {number}
|
|
4266
|
+
* @memberof ProfinetSubSlotDescription
|
|
3615
4267
|
*/
|
|
3616
|
-
'
|
|
4268
|
+
'number': number;
|
|
3617
4269
|
/**
|
|
3618
|
-
*
|
|
4270
|
+
* The length in bytes of the PROFINET input.
|
|
3619
4271
|
* @type {number}
|
|
3620
|
-
* @memberof
|
|
4272
|
+
* @memberof ProfinetSubSlotDescription
|
|
3621
4273
|
*/
|
|
3622
|
-
'
|
|
4274
|
+
'input_length': number;
|
|
3623
4275
|
/**
|
|
3624
|
-
*
|
|
4276
|
+
* The length in bytes of the PROFINET output.
|
|
4277
|
+
* @type {number}
|
|
4278
|
+
* @memberof ProfinetSubSlotDescription
|
|
4279
|
+
*/
|
|
4280
|
+
'output_length': number;
|
|
4281
|
+
}
|
|
4282
|
+
/**
|
|
4283
|
+
* <!-- 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.
|
|
4284
|
+
* @export
|
|
4285
|
+
* @interface RRTConnectAlgorithm
|
|
4286
|
+
*/
|
|
4287
|
+
export interface RRTConnectAlgorithm {
|
|
4288
|
+
/**
|
|
4289
|
+
* Algorithm discriminator.
|
|
3625
4290
|
* @type {string}
|
|
3626
|
-
* @memberof
|
|
4291
|
+
* @memberof RRTConnectAlgorithm
|
|
3627
4292
|
*/
|
|
3628
|
-
'
|
|
4293
|
+
'algorithm_name': RRTConnectAlgorithmAlgorithmNameEnum;
|
|
3629
4294
|
/**
|
|
3630
|
-
*
|
|
3631
|
-
* @type {
|
|
3632
|
-
* @memberof
|
|
4295
|
+
* Maximum number of iterations for the RRT Connect algorithm. Higher values increase likelihood of success, but also computation time.
|
|
4296
|
+
* @type {number}
|
|
4297
|
+
* @memberof RRTConnectAlgorithm
|
|
3633
4298
|
*/
|
|
3634
|
-
'
|
|
4299
|
+
'max_iterations'?: number;
|
|
4300
|
+
}
|
|
4301
|
+
|
|
4302
|
+
export const RRTConnectAlgorithmAlgorithmNameEnum = {
|
|
4303
|
+
RrtConnectAlgorithm: 'RRTConnectAlgorithm'
|
|
4304
|
+
} as const;
|
|
4305
|
+
|
|
4306
|
+
export type RRTConnectAlgorithmAlgorithmNameEnum = typeof RRTConnectAlgorithmAlgorithmNameEnum[keyof typeof RRTConnectAlgorithmAlgorithmNameEnum];
|
|
4307
|
+
|
|
4308
|
+
/**
|
|
4309
|
+
* Defines an x/y-plane with finite size. Centred around the z-axis.
|
|
4310
|
+
* @export
|
|
4311
|
+
* @interface Rectangle
|
|
4312
|
+
*/
|
|
4313
|
+
export interface Rectangle {
|
|
3635
4314
|
/**
|
|
3636
4315
|
*
|
|
3637
|
-
* @type {
|
|
3638
|
-
* @memberof
|
|
4316
|
+
* @type {string}
|
|
4317
|
+
* @memberof Rectangle
|
|
3639
4318
|
*/
|
|
3640
|
-
'
|
|
4319
|
+
'shape_type': RectangleShapeTypeEnum;
|
|
3641
4320
|
/**
|
|
3642
|
-
*
|
|
4321
|
+
* The dimension in x-direction in [mm].
|
|
3643
4322
|
* @type {number}
|
|
3644
|
-
* @memberof
|
|
4323
|
+
* @memberof Rectangle
|
|
3645
4324
|
*/
|
|
3646
|
-
'
|
|
4325
|
+
'size_x': number;
|
|
3647
4326
|
/**
|
|
3648
|
-
*
|
|
3649
|
-
* @type {
|
|
3650
|
-
* @memberof
|
|
4327
|
+
* The dimension in y-direction in [mm].
|
|
4328
|
+
* @type {number}
|
|
4329
|
+
* @memberof Rectangle
|
|
3651
4330
|
*/
|
|
3652
|
-
'
|
|
4331
|
+
'size_y': number;
|
|
3653
4332
|
}
|
|
3654
4333
|
|
|
4334
|
+
export const RectangleShapeTypeEnum = {
|
|
4335
|
+
Rectangle: 'rectangle'
|
|
4336
|
+
} as const;
|
|
4337
|
+
|
|
4338
|
+
export type RectangleShapeTypeEnum = typeof RectangleShapeTypeEnum[keyof typeof RectangleShapeTypeEnum];
|
|
3655
4339
|
|
|
3656
4340
|
/**
|
|
3657
|
-
*
|
|
4341
|
+
* Convex hull around four spheres. Sphere center points in x/y-plane, offset by either combination \"+/- sizeX\" or \"+/- sizeY\". Alternative description: Rectangle in x/y-plane with a 3D padding.
|
|
3658
4342
|
* @export
|
|
3659
|
-
* @interface
|
|
4343
|
+
* @interface RectangularCapsule
|
|
3660
4344
|
*/
|
|
3661
|
-
export interface
|
|
4345
|
+
export interface RectangularCapsule {
|
|
3662
4346
|
/**
|
|
3663
|
-
*
|
|
4347
|
+
*
|
|
3664
4348
|
* @type {string}
|
|
3665
|
-
* @memberof
|
|
4349
|
+
* @memberof RectangularCapsule
|
|
3666
4350
|
*/
|
|
3667
|
-
'
|
|
4351
|
+
'shape_type': RectangularCapsuleShapeTypeEnum;
|
|
3668
4352
|
/**
|
|
3669
|
-
*
|
|
4353
|
+
* The radius of the inner spheres in [mm].
|
|
3670
4354
|
* @type {number}
|
|
3671
|
-
* @memberof
|
|
4355
|
+
* @memberof RectangularCapsule
|
|
3672
4356
|
*/
|
|
3673
|
-
'
|
|
4357
|
+
'radius': number;
|
|
3674
4358
|
/**
|
|
3675
|
-
* The
|
|
3676
|
-
* @type {
|
|
3677
|
-
* @memberof
|
|
4359
|
+
* The distance of the sphere center in x-direction in [mm].
|
|
4360
|
+
* @type {number}
|
|
4361
|
+
* @memberof RectangularCapsule
|
|
3678
4362
|
*/
|
|
3679
|
-
'
|
|
4363
|
+
'sphere_center_distance_x': number;
|
|
4364
|
+
/**
|
|
4365
|
+
* The distance of the sphere center in y-direction in [mm].
|
|
4366
|
+
* @type {number}
|
|
4367
|
+
* @memberof RectangularCapsule
|
|
4368
|
+
*/
|
|
4369
|
+
'sphere_center_distance_y': number;
|
|
4370
|
+
}
|
|
4371
|
+
|
|
4372
|
+
export const RectangularCapsuleShapeTypeEnum = {
|
|
4373
|
+
RectangularCapsule: 'rectangular_capsule'
|
|
4374
|
+
} as const;
|
|
4375
|
+
|
|
4376
|
+
export type RectangularCapsuleShapeTypeEnum = typeof RectangularCapsuleShapeTypeEnum[keyof typeof RectangularCapsuleShapeTypeEnum];
|
|
4377
|
+
|
|
4378
|
+
/**
|
|
4379
|
+
* The channel that defines what a new Wandelbots NOVA version is. * `next` the over all latest version * `stable` newes patch of the current version
|
|
4380
|
+
* @export
|
|
4381
|
+
* @enum {string}
|
|
4382
|
+
*/
|
|
4383
|
+
|
|
4384
|
+
export const ReleaseChannel = {
|
|
4385
|
+
Stable: 'stable',
|
|
4386
|
+
Next: 'next'
|
|
4387
|
+
} as const;
|
|
4388
|
+
|
|
4389
|
+
export type ReleaseChannel = typeof ReleaseChannel[keyof typeof ReleaseChannel];
|
|
4390
|
+
|
|
4391
|
+
|
|
4392
|
+
/**
|
|
4393
|
+
* The configuration of a physical or virtual robot controller.
|
|
4394
|
+
* @export
|
|
4395
|
+
* @interface RobotController
|
|
4396
|
+
*/
|
|
4397
|
+
export interface RobotController {
|
|
4398
|
+
/**
|
|
4399
|
+
* 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).
|
|
4400
|
+
* @type {string}
|
|
4401
|
+
* @memberof RobotController
|
|
4402
|
+
*/
|
|
4403
|
+
'name': string;
|
|
3680
4404
|
/**
|
|
3681
4405
|
*
|
|
3682
|
-
* @type {
|
|
3683
|
-
* @memberof
|
|
4406
|
+
* @type {RobotControllerConfiguration}
|
|
4407
|
+
* @memberof RobotController
|
|
3684
4408
|
*/
|
|
3685
|
-
'
|
|
4409
|
+
'configuration': RobotControllerConfiguration;
|
|
4410
|
+
}
|
|
4411
|
+
/**
|
|
4412
|
+
* @type RobotControllerConfiguration
|
|
4413
|
+
* @export
|
|
4414
|
+
*/
|
|
4415
|
+
export type RobotControllerConfiguration = AbbController | FanucController | KukaController | UniversalrobotsController | VirtualController | YaskawaController;
|
|
4416
|
+
|
|
4417
|
+
/**
|
|
4418
|
+
* Returns the whole current state of robot controller.
|
|
4419
|
+
* @export
|
|
4420
|
+
* @interface RobotControllerState
|
|
4421
|
+
*/
|
|
4422
|
+
export interface RobotControllerState {
|
|
4423
|
+
/**
|
|
4424
|
+
* Mode of communication and control between NOVA and the robot controller.
|
|
4425
|
+
* @type {RobotSystemMode}
|
|
4426
|
+
* @memberof RobotControllerState
|
|
4427
|
+
*/
|
|
4428
|
+
'mode': RobotSystemMode;
|
|
4429
|
+
/**
|
|
4430
|
+
* 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.
|
|
4431
|
+
* @type {Array<string>}
|
|
4432
|
+
* @memberof RobotControllerState
|
|
4433
|
+
*/
|
|
4434
|
+
'last_error'?: Array<string>;
|
|
4435
|
+
/**
|
|
4436
|
+
* Timestamp indicating when the represented information was received from the robot controller.
|
|
4437
|
+
* @type {string}
|
|
4438
|
+
* @memberof RobotControllerState
|
|
4439
|
+
*/
|
|
4440
|
+
'timestamp': string;
|
|
4441
|
+
/**
|
|
4442
|
+
* Sequence number of the controller state. It starts with 0 upon establishing the connection with a physical controller. The sequence number is reset when the connection to the physical controller is closed and re-established.
|
|
4443
|
+
* @type {number}
|
|
4444
|
+
* @memberof RobotControllerState
|
|
4445
|
+
*/
|
|
4446
|
+
'sequence_number': number;
|
|
4447
|
+
/**
|
|
4448
|
+
* Identifier of the configured robot controller.
|
|
4449
|
+
* @type {string}
|
|
4450
|
+
* @memberof RobotControllerState
|
|
4451
|
+
*/
|
|
4452
|
+
'controller': string;
|
|
3686
4453
|
/**
|
|
3687
4454
|
*
|
|
3688
|
-
* @type {
|
|
3689
|
-
* @memberof
|
|
4455
|
+
* @type {OperationMode}
|
|
4456
|
+
* @memberof RobotControllerState
|
|
3690
4457
|
*/
|
|
3691
|
-
'
|
|
4458
|
+
'operation_mode': OperationMode;
|
|
3692
4459
|
/**
|
|
3693
4460
|
*
|
|
3694
|
-
* @type {
|
|
3695
|
-
* @memberof
|
|
4461
|
+
* @type {SafetyStateType}
|
|
4462
|
+
* @memberof RobotControllerState
|
|
3696
4463
|
*/
|
|
3697
|
-
'
|
|
4464
|
+
'safety_state': SafetyStateType;
|
|
4465
|
+
/**
|
|
4466
|
+
* If made available by the robot controller, returns the current velocity override in [percentage] for movements adjusted on robot control panel. Valid value range: 1 - 100.
|
|
4467
|
+
* @type {number}
|
|
4468
|
+
* @memberof RobotControllerState
|
|
4469
|
+
*/
|
|
4470
|
+
'velocity_override'?: number;
|
|
3698
4471
|
/**
|
|
3699
|
-
*
|
|
3700
|
-
* @type {
|
|
3701
|
-
* @memberof
|
|
4472
|
+
* State of indicated motion groups. In case of state request via controller all configured motion groups are returned. In case of executing a motion only the affected motion groups are returned.
|
|
4473
|
+
* @type {Array<MotionGroupState>}
|
|
4474
|
+
* @memberof RobotControllerState
|
|
3702
4475
|
*/
|
|
3703
|
-
'
|
|
4476
|
+
'motion_groups': Array<MotionGroupState>;
|
|
3704
4477
|
}
|
|
4478
|
+
|
|
4479
|
+
|
|
3705
4480
|
/**
|
|
3706
|
-
*
|
|
4481
|
+
* 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.
|
|
3707
4482
|
* @export
|
|
3708
4483
|
* @enum {string}
|
|
3709
4484
|
*/
|
|
3710
4485
|
|
|
3711
4486
|
export const RobotSystemMode = {
|
|
3712
|
-
|
|
3713
|
-
|
|
3714
|
-
|
|
3715
|
-
|
|
3716
|
-
|
|
4487
|
+
ModeControllerNotConfigured: 'MODE_CONTROLLER_NOT_CONFIGURED',
|
|
4488
|
+
ModeInitializing: 'MODE_INITIALIZING',
|
|
4489
|
+
ModeMonitor: 'MODE_MONITOR',
|
|
4490
|
+
ModeControl: 'MODE_CONTROL',
|
|
4491
|
+
ModeFreeDrive: 'MODE_FREE_DRIVE'
|
|
3717
4492
|
} as const;
|
|
3718
4493
|
|
|
3719
4494
|
export type RobotSystemMode = typeof RobotSystemMode[keyof typeof RobotSystemMode];
|
|
@@ -3791,52 +4566,6 @@ export interface RobotTcpData {
|
|
|
3791
4566
|
}
|
|
3792
4567
|
|
|
3793
4568
|
|
|
3794
|
-
/**
|
|
3795
|
-
*
|
|
3796
|
-
* @export
|
|
3797
|
-
* @interface Running
|
|
3798
|
-
*/
|
|
3799
|
-
export interface Running {
|
|
3800
|
-
/**
|
|
3801
|
-
*
|
|
3802
|
-
* @type {string}
|
|
3803
|
-
* @memberof Running
|
|
3804
|
-
*/
|
|
3805
|
-
'kind': RunningKindEnum;
|
|
3806
|
-
}
|
|
3807
|
-
|
|
3808
|
-
export const RunningKindEnum = {
|
|
3809
|
-
Running: 'RUNNING'
|
|
3810
|
-
} as const;
|
|
3811
|
-
|
|
3812
|
-
export type RunningKindEnum = typeof RunningKindEnum[keyof typeof RunningKindEnum];
|
|
3813
|
-
|
|
3814
|
-
/**
|
|
3815
|
-
*
|
|
3816
|
-
* @export
|
|
3817
|
-
* @interface Running1
|
|
3818
|
-
*/
|
|
3819
|
-
export interface Running1 {
|
|
3820
|
-
/**
|
|
3821
|
-
*
|
|
3822
|
-
* @type {string}
|
|
3823
|
-
* @memberof Running1
|
|
3824
|
-
*/
|
|
3825
|
-
'kind': Running1KindEnum;
|
|
3826
|
-
/**
|
|
3827
|
-
* Remaining time in milliseconds (ms) to reach the end of the motion.
|
|
3828
|
-
* @type {number}
|
|
3829
|
-
* @memberof Running1
|
|
3830
|
-
*/
|
|
3831
|
-
'time_to_end': number;
|
|
3832
|
-
}
|
|
3833
|
-
|
|
3834
|
-
export const Running1KindEnum = {
|
|
3835
|
-
Running: 'RUNNING'
|
|
3836
|
-
} as const;
|
|
3837
|
-
|
|
3838
|
-
export type Running1KindEnum = typeof Running1KindEnum[keyof typeof Running1KindEnum];
|
|
3839
|
-
|
|
3840
4569
|
/**
|
|
3841
4570
|
* 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.
|
|
3842
4571
|
* @export
|
|
@@ -4011,37 +4740,6 @@ export const SettableRobotSystemMode = {
|
|
|
4011
4740
|
export type SettableRobotSystemMode = typeof SettableRobotSystemMode[keyof typeof SettableRobotSystemMode];
|
|
4012
4741
|
|
|
4013
4742
|
|
|
4014
|
-
/**
|
|
4015
|
-
*
|
|
4016
|
-
* @export
|
|
4017
|
-
* @interface SingleMotionGroupCollisionScene
|
|
4018
|
-
*/
|
|
4019
|
-
export interface SingleMotionGroupCollisionScene {
|
|
4020
|
-
/**
|
|
4021
|
-
* A collection of identifiable colliders.
|
|
4022
|
-
* @type {{ [key: string]: Collider; }}
|
|
4023
|
-
* @memberof SingleMotionGroupCollisionScene
|
|
4024
|
-
*/
|
|
4025
|
-
'static_colliders'?: { [key: string]: Collider; };
|
|
4026
|
-
/**
|
|
4027
|
-
* 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.
|
|
4028
|
-
* @type {Array<{ [key: string]: Collider; }>}
|
|
4029
|
-
* @memberof SingleMotionGroupCollisionScene
|
|
4030
|
-
*/
|
|
4031
|
-
'link_chain'?: Array<{ [key: string]: Collider; }>;
|
|
4032
|
-
/**
|
|
4033
|
-
* 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.
|
|
4034
|
-
* @type {{ [key: string]: Collider; }}
|
|
4035
|
-
* @memberof SingleMotionGroupCollisionScene
|
|
4036
|
-
*/
|
|
4037
|
-
'tool'?: { [key: string]: Collider; };
|
|
4038
|
-
/**
|
|
4039
|
-
* If true, self-collision detection is enabled for the motion group. See LinkChain documentation for details. Default is true.
|
|
4040
|
-
* @type {boolean}
|
|
4041
|
-
* @memberof SingleMotionGroupCollisionScene
|
|
4042
|
-
*/
|
|
4043
|
-
'motion_group_self_collision_detection'?: boolean;
|
|
4044
|
-
}
|
|
4045
4743
|
/**
|
|
4046
4744
|
*
|
|
4047
4745
|
* @export
|
|
@@ -4100,7 +4798,7 @@ export interface StartMovementRequest {
|
|
|
4100
4798
|
* @type {Direction}
|
|
4101
4799
|
* @memberof StartMovementRequest
|
|
4102
4800
|
*/
|
|
4103
|
-
'direction'
|
|
4801
|
+
'direction'?: Direction;
|
|
4104
4802
|
/**
|
|
4105
4803
|
* 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.
|
|
4106
4804
|
* @type {Array<IOValue>}
|
|
@@ -4407,7 +5105,27 @@ export type TrajectoryDetailsKindEnum = typeof TrajectoryDetailsKindEnum[keyof t
|
|
|
4407
5105
|
* @type TrajectoryDetailsState
|
|
4408
5106
|
* @export
|
|
4409
5107
|
*/
|
|
4410
|
-
export type TrajectoryDetailsState =
|
|
5108
|
+
export type TrajectoryDetailsState = TrajectoryEnded | TrajectoryPausedByUser | TrajectoryPausedOnIO | TrajectoryRunning | TrajectoryWaitForIO;
|
|
5109
|
+
|
|
5110
|
+
/**
|
|
5111
|
+
*
|
|
5112
|
+
* @export
|
|
5113
|
+
* @interface TrajectoryEnded
|
|
5114
|
+
*/
|
|
5115
|
+
export interface TrajectoryEnded {
|
|
5116
|
+
/**
|
|
5117
|
+
*
|
|
5118
|
+
* @type {string}
|
|
5119
|
+
* @memberof TrajectoryEnded
|
|
5120
|
+
*/
|
|
5121
|
+
'kind': TrajectoryEndedKindEnum;
|
|
5122
|
+
}
|
|
5123
|
+
|
|
5124
|
+
export const TrajectoryEndedKindEnum = {
|
|
5125
|
+
EndOfTrajectory: 'END_OF_TRAJECTORY'
|
|
5126
|
+
} as const;
|
|
5127
|
+
|
|
5128
|
+
export type TrajectoryEndedKindEnum = typeof TrajectoryEndedKindEnum[keyof typeof TrajectoryEndedKindEnum];
|
|
4411
5129
|
|
|
4412
5130
|
/**
|
|
4413
5131
|
*
|
|
@@ -4436,22 +5154,108 @@ export const TrajectoryIdMessageTypeEnum = {
|
|
|
4436
5154
|
export type TrajectoryIdMessageTypeEnum = typeof TrajectoryIdMessageTypeEnum[keyof typeof TrajectoryIdMessageTypeEnum];
|
|
4437
5155
|
|
|
4438
5156
|
/**
|
|
4439
|
-
*
|
|
5157
|
+
*
|
|
4440
5158
|
* @export
|
|
4441
|
-
* @
|
|
5159
|
+
* @interface TrajectoryPausedByUser
|
|
4442
5160
|
*/
|
|
5161
|
+
export interface TrajectoryPausedByUser {
|
|
5162
|
+
/**
|
|
5163
|
+
*
|
|
5164
|
+
* @type {string}
|
|
5165
|
+
* @memberof TrajectoryPausedByUser
|
|
5166
|
+
*/
|
|
5167
|
+
'kind': TrajectoryPausedByUserKindEnum;
|
|
5168
|
+
}
|
|
4443
5169
|
|
|
4444
|
-
export const
|
|
4445
|
-
|
|
4446
|
-
|
|
4447
|
-
|
|
4448
|
-
|
|
4449
|
-
|
|
4450
|
-
|
|
4451
|
-
|
|
4452
|
-
|
|
4453
|
-
|
|
4454
|
-
|
|
5170
|
+
export const TrajectoryPausedByUserKindEnum = {
|
|
5171
|
+
PausedByUser: 'PAUSED_BY_USER'
|
|
5172
|
+
} as const;
|
|
5173
|
+
|
|
5174
|
+
export type TrajectoryPausedByUserKindEnum = typeof TrajectoryPausedByUserKindEnum[keyof typeof TrajectoryPausedByUserKindEnum];
|
|
5175
|
+
|
|
5176
|
+
/**
|
|
5177
|
+
*
|
|
5178
|
+
* @export
|
|
5179
|
+
* @interface TrajectoryPausedOnIO
|
|
5180
|
+
*/
|
|
5181
|
+
export interface TrajectoryPausedOnIO {
|
|
5182
|
+
/**
|
|
5183
|
+
*
|
|
5184
|
+
* @type {string}
|
|
5185
|
+
* @memberof TrajectoryPausedOnIO
|
|
5186
|
+
*/
|
|
5187
|
+
'kind': TrajectoryPausedOnIOKindEnum;
|
|
5188
|
+
}
|
|
5189
|
+
|
|
5190
|
+
export const TrajectoryPausedOnIOKindEnum = {
|
|
5191
|
+
PausedOnIo: 'PAUSED_ON_IO'
|
|
5192
|
+
} as const;
|
|
5193
|
+
|
|
5194
|
+
export type TrajectoryPausedOnIOKindEnum = typeof TrajectoryPausedOnIOKindEnum[keyof typeof TrajectoryPausedOnIOKindEnum];
|
|
5195
|
+
|
|
5196
|
+
/**
|
|
5197
|
+
*
|
|
5198
|
+
* @export
|
|
5199
|
+
* @interface TrajectoryRunning
|
|
5200
|
+
*/
|
|
5201
|
+
export interface TrajectoryRunning {
|
|
5202
|
+
/**
|
|
5203
|
+
*
|
|
5204
|
+
* @type {string}
|
|
5205
|
+
* @memberof TrajectoryRunning
|
|
5206
|
+
*/
|
|
5207
|
+
'kind': TrajectoryRunningKindEnum;
|
|
5208
|
+
/**
|
|
5209
|
+
* Remaining time in milliseconds (ms) to reach the end of the motion.
|
|
5210
|
+
* @type {number}
|
|
5211
|
+
* @memberof TrajectoryRunning
|
|
5212
|
+
*/
|
|
5213
|
+
'time_to_end': number;
|
|
5214
|
+
}
|
|
5215
|
+
|
|
5216
|
+
export const TrajectoryRunningKindEnum = {
|
|
5217
|
+
Running: 'RUNNING'
|
|
5218
|
+
} as const;
|
|
5219
|
+
|
|
5220
|
+
export type TrajectoryRunningKindEnum = typeof TrajectoryRunningKindEnum[keyof typeof TrajectoryRunningKindEnum];
|
|
5221
|
+
|
|
5222
|
+
/**
|
|
5223
|
+
*
|
|
5224
|
+
* @export
|
|
5225
|
+
* @interface TrajectoryWaitForIO
|
|
5226
|
+
*/
|
|
5227
|
+
export interface TrajectoryWaitForIO {
|
|
5228
|
+
/**
|
|
5229
|
+
*
|
|
5230
|
+
* @type {string}
|
|
5231
|
+
* @memberof TrajectoryWaitForIO
|
|
5232
|
+
*/
|
|
5233
|
+
'kind': TrajectoryWaitForIOKindEnum;
|
|
5234
|
+
}
|
|
5235
|
+
|
|
5236
|
+
export const TrajectoryWaitForIOKindEnum = {
|
|
5237
|
+
WaitForIo: 'WAIT_FOR_IO'
|
|
5238
|
+
} as const;
|
|
5239
|
+
|
|
5240
|
+
export type TrajectoryWaitForIOKindEnum = typeof TrajectoryWaitForIOKindEnum[keyof typeof TrajectoryWaitForIOKindEnum];
|
|
5241
|
+
|
|
5242
|
+
/**
|
|
5243
|
+
* The unit of input/output value.
|
|
5244
|
+
* @export
|
|
5245
|
+
* @enum {string}
|
|
5246
|
+
*/
|
|
5247
|
+
|
|
5248
|
+
export const UnitType = {
|
|
5249
|
+
UnitNone: 'UNIT_NONE',
|
|
5250
|
+
UnitKilogram: 'UNIT_KILOGRAM',
|
|
5251
|
+
UnitAmpere: 'UNIT_AMPERE',
|
|
5252
|
+
UnitKelvin: 'UNIT_KELVIN',
|
|
5253
|
+
UnitHertz: 'UNIT_HERTZ',
|
|
5254
|
+
UnitNewton: 'UNIT_NEWTON',
|
|
5255
|
+
UnitVolt: 'UNIT_VOLT',
|
|
5256
|
+
UnitCelsius: 'UNIT_CELSIUS',
|
|
5257
|
+
UnitNewtonMeter: 'UNIT_NEWTON_METER',
|
|
5258
|
+
UnitMeter: 'UNIT_METER'
|
|
4455
5259
|
} as const;
|
|
4456
5260
|
|
|
4457
5261
|
export type UnitType = typeof UnitType[keyof typeof UnitType];
|
|
@@ -4522,6 +5326,12 @@ export interface ValidationError {
|
|
|
4522
5326
|
* @memberof ValidationError
|
|
4523
5327
|
*/
|
|
4524
5328
|
'type': string;
|
|
5329
|
+
/**
|
|
5330
|
+
*
|
|
5331
|
+
* @type {{ [key: string]: any; }}
|
|
5332
|
+
* @memberof ValidationError
|
|
5333
|
+
*/
|
|
5334
|
+
'input': { [key: string]: any; };
|
|
4525
5335
|
}
|
|
4526
5336
|
/**
|
|
4527
5337
|
* @type ValidationErrorLocInner
|
|
@@ -4564,7 +5374,7 @@ export interface VirtualController {
|
|
|
4564
5374
|
* @type {string}
|
|
4565
5375
|
* @memberof VirtualController
|
|
4566
5376
|
*/
|
|
4567
|
-
'
|
|
5377
|
+
'initial_joint_position'?: string;
|
|
4568
5378
|
}
|
|
4569
5379
|
|
|
4570
5380
|
export const VirtualControllerKindEnum = {
|
|
@@ -4614,6 +5424,7 @@ export const VirtualControllerTypes = {
|
|
|
4614
5424
|
FanucCrx20ial: 'fanuc-crx20ial',
|
|
4615
5425
|
FanucCrx25ia: 'fanuc-crx25ia',
|
|
4616
5426
|
FanucCrx30ia: 'fanuc-crx30ia',
|
|
5427
|
+
FanucCrx5ia: 'fanuc-crx5ia',
|
|
4617
5428
|
FanucLrMate200iD: 'fanuc-lr_mate_200iD',
|
|
4618
5429
|
FanucLrMate200iD4S: 'fanuc-lr_mate_200iD4S',
|
|
4619
5430
|
FanucLrMate200iD7L: 'fanuc-lr_mate_200iD7L',
|
|
@@ -4621,6 +5432,7 @@ export const VirtualControllerTypes = {
|
|
|
4621
5432
|
FanucM10iD16S: 'fanuc-m10iD16S',
|
|
4622
5433
|
FanucM20iD25: 'fanuc-m20iD25',
|
|
4623
5434
|
FanucM20iD35: 'fanuc-m20iD35',
|
|
5435
|
+
FanucM710iC20L: 'fanuc-m710iC20L',
|
|
4624
5436
|
FanucM900iB280L: 'fanuc-m900iB280L',
|
|
4625
5437
|
FanucM900iB360E: 'fanuc-m900iB360E',
|
|
4626
5438
|
FanucR2000ic125l: 'fanuc-r2000ic125l',
|
|
@@ -4711,26 +5523,6 @@ export interface VirtualRobotConfiguration {
|
|
|
4711
5523
|
*/
|
|
4712
5524
|
'content': string;
|
|
4713
5525
|
}
|
|
4714
|
-
/**
|
|
4715
|
-
*
|
|
4716
|
-
* @export
|
|
4717
|
-
* @interface WaitForIO
|
|
4718
|
-
*/
|
|
4719
|
-
export interface WaitForIO {
|
|
4720
|
-
/**
|
|
4721
|
-
*
|
|
4722
|
-
* @type {string}
|
|
4723
|
-
* @memberof WaitForIO
|
|
4724
|
-
*/
|
|
4725
|
-
'kind': WaitForIOKindEnum;
|
|
4726
|
-
}
|
|
4727
|
-
|
|
4728
|
-
export const WaitForIOKindEnum = {
|
|
4729
|
-
WaitForIo: 'WAIT_FOR_IO'
|
|
4730
|
-
} as const;
|
|
4731
|
-
|
|
4732
|
-
export type WaitForIOKindEnum = typeof WaitForIOKindEnum[keyof typeof WaitForIOKindEnum];
|
|
4733
|
-
|
|
4734
5526
|
/**
|
|
4735
5527
|
* The value to compare with the current value of the input/output.
|
|
4736
5528
|
* @export
|
|
@@ -4786,7 +5578,7 @@ export type YaskawaControllerKindEnum = typeof YaskawaControllerKindEnum[keyof t
|
|
|
4786
5578
|
export const ApplicationApiAxiosParamCreator = function (configuration?: Configuration) {
|
|
4787
5579
|
return {
|
|
4788
5580
|
/**
|
|
4789
|
-
* 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
|
|
5581
|
+
* 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.
|
|
4790
5582
|
* @summary Add Application
|
|
4791
5583
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
4792
5584
|
* @param {App} app
|
|
@@ -5092,7 +5884,7 @@ export const ApplicationApiFp = function(configuration?: Configuration) {
|
|
|
5092
5884
|
const localVarAxiosParamCreator = ApplicationApiAxiosParamCreator(configuration)
|
|
5093
5885
|
return {
|
|
5094
5886
|
/**
|
|
5095
|
-
* 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
|
|
5887
|
+
* 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.
|
|
5096
5888
|
* @summary Add Application
|
|
5097
5889
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5098
5890
|
* @param {App} app
|
|
@@ -5189,7 +5981,7 @@ export const ApplicationApiFactory = function (configuration?: Configuration, ba
|
|
|
5189
5981
|
const localVarFp = ApplicationApiFp(configuration)
|
|
5190
5982
|
return {
|
|
5191
5983
|
/**
|
|
5192
|
-
* 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
|
|
5984
|
+
* 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.
|
|
5193
5985
|
* @summary Add Application
|
|
5194
5986
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5195
5987
|
* @param {App} app
|
|
@@ -5260,92 +6052,1222 @@ export const ApplicationApiFactory = function (configuration?: Configuration, ba
|
|
|
5260
6052
|
};
|
|
5261
6053
|
};
|
|
5262
6054
|
|
|
5263
|
-
/**
|
|
5264
|
-
* ApplicationApi - object-oriented interface
|
|
5265
|
-
* @export
|
|
5266
|
-
* @class ApplicationApi
|
|
5267
|
-
* @extends {BaseAPI}
|
|
5268
|
-
*/
|
|
5269
|
-
export class ApplicationApi extends BaseAPI {
|
|
6055
|
+
/**
|
|
6056
|
+
* ApplicationApi - object-oriented interface
|
|
6057
|
+
* @export
|
|
6058
|
+
* @class ApplicationApi
|
|
6059
|
+
* @extends {BaseAPI}
|
|
6060
|
+
*/
|
|
6061
|
+
export class ApplicationApi extends BaseAPI {
|
|
6062
|
+
/**
|
|
6063
|
+
* 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.
|
|
6064
|
+
* @summary Add Application
|
|
6065
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
6066
|
+
* @param {App} app
|
|
6067
|
+
* @param {number} [completionTimeout]
|
|
6068
|
+
* @param {*} [options] Override http request option.
|
|
6069
|
+
* @throws {RequiredError}
|
|
6070
|
+
* @memberof ApplicationApi
|
|
6071
|
+
*/
|
|
6072
|
+
public addApp(cell: string, app: App, completionTimeout?: number, options?: RawAxiosRequestConfig) {
|
|
6073
|
+
return ApplicationApiFp(this.configuration).addApp(cell, app, completionTimeout, options).then((request) => request(this.axios, this.basePath));
|
|
6074
|
+
}
|
|
6075
|
+
|
|
6076
|
+
/**
|
|
6077
|
+
* Delete all GUI applications from the cell.
|
|
6078
|
+
* @summary Clear Applications
|
|
6079
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
6080
|
+
* @param {number} [completionTimeout]
|
|
6081
|
+
* @param {*} [options] Override http request option.
|
|
6082
|
+
* @throws {RequiredError}
|
|
6083
|
+
* @memberof ApplicationApi
|
|
6084
|
+
*/
|
|
6085
|
+
public clearApps(cell: string, completionTimeout?: number, options?: RawAxiosRequestConfig) {
|
|
6086
|
+
return ApplicationApiFp(this.configuration).clearApps(cell, completionTimeout, options).then((request) => request(this.axios, this.basePath));
|
|
6087
|
+
}
|
|
6088
|
+
|
|
6089
|
+
/**
|
|
6090
|
+
* Delete a GUI application from the cell.
|
|
6091
|
+
* @summary Delete Application
|
|
6092
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
6093
|
+
* @param {string} app
|
|
6094
|
+
* @param {number} [completionTimeout]
|
|
6095
|
+
* @param {*} [options] Override http request option.
|
|
6096
|
+
* @throws {RequiredError}
|
|
6097
|
+
* @memberof ApplicationApi
|
|
6098
|
+
*/
|
|
6099
|
+
public deleteApp(cell: string, app: string, completionTimeout?: number, options?: RawAxiosRequestConfig) {
|
|
6100
|
+
return ApplicationApiFp(this.configuration).deleteApp(cell, app, completionTimeout, options).then((request) => request(this.axios, this.basePath));
|
|
6101
|
+
}
|
|
6102
|
+
|
|
6103
|
+
/**
|
|
6104
|
+
* 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.
|
|
6105
|
+
* @summary Configuration
|
|
6106
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
6107
|
+
* @param {string} app
|
|
6108
|
+
* @param {*} [options] Override http request option.
|
|
6109
|
+
* @throws {RequiredError}
|
|
6110
|
+
* @memberof ApplicationApi
|
|
6111
|
+
*/
|
|
6112
|
+
public getApp(cell: string, app: string, options?: RawAxiosRequestConfig) {
|
|
6113
|
+
return ApplicationApiFp(this.configuration).getApp(cell, app, options).then((request) => request(this.axios, this.basePath));
|
|
6114
|
+
}
|
|
6115
|
+
|
|
6116
|
+
/**
|
|
6117
|
+
* 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.
|
|
6118
|
+
* @summary List Applications
|
|
6119
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
6120
|
+
* @param {*} [options] Override http request option.
|
|
6121
|
+
* @throws {RequiredError}
|
|
6122
|
+
* @memberof ApplicationApi
|
|
6123
|
+
*/
|
|
6124
|
+
public listApps(cell: string, options?: RawAxiosRequestConfig) {
|
|
6125
|
+
return ApplicationApiFp(this.configuration).listApps(cell, options).then((request) => request(this.axios, this.basePath));
|
|
6126
|
+
}
|
|
6127
|
+
|
|
6128
|
+
/**
|
|
6129
|
+
* Update the configuration of a GUI application in the cell.
|
|
6130
|
+
* @summary Update Configuration
|
|
6131
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
6132
|
+
* @param {string} app
|
|
6133
|
+
* @param {App} app2
|
|
6134
|
+
* @param {number} [completionTimeout]
|
|
6135
|
+
* @param {*} [options] Override http request option.
|
|
6136
|
+
* @throws {RequiredError}
|
|
6137
|
+
* @memberof ApplicationApi
|
|
6138
|
+
*/
|
|
6139
|
+
public updateApp(cell: string, app: string, app2: App, completionTimeout?: number, options?: RawAxiosRequestConfig) {
|
|
6140
|
+
return ApplicationApiFp(this.configuration).updateApp(cell, app, app2, completionTimeout, options).then((request) => request(this.axios, this.basePath));
|
|
6141
|
+
}
|
|
6142
|
+
}
|
|
6143
|
+
|
|
6144
|
+
|
|
6145
|
+
|
|
6146
|
+
/**
|
|
6147
|
+
* BUSInputsOutputsApi - axios parameter creator
|
|
6148
|
+
* @export
|
|
6149
|
+
*/
|
|
6150
|
+
export const BUSInputsOutputsApiAxiosParamCreator = function (configuration?: Configuration) {
|
|
6151
|
+
return {
|
|
6152
|
+
/**
|
|
6153
|
+
* Add a BUS Inputs/Outputs Service to the cell.
|
|
6154
|
+
* @summary Add Service
|
|
6155
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
6156
|
+
* @param {BusIOType} busIOType
|
|
6157
|
+
* @param {number} [completionTimeout]
|
|
6158
|
+
* @param {*} [options] Override http request option.
|
|
6159
|
+
* @throws {RequiredError}
|
|
6160
|
+
*/
|
|
6161
|
+
addBusIOService: async (cell: string, busIOType: BusIOType, completionTimeout?: number, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
6162
|
+
// verify required parameter 'cell' is not null or undefined
|
|
6163
|
+
assertParamExists('addBusIOService', 'cell', cell)
|
|
6164
|
+
// verify required parameter 'busIOType' is not null or undefined
|
|
6165
|
+
assertParamExists('addBusIOService', 'busIOType', busIOType)
|
|
6166
|
+
const localVarPath = `/cells/{cell}/bus-ios`
|
|
6167
|
+
.replace(`{${"cell"}}`, encodeURIComponent(String(cell)));
|
|
6168
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
6169
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
6170
|
+
let baseOptions;
|
|
6171
|
+
if (configuration) {
|
|
6172
|
+
baseOptions = configuration.baseOptions;
|
|
6173
|
+
}
|
|
6174
|
+
|
|
6175
|
+
const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
|
|
6176
|
+
const localVarHeaderParameter = {} as any;
|
|
6177
|
+
const localVarQueryParameter = {} as any;
|
|
6178
|
+
|
|
6179
|
+
// authentication BasicAuth required
|
|
6180
|
+
// http basic authentication required
|
|
6181
|
+
setBasicAuthToObject(localVarRequestOptions, configuration)
|
|
6182
|
+
|
|
6183
|
+
// authentication BearerAuth required
|
|
6184
|
+
// http bearer authentication required
|
|
6185
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
6186
|
+
|
|
6187
|
+
if (completionTimeout !== undefined) {
|
|
6188
|
+
localVarQueryParameter['completion_timeout'] = completionTimeout;
|
|
6189
|
+
}
|
|
6190
|
+
|
|
6191
|
+
|
|
6192
|
+
|
|
6193
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
6194
|
+
|
|
6195
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
6196
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
6197
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
6198
|
+
localVarRequestOptions.data = serializeDataIfNeeded(busIOType, localVarRequestOptions, configuration)
|
|
6199
|
+
|
|
6200
|
+
return {
|
|
6201
|
+
url: toPathString(localVarUrlObj),
|
|
6202
|
+
options: localVarRequestOptions,
|
|
6203
|
+
};
|
|
6204
|
+
},
|
|
6205
|
+
/**
|
|
6206
|
+
* Adds an input/output to or updates an input/output on the PROFINET device.
|
|
6207
|
+
* @summary Add PROFINET Input/Output
|
|
6208
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
6209
|
+
* @param {string} io Unique identifier to address an Input/Output in the cell.
|
|
6210
|
+
* @param {ProfinetIOData} profinetIOData
|
|
6211
|
+
* @param {*} [options] Override http request option.
|
|
6212
|
+
* @throws {RequiredError}
|
|
6213
|
+
*/
|
|
6214
|
+
addProfinetIO: async (cell: string, io: string, profinetIOData: ProfinetIOData, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
6215
|
+
// verify required parameter 'cell' is not null or undefined
|
|
6216
|
+
assertParamExists('addProfinetIO', 'cell', cell)
|
|
6217
|
+
// verify required parameter 'io' is not null or undefined
|
|
6218
|
+
assertParamExists('addProfinetIO', 'io', io)
|
|
6219
|
+
// verify required parameter 'profinetIOData' is not null or undefined
|
|
6220
|
+
assertParamExists('addProfinetIO', 'profinetIOData', profinetIOData)
|
|
6221
|
+
const localVarPath = `/cells/{cell}/bus-ios/profinet/ios/{io}`
|
|
6222
|
+
.replace(`{${"cell"}}`, encodeURIComponent(String(cell)))
|
|
6223
|
+
.replace(`{${"io"}}`, encodeURIComponent(String(io)));
|
|
6224
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
6225
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
6226
|
+
let baseOptions;
|
|
6227
|
+
if (configuration) {
|
|
6228
|
+
baseOptions = configuration.baseOptions;
|
|
6229
|
+
}
|
|
6230
|
+
|
|
6231
|
+
const localVarRequestOptions = { method: 'PUT', ...baseOptions, ...options};
|
|
6232
|
+
const localVarHeaderParameter = {} as any;
|
|
6233
|
+
const localVarQueryParameter = {} as any;
|
|
6234
|
+
|
|
6235
|
+
// authentication BasicAuth required
|
|
6236
|
+
// http basic authentication required
|
|
6237
|
+
setBasicAuthToObject(localVarRequestOptions, configuration)
|
|
6238
|
+
|
|
6239
|
+
// authentication BearerAuth required
|
|
6240
|
+
// http bearer authentication required
|
|
6241
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
6242
|
+
|
|
6243
|
+
|
|
6244
|
+
|
|
6245
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
6246
|
+
|
|
6247
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
6248
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
6249
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
6250
|
+
localVarRequestOptions.data = serializeDataIfNeeded(profinetIOData, localVarRequestOptions, configuration)
|
|
6251
|
+
|
|
6252
|
+
return {
|
|
6253
|
+
url: toPathString(localVarUrlObj),
|
|
6254
|
+
options: localVarRequestOptions,
|
|
6255
|
+
};
|
|
6256
|
+
},
|
|
6257
|
+
/**
|
|
6258
|
+
* Delete BUS Inputs/Outputs Service from the cell.
|
|
6259
|
+
* @summary Clear Service
|
|
6260
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
6261
|
+
* @param {number} [completionTimeout]
|
|
6262
|
+
* @param {*} [options] Override http request option.
|
|
6263
|
+
* @throws {RequiredError}
|
|
6264
|
+
*/
|
|
6265
|
+
clearBusIOService: async (cell: string, completionTimeout?: number, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
6266
|
+
// verify required parameter 'cell' is not null or undefined
|
|
6267
|
+
assertParamExists('clearBusIOService', 'cell', cell)
|
|
6268
|
+
const localVarPath = `/cells/{cell}/bus-ios`
|
|
6269
|
+
.replace(`{${"cell"}}`, encodeURIComponent(String(cell)));
|
|
6270
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
6271
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
6272
|
+
let baseOptions;
|
|
6273
|
+
if (configuration) {
|
|
6274
|
+
baseOptions = configuration.baseOptions;
|
|
6275
|
+
}
|
|
6276
|
+
|
|
6277
|
+
const localVarRequestOptions = { method: 'DELETE', ...baseOptions, ...options};
|
|
6278
|
+
const localVarHeaderParameter = {} as any;
|
|
6279
|
+
const localVarQueryParameter = {} as any;
|
|
6280
|
+
|
|
6281
|
+
// authentication BasicAuth required
|
|
6282
|
+
// http basic authentication required
|
|
6283
|
+
setBasicAuthToObject(localVarRequestOptions, configuration)
|
|
6284
|
+
|
|
6285
|
+
// authentication BearerAuth required
|
|
6286
|
+
// http bearer authentication required
|
|
6287
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
6288
|
+
|
|
6289
|
+
if (completionTimeout !== undefined) {
|
|
6290
|
+
localVarQueryParameter['completion_timeout'] = completionTimeout;
|
|
6291
|
+
}
|
|
6292
|
+
|
|
6293
|
+
|
|
6294
|
+
|
|
6295
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
6296
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
6297
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
6298
|
+
|
|
6299
|
+
return {
|
|
6300
|
+
url: toPathString(localVarUrlObj),
|
|
6301
|
+
options: localVarRequestOptions,
|
|
6302
|
+
};
|
|
6303
|
+
},
|
|
6304
|
+
/**
|
|
6305
|
+
* Removes the input/output from the PROFINET device.
|
|
6306
|
+
* @summary Remove PROFINET Input/Ouptut
|
|
6307
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
6308
|
+
* @param {string} io Unique identifier to address an Input/Output in the cell.
|
|
6309
|
+
* @param {*} [options] Override http request option.
|
|
6310
|
+
* @throws {RequiredError}
|
|
6311
|
+
*/
|
|
6312
|
+
deleteProfinetIO: async (cell: string, io: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
6313
|
+
// verify required parameter 'cell' is not null or undefined
|
|
6314
|
+
assertParamExists('deleteProfinetIO', 'cell', cell)
|
|
6315
|
+
// verify required parameter 'io' is not null or undefined
|
|
6316
|
+
assertParamExists('deleteProfinetIO', 'io', io)
|
|
6317
|
+
const localVarPath = `/cells/{cell}/bus-ios/profinet/ios/{io}`
|
|
6318
|
+
.replace(`{${"cell"}}`, encodeURIComponent(String(cell)))
|
|
6319
|
+
.replace(`{${"io"}}`, encodeURIComponent(String(io)));
|
|
6320
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
6321
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
6322
|
+
let baseOptions;
|
|
6323
|
+
if (configuration) {
|
|
6324
|
+
baseOptions = configuration.baseOptions;
|
|
6325
|
+
}
|
|
6326
|
+
|
|
6327
|
+
const localVarRequestOptions = { method: 'DELETE', ...baseOptions, ...options};
|
|
6328
|
+
const localVarHeaderParameter = {} as any;
|
|
6329
|
+
const localVarQueryParameter = {} as any;
|
|
6330
|
+
|
|
6331
|
+
// authentication BasicAuth required
|
|
6332
|
+
// http basic authentication required
|
|
6333
|
+
setBasicAuthToObject(localVarRequestOptions, configuration)
|
|
6334
|
+
|
|
6335
|
+
// authentication BearerAuth required
|
|
6336
|
+
// http bearer authentication required
|
|
6337
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
6338
|
+
|
|
6339
|
+
|
|
6340
|
+
|
|
6341
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
6342
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
6343
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
6344
|
+
|
|
6345
|
+
return {
|
|
6346
|
+
url: toPathString(localVarUrlObj),
|
|
6347
|
+
options: localVarRequestOptions,
|
|
6348
|
+
};
|
|
6349
|
+
},
|
|
6350
|
+
/**
|
|
6351
|
+
* Get deployed BUS Inputs/Outputs Service.
|
|
6352
|
+
* @summary Get Service
|
|
6353
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
6354
|
+
* @param {*} [options] Override http request option.
|
|
6355
|
+
* @throws {RequiredError}
|
|
6356
|
+
*/
|
|
6357
|
+
getBusIOService: async (cell: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
6358
|
+
// verify required parameter 'cell' is not null or undefined
|
|
6359
|
+
assertParamExists('getBusIOService', 'cell', cell)
|
|
6360
|
+
const localVarPath = `/cells/{cell}/bus-ios`
|
|
6361
|
+
.replace(`{${"cell"}}`, encodeURIComponent(String(cell)));
|
|
6362
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
6363
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
6364
|
+
let baseOptions;
|
|
6365
|
+
if (configuration) {
|
|
6366
|
+
baseOptions = configuration.baseOptions;
|
|
6367
|
+
}
|
|
6368
|
+
|
|
6369
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
6370
|
+
const localVarHeaderParameter = {} as any;
|
|
6371
|
+
const localVarQueryParameter = {} as any;
|
|
6372
|
+
|
|
6373
|
+
// authentication BasicAuth required
|
|
6374
|
+
// http basic authentication required
|
|
6375
|
+
setBasicAuthToObject(localVarRequestOptions, configuration)
|
|
6376
|
+
|
|
6377
|
+
// authentication BearerAuth required
|
|
6378
|
+
// http bearer authentication required
|
|
6379
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
6380
|
+
|
|
6381
|
+
|
|
6382
|
+
|
|
6383
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
6384
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
6385
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
6386
|
+
|
|
6387
|
+
return {
|
|
6388
|
+
url: toPathString(localVarUrlObj),
|
|
6389
|
+
options: localVarRequestOptions,
|
|
6390
|
+
};
|
|
6391
|
+
},
|
|
6392
|
+
/**
|
|
6393
|
+
* Get the current state of the BUS Inputs/Outputs service.
|
|
6394
|
+
* @summary State
|
|
6395
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
6396
|
+
* @param {*} [options] Override http request option.
|
|
6397
|
+
* @throws {RequiredError}
|
|
6398
|
+
*/
|
|
6399
|
+
getBusIOState: async (cell: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
6400
|
+
// verify required parameter 'cell' is not null or undefined
|
|
6401
|
+
assertParamExists('getBusIOState', 'cell', cell)
|
|
6402
|
+
const localVarPath = `/cells/{cell}/bus-ios/state`
|
|
6403
|
+
.replace(`{${"cell"}}`, encodeURIComponent(String(cell)));
|
|
6404
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
6405
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
6406
|
+
let baseOptions;
|
|
6407
|
+
if (configuration) {
|
|
6408
|
+
baseOptions = configuration.baseOptions;
|
|
6409
|
+
}
|
|
6410
|
+
|
|
6411
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
6412
|
+
const localVarHeaderParameter = {} as any;
|
|
6413
|
+
const localVarQueryParameter = {} as any;
|
|
6414
|
+
|
|
6415
|
+
// authentication BasicAuth required
|
|
6416
|
+
// http basic authentication required
|
|
6417
|
+
setBasicAuthToObject(localVarRequestOptions, configuration)
|
|
6418
|
+
|
|
6419
|
+
// authentication BearerAuth required
|
|
6420
|
+
// http bearer authentication required
|
|
6421
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
6422
|
+
|
|
6423
|
+
|
|
6424
|
+
|
|
6425
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
6426
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
6427
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
6428
|
+
|
|
6429
|
+
return {
|
|
6430
|
+
url: toPathString(localVarUrlObj),
|
|
6431
|
+
options: localVarRequestOptions,
|
|
6432
|
+
};
|
|
6433
|
+
},
|
|
6434
|
+
/**
|
|
6435
|
+
* 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).
|
|
6436
|
+
* @summary Get Input/Output Values
|
|
6437
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
6438
|
+
* @param {Array<string>} [ios]
|
|
6439
|
+
* @param {*} [options] Override http request option.
|
|
6440
|
+
* @throws {RequiredError}
|
|
6441
|
+
*/
|
|
6442
|
+
getBusIOValues: async (cell: string, ios?: Array<string>, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
6443
|
+
// verify required parameter 'cell' is not null or undefined
|
|
6444
|
+
assertParamExists('getBusIOValues', 'cell', cell)
|
|
6445
|
+
const localVarPath = `/cells/{cell}/bus-ios/ios/values`
|
|
6446
|
+
.replace(`{${"cell"}}`, encodeURIComponent(String(cell)));
|
|
6447
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
6448
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
6449
|
+
let baseOptions;
|
|
6450
|
+
if (configuration) {
|
|
6451
|
+
baseOptions = configuration.baseOptions;
|
|
6452
|
+
}
|
|
6453
|
+
|
|
6454
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
6455
|
+
const localVarHeaderParameter = {} as any;
|
|
6456
|
+
const localVarQueryParameter = {} as any;
|
|
6457
|
+
|
|
6458
|
+
// authentication BasicAuth required
|
|
6459
|
+
// http basic authentication required
|
|
6460
|
+
setBasicAuthToObject(localVarRequestOptions, configuration)
|
|
6461
|
+
|
|
6462
|
+
// authentication BearerAuth required
|
|
6463
|
+
// http bearer authentication required
|
|
6464
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
6465
|
+
|
|
6466
|
+
if (ios) {
|
|
6467
|
+
localVarQueryParameter['ios'] = ios;
|
|
6468
|
+
}
|
|
6469
|
+
|
|
6470
|
+
|
|
6471
|
+
|
|
6472
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
6473
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
6474
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
6475
|
+
|
|
6476
|
+
return {
|
|
6477
|
+
url: toPathString(localVarUrlObj),
|
|
6478
|
+
options: localVarRequestOptions,
|
|
6479
|
+
};
|
|
6480
|
+
},
|
|
6481
|
+
/**
|
|
6482
|
+
* Get description of PROFINET
|
|
6483
|
+
* @summary Get PROFINET Description
|
|
6484
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
6485
|
+
* @param {*} [options] Override http request option.
|
|
6486
|
+
* @throws {RequiredError}
|
|
6487
|
+
*/
|
|
6488
|
+
getProfinetDescription: async (cell: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
6489
|
+
// verify required parameter 'cell' is not null or undefined
|
|
6490
|
+
assertParamExists('getProfinetDescription', 'cell', cell)
|
|
6491
|
+
const localVarPath = `/cells/{cell}/bus-ios/profinet/description`
|
|
6492
|
+
.replace(`{${"cell"}}`, encodeURIComponent(String(cell)));
|
|
6493
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
6494
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
6495
|
+
let baseOptions;
|
|
6496
|
+
if (configuration) {
|
|
6497
|
+
baseOptions = configuration.baseOptions;
|
|
6498
|
+
}
|
|
6499
|
+
|
|
6500
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
6501
|
+
const localVarHeaderParameter = {} as any;
|
|
6502
|
+
const localVarQueryParameter = {} as any;
|
|
6503
|
+
|
|
6504
|
+
// authentication BasicAuth required
|
|
6505
|
+
// http basic authentication required
|
|
6506
|
+
setBasicAuthToObject(localVarRequestOptions, configuration)
|
|
6507
|
+
|
|
6508
|
+
// authentication BearerAuth required
|
|
6509
|
+
// http bearer authentication required
|
|
6510
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
6511
|
+
|
|
6512
|
+
|
|
6513
|
+
|
|
6514
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
6515
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
6516
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
6517
|
+
|
|
6518
|
+
return {
|
|
6519
|
+
url: toPathString(localVarUrlObj),
|
|
6520
|
+
options: localVarRequestOptions,
|
|
6521
|
+
};
|
|
6522
|
+
},
|
|
6523
|
+
/**
|
|
6524
|
+
* Get input/output configuration of the PROFINET device as file.
|
|
6525
|
+
* @summary PROFINET Inputs/Outputs to File
|
|
6526
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
6527
|
+
* @param {number} [inputOffset]
|
|
6528
|
+
* @param {number} [outputOffset]
|
|
6529
|
+
* @param {*} [options] Override http request option.
|
|
6530
|
+
* @throws {RequiredError}
|
|
6531
|
+
*/
|
|
6532
|
+
getProfinetIOsFromFile: async (cell: string, inputOffset?: number, outputOffset?: number, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
6533
|
+
// verify required parameter 'cell' is not null or undefined
|
|
6534
|
+
assertParamExists('getProfinetIOsFromFile', 'cell', cell)
|
|
6535
|
+
const localVarPath = `/cells/{cell}/bus-ios/profinet/iofile`
|
|
6536
|
+
.replace(`{${"cell"}}`, encodeURIComponent(String(cell)));
|
|
6537
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
6538
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
6539
|
+
let baseOptions;
|
|
6540
|
+
if (configuration) {
|
|
6541
|
+
baseOptions = configuration.baseOptions;
|
|
6542
|
+
}
|
|
6543
|
+
|
|
6544
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
6545
|
+
const localVarHeaderParameter = {} as any;
|
|
6546
|
+
const localVarQueryParameter = {} as any;
|
|
6547
|
+
|
|
6548
|
+
// authentication BasicAuth required
|
|
6549
|
+
// http basic authentication required
|
|
6550
|
+
setBasicAuthToObject(localVarRequestOptions, configuration)
|
|
6551
|
+
|
|
6552
|
+
// authentication BearerAuth required
|
|
6553
|
+
// http bearer authentication required
|
|
6554
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
6555
|
+
|
|
6556
|
+
if (inputOffset !== undefined) {
|
|
6557
|
+
localVarQueryParameter['input_offset'] = inputOffset;
|
|
6558
|
+
}
|
|
6559
|
+
|
|
6560
|
+
if (outputOffset !== undefined) {
|
|
6561
|
+
localVarQueryParameter['output_offset'] = outputOffset;
|
|
6562
|
+
}
|
|
6563
|
+
|
|
6564
|
+
|
|
6565
|
+
|
|
6566
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
6567
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
6568
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
6569
|
+
|
|
6570
|
+
return {
|
|
6571
|
+
url: toPathString(localVarUrlObj),
|
|
6572
|
+
options: localVarRequestOptions,
|
|
6573
|
+
};
|
|
6574
|
+
},
|
|
6575
|
+
/**
|
|
6576
|
+
* List all BUS Input/Output descriptions.
|
|
6577
|
+
* @summary List Descriptions
|
|
6578
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
6579
|
+
* @param {*} [options] Override http request option.
|
|
6580
|
+
* @throws {RequiredError}
|
|
6581
|
+
*/
|
|
6582
|
+
listBusIODescriptions: async (cell: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
6583
|
+
// verify required parameter 'cell' is not null or undefined
|
|
6584
|
+
assertParamExists('listBusIODescriptions', 'cell', cell)
|
|
6585
|
+
const localVarPath = `/cells/{cell}/bus-ios/ios/description`
|
|
6586
|
+
.replace(`{${"cell"}}`, encodeURIComponent(String(cell)));
|
|
6587
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
6588
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
6589
|
+
let baseOptions;
|
|
6590
|
+
if (configuration) {
|
|
6591
|
+
baseOptions = configuration.baseOptions;
|
|
6592
|
+
}
|
|
6593
|
+
|
|
6594
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
6595
|
+
const localVarHeaderParameter = {} as any;
|
|
6596
|
+
const localVarQueryParameter = {} as any;
|
|
6597
|
+
|
|
6598
|
+
// authentication BasicAuth required
|
|
6599
|
+
// http basic authentication required
|
|
6600
|
+
setBasicAuthToObject(localVarRequestOptions, configuration)
|
|
6601
|
+
|
|
6602
|
+
// authentication BearerAuth required
|
|
6603
|
+
// http bearer authentication required
|
|
6604
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
6605
|
+
|
|
6606
|
+
|
|
6607
|
+
|
|
6608
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
6609
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
6610
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
6611
|
+
|
|
6612
|
+
return {
|
|
6613
|
+
url: toPathString(localVarUrlObj),
|
|
6614
|
+
options: localVarRequestOptions,
|
|
6615
|
+
};
|
|
6616
|
+
},
|
|
6617
|
+
/**
|
|
6618
|
+
* List all PROFINET input and outputs.
|
|
6619
|
+
* @summary List PROFINET Input/Output Configuration
|
|
6620
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
6621
|
+
* @param {*} [options] Override http request option.
|
|
6622
|
+
* @throws {RequiredError}
|
|
6623
|
+
*/
|
|
6624
|
+
listProfinetIOs: async (cell: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
6625
|
+
// verify required parameter 'cell' is not null or undefined
|
|
6626
|
+
assertParamExists('listProfinetIOs', 'cell', cell)
|
|
6627
|
+
const localVarPath = `/cells/{cell}/bus-ios/profinet/ios`
|
|
6628
|
+
.replace(`{${"cell"}}`, encodeURIComponent(String(cell)));
|
|
6629
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
6630
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
6631
|
+
let baseOptions;
|
|
6632
|
+
if (configuration) {
|
|
6633
|
+
baseOptions = configuration.baseOptions;
|
|
6634
|
+
}
|
|
6635
|
+
|
|
6636
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
6637
|
+
const localVarHeaderParameter = {} as any;
|
|
6638
|
+
const localVarQueryParameter = {} as any;
|
|
6639
|
+
|
|
6640
|
+
// authentication BasicAuth required
|
|
6641
|
+
// http basic authentication required
|
|
6642
|
+
setBasicAuthToObject(localVarRequestOptions, configuration)
|
|
6643
|
+
|
|
6644
|
+
// authentication BearerAuth required
|
|
6645
|
+
// http bearer authentication required
|
|
6646
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
6647
|
+
|
|
6648
|
+
|
|
6649
|
+
|
|
6650
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
6651
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
6652
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
6653
|
+
|
|
6654
|
+
return {
|
|
6655
|
+
url: toPathString(localVarUrlObj),
|
|
6656
|
+
options: localVarRequestOptions,
|
|
6657
|
+
};
|
|
6658
|
+
},
|
|
6659
|
+
/**
|
|
6660
|
+
* 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.
|
|
6661
|
+
* @summary Set Output Values
|
|
6662
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
6663
|
+
* @param {Array<IOValue>} iOValue
|
|
6664
|
+
* @param {*} [options] Override http request option.
|
|
6665
|
+
* @throws {RequiredError}
|
|
6666
|
+
*/
|
|
6667
|
+
setBusIOValues: async (cell: string, iOValue: Array<IOValue>, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
6668
|
+
// verify required parameter 'cell' is not null or undefined
|
|
6669
|
+
assertParamExists('setBusIOValues', 'cell', cell)
|
|
6670
|
+
// verify required parameter 'iOValue' is not null or undefined
|
|
6671
|
+
assertParamExists('setBusIOValues', 'iOValue', iOValue)
|
|
6672
|
+
const localVarPath = `/cells/{cell}/bus-ios/ios/values`
|
|
6673
|
+
.replace(`{${"cell"}}`, encodeURIComponent(String(cell)));
|
|
6674
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
6675
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
6676
|
+
let baseOptions;
|
|
6677
|
+
if (configuration) {
|
|
6678
|
+
baseOptions = configuration.baseOptions;
|
|
6679
|
+
}
|
|
6680
|
+
|
|
6681
|
+
const localVarRequestOptions = { method: 'PUT', ...baseOptions, ...options};
|
|
6682
|
+
const localVarHeaderParameter = {} as any;
|
|
6683
|
+
const localVarQueryParameter = {} as any;
|
|
6684
|
+
|
|
6685
|
+
// authentication BasicAuth required
|
|
6686
|
+
// http basic authentication required
|
|
6687
|
+
setBasicAuthToObject(localVarRequestOptions, configuration)
|
|
6688
|
+
|
|
6689
|
+
// authentication BearerAuth required
|
|
6690
|
+
// http bearer authentication required
|
|
6691
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
6692
|
+
|
|
6693
|
+
|
|
6694
|
+
|
|
6695
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
6696
|
+
|
|
6697
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
6698
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
6699
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
6700
|
+
localVarRequestOptions.data = serializeDataIfNeeded(iOValue, localVarRequestOptions, configuration)
|
|
6701
|
+
|
|
6702
|
+
return {
|
|
6703
|
+
url: toPathString(localVarUrlObj),
|
|
6704
|
+
options: localVarRequestOptions,
|
|
6705
|
+
};
|
|
6706
|
+
},
|
|
6707
|
+
/**
|
|
6708
|
+
* Sets inputs/outputs on the PROFINET device from file.
|
|
6709
|
+
* @summary Set PROFINET Inputs/Outputs from File
|
|
6710
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
6711
|
+
* @param {ProfinetInputOutputConfig} profinetInputOutputConfig
|
|
6712
|
+
* @param {*} [options] Override http request option.
|
|
6713
|
+
* @throws {RequiredError}
|
|
6714
|
+
*/
|
|
6715
|
+
setProfinetIOsFromFile: async (cell: string, profinetInputOutputConfig: ProfinetInputOutputConfig, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
6716
|
+
// verify required parameter 'cell' is not null or undefined
|
|
6717
|
+
assertParamExists('setProfinetIOsFromFile', 'cell', cell)
|
|
6718
|
+
// verify required parameter 'profinetInputOutputConfig' is not null or undefined
|
|
6719
|
+
assertParamExists('setProfinetIOsFromFile', 'profinetInputOutputConfig', profinetInputOutputConfig)
|
|
6720
|
+
const localVarPath = `/cells/{cell}/bus-ios/profinet/iofile`
|
|
6721
|
+
.replace(`{${"cell"}}`, encodeURIComponent(String(cell)));
|
|
6722
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
6723
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
6724
|
+
let baseOptions;
|
|
6725
|
+
if (configuration) {
|
|
6726
|
+
baseOptions = configuration.baseOptions;
|
|
6727
|
+
}
|
|
6728
|
+
|
|
6729
|
+
const localVarRequestOptions = { method: 'PUT', ...baseOptions, ...options};
|
|
6730
|
+
const localVarHeaderParameter = {} as any;
|
|
6731
|
+
const localVarQueryParameter = {} as any;
|
|
6732
|
+
|
|
6733
|
+
// authentication BasicAuth required
|
|
6734
|
+
// http basic authentication required
|
|
6735
|
+
setBasicAuthToObject(localVarRequestOptions, configuration)
|
|
6736
|
+
|
|
6737
|
+
// authentication BearerAuth required
|
|
6738
|
+
// http bearer authentication required
|
|
6739
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
6740
|
+
|
|
6741
|
+
|
|
6742
|
+
|
|
6743
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
6744
|
+
|
|
6745
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
6746
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
6747
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
6748
|
+
localVarRequestOptions.data = serializeDataIfNeeded(profinetInputOutputConfig, localVarRequestOptions, configuration)
|
|
6749
|
+
|
|
6750
|
+
return {
|
|
6751
|
+
url: toPathString(localVarUrlObj),
|
|
6752
|
+
options: localVarRequestOptions,
|
|
6753
|
+
};
|
|
6754
|
+
},
|
|
6755
|
+
}
|
|
6756
|
+
};
|
|
6757
|
+
|
|
6758
|
+
/**
|
|
6759
|
+
* BUSInputsOutputsApi - functional programming interface
|
|
6760
|
+
* @export
|
|
6761
|
+
*/
|
|
6762
|
+
export const BUSInputsOutputsApiFp = function(configuration?: Configuration) {
|
|
6763
|
+
const localVarAxiosParamCreator = BUSInputsOutputsApiAxiosParamCreator(configuration)
|
|
6764
|
+
return {
|
|
6765
|
+
/**
|
|
6766
|
+
* Add a BUS Inputs/Outputs Service to the cell.
|
|
6767
|
+
* @summary Add Service
|
|
6768
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
6769
|
+
* @param {BusIOType} busIOType
|
|
6770
|
+
* @param {number} [completionTimeout]
|
|
6771
|
+
* @param {*} [options] Override http request option.
|
|
6772
|
+
* @throws {RequiredError}
|
|
6773
|
+
*/
|
|
6774
|
+
async addBusIOService(cell: string, busIOType: BusIOType, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> {
|
|
6775
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.addBusIOService(cell, busIOType, completionTimeout, options);
|
|
6776
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
6777
|
+
const localVarOperationServerBasePath = operationServerMap['BUSInputsOutputsApi.addBusIOService']?.[localVarOperationServerIndex]?.url;
|
|
6778
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
6779
|
+
},
|
|
6780
|
+
/**
|
|
6781
|
+
* Adds an input/output to or updates an input/output on the PROFINET device.
|
|
6782
|
+
* @summary Add PROFINET Input/Output
|
|
6783
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
6784
|
+
* @param {string} io Unique identifier to address an Input/Output in the cell.
|
|
6785
|
+
* @param {ProfinetIOData} profinetIOData
|
|
6786
|
+
* @param {*} [options] Override http request option.
|
|
6787
|
+
* @throws {RequiredError}
|
|
6788
|
+
*/
|
|
6789
|
+
async addProfinetIO(cell: string, io: string, profinetIOData: ProfinetIOData, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> {
|
|
6790
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.addProfinetIO(cell, io, profinetIOData, options);
|
|
6791
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
6792
|
+
const localVarOperationServerBasePath = operationServerMap['BUSInputsOutputsApi.addProfinetIO']?.[localVarOperationServerIndex]?.url;
|
|
6793
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
6794
|
+
},
|
|
6795
|
+
/**
|
|
6796
|
+
* Delete BUS Inputs/Outputs Service from the cell.
|
|
6797
|
+
* @summary Clear Service
|
|
6798
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
6799
|
+
* @param {number} [completionTimeout]
|
|
6800
|
+
* @param {*} [options] Override http request option.
|
|
6801
|
+
* @throws {RequiredError}
|
|
6802
|
+
*/
|
|
6803
|
+
async clearBusIOService(cell: string, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> {
|
|
6804
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.clearBusIOService(cell, completionTimeout, options);
|
|
6805
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
6806
|
+
const localVarOperationServerBasePath = operationServerMap['BUSInputsOutputsApi.clearBusIOService']?.[localVarOperationServerIndex]?.url;
|
|
6807
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
6808
|
+
},
|
|
6809
|
+
/**
|
|
6810
|
+
* Removes the input/output from the PROFINET device.
|
|
6811
|
+
* @summary Remove PROFINET Input/Ouptut
|
|
6812
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
6813
|
+
* @param {string} io Unique identifier to address an Input/Output in the cell.
|
|
6814
|
+
* @param {*} [options] Override http request option.
|
|
6815
|
+
* @throws {RequiredError}
|
|
6816
|
+
*/
|
|
6817
|
+
async deleteProfinetIO(cell: string, io: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> {
|
|
6818
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.deleteProfinetIO(cell, io, options);
|
|
6819
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
6820
|
+
const localVarOperationServerBasePath = operationServerMap['BUSInputsOutputsApi.deleteProfinetIO']?.[localVarOperationServerIndex]?.url;
|
|
6821
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
6822
|
+
},
|
|
6823
|
+
/**
|
|
6824
|
+
* Get deployed BUS Inputs/Outputs Service.
|
|
6825
|
+
* @summary Get Service
|
|
6826
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
6827
|
+
* @param {*} [options] Override http request option.
|
|
6828
|
+
* @throws {RequiredError}
|
|
6829
|
+
*/
|
|
6830
|
+
async getBusIOService(cell: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BusIOType>> {
|
|
6831
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.getBusIOService(cell, options);
|
|
6832
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
6833
|
+
const localVarOperationServerBasePath = operationServerMap['BUSInputsOutputsApi.getBusIOService']?.[localVarOperationServerIndex]?.url;
|
|
6834
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
6835
|
+
},
|
|
6836
|
+
/**
|
|
6837
|
+
* Get the current state of the BUS Inputs/Outputs service.
|
|
6838
|
+
* @summary State
|
|
6839
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
6840
|
+
* @param {*} [options] Override http request option.
|
|
6841
|
+
* @throws {RequiredError}
|
|
6842
|
+
*/
|
|
6843
|
+
async getBusIOState(cell: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BusIOsState>> {
|
|
6844
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.getBusIOState(cell, options);
|
|
6845
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
6846
|
+
const localVarOperationServerBasePath = operationServerMap['BUSInputsOutputsApi.getBusIOState']?.[localVarOperationServerIndex]?.url;
|
|
6847
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
6848
|
+
},
|
|
6849
|
+
/**
|
|
6850
|
+
* 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).
|
|
6851
|
+
* @summary Get Input/Output Values
|
|
6852
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
6853
|
+
* @param {Array<string>} [ios]
|
|
6854
|
+
* @param {*} [options] Override http request option.
|
|
6855
|
+
* @throws {RequiredError}
|
|
6856
|
+
*/
|
|
6857
|
+
async getBusIOValues(cell: string, ios?: Array<string>, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<IOValue>>> {
|
|
6858
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.getBusIOValues(cell, ios, options);
|
|
6859
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
6860
|
+
const localVarOperationServerBasePath = operationServerMap['BUSInputsOutputsApi.getBusIOValues']?.[localVarOperationServerIndex]?.url;
|
|
6861
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
6862
|
+
},
|
|
6863
|
+
/**
|
|
6864
|
+
* Get description of PROFINET
|
|
6865
|
+
* @summary Get PROFINET Description
|
|
6866
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
6867
|
+
* @param {*} [options] Override http request option.
|
|
6868
|
+
* @throws {RequiredError}
|
|
6869
|
+
*/
|
|
6870
|
+
async getProfinetDescription(cell: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ProfinetDescription>> {
|
|
6871
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.getProfinetDescription(cell, options);
|
|
6872
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
6873
|
+
const localVarOperationServerBasePath = operationServerMap['BUSInputsOutputsApi.getProfinetDescription']?.[localVarOperationServerIndex]?.url;
|
|
6874
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
6875
|
+
},
|
|
6876
|
+
/**
|
|
6877
|
+
* Get input/output configuration of the PROFINET device as file.
|
|
6878
|
+
* @summary PROFINET Inputs/Outputs to File
|
|
6879
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
6880
|
+
* @param {number} [inputOffset]
|
|
6881
|
+
* @param {number} [outputOffset]
|
|
6882
|
+
* @param {*} [options] Override http request option.
|
|
6883
|
+
* @throws {RequiredError}
|
|
6884
|
+
*/
|
|
6885
|
+
async getProfinetIOsFromFile(cell: string, inputOffset?: number, outputOffset?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<string>> {
|
|
6886
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.getProfinetIOsFromFile(cell, inputOffset, outputOffset, options);
|
|
6887
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
6888
|
+
const localVarOperationServerBasePath = operationServerMap['BUSInputsOutputsApi.getProfinetIOsFromFile']?.[localVarOperationServerIndex]?.url;
|
|
6889
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
6890
|
+
},
|
|
6891
|
+
/**
|
|
6892
|
+
* List all BUS Input/Output descriptions.
|
|
6893
|
+
* @summary List Descriptions
|
|
6894
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
6895
|
+
* @param {*} [options] Override http request option.
|
|
6896
|
+
* @throws {RequiredError}
|
|
6897
|
+
*/
|
|
6898
|
+
async listBusIODescriptions(cell: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<IODescription>>> {
|
|
6899
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.listBusIODescriptions(cell, options);
|
|
6900
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
6901
|
+
const localVarOperationServerBasePath = operationServerMap['BUSInputsOutputsApi.listBusIODescriptions']?.[localVarOperationServerIndex]?.url;
|
|
6902
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
6903
|
+
},
|
|
6904
|
+
/**
|
|
6905
|
+
* List all PROFINET input and outputs.
|
|
6906
|
+
* @summary List PROFINET Input/Output Configuration
|
|
6907
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
6908
|
+
* @param {*} [options] Override http request option.
|
|
6909
|
+
* @throws {RequiredError}
|
|
6910
|
+
*/
|
|
6911
|
+
async listProfinetIOs(cell: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<ProfinetIO>>> {
|
|
6912
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.listProfinetIOs(cell, options);
|
|
6913
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
6914
|
+
const localVarOperationServerBasePath = operationServerMap['BUSInputsOutputsApi.listProfinetIOs']?.[localVarOperationServerIndex]?.url;
|
|
6915
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
6916
|
+
},
|
|
6917
|
+
/**
|
|
6918
|
+
* 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.
|
|
6919
|
+
* @summary Set Output Values
|
|
6920
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
6921
|
+
* @param {Array<IOValue>} iOValue
|
|
6922
|
+
* @param {*} [options] Override http request option.
|
|
6923
|
+
* @throws {RequiredError}
|
|
6924
|
+
*/
|
|
6925
|
+
async setBusIOValues(cell: string, iOValue: Array<IOValue>, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> {
|
|
6926
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.setBusIOValues(cell, iOValue, options);
|
|
6927
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
6928
|
+
const localVarOperationServerBasePath = operationServerMap['BUSInputsOutputsApi.setBusIOValues']?.[localVarOperationServerIndex]?.url;
|
|
6929
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
6930
|
+
},
|
|
6931
|
+
/**
|
|
6932
|
+
* Sets inputs/outputs on the PROFINET device from file.
|
|
6933
|
+
* @summary Set PROFINET Inputs/Outputs from File
|
|
6934
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
6935
|
+
* @param {ProfinetInputOutputConfig} profinetInputOutputConfig
|
|
6936
|
+
* @param {*} [options] Override http request option.
|
|
6937
|
+
* @throws {RequiredError}
|
|
6938
|
+
*/
|
|
6939
|
+
async setProfinetIOsFromFile(cell: string, profinetInputOutputConfig: ProfinetInputOutputConfig, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> {
|
|
6940
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.setProfinetIOsFromFile(cell, profinetInputOutputConfig, options);
|
|
6941
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
6942
|
+
const localVarOperationServerBasePath = operationServerMap['BUSInputsOutputsApi.setProfinetIOsFromFile']?.[localVarOperationServerIndex]?.url;
|
|
6943
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
6944
|
+
},
|
|
6945
|
+
}
|
|
6946
|
+
};
|
|
6947
|
+
|
|
6948
|
+
/**
|
|
6949
|
+
* BUSInputsOutputsApi - factory interface
|
|
6950
|
+
* @export
|
|
6951
|
+
*/
|
|
6952
|
+
export const BUSInputsOutputsApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
|
|
6953
|
+
const localVarFp = BUSInputsOutputsApiFp(configuration)
|
|
6954
|
+
return {
|
|
6955
|
+
/**
|
|
6956
|
+
* Add a BUS Inputs/Outputs Service to the cell.
|
|
6957
|
+
* @summary Add Service
|
|
6958
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
6959
|
+
* @param {BusIOType} busIOType
|
|
6960
|
+
* @param {number} [completionTimeout]
|
|
6961
|
+
* @param {*} [options] Override http request option.
|
|
6962
|
+
* @throws {RequiredError}
|
|
6963
|
+
*/
|
|
6964
|
+
addBusIOService(cell: string, busIOType: BusIOType, completionTimeout?: number, options?: RawAxiosRequestConfig): AxiosPromise<void> {
|
|
6965
|
+
return localVarFp.addBusIOService(cell, busIOType, completionTimeout, options).then((request) => request(axios, basePath));
|
|
6966
|
+
},
|
|
6967
|
+
/**
|
|
6968
|
+
* Adds an input/output to or updates an input/output on the PROFINET device.
|
|
6969
|
+
* @summary Add PROFINET Input/Output
|
|
6970
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
6971
|
+
* @param {string} io Unique identifier to address an Input/Output in the cell.
|
|
6972
|
+
* @param {ProfinetIOData} profinetIOData
|
|
6973
|
+
* @param {*} [options] Override http request option.
|
|
6974
|
+
* @throws {RequiredError}
|
|
6975
|
+
*/
|
|
6976
|
+
addProfinetIO(cell: string, io: string, profinetIOData: ProfinetIOData, options?: RawAxiosRequestConfig): AxiosPromise<void> {
|
|
6977
|
+
return localVarFp.addProfinetIO(cell, io, profinetIOData, options).then((request) => request(axios, basePath));
|
|
6978
|
+
},
|
|
6979
|
+
/**
|
|
6980
|
+
* Delete BUS Inputs/Outputs Service from the cell.
|
|
6981
|
+
* @summary Clear Service
|
|
6982
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
6983
|
+
* @param {number} [completionTimeout]
|
|
6984
|
+
* @param {*} [options] Override http request option.
|
|
6985
|
+
* @throws {RequiredError}
|
|
6986
|
+
*/
|
|
6987
|
+
clearBusIOService(cell: string, completionTimeout?: number, options?: RawAxiosRequestConfig): AxiosPromise<void> {
|
|
6988
|
+
return localVarFp.clearBusIOService(cell, completionTimeout, options).then((request) => request(axios, basePath));
|
|
6989
|
+
},
|
|
6990
|
+
/**
|
|
6991
|
+
* Removes the input/output from the PROFINET device.
|
|
6992
|
+
* @summary Remove PROFINET Input/Ouptut
|
|
6993
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
6994
|
+
* @param {string} io Unique identifier to address an Input/Output in the cell.
|
|
6995
|
+
* @param {*} [options] Override http request option.
|
|
6996
|
+
* @throws {RequiredError}
|
|
6997
|
+
*/
|
|
6998
|
+
deleteProfinetIO(cell: string, io: string, options?: RawAxiosRequestConfig): AxiosPromise<void> {
|
|
6999
|
+
return localVarFp.deleteProfinetIO(cell, io, options).then((request) => request(axios, basePath));
|
|
7000
|
+
},
|
|
7001
|
+
/**
|
|
7002
|
+
* Get deployed BUS Inputs/Outputs Service.
|
|
7003
|
+
* @summary Get Service
|
|
7004
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
7005
|
+
* @param {*} [options] Override http request option.
|
|
7006
|
+
* @throws {RequiredError}
|
|
7007
|
+
*/
|
|
7008
|
+
getBusIOService(cell: string, options?: RawAxiosRequestConfig): AxiosPromise<BusIOType> {
|
|
7009
|
+
return localVarFp.getBusIOService(cell, options).then((request) => request(axios, basePath));
|
|
7010
|
+
},
|
|
7011
|
+
/**
|
|
7012
|
+
* Get the current state of the BUS Inputs/Outputs service.
|
|
7013
|
+
* @summary State
|
|
7014
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
7015
|
+
* @param {*} [options] Override http request option.
|
|
7016
|
+
* @throws {RequiredError}
|
|
7017
|
+
*/
|
|
7018
|
+
getBusIOState(cell: string, options?: RawAxiosRequestConfig): AxiosPromise<BusIOsState> {
|
|
7019
|
+
return localVarFp.getBusIOState(cell, options).then((request) => request(axios, basePath));
|
|
7020
|
+
},
|
|
7021
|
+
/**
|
|
7022
|
+
* 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).
|
|
7023
|
+
* @summary Get Input/Output Values
|
|
7024
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
7025
|
+
* @param {Array<string>} [ios]
|
|
7026
|
+
* @param {*} [options] Override http request option.
|
|
7027
|
+
* @throws {RequiredError}
|
|
7028
|
+
*/
|
|
7029
|
+
getBusIOValues(cell: string, ios?: Array<string>, options?: RawAxiosRequestConfig): AxiosPromise<Array<IOValue>> {
|
|
7030
|
+
return localVarFp.getBusIOValues(cell, ios, options).then((request) => request(axios, basePath));
|
|
7031
|
+
},
|
|
7032
|
+
/**
|
|
7033
|
+
* Get description of PROFINET
|
|
7034
|
+
* @summary Get PROFINET Description
|
|
7035
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
7036
|
+
* @param {*} [options] Override http request option.
|
|
7037
|
+
* @throws {RequiredError}
|
|
7038
|
+
*/
|
|
7039
|
+
getProfinetDescription(cell: string, options?: RawAxiosRequestConfig): AxiosPromise<ProfinetDescription> {
|
|
7040
|
+
return localVarFp.getProfinetDescription(cell, options).then((request) => request(axios, basePath));
|
|
7041
|
+
},
|
|
7042
|
+
/**
|
|
7043
|
+
* Get input/output configuration of the PROFINET device as file.
|
|
7044
|
+
* @summary PROFINET Inputs/Outputs to File
|
|
7045
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
7046
|
+
* @param {number} [inputOffset]
|
|
7047
|
+
* @param {number} [outputOffset]
|
|
7048
|
+
* @param {*} [options] Override http request option.
|
|
7049
|
+
* @throws {RequiredError}
|
|
7050
|
+
*/
|
|
7051
|
+
getProfinetIOsFromFile(cell: string, inputOffset?: number, outputOffset?: number, options?: RawAxiosRequestConfig): AxiosPromise<string> {
|
|
7052
|
+
return localVarFp.getProfinetIOsFromFile(cell, inputOffset, outputOffset, options).then((request) => request(axios, basePath));
|
|
7053
|
+
},
|
|
7054
|
+
/**
|
|
7055
|
+
* List all BUS Input/Output descriptions.
|
|
7056
|
+
* @summary List Descriptions
|
|
7057
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
7058
|
+
* @param {*} [options] Override http request option.
|
|
7059
|
+
* @throws {RequiredError}
|
|
7060
|
+
*/
|
|
7061
|
+
listBusIODescriptions(cell: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<IODescription>> {
|
|
7062
|
+
return localVarFp.listBusIODescriptions(cell, options).then((request) => request(axios, basePath));
|
|
7063
|
+
},
|
|
7064
|
+
/**
|
|
7065
|
+
* List all PROFINET input and outputs.
|
|
7066
|
+
* @summary List PROFINET Input/Output Configuration
|
|
7067
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
7068
|
+
* @param {*} [options] Override http request option.
|
|
7069
|
+
* @throws {RequiredError}
|
|
7070
|
+
*/
|
|
7071
|
+
listProfinetIOs(cell: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<ProfinetIO>> {
|
|
7072
|
+
return localVarFp.listProfinetIOs(cell, options).then((request) => request(axios, basePath));
|
|
7073
|
+
},
|
|
7074
|
+
/**
|
|
7075
|
+
* 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.
|
|
7076
|
+
* @summary Set Output Values
|
|
7077
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
7078
|
+
* @param {Array<IOValue>} iOValue
|
|
7079
|
+
* @param {*} [options] Override http request option.
|
|
7080
|
+
* @throws {RequiredError}
|
|
7081
|
+
*/
|
|
7082
|
+
setBusIOValues(cell: string, iOValue: Array<IOValue>, options?: RawAxiosRequestConfig): AxiosPromise<void> {
|
|
7083
|
+
return localVarFp.setBusIOValues(cell, iOValue, options).then((request) => request(axios, basePath));
|
|
7084
|
+
},
|
|
7085
|
+
/**
|
|
7086
|
+
* Sets inputs/outputs on the PROFINET device from file.
|
|
7087
|
+
* @summary Set PROFINET Inputs/Outputs from File
|
|
7088
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
7089
|
+
* @param {ProfinetInputOutputConfig} profinetInputOutputConfig
|
|
7090
|
+
* @param {*} [options] Override http request option.
|
|
7091
|
+
* @throws {RequiredError}
|
|
7092
|
+
*/
|
|
7093
|
+
setProfinetIOsFromFile(cell: string, profinetInputOutputConfig: ProfinetInputOutputConfig, options?: RawAxiosRequestConfig): AxiosPromise<void> {
|
|
7094
|
+
return localVarFp.setProfinetIOsFromFile(cell, profinetInputOutputConfig, options).then((request) => request(axios, basePath));
|
|
7095
|
+
},
|
|
7096
|
+
};
|
|
7097
|
+
};
|
|
7098
|
+
|
|
7099
|
+
/**
|
|
7100
|
+
* BUSInputsOutputsApi - object-oriented interface
|
|
7101
|
+
* @export
|
|
7102
|
+
* @class BUSInputsOutputsApi
|
|
7103
|
+
* @extends {BaseAPI}
|
|
7104
|
+
*/
|
|
7105
|
+
export class BUSInputsOutputsApi extends BaseAPI {
|
|
7106
|
+
/**
|
|
7107
|
+
* Add a BUS Inputs/Outputs Service to the cell.
|
|
7108
|
+
* @summary Add Service
|
|
7109
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
7110
|
+
* @param {BusIOType} busIOType
|
|
7111
|
+
* @param {number} [completionTimeout]
|
|
7112
|
+
* @param {*} [options] Override http request option.
|
|
7113
|
+
* @throws {RequiredError}
|
|
7114
|
+
* @memberof BUSInputsOutputsApi
|
|
7115
|
+
*/
|
|
7116
|
+
public addBusIOService(cell: string, busIOType: BusIOType, completionTimeout?: number, options?: RawAxiosRequestConfig) {
|
|
7117
|
+
return BUSInputsOutputsApiFp(this.configuration).addBusIOService(cell, busIOType, completionTimeout, options).then((request) => request(this.axios, this.basePath));
|
|
7118
|
+
}
|
|
7119
|
+
|
|
7120
|
+
/**
|
|
7121
|
+
* Adds an input/output to or updates an input/output on the PROFINET device.
|
|
7122
|
+
* @summary Add PROFINET Input/Output
|
|
7123
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
7124
|
+
* @param {string} io Unique identifier to address an Input/Output in the cell.
|
|
7125
|
+
* @param {ProfinetIOData} profinetIOData
|
|
7126
|
+
* @param {*} [options] Override http request option.
|
|
7127
|
+
* @throws {RequiredError}
|
|
7128
|
+
* @memberof BUSInputsOutputsApi
|
|
7129
|
+
*/
|
|
7130
|
+
public addProfinetIO(cell: string, io: string, profinetIOData: ProfinetIOData, options?: RawAxiosRequestConfig) {
|
|
7131
|
+
return BUSInputsOutputsApiFp(this.configuration).addProfinetIO(cell, io, profinetIOData, options).then((request) => request(this.axios, this.basePath));
|
|
7132
|
+
}
|
|
7133
|
+
|
|
7134
|
+
/**
|
|
7135
|
+
* Delete BUS Inputs/Outputs Service from the cell.
|
|
7136
|
+
* @summary Clear Service
|
|
7137
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
7138
|
+
* @param {number} [completionTimeout]
|
|
7139
|
+
* @param {*} [options] Override http request option.
|
|
7140
|
+
* @throws {RequiredError}
|
|
7141
|
+
* @memberof BUSInputsOutputsApi
|
|
7142
|
+
*/
|
|
7143
|
+
public clearBusIOService(cell: string, completionTimeout?: number, options?: RawAxiosRequestConfig) {
|
|
7144
|
+
return BUSInputsOutputsApiFp(this.configuration).clearBusIOService(cell, completionTimeout, options).then((request) => request(this.axios, this.basePath));
|
|
7145
|
+
}
|
|
7146
|
+
|
|
7147
|
+
/**
|
|
7148
|
+
* Removes the input/output from the PROFINET device.
|
|
7149
|
+
* @summary Remove PROFINET Input/Ouptut
|
|
7150
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
7151
|
+
* @param {string} io Unique identifier to address an Input/Output in the cell.
|
|
7152
|
+
* @param {*} [options] Override http request option.
|
|
7153
|
+
* @throws {RequiredError}
|
|
7154
|
+
* @memberof BUSInputsOutputsApi
|
|
7155
|
+
*/
|
|
7156
|
+
public deleteProfinetIO(cell: string, io: string, options?: RawAxiosRequestConfig) {
|
|
7157
|
+
return BUSInputsOutputsApiFp(this.configuration).deleteProfinetIO(cell, io, options).then((request) => request(this.axios, this.basePath));
|
|
7158
|
+
}
|
|
7159
|
+
|
|
7160
|
+
/**
|
|
7161
|
+
* Get deployed BUS Inputs/Outputs Service.
|
|
7162
|
+
* @summary Get Service
|
|
7163
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
7164
|
+
* @param {*} [options] Override http request option.
|
|
7165
|
+
* @throws {RequiredError}
|
|
7166
|
+
* @memberof BUSInputsOutputsApi
|
|
7167
|
+
*/
|
|
7168
|
+
public getBusIOService(cell: string, options?: RawAxiosRequestConfig) {
|
|
7169
|
+
return BUSInputsOutputsApiFp(this.configuration).getBusIOService(cell, options).then((request) => request(this.axios, this.basePath));
|
|
7170
|
+
}
|
|
7171
|
+
|
|
7172
|
+
/**
|
|
7173
|
+
* Get the current state of the BUS Inputs/Outputs service.
|
|
7174
|
+
* @summary State
|
|
7175
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
7176
|
+
* @param {*} [options] Override http request option.
|
|
7177
|
+
* @throws {RequiredError}
|
|
7178
|
+
* @memberof BUSInputsOutputsApi
|
|
7179
|
+
*/
|
|
7180
|
+
public getBusIOState(cell: string, options?: RawAxiosRequestConfig) {
|
|
7181
|
+
return BUSInputsOutputsApiFp(this.configuration).getBusIOState(cell, options).then((request) => request(this.axios, this.basePath));
|
|
7182
|
+
}
|
|
7183
|
+
|
|
5270
7184
|
/**
|
|
5271
|
-
*
|
|
5272
|
-
* @summary
|
|
7185
|
+
* 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).
|
|
7186
|
+
* @summary Get Input/Output Values
|
|
5273
7187
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5274
|
-
* @param {
|
|
5275
|
-
* @param {number} [completionTimeout]
|
|
7188
|
+
* @param {Array<string>} [ios]
|
|
5276
7189
|
* @param {*} [options] Override http request option.
|
|
5277
7190
|
* @throws {RequiredError}
|
|
5278
|
-
* @memberof
|
|
7191
|
+
* @memberof BUSInputsOutputsApi
|
|
5279
7192
|
*/
|
|
5280
|
-
public
|
|
5281
|
-
return
|
|
7193
|
+
public getBusIOValues(cell: string, ios?: Array<string>, options?: RawAxiosRequestConfig) {
|
|
7194
|
+
return BUSInputsOutputsApiFp(this.configuration).getBusIOValues(cell, ios, options).then((request) => request(this.axios, this.basePath));
|
|
5282
7195
|
}
|
|
5283
7196
|
|
|
5284
7197
|
/**
|
|
5285
|
-
*
|
|
5286
|
-
* @summary
|
|
7198
|
+
* Get description of PROFINET
|
|
7199
|
+
* @summary Get PROFINET Description
|
|
5287
7200
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5288
|
-
* @param {number} [completionTimeout]
|
|
5289
7201
|
* @param {*} [options] Override http request option.
|
|
5290
7202
|
* @throws {RequiredError}
|
|
5291
|
-
* @memberof
|
|
7203
|
+
* @memberof BUSInputsOutputsApi
|
|
5292
7204
|
*/
|
|
5293
|
-
public
|
|
5294
|
-
return
|
|
7205
|
+
public getProfinetDescription(cell: string, options?: RawAxiosRequestConfig) {
|
|
7206
|
+
return BUSInputsOutputsApiFp(this.configuration).getProfinetDescription(cell, options).then((request) => request(this.axios, this.basePath));
|
|
5295
7207
|
}
|
|
5296
7208
|
|
|
5297
7209
|
/**
|
|
5298
|
-
*
|
|
5299
|
-
* @summary
|
|
7210
|
+
* Get input/output configuration of the PROFINET device as file.
|
|
7211
|
+
* @summary PROFINET Inputs/Outputs to File
|
|
5300
7212
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5301
|
-
* @param {
|
|
5302
|
-
* @param {number} [
|
|
7213
|
+
* @param {number} [inputOffset]
|
|
7214
|
+
* @param {number} [outputOffset]
|
|
5303
7215
|
* @param {*} [options] Override http request option.
|
|
5304
7216
|
* @throws {RequiredError}
|
|
5305
|
-
* @memberof
|
|
7217
|
+
* @memberof BUSInputsOutputsApi
|
|
5306
7218
|
*/
|
|
5307
|
-
public
|
|
5308
|
-
return
|
|
7219
|
+
public getProfinetIOsFromFile(cell: string, inputOffset?: number, outputOffset?: number, options?: RawAxiosRequestConfig) {
|
|
7220
|
+
return BUSInputsOutputsApiFp(this.configuration).getProfinetIOsFromFile(cell, inputOffset, outputOffset, options).then((request) => request(this.axios, this.basePath));
|
|
5309
7221
|
}
|
|
5310
7222
|
|
|
5311
7223
|
/**
|
|
5312
|
-
*
|
|
5313
|
-
* @summary
|
|
7224
|
+
* List all BUS Input/Output descriptions.
|
|
7225
|
+
* @summary List Descriptions
|
|
5314
7226
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5315
|
-
* @param {string} app
|
|
5316
7227
|
* @param {*} [options] Override http request option.
|
|
5317
7228
|
* @throws {RequiredError}
|
|
5318
|
-
* @memberof
|
|
7229
|
+
* @memberof BUSInputsOutputsApi
|
|
5319
7230
|
*/
|
|
5320
|
-
public
|
|
5321
|
-
return
|
|
7231
|
+
public listBusIODescriptions(cell: string, options?: RawAxiosRequestConfig) {
|
|
7232
|
+
return BUSInputsOutputsApiFp(this.configuration).listBusIODescriptions(cell, options).then((request) => request(this.axios, this.basePath));
|
|
5322
7233
|
}
|
|
5323
7234
|
|
|
5324
7235
|
/**
|
|
5325
|
-
* List all
|
|
5326
|
-
* @summary List
|
|
7236
|
+
* List all PROFINET input and outputs.
|
|
7237
|
+
* @summary List PROFINET Input/Output Configuration
|
|
5327
7238
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5328
7239
|
* @param {*} [options] Override http request option.
|
|
5329
7240
|
* @throws {RequiredError}
|
|
5330
|
-
* @memberof
|
|
7241
|
+
* @memberof BUSInputsOutputsApi
|
|
5331
7242
|
*/
|
|
5332
|
-
public
|
|
5333
|
-
return
|
|
7243
|
+
public listProfinetIOs(cell: string, options?: RawAxiosRequestConfig) {
|
|
7244
|
+
return BUSInputsOutputsApiFp(this.configuration).listProfinetIOs(cell, options).then((request) => request(this.axios, this.basePath));
|
|
5334
7245
|
}
|
|
5335
7246
|
|
|
5336
7247
|
/**
|
|
5337
|
-
*
|
|
5338
|
-
* @summary
|
|
7248
|
+
* 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.
|
|
7249
|
+
* @summary Set Output Values
|
|
5339
7250
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5340
|
-
* @param {
|
|
5341
|
-
* @param {App} app2
|
|
5342
|
-
* @param {number} [completionTimeout]
|
|
7251
|
+
* @param {Array<IOValue>} iOValue
|
|
5343
7252
|
* @param {*} [options] Override http request option.
|
|
5344
7253
|
* @throws {RequiredError}
|
|
5345
|
-
* @memberof
|
|
7254
|
+
* @memberof BUSInputsOutputsApi
|
|
5346
7255
|
*/
|
|
5347
|
-
public
|
|
5348
|
-
return
|
|
7256
|
+
public setBusIOValues(cell: string, iOValue: Array<IOValue>, options?: RawAxiosRequestConfig) {
|
|
7257
|
+
return BUSInputsOutputsApiFp(this.configuration).setBusIOValues(cell, iOValue, options).then((request) => request(this.axios, this.basePath));
|
|
7258
|
+
}
|
|
7259
|
+
|
|
7260
|
+
/**
|
|
7261
|
+
* Sets inputs/outputs on the PROFINET device from file.
|
|
7262
|
+
* @summary Set PROFINET Inputs/Outputs from File
|
|
7263
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
7264
|
+
* @param {ProfinetInputOutputConfig} profinetInputOutputConfig
|
|
7265
|
+
* @param {*} [options] Override http request option.
|
|
7266
|
+
* @throws {RequiredError}
|
|
7267
|
+
* @memberof BUSInputsOutputsApi
|
|
7268
|
+
*/
|
|
7269
|
+
public setProfinetIOsFromFile(cell: string, profinetInputOutputConfig: ProfinetInputOutputConfig, options?: RawAxiosRequestConfig) {
|
|
7270
|
+
return BUSInputsOutputsApiFp(this.configuration).setProfinetIOsFromFile(cell, profinetInputOutputConfig, options).then((request) => request(this.axios, this.basePath));
|
|
5349
7271
|
}
|
|
5350
7272
|
}
|
|
5351
7273
|
|
|
@@ -6262,52 +8184,6 @@ export const ControllerApiAxiosParamCreator = function (configuration?: Configur
|
|
|
6262
8184
|
|
|
6263
8185
|
|
|
6264
8186
|
|
|
6265
|
-
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
6266
|
-
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
6267
|
-
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
6268
|
-
|
|
6269
|
-
return {
|
|
6270
|
-
url: toPathString(localVarUrlObj),
|
|
6271
|
-
options: localVarRequestOptions,
|
|
6272
|
-
};
|
|
6273
|
-
},
|
|
6274
|
-
/**
|
|
6275
|
-
* 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).
|
|
6276
|
-
* @summary Current Mode
|
|
6277
|
-
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
6278
|
-
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
6279
|
-
* @param {*} [options] Override http request option.
|
|
6280
|
-
* @throws {RequiredError}
|
|
6281
|
-
*/
|
|
6282
|
-
getMode: async (cell: string, controller: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
6283
|
-
// verify required parameter 'cell' is not null or undefined
|
|
6284
|
-
assertParamExists('getMode', 'cell', cell)
|
|
6285
|
-
// verify required parameter 'controller' is not null or undefined
|
|
6286
|
-
assertParamExists('getMode', 'controller', controller)
|
|
6287
|
-
const localVarPath = `/cells/{cell}/controllers/{controller}/mode`
|
|
6288
|
-
.replace(`{${"cell"}}`, encodeURIComponent(String(cell)))
|
|
6289
|
-
.replace(`{${"controller"}}`, encodeURIComponent(String(controller)));
|
|
6290
|
-
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
6291
|
-
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
6292
|
-
let baseOptions;
|
|
6293
|
-
if (configuration) {
|
|
6294
|
-
baseOptions = configuration.baseOptions;
|
|
6295
|
-
}
|
|
6296
|
-
|
|
6297
|
-
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
6298
|
-
const localVarHeaderParameter = {} as any;
|
|
6299
|
-
const localVarQueryParameter = {} as any;
|
|
6300
|
-
|
|
6301
|
-
// authentication BasicAuth required
|
|
6302
|
-
// http basic authentication required
|
|
6303
|
-
setBasicAuthToObject(localVarRequestOptions, configuration)
|
|
6304
|
-
|
|
6305
|
-
// authentication BearerAuth required
|
|
6306
|
-
// http bearer authentication required
|
|
6307
|
-
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
6308
|
-
|
|
6309
|
-
|
|
6310
|
-
|
|
6311
8187
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
6312
8188
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
6313
8189
|
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
@@ -6503,7 +8379,7 @@ export const ControllerApiAxiosParamCreator = function (configuration?: Configur
|
|
|
6503
8379
|
};
|
|
6504
8380
|
},
|
|
6505
8381
|
/**
|
|
6506
|
-
* Switch between monitor and control usage as default for a robot controller. Monitoring mode is used to read information from the robot controller and control mode is used to command the robot system. As long as the robot controller is connected via network monitoring mode is always possible. To switch to control mode the robot controller must be in `automatic` or `manual` operating mode and safety state \'normal\' or \'reduced\'. If the robot controller is in `manual` operating mode, you have manually confirm the control usage activation on the robot control panel. This manual confirmation can\'t be replaced with this API. Without manual confirmation the robot controller will stay in monitor mode. The robot system will try to activate the required operation mode for the requested usage unless no active call requires a different mode. > **NOTE** > > Some robot controllers prevent the external activation of automatic operating mode. In this case, changing the operating mode manually at the robot controller is mandatory. > **NOTE** > > The current operation mode and safety state can be requested via [getCurrentRobotControllerState](getCurrentRobotControllerState). If a mode change is not possible, the response lists reasons for the failed change.
|
|
8382
|
+
* Switch between monitor and control usage as default for a robot controller. Monitoring mode is used to read information from the robot controller and control mode is used to command the robot system. As long as the robot controller is connected via network monitoring mode is always possible. To switch to control mode the robot controller must be in `automatic` or `manual` operating mode and safety state \'normal\' or \'reduced\'. If the robot controller is in `manual` operating mode, you have manually confirm the control usage activation on the robot control panel. This manual confirmation can\'t be replaced with this API. Without manual confirmation the robot controller will stay in monitor mode. The robot system will try to activate the required operation mode for the requested usage unless no active call requires a different mode. > **NOTE** > > `setDefaultMode` enables the robot controller to stay in control mode to keep the motors activated. > This allows for faster execution of sequential movements as no mode switches are required. > **NOTE** > > Some robot controllers prevent the external activation of automatic operating mode. In this case, changing the operating mode manually at the robot controller is mandatory. > **NOTE** > > The current operation mode and safety state can be requested via [getCurrentRobotControllerState](getCurrentRobotControllerState). If a mode change is not possible, the response lists reasons for the failed change.
|
|
6507
8383
|
* @summary Set Default Mode
|
|
6508
8384
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
6509
8385
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -6607,15 +8483,16 @@ export const ControllerApiAxiosParamCreator = function (configuration?: Configur
|
|
|
6607
8483
|
};
|
|
6608
8484
|
},
|
|
6609
8485
|
/**
|
|
6610
|
-
* <!-- theme: danger --> > Websocket endpoint Receive updates of the state of a robot controller.
|
|
8486
|
+
* <!-- 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.
|
|
6611
8487
|
* @summary Stream State
|
|
6612
8488
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
6613
8489
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
6614
8490
|
* @param {number} [responseRate]
|
|
8491
|
+
* @param {number} [addControllerTimeout]
|
|
6615
8492
|
* @param {*} [options] Override http request option.
|
|
6616
8493
|
* @throws {RequiredError}
|
|
6617
8494
|
*/
|
|
6618
|
-
streamRobotControllerState: async (cell: string, controller: string, responseRate?: number, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
8495
|
+
streamRobotControllerState: async (cell: string, controller: string, responseRate?: number, addControllerTimeout?: number, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
6619
8496
|
// verify required parameter 'cell' is not null or undefined
|
|
6620
8497
|
assertParamExists('streamRobotControllerState', 'cell', cell)
|
|
6621
8498
|
// verify required parameter 'controller' is not null or undefined
|
|
@@ -6646,6 +8523,10 @@ export const ControllerApiAxiosParamCreator = function (configuration?: Configur
|
|
|
6646
8523
|
localVarQueryParameter['response_rate'] = responseRate;
|
|
6647
8524
|
}
|
|
6648
8525
|
|
|
8526
|
+
if (addControllerTimeout !== undefined) {
|
|
8527
|
+
localVarQueryParameter['add_controller_timeout'] = addControllerTimeout;
|
|
8528
|
+
}
|
|
8529
|
+
|
|
6649
8530
|
|
|
6650
8531
|
|
|
6651
8532
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
@@ -6812,20 +8693,6 @@ export const ControllerApiFp = function(configuration?: Configuration) {
|
|
|
6812
8693
|
const localVarOperationServerBasePath = operationServerMap['ControllerApi.getCurrentRobotControllerState']?.[localVarOperationServerIndex]?.url;
|
|
6813
8694
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
6814
8695
|
},
|
|
6815
|
-
/**
|
|
6816
|
-
* 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).
|
|
6817
|
-
* @summary Current Mode
|
|
6818
|
-
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
6819
|
-
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
6820
|
-
* @param {*} [options] Override http request option.
|
|
6821
|
-
* @throws {RequiredError}
|
|
6822
|
-
*/
|
|
6823
|
-
async getMode(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetModeResponse>> {
|
|
6824
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.getMode(cell, controller, options);
|
|
6825
|
-
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
6826
|
-
const localVarOperationServerBasePath = operationServerMap['ControllerApi.getMode']?.[localVarOperationServerIndex]?.url;
|
|
6827
|
-
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
6828
|
-
},
|
|
6829
8696
|
/**
|
|
6830
8697
|
* Get the configuration for a robot controller.
|
|
6831
8698
|
* @summary Robot Controller
|
|
@@ -6883,7 +8750,7 @@ export const ControllerApiFp = function(configuration?: Configuration) {
|
|
|
6883
8750
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
6884
8751
|
},
|
|
6885
8752
|
/**
|
|
6886
|
-
* Switch between monitor and control usage as default for a robot controller. Monitoring mode is used to read information from the robot controller and control mode is used to command the robot system. As long as the robot controller is connected via network monitoring mode is always possible. To switch to control mode the robot controller must be in `automatic` or `manual` operating mode and safety state \'normal\' or \'reduced\'. If the robot controller is in `manual` operating mode, you have manually confirm the control usage activation on the robot control panel. This manual confirmation can\'t be replaced with this API. Without manual confirmation the robot controller will stay in monitor mode. The robot system will try to activate the required operation mode for the requested usage unless no active call requires a different mode. > **NOTE** > > Some robot controllers prevent the external activation of automatic operating mode. In this case, changing the operating mode manually at the robot controller is mandatory. > **NOTE** > > The current operation mode and safety state can be requested via [getCurrentRobotControllerState](getCurrentRobotControllerState). If a mode change is not possible, the response lists reasons for the failed change.
|
|
8753
|
+
* Switch between monitor and control usage as default for a robot controller. Monitoring mode is used to read information from the robot controller and control mode is used to command the robot system. As long as the robot controller is connected via network monitoring mode is always possible. To switch to control mode the robot controller must be in `automatic` or `manual` operating mode and safety state \'normal\' or \'reduced\'. If the robot controller is in `manual` operating mode, you have manually confirm the control usage activation on the robot control panel. This manual confirmation can\'t be replaced with this API. Without manual confirmation the robot controller will stay in monitor mode. The robot system will try to activate the required operation mode for the requested usage unless no active call requires a different mode. > **NOTE** > > `setDefaultMode` enables the robot controller to stay in control mode to keep the motors activated. > This allows for faster execution of sequential movements as no mode switches are required. > **NOTE** > > Some robot controllers prevent the external activation of automatic operating mode. In this case, changing the operating mode manually at the robot controller is mandatory. > **NOTE** > > The current operation mode and safety state can be requested via [getCurrentRobotControllerState](getCurrentRobotControllerState). If a mode change is not possible, the response lists reasons for the failed change.
|
|
6887
8754
|
* @summary Set Default Mode
|
|
6888
8755
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
6889
8756
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -6913,16 +8780,17 @@ export const ControllerApiFp = function(configuration?: Configuration) {
|
|
|
6913
8780
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
6914
8781
|
},
|
|
6915
8782
|
/**
|
|
6916
|
-
* <!-- theme: danger --> > Websocket endpoint Receive updates of the state of a robot controller.
|
|
8783
|
+
* <!-- 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.
|
|
6917
8784
|
* @summary Stream State
|
|
6918
8785
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
6919
8786
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
6920
8787
|
* @param {number} [responseRate]
|
|
8788
|
+
* @param {number} [addControllerTimeout]
|
|
6921
8789
|
* @param {*} [options] Override http request option.
|
|
6922
8790
|
* @throws {RequiredError}
|
|
6923
8791
|
*/
|
|
6924
|
-
async streamRobotControllerState(cell: string, controller: string, responseRate?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<RobotControllerState>> {
|
|
6925
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.streamRobotControllerState(cell, controller, responseRate, options);
|
|
8792
|
+
async streamRobotControllerState(cell: string, controller: string, responseRate?: number, addControllerTimeout?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<RobotControllerState>> {
|
|
8793
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.streamRobotControllerState(cell, controller, responseRate, addControllerTimeout, options);
|
|
6926
8794
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
6927
8795
|
const localVarOperationServerBasePath = operationServerMap['ControllerApi.streamRobotControllerState']?.[localVarOperationServerIndex]?.url;
|
|
6928
8796
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
@@ -7023,17 +8891,6 @@ export const ControllerApiFactory = function (configuration?: Configuration, bas
|
|
|
7023
8891
|
getCurrentRobotControllerState(cell: string, controller: string, options?: RawAxiosRequestConfig): AxiosPromise<RobotControllerState> {
|
|
7024
8892
|
return localVarFp.getCurrentRobotControllerState(cell, controller, options).then((request) => request(axios, basePath));
|
|
7025
8893
|
},
|
|
7026
|
-
/**
|
|
7027
|
-
* 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).
|
|
7028
|
-
* @summary Current Mode
|
|
7029
|
-
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
7030
|
-
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
7031
|
-
* @param {*} [options] Override http request option.
|
|
7032
|
-
* @throws {RequiredError}
|
|
7033
|
-
*/
|
|
7034
|
-
getMode(cell: string, controller: string, options?: RawAxiosRequestConfig): AxiosPromise<GetModeResponse> {
|
|
7035
|
-
return localVarFp.getMode(cell, controller, options).then((request) => request(axios, basePath));
|
|
7036
|
-
},
|
|
7037
8894
|
/**
|
|
7038
8895
|
* Get the configuration for a robot controller.
|
|
7039
8896
|
* @summary Robot Controller
|
|
@@ -7079,7 +8936,7 @@ export const ControllerApiFactory = function (configuration?: Configuration, bas
|
|
|
7079
8936
|
return localVarFp.listRobotControllers(cell, options).then((request) => request(axios, basePath));
|
|
7080
8937
|
},
|
|
7081
8938
|
/**
|
|
7082
|
-
* Switch between monitor and control usage as default for a robot controller. Monitoring mode is used to read information from the robot controller and control mode is used to command the robot system. As long as the robot controller is connected via network monitoring mode is always possible. To switch to control mode the robot controller must be in `automatic` or `manual` operating mode and safety state \'normal\' or \'reduced\'. If the robot controller is in `manual` operating mode, you have manually confirm the control usage activation on the robot control panel. This manual confirmation can\'t be replaced with this API. Without manual confirmation the robot controller will stay in monitor mode. The robot system will try to activate the required operation mode for the requested usage unless no active call requires a different mode. > **NOTE** > > Some robot controllers prevent the external activation of automatic operating mode. In this case, changing the operating mode manually at the robot controller is mandatory. > **NOTE** > > The current operation mode and safety state can be requested via [getCurrentRobotControllerState](getCurrentRobotControllerState). If a mode change is not possible, the response lists reasons for the failed change.
|
|
8939
|
+
* Switch between monitor and control usage as default for a robot controller. Monitoring mode is used to read information from the robot controller and control mode is used to command the robot system. As long as the robot controller is connected via network monitoring mode is always possible. To switch to control mode the robot controller must be in `automatic` or `manual` operating mode and safety state \'normal\' or \'reduced\'. If the robot controller is in `manual` operating mode, you have manually confirm the control usage activation on the robot control panel. This manual confirmation can\'t be replaced with this API. Without manual confirmation the robot controller will stay in monitor mode. The robot system will try to activate the required operation mode for the requested usage unless no active call requires a different mode. > **NOTE** > > `setDefaultMode` enables the robot controller to stay in control mode to keep the motors activated. > This allows for faster execution of sequential movements as no mode switches are required. > **NOTE** > > Some robot controllers prevent the external activation of automatic operating mode. In this case, changing the operating mode manually at the robot controller is mandatory. > **NOTE** > > The current operation mode and safety state can be requested via [getCurrentRobotControllerState](getCurrentRobotControllerState). If a mode change is not possible, the response lists reasons for the failed change.
|
|
7083
8940
|
* @summary Set Default Mode
|
|
7084
8941
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
7085
8942
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -7103,16 +8960,17 @@ export const ControllerApiFactory = function (configuration?: Configuration, bas
|
|
|
7103
8960
|
return localVarFp.streamFreeDrive(cell, controller, responseRate, options).then((request) => request(axios, basePath));
|
|
7104
8961
|
},
|
|
7105
8962
|
/**
|
|
7106
|
-
* <!-- theme: danger --> > Websocket endpoint Receive updates of the state of a robot controller.
|
|
8963
|
+
* <!-- 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.
|
|
7107
8964
|
* @summary Stream State
|
|
7108
8965
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
7109
8966
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
7110
8967
|
* @param {number} [responseRate]
|
|
8968
|
+
* @param {number} [addControllerTimeout]
|
|
7111
8969
|
* @param {*} [options] Override http request option.
|
|
7112
8970
|
* @throws {RequiredError}
|
|
7113
8971
|
*/
|
|
7114
|
-
streamRobotControllerState(cell: string, controller: string, responseRate?: number, options?: RawAxiosRequestConfig): AxiosPromise<RobotControllerState> {
|
|
7115
|
-
return localVarFp.streamRobotControllerState(cell, controller, responseRate, options).then((request) => request(axios, basePath));
|
|
8972
|
+
streamRobotControllerState(cell: string, controller: string, responseRate?: number, addControllerTimeout?: number, options?: RawAxiosRequestConfig): AxiosPromise<RobotControllerState> {
|
|
8973
|
+
return localVarFp.streamRobotControllerState(cell, controller, responseRate, addControllerTimeout, options).then((request) => request(axios, basePath));
|
|
7116
8974
|
},
|
|
7117
8975
|
/**
|
|
7118
8976
|
* 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.
|
|
@@ -7219,19 +9077,6 @@ export class ControllerApi extends BaseAPI {
|
|
|
7219
9077
|
return ControllerApiFp(this.configuration).getCurrentRobotControllerState(cell, controller, options).then((request) => request(this.axios, this.basePath));
|
|
7220
9078
|
}
|
|
7221
9079
|
|
|
7222
|
-
/**
|
|
7223
|
-
* 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).
|
|
7224
|
-
* @summary Current Mode
|
|
7225
|
-
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
7226
|
-
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
7227
|
-
* @param {*} [options] Override http request option.
|
|
7228
|
-
* @throws {RequiredError}
|
|
7229
|
-
* @memberof ControllerApi
|
|
7230
|
-
*/
|
|
7231
|
-
public getMode(cell: string, controller: string, options?: RawAxiosRequestConfig) {
|
|
7232
|
-
return ControllerApiFp(this.configuration).getMode(cell, controller, options).then((request) => request(this.axios, this.basePath));
|
|
7233
|
-
}
|
|
7234
|
-
|
|
7235
9080
|
/**
|
|
7236
9081
|
* Get the configuration for a robot controller.
|
|
7237
9082
|
* @summary Robot Controller
|
|
@@ -7285,7 +9130,7 @@ export class ControllerApi extends BaseAPI {
|
|
|
7285
9130
|
}
|
|
7286
9131
|
|
|
7287
9132
|
/**
|
|
7288
|
-
* Switch between monitor and control usage as default for a robot controller. Monitoring mode is used to read information from the robot controller and control mode is used to command the robot system. As long as the robot controller is connected via network monitoring mode is always possible. To switch to control mode the robot controller must be in `automatic` or `manual` operating mode and safety state \'normal\' or \'reduced\'. If the robot controller is in `manual` operating mode, you have manually confirm the control usage activation on the robot control panel. This manual confirmation can\'t be replaced with this API. Without manual confirmation the robot controller will stay in monitor mode. The robot system will try to activate the required operation mode for the requested usage unless no active call requires a different mode. > **NOTE** > > Some robot controllers prevent the external activation of automatic operating mode. In this case, changing the operating mode manually at the robot controller is mandatory. > **NOTE** > > The current operation mode and safety state can be requested via [getCurrentRobotControllerState](getCurrentRobotControllerState). If a mode change is not possible, the response lists reasons for the failed change.
|
|
9133
|
+
* Switch between monitor and control usage as default for a robot controller. Monitoring mode is used to read information from the robot controller and control mode is used to command the robot system. As long as the robot controller is connected via network monitoring mode is always possible. To switch to control mode the robot controller must be in `automatic` or `manual` operating mode and safety state \'normal\' or \'reduced\'. If the robot controller is in `manual` operating mode, you have manually confirm the control usage activation on the robot control panel. This manual confirmation can\'t be replaced with this API. Without manual confirmation the robot controller will stay in monitor mode. The robot system will try to activate the required operation mode for the requested usage unless no active call requires a different mode. > **NOTE** > > `setDefaultMode` enables the robot controller to stay in control mode to keep the motors activated. > This allows for faster execution of sequential movements as no mode switches are required. > **NOTE** > > Some robot controllers prevent the external activation of automatic operating mode. In this case, changing the operating mode manually at the robot controller is mandatory. > **NOTE** > > The current operation mode and safety state can be requested via [getCurrentRobotControllerState](getCurrentRobotControllerState). If a mode change is not possible, the response lists reasons for the failed change.
|
|
7289
9134
|
* @summary Set Default Mode
|
|
7290
9135
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
7291
9136
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -7313,17 +9158,18 @@ export class ControllerApi extends BaseAPI {
|
|
|
7313
9158
|
}
|
|
7314
9159
|
|
|
7315
9160
|
/**
|
|
7316
|
-
* <!-- theme: danger --> > Websocket endpoint Receive updates of the state of a robot controller.
|
|
9161
|
+
* <!-- 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.
|
|
7317
9162
|
* @summary Stream State
|
|
7318
9163
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
7319
9164
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
7320
9165
|
* @param {number} [responseRate]
|
|
9166
|
+
* @param {number} [addControllerTimeout]
|
|
7321
9167
|
* @param {*} [options] Override http request option.
|
|
7322
9168
|
* @throws {RequiredError}
|
|
7323
9169
|
* @memberof ControllerApi
|
|
7324
9170
|
*/
|
|
7325
|
-
public streamRobotControllerState(cell: string, controller: string, responseRate?: number, options?: RawAxiosRequestConfig) {
|
|
7326
|
-
return ControllerApiFp(this.configuration).streamRobotControllerState(cell, controller, responseRate, options).then((request) => request(this.axios, this.basePath));
|
|
9171
|
+
public streamRobotControllerState(cell: string, controller: string, responseRate?: number, addControllerTimeout?: number, options?: RawAxiosRequestConfig) {
|
|
9172
|
+
return ControllerApiFp(this.configuration).streamRobotControllerState(cell, controller, responseRate, addControllerTimeout, options).then((request) => request(this.axios, this.basePath));
|
|
7327
9173
|
}
|
|
7328
9174
|
|
|
7329
9175
|
/**
|
|
@@ -8007,6 +9853,52 @@ export class JoggingApi extends BaseAPI {
|
|
|
8007
9853
|
*/
|
|
8008
9854
|
export const KinematicsApiAxiosParamCreator = function (configuration?: Configuration) {
|
|
8009
9855
|
return {
|
|
9856
|
+
/**
|
|
9857
|
+
* Returns the TCP poses for a list of given joint positions.
|
|
9858
|
+
* @summary Forward kinematics
|
|
9859
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
9860
|
+
* @param {ForwardKinematicsRequest} [forwardKinematicsRequest]
|
|
9861
|
+
* @param {*} [options] Override http request option.
|
|
9862
|
+
* @throws {RequiredError}
|
|
9863
|
+
*/
|
|
9864
|
+
forwardKinematics: async (cell: string, forwardKinematicsRequest?: ForwardKinematicsRequest, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
9865
|
+
// verify required parameter 'cell' is not null or undefined
|
|
9866
|
+
assertParamExists('forwardKinematics', 'cell', cell)
|
|
9867
|
+
const localVarPath = `/cells/{cell}/kinematic/forward`
|
|
9868
|
+
.replace(`{${"cell"}}`, encodeURIComponent(String(cell)));
|
|
9869
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
9870
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
9871
|
+
let baseOptions;
|
|
9872
|
+
if (configuration) {
|
|
9873
|
+
baseOptions = configuration.baseOptions;
|
|
9874
|
+
}
|
|
9875
|
+
|
|
9876
|
+
const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
|
|
9877
|
+
const localVarHeaderParameter = {} as any;
|
|
9878
|
+
const localVarQueryParameter = {} as any;
|
|
9879
|
+
|
|
9880
|
+
// authentication BasicAuth required
|
|
9881
|
+
// http basic authentication required
|
|
9882
|
+
setBasicAuthToObject(localVarRequestOptions, configuration)
|
|
9883
|
+
|
|
9884
|
+
// authentication BearerAuth required
|
|
9885
|
+
// http bearer authentication required
|
|
9886
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
9887
|
+
|
|
9888
|
+
|
|
9889
|
+
|
|
9890
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
9891
|
+
|
|
9892
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
9893
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
9894
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
9895
|
+
localVarRequestOptions.data = serializeDataIfNeeded(forwardKinematicsRequest, localVarRequestOptions, configuration)
|
|
9896
|
+
|
|
9897
|
+
return {
|
|
9898
|
+
url: toPathString(localVarUrlObj),
|
|
9899
|
+
options: localVarRequestOptions,
|
|
9900
|
+
};
|
|
9901
|
+
},
|
|
8010
9902
|
/**
|
|
8011
9903
|
* Returns the reachable joint positions for a list of given poses.
|
|
8012
9904
|
* @summary Inverse kinematics
|
|
@@ -8063,6 +9955,20 @@ export const KinematicsApiAxiosParamCreator = function (configuration?: Configur
|
|
|
8063
9955
|
export const KinematicsApiFp = function(configuration?: Configuration) {
|
|
8064
9956
|
const localVarAxiosParamCreator = KinematicsApiAxiosParamCreator(configuration)
|
|
8065
9957
|
return {
|
|
9958
|
+
/**
|
|
9959
|
+
* Returns the TCP poses for a list of given joint positions.
|
|
9960
|
+
* @summary Forward kinematics
|
|
9961
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
9962
|
+
* @param {ForwardKinematicsRequest} [forwardKinematicsRequest]
|
|
9963
|
+
* @param {*} [options] Override http request option.
|
|
9964
|
+
* @throws {RequiredError}
|
|
9965
|
+
*/
|
|
9966
|
+
async forwardKinematics(cell: string, forwardKinematicsRequest?: ForwardKinematicsRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ForwardKinematicsResponse>> {
|
|
9967
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.forwardKinematics(cell, forwardKinematicsRequest, options);
|
|
9968
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
9969
|
+
const localVarOperationServerBasePath = operationServerMap['KinematicsApi.forwardKinematics']?.[localVarOperationServerIndex]?.url;
|
|
9970
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
9971
|
+
},
|
|
8066
9972
|
/**
|
|
8067
9973
|
* Returns the reachable joint positions for a list of given poses.
|
|
8068
9974
|
* @summary Inverse kinematics
|
|
@@ -8087,6 +9993,17 @@ export const KinematicsApiFp = function(configuration?: Configuration) {
|
|
|
8087
9993
|
export const KinematicsApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
|
|
8088
9994
|
const localVarFp = KinematicsApiFp(configuration)
|
|
8089
9995
|
return {
|
|
9996
|
+
/**
|
|
9997
|
+
* Returns the TCP poses for a list of given joint positions.
|
|
9998
|
+
* @summary Forward kinematics
|
|
9999
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
10000
|
+
* @param {ForwardKinematicsRequest} [forwardKinematicsRequest]
|
|
10001
|
+
* @param {*} [options] Override http request option.
|
|
10002
|
+
* @throws {RequiredError}
|
|
10003
|
+
*/
|
|
10004
|
+
forwardKinematics(cell: string, forwardKinematicsRequest?: ForwardKinematicsRequest, options?: RawAxiosRequestConfig): AxiosPromise<ForwardKinematicsResponse> {
|
|
10005
|
+
return localVarFp.forwardKinematics(cell, forwardKinematicsRequest, options).then((request) => request(axios, basePath));
|
|
10006
|
+
},
|
|
8090
10007
|
/**
|
|
8091
10008
|
* Returns the reachable joint positions for a list of given poses.
|
|
8092
10009
|
* @summary Inverse kinematics
|
|
@@ -8108,6 +10025,19 @@ export const KinematicsApiFactory = function (configuration?: Configuration, bas
|
|
|
8108
10025
|
* @extends {BaseAPI}
|
|
8109
10026
|
*/
|
|
8110
10027
|
export class KinematicsApi extends BaseAPI {
|
|
10028
|
+
/**
|
|
10029
|
+
* Returns the TCP poses for a list of given joint positions.
|
|
10030
|
+
* @summary Forward kinematics
|
|
10031
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
10032
|
+
* @param {ForwardKinematicsRequest} [forwardKinematicsRequest]
|
|
10033
|
+
* @param {*} [options] Override http request option.
|
|
10034
|
+
* @throws {RequiredError}
|
|
10035
|
+
* @memberof KinematicsApi
|
|
10036
|
+
*/
|
|
10037
|
+
public forwardKinematics(cell: string, forwardKinematicsRequest?: ForwardKinematicsRequest, options?: RawAxiosRequestConfig) {
|
|
10038
|
+
return KinematicsApiFp(this.configuration).forwardKinematics(cell, forwardKinematicsRequest, options).then((request) => request(this.axios, this.basePath));
|
|
10039
|
+
}
|
|
10040
|
+
|
|
8111
10041
|
/**
|
|
8112
10042
|
* Returns the reachable joint positions for a list of given poses.
|
|
8113
10043
|
* @summary Inverse kinematics
|
|
@@ -10042,27 +11972,27 @@ export class StoreCollisionComponentsApi extends BaseAPI {
|
|
|
10042
11972
|
|
|
10043
11973
|
|
|
10044
11974
|
/**
|
|
10045
|
-
*
|
|
11975
|
+
* StoreCollisionSetupsApi - axios parameter creator
|
|
10046
11976
|
* @export
|
|
10047
11977
|
*/
|
|
10048
|
-
export const
|
|
11978
|
+
export const StoreCollisionSetupsApiAxiosParamCreator = function (configuration?: Configuration) {
|
|
10049
11979
|
return {
|
|
10050
11980
|
/**
|
|
10051
|
-
* Deletes the stored
|
|
10052
|
-
* @summary Delete
|
|
11981
|
+
* Deletes the stored collision setup. <!-- theme: danger --> > This will delete persistently stored data.
|
|
11982
|
+
* @summary Delete Collision Setup
|
|
10053
11983
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
10054
|
-
* @param {string}
|
|
11984
|
+
* @param {string} setup Identifier of the collision setup
|
|
10055
11985
|
* @param {*} [options] Override http request option.
|
|
10056
11986
|
* @throws {RequiredError}
|
|
10057
11987
|
*/
|
|
10058
|
-
|
|
11988
|
+
deleteStoredCollisionSetup: async (cell: string, setup: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
10059
11989
|
// verify required parameter 'cell' is not null or undefined
|
|
10060
|
-
assertParamExists('
|
|
10061
|
-
// verify required parameter '
|
|
10062
|
-
assertParamExists('
|
|
10063
|
-
const localVarPath = `/cells/{cell}/store/collision/
|
|
11990
|
+
assertParamExists('deleteStoredCollisionSetup', 'cell', cell)
|
|
11991
|
+
// verify required parameter 'setup' is not null or undefined
|
|
11992
|
+
assertParamExists('deleteStoredCollisionSetup', 'setup', setup)
|
|
11993
|
+
const localVarPath = `/cells/{cell}/store/collision/setups/{setup}`
|
|
10064
11994
|
.replace(`{${"cell"}}`, encodeURIComponent(String(cell)))
|
|
10065
|
-
.replace(`{${"
|
|
11995
|
+
.replace(`{${"setup"}}`, encodeURIComponent(String(setup)));
|
|
10066
11996
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
10067
11997
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
10068
11998
|
let baseOptions;
|
|
@@ -10094,21 +12024,21 @@ export const StoreCollisionScenesApiAxiosParamCreator = function (configuration?
|
|
|
10094
12024
|
};
|
|
10095
12025
|
},
|
|
10096
12026
|
/**
|
|
10097
|
-
* Returns the stored
|
|
10098
|
-
* @summary Get
|
|
12027
|
+
* Returns the stored collision setup.
|
|
12028
|
+
* @summary Get Collision Setup
|
|
10099
12029
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
10100
|
-
* @param {string}
|
|
12030
|
+
* @param {string} setup Identifier of the collision setup
|
|
10101
12031
|
* @param {*} [options] Override http request option.
|
|
10102
12032
|
* @throws {RequiredError}
|
|
10103
12033
|
*/
|
|
10104
|
-
|
|
12034
|
+
getStoredCollisionSetup: async (cell: string, setup: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
10105
12035
|
// verify required parameter 'cell' is not null or undefined
|
|
10106
|
-
assertParamExists('
|
|
10107
|
-
// verify required parameter '
|
|
10108
|
-
assertParamExists('
|
|
10109
|
-
const localVarPath = `/cells/{cell}/store/collision/
|
|
12036
|
+
assertParamExists('getStoredCollisionSetup', 'cell', cell)
|
|
12037
|
+
// verify required parameter 'setup' is not null or undefined
|
|
12038
|
+
assertParamExists('getStoredCollisionSetup', 'setup', setup)
|
|
12039
|
+
const localVarPath = `/cells/{cell}/store/collision/setups/{setup}`
|
|
10110
12040
|
.replace(`{${"cell"}}`, encodeURIComponent(String(cell)))
|
|
10111
|
-
.replace(`{${"
|
|
12041
|
+
.replace(`{${"setup"}}`, encodeURIComponent(String(setup)));
|
|
10112
12042
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
10113
12043
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
10114
12044
|
let baseOptions;
|
|
@@ -10140,16 +12070,16 @@ export const StoreCollisionScenesApiAxiosParamCreator = function (configuration?
|
|
|
10140
12070
|
};
|
|
10141
12071
|
},
|
|
10142
12072
|
/**
|
|
10143
|
-
* Returns a list of stored
|
|
10144
|
-
* @summary List
|
|
12073
|
+
* Returns a list of stored collision setups.
|
|
12074
|
+
* @summary List Collision Setups
|
|
10145
12075
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
10146
12076
|
* @param {*} [options] Override http request option.
|
|
10147
12077
|
* @throws {RequiredError}
|
|
10148
12078
|
*/
|
|
10149
|
-
|
|
12079
|
+
listStoredCollisionSetups: async (cell: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
10150
12080
|
// verify required parameter 'cell' is not null or undefined
|
|
10151
|
-
assertParamExists('
|
|
10152
|
-
const localVarPath = `/cells/{cell}/store/collision/
|
|
12081
|
+
assertParamExists('listStoredCollisionSetups', 'cell', cell)
|
|
12082
|
+
const localVarPath = `/cells/{cell}/store/collision/setups`
|
|
10153
12083
|
.replace(`{${"cell"}}`, encodeURIComponent(String(cell)));
|
|
10154
12084
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
10155
12085
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
@@ -10182,24 +12112,24 @@ export const StoreCollisionScenesApiAxiosParamCreator = function (configuration?
|
|
|
10182
12112
|
};
|
|
10183
12113
|
},
|
|
10184
12114
|
/**
|
|
10185
|
-
*
|
|
10186
|
-
* @summary Store
|
|
12115
|
+
* Stores collision setup. If the collision setup does not exist, it will be created. If the collision setup exists, it will be updated.
|
|
12116
|
+
* @summary Store Collision Setup
|
|
10187
12117
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
10188
|
-
* @param {string}
|
|
10189
|
-
* @param {
|
|
12118
|
+
* @param {string} setup Identifier of the collision setup
|
|
12119
|
+
* @param {CollisionSetup} collisionSetup
|
|
10190
12120
|
* @param {*} [options] Override http request option.
|
|
10191
12121
|
* @throws {RequiredError}
|
|
10192
12122
|
*/
|
|
10193
|
-
|
|
12123
|
+
storeCollisionSetup: async (cell: string, setup: string, collisionSetup: CollisionSetup, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
10194
12124
|
// verify required parameter 'cell' is not null or undefined
|
|
10195
|
-
assertParamExists('
|
|
10196
|
-
// verify required parameter '
|
|
10197
|
-
assertParamExists('
|
|
10198
|
-
// verify required parameter '
|
|
10199
|
-
assertParamExists('
|
|
10200
|
-
const localVarPath = `/cells/{cell}/store/collision/
|
|
12125
|
+
assertParamExists('storeCollisionSetup', 'cell', cell)
|
|
12126
|
+
// verify required parameter 'setup' is not null or undefined
|
|
12127
|
+
assertParamExists('storeCollisionSetup', 'setup', setup)
|
|
12128
|
+
// verify required parameter 'collisionSetup' is not null or undefined
|
|
12129
|
+
assertParamExists('storeCollisionSetup', 'collisionSetup', collisionSetup)
|
|
12130
|
+
const localVarPath = `/cells/{cell}/store/collision/setups/{setup}`
|
|
10201
12131
|
.replace(`{${"cell"}}`, encodeURIComponent(String(cell)))
|
|
10202
|
-
.replace(`{${"
|
|
12132
|
+
.replace(`{${"setup"}}`, encodeURIComponent(String(setup)));
|
|
10203
12133
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
10204
12134
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
10205
12135
|
let baseOptions;
|
|
@@ -10226,7 +12156,7 @@ export const StoreCollisionScenesApiAxiosParamCreator = function (configuration?
|
|
|
10226
12156
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
10227
12157
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
10228
12158
|
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
10229
|
-
localVarRequestOptions.data = serializeDataIfNeeded(
|
|
12159
|
+
localVarRequestOptions.data = serializeDataIfNeeded(collisionSetup, localVarRequestOptions, configuration)
|
|
10230
12160
|
|
|
10231
12161
|
return {
|
|
10232
12162
|
url: toPathString(localVarUrlObj),
|
|
@@ -10237,182 +12167,182 @@ export const StoreCollisionScenesApiAxiosParamCreator = function (configuration?
|
|
|
10237
12167
|
};
|
|
10238
12168
|
|
|
10239
12169
|
/**
|
|
10240
|
-
*
|
|
12170
|
+
* StoreCollisionSetupsApi - functional programming interface
|
|
10241
12171
|
* @export
|
|
10242
12172
|
*/
|
|
10243
|
-
export const
|
|
10244
|
-
const localVarAxiosParamCreator =
|
|
12173
|
+
export const StoreCollisionSetupsApiFp = function(configuration?: Configuration) {
|
|
12174
|
+
const localVarAxiosParamCreator = StoreCollisionSetupsApiAxiosParamCreator(configuration)
|
|
10245
12175
|
return {
|
|
10246
12176
|
/**
|
|
10247
|
-
* Deletes the stored
|
|
10248
|
-
* @summary Delete
|
|
12177
|
+
* Deletes the stored collision setup. <!-- theme: danger --> > This will delete persistently stored data.
|
|
12178
|
+
* @summary Delete Collision Setup
|
|
10249
12179
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
10250
|
-
* @param {string}
|
|
12180
|
+
* @param {string} setup Identifier of the collision setup
|
|
10251
12181
|
* @param {*} [options] Override http request option.
|
|
10252
12182
|
* @throws {RequiredError}
|
|
10253
12183
|
*/
|
|
10254
|
-
async
|
|
10255
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.
|
|
12184
|
+
async deleteStoredCollisionSetup(cell: string, setup: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> {
|
|
12185
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.deleteStoredCollisionSetup(cell, setup, options);
|
|
10256
12186
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
10257
|
-
const localVarOperationServerBasePath = operationServerMap['
|
|
12187
|
+
const localVarOperationServerBasePath = operationServerMap['StoreCollisionSetupsApi.deleteStoredCollisionSetup']?.[localVarOperationServerIndex]?.url;
|
|
10258
12188
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
10259
12189
|
},
|
|
10260
12190
|
/**
|
|
10261
|
-
* Returns the stored
|
|
10262
|
-
* @summary Get
|
|
12191
|
+
* Returns the stored collision setup.
|
|
12192
|
+
* @summary Get Collision Setup
|
|
10263
12193
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
10264
|
-
* @param {string}
|
|
12194
|
+
* @param {string} setup Identifier of the collision setup
|
|
10265
12195
|
* @param {*} [options] Override http request option.
|
|
10266
12196
|
* @throws {RequiredError}
|
|
10267
12197
|
*/
|
|
10268
|
-
async
|
|
10269
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.
|
|
12198
|
+
async getStoredCollisionSetup(cell: string, setup: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CollisionSetup>> {
|
|
12199
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.getStoredCollisionSetup(cell, setup, options);
|
|
10270
12200
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
10271
|
-
const localVarOperationServerBasePath = operationServerMap['
|
|
12201
|
+
const localVarOperationServerBasePath = operationServerMap['StoreCollisionSetupsApi.getStoredCollisionSetup']?.[localVarOperationServerIndex]?.url;
|
|
10272
12202
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
10273
12203
|
},
|
|
10274
12204
|
/**
|
|
10275
|
-
* Returns a list of stored
|
|
10276
|
-
* @summary List
|
|
12205
|
+
* Returns a list of stored collision setups.
|
|
12206
|
+
* @summary List Collision Setups
|
|
10277
12207
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
10278
12208
|
* @param {*} [options] Override http request option.
|
|
10279
12209
|
* @throws {RequiredError}
|
|
10280
12210
|
*/
|
|
10281
|
-
async
|
|
10282
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.
|
|
12211
|
+
async listStoredCollisionSetups(cell: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<{ [key: string]: CollisionSetup; }>> {
|
|
12212
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.listStoredCollisionSetups(cell, options);
|
|
10283
12213
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
10284
|
-
const localVarOperationServerBasePath = operationServerMap['
|
|
12214
|
+
const localVarOperationServerBasePath = operationServerMap['StoreCollisionSetupsApi.listStoredCollisionSetups']?.[localVarOperationServerIndex]?.url;
|
|
10285
12215
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
10286
12216
|
},
|
|
10287
12217
|
/**
|
|
10288
|
-
*
|
|
10289
|
-
* @summary Store
|
|
12218
|
+
* Stores collision setup. If the collision setup does not exist, it will be created. If the collision setup exists, it will be updated.
|
|
12219
|
+
* @summary Store Collision Setup
|
|
10290
12220
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
10291
|
-
* @param {string}
|
|
10292
|
-
* @param {
|
|
12221
|
+
* @param {string} setup Identifier of the collision setup
|
|
12222
|
+
* @param {CollisionSetup} collisionSetup
|
|
10293
12223
|
* @param {*} [options] Override http request option.
|
|
10294
12224
|
* @throws {RequiredError}
|
|
10295
12225
|
*/
|
|
10296
|
-
async
|
|
10297
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.
|
|
12226
|
+
async storeCollisionSetup(cell: string, setup: string, collisionSetup: CollisionSetup, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CollisionSetup>> {
|
|
12227
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.storeCollisionSetup(cell, setup, collisionSetup, options);
|
|
10298
12228
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
10299
|
-
const localVarOperationServerBasePath = operationServerMap['
|
|
12229
|
+
const localVarOperationServerBasePath = operationServerMap['StoreCollisionSetupsApi.storeCollisionSetup']?.[localVarOperationServerIndex]?.url;
|
|
10300
12230
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
10301
12231
|
},
|
|
10302
12232
|
}
|
|
10303
12233
|
};
|
|
10304
12234
|
|
|
10305
12235
|
/**
|
|
10306
|
-
*
|
|
12236
|
+
* StoreCollisionSetupsApi - factory interface
|
|
10307
12237
|
* @export
|
|
10308
12238
|
*/
|
|
10309
|
-
export const
|
|
10310
|
-
const localVarFp =
|
|
12239
|
+
export const StoreCollisionSetupsApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
|
|
12240
|
+
const localVarFp = StoreCollisionSetupsApiFp(configuration)
|
|
10311
12241
|
return {
|
|
10312
12242
|
/**
|
|
10313
|
-
* Deletes the stored
|
|
10314
|
-
* @summary Delete
|
|
12243
|
+
* Deletes the stored collision setup. <!-- theme: danger --> > This will delete persistently stored data.
|
|
12244
|
+
* @summary Delete Collision Setup
|
|
10315
12245
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
10316
|
-
* @param {string}
|
|
12246
|
+
* @param {string} setup Identifier of the collision setup
|
|
10317
12247
|
* @param {*} [options] Override http request option.
|
|
10318
12248
|
* @throws {RequiredError}
|
|
10319
12249
|
*/
|
|
10320
|
-
|
|
10321
|
-
return localVarFp.
|
|
12250
|
+
deleteStoredCollisionSetup(cell: string, setup: string, options?: RawAxiosRequestConfig): AxiosPromise<void> {
|
|
12251
|
+
return localVarFp.deleteStoredCollisionSetup(cell, setup, options).then((request) => request(axios, basePath));
|
|
10322
12252
|
},
|
|
10323
12253
|
/**
|
|
10324
|
-
* Returns the stored
|
|
10325
|
-
* @summary Get
|
|
12254
|
+
* Returns the stored collision setup.
|
|
12255
|
+
* @summary Get Collision Setup
|
|
10326
12256
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
10327
|
-
* @param {string}
|
|
12257
|
+
* @param {string} setup Identifier of the collision setup
|
|
10328
12258
|
* @param {*} [options] Override http request option.
|
|
10329
12259
|
* @throws {RequiredError}
|
|
10330
12260
|
*/
|
|
10331
|
-
|
|
10332
|
-
return localVarFp.
|
|
12261
|
+
getStoredCollisionSetup(cell: string, setup: string, options?: RawAxiosRequestConfig): AxiosPromise<CollisionSetup> {
|
|
12262
|
+
return localVarFp.getStoredCollisionSetup(cell, setup, options).then((request) => request(axios, basePath));
|
|
10333
12263
|
},
|
|
10334
12264
|
/**
|
|
10335
|
-
* Returns a list of stored
|
|
10336
|
-
* @summary List
|
|
12265
|
+
* Returns a list of stored collision setups.
|
|
12266
|
+
* @summary List Collision Setups
|
|
10337
12267
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
10338
12268
|
* @param {*} [options] Override http request option.
|
|
10339
12269
|
* @throws {RequiredError}
|
|
10340
12270
|
*/
|
|
10341
|
-
|
|
10342
|
-
return localVarFp.
|
|
12271
|
+
listStoredCollisionSetups(cell: string, options?: RawAxiosRequestConfig): AxiosPromise<{ [key: string]: CollisionSetup; }> {
|
|
12272
|
+
return localVarFp.listStoredCollisionSetups(cell, options).then((request) => request(axios, basePath));
|
|
10343
12273
|
},
|
|
10344
12274
|
/**
|
|
10345
|
-
*
|
|
10346
|
-
* @summary Store
|
|
12275
|
+
* Stores collision setup. If the collision setup does not exist, it will be created. If the collision setup exists, it will be updated.
|
|
12276
|
+
* @summary Store Collision Setup
|
|
10347
12277
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
10348
|
-
* @param {string}
|
|
10349
|
-
* @param {
|
|
12278
|
+
* @param {string} setup Identifier of the collision setup
|
|
12279
|
+
* @param {CollisionSetup} collisionSetup
|
|
10350
12280
|
* @param {*} [options] Override http request option.
|
|
10351
12281
|
* @throws {RequiredError}
|
|
10352
12282
|
*/
|
|
10353
|
-
|
|
10354
|
-
return localVarFp.
|
|
12283
|
+
storeCollisionSetup(cell: string, setup: string, collisionSetup: CollisionSetup, options?: RawAxiosRequestConfig): AxiosPromise<CollisionSetup> {
|
|
12284
|
+
return localVarFp.storeCollisionSetup(cell, setup, collisionSetup, options).then((request) => request(axios, basePath));
|
|
10355
12285
|
},
|
|
10356
12286
|
};
|
|
10357
12287
|
};
|
|
10358
12288
|
|
|
10359
12289
|
/**
|
|
10360
|
-
*
|
|
12290
|
+
* StoreCollisionSetupsApi - object-oriented interface
|
|
10361
12291
|
* @export
|
|
10362
|
-
* @class
|
|
12292
|
+
* @class StoreCollisionSetupsApi
|
|
10363
12293
|
* @extends {BaseAPI}
|
|
10364
12294
|
*/
|
|
10365
|
-
export class
|
|
12295
|
+
export class StoreCollisionSetupsApi extends BaseAPI {
|
|
10366
12296
|
/**
|
|
10367
|
-
* Deletes the stored
|
|
10368
|
-
* @summary Delete
|
|
12297
|
+
* Deletes the stored collision setup. <!-- theme: danger --> > This will delete persistently stored data.
|
|
12298
|
+
* @summary Delete Collision Setup
|
|
10369
12299
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
10370
|
-
* @param {string}
|
|
12300
|
+
* @param {string} setup Identifier of the collision setup
|
|
10371
12301
|
* @param {*} [options] Override http request option.
|
|
10372
12302
|
* @throws {RequiredError}
|
|
10373
|
-
* @memberof
|
|
12303
|
+
* @memberof StoreCollisionSetupsApi
|
|
10374
12304
|
*/
|
|
10375
|
-
public
|
|
10376
|
-
return
|
|
12305
|
+
public deleteStoredCollisionSetup(cell: string, setup: string, options?: RawAxiosRequestConfig) {
|
|
12306
|
+
return StoreCollisionSetupsApiFp(this.configuration).deleteStoredCollisionSetup(cell, setup, options).then((request) => request(this.axios, this.basePath));
|
|
10377
12307
|
}
|
|
10378
12308
|
|
|
10379
12309
|
/**
|
|
10380
|
-
* Returns the stored
|
|
10381
|
-
* @summary Get
|
|
12310
|
+
* Returns the stored collision setup.
|
|
12311
|
+
* @summary Get Collision Setup
|
|
10382
12312
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
10383
|
-
* @param {string}
|
|
12313
|
+
* @param {string} setup Identifier of the collision setup
|
|
10384
12314
|
* @param {*} [options] Override http request option.
|
|
10385
12315
|
* @throws {RequiredError}
|
|
10386
|
-
* @memberof
|
|
12316
|
+
* @memberof StoreCollisionSetupsApi
|
|
10387
12317
|
*/
|
|
10388
|
-
public
|
|
10389
|
-
return
|
|
12318
|
+
public getStoredCollisionSetup(cell: string, setup: string, options?: RawAxiosRequestConfig) {
|
|
12319
|
+
return StoreCollisionSetupsApiFp(this.configuration).getStoredCollisionSetup(cell, setup, options).then((request) => request(this.axios, this.basePath));
|
|
10390
12320
|
}
|
|
10391
12321
|
|
|
10392
12322
|
/**
|
|
10393
|
-
* Returns a list of stored
|
|
10394
|
-
* @summary List
|
|
12323
|
+
* Returns a list of stored collision setups.
|
|
12324
|
+
* @summary List Collision Setups
|
|
10395
12325
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
10396
12326
|
* @param {*} [options] Override http request option.
|
|
10397
12327
|
* @throws {RequiredError}
|
|
10398
|
-
* @memberof
|
|
12328
|
+
* @memberof StoreCollisionSetupsApi
|
|
10399
12329
|
*/
|
|
10400
|
-
public
|
|
10401
|
-
return
|
|
12330
|
+
public listStoredCollisionSetups(cell: string, options?: RawAxiosRequestConfig) {
|
|
12331
|
+
return StoreCollisionSetupsApiFp(this.configuration).listStoredCollisionSetups(cell, options).then((request) => request(this.axios, this.basePath));
|
|
10402
12332
|
}
|
|
10403
12333
|
|
|
10404
12334
|
/**
|
|
10405
|
-
*
|
|
10406
|
-
* @summary Store
|
|
12335
|
+
* Stores collision setup. If the collision setup does not exist, it will be created. If the collision setup exists, it will be updated.
|
|
12336
|
+
* @summary Store Collision Setup
|
|
10407
12337
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
10408
|
-
* @param {string}
|
|
10409
|
-
* @param {
|
|
12338
|
+
* @param {string} setup Identifier of the collision setup
|
|
12339
|
+
* @param {CollisionSetup} collisionSetup
|
|
10410
12340
|
* @param {*} [options] Override http request option.
|
|
10411
12341
|
* @throws {RequiredError}
|
|
10412
|
-
* @memberof
|
|
12342
|
+
* @memberof StoreCollisionSetupsApi
|
|
10413
12343
|
*/
|
|
10414
|
-
public
|
|
10415
|
-
return
|
|
12344
|
+
public storeCollisionSetup(cell: string, setup: string, collisionSetup: CollisionSetup, options?: RawAxiosRequestConfig) {
|
|
12345
|
+
return StoreCollisionSetupsApiFp(this.configuration).storeCollisionSetup(cell, setup, collisionSetup, options).then((request) => request(this.axios, this.basePath));
|
|
10416
12346
|
}
|
|
10417
12347
|
}
|
|
10418
12348
|
|
|
@@ -10975,16 +12905,14 @@ export class StoreObjectApi extends BaseAPI {
|
|
|
10975
12905
|
export const SystemApiAxiosParamCreator = function (configuration?: Configuration) {
|
|
10976
12906
|
return {
|
|
10977
12907
|
/**
|
|
10978
|
-
* Retrieves a configuration backup based on provided resource identifiers.
|
|
12908
|
+
* Retrieves a configuration backup based on provided resource identifiers. If an empty array of resources is provided, a backup for all resources will be retrieved.
|
|
10979
12909
|
* @summary Retrieve Configuration Backup
|
|
10980
|
-
* @param {Array<string>} resources List of resource identifiers to
|
|
12910
|
+
* @param {Array<string>} [resources] List of resource identifiers to include in the retrieval.
|
|
10981
12911
|
* @param {{ [key: string]: string; }} [metadata] Additional metadata to add to the backup
|
|
10982
12912
|
* @param {*} [options] Override http request option.
|
|
10983
12913
|
* @throws {RequiredError}
|
|
10984
12914
|
*/
|
|
10985
|
-
backupConfiguration: async (resources
|
|
10986
|
-
// verify required parameter 'resources' is not null or undefined
|
|
10987
|
-
assertParamExists('backupConfiguration', 'resources', resources)
|
|
12915
|
+
backupConfiguration: async (resources?: Array<string>, metadata?: { [key: string]: string; }, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
10988
12916
|
const localVarPath = `/system/configuration`;
|
|
10989
12917
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
10990
12918
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
@@ -11372,14 +13300,14 @@ export const SystemApiFp = function(configuration?: Configuration) {
|
|
|
11372
13300
|
const localVarAxiosParamCreator = SystemApiAxiosParamCreator(configuration)
|
|
11373
13301
|
return {
|
|
11374
13302
|
/**
|
|
11375
|
-
* Retrieves a configuration backup based on provided resource identifiers.
|
|
13303
|
+
* Retrieves a configuration backup based on provided resource identifiers. If an empty array of resources is provided, a backup for all resources will be retrieved.
|
|
11376
13304
|
* @summary Retrieve Configuration Backup
|
|
11377
|
-
* @param {Array<string>} resources List of resource identifiers to
|
|
13305
|
+
* @param {Array<string>} [resources] List of resource identifiers to include in the retrieval.
|
|
11378
13306
|
* @param {{ [key: string]: string; }} [metadata] Additional metadata to add to the backup
|
|
11379
13307
|
* @param {*} [options] Override http request option.
|
|
11380
13308
|
* @throws {RequiredError}
|
|
11381
13309
|
*/
|
|
11382
|
-
async backupConfiguration(resources
|
|
13310
|
+
async backupConfiguration(resources?: Array<string>, metadata?: { [key: string]: string; }, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<File>> {
|
|
11383
13311
|
const localVarAxiosArgs = await localVarAxiosParamCreator.backupConfiguration(resources, metadata, options);
|
|
11384
13312
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
11385
13313
|
const localVarOperationServerBasePath = operationServerMap['SystemApi.backupConfiguration']?.[localVarOperationServerIndex]?.url;
|
|
@@ -11497,14 +13425,14 @@ export const SystemApiFactory = function (configuration?: Configuration, basePat
|
|
|
11497
13425
|
const localVarFp = SystemApiFp(configuration)
|
|
11498
13426
|
return {
|
|
11499
13427
|
/**
|
|
11500
|
-
* Retrieves a configuration backup based on provided resource identifiers.
|
|
13428
|
+
* Retrieves a configuration backup based on provided resource identifiers. If an empty array of resources is provided, a backup for all resources will be retrieved.
|
|
11501
13429
|
* @summary Retrieve Configuration Backup
|
|
11502
|
-
* @param {Array<string>} resources List of resource identifiers to
|
|
13430
|
+
* @param {Array<string>} [resources] List of resource identifiers to include in the retrieval.
|
|
11503
13431
|
* @param {{ [key: string]: string; }} [metadata] Additional metadata to add to the backup
|
|
11504
13432
|
* @param {*} [options] Override http request option.
|
|
11505
13433
|
* @throws {RequiredError}
|
|
11506
13434
|
*/
|
|
11507
|
-
backupConfiguration(resources
|
|
13435
|
+
backupConfiguration(resources?: Array<string>, metadata?: { [key: string]: string; }, options?: RawAxiosRequestConfig): AxiosPromise<File> {
|
|
11508
13436
|
return localVarFp.backupConfiguration(resources, metadata, options).then((request) => request(axios, basePath));
|
|
11509
13437
|
},
|
|
11510
13438
|
/**
|
|
@@ -11595,15 +13523,15 @@ export const SystemApiFactory = function (configuration?: Configuration, basePat
|
|
|
11595
13523
|
*/
|
|
11596
13524
|
export class SystemApi extends BaseAPI {
|
|
11597
13525
|
/**
|
|
11598
|
-
* Retrieves a configuration backup based on provided resource identifiers.
|
|
13526
|
+
* Retrieves a configuration backup based on provided resource identifiers. If an empty array of resources is provided, a backup for all resources will be retrieved.
|
|
11599
13527
|
* @summary Retrieve Configuration Backup
|
|
11600
|
-
* @param {Array<string>} resources List of resource identifiers to
|
|
13528
|
+
* @param {Array<string>} [resources] List of resource identifiers to include in the retrieval.
|
|
11601
13529
|
* @param {{ [key: string]: string; }} [metadata] Additional metadata to add to the backup
|
|
11602
13530
|
* @param {*} [options] Override http request option.
|
|
11603
13531
|
* @throws {RequiredError}
|
|
11604
13532
|
* @memberof SystemApi
|
|
11605
13533
|
*/
|
|
11606
|
-
public backupConfiguration(resources
|
|
13534
|
+
public backupConfiguration(resources?: Array<string>, metadata?: { [key: string]: string; }, options?: RawAxiosRequestConfig) {
|
|
11607
13535
|
return SystemApiFp(this.configuration).backupConfiguration(resources, metadata, options).then((request) => request(this.axios, this.basePath));
|
|
11608
13536
|
}
|
|
11609
13537
|
|
|
@@ -12324,7 +14252,53 @@ export class TrajectoryExecutionApi extends BaseAPI {
|
|
|
12324
14252
|
export const TrajectoryPlanningApiAxiosParamCreator = function (configuration?: Configuration) {
|
|
12325
14253
|
return {
|
|
12326
14254
|
/**
|
|
12327
|
-
* Plans a
|
|
14255
|
+
* 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.
|
|
14256
|
+
* @summary Plan Collision-Free Trajectory
|
|
14257
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
14258
|
+
* @param {PlanCollisionFreeRequest} [planCollisionFreeRequest]
|
|
14259
|
+
* @param {*} [options] Override http request option.
|
|
14260
|
+
* @throws {RequiredError}
|
|
14261
|
+
*/
|
|
14262
|
+
planCollisionFree: async (cell: string, planCollisionFreeRequest?: PlanCollisionFreeRequest, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
14263
|
+
// verify required parameter 'cell' is not null or undefined
|
|
14264
|
+
assertParamExists('planCollisionFree', 'cell', cell)
|
|
14265
|
+
const localVarPath = `/cells/{cell}/trajectory-planning/plan-collision-free`
|
|
14266
|
+
.replace(`{${"cell"}}`, encodeURIComponent(String(cell)));
|
|
14267
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
14268
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
14269
|
+
let baseOptions;
|
|
14270
|
+
if (configuration) {
|
|
14271
|
+
baseOptions = configuration.baseOptions;
|
|
14272
|
+
}
|
|
14273
|
+
|
|
14274
|
+
const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
|
|
14275
|
+
const localVarHeaderParameter = {} as any;
|
|
14276
|
+
const localVarQueryParameter = {} as any;
|
|
14277
|
+
|
|
14278
|
+
// authentication BasicAuth required
|
|
14279
|
+
// http basic authentication required
|
|
14280
|
+
setBasicAuthToObject(localVarRequestOptions, configuration)
|
|
14281
|
+
|
|
14282
|
+
// authentication BearerAuth required
|
|
14283
|
+
// http bearer authentication required
|
|
14284
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
14285
|
+
|
|
14286
|
+
|
|
14287
|
+
|
|
14288
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
14289
|
+
|
|
14290
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
14291
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
14292
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
14293
|
+
localVarRequestOptions.data = serializeDataIfNeeded(planCollisionFreeRequest, localVarRequestOptions, configuration)
|
|
14294
|
+
|
|
14295
|
+
return {
|
|
14296
|
+
url: toPathString(localVarUrlObj),
|
|
14297
|
+
options: localVarRequestOptions,
|
|
14298
|
+
};
|
|
14299
|
+
},
|
|
14300
|
+
/**
|
|
14301
|
+
* 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.
|
|
12328
14302
|
* @summary Plan Trajectory
|
|
12329
14303
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
12330
14304
|
* @param {PlanTrajectoryRequest} [planTrajectoryRequest]
|
|
@@ -12380,7 +14354,21 @@ export const TrajectoryPlanningApiFp = function(configuration?: Configuration) {
|
|
|
12380
14354
|
const localVarAxiosParamCreator = TrajectoryPlanningApiAxiosParamCreator(configuration)
|
|
12381
14355
|
return {
|
|
12382
14356
|
/**
|
|
12383
|
-
* Plans a
|
|
14357
|
+
* 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.
|
|
14358
|
+
* @summary Plan Collision-Free Trajectory
|
|
14359
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
14360
|
+
* @param {PlanCollisionFreeRequest} [planCollisionFreeRequest]
|
|
14361
|
+
* @param {*} [options] Override http request option.
|
|
14362
|
+
* @throws {RequiredError}
|
|
14363
|
+
*/
|
|
14364
|
+
async planCollisionFree(cell: string, planCollisionFreeRequest?: PlanCollisionFreeRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PlanCollisionFreeResponse>> {
|
|
14365
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.planCollisionFree(cell, planCollisionFreeRequest, options);
|
|
14366
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
14367
|
+
const localVarOperationServerBasePath = operationServerMap['TrajectoryPlanningApi.planCollisionFree']?.[localVarOperationServerIndex]?.url;
|
|
14368
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
14369
|
+
},
|
|
14370
|
+
/**
|
|
14371
|
+
* 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.
|
|
12384
14372
|
* @summary Plan Trajectory
|
|
12385
14373
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
12386
14374
|
* @param {PlanTrajectoryRequest} [planTrajectoryRequest]
|
|
@@ -12404,7 +14392,18 @@ export const TrajectoryPlanningApiFactory = function (configuration?: Configurat
|
|
|
12404
14392
|
const localVarFp = TrajectoryPlanningApiFp(configuration)
|
|
12405
14393
|
return {
|
|
12406
14394
|
/**
|
|
12407
|
-
* Plans a
|
|
14395
|
+
* 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.
|
|
14396
|
+
* @summary Plan Collision-Free Trajectory
|
|
14397
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
14398
|
+
* @param {PlanCollisionFreeRequest} [planCollisionFreeRequest]
|
|
14399
|
+
* @param {*} [options] Override http request option.
|
|
14400
|
+
* @throws {RequiredError}
|
|
14401
|
+
*/
|
|
14402
|
+
planCollisionFree(cell: string, planCollisionFreeRequest?: PlanCollisionFreeRequest, options?: RawAxiosRequestConfig): AxiosPromise<PlanCollisionFreeResponse> {
|
|
14403
|
+
return localVarFp.planCollisionFree(cell, planCollisionFreeRequest, options).then((request) => request(axios, basePath));
|
|
14404
|
+
},
|
|
14405
|
+
/**
|
|
14406
|
+
* 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.
|
|
12408
14407
|
* @summary Plan Trajectory
|
|
12409
14408
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
12410
14409
|
* @param {PlanTrajectoryRequest} [planTrajectoryRequest]
|
|
@@ -12425,7 +14424,20 @@ export const TrajectoryPlanningApiFactory = function (configuration?: Configurat
|
|
|
12425
14424
|
*/
|
|
12426
14425
|
export class TrajectoryPlanningApi extends BaseAPI {
|
|
12427
14426
|
/**
|
|
12428
|
-
* Plans a
|
|
14427
|
+
* 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.
|
|
14428
|
+
* @summary Plan Collision-Free Trajectory
|
|
14429
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
14430
|
+
* @param {PlanCollisionFreeRequest} [planCollisionFreeRequest]
|
|
14431
|
+
* @param {*} [options] Override http request option.
|
|
14432
|
+
* @throws {RequiredError}
|
|
14433
|
+
* @memberof TrajectoryPlanningApi
|
|
14434
|
+
*/
|
|
14435
|
+
public planCollisionFree(cell: string, planCollisionFreeRequest?: PlanCollisionFreeRequest, options?: RawAxiosRequestConfig) {
|
|
14436
|
+
return TrajectoryPlanningApiFp(this.configuration).planCollisionFree(cell, planCollisionFreeRequest, options).then((request) => request(this.axios, this.basePath));
|
|
14437
|
+
}
|
|
14438
|
+
|
|
14439
|
+
/**
|
|
14440
|
+
* 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.
|
|
12429
14441
|
* @summary Plan Trajectory
|
|
12430
14442
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
12431
14443
|
* @param {PlanTrajectoryRequest} [planTrajectoryRequest]
|