Merge pull request #8 from m5stack/dev-readthedocs

Dev readthedocs
This commit is contained in:
LiHuashen
2018-09-19 17:57:15 +08:00
committed by GitHub
22 changed files with 70 additions and 38 deletions
@@ -48,6 +48,8 @@ b. select `M5Cam-vx.x (/M5Cam-psram)` option, if you own a ESP32CAM (/ M5CAMERA)
![image](../../_static/getting_started_pics/burn_firmware_05.png)
**Then reset your board**
#### ***Note:***
***1. If M5Burner means be busy after clicking `Burn`, please wait for a few minutes. It'll be normal after the firmware has been burnt successfully.***
@@ -67,6 +67,8 @@ below, it means chip has been burnt successfully.
.. image:: ../../_static/getting_started_pics/burn_firmware_05.png
**Then reset your board.**
**Note:**
^^^^^^^^^^^
+62 -34
View File
@@ -7,56 +7,84 @@ M5Stack Core
.. toctree::
:maxdepth: 1
M5Stack BASIC <m5stack-core/m5stack_basic>
M5Stack GRAY <m5stack-core/m5stack_gray>
M5Stack FIRE <m5stack-core/m5stack_fire>
M5Stack PANDA <m5stack-core/m5stack_panda>
M5Stack FACES <m5stack-core/m5stack_faces>
M5Stack PLC <m5stack-core/m5stack_plc>
====================== ======================
`BASIC`_ `GRAY`_
---------------------- ----------------------
`FIRE`_ `PANDA`_
====================== ======================
.. _BASIC: m5stack-core/m5stack_basic.html
.. _GRAY: m5stack-core/m5stack_gray.html
.. _FIRE: m5stack-core/m5stack_fire.html
.. _PANDA: m5stack-core/m5stack_panda.html
Modules
~~~~~~~~~~~~~~~~~~~
.. toctree::
:maxdepth: 1
ESP32CAM <modules/esp32cam>
M5Stack GPS Module <modules/m5stack_gps_module>
M5Stack LORA Module <modules/m5stack_lora_module>
M5Stack SIM800 Module <modules/m5stack_sim800_module>
M5Stack BATTERY Module <modules/m5stack_battery_module>
M5Stack BTC Module <modules/m5stack_btc_module>
M5Stack PROTO Module <modules/m5stack_proto_module>
M5Stack PROTO Kit <modules/m5stack_proto_kit>
ESP32CAM <modules/esp32cam> / M5CAMERA <modules/M5CAMERA>
GPS Module <modules/m5stack_gps_module>
LORA Module <modules/m5stack_lora_module>
SIM800 Module <modules/m5stack_sim800_module>
BATTERY Module <modules/m5stack_battery_module>
BTC Module <modules/m5stack_btc_module>
PROTO Module <modules/m5stack_proto_module>
PROTO Kit <modules/m5stack_proto_kit>
ROBOT
BASE
~~~~~~~~~~~~~~~~~~~
.. toctree::
:maxdepth: 1
BALA <ROBOT/BALA>
PLC <bases/m5stack_plc>
STEAM Kit
ACCESSORY
~~~~~~~~~~~~~~~~~~~
.. toctree::
:maxdepth: 1
M5Stack M5GO <STEAM Kit/M5GO/m5go>
M5GO Unit ENV <STEAM Kit/M5GO/units/m5go_unit_env>
M5GO Unit HUB <STEAM Kit/M5GO/units/m5go_unit_hub>
M5GO Unit IR <STEAM Kit/M5GO/units/m5go_unit_ir>
M5GO Unit PIR <STEAM Kit/M5GO/units/m5go_unit_pir>
M5GO Unit POT <STEAM Kit/M5GO/units/m5go_unit_pot>
M5GO Unit RGB <STEAM Kit/M5GO/units/m5go_unit_rgb>
M5GO Unit 3.96PORT <STEAM Kit/M5GO/units/m5go_unit_3.96port>
M5GO Unit EARTH <STEAM Kit/M5GO/units/m5go_unit_earth>
M5GO Unit LIGHT <STEAM Kit/M5GO/units/m5go_unit_light>
M5GO Unit MAKEY <STEAM Kit/M5GO/units/m5go_unit_makey>
M5GO Unit PROTO <STEAM Kit/M5GO/units/m5go_unit_proto>
M5GO Unit RELAY <STEAM Kit/M5GO/units/m5go_unit_relay>
M5GO Unit THERMAL <STEAM Kit/M5GO/units/m5go_unit_thermal>
cable <cables/cable>
UNIT
~~~~~~~~~~~~~~~~~~~
.. toctree::
:maxdepth: 1
====================== ====================== ======================
`ENV`_ `HUB`_ `IR`_
---------------------- ---------------------- ----------------------
`PIR`_ `POT`_ `RGB`_
---------------------- ---------------------- ----------------------
`3.96PORT`_ `EARTH`_ `LIGHT`_
---------------------- ---------------------- ----------------------
`MAKEY`_ `PROTO`_ `RELAY`_
---------------------- ---------------------- ----------------------
`THERMAL`_
====================== ====================== ======================
.. _ENV: units/m5go_unit_env.html
.. _HUB: units/m5go_unit_hub.html
.. _IR: units/m5go_unit_ir.html
.. _PIR: units/m5go_unit_pir.html
.. _POT: units/m5go_unit_pot.html
.. _RGB: units/m5go_unit_rgb.html
.. _3.96PORT: units/m5go_unit_3.96port.html
.. _EARTH: units/m5go_unit_earth.html
.. _LIGHT: units/m5go_unit_light.html
.. _MAKEY: units/m5go_unit_makey.html
.. _PROTO: units/m5go_unit_proto.html
.. _RELAY: units/m5go_unit_relay.html
.. _THERMAL: units/m5go_unit_thermal.html
APPLICATION
~~~~~~~~~~~~~~~~~~~
.. toctree::
:maxdepth: 1
BALA <applications/BALA>
PCD <applications/pcd>
Tools
@@ -6,14 +6,14 @@ DESCRIPTION
The M5Stack LAN Module is a ethernet module which with a I2C Grove port and 6 pins user ports.
When the speed of our wireless network is so slow that M5Stack Core can not normally connect to the wireless network.
When the speed of our wireless network is so slow that M5Stack Core can not normally connect to the wireless network.
So we need a ethernet port board which is connected with M5Stack Core. This **LAN module** is that one who solves the awkward problem.
FEATURES
--------
- W5500 - High-performance ethernet chip
- W5500 - High-performance ethernet chip
- Less code and Hand-in-hand program experience
INCLUDES
@@ -40,11 +40,11 @@ DOCUMENTS
- `WebSite <https://m5stack.com>`__
- Example
+ `Arduino Example <https://github.com/m5stack/M5Stack/tree/master/examples/Modules/LAN>`__
+ `Arduino Example <https://github.com/m5stack/M5Stack/tree/master/examples/Modules/W5500>`__
- `LAN Info <https://www.u-blox.com/zh/product/neo-m8-series>`__ (LAN)
- GitHub
+ `Arduino GitHub <https://github.com/m5stack/M5Stack>`__
- `Purchase <https://www.aliexpress.com/store/product/M5Stack-New-Arrival-LAN-Module-with-W5500-Chip-LanProto-Ethernet-convert-Network-Module-Microcontroller-for-Arduino/3226069_32904089417.html>`_

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