MYNT-EYE-S-SDK/spec_control_api.html

156 lines
12 KiB
HTML
Raw Permalink Normal View History

2019-02-22 15:17:50 +02:00
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
2018-07-17 17:16:48 +03:00
<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"/>
2019-02-22 15:17:50 +02:00
<meta name="generator" content="Doxygen 1.8.15"/>
2018-07-17 17:16:48 +03:00
<meta name="viewport" content="width=device-width, initial-scale=1"/>
2018-11-08 17:08:21 +02:00
<title>MYNT EYE S SDK: Control Protocols</title>
2018-07-17 17:16:48 +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;">
2018-11-08 17:08:21 +02:00
<div id="projectname">MYNT EYE S SDK
2019-02-28 03:38:54 +02:00
&#160;<span id="projectnumber">2.3.2</span>
2018-07-17 17:16:48 +03:00
</div>
2018-11-25 07:49:14 +02:00
<div id="projectbrief">http://www.myntai.com/mynteye/standard</div>
2018-07-17 17:16:48 +03:00
</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=""/>
<input type="text" id="MSearchField" value="Search" accesskey="S"
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 -->
2019-02-22 15:17:50 +02:00
<!-- Generated by Doxygen 1.8.15 -->
2018-07-17 17:16:48 +03:00
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search');
/* @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_control_api.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>
2019-02-22 15:17:50 +02:00
<div class="PageDoc"><div class="header">
2018-07-17 17:16:48 +03:00
<div class="headertitle">
<div class="title">Control Protocols </div> </div>
</div><!--header-->
<div class="contents">
<div class="textblock"><p>There are two control modes, one is through UVC standard protocol, the other is through UVC custom protocol with extension unit.</p>
<h2>Standard Protocol</h2>
<table class="markdownTable">
<tr class="markdownTableHead">
<th class="markdownTableHeadLeft">Name </th><th class="markdownTableHeadLeft">Field </th><th class="markdownTableHeadLeft">Bytes </th><th class="markdownTableHeadLeft">Default </th><th class="markdownTableHeadLeft">Min </th><th class="markdownTableHeadLeft">Max </th><th class="markdownTableHeadLeft">Stored </th><th class="markdownTableHeadLeft">Flash Address </th><th class="markdownTableHeadLeft">Note </th></tr>
2019-02-22 15:17:50 +02:00
<tr class="markdownTableRowOdd">
2018-07-17 17:16:48 +03:00
<td class="markdownTableBodyLeft">Gain </td><td class="markdownTableBodyLeft">gain </td><td class="markdownTableBodyLeft">2 </td><td class="markdownTableBodyLeft">24 </td><td class="markdownTableBodyLeft">0 </td><td class="markdownTableBodyLeft">48 </td><td class="markdownTableBodyLeft"></td><td class="markdownTableBodyLeft">0x12 </td><td class="markdownTableBodyLeft">valid if manual-exposure </td></tr>
2019-02-22 15:17:50 +02:00
<tr class="markdownTableRowEven">
2018-07-17 17:16:48 +03:00
<td class="markdownTableBodyLeft">Brightness </td><td class="markdownTableBodyLeft">brightness/exposure_time </td><td class="markdownTableBodyLeft">2 </td><td class="markdownTableBodyLeft">120 </td><td class="markdownTableBodyLeft">0 </td><td class="markdownTableBodyLeft">240 </td><td class="markdownTableBodyLeft"></td><td class="markdownTableBodyLeft">0x14 </td><td class="markdownTableBodyLeft">valid if manual-exposure </td></tr>
2019-02-22 15:17:50 +02:00
<tr class="markdownTableRowOdd">
2018-07-17 17:16:48 +03:00
<td class="markdownTableBodyLeft">Contrast </td><td class="markdownTableBodyLeft">contrast/black_level_calibration </td><td class="markdownTableBodyLeft">2 </td><td class="markdownTableBodyLeft">127 </td><td class="markdownTableBodyLeft">0 </td><td class="markdownTableBodyLeft">255 </td><td class="markdownTableBodyLeft"></td><td class="markdownTableBodyLeft">0x10 </td><td class="markdownTableBodyLeft">valid if manual-exposure </td></tr>
</table>
<h2>Custom Protocol</h2>
2018-10-22 17:21:29 +03:00
<table class="markdownTable">
<tr class="markdownTableHead">
<th class="markdownTableHeadLeft">Name </th><th class="markdownTableHeadLeft">Field </th><th class="markdownTableHeadLeft">Bytes </th><th class="markdownTableHeadLeft">Default </th><th class="markdownTableHeadLeft">Min </th><th class="markdownTableHeadLeft">Max </th><th class="markdownTableHeadLeft">Stored </th><th class="markdownTableHeadLeft">Flash Address </th><th class="markdownTableHeadLeft">Channel </th><th class="markdownTableHeadLeft">Note </th></tr>
2019-02-22 15:17:50 +02:00
<tr class="markdownTableRowOdd">
2018-10-22 17:21:29 +03:00
<td class="markdownTableBodyLeft">Frame rate </td><td class="markdownTableBodyLeft">frame_rate </td><td class="markdownTableBodyLeft">2 </td><td class="markdownTableBodyLeft">25 </td><td class="markdownTableBodyLeft">10 </td><td class="markdownTableBodyLeft">60 </td><td class="markdownTableBodyLeft"></td><td class="markdownTableBodyLeft">0x21 </td><td class="markdownTableBodyLeft">XU_CAM_CTRL </td><td class="markdownTableBodyLeft">values: {10,15,20,25,30,35,40,45,50,55,60} </td></tr>
2019-02-22 15:17:50 +02:00
<tr class="markdownTableRowEven">
2018-10-22 17:21:29 +03:00
<td class="markdownTableBodyLeft">IMU frequency </td><td class="markdownTableBodyLeft">imu_frequency </td><td class="markdownTableBodyLeft">2 </td><td class="markdownTableBodyLeft">200 </td><td class="markdownTableBodyLeft">100 </td><td class="markdownTableBodyLeft">500 </td><td class="markdownTableBodyLeft"></td><td class="markdownTableBodyLeft">0x23 </td><td class="markdownTableBodyLeft">XU_CAM_CTRL </td><td class="markdownTableBodyLeft">values: {100,200,250,333,500} </td></tr>
2019-02-22 15:17:50 +02:00
<tr class="markdownTableRowOdd">
2018-10-22 17:21:29 +03:00
<td class="markdownTableBodyLeft">Exposure mode </td><td class="markdownTableBodyLeft">exposure_mode </td><td class="markdownTableBodyLeft">1 </td><td class="markdownTableBodyLeft">0 </td><td class="markdownTableBodyLeft">0 </td><td class="markdownTableBodyLeft">1 </td><td class="markdownTableBodyLeft"></td><td class="markdownTableBodyLeft">0x0F </td><td class="markdownTableBodyLeft">XU_CAM_CTRL </td><td class="markdownTableBodyLeft">0: enable auto-exposure; 1: manual-exposure </td></tr>
2019-02-22 15:17:50 +02:00
<tr class="markdownTableRowEven">
2018-10-22 17:21:29 +03:00
<td class="markdownTableBodyLeft">Max gain </td><td class="markdownTableBodyLeft">max_gain </td><td class="markdownTableBodyLeft">2 </td><td class="markdownTableBodyLeft">48 </td><td class="markdownTableBodyLeft">0 </td><td class="markdownTableBodyLeft">48 </td><td class="markdownTableBodyLeft"></td><td class="markdownTableBodyLeft">0x1D </td><td class="markdownTableBodyLeft">XU_CAM_CTRL </td><td class="markdownTableBodyLeft">valid if auto-exposure </td></tr>
2019-02-22 15:17:50 +02:00
<tr class="markdownTableRowOdd">
2018-10-22 17:21:29 +03:00
<td class="markdownTableBodyLeft">Max exposure time </td><td class="markdownTableBodyLeft">max_exposure_time </td><td class="markdownTableBodyLeft">2 </td><td class="markdownTableBodyLeft">240 </td><td class="markdownTableBodyLeft">0 </td><td class="markdownTableBodyLeft">240 </td><td class="markdownTableBodyLeft"></td><td class="markdownTableBodyLeft">0x1B </td><td class="markdownTableBodyLeft">XU_CAM_CTRL </td><td class="markdownTableBodyLeft">valid if auto-exposure </td></tr>
2019-02-22 15:17:50 +02:00
<tr class="markdownTableRowEven">
2018-10-22 17:21:29 +03:00
<td class="markdownTableBodyLeft">Desired brightness </td><td class="markdownTableBodyLeft">desired_brightness </td><td class="markdownTableBodyLeft">2 </td><td class="markdownTableBodyLeft">192 </td><td class="markdownTableBodyLeft">0 </td><td class="markdownTableBodyLeft">255 </td><td class="markdownTableBodyLeft"></td><td class="markdownTableBodyLeft">0x19 </td><td class="markdownTableBodyLeft">XU_CAM_CTRL </td><td class="markdownTableBodyLeft">valid if auto-exposure </td></tr>
2019-02-22 15:17:50 +02:00
<tr class="markdownTableRowOdd">
2018-10-22 17:21:29 +03:00
<td class="markdownTableBodyLeft">IR control </td><td class="markdownTableBodyLeft">ir_control </td><td class="markdownTableBodyLeft">1 </td><td class="markdownTableBodyLeft">0 </td><td class="markdownTableBodyLeft">0 </td><td class="markdownTableBodyLeft">160 </td><td class="markdownTableBodyLeft">× </td><td class="markdownTableBodyLeft">- </td><td class="markdownTableBodyLeft">XU_CAM_CTRL </td><td class="markdownTableBodyLeft"></td></tr>
2019-02-22 15:17:50 +02:00
<tr class="markdownTableRowEven">
2018-10-22 17:21:29 +03:00
<td class="markdownTableBodyLeft">HDR mode </td><td class="markdownTableBodyLeft">hdr_mode </td><td class="markdownTableBodyLeft">1 </td><td class="markdownTableBodyLeft">0 </td><td class="markdownTableBodyLeft">0 </td><td class="markdownTableBodyLeft">1 </td><td class="markdownTableBodyLeft"></td><td class="markdownTableBodyLeft">0x1F </td><td class="markdownTableBodyLeft">XU_CAM_CTRL </td><td class="markdownTableBodyLeft">0: 10-bit; 1: 12-bit </td></tr>
2019-02-22 15:17:50 +02:00
<tr class="markdownTableRowOdd">
2018-10-22 17:21:29 +03:00
<td class="markdownTableBodyLeft">Zero drift calibration </td><td class="markdownTableBodyLeft">zero_drift_calibration </td><td class="markdownTableBodyLeft"></td><td class="markdownTableBodyLeft">- </td><td class="markdownTableBodyLeft">- </td><td class="markdownTableBodyLeft">- </td><td class="markdownTableBodyLeft">× </td><td class="markdownTableBodyLeft">- </td><td class="markdownTableBodyLeft">XU_HALF_DUPLEX </td><td class="markdownTableBodyLeft"></td></tr>
2019-02-22 15:17:50 +02:00
<tr class="markdownTableRowEven">
2018-10-22 17:21:29 +03:00
<td class="markdownTableBodyLeft">Erase chip </td><td class="markdownTableBodyLeft">erase_chip </td><td class="markdownTableBodyLeft"></td><td class="markdownTableBodyLeft">- </td><td class="markdownTableBodyLeft">- </td><td class="markdownTableBodyLeft">- </td><td class="markdownTableBodyLeft">× </td><td class="markdownTableBodyLeft">- </td><td class="markdownTableBodyLeft">XU_HALF_DUPLEX </td><td class="markdownTableBodyLeft"></td></tr>
</table>
2019-02-22 15:17:50 +02:00
</div></div><!-- PageDoc -->
</div><!-- contents -->
2018-07-17 17:16:48 +03:00
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="footer">Generated by
<a href="http://www.doxygen.org/index.html">
2019-02-22 15:17:50 +02:00
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.15 </li>
2018-07-17 17:16:48 +03:00
</ul>
</div>
</body>
</html>