MYNT-EYE-S-SDK/spec_contorl_api.html

158 lines
13 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"/>
<title>MYNT EYE SDK: 控制 API 说明</title>
<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
&#160;<span id="projectnumber">2.0.0-rc</span>
</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=""/>
<input type="text" id="MSearchField" value="搜索" 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 -->
<!-- 制作者 Doxygen 1.8.14 -->
<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,'搜索');
/* @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_contorl_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>
<div class="header">
<div class="headertitle">
<div class="title">控制 API 说明 </div> </div>
</div><!--header-->
<div class="contents">
<div class="textblock"><p>控制有两种实现方式,一是通过 UVC 标准协议,二是通过 UVC 拓展通道自定义协议。</p>
<h2>标准协议</h2>
<table class="markdownTable">
<tr class="markdownTableHead">
<th class="markdownTableHeadLeft">名称 </th><th class="markdownTableHeadLeft">字段 </th><th class="markdownTableHeadLeft">字节数 </th><th class="markdownTableHeadLeft">默认值 </th><th class="markdownTableHeadLeft">最小值 </th><th class="markdownTableHeadLeft">最大值 </th><th class="markdownTableHeadLeft">是否储存 </th><th class="markdownTableHeadLeft">Flash 地址 </th><th class="markdownTableHeadLeft">说明 </th></tr>
<tr class="markdownTableBody" class="markdownTableRowOdd">
<td class="markdownTableBodyLeft">增益 </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">关闭自动曝光,手动设定的参数 </td></tr>
<tr class="markdownTableBody" class="markdownTableRowEven">
<td class="markdownTableBodyLeft">亮度 </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">关闭自动曝光,手动设定的参数 </td></tr>
<tr class="markdownTableBody" class="markdownTableRowOdd">
<td class="markdownTableBodyLeft">对比度 </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"></td></tr>
</table>
<blockquote class="doxtable">
<p>UVC 标准协议实现的控制,有现成的 API 进行 Get &amp; Set ,包括 Min, Max, Default 。 </p>
</blockquote>
<h2>自定义协议</h2>
<table class="markdownTable">
<tr class="markdownTableHead">
<th class="markdownTableHeadLeft">名称 </th><th class="markdownTableHeadLeft">字段 </th><th class="markdownTableHeadLeft">字节数 </th><th class="markdownTableHeadLeft">默认值 </th><th class="markdownTableHeadLeft">最小值 </th><th class="markdownTableHeadLeft">最大值 </th><th class="markdownTableHeadLeft">是否储存 </th><th class="markdownTableHeadLeft">Flash 地址 </th><th class="markdownTableHeadLeft">所属通道 </th><th class="markdownTableHeadLeft">通道地址 </th><th class="markdownTableHeadLeft">说明 </th></tr>
<tr class="markdownTableBody" class="markdownTableRowOdd">
<td class="markdownTableBodyLeft">图像帧率 </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">0x0100 </td><td class="markdownTableBodyLeft">步进为5即有效值为{10,15,20,25,30,35,40,45,50,55,60} </td></tr>
<tr class="markdownTableBody" class="markdownTableRowEven">
<td class="markdownTableBodyLeft">IMU 频率 </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">0x0100 </td><td class="markdownTableBodyLeft">有效值为{100,200,250,333,500} </td></tr>
<tr class="markdownTableBody" class="markdownTableRowOdd">
<td class="markdownTableBodyLeft">曝光模式 </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">0x0100 </td><td class="markdownTableBodyLeft">0开启自动曝光 1关闭 </td></tr>
<tr class="markdownTableBody" class="markdownTableRowEven">
<td class="markdownTableBodyLeft">最大增益 </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">0x0100 </td><td class="markdownTableBodyLeft">开始自动曝光,可设定的阈值 </td></tr>
<tr class="markdownTableBody" class="markdownTableRowOdd">
<td class="markdownTableBodyLeft">最大曝光时间 </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">0x0100 </td><td class="markdownTableBodyLeft">开始自动曝光,可设定的阈值 </td></tr>
<tr class="markdownTableBody" class="markdownTableRowEven">
<td class="markdownTableBodyLeft">期望亮度 </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">0x0100 </td><td class="markdownTableBodyLeft"></td></tr>
<tr class="markdownTableBody" class="markdownTableRowOdd">
<td class="markdownTableBodyLeft">IR 控制 </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">0x0100 </td><td class="markdownTableBodyLeft"></td></tr>
<tr class="markdownTableBody" class="markdownTableRowEven">
<td class="markdownTableBodyLeft">HDR 模式 </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">0x0100 </td><td class="markdownTableBodyLeft">010-bit112-bit </td></tr>
<tr class="markdownTableBody" class="markdownTableRowOdd">
<td class="markdownTableBodyLeft">零漂标定 </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">0x0200 </td><td class="markdownTableBodyLeft"></td></tr>
<tr class="markdownTableBody" class="markdownTableRowEven">
<td class="markdownTableBodyLeft">擦除芯片 </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">0x0200 </td><td class="markdownTableBodyLeft"></td></tr>
</table>
</div></div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="footer">制作者
<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>