-
Notifications
You must be signed in to change notification settings - Fork 4
/
http-api.yml
1347 lines (1288 loc) · 42.1 KB
/
http-api.yml
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
openapi: "3.0.2"
info:
title: Blueye HTTP API
version: "1.0.1"
servers:
- url: http://192.168.1.101/
tags:
- name: "Diagnostics"
- name: "Subtitles"
- name: "Dive data"
- name: "Pictures"
paths:
/diagnostics/drone_info:
get:
tags:
- "Diagnostics"
summary: Drone information
description: |
Returns a JSON string of drone information. Using this endpoint is the easiest way to check
if there is a drone connected to your network.
responses:
"200":
description: A JSON string of drone information.
content:
application/json:
schema:
$ref: "#/components/schemas/DroneInfo"
x-codeSamples:
- lang: "curl"
source: |
curl -X GET "http://192.168.1.101/diagnostics/drone_info"
- lang: "Python"
source: |
import requests
response = requests.get("http://192.168.1.101/diagnostics/drone_info")
print(response.json())
/diagnostics/iperf:
post:
tags:
- "Diagnostics"
summary: Tether bandwidth test
description: |
Performs a bandwidth test on the connection between the surface unit and the drone. Set the
test duration with the "duration"-parameter. A longer duration should yield a more accurate
result.
parameters:
- in: query
name: "duration"
description: Duration of the test to perform. Unit is seconds.
required: false
schema:
type: integer
default: 10
responses:
"200":
description: A JSON string with the performance test results.
content:
application/json:
schema:
$ref: "#/components/schemas/IperfResult"
x-codeSamples:
- lang: "curl"
source: |
curl -X POST "http://192.168.1.101/diagnostics/iperf" -d duration=5
- lang: "Python"
source: |
import requests
response = requests.post("http://192.168.1.101/diagnostics/iperf",
data={"duration": 5})
print(response.json())
/logs:
get:
tags:
- "Dive data"
summary: Array of binary logs
description: |
Returns an array of binary logs from the drone. Each array item represents an available log
file on the drone. Use the /logs/{filename}/binlog endpoint to get the full log.
responses:
"200":
description: Array of binary logs
content:
application/json:
schema:
type: array
items:
$ref: "#/components/schemas/BinLog"
x-codeSamples:
- lang: "curl"
source: |
curl -X GET "http://192.168.1.101/logs"
- lang: "Python"
source: |
import requests
response = requests.get("http://192.168.1.101/logs")
print(response.json())
/logs/{logname}/binlog:
get:
tags:
- "Dive data"
summary: Download a binary log file
description: Returns the binary content of the requested log
parameters:
- name: logname
in: path
description: Name of the log to download
required: true
schema:
type: string
example: BYEDP070018_ea9add4d0c1961d4_00388
responses:
"200":
description: Binary log file
content:
application/octet-stream:
schema:
type: string
format: binary
x-codeSamples:
- lang: "curl"
source: |
# To get log with name BYEDP070018_ea9add4d0c1961d4_00388
curl -X GET "http://192.168.1.101/logs/BYEDP070018_ea9add4d0c1961d4_00388/binlog"
- lang: "Python"
source: |
import requests
logname = "BYEDP070018_ea9add4d0c1961d4_00388"
response = requests.get(f"http://192.168.1.101/logs/{logname}/binlog")
with open(f"{logname}.bez", "wb") as f:
f.write(response.content)
/logs/{logname}/dive_info:
get:
tags:
- "Dive data"
summary: Get dive info for binlog
description: |
Returns extended meta data for the requested log. This endpoint is mostly useful for Blunux
< 3.3, as the dive info is included with the output of the /logs endpoint from 3.3 and
onwards.
parameters:
- name: logname
in: path
description: Name of the log to download info for
required: true
schema:
type: string
example: BYEDP070018_ea9add4d0c1961d4_00388
responses:
"200":
description: Dive info
content:
application/json:
schema:
$ref: "#/components/schemas/DiveInfo"
x-codeSamples:
- lang: "curl"
source: |
# To get info for log with name BYEDP070018_ea9add4d0c1961d4_00388
curl -X GET "http://192.168.1.101/logs/BYEDP070018_ea9add4d0c1961d4_00388/dive_info"
- lang: "Python"
source: |
import requests
logname = "BYEDP070018_ea9add4d0c1961d4_00388"
response = requests.get(f"http://192.168.1.101/logs/{logname}/dive_info")
print(response.json())
/logcsv:
get:
tags:
- "Dive data"
summary: Array of logs
description: |
Returns an array of logs from the drone. Each array item represents an available log file on
the drone. Use the /logcsv/{filename} endpoint to get the full log.
parameters:
- name: all
in: query
description: |
Add `all` to the parameter list to show logs that are not classified as dives (no auto
functions enabled, and max depth < 0.25m). All logs will be shown regardless of the
content of the all parameter (even false, 0, etc).
required: false
schema:
type: any
- name: filter_depth_min_mm
in: query
description: |
Filter the minimum depth of the listed logs. Will be ignored if `all` is included in
parameter list.
required: false
schema:
type: integer
example: 1000
default: 250
responses:
"200":
description: Array of logs
content:
application/json:
schema:
type: array
items:
$ref: "#/components/schemas/Log"
x-codeSamples:
- lang: "curl"
source: |
curl -X GET "http://192.168.1.101/logcsv"
- lang: "Python"
source: |
import requests
response = requests.get("http://192.168.1.101/logcsv")
print(response.json())
/logcsv/{filename}:
get:
tags:
- "Dive data"
summary: CSV log-file
description: Downloads a comma-separated-value (CSV) log-file with the requested name.
parameters:
- name: filename
in: path
description: Filename of log to download
required: true
schema:
type: string
- name: divisor
in: query
description: Divisor to use when downsampling CSV before downloading. Set to 1 to get max resolution.
required: false
schema:
type: integer
example: 1
default: 10
responses:
"200":
description: Comma-separated-value file with log data
content:
text/csv:
schema:
type: string
x-codeSamples:
- lang: "curl"
source: |
# To get log with filename ea9ac92e1817a1d4-00090.csv
curl -X GET "http://192.168.1.101/logcsv/ea9ac92e1817a1d4-00090.csv"
- lang: "Python"
source: |
import requests
logname = "ea9ac92e1817a1d4-00090.csv"
response = requests.get(f"http://192.168.1.101/logcsv/{logname}")
with open(logname, "wb") as f:
f.write(response.content)
/logcsv/binary_logs.zip:
get:
tags:
- "Dive data"
summary: "Zipped CSV log files"
description: "Download all CSV log files as a zlib compressed zip file"
responses:
"200":
description:
content:
application/zip:
schema:
type: file
x-codeSamples:
- lang: "curl"
source: |
curl -X GET "http://192.168.1.101/logcsv/binary_logs.zip"
- lang: "Python"
source: |
import requests
response = requests.get(f"http://192.168.1.101/logcsv/binary_logs.zip")
with open(logname, "wb") as f:
f.write(response.content)
/agisoft:
get:
tags:
- "Dive data"
summary: Download CSV file with data for creating scaled 3D models
description: |
Download CSV file with data for creating scaled 3D models in Agisoft
parameters:
- name: file
in: query
description: "Name of the video file to download data for"
required: true
schema:
type: string
example: "video_BYEDP123456_2019-01-01_000001.mp4"
- name: frame-step
in: query
description: "Amout of steps between each frame grab"
required: false
schema:
type: integer
example: "20"
- name: mag-dist
in: query
description: |
Expected compass variance induced from magnetic disturbance in degrees.
The most important data for an accurate 3D model are roll and pitch, which are not
affected by magnetic disturbance, so the default is set quite high (180). If you trust
that the data has not been skewed by magnetic interference you can set this to a
medium (60) or even low (10) value.
required: false
schema:
type: integer
default: "180"
minimum: 1
maximum: 360
example: 180
responses:
"200":
description: Comma-separated-value file with log data
content:
text/csv:
schema:
type: string
x-codeSamples:
- lang: "curl"
source: |
# To get log CSV for videofile video_BYEDP123456_2019-01-01_000001.mp4
curl -X GET "http://192.168.1.101/agisoft \
-d "file=video_BYEDP123456_2019-01-01_000001.mp4"
- lang: "Python"
source: |
import requests
fileName = "video_BYEDP123456_2019-01-01_000001"
parameters = {
"file": f"{fileName}.mp4"
}
response = requests.get(f"http://192.168.1.101/agisoft" params=parameters)
with open(f"{fileName}.csv", "wb") as f:
f.write(response.content)
/srt:
get:
tags:
- "Subtitles"
summary: Download subtitle file
description: |
Downloads a subtitle file (srt) for a video file containing log data from the dive. The data
is gathered from the videos accompanying logfile. By passing in varius queries it is
possible to select which data one wants displayed, and where to display it.
parameters:
- name: file
in: query
description: "Name of the videofile to download subtitle file for."
required: true
schema:
type: string
example: "video_BYEDP123456_2019-01-01_000001.mp4"
- name: title
in: query
description: "Title of the video."
required: false
schema:
type: string
default: ""
- name: length-units
in: query
description: Unit to use for depth. Use "meter" for metric units, and "feet" for imperial.
required: false
schema:
type: string
default: "meter"
enum:
- "meter"
- "feet"
- name: temp-units
in: query
description: |
Unit to use for temperature. Use "celsius" for metric units, and "fahrenheit" for
imperial.
required: false
schema:
type: string
default: "celsius"
- name: placement
in: query
description: |
Where to place the subtitle. Use "top" for placing on the top, "bottom" for placing on
the bottom, and "" for using the player default.
required: false
schema:
type: string
default: "top"
enum:
- "top"
- "bottom"
- ""
- name: field-date
in: query
description: Enable or disable the date field. "1" to enable, "0" to disable.
required: false
schema:
type: integer
default: 0
enum:
- 0
- 1
- name: field-depth
in: query
description: Enable or disable the depth field. "1" to enable, "0" to disable.
required: false
schema:
type: integer
default: 1
enum:
- 0
- 1
- name: field-heading
in: query
description: Enable or disable the heading field. "1" to enable, "0" to disable.
required: false
schema:
type: integer
default: 1
enum:
- 0
- 1
- name: field-temp
in: query
description: Enable or disable the temperature field. "1" to enable, "0" to disable.
required: false
schema:
type: integer
default: 1
enum:
- 0
- 1
- name: date-format
in: query
description: "Format of the date/time."
required: false
schema:
type: string
default: "%Y-%m-%d %H:%M:%S"
externalDocs:
description: Python3 documentation for datetime formatting
url: https://docs.python.org/3/library/datetime.html#strftime-strptime-behavior
- name: tz-offset
in: query
description: |
The drone stores all time in UTC+0, so if you were diving in another timezone and want
to correct for that in the displayed time you can add a timezone offset here. The unit
is minutes and both positive and negative values are supported.
required: false
schema:
type: integer
default: 0
format: int32
- name: format
in: query
description: |
Subtitles can also be retrived in the WEBVTT format. Use format=vtt to get a .vtt file instead of a .srt file.
required: false
schema:
type: string
default: "srt"
enum:
- "srt"
- "vtt"
responses:
"200":
description: Subtitle file for the requested video file
content:
text/srt:
schema:
type: object
x-codeSamples:
- lang: "curl"
source: |
curl -X GET -G "http://192.168.1.101/srt" \
-d "file=video_BYEDP123456_2019-01-01_000001.mp4" \
-d "title=My title"
- lang: "Python"
source: |
import requests
videoName = "video_BYEDP123456_2019-01-01_000001"
parameters = {
"file": f"{videoName}.mp4",
"title": "My title"
}
response = requests.get("http://192.168.1.101/srt", params=parameters)
with open(f"{videoName}.srt", "wb") as f:
f.write(response.content)
/picture:
get:
tags:
- "Pictures"
summary: Download pictures
description: |
Downloads a picture (jpg) if get param filename is specified. If no parameter is set you'll get a list of all images.
parameters:
- name: file
in: query
description: "Name of the image file to download"
required: false
schema:
type: string
example: "picture_BYEDP123456_2019-01-01_000001.001.jpg"
- name: logo
in: query
description: "Add logo to picture. 0 = No logo, 1 = Drone default logo, 2 = User uploaded logo"
required: false
schema:
type: integer
example: "2"
- name: tz-offset
in: query
description: |
Add timezone offset to the picture EXIF data in minutes, can also be negative number.
For example in Norway during summer time the correct value would be 60, while it would be -180 in Chile
required: false
schema:
type: integer
example: "-180"
responses:
"200":
description: Picture
content:
application/json:
schema:
type: array
items:
$ref: "#/components/schemas/Picture"
image/jpeg:
schema:
type: object
x-codeSamples:
- lang: "curl"
source: |
curl -X GET -G "http://192.168.1.101/picture" \
-d "file=picture_BYEDP123456_2019-01-01_000001.001.jpg"
- lang: "Python"
source: |
import requests
videoName = "picture_BYEDP123456_2019-01-01_000001.001"
parameters = {
"file": f"{pictureName}.jpg"
}
response = requests.get("http://192.168.1.101/picture", params=parameters)
with open(f"{pictureName}.jpg", "wb") as f:
f.write(response.content)
/picture/thumbnail:
get:
tags:
- "Pictures"
summary: Download a thumbnail of a picture
description: |
Downloads a picture (jpg) with EXIF metadata from when the photo was captured.
parameters:
- name: file
in: query
description: "Name of the image file to download"
required: true
schema:
type: string
example: "picture_BYEDP123456_2019-01-01_000001.001.jpg"
- name: width
in: query
description: "Width of the thumbnail in pixels."
required: false
schema:
type: integer
default: 1024
- name: height
in: query
description: "Height of the thumbnail in pixels."
required: false
schema:
type: integer
default: 576
- name: quality
in: query
description: "JPG compression level, 0-100. 100 is best quality, 0 is worst quality."
required: false
schema:
type: integer
default: 85
responses:
"200":
description: Picture thumbnail
content:
image/jpeg:
schema:
type: object
x-codeSamples:
- lang: "curl"
source: |
curl -X GET -G "http://192.168.1.101/picture/thumbnail" \
-d "file=picture_BYEDP123456_2019-01-01_000001.001.jpg"
- lang: "Python"
source: |
import requests
pictureName = "picture_BYEDP123456_2019-01-01_000001.001"
parameters = {
"file": f"{pictureName}.jpg",
}
response = requests.get("http://192.168.1.101/picture/thumbnail", params=parameters)
with open(f"{pictureName}.jpg", "wb") as f:
f.write(response.content)
/picture/overlay:
get:
tags:
- "Pictures"
summary: Download pictures with metadata overlay
description: |
Downloads a picture (jpg) with metadata from when the photo was captured.
parameters:
- name: file
in: query
description: "Name of the image file to download"
required: true
schema:
type: string
example: "picture_BYEDP123456_2019-01-01_000001.001.jpg"
- name: title
in: query
description: "Title of the image."
required: false
schema:
type: string
default: ""
- name: subtitle
in: query
description: "Subtitle of the image"
required: false
schema:
type: string
default: ""
- name: length-units
in: query
description: |
Unit to use for all distance/length measurements such as depth, altitude, distance etc.
For shorter lengths `mm` or `inches` will be used accordingly.
* `meter` - Metric unit
* `feet` - Imperial unit
required: false
schema:
type: string
default: "meter"
- name: temp-units
in: query
description: |
Unit to use for the temperature field and any temperature related measurements.
* `celsius` - Metric unit
* `fahrenheit` - Imperial unit
required: false
schema:
type: string
default: "celsius"
- name: field-date
in: query
description: |
Enable or disable the date field.
* `1` - Enable
* `0` - Disable
required: false
schema:
type: integer
default: 1
enum:
- 0
- 1
- name: field-depth
in: query
description: |
Display water depth in the image overlay.
* `1` - Enable
* `0` - Disable
required: false
schema:
type: integer
default: 1
enum:
- 0
- 1
- name: field-heading
in: query
description: |
Display compass heading in the image overlay.
* `1` - Enable
* `0` - Disable
required: false
schema:
type: integer
default: 1
enum:
- 0
- 1
- name: field-temp
in: query
description: |
Display water temperature in the image overlay.
* `1` - Enable
* `0` - Disable
required: false
schema:
type: integer
default: 1
enum:
- 0
- 1
- name: field-tilt
in: query
description: |
Display camera tilt angle in the image overlay.
* `1` - Enable
* `0` - Disable
required: false
schema:
type: integer
default: 0
enum:
- 0
- 1
- name: date-format
in: query
description: "Format of the date/time."
required: false
schema:
type: string
default: "%Y-%m-%d %H:%M:%S"
externalDocs:
description: Python3 documentation for datetime formatting
url: https://docs.python.org/3/library/datetime.html#strftime-strptime-behavior
- name: tz-offset
in: query
description: |
The drone stores all time in UTC+0, so if you were diving in another timezone and want
to correct for that in the displayed time you can add a timezone offset here. The unit
is minutes and both positive and negative values are supported.
required: false
schema:
type: integer
default: 0
example: "60"
format: int32
- name: logo
in: query
description: |
Which logo to overlay.
* `0` - No logo
* `1` - Drone default logo
* `2` - User uploaded logo
required: false
schema:
type: integer
default: 0
enum: [0, 1, 2]
- name: ignore-exif-titles
in: query
description: |
Ignore title and subtitle set by the app during the dive. If `title` and `subtitle` is
not specified, the title and/or subtitle selected for the video overlay will be written
unless this parameter is enabled.
* `1` - Ignore exif titles
* `0` - Use title from exif
required: false
schema:
type: integer
default: 0
enum: [0, 1]
- name: field-guestport
in: query
description: |
Display data from connected guestport sensors in the image overlay.
* `1` - Enable
* `0` - Disable
required: false
schema:
type: integer
default: 1
enum: [0, 1]
- name: field-gps
in: query
description: |
Display GPS coordinates (decimal degrees) in the image overlay.
Requires Blunux 3.0 or newer.
If a positioning system is used, the coordinates of the drone is shown, else the operator
position reported by the app is shown.
* `1` - Enable
* `0` - Disable
required: false
schema:
type: integer
default: 0
enum: [0, 1]
responses:
"200":
description: Picture with overlay metadata
content:
image/jpeg:
schema:
type: object
x-codeSamples:
- lang: "curl"
source: |
curl -X GET -G "http://192.168.1.101/picture/overlay" \
-d "file=picture_BYEDP123456_2019-01-01_000001.001.jpg" \
- lang: "Python"
source: |
import requests
pictureName = "picture_BYEDP123456_2019-01-01_000001.001"
parameters = {
"file": f"{pictureName}.jpg",
}
response = requests.get("http://192.168.1.101/picture/overlay", params=parameters)
with open(f"{pictureName}_overlay.jpg", "wb") as f:
f.write(response.content)
/asset/logo:
post:
tags:
- "Pictures"
summary: Upload logo
description: |
Upload user selectable logo for watermarking videos and pictures.
Allowed filetype: JPG or PNG. Max resolution: 2000px. Max file size: 5MB.
parameters:
- name: image
in: query
description: "JPG or PNG, <5MB, <2000px"
required: true
content:
image:
schema:
type: object
responses:
"200":
description: Upload sucessful
content:
text/html:
schema:
type: string
description: Image upload successful!
"400":
description: Upload failed
content:
text/html:
schema:
oneOf:
- $ref: "#/components/schemas/FileNotPresent"
- $ref: "#/components/schemas/FileSizeTooLarge"
- $ref: "#/components/schemas/ImageIsCorrupt"
- $ref: "#/components/schemas/ImageIsInvalid"
- $ref: "#/components/schemas/ImageResolutionTooHigh"
x-codeSamples:
- lang: "curl"
source: |
curl -X POST "http://192.168.1.101/asset/logo" --form 'image=@"logo.png"'
- lang: "Python"
source: |
import requests
url = "http://192.168.1.101/asset/logo"
files=[
('image', ('logo.png', open('logo.png', 'rb'), 'image/png'))
]
response = requests.post(url, files=files)
print(response.text)
get:
tags:
- "Pictures"
summary: Download logo
description: |
Download the original user uploaded logo (PNG or JPG)
responses:
"200":
description: Logo as an image file PNG/JPG
content:
image/png:
schema:
type: object
image/jpeg:
schema:
type: object
"404":
description: No logo found
content:
text/html:
schema:
type: string
description: No custom logo found!
x-codeSamples:
- lang: "curl"
source: |
curl -X GET "http://192.168.1.101/asset/logo"
- lang: "Python"
source: |
import requests
response = requests.get("http://192.168.1.101/asset/logo")
with open("logo.png", "wb") as f:
f.write(response.content)
delete:
tags:
- "Pictures"
summary: Delete logo
description: |
Delete the uploaded logo
responses:
"200":
description: Deletes the uploaded logo file
content:
text/html:
schema:
oneOf:
- $ref: "#/components/schemas/LogoDeleted"
- $ref: "#/components/schemas/NoLogoToDelete"
x-codeSamples:
- lang: "curl"
source: |
curl -X DELETE "http://192.168.1.101/asset/logo"
- lang: "Python"
source: |
import requests
response = requests.delete("http://192.168.1.101/asset/logo")
print(response.text)
/asset/logo/md5:
get:
tags:
- "Pictures"
summary: Get logo md5sum
description: |
Returns uploaded logo md5sum
responses:
"200":
description: A JSON with the user defined logo MD5 checksum
content:
application/json:
schema:
$ref: "#/components/schemas/Md5"
"404":
description: No custom logo found!
content:
text/html:
schema:
type: string
description: No custom logo found!
x-codeSamples:
- lang: "curl"
source: |
curl -X GET "http://192.168.1.101/asset/logo/md5"
- lang: "Python"
source: |
import requests
response = requests.get("http://192.168.1.101/asset/logo/md5")
print(response.json())
/surface_unit/version:
get:
tags:
- "Surface unit"
summary: Get current version(s)
description: Get version of update file stored on drone and the version installed on the surface unit
responses:
"200":
description: A JSON with the version of the update file stored on the drone and the version installed on the surface unit
content: