diff --git a/en/index.rst b/en/index.rst index 0d9a61b1..11d9d5e6 100644 --- a/en/index.rst +++ b/en/index.rst @@ -17,11 +17,13 @@ Our a series of core boards are based on ESP32 chip. Our aim is "**Stackable Boards is Product**". Here's the `Official Website`_ If you have any questions, you can contact us by `Email`_ or `Forum`_. +If you want to get our products, access our `store`_ please. -.. _Official Website: www.m5stack.com -.. _Email: tech@m5stack.com -.. _Forum: forum.m5stack.com +.. _Official Website: http://www.m5stack.com +.. _Email: http://tech@m5stack.com +.. _Forum: http://forum.m5stack.com +.. _store: http://www.aliexpress.com/store/all-wholesale-products/3226069.html?spm=2114.12010108.100004.3.7e3a5379KoyhDo ====================== ====================== ====================== diff --git a/en/product-documents/m5stack-core/index.rst b/en/product-documents/m5stack-core/index.rst index b2126847..2be0eeab 100644 --- a/en/product-documents/m5stack-core/index.rst +++ b/en/product-documents/m5stack-core/index.rst @@ -11,4 +11,3 @@ M5Stack Core Description M5Stack FACES M5Stack PLC -Example code for this API section is provided in directory of ESP-IDF examples. diff --git a/en/product-documents/m5stack-core/m5stack_faces.rst b/en/product-documents/m5stack-core/m5stack_faces.rst index 6aca0fd1..7ff372c9 100644 --- a/en/product-documents/m5stack-core/m5stack_faces.rst +++ b/en/product-documents/m5stack-core/m5stack_faces.rst @@ -93,7 +93,9 @@ DOCUMENTS + `MPU9250 `__ - `M5Stack-nesemu `__ + - `GitHub `__ +- `Purchase `_ diff --git a/en/product-documents/m5stack-core/m5stack_gray.rst b/en/product-documents/m5stack-core/m5stack_gray.rst index c960de15..466ec2d5 100644 --- a/en/product-documents/m5stack-core/m5stack_gray.rst +++ b/en/product-documents/m5stack-core/m5stack_gray.rst @@ -85,5 +85,6 @@ DOCUMENTS + `MicroPython GitHub `__ +- `Purchase `_ diff --git a/en/product-documents/modules/m5stack_battery_module.rst b/en/product-documents/modules/m5stack_battery_module.rst index 087e1b83..c3b5312e 100644 --- a/en/product-documents/modules/m5stack_battery_module.rst +++ b/en/product-documents/modules/m5stack_battery_module.rst @@ -22,5 +22,6 @@ DOCUMENTS --------- - `WebSite `__ + - `Purchase `_ diff --git a/en/product-documents/modules/m5stack_lora_module.rst b/en/product-documents/modules/m5stack_lora_module.rst index e7197038..f2a8b38f 100644 --- a/en/product-documents/modules/m5stack_lora_module.rst +++ b/en/product-documents/modules/m5stack_lora_module.rst @@ -42,6 +42,9 @@ DOCUMENTS - `LoRa Info `__ (LoRa) - `GitHub `__ +- `Purchase `_ + + *NOTE* ~~~~~~ @@ -58,3 +61,5 @@ below Because GPIO5 who has connected NSS pin of LoRa module need be pull-up at the moment your board(or system) power on to prevent system's LCD can't display. + + diff --git a/en/product-documents/modules/m5stack_proto_module.rst b/en/product-documents/modules/m5stack_proto_module.rst index 1b4958e4..93e712d9 100644 --- a/en/product-documents/modules/m5stack_proto_module.rst +++ b/en/product-documents/modules/m5stack_proto_module.rst @@ -67,7 +67,10 @@ DOCUMENTS --------- - `WebSite `__ + - `Example `__ + - `GitHub `__ + - `Purchase `_ diff --git a/en/product-documents/modules/m5stack_sim800_module.rst b/en/product-documents/modules/m5stack_sim800_module.rst index 6564f94e..706ccc72 100644 --- a/en/product-documents/modules/m5stack_sim800_module.rst +++ b/en/product-documents/modules/m5stack_sim800_module.rst @@ -47,3 +47,5 @@ DOCUMENTS (SIM800L) - `GitHub `__ +- `Purchase `_ + diff --git a/en_build/doctrees/COPYRIGHT.doctree b/en_build/doctrees/COPYRIGHT.doctree new file mode 100644 index 00000000..908ec469 Binary files /dev/null and b/en_build/doctrees/COPYRIGHT.doctree differ diff --git a/en_build/doctrees/about.doctree b/en_build/doctrees/about.doctree new file mode 100644 index 00000000..fb2807f3 Binary files /dev/null and b/en_build/doctrees/about.doctree differ diff --git a/en_build/doctrees/api-reference/button/button.doctree b/en_build/doctrees/api-reference/button/button.doctree new file mode 100644 index 00000000..455faf71 Binary files /dev/null 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 new file mode 100644 index 00000000..bf88faaa Binary files /dev/null and b/en_build/doctrees/api-reference/index.doctree differ diff --git a/en_build/doctrees/api-reference/lcd/Backup/lcd_api_arduino.doctree b/en_build/doctrees/api-reference/lcd/Backup/lcd_api_arduino.doctree new file mode 100644 index 00000000..16754455 Binary files /dev/null and b/en_build/doctrees/api-reference/lcd/Backup/lcd_api_arduino.doctree differ diff --git a/en_build/doctrees/api-reference/lcd/Backup/lcd_api_micropython.doctree b/en_build/doctrees/api-reference/lcd/Backup/lcd_api_micropython.doctree new file mode 100644 index 00000000..56323e2b Binary files /dev/null and b/en_build/doctrees/api-reference/lcd/Backup/lcd_api_micropython.doctree differ diff --git a/en_build/doctrees/api-reference/lcd/lcd.doctree b/en_build/doctrees/api-reference/lcd/lcd.doctree new file mode 100644 index 00000000..336ef4e3 Binary files /dev/null and b/en_build/doctrees/api-reference/lcd/lcd.doctree differ diff --git a/en_build/doctrees/api-reference/peripherals/adc.doctree b/en_build/doctrees/api-reference/peripherals/adc.doctree new file mode 100644 index 00000000..aa4b3f56 Binary files /dev/null and b/en_build/doctrees/api-reference/peripherals/adc.doctree differ diff --git a/en_build/doctrees/api-reference/peripherals/dac.doctree b/en_build/doctrees/api-reference/peripherals/dac.doctree new file mode 100644 index 00000000..f0a48135 Binary files /dev/null and b/en_build/doctrees/api-reference/peripherals/dac.doctree differ diff --git a/en_build/doctrees/api-reference/peripherals/gpio.doctree b/en_build/doctrees/api-reference/peripherals/gpio.doctree new file mode 100644 index 00000000..a0417875 Binary files /dev/null and b/en_build/doctrees/api-reference/peripherals/gpio.doctree differ diff --git a/en_build/doctrees/api-reference/peripherals/i2c.doctree b/en_build/doctrees/api-reference/peripherals/i2c.doctree new file mode 100644 index 00000000..c5f1fb6e Binary files /dev/null and b/en_build/doctrees/api-reference/peripherals/i2c.doctree differ diff --git a/en_build/doctrees/api-reference/peripherals/index.doctree b/en_build/doctrees/api-reference/peripherals/index.doctree new file mode 100644 index 00000000..c69584ac Binary files /dev/null and b/en_build/doctrees/api-reference/peripherals/index.doctree differ diff --git a/en_build/doctrees/api-reference/peripherals/neopixel.doctree b/en_build/doctrees/api-reference/peripherals/neopixel.doctree new file mode 100644 index 00000000..f6bf78df Binary files /dev/null and b/en_build/doctrees/api-reference/peripherals/neopixel.doctree differ diff --git a/en_build/doctrees/api-reference/peripherals/rtc.doctree b/en_build/doctrees/api-reference/peripherals/rtc.doctree new file mode 100644 index 00000000..80cccb30 Binary files /dev/null and b/en_build/doctrees/api-reference/peripherals/rtc.doctree differ diff --git a/en_build/doctrees/api-reference/peripherals/spi.doctree b/en_build/doctrees/api-reference/peripherals/spi.doctree new file mode 100644 index 00000000..82208f46 Binary files /dev/null and b/en_build/doctrees/api-reference/peripherals/spi.doctree differ diff --git a/en_build/doctrees/api-reference/peripherals/timer.doctree b/en_build/doctrees/api-reference/peripherals/timer.doctree new file mode 100644 index 00000000..ddc55795 Binary files /dev/null and b/en_build/doctrees/api-reference/peripherals/timer.doctree differ diff --git a/en_build/doctrees/api-reference/peripherals/uart.doctree b/en_build/doctrees/api-reference/peripherals/uart.doctree new file mode 100644 index 00000000..a4c7a252 Binary files /dev/null and b/en_build/doctrees/api-reference/peripherals/uart.doctree differ diff --git a/en_build/doctrees/api-reference/sd_card/sd_card.doctree b/en_build/doctrees/api-reference/sd_card/sd_card.doctree new file mode 100644 index 00000000..f2373fc0 Binary files /dev/null and b/en_build/doctrees/api-reference/sd_card/sd_card.doctree differ diff --git a/en_build/doctrees/api-reference/speaker/speaker.doctree b/en_build/doctrees/api-reference/speaker/speaker.doctree new file mode 100644 index 00000000..c6cdf93f Binary files /dev/null and b/en_build/doctrees/api-reference/speaker/speaker.doctree differ diff --git a/en_build/doctrees/basic-cases/esp32cam/index.doctree b/en_build/doctrees/basic-cases/esp32cam/index.doctree new file mode 100644 index 00000000..639be5b8 Binary files /dev/null and b/en_build/doctrees/basic-cases/esp32cam/index.doctree differ diff --git a/en_build/doctrees/basic-cases/index.doctree b/en_build/doctrees/basic-cases/index.doctree new file mode 100644 index 00000000..999293aa Binary files /dev/null and b/en_build/doctrees/basic-cases/index.doctree differ diff --git a/en_build/doctrees/basic-cases/m5go/index.doctree b/en_build/doctrees/basic-cases/m5go/index.doctree new file mode 100644 index 00000000..364c35e2 Binary files /dev/null and b/en_build/doctrees/basic-cases/m5go/index.doctree differ diff --git a/en_build/doctrees/basic-cases/m5stack-core/index.doctree b/en_build/doctrees/basic-cases/m5stack-core/index.doctree new file mode 100644 index 00000000..be088e51 Binary files /dev/null and b/en_build/doctrees/basic-cases/m5stack-core/index.doctree differ diff --git a/en_build/doctrees/environment.pickle b/en_build/doctrees/environment.pickle new file mode 100644 index 00000000..324382dc Binary files /dev/null and b/en_build/doctrees/environment.pickle 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 new file mode 100644 index 00000000..abeefc28 Binary files /dev/null and b/en_build/doctrees/get-started/add-idf_path-to-profile.doctree differ diff --git a/en_build/doctrees/get-started/establish-serial-connection.doctree b/en_build/doctrees/get-started/establish-serial-connection.doctree new file mode 100644 index 00000000..f0c2347e Binary files /dev/null and b/en_build/doctrees/get-started/establish-serial-connection.doctree differ diff --git a/en_build/doctrees/get-started/get-started-ESP32CAM.doctree b/en_build/doctrees/get-started/get-started-ESP32CAM.doctree new file mode 100644 index 00000000..87689321 Binary files /dev/null and b/en_build/doctrees/get-started/get-started-ESP32CAM.doctree differ diff --git a/en_build/doctrees/get-started/get-started-M5Bala.doctree b/en_build/doctrees/get-started/get-started-M5Bala.doctree new file mode 100644 index 00000000..41b3c8d2 Binary files /dev/null and b/en_build/doctrees/get-started/get-started-M5Bala.doctree differ diff --git a/en_build/doctrees/get-started/get-started-M5StackCore-Arduino.doctree b/en_build/doctrees/get-started/get-started-M5StackCore-Arduino.doctree new file mode 100644 index 00000000..b3581f4f Binary files /dev/null and b/en_build/doctrees/get-started/get-started-M5StackCore-Arduino.doctree differ diff --git a/en_build/doctrees/get-started/get-started-M5StackCore-Micropython.doctree b/en_build/doctrees/get-started/get-started-M5StackCore-Micropython.doctree new file mode 100644 index 00000000..f22ed677 Binary files /dev/null and b/en_build/doctrees/get-started/get-started-M5StackCore-Micropython.doctree differ diff --git a/en_build/doctrees/get-started/get-started-StepMotor.doctree b/en_build/doctrees/get-started/get-started-StepMotor.doctree new file mode 100644 index 00000000..b752162e Binary files /dev/null and b/en_build/doctrees/get-started/get-started-StepMotor.doctree differ diff --git a/en_build/doctrees/get-started/idf-monitor.doctree b/en_build/doctrees/get-started/idf-monitor.doctree new file mode 100644 index 00000000..996b06a2 Binary files /dev/null and b/en_build/doctrees/get-started/idf-monitor.doctree differ diff --git a/en_build/doctrees/get-started/index.doctree b/en_build/doctrees/get-started/index.doctree new file mode 100644 index 00000000..14489237 Binary files /dev/null and b/en_build/doctrees/get-started/index.doctree differ diff --git a/en_build/doctrees/get-started/make-project.doctree b/en_build/doctrees/get-started/make-project.doctree new file mode 100644 index 00000000..30d41876 Binary files /dev/null and b/en_build/doctrees/get-started/make-project.doctree differ diff --git a/en_build/doctrees/get-started/toolchain-setup-scratch.doctree b/en_build/doctrees/get-started/toolchain-setup-scratch.doctree new file mode 100644 index 00000000..131c3bd2 Binary files /dev/null and b/en_build/doctrees/get-started/toolchain-setup-scratch.doctree differ diff --git a/en_build/doctrees/index.doctree b/en_build/doctrees/index.doctree new file mode 100644 index 00000000..408e7118 Binary files /dev/null and b/en_build/doctrees/index.doctree differ diff --git a/en_build/doctrees/languages.doctree b/en_build/doctrees/languages.doctree new file mode 100644 index 00000000..91050452 Binary files /dev/null and b/en_build/doctrees/languages.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 new file mode 100644 index 00000000..25dba64d Binary files /dev/null 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 new file mode 100644 index 00000000..e808c3de Binary files /dev/null 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 new file mode 100644 index 00000000..69f47393 Binary files /dev/null and b/en_build/doctrees/m5stack-awesome/TFT_eSPI/index.doctree differ diff --git a/en_build/doctrees/m5stack-awesome/awesome.doctree b/en_build/doctrees/m5stack-awesome/awesome.doctree new file mode 100644 index 00000000..96ee8f04 Binary files /dev/null and b/en_build/doctrees/m5stack-awesome/awesome.doctree differ diff --git a/en_build/doctrees/m5stack-awesome/index.doctree b/en_build/doctrees/m5stack-awesome/index.doctree new file mode 100644 index 00000000..85b660b4 Binary files /dev/null and b/en_build/doctrees/m5stack-awesome/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 new file mode 100644 index 00000000..fe40faf7 Binary files /dev/null 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 new file mode 100644 index 00000000..5455bfe3 Binary files /dev/null and b/en_build/doctrees/m5stack-faq/M5Stack-Module/index.doctree differ diff --git a/en_build/doctrees/m5stack-faq/index.doctree b/en_build/doctrees/m5stack-faq/index.doctree new file mode 100644 index 00000000..a5bc08d8 Binary files /dev/null and b/en_build/doctrees/m5stack-faq/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 new file mode 100644 index 00000000..fe40faf7 Binary files /dev/null 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 new file mode 100644 index 00000000..5455bfe3 Binary files /dev/null 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 new file mode 100644 index 00000000..ad2cd591 Binary files /dev/null and b/en_build/doctrees/product-documents/ROBOT/BALA.doctree 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 new file mode 100644 index 00000000..e2a901e5 Binary files /dev/null and b/en_build/doctrees/product-documents/STEAM Kit/M5GO/m5go.doctree differ diff --git a/en_build/doctrees/product-documents/STEAM Kit/M5GO/m5go_unit_env.doctree b/en_build/doctrees/product-documents/STEAM Kit/M5GO/m5go_unit_env.doctree new file mode 100644 index 00000000..1d7261e5 Binary files /dev/null and b/en_build/doctrees/product-documents/STEAM Kit/M5GO/m5go_unit_env.doctree differ diff --git a/en_build/doctrees/product-documents/STEAM Kit/M5GO/m5go_unit_hub.doctree b/en_build/doctrees/product-documents/STEAM Kit/M5GO/m5go_unit_hub.doctree new file mode 100644 index 00000000..2005fc55 Binary files /dev/null and b/en_build/doctrees/product-documents/STEAM Kit/M5GO/m5go_unit_hub.doctree differ diff --git a/en_build/doctrees/product-documents/STEAM Kit/M5GO/m5go_unit_ir.doctree b/en_build/doctrees/product-documents/STEAM Kit/M5GO/m5go_unit_ir.doctree new file mode 100644 index 00000000..4338e3e7 Binary files /dev/null and b/en_build/doctrees/product-documents/STEAM Kit/M5GO/m5go_unit_ir.doctree differ diff --git a/en_build/doctrees/product-documents/STEAM Kit/M5GO/m5go_unit_pir.doctree b/en_build/doctrees/product-documents/STEAM Kit/M5GO/m5go_unit_pir.doctree new file mode 100644 index 00000000..85e5d2ff Binary files /dev/null and b/en_build/doctrees/product-documents/STEAM Kit/M5GO/m5go_unit_pir.doctree differ diff --git a/en_build/doctrees/product-documents/STEAM Kit/M5GO/m5go_unit_pot.doctree b/en_build/doctrees/product-documents/STEAM Kit/M5GO/m5go_unit_pot.doctree new file mode 100644 index 00000000..7e8bb3f0 Binary files /dev/null and b/en_build/doctrees/product-documents/STEAM Kit/M5GO/m5go_unit_pot.doctree differ diff --git a/en_build/doctrees/product-documents/STEAM Kit/M5GO/m5go_unit_rgby.doctree b/en_build/doctrees/product-documents/STEAM Kit/M5GO/m5go_unit_rgby.doctree new file mode 100644 index 00000000..f91ce81d Binary files /dev/null and b/en_build/doctrees/product-documents/STEAM Kit/M5GO/m5go_unit_rgby.doctree differ diff --git a/en_build/doctrees/product-documents/index.doctree b/en_build/doctrees/product-documents/index.doctree new file mode 100644 index 00000000..396adeb4 Binary files /dev/null and b/en_build/doctrees/product-documents/index.doctree differ diff --git a/en_build/doctrees/product-documents/m5stack-core/index.doctree b/en_build/doctrees/product-documents/m5stack-core/index.doctree new file mode 100644 index 00000000..5964ec44 Binary files /dev/null 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 new file mode 100644 index 00000000..a1d93aa7 Binary files /dev/null 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 new file mode 100644 index 00000000..dd46f07e Binary files /dev/null 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 new file mode 100644 index 00000000..292b371e Binary files /dev/null and b/en_build/doctrees/product-documents/m5stack-core/m5stack_fire.doctree differ diff --git a/en_build/doctrees/product-documents/m5stack-core/m5stack_gray.doctree b/en_build/doctrees/product-documents/m5stack-core/m5stack_gray.doctree new file mode 100644 index 00000000..56a23ed1 Binary files /dev/null and b/en_build/doctrees/product-documents/m5stack-core/m5stack_gray.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 new file mode 100644 index 00000000..f72de7bf Binary files /dev/null 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 new file mode 100644 index 00000000..eb6ab8d7 Binary files /dev/null and b/en_build/doctrees/product-documents/m5stack-core/m5stack_plc.doctree differ diff --git a/en_build/doctrees/product-documents/modules/esp32cam.doctree b/en_build/doctrees/product-documents/modules/esp32cam.doctree new file mode 100644 index 00000000..2173ddc1 Binary files /dev/null and b/en_build/doctrees/product-documents/modules/esp32cam.doctree differ diff --git a/en_build/doctrees/product-documents/modules/index.doctree b/en_build/doctrees/product-documents/modules/index.doctree new file mode 100644 index 00000000..a806dfb0 Binary files /dev/null and b/en_build/doctrees/product-documents/modules/index.doctree 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 new file mode 100644 index 00000000..41f8497e Binary files /dev/null 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 new file mode 100644 index 00000000..029bc49d Binary files /dev/null and b/en_build/doctrees/product-documents/modules/m5stack_btc_module.doctree differ diff --git a/en_build/doctrees/product-documents/modules/m5stack_gps_module.doctree b/en_build/doctrees/product-documents/modules/m5stack_gps_module.doctree new file mode 100644 index 00000000..10754c83 Binary files /dev/null and b/en_build/doctrees/product-documents/modules/m5stack_gps_module.doctree differ diff --git a/en_build/doctrees/product-documents/modules/m5stack_lan_module.doctree b/en_build/doctrees/product-documents/modules/m5stack_lan_module.doctree new file mode 100644 index 00000000..70d73c67 Binary files /dev/null and b/en_build/doctrees/product-documents/modules/m5stack_lan_module.doctree differ diff --git a/en_build/doctrees/product-documents/modules/m5stack_lora_module.doctree b/en_build/doctrees/product-documents/modules/m5stack_lora_module.doctree new file mode 100644 index 00000000..3f15df9a Binary files /dev/null and b/en_build/doctrees/product-documents/modules/m5stack_lora_module.doctree differ diff --git a/en_build/doctrees/product-documents/modules/m5stack_proto_kit.doctree b/en_build/doctrees/product-documents/modules/m5stack_proto_kit.doctree new file mode 100644 index 00000000..d2d3cc92 Binary files /dev/null and b/en_build/doctrees/product-documents/modules/m5stack_proto_kit.doctree differ diff --git a/en_build/doctrees/product-documents/modules/m5stack_proto_module.doctree b/en_build/doctrees/product-documents/modules/m5stack_proto_module.doctree new file mode 100644 index 00000000..a161f6d4 Binary files /dev/null and b/en_build/doctrees/product-documents/modules/m5stack_proto_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 new file mode 100644 index 00000000..0a2770e4 Binary files /dev/null and b/en_build/doctrees/product-documents/modules/m5stack_sim800_module.doctree differ diff --git a/en_build/doctrees/product-documents/tools/index.doctree b/en_build/doctrees/product-documents/tools/index.doctree new file mode 100644 index 00000000..251ad297 Binary files /dev/null and b/en_build/doctrees/product-documents/tools/index.doctree differ diff --git a/en_build/doctrees/product-documents/tools/m5stack_usb_downloader.doctree b/en_build/doctrees/product-documents/tools/m5stack_usb_downloader.doctree new file mode 100644 index 00000000..c69f106c Binary files /dev/null and b/en_build/doctrees/product-documents/tools/m5stack_usb_downloader.doctree differ diff --git a/en_build/doctrees/resources.doctree b/en_build/doctrees/resources.doctree new file mode 100644 index 00000000..a045dc47 Binary files /dev/null and b/en_build/doctrees/resources.doctree differ diff --git a/en_build/html/.buildinfo b/en_build/html/.buildinfo new file mode 100644 index 00000000..b52c5a6c --- /dev/null +++ b/en_build/html/.buildinfo @@ -0,0 +1,4 @@ +# Sphinx build info version 1 +# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done. +config: c48f6208e60429fdff9e0ee464b43420 +tags: 645f666f9bcd5a90fca523b33c5a78b7 diff --git a/en_build/html/COPYRIGHT.html b/en_build/html/COPYRIGHT.html new file mode 100644 index 00000000..57e76f69 --- /dev/null +++ b/en_build/html/COPYRIGHT.html @@ -0,0 +1,264 @@ + + + + + + + + + + + Copyrights and Licenses — M5Stack 1.0.1 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + +
+ + + + + +
+ +
+ + + + + + + + + + + + + + + + + +
+ + + + +
+
+
+
+ +
+

Copyrights and Licenses

+
+

Software Copyrights

+

All original source code in this repository is Copyright (C) 2017-2018 M5Stack Inc. This source code is licensed under the Apache License 2.0 as described in the file LICENSE.

+

Additional third party copyrighted code is included under the following licenses.

+

Where source code headers specify Copyright & License information, this information takes precedence over the summaries made here.

+
+

Firmware Components

+
+
+

Build Tools

+

This is the list of licenses for tools included in this repository, which are used to build applications. The tools do not become part of the application (firmware), so their license does not affect licensing of the application.

+
+
+
+

Xtensa libhal MIT License

+

Copyright (c) 2003, 2006, 2010 Tensilica Inc.

+

Permission is hereby granted, free of charge, to any person obtaining +a copy of this software and associated documentation files (the +“Software”), to deal in the Software without restriction, including +without limitation the rights to use, copy, modify, merge, publish, +distribute, sublicense, and/or sell copies of the Software, and to +permit persons to whom the Software is furnished to do so, subject to +the following conditions:

+

The above copyright notice and this permission notice shall be included +in all copies or substantial portions of the Software.

+

THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, +EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF +MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. +IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY +CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, +TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE +SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

+
+
+

TinyBasic Plus MIT License

+

Copyright (c) 2012-2013

+

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

+

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

+

THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

+
+
+

TJpgDec License

+

TJpgDec - Tiny JPEG Decompressor R0.01 (C)ChaN, 2011 +The TJpgDec is a generic JPEG decompressor module for tiny embedded systems. +This is a free software that opened for education, research and commercial +developments under license policy of following terms.

+

Copyright (C) 2011, ChaN, all right reserved.

+
    +
  • The TJpgDec module is a free software and there is NO WARRANTY.
    • +
  • No restriction on use. You can use, modify and redistribute it for personal, non-profit or commercial products UNDER YOUR RESPONSIBILITY.
    • +
  • Redistributions of source code must retain the above copyright notice.
    • +
+
+
+ + +
+ +
+
+ + +
+ +
+

+ © 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/_images/ESP32CAM.jpg b/en_build/html/_images/ESP32CAM.jpg new file mode 100644 index 00000000..675dc4ae Binary files /dev/null and b/en_build/html/_images/ESP32CAM.jpg differ diff --git a/en_build/html/_images/ESP32CAM_Browser.png b/en_build/html/_images/ESP32CAM_Browser.png new file mode 100644 index 00000000..dae1e500 Binary files /dev/null and b/en_build/html/_images/ESP32CAM_Browser.png differ diff --git a/en_build/html/_images/ESP32CAM_M5CAM.png b/en_build/html/_images/ESP32CAM_M5CAM.png new file mode 100644 index 00000000..61b396a4 Binary files /dev/null and b/en_build/html/_images/ESP32CAM_M5CAM.png differ diff --git a/en_build/html/_images/ESP32CAM_Terminal.png b/en_build/html/_images/ESP32CAM_Terminal.png new file mode 100644 index 00000000..3c5763a9 Binary files /dev/null and b/en_build/html/_images/ESP32CAM_Terminal.png differ diff --git a/en_build/html/_images/FAQ.jpg b/en_build/html/_images/FAQ.jpg new file mode 100644 index 00000000..36176da5 Binary files /dev/null and b/en_build/html/_images/FAQ.jpg differ diff --git a/en_build/html/_images/FactoryTest_result.png b/en_build/html/_images/FactoryTest_result.png new file mode 100644 index 00000000..ab97ede8 Binary files /dev/null and b/en_build/html/_images/FactoryTest_result.png differ diff --git a/en_build/html/_images/M5Bala.jpg b/en_build/html/_images/M5Bala.jpg new file mode 100644 index 00000000..87c31d01 Binary files /dev/null and b/en_build/html/_images/M5Bala.jpg differ diff --git a/en_build/html/_images/M5GO.jpg b/en_build/html/_images/M5GO.jpg new file mode 100644 index 00000000..593f3a29 Binary files /dev/null and b/en_build/html/_images/M5GO.jpg differ diff --git a/en_build/html/_images/WebIDE_check_code.png b/en_build/html/_images/WebIDE_check_code.png new file mode 100644 index 00000000..202c78bb Binary files /dev/null and b/en_build/html/_images/WebIDE_check_code.png differ diff --git a/en_build/html/_images/about-doc.png b/en_build/html/_images/about-doc.png new file mode 100644 index 00000000..f52f1658 Binary files /dev/null and b/en_build/html/_images/about-doc.png differ diff --git a/en_build/html/_images/arduino_cc_package.png b/en_build/html/_images/arduino_cc_package.png new file mode 100644 index 00000000..4ebf5bf8 Binary files /dev/null and b/en_build/html/_images/arduino_cc_package.png differ diff --git a/en_build/html/_images/arduino_path.png b/en_build/html/_images/arduino_path.png new file mode 100644 index 00000000..f88b1bae Binary files /dev/null and b/en_build/html/_images/arduino_path.png differ diff --git a/en_build/html/_images/choose_version.png b/en_build/html/_images/choose_version.png new file mode 100644 index 00000000..c8927df1 Binary files /dev/null and b/en_build/html/_images/choose_version.png differ diff --git a/en_build/html/_images/create_a_new_project.png b/en_build/html/_images/create_a_new_project.png new file mode 100644 index 00000000..eb1bc1c7 Binary files /dev/null and b/en_build/html/_images/create_a_new_project.png differ diff --git a/en_build/html/_images/display_hello_world.png b/en_build/html/_images/display_hello_world.png new file mode 100644 index 00000000..d4ffae69 Binary files /dev/null and b/en_build/html/_images/display_hello_world.png differ diff --git a/en_build/html/_images/download_idf.png b/en_build/html/_images/download_idf.png new file mode 100644 index 00000000..90d21ebd Binary files /dev/null and b/en_build/html/_images/download_idf.png differ diff --git a/en_build/html/_images/download_m5stack_lib.png b/en_build/html/_images/download_m5stack_lib.png new file mode 100644 index 00000000..e90782b6 Binary files /dev/null and b/en_build/html/_images/download_m5stack_lib.png differ diff --git a/en_build/html/_images/download_xtensa_tools.png b/en_build/html/_images/download_xtensa_tools.png new file mode 100644 index 00000000..c5156796 Binary files /dev/null and b/en_build/html/_images/download_xtensa_tools.png differ diff --git a/en_build/html/_images/get-started.jpg b/en_build/html/_images/get-started.jpg new file mode 100644 index 00000000..54491d69 Binary files /dev/null and b/en_build/html/_images/get-started.jpg differ diff --git a/en_build/html/_images/linux-logo.png b/en_build/html/_images/linux-logo.png new file mode 100644 index 00000000..1112db65 Binary files /dev/null and b/en_build/html/_images/linux-logo.png differ diff --git a/en_build/html/_images/m5-api-reference.jpg b/en_build/html/_images/m5-api-reference.jpg new file mode 100644 index 00000000..efcd29b4 Binary files /dev/null and b/en_build/html/_images/m5-api-reference.jpg differ diff --git a/en_build/html/_images/m5-arduino.jpg b/en_build/html/_images/m5-arduino.jpg new file mode 100644 index 00000000..cc13dbc3 Binary files /dev/null and b/en_build/html/_images/m5-arduino.jpg differ diff --git a/en_build/html/_images/m5-awesome.jpg b/en_build/html/_images/m5-awesome.jpg new file mode 100644 index 00000000..7d3673af Binary files /dev/null and b/en_build/html/_images/m5-awesome.jpg differ diff --git a/en_build/html/_images/m5-micropython.jpg b/en_build/html/_images/m5-micropython.jpg new file mode 100644 index 00000000..f5f25a18 Binary files /dev/null and b/en_build/html/_images/m5-micropython.jpg differ diff --git a/en_build/html/_images/m5-stepmotor.jpg b/en_build/html/_images/m5-stepmotor.jpg new file mode 100644 index 00000000..cd82beef Binary files /dev/null and b/en_build/html/_images/m5-stepmotor.jpg differ diff --git a/en_build/html/_images/m5stack-forum.jpg b/en_build/html/_images/m5stack-forum.jpg new file mode 100644 index 00000000..b2baf3f3 Binary files /dev/null and b/en_build/html/_images/m5stack-forum.jpg differ diff --git a/en_build/html/_images/m5stack_connet_wifi.png b/en_build/html/_images/m5stack_connet_wifi.png new file mode 100644 index 00000000..a86ae2d6 Binary files /dev/null and b/en_build/html/_images/m5stack_connet_wifi.png differ diff --git a/en_build/html/_images/macos-logo.png b/en_build/html/_images/macos-logo.png new file mode 100644 index 00000000..289d1f60 Binary files /dev/null and b/en_build/html/_images/macos-logo.png differ diff --git a/en_build/html/_images/product-documents.jpg b/en_build/html/_images/product-documents.jpg new file mode 100644 index 00000000..7dbec619 Binary files /dev/null and b/en_build/html/_images/product-documents.jpg differ diff --git a/en_build/html/_images/putty-settings-linux.png b/en_build/html/_images/putty-settings-linux.png new file mode 100644 index 00000000..7b04f922 Binary files /dev/null and b/en_build/html/_images/putty-settings-linux.png differ diff --git a/en_build/html/_images/putty-settings-windows.png b/en_build/html/_images/putty-settings-windows.png new file mode 100644 index 00000000..d08d6ab1 Binary files /dev/null and b/en_build/html/_images/putty-settings-windows.png differ diff --git a/en_build/html/_images/select_arduino_install_path.png b/en_build/html/_images/select_arduino_install_path.png new file mode 100644 index 00000000..e0e0db86 Binary files /dev/null and b/en_build/html/_images/select_arduino_install_path.png differ diff --git a/en_build/html/_images/select_arduino_lib.png b/en_build/html/_images/select_arduino_lib.png new file mode 100644 index 00000000..e820d183 Binary files /dev/null and b/en_build/html/_images/select_arduino_lib.png differ diff --git a/en_build/html/_images/select_board_and_com.png b/en_build/html/_images/select_board_and_com.png new file mode 100644 index 00000000..4476f38d Binary files /dev/null and b/en_build/html/_images/select_board_and_com.png differ diff --git a/en_build/html/_images/select_demo.png b/en_build/html/_images/select_demo.png new file mode 100644 index 00000000..45183285 Binary files /dev/null and b/en_build/html/_images/select_demo.png differ diff --git a/en_build/html/_images/select_get_exe_file.png b/en_build/html/_images/select_get_exe_file.png new file mode 100644 index 00000000..9d715826 Binary files /dev/null and b/en_build/html/_images/select_get_exe_file.png differ diff --git a/en_build/html/_images/show_motors_files_added.png b/en_build/html/_images/show_motors_files_added.png new file mode 100644 index 00000000..6ba5f20b Binary files /dev/null and b/en_build/html/_images/show_motors_files_added.png differ diff --git a/en_build/html/_images/upload_module_files.png b/en_build/html/_images/upload_module_files.png new file mode 100644 index 00000000..82b16b20 Binary files /dev/null and b/en_build/html/_images/upload_module_files.png differ diff --git a/en_build/html/_images/windows-logo.png b/en_build/html/_images/windows-logo.png new file mode 100644 index 00000000..122f53a2 Binary files /dev/null and b/en_build/html/_images/windows-logo.png differ diff --git a/en_build/html/_images/windows_download_firmware.png b/en_build/html/_images/windows_download_firmware.png new file mode 100644 index 00000000..d70843bf Binary files /dev/null and b/en_build/html/_images/windows_download_firmware.png differ diff --git a/en_build/html/_sources/COPYRIGHT.rst.txt b/en_build/html/_sources/COPYRIGHT.rst.txt new file mode 100644 index 00000000..d7f2f3a1 --- /dev/null +++ b/en_build/html/_sources/COPYRIGHT.rst.txt @@ -0,0 +1,74 @@ +Copyrights and Licenses +*********************** + +Software Copyrights +=================== + +All original source code in this repository is Copyright (C) 2017-2018 M5Stack Inc. This source code is licensed under the Apache License 2.0 as described in the file LICENSE. + +Additional third party copyrighted code is included under the following licenses. + +Where source code headers specify Copyright & License information, this information takes precedence over the summaries made here. + +Firmware Components +------------------- + + + +Build Tools +----------- + +This is the list of licenses for tools included in this repository, which are used to build applications. The tools do not become part of the application (firmware), so their license does not affect licensing of the application. + + +Xtensa libhal MIT License +========================= + +Copyright (c) 2003, 2006, 2010 Tensilica Inc. + +Permission is hereby granted, free of charge, to any person obtaining +a copy of this software and associated documentation files (the +"Software"), to deal in the Software without restriction, including +without limitation the rights to use, copy, modify, merge, publish, +distribute, sublicense, and/or sell copies of the Software, and to +permit persons to whom the Software is furnished to do so, subject to +the following conditions: + +The above copyright notice and this permission notice shall be included +in all copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, +EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF +MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. +IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY +CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, +TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE +SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. + +TinyBasic Plus MIT License +========================== + +Copyright (c) 2012-2013 + +Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. + +TJpgDec License +=============== + +TJpgDec - Tiny JPEG Decompressor R0.01 (C)ChaN, 2011 +The TJpgDec is a generic JPEG decompressor module for tiny embedded systems. +This is a free software that opened for education, research and commercial +developments under license policy of following terms. + +Copyright (C) 2011, ChaN, all right reserved. + +* The TJpgDec module is a free software and there is NO WARRANTY. +* No restriction on use. You can use, modify and redistribute it for personal, non-profit or commercial products UNDER YOUR RESPONSIBILITY. +* Redistributions of source code must retain the above copyright notice. + + + diff --git a/en_build/html/_sources/about.rst.txt b/en_build/html/_sources/about.rst.txt new file mode 100644 index 00000000..2c460675 --- /dev/null +++ b/en_build/html/_sources/about.rst.txt @@ -0,0 +1,16 @@ +About +===== + +This is documentation of `ESP-IDF `_, the framework to develop applications for `ESP32 `_ chip by `Espressif `_. + +The ESP32 is 2.4 GHz Wi-Fi and Bluetooth combo, 32 bit dual core chip with 600 DMIPS processing power. + +.. figure:: ../_static/about-doc.png + :align: center + :alt: Espressif IoT Integrated Development Framework + :figclass: align-center + + Espressif IoT Integrated Development Framework + +The ESP-IDF, Espressif IoT Integrated Development Framework, provides toolchain, API, components and workflows to develop applications for ESP32 using Windows, Linux and Mac OS operating systems. + diff --git a/en_build/html/_sources/api-reference/button/button.rst.txt b/en_build/html/_sources/api-reference/button/button.rst.txt new file mode 100644 index 00000000..c9f95227 --- /dev/null +++ b/en_build/html/_sources/api-reference/button/button.rst.txt @@ -0,0 +1,70 @@ +Button API +*********** + +----------------------------- + +Function +--------- + +isPressed() + +isReleased() + +pressedFor(timeout) + +wasPressed(callback=None) +wasReleased(callback=None) +releasedFor(timeout, callback=None) + + + +--------------------- + +Usage +------ + +.. code:: python + + from m5stack import * + from machine import SPI, Pin + from display import LCD + import utime + + spi = SPI(1, baudrate=32000000, mosi=Pin(23), miso=Pin(19), sck=Pin(18)) + + lcd = LCD(spi = spi) #lcd init + + while True: + if buttonA.wasPressed(): + lcd.print('Button A was Pressed\n') + + if buttonA.wasReleased(): + lcd.print('Button A was Released\n') + + if buttonA.pressedFor(1.5): + lcd.print('Button A pressed for 1.5s\n') + + if buttonA.releasedFor(2): + lcd.print('Button A released for 2s press hold\n') + + utime.sleep(0.1) + + +.. code:: python + + #Button Callback + + from m5stack import * + + def on_wasPressed(): + lcd.print('Button B was Pressed\n') + + def on_wasReleased(): + lcd.print('Button B was Released\n') + + def on_releasedFor(): + lcd.print('Button B released for 1.2s press hold\n') + + buttonB.wasPressed(on_wasPressed) + buttonB.wasReleased(on_wasReleased) + buttonB.releasedFor(1.2, on_releasedFor) diff --git a/en_build/html/_sources/api-reference/index.rst.txt b/en_build/html/_sources/api-reference/index.rst.txt new file mode 100644 index 00000000..81efb7aa --- /dev/null +++ b/en_build/html/_sources/api-reference/index.rst.txt @@ -0,0 +1,17 @@ +************* +API Reference +************* + +.. toctree:: + :maxdepth: 1 + + LCD + Button