mirror of
https://github.com/Fishwaldo/bl_mcu_sdk.git
synced 2025-07-21 12:18:43 +00:00
[update] update doc&errata
This commit is contained in:
jzlv
parent
ee8ed272aa
commit
322bbbe17e
230 changed files with 3248 additions and 24793 deletions
|
|
@ -1,4 +0,0 @@
|
|||
# Sphinx build info version 1
|
||||
# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
|
||||
config: cc25d7d982b3f2727b74849d9127cb3d
|
||||
tags: 645f666f9bcd5a90fca523b33c5a78b7
|
||||
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
|
|
@ -1,392 +0,0 @@
|
|||
|
||||
|
||||
<!DOCTYPE html>
|
||||
<html class="writer-html5" lang="zh-CN" >
|
||||
<head>
|
||||
<meta charset="utf-8" />
|
||||
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
||||
|
||||
<title>4. Linux 环境开发指南 — BL_MCU_SDK 开发指南 0.1 文档</title>
|
||||
|
||||
|
||||
|
||||
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
|
||||
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<!--[if lt IE 9]>
|
||||
<script src="_static/js/html5shiv.min.js"></script>
|
||||
<![endif]-->
|
||||
|
||||
|
||||
<script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
|
||||
<script src="_static/jquery.js"></script>
|
||||
<script src="_static/underscore.js"></script>
|
||||
<script src="_static/doctools.js"></script>
|
||||
<script src="_static/translations.js"></script>
|
||||
|
||||
<script type="text/javascript" src="_static/js/theme.js"></script>
|
||||
|
||||
|
||||
<link rel="index" title="索引" href="genindex.html" />
|
||||
<link rel="search" title="搜索" href="search.html" />
|
||||
<link rel="next" title="5. 硬件连接" href="connecting_hardware.html" />
|
||||
<link rel="prev" title="3. Windows 下使用 Eclipse 开发指南" href="Windows_quick_start_eclipse.html" />
|
||||
</head>
|
||||
|
||||
<body class="wy-body-for-nav">
|
||||
|
||||
|
||||
<div class="wy-grid-for-nav">
|
||||
|
||||
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
|
||||
<div class="wy-side-scroll">
|
||||
<div class="wy-side-nav-search" >
|
||||
|
||||
|
||||
|
||||
<a href="index.html" class="icon icon-home"> BL_MCU_SDK 开发指南
|
||||
|
||||
|
||||
|
||||
</a>
|
||||
|
||||
|
||||
|
||||
|
||||
<div class="version">
|
||||
0.1
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
<div role="search">
|
||||
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
|
||||
<input type="text" name="q" placeholder="Search docs" />
|
||||
<input type="hidden" name="check_keywords" value="yes" />
|
||||
<input type="hidden" name="area" value="default" />
|
||||
</form>
|
||||
</div>
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<p class="caption"><span class="caption-text">快速开发指南</span></p>
|
||||
<ul class="current">
|
||||
<li class="toctree-l1"><a class="reference internal" href="get_started.html">1. 开发前的准备</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="Windows_quick_start_cdk.html">2. Windows 下使用 CDK (类 MDK Keil)开发指南</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="Windows_quick_start_eclipse.html">3. Windows 下使用 Eclipse 开发指南</a></li>
|
||||
<li class="toctree-l1 current"><a class="current reference internal" href="#">4. Linux 环境开发指南</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="#id1">4.1. 需要的软硬件环境</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="#risc-v">4.2. 配置 RISC-V 工具链</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="#cmake-make">4.3. 配置 cmake & make 工具</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="#id2">4.4. 硬件连接</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="#bl-mcu-sdk">4.5. 获取 bl_mcu_sdk</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="#hello-world">4.6. 测试 Hello World 工程</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#id3">4.6.1. 打开 Hello World</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#id4">4.6.2. 编译 Hello World</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#id5">4.6.3. 烧写 Hello World</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#id6">4.6.4. 运行 Hello World</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#id7">4.6.5. 调试 Hello World</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="connecting_hardware.html">5. 硬件连接</a></li>
|
||||
</ul>
|
||||
<p class="caption"><span class="caption-text">API 手册</span></p>
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="api_guide.html">1. API 分层模型</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="api_guide.html#id5">2. 时钟树</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="api_guide.html#gpio">3. GPIO 设备</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="api_guide.html#uart">4. UART 设备</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="api_guide.html#pwm">5. PWM设备</a></li>
|
||||
</ul>
|
||||
<p class="caption"><span class="caption-text">示例代码</span></p>
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="blink_demo_introduce.html">1. 流水灯示例</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="breath_pwm_demo_introduce.html">2. 呼吸灯示例</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="uart_loopback_demo_introduce.html">3. 串口自收发示例</a></li>
|
||||
</ul>
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
</div>
|
||||
</nav>
|
||||
|
||||
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
|
||||
|
||||
|
||||
<nav class="wy-nav-top" aria-label="top navigation">
|
||||
|
||||
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
|
||||
<a href="index.html">BL_MCU_SDK 开发指南</a>
|
||||
|
||||
</nav>
|
||||
|
||||
|
||||
<div class="wy-nav-content">
|
||||
|
||||
<div class="rst-content">
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<div role="navigation" aria-label="breadcrumbs navigation">
|
||||
|
||||
<ul class="wy-breadcrumbs">
|
||||
|
||||
<li><a href="index.html" class="icon icon-home"></a> »</li>
|
||||
|
||||
<li><span class="section-number">4. </span>Linux 环境开发指南</li>
|
||||
|
||||
|
||||
<li class="wy-breadcrumbs-aside">
|
||||
|
||||
|
||||
<a href="_sources/Linux_quick_start_ubuntu.rst.txt" rel="nofollow"> View page source</a>
|
||||
|
||||
|
||||
</li>
|
||||
|
||||
</ul>
|
||||
|
||||
|
||||
<hr/>
|
||||
</div>
|
||||
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
|
||||
<div itemprop="articleBody">
|
||||
|
||||
<div class="section" id="linux">
|
||||
<h1><span class="section-number">4. </span>Linux 环境开发指南<a class="headerlink" href="#linux" title="永久链接至标题">¶</a></h1>
|
||||
<p>本文档介绍了如何在 Linux 安装配置 BL702 系列 MCU 需要的软件开发工具。</p>
|
||||
<div class="section" id="id1">
|
||||
<h2><span class="section-number">4.1. </span>需要的软硬件环境<a class="headerlink" href="#id1" title="永久链接至标题">¶</a></h2>
|
||||
<ul class="simple">
|
||||
<li><p>一根 mini USB 数据线</p></li>
|
||||
<li><p>一个 USB-TTL 串口模块</p></li>
|
||||
<li><p>杜邦线若干</p></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="section" id="risc-v">
|
||||
<h2><span class="section-number">4.2. </span>配置 RISC-V 工具链<a class="headerlink" href="#risc-v" title="永久链接至标题">¶</a></h2>
|
||||
<div class="highlight-bash notranslate"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span class="normal">1</span>
|
||||
<span class="normal">2</span>
|
||||
<span class="normal">3</span>
|
||||
<span class="normal">4</span>
|
||||
<span class="normal">5</span>
|
||||
<span class="normal">6</span>
|
||||
<span class="normal">7</span></pre></div></td><td class="code"><div class="highlight"><pre><span></span>$ <span class="nb">cd</span> ~
|
||||
$ wget -c https://dev.bouffalolab.com/media/upload/download/riscv64-elf-x86_64-20210120.tar.gz
|
||||
$ mkdir -p riscv64-elf-20210120
|
||||
<span class="hll">$ tar -zxvf riscv64-elf-x86_64-20210120.tar.gz -C riscv64-elf-20210120
|
||||
</span><span class="hll">$ sudo cp ~/riscv64-elf-20210120 /usr/bin
|
||||
</span><span class="hll">$ <span class="nb">echo</span> <span class="s2">"export PATH=\"</span><span class="nv">$PATH</span><span class="s2">:/usr/bin/riscv64-elf-20210120/bin\""</span> >> ~/.bashrc
|
||||
</span>$ <span class="nb">source</span> ~/.bashrc
|
||||
</pre></div>
|
||||
</td></tr></table></div>
|
||||
</div>
|
||||
<div class="section" id="cmake-make">
|
||||
<h2><span class="section-number">4.3. </span>配置 cmake & make 工具<a class="headerlink" href="#cmake-make" title="永久链接至标题">¶</a></h2>
|
||||
<div class="highlight-bash notranslate"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span class="normal">1</span>
|
||||
<span class="normal">2</span>
|
||||
<span class="normal">3</span>
|
||||
<span class="normal">4</span>
|
||||
<span class="normal">5</span>
|
||||
<span class="normal">6</span>
|
||||
<span class="normal">7</span>
|
||||
<span class="normal">8</span></pre></div></td><td class="code"><div class="highlight"><pre><span></span>$ sudo apt update
|
||||
$ sudo apt install make
|
||||
$ <span class="nb">cd</span> ~
|
||||
$ wget -c https://cmake.org/files/v3.19/cmake-3.19.3-Linux-x86_64.tar.gz
|
||||
<span class="hll">$ tar -zxvf cmake-3.19.3-Linux-x86_64.tar.gz
|
||||
</span><span class="hll">$ sudo cp ~/cmake-3.19.3-Linux-x86_64 /usr/bin
|
||||
</span><span class="hll">$ <span class="nb">echo</span> <span class="s2">"export PATH=\"</span><span class="nv">$PATH</span><span class="s2">:/usr/bin/cmake-3.19.3-Linux-x86_64/bin\""</span> >> ~/.bashrc
|
||||
</span>$ <span class="nb">source</span> ~/.bashrc
|
||||
</pre></div>
|
||||
</td></tr></table></div>
|
||||
</div>
|
||||
<div class="section" id="id2">
|
||||
<h2><span class="section-number">4.4. </span>硬件连接<a class="headerlink" href="#id2" title="永久链接至标题">¶</a></h2>
|
||||
<ul class="simple">
|
||||
<li><p>具体开发板的连接, 请参考 <a class="reference internal" href="connecting_hardware.html#connect-hardware"><span class="std std-ref">硬件连接</span></a> 部分</p></li>
|
||||
<li><p>请确保开发板正确设置后再进行下面的步骤 (建议 Linux 下采用串口连接)</p></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="section" id="bl-mcu-sdk">
|
||||
<h2><span class="section-number">4.5. </span>获取 bl_mcu_sdk<a class="headerlink" href="#bl-mcu-sdk" title="永久链接至标题">¶</a></h2>
|
||||
<ul class="simple">
|
||||
<li><p>打开终端输入以下命令获取 bl_mcu_sdk</p></li>
|
||||
</ul>
|
||||
<div class="highlight-bash notranslate"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span class="normal">1</span>
|
||||
<span class="normal">2</span></pre></div></td><td class="code"><div class="highlight"><pre><span></span> $ <span class="nb">cd</span> ~
|
||||
$ git clone https://gitee.com/bouffalolab/bl_mcu_sdk.git --recursive
|
||||
</pre></div>
|
||||
</td></tr></table></div>
|
||||
</div>
|
||||
<div class="section" id="hello-world">
|
||||
<h2><span class="section-number">4.6. </span>测试 Hello World 工程<a class="headerlink" href="#hello-world" title="永久链接至标题">¶</a></h2>
|
||||
<div class="section" id="id3">
|
||||
<h3><span class="section-number">4.6.1. </span>打开 Hello World<a class="headerlink" href="#id3" title="永久链接至标题">¶</a></h3>
|
||||
<ul class="simple">
|
||||
<li><p>获取到 SDK 后，进入 sdk 中的 <code class="docutils literal notranslate"><span class="pre">examples/hellowd/helloworld</span></code> 目录下，打开 <code class="docutils literal notranslate"><span class="pre">main.c</span></code>，即可编辑 helloworld 的相关代码。</p></li>
|
||||
</ul>
|
||||
<div class="highlight-bash notranslate"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span class="normal">1</span>
|
||||
<span class="normal">2</span></pre></div></td><td class="code"><div class="highlight"><pre><span></span> $ <span class="nb">cd</span> ~/bl_mcu_sdk/examples/hellowd/helloworld
|
||||
$ vi main.c
|
||||
</pre></div>
|
||||
</td></tr></table></div>
|
||||
<ul class="simple">
|
||||
<li><p>若编辑完成后，保存修改并关闭文件，接下来进行编译</p></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="section" id="id4">
|
||||
<h3><span class="section-number">4.6.2. </span>编译 Hello World<a class="headerlink" href="#id4" title="永久链接至标题">¶</a></h3>
|
||||
<div class="highlight-bash notranslate"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span class="normal">1</span>
|
||||
<span class="normal">2</span></pre></div></td><td class="code"><div class="highlight"><pre><span></span> $ <span class="nb">cd</span> ~/bl_mcu_sdk
|
||||
$ make build <span class="nv">BOARD</span><span class="o">=</span>bl706_iot <span class="nv">APP</span><span class="o">=</span>helloworld
|
||||
</pre></div>
|
||||
</td></tr></table></div>
|
||||
</div>
|
||||
<div class="section" id="id5">
|
||||
<h3><span class="section-number">4.6.3. </span>烧写 Hello World<a class="headerlink" href="#id5" title="永久链接至标题">¶</a></h3>
|
||||
<ul class="simple">
|
||||
<li><p>烧写前请先确认烧写方式，若采用串口烧写，请先按住板子上的 <code class="docutils literal notranslate"><span class="pre">boot</span></code> 键不要释放，此时在按下 <code class="docutils literal notranslate"><span class="pre">rst</span></code> 键，然后释放两个键，此时板子进入 boot_rom 状态。</p></li>
|
||||
<li><p>这时在终端中输入以下命令进行烧写</p></li>
|
||||
</ul>
|
||||
<div class="highlight-bash notranslate"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span class="normal">1</span>
|
||||
<span class="normal">2</span></pre></div></td><td class="code"><div class="highlight"><pre><span></span> $ <span class="nb">cd</span> ~/bl_mcu_sdk
|
||||
$ make download <span class="nv">INTERFACE</span><span class="o">=</span>uart
|
||||
</pre></div>
|
||||
</td></tr></table></div>
|
||||
<ul class="simple">
|
||||
<li><p>如果下载失败请检查：</p>
|
||||
<ul>
|
||||
<li><ol class="arabic simple">
|
||||
<li><p>是否使用串口烧写，开发板是否供电，硬件连接是否正确。</p></li>
|
||||
</ol>
|
||||
</li>
|
||||
<li><ol class="arabic simple" start="2">
|
||||
<li><p>烧写命令是否在 <code class="docutils literal notranslate"><span class="pre">bl_mcu_sdk</span></code> 目录下执行</p></li>
|
||||
</ol>
|
||||
</li>
|
||||
<li><ol class="arabic simple" start="3">
|
||||
<li><p>是否进入 boot_rom 模式</p></li>
|
||||
</ol>
|
||||
</li>
|
||||
<li><ol class="arabic simple" start="4">
|
||||
<li><p>串口是否被占用</p></li>
|
||||
</ol>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="section" id="id6">
|
||||
<h3><span class="section-number">4.6.4. </span>运行 Hello World<a class="headerlink" href="#id6" title="永久链接至标题">¶</a></h3>
|
||||
<ul class="simple">
|
||||
<li><p>打开新的终端，安装、运行串口工具</p></li>
|
||||
</ul>
|
||||
<div class="highlight-bash notranslate"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span class="normal">1</span>
|
||||
<span class="normal">2</span></pre></div></td><td class="code"><div class="highlight"><pre><span></span> $ sudo apt install picocom <span class="c1"># 若已经安装请忽略</span>
|
||||
$ picocom -b <span class="m">2000000</span> /dev/ttyUSB0
|
||||
</pre></div>
|
||||
</td></tr></table></div>
|
||||
<ul class="simple">
|
||||
<li><p>按一下开发板上的 <code class="docutils literal notranslate"><span class="pre">rst</span></code> 按键，即可在串口终端中看到 <code class="docutils literal notranslate"><span class="pre">hello</span> <span class="pre">world！</span></code></p></li>
|
||||
</ul>
|
||||
<div class="figure align-default" id="id8">
|
||||
<img alt="" src="_images/linux1.png" />
|
||||
<p class="caption"><span class="caption-text">helloworld!</span><a class="headerlink" href="#id8" title="永久链接至图片">¶</a></p>
|
||||
</div>
|
||||
</div>
|
||||
<div class="section" id="id7">
|
||||
<h3><span class="section-number">4.6.5. </span>调试 Hello World<a class="headerlink" href="#id7" title="永久链接至标题">¶</a></h3>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
</div>
|
||||
<footer>
|
||||
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
|
||||
<a href="connecting_hardware.html" class="btn btn-neutral float-right" title="5. 硬件连接" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
|
||||
<a href="Windows_quick_start_eclipse.html" class="btn btn-neutral float-left" title="3. Windows 下使用 Eclipse 开发指南" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
|
||||
</div>
|
||||
|
||||
<hr/>
|
||||
|
||||
<div role="contentinfo">
|
||||
<p>
|
||||
© 版权所有 2021, BouffaloLab Co., Ltd.
|
||||
|
||||
</p>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
|
||||
|
||||
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
|
||||
|
||||
provided by <a href="https://readthedocs.org">Read the Docs</a>.
|
||||
|
||||
</footer>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
</section>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<script type="text/javascript">
|
||||
jQuery(function () {
|
||||
SphinxRtdTheme.Navigation.enable(true);
|
||||
});
|
||||
</script>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</body>
|
||||
</html>
|
||||
|
|
@ -1,412 +0,0 @@
|
|||
|
||||
|
||||
<!DOCTYPE html>
|
||||
<html class="writer-html5" lang="zh-CN" >
|
||||
<head>
|
||||
<meta charset="utf-8" />
|
||||
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
||||
|
||||
<title>2. Windows 下使用 CDK (类 MDK Keil)开发指南 — BL_MCU_SDK 开发指南 0.1 文档</title>
|
||||
|
||||
|
||||
|
||||
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
|
||||
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<!--[if lt IE 9]>
|
||||
<script src="_static/js/html5shiv.min.js"></script>
|
||||
<![endif]-->
|
||||
|
||||
|
||||
<script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
|
||||
<script src="_static/jquery.js"></script>
|
||||
<script src="_static/underscore.js"></script>
|
||||
<script src="_static/doctools.js"></script>
|
||||
<script src="_static/translations.js"></script>
|
||||
|
||||
<script type="text/javascript" src="_static/js/theme.js"></script>
|
||||
|
||||
|
||||
<link rel="index" title="索引" href="genindex.html" />
|
||||
<link rel="search" title="搜索" href="search.html" />
|
||||
<link rel="next" title="3. Windows 下使用 Eclipse 开发指南" href="Windows_quick_start_eclipse.html" />
|
||||
<link rel="prev" title="1. 开发前的准备" href="get_started.html" />
|
||||
</head>
|
||||
|
||||
<body class="wy-body-for-nav">
|
||||
|
||||
|
||||
<div class="wy-grid-for-nav">
|
||||
|
||||
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
|
||||
<div class="wy-side-scroll">
|
||||
<div class="wy-side-nav-search" >
|
||||
|
||||
|
||||
|
||||
<a href="index.html" class="icon icon-home"> BL_MCU_SDK 开发指南
|
||||
|
||||
|
||||
|
||||
</a>
|
||||
|
||||
|
||||
|
||||
|
||||
<div class="version">
|
||||
0.1
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
<div role="search">
|
||||
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
|
||||
<input type="text" name="q" placeholder="Search docs" />
|
||||
<input type="hidden" name="check_keywords" value="yes" />
|
||||
<input type="hidden" name="area" value="default" />
|
||||
</form>
|
||||
</div>
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<p class="caption"><span class="caption-text">快速开发指南</span></p>
|
||||
<ul class="current">
|
||||
<li class="toctree-l1"><a class="reference internal" href="get_started.html">1. 开发前的准备</a></li>
|
||||
<li class="toctree-l1 current"><a class="current reference internal" href="#">2. Windows 下使用 CDK (类 MDK Keil)开发指南</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="#id2">2.1. 需要的软硬件环境</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="#cdk">2.2. 下载剑池 CDK 软件安装包</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="#bl-mcu-sdk">2.3. 下载 bl_mcu_sdk 软件开发包</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="#id4">2.4. 硬件连接</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="#hello-world">2.5. 测试 Hello World 工程</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#id5">2.5.1. 打开 Hello World</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#id6">2.5.2. 编译 Hello World</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#id7">2.5.3. 烧写 Hello World</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#id8">2.5.4. 运行 Hello World</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#id9">2.5.5. 调试 Hello World</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="Windows_quick_start_eclipse.html">3. Windows 下使用 Eclipse 开发指南</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="Linux_quick_start_ubuntu.html">4. Linux 环境开发指南</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="connecting_hardware.html">5. 硬件连接</a></li>
|
||||
</ul>
|
||||
<p class="caption"><span class="caption-text">API 手册</span></p>
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="api_guide.html">1. API 分层模型</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="api_guide.html#id5">2. 时钟树</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="api_guide.html#gpio">3. GPIO 设备</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="api_guide.html#uart">4. UART 设备</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="api_guide.html#pwm">5. PWM设备</a></li>
|
||||
</ul>
|
||||
<p class="caption"><span class="caption-text">示例代码</span></p>
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="blink_demo_introduce.html">1. 流水灯示例</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="breath_pwm_demo_introduce.html">2. 呼吸灯示例</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="uart_loopback_demo_introduce.html">3. 串口自收发示例</a></li>
|
||||
</ul>
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
</div>
|
||||
</nav>
|
||||
|
||||
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
|
||||
|
||||
|
||||
<nav class="wy-nav-top" aria-label="top navigation">
|
||||
|
||||
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
|
||||
<a href="index.html">BL_MCU_SDK 开发指南</a>
|
||||
|
||||
</nav>
|
||||
|
||||
|
||||
<div class="wy-nav-content">
|
||||
|
||||
<div class="rst-content">
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<div role="navigation" aria-label="breadcrumbs navigation">
|
||||
|
||||
<ul class="wy-breadcrumbs">
|
||||
|
||||
<li><a href="index.html" class="icon icon-home"></a> »</li>
|
||||
|
||||
<li><span class="section-number">2. </span>Windows 下使用 CDK (类 MDK Keil)开发指南</li>
|
||||
|
||||
|
||||
<li class="wy-breadcrumbs-aside">
|
||||
|
||||
|
||||
<a href="_sources/Windows_quick_start_cdk.rst.txt" rel="nofollow"> View page source</a>
|
||||
|
||||
|
||||
</li>
|
||||
|
||||
</ul>
|
||||
|
||||
|
||||
<hr/>
|
||||
</div>
|
||||
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
|
||||
<div itemprop="articleBody">
|
||||
|
||||
<div class="section" id="windows-cdk-mdk-keil">
|
||||
<h1><span class="section-number">2. </span>Windows 下使用 CDK (类 MDK Keil)开发指南<a class="headerlink" href="#windows-cdk-mdk-keil" title="永久链接至标题">¶</a></h1>
|
||||
<p>本文档介绍了如何在 Windows 下使用 <a class="reference external" href="https://www.t-heah.cn/about">平头哥半导体</a> 开发的 CDK 集成开发环境，
|
||||
来完成博流 BL702 系列 MCU 的相关软件开发工作。</p>
|
||||
<p>关于剑池 CDK ，这是一款由平头哥半导体开发打造的集成开发环境。它拥有和传统 MCU 开发环境十分近似的操作和设置，旨在不改变用户开发习惯的基础上，全面接入云端开发资源，结合图形化的 OSTracer、Profiling 等调试分析工具，加速用户产品开发。</p>
|
||||
<div class="section" id="id2">
|
||||
<h2><span class="section-number">2.1. </span>需要的软硬件环境<a class="headerlink" href="#id2" title="永久链接至标题">¶</a></h2>
|
||||
<ul class="simple">
|
||||
<li><p>剑池 CDK 软件</p></li>
|
||||
<li><p>一根 USB Type-A 数据线</p></li>
|
||||
<li><p>一个 CK-Link 仿真器</p></li>
|
||||
<li><p>一个 USB-TTL 串口模块</p></li>
|
||||
<li><p>杜邦线若干</p></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="section" id="cdk">
|
||||
<h2><span class="section-number">2.2. </span>下载剑池 CDK 软件安装包<a class="headerlink" href="#cdk" title="永久链接至标题">¶</a></h2>
|
||||
<ul class="simple">
|
||||
<li><p><a class="reference external" href="https://occ.t-head.cn/development/series/download?id=3864775351511420928&type=kind&softPlatformType=4#sticky">剑池CDK</a> 软件安装可以从平头哥半导体 OCC 官网获取到。</p></li>
|
||||
<li><p>下载完成后，解压缩，双击 <code class="docutils literal notranslate"><span class="pre">setup.exe</span></code>，按照其提示，完成软件安装即可。</p></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="section" id="bl-mcu-sdk">
|
||||
<h2><span class="section-number">2.3. </span>下载 bl_mcu_sdk 软件开发包<a class="headerlink" href="#bl-mcu-sdk" title="永久链接至标题">¶</a></h2>
|
||||
<ul>
|
||||
<li><p>从开源社区下载 bl_mcu_sdk 软件开发包。</p>
|
||||
<ul class="simple">
|
||||
<li><p>可以使用 <code class="docutils literal notranslate"><span class="pre">git</span> <span class="pre">clone</span></code> 或者直接 <code class="docutils literal notranslate"><span class="pre">download</span></code> 的方式下 SDK</p></li>
|
||||
<li><p>使用 <code class="docutils literal notranslate"><span class="pre">git</span> <span class="pre">clone</span></code> 前请确保已正确安装 <code class="docutils literal notranslate"><span class="pre">git</span></code>，打开支持 <code class="docutils literal notranslate"><span class="pre">git</span></code> 的终端输入以下命令即可获取最新的 SDK。</p></li>
|
||||
</ul>
|
||||
<div class="highlight-bash notranslate"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span class="normal">1</span></pre></div></td><td class="code"><div class="highlight"><pre><span></span><span class="hll">$ git clone https://gitee.com/bouffalolab/bl_mcu_sdk.git --recursive
|
||||
</span></pre></div>
|
||||
</td></tr></table></div>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="section" id="id4">
|
||||
<h2><span class="section-number">2.4. </span>硬件连接<a class="headerlink" href="#id4" title="永久链接至标题">¶</a></h2>
|
||||
<ul class="simple">
|
||||
<li><p>具体开发板的连接, 请参考 <a class="reference internal" href="connecting_hardware.html#connect-hardware"><span class="std std-ref">硬件连接</span></a> 部分</p></li>
|
||||
<li><p>请确保开发板被正确设置后再进行下面的步骤</p></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="section" id="hello-world">
|
||||
<h2><span class="section-number">2.5. </span>测试 Hello World 工程<a class="headerlink" href="#hello-world" title="永久链接至标题">¶</a></h2>
|
||||
<div class="section" id="id5">
|
||||
<h3><span class="section-number">2.5.1. </span>打开 Hello World<a class="headerlink" href="#id5" title="永久链接至标题">¶</a></h3>
|
||||
<ul class="simple">
|
||||
<li><p>获取到 SDK 后，进入 sdk 中的 <code class="docutils literal notranslate"><span class="pre">examples/hellowd/helloworld/cdk</span></code> 目录下，双击 <code class="docutils literal notranslate"><span class="pre">helloworld.cdkproj</span></code>，即可打开 <code class="docutils literal notranslate"><span class="pre">Helloworld</span></code> 工程。</p></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="section" id="id6">
|
||||
<h3><span class="section-number">2.5.2. </span>编译 Hello World<a class="headerlink" href="#id6" title="永久链接至标题">¶</a></h3>
|
||||
<div class="figure align-default" id="id10">
|
||||
<img alt="" src="_images/cdk1.png" />
|
||||
<p class="caption"><span class="caption-text">helloworld.cdkproj</span><a class="headerlink" href="#id10" title="永久链接至图片">¶</a></p>
|
||||
</div>
|
||||
<ul class="simple">
|
||||
<li><p>在 CDK 工具栏中，点击编译图标即可编译工程</p>
|
||||
<ul>
|
||||
<li><p>点击 <code class="docutils literal notranslate"><span class="pre">1</span></code> 处 图标 <code class="docutils literal notranslate"><span class="pre">Build</span> <span class="pre">Project</span></code> 即可编译当前选中的工程</p></li>
|
||||
<li><p>点击 <code class="docutils literal notranslate"><span class="pre">2</span></code> 处 图标 <code class="docutils literal notranslate"><span class="pre">Clean</span> <span class="pre">Project</span></code> 即可清除上次编译的结果</p></li>
|
||||
<li><p>点击 <code class="docutils literal notranslate"><span class="pre">3</span></code> 处 图标 <code class="docutils literal notranslate"><span class="pre">Flash</span> <span class="pre">Download</span></code> 即可将编译好的代码下载到芯片中</p></li>
|
||||
<li><p>点击 <code class="docutils literal notranslate"><span class="pre">4</span></code> 处 图标 <code class="docutils literal notranslate"><span class="pre">Start/Stop</span> <span class="pre">Debug</span></code> 即可进行 debug 的相关操作</p></li>
|
||||
<li><p>也可以在 <code class="docutils literal notranslate"><span class="pre">Project</span></code> 中，右击工程名称，通过右击菜单中的选项对项目进行编译等操作</p></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="section" id="id7">
|
||||
<h3><span class="section-number">2.5.3. </span>烧写 Hello World<a class="headerlink" href="#id7" title="永久链接至标题">¶</a></h3>
|
||||
<ul>
|
||||
<li><p>由于目前 CDK 软件中还没有包含我们的 flash 算法，所以需要我们手动将 flash 算法放到 CDK 安装目录，具体操作如下：</p>
|
||||
<ul class="simple">
|
||||
<li><p>进入 SDK 目录下 <code class="docutils literal notranslate"><span class="pre">tools\cdk_flashloader</span></code> 目录</p></li>
|
||||
<li><p>将目录下的 <code class="docutils literal notranslate"><span class="pre">bl70x_flasher.elf</span></code> 文件，拷贝到 CDK 工具的 <code class="docutils literal notranslate"><span class="pre">C-Sky\CDK\CSKY\Flash</span></code> 目录中</p></li>
|
||||
</ul>
|
||||
<div class="figure align-default" id="id11">
|
||||
<img alt="" src="_images/cdk7.png" />
|
||||
<p class="caption"><span class="caption-text">CDK Flash Loader</span><a class="headerlink" href="#id11" title="永久链接至图片">¶</a></p>
|
||||
</div>
|
||||
</li>
|
||||
</ul>
|
||||
<div class="figure align-default" id="id12">
|
||||
<img alt="" src="_images/cdk8.png" />
|
||||
<p class="caption"><span class="caption-text">CDK Project Setting</span><a class="headerlink" href="#id12" title="永久链接至图片">¶</a></p>
|
||||
</div>
|
||||
<ul class="simple">
|
||||
<li><p>点击 <code class="docutils literal notranslate"><span class="pre">Project</span> <span class="pre">View</span></code> 中的项目设置按钮，打开 <code class="docutils literal notranslate"><span class="pre">Project</span> <span class="pre">Setting</span></code> 窗口，或者通过右击 <code class="docutils literal notranslate"><span class="pre">Project</span></code> 名称中右击菜单栏中打开</p></li>
|
||||
<li><p>在打开的 <code class="docutils literal notranslate"><span class="pre">Project</span> <span class="pre">Setting</span></code> 窗口中，选择 <code class="docutils literal notranslate"><span class="pre">Flash</span></code> 标签，配置需要的 Flash 算法</p></li>
|
||||
</ul>
|
||||
<div class="figure align-default" id="id13">
|
||||
<img alt="" src="_images/cdk9.png" />
|
||||
<p class="caption"><span class="caption-text">CDK Project Flash setting</span><a class="headerlink" href="#id13" title="永久链接至图片">¶</a></p>
|
||||
</div>
|
||||
<ul class="simple">
|
||||
<li><p>在 <code class="docutils literal notranslate"><span class="pre">Flash</span></code> 标签中，点击 <code class="docutils literal notranslate"><span class="pre">Add</span></code> 按纽，在打开的列表中选择 <code class="docutils literal notranslate"><span class="pre">bl70x_flash</span></code> 算法，点击 <code class="docutils literal notranslate"><span class="pre">Add</span></code> 添加到工程中，<code class="docutils literal notranslate"><span class="pre">Flash</span></code> 标签下的其他设置，如图所示：</p></li>
|
||||
<li><p>点击 OK 后，如配置正确，点击 <code class="docutils literal notranslate"><span class="pre">Flash</span> <span class="pre">Download</span></code> 即可将编译好的代码下载到芯片中</p></li>
|
||||
</ul>
|
||||
<div class="figure align-default" id="id14">
|
||||
<img alt="" src="_images/cdk5.png" />
|
||||
<p class="caption"><span class="caption-text">CDK Flashdownload Success</span><a class="headerlink" href="#id14" title="永久链接至图片">¶</a></p>
|
||||
</div>
|
||||
<ul class="simple">
|
||||
<li><p>如下载失败请检查：</p>
|
||||
<ul>
|
||||
<li><ol class="arabic simple">
|
||||
<li><p>代码是否被正确编译，并生成 <code class="docutils literal notranslate"><span class="pre">.elf</span></code> <code class="docutils literal notranslate"><span class="pre">.bin</span></code> 等文件</p></li>
|
||||
</ol>
|
||||
</li>
|
||||
<li><ol class="arabic simple" start="2">
|
||||
<li><p>Flash 算法是否被正确设置</p></li>
|
||||
</ol>
|
||||
</li>
|
||||
<li><ol class="arabic simple" start="3">
|
||||
<li><p>CK-Link 与开发板是否正确连接</p></li>
|
||||
</ol>
|
||||
</li>
|
||||
<li><ol class="arabic simple" start="4">
|
||||
<li><p>开发板是否正常供电，电源指示灯是否点亮</p></li>
|
||||
</ol>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="section" id="id8">
|
||||
<h3><span class="section-number">2.5.4. </span>运行 Hello World<a class="headerlink" href="#id8" title="永久链接至标题">¶</a></h3>
|
||||
<ul class="simple">
|
||||
<li><p>从 CDK 的菜单栏 <code class="docutils literal notranslate"><span class="pre">View->Serial</span> <span class="pre">Pane</span></code>，打开串口面板，在打开的 <code class="docutils literal notranslate"><span class="pre">Serial</span> <span class="pre">Pane</span></code> 中右击，进行串口设置，选择你对应的串口号和波特率</p></li>
|
||||
</ul>
|
||||
<div class="figure align-default">
|
||||
<img alt="_images/cdk4.png" src="_images/cdk4.png" />
|
||||
</div>
|
||||
<div class="figure align-default" id="id15">
|
||||
<img alt="" src="_images/cdk3.png" />
|
||||
<p class="caption"><span class="caption-text">CDK Serial Pane setting</span><a class="headerlink" href="#id15" title="永久链接至图片">¶</a></p>
|
||||
</div>
|
||||
<ul class="simple">
|
||||
<li><p>按下板子上的 <code class="docutils literal notranslate"><span class="pre">RST</span></code> 按键，即可在串口中看到代码的运行结果</p></li>
|
||||
</ul>
|
||||
<div class="figure align-default" id="id16">
|
||||
<img alt="" src="_images/cdk6.png" />
|
||||
<p class="caption"><span class="caption-text">HelloWorld！</span><a class="headerlink" href="#id16" title="永久链接至图片">¶</a></p>
|
||||
</div>
|
||||
</div>
|
||||
<div class="section" id="id9">
|
||||
<h3><span class="section-number">2.5.5. </span>调试 Hello World<a class="headerlink" href="#id9" title="永久链接至标题">¶</a></h3>
|
||||
<ul class="simple">
|
||||
<li><p>点击工具栏上方的 <code class="docutils literal notranslate"><span class="pre">Start/Stop</span> <span class="pre">Debugger</span></code> 按钮，进入 debug 界面，如下图所示</p></li>
|
||||
</ul>
|
||||
<div class="figure align-default" id="id17">
|
||||
<img alt="" src="_images/cdk10.png" />
|
||||
<p class="caption"><span class="caption-text">Debug HelloWorld！</span><a class="headerlink" href="#id17" title="永久链接至图片">¶</a></p>
|
||||
</div>
|
||||
<ul class="simple">
|
||||
<li><p>在 debug 界面下，左侧的 <code class="docutils literal notranslate"><span class="pre">Register</span></code> 窗口中，可以查看 <code class="docutils literal notranslate"><span class="pre">CPU</span></code> 内部寄存器数据；右侧的 <code class="docutils literal notranslate"><span class="pre">Peripherals</span></code> 外设面板中，
|
||||
可以查看相应外设寄存器数据，外设的选择可以在顶部菜单栏的 <code class="docutils literal notranslate"><span class="pre">Peripherals->System</span> <span class="pre">Viewer</span></code> 选择；
|
||||
点击上方工具栏中的相关调试按钮可以进行断点设置、单步调试、指令单步和全速运行等操作。
|
||||
当然这些操作都有相应的快捷键和快捷设置方法，详情请参考 <code class="docutils literal notranslate"><span class="pre">CDK</span> <span class="pre">Help</span></code>，这里就不作过多介绍了。</p></li>
|
||||
<li><p>我们点击单步运行按钮，运行代码，即可看到指示光标移动到下一句代码，同时可以看到串口面板中显示了我们输出的 <code class="docutils literal notranslate"><span class="pre">Hello</span> <span class="pre">World！</span></code></p></li>
|
||||
</ul>
|
||||
<div class="figure align-default" id="id18">
|
||||
<img alt="" src="_images/cdk11.png" />
|
||||
<p class="caption"><span class="caption-text">Debug HelloWorld！</span><a class="headerlink" href="#id18" title="永久链接至图片">¶</a></p>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
</div>
|
||||
<footer>
|
||||
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
|
||||
<a href="Windows_quick_start_eclipse.html" class="btn btn-neutral float-right" title="3. Windows 下使用 Eclipse 开发指南" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
|
||||
<a href="get_started.html" class="btn btn-neutral float-left" title="1. 开发前的准备" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
|
||||
</div>
|
||||
|
||||
<hr/>
|
||||
|
||||
<div role="contentinfo">
|
||||
<p>
|
||||
© 版权所有 2021, BouffaloLab Co., Ltd.
|
||||
|
||||
</p>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
|
||||
|
||||
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
|
||||
|
||||
provided by <a href="https://readthedocs.org">Read the Docs</a>.
|
||||
|
||||
</footer>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
</section>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<script type="text/javascript">
|
||||
jQuery(function () {
|
||||
SphinxRtdTheme.Navigation.enable(true);
|
||||
});
|
||||
</script>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</body>
|
||||
</html>
|
||||
|
|
@ -1,418 +0,0 @@
|
|||
|
||||
|
||||
<!DOCTYPE html>
|
||||
<html class="writer-html5" lang="zh-CN" >
|
||||
<head>
|
||||
<meta charset="utf-8" />
|
||||
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
||||
|
||||
<title>3. Windows 下使用 Eclipse 开发指南 — BL_MCU_SDK 开发指南 0.1 文档</title>
|
||||
|
||||
|
||||
|
||||
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
|
||||
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<!--[if lt IE 9]>
|
||||
<script src="_static/js/html5shiv.min.js"></script>
|
||||
<![endif]-->
|
||||
|
||||
|
||||
<script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
|
||||
<script src="_static/jquery.js"></script>
|
||||
<script src="_static/underscore.js"></script>
|
||||
<script src="_static/doctools.js"></script>
|
||||
<script src="_static/translations.js"></script>
|
||||
|
||||
<script type="text/javascript" src="_static/js/theme.js"></script>
|
||||
|
||||
|
||||
<link rel="index" title="索引" href="genindex.html" />
|
||||
<link rel="search" title="搜索" href="search.html" />
|
||||
<link rel="next" title="4. Linux 环境开发指南" href="Linux_quick_start_ubuntu.html" />
|
||||
<link rel="prev" title="2. Windows 下使用 CDK (类 MDK Keil)开发指南" href="Windows_quick_start_cdk.html" />
|
||||
</head>
|
||||
|
||||
<body class="wy-body-for-nav">
|
||||
|
||||
|
||||
<div class="wy-grid-for-nav">
|
||||
|
||||
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
|
||||
<div class="wy-side-scroll">
|
||||
<div class="wy-side-nav-search" >
|
||||
|
||||
|
||||
|
||||
<a href="index.html" class="icon icon-home"> BL_MCU_SDK 开发指南
|
||||
|
||||
|
||||
|
||||
</a>
|
||||
|
||||
|
||||
|
||||
|
||||
<div class="version">
|
||||
0.1
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
<div role="search">
|
||||
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
|
||||
<input type="text" name="q" placeholder="Search docs" />
|
||||
<input type="hidden" name="check_keywords" value="yes" />
|
||||
<input type="hidden" name="area" value="default" />
|
||||
</form>
|
||||
</div>
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<p class="caption"><span class="caption-text">快速开发指南</span></p>
|
||||
<ul class="current">
|
||||
<li class="toctree-l1"><a class="reference internal" href="get_started.html">1. 开发前的准备</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="Windows_quick_start_cdk.html">2. Windows 下使用 CDK (类 MDK Keil)开发指南</a></li>
|
||||
<li class="toctree-l1 current"><a class="current reference internal" href="#">3. Windows 下使用 Eclipse 开发指南</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="#id1">3.1. 需要的软硬件环境</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="#eclipse">3.2. 下载 Eclipse 安装包</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="#bl-mcu-sdk">3.3. 下载 bl_mcu_sdk</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="#id3">3.4. 配置 eclipse 开发环境</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="#id4">3.5. 导入 bl_mcu_sdk</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="#id5">3.6. 硬件连接</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="#hello-world">3.7. 测试 Hello World 工程</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#id6">3.7.1. 打开 Hello World</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#id7">3.7.2. 编译 Hello World</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#id8">3.7.3. 烧写 Hello World</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#id9">3.7.4. 运行 Hello World</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#id10">3.7.5. 调试 Hello World</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="#id11">3.8. 编译烧写不同的目标工程</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="Linux_quick_start_ubuntu.html">4. Linux 环境开发指南</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="connecting_hardware.html">5. 硬件连接</a></li>
|
||||
</ul>
|
||||
<p class="caption"><span class="caption-text">API 手册</span></p>
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="api_guide.html">1. API 分层模型</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="api_guide.html#id5">2. 时钟树</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="api_guide.html#gpio">3. GPIO 设备</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="api_guide.html#uart">4. UART 设备</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="api_guide.html#pwm">5. PWM设备</a></li>
|
||||
</ul>
|
||||
<p class="caption"><span class="caption-text">示例代码</span></p>
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="blink_demo_introduce.html">1. 流水灯示例</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="breath_pwm_demo_introduce.html">2. 呼吸灯示例</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="uart_loopback_demo_introduce.html">3. 串口自收发示例</a></li>
|
||||
</ul>
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
</div>
|
||||
</nav>
|
||||
|
||||
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
|
||||
|
||||
|
||||
<nav class="wy-nav-top" aria-label="top navigation">
|
||||
|
||||
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
|
||||
<a href="index.html">BL_MCU_SDK 开发指南</a>
|
||||
|
||||
</nav>
|
||||
|
||||
|
||||
<div class="wy-nav-content">
|
||||
|
||||
<div class="rst-content">
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<div role="navigation" aria-label="breadcrumbs navigation">
|
||||
|
||||
<ul class="wy-breadcrumbs">
|
||||
|
||||
<li><a href="index.html" class="icon icon-home"></a> »</li>
|
||||
|
||||
<li><span class="section-number">3. </span>Windows 下使用 Eclipse 开发指南</li>
|
||||
|
||||
|
||||
<li class="wy-breadcrumbs-aside">
|
||||
|
||||
|
||||
<a href="_sources/Windows_quick_start_eclipse.rst.txt" rel="nofollow"> View page source</a>
|
||||
|
||||
|
||||
</li>
|
||||
|
||||
</ul>
|
||||
|
||||
|
||||
<hr/>
|
||||
</div>
|
||||
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
|
||||
<div itemprop="articleBody">
|
||||
|
||||
<div class="section" id="windows-eclipse">
|
||||
<h1><span class="section-number">3. </span>Windows 下使用 Eclipse 开发指南<a class="headerlink" href="#windows-eclipse" title="永久链接至标题">¶</a></h1>
|
||||
<p>本文档介绍了如何在 Windows 下使用 eclipse，构建 BL702 系列 MCU 的软件开发环境。</p>
|
||||
<div class="section" id="id1">
|
||||
<h2><span class="section-number">3.1. </span>需要的软硬件环境<a class="headerlink" href="#id1" title="永久链接至标题">¶</a></h2>
|
||||
<ul class="simple">
|
||||
<li><p>Eclipse 免安装软件包</p></li>
|
||||
<li><p>串口助手软件</p></li>
|
||||
<li><p>一根 USB Type-A 数据线</p></li>
|
||||
<li><p>一个 j-link 仿真器</p></li>
|
||||
<li><p>一个 USB-TTL 串口模块</p></li>
|
||||
<li><p>杜邦线若干</p></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="section" id="eclipse">
|
||||
<h2><span class="section-number">3.2. </span>下载 Eclipse 安装包<a class="headerlink" href="#eclipse" title="永久链接至标题">¶</a></h2>
|
||||
<ul class="simple">
|
||||
<li><p>从 Bouffalo Lab 开发者社区下载带有 RISC-V 工具链的 <a class="reference external" href="https://dev.bouffalolab.com/media/upload/download/BouffaloLab_eclipse_x86_64_win.zip">Eclipse https://dev.bouffalolab.com/download</a> 安装包。</p></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="section" id="bl-mcu-sdk">
|
||||
<h2><span class="section-number">3.3. </span>下载 bl_mcu_sdk<a class="headerlink" href="#bl-mcu-sdk" title="永久链接至标题">¶</a></h2>
|
||||
<ul class="simple">
|
||||
<li><p>从开源社区下载 <a class="reference external" href="https://gitee.com/bouffalolab/bl_mcu_sdk.git">bl_mcu_sdk</a> 软件开发包。</p></li>
|
||||
<li><p>可以使用 <code class="docutils literal notranslate"><span class="pre">git</span> <span class="pre">clone</span></code> 或者直接 <code class="docutils literal notranslate"><span class="pre">download</span></code> 的方式下 SDK</p></li>
|
||||
<li><p>使用 <code class="docutils literal notranslate"><span class="pre">git</span> <span class="pre">clone</span></code> 前请确保已正确安装 <code class="docutils literal notranslate"><span class="pre">git</span></code>，打开支持 <code class="docutils literal notranslate"><span class="pre">git</span></code> 的终端输入以下命令即可获取最新的 SDK。</p></li>
|
||||
</ul>
|
||||
<div class="highlight-bash notranslate"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span class="normal">1</span></pre></div></td><td class="code"><div class="highlight"><pre><span></span><span class="hll">$ git clone https://gitee.com/bouffalolab/bl_mcu_sdk.git --recursive
|
||||
</span></pre></div>
|
||||
</td></tr></table></div>
|
||||
</div>
|
||||
<div class="section" id="id3">
|
||||
<h2><span class="section-number">3.4. </span>配置 eclipse 开发环境<a class="headerlink" href="#id3" title="永久链接至标题">¶</a></h2>
|
||||
<ul>
|
||||
<li><p>将获取到的 eclipse 压缩包拷贝到您的工作目录，解压 eclipse 压缩包</p></li>
|
||||
<li><p>进入 eclipse 目录，双击 <code class="docutils literal notranslate"><span class="pre">eclipse.exe</span></code> 启动 eclipse</p></li>
|
||||
<li><p>选择您的 <code class="docutils literal notranslate"><span class="pre">Workspace</span></code> 目录，点击 <code class="docutils literal notranslate"><span class="pre">Launch</span></code> 进入工作空间</p>
|
||||
<div class="figure align-default">
|
||||
<img alt="" src="_images/pic1.png" />
|
||||
</div>
|
||||
</li>
|
||||
<li><p>点击菜单栏中 <code class="docutils literal notranslate"><span class="pre">Window->preferences</span></code> 打开环境配置相关页面，准备导入相关的配置环境</p>
|
||||
<div class="figure align-default">
|
||||
<img alt="" src="_images/pic2.png" />
|
||||
</div>
|
||||
</li>
|
||||
<li><p>点击下图 1 处的图标，打开导入配置界面，按照如图所示步骤，选择 <code class="docutils literal notranslate"><span class="pre">eclipse.exe</span></code> 目录下的 <code class="docutils literal notranslate"><span class="pre">bflb_mcu_preferences.epf</span></code> 配置文件。</p>
|
||||
<div class="figure align-default">
|
||||
<img alt="" src="_images/pic3.png" />
|
||||
</div>
|
||||
</li>
|
||||
<li><p>选择好对应的文件后，点击 <code class="docutils literal notranslate"><span class="pre">Finish</span></code>，在弹出的对话框选中点击 <code class="docutils literal notranslate"><span class="pre">cancel</span></code> ，不用重新启动。</p>
|
||||
<div class="figure align-default">
|
||||
<img alt="" src="_images/pic4.png" />
|
||||
</div>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="section" id="id4">
|
||||
<h2><span class="section-number">3.5. </span>导入 bl_mcu_sdk<a class="headerlink" href="#id4" title="永久链接至标题">¶</a></h2>
|
||||
<ul>
|
||||
<li><p>点击 菜单栏 <code class="docutils literal notranslate"><span class="pre">File->Import</span></code> ，打开导入项目的配置界面</p>
|
||||
<div class="figure align-default">
|
||||
<img alt="" src="_images/pic5.png" />
|
||||
</div>
|
||||
</li>
|
||||
<li><p>在打开的 <code class="docutils literal notranslate"><span class="pre">Import</span></code> 窗口中选择 <code class="docutils literal notranslate"><span class="pre">General->Existing</span> <span class="pre">Projects</span> <span class="pre">into</span> <span class="pre">Workspace</span></code> ，然后点击 <code class="docutils literal notranslate"><span class="pre">Next</span></code></p>
|
||||
<div class="figure align-default">
|
||||
<img alt="" src="_images/pic6.png" />
|
||||
</div>
|
||||
</li>
|
||||
<li><p>加载 bl_mcu_sdk 的工程路径后，点击 <code class="docutils literal notranslate"><span class="pre">Finsh</span></code> 完成导入</p>
|
||||
<div class="figure align-default">
|
||||
<img alt="" src="_images/pic7.png" />
|
||||
</div>
|
||||
</li>
|
||||
<li><p>导入完成后，关闭 <code class="docutils literal notranslate"><span class="pre">Welcome</span></code> 窗口即可看到导入的工程</p>
|
||||
<div class="figure align-default">
|
||||
<img alt="" src="_images/pic8.png" />
|
||||
</div>
|
||||
<div class="figure align-default">
|
||||
<img alt="" src="_images/pic9.png" />
|
||||
</div>
|
||||
</li>
|
||||
<li><p>展开 <code class="docutils literal notranslate"><span class="pre">Build</span> <span class="pre">Target</span></code> 目录，即可看到 <code class="docutils literal notranslate"><span class="pre">bl_clean</span></code>、<code class="docutils literal notranslate"><span class="pre">bl_make</span></code>、<code class="docutils literal notranslate"><span class="pre">download</span></code> 三个功能按钮。</p>
|
||||
<ul class="simple">
|
||||
<li><p>双击 <code class="docutils literal notranslate"><span class="pre">bl_clean</span></code> 按钮，会清除 <code class="docutils literal notranslate"><span class="pre">build</span></code> 和 <code class="docutils literal notranslate"><span class="pre">out</span></code> 两个目录下的编译缓存</p></li>
|
||||
<li><p>双击 <code class="docutils literal notranslate"><span class="pre">bl_make</span></code> 按钮，会正常编译设置的 case，若没有修改默认配置则会编译 <code class="docutils literal notranslate"><span class="pre">helloworld</span></code> 工程</p></li>
|
||||
<li><p>双击 <code class="docutils literal notranslate"><span class="pre">download</span></code> 按钮，会下载代码到芯片中，若没有编译成功则会下载默认的或者上一次的 <code class="docutils literal notranslate"><span class="pre">.bin</span></code> 文件</p></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="section" id="id5">
|
||||
<h2><span class="section-number">3.6. </span>硬件连接<a class="headerlink" href="#id5" title="永久链接至标题">¶</a></h2>
|
||||
<ul class="simple">
|
||||
<li><p>具体开发板的连接, 请参考 <a class="reference internal" href="connecting_hardware.html#connect-hardware"><span class="std std-ref">硬件连接</span></a> 部分；（eclipse 环境建议使用 <code class="docutils literal notranslate"><span class="pre">j-link</span></code> 烧写、调试）</p></li>
|
||||
<li><p>请确保开发板正确设置后再进行下面的步骤</p></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="section" id="hello-world">
|
||||
<h2><span class="section-number">3.7. </span>测试 Hello World 工程<a class="headerlink" href="#hello-world" title="永久链接至标题">¶</a></h2>
|
||||
<div class="section" id="id6">
|
||||
<h3><span class="section-number">3.7.1. </span>打开 Hello World<a class="headerlink" href="#id6" title="永久链接至标题">¶</a></h3>
|
||||
<ul class="simple">
|
||||
<li><p>打开 <code class="docutils literal notranslate"><span class="pre">examples/hellowd/helloworld/main.c</span></code> 文件，即可编辑、修改 <code class="docutils literal notranslate"><span class="pre">helloworld</span></code> 测试 demo 的代码，若修改了，请保存后在执行编译</p></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="section" id="id7">
|
||||
<h3><span class="section-number">3.7.2. </span>编译 Hello World<a class="headerlink" href="#id7" title="永久链接至标题">¶</a></h3>
|
||||
<ul class="simple">
|
||||
<li><p>双击 <code class="docutils literal notranslate"><span class="pre">bl_make</span></code> 即可编 helloworld 工程</p></li>
|
||||
<li><p>编译成功后 <code class="docutils literal notranslate"><span class="pre">Console</span></code> 窗口可以看到如下图所示的 log 信息</p></li>
|
||||
</ul>
|
||||
<div class="figure align-default">
|
||||
<img alt="_images/pic10.png" src="_images/pic10.png" />
|
||||
</div>
|
||||
</div>
|
||||
<div class="section" id="id8">
|
||||
<h3><span class="section-number">3.7.3. </span>烧写 Hello World<a class="headerlink" href="#id8" title="永久链接至标题">¶</a></h3>
|
||||
<ul class="simple">
|
||||
<li><p>双击 <code class="docutils literal notranslate"><span class="pre">download</span></code> 即可烧写 helloworld 工程 <code class="docutils literal notranslate"><span class="pre">bin</span></code> 文件到芯片中</p></li>
|
||||
<li><p>下载成功后 <code class="docutils literal notranslate"><span class="pre">Console</span></code> 窗口可以看到如下图所示的 log 信息</p></li>
|
||||
</ul>
|
||||
<div class="figure align-default">
|
||||
<img alt="_images/pic11.png" src="_images/pic11.png" />
|
||||
</div>
|
||||
</div>
|
||||
<div class="section" id="id9">
|
||||
<h3><span class="section-number">3.7.4. </span>运行 Hello World<a class="headerlink" href="#id9" title="永久链接至标题">¶</a></h3>
|
||||
<ul class="simple">
|
||||
<li><p>将开发板的 <code class="docutils literal notranslate"><span class="pre">TXD0</span></code>、<code class="docutils literal notranslate"><span class="pre">RXD0</span></code> 和 <code class="docutils literal notranslate"><span class="pre">GND</span></code> 引脚使用杜邦线连接到 USB-TTL 串口模块，将串口模块插入 PC 主机， 使用任意的串口助手软件打开串口</p></li>
|
||||
<li><p>烧写成功后，按下板子上的 <code class="docutils literal notranslate"><span class="pre">rst</span></code> 按键，如果下载正确，即可在串口助手软件中看到如下图所示的 log 信息。</p></li>
|
||||
</ul>
|
||||
<div class="figure align-default">
|
||||
<img alt="_images/eclipse_run.png" src="_images/eclipse_run.png" />
|
||||
</div>
|
||||
</div>
|
||||
<div class="section" id="id10">
|
||||
<h3><span class="section-number">3.7.5. </span>调试 Hello World<a class="headerlink" href="#id10" title="永久链接至标题">¶</a></h3>
|
||||
<ul class="simple">
|
||||
<li><p>点击 eclipse 工具栏中的 <code class="docutils literal notranslate"><span class="pre">Debug</span></code> 按钮，进入 debug 配置窗口</p></li>
|
||||
<li><p>选择 <code class="docutils literal notranslate"><span class="pre">GDB</span> <span class="pre">SEGGER</span> <span class="pre">J-Link</span> <span class="pre">Debugging->Jlink_bl_mcu_sdk</span></code> Debug 配置，在 <code class="docutils literal notranslate"><span class="pre">C/C++</span> <span class="pre">Application:</span></code> 选项中选择需要调试的 <code class="docutils literal notranslate"><span class="pre">.elf</span></code> 文件</p></li>
|
||||
<li><p>先点击 <code class="docutils literal notranslate"><span class="pre">Apply</span></code> 后，在点击 <code class="docutils literal notranslate"><span class="pre">Debug</span></code> 即可进行 <code class="docutils literal notranslate"><span class="pre">Debug</span></code></p></li>
|
||||
</ul>
|
||||
<div class="figure align-default">
|
||||
<img alt="" src="_images/pic14.png" />
|
||||
</div>
|
||||
<ul class="simple">
|
||||
<li><p>进入 Debug 界面后，即可看到程序停在了 <code class="docutils literal notranslate"><span class="pre">main</span></code>，点击上方工具栏中的 <code class="docutils literal notranslate"><span class="pre">Step</span> <span class="pre">Over</span></code>，按钮即可对代码工程进行单步调试。</p></li>
|
||||
</ul>
|
||||
<div class="figure align-default" id="id12">
|
||||
<img alt="" src="_images/pic15.png" />
|
||||
<p class="caption"><span class="caption-text">Eclipse Debugging</span><a class="headerlink" href="#id12" title="永久链接至图片">¶</a></p>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="section" id="id11">
|
||||
<h2><span class="section-number">3.8. </span>编译烧写不同的目标工程<a class="headerlink" href="#id11" title="永久链接至标题">¶</a></h2>
|
||||
<ul class="simple">
|
||||
<li><p>当右击 <code class="docutils literal notranslate"><span class="pre">bl_make</span></code> 按钮，点击 <code class="docutils literal notranslate"><span class="pre">Edit</span></code> 后，会弹出更换目标工程的配置界面，如下图所示</p></li>
|
||||
</ul>
|
||||
<div class="figure align-default">
|
||||
<img alt="" src="_images/pic12.png" />
|
||||
</div>
|
||||
<ul class="simple">
|
||||
<li><p>其中 <code class="docutils literal notranslate"><span class="pre">APP=xxx</span></code> 用户可以修改其内容，改为需要编译烧写的目标工程名，例如想要编译烧写 <code class="docutils literal notranslate"><span class="pre">gpio/gpio_blink</span></code> 工程，将其修改为 <code class="docutils literal notranslate"><span class="pre">APP=gpio_blink</span></code> 即可</p></li>
|
||||
<li><p><code class="docutils literal notranslate"><span class="pre">Build</span> <span class="pre">command</span></code> 中 <code class="docutils literal notranslate"><span class="pre">make</span> <span class="pre">BOARD=bl706_iot</span></code> 会指定不同的 Board 类型以指定适配不同类型的开发板。</p></li>
|
||||
<li><p><code class="docutils literal notranslate"><span class="pre">Board</span></code> 类型决定编译时选择相应的 <code class="docutils literal notranslate"><span class="pre">borad</span></code> 头文件。默认选择的是 BL706 的 iot 开发板 <code class="docutils literal notranslate"><span class="pre">make</span> <span class="pre">build</span> <span class="pre">BOARD=bl706_iot</span></code></p></li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
</div>
|
||||
<footer>
|
||||
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
|
||||
<a href="Linux_quick_start_ubuntu.html" class="btn btn-neutral float-right" title="4. Linux 环境开发指南" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
|
||||
<a href="Windows_quick_start_cdk.html" class="btn btn-neutral float-left" title="2. Windows 下使用 CDK (类 MDK Keil)开发指南" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
|
||||
</div>
|
||||
|
||||
<hr/>
|
||||
|
||||
<div role="contentinfo">
|
||||
<p>
|
||||
© 版权所有 2021, BouffaloLab Co., Ltd.
|
||||
|
||||
</p>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
|
||||
|
||||
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
|
||||
|
||||
provided by <a href="https://readthedocs.org">Read the Docs</a>.
|
||||
|
||||
</footer>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
</section>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<script type="text/javascript">
|
||||
jQuery(function () {
|
||||
SphinxRtdTheme.Navigation.enable(true);
|
||||
});
|
||||
</script>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</body>
|
||||
</html>
|
||||
Binary file not shown.
|
Before Width: | Height: | Size: 15 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 2.7 MiB |
Binary file not shown.
|
Before Width: | Height: | Size: 46 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 120 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 108 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 114 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 33 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 29 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 4.7 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 14 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 39 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 32 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 50 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 4.5 MiB |
Binary file not shown.
|
Before Width: | Height: | Size: 7.1 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 6.5 MiB |
Binary file not shown.
|
Before Width: | Height: | Size: 187 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 11 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 126 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 38 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 12 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 61 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 95 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 178 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 156 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 43 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 44 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 26 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 67 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 32 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 13 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 26 KiB |
|
|
@ -1,134 +0,0 @@
|
|||
Linux 环境开发指南
|
||||
=============================
|
||||
|
||||
本文档介绍了如何在 Linux 安装配置 BL702 系列 MCU 需要的软件开发工具。
|
||||
|
||||
|
||||
|
||||
需要的软硬件环境
|
||||
-----------------------------
|
||||
|
||||
- 一根 mini USB 数据线
|
||||
- 一个 USB-TTL 串口模块
|
||||
- 杜邦线若干
|
||||
|
||||
配置 RISC-V 工具链
|
||||
-----------------------------
|
||||
|
||||
.. code-block:: bash
|
||||
:linenos:
|
||||
:emphasize-lines: 4-6
|
||||
|
||||
$ cd ~
|
||||
$ wget -c https://dev.bouffalolab.com/media/upload/download/riscv64-elf-x86_64-20210120.tar.gz
|
||||
$ mkdir -p riscv64-elf-20210120
|
||||
$ tar -zxvf riscv64-elf-x86_64-20210120.tar.gz -C riscv64-elf-20210120
|
||||
$ sudo cp ~/riscv64-elf-20210120 /usr/bin
|
||||
$ echo "export PATH=\"$PATH:/usr/bin/riscv64-elf-20210120/bin\"" >> ~/.bashrc
|
||||
$ source ~/.bashrc
|
||||
|
||||
配置 cmake & make 工具
|
||||
----------------------------
|
||||
|
||||
.. code-block:: bash
|
||||
:linenos:
|
||||
:emphasize-lines: 5-7
|
||||
|
||||
$ sudo apt update
|
||||
$ sudo apt install make
|
||||
$ cd ~
|
||||
$ wget -c https://cmake.org/files/v3.19/cmake-3.19.3-Linux-x86_64.tar.gz
|
||||
$ tar -zxvf cmake-3.19.3-Linux-x86_64.tar.gz
|
||||
$ sudo cp ~/cmake-3.19.3-Linux-x86_64 /usr/bin
|
||||
$ echo "export PATH=\"$PATH:/usr/bin/cmake-3.19.3-Linux-x86_64/bin\"" >> ~/.bashrc
|
||||
$ source ~/.bashrc
|
||||
|
||||
|
||||
硬件连接
|
||||
----------------------
|
||||
|
||||
- 具体开发板的连接, 请参考 :ref:`connect_hardware` 部分
|
||||
- 请确保开发板正确设置后再进行下面的步骤 (建议 Linux 下采用串口连接)
|
||||
|
||||
|
||||
获取 bl_mcu_sdk
|
||||
---------------------------
|
||||
|
||||
- 打开终端输入以下命令获取 bl_mcu_sdk
|
||||
|
||||
.. code-block:: bash
|
||||
:linenos:
|
||||
|
||||
$ cd ~
|
||||
$ git clone https://gitee.com/bouffalolab/bl_mcu_sdk.git --recursive
|
||||
|
||||
|
||||
测试 Hello World 工程
|
||||
------------------------------
|
||||
|
||||
打开 Hello World
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
- 获取到 SDK 后，进入 sdk 中的 ``examples/hellowd/helloworld`` 目录下，打开 ``main.c``，即可编辑 helloworld 的相关代码。
|
||||
|
||||
.. code-block:: bash
|
||||
:linenos:
|
||||
|
||||
$ cd ~/bl_mcu_sdk/examples/hellowd/helloworld
|
||||
$ vi main.c
|
||||
|
||||
- 若编辑完成后，保存修改并关闭文件，接下来进行编译
|
||||
|
||||
编译 Hello World
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
.. code-block:: bash
|
||||
:linenos:
|
||||
|
||||
$ cd ~/bl_mcu_sdk
|
||||
$ make build BOARD=bl706_iot APP=helloworld
|
||||
|
||||
|
||||
烧写 Hello World
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
- 烧写前请先确认烧写方式，若采用串口烧写，请先按住板子上的 ``boot`` 键不要释放，此时在按下 ``rst`` 键，然后释放两个键，此时板子进入 boot_rom 状态。
|
||||
- 这时在终端中输入以下命令进行烧写
|
||||
|
||||
.. code-block:: bash
|
||||
:linenos:
|
||||
|
||||
$ cd ~/bl_mcu_sdk
|
||||
$ make download INTERFACE=uart
|
||||
|
||||
- 如果下载失败请检查：
|
||||
|
||||
- 1. 是否使用串口烧写，开发板是否供电，硬件连接是否正确。
|
||||
- 2. 烧写命令是否在 ``bl_mcu_sdk`` 目录下执行
|
||||
- 3. 是否进入 boot_rom 模式
|
||||
- 4. 串口是否被占用
|
||||
|
||||
运行 Hello World
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
- 打开新的终端，安装、运行串口工具
|
||||
|
||||
.. code-block:: bash
|
||||
:linenos:
|
||||
|
||||
$ sudo apt install picocom # 若已经安装请忽略
|
||||
$ picocom -b 2000000 /dev/ttyUSB0
|
||||
|
||||
- 按一下开发板上的 ``rst`` 按键，即可在串口终端中看到 ``hello world！``
|
||||
|
||||
.. figure:: img/linux1.png
|
||||
:alt:
|
||||
|
||||
helloworld!
|
||||
|
||||
|
||||
调试 Hello World
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
|
||||
|
||||
|
|
@ -1,164 +0,0 @@
|
|||
Windows 下使用 CDK (类 MDK Keil)开发指南
|
||||
=============================
|
||||
|
||||
本文档介绍了如何在 Windows 下使用 `平头哥半导体 <https://www.t-heah.cn/about>`_ 开发的 CDK 集成开发环境，
|
||||
来完成博流 BL702 系列 MCU 的相关软件开发工作。
|
||||
|
||||
关于剑池 CDK ，这是一款由平头哥半导体开发打造的集成开发环境。它拥有和传统 MCU 开发环境十分近似的操作和设置，旨在不改变用户开发习惯的基础上，全面接入云端开发资源，结合图形化的 OSTracer、Profiling 等调试分析工具，加速用户产品开发。
|
||||
|
||||
|
||||
需要的软硬件环境
|
||||
-----------------------------
|
||||
|
||||
- 剑池 CDK 软件
|
||||
- 一根 USB Type-A 数据线
|
||||
- 一个 CK-Link 仿真器
|
||||
- 一个 USB-TTL 串口模块
|
||||
- 杜邦线若干
|
||||
|
||||
|
||||
下载剑池 CDK 软件安装包
|
||||
-----------------------------
|
||||
|
||||
- `剑池CDK <https://occ.t-head.cn/development/series/download?id=3864775351511420928&type=kind&softPlatformType=4#sticky>`_ 软件安装可以从平头哥半导体 OCC 官网获取到。
|
||||
|
||||
- 下载完成后，解压缩，双击 ``setup.exe``，按照其提示，完成软件安装即可。
|
||||
|
||||
|
||||
下载 bl_mcu_sdk 软件开发包
|
||||
----------------------------
|
||||
|
||||
- 从开源社区下载 bl_mcu_sdk 软件开发包。
|
||||
|
||||
- 可以使用 ``git clone`` 或者直接 ``download`` 的方式下 SDK
|
||||
- 使用 ``git clone`` 前请确保已正确安装 ``git``，打开支持 ``git`` 的终端输入以下命令即可获取最新的 SDK。
|
||||
|
||||
.. code-block:: bash
|
||||
:linenos:
|
||||
:emphasize-lines: 1
|
||||
|
||||
$ git clone https://gitee.com/bouffalolab/bl_mcu_sdk.git --recursive
|
||||
|
||||
|
||||
硬件连接
|
||||
----------------------
|
||||
|
||||
- 具体开发板的连接, 请参考 :ref:`connect_hardware` 部分
|
||||
- 请确保开发板被正确设置后再进行下面的步骤
|
||||
|
||||
|
||||
测试 Hello World 工程
|
||||
------------------------------
|
||||
|
||||
打开 Hello World
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
- 获取到 SDK 后，进入 sdk 中的 ``examples/hellowd/helloworld/cdk`` 目录下，双击 ``helloworld.cdkproj``，即可打开 ``Helloworld`` 工程。
|
||||
|
||||
|
||||
编译 Hello World
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
.. figure:: img/cdk1.png
|
||||
:alt:
|
||||
|
||||
helloworld.cdkproj
|
||||
|
||||
- 在 CDK 工具栏中，点击编译图标即可编译工程
|
||||
|
||||
- 点击 ``1`` 处 图标 ``Build Project`` 即可编译当前选中的工程
|
||||
- 点击 ``2`` 处 图标 ``Clean Project`` 即可清除上次编译的结果
|
||||
- 点击 ``3`` 处 图标 ``Flash Download`` 即可将编译好的代码下载到芯片中
|
||||
- 点击 ``4`` 处 图标 ``Start/Stop Debug`` 即可进行 debug 的相关操作
|
||||
- 也可以在 ``Project`` 中，右击工程名称，通过右击菜单中的选项对项目进行编译等操作
|
||||
|
||||
|
||||
烧写 Hello World
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
- 由于目前 CDK 软件中还没有包含我们的 flash 算法，所以需要我们手动将 flash 算法放到 CDK 安装目录，具体操作如下：
|
||||
|
||||
- 进入 SDK 目录下 ``tools\cdk_flashloader`` 目录
|
||||
- 将目录下的 ``bl70x_flasher.elf`` 文件，拷贝到 CDK 工具的 ``C-Sky\CDK\CSKY\Flash`` 目录中
|
||||
|
||||
.. figure:: img/cdk7.png
|
||||
:alt:
|
||||
|
||||
CDK Flash Loader
|
||||
|
||||
|
||||
|
||||
.. figure:: img/cdk8.png
|
||||
:alt:
|
||||
|
||||
CDK Project Setting
|
||||
|
||||
- 点击 ``Project View`` 中的项目设置按钮，打开 ``Project Setting`` 窗口，或者通过右击 ``Project`` 名称中右击菜单栏中打开
|
||||
|
||||
- 在打开的 ``Project Setting`` 窗口中，选择 ``Flash`` 标签，配置需要的 Flash 算法
|
||||
|
||||
.. figure:: img/cdk9.png
|
||||
:alt:
|
||||
|
||||
CDK Project Flash setting
|
||||
|
||||
- 在 ``Flash`` 标签中，点击 ``Add`` 按纽，在打开的列表中选择 ``bl70x_flash`` 算法，点击 ``Add`` 添加到工程中，``Flash`` 标签下的其他设置，如图所示：
|
||||
|
||||
- 点击 OK 后，如配置正确，点击 ``Flash Download`` 即可将编译好的代码下载到芯片中
|
||||
|
||||
|
||||
.. figure:: img/cdk5.png
|
||||
:alt:
|
||||
|
||||
CDK Flashdownload Success
|
||||
|
||||
- 如下载失败请检查：
|
||||
|
||||
- 1. 代码是否被正确编译，并生成 ``.elf`` ``.bin`` 等文件
|
||||
- 2. Flash 算法是否被正确设置
|
||||
- 3. CK-Link 与开发板是否正确连接
|
||||
- 4. 开发板是否正常供电，电源指示灯是否点亮
|
||||
|
||||
运行 Hello World
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
- 从 CDK 的菜单栏 ``View->Serial Pane``，打开串口面板，在打开的 ``Serial Pane`` 中右击，进行串口设置，选择你对应的串口号和波特率
|
||||
|
||||
.. figure:: img/cdk4.png
|
||||
.. figure:: img/cdk3.png
|
||||
:alt:
|
||||
|
||||
CDK Serial Pane setting
|
||||
|
||||
- 按下板子上的 ``RST`` 按键，即可在串口中看到代码的运行结果
|
||||
|
||||
.. figure:: img/cdk6.png
|
||||
:alt:
|
||||
|
||||
HelloWorld！
|
||||
|
||||
|
||||
调试 Hello World
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
- 点击工具栏上方的 ``Start/Stop Debugger`` 按钮，进入 debug 界面，如下图所示
|
||||
|
||||
.. figure:: img/cdk10.png
|
||||
:alt:
|
||||
|
||||
Debug HelloWorld！
|
||||
|
||||
- 在 debug 界面下，左侧的 ``Register`` 窗口中，可以查看 ``CPU`` 内部寄存器数据；右侧的 ``Peripherals`` 外设面板中，
|
||||
可以查看相应外设寄存器数据，外设的选择可以在顶部菜单栏的 ``Peripherals->System Viewer`` 选择；
|
||||
点击上方工具栏中的相关调试按钮可以进行断点设置、单步调试、指令单步和全速运行等操作。
|
||||
当然这些操作都有相应的快捷键和快捷设置方法，详情请参考 ``CDK Help``，这里就不作过多介绍了。
|
||||
|
||||
- 我们点击单步运行按钮，运行代码，即可看到指示光标移动到下一句代码，同时可以看到串口面板中显示了我们输出的 ``Hello World！``
|
||||
|
||||
.. figure:: img/cdk11.png
|
||||
:alt:
|
||||
|
||||
Debug HelloWorld！
|
||||
|
||||
|
||||
|
||||
|
|
@ -1,175 +0,0 @@
|
|||
Windows 下使用 Eclipse 开发指南
|
||||
=============================
|
||||
|
||||
本文档介绍了如何在 Windows 下使用 eclipse，构建 BL702 系列 MCU 的软件开发环境。
|
||||
|
||||
|
||||
需要的软硬件环境
|
||||
-----------------------------
|
||||
|
||||
- Eclipse 免安装软件包
|
||||
- 串口助手软件
|
||||
- 一根 USB Type-A 数据线
|
||||
- 一个 j-link 仿真器
|
||||
- 一个 USB-TTL 串口模块
|
||||
- 杜邦线若干
|
||||
|
||||
|
||||
下载 Eclipse 安装包
|
||||
-----------------------------
|
||||
|
||||
- 从 Bouffalo Lab 开发者社区下载带有 RISC-V 工具链的 `Eclipse https://dev.bouffalolab.com/download <https://dev.bouffalolab.com/media/upload/download/BouffaloLab_eclipse_x86_64_win.zip>`_ 安装包。
|
||||
|
||||
下载 bl_mcu_sdk
|
||||
-----------------------------
|
||||
|
||||
- 从开源社区下载 `bl_mcu_sdk <https://gitee.com/bouffalolab/bl_mcu_sdk.git>`_ 软件开发包。
|
||||
|
||||
- 可以使用 ``git clone`` 或者直接 ``download`` 的方式下 SDK
|
||||
- 使用 ``git clone`` 前请确保已正确安装 ``git``，打开支持 ``git`` 的终端输入以下命令即可获取最新的 SDK。
|
||||
|
||||
.. code-block:: bash
|
||||
:linenos:
|
||||
:emphasize-lines: 1
|
||||
|
||||
$ git clone https://gitee.com/bouffalolab/bl_mcu_sdk.git --recursive
|
||||
|
||||
|
||||
配置 eclipse 开发环境
|
||||
----------------------------
|
||||
|
||||
- 将获取到的 eclipse 压缩包拷贝到您的工作目录，解压 eclipse 压缩包
|
||||
- 进入 eclipse 目录，双击 ``eclipse.exe`` 启动 eclipse
|
||||
- 选择您的 ``Workspace`` 目录，点击 ``Launch`` 进入工作空间
|
||||
|
||||
.. figure:: img/pic1.png
|
||||
:alt:
|
||||
|
||||
- 点击菜单栏中 ``Window->preferences`` 打开环境配置相关页面，准备导入相关的配置环境
|
||||
|
||||
.. figure:: img/pic2.png
|
||||
:alt:
|
||||
|
||||
- 点击下图 1 处的图标，打开导入配置界面，按照如图所示步骤，选择 ``eclipse.exe`` 目录下的 ``bflb_mcu_preferences.epf`` 配置文件。
|
||||
|
||||
.. figure:: img/pic3.png
|
||||
:alt:
|
||||
|
||||
- 选择好对应的文件后，点击 ``Finish``，在弹出的对话框选中点击 ``cancel`` ，不用重新启动。
|
||||
|
||||
.. figure:: img/pic4.png
|
||||
:alt:
|
||||
|
||||
导入 bl_mcu_sdk
|
||||
--------------------------
|
||||
|
||||
- 点击 菜单栏 ``File->Import`` ，打开导入项目的配置界面
|
||||
|
||||
.. figure:: img/pic5.png
|
||||
:alt:
|
||||
|
||||
- 在打开的 ``Import`` 窗口中选择 ``General->Existing Projects into Workspace`` ，然后点击 ``Next``
|
||||
|
||||
.. figure:: img/pic6.png
|
||||
:alt:
|
||||
|
||||
- 加载 bl_mcu_sdk 的工程路径后，点击 ``Finsh`` 完成导入
|
||||
|
||||
.. figure:: img/pic7.png
|
||||
:alt:
|
||||
|
||||
- 导入完成后，关闭 ``Welcome`` 窗口即可看到导入的工程
|
||||
|
||||
.. figure:: img/pic8.png
|
||||
:alt:
|
||||
|
||||
.. figure:: img/pic9.png
|
||||
:alt:
|
||||
|
||||
- 展开 ``Build Target`` 目录，即可看到 ``bl_clean``、``bl_make``、``download`` 三个功能按钮。
|
||||
|
||||
- 双击 ``bl_clean`` 按钮，会清除 ``build`` 和 ``out`` 两个目录下的编译缓存
|
||||
- 双击 ``bl_make`` 按钮，会正常编译设置的 case，若没有修改默认配置则会编译 ``helloworld`` 工程
|
||||
- 双击 ``download`` 按钮，会下载代码到芯片中，若没有编译成功则会下载默认的或者上一次的 ``.bin`` 文件
|
||||
|
||||
|
||||
硬件连接
|
||||
----------------------
|
||||
|
||||
- 具体开发板的连接, 请参考 :ref:`connect_hardware` 部分；（eclipse 环境建议使用 ``j-link`` 烧写、调试）
|
||||
- 请确保开发板正确设置后再进行下面的步骤
|
||||
|
||||
|
||||
测试 Hello World 工程
|
||||
------------------------------
|
||||
|
||||
|
||||
打开 Hello World
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
- 打开 ``examples/hellowd/helloworld/main.c`` 文件，即可编辑、修改 ``helloworld`` 测试 demo 的代码，若修改了，请保存后在执行编译
|
||||
|
||||
|
||||
编译 Hello World
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
- 双击 ``bl_make`` 即可编 helloworld 工程
|
||||
|
||||
- 编译成功后 ``Console`` 窗口可以看到如下图所示的 log 信息
|
||||
|
||||
.. figure:: img/pic10.png
|
||||
|
||||
|
||||
烧写 Hello World
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
- 双击 ``download`` 即可烧写 helloworld 工程 ``bin`` 文件到芯片中
|
||||
|
||||
- 下载成功后 ``Console`` 窗口可以看到如下图所示的 log 信息
|
||||
|
||||
.. figure:: img/pic11.png
|
||||
|
||||
|
||||
运行 Hello World
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
- 将开发板的 ``TXD0``、``RXD0`` 和 ``GND`` 引脚使用杜邦线连接到 USB-TTL 串口模块，将串口模块插入 PC 主机， 使用任意的串口助手软件打开串口
|
||||
- 烧写成功后，按下板子上的 ``rst`` 按键，如果下载正确，即可在串口助手软件中看到如下图所示的 log 信息。
|
||||
|
||||
.. figure:: img/eclipse_run.png
|
||||
|
||||
|
||||
调试 Hello World
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
- 点击 eclipse 工具栏中的 ``Debug`` 按钮，进入 debug 配置窗口
|
||||
- 选择 ``GDB SEGGER J-Link Debugging->Jlink_bl_mcu_sdk`` Debug 配置，在 ``C/C++ Application:`` 选项中选择需要调试的 ``.elf`` 文件
|
||||
- 先点击 ``Apply`` 后，在点击 ``Debug`` 即可进行 ``Debug``
|
||||
|
||||
.. figure:: img/pic14.png
|
||||
:alt:
|
||||
|
||||
- 进入 Debug 界面后，即可看到程序停在了 ``main``，点击上方工具栏中的 ``Step Over``，按钮即可对代码工程进行单步调试。
|
||||
|
||||
.. figure:: img/pic15.png
|
||||
:alt:
|
||||
|
||||
Eclipse Debugging
|
||||
|
||||
|
||||
编译烧写不同的目标工程
|
||||
-----------------------
|
||||
|
||||
- 当右击 ``bl_make`` 按钮，点击 ``Edit`` 后，会弹出更换目标工程的配置界面，如下图所示
|
||||
|
||||
.. figure:: img/pic12.png
|
||||
:alt:
|
||||
|
||||
|
||||
- 其中 ``APP=xxx`` 用户可以修改其内容，改为需要编译烧写的目标工程名，例如想要编译烧写 ``gpio/gpio_blink`` 工程，将其修改为 ``APP=gpio_blink`` 即可
|
||||
- ``Build command`` 中 ``make BOARD=bl706_iot`` 会指定不同的 Board 类型以指定适配不同类型的开发板。
|
||||
|
||||
- ``Board`` 类型决定编译时选择相应的 ``borad`` 头文件。默认选择的是 BL706 的 iot 开发板 ``make build BOARD=bl706_iot``
|
||||
|
||||
|
||||
|
||||
|
|
@ -1,896 +0,0 @@
|
|||
API 分层模型
|
||||
=========================
|
||||
|
||||
简介
|
||||
----
|
||||
|
||||
为了不影响用户应用层代码因为芯片驱动的不同而频繁修改，**bl_mcu_sdk** 的外设 API 采用了 HAL 层的思想，屏蔽了底层硬件的实现。而 HAL 层又分为两大类：
|
||||
|
||||
- 设备驱动管理层：提供一套标准的接口，具体实现由外设驱动适配层实现。
|
||||
- 外设驱动适配层：实现设备驱动管理层的标准接口，并且拓展自己的独特的接口。
|
||||
|
||||
整体的代码分层框架如图所示：
|
||||
|
||||
.. figure:: img/api1.png
|
||||
:alt:
|
||||
|
||||
code structure
|
||||
|
||||
- 应用层是用户自己编写的代码，接口则是调用 hal 层的接口。
|
||||
- HAL 层提供给应用层接口，底层调用 std 层，不同的芯片调用不同的 std 层。
|
||||
- STD 层则是对硬件寄存器进行简单封装，由外设驱动适配层进行调用。
|
||||
|
||||
设备驱动管理层实现
|
||||
---------------------
|
||||
|
||||
设备驱动管理层的实现采用了面向对象的思想，首先我们将外设看成是一个设备或者是文件，秉承 **一切皆文件** 的理念，而文件又都具有标准的调用接口：``open``、``close``、``ctrl``、``write``、``read``、``callback``，不同文件类别不同（比如串口设备、ADC设备、SPI设备），并且打开的方式也不同（比如轮询、中断、DMA），由此，我们可以构建出一个对象的基类（父类）。
|
||||
|
||||
**基类**
|
||||
|
||||
.. code-block:: C
|
||||
|
||||
struct device
|
||||
{
|
||||
char name[NAME_MAX]; /*name of device */
|
||||
dlist_t list; /*list node of device */
|
||||
enum device_status_type status; /*status of device */
|
||||
enum device_class_type type; /*type of device */
|
||||
uint16_t oflag; /*oflag of device */
|
||||
|
||||
int (*open)(struct device *dev, uint16_t oflag);
|
||||
int (*close)(struct device *dev);
|
||||
int (*control)(struct device *dev, int cmd, void *args);
|
||||
int (*write)(struct device *dev, uint32_t pos, const void *buffer, uint32_t size);
|
||||
int (*read)(struct device *dev, uint32_t pos, void *buffer, uint32_t size);
|
||||
void (*callback)(struct device *dev, void *args, uint32_t size, uint32_t event);
|
||||
void *handle;
|
||||
};
|
||||
|
||||
**基类成员：name**
|
||||
|
||||
给设备取名，后面会使用 ``device_find`` 找到这个设备。
|
||||
|
||||
**基类成员：type**
|
||||
|
||||
``type`` 记录当前设备的类别，可以选择的 ``type`` 类型如下。
|
||||
|
||||
.. code-block:: C
|
||||
|
||||
enum device_class_type
|
||||
{
|
||||
DEVICE_CLASS_NONE = 0,
|
||||
DEVICE_CLASS_GPIO,
|
||||
DEVICE_CLASS_UART,
|
||||
DEVICE_CLASS_SPI,
|
||||
DEVICE_CLASS_I2C,
|
||||
DEVICE_CLASS_ADC,
|
||||
DEVICE_CLASS_DMA,
|
||||
DEVICE_CLASS_TIMER,
|
||||
DEVICE_CLASS_PWM,
|
||||
DEVICE_CLASS_SDIO,
|
||||
DEVICE_CLASS_USB,
|
||||
DEVICE_CLASS_I2S,
|
||||
DEVICE_CLASS_CAMERA,
|
||||
DEVICE_CLASS_SEC_HASH,
|
||||
} ;
|
||||
|
||||
**基类成员：status**
|
||||
|
||||
``status`` 用来记录当前设备的状态，当前提供 4 种状态。
|
||||
|
||||
.. code-block:: C
|
||||
|
||||
enum device_status_type
|
||||
{
|
||||
DEVICE_UNREGISTER = 0,
|
||||
DEVICE_REGISTERED,
|
||||
DEVICE_OPENED,
|
||||
DEVICE_CLOSED
|
||||
} ;
|
||||
|
||||
**基类成员：oflag**
|
||||
|
||||
``oflag`` 记录 注册时填入的 flag 信息以及使用 ``device_open`` 时填入的 ``oflag`` 信息。
|
||||
|
||||
**基类成员：list**
|
||||
|
||||
设备的增加和删除使用双向链表进行存储，节省内存。
|
||||
|
||||
**基类成员：标准的函数指针**
|
||||
|
||||
为不同的外设提供了标准的函数接口，当外设实现此类接口并赋值给该成员，便能达到重写的功能。
|
||||
|
||||
设备驱动管理层标准接口
|
||||
-----------------------
|
||||
|
||||
**device_register**
|
||||
^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
``device_register`` 用于设备的注册，将设备信息注册到链表当中。
|
||||
|
||||
.. code-block:: C
|
||||
|
||||
int device_register(struct device *dev, const char *name, uint16_t flag);
|
||||
|
||||
- dev 设备句柄。
|
||||
- name 设备名称。
|
||||
- flag 设备的读写属性
|
||||
- return 返回错误码，0 表示注册成功，其他表示错误。
|
||||
|
||||
``flag`` 可以写入以下参数，表示：**只读**、**只写**、**可读可写**。
|
||||
|
||||
.. code-block:: C
|
||||
|
||||
#define DEVICE_OFLAG_RDONLY 0x1000 /* 以只读方式打开设备 */
|
||||
#define DEVICE_OFLAG_WRONLY 0x2000 /* 以只写方式打开设备 */
|
||||
#define DEVICE_OFLAG_RDWR 0x3000 /* 以读写方式打开设备 */
|
||||
|
||||
|
||||
**device_unregister**
|
||||
^^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
``device_unregister`` 用于设备的删除，将设备信息从链表中删除。
|
||||
|
||||
.. code-block:: C
|
||||
|
||||
int device_unregister(const char *name);
|
||||
|
||||
- dev 设备句柄
|
||||
- name 要删除的设备名称
|
||||
- return 错误码，0 表示删除，其他表示错误
|
||||
|
||||
**device_find**
|
||||
^^^^^^^^^^^^^^^^
|
||||
|
||||
``device_find`` 用于根据 ``name`` 从链表中寻找设备，并返回设备句柄的首地址。
|
||||
|
||||
.. code-block:: C
|
||||
|
||||
struct device *device_find(const char *name);
|
||||
|
||||
- dev 设备句柄
|
||||
- name 要查找的设备名称
|
||||
- return 错误码，不为 0 表示找到的设备句柄，NULL 表示未找到该设备。
|
||||
|
||||
|
||||
**device_open**
|
||||
^^^^^^^^^^^^^^^^
|
||||
|
||||
``device_open`` 用于设备的打开，``oflag`` 表示以何种方式打开，目前提供 6 种打开方式。底层调用 ``dev`` 句柄中的 ``open`` 成员。
|
||||
|
||||
.. code-block:: C
|
||||
|
||||
int device_open(struct device *dev, uint16_t oflag);
|
||||
|
||||
- dev 设备句柄
|
||||
- oflag 设备的打开方式
|
||||
- return 错误码，0 表示打开成功，其他表示错误
|
||||
|
||||
``oflag`` 可以写入以下参数：
|
||||
|
||||
.. code-block:: C
|
||||
|
||||
#define DEVICE_OFLAG_STREAM_TX 0x001 /* 设备以轮训发送模式打开 */
|
||||
#define DEVICE_OFLAG_STREAM_RX 0x002 /* 设备以轮训接收模式打开 */
|
||||
#define DEVICE_OFLAG_INT_TX 0x004 /* 设备以中断发送模式打开 */
|
||||
#define DEVICE_OFLAG_INT_RX 0x008 /* 设备以中断接收模式打开 */
|
||||
#define DEVICE_OFLAG_DMA_TX 0x010 /* 设备以 DMA 发送模式打开 */
|
||||
#define DEVICE_OFLAG_DMA_RX 0x020 /* 设备以 DMA 接收模式打开 */
|
||||
|
||||
**device_close**
|
||||
^^^^^^^^^^^^^^^^
|
||||
|
||||
``device_close`` 用于设备的关闭。底层调用 ``dev`` 句柄中的 ``close`` 成员。
|
||||
|
||||
.. code-block:: C
|
||||
|
||||
int device_close(struct device *dev);
|
||||
|
||||
- dev 设备句柄
|
||||
- return 错误码，0 表示关闭成功，其他表示错误
|
||||
|
||||
**device_control**
|
||||
^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
``device_control`` 用于根据命令对设备进行控制和参数的修改。底层调用 ``dev`` 句柄中的 ``control`` 成员。
|
||||
|
||||
.. code-block:: C
|
||||
|
||||
int device_control(struct device *dev, int cmd, void *args);
|
||||
|
||||
- dev 设备句柄
|
||||
- cmd 设备控制命令
|
||||
- args 控制参数
|
||||
- return 不同的控制命令返回的意义不同。
|
||||
|
||||
``cmd`` 提供了以下标准命令，除此之外，不同外设还具有自己的命令
|
||||
|
||||
.. code-block:: C
|
||||
|
||||
#define DEVICE_CTRL_SET_INT 0x01 /* set interrupt */
|
||||
#define DEVICE_CTRL_CLR_INT 0x02 /* clear interrupt */
|
||||
#define DEVICE_CTRL_GET_INT 0x03 /* get interrupt status*/
|
||||
#define DEVICE_CTRL_RESUME 0x04 /* resume device */
|
||||
#define DEVICE_CTRL_SUSPEND 0x05 /* suspend device */
|
||||
#define DEVICE_CTRL_CONFIG 0x06 /* config device */
|
||||
#define DEVICE_CTRL_GET_CONFIG 0x07 /* get device configuration */
|
||||
#define DEVICE_CTRL_ATTACH_TX_DMA 0x08
|
||||
#define DEVICE_CTRL_ATTACH_RX_DMA 0x09
|
||||
#define DEVICE_CTRL_TX_DMA_SUSPEND 0x0a
|
||||
#define DEVICE_CTRL_RX_DMA_SUSPEND 0x0b
|
||||
#define DEVICE_CTRL_TX_DMA_RESUME 0x0c
|
||||
#define DEVICE_CTRL_RX_DMA_RESUME 0x0d
|
||||
#define DEVICE_CTRL_RESVD1 0x0E
|
||||
#define DEVICE_CTRL_RESVD2 0x0F
|
||||
|
||||
**device_write**
|
||||
^^^^^^^^^^^^^^^^
|
||||
|
||||
``device_write`` 用于数据的发送，发送方式根据打开方式可以是轮询、中断、dma。底层调用 ``dev`` 句柄中的 ``write`` 成员。
|
||||
|
||||
.. code-block:: C
|
||||
|
||||
int device_write(struct device *dev, uint32_t pos, const void *buffer, uint32_t size);
|
||||
|
||||
- dev 设备句柄
|
||||
- pos 不同的设备 pos 的意义不同
|
||||
- buffer 要写入的 buffer 缓冲区
|
||||
- size 要写入的长度
|
||||
- return 错误码，0 表示写入成功，其他表示错误
|
||||
|
||||
**device_read**
|
||||
^^^^^^^^^^^^^^^^
|
||||
|
||||
``device_read`` 用于数据的接收，接收方式根据打开方式可以是轮询、中断、dma。底层调用 ``dev`` 句柄中的 ``read`` 成员。
|
||||
|
||||
.. code-block:: C
|
||||
|
||||
int device_read(struct device *dev, uint32_t pos, void *buffer, uint32_t size);
|
||||
|
||||
- dev 设备句柄
|
||||
- pos 不同的设备 pos 的意义不同
|
||||
- buffer 要读入的 buffer 缓冲区
|
||||
- size 要读入的长度
|
||||
- return 错误码，0 表示读入成功，其他表示错误
|
||||
|
||||
**device_set_callback**
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
``device_set_callback`` 用于中断回调函数的注册。底层调用 ``dev`` 句柄中的 ``callback`` 成员。
|
||||
|
||||
.. code-block:: C
|
||||
|
||||
int device_set_callback(struct device *dev, void (*callback)(struct device *dev, void *args, uint32_t size, uint32_t event));
|
||||
|
||||
- dev 设备句柄
|
||||
- callback 要注册的中断回调函数
|
||||
|
||||
|
||||
* dev 设备句柄
|
||||
* args 不同外设意义不同
|
||||
* size 传输长度
|
||||
* event 中断事件类型
|
||||
|
||||
外设驱动适配层实现
|
||||
------------------------
|
||||
|
||||
**子类继承父类**
|
||||
|
||||
不同的外设首成员为 ``struct device`` ，这就相当于父类的继承，从而可以使用子类来访问父类成员，当使用子类修改父类成员时，便拥有了子类自己的功能。实现原理是不同结构体的首地址是该结构体中首个成员的地址。
|
||||
|
||||
.. code-block:: C
|
||||
|
||||
typedef struct xxx_device
|
||||
{
|
||||
struct device parent;
|
||||
|
||||
} xxx_device_t;
|
||||
|
||||
**重写标准接口**
|
||||
|
||||
每个外设都有一个 ``xxx_register`` 函数，用来重写标准接口。
|
||||
|
||||
.. code-block:: C
|
||||
|
||||
dev->open = xxx_open;
|
||||
dev->close = xxx_close;
|
||||
dev->control = xxx_control;
|
||||
dev->write = xxx_write;
|
||||
dev->read = xxx_read;
|
||||
|
||||
|
||||
时钟树
|
||||
=========================
|
||||
|
||||
简介
|
||||
------------------------
|
||||
|
||||
博流系列芯片拥有丰富的时钟源选择，为方便用户配置，提供了时钟树配置表，不需要用户手动调用时钟设置接口，用户只需要关心最终的系统时钟和外设时钟频率即可。时钟配置表位于 ``bsp/board/xxx_board`` 目录下 ``xxx_clock_config.h`` 文件。
|
||||
|
||||
|
||||
时钟频率获取接口
|
||||
------------------------
|
||||
|
||||
**system_clock_get**
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
``system_clock_get`` 用来获取系统时钟频率。
|
||||
|
||||
.. code-block:: C
|
||||
|
||||
uint32_t system_clock_get(enum system_clock_type type);
|
||||
|
||||
- type 获取的系统时钟频率类型
|
||||
|
||||
``type`` 提供以下几种类型
|
||||
|
||||
.. code-block:: C
|
||||
|
||||
enum system_clock_type
|
||||
{
|
||||
SYSTEM_CLOCK_ROOT_CLOCK = 0,
|
||||
SYSTEM_CLOCK_FCLK,
|
||||
SYSTEM_CLOCK_BCLK,
|
||||
SYSTEM_CLOCK_XCLK,
|
||||
};
|
||||
|
||||
|
||||
**peripheral_clock_get**
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
``peripheral_clock_get`` 用来获取外设时钟频率。
|
||||
|
||||
.. code-block:: C
|
||||
|
||||
uint32_t peripheral_clock_get(enum peripheral_clock_type type);
|
||||
|
||||
- type 获取的外设时钟频率类型
|
||||
|
||||
``type`` 提供以下几种类型
|
||||
|
||||
.. code-block:: C
|
||||
|
||||
enum peripheral_clock_type
|
||||
{
|
||||
PERIPHERAL_CLOCK_UART = 0,
|
||||
PERIPHERAL_CLOCK_SPI,
|
||||
PERIPHERAL_CLOCK_I2C,
|
||||
PERIPHERAL_CLOCK_ADC,
|
||||
PERIPHERAL_CLOCK_DAC,
|
||||
PERIPHERAL_CLOCK_I2S,
|
||||
};
|
||||
|
||||
|
||||
GPIO 设备
|
||||
=========================
|
||||
|
||||
|
||||
简介
|
||||
------------------------
|
||||
|
||||
GPIO 全称 General Purpose Input Output（通用输入 / 输出），博流系列芯片的 GPIO 外设主要有以下功能。
|
||||
|
||||
- 普通输入输出带上下拉
|
||||
- 复用功能带上下拉
|
||||
- 模拟功能
|
||||
- 外部中断（上升沿、下降沿、高电平、低电平）
|
||||
- 硬件消抖
|
||||
- 驱动能力控制
|
||||
|
||||
bl mcu sdk 的引脚配置方式分为两种。
|
||||
|
||||
- GPIO 复用功能通过专门的 **pinmux table** ，用户只需要修改 table 中的相关引脚的功能，程序会自动配置这些引脚。**pinmux table** 位于 ``bsp/board/xxx_board`` 目录下 ``pinmux_config.h`` 文件。
|
||||
- 通过标准的 GPIO 设备接口配置引脚，缺点是只能配置普通的输入输出和中断功能，复用功能建议还是使用 table 进行配置。
|
||||
|
||||
GPIO 设备接口
|
||||
------------------------
|
||||
|
||||
**gpio_set_mode**
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
``gpio_set_mode`` 用来配置 gpio 的模式。
|
||||
|
||||
.. code-block:: C
|
||||
|
||||
void gpio_set_mode(uint32_t pin, uint32_t mode);
|
||||
|
||||
- pin 要配置的引脚
|
||||
- mode 要配置的引脚功能
|
||||
|
||||
mode 提供以下几种类型
|
||||
|
||||
.. code-block:: C
|
||||
|
||||
#define GPIO_OUTPUT_MODE 0
|
||||
#define GPIO_OUTPUT_PP_MODE 1
|
||||
#define GPIO_OUTPUT_PD_MODE 2
|
||||
#define GPIO_INPUT_MODE 3
|
||||
#define GPIO_INPUT_PP_MODE 4
|
||||
#define GPIO_INPUT_PD_MODE 5
|
||||
#define GPIO_ASYNC_RISING_TRIGER_INT_MODE 6
|
||||
#define GPIO_ASYNC_FALLING_TRIGER_INT_MODE 7
|
||||
#define GPIO_ASYNC_HIGH_LEVEL_INT_MODE 8
|
||||
#define GPIO_ASYNC_LOW_LEVEL_INT_MODE 9
|
||||
#define GPIO_SYNC_RISING_TRIGER_INT_MODE 10
|
||||
#define GPIO_SYNC_FALLING_TRIGER_INT_MODE 11
|
||||
#define GPIO_SYNC_HIGH_LEVEL_INT_MODE 12
|
||||
#define GPIO_SYNC_LOW_LEVEL_INT_MODE 13
|
||||
|
||||
**gpio_write**
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
``gpio_write`` 设置引脚电平
|
||||
|
||||
.. code-block:: C
|
||||
|
||||
void gpio_write(uint32_t pin, uint32_t value);
|
||||
|
||||
|
||||
- pin 要设置的引脚
|
||||
- value 要设置的电平
|
||||
|
||||
|
||||
**gpio_toggle**
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
``gpio_toggle`` 翻转引脚电平
|
||||
|
||||
.. code-block:: C
|
||||
|
||||
void gpio_toggle(uint32_t pin);
|
||||
|
||||
|
||||
- pin 要翻转的引脚
|
||||
|
||||
|
||||
**gpio_read**
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
``gpio_read`` 读取引脚电平
|
||||
|
||||
.. code-block:: C
|
||||
|
||||
int gpio_read(uint32_t pin);
|
||||
|
||||
|
||||
- pin 要读取电平的引脚
|
||||
- return 0 为低电平，1 为高电平
|
||||
|
||||
**gpio_attach_irq**
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
``gpio_attach_irq`` 为中断引脚附加中断回调函数
|
||||
|
||||
.. code-block:: C
|
||||
|
||||
void gpio_attach_irq(uint32_t pin, void (*cbFun)(void));
|
||||
|
||||
- pin 要附加中断回调的引脚
|
||||
- cbFun 中断回调函数
|
||||
|
||||
**gpio_irq_enable**
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
``gpio_irq_enable`` 读取引脚电平
|
||||
|
||||
.. code-block:: C
|
||||
|
||||
void gpio_irq_enable(uint32_t pin,uint8_t enabled);
|
||||
|
||||
- pin 要开启或者关闭中断的引脚
|
||||
- enabled 0 为关闭中断，1 为打开中断
|
||||
|
||||
|
||||
UART 设备
|
||||
=========================
|
||||
|
||||
简介
|
||||
------------------------
|
||||
|
||||
UART 全称（Universal Asynchronous Receiver/Transmitter）通用异步收发传输器，博流系列芯片的 UART 外设自带可配深度 **硬件fifo** ，并且拥有 **RTO（接收超时）中断** ，在使用中断的时候，无需频繁进入中断，fifo 和 rto 的搭配能够使得 UART 的利用性更加高效，UART 设备具有以下功能。
|
||||
|
||||
- 轮询收发模式
|
||||
- 中断收发模式
|
||||
- dma 收发模式
|
||||
- 自动波特率检测
|
||||
- 硬件 fifo
|
||||
- 特有的 rto 中断
|
||||
|
||||
UART 设备结构体定义
|
||||
------------------------
|
||||
|
||||
.. code-block:: C
|
||||
|
||||
typedef struct uart_device
|
||||
{
|
||||
struct device parent;
|
||||
uint8_t id;
|
||||
uint32_t baudrate;
|
||||
uart_databits_t databits;
|
||||
uart_stopbits_t stopbits;
|
||||
uart_parity_t parity;
|
||||
uint8_t fifo_threshold;
|
||||
void* tx_dma;
|
||||
void* rx_dma;
|
||||
} uart_device_t;
|
||||
|
||||
- parent 继承父类属性
|
||||
- id 串口 id，0 表示串口 0，,1 表示串口 1，以此类推
|
||||
- baudrate 波特率
|
||||
- databits 数据位
|
||||
- stopbits 停止位
|
||||
- parity 校验位
|
||||
- fifo_threshold fifo 阈值,不同 mcu 最大值不同
|
||||
- tx_dma 附加的发送 dma 句柄
|
||||
- rx_dma 附加的接收 dma 句柄
|
||||
|
||||
databits 提供以下类型
|
||||
|
||||
.. code-block:: C
|
||||
|
||||
typedef enum
|
||||
{
|
||||
UART_DATA_LEN_5 = 0, /*!< Data length is 5 bits */
|
||||
UART_DATA_LEN_6 = 1, /*!< Data length is 6 bits */
|
||||
UART_DATA_LEN_7 = 2, /*!< Data length is 7 bits */
|
||||
UART_DATA_LEN_8 = 3 /*!< Data length is 8 bits */
|
||||
} uart_databits_t;
|
||||
|
||||
stopbits 提供以下类型
|
||||
|
||||
.. code-block:: C
|
||||
|
||||
typedef enum
|
||||
{
|
||||
UART_STOP_ONE = 0, /*!< One stop bit */
|
||||
UART_STOP_ONE_D_FIVE = 0, /*!< 1.5 stop bit */
|
||||
UART_STOP_TWO = 1 /*!< Two stop bits */
|
||||
} uart_stopbits_t;
|
||||
|
||||
``parity`` 提供以下类型
|
||||
|
||||
.. code-block:: C
|
||||
|
||||
typedef enum
|
||||
{
|
||||
UART_PAR_NONE = 0, /*!< No parity */
|
||||
UART_PAR_ODD = 1, /*!< Parity bit is odd */
|
||||
UART_PAR_EVEN = 2, /*!< Parity bit is even */
|
||||
} uart_parity_t;
|
||||
|
||||
UART 设备参数配置表
|
||||
------------------------
|
||||
|
||||
每一个 UART 设备都有一个参数配置，配置文件位于 ``bsp/board/xxx_board`` 目录下 ``peripheral_config.h`` 文件。当用户打开对应设备的宏，该设备的配置才生效。例如打开宏 ``BSP_USING_UART0`` ，UART0 设备就可以进行注册和使用了。
|
||||
|
||||
.. code-block:: C
|
||||
|
||||
uart_device_t uartx_device[UART_MAX_INDEX] =
|
||||
{
|
||||
#ifdef BSP_USING_UART0
|
||||
UART0_CONFIG,
|
||||
#endif
|
||||
#ifdef BSP_USING_UART1
|
||||
UART1_CONFIG,
|
||||
#endif
|
||||
};
|
||||
|
||||
#if defined(BSP_USING_UART0)
|
||||
#ifndef UART0_CONFIG
|
||||
#define UART0_CONFIG \
|
||||
{ \
|
||||
.id = 0, \
|
||||
.baudrate = 2000000,\
|
||||
.databits = UART_DATA_LEN_8, \
|
||||
.stopbits = UART_STOP_ONE, \
|
||||
.parity = UART_PAR_NONE, \
|
||||
.fifo_threshold = 1, \
|
||||
}
|
||||
#endif
|
||||
#endif
|
||||
|
||||
UART 设备接口
|
||||
------------------------
|
||||
|
||||
UART 设备接口全部遵循标准设备驱动管理层提供的接口。
|
||||
|
||||
**uart_register**
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
``uart_register`` 用来注册一个 UART 设备，在注册之前需要打开对应 UART 设备的宏定义,例如 ``BSP_USING_UART0`` 方可使用 UART0 设备。注册完成以后才可以使用其他接口，如果没有定义宏，则无法使用 UART 设备。
|
||||
|
||||
.. code-block:: C
|
||||
|
||||
int uart_register(enum uart_index_type index, const char *name, uint16_t flag);
|
||||
|
||||
- index 要注册的设备索引
|
||||
- name 为注册的设备命名
|
||||
- flag 默认可读可写属性
|
||||
|
||||
``index`` 用来选择 UART 设备配置，一个 index 对应一个 UART 设备配置，比如 ``UART0_INDEX`` 对应 UART0 配置，``index`` 有如下可选类型
|
||||
|
||||
.. code-block:: C
|
||||
|
||||
enum uart_index_type
|
||||
{
|
||||
#ifdef BSP_USING_UART0
|
||||
UART0_INDEX,
|
||||
#endif
|
||||
#ifdef BSP_USING_UART1
|
||||
UART1_INDEX,
|
||||
#endif
|
||||
#ifdef BSP_USING_UART2
|
||||
UART2_INDEX,
|
||||
#endif
|
||||
#ifdef BSP_USING_UART3
|
||||
UART3_INDEX,
|
||||
#endif
|
||||
#ifdef BSP_USING_UART4
|
||||
UART4_INDEX,
|
||||
#endif
|
||||
UART_MAX_INDEX
|
||||
};
|
||||
|
||||
**device_open**
|
||||
^^^^^^^^^^^^^^^^
|
||||
|
||||
``device_open`` 用于设备的打开，``oflag`` 表示以何种方式打开。
|
||||
|
||||
.. code-block:: C
|
||||
|
||||
int device_open(struct device *dev, uint16_t oflag);
|
||||
|
||||
- dev 设备句柄
|
||||
- oflag 设备的打开方式
|
||||
- return 错误码，0 表示打开成功，其他表示错误
|
||||
|
||||
``oflag`` 可以写入以下参数：
|
||||
|
||||
.. code-block:: C
|
||||
|
||||
#define DEVICE_OFLAG_STREAM_TX 0x001 /* 设备以轮训发送模式打开 */
|
||||
#define DEVICE_OFLAG_STREAM_RX 0x002 /* 设备以轮训接收模式打开 */
|
||||
#define DEVICE_OFLAG_INT_TX 0x004 /* 设备以中断发送模式打开 */
|
||||
#define DEVICE_OFLAG_INT_RX 0x008 /* 设备以中断接收模式打开 */
|
||||
#define DEVICE_OFLAG_DMA_TX 0x010 /* 设备以 DMA 发送模式打开 */
|
||||
#define DEVICE_OFLAG_DMA_RX 0x020 /* 设备以 DMA 接收模式打开 */
|
||||
|
||||
**device_close**
|
||||
^^^^^^^^^^^^^^^^
|
||||
|
||||
``device_close`` 用于设备的关闭。
|
||||
|
||||
.. code-block:: C
|
||||
|
||||
int device_close(struct device *dev);
|
||||
|
||||
- dev 设备句柄
|
||||
- return 错误码，0 表示关闭成功，其他表示错误
|
||||
|
||||
**device_control**
|
||||
^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
``device_control`` 用于根据命令对设备进行控制和参数的修改。
|
||||
|
||||
.. code-block:: C
|
||||
|
||||
int device_control(struct device *dev, int cmd, void *args);
|
||||
|
||||
- dev 设备句柄
|
||||
- cmd 设备控制命令
|
||||
- args 控制参数
|
||||
- return 不同的控制命令返回的意义不同。
|
||||
|
||||
串口设备除了标准的控制命令，还具有自己特殊的控制命令。
|
||||
|
||||
.. code-block:: C
|
||||
|
||||
#define DEVICE_CTRL_UART_GET_TX_FIFO 0x10
|
||||
#define DEVICE_CTRL_UART_GET_RX_FIFO 0x11
|
||||
|
||||
``args`` 根据不同的 ``cmd`` 传入不同，具体如下：
|
||||
|
||||
+---------------------------------------+--------------------------------------+
|
||||
| cmd | args |
|
||||
+=======================================+======================================+
|
||||
| DEVICE_CTRL_SET_INT | uart_it_type |
|
||||
+---------------------------------------+--------------------------------------+
|
||||
| DEVICE_CTRL_CLR_INT | uart_it_type |
|
||||
+---------------------------------------+--------------------------------------+
|
||||
| DEVICE_CTRL_CONFIG | uart_param_cfg_t |
|
||||
+---------------------------------------+--------------------------------------+
|
||||
| DEVICE_CTRL_ATTACH_TX_DMA | dma句柄 |
|
||||
+---------------------------------------+--------------------------------------+
|
||||
| DEVICE_CTRL_ATTACH_RX_DMA | dma句柄 |
|
||||
+---------------------------------------+--------------------------------------+
|
||||
| DEVICE_CTRL_UART_GET_TX_FIFO | 缓存变量 |
|
||||
+---------------------------------------+--------------------------------------+
|
||||
| DEVICE_CTRL_UART_GET_RX_FIFO | 缓存变量 |
|
||||
+---------------------------------------+--------------------------------------+
|
||||
|
||||
**device_write**
|
||||
^^^^^^^^^^^^^^^^
|
||||
|
||||
``device_write`` 用于串口数据的发送，发送方式根据打开方式可以是轮询、中断、dma。
|
||||
|
||||
.. code-block:: C
|
||||
|
||||
int device_write(struct device *dev, uint32_t pos, const void *buffer, uint32_t size);
|
||||
|
||||
- dev 设备句柄
|
||||
- pos 无作用
|
||||
- buffer 要写入的 buffer 缓冲区
|
||||
- size 要写入的长度
|
||||
- return 错误码，0 表示写入成功，其他表示错误
|
||||
|
||||
**device_read**
|
||||
^^^^^^^^^^^^^^^^
|
||||
|
||||
``device_read`` 用于串口数据的接收，接收方式根据打开方式可以是轮询、中断、dma。
|
||||
|
||||
.. code-block:: C
|
||||
|
||||
int device_read(struct device *dev, uint32_t pos, void *buffer, uint32_t size);
|
||||
|
||||
- dev 设备句柄
|
||||
- pos 无作用
|
||||
- buffer 要读入的 buffer 缓冲区
|
||||
- size 要读入的长度
|
||||
- return 错误码，0 表示读入成功，其他表示错误
|
||||
|
||||
**device_set_callback**
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
``device_set_callback`` 用于注册一个串口中断回调函数。
|
||||
|
||||
.. code-block:: C
|
||||
|
||||
int device_set_callback(struct device *dev, void (*callback)(struct device *dev, void *args, uint32_t size, uint32_t event));
|
||||
|
||||
- dev 设备句柄
|
||||
- callback 要注册的中断回调函数
|
||||
|
||||
- dev 设备句柄
|
||||
- args 接收发送缓冲区，数据类型为 uint8_t*
|
||||
- size 传输长度
|
||||
- event 中断事件类型
|
||||
|
||||
串口设备 ``event`` 有以下类型
|
||||
|
||||
.. code-block:: C
|
||||
|
||||
enum uart_event_type
|
||||
{
|
||||
UART_EVENT_TX_END,
|
||||
UART_EVENT_TX_FIFO,
|
||||
UART_EVENT_RX_END,
|
||||
UART_EVENT_RX_FIFO,
|
||||
UART_EVENT_RTO,
|
||||
UART_EVENT_UNKNOWN
|
||||
};
|
||||
|
||||
PWM设备
|
||||
=========================
|
||||
|
||||
简介
|
||||
------------------------
|
||||
|
||||
脉冲宽度调制（Pulse width modulation，简称 PWM）是一种用数字方式实现模拟电压控制的技术。它是通过对一系列脉冲的宽度进行调制，等效出所需要的波形（包含形状以及幅值），对模拟信号电平进行数字编码，也就是说通过调节占空比的变化来调节信号、能量等的变化，占空比就是指在一个周期内，信号处于高电平的时间占据整个信号周期的百分比，例如方波的占空比就是50%。博流PWM设备具有以下功能：
|
||||
|
||||
- 支持5通道PWM信号生成
|
||||
- 三种时钟源可选择（总线时钟 <bclk>、晶振时钟 <xtal_ck>、慢速时钟 <32k>），搭配 16-bit 时钟分频器
|
||||
- 双门限值域设定，增加脉冲弹性
|
||||
|
||||
PWM设备接口
|
||||
------------------------
|
||||
|
||||
PWM 设备接口全部遵循标准设备驱动管理层提供的接口。并且为了方便用户调用，将某些标准接口使用宏来重定义。
|
||||
|
||||
**pwm_register**
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
``pwm_register`` 用来注册一个PWM 设备，在注册之前需要打开对应 PWM 通道设备的宏定义,例如 ``BSP_USING_PWM_CH0`` 方可使用 UART0 设备。注册完成以后才可以使用其他接口，如果没有定义宏，则无法使用 UART 设备。
|
||||
|
||||
.. code-block:: C
|
||||
|
||||
int pwm_register(enum pwm_index_type index, const char *name, uint16_t flag);
|
||||
|
||||
- index 要注册的设备索引
|
||||
- name 为注册的设备命名
|
||||
- flag 默认可读可写属性
|
||||
|
||||
``index`` 用来选择 PWM 设备配置，一个 index 对应一个 PWM 设备的一个通道配置，比如 ``PWM_CH0_INDEX`` 对应 PWM 通道0 配置，``index`` 有如下可选类型
|
||||
|
||||
.. code-block:: C
|
||||
|
||||
enum pwm_index_type
|
||||
{
|
||||
#ifdef BSP_USING_PWM_CH0
|
||||
PWM_CH0_INDEX,
|
||||
#endif
|
||||
#ifdef BSP_USING_PWM_CH1
|
||||
PWM_CH1_INDEX,
|
||||
#endif
|
||||
#ifdef BSP_USING_PWM_CH2
|
||||
PWM_CH2_INDEX,
|
||||
#endif
|
||||
#ifdef BSP_USING_PWM_CH3
|
||||
PWM_CH3_INDEX,
|
||||
#endif
|
||||
#ifdef BSP_USING_PWM_CH4
|
||||
PWM_CH4_INDEX,
|
||||
#endif
|
||||
PWM_MAX_INDEX
|
||||
};
|
||||
|
||||
**device_open**
|
||||
^^^^^^^^^^^^^^^^
|
||||
|
||||
``device_open`` 用于设备的打开，``oflag`` 表示以何种方式打开。
|
||||
|
||||
.. code-block:: C
|
||||
|
||||
int device_open(struct device *dev, uint16_t oflag);
|
||||
|
||||
- dev 设备句柄
|
||||
- oflag 设备的打开方式
|
||||
- return 错误码，0 表示打开成功，其他表示错误
|
||||
|
||||
``oflag`` 可以写入以下参数：
|
||||
|
||||
.. code-block:: C
|
||||
|
||||
#define DEVICE_OFLAG_STREAM_TX 0x001 /* 设备以轮训发送模式打开 */
|
||||
#define DEVICE_OFLAG_STREAM_RX 0x002 /* 设备以轮训接收模式打开 */
|
||||
#define DEVICE_OFLAG_INT_TX 0x004 /* 设备以中断发送模式打开 */
|
||||
#define DEVICE_OFLAG_INT_RX 0x008 /* 设备以中断接收模式打开 */
|
||||
#define DEVICE_OFLAG_DMA_TX 0x010 /* 设备以 DMA 发送模式打开 */
|
||||
#define DEVICE_OFLAG_DMA_RX 0x020 /* 设备以 DMA 接收模式打开 */
|
||||
|
||||
**device_close**
|
||||
^^^^^^^^^^^^^^^^
|
||||
|
||||
``device_close`` 用于设备的关闭。
|
||||
|
||||
.. code-block:: C
|
||||
|
||||
int device_close(struct device *dev);
|
||||
|
||||
- dev 设备句柄
|
||||
- return 错误码，0 表示关闭成功，其他表示错误
|
||||
|
||||
**device_control**
|
||||
^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
``device_control`` 用于根据命令对设备进行控制和参数的修改。
|
||||
|
||||
.. code-block:: C
|
||||
|
||||
int device_control(struct device *dev, int cmd, void *args);
|
||||
|
||||
- dev 设备句柄
|
||||
- cmd 设备控制命令
|
||||
- args 控制参数
|
||||
- return 不同的控制命令返回的意义不同。
|
||||
|
||||
串口设备除了标准的控制命令，还具有自己特殊的控制命令。
|
||||
|
||||
.. code-block:: C
|
||||
|
||||
#define DEIVCE_CTRL_PWM_IT_PULSE_COUNT_CONFIG 0x10
|
||||
|
||||
``args`` 根据不同的 ``cmd`` 传入不同，具体如下：
|
||||
|
||||
+------------------------------------------+-----------------+
|
||||
|cmd |args |
|
||||
+==========================================+=================+
|
||||
|DEVICE_CTRL_SET_INT |NULL |
|
||||
+------------------------------------------+-----------------+
|
||||
|DEVICE_CTRL_CLR_INT |NULL |
|
||||
+------------------------------------------+-----------------+
|
||||
|DEVICE_CTRL_CONFIG |pwm_config_t |
|
||||
+------------------------------------------+-----------------+
|
||||
|DEVICE_CTRL_ATTACH_TX_DMA |dma句柄 |
|
||||
+------------------------------------------+-----------------+
|
||||
|DEIVCE_CTRL_PWM_IT_PULSE_COUNT_CONFIG |周期计数值 |
|
||||
+------------------------------------------+-----------------+
|
||||
|
|
@ -1,41 +0,0 @@
|
|||
流水灯示例
|
||||
====================
|
||||
|
||||
硬件连接
|
||||
-----------------------------
|
||||
|
||||
.. figure:: img/blink_breath_sch.png
|
||||
:alt:
|
||||
|
||||
**BL706_IOT板支持上述电路**
|
||||
|
||||
- 硬件连接如上图所示 ``GPIO29`` ``GPIO30`` ``GPIO31`` ``GPIO22`` 分别控制四路 LED 灯
|
||||
|
||||
|
||||
|
||||
软件实现
|
||||
-----------------------------
|
||||
|
||||
- 软件代码见 ``examples/gpio/gpio_blink``
|
||||
|
||||
.. code-block:: C
|
||||
:linenos:
|
||||
|
||||
gpio_set_mode(GPIO_PIN_22, GPIO_OUTPUT_PP_MODE);
|
||||
gpio_set_mode(GPIO_PIN_29, GPIO_OUTPUT_PP_MODE);
|
||||
gpio_set_mode(GPIO_PIN_30, GPIO_OUTPUT_PP_MODE);
|
||||
gpio_set_mode(GPIO_PIN_31, GPIO_OUTPUT_PP_MODE);
|
||||
|
||||
- 使用上述代码将 ``GPIO22`` ``GPIO29`` ``GPIO30`` ``GPIO31`` 配置为输出模式。
|
||||
|
||||
.. code-block:: C
|
||||
:linenos:
|
||||
|
||||
gpio_write(GPIO_PIN_22, 0);
|
||||
|
||||
- 使用上述代码修改输出的电平值。
|
||||
|
||||
|
||||
最终效果
|
||||
-----------------------------
|
||||
见视频展示
|
||||
|
|
@ -1,64 +0,0 @@
|
|||
呼吸灯示例
|
||||
====================
|
||||
|
||||
硬件连接
|
||||
-----------------------------
|
||||
|
||||
.. figure:: img/blink_breath_sch.png
|
||||
:alt:
|
||||
|
||||
**BL706_IOT板支持上述电路**
|
||||
|
||||
- 硬件连接如上图所示 ``GPIO29`` ``GPIO30`` ``GPIO31`` ``GPIO22`` 分别控制四路 LED 灯
|
||||
- 呼吸灯会单独使用 ``GPIO22`` 来演示效果
|
||||
|
||||
|
||||
|
||||
软件实现
|
||||
-----------------------------
|
||||
|
||||
- 软件代码见 ``examples/pwm/pwm_breath_led``
|
||||
|
||||
|
||||
- ``PWM`` 的输出引脚由板级描述文件 ``bsp/board/bl706_iot/pinmux_config.h`` 来配置
|
||||
|
||||
.. code-block:: C
|
||||
:linenos:
|
||||
|
||||
#define CONFIG_GPIO22_FUNC GPIO_FUN_UNUSED
|
||||
|
||||
|
||||
- 可以看到，我们将 ``GPIO22`` 的功能选择为 ``PWM`` 输出，不同的电路板会存在不同的引脚配置。
|
||||
|
||||
- 我们会使用向导来配置不同应用场景下的引脚配置，用户也可以手动修改。
|
||||
|
||||
.. code-block:: C
|
||||
:linenos:
|
||||
|
||||
pwm_register(PWM0_INDEX, "led_breath", DEVICE_OFLAG_RDWR);
|
||||
|
||||
struct device *led_breath = device_find("led_breath");
|
||||
|
||||
if (led_breath)
|
||||
{
|
||||
device_open(led_breath, 0);
|
||||
}
|
||||
|
||||
|
||||
- 上述代码展现了 ``bl_mcu_sdk`` 框架最一般的设备初始化流程，首先调用 ``pwm_register`` 函数注册 ``pwm`` 设备
|
||||
- 然后通过 ``find`` 函数找到设备对应的句柄，保存于 ``led_breath`` 对象中
|
||||
- 使用 ``device_open`` 来打开 ``led_breath`` 设备。
|
||||
|
||||
.. code-block:: C
|
||||
:linenos:
|
||||
|
||||
device_control(led_breath, DEVICE_CTRL_CONFIG, &pwm_cfg);
|
||||
|
||||
使用 ``device_contorl`` 函数，配合 ``DEVICE_CTRL_CONFIG`` 指令，输入需要配置的频率和占空比，即可配置 ``PWM`` 的输出波形。
|
||||
|
||||
|
||||
|
||||
最终效果
|
||||
-----------------------------
|
||||
见视频展示
|
||||
|
||||
|
|
@ -1,97 +0,0 @@
|
|||
.. _connect_hardware:
|
||||
|
||||
硬件连接
|
||||
================
|
||||
|
||||
本文档介绍了如何连接 BL70x 系列 MCU 的开发板
|
||||
|
||||
BL706_IOT 开发板
|
||||
-------------------------
|
||||
|
||||
使用 CK-Link 烧写、调试连接方法
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
- 将 CK-Link USB 接口使用合适的 USB 数据线正确连接到 PC 主机
|
||||
- 将 Iot 开发板的 ``HD3`` 组的标准 ``JTAG`` 引脚使用杜邦线与 ``CK-Link`` 对应的 ``JTAG`` 引脚连接起来
|
||||
- 若没有使用 CK-Link 给开发板供电，需要给开发板单独供电
|
||||
|
||||
::
|
||||
|
||||
bl706-iot board CK-Link
|
||||
-------------------------------
|
||||
JTAG_TDI <--> TDI
|
||||
JTAG_TDO <--> TDO
|
||||
JTAG_TCK <--> TCK
|
||||
JTAG_TMS <--> TMS
|
||||
VDD33 <--> VREF
|
||||
GND <--> GND
|
||||
|
||||
|
||||
.. figure:: img/ck_link_connect_bl706_iot.png
|
||||
:alt:
|
||||
|
||||
ck_link connect bl706-iot board
|
||||
|
||||
|
||||
使用 J-Link 烧写、调试连接方法
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
- 将 j-link 的 USB 接口使用合适的 USB 数据线正确连接到 PC 主机
|
||||
- 将 Iot 开发板的 ``HD3`` 组的标准 ``JTAG`` 引脚使用杜邦线与 ``j-link`` 对应的 ``JTAG`` 引脚连接起来
|
||||
- j-link 连接的情况下需要给开发板独立供电，并且将开发板的电源接到 j-link 的 ``VTref`` 引脚
|
||||
|
||||
::
|
||||
|
||||
bl706-iot board j-link
|
||||
-------------------------------
|
||||
JTAG_TDI <--> TDI
|
||||
JTAG_TDO <--> TDO
|
||||
JTAG_TCK <--> TCK
|
||||
JTAG_TMS <--> TMS
|
||||
VDD33 <--> VTref
|
||||
GND <--> GND
|
||||
|
||||
|
||||
.. figure:: img/jlink_connect_bl706_iot.png
|
||||
:alt:
|
||||
|
||||
jlink connect bl706-iot board
|
||||
|
||||
|
||||
使用串口烧写程序连接方法
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
- 使用串口烧写前，请确保正确安装了 ``Bouffalo Lab Dev Cube`` 或命令行烧写工具
|
||||
|
||||
- 使用 ``Type-C USB`` 数据线 or ``Mini USB`` 数据线连接到开发板上对应的 ``Type-C`` 接口 or ``Mini`` 接口上。
|
||||
- 按下开发板上的 ``Boot`` 键，不要释放
|
||||
- 按下开发板上的 ``RST`` 键，此时已经进入 ``Boot ROM``，可以释放两个按键
|
||||
- 这时就可以从 ``Bouffalo Lab Dev Cube`` 中看到相应的串口 ``COM`` 号，如没有出现，请点击 ``Refresh`` 按钮刷新一下
|
||||
|
||||
|
||||
- 如没有合适的数据线，也可以使用一些常见的 ``USB-TTL`` 模块，连接到开发板的 ``UART0`` 端口进行烧写。 ``UART0`` 在 ``HD1`` 组上，连接方法如下：
|
||||
|
||||
::
|
||||
|
||||
USB-TTL BL702_IoT
|
||||
----------------------
|
||||
3V3 <--> VDD
|
||||
TXD <--> RX0
|
||||
RXD <--> TX0
|
||||
GND <--> GND
|
||||
|
||||
- 烧写方法同上
|
||||
|
||||
BL702_AVB 开发板
|
||||
--------------------------
|
||||
|
||||
使用 CK-Link 烧写、调试连接方法
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
- ``TO DO``
|
||||
|
||||
使用串口烧写程序连接方法
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
- ``TO DO``
|
||||
|
||||
|
|
@ -1,37 +0,0 @@
|
|||
开发前的准备
|
||||
=============================
|
||||
|
||||
硬件环境准备
|
||||
-----------------------------
|
||||
|
||||
- 一块 BL702 系列 MCU 的开发板：
|
||||
|
||||
- BL706_IOT 开发板， or
|
||||
- BL706_AVB 开发板
|
||||
|
||||
BL706_Iot 开发板如下图所示
|
||||
|
||||
.. figure:: img/bl702_iot.png
|
||||
:alt:
|
||||
|
||||
BL706_IoT
|
||||
|
||||
|
||||
- 一个支持标准 JTAG 功能的调试器：
|
||||
|
||||
- CK-Link 仿真器，or
|
||||
- Jlink V11 仿真器，or
|
||||
- Sipeed USB-JTAG/TTL 调试器，or
|
||||
- Bouffalo Lab Debugger 调试器
|
||||
|
||||
- 一台 PC 主机（运行 Windows 或者 Linux 系统）
|
||||
|
||||
软件环境准备
|
||||
--------------------------------
|
||||
|
||||
为了更好的进行 BL702 系列 MCU 的开发，建议您应当具备以下开发环境：
|
||||
|
||||
- Windows 使用 `CDK <Windows_quick_start_cdk.html>`_ 环境开发 (建议 Windows 7 以上版本。) ，or
|
||||
- `Windows <Windows_quick_start_eclipse.html>`_ 使用 Eclipse 环境开发 (建议 Windows 7 以上版本。) ，or
|
||||
- `Linux <Linux_quick_start_ubuntu.html>`_ (建议使用 Ubuntu 18 以上的 LTS 版本)
|
||||
|
||||
|
|
@ -1,45 +0,0 @@
|
|||
.. bl_mcu_sdk_development_guide documentation master file, created by
|
||||
sphinx-quickstart on Fri Mar 12 16:32:56 2021.
|
||||
You can adapt this file completely to your liking, but it should at least
|
||||
contain the root `toctree` directive.
|
||||
|
||||
========================================================
|
||||
BL MCU SDK 开发指南
|
||||
========================================================
|
||||
|
||||
博流 `BL702 <https://www.bouffalolab.com/bl70X>`_ 系列产品是基于 “SiFive E24 Core” `RISC-V <https://en.wikipedia.org/wiki/RISC-V>`_ 处理器的通用微控制器，具有 BLE 5.0、zigbee 和以太网等网络功能，同时还具备其它丰富的外设。
|
||||
可被广泛应用于 `IoT <https://en.wikipedia.org/wiki/Internet_of_things>`_ 和其他低功耗领域中。
|
||||
支持通过 `JTAG <https://en.wikipedia.org/wiki/JTAG>`_ 对芯片进行烧写和调试，也支持通过 `UART <https://en.wikipedia.org/wiki/Universal_asynchronous_receiver-transmitter>`_ 进行程序烧录。
|
||||
|
||||
BL MCU SDK 将为您提供博流 BL70X 系列 MCU 开发的全方位支持。
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 1
|
||||
:caption: 快速开发指南
|
||||
:numbered:
|
||||
|
||||
get_started
|
||||
Windows_quick_start_cdk
|
||||
Windows_quick_start_eclipse
|
||||
Linux_quick_start_ubuntu
|
||||
connecting_hardware
|
||||
|
||||
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 1
|
||||
:caption: API 手册
|
||||
:numbered:
|
||||
|
||||
api_guide
|
||||
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 1
|
||||
:caption: 示例代码
|
||||
:numbered:
|
||||
|
||||
blink_demo_introduce
|
||||
breath_pwm_demo_introduce
|
||||
uart_loopback_demo_introduce
|
||||
|
||||
|
|
@ -1,91 +0,0 @@
|
|||
串口自收发示例
|
||||
====================
|
||||
|
||||
硬件连接
|
||||
-----------------------------
|
||||
|
||||
.. figure:: img/uart_loop_sch.png
|
||||
:alt:
|
||||
|
||||
**BL706_IOT板支持上述电路**
|
||||
|
||||
- 硬件连接如上图所示 板子将芯片对应的 RX 与 TX 脚引到了排针 ``HD1``。
|
||||
- 将对应的 TX 接上串口转换芯片的 RX，RX 接上串口转换芯片的 TX，将串口转换芯片连接电脑。
|
||||
|
||||
|
||||
|
||||
软件实现
|
||||
-----------------------------
|
||||
|
||||
- 软件代码见 ``examples/uart/uart_echo``
|
||||
|
||||
- ``pwm`` 的输出引脚由板级描述文件 ``bsp/board/bl706_iot/pinmux_config.h`` 来配置
|
||||
|
||||
.. code-block:: C
|
||||
:linenos:
|
||||
|
||||
#define CONFIG_GPIO14_FUNC GPIO_FUN_UART0_TX
|
||||
#define CONFIG_GPIO15_FUNC GPIO_FUN_UART0_RX
|
||||
|
||||
- 可以看到，我们将 ``GPIO_PIN_14`` 与 ``GPIO_PIN_15`` 的功能选择了 ``UART`` 功能。
|
||||
|
||||
- 不同的电路板会存在不同的引脚配置，我们会使用向导来配置不同应用场景下的引脚配置，用户也可以手动修改。
|
||||
|
||||
|
||||
.. code-block:: C
|
||||
:linenos:
|
||||
|
||||
bflb_platform_init();
|
||||
|
||||
- 在 ``bflb_platform_init`` 函数中，我们已经注册并且打开了一个调试用的串口设备，给用户实现一个 ``printf`` 的基本功能用作打印输出报文。
|
||||
|
||||
.. code-block:: C
|
||||
:linenos:
|
||||
|
||||
struct device *uart = device_find("debug_log");
|
||||
|
||||
- 我们通过 ``find`` 函数，找到在 ``bflb_platform_init`` 函数中注册并且打开的串口设备句柄，储存于 ``uart`` 变量中。
|
||||
|
||||
.. code-block:: C
|
||||
:linenos:
|
||||
|
||||
if (uart)
|
||||
{
|
||||
device_set_callback(uart, uart_irq_callback);
|
||||
device_control(uart, DEVICE_CTRL_SET_INT, (void *)(UART_RX_FIFO_IT|UART_RTO_IT));
|
||||
}
|
||||
|
||||
- 通过 ``set_callback`` 函数，注册用户指定的中断服务函数。通过 ``device_control`` 函数打开中断使能开关
|
||||
|
||||
.. code-block:: C
|
||||
:linenos:
|
||||
|
||||
void uart_irq_callback(struct device *dev, void *args, uint32_t size, uint32_t state)
|
||||
{
|
||||
if (state == UART_EVENT_RX_FIFO)
|
||||
{
|
||||
device_write(dev,0,(uint8_t *)args,size);
|
||||
}
|
||||
else if (state == UART_EVENT_RTO)
|
||||
{
|
||||
device_write(dev,0,(uint8_t *)args,size);
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
- 此函数是示例的中断服务函数，作用是将接受到的数据原封不动的发送出去。
|
||||
|
||||
- ``state`` 会返回 ``UART`` 设备的中断类型
|
||||
- ``args`` 包含了返回数据指针
|
||||
- ``size`` 包含返回数据的长度
|
||||
- ``dev`` 为中断的 ``uart`` 设备句柄
|
||||
|
||||
- 当中断产生，将会调用 ``device_write`` 函数将接受到的数据发送回去。
|
||||
|
||||
|
||||
|
||||
最终效果
|
||||
-----------------------------
|
||||
见视频讲解
|
||||
|
||||
|
||||
|
|
@ -1,856 +0,0 @@
|
|||
/*
|
||||
* basic.css
|
||||
* ~~~~~~~~~
|
||||
*
|
||||
* Sphinx stylesheet -- basic theme.
|
||||
*
|
||||
* :copyright: Copyright 2007-2021 by the Sphinx team, see AUTHORS.
|
||||
* :license: BSD, see LICENSE for details.
|
||||
*
|
||||
*/
|
||||
|
||||
/* -- main layout ----------------------------------------------------------- */
|
||||
|
||||
div.clearer {
|
||||
clear: both;
|
||||
}
|
||||
|
||||
div.section::after {
|
||||
display: block;
|
||||
content: '';
|
||||
clear: left;
|
||||
}
|
||||
|
||||
/* -- relbar ---------------------------------------------------------------- */
|
||||
|
||||
div.related {
|
||||
width: 100%;
|
||||
font-size: 90%;
|
||||
}
|
||||
|
||||
div.related h3 {
|
||||
display: none;
|
||||
}
|
||||
|
||||
div.related ul {
|
||||
margin: 0;
|
||||
padding: 0 0 0 10px;
|
||||
list-style: none;
|
||||
}
|
||||
|
||||
div.related li {
|
||||
display: inline;
|
||||
}
|
||||
|
||||
div.related li.right {
|
||||
float: right;
|
||||
margin-right: 5px;
|
||||
}
|
||||
|
||||
/* -- sidebar --------------------------------------------------------------- */
|
||||
|
||||
div.sphinxsidebarwrapper {
|
||||
padding: 10px 5px 0 10px;
|
||||
}
|
||||
|
||||
div.sphinxsidebar {
|
||||
float: left;
|
||||
width: 230px;
|
||||
margin-left: -100%;
|
||||
font-size: 90%;
|
||||
word-wrap: break-word;
|
||||
overflow-wrap : break-word;
|
||||
}
|
||||
|
||||
div.sphinxsidebar ul {
|
||||
list-style: none;
|
||||
}
|
||||
|
||||
div.sphinxsidebar ul ul,
|
||||
div.sphinxsidebar ul.want-points {
|
||||
margin-left: 20px;
|
||||
list-style: square;
|
||||
}
|
||||
|
||||
div.sphinxsidebar ul ul {
|
||||
margin-top: 0;
|
||||
margin-bottom: 0;
|
||||
}
|
||||
|
||||
div.sphinxsidebar form {
|
||||
margin-top: 10px;
|
||||
}
|
||||
|
||||
div.sphinxsidebar input {
|
||||
border: 1px solid #98dbcc;
|
||||
font-family: sans-serif;
|
||||
font-size: 1em;
|
||||
}
|
||||
|
||||
div.sphinxsidebar #searchbox form.search {
|
||||
overflow: hidden;
|
||||
}
|
||||
|
||||
div.sphinxsidebar #searchbox input[type="text"] {
|
||||
float: left;
|
||||
width: 80%;
|
||||
padding: 0.25em;
|
||||
box-sizing: border-box;
|
||||
}
|
||||
|
||||
div.sphinxsidebar #searchbox input[type="submit"] {
|
||||
float: left;
|
||||
width: 20%;
|
||||
border-left: none;
|
||||
padding: 0.25em;
|
||||
box-sizing: border-box;
|
||||
}
|
||||
|
||||
|
||||
img {
|
||||
border: 0;
|
||||
max-width: 100%;
|
||||
}
|
||||
|
||||
/* -- search page ----------------------------------------------------------- */
|
||||
|
||||
ul.search {
|
||||
margin: 10px 0 0 20px;
|
||||
padding: 0;
|
||||
}
|
||||
|
||||
ul.search li {
|
||||
padding: 5px 0 5px 20px;
|
||||
background-image: url(file.png);
|
||||
background-repeat: no-repeat;
|
||||
background-position: 0 7px;
|
||||
}
|
||||
|
||||
ul.search li a {
|
||||
font-weight: bold;
|
||||
}
|
||||
|
||||
ul.search li div.context {
|
||||
color: #888;
|
||||
margin: 2px 0 0 30px;
|
||||
text-align: left;
|
||||
}
|
||||
|
||||
ul.keywordmatches li.goodmatch a {
|
||||
font-weight: bold;
|
||||
}
|
||||
|
||||
/* -- index page ------------------------------------------------------------ */
|
||||
|
||||
table.contentstable {
|
||||
width: 90%;
|
||||
margin-left: auto;
|
||||
margin-right: auto;
|
||||
}
|
||||
|
||||
table.contentstable p.biglink {
|
||||
line-height: 150%;
|
||||
}
|
||||
|
||||
a.biglink {
|
||||
font-size: 1.3em;
|
||||
}
|
||||
|
||||
span.linkdescr {
|
||||
font-style: italic;
|
||||
padding-top: 5px;
|
||||
font-size: 90%;
|
||||
}
|
||||
|
||||
/* -- general index --------------------------------------------------------- */
|
||||
|
||||
table.indextable {
|
||||
width: 100%;
|
||||
}
|
||||
|
||||
table.indextable td {
|
||||
text-align: left;
|
||||
vertical-align: top;
|
||||
}
|
||||
|
||||
table.indextable ul {
|
||||
margin-top: 0;
|
||||
margin-bottom: 0;
|
||||
list-style-type: none;
|
||||
}
|
||||
|
||||
table.indextable > tbody > tr > td > ul {
|
||||
padding-left: 0em;
|
||||
}
|
||||
|
||||
table.indextable tr.pcap {
|
||||
height: 10px;
|
||||
}
|
||||
|
||||
table.indextable tr.cap {
|
||||
margin-top: 10px;
|
||||
background-color: #f2f2f2;
|
||||
}
|
||||
|
||||
img.toggler {
|
||||
margin-right: 3px;
|
||||
margin-top: 3px;
|
||||
cursor: pointer;
|
||||
}
|
||||
|
||||
div.modindex-jumpbox {
|
||||
border-top: 1px solid #ddd;
|
||||
border-bottom: 1px solid #ddd;
|
||||
margin: 1em 0 1em 0;
|
||||
padding: 0.4em;
|
||||
}
|
||||
|
||||
div.genindex-jumpbox {
|
||||
border-top: 1px solid #ddd;
|
||||
border-bottom: 1px solid #ddd;
|
||||
margin: 1em 0 1em 0;
|
||||
padding: 0.4em;
|
||||
}
|
||||
|
||||
/* -- domain module index --------------------------------------------------- */
|
||||
|
||||
table.modindextable td {
|
||||
padding: 2px;
|
||||
border-collapse: collapse;
|
||||
}
|
||||
|
||||
/* -- general body styles --------------------------------------------------- */
|
||||
|
||||
div.body {
|
||||
min-width: 450px;
|
||||
max-width: 800px;
|
||||
}
|
||||
|
||||
div.body p, div.body dd, div.body li, div.body blockquote {
|
||||
-moz-hyphens: auto;
|
||||
-ms-hyphens: auto;
|
||||
-webkit-hyphens: auto;
|
||||
hyphens: auto;
|
||||
}
|
||||
|
||||
a.headerlink {
|
||||
visibility: hidden;
|
||||
}
|
||||
|
||||
a.brackets:before,
|
||||
span.brackets > a:before{
|
||||
content: "[";
|
||||
}
|
||||
|
||||
a.brackets:after,
|
||||
span.brackets > a:after {
|
||||
content: "]";
|
||||
}
|
||||
|
||||
h1:hover > a.headerlink,
|
||||
h2:hover > a.headerlink,
|
||||
h3:hover > a.headerlink,
|
||||
h4:hover > a.headerlink,
|
||||
h5:hover > a.headerlink,
|
||||
h6:hover > a.headerlink,
|
||||
dt:hover > a.headerlink,
|
||||
caption:hover > a.headerlink,
|
||||
p.caption:hover > a.headerlink,
|
||||
div.code-block-caption:hover > a.headerlink {
|
||||
visibility: visible;
|
||||
}
|
||||
|
||||
div.body p.caption {
|
||||
text-align: inherit;
|
||||
}
|
||||
|
||||
div.body td {
|
||||
text-align: left;
|
||||
}
|
||||
|
||||
.first {
|
||||
margin-top: 0 !important;
|
||||
}
|
||||
|
||||
p.rubric {
|
||||
margin-top: 30px;
|
||||
font-weight: bold;
|
||||
}
|
||||
|
||||
img.align-left, .figure.align-left, object.align-left {
|
||||
clear: left;
|
||||
float: left;
|
||||
margin-right: 1em;
|
||||
}
|
||||
|
||||
img.align-right, .figure.align-right, object.align-right {
|
||||
clear: right;
|
||||
float: right;
|
||||
margin-left: 1em;
|
||||
}
|
||||
|
||||
img.align-center, .figure.align-center, object.align-center {
|
||||
display: block;
|
||||
margin-left: auto;
|
||||
margin-right: auto;
|
||||
}
|
||||
|
||||
img.align-default, .figure.align-default {
|
||||
display: block;
|
||||
margin-left: auto;
|
||||
margin-right: auto;
|
||||
}
|
||||
|
||||
.align-left {
|
||||
text-align: left;
|
||||
}
|
||||
|
||||
.align-center {
|
||||
text-align: center;
|
||||
}
|
||||
|
||||
.align-default {
|
||||
text-align: center;
|
||||
}
|
||||
|
||||
.align-right {
|
||||
text-align: right;
|
||||
}
|
||||
|
||||
/* -- sidebars -------------------------------------------------------------- */
|
||||
|
||||
div.sidebar {
|
||||
margin: 0 0 0.5em 1em;
|
||||
border: 1px solid #ddb;
|
||||
padding: 7px;
|
||||
background-color: #ffe;
|
||||
width: 40%;
|
||||
float: right;
|
||||
clear: right;
|
||||
overflow-x: auto;
|
||||
}
|
||||
|
||||
p.sidebar-title {
|
||||
font-weight: bold;
|
||||
}
|
||||
|
||||
div.admonition, div.topic, blockquote {
|
||||
clear: left;
|
||||
}
|
||||
|
||||
/* -- topics ---------------------------------------------------------------- */
|
||||
|
||||
div.topic {
|
||||
border: 1px solid #ccc;
|
||||
padding: 7px;
|
||||
margin: 10px 0 10px 0;
|
||||
}
|
||||
|
||||
p.topic-title {
|
||||
font-size: 1.1em;
|
||||
font-weight: bold;
|
||||
margin-top: 10px;
|
||||
}
|
||||
|
||||
/* -- admonitions ----------------------------------------------------------- */
|
||||
|
||||
div.admonition {
|
||||
margin-top: 10px;
|
||||
margin-bottom: 10px;
|
||||
padding: 7px;
|
||||
}
|
||||
|
||||
div.admonition dt {
|
||||
font-weight: bold;
|
||||
}
|
||||
|
||||
p.admonition-title {
|
||||
margin: 0px 10px 5px 0px;
|
||||
font-weight: bold;
|
||||
}
|
||||
|
||||
div.body p.centered {
|
||||
text-align: center;
|
||||
margin-top: 25px;
|
||||
}
|
||||
|
||||
/* -- content of sidebars/topics/admonitions -------------------------------- */
|
||||
|
||||
div.sidebar > :last-child,
|
||||
div.topic > :last-child,
|
||||
div.admonition > :last-child {
|
||||
margin-bottom: 0;
|
||||
}
|
||||
|
||||
div.sidebar::after,
|
||||
div.topic::after,
|
||||
div.admonition::after,
|
||||
blockquote::after {
|
||||
display: block;
|
||||
content: '';
|
||||
clear: both;
|
||||
}
|
||||
|
||||
/* -- tables ---------------------------------------------------------------- */
|
||||
|
||||
table.docutils {
|
||||
margin-top: 10px;
|
||||
margin-bottom: 10px;
|
||||
border: 0;
|
||||
border-collapse: collapse;
|
||||
}
|
||||
|
||||
table.align-center {
|
||||
margin-left: auto;
|
||||
margin-right: auto;
|
||||
}
|
||||
|
||||
table.align-default {
|
||||
margin-left: auto;
|
||||
margin-right: auto;
|
||||
}
|
||||
|
||||
table caption span.caption-number {
|
||||
font-style: italic;
|
||||
}
|
||||
|
||||
table caption span.caption-text {
|
||||
}
|
||||
|
||||
table.docutils td, table.docutils th {
|
||||
padding: 1px 8px 1px 5px;
|
||||
border-top: 0;
|
||||
border-left: 0;
|
||||
border-right: 0;
|
||||
border-bottom: 1px solid #aaa;
|
||||
}
|
||||
|
||||
table.footnote td, table.footnote th {
|
||||
border: 0 !important;
|
||||
}
|
||||
|
||||
th {
|
||||
text-align: left;
|
||||
padding-right: 5px;
|
||||
}
|
||||
|
||||
table.citation {
|
||||
border-left: solid 1px gray;
|
||||
margin-left: 1px;
|
||||
}
|
||||
|
||||
table.citation td {
|
||||
border-bottom: none;
|
||||
}
|
||||
|
||||
th > :first-child,
|
||||
td > :first-child {
|
||||
margin-top: 0px;
|
||||
}
|
||||
|
||||
th > :last-child,
|
||||
td > :last-child {
|
||||
margin-bottom: 0px;
|
||||
}
|
||||
|
||||
/* -- figures --------------------------------------------------------------- */
|
||||
|
||||
div.figure {
|
||||
margin: 0.5em;
|
||||
padding: 0.5em;
|
||||
}
|
||||
|
||||
div.figure p.caption {
|
||||
padding: 0.3em;
|
||||
}
|
||||
|
||||
div.figure p.caption span.caption-number {
|
||||
font-style: italic;
|
||||
}
|
||||
|
||||
div.figure p.caption span.caption-text {
|
||||
}
|
||||
|
||||
/* -- field list styles ----------------------------------------------------- */
|
||||
|
||||
table.field-list td, table.field-list th {
|
||||
border: 0 !important;
|
||||
}
|
||||
|
||||
.field-list ul {
|
||||
margin: 0;
|
||||
padding-left: 1em;
|
||||
}
|
||||
|
||||
.field-list p {
|
||||
margin: 0;
|
||||
}
|
||||
|
||||
.field-name {
|
||||
-moz-hyphens: manual;
|
||||
-ms-hyphens: manual;
|
||||
-webkit-hyphens: manual;
|
||||
hyphens: manual;
|
||||
}
|
||||
|
||||
/* -- hlist styles ---------------------------------------------------------- */
|
||||
|
||||
table.hlist {
|
||||
margin: 1em 0;
|
||||
}
|
||||
|
||||
table.hlist td {
|
||||
vertical-align: top;
|
||||
}
|
||||
|
||||
|
||||
/* -- other body styles ----------------------------------------------------- */
|
||||
|
||||
ol.arabic {
|
||||
list-style: decimal;
|
||||
}
|
||||
|
||||
ol.loweralpha {
|
||||
list-style: lower-alpha;
|
||||
}
|
||||
|
||||
ol.upperalpha {
|
||||
list-style: upper-alpha;
|
||||
}
|
||||
|
||||
ol.lowerroman {
|
||||
list-style: lower-roman;
|
||||
}
|
||||
|
||||
ol.upperroman {
|
||||
list-style: upper-roman;
|
||||
}
|
||||
|
||||
:not(li) > ol > li:first-child > :first-child,
|
||||
:not(li) > ul > li:first-child > :first-child {
|
||||
margin-top: 0px;
|
||||
}
|
||||
|
||||
:not(li) > ol > li:last-child > :last-child,
|
||||
:not(li) > ul > li:last-child > :last-child {
|
||||
margin-bottom: 0px;
|
||||
}
|
||||
|
||||
ol.simple ol p,
|
||||
ol.simple ul p,
|
||||
ul.simple ol p,
|
||||
ul.simple ul p {
|
||||
margin-top: 0;
|
||||
}
|
||||
|
||||
ol.simple > li:not(:first-child) > p,
|
||||
ul.simple > li:not(:first-child) > p {
|
||||
margin-top: 0;
|
||||
}
|
||||
|
||||
ol.simple p,
|
||||
ul.simple p {
|
||||
margin-bottom: 0;
|
||||
}
|
||||
|
||||
dl.footnote > dt,
|
||||
dl.citation > dt {
|
||||
float: left;
|
||||
margin-right: 0.5em;
|
||||
}
|
||||
|
||||
dl.footnote > dd,
|
||||
dl.citation > dd {
|
||||
margin-bottom: 0em;
|
||||
}
|
||||
|
||||
dl.footnote > dd:after,
|
||||
dl.citation > dd:after {
|
||||
content: "";
|
||||
clear: both;
|
||||
}
|
||||
|
||||
dl.field-list {
|
||||
display: grid;
|
||||
grid-template-columns: fit-content(30%) auto;
|
||||
}
|
||||
|
||||
dl.field-list > dt {
|
||||
font-weight: bold;
|
||||
word-break: break-word;
|
||||
padding-left: 0.5em;
|
||||
padding-right: 5px;
|
||||
}
|
||||
|
||||
dl.field-list > dt:after {
|
||||
content: ":";
|
||||
}
|
||||
|
||||
dl.field-list > dd {
|
||||
padding-left: 0.5em;
|
||||
margin-top: 0em;
|
||||
margin-left: 0em;
|
||||
margin-bottom: 0em;
|
||||
}
|
||||
|
||||
dl {
|
||||
margin-bottom: 15px;
|
||||
}
|
||||
|
||||
dd > :first-child {
|
||||
margin-top: 0px;
|
||||
}
|
||||
|
||||
dd ul, dd table {
|
||||
margin-bottom: 10px;
|
||||
}
|
||||
|
||||
dd {
|
||||
margin-top: 3px;
|
||||
margin-bottom: 10px;
|
||||
margin-left: 30px;
|
||||
}
|
||||
|
||||
dl > dd:last-child,
|
||||
dl > dd:last-child > :last-child {
|
||||
margin-bottom: 0;
|
||||
}
|
||||
|
||||
dt:target, span.highlighted {
|
||||
background-color: #fbe54e;
|
||||
}
|
||||
|
||||
rect.highlighted {
|
||||
fill: #fbe54e;
|
||||
}
|
||||
|
||||
dl.glossary dt {
|
||||
font-weight: bold;
|
||||
font-size: 1.1em;
|
||||
}
|
||||
|
||||
.optional {
|
||||
font-size: 1.3em;
|
||||
}
|
||||
|
||||
.sig-paren {
|
||||
font-size: larger;
|
||||
}
|
||||
|
||||
.versionmodified {
|
||||
font-style: italic;
|
||||
}
|
||||
|
||||
.system-message {
|
||||
background-color: #fda;
|
||||
padding: 5px;
|
||||
border: 3px solid red;
|
||||
}
|
||||
|
||||
.footnote:target {
|
||||
background-color: #ffa;
|
||||
}
|
||||
|
||||
.line-block {
|
||||
display: block;
|
||||
margin-top: 1em;
|
||||
margin-bottom: 1em;
|
||||
}
|
||||
|
||||
.line-block .line-block {
|
||||
margin-top: 0;
|
||||
margin-bottom: 0;
|
||||
margin-left: 1.5em;
|
||||
}
|
||||
|
||||
.guilabel, .menuselection {
|
||||
font-family: sans-serif;
|
||||
}
|
||||
|
||||
.accelerator {
|
||||
text-decoration: underline;
|
||||
}
|
||||
|
||||
.classifier {
|
||||
font-style: oblique;
|
||||
}
|
||||
|
||||
.classifier:before {
|
||||
font-style: normal;
|
||||
margin: 0.5em;
|
||||
content: ":";
|
||||
}
|
||||
|
||||
abbr, acronym {
|
||||
border-bottom: dotted 1px;
|
||||
cursor: help;
|
||||
}
|
||||
|
||||
/* -- code displays --------------------------------------------------------- */
|
||||
|
||||
pre {
|
||||
overflow: auto;
|
||||
overflow-y: hidden; /* fixes display issues on Chrome browsers */
|
||||
}
|
||||
|
||||
pre, div[class*="highlight-"] {
|
||||
clear: both;
|
||||
}
|
||||
|
||||
span.pre {
|
||||
-moz-hyphens: none;
|
||||
-ms-hyphens: none;
|
||||
-webkit-hyphens: none;
|
||||
hyphens: none;
|
||||
}
|
||||
|
||||
div[class*="highlight-"] {
|
||||
margin: 1em 0;
|
||||
}
|
||||
|
||||
td.linenos pre {
|
||||
border: 0;
|
||||
background-color: transparent;
|
||||
color: #aaa;
|
||||
}
|
||||
|
||||
table.highlighttable {
|
||||
display: block;
|
||||
}
|
||||
|
||||
table.highlighttable tbody {
|
||||
display: block;
|
||||
}
|
||||
|
||||
table.highlighttable tr {
|
||||
display: flex;
|
||||
}
|
||||
|
||||
table.highlighttable td {
|
||||
margin: 0;
|
||||
padding: 0;
|
||||
}
|
||||
|
||||
table.highlighttable td.linenos {
|
||||
padding-right: 0.5em;
|
||||
}
|
||||
|
||||
table.highlighttable td.code {
|
||||
flex: 1;
|
||||
overflow: hidden;
|
||||
}
|
||||
|
||||
.highlight .hll {
|
||||
display: block;
|
||||
}
|
||||
|
||||
div.highlight pre,
|
||||
table.highlighttable pre {
|
||||
margin: 0;
|
||||
}
|
||||
|
||||
div.code-block-caption + div {
|
||||
margin-top: 0;
|
||||
}
|
||||
|
||||
div.code-block-caption {
|
||||
margin-top: 1em;
|
||||
padding: 2px 5px;
|
||||
font-size: small;
|
||||
}
|
||||
|
||||
div.code-block-caption code {
|
||||
background-color: transparent;
|
||||
}
|
||||
|
||||
table.highlighttable td.linenos,
|
||||
span.linenos,
|
||||
div.doctest > div.highlight span.gp { /* gp: Generic.Prompt */
|
||||
user-select: none;
|
||||
}
|
||||
|
||||
div.code-block-caption span.caption-number {
|
||||
padding: 0.1em 0.3em;
|
||||
font-style: italic;
|
||||
}
|
||||
|
||||
div.code-block-caption span.caption-text {
|
||||
}
|
||||
|
||||
div.literal-block-wrapper {
|
||||
margin: 1em 0;
|
||||
}
|
||||
|
||||
code.descname {
|
||||
background-color: transparent;
|
||||
font-weight: bold;
|
||||
font-size: 1.2em;
|
||||
}
|
||||
|
||||
code.descclassname {
|
||||
background-color: transparent;
|
||||
}
|
||||
|
||||
code.xref, a code {
|
||||
background-color: transparent;
|
||||
font-weight: bold;
|
||||
}
|
||||
|
||||
h1 code, h2 code, h3 code, h4 code, h5 code, h6 code {
|
||||
background-color: transparent;
|
||||
}
|
||||
|
||||
.viewcode-link {
|
||||
float: right;
|
||||
}
|
||||
|
||||
.viewcode-back {
|
||||
float: right;
|
||||
font-family: sans-serif;
|
||||
}
|
||||
|
||||
div.viewcode-block:target {
|
||||
margin: -1px -10px;
|
||||
padding: 0 10px;
|
||||
}
|
||||
|
||||
/* -- math display ---------------------------------------------------------- */
|
||||
|
||||
img.math {
|
||||
vertical-align: middle;
|
||||
}
|
||||
|
||||
div.body div.math p {
|
||||
text-align: center;
|
||||
}
|
||||
|
||||
span.eqno {
|
||||
float: right;
|
||||
}
|
||||
|
||||
span.eqno a.headerlink {
|
||||
position: absolute;
|
||||
z-index: 1;
|
||||
}
|
||||
|
||||
div.math:hover a.headerlink {
|
||||
visibility: visible;
|
||||
}
|
||||
|
||||
/* -- printout stylesheet --------------------------------------------------- */
|
||||
|
||||
@media print {
|
||||
div.document,
|
||||
div.documentwrapper,
|
||||
div.bodywrapper {
|
||||
margin: 0 !important;
|
||||
width: 100%;
|
||||
}
|
||||
|
||||
div.sphinxsidebar,
|
||||
div.related,
|
||||
div.footer,
|
||||
#top-link {
|
||||
display: none;
|
||||
}
|
||||
}
|
||||
|
|
@ -1 +0,0 @@
|
|||
.fa:before{-webkit-font-smoothing:antialiased}.clearfix{*zoom:1}.clearfix:after,.clearfix:before{display:table;content:""}.clearfix:after{clear:both}@font-face{font-family:FontAwesome;font-style:normal;font-weight:400;src:url(fonts/fontawesome-webfont.eot?674f50d287a8c48dc19ba404d20fe713?#iefix) format("embedded-opentype"),url(fonts/fontawesome-webfont.woff2?af7ae505a9eed503f8b8e6982036873e) format("woff2"),url(fonts/fontawesome-webfont.woff?fee66e712a8a08eef5805a46892932ad) format("woff"),url(fonts/fontawesome-webfont.ttf?b06871f281fee6b241d60582ae9369b9) format("truetype"),url(fonts/fontawesome-webfont.svg?912ec66d7572ff821749319396470bde#FontAwesome) format("svg")}.fa:before{font-family:FontAwesome;font-style:normal;font-weight:400;line-height:1}.fa:before,a .fa{text-decoration:inherit}.fa:before,a .fa,li .fa{display:inline-block}li .fa-large:before{width:1.875em}ul.fas{list-style-type:none;margin-left:2em;text-indent:-.8em}ul.fas li .fa{width:.8em}ul.fas li .fa-large:before{vertical-align:baseline}.fa-book:before,.icon-book:before{content:"\f02d"}.fa-caret-down:before,.icon-caret-down:before{content:"\f0d7"}.fa-caret-up:before,.icon-caret-up:before{content:"\f0d8"}.fa-caret-left:before,.icon-caret-left:before{content:"\f0d9"}.fa-caret-right:before,.icon-caret-right:before{content:"\f0da"}.rst-versions{position:fixed;bottom:0;left:0;width:300px;color:#fcfcfc;background:#1f1d1d;font-family:Lato,proxima-nova,Helvetica Neue,Arial,sans-serif;z-index:400}.rst-versions a{color:#2980b9;text-decoration:none}.rst-versions .rst-badge-small{display:none}.rst-versions .rst-current-version{padding:12px;background-color:#272525;display:block;text-align:right;font-size:90%;cursor:pointer;color:#27ae60}.rst-versions .rst-current-version:after{clear:both;content:"";display:block}.rst-versions .rst-current-version .fa{color:#fcfcfc}.rst-versions .rst-current-version .fa-book,.rst-versions .rst-current-version .icon-book{float:left}.rst-versions .rst-current-version.rst-out-of-date{background-color:#e74c3c;color:#fff}.rst-versions .rst-current-version.rst-active-old-version{background-color:#f1c40f;color:#000}.rst-versions.shift-up{height:auto;max-height:100%;overflow-y:scroll}.rst-versions.shift-up .rst-other-versions{display:block}.rst-versions .rst-other-versions{font-size:90%;padding:12px;color:grey;display:none}.rst-versions .rst-other-versions hr{display:block;height:1px;border:0;margin:20px 0;padding:0;border-top:1px solid #413d3d}.rst-versions .rst-other-versions dd{display:inline-block;margin:0}.rst-versions .rst-other-versions dd a{display:inline-block;padding:6px;color:#fcfcfc}.rst-versions.rst-badge{width:auto;bottom:20px;right:20px;left:auto;border:none;max-width:300px;max-height:90%}.rst-versions.rst-badge .fa-book,.rst-versions.rst-badge .icon-book{float:none;line-height:30px}.rst-versions.rst-badge.shift-up .rst-current-version{text-align:right}.rst-versions.rst-badge.shift-up .rst-current-version .fa-book,.rst-versions.rst-badge.shift-up .rst-current-version .icon-book{float:left}.rst-versions.rst-badge>.rst-current-version{width:auto;height:30px;line-height:30px;padding:0 6px;display:block;text-align:center}@media screen and (max-width:768px){.rst-versions{width:85%;display:none}.rst-versions.shift{display:block}}
|
||||
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
File diff suppressed because it is too large
Load diff
|
Before Width: | Height: | Size: 434 KiB |
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
File diff suppressed because one or more lines are too long
|
|
@ -1,321 +0,0 @@
|
|||
/*
|
||||
* doctools.js
|
||||
* ~~~~~~~~~~~
|
||||
*
|
||||
* Sphinx JavaScript utilities for all documentation.
|
||||
*
|
||||
* :copyright: Copyright 2007-2021 by the Sphinx team, see AUTHORS.
|
||||
* :license: BSD, see LICENSE for details.
|
||||
*
|
||||
*/
|
||||
|
||||
/**
|
||||
* select a different prefix for underscore
|
||||
*/
|
||||
$u = _.noConflict();
|
||||
|
||||
/**
|
||||
* make the code below compatible with browsers without
|
||||
* an installed firebug like debugger
|
||||
if (!window.console || !console.firebug) {
|
||||
var names = ["log", "debug", "info", "warn", "error", "assert", "dir",
|
||||
"dirxml", "group", "groupEnd", "time", "timeEnd", "count", "trace",
|
||||
"profile", "profileEnd"];
|
||||
window.console = {};
|
||||
for (var i = 0; i < names.length; ++i)
|
||||
window.console[names[i]] = function() {};
|
||||
}
|
||||
*/
|
||||
|
||||
/**
|
||||
* small helper function to urldecode strings
|
||||
*
|
||||
* See https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/decodeURIComponent#Decoding_query_parameters_from_a_URL
|
||||
*/
|
||||
jQuery.urldecode = function(x) {
|
||||
if (!x) {
|
||||
return x
|
||||
}
|
||||
return decodeURIComponent(x.replace(/\+/g, ' '));
|
||||
};
|
||||
|
||||
/**
|
||||
* small helper function to urlencode strings
|
||||
*/
|
||||
jQuery.urlencode = encodeURIComponent;
|
||||
|
||||
/**
|
||||
* This function returns the parsed url parameters of the
|
||||
* current request. Multiple values per key are supported,
|
||||
* it will always return arrays of strings for the value parts.
|
||||
*/
|
||||
jQuery.getQueryParameters = function(s) {
|
||||
if (typeof s === 'undefined')
|
||||
s = document.location.search;
|
||||
var parts = s.substr(s.indexOf('?') + 1).split('&');
|
||||
var result = {};
|
||||
for (var i = 0; i < parts.length; i++) {
|
||||
var tmp = parts[i].split('=', 2);
|
||||
var key = jQuery.urldecode(tmp[0]);
|
||||
var value = jQuery.urldecode(tmp[1]);
|
||||
if (key in result)
|
||||
result[key].push(value);
|
||||
else
|
||||
result[key] = [value];
|
||||
}
|
||||
return result;
|
||||
};
|
||||
|
||||
/**
|
||||
* highlight a given string on a jquery object by wrapping it in
|
||||
* span elements with the given class name.
|
||||
*/
|
||||
jQuery.fn.highlightText = function(text, className) {
|
||||
function highlight(node, addItems) {
|
||||
if (node.nodeType === 3) {
|
||||
var val = node.nodeValue;
|
||||
var pos = val.toLowerCase().indexOf(text);
|
||||
if (pos >= 0 &&
|
||||
!jQuery(node.parentNode).hasClass(className) &&
|
||||
!jQuery(node.parentNode).hasClass("nohighlight")) {
|
||||
var span;
|
||||
var isInSVG = jQuery(node).closest("body, svg, foreignObject").is("svg");
|
||||
if (isInSVG) {
|
||||
span = document.createElementNS("http://www.w3.org/2000/svg", "tspan");
|
||||
} else {
|
||||
span = document.createElement("span");
|
||||
span.className = className;
|
||||
}
|
||||
span.appendChild(document.createTextNode(val.substr(pos, text.length)));
|
||||
node.parentNode.insertBefore(span, node.parentNode.insertBefore(
|
||||
document.createTextNode(val.substr(pos + text.length)),
|
||||
node.nextSibling));
|
||||
node.nodeValue = val.substr(0, pos);
|
||||
if (isInSVG) {
|
||||
var rect = document.createElementNS("http://www.w3.org/2000/svg", "rect");
|
||||
var bbox = node.parentElement.getBBox();
|
||||
rect.x.baseVal.value = bbox.x;
|
||||
rect.y.baseVal.value = bbox.y;
|
||||
rect.width.baseVal.value = bbox.width;
|
||||
rect.height.baseVal.value = bbox.height;
|
||||
rect.setAttribute('class', className);
|
||||
addItems.push({
|
||||
"parent": node.parentNode,
|
||||
"target": rect});
|
||||
}
|
||||
}
|
||||
}
|
||||
else if (!jQuery(node).is("button, select, textarea")) {
|
||||
jQuery.each(node.childNodes, function() {
|
||||
highlight(this, addItems);
|
||||
});
|
||||
}
|
||||
}
|
||||
var addItems = [];
|
||||
var result = this.each(function() {
|
||||
highlight(this, addItems);
|
||||
});
|
||||
for (var i = 0; i < addItems.length; ++i) {
|
||||
jQuery(addItems[i].parent).before(addItems[i].target);
|
||||
}
|
||||
return result;
|
||||
};
|
||||
|
||||
/*
|
||||
* backward compatibility for jQuery.browser
|
||||
* This will be supported until firefox bug is fixed.
|
||||
*/
|
||||
if (!jQuery.browser) {
|
||||
jQuery.uaMatch = function(ua) {
|
||||
ua = ua.toLowerCase();
|
||||
|
||||
var match = /(chrome)[ \/]([\w.]+)/.exec(ua) ||
|
||||
/(webkit)[ \/]([\w.]+)/.exec(ua) ||
|
||||
/(opera)(?:.*version|)[ \/]([\w.]+)/.exec(ua) ||
|
||||
/(msie) ([\w.]+)/.exec(ua) ||
|
||||
ua.indexOf("compatible") < 0 && /(mozilla)(?:.*? rv:([\w.]+)|)/.exec(ua) ||
|
||||
[];
|
||||
|
||||
return {
|
||||
browser: match[ 1 ] || "",
|
||||
version: match[ 2 ] || "0"
|
||||
};
|
||||
};
|
||||
jQuery.browser = {};
|
||||
jQuery.browser[jQuery.uaMatch(navigator.userAgent).browser] = true;
|
||||
}
|
||||
|
||||
/**
|
||||
* Small JavaScript module for the documentation.
|
||||
*/
|
||||
var Documentation = {
|
||||
|
||||
init : function() {
|
||||
this.fixFirefoxAnchorBug();
|
||||
this.highlightSearchWords();
|
||||
this.initIndexTable();
|
||||
if (DOCUMENTATION_OPTIONS.NAVIGATION_WITH_KEYS) {
|
||||
this.initOnKeyListeners();
|
||||
}
|
||||
},
|
||||
|
||||
/**
|
||||
* i18n support
|
||||
*/
|
||||
TRANSLATIONS : {},
|
||||
PLURAL_EXPR : function(n) { return n === 1 ? 0 : 1; },
|
||||
LOCALE : 'unknown',
|
||||
|
||||
// gettext and ngettext don't access this so that the functions
|
||||
// can safely bound to a different name (_ = Documentation.gettext)
|
||||
gettext : function(string) {
|
||||
var translated = Documentation.TRANSLATIONS[string];
|
||||
if (typeof translated === 'undefined')
|
||||
return string;
|
||||
return (typeof translated === 'string') ? translated : translated[0];
|
||||
},
|
||||
|
||||
ngettext : function(singular, plural, n) {
|
||||
var translated = Documentation.TRANSLATIONS[singular];
|
||||
if (typeof translated === 'undefined')
|
||||
return (n == 1) ? singular : plural;
|
||||
return translated[Documentation.PLURALEXPR(n)];
|
||||
},
|
||||
|
||||
addTranslations : function(catalog) {
|
||||
for (var key in catalog.messages)
|
||||
this.TRANSLATIONS[key] = catalog.messages[key];
|
||||
this.PLURAL_EXPR = new Function('n', 'return +(' + catalog.plural_expr + ')');
|
||||
this.LOCALE = catalog.locale;
|
||||
},
|
||||
|
||||
/**
|
||||
* add context elements like header anchor links
|
||||
*/
|
||||
addContextElements : function() {
|
||||
$('div[id] > :header:first').each(function() {
|
||||
$('<a class="headerlink">\u00B6</a>').
|
||||
attr('href', '#' + this.id).
|
||||
attr('title', _('Permalink to this headline')).
|
||||
appendTo(this);
|
||||
});
|
||||
$('dt[id]').each(function() {
|
||||
$('<a class="headerlink">\u00B6</a>').
|
||||
attr('href', '#' + this.id).
|
||||
attr('title', _('Permalink to this definition')).
|
||||
appendTo(this);
|
||||
});
|
||||
},
|
||||
|
||||
/**
|
||||
* workaround a firefox stupidity
|
||||
* see: https://bugzilla.mozilla.org/show_bug.cgi?id=645075
|
||||
*/
|
||||
fixFirefoxAnchorBug : function() {
|
||||
if (document.location.hash && $.browser.mozilla)
|
||||
window.setTimeout(function() {
|
||||
document.location.href += '';
|
||||
}, 10);
|
||||
},
|
||||
|
||||
/**
|
||||
* highlight the search words provided in the url in the text
|
||||
*/
|
||||
highlightSearchWords : function() {
|
||||
var params = $.getQueryParameters();
|
||||
var terms = (params.highlight) ? params.highlight[0].split(/\s+/) : [];
|
||||
if (terms.length) {
|
||||
var body = $('div.body');
|
||||
if (!body.length) {
|
||||
body = $('body');
|
||||
}
|
||||
window.setTimeout(function() {
|
||||
$.each(terms, function() {
|
||||
body.highlightText(this.toLowerCase(), 'highlighted');
|
||||
});
|
||||
}, 10);
|
||||
$('<p class="highlight-link"><a href="javascript:Documentation.' +
|
||||
'hideSearchWords()">' + _('Hide Search Matches') + '</a></p>')
|
||||
.appendTo($('#searchbox'));
|
||||
}
|
||||
},
|
||||
|
||||
/**
|
||||
* init the domain index toggle buttons
|
||||
*/
|
||||
initIndexTable : function() {
|
||||
var togglers = $('img.toggler').click(function() {
|
||||
var src = $(this).attr('src');
|
||||
var idnum = $(this).attr('id').substr(7);
|
||||
$('tr.cg-' + idnum).toggle();
|
||||
if (src.substr(-9) === 'minus.png')
|
||||
$(this).attr('src', src.substr(0, src.length-9) + 'plus.png');
|
||||
else
|
||||
$(this).attr('src', src.substr(0, src.length-8) + 'minus.png');
|
||||
}).css('display', '');
|
||||
if (DOCUMENTATION_OPTIONS.COLLAPSE_INDEX) {
|
||||
togglers.click();
|
||||
}
|
||||
},
|
||||
|
||||
/**
|
||||
* helper function to hide the search marks again
|
||||
*/
|
||||
hideSearchWords : function() {
|
||||
$('#searchbox .highlight-link').fadeOut(300);
|
||||
$('span.highlighted').removeClass('highlighted');
|
||||
},
|
||||
|
||||
/**
|
||||
* make the url absolute
|
||||
*/
|
||||
makeURL : function(relativeURL) {
|
||||
return DOCUMENTATION_OPTIONS.URL_ROOT + '/' + relativeURL;
|
||||
},
|
||||
|
||||
/**
|
||||
* get the current relative url
|
||||
*/
|
||||
getCurrentURL : function() {
|
||||
var path = document.location.pathname;
|
||||
var parts = path.split(/\//);
|
||||
$.each(DOCUMENTATION_OPTIONS.URL_ROOT.split(/\//), function() {
|
||||
if (this === '..')
|
||||
parts.pop();
|
||||
});
|
||||
var url = parts.join('/');
|
||||
return path.substring(url.lastIndexOf('/') + 1, path.length - 1);
|
||||
},
|
||||
|
||||
initOnKeyListeners: function() {
|
||||
$(document).keydown(function(event) {
|
||||
var activeElementType = document.activeElement.tagName;
|
||||
// don't navigate when in search box, textarea, dropdown or button
|
||||
if (activeElementType !== 'TEXTAREA' && activeElementType !== 'INPUT' && activeElementType !== 'SELECT'
|
||||
&& activeElementType !== 'BUTTON' && !event.altKey && !event.ctrlKey && !event.metaKey
|
||||
&& !event.shiftKey) {
|
||||
switch (event.keyCode) {
|
||||
case 37: // left
|
||||
var prevHref = $('link[rel="prev"]').prop('href');
|
||||
if (prevHref) {
|
||||
window.location.href = prevHref;
|
||||
return false;
|
||||
}
|
||||
case 39: // right
|
||||
var nextHref = $('link[rel="next"]').prop('href');
|
||||
if (nextHref) {
|
||||
window.location.href = nextHref;
|
||||
return false;
|
||||
}
|
||||
}
|
||||
}
|
||||
});
|
||||
}
|
||||
};
|
||||
|
||||
// quick alias for translations
|
||||
_ = Documentation.gettext;
|
||||
|
||||
$(document).ready(function() {
|
||||
Documentation.init();
|
||||
});
|
||||
|
|
@ -1,12 +0,0 @@
|
|||
var DOCUMENTATION_OPTIONS = {
|
||||
URL_ROOT: document.getElementById("documentation_options").getAttribute('data-url_root'),
|
||||
VERSION: '0.1',
|
||||
LANGUAGE: 'zh_CN',
|
||||
COLLAPSE_INDEX: false,
|
||||
BUILDER: 'html',
|
||||
FILE_SUFFIX: '.html',
|
||||
LINK_SUFFIX: '.html',
|
||||
HAS_SOURCE: true,
|
||||
SOURCELINK_SUFFIX: '.txt',
|
||||
NAVIGATION_WITH_KEYS: false
|
||||
};
|
||||
Binary file not shown.
|
Before Width: | Height: | Size: 286 B |
File diff suppressed because it is too large
Load diff
File diff suppressed because one or more lines are too long
|
|
@ -1 +0,0 @@
|
|||
!function(e){var t={};function r(n){if(t[n])return t[n].exports;var o=t[n]={i:n,l:!1,exports:{}};return e[n].call(o.exports,o,o.exports,r),o.l=!0,o.exports}r.m=e,r.c=t,r.d=function(e,t,n){r.o(e,t)||Object.defineProperty(e,t,{enumerable:!0,get:n})},r.r=function(e){"undefined"!=typeof Symbol&&Symbol.toStringTag&&Object.defineProperty(e,Symbol.toStringTag,{value:"Module"}),Object.defineProperty(e,"__esModule",{value:!0})},r.t=function(e,t){if(1&t&&(e=r(e)),8&t)return e;if(4&t&&"object"==typeof e&&e&&e.__esModule)return e;var n=Object.create(null);if(r.r(n),Object.defineProperty(n,"default",{enumerable:!0,value:e}),2&t&&"string"!=typeof e)for(var o in e)r.d(n,o,function(t){return e[t]}.bind(null,o));return n},r.n=function(e){var t=e&&e.__esModule?function(){return e.default}:function(){return e};return r.d(t,"a",t),t},r.o=function(e,t){return Object.prototype.hasOwnProperty.call(e,t)},r.p="",r(r.s=4)}({4:function(e,t,r){}});
|
||||
|
|
@ -1,4 +0,0 @@
|
|||
/**
|
||||
* @preserve HTML5 Shiv 3.7.3-pre | @afarkas @jdalton @jon_neal @rem | MIT/GPL2 Licensed
|
||||
*/
|
||||
!function(a,b){function c(a,b){var c=a.createElement("p"),d=a.getElementsByTagName("head")[0]||a.documentElement;return c.innerHTML="x<style>"+b+"</style>",d.insertBefore(c.lastChild,d.firstChild)}function d(){var a=y.elements;return"string"==typeof a?a.split(" "):a}function e(a,b){var c=y.elements;"string"!=typeof c&&(c=c.join(" ")),"string"!=typeof a&&(a=a.join(" ")),y.elements=c+" "+a,j(b)}function f(a){var b=x[a[v]];return b||(b={},w++,a[v]=w,x[w]=b),b}function g(a,c,d){if(c||(c=b),q)return c.createElement(a);d||(d=f(c));var e;return e=d.cache[a]?d.cache[a].cloneNode():u.test(a)?(d.cache[a]=d.createElem(a)).cloneNode():d.createElem(a),!e.canHaveChildren||t.test(a)||e.tagUrn?e:d.frag.appendChild(e)}function h(a,c){if(a||(a=b),q)return a.createDocumentFragment();c=c||f(a);for(var e=c.frag.cloneNode(),g=0,h=d(),i=h.length;i>g;g++)e.createElement(h[g]);return e}function i(a,b){b.cache||(b.cache={},b.createElem=a.createElement,b.createFrag=a.createDocumentFragment,b.frag=b.createFrag()),a.createElement=function(c){return y.shivMethods?g(c,a,b):b.createElem(c)},a.createDocumentFragment=Function("h,f","return function(){var n=f.cloneNode(),c=n.createElement;h.shivMethods&&("+d().join().replace(/[\w\-:]+/g,function(a){return b.createElem(a),b.frag.createElement(a),'c("'+a+'")'})+");return n}")(y,b.frag)}function j(a){a||(a=b);var d=f(a);return!y.shivCSS||p||d.hasCSS||(d.hasCSS=!!c(a,"article,aside,dialog,figcaption,figure,footer,header,hgroup,main,nav,section{display:block}mark{background:#FF0;color:#000}template{display:none}")),q||i(a,d),a}function k(a){for(var b,c=a.getElementsByTagName("*"),e=c.length,f=RegExp("^(?:"+d().join("|")+")$","i"),g=[];e--;)b=c[e],f.test(b.nodeName)&&g.push(b.applyElement(l(b)));return g}function l(a){for(var b,c=a.attributes,d=c.length,e=a.ownerDocument.createElement(A+":"+a.nodeName);d--;)b=c[d],b.specified&&e.setAttribute(b.nodeName,b.nodeValue);return e.style.cssText=a.style.cssText,e}function m(a){for(var b,c=a.split("{"),e=c.length,f=RegExp("(^|[\\s,>+~])("+d().join("|")+")(?=[[\\s,>+~#.:]|$)","gi"),g="$1"+A+"\\:$2";e--;)b=c[e]=c[e].split("}"),b[b.length-1]=b[b.length-1].replace(f,g),c[e]=b.join("}");return c.join("{")}function n(a){for(var b=a.length;b--;)a[b].removeNode()}function o(a){function b(){clearTimeout(g._removeSheetTimer),d&&d.removeNode(!0),d=null}var d,e,g=f(a),h=a.namespaces,i=a.parentWindow;return!B||a.printShived?a:("undefined"==typeof h[A]&&h.add(A),i.attachEvent("onbeforeprint",function(){b();for(var f,g,h,i=a.styleSheets,j=[],l=i.length,n=Array(l);l--;)n[l]=i[l];for(;h=n.pop();)if(!h.disabled&&z.test(h.media)){try{f=h.imports,g=f.length}catch(o){g=0}for(l=0;g>l;l++)n.push(f[l]);try{j.push(h.cssText)}catch(o){}}j=m(j.reverse().join("")),e=k(a),d=c(a,j)}),i.attachEvent("onafterprint",function(){n(e),clearTimeout(g._removeSheetTimer),g._removeSheetTimer=setTimeout(b,500)}),a.printShived=!0,a)}var p,q,r="3.7.3",s=a.html5||{},t=/^<|^(?:button|map|select|textarea|object|iframe|option|optgroup)$/i,u=/^(?:a|b|code|div|fieldset|h1|h2|h3|h4|h5|h6|i|label|li|ol|p|q|span|strong|style|table|tbody|td|th|tr|ul)$/i,v="_html5shiv",w=0,x={};!function(){try{var a=b.createElement("a");a.innerHTML="<xyz></xyz>",p="hidden"in a,q=1==a.childNodes.length||function(){b.createElement("a");var a=b.createDocumentFragment();return"undefined"==typeof a.cloneNode||"undefined"==typeof a.createDocumentFragment||"undefined"==typeof a.createElement}()}catch(c){p=!0,q=!0}}();var y={elements:s.elements||"abbr article aside audio bdi canvas data datalist details dialog figcaption figure footer header hgroup main mark meter nav output picture progress section summary template time video",version:r,shivCSS:s.shivCSS!==!1,supportsUnknownElements:q,shivMethods:s.shivMethods!==!1,type:"default",shivDocument:j,createElement:g,createDocumentFragment:h,addElements:e};a.html5=y,j(b);var z=/^$|\b(?:all|print)\b/,A="html5shiv",B=!q&&function(){var c=b.documentElement;return!("undefined"==typeof b.namespaces||"undefined"==typeof b.parentWindow||"undefined"==typeof c.applyElement||"undefined"==typeof c.removeNode||"undefined"==typeof a.attachEvent)}();y.type+=" print",y.shivPrint=o,o(b),"object"==typeof module&&module.exports&&(module.exports=y)}("undefined"!=typeof window?window:this,document);
|
||||
|
|
@ -1,4 +0,0 @@
|
|||
/**
|
||||
* @preserve HTML5 Shiv 3.7.3 | @afarkas @jdalton @jon_neal @rem | MIT/GPL2 Licensed
|
||||
*/
|
||||
!function(a,b){function c(a,b){var c=a.createElement("p"),d=a.getElementsByTagName("head")[0]||a.documentElement;return c.innerHTML="x<style>"+b+"</style>",d.insertBefore(c.lastChild,d.firstChild)}function d(){var a=t.elements;return"string"==typeof a?a.split(" "):a}function e(a,b){var c=t.elements;"string"!=typeof c&&(c=c.join(" ")),"string"!=typeof a&&(a=a.join(" ")),t.elements=c+" "+a,j(b)}function f(a){var b=s[a[q]];return b||(b={},r++,a[q]=r,s[r]=b),b}function g(a,c,d){if(c||(c=b),l)return c.createElement(a);d||(d=f(c));var e;return e=d.cache[a]?d.cache[a].cloneNode():p.test(a)?(d.cache[a]=d.createElem(a)).cloneNode():d.createElem(a),!e.canHaveChildren||o.test(a)||e.tagUrn?e:d.frag.appendChild(e)}function h(a,c){if(a||(a=b),l)return a.createDocumentFragment();c=c||f(a);for(var e=c.frag.cloneNode(),g=0,h=d(),i=h.length;i>g;g++)e.createElement(h[g]);return e}function i(a,b){b.cache||(b.cache={},b.createElem=a.createElement,b.createFrag=a.createDocumentFragment,b.frag=b.createFrag()),a.createElement=function(c){return t.shivMethods?g(c,a,b):b.createElem(c)},a.createDocumentFragment=Function("h,f","return function(){var n=f.cloneNode(),c=n.createElement;h.shivMethods&&("+d().join().replace(/[\w\-:]+/g,function(a){return b.createElem(a),b.frag.createElement(a),'c("'+a+'")'})+");return n}")(t,b.frag)}function j(a){a||(a=b);var d=f(a);return!t.shivCSS||k||d.hasCSS||(d.hasCSS=!!c(a,"article,aside,dialog,figcaption,figure,footer,header,hgroup,main,nav,section{display:block}mark{background:#FF0;color:#000}template{display:none}")),l||i(a,d),a}var k,l,m="3.7.3-pre",n=a.html5||{},o=/^<|^(?:button|map|select|textarea|object|iframe|option|optgroup)$/i,p=/^(?:a|b|code|div|fieldset|h1|h2|h3|h4|h5|h6|i|label|li|ol|p|q|span|strong|style|table|tbody|td|th|tr|ul)$/i,q="_html5shiv",r=0,s={};!function(){try{var a=b.createElement("a");a.innerHTML="<xyz></xyz>",k="hidden"in a,l=1==a.childNodes.length||function(){b.createElement("a");var a=b.createDocumentFragment();return"undefined"==typeof a.cloneNode||"undefined"==typeof a.createDocumentFragment||"undefined"==typeof a.createElement}()}catch(c){k=!0,l=!0}}();var t={elements:n.elements||"abbr article aside audio bdi canvas data datalist details dialog figcaption figure footer header hgroup main mark meter nav output picture progress section summary template time video",version:m,shivCSS:n.shivCSS!==!1,supportsUnknownElements:l,shivMethods:n.shivMethods!==!1,type:"default",shivDocument:j,createElement:g,createDocumentFragment:h,addElements:e};a.html5=t,j(b),"object"==typeof module&&module.exports&&(module.exports=t)}("undefined"!=typeof window?window:this,document);
|
||||
|
|
@ -1 +0,0 @@
|
|||
!function(n){var e={};function t(i){if(e[i])return e[i].exports;var o=e[i]={i:i,l:!1,exports:{}};return n[i].call(o.exports,o,o.exports,t),o.l=!0,o.exports}t.m=n,t.c=e,t.d=function(n,e,i){t.o(n,e)||Object.defineProperty(n,e,{enumerable:!0,get:i})},t.r=function(n){"undefined"!=typeof Symbol&&Symbol.toStringTag&&Object.defineProperty(n,Symbol.toStringTag,{value:"Module"}),Object.defineProperty(n,"__esModule",{value:!0})},t.t=function(n,e){if(1&e&&(n=t(n)),8&e)return n;if(4&e&&"object"==typeof n&&n&&n.__esModule)return n;var i=Object.create(null);if(t.r(i),Object.defineProperty(i,"default",{enumerable:!0,value:n}),2&e&&"string"!=typeof n)for(var o in n)t.d(i,o,function(e){return n[e]}.bind(null,o));return i},t.n=function(n){var e=n&&n.__esModule?function(){return n.default}:function(){return n};return t.d(e,"a",e),e},t.o=function(n,e){return Object.prototype.hasOwnProperty.call(n,e)},t.p="",t(t.s=0)}([function(n,e,t){t(1),n.exports=t(3)},function(n,e,t){(function(){var e="undefined"!=typeof window?window.jQuery:t(2);n.exports.ThemeNav={navBar:null,win:null,winScroll:!1,winResize:!1,linkScroll:!1,winPosition:0,winHeight:null,docHeight:null,isRunning:!1,enable:function(n){var t=this;void 0===n&&(n=!0),t.isRunning||(t.isRunning=!0,e((function(e){t.init(e),t.reset(),t.win.on("hashchange",t.reset),n&&t.win.on("scroll",(function(){t.linkScroll||t.winScroll||(t.winScroll=!0,requestAnimationFrame((function(){t.onScroll()})))})),t.win.on("resize",(function(){t.winResize||(t.winResize=!0,requestAnimationFrame((function(){t.onResize()})))})),t.onResize()})))},enableSticky:function(){this.enable(!0)},init:function(n){n(document);var e=this;this.navBar=n("div.wy-side-scroll:first"),this.win=n(window),n(document).on("click","[data-toggle='wy-nav-top']",(function(){n("[data-toggle='wy-nav-shift']").toggleClass("shift"),n("[data-toggle='rst-versions']").toggleClass("shift")})).on("click",".wy-menu-vertical .current ul li a",(function(){var t=n(this);n("[data-toggle='wy-nav-shift']").removeClass("shift"),n("[data-toggle='rst-versions']").toggleClass("shift"),e.toggleCurrent(t),e.hashChange()})).on("click","[data-toggle='rst-current-version']",(function(){n("[data-toggle='rst-versions']").toggleClass("shift-up")})),n("table.docutils:not(.field-list,.footnote,.citation)").wrap("<div class='wy-table-responsive'></div>"),n("table.docutils.footnote").wrap("<div class='wy-table-responsive footnote'></div>"),n("table.docutils.citation").wrap("<div class='wy-table-responsive citation'></div>"),n(".wy-menu-vertical ul").not(".simple").siblings("a").each((function(){var t=n(this);expand=n('<span class="toctree-expand"></span>'),expand.on("click",(function(n){return e.toggleCurrent(t),n.stopPropagation(),!1})),t.prepend(expand)}))},reset:function(){var n=encodeURI(window.location.hash)||"#";try{var e=$(".wy-menu-vertical"),t=e.find('[href="'+n+'"]');if(0===t.length){var i=$('.document [id="'+n.substring(1)+'"]').closest("div.section");0===(t=e.find('[href="#'+i.attr("id")+'"]')).length&&(t=e.find('[href="#"]'))}t.length>0&&($(".wy-menu-vertical .current").removeClass("current"),t.addClass("current"),t.closest("li.toctree-l1").addClass("current"),t.closest("li.toctree-l1").parent().addClass("current"),t.closest("li.toctree-l1").addClass("current"),t.closest("li.toctree-l2").addClass("current"),t.closest("li.toctree-l3").addClass("current"),t.closest("li.toctree-l4").addClass("current"),t.closest("li.toctree-l5").addClass("current"),t[0].scrollIntoView())}catch(n){console.log("Error expanding nav for anchor",n)}},onScroll:function(){this.winScroll=!1;var n=this.win.scrollTop(),e=n+this.winHeight,t=this.navBar.scrollTop()+(n-this.winPosition);n<0||e>this.docHeight||(this.navBar.scrollTop(t),this.winPosition=n)},onResize:function(){this.winResize=!1,this.winHeight=this.win.height(),this.docHeight=$(document).height()},hashChange:function(){this.linkScroll=!0,this.win.one("hashchange",(function(){this.linkScroll=!1}))},toggleCurrent:function(n){var e=n.closest("li");e.siblings("li.current").removeClass("current"),e.siblings().find("li.current").removeClass("current"),e.find("> ul li.current").removeClass("current"),e.toggleClass("current")}},"undefined"!=typeof window&&(window.SphinxRtdTheme={Navigation:n.exports.ThemeNav,StickyNav:n.exports.ThemeNav}),function(){for(var n=0,e=["ms","moz","webkit","o"],t=0;t<e.length&&!window.requestAnimationFrame;++t)window.requestAnimationFrame=window[e[t]+"RequestAnimationFrame"],window.cancelAnimationFrame=window[e[t]+"CancelAnimationFrame"]||window[e[t]+"CancelRequestAnimationFrame"];window.requestAnimationFrame||(window.requestAnimationFrame=function(e,t){var i=(new Date).getTime(),o=Math.max(0,16-(i-n)),r=window.setTimeout((function(){e(i+o)}),o);return n=i+o,r}),window.cancelAnimationFrame||(window.cancelAnimationFrame=function(n){clearTimeout(n)})}()}).call(window)},function(n,e){n.exports=jQuery},function(n,e,t){}]);
|
||||
|
|
@ -1,297 +0,0 @@
|
|||
/*
|
||||
* language_data.js
|
||||
* ~~~~~~~~~~~~~~~~
|
||||
*
|
||||
* This script contains the language-specific data used by searchtools.js,
|
||||
* namely the list of stopwords, stemmer, scorer and splitter.
|
||||
*
|
||||
* :copyright: Copyright 2007-2021 by the Sphinx team, see AUTHORS.
|
||||
* :license: BSD, see LICENSE for details.
|
||||
*
|
||||
*/
|
||||
|
||||
var stopwords = ["a","and","are","as","at","be","but","by","for","if","in","into","is","it","near","no","not","of","on","or","such","that","the","their","then","there","these","they","this","to","was","will","with"];
|
||||
|
||||
|
||||
/* Non-minified version is copied as a separate JS file, is available */
|
||||
|
||||
/**
|
||||
* Porter Stemmer
|
||||
*/
|
||||
var Stemmer = function() {
|
||||
|
||||
var step2list = {
|
||||
ational: 'ate',
|
||||
tional: 'tion',
|
||||
enci: 'ence',
|
||||
anci: 'ance',
|
||||
izer: 'ize',
|
||||
bli: 'ble',
|
||||
alli: 'al',
|
||||
entli: 'ent',
|
||||
eli: 'e',
|
||||
ousli: 'ous',
|
||||
ization: 'ize',
|
||||
ation: 'ate',
|
||||
ator: 'ate',
|
||||
alism: 'al',
|
||||
iveness: 'ive',
|
||||
fulness: 'ful',
|
||||
ousness: 'ous',
|
||||
aliti: 'al',
|
||||
iviti: 'ive',
|
||||
biliti: 'ble',
|
||||
logi: 'log'
|
||||
};
|
||||
|
||||
var step3list = {
|
||||
icate: 'ic',
|
||||
ative: '',
|
||||
alize: 'al',
|
||||
iciti: 'ic',
|
||||
ical: 'ic',
|
||||
ful: '',
|
||||
ness: ''
|
||||
};
|
||||
|
||||
var c = "[^aeiou]"; // consonant
|
||||
var v = "[aeiouy]"; // vowel
|
||||
var C = c + "[^aeiouy]*"; // consonant sequence
|
||||
var V = v + "[aeiou]*"; // vowel sequence
|
||||
|
||||
var mgr0 = "^(" + C + ")?" + V + C; // [C]VC... is m>0
|
||||
var meq1 = "^(" + C + ")?" + V + C + "(" + V + ")?$"; // [C]VC[V] is m=1
|
||||
var mgr1 = "^(" + C + ")?" + V + C + V + C; // [C]VCVC... is m>1
|
||||
var s_v = "^(" + C + ")?" + v; // vowel in stem
|
||||
|
||||
this.stemWord = function (w) {
|
||||
var stem;
|
||||
var suffix;
|
||||
var firstch;
|
||||
var origword = w;
|
||||
|
||||
if (w.length < 3)
|
||||
return w;
|
||||
|
||||
var re;
|
||||
var re2;
|
||||
var re3;
|
||||
var re4;
|
||||
|
||||
firstch = w.substr(0,1);
|
||||
if (firstch == "y")
|
||||
w = firstch.toUpperCase() + w.substr(1);
|
||||
|
||||
// Step 1a
|
||||
re = /^(.+?)(ss|i)es$/;
|
||||
re2 = /^(.+?)([^s])s$/;
|
||||
|
||||
if (re.test(w))
|
||||
w = w.replace(re,"$1$2");
|
||||
else if (re2.test(w))
|
||||
w = w.replace(re2,"$1$2");
|
||||
|
||||
// Step 1b
|
||||
re = /^(.+?)eed$/;
|
||||
re2 = /^(.+?)(ed|ing)$/;
|
||||
if (re.test(w)) {
|
||||
var fp = re.exec(w);
|
||||
re = new RegExp(mgr0);
|
||||
if (re.test(fp[1])) {
|
||||
re = /.$/;
|
||||
w = w.replace(re,"");
|
||||
}
|
||||
}
|
||||
else if (re2.test(w)) {
|
||||
var fp = re2.exec(w);
|
||||
stem = fp[1];
|
||||
re2 = new RegExp(s_v);
|
||||
if (re2.test(stem)) {
|
||||
w = stem;
|
||||
re2 = /(at|bl|iz)$/;
|
||||
re3 = new RegExp("([^aeiouylsz])\\1$");
|
||||
re4 = new RegExp("^" + C + v + "[^aeiouwxy]$");
|
||||
if (re2.test(w))
|
||||
w = w + "e";
|
||||
else if (re3.test(w)) {
|
||||
re = /.$/;
|
||||
w = w.replace(re,"");
|
||||
}
|
||||
else if (re4.test(w))
|
||||
w = w + "e";
|
||||
}
|
||||
}
|
||||
|
||||
// Step 1c
|
||||
re = /^(.+?)y$/;
|
||||
if (re.test(w)) {
|
||||
var fp = re.exec(w);
|
||||
stem = fp[1];
|
||||
re = new RegExp(s_v);
|
||||
if (re.test(stem))
|
||||
w = stem + "i";
|
||||
}
|
||||
|
||||
// Step 2
|
||||
re = /^(.+?)(ational|tional|enci|anci|izer|bli|alli|entli|eli|ousli|ization|ation|ator|alism|iveness|fulness|ousness|aliti|iviti|biliti|logi)$/;
|
||||
if (re.test(w)) {
|
||||
var fp = re.exec(w);
|
||||
stem = fp[1];
|
||||
suffix = fp[2];
|
||||
re = new RegExp(mgr0);
|
||||
if (re.test(stem))
|
||||
w = stem + step2list[suffix];
|
||||
}
|
||||
|
||||
// Step 3
|
||||
re = /^(.+?)(icate|ative|alize|iciti|ical|ful|ness)$/;
|
||||
if (re.test(w)) {
|
||||
var fp = re.exec(w);
|
||||
stem = fp[1];
|
||||
suffix = fp[2];
|
||||
re = new RegExp(mgr0);
|
||||
if (re.test(stem))
|
||||
w = stem + step3list[suffix];
|
||||
}
|
||||
|
||||
// Step 4
|
||||
re = /^(.+?)(al|ance|ence|er|ic|able|ible|ant|ement|ment|ent|ou|ism|ate|iti|ous|ive|ize)$/;
|
||||
re2 = /^(.+?)(s|t)(ion)$/;
|
||||
if (re.test(w)) {
|
||||
var fp = re.exec(w);
|
||||
stem = fp[1];
|
||||
re = new RegExp(mgr1);
|
||||
if (re.test(stem))
|
||||
w = stem;
|
||||
}
|
||||
else if (re2.test(w)) {
|
||||
var fp = re2.exec(w);
|
||||
stem = fp[1] + fp[2];
|
||||
re2 = new RegExp(mgr1);
|
||||
if (re2.test(stem))
|
||||
w = stem;
|
||||
}
|
||||
|
||||
// Step 5
|
||||
re = /^(.+?)e$/;
|
||||
if (re.test(w)) {
|
||||
var fp = re.exec(w);
|
||||
stem = fp[1];
|
||||
re = new RegExp(mgr1);
|
||||
re2 = new RegExp(meq1);
|
||||
re3 = new RegExp("^" + C + v + "[^aeiouwxy]$");
|
||||
if (re.test(stem) || (re2.test(stem) && !(re3.test(stem))))
|
||||
w = stem;
|
||||
}
|
||||
re = /ll$/;
|
||||
re2 = new RegExp(mgr1);
|
||||
if (re.test(w) && re2.test(w)) {
|
||||
re = /.$/;
|
||||
w = w.replace(re,"");
|
||||
}
|
||||
|
||||
// and turn initial Y back to y
|
||||
if (firstch == "y")
|
||||
w = firstch.toLowerCase() + w.substr(1);
|
||||
return w;
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
|
||||
|
||||
var splitChars = (function() {
|
||||
var result = {};
|
||||
var singles = [96, 180, 187, 191, 215, 247, 749, 885, 903, 907, 909, 930, 1014, 1648,
|
||||
1748, 1809, 2416, 2473, 2481, 2526, 2601, 2609, 2612, 2615, 2653, 2702,
|
||||
2706, 2729, 2737, 2740, 2857, 2865, 2868, 2910, 2928, 2948, 2961, 2971,
|
||||
2973, 3085, 3089, 3113, 3124, 3213, 3217, 3241, 3252, 3295, 3341, 3345,
|
||||
3369, 3506, 3516, 3633, 3715, 3721, 3736, 3744, 3748, 3750, 3756, 3761,
|
||||
3781, 3912, 4239, 4347, 4681, 4695, 4697, 4745, 4785, 4799, 4801, 4823,
|
||||
4881, 5760, 5901, 5997, 6313, 7405, 8024, 8026, 8028, 8030, 8117, 8125,
|
||||
8133, 8181, 8468, 8485, 8487, 8489, 8494, 8527, 11311, 11359, 11687, 11695,
|
||||
11703, 11711, 11719, 11727, 11735, 12448, 12539, 43010, 43014, 43019, 43587,
|
||||
43696, 43713, 64286, 64297, 64311, 64317, 64319, 64322, 64325, 65141];
|
||||
var i, j, start, end;
|
||||
for (i = 0; i < singles.length; i++) {
|
||||
result[singles[i]] = true;
|
||||
}
|
||||
var ranges = [[0, 47], [58, 64], [91, 94], [123, 169], [171, 177], [182, 184], [706, 709],
|
||||
[722, 735], [741, 747], [751, 879], [888, 889], [894, 901], [1154, 1161],
|
||||
[1318, 1328], [1367, 1368], [1370, 1376], [1416, 1487], [1515, 1519], [1523, 1568],
|
||||
[1611, 1631], [1642, 1645], [1750, 1764], [1767, 1773], [1789, 1790], [1792, 1807],
|
||||
[1840, 1868], [1958, 1968], [1970, 1983], [2027, 2035], [2038, 2041], [2043, 2047],
|
||||
[2070, 2073], [2075, 2083], [2085, 2087], [2089, 2307], [2362, 2364], [2366, 2383],
|
||||
[2385, 2391], [2402, 2405], [2419, 2424], [2432, 2436], [2445, 2446], [2449, 2450],
|
||||
[2483, 2485], [2490, 2492], [2494, 2509], [2511, 2523], [2530, 2533], [2546, 2547],
|
||||
[2554, 2564], [2571, 2574], [2577, 2578], [2618, 2648], [2655, 2661], [2672, 2673],
|
||||
[2677, 2692], [2746, 2748], [2750, 2767], [2769, 2783], [2786, 2789], [2800, 2820],
|
||||
[2829, 2830], [2833, 2834], [2874, 2876], [2878, 2907], [2914, 2917], [2930, 2946],
|
||||
[2955, 2957], [2966, 2968], [2976, 2978], [2981, 2983], [2987, 2989], [3002, 3023],
|
||||
[3025, 3045], [3059, 3076], [3130, 3132], [3134, 3159], [3162, 3167], [3170, 3173],
|
||||
[3184, 3191], [3199, 3204], [3258, 3260], [3262, 3293], [3298, 3301], [3312, 3332],
|
||||
[3386, 3388], [3390, 3423], [3426, 3429], [3446, 3449], [3456, 3460], [3479, 3481],
|
||||
[3518, 3519], [3527, 3584], [3636, 3647], [3655, 3663], [3674, 3712], [3717, 3718],
|
||||
[3723, 3724], [3726, 3731], [3752, 3753], [3764, 3772], [3774, 3775], [3783, 3791],
|
||||
[3802, 3803], [3806, 3839], [3841, 3871], [3892, 3903], [3949, 3975], [3980, 4095],
|
||||
[4139, 4158], [4170, 4175], [4182, 4185], [4190, 4192], [4194, 4196], [4199, 4205],
|
||||
[4209, 4212], [4226, 4237], [4250, 4255], [4294, 4303], [4349, 4351], [4686, 4687],
|
||||
[4702, 4703], [4750, 4751], [4790, 4791], [4806, 4807], [4886, 4887], [4955, 4968],
|
||||
[4989, 4991], [5008, 5023], [5109, 5120], [5741, 5742], [5787, 5791], [5867, 5869],
|
||||
[5873, 5887], [5906, 5919], [5938, 5951], [5970, 5983], [6001, 6015], [6068, 6102],
|
||||
[6104, 6107], [6109, 6111], [6122, 6127], [6138, 6159], [6170, 6175], [6264, 6271],
|
||||
[6315, 6319], [6390, 6399], [6429, 6469], [6510, 6511], [6517, 6527], [6572, 6592],
|
||||
[6600, 6607], [6619, 6655], [6679, 6687], [6741, 6783], [6794, 6799], [6810, 6822],
|
||||
[6824, 6916], [6964, 6980], [6988, 6991], [7002, 7042], [7073, 7085], [7098, 7167],
|
||||
[7204, 7231], [7242, 7244], [7294, 7400], [7410, 7423], [7616, 7679], [7958, 7959],
|
||||
[7966, 7967], [8006, 8007], [8014, 8015], [8062, 8063], [8127, 8129], [8141, 8143],
|
||||
[8148, 8149], [8156, 8159], [8173, 8177], [8189, 8303], [8306, 8307], [8314, 8318],
|
||||
[8330, 8335], [8341, 8449], [8451, 8454], [8456, 8457], [8470, 8472], [8478, 8483],
|
||||
[8506, 8507], [8512, 8516], [8522, 8525], [8586, 9311], [9372, 9449], [9472, 10101],
|
||||
[10132, 11263], [11493, 11498], [11503, 11516], [11518, 11519], [11558, 11567],
|
||||
[11622, 11630], [11632, 11647], [11671, 11679], [11743, 11822], [11824, 12292],
|
||||
[12296, 12320], [12330, 12336], [12342, 12343], [12349, 12352], [12439, 12444],
|
||||
[12544, 12548], [12590, 12592], [12687, 12689], [12694, 12703], [12728, 12783],
|
||||
[12800, 12831], [12842, 12880], [12896, 12927], [12938, 12976], [12992, 13311],
|
||||
[19894, 19967], [40908, 40959], [42125, 42191], [42238, 42239], [42509, 42511],
|
||||
[42540, 42559], [42592, 42593], [42607, 42622], [42648, 42655], [42736, 42774],
|
||||
[42784, 42785], [42889, 42890], [42893, 43002], [43043, 43055], [43062, 43071],
|
||||
[43124, 43137], [43188, 43215], [43226, 43249], [43256, 43258], [43260, 43263],
|
||||
[43302, 43311], [43335, 43359], [43389, 43395], [43443, 43470], [43482, 43519],
|
||||
[43561, 43583], [43596, 43599], [43610, 43615], [43639, 43641], [43643, 43647],
|
||||
[43698, 43700], [43703, 43704], [43710, 43711], [43715, 43738], [43742, 43967],
|
||||
[44003, 44015], [44026, 44031], [55204, 55215], [55239, 55242], [55292, 55295],
|
||||
[57344, 63743], [64046, 64047], [64110, 64111], [64218, 64255], [64263, 64274],
|
||||
[64280, 64284], [64434, 64466], [64830, 64847], [64912, 64913], [64968, 65007],
|
||||
[65020, 65135], [65277, 65295], [65306, 65312], [65339, 65344], [65371, 65381],
|
||||
[65471, 65473], [65480, 65481], [65488, 65489], [65496, 65497]];
|
||||
for (i = 0; i < ranges.length; i++) {
|
||||
start = ranges[i][0];
|
||||
end = ranges[i][1];
|
||||
for (j = start; j <= end; j++) {
|
||||
result[j] = true;
|
||||
}
|
||||
}
|
||||
return result;
|
||||
})();
|
||||
|
||||
function splitQuery(query) {
|
||||
var result = [];
|
||||
var start = -1;
|
||||
for (var i = 0; i < query.length; i++) {
|
||||
if (splitChars[query.charCodeAt(i)]) {
|
||||
if (start !== -1) {
|
||||
result.push(query.slice(start, i));
|
||||
start = -1;
|
||||
}
|
||||
} else if (start === -1) {
|
||||
start = i;
|
||||
}
|
||||
}
|
||||
if (start !== -1) {
|
||||
result.push(query.slice(start));
|
||||
}
|
||||
return result;
|
||||
}
|
||||
|
||||
|
||||
Binary file not shown.
|
Before Width: | Height: | Size: 90 B |
Binary file not shown.
|
Before Width: | Height: | Size: 90 B |
|
|
@ -1,74 +0,0 @@
|
|||
pre { line-height: 125%; }
|
||||
td.linenos .normal { color: inherit; background-color: transparent; padding-left: 5px; padding-right: 5px; }
|
||||
span.linenos { color: inherit; background-color: transparent; padding-left: 5px; padding-right: 5px; }
|
||||
td.linenos .special { color: #000000; background-color: #ffffc0; padding-left: 5px; padding-right: 5px; }
|
||||
span.linenos.special { color: #000000; background-color: #ffffc0; padding-left: 5px; padding-right: 5px; }
|
||||
.highlight .hll { background-color: #ffffcc }
|
||||
.highlight { background: #f8f8f8; }
|
||||
.highlight .c { color: #408080; font-style: italic } /* Comment */
|
||||
.highlight .err { border: 1px solid #FF0000 } /* Error */
|
||||
.highlight .k { color: #008000; font-weight: bold } /* Keyword */
|
||||
.highlight .o { color: #666666 } /* Operator */
|
||||
.highlight .ch { color: #408080; font-style: italic } /* Comment.Hashbang */
|
||||
.highlight .cm { color: #408080; font-style: italic } /* Comment.Multiline */
|
||||
.highlight .cp { color: #BC7A00 } /* Comment.Preproc */
|
||||
.highlight .cpf { color: #408080; font-style: italic } /* Comment.PreprocFile */
|
||||
.highlight .c1 { color: #408080; font-style: italic } /* Comment.Single */
|
||||
.highlight .cs { color: #408080; font-style: italic } /* Comment.Special */
|
||||
.highlight .gd { color: #A00000 } /* Generic.Deleted */
|
||||
.highlight .ge { font-style: italic } /* Generic.Emph */
|
||||
.highlight .gr { color: #FF0000 } /* Generic.Error */
|
||||
.highlight .gh { color: #000080; font-weight: bold } /* Generic.Heading */
|
||||
.highlight .gi { color: #00A000 } /* Generic.Inserted */
|
||||
.highlight .go { color: #888888 } /* Generic.Output */
|
||||
.highlight .gp { color: #000080; font-weight: bold } /* Generic.Prompt */
|
||||
.highlight .gs { font-weight: bold } /* Generic.Strong */
|
||||
.highlight .gu { color: #800080; font-weight: bold } /* Generic.Subheading */
|
||||
.highlight .gt { color: #0044DD } /* Generic.Traceback */
|
||||
.highlight .kc { color: #008000; font-weight: bold } /* Keyword.Constant */
|
||||
.highlight .kd { color: #008000; font-weight: bold } /* Keyword.Declaration */
|
||||
.highlight .kn { color: #008000; font-weight: bold } /* Keyword.Namespace */
|
||||
.highlight .kp { color: #008000 } /* Keyword.Pseudo */
|
||||
.highlight .kr { color: #008000; font-weight: bold } /* Keyword.Reserved */
|
||||
.highlight .kt { color: #B00040 } /* Keyword.Type */
|
||||
.highlight .m { color: #666666 } /* Literal.Number */
|
||||
.highlight .s { color: #BA2121 } /* Literal.String */
|
||||
.highlight .na { color: #7D9029 } /* Name.Attribute */
|
||||
.highlight .nb { color: #008000 } /* Name.Builtin */
|
||||
.highlight .nc { color: #0000FF; font-weight: bold } /* Name.Class */
|
||||
.highlight .no { color: #880000 } /* Name.Constant */
|
||||
.highlight .nd { color: #AA22FF } /* Name.Decorator */
|
||||
.highlight .ni { color: #999999; font-weight: bold } /* Name.Entity */
|
||||
.highlight .ne { color: #D2413A; font-weight: bold } /* Name.Exception */
|
||||
.highlight .nf { color: #0000FF } /* Name.Function */
|
||||
.highlight .nl { color: #A0A000 } /* Name.Label */
|
||||
.highlight .nn { color: #0000FF; font-weight: bold } /* Name.Namespace */
|
||||
.highlight .nt { color: #008000; font-weight: bold } /* Name.Tag */
|
||||
.highlight .nv { color: #19177C } /* Name.Variable */
|
||||
.highlight .ow { color: #AA22FF; font-weight: bold } /* Operator.Word */
|
||||
.highlight .w { color: #bbbbbb } /* Text.Whitespace */
|
||||
.highlight .mb { color: #666666 } /* Literal.Number.Bin */
|
||||
.highlight .mf { color: #666666 } /* Literal.Number.Float */
|
||||
.highlight .mh { color: #666666 } /* Literal.Number.Hex */
|
||||
.highlight .mi { color: #666666 } /* Literal.Number.Integer */
|
||||
.highlight .mo { color: #666666 } /* Literal.Number.Oct */
|
||||
.highlight .sa { color: #BA2121 } /* Literal.String.Affix */
|
||||
.highlight .sb { color: #BA2121 } /* Literal.String.Backtick */
|
||||
.highlight .sc { color: #BA2121 } /* Literal.String.Char */
|
||||
.highlight .dl { color: #BA2121 } /* Literal.String.Delimiter */
|
||||
.highlight .sd { color: #BA2121; font-style: italic } /* Literal.String.Doc */
|
||||
.highlight .s2 { color: #BA2121 } /* Literal.String.Double */
|
||||
.highlight .se { color: #BB6622; font-weight: bold } /* Literal.String.Escape */
|
||||
.highlight .sh { color: #BA2121 } /* Literal.String.Heredoc */
|
||||
.highlight .si { color: #BB6688; font-weight: bold } /* Literal.String.Interpol */
|
||||
.highlight .sx { color: #008000 } /* Literal.String.Other */
|
||||
.highlight .sr { color: #BB6688 } /* Literal.String.Regex */
|
||||
.highlight .s1 { color: #BA2121 } /* Literal.String.Single */
|
||||
.highlight .ss { color: #19177C } /* Literal.String.Symbol */
|
||||
.highlight .bp { color: #008000 } /* Name.Builtin.Pseudo */
|
||||
.highlight .fm { color: #0000FF } /* Name.Function.Magic */
|
||||
.highlight .vc { color: #19177C } /* Name.Variable.Class */
|
||||
.highlight .vg { color: #19177C } /* Name.Variable.Global */
|
||||
.highlight .vi { color: #19177C } /* Name.Variable.Instance */
|
||||
.highlight .vm { color: #19177C } /* Name.Variable.Magic */
|
||||
.highlight .il { color: #666666 } /* Literal.Number.Integer.Long */
|
||||
|
|
@ -1,522 +0,0 @@
|
|||
/*
|
||||
* searchtools.js
|
||||
* ~~~~~~~~~~~~~~~~
|
||||
*
|
||||
* Sphinx JavaScript utilities for the full-text search.
|
||||
*
|
||||
* :copyright: Copyright 2007-2021 by the Sphinx team, see AUTHORS.
|
||||
* :license: BSD, see LICENSE for details.
|
||||
*
|
||||
*/
|
||||
|
||||
if (!Scorer) {
|
||||
/**
|
||||
* Simple result scoring code.
|
||||
*/
|
||||
var Scorer = {
|
||||
// Implement the following function to further tweak the score for each result
|
||||
// The function takes a result array [filename, title, anchor, descr, score]
|
||||
// and returns the new score.
|
||||
/*
|
||||
score: function(result) {
|
||||
return result[4];
|
||||
},
|
||||
*/
|
||||
|
||||
// query matches the full name of an object
|
||||
objNameMatch: 11,
|
||||
// or matches in the last dotted part of the object name
|
||||
objPartialMatch: 6,
|
||||
// Additive scores depending on the priority of the object
|
||||
objPrio: {0: 15, // used to be importantResults
|
||||
1: 5, // used to be objectResults
|
||||
2: -5}, // used to be unimportantResults
|
||||
// Used when the priority is not in the mapping.
|
||||
objPrioDefault: 0,
|
||||
|
||||
// query found in title
|
||||
title: 15,
|
||||
partialTitle: 7,
|
||||
// query found in terms
|
||||
term: 5,
|
||||
partialTerm: 2
|
||||
};
|
||||
}
|
||||
|
||||
if (!splitQuery) {
|
||||
function splitQuery(query) {
|
||||
return query.split(/\s+/);
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Search Module
|
||||
*/
|
||||
var Search = {
|
||||
|
||||
_index : null,
|
||||
_queued_query : null,
|
||||
_pulse_status : -1,
|
||||
|
||||
htmlToText : function(htmlString) {
|
||||
var virtualDocument = document.implementation.createHTMLDocument('virtual');
|
||||
var htmlElement = $(htmlString, virtualDocument);
|
||||
htmlElement.find('.headerlink').remove();
|
||||
docContent = htmlElement.find('[role=main]')[0];
|
||||
if(docContent === undefined) {
|
||||
console.warn("Content block not found. Sphinx search tries to obtain it " +
|
||||
"via '[role=main]'. Could you check your theme or template.");
|
||||
return "";
|
||||
}
|
||||
return docContent.textContent || docContent.innerText;
|
||||
},
|
||||
|
||||
init : function() {
|
||||
var params = $.getQueryParameters();
|
||||
if (params.q) {
|
||||
var query = params.q[0];
|
||||
$('input[name="q"]')[0].value = query;
|
||||
this.performSearch(query);
|
||||
}
|
||||
},
|
||||
|
||||
loadIndex : function(url) {
|
||||
$.ajax({type: "GET", url: url, data: null,
|
||||
dataType: "script", cache: true,
|
||||
complete: function(jqxhr, textstatus) {
|
||||
if (textstatus != "success") {
|
||||
document.getElementById("searchindexloader").src = url;
|
||||
}
|
||||
}});
|
||||
},
|
||||
|
||||
setIndex : function(index) {
|
||||
var q;
|
||||
this._index = index;
|
||||
if ((q = this._queued_query) !== null) {
|
||||
this._queued_query = null;
|
||||
Search.query(q);
|
||||
}
|
||||
},
|
||||
|
||||
hasIndex : function() {
|
||||
return this._index !== null;
|
||||
},
|
||||
|
||||
deferQuery : function(query) {
|
||||
this._queued_query = query;
|
||||
},
|
||||
|
||||
stopPulse : function() {
|
||||
this._pulse_status = 0;
|
||||
},
|
||||
|
||||
startPulse : function() {
|
||||
if (this._pulse_status >= 0)
|
||||
return;
|
||||
function pulse() {
|
||||
var i;
|
||||
Search._pulse_status = (Search._pulse_status + 1) % 4;
|
||||
var dotString = '';
|
||||
for (i = 0; i < Search._pulse_status; i++)
|
||||
dotString += '.';
|
||||
Search.dots.text(dotString);
|
||||
if (Search._pulse_status > -1)
|
||||
window.setTimeout(pulse, 500);
|
||||
}
|
||||
pulse();
|
||||
},
|
||||
|
||||
/**
|
||||
* perform a search for something (or wait until index is loaded)
|
||||
*/
|
||||
performSearch : function(query) {
|
||||
// create the required interface elements
|
||||
this.out = $('#search-results');
|
||||
this.title = $('<h2>' + _('Searching') + '</h2>').appendTo(this.out);
|
||||
this.dots = $('<span></span>').appendTo(this.title);
|
||||
this.status = $('<p class="search-summary"> </p>').appendTo(this.out);
|
||||
this.output = $('<ul class="search"/>').appendTo(this.out);
|
||||
|
||||
$('#search-progress').text(_('Preparing search...'));
|
||||
this.startPulse();
|
||||
|
||||
// index already loaded, the browser was quick!
|
||||
if (this.hasIndex())
|
||||
this.query(query);
|
||||
else
|
||||
this.deferQuery(query);
|
||||
},
|
||||
|
||||
/**
|
||||
* execute search (requires search index to be loaded)
|
||||
*/
|
||||
query : function(query) {
|
||||
var i;
|
||||
|
||||
// stem the searchterms and add them to the correct list
|
||||
var stemmer = new Stemmer();
|
||||
var searchterms = [];
|
||||
var excluded = [];
|
||||
var hlterms = [];
|
||||
var tmp = splitQuery(query);
|
||||
var objectterms = [];
|
||||
for (i = 0; i < tmp.length; i++) {
|
||||
if (tmp[i] !== "") {
|
||||
objectterms.push(tmp[i].toLowerCase());
|
||||
}
|
||||
|
||||
if ($u.indexOf(stopwords, tmp[i].toLowerCase()) != -1 || tmp[i] === "") {
|
||||
// skip this "word"
|
||||
continue;
|
||||
}
|
||||
// stem the word
|
||||
var word = stemmer.stemWord(tmp[i].toLowerCase());
|
||||
// prevent stemmer from cutting word smaller than two chars
|
||||
if(word.length < 3 && tmp[i].length >= 3) {
|
||||
word = tmp[i];
|
||||
}
|
||||
var toAppend;
|
||||
// select the correct list
|
||||
if (word[0] == '-') {
|
||||
toAppend = excluded;
|
||||
word = word.substr(1);
|
||||
}
|
||||
else {
|
||||
toAppend = searchterms;
|
||||
hlterms.push(tmp[i].toLowerCase());
|
||||
}
|
||||
// only add if not already in the list
|
||||
if (!$u.contains(toAppend, word))
|
||||
toAppend.push(word);
|
||||
}
|
||||
var highlightstring = '?highlight=' + $.urlencode(hlterms.join(" "));
|
||||
|
||||
// console.debug('SEARCH: searching for:');
|
||||
// console.info('required: ', searchterms);
|
||||
// console.info('excluded: ', excluded);
|
||||
|
||||
// prepare search
|
||||
var terms = this._index.terms;
|
||||
var titleterms = this._index.titleterms;
|
||||
|
||||
// array of [filename, title, anchor, descr, score]
|
||||
var results = [];
|
||||
$('#search-progress').empty();
|
||||
|
||||
// lookup as object
|
||||
for (i = 0; i < objectterms.length; i++) {
|
||||
var others = [].concat(objectterms.slice(0, i),
|
||||
objectterms.slice(i+1, objectterms.length));
|
||||
results = results.concat(this.performObjectSearch(objectterms[i], others));
|
||||
}
|
||||
|
||||
// lookup as search terms in fulltext
|
||||
results = results.concat(this.performTermsSearch(searchterms, excluded, terms, titleterms));
|
||||
|
||||
// let the scorer override scores with a custom scoring function
|
||||
if (Scorer.score) {
|
||||
for (i = 0; i < results.length; i++)
|
||||
results[i][4] = Scorer.score(results[i]);
|
||||
}
|
||||
|
||||
// now sort the results by score (in opposite order of appearance, since the
|
||||
// display function below uses pop() to retrieve items) and then
|
||||
// alphabetically
|
||||
results.sort(function(a, b) {
|
||||
var left = a[4];
|
||||
var right = b[4];
|
||||
if (left > right) {
|
||||
return 1;
|
||||
} else if (left < right) {
|
||||
return -1;
|
||||
} else {
|
||||
// same score: sort alphabetically
|
||||
left = a[1].toLowerCase();
|
||||
right = b[1].toLowerCase();
|
||||
return (left > right) ? -1 : ((left < right) ? 1 : 0);
|
||||
}
|
||||
});
|
||||
|
||||
// for debugging
|
||||
//Search.lastresults = results.slice(); // a copy
|
||||
//console.info('search results:', Search.lastresults);
|
||||
|
||||
// print the results
|
||||
var resultCount = results.length;
|
||||
function displayNextItem() {
|
||||
// results left, load the summary and display it
|
||||
if (results.length) {
|
||||
var item = results.pop();
|
||||
var listItem = $('<li></li>');
|
||||
var requestUrl = "";
|
||||
var linkUrl = "";
|
||||
if (DOCUMENTATION_OPTIONS.BUILDER === 'dirhtml') {
|
||||
// dirhtml builder
|
||||
var dirname = item[0] + '/';
|
||||
if (dirname.match(/\/index\/$/)) {
|
||||
dirname = dirname.substring(0, dirname.length-6);
|
||||
} else if (dirname == 'index/') {
|
||||
dirname = '';
|
||||
}
|
||||
requestUrl = DOCUMENTATION_OPTIONS.URL_ROOT + dirname;
|
||||
linkUrl = requestUrl;
|
||||
|
||||
} else {
|
||||
// normal html builders
|
||||
requestUrl = DOCUMENTATION_OPTIONS.URL_ROOT + item[0] + DOCUMENTATION_OPTIONS.FILE_SUFFIX;
|
||||
linkUrl = item[0] + DOCUMENTATION_OPTIONS.LINK_SUFFIX;
|
||||
}
|
||||
listItem.append($('<a/>').attr('href',
|
||||
linkUrl +
|
||||
highlightstring + item[2]).html(item[1]));
|
||||
if (item[3]) {
|
||||
listItem.append($('<span> (' + item[3] + ')</span>'));
|
||||
Search.output.append(listItem);
|
||||
setTimeout(function() {
|
||||
displayNextItem();
|
||||
}, 5);
|
||||
} else if (DOCUMENTATION_OPTIONS.HAS_SOURCE) {
|
||||
$.ajax({url: requestUrl,
|
||||
dataType: "text",
|
||||
complete: function(jqxhr, textstatus) {
|
||||
var data = jqxhr.responseText;
|
||||
if (data !== '' && data !== undefined) {
|
||||
listItem.append(Search.makeSearchSummary(data, searchterms, hlterms));
|
||||
}
|
||||
Search.output.append(listItem);
|
||||
setTimeout(function() {
|
||||
displayNextItem();
|
||||
}, 5);
|
||||
}});
|
||||
} else {
|
||||
// no source available, just display title
|
||||
Search.output.append(listItem);
|
||||
setTimeout(function() {
|
||||
displayNextItem();
|
||||
}, 5);
|
||||
}
|
||||
}
|
||||
// search finished, update title and status message
|
||||
else {
|
||||
Search.stopPulse();
|
||||
Search.title.text(_('Search Results'));
|
||||
if (!resultCount)
|
||||
Search.status.text(_('Your search did not match any documents. Please make sure that all words are spelled correctly and that you\'ve selected enough categories.'));
|
||||
else
|
||||
Search.status.text(_('Search finished, found %s page(s) matching the search query.').replace('%s', resultCount));
|
||||
Search.status.fadeIn(500);
|
||||
}
|
||||
}
|
||||
displayNextItem();
|
||||
},
|
||||
|
||||
/**
|
||||
* search for object names
|
||||
*/
|
||||
performObjectSearch : function(object, otherterms) {
|
||||
var filenames = this._index.filenames;
|
||||
var docnames = this._index.docnames;
|
||||
var objects = this._index.objects;
|
||||
var objnames = this._index.objnames;
|
||||
var titles = this._index.titles;
|
||||
|
||||
var i;
|
||||
var results = [];
|
||||
|
||||
for (var prefix in objects) {
|
||||
for (var name in objects[prefix]) {
|
||||
var fullname = (prefix ? prefix + '.' : '') + name;
|
||||
var fullnameLower = fullname.toLowerCase()
|
||||
if (fullnameLower.indexOf(object) > -1) {
|
||||
var score = 0;
|
||||
var parts = fullnameLower.split('.');
|
||||
// check for different match types: exact matches of full name or
|
||||
// "last name" (i.e. last dotted part)
|
||||
if (fullnameLower == object || parts[parts.length - 1] == object) {
|
||||
score += Scorer.objNameMatch;
|
||||
// matches in last name
|
||||
} else if (parts[parts.length - 1].indexOf(object) > -1) {
|
||||
score += Scorer.objPartialMatch;
|
||||
}
|
||||
var match = objects[prefix][name];
|
||||
var objname = objnames[match[1]][2];
|
||||
var title = titles[match[0]];
|
||||
// If more than one term searched for, we require other words to be
|
||||
// found in the name/title/description
|
||||
if (otherterms.length > 0) {
|
||||
var haystack = (prefix + ' ' + name + ' ' +
|
||||
objname + ' ' + title).toLowerCase();
|
||||
var allfound = true;
|
||||
for (i = 0; i < otherterms.length; i++) {
|
||||
if (haystack.indexOf(otherterms[i]) == -1) {
|
||||
allfound = false;
|
||||
break;
|
||||
}
|
||||
}
|
||||
if (!allfound) {
|
||||
continue;
|
||||
}
|
||||
}
|
||||
var descr = objname + _(', in ') + title;
|
||||
|
||||
var anchor = match[3];
|
||||
if (anchor === '')
|
||||
anchor = fullname;
|
||||
else if (anchor == '-')
|
||||
anchor = objnames[match[1]][1] + '-' + fullname;
|
||||
// add custom score for some objects according to scorer
|
||||
if (Scorer.objPrio.hasOwnProperty(match[2])) {
|
||||
score += Scorer.objPrio[match[2]];
|
||||
} else {
|
||||
score += Scorer.objPrioDefault;
|
||||
}
|
||||
results.push([docnames[match[0]], fullname, '#'+anchor, descr, score, filenames[match[0]]]);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
return results;
|
||||
},
|
||||
|
||||
/**
|
||||
* See https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Regular_Expressions
|
||||
*/
|
||||
escapeRegExp : function(string) {
|
||||
return string.replace(/[.*+\-?^${}()|[\]\\]/g, '\\$&'); // $& means the whole matched string
|
||||
},
|
||||
|
||||
/**
|
||||
* search for full-text terms in the index
|
||||
*/
|
||||
performTermsSearch : function(searchterms, excluded, terms, titleterms) {
|
||||
var docnames = this._index.docnames;
|
||||
var filenames = this._index.filenames;
|
||||
var titles = this._index.titles;
|
||||
|
||||
var i, j, file;
|
||||
var fileMap = {};
|
||||
var scoreMap = {};
|
||||
var results = [];
|
||||
|
||||
// perform the search on the required terms
|
||||
for (i = 0; i < searchterms.length; i++) {
|
||||
var word = searchterms[i];
|
||||
var files = [];
|
||||
var _o = [
|
||||
{files: terms[word], score: Scorer.term},
|
||||
{files: titleterms[word], score: Scorer.title}
|
||||
];
|
||||
// add support for partial matches
|
||||
if (word.length > 2) {
|
||||
var word_regex = this.escapeRegExp(word);
|
||||
for (var w in terms) {
|
||||
if (w.match(word_regex) && !terms[word]) {
|
||||
_o.push({files: terms[w], score: Scorer.partialTerm})
|
||||
}
|
||||
}
|
||||
for (var w in titleterms) {
|
||||
if (w.match(word_regex) && !titleterms[word]) {
|
||||
_o.push({files: titleterms[w], score: Scorer.partialTitle})
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
// no match but word was a required one
|
||||
if ($u.every(_o, function(o){return o.files === undefined;})) {
|
||||
break;
|
||||
}
|
||||
// found search word in contents
|
||||
$u.each(_o, function(o) {
|
||||
var _files = o.files;
|
||||
if (_files === undefined)
|
||||
return
|
||||
|
||||
if (_files.length === undefined)
|
||||
_files = [_files];
|
||||
files = files.concat(_files);
|
||||
|
||||
// set score for the word in each file to Scorer.term
|
||||
for (j = 0; j < _files.length; j++) {
|
||||
file = _files[j];
|
||||
if (!(file in scoreMap))
|
||||
scoreMap[file] = {};
|
||||
scoreMap[file][word] = o.score;
|
||||
}
|
||||
});
|
||||
|
||||
// create the mapping
|
||||
for (j = 0; j < files.length; j++) {
|
||||
file = files[j];
|
||||
if (file in fileMap && fileMap[file].indexOf(word) === -1)
|
||||
fileMap[file].push(word);
|
||||
else
|
||||
fileMap[file] = [word];
|
||||
}
|
||||
}
|
||||
|
||||
// now check if the files don't contain excluded terms
|
||||
for (file in fileMap) {
|
||||
var valid = true;
|
||||
|
||||
// check if all requirements are matched
|
||||
var filteredTermCount = // as search terms with length < 3 are discarded: ignore
|
||||
searchterms.filter(function(term){return term.length > 2}).length
|
||||
if (
|
||||
fileMap[file].length != searchterms.length &&
|
||||
fileMap[file].length != filteredTermCount
|
||||
) continue;
|
||||
|
||||
// ensure that none of the excluded terms is in the search result
|
||||
for (i = 0; i < excluded.length; i++) {
|
||||
if (terms[excluded[i]] == file ||
|
||||
titleterms[excluded[i]] == file ||
|
||||
$u.contains(terms[excluded[i]] || [], file) ||
|
||||
$u.contains(titleterms[excluded[i]] || [], file)) {
|
||||
valid = false;
|
||||
break;
|
||||
}
|
||||
}
|
||||
|
||||
// if we have still a valid result we can add it to the result list
|
||||
if (valid) {
|
||||
// select one (max) score for the file.
|
||||
// for better ranking, we should calculate ranking by using words statistics like basic tf-idf...
|
||||
var score = $u.max($u.map(fileMap[file], function(w){return scoreMap[file][w]}));
|
||||
results.push([docnames[file], titles[file], '', null, score, filenames[file]]);
|
||||
}
|
||||
}
|
||||
return results;
|
||||
},
|
||||
|
||||
/**
|
||||
* helper function to return a node containing the
|
||||
* search summary for a given text. keywords is a list
|
||||
* of stemmed words, hlwords is the list of normal, unstemmed
|
||||
* words. the first one is used to find the occurrence, the
|
||||
* latter for highlighting it.
|
||||
*/
|
||||
makeSearchSummary : function(htmlText, keywords, hlwords) {
|
||||
var text = Search.htmlToText(htmlText);
|
||||
var textLower = text.toLowerCase();
|
||||
var start = 0;
|
||||
$.each(keywords, function() {
|
||||
var i = textLower.indexOf(this.toLowerCase());
|
||||
if (i > -1)
|
||||
start = i;
|
||||
});
|
||||
start = Math.max(start - 120, 0);
|
||||
var excerpt = ((start > 0) ? '...' : '') +
|
||||
$.trim(text.substr(start, 240)) +
|
||||
((start + 240 - text.length) ? '...' : '');
|
||||
var rv = $('<div class="context"></div>').text(excerpt);
|
||||
$.each(hlwords, function() {
|
||||
rv = rv.highlightText(this, 'highlighted');
|
||||
});
|
||||
return rv;
|
||||
}
|
||||
};
|
||||
|
||||
$(document).ready(function() {
|
||||
Search.init();
|
||||
});
|
||||
|
|
@ -1,63 +0,0 @@
|
|||
Documentation.addTranslations({
|
||||
"locale": "zh_Hans_CN",
|
||||
"messages": {
|
||||
"%(filename)s — %(docstitle)s": "%(filename)s — %(docstitle)s",
|
||||
"© <a href=\"%(path)s\">Copyright</a> %(copyright)s.": "© <a href=\"%(path)s\"> \u7248\u6743\u6240\u6709</a> %(copyright)s.",
|
||||
"© Copyright %(copyright)s.": "© \u7248\u6743\u6240\u6709 %(copyright)s.",
|
||||
", in ": "\uff0c \u5728 ",
|
||||
"About these documents": "\u5173\u4e8e\u8fd9\u4e9b\u6587\u6863",
|
||||
"Automatically generated list of changes in version %(version)s": "\u81ea\u52a8\u751f\u6210\u7684 %(version)s \u7248\u672c\u4e2d\u7684\u66f4\u6539\u5217\u8868",
|
||||
"C API changes": "C API \u66f4\u6539",
|
||||
"Changes in Version %(version)s — %(docstitle)s": "\u66f4\u6539\u53d1\u751f\u5728\u7248\u672c %(version)s— %(docstitle)s",
|
||||
"Collapse sidebar": "\u6298\u53e0\u8fb9\u680f",
|
||||
"Complete Table of Contents": "\u5b8c\u6574\u7684\u5185\u5bb9\u8868",
|
||||
"Contents": "\u76ee\u5f55",
|
||||
"Copyright": "\u7248\u6743\u6240\u6709",
|
||||
"Created using <a href=\"http://sphinx-doc.org/\">Sphinx</a> %(sphinx_version)s.": "\u7531 <a href=\"http://sphinx-doc.org/\">Sphinx</a> %(sphinx_version)s \u521b\u5efa\u3002",
|
||||
"Expand sidebar": "\u5c55\u5f00\u8fb9\u680f",
|
||||
"Full index on one page": "\u4e00\u9875\u7684\u5168\u90e8\u7d22\u5f15",
|
||||
"General Index": "\u603b\u76ee\u5f55",
|
||||
"Global Module Index": "\u5168\u5c40\u6a21\u5757\u7d22\u5f15",
|
||||
"Go": "\u8f6c\u5411",
|
||||
"Hide Search Matches": "\u9690\u85cf\u641c\u7d22\u7ed3\u679c",
|
||||
"Index": "\u7d22\u5f15",
|
||||
"Index – %(key)s": "\u7d22\u5f15 – %(key)s",
|
||||
"Index pages by letter": "\u6309\u7167\u5b57\u6bcd\u7684\u7d22\u5f15\u9875",
|
||||
"Indices and tables:": "\u7d22\u5f15\u548c\u8868\u683c\uff1a",
|
||||
"Last updated on %(last_updated)s.": "\u6700\u540e\u66f4\u65b0\u4e8e %(last_updated)s.",
|
||||
"Library changes": "\u5e93\u66f4\u6539",
|
||||
"Navigation": "\u5bfc\u822a",
|
||||
"Next topic": "\u4e0b\u4e00\u4e2a\u4e3b\u9898",
|
||||
"Other changes": "\u5176\u4ed6\u66f4\u6539",
|
||||
"Overview": "\u6982\u8ff0",
|
||||
"Permalink to this definition": "\u6c38\u4e45\u94fe\u63a5\u81f3\u76ee\u6807",
|
||||
"Permalink to this headline": "\u6c38\u4e45\u94fe\u63a5\u81f3\u6807\u9898",
|
||||
"Please activate JavaScript to enable the search\n functionality.": "\u8bf7\u6fc0\u6d3b JavaScript \u4ee5\u5f00\u542f\u641c\u7d22\u529f\u80fd\u3002",
|
||||
"Preparing search...": "\u51c6\u5907\u641c\u7d22\u2026\u2026",
|
||||
"Previous topic": "\u4e0a\u4e00\u4e2a\u4e3b\u9898",
|
||||
"Quick search": "\u5feb\u901f\u641c\u7d22",
|
||||
"Search": "\u641c\u7d22",
|
||||
"Search Page": "\u641c\u7d22\u9875\u9762",
|
||||
"Search Results": "\u641c\u7d22\u7ed3\u679c",
|
||||
"Search finished, found %s page(s) matching the search query.": "\u641c\u7d22\u5b8c\u6210\uff0c\u6709 %s \u4e2a\u9875\u9762\u5339\u914d\u3002",
|
||||
"Search within %(docstitle)s": "\u5728 %(docstitle)s \u4e2d\u641c\u7d22",
|
||||
"Searching": "\u641c\u7d22\u4e2d",
|
||||
"Searching for multiple words only shows matches that contain\n all words.": "",
|
||||
"Show Source": "\u663e\u793a\u6e90\u4ee3\u7801",
|
||||
"Table of Contents": "\u76ee\u5f55",
|
||||
"This Page": "\u672c\u9875",
|
||||
"Welcome! This is": "\u6b22\u8fce\uff01\u8fd9\u662f",
|
||||
"Your search did not match any documents. Please make sure that all words are spelled correctly and that you've selected enough categories.": "\u6ca1\u6709\u4efb\u4f55\u6587\u6863\u5339\u914d\u60a8\u7684\u641c\u7d22\u3002\u8bf7\u786e\u4fdd\u4f60\u8f93\u5165\u7684\u8bcd\u62fc\u5199\u6b63\u786e\u5e76\u9009\u62e9\u4e86\u5408\u9002\u7684\u5206\u7c7b\u3002",
|
||||
"all functions, classes, terms": "\u6240\u7684\u51fd\u6570\uff0c\u7c7b\uff0c\u672f\u8bed",
|
||||
"can be huge": "\u53ef\u80fd\u4f1a\u5f88\u591a",
|
||||
"last updated": "\u6700\u540e\u66f4\u65b0\u4e8e",
|
||||
"lists all sections and subsections": "\u5217\u51fa\u6240\u6709\u7684\u7ae0\u8282\u548c\u90e8\u5206",
|
||||
"next chapter": "\u4e0b\u4e00\u7ae0",
|
||||
"previous chapter": "\u4e0a\u4e00\u7ae0",
|
||||
"quick access to all modules": "\u5feb\u901f\u67e5\u770b\u6240\u6709\u7684\u6a21\u5757",
|
||||
"search": "\u641c\u7d22",
|
||||
"search this documentation": "\u641c\u7d22\u6587\u6863",
|
||||
"the documentation for": "\u8fd9\u4efd\u6587\u6863\u662f"
|
||||
},
|
||||
"plural_expr": "0"
|
||||
});
|
||||
File diff suppressed because it is too large
Load diff
File diff suppressed because one or more lines are too long
File diff suppressed because it is too large
Load diff
|
|
@ -1,275 +0,0 @@
|
|||
|
||||
|
||||
<!DOCTYPE html>
|
||||
<html class="writer-html5" lang="zh-CN" >
|
||||
<head>
|
||||
<meta charset="utf-8" />
|
||||
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
||||
|
||||
<title>1. 流水灯示例 — BL_MCU_SDK 开发指南 0.1 文档</title>
|
||||
|
||||
|
||||
|
||||
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
|
||||
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<!--[if lt IE 9]>
|
||||
<script src="_static/js/html5shiv.min.js"></script>
|
||||
<![endif]-->
|
||||
|
||||
|
||||
<script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
|
||||
<script src="_static/jquery.js"></script>
|
||||
<script src="_static/underscore.js"></script>
|
||||
<script src="_static/doctools.js"></script>
|
||||
<script src="_static/translations.js"></script>
|
||||
|
||||
<script type="text/javascript" src="_static/js/theme.js"></script>
|
||||
|
||||
|
||||
<link rel="index" title="索引" href="genindex.html" />
|
||||
<link rel="search" title="搜索" href="search.html" />
|
||||
<link rel="next" title="2. 呼吸灯示例" href="breath_pwm_demo_introduce.html" />
|
||||
<link rel="prev" title="1. API 分层模型" href="api_guide.html" />
|
||||
</head>
|
||||
|
||||
<body class="wy-body-for-nav">
|
||||
|
||||
|
||||
<div class="wy-grid-for-nav">
|
||||
|
||||
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
|
||||
<div class="wy-side-scroll">
|
||||
<div class="wy-side-nav-search" >
|
||||
|
||||
|
||||
|
||||
<a href="index.html" class="icon icon-home"> BL_MCU_SDK 开发指南
|
||||
|
||||
|
||||
|
||||
</a>
|
||||
|
||||
|
||||
|
||||
|
||||
<div class="version">
|
||||
0.1
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
<div role="search">
|
||||
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
|
||||
<input type="text" name="q" placeholder="Search docs" />
|
||||
<input type="hidden" name="check_keywords" value="yes" />
|
||||
<input type="hidden" name="area" value="default" />
|
||||
</form>
|
||||
</div>
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<p class="caption"><span class="caption-text">快速开发指南</span></p>
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="get_started.html">1. 开发前的准备</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="Windows_quick_start_cdk.html">2. Windows 下使用 CDK (类 MDK Keil)开发指南</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="Windows_quick_start_eclipse.html">3. Windows 下使用 Eclipse 开发指南</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="Linux_quick_start_ubuntu.html">4. Linux 环境开发指南</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="connecting_hardware.html">5. 硬件连接</a></li>
|
||||
</ul>
|
||||
<p class="caption"><span class="caption-text">API 手册</span></p>
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="api_guide.html">1. API 分层模型</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="api_guide.html#id5">2. 时钟树</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="api_guide.html#gpio">3. GPIO 设备</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="api_guide.html#uart">4. UART 设备</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="api_guide.html#pwm">5. PWM设备</a></li>
|
||||
</ul>
|
||||
<p class="caption"><span class="caption-text">示例代码</span></p>
|
||||
<ul class="current">
|
||||
<li class="toctree-l1 current"><a class="current reference internal" href="#">1. 流水灯示例</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="#id2">1.1. 硬件连接</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="#id3">1.2. 软件实现</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="#id4">1.3. 最终效果</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="breath_pwm_demo_introduce.html">2. 呼吸灯示例</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="uart_loopback_demo_introduce.html">3. 串口自收发示例</a></li>
|
||||
</ul>
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
</div>
|
||||
</nav>
|
||||
|
||||
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
|
||||
|
||||
|
||||
<nav class="wy-nav-top" aria-label="top navigation">
|
||||
|
||||
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
|
||||
<a href="index.html">BL_MCU_SDK 开发指南</a>
|
||||
|
||||
</nav>
|
||||
|
||||
|
||||
<div class="wy-nav-content">
|
||||
|
||||
<div class="rst-content">
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<div role="navigation" aria-label="breadcrumbs navigation">
|
||||
|
||||
<ul class="wy-breadcrumbs">
|
||||
|
||||
<li><a href="index.html" class="icon icon-home"></a> »</li>
|
||||
|
||||
<li><span class="section-number">1. </span>流水灯示例</li>
|
||||
|
||||
|
||||
<li class="wy-breadcrumbs-aside">
|
||||
|
||||
|
||||
<a href="_sources/blink_demo_introduce.rst.txt" rel="nofollow"> View page source</a>
|
||||
|
||||
|
||||
</li>
|
||||
|
||||
</ul>
|
||||
|
||||
|
||||
<hr/>
|
||||
</div>
|
||||
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
|
||||
<div itemprop="articleBody">
|
||||
|
||||
<div class="section" id="id1">
|
||||
<h1><span class="section-number">1. </span>流水灯示例<a class="headerlink" href="#id1" title="永久链接至标题">¶</a></h1>
|
||||
<div class="section" id="id2">
|
||||
<h2><span class="section-number">1.1. </span>硬件连接<a class="headerlink" href="#id2" title="永久链接至标题">¶</a></h2>
|
||||
<div class="figure align-default" id="id5">
|
||||
<img alt="" src="_images/blink_breath_sch.png" />
|
||||
<p class="caption"><span class="caption-text"><strong>BL706_IOT板支持上述电路</strong></span><a class="headerlink" href="#id5" title="永久链接至图片">¶</a></p>
|
||||
</div>
|
||||
<ul class="simple">
|
||||
<li><p>硬件连接如上图所示 <code class="docutils literal notranslate"><span class="pre">GPIO29</span></code> <code class="docutils literal notranslate"><span class="pre">GPIO30</span></code> <code class="docutils literal notranslate"><span class="pre">GPIO31</span></code> <code class="docutils literal notranslate"><span class="pre">GPIO22</span></code> 分别控制四路 LED 灯</p></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="section" id="id3">
|
||||
<h2><span class="section-number">1.2. </span>软件实现<a class="headerlink" href="#id3" title="永久链接至标题">¶</a></h2>
|
||||
<ul class="simple">
|
||||
<li><p>软件代码见 <code class="docutils literal notranslate"><span class="pre">examples/gpio/gpio_blink</span></code></p></li>
|
||||
</ul>
|
||||
<div class="highlight-C notranslate"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span class="normal">1</span>
|
||||
<span class="normal">2</span>
|
||||
<span class="normal">3</span>
|
||||
<span class="normal">4</span></pre></div></td><td class="code"><div class="highlight"><pre><span></span><span class="n">gpio_set_mode</span><span class="p">(</span><span class="n">GPIO_PIN_22</span><span class="p">,</span> <span class="n">GPIO_OUTPUT_PP_MODE</span><span class="p">);</span>
|
||||
<span class="n">gpio_set_mode</span><span class="p">(</span><span class="n">GPIO_PIN_29</span><span class="p">,</span> <span class="n">GPIO_OUTPUT_PP_MODE</span><span class="p">);</span>
|
||||
<span class="n">gpio_set_mode</span><span class="p">(</span><span class="n">GPIO_PIN_30</span><span class="p">,</span> <span class="n">GPIO_OUTPUT_PP_MODE</span><span class="p">);</span>
|
||||
<span class="n">gpio_set_mode</span><span class="p">(</span><span class="n">GPIO_PIN_31</span><span class="p">,</span> <span class="n">GPIO_OUTPUT_PP_MODE</span><span class="p">);</span>
|
||||
</pre></div>
|
||||
</td></tr></table></div>
|
||||
<ul class="simple">
|
||||
<li><p>使用上述代码将 <code class="docutils literal notranslate"><span class="pre">GPIO22</span></code> <code class="docutils literal notranslate"><span class="pre">GPIO29</span></code> <code class="docutils literal notranslate"><span class="pre">GPIO30</span></code> <code class="docutils literal notranslate"><span class="pre">GPIO31</span></code> 配置为输出模式。</p></li>
|
||||
</ul>
|
||||
<div class="highlight-C notranslate"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span class="normal">1</span></pre></div></td><td class="code"><div class="highlight"><pre><span></span><span class="n">gpio_write</span><span class="p">(</span><span class="n">GPIO_PIN_22</span><span class="p">,</span> <span class="mi">0</span><span class="p">);</span>
|
||||
</pre></div>
|
||||
</td></tr></table></div>
|
||||
<ul class="simple">
|
||||
<li><p>使用上述代码修改输出的电平值。</p></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="section" id="id4">
|
||||
<h2><span class="section-number">1.3. </span>最终效果<a class="headerlink" href="#id4" title="永久链接至标题">¶</a></h2>
|
||||
<p>见视频展示</p>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
</div>
|
||||
<footer>
|
||||
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
|
||||
<a href="breath_pwm_demo_introduce.html" class="btn btn-neutral float-right" title="2. 呼吸灯示例" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
|
||||
<a href="api_guide.html" class="btn btn-neutral float-left" title="1. API 分层模型" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
|
||||
</div>
|
||||
|
||||
<hr/>
|
||||
|
||||
<div role="contentinfo">
|
||||
<p>
|
||||
© 版权所有 2021, BouffaloLab Co., Ltd.
|
||||
|
||||
</p>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
|
||||
|
||||
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
|
||||
|
||||
provided by <a href="https://readthedocs.org">Read the Docs</a>.
|
||||
|
||||
</footer>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
</section>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<script type="text/javascript">
|
||||
jQuery(function () {
|
||||
SphinxRtdTheme.Navigation.enable(true);
|
||||
});
|
||||
</script>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</body>
|
||||
</html>
|
||||
|
|
@ -1,292 +0,0 @@
|
|||
|
||||
|
||||
<!DOCTYPE html>
|
||||
<html class="writer-html5" lang="zh-CN" >
|
||||
<head>
|
||||
<meta charset="utf-8" />
|
||||
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
||||
|
||||
<title>2. 呼吸灯示例 — BL_MCU_SDK 开发指南 0.1 文档</title>
|
||||
|
||||
|
||||
|
||||
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
|
||||
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<!--[if lt IE 9]>
|
||||
<script src="_static/js/html5shiv.min.js"></script>
|
||||
<![endif]-->
|
||||
|
||||
|
||||
<script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
|
||||
<script src="_static/jquery.js"></script>
|
||||
<script src="_static/underscore.js"></script>
|
||||
<script src="_static/doctools.js"></script>
|
||||
<script src="_static/translations.js"></script>
|
||||
|
||||
<script type="text/javascript" src="_static/js/theme.js"></script>
|
||||
|
||||
|
||||
<link rel="index" title="索引" href="genindex.html" />
|
||||
<link rel="search" title="搜索" href="search.html" />
|
||||
<link rel="next" title="3. 串口自收发示例" href="uart_loopback_demo_introduce.html" />
|
||||
<link rel="prev" title="1. 流水灯示例" href="blink_demo_introduce.html" />
|
||||
</head>
|
||||
|
||||
<body class="wy-body-for-nav">
|
||||
|
||||
|
||||
<div class="wy-grid-for-nav">
|
||||
|
||||
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
|
||||
<div class="wy-side-scroll">
|
||||
<div class="wy-side-nav-search" >
|
||||
|
||||
|
||||
|
||||
<a href="index.html" class="icon icon-home"> BL_MCU_SDK 开发指南
|
||||
|
||||
|
||||
|
||||
</a>
|
||||
|
||||
|
||||
|
||||
|
||||
<div class="version">
|
||||
0.1
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
<div role="search">
|
||||
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
|
||||
<input type="text" name="q" placeholder="Search docs" />
|
||||
<input type="hidden" name="check_keywords" value="yes" />
|
||||
<input type="hidden" name="area" value="default" />
|
||||
</form>
|
||||
</div>
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<p class="caption"><span class="caption-text">快速开发指南</span></p>
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="get_started.html">1. 开发前的准备</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="Windows_quick_start_cdk.html">2. Windows 下使用 CDK (类 MDK Keil)开发指南</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="Windows_quick_start_eclipse.html">3. Windows 下使用 Eclipse 开发指南</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="Linux_quick_start_ubuntu.html">4. Linux 环境开发指南</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="connecting_hardware.html">5. 硬件连接</a></li>
|
||||
</ul>
|
||||
<p class="caption"><span class="caption-text">API 手册</span></p>
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="api_guide.html">1. API 分层模型</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="api_guide.html#id5">2. 时钟树</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="api_guide.html#gpio">3. GPIO 设备</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="api_guide.html#uart">4. UART 设备</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="api_guide.html#pwm">5. PWM设备</a></li>
|
||||
</ul>
|
||||
<p class="caption"><span class="caption-text">示例代码</span></p>
|
||||
<ul class="current">
|
||||
<li class="toctree-l1"><a class="reference internal" href="blink_demo_introduce.html">1. 流水灯示例</a></li>
|
||||
<li class="toctree-l1 current"><a class="current reference internal" href="#">2. 呼吸灯示例</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="#id2">2.1. 硬件连接</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="#id3">2.2. 软件实现</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="#id4">2.3. 最终效果</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="uart_loopback_demo_introduce.html">3. 串口自收发示例</a></li>
|
||||
</ul>
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
</div>
|
||||
</nav>
|
||||
|
||||
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
|
||||
|
||||
|
||||
<nav class="wy-nav-top" aria-label="top navigation">
|
||||
|
||||
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
|
||||
<a href="index.html">BL_MCU_SDK 开发指南</a>
|
||||
|
||||
</nav>
|
||||
|
||||
|
||||
<div class="wy-nav-content">
|
||||
|
||||
<div class="rst-content">
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<div role="navigation" aria-label="breadcrumbs navigation">
|
||||
|
||||
<ul class="wy-breadcrumbs">
|
||||
|
||||
<li><a href="index.html" class="icon icon-home"></a> »</li>
|
||||
|
||||
<li><span class="section-number">2. </span>呼吸灯示例</li>
|
||||
|
||||
|
||||
<li class="wy-breadcrumbs-aside">
|
||||
|
||||
|
||||
<a href="_sources/breath_pwm_demo_introduce.rst.txt" rel="nofollow"> View page source</a>
|
||||
|
||||
|
||||
</li>
|
||||
|
||||
</ul>
|
||||
|
||||
|
||||
<hr/>
|
||||
</div>
|
||||
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
|
||||
<div itemprop="articleBody">
|
||||
|
||||
<div class="section" id="id1">
|
||||
<h1><span class="section-number">2. </span>呼吸灯示例<a class="headerlink" href="#id1" title="永久链接至标题">¶</a></h1>
|
||||
<div class="section" id="id2">
|
||||
<h2><span class="section-number">2.1. </span>硬件连接<a class="headerlink" href="#id2" title="永久链接至标题">¶</a></h2>
|
||||
<div class="figure align-default" id="id5">
|
||||
<img alt="" src="_images/blink_breath_sch.png" />
|
||||
<p class="caption"><span class="caption-text"><strong>BL706_IOT板支持上述电路</strong></span><a class="headerlink" href="#id5" title="永久链接至图片">¶</a></p>
|
||||
</div>
|
||||
<ul class="simple">
|
||||
<li><p>硬件连接如上图所示 <code class="docutils literal notranslate"><span class="pre">GPIO29</span></code> <code class="docutils literal notranslate"><span class="pre">GPIO30</span></code> <code class="docutils literal notranslate"><span class="pre">GPIO31</span></code> <code class="docutils literal notranslate"><span class="pre">GPIO22</span></code> 分别控制四路 LED 灯</p></li>
|
||||
<li><p>呼吸灯会单独使用 <code class="docutils literal notranslate"><span class="pre">GPIO22</span></code> 来演示效果</p></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="section" id="id3">
|
||||
<h2><span class="section-number">2.2. </span>软件实现<a class="headerlink" href="#id3" title="永久链接至标题">¶</a></h2>
|
||||
<ul class="simple">
|
||||
<li><p>软件代码见 <code class="docutils literal notranslate"><span class="pre">examples/pwm/pwm_breath_led</span></code></p></li>
|
||||
<li><p><code class="docutils literal notranslate"><span class="pre">PWM</span></code> 的输出引脚由板级描述文件 <code class="docutils literal notranslate"><span class="pre">bsp/board/bl706_iot/pinmux_config.h</span></code> 来配置</p></li>
|
||||
</ul>
|
||||
<div class="highlight-C notranslate"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span class="normal">1</span></pre></div></td><td class="code"><div class="highlight"><pre><span></span><span class="cp">#define CONFIG_GPIO22_FUNC GPIO_FUN_UNUSED</span>
|
||||
</pre></div>
|
||||
</td></tr></table></div>
|
||||
<ul class="simple">
|
||||
<li><p>可以看到，我们将 <code class="docutils literal notranslate"><span class="pre">GPIO22</span></code> 的功能选择为 <code class="docutils literal notranslate"><span class="pre">PWM</span></code> 输出，不同的电路板会存在不同的引脚配置。</p></li>
|
||||
<li><p>我们会使用向导来配置不同应用场景下的引脚配置，用户也可以手动修改。</p></li>
|
||||
</ul>
|
||||
<div class="highlight-C notranslate"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span class="normal">1</span>
|
||||
<span class="normal">2</span>
|
||||
<span class="normal">3</span>
|
||||
<span class="normal">4</span>
|
||||
<span class="normal">5</span>
|
||||
<span class="normal">6</span>
|
||||
<span class="normal">7</span>
|
||||
<span class="normal">8</span></pre></div></td><td class="code"><div class="highlight"><pre><span></span><span class="n">pwm_register</span><span class="p">(</span><span class="n">PWM0_INDEX</span><span class="p">,</span> <span class="s">"led_breath"</span><span class="p">,</span> <span class="n">DEVICE_OFLAG_RDWR</span><span class="p">);</span>
|
||||
|
||||
<span class="k">struct</span> <span class="nc">device</span> <span class="o">*</span><span class="n">led_breath</span> <span class="o">=</span> <span class="n">device_find</span><span class="p">(</span><span class="s">"led_breath"</span><span class="p">);</span>
|
||||
|
||||
<span class="k">if</span> <span class="p">(</span><span class="n">led_breath</span><span class="p">)</span>
|
||||
<span class="p">{</span>
|
||||
<span class="n">device_open</span><span class="p">(</span><span class="n">led_breath</span><span class="p">,</span> <span class="mi">0</span><span class="p">);</span>
|
||||
<span class="p">}</span>
|
||||
</pre></div>
|
||||
</td></tr></table></div>
|
||||
<ul class="simple">
|
||||
<li><p>上述代码展现了 <code class="docutils literal notranslate"><span class="pre">bl_mcu_sdk</span></code> 框架最一般的设备初始化流程，首先调用 <code class="docutils literal notranslate"><span class="pre">pwm_register</span></code> 函数注册 <code class="docutils literal notranslate"><span class="pre">pwm</span></code> 设备</p></li>
|
||||
<li><p>然后通过 <code class="docutils literal notranslate"><span class="pre">find</span></code> 函数找到设备对应的句柄，保存于 <code class="docutils literal notranslate"><span class="pre">led_breath</span></code> 对象中</p></li>
|
||||
<li><p>使用 <code class="docutils literal notranslate"><span class="pre">device_open</span></code> 来打开 <code class="docutils literal notranslate"><span class="pre">led_breath</span></code> 设备。</p></li>
|
||||
</ul>
|
||||
<div class="highlight-C notranslate"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span class="normal">1</span></pre></div></td><td class="code"><div class="highlight"><pre><span></span><span class="n">device_control</span><span class="p">(</span><span class="n">led_breath</span><span class="p">,</span> <span class="n">DEVICE_CTRL_CONFIG</span><span class="p">,</span> <span class="o">&</span><span class="n">pwm_cfg</span><span class="p">);</span>
|
||||
</pre></div>
|
||||
</td></tr></table></div>
|
||||
<p>使用 <code class="docutils literal notranslate"><span class="pre">device_contorl</span></code> 函数，配合 <code class="docutils literal notranslate"><span class="pre">DEVICE_CTRL_CONFIG</span></code> 指令，输入需要配置的频率和占空比，即可配置 <code class="docutils literal notranslate"><span class="pre">PWM</span></code> 的输出波形。</p>
|
||||
</div>
|
||||
<div class="section" id="id4">
|
||||
<h2><span class="section-number">2.3. </span>最终效果<a class="headerlink" href="#id4" title="永久链接至标题">¶</a></h2>
|
||||
<p>见视频展示</p>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
</div>
|
||||
<footer>
|
||||
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
|
||||
<a href="uart_loopback_demo_introduce.html" class="btn btn-neutral float-right" title="3. 串口自收发示例" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
|
||||
<a href="blink_demo_introduce.html" class="btn btn-neutral float-left" title="1. 流水灯示例" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
|
||||
</div>
|
||||
|
||||
<hr/>
|
||||
|
||||
<div role="contentinfo">
|
||||
<p>
|
||||
© 版权所有 2021, BouffaloLab Co., Ltd.
|
||||
|
||||
</p>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
|
||||
|
||||
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
|
||||
|
||||
provided by <a href="https://readthedocs.org">Read the Docs</a>.
|
||||
|
||||
</footer>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
</section>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<script type="text/javascript">
|
||||
jQuery(function () {
|
||||
SphinxRtdTheme.Navigation.enable(true);
|
||||
});
|
||||
</script>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</body>
|
||||
</html>
|
||||
|
|
@ -1,333 +0,0 @@
|
|||
|
||||
|
||||
<!DOCTYPE html>
|
||||
<html class="writer-html5" lang="zh-CN" >
|
||||
<head>
|
||||
<meta charset="utf-8" />
|
||||
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
||||
|
||||
<title>5. 硬件连接 — BL_MCU_SDK 开发指南 0.1 文档</title>
|
||||
|
||||
|
||||
|
||||
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
|
||||
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<!--[if lt IE 9]>
|
||||
<script src="_static/js/html5shiv.min.js"></script>
|
||||
<![endif]-->
|
||||
|
||||
|
||||
<script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
|
||||
<script src="_static/jquery.js"></script>
|
||||
<script src="_static/underscore.js"></script>
|
||||
<script src="_static/doctools.js"></script>
|
||||
<script src="_static/translations.js"></script>
|
||||
|
||||
<script type="text/javascript" src="_static/js/theme.js"></script>
|
||||
|
||||
|
||||
<link rel="index" title="索引" href="genindex.html" />
|
||||
<link rel="search" title="搜索" href="search.html" />
|
||||
<link rel="next" title="1. API 分层模型" href="api_guide.html" />
|
||||
<link rel="prev" title="4. Linux 环境开发指南" href="Linux_quick_start_ubuntu.html" />
|
||||
</head>
|
||||
|
||||
<body class="wy-body-for-nav">
|
||||
|
||||
|
||||
<div class="wy-grid-for-nav">
|
||||
|
||||
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
|
||||
<div class="wy-side-scroll">
|
||||
<div class="wy-side-nav-search" >
|
||||
|
||||
|
||||
|
||||
<a href="index.html" class="icon icon-home"> BL_MCU_SDK 开发指南
|
||||
|
||||
|
||||
|
||||
</a>
|
||||
|
||||
|
||||
|
||||
|
||||
<div class="version">
|
||||
0.1
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
<div role="search">
|
||||
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
|
||||
<input type="text" name="q" placeholder="Search docs" />
|
||||
<input type="hidden" name="check_keywords" value="yes" />
|
||||
<input type="hidden" name="area" value="default" />
|
||||
</form>
|
||||
</div>
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<p class="caption"><span class="caption-text">快速开发指南</span></p>
|
||||
<ul class="current">
|
||||
<li class="toctree-l1"><a class="reference internal" href="get_started.html">1. 开发前的准备</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="Windows_quick_start_cdk.html">2. Windows 下使用 CDK (类 MDK Keil)开发指南</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="Windows_quick_start_eclipse.html">3. Windows 下使用 Eclipse 开发指南</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="Linux_quick_start_ubuntu.html">4. Linux 环境开发指南</a></li>
|
||||
<li class="toctree-l1 current"><a class="current reference internal" href="#">5. 硬件连接</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="#bl706-iot">5.1. BL706_IOT 开发板</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#ck-link">5.1.1. 使用 CK-Link 烧写、调试连接方法</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#j-link">5.1.2. 使用 J-Link 烧写、调试连接方法</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#id2">5.1.3. 使用串口烧写程序连接方法</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="#bl702-avb">5.2. BL702_AVB 开发板</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#id3">5.2.1. 使用 CK-Link 烧写、调试连接方法</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#id4">5.2.2. 使用串口烧写程序连接方法</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<p class="caption"><span class="caption-text">API 手册</span></p>
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="api_guide.html">1. API 分层模型</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="api_guide.html#id5">2. 时钟树</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="api_guide.html#gpio">3. GPIO 设备</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="api_guide.html#uart">4. UART 设备</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="api_guide.html#pwm">5. PWM设备</a></li>
|
||||
</ul>
|
||||
<p class="caption"><span class="caption-text">示例代码</span></p>
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="blink_demo_introduce.html">1. 流水灯示例</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="breath_pwm_demo_introduce.html">2. 呼吸灯示例</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="uart_loopback_demo_introduce.html">3. 串口自收发示例</a></li>
|
||||
</ul>
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
</div>
|
||||
</nav>
|
||||
|
||||
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
|
||||
|
||||
|
||||
<nav class="wy-nav-top" aria-label="top navigation">
|
||||
|
||||
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
|
||||
<a href="index.html">BL_MCU_SDK 开发指南</a>
|
||||
|
||||
</nav>
|
||||
|
||||
|
||||
<div class="wy-nav-content">
|
||||
|
||||
<div class="rst-content">
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<div role="navigation" aria-label="breadcrumbs navigation">
|
||||
|
||||
<ul class="wy-breadcrumbs">
|
||||
|
||||
<li><a href="index.html" class="icon icon-home"></a> »</li>
|
||||
|
||||
<li><span class="section-number">5. </span>硬件连接</li>
|
||||
|
||||
|
||||
<li class="wy-breadcrumbs-aside">
|
||||
|
||||
|
||||
<a href="_sources/connecting_hardware.rst.txt" rel="nofollow"> View page source</a>
|
||||
|
||||
|
||||
</li>
|
||||
|
||||
</ul>
|
||||
|
||||
|
||||
<hr/>
|
||||
</div>
|
||||
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
|
||||
<div itemprop="articleBody">
|
||||
|
||||
<div class="section" id="connect-hardware">
|
||||
<span id="id1"></span><h1><span class="section-number">5. </span>硬件连接<a class="headerlink" href="#connect-hardware" title="永久链接至标题">¶</a></h1>
|
||||
<p>本文档介绍了如何连接 BL70x 系列 MCU 的开发板</p>
|
||||
<div class="section" id="bl706-iot">
|
||||
<h2><span class="section-number">5.1. </span>BL706_IOT 开发板<a class="headerlink" href="#bl706-iot" title="永久链接至标题">¶</a></h2>
|
||||
<div class="section" id="ck-link">
|
||||
<h3><span class="section-number">5.1.1. </span>使用 CK-Link 烧写、调试连接方法<a class="headerlink" href="#ck-link" title="永久链接至标题">¶</a></h3>
|
||||
<ul class="simple">
|
||||
<li><p>将 CK-Link USB 接口使用合适的 USB 数据线正确连接到 PC 主机</p></li>
|
||||
<li><p>将 Iot 开发板的 <code class="docutils literal notranslate"><span class="pre">HD3</span></code> 组的标准 <code class="docutils literal notranslate"><span class="pre">JTAG</span></code> 引脚使用杜邦线与 <code class="docutils literal notranslate"><span class="pre">CK-Link</span></code> 对应的 <code class="docutils literal notranslate"><span class="pre">JTAG</span></code> 引脚连接起来</p></li>
|
||||
<li><p>若没有使用 CK-Link 给开发板供电，需要给开发板单独供电</p></li>
|
||||
</ul>
|
||||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">bl706</span><span class="o">-</span><span class="n">iot</span> <span class="n">board</span> <span class="n">CK</span><span class="o">-</span><span class="n">Link</span>
|
||||
<span class="o">-------------------------------</span>
|
||||
<span class="n">JTAG_TDI</span> <span class="o"><--></span> <span class="n">TDI</span>
|
||||
<span class="n">JTAG_TDO</span> <span class="o"><--></span> <span class="n">TDO</span>
|
||||
<span class="n">JTAG_TCK</span> <span class="o"><--></span> <span class="n">TCK</span>
|
||||
<span class="n">JTAG_TMS</span> <span class="o"><--></span> <span class="n">TMS</span>
|
||||
<span class="n">VDD33</span> <span class="o"><--></span> <span class="n">VREF</span>
|
||||
<span class="n">GND</span> <span class="o"><--></span> <span class="n">GND</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
<div class="figure align-default" id="id5">
|
||||
<img alt="" src="_images/ck_link_connect_bl706_iot.png" />
|
||||
<p class="caption"><span class="caption-text">ck_link connect bl706-iot board</span><a class="headerlink" href="#id5" title="永久链接至图片">¶</a></p>
|
||||
</div>
|
||||
</div>
|
||||
<div class="section" id="j-link">
|
||||
<h3><span class="section-number">5.1.2. </span>使用 J-Link 烧写、调试连接方法<a class="headerlink" href="#j-link" title="永久链接至标题">¶</a></h3>
|
||||
<ul class="simple">
|
||||
<li><p>将 j-link 的 USB 接口使用合适的 USB 数据线正确连接到 PC 主机</p></li>
|
||||
<li><p>将 Iot 开发板的 <code class="docutils literal notranslate"><span class="pre">HD3</span></code> 组的标准 <code class="docutils literal notranslate"><span class="pre">JTAG</span></code> 引脚使用杜邦线与 <code class="docutils literal notranslate"><span class="pre">j-link</span></code> 对应的 <code class="docutils literal notranslate"><span class="pre">JTAG</span></code> 引脚连接起来</p></li>
|
||||
<li><p>j-link 连接的情况下需要给开发板独立供电，并且将开发板的电源接到 j-link 的 <code class="docutils literal notranslate"><span class="pre">VTref</span></code> 引脚</p></li>
|
||||
</ul>
|
||||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">bl706</span><span class="o">-</span><span class="n">iot</span> <span class="n">board</span> <span class="n">j</span><span class="o">-</span><span class="n">link</span>
|
||||
<span class="o">-------------------------------</span>
|
||||
<span class="n">JTAG_TDI</span> <span class="o"><--></span> <span class="n">TDI</span>
|
||||
<span class="n">JTAG_TDO</span> <span class="o"><--></span> <span class="n">TDO</span>
|
||||
<span class="n">JTAG_TCK</span> <span class="o"><--></span> <span class="n">TCK</span>
|
||||
<span class="n">JTAG_TMS</span> <span class="o"><--></span> <span class="n">TMS</span>
|
||||
<span class="n">VDD33</span> <span class="o"><--></span> <span class="n">VTref</span>
|
||||
<span class="n">GND</span> <span class="o"><--></span> <span class="n">GND</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
<div class="figure align-default" id="id6">
|
||||
<img alt="" src="_images/jlink_connect_bl706_iot.png" />
|
||||
<p class="caption"><span class="caption-text">jlink connect bl706-iot board</span><a class="headerlink" href="#id6" title="永久链接至图片">¶</a></p>
|
||||
</div>
|
||||
</div>
|
||||
<div class="section" id="id2">
|
||||
<h3><span class="section-number">5.1.3. </span>使用串口烧写程序连接方法<a class="headerlink" href="#id2" title="永久链接至标题">¶</a></h3>
|
||||
<ul class="simple">
|
||||
<li><p>使用串口烧写前，请确保正确安装了 <code class="docutils literal notranslate"><span class="pre">Bouffalo</span> <span class="pre">Lab</span> <span class="pre">Dev</span> <span class="pre">Cube</span></code> 或命令行烧写工具</p>
|
||||
<ul>
|
||||
<li><p>使用 <code class="docutils literal notranslate"><span class="pre">Type-C</span> <span class="pre">USB</span></code> 数据线 or <code class="docutils literal notranslate"><span class="pre">Mini</span> <span class="pre">USB</span></code> 数据线连接到开发板上对应的 <code class="docutils literal notranslate"><span class="pre">Type-C</span></code> 接口 or <code class="docutils literal notranslate"><span class="pre">Mini</span></code> 接口上。</p></li>
|
||||
<li><p>按下开发板上的 <code class="docutils literal notranslate"><span class="pre">Boot</span></code> 键，不要释放</p></li>
|
||||
<li><p>按下开发板上的 <code class="docutils literal notranslate"><span class="pre">RST</span></code> 键，此时已经进入 <code class="docutils literal notranslate"><span class="pre">Boot</span> <span class="pre">ROM</span></code>，可以释放两个按键</p></li>
|
||||
<li><p>这时就可以从 <code class="docutils literal notranslate"><span class="pre">Bouffalo</span> <span class="pre">Lab</span> <span class="pre">Dev</span> <span class="pre">Cube</span></code> 中看到相应的串口 <code class="docutils literal notranslate"><span class="pre">COM</span></code> 号，如没有出现，请点击 <code class="docutils literal notranslate"><span class="pre">Refresh</span></code> 按钮刷新一下</p></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><p>如没有合适的数据线，也可以使用一些常见的 <code class="docutils literal notranslate"><span class="pre">USB-TTL</span></code> 模块，连接到开发板的 <code class="docutils literal notranslate"><span class="pre">UART0</span></code> 端口进行烧写。 <code class="docutils literal notranslate"><span class="pre">UART0</span></code> 在 <code class="docutils literal notranslate"><span class="pre">HD1</span></code> 组上，连接方法如下：</p></li>
|
||||
</ul>
|
||||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">USB</span><span class="o">-</span><span class="n">TTL</span> <span class="n">BL702_IoT</span>
|
||||
<span class="o">----------------------</span>
|
||||
<span class="mi">3</span><span class="n">V3</span> <span class="o"><--></span> <span class="n">VDD</span>
|
||||
<span class="n">TXD</span> <span class="o"><--></span> <span class="n">RX0</span>
|
||||
<span class="n">RXD</span> <span class="o"><--></span> <span class="n">TX0</span>
|
||||
<span class="n">GND</span> <span class="o"><--></span> <span class="n">GND</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
<ul class="simple">
|
||||
<li><p>烧写方法同上</p></li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
<div class="section" id="bl702-avb">
|
||||
<h2><span class="section-number">5.2. </span>BL702_AVB 开发板<a class="headerlink" href="#bl702-avb" title="永久链接至标题">¶</a></h2>
|
||||
<div class="section" id="id3">
|
||||
<h3><span class="section-number">5.2.1. </span>使用 CK-Link 烧写、调试连接方法<a class="headerlink" href="#id3" title="永久链接至标题">¶</a></h3>
|
||||
<ul class="simple">
|
||||
<li><p><code class="docutils literal notranslate"><span class="pre">TO</span> <span class="pre">DO</span></code></p></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="section" id="id4">
|
||||
<h3><span class="section-number">5.2.2. </span>使用串口烧写程序连接方法<a class="headerlink" href="#id4" title="永久链接至标题">¶</a></h3>
|
||||
<ul class="simple">
|
||||
<li><p><code class="docutils literal notranslate"><span class="pre">TO</span> <span class="pre">DO</span></code></p></li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
</div>
|
||||
<footer>
|
||||
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
|
||||
<a href="api_guide.html" class="btn btn-neutral float-right" title="1. API 分层模型" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
|
||||
<a href="Linux_quick_start_ubuntu.html" class="btn btn-neutral float-left" title="4. Linux 环境开发指南" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
|
||||
</div>
|
||||
|
||||
<hr/>
|
||||
|
||||
<div role="contentinfo">
|
||||
<p>
|
||||
© 版权所有 2021, BouffaloLab Co., Ltd.
|
||||
|
||||
</p>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
|
||||
|
||||
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
|
||||
|
||||
provided by <a href="https://readthedocs.org">Read the Docs</a>.
|
||||
|
||||
</footer>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
</section>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<script type="text/javascript">
|
||||
jQuery(function () {
|
||||
SphinxRtdTheme.Navigation.enable(true);
|
||||
});
|
||||
</script>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</body>
|
||||
</html>
|
||||
|
|
@ -1,227 +0,0 @@
|
|||
|
||||
|
||||
<!DOCTYPE html>
|
||||
<html class="writer-html5" lang="zh-CN" >
|
||||
<head>
|
||||
<meta charset="utf-8" />
|
||||
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
||||
|
||||
<title>索引 — BL_MCU_SDK 开发指南 0.1 文档</title>
|
||||
|
||||
|
||||
|
||||
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
|
||||
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<!--[if lt IE 9]>
|
||||
<script src="_static/js/html5shiv.min.js"></script>
|
||||
<![endif]-->
|
||||
|
||||
|
||||
<script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
|
||||
<script src="_static/jquery.js"></script>
|
||||
<script src="_static/underscore.js"></script>
|
||||
<script src="_static/doctools.js"></script>
|
||||
<script src="_static/translations.js"></script>
|
||||
|
||||
<script type="text/javascript" src="_static/js/theme.js"></script>
|
||||
|
||||
|
||||
<link rel="index" title="索引" href="#" />
|
||||
<link rel="search" title="搜索" href="search.html" />
|
||||
</head>
|
||||
|
||||
<body class="wy-body-for-nav">
|
||||
|
||||
|
||||
<div class="wy-grid-for-nav">
|
||||
|
||||
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
|
||||
<div class="wy-side-scroll">
|
||||
<div class="wy-side-nav-search" >
|
||||
|
||||
|
||||
|
||||
<a href="index.html" class="icon icon-home"> BL_MCU_SDK 开发指南
|
||||
|
||||
|
||||
|
||||
</a>
|
||||
|
||||
|
||||
|
||||
|
||||
<div class="version">
|
||||
0.1
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
<div role="search">
|
||||
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
|
||||
<input type="text" name="q" placeholder="Search docs" />
|
||||
<input type="hidden" name="check_keywords" value="yes" />
|
||||
<input type="hidden" name="area" value="default" />
|
||||
</form>
|
||||
</div>
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<p class="caption"><span class="caption-text">快速开发指南</span></p>
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="get_started.html">1. 开发前的准备</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="Windows_quick_start_cdk.html">2. Windows 下使用 CDK (类 MDK Keil)开发指南</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="Windows_quick_start_eclipse.html">3. Windows 下使用 Eclipse 开发指南</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="Linux_quick_start_ubuntu.html">4. Linux 环境开发指南</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="connecting_hardware.html">5. 硬件连接</a></li>
|
||||
</ul>
|
||||
<p class="caption"><span class="caption-text">API 手册</span></p>
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="api_guide.html">1. API 分层模型</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="api_guide.html#id5">2. 时钟树</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="api_guide.html#gpio">3. GPIO 设备</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="api_guide.html#uart">4. UART 设备</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="api_guide.html#pwm">5. PWM设备</a></li>
|
||||
</ul>
|
||||
<p class="caption"><span class="caption-text">示例代码</span></p>
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="blink_demo_introduce.html">1. 流水灯示例</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="breath_pwm_demo_introduce.html">2. 呼吸灯示例</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="uart_loopback_demo_introduce.html">3. 串口自收发示例</a></li>
|
||||
</ul>
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
</div>
|
||||
</nav>
|
||||
|
||||
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
|
||||
|
||||
|
||||
<nav class="wy-nav-top" aria-label="top navigation">
|
||||
|
||||
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
|
||||
<a href="index.html">BL_MCU_SDK 开发指南</a>
|
||||
|
||||
</nav>
|
||||
|
||||
|
||||
<div class="wy-nav-content">
|
||||
|
||||
<div class="rst-content">
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<div role="navigation" aria-label="breadcrumbs navigation">
|
||||
|
||||
<ul class="wy-breadcrumbs">
|
||||
|
||||
<li><a href="index.html" class="icon icon-home"></a> »</li>
|
||||
|
||||
<li>索引</li>
|
||||
|
||||
|
||||
<li class="wy-breadcrumbs-aside">
|
||||
|
||||
|
||||
|
||||
</li>
|
||||
|
||||
</ul>
|
||||
|
||||
|
||||
<hr/>
|
||||
</div>
|
||||
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
|
||||
<div itemprop="articleBody">
|
||||
|
||||
|
||||
<h1 id="index">索引</h1>
|
||||
|
||||
<div class="genindex-jumpbox">
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
</div>
|
||||
<footer>
|
||||
|
||||
<hr/>
|
||||
|
||||
<div role="contentinfo">
|
||||
<p>
|
||||
© 版权所有 2021, BouffaloLab Co., Ltd.
|
||||
|
||||
</p>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
|
||||
|
||||
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
|
||||
|
||||
provided by <a href="https://readthedocs.org">Read the Docs</a>.
|
||||
|
||||
</footer>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
</section>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<script type="text/javascript">
|
||||
jQuery(function () {
|
||||
SphinxRtdTheme.Navigation.enable(true);
|
||||
});
|
||||
</script>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</body>
|
||||
</html>
|
||||
|
|
@ -1,275 +0,0 @@
|
|||
|
||||
|
||||
<!DOCTYPE html>
|
||||
<html class="writer-html5" lang="zh-CN" >
|
||||
<head>
|
||||
<meta charset="utf-8" />
|
||||
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
||||
|
||||
<title>1. 开发前的准备 — BL_MCU_SDK 开发指南 0.1 文档</title>
|
||||
|
||||
|
||||
|
||||
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
|
||||
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<!--[if lt IE 9]>
|
||||
<script src="_static/js/html5shiv.min.js"></script>
|
||||
<![endif]-->
|
||||
|
||||
|
||||
<script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
|
||||
<script src="_static/jquery.js"></script>
|
||||
<script src="_static/underscore.js"></script>
|
||||
<script src="_static/doctools.js"></script>
|
||||
<script src="_static/translations.js"></script>
|
||||
|
||||
<script type="text/javascript" src="_static/js/theme.js"></script>
|
||||
|
||||
|
||||
<link rel="index" title="索引" href="genindex.html" />
|
||||
<link rel="search" title="搜索" href="search.html" />
|
||||
<link rel="next" title="2. Windows 下使用 CDK (类 MDK Keil)开发指南" href="Windows_quick_start_cdk.html" />
|
||||
<link rel="prev" title="BL MCU SDK 开发指南" href="index.html" />
|
||||
</head>
|
||||
|
||||
<body class="wy-body-for-nav">
|
||||
|
||||
|
||||
<div class="wy-grid-for-nav">
|
||||
|
||||
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
|
||||
<div class="wy-side-scroll">
|
||||
<div class="wy-side-nav-search" >
|
||||
|
||||
|
||||
|
||||
<a href="index.html" class="icon icon-home"> BL_MCU_SDK 开发指南
|
||||
|
||||
|
||||
|
||||
</a>
|
||||
|
||||
|
||||
|
||||
|
||||
<div class="version">
|
||||
0.1
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
<div role="search">
|
||||
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
|
||||
<input type="text" name="q" placeholder="Search docs" />
|
||||
<input type="hidden" name="check_keywords" value="yes" />
|
||||
<input type="hidden" name="area" value="default" />
|
||||
</form>
|
||||
</div>
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<p class="caption"><span class="caption-text">快速开发指南</span></p>
|
||||
<ul class="current">
|
||||
<li class="toctree-l1 current"><a class="current reference internal" href="#">1. 开发前的准备</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="#id2">1.1. 硬件环境准备</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="#id3">1.2. 软件环境准备</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="Windows_quick_start_cdk.html">2. Windows 下使用 CDK (类 MDK Keil)开发指南</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="Windows_quick_start_eclipse.html">3. Windows 下使用 Eclipse 开发指南</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="Linux_quick_start_ubuntu.html">4. Linux 环境开发指南</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="connecting_hardware.html">5. 硬件连接</a></li>
|
||||
</ul>
|
||||
<p class="caption"><span class="caption-text">API 手册</span></p>
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="api_guide.html">1. API 分层模型</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="api_guide.html#id5">2. 时钟树</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="api_guide.html#gpio">3. GPIO 设备</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="api_guide.html#uart">4. UART 设备</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="api_guide.html#pwm">5. PWM设备</a></li>
|
||||
</ul>
|
||||
<p class="caption"><span class="caption-text">示例代码</span></p>
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="blink_demo_introduce.html">1. 流水灯示例</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="breath_pwm_demo_introduce.html">2. 呼吸灯示例</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="uart_loopback_demo_introduce.html">3. 串口自收发示例</a></li>
|
||||
</ul>
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
</div>
|
||||
</nav>
|
||||
|
||||
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
|
||||
|
||||
|
||||
<nav class="wy-nav-top" aria-label="top navigation">
|
||||
|
||||
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
|
||||
<a href="index.html">BL_MCU_SDK 开发指南</a>
|
||||
|
||||
</nav>
|
||||
|
||||
|
||||
<div class="wy-nav-content">
|
||||
|
||||
<div class="rst-content">
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<div role="navigation" aria-label="breadcrumbs navigation">
|
||||
|
||||
<ul class="wy-breadcrumbs">
|
||||
|
||||
<li><a href="index.html" class="icon icon-home"></a> »</li>
|
||||
|
||||
<li><span class="section-number">1. </span>开发前的准备</li>
|
||||
|
||||
|
||||
<li class="wy-breadcrumbs-aside">
|
||||
|
||||
|
||||
<a href="_sources/get_started.rst.txt" rel="nofollow"> View page source</a>
|
||||
|
||||
|
||||
</li>
|
||||
|
||||
</ul>
|
||||
|
||||
|
||||
<hr/>
|
||||
</div>
|
||||
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
|
||||
<div itemprop="articleBody">
|
||||
|
||||
<div class="section" id="id1">
|
||||
<h1><span class="section-number">1. </span>开发前的准备<a class="headerlink" href="#id1" title="永久链接至标题">¶</a></h1>
|
||||
<div class="section" id="id2">
|
||||
<h2><span class="section-number">1.1. </span>硬件环境准备<a class="headerlink" href="#id2" title="永久链接至标题">¶</a></h2>
|
||||
<ul class="simple">
|
||||
<li><p>一块 BL702 系列 MCU 的开发板：</p>
|
||||
<ul>
|
||||
<li><p>BL706_IOT 开发板， or</p></li>
|
||||
<li><p>BL706_AVB 开发板</p></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<p>BL706_Iot 开发板如下图所示</p>
|
||||
<div class="figure align-default" id="id4">
|
||||
<img alt="" src="_images/bl702_iot.png" />
|
||||
<p class="caption"><span class="caption-text">BL706_IoT</span><a class="headerlink" href="#id4" title="永久链接至图片">¶</a></p>
|
||||
</div>
|
||||
<ul class="simple">
|
||||
<li><p>一个支持标准 JTAG 功能的调试器：</p></li>
|
||||
</ul>
|
||||
<blockquote>
|
||||
<div><ul class="simple">
|
||||
<li><p>CK-Link 仿真器，or</p></li>
|
||||
<li><p>Jlink V11 仿真器，or</p></li>
|
||||
<li><p>Sipeed USB-JTAG/TTL 调试器，or</p></li>
|
||||
<li><p>Bouffalo Lab Debugger 调试器</p></li>
|
||||
</ul>
|
||||
</div></blockquote>
|
||||
<ul class="simple">
|
||||
<li><p>一台 PC 主机（运行 Windows 或者 Linux 系统）</p></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="section" id="id3">
|
||||
<h2><span class="section-number">1.2. </span>软件环境准备<a class="headerlink" href="#id3" title="永久链接至标题">¶</a></h2>
|
||||
<p>为了更好的进行 BL702 系列 MCU 的开发，建议您应当具备以下开发环境：</p>
|
||||
<ul class="simple">
|
||||
<li><p>Windows 使用 <a class="reference external" href="Windows_quick_start_cdk.html">CDK</a> 环境开发 (建议 Windows 7 以上版本。) ，or</p></li>
|
||||
<li><p><a class="reference external" href="Windows_quick_start_eclipse.html">Windows</a> 使用 Eclipse 环境开发 (建议 Windows 7 以上版本。) ，or</p></li>
|
||||
<li><p><a class="reference external" href="Linux_quick_start_ubuntu.html">Linux</a> (建议使用 Ubuntu 18 以上的 LTS 版本)</p></li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
</div>
|
||||
<footer>
|
||||
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
|
||||
<a href="Windows_quick_start_cdk.html" class="btn btn-neutral float-right" title="2. Windows 下使用 CDK (类 MDK Keil)开发指南" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
|
||||
<a href="index.html" class="btn btn-neutral float-left" title="BL MCU SDK 开发指南" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
|
||||
</div>
|
||||
|
||||
<hr/>
|
||||
|
||||
<div role="contentinfo">
|
||||
<p>
|
||||
© 版权所有 2021, BouffaloLab Co., Ltd.
|
||||
|
||||
</p>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
|
||||
|
||||
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
|
||||
|
||||
provided by <a href="https://readthedocs.org">Read the Docs</a>.
|
||||
|
||||
</footer>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
</section>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<script type="text/javascript">
|
||||
jQuery(function () {
|
||||
SphinxRtdTheme.Navigation.enable(true);
|
||||
});
|
||||
</script>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</body>
|
||||
</html>
|
||||
Some files were not shown because too many files have changed in this diff Show more
Loading…
Add table
Add a link
Reference in a new issue