-
Notifications
You must be signed in to change notification settings - Fork 6
/
index.html
140 lines (133 loc) · 6.65 KB
/
index.html
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
<!DOCTYPE html>
<html>
<head>
<meta name="generator"
content="HTML Tidy for HTML5 (experimental) for Windows https://github.com/w3c/tidy-html5/tree/c63cc39" />
<meta charset="utf-8" />
<meta http-equiv="X-UA-Compatible" content="chrome=1" />
<title>RedEdge API by MicaSense</title>
<link rel="stylesheet" href="stylesheets/styles.css" />
<link rel="stylesheet" href="stylesheets/pygment_trac.css" />
<meta name="viewport" content="width=device-width, initial-scale=1, user-scalable=no" />
<!--[if lt IE 9]>
<script src="//raw.githubusercontent.com/aFarkas/html5shiv/master/dist/html5shiv.min.js"></script>
<![endif]-->
</head>
<body>
<div class="wrapper">
<header>
<h1>RedEdge API</h1>
<p>MicaSense RedEdge camera API documentation and example code.</p>
<ul>
<li>
<a href="#welcome">Introduction</a>
</li>
<li>
<a href="#about-apis">About the APIs</a>
<ul>
<li><a href="#altum-api">Using RedEdge APIs with Altum</a></li>
<li><a href="#http-api">HTTP API</a></li>
<li><a href="#serial-api">Serial API</a></li>
</ul>
</li>
<li>
<a href="#examples">Example Code</a>
</li>
</ul>
</header>
<section>
<h1><a id="welcome" class="anchor" href="#welcome" aria-hidden="true"></a>
Welcome to the RedEdge API page</h1>
<p>The RedEdge camera is designed for quick and easy integration into just about any platform. However, for more control,
you can talk to the RedEdge by serial port, Ethernet, or WiFi.</p>
<p>API documentation indicates what camera firmware versions it is compatible with. We'll always do our best to
<strong>not</strong> break anything with new releases, but sometimes new features may be released that were not present in
older software versions, so it is always best to check your firmware version and note the relevant sections. Of course,
you can always upgrade your camera to the latest firmware! Log on to
<a href="https://atlas.micasense.com/">MicaSense Atlas</a> or
<a href="http://www.micasense.com/contact">contact us</a> for the latest.</p>
<p><strong>Don't know what version you have?</strong> Connect to the camera WiFi, and you can read the version from the
bottom of the 'config' page.</p>
</section>
<section>
<h1><a id="about-apis" class="anchor" href="about-apis" aria-hidden="true"></a>
About the APIs</h1>
<h2><a id="altum-api" class="anchor" href="#altum-api" aria-hidden="true"></a>
Using the RedEdge APIs with Altum</h2>
<p>RedEdge and Altum have different versioning numbers. The version numbers provided in these documents are only applicable
to RedEdge versions. However, the table below shows which RedEdge API versions are compatible with which Altum versions.</p>
<table>
<thead>
<tr>
<th>Altum Versions</th>
<th>Compatible RedEdge API Version</th>
</tr>
</thead>
<tbody>
<tr>
<td>v1.0.0-v1.2.x</td>
<td>v4.1.0</td>
</tr>
<tr>
<td>v1.3.0-v1.3.x</td>
<td>v5.0.0</td>
</tr>
<tr>
<td>v1.4.0</td>
<td>v5.2.0</td>
</tr>
<tr>
<td>v2.0.0</td>
<td>v7.1.0</td>
</tr>
</tbody>
</table>
<h2><a id="http-api" class="anchor" href="#http-api" aria-hidden="true"></a>
HTTP API</h2>
<p>The HTTP API is the most powerful way to interface to the RedEdge. You can use this API using either the Ethernet
connector or the WiFi access point.</p>
<p><a href="api/http.html">Full HTTP API Documentation</a></p>
<h2><a id="serial-api" class="anchor" href="#serial-api" aria-hidden="true"></a>
Serial API</h2>
<p>The Serial API provides a MAVLink interface to the RedEdge. You can use this API by connecting your MAVLink-capable
system to the host serial port on the camera.</p>
<p><a href="api/serial.html">Full Serial API Documentation</a></p>
</section>
<section>
<h1><a id="examples" class="anchor" href="#examples" aria-hidden="true"></a>
Example Code</h1>
<dl>
<dt><a href="examples/mavlink_serial.py">mavlink_serial.py</a></dt>
<dd>An example python program that can be used to verify communication with the RedEdge. A typical use of the script is:
<pre>
<code>python mavlink_serial.py --device /dev/ttyUSB0 --baud 57600</code></pre>
</dd>
<dt><a href="examples/gps_wifi.py">gps_wifi.py</a></dt>
<dd>An example python program that can be used to get the camera's GPS location and command a capture. A typical usage of
the script is:<pre>
<code>python gps_wifi.py</code></pre></dd>
<dt><a href="examples/expandable_storage.py">expandable_storage.py</a></dt>
<dd>An example python program which can be used to store captures from the RedEdge camera to an external storage device using a Raspberry Pi. A typical usage of the script is:<pre>
<code>sudo python expandable_storage.py</code></pre></dd>
<dt><a href="examples/gps_image_insert.py">gps_image_insert.py</a></dt>
<dd>And example python script which takes in an RTKlib output postion file and creates a Pix4D compatible LLH file. A typical usage of this script is:<pre>
<code>python gps_image_insert.py create_image_location_file --input_path raw_flight_date_events.pos --output_path image_location.csv</code></pre></dd>
</dl>
</section>
<footer>
<img src="./images/MicaSense_Logo_clr.png" title="MicaSense" />
</footer>
</div>
<script src="javascripts/scale.fix.js"></script>
<script type="text/javascript">
var gaJsHost = (("https:" == document.location.protocol) ? "https://ssl." : "http://www.");
document.write(unescape("%3Cscript src='" + gaJsHost + "google-analytics.com/ga.js'
type='text/javascript'%3E%3C/script%3E"));
</script>
<script type="text/javascript">
try {
var pageTracker = _gat._getTracker("UA-50862965-2");
pageTracker._trackPageview();
} catch(err) {}
</script></body>
</html>