MYNT-EYE-S-SDK/spec_imu_data.html

174 lines
10 KiB
HTML
Raw Normal View History

2018-06-10 10:49:12 +03:00
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.14"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
2018-07-17 17:16:48 +03:00
<title>MYNT EYE SDK: IMU Data</title>
2018-06-10 10:49:12 +03:00
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(document).ready(initResizable);
/* @license-end */</script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function() { init_search(); });
/* @license-end */
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="custom.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectlogo"><img alt="Logo" src="icon.png"/></td>
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">MYNT EYE SDK
2018-10-22 17:21:29 +03:00
&#160;<span id="projectnumber">2.2.1-rc</span>
2018-06-10 10:49:12 +03:00
</div>
<div id="projectbrief">http://www.myntai.com/camera</div>
</td>
<td> <div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<img id="MSearchSelect" src="search/mag_sel.png"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
2018-07-17 17:16:48 +03:00
<input type="text" id="MSearchField" value="Search" accesskey="S"
2018-06-10 10:49:12 +03:00
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
2018-07-17 17:16:48 +03:00
<!-- Generated by Doxygen 1.8.14 -->
2018-06-10 10:49:12 +03:00
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
2018-07-17 17:16:48 +03:00
var searchBox = new SearchBox("searchBox", "search",false,'Search');
2018-06-10 10:49:12 +03:00
/* @license-end */
</script>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function(){initNavTree('spec_imu_data.html','');});
/* @license-end */
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div class="header">
<div class="headertitle">
2018-07-17 17:16:48 +03:00
<div class="title">IMU Data </div> </div>
2018-06-10 10:49:12 +03:00
</div><!--header-->
<div class="contents">
2018-07-17 17:16:48 +03:00
<div class="textblock"><h2>IMU Request Packet</h2>
2018-06-10 10:49:12 +03:00
<table class="markdownTable">
<tr class="markdownTableHead">
<th class="markdownTableHeadLeft">Name </th><th class="markdownTableHeadLeft">Header </th><th class="markdownTableHeadLeft">Serial Number </th></tr>
<tr class="markdownTableBody" class="markdownTableRowOdd">
2018-07-17 17:16:48 +03:00
<td class="markdownTableBodyLeft">Bytes </td><td class="markdownTableBodyLeft">1 </td><td class="markdownTableBodyLeft">4 </td></tr>
2018-06-10 10:49:12 +03:00
<tr class="markdownTableBody" class="markdownTableRowEven">
2018-07-17 17:16:48 +03:00
<td class="markdownTableBodyLeft">Type </td><td class="markdownTableBodyLeft">uint8_t </td><td class="markdownTableBodyLeft">uint32_t </td></tr>
2018-06-10 10:49:12 +03:00
<tr class="markdownTableBody" class="markdownTableRowOdd">
2018-07-17 17:16:48 +03:00
<td class="markdownTableBodyLeft">Description </td><td class="markdownTableBodyLeft">0x5A </td><td class="markdownTableBodyLeft">First request should be 0, otherwise the last one </td></tr>
2018-06-10 10:49:12 +03:00
</table>
2018-07-17 17:16:48 +03:00
<h2>IMU Response Packet</h2>
<p>The IMU response packet contains multiple IMU packets, and each IMU packet contains multiple IMU segments.</p>
2018-06-10 10:49:12 +03:00
<table class="markdownTable">
<tr class="markdownTableHead">
<th class="markdownTableHeadLeft">Name </th><th class="markdownTableHeadLeft">Header </th><th class="markdownTableHeadLeft">State </th><th class="markdownTableHeadLeft">Size </th><th class="markdownTableHeadLeft">IMU Packets </th><th class="markdownTableHeadLeft">Checksum </th></tr>
<tr class="markdownTableBody" class="markdownTableRowOdd">
2018-07-17 17:16:48 +03:00
<td class="markdownTableBodyLeft">Bytes </td><td class="markdownTableBodyLeft">1 </td><td class="markdownTableBodyLeft">1 </td><td class="markdownTableBodyLeft">2 </td><td class="markdownTableBodyLeft">... </td><td class="markdownTableBodyLeft">1 </td></tr>
2018-06-10 10:49:12 +03:00
<tr class="markdownTableBody" class="markdownTableRowEven">
2018-07-17 17:16:48 +03:00
<td class="markdownTableBodyLeft">Type </td><td class="markdownTableBodyLeft">uint8_t </td><td class="markdownTableBodyLeft">uint8_t </td><td class="markdownTableBodyLeft">uint16_t </td><td class="markdownTableBodyLeft">- </td><td class="markdownTableBodyLeft">uint8_t </td></tr>
2018-06-10 10:49:12 +03:00
<tr class="markdownTableBody" class="markdownTableRowOdd">
2018-07-17 17:16:48 +03:00
<td class="markdownTableBodyLeft">Description </td><td class="markdownTableBodyLeft">0x5B </td><td class="markdownTableBodyLeft">0 is success, others are failed </td><td class="markdownTableBodyLeft">Content size </td><td class="markdownTableBodyLeft">IMU packets </td><td class="markdownTableBodyLeft">Checksum, XOR of all content bytes </td></tr>
2018-06-10 10:49:12 +03:00
</table>
2018-07-17 17:16:48 +03:00
<h3>IMU Packet</h3>
<p>The IMU packet is an array of IMU datas.</p>
2018-06-10 10:49:12 +03:00
<table class="markdownTable">
<tr class="markdownTableHead">
<th class="markdownTableHeadLeft">Name </th><th class="markdownTableHeadLeft">Serial Number </th><th class="markdownTableHeadLeft">Timestamp </th><th class="markdownTableHeadLeft">Count </th><th class="markdownTableHeadLeft">IMU Datas </th></tr>
<tr class="markdownTableBody" class="markdownTableRowOdd">
2018-07-17 17:16:48 +03:00
<td class="markdownTableBodyLeft">Bytes </td><td class="markdownTableBodyLeft">4 </td><td class="markdownTableBodyLeft">4 </td><td class="markdownTableBodyLeft">1 </td><td class="markdownTableBodyLeft">... </td></tr>
2018-06-10 10:49:12 +03:00
<tr class="markdownTableBody" class="markdownTableRowEven">
2018-07-17 17:16:48 +03:00
<td class="markdownTableBodyLeft">Type </td><td class="markdownTableBodyLeft">uint32_t </td><td class="markdownTableBodyLeft">uint32_t </td><td class="markdownTableBodyLeft">uint8_t </td><td class="markdownTableBodyLeft">- </td></tr>
2018-06-10 10:49:12 +03:00
<tr class="markdownTableBody" class="markdownTableRowOdd">
2018-07-17 17:16:48 +03:00
<td class="markdownTableBodyLeft">Description </td><td class="markdownTableBodyLeft">Serial number </td><td class="markdownTableBodyLeft">IMU basic timestamp </td><td class="markdownTableBodyLeft">The number of IMU datas </td><td class="markdownTableBodyLeft">IMU datas </td></tr>
2018-06-10 10:49:12 +03:00
</table>
2018-07-17 17:16:48 +03:00
<h3>IMU Segment</h3>
2018-06-10 10:49:12 +03:00
<table class="markdownTable">
<tr class="markdownTableHead">
2018-07-17 17:16:48 +03:00
<th class="markdownTableHeadLeft">Name </th><th class="markdownTableHeadLeft">Offset </th><th class="markdownTableHeadLeft">Frame ID </th><th class="markdownTableHeadLeft">Accelerometer </th><th class="markdownTableHeadLeft">Temperature </th><th class="markdownTableHeadLeft">Gyroscope </th></tr>
2018-06-10 10:49:12 +03:00
<tr class="markdownTableBody" class="markdownTableRowOdd">
2018-07-17 17:16:48 +03:00
<td class="markdownTableBodyLeft">Bytes </td><td class="markdownTableBodyLeft">2 </td><td class="markdownTableBodyLeft">2 </td><td class="markdownTableBodyLeft">6 </td><td class="markdownTableBodyLeft">2 </td><td class="markdownTableBodyLeft">6 </td></tr>
2018-06-10 10:49:12 +03:00
<tr class="markdownTableBody" class="markdownTableRowEven">
2018-07-17 17:16:48 +03:00
<td class="markdownTableBodyLeft">Type </td><td class="markdownTableBodyLeft">int16_t </td><td class="markdownTableBodyLeft">uint16_t </td><td class="markdownTableBodyLeft">int16_t * 3 </td><td class="markdownTableBodyLeft">int16_t </td><td class="markdownTableBodyLeft">int16_t * 3 </td></tr>
2018-06-10 10:49:12 +03:00
<tr class="markdownTableBody" class="markdownTableRowOdd">
2018-07-17 17:16:48 +03:00
<td class="markdownTableBodyLeft">Description </td><td class="markdownTableBodyLeft">The timestamp offset </td><td class="markdownTableBodyLeft">Image frame ID </td><td class="markdownTableBodyLeft">Accel x,y,z values </td><td class="markdownTableBodyLeft">IMU temperature </td><td class="markdownTableBodyLeft">Gyro x,y,z values </td></tr>
2018-06-10 10:49:12 +03:00
</table>
<ul>
2018-07-17 17:16:48 +03:00
<li>Formula for converting the accel &amp; gyro values to real ones: <b>real = data * range / 0x10000</b> .<ul>
<li><code>accel</code> default <code>range</code> is <b>8 g</b>, <code>gyro</code> default <code>range</code> is <b>1000 deg/s</b>.</li>
2018-06-10 10:49:12 +03:00
</ul>
</li>
2018-07-17 17:16:48 +03:00
<li>Formula for converting the temperature to real value: <b>real = data / ratio + offset</b> .<ul>
<li>default <code>ratio</code> is <b>326.8</b>, default <code>offset</code> is <b>25℃</b>. </li>
2018-06-10 10:49:12 +03:00
</ul>
</li>
</ul>
</div></div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
2018-07-17 17:16:48 +03:00
<li class="footer">Generated by
2018-06-10 10:49:12 +03:00
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.14 </li>
</ul>
</div>
</body>
</html>