From b21d41c429cff5398e42cd090c38c9084b55b1c0 Mon Sep 17 00:00:00 2001 From: watson8544 <854410664@qq.com> Date: Wed, 19 Sep 2018 15:12:13 +0800 Subject: [PATCH 1/3] updated --- en/get-started/how_to_burn_firmware_en.md | 2 ++ en/get-started/how_to_burn_firmware_en.rst | 2 ++ 2 files changed, 4 insertions(+) diff --git a/en/get-started/how_to_burn_firmware_en.md b/en/get-started/how_to_burn_firmware_en.md index 1415ecc7..060bd610 100644 --- a/en/get-started/how_to_burn_firmware_en.md +++ b/en/get-started/how_to_burn_firmware_en.md @@ -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.*** diff --git a/en/get-started/how_to_burn_firmware_en.rst b/en/get-started/how_to_burn_firmware_en.rst index 2eb02110..83b31855 100644 --- a/en/get-started/how_to_burn_firmware_en.rst +++ b/en/get-started/how_to_burn_firmware_en.rst @@ -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:** ^^^^^^^^^^^ From 19d5846ef83d1f2e2813e72662a30dca772a8267 Mon Sep 17 00:00:00 2001 From: watson8544 <854410664@qq.com> Date: Wed, 19 Sep 2018 17:53:01 +0800 Subject: [PATCH 2/3] fixed a bug --- en/product-documents/modules/m5stack_lan_module.rst | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/en/product-documents/modules/m5stack_lan_module.rst b/en/product-documents/modules/m5stack_lan_module.rst index e465bfd6..ed9ececd 100644 --- a/en/product-documents/modules/m5stack_lan_module.rst +++ b/en/product-documents/modules/m5stack_lan_module.rst @@ -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 `__ - Example - + `Arduino Example `__ + + `Arduino Example `__ - `LAN Info `__ (LAN) - GitHub + `Arduino GitHub `__ - + - `Purchase `_ From 504b05d66c78b2950fb0e6fb5d26cc9f1595b7f0 Mon Sep 17 00:00:00 2001 From: watson8544 <854410664@qq.com> Date: Wed, 19 Sep 2018 17:53:58 +0800 Subject: [PATCH 3/3] adjust product list --- .../accessorries/cables/cable.rst | 0 .../{ROBOT => applications}/BALA.md | 0 .../{ROBOT => applications}/BALA.rst | 0 .../{m5stack-core => bases}/m5stack_plc.rst | 0 en/product-documents/index.rst | 96 ++++++++++++------- .../{STEAM Kit/M5GO => m5stack-core}/m5go.rst | 0 .../M5GO => }/units/m5go_unit_3.96port.rst | 0 .../M5GO => }/units/m5go_unit_earth.rst | 0 .../M5GO => }/units/m5go_unit_env.rst | 0 .../M5GO => }/units/m5go_unit_hub.rst | 0 .../M5GO => }/units/m5go_unit_ir.rst | 0 .../M5GO => }/units/m5go_unit_light.rst | 0 .../M5GO => }/units/m5go_unit_makey.rst | 0 .../M5GO => }/units/m5go_unit_pir.rst | 0 .../M5GO => }/units/m5go_unit_pot.rst | 0 .../M5GO => }/units/m5go_unit_proto.rst | 0 .../M5GO => }/units/m5go_unit_relay.rst | 0 .../M5GO => }/units/m5go_unit_rgb.rst | 0 .../M5GO => }/units/m5go_unit_thermal.rst | 0 19 files changed, 62 insertions(+), 34 deletions(-) create mode 100644 en/product-documents/accessorries/cables/cable.rst rename en/product-documents/{ROBOT => applications}/BALA.md (100%) rename en/product-documents/{ROBOT => applications}/BALA.rst (100%) rename en/product-documents/{m5stack-core => bases}/m5stack_plc.rst (100%) rename en/product-documents/{STEAM Kit/M5GO => m5stack-core}/m5go.rst (100%) rename en/product-documents/{STEAM Kit/M5GO => }/units/m5go_unit_3.96port.rst (100%) rename en/product-documents/{STEAM Kit/M5GO => }/units/m5go_unit_earth.rst (100%) rename en/product-documents/{STEAM Kit/M5GO => }/units/m5go_unit_env.rst (100%) rename en/product-documents/{STEAM Kit/M5GO => }/units/m5go_unit_hub.rst (100%) rename en/product-documents/{STEAM Kit/M5GO => }/units/m5go_unit_ir.rst (100%) rename en/product-documents/{STEAM Kit/M5GO => }/units/m5go_unit_light.rst (100%) rename en/product-documents/{STEAM Kit/M5GO => }/units/m5go_unit_makey.rst (100%) rename en/product-documents/{STEAM Kit/M5GO => }/units/m5go_unit_pir.rst (100%) rename en/product-documents/{STEAM Kit/M5GO => }/units/m5go_unit_pot.rst (100%) rename en/product-documents/{STEAM Kit/M5GO => }/units/m5go_unit_proto.rst (100%) rename en/product-documents/{STEAM Kit/M5GO => }/units/m5go_unit_relay.rst (100%) rename en/product-documents/{STEAM Kit/M5GO => }/units/m5go_unit_rgb.rst (100%) rename en/product-documents/{STEAM Kit/M5GO => }/units/m5go_unit_thermal.rst (100%) diff --git a/en/product-documents/accessorries/cables/cable.rst b/en/product-documents/accessorries/cables/cable.rst new file mode 100644 index 00000000..e69de29b diff --git a/en/product-documents/ROBOT/BALA.md b/en/product-documents/applications/BALA.md similarity index 100% rename from en/product-documents/ROBOT/BALA.md rename to en/product-documents/applications/BALA.md diff --git a/en/product-documents/ROBOT/BALA.rst b/en/product-documents/applications/BALA.rst similarity index 100% rename from en/product-documents/ROBOT/BALA.rst rename to en/product-documents/applications/BALA.rst diff --git a/en/product-documents/m5stack-core/m5stack_plc.rst b/en/product-documents/bases/m5stack_plc.rst similarity index 100% rename from en/product-documents/m5stack-core/m5stack_plc.rst rename to en/product-documents/bases/m5stack_plc.rst diff --git a/en/product-documents/index.rst b/en/product-documents/index.rst index 442f4c73..1eeda330 100644 --- a/en/product-documents/index.rst +++ b/en/product-documents/index.rst @@ -7,56 +7,84 @@ M5Stack Core .. toctree:: :maxdepth: 1 - M5Stack BASIC - M5Stack GRAY - M5Stack FIRE - M5Stack PANDA - M5Stack FACES - 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 - M5Stack GPS Module - M5Stack LORA Module - M5Stack SIM800 Module - M5Stack BATTERY Module - M5Stack BTC Module - M5Stack PROTO Module - M5Stack PROTO Kit + ESP32CAM / M5CAMERA + GPS Module + LORA Module + SIM800 Module + BATTERY Module + BTC Module + PROTO Module + PROTO Kit - -ROBOT +BASE ~~~~~~~~~~~~~~~~~~~ .. toctree:: :maxdepth: 1 - BALA + PLC - - -STEAM Kit +ACCESSORY ~~~~~~~~~~~~~~~~~~~ .. toctree:: :maxdepth: 1 - M5Stack M5GO - M5GO Unit ENV - M5GO Unit HUB - M5GO Unit IR - M5GO Unit PIR - M5GO Unit POT - M5GO Unit RGB - M5GO Unit 3.96PORT - M5GO Unit EARTH - M5GO Unit LIGHT - M5GO Unit MAKEY - M5GO Unit PROTO - M5GO Unit RELAY - M5GO Unit THERMAL + 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 + PCD Tools diff --git a/en/product-documents/STEAM Kit/M5GO/m5go.rst b/en/product-documents/m5stack-core/m5go.rst similarity index 100% rename from en/product-documents/STEAM Kit/M5GO/m5go.rst rename to en/product-documents/m5stack-core/m5go.rst diff --git a/en/product-documents/STEAM Kit/M5GO/units/m5go_unit_3.96port.rst b/en/product-documents/units/m5go_unit_3.96port.rst similarity index 100% rename from en/product-documents/STEAM Kit/M5GO/units/m5go_unit_3.96port.rst rename to en/product-documents/units/m5go_unit_3.96port.rst diff --git a/en/product-documents/STEAM Kit/M5GO/units/m5go_unit_earth.rst b/en/product-documents/units/m5go_unit_earth.rst similarity index 100% rename from en/product-documents/STEAM Kit/M5GO/units/m5go_unit_earth.rst rename to en/product-documents/units/m5go_unit_earth.rst diff --git a/en/product-documents/STEAM Kit/M5GO/units/m5go_unit_env.rst b/en/product-documents/units/m5go_unit_env.rst similarity index 100% rename from en/product-documents/STEAM Kit/M5GO/units/m5go_unit_env.rst rename to en/product-documents/units/m5go_unit_env.rst diff --git a/en/product-documents/STEAM Kit/M5GO/units/m5go_unit_hub.rst b/en/product-documents/units/m5go_unit_hub.rst similarity index 100% rename from en/product-documents/STEAM Kit/M5GO/units/m5go_unit_hub.rst rename to en/product-documents/units/m5go_unit_hub.rst diff --git a/en/product-documents/STEAM Kit/M5GO/units/m5go_unit_ir.rst b/en/product-documents/units/m5go_unit_ir.rst similarity index 100% rename from en/product-documents/STEAM Kit/M5GO/units/m5go_unit_ir.rst rename to en/product-documents/units/m5go_unit_ir.rst diff --git a/en/product-documents/STEAM Kit/M5GO/units/m5go_unit_light.rst b/en/product-documents/units/m5go_unit_light.rst similarity index 100% rename from en/product-documents/STEAM Kit/M5GO/units/m5go_unit_light.rst rename to en/product-documents/units/m5go_unit_light.rst diff --git a/en/product-documents/STEAM Kit/M5GO/units/m5go_unit_makey.rst b/en/product-documents/units/m5go_unit_makey.rst similarity index 100% rename from en/product-documents/STEAM Kit/M5GO/units/m5go_unit_makey.rst rename to en/product-documents/units/m5go_unit_makey.rst diff --git a/en/product-documents/STEAM Kit/M5GO/units/m5go_unit_pir.rst b/en/product-documents/units/m5go_unit_pir.rst similarity index 100% rename from en/product-documents/STEAM Kit/M5GO/units/m5go_unit_pir.rst rename to en/product-documents/units/m5go_unit_pir.rst diff --git a/en/product-documents/STEAM Kit/M5GO/units/m5go_unit_pot.rst b/en/product-documents/units/m5go_unit_pot.rst similarity index 100% rename from en/product-documents/STEAM Kit/M5GO/units/m5go_unit_pot.rst rename to en/product-documents/units/m5go_unit_pot.rst diff --git a/en/product-documents/STEAM Kit/M5GO/units/m5go_unit_proto.rst b/en/product-documents/units/m5go_unit_proto.rst similarity index 100% rename from en/product-documents/STEAM Kit/M5GO/units/m5go_unit_proto.rst rename to en/product-documents/units/m5go_unit_proto.rst diff --git a/en/product-documents/STEAM Kit/M5GO/units/m5go_unit_relay.rst b/en/product-documents/units/m5go_unit_relay.rst similarity index 100% rename from en/product-documents/STEAM Kit/M5GO/units/m5go_unit_relay.rst rename to en/product-documents/units/m5go_unit_relay.rst diff --git a/en/product-documents/STEAM Kit/M5GO/units/m5go_unit_rgb.rst b/en/product-documents/units/m5go_unit_rgb.rst similarity index 100% rename from en/product-documents/STEAM Kit/M5GO/units/m5go_unit_rgb.rst rename to en/product-documents/units/m5go_unit_rgb.rst diff --git a/en/product-documents/STEAM Kit/M5GO/units/m5go_unit_thermal.rst b/en/product-documents/units/m5go_unit_thermal.rst similarity index 100% rename from en/product-documents/STEAM Kit/M5GO/units/m5go_unit_thermal.rst rename to en/product-documents/units/m5go_unit_thermal.rst