doc/doxygen/output/index.html

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://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=11"/>
<meta name="generator" content="Doxygen 1.9.2"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Agile Console: Agile Console</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="doxygen.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="projectalign" style="padding-left: 0.5em;">
   <div id="projectname">Agile Console<span id="projectnumber">&#160;1.1.0</span>
   </div>
   <div id="projectbrief">Simple debugging device Middleware</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- 制作者 Doxygen 1.9.2 -->
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() {
  initMenu('',false,false,'search.php','搜索');
});
/* @license-end */
</script>
<div id="main-nav"></div>
</div><!-- top -->
<div><div class="header">
  <div class="headertitle"><div class="title">Agile Console </div></div>
</div><!--header-->
<div class="contents">
<div class="textblock"><p ><a class="anchor" id="md_C__Users_25440_Desktop_stm32f407_atk_explorer_packages_agile_console_latest_README"></a> </p>
<h1><a class="anchor" id="autotoc_md4"></a>
1、介绍</h1>
<p >Agile Console 是基于 RT-Thread 的一个简单易用的调试设备中间件。</p>
<ul>
<li>接管 <code>console</code> 设备，支持 <code>device</code> 接口和 <code>posix</code> 接口。</li>
<li>后端实现极其方便，任何接口都可快速接入。</li>
</ul>
<p ><b>注意</b> : 由于 Agile Console 会直接接管 <code>console</code> 设备，建议将 <code>RT-Thread</code> <code>Kernel</code> 中的 <code>RT_CONSOLE_DEVICE_NAME</code> 配置为一个不存在的设备。</p>
<p >Agile Console 目前支持的后端接口如下：</p>
<ul>
<li>串口后端</li>
<li><p class="startli">USB CDC 后端</p>
<p class="startli">使用到 <a href="https://github.com/RT-Thread-packages/tinyusb">tinyusb</a>。</p>
</li>
<li><p class="startli">Telnet 后端</p>
<p class="startli">使用到 <a href="https://github.com/loogg/agile_telnet">agile_telnet</a>。</p>
</li>
</ul>
<h2><a class="anchor" id="autotoc_md5"></a>
1.1、目录结构</h2>
<table class="markdownTable">
<tr class="markdownTableHead">
<th class="markdownTableHeadNone">名称   </th><th class="markdownTableHeadNone">说明    </th></tr>
<tr class="markdownTableRowOdd">
<td class="markdownTableBodyNone">doc   </td><td class="markdownTableBodyNone">文档    </td></tr>
<tr class="markdownTableRowEven">
<td class="markdownTableBodyNone">examples   </td><td class="markdownTableBodyNone">示例    </td></tr>
<tr class="markdownTableRowOdd">
<td class="markdownTableBodyNone">figures   </td><td class="markdownTableBodyNone">素材    </td></tr>
<tr class="markdownTableRowEven">
<td class="markdownTableBodyNone">inc   </td><td class="markdownTableBodyNone">头文件    </td></tr>
<tr class="markdownTableRowOdd">
<td class="markdownTableBodyNone">src   </td><td class="markdownTableBodyNone">源代码   </td></tr>
</table>
<h2><a class="anchor" id="autotoc_md6"></a>
1.2、许可证</h2>
<p >Agile Console package 遵循 LGPLv2.1 许可，详见 <code>LICENSE</code> 文件。</p>
<h2><a class="anchor" id="autotoc_md7"></a>
1.3、依赖</h2>
<ul>
<li>RT-Thread 4.0.3</li>
<li>RT-Thread 4.0.5 ~ master</li>
</ul>
<h1><a class="anchor" id="autotoc_md8"></a>
2、使用 Agile Console</h1>
<ul>
<li>帮助文档请查看 <a href="./doc/doxygen/Agile_Console.chm">doc/doxygen/Agile_Console.chm</a></li>
<li><p class="startli">使用 Agile Console package 需要在 RT-Thread 的包管理器中选择它，具体路径如下：</p>
<div class="fragment"><div class="line">RT-Thread online packages</div>
<div class="line">    peripheral libraries and drivers  ---&gt;</div>
<div class="line">         [*] <a class="code hl_struct" href="structagile__console.html">agile_console</a>: Simple debugging device Middleware.  ---&gt;</div>
<div class="line">            (1024) Set <a class="code hl_struct" href="structagile__console.html">agile_console</a> rx buffer size</div>
<div class="line">            (tty) Set <a class="code hl_struct" href="structagile__console.html">agile_console</a> device name</div>
<div class="line">            (9)  Set <a class="code hl_struct" href="structagile__console.html">agile_console</a> thread priority</div>
<div class="line">            (2048) Set <a class="code hl_struct" href="structagile__console.html">agile_console</a> thread stack size</div>
<div class="line">            [*]   Enable <a class="code hl_struct" href="structagile__console.html">agile_console</a> serial example</div>
<div class="line">            (uart1) Set serial device name</div>
<div class="line">            [*]   Enable telnet plugin</div>
<div class="line">            [*]   Enable tinyusb plugin (RT-Thread 版本 &gt;= 4.1.0)</div>
<div class="line">                  Version (latest)  ---&gt;</div>
<div class="ttc" id="astructagile__console_html"><div class="ttname"><a href="structagile__console.html">agile_console</a></div><div class="ttdoc">Agile Console 结构体</div><div class="ttdef"><b>Definition:</b> <a href="agile__console_8h_source.html#l00043">agile_console.h:43</a></div></div>
</div><!-- fragment --><ul>
<li><b>Set <a class="el" href="structagile__console.html" title="Agile Console 结构体">agile_console</a> rx buffer size</b> ：Agile Console 接受环形缓冲区大小</li>
<li><b>Set <a class="el" href="structagile__console.html" title="Agile Console 结构体">agile_console</a> device name</b> ：Agile Console 设备名</li>
<li><b>Set <a class="el" href="structagile__console.html" title="Agile Console 结构体">agile_console</a> thread priority</b> ：Agile Console 线程优先级</li>
<li><b>Set <a class="el" href="structagile__console.html" title="Agile Console 结构体">agile_console</a> thread stack size</b> ：Agile Console 线程堆栈大小</li>
<li><b>Enable <a class="el" href="structagile__console.html" title="Agile Console 结构体">agile_console</a> serial example</b> ：使能串口例程</li>
<li><b>Set serial device name</b> ：串口设备名</li>
<li><p class="startli"><b>Enable telnet plugin</b> ：使能 telnet 后端插件</p>
<p class="startli">使能后会选中 <a href="https://github.com/loogg/agile_telnet">agile_telnet</a> 软件包。</p>
</li>
<li><p class="startli"><b>Enable tinyusb plugin</b> ：使能 tinyusb 后端插件</p>
<p class="startli">RT-Thread 版本 &gt;= 4.1.0 才有该选项。使能后会选中 <a href="https://github.com/RT-Thread-packages/tinyusb">tinyusb</a> 软件包。</p>
</li>
</ul>
</li>
<li>Doxygen 文档生成<ul>
<li>使用 <code>Doxywizard</code> 打开 <a href="./doc/doxygen/Doxyfile">Doxyfile</a> 运行，生成的文件在 <a href="./doc/doxygen/output">doxygen/output</a> 下。</li>
<li>需要更改 <code>Graphviz</code> 路径。</li>
<li><code>HTML</code> 生成未使用 <code>chm</code> 格式的，如果使能需要更改 <code>hhc.exe</code> 路径。</li>
</ul>
</li>
<li><p class="startli">多后端演示</p>
<p class="startli">演示使用开发板：正点原子探索者</p><ul>
<li><p class="startli">串口、Telnet 和 USB CDC 同时交互演示：</p>
<p class="startli"><img src="./figures/whole.gif" alt="whole" class="inline"/></p>
</li>
<li><p class="startli">USB CDC Ymodem 传输文件</p>
<p class="startli">CDC Fifo 接收大小修改为 1024</p>
<p class="startli">CDC Fifo 发送大小修改为 2048</p>
<p class="startli"><img src="./figures/usb_file.gif" alt="usb_file" class="inline"/></p>
</li>
</ul>
</li>
</ul>
<h1><a class="anchor" id="autotoc_md9"></a>
3、新的后端接入 Agile Console</h1>
<ul>
<li>可以参考 <a href="./examples">examples</a> 文件夹中的例子和 <a href="https://github.com/loogg/agile_telnet">agile_telnet</a> 软件包</li>
<li>USB CDC 后端例子中展示了如何屏蔽输入输出</li>
<li><p class="startli">Agile Console 提供了后端接口结构体定义：</p>
<div class="fragment"><div class="line"> </div>
<div class="line"><span class="keyword">struct </span><a class="code hl_struct" href="structagile__console__backend.html">agile_console_backend</a> {</div>
<div class="line">    void (*<a class="code hl_variable" href="structagile__console__backend.html#a414aa128e511ad511e53b35f7b60e818">output</a>)(rt_device_t dev, <span class="keyword">const</span> uint8_t *buf, <span class="keywordtype">int</span> len); </div>
<div class="line">    int (*<a class="code hl_variable" href="structagile__console__backend.html#a020729f4e30754f939ba556bca583a48">read</a>)(rt_device_t dev, uint8_t *buf, <span class="keywordtype">int</span> len);          </div>
<div class="line">    int (*<a class="code hl_variable" href="structagile__console__backend.html#ab2c886bf05885d6acc2912d62b301c27">control</a>)(rt_device_t dev, <span class="keywordtype">int</span> cmd, <span class="keywordtype">void</span> *arg);          </div>
<div class="line">    rt_slist_t <a class="code hl_variable" href="structagile__console__backend.html#a87d68b1de31ca26ce6864f645a66cde5">slist</a>;                                             </div>
<div class="line">};</div>
<div class="ttc" id="astructagile__console__backend_html"><div class="ttname"><a href="structagile__console__backend.html">agile_console_backend</a></div><div class="ttdoc">Agile Console 后端接口结构体</div><div class="ttdef"><b>Definition:</b> <a href="agile__console_8h_source.html#l00033">agile_console.h:33</a></div></div>
<div class="ttc" id="astructagile__console__backend_html_a020729f4e30754f939ba556bca583a48"><div class="ttname"><a href="structagile__console__backend.html#a020729f4e30754f939ba556bca583a48">agile_console_backend::read</a></div><div class="ttdeci">int(* read)(rt_device_t dev, uint8_t *buf, int len)</div><div class="ttdoc">从后端读取数据接口</div><div class="ttdef"><b>Definition:</b> <a href="agile__console_8h_source.html#l00035">agile_console.h:35</a></div></div>
<div class="ttc" id="astructagile__console__backend_html_a414aa128e511ad511e53b35f7b60e818"><div class="ttname"><a href="structagile__console__backend.html#a414aa128e511ad511e53b35f7b60e818">agile_console_backend::output</a></div><div class="ttdeci">void(* output)(rt_device_t dev, const uint8_t *buf, int len)</div><div class="ttdoc">向后端输出数据接口</div><div class="ttdef"><b>Definition:</b> <a href="agile__console_8h_source.html#l00034">agile_console.h:34</a></div></div>
<div class="ttc" id="astructagile__console__backend_html_a87d68b1de31ca26ce6864f645a66cde5"><div class="ttname"><a href="structagile__console__backend.html#a87d68b1de31ca26ce6864f645a66cde5">agile_console_backend::slist</a></div><div class="ttdeci">rt_slist_t slist</div><div class="ttdoc">单向链表节点</div><div class="ttdef"><b>Definition:</b> <a href="agile__console_8h_source.html#l00037">agile_console.h:37</a></div></div>
<div class="ttc" id="astructagile__console__backend_html_ab2c886bf05885d6acc2912d62b301c27"><div class="ttname"><a href="structagile__console__backend.html#ab2c886bf05885d6acc2912d62b301c27">agile_console_backend::control</a></div><div class="ttdeci">int(* control)(rt_device_t dev, int cmd, void *arg)</div><div class="ttdoc">对后端进行设置接口</div><div class="ttdef"><b>Definition:</b> <a href="agile__console_8h_source.html#l00036">agile_console.h:36</a></div></div>
</div><!-- fragment --></li>
<li>实现一个新的后端并接入 Agile Console 的步骤如下：<ol type="1">
<li>定义后端变量</li>
<li>实现后端的 <code>output</code>、<code>read</code> 和 <code>control</code> 接口<ul>
<li><p class="startli"><code>output</code> 接口</p>
<p class="startli">实现时 <b>不能调用任何可能导致线程挂起的 API</b> 。建议将数据放入 <code>ringbuffer</code> 并创建线程异步发送。</p>
</li>
<li><p class="startli"><code>read</code> 接口</p>
<p class="startli">除了保护资源而使用的互斥锁外，其他引起阻塞的 API 不建议调用。已有的数据存放到数据区后立马返回。</p>
</li>
<li><p class="startli"><code>control</code> 接口</p>
<p class="startli">该接口用作控制后端。除 <code>TCFLSH</code> 命令，其他命令均会调用该接口。可不实现。</p>
</li>
</ul>
</li>
<li>调用 <code>agile_console_backend_register</code> 注册后端</li>
<li>后端收到数据时调用 <code>agile_console_wakeup</code> 唤醒接收线程</li>
</ol>
</li>
</ul>
<h1><a class="anchor" id="autotoc_md10"></a>
4、联系方式 &amp; 感谢</h1>
<ul>
<li>维护：马龙伟</li>
<li>主页：<a href="https://github.com/loogg/agile_console">https://github.com/loogg/agile_console</a></li>
<li>邮箱：<a href="#" onclick="location.href='mai'+'lto:'+'254'+'40'+'472'+'13'+'@qq'+'.c'+'om'; return false;">25440<span style="display: none;">.nosp@m.</span>4721<span style="display: none;">.nosp@m.</span>3@qq.<span style="display: none;">.nosp@m.</span>com</a> </li>
</ul>
</div></div><!-- PageDoc -->
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
制作者&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.2
</small></address>
</body>
</html>