@wandelbots/nova-api 25.7.0-dev.26 → 25.7.0-dev.28
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/package.json +1 -1
- package/v2/api.d.ts +1784 -523
- package/v2/api.js +1408 -253
- package/v2/api.js.map +1 -1
- package/v2/api.ts +2460 -480
package/v2/api.ts
CHANGED
|
@@ -366,6 +366,182 @@ export const BoxBoxTypeEnum = {
|
|
|
366
366
|
|
|
367
367
|
export type BoxBoxTypeEnum = typeof BoxBoxTypeEnum[keyof typeof BoxBoxTypeEnum];
|
|
368
368
|
|
|
369
|
+
/**
|
|
370
|
+
* PROFINET BUS Inputs/Outputs Service configuration.
|
|
371
|
+
* @export
|
|
372
|
+
* @interface BusIOProfinet
|
|
373
|
+
*/
|
|
374
|
+
export interface BusIOProfinet {
|
|
375
|
+
/**
|
|
376
|
+
*
|
|
377
|
+
* @type {string}
|
|
378
|
+
* @memberof BusIOProfinet
|
|
379
|
+
*/
|
|
380
|
+
'bus_type'?: BusIOProfinetBusTypeEnum;
|
|
381
|
+
/**
|
|
382
|
+
* Path to the configuration file.
|
|
383
|
+
* @type {string}
|
|
384
|
+
* @memberof BusIOProfinet
|
|
385
|
+
*/
|
|
386
|
+
'config_file_content'?: string;
|
|
387
|
+
/**
|
|
388
|
+
*
|
|
389
|
+
* @type {BusIOProfinetNetwork}
|
|
390
|
+
* @memberof BusIOProfinet
|
|
391
|
+
*/
|
|
392
|
+
'network_config'?: BusIOProfinetNetwork;
|
|
393
|
+
/**
|
|
394
|
+
* MAC address for the PROFINET port, should be get from another NOVA API endpoind?
|
|
395
|
+
* @type {string}
|
|
396
|
+
* @memberof BusIOProfinet
|
|
397
|
+
*/
|
|
398
|
+
'mac': string;
|
|
399
|
+
/**
|
|
400
|
+
*
|
|
401
|
+
* @type {BusIOProfinetDefaultRoute}
|
|
402
|
+
* @memberof BusIOProfinet
|
|
403
|
+
*/
|
|
404
|
+
'default_route': BusIOProfinetDefaultRoute;
|
|
405
|
+
}
|
|
406
|
+
|
|
407
|
+
export const BusIOProfinetBusTypeEnum = {
|
|
408
|
+
Profinet: 'profinet'
|
|
409
|
+
} as const;
|
|
410
|
+
|
|
411
|
+
export type BusIOProfinetBusTypeEnum = typeof BusIOProfinetBusTypeEnum[keyof typeof BusIOProfinetBusTypeEnum];
|
|
412
|
+
|
|
413
|
+
/**
|
|
414
|
+
* Default route configuration for the PROFINET service. Will be removed before release by automatic default route configuration, if possible.
|
|
415
|
+
* @export
|
|
416
|
+
* @interface BusIOProfinetDefaultRoute
|
|
417
|
+
*/
|
|
418
|
+
export interface BusIOProfinetDefaultRoute {
|
|
419
|
+
/**
|
|
420
|
+
* Gateway for the default route.
|
|
421
|
+
* @type {string}
|
|
422
|
+
* @memberof BusIOProfinetDefaultRoute
|
|
423
|
+
*/
|
|
424
|
+
'gateway': string;
|
|
425
|
+
/**
|
|
426
|
+
* Interface for the default route.
|
|
427
|
+
* @type {string}
|
|
428
|
+
* @memberof BusIOProfinetDefaultRoute
|
|
429
|
+
*/
|
|
430
|
+
'interface': string;
|
|
431
|
+
}
|
|
432
|
+
/**
|
|
433
|
+
* Network configuration for the PROFINET device
|
|
434
|
+
* @export
|
|
435
|
+
* @interface BusIOProfinetIpConfig
|
|
436
|
+
*/
|
|
437
|
+
export interface BusIOProfinetIpConfig {
|
|
438
|
+
/**
|
|
439
|
+
* IP address for the PROFINET device
|
|
440
|
+
* @type {string}
|
|
441
|
+
* @memberof BusIOProfinetIpConfig
|
|
442
|
+
*/
|
|
443
|
+
'ip': string;
|
|
444
|
+
/**
|
|
445
|
+
* Network mask for the PROFINET device.
|
|
446
|
+
* @type {string}
|
|
447
|
+
* @memberof BusIOProfinetIpConfig
|
|
448
|
+
*/
|
|
449
|
+
'netmask': string;
|
|
450
|
+
/**
|
|
451
|
+
* Gateway for the PROFINET device
|
|
452
|
+
* @type {string}
|
|
453
|
+
* @memberof BusIOProfinetIpConfig
|
|
454
|
+
*/
|
|
455
|
+
'gateway': string;
|
|
456
|
+
}
|
|
457
|
+
/**
|
|
458
|
+
*
|
|
459
|
+
* @export
|
|
460
|
+
* @interface BusIOProfinetNetwork
|
|
461
|
+
*/
|
|
462
|
+
export interface BusIOProfinetNetwork {
|
|
463
|
+
/**
|
|
464
|
+
* Name of the PROFINET device.
|
|
465
|
+
* @type {string}
|
|
466
|
+
* @memberof BusIOProfinetNetwork
|
|
467
|
+
*/
|
|
468
|
+
'device_name'?: string;
|
|
469
|
+
/**
|
|
470
|
+
*
|
|
471
|
+
* @type {BusIOProfinetIpConfig}
|
|
472
|
+
* @memberof BusIOProfinetNetwork
|
|
473
|
+
*/
|
|
474
|
+
'ip_config'?: BusIOProfinetIpConfig;
|
|
475
|
+
/**
|
|
476
|
+
* Content of the PROFINET REMA XML file.
|
|
477
|
+
* @type {string}
|
|
478
|
+
* @memberof BusIOProfinetNetwork
|
|
479
|
+
*/
|
|
480
|
+
'rema_xml_content'?: string;
|
|
481
|
+
}
|
|
482
|
+
/**
|
|
483
|
+
* Virtual PROFINET BUS Inputs/Outputs Service configuration.
|
|
484
|
+
* @export
|
|
485
|
+
* @interface BusIOProfinetVirtual
|
|
486
|
+
*/
|
|
487
|
+
export interface BusIOProfinetVirtual {
|
|
488
|
+
/**
|
|
489
|
+
*
|
|
490
|
+
* @type {string}
|
|
491
|
+
* @memberof BusIOProfinetVirtual
|
|
492
|
+
*/
|
|
493
|
+
'bus_type'?: BusIOProfinetVirtualBusTypeEnum;
|
|
494
|
+
}
|
|
495
|
+
|
|
496
|
+
export const BusIOProfinetVirtualBusTypeEnum = {
|
|
497
|
+
VirtualProfinet: 'virtual_profinet'
|
|
498
|
+
} as const;
|
|
499
|
+
|
|
500
|
+
export type BusIOProfinetVirtualBusTypeEnum = typeof BusIOProfinetVirtualBusTypeEnum[keyof typeof BusIOProfinetVirtualBusTypeEnum];
|
|
501
|
+
|
|
502
|
+
/**
|
|
503
|
+
* @type BusIOType
|
|
504
|
+
* @export
|
|
505
|
+
*/
|
|
506
|
+
export type BusIOType = { bus_type: 'profinet' } & BusIOProfinet | { bus_type: 'profinet_virtual' } & BusIOProfinetVirtual;
|
|
507
|
+
|
|
508
|
+
/**
|
|
509
|
+
*
|
|
510
|
+
* @export
|
|
511
|
+
* @interface BusIOsState
|
|
512
|
+
*/
|
|
513
|
+
export interface BusIOsState {
|
|
514
|
+
/**
|
|
515
|
+
*
|
|
516
|
+
* @type {BusIOsStateEnum}
|
|
517
|
+
* @memberof BusIOsState
|
|
518
|
+
*/
|
|
519
|
+
'state': BusIOsStateEnum;
|
|
520
|
+
/**
|
|
521
|
+
* 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.
|
|
522
|
+
* @type {string}
|
|
523
|
+
* @memberof BusIOsState
|
|
524
|
+
*/
|
|
525
|
+
'message'?: string;
|
|
526
|
+
}
|
|
527
|
+
|
|
528
|
+
|
|
529
|
+
/**
|
|
530
|
+
* Current state of the BUS input/output service.
|
|
531
|
+
* @export
|
|
532
|
+
* @enum {string}
|
|
533
|
+
*/
|
|
534
|
+
|
|
535
|
+
export const BusIOsStateEnum = {
|
|
536
|
+
BusIosStateUnknown: 'BUS_IOS_STATE_UNKNOWN',
|
|
537
|
+
BusIosStateInitializing: 'BUS_IOS_STATE_INITIALIZING',
|
|
538
|
+
BusIosStateConnected: 'BUS_IOS_STATE_CONNECTED',
|
|
539
|
+
BusIosStateDisconnected: 'BUS_IOS_STATE_DISCONNECTED'
|
|
540
|
+
} as const;
|
|
541
|
+
|
|
542
|
+
export type BusIOsStateEnum = typeof BusIOsStateEnum[keyof typeof BusIOsStateEnum];
|
|
543
|
+
|
|
544
|
+
|
|
369
545
|
/**
|
|
370
546
|
* Defines a cylindrical shape with 2 semi-spheres on the top and bottom. Centred around origin, symmetric around z-axis.
|
|
371
547
|
* @export
|
|
@@ -514,13 +690,13 @@ export interface Collision {
|
|
|
514
690
|
* @type {string}
|
|
515
691
|
* @memberof Collision
|
|
516
692
|
*/
|
|
517
|
-
'
|
|
693
|
+
'id_of_layer'?: string;
|
|
518
694
|
/**
|
|
519
695
|
* A three-dimensional vector [x, y, z] with double precision.
|
|
520
696
|
* @type {Array<number>}
|
|
521
697
|
* @memberof Collision
|
|
522
698
|
*/
|
|
523
|
-
'
|
|
699
|
+
'normal_root_on_b'?: Array<number>;
|
|
524
700
|
/**
|
|
525
701
|
*
|
|
526
702
|
* @type {CollisionContact}
|
|
@@ -551,7 +727,7 @@ export interface CollisionContact {
|
|
|
551
727
|
* @type {Array<number>}
|
|
552
728
|
* @memberof CollisionContact
|
|
553
729
|
*/
|
|
554
|
-
'
|
|
730
|
+
'root'?: Array<number>;
|
|
555
731
|
}
|
|
556
732
|
/**
|
|
557
733
|
*
|
|
@@ -567,110 +743,42 @@ export interface CollisionError {
|
|
|
567
743
|
'collision'?: FeedbackCollision;
|
|
568
744
|
}
|
|
569
745
|
/**
|
|
570
|
-
*
|
|
746
|
+
* @type CollisionFreeAlgorithm
|
|
747
|
+
* Configuration for collision-free path planning algorithms. Different algorithms may have different parameters and behavior.
|
|
571
748
|
* @export
|
|
572
|
-
* @interface CollisionMotionGroup
|
|
573
749
|
*/
|
|
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
|
-
}
|
|
750
|
+
export type CollisionFreeAlgorithm = MidpointInsertionAlgorithm | RRTConnectAlgorithm;
|
|
751
|
+
|
|
588
752
|
/**
|
|
589
753
|
*
|
|
590
754
|
* @export
|
|
591
|
-
* @interface
|
|
755
|
+
* @interface CollisionSetup
|
|
592
756
|
*/
|
|
593
|
-
export interface
|
|
594
|
-
/**
|
|
595
|
-
* References a stored link chain.
|
|
596
|
-
* @type {string}
|
|
597
|
-
* @memberof CollisionMotionGroupAssembly
|
|
598
|
-
*/
|
|
599
|
-
'stored_link_chain'?: string;
|
|
757
|
+
export interface CollisionSetup {
|
|
600
758
|
/**
|
|
601
|
-
*
|
|
602
|
-
* @type {string}
|
|
603
|
-
* @memberof
|
|
759
|
+
* A collection of identifiable colliders.
|
|
760
|
+
* @type {{ [key: string]: Collider; }}
|
|
761
|
+
* @memberof CollisionSetup
|
|
604
762
|
*/
|
|
605
|
-
'
|
|
763
|
+
'colliders'?: { [key: string]: Collider; };
|
|
606
764
|
/**
|
|
607
765
|
* 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
766
|
* @type {Array<{ [key: string]: Collider; }>}
|
|
609
|
-
* @memberof
|
|
767
|
+
* @memberof CollisionSetup
|
|
610
768
|
*/
|
|
611
769
|
'link_chain'?: Array<{ [key: string]: Collider; }>;
|
|
612
770
|
/**
|
|
613
771
|
* 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
772
|
* @type {{ [key: string]: Collider; }}
|
|
615
|
-
* @memberof
|
|
773
|
+
* @memberof CollisionSetup
|
|
616
774
|
*/
|
|
617
775
|
'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
776
|
/**
|
|
669
|
-
*
|
|
670
|
-
* @type {
|
|
671
|
-
* @memberof
|
|
777
|
+
* 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.
|
|
778
|
+
* @type {boolean}
|
|
779
|
+
* @memberof CollisionSetup
|
|
672
780
|
*/
|
|
673
|
-
'
|
|
781
|
+
'self_collision_detection'?: boolean;
|
|
674
782
|
}
|
|
675
783
|
/**
|
|
676
784
|
* 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.
|
|
@@ -1126,6 +1234,128 @@ export const Direction = {
|
|
|
1126
1234
|
export type Direction = typeof Direction[keyof typeof Direction];
|
|
1127
1235
|
|
|
1128
1236
|
|
|
1237
|
+
/**
|
|
1238
|
+
* The provided joint data does not match the expected number of joints for this motion group.
|
|
1239
|
+
* @export
|
|
1240
|
+
* @interface ErrorInvalidJointCount
|
|
1241
|
+
*/
|
|
1242
|
+
export interface ErrorInvalidJointCount {
|
|
1243
|
+
/**
|
|
1244
|
+
* The expected number of joints for this motion group.
|
|
1245
|
+
* @type {number}
|
|
1246
|
+
* @memberof ErrorInvalidJointCount
|
|
1247
|
+
*/
|
|
1248
|
+
'expected_joint_count': number;
|
|
1249
|
+
/**
|
|
1250
|
+
* The number of provided joints.
|
|
1251
|
+
* @type {number}
|
|
1252
|
+
* @memberof ErrorInvalidJointCount
|
|
1253
|
+
*/
|
|
1254
|
+
'provided_joint_count': number;
|
|
1255
|
+
/**
|
|
1256
|
+
*
|
|
1257
|
+
* @type {string}
|
|
1258
|
+
* @memberof ErrorInvalidJointCount
|
|
1259
|
+
*/
|
|
1260
|
+
'error_feedback_name': ErrorInvalidJointCountErrorFeedbackNameEnum;
|
|
1261
|
+
}
|
|
1262
|
+
|
|
1263
|
+
export const ErrorInvalidJointCountErrorFeedbackNameEnum = {
|
|
1264
|
+
ErrorInvalidJointCount: 'ErrorInvalidJointCount'
|
|
1265
|
+
} as const;
|
|
1266
|
+
|
|
1267
|
+
export type ErrorInvalidJointCountErrorFeedbackNameEnum = typeof ErrorInvalidJointCountErrorFeedbackNameEnum[keyof typeof ErrorInvalidJointCountErrorFeedbackNameEnum];
|
|
1268
|
+
|
|
1269
|
+
/**
|
|
1270
|
+
* A reference joint position (start or target) exceeds the configured joint limits.
|
|
1271
|
+
* @export
|
|
1272
|
+
* @interface ErrorJointLimitExceeded
|
|
1273
|
+
*/
|
|
1274
|
+
export interface ErrorJointLimitExceeded {
|
|
1275
|
+
/**
|
|
1276
|
+
* Index of the joint exceeding its limits (0-based).
|
|
1277
|
+
* @type {number}
|
|
1278
|
+
* @memberof ErrorJointLimitExceeded
|
|
1279
|
+
*/
|
|
1280
|
+
'joint_index'?: number;
|
|
1281
|
+
/**
|
|
1282
|
+
*
|
|
1283
|
+
* @type {Array<number>}
|
|
1284
|
+
* @memberof ErrorJointLimitExceeded
|
|
1285
|
+
*/
|
|
1286
|
+
'joint_position'?: Array<number>;
|
|
1287
|
+
/**
|
|
1288
|
+
*
|
|
1289
|
+
* @type {string}
|
|
1290
|
+
* @memberof ErrorJointLimitExceeded
|
|
1291
|
+
*/
|
|
1292
|
+
'error_feedback_name': ErrorJointLimitExceededErrorFeedbackNameEnum;
|
|
1293
|
+
}
|
|
1294
|
+
|
|
1295
|
+
export const ErrorJointLimitExceededErrorFeedbackNameEnum = {
|
|
1296
|
+
ErrorJointLimitExceeded: 'ErrorJointLimitExceeded'
|
|
1297
|
+
} as const;
|
|
1298
|
+
|
|
1299
|
+
export type ErrorJointLimitExceededErrorFeedbackNameEnum = typeof ErrorJointLimitExceededErrorFeedbackNameEnum[keyof typeof ErrorJointLimitExceededErrorFeedbackNameEnum];
|
|
1300
|
+
|
|
1301
|
+
/**
|
|
1302
|
+
* A reference joint position (e.g. start or target joint position) results in collisions that prevent processing.
|
|
1303
|
+
* @export
|
|
1304
|
+
* @interface ErrorJointPositionCollision
|
|
1305
|
+
*/
|
|
1306
|
+
export interface ErrorJointPositionCollision {
|
|
1307
|
+
/**
|
|
1308
|
+
*
|
|
1309
|
+
* @type {Array<Collision>}
|
|
1310
|
+
* @memberof ErrorJointPositionCollision
|
|
1311
|
+
*/
|
|
1312
|
+
'collisions'?: Array<Collision>;
|
|
1313
|
+
/**
|
|
1314
|
+
*
|
|
1315
|
+
* @type {Array<number>}
|
|
1316
|
+
* @memberof ErrorJointPositionCollision
|
|
1317
|
+
*/
|
|
1318
|
+
'joint_position'?: Array<number>;
|
|
1319
|
+
/**
|
|
1320
|
+
*
|
|
1321
|
+
* @type {string}
|
|
1322
|
+
* @memberof ErrorJointPositionCollision
|
|
1323
|
+
*/
|
|
1324
|
+
'error_feedback_name': ErrorJointPositionCollisionErrorFeedbackNameEnum;
|
|
1325
|
+
}
|
|
1326
|
+
|
|
1327
|
+
export const ErrorJointPositionCollisionErrorFeedbackNameEnum = {
|
|
1328
|
+
ErrorJointPositionCollision: 'ErrorJointPositionCollision'
|
|
1329
|
+
} as const;
|
|
1330
|
+
|
|
1331
|
+
export type ErrorJointPositionCollisionErrorFeedbackNameEnum = typeof ErrorJointPositionCollisionErrorFeedbackNameEnum[keyof typeof ErrorJointPositionCollisionErrorFeedbackNameEnum];
|
|
1332
|
+
|
|
1333
|
+
/**
|
|
1334
|
+
* The collision-free planning algorithm reached its maximum iteration limit without finding a valid path. Increase max_iterations or modify the start/target positions.
|
|
1335
|
+
* @export
|
|
1336
|
+
* @interface ErrorMaxIterationsExceeded
|
|
1337
|
+
*/
|
|
1338
|
+
export interface ErrorMaxIterationsExceeded {
|
|
1339
|
+
/**
|
|
1340
|
+
* The maximum number of iterations that was reached.
|
|
1341
|
+
* @type {number}
|
|
1342
|
+
* @memberof ErrorMaxIterationsExceeded
|
|
1343
|
+
*/
|
|
1344
|
+
'max_iterations'?: number;
|
|
1345
|
+
/**
|
|
1346
|
+
*
|
|
1347
|
+
* @type {string}
|
|
1348
|
+
* @memberof ErrorMaxIterationsExceeded
|
|
1349
|
+
*/
|
|
1350
|
+
'error_feedback_name': ErrorMaxIterationsExceededErrorFeedbackNameEnum;
|
|
1351
|
+
}
|
|
1352
|
+
|
|
1353
|
+
export const ErrorMaxIterationsExceededErrorFeedbackNameEnum = {
|
|
1354
|
+
ErrorMaxIterationsExceeded: 'ErrorMaxIterationsExceeded'
|
|
1355
|
+
} as const;
|
|
1356
|
+
|
|
1357
|
+
export type ErrorMaxIterationsExceededErrorFeedbackNameEnum = typeof ErrorMaxIterationsExceededErrorFeedbackNameEnum[keyof typeof ErrorMaxIterationsExceededErrorFeedbackNameEnum];
|
|
1358
|
+
|
|
1129
1359
|
/**
|
|
1130
1360
|
* 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.
|
|
1131
1361
|
* @export
|
|
@@ -1403,49 +1633,128 @@ export type FloatValueValueTypeEnum = typeof FloatValueValueTypeEnum[keyof typeo
|
|
|
1403
1633
|
/**
|
|
1404
1634
|
*
|
|
1405
1635
|
* @export
|
|
1406
|
-
* @interface
|
|
1636
|
+
* @interface ForwardKinematics422Response
|
|
1407
1637
|
*/
|
|
1408
|
-
export interface
|
|
1638
|
+
export interface ForwardKinematics422Response {
|
|
1409
1639
|
/**
|
|
1410
1640
|
*
|
|
1411
|
-
* @type {
|
|
1412
|
-
* @memberof
|
|
1641
|
+
* @type {Array<ForwardKinematicsValidationError>}
|
|
1642
|
+
* @memberof ForwardKinematics422Response
|
|
1413
1643
|
*/
|
|
1414
|
-
'
|
|
1644
|
+
'detail'?: Array<ForwardKinematicsValidationError>;
|
|
1415
1645
|
}
|
|
1416
|
-
|
|
1417
|
-
|
|
1418
1646
|
/**
|
|
1419
1647
|
*
|
|
1420
1648
|
* @export
|
|
1421
|
-
* @interface
|
|
1649
|
+
* @interface ForwardKinematicsRequest
|
|
1422
1650
|
*/
|
|
1423
|
-
export interface
|
|
1651
|
+
export interface ForwardKinematicsRequest {
|
|
1424
1652
|
/**
|
|
1425
|
-
*
|
|
1653
|
+
* String identifiying the model of a motion group.
|
|
1426
1654
|
* @type {string}
|
|
1427
|
-
* @memberof
|
|
1655
|
+
* @memberof ForwardKinematicsRequest
|
|
1428
1656
|
*/
|
|
1429
|
-
'
|
|
1657
|
+
'motion_group_model': string;
|
|
1430
1658
|
/**
|
|
1431
|
-
*
|
|
1432
|
-
* @type {
|
|
1433
|
-
* @memberof
|
|
1659
|
+
* List of joint positions [rad] for which TCP poses are computed.
|
|
1660
|
+
* @type {Array<Array<number>>}
|
|
1661
|
+
* @memberof ForwardKinematicsRequest
|
|
1434
1662
|
*/
|
|
1435
|
-
'
|
|
1663
|
+
'joint_positions': Array<Array<number>>;
|
|
1436
1664
|
/**
|
|
1437
|
-
*
|
|
1438
|
-
* @type {
|
|
1439
|
-
* @memberof
|
|
1665
|
+
*
|
|
1666
|
+
* @type {Pose}
|
|
1667
|
+
* @memberof ForwardKinematicsRequest
|
|
1440
1668
|
*/
|
|
1441
|
-
'
|
|
1669
|
+
'tcp_offset'?: Pose;
|
|
1670
|
+
/**
|
|
1671
|
+
* Offset from the world frame to the motion group base.
|
|
1672
|
+
* @type {Pose}
|
|
1673
|
+
* @memberof ForwardKinematicsRequest
|
|
1674
|
+
*/
|
|
1675
|
+
'mounting'?: Pose;
|
|
1442
1676
|
}
|
|
1443
1677
|
/**
|
|
1444
1678
|
*
|
|
1445
1679
|
* @export
|
|
1446
|
-
* @interface
|
|
1680
|
+
* @interface ForwardKinematicsResponse
|
|
1447
1681
|
*/
|
|
1448
|
-
export interface
|
|
1682
|
+
export interface ForwardKinematicsResponse {
|
|
1683
|
+
/**
|
|
1684
|
+
* List of computed TCP poses corresponding to the input joint positions.
|
|
1685
|
+
* @type {Array<Pose>}
|
|
1686
|
+
* @memberof ForwardKinematicsResponse
|
|
1687
|
+
*/
|
|
1688
|
+
'tcp_poses': Array<Pose>;
|
|
1689
|
+
}
|
|
1690
|
+
/**
|
|
1691
|
+
*
|
|
1692
|
+
* @export
|
|
1693
|
+
* @interface ForwardKinematicsValidationError
|
|
1694
|
+
*/
|
|
1695
|
+
export interface ForwardKinematicsValidationError {
|
|
1696
|
+
/**
|
|
1697
|
+
*
|
|
1698
|
+
* @type {Array<ValidationErrorLocInner>}
|
|
1699
|
+
* @memberof ForwardKinematicsValidationError
|
|
1700
|
+
*/
|
|
1701
|
+
'loc': Array<ValidationErrorLocInner>;
|
|
1702
|
+
/**
|
|
1703
|
+
*
|
|
1704
|
+
* @type {string}
|
|
1705
|
+
* @memberof ForwardKinematicsValidationError
|
|
1706
|
+
*/
|
|
1707
|
+
'msg': string;
|
|
1708
|
+
/**
|
|
1709
|
+
*
|
|
1710
|
+
* @type {string}
|
|
1711
|
+
* @memberof ForwardKinematicsValidationError
|
|
1712
|
+
*/
|
|
1713
|
+
'type': string;
|
|
1714
|
+
/**
|
|
1715
|
+
*
|
|
1716
|
+
* @type {{ [key: string]: any; }}
|
|
1717
|
+
* @memberof ForwardKinematicsValidationError
|
|
1718
|
+
*/
|
|
1719
|
+
'input': { [key: string]: any; };
|
|
1720
|
+
/**
|
|
1721
|
+
*
|
|
1722
|
+
* @type {ErrorInvalidJointCount}
|
|
1723
|
+
* @memberof ForwardKinematicsValidationError
|
|
1724
|
+
*/
|
|
1725
|
+
'data'?: ErrorInvalidJointCount;
|
|
1726
|
+
}
|
|
1727
|
+
/**
|
|
1728
|
+
*
|
|
1729
|
+
* @export
|
|
1730
|
+
* @interface GetTrajectoryResponse
|
|
1731
|
+
*/
|
|
1732
|
+
export interface GetTrajectoryResponse {
|
|
1733
|
+
/**
|
|
1734
|
+
* Unique identifier of the motion group the trajectory is planned for.
|
|
1735
|
+
* @type {string}
|
|
1736
|
+
* @memberof GetTrajectoryResponse
|
|
1737
|
+
*/
|
|
1738
|
+
'motion_group': string;
|
|
1739
|
+
/**
|
|
1740
|
+
* The trajectory consisting of a list of joint positions and an equal number of corresponding timestamps.
|
|
1741
|
+
* @type {JointTrajectory}
|
|
1742
|
+
* @memberof GetTrajectoryResponse
|
|
1743
|
+
*/
|
|
1744
|
+
'trajectory': JointTrajectory;
|
|
1745
|
+
/**
|
|
1746
|
+
* Unique identifier of the tool the trajectory is planned for.
|
|
1747
|
+
* @type {string}
|
|
1748
|
+
* @memberof GetTrajectoryResponse
|
|
1749
|
+
*/
|
|
1750
|
+
'tcp': string;
|
|
1751
|
+
}
|
|
1752
|
+
/**
|
|
1753
|
+
*
|
|
1754
|
+
* @export
|
|
1755
|
+
* @interface HTTPValidationError
|
|
1756
|
+
*/
|
|
1757
|
+
export interface HTTPValidationError {
|
|
1449
1758
|
/**
|
|
1450
1759
|
*
|
|
1451
1760
|
* @type {Array<ValidationError>}
|
|
@@ -1927,6 +2236,19 @@ export interface InvalidDofInvalidDof {
|
|
|
1927
2236
|
*/
|
|
1928
2237
|
'joint_position'?: Array<number>;
|
|
1929
2238
|
}
|
|
2239
|
+
/**
|
|
2240
|
+
*
|
|
2241
|
+
* @export
|
|
2242
|
+
* @interface InverseKinematics422Response
|
|
2243
|
+
*/
|
|
2244
|
+
export interface InverseKinematics422Response {
|
|
2245
|
+
/**
|
|
2246
|
+
*
|
|
2247
|
+
* @type {Array<InverseKinematicsValidationError>}
|
|
2248
|
+
* @memberof InverseKinematics422Response
|
|
2249
|
+
*/
|
|
2250
|
+
'detail'?: Array<InverseKinematicsValidationError>;
|
|
2251
|
+
}
|
|
1930
2252
|
/**
|
|
1931
2253
|
*
|
|
1932
2254
|
* @export
|
|
@@ -1964,11 +2286,11 @@ export interface InverseKinematicsRequest {
|
|
|
1964
2286
|
*/
|
|
1965
2287
|
'joint_position_limits'?: Array<LimitRange>;
|
|
1966
2288
|
/**
|
|
1967
|
-
* Collision
|
|
1968
|
-
* @type {{ [key: string]:
|
|
2289
|
+
* 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.
|
|
2290
|
+
* @type {{ [key: string]: CollisionSetup; }}
|
|
1969
2291
|
* @memberof InverseKinematicsRequest
|
|
1970
2292
|
*/
|
|
1971
|
-
'
|
|
2293
|
+
'collision_setups'?: { [key: string]: CollisionSetup; };
|
|
1972
2294
|
}
|
|
1973
2295
|
/**
|
|
1974
2296
|
*
|
|
@@ -1983,6 +2305,50 @@ export interface InverseKinematicsResponse {
|
|
|
1983
2305
|
*/
|
|
1984
2306
|
'joints': Array<Array<Array<number>>>;
|
|
1985
2307
|
}
|
|
2308
|
+
/**
|
|
2309
|
+
*
|
|
2310
|
+
* @export
|
|
2311
|
+
* @interface InverseKinematicsValidationError
|
|
2312
|
+
*/
|
|
2313
|
+
export interface InverseKinematicsValidationError {
|
|
2314
|
+
/**
|
|
2315
|
+
*
|
|
2316
|
+
* @type {Array<ValidationErrorLocInner>}
|
|
2317
|
+
* @memberof InverseKinematicsValidationError
|
|
2318
|
+
*/
|
|
2319
|
+
'loc': Array<ValidationErrorLocInner>;
|
|
2320
|
+
/**
|
|
2321
|
+
*
|
|
2322
|
+
* @type {string}
|
|
2323
|
+
* @memberof InverseKinematicsValidationError
|
|
2324
|
+
*/
|
|
2325
|
+
'msg': string;
|
|
2326
|
+
/**
|
|
2327
|
+
*
|
|
2328
|
+
* @type {string}
|
|
2329
|
+
* @memberof InverseKinematicsValidationError
|
|
2330
|
+
*/
|
|
2331
|
+
'type': string;
|
|
2332
|
+
/**
|
|
2333
|
+
*
|
|
2334
|
+
* @type {{ [key: string]: any; }}
|
|
2335
|
+
* @memberof InverseKinematicsValidationError
|
|
2336
|
+
*/
|
|
2337
|
+
'input': { [key: string]: any; };
|
|
2338
|
+
/**
|
|
2339
|
+
*
|
|
2340
|
+
* @type {InverseKinematicsValidationErrorAllOfData}
|
|
2341
|
+
* @memberof InverseKinematicsValidationError
|
|
2342
|
+
*/
|
|
2343
|
+
'data'?: InverseKinematicsValidationErrorAllOfData;
|
|
2344
|
+
}
|
|
2345
|
+
/**
|
|
2346
|
+
* @type InverseKinematicsValidationErrorAllOfData
|
|
2347
|
+
* Optional data further specifying the validation error.
|
|
2348
|
+
* @export
|
|
2349
|
+
*/
|
|
2350
|
+
export type InverseKinematicsValidationErrorAllOfData = { error_feedback_name: 'ErrorInvalidJointCount' } & ErrorInvalidJointCount | { error_feedback_name: 'ErrorJointLimitExceeded' } & ErrorJointLimitExceeded;
|
|
2351
|
+
|
|
1986
2352
|
/**
|
|
1987
2353
|
* 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.
|
|
1988
2354
|
* @export
|
|
@@ -2565,6 +2931,32 @@ export const Manufacturer = {
|
|
|
2565
2931
|
export type Manufacturer = typeof Manufacturer[keyof typeof Manufacturer];
|
|
2566
2932
|
|
|
2567
2933
|
|
|
2934
|
+
/**
|
|
2935
|
+
* 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.
|
|
2936
|
+
* @export
|
|
2937
|
+
* @interface MidpointInsertionAlgorithm
|
|
2938
|
+
*/
|
|
2939
|
+
export interface MidpointInsertionAlgorithm {
|
|
2940
|
+
/**
|
|
2941
|
+
* Algorithm discriminator.
|
|
2942
|
+
* @type {string}
|
|
2943
|
+
* @memberof MidpointInsertionAlgorithm
|
|
2944
|
+
*/
|
|
2945
|
+
'algorithm_name': MidpointInsertionAlgorithmAlgorithmNameEnum;
|
|
2946
|
+
/**
|
|
2947
|
+
* Maximum number of iterations for the midpoint insertion algorithm. Higher values increase likelyhood of success, but also computation time (linear).
|
|
2948
|
+
* @type {number}
|
|
2949
|
+
* @memberof MidpointInsertionAlgorithm
|
|
2950
|
+
*/
|
|
2951
|
+
'max_iterations'?: number;
|
|
2952
|
+
}
|
|
2953
|
+
|
|
2954
|
+
export const MidpointInsertionAlgorithmAlgorithmNameEnum = {
|
|
2955
|
+
MidpointInsertionAlgorithm: 'MidpointInsertionAlgorithm'
|
|
2956
|
+
} as const;
|
|
2957
|
+
|
|
2958
|
+
export type MidpointInsertionAlgorithmAlgorithmNameEnum = typeof MidpointInsertionAlgorithmAlgorithmNameEnum[keyof typeof MidpointInsertionAlgorithmAlgorithmNameEnum];
|
|
2959
|
+
|
|
2568
2960
|
/**
|
|
2569
2961
|
*
|
|
2570
2962
|
* @export
|
|
@@ -2745,6 +3137,55 @@ export interface MotionGroupJoints {
|
|
|
2745
3137
|
*/
|
|
2746
3138
|
'torques'?: Array<number>;
|
|
2747
3139
|
}
|
|
3140
|
+
/**
|
|
3141
|
+
*
|
|
3142
|
+
* @export
|
|
3143
|
+
* @interface MotionGroupSetup
|
|
3144
|
+
*/
|
|
3145
|
+
export interface MotionGroupSetup {
|
|
3146
|
+
/**
|
|
3147
|
+
* String identifiying the model of a motion group.
|
|
3148
|
+
* @type {string}
|
|
3149
|
+
* @memberof MotionGroupSetup
|
|
3150
|
+
*/
|
|
3151
|
+
'motion_group_model': string;
|
|
3152
|
+
/**
|
|
3153
|
+
* [ms] cycle time of the motion group controller. A trajectory for this motion group should be computed to this resolution.
|
|
3154
|
+
* @type {number}
|
|
3155
|
+
* @memberof MotionGroupSetup
|
|
3156
|
+
*/
|
|
3157
|
+
'cycle_time': number;
|
|
3158
|
+
/**
|
|
3159
|
+
* The offset from the world frame to the motion group base.
|
|
3160
|
+
* @type {Pose}
|
|
3161
|
+
* @memberof MotionGroupSetup
|
|
3162
|
+
*/
|
|
3163
|
+
'mounting'?: Pose;
|
|
3164
|
+
/**
|
|
3165
|
+
*
|
|
3166
|
+
* @type {Pose}
|
|
3167
|
+
* @memberof MotionGroupSetup
|
|
3168
|
+
*/
|
|
3169
|
+
'tcp_offset'?: Pose;
|
|
3170
|
+
/**
|
|
3171
|
+
*
|
|
3172
|
+
* @type {LimitSet}
|
|
3173
|
+
* @memberof MotionGroupSetup
|
|
3174
|
+
*/
|
|
3175
|
+
'global_limits'?: LimitSet;
|
|
3176
|
+
/**
|
|
3177
|
+
*
|
|
3178
|
+
* @type {Payload}
|
|
3179
|
+
* @memberof MotionGroupSetup
|
|
3180
|
+
*/
|
|
3181
|
+
'payload'?: Payload;
|
|
3182
|
+
/**
|
|
3183
|
+
* 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.
|
|
3184
|
+
* @type {{ [key: string]: CollisionSetup; }}
|
|
3185
|
+
* @memberof MotionGroupSetup
|
|
3186
|
+
*/
|
|
3187
|
+
'collision_setups'?: { [key: string]: CollisionSetup; };
|
|
3188
|
+
}
|
|
2748
3189
|
/**
|
|
2749
3190
|
* Presents the current state of the motion group.
|
|
2750
3191
|
* @export
|
|
@@ -3307,6 +3748,82 @@ export interface Payload {
|
|
|
3307
3748
|
*/
|
|
3308
3749
|
'moment_of_inertia'?: Array<number>;
|
|
3309
3750
|
}
|
|
3751
|
+
/**
|
|
3752
|
+
*
|
|
3753
|
+
* @export
|
|
3754
|
+
* @interface Plan422Response
|
|
3755
|
+
*/
|
|
3756
|
+
export interface Plan422Response {
|
|
3757
|
+
/**
|
|
3758
|
+
*
|
|
3759
|
+
* @type {Array<PlanValidationError>}
|
|
3760
|
+
* @memberof Plan422Response
|
|
3761
|
+
*/
|
|
3762
|
+
'detail'?: Array<PlanValidationError>;
|
|
3763
|
+
}
|
|
3764
|
+
/**
|
|
3765
|
+
* Response when collision-free trajectory planning fails. Contains specific feedback about why the planning failed.
|
|
3766
|
+
* @export
|
|
3767
|
+
* @interface PlanCollisionFreeFailedResponse
|
|
3768
|
+
*/
|
|
3769
|
+
export interface PlanCollisionFreeFailedResponse {
|
|
3770
|
+
/**
|
|
3771
|
+
*
|
|
3772
|
+
* @type {ErrorMaxIterationsExceeded}
|
|
3773
|
+
* @memberof PlanCollisionFreeFailedResponse
|
|
3774
|
+
*/
|
|
3775
|
+
'error_feedback': ErrorMaxIterationsExceeded;
|
|
3776
|
+
}
|
|
3777
|
+
/**
|
|
3778
|
+
*
|
|
3779
|
+
* @export
|
|
3780
|
+
* @interface PlanCollisionFreeRequest
|
|
3781
|
+
*/
|
|
3782
|
+
export interface PlanCollisionFreeRequest {
|
|
3783
|
+
/**
|
|
3784
|
+
* The data to assemble the robot setup can be retrieved from [getMotionGroupDescription](getMotionGroupDescription) endpoint.
|
|
3785
|
+
* @type {MotionGroupSetup}
|
|
3786
|
+
* @memberof PlanCollisionFreeRequest
|
|
3787
|
+
*/
|
|
3788
|
+
'motion_group_setup': MotionGroupSetup;
|
|
3789
|
+
/**
|
|
3790
|
+
*
|
|
3791
|
+
* @type {Array<number>}
|
|
3792
|
+
* @memberof PlanCollisionFreeRequest
|
|
3793
|
+
*/
|
|
3794
|
+
'start_joint_position': Array<number>;
|
|
3795
|
+
/**
|
|
3796
|
+
*
|
|
3797
|
+
* @type {Array<number>}
|
|
3798
|
+
* @memberof PlanCollisionFreeRequest
|
|
3799
|
+
*/
|
|
3800
|
+
'target': Array<number>;
|
|
3801
|
+
/**
|
|
3802
|
+
*
|
|
3803
|
+
* @type {CollisionFreeAlgorithm}
|
|
3804
|
+
* @memberof PlanCollisionFreeRequest
|
|
3805
|
+
*/
|
|
3806
|
+
'algorithm': CollisionFreeAlgorithm;
|
|
3807
|
+
}
|
|
3808
|
+
/**
|
|
3809
|
+
* Response from collision-free trajectory planning. Contains either a successful joint trajectory or failure information.
|
|
3810
|
+
* @export
|
|
3811
|
+
* @interface PlanCollisionFreeResponse
|
|
3812
|
+
*/
|
|
3813
|
+
export interface PlanCollisionFreeResponse {
|
|
3814
|
+
/**
|
|
3815
|
+
*
|
|
3816
|
+
* @type {PlanCollisionFreeResponseResponse}
|
|
3817
|
+
* @memberof PlanCollisionFreeResponse
|
|
3818
|
+
*/
|
|
3819
|
+
'response': PlanCollisionFreeResponseResponse;
|
|
3820
|
+
}
|
|
3821
|
+
/**
|
|
3822
|
+
* @type PlanCollisionFreeResponseResponse
|
|
3823
|
+
* @export
|
|
3824
|
+
*/
|
|
3825
|
+
export type PlanCollisionFreeResponseResponse = JointTrajectory | PlanCollisionFreeFailedResponse;
|
|
3826
|
+
|
|
3310
3827
|
/**
|
|
3311
3828
|
*
|
|
3312
3829
|
* @export
|
|
@@ -3346,10 +3863,10 @@ export type PlanTrajectoryFailedResponseErrorFeedback = FeedbackCollision | Feed
|
|
|
3346
3863
|
export interface PlanTrajectoryRequest {
|
|
3347
3864
|
/**
|
|
3348
3865
|
* The data to assemble the robot setup can be retrieved from [getMotionGroupDescription](getMotionGroupDescription) endpoint.
|
|
3349
|
-
* @type {
|
|
3866
|
+
* @type {MotionGroupSetup}
|
|
3350
3867
|
* @memberof PlanTrajectoryRequest
|
|
3351
3868
|
*/
|
|
3352
|
-
'
|
|
3869
|
+
'motion_group_setup': MotionGroupSetup;
|
|
3353
3870
|
/**
|
|
3354
3871
|
*
|
|
3355
3872
|
* @type {Array<number>}
|
|
@@ -3382,6 +3899,50 @@ export interface PlanTrajectoryResponse {
|
|
|
3382
3899
|
*/
|
|
3383
3900
|
export type PlanTrajectoryResponseResponse = JointTrajectory | PlanTrajectoryFailedResponse;
|
|
3384
3901
|
|
|
3902
|
+
/**
|
|
3903
|
+
*
|
|
3904
|
+
* @export
|
|
3905
|
+
* @interface PlanValidationError
|
|
3906
|
+
*/
|
|
3907
|
+
export interface PlanValidationError {
|
|
3908
|
+
/**
|
|
3909
|
+
*
|
|
3910
|
+
* @type {Array<ValidationErrorLocInner>}
|
|
3911
|
+
* @memberof PlanValidationError
|
|
3912
|
+
*/
|
|
3913
|
+
'loc': Array<ValidationErrorLocInner>;
|
|
3914
|
+
/**
|
|
3915
|
+
*
|
|
3916
|
+
* @type {string}
|
|
3917
|
+
* @memberof PlanValidationError
|
|
3918
|
+
*/
|
|
3919
|
+
'msg': string;
|
|
3920
|
+
/**
|
|
3921
|
+
*
|
|
3922
|
+
* @type {string}
|
|
3923
|
+
* @memberof PlanValidationError
|
|
3924
|
+
*/
|
|
3925
|
+
'type': string;
|
|
3926
|
+
/**
|
|
3927
|
+
*
|
|
3928
|
+
* @type {{ [key: string]: any; }}
|
|
3929
|
+
* @memberof PlanValidationError
|
|
3930
|
+
*/
|
|
3931
|
+
'input': { [key: string]: any; };
|
|
3932
|
+
/**
|
|
3933
|
+
*
|
|
3934
|
+
* @type {PlanValidationErrorAllOfData}
|
|
3935
|
+
* @memberof PlanValidationError
|
|
3936
|
+
*/
|
|
3937
|
+
'data'?: PlanValidationErrorAllOfData;
|
|
3938
|
+
}
|
|
3939
|
+
/**
|
|
3940
|
+
* @type PlanValidationErrorAllOfData
|
|
3941
|
+
* Optional data further specifying the validation error.
|
|
3942
|
+
* @export
|
|
3943
|
+
*/
|
|
3944
|
+
export type PlanValidationErrorAllOfData = { error_feedback_name: 'ErrorInvalidJointCount' } & ErrorInvalidJointCount | { error_feedback_name: 'ErrorJointLimitExceeded' } & ErrorJointLimitExceeded | { error_feedback_name: 'ErrorJointPositionCollision' } & ErrorJointPositionCollision;
|
|
3945
|
+
|
|
3385
3946
|
/**
|
|
3386
3947
|
* Defines an x/y-plane with infinite size.
|
|
3387
3948
|
* @export
|
|
@@ -3474,36 +4035,295 @@ export interface Pose {
|
|
|
3474
4035
|
'orientation'?: Array<number>;
|
|
3475
4036
|
}
|
|
3476
4037
|
/**
|
|
3477
|
-
*
|
|
4038
|
+
*
|
|
3478
4039
|
* @export
|
|
3479
|
-
* @interface
|
|
4040
|
+
* @interface ProfinetDescription
|
|
3480
4041
|
*/
|
|
3481
|
-
export interface
|
|
4042
|
+
export interface ProfinetDescription {
|
|
3482
4043
|
/**
|
|
3483
|
-
*
|
|
4044
|
+
* The vendor identifier of the PROFINET device, identifying the manufacturer.
|
|
3484
4045
|
* @type {string}
|
|
3485
|
-
* @memberof
|
|
4046
|
+
* @memberof ProfinetDescription
|
|
3486
4047
|
*/
|
|
3487
|
-
'
|
|
4048
|
+
'vendor_id': string;
|
|
3488
4049
|
/**
|
|
3489
|
-
* The
|
|
3490
|
-
* @type {
|
|
3491
|
-
* @memberof
|
|
4050
|
+
* The device identifier of the PROFINET device, identifying the specific device within the vendor\'s range.
|
|
4051
|
+
* @type {string}
|
|
4052
|
+
* @memberof ProfinetDescription
|
|
3492
4053
|
*/
|
|
3493
|
-
'
|
|
4054
|
+
'device_id': string;
|
|
3494
4055
|
/**
|
|
3495
|
-
*
|
|
3496
|
-
* @type {
|
|
3497
|
-
* @memberof
|
|
4056
|
+
*
|
|
4057
|
+
* @type {Array<ProfinetSlotDescription>}
|
|
4058
|
+
* @memberof ProfinetDescription
|
|
3498
4059
|
*/
|
|
3499
|
-
'
|
|
4060
|
+
'slots'?: Array<ProfinetSlotDescription>;
|
|
4061
|
+
/**
|
|
4062
|
+
* Name of the PROFINET device
|
|
4063
|
+
* @type {string}
|
|
4064
|
+
* @memberof ProfinetDescription
|
|
4065
|
+
*/
|
|
4066
|
+
'device_name'?: string;
|
|
4067
|
+
/**
|
|
4068
|
+
* IP address for the PROFINET device
|
|
4069
|
+
* @type {string}
|
|
4070
|
+
* @memberof ProfinetDescription
|
|
4071
|
+
*/
|
|
4072
|
+
'ip'?: string;
|
|
3500
4073
|
}
|
|
3501
|
-
|
|
3502
|
-
|
|
3503
|
-
|
|
3504
|
-
|
|
3505
|
-
|
|
3506
|
-
export
|
|
4074
|
+
/**
|
|
4075
|
+
*
|
|
4076
|
+
* @export
|
|
4077
|
+
* @interface ProfinetIO
|
|
4078
|
+
*/
|
|
4079
|
+
export interface ProfinetIO {
|
|
4080
|
+
/**
|
|
4081
|
+
* 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.
|
|
4082
|
+
* @type {string}
|
|
4083
|
+
* @memberof ProfinetIO
|
|
4084
|
+
*/
|
|
4085
|
+
'name': string;
|
|
4086
|
+
/**
|
|
4087
|
+
*
|
|
4088
|
+
* @type {ProfinetIOTypeEnum}
|
|
4089
|
+
* @memberof ProfinetIO
|
|
4090
|
+
*/
|
|
4091
|
+
'type': ProfinetIOTypeEnum;
|
|
4092
|
+
/**
|
|
4093
|
+
* The direction of the input/output value, indicating whether it is an input or output for the device.
|
|
4094
|
+
* @type {ProfinetIODirection}
|
|
4095
|
+
* @memberof ProfinetIO
|
|
4096
|
+
*/
|
|
4097
|
+
'direction': ProfinetIODirection;
|
|
4098
|
+
/**
|
|
4099
|
+
* 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.
|
|
4100
|
+
* @type {number}
|
|
4101
|
+
* @memberof ProfinetIO
|
|
4102
|
+
*/
|
|
4103
|
+
'byte_address': number;
|
|
4104
|
+
/**
|
|
4105
|
+
* 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.
|
|
4106
|
+
* @type {number}
|
|
4107
|
+
* @memberof ProfinetIO
|
|
4108
|
+
*/
|
|
4109
|
+
'bit_address'?: number;
|
|
4110
|
+
/**
|
|
4111
|
+
* The unique identifier for the input/output value. This identifier is used to reference the specific input/output in the NOVA system.
|
|
4112
|
+
* @type {string}
|
|
4113
|
+
* @memberof ProfinetIO
|
|
4114
|
+
*/
|
|
4115
|
+
'io': string;
|
|
4116
|
+
}
|
|
4117
|
+
|
|
4118
|
+
|
|
4119
|
+
/**
|
|
4120
|
+
*
|
|
4121
|
+
* @export
|
|
4122
|
+
* @interface ProfinetIOData
|
|
4123
|
+
*/
|
|
4124
|
+
export interface ProfinetIOData {
|
|
4125
|
+
/**
|
|
4126
|
+
* 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.
|
|
4127
|
+
* @type {string}
|
|
4128
|
+
* @memberof ProfinetIOData
|
|
4129
|
+
*/
|
|
4130
|
+
'name': string;
|
|
4131
|
+
/**
|
|
4132
|
+
*
|
|
4133
|
+
* @type {ProfinetIOTypeEnum}
|
|
4134
|
+
* @memberof ProfinetIOData
|
|
4135
|
+
*/
|
|
4136
|
+
'type': ProfinetIOTypeEnum;
|
|
4137
|
+
/**
|
|
4138
|
+
* The direction of the input/output value, indicating whether it is an input or output for the device.
|
|
4139
|
+
* @type {ProfinetIODirection}
|
|
4140
|
+
* @memberof ProfinetIOData
|
|
4141
|
+
*/
|
|
4142
|
+
'direction': ProfinetIODirection;
|
|
4143
|
+
/**
|
|
4144
|
+
* 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.
|
|
4145
|
+
* @type {number}
|
|
4146
|
+
* @memberof ProfinetIOData
|
|
4147
|
+
*/
|
|
4148
|
+
'byte_address': number;
|
|
4149
|
+
/**
|
|
4150
|
+
* 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.
|
|
4151
|
+
* @type {number}
|
|
4152
|
+
* @memberof ProfinetIOData
|
|
4153
|
+
*/
|
|
4154
|
+
'bit_address'?: number;
|
|
4155
|
+
}
|
|
4156
|
+
|
|
4157
|
+
|
|
4158
|
+
/**
|
|
4159
|
+
* Identifies the input/output type.
|
|
4160
|
+
* @export
|
|
4161
|
+
* @enum {string}
|
|
4162
|
+
*/
|
|
4163
|
+
|
|
4164
|
+
export const ProfinetIODirection = {
|
|
4165
|
+
ProfinetIoDirectionInput: 'PROFINET_IO_DIRECTION_INPUT',
|
|
4166
|
+
ProfinetIoDirectionOutput: 'PROFINET_IO_DIRECTION_OUTPUT',
|
|
4167
|
+
ProfinetIoDirectionInout: 'PROFINET_IO_DIRECTION_INOUT'
|
|
4168
|
+
} as const;
|
|
4169
|
+
|
|
4170
|
+
export type ProfinetIODirection = typeof ProfinetIODirection[keyof typeof ProfinetIODirection];
|
|
4171
|
+
|
|
4172
|
+
|
|
4173
|
+
/**
|
|
4174
|
+
* Value type of the PROFINET input/output.
|
|
4175
|
+
* @export
|
|
4176
|
+
* @enum {string}
|
|
4177
|
+
*/
|
|
4178
|
+
|
|
4179
|
+
export const ProfinetIOTypeEnum = {
|
|
4180
|
+
ProfinetIoTypeUnknown: 'PROFINET_IO_TYPE_UNKNOWN',
|
|
4181
|
+
ProfinetIoTypeBool: 'PROFINET_IO_TYPE_BOOL',
|
|
4182
|
+
ProfinetIoTypeUsint: 'PROFINET_IO_TYPE_USINT',
|
|
4183
|
+
ProfinetIoTypeSint: 'PROFINET_IO_TYPE_SINT',
|
|
4184
|
+
ProfinetIoTypeUint: 'PROFINET_IO_TYPE_UINT',
|
|
4185
|
+
ProfinetIoTypeInt: 'PROFINET_IO_TYPE_INT',
|
|
4186
|
+
ProfinetIoTypeUdint: 'PROFINET_IO_TYPE_UDINT',
|
|
4187
|
+
ProfinetIoTypeDint: 'PROFINET_IO_TYPE_DINT',
|
|
4188
|
+
ProfinetIoTypeReal: 'PROFINET_IO_TYPE_REAL',
|
|
4189
|
+
ProfinetIoTypeLreal: 'PROFINET_IO_TYPE_LREAL'
|
|
4190
|
+
} as const;
|
|
4191
|
+
|
|
4192
|
+
export type ProfinetIOTypeEnum = typeof ProfinetIOTypeEnum[keyof typeof ProfinetIOTypeEnum];
|
|
4193
|
+
|
|
4194
|
+
|
|
4195
|
+
/**
|
|
4196
|
+
*
|
|
4197
|
+
* @export
|
|
4198
|
+
* @interface ProfinetInputOutputConfig
|
|
4199
|
+
*/
|
|
4200
|
+
export interface ProfinetInputOutputConfig {
|
|
4201
|
+
/**
|
|
4202
|
+
* Content of the input output configuration file.
|
|
4203
|
+
* @type {string}
|
|
4204
|
+
* @memberof ProfinetInputOutputConfig
|
|
4205
|
+
*/
|
|
4206
|
+
'config': string;
|
|
4207
|
+
/**
|
|
4208
|
+
* Offset in bytes for the input data.
|
|
4209
|
+
* @type {number}
|
|
4210
|
+
* @memberof ProfinetInputOutputConfig
|
|
4211
|
+
*/
|
|
4212
|
+
'input_offset': number;
|
|
4213
|
+
/**
|
|
4214
|
+
* Offset in bytes for the output data.
|
|
4215
|
+
* @type {number}
|
|
4216
|
+
* @memberof ProfinetInputOutputConfig
|
|
4217
|
+
*/
|
|
4218
|
+
'output_offset': number;
|
|
4219
|
+
}
|
|
4220
|
+
/**
|
|
4221
|
+
*
|
|
4222
|
+
* @export
|
|
4223
|
+
* @interface ProfinetSlotDescription
|
|
4224
|
+
*/
|
|
4225
|
+
export interface ProfinetSlotDescription {
|
|
4226
|
+
/**
|
|
4227
|
+
* The number of the PROFINET slot.
|
|
4228
|
+
* @type {number}
|
|
4229
|
+
* @memberof ProfinetSlotDescription
|
|
4230
|
+
*/
|
|
4231
|
+
'number': number;
|
|
4232
|
+
/**
|
|
4233
|
+
* The API number of the PROFINET input, used to identify the specific API for the input.
|
|
4234
|
+
* @type {number}
|
|
4235
|
+
* @memberof ProfinetSlotDescription
|
|
4236
|
+
*/
|
|
4237
|
+
'api': number;
|
|
4238
|
+
/**
|
|
4239
|
+
* An array of PROFINET subslots.
|
|
4240
|
+
* @type {Array<ProfinetSubSlotDescription>}
|
|
4241
|
+
* @memberof ProfinetSlotDescription
|
|
4242
|
+
*/
|
|
4243
|
+
'subslots': Array<ProfinetSubSlotDescription>;
|
|
4244
|
+
}
|
|
4245
|
+
/**
|
|
4246
|
+
*
|
|
4247
|
+
* @export
|
|
4248
|
+
* @interface ProfinetSubSlotDescription
|
|
4249
|
+
*/
|
|
4250
|
+
export interface ProfinetSubSlotDescription {
|
|
4251
|
+
/**
|
|
4252
|
+
* The identifier of the PROFINET subslot.
|
|
4253
|
+
* @type {number}
|
|
4254
|
+
* @memberof ProfinetSubSlotDescription
|
|
4255
|
+
*/
|
|
4256
|
+
'number': number;
|
|
4257
|
+
/**
|
|
4258
|
+
* The length in bytes of the PROFINET input.
|
|
4259
|
+
* @type {number}
|
|
4260
|
+
* @memberof ProfinetSubSlotDescription
|
|
4261
|
+
*/
|
|
4262
|
+
'input_length': number;
|
|
4263
|
+
/**
|
|
4264
|
+
* The length in bytes of the PROFINET output.
|
|
4265
|
+
* @type {number}
|
|
4266
|
+
* @memberof ProfinetSubSlotDescription
|
|
4267
|
+
*/
|
|
4268
|
+
'output_length': number;
|
|
4269
|
+
}
|
|
4270
|
+
/**
|
|
4271
|
+
* <!-- 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.
|
|
4272
|
+
* @export
|
|
4273
|
+
* @interface RRTConnectAlgorithm
|
|
4274
|
+
*/
|
|
4275
|
+
export interface RRTConnectAlgorithm {
|
|
4276
|
+
/**
|
|
4277
|
+
* Algorithm discriminator.
|
|
4278
|
+
* @type {string}
|
|
4279
|
+
* @memberof RRTConnectAlgorithm
|
|
4280
|
+
*/
|
|
4281
|
+
'algorithm_name': RRTConnectAlgorithmAlgorithmNameEnum;
|
|
4282
|
+
/**
|
|
4283
|
+
* Maximum number of iterations for the RRT Connect algorithm. Higher values increase likelihood of success, but also computation time.
|
|
4284
|
+
* @type {number}
|
|
4285
|
+
* @memberof RRTConnectAlgorithm
|
|
4286
|
+
*/
|
|
4287
|
+
'max_iterations'?: number;
|
|
4288
|
+
}
|
|
4289
|
+
|
|
4290
|
+
export const RRTConnectAlgorithmAlgorithmNameEnum = {
|
|
4291
|
+
RrtConnectAlgorithm: 'RRTConnectAlgorithm'
|
|
4292
|
+
} as const;
|
|
4293
|
+
|
|
4294
|
+
export type RRTConnectAlgorithmAlgorithmNameEnum = typeof RRTConnectAlgorithmAlgorithmNameEnum[keyof typeof RRTConnectAlgorithmAlgorithmNameEnum];
|
|
4295
|
+
|
|
4296
|
+
/**
|
|
4297
|
+
* Defines an x/y-plane with finite size. Centred around the z-axis.
|
|
4298
|
+
* @export
|
|
4299
|
+
* @interface Rectangle
|
|
4300
|
+
*/
|
|
4301
|
+
export interface Rectangle {
|
|
4302
|
+
/**
|
|
4303
|
+
*
|
|
4304
|
+
* @type {string}
|
|
4305
|
+
* @memberof Rectangle
|
|
4306
|
+
*/
|
|
4307
|
+
'shape_type': RectangleShapeTypeEnum;
|
|
4308
|
+
/**
|
|
4309
|
+
* The dimension in x-direction in [mm].
|
|
4310
|
+
* @type {number}
|
|
4311
|
+
* @memberof Rectangle
|
|
4312
|
+
*/
|
|
4313
|
+
'size_x': number;
|
|
4314
|
+
/**
|
|
4315
|
+
* The dimension in y-direction in [mm].
|
|
4316
|
+
* @type {number}
|
|
4317
|
+
* @memberof Rectangle
|
|
4318
|
+
*/
|
|
4319
|
+
'size_y': number;
|
|
4320
|
+
}
|
|
4321
|
+
|
|
4322
|
+
export const RectangleShapeTypeEnum = {
|
|
4323
|
+
Rectangle: 'rectangle'
|
|
4324
|
+
} as const;
|
|
4325
|
+
|
|
4326
|
+
export type RectangleShapeTypeEnum = typeof RectangleShapeTypeEnum[keyof typeof RectangleShapeTypeEnum];
|
|
3507
4327
|
|
|
3508
4328
|
/**
|
|
3509
4329
|
* 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.
|
|
@@ -3588,6 +4408,18 @@ export type RobotControllerConfiguration = AbbController | FanucController | Kuk
|
|
|
3588
4408
|
* @interface RobotControllerState
|
|
3589
4409
|
*/
|
|
3590
4410
|
export interface RobotControllerState {
|
|
4411
|
+
/**
|
|
4412
|
+
* Mode of communication and control between NOVA and the robot controller.
|
|
4413
|
+
* @type {RobotSystemMode}
|
|
4414
|
+
* @memberof RobotControllerState
|
|
4415
|
+
*/
|
|
4416
|
+
'mode': RobotSystemMode;
|
|
4417
|
+
/**
|
|
4418
|
+
* 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.
|
|
4419
|
+
* @type {Array<string>}
|
|
4420
|
+
* @memberof RobotControllerState
|
|
4421
|
+
*/
|
|
4422
|
+
'last_error'?: Array<string>;
|
|
3591
4423
|
/**
|
|
3592
4424
|
* Timestamp indicating when the represented information was received from the robot controller.
|
|
3593
4425
|
* @type {string}
|
|
@@ -3634,66 +4466,17 @@ export interface RobotControllerState {
|
|
|
3634
4466
|
|
|
3635
4467
|
|
|
3636
4468
|
/**
|
|
3637
|
-
*
|
|
3638
|
-
* @export
|
|
3639
|
-
* @interface RobotSetup
|
|
3640
|
-
*/
|
|
3641
|
-
export interface RobotSetup {
|
|
3642
|
-
/**
|
|
3643
|
-
* String identifiying the model of a motion group.
|
|
3644
|
-
* @type {string}
|
|
3645
|
-
* @memberof RobotSetup
|
|
3646
|
-
*/
|
|
3647
|
-
'motion_group_model': string;
|
|
3648
|
-
/**
|
|
3649
|
-
* [ms] cycle time of the motion group controller. A trajectory for this motion group should be computed to this resolution.
|
|
3650
|
-
* @type {number}
|
|
3651
|
-
* @memberof RobotSetup
|
|
3652
|
-
*/
|
|
3653
|
-
'cycle_time': number;
|
|
3654
|
-
/**
|
|
3655
|
-
* The offset from the world frame to the motion group base.
|
|
3656
|
-
* @type {Pose}
|
|
3657
|
-
* @memberof RobotSetup
|
|
3658
|
-
*/
|
|
3659
|
-
'mounting'?: Pose;
|
|
3660
|
-
/**
|
|
3661
|
-
*
|
|
3662
|
-
* @type {Pose}
|
|
3663
|
-
* @memberof RobotSetup
|
|
3664
|
-
*/
|
|
3665
|
-
'tcp_offset'?: Pose;
|
|
3666
|
-
/**
|
|
3667
|
-
*
|
|
3668
|
-
* @type {LimitSet}
|
|
3669
|
-
* @memberof RobotSetup
|
|
3670
|
-
*/
|
|
3671
|
-
'global_limits'?: LimitSet;
|
|
3672
|
-
/**
|
|
3673
|
-
*
|
|
3674
|
-
* @type {Payload}
|
|
3675
|
-
* @memberof RobotSetup
|
|
3676
|
-
*/
|
|
3677
|
-
'payload'?: Payload;
|
|
3678
|
-
/**
|
|
3679
|
-
* Collision scenes to be respected by the motion planner. Each contains the single motion group which is planned for. Scenes are checked individually along the trajectory and independently of other scenes. To respect the safety zones of the controller, fetch the safety zones, link and tool shapes from the controller and add one scene made up of those. To respect the safety zones of the controller and check for collision: 1. Fetch the safety zones, link and tool shapes from the controller. 2. Add the fetched zones, links and tools to a scene. 3. Create other scenes from your own 3D data as needed. 4. Execute this endpoint. 5. The response highlights the scenes in which a collision was detected by key.
|
|
3680
|
-
* @type {{ [key: string]: SingleMotionGroupCollisionScene; }}
|
|
3681
|
-
* @memberof RobotSetup
|
|
3682
|
-
*/
|
|
3683
|
-
'collision_scenes'?: { [key: string]: SingleMotionGroupCollisionScene; };
|
|
3684
|
-
}
|
|
3685
|
-
/**
|
|
3686
|
-
* The system mode of the robot system. ### ROBOT_SYSTEM_MODE_UNDEFINED Indicates that the robot controller is currently performing a mode transition. ### ROBOT_SYSTEM_MODE_DISCONNECT There is no communication with the robot controller at all. All connections are closed. No command is sent to the robot controller while in this mode. No input/output interaction is possible in this mode! All move requests will be rejected in this mode! ### ROBOT_SYSTEM_MODE_MONITOR A connection to the robot controller is established to only read the robot controller state. No command is sent to the robot controller while in this mode. It is possible to receive input/output information. All move requests will be rejected in this mode! ### ROBOT_SYSTEM_MODE_CONTROL An active connection is established with the robot controller and the robot system is cyclic commanded to stay in its actual position. The robot controller state is received in the cycle time of the robot controller. Requests via the MotionService and JoggingService will be processed and executed in this mode. Input/Output interaction is possible in this mode! **In this mode the robot system can be commanded to move.** ### ROBOT_SYSTEM_MODE_FREE_DRIVE Like ROBOT_SYSTEM_MODE_MONITOR a connection to the robot controller is established to only read the robot controller state. The difference is that the motion groups can be moved by the user (Free Drive). Thus, the servo motors are turned on. All move requests will be rejected in this mode! **This mode is not supported by every robot!** Use [getSupportedModes](getSupportedModes) to evaluate if the device support free drive.
|
|
4469
|
+
* 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.
|
|
3687
4470
|
* @export
|
|
3688
4471
|
* @enum {string}
|
|
3689
4472
|
*/
|
|
3690
4473
|
|
|
3691
4474
|
export const RobotSystemMode = {
|
|
3692
|
-
|
|
3693
|
-
|
|
3694
|
-
|
|
3695
|
-
|
|
3696
|
-
|
|
4475
|
+
ModeControllerNotConfigured: 'MODE_CONTROLLER_NOT_CONFIGURED',
|
|
4476
|
+
ModeInitializing: 'MODE_INITIALIZING',
|
|
4477
|
+
ModeMonitor: 'MODE_MONITOR',
|
|
4478
|
+
ModeControl: 'MODE_CONTROL',
|
|
4479
|
+
ModeFreeDrive: 'MODE_FREE_DRIVE'
|
|
3697
4480
|
} as const;
|
|
3698
4481
|
|
|
3699
4482
|
export type RobotSystemMode = typeof RobotSystemMode[keyof typeof RobotSystemMode];
|
|
@@ -3945,37 +4728,6 @@ export const SettableRobotSystemMode = {
|
|
|
3945
4728
|
export type SettableRobotSystemMode = typeof SettableRobotSystemMode[keyof typeof SettableRobotSystemMode];
|
|
3946
4729
|
|
|
3947
4730
|
|
|
3948
|
-
/**
|
|
3949
|
-
*
|
|
3950
|
-
* @export
|
|
3951
|
-
* @interface SingleMotionGroupCollisionScene
|
|
3952
|
-
*/
|
|
3953
|
-
export interface SingleMotionGroupCollisionScene {
|
|
3954
|
-
/**
|
|
3955
|
-
* A collection of identifiable colliders.
|
|
3956
|
-
* @type {{ [key: string]: Collider; }}
|
|
3957
|
-
* @memberof SingleMotionGroupCollisionScene
|
|
3958
|
-
*/
|
|
3959
|
-
'static_colliders'?: { [key: string]: Collider; };
|
|
3960
|
-
/**
|
|
3961
|
-
* 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.
|
|
3962
|
-
* @type {Array<{ [key: string]: Collider; }>}
|
|
3963
|
-
* @memberof SingleMotionGroupCollisionScene
|
|
3964
|
-
*/
|
|
3965
|
-
'link_chain'?: Array<{ [key: string]: Collider; }>;
|
|
3966
|
-
/**
|
|
3967
|
-
* 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.
|
|
3968
|
-
* @type {{ [key: string]: Collider; }}
|
|
3969
|
-
* @memberof SingleMotionGroupCollisionScene
|
|
3970
|
-
*/
|
|
3971
|
-
'tool'?: { [key: string]: Collider; };
|
|
3972
|
-
/**
|
|
3973
|
-
* If true, self-collision detection is enabled for the motion group. See LinkChain documentation for details. Default is true.
|
|
3974
|
-
* @type {boolean}
|
|
3975
|
-
* @memberof SingleMotionGroupCollisionScene
|
|
3976
|
-
*/
|
|
3977
|
-
'motion_group_self_collision_detection'?: boolean;
|
|
3978
|
-
}
|
|
3979
4731
|
/**
|
|
3980
4732
|
*
|
|
3981
4733
|
* @export
|
|
@@ -4562,6 +5314,12 @@ export interface ValidationError {
|
|
|
4562
5314
|
* @memberof ValidationError
|
|
4563
5315
|
*/
|
|
4564
5316
|
'type': string;
|
|
5317
|
+
/**
|
|
5318
|
+
*
|
|
5319
|
+
* @type {{ [key: string]: any; }}
|
|
5320
|
+
* @memberof ValidationError
|
|
5321
|
+
*/
|
|
5322
|
+
'input': { [key: string]: any; };
|
|
4565
5323
|
}
|
|
4566
5324
|
/**
|
|
4567
5325
|
* @type ValidationErrorLocInner
|
|
@@ -5280,92 +6038,1222 @@ export const ApplicationApiFactory = function (configuration?: Configuration, ba
|
|
|
5280
6038
|
};
|
|
5281
6039
|
};
|
|
5282
6040
|
|
|
5283
|
-
/**
|
|
5284
|
-
* ApplicationApi - object-oriented interface
|
|
5285
|
-
* @export
|
|
5286
|
-
* @class ApplicationApi
|
|
5287
|
-
* @extends {BaseAPI}
|
|
5288
|
-
*/
|
|
5289
|
-
export class ApplicationApi extends BaseAPI {
|
|
6041
|
+
/**
|
|
6042
|
+
* ApplicationApi - object-oriented interface
|
|
6043
|
+
* @export
|
|
6044
|
+
* @class ApplicationApi
|
|
6045
|
+
* @extends {BaseAPI}
|
|
6046
|
+
*/
|
|
6047
|
+
export class ApplicationApi extends BaseAPI {
|
|
6048
|
+
/**
|
|
6049
|
+
* 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.
|
|
6050
|
+
* @summary Add Application
|
|
6051
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
6052
|
+
* @param {App} app
|
|
6053
|
+
* @param {number} [completionTimeout]
|
|
6054
|
+
* @param {*} [options] Override http request option.
|
|
6055
|
+
* @throws {RequiredError}
|
|
6056
|
+
* @memberof ApplicationApi
|
|
6057
|
+
*/
|
|
6058
|
+
public addApp(cell: string, app: App, completionTimeout?: number, options?: RawAxiosRequestConfig) {
|
|
6059
|
+
return ApplicationApiFp(this.configuration).addApp(cell, app, completionTimeout, options).then((request) => request(this.axios, this.basePath));
|
|
6060
|
+
}
|
|
6061
|
+
|
|
6062
|
+
/**
|
|
6063
|
+
* Delete all GUI applications from the cell.
|
|
6064
|
+
* @summary Clear Applications
|
|
6065
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
6066
|
+
* @param {number} [completionTimeout]
|
|
6067
|
+
* @param {*} [options] Override http request option.
|
|
6068
|
+
* @throws {RequiredError}
|
|
6069
|
+
* @memberof ApplicationApi
|
|
6070
|
+
*/
|
|
6071
|
+
public clearApps(cell: string, completionTimeout?: number, options?: RawAxiosRequestConfig) {
|
|
6072
|
+
return ApplicationApiFp(this.configuration).clearApps(cell, completionTimeout, options).then((request) => request(this.axios, this.basePath));
|
|
6073
|
+
}
|
|
6074
|
+
|
|
6075
|
+
/**
|
|
6076
|
+
* Delete a GUI application from the cell.
|
|
6077
|
+
* @summary Delete Application
|
|
6078
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
6079
|
+
* @param {string} app
|
|
6080
|
+
* @param {number} [completionTimeout]
|
|
6081
|
+
* @param {*} [options] Override http request option.
|
|
6082
|
+
* @throws {RequiredError}
|
|
6083
|
+
* @memberof ApplicationApi
|
|
6084
|
+
*/
|
|
6085
|
+
public deleteApp(cell: string, app: string, completionTimeout?: number, options?: RawAxiosRequestConfig) {
|
|
6086
|
+
return ApplicationApiFp(this.configuration).deleteApp(cell, app, completionTimeout, options).then((request) => request(this.axios, this.basePath));
|
|
6087
|
+
}
|
|
6088
|
+
|
|
6089
|
+
/**
|
|
6090
|
+
* 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.
|
|
6091
|
+
* @summary Configuration
|
|
6092
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
6093
|
+
* @param {string} app
|
|
6094
|
+
* @param {*} [options] Override http request option.
|
|
6095
|
+
* @throws {RequiredError}
|
|
6096
|
+
* @memberof ApplicationApi
|
|
6097
|
+
*/
|
|
6098
|
+
public getApp(cell: string, app: string, options?: RawAxiosRequestConfig) {
|
|
6099
|
+
return ApplicationApiFp(this.configuration).getApp(cell, app, options).then((request) => request(this.axios, this.basePath));
|
|
6100
|
+
}
|
|
6101
|
+
|
|
6102
|
+
/**
|
|
6103
|
+
* 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.
|
|
6104
|
+
* @summary List Applications
|
|
6105
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
6106
|
+
* @param {*} [options] Override http request option.
|
|
6107
|
+
* @throws {RequiredError}
|
|
6108
|
+
* @memberof ApplicationApi
|
|
6109
|
+
*/
|
|
6110
|
+
public listApps(cell: string, options?: RawAxiosRequestConfig) {
|
|
6111
|
+
return ApplicationApiFp(this.configuration).listApps(cell, options).then((request) => request(this.axios, this.basePath));
|
|
6112
|
+
}
|
|
6113
|
+
|
|
6114
|
+
/**
|
|
6115
|
+
* Update the configuration of a GUI application in the cell.
|
|
6116
|
+
* @summary Update Configuration
|
|
6117
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
6118
|
+
* @param {string} app
|
|
6119
|
+
* @param {App} app2
|
|
6120
|
+
* @param {number} [completionTimeout]
|
|
6121
|
+
* @param {*} [options] Override http request option.
|
|
6122
|
+
* @throws {RequiredError}
|
|
6123
|
+
* @memberof ApplicationApi
|
|
6124
|
+
*/
|
|
6125
|
+
public updateApp(cell: string, app: string, app2: App, completionTimeout?: number, options?: RawAxiosRequestConfig) {
|
|
6126
|
+
return ApplicationApiFp(this.configuration).updateApp(cell, app, app2, completionTimeout, options).then((request) => request(this.axios, this.basePath));
|
|
6127
|
+
}
|
|
6128
|
+
}
|
|
6129
|
+
|
|
6130
|
+
|
|
6131
|
+
|
|
6132
|
+
/**
|
|
6133
|
+
* BUSInputsOutputsApi - axios parameter creator
|
|
6134
|
+
* @export
|
|
6135
|
+
*/
|
|
6136
|
+
export const BUSInputsOutputsApiAxiosParamCreator = function (configuration?: Configuration) {
|
|
6137
|
+
return {
|
|
6138
|
+
/**
|
|
6139
|
+
* Add a BUS Inputs/Outputs Service to the cell.
|
|
6140
|
+
* @summary Add Service
|
|
6141
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
6142
|
+
* @param {BusIOType} busIOType
|
|
6143
|
+
* @param {number} [completionTimeout]
|
|
6144
|
+
* @param {*} [options] Override http request option.
|
|
6145
|
+
* @throws {RequiredError}
|
|
6146
|
+
*/
|
|
6147
|
+
addBusIOService: async (cell: string, busIOType: BusIOType, completionTimeout?: number, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
6148
|
+
// verify required parameter 'cell' is not null or undefined
|
|
6149
|
+
assertParamExists('addBusIOService', 'cell', cell)
|
|
6150
|
+
// verify required parameter 'busIOType' is not null or undefined
|
|
6151
|
+
assertParamExists('addBusIOService', 'busIOType', busIOType)
|
|
6152
|
+
const localVarPath = `/cells/{cell}/bus-ios`
|
|
6153
|
+
.replace(`{${"cell"}}`, encodeURIComponent(String(cell)));
|
|
6154
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
6155
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
6156
|
+
let baseOptions;
|
|
6157
|
+
if (configuration) {
|
|
6158
|
+
baseOptions = configuration.baseOptions;
|
|
6159
|
+
}
|
|
6160
|
+
|
|
6161
|
+
const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
|
|
6162
|
+
const localVarHeaderParameter = {} as any;
|
|
6163
|
+
const localVarQueryParameter = {} as any;
|
|
6164
|
+
|
|
6165
|
+
// authentication BasicAuth required
|
|
6166
|
+
// http basic authentication required
|
|
6167
|
+
setBasicAuthToObject(localVarRequestOptions, configuration)
|
|
6168
|
+
|
|
6169
|
+
// authentication BearerAuth required
|
|
6170
|
+
// http bearer authentication required
|
|
6171
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
6172
|
+
|
|
6173
|
+
if (completionTimeout !== undefined) {
|
|
6174
|
+
localVarQueryParameter['completion_timeout'] = completionTimeout;
|
|
6175
|
+
}
|
|
6176
|
+
|
|
6177
|
+
|
|
6178
|
+
|
|
6179
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
6180
|
+
|
|
6181
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
6182
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
6183
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
6184
|
+
localVarRequestOptions.data = serializeDataIfNeeded(busIOType, localVarRequestOptions, configuration)
|
|
6185
|
+
|
|
6186
|
+
return {
|
|
6187
|
+
url: toPathString(localVarUrlObj),
|
|
6188
|
+
options: localVarRequestOptions,
|
|
6189
|
+
};
|
|
6190
|
+
},
|
|
6191
|
+
/**
|
|
6192
|
+
* Adds an input/output to or updates an input/output on the PROFINET device.
|
|
6193
|
+
* @summary Add PROFINET Input/Output
|
|
6194
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
6195
|
+
* @param {string} io Unique identifier to address an Input/Output in the cell.
|
|
6196
|
+
* @param {ProfinetIOData} profinetIOData
|
|
6197
|
+
* @param {*} [options] Override http request option.
|
|
6198
|
+
* @throws {RequiredError}
|
|
6199
|
+
*/
|
|
6200
|
+
addProfinetIO: async (cell: string, io: string, profinetIOData: ProfinetIOData, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
6201
|
+
// verify required parameter 'cell' is not null or undefined
|
|
6202
|
+
assertParamExists('addProfinetIO', 'cell', cell)
|
|
6203
|
+
// verify required parameter 'io' is not null or undefined
|
|
6204
|
+
assertParamExists('addProfinetIO', 'io', io)
|
|
6205
|
+
// verify required parameter 'profinetIOData' is not null or undefined
|
|
6206
|
+
assertParamExists('addProfinetIO', 'profinetIOData', profinetIOData)
|
|
6207
|
+
const localVarPath = `/cells/{cell}/bus-ios/profinet/ios/{io}`
|
|
6208
|
+
.replace(`{${"cell"}}`, encodeURIComponent(String(cell)))
|
|
6209
|
+
.replace(`{${"io"}}`, encodeURIComponent(String(io)));
|
|
6210
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
6211
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
6212
|
+
let baseOptions;
|
|
6213
|
+
if (configuration) {
|
|
6214
|
+
baseOptions = configuration.baseOptions;
|
|
6215
|
+
}
|
|
6216
|
+
|
|
6217
|
+
const localVarRequestOptions = { method: 'PUT', ...baseOptions, ...options};
|
|
6218
|
+
const localVarHeaderParameter = {} as any;
|
|
6219
|
+
const localVarQueryParameter = {} as any;
|
|
6220
|
+
|
|
6221
|
+
// authentication BasicAuth required
|
|
6222
|
+
// http basic authentication required
|
|
6223
|
+
setBasicAuthToObject(localVarRequestOptions, configuration)
|
|
6224
|
+
|
|
6225
|
+
// authentication BearerAuth required
|
|
6226
|
+
// http bearer authentication required
|
|
6227
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
6228
|
+
|
|
6229
|
+
|
|
6230
|
+
|
|
6231
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
6232
|
+
|
|
6233
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
6234
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
6235
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
6236
|
+
localVarRequestOptions.data = serializeDataIfNeeded(profinetIOData, localVarRequestOptions, configuration)
|
|
6237
|
+
|
|
6238
|
+
return {
|
|
6239
|
+
url: toPathString(localVarUrlObj),
|
|
6240
|
+
options: localVarRequestOptions,
|
|
6241
|
+
};
|
|
6242
|
+
},
|
|
6243
|
+
/**
|
|
6244
|
+
* Delete BUS Inputs/Outputs Service from the cell.
|
|
6245
|
+
* @summary Clear Service
|
|
6246
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
6247
|
+
* @param {number} [completionTimeout]
|
|
6248
|
+
* @param {*} [options] Override http request option.
|
|
6249
|
+
* @throws {RequiredError}
|
|
6250
|
+
*/
|
|
6251
|
+
clearBusIOService: async (cell: string, completionTimeout?: number, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
6252
|
+
// verify required parameter 'cell' is not null or undefined
|
|
6253
|
+
assertParamExists('clearBusIOService', 'cell', cell)
|
|
6254
|
+
const localVarPath = `/cells/{cell}/bus-ios`
|
|
6255
|
+
.replace(`{${"cell"}}`, encodeURIComponent(String(cell)));
|
|
6256
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
6257
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
6258
|
+
let baseOptions;
|
|
6259
|
+
if (configuration) {
|
|
6260
|
+
baseOptions = configuration.baseOptions;
|
|
6261
|
+
}
|
|
6262
|
+
|
|
6263
|
+
const localVarRequestOptions = { method: 'DELETE', ...baseOptions, ...options};
|
|
6264
|
+
const localVarHeaderParameter = {} as any;
|
|
6265
|
+
const localVarQueryParameter = {} as any;
|
|
6266
|
+
|
|
6267
|
+
// authentication BasicAuth required
|
|
6268
|
+
// http basic authentication required
|
|
6269
|
+
setBasicAuthToObject(localVarRequestOptions, configuration)
|
|
6270
|
+
|
|
6271
|
+
// authentication BearerAuth required
|
|
6272
|
+
// http bearer authentication required
|
|
6273
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
6274
|
+
|
|
6275
|
+
if (completionTimeout !== undefined) {
|
|
6276
|
+
localVarQueryParameter['completion_timeout'] = completionTimeout;
|
|
6277
|
+
}
|
|
6278
|
+
|
|
6279
|
+
|
|
6280
|
+
|
|
6281
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
6282
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
6283
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
6284
|
+
|
|
6285
|
+
return {
|
|
6286
|
+
url: toPathString(localVarUrlObj),
|
|
6287
|
+
options: localVarRequestOptions,
|
|
6288
|
+
};
|
|
6289
|
+
},
|
|
6290
|
+
/**
|
|
6291
|
+
* Removes the input/output from the PROFINET device.
|
|
6292
|
+
* @summary Remove PROFINET Input/Ouptut
|
|
6293
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
6294
|
+
* @param {string} io Unique identifier to address an Input/Output in the cell.
|
|
6295
|
+
* @param {*} [options] Override http request option.
|
|
6296
|
+
* @throws {RequiredError}
|
|
6297
|
+
*/
|
|
6298
|
+
deleteProfinetIO: async (cell: string, io: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
6299
|
+
// verify required parameter 'cell' is not null or undefined
|
|
6300
|
+
assertParamExists('deleteProfinetIO', 'cell', cell)
|
|
6301
|
+
// verify required parameter 'io' is not null or undefined
|
|
6302
|
+
assertParamExists('deleteProfinetIO', 'io', io)
|
|
6303
|
+
const localVarPath = `/cells/{cell}/bus-ios/profinet/ios/{io}`
|
|
6304
|
+
.replace(`{${"cell"}}`, encodeURIComponent(String(cell)))
|
|
6305
|
+
.replace(`{${"io"}}`, encodeURIComponent(String(io)));
|
|
6306
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
6307
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
6308
|
+
let baseOptions;
|
|
6309
|
+
if (configuration) {
|
|
6310
|
+
baseOptions = configuration.baseOptions;
|
|
6311
|
+
}
|
|
6312
|
+
|
|
6313
|
+
const localVarRequestOptions = { method: 'DELETE', ...baseOptions, ...options};
|
|
6314
|
+
const localVarHeaderParameter = {} as any;
|
|
6315
|
+
const localVarQueryParameter = {} as any;
|
|
6316
|
+
|
|
6317
|
+
// authentication BasicAuth required
|
|
6318
|
+
// http basic authentication required
|
|
6319
|
+
setBasicAuthToObject(localVarRequestOptions, configuration)
|
|
6320
|
+
|
|
6321
|
+
// authentication BearerAuth required
|
|
6322
|
+
// http bearer authentication required
|
|
6323
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
6324
|
+
|
|
6325
|
+
|
|
6326
|
+
|
|
6327
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
6328
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
6329
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
6330
|
+
|
|
6331
|
+
return {
|
|
6332
|
+
url: toPathString(localVarUrlObj),
|
|
6333
|
+
options: localVarRequestOptions,
|
|
6334
|
+
};
|
|
6335
|
+
},
|
|
6336
|
+
/**
|
|
6337
|
+
* Get deployed BUS Inputs/Outputs Service.
|
|
6338
|
+
* @summary Get Service
|
|
6339
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
6340
|
+
* @param {*} [options] Override http request option.
|
|
6341
|
+
* @throws {RequiredError}
|
|
6342
|
+
*/
|
|
6343
|
+
getBusIOService: async (cell: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
6344
|
+
// verify required parameter 'cell' is not null or undefined
|
|
6345
|
+
assertParamExists('getBusIOService', 'cell', cell)
|
|
6346
|
+
const localVarPath = `/cells/{cell}/bus-ios`
|
|
6347
|
+
.replace(`{${"cell"}}`, encodeURIComponent(String(cell)));
|
|
6348
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
6349
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
6350
|
+
let baseOptions;
|
|
6351
|
+
if (configuration) {
|
|
6352
|
+
baseOptions = configuration.baseOptions;
|
|
6353
|
+
}
|
|
6354
|
+
|
|
6355
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
6356
|
+
const localVarHeaderParameter = {} as any;
|
|
6357
|
+
const localVarQueryParameter = {} as any;
|
|
6358
|
+
|
|
6359
|
+
// authentication BasicAuth required
|
|
6360
|
+
// http basic authentication required
|
|
6361
|
+
setBasicAuthToObject(localVarRequestOptions, configuration)
|
|
6362
|
+
|
|
6363
|
+
// authentication BearerAuth required
|
|
6364
|
+
// http bearer authentication required
|
|
6365
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
6366
|
+
|
|
6367
|
+
|
|
6368
|
+
|
|
6369
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
6370
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
6371
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
6372
|
+
|
|
6373
|
+
return {
|
|
6374
|
+
url: toPathString(localVarUrlObj),
|
|
6375
|
+
options: localVarRequestOptions,
|
|
6376
|
+
};
|
|
6377
|
+
},
|
|
6378
|
+
/**
|
|
6379
|
+
* Get the current state of the BUS Inputs/Outputs service.
|
|
6380
|
+
* @summary State
|
|
6381
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
6382
|
+
* @param {*} [options] Override http request option.
|
|
6383
|
+
* @throws {RequiredError}
|
|
6384
|
+
*/
|
|
6385
|
+
getBusIOState: async (cell: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
6386
|
+
// verify required parameter 'cell' is not null or undefined
|
|
6387
|
+
assertParamExists('getBusIOState', 'cell', cell)
|
|
6388
|
+
const localVarPath = `/cells/{cell}/bus-ios/state`
|
|
6389
|
+
.replace(`{${"cell"}}`, encodeURIComponent(String(cell)));
|
|
6390
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
6391
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
6392
|
+
let baseOptions;
|
|
6393
|
+
if (configuration) {
|
|
6394
|
+
baseOptions = configuration.baseOptions;
|
|
6395
|
+
}
|
|
6396
|
+
|
|
6397
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
6398
|
+
const localVarHeaderParameter = {} as any;
|
|
6399
|
+
const localVarQueryParameter = {} as any;
|
|
6400
|
+
|
|
6401
|
+
// authentication BasicAuth required
|
|
6402
|
+
// http basic authentication required
|
|
6403
|
+
setBasicAuthToObject(localVarRequestOptions, configuration)
|
|
6404
|
+
|
|
6405
|
+
// authentication BearerAuth required
|
|
6406
|
+
// http bearer authentication required
|
|
6407
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
6408
|
+
|
|
6409
|
+
|
|
6410
|
+
|
|
6411
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
6412
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
6413
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
6414
|
+
|
|
6415
|
+
return {
|
|
6416
|
+
url: toPathString(localVarUrlObj),
|
|
6417
|
+
options: localVarRequestOptions,
|
|
6418
|
+
};
|
|
6419
|
+
},
|
|
6420
|
+
/**
|
|
6421
|
+
* 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).
|
|
6422
|
+
* @summary Get Input/Output Values
|
|
6423
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
6424
|
+
* @param {Array<string>} [ios]
|
|
6425
|
+
* @param {*} [options] Override http request option.
|
|
6426
|
+
* @throws {RequiredError}
|
|
6427
|
+
*/
|
|
6428
|
+
getBusIOValues: async (cell: string, ios?: Array<string>, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
6429
|
+
// verify required parameter 'cell' is not null or undefined
|
|
6430
|
+
assertParamExists('getBusIOValues', 'cell', cell)
|
|
6431
|
+
const localVarPath = `/cells/{cell}/bus-ios/ios/values`
|
|
6432
|
+
.replace(`{${"cell"}}`, encodeURIComponent(String(cell)));
|
|
6433
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
6434
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
6435
|
+
let baseOptions;
|
|
6436
|
+
if (configuration) {
|
|
6437
|
+
baseOptions = configuration.baseOptions;
|
|
6438
|
+
}
|
|
6439
|
+
|
|
6440
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
6441
|
+
const localVarHeaderParameter = {} as any;
|
|
6442
|
+
const localVarQueryParameter = {} as any;
|
|
6443
|
+
|
|
6444
|
+
// authentication BasicAuth required
|
|
6445
|
+
// http basic authentication required
|
|
6446
|
+
setBasicAuthToObject(localVarRequestOptions, configuration)
|
|
6447
|
+
|
|
6448
|
+
// authentication BearerAuth required
|
|
6449
|
+
// http bearer authentication required
|
|
6450
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
6451
|
+
|
|
6452
|
+
if (ios) {
|
|
6453
|
+
localVarQueryParameter['ios'] = ios;
|
|
6454
|
+
}
|
|
6455
|
+
|
|
6456
|
+
|
|
6457
|
+
|
|
6458
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
6459
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
6460
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
6461
|
+
|
|
6462
|
+
return {
|
|
6463
|
+
url: toPathString(localVarUrlObj),
|
|
6464
|
+
options: localVarRequestOptions,
|
|
6465
|
+
};
|
|
6466
|
+
},
|
|
6467
|
+
/**
|
|
6468
|
+
* Get description of PROFINET
|
|
6469
|
+
* @summary Get PROFINET Description
|
|
6470
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
6471
|
+
* @param {*} [options] Override http request option.
|
|
6472
|
+
* @throws {RequiredError}
|
|
6473
|
+
*/
|
|
6474
|
+
getProfinetDescription: async (cell: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
6475
|
+
// verify required parameter 'cell' is not null or undefined
|
|
6476
|
+
assertParamExists('getProfinetDescription', 'cell', cell)
|
|
6477
|
+
const localVarPath = `/cells/{cell}/bus-ios/profinet/description`
|
|
6478
|
+
.replace(`{${"cell"}}`, encodeURIComponent(String(cell)));
|
|
6479
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
6480
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
6481
|
+
let baseOptions;
|
|
6482
|
+
if (configuration) {
|
|
6483
|
+
baseOptions = configuration.baseOptions;
|
|
6484
|
+
}
|
|
6485
|
+
|
|
6486
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
6487
|
+
const localVarHeaderParameter = {} as any;
|
|
6488
|
+
const localVarQueryParameter = {} as any;
|
|
6489
|
+
|
|
6490
|
+
// authentication BasicAuth required
|
|
6491
|
+
// http basic authentication required
|
|
6492
|
+
setBasicAuthToObject(localVarRequestOptions, configuration)
|
|
6493
|
+
|
|
6494
|
+
// authentication BearerAuth required
|
|
6495
|
+
// http bearer authentication required
|
|
6496
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
6497
|
+
|
|
6498
|
+
|
|
6499
|
+
|
|
6500
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
6501
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
6502
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
6503
|
+
|
|
6504
|
+
return {
|
|
6505
|
+
url: toPathString(localVarUrlObj),
|
|
6506
|
+
options: localVarRequestOptions,
|
|
6507
|
+
};
|
|
6508
|
+
},
|
|
6509
|
+
/**
|
|
6510
|
+
* Get input/output configuration of the PROFINET device as file.
|
|
6511
|
+
* @summary PROFINET Inputs/Outputs to File
|
|
6512
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
6513
|
+
* @param {number} [inputOffset]
|
|
6514
|
+
* @param {number} [outputOffset]
|
|
6515
|
+
* @param {*} [options] Override http request option.
|
|
6516
|
+
* @throws {RequiredError}
|
|
6517
|
+
*/
|
|
6518
|
+
getProfinetIOsFromFile: async (cell: string, inputOffset?: number, outputOffset?: number, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
6519
|
+
// verify required parameter 'cell' is not null or undefined
|
|
6520
|
+
assertParamExists('getProfinetIOsFromFile', 'cell', cell)
|
|
6521
|
+
const localVarPath = `/cells/{cell}/bus-ios/profinet/iofile`
|
|
6522
|
+
.replace(`{${"cell"}}`, encodeURIComponent(String(cell)));
|
|
6523
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
6524
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
6525
|
+
let baseOptions;
|
|
6526
|
+
if (configuration) {
|
|
6527
|
+
baseOptions = configuration.baseOptions;
|
|
6528
|
+
}
|
|
6529
|
+
|
|
6530
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
6531
|
+
const localVarHeaderParameter = {} as any;
|
|
6532
|
+
const localVarQueryParameter = {} as any;
|
|
6533
|
+
|
|
6534
|
+
// authentication BasicAuth required
|
|
6535
|
+
// http basic authentication required
|
|
6536
|
+
setBasicAuthToObject(localVarRequestOptions, configuration)
|
|
6537
|
+
|
|
6538
|
+
// authentication BearerAuth required
|
|
6539
|
+
// http bearer authentication required
|
|
6540
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
6541
|
+
|
|
6542
|
+
if (inputOffset !== undefined) {
|
|
6543
|
+
localVarQueryParameter['input_offset'] = inputOffset;
|
|
6544
|
+
}
|
|
6545
|
+
|
|
6546
|
+
if (outputOffset !== undefined) {
|
|
6547
|
+
localVarQueryParameter['output_offset'] = outputOffset;
|
|
6548
|
+
}
|
|
6549
|
+
|
|
6550
|
+
|
|
6551
|
+
|
|
6552
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
6553
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
6554
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
6555
|
+
|
|
6556
|
+
return {
|
|
6557
|
+
url: toPathString(localVarUrlObj),
|
|
6558
|
+
options: localVarRequestOptions,
|
|
6559
|
+
};
|
|
6560
|
+
},
|
|
6561
|
+
/**
|
|
6562
|
+
* List all BUS Input/Output descriptions.
|
|
6563
|
+
* @summary List Descriptions
|
|
6564
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
6565
|
+
* @param {*} [options] Override http request option.
|
|
6566
|
+
* @throws {RequiredError}
|
|
6567
|
+
*/
|
|
6568
|
+
listBusIODescriptions: async (cell: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
6569
|
+
// verify required parameter 'cell' is not null or undefined
|
|
6570
|
+
assertParamExists('listBusIODescriptions', 'cell', cell)
|
|
6571
|
+
const localVarPath = `/cells/{cell}/bus-ios/ios/description`
|
|
6572
|
+
.replace(`{${"cell"}}`, encodeURIComponent(String(cell)));
|
|
6573
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
6574
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
6575
|
+
let baseOptions;
|
|
6576
|
+
if (configuration) {
|
|
6577
|
+
baseOptions = configuration.baseOptions;
|
|
6578
|
+
}
|
|
6579
|
+
|
|
6580
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
6581
|
+
const localVarHeaderParameter = {} as any;
|
|
6582
|
+
const localVarQueryParameter = {} as any;
|
|
6583
|
+
|
|
6584
|
+
// authentication BasicAuth required
|
|
6585
|
+
// http basic authentication required
|
|
6586
|
+
setBasicAuthToObject(localVarRequestOptions, configuration)
|
|
6587
|
+
|
|
6588
|
+
// authentication BearerAuth required
|
|
6589
|
+
// http bearer authentication required
|
|
6590
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
6591
|
+
|
|
6592
|
+
|
|
6593
|
+
|
|
6594
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
6595
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
6596
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
6597
|
+
|
|
6598
|
+
return {
|
|
6599
|
+
url: toPathString(localVarUrlObj),
|
|
6600
|
+
options: localVarRequestOptions,
|
|
6601
|
+
};
|
|
6602
|
+
},
|
|
6603
|
+
/**
|
|
6604
|
+
* List all PROFINET input and outputs.
|
|
6605
|
+
* @summary List PROFINET Input/Output Configuration
|
|
6606
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
6607
|
+
* @param {*} [options] Override http request option.
|
|
6608
|
+
* @throws {RequiredError}
|
|
6609
|
+
*/
|
|
6610
|
+
listProfinetIOs: async (cell: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
6611
|
+
// verify required parameter 'cell' is not null or undefined
|
|
6612
|
+
assertParamExists('listProfinetIOs', 'cell', cell)
|
|
6613
|
+
const localVarPath = `/cells/{cell}/bus-ios/profinet/ios`
|
|
6614
|
+
.replace(`{${"cell"}}`, encodeURIComponent(String(cell)));
|
|
6615
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
6616
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
6617
|
+
let baseOptions;
|
|
6618
|
+
if (configuration) {
|
|
6619
|
+
baseOptions = configuration.baseOptions;
|
|
6620
|
+
}
|
|
6621
|
+
|
|
6622
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
6623
|
+
const localVarHeaderParameter = {} as any;
|
|
6624
|
+
const localVarQueryParameter = {} as any;
|
|
6625
|
+
|
|
6626
|
+
// authentication BasicAuth required
|
|
6627
|
+
// http basic authentication required
|
|
6628
|
+
setBasicAuthToObject(localVarRequestOptions, configuration)
|
|
6629
|
+
|
|
6630
|
+
// authentication BearerAuth required
|
|
6631
|
+
// http bearer authentication required
|
|
6632
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
6633
|
+
|
|
6634
|
+
|
|
6635
|
+
|
|
6636
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
6637
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
6638
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
6639
|
+
|
|
6640
|
+
return {
|
|
6641
|
+
url: toPathString(localVarUrlObj),
|
|
6642
|
+
options: localVarRequestOptions,
|
|
6643
|
+
};
|
|
6644
|
+
},
|
|
6645
|
+
/**
|
|
6646
|
+
* 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.
|
|
6647
|
+
* @summary Set Output Values
|
|
6648
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
6649
|
+
* @param {Array<IOValue>} iOValue
|
|
6650
|
+
* @param {*} [options] Override http request option.
|
|
6651
|
+
* @throws {RequiredError}
|
|
6652
|
+
*/
|
|
6653
|
+
setBusIOValues: async (cell: string, iOValue: Array<IOValue>, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
6654
|
+
// verify required parameter 'cell' is not null or undefined
|
|
6655
|
+
assertParamExists('setBusIOValues', 'cell', cell)
|
|
6656
|
+
// verify required parameter 'iOValue' is not null or undefined
|
|
6657
|
+
assertParamExists('setBusIOValues', 'iOValue', iOValue)
|
|
6658
|
+
const localVarPath = `/cells/{cell}/bus-ios/ios/values`
|
|
6659
|
+
.replace(`{${"cell"}}`, encodeURIComponent(String(cell)));
|
|
6660
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
6661
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
6662
|
+
let baseOptions;
|
|
6663
|
+
if (configuration) {
|
|
6664
|
+
baseOptions = configuration.baseOptions;
|
|
6665
|
+
}
|
|
6666
|
+
|
|
6667
|
+
const localVarRequestOptions = { method: 'PUT', ...baseOptions, ...options};
|
|
6668
|
+
const localVarHeaderParameter = {} as any;
|
|
6669
|
+
const localVarQueryParameter = {} as any;
|
|
6670
|
+
|
|
6671
|
+
// authentication BasicAuth required
|
|
6672
|
+
// http basic authentication required
|
|
6673
|
+
setBasicAuthToObject(localVarRequestOptions, configuration)
|
|
6674
|
+
|
|
6675
|
+
// authentication BearerAuth required
|
|
6676
|
+
// http bearer authentication required
|
|
6677
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
6678
|
+
|
|
6679
|
+
|
|
6680
|
+
|
|
6681
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
6682
|
+
|
|
6683
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
6684
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
6685
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
6686
|
+
localVarRequestOptions.data = serializeDataIfNeeded(iOValue, localVarRequestOptions, configuration)
|
|
6687
|
+
|
|
6688
|
+
return {
|
|
6689
|
+
url: toPathString(localVarUrlObj),
|
|
6690
|
+
options: localVarRequestOptions,
|
|
6691
|
+
};
|
|
6692
|
+
},
|
|
6693
|
+
/**
|
|
6694
|
+
* Sets inputs/outputs on the PROFINET device from file.
|
|
6695
|
+
* @summary Set PROFINET Inputs/Outputs from File
|
|
6696
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
6697
|
+
* @param {ProfinetInputOutputConfig} profinetInputOutputConfig
|
|
6698
|
+
* @param {*} [options] Override http request option.
|
|
6699
|
+
* @throws {RequiredError}
|
|
6700
|
+
*/
|
|
6701
|
+
setProfinetIOsFromFile: async (cell: string, profinetInputOutputConfig: ProfinetInputOutputConfig, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
6702
|
+
// verify required parameter 'cell' is not null or undefined
|
|
6703
|
+
assertParamExists('setProfinetIOsFromFile', 'cell', cell)
|
|
6704
|
+
// verify required parameter 'profinetInputOutputConfig' is not null or undefined
|
|
6705
|
+
assertParamExists('setProfinetIOsFromFile', 'profinetInputOutputConfig', profinetInputOutputConfig)
|
|
6706
|
+
const localVarPath = `/cells/{cell}/bus-ios/profinet/iofile`
|
|
6707
|
+
.replace(`{${"cell"}}`, encodeURIComponent(String(cell)));
|
|
6708
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
6709
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
6710
|
+
let baseOptions;
|
|
6711
|
+
if (configuration) {
|
|
6712
|
+
baseOptions = configuration.baseOptions;
|
|
6713
|
+
}
|
|
6714
|
+
|
|
6715
|
+
const localVarRequestOptions = { method: 'PUT', ...baseOptions, ...options};
|
|
6716
|
+
const localVarHeaderParameter = {} as any;
|
|
6717
|
+
const localVarQueryParameter = {} as any;
|
|
6718
|
+
|
|
6719
|
+
// authentication BasicAuth required
|
|
6720
|
+
// http basic authentication required
|
|
6721
|
+
setBasicAuthToObject(localVarRequestOptions, configuration)
|
|
6722
|
+
|
|
6723
|
+
// authentication BearerAuth required
|
|
6724
|
+
// http bearer authentication required
|
|
6725
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
6726
|
+
|
|
6727
|
+
|
|
6728
|
+
|
|
6729
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
6730
|
+
|
|
6731
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
6732
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
6733
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
6734
|
+
localVarRequestOptions.data = serializeDataIfNeeded(profinetInputOutputConfig, localVarRequestOptions, configuration)
|
|
6735
|
+
|
|
6736
|
+
return {
|
|
6737
|
+
url: toPathString(localVarUrlObj),
|
|
6738
|
+
options: localVarRequestOptions,
|
|
6739
|
+
};
|
|
6740
|
+
},
|
|
6741
|
+
}
|
|
6742
|
+
};
|
|
6743
|
+
|
|
6744
|
+
/**
|
|
6745
|
+
* BUSInputsOutputsApi - functional programming interface
|
|
6746
|
+
* @export
|
|
6747
|
+
*/
|
|
6748
|
+
export const BUSInputsOutputsApiFp = function(configuration?: Configuration) {
|
|
6749
|
+
const localVarAxiosParamCreator = BUSInputsOutputsApiAxiosParamCreator(configuration)
|
|
6750
|
+
return {
|
|
6751
|
+
/**
|
|
6752
|
+
* Add a BUS Inputs/Outputs Service to the cell.
|
|
6753
|
+
* @summary Add Service
|
|
6754
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
6755
|
+
* @param {BusIOType} busIOType
|
|
6756
|
+
* @param {number} [completionTimeout]
|
|
6757
|
+
* @param {*} [options] Override http request option.
|
|
6758
|
+
* @throws {RequiredError}
|
|
6759
|
+
*/
|
|
6760
|
+
async addBusIOService(cell: string, busIOType: BusIOType, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> {
|
|
6761
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.addBusIOService(cell, busIOType, completionTimeout, options);
|
|
6762
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
6763
|
+
const localVarOperationServerBasePath = operationServerMap['BUSInputsOutputsApi.addBusIOService']?.[localVarOperationServerIndex]?.url;
|
|
6764
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
6765
|
+
},
|
|
6766
|
+
/**
|
|
6767
|
+
* Adds an input/output to or updates an input/output on the PROFINET device.
|
|
6768
|
+
* @summary Add PROFINET Input/Output
|
|
6769
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
6770
|
+
* @param {string} io Unique identifier to address an Input/Output in the cell.
|
|
6771
|
+
* @param {ProfinetIOData} profinetIOData
|
|
6772
|
+
* @param {*} [options] Override http request option.
|
|
6773
|
+
* @throws {RequiredError}
|
|
6774
|
+
*/
|
|
6775
|
+
async addProfinetIO(cell: string, io: string, profinetIOData: ProfinetIOData, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> {
|
|
6776
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.addProfinetIO(cell, io, profinetIOData, options);
|
|
6777
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
6778
|
+
const localVarOperationServerBasePath = operationServerMap['BUSInputsOutputsApi.addProfinetIO']?.[localVarOperationServerIndex]?.url;
|
|
6779
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
6780
|
+
},
|
|
6781
|
+
/**
|
|
6782
|
+
* Delete BUS Inputs/Outputs Service from the cell.
|
|
6783
|
+
* @summary Clear Service
|
|
6784
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
6785
|
+
* @param {number} [completionTimeout]
|
|
6786
|
+
* @param {*} [options] Override http request option.
|
|
6787
|
+
* @throws {RequiredError}
|
|
6788
|
+
*/
|
|
6789
|
+
async clearBusIOService(cell: string, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> {
|
|
6790
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.clearBusIOService(cell, completionTimeout, options);
|
|
6791
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
6792
|
+
const localVarOperationServerBasePath = operationServerMap['BUSInputsOutputsApi.clearBusIOService']?.[localVarOperationServerIndex]?.url;
|
|
6793
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
6794
|
+
},
|
|
6795
|
+
/**
|
|
6796
|
+
* Removes the input/output from the PROFINET device.
|
|
6797
|
+
* @summary Remove PROFINET Input/Ouptut
|
|
6798
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
6799
|
+
* @param {string} io Unique identifier to address an Input/Output in the cell.
|
|
6800
|
+
* @param {*} [options] Override http request option.
|
|
6801
|
+
* @throws {RequiredError}
|
|
6802
|
+
*/
|
|
6803
|
+
async deleteProfinetIO(cell: string, io: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> {
|
|
6804
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.deleteProfinetIO(cell, io, options);
|
|
6805
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
6806
|
+
const localVarOperationServerBasePath = operationServerMap['BUSInputsOutputsApi.deleteProfinetIO']?.[localVarOperationServerIndex]?.url;
|
|
6807
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
6808
|
+
},
|
|
6809
|
+
/**
|
|
6810
|
+
* Get deployed BUS Inputs/Outputs Service.
|
|
6811
|
+
* @summary Get Service
|
|
6812
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
6813
|
+
* @param {*} [options] Override http request option.
|
|
6814
|
+
* @throws {RequiredError}
|
|
6815
|
+
*/
|
|
6816
|
+
async getBusIOService(cell: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BusIOType>> {
|
|
6817
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.getBusIOService(cell, options);
|
|
6818
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
6819
|
+
const localVarOperationServerBasePath = operationServerMap['BUSInputsOutputsApi.getBusIOService']?.[localVarOperationServerIndex]?.url;
|
|
6820
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
6821
|
+
},
|
|
6822
|
+
/**
|
|
6823
|
+
* Get the current state of the BUS Inputs/Outputs service.
|
|
6824
|
+
* @summary State
|
|
6825
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
6826
|
+
* @param {*} [options] Override http request option.
|
|
6827
|
+
* @throws {RequiredError}
|
|
6828
|
+
*/
|
|
6829
|
+
async getBusIOState(cell: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BusIOsState>> {
|
|
6830
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.getBusIOState(cell, options);
|
|
6831
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
6832
|
+
const localVarOperationServerBasePath = operationServerMap['BUSInputsOutputsApi.getBusIOState']?.[localVarOperationServerIndex]?.url;
|
|
6833
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
6834
|
+
},
|
|
6835
|
+
/**
|
|
6836
|
+
* 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).
|
|
6837
|
+
* @summary Get Input/Output Values
|
|
6838
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
6839
|
+
* @param {Array<string>} [ios]
|
|
6840
|
+
* @param {*} [options] Override http request option.
|
|
6841
|
+
* @throws {RequiredError}
|
|
6842
|
+
*/
|
|
6843
|
+
async getBusIOValues(cell: string, ios?: Array<string>, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<IOValue>>> {
|
|
6844
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.getBusIOValues(cell, ios, options);
|
|
6845
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
6846
|
+
const localVarOperationServerBasePath = operationServerMap['BUSInputsOutputsApi.getBusIOValues']?.[localVarOperationServerIndex]?.url;
|
|
6847
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
6848
|
+
},
|
|
6849
|
+
/**
|
|
6850
|
+
* Get description of PROFINET
|
|
6851
|
+
* @summary Get PROFINET Description
|
|
6852
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
6853
|
+
* @param {*} [options] Override http request option.
|
|
6854
|
+
* @throws {RequiredError}
|
|
6855
|
+
*/
|
|
6856
|
+
async getProfinetDescription(cell: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ProfinetDescription>> {
|
|
6857
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.getProfinetDescription(cell, options);
|
|
6858
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
6859
|
+
const localVarOperationServerBasePath = operationServerMap['BUSInputsOutputsApi.getProfinetDescription']?.[localVarOperationServerIndex]?.url;
|
|
6860
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
6861
|
+
},
|
|
6862
|
+
/**
|
|
6863
|
+
* Get input/output configuration of the PROFINET device as file.
|
|
6864
|
+
* @summary PROFINET Inputs/Outputs to File
|
|
6865
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
6866
|
+
* @param {number} [inputOffset]
|
|
6867
|
+
* @param {number} [outputOffset]
|
|
6868
|
+
* @param {*} [options] Override http request option.
|
|
6869
|
+
* @throws {RequiredError}
|
|
6870
|
+
*/
|
|
6871
|
+
async getProfinetIOsFromFile(cell: string, inputOffset?: number, outputOffset?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<string>> {
|
|
6872
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.getProfinetIOsFromFile(cell, inputOffset, outputOffset, options);
|
|
6873
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
6874
|
+
const localVarOperationServerBasePath = operationServerMap['BUSInputsOutputsApi.getProfinetIOsFromFile']?.[localVarOperationServerIndex]?.url;
|
|
6875
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
6876
|
+
},
|
|
6877
|
+
/**
|
|
6878
|
+
* List all BUS Input/Output descriptions.
|
|
6879
|
+
* @summary List Descriptions
|
|
6880
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
6881
|
+
* @param {*} [options] Override http request option.
|
|
6882
|
+
* @throws {RequiredError}
|
|
6883
|
+
*/
|
|
6884
|
+
async listBusIODescriptions(cell: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<IODescription>>> {
|
|
6885
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.listBusIODescriptions(cell, options);
|
|
6886
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
6887
|
+
const localVarOperationServerBasePath = operationServerMap['BUSInputsOutputsApi.listBusIODescriptions']?.[localVarOperationServerIndex]?.url;
|
|
6888
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
6889
|
+
},
|
|
6890
|
+
/**
|
|
6891
|
+
* List all PROFINET input and outputs.
|
|
6892
|
+
* @summary List PROFINET Input/Output Configuration
|
|
6893
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
6894
|
+
* @param {*} [options] Override http request option.
|
|
6895
|
+
* @throws {RequiredError}
|
|
6896
|
+
*/
|
|
6897
|
+
async listProfinetIOs(cell: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<ProfinetIO>>> {
|
|
6898
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.listProfinetIOs(cell, options);
|
|
6899
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
6900
|
+
const localVarOperationServerBasePath = operationServerMap['BUSInputsOutputsApi.listProfinetIOs']?.[localVarOperationServerIndex]?.url;
|
|
6901
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
6902
|
+
},
|
|
6903
|
+
/**
|
|
6904
|
+
* 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.
|
|
6905
|
+
* @summary Set Output Values
|
|
6906
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
6907
|
+
* @param {Array<IOValue>} iOValue
|
|
6908
|
+
* @param {*} [options] Override http request option.
|
|
6909
|
+
* @throws {RequiredError}
|
|
6910
|
+
*/
|
|
6911
|
+
async setBusIOValues(cell: string, iOValue: Array<IOValue>, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> {
|
|
6912
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.setBusIOValues(cell, iOValue, options);
|
|
6913
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
6914
|
+
const localVarOperationServerBasePath = operationServerMap['BUSInputsOutputsApi.setBusIOValues']?.[localVarOperationServerIndex]?.url;
|
|
6915
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
6916
|
+
},
|
|
6917
|
+
/**
|
|
6918
|
+
* Sets inputs/outputs on the PROFINET device from file.
|
|
6919
|
+
* @summary Set PROFINET Inputs/Outputs from File
|
|
6920
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
6921
|
+
* @param {ProfinetInputOutputConfig} profinetInputOutputConfig
|
|
6922
|
+
* @param {*} [options] Override http request option.
|
|
6923
|
+
* @throws {RequiredError}
|
|
6924
|
+
*/
|
|
6925
|
+
async setProfinetIOsFromFile(cell: string, profinetInputOutputConfig: ProfinetInputOutputConfig, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> {
|
|
6926
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.setProfinetIOsFromFile(cell, profinetInputOutputConfig, options);
|
|
6927
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
6928
|
+
const localVarOperationServerBasePath = operationServerMap['BUSInputsOutputsApi.setProfinetIOsFromFile']?.[localVarOperationServerIndex]?.url;
|
|
6929
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
6930
|
+
},
|
|
6931
|
+
}
|
|
6932
|
+
};
|
|
6933
|
+
|
|
6934
|
+
/**
|
|
6935
|
+
* BUSInputsOutputsApi - factory interface
|
|
6936
|
+
* @export
|
|
6937
|
+
*/
|
|
6938
|
+
export const BUSInputsOutputsApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
|
|
6939
|
+
const localVarFp = BUSInputsOutputsApiFp(configuration)
|
|
6940
|
+
return {
|
|
6941
|
+
/**
|
|
6942
|
+
* Add a BUS Inputs/Outputs Service to the cell.
|
|
6943
|
+
* @summary Add Service
|
|
6944
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
6945
|
+
* @param {BusIOType} busIOType
|
|
6946
|
+
* @param {number} [completionTimeout]
|
|
6947
|
+
* @param {*} [options] Override http request option.
|
|
6948
|
+
* @throws {RequiredError}
|
|
6949
|
+
*/
|
|
6950
|
+
addBusIOService(cell: string, busIOType: BusIOType, completionTimeout?: number, options?: RawAxiosRequestConfig): AxiosPromise<void> {
|
|
6951
|
+
return localVarFp.addBusIOService(cell, busIOType, completionTimeout, options).then((request) => request(axios, basePath));
|
|
6952
|
+
},
|
|
6953
|
+
/**
|
|
6954
|
+
* Adds an input/output to or updates an input/output on the PROFINET device.
|
|
6955
|
+
* @summary Add PROFINET Input/Output
|
|
6956
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
6957
|
+
* @param {string} io Unique identifier to address an Input/Output in the cell.
|
|
6958
|
+
* @param {ProfinetIOData} profinetIOData
|
|
6959
|
+
* @param {*} [options] Override http request option.
|
|
6960
|
+
* @throws {RequiredError}
|
|
6961
|
+
*/
|
|
6962
|
+
addProfinetIO(cell: string, io: string, profinetIOData: ProfinetIOData, options?: RawAxiosRequestConfig): AxiosPromise<void> {
|
|
6963
|
+
return localVarFp.addProfinetIO(cell, io, profinetIOData, options).then((request) => request(axios, basePath));
|
|
6964
|
+
},
|
|
6965
|
+
/**
|
|
6966
|
+
* Delete BUS Inputs/Outputs Service from the cell.
|
|
6967
|
+
* @summary Clear Service
|
|
6968
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
6969
|
+
* @param {number} [completionTimeout]
|
|
6970
|
+
* @param {*} [options] Override http request option.
|
|
6971
|
+
* @throws {RequiredError}
|
|
6972
|
+
*/
|
|
6973
|
+
clearBusIOService(cell: string, completionTimeout?: number, options?: RawAxiosRequestConfig): AxiosPromise<void> {
|
|
6974
|
+
return localVarFp.clearBusIOService(cell, completionTimeout, options).then((request) => request(axios, basePath));
|
|
6975
|
+
},
|
|
6976
|
+
/**
|
|
6977
|
+
* Removes the input/output from the PROFINET device.
|
|
6978
|
+
* @summary Remove PROFINET Input/Ouptut
|
|
6979
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
6980
|
+
* @param {string} io Unique identifier to address an Input/Output in the cell.
|
|
6981
|
+
* @param {*} [options] Override http request option.
|
|
6982
|
+
* @throws {RequiredError}
|
|
6983
|
+
*/
|
|
6984
|
+
deleteProfinetIO(cell: string, io: string, options?: RawAxiosRequestConfig): AxiosPromise<void> {
|
|
6985
|
+
return localVarFp.deleteProfinetIO(cell, io, options).then((request) => request(axios, basePath));
|
|
6986
|
+
},
|
|
6987
|
+
/**
|
|
6988
|
+
* Get deployed BUS Inputs/Outputs Service.
|
|
6989
|
+
* @summary Get Service
|
|
6990
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
6991
|
+
* @param {*} [options] Override http request option.
|
|
6992
|
+
* @throws {RequiredError}
|
|
6993
|
+
*/
|
|
6994
|
+
getBusIOService(cell: string, options?: RawAxiosRequestConfig): AxiosPromise<BusIOType> {
|
|
6995
|
+
return localVarFp.getBusIOService(cell, options).then((request) => request(axios, basePath));
|
|
6996
|
+
},
|
|
6997
|
+
/**
|
|
6998
|
+
* Get the current state of the BUS Inputs/Outputs service.
|
|
6999
|
+
* @summary State
|
|
7000
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
7001
|
+
* @param {*} [options] Override http request option.
|
|
7002
|
+
* @throws {RequiredError}
|
|
7003
|
+
*/
|
|
7004
|
+
getBusIOState(cell: string, options?: RawAxiosRequestConfig): AxiosPromise<BusIOsState> {
|
|
7005
|
+
return localVarFp.getBusIOState(cell, options).then((request) => request(axios, basePath));
|
|
7006
|
+
},
|
|
7007
|
+
/**
|
|
7008
|
+
* 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).
|
|
7009
|
+
* @summary Get Input/Output Values
|
|
7010
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
7011
|
+
* @param {Array<string>} [ios]
|
|
7012
|
+
* @param {*} [options] Override http request option.
|
|
7013
|
+
* @throws {RequiredError}
|
|
7014
|
+
*/
|
|
7015
|
+
getBusIOValues(cell: string, ios?: Array<string>, options?: RawAxiosRequestConfig): AxiosPromise<Array<IOValue>> {
|
|
7016
|
+
return localVarFp.getBusIOValues(cell, ios, options).then((request) => request(axios, basePath));
|
|
7017
|
+
},
|
|
7018
|
+
/**
|
|
7019
|
+
* Get description of PROFINET
|
|
7020
|
+
* @summary Get PROFINET Description
|
|
7021
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
7022
|
+
* @param {*} [options] Override http request option.
|
|
7023
|
+
* @throws {RequiredError}
|
|
7024
|
+
*/
|
|
7025
|
+
getProfinetDescription(cell: string, options?: RawAxiosRequestConfig): AxiosPromise<ProfinetDescription> {
|
|
7026
|
+
return localVarFp.getProfinetDescription(cell, options).then((request) => request(axios, basePath));
|
|
7027
|
+
},
|
|
7028
|
+
/**
|
|
7029
|
+
* Get input/output configuration of the PROFINET device as file.
|
|
7030
|
+
* @summary PROFINET Inputs/Outputs to File
|
|
7031
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
7032
|
+
* @param {number} [inputOffset]
|
|
7033
|
+
* @param {number} [outputOffset]
|
|
7034
|
+
* @param {*} [options] Override http request option.
|
|
7035
|
+
* @throws {RequiredError}
|
|
7036
|
+
*/
|
|
7037
|
+
getProfinetIOsFromFile(cell: string, inputOffset?: number, outputOffset?: number, options?: RawAxiosRequestConfig): AxiosPromise<string> {
|
|
7038
|
+
return localVarFp.getProfinetIOsFromFile(cell, inputOffset, outputOffset, options).then((request) => request(axios, basePath));
|
|
7039
|
+
},
|
|
7040
|
+
/**
|
|
7041
|
+
* List all BUS Input/Output descriptions.
|
|
7042
|
+
* @summary List Descriptions
|
|
7043
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
7044
|
+
* @param {*} [options] Override http request option.
|
|
7045
|
+
* @throws {RequiredError}
|
|
7046
|
+
*/
|
|
7047
|
+
listBusIODescriptions(cell: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<IODescription>> {
|
|
7048
|
+
return localVarFp.listBusIODescriptions(cell, options).then((request) => request(axios, basePath));
|
|
7049
|
+
},
|
|
7050
|
+
/**
|
|
7051
|
+
* List all PROFINET input and outputs.
|
|
7052
|
+
* @summary List PROFINET Input/Output Configuration
|
|
7053
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
7054
|
+
* @param {*} [options] Override http request option.
|
|
7055
|
+
* @throws {RequiredError}
|
|
7056
|
+
*/
|
|
7057
|
+
listProfinetIOs(cell: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<ProfinetIO>> {
|
|
7058
|
+
return localVarFp.listProfinetIOs(cell, options).then((request) => request(axios, basePath));
|
|
7059
|
+
},
|
|
7060
|
+
/**
|
|
7061
|
+
* 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.
|
|
7062
|
+
* @summary Set Output Values
|
|
7063
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
7064
|
+
* @param {Array<IOValue>} iOValue
|
|
7065
|
+
* @param {*} [options] Override http request option.
|
|
7066
|
+
* @throws {RequiredError}
|
|
7067
|
+
*/
|
|
7068
|
+
setBusIOValues(cell: string, iOValue: Array<IOValue>, options?: RawAxiosRequestConfig): AxiosPromise<void> {
|
|
7069
|
+
return localVarFp.setBusIOValues(cell, iOValue, options).then((request) => request(axios, basePath));
|
|
7070
|
+
},
|
|
7071
|
+
/**
|
|
7072
|
+
* Sets inputs/outputs on the PROFINET device from file.
|
|
7073
|
+
* @summary Set PROFINET Inputs/Outputs from File
|
|
7074
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
7075
|
+
* @param {ProfinetInputOutputConfig} profinetInputOutputConfig
|
|
7076
|
+
* @param {*} [options] Override http request option.
|
|
7077
|
+
* @throws {RequiredError}
|
|
7078
|
+
*/
|
|
7079
|
+
setProfinetIOsFromFile(cell: string, profinetInputOutputConfig: ProfinetInputOutputConfig, options?: RawAxiosRequestConfig): AxiosPromise<void> {
|
|
7080
|
+
return localVarFp.setProfinetIOsFromFile(cell, profinetInputOutputConfig, options).then((request) => request(axios, basePath));
|
|
7081
|
+
},
|
|
7082
|
+
};
|
|
7083
|
+
};
|
|
7084
|
+
|
|
7085
|
+
/**
|
|
7086
|
+
* BUSInputsOutputsApi - object-oriented interface
|
|
7087
|
+
* @export
|
|
7088
|
+
* @class BUSInputsOutputsApi
|
|
7089
|
+
* @extends {BaseAPI}
|
|
7090
|
+
*/
|
|
7091
|
+
export class BUSInputsOutputsApi extends BaseAPI {
|
|
7092
|
+
/**
|
|
7093
|
+
* Add a BUS Inputs/Outputs Service to the cell.
|
|
7094
|
+
* @summary Add Service
|
|
7095
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
7096
|
+
* @param {BusIOType} busIOType
|
|
7097
|
+
* @param {number} [completionTimeout]
|
|
7098
|
+
* @param {*} [options] Override http request option.
|
|
7099
|
+
* @throws {RequiredError}
|
|
7100
|
+
* @memberof BUSInputsOutputsApi
|
|
7101
|
+
*/
|
|
7102
|
+
public addBusIOService(cell: string, busIOType: BusIOType, completionTimeout?: number, options?: RawAxiosRequestConfig) {
|
|
7103
|
+
return BUSInputsOutputsApiFp(this.configuration).addBusIOService(cell, busIOType, completionTimeout, options).then((request) => request(this.axios, this.basePath));
|
|
7104
|
+
}
|
|
7105
|
+
|
|
7106
|
+
/**
|
|
7107
|
+
* Adds an input/output to or updates an input/output on the PROFINET device.
|
|
7108
|
+
* @summary Add PROFINET Input/Output
|
|
7109
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
7110
|
+
* @param {string} io Unique identifier to address an Input/Output in the cell.
|
|
7111
|
+
* @param {ProfinetIOData} profinetIOData
|
|
7112
|
+
* @param {*} [options] Override http request option.
|
|
7113
|
+
* @throws {RequiredError}
|
|
7114
|
+
* @memberof BUSInputsOutputsApi
|
|
7115
|
+
*/
|
|
7116
|
+
public addProfinetIO(cell: string, io: string, profinetIOData: ProfinetIOData, options?: RawAxiosRequestConfig) {
|
|
7117
|
+
return BUSInputsOutputsApiFp(this.configuration).addProfinetIO(cell, io, profinetIOData, options).then((request) => request(this.axios, this.basePath));
|
|
7118
|
+
}
|
|
7119
|
+
|
|
7120
|
+
/**
|
|
7121
|
+
* Delete BUS Inputs/Outputs Service from the cell.
|
|
7122
|
+
* @summary Clear Service
|
|
7123
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
7124
|
+
* @param {number} [completionTimeout]
|
|
7125
|
+
* @param {*} [options] Override http request option.
|
|
7126
|
+
* @throws {RequiredError}
|
|
7127
|
+
* @memberof BUSInputsOutputsApi
|
|
7128
|
+
*/
|
|
7129
|
+
public clearBusIOService(cell: string, completionTimeout?: number, options?: RawAxiosRequestConfig) {
|
|
7130
|
+
return BUSInputsOutputsApiFp(this.configuration).clearBusIOService(cell, completionTimeout, options).then((request) => request(this.axios, this.basePath));
|
|
7131
|
+
}
|
|
7132
|
+
|
|
7133
|
+
/**
|
|
7134
|
+
* Removes the input/output from the PROFINET device.
|
|
7135
|
+
* @summary Remove PROFINET Input/Ouptut
|
|
7136
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
7137
|
+
* @param {string} io Unique identifier to address an Input/Output in the cell.
|
|
7138
|
+
* @param {*} [options] Override http request option.
|
|
7139
|
+
* @throws {RequiredError}
|
|
7140
|
+
* @memberof BUSInputsOutputsApi
|
|
7141
|
+
*/
|
|
7142
|
+
public deleteProfinetIO(cell: string, io: string, options?: RawAxiosRequestConfig) {
|
|
7143
|
+
return BUSInputsOutputsApiFp(this.configuration).deleteProfinetIO(cell, io, options).then((request) => request(this.axios, this.basePath));
|
|
7144
|
+
}
|
|
7145
|
+
|
|
7146
|
+
/**
|
|
7147
|
+
* Get deployed BUS Inputs/Outputs Service.
|
|
7148
|
+
* @summary Get Service
|
|
7149
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
7150
|
+
* @param {*} [options] Override http request option.
|
|
7151
|
+
* @throws {RequiredError}
|
|
7152
|
+
* @memberof BUSInputsOutputsApi
|
|
7153
|
+
*/
|
|
7154
|
+
public getBusIOService(cell: string, options?: RawAxiosRequestConfig) {
|
|
7155
|
+
return BUSInputsOutputsApiFp(this.configuration).getBusIOService(cell, options).then((request) => request(this.axios, this.basePath));
|
|
7156
|
+
}
|
|
7157
|
+
|
|
5290
7158
|
/**
|
|
5291
|
-
*
|
|
5292
|
-
* @summary
|
|
7159
|
+
* Get the current state of the BUS Inputs/Outputs service.
|
|
7160
|
+
* @summary State
|
|
5293
7161
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5294
|
-
* @param {App} app
|
|
5295
|
-
* @param {number} [completionTimeout]
|
|
5296
7162
|
* @param {*} [options] Override http request option.
|
|
5297
7163
|
* @throws {RequiredError}
|
|
5298
|
-
* @memberof
|
|
7164
|
+
* @memberof BUSInputsOutputsApi
|
|
5299
7165
|
*/
|
|
5300
|
-
public
|
|
5301
|
-
return
|
|
7166
|
+
public getBusIOState(cell: string, options?: RawAxiosRequestConfig) {
|
|
7167
|
+
return BUSInputsOutputsApiFp(this.configuration).getBusIOState(cell, options).then((request) => request(this.axios, this.basePath));
|
|
5302
7168
|
}
|
|
5303
7169
|
|
|
5304
7170
|
/**
|
|
5305
|
-
*
|
|
5306
|
-
* @summary
|
|
7171
|
+
* 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).
|
|
7172
|
+
* @summary Get Input/Output Values
|
|
5307
7173
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5308
|
-
* @param {
|
|
7174
|
+
* @param {Array<string>} [ios]
|
|
5309
7175
|
* @param {*} [options] Override http request option.
|
|
5310
7176
|
* @throws {RequiredError}
|
|
5311
|
-
* @memberof
|
|
7177
|
+
* @memberof BUSInputsOutputsApi
|
|
5312
7178
|
*/
|
|
5313
|
-
public
|
|
5314
|
-
return
|
|
7179
|
+
public getBusIOValues(cell: string, ios?: Array<string>, options?: RawAxiosRequestConfig) {
|
|
7180
|
+
return BUSInputsOutputsApiFp(this.configuration).getBusIOValues(cell, ios, options).then((request) => request(this.axios, this.basePath));
|
|
5315
7181
|
}
|
|
5316
7182
|
|
|
5317
7183
|
/**
|
|
5318
|
-
*
|
|
5319
|
-
* @summary
|
|
7184
|
+
* Get description of PROFINET
|
|
7185
|
+
* @summary Get PROFINET Description
|
|
5320
7186
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5321
|
-
* @param {string} app
|
|
5322
|
-
* @param {number} [completionTimeout]
|
|
5323
7187
|
* @param {*} [options] Override http request option.
|
|
5324
7188
|
* @throws {RequiredError}
|
|
5325
|
-
* @memberof
|
|
7189
|
+
* @memberof BUSInputsOutputsApi
|
|
5326
7190
|
*/
|
|
5327
|
-
public
|
|
5328
|
-
return
|
|
7191
|
+
public getProfinetDescription(cell: string, options?: RawAxiosRequestConfig) {
|
|
7192
|
+
return BUSInputsOutputsApiFp(this.configuration).getProfinetDescription(cell, options).then((request) => request(this.axios, this.basePath));
|
|
5329
7193
|
}
|
|
5330
7194
|
|
|
5331
7195
|
/**
|
|
5332
|
-
* Get
|
|
5333
|
-
* @summary
|
|
7196
|
+
* Get input/output configuration of the PROFINET device as file.
|
|
7197
|
+
* @summary PROFINET Inputs/Outputs to File
|
|
5334
7198
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5335
|
-
* @param {
|
|
7199
|
+
* @param {number} [inputOffset]
|
|
7200
|
+
* @param {number} [outputOffset]
|
|
5336
7201
|
* @param {*} [options] Override http request option.
|
|
5337
7202
|
* @throws {RequiredError}
|
|
5338
|
-
* @memberof
|
|
7203
|
+
* @memberof BUSInputsOutputsApi
|
|
5339
7204
|
*/
|
|
5340
|
-
public
|
|
5341
|
-
return
|
|
7205
|
+
public getProfinetIOsFromFile(cell: string, inputOffset?: number, outputOffset?: number, options?: RawAxiosRequestConfig) {
|
|
7206
|
+
return BUSInputsOutputsApiFp(this.configuration).getProfinetIOsFromFile(cell, inputOffset, outputOffset, options).then((request) => request(this.axios, this.basePath));
|
|
5342
7207
|
}
|
|
5343
7208
|
|
|
5344
7209
|
/**
|
|
5345
|
-
* List all
|
|
5346
|
-
* @summary List
|
|
7210
|
+
* List all BUS Input/Output descriptions.
|
|
7211
|
+
* @summary List Descriptions
|
|
5347
7212
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5348
7213
|
* @param {*} [options] Override http request option.
|
|
5349
7214
|
* @throws {RequiredError}
|
|
5350
|
-
* @memberof
|
|
7215
|
+
* @memberof BUSInputsOutputsApi
|
|
5351
7216
|
*/
|
|
5352
|
-
public
|
|
5353
|
-
return
|
|
7217
|
+
public listBusIODescriptions(cell: string, options?: RawAxiosRequestConfig) {
|
|
7218
|
+
return BUSInputsOutputsApiFp(this.configuration).listBusIODescriptions(cell, options).then((request) => request(this.axios, this.basePath));
|
|
5354
7219
|
}
|
|
5355
7220
|
|
|
5356
7221
|
/**
|
|
5357
|
-
*
|
|
5358
|
-
* @summary
|
|
7222
|
+
* List all PROFINET input and outputs.
|
|
7223
|
+
* @summary List PROFINET Input/Output Configuration
|
|
5359
7224
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5360
|
-
* @param {string} app
|
|
5361
|
-
* @param {App} app2
|
|
5362
|
-
* @param {number} [completionTimeout]
|
|
5363
7225
|
* @param {*} [options] Override http request option.
|
|
5364
7226
|
* @throws {RequiredError}
|
|
5365
|
-
* @memberof
|
|
7227
|
+
* @memberof BUSInputsOutputsApi
|
|
5366
7228
|
*/
|
|
5367
|
-
public
|
|
5368
|
-
return
|
|
7229
|
+
public listProfinetIOs(cell: string, options?: RawAxiosRequestConfig) {
|
|
7230
|
+
return BUSInputsOutputsApiFp(this.configuration).listProfinetIOs(cell, options).then((request) => request(this.axios, this.basePath));
|
|
7231
|
+
}
|
|
7232
|
+
|
|
7233
|
+
/**
|
|
7234
|
+
* 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.
|
|
7235
|
+
* @summary Set Output Values
|
|
7236
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
7237
|
+
* @param {Array<IOValue>} iOValue
|
|
7238
|
+
* @param {*} [options] Override http request option.
|
|
7239
|
+
* @throws {RequiredError}
|
|
7240
|
+
* @memberof BUSInputsOutputsApi
|
|
7241
|
+
*/
|
|
7242
|
+
public setBusIOValues(cell: string, iOValue: Array<IOValue>, options?: RawAxiosRequestConfig) {
|
|
7243
|
+
return BUSInputsOutputsApiFp(this.configuration).setBusIOValues(cell, iOValue, options).then((request) => request(this.axios, this.basePath));
|
|
7244
|
+
}
|
|
7245
|
+
|
|
7246
|
+
/**
|
|
7247
|
+
* Sets inputs/outputs on the PROFINET device from file.
|
|
7248
|
+
* @summary Set PROFINET Inputs/Outputs from File
|
|
7249
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
7250
|
+
* @param {ProfinetInputOutputConfig} profinetInputOutputConfig
|
|
7251
|
+
* @param {*} [options] Override http request option.
|
|
7252
|
+
* @throws {RequiredError}
|
|
7253
|
+
* @memberof BUSInputsOutputsApi
|
|
7254
|
+
*/
|
|
7255
|
+
public setProfinetIOsFromFile(cell: string, profinetInputOutputConfig: ProfinetInputOutputConfig, options?: RawAxiosRequestConfig) {
|
|
7256
|
+
return BUSInputsOutputsApiFp(this.configuration).setProfinetIOsFromFile(cell, profinetInputOutputConfig, options).then((request) => request(this.axios, this.basePath));
|
|
5369
7257
|
}
|
|
5370
7258
|
}
|
|
5371
7259
|
|
|
@@ -6282,52 +8170,6 @@ export const ControllerApiAxiosParamCreator = function (configuration?: Configur
|
|
|
6282
8170
|
|
|
6283
8171
|
|
|
6284
8172
|
|
|
6285
|
-
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
6286
|
-
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
6287
|
-
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
6288
|
-
|
|
6289
|
-
return {
|
|
6290
|
-
url: toPathString(localVarUrlObj),
|
|
6291
|
-
options: localVarRequestOptions,
|
|
6292
|
-
};
|
|
6293
|
-
},
|
|
6294
|
-
/**
|
|
6295
|
-
* 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).
|
|
6296
|
-
* @summary Current Mode
|
|
6297
|
-
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
6298
|
-
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
6299
|
-
* @param {*} [options] Override http request option.
|
|
6300
|
-
* @throws {RequiredError}
|
|
6301
|
-
*/
|
|
6302
|
-
getMode: async (cell: string, controller: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
6303
|
-
// verify required parameter 'cell' is not null or undefined
|
|
6304
|
-
assertParamExists('getMode', 'cell', cell)
|
|
6305
|
-
// verify required parameter 'controller' is not null or undefined
|
|
6306
|
-
assertParamExists('getMode', 'controller', controller)
|
|
6307
|
-
const localVarPath = `/cells/{cell}/controllers/{controller}/mode`
|
|
6308
|
-
.replace(`{${"cell"}}`, encodeURIComponent(String(cell)))
|
|
6309
|
-
.replace(`{${"controller"}}`, encodeURIComponent(String(controller)));
|
|
6310
|
-
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
6311
|
-
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
6312
|
-
let baseOptions;
|
|
6313
|
-
if (configuration) {
|
|
6314
|
-
baseOptions = configuration.baseOptions;
|
|
6315
|
-
}
|
|
6316
|
-
|
|
6317
|
-
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
6318
|
-
const localVarHeaderParameter = {} as any;
|
|
6319
|
-
const localVarQueryParameter = {} as any;
|
|
6320
|
-
|
|
6321
|
-
// authentication BasicAuth required
|
|
6322
|
-
// http basic authentication required
|
|
6323
|
-
setBasicAuthToObject(localVarRequestOptions, configuration)
|
|
6324
|
-
|
|
6325
|
-
// authentication BearerAuth required
|
|
6326
|
-
// http bearer authentication required
|
|
6327
|
-
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
6328
|
-
|
|
6329
|
-
|
|
6330
|
-
|
|
6331
8173
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
6332
8174
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
6333
8175
|
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
@@ -6627,15 +8469,16 @@ export const ControllerApiAxiosParamCreator = function (configuration?: Configur
|
|
|
6627
8469
|
};
|
|
6628
8470
|
},
|
|
6629
8471
|
/**
|
|
6630
|
-
* <!-- theme: danger --> > Websocket endpoint Receive updates of the state of a robot controller.
|
|
8472
|
+
* <!-- 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.
|
|
6631
8473
|
* @summary Stream State
|
|
6632
8474
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
6633
8475
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
6634
8476
|
* @param {number} [responseRate]
|
|
8477
|
+
* @param {number} [addControllerTimeout]
|
|
6635
8478
|
* @param {*} [options] Override http request option.
|
|
6636
8479
|
* @throws {RequiredError}
|
|
6637
8480
|
*/
|
|
6638
|
-
streamRobotControllerState: async (cell: string, controller: string, responseRate?: number, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
8481
|
+
streamRobotControllerState: async (cell: string, controller: string, responseRate?: number, addControllerTimeout?: number, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
6639
8482
|
// verify required parameter 'cell' is not null or undefined
|
|
6640
8483
|
assertParamExists('streamRobotControllerState', 'cell', cell)
|
|
6641
8484
|
// verify required parameter 'controller' is not null or undefined
|
|
@@ -6666,6 +8509,10 @@ export const ControllerApiAxiosParamCreator = function (configuration?: Configur
|
|
|
6666
8509
|
localVarQueryParameter['response_rate'] = responseRate;
|
|
6667
8510
|
}
|
|
6668
8511
|
|
|
8512
|
+
if (addControllerTimeout !== undefined) {
|
|
8513
|
+
localVarQueryParameter['add_controller_timeout'] = addControllerTimeout;
|
|
8514
|
+
}
|
|
8515
|
+
|
|
6669
8516
|
|
|
6670
8517
|
|
|
6671
8518
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
@@ -6832,20 +8679,6 @@ export const ControllerApiFp = function(configuration?: Configuration) {
|
|
|
6832
8679
|
const localVarOperationServerBasePath = operationServerMap['ControllerApi.getCurrentRobotControllerState']?.[localVarOperationServerIndex]?.url;
|
|
6833
8680
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
6834
8681
|
},
|
|
6835
|
-
/**
|
|
6836
|
-
* 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).
|
|
6837
|
-
* @summary Current Mode
|
|
6838
|
-
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
6839
|
-
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
6840
|
-
* @param {*} [options] Override http request option.
|
|
6841
|
-
* @throws {RequiredError}
|
|
6842
|
-
*/
|
|
6843
|
-
async getMode(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetModeResponse>> {
|
|
6844
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.getMode(cell, controller, options);
|
|
6845
|
-
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
6846
|
-
const localVarOperationServerBasePath = operationServerMap['ControllerApi.getMode']?.[localVarOperationServerIndex]?.url;
|
|
6847
|
-
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
6848
|
-
},
|
|
6849
8682
|
/**
|
|
6850
8683
|
* Get the configuration for a robot controller.
|
|
6851
8684
|
* @summary Robot Controller
|
|
@@ -6933,16 +8766,17 @@ export const ControllerApiFp = function(configuration?: Configuration) {
|
|
|
6933
8766
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
6934
8767
|
},
|
|
6935
8768
|
/**
|
|
6936
|
-
* <!-- theme: danger --> > Websocket endpoint Receive updates of the state of a robot controller.
|
|
8769
|
+
* <!-- 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.
|
|
6937
8770
|
* @summary Stream State
|
|
6938
8771
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
6939
8772
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
6940
8773
|
* @param {number} [responseRate]
|
|
8774
|
+
* @param {number} [addControllerTimeout]
|
|
6941
8775
|
* @param {*} [options] Override http request option.
|
|
6942
8776
|
* @throws {RequiredError}
|
|
6943
8777
|
*/
|
|
6944
|
-
async streamRobotControllerState(cell: string, controller: string, responseRate?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<RobotControllerState>> {
|
|
6945
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.streamRobotControllerState(cell, controller, responseRate, options);
|
|
8778
|
+
async streamRobotControllerState(cell: string, controller: string, responseRate?: number, addControllerTimeout?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<RobotControllerState>> {
|
|
8779
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.streamRobotControllerState(cell, controller, responseRate, addControllerTimeout, options);
|
|
6946
8780
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
6947
8781
|
const localVarOperationServerBasePath = operationServerMap['ControllerApi.streamRobotControllerState']?.[localVarOperationServerIndex]?.url;
|
|
6948
8782
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
@@ -7043,17 +8877,6 @@ export const ControllerApiFactory = function (configuration?: Configuration, bas
|
|
|
7043
8877
|
getCurrentRobotControllerState(cell: string, controller: string, options?: RawAxiosRequestConfig): AxiosPromise<RobotControllerState> {
|
|
7044
8878
|
return localVarFp.getCurrentRobotControllerState(cell, controller, options).then((request) => request(axios, basePath));
|
|
7045
8879
|
},
|
|
7046
|
-
/**
|
|
7047
|
-
* 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).
|
|
7048
|
-
* @summary Current Mode
|
|
7049
|
-
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
7050
|
-
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
7051
|
-
* @param {*} [options] Override http request option.
|
|
7052
|
-
* @throws {RequiredError}
|
|
7053
|
-
*/
|
|
7054
|
-
getMode(cell: string, controller: string, options?: RawAxiosRequestConfig): AxiosPromise<GetModeResponse> {
|
|
7055
|
-
return localVarFp.getMode(cell, controller, options).then((request) => request(axios, basePath));
|
|
7056
|
-
},
|
|
7057
8880
|
/**
|
|
7058
8881
|
* Get the configuration for a robot controller.
|
|
7059
8882
|
* @summary Robot Controller
|
|
@@ -7123,16 +8946,17 @@ export const ControllerApiFactory = function (configuration?: Configuration, bas
|
|
|
7123
8946
|
return localVarFp.streamFreeDrive(cell, controller, responseRate, options).then((request) => request(axios, basePath));
|
|
7124
8947
|
},
|
|
7125
8948
|
/**
|
|
7126
|
-
* <!-- theme: danger --> > Websocket endpoint Receive updates of the state of a robot controller.
|
|
8949
|
+
* <!-- 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.
|
|
7127
8950
|
* @summary Stream State
|
|
7128
8951
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
7129
8952
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
7130
8953
|
* @param {number} [responseRate]
|
|
8954
|
+
* @param {number} [addControllerTimeout]
|
|
7131
8955
|
* @param {*} [options] Override http request option.
|
|
7132
8956
|
* @throws {RequiredError}
|
|
7133
8957
|
*/
|
|
7134
|
-
streamRobotControllerState(cell: string, controller: string, responseRate?: number, options?: RawAxiosRequestConfig): AxiosPromise<RobotControllerState> {
|
|
7135
|
-
return localVarFp.streamRobotControllerState(cell, controller, responseRate, options).then((request) => request(axios, basePath));
|
|
8958
|
+
streamRobotControllerState(cell: string, controller: string, responseRate?: number, addControllerTimeout?: number, options?: RawAxiosRequestConfig): AxiosPromise<RobotControllerState> {
|
|
8959
|
+
return localVarFp.streamRobotControllerState(cell, controller, responseRate, addControllerTimeout, options).then((request) => request(axios, basePath));
|
|
7136
8960
|
},
|
|
7137
8961
|
/**
|
|
7138
8962
|
* 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.
|
|
@@ -7239,19 +9063,6 @@ export class ControllerApi extends BaseAPI {
|
|
|
7239
9063
|
return ControllerApiFp(this.configuration).getCurrentRobotControllerState(cell, controller, options).then((request) => request(this.axios, this.basePath));
|
|
7240
9064
|
}
|
|
7241
9065
|
|
|
7242
|
-
/**
|
|
7243
|
-
* 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).
|
|
7244
|
-
* @summary Current Mode
|
|
7245
|
-
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
7246
|
-
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
7247
|
-
* @param {*} [options] Override http request option.
|
|
7248
|
-
* @throws {RequiredError}
|
|
7249
|
-
* @memberof ControllerApi
|
|
7250
|
-
*/
|
|
7251
|
-
public getMode(cell: string, controller: string, options?: RawAxiosRequestConfig) {
|
|
7252
|
-
return ControllerApiFp(this.configuration).getMode(cell, controller, options).then((request) => request(this.axios, this.basePath));
|
|
7253
|
-
}
|
|
7254
|
-
|
|
7255
9066
|
/**
|
|
7256
9067
|
* Get the configuration for a robot controller.
|
|
7257
9068
|
* @summary Robot Controller
|
|
@@ -7333,17 +9144,18 @@ export class ControllerApi extends BaseAPI {
|
|
|
7333
9144
|
}
|
|
7334
9145
|
|
|
7335
9146
|
/**
|
|
7336
|
-
* <!-- theme: danger --> > Websocket endpoint Receive updates of the state of a robot controller.
|
|
9147
|
+
* <!-- 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.
|
|
7337
9148
|
* @summary Stream State
|
|
7338
9149
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
7339
9150
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
7340
9151
|
* @param {number} [responseRate]
|
|
9152
|
+
* @param {number} [addControllerTimeout]
|
|
7341
9153
|
* @param {*} [options] Override http request option.
|
|
7342
9154
|
* @throws {RequiredError}
|
|
7343
9155
|
* @memberof ControllerApi
|
|
7344
9156
|
*/
|
|
7345
|
-
public streamRobotControllerState(cell: string, controller: string, responseRate?: number, options?: RawAxiosRequestConfig) {
|
|
7346
|
-
return ControllerApiFp(this.configuration).streamRobotControllerState(cell, controller, responseRate, options).then((request) => request(this.axios, this.basePath));
|
|
9157
|
+
public streamRobotControllerState(cell: string, controller: string, responseRate?: number, addControllerTimeout?: number, options?: RawAxiosRequestConfig) {
|
|
9158
|
+
return ControllerApiFp(this.configuration).streamRobotControllerState(cell, controller, responseRate, addControllerTimeout, options).then((request) => request(this.axios, this.basePath));
|
|
7347
9159
|
}
|
|
7348
9160
|
|
|
7349
9161
|
/**
|
|
@@ -8027,6 +9839,52 @@ export class JoggingApi extends BaseAPI {
|
|
|
8027
9839
|
*/
|
|
8028
9840
|
export const KinematicsApiAxiosParamCreator = function (configuration?: Configuration) {
|
|
8029
9841
|
return {
|
|
9842
|
+
/**
|
|
9843
|
+
* Returns the TCP poses for a list of given joint positions.
|
|
9844
|
+
* @summary Forward kinematics
|
|
9845
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
9846
|
+
* @param {ForwardKinematicsRequest} [forwardKinematicsRequest]
|
|
9847
|
+
* @param {*} [options] Override http request option.
|
|
9848
|
+
* @throws {RequiredError}
|
|
9849
|
+
*/
|
|
9850
|
+
forwardKinematics: async (cell: string, forwardKinematicsRequest?: ForwardKinematicsRequest, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
9851
|
+
// verify required parameter 'cell' is not null or undefined
|
|
9852
|
+
assertParamExists('forwardKinematics', 'cell', cell)
|
|
9853
|
+
const localVarPath = `/cells/{cell}/kinematic/forward`
|
|
9854
|
+
.replace(`{${"cell"}}`, encodeURIComponent(String(cell)));
|
|
9855
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
9856
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
9857
|
+
let baseOptions;
|
|
9858
|
+
if (configuration) {
|
|
9859
|
+
baseOptions = configuration.baseOptions;
|
|
9860
|
+
}
|
|
9861
|
+
|
|
9862
|
+
const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
|
|
9863
|
+
const localVarHeaderParameter = {} as any;
|
|
9864
|
+
const localVarQueryParameter = {} as any;
|
|
9865
|
+
|
|
9866
|
+
// authentication BasicAuth required
|
|
9867
|
+
// http basic authentication required
|
|
9868
|
+
setBasicAuthToObject(localVarRequestOptions, configuration)
|
|
9869
|
+
|
|
9870
|
+
// authentication BearerAuth required
|
|
9871
|
+
// http bearer authentication required
|
|
9872
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
9873
|
+
|
|
9874
|
+
|
|
9875
|
+
|
|
9876
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
9877
|
+
|
|
9878
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
9879
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
9880
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
9881
|
+
localVarRequestOptions.data = serializeDataIfNeeded(forwardKinematicsRequest, localVarRequestOptions, configuration)
|
|
9882
|
+
|
|
9883
|
+
return {
|
|
9884
|
+
url: toPathString(localVarUrlObj),
|
|
9885
|
+
options: localVarRequestOptions,
|
|
9886
|
+
};
|
|
9887
|
+
},
|
|
8030
9888
|
/**
|
|
8031
9889
|
* Returns the reachable joint positions for a list of given poses.
|
|
8032
9890
|
* @summary Inverse kinematics
|
|
@@ -8083,6 +9941,20 @@ export const KinematicsApiAxiosParamCreator = function (configuration?: Configur
|
|
|
8083
9941
|
export const KinematicsApiFp = function(configuration?: Configuration) {
|
|
8084
9942
|
const localVarAxiosParamCreator = KinematicsApiAxiosParamCreator(configuration)
|
|
8085
9943
|
return {
|
|
9944
|
+
/**
|
|
9945
|
+
* Returns the TCP poses for a list of given joint positions.
|
|
9946
|
+
* @summary Forward kinematics
|
|
9947
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
9948
|
+
* @param {ForwardKinematicsRequest} [forwardKinematicsRequest]
|
|
9949
|
+
* @param {*} [options] Override http request option.
|
|
9950
|
+
* @throws {RequiredError}
|
|
9951
|
+
*/
|
|
9952
|
+
async forwardKinematics(cell: string, forwardKinematicsRequest?: ForwardKinematicsRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ForwardKinematicsResponse>> {
|
|
9953
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.forwardKinematics(cell, forwardKinematicsRequest, options);
|
|
9954
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
9955
|
+
const localVarOperationServerBasePath = operationServerMap['KinematicsApi.forwardKinematics']?.[localVarOperationServerIndex]?.url;
|
|
9956
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
9957
|
+
},
|
|
8086
9958
|
/**
|
|
8087
9959
|
* Returns the reachable joint positions for a list of given poses.
|
|
8088
9960
|
* @summary Inverse kinematics
|
|
@@ -8107,6 +9979,17 @@ export const KinematicsApiFp = function(configuration?: Configuration) {
|
|
|
8107
9979
|
export const KinematicsApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
|
|
8108
9980
|
const localVarFp = KinematicsApiFp(configuration)
|
|
8109
9981
|
return {
|
|
9982
|
+
/**
|
|
9983
|
+
* Returns the TCP poses for a list of given joint positions.
|
|
9984
|
+
* @summary Forward kinematics
|
|
9985
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
9986
|
+
* @param {ForwardKinematicsRequest} [forwardKinematicsRequest]
|
|
9987
|
+
* @param {*} [options] Override http request option.
|
|
9988
|
+
* @throws {RequiredError}
|
|
9989
|
+
*/
|
|
9990
|
+
forwardKinematics(cell: string, forwardKinematicsRequest?: ForwardKinematicsRequest, options?: RawAxiosRequestConfig): AxiosPromise<ForwardKinematicsResponse> {
|
|
9991
|
+
return localVarFp.forwardKinematics(cell, forwardKinematicsRequest, options).then((request) => request(axios, basePath));
|
|
9992
|
+
},
|
|
8110
9993
|
/**
|
|
8111
9994
|
* Returns the reachable joint positions for a list of given poses.
|
|
8112
9995
|
* @summary Inverse kinematics
|
|
@@ -8128,6 +10011,19 @@ export const KinematicsApiFactory = function (configuration?: Configuration, bas
|
|
|
8128
10011
|
* @extends {BaseAPI}
|
|
8129
10012
|
*/
|
|
8130
10013
|
export class KinematicsApi extends BaseAPI {
|
|
10014
|
+
/**
|
|
10015
|
+
* Returns the TCP poses for a list of given joint positions.
|
|
10016
|
+
* @summary Forward kinematics
|
|
10017
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
10018
|
+
* @param {ForwardKinematicsRequest} [forwardKinematicsRequest]
|
|
10019
|
+
* @param {*} [options] Override http request option.
|
|
10020
|
+
* @throws {RequiredError}
|
|
10021
|
+
* @memberof KinematicsApi
|
|
10022
|
+
*/
|
|
10023
|
+
public forwardKinematics(cell: string, forwardKinematicsRequest?: ForwardKinematicsRequest, options?: RawAxiosRequestConfig) {
|
|
10024
|
+
return KinematicsApiFp(this.configuration).forwardKinematics(cell, forwardKinematicsRequest, options).then((request) => request(this.axios, this.basePath));
|
|
10025
|
+
}
|
|
10026
|
+
|
|
8131
10027
|
/**
|
|
8132
10028
|
* Returns the reachable joint positions for a list of given poses.
|
|
8133
10029
|
* @summary Inverse kinematics
|
|
@@ -10062,27 +11958,27 @@ export class StoreCollisionComponentsApi extends BaseAPI {
|
|
|
10062
11958
|
|
|
10063
11959
|
|
|
10064
11960
|
/**
|
|
10065
|
-
*
|
|
11961
|
+
* StoreCollisionSetupsApi - axios parameter creator
|
|
10066
11962
|
* @export
|
|
10067
11963
|
*/
|
|
10068
|
-
export const
|
|
11964
|
+
export const StoreCollisionSetupsApiAxiosParamCreator = function (configuration?: Configuration) {
|
|
10069
11965
|
return {
|
|
10070
11966
|
/**
|
|
10071
|
-
* Deletes the stored
|
|
10072
|
-
* @summary Delete
|
|
11967
|
+
* Deletes the stored collision setup. <!-- theme: danger --> > This will delete persistently stored data.
|
|
11968
|
+
* @summary Delete Collision Setup
|
|
10073
11969
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
10074
|
-
* @param {string}
|
|
11970
|
+
* @param {string} setup Identifier of the collision setup
|
|
10075
11971
|
* @param {*} [options] Override http request option.
|
|
10076
11972
|
* @throws {RequiredError}
|
|
10077
11973
|
*/
|
|
10078
|
-
|
|
11974
|
+
deleteStoredCollisionSetup: async (cell: string, setup: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
10079
11975
|
// verify required parameter 'cell' is not null or undefined
|
|
10080
|
-
assertParamExists('
|
|
10081
|
-
// verify required parameter '
|
|
10082
|
-
assertParamExists('
|
|
10083
|
-
const localVarPath = `/cells/{cell}/store/collision/
|
|
11976
|
+
assertParamExists('deleteStoredCollisionSetup', 'cell', cell)
|
|
11977
|
+
// verify required parameter 'setup' is not null or undefined
|
|
11978
|
+
assertParamExists('deleteStoredCollisionSetup', 'setup', setup)
|
|
11979
|
+
const localVarPath = `/cells/{cell}/store/collision/setups/{setup}`
|
|
10084
11980
|
.replace(`{${"cell"}}`, encodeURIComponent(String(cell)))
|
|
10085
|
-
.replace(`{${"
|
|
11981
|
+
.replace(`{${"setup"}}`, encodeURIComponent(String(setup)));
|
|
10086
11982
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
10087
11983
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
10088
11984
|
let baseOptions;
|
|
@@ -10114,21 +12010,21 @@ export const StoreCollisionScenesApiAxiosParamCreator = function (configuration?
|
|
|
10114
12010
|
};
|
|
10115
12011
|
},
|
|
10116
12012
|
/**
|
|
10117
|
-
* Returns the stored
|
|
10118
|
-
* @summary Get
|
|
12013
|
+
* Returns the stored collision setup.
|
|
12014
|
+
* @summary Get Collision Setup
|
|
10119
12015
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
10120
|
-
* @param {string}
|
|
12016
|
+
* @param {string} setup Identifier of the collision setup
|
|
10121
12017
|
* @param {*} [options] Override http request option.
|
|
10122
12018
|
* @throws {RequiredError}
|
|
10123
12019
|
*/
|
|
10124
|
-
|
|
12020
|
+
getStoredCollisionSetup: async (cell: string, setup: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
10125
12021
|
// verify required parameter 'cell' is not null or undefined
|
|
10126
|
-
assertParamExists('
|
|
10127
|
-
// verify required parameter '
|
|
10128
|
-
assertParamExists('
|
|
10129
|
-
const localVarPath = `/cells/{cell}/store/collision/
|
|
12022
|
+
assertParamExists('getStoredCollisionSetup', 'cell', cell)
|
|
12023
|
+
// verify required parameter 'setup' is not null or undefined
|
|
12024
|
+
assertParamExists('getStoredCollisionSetup', 'setup', setup)
|
|
12025
|
+
const localVarPath = `/cells/{cell}/store/collision/setups/{setup}`
|
|
10130
12026
|
.replace(`{${"cell"}}`, encodeURIComponent(String(cell)))
|
|
10131
|
-
.replace(`{${"
|
|
12027
|
+
.replace(`{${"setup"}}`, encodeURIComponent(String(setup)));
|
|
10132
12028
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
10133
12029
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
10134
12030
|
let baseOptions;
|
|
@@ -10160,16 +12056,16 @@ export const StoreCollisionScenesApiAxiosParamCreator = function (configuration?
|
|
|
10160
12056
|
};
|
|
10161
12057
|
},
|
|
10162
12058
|
/**
|
|
10163
|
-
* Returns a list of stored
|
|
10164
|
-
* @summary List
|
|
12059
|
+
* Returns a list of stored collision setups.
|
|
12060
|
+
* @summary List Collision Setups
|
|
10165
12061
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
10166
12062
|
* @param {*} [options] Override http request option.
|
|
10167
12063
|
* @throws {RequiredError}
|
|
10168
12064
|
*/
|
|
10169
|
-
|
|
12065
|
+
listStoredCollisionSetups: async (cell: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
10170
12066
|
// verify required parameter 'cell' is not null or undefined
|
|
10171
|
-
assertParamExists('
|
|
10172
|
-
const localVarPath = `/cells/{cell}/store/collision/
|
|
12067
|
+
assertParamExists('listStoredCollisionSetups', 'cell', cell)
|
|
12068
|
+
const localVarPath = `/cells/{cell}/store/collision/setups`
|
|
10173
12069
|
.replace(`{${"cell"}}`, encodeURIComponent(String(cell)));
|
|
10174
12070
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
10175
12071
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
@@ -10202,24 +12098,24 @@ export const StoreCollisionScenesApiAxiosParamCreator = function (configuration?
|
|
|
10202
12098
|
};
|
|
10203
12099
|
},
|
|
10204
12100
|
/**
|
|
10205
|
-
*
|
|
10206
|
-
* @summary Store
|
|
12101
|
+
* Stores collision setup. If the collision setup does not exist, it will be created. If the collision setup exists, it will be updated.
|
|
12102
|
+
* @summary Store Collision Setup
|
|
10207
12103
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
10208
|
-
* @param {string}
|
|
10209
|
-
* @param {
|
|
12104
|
+
* @param {string} setup Identifier of the collision setup
|
|
12105
|
+
* @param {CollisionSetup} collisionSetup
|
|
10210
12106
|
* @param {*} [options] Override http request option.
|
|
10211
12107
|
* @throws {RequiredError}
|
|
10212
12108
|
*/
|
|
10213
|
-
|
|
12109
|
+
storeCollisionSetup: async (cell: string, setup: string, collisionSetup: CollisionSetup, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
10214
12110
|
// verify required parameter 'cell' is not null or undefined
|
|
10215
|
-
assertParamExists('
|
|
10216
|
-
// verify required parameter '
|
|
10217
|
-
assertParamExists('
|
|
10218
|
-
// verify required parameter '
|
|
10219
|
-
assertParamExists('
|
|
10220
|
-
const localVarPath = `/cells/{cell}/store/collision/
|
|
12111
|
+
assertParamExists('storeCollisionSetup', 'cell', cell)
|
|
12112
|
+
// verify required parameter 'setup' is not null or undefined
|
|
12113
|
+
assertParamExists('storeCollisionSetup', 'setup', setup)
|
|
12114
|
+
// verify required parameter 'collisionSetup' is not null or undefined
|
|
12115
|
+
assertParamExists('storeCollisionSetup', 'collisionSetup', collisionSetup)
|
|
12116
|
+
const localVarPath = `/cells/{cell}/store/collision/setups/{setup}`
|
|
10221
12117
|
.replace(`{${"cell"}}`, encodeURIComponent(String(cell)))
|
|
10222
|
-
.replace(`{${"
|
|
12118
|
+
.replace(`{${"setup"}}`, encodeURIComponent(String(setup)));
|
|
10223
12119
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
10224
12120
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
10225
12121
|
let baseOptions;
|
|
@@ -10246,7 +12142,7 @@ export const StoreCollisionScenesApiAxiosParamCreator = function (configuration?
|
|
|
10246
12142
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
10247
12143
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
10248
12144
|
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
10249
|
-
localVarRequestOptions.data = serializeDataIfNeeded(
|
|
12145
|
+
localVarRequestOptions.data = serializeDataIfNeeded(collisionSetup, localVarRequestOptions, configuration)
|
|
10250
12146
|
|
|
10251
12147
|
return {
|
|
10252
12148
|
url: toPathString(localVarUrlObj),
|
|
@@ -10257,182 +12153,182 @@ export const StoreCollisionScenesApiAxiosParamCreator = function (configuration?
|
|
|
10257
12153
|
};
|
|
10258
12154
|
|
|
10259
12155
|
/**
|
|
10260
|
-
*
|
|
12156
|
+
* StoreCollisionSetupsApi - functional programming interface
|
|
10261
12157
|
* @export
|
|
10262
12158
|
*/
|
|
10263
|
-
export const
|
|
10264
|
-
const localVarAxiosParamCreator =
|
|
12159
|
+
export const StoreCollisionSetupsApiFp = function(configuration?: Configuration) {
|
|
12160
|
+
const localVarAxiosParamCreator = StoreCollisionSetupsApiAxiosParamCreator(configuration)
|
|
10265
12161
|
return {
|
|
10266
12162
|
/**
|
|
10267
|
-
* Deletes the stored
|
|
10268
|
-
* @summary Delete
|
|
12163
|
+
* Deletes the stored collision setup. <!-- theme: danger --> > This will delete persistently stored data.
|
|
12164
|
+
* @summary Delete Collision Setup
|
|
10269
12165
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
10270
|
-
* @param {string}
|
|
12166
|
+
* @param {string} setup Identifier of the collision setup
|
|
10271
12167
|
* @param {*} [options] Override http request option.
|
|
10272
12168
|
* @throws {RequiredError}
|
|
10273
12169
|
*/
|
|
10274
|
-
async
|
|
10275
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.
|
|
12170
|
+
async deleteStoredCollisionSetup(cell: string, setup: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> {
|
|
12171
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.deleteStoredCollisionSetup(cell, setup, options);
|
|
10276
12172
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
10277
|
-
const localVarOperationServerBasePath = operationServerMap['
|
|
12173
|
+
const localVarOperationServerBasePath = operationServerMap['StoreCollisionSetupsApi.deleteStoredCollisionSetup']?.[localVarOperationServerIndex]?.url;
|
|
10278
12174
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
10279
12175
|
},
|
|
10280
12176
|
/**
|
|
10281
|
-
* Returns the stored
|
|
10282
|
-
* @summary Get
|
|
12177
|
+
* Returns the stored collision setup.
|
|
12178
|
+
* @summary Get Collision Setup
|
|
10283
12179
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
10284
|
-
* @param {string}
|
|
12180
|
+
* @param {string} setup Identifier of the collision setup
|
|
10285
12181
|
* @param {*} [options] Override http request option.
|
|
10286
12182
|
* @throws {RequiredError}
|
|
10287
12183
|
*/
|
|
10288
|
-
async
|
|
10289
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.
|
|
12184
|
+
async getStoredCollisionSetup(cell: string, setup: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CollisionSetup>> {
|
|
12185
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.getStoredCollisionSetup(cell, setup, options);
|
|
10290
12186
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
10291
|
-
const localVarOperationServerBasePath = operationServerMap['
|
|
12187
|
+
const localVarOperationServerBasePath = operationServerMap['StoreCollisionSetupsApi.getStoredCollisionSetup']?.[localVarOperationServerIndex]?.url;
|
|
10292
12188
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
10293
12189
|
},
|
|
10294
12190
|
/**
|
|
10295
|
-
* Returns a list of stored
|
|
10296
|
-
* @summary List
|
|
12191
|
+
* Returns a list of stored collision setups.
|
|
12192
|
+
* @summary List Collision Setups
|
|
10297
12193
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
10298
12194
|
* @param {*} [options] Override http request option.
|
|
10299
12195
|
* @throws {RequiredError}
|
|
10300
12196
|
*/
|
|
10301
|
-
async
|
|
10302
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.
|
|
12197
|
+
async listStoredCollisionSetups(cell: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<{ [key: string]: CollisionSetup; }>> {
|
|
12198
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.listStoredCollisionSetups(cell, options);
|
|
10303
12199
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
10304
|
-
const localVarOperationServerBasePath = operationServerMap['
|
|
12200
|
+
const localVarOperationServerBasePath = operationServerMap['StoreCollisionSetupsApi.listStoredCollisionSetups']?.[localVarOperationServerIndex]?.url;
|
|
10305
12201
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
10306
12202
|
},
|
|
10307
12203
|
/**
|
|
10308
|
-
*
|
|
10309
|
-
* @summary Store
|
|
12204
|
+
* Stores collision setup. If the collision setup does not exist, it will be created. If the collision setup exists, it will be updated.
|
|
12205
|
+
* @summary Store Collision Setup
|
|
10310
12206
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
10311
|
-
* @param {string}
|
|
10312
|
-
* @param {
|
|
12207
|
+
* @param {string} setup Identifier of the collision setup
|
|
12208
|
+
* @param {CollisionSetup} collisionSetup
|
|
10313
12209
|
* @param {*} [options] Override http request option.
|
|
10314
12210
|
* @throws {RequiredError}
|
|
10315
12211
|
*/
|
|
10316
|
-
async
|
|
10317
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.
|
|
12212
|
+
async storeCollisionSetup(cell: string, setup: string, collisionSetup: CollisionSetup, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CollisionSetup>> {
|
|
12213
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.storeCollisionSetup(cell, setup, collisionSetup, options);
|
|
10318
12214
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
10319
|
-
const localVarOperationServerBasePath = operationServerMap['
|
|
12215
|
+
const localVarOperationServerBasePath = operationServerMap['StoreCollisionSetupsApi.storeCollisionSetup']?.[localVarOperationServerIndex]?.url;
|
|
10320
12216
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
10321
12217
|
},
|
|
10322
12218
|
}
|
|
10323
12219
|
};
|
|
10324
12220
|
|
|
10325
12221
|
/**
|
|
10326
|
-
*
|
|
12222
|
+
* StoreCollisionSetupsApi - factory interface
|
|
10327
12223
|
* @export
|
|
10328
12224
|
*/
|
|
10329
|
-
export const
|
|
10330
|
-
const localVarFp =
|
|
12225
|
+
export const StoreCollisionSetupsApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
|
|
12226
|
+
const localVarFp = StoreCollisionSetupsApiFp(configuration)
|
|
10331
12227
|
return {
|
|
10332
12228
|
/**
|
|
10333
|
-
* Deletes the stored
|
|
10334
|
-
* @summary Delete
|
|
12229
|
+
* Deletes the stored collision setup. <!-- theme: danger --> > This will delete persistently stored data.
|
|
12230
|
+
* @summary Delete Collision Setup
|
|
10335
12231
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
10336
|
-
* @param {string}
|
|
12232
|
+
* @param {string} setup Identifier of the collision setup
|
|
10337
12233
|
* @param {*} [options] Override http request option.
|
|
10338
12234
|
* @throws {RequiredError}
|
|
10339
12235
|
*/
|
|
10340
|
-
|
|
10341
|
-
return localVarFp.
|
|
12236
|
+
deleteStoredCollisionSetup(cell: string, setup: string, options?: RawAxiosRequestConfig): AxiosPromise<void> {
|
|
12237
|
+
return localVarFp.deleteStoredCollisionSetup(cell, setup, options).then((request) => request(axios, basePath));
|
|
10342
12238
|
},
|
|
10343
12239
|
/**
|
|
10344
|
-
* Returns the stored
|
|
10345
|
-
* @summary Get
|
|
12240
|
+
* Returns the stored collision setup.
|
|
12241
|
+
* @summary Get Collision Setup
|
|
10346
12242
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
10347
|
-
* @param {string}
|
|
12243
|
+
* @param {string} setup Identifier of the collision setup
|
|
10348
12244
|
* @param {*} [options] Override http request option.
|
|
10349
12245
|
* @throws {RequiredError}
|
|
10350
12246
|
*/
|
|
10351
|
-
|
|
10352
|
-
return localVarFp.
|
|
12247
|
+
getStoredCollisionSetup(cell: string, setup: string, options?: RawAxiosRequestConfig): AxiosPromise<CollisionSetup> {
|
|
12248
|
+
return localVarFp.getStoredCollisionSetup(cell, setup, options).then((request) => request(axios, basePath));
|
|
10353
12249
|
},
|
|
10354
12250
|
/**
|
|
10355
|
-
* Returns a list of stored
|
|
10356
|
-
* @summary List
|
|
12251
|
+
* Returns a list of stored collision setups.
|
|
12252
|
+
* @summary List Collision Setups
|
|
10357
12253
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
10358
12254
|
* @param {*} [options] Override http request option.
|
|
10359
12255
|
* @throws {RequiredError}
|
|
10360
12256
|
*/
|
|
10361
|
-
|
|
10362
|
-
return localVarFp.
|
|
12257
|
+
listStoredCollisionSetups(cell: string, options?: RawAxiosRequestConfig): AxiosPromise<{ [key: string]: CollisionSetup; }> {
|
|
12258
|
+
return localVarFp.listStoredCollisionSetups(cell, options).then((request) => request(axios, basePath));
|
|
10363
12259
|
},
|
|
10364
12260
|
/**
|
|
10365
|
-
*
|
|
10366
|
-
* @summary Store
|
|
12261
|
+
* Stores collision setup. If the collision setup does not exist, it will be created. If the collision setup exists, it will be updated.
|
|
12262
|
+
* @summary Store Collision Setup
|
|
10367
12263
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
10368
|
-
* @param {string}
|
|
10369
|
-
* @param {
|
|
12264
|
+
* @param {string} setup Identifier of the collision setup
|
|
12265
|
+
* @param {CollisionSetup} collisionSetup
|
|
10370
12266
|
* @param {*} [options] Override http request option.
|
|
10371
12267
|
* @throws {RequiredError}
|
|
10372
12268
|
*/
|
|
10373
|
-
|
|
10374
|
-
return localVarFp.
|
|
12269
|
+
storeCollisionSetup(cell: string, setup: string, collisionSetup: CollisionSetup, options?: RawAxiosRequestConfig): AxiosPromise<CollisionSetup> {
|
|
12270
|
+
return localVarFp.storeCollisionSetup(cell, setup, collisionSetup, options).then((request) => request(axios, basePath));
|
|
10375
12271
|
},
|
|
10376
12272
|
};
|
|
10377
12273
|
};
|
|
10378
12274
|
|
|
10379
12275
|
/**
|
|
10380
|
-
*
|
|
12276
|
+
* StoreCollisionSetupsApi - object-oriented interface
|
|
10381
12277
|
* @export
|
|
10382
|
-
* @class
|
|
12278
|
+
* @class StoreCollisionSetupsApi
|
|
10383
12279
|
* @extends {BaseAPI}
|
|
10384
12280
|
*/
|
|
10385
|
-
export class
|
|
12281
|
+
export class StoreCollisionSetupsApi extends BaseAPI {
|
|
10386
12282
|
/**
|
|
10387
|
-
* Deletes the stored
|
|
10388
|
-
* @summary Delete
|
|
12283
|
+
* Deletes the stored collision setup. <!-- theme: danger --> > This will delete persistently stored data.
|
|
12284
|
+
* @summary Delete Collision Setup
|
|
10389
12285
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
10390
|
-
* @param {string}
|
|
12286
|
+
* @param {string} setup Identifier of the collision setup
|
|
10391
12287
|
* @param {*} [options] Override http request option.
|
|
10392
12288
|
* @throws {RequiredError}
|
|
10393
|
-
* @memberof
|
|
12289
|
+
* @memberof StoreCollisionSetupsApi
|
|
10394
12290
|
*/
|
|
10395
|
-
public
|
|
10396
|
-
return
|
|
12291
|
+
public deleteStoredCollisionSetup(cell: string, setup: string, options?: RawAxiosRequestConfig) {
|
|
12292
|
+
return StoreCollisionSetupsApiFp(this.configuration).deleteStoredCollisionSetup(cell, setup, options).then((request) => request(this.axios, this.basePath));
|
|
10397
12293
|
}
|
|
10398
12294
|
|
|
10399
12295
|
/**
|
|
10400
|
-
* Returns the stored
|
|
10401
|
-
* @summary Get
|
|
12296
|
+
* Returns the stored collision setup.
|
|
12297
|
+
* @summary Get Collision Setup
|
|
10402
12298
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
10403
|
-
* @param {string}
|
|
12299
|
+
* @param {string} setup Identifier of the collision setup
|
|
10404
12300
|
* @param {*} [options] Override http request option.
|
|
10405
12301
|
* @throws {RequiredError}
|
|
10406
|
-
* @memberof
|
|
12302
|
+
* @memberof StoreCollisionSetupsApi
|
|
10407
12303
|
*/
|
|
10408
|
-
public
|
|
10409
|
-
return
|
|
12304
|
+
public getStoredCollisionSetup(cell: string, setup: string, options?: RawAxiosRequestConfig) {
|
|
12305
|
+
return StoreCollisionSetupsApiFp(this.configuration).getStoredCollisionSetup(cell, setup, options).then((request) => request(this.axios, this.basePath));
|
|
10410
12306
|
}
|
|
10411
12307
|
|
|
10412
12308
|
/**
|
|
10413
|
-
* Returns a list of stored
|
|
10414
|
-
* @summary List
|
|
12309
|
+
* Returns a list of stored collision setups.
|
|
12310
|
+
* @summary List Collision Setups
|
|
10415
12311
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
10416
12312
|
* @param {*} [options] Override http request option.
|
|
10417
12313
|
* @throws {RequiredError}
|
|
10418
|
-
* @memberof
|
|
12314
|
+
* @memberof StoreCollisionSetupsApi
|
|
10419
12315
|
*/
|
|
10420
|
-
public
|
|
10421
|
-
return
|
|
12316
|
+
public listStoredCollisionSetups(cell: string, options?: RawAxiosRequestConfig) {
|
|
12317
|
+
return StoreCollisionSetupsApiFp(this.configuration).listStoredCollisionSetups(cell, options).then((request) => request(this.axios, this.basePath));
|
|
10422
12318
|
}
|
|
10423
12319
|
|
|
10424
12320
|
/**
|
|
10425
|
-
*
|
|
10426
|
-
* @summary Store
|
|
12321
|
+
* Stores collision setup. If the collision setup does not exist, it will be created. If the collision setup exists, it will be updated.
|
|
12322
|
+
* @summary Store Collision Setup
|
|
10427
12323
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
10428
|
-
* @param {string}
|
|
10429
|
-
* @param {
|
|
12324
|
+
* @param {string} setup Identifier of the collision setup
|
|
12325
|
+
* @param {CollisionSetup} collisionSetup
|
|
10430
12326
|
* @param {*} [options] Override http request option.
|
|
10431
12327
|
* @throws {RequiredError}
|
|
10432
|
-
* @memberof
|
|
12328
|
+
* @memberof StoreCollisionSetupsApi
|
|
10433
12329
|
*/
|
|
10434
|
-
public
|
|
10435
|
-
return
|
|
12330
|
+
public storeCollisionSetup(cell: string, setup: string, collisionSetup: CollisionSetup, options?: RawAxiosRequestConfig) {
|
|
12331
|
+
return StoreCollisionSetupsApiFp(this.configuration).storeCollisionSetup(cell, setup, collisionSetup, options).then((request) => request(this.axios, this.basePath));
|
|
10436
12332
|
}
|
|
10437
12333
|
}
|
|
10438
12334
|
|
|
@@ -12344,7 +14240,53 @@ export class TrajectoryExecutionApi extends BaseAPI {
|
|
|
12344
14240
|
export const TrajectoryPlanningApiAxiosParamCreator = function (configuration?: Configuration) {
|
|
12345
14241
|
return {
|
|
12346
14242
|
/**
|
|
12347
|
-
* Plans a
|
|
14243
|
+
* 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.
|
|
14244
|
+
* @summary Plan Collision-Free Trajectory
|
|
14245
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
14246
|
+
* @param {PlanCollisionFreeRequest} [planCollisionFreeRequest]
|
|
14247
|
+
* @param {*} [options] Override http request option.
|
|
14248
|
+
* @throws {RequiredError}
|
|
14249
|
+
*/
|
|
14250
|
+
planCollisionFree: async (cell: string, planCollisionFreeRequest?: PlanCollisionFreeRequest, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
14251
|
+
// verify required parameter 'cell' is not null or undefined
|
|
14252
|
+
assertParamExists('planCollisionFree', 'cell', cell)
|
|
14253
|
+
const localVarPath = `/cells/{cell}/trajectory-planning/plan-collision-free`
|
|
14254
|
+
.replace(`{${"cell"}}`, encodeURIComponent(String(cell)));
|
|
14255
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
14256
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
14257
|
+
let baseOptions;
|
|
14258
|
+
if (configuration) {
|
|
14259
|
+
baseOptions = configuration.baseOptions;
|
|
14260
|
+
}
|
|
14261
|
+
|
|
14262
|
+
const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
|
|
14263
|
+
const localVarHeaderParameter = {} as any;
|
|
14264
|
+
const localVarQueryParameter = {} as any;
|
|
14265
|
+
|
|
14266
|
+
// authentication BasicAuth required
|
|
14267
|
+
// http basic authentication required
|
|
14268
|
+
setBasicAuthToObject(localVarRequestOptions, configuration)
|
|
14269
|
+
|
|
14270
|
+
// authentication BearerAuth required
|
|
14271
|
+
// http bearer authentication required
|
|
14272
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
14273
|
+
|
|
14274
|
+
|
|
14275
|
+
|
|
14276
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
14277
|
+
|
|
14278
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
14279
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
14280
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
14281
|
+
localVarRequestOptions.data = serializeDataIfNeeded(planCollisionFreeRequest, localVarRequestOptions, configuration)
|
|
14282
|
+
|
|
14283
|
+
return {
|
|
14284
|
+
url: toPathString(localVarUrlObj),
|
|
14285
|
+
options: localVarRequestOptions,
|
|
14286
|
+
};
|
|
14287
|
+
},
|
|
14288
|
+
/**
|
|
14289
|
+
* 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.
|
|
12348
14290
|
* @summary Plan Trajectory
|
|
12349
14291
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
12350
14292
|
* @param {PlanTrajectoryRequest} [planTrajectoryRequest]
|
|
@@ -12400,7 +14342,21 @@ export const TrajectoryPlanningApiFp = function(configuration?: Configuration) {
|
|
|
12400
14342
|
const localVarAxiosParamCreator = TrajectoryPlanningApiAxiosParamCreator(configuration)
|
|
12401
14343
|
return {
|
|
12402
14344
|
/**
|
|
12403
|
-
* Plans a
|
|
14345
|
+
* 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.
|
|
14346
|
+
* @summary Plan Collision-Free Trajectory
|
|
14347
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
14348
|
+
* @param {PlanCollisionFreeRequest} [planCollisionFreeRequest]
|
|
14349
|
+
* @param {*} [options] Override http request option.
|
|
14350
|
+
* @throws {RequiredError}
|
|
14351
|
+
*/
|
|
14352
|
+
async planCollisionFree(cell: string, planCollisionFreeRequest?: PlanCollisionFreeRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PlanCollisionFreeResponse>> {
|
|
14353
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.planCollisionFree(cell, planCollisionFreeRequest, options);
|
|
14354
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
14355
|
+
const localVarOperationServerBasePath = operationServerMap['TrajectoryPlanningApi.planCollisionFree']?.[localVarOperationServerIndex]?.url;
|
|
14356
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
14357
|
+
},
|
|
14358
|
+
/**
|
|
14359
|
+
* 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.
|
|
12404
14360
|
* @summary Plan Trajectory
|
|
12405
14361
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
12406
14362
|
* @param {PlanTrajectoryRequest} [planTrajectoryRequest]
|
|
@@ -12424,7 +14380,18 @@ export const TrajectoryPlanningApiFactory = function (configuration?: Configurat
|
|
|
12424
14380
|
const localVarFp = TrajectoryPlanningApiFp(configuration)
|
|
12425
14381
|
return {
|
|
12426
14382
|
/**
|
|
12427
|
-
* Plans a
|
|
14383
|
+
* 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.
|
|
14384
|
+
* @summary Plan Collision-Free Trajectory
|
|
14385
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
14386
|
+
* @param {PlanCollisionFreeRequest} [planCollisionFreeRequest]
|
|
14387
|
+
* @param {*} [options] Override http request option.
|
|
14388
|
+
* @throws {RequiredError}
|
|
14389
|
+
*/
|
|
14390
|
+
planCollisionFree(cell: string, planCollisionFreeRequest?: PlanCollisionFreeRequest, options?: RawAxiosRequestConfig): AxiosPromise<PlanCollisionFreeResponse> {
|
|
14391
|
+
return localVarFp.planCollisionFree(cell, planCollisionFreeRequest, options).then((request) => request(axios, basePath));
|
|
14392
|
+
},
|
|
14393
|
+
/**
|
|
14394
|
+
* 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.
|
|
12428
14395
|
* @summary Plan Trajectory
|
|
12429
14396
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
12430
14397
|
* @param {PlanTrajectoryRequest} [planTrajectoryRequest]
|
|
@@ -12445,7 +14412,20 @@ export const TrajectoryPlanningApiFactory = function (configuration?: Configurat
|
|
|
12445
14412
|
*/
|
|
12446
14413
|
export class TrajectoryPlanningApi extends BaseAPI {
|
|
12447
14414
|
/**
|
|
12448
|
-
* Plans a
|
|
14415
|
+
* 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.
|
|
14416
|
+
* @summary Plan Collision-Free Trajectory
|
|
14417
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
14418
|
+
* @param {PlanCollisionFreeRequest} [planCollisionFreeRequest]
|
|
14419
|
+
* @param {*} [options] Override http request option.
|
|
14420
|
+
* @throws {RequiredError}
|
|
14421
|
+
* @memberof TrajectoryPlanningApi
|
|
14422
|
+
*/
|
|
14423
|
+
public planCollisionFree(cell: string, planCollisionFreeRequest?: PlanCollisionFreeRequest, options?: RawAxiosRequestConfig) {
|
|
14424
|
+
return TrajectoryPlanningApiFp(this.configuration).planCollisionFree(cell, planCollisionFreeRequest, options).then((request) => request(this.axios, this.basePath));
|
|
14425
|
+
}
|
|
14426
|
+
|
|
14427
|
+
/**
|
|
14428
|
+
* 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.
|
|
12449
14429
|
* @summary Plan Trajectory
|
|
12450
14430
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
12451
14431
|
* @param {PlanTrajectoryRequest} [planTrajectoryRequest]
|