m5/m5-docs
0
0
Fork 0
mirror of https://github.com/m5stack/m5-docs.git synced 2026-05-20 10:23:01 -07:00
Code Issues Packages Projects Releases Wiki Activity

remove the files which under the compile folder named "en_build"

Browse Source
This commit is contained in:
watson8544
2018-09-19 11:05:59 +08:00
parent a4b82f0abe
commit 9dab67918b
34 changed files with 0 additions and 3397 deletions
Download Patch File Download Diff File Expand all files Collapse all files
en_build/doctrees/api-reference/mic/mic.doctree
BIN
View File
Binary file not shown.
en_build/doctrees/languages.doctree
BIN
View File
Binary file not shown.
en_build/doctrees/product-documents/STEAM Kit/M5GO/m5go_unit_env.doctree
BIN
View File
Binary file not shown.
en_build/doctrees/product-documents/STEAM Kit/M5GO/m5go_unit_hub.doctree
BIN
View File
Binary file not shown.
en_build/doctrees/product-documents/STEAM Kit/M5GO/m5go_unit_ir.doctree
BIN
View File
Binary file not shown.
en_build/doctrees/product-documents/STEAM Kit/M5GO/m5go_unit_pir.doctree
BIN
View File
Binary file not shown.
en_build/doctrees/product-documents/STEAM Kit/M5GO/m5go_unit_pot.doctree
BIN
View File
Binary file not shown.
en_build/doctrees/product-documents/STEAM Kit/M5GO/m5go_unit_rgby.doctree
BIN
View File
Binary file not shown.
en_build/html/COPYRIGHT.html
-264
View File
@@ -1,264 +0,0 @@
<!DOCTYPE html>
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>Copyrights and Licenses &mdash; M5Stack 1.0.1 documentation</title>
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<link rel="author" title="About these documents" href="about.html" />
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<script src="_static/js/modernizr.min.js"></script>
</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"> M5Stack
</a>
<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">
<ul>
<li class="toctree-l1"><a class="reference internal" href="product-documents/index.html">Product Documents</a></li>
<li class="toctree-l1"><a class="reference internal" href="get-started/index.html">Get Started</a></li>
<li class="toctree-l1"><a class="reference internal" href="api-reference/index.html">API Reference</a></li>
<li class="toctree-l1"><a class="reference internal" href="basic-cases/index.html">M5Stack Cases</a></li>
<li class="toctree-l1"><a class="reference internal" href="m5stack-awesome/index.html">M5Stack Awesome</a></li>
<li class="toctree-l1"><a class="reference internal" href="m5stack-faq/index.html">FAQ</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">M5Stack</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">Docs</a> &raquo;</li>
<li>Copyrights and Licenses</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/COPYRIGHT.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="copyrights-and-licenses">
<h1>Copyrights and Licenses<a class="headerlink" href="#copyrights-and-licenses" title="Permalink to this headline"></a></h1>
<div class="section" id="software-copyrights">
<h2>Software Copyrights<a class="headerlink" href="#software-copyrights" title="Permalink to this headline"></a></h2>
<p>All original source code in this repository is Copyright (C) 2017-2018 M5Stack Inc. This source code is licensed under the Apache License 2.0 as described in the file LICENSE.</p>
<p>Additional third party copyrighted code is included under the following licenses.</p>
<p>Where source code headers specify Copyright &amp; License information, this information takes precedence over the summaries made here.</p>
<div class="section" id="firmware-components">
<h3>Firmware Components<a class="headerlink" href="#firmware-components" title="Permalink to this headline"></a></h3>
</div>
<div class="section" id="build-tools">
<h3>Build Tools<a class="headerlink" href="#build-tools" title="Permalink to this headline"></a></h3>
<p>This is the list of licenses for tools included in this repository, which are used to build applications. The tools do not become part of the application (firmware), so their license does not affect licensing of the application.</p>
</div>
</div>
<div class="section" id="xtensa-libhal-mit-license">
<h2>Xtensa libhal MIT License<a class="headerlink" href="#xtensa-libhal-mit-license" title="Permalink to this headline"></a></h2>
<p>Copyright (c) 2003, 2006, 2010 Tensilica Inc.</p>
<p>Permission is hereby granted, free of charge, to any person obtaining
a copy of this software and associated documentation files (the
“Software”), to deal in the Software without restriction, including
without limitation the rights to use, copy, modify, merge, publish,
distribute, sublicense, and/or sell copies of the Software, and to
permit persons to whom the Software is furnished to do so, subject to
the following conditions:</p>
<p>The above copyright notice and this permission notice shall be included
in all copies or substantial portions of the Software.</p>
<p>THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.</p>
</div>
<div class="section" id="tinybasic-plus-mit-license">
<h2>TinyBasic Plus MIT License<a class="headerlink" href="#tinybasic-plus-mit-license" title="Permalink to this headline"></a></h2>
<p>Copyright (c) 2012-2013</p>
<p>Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:</p>
<p>The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.</p>
<p>THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.</p>
</div>
<div class="section" id="tjpgdec-license">
<h2>TJpgDec License<a class="headerlink" href="#tjpgdec-license" title="Permalink to this headline"></a></h2>
<p>TJpgDec - Tiny JPEG Decompressor R0.01 (C)ChaN, 2011
The TJpgDec is a generic JPEG decompressor module for tiny embedded systems.
This is a free software that opened for education, research and commercial
developments under license policy of following terms.</p>
<p>Copyright (C) 2011, ChaN, all right reserved.</p>
<ul class="simple">
<li>The TJpgDec module is a free software and there is NO WARRANTY.</li>
<li>No restriction on use. You can use, modify and redistribute it for personal, non-profit or commercial products UNDER YOUR RESPONSIBILITY.</li>
<li>Redistributions of source code must retain the above copyright notice.</li>
</ul>
</div>
</div>
</div>
</div>
<footer>
<hr/>
<div role="contentinfo">
<p>
&copy; Copyright 2017 - 2018, M5Stack Inc.
</p>
</div>
Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/rtfd/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">
var DOCUMENTATION_OPTIONS = {
URL_ROOT:'./',
VERSION:'1.0.1',
LANGUAGE:'en',
COLLAPSE_INDEX:false,
FILE_SUFFIX:'.html',
HAS_SOURCE: true,
SOURCELINK_SUFFIX: '.txt'
};
</script>
<script type="text/javascript" src="_static/jquery.js"></script>
<script type="text/javascript" src="_static/underscore.js"></script>
<script type="text/javascript" src="_static/doctools.js"></script>
<script type="text/javascript" src="_static/js/theme.js"></script>
<script type="text/javascript">
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>
</body>
</html>
en_build/html/_images/about-doc.png
BIN
View File
Binary file not shown.
Side by Side

Before

Width:  |  Height:  |  Size: 106 KiB

en_build/html/_images/choose_version.png
BIN
View File
Binary file not shown.
Side by Side

Before

Width:  |  Height:  |  Size: 22 KiB

en_build/html/_sources/COPYRIGHT.rst.txt
-74
View File
@@ -1,74 +0,0 @@
Copyrights and Licenses
***********************
Software Copyrights
===================
All original source code in this repository is Copyright (C) 2017-2018 M5Stack Inc. This source code is licensed under the Apache License 2.0 as described in the file LICENSE.
Additional third party copyrighted code is included under the following licenses.
Where source code headers specify Copyright & License information, this information takes precedence over the summaries made here.
Firmware Components
-------------------
Build Tools
-----------
This is the list of licenses for tools included in this repository, which are used to build applications. The tools do not become part of the application (firmware), so their license does not affect licensing of the application.
Xtensa libhal MIT License
=========================
Copyright (c) 2003, 2006, 2010 Tensilica Inc.
Permission is hereby granted, free of charge, to any person obtaining
a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including
without limitation the rights to use, copy, modify, merge, publish,
distribute, sublicense, and/or sell copies of the Software, and to
permit persons to whom the Software is furnished to do so, subject to
the following conditions:
The above copyright notice and this permission notice shall be included
in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
TinyBasic Plus MIT License
==========================
Copyright (c) 2012-2013
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
TJpgDec License
===============
TJpgDec - Tiny JPEG Decompressor R0.01 (C)ChaN, 2011
The TJpgDec is a generic JPEG decompressor module for tiny embedded systems.
This is a free software that opened for education, research and commercial
developments under license policy of following terms.
Copyright (C) 2011, ChaN, all right reserved.
* The TJpgDec module is a free software and there is NO WARRANTY.
* No restriction on use. You can use, modify and redistribute it for personal, non-profit or commercial products UNDER YOUR RESPONSIBILITY.
* Redistributions of source code must retain the above copyright notice.
en_build/html/_sources/about.rst.txt
-16
View File
@@ -1,16 +0,0 @@
About
=====
This is documentation of `ESP-IDF <https://github.com/espressif/esp-idf>`_, the framework to develop applications for `ESP32 <https://espressif.com/en/products/hardware/esp32/overview>`_ chip by `Espressif <https://espressif.com>`_.
The ESP32 is 2.4 GHz Wi-Fi and Bluetooth combo, 32 bit dual core chip with 600 DMIPS processing power.
.. figure:: ../_static/about-doc.png
:align: center
:alt: Espressif IoT Integrated Development Framework
:figclass: align-center
Espressif IoT Integrated Development Framework
The ESP-IDF, Espressif IoT Integrated Development Framework, provides toolchain, API, components and workflows to develop applications for ESP32 using Windows, Linux and Mac OS operating systems.
en_build/html/_sources/api-reference/mic/mic.rst.txt
-45
View File
@@ -1,45 +0,0 @@
# Usage
.. code:: python
from m5stack import *
import machine, _thread
mic_adc = 0
buffer = []
def microphone_enter():
print('microphone_enter')
global mic_adc, buffer
try:
mic_adc = machine.ADC(34)
mic_adc.atten(mic_adc.ATTN_11DB)
dac = machine.DAC(machine.Pin(25))
dac.write(0)
except:
pass
buffer = []
for i in range(0, 55):
buffer.append(0)
def microphone_loop():
global mic_adc, buffer
val = 0
for i in range(0, 32):
raw = (mic_adc.readraw() - 1845) // 10
if raw > 20:
raw = 20
elif raw < -20:
raw = -20
val += raw
val = val // 32
buffer.pop()
buffer.insert(0, val)
for i in range(1, 50):
lcd.line(i*2+44, 120+buffer[i+1], i*2+44+2, 120+buffer[i+2], lcd.WHITE)
lcd.line(i*2+44, 120+buffer[i], i*2+44+2, 120+buffer[i+1], lcd.BLACK)
microphone_enter()
while 1:
microphone_loop()
en_build/html/_sources/get-started/make-project.rst.txt
-74
View File
@@ -1,74 +0,0 @@
Build and Flash with Make
=========================
`zh_CN:[中文]`
Finding a project
-----------------
As well as the `esp-idf-template <https://github.com/espressif/esp-idf-template>`_ project, ESP-IDF comes with some example projects on github in the `examples` directory.
Once you've found the project you want to work with, change to its directory and you can configure and build it.
Configuring your project
------------------------
::
make menuconfig
Compiling your project
----------------------
::
make all
... will compile app, bootloader and generate a partition table based on the config.
Flashing your project
---------------------
When ``make all`` finishes, it will print a command line to use esptool.py to flash the chip. However you can also do this from make by running::
make flash
This will flash the entire project (app, bootloader and partition table) to a new chip. The settings for serial port flashing can be configured with `make menuconfig`.
You don't need to run ``make all`` before running ``make flash``, ``make flash`` will automatically rebuild anything which needs it.
Compiling & Flashing Just the App
---------------------------------
After the initial flash, you may just want to build and flash just your app, not the bootloader and partition table:
* ``make app`` - build just the app.
* ``make app-flash`` - flash just the app.
``make app-flash`` will automatically rebuild the app if it needs it.
There's no downside to reflashing the bootloader and partition table each time, if they haven't changed.
The Partition Table
-------------------
Once you've compiled your project, the "build" directory will contain a binary file with a name like "my_app.bin". This is an ESP32 image binary that can be loaded by the bootloader.
A single ESP32's flash can contain multiple apps, as well as many kinds of data (calibration data, filesystems, parameter storage, etc). For this reason, a partition table is flashed to offset 0x8000 in the flash.
Each entry in the partition table has a name (label), type (app, data, or something else), subtype and the offset in flash where the partition is loaded.
The simplest way to use the partition table is to `make menuconfig` and choose one of the simple predefined partition tables:
* "Single factory app, no OTA"
* "Factory app, two OTA definitions"
In both cases the factory app is flashed at offset 0x10000. If you `make partition_table` then it will print a summary of the partition table.
For more details about :doc:`partition tables <../api-guides/partition-tables>` and how to create custom variations, view the :doc:`documentation <../api-guides/partition-tables>`.
en_build/html/_sources/get-started/toolchain-setup-scratch.rst.txt
-25
View File
@@ -1,25 +0,0 @@
.. _get-started-customized-setup:
*****************************
Customized Setup of Toolchain
*****************************
Instead of downloading binary toolchain from Espressif website (see :ref:`get-started-setup-toolchain`) you may build the toolchain yourself.
If you can't think of a reason why you need to build it yourself, then probably it's better to stick with the binary version. However, here are some of the reasons why you might want to compile it from source:
- if you want to customize toolchain build configuration
- if you want to use a different GCC version (such as 4.8.5)
- if you want to hack gcc or newlib or libstdc++
- if you are curious and/or have time to spare
- if you don't trust binaries downloaded from the Internet
In any case, here are the instructions to compile the toolchain yourself.
.. toctree::
:maxdepth: 1
windows-setup-scratch
linux-setup-scratch
macos-setup-scratch
en_build/html/_sources/languages.rst.txt
-19
View File
@@ -1,19 +0,0 @@
Switch Between Languages/切换语言
=================================
The documentation now has two language versions, however, please refer to the English version if there is any discrepancy.
本文档现在有两种语言的版本，如有出入请以英文版本为准。
- English/英文
- Chinese/中文
You can easily changed from one language to another by the panel on the sidebar like below. Just click on the **Read
the Docs** title button on the left-bottom conner if it is folded.
如下图所示，你可使用边栏的面板进行语言的切换。如果该面板被折叠，点击左下角 **Read the Docs** 标题按钮来显示它。
.. image:: /../_static/choose_version.png
en_build/html/_sources/product-documents/STEAM Kit/M5GO/m5go_unit_env.rst.txt
-30
View File
@@ -1,30 +0,0 @@
M5GO ENV
========
DESCRIPTION
-----------
The M5GO ENV is a environment sensor for M5GO that can easily detect
temperature, humidity and air pressure with M5GO Core, including
temperature and humidity sensor and absolute barometric pressure sensor.
FEATURES
--------
- Temperature:
- measuring range: 20 ~ 60℃
- resolution: ±0.2℃
- Humidity:
- measuring range: 20 ~ 95℃
- resolution: 0.1%
- Air pressure
- measuring range: 300 ~ 1100hPa
- resolution: ±1hPa
- Two Lego installation holes
DOCUMENTS
---------
- `WebSite <https://m5stack.com>`__
- `GitHub <https://github.com/m5stack/M5GO>`__
en_build/html/_sources/product-documents/STEAM Kit/M5GO/m5go_unit_hub.rst.txt
-22
View File
@@ -1,22 +0,0 @@
M5GO HUB
========
DESCRIPTION
-----------
The M5GO HUB is a module for M5GO to expand GROVE port added three GROVE
ports for user. So you can control 3 GROVE devices with only one M5GO
Core at a time.
FEATURES
--------
- Instantly Add Three 4-Pins-GROVE ports to Any Compatible Device
- Two Lego installation holes
DOCUMENTS
---------
- `WebSite <https://m5stack.com>`__
- `GitHub <https://github.com/m5stack/M5GO>`__
en_build/html/_sources/product-documents/STEAM Kit/M5GO/m5go_unit_ir.rst.txt
-29
View File
@@ -1,29 +0,0 @@
M5GO IR
=======
DESCRIPTION
-----------
The M5GO IR is a IR infrared obstacle avoidance sensor for M5GO. It can
be widely used in robot obstacle avoidance, obstacle avoidance car, line
count, and black and white line tracking and so on.
It has a pair of infrared transmitting and receiving tube, tube infrared
emit a certain frequency, when detecting direction meet with obstacles
(reflecting surface), reflected infrared receiving tube, after the
comparator circuit processing, green indicator will light up, at the
same time signal output interface to output digital signal.
FEATURES
--------
- A pair of infrared transmitting and receiving tube
- Detects the distance 2 ~ 5cm
- Two Lego installation holes
DOCUMENTS
---------
- `WebSite <https://m5stack.com>`__
- `GitHub <https://github.com/m5stack/M5GO>`__

Some files were not shown because too many files have changed in this diff Show More