-
Notifications
You must be signed in to change notification settings - Fork 8
/
mir100-openapi.yaml
13059 lines (13058 loc) · 379 KB
/
mir100-openapi.yaml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
components:
schemas:
Error:
properties:
error_code:
description: The error in machine format
type: string
error_human:
description: The error in human friendly format
type: string
type: object
GetAction_definition:
properties:
action_type:
type: string
description:
type: string
descriptions:
items:
type: object
type: array
help:
type: string
mission_group_id:
type: string
name:
type: string
parameters:
items:
type: object
type: array
type: object
GetAction_definitions:
properties:
action_type:
type: string
description:
type: string
descriptions:
items:
type: object
type: array
help:
type: string
mission_group_id:
type: string
name:
type: string
parameters:
items:
type: object
type: array
type: object
GetArea_action_definition:
properties:
action_type:
description: A name associated with this area action
type: string
action_type_id:
description: The type of area action
format: int64
type: integer
help:
description: A description of this action
type: string
limit:
description: The amount of actions of this type we can add.
format: int64
type: integer
name:
description: A nice name associated with this area action
type: string
parameters:
items:
type: object
type: array
type: object
GetArea_action_definitions:
properties:
action_type:
description: A name associated with this area action
type: string
action_type_id:
description: The type of area action
format: int64
type: integer
help:
description: A description of this action
type: string
limit:
description: The amount of actions of this type we can add.
format: int64
type: integer
name:
description: A nice name associated with this area action
type: string
parameters:
items:
type: object
type: array
type: object
GetArea_event:
properties:
actions:
type: string
created_by:
description: The url to the description of the type of this position
type: string
created_by_id:
description: The global id of the user who created this entry
type: string
guid:
description: The global id unique across robots that identifies this area
type: string
map:
description: The url to the map this area belongs to
type: string
map_id:
description: The id of the map this area belongs to
type: string
name:
description: A name associated with this area
type: string
polygon:
description: The list of coordinates in the area polygon
items:
type: object
type: array
type_id:
description: The type of area
format: int64
type: integer
type: object
GetArea_events:
properties:
guid:
description: The global id unique across robots that identifies this area
type: string
map:
description: The url to the map this area belongs to
type: string
name:
description: A name associated with this area
type: string
type_id:
description: The type of area
format: int64
type: integer
url:
description: The URL of the resource
type: string
type: object
GetArea_events_definitions:
properties:
actions:
type: string
color:
description: The color associated with this area
type: string
id:
description: The type of area
format: int64
type: integer
image:
type: string
legacyName:
type: string
name:
description: A nice name associated with this area action
type: string
type: object
GetBluetooth:
properties:
address:
description: The mac address of the blueooth device
type: string
name:
description: The name of the bluetooth device
type: string
url:
description: The URL of the resource
type: string
type: object
GetBluetooth_relay:
properties:
created_by:
description: The url to the description of the type of this position
type: string
created_by_id:
description: The global id of the user who created this entry
type: string
guid:
description: The global unique id across robots that identifies this bluetooth
device
type: string
hardware_id:
description: The hardware id string for this bluetooth device
type: string
name:
description: The name of the bluetooth device
type: string
type:
description: Parameter to filter bluetooth devices
type: string
type: object
GetBluetooth_relays:
properties:
guid:
description: The global unique id across robots that identifies this bluetooth
device
type: string
name:
description: The name of the bluetooth device
type: string
type:
description: Parameter to filter bluetooth devices
type: string
url:
description: The URL of the resource
type: string
type: object
GetBluetooth_status:
properties: {}
type: object
GetCart:
properties:
cart_calibration:
description: The url to the calibration of this cart
type: string
cart_calibration_id:
description: The id of the calibration for this cart has
type: string
cart_type:
description: The url to the type of this cart
type: string
cart_type_id:
description: The id of the type of this cart
type: string
created_by:
description: The url to the description of the type of this position
type: string
created_by_id:
description: The global id of the user who created this entry
type: string
guid:
description: The global id unique across robots that identifies this cart
type: string
name:
description: The name of the cart
type: string
type: object
GetCart_calibration:
properties:
created_by:
description: The url to the description of the type of this position
type: string
created_by_id:
description: The global id of the user who created this entry
type: string
drive_height:
description: The height of the hook when driving with carts of this cart
calibration
format: int64
type: integer
entry_height:
description: The entry height of the hook for the cart calibration
format: int64
type: integer
guid:
description: The global id unique across robots that identifies this cart
calibration
type: string
lock_height:
description: The lock height of the hook for the cart calibration
format: int64
type: integer
name:
description: The name of the cart calibration
type: string
qw:
description: The qw quaternion of the cart calibration
format: float
type: number
qx:
description: The qx quaternion of the cart calibration
format: float
type: number
qy:
description: The qy quaternion of the cart calibration
format: float
type: number
qz:
description: The qz quaternion of the cart calibration
format: float
type: number
standard:
description: If the cart calibration is standard or not
type: boolean
x:
description: The offset in the x-coordinate of the cart calibration
format: float
type: number
y:
description: The offset in the y-coordinate of the cart calibration
format: float
type: number
z:
description: The offset in the z-coordinate of the cart calibration
format: float
type: number
type: object
GetCart_calibrations:
properties:
guid:
description: The global id unique across robots that identifies this cart
calibration
type: string
name:
description: The name of the cart calibration
type: string
url:
description: The URL of the resource
type: string
type: object
GetCart_type:
properties:
created_by:
description: The url to the description of the type of this position
type: string
created_by_id:
description: The global id of the user who created this entry
type: string
guid:
description: The global id unique across robots that identifies this cart
type
type: string
height:
description: The height of carts of this type
format: float
type: number
length:
description: The length of carts of this type
format: float
type: number
name:
description: The name of the cart type
type: string
offset_locked_wheels:
description: The offset from the center of the robot to the locked wheels
of carts of this type
format: float
type: number
width:
description: The width of carts of this type
format: float
type: number
type: object
GetCart_types:
properties:
guid:
description: The global id unique across robots that identifies this cart
type
type: string
name:
description: The name of the cart type
type: string
url:
description: The URL of the resource
type: string
type: object
GetCarts:
properties:
cart_calibration:
description: The url to the calibration of this cart
type: string
cart_type:
description: The url to the type of this cart
type: string
guid:
description: The global id unique across robots that identifies this cart
type: string
name:
description: The name of the cart
type: string
url:
description: The URL of the resource
type: string
type: object
GetChanges_me:
properties: {}
type: object
GetDashboard:
properties:
created_by:
description: The url to the user that created the dashboard
type: string
created_by_id:
description: The global id of the user who created this entry
type: string
fleet_dashboard:
type: boolean
guid:
description: The global id unique across robots that identifies this dashboard
type: string
name:
description: The name of this dashboard
type: string
widgets:
description: The url to the possible widgets. if the dashboard does not
have any widgets then this field is empty
type: string
type: object
GetDashboard_widget:
properties:
dashboard:
description: The url to the dashboard where this widget belongs.
type: string
dashboard_id:
description: The guid of the dashboard this widget belongs to
type: string
guid:
description: The global id unique across robots that identifies this widget
type: string
settings:
description: Widgets configuration encoded base 64 in json
type: string
type: object
GetDashboard_widgets:
properties:
dashboard_id:
description: The guid of the dashboard this widget belongs to
type: string
guid:
description: The global id unique across robots that identifies this widget
type: string
url:
description: The URL of the resource
type: string
type: object
GetDashboards:
properties:
guid:
description: The global id unique across robots that identifies this dashboard
type: string
name:
description: The name of this dashboard
type: string
url:
description: The URL of the resource
type: string
widgets:
description: The url to the possible widgets. if the dashboard does not
have any widgets then this field is empty
type: string
type: object
GetDistance_statistics:
properties:
date:
format: date-time
type: string
distance:
format: float
type: number
type: object
GetDocking_offset:
properties:
guid:
description: The global id unique across robots that identifies this docking
offset
type: string
orientation_offset:
description: The orientation offset with respect to the docking marker
format: float
type: number
pos_id:
description: The global id refering to the position that this offset belongs
to
type: string
position:
description: The url to the position
type: string
x_offset:
description: The x-offset with respect to the docking marker
format: float
type: number
y_offset:
description: The y-offset with respect to the docking marker
format: float
type: number
type: object
GetDocking_offsets:
properties:
guid:
description: The global id unique across robots that identifies this docking
offset
type: string
position:
description: The url to the position
type: string
url:
description: The URL of the resource
type: string
type: object
GetError_report:
properties:
description:
type: string
download_url:
description: The url to where the bag can be downloaded
type: string
id:
description: Id of the autobag
format: int64
type: integer
module:
description: The module that created the autolog
type: string
ready:
description: Status of the rosbag
type: boolean
time:
description: The time where the autolog was created
format: date-time
type: string
type: object
GetError_report_download:
properties: {}
type: object
GetError_reports:
properties:
description:
type: string
download_url:
description: The url to where the bag can be downloaded
type: string
id:
description: Id of the autobag
format: int64
type: integer
module:
description: The module that created the autolog
type: string
ready:
description: Status of the rosbag
type: boolean
time:
description: The time where the autolog was created
format: date-time
type: string
type: object
GetFactory_reset:
properties: {}
type: object
GetGroup_action_definition:
properties:
action_type:
type: string
description:
type: string
descriptions:
items:
type: object
type: array
help:
type: string
mission_group_id:
type: string
name:
type: string
parameters:
items:
type: object
type: array
type: object
GetGroup_missions:
properties:
guid:
description: The global id unique across robots that identifies this mission
type: string
name:
description: The name of the mission
type: string
url:
description: The URL of the resource
type: string
type: object
GetHelper_positions:
properties:
guid:
description: The global id unique across robots that identifies this position
type: string
map:
description: The url to the map this position belongs to
type: string
name:
description: The name of the position
type: string
type_id:
description: The type of position. see the general description above
format: int64
type: integer
url:
description: The URL of the resource
type: string
type: object
GetHook:
properties:
angle:
description: The angle of the hook arm
format: float
type: number
available:
description: Whether the hook data is available or not
type: boolean
brake:
$ref: '#/components/schemas/brake'
gripper:
$ref: '#/components/schemas/gripper'
height:
$ref: '#/components/schemas/height'
qr_marker_name:
description: The name of the last seen qr marker
type: string
type: object
GetHook_brake:
properties:
braked:
description: Whether the brake of the hook is active or not
type: boolean
state:
description: The state of the hook brake in machine format
format: int64
type: integer
state_string:
description: The state of the hook brake in human format
type: string
type: object
GetHook_gripper:
properties:
closed:
description: Whether the gripper of the hook is closed or not
type: boolean
state:
description: The sate of the hook gripper in machine format
format: int64
type: integer
state_string:
description: The state of the hook gripper in human format
type: string
type: object
GetHook_height:
properties:
height:
description: The height of the hook in mm
format: int64
type: integer
state:
description: The state of the hook actuator in machine format
format: int64
type: integer
state_string:
description: The state of the hook actuator in human format
type: string
type: object
GetHw_config_export:
properties: {}
type: object
GetHw_config_import:
properties: {}
type: object
GetIo_module:
properties:
address:
description: The address for connecting to the device. it can be a mac address
or an ip depending on the type of io module
type: string
created_by:
description: The url to the description of the type of this io module
type: string
created_by_id:
description: The global id of the user who created this entry
type: string
guid:
description: The global unique id across robots that identifies this io
module
type: string
name:
description: The name of the io module
type: string
num_inputs:
description: The number of inputs that the io module has
format: int64
type: integer
num_outputs:
description: The number or outputs that the io module has
format: int64
type: integer
type:
description: The type of the io module. currently supported devices [bluetooth,
wise].
type: string
type: object
GetIo_module_status:
properties: {}
type: object
GetIo_modules:
properties:
guid:
description: The global unique id across robots that identifies this io
module
type: string
name:
description: The name of the io module
type: string
type:
description: The type of the io module. currently supported devices [bluetooth,
wise].
type: string
url:
description: The URL of the resource
type: string
type: object
GetMap:
properties:
created_by:
description: The url to the description of the type of this position
type: string
created_by_id:
description: The global id of the user who created this entry
type: string
guid:
description: The global id unique across robots that identifies this map
type: string
map:
description: If this map is navigation map or not
format: byte
type: string
metadata:
description: If this map is a web map or not
format: byte
type: string
name:
description: The name of the map
type: string
one_way_map:
description: If this map is navigation map or not
format: byte
type: string
origin_theta:
description: The angle in the map of the center of the map relative to the
robots position
format: float
type: number
origin_x:
description: The x-coordinate in the map of the center of the map relative
to the robots position
format: float
type: number
origin_y:
description: The y-coordinate in the map of the center of the map relative
to the robots position
format: float
type: number
path_guides:
description: The url to the list of path guides in this map
type: string
paths:
description: The url to the list of paths in this map
type: string
positions:
description: The url to the list of positions in this map
type: string
resolution:
description: The resolution of the map
format: float
type: number
session_id:
description: The global id unique across robots of the area containing this
map
type: string
type: object
GetMap_area_event:
properties:
guid:
description: The global id unique across robots that identifies this area
type: string
map:
description: The url to the map this area belongs to
type: string
name:
description: A name associated with this area
type: string
type_id:
description: The type of area
format: int64
type: integer
url:
description: The URL of the resource
type: string
type: object
GetMap_path_guides:
properties:
guid:
description: The global unique id across robots that identifies this path
guide
type: string
name:
description: The name of the path guide
type: string
url:
description: The URL of the resource
type: string
type: object
GetMap_paths:
properties:
goal_pos:
description: The url to the end position of the path
type: string
guid:
description: The global id unique across robots that identifies this path
type: string
start_pos:
description: The url to the start position of the path
type: string
url:
description: The URL of the resource
type: string
type: object
GetMap_positions:
properties:
guid:
description: The global id unique across robots that identifies this position
type: string
map:
description: The url to the map this position belongs to
type: string
name:
description: The name of the position
type: string
type_id:
description: The type of position. see the general description above
format: int64
type: integer
url:
description: The URL of the resource
type: string
type: object
GetMaps:
properties:
guid:
description: The global id unique across robots that identifies this map
type: string
name:
description: The name of the map
type: string
url:
description: The URL of the resource
type: string
type: object
GetMe:
properties:
guid:
description: The global unique id across robots that identifies this user
type: string
name:
description: The name of the user
type: string
url:
description: The URL of the resource
type: string
user_group:
description: Url for the user group this user is in
type: string
user_group_id:
description: Global id of the user group this user is in
type: string
type: object
GetMission:
properties:
actions:
description: The url to the list of actions contained in this mission
type: string
created_by:
description: The url to the description of the type of this position
type: string
created_by_id:
description: The global id of the user who created this entry
type: string
definition:
description: The url to the list of input parameters this mission accepts
type: string
description:
description: The description of the mission
type: string
group_id:
description: The id of the area this mission belongs to, or null if the
mission belongs to all areas
type: string
guid:
description: The global id unique across robots that identifies this mission
type: string
has_user_parameters:
description: Indicates if the mission has dynamic parameters
type: boolean
hidden:
description: If this mission is hidden in the mission list
type: boolean
name:
description: The name of the mission
type: string
session_id:
description: The id of the area this mission belongs to, or null if the
mission belongs to all areas
type: string
valid:
description: Indicates if the mission contains only existing submissions
type: boolean
type: object
GetMission_action:
properties:
action_type:
description: The id of the type of action
type: string
guid:
description: The global id unique across robots that identifies this mission
type: string
mission_id:
description: The id of the mission the action belongs to
type: string
parameters:
items:
type: object
type: array
priority:
description: The priority of the action
format: int64
type: integer
scope_reference:
description: Reference to the scope in which the action belongs
type: string
type: object
GetMission_actions:
properties:
action_type:
description: The id of the type of action
type: string
guid:
description: The global id unique across robots that identifies this mission
type: string
mission_id:
description: The id of the mission the action belongs to
type: string
parameters:
items:
type: object
type: array
priority:
description: The priority of the action
format: int64
type: integer
url:
description: The URL of the resource
type: string
type: object
GetMission_definition:
properties:
action_type:
type: string
name:
type: string
url:
description: The URL of the resource
type: string
type: object
GetMission_group:
properties:
created_by:
description: The url to the description of the type of this position
type: string
created_by_id:
description: The global id of the user who created this entry
type: string
feature:
description: The name of the position
type: string
guid:
description: The global id unique across robots that identifies this position
type: string
icon:
description: The name of the position
format: byte
type: string
name:
description: The name of the position
type: string
priority:
description: The name of the position
format: int64
type: integer
type: object