diff --git a/en_build/doctrees/api-reference/button/button.doctree b/en_build/doctrees/api-reference/button/button.doctree index 567524d4..fda2d2af 100644 Binary files a/en_build/doctrees/api-reference/button/button.doctree and b/en_build/doctrees/api-reference/button/button.doctree differ diff --git a/en_build/doctrees/api-reference/index.doctree b/en_build/doctrees/api-reference/index.doctree index eed25a36..3d6fc7f9 100644 Binary files a/en_build/doctrees/api-reference/index.doctree and b/en_build/doctrees/api-reference/index.doctree differ diff --git a/en_build/doctrees/environment.pickle b/en_build/doctrees/environment.pickle index f0025dc9..1120df96 100644 Binary files a/en_build/doctrees/environment.pickle and b/en_build/doctrees/environment.pickle differ diff --git a/en_build/doctrees/get-started/M5GO/get_started_M5GO_ThermalCam.doctree b/en_build/doctrees/get-started/M5GO/get_started_M5GO_ThermalCam.doctree index 79253e11..c228bcbf 100644 Binary files a/en_build/doctrees/get-started/M5GO/get_started_M5GO_ThermalCam.doctree and b/en_build/doctrees/get-started/M5GO/get_started_M5GO_ThermalCam.doctree differ diff --git a/en_build/doctrees/get-started/M5Stack_Core_Get_Started.doctree b/en_build/doctrees/get-started/M5Stack_Core_Get_Started.doctree index dc4198d0..814052f4 100644 Binary files a/en_build/doctrees/get-started/M5Stack_Core_Get_Started.doctree and b/en_build/doctrees/get-started/M5Stack_Core_Get_Started.doctree differ diff --git a/en_build/doctrees/get-started/M5Stack_Core_Get_Started_Arduino_Mac_en.doctree b/en_build/doctrees/get-started/M5Stack_Core_Get_Started_Arduino_Mac_en.doctree deleted file mode 100644 index 6a43345d..00000000 Binary files a/en_build/doctrees/get-started/M5Stack_Core_Get_Started_Arduino_Mac_en.doctree and /dev/null differ diff --git a/en_build/doctrees/get-started/M5Stack_Core_Get_Started_Arduino_Windows_en.doctree b/en_build/doctrees/get-started/M5Stack_Core_Get_Started_Arduino_Windows_en.doctree deleted file mode 100644 index 376bf274..00000000 Binary files a/en_build/doctrees/get-started/M5Stack_Core_Get_Started_Arduino_Windows_en.doctree and /dev/null differ diff --git a/en_build/doctrees/get-started/M5Stack_Core_Get_Started_MicroPython_Windows_en.doctree b/en_build/doctrees/get-started/M5Stack_Core_Get_Started_MicroPython_Windows_en.doctree deleted file mode 100644 index 0d206310..00000000 Binary files a/en_build/doctrees/get-started/M5Stack_Core_Get_Started_MicroPython_Windows_en.doctree and /dev/null differ diff --git a/en_build/doctrees/get-started/add-idf_path-to-profile.doctree b/en_build/doctrees/get-started/add-idf_path-to-profile.doctree index 325fb8cd..deb8d3c9 100644 Binary files a/en_build/doctrees/get-started/add-idf_path-to-profile.doctree and b/en_build/doctrees/get-started/add-idf_path-to-profile.doctree differ diff --git a/en_build/doctrees/get-started/get-started-StepMotor.doctree b/en_build/doctrees/get-started/get-started-StepMotor.doctree index 2aeed7e5..8493c6ad 100644 Binary files a/en_build/doctrees/get-started/get-started-StepMotor.doctree and b/en_build/doctrees/get-started/get-started-StepMotor.doctree differ diff --git a/en_build/doctrees/get-started/how_to_burn_firmware.doctree b/en_build/doctrees/get-started/how_to_burn_firmware.doctree deleted file mode 100644 index 2d7c6821..00000000 Binary files a/en_build/doctrees/get-started/how_to_burn_firmware.doctree and /dev/null differ diff --git a/en_build/doctrees/get-started/how_to_burn_firmware_en.doctree b/en_build/doctrees/get-started/how_to_burn_firmware_en.doctree index 3158660c..2fda239c 100644 Binary files a/en_build/doctrees/get-started/how_to_burn_firmware_en.doctree and b/en_build/doctrees/get-started/how_to_burn_firmware_en.doctree differ diff --git a/en_build/doctrees/get-started/how_to_connect_wifi_using_core.doctree b/en_build/doctrees/get-started/how_to_connect_wifi_using_core.doctree index 2224c35f..f4abd250 100644 Binary files a/en_build/doctrees/get-started/how_to_connect_wifi_using_core.doctree and b/en_build/doctrees/get-started/how_to_connect_wifi_using_core.doctree differ diff --git a/en_build/doctrees/get-started/index.doctree b/en_build/doctrees/get-started/index.doctree index 78d3c240..81066a96 100644 Binary files a/en_build/doctrees/get-started/index.doctree and b/en_build/doctrees/get-started/index.doctree differ diff --git a/en_build/doctrees/get-started/m5stack_core_get_started.doctree b/en_build/doctrees/get-started/m5stack_core_get_started.doctree new file mode 100644 index 00000000..814052f4 Binary files /dev/null and b/en_build/doctrees/get-started/m5stack_core_get_started.doctree differ diff --git a/en_build/doctrees/get-started/m5stack_core_get_started_Arduino_Windows.doctree b/en_build/doctrees/get-started/m5stack_core_get_started_Arduino_Windows.doctree index 758119f5..27d45b35 100644 Binary files a/en_build/doctrees/get-started/m5stack_core_get_started_Arduino_Windows.doctree and b/en_build/doctrees/get-started/m5stack_core_get_started_Arduino_Windows.doctree differ diff --git a/en_build/doctrees/get-started/m5stack_core_get_started_MicroPython.doctree b/en_build/doctrees/get-started/m5stack_core_get_started_MicroPython.doctree index 8c7626bd..aff56f4a 100644 Binary files a/en_build/doctrees/get-started/m5stack_core_get_started_MicroPython.doctree and b/en_build/doctrees/get-started/m5stack_core_get_started_MicroPython.doctree differ diff --git a/en_build/doctrees/get-started/m5stack_core_get_started_MicroPython_MacOS.doctree b/en_build/doctrees/get-started/m5stack_core_get_started_MicroPython_MacOS.doctree deleted file mode 100644 index c778bf6e..00000000 Binary files a/en_build/doctrees/get-started/m5stack_core_get_started_MicroPython_MacOS.doctree and /dev/null differ diff --git a/en_build/doctrees/get-started/m5stack_core_get_started_MicroPython_Windows.doctree b/en_build/doctrees/get-started/m5stack_core_get_started_MicroPython_Windows.doctree deleted file mode 100644 index ab002f7c..00000000 Binary files a/en_build/doctrees/get-started/m5stack_core_get_started_MicroPython_Windows.doctree and /dev/null differ diff --git a/en_build/doctrees/get-started/m5tack_core_get_started_Arduino_MacOS.doctree b/en_build/doctrees/get-started/m5tack_core_get_started_Arduino_MacOS.doctree deleted file mode 100644 index 730536a1..00000000 Binary files a/en_build/doctrees/get-started/m5tack_core_get_started_Arduino_MacOS.doctree and /dev/null differ diff --git a/en_build/doctrees/get-started/practices_blockly.doctree b/en_build/doctrees/get-started/practices_blockly.doctree index dbc1af79..bc67c894 100644 Binary files a/en_build/doctrees/get-started/practices_blockly.doctree and b/en_build/doctrees/get-started/practices_blockly.doctree differ diff --git a/en_build/doctrees/get-started/upgrade_m5stack_lib.doctree b/en_build/doctrees/get-started/upgrade_m5stack_lib.doctree index 4fc61959..5cc288b6 100644 Binary files a/en_build/doctrees/get-started/upgrade_m5stack_lib.doctree and b/en_build/doctrees/get-started/upgrade_m5stack_lib.doctree differ diff --git a/en_build/doctrees/index.doctree b/en_build/doctrees/index.doctree index 695721ce..65c372ff 100644 Binary files a/en_build/doctrees/index.doctree and b/en_build/doctrees/index.doctree differ diff --git a/en_build/doctrees/m5stack-awesome/M5Stack-SD-Updater/index.doctree b/en_build/doctrees/m5stack-awesome/M5Stack-SD-Updater/index.doctree index 3640490c..d31811a8 100644 Binary files a/en_build/doctrees/m5stack-awesome/M5Stack-SD-Updater/index.doctree and b/en_build/doctrees/m5stack-awesome/M5Stack-SD-Updater/index.doctree differ diff --git a/en_build/doctrees/m5stack-awesome/M5Widgets/index.doctree b/en_build/doctrees/m5stack-awesome/M5Widgets/index.doctree index 2556be41..7f480549 100644 Binary files a/en_build/doctrees/m5stack-awesome/M5Widgets/index.doctree and b/en_build/doctrees/m5stack-awesome/M5Widgets/index.doctree differ diff --git a/en_build/doctrees/m5stack-awesome/TFT_eSPI/index.doctree b/en_build/doctrees/m5stack-awesome/TFT_eSPI/index.doctree index 6ef1f0bb..ddb91b9e 100644 Binary files a/en_build/doctrees/m5stack-awesome/TFT_eSPI/index.doctree and b/en_build/doctrees/m5stack-awesome/TFT_eSPI/index.doctree differ diff --git a/en_build/doctrees/m5stack-faq/M5Stack-Core/index.doctree b/en_build/doctrees/m5stack-faq/M5Stack-Core/index.doctree index 6b1bf81a..73cf120b 100644 Binary files a/en_build/doctrees/m5stack-faq/M5Stack-Core/index.doctree and b/en_build/doctrees/m5stack-faq/M5Stack-Core/index.doctree differ diff --git a/en_build/doctrees/m5stack-faq/m5stack-module/index.doctree b/en_build/doctrees/m5stack-faq/m5stack-module/index.doctree index 8879287f..d190939f 100644 Binary files a/en_build/doctrees/m5stack-faq/m5stack-module/index.doctree and b/en_build/doctrees/m5stack-faq/m5stack-module/index.doctree differ diff --git a/en_build/doctrees/product-documents/ROBOT/BALA.doctree b/en_build/doctrees/product-documents/ROBOT/BALA.doctree deleted file mode 100644 index 8001dbea..00000000 Binary files a/en_build/doctrees/product-documents/ROBOT/BALA.doctree and /dev/null differ diff --git a/en_build/doctrees/product-documents/STEAM Kit/M5GO/m5go.doctree b/en_build/doctrees/product-documents/STEAM Kit/M5GO/m5go.doctree deleted file mode 100644 index 2a29d4a2..00000000 Binary files a/en_build/doctrees/product-documents/STEAM Kit/M5GO/m5go.doctree and /dev/null differ diff --git a/en_build/doctrees/product-documents/STEAM Kit/M5GO/units/m5go_unit_3.96port.doctree b/en_build/doctrees/product-documents/STEAM Kit/M5GO/units/m5go_unit_3.96port.doctree deleted file mode 100644 index 5a6fe215..00000000 Binary files a/en_build/doctrees/product-documents/STEAM Kit/M5GO/units/m5go_unit_3.96port.doctree and /dev/null differ diff --git a/en_build/doctrees/product-documents/STEAM Kit/M5GO/units/m5go_unit_earth.doctree b/en_build/doctrees/product-documents/STEAM Kit/M5GO/units/m5go_unit_earth.doctree deleted file mode 100644 index cc526e15..00000000 Binary files a/en_build/doctrees/product-documents/STEAM Kit/M5GO/units/m5go_unit_earth.doctree and /dev/null differ diff --git a/en_build/doctrees/product-documents/STEAM Kit/M5GO/units/m5go_unit_env.doctree b/en_build/doctrees/product-documents/STEAM Kit/M5GO/units/m5go_unit_env.doctree deleted file mode 100644 index 96fcf06c..00000000 Binary files a/en_build/doctrees/product-documents/STEAM Kit/M5GO/units/m5go_unit_env.doctree and /dev/null differ diff --git a/en_build/doctrees/product-documents/STEAM Kit/M5GO/units/m5go_unit_hub.doctree b/en_build/doctrees/product-documents/STEAM Kit/M5GO/units/m5go_unit_hub.doctree deleted file mode 100644 index 9c03fb01..00000000 Binary files a/en_build/doctrees/product-documents/STEAM Kit/M5GO/units/m5go_unit_hub.doctree and /dev/null differ diff --git a/en_build/doctrees/product-documents/STEAM Kit/M5GO/units/m5go_unit_ir.doctree b/en_build/doctrees/product-documents/STEAM Kit/M5GO/units/m5go_unit_ir.doctree deleted file mode 100644 index bf87c855..00000000 Binary files a/en_build/doctrees/product-documents/STEAM Kit/M5GO/units/m5go_unit_ir.doctree and /dev/null differ diff --git a/en_build/doctrees/product-documents/STEAM Kit/M5GO/units/m5go_unit_light.doctree b/en_build/doctrees/product-documents/STEAM Kit/M5GO/units/m5go_unit_light.doctree deleted file mode 100644 index 9d0d9b75..00000000 Binary files a/en_build/doctrees/product-documents/STEAM Kit/M5GO/units/m5go_unit_light.doctree and /dev/null differ diff --git a/en_build/doctrees/product-documents/STEAM Kit/M5GO/units/m5go_unit_makey.doctree b/en_build/doctrees/product-documents/STEAM Kit/M5GO/units/m5go_unit_makey.doctree deleted file mode 100644 index 39f18079..00000000 Binary files a/en_build/doctrees/product-documents/STEAM Kit/M5GO/units/m5go_unit_makey.doctree and /dev/null differ diff --git a/en_build/doctrees/product-documents/STEAM Kit/M5GO/units/m5go_unit_pir.doctree b/en_build/doctrees/product-documents/STEAM Kit/M5GO/units/m5go_unit_pir.doctree deleted file mode 100644 index 19c2ae84..00000000 Binary files a/en_build/doctrees/product-documents/STEAM Kit/M5GO/units/m5go_unit_pir.doctree and /dev/null differ diff --git a/en_build/doctrees/product-documents/STEAM Kit/M5GO/units/m5go_unit_pot.doctree b/en_build/doctrees/product-documents/STEAM Kit/M5GO/units/m5go_unit_pot.doctree deleted file mode 100644 index d2707cf2..00000000 Binary files a/en_build/doctrees/product-documents/STEAM Kit/M5GO/units/m5go_unit_pot.doctree and /dev/null differ diff --git a/en_build/doctrees/product-documents/STEAM Kit/M5GO/units/m5go_unit_proto.doctree b/en_build/doctrees/product-documents/STEAM Kit/M5GO/units/m5go_unit_proto.doctree deleted file mode 100644 index ace0835a..00000000 Binary files a/en_build/doctrees/product-documents/STEAM Kit/M5GO/units/m5go_unit_proto.doctree and /dev/null differ diff --git a/en_build/doctrees/product-documents/STEAM Kit/M5GO/units/m5go_unit_relay.doctree b/en_build/doctrees/product-documents/STEAM Kit/M5GO/units/m5go_unit_relay.doctree deleted file mode 100644 index 4c1aede5..00000000 Binary files a/en_build/doctrees/product-documents/STEAM Kit/M5GO/units/m5go_unit_relay.doctree and /dev/null differ diff --git a/en_build/doctrees/product-documents/STEAM Kit/M5GO/units/m5go_unit_rgb.doctree b/en_build/doctrees/product-documents/STEAM Kit/M5GO/units/m5go_unit_rgb.doctree deleted file mode 100644 index 90cd2ecb..00000000 Binary files a/en_build/doctrees/product-documents/STEAM Kit/M5GO/units/m5go_unit_rgb.doctree and /dev/null differ diff --git a/en_build/doctrees/product-documents/STEAM Kit/M5GO/units/m5go_unit_thermal.doctree b/en_build/doctrees/product-documents/STEAM Kit/M5GO/units/m5go_unit_thermal.doctree deleted file mode 100644 index 202bf2ab..00000000 Binary files a/en_build/doctrees/product-documents/STEAM Kit/M5GO/units/m5go_unit_thermal.doctree and /dev/null differ diff --git a/en_build/doctrees/product-documents/accessorries/cables/cable.doctree b/en_build/doctrees/product-documents/accessorries/cables/cable.doctree index e125cffc..1c05e156 100644 Binary files a/en_build/doctrees/product-documents/accessorries/cables/cable.doctree and b/en_build/doctrees/product-documents/accessorries/cables/cable.doctree differ diff --git a/en_build/doctrees/product-documents/m5stack-core/index.doctree b/en_build/doctrees/product-documents/m5stack-core/index.doctree index 04aba197..2d44d959 100644 Binary files a/en_build/doctrees/product-documents/m5stack-core/index.doctree and b/en_build/doctrees/product-documents/m5stack-core/index.doctree differ diff --git a/en_build/doctrees/product-documents/m5stack-core/m5stack_basic.doctree b/en_build/doctrees/product-documents/m5stack-core/m5stack_basic.doctree index 5cd20532..d89b52da 100644 Binary files a/en_build/doctrees/product-documents/m5stack-core/m5stack_basic.doctree and b/en_build/doctrees/product-documents/m5stack-core/m5stack_basic.doctree differ diff --git a/en_build/doctrees/product-documents/m5stack-core/m5stack_faces.doctree b/en_build/doctrees/product-documents/m5stack-core/m5stack_faces.doctree index 69c29069..3a55ea3c 100644 Binary files a/en_build/doctrees/product-documents/m5stack-core/m5stack_faces.doctree and b/en_build/doctrees/product-documents/m5stack-core/m5stack_faces.doctree differ diff --git a/en_build/doctrees/product-documents/m5stack-core/m5stack_fire.doctree b/en_build/doctrees/product-documents/m5stack-core/m5stack_fire.doctree index d22273aa..7c0fabfe 100644 Binary files a/en_build/doctrees/product-documents/m5stack-core/m5stack_fire.doctree and b/en_build/doctrees/product-documents/m5stack-core/m5stack_fire.doctree differ diff --git a/en_build/doctrees/product-documents/m5stack-core/m5stack_panda.doctree b/en_build/doctrees/product-documents/m5stack-core/m5stack_panda.doctree index e6716ae6..4228a387 100644 Binary files a/en_build/doctrees/product-documents/m5stack-core/m5stack_panda.doctree and b/en_build/doctrees/product-documents/m5stack-core/m5stack_panda.doctree differ diff --git a/en_build/doctrees/product-documents/m5stack-core/m5stack_plc.doctree b/en_build/doctrees/product-documents/m5stack-core/m5stack_plc.doctree deleted file mode 100644 index a35627c2..00000000 Binary files a/en_build/doctrees/product-documents/m5stack-core/m5stack_plc.doctree and /dev/null differ diff --git a/en_build/doctrees/product-documents/modules/m5stack_battery_module.doctree b/en_build/doctrees/product-documents/modules/m5stack_battery_module.doctree index c27eee5a..8df3167b 100644 Binary files a/en_build/doctrees/product-documents/modules/m5stack_battery_module.doctree and b/en_build/doctrees/product-documents/modules/m5stack_battery_module.doctree differ diff --git a/en_build/doctrees/product-documents/modules/m5stack_btc_module.doctree b/en_build/doctrees/product-documents/modules/m5stack_btc_module.doctree index b0aa137c..0c5fefda 100644 Binary files a/en_build/doctrees/product-documents/modules/m5stack_btc_module.doctree and b/en_build/doctrees/product-documents/modules/m5stack_btc_module.doctree differ diff --git a/en_build/doctrees/product-documents/modules/m5stack_sim800_module.doctree b/en_build/doctrees/product-documents/modules/m5stack_sim800_module.doctree index 37590fce..59f873d0 100644 Binary files a/en_build/doctrees/product-documents/modules/m5stack_sim800_module.doctree and b/en_build/doctrees/product-documents/modules/m5stack_sim800_module.doctree differ diff --git a/en_build/doctrees/product-documents/units/a.doctree b/en_build/doctrees/product-documents/units/a.doctree deleted file mode 100644 index ea5a1ffc..00000000 Binary files a/en_build/doctrees/product-documents/units/a.doctree and /dev/null differ diff --git a/en_build/doctrees/product-documents/units/m5go_unit_ir.doctree b/en_build/doctrees/product-documents/units/m5go_unit_ir.doctree index a9251e94..0d3bd60f 100644 Binary files a/en_build/doctrees/product-documents/units/m5go_unit_ir.doctree and b/en_build/doctrees/product-documents/units/m5go_unit_ir.doctree differ diff --git a/en_build/doctrees/product-documents/units/m5go_unit_pot.doctree b/en_build/doctrees/product-documents/units/m5go_unit_pot.doctree index 47ee65ce..9e3bee31 100644 Binary files a/en_build/doctrees/product-documents/units/m5go_unit_pot.doctree and b/en_build/doctrees/product-documents/units/m5go_unit_pot.doctree differ diff --git a/en_build/doctrees/product-documents/units/m5go_unit_thermal.doctree b/en_build/doctrees/product-documents/units/m5go_unit_thermal.doctree index bf83ea31..5a291b35 100644 Binary files a/en_build/doctrees/product-documents/units/m5go_unit_thermal.doctree and b/en_build/doctrees/product-documents/units/m5go_unit_thermal.doctree differ diff --git a/en_build/doctrees/resources.doctree b/en_build/doctrees/resources.doctree index 045c5ec4..70634cca 100644 Binary files a/en_build/doctrees/resources.doctree and b/en_build/doctrees/resources.doctree differ diff --git a/en_build/html/_images/ESP32CAM.jpg b/en_build/html/_images/ESP32CAM.jpg deleted file mode 100644 index 675dc4ae..00000000 Binary files a/en_build/html/_images/ESP32CAM.jpg and /dev/null differ diff --git a/en_build/html/_images/FactoryTest_result.png b/en_build/html/_images/FactoryTest_result.png deleted file mode 100644 index ab97ede8..00000000 Binary files a/en_build/html/_images/FactoryTest_result.png and /dev/null differ diff --git a/en_build/html/_images/WebIDE_check_code.png b/en_build/html/_images/WebIDE_check_code.png deleted file mode 100644 index 202c78bb..00000000 Binary files a/en_build/html/_images/WebIDE_check_code.png and /dev/null differ diff --git a/en_build/html/_images/arduino_path.png b/en_build/html/_images/arduino_path.png deleted file mode 100644 index f88b1bae..00000000 Binary files a/en_build/html/_images/arduino_path.png and /dev/null differ diff --git a/en_build/html/_images/connecting.png b/en_build/html/_images/connecting.png deleted file mode 100644 index c0af1a2d..00000000 Binary files a/en_build/html/_images/connecting.png and /dev/null differ diff --git a/en_build/html/_images/create_a_new_project.png b/en_build/html/_images/create_a_new_project.png deleted file mode 100644 index eb1bc1c7..00000000 Binary files a/en_build/html/_images/create_a_new_project.png and /dev/null differ diff --git a/en_build/html/_images/display_hello_world1.png b/en_build/html/_images/display_hello_world1.png deleted file mode 100644 index d4ffae69..00000000 Binary files a/en_build/html/_images/display_hello_world1.png and /dev/null differ diff --git a/en_build/html/_images/download_idf.png b/en_build/html/_images/download_idf.png deleted file mode 100644 index 90d21ebd..00000000 Binary files a/en_build/html/_images/download_idf.png and /dev/null differ diff --git a/en_build/html/_images/download_idf1.png b/en_build/html/_images/download_idf1.png deleted file mode 100644 index 90d21ebd..00000000 Binary files a/en_build/html/_images/download_idf1.png and /dev/null differ diff --git a/en_build/html/_images/download_m5stack_lib.png b/en_build/html/_images/download_m5stack_lib.png deleted file mode 100644 index e90782b6..00000000 Binary files a/en_build/html/_images/download_m5stack_lib.png and /dev/null differ diff --git a/en_build/html/_images/download_xtensa_tools.png b/en_build/html/_images/download_xtensa_tools.png deleted file mode 100644 index c5156796..00000000 Binary files a/en_build/html/_images/download_xtensa_tools.png and /dev/null differ diff --git a/en_build/html/_images/incompatible.jpg b/en_build/html/_images/incompatible.jpg deleted file mode 100644 index 8157954e..00000000 Binary files a/en_build/html/_images/incompatible.jpg and /dev/null differ diff --git a/en_build/html/_images/m5-arduino.jpg b/en_build/html/_images/m5-arduino.jpg deleted file mode 100644 index cc13dbc3..00000000 Binary files a/en_build/html/_images/m5-arduino.jpg and /dev/null differ diff --git a/en_build/html/_images/m5-micropython.jpg b/en_build/html/_images/m5-micropython.jpg deleted file mode 100644 index f5f25a18..00000000 Binary files a/en_build/html/_images/m5-micropython.jpg and /dev/null differ diff --git a/en_build/html/_images/m5go.jpg b/en_build/html/_images/m5go.jpg new file mode 100644 index 00000000..61cdcc53 Binary files /dev/null and b/en_build/html/_images/m5go.jpg differ diff --git a/en_build/html/_images/macos-logo.png b/en_build/html/_images/macos-logo.png deleted file mode 100644 index 289d1f60..00000000 Binary files a/en_build/html/_images/macos-logo.png and /dev/null differ diff --git a/en_build/html/_images/micropython_logo.png b/en_build/html/_images/micropython_logo.png deleted file mode 100644 index 7af4d6b9..00000000 Binary files a/en_build/html/_images/micropython_logo.png and /dev/null differ diff --git a/en_build/html/_images/mkdir_espressif.png b/en_build/html/_images/mkdir_espressif.png deleted file mode 100644 index a770caa8..00000000 Binary files a/en_build/html/_images/mkdir_espressif.png and /dev/null differ diff --git a/en_build/html/_images/select_arduino_lib.png b/en_build/html/_images/select_arduino_lib.png deleted file mode 100644 index e820d183..00000000 Binary files a/en_build/html/_images/select_arduino_lib.png and /dev/null differ diff --git a/en_build/html/_images/select_board_and_com.png b/en_build/html/_images/select_board_and_com.png deleted file mode 100644 index 4476f38d..00000000 Binary files a/en_build/html/_images/select_board_and_com.png and /dev/null differ diff --git a/en_build/html/_images/select_board_and_com1.png b/en_build/html/_images/select_board_and_com1.png deleted file mode 100644 index 4476f38d..00000000 Binary files a/en_build/html/_images/select_board_and_com1.png and /dev/null differ diff --git a/en_build/html/_images/select_demo.png b/en_build/html/_images/select_demo.png deleted file mode 100644 index 45183285..00000000 Binary files a/en_build/html/_images/select_demo.png and /dev/null differ diff --git a/en_build/html/_images/select_get_exe_file.png b/en_build/html/_images/select_get_exe_file.png deleted file mode 100644 index 9d715826..00000000 Binary files a/en_build/html/_images/select_get_exe_file.png and /dev/null differ diff --git a/en_build/html/_images/select_m5stack_core_board.jpg b/en_build/html/_images/select_m5stack_core_board.jpg deleted file mode 100644 index 85623f22..00000000 Binary files a/en_build/html/_images/select_m5stack_core_board.jpg and /dev/null differ diff --git a/en_build/html/_images/windows_download_firmware.png b/en_build/html/_images/windows_download_firmware.png deleted file mode 100644 index d70843bf..00000000 Binary files a/en_build/html/_images/windows_download_firmware.png and /dev/null differ diff --git a/en_build/html/_sources/get-started/M5Stack_Core_Get_Started_Arduino_Mac_en.rst.txt b/en_build/html/_sources/get-started/M5Stack_Core_Get_Started_Arduino_Mac_en.rst.txt deleted file mode 100644 index 599c64b7..00000000 --- a/en_build/html/_sources/get-started/M5Stack_Core_Get_Started_Arduino_Mac_en.rst.txt +++ /dev/null @@ -1,127 +0,0 @@ -M5Stack-Core Get Started(MacOS, Arduino) -======================================== - -CONTENT -~~~~~~~ - -1. `Setting Environment <#setting-environment>`__ - - - `1. Install Arduino IDE <#1-install-arduino-ide>`__ - - - `2. ESP32 Board Support <#2-esp32-board-support>`__ - - - `3. Install M5Stack Library <#3-install-m5stack-library>`__ - -2. `Upload an Example Sketch <#upload-an-example-sketch>`__ - -Setting Environment -~~~~~~~~~~~~~~~~~~~ - -*Before setting the development environment, we suggest you confirm -whether the USB driver was installed. If not, please visit this link -``establish serial connection``.* TODO: add a link - -1. Install ``Arduino IDE`` -^^^^^^^^^^^^^^^^^^^^^^^^^^ - -If you don't already have the Arduino IDE installed, make sure to -install it. You can download it here -https://www.arduino.cc/en/Main/Software - -.. image:: ../../_static/getting_started_pics/m5stack_core/macOS_download_arduino_ide.png - -2. ESP32 Board Support -^^^^^^^^^^^^^^^^^^^^^^ - -Open Terminal (if you've never used the terminal before, it can be found -in Applications > Utilities > Terminal) and execute the following -command (copy->paste and hit enter): - -:: - - - mkdir -p ~/Documents/Arduino/hardware/espressif && \ - cd ~/Documents/Arduino/hardware/espressif && \ - git clone https://github.com/espressif/arduino-esp32.git esp32 && \ - cd esp32 && \ - git submodule update --init --recursive && \ - cd tools && \ - python get.py - -Where ~/Documents/Arduino represents your default sketch book location. -If you encounter any problems it could be that your Arduino sketchbook -folder is in a different location. This can be found by running arduino -and navigating through the menu to "Arduino" > "Preferences" > -"Sketchbook location". Adjust the command above accordingly if -necessary! - -.. note:: - - * If you get the error below: ``xcrun: error: invalid active developer path (/Library/Developer/CommandLineTools),`` - ``missing xcrun at: /Library/Developer/CommandLineTools/usr/bin/xcrun``, install the command line dev tools by typing ``xcode-select --install`` into the terminal and hit enter. once installed try the command above again and restart the Arduino IDE. - - * If you get the error: ``IOError: [Errno socket error] [SSL: TLSV1_ALERT_PROTOCOL_VERSION] tlsv1 alert protocol`` - ``version (_ssl.c:590) when running python get.py``, try ``python3`` instead of ``python`` and restart the Arduino IDE. - -3. Install M5Stack Library -^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Start up the Arduino IDE, then Select -``Sketch``->``Include Library``->``Manage Libraries...`` Type -``M5Stack`` into the search box, choose the library marked "Library for -M5Stack Core development kit" and install it. - -.. image:: ../../_static/getting_started_pics/m5stack_core/macOS_install_m5stack_lib.png - -.. image:: ../../_static/getting_started_pics/m5stack_core/macOS_search_m5stack.png - -Upload an Example Sketch -~~~~~~~~~~~~~~~~~~~~~~~~ - -1. Select your board and the serial port -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -After connecting the M5 to your computer via the USB cable. Start up the -Arduino IDE, and click ``Tools -> Boards -> M5Stack-Core-ESP32`` to -select your board - -.. image:: ../../_static/getting_started_pics/m5stack_core/macOS_select_board.png - -Click ``Tools -> Ports ->`` to select the serial port which your M5Stack -Core is connected to. It should be called something like -``/dev/cu.SLAB_USBtoUART`` - -.. image:: ../../_static/getting_started_pics/m5stack_core/macOS_select_serial_port.png - -2. Select an example -~~~~~~~~~~~~~~~~~~~~ - -Click ``File-> Examples``. there are some test programs in ``M5Stack->`` - -Try to open a sketch called ``HelloWorld`` inside Basics. - -.. image:: ../../_static/getting_started_pics/m5stack_core/macOS_select_example.png - -Compile and upload it, the M5Stack screen will show "Hello World!" - -.. image:: ../../_static/getting_started_pics/m5stack_core/display_hello_world.png - -Note -~~~~ - -Although most versions of MacOS have no problem with detecting the COM -port, on some newer versions of High Sierra sometimes Slab\_USBtoUART -does not appear. If this is the case, after you connect the M5 open -``security and privacy`` in the system preferences and set it to -``permit``. - -.. image:: ../../_static/getting_started_pics/m5stack_core/macOS_security_and_privacy.png - -.. image:: ../../_static/getting_started_pics/m5stack_core/macOS_security_and_privacy_01.png - -.. image:: ../../_static/getting_started_pics/m5stack_core/macOS_security_and_privacy_02.png - -.. note:: - - **If you want to read more the permission about the CP2104 USB driver, visit the below link please.** - https://developer.apple.com/library/archive/technotes/tn2459/\_index.html diff --git a/en_build/html/_sources/get-started/M5Stack_Core_Get_Started_Arduino_Windows_en.rst.txt b/en_build/html/_sources/get-started/M5Stack_Core_Get_Started_Arduino_Windows_en.rst.txt deleted file mode 100644 index 926aa12a..00000000 --- a/en_build/html/_sources/get-started/M5Stack_Core_Get_Started_Arduino_Windows_en.rst.txt +++ /dev/null @@ -1,148 +0,0 @@ -M5Stack-Core Get Started(Windows, Arduino) -========================================== - -.. note:: - If your OS is MacOS, please click `here`_ - -.. _here: M5Stack_Core_Get_Started_Arduino_Mac_en.html - - -CONTENT -~~~~~~~ - -1. `Setting Environment <#setting-environment>`__ - - - `1. Install Arduino IDE <#1-install-arduino-ide>`__ - - - `2. Download Toolchain <#2-download-toolchain>`__ - - - `3. ESP32 Toolchain <#3-esp32-toolchain>`__ - - - `4. Download M5Stack Lib <#4-download-m5stack-lib>`__ - -2. `Example <#example>`__ - -.. note:: - - If you want to upgrade the M5Stack Lib, please view this article `upgrade M5Stack Lib`_ - -.. _upgrade M5Stack Lib: upgrade_m5stack_lib.html - - -Setting Environment -~~~~~~~~~~~~~~~~~~~ - -Before setting the development environment, we suggest you confirm -whether the USB driver has installed. If not, please visit this link -``establish serial connection``. - -1. Install ``Arduino IDE`` -^^^^^^^^^^^^^^^^^^^^^^^^^^ - -*download address* https://www.arduino.cc/en/Main/Software - -.. image:: ../../_static/screenshots/arduino_cc_package.png - -modified the path of Arduino as ``D:\Program Files`` as shown below - -.. image:: ../../_static/screenshots/select_arduino_install_path.png - -Now my path of Arduino is ``D:\Program Files\Arduino`` - -.. image:: ../../_static/screenshots/arduino_path.png - -2. Download Toolchain -^^^^^^^^^^^^^^^^^^^^^ - -（Now my path of Arduino is ``D:\Program Files\Arduino``\ ） - -Enter the path ``D:\Program Files\Arduino\hareware`` via the terminal of -Windows - -Execute the following commands on the terminal of Windows > \* new a -directory named ``espressif``, then enter this directory - -mkdir espressif && cd espressif - -.. image:: ../../_static/screenshots/mkdir_espressif.png - - - - clone ``esp32 idf`` at the directory named ``esp32`` - -git clone --recursive https://github.com/espressif/arduino-esp32.git -esp32 - -.. image:: ../../_static/screenshots/download_idf.png - -3. ESP32 Toolchain -^^^^^^^^^^^^^^^^^^ - -Enter the path -``D:\Program Files\arduino\hardware\espressif\esp32\tools`` double click -on ``get.exe`` - -.. image:: ../../_static/screenshots/select_get_exe_file.png - -.. image:: ../../_static/screenshots/download_xtensa_tools.png - -4. Download the M5Stack Lib via Arduino IDE -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Open Arduino IDE, then Select -``Sketch``->``Include Library``->``Manage Libraries...`` Search -``M5Stack`` and install it - -.. image:: ../../_static/screenshots/select_arduino_lib.png - -.. image:: ../../_static/screenshots/download_m5stack_lib.png - -Example -~~~~~~~ - -The USB cable connects to M5Stack Core, then select your serial port -which is connected M5Stack Core. Select a demo example, compile and -upload - -1. Open a example likes ``FactoryTest.ino`` -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -.. image:: ../../_static/screenshots/select_demo.png - -Comfire your board name, baudrate, the specified serial port: -M5Stack-Core-ESP32、921600、COM3 - -.. image:: ../../_static/screenshots/select_board_and_com.png - -After upload seccessfully, open the Serial Monitor - -.. image:: ../../_static/screenshots/FactoryTest_result.png - -2. New a M5Stack program -^^^^^^^^^^^^^^^^^^^^^^^^ - -Open Arduino IDE, then new a ``.ino`` file, rename it as ``my_test.ino`` - -Copy the below code to my\_test.ino - -.. code:: cpp - - #include - - // the setup routine runs once when M5Stack starts up - void setup(){tack - - // Initialize the M5Stack object - M5.begin(); - - // LCD display - M5.Lcd.print("Hello World!"); - M5.Lcd.print("M5Stack is running successfully!"); - } - - // the loop routine runs over and over again forever - void loop() { - - } - -compile it and upload, the M5Stack screen will show "Hello World!" -"M5Stack is running successfully!" diff --git a/en_build/html/_sources/get-started/M5Stack_Core_Get_Started_MicroPython_Windows_en.rst.txt b/en_build/html/_sources/get-started/M5Stack_Core_Get_Started_MicroPython_Windows_en.rst.txt deleted file mode 100644 index b7afcba2..00000000 --- a/en_build/html/_sources/get-started/M5Stack_Core_Get_Started_MicroPython_Windows_en.rst.txt +++ /dev/null @@ -1,140 +0,0 @@ -M5Stack-Core Get Started(Windows, MicroPython) -============================================== - -CONTENT -~~~~~~~ - -1. `Burn Firmware <#Burn-Firmwared>`__ - - - `1. Download Firmware <#1-download-firmware>`__ - - - `2. Burn to M5Stack <#2-Burn-to-M5Stack>`__ - -2. `Connect Wi-Fi <#connect-wi-fi>`__ - -3. `Binding device <#binding-device>`__ - -4. `Coding MicroPython <#coding-micropython>`__ - -Burn Firmware -~~~~~~~~~~~~~ - -1. Download Firmware -^^^^^^^^^^^^^^^^^^^^ - -https://github.com/m5stack/M5Cloud/tree/master/firmwares - -Now, the M5Cloud firmware I downloaded named -``m5cloud-20180516-v0.4.0.bin`` and it saved at ``~/smbshare`` - -2. Burn to M5Stack -^^^^^^^^^^^^^^^^^^ - -+-----------+-----------+-----------+ -| |image| | |image| | |image| | -+===========+===========+===========+ -| Windows | Linux | MacOS | -+-----------+-----------+-----------+ - -***Windows*** - -open Flash Download -Tools(\ `点击下载 `__) -apply by Espressif, choose ``ESP32 DownloadTool`` option and execute -three steps ( *choose firmware file, your serial port, erase and program -flash* ) as shown below - -.. figure:: ../../_static/M5Stack_MicroPython_UserGuidePictures/windows_download_firmware.png - :alt: image - - image -***MacOS/Linux*** - -*1. Check port on Linux and MacOS* - -To check the device name for the serial port of your M5Stack board (or -external converter dongle), run this command two times, first with the -board / dongle unplugged, then with plugged in. The port which appears -the second time is the one you need: - -Linux - -``ls /dev/tty*`` - -MacOS - -``ls /dev/cu.*`` - -*2. Adding user to ``dialout`` on Linux* - -The currently logged user should have read and write access the serial -port over USB. On most Linux distributions, this is done by adding the -user to ``dialout`` group with the following command: - -``sudo usermod -a -G dialout $USER`` Now, my serial port named -``ttyUSB0`` - -*3. Download M5Cloud firmware to M5Stack board* - Installing esptool： -``pip install esptool`` - Erase flash on M5Stack: -``esptool.py --chip esp32 --port /dev/ttyUSB0 erase_flash`` - Download -firmware to M5Stack: -``esptool.py --chip esp32 --port /dev/ttyUSB0 write_flash --flash_mode dio -z 0x1000 m5cloud-20180516-v0.4.0.bin`` - -Connect Wi-Fi -~~~~~~~~~~~~~ - -Mobile Phone or PC connect to M5Stack AP(like ``M5Stack-a67c``), and -then open brower to login 192.168.4.1 setting your LAN SSID and Password - -.. figure:: ../../_static/M5Stack_MicroPython_UserGuidePictures/m5stack_connet_wifi.png - :alt: image - - image -Binding device -~~~~~~~~~~~~~~ - -*1.login http://io.m5stack.com and register your own account(or login -your account)* - -*2. press ``Device->Add`` buttom on M5Cloud IDE for binding M5Stack -board to your account* - -*3. Input the Check Code for the M5Stack screen display，Check Code is -random, after 60s will refresh* - -.. figure:: ../../_static/M5Stack_MicroPython_UserGuidePictures/WebIDE_check_code.png - :alt: image - - image -Coding MicroPython -~~~~~~~~~~~~~~~~~~ - -*1. create a new python project* - -.. figure:: ../../_static/M5Stack_MicroPython_UserGuidePictures/create_a_new_project.png - :alt: image - - image -*2. write your own code and press ``Upload & Run`` buttom on the M5Cloud -IDE* - -copy below code to ``main.py`` file and press ``Upload & Run`` - -.. code:: python - - from m5stack import lcd - - lcd.clear() - lcd.setCursor(0, 0) - lcd.setColor(lcd.WHITE) - - lcd.print("Hello World!") - -.. figure:: ../../_static/M5Stack_MicroPython_UserGuidePictures/display_hello_world.png - :alt: image - - image - -.. |image| image:: ../../_static/windows-logo.png -.. |image| image:: ../../_static/linux-logo.png -.. |image| image:: ../../_static/macos-logo.png diff --git a/en_build/html/_sources/get-started/how_to_burn_firmware.rst.txt b/en_build/html/_sources/get-started/how_to_burn_firmware.rst.txt deleted file mode 100644 index e69de29b..00000000 diff --git a/en_build/html/_sources/get-started/m5stack_core_get_started.rst.txt b/en_build/html/_sources/get-started/m5stack_core_get_started.rst.txt new file mode 100644 index 00000000..65f706d1 --- /dev/null +++ b/en_build/html/_sources/get-started/m5stack_core_get_started.rst.txt @@ -0,0 +1,17 @@ +M5Stack Core Get Started +============================================== + +Pick up your programming mode below for getting started +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +============================ ============================ +|Arduino|_ |Blockly/MicroPython|_ +---------------------------- ---------------------------- +`Arduino`_ `Blockly/MicroPython`_ +============================ ============================ + +.. |Arduino| image:: ../../_static/getting_started_pics/arduino_logo.png +.. |Blockly/MicroPython| image:: ../../_static/getting_started_pics/blockly_and_micropython.png + +.. _Arduino: m5stack_core_get_started_Arduino_MacOS.html +.. _Blockly/MicroPython: m5stack_core_get_started_MicroPython.html diff --git a/en_build/html/_sources/get-started/m5stack_core_get_started_MicroPython_MacOS.rst.txt b/en_build/html/_sources/get-started/m5stack_core_get_started_MicroPython_MacOS.rst.txt deleted file mode 100644 index a4355b45..00000000 --- a/en_build/html/_sources/get-started/m5stack_core_get_started_MicroPython_MacOS.rst.txt +++ /dev/null @@ -1,7 +0,0 @@ -M5Stack Core Get Started(MacOS, MicroPython) -======================================== - -.. note:: - If your OS is Windows, please click `here`_. - -.. _here: m5stack_core_get_started_MicroPython_Windows.html diff --git a/en_build/html/_sources/get-started/m5stack_core_get_started_MicroPython_Windows.rst.txt b/en_build/html/_sources/get-started/m5stack_core_get_started_MicroPython_Windows.rst.txt deleted file mode 100644 index b26cf93c..00000000 --- a/en_build/html/_sources/get-started/m5stack_core_get_started_MicroPython_Windows.rst.txt +++ /dev/null @@ -1,156 +0,0 @@ -M5Stack Core Get Started(Windows, MicroPython) -============================================== - -CONTENT -~~~~~~~ - -1. `Burn Firmware <#Burn-Firmwared>`__ - - - `1. Download Firmware <#1-download-firmware>`__ - - - `2. Burn to M5Stack <#2-Burn-to-M5Stack>`__ - -2. `Connect Wi-Fi <#connect-wi-fi>`__ - -3. `Binding device <#binding-device>`__ - -4. `Coding MicroPython <#coding-micropython>`__ - -.. note:: - Before programing through Blockly(or MicroPython), you need to burn a appropriate firmware to your board follwing this article `How to burn firmare`_. - -.. _How to burn firmare: how_to_burn_firmware_en.html - -Connect the LAN -~~~~~~~~~~~~~~~~ - -.. note:: - - M5Flow和M5GO连接wifi的界面和步骤完全不一样 - 输入checkcode也是不一样 - 连接也是不一样 - - m5cloud m5go m5flow - -Burn Firmware -~~~~~~~~~~~~~ - -1. Download Firmware -^^^^^^^^^^^^^^^^^^^^ - -https://github.com/m5stack/M5Cloud/tree/master/firmwares - -Now, the M5Cloud firmware I downloaded named -``m5cloud-20180516-v0.4.0.bin`` and it saved at ``~/smbshare`` - -2. Burn to M5Stack -^^^^^^^^^^^^^^^^^^ - -+-----------+-----------+-----------+ -| |image| | |image| | |image| | -+===========+===========+===========+ -| Windows | Linux | MacOS | -+-----------+-----------+-----------+ - -***Windows*** - -open Flash Download -Tools(\ `点击下载 `__) -apply by Espressif, choose ``ESP32 DownloadTool`` option and execute -three steps ( *choose firmware file, your serial port, erase and program -flash* ) as shown below - -.. figure:: ../../_static/M5Stack_MicroPython_UserGuidePictures/windows_download_firmware.png - :alt: image - - image -***MacOS/Linux*** - -*1. Check port on Linux and MacOS* - -To check the device name for the serial port of your M5Stack board (or -external converter dongle), run this command two times, first with the -board / dongle unplugged, then with plugged in. The port which appears -the second time is the one you need: - -Linux - -``ls /dev/tty*`` - -MacOS - -``ls /dev/cu.*`` - -*2. Adding user to ``dialout`` on Linux* - -The currently logged user should have read and write access the serial -port over USB. On most Linux distributions, this is done by adding the -user to ``dialout`` group with the following command: - -``sudo usermod -a -G dialout $USER`` Now, my serial port named -``ttyUSB0`` - -*3. Download M5Cloud firmware to M5Stack board* - Installing esptool： -``pip install esptool`` - Erase flash on M5Stack: -``esptool.py --chip esp32 --port /dev/ttyUSB0 erase_flash`` - Download -firmware to M5Stack: -``esptool.py --chip esp32 --port /dev/ttyUSB0 write_flash --flash_mode dio -z 0x1000 m5cloud-20180516-v0.4.0.bin`` - -Connect Wi-Fi -~~~~~~~~~~~~~ - -Mobile Phone or PC connect to M5Stack AP(like ``M5Stack-a67c``), and -then open brower to login 192.168.4.1 setting your LAN SSID and Password - -.. figure:: ../../_static/M5Stack_MicroPython_UserGuidePictures/m5stack_connet_wifi.png - :alt: image - - image -Binding device -~~~~~~~~~~~~~~ - -*1.login http://io.m5stack.com and register your own account(or login -your account)* - -*2. press ``Device->Add`` buttom on M5Cloud IDE for binding M5Stack -board to your account* - -*3. Input the Check Code for the M5Stack screen display，Check Code is -random, after 60s will refresh* - -.. figure:: ../../_static/M5Stack_MicroPython_UserGuidePictures/WebIDE_check_code.png - :alt: image - - image -Coding MicroPython -~~~~~~~~~~~~~~~~~~ - -*1. create a new python project* - -.. figure:: ../../_static/M5Stack_MicroPython_UserGuidePictures/create_a_new_project.png - :alt: image - - image -*2. write your own code and press ``Upload & Run`` buttom on the M5Cloud -IDE* - -copy below code to ``main.py`` file and press ``Upload & Run`` - -.. code:: python - - from m5stack import lcd - - lcd.clear() - lcd.setCursor(0, 0) - lcd.setColor(lcd.WHITE) - - lcd.print("Hello World!") - -.. figure:: ../../_static/M5Stack_MicroPython_UserGuidePictures/display_hello_world.png - :alt: image - - image - -.. |image| image:: ../../_static/windows-logo.png -.. |image| image:: ../../_static/linux-logo.png -.. |image| image:: ../../_static/macos-logo.png diff --git a/en_build/html/_sources/get-started/m5tack_core_get_started_Arduino_MacOS.rst.txt b/en_build/html/_sources/get-started/m5tack_core_get_started_Arduino_MacOS.rst.txt deleted file mode 100644 index 6fedf8ce..00000000 --- a/en_build/html/_sources/get-started/m5tack_core_get_started_Arduino_MacOS.rst.txt +++ /dev/null @@ -1,132 +0,0 @@ -M5Stack-Core Get Started(MacOS, Arduino) -======================================== - -.. note:: - If your OS is Windows, please click `here`_ - -.. _here: m5stack_core_get_started_Arduino_Windows.html - -CONTENT -~~~~~~~ - -1. `Setting Environment <#setting-environment>`__ - - - `1. Install Arduino IDE <#1-install-arduino-ide>`__ - - - `2. ESP32 Board Support <#2-esp32-board-support>`__ - - - `3. Install M5Stack Library <#3-install-m5stack-library>`__ - -2. `Upload an Example Sketch <#upload-an-example-sketch>`__ - -Setting Environment -~~~~~~~~~~~~~~~~~~~ - -*Before setting the development environment, we suggest you confirm -whether the USB driver was installed. If not, please visit this link -``establish serial connection``.* TODO: add a link - -1. Install ``Arduino IDE`` -^^^^^^^^^^^^^^^^^^^^^^^^^^ - -If you don't already have the Arduino IDE installed, make sure to -install it. You can download it here -https://www.arduino.cc/en/Main/Software - -.. image:: ../../_static/getting_started_pics/m5stack_core/macOS_download_arduino_ide.png - -2. ESP32 Board Support -^^^^^^^^^^^^^^^^^^^^^^ - -Open Terminal (if you've never used the terminal before, it can be found -in Applications > Utilities > Terminal) and execute the following -command (copy->paste and hit enter): - -:: - - - mkdir -p ~/Documents/Arduino/hardware/espressif && \ - cd ~/Documents/Arduino/hardware/espressif && \ - git clone https://github.com/espressif/arduino-esp32.git esp32 && \ - cd esp32 && \ - git submodule update --init --recursive && \ - cd tools && \ - python get.py - -Where ~/Documents/Arduino represents your default sketch book location. -If you encounter any problems it could be that your Arduino sketchbook -folder is in a different location. This can be found by running arduino -and navigating through the menu to "Arduino" > "Preferences" > -"Sketchbook location". Adjust the command above accordingly if -necessary! - -.. note:: - - * If you get the error below: ``xcrun: error: invalid active developer path (/Library/Developer/CommandLineTools),`` - ``missing xcrun at: /Library/Developer/CommandLineTools/usr/bin/xcrun``, install the command line dev tools by typing ``xcode-select --install`` into the terminal and hit enter. once installed try the command above again and restart the Arduino IDE. - - * If you get the error: ``IOError: [Errno socket error] [SSL: TLSV1_ALERT_PROTOCOL_VERSION] tlsv1 alert protocol`` - ``version (_ssl.c:590) when running python get.py``, try ``python3`` instead of ``python`` and restart the Arduino IDE. - -3. Install M5Stack Library -^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Start up the Arduino IDE, then Select -``Sketch``->``Include Library``->``Manage Libraries...`` Type -``M5Stack`` into the search box, choose the library marked "Library for -M5Stack Core development kit" and install it. - -.. image:: ../../_static/getting_started_pics/m5stack_core/macOS_install_m5stack_lib.png - -.. image:: ../../_static/getting_started_pics/m5stack_core/macOS_search_m5stack.png - -Upload an Example Sketch -~~~~~~~~~~~~~~~~~~~~~~~~ - -1. Select your board and the serial port -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -After connecting the M5 to your computer via the USB cable. Start up the -Arduino IDE, and click ``Tools -> Boards -> M5Stack-Core-ESP32`` to -select your board - -.. image:: ../../_static/getting_started_pics/m5stack_core/macOS_select_board.png - -Click ``Tools -> Ports ->`` to select the serial port which your M5Stack -Core is connected to. It should be called something like -``/dev/cu.SLAB_USBtoUART`` - -.. image:: ../../_static/getting_started_pics/m5stack_core/macOS_select_serial_port.png - -2. Select an example -~~~~~~~~~~~~~~~~~~~~ - -Click ``File-> Examples``. there are some test programs in ``M5Stack->`` - -Try to open a sketch called ``HelloWorld`` inside Basics. - -.. image:: ../../_static/getting_started_pics/m5stack_core/macOS_select_example.png - -Compile and upload it, the M5Stack screen will show "Hello World!" - -.. image:: ../../_static/getting_started_pics/m5stack_core/display_hello_world.png - -Note -~~~~ - -Although most versions of MacOS have no problem with detecting the COM -port, on some newer versions of High Sierra sometimes Slab\_USBtoUART -does not appear. If this is the case, after you connect the M5 open -``security and privacy`` in the system preferences and set it to -``permit``. - -.. image:: ../../_static/getting_started_pics/m5stack_core/macOS_security_and_privacy.png - -.. image:: ../../_static/getting_started_pics/m5stack_core/macOS_security_and_privacy_01.png - -.. image:: ../../_static/getting_started_pics/m5stack_core/macOS_security_and_privacy_02.png - -.. note:: - - **If you want to read more the permission about the CP2104 USB driver, visit the below link please.** - https://developer.apple.com/library/archive/technotes/tn2459/\_index.html diff --git a/en_build/html/_sources/index.rst.txt b/en_build/html/_sources/index.rst.txt index b22f909c..bdd78737 100644 --- a/en_build/html/_sources/index.rst.txt +++ b/en_build/html/_sources/index.rst.txt @@ -6,7 +6,7 @@ M5Stack ============================= -Welcom to M5Stack Documents! +Welcome to M5Stack Documents! .. image:: ../_static/m5stack.png diff --git a/en_build/html/_sources/product-documents/ROBOT/BALA.rst.txt b/en_build/html/_sources/product-documents/ROBOT/BALA.rst.txt deleted file mode 100644 index 634d40ad..00000000 --- a/en_build/html/_sources/product-documents/ROBOT/BALA.rst.txt +++ /dev/null @@ -1,81 +0,0 @@ -M5Stack BALA -============ - -DESCRIPTION ------------ - -The M5Stack BALA is a balance bot based on M5Stack FIRE, including a 2 DC driver module based on Mega328p which is a core chip on Arduino UNO -You can even program The M5Stack BALA through Arduino or MicroPython with few code - -The 2 DC driver module communicates with M5Stack FIRE through I2C bus. It's default I2C address is **0x56** - -FEATURES --------- - -- Programming Support -- Python -- Compatible LEGO -- POGO Pin -- TF Card Support - -PARAMETER ---------- - -+--------------+---------------------------------------------------------------------+ -| Model | M5Stack FIRE | -+==============+=====================================================================+ -| ESP32 | 240MHz dual core, 600 DMIPS, 4MB SRAM, Wi-Fi, dual mode Bluetooth | -+--------------+---------------------------------------------------------------------+ -| Flash | 16M-Bytes | -+--------------+---------------------------------------------------------------------+ -| Input | 5V @ 500mA | -+--------------+---------------------------------------------------------------------+ -| Interface | TypeC x 1, GROVE(I2C+I/0+UART), Pogo Pin x 1 | -+--------------+---------------------------------------------------------------------+ -| LCD | 2 inch, 320x240 Colorful TFT LCD, ILI9342 | -+--------------+---------------------------------------------------------------------+ -| Speaker | 1W-0928 | -+--------------+---------------------------------------------------------------------+ -| Microphone | MEMS Analog BSE3729 Microphone | -+--------------+---------------------------------------------------------------------+ -| LED | SK6812 3535 RGB LED x 10 | -+--------------+---------------------------------------------------------------------+ -| MEMS | MPU6050, MAG3110 | -+--------------+---------------------------------------------------------------------+ -| Battery | 550mAh @ 3.7V, inside | -+--------------+---------------------------------------------------------------------+ -| Op.Temp. | 32°F to 104°F ( 0°C to 40°C ) | -+--------------+---------------------------------------------------------------------+ -| Size | 54 x 54 x 21 mm | -+--------------+---------------------------------------------------------------------+ -| C.A.S.E | Plastic ( PC ) | -+--------------+---------------------------------------------------------------------+ -| Weight | 56g | -+--------------+---------------------------------------------------------------------+ - -INCLUDES --------- - -- 1x M5Stack BALA -- 1x Motor Driver -- 2x N20(Encoder included) -- Type-C USB Cable - -DOCUMENTS ---------- - -- Example - - + `Arduino Example `__ - - + `MicroPython Example `__ - -- `GitHub `__ - -- `QuickStart`_ - -.. _QuickStart: ../../get-started/get-started-M5Bala.html - -- `Purchase `_ - - diff --git a/en_build/html/_sources/product-documents/STEAM Kit/M5GO/m5go.rst.txt b/en_build/html/_sources/product-documents/STEAM Kit/M5GO/m5go.rst.txt deleted file mode 100644 index fce37327..00000000 --- a/en_build/html/_sources/product-documents/STEAM Kit/M5GO/m5go.rst.txt +++ /dev/null @@ -1,87 +0,0 @@ -M5Stack M5GO -============ - -DESCRIPTION ------------ - -The M5Stack M5GO is a development kit based on ESP32 chip. You can even -program The M5Stack M5GO through Blockly, Arduino or MicroPython. - -The M5Stack M5GO equips the ESP32 with everything necessary to program, -run and develop on the wonderchip. It also features a Six-Axis (Gyro + -Accelerometer), 3-Axis Digital Magnetometer, MEMS(MPU9250) and a TFT -LCD, so you can create a 3D remote gesture controller, a simple "Leap -Motion" via M5Stack M5GO in a day in stead of couple weeks and so on. - -FEATURES --------- - -- Programming Support -- Blockly -- Arduino -- Python -- Compatible LEGO -- TF Card Support - -PARAMETER ---------- - -+--------------+-----------------------------------------------------------------------+ -| Model | M5Stack M5GO | -+==============+=======================================================================+ -| ESP32 | 240MHz dual core, 600 DMIPS, 520KB SRAM, Wi-Fi, dual mode Bluetooth | -+--------------+-----------------------------------------------------------------------+ -| Flash | 16M-Bytes | -+--------------+-----------------------------------------------------------------------+ -| Input | 5V @ 500mA | -+--------------+-----------------------------------------------------------------------+ -| Interface | TypeC x 1, GROVE(I2C+I/0+UART), Pogo Pin x 1 | -+--------------+-----------------------------------------------------------------------+ -| LCD | 2 inch, 320x240 Colorful TFT LCD, ILI9342 | -+--------------+-----------------------------------------------------------------------+ -| Speaker | 1W-0928 | -+--------------+-----------------------------------------------------------------------+ -| Microphone | MEMS Analog BSE3729 Microphone | -+--------------+-----------------------------------------------------------------------+ -| LED | SK6812 3535 RGB LED x 10 | -+--------------+-----------------------------------------------------------------------+ -| MEMS | MPU6050, MAG3110 | -+--------------+-----------------------------------------------------------------------+ -| Battery | 550mAh @ 3.7V, inside | -+--------------+-----------------------------------------------------------------------+ -| Op.Temp. | 32°F to 104°F ( 0°C to 40°C ) | -+--------------+-----------------------------------------------------------------------+ -| Size | 54 x 54 x 21 mm | -+--------------+-----------------------------------------------------------------------+ -| C.A.S.E | Plastic ( PC ) | -+--------------+-----------------------------------------------------------------------+ -| Weight | 56g | -+--------------+-----------------------------------------------------------------------+ - -INCLUDES --------- - -- 1x M5Stack M5GO -- 1x M5GO Bottom -- 1x ENV Unit -- 1x IR Unit -- 1x RGB Unit -- 1x PIR Unit -- 1x POT Unit -- 1x HUB Unit -- Type-C USB Cable -- User Manual - -DOCUMENTS ---------- - -- `Schematic `__ -- `Example `__ -- `Datasheet `__ - (ESP32) -- `Datasheet `__ - (MPU9250) -- `GitHub `__ - -- `Purchase `_ - diff --git a/en_build/html/_sources/product-documents/STEAM Kit/M5GO/units/m5go_unit_3.96port.rst.txt b/en_build/html/_sources/product-documents/STEAM Kit/M5GO/units/m5go_unit_3.96port.rst.txt deleted file mode 100644 index 777f1aa1..00000000 --- a/en_build/html/_sources/product-documents/STEAM Kit/M5GO/units/m5go_unit_3.96port.rst.txt +++ /dev/null @@ -1,15 +0,0 @@ -M5GO 3.96port -============= - -DESCRIPTION ------------ - -The M5GO 3.96port is a unit that aim to transfer GROVE interface to VH3.96-4Pin. - -.. image:: _static/product_pics/M5GO/M5GO_Unit_3.96.jpg - -FEATURES --------- - -- VH3.96 interface -- Two Lego installation holes diff --git a/en_build/html/_sources/product-documents/STEAM Kit/M5GO/units/m5go_unit_earth.rst.txt b/en_build/html/_sources/product-documents/STEAM Kit/M5GO/units/m5go_unit_earth.rst.txt deleted file mode 100644 index 274a5171..00000000 --- a/en_build/html/_sources/product-documents/STEAM Kit/M5GO/units/m5go_unit_earth.rst.txt +++ /dev/null @@ -1,25 +0,0 @@ -M5GO earth -============= - -DESCRIPTION ------------ - -The M5GO earth is a moisture detective unit for measuring the moisture in soil. The soil moisture sensor is pretty straight forward to use. The two large exp osed pads function as probes for the sensor, together acting as a variable resistor. The more water that is in the soil means the better the conductivity between the pads will be and will result in a lower resistance, and a higher SIG out. -You can read the moisture in soil staright or get a digital signal(0/1) that means the high(or low) humidity. - -FEATURES --------- - -- Adjustable threshold, including 10K adjustable resistor -- Analog & Digital output -- Grove interface -- Two Lego installation holes - -DOCUMENTS ---------- - -- `Schematic `__ - -- GitHub - - + `Arduino GitHub `__ diff --git a/en_build/html/_sources/product-documents/STEAM Kit/M5GO/units/m5go_unit_env.rst.txt b/en_build/html/_sources/product-documents/STEAM Kit/M5GO/units/m5go_unit_env.rst.txt deleted file mode 100644 index c27181b9..00000000 --- a/en_build/html/_sources/product-documents/STEAM Kit/M5GO/units/m5go_unit_env.rst.txt +++ /dev/null @@ -1,29 +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 `__ -- `GitHub `__ diff --git a/en_build/html/_sources/product-documents/STEAM Kit/M5GO/units/m5go_unit_hub.rst.txt b/en_build/html/_sources/product-documents/STEAM Kit/M5GO/units/m5go_unit_hub.rst.txt deleted file mode 100644 index 80dcbbb2..00000000 --- a/en_build/html/_sources/product-documents/STEAM Kit/M5GO/units/m5go_unit_hub.rst.txt +++ /dev/null @@ -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 `__ -- `GitHub `__ - diff --git a/en_build/html/_sources/product-documents/STEAM Kit/M5GO/units/m5go_unit_ir.rst.txt b/en_build/html/_sources/product-documents/STEAM Kit/M5GO/units/m5go_unit_ir.rst.txt deleted file mode 100644 index cbf93d7e..00000000 --- a/en_build/html/_sources/product-documents/STEAM Kit/M5GO/units/m5go_unit_ir.rst.txt +++ /dev/null @@ -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 `__ -- `GitHub `__ - diff --git a/en_build/html/_sources/product-documents/STEAM Kit/M5GO/units/m5go_unit_light.rst.txt b/en_build/html/_sources/product-documents/STEAM Kit/M5GO/units/m5go_unit_light.rst.txt deleted file mode 100644 index 43f4a724..00000000 --- a/en_build/html/_sources/product-documents/STEAM Kit/M5GO/units/m5go_unit_light.rst.txt +++ /dev/null @@ -1,28 +0,0 @@ -M5GO light -============= - -.. image:: ../../_static/product_pics/M5GO/M5GO_Unit_light.png - -DESCRIPTION ------------ - -The M5GO light is a light sensor unit with an adjustable resistor that can detect the environmental light intensity. -You can read analog signal(environmental light intensity) staright or get a digital signal(0/1) that means whether the light exists or not. - - -FEATURES --------- - -- Adjustable threshold, including 10K adjustable resistor -- Analog & Digital output -- Grove interface -- Two Lego installation holes - -DOCUMENTS ---------- - -- `Schematic `__ - -- GitHub - - + `Arduino GitHub `__ diff --git a/en_build/html/_sources/product-documents/STEAM Kit/M5GO/units/m5go_unit_makey.rst.txt b/en_build/html/_sources/product-documents/STEAM Kit/M5GO/units/m5go_unit_makey.rst.txt deleted file mode 100644 index 6dbb85dc..00000000 --- a/en_build/html/_sources/product-documents/STEAM Kit/M5GO/units/m5go_unit_makey.rst.txt +++ /dev/null @@ -1,47 +0,0 @@ -M5GO makey -============= - -.. image:: ../../_static/product_pics/M5GO/M5GO_Unit_makey.png - -DESCRIPTION ------------ - -The M5GO makey is a makey unit with 16 touchable pins. - -camera module contains thermopile sensors named MLX90640. the MLX90640 contains a 32x64 piexls IR array. It communicates with M5GO Core via GROVE which actually is a I2C interfacel. -As the images show you can detect surface temperatures from many feet away with an accuracy of ±1.5°C (best case). -After burn the firmware of the module's demostatrion to M5GO Core via `M5Burner`, the module will be running. Then you can program it via Arduino IDE. - - -FEATURES --------- - -- 32x24 piexls -- Target temperature -40°C - 300°C -- GROVE interface -- Two Lego installation holes - -APPLICATION ------------- - -- High precision non-contact temperature measurements -- Intrusion / Movement detection -- Visual IR thermometers -- Temperature sensing element for intelligent building air conditioning - -DOCUMENTS ---------- - -- GitHub - - + `Arduino GitHub `__ - - + `MLX90640 Drive GitHub `__ - -- Datasheet - - + `MLX90640 `__ - -- `QuickStart`_ - -.. _QuickStart: ../../get-started/M5GO/get_started_M5GO_makeyCam.html \ No newline at end of file diff --git a/en_build/html/_sources/product-documents/STEAM Kit/M5GO/units/m5go_unit_pir.rst.txt b/en_build/html/_sources/product-documents/STEAM Kit/M5GO/units/m5go_unit_pir.rst.txt deleted file mode 100644 index f4547297..00000000 --- a/en_build/html/_sources/product-documents/STEAM Kit/M5GO/units/m5go_unit_pir.rst.txt +++ /dev/null @@ -1,21 +0,0 @@ -M5GO PIR -======== - -DESCRIPTION ------------ - -The M5GO PIR is a human infrared sensor for M5GO that can easily detect -whether someone appears in front of it with M5GO Core. - -FEATURES --------- - -- Detects the distance 150cm -- Two Lego installation holes - -DOCUMENTS ---------- - -- `WebSite `__ -- `GitHub `__ - diff --git a/en_build/html/_sources/product-documents/STEAM Kit/M5GO/units/m5go_unit_pot.rst.txt b/en_build/html/_sources/product-documents/STEAM Kit/M5GO/units/m5go_unit_pot.rst.txt deleted file mode 100644 index 88d7fee3..00000000 --- a/en_build/html/_sources/product-documents/STEAM Kit/M5GO/units/m5go_unit_pot.rst.txt +++ /dev/null @@ -1,20 +0,0 @@ -M5GO POT -======== - -DESCRIPTION ------------ - -The M5GO POT is a potentiometer sensor for M5GO that can detect rotary -angle. - -FEATURES --------- - -- Two Lego installation holes - -DOCUMENTS ---------- - -- `WebSite `__ -- `GitHub `__ - diff --git a/en_build/html/_sources/product-documents/STEAM Kit/M5GO/units/m5go_unit_proto.rst.txt b/en_build/html/_sources/product-documents/STEAM Kit/M5GO/units/m5go_unit_proto.rst.txt deleted file mode 100644 index 75972cc8..00000000 --- a/en_build/html/_sources/product-documents/STEAM Kit/M5GO/units/m5go_unit_proto.rst.txt +++ /dev/null @@ -1,18 +0,0 @@ -M5GO proto -============= - -.. image:: ../../_static/product_pics/M5GO/M5GO_Unit_proto.png - -DESCRIPTION ------------ - -The M5Stack proto unit is a flexible blank circle with 100mil pitch of holes. You can create any circle -that could controlled by M5GO Core as you like. - -FEATURES --------- - -- Flexible extended blank circle -- 70 holes(pitch of holes: 100mil) -- GROVE interface -- Two Lego installation holes diff --git a/en_build/html/_sources/product-documents/STEAM Kit/M5GO/units/m5go_unit_relay.rst.txt b/en_build/html/_sources/product-documents/STEAM Kit/M5GO/units/m5go_unit_relay.rst.txt deleted file mode 100644 index 5e5ccd67..00000000 --- a/en_build/html/_sources/product-documents/STEAM Kit/M5GO/units/m5go_unit_relay.rst.txt +++ /dev/null @@ -1,33 +0,0 @@ -M5GO relay -=========== - -.. image:: ../../_static/product_pics/M5GO/M5GO_Unit_relay.png - -DESCRIPTION ------------ - -The M5GO relay is a unit that allows you to control large power loads with a light-current, safe, reliable power control system. the large power loads you can safely control is up to 24 VDC or 120 VAC. -Only a low electrial level is sent to this unit, the relay will be close and the large power loads you want to control will be working. - - -FEATURES --------- -- A single input -- Up to 3A @ 24 VDC or 120 VAC -- GROVE interface -- Two Lego installation holes - -APPLICATION ------------- - -- Be perfect for large inductive loads(like DC motors electrocircuit, intelligent interpolation...) -- Control a standard wall outlet device - -DOCUMENTS ---------- - -- `Schematic `__ - -- GitHub - - + `Arduino GitHub `__ diff --git a/en_build/html/_sources/product-documents/STEAM Kit/M5GO/units/m5go_unit_rgb.rst.txt b/en_build/html/_sources/product-documents/STEAM Kit/M5GO/units/m5go_unit_rgb.rst.txt deleted file mode 100644 index c7b08272..00000000 --- a/en_build/html/_sources/product-documents/STEAM Kit/M5GO/units/m5go_unit_rgb.rst.txt +++ /dev/null @@ -1,21 +0,0 @@ -M5GO RGB -======== - -DESCRIPTION ------------ - -The M5GO RGB is a sensor including three RGB LED lights and two GROVE -ports.You can display specified color using M5GO Core through Blockly, -Arduino or MicroPython. - -FEATURES --------- - -- Two Lego installation holes - -DOCUMENTS ---------- - -- `WebSite `__ -- `GitHub `__ - diff --git a/en_build/html/_sources/product-documents/STEAM Kit/M5GO/units/m5go_unit_thermal.rst.txt b/en_build/html/_sources/product-documents/STEAM Kit/M5GO/units/m5go_unit_thermal.rst.txt deleted file mode 100644 index 2a1a993e..00000000 --- a/en_build/html/_sources/product-documents/STEAM Kit/M5GO/units/m5go_unit_thermal.rst.txt +++ /dev/null @@ -1,45 +0,0 @@ -M5GO thermal -============= - -.. image:: ../../_static/product_pics/M5GO/M5GO_Unit_thermal.png - -DESCRIPTION ------------ - -The M5GO thermal is a thermal camera module contains thermopile sensors named MLX90640. the MLX90640 contains a 32x64 piexls IR array. It communicates with M5GO Core via GROVE which actually is a I2C interfacel. -As the images show you can detect surface temperatures from many feet away with an accuracy of ±1.5°C (best case). -After burn the firmware of the module's demostatrion to M5GO Core via `M5Burner`, the module will be running. Then you can program it via Arduino IDE. - - -FEATURES --------- - -- 32x24 piexls -- Target temperature -40°C ÷ 300°C -- GROVE interface -- Two Lego installation holes - -APPLICATION ------------- - -- High precision non-contact temperature measurements -- Intrusion / Movement detection -- Visual IR thermometers -- Temperature sensing element for intelligent building air conditioning - -DOCUMENTS ---------- - -- GitHub - - + `Arduino GitHub `__ - - + `MLX90640 Drive GitHub `__ - -- Datasheet - - + `MLX90640 `__ - -- `QuickStart`_ - -.. _QuickStart: ../../get-started/M5GO/get_started_M5GO_ThermalCam.html \ No newline at end of file diff --git a/en_build/html/_sources/product-documents/m5stack-core/m5stack_plc.rst.txt b/en_build/html/_sources/product-documents/m5stack-core/m5stack_plc.rst.txt deleted file mode 100644 index ea715464..00000000 --- a/en_build/html/_sources/product-documents/m5stack-core/m5stack_plc.rst.txt +++ /dev/null @@ -1,51 +0,0 @@ -M5Stack PLC Module -================== - -DESCRIPTION ------------ - -The M5Stack PLC Module is a prototye industrial board, including RS484 -adapter and electricity meter module. - -With DC9~24V power input, PLC-Proto motherboard reserved 6Pin or 4Pin -relay output, digital input, communication interface etc. - -FEATURES --------- - -- Free DIY -- Programmable Logic Controller -- Individual package weight: 0.1kg (0.22lb.) -- Package size: 5cm \* 5cm \* 5cm (1.97in \* 1.97in \* 1.97in) - -INCLUDES --------- - -- 1x PLC-Proto Broad -- 1x RS485 module -- 1x PLC Plastic Enclosure -- 1x Slide Guide -- 1x Magnet -- 1x 6 Pin 3.96 Pitch Terminal -- 1x 4 Pin 3.96 Pitch Terminal -- 3x Hex Key -- 7x Electrical Terminal -- 1x Sticker - -Applications ------------- - -- Programmable Logic Controller -- Programmable Motion Controller -- Digital Operation Processor -- Strong Electric Controller - -DOCUMENTS ---------- - -- `WebSite `__ - -- GitHub - - + `Arduino GitHub `__ - diff --git a/en_build/html/_sources/product-documents/units/a.rst.txt b/en_build/html/_sources/product-documents/units/a.rst.txt deleted file mode 100644 index e69de29b..00000000 diff --git a/en_build/html/api-reference/button/button.html b/en_build/html/api-reference/button/button.html index 9d94f62f..c90bb717 100644 --- a/en_build/html/api-reference/button/button.html +++ b/en_build/html/api-reference/button/button.html @@ -89,6 +89,7 @@
  • Peripherals
    • +
  • Mic
  • Speaker
  • SD Card
    • diff --git a/en_build/html/api-reference/index.html b/en_build/html/api-reference/index.html index 5583832b..33704435 100644 --- a/en_build/html/api-reference/index.html +++ b/en_build/html/api-reference/index.html @@ -29,7 +29,7 @@ - + @@ -182,7 +182,7 @@ - + diff --git a/en_build/html/api-reference/lcd/lcd.html b/en_build/html/api-reference/lcd/lcd.html index 4890f0d0..aa2e810c 100644 --- a/en_build/html/api-reference/lcd/lcd.html +++ b/en_build/html/api-reference/lcd/lcd.html @@ -108,6 +108,7 @@
  • Button
  • Peripherals
    • +
  • Mic
  • Speaker
  • SD Card
    • diff --git a/en_build/html/api-reference/peripherals/adc.html b/en_build/html/api-reference/peripherals/adc.html index d6f95f8a..8aa67ae9 100644 --- a/en_build/html/api-reference/peripherals/adc.html +++ b/en_build/html/api-reference/peripherals/adc.html @@ -101,6 +101,7 @@
  • RTC
    • +
  • Mic
  • Speaker
  • SD Card
    • diff --git a/en_build/html/api-reference/peripherals/dac.html b/en_build/html/api-reference/peripherals/dac.html index 30d48bc2..d04cba54 100644 --- a/en_build/html/api-reference/peripherals/dac.html +++ b/en_build/html/api-reference/peripherals/dac.html @@ -101,6 +101,7 @@
  • RTC
    • +
  • Mic
  • Speaker
  • SD Card
    • diff --git a/en_build/html/api-reference/peripherals/gpio.html b/en_build/html/api-reference/peripherals/gpio.html index 25e9691c..e207ae5f 100644 --- a/en_build/html/api-reference/peripherals/gpio.html +++ b/en_build/html/api-reference/peripherals/gpio.html @@ -100,6 +100,7 @@
  • RTC
    • +
  • Mic
  • Speaker
  • SD Card
    • diff --git a/en_build/html/api-reference/peripherals/i2c.html b/en_build/html/api-reference/peripherals/i2c.html index 538f639b..3a2447e3 100644 --- a/en_build/html/api-reference/peripherals/i2c.html +++ b/en_build/html/api-reference/peripherals/i2c.html @@ -101,6 +101,7 @@
  • RTC
    • +
  • Mic
  • Speaker
  • SD Card
    • diff --git a/en_build/html/api-reference/peripherals/index.html b/en_build/html/api-reference/peripherals/index.html index 83a54258..e5f8ef93 100644 --- a/en_build/html/api-reference/peripherals/index.html +++ b/en_build/html/api-reference/peripherals/index.html @@ -96,6 +96,7 @@
  • RTC
    • +
  • Mic
  • Speaker
  • SD Card
    • diff --git a/en_build/html/api-reference/peripherals/neopixel.html b/en_build/html/api-reference/peripherals/neopixel.html index d3bc5e84..99d7ed4c 100644 --- a/en_build/html/api-reference/peripherals/neopixel.html +++ b/en_build/html/api-reference/peripherals/neopixel.html @@ -101,6 +101,7 @@
  • RTC
    • +
  • Mic
  • Speaker
  • SD Card
    • diff --git a/en_build/html/api-reference/peripherals/rtc.html b/en_build/html/api-reference/peripherals/rtc.html index 14cf8b98..a1f88bd3 100644 --- a/en_build/html/api-reference/peripherals/rtc.html +++ b/en_build/html/api-reference/peripherals/rtc.html @@ -28,7 +28,7 @@ - + @@ -101,6 +101,7 @@ +
  • Mic
  • Speaker
  • SD Card
    • @@ -320,7 +321,7 @@ The string can be, for example, json string containing the parameters which has diff --git a/en_build/html/get-started/M5Stack_Core_Get_Started.html b/en_build/html/get-started/M5Stack_Core_Get_Started.html index a49342d8..e35e4999 100644 --- a/en_build/html/get-started/M5Stack_Core_Get_Started.html +++ b/en_build/html/get-started/M5Stack_Core_Get_Started.html @@ -84,13 +84,13 @@
  • Introduction
  • What You Need
  • Your boards
    • diff --git a/en_build/html/get-started/M5Stack_Core_Get_Started_Arduino_Mac_en.html b/en_build/html/get-started/M5Stack_Core_Get_Started_Arduino_Mac_en.html deleted file mode 100644 index 08f9d445..00000000 --- a/en_build/html/get-started/M5Stack_Core_Get_Started_Arduino_Mac_en.html +++ /dev/null @@ -1,319 +0,0 @@ - - - - - - - - - - - M5Stack-Core Get Started(MacOS, Arduino) — M5Stack 1.0.1 documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    - - - - -
    - - - - - -
    - -
    - - - - - - - - - - - - - - - - - -
    - - - - -
    -
    -
    -
    - -
    -

    M5Stack-Core Get Started(MacOS, Arduino)

    -
    -

    CONTENT

    -
      -
    1. Setting Environment -
      2. -
    2. Upload an Example Sketch
      3. -
    -
    -
    -

    Setting Environment

    -

    Before setting the development environment, we suggest you confirm -whether the USB driver was installed. If not, please visit this link -``establish serial connection``. TODO: add a link

    -
    -

    1. Install Arduino IDE

    -

    If you don’t already have the Arduino IDE installed, make sure to -install it. You can download it here -https://www.arduino.cc/en/Main/Software

    -../_images/macOS_download_arduino_ide.png -
    -
    -

    2. ESP32 Board Support

    -

    Open Terminal (if you’ve never used the terminal before, it can be found -in Applications > Utilities > Terminal) and execute the following -command (copy->paste and hit enter):

    -
    mkdir -p ~/Documents/Arduino/hardware/espressif && \
-cd ~/Documents/Arduino/hardware/espressif && \
-git clone https://github.com/espressif/arduino-esp32.git esp32 && \
-cd esp32 && \
-git submodule update --init --recursive && \
-cd tools && \
-python get.py
-
    -
    -

    Where ~/Documents/Arduino represents your default sketch book location. -If you encounter any problems it could be that your Arduino sketchbook -folder is in a different location. This can be found by running arduino -and navigating through the menu to “Arduino” > “Preferences” > -“Sketchbook location”. Adjust the command above accordingly if -necessary!

    -
    -

    Note

    -
      -
    • If you get the error below: xcrun: error: invalid active developer path (/Library/Developer/CommandLineTools),
      • -
    -
    -
    missing xcrun at: /Library/Developer/CommandLineTools/usr/bin/xcrun, install the command line dev tools by typing xcode-select --install into the terminal and hit enter. once installed try the command above again and restart the Arduino IDE.
    -
      -
    • If you get the error: IOError: [Errno socket error] [SSL: TLSV1_ALERT_PROTOCOL_VERSION] tlsv1 alert protocol
      • -
    -
    -
    version (_ssl.c:590) when running python get.py, try python3 instead of python and restart the Arduino IDE.
    -
    -
    -
    -

    3. Install M5Stack Library

    -

    Start up the Arduino IDE, then Select -Sketch->``Include Library``->``Manage Libraries…`` Type -M5Stack into the search box, choose the library marked “Library for -M5Stack Core development kit” and install it.

    -../_images/macOS_install_m5stack_lib.png -../_images/macOS_search_m5stack.png -
    -
    -
    -

    Upload an Example Sketch

    -
    -

    1. Select your board and the serial port

    -

    After connecting the M5 to your computer via the USB cable. Start up the -Arduino IDE, and click Tools -> Boards -> M5Stack-Core-ESP32 to -select your board

    -../_images/macOS_select_board.png -

    Click Tools -> Ports -> to select the serial port which your M5Stack -Core is connected to. It should be called something like -/dev/cu.SLAB_USBtoUART

    -../_images/macOS_select_serial_port.png -
    -
    -
    -

    2. Select an example

    -

    Click File-> Examples. there are some test programs in M5Stack->

    -

    Try to open a sketch called HelloWorld inside Basics.

    -../_images/macOS_select_example.png -

    Compile and upload it, the M5Stack screen will show “Hello World!”

    -../_images/display_hello_world.png -
    -
    -

    Note

    -

    Although most versions of MacOS have no problem with detecting the COM -port, on some newer versions of High Sierra sometimes Slab_USBtoUART -does not appear. If this is the case, after you connect the M5 open -security and privacy in the system preferences and set it to -permit.

    -../_images/macOS_security_and_privacy.png -../_images/macOS_security_and_privacy_01.png -../_images/macOS_security_and_privacy_02.png -
    -

    Note

    -
    -
    If you want to read more the permission about the CP2104 USB driver, visit the below link please.
    -
    https://developer.apple.com/library/archive/technotes/tn2459/_index.html
    -
    -
    -
    -
    - - -
    - -
    -
    - - -
    - -
    -

    - © Copyright 2017 - 2018, M5Stack Inc. - -

    -
    - Built with Sphinx using a theme provided by Read the Docs. - -
    - -
    -
    - -
    - -
    - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/en_build/html/get-started/M5Stack_Core_Get_Started_Arduino_Windows_en.html b/en_build/html/get-started/M5Stack_Core_Get_Started_Arduino_Windows_en.html deleted file mode 100644 index 8823486c..00000000 --- a/en_build/html/get-started/M5Stack_Core_Get_Started_Arduino_Windows_en.html +++ /dev/null @@ -1,349 +0,0 @@ - - - - - - - - - - - M5Stack-Core Get Started(Windows, Arduino) — M5Stack 1.0.1 documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    - - - - -
    - - - - - -
    - -
    - - - - - - - - - - - - - - - - - -
    - - - - -
    -
    -
    -
    - -
    -

    M5Stack-Core Get Started(Windows, Arduino)

    -
    -

    Note

    -

    If your OS is MacOS, please click here

    -
    -
    -

    CONTENT

    -
      -
    1. Setting Environment -
      2. -
    2. Example
      3. -
    -
    -

    Note

    -

    If you want to upgrade the M5Stack Lib, please view this article upgrade M5Stack Lib

    -
    -
    -
    -

    Setting Environment

    -

    Before setting the development environment, we suggest you confirm -whether the USB driver has installed. If not, please visit this link -establish serial connection.

    -
    -

    1. Install Arduino IDE

    -

    download address https://www.arduino.cc/en/Main/Software

    -../_images/arduino_cc_package.png -

    modified the path of Arduino as D:\Program Files as shown below

    -../_images/select_arduino_install_path.png -

    Now my path of Arduino is D:\Program Files\Arduino

    -../_images/arduino_path.png -
    -
    -

    2. Download Toolchain

    -

    （Now my path of Arduino is D:\Program Files\Arduino）

    -

    Enter the path D:\Program Files\Arduino\hareware via the terminal of -Windows

    -

    Execute the following commands on the terminal of Windows > * new a -directory named espressif, then enter this directory

    -

    mkdir espressif && cd espressif

    -

    git clone –recursive https://github.com/espressif/arduino-esp32.git -esp32

    -../_images/download_idf.png -
    -
    -

    3. ESP32 Toolchain

    -

    Enter the path -D:\Program Files\arduino\hardware\espressif\esp32\tools double click -on get.exe

    -../_images/select_get_exe_file.png -../_images/download_xtensa_tools.png -
    -
    -

    4. Download the M5Stack Lib via Arduino IDE

    -

    Open Arduino IDE, then Select -Sketch->``Include Library``->``Manage Libraries…`` Search -M5Stack and install it

    -../_images/select_arduino_lib.png -../_images/download_m5stack_lib.png -
    -
    -
    -

    Example

    -

    The USB cable connects to M5Stack Core, then select your serial port -which is connected M5Stack Core. Select a demo example, compile and -upload

    -
    -

    1. Open a example likes FactoryTest.ino

    -../_images/select_demo.png -

    Comfire your board name, baudrate, the specified serial port: -M5Stack-Core-ESP32、921600、COM3

    -../_images/select_board_and_com.png -

    After upload seccessfully, open the Serial Monitor

    -../_images/FactoryTest_result.png -
    -
    -

    2. New a M5Stack program

    -

    Open Arduino IDE, then new a .ino file, rename it as my_test.ino

    -

    Copy the below code to my_test.ino

    -
    #include <M5Stack.h>
-
-// the setup routine runs once when M5Stack starts up
-void setup(){tack
-
-  // Initialize the M5Stack object
-  M5.begin();
-
-  // LCD display
-  M5.Lcd.print("Hello World!");
-  M5.Lcd.print("M5Stack is running successfully!");
-}
-
-// the loop routine runs over and over again forever
-void loop() {
-
-}
-
    -
    -

    compile it and upload, the M5Stack screen will show “Hello World!” -“M5Stack is running successfully!”

    -
    -
    -
    - - -
    - -
    - - -
    -
    - -
    - -
    - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/en_build/html/get-started/M5Stack_Core_Get_Started_MicroPython_Windows_en.html b/en_build/html/get-started/M5Stack_Core_Get_Started_MicroPython_Windows_en.html deleted file mode 100644 index deb61987..00000000 --- a/en_build/html/get-started/M5Stack_Core_Get_Started_MicroPython_Windows_en.html +++ /dev/null @@ -1,373 +0,0 @@ - - - - - - - - - - - M5Stack-Core Get Started(Windows, MicroPython) — M5Stack 1.0.1 documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    - - - - -
    - - - - - -
    - -
    - - - - - - - - - - - - - - - - - -
    - - - - -
    -
    -
    -
    - -
    -

    M5Stack-Core Get Started(Windows, MicroPython)

    -
    -

    CONTENT

    -
      -
    1. Burn Firmware -
      2. -
    2. Connect Wi-Fi
      3. -
    3. Binding device
      4. -
    4. Coding MicroPython
      5. -
    -
    -
    -

    Burn Firmware

    -
    -

    1. Download Firmware

    -

    https://github.com/m5stack/M5Cloud/tree/master/firmwares

    -

    Now, the M5Cloud firmware I downloaded named -m5cloud-20180516-v0.4.0.bin and it saved at ~/smbshare

    -
    -
    -

    2. Burn to M5Stack

    - ----- - - - - - - - - - - - - -
    imageimageimage
    WindowsLinuxMacOS
    -

    *Windows*

    -

    open Flash Download -Tools(点击下载) -apply by Espressif, choose ESP32 DownloadTool option and execute -three steps ( choose firmware file, your serial port, erase and program -flash ) as shown below

    -
    -image -

    image

    -
    -

    *MacOS/Linux*

    -

    1. Check port on Linux and MacOS

    -

    To check the device name for the serial port of your M5Stack board (or -external converter dongle), run this command two times, first with the -board / dongle unplugged, then with plugged in. The port which appears -the second time is the one you need:

    -

    Linux

    -

    ls /dev/tty*

    -

    MacOS

    -

    ls /dev/cu.*

    -

    2. Adding user to ``dialout`` on Linux

    -

    The currently logged user should have read and write access the serial -port over USB. On most Linux distributions, this is done by adding the -user to dialout group with the following command:

    -

    sudo usermod -a -G dialout $USER Now, my serial port named -ttyUSB0

    -

    3. Download M5Cloud firmware to M5Stack board - Installing esptool： -pip install esptool - Erase flash on M5Stack: -esptool.py --chip esp32 --port /dev/ttyUSB0 erase_flash - Download -firmware to M5Stack: -esptool.py --chip esp32 --port /dev/ttyUSB0 write_flash --flash_mode dio -z 0x1000 m5cloud-20180516-v0.4.0.bin

    -
    -
    -
    -

    Connect Wi-Fi

    -

    Mobile Phone or PC connect to M5Stack AP(like M5Stack-a67c), and -then open brower to login 192.168.4.1 setting your LAN SSID and Password

    -
    -image -

    image

    -
    -
    -
    -

    Binding device

    -

    1.login http://io.m5stack.com and register your own account(or login -your account)

    -

    2. press ``Device->Add`` buttom on M5Cloud IDE for binding M5Stack -board to your account

    -

    3. Input the Check Code for the M5Stack screen display，Check Code is -random, after 60s will refresh

    -
    -image -

    image

    -
    -
    -
    -

    Coding MicroPython

    -

    1. create a new python project

    -
    -image -

    image

    -
    -

    2. write your own code and press ``Upload & Run`` buttom on the M5Cloud -IDE

    -

    copy below code to main.py file and press Upload & Run

    -
    from m5stack import lcd
-
-lcd.clear()
-lcd.setCursor(0, 0)
-lcd.setColor(lcd.WHITE)
-
-lcd.print("Hello World!")
-
    -
    -
    -image -

    image

    -
    -
    -
    - - -
    - -
    - - -
    -
    - -
    - -
    - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/en_build/html/get-started/establish_serial_connection.html b/en_build/html/get-started/establish_serial_connection.html index 2e0b61df..d17c2d46 100644 --- a/en_build/html/get-started/establish_serial_connection.html +++ b/en_build/html/get-started/establish_serial_connection.html @@ -28,7 +28,7 @@ - + @@ -91,6 +91,9 @@
  • For Windows
    • +
  • How to Burn Firmware
    • +
  • How to Connect WIFI Using Core
    • +
  • Upgrade M5Stack Lib
    • @@ -232,7 +235,7 @@ disappears from the list and then shows back again.

    diff --git a/en_build/html/get-started/get-started-StepMotor.html b/en_build/html/get-started/get-started-StepMotor.html index 79f18ba0..4d285b9a 100644 --- a/en_build/html/get-started/get-started-StepMotor.html +++ b/en_build/html/get-started/get-started-StepMotor.html @@ -84,11 +84,10 @@
  • Introduction
  • What You Need
  • Your boards
      -
    • M5Stack Core with Arduino IDE
      • -
    • M5Stack Core with Micropython
      • -
    • M5GO
      • +
    • M5Stack Core
      • +
    • M5GO
    • ESP32CAM
      • -
    • M5Stack STEPMOTOR Module
        +
      • STEPMOTOR Module
        • diff --git a/en_build/html/get-started/how_to_burn_firmware.html b/en_build/html/get-started/how_to_burn_firmware.html deleted file mode 100644 index 68605b23..00000000 --- a/en_build/html/get-started/how_to_burn_firmware.html +++ /dev/null @@ -1,208 +0,0 @@ - - - - - - - - - - - <no title> — M5Stack 1.0.1 documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
        - - - - -
        - - - - - -
        - -
        - - - - - - - - - - - - - - - - - -
        - - - - -
        -
        -
        -
        - - - -
        - -
        -
        - - -
        - -
        -

        - © Copyright 2017 - 2018, M5Stack Inc. - -

        -
        - Built with Sphinx using a theme provided by Read the Docs. - -
        - -
        -
        - -
        - -
        - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/en_build/html/get-started/how_to_burn_firmware_en.html b/en_build/html/get-started/how_to_burn_firmware_en.html index e482380c..b44cefad 100644 --- a/en_build/html/get-started/how_to_burn_firmware_en.html +++ b/en_build/html/get-started/how_to_burn_firmware_en.html @@ -27,7 +27,9 @@ - + + + @@ -76,9 +78,26 @@ -
          +
          • Product Documents
            • -
          • Get Started
            • +
          • Get Started +
          • API Reference
          • M5Stack Cases
          • M5Stack Awesome
            • @@ -128,6 +147,8 @@
          • Docs »
            • +
          • Get Started »
            • +
          • How to Burn Firmware
            • @@ -217,6 +238,15 @@ below, it means chip has been burnt successfully..